DXGKDDI_VIDPNSOURCEMODESET_PINMODE callback function (d3dkmddi.h)

Article
02/22/2024

The pfnPinMode function pins a specified mode in a VidPN source mode set.

Syntax

DXGKDDI_VIDPNSOURCEMODESET_PINMODE DxgkddiVidpnsourcemodesetPinmode;

NTSTATUS DxgkddiVidpnsourcemodesetPinmode(
  [in] IN_D3DKMDT_HVIDPNSOURCEMODESET hVidPnSourceModeSet,
  [in] IN_CONST_D3DKMDT_VIDEO_PRESENT_SOURCE_MODE_ID VidPnSourceModeId
)
{...}

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.

[in] VidPnSourceModeId

An integer that identifies the mode to be pinned.

Return value

The pfnPinMode 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.
STATUS_GRAPHICS_INVALID_VIDEO_PRESENT_SOURCE_MODE	The mode identified by VidPnSourceModeId does not belong to the source mode set represented by hVidPnSourceModeSet.

Remarks

VidPN source mode identifiers are assigned by the operating system. The pfnCreateNewModeInfo function generates a mode identifier, assigns the identifier to the Id member of a D3DKMDT_VIDPN_SOURCE_MODE structure, and returns the structure to the display miniport driver.

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