Skip to content

Latest commit

 

History

History
105 lines (71 loc) · 4.95 KB

nc-d3dkmddi-dxgkddi_vidpn_acquiretargetmodeset.md

File metadata and controls

105 lines (71 loc) · 4.95 KB
UID title description old-location ms.date keywords ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos tech.root req.typenames f1_keywords topic_type api_type api_location api_name
NC:d3dkmddi.DXGKDDI_VIDPN_ACQUIRETARGETMODESET
DXGKDDI_VIDPN_ACQUIRETARGETMODESET (d3dkmddi.h)
The pfnAcquireTargetModeSet function returns a handle to a particular target mode set object that is contained by a specified VidPN object.
display\dxgk_vidpn_interface_pfnacquiretargetmodeset.htm
05/10/2018
DXGKDDI_VIDPN_ACQUIRETARGETMODESET callback function
DXGKDDI_VIDPN_ACQUIRETARGETMODESET, DXGKDDI_VIDPN_ACQUIRETARGETMODESET callback, VidPnFunctions_e7b058c8-0f02-4456-8938-9182a35826f9.xml, d3dkmddi/pfnAcquireTargetModeSet, display.dxgk_vidpn_interface_pfnacquiretargetmodeset, pfnAcquireTargetModeSet, pfnAcquireTargetModeSet callback function [Display Devices]
d3dkmddi.h
D3dkmddi.h
Desktop
Windows Vista
PASSIVE_LEVEL
Windows
display
DXGKDDI_VIDPN_ACQUIRETARGETMODESET
d3dkmddi/DXGKDDI_VIDPN_ACQUIRETARGETMODESET
APIRef
kbSyntax
UserDefined
d3dkmddi.h
DXGKDDI_VIDPN_ACQUIRETARGETMODESET

DXGKDDI_VIDPN_ACQUIRETARGETMODESET callback function

-description

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

-parameters

-param hVidPn [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.

-param VidPnTargetId [in]

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

-param phVidPnTargetModeSet [out]

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

-param ppVidPnTargetModeSetInterface [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.

-returns

The pfnAcquireTargetModeSet function returns one of the following values:

Return code Description
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.

-see-also

VidPN Target Mode Set Interface

pfnAssignTargetModeSet

pfnCreateNewTargetModeSet

pfnReleaseTargetModeSet