high-level glu documentation
authorAndy Wingo <wingo@pobox.com>
Tue, 12 Feb 2013 11:35:17 +0000 (12:35 +0100)
committerAndy Wingo <wingo@pobox.com>
Tue, 12 Feb 2013 11:39:39 +0000 (12:39 +0100)
* Makefile.am:
* doc/figl.texi:
* doc/glu.texi: Factor GLU docs into separate file, and add high-level
  documentation.

Makefile.am
doc/figl.texi
doc/glu.texi [new file with mode: 0644]

index e865ec1..726d74b 100644 (file)
@@ -44,6 +44,7 @@ EXTRA_DIST += env.in COPYING COPYING.LESSER examples upstream-doc
 info_TEXINFOS = doc/figl.texi
 figl_TEXINFOS = \
        doc/gl.texi \
+       doc/glu.texi \
        doc/low-level-gl.texi \
        doc/low-level-glu.texi \
        doc/low-level-glx.texi \
index 8a367f3..9408c76 100644 (file)
@@ -138,16 +138,8 @@ example @code{(figl gl)}.
 @include gl.texi
 
 
-@node GLU
-@chapter GLU
-
-@menu
-* Low-Level GLU::               Primitive interface to ``glu'' functionality.
-@end menu
-
-@node Low-Level GLU
-@section Low-Level GLU
-@include low-level-glu.texi
+@c Defines the GLU node and chapter.
+@include glu.texi
 
 
 @node GLX
diff --git a/doc/glu.texi b/doc/glu.texi
new file mode 100644 (file)
index 0000000..ad1fd62
--- /dev/null
@@ -0,0 +1,67 @@
+@node GLU
+@chapter GLU
+
+@menu
+* GLU API::                     The high-level interface to GLU.
+* Low-Level GLU::               Primitive interface to ``glu'' functionality.
+@end menu
+
+@node GLU API
+@section GLU API
+
+Import the GLU module to have access to these procedures:
+
+@example
+(use-modules (figl glu))
+@end example
+
+The GLU specification is available at
+@uref{http://www.opengl.org/registry/doc/glu1.3.pdf}.
+
+@menu
+* Initialization::
+* Mipmapping::
+* Matrix Manipulation::
+* Polygon Tesselation::
+* Quadrics::
+* NURBS::
+* Errors::
+@end menu
+
+@node Initialization
+@subsection Initialization
+
+@node Mipmapping
+@subsection Mipmapping
+
+@node Matrix Manipulation
+@subsection Matrix Manipulation
+
+@defun glu-perspective fov-y aspect z-near z-far
+Set up a perspective projection matrix.
+
+@var{fov-y} is the field of view angle, in degrees, in the Y
+direction.  @var{aspect} is the ratio of width to height.
+@var{z-near} and @var{z-far} are the distances from the viewer to the
+near and far clipping planes, respectively.
+
+The resulting matrix is multiplied against the current matrix.
+@end defun
+
+@node Polygon Tesselation
+@subsection Polygon Tesselation
+
+@node Quadrics
+@subsection Quadrics
+
+@node NURBS
+@subsection NURBS
+
+@node Errors
+@subsection Errors
+
+@node Low-Level GLU
+@section Low-Level GLU
+@include low-level-glu.texi
+
+