javax.media.j3d.ShaderProgram Maven / Gradle / Ivy
Show all versions of java3d-core Show documentation
/*
* Copyright 2004-2008 Sun Microsystems, Inc. All Rights Reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Sun designates this
* particular file as subject to the "Classpath" exception as provided
* by Sun in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
* CA 95054 USA or visit www.sun.com if you need additional information or
* have any questions.
*
*/
package javax.media.j3d;
/**
* The ShaderProgram node component object is the abstract base class
* for programmable shader programs. Each concrete instance of a
* ShaderProgram is a container for a set of Shader objects. The set
* of Shaders contained in the ShaderProgram is a complete program for
* the Graphics Pipeline Unit (GPU) of the graphics accelerator. It is
* specified using the shader language defined by the
* ShaderProgram. The currently defined shader languages are: Cg and
* GLSL.
*
*
* NOTE: Applications should not extend this class.
*
* @see Shader
* @see ShaderAppearance#setShaderProgram
*
* @since Java 3D 1.4
*/
public abstract class ShaderProgram extends NodeComponent {
/**
* Specifies that this ShaderProgram object allows reading
* its shaders.
*/
public static final int ALLOW_SHADERS_READ =
CapabilityBits.SHADER_PROGRAM_ALLOW_SHADERS_READ;
/**
* Specifies that this ShaderProgram object allows reading
* its shader or vertex attribute names.
*/
public static final int ALLOW_NAMES_READ =
CapabilityBits.SHADER_PROGRAM_ALLOW_NAMES_READ;
// Array for setting default read capabilities
private static final int[] readCapabilities = {
ALLOW_SHADERS_READ,
ALLOW_NAMES_READ
};
/*
* Default values (copied from GeometryArray.java):
*
* vertexAttrNames : null
*/
/**
* Package scope constructor so it can't be subclassed by classes
* outside the javax.media.j3d package.
*/
ShaderProgram() {
// set default read capabilities
setDefaultReadCapabilities(readCapabilities);
}
/**
* Sets the vertex attribute names array for this ShaderProgram
* object. Each element in the array specifies the shader
* attribute name that is bound to the corresponding numbered
* vertex attribute within a GeometryArray object that uses this
* shader program. Array element 0 specifies the name of
* GeometryArray vertex attribute 0, array element 1 specifies the
* name of GeometryArray vertex attribute 1, and so forth.
* The array of names may be null or empty (0 length), but the
* elements of the array must be non-null.
*
* @param vertexAttrNames array of vertex attribute names for this
* shader program. A copy of this array is made.
*
* @exception RestrictedAccessException if the method is called
* when this object is part of live or compiled scene graph.
*
* @exception NullPointerException if any element in the
* vertexAttrNames array is null.
*/
public abstract void setVertexAttrNames(String[] vertexAttrNames);
/**
* Retrieves the vertex attribute names array from this
* ShaderProgram object.
*
* @exception CapabilityNotSetException if appropriate capability is
* not set and this object is part of live or compiled scene graph
*
* @return a copy of this ShaderProgram's array of vertex attribute names.
*/
public abstract String[] getVertexAttrNames();
/**
* Sets the shader attribute names array for this ShaderProgram
* object. Each element in the array specifies a shader
* attribute name that may be set via a ShaderAttribute object.
* Only those attributes whose names that appear in the shader
* attribute names array can be set for a given shader program.
* The array of names may be null or empty (0 length), but the
* elements of the array must be non-null.
*
*
* TODO: finish this.
*
* @param shaderAttrNames array of shader attribute names for this
* shader program. A copy of this array is made.
*
* @exception RestrictedAccessException if the method is called
* when this object is part of live or compiled scene graph.
*
* @exception NullPointerException if any element in the
* shaderAttrNames array is null.
*/
public abstract void setShaderAttrNames(String[] shaderAttrNames);
/**
* Retrieves the shader attribute names array from this
* ShaderProgram object.
*
* @exception CapabilityNotSetException if appropriate capability is
* not set and this object is part of live or compiled scene graph
*
* @return a copy of this ShaderProgram's array of shader attribute names.
*/
public abstract String[] getShaderAttrNames();
/**
* Copies the specified array of shaders into this shader
* program. This method makes a shallow copy of the array. The
* array of shaders may be null or empty (0 length), but the
* elements of the array must be non-null. The shading
* language of each shader in the array must match the
* subclass. Subclasses may impose additional restrictions.
*
* @param shaders array of Shader objects to be copied into this
* ShaderProgram
*
* @exception RestrictedAccessException if the method is called
* when this object is part of live or compiled scene graph.
*
* @exception IllegalArgumentException if the shading language of
* any shader in the shaders array doesn't match the type of the
* subclass.
*
* @exception NullPointerException if any element in the
* shaders array is null.
*/
public abstract void setShaders(Shader[] shaders);
/**
* Retrieves the array of shaders from this shader program. A
* shallow copy of the array is returned. The return value may
* be null.
*
* @return a copy of this ShaderProgram's array of Shader objects
*
* @exception CapabilityNotSetException if appropriate capability is
* not set and this object is part of live or compiled scene graph
*/
public abstract Shader[] getShaders();
// Default shader error listener class
private static ShaderErrorListener defaultErrorListener = null;
synchronized static ShaderErrorListener getDefaultErrorListener() {
if (defaultErrorListener == null) {
defaultErrorListener = new DefaultErrorListener();
}
return defaultErrorListener;
}
static class DefaultErrorListener implements ShaderErrorListener {
@Override
public void errorOccurred(ShaderError error) {
System.err.println();
System.err.println("DefaultShaderErrorListener.errorOccurred:");
error.printVerbose();
}
}
}