DXGK_MULTIPLANE_OVERLAY_PLANE2 structure (d3dkmddi.h)

DXGK_MULTIPLANE_OVERLAY_PLANE2 is used with the DxgkDdiSetVidPnSourceAddressWithMultiPlaneOverlay2 function to specify an overlay plane to display.

Syntax

typedef struct _DXGK_MULTIPLANE_OVERLAY_PLANE2 {
  UINT                                LayerIndex;
  BOOL                                Enabled;
  UINT                                AllocationSegment;
  PHYSICAL_ADDRESS                    AllocationAddress;
  HANDLE                              hAllocation;
  DXGK_MULTIPLANE_OVERLAY_ATTRIBUTES2 PlaneAttributes;
} DXGK_MULTIPLANE_OVERLAY_PLANE2;

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.

AllocationSegment

The identifier of a segment that data is read from.

AllocationAddress

A PHYSICAL_ADDRESS data type (which is defined as LARGE_INTEGER) that indicates the physical address within the segment that AllocationSegment specifies, where the data is read.

hAllocation

A handle to the allocation to be displayed on the overlay plane.

PlaneAttributes

A structure of type DXGK_MULTIPLANE_OVERLAY_ATTRIBUTES2 that specifies overlay plane attributes.

Requirements

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

See also

DXGK_MULTIPLANE_OVERLAY_ATTRIBUTES2

DxgkDdiSetVidPnSourceAddressWithMultiPlaneOverlay2