DXGKDDI_RECOMMENDVIDPNTOPOLOGY callback function (d3dkmddi.h)

Article
02/22/2024

The DxgkDdiRecommendVidPnTopology function creates the topology of a specified VidPN or augments the topology with a new path to video present targets.

Syntax

DXGKDDI_RECOMMENDVIDPNTOPOLOGY DxgkddiRecommendvidpntopology;

NTSTATUS DxgkddiRecommendvidpntopology(
       IN_CONST_HANDLE hAdapter,
  [in] IN_CONST_PDXGKARG_RECOMMENDVIDPNTOPOLOGY_CONST pRecommendVidPnTopology
)
{...}

Parameters

hAdapter

A handle to a context block that is associated with a display adapter. The display miniport driver previously provided this handle to the Microsoft DirectX graphics kernel subsystem in the MiniportDeviceContext output parameter of the DxgkDdiAddDevice function.

[in] pRecommendVidPnTopology

A pointer to a DXGKARG_RECOMMENDVIDPNTOPOLOGY structure that contains function arguments.

Return value

DxgkDdiRecommendVidPnTopology returns one of the following values:

Return code	Description
STATUS_SUCCESS	The function successfully created or augmented the topology.
STATUS_GRAPHICS_NO_RECOMMENDED_VIDPN_TOPOLOGY	The function has no recommendation for the augmentation of the specified VidPN topology.
STATUS_GRAPHICS_CANCEL_VIDPN_TOPOLOGY_AUGMENTATION	The function recommends to cancel the augmentation of the specified VidPN's topology on the specified source. This return code is allowed only in the case of VidPN topology augmentation.
STATUS_NO_MEMORY	The function failed because it was unable to allocate enough memory.

The miniport driver should pass through any error code that it gets from the operating system for which it does not have a fallback code path.

Remarks

DxgkDdiRecommendVidPnTopology should be made pageable.

Requirements

Requirement	Value
Minimum supported client	Windows Vista
Target Platform	Desktop
Header	d3dkmddi.h
IRQL	PASSIVE_LEVEL