Edit

Share via

IDXGIOutput4::CheckOverlayColorSpaceSupport method (dxgi1_4.h)

  • Article

Checks for overlay color space support.

Syntax

HRESULT CheckOverlayColorSpaceSupport(
  [in]  DXGI_FORMAT           Format,
  [in]  DXGI_COLOR_SPACE_TYPE ColorSpace,
  [in]  IUnknown              *pConcernedDevice,
  [out] UINT                  *pFlags
);

Parameters

[in] Format

Type: DXGI_FORMAT

A DXGI_FORMAT-typed value for the color format.

[in] ColorSpace

Type: DXGI_COLOR_SPACE_TYPE

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

[in] pConcernedDevice

Type: IUnknown*

A pointer to the Direct3D device interface. CheckOverlayColorSpaceSupport returns only support info about this scan-out device.

[out] pFlags

Type: UINT*

A pointer to a variable that receives a combination of DXGI_OVERLAY_COLOR_SPACE_SUPPORT_FLAG-typed values that are combined by using a bitwise OR operation. The resulting value specifies options for overlay 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

IDXGIOutput4