Edit

DXGK_MULTIPLANE_OVERLAY_ATTRIBUTES2 structure (d3dkmddi.h)

  • Article

DXGK_MULTIPLANE_OVERLAY_ATTRIBUTES2 is used by the display miniport driver to specify overlay plane attributes.

Syntax

typedef struct _DXGK_MULTIPLANE_OVERLAY_ATTRIBUTES2 {
  DXGK_MULTIPLANE_OVERLAY_FLAGS              Flags;
  RECT                                       SrcRect;
  RECT                                       DstRect;
  RECT                                       ClipRect;
  D3DDDI_ROTATION                            Rotation;
  DXGK_MULTIPLANE_OVERLAY_BLEND              Blend;
  DXGK_MULTIPLANE_OVERLAY_VIDEO_FRAME_FORMAT VideoFrameFormat;
  D3DDDI_COLOR_SPACE_TYPE                    ColorSpaceType;
  DXGK_MULTIPLANE_OVERLAY_STEREO_FORMAT      StereoFormat;
  BOOL                                       StereoLeftViewFrame0;
  BOOL                                       StereoBaseViewFrame0;
  DXGK_MULTIPLANE_OVERLAY_STEREO_FLIP_MODE   StereoFlipMode;
  DXGK_MULTIPLANE_OVERLAY_STRETCH_QUALITY    StretchQuality;
  UINT                                       Reserved1;
} DXGK_MULTIPLANE_OVERLAY_ATTRIBUTES2;

Members

Flags

Specifies a combination of flip operations by performing a bitwise OR operation on the values in the DXGK_MULTIPLANE_OVERLAY_FLAGS enumeration.

SrcRect

Specifies the source rectangle relative to the source resource.

DstRect

Specifies the destination rectangle relative to the monitor resolution.

ClipRect

Specifies any additional clipping region relative to DstRect after the data has been stretched according to the values of SrcRect and DstRect.

The driver and hardware can use the ClipRect member to apply a common stretch factor as the clipping changes when an application occludes part of the DstRect destination rectangle.

Rotation

Specifies the clockwise rotation of the overlay plane, given as a value from the D3DDDI_ROTATION enumeration.

Blend

Specifies the blend mode that applies to this overlay plane and the plane beneath it, given as a value from the DXGK_MULTIPLANE_OVERLAY_BLEND enumeration.

VideoFrameFormat

Specifies the overlay plane's video frame format, given as a value from the DXGK_MULTIPLANE_OVERLAY_VIDEO_FRAME_FORMAT enumeration.

ColorSpaceType

Specifies the color space configuration, given as a value from the D3DDDI_COLOR_SPACE_TYPE enumeration.

StereoFormat

Specifies the overlay plane's video frame format, given as a value from the DXGK_MULTIPLANE_OVERLAY_STEREO_FORMAT enumeration.

StereoLeftViewFrame0

Reserved for system use. Must always be FALSE.

StereoBaseViewFrame0

Reserved for system use. Must always be FALSE.

StereoFlipMode

Specifies the overlay plane's stereo flip mode, given as a value from the DXGK_MULTIPLANE_OVERLAY_STEREO_FLIP_MODE enumeration.

StretchQuality

Specifies the overlay plane's stretch quality, given as a value from the DXGK_MULTIPLANE_OVERLAY_STRETCH_QUALITY enumeration.

Reserved1

ColorKey

Specifies the color key value used when color key blending is enabled for legacy overlays.

Requirements

Requirement Value
Minimum supported client Windows 10
Minimum supported server Windows Server 2016
Header d3dkmddi.h (include D3dkmddi.h)

See also

D3DDDI_COLOR_SPACE_TYPE

D3DDDI_ROTATION

DXGK_MULTIPLANE_OVERLAY_BLEND

DXGK_MULTIPLANE_OVERLAY_FLAGS

DXGK_MULTIPLANE_OVERLAY_STEREO_FLIP_MODE

DXGK_MULTIPLANE_OVERLAY_STEREO_FORMAT

DXGK_MULTIPLANE_OVERLAY_STRETCH_QUALITY

DXGK_MULTIPLANE_OVERLAY_VIDEO_FRAME_FORMAT