APIdia Launch Partner
Top Description Fields Constructors Methods
com.badlogic.gdx.graphics.glutils

public Class VertexArray

extends Object
implements VertexData
Class Inheritance
All Implemented Interfaces
com.badlogic.gdx.graphics.glutils.VertexData, com.badlogic.gdx.utils.Disposable
Imports
java.nio.Buffer, .ByteBuffer, .FloatBuffer, com.badlogic.gdx.graphics.GL20, .VertexAttribute, .VertexAttributes, com.badlogic.gdx.utils.BufferUtils

Convenience class for working with OpenGL vertex arrays. It interleaves all data in the order you specified in the constructor via VertexAttribute.

This class is not compatible with OpenGL 3+ core profiles. For this VertexBufferObjects are needed.

Author
mzechner, Dave Clayton

Field Summary

Modifier and TypeField and Description
pack-priv final VertexAttributes
pack-priv final FloatBuffer
pack-priv final ByteBuffer
pack-priv boolean

Constructor Summary

AccessConstructor and Description
public
VertexArray(int
the maximum number of vertices
numVertices
,
VertexAttribute... attributes)

Constructs a new interleaved VertexArray

public
VertexArray(int
the maximum number of vertices
numVertices
,
VertexAttributes attributes)

Constructs a new interleaved VertexArray

Method Summary

Modifier and TypeMethod and Description
public void
bind(final ShaderProgram shader)

Implements com.badlogic.gdx.graphics.glutils.VertexData.bind.

Binds this VertexData for rendering via glDrawArrays or glDrawElements.

public void
bind(final ShaderProgram shader, final int[] locations)

Implements com.badlogic.gdx.graphics.glutils.VertexData.bind.

Binds this VertexData for rendering via glDrawArrays or glDrawElements.

public void
dispose()

Implements com.badlogic.gdx.graphics.glutils.VertexData.dispose.

Disposes this VertexData and all its associated OpenGL resources.

public VertexAttributes
public FloatBuffer
getBuffer()

Implements com.badlogic.gdx.graphics.glutils.VertexData.getBuffer.

Deprecated use getBuffer(boolean) instead

Returns the underlying FloatBuffer and marks it as dirty, causing the buffer contents to be uploaded on the next call to bind.

public FloatBuffer
getBuffer(boolean forWriting)

Implements com.badlogic.gdx.graphics.glutils.VertexData.getBuffer.

Returns the underlying FloatBuffer for reading or writing.

public int
public int
public void
invalidate()

Implements com.badlogic.gdx.graphics.glutils.VertexData.invalidate.

Invalidates the VertexData if applicable.

public void
setVertices(float[] vertices, int offset, int count)

Implements com.badlogic.gdx.graphics.glutils.VertexData.setVertices.

Sets the vertices of this VertexData, discarding the old vertex data.

public void
unbind(ShaderProgram
the shader
shader
)

Implements com.badlogic.gdx.graphics.glutils.VertexData.unbind.

Unbinds this VertexBufferObject.

public void
unbind(ShaderProgram shader, int[] locations)

Implements com.badlogic.gdx.graphics.glutils.VertexData.unbind.

Unbinds this VertexData.

public void
updateVertices(int targetOffset, float[] vertices, int sourceOffset, int count)

Implements com.badlogic.gdx.graphics.glutils.VertexData.updateVertices.

Update (a portion of) the vertices.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

attributesback to summary
pack-priv final VertexAttributes attributes
bufferback to summary
pack-priv final FloatBuffer buffer
byteBufferback to summary
pack-priv final ByteBuffer byteBuffer
isBoundback to summary
pack-priv boolean isBound

Constructor Detail

VertexArrayback to summary
public VertexArray(int numVertices, VertexAttribute... attributes)

Constructs a new interleaved VertexArray

Parameters
numVertices:int

the maximum number of vertices

attributes:VertexAttribute[]

the VertexAttributes

VertexArrayback to summary
public VertexArray(int numVertices, VertexAttributes attributes)

Constructs a new interleaved VertexArray

Parameters
numVertices:int

the maximum number of vertices

attributes:VertexAttributes

the VertexAttributes

Method Detail

bindback to summary
public void bind(final ShaderProgram shader)

Implements com.badlogic.gdx.graphics.glutils.VertexData.bind.

Doc from com.badlogic.gdx.graphics.glutils.VertexData.bind.

Binds this VertexData for rendering via glDrawArrays or glDrawElements.

Annotations
@Override
bindback to summary
public void bind(final ShaderProgram shader, final int[] locations)

Implements com.badlogic.gdx.graphics.glutils.VertexData.bind.

Doc from com.badlogic.gdx.graphics.glutils.VertexData.bind.

Binds this VertexData for rendering via glDrawArrays or glDrawElements.

Annotations
@Override
disposeback to summary
public void dispose()

Implements com.badlogic.gdx.graphics.glutils.VertexData.dispose.

Doc from com.badlogic.gdx.graphics.glutils.VertexData.dispose.

Disposes this VertexData and all its associated OpenGL resources.

Annotations
@Override
getAttributesback to summary
public VertexAttributes getAttributes()

Implements com.badlogic.gdx.graphics.glutils.VertexData.getAttributes.

Annotations
@Override
getBufferback to summary
public FloatBuffer getBuffer()

Implements com.badlogic.gdx.graphics.glutils.VertexData.getBuffer.

Doc from com.badlogic.gdx.graphics.glutils.VertexData.getBuffer.

Deprecated

use getBuffer(boolean) instead

Returns the underlying FloatBuffer and marks it as dirty, causing the buffer contents to be uploaded on the next call to bind. If you need immediate uploading use setVertices(float[], int, int); Any modifications made to the Buffer *after* the call to bind will not automatically be uploaded.

Annotations
@Override
@Deprecated
getBufferback to summary
public FloatBuffer getBuffer(boolean forWriting)

Implements com.badlogic.gdx.graphics.glutils.VertexData.getBuffer.

Doc from com.badlogic.gdx.graphics.glutils.VertexData.getBuffer.

Returns the underlying FloatBuffer for reading or writing.

Annotations
@Override
getNumMaxVerticesback to summary
public int getNumMaxVertices()

Implements com.badlogic.gdx.graphics.glutils.VertexData.getNumMaxVertices.

getNumVerticesback to summary
public int getNumVertices()

Implements com.badlogic.gdx.graphics.glutils.VertexData.getNumVertices.

Annotations
@Override
invalidateback to summary
public void invalidate()

Implements com.badlogic.gdx.graphics.glutils.VertexData.invalidate.

Doc from com.badlogic.gdx.graphics.glutils.VertexData.invalidate.

Invalidates the VertexData if applicable. Use this in case of a context loss.

Annotations
@Override
setVerticesback to summary
public void setVertices(float[] vertices, int offset, int count)

Implements com.badlogic.gdx.graphics.glutils.VertexData.setVertices.

Doc from com.badlogic.gdx.graphics.glutils.VertexData.setVertices.

Sets the vertices of this VertexData, discarding the old vertex data. The count must equal the number of floats per vertex times the number of vertices to be copied to this VertexData. The order of the vertex attributes must be the same as specified at construction time via VertexAttributes.

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

Annotations
@Override
unbindback to summary
public void unbind(ShaderProgram shader)

Implements com.badlogic.gdx.graphics.glutils.VertexData.unbind.

Unbinds this VertexBufferObject.

Parameters
shader:ShaderProgram

the shader

Annotations
@Override
unbindback to summary
public void unbind(ShaderProgram shader, int[] locations)

Implements com.badlogic.gdx.graphics.glutils.VertexData.unbind.

Doc from com.badlogic.gdx.graphics.glutils.VertexData.unbind.

Unbinds this VertexData.

Annotations
@Override
updateVerticesback to summary
public void updateVertices(int targetOffset, float[] vertices, int sourceOffset, int count)

Implements com.badlogic.gdx.graphics.glutils.VertexData.updateVertices.

Doc from com.badlogic.gdx.graphics.glutils.VertexData.updateVertices.

Update (a portion of) the vertices. Does not resize the backing buffer.

Annotations
@Override