Skip to content

Commit 296f94d

Browse files
committed
Updated comments for PShader.java
1 parent 8a7c957 commit 296f94d

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

core/src/processing/opengl/PShader.java

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,14 +33,16 @@
3333
import java.util.HashMap;
3434

3535
/**
36-
* This class encapsulates a GLSL shader program, including a vertex
37-
* and a fragment shader. Based on the GLSLShader class from GLGraphics, which
38-
* in turn was originally based in the code by JohnG:
39-
* http://processing.org/discourse/beta/num_1159494801.html
36+
* This class encapsulates a GLSL shader program, including a vertex and a
37+
* fragment shader. It's compatible with the P2D and P3D renderers, but not with
38+
* the default renderer. Use the <b>loadShader()</b> function to load your
39+
* shader code. [Note: It's strongly encouraged to use <b>loadShader()</b> to
40+
* create a PShader object, rather than calling the PShader constructor
41+
* manually.]
4042
*
4143
* @webref rendering:shaders
4244
* @webBrief This class encapsulates a GLSL shader program, including a vertex
43-
* and a fragment shader.
45+
* and a fragment shader.
4446
*/
4547
public class PShader implements PConstants {
4648
static protected final int POINT = 0;
@@ -384,7 +386,8 @@ public boolean bound() {
384386
}
385387

386388
/**
387-
* Sets a variable within the shader
389+
* Sets the uniform variables inside the shader to modify the effect while the
390+
* program is running.
388391
*
389392
* @webref rendering:shaders
390393
* @webBrief Sets a variable within the shader

0 commit comments

Comments
 (0)