com.bonzaiengine.texture

Class TextureList

java.lang.Object

com.bonzaiengine.texture.TextureList

All Implemented Interfaces:

java.lang.Iterable<TextureID>

public class TextureList
extends java.lang.Object
implements java.lang.Iterable<TextureID>

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CUBEMAP_EXT
static java.lang.String[]	CUBEMAP_SUFFIXE
static java.lang.String	DOT3_EXT

Constructor Summary

Constructors

Constructor and Description
TextureList(TextureLoader textureLoader)

Method Summary

Modifier and Type	Method and Description
void	addOnLoadListener(OnLoadListener<Texture> listener) Register an OnLoadListener listener to be notified of texture loading.
void	destroyAll(IGLApi glApi) Unload from gpu and remove from this TextureList all textures
void	destroyUnreferenced(IGLApi glApi) Unload from gpu and remove from this TextureList unreferenced textures
Texture	get(java.lang.String name)
TextureParam	getDefaultTextureParam()
int	getNumLoadedTextures()
TextureLibrary	getTextureLibrary()
TextureLoader	getTextureLoader()
ITexture[]	getTextureSw(Texture texture) Deprecated.
boolean	hasPendingLoading()
boolean	isPendingLoading(Texture texture)
java.util.Iterator<TextureID>	iterator()
int	load(IGLApi glApi) Load textures read in cpu.
void	load(IGLApi glApi, Texture texture)
static java.lang.String[]	mapNameToFileName(java.lang.String name)
void	onContextLost()
boolean	read(Finder finder, Texture texture, TextureParam textureParam) Read texture in cpu, an OpenGL context is not needed.
boolean	read(Finder finder, Texture texture, TextureParam textureParam, boolean reRead)
void	read(Texture texture, ITexture[] textures, TextureParam textureParam)
void	readAndLoad(IGLApi glApi, Finder finder, Texture texture, TextureParam textureParam) Deprecated.
void	removeOnLoadListener(OnLoadListener<Texture> listener)
void	resetFailures()
TextureList	setDefaultTextureParam(TextureParam defaultTextureParam)
TextureList	setTextureLibrary(TextureLibrary textureLibrary)
java.lang.Iterable<Texture>	textureIterable()
void	unload(IGLApi glApi, Texture texture)
void	unload(IGLApi glApi, Texture texture, boolean remove)
void	unloadAll(IGLApi glApi) Unload all textures from gpu
TextureID	unloadExternal(Texture texture)
void	unloadUnreferenced(IGLApi glApi) Unload unreferenced textures from gpu
Texture	use(java.lang.String name) Get the Texture with the specified name and increment its reference counting.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

DOT3_EXT

public static final java.lang.String DOT3_EXT

See Also:

Constant Field Values

CUBEMAP_EXT

public static final java.lang.String CUBEMAP_EXT

See Also:

Constant Field Values

CUBEMAP_SUFFIXE

public static final java.lang.String[] CUBEMAP_SUFFIXE

Constructor Detail

TextureList

public TextureList(TextureLoader textureLoader)

Method Detail

use

public final Texture use(java.lang.String name)

Get the Texture with the specified name and increment its reference counting.
Texture.release() must be called when the texture is not used anymore.

Returns:

exiting or new Texture with the specified name, with reference count incremented

get

public final Texture get(java.lang.String name)

Returns:

exiting or new Texture with the specified name

read

public final boolean read(Finder finder,
                          Texture texture,
                          TextureParam textureParam)

Read texture in cpu, an OpenGL context is not needed.
The texture is transfered on the GPU with #loadTextures(IGL)

Parameters:

finder - finder to search the texture

texture - texture to read

textureParam - optional texture param for loading texture on gpu

Returns:

true if the texture was read

read

public final boolean read(Finder finder,
                          Texture texture,
                          TextureParam textureParam,
                          boolean reRead)

Parameters:

reRead - true if the texture should be re-read if already loaded to gpu (or has failed before)

See Also:

read(Finder, Texture, TextureParam)

read

public final void read(Texture texture,
                       ITexture[] textures,
                       TextureParam textureParam)

hasPendingLoading

public final boolean hasPendingLoading()

Returns:

true if some texture are ready to load

See Also:

#load(IGL)

isPendingLoading

public final boolean isPendingLoading(Texture texture)

Parameters:

texture - a Texture

Returns:

true if loading of the specified Texture to OpenGL is pending

getTextureSw

@Deprecated
public final ITexture[] getTextureSw(Texture texture)

Deprecated.

This function is not usefull for most cases, except for tool working without loading texture to gpu

load

public final int load(IGLApi glApi)

Load textures read in cpu.
An OpenGL context must be current to call this function.

Returns:

number of texture loaded

load

public final void load(IGLApi glApi,
                       Texture texture)

readAndLoad

@Deprecated
public final void readAndLoad(IGLApi glApi,
                                          Finder finder,
                                          Texture texture,
                                          TextureParam textureParam)

Deprecated.

Read and load a texture in gpu.

Parameters:

gl - opengl context

finder -

texture -

textureParam - texture parameters or null

destroyAll

public final void destroyAll(IGLApi glApi)

Unload from gpu and remove from this TextureList all textures

destroyUnreferenced

public final void destroyUnreferenced(IGLApi glApi)

Unload from gpu and remove from this TextureList unreferenced textures

unloadAll

public final void unloadAll(IGLApi glApi)

Unload all textures from gpu

unloadUnreferenced

public final void unloadUnreferenced(IGLApi glApi)

Unload unreferenced textures from gpu

unload

public final void unload(IGLApi glApi,
                         Texture texture)

Parameters:

texture - Texture to unload from this TextureList

unload

public final void unload(IGLApi glApi,
                         Texture texture,
                         boolean remove)

Parameters:

texture - Texture to unload from this TextureList

remove - true to remove/destroy the texture from this TextureList

unloadExternal

public final TextureID unloadExternal(Texture texture)

Returns:

returns the Texture's TextureID which the called must unload from gpu

onContextLost

public final void onContextLost()

iterator

public final java.util.Iterator<TextureID> iterator()

Specified by:

iterator in interface java.lang.Iterable<TextureID>

textureIterable

public final java.lang.Iterable<Texture> textureIterable()

getNumLoadedTextures

public final int getNumLoadedTextures()

resetFailures

public final void resetFailures()

getTextureLoader

public final TextureLoader getTextureLoader()

addOnLoadListener

public final void addOnLoadListener(OnLoadListener<Texture> listener)

Register an OnLoadListener listener to be notified of texture loading.

Parameters:

listener - OnLoadListener listener to register

removeOnLoadListener

public final void removeOnLoadListener(OnLoadListener<Texture> listener)

Parameters:

listener - OnLoadListener listener to remove

getDefaultTextureParam

public final TextureParam getDefaultTextureParam()

setDefaultTextureParam

public final TextureList setDefaultTextureParam(TextureParam defaultTextureParam)

getTextureLibrary

public final TextureLibrary getTextureLibrary()

setTextureLibrary

public final TextureList setTextureLibrary(TextureLibrary textureLibrary)

mapNameToFileName

public static java.lang.String[] mapNameToFileName(java.lang.String name)

Returns:

the list of texture file names corresponding to the map name