Edit

Share via

DXGKDDI_GETMULTIPLANEOVERLAYCAPS callback function (d3dkmddi.h)

  • Article

Called to retrieve multiplane overlay capabilities. Support for this DDI is required for any WDDM 2.2 driver that wants to support multiple planes.

Syntax

DXGKDDI_GETMULTIPLANEOVERLAYCAPS DxgkddiGetmultiplaneoverlaycaps;

NTSTATUS DxgkddiGetmultiplaneoverlaycaps(
  [in]     IN_CONST_HANDLE hAdapter,
  [in/out] IN_OUT_PDXGKARG_GETMULTIPLANEOVERLAYCAPS pGetMultiPlaneOverlayCaps
)
{...}

Parameters

[in] hAdapter

Identifies the adapter containing the overlay hardware.

[in/out] pGetMultiPlaneOverlayCaps

A pointer to a DXGKARG_GETMULTIPLANEOVERLAYCAPS structure that receives the driver capabilities.

Return value

DXGKDDI_GETMULTIPLANEOVERLAYCAPS returns the following values:

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

Remarks

This function is called at PASSIVE_LEVEL.

The multiplane overlay capabilities are allowed to change due to display configuration changes.

For WDDM 2.2 drivers, this DDI is used to retrieve the multiplane overlay capabilities rather than the user mode DDIs.

Requirements

Requirement Value
Target Platform Windows
Header d3dkmddi.h