Microsoft.Xna.Framework.Graphics

Class IndexBuffer

java.lang.Object

Microsoft.Xna.Framework.Graphics.GraphicsResource

Microsoft.Xna.Framework.Graphics.IndexBuffer

All Implemented Interfaces:

IDisposable

Direct Known Subclasses:

DynamicIndexBuffer

public class IndexBuffer
extends GraphicsResource

Describes the rendering order of the vertices in a vertex buffer.

Author:

Halofreak1990

Field Summary

Fields inherited from class Microsoft.Xna.Framework.Graphics.GraphicsResource

_parent, Disposing, Name, Tag

Constructor Summary

Constructors

Constructor and Description
IndexBuffer(GraphicsDevice graphicsDevice, java.lang.Class indexType, int indexCount, BufferUsage usage) Initializes a new instance of the IndexBuffer class.
IndexBuffer(GraphicsDevice graphicsDevice, IndexElementSize indexElementSize, int indexCount, BufferUsage usage) Initializes a new instance of the IndexBuffer class.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	Dispose(boolean disposing) Immediately releases the unmanaged resources used by this object.
BufferUsage	getBufferUsage() Gets the state of the related BufferUsage enumeration.
<T> void	GetData(int offsetInBytes, T[] data, int startIndex, int elementCount) Gets a copy of the index buffer data, specifying the start index, starting offset, number of elements, and size of the elements.
<T> void	GetData(T[] data) Gets a copy of the index buffer data.
<T> void	GetData(T[] data, int startIndex, int elementCount) Gets a copy of the index buffer data, specifying the start index and number of elements.
int	getIndexCount() Gets the number of indices in this buffer.
IndexElementSize	getIndexElementSize() Gets a value indicating the size of this index element.
<T> void	SetData(int offsetInBytes, T[] data, int startIndex, int elementCount) Sets index buffer data, specifying the offset, start index and number of elements.
<T> void	SetData(T[] data) Sets index buffer data.
<T> void	SetData(T[] data, int startIndex, int elementCount) Sets index buffer data, specifying the start index and number of elements.

Methods inherited from class Microsoft.Xna.Framework.Graphics.GraphicsResource

Dispose, finalize, getGraphicsDevice, IsDisposed, raise_disposing, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

IndexBuffer

public IndexBuffer(GraphicsDevice graphicsDevice,
           IndexElementSize indexElementSize,
           int indexCount,
           BufferUsage usage)

Initializes a new instance of the IndexBuffer class.

Parameters:

graphicsDevice - The GraphicsDevice object to associate with the index buffer.

indexElementSize - The size (in bits) of each index.

indexCount - The number of indices.

usage - Behavior options.

IndexBuffer

public IndexBuffer(GraphicsDevice graphicsDevice,
           java.lang.Class indexType,
           int indexCount,
           BufferUsage usage)

Initializes a new instance of the IndexBuffer class.

Parameters:

graphicsDevice - The GraphicsDevice object to associate with the index buffer.

indexType - The index value type.

indexCount - The number of indices.

usage - Behavior options.

Method Detail

getBufferUsage

public BufferUsage getBufferUsage()

Gets the state of the related BufferUsage enumeration.

getIndexCount

public int getIndexCount()

Gets the number of indices in this buffer.

getIndexElementSize

public IndexElementSize getIndexElementSize()

Gets a value indicating the size of this index element.

Dispose

protected void Dispose(boolean disposing)

Immediately releases the unmanaged resources used by this object.

Overrides:

Dispose in class GraphicsResource

Parameters:

disposing - true to release both managed and unmanaged resources; false to release only unmanaged resources.

GetData

public <T> void GetData(int offsetInBytes,
               T[] data,
               int startIndex,
               int elementCount)

Gets a copy of the index buffer data, specifying the start index, starting offset, number of elements, and size of the elements.

Parameters:

offsetInBytes - Offset in bytes from the beginning of the buffer to the data.

data - Array of data.

startIndex - Index of the first element to get.

elementCount - Number of elements to get.

GetData

public <T> void GetData(T[] data)

Gets a copy of the index buffer data.

Parameters:

data - Array of data.

GetData

public <T> void GetData(T[] data,
               int startIndex,
               int elementCount)

Gets a copy of the index buffer data, specifying the start index and number of elements.

Parameters:

data - Array of data.

startIndex - Index of the first element to get.

elementCount - Number of elements to get.

SetData

public <T> void SetData(int offsetInBytes,
               T[] data,
               int startIndex,
               int elementCount)

Sets index buffer data, specifying the offset, start index and number of elements.

Parameters:

offsetInBytes - Offset in bytes from the beginning of the buffer to the data.

data - Array of data.

startIndex - Index of the first element to set.

elementCount - Number of elements to set.

SetData

public <T> void SetData(T[] data)

Sets index buffer data.

Parameters:

data - Array of data.

SetData

public <T> void SetData(T[] data,
               int startIndex,
               int elementCount)

Sets index buffer data, specifying the start index and number of elements.

Parameters:

data - Array of data.

startIndex - Index of the first element to set.

elementCount - Number of elements to set.