SwapChain.GetBackBuffer Method

Article
07/18/2007

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 Surface GetBackBuffer (
    int backBuffer, 
    BackBufferType backBufferType
)

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

Parameters

backBuffer
Index of the back buffer object to return.

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

Return Value

A Surface that represents the returned back buffer surface.

Exceptions

Exception type	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 .

Platforms

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

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

Version Information

.NET Compact Framework

Supported in: 2.0