Skip to content

Latest commit

 

History

History
96 lines (67 loc) · 4.46 KB

nc-d3dkmddi-dxgkddi_vidpnsourcemodeset_addmode.md

File metadata and controls

96 lines (67 loc) · 4.46 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_VIDPNSOURCEMODESET_ADDMODE
DXGKDDI_VIDPNSOURCEMODESET_ADDMODE (d3dkmddi.h)
The pfnAddMode function adds a VidPN source mode to a specified VidPN source mode set object.
display\dxgk_vidpnsourcemodeset_interface_pfnaddmode.htm
05/10/2018
DXGKDDI_VIDPNSOURCEMODESET_ADDMODE callback function
DXGKDDI_VIDPNSOURCEMODESET_ADDMODE, DXGKDDI_VIDPNSOURCEMODESET_ADDMODE callback, VidPnFunctions_4a5d2191-c7d3-4b94-80aa-b6b3c71dfe18.xml, d3dkmddi/pfnAddMode, display.dxgk_vidpnsourcemodeset_interface_pfnaddmode, pfnAddMode, pfnAddMode callback function [Display Devices]
d3dkmddi.h
D3dkmddi.h
Desktop
Windows Vista
PASSIVE_LEVEL
Windows
display
DXGKDDI_VIDPNSOURCEMODESET_ADDMODE
d3dkmddi/DXGKDDI_VIDPNSOURCEMODESET_ADDMODE
APIRef
kbSyntax
UserDefined
d3dkmddi.h
DXGKDDI_VIDPNSOURCEMODESET_ADDMODE

DXGKDDI_VIDPNSOURCEMODESET_ADDMODE callback function

-description

The pfnAddMode function adds a VidPN source mode to a specified VidPN source mode set object.

-parameters

-param hVidPnSourceModeSet [in]

A handle to a VidPN source mode set object. The display miniport driver previously obtained this handle by calling the pfnAcquireSourceModeSet function of the DXGK_VIDPN_INTERFACE interface.

-param pVidPnSourceModeInfo [in]

A pointer to a D3DKMDT_VIDPN_SOURCE_MODE structure that describes the source mode. The display miniport driver previously obtained this structure by calling pfnCreateNewModeInfo.

-returns

The pfnAddMode function returns one of the following values:

Return code Description
STATUS_SUCCESS The function succeeded.
STATUS_GRAPHICS_INVALID_VIDPN_SOURCEMODESET The handle supplied in hVidPnSourceModeSet was invalid.

-remarks

To add a mode to a source mode set, the display miniport driver performs the following steps.

Call pfnCreateNewModeInfo to obtain a pointer to a D3DKMDT_VIDPN_SOURCE_MODE structure. The pnfCreateNewModeInfo function allocates the structure, fills in the Id member with a newly generated source mode identifier, and sets the Type member to D3DKMDT_RMT_UNINITIALIZED.

Populate the D3DKMDT_VIDPN_SOURCE_MODE structure (except for the Id member) with information about the mode, including the mode's type and format.

Call pfnAddMode to add the mode to a source mode set.

The VidPN manager allocates a D3DKMDT_VIDPN_SOURCE_MODE structure when you call pfnCreateNewModeInfo. If you add the mode described by that structure to a source mode set, you do not need to explicitly release the structure; pfnAddMode releases it.

If you obtain a D3DKMDT_VIDPN_SOURCE_MODE structure by calling pfnCreateNewModeInfo and then decide not to add that mode to a source mode set, you must explicitly release the structure by calling pfnReleaseModeInfo.

The D3DKMDT_HVIDPNSOURCEMODESET data type is defined in D3dkmdt.h.

-see-also

D3DKMDT_VIDPN_SOURCE_MODE

pfnCreateNewModeInfo

pfnReleaseModeInfo