com.bonzaiengine.shader

Class ComputeShader

java.lang.Object

com.bonzaiengine.shader.ComputeShader

All Implemented Interfaces:

java.lang.Comparable<com.bonzaiengine.shader.AbstractShader>

public class ComputeShader
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
ComputeShader(java.lang.String name, java.lang.String code)

Method Summary

Modifier and Type	Method and Description
void	bind(IGL gl)
int	compareTo(com.bonzaiengine.shader.AbstractShader o)
protected void	createAndLinkProgram(IGL gl, int[] shaders)
protected int	createAndLoadShader(IGL gl, int type, java.lang.String code)
java.lang.String	getCode()
java.lang.String	getLoadError()
java.lang.String	getName()
int	getNumGroupX()
int	getNumGroupY()
int	getNumGroupZ()
int	getProgram()
int	getRefCount()
ShaderState	getState()
<T extends IValueCopy<T>> ShaderUniform<T>	getUniform(ShaderUniform.BuiltIn uniform)
int	getUniformLocation(ShaderUniform.BuiltIn uniform)
protected boolean	initStateAndSamplers(IGL gl)
boolean	isLoaded()
boolean	load(IGLApi glApi)
void	onContextLost() Must be called when OpenGL context is lost
int	release() Decrement reference counter
void	run(IGL gl)
void	sendUniforms(IGL gl) Send uniform value, if changed, to OpenGL.
void	setCode(java.lang.String code)
void	setWorkGroup(int workGroupX, int workGroupY, int workGroupZ)
java.lang.String	toString()
void	unbind(IGL gl)
void	unload(IGLApi glApi)
int	use() Increment reference counter
protected void	validateProgram(IGL gl)

Methods inherited from class java.lang.Object

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

Constructor Detail

ComputeShader

public ComputeShader(java.lang.String name,
                     java.lang.String code)

Method Detail

getCode

public final java.lang.String getCode()

setCode

public void setCode(java.lang.String code)

load

public boolean load(IGLApi glApi)

run

public final void run(IGL gl)

setWorkGroup

public final void setWorkGroup(int workGroupX,
                               int workGroupY,
                               int workGroupZ)

getNumGroupX

public int getNumGroupX()

getNumGroupY

public int getNumGroupY()

getNumGroupZ

public int getNumGroupZ()

toString

public final java.lang.String toString()

Overrides:

toString in class java.lang.Object

compareTo

public final int compareTo(com.bonzaiengine.shader.AbstractShader o)

Specified by:

compareTo in interface java.lang.Comparable<com.bonzaiengine.shader.AbstractShader>

getName

public final java.lang.String getName()

createAndLoadShader

protected final int createAndLoadShader(IGL gl,
                                        int type,
                                        java.lang.String code)

createAndLinkProgram

protected final void createAndLinkProgram(IGL gl,
                                          int[] shaders)

validateProgram

protected final void validateProgram(IGL gl)

initStateAndSamplers

protected final boolean initStateAndSamplers(IGL gl)

getLoadError

public final java.lang.String getLoadError()

unload

public final void unload(IGLApi glApi)

isLoaded

public final boolean isLoaded()

Returns:

true if this shader is loaded

getProgram

public final int getProgram()

Returns:

the program ID

onContextLost

public final void onContextLost()

Must be called when OpenGL context is lost

bind

public final void bind(IGL gl)

unbind

public final void unbind(IGL gl)

getState

public ShaderState getState()

Returns:

ShaderState of this Shader.
The ShaderState contains uniforms list and values for this shader.

getUniform

public final <T extends IValueCopy<T>> ShaderUniform<T> getUniform(ShaderUniform.BuiltIn uniform)

getUniformLocation

public final int getUniformLocation(ShaderUniform.BuiltIn uniform)

Returns:

the uniform location, -1 if it does not exists.

sendUniforms

public final void sendUniforms(IGL gl)

Send uniform value, if changed, to OpenGL.
ShaderUniform implementation bufferize uniform value, the transfer to OpenGL is actual done here.

Parameters:

gl - OpenGL context

getRefCount

public final int getRefCount()

Returns:

this shader reference counter

use

public final int use()

Increment reference counter

Returns:

the new reference counter value

release

public final int release()

Decrement reference counter

Returns:

the new reference counter value