IDirect3DDevice8::GetFrontBuffer

Generates a copy of the device's front buffer and places that copy in a system memory buffer provided by the application.

HRESULT GetFrontBuffer(
  IDirect3DSurface8* pDestSurface
);

Parameters

pDestSurface

[in] Pointer to an IDirect3DSurface8 interface that will receive a copy of the contents of the front buffer. The data is returned in successive rows with no intervening space, starting from the vertically highest row on the device's output to the lowest.

Return Values

If the method succeeds, the return value is D3D_OK.

If the method fails, the return value can be one of the following values.

Remarks

The buffer pointed to by pDestSurface will be filled with a representation of the front buffer, converted to the standard 32bpp format, D3DFMT_A8R8G8B8.

This method is the only way to capture an anti-aliased screen shot.

For more information, see Lost Devices.

Requirements

  Header: Declared in D3d8.h.
  Import Library: Use D3d8.lib.