SwapChain.GetBackBuffer Method

Article
10/19/2012

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

Namespace: Microsoft.WindowsMobile.DirectX.Direct3D
Assembly: Microsoft.WindowsMobile.DirectX (in Microsoft.WindowsMobile.DirectX.dll)

Syntax

'Declaration
Public Function GetBackBuffer ( _
    backBuffer As Integer, _
    backBufferType As BackBufferType _
) As Surface
'Usage
Dim instance As SwapChain 
Dim backBuffer As Integer 
Dim backBufferType As BackBufferType 
Dim returnValue As Surface 

returnValue = instance.GetBackBuffer(backBuffer, _
    backBufferType)

public Surface GetBackBuffer(
    int backBuffer,
    BackBufferType backBufferType
)

public:
Surface^ GetBackBuffer(
    int backBuffer, 
    BackBufferType backBufferType
)

public function GetBackBuffer(
    backBuffer : int, 
    backBufferType : BackBufferType
) : Surface

Parameters

backBuffer
Type: System.Int32

Index of the back buffer object to return.

backBufferType
Type: Microsoft.WindowsMobile.DirectX.Direct3D.BackBufferType

Because stereo view is not supported, the only valid value for this parameter is BackBufferType.Mono.

Return Value

Type: Microsoft.WindowsMobile.DirectX.Direct3D.Surface
A Surface that represents the returned back buffer surface.

Exceptions

Exception	Condition
InvalidCallException	The method call is invalid. For example, a method's parameter may contain an invalid value.

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.

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Platforms

Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Version Information

.NET Compact Framework

Supported in: 3.5, 2.0

Share via