Edit

IDXGISwapChain::GetFullscreenState method (dxgi.h)

  • Article

Get the state associated with full-screen mode.

Syntax

HRESULT GetFullscreenState(
  [out, optional] BOOL        *pFullscreen,
  [out, optional] IDXGIOutput **ppTarget
);

Parameters

[out, optional] pFullscreen

Type: BOOL*

A pointer to a boolean whose value is either:

  • TRUE if the swap chain is in full-screen mode
  • FALSE if the swap chain is in windowed mode

[out, optional] ppTarget

Type: IDXGIOutput**

A pointer to the output target (see IDXGIOutput) when the mode is full screen; otherwise NULL.

Return value

Type: HRESULT

Returns one of the following DXGI_ERROR.

Remarks

When the swap chain is in full-screen mode, a pointer to the target output will be returned and its reference count will be incremented.

Requirements

Requirement Value
Target Platform Windows
Header dxgi.h
Library DXGI.lib

See also

IDXGISwapChain