DXGK_VIDPNSOURCEMODESET_INTERFACE::pfnAcquirePinnedModeInfo routine

The pfnAcquirePinnedModeInfo function returns a descriptor of the pinned mode in a specified VidPN source mode set.

Syntax


DXGKDDI_VIDPNSOURCEMODESET_ACQUIREPINNEDMODEINFO pfnAcquirePinnedModeInfo;

NTSTATUS APIENTRY pfnAcquirePinnedModeInfo(
  _In_  const D3DKMDT_HVIDPNSOURCEMODESET hVidPnSourceModeSet,
  _Out_ const D3DKMDT_VIDPN_SOURCE_MODE   **ppPinnedVidPnSourceModeInfo
)
{ ... }

Parameters

hVidPnSourceModeSet [in]

[in] A handle to a VidPN source mode set object. The display miniport driver previously obtained this handle by calling the pfnAcquireSourceModeSet function of the DXGK_VIDPN_INTERFACE interface.

ppPinnedVidPnSourceModeInfo [out]

[out] A pointer to a variable that receives a pointer to a D3DKMDT_VIDPN_SOURCE_MODE structure. The structure contains a variety of information about the pinned mode, including its ID, type, and rendering format. If the source mode set identified by hVidPnSourceModeSet has no pinned mode, then this variable receives a NULL pointer.

Return value

The pfnAcquirePinnedModeInfo function returns one of the following values:

Return codeDescription
STATUS_SUCCESS

The function succeeded by doing one of the following:

Setting ppPinnedVidPnSourceModeInfo to the address of D3DKMDT_VIDPN_SOURCE_MODE structure that describes the pinned mode.

Setting ppPinnedVidPnSourceModeInfo to NULL to indicate that the source mode set has no pinned mode.

STATUS_GRAPHICS_INVALID_VIDPN_SOURCEMODESET

The handle supplied in hVidPnSourceModeSet was invalid.

 

Remarks

When you have finished using the D3DKMDT_VIDPN_SOURCE_MODE structure, you must release the structure by calling pfnReleaseModeInfo.

The D3DKMDT_HVIDPNSOURCEMODESET data type is defined in D3dkmdt.h.

Requirements

Target platform

Version

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

Header

D3dkmddi.h (include D3dkmddi.h)

IRQL

PASSIVE_LEVEL

See also

pfnReleaseModeInfo
pfnPinMode
D3DKMDT_VIDPN_SOURCE_MODE

 

 

Send comments about this topic to Microsoft

Show: