com.badlogic.gdx.assets

Class AssetManager

java.lang.Object

com.badlogic.gdx.assets.AssetManager

All Implemented Interfaces:

Disposable

public class AssetManager
extends Object
implements Disposable

Loads and stores assets like textures, bitmapfonts, tile maps, sounds, music and so on.

Author:

mzechner

Constructor Summary

Constructors

Constructor and Description
AssetManager() Creates a new AssetManager with all default loaders.
AssetManager(FileHandleResolver resolver) Creates a new AssetManager with all default loaders.

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Clears and disposes all assets and the preloading queue.
<T> boolean	containsAsset(T asset)
void	dispose() Disposes all assets in the manager and stops all asynchronous loading.
void	finishLoading() blocks until all assets are loaded.
<T> T	get(AssetDescriptor<T> assetDescriptor)
<T> T	get(String fileName)
<T> T	get(String fileName, Class<T> type)
<T> Array<T>	getAll(Class<T> type, Array<T> out)
<T> String	getAssetFileName(T asset)
Array<String>	getAssetNames()
Class	getAssetType(String fileName)
Array<String>	getDependencies(String fileName)
String	getDiagnostics()
int	getLoadedAssets()
<T> AssetLoader	getLoader(Class<T> type) Returns the default loader for the given type
<T> AssetLoader	getLoader(Class<T> type, String fileName) Returns the loader for the given type and the specified filename.
Logger	getLogger()
float	getProgress()
int	getQueuedAssets()
int	getReferenceCount(String fileName) Returns the reference count of an asset.
boolean	isLoaded(String fileName)
boolean	isLoaded(String fileName, Class type)
void	load(AssetDescriptor desc) Adds the given asset to the loading queue of the AssetManager.
<T> void	load(String fileName, Class<T> type) Adds the given asset to the loading queue of the AssetManager.
<T> void	load(String fileName, Class<T> type, AssetLoaderParameters<T> parameter) Adds the given asset to the loading queue of the AssetManager.
void	setErrorListener(AssetErrorListener listener) Sets an AssetErrorListener to be invoked in case loading an asset failed.
<T,P extends AssetLoaderParameters<T>> void	setLoader(Class<T> type, AssetLoader<T,P> loader) Sets a new AssetLoader for the given type.
<T,P extends AssetLoaderParameters<T>> void	setLoader(Class<T> type, String suffix, AssetLoader<T,P> loader) Sets a new AssetLoader for the given type.
void	setLogger(Logger logger)
void	setReferenceCount(String fileName, int refCount) Sets the reference count of an asset.
void	unload(String fileName) Removes the asset and all its dependencies, if they are not used by other assets.
boolean	update() Updates the AssetManager, keeping it loading any assets in the preload queue.
boolean	update(int millis) Updates the AssetManager continuously for the specified number of milliseconds, yielding the CPU to the loading thread between updates.

Methods inherited from class java.lang.Object

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

Constructor Detail

AssetManager

public AssetManager()

Creates a new AssetManager with all default loaders.

AssetManager

public AssetManager(FileHandleResolver resolver)

Creates a new AssetManager with all default loaders.

Method Detail

get

public <T> T get(String fileName)

Parameters:

fileName - the asset file name

Returns:

the asset

get

public <T> T get(String fileName,
        Class<T> type)

Parameters:

fileName - the asset file name

type - the asset type

Returns:

the asset

getAll

public <T> Array<T> getAll(Class<T> type,
                  Array<T> out)

Parameters:

type - the asset type

Returns:

all the assets matching the specified type

get

public <T> T get(AssetDescriptor<T> assetDescriptor)

Parameters:

assetDescriptor - the asset descriptor

Returns:

the asset

unload

public void unload(String fileName)

Removes the asset and all its dependencies, if they are not used by other assets.

Parameters:

fileName - the file name

containsAsset

public <T> boolean containsAsset(T asset)

Parameters:

asset - the asset

Returns:

whether the asset is contained in this manager

getAssetFileName

public <T> String getAssetFileName(T asset)

Parameters:

asset - the asset

Returns:

the filename of the asset or null

isLoaded

public boolean isLoaded(String fileName)

Parameters:

fileName - the file name of the asset

Returns:

whether the asset is loaded

isLoaded

public boolean isLoaded(String fileName,
               Class type)

Parameters:

fileName - the file name of the asset

Returns:

whether the asset is loaded

getLoader

public <T> AssetLoader getLoader(Class<T> type)

Returns the default loader for the given type

Parameters:

type - The type of the loader to get

Returns:

The loader capable of loading the type, or null if none exists

getLoader

public <T> AssetLoader getLoader(Class<T> type,
                        String fileName)

Returns the loader for the given type and the specified filename. If no loader exists for the specific filename, the default loader for that type is returned.

Parameters:

type - The type of the loader to get

fileName - The filename of the asset to get a loader for, or null to get the default loader

Returns:

The loader capable of loading the type and filename, or null if none exists

load

public <T> void load(String fileName,
            Class<T> type)

Adds the given asset to the loading queue of the AssetManager.

Parameters:

fileName - the file name (interpretation depends on AssetLoader)

type - the type of the asset.

load

public <T> void load(String fileName,
            Class<T> type,
            AssetLoaderParameters<T> parameter)

Adds the given asset to the loading queue of the AssetManager.

Parameters:

fileName - the file name (interpretation depends on AssetLoader)

type - the type of the asset.

parameter - parameters for the AssetLoader.

load

public void load(AssetDescriptor desc)

Adds the given asset to the loading queue of the AssetManager.

Parameters:

desc - the AssetDescriptor

update

public boolean update()

Updates the AssetManager, keeping it loading any assets in the preload queue.

Returns:

true if all loading is finished.

update

public boolean update(int millis)

Updates the AssetManager continuously for the specified number of milliseconds, yielding the CPU to the loading thread between updates. This may block for less time if all loading tasks are complete. This may block for more time if the portion of a single task that happens in the GL thread takes a long time.

Returns:

true if all loading is finished.

finishLoading

public void finishLoading()

blocks until all assets are loaded.

setLoader

public <T,P extends AssetLoaderParameters<T>> void setLoader(Class<T> type,
                                                    AssetLoader<T,P> loader)

Sets a new AssetLoader for the given type.

Parameters:

type - the type of the asset

loader - the loader

setLoader

public <T,P extends AssetLoaderParameters<T>> void setLoader(Class<T> type,
                                                    String suffix,
                                                    AssetLoader<T,P> loader)

Sets a new AssetLoader for the given type.

Parameters:

type - the type of the asset

suffix - the suffix the filename must have for this loader to be used or null to specify the default loader.

loader - the loader

getLoadedAssets

public int getLoadedAssets()

Returns:

the number of loaded assets

getQueuedAssets

public int getQueuedAssets()

Returns:

the number of currently queued assets

getProgress

public float getProgress()

Returns:

the progress in percent of completion.

setErrorListener

public void setErrorListener(AssetErrorListener listener)

Sets an AssetErrorListener to be invoked in case loading an asset failed.

Parameters:

listener - the listener or null

dispose

public void dispose()

Disposes all assets in the manager and stops all asynchronous loading.

Specified by:

dispose in interface Disposable

clear

public void clear()

Clears and disposes all assets and the preloading queue.

getLogger

public Logger getLogger()

Returns:

the Logger used by the AssetManager

setLogger

public void setLogger(Logger logger)

getReferenceCount

public int getReferenceCount(String fileName)

Returns the reference count of an asset.

Parameters:

fileName -

setReferenceCount

public void setReferenceCount(String fileName,
                     int refCount)

Sets the reference count of an asset.

Parameters:

fileName -

getDiagnostics

public String getDiagnostics()

Returns:

a string containing ref count and dependency information for all assets.

getAssetNames

public Array<String> getAssetNames()

Returns:

the file names of all loaded assets.

getDependencies

public Array<String> getDependencies(String fileName)

Returns:

the dependencies of an asset or null if the asset has no dependencies.

getAssetType

public Class getAssetType(String fileName)

Returns:

the type of a loaded asset.