ShaderProgram (libGDX Core 1.3.0 API)

java.lang.Object
- com.badlogic.gdx.graphics.glutils.ShaderProgram

All Implemented Interfaces:

Disposable
```
public class ShaderProgram
extends Object
implements Disposable
```
A shader program encapsulates a vertex and fragment shader pair linked to form a shader program useable with OpenGL ES 2.0.

After construction a ShaderProgram can be used to draw Mesh. To make the GPU use a specific ShaderProgram the programs begin() method must be used which effectively binds the program.

When a ShaderProgram is bound one can set uniforms, vertex attributes and attributes as needed via the respective methods.

A ShaderProgram can be unbound with a call to end()

A ShaderProgram must be disposed via a call to dispose() when it is no longer needed

ShaderPrograms are managed. In case the OpenGL context is lost all shaders get invalidated and have to be reloaded. This happens on Android when a user switches to another application or receives an incoming call. Managed ShaderPrograms are automatically reloaded when the OpenGL context is recreated so you don't have to do this manually.

Author:

mzechner

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`BINORMAL_ATTRIBUTE` default name for binormal attribute
`static String`	`COLOR_ATTRIBUTE` default name for color attributes
`static String`	`NORMAL_ATTRIBUTE` default name for normal attributes
`static boolean`	`pedantic` flag indicating whether attributes & uniforms must be present at all times
`static String`	`POSITION_ATTRIBUTE` default name for position attributes
`static String`	`TANGENT_ATTRIBUTE` default name for tangent attribute
`static String`	`TEXCOORD_ATTRIBUTE` default name for texcoords attributes, append texture unit number

Constructor Summary

Constructors
Constructor and Description
`ShaderProgram(FileHandle vertexShader, FileHandle fragmentShader)`
`ShaderProgram(String vertexShader, String fragmentShader)` Constructs a new ShaderProgram and immediately compiles it.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`begin()` Makes OpenGL ES 2.0 use this vertex and fragment shader pair.
`static void`	`clearAllShaderPrograms(Application app)`
`void`	`disableVertexAttribute(int location)`
`void`	`disableVertexAttribute(String name)` Disables the vertex attribute with the given name
`void`	`dispose()` Disposes all resources associated with this shader.
`void`	`enableVertexAttribute(int location)`
`void`	`enableVertexAttribute(String name)` Enables the vertex attribute with the given name
`void`	`end()` Disables this shader.
`int`	`fetchUniformLocation(String name, boolean pedantic)`
`int`	`getAttributeLocation(String name)`
`String[]`	`getAttributes()`
`int`	`getAttributeSize(String name)`
`int`	`getAttributeType(String name)`
`String`	`getFragmentShaderSource()`
`String`	`getLog()`
`static String`	`getManagedStatus()`
`int`	`getUniformLocation(String name)`
`String[]`	`getUniforms()`
`int`	`getUniformSize(String name)`
`int`	`getUniformType(String name)`
`String`	`getVertexShaderSource()`
`boolean`	`hasAttribute(String name)`
`boolean`	`hasUniform(String name)`
`static void`	`invalidateAllShaderPrograms(Application app)` Invalidates all shaders so the next time they are used new handles are generated
`boolean`	`isCompiled()`
`void`	`setAttributef(String name, float value1, float value2, float value3, float value4)` Sets the given attribute
`void`	`setUniform1fv(int location, float[] values, int offset, int length)`
`void`	`setUniform1fv(String name, float[] values, int offset, int length)`
`void`	`setUniform2fv(int location, float[] values, int offset, int length)`
`void`	`setUniform2fv(String name, float[] values, int offset, int length)`
`void`	`setUniform3fv(int location, float[] values, int offset, int length)`
`void`	`setUniform3fv(String name, float[] values, int offset, int length)`
`void`	`setUniform4fv(int location, float[] values, int offset, int length)`
`void`	`setUniform4fv(String name, float[] values, int offset, int length)`
`void`	`setUniformf(int location, Color values)`
`void`	`setUniformf(int location, float value)`
`void`	`setUniformf(int location, float value1, float value2)`
`void`	`setUniformf(int location, float value1, float value2, float value3)`
`void`	`setUniformf(int location, float value1, float value2, float value3, float value4)`
`void`	`setUniformf(int location, Vector2 values)`
`void`	`setUniformf(int location, Vector3 values)`
`void`	`setUniformf(String name, Color values)` Sets the uniform with the given name.
`void`	`setUniformf(String name, float value)` Sets the uniform with the given name.
`void`	`setUniformf(String name, float value1, float value2)` Sets the uniform with the given name.
`void`	`setUniformf(String name, float value1, float value2, float value3)` Sets the uniform with the given name.
`void`	`setUniformf(String name, float value1, float value2, float value3, float value4)` Sets the uniform with the given name.
`void`	`setUniformf(String name, Vector2 values)` Sets the uniform with the given name.
`void`	`setUniformf(String name, Vector3 values)` Sets the uniform with the given name.
`void`	`setUniformi(int location, int value)`
`void`	`setUniformi(int location, int value1, int value2)`
`void`	`setUniformi(int location, int value1, int value2, int value3)`
`void`	`setUniformi(int location, int value1, int value2, int value3, int value4)`
`void`	`setUniformi(String name, int value)` Sets the uniform with the given name.
`void`	`setUniformi(String name, int value1, int value2)` Sets the uniform with the given name.
`void`	`setUniformi(String name, int value1, int value2, int value3)` Sets the uniform with the given name.
`void`	`setUniformi(String name, int value1, int value2, int value3, int value4)` Sets the uniform with the given name.
`void`	`setUniformMatrix(int location, Matrix3 matrix)`
`void`	`setUniformMatrix(int location, Matrix3 matrix, boolean transpose)`
`void`	`setUniformMatrix(int location, Matrix4 matrix)`
`void`	`setUniformMatrix(int location, Matrix4 matrix, boolean transpose)`
`void`	`setUniformMatrix(String name, Matrix3 matrix)` Sets the uniform matrix with the given name.
`void`	`setUniformMatrix(String name, Matrix3 matrix, boolean transpose)` Sets the uniform matrix with the given name.
`void`	`setUniformMatrix(String name, Matrix4 matrix)` Sets the uniform matrix with the given name.
`void`	`setUniformMatrix(String name, Matrix4 matrix, boolean transpose)` Sets the uniform matrix with the given name.
`void`	`setUniformMatrix3fv(String name, FloatBuffer buffer, int count, boolean transpose)` Sets an array of uniform matrices with the given name.
`void`	`setUniformMatrix4fv(int location, float[] values, int offset, int length)`
`void`	`setUniformMatrix4fv(String name, float[] values, int offset, int length)`
`void`	`setUniformMatrix4fv(String name, FloatBuffer buffer, int count, boolean transpose)` Sets an array of uniform matrices with the given name.
`void`	`setVertexAttribute(int location, int size, int type, boolean normalize, int stride, Buffer buffer)`
`void`	`setVertexAttribute(int location, int size, int type, boolean normalize, int stride, int offset)`
`void`	`setVertexAttribute(String name, int size, int type, boolean normalize, int stride, Buffer buffer)` Sets the vertex attribute with the given name.
`void`	`setVertexAttribute(String name, int size, int type, boolean normalize, int stride, int offset)` Sets the vertex attribute with the given name.

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

- Field Detail
  - POSITION_ATTRIBUTE
```
public static final String POSITION_ATTRIBUTE
```
    default name for position attributes
    
    See Also:
    Constant Field Values
  - NORMAL_ATTRIBUTE
```
public static final String NORMAL_ATTRIBUTE
```
    default name for normal attributes
    
    See Also:
    Constant Field Values
  - COLOR_ATTRIBUTE
```
public static final String COLOR_ATTRIBUTE
```
    default name for color attributes
    
    See Also:
    Constant Field Values
  - TEXCOORD_ATTRIBUTE
```
public static final String TEXCOORD_ATTRIBUTE
```
    default name for texcoords attributes, append texture unit number
    
    See Also:
    Constant Field Values
  - TANGENT_ATTRIBUTE
```
public static final String TANGENT_ATTRIBUTE
```
    default name for tangent attribute
    
    See Also:
    Constant Field Values
  - BINORMAL_ATTRIBUTE
```
public static final String BINORMAL_ATTRIBUTE
```
    default name for binormal attribute
    
    See Also:
    Constant Field Values
  - pedantic
```
public static boolean pedantic
```
    flag indicating whether attributes & uniforms must be present at all times
- Constructor Detail
  - ShaderProgram
```
public ShaderProgram(String vertexShader,
             String fragmentShader)
```
    Constructs a new ShaderProgram and immediately compiles it.
    
    Parameters:
    vertexShader - the vertex shader
    fragmentShader - the fragment shader
  - ShaderProgram
```
public ShaderProgram(FileHandle vertexShader,
             FileHandle fragmentShader)
```
- Method Detail
  - getLog
```
public String getLog()
```
    Returns:
    the log info for the shader compilation and program linking stage. The shader needs to be bound for this method to have an effect.
  - isCompiled
```
public boolean isCompiled()
```
    Returns:
    whether this ShaderProgram compiled successfully.
  - fetchUniformLocation
```
public int fetchUniformLocation(String name,
                       boolean pedantic)
```
  - setUniformi
```
public void setUniformi(String name,
               int value)
```
    Sets the uniform with the given name. Throws an IllegalArgumentException in case it is not called in between a begin()/end() block.
    
    Parameters:
    name - the name of the uniform
    value - the value
  - setUniformi
```
public void setUniformi(int location,
               int value)
```
  - setUniformi
```
public void setUniformi(String name,
               int value1,
               int value2)
```
    Sets the uniform with the given name. Throws an IllegalArgumentException in case it is not called in between a begin()/end() block.
    
    Parameters:
    name - the name of the uniform
    value1 - the first value
    value2 - the second value
  - setUniformi
```
public void setUniformi(int location,
               int value1,
               int value2)
```
  - setUniformi
```
public void setUniformi(String name,
               int value1,
               int value2,
               int value3)
```
    Sets the uniform with the given name. Throws an IllegalArgumentException in case it is not called in between a begin()/end() block.
    
    Parameters:
    name - the name of the uniform
    value1 - the first value
    value2 - the second value
    value3 - the third value
  - setUniformi
```
public void setUniformi(int location,
               int value1,
               int value2,
               int value3)
```
  - setUniformi
```
public void setUniformi(String name,
               int value1,
               int value2,
               int value3,
               int value4)
```
    Sets the uniform with the given name. Throws an IllegalArgumentException in case it is not called in between a begin()/end() block.
    
    Parameters:
    name - the name of the uniform
    value1 - the first value
    value2 - the second value
    value3 - the third value
    value4 - the fourth value
  - setUniformi
```
public void setUniformi(int location,
               int value1,
               int value2,
               int value3,
               int value4)
```
  - setUniformf
```
public void setUniformf(String name,
               float value)
```
    Sets the uniform with the given name. Throws an IllegalArgumentException in case it is not called in between a begin()/end() block.
    
    Parameters:
    name - the name of the uniform
    value - the value
  - setUniformf
```
public void setUniformf(int location,
               float value)
```
  - setUniformf
```
public void setUniformf(String name,
               float value1,
               float value2)
```
    Sets the uniform with the given name. Throws an IllegalArgumentException in case it is not called in between a begin()/end() block.
    
    Parameters:
    name - the name of the uniform
    value1 - the first value
    value2 - the second value
  - setUniformf
```
public void setUniformf(int location,
               float value1,
               float value2)
```
  - setUniformf
```
public void setUniformf(String name,
               float value1,
               float value2,
               float value3)
```
    Sets the uniform with the given name. Throws an IllegalArgumentException in case it is not called in between a begin()/end() block.
    
    Parameters:
    name - the name of the uniform
    value1 - the first value
    value2 - the second value
    value3 - the third value
  - setUniformf
```
public void setUniformf(int location,
               float value1,
               float value2,
               float value3)
```
  - setUniformf
```
public void setUniformf(String name,
               float value1,
               float value2,
               float value3,
               float value4)
```
    Sets the uniform with the given name. Throws an IllegalArgumentException in case it is not called in between a begin()/end() block.
    
    Parameters:
    name - the name of the uniform
    value1 - the first value
    value2 - the second value
    value3 - the third value
    value4 - the fourth value
  - setUniformf
```
public void setUniformf(int location,
               float value1,
               float value2,
               float value3,
               float value4)
```
  - setUniform1fv
```
public void setUniform1fv(String name,
                 float[] values,
                 int offset,
                 int length)
```
  - setUniform1fv
```
public void setUniform1fv(int location,
                 float[] values,
                 int offset,
                 int length)
```
  - setUniform2fv
```
public void setUniform2fv(String name,
                 float[] values,
                 int offset,
                 int length)
```
  - setUniform2fv
```
public void setUniform2fv(int location,
                 float[] values,
                 int offset,
                 int length)
```
  - setUniform3fv
```
public void setUniform3fv(String name,
                 float[] values,
                 int offset,
                 int length)
```
  - setUniform3fv
```
public void setUniform3fv(int location,
                 float[] values,
                 int offset,
                 int length)
```
  - setUniform4fv
```
public void setUniform4fv(String name,
                 float[] values,
                 int offset,
                 int length)
```
  - setUniform4fv
```
public void setUniform4fv(int location,
                 float[] values,
                 int offset,
                 int length)
```
  - setUniformMatrix
```
public void setUniformMatrix(String name,
                    Matrix4 matrix)
```
    Sets the uniform matrix with the given name. Throws an IllegalArgumentException in case it is not called in between a begin()/end() block.
    
    Parameters:
    name - the name of the uniform
    matrix - the matrix
  - setUniformMatrix
```
public void setUniformMatrix(String name,
                    Matrix4 matrix,
                    boolean transpose)
```
    Sets the uniform matrix with the given name. Throws an IllegalArgumentException in case it is not called in between a begin()/end() block.
    
    Parameters:
    name - the name of the uniform
    matrix - the matrix
    transpose - whether the matrix should be transposed
  - setUniformMatrix
```
public void setUniformMatrix(int location,
                    Matrix4 matrix)
```
  - setUniformMatrix
```
public void setUniformMatrix(int location,
                    Matrix4 matrix,
                    boolean transpose)
```
  - setUniformMatrix
```
public void setUniformMatrix(String name,
                    Matrix3 matrix)
```
    Sets the uniform matrix with the given name. Throws an IllegalArgumentException in case it is not called in between a begin()/end() block.
    
    Parameters:
    name - the name of the uniform
    matrix - the matrix
  - setUniformMatrix
```
public void setUniformMatrix(String name,
                    Matrix3 matrix,
                    boolean transpose)
```
    Sets the uniform matrix with the given name. Throws an IllegalArgumentException in case it is not called in between a begin()/end() block.
    
    Parameters:
    name - the name of the uniform
    matrix - the matrix
    transpose - whether the uniform matrix should be transposed
  - setUniformMatrix
```
public void setUniformMatrix(int location,
                    Matrix3 matrix)
```
  - setUniformMatrix
```
public void setUniformMatrix(int location,
                    Matrix3 matrix,
                    boolean transpose)
```
  - setUniformMatrix3fv
```
public void setUniformMatrix3fv(String name,
                       FloatBuffer buffer,
                       int count,
                       boolean transpose)
```
    Sets an array of uniform matrices with the given name. Throws an IllegalArgumentException in case it is not called in between a begin()/end() block.
    
    Parameters:
    name - the name of the uniform
    buffer - buffer containing the matrix data
    transpose - whether the uniform matrix should be transposed
  - setUniformMatrix4fv
```
public void setUniformMatrix4fv(String name,
                       FloatBuffer buffer,
                       int count,
                       boolean transpose)
```
    Sets an array of uniform matrices with the given name. Throws an IllegalArgumentException in case it is not called in between a begin()/end() block.
    
    Parameters:
    name - the name of the uniform
    buffer - buffer containing the matrix data
    transpose - whether the uniform matrix should be transposed
  - setUniformMatrix4fv
```
public void setUniformMatrix4fv(int location,
                       float[] values,
                       int offset,
                       int length)
```
  - setUniformMatrix4fv
```
public void setUniformMatrix4fv(String name,
                       float[] values,
                       int offset,
                       int length)
```
  - setUniformf
```
public void setUniformf(String name,
               Vector2 values)
```
    Sets the uniform with the given name. Throws an IllegalArgumentException in case it is not called in between a begin()/end() block.
    
    Parameters:
    name - the name of the uniform
    values - x and y as the first and second values respectively
  - setUniformf
```
public void setUniformf(int location,
               Vector2 values)
```
  - setUniformf
```
public void setUniformf(String name,
               Vector3 values)
```
    Sets the uniform with the given name. Throws an IllegalArgumentException in case it is not called in between a begin()/end() block.
    
    Parameters:
    name - the name of the uniform
    values - x, y and z as the first, second and third values respectively
  - setUniformf
```
public void setUniformf(int location,
               Vector3 values)
```
  - setUniformf
```
public void setUniformf(String name,
               Color values)
```
    Sets the uniform with the given name. Throws an IllegalArgumentException in case it is not called in between a begin()/end() block.
    
    Parameters:
    name - the name of the uniform
    values - r, g, b and a as the first through fourth values respectively
  - setUniformf
```
public void setUniformf(int location,
               Color values)
```
  - setVertexAttribute
```
public void setVertexAttribute(String name,
                      int size,
                      int type,
                      boolean normalize,
                      int stride,
                      Buffer buffer)
```
    Sets the vertex attribute with the given name. Throws an IllegalArgumentException in case it is not called in between a begin()/end() block.
    
    Parameters:
    name - the attribute name
    size - the number of components, must be >= 1 and <= 4
    type - the type, must be one of GL20.GL_BYTE, GL20.GL_UNSIGNED_BYTE, GL20.GL_SHORT, GL20.GL_UNSIGNED_SHORT,GL20.GL_FIXED, or GL20.GL_FLOAT. GL_FIXED will not work on the desktop
    normalize - whether fixed point data should be normalized. Will not work on the desktop
    stride - the stride in bytes between successive attributes
    buffer - the buffer containing the vertex attributes.
  - setVertexAttribute
```
public void setVertexAttribute(int location,
                      int size,
                      int type,
                      boolean normalize,
                      int stride,
                      Buffer buffer)
```
  - setVertexAttribute
```
public void setVertexAttribute(String name,
                      int size,
                      int type,
                      boolean normalize,
                      int stride,
                      int offset)
```
    Sets the vertex attribute with the given name. Throws an IllegalArgumentException in case it is not called in between a begin()/end() block.
    
    Parameters:
    name - the attribute name
    size - the number of components, must be >= 1 and <= 4
    type - the type, must be one of GL20.GL_BYTE, GL20.GL_UNSIGNED_BYTE, GL20.GL_SHORT, GL20.GL_UNSIGNED_SHORT,GL20.GL_FIXED, or GL20.GL_FLOAT. GL_FIXED will not work on the desktop
    normalize - whether fixed point data should be normalized. Will not work on the desktop
    stride - the stride in bytes between successive attributes
    offset - byte offset into the vertex buffer object bound to GL20.GL_ARRAY_BUFFER.
  - setVertexAttribute
```
public void setVertexAttribute(int location,
                      int size,
                      int type,
                      boolean normalize,
                      int stride,
                      int offset)
```
  - begin
```
public void begin()
```
    Makes OpenGL ES 2.0 use this vertex and fragment shader pair. When you are done with this shader you have to call end().
  - end
```
public void end()
```
    Disables this shader. Must be called when one is done with the shader. Don't mix it with dispose, that will release the shader resources.
  - dispose
```
public void dispose()
```
    Disposes all resources associated with this shader. Must be called when the shader is no longer used.
    
    Specified by:
    
    dispose in interface Disposable
  - disableVertexAttribute
```
public void disableVertexAttribute(String name)
```
    Disables the vertex attribute with the given name
    
    Parameters:
    name - the vertex attribute name
  - disableVertexAttribute
```
public void disableVertexAttribute(int location)
```
  - enableVertexAttribute
```
public void enableVertexAttribute(String name)
```
    Enables the vertex attribute with the given name
    
    Parameters:
    name - the vertex attribute name
  - enableVertexAttribute
```
public void enableVertexAttribute(int location)
```
  - invalidateAllShaderPrograms
```
public static void invalidateAllShaderPrograms(Application app)
```
    Invalidates all shaders so the next time they are used new handles are generated
    
    Parameters:
    app -
  - clearAllShaderPrograms
```
public static void clearAllShaderPrograms(Application app)
```
  - getManagedStatus
```
public static String getManagedStatus()
```
  - setAttributef
```
public void setAttributef(String name,
                 float value1,
                 float value2,
                 float value3,
                 float value4)
```
    Sets the given attribute
    
    Parameters:
    name - the name of the attribute
    value1 - the first value
    value2 - the second value
    value3 - the third value
    value4 - the fourth value
  - hasAttribute
```
public boolean hasAttribute(String name)
```
    Parameters:
    name - the name of the attribute
    
    Returns:
    whether the attribute is available in the shader
  - getAttributeType
```
public int getAttributeType(String name)
```
    Parameters:
    name - the name of the attribute
    
    Returns:
    the type of the attribute, one of GL20.GL_FLOAT, GL20.GL_FLOAT_VEC2 etc.
  - getAttributeLocation
```
public int getAttributeLocation(String name)
```
    Parameters:
    name - the name of the attribute
    
    Returns:
    the location of the attribute or -1.
  - getAttributeSize
```
public int getAttributeSize(String name)
```
    Parameters:
    name - the name of the attribute
    
    Returns:
    the size of the attribute or 0.
  - hasUniform
```
public boolean hasUniform(String name)
```
    Parameters:
    name - the name of the uniform
    
    Returns:
    whether the uniform is available in the shader
  - getUniformType
```
public int getUniformType(String name)
```
    Parameters:
    name - the name of the uniform
    
    Returns:
    the type of the uniform, one of GL20.GL_FLOAT, GL20.GL_FLOAT_VEC2 etc.
  - getUniformLocation
```
public int getUniformLocation(String name)
```
    Parameters:
    name - the name of the uniform
    
    Returns:
    the location of the uniform or -1.
  - getUniformSize
```
public int getUniformSize(String name)
```
    Parameters:
    name - the name of the uniform
    
    Returns:
    the size of the uniform or 0.
  - getAttributes
```
public String[] getAttributes()
```
    Returns:
    the attributes
  - getUniforms
```
public String[] getUniforms()
```
    Returns:
    the uniforms
  - getVertexShaderSource
```
public String getVertexShaderSource()
```
    Returns:
    the source of the vertex shader
  - getFragmentShaderSource
```
public String getFragmentShaderSource()
```
    Returns:
    the source of the fragment shader

Class ShaderProgram

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

POSITION_ATTRIBUTE

NORMAL_ATTRIBUTE

COLOR_ATTRIBUTE

TEXCOORD_ATTRIBUTE

TANGENT_ATTRIBUTE

BINORMAL_ATTRIBUTE

pedantic

Constructor Detail

ShaderProgram

ShaderProgram

Method Detail

getLog

isCompiled

fetchUniformLocation

setUniformi

setUniformi

setUniformi

setUniformi

setUniformi

setUniformi

setUniformi

setUniformi

setUniformf

setUniformf

setUniformf

setUniformf

setUniformf

setUniformf

setUniformf

setUniformf

setUniform1fv

setUniform1fv

setUniform2fv

setUniform2fv

setUniform3fv

setUniform3fv

setUniform4fv

setUniform4fv

setUniformMatrix

setUniformMatrix

setUniformMatrix

setUniformMatrix

setUniformMatrix

setUniformMatrix

setUniformMatrix

setUniformMatrix

setUniformMatrix3fv

setUniformMatrix4fv

setUniformMatrix4fv

setUniformMatrix4fv

setUniformf

setUniformf

setUniformf

setUniformf

setUniformf

setUniformf

setVertexAttribute

setVertexAttribute

setVertexAttribute

setVertexAttribute

begin

end

dispose

disableVertexAttribute

disableVertexAttribute

enableVertexAttribute

enableVertexAttribute

invalidateAllShaderPrograms

clearAllShaderPrograms

getManagedStatus

setAttributef

hasAttribute

getAttributeType

getAttributeLocation