com.badlogic.gdx.graphics

Class GLTexture

java.lang.Object

com.badlogic.gdx.graphics.GLTexture

All Implemented Interfaces:

Disposable

Direct Known Subclasses:

Cubemap, Texture, TextureArray

public abstract class GLTexture
extends Object
implements Disposable

Class representing an OpenGL texture by its target and handle. Keeps track of its state like the TextureFilter and TextureWrap. Also provides some (protected) static methods to create TextureData and upload image data.

Author:

badlogic, Xoppa

Field Summary

Fields

Modifier and Type	Field and Description
int	glTarget The target of this texture, used when binding the texture, e.g.

Constructor Summary

Constructors

Constructor and Description
GLTexture(int glTarget) Generates a new OpenGL texture with the specified target.
GLTexture(int glTarget, int glHandle)

Method Summary

Modifier and Type	Method and Description
void	bind() Binds this texture.
void	bind(int unit) Binds the texture to the given texture unit.
void	dispose() Releases all resources of this object.
float	getAnisotropicFilter()
abstract int	getDepth()
abstract int	getHeight()
Texture.TextureFilter	getMagFilter()
static float	getMaxAnisotropicFilterLevel()
Texture.TextureFilter	getMinFilter()
int	getTextureObjectHandle()
Texture.TextureWrap	getUWrap()
Texture.TextureWrap	getVWrap()
abstract int	getWidth()
abstract boolean	isManaged()
float	setAnisotropicFilter(float level) Sets the anisotropic filter level for the texture.
void	setFilter(Texture.TextureFilter minFilter, Texture.TextureFilter magFilter) Sets the Texture.TextureFilter for this texture for minification and magnification.
void	setWrap(Texture.TextureWrap u, Texture.TextureWrap v) Sets the Texture.TextureWrap for this texture on the u and v axis.
float	unsafeSetAnisotropicFilter(float level) Sets the anisotropic filter level for the texture.
float	unsafeSetAnisotropicFilter(float level, boolean force) Sets the anisotropic filter level for the texture.
void	unsafeSetFilter(Texture.TextureFilter minFilter, Texture.TextureFilter magFilter) Sets the Texture.TextureFilter for this texture for minification and magnification.
void	unsafeSetFilter(Texture.TextureFilter minFilter, Texture.TextureFilter magFilter, boolean force) Sets the Texture.TextureFilter for this texture for minification and magnification.
void	unsafeSetWrap(Texture.TextureWrap u, Texture.TextureWrap v) Sets the Texture.TextureWrap for this texture on the u and v axis.
void	unsafeSetWrap(Texture.TextureWrap u, Texture.TextureWrap v, boolean force) Sets the Texture.TextureWrap for this texture on the u and v axis.
static void	uploadImageData(int target, TextureData data, int miplevel)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

glTarget

public final int glTarget

The target of this texture, used when binding the texture, e.g. GL_TEXTURE_2D

Constructor Detail

GLTexture

public GLTexture(int glTarget)

Generates a new OpenGL texture with the specified target.

GLTexture

public GLTexture(int glTarget,
                 int glHandle)

Method Detail

getWidth

public abstract int getWidth()

Returns:

the width of the texture in pixels

getHeight

public abstract int getHeight()

Returns:

the height of the texture in pixels

getDepth

public abstract int getDepth()

Returns:

the depth of the texture in pixels

isManaged

public abstract boolean isManaged()

Returns:

whether this texture is managed or not.

bind

public void bind()

Binds this texture. The texture will be bound to the currently active texture unit specified via GL20.glActiveTexture(int).

bind

public void bind(int unit)

Binds the texture to the given texture unit. Sets the currently active texture unit via GL20.glActiveTexture(int).

Parameters:

unit - the unit (0 to MAX_TEXTURE_UNITS).

getMinFilter

public Texture.TextureFilter getMinFilter()

Returns:

The Texture.TextureFilter used for minification.

getMagFilter

public Texture.TextureFilter getMagFilter()

Returns:

The Texture.TextureFilter used for magnification.

getUWrap

public Texture.TextureWrap getUWrap()

Returns:

The Texture.TextureWrap used for horizontal (U) texture coordinates.

getVWrap

public Texture.TextureWrap getVWrap()

Returns:

The Texture.TextureWrap used for vertical (V) texture coordinates.

getTextureObjectHandle

public int getTextureObjectHandle()

Returns:

The OpenGL handle for this texture.

unsafeSetWrap

public void unsafeSetWrap(Texture.TextureWrap u,
                          Texture.TextureWrap v)

Sets the Texture.TextureWrap for this texture on the u and v axis. Assumes the texture is bound and active!

Parameters:

u - the u wrap

v - the v wrap

unsafeSetWrap

public void unsafeSetWrap(Texture.TextureWrap u,
                          Texture.TextureWrap v,
                          boolean force)

Sets the Texture.TextureWrap for this texture on the u and v axis. Assumes the texture is bound and active!

Parameters:

u - the u wrap

v - the v wrap

force - True to always set the values, even if they are the same as the current values.

setWrap

public void setWrap(Texture.TextureWrap u,
                    Texture.TextureWrap v)

Sets the Texture.TextureWrap for this texture on the u and v axis. This will bind this texture!

Parameters:

u - the u wrap

v - the v wrap

unsafeSetFilter

public void unsafeSetFilter(Texture.TextureFilter minFilter,
                            Texture.TextureFilter magFilter)

Sets the Texture.TextureFilter for this texture for minification and magnification. Assumes the texture is bound and active!

Parameters:

minFilter - the minification filter

magFilter - the magnification filter

unsafeSetFilter

public void unsafeSetFilter(Texture.TextureFilter minFilter,
                            Texture.TextureFilter magFilter,
                            boolean force)

Sets the Texture.TextureFilter for this texture for minification and magnification. Assumes the texture is bound and active!

Parameters:

minFilter - the minification filter

magFilter - the magnification filter

force - True to always set the values, even if they are the same as the current values.

setFilter

public void setFilter(Texture.TextureFilter minFilter,
                      Texture.TextureFilter magFilter)

Sets the Texture.TextureFilter for this texture for minification and magnification. This will bind this texture!

Parameters:

minFilter - the minification filter

magFilter - the magnification filter

unsafeSetAnisotropicFilter

public float unsafeSetAnisotropicFilter(float level)

Sets the anisotropic filter level for the texture. Assumes the texture is bound and active!

Parameters:

level - The desired level of filtering. The maximum level supported by the device up to this value will be used.

Returns:

The actual level set, which may be lower than the provided value due to device limitations.

unsafeSetAnisotropicFilter

public float unsafeSetAnisotropicFilter(float level,
                                        boolean force)

Sets the anisotropic filter level for the texture. Assumes the texture is bound and active!

Parameters:

level - The desired level of filtering. The maximum level supported by the device up to this value will be used.

force - True to always set the value, even if it is the same as the current values.

Returns:

The actual level set, which may be lower than the provided value due to device limitations.

setAnisotropicFilter

public float setAnisotropicFilter(float level)

Sets the anisotropic filter level for the texture. This will bind the texture!

Parameters:

level - The desired level of filtering. The maximum level supported by the device up to this value will be used.

Returns:

The actual level set, which may be lower than the provided value due to device limitations.

getAnisotropicFilter

public float getAnisotropicFilter()

Returns:

The currently set anisotropic filtering level for the texture, or 1.0f if none has been set.

getMaxAnisotropicFilterLevel

public static float getMaxAnisotropicFilterLevel()

Returns:

The maximum supported anisotropic filtering level supported by the device.

dispose

public void dispose()

Description copied from interface: Disposable

Releases all resources of this object.

Specified by:

dispose in interface Disposable

uploadImageData

public static void uploadImageData(int target,
                                   TextureData data,
                                   int miplevel)