org.mini2Dx.core.graphics

Interface Shader

All Superinterfaces:

org.mini2Dx.gdx.utils.Disposable

All Known Implementing Classes:

LibgdxShader

public interface Shader
extends org.mini2Dx.gdx.utils.Disposable

Interface to platform-specific shader implementations

Method Summary

Modifier and Type	Method and Description
void	begin() Binds the shader for parameter modification
void	end() Unbinds the shader for parameter modification
java.lang.String	getLog()
ShaderType	getShaderType() Returns the ShaderType (Note: different platforms require different types)
boolean	hasParameter(java.lang.String name) Checks if the shader has the specified parameter (uniform, attribute, etc.).
boolean	isCompiled() Returns if this shader compiled successfully
void	setParameter(java.lang.String name, int bindId, Texture texture) Sets the specified texture parameter.
void	setParameter(java.lang.String name, Texture texture) Sets the specified texture parameter.
void	setParameterf(java.lang.String name, float value) Sets the specified float parameter (uniform).
void	setParameterf(java.lang.String name, float value1, float value2) Sets the specified parameter (uniform).
void	setParameterf(java.lang.String name, float value1, float value2, float value3) Sets the specified parameter (uniform).
void	setParameterf(java.lang.String name, float value1, float value2, float value3, float value4) Sets the specified parameter (uniform or attribute).
void	setParameterf(java.lang.String name, org.mini2Dx.gdx.math.Vector2 vec) Sets the specified parameter (uniform).
void	setParameterf(java.lang.String name, org.mini2Dx.gdx.math.Vector3 vec) Sets the specified parameter (uniform).
void	setParameteri(java.lang.String name, int value) Sets the specified parameter (uniform).
void	setParameterMatrix(java.lang.String name, org.mini2Dx.gdx.math.Matrix4 matrix) Sets the specified parameter (uniform).
void	setParameterMatrix(java.lang.String name, org.mini2Dx.gdx.math.Matrix4 matrix, boolean transpose) Sets the specified parameter (uniform).

Methods inherited from interface org.mini2Dx.gdx.utils.Disposable

dispose

Method Detail

begin

void begin()

Binds the shader for parameter modification

end

void end()

Unbinds the shader for parameter modification

hasParameter

boolean hasParameter(java.lang.String name)

Checks if the shader has the specified parameter (uniform, attribute, etc.).

Parameters:

name - The parameter name

Returns:

False if the uniform, attribute, etc. does not exist

setParameter

void setParameter(java.lang.String name,
                  Texture texture)

Sets the specified texture parameter. Automatically allocates a bind ID for the texture on OpenGL platforms. Note: begin() must be called before using this method

Parameters:

name - The parameter name

texture - The texture to bind to the parameter

setParameter

void setParameter(java.lang.String name,
                  int bindId,
                  Texture texture)

Sets the specified texture parameter. Note: begin() must be called before using this method

Parameters:

name - The parameter name

bindId - The texture bind ID to use on OpenGL platforms

texture - The texture to bind to the parameter

setParameterf

void setParameterf(java.lang.String name,
                   float value)

Sets the specified float parameter (uniform). Note: begin() must be called before using this method

Parameters:

name - The parameter name

value -

setParameterf

void setParameterf(java.lang.String name,
                   float value1,
                   float value2)

Sets the specified parameter (uniform). Note: begin() must be called before using this method

Parameters:

name - The parameter name

value1 -

value2 -

setParameterf

void setParameterf(java.lang.String name,
                   float value1,
                   float value2,
                   float value3)

Sets the specified parameter (uniform). Note: begin() must be called before using this method

Parameters:

name - The parameter name

value1 -

value2 -

value3 -

setParameterf

void setParameterf(java.lang.String name,
                   float value1,
                   float value2,
                   float value3,
                   float value4)

Sets the specified parameter (uniform or attribute). Note: begin() must be called before using this method

Parameters:

name - The parameter name

value1 -

value2 -

value3 -

value4 -

setParameterf

void setParameterf(java.lang.String name,
                   org.mini2Dx.gdx.math.Vector2 vec)

Sets the specified parameter (uniform). Note: begin() must be called before using this method

Parameters:

name - The parameter name

vec -

setParameterf

void setParameterf(java.lang.String name,
                   org.mini2Dx.gdx.math.Vector3 vec)

Sets the specified parameter (uniform). Note: begin() must be called before using this method

Parameters:

name - The parameter name

vec -

setParameteri

void setParameteri(java.lang.String name,
                   int value)

Sets the specified parameter (uniform). Note: begin() must be called before using this method

Parameters:

name - The parameter name

value -

setParameterMatrix

void setParameterMatrix(java.lang.String name,
                        org.mini2Dx.gdx.math.Matrix4 matrix)

Sets the specified parameter (uniform). Note: begin() must be called before using this method

Parameters:

name - The parameter name

matrix -

setParameterMatrix

void setParameterMatrix(java.lang.String name,
                        org.mini2Dx.gdx.math.Matrix4 matrix,
                        boolean transpose)

Sets the specified parameter (uniform). Note: begin() must be called before using this method

Parameters:

name - The parameter name

matrix -

transpose -

getLog

java.lang.String getLog()

isCompiled

boolean isCompiled()

Returns if this shader compiled successfully

Returns:

getShaderType

ShaderType getShaderType()

Returns the ShaderType (Note: different platforms require different types)

Returns: