Edit

Share via

IDXGIOutput3::CheckOverlaySupport method (dxgi1_3.h)

  • Article

Checks for overlay support.

Syntax

HRESULT CheckOverlaySupport(
  [in]  DXGI_FORMAT EnumFormat,
  [in]  IUnknown    *pConcernedDevice,
  [out] UINT        *pFlags
);

Parameters

[in] EnumFormat

Type: DXGI_FORMAT

A DXGI_FORMAT-typed value for the color format.

[in] pConcernedDevice

Type: IUnknown*

A pointer to the Direct3D device interface. CheckOverlaySupport 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_SUPPORT_FLAG-typed values that are combined by using a bitwise OR operation. The resulting value specifies options for overlay support.

Return value

Type: HRESULT

Returns one of the error codes described in the DXGI_ERROR topic.

Requirements

Requirement Value
Minimum supported client Windows 8.1 [desktop apps only]
Minimum supported server Windows Server 2012 R2 [desktop apps only]
Target Platform Windows
Header dxgi1_3.h
Library Dxgi.lib

See also

IDXGIOutput3