DXGK_VIDPN_INTERFACE::pfnCreateNewSourceModeSet routine

The pfnCreateNewSourceModeSet function creates a new source mode set object within a specified VidPN object.

Syntax


DXGKDDI_VIDPN_CREATENEWSOURCEMODESET pfnCreateNewSourceModeSet;

NTSTATUS APIENTRY pfnCreateNewSourceModeSet(
  _In_   const D3DKMDT_HVIDPN hVidPn,
  _In_   const D3DDDI_VIDEO_PRESENT_SOURCE_ID VidPnSourceId,
  _Out_  D3DKMDT_HVIDPNSOURCEMODESET *phNewVidPnSourceModeSet,
  _Out_  const DXGK_VIDPNSOURCEMODESET_INTERFACE **ppVidPnSourceModeSetInterface
)
{ ... }

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.

VidPnSourceId [in]

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

phNewVidPnSourceModeSet [out]

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

ppVidPnSourceModeSetInterface [out]

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

Return value

The pfnCreateNewSourceModeSet 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_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.

Requirements

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 Source Mode Set Interface
pfnAssignSourceModeSet
pfnReleaseSourceModeSet

 

 

Send comments about this topic to Microsoft

Show:
© 2014 Microsoft