Edit

DXGKDDI_CHECKMULTIPLANEOVERLAYSUPPORT3 callback function (d3dkmddi.h)

  • Article

In WDDM 2.1 and later versions, the DirectX graphics kernel subsystem calls a driver's DXGKDDI_CHECKMULTIPLANEOVERLAYSUPPORT3 callback routine to determine whether a specific multi-plane overlay configuration is supported. It must be implemented by WDDM 2.1 and later version drivers that support multi-plane overlays.

Syntax

DXGKDDI_CHECKMULTIPLANEOVERLAYSUPPORT3 DxgkddiCheckmultiplaneoverlaysupport3;

NTSTATUS DxgkddiCheckmultiplaneoverlaysupport3(
  IN_CONST_HANDLE hAdapter,
  IN_OUT_PDXGKARG_CHECKMULTIPLANEOVERLAYSUPPORT3 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_CHECKMULTIPLANEOVERLAYSUPPORT3 structure that describes the surfaces and display options to present.

Return value

DXGKDDI_CHECKMULTIPLANEOVERLAYSUPPORT3 returns the following values:

Return code Description
STATUS_SUCCESS The routine has successfully completed.

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 to this configuration getting set.

This function is always called at PASSIVE level.

Requirements

Requirement Value
Minimum supported client Windows 10, version 1607 (WDDM 2.1)
Target Platform Windows
Header d3dkmddi.h

See also

DXGKARG_CHECKMULTIPLANEOVERLAYSUPPORT3