Edit

IDXGIOutput::SetDisplaySurface method (dxgi.h)

  • Article

Changes the display mode.

Syntax

HRESULT SetDisplaySurface(
  [in] IDXGISurface *pScanoutSurface
);

Parameters

[in] pScanoutSurface

Type: IDXGISurface*

A pointer to a surface (see IDXGISurface) used for rendering an image to the screen. The surface must have been created as a back buffer (DXGI_USAGE_BACKBUFFER).

Return value

Type: HRESULT

Returns one of the DXGI_ERROR values.

Remarks

IDXGIOutput::SetDisplaySurface should not be called directly by applications, since results will be unpredictable. It is called implicitly by the DXGI swap chain object during full-screen transitions, and should not be used as a substitute for swap-chain methods.

This method should only be called between IDXGIOutput::TakeOwnership and IDXGIOutput::ReleaseOwnership calls.

Notes for Windows Store apps

If a Windows Store app uses SetDisplaySurface, it fails with DXGI_ERROR_NOT_CURRENTLY_AVAILABLE.

Requirements

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

See also

IDXGIOutput