EVT_IDD_CX_ADAPTER_COMMIT_MODES2 callback function (iddcx.h)

Article
02/22/2024

The OS calls EVT_IDD_CX_ADAPTER_COMMIT_MODES2 to inform the driver of a mode change for monitors on the adapter.

Syntax

EVT_IDD_CX_ADAPTER_COMMIT_MODES2 EvtIddCxAdapterCommitModes2;

NTSTATUS EvtIddCxAdapterCommitModes2(
  IDDCX_ADAPTER AdapterObject,
  const IDARG_IN_COMMITMODES2 *pInArgs
)
{...}

Parameters

AdapterObject

[in] The OS-generated adapter object of the adapter being queried. This IDDCX_ADAPTER object handle was returned in a previous call to IddCxAdapterInitAsync.

pInArgs

[in] Pointer to a IDARG_IN_COMMITMODES2 structure that contains arguments used by EVT_IDD_CX_ADAPTER_COMMIT_MODES2.

Return value

EVT_IDD_CX_ADAPTER_COMMIT_MODES2 returns an NTSTATUS value. If the operation is successful, it returns STATUS_SUCCESS or another status value for which NT_SUCCESS(status) equals TRUE. Otherwise, it returns an appropriate NTSTATUS error code.

Remarks

When modes are committed for monitors, IddCx version 1.10 drivers that support HDR or WCG are called via this function and told the color space and bits per component to be used on the physical monitor connection. These values are based on the target capabilities and mode parameters previously reported by the driver. Reporting adapter support for FP16 but not exposing this function is an error.

The color space specified in a committed mode does not specify the surface format used for every surface in a swapchain. The surface provided in IDDCX_METADATA2 must still be queried.

The OS always provides the IDDCX_PATH2 for every connected monitor even if that monitor isn't active, and indicates which paths have changed. If a path is marked inactive, then the whole display pipeline for that path will be powered off and no signal will be sent to the monitor.

When a new path is committed, the driver should program the display pipeline to display a black image until the first frame is ready to be displayed. To achieve this, WDDM visibility should be off until the first frame is ready to be displayed, then the visibility should be turned on.

For more information about HDR support, see IddCx version 1.10 updates.

Requirements

Requirement	Value
Minimum supported client	Windows 11, version 22H2 September Update (IddCx Version 1.10)
Header	iddcx.h