Edit

Share via

DXGI_DDI_PRESENT_MULTIPLANE_OVERLAY structure (dxgiddi.h)

  • Article

Specifies overlay planes to display.

Syntax

typedef struct _DXGI_DDI_PRESENT_MULTIPLANE_OVERLAY {
  UINT                                   LayerIndex;
  BOOL                                   Enabled;
  DXGI_DDI_HRESOURCE                     hResource;
  UINT                                   SubResourceIndex;
  DXGI_DDI_MULTIPLANE_OVERLAY_ATTRIBUTES PlaneAttributes;
} DXGI_DDI_PRESENT_MULTIPLANE_OVERLAY;

Members

LayerIndex

The zero-based index of the overlay plane to display. The top plane (in the z-direction) has index zero. The planes' index values must be sequential from top to bottom.

Enabled

Indicates whether the overlay plane specified by LayerIndex is enabled for display.

hResource

A handle to the resource that is displayed by using the overlay plane.

SubResourceIndex

The zero-based index into the resource, which is specified by the handle in the hResource member. This index indicates the subresource, or surface, on which an overlay plane is to be displayed.

PlaneAttributes

A structure of type DXGI_DDI_MULTIPLANE_OVERLAY_ATTRIBUTES that specifies overlay plane attributes.

Requirements

Requirement Value
Minimum supported client Windows 8.1
Minimum supported server Windows Server 2012 R2
Header dxgiddi.h (include D3d10umddi.h)

See also

DXGI_DDI_MULTIPLANE_OVERLAY_ATTRIBUTES