DXGKDDI_VIDPNTARGETMODESET_PINMODE callback function (d3dkmddi.h)

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

Syntax

DXGKDDI_VIDPNTARGETMODESET_PINMODE DxgkddiVidpntargetmodesetPinmode;

NTSTATUS DxgkddiVidpntargetmodesetPinmode(
  IN_D3DKMDT_HVIDPNTARGETMODESET hVidPnTargetModeSet,
  IN_CONST_D3DKMDT_VIDEO_PRESENT_TARGET_MODE_ID VidPnTargetModeId
)
{...}

Parameters

hVidPnTargetModeSet

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

VidPnTargetModeId

[in] 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_TARGETMODESET The handle supplied in hVidPnTargetModeSet was invalid.
STATUS_GRAPHICS_INVALID_VIDEO_PRESENT_TARGET_MODE The mode identified by VidPnTargetModeId does not belong to the source mode set represented by hVidPnTargetModeSet.

Remarks

VidPN target 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_TARGET_MODE structure, and returns the structure to the display miniport driver.

The D3DKMDT_HVIDPNTARGETMODESET data type is defined in D3dkmdt.h.

Requirements

   
Minimum supported client Available in Windows Vista and later versions of the Windows operating systems.
Target Platform Desktop
Header d3dkmddi.h (include D3dkmddi.h)
IRQL PASSIVE_LEVEL