DXGKDDI_VIDPNTARGETMODESET_RELEASEMODEINFO callback function (d3dkmddi.h)

Article
05/26/2023

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

Syntax

DXGKDDI_VIDPNTARGETMODESET_RELEASEMODEINFO DxgkddiVidpntargetmodesetReleasemodeinfo;

NTSTATUS DxgkddiVidpntargetmodesetReleasemodeinfo(
  [in] IN_CONST_D3DKMDT_HVIDPNTARGETMODESET hVidPnTargetModeSet,
  [in] IN_CONST_PD3DKMDT_VIDPN_TARGET_MODE_CONST pVidPnTargetModeInfo
)
{...}

Parameters

[in] hVidPnTargetModeSet

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.

[in] pVidPnTargetModeInfo

A pointer to the D3DKMDT_VIDPN_TARGET_MODE structure that is to be released.

Return value

The pfnReleaseModeInfo 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 pointer supplied in pVidPnTargetModeInfo was invalid.

Remarks

When you have finished using a D3DKMDT_VIDPN_TARGET_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_TARGET_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 target mode set, you must release the newly created 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