DXGKDDI_CHECKMULTIPLANEOVERLAYSUPPORT2 callback function (d3dkmddi.h)

The DirectX graphics kernel subsystem calls a WDDM 2.0 driver's DXGKDDI_CHECKMULTIPLANEOVERLAYSUPPORT2 callback routine to determine whether a specific multi-plane overlay configuration is supported. It must be implemented by WDDM 2.0 drivers that support multi-plane overlays. This function has been replaced with DXGKDDI_CHECKMULTIPLANEOVERLAYSUPPORT3.

Syntax

DXGKDDI_CHECKMULTIPLANEOVERLAYSUPPORT2 DxgkddiCheckmultiplaneoverlaysupport2;

NTSTATUS DxgkddiCheckmultiplaneoverlaysupport2(
  IN_CONST_HANDLE hAdapter,
  IN_OUT_PDXGKARG_CHECKMULTIPLANEOVERLAYSUPPORT2 pCheckMultiPlaneOverlaySupport
)
{...}

Parameters

hAdapter

Identifies the adapter containing the overlay hardware. The display miniport driver previously provided this handle to the DirectX graphics kernel subsystem in the MiniportDeviceContext output parameter of the DxgkDdiAddDevice function.

pCheckMultiPlaneOverlaySupport

A pointer to a DXGKARG_CHECKMULTIPLANEOVERLAYSUPPORT2 structure that describes the surfaces and display options to present.

Return value

If this routine succeeds, it returns NTSTATUS_SUCCESS. The driver should always return a success code.

Remarks

The kernel-mode driver reports whether the specified configuration is supported. The kernel-mode driver should not raise or lower the available bandwidth in anticipation of this configuration getting set.

Requirements

Requirement Value
Minimum supported client Windows 10 (WDDM 2.0)
Minimum supported server Windows Server 2016
Target Platform Desktop
Header d3dkmddi.h (include D3dkmddi.h)
IRQL PASSIVE_LEVEL

See also

DXGKARG_CHECKMULTIPLANEOVERLAYSUPPORT2