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

public Class VertexBufferObject

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.Gdx, com.badlogic.gdx.graphics.GL20, .VertexAttribute, .VertexAttributes, com.badlogic.gdx.utils.BufferUtils, .GdxRuntimeException

A VertexData implementation based on OpenGL vertex buffer objects.

If the OpenGL ES context was lost you can call invalidate() to recreate a new OpenGL vertex buffer object.

The data is bound via glVertexAttribPointer() according to the attribute aliases specified via VertexAttributes in the constructor.

VertexBufferObjects must be disposed via the dispose() method when no longer needed

Author
mzechner, Dave Clayton

Field Summary

Modifier and TypeField and Description
private VertexAttributes
attributes

private FloatBuffer
buffer

private int
bufferHandle

private ByteBuffer
byteBuffer

pack-priv boolean
isBound

pack-priv boolean
isDirty

private boolean
ownsBuffer

private int
usage

Constructor Summary

AccessConstructor and Description
public
VertexBufferObject(boolean
whether the vertex data is static.
isStatic, int
the maximum number of vertices
numVertices, VertexAttribute...
the VertexAttributes.
attributes)

Constructs a new interleaved VertexBufferObject.

public
VertexBufferObject(boolean
whether the vertex data is static.
isStatic, int
the maximum number of vertices
numVertices, VertexAttributes
the VertexAttributes.
attributes)

Constructs a new interleaved VertexBufferObject.

protected
VertexBufferObject(int usage, ByteBuffer data, boolean ownsBuffer, VertexAttributes attributes)

Method Summary

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

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

Binds this VertexBufferObject for rendering via glDrawArrays or glDrawElements

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

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

Binds this VertexData for rendering via glDrawArrays or glDrawElements.

private void
bufferChanged()

public void
dispose()

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

Disposes of all resources this VertexBufferObject uses.

public VertexAttributes
getAttributes()

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

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
getNumMaxVertices()

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

public int
getNumVertices()

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

protected int
getUsage()

Returns: The GL enum used in the call to GL20#glBufferData(int, int, java.nio.Buffer, int), e.g. GL_STATIC_DRAW or GL_DYNAMIC_DRAW

public void
invalidate()

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

Invalidates the VertexBufferObject so a new OpenGL buffer handle is created.

protected void
setBuffer(Buffer data, boolean ownsBuffer, VertexAttributes value)

Low level method to reset the buffer and attributes to the specified values.

protected void
setUsage(int value)

Set the GL enum used in the call to GL20#glBufferData(int, int, java.nio.Buffer, int), can only be called when the VBO is not bound.

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(final ShaderProgram
the shader
shader)

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

Unbinds this VertexBufferObject.

public void
unbind(final ShaderProgram shader, final 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
private VertexAttributes attributes
bufferback to summary
private FloatBuffer buffer
bufferHandleback to summary
private int bufferHandle
byteBufferback to summary
private ByteBuffer byteBuffer
isBoundback to summary
pack-priv boolean isBound
isDirtyback to summary
pack-priv boolean isDirty
ownsBufferback to summary
private boolean ownsBuffer
usageback to summary
private int usage

Constructor Detail

VertexBufferObjectback to summary
public VertexBufferObject(boolean isStatic, int numVertices, VertexAttribute... attributes)

Constructs a new interleaved VertexBufferObject.

Parameters
isStatic:boolean

whether the vertex data is static.

numVertices:int

the maximum number of vertices

attributes:VertexAttribute[]

the VertexAttributes.

VertexBufferObjectback to summary
public VertexBufferObject(boolean isStatic, int numVertices, VertexAttributes attributes)

Constructs a new interleaved VertexBufferObject.

Parameters
isStatic:boolean

whether the vertex data is static.

numVertices:int

the maximum number of vertices

attributes:VertexAttributes

the VertexAttributes.

VertexBufferObjectback to summary
protected VertexBufferObject(int usage, ByteBuffer data, boolean ownsBuffer, VertexAttributes attributes)

Method Detail

bindback to summary
public void bind(ShaderProgram shader)

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

Binds this VertexBufferObject for rendering via glDrawArrays or glDrawElements

Parameters
shader:ShaderProgram

the shader

Annotations
@Override
bindback to summary
public void bind(ShaderProgram shader, 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
bufferChangedback to summary
private void bufferChanged()
disposeback to summary
public void dispose()

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

Disposes of all resources this VertexBufferObject uses.

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.

Annotations
@Override
getNumVerticesback to summary
public int getNumVertices()

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

Annotations
@Override
getUsageback to summary
protected int getUsage()
Returns:int

The GL enum used in the call to GL20#glBufferData(int, int, java.nio.Buffer, int), e.g. GL_STATIC_DRAW or GL_DYNAMIC_DRAW

invalidateback to summary
public void invalidate()

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

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

Annotations
@Override
setBufferback to summary
protected void setBuffer(Buffer data, boolean ownsBuffer, VertexAttributes value)

Low level method to reset the buffer and attributes to the specified values. Use with care!

setUsageback to summary
protected void setUsage(int value)

Set the GL enum used in the call to GL20#glBufferData(int, int, java.nio.Buffer, int), can only be called when the VBO is not bound.

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(final 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(final ShaderProgram shader, final 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