Skip to content

Latest commit

 

History

History
115 lines (81 loc) · 5.1 KB

nc-d3dkmddi-dxgkddi_vidpn_createnewsourcemodeset.md

File metadata and controls

115 lines (81 loc) · 5.1 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_CREATENEWSOURCEMODESET
DXGKDDI_VIDPN_CREATENEWSOURCEMODESET (d3dkmddi.h)
The pfnCreateNewSourceModeSet function creates a new source mode set object within a specified VidPN object.
display\dxgk_vidpn_interface_pfncreatenewsourcemodeset.htm
05/10/2018
DXGKDDI_VIDPN_CREATENEWSOURCEMODESET callback function
DXGKDDI_VIDPN_CREATENEWSOURCEMODESET, DXGKDDI_VIDPN_CREATENEWSOURCEMODESET callback, VidPnFunctions_13c4227c-f1d3-4191-a085-5ed298fe11e7.xml, d3dkmddi/pfnCreateNewSourceModeSet, display.dxgk_vidpn_interface_pfncreatenewsourcemodeset, pfnCreateNewSourceModeSet, pfnCreateNewSourceModeSet callback function [Display Devices]
d3dkmddi.h
D3dkmddi.h
Desktop
Windows Vista
PASSIVE_LEVEL
Windows
display
DXGKDDI_VIDPN_CREATENEWSOURCEMODESET
d3dkmddi/DXGKDDI_VIDPN_CREATENEWSOURCEMODESET
APIRef
kbSyntax
UserDefined
d3dkmddi.h
DXGKDDI_VIDPN_CREATENEWSOURCEMODESET

DXGKDDI_VIDPN_CREATENEWSOURCEMODESET callback function

-description

The pfnCreateNewSourceModeSet function creates a new source 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 VidPnSourceId [in]

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

-param phNewVidPnSourceModeSet [out]

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

-param ppVidPnSourceModeSetInterface [out]

A pointer to a variable that receives a pointer to a DXGK_VIDPNSOURCEMODESET_INTERFACE structure. The structure contains pointers to functions that the display miniport driver can call to inspect and alter the source mode set object.

-returns

The pfnCreateNewSourceModeSet 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 source mode set object.

-remarks

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

  1. Call pfnCreateNewSourceModeSet to get a handle to a new source mode set object. That source mode set object belongs to a particular VidPN object that you specify.
  2. Use the functions of the DXGK_VIDPNSOURCEMODESET_INTERFACE interface to add modes to the source mode set object.
  3. Call pfnAssignSourceModeSet to assign the new source mode set to a particular source.
If you obtain a handle by calling pfnCreateNewSourceModeSet and then pass that handle to pfnAssignSourceModeSet, you do not need to release the handle by calling pfnReleaseSourceModeSet.

If you obtain a handle by calling pfnCreateNewSourceModeSet and then you decide not to assign the new source mode set to a source, you must release the newly obtained handle by calling pfnReleaseSourceModeSet.

The lifetime of the DXGK_VIDPNSOURCEMODESET_INTERFACE structure returned in ppVidPnSourceModeSetInterface 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_HVIDPNSOURCEMODESET data types are defined in D3dkmdt.h.

-see-also

VidPN Source Mode Set Interface

pfnAssignSourceModeSet

pfnReleaseSourceModeSet