GLSLProgram

java.lang.Object
- org.synthclipse.scripting.gl.GLSLProgram

All Implemented Interfaces:

org.synthclipse.scripting.IDisposable
```
public class GLSLProgram
extends Object
implements org.synthclipse.scripting.IDisposable
```
Wrapped GLSL program with some useful utility methods.
GLSLProgram, apart from standard OpenGL features, also parses GLSL code in search of Uniform Controls and Commands.

SCRIPTING: In scripts, instance of this class can be created using GLSLProgramFactory.

Constructor Summary

Constructors
Constructor and Description
`GLSLProgram(javax.media.opengl.GL3 gl, File scriptFile, org.synthclipse.core.parser.IParsingErrorHandler errorHandler, org.synthclipse.core.IFileResolver fileResolver, org.synthclipse.scripting.IScriptingController scriptingController)` Creates a new GLSLProgram.
`GLSLProgram(javax.media.opengl.GL3 gl, String name, File scriptFile, org.synthclipse.core.parser.IParsingErrorHandler errorHandler, org.synthclipse.core.IFileResolver fileResolver, org.synthclipse.scripting.IScriptingController scriptingController)` Creates a new GLSL program.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`applyUniforms()` Applies Uniform Controls' values to the program.
`void`	`attachShader(String path)` Attaches shader to the program.
`void`	`attachShader(String path, int type)` Attaches shader to the program.
`void`	`attachShaderString(String shaderCode, int type)` Attaches shader, contained in the `shaderCode`, to the program.
`void`	`dispose()` Releases resources.
`org.synthclipse.core.gl.executor.GLSLExecutor`	`getGLSLExecutor()` Returns internal program executor.
`int`	`getId()` Returns OpenGL's ID of the program.
`String`	`getName()` Returns porgram's name.
`int`	`getUniformLocation(String name)` Gets uniform's location.
`void`	`link()` Links the program.
`boolean`	`loadPreset(String presetName)` Loads preset.
`void`	`printActiveAttributes()` Prints active attributes.
`void`	`printActiveUniforms()` Prints active uniform variables.
`String`	`readProgramInfoLog()` Reads program's log.
`void`	`setName(String name)` Sets program's name.
`void`	`setUniform(int location, boolean value)` Sets uniform variable with GLSL's type `bool`.
`void`	`setUniform(int location, ColorRGB color)` Sets uniform variable with GLSL's type `vec3`.
`void`	`setUniform(int location, ColorRGBA color)` Sets uniform variable with GLSL's type `vec4`.
`void`	`setUniform(int location, double value)` Sets uniform variable with GLSL's type `double`.
`void`	`setUniform(int location, float value)` Sets uniform variable with GLSL's type `float`.
`void`	`setUniform(int location, float x, float y)` Sets uniform variable with GLSL's type `vec2`.
`void`	`setUniform(int location, float x, float y, float z)` Sets uniform variable with GLSL's type `vec3`.
`void`	`setUniform(int location, float x, float y, float z, float w)` Sets uniform variable with GLSL's type `vec4`.
`void`	`setUniform(int location, int value)` Sets uniform variable with GLSL's type `int`.
`void`	`setUniform(int location, Matrix3f mat3)` Sets uniform variable with GLSL's type `mat3`.
`void`	`setUniform(int location, Matrix4f mat4)` Sets uniform variable with GLSL's type `mat4`.
`void`	`setUniform(int location, Vector2f v)` Sets uniform variable with GLSL's type `vec2`.
`void`	`setUniform(int location, Vector3f v)` Sets uniform variable with GLSL's type `vec3`.
`void`	`setUniform(int location, Vector4f v)` Sets uniform variable with GLSL's type `vec4`.
`void`	`setUniform(String name, boolean value)` Sets uniform variable with GLSL's type `bool`.
`void`	`setUniform(String name, ColorRGB color)` Sets uniform variable with GLSL's type `vec3`.
`void`	`setUniform(String name, ColorRGBA color)` Sets uniform variable with GLSL's type `vec4`.
`void`	`setUniform(String name, double value)` Sets uniform variable with GLSL's type `double`.
`void`	`setUniform(String name, float value)` Sets uniform variable with GLSL's type `float`.
`void`	`setUniform(String name, float x, float y)` Sets uniform variable with GLSL's type `vec2`.
`void`	`setUniform(String name, float x, float y, float z)` Sets uniform variable with GLSL's type `vec3`.
`void`	`setUniform(String name, float x, float y, float z, float w)` Sets uniform variable with GLSL's type `vec4`.
`void`	`setUniform(String name, int value)` Sets uniform variable with GLSL's type `int`.
`void`	`setUniform(String name, Matrix3f mat3)` Sets uniform variable with GLSL's type `mat3`.
`void`	`setUniform(String name, Matrix4f mat4)` Sets uniform variable with GLSL's type `mat4`.
`void`	`setUniform(String name, Vector2f v)` Sets uniform variable with GLSL's type `vec2`.
`void`	`setUniform(String name, Vector3f v)` Sets uniform variable with GLSL's type `vec3`.
`void`	`setUniform(String name, Vector4f v)` Sets uniform variable with GLSL's type `vec4`.
`void`	`setUniformColor(int location, float r, float g, float b)` Sets uniform variable with GLSL's type `vec3` and Uniform Control type: ColorRGB.
`void`	`setUniformColor(int location, float r, float g, float b, float a)` Sets uniform variable with GLSL's type `vec4` and Uniform Control type: ColorRGBA.
`void`	`setUniformColor(String name, float r, float g, float b)` Sets uniform variable with GLSL's type `vec3` and Uniform Control type: ColorRGB.
`void`	`setUniformColor(String name, float r, float g, float b, float a)` Sets uniform variable with GLSL's type `vec4` and Uniform Control type: ColorRGBA.
`void`	`setUniformDouble(int location, double value)` Sets uniform variable with GLSL's type `double`.
`void`	`setUniformDouble(String name, double value)` Sets uniform variable with GLSL's type `double`.
`void`	`setUniformFloat(int location, float value)` Sets uniform variable with GLSL's type `float`.
`void`	`setUniformFloat(String name, float value)` Sets uniform variable with GLSL's type `float`.
`void`	`setUniformInt(int location, int value)` Sets uniform variable with GLSL's type `int`.
`void`	`setUniformInt(String name, int value)` Sets uniform variable with GLSL's type `int`.
`void`	`setUniformMatrix3(int location, Matrix4f mat4)` Sets uniform variable with GLSL's type `mat3`.
`void`	`setUniformMatrix3(String name, Matrix4f mat4)` Sets uniform variable with GLSL's type `mat3`.
`String`	`toString()`
`void`	`unuse()` This method is equivalent of using function glUseProgram() with `0` as the argument.
`void`	`use()` This method is equivalent of using function glUseProgram() with this program's id as the argument.
`boolean`	`validate()` Validates the program.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - GLSLProgram
```
public GLSLProgram(javax.media.opengl.GL3 gl,
                   File scriptFile,
                   org.synthclipse.core.parser.IParsingErrorHandler errorHandler,
                   org.synthclipse.core.IFileResolver fileResolver,
                   org.synthclipse.scripting.IScriptingController scriptingController)
```
    Creates a new GLSLProgram.
    
    WARNING: Do not use this constructor directly in scripts.
    Use GLSLProgramFactory.createProgram(String) instead.
  - GLSLProgram
```
public GLSLProgram(javax.media.opengl.GL3 gl,
                   String name,
                   File scriptFile,
                   org.synthclipse.core.parser.IParsingErrorHandler errorHandler,
                   org.synthclipse.core.IFileResolver fileResolver,
                   org.synthclipse.scripting.IScriptingController scriptingController)
```
    Creates a new GLSL program.
    
    WARNING: Do not use this constructor directly in scripts.
    Use GLSLProgramFactory.createProgram(String) instead.
- Method Detail
  - dispose
```
public void dispose()
```
    Releases resources.
    
    Specified by:
    
    dispose in interface org.synthclipse.scripting.IDisposable
  - attachShader
```
public void attachShader(String path)
                  throws org.synthclipse.core.gl.GLObjectException,
                         FileNotFoundException,
                         org.synthclipse.core.parser.ParsingException,
                         org.synthclipse.core.SynthclipseException
```
    Attaches shader to the program. Shader's type is deduced by the file's extension contained in the path.
    Currently recognized extensions are:
    - gl.VERTEX_SHADER: .vs, .vert
    - gl.FRAGMENT_SHADER: .fs, .frag, .fragx
    - gl.GEOMETRY_SHADER: .gs, .geom
    - gl.TESS_CONTROL_SHADER: .tcs, .tessctrl, .tesscontrol
    - gl.TESS_EVALUATION_SHADER: .tes, .tev, .tesseval
    - gl.COMPUTE_SHADER: .cs, .compute, .comp
    Parameters:
    
    path - Path to a shader file.
    
    Throws:
    
    org.synthclipse.core.SynthclipseException - If something unexpected happens.
    
    FileNotFoundException - If file pointed by path doesn't exist.
    
    org.synthclipse.core.parser.ParsingException - If shader parsing error occurs.
    
    org.synthclipse.core.gl.GLObjectException
  - attachShader
```
public void attachShader(String path,
                         int type)
                  throws org.synthclipse.core.SynthclipseException,
                         FileNotFoundException,
                         org.synthclipse.core.parser.ParsingException,
                         org.synthclipse.core.gl.GLObjectException
```
    Attaches shader to the program.
    Parameters:
    
    path - Path to a shader file.
    type - The type should be one of the following constants:
    
    gl.FRAGMENT_SHADER
    
    gl.VERTEX_SHADER
    
    gl.GEOMETRY_SHADER
    
    gl.TESS_EVALUATION_SHADER
    
    gl.TESS_CONTROL_SHADER
    
    gl.COMPUTE_SHADER
    Throws:
    
    org.synthclipse.core.SynthclipseException - If the type is not one of listed above, or something unexpected happens.
    
    FileNotFoundException - If file pointed by path doesn't exist.
    
    org.synthclipse.core.parser.ParsingException - If shader parsing error occurs.
    
    org.synthclipse.core.gl.GLObjectException
  - attachShaderString
```
public void attachShaderString(String shaderCode,
                               int type)
                        throws org.synthclipse.core.SynthclipseException,
                               org.synthclipse.core.parser.ParsingException,
                               org.synthclipse.core.gl.GLObjectException
```
    Attaches shader, contained in the shaderCode, to the program.
    Parameters:
    
    shaderCode - Shader code in a String form.
    type - The type should be one of the following constants:
    
    gl.FRAGMENT_SHADER
    
    gl.VERTEX_SHADER
    
    gl.GEOMETRY_SHADER
    
    gl.TESS_EVALUATION_SHADER
    
    gl.TESS_CONTROL_SHADER
    
    gl.COMPUTE_SHADER
    Throws:
    
    org.synthclipse.core.SynthclipseException - If the type is not one of listed above, or something unexpected happens.
    
    org.synthclipse.core.parser.ParsingException - If shader parsing error occurs.
    
    org.synthclipse.core.gl.GLObjectException
  - link
```
public void link()
          throws org.synthclipse.core.SynthclipseException
```
    Links the program.
    
    Throws:
    
    org.synthclipse.core.SynthclipseException - If program fails to link.
  - applyUniforms
```
public void applyUniforms()
```
    Applies Uniform Controls' values to the program.
  - getName
```
public String getName()
```
    Returns porgram's name.
    
    SCRIPTING: As with all Java's getters and setters you can call this method in JavaScript in two ways:
    - program.getName();
    - program.name;
  - setName
```
public void setName(String name)
```
    Sets program's name.
    
    SCRIPTING: As with all Java's getters and setters you can call this method in JavaScript in two ways:
    - program.setName("value");
    - program.name = "value";
  - loadPreset
```
public boolean loadPreset(String presetName)
```
    Loads preset.
    
    Parameters:
    
    presetName - preset's name
    
    Returns:
    
    true if preset with name presetName exists, false otherwise.
  - getGLSLExecutor
```
public org.synthclipse.core.gl.executor.GLSLExecutor getGLSLExecutor()
```
    Returns internal program executor. You probably won't need it in yours scripts.
  - getId
```
public int getId()
```
    Returns OpenGL's ID of the program. It is one returned by glCreateProgram() function.
    
    SCRIPTING: As with all Java's getters and setters you can call this method in JavaScript in two ways:
    - program.getId();
    - program.id;
  - use
```
public void use()
```
    This method is equivalent of using function glUseProgram() with this program's id as the argument.
  - unuse
```
public void unuse()
```
    This method is equivalent of using function glUseProgram() with 0 as the argument.
  - readProgramInfoLog
```
public String readProgramInfoLog()
```
    Reads program's log.
  - printActiveUniforms
```
public void printActiveUniforms()
```
    Prints active uniform variables.
  - printActiveAttributes
```
public void printActiveAttributes()
```
    Prints active attributes.
  - validate
```
public boolean validate()
```
    Validates the program.
    
    Returns:
    
    true if program is valid, false otherwise
  - getUniformLocation
```
public int getUniformLocation(String name)
```
    Gets uniform's location. This method DOES NOT use glGetUniformLocation() but instead it uses internal cache with all uniforms' locations (for speed reason).
    
    Parameters:
    
    name - name of queried variable
    
    Returns:
    
    uniform's location or -1 if it does not exist
  - setUniform
```
public void setUniform(int location,
                       boolean value)
```
    Sets uniform variable with GLSL's type bool.
    
    Parameters:
    
    location - uniform's location
    
    value - the value we want to set
  - setUniform
```
public void setUniform(String name,
                       boolean value)
```
    Sets uniform variable with GLSL's type bool.
    
    Parameters:
    
    name - uniform's name
    
    value - the value we want to set
  - setUniform
```
public void setUniform(int location,
                       int value)
```
    Sets uniform variable with GLSL's type int.
    
    Parameters:
    
    location - uniform's location
    
    value - the value we want to set
  - setUniform
```
public void setUniform(String name,
                       int value)
```
    Sets uniform variable with GLSL's type int.
    
    Parameters:
    
    name - uniform's name
    
    value - the value we want to set
  - setUniformInt
```
public void setUniformInt(int location,
                          int value)
```
    Sets uniform variable with GLSL's type int.
    
    Parameters:
    
    location - uniform's location
    
    value - the value we want to set
  - setUniformInt
```
public void setUniformInt(String name,
                          int value)
```
    Sets uniform variable with GLSL's type int.
    
    Parameters:
    
    name - uniform's name
    
    value - the value we want to set
  - setUniform
```
public void setUniform(int location,
                       float value)
```
    Sets uniform variable with GLSL's type float.
    
    Parameters:
    
    location - uniform's location
    
    value - the value we want to set
  - setUniform
```
public void setUniform(String name,
                       float value)
```
    Sets uniform variable with GLSL's type float.
    
    Parameters:
    
    name - uniform's name
    
    value - the value we want to set
  - setUniformFloat
```
public void setUniformFloat(int location,
                            float value)
```
    Sets uniform variable with GLSL's type float.
    
    Parameters:
    
    location - uniform's location
    
    value - the value we want to set
  - setUniformFloat
```
public void setUniformFloat(String name,
                            float value)
```
    Sets uniform variable with GLSL's type float.
    
    Parameters:
    
    name - uniform's name
    
    value - the value we want to set
  - setUniform
```
public void setUniform(int location,
                       double value)
```
    Sets uniform variable with GLSL's type double.
    
    Parameters:
    
    location - uniform's location
    
    value - the value we want to set
  - setUniform
```
public void setUniform(String name,
                       double value)
```
    Sets uniform variable with GLSL's type double.
    
    Parameters:
    
    name - uniform's name
    
    value - the value we want to set
  - setUniformDouble
```
public void setUniformDouble(int location,
                             double value)
```
    Sets uniform variable with GLSL's type double.
    
    Parameters:
    
    location - uniform's location
    
    value - the value we want to set
  - setUniformDouble
```
public void setUniformDouble(String name,
                             double value)
```
    Sets uniform variable with GLSL's type double.
    
    Parameters:
    
    name - uniform's name
    
    value - the value we want to set
  - setUniform
```
public void setUniform(int location,
                       float x,
                       float y)
```
    Sets uniform variable with GLSL's type vec2.
    
    Parameters:
    
    location - uniform's location
    
    x - X component of the vector
    
    y - Y component of the vector
  - setUniform
```
public void setUniform(String name,
                       float x,
                       float y)
```
    Sets uniform variable with GLSL's type vec2.
    
    Parameters:
    
    name - uniform's name
    
    x - X component of the vector
    
    y - Y component of the vector
  - setUniform
```
public void setUniform(int location,
                       float x,
                       float y,
                       float z)
```
    Sets uniform variable with GLSL's type vec3.
    
    Parameters:
    
    location - uniform's location
    
    x - X component of the vector
    
    y - Y component of the vector
    
    z - Z component of the vector
  - setUniform
```
public void setUniform(String name,
                       float x,
                       float y,
                       float z)
```
    Sets uniform variable with GLSL's type vec3.
    
    Parameters:
    
    name - uniform's name
    
    x - X component of the vector
    
    y - Y component of the vector
    
    z - Z component of the vector
  - setUniform
```
public void setUniform(int location,
                       float x,
                       float y,
                       float z,
                       float w)
```
    Sets uniform variable with GLSL's type vec4.
    
    Parameters:
    
    location - uniform's location
    
    x - X component of the vector
    
    y - Y component of the vector
    
    z - Z component of the vector
    
    w - W component of the vector
  - setUniform
```
public void setUniform(String name,
                       float x,
                       float y,
                       float z,
                       float w)
```
    Sets uniform variable with GLSL's type vec4.
    
    Parameters:
    
    name - uniform's name
    
    x - X component of the vector
    
    y - Y component of the vector
    
    z - Z component of the vector
    
    w - W component of the vector
  - setUniform
```
public void setUniform(int location,
                       Vector2f v)
```
    Sets uniform variable with GLSL's type vec2.
    
    Parameters:
    
    location - uniform's location
    
    v - the vector we want to set
  - setUniform
```
public void setUniform(String name,
                       Vector2f v)
```
    Sets uniform variable with GLSL's type vec2.
    
    Parameters:
    
    name - uniform's name
    
    v - the vector we want to set
  - setUniform
```
public void setUniform(int location,
                       Vector3f v)
```
    Sets uniform variable with GLSL's type vec3.
    
    Parameters:
    
    location - uniform's location
    
    v - the vector we want to set
  - setUniform
```
public void setUniform(String name,
                       Vector3f v)
```
    Sets uniform variable with GLSL's type vec3.
    
    Parameters:
    
    name - uniform's name
    
    v - the vector we want to set
  - setUniform
```
public void setUniform(int location,
                       Vector4f v)
```
    Sets uniform variable with GLSL's type vec4.
    
    Parameters:
    
    location - uniform's location
    
    v - the vector we want to set
  - setUniform
```
public void setUniform(String name,
                       Vector4f v)
```
    Sets uniform variable with GLSL's type vec4.
    
    Parameters:
    
    name - uniform's name
    
    v - the vector we want to set
  - setUniform
```
public void setUniform(int location,
                       ColorRGB color)
```
    Sets uniform variable with GLSL's type vec3.
    
    Parameters:
    
    location - uniform's location
    
    color - Color RGB we want to set
  - setUniform
```
public void setUniform(String name,
                       ColorRGB color)
```
    Sets uniform variable with GLSL's type vec3.
    
    Parameters:
    
    name - uniform's name
    
    color - Color RGB we want to set
  - setUniform
```
public void setUniform(int location,
                       ColorRGBA color)
```
    Sets uniform variable with GLSL's type vec4.
    
    Parameters:
    
    location - uniform's location
    
    color - Color RGBA we want to set
  - setUniform
```
public void setUniform(String name,
                       ColorRGBA color)
```
    Sets uniform variable with GLSL's type vec4.
    
    Parameters:
    
    name - uniform's name
    
    color - Color RGBA we want to set
  - setUniform
```
public void setUniform(int location,
                       Matrix3f mat3)
```
    Sets uniform variable with GLSL's type mat3.
    
    Parameters:
    
    location - uniform's location
    
    mat3 - the matrix 3x3 we want to set
  - setUniform
```
public void setUniform(String name,
                       Matrix3f mat3)
```
    Sets uniform variable with GLSL's type mat3.
    
    Parameters:
    
    name - uniform's name
    
    mat3 - the matrix 3x3 we want to set
  - setUniform
```
public void setUniform(int location,
                       Matrix4f mat4)
```
    Sets uniform variable with GLSL's type mat4.
    
    Parameters:
    
    location - uniform's location
    
    mat4 - the matrix 4x4 we want to set
  - setUniform
```
public void setUniform(String name,
                       Matrix4f mat4)
```
    Sets uniform variable with GLSL's type mat4.
    
    Parameters:
    
    name - uniform's name
    
    mat4 - the matrix 4x4 we want to set
  - setUniformMatrix3
```
public void setUniformMatrix3(int location,
                              Matrix4f mat4)
```
    Sets uniform variable with GLSL's type mat3. It is the same as setUniform(int, Matrix3f) but uses Matrix4f as source.
    
    Parameters:
    
    location - uniform's location
    
    mat4 - the matrix 4x4 from which will be extracted a matrix 3x3 that we want essentially to set
  - setUniformMatrix3
```
public void setUniformMatrix3(String name,
                              Matrix4f mat4)
```
    Sets uniform variable with GLSL's type mat3. It is the same as setUniform(int, Matrix3f) but uses Matrix4f as source.
    
    Parameters:
    
    name - uniform's name
    
    mat4 - the matrix 4x4 from which will be extracted a matrix 3x3 that we want essentially to set
  - setUniformColor
```
public void setUniformColor(String name,
                            float r,
                            float g,
                            float b)
```
    Sets uniform variable with GLSL's type vec3 and Uniform Control type: ColorRGB.
    
    Parameters:
    
    name - uniform's name
    
    r - r component of the color
    
    g - g component of the color
    
    b - b component of the vector
  - setUniformColor
```
public void setUniformColor(int location,
                            float r,
                            float g,
                            float b)
```
    Sets uniform variable with GLSL's type vec3 and Uniform Control type: ColorRGB.
    
    Parameters:
    
    location - uniform's location
    
    r - r component of the color
    
    g - g component of the color
    
    b - b component of the vector
  - setUniformColor
```
public void setUniformColor(String name,
                            float r,
                            float g,
                            float b,
                            float a)
```
    Sets uniform variable with GLSL's type vec4 and Uniform Control type: ColorRGBA.
    
    Parameters:
    
    name - uniform's name
    
    r - r component of the color
    
    g - g component of the color
    
    b - b component of the vector
    
    a - a component of the vector
  - setUniformColor
```
public void setUniformColor(int location,
                            float r,
                            float g,
                            float b,
                            float a)
```
    Sets uniform variable with GLSL's type vec4 and Uniform Control type: ColorRGBA.
    
    Parameters:
    
    location - uniform's location
    
    r - r component of the color
    
    g - g component of the color
    
    b - b component of the vector
    
    a - a component of the vector
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class GLSLProgram

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GLSLProgram

GLSLProgram

Method Detail

dispose

attachShader

attachShader

attachShaderString

link

applyUniforms

getName

setName

loadPreset

getGLSLExecutor

getId

use

unuse

readProgramInfoLog

printActiveUniforms

printActiveAttributes

validate

getUniformLocation

setUniform

setUniform

setUniform

setUniform

setUniformInt

setUniformInt

setUniform

setUniform

setUniformFloat

setUniformFloat

setUniform

setUniform

setUniformDouble

setUniformDouble

setUniform

setUniform

setUniform

setUniform

setUniform

setUniform

setUniform

setUniform

setUniform

setUniform

setUniform

setUniform

setUniform

setUniform

setUniform

setUniform

setUniform

setUniform

setUniform

setUniform

setUniformMatrix3

setUniformMatrix3

setUniformColor

setUniformColor

setUniformColor

setUniformColor

toString