Shaders in Java 3D^TM 1.4

Introduction and pointer to discussion forum

Here is the latest rough first draft of what we are thinking in terms of programmable shader support in Java 3D^TM for 1.4. We plan to formalize the 1.4 API specification under the auspices of the Java Community Process (JCP). However, we very much want to involve the larger community in API discussions for programmable shaders, so please join in the discussion.

We have created a thread on the Java 3D discussion forum for discussing Java 3D Programmable Shaders. Feel free to post your comments on our ideas, or post some ideas of your own.

Class Hierarchy for Shader Objects

The proposed class hierarchy for programmable shaders in Java 3D is:

• Abstract shader base classes:

public abstract class ShaderProgram extends NodeComponent
public abstract class Shader extends NodeComponent

• Concrete GLSL shader classes:

public class GLSLShaderProgram extends ShaderProgram
    method: {add/remove/get}Shader(GLSLShader) // set of shader objs
    method: {add/remove}ErrorListener(GLSLErrorListener)
    method: validate(Canvas3D) ???

public abstract class GLSLShader extends Shader
    public class GLSLVertexShader extends GLSLShader
	method: set/getShaderSource(String)
	method: validate(Canvas3D) ???
    public class GLSLFragmentShader extends GLSLShader
	method: set/getShaderSource(String)
	method: validate(Canvas3D) ???

• Concrete Cg shader classes:

public class CgShaderProgram extends ShaderProgram
    method: {set/get}VertexShader(CgVertexShader)
    method: {set/get}FragmentShader(CgFramentShader)
    method: {add/remove}ErrorListener(CgErrorListener)
    method: validate(Canvas3D) ???

public abstract class CgShader extends Shader
    public class CgVertexShader extends CgShader
	method: set/getShaderSource(String)
	method: validate(Canvas3D) ???
    public class CgFragmentShader extends CgShader
	method: set/getShaderSource(String)
	method: validate(Canvas3D) ???

• New ShaderAppearance class:

public class ShaderAppearance extends Appearance
    method: set/getShaderProgram(ShaderProgram)
    method: set/getShaderAttributes(ShaderAttributes)

• New SystemAttributes class:

public class SystemAttributes extends NodeComponent
    method: put/getAttribute(String,Object)
    method: putAllAttributes(Map)
    method: removeAttribute(String)
    method: clearAttributes()
    method: getAttributesMap()

    method: put/getSystemAttribute(String,String)
    method: putAllSystemAttributes(Map)
    method: removeSystemAttribute(String)
    method: clearSystemAttributes()
    method: getSystemAttributesMap()

Click on the following link for a preliminary look at the javadoc-generated API definitions for the proposed 1.4 API.

Example Usage

This is an example code excerpt showing how one might use the new programmable shader API in a Java 3D program.

String vertexShaderFile = "my-vertex-shader-file-name";
String fragmentShaderFile = "my-fragment-shader-file-name";
String vertexShaderSource;
String fragmentShaderSource;

// Read GLSL vertex and fragment shader source code from text files
vertexShaderSource = TextFileUtils.readFully(vertexShaderFile);
fragmentShaderSource = TextFileUtils.readFully(fragmentShaderSource);

// Create GLSL vertex and fragment shader objects using the given source code
GLSLVertexShader vertexShader = new GLSLVertexShader(vertexShaderSource);
GLSLFragmentShader fragmentShader = new GLSLFragmentShader(fragmentShaderSource);

// Create the GLSL shader program object and attach the vertex and
// fragment shader objects; add an error listener
GLSLShaderProgram shaderProgram = new GLSLShaderProgram();
shaderProgram.setVertexShader(vertexShader);
shaderProgram.setFragmentShader(fragmentShader);
shaderProgram.addErrorListener(myGLSLErrorListener);

// Use GLSL shader program object in appearance
shaderAppearance.setShaderProgram(shaderProgram);

Shader Parameters

NOTE: This section is under construction. For the most up to date API definition, please see the javadoc for the new ShaderAttributes class.

Programmable shaders define two types of parameters: uniform and varying. As the names imply, uniform parameters are constant (within a primitive), while varying parameters can vary on per-vertex or per-fragment basis.

1. Uniform parameters (attributes) are those parameters whose value is constant during the rendering of a primitive. Their values may change from primitive to primitive, but are constant for each vertex (for vertex shaders) or fragment (for fragment shaders) of a single primitive. Examples of uniform parameters include a transformation matrix, a texture map, lights, lookup tables, etc.
   
   We have created a new ShaderAttributes object with following new attributes:
   • Attributes Map, expressed as (attrName,value) pairs, for explicitly defined attributes
   • SystemAttributes Map, expressed as (attrName,j3dAttrName) pairs, for implicitly defined attributes
   See the javadoc for the new ShaderAttributes class for more details. Issues
   
   • Should j3dAttrName be specified as a type-safe enum or object instead of a String?
   • How do we handle passing arrays to the shader, especially for system parameters such as lights? One possibility is:
     "var" - scalar variable "var"
     "arr[0]" - array element 0 of "arr"
     "arr[1,3]" - subarray composed of elements 1 through 3 of "arr"
     "arr[]" - entire array "arr"
     
     Alternatively, an object with a string or type-safe enum, a state (scalar, array element, subarray, or entire array), and indices (as needed).
   
   Automatic variables
   Several Java 3D state attributes are automatically available to the shader program as pre-defined uniform parameters. The application doesn't need to do anything to pass these parameters in to the shader program. The implementation of each shader language (e.g., Cg, GLSL) defines its own mapping from Java 3D attribute to uniform variable name.
   
   A partial list of Java 3D attributes that are mapped to shader attributes follows:



Java 3D Attribute	Cg shader variable	GLSL shader variable
ModelViewProjection	glstate.matrix.mvp	gl_ModelViewProjectionMatrix
Light[n] pos	glstate.light[n].position	gl_LightSource[n].position
...	...	...



2. Varying parameters are those parameters that are specified as per-vertex attributes. They are are interpolated across a primitive similarly to colors and texture coordinates in the fixed function pipeline.
   
   We need additional API to allow applications to pass in per-vertex varying parameters...
   TODO: Finish this...
   

TODO: more info here.

Page last updated — $Date$