IDXGISwapChain4::SetHDRMetaData method

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

Syntax

HRESULT SetHDRMetaData(
  DXGI_HDR_METADATA_TYPE Type,
  UINT                   Size,
  void                   *pMetaData
);

Parameters

Type

Type: DXGI_HDR_METADATA_TYPE

Specifies one member of the DXGI_HDR_METADATA_TYPE enum.

Size

Type: UINT

Specifies the size of pMetaData, in bytes.

pMetaData

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

   
Target Platform Windows
Header dxgi1_5.h
Library Dxgi1_5.lib
DLL Dxgi1_5.dll

See Also

DXGI 1.5 Improvements

IDXGISwapChain4