public:
     virtual bool __fastcall UpdateOverlay( TRect* pSrcRect, TDx_DrawSurface* pDestSurface, TRect* pDestRect, dword pFlags, TDDOverlayFX* pOverlayFx );

• Description
• Parameters
• See Also

If you would like to submit additions or improvements to this page, click: admin@bcb-tools.com.

The TDx_DrawSurface::UpdateOverlay method will reposition and/or modify an overlay surface.

If the method call fails, the OnError event will be triggered with one of the following values:
DDERR_DEVICEDOESNTOWNSURFACE
DDERR_GENERIC
DDERR_HEIGHTALIGN
DDERR_INVALIDOBJECT
DDERR_INVALIDPARAMS
DDERR_INVALIDRECT
DDERR_INVALIDSURFACETYPE
DDERR_NOSTRETCHHW
DDERR_NOTAOVERLAYSURFACE
DDERR_OUTOFCAPS
DDERR_SURFACELOST
DDERR_UNSUPPORTED
DDERR_XALIGN

SrcRect
The SrcRect parameter references a TRect defining a region of the source surface that is being used for the overlay.

Set this parameter to NULL if the entire source surface is to be used and it conforms to driver boundary and size alignment restrictions.
This parameter may also be NULL when hiding the overlay.

DestSurface
The DestSurface parameter references the surface being overlaid.

DestRect
The DestRect parameter references a TRect defining the region of destination surface that is to be overlaid.
This parameter may be NULL when hiding the overlay.

Flags
The Flags parameter defines flags indicating overlay settings and effects.
The described effect applies when the flag is set.

DDOVER_ADDDIRTYRECT
Add a dirty rectangle to the overlay.
Only useful when the overlay is being emulated.

DDOVER_ALPHADEST
The overlay is to be performed using the destination surface's alpha information as the alpha channel.

DDOVER_ALPHADESTCONSTOVERRIDE
The overlay operation's destination alpha channel is obtained from the TDDOverlayFX::AlphaDestConst referenced by the OverlayFX parameter of this method.

DDOVER_ALPHADESTNEG
The destination surface will increase in transparency as alpha values increase.

DDOVER_ALPHADESTSURFACEOVERRIDE
The overlay operation's destination alpha channel is obtained from the TDDOverlayFX::SAlphaDest referenced by the OverlayFX parameter of this method.

DDOVER_ALPHAEDGEBLEND
The overlay operation's alpha channel for alpha edge blending is obtained from the TDDOverlayFX::AlphaEdgeBlend referenced by the OverlayFX parameter of this method.

DDOVER_ALPHASRC
The overlay is to be performed using the source surface's alpha information as the alpha channel.

DDOVER_ALPHASRCCONSTOVERRIDE
The overlay operation's source alpha channel is obtained from the TDDOverlayFX::AlphaSrcConst referenced by the OverlayFX parameter of this method.

DDOVER_ALPHASRCNEG
The source surface will increase in transparency as alpha values increase.

DDOVER_ALPHASRCSURFACEOVERRIDE
The overlay operation's source alpha channel is obtained from the TDDOverlayFX::SAlphaSrc referenced by the OverlayFX parameter of this method.

DDOVER_ARGBSCALEFACTORS
The TDDOverlayFX component referenced by the OverlayFX parameter of this method contains valid ARGB scaling factors.

DDOVER_AUTOFLIP
Autoflip to the next surface in the flip chain every video port VSYNC.

DDOVER_BOB
Use the bob technique to prevent artifacts when individually displaying the odd and even fields of the video stream.

DDOVER_BOBHARDWARE
The performance of bob operations is hardware, rather than software or emulation, based.
DDOVER_BOB must also be set.

DDOVER_DDFX
The special effects flag settings for this overlay operation is obtained from the TDDOverlayFX::FX referenced by the OverlayFX parameter of this method.

DDOVER_DEGRADEARGBSCALING
Degrade ARGB scaling factors to match the driver capabilities if neccessary.

DDOVER_HIDE
The overlay will not be displayed until this method is called with DDOVER_SHOW set.

DDOVER_INTERLEAVED
The surface memory is composed of interleaved fields.

DDOVER_KEYDEST
The overlay is to be performed using the destination surface's color key.

DDOVER_KEYDESTOVERRIDE
The overlay operation's destination color key is obtained from the TDDOverlayFX::DestColorKey referenced by the OverlayFX parameter of this method.

DDOVER_KEYSRC
The overlay is to be performed using the source surface's color key.

DDOVER_KEYSRCOVERRIDE
The overlay operation's source color key is obtained from the TDDOverlayFX::SrcColorKey referenced by the OverlayFX parameter of this method.

DDOVER_OVERRIDEBOBWEAVE
Decisions about the use of bob/weave techniques will not be overridden by another component.

DDOVER_REFRESHALL
The entire emulated overlay surface should be redrawn.

DDOVER_REFRESHDIRTYRECTS
All dirty rectangles on the emulated overlay surface should be redrawn.

DDOVER_SHOW
The overlay will be displayed until this method is called with DDOVER_HIDE set.

OverlayFx
The OverlayFx parameter references a TDDOverlayFX component defining values and effects to be used for this overlay.
DDOVER_DDFX should not be set if this parameter is NULL.

TDx_DrawSurface
TDx_DrawSurface::OnSurfaceLost()
TDDOverlayFX