DXGK_MULTIPLANE_OVERLAY_ATTRIBUTES structure

Used by the display miniport driver to specify overlay plane attributes.

Syntax

typedef struct _DXGK_MULTIPLANE_OVERLAY_ATTRIBUTES {
  DXGK_MULTIPLANE_OVERLAY_FLAGS              Flags;
  RECT                                       SrcRect;
  RECT                                       DstRect;
  RECT                                       ClipRect;
  D3DDDI_ROTATION                            Rotation;
  DXGK_MULTIPLANE_OVERLAY_BLEND              Blend;
  UINT                                       NumFilters;
  void                                       *pFilters;
  DXGK_MULTIPLANE_OVERLAY_VIDEO_FRAME_FORMAT VideoFrameFormat;
  DXGK_MULTIPLANE_OVERLAY_YCbCr_FLAGS        YCbCrFlags;
  DXGK_MULTIPLANE_OVERLAY_STEREO_FORMAT      StereoFormat;
  BOOL                                       StereoLeftViewFrame0;
  BOOL                                       StereoBaseViewFrame0;
  DXGK_MULTIPLANE_OVERLAY_STEREO_FLIP_MODE   StereoFlipMode;
  DXGK_MULTIPLANE_OVERLAY_STRETCH_QUALITY    StretchQuality;
} DXGK_MULTIPLANE_OVERLAY_ATTRIBUTES;

Members

Flags

Specifies a flip operation as one of the applicable constant values in the DXGK_MULTIPLANE_OVERLAY_FLAGS enumeration.

SrcRect

Specifies the source rectangle, of type RECT, relative to the source resource.

DstRect

Specifies the destination rectangle, of type RECT, relative to the monitor resolution.

ClipRect

Specifies any additional clipping, of type RECT, relative to the DstRect rectangle, 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 app 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.

NumFilters

Optionally specifies the number of filters that the driver and hardware implement on the overlay plane. Note that the operating system ignores this member.

pFilters

An optional pointer to a buffer that specifies the filters that the driver and hardware implement on the overlay plane. Note that the operating system ignores this member.

VideoFrameFormat

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

Note This value must always be DXGK_MULTIPLANE_OVERLAY_VIDEO_FRAME_FORMAT_PROGRESSIVE. The operating system does not support the other enumeration values.

YCbCrFlags

Specifies YUV range and conversion info given as a value from the DXGK_MULTIPLANE_OVERLAY_YCbCr_FLAGS enumeration.

StereoFormat

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

Note This value must always be DXGK_MULTIPLANE_OVERLAY_STEREO_FORMAT_MONO. The operating system does not support the other enumeration values.

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.

Note This value must always be DXGK_MULTIPLANE_OVERLAY_STEREO_FLIP_NONE. The operating system does not support the other enumeration values.

StretchQuality

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

Requirements

   
Minimum supported client Windows 8.1
Minimum supported server Windows Server 2012 R2
Header d3dkmddi.h (include D3dkmddi.h)

See Also

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

DXGK_MULTIPLANE_OVERLAY_YCbCr_FLAGS