From bfb10d309d97c19a33f9b6758f647186f8e0ddd6 Mon Sep 17 00:00:00 2001 From: Sven Gothel Date: Wed, 17 Jul 2013 06:32:52 +0200 Subject: JOGL API Doc: Remove 'JSR 231' identifier - we are no more bound to a JSR, for a long time! --- make/doc/jogl/spec-overview.html | 472 ++++++++++++++++++--------------------- 1 file changed, 215 insertions(+), 257 deletions(-) (limited to 'make/doc') diff --git a/make/doc/jogl/spec-overview.html b/make/doc/jogl/spec-overview.html index 8c9f45f8b..637b39a2e 100644 --- a/make/doc/jogl/spec-overview.html +++ b/make/doc/jogl/spec-overview.html @@ -1,25 +1,23 @@ - JSR 231 Draft Public Review Specification + JOGL Specification Overview -

JSR 231 Specification Overview

+

JOGL Specification Overview

Preface

This specification, an optional set of packages, describes the Java(TM) bindings to the native OpenGL(R) 3D graphics library profiles:
- See Inclusion Criteria explaining the OpenGL profile seperation.
+ See Inclusion Criteria explaining the OpenGL profile separation.
See OpenGL Runtime Requirements.

- A sample implementation is available as + An implementation is available as JOGL, a JogAmp module.

Other API bindings are available as JogAmp modules: @@ -31,137 +29,146 @@ bindings to the native OpenGL(R) 3D graphics library profiles:

Dependencies

This binding has dependencies to the following:


OpenGL Profile Model

- OpenGL today is not just a single set of functionality, it offers many profiles for different - purposes, e.g. ES1 and ES2 for mobile, etc.
- JOGL reflects these profiles with an OO abstraction model, + OpenGL today is not just a single set of functions, it offers many profiles for different + purposes, e.g. ES1, ES2 and ES3 for mobile, GL [ 3.1 .. 4.3 ] core for a programmable shader application, etc.
+ JOGL reflects these profiles with an OO abstraction model, specifying interfaces encapsulating common subsets.

Package Structure

The packages defined by this specification include:
-
+which are not exposed.

+

API Binding Conventions

The Java language bindings to the pre-existing C APIs in these packages have been created using a consistent set of rules. Vendor-defined extensions should make use of the same rules in order to provide a consistent developer -experience.
-
+experience. +

The rules for creating the Java language binding are described in the following sections. These rules should be followed as closely as possible for all future -APIs that share the javax.media.opengl namespace.
+APIs that share the javax.media.opengl namespace.

Function Naming

Functions are named in the same way as in the C binding. That is, an OpenGL @@ -169,25 +176,25 @@ API function glClear is bound to Java method GL.glClear. Although it would be possible to drop the gl prefix (since it is redundant with the interface name GL), the resulting code was deemed to look too foreign to experienced OpenGL developers. For the same reason, we have also carried over all type -suffixes like 3f and 3fv from methods such as glColor3f and glColor3fv, respectively.
-
+suffixes like 3f and 3fv from methods such as glColor3f and glColor3fv, respectively. +

Extension suffixes, such as EXT, ARB, and vendor-specific suffixes, are -retained so as to match C conventions.
+retained so as to match C conventions.

Mapping of Constants

Constants are named in the same way as in the C binding. For instance, -the OpenGL constant GL_RGB is bound to Java constant GL.GL_RGB.
+the OpenGL constant GL_RGB is bound to Java constant GL.GL_RGB.

Mapping of Primitive Types

All 8-bit integral types become byte, all 16-bit integral types become short, and all 32-bit integral types become int. All 32-bit floating-point -types become float and all 64-bit floating-point types become double.
-
+types become float and all 64-bit floating-point types become double. +

Integer return values that can only be GL_TRUE or GL_FALSE are mapped to -boolean.
+boolean.

Mapping of Pointer Arguments

- OpenGL functions that take pointer arguments fall into several categories:
+

OpenGL functions that take pointer arguments fall into several categories: