D3DDDI_PRESENT_MULTIPLANE_OVERLAY structure (d3dumddi.h)

Specifies an overlay plane to display.

Syntax

typedef struct _D3DDDI_PRESENT_MULTIPLANE_OVERLAY {
  UINT                                 LayerIndex;
  BOOL                                 Enabled;
  HANDLE                               hResource;
  UINT                                 SubResourceIndex;
  D3DDDI_MULTIPLANE_OVERLAY_ATTRIBUTES PlaneAttributes;
} D3DDDI_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 if 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 D3DDDI_MULTIPLANE_OVERLAY_ATTRIBUTES structure that specifies overlay plane attributes.

Requirements

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

See also

D3DDDI_MULTIPLANE_OVERLAY_ATTRIBUTES