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

Common super class of all FBO attachments. More...

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

Classes

interface  StorageDefinition
 Interface abstraction to allow custom definitions of Attachment's storage. More...
 
enum  Type
 

Public Member Functions

void setStorageDefinition (final StorageDefinition sd)
 Override implementation default StorageDefinition. More...
 
final void formatToGLCapabilities (final GLCapabilities caps, final boolean rgba8Avail)
 Writes the internal format to the given GLCapabilities object. More...
 
final int getFormat ()
 immutable internal format of attachment More...
 
final int getWidth ()
 width of attachment More...
 
final int getHeight ()
 height of attachment More...
 
final int getName ()
 buffer name [1..max], maybe a texture or renderbuffer name, depending on type. More...
 
abstract boolean initialize (final GL gl) throws GLException
 Initializes the attachment and set it's parameter, if uninitialized, i.e. More...
 
abstract void free (final GL gl) throws GLException
 Releases the attachment if initialized, i.e. More...
 
boolean equals (final Object o)
 
int hashCode ()
 
String toString ()
 

Static Public Member Functions

static Type getType (final int attachmentPoint, final int maxColorAttachments)
 

Public Attributes

final Type type
 immutable type [COLOR, DEPTH, STENCIL, COLOR_TEXTURE, DEPTH_TEXTURE, STENCIL_TEXTURE ] More...
 
final int format
 immutable the internal format More...
 

Protected Member Functions

 Attachment (final Type type, final int iFormat, final int width, final int height, final int name)
 
final void setStorage (final GL gl)
 Accessor to call StorageDefinition#setStorage(GL, Attachment) within initialize(GL) for implementations of Attachment. More...
 

Detailed Description

Common super class of all FBO attachments.

Definition at line 125 of file FBObject.java.

Constructor & Destructor Documentation

◆ Attachment()

com.jogamp.opengl.FBObject.Attachment.Attachment ( final Type  type,
final int  iFormat,
final int  width,
final int  height,
final int  name 
)
protected

Definition at line 196 of file FBObject.java.

Here is the caller graph for this function:

Member Function Documentation

◆ equals()

boolean com.jogamp.opengl.FBObject.Attachment.equals ( final Object  o)

Comparison by type, format, width, height and name.

Reimplemented in com.jogamp.opengl.FBObject.RenderAttachment.

Definition at line 338 of file FBObject.java.

Here is the call graph for this function:

◆ formatToGLCapabilities()

final void com.jogamp.opengl.FBObject.Attachment.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

Definition at line 220 of file FBObject.java.

Here is the call graph for this function:

◆ free()

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

Releases the attachment if initialized, i.e.

name is not zero.

 if(0 != name) {
     do free ..
     name = 0;
 }
Exceptions
GLExceptionif buffer release fails.

Reimplemented in com.jogamp.opengl.FBObject.RenderAttachment, and com.jogamp.opengl.FBObject.TextureAttachment.

◆ getFormat()

final int com.jogamp.opengl.FBObject.Attachment.getFormat ( )

immutable internal format of attachment

Definition at line 293 of file FBObject.java.

◆ getHeight()

final int com.jogamp.opengl.FBObject.Attachment.getHeight ( )

height of attachment

Definition at line 298 of file FBObject.java.

Here is the caller graph for this function:

◆ getName()

final int com.jogamp.opengl.FBObject.Attachment.getName ( )

buffer name [1..max], maybe a texture or renderbuffer name, depending on type.

Definition at line 302 of file FBObject.java.

Here is the caller graph for this function:

◆ getType()

static Type com.jogamp.opengl.FBObject.Attachment.getType ( final int  attachmentPoint,
final int  maxColorAttachments 
)
static

Definition at line 374 of file FBObject.java.

◆ getWidth()

final int com.jogamp.opengl.FBObject.Attachment.getWidth ( )

width of attachment

Definition at line 296 of file FBObject.java.

Here is the caller graph for this function:

◆ hashCode()

int com.jogamp.opengl.FBObject.Attachment.hashCode ( )

Hashed by type, format, width, height and name.

Reimplemented in com.jogamp.opengl.FBObject.RenderAttachment.

Definition at line 356 of file FBObject.java.

◆ initialize()

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

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

name is zero.

 final boolean init = 0 == name;
 if( init ) {
     do init ..
 }
 return init;
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.

Reimplemented in com.jogamp.opengl.FBObject.RenderAttachment, and com.jogamp.opengl.FBObject.TextureAttachment.

◆ setStorage()

final void com.jogamp.opengl.FBObject.Attachment.setStorage ( final GL  gl)
protected

Accessor to call StorageDefinition#setStorage(GL, Attachment) within initialize(GL) for implementations of Attachment.

Definition at line 213 of file FBObject.java.

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

◆ setStorageDefinition()

void com.jogamp.opengl.FBObject.Attachment.setStorageDefinition ( final StorageDefinition  sd)

Override implementation default StorageDefinition.

See also
StorageDefinition#setStorage(GL, Attachment)

Definition at line 208 of file FBObject.java.

Here is the caller graph for this function:

◆ toString()

String com.jogamp.opengl.FBObject.Attachment.toString ( )

Member Data Documentation

◆ format

final int com.jogamp.opengl.FBObject.Attachment.format

immutable the internal format

Definition at line 187 of file FBObject.java.

◆ type

final Type com.jogamp.opengl.FBObject.Attachment.type

immutable type [COLOR, DEPTH, STENCIL, COLOR_TEXTURE, DEPTH_TEXTURE, STENCIL_TEXTURE ]

Definition at line 184 of file FBObject.java.


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