IDirect3DDevice9::GetBackBuffer

Retrieves a back buffer from the device's swap chain.

HRESULT GetBackBuffer(
  UINT  iSwapChain,
  UINT BackBuffer,
  D3DBACKBUFFER_TYPE Type,
  IDirect3DSurface9 ** ppBackBuffer
);

Parameters

iSwapChain

[in] An unsigned integer specifying the swap chain.

BackBuffer

[in] Index of the back buffer object to return. Back buffers are numbered from 0 to the total number of back buffers minus one. A value of 0 returns the first back buffer, not the front buffer. The front buffer is not accessible through this method. Use IDirect3DDevice9::GetFrontBufferData to retrieve a copy of the front buffer.

Type

[in] Stereo view is not supported in Direct3D 9, so the only valid value for this parameter is D3DBACKBUFFER_TYPE_MONO.

ppBackBuffer

[out, retval] Address of a pointer to an IDirect3DSurface9 interface, representing the returned back buffer surface.

Return Values

If the method succeeds, the return value is D3D_OK. If BackBuffer equals or exceeds the total number of back buffers, then 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.

Requirements

Header: Declared in D3d9.h.

See Also

IDirect3DDevice9::GetFrontBufferData