DXGKCB_MULTIPLANEOVERLAYDISABLED callback function (d3dkmddi.h)

Article
02/22/2024

A kernel-mode display miniport driver calls DXGKCB_MULTIPLANEOVERLAYDISABLED to indicate that the current multiplane overlay (MPO) configuration is no longer supported on the specified VidPnSourceId.

Syntax

DXGKCB_MULTIPLANEOVERLAYDISABLED DxgkcbMultiplaneoverlaydisabled;

void DxgkcbMultiplaneoverlaydisabled(
  [in] IN_CONST_HANDLE hAdapter,
  [in] UINT VidPnSourceId
)
{...}

Parameters

[in] hAdapter

Handle to the adapter on which the current MPO hardware configuration is no longer supported.

[in] VidPnSourceId

The VidPnSourceId on which the current MPO hardware configuration is no longer supported.

Return value

None

Remarks

DXGKCB_MULTIPLANEOVERLAYDISABLED notifies the Desktop Windows Manager (DWM) that the current MPO configuration is no longer supported, allowing the DWM to fall back to composition.

This request is processed asynchronously and can be delayed by several frames. It is recommended to call this function only in exceptional cases such as the following scenarios:

A display change or hot plug event on one output makes it no longer possible to continue supporting an MPO configuration that is committed to a different monitor. In this case, the driver can disable the overlay planes on the monitor. The user will see a visible artifact but it should be corrected eventually by the DWM.
MPO should be disabled due to thermal issues. In this case, the driver does not need to immediately disable MPO, but can wait until the DWM receives the notification and requires MPO support (which the KMD should indicate is not supported due to the thermal issue). At that time, the DWM will disable MPO and start composing.

For typical cases, drivers should instead prevent incompatible multiplane overlay configurations by responding correctly to DxgkDdiCheckMultiplaneOverlaySupport3.

DXGKCB_XXX functions are implemented by Dxgkrnl. To use this callback function, call DxgkCbMultiPlaneOverlayDisabled via the DXGKRNL_INTERFACE.

Requirements

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