DDHAL_UPDATEOVERLAYDATA (Compact 2013)

  • Article

3/26/2014

This structure contains information necessary for updating an overlay surface. This structure passes the information to the DirectDraw hardware abstraction layer (DDHAL) LPDDHALSURFCB_UPDATEOVERLAY callback function.

Syntax

typedef struct _DDHAL_UPDATEOVERLAYDATA {
  LPDDRAWI_DIRECTDRAW_GBL lpDD;
  LPDDRAWI_DDRAWSURFACE_LCL lpDDDestSurface;
  RECT rDest;
  LPDDRAWI_DDRAWSURFACE_LCL lpDDSrcSurface;
  RECT rSrc;
  DWORD dwFlags;
  DDOVERLAYFX overlayFX;
  HRESULT ddRVal;
} DDHAL_UPDATEOVERLAYDATA;

Members

  • lpDDDestSurface
    Pointer to the DDRAWI_DDRAWSURFACE_LCL structure that represents the surface that is being overlaid.
  • rDest
    Pointer to a RECT structure that contains the x, y, width, and height of the region on the destination surface.
  • lpDDSrcSurface
    Pointer to the DDRAWI_DDRAWSURFACE_LCL structure that represents the DirectDraw overlay surface.
  • rSrc
    Pointer to a RECT structure that contains the x, y, width, and height of the region on the source surface.

  • dwFlags
    Overlay FX control flags.

    The following table shows the possible flags.

    Flag

    Description

    DDOVER_ALPHACONSTOVERRIDE

    Uses the alpha information specified by dwAlphaConst from the lpDDOverlayFX argument.

    For this to be supported, the display hardware must support constant alpha blending, as indicated by DDOVERLAYCAPS_ALPHACONSTANT.

    DDOVER_ALPHADEST

    Uses the alpha information in the pixel format or the alpha channel surface attached to the destination surface as the alpha channel for the destination overlay.

    DDOVER_ALPHADESTNEG

    The NEG suffix indicates that the destination surface becomes more transparent as the alpha value increases.

    DDOVER_ALPHASRC

    Uses the alpha information in the pixel format or the alpha channel surface attached to the source surface as the source alpha channel for this overlay.

    DDOVER_ALPHASRCNEG

    The NEG suffix indicates that the source surface becomes more transparent as the alpha value increases.

    DDOVER_HIDE

    Turns this overlay off.

    DDOVER_KEYDEST

    Uses the color key associated with the destination surface.

    DDOVER_KEYDESTOVERRIDE

    Uses the dckDestColorkey member in the DDOVERLAYFX structure as the color key for the destination surface.

    DDOVER_KEYSRC

    Uses the color key associated with the source surface.

    DDOVER_KEYSRCOVERRIDE

    Uses the dckSrcColorkey member in the DDOVERLAYFX structure as the color key for the source surface.

    DDOVER_MIRRORLEFTRIGHT

    Uses surface mirroring in the left-to-right direction.

    DDOVER_MIRRORUPDOWN

    Uses surface mirroring in the up-to-down direction.

    DDOVER_SHOW

    Turns this overlay on.

    DDOVER_WAITNOTBUSY

    Waits for a previously initiated drawing operation to complete instead of returning immediately with the DDERR_WASSTILLDRAWING return value.

    If a previous drawing operation is in progress at the time of the call, this flag defers returning from the call until the new blit operation begins or an error occurs.

    DDOVER_WAITVSYNC

    Waits for a V-Sync before performing the operation.
  • overlayFX
    Pointer to a DDOVERLAYFX structure that contains the overlay data.
  • ddRVal
    Passes the DirectDraw return values.

Requirements

Header

ddrawi.h

See Also

Reference

DirectDrawSurface Structures
LPDDHALSURFCB_UPDATEOVERLAY
DDRAWI_DIRECTDRAW_GBL
DDRAWI_DDRAWSURFACE_LCL

Other Resources

DDOVERLAYFX