DXGIDDICB_PRESENT_MULTIPLANE_OVERLAY structure (dxgiddi.h)

Describes multiplane overlay allocations that content is copied to and from.

Syntax

typedef struct DXGIDDICB_PRESENT_MULTIPLANE_OVERLAY {
  [in] void                                       *pDXGIContext;
  [in] HANDLE                                     hContext;
  [in] UINT                                       BroadcastContextCount;
       HANDLE                                     BroadcastContext[D3DDDI_MAX_BROADCAST_CONTEXT];
  [in] DWORD                                      AllocationInfoCount;
       DXGIDDI_MULTIPLANE_OVERLAY_ALLOCATION_INFO AllocationInfo[DXGI_DDI_MAX_MULTIPLANE_OVERLAY_ALLOCATIONS];
} DXGIDDICB_PRESENT_MULTIPLANE_OVERLAY;

Members

[in] pDXGIContext

A handle to the Microsoft DirectX Graphics Infrastructure (DXGI) context. This handle is opaque to the driver. The driver should assign the handle from the pDXGIContext member of the DXGI_DDI_ARG_PRESENTMULTIPLANEOVERLAY structure that the driver received in a call to its pfnPresentMultiplaneOverlay (DXGI) function to this member.

[in] hContext

A handle to the context that the driver submits the copy operation to. The user-mode display driver previously created this context by calling the pfnCreateContextCb function.

[in] BroadcastContextCount

The number of additional contexts in the array that the BroadcastContext member specifies.

[in] BroadcastContext[D3DDDI_MAX_BROADCAST_CONTEXT]

An array of handles to the additional contexts to broadcast the current present operation to. The D3DDDI_MAX_BROADCAST_CONTEXT constant, which is defined as 64, defines the maximum number of additional contexts that the user-mode display driver can broadcast the current present operation to.

Broadcasting is supported only for flip operations. To broadcast a flip operation, the display miniport driver must support memory mapped I/O (MMIO)-based flips. To indicate support of MMIO flips, the display miniport driver sets the FlipOnVSyncMmIo bit-field flag in the FlipCaps member of the DXGK_DRIVERCAPS structure when its DxgkDdiQueryAdapterInfo function is called.

The original context that the hContext member specifies and that the user-mode display driver presents to is not an element in the BroadcastContext array. For example, if the BroadcastContext array contains one element, the user-mode display driver sends the present operation to the owning context (hContext) and broadcasts to that one additional context.

[in] AllocationInfoCount

The number of allocations in the array that the AllocationInfo member specifies. The maximum number is 16, the value of the DXGI_DDI_MAX_MULTIPLANE_OVERLAY_ALLOCATIONS constant.

AllocationInfo[DXGI_DDI_MAX_MULTIPLANE_OVERLAY_ALLOCATIONS]

An array of structures of type DXGIDDI_MULTIPLANE_OVERLAY_ALLOCATION_INFO that specify info about the multiplane overlay allocations.

Requirements

See also

DXGIDDI_MULTIPLANE_OVERLAY_ALLOCATION_INFO

DXGI_DDI_ARG_PRESENTMULTIPLANEOVERLAY

DXGK_DRIVERCAPS

pfnCreateContextCb

pfnPresentMultiplaneOverlay (DXGI)