JOGL v2.6.0-rc-20250712
JOGL, High-Performance Graphics Binding for Java™ (public API).
com.jogamp.opengl.util.texture.spi.TextureProvider Interface Reference

Plug-in interface to TextureIO to support reading OpenGL textures from new file formats. More...

Inheritance diagram for com.jogamp.opengl.util.texture.spi.TextureProvider:
Collaboration diagram for com.jogamp.opengl.util.texture.spi.TextureProvider:

Classes

interface  SupportsImageTypes
 Optional additional interface for TextureProvider implementation exposing the supported ImageTypes. More...
 

Public Member Functions

ImageType[] getImageTypes ()
 Returns the known supported ImageTypes, or null if unknown. More...
 
TextureData newTextureData (GLProfile glp, InputStream stream, int internalFormat, int pixelFormat, boolean mipmap, String fileSuffix) throws IOException
 Produces a TextureData object from a stream, or returns null if the file format was not supported by this TextureProvider. More...
 

Detailed Description

Plug-in interface to TextureIO to support reading OpenGL textures from new file formats.

For all methods, either internalFormat or pixelFormat may be 0 in which case they must be inferred as e.g. RGB or RGBA depending on the file contents.

Definition at line 57 of file TextureProvider.java.

Member Function Documentation

◆ getImageTypes()

ImageType[] com.jogamp.opengl.util.texture.spi.TextureProvider.getImageTypes ( )

Returns the known supported ImageTypes, or null if unknown.

Use case: Mapping of ImageTypes to TextureProvider.

Implemented in com.jogamp.opengl.util.texture.spi.awt.IIOTextureProvider.

Here is the caller graph for this function:

◆ newTextureData()

TextureData com.jogamp.opengl.util.texture.spi.TextureProvider.newTextureData ( GLProfile  glp,
InputStream  stream,
int  internalFormat,
int  pixelFormat,
boolean  mipmap,
String  fileSuffix 
) throws IOException

Produces a TextureData object from a stream, or returns null if the file format was not supported by this TextureProvider.

Does not do any OpenGL-related work. The resulting TextureData can be converted into an OpenGL texture in a later step.

Parameters
glpthe OpenGL Profile this texture data should be created for.
streamthe stream from which to read the texture data
internalFormatthe OpenGL internal format to be used for the texture, or 0 if it should be inferred from the file's contents
pixelFormatthe OpenGL pixel format to be used for the texture, or 0 if it should be inferred from the file's contents
mipmapwhether mipmaps should be produced for this texture either by autogenerating them or reading them from the file. Some file formats support multiple mipmaps in a single file in which case those mipmaps will be used rather than generating them.
fileSuffixthe file suffix to be used as a hint to the provider to more quickly decide whether it can handle the file, or null if the provider should infer the type from the file's contents
Exceptions
IOExceptionif an error occurred while reading the stream

Implemented in com.jogamp.opengl.util.texture.spi.awt.IIOTextureProvider.

Here is the caller graph for this function:

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