Skip to content

Latest commit

 

History

History
115 lines (81 loc) · 5.12 KB

nc-d3dkmddi-dxgkddi_vidpn_createnewtargetmodeset.md

File metadata and controls

115 lines (81 loc) · 5.12 KB
Raw
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_CREATENEWTARGETMODESET
DXGKDDI_VIDPN_CREATENEWTARGETMODESET (d3dkmddi.h)
The pfnCreateNewTargetModeSet function creates a new target mode set object within a specified VidPN object.
display\dxgk_vidpn_interface_pfncreatenewtargetmodeset.htm
05/10/2018
DXGKDDI_VIDPN_CREATENEWTARGETMODESET callback function
DXGKDDI_VIDPN_CREATENEWTARGETMODESET, DXGKDDI_VIDPN_CREATENEWTARGETMODESET callback, VidPnFunctions_5bdc542e-e774-434b-a634-84ca5ed07d8d.xml, d3dkmddi/pfnCreateNewTargetModeSet, display.dxgk_vidpn_interface_pfncreatenewtargetmodeset, pfnCreateNewTargetModeSet, pfnCreateNewTargetModeSet callback function [Display Devices]
d3dkmddi.h
D3dkmddi.h
Desktop
Windows Vista
PASSIVE_LEVEL
Windows
display
DXGKDDI_VIDPN_CREATENEWTARGETMODESET
d3dkmddi/DXGKDDI_VIDPN_CREATENEWTARGETMODESET
APIRef
kbSyntax
UserDefined
d3dkmddi.h
DXGKDDI_VIDPN_CREATENEWTARGETMODESET

DXGKDDI_VIDPN_CREATENEWTARGETMODESET callback function

-description

The pfnCreateNewTargetModeSet function creates a new target mode set object within 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 phNewVidPnTargetModeSet [out]

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

-param ppVidPnTargetModeSetInterace [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 pfnCreateNewTargetModeSet 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_NO_MEMORY The VidPN manager was unable to allocate the memory required to create the new target mode set object.

-remarks

To assign a new target mode set to a particular target in a VidPN implementation, perform the following steps:

  1. Call pfnCreateNewTargetModeSet to get a handle to a new target mode set object. That target mode set object belongs to a particular VidPN object that you specify.
  2. Use the functions of the DXGK_VIDPNTARGETMODESET_INTERFACE structure to add modes to the target mode set object.
  3. Call pfnAssignTargetModeSet to assign the new target mode set to a particular target.
If you obtain a handle by calling pfnCreateNewTargetModeSet and then pass that handle to pfnAssignTargetModeSet, you do not need to release the handle by calling pfnReleaseTargetModeSet.

If you obtain a handle by calling pfnCreateNewTargetModeSet and then you decide not to assign the new target mode set to a target, you must release the newly obtained handle by calling pfnReleaseTargetModeSet.

The lifetime of the DXGK_VIDPNTARGETEMODESET_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 D3DKMDT_HVIDPN and D3DKMDT_HVIDPNTARGETMODESET data types are defined in D3dkmdt.h.

-see-also

VidPN Target Mode Set Interface

pfnAssignTargetModeSet

pfnReleaseTargetModeSet