EVT_IDD_CX_MONITOR_SET_DEFAULT_HDR_METADATA callback function (iddcx.h)

Article
10/24/2023

The OS calls EVT_IDD_CX_MONITOR_SET_DEFAULT_HDR_METADATA to provide the default HDR10 metadata that a console driver should send to the monitor when default metadata is specified in a call to IddCxSwapChainReleaseAndAcquireBuffer2.

Syntax

EVT_IDD_CX_MONITOR_SET_DEFAULT_HDR_METADATA EvtIddCxMonitorSetDefaultHdrMetadata;

NTSTATUS EvtIddCxMonitorSetDefaultHdrMetadata(
  IDDCX_MONITOR MonitorObject,
  const IDARG_IN_MONITOR_SET_DEFAULT_HDR_METADATA *pInArgs
)
{...}

Parameters

MonitorObject

[in] An IDDCX_MONITOR object that is the OS context handle for the monitor. The OS provided this handle in a prior call to IddCxMonitorCreate.

pInArgs

[in] Pointer to an IDARG_IN_MONITOR_SET_DEFAULT_HDR_METADATA structure that contains the input arguments for this callback function.

Return value

EVT_IDD_CX_MONITOR_SET_DEFAULT_HDR_METADATA 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

The OS only calls this callback function for console drivers. It calls the driver for any monitor that supports HDR to tell the driver what default HDR metadata to use if the driver sets the IDDCX_ADAPTER_FLAGS_CAN_PROCESS_FP16. flag. This call occurs after IddCxMonitorCreate is called and before any calls to EVT_IDD_CX_ADAPTER_COMMIT_MODES2. The driver should use this data whenever IDDCX_HDRMETADATA_TYPE_DEFAULT is specified as the metadata type in the IDDCX_METADATA2 returned when calling IddCxSwapChainReleaseAndAcquireBuffer2. The OS can call the driver to update this default at any time.

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