This topic has not yet been rated - Rate this topic

DXGK_VIDPNSOURCEMODESET_INTERFACE::pfnAcquireFirstModeInfo routine

The pfnAcquireFirstModeInfo function returns a descriptor of the first mode in a specified VidPN source mode set.

Syntax


DXGKDDI_VIDPNSOURCEMODESET_ACQUIREFIRSTMODEINFO pfnAcquireFirstModeInfo;

NTSTATUS APIENTRY pfnAcquireFirstModeInfo(
  _In_   const D3DKMDT_HVIDPNSOURCEMODESET hVidPnSourceModeSet,
  _Out_  const D3DKMDT_VIDPN_SOURCE_MODE **ppFirstVidPnSourceModeInfo
)
{ ... }

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.
ppFirstVidPnSourceModeInfo [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 mode, including its ID, type, and rendering format.

Return value

The pfnAcquireFirstModeInfo function returns one of the following values:

Return code	Description
STATUS_SUCCESS	The function succeeded.
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.

You can enumerate all the modes that belong to a VidPN source mode set object by calling pfnAcquireFirstModeInfo and then making a sequence of calls to pfnAcquireNextModeInfo.

The D3DKMDT_HVIDPNSOURCEMODESET data type is defined in D3dkmdt.h.

Requirements