com.sun.prism.es2

Class ES2Shader

java.lang.Object

com.sun.prism.impl.BaseGraphicsResource

com.sun.prism.es2.ES2Shader

All Implemented Interfaces:

GraphicsResource, Shader

public class ES2Shader
extends BaseGraphicsResource
implements Shader

Represents an OpenGL shader program object, which can be constructed from the source code for a vertex shader, a fragment shader, or both. Contains convenience methods for enabling/disabling shader state.

Usage example:

     String source =
         "uniform sampler2D myTex;" +
         "void main(void)" +
         "{" +
         "    vec4 src = texture2D(myTex, gl_TexCoord[0].st);" +
         "    gl_FragColor = src.bgra;" + // swizzle!
         "}";
     ES2Shader shader = new ES2Shader(source);
     shader.setConstant("myTex", 0); // myTex will be on texture unit 0
     ...
     shader.enable();
     texture.enable();
     texture.bind();
     ...
     texture.disable();
     shader.disable();
 };
 

Field Summary

Fields inherited from class com.sun.prism.impl.BaseGraphicsResource

disposerRecord

Method Summary

Modifier and Type	Method and Description
void	disable() Disables this shader program in the current GL context's state.
void	dispose() Disposes the native resources used by this program object.
void	enable() Enables this shader program in the current GL context's state.
int	getMaxTexCoordIndex() Returns the maximum texcoord index referenced by this shader program.
int	getProgramObject() Returns the underlying OpenGL program object handle for this fragment shader.
boolean	isPixcoordUsed() Returns true if this shader uses the special pixcoord variable, otherwise returns false
boolean	isValid() Returns whether this shader is valid and can be used for rendering.
void	setConstant(String name, float f0) Sets the uniform variable of the given name with the provided float value.
void	setConstant(String name, float f0, float f1) Sets the uniform variable of the given name with the provided float values.
void	setConstant(String name, float f0, float f1, float f2) Sets the uniform variable of the given name with the provided float values.
void	setConstant(String name, float f0, float f1, float f2, float f3) Sets the uniform variable of the given name with the provided float values.
void	setConstant(String name, int i0) Sets the uniform variable of the given name with the provided integer value.
void	setConstant(String name, int i0, int i1) Sets the uniform variable of the given name with the provided integer values.
void	setConstant(String name, int i0, int i1, int i2) Sets the uniform variable of the given name with the provided integer values.
void	setConstant(String name, int i0, int i1, int i2, int i3) Sets the uniform variable of the given name with the provided integer values.
void	setConstants(String name, FloatBuffer buf, int off, int count) Sets the uniform array variable of the given name with the provided float array values.
void	setConstants(String name, IntBuffer buf, int off, int count) Sets the uniform array variable of the given name with the provided int array values.
void	setMatrix(String name, float[] buf) Sets the uniform matrix variable of the given name with the provided float array values.

Methods inherited from class java.lang.Object

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

Method Detail

getProgramObject

public int getProgramObject()

Returns the underlying OpenGL program object handle for this fragment shader. Most applications will not need to access this, since it is handled automatically by the enable() and dispose() methods.

Returns:

the OpenGL program object handle for this fragment shader

getMaxTexCoordIndex

public int getMaxTexCoordIndex()

Returns the maximum texcoord index referenced by this shader program.

Returns:

the maximum texcoord index referenced by this shader program

isPixcoordUsed

public boolean isPixcoordUsed()

Returns true if this shader uses the special pixcoord variable, otherwise returns false

Returns:

true if this shader uses the special pixcoord variable

enable

public void enable()
            throws RuntimeException

Enables this shader program in the current GL context's state.

Specified by:

enable in interface Shader

Throws:

RuntimeException - if no OpenGL context was current or if any OpenGL-related errors occurred

disable

public void disable()
             throws RuntimeException

Disables this shader program in the current GL context's state.

Specified by:

disable in interface Shader

Throws:

RuntimeException - if no OpenGL context was current or if any OpenGL-related errors occurred

isValid

public boolean isValid()

Description copied from interface: Shader

Returns whether this shader is valid and can be used for rendering. Called on the rendering thread.

Specified by:

isValid in interface Shader

Returns:

true if valid, false if not

setConstant

public void setConstant(String name,
                        int i0)
                 throws RuntimeException

Sets the uniform variable of the given name with the provided integer value.

Specified by:

setConstant in interface Shader

Parameters:

name - the name of the uniform variable to be set

i0 - the first uniform parameter

Throws:

RuntimeException - if no OpenGL context was current or if any OpenGL-related errors occurred

setConstant

public void setConstant(String name,
                        int i0,
                        int i1)
                 throws RuntimeException

Sets the uniform variable of the given name with the provided integer values.

Specified by:

setConstant in interface Shader

Parameters:

name - the name of the uniform variable to be set

i0 - the first uniform parameter

i1 - the second uniform parameter

Throws:

RuntimeException - if no OpenGL context was current or if any OpenGL-related errors occurred

setConstant

public void setConstant(String name,
                        int i0,
                        int i1,
                        int i2)
                 throws RuntimeException

Sets the uniform variable of the given name with the provided integer values.

Specified by:

setConstant in interface Shader

Parameters:

name - the name of the uniform variable to be set

i0 - the first uniform parameter

i1 - the second uniform parameter

i2 - the third uniform parameter

Throws:

RuntimeException - if no OpenGL context was current or if any OpenGL-related errors occurred

setConstant

public void setConstant(String name,
                        int i0,
                        int i1,
                        int i2,
                        int i3)
                 throws RuntimeException

Sets the uniform variable of the given name with the provided integer values.

Specified by:

setConstant in interface Shader

Parameters:

name - the name of the uniform variable to be set

i0 - the first uniform parameter

i1 - the second uniform parameter

i2 - the third uniform parameter

i3 - the fourth uniform parameter

Throws:

RuntimeException - if no OpenGL context was current or if any OpenGL-related errors occurred

setConstant

public void setConstant(String name,
                        float f0)
                 throws RuntimeException

Sets the uniform variable of the given name with the provided float value.

Specified by:

setConstant in interface Shader

Parameters:

name - the name of the uniform variable to be set

f0 - the first uniform parameter

Throws:

RuntimeException - if no OpenGL context was current or if any OpenGL-related errors occurred

setConstant

public void setConstant(String name,
                        float f0,
                        float f1)
                 throws RuntimeException

Sets the uniform variable of the given name with the provided float values.

Specified by:

setConstant in interface Shader

Parameters:

name - the name of the uniform variable to be set

f0 - the first uniform parameter

f1 - the second uniform parameter

Throws:

RuntimeException - if no OpenGL context was current or if any OpenGL-related errors occurred

setConstant

public void setConstant(String name,
                        float f0,
                        float f1,
                        float f2)
                 throws RuntimeException

Sets the uniform variable of the given name with the provided float values.

Specified by:

setConstant in interface Shader

Parameters:

name - the name of the uniform variable to be set

f0 - the first uniform parameter

f1 - the second uniform parameter

f2 - the third uniform parameter

Throws:

RuntimeException - if no OpenGL context was current or if any OpenGL-related errors occurred

setConstant

public void setConstant(String name,
                        float f0,
                        float f1,
                        float f2,
                        float f3)
                 throws RuntimeException

Sets the uniform variable of the given name with the provided float values.

Specified by:

setConstant in interface Shader

Parameters:

name - the name of the uniform variable to be set

f0 - the first uniform parameter

f1 - the second uniform parameter

f2 - the third uniform parameter

f3 - the fourth uniform parameter

Throws:

RuntimeException - if no OpenGL context was current or if any OpenGL-related errors occurred

setConstants

public void setConstants(String name,
                         IntBuffer buf,
                         int off,
                         int count)
                  throws RuntimeException

Sets the uniform array variable of the given name with the provided int array values.

Specified by:

setConstants in interface Shader

Parameters:

name - the name of the uniform variable to be set

buf - the array values to be set

off - the offset into the vals array

count - the number of ivec4 elements in the array

Throws:

RuntimeException - if no OpenGL context was current or if any OpenGL-related errors occurred

setConstants

public void setConstants(String name,
                         FloatBuffer buf,
                         int off,
                         int count)
                  throws RuntimeException

Sets the uniform array variable of the given name with the provided float array values.

Specified by:

setConstants in interface Shader

Parameters:

name - the name of the uniform variable to be set

buf - the array values to be set

count - the number of vec4 elements in the array

off - the offset into the vals array

Throws:

RuntimeException - if no OpenGL context was current or if any OpenGL-related errors occurred

setMatrix

public void setMatrix(String name,
                      float[] buf)
               throws RuntimeException

Sets the uniform matrix variable of the given name with the provided float array values.

Parameters:

name - the name of the uniform variable to be set

buf - the matrix values to be set

Throws:

RuntimeException - if no OpenGL context was current or if any OpenGL-related errors occurred

dispose

public void dispose()
             throws RuntimeException

Disposes the native resources used by this program object.

Specified by:

dispose in interface GraphicsResource

Specified by:

dispose in class BaseGraphicsResource

Throws:

RuntimeException - if no OpenGL context was current or if any OpenGL-related errors occurred