JOGL 2.3.2 · com.jogamp.opengl.GLBufferStorage

OpenGL buffer storage object reflecting it's

storage size
storage memory if mapped
mutable usage or immutable flags

Buffer storage is created via:

GL#glBufferData(int, long, java.nio.Buffer, int) - storage creation via target
GL2#glNamedBufferDataEXT(int, long, java.nio.Buffer, int) - storage creation, direct
GL4#glNamedBufferData(int, long, java.nio.Buffer, int) - storage creation, direct
GL4#glBufferStorage(int, long, Buffer, int) - storage creation via target
GL4#glNamedBufferStorage(int, long, Buffer, int) - storage creation, direct

Note that storage recreation as mentioned above also invalidate a previous storage instance, i.e. disposed the buffer's current storage if exist and attaches a new storage instance.

Buffer storage is disposed via:

GL#glDeleteBuffers(int, IntBuffer) - explicit, direct, via notifyBuffersDeleted(int, IntBuffer) or notifyBuffersDeleted(int, int[], int)
GL#glBufferData(int, long, java.nio.Buffer, int) - storage recreation via target
GL2#glNamedBufferDataEXT(int, long, java.nio.Buffer, int) - storage recreation, direct
GL4#glNamedBufferData(int, long, java.nio.Buffer, int) - storage recreation, direct
GL4#glBufferStorage(int, long, Buffer, int) - storage recreation via target
GL4#glNamedBufferStorage(int, long, Buffer, int) - storage recreation, direct

GL buffer storage is mapped via

GL buffer storage is unmapped via

GL#glDeleteBuffers(int, IntBuffer) - buffer deletion
GL#glUnmapBuffer(int) - explicit via target
GL2#glUnmapNamedBufferEXT(int) - explicit direct
GL4#glUnmapNamedBuffer(int) - explicit direct
GL#glBufferData(int, long, java.nio.Buffer, int) - storage recreation via target
GL2#glNamedBufferDataEXT(int, long, java.nio.Buffer, int) - storage recreation, direct
GL4#glNamedBufferData(int, long, java.nio.Buffer, int) - storage recreation, direct
GL4#glBufferStorage(int, long, Buffer, int) - storage creation via target
GL4#glNamedBufferStorage(int, long, Buffer, int) - storage creation, direct

Modifier and Type	Field and Description
private int	immutableFlags
private ByteBuffer	mappedBuffer
private static final String	msgClazzName
private int	mutableUsage
private final int	name
private long	size

Access	Constructor and Description
protected	GLBufferStorage(final int name, final long size, final int mutableUsage, final int immutableFlags)

Method Summary

Modifier and Type	Method and Description
public final int	getImmutableFlags() Returns the immutable storage flags, invalid if storage is `mutable`.
public final ByteBuffer	getMappedBuffer() Returns the mapped ByteBuffer, or null if not mapped.
public final int	getMutableUsage() Returns the mutable storage usage or 0 if storage is not `mutable`.
public final int	getName() Return the buffer name
public final long	getSize() Return the buffer's storage size.
public final boolean	isMutableStorage() Returns `true` if buffer's storage is mutable, i.e. created via `GL#glBufferData(int, long, java.nio.Buffer, int)`.
protected void	reset(final long size, final int mutableUsage, final int immutableFlags)
protected void	setMappedBuffer(final ByteBuffer buffer)
public final String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public final String	toString(final boolean skipMappedBuffer)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

immutableFlags	back to summary
private int immutableFlags

mappedBuffer	back to summary
private ByteBuffer mappedBuffer

msgClazzName	back to summary
private static final String msgClazzName

mutableUsage	back to summary
private int mutableUsage

name	back to summary
private final int name

size	back to summary
private long size

GLBufferStorage	back to summary
protected GLBufferStorage(final int name, final long size, final int mutableUsage, final int immutableFlags)

Method Detail

getImmutableFlags	back to summary
public final int getImmutableFlags() Returns the immutable storage flags, invalid if storage is `mutable`.

getMappedBuffer back to summary

getMappedBuffer	back to summary
public final ByteBuffer getMappedBuffer() Returns the mapped ByteBuffer, or null if not mapped. Mapping may occur via: `GL#glMapBuffer(int, int)` `GL#glMapBufferRange(int, long, long, int)` `GL2#glMapNamedBufferEXT(int, int)` `GL2#glMapNamedBufferRangeEXT(int, long, long, int)`

public final ByteBuffer getMappedBuffer()

Returns the mapped ByteBuffer, or null if not mapped. Mapping may occur via:

getMutableUsage	back to summary
public final int getMutableUsage() Returns the mutable storage usage or 0 if storage is not `mutable`.

getName	back to summary
public final int getName() Return the buffer name

getSize	back to summary
public final long getSize() Return the buffer's storage size.

isMutableStorage back to summary

isMutableStorage	back to summary
public final boolean isMutableStorage() Returns `true` if buffer's storage is mutable, i.e. created via `GL#glBufferData(int, long, java.nio.Buffer, int)`. Returns `false` if buffer's storage is immutable, i.e. created via `GL4#glBufferStorage(int, long, Buffer, int)`.

public final boolean isMutableStorage()

Returns true if buffer's storage is mutable, i.e. created via GL#glBufferData(int, long, java.nio.Buffer, int).

Returns false if buffer's storage is immutable, i.e. created via GL4#glBufferStorage(int, long, Buffer, int).

reset	back to summary
protected void reset(final long size, final int mutableUsage, final int immutableFlags)

setMappedBuffer	back to summary
protected void setMappedBuffer(final ByteBuffer buffer)

toString	back to summary
public final String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object

toString

back to summary

public final String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String: a string representation of the object

toString	back to summary
public final String toString(final boolean skipMappedBuffer)

public abstract Class GLBufferStorage

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail