DXGKDDI_UPDATEACTIVEVIDPNPRESENTPATH callback function (d3dkmddi.h)

Article
05/26/2023

The DxgkDdiUpdateActiveVidPnPresentPath function updates one of the video present paths that is currently active on the display adapter.

Syntax

DXGKDDI_UPDATEACTIVEVIDPNPRESENTPATH DxgkddiUpdateactivevidpnpresentpath;

NTSTATUS DxgkddiUpdateactivevidpnpresentpath(
       IN_CONST_HANDLE hAdapter,
  [in] IN_CONST_PDXGKARG_UPDATEACTIVEVIDPNPRESENTPATH_CONST pUpdateActiveVidPnPresentPath
)
{...}

Parameters

hAdapter

A handle to a context block that is associated with a display adapter. The display miniport driver previously provided this handle to the Microsoft DirectX graphics kernel subsystem in the MiniportDeviceContext output parameter of the DxgkDdiAddDevice function.

[in] pUpdateActiveVidPnPresentPath

A pointer to a DXGKARG_UPDATEACTIVEVIDPNPRESENTPATH structure, which contains one member: a D3DKMDT_VIDPN_PRESENT_PATH structure. The members of the D3DKMDT_VIDPN_PRESENT_PATH structure identify the path and supply new settings for the path. The DxgkDdiUpdateActiveVidPnPresentPath function must program the path on the display adapter according to the new settings.

Return value

DxgkDdiUpdateActiveVidPnPresentPathreturns one of the following values:

Value	Description
STATUS_SUCCESS	The function succeeded.
STATUS_GRAPHICS_PATH_NOT_IN_TOPOLOGY	The path specified by pUpdateActiveVidPnPresentPathArg->VidPnPresentPathInfo is not in the topology of the active VidPN.
STATUS_GRAPHICS_PATH_CONTENT_GEOMETRY_TRANSFORMATION_NOT_SUPPORTED	The path does not support the content transformation specified by pUpdateActiveVidPnPresentPathArg->VidPnPresentPathInfo.ContentTransformation. The path does not support the gamma ramp specified by pUpdateActiveVidPnPresentPathArg->VidPnPresentPathInfo.GammaRamp.

Remarks

The operating system calls the DxgkDdiUpdateActiveVidPnPresentPath function to control the settings of video present paths, such as path rotation, a presented content's geometry transformations, gamma ramps that are used to adjust the presented content's brightness, and so on.

Note The display miniport driver's DxgkDdiUpdateActiveVidPnPresentPath function must support gamma ramps.

Beginning with Windows 8, if the display miniport driver sets the SupportSmoothRotation member of the DXGK_DRIVERCAPS structure, it must support updating the path rotation on the adapter using the DxgkDdiUpdateActiveVidPnPresentPath function. The driver must always be able to set the path rotation during a call to the DxgkDdiCommitVidPn function.

The DxgkDdiUpdateActiveVidPnPresentPath function should be made pageable.

Requirements

Requirement	Value
Minimum supported client	Windows Vista
Target Platform	Desktop
Header	d3dkmddi.h
IRQL	PASSIVE_LEVEL