IDirect3DSwapChain9::GetFrontBufferData Method

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

Syntax

HRESULT GetFrontBufferData(      

    IDirect3DSurface9 *pDestSurface
);

Parameters

pDestSurface

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

For windowed mode, the size of the destination surface should be the size of the desktop. For full screen mode, the size of the destination surface should be the screen size.

Return Value

If the method succeeds, the return value is D3D_OK.

If BackBuffer exceeds or equals the total number of back buffers, the function fails and returns D3DERR_INVALIDCALL.

Remarks

Calling this method will increase the internal reference count on the IDirect3DSurface9 interface. Failure to call IUnknown::Release when finished using this IDirect3DSurface9 interface results in a memory leak.