IDXGIOutput::SetDisplaySurface Method

Changes the display mode.

On Xbox One, this method is not implemented, and returns DXGI_ERROR_UNSUPPORTED.

Syntax

public:
HRESULT SetDisplaySurface(
         IDXGISurface *pScanoutSurface
)

Parameters

pScanoutSurface
Type: IDXGISurface *

[in] 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

Xbox note: This method can only be called when this output is owned by a device.

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

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

Requirements

Header: Declared in d3d11_x.h (dxgi.h on other Windows platforms).

Library: Use d3d11_x.lib (dxgi.lib on other Windows platforms).