summaryrefslogtreecommitdiffstats
path: root/make
diff options
context:
space:
mode:
authorSven Gothel <[email protected]>2009-10-18 09:08:13 -0700
committerSven Gothel <[email protected]>2009-10-18 09:08:13 -0700
commit1222d9c3329469efa23c5cbf106059359db132a4 (patch)
tree74350d35fb5d55a9716a9db0dbd1bd41ac4808d8 /make
parent52d180d27f62f096542615499ce670f2ba9a76ee (diff)
Fix JavaDoc for GL3bc
Diffstat (limited to 'make')
-rw-r--r--make/config/jogl/gl-common.cfg13
-rw-r--r--make/doc/jogl/spec-overview.html34
2 files changed, 30 insertions, 17 deletions
diff --git a/make/config/jogl/gl-common.cfg b/make/config/jogl/gl-common.cfg
index 37c030cb5..d9d66323a 100644
--- a/make/config/jogl/gl-common.cfg
+++ b/make/config/jogl/gl-common.cfg
@@ -569,7 +569,7 @@ RangeCheck glDeleteVertexArraysAPPLE 1 {0}
# Javadoc for the GL class
ClassJavadoc GL /**
-ClassJavadoc GL * <P> Common interface containing the subset of all profiles, GL3, GL2, GLES1 and GLES2.<br>
+ClassJavadoc GL * <P> Common interface containing the subset of all profiles, GL3bc, GL3, GL2, GLES1 and GLES2.<br>
ClassJavadoc GL * This interface reflects common data types, texture and framebuffer functionality.</P>
ClassJavadoc GL */
@@ -589,7 +589,7 @@ ClassJavadoc GL2ES2 */
ClassJavadoc GL2GL3 /**
ClassJavadoc GL2GL3 * <P>
-ClassJavadoc GL2GL3 * Interface containing the common subset of GL3 (OpenGL 3.1+) and GL2 (OpenGL 3.0),
+ClassJavadoc GL2GL3 * Interface containing the common subset of core GL3 (OpenGL 3.1+) and GL2 (OpenGL 3.0),
ClassJavadoc GL2GL3 * also known as the OpenGL 3.0 forward compatible, non deprecated subset.<br>
ClassJavadoc GL2GL3 * This interface reflects only the programmable shader functionality of desktop OpenGL<br>
ClassJavadoc GL2GL3 * </P>
@@ -603,11 +603,18 @@ ClassJavadoc GL2 * time of this specification. Early OpenGL extensions whose f
ClassJavadoc GL2 * was incorporated into core OpenGL by version 3.0, inclusive, are specifically
ClassJavadoc GL2 * excluded.<br>
ClassJavadoc GL2 * Note: OpenGL 3.0 is the last subsumed version in the specification.
-ClassJavadoc GL2 * You need to use a {@link GL3} OpenGL 3.1+ context to benefit
+ClassJavadoc GL2 * You need to use a {@link GL3} or {@link GL3bc} OpenGL 3.1+ context to benefit
ClassJavadoc GL2 * from new functionality and versions.
ClassJavadoc GL2 * </P>
ClassJavadoc GL2 */
+ClassJavadoc GL3bc /**
+ClassJavadoc GL3bc * <P>
+ClassJavadoc GL3bc * This interface contains the OpenGL 3.x compatibility profile, ie includes all methods
+ClassJavadoc GL3bc * as defined in {@link GL2} and {@link GL3}.<br>
+ClassJavadoc GL3bc * </P>
+ClassJavadoc GL3bc */
+
ClassJavadoc GL3 /**
ClassJavadoc GL3 * <P>
ClassJavadoc GL3 * This interface contains all core, forward compatible, OpenGL methods starting from 3.1,
diff --git a/make/doc/jogl/spec-overview.html b/make/doc/jogl/spec-overview.html
index 26936e63e..251fcf9dd 100644
--- a/make/doc/jogl/spec-overview.html
+++ b/make/doc/jogl/spec-overview.html
@@ -12,7 +12,7 @@
bindings to the native OpenGL(R) 3D graphics library profiles:
<ul>
<li> Desktop OpenGL 1.0 - 3.0 </li>
- <li> Desktop OpenGL 3.x, with x >= 1, forward compatible, core profile </li>
+ <li> Desktop OpenGL 3.x, with x >= 1, forward compatible, core profile - and compatibility profile </li>
<li> Embedded OpenGL ES 1.x, with x >= 0 </li>
<li> Embedded OpenGL ES 2.x, with x >= 0 </li>
</ul><br>
@@ -59,17 +59,6 @@ bindings to the native OpenGL(R) 3D graphics library profiles:
See <a href="#GLRuntimeVersion">OpenGL Runtime Requirements</a>.<br>
The main OpenGL profile interfaces are:<br><br>
<ul>
- <li> {@link javax.media.opengl.GL3 javax.media.opengl.GL3} interface<br>
- <br>
- This interface contains all core, forward compatible, OpenGL methods starting from 3.1,
-inclusive, as well as most of it's extensions defined at the time of this specification. <br>
- Note: OpenGL 3.0 forward compatible, non deprecated functionality is included in the
- 3.1 specification, hence the {@link javax.media.opengl.GL2GL3} implemented interface.<br>
- Note: OpenGL 3.1 forward compatible no more includes fixed point functionality.<br>
- See <a href="#GL3InclusionCriteria">GL3 Inclusion Criteria</a>.<br>
- See <a href="#GL3RuntimeVersion">GL3 Runtime Requirements</a>.<br>
- Future extensions will be added with a <a href="#maintenanceupdates">maintenance update</a></li><br>
-
<li> {@link javax.media.opengl.GL2 javax.media.opengl.GL2} interface<br>
<br>
This interface contains all core desktop OpenGL methods through
@@ -84,6 +73,23 @@ was incorporated into core OpenGL until version 3.1, inclusive, are subsumed int
See <a href="#GL2RuntimeVersion">GL2 Runtime Requirements</a>.<br>
Future extensions will be added with a <a href="#maintenanceupdates">maintenance update</a></li><br>
+ <li> {@link javax.media.opengl.GL3 javax.media.opengl.GL3} interface<br>
+ <br>
+ This interface contains all core, forward compatible, OpenGL methods starting from 3.1,
+inclusive, as well as most of it's extensions defined at the time of this specification. <br>
+ Note: OpenGL 3.0 forward compatible, non deprecated functionality is included in the
+ 3.1 specification, hence the {@link javax.media.opengl.GL2GL3} implemented interface.<br>
+ Note: OpenGL 3.1 forward compatible no more includes fixed point functionality.<br>
+ See <a href="#GL3InclusionCriteria">GL3 Inclusion Criteria</a>.<br>
+ See <a href="#GL3RuntimeVersion">GL3 Runtime Requirements</a>.<br>
+ Future extensions will be added with a <a href="#maintenanceupdates">maintenance update</a></li><br>
+
+ <li> {@link javax.media.opengl.GL3bc javax.media.opengl.GL3bc} interface<br>
+ <br>
+ This interface contains the OpenGL 3.x compatibility profile,<br>
+ ie includes all methods as defined in {@link javax.media.opengl.GL2} and {@link javax.media.opengl.GL3}.<br>
+ Future extensions will be added with a <a href="#maintenanceupdates">maintenance update</a></li><br>
+
<li> {@link javax.media.opengl.GLES1 javax.media.opengl.GLES1} interface<br>
<br>
This interface contains all core embedded OpenGL methods of ES 1.x, with x >= 0,
@@ -110,7 +116,7 @@ time of this specification. <br>
<li> {@link javax.media.opengl.GL javax.media.opengl.GL} interface<br>
<br>
- Common interface containing the subset of all profiles, GL3, GL2, GLES1 and GLES2.<br>
+ Common interface containing the subset of all profiles, GL3bc, GL3, GL2, GLES1 and GLES2.<br>
This interface reflects common data types, texture and framebuffer functionality.</li><br>
<li> {@link javax.media.opengl.GL2ES1 javax.media.opengl.GL2ES1} interface<br>
@@ -125,7 +131,7 @@ time of this specification. <br>
<li> {@link javax.media.opengl.GL2GL3 javax.media.opengl.GL2GL3} interface<br>
<br>
- Interface containing the common subset of GL3 (OpenGL 3.1+) and GL2 (OpenGL 3.0),
+ Interface containing the common subset of core GL3 (OpenGL 3.1+) and GL2 (OpenGL 3.0),
also known as the OpenGL 3.0 forward compatible, non deprecated subset.<br>
This interface reflects only the programmable shader functionality of desktop OpenGL</li><br>
</ul>