Skip to content

Latest commit

 

History

History
108 lines (72 loc) · 4.91 KB

nc-d3dkmddi-dxgkddi_vidpntopology_acquirepathinfo.md

File metadata and controls

108 lines (72 loc) · 4.91 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_VIDPNTOPOLOGY_ACQUIREPATHINFO
DXGKDDI_VIDPNTOPOLOGY_ACQUIREPATHINFO (d3dkmddi.h)
The pfnAcquirePathInfo function returns a descriptor of the video present path specified by a video present source and a video present target within a particular VidPN topology.
display\dxgk_vidpntopology_interface_pfnacquirepathinfo.htm
05/10/2018
DXGKDDI_VIDPNTOPOLOGY_ACQUIREPATHINFO callback function
DXGKDDI_VIDPNTOPOLOGY_ACQUIREPATHINFO, DXGKDDI_VIDPNTOPOLOGY_ACQUIREPATHINFO callback, VidPnFunctions_fb690a8a-fc98-4f8f-bfe5-14168a5fdb6a.xml, d3dkmddi/pfnAcquirePathInfo, display.dxgk_vidpntopology_interface_pfnacquirepathinfo, pfnAcquirePathInfo, pfnAcquirePathInfo callback function [Display Devices]
d3dkmddi.h
D3dkmddi.h
Desktop
Windows Vista
PASSIVE_LEVEL
Windows
display
DXGKDDI_VIDPNTOPOLOGY_ACQUIREPATHINFO
d3dkmddi/DXGKDDI_VIDPNTOPOLOGY_ACQUIREPATHINFO
APIRef
kbSyntax
UserDefined
d3dkmddi.h
DXGKDDI_VIDPNTOPOLOGY_ACQUIREPATHINFO

DXGKDDI_VIDPNTOPOLOGY_ACQUIREPATHINFO callback function

-description

The pfnAcquirePathInfo function returns a descriptor of the video present path specified by a video present source and a video present target within a particular VidPN topology.

-parameters

-param hVidPnTopology [in]

A handle to a VidPN topology object. The display miniport driver previously obtained this handle by calling the pfnGetTopology function of the DXGK_VIDPN_INTERFACE interface.

-param VidPnSourceId [in]

An integer that identifies a video present source.

-param VidPnTargetId [in]

An integer that identifies a video present target.

-param ppVidPnPresentPathInfo [out]

A pointer to a variable that receives a pointer to a D3DKMDT_VIDPN_PRESENT_PATH structure that describes the requested path.

-returns

The pfnAcquirePathInfo function returns one of the following values:

Return code Description
STATUS_SUCCESS The function succeeded.
STATUS_GRAPHICS_INVALID_VIDPN_TOPOLOGY The handle supplied in hVidPnTopology was invalid.

-remarks

When you have finished using the D3DKMDT_VIDPN_PRESENT_PATH structure, you must release the structure by calling pfnReleasePathInfo.

A path contains a (source, target) pair, and a topology is a collection of paths. This function returns a descriptor for the path, in a specified topology, that contains a specified (source, target) pair.

You can enumerate all the paths that belong to a VidPN topology object by calling pfnAcquireFirstPathInfo and then making a sequence of calls to pfnAcquireNextPathInfo.

VidPN source identifiers are assigned by the operating system. DxgkDdiStartDevice, implemented by the display miniport driver, returns the number N of video present sources supported by the display adapter. Then the operating system assigns identifiers 0, 1, 2, ... N - 1.

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.

The D3DKMDT_HVIDPNTOPOLOGY data type is defined in D3dkmdt.h.

The D3DDDI_VIDEO_PRESENT_SOURCE_ID and D3DDDI_VIDEO_PRESENT_TARGET_ID data types are defined in D3dukmdt.h.

-see-also

D3DKMDT_VIDPN_PRESENT_PATH

pfnAcquireFirstPathInfo

pfnAcquireNextPathInfo

pfnReleasePathInfo