DXGKDDI_VIDPN_ACQUIRETARGETMODESET callback function

The pfnAcquireTargetModeSet function returns a handle to a particular target mode set object that is contained by a specified VidPN object.

Syntax


DXGKDDI_VIDPN_ACQUIRETARGETMODESET pfnAcquireTargetModeSet;

NTSTATUS APIENTRY pfnAcquireTargetModeSet(
  _In_  const D3DKMDT_HVIDPN                    hVidPN,
  _In_  const D3DDDI_VIDEO_PRESENT_TARGET_ID    VidPnTargetId,
  _Out_       D3DKMDT_HVIDPNTARGETMODESET       *phVidPnTargetModeSet,
  _Out_ const DXGK_VIDPNTARGETMODESET_INTERFACE **ppVidPnTargetModeSetInterface
)
{ ... }

Parameters

hVidPN [in]

[in] A handle to a VidPN object. The VidPN manager previously provided this handle to the display miniport driver by calling DxgkDdiEnumVidPnCofuncModality, DxgkDdiIsSupportedVidPn, or DxgkDdiRecommendFunctionalVidPn.

VidPnTargetId [in]

[in] An integer that identifies one of the video present targets associated with the VidPN object.

phVidPnTargetModeSet [out]

[out] A pointer to a variable that receives a handle to the requested target mode set object.

ppVidPnTargetModeSetInterface [out]

[out] A pointer to a variable that receives a pointer to a DXGK_VIDPNTARGETMODESET_INTERFACE structure. The structure contains pointers to functions that the display miniport driver can call to inspect and alter the target mode set object.

Return value

The pfnAcquireTargetModeSet function returns one of the following values:

Return codeDescription
STATUS_SUCCESS

The function succeeded.

STATUS_GRAPHICS_INVALID_VIDPN

The handle supplied in hVidPn was invalid.

STATUS_GRAPHICS_INVALID_VIDEO_PRESENT_TARGET

The identifier supplied in VidPnTargetId was invalid.

 

Remarks

VidPN target identifiers are assigned by the display miniport driver. DxgkDdiQueryChildRelations, implemented by the display miniport driver, returns an array of DXGK_CHILD_DESCRIPTOR structures, each of which contains an identifier.

When you have finished using the target mode set object handle, you must release the handle by calling pfnReleaseTargetModeSet. Target mode set objects are reference counted, so if you acquire a handle several times, you must release it that same number of times.

The lifetime of the DXGK_VIDPNTARGETMODESET_INTERFACE structure returned in ppVidPnTargetModeSetInterface is owned by the operating system. Using this ownership scheme, the operating system can switch to newer implementations at run time without breaking clients of the interface.

The D3DDDI_VIDEO_PRESENT_TARGET_ID data type is defined in D3dukmdt.h.

The D3DKMDT_HVIDPN and D3DKMDT_HVIDPNTARGETMODESET data types are 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

VidPN Target Mode Set Interface
pfnReleaseTargetModeSet
pfnCreateNewTargetModeSet
pfnAssignTargetModeSet

 

 

Send comments about this topic to Microsoft

Show: