1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
|
/*
* 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.
*
* <p>
* NOTE: Applications should <i>not</i> 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<br>
*/
/**
* 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.
*
* <p>
* 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();
}
}
}
|
