IDirect3DMobileSwapChain::GetBackBuffer

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This method retrieves a back buffer from the swap chain of the device.

Syntax

HRESULT GetBackBuffer(
  UINT BackBuffer,
  D3DMBACKBUFFER_TYPE Type,
  IDirect3DMobileSurface** ppBackBuffer
);

Parameters

• BackBuffer
  [in] Index of the back buffer object to return. Back buffers are numbered from 0 to the total number of back buffers - 1. A value of 0 returns the first back buffer, not the front buffer. The front buffer is not accessible through this method.

• Type
  [in] The only valid value for this parameter is D3DMBACKBUFFER_TYPE_MONO (see D3DMBACKBUFFER_TYPE).

• ppBackBuffer
  [out] Address of a pointer to an IDirect3DMobileSurface interface that represents the returned back buffer surface.

Return Value

If the method succeeds, the return value is D3DM_OK (see D3DM Values).

If the method fails, the return value can be D3DMERR_INVALIDCALL (see D3DMERR Values).

Remarks

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

Requirements

See Also

Reference

IDirect3DMobileSwapChain
D3DMBACKBUFFER_TYPE
IDirect3DMobileSurface