DXGKDDI_VIDPNSOURCEMODESET_ACQUIREPINNEDMODEINFO callback function (d3dkmddi.h)
The pfnAcquirePinnedModeInfo function returns a descriptor of the pinned mode in a specified VidPN source mode set.
Syntax
DXGKDDI_VIDPNSOURCEMODESET_ACQUIREPINNEDMODEINFO DxgkddiVidpnsourcemodesetAcquirepinnedmodeinfo;
NTSTATUS DxgkddiVidpnsourcemodesetAcquirepinnedmodeinfo(
[in] IN_CONST_D3DKMDT_HVIDPNSOURCEMODESET hVidPnSourceModeSet,
[out] DEREF_OUT_CONST_PPD3DKMDT_VIDPN_SOURCE_MODE ppPinnedVidPnSourceModeInfo
)
{...}
Parameters
[in] hVidPnSourceModeSet
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.
[out] ppPinnedVidPnSourceModeInfo
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 code | Description |
|---|---|
| STATUS_SUCCESS | The function succeeded by doing one of the following: 1. Setting ppPinnedVidPnSourceModeInfo to the address of D3DKMDT_VIDPN_SOURCE_MODE structure that describes the pinned mode. 2. 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
| Requirement | Value |
|---|---|
| Minimum supported client | Windows Vista |
| Target Platform | Desktop |
| Header | d3dkmddi.h (include D3dkmddi.h) |
| IRQL | PASSIVE_LEVEL |