com.bonzaiengine.shader

Class ShaderList

java.lang.Object

com.bonzaiengine.shader.ShaderList

All Implemented Interfaces:

java.lang.Iterable<Shader>

public final class ShaderList
extends java.lang.Object
implements java.lang.Iterable<Shader>

Manager of Shader, using reference count.

Usage:

 // Creation
 ShaderList shaders = new ShaderList();
 shaders.setDeleteCodeOnLoadSuccess(); // Default: true
 
 // Asset management
 shaders.use(shader); // Increment referenced count
 shader.release(); // Decrement referenced count
 
 // Update loop
 if(shaders.hasUnreferencedShaders()) {
        shaders.destroyUnreferencedShaders();
 }
 if(shaders.hasPendingLoading()) {
        shaders.loadShaders();
 }
 

Constructor Summary

Constructors

Constructor and Description
ShaderList()

Method Summary

Modifier and Type	Method and Description
int	destroyAll(IGL gl) Deprecated.
int	destroyUnreferenced(IGL gl) Destroy (remove/unload) unreferenced shaders of this ShaderList.
Shader	get(java.lang.String name)
boolean	hasPendingLoading()
boolean	hasUnreferencedShaders()
boolean	isDeleteCodeOnLoadSuccess()
java.util.Iterator<Shader>	iterator()
int	load(IGL gl) Load all shaders from the list.
int	load(IGL gl, int maxNumToLoad) Load all shader from this ShaderList.
boolean	load(IGL gl, Shader shader)
void	onContextLost() Destroy this ShaderList after the OpenGL context has been lost.
void	resetFailures() Reset tracker of Shader which have failed to be loaded
void	setDeleteCodeOnLoadSuccess(boolean deleteCodeOnLoadSuccess)
int	size()
Shader	use(Shader shader) An associated AbstractShader.release() call must match the use(Shader) call to maintain valid reference count.
Shader	use(java.lang.String name)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

ShaderList

public ShaderList()

Method Detail

use

public final Shader use(Shader shader)

An associated AbstractShader.release() call must match the use(Shader) call to maintain valid reference count.

Parameters:

shader - Shader to use, ie increment reference count

Returns:

the specified Shader

See Also:

AbstractShader.release()

use

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

See Also:

get(String), use(Shader)

get

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

Parameters:

name - a Shader name

Returns:

the Shader in this ShaderList with the specified name

hasPendingLoading

public final boolean hasPendingLoading()

Returns:

true if this ShaderList contains Shader not yet loaded.

See Also:

load(IGL)

load

public final int load(IGL gl)

Load all shaders from the list.
Equivalent to: loadShaders(gl, -1)

Returns:

number of shader newly loaded.

See Also:

#load(IGLApi, int)

load

public final int load(IGL gl,
                      int maxNumToLoad)

Load all shader from this ShaderList.

Parameters:

maxNumToLoad - maximum number of shader to load.
Shader loading is something slow and could take load of frames.
This parameter is here to help maintaining a smooth frame rate.
Use -1 for unlimited shader loading.

Returns:

number of shader newly loaded.

See Also:

load(IGL)

load

public final boolean load(IGL gl,
                          Shader shader)

resetFailures

public final void resetFailures()

Reset tracker of Shader which have failed to be loaded

hasUnreferencedShaders

public final boolean hasUnreferencedShaders()

Returns:

the number of shaders not referenced

destroyUnreferenced

public final int destroyUnreferenced(IGL gl)

Destroy (remove/unload) unreferenced shaders of this ShaderList.

Parameters:

gl - opengl context

Returns:

the number of Shader unloaded and removed from this ShaderList

See Also:

destroyAll(IGL)

destroyAll

@Deprecated
public final int destroyAll(IGL gl)

Deprecated.

Destroy (remove/unload) all shaders of this ShaderList, even those who are still references and therefore potentially still used.

Parameters:

gl - opengl context

Returns:

the number of shader destroyed but still referenced

See Also:

destroyUnreferenced(IGL)

onContextLost

public final void onContextLost()

Destroy this ShaderList after the OpenGL context has been lost.

size

public final int size()

Returns:

the number of shader in this ShaderList

setDeleteCodeOnLoadSuccess

public final void setDeleteCodeOnLoadSuccess(boolean deleteCodeOnLoadSuccess)

Parameters:

deleteCodeOnLoadSuccess - true to delete shader code on successful loading.
Default value: true

isDeleteCodeOnLoadSuccess

public final boolean isDeleteCodeOnLoadSuccess()

Returns:

true if shader code is deleted on successful loading

iterator

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

Specified by:

iterator in interface java.lang.Iterable<Shader>