IDirectDrawSurface5::UpdateOverlay

Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.

The IDirectDrawSurface5::UpdateOverlaymethod repositions or modifies the visual attributes of an overlay surface. These surfaces must have the DDSCAPS_OVERLAY flag set.

HRESULT UpdateOverlay(
LPRECT
lpSrcRect
,
LPDIRECTDRAWSURFACE4
lpDDDestSurface
,
LPRECT
lpDestRect
,
DWORD
dwFlags
,
LPDDOVERLAYFX
lpDDOverlayFx
);

Parameters

lpSrcRect

Address of a RECTstructure that defines the x, y, width, and height of the region on the source surface being used as the overlay. This parameter can be NULL when hiding an overlay, or to indicate that the entire overlay surface is to be used and that the overlay surface conforms to any boundary and size alignment restrictions imposed by the device driver.

lpDDDestSurface

Address of the IDirectDrawSurface5interface for the surface that is being overlaid.

lpDestRect

Address of a RECTstructure that defines the x, y, width, and height of the region on the destination surface that the overlay should be moved to. This parameter can be NULL when hiding the overlay.

dwFlags

Flag	Description
DDOVER_ADDDIRTYRECT	Adds a dirty rectangle to an emulated overlay surface.
DDOVER_ALPHADEST	Uses either the alpha information in pixel format or the alpha channel surface attached to the destination surface as the alpha channel for this overlay.
DDOVER_ALPHADESTCONSTOVERRIDE	Uses the dwAlphaDestConstmember of the DDOVERLAYFXstructure as the destination alpha channel for this overlay.
DDOVER_ALPHADESTNEG	Indicates that the destination surface becomes more transparent as the alpha value increases (zero equals opaque).
DDOVER_ALPHADESTSURFACEOVERRIDE	Uses the lpDDSAlphaDestmember of the DDOVERLAYFXstructure as the alpha channel destination for this overlay.
DDOVER_ALPHAEDGEBLEND	Uses the dwAlphaEdgeBlendmember of the DDOVERLAYFXstructure as the alpha channel for the edges of the image that border the color key colors.
DDOVER_ALPHASRC	Uses either the alpha information in pixel format or the alpha channel surface attached to the source surface as the source alpha channel for this overlay.
DDOVER_ALPHASRCCONSTOVERRIDE	Uses the dwAlphaSrcConstmember of the DDOVERLAYFXstructure as the source alpha channel for this overlay.
DDOVER_ALPHASRCNEG	Indicates that the source surface becomes more transparent as the alpha value increases (zero is opaque).
DDOVER_ALPHASRCSURFACEOVERRIDE	Uses the lpDDSAlphaSrcmember of the DDOVERLAYFXstructure as the alpha channel source for this overlay.
DDOVER_AUTOFLIP	Automatically flip to the next surface in the flip chain each time a video port VSYNC occurs.
DDOVER_BOB	Display each field individually of the interlaced video stream without causing any artifacts.
DDOVER_BOBHARDWARE	Indicates that bob operations will be performed using hardware rather than software or emulated. This flag must be used with the DDOVER_BOB flag.
DDOVER_DDFX	Uses the overlay FX flags in the lpDDOverlayFxparameter to define special overlay effects.
DDOVER_HIDE	Turns off this overlay.
DDOVER_KEYDEST	Uses the color key associated with the destination surface.
DDOVER_KEYDESTOVERRIDE	Uses the dckDestColorkeymember of the DDOVERLAYFXstructure as the color key for the destination surface.
DDOVER_KEYSRC	Uses the color key associated with the source surface.
DDOVER_KEYSRCOVERRIDE	Uses the dckSrcColorkeymember of the DDOVERLAYFXstructure as the color key for the source surface.
DDOVER_OVERRIDEBOBWEAVE	Indicates that bob and weave decisions should not be overridden by other interfaces.
DDOVER_INTERLEAVED	Indicates that the surface memory is composed of interleaved fields.
DDOVER_SHOW	Turns on this overlay.

lpDDOverlayFx