Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
GetBackBuffer
Collapse the table of content
Expand the table of content

IDirect3DDevice9::GetBackBuffer method

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

Syntax


HRESULT GetBackBuffer(
  [in]          UINT                iSwapChain,
  [in]          UINT               BackBuffer,
  [in]          D3DBACKBUFFER_TYPE Type,
  [out, retval] IDirect3DSurface9  **ppBackBuffer
);

Parameters

iSwapChain [in]

Type: UINT

An unsigned integer specifying the swap chain.

BackBuffer [in]

Type: UINT

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]

Type: D3DBACKBUFFER_TYPE

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

ppBackBuffer [out, retval]

Type: IDirect3DSurface9**

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

Return value

Type: HRESULT

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

D3D9.h

Library

D3D9.lib

See also

IDirect3DDevice9
IDirect3DDevice9::GetFrontBufferData

 

 

Community Additions

ADD
Show:
© 2015 Microsoft