summaryrefslogtreecommitdiffstats
path: root/make
diff options
context:
space:
mode:
Diffstat (limited to 'make')
-rw-r--r--make/gl-common.cfg28
1 files changed, 19 insertions, 9 deletions
diff --git a/make/gl-common.cfg b/make/gl-common.cfg
index f04f4c582..aa680eb62 100644
--- a/make/gl-common.cfg
+++ b/make/gl-common.cfg
@@ -197,19 +197,29 @@ ArgumentIsString glGetAttribLocationARB 1
# Javadoc for the GL class
ClassJavadoc GL /**
ClassJavadoc GL * <P> The basic interface to OpenGL, providing access to core
-ClassJavadoc GL * functionality up through the OpenGL 1.4 specification as well as
+ClassJavadoc GL * functionality up through the OpenGL 2.0 specification as well as
ClassJavadoc GL * all vendor extensions. </P>
ClassJavadoc GL *
ClassJavadoc GL * <P> While the APIs for vendor extensions are unconditionally
ClassJavadoc GL * exposed, the underlying functions may not be present. The method
ClassJavadoc GL * {@link #isFunctionAvailable} should be used to query the
ClassJavadoc GL * availability of any non-core function before it is used for the
-ClassJavadoc GL * first time. On certain platforms (Windows in particular), the most
-ClassJavadoc GL * "core" functionality is only OpenGL 1.1, so in theory any routines
-ClassJavadoc GL * first exposed in OpenGL 1.2, 1.3, and 1.4 as well as vendor
+ClassJavadoc GL * first time; for example,
+ClassJavadoc GL * <code>gl.isFunctionAvailable("glProgramStringARB")</code>. On
+ClassJavadoc GL * certain platforms (Windows in particular), the most "core"
+ClassJavadoc GL * functionality is only OpenGL 1.1, so in theory any routines first
+ClassJavadoc GL * exposed in OpenGL 1.2, 1.3, and 1.4, 1.5, or 2.0 as well as vendor
ClassJavadoc GL * extensions should all be queried. Calling an unavailable function
ClassJavadoc GL * will cause a {@link GLException} to be raised. </P>
ClassJavadoc GL *
+ClassJavadoc GL * {@link #isExtensionAvailable} may also be used to determine whether
+ClassJavadoc GL * a specific extension is available before calling the routines or
+ClassJavadoc GL * using the functionality it exposes: for example,
+ClassJavadoc GL * <code>gl.isExtensionAvailable("GL_ARB_vertex_program");</code>.
+ClassJavadoc GL * However, in this case it is up to the end user to know which
+ClassJavadoc GL * routines or functionality are associated with which OpenGL
+ClassJavadoc GL * extensions.
+ClassJavadoc GL *
ClassJavadoc GL * <P> Access to window system-specific extensions is provided through
ClassJavadoc GL * the {@link WGL} and {@link GLX} interfaces. However, most of these
ClassJavadoc GL * extensions require access to low-level window system data
@@ -231,11 +241,11 @@ ClassJavadoc GL * #isFunctionAvailable} will translate an argument of
ClassJavadoc GL * "glAllocateMemoryNV" or "glFreeMemoryNV" into the appropriate
ClassJavadoc GL * window system-specific name. </P>
ClassJavadoc GL *
-ClassJavadoc GL * <LI> WGL_ARB_pbuffer and WGL_ARB_pixel_format; these extensions have been
-ClassJavadoc GL * exposed with the names "GL_ARB_pbuffer" and "GL_ARB_pixel_format" for
-ClassJavadoc GL * platform independence. When pbuffer support is added to the X11 port of
-ClassJavadoc GL * Jogl, the semantics of querying for these platform-independent extension
-ClassJavadoc GL * names will be preserved.
+ClassJavadoc GL * <LI> WGL_ARB_pbuffer, WGL_ARB_pixel_format, and other
+ClassJavadoc GL * platform-specific pbuffer functionality; the availability of
+ClassJavadoc GL * pbuffers can be queried on Windows, X11 and Mac OS X platforms by
+ClassJavadoc GL * querying {@link #isExtensionAvailable} with an argument of
+ClassJavadoc GL * "GL_ARB_pbuffer" or "GL_ARB_pixel_format".
ClassJavadoc GL *
ClassJavadoc GL * </UL> <P>
ClassJavadoc GL *