Share via

IDirectDraw::GetScanLine

  • Article

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This method retrieves the scan line that is currently being drawn on the monitor.

Syntax

HRESULT GetScanLine(
  LPDWORD lpdwScanLine
);

Parameters

  • lpdwScanLine
    Address of the variable that will contain the scan line the display is currently drawing.

Return Value

If the method succeeds, the return value is DD_OK.

If the method fails, the return value may be one of the following error values:

DDERR_INVALIDOBJECT

DDERR_INVALIDPARAMS

DDERR_UNSUPPORTED

DDERR_VERTICALBLANKINPROGRESS

For more information on these error codes see DirectDraw Return Values.

Remarks

Scan lines are reported as zero-based integers.

The returned scan line value is between 0 and n, where scan line 0 is the first visible scan line on the screen and n is the last visible scan line, plus scan lines that occur during the vertical blank period.

So, in a case where an application is running at 640×480, and there are 12 scan lines during the vertical blank period, the values returned by this method will range from 0 to 491.

Requirements

Header ddraw.h
Library ddraw.lib
Windows Embedded CE Windows Embedded CE 6.0 and later
Windows Mobile Pocket PC for Windows Mobile Version 5.0 and later, Smartphone for Windows Mobile Version 5.0 and later

See Also

Reference

IDirectDraw::GetVerticalBlankStatus
IDirectDraw::WaitForVerticalBlank