Used by a Texture to load the pixel data. A TextureData can either return a Pixmap or upload the pixel data itself. It signals it's type via getType() to the Texture that's using it. The Texture will then either invoke consumePixmap() or consumeCustomData(int). These are the first methods to be called by Texture. After that the Texture will invoke the other methods to find out about the size of the image data, the format, whether mipmaps should be generated and whether the TextureData is able to manage the pixel data if the OpenGL ES context is lost.

In case the TextureData implementation has the type TextureDataType#Custom, the implementation has to generate the mipmaps itself if necessary. See MipMapGenerator.

Before a call to either consumePixmap() or consumeCustomData(int), Texture will bind the OpenGL ES texture.

Look at FileTextureData and ETC1TextureData for example implementations of this interface.

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	TextureData.Factory Provides static method to instantiate the right implementation (Pixmap, ETC1, KTX).
public static enum	TextureData.TextureDataType The type of this `TextureData`.

Method Summary

Modifier and Type	Method and Description
public void	consumeCustomData(int target) Uploads the pixel data to the OpenGL ES texture.
public Pixmap	Returns: the pixmap. consumePixmap() Returns the `Pixmap` for upload by Texture.
public boolean	disposePixmap() Returns: whether the caller of `consumePixmap()` should dispose the Pixmap returned by `consumePixmap()`
public Pixmap.Format	getFormat() Returns: the `Format` of the pixel data
public int	getHeight() Returns: the height of the pixel data
public TextureData.TextureDataType	getType() Returns: the `TextureDataType`
public int	getWidth() Returns: the width of the pixel data
public boolean	isManaged() Returns: whether this implementation can cope with a EGL context loss.
public boolean	isPrepared() Returns: whether the TextureData is prepared or not.
public void	prepare() Prepares the TextureData for a call to `consumePixmap()` or `consumeCustomData(int)`.
public boolean	useMipMaps() Returns: whether to generate mipmaps or not.

Method Detail

consumeCustomData	back to summary
public void consumeCustomData(int target) Uploads the pixel data to the OpenGL ES texture. The caller must bind an OpenGL ES texture. A call to `prepare()` must preceed a call to this method. Any internal data structures created in `prepare()` should be disposed of here.

consumePixmap back to summary

consumePixmap	back to summary
public Pixmap consumePixmap() Returns the `Pixmap` for upload by Texture. A call to `prepare()` must precede a call to this method. Any internal data structures created in `prepare()` should be disposed of here. Returns:Pixmap the pixmap.

public Pixmap consumePixmap()

Returns the Pixmap for upload by Texture. A call to prepare() must precede a call to this method. Any internal data structures created in prepare() should be disposed of here.

Returns:Pixmap: the pixmap.

disposePixmap	back to summary
public boolean disposePixmap() Returns:boolean whether the caller of `consumePixmap()` should dispose the Pixmap returned by `consumePixmap()`

getFormat	back to summary
public Pixmap.Format getFormat() Returns:Pixmap.Format the `Format` of the pixel data

getHeight	back to summary
public int getHeight() Returns:int the height of the pixel data

getType	back to summary
public TextureData.TextureDataType getType() Returns:TextureData.TextureDataType the `TextureDataType`

getWidth	back to summary
public int getWidth() Returns:int the width of the pixel data

isManaged	back to summary
public boolean isManaged() Returns:boolean whether this implementation can cope with a EGL context loss.

isPrepared	back to summary
public boolean isPrepared() Returns:boolean whether the TextureData is prepared or not.

prepare	back to summary
public void prepare() Prepares the TextureData for a call to `consumePixmap()` or `consumeCustomData(int)`. This method can be called from a non OpenGL thread and should thus not interact with OpenGL.

useMipMaps	back to summary
public boolean useMipMaps() Returns:boolean whether to generate mipmaps or not.

com.badlogic.gdx.graphics back to summary

public Class TextureData.Factory

Class Inheritance

extends Object

java.lang.Object
com.badlogic.gdx.graphics.TextureData.Factory

Provides static method to instantiate the right implementation (Pixmap, ETC1, KTX).

Author: Vincent Bousquet

Constructor Summary

Access	Constructor and Description
public	Factory()

Method Summary

Modifier and Type	Method and Description
public static TextureData	loadFromFile(FileHandle file, boolean useMipMaps)
public static TextureData	loadFromFile(FileHandle file, Pixmap.Format format, boolean useMipMaps)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

Factory	back to summary
public Factory()

Method Detail

loadFromFile	back to summary
public static TextureData loadFromFile(FileHandle file, boolean useMipMaps)

loadFromFile	back to summary
public static TextureData loadFromFile(FileHandle file, Pixmap.Format format, boolean useMipMaps)

com.badlogic.gdx.graphics back to summary

public final Enum TextureData.TextureDataType

Class Inheritance

extends Enum<TextureData.TextureDataType>

java.lang.Object
java.lang.Enum
com.badlogic.gdx.graphics.TextureData.TextureDataType

The type of this TextureData.

Author: mzechner

Field Summary

Modifier and Type	Field and Description
public static final TextureData.TextureDataType	Custom
public static final TextureData.TextureDataType	Pixmap

Constructor Summary

Access	Constructor and Description
private	TextureDataType()

Method Summary

Modifier and Type	Method and Description
public static TextureData.TextureDataType	valueOf(String name)
public static TextureData.TextureDataType[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

Custom	back to summary
public static final TextureData.TextureDataType Custom

Pixmap	back to summary
public static final TextureData.TextureDataType Pixmap

Constructor Detail

TextureDataType	back to summary
private TextureDataType()

Method Detail

valueOf	back to summary
public static TextureData.TextureDataType valueOf(String name)

values	back to summary
public static TextureData.TextureDataType[] values()

public Interface TextureData

Nested and Inner Type Summary

Method Summary

Method Detail

public Class TextureData.Factory

Constructor Summary

Method Summary

Constructor Detail

Method Detail

public final Enum TextureData.TextureDataType

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail