JOGL v2.6.0-rc-20250712
JOGL, High-Performance Graphics Binding for Java™ (public API).
com.jogamp.opengl.FBObject.RenderAttachment Class Reference

Other renderbuffer attachment which maybe a colorbuffer, depth or stencil. More...

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

Public Member Functions

 RenderAttachment (final Type type, final int iFormat, final int samples, final int width, final int height, final int name)
 
final int getSamples ()
 number of samples, or zero for no multisampling More...
 
boolean equals (final Object o)
 
int hashCode ()
 
boolean initialize (final GL gl) throws GLException
 Initializes the attachment and set it's parameter, if uninitialized, i.e. More...
 
void free (final GL gl)
 Releases the attachment if initialized, i.e. More...
 
String toString ()
 
- Public Member Functions inherited from com.jogamp.opengl.FBObject.Attachment
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 ()
 

Additional Inherited Members

- Static Public Member Functions inherited from com.jogamp.opengl.FBObject.Attachment
static Type getType (final int attachmentPoint, final int maxColorAttachments)
 
- Public Attributes inherited from com.jogamp.opengl.FBObject.Attachment
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 inherited from com.jogamp.opengl.FBObject.Attachment
 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

Other renderbuffer attachment which maybe a colorbuffer, depth or stencil.

Definition at line 390 of file FBObject.java.

Constructor & Destructor Documentation

◆ RenderAttachment()

com.jogamp.opengl.FBObject.RenderAttachment.RenderAttachment ( final Type  type,
final int  iFormat,
final int  samples,
final int  width,
final int  height,
final int  name 
)
Parameters
typeallowed types are Type#DEPTH_STENCIL Type#DEPTH, Type#STENCIL or Type#COLOR
iFormat
samples
width
height
name

Definition at line 401 of file FBObject.java.

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

Member Function Documentation

◆ equals()

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

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

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

Reimplemented from com.jogamp.opengl.FBObject.Attachment.

Definition at line 430 of file FBObject.java.

Here is the call graph for this function:

◆ free()

void com.jogamp.opengl.FBObject.RenderAttachment.free ( final GL  gl)

Releases the attachment if initialized, i.e.

name is not zero.

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

Reimplemented from com.jogamp.opengl.FBObject.Attachment.

Definition at line 491 of file FBObject.java.

Here is the call graph for this function:

◆ getSamples()

final int com.jogamp.opengl.FBObject.RenderAttachment.getSamples ( )

number of samples, or zero for no multisampling

Definition at line 408 of file FBObject.java.

◆ hashCode()

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

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

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

Reimplemented from com.jogamp.opengl.FBObject.Attachment.

Definition at line 444 of file FBObject.java.

◆ initialize()

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

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

Definition at line 452 of file FBObject.java.

Here is the call graph for this function:

◆ toString()

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

Reimplemented from com.jogamp.opengl.FBObject.Attachment.

Definition at line 503 of file FBObject.java.

Here is the call graph for this function:

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