Edit

IDXGISwapChain1::GetFullscreenDesc method (dxgi1_2.h)

  • Article

Gets a description of a full-screen swap chain.

Syntax

HRESULT GetFullscreenDesc(
  [out] DXGI_SWAP_CHAIN_FULLSCREEN_DESC *pDesc
);

Parameters

[out] pDesc

A pointer to a DXGI_SWAP_CHAIN_FULLSCREEN_DESC structure that describes the full-screen swap chain.

Return value

GetFullscreenDesc returns:

  • S_OK if it successfully retrieved the description of the full-screen swap chain.
  • DXGI_ERROR_INVALID_CALL for non-HWND swap chains or if pDesc is NULL.
  • Possibly other error codes that are described in the DXGI_ERROR topic.

Remarks

The semantics of GetFullscreenDesc are identical to that of the IDXGISwapchain::GetDesc method for HWND-based swap chains.

Requirements

Requirement Value
Minimum supported client Windows 8 and Platform Update for Windows 7 [desktop apps only]
Minimum supported server Windows Server 2012 and Platform Update for Windows Server 2008 R2 [desktop apps only]
Target Platform Windows
Header dxgi1_2.h
Library Dxgi.lib

See also

IDXGISwapChain1