Edit

DXGK_MULTIPLANE_OVERLAY_PLANE structure (d3dkmddi.h)

  • Article

Specifies an overlay plane to display in a call to the DxgkDdiSetVidPnSourceAddressWithMultiPlaneOverlay function.

Syntax

typedef struct _DXGK_MULTIPLANE_OVERLAY_PLANE {
       UINT                               LayerIndex;
       BOOL                               Enabled;
  [in] UINT                               AllocationSegment;
  [in] PHYSICAL_ADDRESS                   AllocationAddress;
       HANDLE                             hAllocation;
       DXGK_MULTIPLANE_OVERLAY_ATTRIBUTES PlaneAttributes;
} DXGK_MULTIPLANE_OVERLAY_PLANE;

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.

If FALSE, the display miniport driver should disable the specified overlay plane.

If a plane was enabled during a previous call to DxgkDdiSetVidPnSourceAddressWithMultiPlaneOverlay, the driver should continue to display the plane without flipping it.

[in] AllocationSegment

The identifier of a segment that data is read from.

[in] 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_ATTRIBUTES that specifies overlay plane attributes.

Requirements

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

See also

DXGK_ALLOCATIONINFO

DXGK_MULTIPLANE_OVERLAY_ATTRIBUTES

DxgkDdiCreateAllocation

DxgkDdiSetVidPnSourceAddressWithMultiPlaneOverlay