Expand Minimize

D3DDDI_OVERLAYINFO structure

The D3DDDI_OVERLAYINFO structure describes information about an overlay.

Syntax


typedef struct _D3DDDI_OVERLAYINFO {
  HANDLE                  hResource;
  UINT                    SubResourceIndex;
  RECT                    DstRect;
  RECT                    SrcRect;
  UINT                    DstColorKeyLow;
  UINT                    DstColorKeyHigh;
  UINT                    SrcColorKeyLow;
  UINT                    SrcColorKeyHigh;
  D3DDDI_OVERLAYINFOFLAGS Flags;
} D3DDDI_OVERLAYINFO;

Members

hResource

[in] A handle to the resource that is displayed by using the overlay. The resource is created through a call to the CreateResource function with the Overlay bit-field flag set in the Flags member of the D3DDDIARG_CREATERESOURCE structure that is pointed to by the pResource parameter.

SubResourceIndex

[in] The index to the subresource if the resource that is specified by the hResource member contains a list of allocations.

DstRect

[in] A RECT structure for the destination rectangle, which contains the output coordinates for the display.

SrcRect

[in] A RECT structure for the source rectangle that is displayed.

DstColorKeyLow

[in] A value for the destination color key when the DstColorKey bit-field flag is set in the Flags member. If the color key is a range, DstColorKeyLow contains the low end of the range. The value is in the native format of the primary surface that is overlayed.

DstColorKeyHigh

[in] The high end of the destination color key range when the DstColorKeyRange bit-field flag is set in Flags. The value is in the native format of the primary surface that is overlayed.

SrcColorKeyLow

[in] A value for the source color key when the SrcColorKey bit-field flag is set in the Flags member. If the color key is a range, SrcColorKeyLow contains the low end of the range. The value is in the native format of the overlay resource that is displayed.

SrcColorKeyHigh

[in] The high end of the source color key range when the SrcColorKeyRange bit-field flag is set in Flags. The value is in the native format of the overlay resource that is displayed.

Flags

[in] A D3DDDI_OVERLAYINFOFLAGS structure that identifies the type of overlay operation to perform. Note that some flags are mutually exclusive with other flags. For more information, see the following Remarks section.

Remarks

The SrcColorKey, SrcColorKeyRange, DstColorKey, and DstColorKeyRange bit-field flags are never set simultaneously in the Flags member.

Requirements

Version

Available in Windows Vista and later versions of the Windows operating systems.

Header

D3dumddi.h (include D3dumddi.h)

See also

CreateOverlay
CreateResource
D3DDDIARG_CREATERESOURCE
D3DDDI_OVERLAYINFOFLAGS
RECT
UpdateOverlay

 

 

Send comments about this topic to Microsoft

Show:
© 2014 Microsoft. All rights reserved.