LPDDHAL_GETSCANLINE (Compact 2013)

3/26/2014

This callback function gets the current scan line.

Syntax

typedef DWORD (* LPDDHAL_GETSCANLINE)(
  LPDDHAL_GETSCANLINEDATA lpgsld
);

Parameters

• lpgsld
  [in, out] A pointer to a DDHAL_GETSCANLINEDATA structure that contains the scan line information.

Return Value

Returns one of the following values:

• DDHAL_DRIVER_HANDLED
  The request was handled although a specific action may not have been taken.

• DDHAL_DRIVER_NOTHANDLED
  The request was not handled or processed in any way.

Remarks

The returned scan line value in the dwScanLine member of the DDHAL_GETSCANLINEDATA structure must be 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 any scan lines that occur during vertical blank. For example, if your device is running with a screen resolution of 640x480, and you have 12 scan lines during vertical blank, the values that are returned by GetScanLine can range from 0 to 491.

You can find an example implementation of this callback function, named GetScanLine32, in the sample IGS driver source code.

Requirements

See Also

Reference

DirectDraw Display Driver Callback Functions
DDHAL_GETSCANLINEDATA
DDHAL Callback Return Values