LPDDHALSURFCB_UPDATEOVERLAY (Compact 2013)

3/26/2014

This callback function repositions or modifies the visual attributes of an overlay surface.

Syntax

DWORD (* LPDDHALSURFCB_UPDATEOVERLAY)(
  LPDDHAL_UPDATEOVERLAYDATA lpuod
);

Parameters

  • lpuod
    [in, out] Pointer to a DDHAL_UPDATEOVERLAYDATA structure that the driver uses to update the overlay surface.

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.

Note

For a complete list of the DDHAL callback return values, see DDHAL Callback Return Values.

Remarks

DirectDraw passes color-key information to the UpdateOverlay callback function only if DDCAPS_OVERLAYCANTCLIP in DDCAPS.dwCaps is TRUE.

Requirements

Header

ddrawi.h

Library

Developer Implemented

See Also

Reference

DirectDrawSurface Callback Functions
DDHAL_UPDATEOVERLAYDATA
DDHAL Callback Return Values

Other Resources

DDCAPS