The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

IDXGISwapChain4::SetHDRMetaData method

This method sets High Dynamic Range (HDR) and Wide Color Gamut (WCG) header metadata.

Syntax

C++


HRESULT SetHDRMetaData(
  [in]           DXGI_HDR_METADATA_TYPE Type,
  [in]           UINT                   Size,
  [in, optional] void                   *pMetaData
);

Parameters

Type [in]

Type: DXGI_HDR_METADATA_TYPE

Specifies one member of the DXGI_HDR_METADATA_TYPE enum.

Size [in]

Type: UINT

Specifies the size of pMetaData, in bytes.

pMetaData [in, optional]

Type: void*

Specifies a void pointer that references the metadata, if it exists. Refer to the DXGI_HDR_METADATA_HDR10 structure.

Return value

Type: HRESULT

This method returns an HRESULT success or error code.

Remarks

This method sets metadata to enable a monitor's output to be adjusted depending on its capabilities.

Requirements

Header	Dxgi1_5.h
Library	Dxgi1_5.lib
DLL	Dxgi1_5.dll