com.badlogic.gdx.assets.loaders

Class ShaderProgramLoader

java.lang.Object

com.badlogic.gdx.assets.loaders.AssetLoader<T,P>

com.badlogic.gdx.assets.loaders.AsynchronousAssetLoader<ShaderProgram,ShaderProgramLoader.ShaderProgramParameter>

com.badlogic.gdx.assets.loaders.ShaderProgramLoader

public class ShaderProgramLoader
extends AsynchronousAssetLoader<ShaderProgram,ShaderProgramLoader.ShaderProgramParameter>

AssetLoader for ShaderProgram instances loaded from text files. If the file suffix is ".vert", it is assumed to be a vertex shader, and a fragment shader is found using the same file name with a ".frag" suffix. And vice versa if the file suffix is ".frag". These default suffixes can be changed in the ShaderProgramLoader constructor.

For all other file suffixes, the same file is used for both (and therefore should internally distinguish between the programs using preprocessor directives and ShaderProgram.prependVertexCode and ShaderProgram.prependFragmentCode).

The above default behavior for finding the files can be overridden by explicitly setting the file names in a ShaderProgramLoader.ShaderProgramParameter. The parameter can also be used to prepend code to the programs.

Author:

cypherdare

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ShaderProgramLoader.ShaderProgramParameter

Constructor Summary

Constructors

Constructor and Description
ShaderProgramLoader(FileHandleResolver resolver)
ShaderProgramLoader(FileHandleResolver resolver, String vertexFileSuffix, String fragmentFileSuffix)

Method Summary

Modifier and Type	Method and Description
Array<AssetDescriptor>	getDependencies(String fileName, FileHandle file, ShaderProgramLoader.ShaderProgramParameter parameter) Returns the assets this asset requires to be loaded first.
void	loadAsync(AssetManager manager, String fileName, FileHandle file, ShaderProgramLoader.ShaderProgramParameter parameter) Loads the non-OpenGL part of the asset and injects any dependencies of the asset into the AssetManager.
ShaderProgram	loadSync(AssetManager manager, String fileName, FileHandle file, ShaderProgramLoader.ShaderProgramParameter parameter) Loads the OpenGL part of the asset.

Methods inherited from class com.badlogic.gdx.assets.loaders.AsynchronousAssetLoader

unloadAsync

Methods inherited from class com.badlogic.gdx.assets.loaders.AssetLoader

resolve

Methods inherited from class java.lang.Object

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

Constructor Detail

ShaderProgramLoader

public ShaderProgramLoader(FileHandleResolver resolver)

ShaderProgramLoader

public ShaderProgramLoader(FileHandleResolver resolver,
                           String vertexFileSuffix,
                           String fragmentFileSuffix)

Method Detail

getDependencies

public Array<AssetDescriptor> getDependencies(String fileName,
                                              FileHandle file,
                                              ShaderProgramLoader.ShaderProgramParameter parameter)

Description copied from class: AssetLoader

Returns the assets this asset requires to be loaded first. This method may be called on a thread other than the GL thread.

Specified by:

getDependencies in class AssetLoader<ShaderProgram,ShaderProgramLoader.ShaderProgramParameter>

Parameters:

fileName - name of the asset to load

file - the resolved file to load

parameter - parameters for loading the asset

Returns:

other assets that the asset depends on and need to be loaded first or null if there are no dependencies.

loadAsync

public void loadAsync(AssetManager manager,
                      String fileName,
                      FileHandle file,
                      ShaderProgramLoader.ShaderProgramParameter parameter)

Description copied from class: AsynchronousAssetLoader

Loads the non-OpenGL part of the asset and injects any dependencies of the asset into the AssetManager.

Specified by:

loadAsync in class AsynchronousAssetLoader<ShaderProgram,ShaderProgramLoader.ShaderProgramParameter>

fileName - the name of the asset to load

file - the resolved file to load

parameter - the parameters to use for loading the asset

loadSync

public ShaderProgram loadSync(AssetManager manager,
                              String fileName,
                              FileHandle file,
                              ShaderProgramLoader.ShaderProgramParameter parameter)

Description copied from class: AsynchronousAssetLoader

Loads the OpenGL part of the asset.

Specified by:

loadSync in class AsynchronousAssetLoader<ShaderProgram,ShaderProgramLoader.ShaderProgramParameter>

file - the resolved file to load