SwapChain.GetBackBuffer(Int32,BackBufferType) Method (Microsoft.DirectX.Direct3D)

  • Article

Retrieves a back buffer from the swap chain of a device.

Definition

Visual Basic Public Function GetBackBuffer( _
    ByVal backBuffer As Integer, _
    ByVal typeBuffer As BackBufferType _
) As Surface
C# public Surface GetBackBuffer(
    int backBuffer,
    BackBufferType typeBuffer
);
C++ public:
Surface^ GetBackBuffer(
    int backBuffer,
    BackBufferType typeBuffer
);
JScript public function GetBackBuffer(
    backBuffer : int,
    typeBuffer : BackBufferType
) : Surface;

Parameters

backBuffer System.Int32
Index of the back buffer object to return. See Remarks.
typeBuffer Microsoft.DirectX.Direct3D.BackBufferType
Because stereo view is not supported in Microsoft DirectX 9.0, the only valid value for this parameter is Mono.

Return Value

Microsoft.DirectX.Direct3D.Surface
A Surface object that represents the returned back buffer surface.

Remarks

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.

Exceptions

InvalidCallException

The method call is invalid. For example, a method's parameter might contain an invalid value.