DXGKCB_QUERYVIDPNINTERFACE callback function (d3dkmddi.h)

Article
02/22/2024

DXGKCB_QUERYVIDPNINTERFACE obtains a pointer to a DXGK_VIDPN_INTERFACE structure, which contains pointers to functions that the display miniport driver can call to inspect and alter a VidPN object.

Syntax

DXGKCB_QUERYVIDPNINTERFACE DxgkcbQueryvidpninterface;

NTSTATUS DxgkcbQueryvidpninterface(
  [in]  IN_CONST_D3DKMDT_HVIDPN hVidPn,
  [in]  IN_CONST_DXGK_VIDPN_INTERFACE_VERSION VidPnInterfaceVersion,
  [out] DEREF_OUT_CONST_PPDXGK_VIDPN_INTERFACE ppVidPnInterface
)
{...}

Parameters

[in] hVidPn

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

[in] VidPnInterfaceVersion

A DXGK_VIDPN_INTERFACE_VERSION enumerator that specifies the version of the VidPN interface being requested. Callers must set this parameter to DXGK_VIDPN_INTERFACE_VERSION_V1.

[out] ppVidPnInterface

A pointer to a variable that receives a pointer to the DXGK_VIDPN_INTERFACE structure.

Return value

DxgkCbQueryVidPnInterface returns one of the following values:

Return code	Description
STATUS_SUCCESS	The function succeeded.
STATUS_INVALID_PARAMETER	The value passed to ppVidPnInterface is not valid.
STATUS_GRAPHICS_INVALID_VIDPN	The handle passed to hVidPn is not valid.
STATUS_NOT_SUPPORTED	The interface version specified by VidPnInterfaceVersion is not supported.

Remarks

DXGKCB_XXX functions are implemented by Dxgkrnl. To use this callback function, the kernel-mode driver calls DxgkCbQueryVidPnInterface via the DXGKRNL_INTERFACE.

Requirements

Requirement	Value
Minimum supported client	Windows Vista (WDDM 1.0)
Target Platform	Desktop
Header	d3dkmddi.h (include D3dkmddi.h)
IRQL	<= APC_LEVEL