DXGKDDI_VIDPN_GETTOPOLOGY callback function

The pfnGetTopology function returns a handle to the VidPN topology object contained by a specified VidPN object.

Syntax

DXGKDDI_VIDPN_GETTOPOLOGY DxgkddiVidpnGettopology;

NTSTATUS DxgkddiVidpnGettopology(
  IN_CONST_D3DKMDT_HVIDPN hVidPn,
  OUT_PD3DKMDT_HVIDPNTOPOLOGY phVidPnTopology,
  DEREF_OUT_CONST_PPDXGK_VIDPNTOPOLOGY_INTERFACE ppVidPnTopologyInterface
)
{...}

Parameters

hVidPn

[in] A handle to a VidPN object. The VidPN manager previously provided this handle to the display miniport driver by calling DxgkDdiEnumVidPnCofuncModality, DxgkDdiIsSupportedVidPn, or DxgkDdiRecommendFunctionalVidPn.

phVidPnTopology

[out] A pointer to a variable that receives a handle to the VidPN topology object.

ppVidPnTopologyInterface

[out] A pointer to a variable that receives a pointer to a DXGK_VIDPNTOPOLOGY_INTERFACE structure. The structure contains pointers to functions that the display miniport driver can call to inspect and alter the VidPN topology object.

Return Value

The pfnGetTopology function returns one of the following values:

Return code Description
STATUS_SUCCESS The function succeeded.
STATUS_GRAPHICS_INVALID_VIDPN The handle supplied in hVidPn was invalid.

Remarks

The display miniport driver does not need to release the handle that it receives in phVidPnTopology.

The lifetime of the DXGK_VIDPNTOPOLOGY_INTERFACE structure returned in ppVidPnTopologyInterface is owned by the operating system. Using this ownership scheme, the operating system can migrate to newer implementations at run time without breaking clients of the interface.

Requirements

   
Minimum supported client Available in Windows Vista and later versions of the Windows operating systems.
Target Platform Desktop
Header d3dkmddi.h (include D3dkmddi.h)
IRQL PASSIVE_LEVEL

See Also

DXGK_VIDPNTOPOLOGY_INTERFACE

VidPN Topology Interface