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

Texture FBO attachment. More...

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

Public Member Functions

 TextureAttachment (final Type type, final int iFormat, final int width, final int height, final int dataFormat, final int dataType, final int magFilter, final int minFilter, final int wrapS, final int wrapT, final int name)
 
boolean initialize (final GL gl) throws GLException
 Initializes the texture and set it's parameter, if uninitialized, i.e. More...
 
void free (final GL gl)
 Releases the color buffer if initialized, i.e. More...
 
final boolean isTextureAttachment ()
 Returns true if instance is of type TextureAttachment and false if instance is of type ColorAttachment. More...
 
final TextureAttachment getTextureAttachment ()
 Casts this object to a TextureAttachment reference, see isTextureAttachment(). More...
 
final ColorAttachment getColorAttachment ()
 Casts this object to a ColorAttachment reference, see isTextureAttachment(). 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 ()
 
- Public Member Functions inherited from com.jogamp.opengl.FBObject.Colorbuffer
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...
 

Public Attributes

final int dataFormat
 details of the texture setup More...
 
final int dataType
 
final int magFilter
 
final int minFilter
 
final int wrapS
 
final int wrapT
 
- 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...
 

Additional Inherited Members

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

Texture FBO attachment.

Definition at line 523 of file FBObject.java.

Constructor & Destructor Documentation

◆ TextureAttachment()

com.jogamp.opengl.FBObject.TextureAttachment.TextureAttachment ( final Type  type,
final int  iFormat,
final int  width,
final int  height,
final int  dataFormat,
final int  dataType,
final int  magFilter,
final int  minFilter,
final int  wrapS,
final int  wrapT,
final int  name 
)
Parameters
typeallowed types are [ Type#COLOR_TEXTURE, Type#DEPTH_TEXTURE, Type#STENCIL_TEXTURE ]
iFormat
width
height
dataFormat
dataType
magFilter
minFilter
wrapS
wrapT
name

Definition at line 540 of file FBObject.java.

Here is the call graph for this function:

Member Function Documentation

◆ free()

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

Releases the color buffer if initialized, i.e.

name is not zero.

Exceptions
GLExceptionif buffer release fails.

Implements com.jogamp.opengl.FBObject.Colorbuffer.

Definition at line 625 of file FBObject.java.

Here is the call graph for this function:

◆ getColorAttachment()

final ColorAttachment com.jogamp.opengl.FBObject.TextureAttachment.getColorAttachment ( )

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

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

Implements com.jogamp.opengl.FBObject.Colorbuffer.

Definition at line 641 of file FBObject.java.

◆ getTextureAttachment()

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

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

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

Implements com.jogamp.opengl.FBObject.Colorbuffer.

Definition at line 639 of file FBObject.java.

◆ initialize()

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

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

name is zero.

Exceptions
GLExceptionif texture generation and setup fails. The just created texture name will be deleted in this case.

Implements com.jogamp.opengl.FBObject.Colorbuffer.

Definition at line 568 of file FBObject.java.

Here is the call graph for this function:

◆ isTextureAttachment()

final boolean com.jogamp.opengl.FBObject.TextureAttachment.isTextureAttachment ( )

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

Implements com.jogamp.opengl.FBObject.Colorbuffer.

Definition at line 637 of file FBObject.java.

◆ toString()

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

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

Definition at line 644 of file FBObject.java.

Here is the call graph for this function:

Member Data Documentation

◆ dataFormat

final int com.jogamp.opengl.FBObject.TextureAttachment.dataFormat

details of the texture setup

Definition at line 525 of file FBObject.java.

◆ dataType

final int com.jogamp.opengl.FBObject.TextureAttachment.dataType

Definition at line 525 of file FBObject.java.

◆ magFilter

final int com.jogamp.opengl.FBObject.TextureAttachment.magFilter

Definition at line 525 of file FBObject.java.

◆ minFilter

final int com.jogamp.opengl.FBObject.TextureAttachment.minFilter

Definition at line 525 of file FBObject.java.

◆ wrapS

final int com.jogamp.opengl.FBObject.TextureAttachment.wrapS

Definition at line 525 of file FBObject.java.

◆ wrapT

final int com.jogamp.opengl.FBObject.TextureAttachment.wrapT

Definition at line 525 of file FBObject.java.


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