Microsoft.Xna.Framework.Graphics

Class VertexBufferBinding

java.lang.Object

System.ValueType

Microsoft.Xna.Framework.Graphics.VertexBufferBinding

public final class VertexBufferBinding
extends ValueType

Binding structure that specifies a vertex buffer and other per-vertex parameters (such as offset and instancing) for a graphics device.

Author:

Halofreak1990

Constructor Summary

Constructors

Constructor and Description
VertexBufferBinding(VertexBuffer vertexBuffer) Creates an instance of this object.
VertexBufferBinding(VertexBuffer vertexBuffer, int vertexOffset) Creates an instance of this object.
VertexBufferBinding(VertexBuffer vertexBuffer, int vertexOffset, int instanceFrequency) Creates an instance of this object.

Method Summary

Methods

Modifier and Type	Method and Description
int	getInstanceFrequency() Gets the instancing frequency.
VertexBuffer	getVertexBuffer() Gets the associated vertex buffer.
int	getVertexOffset() Gets the offset between the beginning of the buffer and the vertex data to use.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VertexBufferBinding

public VertexBufferBinding(VertexBuffer vertexBuffer)

Creates an instance of this object.

Parameters:

vertexBuffer - The vertex buffer.

VertexBufferBinding

public VertexBufferBinding(VertexBuffer vertexBuffer,
                   int vertexOffset)

Creates an instance of this object.

Parameters:

vertexBuffer - The vertex buffer.

vertexOffset - Offset (in vertices) from the beginning of the buffer to the first vertex to use.

VertexBufferBinding

public VertexBufferBinding(VertexBuffer vertexBuffer,
                   int vertexOffset,
                   int instanceFrequency)

Creates an instance of this object.

Parameters:

vertexBuffer - The vertex buffer.

vertexOffset - Offset (in vertices) from the beginning of the buffer to the first vertex to use.

instanceFrequency - Number (or frequency) of instances to draw for each draw call; 1 means draw one instance, 2 means draw 2 instances, etc. Use 0 if you are not instancing.

Method Detail

getInstanceFrequency

public int getInstanceFrequency()

Gets the instancing frequency.

Returns:

The instancing frequency.

getVertexBuffer

public VertexBuffer getVertexBuffer()

Gets the associated vertex buffer.

Returns:

The associated vertex buffer.

getVertexOffset

public int getVertexOffset()

Gets the offset between the beginning of the buffer and the vertex data to use.

Returns:

The offset between the beginning of the buffer and the vertex data to use.