JOGL v2.6.0-rc-20250706
JOGL, High-Performance Graphics Binding for Java™ (public API).
com.jogamp.opengl.FBObject.Colorbuffer Interface Reference

Generic color buffer FBO attachment, either of type ColorAttachment or TextureAttachment. More...

Inheritance diagram for com.jogamp.opengl.FBObject.Colorbuffer:
Collaboration diagram for com.jogamp.opengl.FBObject.Colorbuffer:

Public Member Functions

boolean initialize (final GL gl) throws GLException
 Initializes the color buffer and set it's parameter, if uninitialized, i.e. More...
 
void free (final GL gl) throws GLException
 Releases the color buffer if initialized, i.e. More...
 
void formatToGLCapabilities (final GLCapabilities caps, final boolean rgba8Avail)
 Writes the internal format to the given GLCapabilities object. More...
 
boolean isTextureAttachment ()
 Returns true if instance is of type TextureAttachment and false if instance is of type ColorAttachment. More...
 
TextureAttachment getTextureAttachment ()
 Casts this object to a TextureAttachment reference, see isTextureAttachment(). More...
 
ColorAttachment getColorAttachment ()
 Casts this object to a ColorAttachment reference, see isTextureAttachment(). More...
 
int getFormat ()
 internal format of colorbuffer More...
 
int getWidth ()
 width of colorbuffer More...
 
int getHeight ()
 height of colorbuffer More...
 
int getName ()
 colorbuffer name [1..max] More...
 

Detailed Description

Generic color buffer FBO attachment, either of type ColorAttachment or TextureAttachment.

Always an instance of Attachment.

Definition at line 70 of file FBObject.java.

Member Function Documentation

◆ formatToGLCapabilities()

void com.jogamp.opengl.FBObject.Colorbuffer.formatToGLCapabilities ( final GLCapabilities  caps,
final boolean  rgba8Avail 
)

Writes the internal format to the given GLCapabilities object.

Parameters
capsthe destination for format bits
rgba8Availwhether rgba8 is available
Here is the caller graph for this function:

◆ free()

void com.jogamp.opengl.FBObject.Colorbuffer.free ( final GL  gl) throws GLException

Releases the color buffer if initialized, i.e.

name is not zero.

Exceptions
GLExceptionif buffer release fails.

Implemented in com.jogamp.opengl.FBObject.TextureAttachment.

◆ getColorAttachment()

ColorAttachment com.jogamp.opengl.FBObject.Colorbuffer.getColorAttachment ( )

Casts this object to a ColorAttachment reference, see isTextureAttachment().

Exceptions
GLExceptionif this object is not of type ColorAttachment
See also
isTextureAttachment()

Implemented in com.jogamp.opengl.FBObject.ColorAttachment, and com.jogamp.opengl.FBObject.TextureAttachment.

◆ getFormat()

int com.jogamp.opengl.FBObject.Colorbuffer.getFormat ( )

internal format of colorbuffer

Here is the caller graph for this function:

◆ getHeight()

int com.jogamp.opengl.FBObject.Colorbuffer.getHeight ( )

height of colorbuffer

Here is the caller graph for this function:

◆ getName()

int com.jogamp.opengl.FBObject.Colorbuffer.getName ( )

colorbuffer name [1..max]

Here is the caller graph for this function:

◆ getTextureAttachment()

TextureAttachment com.jogamp.opengl.FBObject.Colorbuffer.getTextureAttachment ( )

Casts this object to a TextureAttachment reference, see isTextureAttachment().

Exceptions
GLExceptionif this object is not of type TextureAttachment
See also
isTextureAttachment()

Implemented in com.jogamp.opengl.FBObject.ColorAttachment, and com.jogamp.opengl.FBObject.TextureAttachment.

◆ getWidth()

int com.jogamp.opengl.FBObject.Colorbuffer.getWidth ( )

width of colorbuffer

Here is the caller graph for this function:

◆ initialize()

boolean com.jogamp.opengl.FBObject.Colorbuffer.initialize ( final GL  gl) throws GLException

Initializes the color buffer and set it's parameter, if uninitialized, i.e.

name is zero.

Returns
true if newly initialized, otherwise false.
Exceptions
GLExceptionif buffer generation or setup fails. The just created buffer name will be deleted in this case.

Implemented in com.jogamp.opengl.FBObject.TextureAttachment.

◆ isTextureAttachment()

boolean com.jogamp.opengl.FBObject.Colorbuffer.isTextureAttachment ( )

Returns true if instance is of type TextureAttachment and false if instance is of type ColorAttachment.

Implemented in com.jogamp.opengl.FBObject.ColorAttachment, and com.jogamp.opengl.FBObject.TextureAttachment.


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