com.badlogic.gdx.graphics.glutils

Interface IndexData

All Superinterfaces:

Disposable

All Known Implementing Classes:

IndexArray, IndexBufferObject, IndexBufferObjectSubData

public interface IndexData
extends Disposable

An IndexData instance holds index data. Can be either a plain short buffer or an OpenGL buffer object.

Author:

mzechner

Method Summary

Methods

Modifier and Type	Method and Description
void	bind() Binds this IndexBufferObject for rendering with glDrawElements.
void	dispose() Disposes this IndexDatat and all its associated OpenGL resources.
ShortBuffer	getBuffer() Returns the underlying ShortBuffer.
int	getNumIndices()
int	getNumMaxIndices()
void	invalidate() Invalidates the IndexBufferObject so a new OpenGL buffer handle is created.
void	setIndices(short[] indices, int offset, int count) Sets the indices of this IndexBufferObject, discarding the old indices.
void	setIndices(ShortBuffer indices) Copies the specified indices to the indices of this IndexBufferObject, discarding the old indices.
void	unbind() Unbinds this IndexBufferObject.

Method Detail

getNumIndices

int getNumIndices()

Returns:

the number of indices currently stored in this buffer

getNumMaxIndices

int getNumMaxIndices()

Returns:

the maximum number of indices this IndexBufferObject can store.

setIndices

void setIndices(short[] indices,
              int offset,
              int count)

Sets the indices of this IndexBufferObject, discarding the old indices. The count must equal the number of indices to be copied to this IndexBufferObject.

This can be called in between calls to bind() and unbind(). The index data will be updated instantly.

Parameters:

indices - the index data

offset - the offset to start copying the data from

count - the number of shorts to copy

setIndices

void setIndices(ShortBuffer indices)

Copies the specified indices to the indices of this IndexBufferObject, discarding the old indices. Copying start at the current Buffer.position() of the specified buffer and copied the Buffer.remaining() amount of indices. This can be called in between calls to bind() and unbind(). The index data will be updated instantly.

Parameters:

indices - the index data to copy

getBuffer

ShortBuffer getBuffer()

Returns the underlying ShortBuffer. If you modify the buffer contents they wil be uploaded on the call to bind(). If you need immediate uploading use setIndices(short[], int, int).

Returns:

the underlying short buffer.

bind

void bind()

Binds this IndexBufferObject for rendering with glDrawElements.

unbind

void unbind()

Unbinds this IndexBufferObject.

invalidate

void invalidate()

Invalidates the IndexBufferObject so a new OpenGL buffer handle is created. Use this in case of a context loss.

dispose

void dispose()

Disposes this IndexDatat and all its associated OpenGL resources.

Specified by:

dispose in interface Disposable