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

public Class InstanceBufferObject

extends Object
implements InstanceData
Class Inheritance
All Implemented Interfaces
com.badlogic.gdx.graphics.glutils.InstanceData, com.badlogic.gdx.utils.Disposable
Imports
com.badlogic.gdx.Gdx, com.badlogic.gdx.graphics.GL20, .VertexAttribute, .VertexAttributes, com.badlogic.gdx.utils.BufferUtils, .GdxRuntimeException, java.nio.Buffer, .ByteBuffer, .FloatBuffer
Modification of the VertexBufferObject class. Sets the glVertexAttribDivisor for every VertexAttribute automatically.
Author
mrdlink

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
InstanceBufferObject(boolean isStatic, int numVertices, VertexAttribute... attributes)

public
InstanceBufferObject(boolean isStatic, int numVertices, VertexAttributes instanceAttributes)

Method Summary

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

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

Binds this InstanceBufferObject for rendering via glDrawArraysInstanced or glDrawElementsInstanced

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

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

Binds this InstanceData for rendering via glDrawArraysInstanced or glDrawElementsInstanced.

private void
bufferChanged()

public void
dispose()

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

Disposes of all resources this InstanceBufferObject uses.

public VertexAttributes
getAttributes()

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

public FloatBuffer
getBuffer()

Implements com.badlogic.gdx.graphics.glutils.InstanceData.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.InstanceData.getBuffer.

Returns the underlying FloatBuffer for reading or writing.

public int
getNumInstances()

Implements com.badlogic.gdx.graphics.glutils.InstanceData.getNumInstances.

public int
getNumMaxInstances()

Implements com.badlogic.gdx.graphics.glutils.InstanceData.getNumMaxInstances.

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.InstanceData.invalidate.

Invalidates the InstanceBufferObject 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.

public void
setInstanceData(float[] data, int offset, int count)

Implements com.badlogic.gdx.graphics.glutils.InstanceData.setInstanceData.

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

public void
setInstanceData(FloatBuffer data, int count)

Implements com.badlogic.gdx.graphics.glutils.InstanceData.setInstanceData.

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

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

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

Unbinds this InstanceBufferObject.

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

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

Unbinds this InstanceData.

public void
updateInstanceData(int targetOffset, float[] data, int sourceOffset, int count)

Implements com.badlogic.gdx.graphics.glutils.InstanceData.updateInstanceData.

Update (a portion of) the vertices.

public void
updateInstanceData(int targetOffset, FloatBuffer data, int sourceOffset, int count)

Implements com.badlogic.gdx.graphics.glutils.InstanceData.updateInstanceData.

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

InstanceBufferObjectback to summary
public InstanceBufferObject(boolean isStatic, int numVertices, VertexAttribute... attributes)
InstanceBufferObjectback to summary
public InstanceBufferObject(boolean isStatic, int numVertices, VertexAttributes instanceAttributes)

Method Detail

bindback to summary
public void bind(ShaderProgram shader)

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

Binds this InstanceBufferObject for rendering via glDrawArraysInstanced or glDrawElementsInstanced

Parameters
shader:ShaderProgram

the shader

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

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

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

Binds this InstanceData for rendering via glDrawArraysInstanced or glDrawElementsInstanced.

Annotations
@Override
bufferChangedback to summary
private void bufferChanged()
disposeback to summary
public void dispose()

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

Disposes of all resources this InstanceBufferObject uses.

Annotations
@Override
getAttributesback to summary
public VertexAttributes getAttributes()

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

Annotations
@Override
getBufferback to summary
public FloatBuffer getBuffer()

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

Doc from com.badlogic.gdx.graphics.glutils.InstanceData.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 setInstanceData(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.InstanceData.getBuffer.

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

Returns the underlying FloatBuffer for reading or writing.

Annotations
@Override
getNumInstancesback to summary
public int getNumInstances()

Implements com.badlogic.gdx.graphics.glutils.InstanceData.getNumInstances.

Annotations
@Override
getNumMaxInstancesback to summary
public int getNumMaxInstances()

Implements com.badlogic.gdx.graphics.glutils.InstanceData.getNumMaxInstances.

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.InstanceData.invalidate.

Invalidates the InstanceBufferObject 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!

setInstanceDataback to summary
public void setInstanceData(float[] data, int offset, int count)

Implements com.badlogic.gdx.graphics.glutils.InstanceData.setInstanceData.

Doc from com.badlogic.gdx.graphics.glutils.InstanceData.setInstanceData.

Sets the vertices of this InstanceData, 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
setInstanceDataback to summary
public void setInstanceData(FloatBuffer data, int count)

Implements com.badlogic.gdx.graphics.glutils.InstanceData.setInstanceData.

Doc from com.badlogic.gdx.graphics.glutils.InstanceData.setInstanceData.

Sets the vertices of this InstanceData, 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 InstanceData. 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
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.

unbindback to summary
public void unbind(final ShaderProgram shader)

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

Unbinds this InstanceBufferObject.

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.InstanceData.unbind.

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

Unbinds this InstanceData.

Annotations
@Override
updateInstanceDataback to summary
public void updateInstanceData(int targetOffset, float[] data, int sourceOffset, int count)

Implements com.badlogic.gdx.graphics.glutils.InstanceData.updateInstanceData.

Doc from com.badlogic.gdx.graphics.glutils.InstanceData.updateInstanceData.

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

Annotations
@Override
updateInstanceDataback to summary
public void updateInstanceData(int targetOffset, FloatBuffer data, int sourceOffset, int count)

Implements com.badlogic.gdx.graphics.glutils.InstanceData.updateInstanceData.

Doc from com.badlogic.gdx.graphics.glutils.InstanceData.updateInstanceData.

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

Annotations
@Override