IddCxSetRealtimeGPUPriority function (iddcx.h)

An indirect display driver (IDD) calls IddCxSetRealtimeGPUPriority to raise the GPU priority of a DirectX device to realtime.

Syntax

HRESULT IddCxSetRealtimeGPUPriority(
  [in] IDDCX_SWAPCHAIN                       SwapChainObject,
  [in] const IDARG_IN_SETREALTIMEGPUPRIORITY *pIn
);

Parameters

[in] SwapChainObject

An IDDCX_SWAPCHAIN object that represents the swapchain the provided DXGI device will process.

[in] pIn

Pointer to a IDARG_IN_SETREALTIMEGPUPRIORITY structure with additional input arguments about the DXGI device.

Return value

IddCxSetRealtimeGPUPriority returns STATUS_SUCCESS (S_OK) if the call succeeds. Otherwise, it returns an appropriate NTSTATUS error code such as the following.

Error code Meaning
E_INVALIDARG An invalid swapchain object was provided.
E_NOTIMPL The GPU priority boost is not supported. See Remarks.

Remarks

An IDD can call this function to ensure GPU work for processing a frame is completed in a timely manner.

On success the GPU priority for the provided DXGI device will be raised to realtime. This means any GPU work scheduled by this device will have higher priority than any regular application can set. The OS picks the exact realtime priority level to set; the chosen level in the realtime priority band might change in future OS releases.

Setting realtime priority is not supported on WDDM 1.x devices; IddCxSetRealtimeGPUPriority will return E_NOTIMPL for such devices.

Requirements

Requirement Value
Minimum supported client Windows 11, version 22H2
Header iddcx.h

See also

IDARG_IN_SETREALTIMEGPUPRIORITY