PFND3DDDI_PRESENTMULTIPLANEOVERLAYCB callback function (d3dumddi.h)

Article
04/01/2021

Copies content from a source multiplane overlay allocation to a destination allocation. Can be called by Windows Display Driver Model (WDDM) 1.3 or later user-mode display drivers.

Syntax

PFND3DDDI_PRESENTMULTIPLANEOVERLAYCB Pfnd3dddiPresentmultiplaneoverlaycb;

HRESULT Pfnd3dddiPresentmultiplaneoverlaycb(
  HANDLE hDevice,
  const D3DDDICB_PRESENTMULTIPLANEOVERLAY *unnamedParam2
)
{...}

Parameters

hDevice

A handle to a display device (graphics context).

unnamedParam2

pPresent [in]

A pointer to a D3DDDICB_PRESENTMULTIPLANEOVERLAY structure that describes the source and destination allocations that content is copied from and to.

Return value

Returns one of these values:

Return code	Description
S_OK	Content was successfully copied.
E_OUTOFMEMORY	The function could not complete because of insufficient memory.
E_INVALIDARG	Parameters were validated and determined to be incorrect.

Remarks

The user-mode display driver should call this function only after it has successfully processed a call by the Microsoft DirectX Graphics Infrastructure (DXGI) runtime to the pfnPresentMultiplaneOverlay (D3D) function.

Note When the display driver calls pfnPresentMultiPlaneOverlayCb (D3D), it must maintain the same order of allocations in the AllocationInfo array member of the D3DDDICB_PRESENTMULTIPLANEOVERLAY structure as it received from the Microsoft Direct3D runtime when the runtime called pfnPresentMultiplaneOverlay (D3D).

For example, the allocation handle in index 1 of AllocationInfo must represent the same resource that was passed to the driver in index 1 of the pPresentPlanes member of the D3DDDIARG_PRESENTMULTIPLANEOVERLAY structure used with pfnPresentMultiplaneOverlay (D3D).

Requirements

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