Package gaiasky.util.gdx.mesh

Class VertexBufferObjectInstanced

java.lang.Object
gaiasky.util.gdx.mesh.VertexBufferObjectInstanced
All Implemented Interfaces:
com.badlogic.gdx.utils.Disposable, IntVertexData
public class VertexBufferObjectInstanced extends Object implements IntVertexData

A VertexData implementation that uses vertex buffer objects and vertex array objects to construct a global buffer and an instance buffer for instanced rendering. The global buffer holds the attributes that do not change (i.e. position, uv, etc.), the instance buffer holds attributes that change for every instance. (This is required for OpenGL 3.0+ core profiles. In particular, the default VAO has been deprecated, as has the use of client memory for passing vertex attributes.) Use of VAOs should give a slight performance benefit since you don't have to bind the attributes on every draw anymore.

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

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

Code adapted from VertexBufferObject.

  • Constructor Summary

    Constructors
    Constructor
    Description
    VertexBufferObjectInstanced(boolean isStatic, int numGlobal, com.badlogic.gdx.graphics.VertexAttributes globalAttributes, int numInstance, com.badlogic.gdx.graphics.VertexAttributes instanceAttributes)
    Constructs a new interleaved VertexBufferObjectWithVAO.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    bind(ExtShaderProgram shader)
    Binds this VertexBufferObject for rendering via glDrawArrays or glDrawElements
    void
    bind(ExtShaderProgram shader, int[] locations)
    Binds this VertexData for rendering via glDrawArrays or glDrawElements.
    void
    dispose()
    Disposes of all resources this VertexBufferObject uses.
    com.badlogic.gdx.graphics.VertexAttributes
    getAttributes()
     
    FloatBuffer
    getBuffer()
    Returns the underlying FloatBuffer and marks it as dirty, causing the buffer contents to be uploaded on the next call to bind.
    com.badlogic.gdx.graphics.VertexAttributes
    getInstanceAttributes()
     
    int
    getNumMaxVertices()
     
    int
    getNumVertices()
     
    void
    invalidate()
    Invalidates the VertexBufferObject so a new OpenGL buffer handle is created.
    void
    setInstance(float[] vertices, int offset, int count)
     
    void
    setVertices(float[] vertices, int offset, int count)
    Sets the vertices of this VertexData, discarding the old vertex data.
    void
    unbind(ExtShaderProgram shader)
    Unbinds this VertexBufferObject.
    void
    unbind(ExtShaderProgram shader, int[] locations)
    Unbinds this VertexData.
    void
    updateVertices(int targetOffset, float[] vertices, int sourceOffset, int count)
    Update (a portion of) the vertices.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • VertexBufferObjectInstanced

      public VertexBufferObjectInstanced(boolean isStatic, int numGlobal, com.badlogic.gdx.graphics.VertexAttributes globalAttributes, int numInstance, com.badlogic.gdx.graphics.VertexAttributes instanceAttributes)
      Constructs a new interleaved VertexBufferObjectWithVAO.
      Parameters:
      isStatic - whether the vertex data is static.
      numGlobal - the maximum number of vertices
      globalAttributes - the VertexAttributes.

  • Method Details

    • getAttributes

      public com.badlogic.gdx.graphics.VertexAttributes getAttributes()
      Specified by:
      getAttributes in interface IntVertexData
      Returns:
      the VertexAttributes as specified during construction.

    • getInstanceAttributes

      public com.badlogic.gdx.graphics.VertexAttributes getInstanceAttributes()

    • getNumVertices

      public int getNumVertices()
      Specified by:
      getNumVertices in interface IntVertexData
      Returns:
      the number of vertices this VertexData stores

    • getNumMaxVertices

      public int getNumMaxVertices()
      Specified by:
      getNumMaxVertices in interface IntVertexData
      Returns:
      the number of vertices this VertedData can store

    • getBuffer

      public FloatBuffer getBuffer()
      Description copied from interface: IntVertexData
      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 IntVertexData.setVertices(float[], int, int); Any modifications made to the Buffer *after* the call to bind will not automatically be uploaded.
      Specified by:
      getBuffer in interface IntVertexData
      Returns:
      the underlying FloatBuffer holding the vertex data.

    • setVertices

      public void setVertices(float[] vertices, int offset, int count)
      Description copied from interface: IntVertexData
      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.

      Specified by:
      setVertices in interface IntVertexData
      Parameters:
      vertices - the vertex data
      offset - the offset to start copying the data from
      count - the number of floats to copy

    • setInstance

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

    • updateVertices

      public void updateVertices(int targetOffset, float[] vertices, int sourceOffset, int count)
      Description copied from interface: IntVertexData
      Update (a portion of) the vertices. Does not resize the backing buffer.
      Specified by:
      updateVertices in interface IntVertexData
      Parameters:
      vertices - the vertex data
      sourceOffset - the offset to start copying the data from
      count - the number of floats to copy

    • bind

      public void bind(ExtShaderProgram shader)
      Binds this VertexBufferObject for rendering via glDrawArrays or glDrawElements
      Specified by:
      bind in interface IntVertexData
      Parameters:
      shader - the shader

    • bind

      public void bind(ExtShaderProgram shader, int[] locations)
      Description copied from interface: IntVertexData
      Binds this VertexData for rendering via glDrawArrays or glDrawElements.
      Specified by:
      bind in interface IntVertexData
      Parameters:
      locations - array containing the attribute locations.

    • unbind

      public void unbind(ExtShaderProgram shader)
      Unbinds this VertexBufferObject.
      Specified by:
      unbind in interface IntVertexData
      Parameters:
      shader - the shader

    • unbind

      public void unbind(ExtShaderProgram shader, int[] locations)
      Description copied from interface: IntVertexData
      Unbinds this VertexData.
      Specified by:
      unbind in interface IntVertexData
      Parameters:
      locations - array containing the attribute locations.

    • invalidate

      public void invalidate()
      Invalidates the VertexBufferObject so a new OpenGL buffer handle is created. Use this in case of a context loss.
      Specified by:
      invalidate in interface IntVertexData

    • dispose

      public void dispose()
      Disposes of all resources this VertexBufferObject uses.
      Specified by:
      dispose in interface com.badlogic.gdx.utils.Disposable
      Specified by:
      dispose in interface IntVertexData