DXGK_VIDPN_INTERFACE::pfnGetTopology routine

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

Syntax


DXGKDDI_VIDPN_GETTOPOLOGY pfnGetTopology;

NTSTATUS APIENTRY pfnGetTopology(
  _In_   const D3DKMDT_HVIDPN hVidPn,
  _Out_  D3DKMDT_HVIDPNTOPOLOGY *phVidPnTopology,
  _Out_  const DXGK_VIDPNTOPOLOGY_INTERFACE **ppVidPnTopologyInterface
)
{ ... }

Parameters

hVidPn [in]

[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]

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

ppVidPnTopologyInterface [out]

[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 codeDescription
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

Version

Available in Windows Vista and later versions of the Windows operating systems.

Header

D3dkmddi.h (include D3dkmddi.h)

IRQL

PASSIVE_LEVEL

See also

VidPN Topology Interface
DXGK_VIDPNTOPOLOGY_INTERFACE

 

 

Send comments about this topic to Microsoft

Show:
© 2014 Microsoft. All rights reserved.