IDXGISwapChain3::CheckColorSpaceSupport method (dxgi1_4.h)

Checks whether the swap chain currently supports the specified color space, based on the current adapter output (for example, what monitor the swap chain window is being displayed on).

Note

The swap chain might still be able to set and display color spaces that are not returned as supported. For example the DXGI_COLOR_SPACE_RGB_FULL_G2084_NONE_P2020 and DXGI_COLOR_SPACE_RGB_FULL_G10_NONE_P709 color spaces will be displayed even if DXGI_COLOR_SPACE_RGB_FULL_G22_NONE_P709 is in use, although out-of-gamut colors will be clipped.

While a color space has been successfully set to the swap chain (whether or not it was returned as supported before), it will be returned as supported when queried with this function.

Syntax

HRESULT CheckColorSpaceSupport(
  [in]  DXGI_COLOR_SPACE_TYPE ColorSpace,
  [out] UINT                  *pColorSpaceSupport
);

Parameters

[in] ColorSpace

Type: DXGI_COLOR_SPACE_TYPE

A DXGI_COLOR_SPACE_TYPE-typed value that specifies color space type to check support for.

[out] pColorSpaceSupport

Type: UINT*

A pointer to a variable that receives a combination of DXGI_SWAP_CHAIN_COLOR_SPACE_SUPPORT_FLAG-typed values that are combined by using a bitwise OR operation. The resulting value specifies options for color space support.

Return value

Type: HRESULT

This method returns S_OK on success, or it returns one of the error codes that are described in the DXGI_ERROR topic.

Requirements

Requirement Value
Minimum supported client Windows 10 [desktop apps only]
Minimum supported server Windows Server 2016 [desktop apps only]
Target Platform Windows
Header dxgi1_4.h
Library Dxgi.lib

See also

IDXGISwapChain3