IDirectDraw::GetScanLine (Compact 2013)

  • Article

3/26/2014

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.

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

See Also

Reference

IDirectDraw
DirectDraw Reference
DirectDraw Interfaces
IDirectDraw::GetVerticalBlankStatus
IDirectDraw::WaitForVerticalBlank

Other Resources

DirectDraw