JOGL v2.6.0-rc-20250712
JOGL, High-Performance Graphics Binding for Java™ (public API).
com.jogamp.opengl.util.texture.awt.AWTTextureData Class Reference
Inheritance diagram for com.jogamp.opengl.util.texture.awt.AWTTextureData:
Collaboration diagram for com.jogamp.opengl.util.texture.awt.AWTTextureData:

Public Member Functions

 AWTTextureData (final GLProfile glp, final int internalFormat, final int pixelFormat, final boolean mipmap, final BufferedImage image)
 Constructs a new TextureData object with the specified parameters and data contained in the given BufferedImage. More...
 
GLPixelAttributes getPixelAttributes ()
 Returns the intended OpenGL GLPixelAttributes of the texture data, i.e. More...
 
int getPixelFormat ()
 Returns the intended OpenGL pixel format of the texture data using getPixelAttributes(). More...
 
int getPixelType ()
 Returns the intended OpenGL pixel type of the texture data using getPixelAttributes(). More...
 
Buffer getBuffer ()
 Returns the texture data, or null if it is specified as a set of mipmaps. More...
 
- Public Member Functions inherited from com.jogamp.opengl.util.texture.TextureData
 TextureData (final GLProfile glp, final int internalFormat, final int width, final int height, final int border, final int pixelFormat, final int pixelType, final boolean mipmap, final boolean dataIsCompressed, final boolean mustFlipVertically, final Buffer buffer, final Flusher flusher) throws IllegalArgumentException
 Constructs a new TextureData object with the specified parameters and data contained in the given Buffer. More...
 
 TextureData (final GLProfile glp, final int internalFormat, final int width, final int height, final int border, final GLPixelAttributes pixelAttributes, final boolean mipmap, final boolean dataIsCompressed, final boolean mustFlipVertically, final Buffer buffer, final Flusher flusher) throws IllegalArgumentException
 Constructs a new TextureData object with the specified parameters and data contained in the given Buffer. More...
 
 TextureData (final GLProfile glp, final int internalFormat, final int width, final int height, final int border, final int pixelFormat, final int pixelType, final boolean dataIsCompressed, final boolean mustFlipVertically, final Buffer[] mipmapData, final Flusher flusher) throws IllegalArgumentException
 Constructs a new TextureData object with the specified parameters and data for multiple mipmap levels contained in the given array of Buffers. More...
 
 TextureData (final GLProfile glp, final int internalFormat, final int width, final int height, final int border, final GLPixelAttributes pixelAttributes, final boolean dataIsCompressed, final boolean mustFlipVertically, final Buffer[] mipmapData, final Flusher flusher) throws IllegalArgumentException
 Constructs a new TextureData object with the specified parameters and data for multiple mipmap levels contained in the given array of Buffers. More...
 
ColorSpace getColorSpace ()
 Returns the color space of the pixel data. More...
 
void setColorSpace (final ColorSpace cs)
 Set the color space of the pixel data, which defaults to ColorSpace#RGB. More...
 
final ImageType getSourceImageType ()
 Returns the source ImageType if applicable and known, otherwise null. More...
 
int getWidth ()
 Returns the width in pixels of the texture data. More...
 
int getHeight ()
 Returns the height in pixels of the texture data. More...
 
int getBorder ()
 Returns the border in pixels of the texture data. More...
 
GLPixelAttributes getPixelAttributes ()
 Returns the intended OpenGL GLPixelAttributes of the texture data, i.e. More...
 
int getPixelFormat ()
 Returns the intended OpenGL pixel format of the texture data using getPixelAttributes(). More...
 
int getPixelType ()
 Returns the intended OpenGL pixel type of the texture data using getPixelAttributes(). More...
 
int getInternalFormat ()
 Returns the intended OpenGL internal format of the texture data. More...
 
boolean getMipmap ()
 Returns whether mipmaps should be generated for the texture data. More...
 
boolean isDataCompressed ()
 Indicates whether the texture data is in compressed form. More...
 
boolean getMustFlipVertically ()
 Indicates whether the texture coordinates must be flipped vertically for proper display. More...
 
Buffer getBuffer ()
 Returns the texture data, or null if it is specified as a set of mipmaps. More...
 
Buffer[] getMipmapData ()
 Returns all mipmap levels for the texture data, or null if it is specified as a single image. More...
 
int getAlignment ()
 Returns the required byte alignment for the texture data. More...
 
int getRowLength ()
 Returns the row length needed for correct GL_UNPACK_ROW_LENGTH specification. More...
 
void setWidth (final int width)
 Sets the width in pixels of the texture data. More...
 
void setHeight (final int height)
 Sets the height in pixels of the texture data. More...
 
void setBorder (final int border)
 Sets the border in pixels of the texture data. More...
 
void setPixelAttributes (final GLPixelAttributes pixelAttributes)
 Sets the intended OpenGL pixel format of the texture data. More...
 
void setPixelFormat (final int pixelFormat)
 Sets the intended OpenGL pixel format component of GLPixelAttributes of the texture data. More...
 
void setPixelType (final int pixelType)
 Sets the intended OpenGL pixel type component of GLPixelAttributes of the texture data. More...
 
void setInternalFormat (final int internalFormat)
 Sets the intended OpenGL internal format of the texture data. More...
 
void setMipmap (final boolean mipmap)
 Sets whether mipmaps should be generated for the texture data. More...
 
void setIsDataCompressed (final boolean compressed)
 Sets whether the texture data is in compressed form. More...
 
void setMustFlipVertically (final boolean mustFlipVertically)
 Sets whether the texture coordinates must be flipped vertically for proper display. More...
 
void setBuffer (final Buffer buffer)
 Sets the texture data. More...
 
void setAlignment (final int alignment)
 Sets the required byte alignment for the texture data. More...
 
void setRowLength (final int rowLength)
 Sets the row length needed for correct GL_UNPACK_ROW_LENGTH specification. More...
 
void setHaveEXTABGR (final boolean haveEXTABGR)
 Indicates to this TextureData whether the GL_EXT_abgr extension is available. More...
 
void setHaveGL12 (final boolean haveGL12)
 Indicates to this TextureData whether OpenGL version 1.2 is available. More...
 
GLProfile getGLProfile ()
 Returns the GLProfile this texture data is intended and created for. More...
 
int getEstimatedMemorySize ()
 Returns an estimate of the amount of memory in bytes this TextureData will consume once uploaded to the graphics card. More...
 
void flush ()
 Flushes resources associated with this TextureData by calling Flusher.flush(). More...
 
void destroy ()
 Calls flush() More...
 
String toString ()
 

Additional Inherited Members

- Protected Member Functions inherited from com.jogamp.opengl.util.texture.TextureData
 TextureData (final GLProfile glp)
 Used only by subclasses. More...
 
- Static Protected Member Functions inherited from com.jogamp.opengl.util.texture.TextureData
static int estimatedMemorySize (final Buffer buffer)
 
- Protected Attributes inherited from com.jogamp.opengl.util.texture.TextureData
int width
 
int height
 
GLPixelAttributes pixelAttributes
 
int internalFormat
 
boolean mipmap
 
boolean mustFlipVertically
 
Buffer buffer
 
int rowLength
 
int alignment
 
int estimatedMemorySize
 
boolean haveEXTABGR
 
boolean haveGL12
 
GLProfile glProfile
 
ColorSpace pixelCS = ColorSpace.RGB
 

Detailed Description

Definition at line 72 of file AWTTextureData.java.

Constructor & Destructor Documentation

◆ AWTTextureData()

com.jogamp.opengl.util.texture.awt.AWTTextureData.AWTTextureData ( final GLProfile  glp,
final int  internalFormat,
final int  pixelFormat,
final boolean  mipmap,
final BufferedImage  image 
)

Constructs a new TextureData object with the specified parameters and data contained in the given BufferedImage.

The resulting TextureData "wraps" the contents of the BufferedImage, so if a modification is made to the BufferedImage between the time the TextureData is constructed and when a Texture is made from the TextureData, that modification will be visible in the resulting Texture.

Parameters
glpthe OpenGL Profile this texture data should be created for.
internalFormatthe OpenGL internal format for the resulting texture; may be 0, in which case it is inferred from the image's type
pixelFormatthe OpenGL internal format for the resulting texture; may be 0, in which case it is inferred from the image's type (note: this argument is currently always ignored)
mipmapindicates whether mipmaps should be autogenerated (using GLU) for the resulting texture
imagethe image containing the texture data

Definition at line 116 of file AWTTextureData.java.

Member Function Documentation

◆ getBuffer()

Buffer com.jogamp.opengl.util.texture.awt.AWTTextureData.getBuffer ( )

Returns the texture data, or null if it is specified as a set of mipmaps.

Reimplemented from com.jogamp.opengl.util.texture.TextureData.

Definition at line 166 of file AWTTextureData.java.

◆ getPixelAttributes()

GLPixelAttributes com.jogamp.opengl.util.texture.awt.AWTTextureData.getPixelAttributes ( )

Returns the intended OpenGL GLPixelAttributes of the texture data, i.e.

format and type.

Reimplemented from com.jogamp.opengl.util.texture.TextureData.

Definition at line 149 of file AWTTextureData.java.

◆ getPixelFormat()

int com.jogamp.opengl.util.texture.awt.AWTTextureData.getPixelFormat ( )

Returns the intended OpenGL pixel format of the texture data using getPixelAttributes().

Reimplemented from com.jogamp.opengl.util.texture.TextureData.

Definition at line 155 of file AWTTextureData.java.

◆ getPixelType()

int com.jogamp.opengl.util.texture.awt.AWTTextureData.getPixelType ( )

Returns the intended OpenGL pixel type of the texture data using getPixelAttributes().

Reimplemented from com.jogamp.opengl.util.texture.TextureData.

Definition at line 160 of file AWTTextureData.java.


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