pfnPresentMultiPlaneOverlayCb (DXGI) function

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


_Check_return_ HRESULT APIENTRY CALLBACK* pfnPresentMultiPlaneOverlayCb(
  _In_  HANDLE hDevice,
  _In_  const DXGIDDICB_PRESENT_MULTIPLANE_OVERLAY *pOverlay
);

Parameters

hDevice [in]

A handle to a display device (graphics context).

pOverlay [in]

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

Return value

Returns one of these values:

Return codeDescription
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 (DXGI) function.

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

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 DXGI_DDI_ARG_PRESENTMULTIPLANEOVERLAY structure used with pfnPresentMultiplaneOverlay (DXGI).

Requirements

Minimum supported client

Windows 8.1

Minimum supported server

Windows Server 2012 R2

Header

Dxgiddi.h (include D3d10umddi.h)

See also

DXGI_DDI_ARG_PRESENTMULTIPLANEOVERLAY
DXGIDDICB_PRESENT_MULTIPLANE_OVERLAY
pfnPresentMultiplaneOverlay (DXGI)

 

 

Send comments about this topic to Microsoft

Show:
© 2014 Microsoft. All rights reserved.