DD_UPDATEOVERLAYDATA

typedef struct _DD_UPDATEOVERLAYDATA {
    PDD_DIRECTDRAW_GLOBAL       lpDD;           
    PDD_SURFACE_LOCAL           lpDDDestSurface;
    RECTL                       rDest;          
    PDD_SURFACE_LOCAL           lpDDSrcSurface; 
    RECTL                       rSrc;           
    DWORD                       dwFlags;        
    DDOVERLAYFX                 overlayFX;      
    HRESULT                     ddRVal;         
    VOID *                      UpdateOverlay; 
} DD_UPDATEOVERLAYDATA;

The DD_UPDATEOVERLAYDATA structure is passed to the DirectDraw hardware interface’s UpdateOverlay surface object callback.

Members

lpDD

Pointer to the DD_DIRECTDRAW_GLOBAL structure that describes the driver.

lpDDDestSurface

Pointer to the DD_SURFACE_LOCAL structure that describes the surface to be overlayed. This value can be NULL if DDOVER_HIDE is specified for dwFlags.

rDest

RECTL that specifies the destination for the overlay.

lpDDSrcSurface

Pointer to the DD_SURFACE_LOCAL structure that describes the overlay surface.

rSrc

RECTL that specifies the portion of the source surface to be used for the overlay.

dwFlags

Specifies how the driver should handle the overlay. This field can be a combination of the following values:

Value	Meaning
DDOVER_HIDE	The driver should hide the overlay surface.
DDOVER_SHOW	The driver should show the overlay surface using the attributes specified by overlayFX.
DDOVER_KEYDEST	The driver should use the color key associated with the destination surface by SetColorKey.
DDOVER_KEYDESTOVERRIDE	The driver should use the destination color key specified by overlayFX.dckDestColorKey.
DDOVER_KEYSRC	The driver should use the color key associated with the destination surface by SetColorKey.
DDOVER_KEYSRCOVERRIDE	The driver should use the source color key specified by overlayFX.dckSrcColorKey.

overlayFX

DDOVERLAYFX structure that contains the requested attributes for the overlay.

ddRVal

Location in which the driver returns a DirectDraw status return code. The status codes are defined in ddraw.h.

UpdateOverlay

Unused by Windows NT.