JOGL v2.6.0-rc-20250706
JOGL, High-Performance Graphics Binding for Java™ (public API).
com.jogamp.opengl.GLBufferStorage Class Referenceabstract

OpenGL buffer storage object reflecting it's. More...

Collaboration diagram for com.jogamp.opengl.GLBufferStorage:

Public Member Functions

final int getName ()
 Return the buffer name. More...
 
final long getSize ()
 Return the buffer's storage size. More...
 
final boolean isMutableStorage ()
 Returns true if buffer's storage is mutable, i.e. More...
 
final int getMutableUsage ()
 Returns the mutable storage usage or 0 if storage is not mutable. More...
 
final int getImmutableFlags ()
 Returns the immutable storage flags, invalid if storage is mutable. More...
 
final ByteBuffer getMappedBuffer ()
 Returns the mapped ByteBuffer, or null if not mapped. More...
 
final String toString ()
 
final String toString (final boolean skipMappedBuffer)
 

Protected Member Functions

 GLBufferStorage (final int name, final long size, final int mutableUsage, final int immutableFlags)
 
void reset (final long size, final int mutableUsage, final int immutableFlags)
 
void setMappedBuffer (final ByteBuffer buffer)
 

Detailed Description

OpenGL buffer storage object reflecting it's.

  • storage size
  • storage memory if mapped
  • mutable usage or immutable flags

Buffer storage is created via:

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 buffer storage is mapped via

GL buffer storage is unmapped via

Definition at line 90 of file GLBufferStorage.java.

Constructor & Destructor Documentation

◆ GLBufferStorage()

com.jogamp.opengl.GLBufferStorage.GLBufferStorage ( final int  name,
final long  size,
final int  mutableUsage,
final int  immutableFlags 
)
protected

Definition at line 97 of file GLBufferStorage.java.

Member Function Documentation

◆ getImmutableFlags()

final int com.jogamp.opengl.GLBufferStorage.getImmutableFlags ( )

Returns the immutable storage flags, invalid if storage is mutable.

Definition at line 140 of file GLBufferStorage.java.

◆ getMappedBuffer()

final ByteBuffer com.jogamp.opengl.GLBufferStorage.getMappedBuffer ( )

Returns the mapped ByteBuffer, or null if not mapped.

Mapping may occur via:

Definition at line 152 of file GLBufferStorage.java.

Here is the caller graph for this function:

◆ getMutableUsage()

final int com.jogamp.opengl.GLBufferStorage.getMutableUsage ( )

Returns the mutable storage usage or 0 if storage is not mutable.

Definition at line 135 of file GLBufferStorage.java.

◆ getName()

final int com.jogamp.opengl.GLBufferStorage.getName ( )

Return the buffer name.

Definition at line 116 of file GLBufferStorage.java.

◆ getSize()

final long com.jogamp.opengl.GLBufferStorage.getSize ( )

Return the buffer's storage size.

Definition at line 119 of file GLBufferStorage.java.

Here is the caller graph for this function:

◆ isMutableStorage()

final boolean com.jogamp.opengl.GLBufferStorage.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).

Returns

Definition at line 130 of file GLBufferStorage.java.

Here is the caller graph for this function:

◆ reset()

void com.jogamp.opengl.GLBufferStorage.reset ( final long  size,
final int  mutableUsage,
final int  immutableFlags 
)
protected

Definition at line 105 of file GLBufferStorage.java.

◆ setMappedBuffer()

void com.jogamp.opengl.GLBufferStorage.setMappedBuffer ( final ByteBuffer  buffer)
protected

Definition at line 111 of file GLBufferStorage.java.

◆ toString() [1/2]

final String com.jogamp.opengl.GLBufferStorage.toString ( )

Definition at line 154 of file GLBufferStorage.java.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ toString() [2/2]

final String com.jogamp.opengl.GLBufferStorage.toString ( final boolean  skipMappedBuffer)

Definition at line 157 of file GLBufferStorage.java.

Here is the call graph for this function:

The documentation for this class was generated from the following file: