maspack.render.GL.GL3

Class BufferObject

java.lang.Object

maspack.util.ReferenceCountedBase

maspack.render.GL.GLResourceBase

maspack.render.GL.GL3.GL3ResourceBase

maspack.render.GL.GL3.BufferObject

All Implemented Interfaces:

GL3Resource, GLResource, ReferenceCounted

Direct Known Subclasses:

IndexBufferObject, UniformBufferObject, VertexBufferObject

public class BufferObject
extends GL3ResourceBase

Generic GL Buffer Object

Constructor Summary

Constructors

Constructor and Description
BufferObject(int target, int BufferId)

Method Summary

Modifier and Type	Method and Description
BufferObject	acquire() Signal the resource that something is holding a reference to it.
void	allocate(com.jogamp.opengl.GL3 gl, int size, int usage)
void	bind(com.jogamp.opengl.GL3 gl)
void	dispose(com.jogamp.opengl.GL3 gl) Dispose of resource
void	fill(com.jogamp.opengl.GL3 gl, java.nio.ByteBuffer buff)
void	fill(com.jogamp.opengl.GL3 gl, java.nio.ByteBuffer buff, int usage)
void	fill(com.jogamp.opengl.GL3 gl, java.nio.ByteBuffer buff, int size, int usage)
void	flushBufferRange(com.jogamp.opengl.GL3 gl, int offset, int length)
static BufferObject	generate(com.jogamp.opengl.GL3 gl, int target)
int	getId()
int	getSize()
int	getUsage()
boolean	isDisposed() Returns true if resource has been disposed
java.nio.ByteBuffer	mapBuffer(com.jogamp.opengl.GL3 gl, int access) Retrieve a mapped buffer to the underlying Buffer data
java.nio.ByteBuffer	mapBufferRange(com.jogamp.opengl.GL3 gl, int offset, int length, int access) Maps only a portion of the underlying buffer
java.nio.ByteBuffer	mapNewBuffer(com.jogamp.opengl.GL3 gl) First orphans the original buffer, potentially causing a re-allocation, then returns a mapped buffer ready for writing.
void	unbind(com.jogamp.opengl.GL3 gl)
void	unmapBuffer(com.jogamp.opengl.GL3 gl)
void	update(com.jogamp.opengl.GL3 gl, java.nio.ByteBuffer buff)
void	update(com.jogamp.opengl.GL3 gl, java.nio.ByteBuffer buff, int start)
void	update(com.jogamp.opengl.GL3 gl, java.nio.ByteBuffer buff, int start, int size)

Methods inherited from class maspack.render.GL.GL3.GL3ResourceBase

dispose, disposeInvalid, disposeInvalid, disposeUnreferenced, disposeUnreferenced, releaseDispose, releaseDispose

Methods inherited from class maspack.render.GL.GLResourceBase

isValid

Methods inherited from class maspack.util.ReferenceCountedBase

acquireAndCount, getReferenceCount, release, releaseAndCount

Methods inherited from class java.lang.Object

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

Methods inherited from interface maspack.render.GL.GLResource

isValid

Methods inherited from interface maspack.util.ReferenceCounted

acquireAndCount, getReferenceCount, release, releaseAndCount

Constructor Detail

BufferObject

public BufferObject(int target,
                    int BufferId)

Method Detail

dispose

public void dispose(com.jogamp.opengl.GL3 gl)

Dispose of resource

Specified by:

dispose in interface GL3Resource

Specified by:

dispose in class GL3ResourceBase

Parameters:

gl - active context

isDisposed

public boolean isDisposed()

Description copied from interface: GLResource

Returns true if resource has been disposed

Specified by:

isDisposed in interface GLResource

Specified by:

isDisposed in class GLResourceBase

allocate

public void allocate(com.jogamp.opengl.GL3 gl,
                     int size,
                     int usage)

fill

public void fill(com.jogamp.opengl.GL3 gl,
                 java.nio.ByteBuffer buff)

fill

public void fill(com.jogamp.opengl.GL3 gl,
                 java.nio.ByteBuffer buff,
                 int usage)

fill

public void fill(com.jogamp.opengl.GL3 gl,
                 java.nio.ByteBuffer buff,
                 int size,
                 int usage)

update

public void update(com.jogamp.opengl.GL3 gl,
                   java.nio.ByteBuffer buff)

update

public void update(com.jogamp.opengl.GL3 gl,
                   java.nio.ByteBuffer buff,
                   int start)

update

public void update(com.jogamp.opengl.GL3 gl,
                   java.nio.ByteBuffer buff,
                   int start,
                   int size)

mapBuffer

public java.nio.ByteBuffer mapBuffer(com.jogamp.opengl.GL3 gl,
                                     int access)

Retrieve a mapped buffer to the underlying Buffer data

Parameters:

gl - GL hanlde

access - either GL3.GL_WRITE_ONLY, GL3.GL_READ_ONLY, or GL3.GL_READ_WRITE;

Returns:

the mapped buffer

mapBufferRange

public java.nio.ByteBuffer mapBufferRange(com.jogamp.opengl.GL3 gl,
                                          int offset,
                                          int length,
                                          int access)

Maps only a portion of the underlying buffer

flushBufferRange

public void flushBufferRange(com.jogamp.opengl.GL3 gl,
                             int offset,
                             int length)

mapNewBuffer

public java.nio.ByteBuffer mapNewBuffer(com.jogamp.opengl.GL3 gl)

First orphans the original buffer, potentially causing a re-allocation, then returns a mapped buffer ready for writing.

unmapBuffer

public void unmapBuffer(com.jogamp.opengl.GL3 gl)

bind

public void bind(com.jogamp.opengl.GL3 gl)

unbind

public void unbind(com.jogamp.opengl.GL3 gl)

getId

public int getId()

getUsage

public int getUsage()

getSize

public int getSize()

acquire

public BufferObject acquire()

Description copied from interface: ReferenceCounted

Signal the resource that something is holding a reference to it.

Specified by:

acquire in interface GL3Resource

Specified by:

acquire in interface GLResource

Specified by:

acquire in interface ReferenceCounted

Overrides:

acquire in class GL3ResourceBase

Returns:

a reference to the acquired object for convenience.

generate

public static BufferObject generate(com.jogamp.opengl.GL3 gl,
                                    int target)