DXGKCB_MULTIPLANEOVERLAYDISABLED callback function

This callback allows the kernel mode driver to indicate that the current multiplane overlay configuration is no longer supported on the specified VidPnSourceId.

Syntax

DXGKCB_MULTIPLANEOVERLAYDISABLED DxgkcbMultiplaneoverlaydisabled;

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

Parameters

hAdapter

Indicates the adapter on which the current multiplane overlay hardware configuration is no longer supported.

VidPnSourceId

Indicates the VidPnSourceId on which the current multiplane overlay hardware configuration is no longer supported.

Return Value

DXGKCB_MULTIPLANEOVERLAYDISABLED returns one of the following values:

Return code Description
STATUS_SUCCESS If the call has been successfully completed.

Remarks

This callback will notify the DWM that the current MPO configuration is no longer supported, allowing the DWM to fall back to composition.

This callback can only be called at passive level.

This callback can be used in 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.

Requirements

   
Target Platform Windows
Header d3dkmddi.h
IRQL requires_max_(PASSIVE_LEVEL)