DXGKDDI_VIDPNSOURCEMODESET_RELEASEMODEINFO callback function

The pfnReleaseModeInfo function releases a D3DKMDT_VIDPN_SOURCE_MODE structure that the VidPN manager previously provided to the display miniport driver.

Syntax


DXGKDDI_VIDPNSOURCEMODESET_RELEASEMODEINFO pfnReleaseModeInfo;

NTSTATUS APIENTRY pfnReleaseModeInfo(
  _In_ const D3DKMDT_HVIDPNSOURCEMODESET     hVidPnSourceModeSet,
  _In_ const D3DKMDT_VIDPN_SOURCE_MODE CONST *pVidPnSourceModeInfo
)
{ ... }

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.

pVidPnSourceModeInfo [in]

[in] A pointer to the D3DKMDT_VIDPN_SOURCE_MODE structure that is to be released.

Return value

The pfnReleaseModeInfo function returns one of the following values:

Return codeDescription
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 pointer supplied in pVidPnSourceModeInfo was invalid.

 

Remarks

When you have finished using a D3DKMDT_VIDPN_SOURCE_MODE structure that you obtained by calling any of the following functions, you must release the structure by calling pfnReleaseModeInfo.

If you obtain a D3DKMDT_VIDPN_SOURCE_MODE structure by calling pfnCreateNewModeInfo and then pass that structure to pfnAddMode, you do not need to release the structure.

If you obtain a handle by calling pfnCreateNewModeInfo and then you decide not to add the new mode to a source mode set, you must release the newly created structure by calling pfnReleaseModeInfo.

The D3DKMDT_HVIDPNSOURCEMODESET data type is defined in D3dkmdt.h.

Requirements

Target platform

Desktop

Version

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

Header

D3dkmddi.h (include D3dkmddi.h)

IRQL

PASSIVE_LEVEL

See also

pfnAcquireFirstModeInfo
pfnAcquireNextModeInfo
pfnAcquirePinnedModeInfo
D3DKMDT_VIDPN_SOURCE_MODE

 

 

Send comments about this topic to Microsoft

Show: