* .gitignore: New file.
* Makefile.am: Add documentation, and only update the generated files
when asked to. Add new low-level generated files and generated
documentation.
* doc/figl.texi: New file.
* doc/low-level-gl.texi:
* doc/low-level-glu.texi:
* doc/low-level-glx.texi: New generated files.
* figl/config.scm.in: Add abs-top-srcdir.
* figl/low-level.inc.scm: Removed.
* figl/low-level/gl.scm:
* figl/low-level/glu.scm:
* figl/low-level/glx.scm: New generated files.
* figl/low-level/support.scm: New runtime support file.
* figl/parse.scm: Update to expose a "gl-definition" data type, and
expose a parse-to-list interface rather than a fold interface.
Various hacky documentation tweaks to generate valid stexi for the
whole binding set.
* generate-low-level-bindings:
* maint/update-low-level-bindings: Move the updater into maint/ dir, and
only run when asked. Generate whole modules, and documentation too.
/config.status
/Makefile
/figl/config.scm
+/build-aux/texinfo.tex
+/doc/figl.info
+/doc/figl.info-1
+/doc/figl.info-2
+/doc/figl.info-3
+/env
figl.scm \
figl/config.scm \
figl/parse.scm \
- figl/low-level.scm
+ figl/low-level/support.scm \
+ figl/low-level/gl.scm \
+ figl/low-level/glu.scm \
+ figl/low-level/glx.scm
-BUILT_SOURCES = \
- figl/low-level.inc.scm
-
-NOCOMP_SOURCES = \
- figl/low-level.inc.scm
-
-figl/low-level.inc.scm: figl/parse.go
- $(top_builddir)/env $(GUILE) $(top_srcdir)/generate-low-level-bindings > $@
+update: figl/parse.go
+ $(top_builddir)/env $(GUILE) $(top_srcdir)/maint/update-low-level-bindings
EXTRA_DIST += env.in COPYING COPYING.LESSER
+info_TEXINFOS = doc/figl.texi
+figl_TEXINFOS = \
+ doc/low-level-gl.texi \
+ doc/low-level-glu.texi \
+ doc/low-level-glx.texi
+
TESTS = \
tests/basic.test
TESTS_ENVIRONMENT = $(top_builddir)/env $(GUILE) --no-auto-compile
--- /dev/null
+\input texinfo @c -*-texinfo-*-
+@c %**start of header
+@setfilename figl.info
+@settitle Figl
+@c %**end of header
+
+@set VERSION 2.0.0
+@set UPDATED 1 February 2013
+
+@copying
+This manual is for Figl (version @value{VERSION}, updated
+@value{UPDATED})
+
+Copyright 2013 Andy Wingo and others.
+
+@quotation
+Figl is free software: you can redistribute and/or modify it and its
+documentation under the terms of the GNU Lesser General Public License
+as published by the Free Software Foundation, either version 3 of the
+License, or (at your option) any later version.
+
+Figl is distributed in the hope that it will be useful, but WITHOUT
+ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
+Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public
+License along with this program. If not, see
+@uref{http://www.gnu.org/licenses/}.
+@end quotation
+
+Portions of this document were generated from the upstream OpenGL
+documentation. The work as a whole is redistributable under the
+license above. Sections containing generated documentation are
+prefixed with a specific copyright header.
+@end copying
+
+@dircategory The Algorithmic Language Scheme
+@direntry
+* Figl: (figl.info). An OpenGL interface for Guile.
+@end direntry
+
+@titlepage
+@title Figl
+@subtitle version @value{VERSION}, updated @value{UPDATED}
+@author Andy Wingo
+@author (many others)
+@page
+@vskip 0pt plus 1filll
+@insertcopying
+@end titlepage
+
+@ifnottex
+@node Top
+@top Figl
+
+
+@insertcopying
+@menu
+* Low-Level GL:: Primitive interface to OpenGL.
+* Low-Level GLU:: Primitive interface to ``glu'' functionality.
+* Low-Level GLX:: Primitive interface to ``glX'' functionality.
+
+* Function Index::
+@end menu
+
+@end ifnottex
+
+@iftex
+@shortcontents
+@end iftex
+
+@node Low-Level GL
+@chapter Low-Level GL
+@include low-level-gl.texi
+
+@node Low-Level GLU
+@chapter Low-Level GLU
+@include low-level-glu.texi
+
+@node Low-Level GLX
+@chapter Low-Level GLX
+@include low-level-glx.texi
+
+@node Function Index
+@unnumbered Function Index
+@printindex fn
+@bye
--- /dev/null
+
+@c %start of fragment
+
+@copying
+This section of the manual was derived from the upstream OpenGL
+documentation. Each function's documentation has its own copyright
+statement; for full details, see the upstream documentation. The
+copyright notices and licenses present in this section are as follows.
+
+Copyright @copyright{} 1991-2006 Silicon Graphics, Inc. This document is
+licensed under the SGI Free Software B License. For details, see
+@uref{http://oss.sgi.com/projects/FreeB/,http://oss.sgi.com/projects/FreeB/}.
+
+Copyright @copyright{} 2003-2005 3Dlabs Inc. Ltd. This material may be
+distributed subject to the terms and conditions set forth in the Open
+Publication License, v 1.0, 8 June 1999.
+@uref{http://opencontent.org/openpub/,http://opencontent.org/openpub/}.
+
+Copyright @copyright{} 2005 Addison-Wesley. This material may be
+distributed subject to the terms and conditions set forth in the Open
+Publication License, v 1.0, 8 June 1999.
+@uref{http://opencontent.org/openpub/,http://opencontent.org/openpub/}.
+
+Copyright @copyright{} 2006 Khronos Group. This material may be
+distributed subject to the terms and conditions set forth in the Open
+Publication License, v 1.0, 8 June 1999.
+@uref{http://opencontent.org/openpub/,http://opencontent.org/openpub/}.
+
+@end copying
+
+The functions from this section may be had by loading the module:
+
+@example
+(use-modules (figl low-level gl))
+@end example
+
+@defun glAccum
+@heading operate on the accumulation buffer
+@heading Parameters
+@table @asis
+@item @var{op}
+Specifies the accumulation buffer operation. Symbolic constants
+@code{GL_ACCUM}, @code{GL_LOAD}, @code{GL_ADD}, @code{GL_MULT}, and
+@code{GL_RETURN} are accepted.
+
+@item @var{value}
+Specifies a floating-point value used in the accumulation buffer
+operation. @var{op} determines how @var{value} is used.
+
+@end table
+
+@heading Description
+The accumulation buffer is an extended-range color buffer. Images are
+not rendered into it. Rather, images rendered into one of the color
+buffers are added to the contents of the accumulation buffer after
+rendering. Effects such as antialiasing (of points, lines, and
+polygons), motion blur, and depth of field can be created by
+accumulating images generated with different transformation matrices.
+
+Each pixel in the accumulation buffer consists of red, green, blue, and
+alpha values. The number of bits per component in the accumulation
+buffer depends on the implementation. You can examine this number by
+calling @code{glGetIntegerv} four times, with arguments
+@code{GL_ACCUM_RED_BITS}, @code{GL_ACCUM_GREEN_BITS},
+@code{GL_ACCUM_BLUE_BITS}, and @code{GL_ACCUM_ALPHA_BITS}. Regardless of
+the number of bits per component, the range of values stored by each
+component is @math{[-1,1]}. The accumulation buffer pixels are mapped
+one-to-one with frame buffer pixels.
+
+@code{glAccum} operates on the accumulation buffer. The first argument,
+@var{op}, is a symbolic constant that selects an accumulation buffer
+operation. The second argument, @var{value}, is a floating-point value
+to be used in that operation. Five operations are specified:
+@code{GL_ACCUM}, @code{GL_LOAD}, @code{GL_ADD}, @code{GL_MULT}, and
+@code{GL_RETURN}.
+
+All accumulation buffer operations are limited to the area of the
+current scissor box and applied identically to the red, green, blue, and
+alpha components of each pixel. If a @code{glAccum} operation results in
+a value outside the range @math{[-1,1]}, the contents of an accumulation
+buffer pixel component are undefined.
+
+The operations are as follows:
+
+@table @asis
+@item @code{GL_ACCUM}
+Obtains R, G, B, and A values from the buffer currently selected for
+reading (see @code{glReadBuffer}). Each component value is divided by
+@math{2^@var{n}-1}, where @math{@var{n}} is the number of bits allocated
+to each color component in the currently selected buffer. The result is
+a floating-point value in the range @math{[0,1]}, which is multiplied by
+@var{value} and added to the corresponding pixel component in the
+accumulation buffer, thereby updating the accumulation buffer.
+
+@item @code{GL_LOAD}
+Similar to @code{GL_ACCUM}, except that the current value in the
+accumulation buffer is not used in the calculation of the new value.
+That is, the R, G, B, and A values from the currently selected buffer
+are divided by @math{2^@var{n}-1}, multiplied by @var{value}, and then
+stored in the corresponding accumulation buffer cell, overwriting the
+current value.
+
+@item @code{GL_ADD}
+Adds @var{value} to each R, G, B, and A in the accumulation buffer.
+
+@item @code{GL_MULT}
+Multiplies each R, G, B, and A in the accumulation buffer by @var{value}
+and returns the scaled component to its corresponding accumulation
+buffer location.
+
+@item @code{GL_RETURN}
+Transfers accumulation buffer values to the color buffer or buffers
+currently selected for writing. Each R, G, B, and A component is
+multiplied by @var{value}, then multiplied by @math{2^@var{n}-1},
+clamped to the range @math{[0,2^@var{n}-1]}, and stored in the
+corresponding display buffer cell. The only fragment operations that are
+applied to this transfer are pixel ownership, scissor, dithering, and
+color writemasks.
+
+@end table
+
+To clear the accumulation buffer, call @code{glClearAccum} with R, G, B,
+and A values to set it to, then call @code{glClear} with the
+accumulation buffer enabled.
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{op} is not an accepted
+value.
+
+@code{GL_INVALID_OPERATION} is generated if there is no accumulation
+buffer.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glAccum} is executed
+between the execution of @code{glBegin} and the corresponding execution
+of @code{glEnd}.
+
+@end defun
+
+@defun glActiveTexture
+@heading select active texture unit
+@heading Parameters
+@table @asis
+@item @var{texture}
+Specifies which texture unit to make active. The number of texture units
+is implementation dependent, but must be at least two. @var{texture}
+must be one of @code{GL_TEXTURE}@math{@var{i}}, where i ranges from 0 to
+the larger of (@code{GL_MAX_TEXTURE_COORDS} - 1) and
+(@code{GL_MAX_COMBINED_TEXTURE_IMAGE_UNITS} - 1). The initial value is
+@code{GL_TEXTURE0}.
+
+@end table
+
+@heading Description
+@code{glActiveTexture} selects which texture unit subsequent texture
+state calls will affect. The number of texture units an implementation
+supports is implementation dependent, but must be at least 2.
+
+Vertex arrays are client-side GL resources, which are selected by the
+@code{glClientActiveTexture} routine.
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{texture} is not one of
+@code{GL_TEXTURE}@math{@var{i}}, where i ranges from 0 to the larger of
+(@code{GL_MAX_TEXTURE_COORDS} - 1) and
+(@code{GL_MAX_COMBINED_TEXTURE_IMAGE_UNITS} - 1).
+
+@end defun
+
+@defun glAlphaFunc
+@heading specify the alpha test function
+@heading Parameters
+@table @asis
+@item @var{func}
+Specifies the alpha comparison function. Symbolic constants
+@code{GL_NEVER}, @code{GL_LESS}, @code{GL_EQUAL}, @code{GL_LEQUAL},
+@code{GL_GREATER}, @code{GL_NOTEQUAL}, @code{GL_GEQUAL}, and
+@code{GL_ALWAYS} are accepted. The initial value is @code{GL_ALWAYS}.
+
+@item @var{ref}
+Specifies the reference value that incoming alpha values are compared
+to. This value is clamped to the range @math{[0,1]}, where 0 represents
+the lowest possible alpha value and 1 the highest possible value. The
+initial reference value is 0.
+
+@end table
+
+@heading Description
+The alpha test discards fragments depending on the outcome of a
+comparison between an incoming fragment's alpha value and a constant
+reference value. @code{glAlphaFunc} specifies the reference value and
+the comparison function. The comparison is performed only if alpha
+testing is enabled. By default, it is not enabled. (See @code{glEnable}
+and @code{glDisable} of @code{GL_ALPHA_TEST}.)
+
+@var{func} and @var{ref} specify the conditions under which the pixel is
+drawn. The incoming alpha value is compared to @var{ref} using the
+function specified by @var{func}. If the value passes the comparison,
+the incoming fragment is drawn if it also passes subsequent stencil and
+depth buffer tests. If the value fails the comparison, no change is made
+to the frame buffer at that pixel location. The comparison functions are
+as follows:
+
+@table @asis
+@item @code{GL_NEVER}
+Never passes.
+
+@item @code{GL_LESS}
+Passes if the incoming alpha value is less than the reference value.
+
+@item @code{GL_EQUAL}
+Passes if the incoming alpha value is equal to the reference value.
+
+@item @code{GL_LEQUAL}
+Passes if the incoming alpha value is less than or equal to the
+reference value.
+
+@item @code{GL_GREATER}
+Passes if the incoming alpha value is greater than the reference value.
+
+@item @code{GL_NOTEQUAL}
+Passes if the incoming alpha value is not equal to the reference value.
+
+@item @code{GL_GEQUAL}
+Passes if the incoming alpha value is greater than or equal to the
+reference value.
+
+@item @code{GL_ALWAYS}
+Always passes (initial value).
+
+@end table
+
+@code{glAlphaFunc} operates on all pixel write operations, including
+those resulting from the scan conversion of points, lines, polygons, and
+bitmaps, and from pixel draw and copy operations. @code{glAlphaFunc}
+does not affect screen clear operations.
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{func} is not an accepted
+value.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glAlphaFunc} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glAreTexturesResident
+@heading determine if textures are loaded in texture memory
+@heading Parameters
+@table @asis
+@item @var{n}
+Specifies the number of textures to be queried.
+
+@item @var{textures}
+Specifies an array containing the names of the textures to be queried.
+
+@item @var{residences}
+Specifies an array in which the texture residence status is returned.
+The residence status of a texture named by an element of @var{textures}
+is returned in the corresponding element of @var{residences}.
+
+@end table
+
+@heading Description
+GL establishes a ``working set'' of textures that are resident in
+texture memory. These textures can be bound to a texture target much
+more efficiently than textures that are not resident.
+
+@code{glAreTexturesResident} queries the texture residence status of the
+@var{n} textures named by the elements of @var{textures}. If all the
+named textures are resident, @code{glAreTexturesResident} returns
+@code{GL_TRUE}, and the contents of @var{residences} are undisturbed. If
+not all the named textures are resident, @code{glAreTexturesResident}
+returns @code{GL_FALSE}, and detailed status is returned in the @var{n}
+elements of @var{residences}. If an element of @var{residences} is
+@code{GL_TRUE}, then the texture named by the corresponding element of
+@var{textures} is resident.
+
+The residence status of a single bound texture may also be queried by
+calling @code{glGetTexParameter} with the @var{target} argument set to
+the target to which the texture is bound, and the @var{pname} argument
+set to @code{GL_TEXTURE_RESIDENT}. This is the only way that the
+residence status of a default texture can be queried.
+
+@heading Errors
+@code{GL_INVALID_VALUE} is generated if @var{n} is negative.
+
+@code{GL_INVALID_VALUE} is generated if any element in @var{textures} is
+0 or does not name a texture. In that case, the function returns
+@code{GL_FALSE} and the contents of @var{residences} is indeterminate.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glAreTexturesResident}
+is executed between the execution of @code{glBegin} and the
+corresponding execution of @code{glEnd}.
+
+@end defun
+
+@defun glArrayElement
+@heading render a vertex using the specified vertex array element
+@heading Parameters
+@table @asis
+@item @var{i}
+Specifies an index into the enabled vertex data arrays.
+
+@end table
+
+@heading Description
+@code{glArrayElement} commands are used within
+@code{glBegin}/@code{glEnd} pairs to specify vertex and attribute data
+for point, line, and polygon primitives. If @code{GL_VERTEX_ARRAY} is
+enabled when @code{glArrayElement} is called, a single vertex is drawn,
+using vertex and attribute data taken from location @var{i} of the
+enabled arrays. If @code{GL_VERTEX_ARRAY} is not enabled, no drawing
+occurs but the attributes corresponding to the enabled arrays are
+modified.
+
+Use @code{glArrayElement} to construct primitives by indexing vertex
+data, rather than by streaming through arrays of data in first-to-last
+order. Because each call specifies only a single vertex, it is possible
+to explicitly specify per-primitive attributes such as a single normal
+for each triangle.
+
+Changes made to array data between the execution of @code{glBegin} and
+the corresponding execution of @code{glEnd} may affect calls to
+@code{glArrayElement} that are made within the same
+@code{glBegin}/@code{glEnd} period in nonsequential ways. That is, a
+call to @code{glArrayElement} that precedes a change to array data may
+access the changed data, and a call that follows a change to array data
+may access original data.
+
+@heading Errors
+@code{GL_INVALID_VALUE} may be generated if @var{i} is negative.
+
+@code{GL_INVALID_OPERATION} is generated if a non-zero buffer object
+name is bound to an enabled array and the buffer object's data store is
+currently mapped.
+
+@end defun
+
+@defun glAttachShader
+@heading Attaches a shader object to a program object
+@heading Parameters
+@table @asis
+@item @var{program}
+Specifies the program object to which a shader object will be attached.
+
+@item @var{shader}
+Specifies the shader object that is to be attached.
+
+@end table
+
+@heading Description
+In order to create an executable, there must be a way to specify the
+list of things that will be linked together. Program objects provide
+this mechanism. Shaders that are to be linked together in a program
+object must first be attached to that program object.
+@code{glAttachShader} attaches the shader object specified by
+@var{shader} to the program object specified by @var{program}. This
+indicates that @var{shader} will be included in link operations that
+will be performed on @var{program}.
+
+All operations that can be performed on a shader object are valid
+whether or not the shader object is attached to a program object. It is
+permissible to attach a shader object to a program object before source
+code has been loaded into the shader object or before the shader object
+has been compiled. It is permissible to attach multiple shader objects
+of the same type because each may contain a portion of the complete
+shader. It is also permissible to attach a shader object to more than
+one program object. If a shader object is deleted while it is attached
+to a program object, it will be flagged for deletion, and deletion will
+not occur until @code{glDetachShader} is called to detach it from all
+program objects to which it is attached.
+
+@heading Errors
+@code{GL_INVALID_VALUE} is generated if either @var{program} or
+@var{shader} is not a value generated by OpenGL.
+
+@code{GL_INVALID_OPERATION} is generated if @var{program} is not a
+program object.
+
+@code{GL_INVALID_OPERATION} is generated if @var{shader} is not a shader
+object.
+
+@code{GL_INVALID_OPERATION} is generated if @var{shader} is already
+attached to @var{program}.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glAttachShader} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glBeginQuery
+@heading delimit the boundaries of a query object
+@heading Parameters
+@table @asis
+@item @var{target}
+Specifies the target type of query object established between
+@code{glBeginQuery} and the subsequent @code{glEndQuery}. The symbolic
+constant must be @code{GL_SAMPLES_PASSED}.
+
+@item @var{id}
+Specifies the name of a query object.
+
+@end table
+
+@heading Description
+@code{glBeginQuery} and @code{glEndQuery} delimit the boundaries of a
+query object. If a query object with name @var{id} does not yet exist it
+is created.
+
+When @code{glBeginQuery} is executed, the query object's samples-passed
+counter is reset to 0. Subsequent rendering will increment the counter
+once for every sample that passes the depth test. When @code{glEndQuery}
+is executed, the samples-passed counter is assigned to the query
+object's result value. This value can be queried by calling
+@code{glGetQueryObject} with @var{pname}@code{GL_QUERY_RESULT}.
+
+Querying the @code{GL_QUERY_RESULT} implicitly flushes the GL pipeline
+until the rendering delimited by the query object has completed and the
+result is available. @code{GL_QUERY_RESULT_AVAILABLE} can be queried to
+determine if the result is immediately available or if the rendering is
+not yet complete.
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{target} is not
+@code{GL_SAMPLES_PASSED}.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glBeginQuery} is
+executed while a query object of the same @var{target} is already
+active.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glEndQuery} is
+executed when a query object of the same @var{target} is not active.
+
+@code{GL_INVALID_OPERATION} is generated if @var{id} is 0.
+
+@code{GL_INVALID_OPERATION} is generated if @var{id} is the name of an
+already active query object.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glBeginQuery} or
+@code{glEndQuery} is executed between the execution of @code{glBegin}
+and the corresponding execution of @code{glEnd}.
+
+@end defun
+
+@defun glBegin
+@heading delimit the vertices of a primitive or a group of like primitives
+@heading Parameters
+@table @asis
+@item @var{mode}
+Specifies the primitive or primitives that will be created from vertices
+presented between @code{glBegin} and the subsequent @code{glEnd}. Ten
+symbolic constants are accepted: @code{GL_POINTS}, @code{GL_LINES},
+@code{GL_LINE_STRIP}, @code{GL_LINE_LOOP}, @code{GL_TRIANGLES},
+@code{GL_TRIANGLE_STRIP}, @code{GL_TRIANGLE_FAN}, @code{GL_QUADS},
+@code{GL_QUAD_STRIP}, and @code{GL_POLYGON}.
+
+@end table
+
+@heading Description
+@code{glBegin} and @code{glEnd} delimit the vertices that define a
+primitive or a group of like primitives. @code{glBegin} accepts a single
+argument that specifies in which of ten ways the vertices are
+interpreted. Taking @math{@var{n}} as an integer count starting at one,
+and @math{@var{N}} as the total number of vertices specified, the
+interpretations are as follows:
+
+@table @asis
+@item @code{GL_POINTS}
+Treats each vertex as a single point. Vertex @math{@var{n}} defines
+point @math{@var{n}}. @math{@var{N}} points are drawn.
+
+@item @code{GL_LINES}
+Treats each pair of vertices as an independent line segment. Vertices
+@math{2@var{n}-1} and @math{2@var{n}} define line @math{@var{n}}.
+@math{@var{N}/2} lines are drawn.
+
+@item @code{GL_LINE_STRIP}
+Draws a connected group of line segments from the first vertex to the
+last. Vertices @math{@var{n}} and @math{@var{n}+1} define line
+@math{@var{n}}. @math{@var{N}-1} lines are drawn.
+
+@item @code{GL_LINE_LOOP}
+Draws a connected group of line segments from the first vertex to the
+last, then back to the first. Vertices @math{@var{n}} and
+@math{@var{n}+1} define line @math{@var{n}}. The last line, however, is
+defined by vertices @math{@var{N}} and @math{1}. @math{@var{N}} lines
+are drawn.
+
+@item @code{GL_TRIANGLES}
+Treats each triplet of vertices as an independent triangle. Vertices
+@math{3@var{n}-2}, @math{3@var{n}-1}, and @math{3@var{n}} define
+triangle @math{@var{n}}. @math{@var{N}/3} triangles are drawn.
+
+@item @code{GL_TRIANGLE_STRIP}
+Draws a connected group of triangles. One triangle is defined for each
+vertex presented after the first two vertices. For odd @math{@var{n}},
+vertices @math{@var{n}}, @math{@var{n}+1}, and @math{@var{n}+2} define
+triangle @math{@var{n}}. For even @math{@var{n}}, vertices
+@math{@var{n}+1}, @math{@var{n}}, and @math{@var{n}+2} define triangle
+@math{@var{n}}. @math{@var{N}-2} triangles are drawn.
+
+@item @code{GL_TRIANGLE_FAN}
+Draws a connected group of triangles. One triangle is defined for each
+vertex presented after the first two vertices. Vertices @math{1},
+@math{@var{n}+1}, and @math{@var{n}+2} define triangle @math{@var{n}}.
+@math{@var{N}-2} triangles are drawn.
+
+@item @code{GL_QUADS}
+Treats each group of four vertices as an independent quadrilateral.
+Vertices @math{4@var{n}-3}, @math{4@var{n}-2}, @math{4@var{n}-1}, and
+@math{4@var{n}} define quadrilateral @math{@var{n}}. @math{@var{N}/4}
+quadrilaterals are drawn.
+
+@item @code{GL_QUAD_STRIP}
+Draws a connected group of quadrilaterals. One quadrilateral is defined
+for each pair of vertices presented after the first pair. Vertices
+@math{2@var{n}-1}, @math{2@var{n}}, @math{2@var{n}+2}, and
+@math{2@var{n}+1} define quadrilateral @math{@var{n}}.
+@math{@var{N}/2-1} quadrilaterals are drawn. Note that the order in
+which vertices are used to construct a quadrilateral from strip data is
+different from that used with independent data.
+
+@item @code{GL_POLYGON}
+Draws a single, convex polygon. Vertices @math{1} through @math{@var{N}}
+define this polygon.
+
+@end table
+
+Only a subset of GL commands can be used between @code{glBegin} and
+@code{glEnd}. The commands are @code{glVertex}, @code{glColor},
+@code{glSecondaryColor}, @code{glIndex}, @code{glNormal},
+@code{glFogCoord}, @code{glTexCoord}, @code{glMultiTexCoord},
+@code{glVertexAttrib}, @code{glEvalCoord}, @code{glEvalPoint},
+@code{glArrayElement}, @code{glMaterial}, and @code{glEdgeFlag}. Also,
+it is acceptable to use @code{glCallList} or @code{glCallLists} to
+execute display lists that include only the preceding commands. If any
+other GL command is executed between @code{glBegin} and @code{glEnd},
+the error flag is set and the command is ignored.
+
+Regardless of the value chosen for @var{mode}, there is no limit to the
+number of vertices that can be defined between @code{glBegin} and
+@code{glEnd}. Lines, triangles, quadrilaterals, and polygons that are
+incompletely specified are not drawn. Incomplete specification results
+when either too few vertices are provided to specify even a single
+primitive or when an incorrect multiple of vertices is specified. The
+incomplete primitive is ignored; the rest are drawn.
+
+The minimum specification of vertices for each primitive is as follows:
+1 for a point, 2 for a line, 3 for a triangle, 4 for a quadrilateral,
+and 3 for a polygon. Modes that require a certain multiple of vertices
+are @code{GL_LINES} (2), @code{GL_TRIANGLES} (3), @code{GL_QUADS} (4),
+and @code{GL_QUAD_STRIP} (2).
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{mode} is set to an
+unaccepted value.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glBegin} is executed
+between a @code{glBegin} and the corresponding execution of
+@code{glEnd}.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glEnd} is executed
+without being preceded by a @code{glBegin}.
+
+@code{GL_INVALID_OPERATION} is generated if a command other than
+@code{glVertex}, @code{glColor}, @code{glSecondaryColor},
+@code{glIndex}, @code{glNormal}, @code{glFogCoord}, @code{glTexCoord},
+@code{glMultiTexCoord}, @code{glVertexAttrib}, @code{glEvalCoord},
+@code{glEvalPoint}, @code{glArrayElement}, @code{glMaterial},
+@code{glEdgeFlag}, @code{glCallList}, or @code{glCallLists} is executed
+between the execution of @code{glBegin} and the corresponding execution
+@code{glEnd}.
+
+Execution of @code{glEnableClientState}, @code{glDisableClientState},
+@code{glEdgeFlagPointer}, @code{glFogCoordPointer},
+@code{glTexCoordPointer}, @code{glColorPointer},
+@code{glSecondaryColorPointer}, @code{glIndexPointer},
+@code{glNormalPointer}, @code{glVertexPointer},
+@code{glVertexAttribPointer}, @code{glInterleavedArrays}, or
+@code{glPixelStore} is not allowed after a call to @code{glBegin} and
+before the corresponding call to @code{glEnd}, but an error may or may
+not be generated.
+
+@end defun
+
+@defun glBindAttribLocation
+@heading Associates a generic vertex attribute index with a named attribute variable
+@heading Parameters
+@table @asis
+@item @var{program}
+Specifies the handle of the program object in which the association is
+to be made.
+
+@item @var{index}
+Specifies the index of the generic vertex attribute to be bound.
+
+@item @var{name}
+Specifies a null terminated string containing the name of the vertex
+shader attribute variable to which @var{index} is to be bound.
+
+@end table
+
+@heading Description
+@code{glBindAttribLocation} is used to associate a user-defined
+attribute variable in the program object specified by @var{program} with
+a generic vertex attribute index. The name of the user-defined attribute
+variable is passed as a null terminated string in @var{name}. The
+generic vertex attribute index to be bound to this variable is specified
+by @var{index}. When @var{program} is made part of current state, values
+provided via the generic vertex attribute @var{index} will modify the
+value of the user-defined attribute variable specified by @var{name}.
+
+If @var{name} refers to a matrix attribute variable, @var{index} refers
+to the first column of the matrix. Other matrix columns are then
+automatically bound to locations @var{index+1} for a matrix of type
+mat2; @var{index+1} and @var{index+2} for a matrix of type mat3; and
+@var{index+1}, @var{index+2}, and @var{index+3} for a matrix of type
+mat4.
+
+This command makes it possible for vertex shaders to use descriptive
+names for attribute variables rather than generic variables that are
+numbered from 0 to @code{GL_MAX_VERTEX_ATTRIBS} -1. The values sent to
+each generic attribute index are part of current state, just like
+standard vertex attributes such as color, normal, and vertex position.
+If a different program object is made current by calling
+@code{glUseProgram}, the generic vertex attributes are tracked in such a
+way that the same values will be observed by attributes in the new
+program object that are also bound to @var{index}.
+
+Attribute variable name-to-generic attribute index bindings for a
+program object can be explicitly assigned at any time by calling
+@code{glBindAttribLocation}. Attribute bindings do not go into effect
+until @code{glLinkProgram} is called. After a program object has been
+linked successfully, the index values for generic attributes remain
+fixed (and their values can be queried) until the next link command
+occurs.
+
+Applications are not allowed to bind any of the standard OpenGL vertex
+attributes using this command, as they are bound automatically when
+needed. Any attribute binding that occurs after the program object has
+been linked will not take effect until the next time the program object
+is linked.
+
+@heading Errors
+@code{GL_INVALID_VALUE} is generated if @var{index} is greater than or
+equal to @code{GL_MAX_VERTEX_ATTRIBS}.
+
+@code{GL_INVALID_OPERATION} is generated if @var{name} starts with the
+reserved prefix "gl_".
+
+@code{GL_INVALID_VALUE} is generated if @var{program} is not a value
+generated by OpenGL.
+
+@code{GL_INVALID_OPERATION} is generated if @var{program} is not a
+program object.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glBindAttribLocation}
+is executed between the execution of @code{glBegin} and the
+corresponding execution of @code{glEnd}.
+
+@end defun
+
+@defun glBindBuffer
+@heading bind a named buffer object
+@heading Parameters
+@table @asis
+@item @var{target}
+Specifies the target to which the buffer object is bound. The symbolic
+constant must be @code{GL_ARRAY_BUFFER}, @code{GL_ELEMENT_ARRAY_BUFFER},
+@code{GL_PIXEL_PACK_BUFFER}, or @code{GL_PIXEL_UNPACK_BUFFER}.
+
+@item @var{buffer}
+Specifies the name of a buffer object.
+
+@end table
+
+@heading Description
+@code{glBindBuffer} lets you create or use a named buffer object.
+Calling @code{glBindBuffer} with @var{target} set to
+@code{GL_ARRAY_BUFFER}, @code{GL_ELEMENT_ARRAY_BUFFER},
+@code{GL_PIXEL_PACK_BUFFER} or @code{GL_PIXEL_UNPACK_BUFFER} and
+@var{buffer} set to the name of the new buffer object binds the buffer
+object name to the target. When a buffer object is bound to a target,
+the previous binding for that target is automatically broken.
+
+Buffer object names are unsigned integers. The value zero is reserved,
+but there is no default buffer object for each buffer object target.
+Instead, @var{buffer} set to zero effectively unbinds any buffer object
+previously bound, and restores client memory usage for that buffer
+object target. Buffer object names and the corresponding buffer object
+contents are local to the shared display-list space (see
+@code{glXCreateContext}) of the current GL rendering context; two
+rendering contexts share buffer object names only if they also share
+display lists.
+
+You may use @code{glGenBuffers} to generate a set of new buffer object
+names.
+
+The state of a buffer object immediately after it is first bound is an
+unmapped zero-sized memory buffer with @code{GL_READ_WRITE} access and
+@code{GL_STATIC_DRAW} usage.
+
+While a non-zero buffer object name is bound, GL operations on the
+target to which it is bound affect the bound buffer object, and queries
+of the target to which it is bound return state from the bound buffer
+object. While buffer object name zero is bound, as in the initial state,
+attempts to modify or query state on the target to which it is bound
+generates an @code{GL_INVALID_OPERATION} error.
+
+When vertex array pointer state is changed, for example by a call to
+@code{glNormalPointer}, the current buffer object binding
+(@code{GL_ARRAY_BUFFER_BINDING}) is copied into the corresponding client
+state for the vertex array type being changed, for example
+@code{GL_NORMAL_ARRAY_BUFFER_BINDING}. While a non-zero buffer object is
+bound to the @code{GL_ARRAY_BUFFER} target, the vertex array pointer
+parameter that is traditionally interpreted as a pointer to client-side
+memory is instead interpreted as an offset within the buffer object
+measured in basic machine units.
+
+While a non-zero buffer object is bound to the
+@code{GL_ELEMENT_ARRAY_BUFFER} target, the indices parameter of
+@code{glDrawElements}, @code{glDrawRangeElements}, or
+@code{glMultiDrawElements} that is traditionally interpreted as a
+pointer to client-side memory is instead interpreted as an offset within
+the buffer object measured in basic machine units.
+
+While a non-zero buffer object is bound to the
+@code{GL_PIXEL_PACK_BUFFER} target, the following commands are affected:
+@code{glGetCompressedTexImage}, @code{glGetConvolutionFilter},
+@code{glGetHistogram}, @code{glGetMinmax}, @code{glGetPixelMap},
+@code{glGetPolygonStipple}, @code{glGetSeparableFilter},
+@code{glGetTexImage}, and @code{glReadPixels}. The pointer parameter
+that is traditionally interpreted as a pointer to client-side memory
+where the pixels are to be packed is instead interpreted as an offset
+within the buffer object measured in basic machine units.
+
+While a non-zero buffer object is bound to the
+@code{GL_PIXEL_UNPACK_BUFFER} target, the following commands are
+affected: @code{glBitmap}, @code{glColorSubTable}, @code{glColorTable},
+@code{glCompressedTexImage1D}, @code{glCompressedTexImage2D},
+@code{glCompressedTexImage3D}, @code{glCompressedTexSubImage1D},
+@code{glCompressedTexSubImage2D}, @code{glCompressedTexSubImage3D},
+@code{glConvolutionFilter1D}, @code{glConvolutionFilter2D},
+@code{glDrawPixels}, @code{glPixelMap}, @code{glPolygonStipple},
+@code{glSeparableFilter2D}, @code{glTexImage1D}, @code{glTexImage2D},
+@code{glTexImage3D}, @code{glTexSubImage1D}, @code{glTexSubImage2D}, and
+@code{glTexSubImage3D}. The pointer parameter that is traditionally
+interpreted as a pointer to client-side memory from which the pixels are
+to be unpacked is instead interpreted as an offset within the buffer
+object measured in basic machine units.
+
+A buffer object binding created with @code{glBindBuffer} remains active
+until a different buffer object name is bound to the same target, or
+until the bound buffer object is deleted with @code{glDeleteBuffers}.
+
+Once created, a named buffer object may be re-bound to any target as
+often as needed. However, the GL implementation may make choices about
+how to optimize the storage of a buffer object based on its initial
+binding target.
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{target} is not one of the
+allowable values.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glBindBuffer} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glBindTexture
+@heading bind a named texture to a texturing target
+@heading Parameters
+@table @asis
+@item @var{target}
+Specifies the target to which the texture is bound. Must be either
+@code{GL_TEXTURE_1D}, @code{GL_TEXTURE_2D}, @code{GL_TEXTURE_3D}, or
+@code{GL_TEXTURE_CUBE_MAP}.
+
+@item @var{texture}
+Specifies the name of a texture.
+
+@end table
+
+@heading Description
+@code{glBindTexture} lets you create or use a named texture. Calling
+@code{glBindTexture} with @var{target} set to @code{GL_TEXTURE_1D},
+@code{GL_TEXTURE_2D}, @code{GL_TEXTURE_3D} or @code{GL_TEXTURE_CUBE_MAP}
+and @var{texture} set to the name of the new texture binds the texture
+name to the target. When a texture is bound to a target, the previous
+binding for that target is automatically broken.
+
+Texture names are unsigned integers. The value zero is reserved to
+represent the default texture for each texture target. Texture names and
+the corresponding texture contents are local to the shared display-list
+space (see @code{glXCreateContext}) of the current GL rendering context;
+two rendering contexts share texture names only if they also share
+display lists.
+
+You may use @code{glGenTextures} to generate a set of new texture names.
+
+When a texture is first bound, it assumes the specified target: A
+texture first bound to @code{GL_TEXTURE_1D} becomes one-dimensional
+texture, a texture first bound to @code{GL_TEXTURE_2D} becomes
+two-dimensional texture, a texture first bound to @code{GL_TEXTURE_3D}
+becomes three-dimensional texture, and a texture first bound to
+@code{GL_TEXTURE_CUBE_MAP} becomes a cube-mapped texture. The state of a
+one-dimensional texture immediately after it is first bound is
+equivalent to the state of the default @code{GL_TEXTURE_1D} at GL
+initialization, and similarly for two- and three-dimensional textures
+and cube-mapped textures.
+
+While a texture is bound, GL operations on the target to which it is
+bound affect the bound texture, and queries of the target to which it is
+bound return state from the bound texture. If texture mapping is active
+on the target to which a texture is bound, the bound texture is used. In
+effect, the texture targets become aliases for the textures currently
+bound to them, and the texture name zero refers to the default textures
+that were bound to them at initialization.
+
+A texture binding created with @code{glBindTexture} remains active until
+a different texture is bound to the same target, or until the bound
+texture is deleted with @code{glDeleteTextures}.
+
+Once created, a named texture may be re-bound to its same original
+target as often as needed. It is usually much faster to use
+@code{glBindTexture} to bind an existing named texture to one of the
+texture targets than it is to reload the texture image using
+@code{glTexImage1D}, @code{glTexImage2D}, or @code{glTexImage3D}. For
+additional control over performance, use @code{glPrioritizeTextures}.
+
+@code{glBindTexture} is included in display lists.
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{target} is not one of the
+allowable values.
+
+@code{GL_INVALID_OPERATION} is generated if @var{texture} was previously
+created with a target that doesn't match that of @var{target}.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glBindTexture} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glBitmap
+@heading draw a bitmap
+@heading Parameters
+@table @asis
+@item @var{width}
+@itemx @var{height}
+Specify the pixel width and height of the bitmap image.
+
+@item @var{xorig}
+@itemx @var{yorig}
+Specify the location of the origin in the bitmap image. The origin is
+measured from the lower left corner of the bitmap, with right and up
+being the positive axes.
+
+@item @var{xmove}
+@itemx @var{ymove}
+Specify the @var{x} and @var{y} offsets to be added to the current
+raster position after the bitmap is drawn.
+
+@item @var{bitmap}
+Specifies the address of the bitmap image.
+
+@end table
+
+@heading Description
+A bitmap is a binary image. When drawn, the bitmap is positioned
+relative to the current raster position, and frame buffer pixels
+corresponding to 1's in the bitmap are written using the current raster
+color or index. Frame buffer pixels corresponding to 0's in the bitmap
+are not modified.
+
+@code{glBitmap} takes seven arguments. The first pair specifies the
+width and height of the bitmap image. The second pair specifies the
+location of the bitmap origin relative to the lower left corner of the
+bitmap image. The third pair of arguments specifies @var{x} and @var{y}
+offsets to be added to the current raster position after the bitmap has
+been drawn. The final argument is a pointer to the bitmap image itself.
+
+If a non-zero named buffer object is bound to the
+@code{GL_PIXEL_UNPACK_BUFFER} target (see @code{glBindBuffer}) while a
+bitmap image is specified, @var{bitmap} is treated as a byte offset into
+the buffer object's data store.
+
+The bitmap image is interpreted like image data for the
+@code{glDrawPixels} command, with @var{width} and @var{height}
+corresponding to the width and height arguments of that command, and
+with @var{type} set to @code{GL_BITMAP} and @var{format} set to
+@code{GL_COLOR_INDEX}. Modes specified using @code{glPixelStore} affect
+the interpretation of bitmap image data; modes specified using
+@code{glPixelTransfer} do not.
+
+If the current raster position is invalid, @code{glBitmap} is ignored.
+Otherwise, the lower left corner of the bitmap image is positioned at
+the window coordinates
+
+@math{@var{x}_@var{w}=⌊@var{x}_@var{r}-@var{x}_@var{o},⌋}
+
+@math{@var{y}_@var{w}=⌊@var{y}_@var{r}-@var{y}_@var{o},⌋}
+
+where @math{(@var{x}_@var{r},@var{y}_@var{r})} is the raster position
+and @math{(@var{x}_@var{o},@var{y}_@var{o})} is the bitmap origin.
+Fragments are then generated for each pixel corresponding to a 1 (one)
+in the bitmap image. These fragments are generated using the current
+raster @var{z} coordinate, color or color index, and current raster
+texture coordinates. They are then treated just as if they had been
+generated by a point, line, or polygon, including texture mapping,
+fogging, and all per-fragment operations such as alpha and depth
+testing.
+
+After the bitmap has been drawn, the @var{x} and @var{y} coordinates of
+the current raster position are offset by @var{xmove} and @var{ymove}.
+No change is made to the @var{z} coordinate of the current raster
+position, or to the current raster color, texture coordinates, or index.
+
+@heading Errors
+@code{GL_INVALID_VALUE} is generated if @var{width} or @var{height} is
+negative.
+
+@code{GL_INVALID_OPERATION} is generated if a non-zero buffer object
+name is bound to the @code{GL_PIXEL_UNPACK_BUFFER} target and the buffer
+object's data store is currently mapped.
+
+@code{GL_INVALID_OPERATION} is generated if a non-zero buffer object
+name is bound to the @code{GL_PIXEL_UNPACK_BUFFER} target and the data
+would be unpacked from the buffer object such that the memory reads
+required would exceed the data store size.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glBitmap} is executed
+between the execution of @code{glBegin} and the corresponding execution
+of @code{glEnd}.
+
+@end defun
+
+@defun glBlendColor
+@heading set the blend color
+@heading Parameters
+@table @asis
+@item @var{red}
+@itemx @var{green}
+@itemx @var{blue}
+@itemx @var{alpha}
+specify the components of @code{GL_BLEND_COLOR}
+
+@end table
+
+@heading Description
+The @code{GL_BLEND_COLOR} may be used to calculate the source and
+destination blending factors. The color components are clamped to the
+range @math{[0,1]} before being stored. See @code{glBlendFunc} for a
+complete description of the blending operations. Initially the
+@code{GL_BLEND_COLOR} is set to (0, 0, 0, 0).
+
+@heading Errors
+@code{GL_INVALID_OPERATION} is generated if @code{glBlendColor} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+
+
+@end defun
+
+@defun glBlendEquationSeparate
+@heading set the RGB blend equation and the alpha blend equation separately
+@heading Parameters
+@table @asis
+@item @var{modeRGB}
+specifies the RGB blend equation, how the red, green, and blue
+components of the source and destination colors are combined. It must be
+@code{GL_FUNC_ADD}, @code{GL_FUNC_SUBTRACT},
+@code{GL_FUNC_REVERSE_SUBTRACT}, @code{GL_MIN}, @code{GL_MAX}.
+
+@item @var{modeAlpha}
+specifies the alpha blend equation, how the alpha component of the
+source and destination colors are combined. It must be
+@code{GL_FUNC_ADD}, @code{GL_FUNC_SUBTRACT},
+@code{GL_FUNC_REVERSE_SUBTRACT}, @code{GL_MIN}, @code{GL_MAX}.
+
+@end table
+
+@heading Description
+The blend equations determines how a new pixel (the ''source'' color) is
+combined with a pixel already in the framebuffer (the ''destination''
+color). This function specifies one blend equation for the RGB-color
+components and one blend equation for the alpha component.
+
+The blend equations use the source and destination blend factors
+specified by either @code{glBlendFunc} or @code{glBlendFuncSeparate}.
+See @code{glBlendFunc} or @code{glBlendFuncSeparate} for a description
+of the various blend factors.
+
+In the equations that follow, source and destination color components
+are referred to as
+@math{(@var{R}_@var{s},@var{G}_@var{s}@var{B}_@var{s}@var{A}_@var{s})}
+and
+@math{(@var{R}_@var{d},@var{G}_@var{d}@var{B}_@var{d}@var{A}_@var{d})},
+respectively. The result color is referred to as
+@math{(@var{R}_@var{r},@var{G}_@var{r}@var{B}_@var{r}@var{A}_@var{r})}.
+The source and destination blend factors are denoted
+@math{(@var{s}_@var{R},@var{s}_@var{G}@var{s}_@var{B}@var{s}_@var{A})}
+and
+@math{(@var{d}_@var{R},@var{d}_@var{G}@var{d}_@var{B}@var{d}_@var{A})},
+respectively. For these equations all color components are understood to
+have values in the range @math{[0,1]}.
+
+@table @asis
+@item @strong{Mode}
+@strong{RGB Components}, @strong{Alpha Component}
+
+@item @code{GL_FUNC_ADD}
+@math{@var{Rr}=@var{R}_@var{s}@var{s}_@var{R}+@var{R}_@var{d}@var{d}_@var{R}}@math{@var{Gr}=@var{G}_@var{s}@var{s}_@var{G}+@var{G}_@var{d}@var{d}_@var{G}}@math{@var{Br}=@var{B}_@var{s}@var{s}_@var{B}+@var{B}_@var{d}@var{d}_@var{B}},
+@math{@var{Ar}=@var{A}_@var{s}@var{s}_@var{A}+@var{A}_@var{d}@var{d}_@var{A}}
+
+@item @code{GL_FUNC_SUBTRACT}
+@math{@var{Rr}=@var{R}_@var{s}@var{s}_@var{R}-@var{R}_@var{d}@var{d}_@var{R}}@math{@var{Gr}=@var{G}_@var{s}@var{s}_@var{G}-@var{G}_@var{d}@var{d}_@var{G}}@math{@var{Br}=@var{B}_@var{s}@var{s}_@var{B}-@var{B}_@var{d}@var{d}_@var{B}},
+@math{@var{Ar}=@var{A}_@var{s}@var{s}_@var{A}-@var{A}_@var{d}@var{d}_@var{A}}
+
+@item @code{GL_FUNC_REVERSE_SUBTRACT}
+@math{@var{Rr}=@var{R}_@var{d}@var{d}_@var{R}-@var{R}_@var{s}@var{s}_@var{R}}@math{@var{Gr}=@var{G}_@var{d}@var{d}_@var{G}-@var{G}_@var{s}@var{s}_@var{G}}@math{@var{Br}=@var{B}_@var{d}@var{d}_@var{B}-@var{B}_@var{s}@var{s}_@var{B}},
+@math{@var{Ar}=@var{A}_@var{d}@var{d}_@var{A}-@var{A}_@var{s}@var{s}_@var{A}}
+
+@item @code{GL_MIN}
+@math{@var{Rr}=@var{min}(@var{R}_@var{s},@var{R}_@var{d})}@math{@var{Gr}=@var{min}(@var{G}_@var{s},@var{G}_@var{d})}@math{@var{Br}=@var{min}(@var{B}_@var{s},@var{B}_@var{d})},
+@math{@var{Ar}=@var{min}(@var{A}_@var{s},@var{A}_@var{d})}
+
+@item @code{GL_MAX}
+@math{@var{Rr}=@var{max}(@var{R}_@var{s},@var{R}_@var{d})}@math{@var{Gr}=@var{max}(@var{G}_@var{s},@var{G}_@var{d})}@math{@var{Br}=@var{max}(@var{B}_@var{s},@var{B}_@var{d})},
+@math{@var{Ar}=@var{max}(@var{A}_@var{s},@var{A}_@var{d})}
+
+@end table
+
+The results of these equations are clamped to the range @math{[0,1]}.
+
+The @code{GL_MIN} and @code{GL_MAX} equations are useful for
+applications that analyze image data (image thresholding against a
+constant color, for example). The @code{GL_FUNC_ADD} equation is useful
+for antialiasing and transparency, among other things.
+
+Initially, both the RGB blend equation and the alpha blend equation are
+set to @code{GL_FUNC_ADD}.
+
+
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if either @var{modeRGB} or
+@var{modeAlpha} is not one of @code{GL_FUNC_ADD},
+@code{GL_FUNC_SUBTRACT}, @code{GL_FUNC_REVERSE_SUBTRACT}, @code{GL_MAX},
+or @code{GL_MIN}.
+
+@code{GL_INVALID_OPERATION} is generated if
+@code{glBlendEquationSeparate} is executed between the execution of
+@code{glBegin} and the corresponding execution of @code{glEnd}.
+
+@end defun
+
+@defun glBlendEquation
+@heading specify the equation used for both the RGB blend equation and the Alpha blend equation
+@heading Parameters
+@table @asis
+@item @var{mode}
+specifies how source and destination colors are combined. It must be
+@code{GL_FUNC_ADD}, @code{GL_FUNC_SUBTRACT},
+@code{GL_FUNC_REVERSE_SUBTRACT}, @code{GL_MIN}, @code{GL_MAX}.
+
+@end table
+
+@heading Description
+The blend equations determine how a new pixel (the ''source'' color) is
+combined with a pixel already in the framebuffer (the ''destination''
+color). This function sets both the RGB blend equation and the alpha
+blend equation to a single equation.
+
+These equations use the source and destination blend factors specified
+by either @code{glBlendFunc} or @code{glBlendFuncSeparate}. See
+@code{glBlendFunc} or @code{glBlendFuncSeparate} for a description of
+the various blend factors.
+
+In the equations that follow, source and destination color components
+are referred to as
+@math{(@var{R}_@var{s},@var{G}_@var{s}@var{B}_@var{s}@var{A}_@var{s})}
+and
+@math{(@var{R}_@var{d},@var{G}_@var{d}@var{B}_@var{d}@var{A}_@var{d})},
+respectively. The result color is referred to as
+@math{(@var{R}_@var{r},@var{G}_@var{r}@var{B}_@var{r}@var{A}_@var{r})}.
+The source and destination blend factors are denoted
+@math{(@var{s}_@var{R},@var{s}_@var{G}@var{s}_@var{B}@var{s}_@var{A})}
+and
+@math{(@var{d}_@var{R},@var{d}_@var{G}@var{d}_@var{B}@var{d}_@var{A})},
+respectively. For these equations all color components are understood to
+have values in the range @math{[0,1]}.
+
+@table @asis
+@item @strong{Mode}
+@strong{RGB Components}, @strong{Alpha Component}
+
+@item @code{GL_FUNC_ADD}
+@math{@var{Rr}=@var{R}_@var{s}@var{s}_@var{R}+@var{R}_@var{d}@var{d}_@var{R}}@math{@var{Gr}=@var{G}_@var{s}@var{s}_@var{G}+@var{G}_@var{d}@var{d}_@var{G}}@math{@var{Br}=@var{B}_@var{s}@var{s}_@var{B}+@var{B}_@var{d}@var{d}_@var{B}},
+@math{@var{Ar}=@var{A}_@var{s}@var{s}_@var{A}+@var{A}_@var{d}@var{d}_@var{A}}
+
+@item @code{GL_FUNC_SUBTRACT}
+@math{@var{Rr}=@var{R}_@var{s}@var{s}_@var{R}-@var{R}_@var{d}@var{d}_@var{R}}@math{@var{Gr}=@var{G}_@var{s}@var{s}_@var{G}-@var{G}_@var{d}@var{d}_@var{G}}@math{@var{Br}=@var{B}_@var{s}@var{s}_@var{B}-@var{B}_@var{d}@var{d}_@var{B}},
+@math{@var{Ar}=@var{A}_@var{s}@var{s}_@var{A}-@var{A}_@var{d}@var{d}_@var{A}}
+
+@item @code{GL_FUNC_REVERSE_SUBTRACT}
+@math{@var{Rr}=@var{R}_@var{d}@var{d}_@var{R}-@var{R}_@var{s}@var{s}_@var{R}}@math{@var{Gr}=@var{G}_@var{d}@var{d}_@var{G}-@var{G}_@var{s}@var{s}_@var{G}}@math{@var{Br}=@var{B}_@var{d}@var{d}_@var{B}-@var{B}_@var{s}@var{s}_@var{B}},
+@math{@var{Ar}=@var{A}_@var{d}@var{d}_@var{A}-@var{A}_@var{s}@var{s}_@var{A}}
+
+@item @code{GL_MIN}
+@math{@var{Rr}=@var{min}(@var{R}_@var{s},@var{R}_@var{d})}@math{@var{Gr}=@var{min}(@var{G}_@var{s},@var{G}_@var{d})}@math{@var{Br}=@var{min}(@var{B}_@var{s},@var{B}_@var{d})},
+@math{@var{Ar}=@var{min}(@var{A}_@var{s},@var{A}_@var{d})}
+
+@item @code{GL_MAX}
+@math{@var{Rr}=@var{max}(@var{R}_@var{s},@var{R}_@var{d})}@math{@var{Gr}=@var{max}(@var{G}_@var{s},@var{G}_@var{d})}@math{@var{Br}=@var{max}(@var{B}_@var{s},@var{B}_@var{d})},
+@math{@var{Ar}=@var{max}(@var{A}_@var{s},@var{A}_@var{d})}
+
+@end table
+
+The results of these equations are clamped to the range @math{[0,1]}.
+
+The @code{GL_MIN} and @code{GL_MAX} equations are useful for
+applications that analyze image data (image thresholding against a
+constant color, for example). The @code{GL_FUNC_ADD} equation is useful
+for antialiasing and transparency, among other things.
+
+Initially, both the RGB blend equation and the alpha blend equation are
+set to @code{GL_FUNC_ADD}.
+
+
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{mode} is not one of
+@code{GL_FUNC_ADD}, @code{GL_FUNC_SUBTRACT},
+@code{GL_FUNC_REVERSE_SUBTRACT}, @code{GL_MAX}, or @code{GL_MIN}.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glBlendEquation} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glBlendFuncSeparate
+@heading specify pixel arithmetic for RGB and alpha components separately
+@heading Parameters
+@table @asis
+@item @var{srcRGB}
+Specifies how the red, green, and blue blending factors are computed.
+The following symbolic constants are accepted: @code{GL_ZERO},
+@code{GL_ONE}, @code{GL_SRC_COLOR}, @code{GL_ONE_MINUS_SRC_COLOR},
+@code{GL_DST_COLOR}, @code{GL_ONE_MINUS_DST_COLOR}, @code{GL_SRC_ALPHA},
+@code{GL_ONE_MINUS_SRC_ALPHA}, @code{GL_DST_ALPHA},
+@code{GL_ONE_MINUS_DST_ALPHA}, @code{GL_CONSTANT_COLOR},
+@code{GL_ONE_MINUS_CONSTANT_COLOR}, @code{GL_CONSTANT_ALPHA},
+@code{GL_ONE_MINUS_CONSTANT_ALPHA}, and @code{GL_SRC_ALPHA_SATURATE}.
+The initial value is @code{GL_ONE}.
+
+@item @var{dstRGB}
+Specifies how the red, green, and blue destination blending factors are
+computed. The following symbolic constants are accepted: @code{GL_ZERO},
+@code{GL_ONE}, @code{GL_SRC_COLOR}, @code{GL_ONE_MINUS_SRC_COLOR},
+@code{GL_DST_COLOR}, @code{GL_ONE_MINUS_DST_COLOR}, @code{GL_SRC_ALPHA},
+@code{GL_ONE_MINUS_SRC_ALPHA}, @code{GL_DST_ALPHA},
+@code{GL_ONE_MINUS_DST_ALPHA}. @code{GL_CONSTANT_COLOR},
+@code{GL_ONE_MINUS_CONSTANT_COLOR}, @code{GL_CONSTANT_ALPHA}, and
+@code{GL_ONE_MINUS_CONSTANT_ALPHA}. The initial value is @code{GL_ZERO}.
+
+@item @var{srcAlpha}
+Specified how the alpha source blending factor is computed. The same
+symbolic constants are accepted as for @var{srcRGB}. The initial value
+is @code{GL_ONE}.
+
+@item @var{dstAlpha}
+Specified how the alpha destination blending factor is computed. The
+same symbolic constants are accepted as for @var{dstRGB}. The initial
+value is @code{GL_ZERO}.
+
+@end table
+
+@heading Description
+In RGBA mode, pixels can be drawn using a function that blends the
+incoming (source) RGBA values with the RGBA values that are already in
+the frame buffer (the destination values). Blending is initially
+disabled. Use @code{glEnable} and @code{glDisable} with argument
+@code{GL_BLEND} to enable and disable blending.
+
+@code{glBlendFuncSeparate} defines the operation of blending when it is
+enabled. @var{srcRGB} specifies which method is used to scale the source
+RGB-color components. @var{dstRGB} specifies which method is used to
+scale the destination RGB-color components. Likewise, @var{srcAlpha}
+specifies which method is used to scale the source alpha color
+component, and @var{dstAlpha} specifies which method is used to scale
+the destination alpha component. The possible methods are described in
+the following table. Each method defines four scale factors, one each
+for red, green, blue, and alpha.
+
+In the table and in subsequent equations, source and destination color
+components are referred to as
+@math{(@var{R}_@var{s},@var{G}_@var{s}@var{B}_@var{s}@var{A}_@var{s})}
+and
+@math{(@var{R}_@var{d},@var{G}_@var{d}@var{B}_@var{d}@var{A}_@var{d})}.
+The color specified by @code{glBlendColor} is referred to as
+@math{(@var{R}_@var{c},@var{G}_@var{c}@var{B}_@var{c}@var{A}_@var{c})}.
+They are understood to have integer values between 0 and
+@math{(@var{k}_@var{R},@var{k}_@var{G}@var{k}_@var{B}@var{k}_@var{A})},
+where
+
+@math{@var{k}_@var{c}=2^@var{m}_@var{c},-1}
+
+and
+@math{(@var{m}_@var{R},@var{m}_@var{G}@var{m}_@var{B}@var{m}_@var{A})}
+is the number of red, green, blue, and alpha bitplanes.
+
+Source and destination scale factors are referred to as
+@math{(@var{s}_@var{R},@var{s}_@var{G}@var{s}_@var{B}@var{s}_@var{A})}
+and
+@math{(@var{d}_@var{R},@var{d}_@var{G}@var{d}_@var{B}@var{d}_@var{A})}.
+All scale factors have range @math{[0,1]}.
+
+
+
+@table @asis
+@item @strong{Parameter}
+@strong{RGB Factor}, @strong{Alpha Factor}
+
+@item @code{GL_ZERO}
+@math{(0,00)}, @math{0}
+
+@item @code{GL_ONE}
+@math{(1,11)}, @math{1}
+
+@item @code{GL_SRC_COLOR}
+@math{(@var{R}_@var{s}/@var{k}_@var{R},@var{G}_@var{s}/@var{k}_@var{G}@var{B}_@var{s}/@var{k}_@var{B})},
+@math{@var{A}_@var{s}/@var{k}_@var{A}}
+
+@item @code{GL_ONE_MINUS_SRC_COLOR}
+@math{(1,111)-(@var{R}_@var{s}/@var{k}_@var{R},@var{G}_@var{s}/@var{k}_@var{G}@var{B}_@var{s}/@var{k}_@var{B})},
+@math{1-@var{A}_@var{s}/@var{k}_@var{A}}
+
+@item @code{GL_DST_COLOR}
+@math{(@var{R}_@var{d}/@var{k}_@var{R},@var{G}_@var{d}/@var{k}_@var{G}@var{B}_@var{d}/@var{k}_@var{B})},
+@math{@var{A}_@var{d}/@var{k}_@var{A}}
+
+@item @code{GL_ONE_MINUS_DST_COLOR}
+@math{(1,11)-(@var{R}_@var{d}/@var{k}_@var{R},@var{G}_@var{d}/@var{k}_@var{G}@var{B}_@var{d}/@var{k}_@var{B})},
+@math{1-@var{A}_@var{d}/@var{k}_@var{A}}
+
+@item @code{GL_SRC_ALPHA}
+@math{(@var{A}_@var{s}/@var{k}_@var{A},@var{A}_@var{s}/@var{k}_@var{A}@var{A}_@var{s}/@var{k}_@var{A})},
+@math{@var{A}_@var{s}/@var{k}_@var{A}}
+
+@item @code{GL_ONE_MINUS_SRC_ALPHA}
+@math{(1,11)-(@var{A}_@var{s}/@var{k}_@var{A},@var{A}_@var{s}/@var{k}_@var{A}@var{A}_@var{s}/@var{k}_@var{A})},
+@math{1-@var{A}_@var{s}/@var{k}_@var{A}}
+
+@item @code{GL_DST_ALPHA}
+@math{(@var{A}_@var{d}/@var{k}_@var{A},@var{A}_@var{d}/@var{k}_@var{A}@var{A}_@var{d}/@var{k}_@var{A})},
+@math{@var{A}_@var{d}/@var{k}_@var{A}}
+
+@item @code{GL_ONE_MINUS_DST_ALPHA}
+@math{(1,11)-(@var{A}_@var{d}/@var{k}_@var{A},@var{A}_@var{d}/@var{k}_@var{A}@var{A}_@var{d}/@var{k}_@var{A})},
+@math{1-@var{A}_@var{d}/@var{k}_@var{A}}
+
+@item @code{GL_CONSTANT_COLOR}
+@math{(@var{R}_@var{c},@var{G}_@var{c}@var{B}_@var{c})},
+@math{@var{A}_@var{c}}
+
+@item @code{GL_ONE_MINUS_CONSTANT_COLOR}
+@math{(1,11)-(@var{R}_@var{c},@var{G}_@var{c}@var{B}_@var{c})},
+@math{1-@var{A}_@var{c}}
+
+@item @code{GL_CONSTANT_ALPHA}
+@math{(@var{A}_@var{c},@var{A}_@var{c}@var{A}_@var{c})},
+@math{@var{A}_@var{c}}
+
+@item @code{GL_ONE_MINUS_CONSTANT_ALPHA}
+@math{(1,11)-(@var{A}_@var{c},@var{A}_@var{c}@var{A}_@var{c})},
+@math{1-@var{A}_@var{c}}
+
+@item @code{GL_SRC_ALPHA_SATURATE}
+@math{(@var{i},@var{i}@var{i})}, @math{1}
+
+@end table
+
+In the table,
+
+@math{@var{i}=@var{min}(@var{A}_@var{s},1-@var{A}_@var{d},)}
+
+To determine the blended RGBA values of a pixel when drawing in RGBA
+mode, the system uses the following equations:
+
+@math{@var{R}_@var{d}=@var{min}(@var{k}_@var{R},@var{R}_@var{s}@var{s}_@var{R}+@var{R}_@var{d}@var{d}_@var{R})}@math{@var{G}_@var{d}=@var{min}(@var{k}_@var{G},@var{G}_@var{s}@var{s}_@var{G}+@var{G}_@var{d}@var{d}_@var{G})}@math{@var{B}_@var{d}=@var{min}(@var{k}_@var{B},@var{B}_@var{s}@var{s}_@var{B}+@var{B}_@var{d}@var{d}_@var{B})}@math{@var{A}_@var{d}=@var{min}(@var{k}_@var{A},@var{A}_@var{s}@var{s}_@var{A}+@var{A}_@var{d}@var{d}_@var{A})}
+
+Despite the apparent precision of the above equations, blending
+arithmetic is not exactly specified, because blending operates with
+imprecise integer color values. However, a blend factor that should be
+equal to 1 is guaranteed not to modify its multiplicand, and a blend
+factor equal to 0 reduces its multiplicand to 0. For example, when
+@var{srcRGB} is @code{GL_SRC_ALPHA}, @var{dstRGB} is
+@code{GL_ONE_MINUS_SRC_ALPHA}, and @math{@var{A}_@var{s}} is equal to
+@math{@var{k}_@var{A}}, the equations reduce to simple replacement:
+
+@math{@var{R}_@var{d}=@var{R}_@var{s}}@math{@var{G}_@var{d}=@var{G}_@var{s}}@math{@var{B}_@var{d}=@var{B}_@var{s}}@math{@var{A}_@var{d}=@var{A}_@var{s}}
+
+
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if either @var{srcRGB} or
+@var{dstRGB} is not an accepted value.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glBlendFuncSeparate}
+is executed between the execution of @code{glBegin} and the
+corresponding execution of @code{glEnd}.
+
+@end defun
+
+@defun glBlendFunc
+@heading specify pixel arithmetic
+@heading Parameters
+@table @asis
+@item @var{sfactor}
+Specifies how the red, green, blue, and alpha source blending factors
+are computed. The following symbolic constants are accepted:
+@code{GL_ZERO}, @code{GL_ONE}, @code{GL_SRC_COLOR},
+@code{GL_ONE_MINUS_SRC_COLOR}, @code{GL_DST_COLOR},
+@code{GL_ONE_MINUS_DST_COLOR}, @code{GL_SRC_ALPHA},
+@code{GL_ONE_MINUS_SRC_ALPHA}, @code{GL_DST_ALPHA},
+@code{GL_ONE_MINUS_DST_ALPHA}, @code{GL_CONSTANT_COLOR},
+@code{GL_ONE_MINUS_CONSTANT_COLOR}, @code{GL_CONSTANT_ALPHA},
+@code{GL_ONE_MINUS_CONSTANT_ALPHA}, and @code{GL_SRC_ALPHA_SATURATE}.
+The initial value is @code{GL_ONE}.
+
+@item @var{dfactor}
+Specifies how the red, green, blue, and alpha destination blending
+factors are computed. The following symbolic constants are accepted:
+@code{GL_ZERO}, @code{GL_ONE}, @code{GL_SRC_COLOR},
+@code{GL_ONE_MINUS_SRC_COLOR}, @code{GL_DST_COLOR},
+@code{GL_ONE_MINUS_DST_COLOR}, @code{GL_SRC_ALPHA},
+@code{GL_ONE_MINUS_SRC_ALPHA}, @code{GL_DST_ALPHA},
+@code{GL_ONE_MINUS_DST_ALPHA}. @code{GL_CONSTANT_COLOR},
+@code{GL_ONE_MINUS_CONSTANT_COLOR}, @code{GL_CONSTANT_ALPHA}, and
+@code{GL_ONE_MINUS_CONSTANT_ALPHA}. The initial value is @code{GL_ZERO}.
+
+@end table
+
+@heading Description
+In RGBA mode, pixels can be drawn using a function that blends the
+incoming (source) RGBA values with the RGBA values that are already in
+the frame buffer (the destination values). Blending is initially
+disabled. Use @code{glEnable} and @code{glDisable} with argument
+@code{GL_BLEND} to enable and disable blending.
+
+@code{glBlendFunc} defines the operation of blending when it is enabled.
+@var{sfactor} specifies which method is used to scale the source color
+components. @var{dfactor} specifies which method is used to scale the
+destination color components. The possible methods are described in the
+following table. Each method defines four scale factors, one each for
+red, green, blue, and alpha. In the table and in subsequent equations,
+source and destination color components are referred to as
+@math{(@var{R}_@var{s},@var{G}_@var{s}@var{B}_@var{s}@var{A}_@var{s})}
+and
+@math{(@var{R}_@var{d},@var{G}_@var{d}@var{B}_@var{d}@var{A}_@var{d})}.
+The color specified by @code{glBlendColor} is referred to as
+@math{(@var{R}_@var{c},@var{G}_@var{c}@var{B}_@var{c}@var{A}_@var{c})}.
+They are understood to have integer values between 0 and
+@math{(@var{k}_@var{R},@var{k}_@var{G}@var{k}_@var{B}@var{k}_@var{A})},
+where
+
+@math{@var{k}_@var{c}=2^@var{m}_@var{c},-1}
+
+and
+@math{(@var{m}_@var{R},@var{m}_@var{G}@var{m}_@var{B}@var{m}_@var{A})}
+is the number of red, green, blue, and alpha bitplanes.
+
+Source and destination scale factors are referred to as
+@math{(@var{s}_@var{R},@var{s}_@var{G}@var{s}_@var{B}@var{s}_@var{A})}
+and
+@math{(@var{d}_@var{R},@var{d}_@var{G}@var{d}_@var{B}@var{d}_@var{A})}.
+The scale factors described in the table, denoted
+@math{(@var{f}_@var{R},@var{f}_@var{G}@var{f}_@var{B}@var{f}_@var{A})},
+represent either source or destination factors. All scale factors have
+range @math{[0,1]}.
+
+
+
+@table @asis
+@item @strong{Parameter}
+@strong{@math{(@var{f}_@var{R},@var{f}_@var{G}@var{f}_@var{B}@var{f}_@var{A})}}
+
+@item @code{GL_ZERO}
+@math{(0,000)}
+
+@item @code{GL_ONE}
+@math{(1,111)}
+
+@item @code{GL_SRC_COLOR}
+@math{(@var{R}_@var{s}/@var{k}_@var{R},@var{G}_@var{s}/@var{k}_@var{G}@var{B}_@var{s}/@var{k}_@var{B}@var{A}_@var{s}/@var{k}_@var{A})}
+
+@item @code{GL_ONE_MINUS_SRC_COLOR}
+@math{(1,111)-(@var{R}_@var{s}/@var{k}_@var{R},@var{G}_@var{s}/@var{k}_@var{G}@var{B}_@var{s}/@var{k}_@var{B}@var{A}_@var{s}/@var{k}_@var{A})}
+
+@item @code{GL_DST_COLOR}
+@math{(@var{R}_@var{d}/@var{k}_@var{R},@var{G}_@var{d}/@var{k}_@var{G}@var{B}_@var{d}/@var{k}_@var{B}@var{A}_@var{d}/@var{k}_@var{A})}
+
+@item @code{GL_ONE_MINUS_DST_COLOR}
+@math{(1,111)-(@var{R}_@var{d}/@var{k}_@var{R},@var{G}_@var{d}/@var{k}_@var{G}@var{B}_@var{d}/@var{k}_@var{B}@var{A}_@var{d}/@var{k}_@var{A})}
+
+@item @code{GL_SRC_ALPHA}
+@math{(@var{A}_@var{s}/@var{k}_@var{A},@var{A}_@var{s}/@var{k}_@var{A}@var{A}_@var{s}/@var{k}_@var{A}@var{A}_@var{s}/@var{k}_@var{A})}
+
+@item @code{GL_ONE_MINUS_SRC_ALPHA}
+@math{(1,111)-(@var{A}_@var{s}/@var{k}_@var{A},@var{A}_@var{s}/@var{k}_@var{A}@var{A}_@var{s}/@var{k}_@var{A}@var{A}_@var{s}/@var{k}_@var{A})}
+
+@item @code{GL_DST_ALPHA}
+@math{(@var{A}_@var{d}/@var{k}_@var{A},@var{A}_@var{d}/@var{k}_@var{A}@var{A}_@var{d}/@var{k}_@var{A}@var{A}_@var{d}/@var{k}_@var{A})}
+
+@item @code{GL_ONE_MINUS_DST_ALPHA}
+@math{(1,111)-(@var{A}_@var{d}/@var{k}_@var{A},@var{A}_@var{d}/@var{k}_@var{A}@var{A}_@var{d}/@var{k}_@var{A}@var{A}_@var{d}/@var{k}_@var{A})}
+
+@item @code{GL_CONSTANT_COLOR}
+@math{(@var{R}_@var{c},@var{G}_@var{c}@var{B}_@var{c}@var{A}_@var{c})}
+
+@item @code{GL_ONE_MINUS_CONSTANT_COLOR}
+@math{(1,111)-(@var{R}_@var{c},@var{G}_@var{c}@var{B}_@var{c}@var{A}_@var{c})}
+
+@item @code{GL_CONSTANT_ALPHA}
+@math{(@var{A}_@var{c},@var{A}_@var{c}@var{A}_@var{c}@var{A}_@var{c})}
+
+@item @code{GL_ONE_MINUS_CONSTANT_ALPHA}
+@math{(1,111)-(@var{A}_@var{c},@var{A}_@var{c}@var{A}_@var{c}@var{A}_@var{c})}
+
+@item @code{GL_SRC_ALPHA_SATURATE}
+@math{(@var{i},@var{i}@var{i}1)}
+
+@end table
+
+In the table,
+
+@math{@var{i}=@var{min}(@var{A}_@var{s},@var{k}_@var{A}-@var{A}_@var{d})/@var{k}_@var{A}}
+
+To determine the blended RGBA values of a pixel when drawing in RGBA
+mode, the system uses the following equations:
+
+@math{@var{R}_@var{d}=@var{min}(@var{k}_@var{R},@var{R}_@var{s}@var{s}_@var{R}+@var{R}_@var{d}@var{d}_@var{R})}@math{@var{G}_@var{d}=@var{min}(@var{k}_@var{G},@var{G}_@var{s}@var{s}_@var{G}+@var{G}_@var{d}@var{d}_@var{G})}@math{@var{B}_@var{d}=@var{min}(@var{k}_@var{B},@var{B}_@var{s}@var{s}_@var{B}+@var{B}_@var{d}@var{d}_@var{B})}@math{@var{A}_@var{d}=@var{min}(@var{k}_@var{A},@var{A}_@var{s}@var{s}_@var{A}+@var{A}_@var{d}@var{d}_@var{A})}
+
+Despite the apparent precision of the above equations, blending
+arithmetic is not exactly specified, because blending operates with
+imprecise integer color values. However, a blend factor that should be
+equal to 1 is guaranteed not to modify its multiplicand, and a blend
+factor equal to 0 reduces its multiplicand to 0. For example, when
+@var{sfactor} is @code{GL_SRC_ALPHA}, @var{dfactor} is
+@code{GL_ONE_MINUS_SRC_ALPHA}, and @math{@var{A}_@var{s}} is equal to
+@math{@var{k}_@var{A}}, the equations reduce to simple replacement:
+
+@math{@var{R}_@var{d}=@var{R}_@var{s}}@math{@var{G}_@var{d}=@var{G}_@var{s}}@math{@var{B}_@var{d}=@var{B}_@var{s}}@math{@var{A}_@var{d}=@var{A}_@var{s}}
+
+
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if either @var{sfactor} or
+@var{dfactor} is not an accepted value.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glBlendFunc} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glBufferData
+@heading creates and initializes a buffer object's data store
+@heading Parameters
+@table @asis
+@item @var{target}
+Specifies the target buffer object. The symbolic constant must be
+@code{GL_ARRAY_BUFFER}, @code{GL_ELEMENT_ARRAY_BUFFER},
+@code{GL_PIXEL_PACK_BUFFER}, or @code{GL_PIXEL_UNPACK_BUFFER}.
+
+@item @var{size}
+Specifies the size in bytes of the buffer object's new data store.
+
+@item @var{data}
+Specifies a pointer to data that will be copied into the data store for
+initialization, or @code{NULL} if no data is to be copied.
+
+@item @var{usage}
+Specifies the expected usage pattern of the data store. The symbolic
+constant must be @code{GL_STREAM_DRAW}, @code{GL_STREAM_READ},
+@code{GL_STREAM_COPY}, @code{GL_STATIC_DRAW}, @code{GL_STATIC_READ},
+@code{GL_STATIC_COPY}, @code{GL_DYNAMIC_DRAW}, @code{GL_DYNAMIC_READ},
+or @code{GL_DYNAMIC_COPY}.
+
+@end table
+
+@heading Description
+@code{glBufferData} creates a new data store for the buffer object
+currently bound to @var{target}. Any pre-existing data store is deleted.
+The new data store is created with the specified @var{size} in bytes and
+@var{usage}. If @var{data} is not @code{NULL}, the data store is
+initialized with data from this pointer. In its initial state, the new
+data store is not mapped, it has a @code{NULL} mapped pointer, and its
+mapped access is @code{GL_READ_WRITE}.
+
+@var{usage} is a hint to the GL implementation as to how a buffer
+object's data store will be accessed. This enables the GL implementation
+to make more intelligent decisions that may significantly impact buffer
+object performance. It does not, however, constrain the actual usage of
+the data store. @var{usage} can be broken down into two parts: first,
+the frequency of access (modification and usage), and second, the nature
+of that access. The frequency of access may be one of these:
+
+@table @asis
+@item STREAM
+The data store contents will be modified once and used at most a few
+times.
+
+@item STATIC
+The data store contents will be modified once and used many times.
+
+@item DYNAMIC
+The data store contents will be modified repeatedly and used many times.
+
+@end table
+
+The nature of access may be one of these:
+
+@table @asis
+@item DRAW
+The data store contents are modified by the application, and used as the
+source for GL drawing and image specification commands.
+
+@item READ
+The data store contents are modified by reading data from the GL, and
+used to return that data when queried by the application.
+
+@item COPY
+The data store contents are modified by reading data from the GL, and
+used as the source for GL drawing and image specification commands.
+
+@end table
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{target} is not
+@code{GL_ARRAY_BUFFER}, @code{GL_ELEMENT_ARRAY_BUFFER},
+@code{GL_PIXEL_PACK_BUFFER}, or @code{GL_PIXEL_UNPACK_BUFFER}.
+
+@code{GL_INVALID_ENUM} is generated if @var{usage} is not
+@code{GL_STREAM_DRAW}, @code{GL_STREAM_READ}, @code{GL_STREAM_COPY},
+@code{GL_STATIC_DRAW}, @code{GL_STATIC_READ}, @code{GL_STATIC_COPY},
+@code{GL_DYNAMIC_DRAW}, @code{GL_DYNAMIC_READ}, or
+@code{GL_DYNAMIC_COPY}.
+
+@code{GL_INVALID_VALUE} is generated if @var{size} is negative.
+
+@code{GL_INVALID_OPERATION} is generated if the reserved buffer object
+name 0 is bound to @var{target}.
+
+@code{GL_OUT_OF_MEMORY} is generated if the GL is unable to create a
+data store with the specified @var{size}.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glBufferData} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glBufferSubData
+@heading updates a subset of a buffer object's data store
+@heading Parameters
+@table @asis
+@item @var{target}
+Specifies the target buffer object. The symbolic constant must be
+@code{GL_ARRAY_BUFFER}, @code{GL_ELEMENT_ARRAY_BUFFER},
+@code{GL_PIXEL_PACK_BUFFER}, or @code{GL_PIXEL_UNPACK_BUFFER}.
+
+@item @var{offset}
+Specifies the offset into the buffer object's data store where data
+replacement will begin, measured in bytes.
+
+@item @var{size}
+Specifies the size in bytes of the data store region being replaced.
+
+@item @var{data}
+Specifies a pointer to the new data that will be copied into the data
+store.
+
+@end table
+
+@heading Description
+@code{glBufferSubData} redefines some or all of the data store for the
+buffer object currently bound to @var{target}. Data starting at byte
+offset @var{offset} and extending for @var{size} bytes is copied to the
+data store from the memory pointed to by @var{data}. An error is thrown
+if @var{offset} and @var{size} together define a range beyond the bounds
+of the buffer object's data store.
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{target} is not
+@code{GL_ARRAY_BUFFER}, @code{GL_ELEMENT_ARRAY_BUFFER},
+@code{GL_PIXEL_PACK_BUFFER}, or @code{GL_PIXEL_UNPACK_BUFFER}.
+
+@code{GL_INVALID_VALUE} is generated if @var{offset} or @var{size} is
+negative, or if together they define a region of memory that extends
+beyond the buffer object's allocated data store.
+
+@code{GL_INVALID_OPERATION} is generated if the reserved buffer object
+name 0 is bound to @var{target}.
+
+@code{GL_INVALID_OPERATION} is generated if the buffer object being
+updated is mapped.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glBufferSubData} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glCallLists
+@heading execute a list of display lists
+@heading Parameters
+@table @asis
+@item @var{n}
+Specifies the number of display lists to be executed.
+
+@item @var{type}
+Specifies the type of values in @var{lists}. Symbolic constants
+@code{GL_BYTE}, @code{GL_UNSIGNED_BYTE}, @code{GL_SHORT},
+@code{GL_UNSIGNED_SHORT}, @code{GL_INT}, @code{GL_UNSIGNED_INT},
+@code{GL_FLOAT}, @code{GL_2_BYTES}, @code{GL_3_BYTES}, and
+@code{GL_4_BYTES} are accepted.
+
+@item @var{lists}
+Specifies the address of an array of name offsets in the display list.
+The pointer type is void because the offsets can be bytes, shorts, ints,
+or floats, depending on the value of @var{type}.
+
+@end table
+
+@heading Description
+@code{glCallLists} causes each display list in the list of names passed
+as @var{lists} to be executed. As a result, the commands saved in each
+display list are executed in order, just as if they were called without
+using a display list. Names of display lists that have not been defined
+are ignored.
+
+@code{glCallLists} provides an efficient means for executing more than
+one display list. @var{type} allows lists with various name formats to
+be accepted. The formats are as follows:
+
+@table @asis
+@item @code{GL_BYTE}
+@var{lists} is treated as an array of signed bytes, each in the range
+@math{-128} through 127.
+
+@item @code{GL_UNSIGNED_BYTE}
+@var{lists} is treated as an array of unsigned bytes, each in the range
+0 through 255.
+
+@item @code{GL_SHORT}
+@var{lists} is treated as an array of signed two-byte integers, each in
+the range @math{-32768} through 32767.
+
+@item @code{GL_UNSIGNED_SHORT}
+@var{lists} is treated as an array of unsigned two-byte integers, each
+in the range 0 through 65535.
+
+@item @code{GL_INT}
+@var{lists} is treated as an array of signed four-byte integers.
+
+@item @code{GL_UNSIGNED_INT}
+@var{lists} is treated as an array of unsigned four-byte integers.
+
+@item @code{GL_FLOAT}
+@var{lists} is treated as an array of four-byte floating-point values.
+
+@item @code{GL_2_BYTES}
+@var{lists} is treated as an array of unsigned bytes. Each pair of bytes
+specifies a single display-list name. The value of the pair is computed
+as 256 times the unsigned value of the first byte plus the unsigned
+value of the second byte.
+
+@item @code{GL_3_BYTES}
+@var{lists} is treated as an array of unsigned bytes. Each triplet of
+bytes specifies a single display-list name. The value of the triplet is
+computed as 65536 times the unsigned value of the first byte, plus 256
+times the unsigned value of the second byte, plus the unsigned value of
+the third byte.
+
+@item @code{GL_4_BYTES}
+@var{lists} is treated as an array of unsigned bytes. Each quadruplet of
+bytes specifies a single display-list name. The value of the quadruplet
+is computed as 16777216 times the unsigned value of the first byte, plus
+65536 times the unsigned value of the second byte, plus 256 times the
+unsigned value of the third byte, plus the unsigned value of the fourth
+byte.
+
+@end table
+
+The list of display-list names is not null-terminated. Rather, @var{n}
+specifies how many names are to be taken from @var{lists}.
+
+An additional level of indirection is made available with the
+@code{glListBase} command, which specifies an unsigned offset that is
+added to each display-list name specified in @var{lists} before that
+display list is executed.
+
+@code{glCallLists} can appear inside a display list. To avoid the
+possibility of infinite recursion resulting from display lists calling
+one another, a limit is placed on the nesting level of display lists
+during display-list execution. This limit must be at least 64, and it
+depends on the implementation.
+
+GL state is not saved and restored across a call to @code{glCallLists}.
+Thus, changes made to GL state during the execution of the display lists
+remain after execution is completed. Use @code{glPushAttrib},
+@code{glPopAttrib}, @code{glPushMatrix}, and @code{glPopMatrix} to
+preserve GL state across @code{glCallLists} calls.
+
+@heading Errors
+@code{GL_INVALID_VALUE} is generated if @var{n} is negative.
+
+@code{GL_INVALID_ENUM} is generated if @var{type} is not one of
+@code{GL_BYTE}, @code{GL_UNSIGNED_BYTE}, @code{GL_SHORT},
+@code{GL_UNSIGNED_SHORT}, @code{GL_INT}, @code{GL_UNSIGNED_INT},
+@code{GL_FLOAT}, @code{GL_2_BYTES}, @code{GL_3_BYTES},
+@code{GL_4_BYTES}.
+
+@end defun
+
+@defun glCallList
+@heading execute a display list
+@heading Parameters
+@table @asis
+@item @var{list}
+Specifies the integer name of the display list to be executed.
+
+@end table
+
+@heading Description
+@code{glCallList} causes the named display list to be executed. The
+commands saved in the display list are executed in order, just as if
+they were called without using a display list. If @var{list} has not
+been defined as a display list, @code{glCallList} is ignored.
+
+@code{glCallList} can appear inside a display list. To avoid the
+possibility of infinite recursion resulting from display lists calling
+one another, a limit is placed on the nesting level of display lists
+during display-list execution. This limit is at least 64, and it depends
+on the implementation.
+
+GL state is not saved and restored across a call to @code{glCallList}.
+Thus, changes made to GL state during the execution of a display list
+remain after execution of the display list is completed. Use
+@code{glPushAttrib}, @code{glPopAttrib}, @code{glPushMatrix}, and
+@code{glPopMatrix} to preserve GL state across @code{glCallList} calls.
+
+@end defun
+
+@defun glClearAccum
+@heading specify clear values for the accumulation buffer
+@heading Parameters
+@table @asis
+@item @var{red}
+@itemx @var{green}
+@itemx @var{blue}
+@itemx @var{alpha}
+Specify the red, green, blue, and alpha values used when the
+accumulation buffer is cleared. The initial values are all 0.
+
+@end table
+
+@heading Description
+@code{glClearAccum} specifies the red, green, blue, and alpha values
+used by @code{glClear} to clear the accumulation buffer.
+
+Values specified by @code{glClearAccum} are clamped to the range
+@math{[-1,1]}.
+
+@heading Errors
+@code{GL_INVALID_OPERATION} is generated if @code{glClearAccum} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glClearColor
+@heading specify clear values for the color buffers
+@heading Parameters
+@table @asis
+@item @var{red}
+@itemx @var{green}
+@itemx @var{blue}
+@itemx @var{alpha}
+Specify the red, green, blue, and alpha values used when the color
+buffers are cleared. The initial values are all 0.
+
+@end table
+
+@heading Description
+@code{glClearColor} specifies the red, green, blue, and alpha values
+used by @code{glClear} to clear the color buffers. Values specified by
+@code{glClearColor} are clamped to the range @math{[0,1]}.
+
+@heading Errors
+@code{GL_INVALID_OPERATION} is generated if @code{glClearColor} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glClearDepth
+@heading specify the clear value for the depth buffer
+@heading Parameters
+@table @asis
+@item @var{depth}
+Specifies the depth value used when the depth buffer is cleared. The
+initial value is 1.
+
+@end table
+
+@heading Description
+@code{glClearDepth} specifies the depth value used by @code{glClear} to
+clear the depth buffer. Values specified by @code{glClearDepth} are
+clamped to the range @math{[0,1]}.
+
+@heading Errors
+@code{GL_INVALID_OPERATION} is generated if @code{glClearDepth} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glClearIndex
+@heading specify the clear value for the color index buffers
+@heading Parameters
+@table @asis
+@item @var{c}
+Specifies the index used when the color index buffers are cleared. The
+initial value is 0.
+
+@end table
+
+@heading Description
+@code{glClearIndex} specifies the index used by @code{glClear} to clear
+the color index buffers. @var{c} is not clamped. Rather, @var{c} is
+converted to a fixed-point value with unspecified precision to the right
+of the binary point. The integer part of this value is then masked with
+@math{2^@var{m}-1}, where @math{@var{m}} is the number of bits in a
+color index stored in the frame buffer.
+
+@heading Errors
+@code{GL_INVALID_OPERATION} is generated if @code{glClearIndex} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glClearStencil
+@heading specify the clear value for the stencil buffer
+@heading Parameters
+@table @asis
+@item @var{s}
+Specifies the index used when the stencil buffer is cleared. The initial
+value is 0.
+
+@end table
+
+@heading Description
+@code{glClearStencil} specifies the index used by @code{glClear} to
+clear the stencil buffer. @var{s} is masked with @math{2^@var{m}-1},
+where @math{@var{m}} is the number of bits in the stencil buffer.
+
+@heading Errors
+@code{GL_INVALID_OPERATION} is generated if @code{glClearStencil} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glClear
+@heading clear buffers to preset values
+@heading Parameters
+@table @asis
+@item @var{mask}
+Bitwise OR of masks that indicate the buffers to be cleared. The four
+masks are @code{GL_COLOR_BUFFER_BIT}, @code{GL_DEPTH_BUFFER_BIT},
+@code{GL_ACCUM_BUFFER_BIT}, and @code{GL_STENCIL_BUFFER_BIT}.
+
+@end table
+
+@heading Description
+@code{glClear} sets the bitplane area of the window to values previously
+selected by @code{glClearColor}, @code{glClearIndex},
+@code{glClearDepth}, @code{glClearStencil}, and @code{glClearAccum}.
+Multiple color buffers can be cleared simultaneously by selecting more
+than one buffer at a time using @code{glDrawBuffer}.
+
+The pixel ownership test, the scissor test, dithering, and the buffer
+writemasks affect the operation of @code{glClear}. The scissor box
+bounds the cleared region. Alpha function, blend function, logical
+operation, stenciling, texture mapping, and depth-buffering are ignored
+by @code{glClear}.
+
+@code{glClear} takes a single argument that is the bitwise OR of several
+values indicating which buffer is to be cleared.
+
+The values are as follows:
+
+@table @asis
+@item @code{GL_COLOR_BUFFER_BIT}
+Indicates the buffers currently enabled for color writing.
+
+@item @code{GL_DEPTH_BUFFER_BIT}
+Indicates the depth buffer.
+
+@item @code{GL_ACCUM_BUFFER_BIT}
+Indicates the accumulation buffer.
+
+@item @code{GL_STENCIL_BUFFER_BIT}
+Indicates the stencil buffer.
+
+@end table
+
+The value to which each buffer is cleared depends on the setting of the
+clear value for that buffer.
+
+@heading Errors
+@code{GL_INVALID_VALUE} is generated if any bit other than the four
+defined bits is set in @var{mask}.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glClear} is executed
+between the execution of @code{glBegin} and the corresponding execution
+of @code{glEnd}.
+
+@end defun
+
+@defun glClientActiveTexture
+@heading select active texture unit
+@heading Parameters
+@table @asis
+@item @var{texture}
+Specifies which texture unit to make active. The number of texture units
+is implementation dependent, but must be at least two. @var{texture}
+must be one of @code{GL_TEXTURE}@math{@var{i}}, where i ranges from 0 to
+the value of @code{GL_MAX_TEXTURE_COORDS} - 1, which is an
+implementation-dependent value. The initial value is @code{GL_TEXTURE0}.
+
+@end table
+
+@heading Description
+@code{glClientActiveTexture} selects the vertex array client state
+parameters to be modified by @code{glTexCoordPointer}, and enabled or
+disabled with @code{glEnableClientState} or @code{glDisableClientState},
+respectively, when called with a parameter of
+@code{GL_TEXTURE_COORD_ARRAY}.
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{texture} is not one of
+@code{GL_TEXTURE}@math{@var{i}}, where i ranges from 0 to the value of
+@code{GL_MAX_TEXTURE_COORDS} - 1.
+
+@end defun
+
+@defun glClipPlane
+@heading specify a plane against which all geometry is clipped
+@heading Parameters
+@table @asis
+@item @var{plane}
+Specifies which clipping plane is being positioned. Symbolic names of
+the form @code{GL_CLIP_PLANE}@var{i}, where @var{i} is an integer
+between 0 and @code{GL_MAX_CLIP_PLANES}@math{-1}, are accepted.
+
+@item @var{equation}
+Specifies the address of an array of four double-precision
+floating-point values. These values are interpreted as a plane equation.
+
+@end table
+
+@heading Description
+Geometry is always clipped against the boundaries of a six-plane frustum
+in @var{x}, @var{y}, and @var{z}. @code{glClipPlane} allows the
+specification of additional planes, not necessarily perpendicular to the
+@var{x}, @var{y}, or @var{z} axis, against which all geometry is
+clipped. To determine the maximum number of additional clipping planes,
+call @code{glGetIntegerv} with argument @code{GL_MAX_CLIP_PLANES}. All
+implementations support at least six such clipping planes. Because the
+resulting clipping region is the intersection of the defined
+half-spaces, it is always convex.
+
+@code{glClipPlane} specifies a half-space using a four-component plane
+equation. When @code{glClipPlane} is called, @var{equation} is
+transformed by the inverse of the modelview matrix and stored in the
+resulting eye coordinates. Subsequent changes to the modelview matrix
+have no effect on the stored plane-equation components. If the dot
+product of the eye coordinates of a vertex with the stored plane
+equation components is positive or zero, the vertex is @var{in} with
+respect to that clipping plane. Otherwise, it is @var{out}.
+
+To enable and disable clipping planes, call @code{glEnable} and
+@code{glDisable} with the argument @code{GL_CLIP_PLANE}@var{i}, where
+@var{i} is the plane number.
+
+All clipping planes are initially defined as (0, 0, 0, 0) in eye
+coordinates and are disabled.
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{plane} is not an accepted
+value.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glClipPlane} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glColorMask
+@heading enable and disable writing of frame buffer color components
+@heading Parameters
+@table @asis
+@item @var{red}
+@itemx @var{green}
+@itemx @var{blue}
+@itemx @var{alpha}
+Specify whether red, green, blue, and alpha can or cannot be written
+into the frame buffer. The initial values are all @code{GL_TRUE},
+indicating that the color components can be written.
+
+@end table
+
+@heading Description
+@code{glColorMask} specifies whether the individual color components in
+the frame buffer can or cannot be written. If @var{red} is
+@code{GL_FALSE}, for example, no change is made to the red component of
+any pixel in any of the color buffers, regardless of the drawing
+operation attempted.
+
+Changes to individual bits of components cannot be controlled. Rather,
+changes are either enabled or disabled for entire color components.
+
+@heading Errors
+@code{GL_INVALID_OPERATION} is generated if @code{glColorMask} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glColorMaterial
+@heading cause a material color to track the current color
+@heading Parameters
+@table @asis
+@item @var{face}
+Specifies whether front, back, or both front and back material
+parameters should track the current color. Accepted values are
+@code{GL_FRONT}, @code{GL_BACK}, and @code{GL_FRONT_AND_BACK}. The
+initial value is @code{GL_FRONT_AND_BACK}.
+
+@item @var{mode}
+Specifies which of several material parameters track the current color.
+Accepted values are @code{GL_EMISSION}, @code{GL_AMBIENT},
+@code{GL_DIFFUSE}, @code{GL_SPECULAR}, and
+@code{GL_AMBIENT_AND_DIFFUSE}. The initial value is
+@code{GL_AMBIENT_AND_DIFFUSE}.
+
+@end table
+
+@heading Description
+@code{glColorMaterial} specifies which material parameters track the
+current color. When @code{GL_COLOR_MATERIAL} is enabled, the material
+parameter or parameters specified by @var{mode}, of the material or
+materials specified by @var{face}, track the current color at all times.
+
+To enable and disable @code{GL_COLOR_MATERIAL}, call @code{glEnable} and
+@code{glDisable} with argument @code{GL_COLOR_MATERIAL}.
+@code{GL_COLOR_MATERIAL} is initially disabled.
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{face} or @var{mode} is not
+an accepted value.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glColorMaterial} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glColorPointer
+@heading define an array of colors
+@heading Parameters
+@table @asis
+@item @var{size}
+Specifies the number of components per color. Must be 3 or 4. The
+initial value is 4.
+
+@item @var{type}
+Specifies the data type of each color component in the array. Symbolic
+constants @code{GL_BYTE}, @code{GL_UNSIGNED_BYTE}, @code{GL_SHORT},
+@code{GL_UNSIGNED_SHORT}, @code{GL_INT}, @code{GL_UNSIGNED_INT},
+@code{GL_FLOAT}, and @code{GL_DOUBLE} are accepted. The initial value is
+@code{GL_FLOAT}.
+
+@item @var{stride}
+Specifies the byte offset between consecutive colors. If @var{stride} is
+0, the colors are understood to be tightly packed in the array. The
+initial value is 0.
+
+@item @var{pointer}
+Specifies a pointer to the first component of the first color element in
+the array. The initial value is 0.
+
+@end table
+
+@heading Description
+@code{glColorPointer} specifies the location and data format of an array
+of color components to use when rendering. @var{size} specifies the
+number of components per color, and must be 3 or 4. @var{type} specifies
+the data type of each color component, and @var{stride} specifies the
+byte stride from one color to the next, allowing vertices and attributes
+to be packed into a single array or stored in separate arrays.
+(Single-array storage may be more efficient on some implementations; see
+@code{glInterleavedArrays}.)
+
+If a non-zero named buffer object is bound to the @code{GL_ARRAY_BUFFER}
+target (see @code{glBindBuffer}) while a color array is specified,
+@var{pointer} is treated as a byte offset into the buffer object's data
+store. Also, the buffer object binding (@code{GL_ARRAY_BUFFER_BINDING})
+is saved as color vertex array client-side state
+(@code{GL_COLOR_ARRAY_BUFFER_BINDING}).
+
+When a color array is specified, @var{size}, @var{type}, @var{stride},
+and @var{pointer} are saved as client-side state, in addition to the
+current vertex array buffer object binding.
+
+To enable and disable the color array, call @code{glEnableClientState}
+and @code{glDisableClientState} with the argument @code{GL_COLOR_ARRAY}.
+If enabled, the color array is used when @code{glDrawArrays},
+@code{glMultiDrawArrays}, @code{glDrawElements},
+@code{glMultiDrawElements}, @code{glDrawRangeElements}, or
+@code{glArrayElement} is called.
+
+@heading Errors
+@code{GL_INVALID_VALUE} is generated if @var{size} is not 3 or 4.
+
+@code{GL_INVALID_ENUM} is generated if @var{type} is not an accepted
+value.
+
+@code{GL_INVALID_VALUE} is generated if @var{stride} is negative.
+
+@end defun
+
+@defun glColorSubTable
+@heading respecify a portion of a color table
+@heading Parameters
+@table @asis
+@item @var{target}
+Must be one of @code{GL_COLOR_TABLE},
+@code{GL_POST_CONVOLUTION_COLOR_TABLE}, or
+@code{GL_POST_COLOR_MATRIX_COLOR_TABLE}.
+
+@item @var{start}
+The starting index of the portion of the color table to be replaced.
+
+@item @var{count}
+The number of table entries to replace.
+
+@item @var{format}
+The format of the pixel data in @var{data}. The allowable values are
+@code{GL_RED}, @code{GL_GREEN}, @code{GL_BLUE}, @code{GL_ALPHA},
+@code{GL_LUMINANCE}, @code{GL_LUMINANCE_ALPHA}, @code{GL_RGB},
+@code{GL_BGR}, @code{GL_RGBA}, and @code{GL_BGRA}.
+
+@item @var{type}
+The type of the pixel data in @var{data}. The allowable values are
+@code{GL_UNSIGNED_BYTE}, @code{GL_BYTE}, @code{GL_UNSIGNED_SHORT},
+@code{GL_SHORT}, @code{GL_UNSIGNED_INT}, @code{GL_INT}, @code{GL_FLOAT},
+@code{GL_UNSIGNED_BYTE_3_3_2}, @code{GL_UNSIGNED_BYTE_2_3_3_REV},
+@code{GL_UNSIGNED_SHORT_5_6_5}, @code{GL_UNSIGNED_SHORT_5_6_5_REV},
+@code{GL_UNSIGNED_SHORT_4_4_4_4}, @code{GL_UNSIGNED_SHORT_4_4_4_4_REV},
+@code{GL_UNSIGNED_SHORT_5_5_5_1}, @code{GL_UNSIGNED_SHORT_1_5_5_5_REV},
+@code{GL_UNSIGNED_INT_8_8_8_8}, @code{GL_UNSIGNED_INT_8_8_8_8_REV},
+@code{GL_UNSIGNED_INT_10_10_10_2}, and
+@code{GL_UNSIGNED_INT_2_10_10_10_REV}.
+
+@item @var{data}
+Pointer to a one-dimensional array of pixel data that is processed to
+replace the specified region of the color table.
+
+@end table
+
+@heading Description
+@code{glColorSubTable} is used to respecify a contiguous portion of a
+color table previously defined using @code{glColorTable}. The pixels
+referenced by @var{data} replace the portion of the existing table from
+indices @var{start} to @math{@var{start}+@var{count}-1}, inclusive. This
+region may not include any entries outside the range of the color table
+as it was originally specified. It is not an error to specify a
+subtexture with width of 0, but such a specification has no effect.
+
+If a non-zero named buffer object is bound to the
+@code{GL_PIXEL_UNPACK_BUFFER} target (see @code{glBindBuffer}) while a
+portion of a color table is respecified, @var{data} is treated as a byte
+offset into the buffer object's data store.
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{target} is not one of the
+allowable values.
+
+@code{GL_INVALID_ENUM} is generated if @var{format} is not one of the
+allowable values.
+
+@code{GL_INVALID_ENUM} is generated if @var{type} is not one of the
+allowable values.
+
+@code{GL_INVALID_VALUE} is generated if
+@math{@var{start}+@var{count}>@var{width}}.
+
+@code{GL_INVALID_OPERATION} is generated if a non-zero buffer object
+name is bound to the @code{GL_PIXEL_UNPACK_BUFFER} target and the buffer
+object's data store is currently mapped.
+
+@code{GL_INVALID_OPERATION} is generated if a non-zero buffer object
+name is bound to the @code{GL_PIXEL_UNPACK_BUFFER} target and the data
+would be unpacked from the buffer object such that the memory reads
+required would exceed the data store size.
+
+@code{GL_INVALID_OPERATION} is generated if a non-zero buffer object
+name is bound to the @code{GL_PIXEL_UNPACK_BUFFER} target and @var{data}
+is not evenly divisible into the number of bytes needed to store in
+memory a datum indicated by @var{type}.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glColorSubTable} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glColorTableParameter
+@heading set color lookup table parameters
+@heading Parameters
+@table @asis
+@item @var{target}
+The target color table. Must be @code{GL_COLOR_TABLE},
+@code{GL_POST_CONVOLUTION_COLOR_TABLE}, or
+@code{GL_POST_COLOR_MATRIX_COLOR_TABLE}.
+
+@item @var{pname}
+The symbolic name of a texture color lookup table parameter. Must be one
+of @code{GL_COLOR_TABLE_SCALE} or @code{GL_COLOR_TABLE_BIAS}.
+
+@item @var{params}
+A pointer to an array where the values of the parameters are stored.
+
+@end table
+
+@heading Description
+@code{glColorTableParameter} is used to specify the scale factors and
+bias terms applied to color components when they are loaded into a color
+table. @var{target} indicates which color table the scale and bias terms
+apply to; it must be set to @code{GL_COLOR_TABLE},
+@code{GL_POST_CONVOLUTION_COLOR_TABLE}, or
+@code{GL_POST_COLOR_MATRIX_COLOR_TABLE}.
+
+@var{pname} must be @code{GL_COLOR_TABLE_SCALE} to set the scale
+factors. In this case, @var{params} points to an array of four values,
+which are the scale factors for red, green, blue, and alpha, in that
+order.
+
+@var{pname} must be @code{GL_COLOR_TABLE_BIAS} to set the bias terms. In
+this case, @var{params} points to an array of four values, which are the
+bias terms for red, green, blue, and alpha, in that order.
+
+The color tables themselves are specified by calling
+@code{glColorTable}.
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{target} or @var{pname} is
+not an acceptable value.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glColorTableParameter}
+is executed between the execution of @code{glBegin} and the
+corresponding execution of @code{glEnd}.
+
+@end defun
+
+@defun glColorTable
+@heading define a color lookup table
+@heading Parameters
+@table @asis
+@item @var{target}
+Must be one of @code{GL_COLOR_TABLE},
+@code{GL_POST_CONVOLUTION_COLOR_TABLE},
+@code{GL_POST_COLOR_MATRIX_COLOR_TABLE}, @code{GL_PROXY_COLOR_TABLE},
+@code{GL_PROXY_POST_CONVOLUTION_COLOR_TABLE}, or
+@code{GL_PROXY_POST_COLOR_MATRIX_COLOR_TABLE}.
+
+@item @var{internalformat}
+The internal format of the color table. The allowable values are
+@code{GL_ALPHA}, @code{GL_ALPHA4}, @code{GL_ALPHA8}, @code{GL_ALPHA12},
+@code{GL_ALPHA16}, @code{GL_LUMINANCE}, @code{GL_LUMINANCE4},
+@code{GL_LUMINANCE8}, @code{GL_LUMINANCE12}, @code{GL_LUMINANCE16},
+@code{GL_LUMINANCE_ALPHA}, @code{GL_LUMINANCE4_ALPHA4},
+@code{GL_LUMINANCE6_ALPHA2}, @code{GL_LUMINANCE8_ALPHA8},
+@code{GL_LUMINANCE12_ALPHA4}, @code{GL_LUMINANCE12_ALPHA12},
+@code{GL_LUMINANCE16_ALPHA16}, @code{GL_INTENSITY},
+@code{GL_INTENSITY4}, @code{GL_INTENSITY8}, @code{GL_INTENSITY12},
+@code{GL_INTENSITY16}, @code{GL_R3_G3_B2}, @code{GL_RGB},
+@code{GL_RGB4}, @code{GL_RGB5}, @code{GL_RGB8}, @code{GL_RGB10},
+@code{GL_RGB12}, @code{GL_RGB16}, @code{GL_RGBA}, @code{GL_RGBA2},
+@code{GL_RGBA4}, @code{GL_RGB5_A1}, @code{GL_RGBA8}, @code{GL_RGB10_A2},
+@code{GL_RGBA12}, and @code{GL_RGBA16}.
+
+@item @var{width}
+The number of entries in the color lookup table specified by @var{data}.
+
+@item @var{format}
+The format of the pixel data in @var{data}. The allowable values are
+@code{GL_RED}, @code{GL_GREEN}, @code{GL_BLUE}, @code{GL_ALPHA},
+@code{GL_LUMINANCE}, @code{GL_LUMINANCE_ALPHA}, @code{GL_RGB},
+@code{GL_BGR}, @code{GL_RGBA}, and @code{GL_BGRA}.
+
+@item @var{type}
+The type of the pixel data in @var{data}. The allowable values are
+@code{GL_UNSIGNED_BYTE}, @code{GL_BYTE}, @code{GL_UNSIGNED_SHORT},
+@code{GL_SHORT}, @code{GL_UNSIGNED_INT}, @code{GL_INT}, @code{GL_FLOAT},
+@code{GL_UNSIGNED_BYTE_3_3_2}, @code{GL_UNSIGNED_BYTE_2_3_3_REV},
+@code{GL_UNSIGNED_SHORT_5_6_5}, @code{GL_UNSIGNED_SHORT_5_6_5_REV},
+@code{GL_UNSIGNED_SHORT_4_4_4_4}, @code{GL_UNSIGNED_SHORT_4_4_4_4_REV},
+@code{GL_UNSIGNED_SHORT_5_5_5_1}, @code{GL_UNSIGNED_SHORT_1_5_5_5_REV},
+@code{GL_UNSIGNED_INT_8_8_8_8}, @code{GL_UNSIGNED_INT_8_8_8_8_REV},
+@code{GL_UNSIGNED_INT_10_10_10_2}, and
+@code{GL_UNSIGNED_INT_2_10_10_10_REV}.
+
+@item @var{data}
+Pointer to a one-dimensional array of pixel data that is processed to
+build the color table.
+
+@end table
+
+@heading Description
+@code{glColorTable} may be used in two ways: to test the actual size and
+color resolution of a lookup table given a particular set of parameters,
+or to load the contents of a color lookup table. Use the targets
+@code{GL_PROXY_*} for the first case and the other targets for the
+second case.
+
+If a non-zero named buffer object is bound to the
+@code{GL_PIXEL_UNPACK_BUFFER} target (see @code{glBindBuffer}) while a
+color table is specified, @var{data} is treated as a byte offset into
+the buffer object's data store.
+
+If @var{target} is @code{GL_COLOR_TABLE},
+@code{GL_POST_CONVOLUTION_COLOR_TABLE}, or
+@code{GL_POST_COLOR_MATRIX_COLOR_TABLE}, @code{glColorTable} builds a
+color lookup table from an array of pixels. The pixel array specified by
+@var{width}, @var{format}, @var{type}, and @var{data} is extracted from
+memory and processed just as if @code{glDrawPixels} were called, but
+processing stops after the final expansion to RGBA is completed.
+
+The four scale parameters and the four bias parameters that are defined
+for the table are then used to scale and bias the R, G, B, and A
+components of each pixel. (Use @code{glColorTableParameter} to set these
+scale and bias parameters.)
+
+Next, the R, G, B, and A values are clamped to the range @math{[0,1]}.
+Each pixel is then converted to the internal format specified by
+@var{internalformat}. This conversion simply maps the component values
+of the pixel (R, G, B, and A) to the values included in the internal
+format (red, green, blue, alpha, luminance, and intensity). The mapping
+is as follows:
+
+
+
+@table @asis
+@item @strong{Internal Format}
+@strong{Red}, @strong{Green}, @strong{Blue}, @strong{Alpha},
+@strong{Luminance}, @strong{Intensity}
+
+@item @code{GL_ALPHA}
+, , , A , ,
+
+@item @code{GL_LUMINANCE}
+, , , , R ,
+
+@item @code{GL_LUMINANCE_ALPHA}
+, , , A , R ,
+
+@item @code{GL_INTENSITY}
+, , , , , R
+
+@item @code{GL_RGB}
+R , G , B , , ,
+
+@item @code{GL_RGBA}
+R , G , B , A , ,
+
+@end table
+
+Finally, the red, green, blue, alpha, luminance, and/or intensity
+components of the resulting pixels are stored in the color table. They
+form a one-dimensional table with indices in the range
+@math{[0,@var{width}-1]}.
+
+If @var{target} is @code{GL_PROXY_*}, @code{glColorTable} recomputes and
+stores the values of the proxy color table's state variables
+@code{GL_COLOR_TABLE_FORMAT}, @code{GL_COLOR_TABLE_WIDTH},
+@code{GL_COLOR_TABLE_RED_SIZE}, @code{GL_COLOR_TABLE_GREEN_SIZE},
+@code{GL_COLOR_TABLE_BLUE_SIZE}, @code{GL_COLOR_TABLE_ALPHA_SIZE},
+@code{GL_COLOR_TABLE_LUMINANCE_SIZE}, and
+@code{GL_COLOR_TABLE_INTENSITY_SIZE}. There is no effect on the image or
+state of any actual color table. If the specified color table is too
+large to be supported, then all the proxy state variables listed above
+are set to zero. Otherwise, the color table could be supported by
+@code{glColorTable} using the corresponding non-proxy target, and the
+proxy state variables are set as if that target were being defined.
+
+The proxy state variables can be retrieved by calling
+@code{glGetColorTableParameter} with a target of @code{GL_PROXY_*}. This
+allows the application to decide if a particular @code{glColorTable}
+command would succeed, and to determine what the resulting color table
+attributes would be.
+
+If a color table is enabled, and its width is non-zero, then its
+contents are used to replace a subset of the components of each RGBA
+pixel group, based on the internal format of the table.
+
+Each pixel group has color components (R, G, B, A) that are in the range
+@math{[0.0,1.0]}. The color components are rescaled to the size of the
+color lookup table to form an index. Then a subset of the components
+based on the internal format of the table are replaced by the table
+entry selected by that index. If the color components and contents of
+the table are represented as follows:
+
+
+
+@table @asis
+@item @strong{Representation}
+@strong{Meaning}
+
+@item @code{r}
+Table index computed from @code{R}
+
+@item @code{g}
+Table index computed from @code{G}
+
+@item @code{b}
+Table index computed from @code{B}
+
+@item @code{a}
+Table index computed from @code{A}
+
+@item @code{L[i]}
+Luminance value at table index @code{i}
+
+@item @code{I[i]}
+Intensity value at table index @code{i}
+
+@item @code{R[i]}
+Red value at table index @code{i}
+
+@item @code{G[i]}
+Green value at table index @code{i}
+
+@item @code{B[i]}
+Blue value at table index @code{i}
+
+@item @code{A[i]}
+Alpha value at table index @code{i}
+
+@end table
+
+then the result of color table lookup is as follows:
+
+
+
+@table @asis
+@item @strong{}
+@strong{Resulting Texture Components}
+
+@item @strong{Table Internal Format}
+@strong{R}, @strong{G}, @strong{B}, @strong{A}
+
+@item @code{GL_ALPHA}
+@code{R}, @code{G}, @code{B}, @code{A[a]}
+
+@item @code{GL_LUMINANCE}
+@code{L[r]}, @code{L[g]}, @code{L[b]}, @code{At}
+
+@item @code{GL_LUMINANCE_ALPHA}
+@code{L[r]}, @code{L[g]}, @code{L[b]}, @code{A[a]}
+
+@item @code{GL_INTENSITY}
+@code{I[r]}, @code{I[g]}, @code{I[b]}, @code{I[a]}
+
+@item @code{GL_RGB}
+@code{R[r]}, @code{G[g]}, @code{B[b]}, @code{A}
+
+@item @code{GL_RGBA}
+@code{R[r]}, @code{G[g]}, @code{B[b]}, @code{A[a]}
+
+@end table
+
+When @code{GL_COLOR_TABLE} is enabled, the colors resulting from the
+pixel map operation (if it is enabled) are mapped by the color lookup
+table before being passed to the convolution operation. The colors
+resulting from the convolution operation are modified by the post
+convolution color lookup table when
+@code{GL_POST_CONVOLUTION_COLOR_TABLE} is enabled. These modified colors
+are then sent to the color matrix operation. Finally, if
+@code{GL_POST_COLOR_MATRIX_COLOR_TABLE} is enabled, the colors resulting
+from the color matrix operation are mapped by the post color matrix
+color lookup table before being used by the histogram operation.
+
+
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{target} is not one of the
+allowable values.
+
+@code{GL_INVALID_ENUM} is generated if @var{internalformat} is not one
+of the allowable values.
+
+@code{GL_INVALID_ENUM} is generated if @var{format} is not one of the
+allowable values.
+
+@code{GL_INVALID_ENUM} is generated if @var{type} is not one of the
+allowable values.
+
+@code{GL_INVALID_VALUE} is generated if @var{width} is less than zero.
+
+@code{GL_TABLE_TOO_LARGE} is generated if the requested color table is
+too large to be supported by the implementation, and @var{target} is not
+a @code{GL_PROXY_*} target.
+
+@code{GL_INVALID_OPERATION} is generated if a non-zero buffer object
+name is bound to the @code{GL_PIXEL_UNPACK_BUFFER} target and the buffer
+object's data store is currently mapped.
+
+@code{GL_INVALID_OPERATION} is generated if a non-zero buffer object
+name is bound to the @code{GL_PIXEL_UNPACK_BUFFER} target and the data
+would be unpacked from the buffer object such that the memory reads
+required would exceed the data store size.
+
+@code{GL_INVALID_OPERATION} is generated if a non-zero buffer object
+name is bound to the @code{GL_PIXEL_UNPACK_BUFFER} target and @var{data}
+is not evenly divisible into the number of bytes needed to store in
+memory a datum indicated by @var{type}.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glColorTable} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glColor
+@heading set the current color
+@heading Parameters
+@table @asis
+@item @var{red}
+@itemx @var{green}
+@itemx @var{blue}
+Specify new red, green, and blue values for the current color.
+
+@item @var{alpha}
+Specifies a new alpha value for the current color. Included only in the
+four-argument @code{glColor4} commands.
+
+@end table
+
+@heading Description
+The GL stores both a current single-valued color index and a current
+four-valued RGBA color. @code{glColor} sets a new four-valued RGBA
+color. @code{glColor} has two major variants: @code{glColor3} and
+@code{glColor4}. @code{glColor3} variants specify new red, green, and
+blue values explicitly and set the current alpha value to 1.0 (full
+intensity) implicitly. @code{glColor4} variants specify all four color
+components explicitly.
+
+@code{glColor3b}, @code{glColor4b}, @code{glColor3s}, @code{glColor4s},
+@code{glColor3i}, and @code{glColor4i} take three or four signed byte,
+short, or long integers as arguments. When @strong{v} is appended to the
+name, the color commands can take a pointer to an array of such values.
+
+Current color values are stored in floating-point format, with
+unspecified mantissa and exponent sizes. Unsigned integer color
+components, when specified, are linearly mapped to floating-point values
+such that the largest representable value maps to 1.0 (full intensity),
+and 0 maps to 0.0 (zero intensity). Signed integer color components,
+when specified, are linearly mapped to floating-point values such that
+the most positive representable value maps to 1.0, and the most negative
+representable value maps to @math{-1.0}. (Note that this mapping does
+not convert 0 precisely to 0.0.) Floating-point values are mapped
+directly.
+
+Neither floating-point nor signed integer values are clamped to the
+range @math{[0,1]} before the current color is updated. However, color
+components are clamped to this range before they are interpolated or
+written into a color buffer.
+
+@end defun
+
+@defun glCompileShader
+@heading Compiles a shader object
+@heading Parameters
+@table @asis
+@item @var{shader}
+Specifies the shader object to be compiled.
+
+@end table
+
+@heading Description
+@code{glCompileShader} compiles the source code strings that have been
+stored in the shader object specified by @var{shader}.
+
+The compilation status will be stored as part of the shader object's
+state. This value will be set to @code{GL_TRUE} if the shader was
+compiled without errors and is ready for use, and @code{GL_FALSE}
+otherwise. It can be queried by calling @code{glGetShader} with
+arguments @var{shader} and @code{GL_COMPILE_STATUS}.
+
+Compilation of a shader can fail for a number of reasons as specified by
+the OpenGL Shading Language Specification. Whether or not the
+compilation was successful, information about the compilation can be
+obtained from the shader object's information log by calling
+@code{glGetShaderInfoLog}.
+
+@heading Errors
+@code{GL_INVALID_VALUE} is generated if @var{shader} is not a value
+generated by OpenGL.
+
+@code{GL_INVALID_OPERATION} is generated if @var{shader} is not a shader
+object.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glCompileShader} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glCompressedTexImage1D
+@heading specify a one-dimensional texture image in a compressed format
+@heading Parameters
+@table @asis
+@item @var{target}
+Specifies the target texture. Must be @code{GL_TEXTURE_1D} or
+@code{GL_PROXY_TEXTURE_1D}.
+
+@item @var{level}
+Specifies the level-of-detail number. Level 0 is the base image level.
+Level @var{n} is the @var{n}th mipmap reduction image.
+
+@item @var{internalformat}
+Specifies the format of the compressed image data stored at address
+@var{data}.
+
+@item @var{width}
+Specifies the width of the texture image including the border if any. If
+the GL version does not support non-power-of-two sizes, this value must
+be @math{2^@var{n}+2(@var{border},)} for some integer @math{@var{n}}.
+All implementations support texture images that are at least 64 texels
+wide. The height of the 1D texture image is 1.
+
+@item @var{border}
+Specifies the width of the border. Must be either 0 or 1.
+
+@item @var{imageSize}
+Specifies the number of unsigned bytes of image data starting at the
+address specified by @var{data}.
+
+@item @var{data}
+Specifies a pointer to the compressed image data in memory.
+
+@end table
+
+@heading Description
+Texturing maps a portion of a specified texture image onto each
+graphical primitive for which texturing is enabled. To enable and
+disable one-dimensional texturing, call @code{glEnable} and
+@code{glDisable} with argument @code{GL_TEXTURE_1D}.
+
+@code{glCompressedTexImage1D} loads a previously defined, and retrieved,
+compressed one-dimensional texture image if @var{target} is
+@code{GL_TEXTURE_1D} (see @code{glTexImage1D}).
+
+If @var{target} is @code{GL_PROXY_TEXTURE_1D}, no data is read from
+@var{data}, but all of the texture image state is recalculated, checked
+for consistency, and checked against the implementation's capabilities.
+If the implementation cannot handle a texture of the requested texture
+size, it sets all of the image state to 0, but does not generate an
+error (see @code{glGetError}). To query for an entire mipmap array, use
+an image array level greater than or equal to 1.
+
+@var{internalformat} must be extension-specified compressed-texture
+format. When a texture is loaded with @code{glTexImage1D} using a
+generic compressed texture format (e.g., @code{GL_COMPRESSED_RGB}) the
+GL selects from one of its extensions supporting compressed textures. In
+order to load the compressed texture image using
+@code{glCompressedTexImage1D}, query the compressed texture image's size
+and format using @code{glGetTexLevelParameter}.
+
+If a non-zero named buffer object is bound to the
+@code{GL_PIXEL_UNPACK_BUFFER} target (see @code{glBindBuffer}) while a
+texture image is specified, @var{data} is treated as a byte offset into
+the buffer object's data store.
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{internalformat} is one of
+the generic compressed internal formats: @code{GL_COMPRESSED_ALPHA},
+@code{GL_COMPRESSED_LUMINANCE}, @code{GL_COMPRESSED_LUMINANCE_ALPHA},
+@code{GL_COMPRESSED_INTENSITY}, @code{GL_COMPRESSED_RGB}, or
+@code{GL_COMPRESSED_RGBA}.
+
+@code{GL_INVALID_VALUE} is generated if @var{imageSize} is not
+consistent with the format, dimensions, and contents of the specified
+compressed image data.
+
+@code{GL_INVALID_OPERATION} is generated if parameter combinations are
+not supported by the specific compressed internal format as specified in
+the specific texture compression extension.
+
+@code{GL_INVALID_OPERATION} is generated if a non-zero buffer object
+name is bound to the @code{GL_PIXEL_UNPACK_BUFFER} target and the buffer
+object's data store is currently mapped.
+
+@code{GL_INVALID_OPERATION} is generated if a non-zero buffer object
+name is bound to the @code{GL_PIXEL_UNPACK_BUFFER} target and the data
+would be unpacked from the buffer object such that the memory reads
+required would exceed the data store size.
+
+@code{GL_INVALID_OPERATION} is generated if
+@code{glCompressedTexImage1D} is executed between the execution of
+@code{glBegin} and the corresponding execution of @code{glEnd}.
+
+Undefined results, including abnormal program termination, are generated
+if @var{data} is not encoded in a manner consistent with the extension
+specification defining the internal compression format.
+
+@end defun
+
+@defun glCompressedTexImage2D
+@heading specify a two-dimensional texture image in a compressed format
+@heading Parameters
+@table @asis
+@item @var{target}
+Specifies the target texture. Must be @code{GL_TEXTURE_2D},
+@code{GL_PROXY_TEXTURE_2D}, @code{GL_TEXTURE_CUBE_MAP_POSITIVE_X},
+@code{GL_TEXTURE_CUBE_MAP_NEGATIVE_X},
+@code{GL_TEXTURE_CUBE_MAP_POSITIVE_Y},
+@code{GL_TEXTURE_CUBE_MAP_NEGATIVE_Y},
+@code{GL_TEXTURE_CUBE_MAP_POSITIVE_Z},
+@code{GL_TEXTURE_CUBE_MAP_NEGATIVE_Z}, or
+@code{GL_PROXY_TEXTURE_CUBE_MAP}.
+
+@item @var{level}
+Specifies the level-of-detail number. Level 0 is the base image level.
+Level @var{n} is the @var{n}th mipmap reduction image.
+
+@item @var{internalformat}
+Specifies the format of the compressed image data stored at address
+@var{data}.
+
+@item @var{width}
+Specifies the width of the texture image including the border if any. If
+the GL version does not support non-power-of-two sizes, this value must
+be @math{2^@var{n}+2(@var{border},)} for some integer @math{@var{n}}.
+All implementations support 2D texture images that are at least 64
+texels wide and cube-mapped texture images that are at least 16 texels
+wide.
+
+@item @var{height}
+Specifies the height of the texture image including the border if any.
+If the GL version does not support non-power-of-two sizes, this value
+must be Must be @math{2^@var{n}+2(@var{border},)} for some integer
+@math{@var{n}}. All implementations support 2D texture images that are
+at least 64 texels high and cube-mapped texture images that are at least
+16 texels high.
+
+@item @var{border}
+Specifies the width of the border. Must be either 0 or 1.
+
+@item @var{imageSize}
+Specifies the number of unsigned bytes of image data starting at the
+address specified by @var{data}.
+
+@item @var{data}
+Specifies a pointer to the compressed image data in memory.
+
+@end table
+
+@heading Description
+Texturing maps a portion of a specified texture image onto each
+graphical primitive for which texturing is enabled. To enable and
+disable two-dimensional texturing, call @code{glEnable} and
+@code{glDisable} with argument @code{GL_TEXTURE_2D}. To enable and
+disable texturing using cube-mapped textures, call @code{glEnable} and
+@code{glDisable} with argument @code{GL_TEXTURE_CUBE_MAP}.
+
+@code{glCompressedTexImage2D} loads a previously defined, and retrieved,
+compressed two-dimensional texture image if @var{target} is
+@code{GL_TEXTURE_2D} (see @code{glTexImage2D}).
+
+If @var{target} is @code{GL_PROXY_TEXTURE_2D}, no data is read from
+@var{data}, but all of the texture image state is recalculated, checked
+for consistency, and checked against the implementation's capabilities.
+If the implementation cannot handle a texture of the requested texture
+size, it sets all of the image state to 0, but does not generate an
+error (see @code{glGetError}). To query for an entire mipmap array, use
+an image array level greater than or equal to 1.
+
+@var{internalformat} must be an extension-specified compressed-texture
+format. When a texture is loaded with @code{glTexImage2D} using a
+generic compressed texture format (e.g., @code{GL_COMPRESSED_RGB}), the
+GL selects from one of its extensions supporting compressed textures. In
+order to load the compressed texture image using
+@code{glCompressedTexImage2D}, query the compressed texture image's size
+and format using @code{glGetTexLevelParameter}.
+
+If a non-zero named buffer object is bound to the
+@code{GL_PIXEL_UNPACK_BUFFER} target (see @code{glBindBuffer}) while a
+texture image is specified, @var{data} is treated as a byte offset into
+the buffer object's data store.
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{internalformat} is one of
+the generic compressed internal formats: @code{GL_COMPRESSED_ALPHA},
+@code{GL_COMPRESSED_LUMINANCE}, @code{GL_COMPRESSED_LUMINANCE_ALPHA},
+@code{GL_COMPRESSED_INTENSITY}, @code{GL_COMPRESSED_RGB}, or
+@code{GL_COMPRESSED_RGBA}.
+
+@code{GL_INVALID_VALUE} is generated if @var{imageSize} is not
+consistent with the format, dimensions, and contents of the specified
+compressed image data.
+
+@code{GL_INVALID_OPERATION} is generated if parameter combinations are
+not supported by the specific compressed internal format as specified in
+the specific texture compression extension.
+
+@code{GL_INVALID_OPERATION} is generated if a non-zero buffer object
+name is bound to the @code{GL_PIXEL_UNPACK_BUFFER} target and the buffer
+object's data store is currently mapped.
+
+@code{GL_INVALID_OPERATION} is generated if a non-zero buffer object
+name is bound to the @code{GL_PIXEL_UNPACK_BUFFER} target and the data
+would be unpacked from the buffer object such that the memory reads
+required would exceed the data store size.
+
+@code{GL_INVALID_OPERATION} is generated if
+@code{glCompressedTexImage2D} is executed between the execution of
+@code{glBegin} and the corresponding execution of @code{glEnd}.
+
+Undefined results, including abnormal program termination, are generated
+if @var{data} is not encoded in a manner consistent with the extension
+specification defining the internal compression format.
+
+@end defun
+
+@defun glCompressedTexImage3D
+@heading specify a three-dimensional texture image in a compressed format
+@heading Parameters
+@table @asis
+@item @var{target}
+Specifies the target texture. Must be @code{GL_TEXTURE_3D} or
+@code{GL_PROXY_TEXTURE_3D}.
+
+@item @var{level}
+Specifies the level-of-detail number. Level 0 is the base image level.
+Level @var{n} is the @var{n}th mipmap reduction image.
+
+@item @var{internalformat}
+Specifies the format of the compressed image data stored at address
+@var{data}.
+
+@item @var{width}
+Specifies the width of the texture image including the border if any. If
+the GL version does not support non-power-of-two sizes, this value must
+be @math{2^@var{n}+2(@var{border},)} for some integer @math{@var{n}}.
+All implementations support 3D texture images that are at least 16
+texels wide.
+
+@item @var{height}
+Specifies the height of the texture image including the border if any.
+If the GL version does not support non-power-of-two sizes, this value
+must be @math{2^@var{n}+2(@var{border},)} for some integer
+@math{@var{n}}. All implementations support 3D texture images that are
+at least 16 texels high.
+
+@item @var{depth}
+Specifies the depth of the texture image including the border if any. If
+the GL version does not support non-power-of-two sizes, this value must
+be @math{2^@var{n}+2(@var{border},)} for some integer @math{@var{n}}.
+All implementations support 3D texture images that are at least 16
+texels deep.
+
+@item @var{border}
+Specifies the width of the border. Must be either 0 or 1.
+
+@item @var{imageSize}
+Specifies the number of unsigned bytes of image data starting at the
+address specified by @var{data}.
+
+@item @var{data}
+Specifies a pointer to the compressed image data in memory.
+
+@end table
+
+@heading Description
+Texturing maps a portion of a specified texture image onto each
+graphical primitive for which texturing is enabled. To enable and
+disable three-dimensional texturing, call @code{glEnable} and
+@code{glDisable} with argument @code{GL_TEXTURE_3D}.
+
+@code{glCompressedTexImage3D} loads a previously defined, and retrieved,
+compressed three-dimensional texture image if @var{target} is
+@code{GL_TEXTURE_3D} (see @code{glTexImage3D}).
+
+If @var{target} is @code{GL_PROXY_TEXTURE_3D}, no data is read from
+@var{data}, but all of the texture image state is recalculated, checked
+for consistency, and checked against the implementation's capabilities.
+If the implementation cannot handle a texture of the requested texture
+size, it sets all of the image state to 0, but does not generate an
+error (see @code{glGetError}). To query for an entire mipmap array, use
+an image array level greater than or equal to 1.
+
+@var{internalformat} must be an extension-specified compressed-texture
+format. When a texture is loaded with @code{glTexImage2D} using a
+generic compressed texture format (e.g., @code{GL_COMPRESSED_RGB}), the
+GL selects from one of its extensions supporting compressed textures. In
+order to load the compressed texture image using
+@code{glCompressedTexImage3D}, query the compressed texture image's size
+and format using @code{glGetTexLevelParameter}.
+
+If a non-zero named buffer object is bound to the
+@code{GL_PIXEL_UNPACK_BUFFER} target (see @code{glBindBuffer}) while a
+texture image is specified, @var{data} is treated as a byte offset into
+the buffer object's data store.
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{internalformat} is one of
+the generic compressed internal formats: @code{GL_COMPRESSED_ALPHA},
+@code{GL_COMPRESSED_LUMINANCE}, @code{GL_COMPRESSED_LUMINANCE_ALPHA},
+@code{GL_COMPRESSED_INTENSITY}, @code{GL_COMPRESSED_RGB}, or
+@code{GL_COMPRESSED_RGBA}.
+
+@code{GL_INVALID_VALUE} is generated if @var{imageSize} is not
+consistent with the format, dimensions, and contents of the specified
+compressed image data.
+
+@code{GL_INVALID_OPERATION} is generated if parameter combinations are
+not supported by the specific compressed internal format as specified in
+the specific texture compression extension.
+
+@code{GL_INVALID_OPERATION} is generated if a non-zero buffer object
+name is bound to the @code{GL_PIXEL_UNPACK_BUFFER} target and the buffer
+object's data store is currently mapped.
+
+@code{GL_INVALID_OPERATION} is generated if a non-zero buffer object
+name is bound to the @code{GL_PIXEL_UNPACK_BUFFER} target and the data
+would be unpacked from the buffer object such that the memory reads
+required would exceed the data store size.
+
+@code{GL_INVALID_OPERATION} is generated if
+@code{glCompressedTexImage3D} is executed between the execution of
+@code{glBegin} and the corresponding execution of @code{glEnd}.
+
+Undefined results, including abnormal program termination, are generated
+if @var{data} is not encoded in a manner consistent with the extension
+specification defining the internal compression format.
+
+@end defun
+
+@defun glCompressedTexSubImage1D
+@heading specify a one-dimensional texture subimage in a compressed format
+@heading Parameters
+@table @asis
+@item @var{target}
+Specifies the target texture. Must be @code{GL_TEXTURE_1D}.
+
+@item @var{level}
+Specifies the level-of-detail number. Level 0 is the base image level.
+Level @var{n} is the @var{n}th mipmap reduction image.
+
+@item @var{xoffset}
+Specifies a texel offset in the x direction within the texture array.
+
+@item @var{width}
+Specifies the width of the texture subimage.
+
+@item @var{format}
+Specifies the format of the compressed image data stored at address
+@var{data}.
+
+@item @var{imageSize}
+Specifies the number of unsigned bytes of image data starting at the
+address specified by @var{data}.
+
+@item @var{data}
+Specifies a pointer to the compressed image data in memory.
+
+@end table
+
+@heading Description
+Texturing maps a portion of a specified texture image onto each
+graphical primitive for which texturing is enabled. To enable and
+disable one-dimensional texturing, call @code{glEnable} and
+@code{glDisable} with argument @code{GL_TEXTURE_1D}.
+
+@code{glCompressedTexSubImage1D} redefines a contiguous subregion of an
+existing one-dimensional texture image. The texels referenced by
+@var{data} replace the portion of the existing texture array with x
+indices @var{xoffset} and @math{@var{xoffset}+@var{width}-1}, inclusive.
+This region may not include any texels outside the range of the texture
+array as it was originally specified. It is not an error to specify a
+subtexture with width of 0, but such a specification has no effect.
+
+@var{format} must be an extension-specified compressed-texture format.
+The @var{format} of the compressed texture image is selected by the GL
+implementation that compressed it (see @code{glTexImage1D}), and should
+be queried at the time the texture was compressed with
+@code{glGetTexLevelParameter}.
+
+If a non-zero named buffer object is bound to the
+@code{GL_PIXEL_UNPACK_BUFFER} target (see @code{glBindBuffer}) while a
+texture image is specified, @var{data} is treated as a byte offset into
+the buffer object's data store.
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{format} is one of these
+generic compressed internal formats: @code{GL_COMPRESSED_ALPHA},
+@code{GL_COMPRESSED_LUMINANCE}, @code{GL_COMPRESSED_LUMINANCE_ALPHA},
+@code{GL_COMPRESSED_INTENSITY}, @code{GL_COMPRESSED_RGB},
+@code{GL_COMPRESSED_RGBA}, @code{GL_COMPRESSED_SLUMINANCE},
+@code{GL_COMPRESSED_SLUMINANCE_ALPHA}, @code{GL_COMPRESSED_SRGB},
+@code{GL_COMPRESSED_SRGBA}, or @code{GL_COMPRESSED_SRGB_ALPHA}.
+
+@code{GL_INVALID_VALUE} is generated if @var{imageSize} is not
+consistent with the format, dimensions, and contents of the specified
+compressed image data.
+
+@code{GL_INVALID_OPERATION} is generated if parameter combinations are
+not supported by the specific compressed internal format as specified in
+the specific texture compression extension.
+
+@code{GL_INVALID_OPERATION} is generated if a non-zero buffer object
+name is bound to the @code{GL_PIXEL_UNPACK_BUFFER} target and the buffer
+object's data store is currently mapped.
+
+@code{GL_INVALID_OPERATION} is generated if a non-zero buffer object
+name is bound to the @code{GL_PIXEL_UNPACK_BUFFER} target and the data
+would be unpacked from the buffer object such that the memory reads
+required would exceed the data store size.
+
+@code{GL_INVALID_OPERATION} is generated if
+@code{glCompressedTexSubImage1D} is executed between the execution of
+@code{glBegin} and the corresponding execution of @code{glEnd}.
+
+Undefined results, including abnormal program termination, are generated
+if @var{data} is not encoded in a manner consistent with the extension
+specification defining the internal compression format.
+
+@end defun
+
+@defun glCompressedTexSubImage2D
+@heading specify a two-dimensional texture subimage in a compressed format
+@heading Parameters
+@table @asis
+@item @var{target}
+Specifies the target texture. Must be @code{GL_TEXTURE_2D},
+@code{GL_TEXTURE_CUBE_MAP_POSITIVE_X},
+@code{GL_TEXTURE_CUBE_MAP_NEGATIVE_X},
+@code{GL_TEXTURE_CUBE_MAP_POSITIVE_Y},
+@code{GL_TEXTURE_CUBE_MAP_NEGATIVE_Y},
+@code{GL_TEXTURE_CUBE_MAP_POSITIVE_Z}, or
+@code{GL_TEXTURE_CUBE_MAP_NEGATIVE_Z}.
+
+@item @var{level}
+Specifies the level-of-detail number. Level 0 is the base image level.
+Level @var{n} is the @var{n}th mipmap reduction image.
+
+@item @var{xoffset}
+Specifies a texel offset in the x direction within the texture array.
+
+@item @var{yoffset}
+Specifies a texel offset in the y direction within the texture array.
+
+@item @var{width}
+Specifies the width of the texture subimage.
+
+@item @var{height}
+Specifies the height of the texture subimage.
+
+@item @var{format}
+Specifies the format of the compressed image data stored at address
+@var{data}.
+
+@item @var{imageSize}
+Specifies the number of unsigned bytes of image data starting at the
+address specified by @var{data}.
+
+@item @var{data}
+Specifies a pointer to the compressed image data in memory.
+
+@end table
+
+@heading Description
+Texturing maps a portion of a specified texture image onto each
+graphical primitive for which texturing is enabled. To enable and
+disable two-dimensional texturing, call @code{glEnable} and
+@code{glDisable} with argument @code{GL_TEXTURE_2D}. To enable and
+disable texturing using cube-mapped texture, call @code{glEnable} and
+@code{glDisable} with argument @code{GL_TEXTURE_CUBE_MAP}.
+
+@code{glCompressedTexSubImage2D} redefines a contiguous subregion of an
+existing two-dimensional texture image. The texels referenced by
+@var{data} replace the portion of the existing texture array with x
+indices @var{xoffset} and @math{@var{xoffset}+@var{width}-1}, and the y
+indices @var{yoffset} and @math{@var{yoffset}+@var{height}-1},
+inclusive. This region may not include any texels outside the range of
+the texture array as it was originally specified. It is not an error to
+specify a subtexture with width of 0, but such a specification has no
+effect.
+
+@var{format} must be an extension-specified compressed-texture format.
+The @var{format} of the compressed texture image is selected by the GL
+implementation that compressed it (see @code{glTexImage2D}) and should
+be queried at the time the texture was compressed with
+@code{glGetTexLevelParameter}.
+
+If a non-zero named buffer object is bound to the
+@code{GL_PIXEL_UNPACK_BUFFER} target (see @code{glBindBuffer}) while a
+texture image is specified, @var{data} is treated as a byte offset into
+the buffer object's data store.
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{format} is one of these
+generic compressed internal formats: @code{GL_COMPRESSED_ALPHA},
+@code{GL_COMPRESSED_LUMINANCE}, @code{GL_COMPRESSED_LUMINANCE_ALPHA},
+@code{GL_COMPRESSED_INTENSITY}, @code{GL_COMPRESSED_RGB},
+@code{GL_COMPRESSED_RGBA}, @code{GL_COMPRESSED_SLUMINANCE},
+@code{GL_COMPRESSED_SLUMINANCE_ALPHA}, @code{GL_COMPRESSED_SRGB},
+@code{GL_COMPRESSED_SRGBA}, or @code{GL_COMPRESSED_SRGB_ALPHA}.
+
+@code{GL_INVALID_VALUE} is generated if @var{imageSize} is not
+consistent with the format, dimensions, and contents of the specified
+compressed image data.
+
+@code{GL_INVALID_OPERATION} is generated if parameter combinations are
+not supported by the specific compressed internal format as specified in
+the specific texture compression extension.
+
+@code{GL_INVALID_OPERATION} is generated if a non-zero buffer object
+name is bound to the @code{GL_PIXEL_UNPACK_BUFFER} target and the buffer
+object's data store is currently mapped.
+
+@code{GL_INVALID_OPERATION} is generated if a non-zero buffer object
+name is bound to the @code{GL_PIXEL_UNPACK_BUFFER} target and the data
+would be unpacked from the buffer object such that the memory reads
+required would exceed the data store size.
+
+@code{GL_INVALID_OPERATION} is generated if
+@code{glCompressedTexSubImage2D} is executed between the execution of
+@code{glBegin} and the corresponding execution of @code{glEnd}.
+
+Undefined results, including abnormal program termination, are generated
+if @var{data} is not encoded in a manner consistent with the extension
+specification defining the internal compression format.
+
+@end defun
+
+@defun glCompressedTexSubImage3D
+@heading specify a three-dimensional texture subimage in a compressed format
+@heading Parameters
+@table @asis
+@item @var{target}
+Specifies the target texture. Must be @code{GL_TEXTURE_3D}.
+
+@item @var{level}
+Specifies the level-of-detail number. Level 0 is the base image level.
+Level @var{n} is the @var{n}th mipmap reduction image.
+
+@item @var{xoffset}
+Specifies a texel offset in the x direction within the texture array.
+
+@item @var{yoffset}
+Specifies a texel offset in the y direction within the texture array.
+
+@item @var{width}
+Specifies the width of the texture subimage.
+
+@item @var{height}
+Specifies the height of the texture subimage.
+
+@item @var{depth}
+Specifies the depth of the texture subimage.
+
+@item @var{format}
+Specifies the format of the compressed image data stored at address
+@var{data}.
+
+@item @var{imageSize}
+Specifies the number of unsigned bytes of image data starting at the
+address specified by @var{data}.
+
+@item @var{data}
+Specifies a pointer to the compressed image data in memory.
+
+@end table
+
+@heading Description
+Texturing maps a portion of a specified texture image onto each
+graphical primitive for which texturing is enabled. To enable and
+disable three-dimensional texturing, call @code{glEnable} and
+@code{glDisable} with argument @code{GL_TEXTURE_3D}.
+
+@code{glCompressedTexSubImage3D} redefines a contiguous subregion of an
+existing three-dimensional texture image. The texels referenced by
+@var{data} replace the portion of the existing texture array with x
+indices @var{xoffset} and @math{@var{xoffset}+@var{width}-1}, and the y
+indices @var{yoffset} and @math{@var{yoffset}+@var{height}-1}, and the z
+indices @var{zoffset} and @math{@var{zoffset}+@var{depth}-1}, inclusive.
+This region may not include any texels outside the range of the texture
+array as it was originally specified. It is not an error to specify a
+subtexture with width of 0, but such a specification has no effect.
+
+@var{format} must be an extension-specified compressed-texture format.
+The @var{format} of the compressed texture image is selected by the GL
+implementation that compressed it (see @code{glTexImage3D}) and should
+be queried at the time the texture was compressed with
+@code{glGetTexLevelParameter}.
+
+If a non-zero named buffer object is bound to the
+@code{GL_PIXEL_UNPACK_BUFFER} target (see @code{glBindBuffer}) while a
+texture image is specified, @var{data} is treated as a byte offset into
+the buffer object's data store.
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{format} is one of these
+generic compressed internal formats: @code{GL_COMPRESSED_ALPHA},
+@code{GL_COMPRESSED_LUMINANCE}, @code{GL_COMPRESSED_LUMINANCE_ALPHA},
+@code{GL_COMPRESSED_INTENSITY}, @code{GL_COMPRESSED_RGB},
+@code{GL_COMPRESSED_RGBA}, @code{GL_COMPRESSED_SLUMINANCE},
+@code{GL_COMPRESSED_SLUMINANCE_ALPHA}, @code{GL_COMPRESSED_SRGB},
+@code{GL_COMPRESSED_SRGBA}, or @code{GL_COMPRESSED_SRGB_ALPHA}.
+
+@code{GL_INVALID_VALUE} is generated if @var{imageSize} is not
+consistent with the format, dimensions, and contents of the specified
+compressed image data.
+
+@code{GL_INVALID_OPERATION} is generated if parameter combinations are
+not supported by the specific compressed internal format as specified in
+the specific texture compression extension.
+
+@code{GL_INVALID_OPERATION} is generated if a non-zero buffer object
+name is bound to the @code{GL_PIXEL_UNPACK_BUFFER} target and the buffer
+object's data store is currently mapped.
+
+@code{GL_INVALID_OPERATION} is generated if a non-zero buffer object
+name is bound to the @code{GL_PIXEL_UNPACK_BUFFER} target and the data
+would be unpacked from the buffer object such that the memory reads
+required would exceed the data store size.
+
+@code{GL_INVALID_OPERATION} is generated if
+@code{glCompressedTexSubImage3D} is executed between the execution of
+@code{glBegin} and the corresponding execution of @code{glEnd}.
+
+Undefined results, including abnormal program termination, are generated
+if @var{data} is not encoded in a manner consistent with the extension
+specification defining the internal compression format.
+
+@end defun
+
+@defun glConvolutionFilter1D
+@heading define a one-dimensional convolution filter
+@heading Parameters
+@table @asis
+@item @var{target}
+Must be @code{GL_CONVOLUTION_1D}.
+
+@item @var{internalformat}
+The internal format of the convolution filter kernel. The allowable
+values are @code{GL_ALPHA}, @code{GL_ALPHA4}, @code{GL_ALPHA8},
+@code{GL_ALPHA12}, @code{GL_ALPHA16}, @code{GL_LUMINANCE},
+@code{GL_LUMINANCE4}, @code{GL_LUMINANCE8}, @code{GL_LUMINANCE12},
+@code{GL_LUMINANCE16}, @code{GL_LUMINANCE_ALPHA},
+@code{GL_LUMINANCE4_ALPHA4}, @code{GL_LUMINANCE6_ALPHA2},
+@code{GL_LUMINANCE8_ALPHA8}, @code{GL_LUMINANCE12_ALPHA4},
+@code{GL_LUMINANCE12_ALPHA12}, @code{GL_LUMINANCE16_ALPHA16},
+@code{GL_INTENSITY}, @code{GL_INTENSITY4}, @code{GL_INTENSITY8},
+@code{GL_INTENSITY12}, @code{GL_INTENSITY16}, @code{GL_R3_G3_B2},
+@code{GL_RGB}, @code{GL_RGB4}, @code{GL_RGB5}, @code{GL_RGB8},
+@code{GL_RGB10}, @code{GL_RGB12}, @code{GL_RGB16}, @code{GL_RGBA},
+@code{GL_RGBA2}, @code{GL_RGBA4}, @code{GL_RGB5_A1}, @code{GL_RGBA8},
+@code{GL_RGB10_A2}, @code{GL_RGBA12}, or @code{GL_RGBA16}.
+
+@item @var{width}
+The width of the pixel array referenced by @var{data}.
+
+@item @var{format}
+The format of the pixel data in @var{data}. The allowable values are
+@code{GL_ALPHA}, @code{GL_LUMINANCE}, @code{GL_LUMINANCE_ALPHA},
+@code{GL_INTENSITY}, @code{GL_RGB}, and @code{GL_RGBA}.
+
+@item @var{type}
+The type of the pixel data in @var{data}. Symbolic constants
+@code{GL_UNSIGNED_BYTE}, @code{GL_BYTE}, @code{GL_BITMAP},
+@code{GL_UNSIGNED_SHORT}, @code{GL_SHORT}, @code{GL_UNSIGNED_INT},
+@code{GL_INT}, @code{GL_FLOAT}, @code{GL_UNSIGNED_BYTE_3_3_2},
+@code{GL_UNSIGNED_BYTE_2_3_3_REV}, @code{GL_UNSIGNED_SHORT_5_6_5},
+@code{GL_UNSIGNED_SHORT_5_6_5_REV}, @code{GL_UNSIGNED_SHORT_4_4_4_4},
+@code{GL_UNSIGNED_SHORT_4_4_4_4_REV}, @code{GL_UNSIGNED_SHORT_5_5_5_1},
+@code{GL_UNSIGNED_SHORT_1_5_5_5_REV}, @code{GL_UNSIGNED_INT_8_8_8_8},
+@code{GL_UNSIGNED_INT_8_8_8_8_REV}, @code{GL_UNSIGNED_INT_10_10_10_2},
+and @code{GL_UNSIGNED_INT_2_10_10_10_REV} are accepted.
+
+@item @var{data}
+Pointer to a one-dimensional array of pixel data that is processed to
+build the convolution filter kernel.
+
+@end table
+
+@heading Description
+@code{glConvolutionFilter1D} builds a one-dimensional convolution filter
+kernel from an array of pixels.
+
+The pixel array specified by @var{width}, @var{format}, @var{type}, and
+@var{data} is extracted from memory and processed just as if
+@code{glDrawPixels} were called, but processing stops after the final
+expansion to RGBA is completed.
+
+If a non-zero named buffer object is bound to the
+@code{GL_PIXEL_UNPACK_BUFFER} target (see @code{glBindBuffer}) while a
+convolution filter is specified, @var{data} is treated as a byte offset
+into the buffer object's data store.
+
+The R, G, B, and A components of each pixel are next scaled by the four
+1D @code{GL_CONVOLUTION_FILTER_SCALE} parameters and biased by the four
+1D @code{GL_CONVOLUTION_FILTER_BIAS} parameters. (The scale and bias
+parameters are set by @code{glConvolutionParameter} using the
+@code{GL_CONVOLUTION_1D} target and the names
+@code{GL_CONVOLUTION_FILTER_SCALE} and
+@code{GL_CONVOLUTION_FILTER_BIAS}. The parameters themselves are vectors
+of four values that are applied to red, green, blue, and alpha, in that
+order.) The R, G, B, and A values are not clamped to [0,1] at any time
+during this process.
+
+Each pixel is then converted to the internal format specified by
+@var{internalformat}. This conversion simply maps the component values
+of the pixel (R, G, B, and A) to the values included in the internal
+format (red, green, blue, alpha, luminance, and intensity). The mapping
+is as follows:
+
+
+
+@table @asis
+@item @strong{Internal Format}
+@strong{Red}, @strong{Green}, @strong{Blue}, @strong{Alpha},
+@strong{Luminance}, @strong{Intensity}
+
+@item @code{GL_ALPHA}
+, , , A , ,
+
+@item @code{GL_LUMINANCE}
+, , , , R ,
+
+@item @code{GL_LUMINANCE_ALPHA}
+, , , A , R ,
+
+@item @code{GL_INTENSITY}
+, , , , , R
+
+@item @code{GL_RGB}
+R , G , B , , ,
+
+@item @code{GL_RGBA}
+R , G , B , A , ,
+
+@end table
+
+The red, green, blue, alpha, luminance, and/or intensity components of
+the resulting pixels are stored in floating-point rather than integer
+format. They form a one-dimensional filter kernel image indexed with
+coordinate @var{i} such that @var{i} starts at 0 and increases from left
+to right. Kernel location @var{i} is derived from the @var{i}th pixel,
+counting from 0.
+
+Note that after a convolution is performed, the resulting color
+components are also scaled by their corresponding
+@code{GL_POST_CONVOLUTION_c_SCALE} parameters and biased by their
+corresponding @code{GL_POST_CONVOLUTION_c_BIAS} parameters (where
+@var{c} takes on the values @strong{RED}, @strong{GREEN}, @strong{BLUE},
+and @strong{ALPHA}). These parameters are set by @code{glPixelTransfer}.
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{target} is not
+@code{GL_CONVOLUTION_1D}.
+
+@code{GL_INVALID_ENUM} is generated if @var{internalformat} is not one
+of the allowable values.
+
+@code{GL_INVALID_ENUM} is generated if @var{format} is not one of the
+allowable values.
+
+@code{GL_INVALID_ENUM} is generated if @var{type} is not one of the
+allowable values.
+
+@code{GL_INVALID_VALUE} is generated if @var{width} is less than zero or
+greater than the maximum supported value. This value may be queried with
+@code{glGetConvolutionParameter} using target @code{GL_CONVOLUTION_1D}
+and name @code{GL_MAX_CONVOLUTION_WIDTH}.
+
+@code{GL_INVALID_OPERATION} is generated if @var{format} is one of
+@code{GL_UNSIGNED_BYTE_3_3_2}, @code{GL_UNSIGNED_BYTE_2_3_3_REV},
+@code{GL_UNSIGNED_SHORT_5_6_5}, or @code{GL_UNSIGNED_SHORT_5_6_5_REV}
+and @var{type} is not @code{GL_RGB}.
+
+@code{GL_INVALID_OPERATION} is generated if @var{format} is one of
+@code{GL_UNSIGNED_SHORT_4_4_4_4}, @code{GL_UNSIGNED_SHORT_4_4_4_4_REV},
+@code{GL_UNSIGNED_SHORT_5_5_5_1}, @code{GL_UNSIGNED_SHORT_1_5_5_5_REV},
+@code{GL_UNSIGNED_INT_8_8_8_8}, @code{GL_UNSIGNED_INT_8_8_8_8_REV},
+@code{GL_UNSIGNED_INT_10_10_10_2}, or
+@code{GL_UNSIGNED_INT_2_10_10_10_REV} and @var{type} is neither
+@code{GL_RGBA} nor @code{GL_BGRA}.
+
+@code{GL_INVALID_OPERATION} is generated if a non-zero buffer object
+name is bound to the @code{GL_PIXEL_UNPACK_BUFFER} target and the buffer
+object's data store is currently mapped.
+
+@code{GL_INVALID_OPERATION} is generated if a non-zero buffer object
+name is bound to the @code{GL_PIXEL_UNPACK_BUFFER} target and the data
+would be unpacked from the buffer object such that the memory reads
+required would exceed the data store size.
+
+@code{GL_INVALID_OPERATION} is generated if a non-zero buffer object
+name is bound to the @code{GL_PIXEL_UNPACK_BUFFER} target and @var{data}
+is not evenly divisible into the number of bytes needed to store in
+memory a datum indicated by @var{type}.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glConvolutionFilter1D}
+is executed between the execution of @code{glBegin} and the
+corresponding execution of @code{glEnd}.
+
+@end defun
+
+@defun glConvolutionFilter2D
+@heading define a two-dimensional convolution filter
+@heading Parameters
+@table @asis
+@item @var{target}
+Must be @code{GL_CONVOLUTION_2D}.
+
+@item @var{internalformat}
+The internal format of the convolution filter kernel. The allowable
+values are @code{GL_ALPHA}, @code{GL_ALPHA4}, @code{GL_ALPHA8},
+@code{GL_ALPHA12}, @code{GL_ALPHA16}, @code{GL_LUMINANCE},
+@code{GL_LUMINANCE4}, @code{GL_LUMINANCE8}, @code{GL_LUMINANCE12},
+@code{GL_LUMINANCE16}, @code{GL_LUMINANCE_ALPHA},
+@code{GL_LUMINANCE4_ALPHA4}, @code{GL_LUMINANCE6_ALPHA2},
+@code{GL_LUMINANCE8_ALPHA8}, @code{GL_LUMINANCE12_ALPHA4},
+@code{GL_LUMINANCE12_ALPHA12}, @code{GL_LUMINANCE16_ALPHA16},
+@code{GL_INTENSITY}, @code{GL_INTENSITY4}, @code{GL_INTENSITY8},
+@code{GL_INTENSITY12}, @code{GL_INTENSITY16}, @code{GL_R3_G3_B2},
+@code{GL_RGB}, @code{GL_RGB4}, @code{GL_RGB5}, @code{GL_RGB8},
+@code{GL_RGB10}, @code{GL_RGB12}, @code{GL_RGB16}, @code{GL_RGBA},
+@code{GL_RGBA2}, @code{GL_RGBA4}, @code{GL_RGB5_A1}, @code{GL_RGBA8},
+@code{GL_RGB10_A2}, @code{GL_RGBA12}, or @code{GL_RGBA16}.
+
+@item @var{width}
+The width of the pixel array referenced by @var{data}.
+
+@item @var{height}
+The height of the pixel array referenced by @var{data}.
+
+@item @var{format}
+The format of the pixel data in @var{data}. The allowable values are
+@code{GL_RED}, @code{GL_GREEN}, @code{GL_BLUE}, @code{GL_ALPHA},
+@code{GL_RGB}, @code{GL_BGR}, @code{GL_RGBA}, @code{GL_BGRA},
+@code{GL_LUMINANCE}, and @code{GL_LUMINANCE_ALPHA}.
+
+@item @var{type}
+The type of the pixel data in @var{data}. Symbolic constants
+@code{GL_UNSIGNED_BYTE}, @code{GL_BYTE}, @code{GL_BITMAP},
+@code{GL_UNSIGNED_SHORT}, @code{GL_SHORT}, @code{GL_UNSIGNED_INT},
+@code{GL_INT}, @code{GL_FLOAT}, @code{GL_UNSIGNED_BYTE_3_3_2},
+@code{GL_UNSIGNED_BYTE_2_3_3_REV}, @code{GL_UNSIGNED_SHORT_5_6_5},
+@code{GL_UNSIGNED_SHORT_5_6_5_REV}, @code{GL_UNSIGNED_SHORT_4_4_4_4},
+@code{GL_UNSIGNED_SHORT_4_4_4_4_REV}, @code{GL_UNSIGNED_SHORT_5_5_5_1},
+@code{GL_UNSIGNED_SHORT_1_5_5_5_REV}, @code{GL_UNSIGNED_INT_8_8_8_8},
+@code{GL_UNSIGNED_INT_8_8_8_8_REV}, @code{GL_UNSIGNED_INT_10_10_10_2},
+and @code{GL_UNSIGNED_INT_2_10_10_10_REV} are accepted.
+
+@item @var{data}
+Pointer to a two-dimensional array of pixel data that is processed to
+build the convolution filter kernel.
+
+@end table
+
+@heading Description
+@code{glConvolutionFilter2D} builds a two-dimensional convolution filter
+kernel from an array of pixels.
+
+The pixel array specified by @var{width}, @var{height}, @var{format},
+@var{type}, and @var{data} is extracted from memory and processed just
+as if @code{glDrawPixels} were called, but processing stops after the
+final expansion to RGBA is completed.
+
+If a non-zero named buffer object is bound to the
+@code{GL_PIXEL_UNPACK_BUFFER} target (see @code{glBindBuffer}) while a
+convolution filter is specified, @var{data} is treated as a byte offset
+into the buffer object's data store.
+
+The R, G, B, and A components of each pixel are next scaled by the four
+2D @code{GL_CONVOLUTION_FILTER_SCALE} parameters and biased by the four
+2D @code{GL_CONVOLUTION_FILTER_BIAS} parameters. (The scale and bias
+parameters are set by @code{glConvolutionParameter} using the
+@code{GL_CONVOLUTION_2D} target and the names
+@code{GL_CONVOLUTION_FILTER_SCALE} and
+@code{GL_CONVOLUTION_FILTER_BIAS}. The parameters themselves are vectors
+of four values that are applied to red, green, blue, and alpha, in that
+order.) The R, G, B, and A values are not clamped to [0,1] at any time
+during this process.
+
+Each pixel is then converted to the internal format specified by
+@var{internalformat}. This conversion simply maps the component values
+of the pixel (R, G, B, and A) to the values included in the internal
+format (red, green, blue, alpha, luminance, and intensity). The mapping
+is as follows:
+
+
+
+@table @asis
+@item @strong{Internal Format}
+@strong{Red}, @strong{Green}, @strong{Blue}, @strong{Alpha},
+@strong{Luminance}, @strong{Intensity}
+
+@item @code{GL_ALPHA}
+, , , A , ,
+
+@item @code{GL_LUMINANCE}
+, , , , R ,
+
+@item @code{GL_LUMINANCE_ALPHA}
+, , , A , R ,
+
+@item @code{GL_INTENSITY}
+, , , , , R
+
+@item @code{GL_RGB}
+R , G , B , , ,
+
+@item @code{GL_RGBA}
+R , G , B , A , ,
+
+@end table
+
+The red, green, blue, alpha, luminance, and/or intensity components of
+the resulting pixels are stored in floating-point rather than integer
+format. They form a two-dimensional filter kernel image indexed with
+coordinates @var{i} and @var{j} such that @var{i} starts at zero and
+increases from left to right, and @var{j} starts at zero and increases
+from bottom to top. Kernel location @var{i,j} is derived from the
+@var{N}th pixel, where @var{N} is @var{i}+@var{j}*@var{width}.
+
+Note that after a convolution is performed, the resulting color
+components are also scaled by their corresponding
+@code{GL_POST_CONVOLUTION_c_SCALE} parameters and biased by their
+corresponding @code{GL_POST_CONVOLUTION_c_BIAS} parameters (where
+@var{c} takes on the values @strong{RED}, @strong{GREEN}, @strong{BLUE},
+and @strong{ALPHA}). These parameters are set by @code{glPixelTransfer}.
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{target} is not
+@code{GL_CONVOLUTION_2D}.
+
+@code{GL_INVALID_ENUM} is generated if @var{internalformat} is not one
+of the allowable values.
+
+@code{GL_INVALID_ENUM} is generated if @var{format} is not one of the
+allowable values.
+
+@code{GL_INVALID_ENUM} is generated if @var{type} is not one of the
+allowable values.
+
+@code{GL_INVALID_VALUE} is generated if @var{width} is less than zero or
+greater than the maximum supported value. This value may be queried with
+@code{glGetConvolutionParameter} using target @code{GL_CONVOLUTION_2D}
+and name @code{GL_MAX_CONVOLUTION_WIDTH}.
+
+@code{GL_INVALID_VALUE} is generated if @var{height} is less than zero
+or greater than the maximum supported value. This value may be queried
+with @code{glGetConvolutionParameter} using target
+@code{GL_CONVOLUTION_2D} and name @code{GL_MAX_CONVOLUTION_HEIGHT}.
+
+@code{GL_INVALID_OPERATION} is generated if @var{height} is one of
+@code{GL_UNSIGNED_BYTE_3_3_2}, @code{GL_UNSIGNED_BYTE_2_3_3_REV},
+@code{GL_UNSIGNED_SHORT_5_6_5}, or @code{GL_UNSIGNED_SHORT_5_6_5_REV}
+and @var{format} is not @code{GL_RGB}.
+
+@code{GL_INVALID_OPERATION} is generated if @var{height} is one of
+@code{GL_UNSIGNED_SHORT_4_4_4_4}, @code{GL_UNSIGNED_SHORT_4_4_4_4_REV},
+@code{GL_UNSIGNED_SHORT_5_5_5_1}, @code{GL_UNSIGNED_SHORT_1_5_5_5_REV},
+@code{GL_UNSIGNED_INT_8_8_8_8}, @code{GL_UNSIGNED_INT_8_8_8_8_REV},
+@code{GL_UNSIGNED_INT_10_10_10_2}, or
+@code{GL_UNSIGNED_INT_2_10_10_10_REV} and @var{format} is neither
+@code{GL_RGBA} nor @code{GL_BGRA}.
+
+@code{GL_INVALID_OPERATION} is generated if a non-zero buffer object
+name is bound to the @code{GL_PIXEL_UNPACK_BUFFER} target and the buffer
+object's data store is currently mapped.
+
+@code{GL_INVALID_OPERATION} is generated if a non-zero buffer object
+name is bound to the @code{GL_PIXEL_UNPACK_BUFFER} target and the data
+would be unpacked from the buffer object such that the memory reads
+required would exceed the data store size.
+
+@code{GL_INVALID_OPERATION} is generated if a non-zero buffer object
+name is bound to the @code{GL_PIXEL_UNPACK_BUFFER} target and @var{data}
+is not evenly divisible into the number of bytes needed to store in
+memory a datum indicated by @var{type}.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glConvolutionFilter2D}
+is executed between the execution of @code{glBegin} and the
+corresponding execution of @code{glEnd}.
+
+@end defun
+
+@defun glConvolutionParameter
+@heading set convolution parameters
+@heading Parameters
+@table @asis
+@item @var{target}
+The target for the convolution parameter. Must be one of
+@code{GL_CONVOLUTION_1D}, @code{GL_CONVOLUTION_2D}, or
+@code{GL_SEPARABLE_2D}.
+
+@item @var{pname}
+The parameter to be set. Must be @code{GL_CONVOLUTION_BORDER_MODE}.
+
+@item @var{params}
+The parameter value. Must be one of @code{GL_REDUCE},
+@code{GL_CONSTANT_BORDER}, @code{GL_REPLICATE_BORDER}.
+
+
+
+@end table
+
+@heading Description
+@code{glConvolutionParameter} sets the value of a convolution parameter.
+
+@var{target} selects the convolution filter to be affected:
+@code{GL_CONVOLUTION_1D}, @code{GL_CONVOLUTION_2D}, or
+@code{GL_SEPARABLE_2D} for the 1D, 2D, or separable 2D filter,
+respectively.
+
+@var{pname} selects the parameter to be changed.
+@code{GL_CONVOLUTION_FILTER_SCALE} and @code{GL_CONVOLUTION_FILTER_BIAS}
+affect the definition of the convolution filter kernel; see
+@code{glConvolutionFilter1D}, @code{glConvolutionFilter2D}, and
+@code{glSeparableFilter2D} for details. In these cases, @var{params}v is
+an array of four values to be applied to red, green, blue, and alpha
+values, respectively. The initial value for
+@code{GL_CONVOLUTION_FILTER_SCALE} is (1, 1, 1, 1), and the initial
+value for @code{GL_CONVOLUTION_FILTER_BIAS} is (0, 0, 0, 0).
+
+A @var{pname} value of @code{GL_CONVOLUTION_BORDER_MODE} controls the
+convolution border mode. The accepted modes are:
+
+@table @asis
+@item @code{GL_REDUCE}
+The image resulting from convolution is smaller than the source image.
+If the filter width is @math{@var{Wf}} and height is @math{@var{Hf}},
+and the source image width is @math{@var{Ws}} and height is
+@math{@var{Hs}}, then the convolved image width will be
+@math{@var{Ws}-@var{Wf}+1} and height will be
+@math{@var{Hs}-@var{Hf}+1}. (If this reduction would generate an image
+with zero or negative width and/or height, the output is simply null,
+with no error generated.) The coordinates of the image resulting from
+convolution are zero through @math{@var{Ws}-@var{Wf}} in width and zero
+through @math{@var{Hs}-@var{Hf}} in height.
+
+@item @code{GL_CONSTANT_BORDER}
+The image resulting from convolution is the same size as the source
+image, and processed as if the source image were surrounded by pixels
+with their color specified by the @code{GL_CONVOLUTION_BORDER_COLOR}.
+
+@item @code{GL_REPLICATE_BORDER}
+The image resulting from convolution is the same size as the source
+image, and processed as if the outermost pixel on the border of the
+source image were replicated.
+
+@end table
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{target} is not one of the
+allowable values.
+
+@code{GL_INVALID_ENUM} is generated if @var{pname} is not one of the
+allowable values.
+
+@code{GL_INVALID_ENUM} is generated if @var{pname} is
+@code{GL_CONVOLUTION_BORDER_MODE} and @var{params} is not one of
+@code{GL_REDUCE}, @code{GL_CONSTANT_BORDER}, or
+@code{GL_REPLICATE_BORDER}.
+
+@code{GL_INVALID_OPERATION} is generated if
+@code{glConvolutionParameter} is executed between the execution of
+@code{glBegin} and the corresponding execution of @code{glEnd}.
+
+@end defun
+
+@defun glCopyColorSubTable
+@heading respecify a portion of a color table
+@heading Parameters
+@table @asis
+@item @var{target}
+Must be one of @code{GL_COLOR_TABLE},
+@code{GL_POST_CONVOLUTION_COLOR_TABLE}, or
+@code{GL_POST_COLOR_MATRIX_COLOR_TABLE}.
+
+@item @var{start}
+The starting index of the portion of the color table to be replaced.
+
+@item @var{x}
+@itemx @var{y}
+The window coordinates of the left corner of the row of pixels to be
+copied.
+
+@item @var{width}
+The number of table entries to replace.
+
+@end table
+
+@heading Description
+@code{glCopyColorSubTable} is used to respecify a contiguous portion of
+a color table previously defined using @code{glColorTable}. The pixels
+copied from the framebuffer replace the portion of the existing table
+from indices @var{start} to @math{@var{start}+@var{x}-1}, inclusive.
+This region may not include any entries outside the range of the color
+table, as was originally specified. It is not an error to specify a
+subtexture with width of 0, but such a specification has no effect.
+
+@heading Errors
+@code{GL_INVALID_VALUE} is generated if @var{target} is not a previously
+defined color table.
+
+@code{GL_INVALID_VALUE} is generated if @var{target} is not one of the
+allowable values.
+
+@code{GL_INVALID_VALUE} is generated if
+@math{@var{start}+@var{x}>@var{width}}.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glCopyColorSubTable}
+is executed between the execution of @code{glBegin} and the
+corresponding execution of @code{glEnd}.
+
+@end defun
+
+@defun glCopyColorTable
+@heading copy pixels into a color table
+@heading Parameters
+@table @asis
+@item @var{target}
+The color table target. Must be @code{GL_COLOR_TABLE},
+@code{GL_POST_CONVOLUTION_COLOR_TABLE}, or
+@code{GL_POST_COLOR_MATRIX_COLOR_TABLE}.
+
+@item @var{internalformat}
+The internal storage format of the texture image. Must be one of the
+following symbolic constants: @code{GL_ALPHA}, @code{GL_ALPHA4},
+@code{GL_ALPHA8}, @code{GL_ALPHA12}, @code{GL_ALPHA16},
+@code{GL_LUMINANCE}, @code{GL_LUMINANCE4}, @code{GL_LUMINANCE8},
+@code{GL_LUMINANCE12}, @code{GL_LUMINANCE16}, @code{GL_LUMINANCE_ALPHA},
+@code{GL_LUMINANCE4_ALPHA4}, @code{GL_LUMINANCE6_ALPHA2},
+@code{GL_LUMINANCE8_ALPHA8}, @code{GL_LUMINANCE12_ALPHA4},
+@code{GL_LUMINANCE12_ALPHA12}, @code{GL_LUMINANCE16_ALPHA16},
+@code{GL_INTENSITY}, @code{GL_INTENSITY4}, @code{GL_INTENSITY8},
+@code{GL_INTENSITY12}, @code{GL_INTENSITY16}, @code{GL_R3_G3_B2},
+@code{GL_RGB}, @code{GL_RGB4}, @code{GL_RGB5}, @code{GL_RGB8},
+@code{GL_RGB10}, @code{GL_RGB12}, @code{GL_RGB16}, @code{GL_RGBA},
+@code{GL_RGBA2}, @code{GL_RGBA4}, @code{GL_RGB5_A1}, @code{GL_RGBA8},
+@code{GL_RGB10_A2}, @code{GL_RGBA12}, or @code{GL_RGBA16}.
+
+@item @var{x}
+The x coordinate of the lower-left corner of the pixel rectangle to be
+transferred to the color table.
+
+@item @var{y}
+The y coordinate of the lower-left corner of the pixel rectangle to be
+transferred to the color table.
+
+@item @var{width}
+The width of the pixel rectangle.
+
+@end table
+
+@heading Description
+@code{glCopyColorTable} loads a color table with pixels from the current
+@code{GL_READ_BUFFER} (rather than from main memory, as is the case for
+@code{glColorTable}).
+
+The screen-aligned pixel rectangle with lower-left corner at (@var{x},\
+@var{y}) having width @var{width} and height 1 is loaded into the color
+table. If any pixels within this region are outside the window that is
+associated with the GL context, the values obtained for those pixels are
+undefined.
+
+The pixels in the rectangle are processed just as if @code{glReadPixels}
+were called, with @var{internalformat} set to RGBA, but processing stops
+after the final conversion to RGBA.
+
+The four scale parameters and the four bias parameters that are defined
+for the table are then used to scale and bias the R, G, B, and A
+components of each pixel. The scale and bias parameters are set by
+calling @code{glColorTableParameter}.
+
+Next, the R, G, B, and A values are clamped to the range @math{[0,1]}.
+Each pixel is then converted to the internal format specified by
+@var{internalformat}. This conversion simply maps the component values
+of the pixel (R, G, B, and A) to the values included in the internal
+format (red, green, blue, alpha, luminance, and intensity). The mapping
+is as follows:
+
+
+
+@table @asis
+@item @strong{Internal Format}
+@strong{Red}, @strong{Green}, @strong{Blue}, @strong{Alpha},
+@strong{Luminance}, @strong{Intensity}
+
+@item @code{GL_ALPHA}
+, , , A , ,
+
+@item @code{GL_LUMINANCE}
+, , , , R ,
+
+@item @code{GL_LUMINANCE_ALPHA}
+, , , A , R ,
+
+@item @code{GL_INTENSITY}
+, , , , , R
+
+@item @code{GL_RGB}
+R , G , B , , ,
+
+@item @code{GL_RGBA}
+R , G , B , A , ,
+
+@end table
+
+Finally, the red, green, blue, alpha, luminance, and/or intensity
+components of the resulting pixels are stored in the color table. They
+form a one-dimensional table with indices in the range
+@math{[0,@var{width}-1]}.
+
+
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated when @var{target} is not one of the
+allowable values.
+
+@code{GL_INVALID_VALUE} is generated if @var{width} is less than zero.
+
+@code{GL_INVALID_VALUE} is generated if @var{internalformat} is not one
+of the allowable values.
+
+@code{GL_TABLE_TOO_LARGE} is generated if the requested color table is
+too large to be supported by the implementation.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glCopyColorTable} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glCopyConvolutionFilter1D
+@heading copy pixels into a one-dimensional convolution filter
+@heading Parameters
+@table @asis
+@item @var{target}
+Must be @code{GL_CONVOLUTION_1D}.
+
+@item @var{internalformat}
+The internal format of the convolution filter kernel. The allowable
+values are @code{GL_ALPHA}, @code{GL_ALPHA4}, @code{GL_ALPHA8},
+@code{GL_ALPHA12}, @code{GL_ALPHA16}, @code{GL_LUMINANCE},
+@code{GL_LUMINANCE4}, @code{GL_LUMINANCE8}, @code{GL_LUMINANCE12},
+@code{GL_LUMINANCE16}, @code{GL_LUMINANCE_ALPHA},
+@code{GL_LUMINANCE4_ALPHA4}, @code{GL_LUMINANCE6_ALPHA2},
+@code{GL_LUMINANCE8_ALPHA8}, @code{GL_LUMINANCE12_ALPHA4},
+@code{GL_LUMINANCE12_ALPHA12}, @code{GL_LUMINANCE16_ALPHA16},
+@code{GL_INTENSITY}, @code{GL_INTENSITY4}, @code{GL_INTENSITY8},
+@code{GL_INTENSITY12}, @code{GL_INTENSITY16}, @code{GL_R3_G3_B2},
+@code{GL_RGB}, @code{GL_RGB4}, @code{GL_RGB5}, @code{GL_RGB8},
+@code{GL_RGB10}, @code{GL_RGB12}, @code{GL_RGB16}, @code{GL_RGBA},
+@code{GL_RGBA2}, @code{GL_RGBA4}, @code{GL_RGB5_A1}, @code{GL_RGBA8},
+@code{GL_RGB10_A2}, @code{GL_RGBA12}, or @code{GL_RGBA16}.
+
+@item @var{x}
+@itemx @var{y}
+The window space coordinates of the lower-left coordinate of the pixel
+array to copy.
+
+@item @var{width}
+The width of the pixel array to copy.
+
+@end table
+
+@heading Description
+@code{glCopyConvolutionFilter1D} defines a one-dimensional convolution
+filter kernel with pixels from the current @code{GL_READ_BUFFER} (rather
+than from main memory, as is the case for @code{glConvolutionFilter1D}).
+
+The screen-aligned pixel rectangle with lower-left corner at (@var{x},\
+@var{y}), width @var{width} and height 1 is used to define the
+convolution filter. If any pixels within this region are outside the
+window that is associated with the GL context, the values obtained for
+those pixels are undefined.
+
+The pixels in the rectangle are processed exactly as if
+@code{glReadPixels} had been called with @var{format} set to RGBA, but
+the process stops just before final conversion. The R, G, B, and A
+components of each pixel are next scaled by the four 1D
+@code{GL_CONVOLUTION_FILTER_SCALE} parameters and biased by the four 1D
+@code{GL_CONVOLUTION_FILTER_BIAS} parameters. (The scale and bias
+parameters are set by @code{glConvolutionParameter} using the
+@code{GL_CONVOLUTION_1D} target and the names
+@code{GL_CONVOLUTION_FILTER_SCALE} and
+@code{GL_CONVOLUTION_FILTER_BIAS}. The parameters themselves are vectors
+of four values that are applied to red, green, blue, and alpha, in that
+order.) The R, G, B, and A values are not clamped to [0,1] at any time
+during this process.
+
+Each pixel is then converted to the internal format specified by
+@var{internalformat}. This conversion simply maps the component values
+of the pixel (R, G, B, and A) to the values included in the internal
+format (red, green, blue, alpha, luminance, and intensity). The mapping
+is as follows:
+
+
+
+@table @asis
+@item @strong{Internal Format}
+@strong{Red}, @strong{Green}, @strong{Blue}, @strong{Alpha},
+@strong{Luminance}, @strong{Intensity}
+
+@item @code{GL_ALPHA}
+, , , A , ,
+
+@item @code{GL_LUMINANCE}
+, , , , R ,
+
+@item @code{GL_LUMINANCE_ALPHA}
+, , , A , R ,
+
+@item @code{GL_INTENSITY}
+, , , , , R
+
+@item @code{GL_RGB}
+R , G , B , , ,
+
+@item @code{GL_RGBA}
+R , G , B , A , ,
+
+@end table
+
+The red, green, blue, alpha, luminance, and/or intensity components of
+the resulting pixels are stored in floating-point rather than integer
+format.
+
+Pixel ordering is such that lower x screen coordinates correspond to
+lower @var{i} filter image coordinates.
+
+Note that after a convolution is performed, the resulting color
+components are also scaled by their corresponding
+@code{GL_POST_CONVOLUTION_c_SCALE} parameters and biased by their
+corresponding @code{GL_POST_CONVOLUTION_c_BIAS} parameters (where
+@var{c} takes on the values @strong{RED}, @strong{GREEN}, @strong{BLUE},
+and @strong{ALPHA}). These parameters are set by @code{glPixelTransfer}.
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{target} is not
+@code{GL_CONVOLUTION_1D}.
+
+@code{GL_INVALID_ENUM} is generated if @var{internalformat} is not one
+of the allowable values.
+
+@code{GL_INVALID_VALUE} is generated if @var{width} is less than zero or
+greater than the maximum supported value. This value may be queried with
+@code{glGetConvolutionParameter} using target @code{GL_CONVOLUTION_1D}
+and name @code{GL_MAX_CONVOLUTION_WIDTH}.
+
+@code{GL_INVALID_OPERATION} is generated if
+@code{glCopyConvolutionFilter1D} is executed between the execution of
+@code{glBegin} and the corresponding execution of @code{glEnd}.
+
+@end defun
+
+@defun glCopyConvolutionFilter2D
+@heading copy pixels into a two-dimensional convolution filter
+@heading Parameters
+@table @asis
+@item @var{target}
+Must be @code{GL_CONVOLUTION_2D}.
+
+@item @var{internalformat}
+The internal format of the convolution filter kernel. The allowable
+values are @code{GL_ALPHA}, @code{GL_ALPHA4}, @code{GL_ALPHA8},
+@code{GL_ALPHA12}, @code{GL_ALPHA16}, @code{GL_LUMINANCE},
+@code{GL_LUMINANCE4}, @code{GL_LUMINANCE8}, @code{GL_LUMINANCE12},
+@code{GL_LUMINANCE16}, @code{GL_LUMINANCE_ALPHA},
+@code{GL_LUMINANCE4_ALPHA4}, @code{GL_LUMINANCE6_ALPHA2},
+@code{GL_LUMINANCE8_ALPHA8}, @code{GL_LUMINANCE12_ALPHA4},
+@code{GL_LUMINANCE12_ALPHA12}, @code{GL_LUMINANCE16_ALPHA16},
+@code{GL_INTENSITY}, @code{GL_INTENSITY4}, @code{GL_INTENSITY8},
+@code{GL_INTENSITY12}, @code{GL_INTENSITY16}, @code{GL_R3_G3_B2},
+@code{GL_RGB}, @code{GL_RGB4}, @code{GL_RGB5}, @code{GL_RGB8},
+@code{GL_RGB10}, @code{GL_RGB12}, @code{GL_RGB16}, @code{GL_RGBA},
+@code{GL_RGBA2}, @code{GL_RGBA4}, @code{GL_RGB5_A1}, @code{GL_RGBA8},
+@code{GL_RGB10_A2}, @code{GL_RGBA12}, or @code{GL_RGBA16}.
+
+@item @var{x}
+@itemx @var{y}
+The window space coordinates of the lower-left coordinate of the pixel
+array to copy.
+
+@item @var{width}
+The width of the pixel array to copy.
+
+@item @var{height}
+The height of the pixel array to copy.
+
+@end table
+
+@heading Description
+@code{glCopyConvolutionFilter2D} defines a two-dimensional convolution
+filter kernel with pixels from the current @code{GL_READ_BUFFER} (rather
+than from main memory, as is the case for @code{glConvolutionFilter2D}).
+
+The screen-aligned pixel rectangle with lower-left corner at (@var{x},\
+@var{y}), width @var{width} and height @var{height} is used to define
+the convolution filter. If any pixels within this region are outside the
+window that is associated with the GL context, the values obtained for
+those pixels are undefined.
+
+The pixels in the rectangle are processed exactly as if
+@code{glReadPixels} had been called with @var{format} set to RGBA, but
+the process stops just before final conversion. The R, G, B, and A
+components of each pixel are next scaled by the four 2D
+@code{GL_CONVOLUTION_FILTER_SCALE} parameters and biased by the four 2D
+@code{GL_CONVOLUTION_FILTER_BIAS} parameters. (The scale and bias
+parameters are set by @code{glConvolutionParameter} using the
+@code{GL_CONVOLUTION_2D} target and the names
+@code{GL_CONVOLUTION_FILTER_SCALE} and
+@code{GL_CONVOLUTION_FILTER_BIAS}. The parameters themselves are vectors
+of four values that are applied to red, green, blue, and alpha, in that
+order.) The R, G, B, and A values are not clamped to [0,1] at any time
+during this process.
+
+Each pixel is then converted to the internal format specified by
+@var{internalformat}. This conversion simply maps the component values
+of the pixel (R, G, B, and A) to the values included in the internal
+format (red, green, blue, alpha, luminance, and intensity). The mapping
+is as follows:
+
+
+
+@table @asis
+@item @strong{Internal Format}
+@strong{Red}, @strong{Green}, @strong{Blue}, @strong{Alpha},
+@strong{Luminance}, @strong{Intensity}
+
+@item @code{GL_ALPHA}
+, , , A , ,
+
+@item @code{GL_LUMINANCE}
+, , , , R ,
+
+@item @code{GL_LUMINANCE_ALPHA}
+, , , A , R ,
+
+@item @code{GL_INTENSITY}
+, , , , , R
+
+@item @code{GL_RGB}
+R , G , B , , ,
+
+@item @code{GL_RGBA}
+R , G , B , A , ,
+
+@end table
+
+The red, green, blue, alpha, luminance, and/or intensity components of
+the resulting pixels are stored in floating-point rather than integer
+format.
+
+Pixel ordering is such that lower x screen coordinates correspond to
+lower @var{i} filter image coordinates, and lower y screen coordinates
+correspond to lower @var{j} filter image coordinates.
+
+Note that after a convolution is performed, the resulting color
+components are also scaled by their corresponding
+@code{GL_POST_CONVOLUTION_c_SCALE} parameters and biased by their
+corresponding @code{GL_POST_CONVOLUTION_c_BIAS} parameters (where
+@var{c} takes on the values @strong{RED}, @strong{GREEN}, @strong{BLUE},
+and @strong{ALPHA}). These parameters are set by @code{glPixelTransfer}.
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{target} is not
+@code{GL_CONVOLUTION_2D}.
+
+@code{GL_INVALID_ENUM} is generated if @var{internalformat} is not one
+of the allowable values.
+
+@code{GL_INVALID_VALUE} is generated if @var{width} is less than zero or
+greater than the maximum supported value. This value may be queried with
+@code{glGetConvolutionParameter} using target @code{GL_CONVOLUTION_2D}
+and name @code{GL_MAX_CONVOLUTION_WIDTH}.
+
+@code{GL_INVALID_VALUE} is generated if @var{height} is less than zero
+or greater than the maximum supported value. This value may be queried
+with @code{glGetConvolutionParameter} using target
+@code{GL_CONVOLUTION_2D} and name @code{GL_MAX_CONVOLUTION_HEIGHT}.
+
+@code{GL_INVALID_OPERATION} is generated if
+@code{glCopyConvolutionFilter2D} is executed between the execution of
+@code{glBegin} and the corresponding execution of @code{glEnd}.
+
+@end defun
+
+@defun glCopyPixels
+@heading copy pixels in the frame buffer
+@heading Parameters
+@table @asis
+@item @var{x}
+@itemx @var{y}
+Specify the window coordinates of the lower left corner of the
+rectangular region of pixels to be copied.
+
+@item @var{width}
+@itemx @var{height}
+Specify the dimensions of the rectangular region of pixels to be copied.
+Both must be nonnegative.
+
+@item @var{type}
+Specifies whether color values, depth values, or stencil values are to
+be copied. Symbolic constants @code{GL_COLOR}, @code{GL_DEPTH}, and
+@code{GL_STENCIL} are accepted.
+
+@end table
+
+@heading Description
+@code{glCopyPixels} copies a screen-aligned rectangle of pixels from the
+specified frame buffer location to a region relative to the current
+raster position. Its operation is well defined only if the entire pixel
+source region is within the exposed portion of the window. Results of
+copies from outside the window, or from regions of the window that are
+not exposed, are hardware dependent and undefined.
+
+@var{x} and @var{y} specify the window coordinates of the lower left
+corner of the rectangular region to be copied. @var{width} and
+@var{height} specify the dimensions of the rectangular region to be
+copied. Both @var{width} and @var{height} must not be negative.
+
+Several parameters control the processing of the pixel data while it is
+being copied. These parameters are set with three commands:
+@code{glPixelTransfer}, @code{glPixelMap}, and @code{glPixelZoom}. This
+reference page describes the effects on @code{glCopyPixels} of most, but
+not all, of the parameters specified by these three commands.
+
+@code{glCopyPixels} copies values from each pixel with the lower
+left-hand corner at @math{(@var{x}+@var{i},@var{y}+@var{j})} for
+@math{0<=@var{i}<@var{width}} and @math{0<=@var{j}<@var{height}}. This
+pixel is said to be the @math{@var{i}}th pixel in the @math{@var{j}}th
+row. Pixels are copied in row order from the lowest to the highest row,
+left to right in each row.
+
+@var{type} specifies whether color, depth, or stencil data is to be
+copied. The details of the transfer for each data type are as follows:
+
+@table @asis
+@item @code{GL_COLOR}
+Indices or RGBA colors are read from the buffer currently specified as
+the read source buffer (see @code{glReadBuffer}). If the GL is in color
+index mode, each index that is read from this buffer is converted to a
+fixed-point format with an unspecified number of bits to the right of
+the binary point. Each index is then shifted left by
+@code{GL_INDEX_SHIFT} bits, and added to @code{GL_INDEX_OFFSET}. If
+@code{GL_INDEX_SHIFT} is negative, the shift is to the right. In either
+case, zero bits fill otherwise unspecified bit locations in the result.
+If @code{GL_MAP_COLOR} is true, the index is replaced with the value
+that it references in lookup table @code{GL_PIXEL_MAP_I_TO_I}. Whether
+the lookup replacement of the index is done or not, the integer part of
+the index is then ANDed with @math{2^@var{b}-1}, where @math{@var{b}} is
+the number of bits in a color index buffer.
+
+If the GL is in RGBA mode, the red, green, blue, and alpha components of
+each pixel that is read are converted to an internal floating-point
+format with unspecified precision. The conversion maps the largest
+representable component value to 1.0, and component value 0 to 0.0. The
+resulting floating-point color values are then multiplied by
+@code{GL_c_SCALE} and added to @code{GL_c_BIAS}, where @var{c} is RED,
+GREEN, BLUE, and ALPHA for the respective color components. The results
+are clamped to the range [0,1]. If @code{GL_MAP_COLOR} is true, each
+color component is scaled by the size of lookup table
+@code{GL_PIXEL_MAP_c_TO_c}, then replaced by the value that it
+references in that table. @var{c} is R, G, B, or A.
+
+If the @code{ARB_imaging} extension is supported, the color values may
+be additionally processed by color-table lookups, color-matrix
+transformations, and convolution filters.
+
+The GL then converts the resulting indices or RGBA colors to fragments
+by attaching the current raster position @var{z} coordinate and texture
+coordinates to each pixel, then assigning window coordinates
+@math{(@var{x}_@var{r}+@var{i},@var{y}_@var{r}+@var{j})}, where
+@math{(@var{x}_@var{r},@var{y}_@var{r})} is the current raster position,
+and the pixel was the @math{@var{i}}th pixel in the @math{@var{j}}th
+row. These pixel fragments are then treated just like the fragments
+generated by rasterizing points, lines, or polygons. Texture mapping,
+fog, and all the fragment operations are applied before the fragments
+are written to the frame buffer.
+
+@item @code{GL_DEPTH}
+Depth values are read from the depth buffer and converted directly to an
+internal floating-point format with unspecified precision. The resulting
+floating-point depth value is then multiplied by @code{GL_DEPTH_SCALE}
+and added to @code{GL_DEPTH_BIAS}. The result is clamped to the range
+[0,1].
+
+The GL then converts the resulting depth components to fragments by
+attaching the current raster position color or color index and texture
+coordinates to each pixel, then assigning window coordinates
+@math{(@var{x}_@var{r}+@var{i},@var{y}_@var{r}+@var{j})}, where
+@math{(@var{x}_@var{r},@var{y}_@var{r})} is the current raster position,
+and the pixel was the @math{@var{i}}th pixel in the @math{@var{j}}th
+row. These pixel fragments are then treated just like the fragments
+generated by rasterizing points, lines, or polygons. Texture mapping,
+fog, and all the fragment operations are applied before the fragments
+are written to the frame buffer.
+
+@item @code{GL_STENCIL}
+Stencil indices are read from the stencil buffer and converted to an
+internal fixed-point format with an unspecified number of bits to the
+right of the binary point. Each fixed-point index is then shifted left
+by @code{GL_INDEX_SHIFT} bits, and added to @code{GL_INDEX_OFFSET}. If
+@code{GL_INDEX_SHIFT} is negative, the shift is to the right. In either
+case, zero bits fill otherwise unspecified bit locations in the result.
+If @code{GL_MAP_STENCIL} is true, the index is replaced with the value
+that it references in lookup table @code{GL_PIXEL_MAP_S_TO_S}. Whether
+the lookup replacement of the index is done or not, the integer part of
+the index is then ANDed with @math{2^@var{b}-1}, where @math{@var{b}} is
+the number of bits in the stencil buffer. The resulting stencil indices
+are then written to the stencil buffer such that the index read from the
+@math{@var{i}}th location of the @math{@var{j}}th row is written to
+location @math{(@var{x}_@var{r}+@var{i},@var{y}_@var{r}+@var{j})}, where
+@math{(@var{x}_@var{r},@var{y}_@var{r})} is the current raster position.
+Only the pixel ownership test, the scissor test, and the stencil
+writemask affect these write operations.
+
+@end table
+
+The rasterization described thus far assumes pixel zoom factors of 1.0.
+If @code{glPixelZoom} is used to change the @math{@var{x}} and
+@math{@var{y}} pixel zoom factors, pixels are converted to fragments as
+follows. If @math{(@var{x}_@var{r},@var{y}_@var{r})} is the current
+raster position, and a given pixel is in the @math{@var{i}}th location
+in the @math{@var{j}}th row of the source pixel rectangle, then
+fragments are generated for pixels whose centers are in the rectangle
+with corners at
+
+@math{(@var{x}_@var{r}+@var{zoom}_@var{x},@var{i},@var{y}_@var{r}+@var{zoom}_@var{y},@var{j})}
+
+and
+
+@math{(@var{x}_@var{r}+@var{zoom}_@var{x},(@var{i}+1,),@var{y}_@var{r}+@var{zoom}_@var{y},(@var{j}+1,))}
+
+where @math{@var{zoom}_@var{x}} is the value of @code{GL_ZOOM_X} and
+@math{@var{zoom}_@var{y}} is the value of @code{GL_ZOOM_Y}.
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{type} is not an accepted
+value.
+
+@code{GL_INVALID_VALUE} is generated if either @var{width} or
+@var{height} is negative.
+
+@code{GL_INVALID_OPERATION} is generated if @var{type} is
+@code{GL_DEPTH} and there is no depth buffer.
+
+@code{GL_INVALID_OPERATION} is generated if @var{type} is
+@code{GL_STENCIL} and there is no stencil buffer.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glCopyPixels} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glCopyTexImage1D
+@heading copy pixels into a 1D texture image
+@heading Parameters
+@table @asis
+@item @var{target}
+Specifies the target texture. Must be @code{GL_TEXTURE_1D}.
+
+@item @var{level}
+Specifies the level-of-detail number. Level 0 is the base image level.
+Level @var{n} is the @var{n}th mipmap reduction image.
+
+@item @var{internalformat}
+Specifies the internal format of the texture. Must be one of the
+following symbolic constants: @code{GL_ALPHA}, @code{GL_ALPHA4},
+@code{GL_ALPHA8}, @code{GL_ALPHA12}, @code{GL_ALPHA16},
+@code{GL_COMPRESSED_ALPHA}, @code{GL_COMPRESSED_LUMINANCE},
+@code{GL_COMPRESSED_LUMINANCE_ALPHA}, @code{GL_COMPRESSED_INTENSITY},
+@code{GL_COMPRESSED_RGB}, @code{GL_COMPRESSED_RGBA},
+@code{GL_DEPTH_COMPONENT}, @code{GL_DEPTH_COMPONENT16},
+@code{GL_DEPTH_COMPONENT24}, @code{GL_DEPTH_COMPONENT32},
+@code{GL_LUMINANCE}, @code{GL_LUMINANCE4}, @code{GL_LUMINANCE8},
+@code{GL_LUMINANCE12}, @code{GL_LUMINANCE16}, @code{GL_LUMINANCE_ALPHA},
+@code{GL_LUMINANCE4_ALPHA4}, @code{GL_LUMINANCE6_ALPHA2},
+@code{GL_LUMINANCE8_ALPHA8}, @code{GL_LUMINANCE12_ALPHA4},
+@code{GL_LUMINANCE12_ALPHA12}, @code{GL_LUMINANCE16_ALPHA16},
+@code{GL_INTENSITY}, @code{GL_INTENSITY4}, @code{GL_INTENSITY8},
+@code{GL_INTENSITY12}, @code{GL_INTENSITY16}, @code{GL_RGB},
+@code{GL_R3_G3_B2}, @code{GL_RGB4}, @code{GL_RGB5}, @code{GL_RGB8},
+@code{GL_RGB10}, @code{GL_RGB12}, @code{GL_RGB16}, @code{GL_RGBA},
+@code{GL_RGBA2}, @code{GL_RGBA4}, @code{GL_RGB5_A1}, @code{GL_RGBA8},
+@code{GL_RGB10_A2}, @code{GL_RGBA12}, @code{GL_RGBA16},
+@code{GL_SLUMINANCE}, @code{GL_SLUMINANCE8}, @code{GL_SLUMINANCE_ALPHA},
+@code{GL_SLUMINANCE8_ALPHA8}, @code{GL_SRGB}, @code{GL_SRGB8},
+@code{GL_SRGB_ALPHA}, or @code{GL_SRGB8_ALPHA8}.
+
+@item @var{x}
+@itemx @var{y}
+Specify the window coordinates of the left corner of the row of pixels
+to be copied.
+
+@item @var{width}
+Specifies the width of the texture image. Must be 0 or
+@math{2^@var{n}+2(@var{border},)} for some integer @math{@var{n}}. The
+height of the texture image is 1.
+
+@item @var{border}
+Specifies the width of the border. Must be either 0 or 1.
+
+@end table
+
+@heading Description
+@code{glCopyTexImage1D} defines a one-dimensional texture image with
+pixels from the current @code{GL_READ_BUFFER}.
+
+The screen-aligned pixel row with left corner at
+@math{(@var{x},@var{y})} and with a length of
+@math{@var{width}+2(@var{border},)} defines the texture array at the
+mipmap level specified by @var{level}. @var{internalformat} specifies
+the internal format of the texture array.
+
+The pixels in the row are processed exactly as if @code{glCopyPixels}
+had been called, but the process stops just before final conversion. At
+this point all pixel component values are clamped to the range
+@math{[0,1]} and then converted to the texture's internal format for
+storage in the texel array.
+
+Pixel ordering is such that lower @math{@var{x}} screen coordinates
+correspond to lower texture coordinates.
+
+If any of the pixels within the specified row of the current
+@code{GL_READ_BUFFER} are outside the window associated with the current
+rendering context, then the values obtained for those pixels are
+undefined.
+
+@code{glCopyTexImage1D} defines a one-dimensional texture image with
+pixels from the current @code{GL_READ_BUFFER}.
+
+When @var{internalformat} is one of the sRGB types, the GL does not
+automatically convert the source pixels to the sRGB color space. In this
+case, the @code{glPixelMap} function can be used to accomplish the
+conversion.
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{target} is not one of the
+allowable values.
+
+@code{GL_INVALID_VALUE} is generated if @var{level} is less than 0.
+
+@code{GL_INVALID_VALUE} may be generated if @var{level} is greater than
+@math{@var{log}_2@var{max}}, where @math{@var{max}} is the returned
+value of @code{GL_MAX_TEXTURE_SIZE}.
+
+@code{GL_INVALID_VALUE} is generated if @var{internalformat} is not an
+allowable value.
+
+@code{GL_INVALID_VALUE} is generated if @var{width} is less than 0 or
+greater than 2 + @code{GL_MAX_TEXTURE_SIZE}.
+
+@code{GL_INVALID_VALUE} is generated if non-power-of-two textures are
+not supported and the @var{width} cannot be represented as
+@math{2^@var{n}+2(@var{border},)} for some integer value of @var{n}.
+
+@code{GL_INVALID_VALUE} is generated if @var{border} is not 0 or 1.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glCopyTexImage1D} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@code{GL_INVALID_OPERATION} is generated if @var{internalformat} is
+@code{GL_DEPTH_COMPONENT}, @code{GL_DEPTH_COMPONENT16},
+@code{GL_DEPTH_COMPONENT24}, or @code{GL_DEPTH_COMPONENT32} and there is
+no depth buffer.
+
+@end defun
+
+@defun glCopyTexImage2D
+@heading copy pixels into a 2D texture image
+@heading Parameters
+@table @asis
+@item @var{target}
+Specifies the target texture. Must be @code{GL_TEXTURE_2D},
+@code{GL_TEXTURE_CUBE_MAP_POSITIVE_X},
+@code{GL_TEXTURE_CUBE_MAP_NEGATIVE_X},
+@code{GL_TEXTURE_CUBE_MAP_POSITIVE_Y},
+@code{GL_TEXTURE_CUBE_MAP_NEGATIVE_Y},
+@code{GL_TEXTURE_CUBE_MAP_POSITIVE_Z}, or
+@code{GL_TEXTURE_CUBE_MAP_NEGATIVE_Z}.
+
+@item @var{level}
+Specifies the level-of-detail number. Level 0 is the base image level.
+Level @var{n} is the @var{n}th mipmap reduction image.
+
+@item @var{internalformat}
+Specifies the internal format of the texture. Must be one of the
+following symbolic constants: @code{GL_ALPHA}, @code{GL_ALPHA4},
+@code{GL_ALPHA8}, @code{GL_ALPHA12}, @code{GL_ALPHA16},
+@code{GL_COMPRESSED_ALPHA}, @code{GL_COMPRESSED_LUMINANCE},
+@code{GL_COMPRESSED_LUMINANCE_ALPHA}, @code{GL_COMPRESSED_INTENSITY},
+@code{GL_COMPRESSED_RGB}, @code{GL_COMPRESSED_RGBA},
+@code{GL_DEPTH_COMPONENT}, @code{GL_DEPTH_COMPONENT16},
+@code{GL_DEPTH_COMPONENT24}, @code{GL_DEPTH_COMPONENT32},
+@code{GL_LUMINANCE}, @code{GL_LUMINANCE4}, @code{GL_LUMINANCE8},
+@code{GL_LUMINANCE12}, @code{GL_LUMINANCE16}, @code{GL_LUMINANCE_ALPHA},
+@code{GL_LUMINANCE4_ALPHA4}, @code{GL_LUMINANCE6_ALPHA2},
+@code{GL_LUMINANCE8_ALPHA8}, @code{GL_LUMINANCE12_ALPHA4},
+@code{GL_LUMINANCE12_ALPHA12}, @code{GL_LUMINANCE16_ALPHA16},
+@code{GL_INTENSITY}, @code{GL_INTENSITY4}, @code{GL_INTENSITY8},
+@code{GL_INTENSITY12}, @code{GL_INTENSITY16}, @code{GL_RGB},
+@code{GL_R3_G3_B2}, @code{GL_RGB4}, @code{GL_RGB5}, @code{GL_RGB8},
+@code{GL_RGB10}, @code{GL_RGB12}, @code{GL_RGB16}, @code{GL_RGBA},
+@code{GL_RGBA2}, @code{GL_RGBA4}, @code{GL_RGB5_A1}, @code{GL_RGBA8},
+@code{GL_RGB10_A2}, @code{GL_RGBA12}, @code{GL_RGBA16},
+@code{GL_SLUMINANCE}, @code{GL_SLUMINANCE8}, @code{GL_SLUMINANCE_ALPHA},
+@code{GL_SLUMINANCE8_ALPHA8}, @code{GL_SRGB}, @code{GL_SRGB8},
+@code{GL_SRGB_ALPHA}, or @code{GL_SRGB8_ALPHA8}.
+
+@item @var{x}
+@itemx @var{y}
+Specify the window coordinates of the lower left corner of the
+rectangular region of pixels to be copied.
+
+@item @var{width}
+Specifies the width of the texture image. Must be 0 or
+@math{2^@var{n}+2(@var{border},)} for some integer @math{@var{n}}.
+
+@item @var{height}
+Specifies the height of the texture image. Must be 0 or
+@math{2^@var{m}+2(@var{border},)} for some integer @math{@var{m}}.
+
+@item @var{border}
+Specifies the width of the border. Must be either 0 or 1.
+
+@end table
+
+@heading Description
+@code{glCopyTexImage2D} defines a two-dimensional texture image, or
+cube-map texture image with pixels from the current
+@code{GL_READ_BUFFER}.
+
+The screen-aligned pixel rectangle with lower left corner at (@var{x},
+@var{y}) and with a width of @math{@var{width}+2(@var{border},)} and a
+height of @math{@var{height}+2(@var{border},)} defines the texture
+array at the mipmap level specified by @var{level}. @var{internalformat}
+specifies the internal format of the texture array.
+
+The pixels in the rectangle are processed exactly as if
+@code{glCopyPixels} had been called, but the process stops just before
+final conversion. At this point all pixel component values are clamped
+to the range @math{[0,1]} and then converted to the texture's internal
+format for storage in the texel array.
+
+Pixel ordering is such that lower @math{@var{x}} and @math{@var{y}}
+screen coordinates correspond to lower @math{@var{s}} and @math{@var{t}}
+texture coordinates.
+
+If any of the pixels within the specified rectangle of the current
+@code{GL_READ_BUFFER} are outside the window associated with the current
+rendering context, then the values obtained for those pixels are
+undefined.
+
+When @var{internalformat} is one of the sRGB types, the GL does not
+automatically convert the source pixels to the sRGB color space. In this
+case, the @code{glPixelMap} function can be used to accomplish the
+conversion.
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{target} is not
+@code{GL_TEXTURE_2D}, @code{GL_TEXTURE_CUBE_MAP_POSITIVE_X},
+@code{GL_TEXTURE_CUBE_MAP_NEGATIVE_X},
+@code{GL_TEXTURE_CUBE_MAP_POSITIVE_Y},
+@code{GL_TEXTURE_CUBE_MAP_NEGATIVE_Y},
+@code{GL_TEXTURE_CUBE_MAP_POSITIVE_Z}, or
+@code{GL_TEXTURE_CUBE_MAP_NEGATIVE_Z}.
+
+@code{GL_INVALID_VALUE} is generated if @var{level} is less than 0.
+
+@code{GL_INVALID_VALUE} may be generated if @var{level} is greater than
+@math{@var{log}_2@var{max}}, where @math{@var{max}} is the returned
+value of @code{GL_MAX_TEXTURE_SIZE}.
+
+@code{GL_INVALID_VALUE} is generated if @var{width} is less than 0 or
+greater than 2 + @code{GL_MAX_TEXTURE_SIZE}.
+
+@code{GL_INVALID_VALUE} is generated if non-power-of-two textures are
+not supported and the @var{width} or @var{depth} cannot be represented
+as @math{2^@var{k}+2(@var{border},)} for some integer @math{@var{k}}.
+
+@code{GL_INVALID_VALUE} is generated if @var{border} is not 0 or 1.
+
+@code{GL_INVALID_VALUE} is generated if @var{internalformat} is not an
+accepted format.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glCopyTexImage2D} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@code{GL_INVALID_OPERATION} is generated if @var{internalformat} is
+@code{GL_DEPTH_COMPONENT}, @code{GL_DEPTH_COMPONENT16},
+@code{GL_DEPTH_COMPONENT24}, or @code{GL_DEPTH_COMPONENT32} and there is
+no depth buffer.
+
+@end defun
+
+@defun glCopyTexSubImage1D
+@heading copy a one-dimensional texture subimage
+@heading Parameters
+@table @asis
+@item @var{target}
+Specifies the target texture. Must be @code{GL_TEXTURE_1D}.
+
+@item @var{level}
+Specifies the level-of-detail number. Level 0 is the base image level.
+Level @var{n} is the @var{n}th mipmap reduction image.
+
+@item @var{xoffset}
+Specifies the texel offset within the texture array.
+
+@item @var{x}
+@itemx @var{y}
+Specify the window coordinates of the left corner of the row of pixels
+to be copied.
+
+@item @var{width}
+Specifies the width of the texture subimage.
+
+@end table
+
+@heading Description
+@code{glCopyTexSubImage1D} replaces a portion of a one-dimensional
+texture image with pixels from the current @code{GL_READ_BUFFER} (rather
+than from main memory, as is the case for @code{glTexSubImage1D}).
+
+The screen-aligned pixel row with left corner at (@var{x},\ @var{y}),
+and with length @var{width} replaces the portion of the texture array
+with x indices @var{xoffset} through @math{@var{xoffset}+@var{width}-1},
+inclusive. The destination in the texture array may not include any
+texels outside the texture array as it was originally specified.
+
+The pixels in the row are processed exactly as if @code{glCopyPixels}
+had been called, but the process stops just before final conversion. At
+this point, all pixel component values are clamped to the range
+@math{[0,1]} and then converted to the texture's internal format for
+storage in the texel array.
+
+It is not an error to specify a subtexture with zero width, but such a
+specification has no effect. If any of the pixels within the specified
+row of the current @code{GL_READ_BUFFER} are outside the read window
+associated with the current rendering context, then the values obtained
+for those pixels are undefined.
+
+No change is made to the @var{internalformat}, @var{width}, or
+@var{border} parameters of the specified texture array or to texel
+values outside the specified subregion.
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if /@var{target} is not
+@code{GL_TEXTURE_1D}.
+
+@code{GL_INVALID_OPERATION} is generated if the texture array has not
+been defined by a previous @code{glTexImage1D} or
+@code{glCopyTexImage1D} operation.
+
+@code{GL_INVALID_VALUE} is generated if @var{level} is less than 0.
+
+@code{GL_INVALID_VALUE} may be generated if
+@math{@var{level}>@var{log}_2(@var{max},)}, where @var{max} is the
+returned value of @code{GL_MAX_TEXTURE_SIZE}.
+
+@code{GL_INVALID_VALUE} is generated if @math{@var{xoffset}<-@var{b}},
+or @math{(@var{xoffset}+@var{width},)>(@var{w}-@var{b},)}, where
+@math{@var{w}} is the @code{GL_TEXTURE_WIDTH} and @math{@var{b}} is the
+@code{GL_TEXTURE_BORDER} of the texture image being modified. Note that
+@math{@var{w}} includes twice the border width.
+
+
+
+@end defun
+
+@defun glCopyTexSubImage2D
+@heading copy a two-dimensional texture subimage
+@heading Parameters
+@table @asis
+@item @var{target}
+Specifies the target texture. Must be @code{GL_TEXTURE_2D},
+@code{GL_TEXTURE_CUBE_MAP_POSITIVE_X},
+@code{GL_TEXTURE_CUBE_MAP_NEGATIVE_X},
+@code{GL_TEXTURE_CUBE_MAP_POSITIVE_Y},
+@code{GL_TEXTURE_CUBE_MAP_NEGATIVE_Y},
+@code{GL_TEXTURE_CUBE_MAP_POSITIVE_Z}, or
+@code{GL_TEXTURE_CUBE_MAP_NEGATIVE_Z}.
+
+@item @var{level}
+Specifies the level-of-detail number. Level 0 is the base image level.
+Level @var{n} is the @var{n}th mipmap reduction image.
+
+@item @var{xoffset}
+Specifies a texel offset in the x direction within the texture array.
+
+@item @var{yoffset}
+Specifies a texel offset in the y direction within the texture array.
+
+@item @var{x}
+@itemx @var{y}
+Specify the window coordinates of the lower left corner of the
+rectangular region of pixels to be copied.
+
+@item @var{width}
+Specifies the width of the texture subimage.
+
+@item @var{height}
+Specifies the height of the texture subimage.
+
+@end table
+
+@heading Description
+@code{glCopyTexSubImage2D} replaces a rectangular portion of a
+two-dimensional texture image or cube-map texture image with pixels from
+the current @code{GL_READ_BUFFER} (rather than from main memory, as is
+the case for @code{glTexSubImage2D}).
+
+The screen-aligned pixel rectangle with lower left corner at
+@math{(@var{x},@var{y})} and with width @var{width} and height
+@var{height} replaces the portion of the texture array with x indices
+@var{xoffset} through @math{@var{xoffset}+@var{width}-1}, inclusive, and
+y indices @var{yoffset} through @math{@var{yoffset}+@var{height}-1},
+inclusive, at the mipmap level specified by @var{level}.
+
+The pixels in the rectangle are processed exactly as if
+@code{glCopyPixels} had been called, but the process stops just before
+final conversion. At this point, all pixel component values are clamped
+to the range @math{[0,1]} and then converted to the texture's internal
+format for storage in the texel array.
+
+The destination rectangle in the texture array may not include any
+texels outside the texture array as it was originally specified. It is
+not an error to specify a subtexture with zero width or height, but such
+a specification has no effect.
+
+If any of the pixels within the specified rectangle of the current
+@code{GL_READ_BUFFER} are outside the read window associated with the
+current rendering context, then the values obtained for those pixels are
+undefined.
+
+No change is made to the @var{internalformat}, @var{width},
+@var{height}, or @var{border} parameters of the specified texture array
+or to texel values outside the specified subregion.
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{target} is not
+@code{GL_TEXTURE_2D}, @code{GL_TEXTURE_CUBE_MAP_POSITIVE_X},
+@code{GL_TEXTURE_CUBE_MAP_NEGATIVE_X},
+@code{GL_TEXTURE_CUBE_MAP_POSITIVE_Y},
+@code{GL_TEXTURE_CUBE_MAP_NEGATIVE_Y},
+@code{GL_TEXTURE_CUBE_MAP_POSITIVE_Z}, or
+@code{GL_TEXTURE_CUBE_MAP_NEGATIVE_Z}.
+
+@code{GL_INVALID_OPERATION} is generated if the texture array has not
+been defined by a previous @code{glTexImage2D} or
+@code{glCopyTexImage2D} operation.
+
+@code{GL_INVALID_VALUE} is generated if @var{level} is less than 0.
+
+@code{GL_INVALID_VALUE} may be generated if
+@math{@var{level}>@var{log}_2(@var{max},)}, where @math{@var{max}} is
+the returned value of @code{GL_MAX_TEXTURE_SIZE}.
+
+@code{GL_INVALID_VALUE} is generated if @math{@var{xoffset}<-@var{b}},
+@math{(@var{xoffset}+@var{width},)>(@var{w}-@var{b},)},
+@math{@var{yoffset}<-@var{b}}, or
+@math{(@var{yoffset}+@var{height},)>(@var{h}-@var{b},)}, where
+@math{@var{w}} is the @code{GL_TEXTURE_WIDTH}, @math{@var{h}} is the
+@code{GL_TEXTURE_HEIGHT}, and @math{@var{b}} is the
+@code{GL_TEXTURE_BORDER} of the texture image being modified. Note that
+@math{@var{w}} and @math{@var{h}} include twice the border width.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glCopyTexSubImage2D}
+is executed between the execution of @code{glBegin} and the
+corresponding execution of @code{glEnd}.
+
+@end defun
+
+@defun glCopyTexSubImage3D
+@heading copy a three-dimensional texture subimage
+@heading Parameters
+@table @asis
+@item @var{target}
+Specifies the target texture. Must be @code{GL_TEXTURE_3D}
+
+@item @var{level}
+Specifies the level-of-detail number. Level 0 is the base image level.
+Level @var{n} is the @var{n}th mipmap reduction image.
+
+@item @var{xoffset}
+Specifies a texel offset in the x direction within the texture array.
+
+@item @var{yoffset}
+Specifies a texel offset in the y direction within the texture array.
+
+@item @var{zoffset}
+Specifies a texel offset in the z direction within the texture array.
+
+@item @var{x}
+@itemx @var{y}
+Specify the window coordinates of the lower left corner of the
+rectangular region of pixels to be copied.
+
+@item @var{width}
+Specifies the width of the texture subimage.
+
+@item @var{height}
+Specifies the height of the texture subimage.
+
+@end table
+
+@heading Description
+@code{glCopyTexSubImage3D} replaces a rectangular portion of a
+three-dimensional texture image with pixels from the current
+@code{GL_READ_BUFFER} (rather than from main memory, as is the case for
+@code{glTexSubImage3D}).
+
+The screen-aligned pixel rectangle with lower left corner at (@var{x},\
+@var{y}) and with width @var{width} and height @var{height} replaces the
+portion of the texture array with x indices @var{xoffset} through
+@math{@var{xoffset}+@var{width}-1}, inclusive, and y indices
+@var{yoffset} through @math{@var{yoffset}+@var{height}-1}, inclusive, at
+z index @var{zoffset} and at the mipmap level specified by @var{level}.
+
+The pixels in the rectangle are processed exactly as if
+@code{glCopyPixels} had been called, but the process stops just before
+final conversion. At this point, all pixel component values are clamped
+to the range @math{[0,1]} and then converted to the texture's internal
+format for storage in the texel array.
+
+The destination rectangle in the texture array may not include any
+texels outside the texture array as it was originally specified. It is
+not an error to specify a subtexture with zero width or height, but such
+a specification has no effect.
+
+If any of the pixels within the specified rectangle of the current
+@code{GL_READ_BUFFER} are outside the read window associated with the
+current rendering context, then the values obtained for those pixels are
+undefined.
+
+No change is made to the @var{internalformat}, @var{width},
+@var{height}, @var{depth}, or @var{border} parameters of the specified
+texture array or to texel values outside the specified subregion.
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if /@var{target} is not
+@code{GL_TEXTURE_3D}.
+
+@code{GL_INVALID_OPERATION} is generated if the texture array has not
+been defined by a previous @code{glTexImage3D} operation.
+
+@code{GL_INVALID_VALUE} is generated if @var{level} is less than 0.
+
+@code{GL_INVALID_VALUE} may be generated if
+@math{@var{level}>@var{log}_2(@var{max},)}, where @math{@var{max}} is
+the returned value of @code{GL_MAX_3D_TEXTURE_SIZE}.
+
+@code{GL_INVALID_VALUE} is generated if @math{@var{xoffset}<-@var{b}},
+@math{(@var{xoffset}+@var{width},)>(@var{w}-@var{b},)},
+@math{@var{yoffset}<-@var{b}},
+@math{(@var{yoffset}+@var{height},)>(@var{h}-@var{b},)},
+@math{@var{zoffset}<-@var{b}}, or
+@math{(@var{zoffset}+1,)>(@var{d}-@var{b},)}, where @math{@var{w}} is
+the @code{GL_TEXTURE_WIDTH}, @math{@var{h}} is the
+@code{GL_TEXTURE_HEIGHT}, @math{@var{d}} is the @code{GL_TEXTURE_DEPTH},
+and @math{@var{b}} is the @code{GL_TEXTURE_BORDER} of the texture image
+being modified. Note that @math{@var{w}}, @math{@var{h}}, and
+@math{@var{d}} include twice the border width.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glCopyTexSubImage3D}
+is executed between the execution of @code{glBegin} and the
+corresponding execution of @code{glEnd}.
+
+@end defun
+
+@defun glCreateProgram
+@heading Creates a program object
+@heading Description
+@code{glCreateProgram} creates an empty program object and returns a
+non-zero value by which it can be referenced. A program object is an
+object to which shader objects can be attached. This provides a
+mechanism to specify the shader objects that will be linked to create a
+program. It also provides a means for checking the compatibility of the
+shaders that will be used to create a program (for instance, checking
+the compatibility between a vertex shader and a fragment shader). When
+no longer needed as part of a program object, shader objects can be
+detached.
+
+One or more executables are created in a program object by successfully
+attaching shader objects to it with @code{glAttachShader}, successfully
+compiling the shader objects with @code{glCompileShader}, and
+successfully linking the program object with @code{glLinkProgram}. These
+executables are made part of current state when @code{glUseProgram} is
+called. Program objects can be deleted by calling
+@code{glDeleteProgram}. The memory associated with the program object
+will be deleted when it is no longer part of current rendering state for
+any context.
+
+@heading Errors
+This function returns 0 if an error occurs creating the program object.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glCreateProgram} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glCreateShader
+@heading Creates a shader object
+@heading Parameters
+@table @asis
+@item @var{shaderType}
+Specifies the type of shader to be created. Must be either
+@code{GL_VERTEX_SHADER} or @code{GL_FRAGMENT_SHADER}.
+
+@end table
+
+@heading Description
+@code{glCreateShader} creates an empty shader object and returns a
+non-zero value by which it can be referenced. A shader object is used to
+maintain the source code strings that define a shader. @var{shaderType}
+indicates the type of shader to be created. Two types of shaders are
+supported. A shader of type @code{GL_VERTEX_SHADER} is a shader that is
+intended to run on the programmable vertex processor and replace the
+fixed functionality vertex processing in OpenGL. A shader of type
+@code{GL_FRAGMENT_SHADER} is a shader that is intended to run on the
+programmable fragment processor and replace the fixed functionality
+fragment processing in OpenGL.
+
+When created, a shader object's @code{GL_SHADER_TYPE} parameter is set
+to either @code{GL_VERTEX_SHADER} or @code{GL_FRAGMENT_SHADER},
+depending on the value of @var{shaderType}.
+
+@heading Errors
+This function returns 0 if an error occurs creating the shader object.
+
+@code{GL_INVALID_ENUM} is generated if @var{shaderType} is not an
+accepted value.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glCreateShader} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glCullFace
+@heading specify whether front- or back-facing facets can be culled
+@heading Parameters
+@table @asis
+@item @var{mode}
+Specifies whether front- or back-facing facets are candidates for
+culling. Symbolic constants @code{GL_FRONT}, @code{GL_BACK}, and
+@code{GL_FRONT_AND_BACK} are accepted. The initial value is
+@code{GL_BACK}.
+
+@end table
+
+@heading Description
+@code{glCullFace} specifies whether front- or back-facing facets are
+culled (as specified by @var{mode}) when facet culling is enabled. Facet
+culling is initially disabled. To enable and disable facet culling, call
+the @code{glEnable} and @code{glDisable} commands with the argument
+@code{GL_CULL_FACE}. Facets include triangles, quadrilaterals, polygons,
+and rectangles.
+
+@code{glFrontFace} specifies which of the clockwise and counterclockwise
+facets are front-facing and back-facing. See @code{glFrontFace}.
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{mode} is not an accepted
+value.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glCullFace} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glDeleteBuffers
+@heading delete named buffer objects
+@heading Parameters
+@table @asis
+@item @var{n}
+Specifies the number of buffer objects to be deleted.
+
+@item @var{buffers}
+Specifies an array of buffer objects to be deleted.
+
+@end table
+
+@heading Description
+@code{glDeleteBuffers} deletes @var{n} buffer objects named by the
+elements of the array @var{buffers}. After a buffer object is deleted,
+it has no contents, and its name is free for reuse (for example by
+@code{glGenBuffers}). If a buffer object that is currently bound is
+deleted, the binding reverts to 0 (the absence of any buffer object,
+which reverts to client memory usage).
+
+@code{glDeleteBuffers} silently ignores 0's and names that do not
+correspond to existing buffer objects.
+
+@heading Errors
+@code{GL_INVALID_VALUE} is generated if @var{n} is negative.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glDeleteBuffers} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glDeleteLists
+@heading delete a contiguous group of display lists
+@heading Parameters
+@table @asis
+@item @var{list}
+Specifies the integer name of the first display list to delete.
+
+@item @var{range}
+Specifies the number of display lists to delete.
+
+@end table
+
+@heading Description
+@code{glDeleteLists} causes a contiguous group of display lists to be
+deleted. @var{list} is the name of the first display list to be deleted,
+and @var{range} is the number of display lists to delete. All display
+lists @math{@var{d}} with
+@math{@var{list}<=@var{d}<=@var{list}+@var{range}-1} are deleted.
+
+All storage locations allocated to the specified display lists are
+freed, and the names are available for reuse at a later time. Names
+within the range that do not have an associated display list are
+ignored. If @var{range} is 0, nothing happens.
+
+@heading Errors
+@code{GL_INVALID_VALUE} is generated if @var{range} is negative.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glDeleteLists} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glDeleteProgram
+@heading Deletes a program object
+@heading Parameters
+@table @asis
+@item @var{program}
+Specifies the program object to be deleted.
+
+@end table
+
+@heading Description
+@code{glDeleteProgram} frees the memory and invalidates the name
+associated with the program object specified by @var{program.} This
+command effectively undoes the effects of a call to
+@code{glCreateProgram}.
+
+If a program object is in use as part of current rendering state, it
+will be flagged for deletion, but it will not be deleted until it is no
+longer part of current state for any rendering context. If a program
+object to be deleted has shader objects attached to it, those shader
+objects will be automatically detached but not deleted unless they have
+already been flagged for deletion by a previous call to
+@code{glDeleteShader}. A value of 0 for @var{program} will be silently
+ignored.
+
+To determine whether a program object has been flagged for deletion,
+call @code{glGetProgram} with arguments @var{program} and
+@code{GL_DELETE_STATUS}.
+
+@heading Errors
+@code{GL_INVALID_VALUE} is generated if @var{program} is not a value
+generated by OpenGL.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glDeleteProgram} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glDeleteQueries
+@heading delete named query objects
+@heading Parameters
+@table @asis
+@item @var{n}
+Specifies the number of query objects to be deleted.
+
+@item @var{ids}
+Specifies an array of query objects to be deleted.
+
+@end table
+
+@heading Description
+@code{glDeleteQueries} deletes @var{n} query objects named by the
+elements of the array @var{ids}. After a query object is deleted, it has
+no contents, and its name is free for reuse (for example by
+@code{glGenQueries}).
+
+@code{glDeleteQueries} silently ignores 0's and names that do not
+correspond to existing query objects.
+
+@heading Errors
+@code{GL_INVALID_VALUE} is generated if @var{n} is negative.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glDeleteQueries} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glDeleteShader
+@heading Deletes a shader object
+@heading Parameters
+@table @asis
+@item @var{shader}
+Specifies the shader object to be deleted.
+
+@end table
+
+@heading Description
+@code{glDeleteShader} frees the memory and invalidates the name
+associated with the shader object specified by @var{shader}. This
+command effectively undoes the effects of a call to
+@code{glCreateShader}.
+
+If a shader object to be deleted is attached to a program object, it
+will be flagged for deletion, but it will not be deleted until it is no
+longer attached to any program object, for any rendering context (i.e.,
+it must be detached from wherever it was attached before it will be
+deleted). A value of 0 for @var{shader} will be silently ignored.
+
+To determine whether an object has been flagged for deletion, call
+@code{glGetShader} with arguments @var{shader} and
+@code{GL_DELETE_STATUS}.
+
+@heading Errors
+@code{GL_INVALID_VALUE} is generated if @var{shader} is not a value
+generated by OpenGL.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glDeleteShader} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glDeleteTextures
+@heading delete named textures
+@heading Parameters
+@table @asis
+@item @var{n}
+Specifies the number of textures to be deleted.
+
+@item @var{textures}
+Specifies an array of textures to be deleted.
+
+@end table
+
+@heading Description
+@code{glDeleteTextures} deletes @var{n} textures named by the elements
+of the array @var{textures}. After a texture is deleted, it has no
+contents or dimensionality, and its name is free for reuse (for example
+by @code{glGenTextures}). If a texture that is currently bound is
+deleted, the binding reverts to 0 (the default texture).
+
+@code{glDeleteTextures} silently ignores 0's and names that do not
+correspond to existing textures.
+
+@heading Errors
+@code{GL_INVALID_VALUE} is generated if @var{n} is negative.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glDeleteTextures} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glDepthFunc
+@heading specify the value used for depth buffer comparisons
+@heading Parameters
+@table @asis
+@item @var{func}
+Specifies the depth comparison function. Symbolic constants
+@code{GL_NEVER}, @code{GL_LESS}, @code{GL_EQUAL}, @code{GL_LEQUAL},
+@code{GL_GREATER}, @code{GL_NOTEQUAL}, @code{GL_GEQUAL}, and
+@code{GL_ALWAYS} are accepted. The initial value is @code{GL_LESS}.
+
+@end table
+
+@heading Description
+@code{glDepthFunc} specifies the function used to compare each incoming
+pixel depth value with the depth value present in the depth buffer. The
+comparison is performed only if depth testing is enabled. (See
+@code{glEnable} and @code{glDisable} of @code{GL_DEPTH_TEST}.)
+
+@var{func} specifies the conditions under which the pixel will be drawn.
+The comparison functions are as follows:
+
+@table @asis
+@item @code{GL_NEVER}
+Never passes.
+
+@item @code{GL_LESS}
+Passes if the incoming depth value is less than the stored depth value.
+
+@item @code{GL_EQUAL}
+Passes if the incoming depth value is equal to the stored depth value.
+
+@item @code{GL_LEQUAL}
+Passes if the incoming depth value is less than or equal to the stored
+depth value.
+
+@item @code{GL_GREATER}
+Passes if the incoming depth value is greater than the stored depth
+value.
+
+@item @code{GL_NOTEQUAL}
+Passes if the incoming depth value is not equal to the stored depth
+value.
+
+@item @code{GL_GEQUAL}
+Passes if the incoming depth value is greater than or equal to the
+stored depth value.
+
+@item @code{GL_ALWAYS}
+Always passes.
+
+@end table
+
+The initial value of @var{func} is @code{GL_LESS}. Initially, depth
+testing is disabled. If depth testing is disabled or if no depth buffer
+exists, it is as if the depth test always passes.
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{func} is not an accepted
+value.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glDepthFunc} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glDepthMask
+@heading enable or disable writing into the depth buffer
+@heading Parameters
+@table @asis
+@item @var{flag}
+Specifies whether the depth buffer is enabled for writing. If @var{flag}
+is @code{GL_FALSE}, depth buffer writing is disabled. Otherwise, it is
+enabled. Initially, depth buffer writing is enabled.
+
+@end table
+
+@heading Description
+@code{glDepthMask} specifies whether the depth buffer is enabled for
+writing. If @var{flag} is @code{GL_FALSE}, depth buffer writing is
+disabled. Otherwise, it is enabled. Initially, depth buffer writing is
+enabled.
+
+@heading Errors
+@code{GL_INVALID_OPERATION} is generated if @code{glDepthMask} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glDepthRange
+@heading specify mapping of depth values from normalized device coordinates to window coordinates
+@heading Parameters
+@table @asis
+@item @var{nearVal}
+Specifies the mapping of the near clipping plane to window coordinates.
+The initial value is 0.
+
+@item @var{farVal}
+Specifies the mapping of the far clipping plane to window coordinates.
+The initial value is 1.
+
+@end table
+
+@heading Description
+After clipping and division by @var{w}, depth coordinates range from
+@math{-1} to 1, corresponding to the near and far clipping planes.
+@code{glDepthRange} specifies a linear mapping of the normalized depth
+coordinates in this range to window depth coordinates. Regardless of the
+actual depth buffer implementation, window coordinate depth values are
+treated as though they range from 0 through 1 (like color components).
+Thus, the values accepted by @code{glDepthRange} are both clamped to
+this range before they are accepted.
+
+The setting of (0,1) maps the near plane to 0 and the far plane to 1.
+With this mapping, the depth buffer range is fully utilized.
+
+@heading Errors
+@code{GL_INVALID_OPERATION} is generated if @code{glDepthRange} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glDetachShader
+@heading Detaches a shader object from a program object to which it is attached
+@heading Parameters
+@table @asis
+@item @var{program}
+Specifies the program object from which to detach the shader object.
+
+@item @var{shader}
+Specifies the shader object to be detached.
+
+@end table
+
+@heading Description
+@code{glDetachShader} detaches the shader object specified by
+@var{shader} from the program object specified by @var{program}. This
+command can be used to undo the effect of the command
+@code{glAttachShader}.
+
+If @var{shader} has already been flagged for deletion by a call to
+@code{glDeleteShader} and it is not attached to any other program
+object, it will be deleted after it has been detached.
+
+@heading Errors
+@code{GL_INVALID_VALUE} is generated if either @var{program} or
+@var{shader} is a value that was not generated by OpenGL.
+
+@code{GL_INVALID_OPERATION} is generated if @var{program} is not a
+program object.
+
+@code{GL_INVALID_OPERATION} is generated if @var{shader} is not a shader
+object.
+
+@code{GL_INVALID_OPERATION} is generated if @var{shader} is not attached
+to @var{program}.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glDetachShader} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glDrawArrays
+@heading render primitives from array data
+@heading Parameters
+@table @asis
+@item @var{mode}
+Specifies what kind of primitives to render. Symbolic constants
+@code{GL_POINTS}, @code{GL_LINE_STRIP}, @code{GL_LINE_LOOP},
+@code{GL_LINES}, @code{GL_TRIANGLE_STRIP}, @code{GL_TRIANGLE_FAN},
+@code{GL_TRIANGLES}, @code{GL_QUAD_STRIP}, @code{GL_QUADS}, and
+@code{GL_POLYGON} are accepted.
+
+@item @var{first}
+Specifies the starting index in the enabled arrays.
+
+@item @var{count}
+Specifies the number of indices to be rendered.
+
+@end table
+
+@heading Description
+@code{glDrawArrays} specifies multiple geometric primitives with very
+few subroutine calls. Instead of calling a GL procedure to pass each
+individual vertex, normal, texture coordinate, edge flag, or color, you
+can prespecify separate arrays of vertices, normals, and colors and use
+them to construct a sequence of primitives with a single call to
+@code{glDrawArrays}.
+
+When @code{glDrawArrays} is called, it uses @var{count} sequential
+elements from each enabled array to construct a sequence of geometric
+primitives, beginning with element @var{first}. @var{mode} specifies
+what kind of primitives are constructed and how the array elements
+construct those primitives. If @code{GL_VERTEX_ARRAY} is not enabled, no
+geometric primitives are generated.
+
+Vertex attributes that are modified by @code{glDrawArrays} have an
+unspecified value after @code{glDrawArrays} returns. For example, if
+@code{GL_COLOR_ARRAY} is enabled, the value of the current color is
+undefined after @code{glDrawArrays} executes. Attributes that aren't
+modified remain well defined.
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{mode} is not an accepted
+value.
+
+@code{GL_INVALID_VALUE} is generated if @var{count} is negative.
+
+@code{GL_INVALID_OPERATION} is generated if a non-zero buffer object
+name is bound to an enabled array and the buffer object's data store is
+currently mapped.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glDrawArrays} is
+executed between the execution of @code{glBegin} and the corresponding
+@code{glEnd}.
+
+@end defun
+
+@defun glDrawBuffers
+@heading Specifies a list of color buffers to be drawn into
+@heading Parameters
+@table @asis
+@item @var{n}
+Specifies the number of buffers in @var{bufs}.
+
+@item @var{bufs}
+Points to an array of symbolic constants specifying the buffers into
+which fragment colors or data values will be written.
+
+@end table
+
+@heading Description
+@code{glDrawBuffers} defines an array of buffers into which fragment
+color values or fragment data will be written. If no fragment shader is
+active, rendering operations will generate only one fragment color per
+fragment and it will be written into each of the buffers specified by
+@var{bufs}. If a fragment shader is active and it writes a value to the
+output variable @code{gl_FragColor}, then that value will be written
+into each of the buffers specified by @var{bufs}. If a fragment shader
+is active and it writes a value to one or more elements of the output
+array variable @code{gl_FragData[]}, then the value of
+@code{gl_FragData[0] } will be written into the first buffer specified
+by @var{bufs}, the value of @code{gl_FragData[1] } will be written into
+the second buffer specified by @var{bufs}, and so on up to
+@code{gl_FragData[n-1]}. The draw buffer used for @code{gl_FragData[n]}
+and beyond is implicitly set to be @code{GL_NONE}.
+
+The symbolic constants contained in @var{bufs} may be any of the
+following:
+
+@table @asis
+@item @code{GL_NONE}
+The fragment color/data value is not written into any color buffer.
+
+@item @code{GL_FRONT_LEFT}
+The fragment color/data value is written into the front left color
+buffer.
+
+@item @code{GL_FRONT_RIGHT}
+The fragment color/data value is written into the front right color
+buffer.
+
+@item @code{GL_BACK_LEFT}
+The fragment color/data value is written into the back left color
+buffer.
+
+@item @code{GL_BACK_RIGHT}
+The fragment color/data value is written into the back right color
+buffer.
+
+@item @code{GL_AUXi}
+The fragment color/data value is written into auxiliary buffer @code{i}.
+
+@end table
+
+Except for @code{GL_NONE}, the preceding symbolic constants may not
+appear more than once in @var{bufs}. The maximum number of draw buffers
+supported is implementation dependent and can be queried by calling
+@code{glGet} with the argument @code{GL_MAX_DRAW_BUFFERS}. The number of
+auxiliary buffers can be queried by calling @code{glGet} with the
+argument @code{GL_AUX_BUFFERS}.
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if one of the values in @var{bufs}
+is not an accepted value.
+
+@code{GL_INVALID_ENUM} is generated if @var{n} is less than 0.
+
+@code{GL_INVALID_OPERATION} is generated if a symbolic constant other
+than @code{GL_NONE} appears more than once in @var{bufs}.
+
+@code{GL_INVALID_OPERATION} is generated if any of the entries in
+@var{bufs} (other than @code{GL_NONE} ) indicates a color buffer that
+does not exist in the current GL context.
+
+@code{GL_INVALID_VALUE} is generated if @var{n} is greater than
+@code{GL_MAX_DRAW_BUFFERS}.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glDrawBuffers} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glDrawBuffer
+@heading specify which color buffers are to be drawn into
+@heading Parameters
+@table @asis
+@item @var{mode}
+Specifies up to four color buffers to be drawn into. Symbolic constants
+@code{GL_NONE}, @code{GL_FRONT_LEFT}, @code{GL_FRONT_RIGHT},
+@code{GL_BACK_LEFT}, @code{GL_BACK_RIGHT}, @code{GL_FRONT},
+@code{GL_BACK}, @code{GL_LEFT}, @code{GL_RIGHT},
+@code{GL_FRONT_AND_BACK}, and @code{GL_AUX}@var{i}, where @var{i} is
+between 0 and the value of @code{GL_AUX_BUFFERS} minus 1, are accepted.
+(@code{GL_AUX_BUFFERS} is not the upper limit; use @code{glGet} to query
+the number of available aux buffers.) The initial value is
+@code{GL_FRONT} for single-buffered contexts, and @code{GL_BACK} for
+double-buffered contexts.
+
+@end table
+
+@heading Description
+When colors are written to the frame buffer, they are written into the
+color buffers specified by @code{glDrawBuffer}. The specifications are
+as follows:
+
+@table @asis
+@item @code{GL_NONE}
+No color buffers are written.
+
+@item @code{GL_FRONT_LEFT}
+Only the front left color buffer is written.
+
+@item @code{GL_FRONT_RIGHT}
+Only the front right color buffer is written.
+
+@item @code{GL_BACK_LEFT}
+Only the back left color buffer is written.
+
+@item @code{GL_BACK_RIGHT}
+Only the back right color buffer is written.
+
+@item @code{GL_FRONT}
+Only the front left and front right color buffers are written. If there
+is no front right color buffer, only the front left color buffer is
+written.
+
+@item @code{GL_BACK}
+Only the back left and back right color buffers are written. If there is
+no back right color buffer, only the back left color buffer is written.
+
+@item @code{GL_LEFT}
+Only the front left and back left color buffers are written. If there is
+no back left color buffer, only the front left color buffer is written.
+
+@item @code{GL_RIGHT}
+Only the front right and back right color buffers are written. If there
+is no back right color buffer, only the front right color buffer is
+written.
+
+@item @code{GL_FRONT_AND_BACK}
+All the front and back color buffers (front left, front right, back
+left, back right) are written. If there are no back color buffers, only
+the front left and front right color buffers are written. If there are
+no right color buffers, only the front left and back left color buffers
+are written. If there are no right or back color buffers, only the front
+left color buffer is written.
+
+@item @code{GL_AUX}@var{i}
+Only auxiliary color buffer @var{i} is written.
+
+@end table
+
+If more than one color buffer is selected for drawing, then blending or
+logical operations are computed and applied independently for each color
+buffer and can produce different results in each buffer.
+
+Monoscopic contexts include only @var{left} buffers, and stereoscopic
+contexts include both @var{left} and @var{right} buffers. Likewise,
+single-buffered contexts include only @var{front} buffers, and
+double-buffered contexts include both @var{front} and @var{back}
+buffers. The context is selected at GL initialization.
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{mode} is not an accepted
+value.
+
+@code{GL_INVALID_OPERATION} is generated if none of the buffers
+indicated by @var{mode} exists.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glDrawBuffer} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glDrawElements
+@heading render primitives from array data
+@heading Parameters
+@table @asis
+@item @var{mode}
+Specifies what kind of primitives to render. Symbolic constants
+@code{GL_POINTS}, @code{GL_LINE_STRIP}, @code{GL_LINE_LOOP},
+@code{GL_LINES}, @code{GL_TRIANGLE_STRIP}, @code{GL_TRIANGLE_FAN},
+@code{GL_TRIANGLES}, @code{GL_QUAD_STRIP}, @code{GL_QUADS}, and
+@code{GL_POLYGON} are accepted.
+
+@item @var{count}
+Specifies the number of elements to be rendered.
+
+@item @var{type}
+Specifies the type of the values in @var{indices}. Must be one of
+@code{GL_UNSIGNED_BYTE}, @code{GL_UNSIGNED_SHORT}, or
+@code{GL_UNSIGNED_INT}.
+
+@item @var{indices}
+Specifies a pointer to the location where the indices are stored.
+
+@end table
+
+@heading Description
+@code{glDrawElements} specifies multiple geometric primitives with very
+few subroutine calls. Instead of calling a GL function to pass each
+individual vertex, normal, texture coordinate, edge flag, or color, you
+can prespecify separate arrays of vertices, normals, and so on, and use
+them to construct a sequence of primitives with a single call to
+@code{glDrawElements}.
+
+When @code{glDrawElements} is called, it uses @var{count} sequential
+elements from an enabled array, starting at @var{indices} to construct a
+sequence of geometric primitives. @var{mode} specifies what kind of
+primitives are constructed and how the array elements construct these
+primitives. If more than one array is enabled, each is used. If
+@code{GL_VERTEX_ARRAY} is not enabled, no geometric primitives are
+constructed.
+
+Vertex attributes that are modified by @code{glDrawElements} have an
+unspecified value after @code{glDrawElements} returns. For example, if
+@code{GL_COLOR_ARRAY} is enabled, the value of the current color is
+undefined after @code{glDrawElements} executes. Attributes that aren't
+modified maintain their previous values.
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{mode} is not an accepted
+value.
+
+@code{GL_INVALID_VALUE} is generated if @var{count} is negative.
+
+@code{GL_INVALID_OPERATION} is generated if a non-zero buffer object
+name is bound to an enabled array or the element array and the buffer
+object's data store is currently mapped.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glDrawElements} is
+executed between the execution of @code{glBegin} and the corresponding
+@code{glEnd}.
+
+@end defun
+
+@defun glDrawPixels
+@heading write a block of pixels to the frame buffer
+@heading Parameters
+@table @asis
+@item @var{width}
+@itemx @var{height}
+Specify the dimensions of the pixel rectangle to be written into the
+frame buffer.
+
+@item @var{format}
+Specifies the format of the pixel data. Symbolic constants
+@code{GL_COLOR_INDEX}, @code{GL_STENCIL_INDEX},
+@code{GL_DEPTH_COMPONENT}, @code{GL_RGB}, @code{GL_BGR}, @code{GL_RGBA},
+@code{GL_BGRA}, @code{GL_RED}, @code{GL_GREEN}, @code{GL_BLUE},
+@code{GL_ALPHA}, @code{GL_LUMINANCE}, and @code{GL_LUMINANCE_ALPHA} are
+accepted.
+
+@item @var{type}
+Specifies the data type for @var{data}. Symbolic constants
+@code{GL_UNSIGNED_BYTE}, @code{GL_BYTE}, @code{GL_BITMAP},
+@code{GL_UNSIGNED_SHORT}, @code{GL_SHORT}, @code{GL_UNSIGNED_INT},
+@code{GL_INT}, @code{GL_FLOAT}, @code{GL_UNSIGNED_BYTE_3_3_2},
+@code{GL_UNSIGNED_BYTE_2_3_3_REV}, @code{GL_UNSIGNED_SHORT_5_6_5},
+@code{GL_UNSIGNED_SHORT_5_6_5_REV}, @code{GL_UNSIGNED_SHORT_4_4_4_4},
+@code{GL_UNSIGNED_SHORT_4_4_4_4_REV}, @code{GL_UNSIGNED_SHORT_5_5_5_1},
+@code{GL_UNSIGNED_SHORT_1_5_5_5_REV}, @code{GL_UNSIGNED_INT_8_8_8_8},
+@code{GL_UNSIGNED_INT_8_8_8_8_REV}, @code{GL_UNSIGNED_INT_10_10_10_2},
+and @code{GL_UNSIGNED_INT_2_10_10_10_REV} are accepted.
+
+@item @var{data}
+Specifies a pointer to the pixel data.
+
+@end table
+
+@heading Description
+@code{glDrawPixels} reads pixel data from memory and writes it into the
+frame buffer relative to the current raster position, provided that the
+raster position is valid. Use @code{glRasterPos} or @code{glWindowPos}
+to set the current raster position; use @code{glGet} with argument
+@code{GL_CURRENT_RASTER_POSITION_VALID} to determine if the specified
+raster position is valid, and @code{glGet} with argument
+@code{GL_CURRENT_RASTER_POSITION} to query the raster position.
+
+Several parameters define the encoding of pixel data in memory and
+control the processing of the pixel data before it is placed in the
+frame buffer. These parameters are set with four commands:
+@code{glPixelStore}, @code{glPixelTransfer}, @code{glPixelMap}, and
+@code{glPixelZoom}. This reference page describes the effects on
+@code{glDrawPixels} of many, but not all, of the parameters specified by
+these four commands.
+
+Data is read from @var{data} as a sequence of signed or unsigned bytes,
+signed or unsigned shorts, signed or unsigned integers, or
+single-precision floating-point values, depending on @var{type}. When
+@var{type} is one of @code{GL_UNSIGNED_BYTE}, @code{GL_BYTE},
+@code{GL_UNSIGNED_SHORT}, @code{GL_SHORT}, @code{GL_UNSIGNED_INT},
+@code{GL_INT}, or @code{GL_FLOAT} each of these bytes, shorts, integers,
+or floating-point values is interpreted as one color or depth component,
+or one index, depending on @var{format}. When @var{type} is one of
+@code{GL_UNSIGNED_BYTE_3_3_2}, @code{GL_UNSIGNED_SHORT_5_6_5},
+@code{GL_UNSIGNED_SHORT_4_4_4_4}, @code{GL_UNSIGNED_SHORT_5_5_5_1},
+@code{GL_UNSIGNED_INT_8_8_8_8}, or @code{GL_UNSIGNED_INT_10_10_10_2},
+each unsigned value is interpreted as containing all the components for
+a single pixel, with the color components arranged according to
+@var{format}. When @var{type} is one of
+@code{GL_UNSIGNED_BYTE_2_3_3_REV}, @code{GL_UNSIGNED_SHORT_5_6_5_REV},
+@code{GL_UNSIGNED_SHORT_4_4_4_4_REV},
+@code{GL_UNSIGNED_SHORT_1_5_5_5_REV},
+@code{GL_UNSIGNED_INT_8_8_8_8_REV}, or
+@code{GL_UNSIGNED_INT_2_10_10_10_REV}, each unsigned value is
+interpreted as containing all color components, specified by
+@var{format}, for a single pixel in a reversed order. Indices are always
+treated individually. Color components are treated as groups of one,
+two, three, or four values, again based on @var{format}. Both individual
+indices and groups of components are referred to as pixels. If
+@var{type} is @code{GL_BITMAP}, the data must be unsigned bytes, and
+@var{format} must be either @code{GL_COLOR_INDEX} or
+@code{GL_STENCIL_INDEX}. Each unsigned byte is treated as eight 1-bit
+pixels, with bit ordering determined by @code{GL_UNPACK_LSB_FIRST} (see
+@code{glPixelStore}).
+
+@math{@var{width}×@var{height}} pixels are read from memory, starting at
+location @var{data}. By default, these pixels are taken from adjacent
+memory locations, except that after all @var{width} pixels are read, the
+read pointer is advanced to the next four-byte boundary. The four-byte
+row alignment is specified by @code{glPixelStore} with argument
+@code{GL_UNPACK_ALIGNMENT}, and it can be set to one, two, four, or
+eight bytes. Other pixel store parameters specify different read pointer
+advancements, both before the first pixel is read and after all
+@var{width} pixels are read. See the @code{glPixelStore} reference page
+for details on these options.
+
+If a non-zero named buffer object is bound to the
+@code{GL_PIXEL_UNPACK_BUFFER} target (see @code{glBindBuffer}) while a
+block of pixels is specified, @var{data} is treated as a byte offset
+into the buffer object's data store.
+
+The @math{@var{width}×@var{height}} pixels that are read from memory are
+each operated on in the same way, based on the values of several
+parameters specified by @code{glPixelTransfer} and @code{glPixelMap}.
+The details of these operations, as well as the target buffer into which
+the pixels are drawn, are specific to the format of the pixels, as
+specified by @var{format}. @var{format} can assume one of 13 symbolic
+values:
+
+@table @asis
+@item @code{GL_COLOR_INDEX}
+Each pixel is a single value, a color index. It is converted to
+fixed-point format, with an unspecified number of bits to the right of
+the binary point, regardless of the memory data type. Floating-point
+values convert to true fixed-point values. Signed and unsigned integer
+data is converted with all fraction bits set to 0. Bitmap data convert
+to either 0 or 1.
+
+Each fixed-point index is then shifted left by @code{GL_INDEX_SHIFT}
+bits and added to @code{GL_INDEX_OFFSET}. If @code{GL_INDEX_SHIFT} is
+negative, the shift is to the right. In either case, zero bits fill
+otherwise unspecified bit locations in the result.
+
+If the GL is in RGBA mode, the resulting index is converted to an RGBA
+pixel with the help of the @code{GL_PIXEL_MAP_I_TO_R},
+@code{GL_PIXEL_MAP_I_TO_G}, @code{GL_PIXEL_MAP_I_TO_B}, and
+@code{GL_PIXEL_MAP_I_TO_A} tables. If the GL is in color index mode, and
+if @code{GL_MAP_COLOR} is true, the index is replaced with the value
+that it references in lookup table @code{GL_PIXEL_MAP_I_TO_I}. Whether
+the lookup replacement of the index is done or not, the integer part of
+the index is then ANDed with @math{2^@var{b}-1}, where @math{@var{b}} is
+the number of bits in a color index buffer.
+
+The GL then converts the resulting indices or RGBA colors to fragments
+by attaching the current raster position @var{z} coordinate and texture
+coordinates to each pixel, then assigning @math{@var{x}} and
+@math{@var{y}} window coordinates to the @math{@var{n}}th fragment such
+that
+@math{@var{x}_@var{n}=@var{x}_@var{r}+@var{n}%@var{width}}@math{@var{y}_@var{n}=@var{y}_@var{r}+⌊@var{n}/@var{width},⌋}
+
+where @math{(@var{x}_@var{r},@var{y}_@var{r})} is the current raster
+position. These pixel fragments are then treated just like the fragments
+generated by rasterizing points, lines, or polygons. Texture mapping,
+fog, and all the fragment operations are applied before the fragments
+are written to the frame buffer.
+
+@item @code{GL_STENCIL_INDEX}
+Each pixel is a single value, a stencil index. It is converted to
+fixed-point format, with an unspecified number of bits to the right of
+the binary point, regardless of the memory data type. Floating-point
+values convert to true fixed-point values. Signed and unsigned integer
+data is converted with all fraction bits set to 0. Bitmap data convert
+to either 0 or 1.
+
+Each fixed-point index is then shifted left by @code{GL_INDEX_SHIFT}
+bits, and added to @code{GL_INDEX_OFFSET}. If @code{GL_INDEX_SHIFT} is
+negative, the shift is to the right. In either case, zero bits fill
+otherwise unspecified bit locations in the result. If
+@code{GL_MAP_STENCIL} is true, the index is replaced with the value that
+it references in lookup table @code{GL_PIXEL_MAP_S_TO_S}. Whether the
+lookup replacement of the index is done or not, the integer part of the
+index is then ANDed with @math{2^@var{b}-1}, where @math{@var{b}} is the
+number of bits in the stencil buffer. The resulting stencil indices are
+then written to the stencil buffer such that the @math{@var{n}}th index
+is written to location
+
+@math{@var{x}_@var{n}=@var{x}_@var{r}+@var{n}%@var{width}}@math{@var{y}_@var{n}=@var{y}_@var{r}+⌊@var{n}/@var{width},⌋}
+
+where @math{(@var{x}_@var{r},@var{y}_@var{r})} is the current raster
+position. Only the pixel ownership test, the scissor test, and the
+stencil writemask affect these write operations.
+
+@item @code{GL_DEPTH_COMPONENT}
+Each pixel is a single-depth component. Floating-point data is converted
+directly to an internal floating-point format with unspecified
+precision. Signed integer data is mapped linearly to the internal
+floating-point format such that the most positive representable integer
+value maps to 1.0, and the most negative representable value maps to
+@math{-1.0}. Unsigned integer data is mapped similarly: the largest
+integer value maps to 1.0, and 0 maps to 0.0. The resulting
+floating-point depth value is then multiplied by @code{GL_DEPTH_SCALE}
+and added to @code{GL_DEPTH_BIAS}. The result is clamped to the range
+@math{[0,1]}.
+
+The GL then converts the resulting depth components to fragments by
+attaching the current raster position color or color index and texture
+coordinates to each pixel, then assigning @math{@var{x}} and
+@math{@var{y}} window coordinates to the @math{@var{n}}th fragment such
+that
+
+@math{@var{x}_@var{n}=@var{x}_@var{r}+@var{n}%@var{width}}@math{@var{y}_@var{n}=@var{y}_@var{r}+⌊@var{n}/@var{width},⌋}
+
+where @math{(@var{x}_@var{r},@var{y}_@var{r})} is the current raster
+position. These pixel fragments are then treated just like the fragments
+generated by rasterizing points, lines, or polygons. Texture mapping,
+fog, and all the fragment operations are applied before the fragments
+are written to the frame buffer.
+
+@item @code{GL_RGBA}
+@item @code{GL_BGRA}
+Each pixel is a four-component group: For @code{GL_RGBA}, the red
+component is first, followed by green, followed by blue, followed by
+alpha; for @code{GL_BGRA} the order is blue, green, red and then alpha.
+Floating-point values are converted directly to an internal
+floating-point format with unspecified precision. Signed integer values
+are mapped linearly to the internal floating-point format such that the
+most positive representable integer value maps to 1.0, and the most
+negative representable value maps to @math{-1.0}. (Note that this
+mapping does not convert 0 precisely to 0.0.) Unsigned integer data is
+mapped similarly: The largest integer value maps to 1.0, and 0 maps to
+0.0. The resulting floating-point color values are then multiplied by
+@code{GL_c_SCALE} and added to @code{GL_c_BIAS}, where @var{c} is RED,
+GREEN, BLUE, and ALPHA for the respective color components. The results
+are clamped to the range @math{[0,1]}.
+
+If @code{GL_MAP_COLOR} is true, each color component is scaled by the
+size of lookup table @code{GL_PIXEL_MAP_c_TO_c}, then replaced by the
+value that it references in that table. @var{c} is R, G, B, or A
+respectively.
+
+The GL then converts the resulting RGBA colors to fragments by attaching
+the current raster position @var{z} coordinate and texture coordinates
+to each pixel, then assigning @math{@var{x}} and @math{@var{y}} window
+coordinates to the @math{@var{n}}th fragment such that
+
+@math{@var{x}_@var{n}=@var{x}_@var{r}+@var{n}%@var{width}}@math{@var{y}_@var{n}=@var{y}_@var{r}+⌊@var{n}/@var{width},⌋}
+
+where @math{(@var{x}_@var{r},@var{y}_@var{r})} is the current raster
+position. These pixel fragments are then treated just like the fragments
+generated by rasterizing points, lines, or polygons. Texture mapping,
+fog, and all the fragment operations are applied before the fragments
+are written to the frame buffer.
+
+@item @code{GL_RED}
+Each pixel is a single red component. This component is converted to the
+internal floating-point format in the same way the red component of an
+RGBA pixel is. It is then converted to an RGBA pixel with green and blue
+set to 0, and alpha set to 1. After this conversion, the pixel is
+treated as if it had been read as an RGBA pixel.
+
+@item @code{GL_GREEN}
+Each pixel is a single green component. This component is converted to
+the internal floating-point format in the same way the green component
+of an RGBA pixel is. It is then converted to an RGBA pixel with red and
+blue set to 0, and alpha set to 1. After this conversion, the pixel is
+treated as if it had been read as an RGBA pixel.
+
+@item @code{GL_BLUE}
+Each pixel is a single blue component. This component is converted to
+the internal floating-point format in the same way the blue component of
+an RGBA pixel is. It is then converted to an RGBA pixel with red and
+green set to 0, and alpha set to 1. After this conversion, the pixel is
+treated as if it had been read as an RGBA pixel.
+
+@item @code{GL_ALPHA}
+Each pixel is a single alpha component. This component is converted to
+the internal floating-point format in the same way the alpha component
+of an RGBA pixel is. It is then converted to an RGBA pixel with red,
+green, and blue set to 0. After this conversion, the pixel is treated as
+if it had been read as an RGBA pixel.
+
+@item @code{GL_RGB}
+@item @code{GL_BGR}
+Each pixel is a three-component group: red first, followed by green,
+followed by blue; for @code{GL_BGR}, the first component is blue,
+followed by green and then red. Each component is converted to the
+internal floating-point format in the same way the red, green, and blue
+components of an RGBA pixel are. The color triple is converted to an
+RGBA pixel with alpha set to 1. After this conversion, the pixel is
+treated as if it had been read as an RGBA pixel.
+
+@item @code{GL_LUMINANCE}
+Each pixel is a single luminance component. This component is converted
+to the internal floating-point format in the same way the red component
+of an RGBA pixel is. It is then converted to an RGBA pixel with red,
+green, and blue set to the converted luminance value, and alpha set to
+1. After this conversion, the pixel is treated as if it had been read as
+an RGBA pixel.
+
+@item @code{GL_LUMINANCE_ALPHA}
+Each pixel is a two-component group: luminance first, followed by alpha.
+The two components are converted to the internal floating-point format
+in the same way the red component of an RGBA pixel is. They are then
+converted to an RGBA pixel with red, green, and blue set to the
+converted luminance value, and alpha set to the converted alpha value.
+After this conversion, the pixel is treated as if it had been read as an
+RGBA pixel.
+
+@end table
+
+The following table summarizes the meaning of the valid constants for
+the @var{type} parameter:
+
+
+
+@table @asis
+@item @strong{Type}
+@strong{Corresponding Type}
+
+@item @code{GL_UNSIGNED_BYTE}
+unsigned 8-bit integer
+
+@item @code{GL_BYTE}
+signed 8-bit integer
+
+@item @code{GL_BITMAP}
+single bits in unsigned 8-bit integers
+
+@item @code{GL_UNSIGNED_SHORT}
+unsigned 16-bit integer
+
+@item @code{GL_SHORT}
+signed 16-bit integer
+
+@item @code{GL_UNSIGNED_INT}
+unsigned 32-bit integer
+
+@item @code{GL_INT}
+32-bit integer
+
+@item @code{GL_FLOAT}
+single-precision floating-point
+
+@item @code{GL_UNSIGNED_BYTE_3_3_2}
+unsigned 8-bit integer
+
+@item @code{GL_UNSIGNED_BYTE_2_3_3_REV}
+unsigned 8-bit integer with reversed component ordering
+
+@item @code{GL_UNSIGNED_SHORT_5_6_5}
+unsigned 16-bit integer
+
+@item @code{GL_UNSIGNED_SHORT_5_6_5_REV}
+unsigned 16-bit integer with reversed component ordering
+
+@item @code{GL_UNSIGNED_SHORT_4_4_4_4}
+unsigned 16-bit integer
+
+@item @code{GL_UNSIGNED_SHORT_4_4_4_4_REV}
+unsigned 16-bit integer with reversed component ordering
+
+@item @code{GL_UNSIGNED_SHORT_5_5_5_1}
+unsigned 16-bit integer
+
+@item @code{GL_UNSIGNED_SHORT_1_5_5_5_REV}
+unsigned 16-bit integer with reversed component ordering
+
+@item @code{GL_UNSIGNED_INT_8_8_8_8}
+unsigned 32-bit integer
+
+@item @code{GL_UNSIGNED_INT_8_8_8_8_REV}
+unsigned 32-bit integer with reversed component ordering
+
+@item @code{GL_UNSIGNED_INT_10_10_10_2}
+unsigned 32-bit integer
+
+@item @code{GL_UNSIGNED_INT_2_10_10_10_REV}
+unsigned 32-bit integer with reversed component ordering
+
+@end table
+
+
+
+The rasterization described so far assumes pixel zoom factors of 1. If
+@code{glPixelZoom} is used to change the @math{@var{x}} and
+@math{@var{y}} pixel zoom factors, pixels are converted to fragments as
+follows. If @math{(@var{x}_@var{r},@var{y}_@var{r})} is the current
+raster position, and a given pixel is in the @math{@var{n}}th column and
+@math{@var{m}}th row of the pixel rectangle, then fragments are
+generated for pixels whose centers are in the rectangle with corners at
+
+@math{(@var{x}_@var{r}+@var{zoom}_@var{x},@var{n},@var{y}_@var{r}+@var{zoom}_@var{y},@var{m})}@math{(@var{x}_@var{r}+@var{zoom}_@var{x},(@var{n}+1,),@var{y}_@var{r}+@var{zoom}_@var{y},(@var{m}+1,))}
+
+where @math{@var{zoom}_@var{x}} is the value of @code{GL_ZOOM_X} and
+@math{@var{zoom}_@var{y}} is the value of @code{GL_ZOOM_Y}.
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{format} or @var{type} is not
+one of the accepted values.
+
+@code{GL_INVALID_ENUM} is generated if @var{type} is @code{GL_BITMAP}
+and @var{format} is not either @code{GL_COLOR_INDEX} or
+@code{GL_STENCIL_INDEX}.
+
+@code{GL_INVALID_VALUE} is generated if either @var{width} or
+@var{height} is negative.
+
+@code{GL_INVALID_OPERATION} is generated if @var{format} is
+@code{GL_STENCIL_INDEX} and there is no stencil buffer.
+
+@code{GL_INVALID_OPERATION} is generated if @var{format} is
+@code{GL_RED}, @code{GL_GREEN}, @code{GL_BLUE}, @code{GL_ALPHA},
+@code{GL_RGB}, @code{GL_RGBA}, @code{GL_BGR}, @code{GL_BGRA},
+@code{GL_LUMINANCE}, or @code{GL_LUMINANCE_ALPHA}, and the GL is in
+color index mode.
+
+@code{GL_INVALID_OPERATION} is generated if @var{format} is one of
+@code{GL_UNSIGNED_BYTE_3_3_2}, @code{GL_UNSIGNED_BYTE_2_3_3_REV},
+@code{GL_UNSIGNED_SHORT_5_6_5}, or @code{GL_UNSIGNED_SHORT_5_6_5_REV}
+and @var{format} is not @code{GL_RGB}.
+
+@code{GL_INVALID_OPERATION} is generated if @var{format} is one of
+@code{GL_UNSIGNED_SHORT_4_4_4_4}, @code{GL_UNSIGNED_SHORT_4_4_4_4_REV},
+@code{GL_UNSIGNED_SHORT_5_5_5_1}, @code{GL_UNSIGNED_SHORT_1_5_5_5_REV},
+@code{GL_UNSIGNED_INT_8_8_8_8}, @code{GL_UNSIGNED_INT_8_8_8_8_REV},
+@code{GL_UNSIGNED_INT_10_10_10_2}, or
+@code{GL_UNSIGNED_INT_2_10_10_10_REV} and @var{format} is neither
+@code{GL_RGBA} nor @code{GL_BGRA}.
+
+@code{GL_INVALID_OPERATION} is generated if a non-zero buffer object
+name is bound to the @code{GL_PIXEL_UNPACK_BUFFER} target and the buffer
+object's data store is currently mapped.
+
+@code{GL_INVALID_OPERATION} is generated if a non-zero buffer object
+name is bound to the @code{GL_PIXEL_UNPACK_BUFFER} target and the data
+would be unpacked from the buffer object such that the memory reads
+required would exceed the data store size.
+
+@code{GL_INVALID_OPERATION} is generated if a non-zero buffer object
+name is bound to the @code{GL_PIXEL_UNPACK_BUFFER} target and @var{data}
+is not evenly divisible into the number of bytes needed to store in
+memory a datum indicated by @var{type}.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glDrawPixels} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glDrawRangeElements
+@heading render primitives from array data
+@heading Parameters
+@table @asis
+@item @var{mode}
+Specifies what kind of primitives to render. Symbolic constants
+@code{GL_POINTS}, @code{GL_LINE_STRIP}, @code{GL_LINE_LOOP},
+@code{GL_LINES}, @code{GL_TRIANGLE_STRIP}, @code{GL_TRIANGLE_FAN},
+@code{GL_TRIANGLES}, @code{GL_QUAD_STRIP}, @code{GL_QUADS}, and
+@code{GL_POLYGON} are accepted.
+
+@item @var{start}
+Specifies the minimum array index contained in @var{indices}.
+
+@item @var{end}
+Specifies the maximum array index contained in @var{indices}.
+
+@item @var{count}
+Specifies the number of elements to be rendered.
+
+@item @var{type}
+Specifies the type of the values in @var{indices}. Must be one of
+@code{GL_UNSIGNED_BYTE}, @code{GL_UNSIGNED_SHORT}, or
+@code{GL_UNSIGNED_INT}.
+
+@item @var{indices}
+Specifies a pointer to the location where the indices are stored.
+
+@end table
+
+@heading Description
+@code{glDrawRangeElements} is a restricted form of
+@code{glDrawElements}. @var{mode}, @var{start}, @var{end}, and
+@var{count} match the corresponding arguments to @code{glDrawElements},
+with the additional constraint that all values in the arrays @var{count}
+must lie between @var{start} and @var{end}, inclusive.
+
+Implementations denote recommended maximum amounts of vertex and index
+data, which may be queried by calling @code{glGet} with argument
+@code{GL_MAX_ELEMENTS_VERTICES} and @code{GL_MAX_ELEMENTS_INDICES}. If
+@math{@var{end}-@var{start}+1} is greater than the value of
+@code{GL_MAX_ELEMENTS_VERTICES}, or if @var{count} is greater than the
+value of @code{GL_MAX_ELEMENTS_INDICES}, then the call may operate at
+reduced performance. There is no requirement that all vertices in the
+range @math{[@var{start},@var{end}]} be referenced. However, the
+implementation may partially process unused vertices, reducing
+performance from what could be achieved with an optimal index set.
+
+When @code{glDrawRangeElements} is called, it uses @var{count}
+sequential elements from an enabled array, starting at @var{start} to
+construct a sequence of geometric primitives. @var{mode} specifies what
+kind of primitives are constructed, and how the array elements construct
+these primitives. If more than one array is enabled, each is used. If
+@code{GL_VERTEX_ARRAY} is not enabled, no geometric primitives are
+constructed.
+
+Vertex attributes that are modified by @code{glDrawRangeElements} have
+an unspecified value after @code{glDrawRangeElements} returns. For
+example, if @code{GL_COLOR_ARRAY} is enabled, the value of the current
+color is undefined after @code{glDrawRangeElements} executes. Attributes
+that aren't modified maintain their previous values.
+
+@heading Errors
+It is an error for indices to lie outside the range
+@math{[@var{start},@var{end}]}, but implementations may not check for
+this situation. Such indices cause implementation-dependent behavior.
+
+@code{GL_INVALID_ENUM} is generated if @var{mode} is not an accepted
+value.
+
+@code{GL_INVALID_VALUE} is generated if @var{count} is negative.
+
+@code{GL_INVALID_VALUE} is generated if @math{@var{end}<@var{start}}.
+
+@code{GL_INVALID_OPERATION} is generated if a non-zero buffer object
+name is bound to an enabled array or the element array and the buffer
+object's data store is currently mapped.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glDrawRangeElements}
+is executed between the execution of @code{glBegin} and the
+corresponding @code{glEnd}.
+
+@end defun
+
+@defun glEdgeFlagPointer
+@heading define an array of edge flags
+@heading Parameters
+@table @asis
+@item @var{stride}
+Specifies the byte offset between consecutive edge flags. If
+@var{stride} is 0, the edge flags are understood to be tightly packed in
+the array. The initial value is 0.
+
+@item @var{pointer}
+Specifies a pointer to the first edge flag in the array. The initial
+value is 0.
+
+@end table
+
+@heading Description
+@code{glEdgeFlagPointer} specifies the location and data format of an
+array of boolean edge flags to use when rendering. @var{stride}
+specifies the byte stride from one edge flag to the next, allowing
+vertices and attributes to be packed into a single array or stored in
+separate arrays.
+
+If a non-zero named buffer object is bound to the @code{GL_ARRAY_BUFFER}
+target (see @code{glBindBuffer}) while an edge flag array is specified,
+@var{pointer} is treated as a byte offset into the buffer object's data
+store. Also, the buffer object binding (@code{GL_ARRAY_BUFFER_BINDING})
+is saved as edge flag vertex array client-side state
+(@code{GL_EDGE_FLAG_ARRAY_BUFFER_BINDING}).
+
+When an edge flag array is specified, @var{stride} and @var{pointer} are
+saved as client-side state, in addition to the current vertex array
+buffer object binding.
+
+To enable and disable the edge flag array, call
+@code{glEnableClientState} and @code{glDisableClientState} with the
+argument @code{GL_EDGE_FLAG_ARRAY}. If enabled, the edge flag array is
+used when @code{glDrawArrays}, @code{glMultiDrawArrays},
+@code{glDrawElements}, @code{glMultiDrawElements},
+@code{glDrawRangeElements}, or @code{glArrayElement} is called.
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{stride} is negative.
+
+@end defun
+
+@defun glEdgeFlag
+@heading flag edges as either boundary or nonboundary
+@heading Parameters
+@table @asis
+@item @var{flag}
+Specifies the current edge flag value, either @code{GL_TRUE} or
+@code{GL_FALSE}. The initial value is @code{GL_TRUE}.
+
+@end table
+
+@heading Description
+Each vertex of a polygon, separate triangle, or separate quadrilateral
+specified between a @code{glBegin}/@code{glEnd} pair is marked as the
+start of either a boundary or nonboundary edge. If the current edge flag
+is true when the vertex is specified, the vertex is marked as the start
+of a boundary edge. Otherwise, the vertex is marked as the start of a
+nonboundary edge. @code{glEdgeFlag} sets the edge flag bit to
+@code{GL_TRUE} if @var{flag} is @code{GL_TRUE} and to @code{GL_FALSE}
+otherwise.
+
+The vertices of connected triangles and connected quadrilaterals are
+always marked as boundary, regardless of the value of the edge flag.
+
+Boundary and nonboundary edge flags on vertices are significant only if
+@code{GL_POLYGON_MODE} is set to @code{GL_POINT} or @code{GL_LINE}. See
+@code{glPolygonMode}.
+
+@end defun
+
+@defun glEnableClientState
+@heading enable or disable client-side capability
+@heading Parameters
+@table @asis
+@item @var{cap}
+Specifies the capability to enable. Symbolic constants
+@code{GL_COLOR_ARRAY}, @code{GL_EDGE_FLAG_ARRAY},
+@code{GL_FOG_COORD_ARRAY}, @code{GL_INDEX_ARRAY},
+@code{GL_NORMAL_ARRAY}, @code{GL_SECONDARY_COLOR_ARRAY},
+@code{GL_TEXTURE_COORD_ARRAY}, and @code{GL_VERTEX_ARRAY} are accepted.
+
+@end table
+
+@heading Description
+@code{glEnableClientState} and @code{glDisableClientState} enable or
+disable individual client-side capabilities. By default, all client-side
+capabilities are disabled. Both @code{glEnableClientState} and
+@code{glDisableClientState} take a single argument, @var{cap}, which can
+assume one of the following values:
+
+@table @asis
+@item @code{GL_COLOR_ARRAY}
+If enabled, the color array is enabled for writing and used during
+rendering when @code{glArrayElement}, @code{glDrawArrays},
+@code{glDrawElements},
+@code{glDrawRangeElements}@code{glMultiDrawArrays}, or
+@code{glMultiDrawElements} is called. See @code{glColorPointer}.
+
+@item @code{GL_EDGE_FLAG_ARRAY}
+If enabled, the edge flag array is enabled for writing and used during
+rendering when @code{glArrayElement}, @code{glDrawArrays},
+@code{glDrawElements},
+@code{glDrawRangeElements}@code{glMultiDrawArrays}, or
+@code{glMultiDrawElements} is called. See @code{glEdgeFlagPointer}.
+
+@item @code{GL_FOG_COORD_ARRAY}
+If enabled, the fog coordinate array is enabled for writing and used
+during rendering when @code{glArrayElement}, @code{glDrawArrays},
+@code{glDrawElements},
+@code{glDrawRangeElements}@code{glMultiDrawArrays}, or
+@code{glMultiDrawElements} is called. See @code{glFogCoordPointer}.
+
+@item @code{GL_INDEX_ARRAY}
+If enabled, the index array is enabled for writing and used during
+rendering when @code{glArrayElement}, @code{glDrawArrays},
+@code{glDrawElements},
+@code{glDrawRangeElements}@code{glMultiDrawArrays}, or
+@code{glMultiDrawElements} is called. See @code{glIndexPointer}.
+
+@item @code{GL_NORMAL_ARRAY}
+If enabled, the normal array is enabled for writing and used during
+rendering when @code{glArrayElement}, @code{glDrawArrays},
+@code{glDrawElements},
+@code{glDrawRangeElements}@code{glMultiDrawArrays}, or
+@code{glMultiDrawElements} is called. See @code{glNormalPointer}.
+
+@item @code{GL_SECONDARY_COLOR_ARRAY}
+If enabled, the secondary color array is enabled for writing and used
+during rendering when @code{glArrayElement}, @code{glDrawArrays},
+@code{glDrawElements},
+@code{glDrawRangeElements}@code{glMultiDrawArrays}, or
+@code{glMultiDrawElements} is called. See @code{glColorPointer}.
+
+@item @code{GL_TEXTURE_COORD_ARRAY}
+If enabled, the texture coordinate array is enabled for writing and used
+during rendering when @code{glArrayElement}, @code{glDrawArrays},
+@code{glDrawElements},
+@code{glDrawRangeElements}@code{glMultiDrawArrays}, or
+@code{glMultiDrawElements} is called. See @code{glTexCoordPointer}.
+
+@item @code{GL_VERTEX_ARRAY}
+If enabled, the vertex array is enabled for writing and used during
+rendering when @code{glArrayElement}, @code{glDrawArrays},
+@code{glDrawElements},
+@code{glDrawRangeElements}@code{glMultiDrawArrays}, or
+@code{glMultiDrawElements} is called. See @code{glVertexPointer}.
+
+@end table
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{cap} is not an accepted
+value.
+
+@code{glEnableClientState} is not allowed between the execution of
+@code{glBegin} and the corresponding @code{glEnd}, but an error may or
+may not be generated. If no error is generated, the behavior is
+undefined.
+
+@end defun
+
+@defun glEnableVertexAttribArray
+@heading Enable or disable a generic vertex attribute array
+@heading Parameters
+@table @asis
+@item @var{index}
+Specifies the index of the generic vertex attribute to be enabled or
+disabled.
+
+@end table
+
+@heading Description
+@code{glEnableVertexAttribArray} enables the generic vertex attribute
+array specified by @var{index}. @code{glDisableVertexAttribArray}
+disables the generic vertex attribute array specified by @var{index}. By
+default, all client-side capabilities are disabled, including all
+generic vertex attribute arrays. If enabled, the values in the generic
+vertex attribute array will be accessed and used for rendering when
+calls are made to vertex array commands such as @code{glDrawArrays},
+@code{glDrawElements}, @code{glDrawRangeElements},
+@code{glArrayElement}, @code{glMultiDrawElements}, or
+@code{glMultiDrawArrays}.
+
+@heading Errors
+@code{GL_INVALID_VALUE} is generated if @var{index} is greater than or
+equal to @code{GL_MAX_VERTEX_ATTRIBS}.
+
+@code{GL_INVALID_OPERATION} is generated if either
+@code{glEnableVertexAttribArray } or @code{glDisableVertexAttribArray }
+is executed between the execution of @code{glBegin} and the
+corresponding execution of @code{glEnd}.
+
+@end defun
+
+@defun glEnable
+@heading enable or disable server-side GL capabilities
+@heading Parameters
+@table @asis
+@item @var{cap}
+Specifies a symbolic constant indicating a GL capability.
+
+@end table
+
+@heading Description
+@code{glEnable} and @code{glDisable} enable and disable various
+capabilities. Use @code{glIsEnabled} or @code{glGet} to determine the
+current setting of any capability. The initial value for each capability
+with the exception of @code{GL_DITHER} and @code{GL_MULTISAMPLE} is
+@code{GL_FALSE}. The initial value for @code{GL_DITHER} and
+@code{GL_MULTISAMPLE} is @code{GL_TRUE}.
+
+Both @code{glEnable} and @code{glDisable} take a single argument,
+@var{cap}, which can assume one of the following values:
+
+@table @asis
+@item @code{GL_ALPHA_TEST}
+
+
+If enabled, do alpha testing. See @code{glAlphaFunc}.
+
+@item @code{GL_AUTO_NORMAL}
+
+
+If enabled, generate normal vectors when either @code{GL_MAP2_VERTEX_3}
+or @code{GL_MAP2_VERTEX_4} is used to generate vertices. See
+@code{glMap2}.
+
+@item @code{GL_BLEND}
+
+
+If enabled, blend the computed fragment color values with the values in
+the color buffers. See @code{glBlendFunc}.
+
+@item @code{GL_CLIP_PLANE}@var{i}
+
+
+If enabled, clip geometry against user-defined clipping plane @var{i}.
+See @code{glClipPlane}.
+
+@item @code{GL_COLOR_LOGIC_OP}
+
+
+If enabled, apply the currently selected logical operation to the
+computed fragment color and color buffer values. See @code{glLogicOp}.
+
+@item @code{GL_COLOR_MATERIAL}
+
+
+If enabled, have one or more material parameters track the current
+color. See @code{glColorMaterial}.
+
+@item @code{GL_COLOR_SUM}
+
+
+If enabled and no fragment shader is active, add the secondary color
+value to the computed fragment color. See @code{glSecondaryColor}.
+
+@item @code{GL_COLOR_TABLE}
+
+
+If enabled, perform a color table lookup on the incoming RGBA color
+values. See @code{glColorTable}.
+
+@item @code{GL_CONVOLUTION_1D}
+
+
+If enabled, perform a 1D convolution operation on incoming RGBA color
+values. See @code{glConvolutionFilter1D}.
+
+@item @code{GL_CONVOLUTION_2D}
+
+
+If enabled, perform a 2D convolution operation on incoming RGBA color
+values. See @code{glConvolutionFilter2D}.
+
+@item @code{GL_CULL_FACE}
+
+
+If enabled, cull polygons based on their winding in window coordinates.
+See @code{glCullFace}.
+
+@item @code{GL_DEPTH_TEST}
+
+
+If enabled, do depth comparisons and update the depth buffer. Note that
+even if the depth buffer exists and the depth mask is non-zero, the
+depth buffer is not updated if the depth test is disabled. See
+@code{glDepthFunc} and @code{glDepthRange}.
+
+@item @code{GL_DITHER}
+
+
+If enabled, dither color components or indices before they are written
+to the color buffer.
+
+@item @code{GL_FOG}
+
+
+If enabled and no fragment shader is active, blend a fog color into the
+post-texturing color. See @code{glFog}.
+
+@item @code{GL_HISTOGRAM}
+
+
+If enabled, histogram incoming RGBA color values. See
+@code{glHistogram}.
+
+@item @code{GL_INDEX_LOGIC_OP}
+
+
+If enabled, apply the currently selected logical operation to the
+incoming index and color buffer indices. See @code{glLogicOp}.
+
+@item @code{GL_LIGHT}@var{i}
+
+
+If enabled, include light @var{i} in the evaluation of the lighting
+equation. See @code{glLightModel} and @code{glLight}.
+
+@item @code{GL_LIGHTING}
+
+
+If enabled and no vertex shader is active, use the current lighting
+parameters to compute the vertex color or index. Otherwise, simply
+associate the current color or index with each vertex. See
+@code{glMaterial}, @code{glLightModel}, and @code{glLight}.
+
+@item @code{GL_LINE_SMOOTH}
+
+
+If enabled, draw lines with correct filtering. Otherwise, draw aliased
+lines. See @code{glLineWidth}.
+
+@item @code{GL_LINE_STIPPLE}
+
+
+If enabled, use the current line stipple pattern when drawing lines. See
+@code{glLineStipple}.
+
+@item @code{GL_MAP1_COLOR_4}
+
+
+If enabled, calls to @code{glEvalCoord1}, @code{glEvalMesh1}, and
+@code{glEvalPoint1} generate RGBA values. See @code{glMap1}.
+
+@item @code{GL_MAP1_INDEX}
+
+
+If enabled, calls to @code{glEvalCoord1}, @code{glEvalMesh1}, and
+@code{glEvalPoint1} generate color indices. See @code{glMap1}.
+
+@item @code{GL_MAP1_NORMAL}
+
+
+If enabled, calls to @code{glEvalCoord1}, @code{glEvalMesh1}, and
+@code{glEvalPoint1} generate normals. See @code{glMap1}.
+
+@item @code{GL_MAP1_TEXTURE_COORD_1}
+
+
+If enabled, calls to @code{glEvalCoord1}, @code{glEvalMesh1}, and
+@code{glEvalPoint1} generate @var{s} texture coordinates. See
+@code{glMap1}.
+
+@item @code{GL_MAP1_TEXTURE_COORD_2}
+
+
+If enabled, calls to @code{glEvalCoord1}, @code{glEvalMesh1}, and
+@code{glEvalPoint1} generate @var{s} and @var{t} texture coordinates.
+See @code{glMap1}.
+
+@item @code{GL_MAP1_TEXTURE_COORD_3}
+
+
+If enabled, calls to @code{glEvalCoord1}, @code{glEvalMesh1}, and
+@code{glEvalPoint1} generate @var{s}, @var{t}, and @var{r} texture
+coordinates. See @code{glMap1}.
+
+@item @code{GL_MAP1_TEXTURE_COORD_4}
+
+
+If enabled, calls to @code{glEvalCoord1}, @code{glEvalMesh1}, and
+@code{glEvalPoint1} generate @var{s}, @var{t}, @var{r}, and @var{q}
+texture coordinates. See @code{glMap1}.
+
+@item @code{GL_MAP1_VERTEX_3}
+
+
+If enabled, calls to @code{glEvalCoord1}, @code{glEvalMesh1}, and
+@code{glEvalPoint1} generate @var{x}, @var{y}, and @var{z} vertex
+coordinates. See @code{glMap1}.
+
+@item @code{GL_MAP1_VERTEX_4}
+
+
+If enabled, calls to @code{glEvalCoord1}, @code{glEvalMesh1}, and
+@code{glEvalPoint1} generate homogeneous @var{x}, @var{y}, @var{z}, and
+@var{w} vertex coordinates. See @code{glMap1}.
+
+@item @code{GL_MAP2_COLOR_4}
+
+
+If enabled, calls to @code{glEvalCoord2}, @code{glEvalMesh2}, and
+@code{glEvalPoint2} generate RGBA values. See @code{glMap2}.
+
+@item @code{GL_MAP2_INDEX}
+
+
+If enabled, calls to @code{glEvalCoord2}, @code{glEvalMesh2}, and
+@code{glEvalPoint2} generate color indices. See @code{glMap2}.
+
+@item @code{GL_MAP2_NORMAL}
+
+
+If enabled, calls to @code{glEvalCoord2}, @code{glEvalMesh2}, and
+@code{glEvalPoint2} generate normals. See @code{glMap2}.
+
+@item @code{GL_MAP2_TEXTURE_COORD_1}
+
+
+If enabled, calls to @code{glEvalCoord2}, @code{glEvalMesh2}, and
+@code{glEvalPoint2} generate @var{s} texture coordinates. See
+@code{glMap2}.
+
+@item @code{GL_MAP2_TEXTURE_COORD_2}
+
+
+If enabled, calls to @code{glEvalCoord2}, @code{glEvalMesh2}, and
+@code{glEvalPoint2} generate @var{s} and @var{t} texture coordinates.
+See @code{glMap2}.
+
+@item @code{GL_MAP2_TEXTURE_COORD_3}
+
+
+If enabled, calls to @code{glEvalCoord2}, @code{glEvalMesh2}, and
+@code{glEvalPoint2} generate @var{s}, @var{t}, and @var{r} texture
+coordinates. See @code{glMap2}.
+
+@item @code{GL_MAP2_TEXTURE_COORD_4}
+
+
+If enabled, calls to @code{glEvalCoord2}, @code{glEvalMesh2}, and
+@code{glEvalPoint2} generate @var{s}, @var{t}, @var{r}, and @var{q}
+texture coordinates. See @code{glMap2}.
+
+@item @code{GL_MAP2_VERTEX_3}
+
+
+If enabled, calls to @code{glEvalCoord2}, @code{glEvalMesh2}, and
+@code{glEvalPoint2} generate @var{x}, @var{y}, and @var{z} vertex
+coordinates. See @code{glMap2}.
+
+@item @code{GL_MAP2_VERTEX_4}
+
+
+If enabled, calls to @code{glEvalCoord2}, @code{glEvalMesh2}, and
+@code{glEvalPoint2} generate homogeneous @var{x}, @var{y}, @var{z}, and
+@var{w} vertex coordinates. See @code{glMap2}.
+
+@item @code{GL_MINMAX}
+
+
+If enabled, compute the minimum and maximum values of incoming RGBA
+color values. See @code{glMinmax}.
+
+@item @code{GL_MULTISAMPLE}
+
+
+If enabled, use multiple fragment samples in computing the final color
+of a pixel. See @code{glSampleCoverage}.
+
+@item @code{GL_NORMALIZE}
+
+
+If enabled and no vertex shader is active, normal vectors are normalized
+to unit length after transformation and before lighting. This method is
+generally less efficient than @code{GL_RESCALE_NORMAL}. See
+@code{glNormal} and @code{glNormalPointer}.
+
+@item @code{GL_POINT_SMOOTH}
+
+
+If enabled, draw points with proper filtering. Otherwise, draw aliased
+points. See @code{glPointSize}.
+
+@item @code{GL_POINT_SPRITE}
+
+
+If enabled, calculate texture coordinates for points based on texture
+environment and point parameter settings. Otherwise texture coordinates
+are constant across points.
+
+@item @code{GL_POLYGON_OFFSET_FILL}
+
+
+If enabled, and if the polygon is rendered in @code{GL_FILL} mode, an
+offset is added to depth values of a polygon's fragments before the
+depth comparison is performed. See @code{glPolygonOffset}.
+
+@item @code{GL_POLYGON_OFFSET_LINE}
+
+
+If enabled, and if the polygon is rendered in @code{GL_LINE} mode, an
+offset is added to depth values of a polygon's fragments before the
+depth comparison is performed. See @code{glPolygonOffset}.
+
+@item @code{GL_POLYGON_OFFSET_POINT}
+
+
+If enabled, an offset is added to depth values of a polygon's fragments
+before the depth comparison is performed, if the polygon is rendered in
+@code{GL_POINT} mode. See @code{glPolygonOffset}.
+
+@item @code{GL_POLYGON_SMOOTH}
+
+
+If enabled, draw polygons with proper filtering. Otherwise, draw aliased
+polygons. For correct antialiased polygons, an alpha buffer is needed
+and the polygons must be sorted front to back.
+
+@item @code{GL_POLYGON_STIPPLE}
+
+
+If enabled, use the current polygon stipple pattern when rendering
+polygons. See @code{glPolygonStipple}.
+
+@item @code{GL_POST_COLOR_MATRIX_COLOR_TABLE}
+
+
+If enabled, perform a color table lookup on RGBA color values after
+color matrix transformation. See @code{glColorTable}.
+
+@item @code{GL_POST_CONVOLUTION_COLOR_TABLE}
+
+
+If enabled, perform a color table lookup on RGBA color values after
+convolution. See @code{glColorTable}.
+
+@item @code{GL_RESCALE_NORMAL}
+
+
+If enabled and no vertex shader is active, normal vectors are scaled
+after transformation and before lighting by a factor computed from the
+modelview matrix. If the modelview matrix scales space uniformly, this
+has the effect of restoring the transformed normal to unit length. This
+method is generally more efficient than @code{GL_NORMALIZE}. See
+@code{glNormal} and @code{glNormalPointer}.
+
+@item @code{GL_SAMPLE_ALPHA_TO_COVERAGE}
+
+
+If enabled, compute a temporary coverage value where each bit is
+determined by the alpha value at the corresponding sample location. The
+temporary coverage value is then ANDed with the fragment coverage value.
+
+@item @code{GL_SAMPLE_ALPHA_TO_ONE}
+
+
+If enabled, each sample alpha value is replaced by the maximum
+representable alpha value.
+
+@item @code{GL_SAMPLE_COVERAGE}
+
+
+If enabled, the fragment's coverage is ANDed with the temporary coverage
+value. If @code{GL_SAMPLE_COVERAGE_INVERT} is set to @code{GL_TRUE},
+invert the coverage value. See @code{glSampleCoverage}.
+
+@item @code{GL_SEPARABLE_2D}
+
+
+If enabled, perform a two-dimensional convolution operation using a
+separable convolution filter on incoming RGBA color values. See
+@code{glSeparableFilter2D}.
+
+@item @code{GL_SCISSOR_TEST}
+
+
+If enabled, discard fragments that are outside the scissor rectangle.
+See @code{glScissor}.
+
+@item @code{GL_STENCIL_TEST}
+
+
+If enabled, do stencil testing and update the stencil buffer. See
+@code{glStencilFunc} and @code{glStencilOp}.
+
+@item @code{GL_TEXTURE_1D}
+
+
+If enabled and no fragment shader is active, one-dimensional texturing
+is performed (unless two- or three-dimensional or cube-mapped texturing
+is also enabled). See @code{glTexImage1D}.
+
+@item @code{GL_TEXTURE_2D}
+
+
+If enabled and no fragment shader is active, two-dimensional texturing
+is performed (unless three-dimensional or cube-mapped texturing is also
+enabled). See @code{glTexImage2D}.
+
+@item @code{GL_TEXTURE_3D}
+
+
+If enabled and no fragment shader is active, three-dimensional texturing
+is performed (unless cube-mapped texturing is also enabled). See
+@code{glTexImage3D}.
+
+@item @code{GL_TEXTURE_CUBE_MAP}
+
+
+If enabled and no fragment shader is active, cube-mapped texturing is
+performed. See @code{glTexImage2D}.
+
+@item @code{GL_TEXTURE_GEN_Q}
+
+
+If enabled and no vertex shader is active, the @var{q} texture
+coordinate is computed using the texture generation function defined
+with @code{glTexGen}. Otherwise, the current @var{q} texture coordinate
+is used. See @code{glTexGen}.
+
+@item @code{GL_TEXTURE_GEN_R}
+
+
+If enabled and no vertex shader is active, the @var{r} texture
+coordinate is computed using the texture generation function defined
+with @code{glTexGen}. Otherwise, the current @var{r} texture coordinate
+is used. See @code{glTexGen}.
+
+@item @code{GL_TEXTURE_GEN_S}
+
+
+If enabled and no vertex shader is active, the @var{s} texture
+coordinate is computed using the texture generation function defined
+with @code{glTexGen}. Otherwise, the current @var{s} texture coordinate
+is used. See @code{glTexGen}.
+
+@item @code{GL_TEXTURE_GEN_T}
+
+
+If enabled and no vertex shader is active, the @var{t} texture
+coordinate is computed using the texture generation function defined
+with @code{glTexGen}. Otherwise, the current @var{t} texture coordinate
+is used. See @code{glTexGen}.
+
+@item @code{GL_VERTEX_PROGRAM_POINT_SIZE}
+
+
+If enabled and a vertex shader is active, then the derived point size is
+taken from the (potentially clipped) shader builtin @code{gl_PointSize}
+and clamped to the implementation-dependent point size range.
+
+@item @code{GL_VERTEX_PROGRAM_TWO_SIDE}
+
+
+If enabled and a vertex shader is active, it specifies that the GL will
+choose between front and back colors based on the polygon's face
+direction of which the vertex being shaded is a part. It has no effect
+on points or lines.
+
+@end table
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{cap} is not one of the
+values listed previously.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glEnable} or
+@code{glDisable} is executed between the execution of @code{glBegin} and
+the corresponding execution of @code{glEnd}.
+
+@end defun
+
+@defun glEvalCoord
+@heading evaluate enabled one- and two-dimensional maps
+@heading Parameters
+@table @asis
+@item @var{u}
+Specifies a value that is the domain coordinate @math{@var{u}} to the
+basis function defined in a previous @code{glMap1} or @code{glMap2}
+command.
+
+@item @var{v}
+Specifies a value that is the domain coordinate @math{@var{v}} to the
+basis function defined in a previous @code{glMap2} command. This
+argument is not present in a @code{glEvalCoord1} command.
+
+@end table
+
+@heading Description
+@code{glEvalCoord1} evaluates enabled one-dimensional maps at argument
+@var{u}. @code{glEvalCoord2} does the same for two-dimensional maps
+using two domain values, @var{u} and @var{v}. To define a map, call
+@code{glMap1} and @code{glMap2}; to enable and disable it, call
+@code{glEnable} and @code{glDisable}.
+
+When one of the @code{glEvalCoord} commands is issued, all currently
+enabled maps of the indicated dimension are evaluated. Then, for each
+enabled map, it is as if the corresponding GL command had been issued
+with the computed value. That is, if @code{GL_MAP1_INDEX} or
+@code{GL_MAP2_INDEX} is enabled, a @code{glIndex} command is simulated.
+If @code{GL_MAP1_COLOR_4} or @code{GL_MAP2_COLOR_4} is enabled, a
+@code{glColor} command is simulated. If @code{GL_MAP1_NORMAL} or
+@code{GL_MAP2_NORMAL} is enabled, a normal vector is produced, and if
+any of @code{GL_MAP1_TEXTURE_COORD_1}, @code{GL_MAP1_TEXTURE_COORD_2},
+@code{GL_MAP1_TEXTURE_COORD_3}, @code{GL_MAP1_TEXTURE_COORD_4},
+@code{GL_MAP2_TEXTURE_COORD_1}, @code{GL_MAP2_TEXTURE_COORD_2},
+@code{GL_MAP2_TEXTURE_COORD_3}, or @code{GL_MAP2_TEXTURE_COORD_4} is
+enabled, then an appropriate @code{glTexCoord} command is simulated.
+
+For color, color index, normal, and texture coordinates the GL uses
+evaluated values instead of current values for those evaluations that
+are enabled, and current values otherwise, However, the evaluated values
+do not update the current values. Thus, if @code{glVertex} commands are
+interspersed with @code{glEvalCoord} commands, the color, normal, and
+texture coordinates associated with the @code{glVertex} commands are not
+affected by the values generated by the @code{glEvalCoord} commands, but
+only by the most recent @code{glColor}, @code{glIndex}, @code{glNormal},
+and @code{glTexCoord} commands.
+
+No commands are issued for maps that are not enabled. If more than one
+texture evaluation is enabled for a particular dimension (for example,
+@code{GL_MAP2_TEXTURE_COORD_1} and @code{GL_MAP2_TEXTURE_COORD_2}), then
+only the evaluation of the map that produces the larger number of
+coordinates (in this case, @code{GL_MAP2_TEXTURE_COORD_2}) is carried
+out. @code{GL_MAP1_VERTEX_4} overrides @code{GL_MAP1_VERTEX_3}, and
+@code{GL_MAP2_VERTEX_4} overrides @code{GL_MAP2_VERTEX_3}, in the same
+manner. If neither a three- nor a four-component vertex map is enabled
+for the specified dimension, the @code{glEvalCoord} command is ignored.
+
+If you have enabled automatic normal generation, by calling
+@code{glEnable} with argument @code{GL_AUTO_NORMAL}, @code{glEvalCoord2}
+generates surface normals analytically, regardless of the contents or
+enabling of the @code{GL_MAP2_NORMAL} map. Let
+
+@math{@code{m}=∂@code{p},/∂@var{u},,×∂@code{p},/∂@var{v},,}
+
+Then the generated normal @math{@code{n}} is
+@math{@code{n}=@code{m}/∥@code{m},∥,}
+
+If automatic normal generation is disabled, the corresponding normal map
+@code{GL_MAP2_NORMAL}, if enabled, is used to produce a normal. If
+neither automatic normal generation nor a normal map is enabled, no
+normal is generated for @code{glEvalCoord2} commands.
+
+@end defun
+
+@defun glEvalMesh
+@heading compute a one- or two-dimensional grid of points or lines
+@heading Parameters
+@table @asis
+@item @var{mode}
+In @code{glEvalMesh1}, specifies whether to compute a one-dimensional
+mesh of points or lines. Symbolic constants @code{GL_POINT} and
+@code{GL_LINE} are accepted.
+
+@item @var{i1}
+@itemx @var{i2}
+Specify the first and last integer values for grid domain variable
+@math{@var{i}}.
+
+@end table
+
+@heading Description
+@code{glMapGrid} and @code{glEvalMesh} are used in tandem to efficiently
+generate and evaluate a series of evenly-spaced map domain values.
+@code{glEvalMesh} steps through the integer domain of a one- or
+two-dimensional grid, whose range is the domain of the evaluation maps
+specified by @code{glMap1} and @code{glMap2}. @var{mode} determines
+whether the resulting vertices are connected as points, lines, or filled
+polygons.
+
+In the one-dimensional case, @code{glEvalMesh1}, the mesh is generated
+as if the following code fragment were executed:
+
+where
+
+@example
+
+glBegin( @var{type} );
+for ( i = @var{i1}; i <= @var{i2}; i += 1 )
+ glEvalCoord1( @math{i·Δ@var{u}+@var{u}_1} );
+glEnd();
+@end example
+
+@math{Δ@var{u}=(@var{u}_2-@var{u}_1,)/@var{n}}
+
+and @math{@var{n}}, @math{@var{u}_1}, and @math{@var{u}_2} are the
+arguments to the most recent @code{glMapGrid1} command. @var{type} is
+@code{GL_POINTS} if @var{mode} is @code{GL_POINT}, or @code{GL_LINES} if
+@var{mode} is @code{GL_LINE}.
+
+The one absolute numeric requirement is that if @math{@var{i}=@var{n}},
+then the value computed from @math{@var{i}·Δ@var{u}+@var{u}_1} is
+exactly @math{@var{u}_2}.
+
+In the two-dimensional case, @code{glEvalMesh2}, let .cp
+@math{Δ@var{u}=(@var{u}_2-@var{u}_1,)/@var{n}}
+
+@math{Δ@var{v}=(@var{v}_2-@var{v}_1,)/@var{m}}
+
+where @math{@var{n}}, @math{@var{u}_1}, @math{@var{u}_2},
+@math{@var{m}}, @math{@var{v}_1}, and @math{@var{v}_2} are the arguments
+to the most recent @code{glMapGrid2} command. Then, if @var{mode} is
+@code{GL_FILL}, the @code{glEvalMesh2} command is equivalent to:
+
+
+
+@example
+
+for ( j = @var{j1}; j < @var{j2}; j += 1 ) @{
+ glBegin( GL_QUAD_STRIP );
+ for ( i = @var{i1}; i <= @var{i2}; i += 1 ) @{
+ glEvalCoord2( @math{i·Δ@var{u}+@var{u}_1,j·Δ@var{v}+@var{v}_1} );
+ glEvalCoord2( @math{i·Δ@var{u}+@var{u}_1,(j+1,)·Δ@var{v}+@var{v}_1} );
+ @}
+ glEnd();
+@}
+@end example
+
+If @var{mode} is @code{GL_LINE}, then a call to @code{glEvalMesh2} is
+equivalent to:
+
+
+
+@example
+
+for ( j = @var{j1}; j <= @var{j2}; j += 1 ) @{
+ glBegin( GL_LINE_STRIP );
+ for ( i = @var{i1}; i <= @var{i2}; i += 1 )
+ glEvalCoord2( @math{i·Δ@var{u}+@var{u}_1,j·Δ@var{v}+@var{v}_1} );
+ glEnd();
+@}
+
+for ( i = @var{i1}; i <= @var{i2}; i += 1 ) @{
+ glBegin( GL_LINE_STRIP );
+ for ( j = @var{j1}; j <= @var{j1}; j += 1 )
+ glEvalCoord2( @math{i·Δ@var{u}+@var{u}_1,j·Δ@var{v}+@var{v}_1} );
+ glEnd();
+@}
+@end example
+
+And finally, if @var{mode} is @code{GL_POINT}, then a call to
+@code{glEvalMesh2} is equivalent to:
+
+
+
+@example
+
+glBegin( GL_POINTS );
+for ( j = @var{j1}; j <= @var{j2}; j += 1 )
+ for ( i = @var{i1}; i <= @var{i2}; i += 1 )
+ glEvalCoord2( @math{i·Δ@var{u}+@var{u}_1,j·Δ@var{v}+@var{v}_1} );
+glEnd();
+@end example
+
+In all three cases, the only absolute numeric requirements are that if
+@math{@var{i}=@var{n}}, then the value computed from
+@math{@var{i}·Δ@var{u}+@var{u}_1} is exactly @math{@var{u}_2}, and if
+@math{@var{j}=@var{m}}, then the value computed from
+@math{@var{j}·Δ@var{v}+@var{v}_1} is exactly @math{@var{v}_2}.
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{mode} is not an accepted
+value.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glEvalMesh} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glEvalPoint
+@heading generate and evaluate a single point in a mesh
+@heading Parameters
+@table @asis
+@item @var{i}
+Specifies the integer value for grid domain variable @math{@var{i}}.
+
+@item @var{j}
+Specifies the integer value for grid domain variable @math{@var{j}}
+(@code{glEvalPoint2} only).
+
+@end table
+
+@heading Description
+@code{glMapGrid} and @code{glEvalMesh} are used in tandem to efficiently
+generate and evaluate a series of evenly spaced map domain values.
+@code{glEvalPoint} can be used to evaluate a single grid point in the
+same gridspace that is traversed by @code{glEvalMesh}. Calling
+@code{glEvalPoint1} is equivalent to calling where
+@math{Δ@var{u}=(@var{u}_2-@var{u}_1,)/@var{n}}
+
+@example
+
+glEvalCoord1( @math{i·Δ@var{u}+@var{u}_1} );
+@end example
+
+and @math{@var{n}}, @math{@var{u}_1}, and @math{@var{u}_2} are the
+arguments to the most recent @code{glMapGrid1} command. The one absolute
+numeric requirement is that if @math{@var{i}=@var{n}}, then the value
+computed from @math{@var{i}·Δ@var{u}+@var{u}_1} is exactly
+@math{@var{u}_2}.
+
+In the two-dimensional case, @code{glEvalPoint2}, let
+
+@math{Δ@var{u}=(@var{u}_2-@var{u}_1,)/@var{n}}@math{Δ@var{v}=(@var{v}_2-@var{v}_1,)/@var{m}}
+
+where @math{@var{n}}, @math{@var{u}_1}, @math{@var{u}_2},
+@math{@var{m}}, @math{@var{v}_1}, and @math{@var{v}_2} are the arguments
+to the most recent @code{glMapGrid2} command. Then the
+@code{glEvalPoint2} command is equivalent to calling The only absolute
+numeric requirements are that if @math{@var{i}=@var{n}}, then the value
+computed from @math{@var{i}·Δ@var{u}+@var{u}_1} is exactly
+@math{@var{u}_2}, and if @math{@var{j}=@var{m}}, then the value computed
+from @math{@var{j}·Δ@var{v}+@var{v}_1} is exactly @math{@var{v}_2}.
+
+@example
+
+glEvalCoord2( @math{i·Δ@var{u}+@var{u}_1,j·Δ@var{v}+@var{v}_1} );
+@end example
+
+@end defun
+
+@defun glFeedbackBuffer
+@heading controls feedback mode
+@heading Parameters
+@table @asis
+@item @var{size}
+Specifies the maximum number of values that can be written into
+@var{buffer}.
+
+@item @var{type}
+Specifies a symbolic constant that describes the information that will
+be returned for each vertex. @code{GL_2D}, @code{GL_3D},
+@code{GL_3D_COLOR}, @code{GL_3D_COLOR_TEXTURE}, and
+@code{GL_4D_COLOR_TEXTURE} are accepted.
+
+@item @var{buffer}
+Returns the feedback data.
+
+@end table
+
+@heading Description
+The @code{glFeedbackBuffer} function controls feedback. Feedback, like
+selection, is a GL mode. The mode is selected by calling
+@code{glRenderMode} with @code{GL_FEEDBACK}. When the GL is in feedback
+mode, no pixels are produced by rasterization. Instead, information
+about primitives that would have been rasterized is fed back to the
+application using the GL.
+
+@code{glFeedbackBuffer} has three arguments: @var{buffer} is a pointer
+to an array of floating-point values into which feedback information is
+placed. @var{size} indicates the size of the array. @var{type} is a
+symbolic constant describing the information that is fed back for each
+vertex. @code{glFeedbackBuffer} must be issued before feedback mode is
+enabled (by calling @code{glRenderMode} with argument
+@code{GL_FEEDBACK}). Setting @code{GL_FEEDBACK} without establishing the
+feedback buffer, or calling @code{glFeedbackBuffer} while the GL is in
+feedback mode, is an error.
+
+When @code{glRenderMode} is called while in feedback mode, it returns
+the number of entries placed in the feedback array and resets the
+feedback array pointer to the base of the feedback buffer. The returned
+value never exceeds @var{size}. If the feedback data required more room
+than was available in @var{buffer}, @code{glRenderMode} returns a
+negative value. To take the GL out of feedback mode, call
+@code{glRenderMode} with a parameter value other than
+@code{GL_FEEDBACK}.
+
+While in feedback mode, each primitive, bitmap, or pixel rectangle that
+would be rasterized generates a block of values that are copied into the
+feedback array. If doing so would cause the number of entries to exceed
+the maximum, the block is partially written so as to fill the array (if
+there is any room left at all), and an overflow flag is set. Each block
+begins with a code indicating the primitive type, followed by values
+that describe the primitive's vertices and associated data. Entries are
+also written for bitmaps and pixel rectangles. Feedback occurs after
+polygon culling and @code{glPolygonMode} interpretation of polygons has
+taken place, so polygons that are culled are not returned in the
+feedback buffer. It can also occur after polygons with more than three
+edges are broken up into triangles, if the GL implementation renders
+polygons by performing this decomposition.
+
+The @code{glPassThrough} command can be used to insert a marker into the
+feedback buffer. See @code{glPassThrough}.
+
+Following is the grammar for the blocks of values written into the
+feedback buffer. Each primitive is indicated with a unique identifying
+value followed by some number of vertices. Polygon entries include an
+integer value indicating how many vertices follow. A vertex is fed back
+as some number of floating-point values, as determined by @var{type}.
+Colors are fed back as four values in RGBA mode and one value in color
+index mode.
+
+feedbackList @math{←} feedbackItem feedbackList | feedbackItem
+feedbackItem @math{←} point | lineSegment | polygon | bitmap |
+pixelRectangle | passThru point @math{←}@code{GL_POINT_TOKEN} vertex
+lineSegment @math{←}@code{GL_LINE_TOKEN} vertex vertex |
+@code{GL_LINE_RESET_TOKEN} vertex vertex polygon
+@math{←}@code{GL_POLYGON_TOKEN} n polySpec polySpec @math{←} polySpec
+vertex | vertex vertex vertex bitmap @math{←}@code{GL_BITMAP_TOKEN}
+vertex pixelRectangle @math{←}@code{GL_DRAW_PIXEL_TOKEN} vertex |
+@code{GL_COPY_PIXEL_TOKEN} vertex passThru
+@math{←}@code{GL_PASS_THROUGH_TOKEN} value vertex @math{←} 2d | 3d |
+3dColor | 3dColorTexture | 4dColorTexture 2d @math{←} value value 3d
+@math{←} value value value 3dColor @math{←} value value value color
+3dColorTexture @math{←} value value value color tex 4dColorTexture
+@math{←} value value value value color tex color @math{←} rgba | index
+rgba @math{←} value value value value index @math{←} value tex @math{←}
+value value value value
+
+@var{value} is a floating-point number, and @var{n} is a floating-point
+integer giving the number of vertices in the polygon.
+@code{GL_POINT_TOKEN}, @code{GL_LINE_TOKEN}, @code{GL_LINE_RESET_TOKEN},
+@code{GL_POLYGON_TOKEN}, @code{GL_BITMAP_TOKEN},
+@code{GL_DRAW_PIXEL_TOKEN}, @code{GL_COPY_PIXEL_TOKEN} and
+@code{GL_PASS_THROUGH_TOKEN} are symbolic floating-point constants.
+@code{GL_LINE_RESET_TOKEN} is returned whenever the line stipple pattern
+is reset. The data returned as a vertex depends on the feedback
+@var{type}.
+
+The following table gives the correspondence between @var{type} and the
+number of values per vertex. @var{k} is 1 in color index mode and 4 in
+RGBA mode.
+
+
+
+@table @asis
+@item @strong{Type}
+@strong{Coordinates}, @strong{Color}, @strong{Texture}, @strong{Total
+Number of Values}
+
+@item @code{GL_2D}
+@var{x}, @var{y}, , , 2
+
+@item @code{GL_3D}
+@var{x}, @var{y}, @var{z}, , , 3
+
+@item @code{GL_3D_COLOR}
+@var{x}, @var{y}, @var{z}, @math{@var{k}}, , @math{3+@var{k}}
+
+@item @code{GL_3D_COLOR_TEXTURE}
+@var{x}, @var{y}, @var{z}, @math{@var{k}}, 4 , @math{7+@var{k}}
+
+@item @code{GL_4D_COLOR_TEXTURE}
+@var{x}, @var{y}, @var{z}, @var{w}, @math{@var{k}}, 4 , @math{8+@var{k}}
+
+@end table
+
+Feedback vertex coordinates are in window coordinates, except @var{w},
+which is in clip coordinates. Feedback colors are lighted, if lighting
+is enabled. Feedback texture coordinates are generated, if texture
+coordinate generation is enabled. They are always transformed by the
+texture matrix.
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{type} is not an accepted
+value.
+
+@code{GL_INVALID_VALUE} is generated if @var{size} is negative.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glFeedbackBuffer} is
+called while the render mode is @code{GL_FEEDBACK}, or if
+@code{glRenderMode} is called with argument @code{GL_FEEDBACK} before
+@code{glFeedbackBuffer} is called at least once.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glFeedbackBuffer} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glFinish
+@heading block until all GL execution is complete
+@heading Description
+@code{glFinish} does not return until the effects of all previously
+called GL commands are complete. Such effects include all changes to GL
+state, all changes to connection state, and all changes to the frame
+buffer contents.
+
+@heading Errors
+@code{GL_INVALID_OPERATION} is generated if @code{glFinish} is executed
+between the execution of @code{glBegin} and the corresponding execution
+of @code{glEnd}.
+
+@end defun
+
+@defun glFlush
+@heading force execution of GL commands in finite time
+@heading Description
+Different GL implementations buffer commands in several different
+locations, including network buffers and the graphics accelerator
+itself. @code{glFlush} empties all of these buffers, causing all issued
+commands to be executed as quickly as they are accepted by the actual
+rendering engine. Though this execution may not be completed in any
+particular time period, it does complete in finite time.
+
+Because any GL program might be executed over a network, or on an
+accelerator that buffers commands, all programs should call
+@code{glFlush} whenever they count on having all of their previously
+issued commands completed. For example, call @code{glFlush} before
+waiting for user input that depends on the generated image.
+
+@heading Errors
+@code{GL_INVALID_OPERATION} is generated if @code{glFlush} is executed
+between the execution of @code{glBegin} and the corresponding execution
+of @code{glEnd}.
+
+@end defun
+
+@defun glFogCoordPointer
+@heading define an array of fog coordinates
+@heading Parameters
+@table @asis
+@item @var{type}
+Specifies the data type of each fog coordinate. Symbolic constants
+@code{GL_FLOAT}, or @code{GL_DOUBLE} are accepted. The initial value is
+@code{GL_FLOAT}.
+
+@item @var{stride}
+Specifies the byte offset between consecutive fog coordinates. If
+@var{stride} is 0, the array elements are understood to be tightly
+packed. The initial value is 0.
+
+@item @var{pointer}
+Specifies a pointer to the first coordinate of the first fog coordinate
+in the array. The initial value is 0.
+
+@end table
+
+@heading Description
+@code{glFogCoordPointer} specifies the location and data format of an
+array of fog coordinates to use when rendering. @var{type} specifies the
+data type of each fog coordinate, and @var{stride} specifies the byte
+stride from one fog coordinate to the next, allowing vertices and
+attributes to be packed into a single array or stored in separate
+arrays.
+
+If a non-zero named buffer object is bound to the @code{GL_ARRAY_BUFFER}
+target (see @code{glBindBuffer}) while a fog coordinate array is
+specified, @var{pointer} is treated as a byte offset into the buffer
+object's data store. Also, the buffer object binding
+(@code{GL_ARRAY_BUFFER_BINDING}) is saved as fog coordinate vertex array
+client-side state (@code{GL_FOG_COORD_ARRAY_BUFFER_BINDING}).
+
+When a fog coordinate array is specified, @var{type}, @var{stride}, and
+@var{pointer} are saved as client-side state, in addition to the current
+vertex array buffer object binding.
+
+To enable and disable the fog coordinate array, call
+@code{glEnableClientState} and @code{glDisableClientState} with the
+argument @code{GL_FOG_COORD_ARRAY}. If enabled, the fog coordinate array
+is used when @code{glDrawArrays}, @code{glMultiDrawArrays},
+@code{glDrawElements}, @code{glMultiDrawElements},
+@code{glDrawRangeElements}, or @code{glArrayElement} is called.
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{type} is not either
+@code{GL_FLOAT} or @code{GL_DOUBLE}.
+
+@code{GL_INVALID_VALUE} is generated if @var{stride} is negative.
+
+@end defun
+
+@defun glFogCoord
+@heading set the current fog coordinates
+@heading Parameters
+@table @asis
+@item @var{coord}
+Specify the fog distance.
+
+@end table
+
+@heading Description
+@code{glFogCoord} specifies the fog coordinate that is associated with
+each vertex and the current raster position. The value specified is
+interpolated and used in computing the fog color (see @code{glFog}).
+
+@end defun
+
+@defun glFog
+@heading specify fog parameters
+@heading Parameters
+@table @asis
+@item @var{pname}
+Specifies a single-valued fog parameter. @code{GL_FOG_MODE},
+@code{GL_FOG_DENSITY}, @code{GL_FOG_START}, @code{GL_FOG_END},
+@code{GL_FOG_INDEX}, and @code{GL_FOG_COORD_SRC} are accepted.
+
+@item @var{param}
+Specifies the value that @var{pname} will be set to.
+
+@end table
+
+@heading Description
+Fog is initially disabled. While enabled, fog affects rasterized
+geometry, bitmaps, and pixel blocks, but not buffer clear operations. To
+enable and disable fog, call @code{glEnable} and @code{glDisable} with
+argument @code{GL_FOG}.
+
+@code{glFog} assigns the value or values in @var{params} to the fog
+parameter specified by @var{pname}. The following values are accepted
+for @var{pname}:
+
+@table @asis
+@item @code{GL_FOG_MODE}
+@var{params} is a single integer or floating-point value that specifies
+the equation to be used to compute the fog blend factor, @math{@var{f}}.
+Three symbolic constants are accepted: @code{GL_LINEAR}, @code{GL_EXP},
+and @code{GL_EXP2}. The equations corresponding to these symbolic
+constants are defined below. The initial fog mode is @code{GL_EXP}.
+
+@item @code{GL_FOG_DENSITY}
+@var{params} is a single integer or floating-point value that specifies
+@math{@var{density}}, the fog density used in both exponential fog
+equations. Only nonnegative densities are accepted. The initial fog
+density is 1.
+
+@item @code{GL_FOG_START}
+@var{params} is a single integer or floating-point value that specifies
+@math{@var{start}}, the near distance used in the linear fog equation.
+The initial near distance is 0.
+
+@item @code{GL_FOG_END}
+@var{params} is a single integer or floating-point value that specifies
+@math{@var{end}}, the far distance used in the linear fog equation. The
+initial far distance is 1.
+
+@item @code{GL_FOG_INDEX}
+@var{params} is a single integer or floating-point value that specifies
+@math{@var{i}_@var{f}}, the fog color index. The initial fog index is 0.
+
+@item @code{GL_FOG_COLOR}
+@var{params} contains four integer or floating-point values that specify
+@math{@var{C}_@var{f}}, the fog color. Integer values are mapped
+linearly such that the most positive representable value maps to 1.0,
+and the most negative representable value maps to @math{-1.0}.
+Floating-point values are mapped directly. After conversion, all color
+components are clamped to the range @math{[0,1]}. The initial fog color
+is (0, 0, 0, 0).
+
+@item @code{GL_FOG_COORD_SRC}
+@var{params} contains either of the following symbolic constants:
+@code{GL_FOG_COORD} or @code{GL_FRAGMENT_DEPTH}. @code{GL_FOG_COORD}
+specifies that the current fog coordinate should be used as distance
+value in the fog color computation. @code{GL_FRAGMENT_DEPTH} specifies
+that the current fragment depth should be used as distance value in the
+fog computation.
+
+@end table
+
+Fog blends a fog color with each rasterized pixel fragment's
+post-texturing color using a blending factor @math{@var{f}}. Factor
+@math{@var{f}} is computed in one of three ways, depending on the fog
+mode. Let @math{@var{c}} be either the distance in eye coordinate from
+the origin (in the case that the @code{GL_FOG_COORD_SRC} is
+@code{GL_FRAGMENT_DEPTH}) or the current fog coordinate (in the case
+that @code{GL_FOG_COORD_SRC} is @code{GL_FOG_COORD}). The equation for
+@code{GL_LINEAR} fog is
+@math{@var{f}=@var{end}-@var{c},/@var{end}-@var{start},}
+
+The equation for @code{GL_EXP} fog is
+@math{@var{f}=@var{e}^-(@var{density}·@var{c},),}
+
+The equation for @code{GL_EXP2} fog is
+@math{@var{f}=@var{e}^-(@var{density}·@var{c},),^2}
+
+Regardless of the fog mode, @math{@var{f}} is clamped to the range
+@math{[0,1]} after it is computed. Then, if the GL is in RGBA color
+mode, the fragment's red, green, and blue colors, represented by
+@math{@var{C}_@var{r}}, are replaced by
+
+@math{@var{C}_@var{r},^″=@var{f}×@var{C}_@var{r}+(1-@var{f},)×@var{C}_@var{f}}
+
+Fog does not affect a fragment's alpha component.
+
+In color index mode, the fragment's color index @math{@var{i}_@var{r}}
+is replaced by
+
+@math{@var{i}_@var{r},^″=@var{i}_@var{r}+(1-@var{f},)×@var{i}_@var{f}}
+
+
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{pname} is not an accepted
+value, or if @var{pname} is @code{GL_FOG_MODE} and @var{params} is not
+an accepted value.
+
+@code{GL_INVALID_VALUE} is generated if @var{pname} is
+@code{GL_FOG_DENSITY} and @var{params} is negative.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glFog} is executed
+between the execution of @code{glBegin} and the corresponding execution
+of @code{glEnd}.
+
+@end defun
+
+@defun glFrontFace
+@heading define front- and back-facing polygons
+@heading Parameters
+@table @asis
+@item @var{mode}
+Specifies the orientation of front-facing polygons. @code{GL_CW} and
+@code{GL_CCW} are accepted. The initial value is @code{GL_CCW}.
+
+@end table
+
+@heading Description
+In a scene composed entirely of opaque closed surfaces, back-facing
+polygons are never visible. Eliminating these invisible polygons has the
+obvious benefit of speeding up the rendering of the image. To enable and
+disable elimination of back-facing polygons, call @code{glEnable} and
+@code{glDisable} with argument @code{GL_CULL_FACE}.
+
+The projection of a polygon to window coordinates is said to have
+clockwise winding if an imaginary object following the path from its
+first vertex, its second vertex, and so on, to its last vertex, and
+finally back to its first vertex, moves in a clockwise direction about
+the interior of the polygon. The polygon's winding is said to be
+counterclockwise if the imaginary object following the same path moves
+in a counterclockwise direction about the interior of the polygon.
+@code{glFrontFace} specifies whether polygons with clockwise winding in
+window coordinates, or counterclockwise winding in window coordinates,
+are taken to be front-facing. Passing @code{GL_CCW} to @var{mode}
+selects counterclockwise polygons as front-facing; @code{GL_CW} selects
+clockwise polygons as front-facing. By default, counterclockwise
+polygons are taken to be front-facing.
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{mode} is not an accepted
+value.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glFrontFace} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glFrustum
+@heading multiply the current matrix by a perspective matrix
+@heading Parameters
+@table @asis
+@item @var{left}
+@itemx @var{right}
+Specify the coordinates for the left and right vertical clipping planes.
+
+@item @var{bottom}
+@itemx @var{top}
+Specify the coordinates for the bottom and top horizontal clipping
+planes.
+
+@item @var{nearVal}
+@itemx @var{farVal}
+Specify the distances to the near and far depth clipping planes. Both
+distances must be positive.
+
+@end table
+
+@heading Description
+@code{glFrustum} describes a perspective matrix that produces a
+perspective projection. The current matrix (see @code{glMatrixMode}) is
+multiplied by this matrix and the result replaces the current matrix, as
+if @code{glMultMatrix} were called with the following matrix as its
+argument:
+
+
+
+@math{[(2@var{nearVal},/@var{right}-@var{left},, 0 @var{A} 0), (0
+2@var{nearVal},/@var{top}-@var{bottom},, @var{B} 0), (0 0 @var{C}
+@var{D}), (0 0 -1 0),]}
+
+@math{@var{A}=@var{right}+@var{left},/@var{right}-@var{left},}
+
+@math{@var{B}=@var{top}+@var{bottom},/@var{top}-@var{bottom},}
+
+@math{@var{C}=-@var{farVal}+@var{nearVal},/@var{farVal}-@var{nearVal},,}
+
+@math{@var{D}=-2@var{farVal}@var{nearVal},/@var{farVal}-@var{nearVal},,}
+
+
+
+Typically, the matrix mode is @code{GL_PROJECTION}, and
+@math{(@var{left},@var{bottom}-@var{nearVal})} and
+@math{(@var{right},@var{top}-@var{nearVal})} specify the points on the
+near clipping plane that are mapped to the lower left and upper right
+corners of the window, assuming that the eye is located at (0, 0, 0).
+@math{-@var{farVal}} specifies the location of the far clipping plane.
+Both @var{nearVal} and @var{farVal} must be positive.
+
+Use @code{glPushMatrix} and @code{glPopMatrix} to save and restore the
+current matrix stack.
+
+@heading Errors
+@code{GL_INVALID_VALUE} is generated if @var{nearVal} or @var{farVal} is
+not positive, or if @var{left} = @var{right}, or @var{bottom} =
+@var{top}, or @var{near} = @var{far}.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glFrustum} is executed
+between the execution of @code{glBegin} and the corresponding execution
+of @code{glEnd}.
+
+@end defun
+
+@defun glGenBuffers
+@heading generate buffer object names
+@heading Parameters
+@table @asis
+@item @var{n}
+Specifies the number of buffer object names to be generated.
+
+@item @var{buffers}
+Specifies an array in which the generated buffer object names are
+stored.
+
+@end table
+
+@heading Description
+@code{glGenBuffers} returns @var{n} buffer object names in
+@var{buffers}. There is no guarantee that the names form a contiguous
+set of integers; however, it is guaranteed that none of the returned
+names was in use immediately before the call to @code{glGenBuffers}.
+
+Buffer object names returned by a call to @code{glGenBuffers} are not
+returned by subsequent calls, unless they are first deleted with
+@code{glDeleteBuffers}.
+
+No buffer objects are associated with the returned buffer object names
+until they are first bound by calling @code{glBindBuffer}.
+
+@heading Errors
+@code{GL_INVALID_VALUE} is generated if @var{n} is negative.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glGenBuffers} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glGenLists
+@heading generate a contiguous set of empty display lists
+@heading Parameters
+@table @asis
+@item @var{range}
+Specifies the number of contiguous empty display lists to be generated.
+
+@end table
+
+@heading Description
+@code{glGenLists} has one argument, @var{range}. It returns an integer
+@var{n} such that @var{range} contiguous empty display lists, named
+@math{@var{n}}, @math{@var{n}+1}, @math{@var{...}},
+@math{@var{n}+@var{range}-1}, are created. If @var{range} is 0, if there
+is no group of @var{range} contiguous names available, or if any error
+is generated, no display lists are generated, and 0 is returned.
+
+@heading Errors
+@code{GL_INVALID_VALUE} is generated if @var{range} is negative.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glGenLists} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glGenQueries
+@heading generate query object names
+@heading Parameters
+@table @asis
+@item @var{n}
+Specifies the number of query object names to be generated.
+
+@item @var{ids}
+Specifies an array in which the generated query object names are stored.
+
+@end table
+
+@heading Description
+@code{glGenQueries} returns @var{n} query object names in @var{ids}.
+There is no guarantee that the names form a contiguous set of integers;
+however, it is guaranteed that none of the returned names was in use
+immediately before the call to @code{glGenQueries}.
+
+Query object names returned by a call to @code{glGenQueries} are not
+returned by subsequent calls, unless they are first deleted with
+@code{glDeleteQueries}.
+
+No query objects are associated with the returned query object names
+until they are first used by calling @code{glBeginQuery}.
+
+@heading Errors
+@code{GL_INVALID_VALUE} is generated if @var{n} is negative.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glGenQueries} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glGenTextures
+@heading generate texture names
+@heading Parameters
+@table @asis
+@item @var{n}
+Specifies the number of texture names to be generated.
+
+@item @var{textures}
+Specifies an array in which the generated texture names are stored.
+
+@end table
+
+@heading Description
+@code{glGenTextures} returns @var{n} texture names in @var{textures}.
+There is no guarantee that the names form a contiguous set of integers;
+however, it is guaranteed that none of the returned names was in use
+immediately before the call to @code{glGenTextures}.
+
+The generated textures have no dimensionality; they assume the
+dimensionality of the texture target to which they are first bound (see
+@code{glBindTexture}).
+
+Texture names returned by a call to @code{glGenTextures} are not
+returned by subsequent calls, unless they are first deleted with
+@code{glDeleteTextures}.
+
+@heading Errors
+@code{GL_INVALID_VALUE} is generated if @var{n} is negative.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glGenTextures} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glGetActiveAttrib
+@heading Returns information about an active attribute variable for the specified program object
+@heading Parameters
+@table @asis
+@item @var{program}
+Specifies the program object to be queried.
+
+@item @var{index}
+Specifies the index of the attribute variable to be queried.
+
+@item @var{bufSize}
+Specifies the maximum number of characters OpenGL is allowed to write in
+the character buffer indicated by @var{name}.
+
+@item @var{length}
+Returns the number of characters actually written by OpenGL in the
+string indicated by @var{name} (excluding the null terminator) if a
+value other than @code{NULL} is passed.
+
+@item @var{size}
+Returns the size of the attribute variable.
+
+@item @var{type}
+Returns the data type of the attribute variable.
+
+@item @var{name}
+Returns a null terminated string containing the name of the attribute
+variable.
+
+@end table
+
+@heading Description
+@code{glGetActiveAttrib} returns information about an active attribute
+variable in the program object specified by @var{program}. The number of
+active attributes can be obtained by calling @code{glGetProgram} with
+the value @code{GL_ACTIVE_ATTRIBUTES}. A value of 0 for @var{index}
+selects the first active attribute variable. Permissible values for
+@var{index} range from 0 to the number of active attribute variables
+minus 1.
+
+A vertex shader may use either built-in attribute variables,
+user-defined attribute variables, or both. Built-in attribute variables
+have a prefix of "gl_" and reference conventional OpenGL vertex
+attribtes (e.g., @var{gl_Vertex}, @var{gl_Normal}, etc., see the OpenGL
+Shading Language specification for a complete list.) User-defined
+attribute variables have arbitrary names and obtain their values through
+numbered generic vertex attributes. An attribute variable (either
+built-in or user-defined) is considered active if it is determined
+during the link operation that it may be accessed during program
+execution. Therefore, @var{program} should have previously been the
+target of a call to @code{glLinkProgram}, but it is not necessary for it
+to have been linked successfully.
+
+The size of the character buffer required to store the longest attribute
+variable name in @var{program} can be obtained by calling
+@code{glGetProgram} with the value
+@code{GL_ACTIVE_ATTRIBUTE_MAX_LENGTH}. This value should be used to
+allocate a buffer of sufficient size to store the returned attribute
+name. The size of this character buffer is passed in @var{bufSize}, and
+a pointer to this character buffer is passed in @var{name}.
+
+@code{glGetActiveAttrib} returns the name of the attribute variable
+indicated by @var{index}, storing it in the character buffer specified
+by @var{name}. The string returned will be null terminated. The actual
+number of characters written into this buffer is returned in
+@var{length}, and this count does not include the null termination
+character. If the length of the returned string is not required, a value
+of @code{NULL} can be passed in the @var{length} argument.
+
+The @var{type} argument will return a pointer to the attribute
+variable's data type. The symbolic constants @code{GL_FLOAT},
+@code{GL_FLOAT_VEC2}, @code{GL_FLOAT_VEC3}, @code{GL_FLOAT_VEC4},
+@code{GL_FLOAT_MAT2}, @code{GL_FLOAT_MAT3}, @code{GL_FLOAT_MAT4},
+@code{GL_FLOAT_MAT2x3}, @code{GL_FLOAT_MAT2x4}, @code{GL_FLOAT_MAT3x2},
+@code{GL_FLOAT_MAT3x4}, @code{GL_FLOAT_MAT4x2}, or
+@code{GL_FLOAT_MAT4x3} may be returned. The @var{size} argument will
+return the size of the attribute, in units of the type returned in
+@var{type}.
+
+The list of active attribute variables may include both built-in
+attribute variables (which begin with the prefix "gl_") as well as
+user-defined attribute variable names.
+
+This function will return as much information as it can about the
+specified active attribute variable. If no information is available,
+@var{length} will be 0, and @var{name} will be an empty string. This
+situation could occur if this function is called after a link operation
+that failed. If an error occurs, the return values @var{length},
+@var{size}, @var{type}, and @var{name} will be unmodified.
+
+@heading Errors
+@code{GL_INVALID_VALUE} is generated if @var{program} is not a value
+generated by OpenGL.
+
+@code{GL_INVALID_OPERATION} is generated if @var{program} is not a
+program object.
+
+@code{GL_INVALID_VALUE} is generated if @var{index} is greater than or
+equal to the number of active attribute variables in @var{program}.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glGetActiveAttrib} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@code{GL_INVALID_VALUE} is generated if @var{bufSize} is less than 0.
+
+@end defun
+
+@defun glGetActiveUniform
+@heading Returns information about an active uniform variable for the specified program object
+@heading Parameters
+@table @asis
+@item @var{program}
+Specifies the program object to be queried.
+
+@item @var{index}
+Specifies the index of the uniform variable to be queried.
+
+@item @var{bufSize}
+Specifies the maximum number of characters OpenGL is allowed to write in
+the character buffer indicated by @var{name}.
+
+@item @var{length}
+Returns the number of characters actually written by OpenGL in the
+string indicated by @var{name} (excluding the null terminator) if a
+value other than @code{NULL} is passed.
+
+@item @var{size}
+Returns the size of the uniform variable.
+
+@item @var{type}
+Returns the data type of the uniform variable.
+
+@item @var{name}
+Returns a null terminated string containing the name of the uniform
+variable.
+
+@end table
+
+@heading Description
+@code{glGetActiveUniform} returns information about an active uniform
+variable in the program object specified by @var{program}. The number of
+active uniform variables can be obtained by calling @code{glGetProgram}
+with the value @code{GL_ACTIVE_UNIFORMS}. A value of 0 for @var{index}
+selects the first active uniform variable. Permissible values for
+@var{index} range from 0 to the number of active uniform variables minus
+1.
+
+Shaders may use either built-in uniform variables, user-defined uniform
+variables, or both. Built-in uniform variables have a prefix of "gl_"
+and reference existing OpenGL state or values derived from such state
+(e.g., @var{gl_Fog}, @var{gl_ModelViewMatrix}, etc., see the OpenGL
+Shading Language specification for a complete list.) User-defined
+uniform variables have arbitrary names and obtain their values from the
+application through calls to @code{glUniform}. A uniform variable
+(either built-in or user-defined) is considered active if it is
+determined during the link operation that it may be accessed during
+program execution. Therefore, @var{program} should have previously been
+the target of a call to @code{glLinkProgram}, but it is not necessary
+for it to have been linked successfully.
+
+The size of the character buffer required to store the longest uniform
+variable name in @var{program} can be obtained by calling
+@code{glGetProgram} with the value @code{GL_ACTIVE_UNIFORM_MAX_LENGTH}.
+This value should be used to allocate a buffer of sufficient size to
+store the returned uniform variable name. The size of this character
+buffer is passed in @var{bufSize}, and a pointer to this character
+buffer is passed in @var{name.}
+
+@code{glGetActiveUniform} returns the name of the uniform variable
+indicated by @var{index}, storing it in the character buffer specified
+by @var{name}. The string returned will be null terminated. The actual
+number of characters written into this buffer is returned in
+@var{length}, and this count does not include the null termination
+character. If the length of the returned string is not required, a value
+of @code{NULL} can be passed in the @var{length} argument.
+
+The @var{type} argument will return a pointer to the uniform variable's
+data type. The symbolic constants @code{GL_FLOAT}, @code{GL_FLOAT_VEC2},
+@code{GL_FLOAT_VEC3}, @code{GL_FLOAT_VEC4}, @code{GL_INT},
+@code{GL_INT_VEC2}, @code{GL_INT_VEC3}, @code{GL_INT_VEC4},
+@code{GL_BOOL}, @code{GL_BOOL_VEC2}, @code{GL_BOOL_VEC3},
+@code{GL_BOOL_VEC4}, @code{GL_FLOAT_MAT2}, @code{GL_FLOAT_MAT3},
+@code{GL_FLOAT_MAT4}, @code{GL_FLOAT_MAT2x3}, @code{GL_FLOAT_MAT2x4},
+@code{GL_FLOAT_MAT3x2}, @code{GL_FLOAT_MAT3x4}, @code{GL_FLOAT_MAT4x2},
+@code{GL_FLOAT_MAT4x3}, @code{GL_SAMPLER_1D}, @code{GL_SAMPLER_2D},
+@code{GL_SAMPLER_3D}, @code{GL_SAMPLER_CUBE},
+@code{GL_SAMPLER_1D_SHADOW}, or @code{GL_SAMPLER_2D_SHADOW} may be
+returned.
+
+If one or more elements of an array are active, the name of the array is
+returned in @var{name}, the type is returned in @var{type}, and the
+@var{size} parameter returns the highest array element index used, plus
+one, as determined by the compiler and/or linker. Only one active
+uniform variable will be reported for a uniform array.
+
+Uniform variables that are declared as structures or arrays of
+structures will not be returned directly by this function. Instead, each
+of these uniform variables will be reduced to its fundamental components
+containing the "." and "[]" operators such that each of the names is
+valid as an argument to @code{glGetUniformLocation}. Each of these
+reduced uniform variables is counted as one active uniform variable and
+is assigned an index. A valid name cannot be a structure, an array of
+structures, or a subcomponent of a vector or matrix.
+
+The size of the uniform variable will be returned in @var{size}. Uniform
+variables other than arrays will have a size of 1. Structures and arrays
+of structures will be reduced as described earlier, such that each of
+the names returned will be a data type in the earlier list. If this
+reduction results in an array, the size returned will be as described
+for uniform arrays; otherwise, the size returned will be 1.
+
+The list of active uniform variables may include both built-in uniform
+variables (which begin with the prefix "gl_") as well as user-defined
+uniform variable names.
+
+This function will return as much information as it can about the
+specified active uniform variable. If no information is available,
+@var{length} will be 0, and @var{name} will be an empty string. This
+situation could occur if this function is called after a link operation
+that failed. If an error occurs, the return values @var{length},
+@var{size}, @var{type}, and @var{name} will be unmodified.
+
+@heading Errors
+@code{GL_INVALID_VALUE} is generated if @var{program} is not a value
+generated by OpenGL.
+
+@code{GL_INVALID_OPERATION} is generated if @var{program} is not a
+program object.
+
+@code{GL_INVALID_VALUE} is generated if @var{index} is greater than or
+equal to the number of active uniform variables in @var{program}.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glGetActiveUniform} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@code{GL_INVALID_VALUE} is generated if @var{bufSize} is less than 0.
+
+@end defun
+
+@defun glGetAttachedShaders
+@heading Returns the handles of the shader objects attached to a program object
+@heading Parameters
+@table @asis
+@item @var{program}
+Specifies the program object to be queried.
+
+@item @var{maxCount}
+Specifies the size of the array for storing the returned object names.
+
+@item @var{count}
+Returns the number of names actually returned in @var{objects}.
+
+@item @var{shaders}
+Specifies an array that is used to return the names of attached shader
+objects.
+
+@end table
+
+@heading Description
+@code{glGetAttachedShaders} returns the names of the shader objects
+attached to @var{program}. The names of shader objects that are attached
+to @var{program} will be returned in @var{shaders.} The actual number of
+shader names written into @var{shaders} is returned in @var{count.} If
+no shader objects are attached to @var{program}, @var{count} is set to
+0. The maximum number of shader names that may be returned in
+@var{shaders} is specified by @var{maxCount}.
+
+If the number of names actually returned is not required (for instance,
+if it has just been obtained by calling @code{glGetProgram}), a value of
+@code{NULL} may be passed for count. If no shader objects are attached
+to @var{program}, a value of 0 will be returned in @var{count}. The
+actual number of attached shaders can be obtained by calling
+@code{glGetProgram} with the value @code{GL_ATTACHED_SHADERS}.
+
+@heading Errors
+@code{GL_INVALID_VALUE} is generated if @var{program} is not a value
+generated by OpenGL.
+
+@code{GL_INVALID_OPERATION} is generated if @var{program} is not a
+program object.
+
+@code{GL_INVALID_VALUE} is generated if @var{maxCount} is less than 0.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glGetAttachedShaders}
+is executed between the execution of @code{glBegin} and the
+corresponding execution of @code{glEnd}.
+
+@end defun
+
+@defun glGetAttribLocation
+@heading Returns the location of an attribute variable
+@heading Parameters
+@table @asis
+@item @var{program}
+Specifies the program object to be queried.
+
+@item @var{name}
+Points to a null terminated string containing the name of the attribute
+variable whose location is to be queried.
+
+@end table
+
+@heading Description
+@code{glGetAttribLocation} queries the previously linked program object
+specified by @var{program} for the attribute variable specified by
+@var{name} and returns the index of the generic vertex attribute that is
+bound to that attribute variable. If @var{name} is a matrix attribute
+variable, the index of the first column of the matrix is returned. If
+the named attribute variable is not an active attribute in the specified
+program object or if @var{name} starts with the reserved prefix "gl_", a
+value of -1 is returned.
+
+The association between an attribute variable name and a generic
+attribute index can be specified at any time by calling
+@code{glBindAttribLocation}. Attribute bindings do not go into effect
+until @code{glLinkProgram} is called. After a program object has been
+linked successfully, the index values for attribute variables remain
+fixed until the next link command occurs. The attribute values can only
+be queried after a link if the link was successful.
+@code{glGetAttribLocation} returns the binding that actually went into
+effect the last time @code{glLinkProgram} was called for the specified
+program object. Attribute bindings that have been specified since the
+last link operation are not returned by @code{glGetAttribLocation}.
+
+@heading Errors
+@code{GL_INVALID_OPERATION} is generated if @var{program} is not a value
+generated by OpenGL.
+
+@code{GL_INVALID_OPERATION} is generated if @var{program} is not a
+program object.
+
+@code{GL_INVALID_OPERATION} is generated if @var{program} has not been
+successfully linked.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glGetAttribLocation}
+is executed between the execution of @code{glBegin} and the
+corresponding execution of @code{glEnd}.
+
+@end defun
+
+@defun glGetBufferParameteriv
+@heading return parameters of a buffer object
+@heading Parameters
+@table @asis
+@item @var{target}
+Specifies the target buffer object. The symbolic constant must be
+@code{GL_ARRAY_BUFFER}, @code{GL_ELEMENT_ARRAY_BUFFER},
+@code{GL_PIXEL_PACK_BUFFER}, or @code{GL_PIXEL_UNPACK_BUFFER}.
+
+@item @var{value}
+Specifies the symbolic name of a buffer object parameter. Accepted
+values are @code{GL_BUFFER_ACCESS}, @code{GL_BUFFER_MAPPED},
+@code{GL_BUFFER_SIZE}, or @code{GL_BUFFER_USAGE}.
+
+@item @var{data}
+Returns the requested parameter.
+
+@end table
+
+@heading Description
+@code{glGetBufferParameteriv} returns in @var{data} a selected parameter
+of the buffer object specified by @var{target}.
+
+@var{value} names a specific buffer object parameter, as follows:
+
+@table @asis
+@item @code{GL_BUFFER_ACCESS}
+@var{params} returns the access policy set while mapping the buffer
+object. The initial value is @code{GL_READ_WRITE}.
+
+@item @code{GL_BUFFER_MAPPED}
+@var{params} returns a flag indicating whether the buffer object is
+currently mapped. The initial value is @code{GL_FALSE}.
+
+@item @code{GL_BUFFER_SIZE}
+@var{params} returns the size of the buffer object, measured in bytes.
+The initial value is 0.
+
+@item @code{GL_BUFFER_USAGE}
+@var{params} returns the buffer object's usage pattern. The initial
+value is @code{GL_STATIC_DRAW}.
+
+@end table
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{target} or @var{value} is
+not an accepted value.
+
+@code{GL_INVALID_OPERATION} is generated if the reserved buffer object
+name 0 is bound to @var{target}.
+
+@code{GL_INVALID_OPERATION} is generated if
+@code{glGetBufferParameteriv} is executed between the execution of
+@code{glBegin} and the corresponding execution of @code{glEnd}.
+
+@end defun
+
+@defun glGetBufferPointerv
+@heading return the pointer to a mapped buffer object's data store
+@heading Parameters
+@table @asis
+@item @var{target}
+Specifies the target buffer object. The symbolic constant must be
+@code{GL_ARRAY_BUFFER}, @code{GL_ELEMENT_ARRAY_BUFFER},
+@code{GL_PIXEL_PACK_BUFFER}, or @code{GL_PIXEL_UNPACK_BUFFER}.
+
+@item @var{pname}
+Specifies the pointer to be returned. The symbolic constant must be
+@code{GL_BUFFER_MAP_POINTER}.
+
+@item @var{params}
+Returns the pointer value specified by @var{pname}.
+
+@end table
+
+@heading Description
+@code{glGetBufferPointerv} returns pointer information. @var{pname} is a
+symbolic constant indicating the pointer to be returned, which must be
+@code{GL_BUFFER_MAP_POINTER}, the pointer to which the buffer object's
+data store is mapped. If the data store is not currently mapped,
+@code{NULL} is returned. @var{params} is a pointer to a location in
+which to place the returned pointer value.
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{target} or @var{pname} is
+not an accepted value.
+
+@code{GL_INVALID_OPERATION} is generated if the reserved buffer object
+name 0 is bound to @var{target}.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glGetBufferPointerv}
+is executed between the execution of @code{glBegin} and the
+corresponding execution of @code{glEnd}.
+
+@end defun
+
+@defun glGetBufferSubData
+@heading returns a subset of a buffer object's data store
+@heading Parameters
+@table @asis
+@item @var{target}
+Specifies the target buffer object. The symbolic constant must be
+@code{GL_ARRAY_BUFFER}, @code{GL_ELEMENT_ARRAY_BUFFER},
+@code{GL_PIXEL_PACK_BUFFER}, or @code{GL_PIXEL_UNPACK_BUFFER}.
+
+@item @var{offset}
+Specifies the offset into the buffer object's data store from which data
+will be returned, measured in bytes.
+
+@item @var{size}
+Specifies the size in bytes of the data store region being returned.
+
+@item @var{data}
+Specifies a pointer to the location where buffer object data is
+returned.
+
+@end table
+
+@heading Description
+@code{glGetBufferSubData} returns some or all of the data from the
+buffer object currently bound to @var{target}. Data starting at byte
+offset @var{offset} and extending for @var{size} bytes is copied from
+the data store to the memory pointed to by @var{data}. An error is
+thrown if the buffer object is currently mapped, or if @var{offset} and
+@var{size} together define a range beyond the bounds of the buffer
+object's data store.
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{target} is not
+@code{GL_ARRAY_BUFFER}, @code{GL_ELEMENT_ARRAY_BUFFER},
+@code{GL_PIXEL_PACK_BUFFER}, or @code{GL_PIXEL_UNPACK_BUFFER}.
+
+@code{GL_INVALID_VALUE} is generated if @var{offset} or @var{size} is
+negative, or if together they define a region of memory that extends
+beyond the buffer object's allocated data store.
+
+@code{GL_INVALID_OPERATION} is generated if the reserved buffer object
+name 0 is bound to @var{target}.
+
+@code{GL_INVALID_OPERATION} is generated if the buffer object being
+queried is mapped.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glGetBufferSubData} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glGetClipPlane
+@heading return the coefficients of the specified clipping plane
+@heading Parameters
+@table @asis
+@item @var{plane}
+Specifies a clipping plane. The number of clipping planes depends on the
+implementation, but at least six clipping planes are supported. They are
+identified by symbolic names of the form
+@code{GL_CLIP_PLANE}@math{@var{i}} where i ranges from 0 to the value of
+@code{GL_MAX_CLIP_PLANES} - 1.
+
+@item @var{equation}
+Returns four double-precision values that are the coefficients of the
+plane equation of @var{plane} in eye coordinates. The initial value is
+(0, 0, 0, 0).
+
+@end table
+
+@heading Description
+@code{glGetClipPlane} returns in @var{equation} the four coefficients of
+the plane equation for @var{plane}.
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{plane} is not an accepted
+value.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glGetClipPlane} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glGetColorTableParameter
+@heading get color lookup table parameters
+@heading Parameters
+@table @asis
+@item @var{target}
+The target color table. Must be @code{GL_COLOR_TABLE},
+@code{GL_POST_CONVOLUTION_COLOR_TABLE},
+@code{GL_POST_COLOR_MATRIX_COLOR_TABLE}, @code{GL_PROXY_COLOR_TABLE},
+@code{GL_PROXY_POST_CONVOLUTION_COLOR_TABLE}, or
+@code{GL_PROXY_POST_COLOR_MATRIX_COLOR_TABLE}.
+
+@item @var{pname}
+The symbolic name of a color lookup table parameter. Must be one of
+@code{GL_COLOR_TABLE_BIAS}, @code{GL_COLOR_TABLE_SCALE},
+@code{GL_COLOR_TABLE_FORMAT}, @code{GL_COLOR_TABLE_WIDTH},
+@code{GL_COLOR_TABLE_RED_SIZE}, @code{GL_COLOR_TABLE_GREEN_SIZE},
+@code{GL_COLOR_TABLE_BLUE_SIZE}, @code{GL_COLOR_TABLE_ALPHA_SIZE},
+@code{GL_COLOR_TABLE_LUMINANCE_SIZE}, or
+@code{GL_COLOR_TABLE_INTENSITY_SIZE}.
+
+@item @var{params}
+A pointer to an array where the values of the parameter will be stored.
+
+@end table
+
+@heading Description
+Returns parameters specific to color table @var{target}.
+
+When @var{pname} is set to @code{GL_COLOR_TABLE_SCALE} or
+@code{GL_COLOR_TABLE_BIAS}, @code{glGetColorTableParameter} returns the
+color table scale or bias parameters for the table specified by
+@var{target}. For these queries, @var{target} must be set to
+@code{GL_COLOR_TABLE}, @code{GL_POST_CONVOLUTION_COLOR_TABLE}, or
+@code{GL_POST_COLOR_MATRIX_COLOR_TABLE} and @var{params} points to an
+array of four elements, which receive the scale or bias factors for red,
+green, blue, and alpha, in that order.
+
+@code{glGetColorTableParameter} can also be used to retrieve the format
+and size parameters for a color table. For these queries, set
+@var{target} to either the color table target or the proxy color table
+target. The format and size parameters are set by @code{glColorTable}.
+
+The following table lists the format and size parameters that may be
+queried. For each symbolic constant listed below for @var{pname},
+@var{params} must point to an array of the given length and receive the
+values indicated.
+
+
+
+@table @asis
+@item @strong{Parameter}
+@strong{N}, @strong{Meaning}
+
+@item @code{GL_COLOR_TABLE_FORMAT}
+1 , Internal format (e.g., @code{GL_RGBA})
+
+@item @code{GL_COLOR_TABLE_WIDTH}
+1 , Number of elements in table
+
+@item @code{GL_COLOR_TABLE_RED_SIZE}
+1 , Size of red component, in bits
+
+@item @code{GL_COLOR_TABLE_GREEN_SIZE}
+1 , Size of green component
+
+@item @code{GL_COLOR_TABLE_BLUE_SIZE}
+1 , Size of blue component
+
+@item @code{GL_COLOR_TABLE_ALPHA_SIZE}
+1 , Size of alpha component
+
+@item @code{GL_COLOR_TABLE_LUMINANCE_SIZE}
+1 , Size of luminance component
+
+@item @code{GL_COLOR_TABLE_INTENSITY_SIZE}
+1 , Size of intensity component
+
+@end table
+
+
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{target} or @var{pname} is
+not an acceptable value.
+
+@code{GL_INVALID_OPERATION} is generated if
+@code{glGetColorTableParameter} is executed between the execution of
+@code{glBegin} and the corresponding execution of @code{glEnd}.
+
+@end defun
+
+@defun glGetColorTable
+@heading retrieve contents of a color lookup table
+@heading Parameters
+@table @asis
+@item @var{target}
+Must be @code{GL_COLOR_TABLE}, @code{GL_POST_CONVOLUTION_COLOR_TABLE},
+or @code{GL_POST_COLOR_MATRIX_COLOR_TABLE}.
+
+@item @var{format}
+The format of the pixel data in @var{table}. The possible values are
+@code{GL_RED}, @code{GL_GREEN}, @code{GL_BLUE}, @code{GL_ALPHA},
+@code{GL_LUMINANCE}, @code{GL_LUMINANCE_ALPHA}, @code{GL_RGB},
+@code{GL_BGR}, @code{GL_RGBA}, and @code{GL_BGRA}.
+
+@item @var{type}
+The type of the pixel data in @var{table}. Symbolic constants
+@code{GL_UNSIGNED_BYTE}, @code{GL_BYTE}, @code{GL_BITMAP},
+@code{GL_UNSIGNED_SHORT}, @code{GL_SHORT}, @code{GL_UNSIGNED_INT},
+@code{GL_INT}, @code{GL_FLOAT}, @code{GL_UNSIGNED_BYTE_3_3_2},
+@code{GL_UNSIGNED_BYTE_2_3_3_REV}, @code{GL_UNSIGNED_SHORT_5_6_5},
+@code{GL_UNSIGNED_SHORT_5_6_5_REV}, @code{GL_UNSIGNED_SHORT_4_4_4_4},
+@code{GL_UNSIGNED_SHORT_4_4_4_4_REV}, @code{GL_UNSIGNED_SHORT_5_5_5_1},
+@code{GL_UNSIGNED_SHORT_1_5_5_5_REV}, @code{GL_UNSIGNED_INT_8_8_8_8},
+@code{GL_UNSIGNED_INT_8_8_8_8_REV}, @code{GL_UNSIGNED_INT_10_10_10_2},
+and @code{GL_UNSIGNED_INT_2_10_10_10_REV} are accepted.
+
+@item @var{table}
+Pointer to a one-dimensional array of pixel data containing the contents
+of the color table.
+
+@end table
+
+@heading Description
+@code{glGetColorTable} returns in @var{table} the contents of the color
+table specified by @var{target}. No pixel transfer operations are
+performed, but pixel storage modes that are applicable to
+@code{glReadPixels} are performed.
+
+If a non-zero named buffer object is bound to the
+@code{GL_PIXEL_PACK_BUFFER} target (see @code{glBindBuffer}) while a
+histogram table is requested, @var{table} is treated as a byte offset
+into the buffer object's data store.
+
+Color components that are requested in the specified @var{format}, but
+which are not included in the internal format of the color lookup table,
+are returned as zero. The assignments of internal color components to
+the components requested by @var{format} are
+
+@table @asis
+@item @strong{Internal Component}
+@strong{Resulting Component}
+
+@item
+Red
+Red
+
+@item
+Green
+Green
+
+@item
+Blue
+Blue
+
+@item
+Alpha
+Alpha
+
+@item
+Luminance
+Red
+
+@item
+Intensity
+Red
+
+@end table
+
+
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{target} is not one of the
+allowable values.
+
+@code{GL_INVALID_ENUM} is generated if @var{format} is not one of the
+allowable values.
+
+@code{GL_INVALID_ENUM} is generated if @var{type} is not one of the
+allowable values.
+
+@code{GL_INVALID_OPERATION} is generated if @var{type} is one of
+@code{GL_UNSIGNED_BYTE_3_3_2}, @code{GL_UNSIGNED_BYTE_2_3_3_REV},
+@code{GL_UNSIGNED_SHORT_5_6_5}, or @code{GL_UNSIGNED_SHORT_5_6_5_REV}
+and @var{format} is not @code{GL_RGB}.
+
+@code{GL_INVALID_OPERATION} is generated if @var{type} is one of
+@code{GL_UNSIGNED_SHORT_4_4_4_4}, @code{GL_UNSIGNED_SHORT_4_4_4_4_REV},
+@code{GL_UNSIGNED_SHORT_5_5_5_1}, @code{GL_UNSIGNED_SHORT_1_5_5_5_REV},
+@code{GL_UNSIGNED_INT_8_8_8_8}, @code{GL_UNSIGNED_INT_8_8_8_8_REV},
+@code{GL_UNSIGNED_INT_10_10_10_2}, or
+@code{GL_UNSIGNED_INT_2_10_10_10_REV} and @var{format} is neither
+@code{GL_RGBA} nor @code{GL_BGRA}.
+
+@code{GL_INVALID_OPERATION} is generated if a non-zero buffer object
+name is bound to the @code{GL_PIXEL_PACK_BUFFER} target and the buffer
+object's data store is currently mapped.
+
+@code{GL_INVALID_OPERATION} is generated if a non-zero buffer object
+name is bound to the @code{GL_PIXEL_PACK_BUFFER} target and the data
+would be packed to the buffer object such that the memory writes
+required would exceed the data store size.
+
+@code{GL_INVALID_OPERATION} is generated if a non-zero buffer object
+name is bound to the @code{GL_PIXEL_PACK_BUFFER} target and @var{table}
+is not evenly divisible into the number of bytes needed to store in
+memory a datum indicated by @var{type}.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glGetColorTable} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glGetCompressedTexImage
+@heading return a compressed texture image
+@heading Parameters
+@table @asis
+@item @var{target}
+Specifies which texture is to be obtained. @code{GL_TEXTURE_1D},
+@code{GL_TEXTURE_2D}, and
+@code{GL_TEXTURE_3D}@code{GL_TEXTURE_CUBE_MAP_POSITIVE_X},
+@code{GL_TEXTURE_CUBE_MAP_NEGATIVE_X},
+@code{GL_TEXTURE_CUBE_MAP_POSITIVE_Y},
+@code{GL_TEXTURE_CUBE_MAP_NEGATIVE_Y},
+@code{GL_TEXTURE_CUBE_MAP_POSITIVE_Z}, and
+@code{GL_TEXTURE_CUBE_MAP_NEGATIVE_Z} are accepted.
+
+@item @var{lod}
+Specifies the level-of-detail number of the desired image. Level 0 is
+the base image level. Level @math{@var{n}} is the @math{@var{n}}th
+mipmap reduction image.
+
+@item @var{img}
+Returns the compressed texture image.
+
+@end table
+
+@heading Description
+@code{glGetCompressedTexImage} returns the compressed texture image
+associated with @var{target} and @var{lod} into @var{img}. @var{img}
+should be an array of @code{GL_TEXTURE_COMPRESSED_IMAGE_SIZE} bytes.
+@var{target} specifies whether the desired texture image was one
+specified by @code{glTexImage1D} (@code{GL_TEXTURE_1D}),
+@code{glTexImage2D} (@code{GL_TEXTURE_2D} or any of
+@code{GL_TEXTURE_CUBE_MAP_*}), or @code{glTexImage3D}
+(@code{GL_TEXTURE_3D}). @var{lod} specifies the level-of-detail number
+of the desired image.
+
+If a non-zero named buffer object is bound to the
+@code{GL_PIXEL_PACK_BUFFER} target (see @code{glBindBuffer}) while a
+texture image is requested, @var{img} is treated as a byte offset into
+the buffer object's data store.
+
+To minimize errors, first verify that the texture is compressed by
+calling @code{glGetTexLevelParameter} with argument
+@code{GL_TEXTURE_COMPRESSED}. If the texture is compressed, then
+determine the amount of memory required to store the compressed texture
+by calling @code{glGetTexLevelParameter} with argument
+@code{GL_TEXTURE_COMPRESSED_IMAGE_SIZE}. Finally, retrieve the internal
+format of the texture by calling @code{glGetTexLevelParameter} with
+argument @code{GL_TEXTURE_INTERNAL_FORMAT}. To store the texture for
+later use, associate the internal format and size with the retrieved
+texture image. These data can be used by the respective texture or
+subtexture loading routine used for loading @var{target} textures.
+
+@heading Errors
+@code{GL_INVALID_VALUE} is generated if @var{lod} is less than zero or
+greater than the maximum number of LODs permitted by the implementation.
+
+@code{GL_INVALID_OPERATION} is generated if
+@code{glGetCompressedTexImage} is used to retrieve a texture that is in
+an uncompressed internal format.
+
+@code{GL_INVALID_OPERATION} is generated if a non-zero buffer object
+name is bound to the @code{GL_PIXEL_PACK_BUFFER} target and the buffer
+object's data store is currently mapped.
+
+@code{GL_INVALID_OPERATION} is generated if a non-zero buffer object
+name is bound to the @code{GL_PIXEL_PACK_BUFFER} target and the data
+would be packed to the buffer object such that the memory writes
+required would exceed the data store size.
+
+@code{GL_INVALID_OPERATION} is generated if
+@code{glGetCompressedTexImage} is executed between the execution of
+@code{glBegin} and the corresponding execution of @code{glEnd}.
+
+@end defun
+
+@defun glGetConvolutionFilter
+@heading get current 1D or 2D convolution filter kernel
+@heading Parameters
+@table @asis
+@item @var{target}
+The filter to be retrieved. Must be one of @code{GL_CONVOLUTION_1D} or
+@code{GL_CONVOLUTION_2D}.
+
+@item @var{format}
+Format of the output image. Must be one of @code{GL_RED},
+@code{GL_GREEN}, @code{GL_BLUE}, @code{GL_ALPHA}, @code{GL_RGB},
+@code{GL_BGR}, @code{GL_RGBA}, @code{GL_BGRA}, @code{GL_LUMINANCE}, or
+@code{GL_LUMINANCE_ALPHA}.
+
+@item @var{type}
+Data type of components in the output image. Symbolic constants
+@code{GL_UNSIGNED_BYTE}, @code{GL_BYTE}, @code{GL_BITMAP},
+@code{GL_UNSIGNED_SHORT}, @code{GL_SHORT}, @code{GL_UNSIGNED_INT},
+@code{GL_INT}, @code{GL_FLOAT}, @code{GL_UNSIGNED_BYTE_3_3_2},
+@code{GL_UNSIGNED_BYTE_2_3_3_REV}, @code{GL_UNSIGNED_SHORT_5_6_5},
+@code{GL_UNSIGNED_SHORT_5_6_5_REV}, @code{GL_UNSIGNED_SHORT_4_4_4_4},
+@code{GL_UNSIGNED_SHORT_4_4_4_4_REV}, @code{GL_UNSIGNED_SHORT_5_5_5_1},
+@code{GL_UNSIGNED_SHORT_1_5_5_5_REV}, @code{GL_UNSIGNED_INT_8_8_8_8},
+@code{GL_UNSIGNED_INT_8_8_8_8_REV}, @code{GL_UNSIGNED_INT_10_10_10_2},
+and @code{GL_UNSIGNED_INT_2_10_10_10_REV} are accepted.
+
+@item @var{image}
+Pointer to storage for the output image.
+
+@end table
+
+@heading Description
+@code{glGetConvolutionFilter} returns the current 1D or 2D convolution
+filter kernel as an image. The one- or two-dimensional image is placed
+in @var{image} according to the specifications in @var{format} and
+@var{type}. No pixel transfer operations are performed on this image,
+but the relevant pixel storage modes are applied.
+
+If a non-zero named buffer object is bound to the
+@code{GL_PIXEL_PACK_BUFFER} target (see @code{glBindBuffer}) while a
+convolution filter is requested, @var{image} is treated as a byte offset
+into the buffer object's data store.
+
+Color components that are present in @var{format} but not included in
+the internal format of the filter are returned as zero. The assignments
+of internal color components to the components of @var{format} are as
+follows.
+
+@table @asis
+@item @strong{Internal Component}
+@strong{Resulting Component}
+
+@item
+Red
+Red
+
+@item
+Green
+Green
+
+@item
+Blue
+Blue
+
+@item
+Alpha
+Alpha
+
+@item
+Luminance
+Red
+
+@item
+Intensity
+Red
+
+@end table
+
+
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{target} is not one of the
+allowable values.
+
+@code{GL_INVALID_ENUM} is generated if @var{format} is not one of the
+allowable values.
+
+@code{GL_INVALID_ENUM} is generated if @var{type} is not one of the
+allowable values.
+
+@code{GL_INVALID_OPERATION} is generated if @var{type} is one of
+@code{GL_UNSIGNED_BYTE_3_3_2}, @code{GL_UNSIGNED_BYTE_2_3_3_REV},
+@code{GL_UNSIGNED_SHORT_5_6_5}, or @code{GL_UNSIGNED_SHORT_5_6_5_REV}
+and @var{format} is not @code{GL_RGB}.
+
+@code{GL_INVALID_OPERATION} is generated if @var{type} is one of
+@code{GL_UNSIGNED_SHORT_4_4_4_4}, @code{GL_UNSIGNED_SHORT_4_4_4_4_REV},
+@code{GL_UNSIGNED_SHORT_5_5_5_1}, @code{GL_UNSIGNED_SHORT_1_5_5_5_REV},
+@code{GL_UNSIGNED_INT_8_8_8_8}, @code{GL_UNSIGNED_INT_8_8_8_8_REV},
+@code{GL_UNSIGNED_INT_10_10_10_2}, or
+@code{GL_UNSIGNED_INT_2_10_10_10_REV} and @var{format} is neither
+@code{GL_RGBA} nor @code{GL_BGRA}.
+
+@code{GL_INVALID_OPERATION} is generated if a non-zero buffer object
+name is bound to the @code{GL_PIXEL_PACK_BUFFER} target and the buffer
+object's data store is currently mapped.
+
+@code{GL_INVALID_OPERATION} is generated if a non-zero buffer object
+name is bound to the @code{GL_PIXEL_PACK_BUFFER} target and the data
+would be packed to the buffer object such that the memory writes
+required would exceed the data store size.
+
+@code{GL_INVALID_OPERATION} is generated if a non-zero buffer object
+name is bound to the @code{GL_PIXEL_PACK_BUFFER} target and @var{image}
+is not evenly divisible into the number of bytes needed to store in
+memory a datum indicated by @var{type}.
+
+@code{GL_INVALID_OPERATION} is generated if
+@code{glGetConvolutionFilter} is executed between the execution of
+@code{glBegin} and the corresponding execution of @code{glEnd}.
+
+@end defun
+
+@defun glGetConvolutionParameter
+@heading get convolution parameters
+@heading Parameters
+@table @asis
+@item @var{target}
+The filter whose parameters are to be retrieved. Must be one of
+@code{GL_CONVOLUTION_1D}, @code{GL_CONVOLUTION_2D}, or
+@code{GL_SEPARABLE_2D}.
+
+@item @var{pname}
+The parameter to be retrieved. Must be one of
+@code{GL_CONVOLUTION_BORDER_MODE}, @code{GL_CONVOLUTION_BORDER_COLOR},
+@code{GL_CONVOLUTION_FILTER_SCALE}, @code{GL_CONVOLUTION_FILTER_BIAS},
+@code{GL_CONVOLUTION_FORMAT}, @code{GL_CONVOLUTION_WIDTH},
+@code{GL_CONVOLUTION_HEIGHT}, @code{GL_MAX_CONVOLUTION_WIDTH}, or
+@code{GL_MAX_CONVOLUTION_HEIGHT}.
+
+@item @var{params}
+Pointer to storage for the parameters to be retrieved.
+
+@end table
+
+@heading Description
+@code{glGetConvolutionParameter} retrieves convolution parameters.
+@var{target} determines which convolution filter is queried. @var{pname}
+determines which parameter is returned:
+
+@table @asis
+@item @code{GL_CONVOLUTION_BORDER_MODE}
+
+
+The convolution border mode. See @code{glConvolutionParameter} for a
+list of border modes.
+
+@item @code{GL_CONVOLUTION_BORDER_COLOR}
+
+
+The current convolution border color. @var{params} must be a pointer to
+an array of four elements, which will receive the red, green, blue, and
+alpha border colors.
+
+@item @code{GL_CONVOLUTION_FILTER_SCALE}
+
+
+The current filter scale factors. @var{params} must be a pointer to an
+array of four elements, which will receive the red, green, blue, and
+alpha filter scale factors in that order.
+
+@item @code{GL_CONVOLUTION_FILTER_BIAS}
+
+
+The current filter bias factors. @var{params} must be a pointer to an
+array of four elements, which will receive the red, green, blue, and
+alpha filter bias terms in that order.
+
+@item @code{GL_CONVOLUTION_FORMAT}
+
+
+The current internal format. See @code{glConvolutionFilter1D},
+@code{glConvolutionFilter2D}, and @code{glSeparableFilter2D} for lists
+of allowable formats.
+
+@item @code{GL_CONVOLUTION_WIDTH}
+
+
+The current filter image width.
+
+@item @code{GL_CONVOLUTION_HEIGHT}
+
+
+The current filter image height.
+
+@item @code{GL_MAX_CONVOLUTION_WIDTH}
+
+
+The maximum acceptable filter image width.
+
+@item @code{GL_MAX_CONVOLUTION_HEIGHT}
+
+
+The maximum acceptable filter image height.
+
+@end table
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{target} is not one of the
+allowable values.
+
+@code{GL_INVALID_ENUM} is generated if @var{pname} is not one of the
+allowable values.
+
+@code{GL_INVALID_ENUM} is generated if @var{target} is
+@code{GL_CONVOLUTION_1D} and @var{pname} is @code{GL_CONVOLUTION_HEIGHT}
+or @code{GL_MAX_CONVOLUTION_HEIGHT}.
+
+@code{GL_INVALID_OPERATION} is generated if
+@code{glGetConvolutionParameter} is executed between the execution of
+@code{glBegin} and the corresponding execution of @code{glEnd}.
+
+@end defun
+
+@defun glGetError
+@heading return error information
+@heading Description
+@code{glGetError} returns the value of the error flag. Each detectable
+error is assigned a numeric code and symbolic name. When an error
+occurs, the error flag is set to the appropriate error code value. No
+other errors are recorded until @code{glGetError} is called, the error
+code is returned, and the flag is reset to @code{GL_NO_ERROR}. If a call
+to @code{glGetError} returns @code{GL_NO_ERROR}, there has been no
+detectable error since the last call to @code{glGetError}, or since the
+GL was initialized.
+
+To allow for distributed implementations, there may be several error
+flags. If any single error flag has recorded an error, the value of that
+flag is returned and that flag is reset to @code{GL_NO_ERROR} when
+@code{glGetError} is called. If more than one flag has recorded an
+error, @code{glGetError} returns and clears an arbitrary error flag
+value. Thus, @code{glGetError} should always be called in a loop, until
+it returns @code{GL_NO_ERROR}, if all error flags are to be reset.
+
+Initially, all error flags are set to @code{GL_NO_ERROR}.
+
+The following errors are currently defined:
+
+@table @asis
+@item @code{GL_NO_ERROR}
+No error has been recorded. The value of this symbolic constant is
+guaranteed to be 0.
+
+@item @code{GL_INVALID_ENUM}
+An unacceptable value is specified for an enumerated argument. The
+offending command is ignored and has no other side effect than to set
+the error flag.
+
+@item @code{GL_INVALID_VALUE}
+A numeric argument is out of range. The offending command is ignored and
+has no other side effect than to set the error flag.
+
+@item @code{GL_INVALID_OPERATION}
+The specified operation is not allowed in the current state. The
+offending command is ignored and has no other side effect than to set
+the error flag.
+
+@item @code{GL_STACK_OVERFLOW}
+This command would cause a stack overflow. The offending command is
+ignored and has no other side effect than to set the error flag.
+
+@item @code{GL_STACK_UNDERFLOW}
+This command would cause a stack underflow. The offending command is
+ignored and has no other side effect than to set the error flag.
+
+@item @code{GL_OUT_OF_MEMORY}
+There is not enough memory left to execute the command. The state of the
+GL is undefined, except for the state of the error flags, after this
+error is recorded.
+
+@item @code{GL_TABLE_TOO_LARGE}
+The specified table exceeds the implementation's maximum supported table
+size. The offending command is ignored and has no other side effect than
+to set the error flag.
+
+@end table
+
+When an error flag is set, results of a GL operation are undefined only
+if @code{GL_OUT_OF_MEMORY} has occurred. In all other cases, the command
+generating the error is ignored and has no effect on the GL state or
+frame buffer contents. If the generating command returns a value, it
+returns 0. If @code{glGetError} itself generates an error, it returns 0.
+
+@heading Errors
+@code{GL_INVALID_OPERATION} is generated if @code{glGetError} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}. In this case, @code{glGetError} returns 0.
+
+@end defun
+
+@defun glGetHistogramParameter
+@heading get histogram parameters
+@heading Parameters
+@table @asis
+@item @var{target}
+Must be one of @code{GL_HISTOGRAM} or @code{GL_PROXY_HISTOGRAM}.
+
+@item @var{pname}
+The name of the parameter to be retrieved. Must be one of
+@code{GL_HISTOGRAM_WIDTH}, @code{GL_HISTOGRAM_FORMAT},
+@code{GL_HISTOGRAM_RED_SIZE}, @code{GL_HISTOGRAM_GREEN_SIZE},
+@code{GL_HISTOGRAM_BLUE_SIZE}, @code{GL_HISTOGRAM_ALPHA_SIZE},
+@code{GL_HISTOGRAM_LUMINANCE_SIZE}, or @code{GL_HISTOGRAM_SINK}.
+
+@item @var{params}
+Pointer to storage for the returned values.
+
+@end table
+
+@heading Description
+@code{glGetHistogramParameter} is used to query parameter values for the
+current histogram or for a proxy. The histogram state information may be
+queried by calling @code{glGetHistogramParameter} with a @var{target} of
+@code{GL_HISTOGRAM} (to obtain information for the current histogram
+table) or @code{GL_PROXY_HISTOGRAM} (to obtain information from the most
+recent proxy request) and one of the following values for the
+@var{pname} argument:
+
+
+
+@table @asis
+@item @strong{Parameter}
+@strong{Description}
+
+@item @code{GL_HISTOGRAM_WIDTH}
+Histogram table width
+
+@item @code{GL_HISTOGRAM_FORMAT}
+Internal format
+
+@item @code{GL_HISTOGRAM_RED_SIZE}
+Red component counter size, in bits
+
+@item @code{GL_HISTOGRAM_GREEN_SIZE}
+Green component counter size, in bits
+
+@item @code{GL_HISTOGRAM_BLUE_SIZE}
+Blue component counter size, in bits
+
+@item @code{GL_HISTOGRAM_ALPHA_SIZE}
+Alpha component counter size, in bits
+
+@item @code{GL_HISTOGRAM_LUMINANCE_SIZE}
+Luminance component counter size, in bits
+
+@item @code{GL_HISTOGRAM_SINK}
+Value of the @var{sink} parameter
+
+@end table
+
+
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{target} is not one of the
+allowable values.
+
+@code{GL_INVALID_ENUM} is generated if @var{pname} is not one of the
+allowable values.
+
+@code{GL_INVALID_OPERATION} is generated if
+@code{glGetHistogramParameter} is executed between the execution of
+@code{glBegin} and the corresponding execution of @code{glEnd}.
+
+@end defun
+
+@defun glGetHistogram
+@heading get histogram table
+@heading Parameters
+@table @asis
+@item @var{target}
+Must be @code{GL_HISTOGRAM}.
+
+@item @var{reset}
+If @code{GL_TRUE}, each component counter that is actually returned is
+reset to zero. (Other counters are unaffected.) If @code{GL_FALSE}, none
+of the counters in the histogram table is modified.
+
+@item @var{format}
+The format of values to be returned in @var{values}. Must be one of
+@code{GL_RED}, @code{GL_GREEN}, @code{GL_BLUE}, @code{GL_ALPHA},
+@code{GL_RGB}, @code{GL_BGR}, @code{GL_RGBA}, @code{GL_BGRA},
+@code{GL_LUMINANCE}, or @code{GL_LUMINANCE_ALPHA}.
+
+@item @var{type}
+The type of values to be returned in @var{values}. Symbolic constants
+@code{GL_UNSIGNED_BYTE}, @code{GL_BYTE}, @code{GL_BITMAP},
+@code{GL_UNSIGNED_SHORT}, @code{GL_SHORT}, @code{GL_UNSIGNED_INT},
+@code{GL_INT}, @code{GL_FLOAT}, @code{GL_UNSIGNED_BYTE_3_3_2},
+@code{GL_UNSIGNED_BYTE_2_3_3_REV}, @code{GL_UNSIGNED_SHORT_5_6_5},
+@code{GL_UNSIGNED_SHORT_5_6_5_REV}, @code{GL_UNSIGNED_SHORT_4_4_4_4},
+@code{GL_UNSIGNED_SHORT_4_4_4_4_REV}, @code{GL_UNSIGNED_SHORT_5_5_5_1},
+@code{GL_UNSIGNED_SHORT_1_5_5_5_REV}, @code{GL_UNSIGNED_INT_8_8_8_8},
+@code{GL_UNSIGNED_INT_8_8_8_8_REV}, @code{GL_UNSIGNED_INT_10_10_10_2},
+and @code{GL_UNSIGNED_INT_2_10_10_10_REV} are accepted.
+
+@item @var{values}
+A pointer to storage for the returned histogram table.
+
+@end table
+
+@heading Description
+@code{glGetHistogram} returns the current histogram table as a
+one-dimensional image with the same width as the histogram. No pixel
+transfer operations are performed on this image, but pixel storage modes
+that are applicable to 1D images are honored.
+
+If a non-zero named buffer object is bound to the
+@code{GL_PIXEL_PACK_BUFFER} target (see @code{glBindBuffer}) while a
+histogram table is requested, @var{values} is treated as a byte offset
+into the buffer object's data store.
+
+Color components that are requested in the specified @var{format}, but
+which are not included in the internal format of the histogram, are
+returned as zero. The assignments of internal color components to the
+components requested by @var{format} are:
+
+@table @asis
+@item @strong{Internal Component}
+@strong{Resulting Component}
+
+@item
+Red
+Red
+
+@item
+Green
+Green
+
+@item
+Blue
+Blue
+
+@item
+Alpha
+Alpha
+
+@item
+Luminance
+Red
+
+@end table
+
+
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{target} is not
+@code{GL_HISTOGRAM}.
+
+@code{GL_INVALID_ENUM} is generated if @var{format} is not one of the
+allowable values.
+
+@code{GL_INVALID_ENUM} is generated if @var{type} is not one of the
+allowable values.
+
+@code{GL_INVALID_OPERATION} is generated if @var{type} is one of
+@code{GL_UNSIGNED_BYTE_3_3_2}, @code{GL_UNSIGNED_BYTE_2_3_3_REV},
+@code{GL_UNSIGNED_SHORT_5_6_5}, or @code{GL_UNSIGNED_SHORT_5_6_5_REV}
+and @var{format} is not @code{GL_RGB}.
+
+@code{GL_INVALID_OPERATION} is generated if @var{type} is one of
+@code{GL_UNSIGNED_SHORT_4_4_4_4}, @code{GL_UNSIGNED_SHORT_4_4_4_4_REV},
+@code{GL_UNSIGNED_SHORT_5_5_5_1}, @code{GL_UNSIGNED_SHORT_1_5_5_5_REV},
+@code{GL_UNSIGNED_INT_8_8_8_8}, @code{GL_UNSIGNED_INT_8_8_8_8_REV},
+@code{GL_UNSIGNED_INT_10_10_10_2}, or
+@code{GL_UNSIGNED_INT_2_10_10_10_REV} and @var{format} is neither
+@code{GL_RGBA} nor @code{GL_BGRA}.
+
+@code{GL_INVALID_OPERATION} is generated if a non-zero buffer object
+name is bound to the @code{GL_PIXEL_PACK_BUFFER} target and the buffer
+object's data store is currently mapped.
+
+@code{GL_INVALID_OPERATION} is generated if a non-zero buffer object
+name is bound to the @code{GL_PIXEL_PACK_BUFFER} target and the data
+would be packed to the buffer object such that the memory writes
+required would exceed the data store size.
+
+@code{GL_INVALID_OPERATION} is generated if a non-zero buffer object
+name is bound to the @code{GL_PIXEL_PACK_BUFFER} target and @var{values}
+is not evenly divisible into the number of bytes needed to store in
+memory a datum indicated by @var{type}.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glGetHistogram} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glGetLight
+@heading return light source parameter values
+@heading Parameters
+@table @asis
+@item @var{light}
+Specifies a light source. The number of possible lights depends on the
+implementation, but at least eight lights are supported. They are
+identified by symbolic names of the form @code{GL_LIGHT}@math{@var{i}}
+where @math{@var{i}} ranges from 0 to the value of @code{GL_MAX_LIGHTS}
+- 1.
+
+@item @var{pname}
+Specifies a light source parameter for @var{light}. Accepted symbolic
+names are @code{GL_AMBIENT}, @code{GL_DIFFUSE}, @code{GL_SPECULAR},
+@code{GL_POSITION}, @code{GL_SPOT_DIRECTION}, @code{GL_SPOT_EXPONENT},
+@code{GL_SPOT_CUTOFF}, @code{GL_CONSTANT_ATTENUATION},
+@code{GL_LINEAR_ATTENUATION}, and @code{GL_QUADRATIC_ATTENUATION}.
+
+@item @var{params}
+Returns the requested data.
+
+@end table
+
+@heading Description
+@code{glGetLight} returns in @var{params} the value or values of a light
+source parameter. @var{light} names the light and is a symbolic name of
+the form @code{GL_LIGHT}@math{@var{i}} where i ranges from 0 to the
+value of @code{GL_MAX_LIGHTS} - 1. @code{GL_MAX_LIGHTS} is an
+implementation dependent constant that is greater than or equal to
+eight. @var{pname} specifies one of ten light source parameters, again
+by symbolic name.
+
+The following parameters are defined:
+
+@table @asis
+@item @code{GL_AMBIENT}
+@var{params} returns four integer or floating-point values representing
+the ambient intensity of the light source. Integer values, when
+requested, are linearly mapped from the internal floating-point
+representation such that 1.0 maps to the most positive representable
+integer value, and @math{-1.0} maps to the most negative representable
+integer value. If the internal value is outside the range @math{[-1,1]},
+the corresponding integer return value is undefined. The initial value
+is (0, 0, 0, 1).
+
+@item @code{GL_DIFFUSE}
+@var{params} returns four integer or floating-point values representing
+the diffuse intensity of the light source. Integer values, when
+requested, are linearly mapped from the internal floating-point
+representation such that 1.0 maps to the most positive representable
+integer value, and @math{-1.0} maps to the most negative representable
+integer value. If the internal value is outside the range @math{[-1,1]},
+the corresponding integer return value is undefined. The initial value
+for @code{GL_LIGHT0} is (1, 1, 1, 1); for other lights, the initial
+value is (0, 0, 0, 0).
+
+@item @code{GL_SPECULAR}
+@var{params} returns four integer or floating-point values representing
+the specular intensity of the light source. Integer values, when
+requested, are linearly mapped from the internal floating-point
+representation such that 1.0 maps to the most positive representable
+integer value, and @math{-1.0} maps to the most negative representable
+integer value. If the internal value is outside the range @math{[-1,1]},
+the corresponding integer return value is undefined. The initial value
+for @code{GL_LIGHT0} is (1, 1, 1, 1); for other lights, the initial
+value is (0, 0, 0, 0).
+
+@item @code{GL_POSITION}
+@var{params} returns four integer or floating-point values representing
+the position of the light source. Integer values, when requested, are
+computed by rounding the internal floating-point values to the nearest
+integer value. The returned values are those maintained in eye
+coordinates. They will not be equal to the values specified using
+@code{glLight}, unless the modelview matrix was identity at the time
+@code{glLight} was called. The initial value is (0, 0, 1, 0).
+
+@item @code{GL_SPOT_DIRECTION}
+@var{params} returns three integer or floating-point values representing
+the direction of the light source. Integer values, when requested, are
+computed by rounding the internal floating-point values to the nearest
+integer value. The returned values are those maintained in eye
+coordinates. They will not be equal to the values specified using
+@code{glLight}, unless the modelview matrix was identity at the time
+@code{glLight} was called. Although spot direction is normalized before
+being used in the lighting equation, the returned values are the
+transformed versions of the specified values prior to normalization. The
+initial value is @math{(0,0-1)}.
+
+@item @code{GL_SPOT_EXPONENT}
+@var{params} returns a single integer or floating-point value
+representing the spot exponent of the light. An integer value, when
+requested, is computed by rounding the internal floating-point
+representation to the nearest integer. The initial value is 0.
+
+@item @code{GL_SPOT_CUTOFF}
+@var{params} returns a single integer or floating-point value
+representing the spot cutoff angle of the light. An integer value, when
+requested, is computed by rounding the internal floating-point
+representation to the nearest integer. The initial value is 180.
+
+@item @code{GL_CONSTANT_ATTENUATION}
+@var{params} returns a single integer or floating-point value
+representing the constant (not distance-related) attenuation of the
+light. An integer value, when requested, is computed by rounding the
+internal floating-point representation to the nearest integer. The
+initial value is 1.
+
+@item @code{GL_LINEAR_ATTENUATION}
+@var{params} returns a single integer or floating-point value
+representing the linear attenuation of the light. An integer value, when
+requested, is computed by rounding the internal floating-point
+representation to the nearest integer. The initial value is 0.
+
+@item @code{GL_QUADRATIC_ATTENUATION}
+@var{params} returns a single integer or floating-point value
+representing the quadratic attenuation of the light. An integer value,
+when requested, is computed by rounding the internal floating-point
+representation to the nearest integer. The initial value is 0.
+
+@end table
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{light} or @var{pname} is not
+an accepted value.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glGetLight} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glGetMap
+@heading return evaluator parameters
+@heading Parameters
+@table @asis
+@item @var{target}
+Specifies the symbolic name of a map. Accepted values are
+@code{GL_MAP1_COLOR_4}, @code{GL_MAP1_INDEX}, @code{GL_MAP1_NORMAL},
+@code{GL_MAP1_TEXTURE_COORD_1}, @code{GL_MAP1_TEXTURE_COORD_2},
+@code{GL_MAP1_TEXTURE_COORD_3}, @code{GL_MAP1_TEXTURE_COORD_4},
+@code{GL_MAP1_VERTEX_3}, @code{GL_MAP1_VERTEX_4},
+@code{GL_MAP2_COLOR_4}, @code{GL_MAP2_INDEX}, @code{GL_MAP2_NORMAL},
+@code{GL_MAP2_TEXTURE_COORD_1}, @code{GL_MAP2_TEXTURE_COORD_2},
+@code{GL_MAP2_TEXTURE_COORD_3}, @code{GL_MAP2_TEXTURE_COORD_4},
+@code{GL_MAP2_VERTEX_3}, and @code{GL_MAP2_VERTEX_4}.
+
+@item @var{query}
+Specifies which parameter to return. Symbolic names @code{GL_COEFF},
+@code{GL_ORDER}, and @code{GL_DOMAIN} are accepted.
+
+@item @var{v}
+Returns the requested data.
+
+@end table
+
+@heading Description
+@code{glMap1} and @code{glMap2} define evaluators. @code{glGetMap}
+returns evaluator parameters. @var{target} chooses a map, @var{query}
+selects a specific parameter, and @var{v} points to storage where the
+values will be returned.
+
+The acceptable values for the @var{target} parameter are described in
+the @code{glMap1} and @code{glMap2} reference pages.
+
+@var{query} can assume the following values:
+
+@table @asis
+@item @code{GL_COEFF}
+@var{v} returns the control points for the evaluator function.
+One-dimensional evaluators return @math{@var{order}} control points, and
+two-dimensional evaluators return @math{@var{uorder}×@var{vorder}}
+control points. Each control point consists of one, two, three, or four
+integer, single-precision floating-point, or double-precision
+floating-point values, depending on the type of the evaluator. The GL
+returns two-dimensional control points in row-major order, incrementing
+the @math{@var{uorder}} index quickly and the @math{@var{vorder}} index
+after each row. Integer values, when requested, are computed by rounding
+the internal floating-point values to the nearest integer values.
+
+@item @code{GL_ORDER}
+@var{v} returns the order of the evaluator function. One-dimensional
+evaluators return a single value, @math{@var{order}}. The initial value
+is 1. Two-dimensional evaluators return two values, @math{@var{uorder}}
+and @math{@var{vorder}}. The initial value is 1,1.
+
+@item @code{GL_DOMAIN}
+@var{v} returns the linear @math{@var{u}} and @math{@var{v}} mapping
+parameters. One-dimensional evaluators return two values,
+@math{@var{u1}} and @math{@var{u2}}, as specified by @code{glMap1}.
+Two-dimensional evaluators return four values (@math{@var{u1}},
+@math{@var{u2}}, @math{@var{v1}}, and @math{@var{v2}}) as specified by
+@code{glMap2}. Integer values, when requested, are computed by rounding
+the internal floating-point values to the nearest integer values.
+
+@end table
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if either @var{target} or
+@var{query} is not an accepted value.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glGetMap} is executed
+between the execution of @code{glBegin} and the corresponding execution
+of @code{glEnd}.
+
+@end defun
+
+@defun glGetMaterial
+@heading return material parameters
+@heading Parameters
+@table @asis
+@item @var{face}
+Specifies which of the two materials is being queried. @code{GL_FRONT}
+or @code{GL_BACK} are accepted, representing the front and back
+materials, respectively.
+
+@item @var{pname}
+Specifies the material parameter to return. @code{GL_AMBIENT},
+@code{GL_DIFFUSE}, @code{GL_SPECULAR}, @code{GL_EMISSION},
+@code{GL_SHININESS}, and @code{GL_COLOR_INDEXES} are accepted.
+
+@item @var{params}
+Returns the requested data.
+
+@end table
+
+@heading Description
+@code{glGetMaterial} returns in @var{params} the value or values of
+parameter @var{pname} of material @var{face}. Six parameters are
+defined:
+
+@table @asis
+@item @code{GL_AMBIENT}
+@var{params} returns four integer or floating-point values representing
+the ambient reflectance of the material. Integer values, when requested,
+are linearly mapped from the internal floating-point representation such
+that 1.0 maps to the most positive representable integer value, and
+@math{-1.0} maps to the most negative representable integer value. If
+the internal value is outside the range @math{[-1,1]}, the corresponding
+integer return value is undefined. The initial value is (0.2, 0.2, 0.2,
+1.0)
+
+@item @code{GL_DIFFUSE}
+@var{params} returns four integer or floating-point values representing
+the diffuse reflectance of the material. Integer values, when requested,
+are linearly mapped from the internal floating-point representation such
+that 1.0 maps to the most positive representable integer value, and
+@math{-1.0} maps to the most negative representable integer value. If
+the internal value is outside the range @math{[-1,1]}, the corresponding
+integer return value is undefined. The initial value is (0.8, 0.8, 0.8,
+1.0).
+
+@item @code{GL_SPECULAR}
+@var{params} returns four integer or floating-point values representing
+the specular reflectance of the material. Integer values, when
+requested, are linearly mapped from the internal floating-point
+representation such that 1.0 maps to the most positive representable
+integer value, and @math{-1.0} maps to the most negative representable
+integer value. If the internal value is outside the range @math{[-1,1]},
+the corresponding integer return value is undefined. The initial value
+is (0, 0, 0, 1).
+
+@item @code{GL_EMISSION}
+@var{params} returns four integer or floating-point values representing
+the emitted light intensity of the material. Integer values, when
+requested, are linearly mapped from the internal floating-point
+representation such that 1.0 maps to the most positive representable
+integer value, and @math{-1.0} maps to the most negative representable
+integer value. If the internal value is outside the range @math{[-1,1]},
+the corresponding integer return value is undefined. The initial value
+is (0, 0, 0, 1).
+
+@item @code{GL_SHININESS}
+@var{params} returns one integer or floating-point value representing
+the specular exponent of the material. Integer values, when requested,
+are computed by rounding the internal floating-point value to the
+nearest integer value. The initial value is 0.
+
+@item @code{GL_COLOR_INDEXES}
+@var{params} returns three integer or floating-point values representing
+the ambient, diffuse, and specular indices of the material. These
+indices are used only for color index lighting. (All the other
+parameters are used only for RGBA lighting.) Integer values, when
+requested, are computed by rounding the internal floating-point values
+to the nearest integer values.
+
+@end table
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{face} or @var{pname} is not
+an accepted value.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glGetMaterial} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glGetMinmaxParameter
+@heading get minmax parameters
+@heading Parameters
+@table @asis
+@item @var{target}
+Must be @code{GL_MINMAX}.
+
+@item @var{pname}
+The parameter to be retrieved. Must be one of @code{GL_MINMAX_FORMAT} or
+@code{GL_MINMAX_SINK}.
+
+@item @var{params}
+A pointer to storage for the retrieved parameters.
+
+@end table
+
+@heading Description
+@code{glGetMinmaxParameter} retrieves parameters for the current minmax
+table by setting @var{pname} to one of the following values:
+
+
+
+@table @asis
+@item @strong{Parameter}
+@strong{Description}
+
+@item @code{GL_MINMAX_FORMAT}
+Internal format of minmax table
+
+@item @code{GL_MINMAX_SINK}
+Value of the @var{sink} parameter
+
+@end table
+
+
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{target} is not
+@code{GL_MINMAX}.
+
+@code{GL_INVALID_ENUM} is generated if @var{pname} is not one of the
+allowable values.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glGetMinmaxParameter}
+is executed between the execution of @code{glBegin} and the
+corresponding execution of @code{glEnd}.
+
+@end defun
+
+@defun glGetMinmax
+@heading get minimum and maximum pixel values
+@heading Parameters
+@table @asis
+@item @var{target}
+Must be @code{GL_MINMAX}.
+
+@item @var{reset}
+If @code{GL_TRUE}, all entries in the minmax table that are actually
+returned are reset to their initial values. (Other entries are
+unaltered.) If @code{GL_FALSE}, the minmax table is unaltered.
+
+@item @var{format}
+The format of the data to be returned in @var{values}. Must be one of
+@code{GL_RED}, @code{GL_GREEN}, @code{GL_BLUE}, @code{GL_ALPHA},
+@code{GL_RGB}, @code{GL_BGR}, @code{GL_RGBA}, @code{GL_BGRA},
+@code{GL_LUMINANCE}, or @code{GL_LUMINANCE_ALPHA}.
+
+@item @var{types}
+The type of the data to be returned in @var{values}. Symbolic constants
+@code{GL_UNSIGNED_BYTE}, @code{GL_BYTE}, @code{GL_BITMAP},
+@code{GL_UNSIGNED_SHORT}, @code{GL_SHORT}, @code{GL_UNSIGNED_INT},
+@code{GL_INT}, @code{GL_FLOAT}, @code{GL_UNSIGNED_BYTE_3_3_2},
+@code{GL_UNSIGNED_BYTE_2_3_3_REV}, @code{GL_UNSIGNED_SHORT_5_6_5},
+@code{GL_UNSIGNED_SHORT_5_6_5_REV}, @code{GL_UNSIGNED_SHORT_4_4_4_4},
+@code{GL_UNSIGNED_SHORT_4_4_4_4_REV}, @code{GL_UNSIGNED_SHORT_5_5_5_1},
+@code{GL_UNSIGNED_SHORT_1_5_5_5_REV}, @code{GL_UNSIGNED_INT_8_8_8_8},
+@code{GL_UNSIGNED_INT_8_8_8_8_REV}, @code{GL_UNSIGNED_INT_10_10_10_2},
+and @code{GL_UNSIGNED_INT_2_10_10_10_REV} are accepted.
+
+@item @var{values}
+A pointer to storage for the returned values.
+
+@end table
+
+@heading Description
+@code{glGetMinmax} returns the accumulated minimum and maximum pixel
+values (computed on a per-component basis) in a one-dimensional image of
+width 2. The first set of return values are the minima, and the second
+set of return values are the maxima. The format of the return values is
+determined by @var{format}, and their type is determined by @var{types}.
+
+If a non-zero named buffer object is bound to the
+@code{GL_PIXEL_PACK_BUFFER} target (see @code{glBindBuffer}) while
+minimum and maximum pixel values are requested, @var{values} is treated
+as a byte offset into the buffer object's data store.
+
+No pixel transfer operations are performed on the return values, but
+pixel storage modes that are applicable to one-dimensional images are
+performed. Color components that are requested in the specified
+@var{format}, but that are not included in the internal format of the
+minmax table, are returned as zero. The assignment of internal color
+components to the components requested by @var{format} are as follows:
+
+
+
+@table @asis
+@item @strong{Internal Component}
+@strong{Resulting Component}
+
+@item
+Red
+Red
+
+@item
+Green
+Green
+
+@item
+Blue
+Blue
+
+@item
+Alpha
+Alpha
+
+@item
+Luminance
+Red
+
+@end table
+
+If @var{reset} is @code{GL_TRUE}, the minmax table entries corresponding
+to the return values are reset to their initial values. Minimum and
+maximum values that are not returned are not modified, even if
+@var{reset} is @code{GL_TRUE}.
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{target} is not
+@code{GL_MINMAX}.
+
+@code{GL_INVALID_ENUM} is generated if @var{format} is not one of the
+allowable values.
+
+@code{GL_INVALID_ENUM} is generated if @var{types} is not one of the
+allowable values.
+
+@code{GL_INVALID_OPERATION} is generated if @var{types} is one of
+@code{GL_UNSIGNED_BYTE_3_3_2}, @code{GL_UNSIGNED_BYTE_2_3_3_REV},
+@code{GL_UNSIGNED_SHORT_5_6_5}, or @code{GL_UNSIGNED_SHORT_5_6_5_REV}
+and @var{format} is not @code{GL_RGB}.
+
+@code{GL_INVALID_OPERATION} is generated if @var{types} is one of
+@code{GL_UNSIGNED_SHORT_4_4_4_4}, @code{GL_UNSIGNED_SHORT_4_4_4_4_REV},
+@code{GL_UNSIGNED_SHORT_5_5_5_1}, @code{GL_UNSIGNED_SHORT_1_5_5_5_REV},
+@code{GL_UNSIGNED_INT_8_8_8_8}, @code{GL_UNSIGNED_INT_8_8_8_8_REV},
+@code{GL_UNSIGNED_INT_10_10_10_2}, or
+@code{GL_UNSIGNED_INT_2_10_10_10_REV} and @var{format} is neither
+@code{GL_RGBA} nor @code{GL_BGRA}.
+
+@code{GL_INVALID_OPERATION} is generated if a non-zero buffer object
+name is bound to the @code{GL_PIXEL_PACK_BUFFER} target and the buffer
+object's data store is currently mapped.
+
+@code{GL_INVALID_OPERATION} is generated if a non-zero buffer object
+name is bound to the @code{GL_PIXEL_PACK_BUFFER} target and the data
+would be packed to the buffer object such that the memory writes
+required would exceed the data store size.
+
+@code{GL_INVALID_OPERATION} is generated if a non-zero buffer object
+name is bound to the @code{GL_PIXEL_PACK_BUFFER} target and @var{values}
+is not evenly divisible into the number of bytes needed to store in
+memory a datum indicated by @var{type}.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glGetMinmax} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glGetPixelMap
+@heading return the specified pixel map
+@heading Parameters
+@table @asis
+@item @var{map}
+Specifies the name of the pixel map to return. Accepted values are
+@code{GL_PIXEL_MAP_I_TO_I}, @code{GL_PIXEL_MAP_S_TO_S},
+@code{GL_PIXEL_MAP_I_TO_R}, @code{GL_PIXEL_MAP_I_TO_G},
+@code{GL_PIXEL_MAP_I_TO_B}, @code{GL_PIXEL_MAP_I_TO_A},
+@code{GL_PIXEL_MAP_R_TO_R}, @code{GL_PIXEL_MAP_G_TO_G},
+@code{GL_PIXEL_MAP_B_TO_B}, and @code{GL_PIXEL_MAP_A_TO_A}.
+
+@item @var{data}
+Returns the pixel map contents.
+
+@end table
+
+@heading Description
+See the @code{glPixelMap} reference page for a description of the
+acceptable values for the @var{map} parameter. @code{glGetPixelMap}
+returns in @var{data} the contents of the pixel map specified in
+@var{map}. Pixel maps are used during the execution of
+@code{glReadPixels}, @code{glDrawPixels}, @code{glCopyPixels},
+@code{glTexImage1D}, @code{glTexImage2D}, @code{glTexImage3D},
+@code{glTexSubImage1D}, @code{glTexSubImage2D}, @code{glTexSubImage3D},
+@code{glCopyTexImage1D}, @code{glCopyTexImage2D},
+@code{glCopyTexSubImage1D}, @code{glCopyTexSubImage2D}, and
+@code{glCopyTexSubImage3D}. to map color indices, stencil indices, color
+components, and depth components to other values.
+
+If a non-zero named buffer object is bound to the
+@code{GL_PIXEL_PACK_BUFFER} target (see @code{glBindBuffer}) while a
+pixel map is requested, @var{data} is treated as a byte offset into the
+buffer object's data store.
+
+Unsigned integer values, if requested, are linearly mapped from the
+internal fixed or floating-point representation such that 1.0 maps to
+the largest representable integer value, and 0.0 maps to 0. Return
+unsigned integer values are undefined if the map value was not in the
+range [0,1].
+
+To determine the required size of @var{map}, call @code{glGet} with the
+appropriate symbolic constant.
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{map} is not an accepted
+value.
+
+@code{GL_INVALID_OPERATION} is generated if a non-zero buffer object
+name is bound to the @code{GL_PIXEL_PACK_BUFFER} target and the buffer
+object's data store is currently mapped.
+
+@code{GL_INVALID_OPERATION} is generated if a non-zero buffer object
+name is bound to the @code{GL_PIXEL_PACK_BUFFER} target and the data
+would be packed to the buffer object such that the memory writes
+required would exceed the data store size.
+
+@code{GL_INVALID_OPERATION} is generated by @code{glGetPixelMapfv} if a
+non-zero buffer object name is bound to the @code{GL_PIXEL_PACK_BUFFER}
+target and @var{data} is not evenly divisible into the number of bytes
+needed to store in memory a GLfloat datum.
+
+@code{GL_INVALID_OPERATION} is generated by @code{glGetPixelMapuiv} if a
+non-zero buffer object name is bound to the @code{GL_PIXEL_PACK_BUFFER}
+target and @var{data} is not evenly divisible into the number of bytes
+needed to store in memory a GLuint datum.
+
+@code{GL_INVALID_OPERATION} is generated by @code{glGetPixelMapusv} if a
+non-zero buffer object name is bound to the @code{GL_PIXEL_PACK_BUFFER}
+target and @var{data} is not evenly divisible into the number of bytes
+needed to store in memory a GLushort datum.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glGetPixelMap} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glGetPointerv
+@heading return the address of the specified pointer
+@heading Parameters
+@table @asis
+@item @var{pname}
+Specifies the array or buffer pointer to be returned. Symbolic constants
+@code{GL_COLOR_ARRAY_POINTER}, @code{GL_EDGE_FLAG_ARRAY_POINTER},
+@code{GL_FOG_COORD_ARRAY_POINTER}, @code{GL_FEEDBACK_BUFFER_POINTER},
+@code{GL_INDEX_ARRAY_POINTER}, @code{GL_NORMAL_ARRAY_POINTER},
+@code{GL_SECONDARY_COLOR_ARRAY_POINTER},
+@code{GL_SELECTION_BUFFER_POINTER},
+@code{GL_TEXTURE_COORD_ARRAY_POINTER}, or @code{GL_VERTEX_ARRAY_POINTER}
+are accepted.
+
+@item @var{params}
+Returns the pointer value specified by @var{pname}.
+
+@end table
+
+@heading Description
+@code{glGetPointerv} returns pointer information. @var{pname} is a
+symbolic constant indicating the pointer to be returned, and
+@var{params} is a pointer to a location in which to place the returned
+data.
+
+For all @var{pname} arguments except @code{GL_FEEDBACK_BUFFER_POINTER}
+and @code{GL_SELECTION_BUFFER_POINTER}, if a non-zero named buffer
+object was bound to the @code{GL_ARRAY_BUFFER} target (see
+@code{glBindBuffer}) when the desired pointer was previously specified,
+the pointer returned is a byte offset into the buffer object's data
+store. Buffer objects are only available in OpenGL versions 1.5 and
+greater.
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{pname} is not an accepted
+value.
+
+@end defun
+
+@defun glGetPolygonStipple
+@heading return the polygon stipple pattern
+@heading Parameters
+@table @asis
+@item @var{pattern}
+Returns the stipple pattern. The initial value is all 1's.
+
+@end table
+
+@heading Description
+@code{glGetPolygonStipple} returns to @var{pattern} a @math{32×32}
+polygon stipple pattern. The pattern is packed into memory as if
+@code{glReadPixels} with both @var{height} and @var{width} of 32,
+@var{type} of @code{GL_BITMAP}, and @var{format} of
+@code{GL_COLOR_INDEX} were called, and the stipple pattern were stored
+in an internal @math{32×32} color index buffer. Unlike
+@code{glReadPixels}, however, pixel transfer operations (shift, offset,
+pixel map) are not applied to the returned stipple image.
+
+If a non-zero named buffer object is bound to the
+@code{GL_PIXEL_PACK_BUFFER} target (see @code{glBindBuffer}) while a
+polygon stipple pattern is requested, @var{pattern} is treated as a byte
+offset into the buffer object's data store.
+
+@heading Errors
+@code{GL_INVALID_OPERATION} is generated if a non-zero buffer object
+name is bound to the @code{GL_PIXEL_PACK_BUFFER} target and the buffer
+object's data store is currently mapped.
+
+@code{GL_INVALID_OPERATION} is generated if a non-zero buffer object
+name is bound to the @code{GL_PIXEL_PACK_BUFFER} target and the data
+would be packed to the buffer object such that the memory writes
+required would exceed the data store size.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glGetPolygonStipple}
+is executed between the execution of @code{glBegin} and the
+corresponding execution of @code{glEnd}.
+
+@end defun
+
+@defun glGetProgramInfoLog
+@heading Returns the information log for a program object
+@heading Parameters
+@table @asis
+@item @var{program}
+Specifies the program object whose information log is to be queried.
+
+@item @var{maxLength}
+Specifies the size of the character buffer for storing the returned
+information log.
+
+@item @var{length}
+Returns the length of the string returned in @var{infoLog} (excluding
+the null terminator).
+
+@item @var{infoLog}
+Specifies an array of characters that is used to return the information
+log.
+
+@end table
+
+@heading Description
+@code{glGetProgramInfoLog} returns the information log for the specified
+program object. The information log for a program object is modified
+when the program object is linked or validated. The string that is
+returned will be null terminated.
+
+@code{glGetProgramInfoLog} returns in @var{infoLog} as much of the
+information log as it can, up to a maximum of @var{maxLength}
+characters. The number of characters actually returned, excluding the
+null termination character, is specified by @var{length}. If the length
+of the returned string is not required, a value of @code{NULL} can be
+passed in the @var{length} argument. The size of the buffer required to
+store the returned information log can be obtained by calling
+@code{glGetProgram} with the value @code{GL_INFO_LOG_LENGTH}.
+
+The information log for a program object is either an empty string, or a
+string containing information about the last link operation, or a string
+containing information about the last validation operation. It may
+contain diagnostic messages, warning messages, and other information.
+When a program object is created, its information log will be a string
+of length 0.
+
+@heading Errors
+@code{GL_INVALID_VALUE} is generated if @var{program} is not a value
+generated by OpenGL.
+
+@code{GL_INVALID_OPERATION} is generated if @var{program} is not a
+program object.
+
+@code{GL_INVALID_VALUE} is generated if @var{maxLength} is less than 0.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glGetProgramInfoLog}
+is executed between the execution of @code{glBegin} and the
+corresponding execution of @code{glEnd}.
+
+@end defun
+
+@defun glGetProgramiv
+@heading Returns a parameter from a program object
+@heading Parameters
+@table @asis
+@item @var{program}
+Specifies the program object to be queried.
+
+@item @var{pname}
+Specifies the object parameter. Accepted symbolic names are
+@code{GL_DELETE_STATUS}, @code{GL_LINK_STATUS},
+@code{GL_VALIDATE_STATUS}, @code{GL_INFO_LOG_LENGTH},
+@code{GL_ATTACHED_SHADERS}, @code{GL_ACTIVE_ATTRIBUTES},
+@code{GL_ACTIVE_ATTRIBUTE_MAX_LENGTH}, @code{GL_ACTIVE_UNIFORMS},
+@code{GL_ACTIVE_UNIFORM_MAX_LENGTH}.
+
+@item @var{params}
+Returns the requested object parameter.
+
+@end table
+
+@heading Description
+@code{glGetProgram} returns in @var{params} the value of a parameter for
+a specific program object. The following parameters are defined:
+
+@table @asis
+@item @code{GL_DELETE_STATUS}
+
+
+@var{params} returns @code{GL_TRUE} if @var{program} is currently
+flagged for deletion, and @code{GL_FALSE} otherwise.
+
+@item @code{GL_LINK_STATUS}
+
+
+@var{params} returns @code{GL_TRUE} if the last link operation on
+@var{program} was successful, and @code{GL_FALSE} otherwise.
+
+@item @code{GL_VALIDATE_STATUS}
+
+
+@var{params} returns @code{GL_TRUE} or if the last validation operation
+on @var{program} was successful, and @code{GL_FALSE} otherwise.
+
+@item @code{GL_INFO_LOG_LENGTH}
+
+
+@var{params} returns the number of characters in the information log for
+@var{program} including the null termination character (i.e., the size
+of the character buffer required to store the information log). If
+@var{program} has no information log, a value of 0 is returned.
+
+@item @code{GL_ATTACHED_SHADERS}
+
+
+@var{params} returns the number of shader objects attached to
+@var{program}.
+
+@item @code{GL_ACTIVE_ATTRIBUTES}
+
+
+@var{params} returns the number of active attribute variables for
+@var{program}.
+
+@item @code{GL_ACTIVE_ATTRIBUTE_MAX_LENGTH}
+
+
+@var{params} returns the length of the longest active attribute name for
+@var{program}, including the null termination character (i.e., the size
+of the character buffer required to store the longest attribute name).
+If no active attributes exist, 0 is returned.
+
+@item @code{GL_ACTIVE_UNIFORMS}
+
+
+@var{params} returns the number of active uniform variables for
+@var{program}.
+
+@item @code{GL_ACTIVE_UNIFORM_MAX_LENGTH}
+
+
+@var{params} returns the length of the longest active uniform variable
+name for @var{program}, including the null termination character (i.e.,
+the size of the character buffer required to store the longest uniform
+variable name). If no active uniform variables exist, 0 is returned.
+
+@end table
+
+@heading Errors
+@code{GL_INVALID_VALUE} is generated if @var{program} is not a value
+generated by OpenGL.
+
+@code{GL_INVALID_OPERATION} is generated if @var{program} does not refer
+to a program object.
+
+@code{GL_INVALID_ENUM} is generated if @var{pname} is not an accepted
+value.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glGetProgram} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glGetQueryiv
+@heading return parameters of a query object target
+@heading Parameters
+@table @asis
+@item @var{target}
+Specifies a query object target. Must be @code{GL_SAMPLES_PASSED}.
+
+@item @var{pname}
+Specifies the symbolic name of a query object target parameter. Accepted
+values are @code{GL_CURRENT_QUERY} or @code{GL_QUERY_COUNTER_BITS}.
+
+@item @var{params}
+Returns the requested data.
+
+@end table
+
+@heading Description
+@code{glGetQueryiv} returns in @var{params} a selected parameter of the
+query object target specified by @var{target}.
+
+@var{pname} names a specific query object target parameter. When
+@var{target} is @code{GL_SAMPLES_PASSED}, @var{pname} can be as follows:
+
+@table @asis
+@item @code{GL_CURRENT_QUERY}
+@var{params} returns the name of the currently active occlusion query
+object. If no occlusion query is active, 0 is returned. The initial
+value is 0.
+
+@item @code{GL_QUERY_COUNTER_BITS}
+@var{params} returns the number of bits in the query counter used to
+accumulate passing samples. If the number of bits returned is 0, the
+implementation does not support a query counter, and the results
+obtained from @code{glGetQueryObject} are useless.
+
+@end table
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{target} or @var{pname} is
+not an accepted value.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glGetQueryiv} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glGetQueryObject
+@heading return parameters of a query object
+@heading Parameters
+@table @asis
+@item @var{id}
+Specifies the name of a query object.
+
+@item @var{pname}
+Specifies the symbolic name of a query object parameter. Accepted values
+are @code{GL_QUERY_RESULT} or @code{GL_QUERY_RESULT_AVAILABLE}.
+
+@item @var{params}
+Returns the requested data.
+
+@end table
+
+@heading Description
+@code{glGetQueryObject} returns in @var{params} a selected parameter of
+the query object specified by @var{id}.
+
+@var{pname} names a specific query object parameter. @var{pname} can be
+as follows:
+
+@table @asis
+@item @code{GL_QUERY_RESULT}
+@var{params} returns the value of the query object's passed samples
+counter. The initial value is 0.
+
+@item @code{GL_QUERY_RESULT_AVAILABLE}
+@var{params} returns whether the passed samples counter is immediately
+available. If a delay would occur waiting for the query result,
+@code{GL_FALSE} is returned. Otherwise, @code{GL_TRUE} is returned,
+which also indicates that the results of all previous queries are
+available as well.
+
+@end table
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{pname} is not an accepted
+value.
+
+@code{GL_INVALID_OPERATION} is generated if @var{id} is not the name of
+a query object.
+
+@code{GL_INVALID_OPERATION} is generated if @var{id} is the name of a
+currently active query object.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glGetQueryObject} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glGetSeparableFilter
+@heading get separable convolution filter kernel images
+@heading Parameters
+@table @asis
+@item @var{target}
+The separable filter to be retrieved. Must be @code{GL_SEPARABLE_2D}.
+
+@item @var{format}
+Format of the output images. Must be one of @code{GL_RED},
+@code{GL_GREEN}, @code{GL_BLUE}, @code{GL_ALPHA}, @code{GL_RGB},
+@code{GL_BGR}@code{GL_RGBA}, @code{GL_BGRA}, @code{GL_LUMINANCE}, or
+@code{GL_LUMINANCE_ALPHA}.
+
+@item @var{type}
+Data type of components in the output images. Symbolic constants
+@code{GL_UNSIGNED_BYTE}, @code{GL_BYTE}, @code{GL_BITMAP},
+@code{GL_UNSIGNED_SHORT}, @code{GL_SHORT}, @code{GL_UNSIGNED_INT},
+@code{GL_INT}, @code{GL_FLOAT}, @code{GL_UNSIGNED_BYTE_3_3_2},
+@code{GL_UNSIGNED_BYTE_2_3_3_REV}, @code{GL_UNSIGNED_SHORT_5_6_5},
+@code{GL_UNSIGNED_SHORT_5_6_5_REV}, @code{GL_UNSIGNED_SHORT_4_4_4_4},
+@code{GL_UNSIGNED_SHORT_4_4_4_4_REV}, @code{GL_UNSIGNED_SHORT_5_5_5_1},
+@code{GL_UNSIGNED_SHORT_1_5_5_5_REV}, @code{GL_UNSIGNED_INT_8_8_8_8},
+@code{GL_UNSIGNED_INT_8_8_8_8_REV}, @code{GL_UNSIGNED_INT_10_10_10_2},
+and @code{GL_UNSIGNED_INT_2_10_10_10_REV} are accepted.
+
+@item @var{row}
+Pointer to storage for the row filter image.
+
+@item @var{column}
+Pointer to storage for the column filter image.
+
+@item @var{span}
+Pointer to storage for the span filter image (currently unused).
+
+@end table
+
+@heading Description
+@code{glGetSeparableFilter} returns the two one-dimensional filter
+kernel images for the current separable 2D convolution filter. The row
+image is placed in @var{row} and the column image is placed in
+@var{column} according to the specifications in @var{format} and
+@var{type}. (In the current implementation, @var{span} is not affected
+in any way.) No pixel transfer operations are performed on the images,
+but the relevant pixel storage modes are applied.
+
+If a non-zero named buffer object is bound to the
+@code{GL_PIXEL_PACK_BUFFER} target (see @code{glBindBuffer}) while a
+separable convolution filter is requested, @var{row}, @var{column}, and
+@var{span} are treated as a byte offset into the buffer object's data
+store.
+
+Color components that are present in @var{format} but not included in
+the internal format of the filters are returned as zero. The assignments
+of internal color components to the components of @var{format} are as
+follows:
+
+
+
+@table @asis
+@item @strong{Internal Component}
+@strong{Resulting Component}
+
+@item
+Red
+Red
+
+@item
+Green
+Green
+
+@item
+Blue
+Blue
+
+@item
+Alpha
+Alpha
+
+@item
+Luminance
+Red
+
+@item
+Intensity
+Red
+
+@end table
+
+
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{target} is not
+@code{GL_SEPARABLE_2D}.
+
+@code{GL_INVALID_ENUM} is generated if @var{format} is not one of the
+allowable values.
+
+@code{GL_INVALID_ENUM} is generated if @var{type} is not one of the
+allowable values.
+
+@code{GL_INVALID_OPERATION} is generated if @var{type} is one of
+@code{GL_UNSIGNED_BYTE_3_3_2}, @code{GL_UNSIGNED_BYTE_2_3_3_REV},
+@code{GL_UNSIGNED_SHORT_5_6_5}, or @code{GL_UNSIGNED_SHORT_5_6_5_REV}
+and @var{format} is not @code{GL_RGB}.
+
+@code{GL_INVALID_OPERATION} is generated if @var{type} is one of
+@code{GL_UNSIGNED_SHORT_4_4_4_4}, @code{GL_UNSIGNED_SHORT_4_4_4_4_REV},
+@code{GL_UNSIGNED_SHORT_5_5_5_1}, @code{GL_UNSIGNED_SHORT_1_5_5_5_REV},
+@code{GL_UNSIGNED_INT_8_8_8_8}, @code{GL_UNSIGNED_INT_8_8_8_8_REV},
+@code{GL_UNSIGNED_INT_10_10_10_2}, or
+@code{GL_UNSIGNED_INT_2_10_10_10_REV} and @var{format} is neither
+@code{GL_RGBA} nor @code{GL_BGRA}.
+
+@code{GL_INVALID_OPERATION} is generated if a non-zero buffer object
+name is bound to the @code{GL_PIXEL_PACK_BUFFER} target and the buffer
+object's data store is currently mapped.
+
+@code{GL_INVALID_OPERATION} is generated if a non-zero buffer object
+name is bound to the @code{GL_PIXEL_PACK_BUFFER} target and the data
+would be packed to the buffer object such that the memory writes
+required would exceed the data store size.
+
+@code{GL_INVALID_OPERATION} is generated if a non-zero buffer object
+name is bound to the @code{GL_PIXEL_PACK_BUFFER} target and @var{row} or
+@var{column} is not evenly divisible into the number of bytes needed to
+store in memory a datum indicated by @var{type}.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glGetSeparableFilter}
+is executed between the execution of @code{glBegin} and the
+corresponding execution of @code{glEnd}.
+
+@end defun
+
+@defun glGetShaderInfoLog
+@heading Returns the information log for a shader object
+@heading Parameters
+@table @asis
+@item @var{shader}
+Specifies the shader object whose information log is to be queried.
+
+@item @var{maxLength}
+Specifies the size of the character buffer for storing the returned
+information log.
+
+@item @var{length}
+Returns the length of the string returned in @var{infoLog} (excluding
+the null terminator).
+
+@item @var{infoLog}
+Specifies an array of characters that is used to return the information
+log.
+
+@end table
+
+@heading Description
+@code{glGetShaderInfoLog} returns the information log for the specified
+shader object. The information log for a shader object is modified when
+the shader is compiled. The string that is returned will be null
+terminated.
+
+@code{glGetShaderInfoLog} returns in @var{infoLog} as much of the
+information log as it can, up to a maximum of @var{maxLength}
+characters. The number of characters actually returned, excluding the
+null termination character, is specified by @var{length}. If the length
+of the returned string is not required, a value of @code{NULL} can be
+passed in the @var{length} argument. The size of the buffer required to
+store the returned information log can be obtained by calling
+@code{glGetShader} with the value @code{GL_INFO_LOG_LENGTH}.
+
+The information log for a shader object is a string that may contain
+diagnostic messages, warning messages, and other information about the
+last compile operation. When a shader object is created, its information
+log will be a string of length 0.
+
+@heading Errors
+@code{GL_INVALID_VALUE} is generated if @var{shader} is not a value
+generated by OpenGL.
+
+@code{GL_INVALID_OPERATION} is generated if @var{shader} is not a shader
+object.
+
+@code{GL_INVALID_VALUE} is generated if @var{maxLength} is less than 0.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glGetShaderInfoLog} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glGetShaderSource
+@heading Returns the source code string from a shader object
+@heading Parameters
+@table @asis
+@item @var{shader}
+Specifies the shader object to be queried.
+
+@item @var{bufSize}
+Specifies the size of the character buffer for storing the returned
+source code string.
+
+@item @var{length}
+Returns the length of the string returned in @var{source} (excluding the
+null terminator).
+
+@item @var{source}
+Specifies an array of characters that is used to return the source code
+string.
+
+@end table
+
+@heading Description
+@code{glGetShaderSource} returns the concatenation of the source code
+strings from the shader object specified by @var{shader}. The source
+code strings for a shader object are the result of a previous call to
+@code{glShaderSource}. The string returned by the function will be null
+terminated.
+
+@code{glGetShaderSource} returns in @var{source} as much of the source
+code string as it can, up to a maximum of @var{bufSize} characters. The
+number of characters actually returned, excluding the null termination
+character, is specified by @var{length}. If the length of the returned
+string is not required, a value of @code{NULL} can be passed in the
+@var{length} argument. The size of the buffer required to store the
+returned source code string can be obtained by calling
+@code{glGetShader} with the value @code{GL_SHADER_SOURCE_LENGTH}.
+
+@heading Errors
+@code{GL_INVALID_VALUE} is generated if @var{shader} is not a value
+generated by OpenGL.
+
+@code{GL_INVALID_OPERATION} is generated if @var{shader} is not a shader
+object.
+
+@code{GL_INVALID_VALUE} is generated if @var{bufSize} is less than 0.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glGetShaderSource} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glGetShaderiv
+@heading Returns a parameter from a shader object
+@heading Parameters
+@table @asis
+@item @var{shader}
+Specifies the shader object to be queried.
+
+@item @var{pname}
+Specifies the object parameter. Accepted symbolic names are
+@code{GL_SHADER_TYPE}, @code{GL_DELETE_STATUS},
+@code{GL_COMPILE_STATUS}, @code{GL_INFO_LOG_LENGTH},
+@code{GL_SHADER_SOURCE_LENGTH}.
+
+@item @var{params}
+Returns the requested object parameter.
+
+@end table
+
+@heading Description
+@code{glGetShader} returns in @var{params} the value of a parameter for
+a specific shader object. The following parameters are defined:
+
+@table @asis
+@item @code{GL_SHADER_TYPE}
+@var{params} returns @code{GL_VERTEX_SHADER} if @var{shader} is a vertex
+shader object, and @code{GL_FRAGMENT_SHADER} if @var{shader} is a
+fragment shader object.
+
+@item @code{GL_DELETE_STATUS}
+@var{params} returns @code{GL_TRUE} if @var{shader} is currently flagged
+for deletion, and @code{GL_FALSE} otherwise.
+
+@item @code{GL_COMPILE_STATUS}
+@var{params} returns @code{GL_TRUE} if the last compile operation on
+@var{shader} was successful, and @code{GL_FALSE} otherwise.
+
+@item @code{GL_INFO_LOG_LENGTH}
+@var{params} returns the number of characters in the information log for
+@var{shader} including the null termination character (i.e., the size of
+the character buffer required to store the information log). If
+@var{shader} has no information log, a value of 0 is returned.
+
+@item @code{GL_SHADER_SOURCE_LENGTH}
+@var{params} returns the length of the concatenation of the source
+strings that make up the shader source for the @var{shader}, including
+the null termination character. (i.e., the size of the character buffer
+required to store the shader source). If no source code exists, 0 is
+returned.
+
+@end table
+
+@heading Errors
+@code{GL_INVALID_VALUE} is generated if @var{shader} is not a value
+generated by OpenGL.
+
+@code{GL_INVALID_OPERATION} is generated if @var{shader} does not refer
+to a shader object.
+
+@code{GL_INVALID_ENUM} is generated if @var{pname} is not an accepted
+value.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glGetShader} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glGetString
+@heading return a string describing the current GL connection
+@heading Parameters
+@table @asis
+@item @var{name}
+Specifies a symbolic constant, one of @code{GL_VENDOR},
+@code{GL_RENDERER}, @code{GL_VERSION},
+@code{GL_SHADING_LANGUAGE_VERSION}, or @code{GL_EXTENSIONS}.
+
+@end table
+
+@heading Description
+@code{glGetString} returns a pointer to a static string describing some
+aspect of the current GL connection. @var{name} can be one of the
+following:
+
+@table @asis
+@item @code{GL_VENDOR}
+
+
+Returns the company responsible for this GL implementation. This name
+does not change from release to release.
+
+@item @code{GL_RENDERER}
+
+
+Returns the name of the renderer. This name is typically specific to a
+particular configuration of a hardware platform. It does not change from
+release to release.
+
+@item @code{GL_VERSION}
+
+
+Returns a version or release number.
+
+@item @code{GL_SHADING_LANGUAGE_VERSION}
+
+
+Returns a version or release number for the shading language.
+
+@item @code{GL_EXTENSIONS}
+
+
+Returns a space-separated list of supported extensions to GL.
+
+@end table
+
+Because the GL does not include queries for the performance
+characteristics of an implementation, some applications are written to
+recognize known platforms and modify their GL usage based on known
+performance characteristics of these platforms. Strings @code{GL_VENDOR}
+and @code{GL_RENDERER} together uniquely specify a platform. They do not
+change from release to release and should be used by
+platform-recognition algorithms.
+
+Some applications want to make use of features that are not part of the
+standard GL. These features may be implemented as extensions to the
+standard GL. The @code{GL_EXTENSIONS} string is a space-separated list
+of supported GL extensions. (Extension names never contain a space
+character.)
+
+The @code{GL_VERSION} and @code{GL_SHADING_LANGUAGE_VERSION} strings
+begin with a version number. The version number uses one of these forms:
+
+@var{major_number.minor_number}@var{major_number.minor_number.release_number}
+
+Vendor-specific information may follow the version number. Its format
+depends on the implementation, but a space always separates the version
+number and the vendor-specific information.
+
+All strings are null-terminated.
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{name} is not an accepted
+value.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glGetString} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glGetTexEnv
+@heading return texture environment parameters
+@heading Parameters
+@table @asis
+@item @var{target}
+Specifies a texture environment. May be @code{GL_TEXTURE_ENV},
+@code{GL_TEXTURE_FILTER_CONTROL}, or @code{GL_POINT_SPRITE}.
+
+@item @var{pname}
+Specifies the symbolic name of a texture environment parameter. Accepted
+values are @code{GL_TEXTURE_ENV_MODE}, @code{GL_TEXTURE_ENV_COLOR},
+@code{GL_TEXTURE_LOD_BIAS}, @code{GL_COMBINE_RGB},
+@code{GL_COMBINE_ALPHA}, @code{GL_SRC0_RGB}, @code{GL_SRC1_RGB},
+@code{GL_SRC2_RGB}, @code{GL_SRC0_ALPHA}, @code{GL_SRC1_ALPHA},
+@code{GL_SRC2_ALPHA}, @code{GL_OPERAND0_RGB}, @code{GL_OPERAND1_RGB},
+@code{GL_OPERAND2_RGB}, @code{GL_OPERAND0_ALPHA},
+@code{GL_OPERAND1_ALPHA}, @code{GL_OPERAND2_ALPHA}, @code{GL_RGB_SCALE},
+@code{GL_ALPHA_SCALE}, or @code{GL_COORD_REPLACE}.
+
+@item @var{params}
+Returns the requested data.
+
+@end table
+
+@heading Description
+@code{glGetTexEnv} returns in @var{params} selected values of a texture
+environment that was specified with @code{glTexEnv}. @var{target}
+specifies a texture environment.
+
+When @var{target} is @code{GL_TEXTURE_FILTER_CONTROL}, @var{pname} must
+be @code{GL_TEXTURE_LOD_BIAS}. When @var{target} is
+@code{GL_POINT_SPRITE}, @var{pname} must be @code{GL_COORD_REPLACE}.
+When @var{target} is @code{GL_TEXTURE_ENV}, @var{pname} can be
+@code{GL_TEXTURE_ENV_MODE}, @code{GL_TEXTURE_ENV_COLOR},
+@code{GL_COMBINE_RGB}, @code{GL_COMBINE_ALPHA}, @code{GL_RGB_SCALE},
+@code{GL_ALPHA_SCALE}, @code{GL_SRC0_RGB}, @code{GL_SRC1_RGB},
+@code{GL_SRC2_RGB}, @code{GL_SRC0_ALPHA}, @code{GL_SRC1_ALPHA}, or
+@code{GL_SRC2_ALPHA}.
+
+@var{pname} names a specific texture environment parameter, as follows:
+
+@table @asis
+@item @code{GL_TEXTURE_ENV_MODE}
+@var{params} returns the single-valued texture environment mode, a
+symbolic constant. The initial value is @code{GL_MODULATE}.
+
+@item @code{GL_TEXTURE_ENV_COLOR}
+@var{params} returns four integer or floating-point values that are the
+texture environment color. Integer values, when requested, are linearly
+mapped from the internal floating-point representation such that 1.0
+maps to the most positive representable integer, and @math{-1.0} maps to
+the most negative representable integer. The initial value is (0, 0, 0,
+0).
+
+@item @code{GL_TEXTURE_LOD_BIAS}
+@var{params} returns a single floating-point value that is the texture
+level-of-detail bias. The initial value is 0.
+
+@item @code{GL_COMBINE_RGB}
+@var{params} returns a single symbolic constant value representing the
+current RGB combine mode. The initial value is @code{GL_MODULATE}.
+
+@item @code{GL_COMBINE_ALPHA}
+@var{params} returns a single symbolic constant value representing the
+current alpha combine mode. The initial value is @code{GL_MODULATE}.
+
+@item @code{GL_SRC0_RGB}
+@var{params} returns a single symbolic constant value representing the
+texture combiner zero's RGB source. The initial value is
+@code{GL_TEXTURE}.
+
+@item @code{GL_SRC1_RGB}
+@var{params} returns a single symbolic constant value representing the
+texture combiner one's RGB source. The initial value is
+@code{GL_PREVIOUS}.
+
+@item @code{GL_SRC2_RGB}
+@var{params} returns a single symbolic constant value representing the
+texture combiner two's RGB source. The initial value is
+@code{GL_CONSTANT}.
+
+@item @code{GL_SRC0_ALPHA}
+@var{params} returns a single symbolic constant value representing the
+texture combiner zero's alpha source. The initial value is
+@code{GL_TEXTURE}.
+
+@item @code{GL_SRC1_ALPHA}
+@var{params} returns a single symbolic constant value representing the
+texture combiner one's alpha source. The initial value is
+@code{GL_PREVIOUS}.
+
+@item @code{GL_SRC2_ALPHA}
+@var{params} returns a single symbolic constant value representing the
+texture combiner two's alpha source. The initial value is
+@code{GL_CONSTANT}.
+
+@item @code{GL_OPERAND0_RGB}
+@var{params} returns a single symbolic constant value representing the
+texture combiner zero's RGB operand. The initial value is
+@code{GL_SRC_COLOR}.
+
+@item @code{GL_OPERAND1_RGB}
+@var{params} returns a single symbolic constant value representing the
+texture combiner one's RGB operand. The initial value is
+@code{GL_SRC_COLOR}.
+
+@item @code{GL_OPERAND2_RGB}
+@var{params} returns a single symbolic constant value representing the
+texture combiner two's RGB operand. The initial value is
+@code{GL_SRC_ALPHA}.
+
+@item @code{GL_OPERAND0_ALPHA}
+@var{params} returns a single symbolic constant value representing the
+texture combiner zero's alpha operand. The initial value is
+@code{GL_SRC_ALPHA}.
+
+@item @code{GL_OPERAND1_ALPHA}
+@var{params} returns a single symbolic constant value representing the
+texture combiner one's alpha operand. The initial value is
+@code{GL_SRC_ALPHA}.
+
+@item @code{GL_OPERAND2_ALPHA}
+@var{params} returns a single symbolic constant value representing the
+texture combiner two's alpha operand. The initial value is
+@code{GL_SRC_ALPHA}.
+
+@item @code{GL_RGB_SCALE}
+@var{params} returns a single floating-point value representing the
+current RGB texture combiner scaling factor. The initial value is 1.0.
+
+@item @code{GL_ALPHA_SCALE}
+@var{params} returns a single floating-point value representing the
+current alpha texture combiner scaling factor. The initial value is 1.0.
+
+@item @code{GL_COORD_REPLACE}
+@var{params} returns a single boolean value representing the current
+point sprite texture coordinate replacement enable state. The initial
+value is @code{GL_FALSE}.
+
+@end table
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{target} or @var{pname} is
+not an accepted value.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glGetTexEnv} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glGetTexGen
+@heading return texture coordinate generation parameters
+@heading Parameters
+@table @asis
+@item @var{coord}
+Specifies a texture coordinate. Must be @code{GL_S}, @code{GL_T},
+@code{GL_R}, or @code{GL_Q}.
+
+@item @var{pname}
+Specifies the symbolic name of the value(s) to be returned. Must be
+either @code{GL_TEXTURE_GEN_MODE} or the name of one of the texture
+generation plane equations: @code{GL_OBJECT_PLANE} or
+@code{GL_EYE_PLANE}.
+
+@item @var{params}
+Returns the requested data.
+
+@end table
+
+@heading Description
+@code{glGetTexGen} returns in @var{params} selected parameters of a
+texture coordinate generation function that was specified using
+@code{glTexGen}. @var{coord} names one of the (@var{s}, @var{t},
+@var{r}, @var{q}) texture coordinates, using the symbolic constant
+@code{GL_S}, @code{GL_T}, @code{GL_R}, or @code{GL_Q}.
+
+@var{pname} specifies one of three symbolic names:
+
+@table @asis
+@item @code{GL_TEXTURE_GEN_MODE}
+@var{params} returns the single-valued texture generation function, a
+symbolic constant. The initial value is @code{GL_EYE_LINEAR}.
+
+@item @code{GL_OBJECT_PLANE}
+@var{params} returns the four plane equation coefficients that specify
+object linear-coordinate generation. Integer values, when requested, are
+mapped directly from the internal floating-point representation.
+
+@item @code{GL_EYE_PLANE}
+@var{params} returns the four plane equation coefficients that specify
+eye linear-coordinate generation. Integer values, when requested, are
+mapped directly from the internal floating-point representation. The
+returned values are those maintained in eye coordinates. They are not
+equal to the values specified using @code{glTexGen}, unless the
+modelview matrix was identity when @code{glTexGen} was called.
+
+@end table
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{coord} or @var{pname} is not
+an accepted value.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glGetTexGen} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glGetTexImage
+@heading return a texture image
+@heading Parameters
+@table @asis
+@item @var{target}
+Specifies which texture is to be obtained. @code{GL_TEXTURE_1D},
+@code{GL_TEXTURE_2D}, @code{GL_TEXTURE_3D},
+@code{GL_TEXTURE_CUBE_MAP_POSITIVE_X},
+@code{GL_TEXTURE_CUBE_MAP_NEGATIVE_X},
+@code{GL_TEXTURE_CUBE_MAP_POSITIVE_Y},
+@code{GL_TEXTURE_CUBE_MAP_NEGATIVE_Y},
+@code{GL_TEXTURE_CUBE_MAP_POSITIVE_Z}, and
+@code{GL_TEXTURE_CUBE_MAP_NEGATIVE_Z} are accepted.
+
+@item @var{level}
+Specifies the level-of-detail number of the desired image. Level 0 is
+the base image level. Level @math{@var{n}} is the @math{@var{n}}th
+mipmap reduction image.
+
+@item @var{format}
+Specifies a pixel format for the returned data. The supported formats
+are @code{GL_RED}, @code{GL_GREEN}, @code{GL_BLUE}, @code{GL_ALPHA},
+@code{GL_RGB}, @code{GL_BGR}, @code{GL_RGBA}, @code{GL_BGRA},
+@code{GL_LUMINANCE}, and @code{GL_LUMINANCE_ALPHA}.
+
+@item @var{type}
+Specifies a pixel type for the returned data. The supported types are
+@code{GL_UNSIGNED_BYTE}, @code{GL_BYTE}, @code{GL_UNSIGNED_SHORT},
+@code{GL_SHORT}, @code{GL_UNSIGNED_INT}, @code{GL_INT}, @code{GL_FLOAT},
+@code{GL_UNSIGNED_BYTE_3_3_2}, @code{GL_UNSIGNED_BYTE_2_3_3_REV},
+@code{GL_UNSIGNED_SHORT_5_6_5}, @code{GL_UNSIGNED_SHORT_5_6_5_REV},
+@code{GL_UNSIGNED_SHORT_4_4_4_4}, @code{GL_UNSIGNED_SHORT_4_4_4_4_REV},
+@code{GL_UNSIGNED_SHORT_5_5_5_1}, @code{GL_UNSIGNED_SHORT_1_5_5_5_REV},
+@code{GL_UNSIGNED_INT_8_8_8_8}, @code{GL_UNSIGNED_INT_8_8_8_8_REV},
+@code{GL_UNSIGNED_INT_10_10_10_2}, and
+@code{GL_UNSIGNED_INT_2_10_10_10_REV}.
+
+@item @var{img}
+Returns the texture image. Should be a pointer to an array of the type
+specified by @var{type}.
+
+@end table
+
+@heading Description
+@code{glGetTexImage} returns a texture image into @var{img}.
+@var{target} specifies whether the desired texture image is one
+specified by @code{glTexImage1D} (@code{GL_TEXTURE_1D}),
+@code{glTexImage2D} (@code{GL_TEXTURE_2D} or any of
+@code{GL_TEXTURE_CUBE_MAP_*}), or @code{glTexImage3D}
+(@code{GL_TEXTURE_3D}). @var{level} specifies the level-of-detail number
+of the desired image. @var{format} and @var{type} specify the format and
+type of the desired image array. See the reference pages
+@code{glTexImage1D} and @code{glDrawPixels} for a description of the
+acceptable values for the @var{format} and @var{type} parameters,
+respectively.
+
+If a non-zero named buffer object is bound to the
+@code{GL_PIXEL_PACK_BUFFER} target (see @code{glBindBuffer}) while a
+texture image is requested, @var{img} is treated as a byte offset into
+the buffer object's data store.
+
+To understand the operation of @code{glGetTexImage}, consider the
+selected internal four-component texture image to be an RGBA color
+buffer the size of the image. The semantics of @code{glGetTexImage} are
+then identical to those of @code{glReadPixels}, with the exception that
+no pixel transfer operations are performed, when called with the same
+@var{format} and @var{type}, with @var{x} and @var{y} set to 0,
+@var{width} set to the width of the texture image (including border if
+one was specified), and @var{height} set to 1 for 1D images, or to the
+height of the texture image (including border if one was specified) for
+2D images. Because the internal texture image is an RGBA image, pixel
+formats @code{GL_COLOR_INDEX}, @code{GL_STENCIL_INDEX}, and
+@code{GL_DEPTH_COMPONENT} are not accepted, and pixel type
+@code{GL_BITMAP} is not accepted.
+
+If the selected texture image does not contain four components, the
+following mappings are applied. Single-component textures are treated as
+RGBA buffers with red set to the single-component value, green set to 0,
+blue set to 0, and alpha set to 1. Two-component textures are treated as
+RGBA buffers with red set to the value of component zero, alpha set to
+the value of component one, and green and blue set to 0. Finally,
+three-component textures are treated as RGBA buffers with red set to
+component zero, green set to component one, blue set to component two,
+and alpha set to 1.
+
+To determine the required size of @var{img}, use
+@code{glGetTexLevelParameter} to determine the dimensions of the
+internal texture image, then scale the required number of pixels by the
+storage required for each pixel, based on @var{format} and @var{type}.
+Be sure to take the pixel storage parameters into account, especially
+@code{GL_PACK_ALIGNMENT}.
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{target}, @var{format}, or
+@var{type} is not an accepted value.
+
+@code{GL_INVALID_VALUE} is generated if @var{level} is less than 0.
+
+@code{GL_INVALID_VALUE} may be generated if @var{level} is greater than
+@math{@var{log}_2(@var{max},)}, where @math{@var{max}} is the returned
+value of @code{GL_MAX_TEXTURE_SIZE}.
+
+@code{GL_INVALID_OPERATION} is returned if @var{type} is one of
+@code{GL_UNSIGNED_BYTE_3_3_2}, @code{GL_UNSIGNED_BYTE_2_3_3_REV},
+@code{GL_UNSIGNED_SHORT_5_6_5}, or @code{GL_UNSIGNED_SHORT_5_6_5_REV}
+and @var{format} is not @code{GL_RGB}.
+
+@code{GL_INVALID_OPERATION} is returned if @var{type} is one of
+@code{GL_UNSIGNED_SHORT_4_4_4_4}, @code{GL_UNSIGNED_SHORT_4_4_4_4_REV},
+@code{GL_UNSIGNED_SHORT_5_5_5_1}, @code{GL_UNSIGNED_SHORT_1_5_5_5_REV},
+@code{GL_UNSIGNED_INT_8_8_8_8}, @code{GL_UNSIGNED_INT_8_8_8_8_REV},
+@code{GL_UNSIGNED_INT_10_10_10_2}, or
+@code{GL_UNSIGNED_INT_2_10_10_10_REV}, and @var{format} is neither
+@code{GL_RGBA} or @code{GL_BGRA}.
+
+@code{GL_INVALID_OPERATION} is generated if a non-zero buffer object
+name is bound to the @code{GL_PIXEL_PACK_BUFFER} target and the buffer
+object's data store is currently mapped.
+
+@code{GL_INVALID_OPERATION} is generated if a non-zero buffer object
+name is bound to the @code{GL_PIXEL_PACK_BUFFER} target and the data
+would be packed to the buffer object such that the memory writes
+required would exceed the data store size.
+
+@code{GL_INVALID_OPERATION} is generated if a non-zero buffer object
+name is bound to the @code{GL_PIXEL_PACK_BUFFER} target and @var{img} is
+not evenly divisible into the number of bytes needed to store in memory
+a datum indicated by @var{type}.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glGetTexImage} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glGetTexLevelParameter
+@heading return texture parameter values for a specific level of detail
+@heading Parameters
+@table @asis
+@item @var{target}
+Specifies the symbolic name of the target texture, either
+@code{GL_TEXTURE_1D}, @code{GL_TEXTURE_2D}, @code{GL_TEXTURE_3D},
+@code{GL_PROXY_TEXTURE_1D}, @code{GL_PROXY_TEXTURE_2D},
+@code{GL_PROXY_TEXTURE_3D}, @code{GL_TEXTURE_CUBE_MAP_POSITIVE_X},
+@code{GL_TEXTURE_CUBE_MAP_NEGATIVE_X},
+@code{GL_TEXTURE_CUBE_MAP_POSITIVE_Y},
+@code{GL_TEXTURE_CUBE_MAP_NEGATIVE_Y},
+@code{GL_TEXTURE_CUBE_MAP_POSITIVE_Z},
+@code{GL_TEXTURE_CUBE_MAP_NEGATIVE_Z}, or
+@code{GL_PROXY_TEXTURE_CUBE_MAP}.
+
+@item @var{level}
+Specifies the level-of-detail number of the desired image. Level 0 is
+the base image level. Level @math{@var{n}} is the @math{@var{n}}th
+mipmap reduction image.
+
+@item @var{pname}
+Specifies the symbolic name of a texture parameter.
+@code{GL_TEXTURE_WIDTH}, @code{GL_TEXTURE_HEIGHT},
+@code{GL_TEXTURE_DEPTH}, @code{GL_TEXTURE_INTERNAL_FORMAT},
+@code{GL_TEXTURE_BORDER}, @code{GL_TEXTURE_RED_SIZE},
+@code{GL_TEXTURE_GREEN_SIZE}, @code{GL_TEXTURE_BLUE_SIZE},
+@code{GL_TEXTURE_ALPHA_SIZE}, @code{GL_TEXTURE_LUMINANCE_SIZE},
+@code{GL_TEXTURE_INTENSITY_SIZE}, @code{GL_TEXTURE_DEPTH_SIZE},
+@code{GL_TEXTURE_COMPRESSED}, and
+@code{GL_TEXTURE_COMPRESSED_IMAGE_SIZE} are accepted.
+
+@item @var{params}
+Returns the requested data.
+
+@end table
+
+@heading Description
+@code{glGetTexLevelParameter} returns in @var{params} texture parameter
+values for a specific level-of-detail value, specified as @var{level}.
+@var{target} defines the target texture, either @code{GL_TEXTURE_1D},
+@code{GL_TEXTURE_2D}, @code{GL_TEXTURE_3D}, @code{GL_PROXY_TEXTURE_1D},
+@code{GL_PROXY_TEXTURE_2D}, @code{GL_PROXY_TEXTURE_3D},
+@code{GL_TEXTURE_CUBE_MAP_POSITIVE_X},
+@code{GL_TEXTURE_CUBE_MAP_NEGATIVE_X},
+@code{GL_TEXTURE_CUBE_MAP_POSITIVE_Y},
+@code{GL_TEXTURE_CUBE_MAP_NEGATIVE_Y},
+@code{GL_TEXTURE_CUBE_MAP_POSITIVE_Z},
+@code{GL_TEXTURE_CUBE_MAP_NEGATIVE_Z}, or
+@code{GL_PROXY_TEXTURE_CUBE_MAP}.
+
+@code{GL_MAX_TEXTURE_SIZE}, and @code{GL_MAX_3D_TEXTURE_SIZE} are not
+really descriptive enough. It has to report the largest square texture
+image that can be accommodated with mipmaps and borders, but a long
+skinny texture, or a texture without mipmaps and borders, may easily fit
+in texture memory. The proxy targets allow the user to more accurately
+query whether the GL can accommodate a texture of a given configuration.
+If the texture cannot be accommodated, the texture state variables,
+which may be queried with @code{glGetTexLevelParameter}, are set to 0.
+If the texture can be accommodated, the texture state values will be set
+as they would be set for a non-proxy target.
+
+@var{pname} specifies the texture parameter whose value or values will
+be returned.
+
+The accepted parameter names are as follows:
+
+@table @asis
+@item @code{GL_TEXTURE_WIDTH}
+
+
+@var{params} returns a single value, the width of the texture image.
+This value includes the border of the texture image. The initial value
+is 0.
+
+@item @code{GL_TEXTURE_HEIGHT}
+
+
+@var{params} returns a single value, the height of the texture image.
+This value includes the border of the texture image. The initial value
+is 0.
+
+@item @code{GL_TEXTURE_DEPTH}
+
+
+@var{params} returns a single value, the depth of the texture image.
+This value includes the border of the texture image. The initial value
+is 0.
+
+@item @code{GL_TEXTURE_INTERNAL_FORMAT}
+
+
+@var{params} returns a single value, the internal format of the texture
+image.
+
+@item @code{GL_TEXTURE_BORDER}
+
+
+@var{params} returns a single value, the width in pixels of the border
+of the texture image. The initial value is 0.
+
+@item @code{GL_TEXTURE_RED_SIZE},
+@item @code{GL_TEXTURE_GREEN_SIZE},
+@item @code{GL_TEXTURE_BLUE_SIZE},
+@item @code{GL_TEXTURE_ALPHA_SIZE},
+@item @code{GL_TEXTURE_LUMINANCE_SIZE},
+@item @code{GL_TEXTURE_INTENSITY_SIZE},
+@item @code{GL_TEXTURE_DEPTH_SIZE}
+
+
+The internal storage resolution of an individual component. The
+resolution chosen by the GL will be a close match for the resolution
+requested by the user with the component argument of
+@code{glTexImage1D}, @code{glTexImage2D}, @code{glTexImage3D},
+@code{glCopyTexImage1D}, and @code{glCopyTexImage2D}. The initial value
+is 0.
+
+@item @code{GL_TEXTURE_COMPRESSED}
+
+
+@var{params} returns a single boolean value indicating if the texture
+image is stored in a compressed internal format. The initiali value is
+@code{GL_FALSE}.
+
+@item @code{GL_TEXTURE_COMPRESSED_IMAGE_SIZE}
+
+
+@var{params} returns a single integer value, the number of unsigned
+bytes of the compressed texture image that would be returned from
+@code{glGetCompressedTexImage}.
+
+@end table
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{target} or @var{pname} is
+not an accepted value.
+
+@code{GL_INVALID_VALUE} is generated if @var{level} is less than 0.
+
+@code{GL_INVALID_VALUE} may be generated if @var{level} is greater than
+@math{@var{log}_2}@var{max}, where @var{max} is the returned value of
+@code{GL_MAX_TEXTURE_SIZE}.
+
+@code{GL_INVALID_OPERATION} is generated if
+@code{glGetTexLevelParameter} is executed between the execution of
+@code{glBegin} and the corresponding execution of @code{glEnd}.
+
+@code{GL_INVALID_OPERATION} is generated if
+@code{GL_TEXTURE_COMPRESSED_IMAGE_SIZE} is queried on texture images
+with an uncompressed internal format or on proxy targets.
+
+@end defun
+
+@defun glGetTexParameter
+@heading return texture parameter values
+@heading Parameters
+@table @asis
+@item @var{target}
+Specifies the symbolic name of the target texture. @code{GL_TEXTURE_1D},
+@code{GL_TEXTURE_2D}, @code{GL_TEXTURE_3D}, and
+@code{GL_TEXTURE_CUBE_MAP} are accepted.
+
+@item @var{pname}
+Specifies the symbolic name of a texture parameter.
+@code{GL_TEXTURE_MAG_FILTER}, @code{GL_TEXTURE_MIN_FILTER},
+@code{GL_TEXTURE_MIN_LOD}, @code{GL_TEXTURE_MAX_LOD},
+@code{GL_TEXTURE_BASE_LEVEL}, @code{GL_TEXTURE_MAX_LEVEL},
+@code{GL_TEXTURE_WRAP_S}, @code{GL_TEXTURE_WRAP_T},
+@code{GL_TEXTURE_WRAP_R}, @code{GL_TEXTURE_BORDER_COLOR},
+@code{GL_TEXTURE_PRIORITY}, @code{GL_TEXTURE_RESIDENT},
+@code{GL_TEXTURE_COMPARE_MODE}, @code{GL_TEXTURE_COMPARE_FUNC},
+@code{GL_DEPTH_TEXTURE_MODE}, and @code{GL_GENERATE_MIPMAP} are
+accepted.
+
+@item @var{params}
+Returns the texture parameters.
+
+@end table
+
+@heading Description
+@code{glGetTexParameter} returns in @var{params} the value or values of
+the texture parameter specified as @var{pname}. @var{target} defines the
+target texture, either @code{GL_TEXTURE_1D}, @code{GL_TEXTURE_2D},
+@code{GL_TEXTURE_3D}, or @code{GL_TEXTURE_CUBE_MAP}, to specify one-,
+two-, or three-dimensional or cube-mapped texturing. @var{pname} accepts
+the same symbols as @code{glTexParameter}, with the same
+interpretations:
+
+@table @asis
+@item @code{GL_TEXTURE_MAG_FILTER}
+Returns the single-valued texture magnification filter, a symbolic
+constant. The initial value is @code{GL_LINEAR}.
+
+@item @code{GL_TEXTURE_MIN_FILTER}
+Returns the single-valued texture minification filter, a symbolic
+constant. The initial value is @code{GL_NEAREST_MIPMAP_LINEAR}.
+
+@item @code{GL_TEXTURE_MIN_LOD}
+Returns the single-valued texture minimum level-of-detail value. The
+initial value is @math{-1000}.
+
+@item @code{GL_TEXTURE_MAX_LOD}
+Returns the single-valued texture maximum level-of-detail value. The
+initial value is 1000.
+
+@item @code{GL_TEXTURE_BASE_LEVEL}
+Returns the single-valued base texture mipmap level. The initial value
+is 0.
+
+@item @code{GL_TEXTURE_MAX_LEVEL}
+Returns the single-valued maximum texture mipmap array level. The
+initial value is 1000.
+
+@item @code{GL_TEXTURE_WRAP_S}
+Returns the single-valued wrapping function for texture coordinate
+@math{@var{s}}, a symbolic constant. The initial value is
+@code{GL_REPEAT}.
+
+@item @code{GL_TEXTURE_WRAP_T}
+Returns the single-valued wrapping function for texture coordinate
+@math{@var{t}}, a symbolic constant. The initial value is
+@code{GL_REPEAT}.
+
+@item @code{GL_TEXTURE_WRAP_R}
+Returns the single-valued wrapping function for texture coordinate
+@math{@var{r}}, a symbolic constant. The initial value is
+@code{GL_REPEAT}.
+
+@item @code{GL_TEXTURE_BORDER_COLOR}
+Returns four integer or floating-point numbers that comprise the RGBA
+color of the texture border. Floating-point values are returned in the
+range @math{[0,1]}. Integer values are returned as a linear mapping of
+the internal floating-point representation such that 1.0 maps to the
+most positive representable integer and @math{-1.0} maps to the most
+negative representable integer. The initial value is (0, 0, 0, 0).
+
+@item @code{GL_TEXTURE_PRIORITY}
+Returns the residence priority of the target texture (or the named
+texture bound to it). The initial value is 1. See
+@code{glPrioritizeTextures}.
+
+@item @code{GL_TEXTURE_RESIDENT}
+Returns the residence status of the target texture. If the value
+returned in @var{params} is @code{GL_TRUE}, the texture is resident in
+texture memory. See @code{glAreTexturesResident}.
+
+@item @code{GL_TEXTURE_COMPARE_MODE}
+Returns a single-valued texture comparison mode, a symbolic constant.
+The initial value is @code{GL_NONE}. See @code{glTexParameter}.
+
+@item @code{GL_TEXTURE_COMPARE_FUNC}
+Returns a single-valued texture comparison function, a symbolic
+constant. The initial value is @code{GL_LEQUAL}. See
+@code{glTexParameter}.
+
+@item @code{GL_DEPTH_TEXTURE_MODE}
+Returns a single-valued texture format indicating how the depth values
+should be converted into color components. The initial value is
+@code{GL_LUMINANCE}. See @code{glTexParameter}.
+
+@item @code{GL_GENERATE_MIPMAP}
+Returns a single boolean value indicating if automatic mipmap level
+updates are enabled. See @code{glTexParameter}.
+
+@end table
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{target} or @var{pname} is
+not an accepted value.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glGetTexParameter} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glGetUniformLocation
+@heading Returns the location of a uniform variable
+@heading Parameters
+@table @asis
+@item @var{program}
+Specifies the program object to be queried.
+
+@item @var{name}
+Points to a null terminated string containing the name of the uniform
+variable whose location is to be queried.
+
+@end table
+
+@heading Description
+@code{glGetUniformLocation } returns an integer that represents the
+location of a specific uniform variable within a program object.
+@var{name} must be a null terminated string that contains no white
+space. @var{name} must be an active uniform variable name in
+@var{program} that is not a structure, an array of structures, or a
+subcomponent of a vector or a matrix. This function returns -1 if
+@var{name} does not correspond to an active uniform variable in
+@var{program} or if @var{name} starts with the reserved prefix "gl_".
+
+Uniform variables that are structures or arrays of structures may be
+queried by calling @code{glGetUniformLocation} for each field within the
+structure. The array element operator "[]" and the structure field
+operator "." may be used in @var{name} in order to select elements
+within an array or fields within a structure. The result of using these
+operators is not allowed to be another structure, an array of
+structures, or a subcomponent of a vector or a matrix. Except if the
+last part of @var{name} indicates a uniform variable array, the location
+of the first element of an array can be retrieved by using the name of
+the array, or by using the name appended by "[0]".
+
+The actual locations assigned to uniform variables are not known until
+the program object is linked successfully. After linking has occurred,
+the command @code{glGetUniformLocation} can be used to obtain the
+location of a uniform variable. This location value can then be passed
+to @code{glUniform} to set the value of the uniform variable or to
+@code{glGetUniform} in order to query the current value of the uniform
+variable. After a program object has been linked successfully, the index
+values for uniform variables remain fixed until the next link command
+occurs. Uniform variable locations and values can only be queried after
+a link if the link was successful.
+
+@heading Errors
+@code{GL_INVALID_VALUE} is generated if @var{program} is not a value
+generated by OpenGL.
+
+@code{GL_INVALID_OPERATION} is generated if @var{program} is not a
+program object.
+
+@code{GL_INVALID_OPERATION} is generated if @var{program} has not been
+successfully linked.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glGetUniformLocation}
+is executed between the execution of @code{glBegin} and the
+corresponding execution of @code{glEnd}.
+
+@end defun
+
+@defun glGetUniformfv
+@heading Returns the value of a uniform variable
+@heading Parameters
+@table @asis
+@item @var{program}
+Specifies the program object to be queried.
+
+@item @var{location}
+Specifies the location of the uniform variable to be queried.
+
+@item @var{params}
+Returns the value of the specified uniform variable.
+
+@end table
+
+@heading Description
+@code{glGetUniform} returns in @var{params} the value(s) of the
+specified uniform variable. The type of the uniform variable specified
+by @var{location} determines the number of values returned. If the
+uniform variable is defined in the shader as a boolean, int, or float, a
+single value will be returned. If it is defined as a vec2, ivec2, or
+bvec2, two values will be returned. If it is defined as a vec3, ivec3,
+or bvec3, three values will be returned, and so on. To query values
+stored in uniform variables declared as arrays, call @code{glGetUniform}
+for each element of the array. To query values stored in uniform
+variables declared as structures, call @code{glGetUniform} for each
+field in the structure. The values for uniform variables declared as a
+matrix will be returned in column major order.
+
+The locations assigned to uniform variables are not known until the
+program object is linked. After linking has occurred, the command
+@code{glGetUniformLocation} can be used to obtain the location of a
+uniform variable. This location value can then be passed to
+@code{glGetUniform} in order to query the current value of the uniform
+variable. After a program object has been linked successfully, the index
+values for uniform variables remain fixed until the next link command
+occurs. The uniform variable values can only be queried after a link if
+the link was successful.
+
+@heading Errors
+@code{GL_INVALID_VALUE} is generated if @var{program} is not a value
+generated by OpenGL.
+
+@code{GL_INVALID_OPERATION} is generated if @var{program} is not a
+program object.
+
+@code{GL_INVALID_OPERATION} is generated if @var{program} has not been
+successfully linked.
+
+@code{GL_INVALID_OPERATION} is generated if @var{location} does not
+correspond to a valid uniform variable location for the specified
+program object.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glGetUniform} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glGetVertexAttribPointerv
+@heading return the address of the specified generic vertex attribute pointer
+@heading Parameters
+@table @asis
+@item @var{index}
+Specifies the generic vertex attribute parameter to be returned.
+
+@item @var{pname}
+Specifies the symbolic name of the generic vertex attribute parameter to
+be returned. Must be @code{GL_VERTEX_ATTRIB_ARRAY_POINTER}.
+
+@item @var{pointer}
+Returns the pointer value.
+
+@end table
+
+@heading Description
+@code{glGetVertexAttribPointerv} returns pointer information.
+@var{index} is the generic vertex attribute to be queried, @var{pname}
+is a symbolic constant indicating the pointer to be returned, and
+@var{params} is a pointer to a location in which to place the returned
+data.
+
+If a non-zero named buffer object was bound to the
+@code{GL_ARRAY_BUFFER} target (see @code{glBindBuffer}) when the desired
+pointer was previously specified, the @var{pointer} returned is a byte
+offset into the buffer object's data store.
+
+@heading Errors
+@code{GL_INVALID_VALUE} is generated if @var{index} is greater than or
+equal to @code{GL_MAX_VERTEX_ATTRIBS}.
+
+@code{GL_INVALID_ENUM} is generated if @var{pname} is not an accepted
+value.
+
+@end defun
+
+@defun glGetVertexAttribdv
+@heading Return a generic vertex attribute parameter
+@heading Parameters
+@table @asis
+@item @var{index}
+Specifies the generic vertex attribute parameter to be queried.
+
+@item @var{pname}
+Specifies the symbolic name of the vertex attribute parameter to be
+queried. Accepted values are
+@code{GL_VERTEX_ATTRIB_ARRAY_BUFFER_BINDING},
+@code{GL_VERTEX_ATTRIB_ARRAY_ENABLED},
+@code{GL_VERTEX_ATTRIB_ARRAY_SIZE},
+@code{GL_VERTEX_ATTRIB_ARRAY_STRIDE},
+@code{GL_VERTEX_ATTRIB_ARRAY_TYPE},
+@code{GL_VERTEX_ATTRIB_ARRAY_NORMALIZED}, or
+@code{GL_CURRENT_VERTEX_ATTRIB}.
+
+@item @var{params}
+Returns the requested data.
+
+@end table
+
+@heading Description
+@code{glGetVertexAttrib} returns in @var{params} the value of a generic
+vertex attribute parameter. The generic vertex attribute to be queried
+is specified by @var{index}, and the parameter to be queried is
+specified by @var{pname}.
+
+The accepted parameter names are as follows:
+
+@table @asis
+@item @code{GL_VERTEX_ATTRIB_ARRAY_BUFFER_BINDING}
+
+
+@var{params} returns a single value, the name of the buffer object
+currently bound to the binding point corresponding to generic vertex
+attribute array @var{index}. If no buffer object is bound, 0 is
+returned. The initial value is 0.
+
+@item @code{GL_VERTEX_ATTRIB_ARRAY_ENABLED}
+
+
+@var{params} returns a single value that is non-zero (true) if the
+vertex attribute array for @var{index} is enabled and 0 (false) if it is
+disabled. The initial value is @code{GL_FALSE}.
+
+@item @code{GL_VERTEX_ATTRIB_ARRAY_SIZE}
+
+
+@var{params} returns a single value, the size of the vertex attribute
+array for @var{index}. The size is the number of values for each element
+of the vertex attribute array, and it will be 1, 2, 3, or 4. The initial
+value is 4.
+
+@item @code{GL_VERTEX_ATTRIB_ARRAY_STRIDE}
+
+
+@var{params} returns a single value, the array stride for (number of
+bytes between successive elements in) the vertex attribute array for
+@var{index}. A value of 0 indicates that the array elements are stored
+sequentially in memory. The initial value is 0.
+
+@item @code{GL_VERTEX_ATTRIB_ARRAY_TYPE}
+
+
+@var{params} returns a single value, a symbolic constant indicating the
+array type for the vertex attribute array for @var{index}. Possible
+values are @code{GL_BYTE}, @code{GL_UNSIGNED_BYTE}, @code{GL_SHORT},
+@code{GL_UNSIGNED_SHORT}, @code{GL_INT}, @code{GL_UNSIGNED_INT},
+@code{GL_FLOAT}, and @code{GL_DOUBLE}. The initial value is
+@code{GL_FLOAT}.
+
+@item @code{GL_VERTEX_ATTRIB_ARRAY_NORMALIZED}
+
+
+@var{params} returns a single value that is non-zero (true) if
+fixed-point data types for the vertex attribute array indicated by
+@var{index} are normalized when they are converted to floating point,
+and 0 (false) otherwise. The initial value is @code{GL_FALSE}.
+
+@item @code{GL_CURRENT_VERTEX_ATTRIB}
+
+
+@var{params} returns four values that represent the current value for
+the generic vertex attribute specified by index. Generic vertex
+attribute 0 is unique in that it has no current state, so an error will
+be generated if @var{index} is 0. The initial value for all other
+generic vertex attributes is (0,0,0,1).
+
+@end table
+
+All of the parameters except @code{GL_CURRENT_VERTEX_ATTRIB} represent
+client-side state.
+
+@heading Errors
+@code{GL_INVALID_VALUE} is generated if @var{index} is greater than or
+equal to @code{GL_MAX_VERTEX_ATTRIBS}.
+
+@code{GL_INVALID_ENUM} is generated if @var{pname} is not an accepted
+value.
+
+@code{GL_INVALID_OPERATION} is generated if @var{index} is 0 and
+@var{pname} is @code{GL_CURRENT_VERTEX_ATTRIB}.
+
+@end defun
+
+@defun glGet
+@heading return the value or values of a selected parameter
+@heading Parameters
+@table @asis
+@item @var{pname}
+Specifies the parameter value to be returned. The symbolic constants in
+the list below are accepted.
+
+@item @var{params}
+Returns the value or values of the specified parameter.
+
+@end table
+
+@heading Description
+These four commands return values for simple state variables in GL.
+@var{pname} is a symbolic constant indicating the state variable to be
+returned, and @var{params} is a pointer to an array of the indicated
+type in which to place the returned data.
+
+Type conversion is performed if @var{params} has a different type than
+the state variable value being requested. If @code{glGetBooleanv} is
+called, a floating-point (or integer) value is converted to
+@code{GL_FALSE} if and only if it is 0.0 (or 0). Otherwise, it is
+converted to @code{GL_TRUE}. If @code{glGetIntegerv} is called, boolean
+values are returned as @code{GL_TRUE} or @code{GL_FALSE}, and most
+floating-point values are rounded to the nearest integer value.
+Floating-point colors and normals, however, are returned with a linear
+mapping that maps 1.0 to the most positive representable integer value
+and @math{-1.0} to the most negative representable integer value. If
+@code{glGetFloatv} or @code{glGetDoublev} is called, boolean values are
+returned as @code{GL_TRUE} or @code{GL_FALSE}, and integer values are
+converted to floating-point values.
+
+The following symbolic constants are accepted by @var{pname}:
+
+@table @asis
+@item @code{GL_ACCUM_ALPHA_BITS}
+
+
+@var{params} returns one value, the number of alpha bitplanes in the
+accumulation buffer.
+
+@item @code{GL_ACCUM_BLUE_BITS}
+
+
+@var{params} returns one value, the number of blue bitplanes in the
+accumulation buffer.
+
+@item @code{GL_ACCUM_CLEAR_VALUE}
+
+
+@var{params} returns four values: the red, green, blue, and alpha values
+used to clear the accumulation buffer. Integer values, if requested, are
+linearly mapped from the internal floating-point representation such
+that 1.0 returns the most positive representable integer value, and
+@math{-1.0} returns the most negative representable integer value. The
+initial value is (0, 0, 0, 0). See @code{glClearAccum}.
+
+@item @code{GL_ACCUM_GREEN_BITS}
+
+
+@var{params} returns one value, the number of green bitplanes in the
+accumulation buffer.
+
+@item @code{GL_ACCUM_RED_BITS}
+
+
+@var{params} returns one value, the number of red bitplanes in the
+accumulation buffer.
+
+@item @code{GL_ACTIVE_TEXTURE}
+
+
+@var{params} returns a single value indicating the active multitexture
+unit. The initial value is @code{GL_TEXTURE0}. See
+@code{glActiveTexture}.
+
+@item @code{GL_ALIASED_POINT_SIZE_RANGE}
+
+
+@var{params} returns two values, the smallest and largest supported
+sizes for aliased points.
+
+@item @code{GL_ALIASED_LINE_WIDTH_RANGE}
+
+
+@var{params} returns two values, the smallest and largest supported
+widths for aliased lines.
+
+@item @code{GL_ALPHA_BIAS}
+
+
+@var{params} returns one value, the alpha bias factor used during pixel
+transfers. The initial value is 0. See @code{glPixelTransfer}.
+
+@item @code{GL_ALPHA_BITS}
+
+
+@var{params} returns one value, the number of alpha bitplanes in each
+color buffer.
+
+@item @code{GL_ALPHA_SCALE}
+
+
+@var{params} returns one value, the alpha scale factor used during pixel
+transfers. The initial value is 1. See @code{glPixelTransfer}.
+
+@item @code{GL_ALPHA_TEST}
+
+
+@var{params} returns a single boolean value indicating whether alpha
+testing of fragments is enabled. The initial value is @code{GL_FALSE}.
+See @code{glAlphaFunc}.
+
+@item @code{GL_ALPHA_TEST_FUNC}@var{params} returns one value,
+
+
+the symbolic name of the alpha test function. The initial value is
+@code{GL_ALWAYS}. See @code{glAlphaFunc}.
+
+@item @code{GL_ALPHA_TEST_REF}
+
+
+@var{params} returns one value, the reference value for the alpha test.
+The initial value is 0. See @code{glAlphaFunc}. An integer value, if
+requested, is linearly mapped from the internal floating-point
+representation such that 1.0 returns the most positive representable
+integer value, and @math{-1.0} returns the most negative representable
+integer value.
+
+@item @code{GL_ARRAY_BUFFER_BINDING}
+
+
+@var{params} returns a single value, the name of the buffer object
+currently bound to the target @code{GL_ARRAY_BUFFER}. If no buffer
+object is bound to this target, 0 is returned. The initial value is 0.
+See @code{glBindBuffer}.
+
+@item @code{GL_ATTRIB_STACK_DEPTH}
+
+
+@var{params} returns one value, the depth of the attribute stack. If the
+stack is empty, 0 is returned. The initial value is 0. See
+@code{glPushAttrib}.
+
+@item @code{GL_AUTO_NORMAL}
+
+
+@var{params} returns a single boolean value indicating whether 2D map
+evaluation automatically generates surface normals. The initial value is
+@code{GL_FALSE}. See @code{glMap2}.
+
+@item @code{GL_AUX_BUFFERS}
+
+
+@var{params} returns one value, the number of auxiliary color buffers
+available.
+
+@item @code{GL_BLEND}
+
+
+@var{params} returns a single boolean value indicating whether blending
+is enabled. The initial value is @code{GL_FALSE}. See
+@code{glBlendFunc}.
+
+@item @code{GL_BLEND_COLOR}
+
+
+@var{params} returns four values, the red, green, blue, and alpha values
+which are the components of the blend color. See @code{glBlendColor}.
+
+@item @code{GL_BLEND_DST_ALPHA}
+
+
+@var{params} returns one value, the symbolic constant identifying the
+alpha destination blend function. The initial value is @code{GL_ZERO}.
+See @code{glBlendFunc} and @code{glBlendFuncSeparate}.
+
+@item @code{GL_BLEND_DST_RGB}
+
+
+@var{params} returns one value, the symbolic constant identifying the
+RGB destination blend function. The initial value is @code{GL_ZERO}. See
+@code{glBlendFunc} and @code{glBlendFuncSeparate}.
+
+@item @code{GL_BLEND_EQUATION_RGB}
+
+
+@var{params} returns one value, a symbolic constant indicating whether
+the RGB blend equation is @code{GL_FUNC_ADD}, @code{GL_FUNC_SUBTRACT},
+@code{GL_FUNC_REVERSE_SUBTRACT}, @code{GL_MIN} or @code{GL_MAX}. See
+@code{glBlendEquationSeparate}.
+
+@item @code{GL_BLEND_EQUATION_ALPHA}
+
+
+@var{params} returns one value, a symbolic constant indicating whether
+the Alpha blend equation is @code{GL_FUNC_ADD}, @code{GL_FUNC_SUBTRACT},
+@code{GL_FUNC_REVERSE_SUBTRACT}, @code{GL_MIN} or @code{GL_MAX}. See
+@code{glBlendEquationSeparate}.
+
+@item @code{GL_BLEND_SRC_ALPHA}
+
+
+@var{params} returns one value, the symbolic constant identifying the
+alpha source blend function. The initial value is @code{GL_ONE}. See
+@code{glBlendFunc} and @code{glBlendFuncSeparate}.
+
+@item @code{GL_BLEND_SRC_RGB}
+
+
+@var{params} returns one value, the symbolic constant identifying the
+RGB source blend function. The initial value is @code{GL_ONE}. See
+@code{glBlendFunc} and @code{glBlendFuncSeparate}.
+
+@item @code{GL_BLUE_BIAS}
+
+
+@var{params} returns one value, the blue bias factor used during pixel
+transfers. The initial value is 0. See @code{glPixelTransfer}.
+
+@item @code{GL_BLUE_BITS}
+
+
+@var{params} returns one value, the number of blue bitplanes in each
+color buffer.
+
+@item @code{GL_BLUE_SCALE}
+
+
+@var{params} returns one value, the blue scale factor used during pixel
+transfers. The initial value is 1. See @code{glPixelTransfer}.
+
+@item @code{GL_CLIENT_ACTIVE_TEXTURE}
+
+
+@var{params} returns a single integer value indicating the current
+client active multitexture unit. The initial value is
+@code{GL_TEXTURE0}. See @code{glClientActiveTexture}.
+
+@item @code{GL_CLIENT_ATTRIB_STACK_DEPTH}
+
+
+@var{params} returns one value indicating the depth of the attribute
+stack. The initial value is 0. See @code{glPushClientAttrib}.
+
+@item @code{GL_CLIP_PLANE}@var{i}
+
+
+@var{params} returns a single boolean value indicating whether the
+specified clipping plane is enabled. The initial value is
+@code{GL_FALSE}. See @code{glClipPlane}.
+
+@item @code{GL_COLOR_ARRAY}
+
+
+@var{params} returns a single boolean value indicating whether the color
+array is enabled. The initial value is @code{GL_FALSE}. See
+@code{glColorPointer}.
+
+@item @code{GL_COLOR_ARRAY_BUFFER_BINDING}
+
+
+@var{params} returns a single value, the name of the buffer object
+associated with the color array. This buffer object would have been
+bound to the target @code{GL_ARRAY_BUFFER} at the time of the most
+recent call to @code{glColorPointer}. If no buffer object was bound to
+this target, 0 is returned. The initial value is 0. See
+@code{glBindBuffer}.
+
+@item @code{GL_COLOR_ARRAY_SIZE}
+
+
+@var{params} returns one value, the number of components per color in
+the color array. The initial value is 4. See @code{glColorPointer}.
+
+@item @code{GL_COLOR_ARRAY_STRIDE}
+
+
+@var{params} returns one value, the byte offset between consecutive
+colors in the color array. The initial value is 0. See
+@code{glColorPointer}.
+
+@item @code{GL_COLOR_ARRAY_TYPE}
+
+
+@var{params} returns one value, the data type of each component in the
+color array. The initial value is @code{GL_FLOAT}. See
+@code{glColorPointer}.
+
+@item @code{GL_COLOR_CLEAR_VALUE}
+
+
+@var{params} returns four values: the red, green, blue, and alpha values
+used to clear the color buffers. Integer values, if requested, are
+linearly mapped from the internal floating-point representation such
+that 1.0 returns the most positive representable integer value, and
+@math{-1.0} returns the most negative representable integer value. The
+initial value is (0, 0, 0, 0). See @code{glClearColor}.
+
+@item @code{GL_COLOR_LOGIC_OP}
+
+
+@var{params} returns a single boolean value indicating whether a
+fragment's RGBA color values are merged into the framebuffer using a
+logical operation. The initial value is @code{GL_FALSE}. See
+@code{glLogicOp}.
+
+@item @code{GL_COLOR_MATERIAL}
+
+
+@var{params} returns a single boolean value indicating whether one or
+more material parameters are tracking the current color. The initial
+value is @code{GL_FALSE}. See @code{glColorMaterial}.
+
+@item @code{GL_COLOR_MATERIAL_FACE}
+
+
+@var{params} returns one value, a symbolic constant indicating which
+materials have a parameter that is tracking the current color. The
+initial value is @code{GL_FRONT_AND_BACK}. See @code{glColorMaterial}.
+
+@item @code{GL_COLOR_MATERIAL_PARAMETER}
+
+
+@var{params} returns one value, a symbolic constant indicating which
+material parameters are tracking the current color. The initial value is
+@code{GL_AMBIENT_AND_DIFFUSE}. See @code{glColorMaterial}.
+
+@item @code{GL_COLOR_MATRIX}
+
+
+@var{params} returns sixteen values: the color matrix on the top of the
+color matrix stack. Initially this matrix is the identity matrix. See
+@code{glPushMatrix}.
+
+@item @code{GL_COLOR_MATRIX_STACK_DEPTH}
+
+
+@var{params} returns one value, the maximum supported depth of the
+projection matrix stack. The value must be at least 2. See
+@code{glPushMatrix}.
+
+@item @code{GL_COLOR_SUM}
+
+
+@var{params} returns a single boolean value indicating whether primary
+and secondary color sum is enabled. See @code{glSecondaryColor}.
+
+@item @code{GL_COLOR_TABLE}
+
+
+@var{params} returns a single boolean value indicating whether the color
+table lookup is enabled. See @code{glColorTable}.
+
+@item @code{GL_COLOR_WRITEMASK}
+
+
+@var{params} returns four boolean values: the red, green, blue, and
+alpha write enables for the color buffers. The initial value is
+(@code{GL_TRUE}, @code{GL_TRUE}, @code{GL_TRUE}, @code{GL_TRUE}). See
+@code{glColorMask}.
+
+@item @code{GL_COMPRESSED_TEXTURE_FORMATS}
+
+
+@var{params} returns a list of symbolic constants of length
+@code{GL_NUM_COMPRESSED_TEXTURE_FORMATS} indicating which compressed
+texture formats are available. See @code{glCompressedTexImage2D}.
+
+@item @code{GL_CONVOLUTION_1D}
+
+
+@var{params} returns a single boolean value indicating whether 1D
+convolution is enabled. The initial value is @code{GL_FALSE}. See
+@code{glConvolutionFilter1D}.
+
+@item @code{GL_CONVOLUTION_2D}
+
+
+@var{params} returns a single boolean value indicating whether 2D
+convolution is enabled. The initial value is @code{GL_FALSE}. See
+@code{glConvolutionFilter2D}.
+
+@item @code{GL_CULL_FACE}
+
+
+@var{params} returns a single boolean value indicating whether polygon
+culling is enabled. The initial value is @code{GL_FALSE}. See
+@code{glCullFace}.
+
+@item @code{GL_CULL_FACE_MODE}
+
+
+@var{params} returns one value, a symbolic constant indicating which
+polygon faces are to be culled. The initial value is @code{GL_BACK}. See
+@code{glCullFace}.
+
+@item @code{GL_CURRENT_COLOR}
+
+
+@var{params} returns four values: the red, green, blue, and alpha values
+of the current color. Integer values, if requested, are linearly mapped
+from the internal floating-point representation such that 1.0 returns
+the most positive representable integer value, and @math{-1.0} returns
+the most negative representable integer value. The initial value is (1,
+1, 1, 1). See @code{glColor}.
+
+@item @code{GL_CURRENT_FOG_COORD}
+
+
+@var{params} returns one value, the current fog coordinate. The initial
+value is 0. See @code{glFogCoord}.
+
+@item @code{GL_CURRENT_INDEX}
+
+
+@var{params} returns one value, the current color index. The initial
+value is 1. See @code{glIndex}.
+
+@item @code{GL_CURRENT_NORMAL}
+
+
+@var{params} returns three values: the @var{x}, @var{y}, and @var{z}
+values of the current normal. Integer values, if requested, are linearly
+mapped from the internal floating-point representation such that 1.0
+returns the most positive representable integer value, and @math{-1.0}
+returns the most negative representable integer value. The initial value
+is (0, 0, 1). See @code{glNormal}.
+
+@item @code{GL_CURRENT_PROGRAM}
+
+
+@var{params} returns one value, the name of the program object that is
+currently active, or 0 if no program object is active. See
+@code{glUseProgram}.
+
+@item @code{GL_CURRENT_RASTER_COLOR}
+
+
+@var{params} returns four values: the red, green, blue, and alpha color
+values of the current raster position. Integer values, if requested, are
+linearly mapped from the internal floating-point representation such
+that 1.0 returns the most positive representable integer value, and
+@math{-1.0} returns the most negative representable integer value. The
+initial value is (1, 1, 1, 1). See @code{glRasterPos}.
+
+@item @code{GL_CURRENT_RASTER_DISTANCE}
+
+
+@var{params} returns one value, the distance from the eye to the current
+raster position. The initial value is 0. See @code{glRasterPos}.
+
+@item @code{GL_CURRENT_RASTER_INDEX}
+
+
+@var{params} returns one value, the color index of the current raster
+position. The initial value is 1. See @code{glRasterPos}.
+
+@item @code{GL_CURRENT_RASTER_POSITION}
+
+
+@var{params} returns four values: the @var{x}, @var{y}, @var{z}, and
+@var{w} components of the current raster position. @var{x}, @var{y}, and
+@var{z} are in window coordinates, and @var{w} is in clip coordinates.
+The initial value is (0, 0, 0, 1). See @code{glRasterPos}.
+
+@item @code{GL_CURRENT_RASTER_POSITION_VALID}
+
+
+@var{params} returns a single boolean value indicating whether the
+current raster position is valid. The initial value is @code{GL_TRUE}.
+See @code{glRasterPos}.
+
+@item @code{GL_CURRENT_RASTER_SECONDARY_COLOR}
+
+
+@var{params} returns four values: the red, green, blue, and alpha
+secondary color values of the current raster position. Integer values,
+if requested, are linearly mapped from the internal floating-point
+representation such that 1.0 returns the most positive representable
+integer value, and @math{-1.0} returns the most negative representable
+integer value. The initial value is (1, 1, 1, 1). See
+@code{glRasterPos}.
+
+@item @code{GL_CURRENT_RASTER_TEXTURE_COORDS}
+
+
+@var{params} returns four values: the @var{s}, @var{t}, @var{r}, and
+@var{q} texture coordinates of the current raster position. The initial
+value is (0, 0, 0, 1). See @code{glRasterPos} and
+@code{glMultiTexCoord}.
+
+@item @code{GL_CURRENT_SECONDARY_COLOR}
+
+
+@var{params} returns four values: the red, green, blue, and alpha values
+of the current secondary color. Integer values, if requested, are
+linearly mapped from the internal floating-point representation such
+that 1.0 returns the most positive representable integer value, and
+@math{-1.0} returns the most negative representable integer value. The
+initial value is (0, 0, 0, 0). See @code{glSecondaryColor}.
+
+@item @code{GL_CURRENT_TEXTURE_COORDS}
+
+
+@var{params} returns four values: the @var{s}, @var{t}, @var{r}, and
+@var{q} current texture coordinates. The initial value is (0, 0, 0, 1).
+See @code{glMultiTexCoord}.
+
+@item @code{GL_DEPTH_BIAS}
+
+
+@var{params} returns one value, the depth bias factor used during pixel
+transfers. The initial value is 0. See @code{glPixelTransfer}.
+
+@item @code{GL_DEPTH_BITS}
+
+
+@var{params} returns one value, the number of bitplanes in the depth
+buffer.
+
+@item @code{GL_DEPTH_CLEAR_VALUE}
+
+
+@var{params} returns one value, the value that is used to clear the
+depth buffer. Integer values, if requested, are linearly mapped from the
+internal floating-point representation such that 1.0 returns the most
+positive representable integer value, and @math{-1.0} returns the most
+negative representable integer value. The initial value is 1. See
+@code{glClearDepth}.
+
+@item @code{GL_DEPTH_FUNC}
+
+
+@var{params} returns one value, the symbolic constant that indicates the
+depth comparison function. The initial value is @code{GL_LESS}. See
+@code{glDepthFunc}.
+
+@item @code{GL_DEPTH_RANGE}
+
+
+@var{params} returns two values: the near and far mapping limits for the
+depth buffer. Integer values, if requested, are linearly mapped from the
+internal floating-point representation such that 1.0 returns the most
+positive representable integer value, and @math{-1.0} returns the most
+negative representable integer value. The initial value is (0, 1). See
+@code{glDepthRange}.
+
+@item @code{GL_DEPTH_SCALE}
+
+
+@var{params} returns one value, the depth scale factor used during pixel
+transfers. The initial value is 1. See @code{glPixelTransfer}.
+
+@item @code{GL_DEPTH_TEST}
+
+
+@var{params} returns a single boolean value indicating whether depth
+testing of fragments is enabled. The initial value is @code{GL_FALSE}.
+See @code{glDepthFunc} and @code{glDepthRange}.
+
+@item @code{GL_DEPTH_WRITEMASK}
+
+
+@var{params} returns a single boolean value indicating if the depth
+buffer is enabled for writing. The initial value is @code{GL_TRUE}. See
+@code{glDepthMask}.
+
+@item @code{GL_DITHER}
+
+
+@var{params} returns a single boolean value indicating whether dithering
+of fragment colors and indices is enabled. The initial value is
+@code{GL_TRUE}.
+
+@item @code{GL_DOUBLEBUFFER}
+
+
+@var{params} returns a single boolean value indicating whether double
+buffering is supported.
+
+@item @code{GL_DRAW_BUFFER}
+
+
+@var{params} returns one value, a symbolic constant indicating which
+buffers are being drawn to. See @code{glDrawBuffer}. The initial value
+is @code{GL_BACK} if there are back buffers, otherwise it is
+@code{GL_FRONT}.
+
+@item @code{GL_DRAW_BUFFER}@var{i}
+
+
+@var{params} returns one value, a symbolic constant indicating which
+buffers are being drawn to by the corresponding output color. See
+@code{glDrawBuffers}. The initial value of @code{GL_DRAW_BUFFER0} is
+@code{GL_BACK} if there are back buffers, otherwise it is
+@code{GL_FRONT}. The initial values of draw buffers for all other output
+colors is @code{GL_NONE}.
+
+@item @code{GL_EDGE_FLAG}
+
+
+@var{params} returns a single boolean value indicating whether the
+current edge flag is @code{GL_TRUE} or @code{GL_FALSE}. The initial
+value is @code{GL_TRUE}. See @code{glEdgeFlag}.
+
+@item @code{GL_EDGE_FLAG_ARRAY}
+
+
+@var{params} returns a single boolean value indicating whether the edge
+flag array is enabled. The initial value is @code{GL_FALSE}. See
+@code{glEdgeFlagPointer}.
+
+@item @code{GL_EDGE_FLAG_ARRAY_BUFFER_BINDING}
+
+
+@var{params} returns a single value, the name of the buffer object
+associated with the edge flag array. This buffer object would have been
+bound to the target @code{GL_ARRAY_BUFFER} at the time of the most
+recent call to @code{glEdgeFlagPointer}. If no buffer object was bound
+to this target, 0 is returned. The initial value is 0. See
+@code{glBindBuffer}.
+
+@item @code{GL_EDGE_FLAG_ARRAY_STRIDE}
+
+
+@var{params} returns one value, the byte offset between consecutive edge
+flags in the edge flag array. The initial value is 0. See
+@code{glEdgeFlagPointer}.
+
+@item @code{GL_ELEMENT_ARRAY_BUFFER_BINDING}
+
+
+@var{params} returns a single value, the name of the buffer object
+currently bound to the target @code{GL_ELEMENT_ARRAY_BUFFER}. If no
+buffer object is bound to this target, 0 is returned. The initial value
+is 0. See @code{glBindBuffer}.
+
+@item @code{GL_FEEDBACK_BUFFER_SIZE}
+
+
+@var{params} returns one value, the size of the feedback buffer. See
+@code{glFeedbackBuffer}.
+
+@item @code{GL_FEEDBACK_BUFFER_TYPE}
+
+
+@var{params} returns one value, the type of the feedback buffer. See
+@code{glFeedbackBuffer}.
+
+@item @code{GL_FOG}
+
+
+@var{params} returns a single boolean value indicating whether fogging
+is enabled. The initial value is @code{GL_FALSE}. See @code{glFog}.
+
+@item @code{GL_FOG_COORD_ARRAY}
+
+
+@var{params} returns a single boolean value indicating whether the fog
+coordinate array is enabled. The initial value is @code{GL_FALSE}. See
+@code{glFogCoordPointer}.
+
+@item @code{GL_FOG_COORD_ARRAY_BUFFER_BINDING}
+
+
+@var{params} returns a single value, the name of the buffer object
+associated with the fog coordinate array. This buffer object would have
+been bound to the target @code{GL_ARRAY_BUFFER} at the time of the most
+recent call to @code{glFogCoordPointer}. If no buffer object was bound
+to this target, 0 is returned. The initial value is 0. See
+@code{glBindBuffer}.
+
+@item @code{GL_FOG_COORD_ARRAY_STRIDE}
+
+
+@var{params} returns one value, the byte offset between consecutive fog
+coordinates in the fog coordinate array. The initial value is 0. See
+@code{glFogCoordPointer}.
+
+@item @code{GL_FOG_COORD_ARRAY_TYPE}
+
+
+@var{params} returns one value, the type of the fog coordinate array.
+The initial value is @code{GL_FLOAT}. See @code{glFogCoordPointer}.
+
+@item @code{GL_FOG_COORD_SRC}
+
+
+@var{params} returns one value, a symbolic constant indicating the
+source of the fog coordinate. The initial value is
+@code{GL_FRAGMENT_DEPTH}. See @code{glFog}.
+
+@item @code{GL_FOG_COLOR}
+
+
+@var{params} returns four values: the red, green, blue, and alpha
+components of the fog color. Integer values, if requested, are linearly
+mapped from the internal floating-point representation such that 1.0
+returns the most positive representable integer value, and @math{-1.0}
+returns the most negative representable integer value. The initial value
+is (0, 0, 0, 0). See @code{glFog}.
+
+@item @code{GL_FOG_DENSITY}
+
+
+@var{params} returns one value, the fog density parameter. The initial
+value is 1. See @code{glFog}.
+
+@item @code{GL_FOG_END}
+
+
+@var{params} returns one value, the end factor for the linear fog
+equation. The initial value is 1. See @code{glFog}.
+
+@item @code{GL_FOG_HINT}
+
+
+@var{params} returns one value, a symbolic constant indicating the mode
+of the fog hint. The initial value is @code{GL_DONT_CARE}. See
+@code{glHint}.
+
+@item @code{GL_FOG_INDEX}
+
+
+@var{params} returns one value, the fog color index. The initial value
+is 0. See @code{glFog}.
+
+@item @code{GL_FOG_MODE}
+
+
+@var{params} returns one value, a symbolic constant indicating which fog
+equation is selected. The initial value is @code{GL_EXP}. See
+@code{glFog}.
+
+@item @code{GL_FOG_START}
+
+
+@var{params} returns one value, the start factor for the linear fog
+equation. The initial value is 0. See @code{glFog}.
+
+@item @code{GL_FRAGMENT_SHADER_DERIVATIVE_HINT}
+
+
+@var{params} returns one value, a symbolic constant indicating the mode
+of the derivative accuracy hint for fragment shaders. The initial value
+is @code{GL_DONT_CARE}. See @code{glHint}.
+
+@item @code{GL_FRONT_FACE}
+
+
+@var{params} returns one value, a symbolic constant indicating whether
+clockwise or counterclockwise polygon winding is treated as
+front-facing. The initial value is @code{GL_CCW}. See
+@code{glFrontFace}.
+
+@item @code{GL_GENERATE_MIPMAP_HINT}
+
+
+@var{params} returns one value, a symbolic constant indicating the mode
+of the mipmap generation filtering hint. The initial value is
+@code{GL_DONT_CARE}. See @code{glHint}.
+
+@item @code{GL_GREEN_BIAS}
+
+
+@var{params} returns one value, the green bias factor used during pixel
+transfers. The initial value is 0.
+
+@item @code{GL_GREEN_BITS}
+
+
+@var{params} returns one value, the number of green bitplanes in each
+color buffer.
+
+@item @code{GL_GREEN_SCALE}
+
+
+@var{params} returns one value, the green scale factor used during pixel
+transfers. The initial value is 1. See @code{glPixelTransfer}.
+
+@item @code{GL_HISTOGRAM}
+
+
+@var{params} returns a single boolean value indicating whether histogram
+is enabled. The initial value is @code{GL_FALSE}. See
+@code{glHistogram}.
+
+@item @code{GL_INDEX_ARRAY}
+
+
+@var{params} returns a single boolean value indicating whether the color
+index array is enabled. The initial value is @code{GL_FALSE}. See
+@code{glIndexPointer}.
+
+@item @code{GL_INDEX_ARRAY_BUFFER_BINDING}
+
+
+@var{params} returns a single value, the name of the buffer object
+associated with the color index array. This buffer object would have
+been bound to the target @code{GL_ARRAY_BUFFER} at the time of the most
+recent call to @code{glIndexPointer}. If no buffer object was bound to
+this target, 0 is returned. The initial value is 0. See
+@code{glBindBuffer}.
+
+@item @code{GL_INDEX_ARRAY_STRIDE}
+
+
+@var{params} returns one value, the byte offset between consecutive
+color indexes in the color index array. The initial value is 0. See
+@code{glIndexPointer}.
+
+@item @code{GL_INDEX_ARRAY_TYPE}
+
+
+@var{params} returns one value, the data type of indexes in the color
+index array. The initial value is @code{GL_FLOAT}. See
+@code{glIndexPointer}.
+
+@item @code{GL_INDEX_BITS}
+
+
+@var{params} returns one value, the number of bitplanes in each color
+index buffer.
+
+@item @code{GL_INDEX_CLEAR_VALUE}
+
+
+@var{params} returns one value, the color index used to clear the color
+index buffers. The initial value is 0. See @code{glClearIndex}.
+
+@item @code{GL_INDEX_LOGIC_OP}
+
+
+@var{params} returns a single boolean value indicating whether a
+fragment's index values are merged into the framebuffer using a logical
+operation. The initial value is @code{GL_FALSE}. See @code{glLogicOp}.
+
+@item @code{GL_INDEX_MODE}
+
+
+@var{params} returns a single boolean value indicating whether the GL is
+in color index mode (@code{GL_TRUE}) or RGBA mode (@code{GL_FALSE}).
+
+@item @code{GL_INDEX_OFFSET}
+
+
+@var{params} returns one value, the offset added to color and stencil
+indices during pixel transfers. The initial value is 0. See
+@code{glPixelTransfer}.
+
+@item @code{GL_INDEX_SHIFT}
+
+
+@var{params} returns one value, the amount that color and stencil
+indices are shifted during pixel transfers. The initial value is 0. See
+@code{glPixelTransfer}.
+
+@item @code{GL_INDEX_WRITEMASK}
+
+
+@var{params} returns one value, a mask indicating which bitplanes of
+each color index buffer can be written. The initial value is all 1's.
+See @code{glIndexMask}.
+
+@item @code{GL_LIGHT}@var{i}
+
+
+@var{params} returns a single boolean value indicating whether the
+specified light is enabled. The initial value is @code{GL_FALSE}. See
+@code{glLight} and @code{glLightModel}.
+
+@item @code{GL_LIGHTING}
+
+
+@var{params} returns a single boolean value indicating whether lighting
+is enabled. The initial value is @code{GL_FALSE}. See
+@code{glLightModel}.
+
+@item @code{GL_LIGHT_MODEL_AMBIENT}
+
+
+@var{params} returns four values: the red, green, blue, and alpha
+components of the ambient intensity of the entire scene. Integer values,
+if requested, are linearly mapped from the internal floating-point
+representation such that 1.0 returns the most positive representable
+integer value, and @math{-1.0} returns the most negative representable
+integer value. The initial value is (0.2, 0.2, 0.2, 1.0). See
+@code{glLightModel}.
+
+@item @code{GL_LIGHT_MODEL_COLOR_CONTROL}
+
+
+@var{params} returns single enumerated value indicating whether specular
+reflection calculations are separated from normal lighting computations.
+The initial value is @code{GL_SINGLE_COLOR}.
+
+@item @code{GL_LIGHT_MODEL_LOCAL_VIEWER}
+
+
+@var{params} returns a single boolean value indicating whether specular
+reflection calculations treat the viewer as being local to the scene.
+The initial value is @code{GL_FALSE}. See @code{glLightModel}.
+
+@item @code{GL_LIGHT_MODEL_TWO_SIDE}
+
+
+@var{params} returns a single boolean value indicating whether separate
+materials are used to compute lighting for front- and back-facing
+polygons. The initial value is @code{GL_FALSE}. See @code{glLightModel}.
+
+@item @code{GL_LINE_SMOOTH}
+
+
+@var{params} returns a single boolean value indicating whether
+antialiasing of lines is enabled. The initial value is @code{GL_FALSE}.
+See @code{glLineWidth}.
+
+@item @code{GL_LINE_SMOOTH_HINT}
+
+
+@var{params} returns one value, a symbolic constant indicating the mode
+of the line antialiasing hint. The initial value is @code{GL_DONT_CARE}.
+See @code{glHint}.
+
+@item @code{GL_LINE_STIPPLE}
+
+
+@var{params} returns a single boolean value indicating whether stippling
+of lines is enabled. The initial value is @code{GL_FALSE}. See
+@code{glLineStipple}.
+
+@item @code{GL_LINE_STIPPLE_PATTERN}
+
+
+@var{params} returns one value, the 16-bit line stipple pattern. The
+initial value is all 1's. See @code{glLineStipple}.
+
+@item @code{GL_LINE_STIPPLE_REPEAT}
+
+
+@var{params} returns one value, the line stipple repeat factor. The
+initial value is 1. See @code{glLineStipple}.
+
+@item @code{GL_LINE_WIDTH}
+
+
+@var{params} returns one value, the line width as specified with
+@code{glLineWidth}. The initial value is 1.
+
+@item @code{GL_LINE_WIDTH_GRANULARITY}
+
+
+@var{params} returns one value, the width difference between adjacent
+supported widths for antialiased lines. See @code{glLineWidth}.
+
+@item @code{GL_LINE_WIDTH_RANGE}
+
+
+@var{params} returns two values: the smallest and largest supported
+widths for antialiased lines. See @code{glLineWidth}.
+
+@item @code{GL_LIST_BASE}
+
+
+@var{params} returns one value, the base offset added to all names in
+arrays presented to @code{glCallLists}. The initial value is 0. See
+@code{glListBase}.
+
+@item @code{GL_LIST_INDEX}
+
+
+@var{params} returns one value, the name of the display list currently
+under construction. 0 is returned if no display list is currently under
+construction. The initial value is 0. See @code{glNewList}.
+
+@item @code{GL_LIST_MODE}
+
+
+@var{params} returns one value, a symbolic constant indicating the
+construction mode of the display list currently under construction. The
+initial value is 0. See @code{glNewList}.
+
+@item @code{GL_LOGIC_OP_MODE}
+
+
+@var{params} returns one value, a symbolic constant indicating the
+selected logic operation mode. The initial value is @code{GL_COPY}. See
+@code{glLogicOp}.
+
+@item @code{GL_MAP1_COLOR_4}
+
+
+@var{params} returns a single boolean value indicating whether 1D
+evaluation generates colors. The initial value is @code{GL_FALSE}. See
+@code{glMap1}.
+
+@item @code{GL_MAP1_GRID_DOMAIN}
+
+
+@var{params} returns two values: the endpoints of the 1D map's grid
+domain. The initial value is (0, 1). See @code{glMapGrid}.
+
+@item @code{GL_MAP1_GRID_SEGMENTS}
+
+
+@var{params} returns one value, the number of partitions in the 1D map's
+grid domain. The initial value is 1. See @code{glMapGrid}.
+
+@item @code{GL_MAP1_INDEX}
+
+
+@var{params} returns a single boolean value indicating whether 1D
+evaluation generates color indices. The initial value is
+@code{GL_FALSE}. See @code{glMap1}.
+
+@item @code{GL_MAP1_NORMAL}
+
+
+@var{params} returns a single boolean value indicating whether 1D
+evaluation generates normals. The initial value is @code{GL_FALSE}. See
+@code{glMap1}.
+
+@item @code{GL_MAP1_TEXTURE_COORD_1}
+
+
+@var{params} returns a single boolean value indicating whether 1D
+evaluation generates 1D texture coordinates. The initial value is
+@code{GL_FALSE}. See @code{glMap1}.
+
+@item @code{GL_MAP1_TEXTURE_COORD_2}
+
+
+@var{params} returns a single boolean value indicating whether 1D
+evaluation generates 2D texture coordinates. The initial value is
+@code{GL_FALSE}. See @code{glMap1}.
+
+@item @code{GL_MAP1_TEXTURE_COORD_3}
+
+
+@var{params} returns a single boolean value indicating whether 1D
+evaluation generates 3D texture coordinates. The initial value is
+@code{GL_FALSE}. See @code{glMap1}.
+
+@item @code{GL_MAP1_TEXTURE_COORD_4}
+
+
+@var{params} returns a single boolean value indicating whether 1D
+evaluation generates 4D texture coordinates. The initial value is
+@code{GL_FALSE}. See @code{glMap1}.
+
+@item @code{GL_MAP1_VERTEX_3}
+
+
+@var{params} returns a single boolean value indicating whether 1D
+evaluation generates 3D vertex coordinates. The initial value is
+@code{GL_FALSE}. See @code{glMap1}.
+
+@item @code{GL_MAP1_VERTEX_4}
+
+
+@var{params} returns a single boolean value indicating whether 1D
+evaluation generates 4D vertex coordinates. The initial value is
+@code{GL_FALSE}. See @code{glMap1}.
+
+@item @code{GL_MAP2_COLOR_4}
+
+
+@var{params} returns a single boolean value indicating whether 2D
+evaluation generates colors. The initial value is @code{GL_FALSE}. See
+@code{glMap2}.
+
+@item @code{GL_MAP2_GRID_DOMAIN}
+
+
+@var{params} returns four values: the endpoints of the 2D map's
+@math{@var{i}} and @math{@var{j}} grid domains. The initial value is
+(0,1; 0,1). See @code{glMapGrid}.
+
+@item @code{GL_MAP2_GRID_SEGMENTS}
+
+
+@var{params} returns two values: the number of partitions in the 2D
+map's @math{@var{i}} and @math{@var{j}} grid domains. The initial value
+is (1,1). See @code{glMapGrid}.
+
+@item @code{GL_MAP2_INDEX}
+
+
+@var{params} returns a single boolean value indicating whether 2D
+evaluation generates color indices. The initial value is
+@code{GL_FALSE}. See @code{glMap2}.
+
+@item @code{GL_MAP2_NORMAL}
+
+
+@var{params} returns a single boolean value indicating whether 2D
+evaluation generates normals. The initial value is @code{GL_FALSE}. See
+@code{glMap2}.
+
+@item @code{GL_MAP2_TEXTURE_COORD_1}
+
+
+@var{params} returns a single boolean value indicating whether 2D
+evaluation generates 1D texture coordinates. The initial value is
+@code{GL_FALSE}. See @code{glMap2}.
+
+@item @code{GL_MAP2_TEXTURE_COORD_2}
+
+
+@var{params} returns a single boolean value indicating whether 2D
+evaluation generates 2D texture coordinates. The initial value is
+@code{GL_FALSE}. See @code{glMap2}.
+
+@item @code{GL_MAP2_TEXTURE_COORD_3}
+
+
+@var{params} returns a single boolean value indicating whether 2D
+evaluation generates 3D texture coordinates. The initial value is
+@code{GL_FALSE}. See @code{glMap2}.
+
+@item @code{GL_MAP2_TEXTURE_COORD_4}
+
+
+@var{params} returns a single boolean value indicating whether 2D
+evaluation generates 4D texture coordinates. The initial value is
+@code{GL_FALSE}. See @code{glMap2}.
+
+@item @code{GL_MAP2_VERTEX_3}
+
+
+@var{params} returns a single boolean value indicating whether 2D
+evaluation generates 3D vertex coordinates. The initial value is
+@code{GL_FALSE}. See @code{glMap2}.
+
+@item @code{GL_MAP2_VERTEX_4}
+
+
+@var{params} returns a single boolean value indicating whether 2D
+evaluation generates 4D vertex coordinates. The initial value is
+@code{GL_FALSE}. See @code{glMap2}.
+
+@item @code{GL_MAP_COLOR}
+
+
+@var{params} returns a single boolean value indicating if colors and
+color indices are to be replaced by table lookup during pixel transfers.
+The initial value is @code{GL_FALSE}. See @code{glPixelTransfer}.
+
+@item @code{GL_MAP_STENCIL}
+
+
+@var{params} returns a single boolean value indicating if stencil
+indices are to be replaced by table lookup during pixel transfers. The
+initial value is @code{GL_FALSE}. See @code{glPixelTransfer}.
+
+@item @code{GL_MATRIX_MODE}
+
+
+@var{params} returns one value, a symbolic constant indicating which
+matrix stack is currently the target of all matrix operations. The
+initial value is @code{GL_MODELVIEW}. See @code{glMatrixMode}.
+
+@item @code{GL_MAX_3D_TEXTURE_SIZE}
+
+
+@var{params} returns one value, a rough estimate of the largest 3D
+texture that the GL can handle. The value must be at least 16. If the GL
+version is 1.2 or greater, use @code{GL_PROXY_TEXTURE_3D} to determine
+if a texture is too large. See @code{glTexImage3D}.
+
+@item @code{GL_MAX_CLIENT_ATTRIB_STACK_DEPTH}
+
+
+@var{params} returns one value indicating the maximum supported depth of
+the client attribute stack. See @code{glPushClientAttrib}.
+
+@item @code{GL_MAX_ATTRIB_STACK_DEPTH}
+
+
+@var{params} returns one value, the maximum supported depth of the
+attribute stack. The value must be at least 16. See @code{glPushAttrib}.
+
+@item @code{GL_MAX_CLIP_PLANES}
+
+
+@var{params} returns one value, the maximum number of
+application-defined clipping planes. The value must be at least 6. See
+@code{glClipPlane}.
+
+@item @code{GL_MAX_COLOR_MATRIX_STACK_DEPTH}
+
+
+@var{params} returns one value, the maximum supported depth of the color
+matrix stack. The value must be at least 2. See @code{glPushMatrix}.
+
+@item @code{GL_MAX_COMBINED_TEXTURE_IMAGE_UNITS}
+
+
+@var{params} returns one value, the maximum supported texture image
+units that can be used to access texture maps from the vertex shader and
+the fragment processor combined. If both the vertex shader and the
+fragment processing stage access the same texture image unit, then that
+counts as using two texture image units against this limit. The value
+must be at least 2. See @code{glActiveTexture}.
+
+@item @code{GL_MAX_CUBE_MAP_TEXTURE_SIZE}
+
+
+@var{params} returns one value. The value gives a rough estimate of the
+largest cube-map texture that the GL can handle. The value must be at
+least 16. If the GL version is 1.3 or greater, use
+@code{GL_PROXY_TEXTURE_CUBE_MAP} to determine if a texture is too large.
+See @code{glTexImage2D}.
+
+@item @code{GL_MAX_DRAW_BUFFERS}
+
+
+@var{params} returns one value, the maximum number of simultaneous
+output colors allowed from a fragment shader using the
+@code{gl_FragData} built-in array. The value must be at least 1. See
+@code{glDrawBuffers}.
+
+@item @code{GL_MAX_ELEMENTS_INDICES}
+
+
+@var{params} returns one value, the recommended maximum number of vertex
+array indices. See @code{glDrawRangeElements}.
+
+@item @code{GL_MAX_ELEMENTS_VERTICES}
+
+
+@var{params} returns one value, the recommended maximum number of vertex
+array vertices. See @code{glDrawRangeElements}.
+
+@item @code{GL_MAX_EVAL_ORDER}
+
+
+@var{params} returns one value, the maximum equation order supported by
+1D and 2D evaluators. The value must be at least 8. See @code{glMap1}
+and @code{glMap2}.
+
+@item @code{GL_MAX_FRAGMENT_UNIFORM_COMPONENTS}
+
+
+@var{params} returns one value, the maximum number of individual
+floating-point, integer, or boolean values that can be held in uniform
+variable storage for a fragment shader. The value must be at least 64.
+See @code{glUniform}.
+
+@item @code{GL_MAX_LIGHTS}
+
+
+@var{params} returns one value, the maximum number of lights. The value
+must be at least 8. See @code{glLight}.
+
+@item @code{GL_MAX_LIST_NESTING}
+
+
+@var{params} returns one value, the maximum recursion depth allowed
+during display-list traversal. The value must be at least 64. See
+@code{glCallList}.
+
+@item @code{GL_MAX_MODELVIEW_STACK_DEPTH}
+
+
+@var{params} returns one value, the maximum supported depth of the
+modelview matrix stack. The value must be at least 32. See
+@code{glPushMatrix}.
+
+@item @code{GL_MAX_NAME_STACK_DEPTH}
+
+
+@var{params} returns one value, the maximum supported depth of the
+selection name stack. The value must be at least 64. See
+@code{glPushName}.
+
+@item @code{GL_MAX_PIXEL_MAP_TABLE}
+
+
+@var{params} returns one value, the maximum supported size of a
+@code{glPixelMap} lookup table. The value must be at least 32. See
+@code{glPixelMap}.
+
+@item @code{GL_MAX_PROJECTION_STACK_DEPTH}
+
+
+@var{params} returns one value, the maximum supported depth of the
+projection matrix stack. The value must be at least 2. See
+@code{glPushMatrix}.
+
+@item @code{GL_MAX_TEXTURE_COORDS}
+
+
+@var{params} returns one value, the maximum number of texture coordinate
+sets available to vertex and fragment shaders. The value must be at
+least 2. See @code{glActiveTexture} and @code{glClientActiveTexture}.
+
+@item @code{GL_MAX_TEXTURE_IMAGE_UNITS}
+
+
+@var{params} returns one value, the maximum supported texture image
+units that can be used to access texture maps from the fragment shader.
+The value must be at least 2. See @code{glActiveTexture}.
+
+@item @code{GL_MAX_TEXTURE_LOD_BIAS}
+
+
+@var{params} returns one value, the maximum, absolute value of the
+texture level-of-detail bias. The value must be at least 4.
+
+@item @code{GL_MAX_TEXTURE_SIZE}
+
+
+@var{params} returns one value. The value gives a rough estimate of the
+largest texture that the GL can handle. The value must be at least 64.
+If the GL version is 1.1 or greater, use @code{GL_PROXY_TEXTURE_1D} or
+@code{GL_PROXY_TEXTURE_2D} to determine if a texture is too large. See
+@code{glTexImage1D} and @code{glTexImage2D}.
+
+@item @code{GL_MAX_TEXTURE_STACK_DEPTH}
+
+
+@var{params} returns one value, the maximum supported depth of the
+texture matrix stack. The value must be at least 2. See
+@code{glPushMatrix}.
+
+@item @code{GL_MAX_TEXTURE_UNITS}
+
+
+@var{params} returns a single value indicating the number of
+conventional texture units supported. Each conventional texture unit
+includes both a texture coordinate set and a texture image unit.
+Conventional texture units may be used for fixed-function (non-shader)
+rendering. The value must be at least 2. Additional texture coordinate
+sets and texture image units may be accessed from vertex and fragment
+shaders. See @code{glActiveTexture} and @code{glClientActiveTexture}.
+
+@item @code{GL_MAX_VARYING_FLOATS}
+
+
+@var{params} returns one value, the maximum number of interpolators
+available for processing varying variables used by vertex and fragment
+shaders. This value represents the number of individual floating-point
+values that can be interpolated; varying variables declared as vectors,
+matrices, and arrays will all consume multiple interpolators. The value
+must be at least 32.
+
+@item @code{GL_MAX_VERTEX_ATTRIBS}
+
+
+@var{params} returns one value, the maximum number of 4-component
+generic vertex attributes accessible to a vertex shader. The value must
+be at least 16. See @code{glVertexAttrib}.
+
+@item @code{GL_MAX_VERTEX_TEXTURE_IMAGE_UNITS}
+
+
+@var{params} returns one value, the maximum supported texture image
+units that can be used to access texture maps from the vertex shader.
+The value may be 0. See @code{glActiveTexture}.
+
+@item @code{GL_MAX_VERTEX_UNIFORM_COMPONENTS}
+
+
+@var{params} returns one value, the maximum number of individual
+floating-point, integer, or boolean values that can be held in uniform
+variable storage for a vertex shader. The value must be at least 512.
+See @code{glUniform}.
+
+@item @code{GL_MAX_VIEWPORT_DIMS}
+
+
+@var{params} returns two values: the maximum supported width and height
+of the viewport. These must be at least as large as the visible
+dimensions of the display being rendered to. See @code{glViewport}.
+
+@item @code{GL_MINMAX}
+
+
+@var{params} returns a single boolean value indicating whether pixel
+minmax values are computed. The initial value is @code{GL_FALSE}. See
+@code{glMinmax}.
+
+@item @code{GL_MODELVIEW_MATRIX}
+
+
+@var{params} returns sixteen values: the modelview matrix on the top of
+the modelview matrix stack. Initially this matrix is the identity
+matrix. See @code{glPushMatrix}.
+
+@item @code{GL_MODELVIEW_STACK_DEPTH}
+
+
+@var{params} returns one value, the number of matrices on the modelview
+matrix stack. The initial value is 1. See @code{glPushMatrix}.
+
+@item @code{GL_NAME_STACK_DEPTH}
+
+
+@var{params} returns one value, the number of names on the selection
+name stack. The initial value is 0. See @code{glPushName}.
+
+@item @code{GL_NORMAL_ARRAY}
+
+
+@var{params} returns a single boolean value, indicating whether the
+normal array is enabled. The initial value is @code{GL_FALSE}. See
+@code{glNormalPointer}.
+
+@item @code{GL_NORMAL_ARRAY_BUFFER_BINDING}
+
+
+@var{params} returns a single value, the name of the buffer object
+associated with the normal array. This buffer object would have been
+bound to the target @code{GL_ARRAY_BUFFER} at the time of the most
+recent call to @code{glNormalPointer}. If no buffer object was bound to
+this target, 0 is returned. The initial value is 0. See
+@code{glBindBuffer}.
+
+@item @code{GL_NORMAL_ARRAY_STRIDE}
+
+
+@var{params} returns one value, the byte offset between consecutive
+normals in the normal array. The initial value is 0. See
+@code{glNormalPointer}.
+
+@item @code{GL_NORMAL_ARRAY_TYPE}
+
+
+@var{params} returns one value, the data type of each coordinate in the
+normal array. The initial value is @code{GL_FLOAT}. See
+@code{glNormalPointer}.
+
+@item @code{GL_NORMALIZE}
+
+
+@var{params} returns a single boolean value indicating whether normals
+are automatically scaled to unit length after they have been transformed
+to eye coordinates. The initial value is @code{GL_FALSE}. See
+@code{glNormal}.
+
+@item @code{GL_NUM_COMPRESSED_TEXTURE_FORMATS}
+
+
+@var{params} returns a single integer value indicating the number of
+available compressed texture formats. The minimum value is 0. See
+@code{glCompressedTexImage2D}.
+
+@item @code{GL_PACK_ALIGNMENT}
+
+
+@var{params} returns one value, the byte alignment used for writing
+pixel data to memory. The initial value is 4. See @code{glPixelStore}.
+
+@item @code{GL_PACK_IMAGE_HEIGHT}
+
+
+@var{params} returns one value, the image height used for writing pixel
+data to memory. The initial value is 0. See @code{glPixelStore}.
+
+@item @code{GL_PACK_LSB_FIRST}
+
+
+@var{params} returns a single boolean value indicating whether
+single-bit pixels being written to memory are written first to the least
+significant bit of each unsigned byte. The initial value is
+@code{GL_FALSE}. See @code{glPixelStore}.
+
+@item @code{GL_PACK_ROW_LENGTH}
+
+
+@var{params} returns one value, the row length used for writing pixel
+data to memory. The initial value is 0. See @code{glPixelStore}.
+
+@item @code{GL_PACK_SKIP_IMAGES}
+
+
+@var{params} returns one value, the number of pixel images skipped
+before the first pixel is written into memory. The initial value is 0.
+See @code{glPixelStore}.
+
+@item @code{GL_PACK_SKIP_PIXELS}
+
+
+@var{params} returns one value, the number of pixel locations skipped
+before the first pixel is written into memory. The initial value is 0.
+See @code{glPixelStore}.
+
+@item @code{GL_PACK_SKIP_ROWS}
+
+
+@var{params} returns one value, the number of rows of pixel locations
+skipped before the first pixel is written into memory. The initial value
+is 0. See @code{glPixelStore}.
+
+@item @code{GL_PACK_SWAP_BYTES}
+
+
+@var{params} returns a single boolean value indicating whether the bytes
+of two-byte and four-byte pixel indices and components are swapped
+before being written to memory. The initial value is @code{GL_FALSE}.
+See @code{glPixelStore}.
+
+@item @code{GL_PERSPECTIVE_CORRECTION_HINT}
+
+
+@var{params} returns one value, a symbolic constant indicating the mode
+of the perspective correction hint. The initial value is
+@code{GL_DONT_CARE}. See @code{glHint}.
+
+@item @code{GL_PIXEL_MAP_A_TO_A_SIZE}
+
+
+@var{params} returns one value, the size of the alpha-to-alpha pixel
+translation table. The initial value is 1. See @code{glPixelMap}.
+
+@item @code{GL_PIXEL_MAP_B_TO_B_SIZE}
+
+
+@var{params} returns one value, the size of the blue-to-blue pixel
+translation table. The initial value is 1. See @code{glPixelMap}.
+
+@item @code{GL_PIXEL_MAP_G_TO_G_SIZE}
+
+
+@var{params} returns one value, the size of the green-to-green pixel
+translation table. The initial value is 1. See @code{glPixelMap}.
+
+@item @code{GL_PIXEL_MAP_I_TO_A_SIZE}
+
+
+@var{params} returns one value, the size of the index-to-alpha pixel
+translation table. The initial value is 1. See @code{glPixelMap}.
+
+@item @code{GL_PIXEL_MAP_I_TO_B_SIZE}
+
+
+@var{params} returns one value, the size of the index-to-blue pixel
+translation table. The initial value is 1. See @code{glPixelMap}.
+
+@item @code{GL_PIXEL_MAP_I_TO_G_SIZE}
+
+
+@var{params} returns one value, the size of the index-to-green pixel
+translation table. The initial value is 1. See @code{glPixelMap}.
+
+@item @code{GL_PIXEL_MAP_I_TO_I_SIZE}
+
+
+@var{params} returns one value, the size of the index-to-index pixel
+translation table. The initial value is 1. See @code{glPixelMap}.
+
+@item @code{GL_PIXEL_MAP_I_TO_R_SIZE}
+
+
+@var{params} returns one value, the size of the index-to-red pixel
+translation table. The initial value is 1. See @code{glPixelMap}.
+
+@item @code{GL_PIXEL_MAP_R_TO_R_SIZE}
+
+
+@var{params} returns one value, the size of the red-to-red pixel
+translation table. The initial value is 1. See @code{glPixelMap}.
+
+@item @code{GL_PIXEL_MAP_S_TO_S_SIZE}
+
+
+@var{params} returns one value, the size of the stencil-to-stencil pixel
+translation table. The initial value is 1. See @code{glPixelMap}.
+
+@item @code{GL_PIXEL_PACK_BUFFER_BINDING}
+
+
+@var{params} returns a single value, the name of the buffer object
+currently bound to the target @code{GL_PIXEL_PACK_BUFFER}. If no buffer
+object is bound to this target, 0 is returned. The initial value is 0.
+See @code{glBindBuffer}.
+
+@item @code{GL_PIXEL_UNPACK_BUFFER_BINDING}
+
+
+@var{params} returns a single value, the name of the buffer object
+currently bound to the target @code{GL_PIXEL_UNPACK_BUFFER}. If no
+buffer object is bound to this target, 0 is returned. The initial value
+is 0. See @code{glBindBuffer}.
+
+@item @code{GL_POINT_DISTANCE_ATTENUATION}
+
+
+@var{params} returns three values, the coefficients for computing the
+attenuation value for points. See @code{glPointParameter}.
+
+@item @code{GL_POINT_FADE_THRESHOLD_SIZE}
+
+
+@var{params} returns one value, the point size threshold for determining
+the point size. See @code{glPointParameter}.
+
+@item @code{GL_POINT_SIZE}
+
+
+@var{params} returns one value, the point size as specified by
+@code{glPointSize}. The initial value is 1.
+
+@item @code{GL_POINT_SIZE_GRANULARITY}
+
+
+@var{params} returns one value, the size difference between adjacent
+supported sizes for antialiased points. See @code{glPointSize}.
+
+@item @code{GL_POINT_SIZE_MAX}
+
+
+@var{params} returns one value, the upper bound for the attenuated point
+sizes. The initial value is 0.0. See @code{glPointParameter}.
+
+@item @code{GL_POINT_SIZE_MIN}
+
+
+@var{params} returns one value, the lower bound for the attenuated point
+sizes. The initial value is 1.0. See @code{glPointParameter}.
+
+@item @code{GL_POINT_SIZE_RANGE}
+
+
+@var{params} returns two values: the smallest and largest supported
+sizes for antialiased points. The smallest size must be at most 1, and
+the largest size must be at least 1. See @code{glPointSize}.
+
+@item @code{GL_POINT_SMOOTH}
+
+
+@var{params} returns a single boolean value indicating whether
+antialiasing of points is enabled. The initial value is @code{GL_FALSE}.
+See @code{glPointSize}.
+
+@item @code{GL_POINT_SMOOTH_HINT}
+
+
+@var{params} returns one value, a symbolic constant indicating the mode
+of the point antialiasing hint. The initial value is
+@code{GL_DONT_CARE}. See @code{glHint}.
+
+@item @code{GL_POINT_SPRITE}
+
+
+@var{params} returns a single boolean value indicating whether point
+sprite is enabled. The initial value is @code{GL_FALSE}.
+
+@item @code{GL_POLYGON_MODE}
+
+
+@var{params} returns two values: symbolic constants indicating whether
+front-facing and back-facing polygons are rasterized as points, lines,
+or filled polygons. The initial value is @code{GL_FILL}. See
+@code{glPolygonMode}.
+
+@item @code{GL_POLYGON_OFFSET_FACTOR}
+
+
+@var{params} returns one value, the scaling factor used to determine the
+variable offset that is added to the depth value of each fragment
+generated when a polygon is rasterized. The initial value is 0. See
+@code{glPolygonOffset}.
+
+@item @code{GL_POLYGON_OFFSET_UNITS}
+
+
+@var{params} returns one value. This value is multiplied by an
+implementation-specific value and then added to the depth value of each
+fragment generated when a polygon is rasterized. The initial value is 0.
+See @code{glPolygonOffset}.
+
+@item @code{GL_POLYGON_OFFSET_FILL}
+
+
+@var{params} returns a single boolean value indicating whether polygon
+offset is enabled for polygons in fill mode. The initial value is
+@code{GL_FALSE}. See @code{glPolygonOffset}.
+
+@item @code{GL_POLYGON_OFFSET_LINE}
+
+
+@var{params} returns a single boolean value indicating whether polygon
+offset is enabled for polygons in line mode. The initial value is
+@code{GL_FALSE}. See @code{glPolygonOffset}.
+
+@item @code{GL_POLYGON_OFFSET_POINT}
+
+
+@var{params} returns a single boolean value indicating whether polygon
+offset is enabled for polygons in point mode. The initial value is
+@code{GL_FALSE}. See @code{glPolygonOffset}.
+
+@item @code{GL_POLYGON_SMOOTH}
+
+
+@var{params} returns a single boolean value indicating whether
+antialiasing of polygons is enabled. The initial value is
+@code{GL_FALSE}. See @code{glPolygonMode}.
+
+@item @code{GL_POLYGON_SMOOTH_HINT}
+
+
+@var{params} returns one value, a symbolic constant indicating the mode
+of the polygon antialiasing hint. The initial value is
+@code{GL_DONT_CARE}. See @code{glHint}.
+
+@item @code{GL_POLYGON_STIPPLE}
+
+
+@var{params} returns a single boolean value indicating whether polygon
+stippling is enabled. The initial value is @code{GL_FALSE}. See
+@code{glPolygonStipple}.
+
+@item @code{GL_POST_COLOR_MATRIX_COLOR_TABLE}
+
+
+@var{params} returns a single boolean value indicating whether post
+color matrix transformation lookup is enabled. The initial value is
+@code{GL_FALSE}. See @code{glColorTable}.
+
+@item @code{GL_POST_COLOR_MATRIX_RED_BIAS}
+
+
+@var{params} returns one value, the red bias factor applied to RGBA
+fragments after color matrix transformations. The initial value is 0.
+See @code{glPixelTransfer}.
+
+@item @code{GL_POST_COLOR_MATRIX_GREEN_BIAS}
+
+
+@var{params} returns one value, the green bias factor applied to RGBA
+fragments after color matrix transformations. The initial value is 0.
+See @code{glPixelTransfer}
+
+@item @code{GL_POST_COLOR_MATRIX_BLUE_BIAS}
+
+
+@var{params} returns one value, the blue bias factor applied to RGBA
+fragments after color matrix transformations. The initial value is 0.
+See @code{glPixelTransfer}.
+
+@item @code{GL_POST_COLOR_MATRIX_ALPHA_BIAS}
+
+
+@var{params} returns one value, the alpha bias factor applied to RGBA
+fragments after color matrix transformations. The initial value is 0.
+See @code{glPixelTransfer}.
+
+@item @code{GL_POST_COLOR_MATRIX_RED_SCALE}
+
+
+@var{params} returns one value, the red scale factor applied to RGBA
+fragments after color matrix transformations. The initial value is 1.
+See @code{glPixelTransfer}.
+
+@item @code{GL_POST_COLOR_MATRIX_GREEN_SCALE}
+
+
+@var{params} returns one value, the green scale factor applied to RGBA
+fragments after color matrix transformations. The initial value is 1.
+See @code{glPixelTransfer}.
+
+@item @code{GL_POST_COLOR_MATRIX_BLUE_SCALE}
+
+
+@var{params} returns one value, the blue scale factor applied to RGBA
+fragments after color matrix transformations. The initial value is 1.
+See @code{glPixelTransfer}.
+
+@item @code{GL_POST_COLOR_MATRIX_ALPHA_SCALE}
+
+
+@var{params} returns one value, the alpha scale factor applied to RGBA
+fragments after color matrix transformations. The initial value is 1.
+See @code{glPixelTransfer}.
+
+@item @code{GL_POST_CONVOLUTION_COLOR_TABLE}
+
+
+@var{params} returns a single boolean value indicating whether post
+convolution lookup is enabled. The initial value is @code{GL_FALSE}. See
+@code{glColorTable}.
+
+@item @code{GL_POST_CONVOLUTION_RED_BIAS}
+
+
+@var{params} returns one value, the red bias factor applied to RGBA
+fragments after convolution. The initial value is 0. See
+@code{glPixelTransfer}.
+
+@item @code{GL_POST_CONVOLUTION_GREEN_BIAS}
+
+
+@var{params} returns one value, the green bias factor applied to RGBA
+fragments after convolution. The initial value is 0. See
+@code{glPixelTransfer}.
+
+@item @code{GL_POST_CONVOLUTION_BLUE_BIAS}
+
+
+@var{params} returns one value, the blue bias factor applied to RGBA
+fragments after convolution. The initial value is 0. See
+@code{glPixelTransfer}.
+
+@item @code{GL_POST_CONVOLUTION_ALPHA_BIAS}
+
+
+@var{params} returns one value, the alpha bias factor applied to RGBA
+fragments after convolution. The initial value is 0. See
+@code{glPixelTransfer}.
+
+@item @code{GL_POST_CONVOLUTION_RED_SCALE}
+
+
+@var{params} returns one value, the red scale factor applied to RGBA
+fragments after convolution. The initial value is 1. See
+@code{glPixelTransfer}.
+
+@item @code{GL_POST_CONVOLUTION_GREEN_SCALE}
+
+
+@var{params} returns one value, the green scale factor applied to RGBA
+fragments after convolution. The initial value is 1. See
+@code{glPixelTransfer}.
+
+@item @code{GL_POST_CONVOLUTION_BLUE_SCALE}
+
+
+@var{params} returns one value, the blue scale factor applied to RGBA
+fragments after convolution. The initial value is 1. See
+@code{glPixelTransfer}.
+
+@item @code{GL_POST_CONVOLUTION_ALPHA_SCALE}
+
+
+@var{params} returns one value, the alpha scale factor applied to RGBA
+fragments after convolution. The initial value is 1. See
+@code{glPixelTransfer}.
+
+@item @code{GL_PROJECTION_MATRIX}
+
+
+@var{params} returns sixteen values: the projection matrix on the top of
+the projection matrix stack. Initially this matrix is the identity
+matrix. See @code{glPushMatrix}.
+
+@item @code{GL_PROJECTION_STACK_DEPTH}
+
+
+@var{params} returns one value, the number of matrices on the projection
+matrix stack. The initial value is 1. See @code{glPushMatrix}.
+
+@item @code{GL_READ_BUFFER}
+
+
+@var{params} returns one value, a symbolic constant indicating which
+color buffer is selected for reading. The initial value is
+@code{GL_BACK} if there is a back buffer, otherwise it is
+@code{GL_FRONT}. See @code{glReadPixels} and @code{glAccum}.
+
+@item @code{GL_RED_BIAS}
+
+
+@var{params} returns one value, the red bias factor used during pixel
+transfers. The initial value is 0.
+
+@item @code{GL_RED_BITS}
+
+
+@var{params} returns one value, the number of red bitplanes in each
+color buffer.
+
+@item @code{GL_RED_SCALE}
+
+
+@var{params} returns one value, the red scale factor used during pixel
+transfers. The initial value is 1. See @code{glPixelTransfer}.
+
+@item @code{GL_RENDER_MODE}
+
+
+@var{params} returns one value, a symbolic constant indicating whether
+the GL is in render, select, or feedback mode. The initial value is
+@code{GL_RENDER}. See @code{glRenderMode}.
+
+@item @code{GL_RESCALE_NORMAL}
+
+
+@var{params} returns single boolean value indicating whether normal
+rescaling is enabled. See @code{glEnable}.
+
+@item @code{GL_RGBA_MODE}
+
+
+@var{params} returns a single boolean value indicating whether the GL is
+in RGBA mode (true) or color index mode (false). See @code{glColor}.
+
+@item @code{GL_SAMPLE_BUFFERS}
+
+
+@var{params} returns a single integer value indicating the number of
+sample buffers associated with the framebuffer. See
+@code{glSampleCoverage}.
+
+@item @code{GL_SAMPLE_COVERAGE_VALUE}
+
+
+@var{params} returns a single positive floating-point value indicating
+the current sample coverage value. See @code{glSampleCoverage}.
+
+@item @code{GL_SAMPLE_COVERAGE_INVERT}
+
+
+@var{params} returns a single boolean value indicating if the temporary
+coverage value should be inverted. See @code{glSampleCoverage}.
+
+@item @code{GL_SAMPLES}
+
+
+@var{params} returns a single integer value indicating the coverage mask
+size. See @code{glSampleCoverage}.
+
+@item @code{GL_SCISSOR_BOX}
+
+
+@var{params} returns four values: the @math{@var{x}} and @math{@var{y}}
+window coordinates of the scissor box, followed by its width and height.
+Initially the @math{@var{x}} and @math{@var{y}} window coordinates are
+both 0 and the width and height are set to the size of the window. See
+@code{glScissor}.
+
+@item @code{GL_SCISSOR_TEST}
+
+
+@var{params} returns a single boolean value indicating whether
+scissoring is enabled. The initial value is @code{GL_FALSE}. See
+@code{glScissor}.
+
+@item @code{GL_SECONDARY_COLOR_ARRAY}
+
+
+@var{params} returns a single boolean value indicating whether the
+secondary color array is enabled. The initial value is @code{GL_FALSE}.
+See @code{glSecondaryColorPointer}.
+
+@item @code{GL_SECONDARY_COLOR_ARRAY_BUFFER_BINDING}
+
+
+@var{params} returns a single value, the name of the buffer object
+associated with the secondary color array. This buffer object would have
+been bound to the target @code{GL_ARRAY_BUFFER} at the time of the most
+recent call to @code{glSecondaryColorPointer}. If no buffer object was
+bound to this target, 0 is returned. The initial value is 0. See
+@code{glBindBuffer}.
+
+@item @code{GL_SECONDARY_COLOR_ARRAY_SIZE}
+
+
+@var{params} returns one value, the number of components per color in
+the secondary color array. The initial value is 3. See
+@code{glSecondaryColorPointer}.
+
+@item @code{GL_SECONDARY_COLOR_ARRAY_STRIDE}
+
+
+@var{params} returns one value, the byte offset between consecutive
+colors in the secondary color array. The initial value is 0. See
+@code{glSecondaryColorPointer}.
+
+@item @code{GL_SECONDARY_COLOR_ARRAY_TYPE}
+
+
+@var{params} returns one value, the data type of each component in the
+secondary color array. The initial value is @code{GL_FLOAT}. See
+@code{glSecondaryColorPointer}.
+
+@item @code{GL_SELECTION_BUFFER_SIZE}
+
+
+@var{params} return one value, the size of the selection buffer. See
+@code{glSelectBuffer}.
+
+@item @code{GL_SEPARABLE_2D}
+
+
+@var{params} returns a single boolean value indicating whether 2D
+separable convolution is enabled. The initial value is @code{GL_FALSE}.
+See @code{glSeparableFilter2D}.
+
+@item @code{GL_SHADE_MODEL}
+
+
+@var{params} returns one value, a symbolic constant indicating whether
+the shading mode is flat or smooth. The initial value is
+@code{GL_SMOOTH}. See @code{glShadeModel}.
+
+@item @code{GL_SMOOTH_LINE_WIDTH_RANGE}
+
+
+@var{params} returns two values, the smallest and largest supported
+widths for antialiased lines. See @code{glLineWidth}.
+
+@item @code{GL_SMOOTH_LINE_WIDTH_GRANULARITY}
+
+
+@var{params} returns one value, the granularity of widths for
+antialiased lines. See @code{glLineWidth}.
+
+@item @code{GL_SMOOTH_POINT_SIZE_RANGE}
+
+
+@var{params} returns two values, the smallest and largest supported
+widths for antialiased points. See @code{glPointSize}.
+
+@item @code{GL_SMOOTH_POINT_SIZE_GRANULARITY}
+
+
+@var{params} returns one value, the granularity of sizes for antialiased
+points. See @code{glPointSize}.
+
+@item @code{GL_STENCIL_BACK_FAIL}
+
+
+@var{params} returns one value, a symbolic constant indicating what
+action is taken for back-facing polygons when the stencil test fails.
+The initial value is @code{GL_KEEP}. See @code{glStencilOpSeparate}.
+
+@item @code{GL_STENCIL_BACK_FUNC}
+
+
+@var{params} returns one value, a symbolic constant indicating what
+function is used for back-facing polygons to compare the stencil
+reference value with the stencil buffer value. The initial value is
+@code{GL_ALWAYS}. See @code{glStencilFuncSeparate}.
+
+@item @code{GL_STENCIL_BACK_PASS_DEPTH_FAIL}
+
+
+@var{params} returns one value, a symbolic constant indicating what
+action is taken for back-facing polygons when the stencil test passes,
+but the depth test fails. The initial value is @code{GL_KEEP}. See
+@code{glStencilOpSeparate}.
+
+@item @code{GL_STENCIL_BACK_PASS_DEPTH_PASS}
+
+
+@var{params} returns one value, a symbolic constant indicating what
+action is taken for back-facing polygons when the stencil test passes
+and the depth test passes. The initial value is @code{GL_KEEP}. See
+@code{glStencilOpSeparate}.
+
+@item @code{GL_STENCIL_BACK_REF}
+
+
+@var{params} returns one value, the reference value that is compared
+with the contents of the stencil buffer for back-facing polygons. The
+initial value is 0. See @code{glStencilFuncSeparate}.
+
+@item @code{GL_STENCIL_BACK_VALUE_MASK}
+
+
+@var{params} returns one value, the mask that is used for back-facing
+polygons to mask both the stencil reference value and the stencil buffer
+value before they are compared. The initial value is all 1's. See
+@code{glStencilFuncSeparate}.
+
+@item @code{GL_STENCIL_BACK_WRITEMASK}
+
+
+@var{params} returns one value, the mask that controls writing of the
+stencil bitplanes for back-facing polygons. The initial value is all
+1's. See @code{glStencilMaskSeparate}.
+
+@item @code{GL_STENCIL_BITS}
+
+
+@var{params} returns one value, the number of bitplanes in the stencil
+buffer.
+
+@item @code{GL_STENCIL_CLEAR_VALUE}
+
+
+@var{params} returns one value, the index to which the stencil bitplanes
+are cleared. The initial value is 0. See @code{glClearStencil}.
+
+@item @code{GL_STENCIL_FAIL}
+
+
+@var{params} returns one value, a symbolic constant indicating what
+action is taken when the stencil test fails. The initial value is
+@code{GL_KEEP}. See @code{glStencilOp}. If the GL version is 2.0 or
+greater, this stencil state only affects non-polygons and front-facing
+polygons. Back-facing polygons use separate stencil state. See
+@code{glStencilOpSeparate}.
+
+@item @code{GL_STENCIL_FUNC}
+
+
+@var{params} returns one value, a symbolic constant indicating what
+function is used to compare the stencil reference value with the stencil
+buffer value. The initial value is @code{GL_ALWAYS}. See
+@code{glStencilFunc}. If the GL version is 2.0 or greater, this stencil
+state only affects non-polygons and front-facing polygons. Back-facing
+polygons use separate stencil state. See @code{glStencilFuncSeparate}.
+
+@item @code{GL_STENCIL_PASS_DEPTH_FAIL}
+
+
+@var{params} returns one value, a symbolic constant indicating what
+action is taken when the stencil test passes, but the depth test fails.
+The initial value is @code{GL_KEEP}. See @code{glStencilOp}. If the GL
+version is 2.0 or greater, this stencil state only affects non-polygons
+and front-facing polygons. Back-facing polygons use separate stencil
+state. See @code{glStencilOpSeparate}.
+
+@item @code{GL_STENCIL_PASS_DEPTH_PASS}
+
+
+@var{params} returns one value, a symbolic constant indicating what
+action is taken when the stencil test passes and the depth test passes.
+The initial value is @code{GL_KEEP}. See @code{glStencilOp}. If the GL
+version is 2.0 or greater, this stencil state only affects non-polygons
+and front-facing polygons. Back-facing polygons use separate stencil
+state. See @code{glStencilOpSeparate}.
+
+@item @code{GL_STENCIL_REF}
+
+
+@var{params} returns one value, the reference value that is compared
+with the contents of the stencil buffer. The initial value is 0. See
+@code{glStencilFunc}. If the GL version is 2.0 or greater, this stencil
+state only affects non-polygons and front-facing polygons. Back-facing
+polygons use separate stencil state. See @code{glStencilFuncSeparate}.
+
+@item @code{GL_STENCIL_TEST}
+
+
+@var{params} returns a single boolean value indicating whether stencil
+testing of fragments is enabled. The initial value is @code{GL_FALSE}.
+See @code{glStencilFunc} and @code{glStencilOp}.
+
+@item @code{GL_STENCIL_VALUE_MASK}
+
+
+@var{params} returns one value, the mask that is used to mask both the
+stencil reference value and the stencil buffer value before they are
+compared. The initial value is all 1's. See @code{glStencilFunc}. If the
+GL version is 2.0 or greater, this stencil state only affects
+non-polygons and front-facing polygons. Back-facing polygons use
+separate stencil state. See @code{glStencilFuncSeparate}.
+
+@item @code{GL_STENCIL_WRITEMASK}
+
+
+@var{params} returns one value, the mask that controls writing of the
+stencil bitplanes. The initial value is all 1's. See
+@code{glStencilMask}. If the GL version is 2.0 or greater, this stencil
+state only affects non-polygons and front-facing polygons. Back-facing
+polygons use separate stencil state. See @code{glStencilMaskSeparate}.
+
+@item @code{GL_STEREO}
+
+
+@var{params} returns a single boolean value indicating whether stereo
+buffers (left and right) are supported.
+
+@item @code{GL_SUBPIXEL_BITS}
+
+
+@var{params} returns one value, an estimate of the number of bits of
+subpixel resolution that are used to position rasterized geometry in
+window coordinates. The value must be at least 4.
+
+@item @code{GL_TEXTURE_1D}
+
+
+@var{params} returns a single boolean value indicating whether 1D
+texture mapping is enabled. The initial value is @code{GL_FALSE}. See
+@code{glTexImage1D}.
+
+@item @code{GL_TEXTURE_BINDING_1D}
+
+
+@var{params} returns a single value, the name of the texture currently
+bound to the target @code{GL_TEXTURE_1D}. The initial value is 0. See
+@code{glBindTexture}.
+
+@item @code{GL_TEXTURE_2D}
+
+
+@var{params} returns a single boolean value indicating whether 2D
+texture mapping is enabled. The initial value is @code{GL_FALSE}. See
+@code{glTexImage2D}.
+
+@item @code{GL_TEXTURE_BINDING_2D}
+
+
+@var{params} returns a single value, the name of the texture currently
+bound to the target @code{GL_TEXTURE_2D}. The initial value is 0. See
+@code{glBindTexture}.
+
+@item @code{GL_TEXTURE_3D}
+
+
+@var{params} returns a single boolean value indicating whether 3D
+texture mapping is enabled. The initial value is @code{GL_FALSE}. See
+@code{glTexImage3D}.
+
+@item @code{GL_TEXTURE_BINDING_3D}
+
+
+@var{params} returns a single value, the name of the texture currently
+bound to the target @code{GL_TEXTURE_3D}. The initial value is 0. See
+@code{glBindTexture}.
+
+@item @code{GL_TEXTURE_BINDING_CUBE_MAP}
+
+
+@var{params} returns a single value, the name of the texture currently
+bound to the target @code{GL_TEXTURE_CUBE_MAP}. The initial value is 0.
+See @code{glBindTexture}.
+
+@item @code{GL_TEXTURE_COMPRESSION_HINT}
+
+
+@var{params} returns a single value indicating the mode of the texture
+compression hint. The initial value is @code{GL_DONT_CARE}.
+
+@item @code{GL_TEXTURE_COORD_ARRAY}
+
+
+@var{params} returns a single boolean value indicating whether the
+texture coordinate array is enabled. The initial value is
+@code{GL_FALSE}. See @code{glTexCoordPointer}.
+
+@item @code{GL_TEXTURE_COORD_ARRAY_BUFFER_BINDING}
+
+
+@var{params} returns a single value, the name of the buffer object
+associated with the texture coordinate array. This buffer object would
+have been bound to the target @code{GL_ARRAY_BUFFER} at the time of the
+most recent call to @code{glTexCoordPointer}. If no buffer object was
+bound to this target, 0 is returned. The initial value is 0. See
+@code{glBindBuffer}.
+
+@item @code{GL_TEXTURE_COORD_ARRAY_SIZE}
+
+
+@var{params} returns one value, the number of coordinates per element in
+the texture coordinate array. The initial value is 4. See
+@code{glTexCoordPointer}.
+
+@item @code{GL_TEXTURE_COORD_ARRAY_STRIDE}
+
+
+@var{params} returns one value, the byte offset between consecutive
+elements in the texture coordinate array. The initial value is 0. See
+@code{glTexCoordPointer}.
+
+@item @code{GL_TEXTURE_COORD_ARRAY_TYPE}
+
+
+@var{params} returns one value, the data type of the coordinates in the
+texture coordinate array. The initial value is @code{GL_FLOAT}. See
+@code{glTexCoordPointer}.
+
+@item @code{GL_TEXTURE_CUBE_MAP}
+
+
+@var{params} returns a single boolean value indicating whether
+cube-mapped texture mapping is enabled. The initial value is
+@code{GL_FALSE}. See @code{glTexImage2D}.
+
+@item @code{GL_TEXTURE_GEN_Q}
+
+
+@var{params} returns a single boolean value indicating whether automatic
+generation of the @var{q} texture coordinate is enabled. The initial
+value is @code{GL_FALSE}. See @code{glTexGen}.
+
+@item @code{GL_TEXTURE_GEN_R}
+
+
+@var{params} returns a single boolean value indicating whether automatic
+generation of the @var{r} texture coordinate is enabled. The initial
+value is @code{GL_FALSE}. See @code{glTexGen}.
+
+@item @code{GL_TEXTURE_GEN_S}
+
+
+@var{params} returns a single boolean value indicating whether automatic
+generation of the @var{S} texture coordinate is enabled. The initial
+value is @code{GL_FALSE}. See @code{glTexGen}.
+
+@item @code{GL_TEXTURE_GEN_T}
+
+
+@var{params} returns a single boolean value indicating whether automatic
+generation of the T texture coordinate is enabled. The initial value is
+@code{GL_FALSE}. See @code{glTexGen}.
+
+@item @code{GL_TEXTURE_MATRIX}
+
+
+@var{params} returns sixteen values: the texture matrix on the top of
+the texture matrix stack. Initially this matrix is the identity matrix.
+See @code{glPushMatrix}.
+
+@item @code{GL_TEXTURE_STACK_DEPTH}
+
+
+@var{params} returns one value, the number of matrices on the texture
+matrix stack. The initial value is 1. See @code{glPushMatrix}.
+
+@item @code{GL_TRANSPOSE_COLOR_MATRIX}
+
+
+@var{params} returns 16 values, the elements of the color matrix in
+row-major order. See @code{glLoadTransposeMatrix}.
+
+@item @code{GL_TRANSPOSE_MODELVIEW_MATRIX}
+
+
+@var{params} returns 16 values, the elements of the modelview matrix in
+row-major order. See @code{glLoadTransposeMatrix}.
+
+@item @code{GL_TRANSPOSE_PROJECTION_MATRIX}
+
+
+@var{params} returns 16 values, the elements of the projection matrix in
+row-major order. See @code{glLoadTransposeMatrix}.
+
+@item @code{GL_TRANSPOSE_TEXTURE_MATRIX}
+
+
+@var{params} returns 16 values, the elements of the texture matrix in
+row-major order. See @code{glLoadTransposeMatrix}.
+
+@item @code{GL_UNPACK_ALIGNMENT}
+
+
+@var{params} returns one value, the byte alignment used for reading
+pixel data from memory. The initial value is 4. See @code{glPixelStore}.
+
+@item @code{GL_UNPACK_IMAGE_HEIGHT}
+
+
+@var{params} returns one value, the image height used for reading pixel
+data from memory. The initial is 0. See @code{glPixelStore}.
+
+@item @code{GL_UNPACK_LSB_FIRST}
+
+
+@var{params} returns a single boolean value indicating whether
+single-bit pixels being read from memory are read first from the least
+significant bit of each unsigned byte. The initial value is
+@code{GL_FALSE}. See @code{glPixelStore}.
+
+@item @code{GL_UNPACK_ROW_LENGTH}
+
+
+@var{params} returns one value, the row length used for reading pixel
+data from memory. The initial value is 0. See @code{glPixelStore}.
+
+@item @code{GL_UNPACK_SKIP_IMAGES}
+
+
+@var{params} returns one value, the number of pixel images skipped
+before the first pixel is read from memory. The initial value is 0. See
+@code{glPixelStore}.
+
+@item @code{GL_UNPACK_SKIP_PIXELS}
+
+
+@var{params} returns one value, the number of pixel locations skipped
+before the first pixel is read from memory. The initial value is 0. See
+@code{glPixelStore}.
+
+@item @code{GL_UNPACK_SKIP_ROWS}
+
+
+@var{params} returns one value, the number of rows of pixel locations
+skipped before the first pixel is read from memory. The initial value is
+0. See @code{glPixelStore}.
+
+@item @code{GL_UNPACK_SWAP_BYTES}
+
+
+@var{params} returns a single boolean value indicating whether the bytes
+of two-byte and four-byte pixel indices and components are swapped after
+being read from memory. The initial value is @code{GL_FALSE}. See
+@code{glPixelStore}.
+
+@item @code{GL_VERTEX_ARRAY}
+
+
+@var{params} returns a single boolean value indicating whether the
+vertex array is enabled. The initial value is @code{GL_FALSE}. See
+@code{glVertexPointer}.
+
+@item @code{GL_VERTEX_ARRAY_BUFFER_BINDING}
+
+
+@var{params} returns a single value, the name of the buffer object
+associated with the vertex array. This buffer object would have been
+bound to the target @code{GL_ARRAY_BUFFER} at the time of the most
+recent call to @code{glVertexPointer}. If no buffer object was bound to
+this target, 0 is returned. The initial value is 0. See
+@code{glBindBuffer}.
+
+@item @code{GL_VERTEX_ARRAY_SIZE}
+
+
+@var{params} returns one value, the number of coordinates per vertex in
+the vertex array. The initial value is 4. See @code{glVertexPointer}.
+
+@item @code{GL_VERTEX_ARRAY_STRIDE}
+
+
+@var{params} returns one value, the byte offset between consecutive
+vertices in the vertex array. The initial value is 0. See
+@code{glVertexPointer}.
+
+@item @code{GL_VERTEX_ARRAY_TYPE}
+
+
+@var{params} returns one value, the data type of each coordinate in the
+vertex array. The initial value is @code{GL_FLOAT}. See
+@code{glVertexPointer}.
+
+@item @code{GL_VERTEX_PROGRAM_POINT_SIZE}
+
+
+@var{params} returns a single boolean value indicating whether vertex
+program point size mode is enabled. If enabled, and a vertex shader is
+active, then the point size is taken from the shader built-in
+@code{gl_PointSize}. If disabled, and a vertex shader is active, then
+the point size is taken from the point state as specified by
+@code{glPointSize}. The initial value is @code{GL_FALSE}.
+
+@item @code{GL_VERTEX_PROGRAM_TWO_SIDE}
+
+
+@var{params} returns a single boolean value indicating whether vertex
+program two-sided color mode is enabled. If enabled, and a vertex shader
+is active, then the GL chooses the back color output for back-facing
+polygons, and the front color output for non-polygons and front-facing
+polygons. If disabled, and a vertex shader is active, then the front
+color output is always selected. The initial value is @code{GL_FALSE}.
+
+@item @code{GL_VIEWPORT}
+
+
+@var{params} returns four values: the @math{@var{x}} and @math{@var{y}}
+window coordinates of the viewport, followed by its width and height.
+Initially the @math{@var{x}} and @math{@var{y}} window coordinates are
+both set to 0, and the width and height are set to the width and height
+of the window into which the GL will do its rendering. See
+@code{glViewport}.
+
+@item @code{GL_ZOOM_X}
+
+
+@var{params} returns one value, the @math{@var{x}} pixel zoom factor.
+The initial value is 1. See @code{glPixelZoom}.
+
+@item @code{GL_ZOOM_Y}
+
+
+@var{params} returns one value, the @math{@var{y}} pixel zoom factor.
+The initial value is 1. See @code{glPixelZoom}.
+
+@end table
+
+Many of the boolean parameters can also be queried more easily using
+@code{glIsEnabled}.
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{pname} is not an accepted
+value.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glGet} is executed
+between the execution of @code{glBegin} and the corresponding execution
+of @code{glEnd}.
+
+
+
+@end defun
+
+@defun glHint
+@heading specify implementation-specific hints
+@heading Parameters
+@table @asis
+@item @var{target}
+Specifies a symbolic constant indicating the behavior to be controlled.
+@code{GL_FOG_HINT}, @code{GL_GENERATE_MIPMAP_HINT},
+@code{GL_LINE_SMOOTH_HINT}, @code{GL_PERSPECTIVE_CORRECTION_HINT},
+@code{GL_POINT_SMOOTH_HINT}, @code{GL_POLYGON_SMOOTH_HINT},
+@code{GL_TEXTURE_COMPRESSION_HINT}, and
+@code{GL_FRAGMENT_SHADER_DERIVATIVE_HINT} are accepted.
+
+@item @var{mode}
+Specifies a symbolic constant indicating the desired behavior.
+@code{GL_FASTEST}, @code{GL_NICEST}, and @code{GL_DONT_CARE} are
+accepted.
+
+@end table
+
+@heading Description
+Certain aspects of GL behavior, when there is room for interpretation,
+can be controlled with hints. A hint is specified with two arguments.
+@var{target} is a symbolic constant indicating the behavior to be
+controlled, and @var{mode} is another symbolic constant indicating the
+desired behavior. The initial value for each @var{target} is
+@code{GL_DONT_CARE}. @var{mode} can be one of the following:
+
+@table @asis
+@item @code{GL_FASTEST}
+
+
+The most efficient option should be chosen.
+
+@item @code{GL_NICEST}
+
+
+The most correct, or highest quality, option should be chosen.
+
+@item @code{GL_DONT_CARE}
+
+
+No preference.
+
+@end table
+
+Though the implementation aspects that can be hinted are well defined,
+the interpretation of the hints depends on the implementation. The hint
+aspects that can be specified with @var{target}, along with suggested
+semantics, are as follows:
+
+@table @asis
+@item @code{GL_FOG_HINT}
+
+
+Indicates the accuracy of fog calculation. If per-pixel fog calculation
+is not efficiently supported by the GL implementation, hinting
+@code{GL_DONT_CARE} or @code{GL_FASTEST} can result in per-vertex
+calculation of fog effects.
+
+@item @code{GL_FRAGMENT_SHADER_DERIVATIVE_HINT}
+
+
+Indicates the accuracy of the derivative calculation for the GL shading
+language fragment processing built-in functions: @code{dFdx},
+@code{dFdy}, and @code{fwidth}.
+
+@item @code{GL_GENERATE_MIPMAP_HINT}
+
+
+Indicates the quality of filtering when generating mipmap images.
+
+@item @code{GL_LINE_SMOOTH_HINT}
+
+
+Indicates the sampling quality of antialiased lines. If a larger filter
+function is applied, hinting @code{GL_NICEST} can result in more pixel
+fragments being generated during rasterization.
+
+@item @code{GL_PERSPECTIVE_CORRECTION_HINT}
+
+
+Indicates the quality of color, texture coordinate, and fog coordinate
+interpolation. If perspective-corrected parameter interpolation is not
+efficiently supported by the GL implementation, hinting
+@code{GL_DONT_CARE} or @code{GL_FASTEST} can result in simple linear
+interpolation of colors and/or texture coordinates.
+
+@item @code{GL_POINT_SMOOTH_HINT}
+
+
+Indicates the sampling quality of antialiased points. If a larger filter
+function is applied, hinting @code{GL_NICEST} can result in more pixel
+fragments being generated during rasterization.
+
+@item @code{GL_POLYGON_SMOOTH_HINT}
+
+
+Indicates the sampling quality of antialiased polygons. Hinting
+@code{GL_NICEST} can result in more pixel fragments being generated
+during rasterization, if a larger filter function is applied.
+
+@item @code{GL_TEXTURE_COMPRESSION_HINT}
+
+
+Indicates the quality and performance of the compressing texture images.
+Hinting @code{GL_FASTEST} indicates that texture images should be
+compressed as quickly as possible, while @code{GL_NICEST} indicates that
+texture images should be compressed with as little image quality loss as
+possible. @code{GL_NICEST} should be selected if the texture is to be
+retrieved by @code{glGetCompressedTexImage} for reuse.
+
+@end table
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if either @var{target} or @var{mode}
+is not an accepted value.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glHint} is executed
+between the execution of @code{glBegin} and the corresponding execution
+of @code{glEnd}.
+
+@end defun
+
+@defun glHistogram
+@heading define histogram table
+@heading Parameters
+@table @asis
+@item @var{target}
+The histogram whose parameters are to be set. Must be one of
+@code{GL_HISTOGRAM} or @code{GL_PROXY_HISTOGRAM}.
+
+@item @var{width}
+The number of entries in the histogram table. Must be a power of 2.
+
+@item @var{internalformat}
+The format of entries in the histogram table. Must be one of
+@code{GL_ALPHA}, @code{GL_ALPHA4}, @code{GL_ALPHA8}, @code{GL_ALPHA12},
+@code{GL_ALPHA16}, @code{GL_LUMINANCE}, @code{GL_LUMINANCE4},
+@code{GL_LUMINANCE8}, @code{GL_LUMINANCE12}, @code{GL_LUMINANCE16},
+@code{GL_LUMINANCE_ALPHA}, @code{GL_LUMINANCE4_ALPHA4},
+@code{GL_LUMINANCE6_ALPHA2}, @code{GL_LUMINANCE8_ALPHA8},
+@code{GL_LUMINANCE12_ALPHA4}, @code{GL_LUMINANCE12_ALPHA12},
+@code{GL_LUMINANCE16_ALPHA16}, @code{GL_R3_G3_B2}, @code{GL_RGB},
+@code{GL_RGB4}, @code{GL_RGB5}, @code{GL_RGB8}, @code{GL_RGB10},
+@code{GL_RGB12}, @code{GL_RGB16}, @code{GL_RGBA}, @code{GL_RGBA2},
+@code{GL_RGBA4}, @code{GL_RGB5_A1}, @code{GL_RGBA8}, @code{GL_RGB10_A2},
+@code{GL_RGBA12}, or @code{GL_RGBA16}.
+
+@item @var{sink}
+If @code{GL_TRUE}, pixels will be consumed by the histogramming process
+and no drawing or texture loading will take place. If @code{GL_FALSE},
+pixels will proceed to the minmax process after histogramming.
+
+@end table
+
+@heading Description
+When @code{GL_HISTOGRAM} is enabled, RGBA color components are converted
+to histogram table indices by clamping to the range [0,1], multiplying
+by the width of the histogram table, and rounding to the nearest
+integer. The table entries selected by the RGBA indices are then
+incremented. (If the internal format of the histogram table includes
+luminance, then the index derived from the R color component determines
+the luminance table entry to be incremented.) If a histogram table entry
+is incremented beyond its maximum value, then its value becomes
+undefined. (This is not an error.)
+
+Histogramming is performed only for RGBA pixels (though these may be
+specified originally as color indices and converted to RGBA by index
+table lookup). Histogramming is enabled with @code{glEnable} and
+disabled with @code{glDisable}.
+
+When @var{target} is @code{GL_HISTOGRAM}, @code{glHistogram} redefines
+the current histogram table to have @var{width} entries of the format
+specified by @var{internalformat}. The entries are indexed 0 through
+@math{@var{width}-1}, and all entries are initialized to zero. The
+values in the previous histogram table, if any, are lost. If @var{sink}
+is @code{GL_TRUE}, then pixels are discarded after histogramming; no
+further processing of the pixels takes place, and no drawing, texture
+loading, or pixel readback will result.
+
+When @var{target} is @code{GL_PROXY_HISTOGRAM}, @code{glHistogram}
+computes all state information as if the histogram table were to be
+redefined, but does not actually define the new table. If the requested
+histogram table is too large to be supported, then the state information
+will be set to zero. This provides a way to determine if a histogram
+table with the given parameters can be supported.
+
+
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{target} is not one of the
+allowable values.
+
+@code{GL_INVALID_VALUE} is generated if @var{width} is less than zero or
+is not a power of 2.
+
+@code{GL_INVALID_ENUM} is generated if @var{internalformat} is not one
+of the allowable values.
+
+@code{GL_TABLE_TOO_LARGE} is generated if @var{target} is
+@code{GL_HISTOGRAM} and the histogram table specified is too large for
+the implementation.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glHistogram} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glIndexMask
+@heading control the writing of individual bits in the color index buffers
+@heading Parameters
+@table @asis
+@item @var{mask}
+Specifies a bit mask to enable and disable the writing of individual
+bits in the color index buffers. Initially, the mask is all 1's.
+
+@end table
+
+@heading Description
+@code{glIndexMask} controls the writing of individual bits in the color
+index buffers. The least significant @math{@var{n}} bits of @var{mask},
+where @math{@var{n}} is the number of bits in a color index buffer,
+specify a mask. Where a 1 (one) appears in the mask, it's possible to
+write to the corresponding bit in the color index buffer (or buffers).
+Where a 0 (zero) appears, the corresponding bit is write-protected.
+
+This mask is used only in color index mode, and it affects only the
+buffers currently selected for writing (see @code{glDrawBuffer}).
+Initially, all bits are enabled for writing.
+
+@heading Errors
+@code{GL_INVALID_OPERATION} is generated if @code{glIndexMask} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glIndexPointer
+@heading define an array of color indexes
+@heading Parameters
+@table @asis
+@item @var{type}
+Specifies the data type of each color index in the array. Symbolic
+constants @code{GL_UNSIGNED_BYTE}, @code{GL_SHORT}, @code{GL_INT},
+@code{GL_FLOAT}, and @code{GL_DOUBLE} are accepted. The initial value is
+@code{GL_FLOAT}.
+
+@item @var{stride}
+Specifies the byte offset between consecutive color indexes. If
+@var{stride} is 0, the color indexes are understood to be tightly packed
+in the array. The initial value is 0.
+
+@item @var{pointer}
+Specifies a pointer to the first index in the array. The initial value
+is 0.
+
+@end table
+
+@heading Description
+@code{glIndexPointer} specifies the location and data format of an array
+of color indexes to use when rendering. @var{type} specifies the data
+type of each color index and @var{stride} specifies the byte stride from
+one color index to the next, allowing vertices and attributes to be
+packed into a single array or stored in separate arrays.
+
+If a non-zero named buffer object is bound to the @code{GL_ARRAY_BUFFER}
+target (see @code{glBindBuffer}) while a color index array is specified,
+@var{pointer} is treated as a byte offset into the buffer object's data
+store. Also, the buffer object binding (@code{GL_ARRAY_BUFFER_BINDING})
+is saved as color index vertex array client-side state
+(@code{GL_INDEX_ARRAY_BUFFER_BINDING}).
+
+When a color index array is specified, @var{type}, @var{stride}, and
+@var{pointer} are saved as client-side state, in addition to the current
+vertex array buffer object binding.
+
+To enable and disable the color index array, call
+@code{glEnableClientState} and @code{glDisableClientState} with the
+argument @code{GL_INDEX_ARRAY}. If enabled, the color index array is
+used when @code{glDrawArrays}, @code{glMultiDrawArrays},
+@code{glDrawElements}, @code{glMultiDrawElements},
+@code{glDrawRangeElements}, or @code{glArrayElement} is called.
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{type} is not an accepted
+value.
+
+@code{GL_INVALID_VALUE} is generated if @var{stride} is negative.
+
+@end defun
+
+@defun glIndex
+@heading set the current color index
+@heading Parameters
+@table @asis
+@item @var{c}
+Specifies the new value for the current color index.
+
+
+
+@end table
+
+@heading Description
+@code{glIndex} updates the current (single-valued) color index. It takes
+one argument, the new value for the current color index.
+
+The current index is stored as a floating-point value. Integer values
+are converted directly to floating-point values, with no special
+mapping. The initial value is 1.
+
+Index values outside the representable range of the color index buffer
+are not clamped. However, before an index is dithered (if enabled) and
+written to the frame buffer, it is converted to fixed-point format. Any
+bits in the integer portion of the resulting fixed-point value that do
+not correspond to bits in the frame buffer are masked out.
+
+@end defun
+
+@defun glInitNames
+@heading initialize the name stack
+@heading Description
+The name stack is used during selection mode to allow sets of rendering
+commands to be uniquely identified. It consists of an ordered set of
+unsigned integers. @code{glInitNames} causes the name stack to be
+initialized to its default empty state.
+
+The name stack is always empty while the render mode is not
+@code{GL_SELECT}. Calls to @code{glInitNames} while the render mode is
+not @code{GL_SELECT} are ignored.
+
+@heading Errors
+@code{GL_INVALID_OPERATION} is generated if @code{glInitNames} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glInterleavedArrays
+@heading simultaneously specify and enable several interleaved arrays
+@heading Parameters
+@table @asis
+@item @var{format}
+Specifies the type of array to enable. Symbolic constants @code{GL_V2F},
+@code{GL_V3F}, @code{GL_C4UB_V2F}, @code{GL_C4UB_V3F},
+@code{GL_C3F_V3F}, @code{GL_N3F_V3F}, @code{GL_C4F_N3F_V3F},
+@code{GL_T2F_V3F}, @code{GL_T4F_V4F}, @code{GL_T2F_C4UB_V3F},
+@code{GL_T2F_C3F_V3F}, @code{GL_T2F_N3F_V3F}, @code{GL_T2F_C4F_N3F_V3F},
+and @code{GL_T4F_C4F_N3F_V4F} are accepted.
+
+@item @var{stride}
+Specifies the offset in bytes between each aggregate array element.
+
+@end table
+
+@heading Description
+@code{glInterleavedArrays} lets you specify and enable individual color,
+normal, texture and vertex arrays whose elements are part of a larger
+aggregate array element. For some implementations, this is more
+efficient than specifying the arrays separately.
+
+If @var{stride} is 0, the aggregate elements are stored consecutively.
+Otherwise, @var{stride} bytes occur between the beginning of one
+aggregate array element and the beginning of the next aggregate array
+element.
+
+@var{format} serves as a ``key'' describing the extraction of individual
+arrays from the aggregate array. If @var{format} contains a T, then
+texture coordinates are extracted from the interleaved array. If C is
+present, color values are extracted. If N is present, normal coordinates
+are extracted. Vertex coordinates are always extracted.
+
+The digits 2, 3, and 4 denote how many values are extracted. F indicates
+that values are extracted as floating-point values. Colors may also be
+extracted as 4 unsigned bytes if 4UB follows the C. If a color is
+extracted as 4 unsigned bytes, the vertex array element which follows is
+located at the first possible floating-point aligned address.
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{format} is not an accepted
+value.
+
+@code{GL_INVALID_VALUE} is generated if @var{stride} is negative.
+
+@end defun
+
+@defun glIsBuffer
+@heading determine if a name corresponds to a buffer object
+@heading Parameters
+@table @asis
+@item @var{buffer}
+Specifies a value that may be the name of a buffer object.
+
+@end table
+
+@heading Description
+@code{glIsBuffer} returns @code{GL_TRUE} if @var{buffer} is currently
+the name of a buffer object. If @var{buffer} is zero, or is a non-zero
+value that is not currently the name of a buffer object, or if an error
+occurs, @code{glIsBuffer} returns @code{GL_FALSE}.
+
+A name returned by @code{glGenBuffers}, but not yet associated with a
+buffer object by calling @code{glBindBuffer}, is not the name of a
+buffer object.
+
+@heading Errors
+@code{GL_INVALID_OPERATION} is generated if @code{glIsBuffer} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glIsEnabled
+@heading test whether a capability is enabled
+@heading Parameters
+@table @asis
+@item @var{cap}
+Specifies a symbolic constant indicating a GL capability.
+
+@end table
+
+@heading Description
+@code{glIsEnabled} returns @code{GL_TRUE} if @var{cap} is an enabled
+capability and returns @code{GL_FALSE} otherwise. Initially all
+capabilities except @code{GL_DITHER} are disabled; @code{GL_DITHER} is
+initially enabled.
+
+The following capabilities are accepted for @var{cap}:
+
+
+
+@table @asis
+@item @strong{Constant}
+@strong{See}
+
+@item @code{GL_ALPHA_TEST}
+@code{glAlphaFunc}
+
+@item @code{GL_AUTO_NORMAL}
+@code{glEvalCoord}
+
+@item @code{GL_BLEND}
+@code{glBlendFunc}, @code{glLogicOp}
+
+@item @code{GL_CLIP_PLANE}@var{i}
+@code{glClipPlane}
+
+@item @code{GL_COLOR_ARRAY}
+@code{glColorPointer}
+
+@item @code{GL_COLOR_LOGIC_OP}
+@code{glLogicOp}
+
+@item @code{GL_COLOR_MATERIAL}
+@code{glColorMaterial}
+
+@item @code{GL_COLOR_SUM}
+@code{glSecondaryColor}
+
+@item @code{GL_COLOR_TABLE}
+@code{glColorTable}
+
+@item @code{GL_CONVOLUTION_1D}
+@code{glConvolutionFilter1D}
+
+@item @code{GL_CONVOLUTION_2D}
+@code{glConvolutionFilter2D}
+
+@item @code{GL_CULL_FACE}
+@code{glCullFace}
+
+@item @code{GL_DEPTH_TEST}
+@code{glDepthFunc}, @code{glDepthRange}
+
+@item @code{GL_DITHER}
+@code{glEnable}
+
+@item @code{GL_EDGE_FLAG_ARRAY}
+@code{glEdgeFlagPointer}
+
+@item @code{GL_FOG}
+@code{glFog}
+
+@item @code{GL_FOG_COORD_ARRAY}
+@code{glFogCoordPointer}
+
+@item @code{GL_HISTOGRAM}
+@code{glHistogram}
+
+@item @code{GL_INDEX_ARRAY}
+@code{glIndexPointer}
+
+@item @code{GL_INDEX_LOGIC_OP}
+@code{glLogicOp}
+
+@item @code{GL_LIGHT}@var{i}
+@code{glLightModel}, @code{glLight}
+
+@item @code{GL_LIGHTING}
+@code{glMaterial}, @code{glLightModel}, @code{glLight}
+
+@item @code{GL_LINE_SMOOTH}
+@code{glLineWidth}
+
+@item @code{GL_LINE_STIPPLE}
+@code{glLineStipple}
+
+@item @code{GL_MAP1_COLOR_4}
+@code{glMap1}
+
+@item @code{GL_MAP1_INDEX}
+@code{glMap1}
+
+@item @code{GL_MAP1_NORMAL}
+@code{glMap1}
+
+@item @code{GL_MAP1_TEXTURE_COORD_1}
+@code{glMap1}
+
+@item @code{GL_MAP1_TEXTURE_COORD_2}
+@code{glMap1}
+
+@item @code{GL_MAP1_TEXTURE_COORD_3}
+@code{glMap1}
+
+@item @code{GL_MAP1_TEXTURE_COORD_4}
+@code{glMap1}
+
+@item @code{GL_MAP2_COLOR_4}
+@code{glMap2}
+
+@item @code{GL_MAP2_INDEX}
+@code{glMap2}
+
+@item @code{GL_MAP2_NORMAL}
+@code{glMap2}
+
+@item @code{GL_MAP2_TEXTURE_COORD_1}
+@code{glMap2}
+
+@item @code{GL_MAP2_TEXTURE_COORD_2}
+@code{glMap2}
+
+@item @code{GL_MAP2_TEXTURE_COORD_3}
+@code{glMap2}
+
+@item @code{GL_MAP2_TEXTURE_COORD_4}
+@code{glMap2}
+
+@item @code{GL_MAP2_VERTEX_3}
+@code{glMap2}
+
+@item @code{GL_MAP2_VERTEX_4}
+@code{glMap2}
+
+@item @code{GL_MINMAX}
+@code{glMinmax}
+
+@item @code{GL_MULTISAMPLE}
+@code{glSampleCoverage}
+
+@item @code{GL_NORMAL_ARRAY}
+@code{glNormalPointer}
+
+@item @code{GL_NORMALIZE}
+@code{glNormal}
+
+@item @code{GL_POINT_SMOOTH}
+@code{glPointSize}
+
+@item @code{GL_POINT_SPRITE}
+@code{glEnable}
+
+@item @code{GL_POLYGON_SMOOTH}
+@code{glPolygonMode}
+
+@item @code{GL_POLYGON_OFFSET_FILL}
+@code{glPolygonOffset}
+
+@item @code{GL_POLYGON_OFFSET_LINE}
+@code{glPolygonOffset}
+
+@item @code{GL_POLYGON_OFFSET_POINT}
+@code{glPolygonOffset}
+
+@item @code{GL_POLYGON_STIPPLE}
+@code{glPolygonStipple}
+
+@item @code{GL_POST_COLOR_MATRIX_COLOR_TABLE}
+@code{glColorTable}
+
+@item @code{GL_POST_CONVOLUTION_COLOR_TABLE}
+@code{glColorTable}
+
+@item @code{GL_RESCALE_NORMAL}
+@code{glNormal}
+
+@item @code{GL_SAMPLE_ALPHA_TO_COVERAGE}
+@code{glSampleCoverage}
+
+@item @code{GL_SAMPLE_ALPHA_TO_ONE}
+@code{glSampleCoverage}
+
+@item @code{GL_SAMPLE_COVERAGE}
+@code{glSampleCoverage}
+
+@item @code{GL_SCISSOR_TEST}
+@code{glScissor}
+
+@item @code{GL_SECONDARY_COLOR_ARRAY}
+@code{glSecondaryColorPointer}
+
+@item @code{GL_SEPARABLE_2D}
+@code{glSeparableFilter2D}
+
+@item @code{GL_STENCIL_TEST}
+@code{glStencilFunc}, @code{glStencilOp}
+
+@item @code{GL_TEXTURE_1D}
+@code{glTexImage1D}
+
+@item @code{GL_TEXTURE_2D}
+@code{glTexImage2D}
+
+@item @code{GL_TEXTURE_3D}
+@code{glTexImage3D}
+
+@item @code{GL_TEXTURE_COORD_ARRAY}
+@code{glTexCoordPointer}
+
+@item @code{GL_TEXTURE_CUBE_MAP}
+@code{glTexImage2D}
+
+@item @code{GL_TEXTURE_GEN_Q}
+@code{glTexGen}
+
+@item @code{GL_TEXTURE_GEN_R}
+@code{glTexGen}
+
+@item @code{GL_TEXTURE_GEN_S}
+@code{glTexGen}
+
+@item @code{GL_TEXTURE_GEN_T}
+@code{glTexGen}
+
+@item @code{GL_VERTEX_ARRAY}
+@code{glVertexPointer}
+
+@item @code{GL_VERTEX_PROGRAM_POINT_SIZE}
+@code{glEnable}
+
+@item @code{GL_VERTEX_PROGRAM_TWO_SIDE}
+@code{glEnable}
+
+@end table
+
+
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{cap} is not an accepted
+value.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glIsEnabled} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glIsList
+@heading determine if a name corresponds to a display list
+@heading Parameters
+@table @asis
+@item @var{list}
+Specifies a potential display list name.
+
+@end table
+
+@heading Description
+@code{glIsList} returns @code{GL_TRUE} if @var{list} is the name of a
+display list and returns @code{GL_FALSE} if it is not, or if an error
+occurs.
+
+A name returned by @code{glGenLists}, but not yet associated with a
+display list by calling @code{glNewList}, is not the name of a display
+list.
+
+@heading Errors
+@code{GL_INVALID_OPERATION} is generated if @code{glIsList} is executed
+between the execution of @code{glBegin} and the corresponding execution
+of @code{glEnd}.
+
+@end defun
+
+@defun glIsProgram
+@heading Determines if a name corresponds to a program object
+@heading Parameters
+@table @asis
+@item @var{program}
+Specifies a potential program object.
+
+@end table
+
+@heading Description
+@code{glIsProgram} returns @code{GL_TRUE} if @var{program} is the name
+of a program object previously created with @code{glCreateProgram} and
+not yet deleted with @code{glDeleteProgram}. If @var{program} is zero or
+a non-zero value that is not the name of a program object, or if an
+error occurs, @code{glIsProgram} returns @code{GL_FALSE}.
+
+@heading Errors
+@code{GL_INVALID_OPERATION} is generated if @code{glIsProgram} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glIsQuery
+@heading determine if a name corresponds to a query object
+@heading Parameters
+@table @asis
+@item @var{id}
+Specifies a value that may be the name of a query object.
+
+@end table
+
+@heading Description
+@code{glIsQuery} returns @code{GL_TRUE} if @var{id} is currently the
+name of a query object. If @var{id} is zero, or is a non-zero value that
+is not currently the name of a query object, or if an error occurs,
+@code{glIsQuery} returns @code{GL_FALSE}.
+
+A name returned by @code{glGenQueries}, but not yet associated with a
+query object by calling @code{glBeginQuery}, is not the name of a query
+object.
+
+@heading Errors
+@code{GL_INVALID_OPERATION} is generated if @code{glIsQuery} is executed
+between the execution of @code{glBegin} and the corresponding execution
+of @code{glEnd}.
+
+@end defun
+
+@defun glIsShader
+@heading Determines if a name corresponds to a shader object
+@heading Parameters
+@table @asis
+@item @var{shader}
+Specifies a potential shader object.
+
+@end table
+
+@heading Description
+@code{glIsShader} returns @code{GL_TRUE} if @var{shader} is the name of
+a shader object previously created with @code{glCreateShader} and not
+yet deleted with @code{glDeleteShader}. If @var{shader} is zero or a
+non-zero value that is not the name of a shader object, or if an error
+occurs, @code{glIsShader } returns @code{GL_FALSE}.
+
+@heading Errors
+@code{GL_INVALID_OPERATION} is generated if @code{glIsShader} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glIsTexture
+@heading determine if a name corresponds to a texture
+@heading Parameters
+@table @asis
+@item @var{texture}
+Specifies a value that may be the name of a texture.
+
+@end table
+
+@heading Description
+@code{glIsTexture} returns @code{GL_TRUE} if @var{texture} is currently
+the name of a texture. If @var{texture} is zero, or is a non-zero value
+that is not currently the name of a texture, or if an error occurs,
+@code{glIsTexture} returns @code{GL_FALSE}.
+
+A name returned by @code{glGenTextures}, but not yet associated with a
+texture by calling @code{glBindTexture}, is not the name of a texture.
+
+@heading Errors
+@code{GL_INVALID_OPERATION} is generated if @code{glIsTexture} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glLightModel
+@heading set the lighting model parameters
+@heading Parameters
+@table @asis
+@item @var{pname}
+Specifies a single-valued lighting model parameter.
+@code{GL_LIGHT_MODEL_LOCAL_VIEWER}, @code{GL_LIGHT_MODEL_COLOR_CONTROL},
+and @code{GL_LIGHT_MODEL_TWO_SIDE} are accepted.
+
+@item @var{param}
+Specifies the value that @var{param} will be set to.
+
+@end table
+
+@heading Description
+@code{glLightModel} sets the lighting model parameter. @var{pname} names
+a parameter and @var{params} gives the new value. There are three
+lighting model parameters:
+
+@table @asis
+@item @code{GL_LIGHT_MODEL_AMBIENT}
+
+
+@var{params} contains four integer or floating-point values that specify
+the ambient RGBA intensity of the entire scene. Integer values are
+mapped linearly such that the most positive representable value maps to
+1.0, and the most negative representable value maps to @math{-1.0}.
+Floating-point values are mapped directly. Neither integer nor
+floating-point values are clamped. The initial ambient scene intensity
+is (0.2, 0.2, 0.2, 1.0).
+
+@item @code{GL_LIGHT_MODEL_COLOR_CONTROL}
+
+
+@var{params} must be either @code{GL_SEPARATE_SPECULAR_COLOR} or
+@code{GL_SINGLE_COLOR}. @code{GL_SINGLE_COLOR} specifies that a single
+color is generated from the lighting computation for a vertex.
+@code{GL_SEPARATE_SPECULAR_COLOR} specifies that the specular color
+computation of lighting be stored separately from the remainder of the
+lighting computation. The specular color is summed into the generated
+fragment's color after the application of texture mapping (if enabled).
+The initial value is @code{GL_SINGLE_COLOR}.
+
+@item @code{GL_LIGHT_MODEL_LOCAL_VIEWER}
+
+
+@var{params} is a single integer or floating-point value that specifies
+how specular reflection angles are computed. If @var{params} is 0 (or
+0.0), specular reflection angles take the view direction to be parallel
+to and in the direction of the -@var{z} axis, regardless of the location
+of the vertex in eye coordinates. Otherwise, specular reflections are
+computed from the origin of the eye coordinate system. The initial value
+is 0.
+
+@item @code{GL_LIGHT_MODEL_TWO_SIDE}
+
+
+@var{params} is a single integer or floating-point value that specifies
+whether one- or two-sided lighting calculations are done for polygons.
+It has no effect on the lighting calculations for points, lines, or
+bitmaps. If @var{params} is 0 (or 0.0), one-sided lighting is specified,
+and only the @var{front} material parameters are used in the lighting
+equation. Otherwise, two-sided lighting is specified. In this case,
+vertices of back-facing polygons are lighted using the @var{back}
+material parameters and have their normals reversed before the lighting
+equation is evaluated. Vertices of front-facing polygons are always
+lighted using the @var{front} material parameters, with no change to
+their normals. The initial value is 0.
+
+@end table
+
+In RGBA mode, the lighted color of a vertex is the sum of the material
+emission intensity, the product of the material ambient reflectance and
+the lighting model full-scene ambient intensity, and the contribution of
+each enabled light source. Each light source contributes the sum of
+three terms: ambient, diffuse, and specular. The ambient light source
+contribution is the product of the material ambient reflectance and the
+light's ambient intensity. The diffuse light source contribution is the
+product of the material diffuse reflectance, the light's diffuse
+intensity, and the dot product of the vertex's normal with the
+normalized vector from the vertex to the light source. The specular
+light source contribution is the product of the material specular
+reflectance, the light's specular intensity, and the dot product of the
+normalized vertex-to-eye and vertex-to-light vectors, raised to the
+power of the shininess of the material. All three light source
+contributions are attenuated equally based on the distance from the
+vertex to the light source and on light source direction, spread
+exponent, and spread cutoff angle. All dot products are replaced with 0
+if they evaluate to a negative value.
+
+The alpha component of the resulting lighted color is set to the alpha
+value of the material diffuse reflectance.
+
+In color index mode, the value of the lighted index of a vertex ranges
+from the ambient to the specular values passed to @code{glMaterial}
+using @code{GL_COLOR_INDEXES}. Diffuse and specular coefficients,
+computed with a (.30, .59, .11) weighting of the lights' colors, the
+shininess of the material, and the same reflection and attenuation
+equations as in the RGBA case, determine how much above ambient the
+resulting index is.
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{pname} is not an accepted
+value.
+
+@code{GL_INVALID_ENUM} is generated if @var{pname} is
+@code{GL_LIGHT_MODEL_COLOR_CONTROL} and @var{params} is not one of
+@code{GL_SINGLE_COLOR} or @code{GL_SEPARATE_SPECULAR_COLOR}.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glLightModel} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glLight
+@heading set light source parameters
+@heading Parameters
+@table @asis
+@item @var{light}
+Specifies a light. The number of lights depends on the implementation,
+but at least eight lights are supported. They are identified by symbolic
+names of the form @code{GL_LIGHT}@math{@var{i}}, where i ranges from 0
+to the value of @code{GL_MAX_LIGHTS} - 1.
+
+@item @var{pname}
+Specifies a single-valued light source parameter for @var{light}.
+@code{GL_SPOT_EXPONENT}, @code{GL_SPOT_CUTOFF},
+@code{GL_CONSTANT_ATTENUATION}, @code{GL_LINEAR_ATTENUATION}, and
+@code{GL_QUADRATIC_ATTENUATION} are accepted.
+
+@item @var{param}
+Specifies the value that parameter @var{pname} of light source
+@var{light} will be set to.
+
+@end table
+
+@heading Description
+@code{glLight} sets the values of individual light source parameters.
+@var{light} names the light and is a symbolic name of the form
+@code{GL_LIGHT}@math{@var{i}}, where i ranges from 0 to the value of
+@code{GL_MAX_LIGHTS} - 1. @var{pname} specifies one of ten light source
+parameters, again by symbolic name. @var{params} is either a single
+value or a pointer to an array that contains the new values.
+
+To enable and disable lighting calculation, call @code{glEnable} and
+@code{glDisable} with argument @code{GL_LIGHTING}. Lighting is initially
+disabled. When it is enabled, light sources that are enabled contribute
+to the lighting calculation. Light source @math{@var{i}} is enabled and
+disabled using @code{glEnable} and @code{glDisable} with argument
+@code{GL_LIGHT}@math{@var{i}}.
+
+The ten light parameters are as follows:
+
+@table @asis
+@item @code{GL_AMBIENT}
+@var{params} contains four integer or floating-point values that specify
+the ambient RGBA intensity of the light. Integer values are mapped
+linearly such that the most positive representable value maps to 1.0,
+and the most negative representable value maps to @math{-1.0}.
+Floating-point values are mapped directly. Neither integer nor
+floating-point values are clamped. The initial ambient light intensity
+is (0, 0, 0, 1).
+
+@item @code{GL_DIFFUSE}
+@var{params} contains four integer or floating-point values that specify
+the diffuse RGBA intensity of the light. Integer values are mapped
+linearly such that the most positive representable value maps to 1.0,
+and the most negative representable value maps to @math{-1.0}.
+Floating-point values are mapped directly. Neither integer nor
+floating-point values are clamped. The initial value for
+@code{GL_LIGHT0} is (1, 1, 1, 1); for other lights, the initial value is
+(0, 0, 0, 1).
+
+@item @code{GL_SPECULAR}
+@var{params} contains four integer or floating-point values that specify
+the specular RGBA intensity of the light. Integer values are mapped
+linearly such that the most positive representable value maps to 1.0,
+and the most negative representable value maps to @math{-1.0}.
+Floating-point values are mapped directly. Neither integer nor
+floating-point values are clamped. The initial value for
+@code{GL_LIGHT0} is (1, 1, 1, 1); for other lights, the initial value is
+(0, 0, 0, 1).
+
+@item @code{GL_POSITION}
+@var{params} contains four integer or floating-point values that specify
+the position of the light in homogeneous object coordinates. Both
+integer and floating-point values are mapped directly. Neither integer
+nor floating-point values are clamped.
+
+The position is transformed by the modelview matrix when @code{glLight}
+is called (just as if it were a point), and it is stored in eye
+coordinates. If the @math{@var{w}} component of the position is 0, the
+light is treated as a directional source. Diffuse and specular lighting
+calculations take the light's direction, but not its actual position,
+into account, and attenuation is disabled. Otherwise, diffuse and
+specular lighting calculations are based on the actual location of the
+light in eye coordinates, and attenuation is enabled. The initial
+position is (0, 0, 1, 0); thus, the initial light source is directional,
+parallel to, and in the direction of the @math{-@var{z}} axis.
+
+@item @code{GL_SPOT_DIRECTION}
+@var{params} contains three integer or floating-point values that
+specify the direction of the light in homogeneous object coordinates.
+Both integer and floating-point values are mapped directly. Neither
+integer nor floating-point values are clamped.
+
+The spot direction is transformed by the upper 3x3 of the modelview
+matrix when @code{glLight} is called, and it is stored in eye
+coordinates. It is significant only when @code{GL_SPOT_CUTOFF} is not
+180, which it is initially. The initial direction is @math{(0,0-1)}.
+
+@item @code{GL_SPOT_EXPONENT}
+@var{params} is a single integer or floating-point value that specifies
+the intensity distribution of the light. Integer and floating-point
+values are mapped directly. Only values in the range @math{[0,128]} are
+accepted.
+
+Effective light intensity is attenuated by the cosine of the angle
+between the direction of the light and the direction from the light to
+the vertex being lighted, raised to the power of the spot exponent.
+Thus, higher spot exponents result in a more focused light source,
+regardless of the spot cutoff angle (see @code{GL_SPOT_CUTOFF}, next
+paragraph). The initial spot exponent is 0, resulting in uniform light
+distribution.
+
+@item @code{GL_SPOT_CUTOFF}
+@var{params} is a single integer or floating-point value that specifies
+the maximum spread angle of a light source. Integer and floating-point
+values are mapped directly. Only values in the range @math{[0,90]} and
+the special value 180 are accepted. If the angle between the direction
+of the light and the direction from the light to the vertex being
+lighted is greater than the spot cutoff angle, the light is completely
+masked. Otherwise, its intensity is controlled by the spot exponent and
+the attenuation factors. The initial spot cutoff is 180, resulting in
+uniform light distribution.
+
+@item @code{GL_CONSTANT_ATTENUATION}
+@item @code{GL_LINEAR_ATTENUATION}
+@item @code{GL_QUADRATIC_ATTENUATION}
+@var{params} is a single integer or floating-point value that specifies
+one of the three light attenuation factors. Integer and floating-point
+values are mapped directly. Only nonnegative values are accepted. If the
+light is positional, rather than directional, its intensity is
+attenuated by the reciprocal of the sum of the constant factor, the
+linear factor times the distance between the light and the vertex being
+lighted, and the quadratic factor times the square of the same distance.
+The initial attenuation factors are (1, 0, 0), resulting in no
+attenuation.
+
+@end table
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if either @var{light} or @var{pname}
+is not an accepted value.
+
+@code{GL_INVALID_VALUE} is generated if a spot exponent value is
+specified outside the range @math{[0,128]}, or if spot cutoff is
+specified outside the range @math{[0,90]} (except for the special value
+180), or if a negative attenuation factor is specified.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glLight} is executed
+between the execution of @code{glBegin} and the corresponding execution
+of @code{glEnd}.
+
+@end defun
+
+@defun glLineStipple
+@heading specify the line stipple pattern
+@heading Parameters
+@table @asis
+@item @var{factor}
+Specifies a multiplier for each bit in the line stipple pattern. If
+@var{factor} is 3, for example, each bit in the pattern is used three
+times before the next bit in the pattern is used. @var{factor} is
+clamped to the range [1, 256] and defaults to 1.
+
+@item @var{pattern}
+Specifies a 16-bit integer whose bit pattern determines which fragments
+of a line will be drawn when the line is rasterized. Bit zero is used
+first; the default pattern is all 1's.
+
+@end table
+
+@heading Description
+Line stippling masks out certain fragments produced by rasterization;
+those fragments will not be drawn. The masking is achieved by using
+three parameters: the 16-bit line stipple pattern @var{pattern}, the
+repeat count @var{factor}, and an integer stipple counter
+@math{@var{s}}.
+
+Counter @math{@var{s}} is reset to 0 whenever @code{glBegin} is called
+and before each line segment of a
+@code{glBegin}(@code{GL_LINES})/@code{glEnd} sequence is generated. It
+is incremented after each fragment of a unit width aliased line segment
+is generated or after each @math{@var{i}} fragments of an @math{@var{i}}
+width line segment are generated. The @math{@var{i}} fragments
+associated with count @math{@var{s}} are masked out if
+
+@var{pattern} bit @math{(@var{s}/@var{factor},)%16}
+
+is 0, otherwise these fragments are sent to the frame buffer. Bit zero
+of @var{pattern} is the least significant bit.
+
+Antialiased lines are treated as a sequence of @math{1×@var{width}}
+rectangles for purposes of stippling. Whether rectangle @math{@var{s}}
+is rasterized or not depends on the fragment rule described for aliased
+lines, counting rectangles rather than groups of fragments.
+
+To enable and disable line stippling, call @code{glEnable} and
+@code{glDisable} with argument @code{GL_LINE_STIPPLE}. When enabled, the
+line stipple pattern is applied as described above. When disabled, it is
+as if the pattern were all 1's. Initially, line stippling is disabled.
+
+@heading Errors
+@code{GL_INVALID_OPERATION} is generated if @code{glLineStipple} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glLineWidth
+@heading specify the width of rasterized lines
+@heading Parameters
+@table @asis
+@item @var{width}
+Specifies the width of rasterized lines. The initial value is 1.
+
+@end table
+
+@heading Description
+@code{glLineWidth} specifies the rasterized width of both aliased and
+antialiased lines. Using a line width other than 1 has different
+effects, depending on whether line antialiasing is enabled. To enable
+and disable line antialiasing, call @code{glEnable} and @code{glDisable}
+with argument @code{GL_LINE_SMOOTH}. Line antialiasing is initially
+disabled.
+
+If line antialiasing is disabled, the actual width is determined by
+rounding the supplied width to the nearest integer. (If the rounding
+results in the value 0, it is as if the line width were 1.) If
+@math{∣Δ@var{x},∣>=∣Δ@var{y},∣}, @var{i} pixels are filled in each
+column that is rasterized, where @var{i} is the rounded value of
+@var{width}. Otherwise, @var{i} pixels are filled in each row that is
+rasterized.
+
+If antialiasing is enabled, line rasterization produces a fragment for
+each pixel square that intersects the region lying within the rectangle
+having width equal to the current line width, length equal to the actual
+length of the line, and centered on the mathematical line segment. The
+coverage value for each fragment is the window coordinate area of the
+intersection of the rectangular region with the corresponding pixel
+square. This value is saved and used in the final rasterization step.
+
+Not all widths can be supported when line antialiasing is enabled. If an
+unsupported width is requested, the nearest supported width is used.
+Only width 1 is guaranteed to be supported; others depend on the
+implementation. Likewise, there is a range for aliased line widths as
+well. To query the range of supported widths and the size difference
+between supported widths within the range, call @code{glGet} with
+arguments @code{GL_ALIASED_LINE_WIDTH_RANGE},
+@code{GL_SMOOTH_LINE_WIDTH_RANGE}, and
+@code{GL_SMOOTH_LINE_WIDTH_GRANULARITY}.
+
+@heading Errors
+@code{GL_INVALID_VALUE} is generated if @var{width} is less than or
+equal to 0.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glLineWidth} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glLinkProgram
+@heading Links a program object
+@heading Parameters
+@table @asis
+@item @var{program}
+Specifies the handle of the program object to be linked.
+
+@end table
+
+@heading Description
+@code{glLinkProgram} links the program object specified by
+@var{program}. If any shader objects of type @code{GL_VERTEX_SHADER} are
+attached to @var{program}, they will be used to create an executable
+that will run on the programmable vertex processor. If any shader
+objects of type @code{GL_FRAGMENT_SHADER} are attached to @var{program},
+they will be used to create an executable that will run on the
+programmable fragment processor.
+
+The status of the link operation will be stored as part of the program
+object's state. This value will be set to @code{GL_TRUE} if the program
+object was linked without errors and is ready for use, and
+@code{GL_FALSE} otherwise. It can be queried by calling
+@code{glGetProgram} with arguments @var{program} and
+@code{GL_LINK_STATUS}.
+
+As a result of a successful link operation, all active user-defined
+uniform variables belonging to @var{program} will be initialized to 0,
+and each of the program object's active uniform variables will be
+assigned a location that can be queried by calling
+@code{glGetUniformLocation}. Also, any active user-defined attribute
+variables that have not been bound to a generic vertex attribute index
+will be bound to one at this time.
+
+Linking of a program object can fail for a number of reasons as
+specified in the @var{OpenGL Shading Language Specification}. The
+following lists some of the conditions that will cause a link error.
+
+@itemize
+@item
+The number of active attribute variables supported by the implementation
+has been exceeded.
+
+@item
+The storage limit for uniform variables has been exceeded.
+
+@item
+The number of active uniform variables supported by the implementation
+has been exceeded.
+
+@item
+The @code{main} function is missing for the vertex shader or the
+fragment shader.
+
+@item
+A varying variable actually used in the fragment shader is not declared
+in the same way (or is not declared at all) in the vertex shader.
+
+@item
+A reference to a function or variable name is unresolved.
+
+@item
+A shared global is declared with two different types or two different
+initial values.
+
+@item
+One or more of the attached shader objects has not been successfully
+compiled.
+
+@item
+Binding a generic attribute matrix caused some rows of the matrix to
+fall outside the allowed maximum of @code{GL_MAX_VERTEX_ATTRIBS}.
+
+@item
+Not enough contiguous vertex attribute slots could be found to bind
+attribute matrices.
+
+@end itemize
+
+When a program object has been successfully linked, the program object
+can be made part of current state by calling @code{glUseProgram}.
+Whether or not the link operation was successful, the program object's
+information log will be overwritten. The information log can be
+retrieved by calling @code{glGetProgramInfoLog}.
+
+@code{glLinkProgram} will also install the generated executables as part
+of the current rendering state if the link operation was successful and
+the specified program object is already currently in use as a result of
+a previous call to @code{glUseProgram}. If the program object currently
+in use is relinked unsuccessfully, its link status will be set to
+@code{GL_FALSE} , but the executables and associated state will remain
+part of the current state until a subsequent call to @code{glUseProgram}
+removes it from use. After it is removed from use, it cannot be made
+part of current state until it has been successfully relinked.
+
+If @var{program} contains shader objects of type @code{GL_VERTEX_SHADER}
+but does not contain shader objects of type @code{GL_FRAGMENT_SHADER},
+the vertex shader will be linked against the implicit interface for
+fixed functionality fragment processing. Similarly, if @var{program}
+contains shader objects of type @code{GL_FRAGMENT_SHADER} but it does
+not contain shader objects of type @code{GL_VERTEX_SHADER}, the fragment
+shader will be linked against the implicit interface for fixed
+functionality vertex processing.
+
+The program object's information log is updated and the program is
+generated at the time of the link operation. After the link operation,
+applications are free to modify attached shader objects, compile
+attached shader objects, detach shader objects, delete shader objects,
+and attach additional shader objects. None of these operations affects
+the information log or the program that is part of the program object.
+
+@heading Errors
+@code{GL_INVALID_VALUE} is generated if @var{program} is not a value
+generated by OpenGL.
+
+@code{GL_INVALID_OPERATION} is generated if @var{program} is not a
+program object.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glLinkProgram} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glListBase
+@heading set the display-list base for
+@heading Parameters
+@table @asis
+@item @var{base}
+Specifies an integer offset that will be added to @code{glCallLists}
+offsets to generate display-list names. The initial value is 0.
+
+@end table
+
+@heading Description
+@code{glCallLists} specifies an array of offsets. Display-list names are
+generated by adding @var{base} to each offset. Names that reference
+valid display lists are executed; the others are ignored.
+
+@heading Errors
+@code{GL_INVALID_OPERATION} is generated if @code{glListBase} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glLoadIdentity
+@heading replace the current matrix with the identity matrix
+@heading Description
+@code{glLoadIdentity} replaces the current matrix with the identity
+matrix. It is semantically equivalent to calling @code{glLoadMatrix}
+with the identity matrix
+
+
+
+@math{((1 0 0 0), (0 1 0 0), (0 0 1 0), (0 0 0 1),,)}
+
+
+
+but in some cases it is more efficient.
+
+@heading Errors
+@code{GL_INVALID_OPERATION} is generated if @code{glLoadIdentity} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glLoadMatrix
+@heading replace the current matrix with the specified matrix
+@heading Parameters
+@table @asis
+@item @var{m}
+Specifies a pointer to 16 consecutive values, which are used as the
+elements of a @math{4×4} column-major matrix.
+
+@end table
+
+@heading Description
+@code{glLoadMatrix} replaces the current matrix with the one whose
+elements are specified by @var{m}. The current matrix is the projection
+matrix, modelview matrix, or texture matrix, depending on the current
+matrix mode (see @code{glMatrixMode}).
+
+The current matrix, M, defines a transformation of coordinates. For
+instance, assume M refers to the modelview matrix. If
+@math{@var{v}=(@var{v}[0,],@var{v}[1,]@var{v}[2,]@var{v}[3,])} is
+the set of object coordinates of a vertex, and @var{m} points to an
+array of @math{16} single- or double-precision floating-point values
+@math{@var{m}=@{@var{m}[0,],@var{m}[1,]@var{...}@var{m}[15,]@}}, then
+the modelview transformation @math{@var{M}(@var{v},)} does the
+following:
+
+@math{@var{M}(@var{v},)=((@var{m}[0,] @var{m}[4,] @var{m}[8,]
+@var{m}[12,]), (@var{m}[1,] @var{m}[5,] @var{m}[9,] @var{m}[13,]),
+(@var{m}[2,] @var{m}[6,] @var{m}[10,] @var{m}[14,]), (@var{m}[3,]
+@var{m}[7,] @var{m}[11,] @var{m}[15,]),)×((@var{v}[0,]),
+(@var{v}[1,]), (@var{v}[2,]), (@var{v}[3,]),)}
+
+
+
+Projection and texture transformations are similarly defined.
+
+@heading Errors
+@code{GL_INVALID_OPERATION} is generated if @code{glLoadMatrix} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glLoadName
+@heading load a name onto the name stack
+@heading Parameters
+@table @asis
+@item @var{name}
+Specifies a name that will replace the top value on the name stack.
+
+@end table
+
+@heading Description
+The name stack is used during selection mode to allow sets of rendering
+commands to be uniquely identified. It consists of an ordered set of
+unsigned integers and is initially empty.
+
+@code{glLoadName} causes @var{name} to replace the value on the top of
+the name stack.
+
+The name stack is always empty while the render mode is not
+@code{GL_SELECT}. Calls to @code{glLoadName} while the render mode is
+not @code{GL_SELECT} are ignored.
+
+@heading Errors
+@code{GL_INVALID_OPERATION} is generated if @code{glLoadName} is called
+while the name stack is empty.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glLoadName} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glLoadTransposeMatrix
+@heading replace the current matrix with the specified row-major ordered matrix
+@heading Parameters
+@table @asis
+@item @var{m}
+Specifies a pointer to 16 consecutive values, which are used as the
+elements of a @math{4×4} row-major matrix.
+
+@end table
+
+@heading Description
+@code{glLoadTransposeMatrix} replaces the current matrix with the one
+whose elements are specified by @var{m}. The current matrix is the
+projection matrix, modelview matrix, or texture matrix, depending on the
+current matrix mode (see @code{glMatrixMode}).
+
+The current matrix, M, defines a transformation of coordinates. For
+instance, assume M refers to the modelview matrix. If
+@math{@var{v}=(@var{v}[0,],@var{v}[1,]@var{v}[2,]@var{v}[3,])} is
+the set of object coordinates of a vertex, and @var{m} points to an
+array of @math{16} single- or double-precision floating-point values
+@math{@var{m}=@{@var{m}[0,],@var{m}[1,]@var{...}@var{m}[15,]@}}, then
+the modelview transformation @math{@var{M}(@var{v},)} does the
+following:
+
+@math{@var{M}(@var{v},)=((@var{m}[0,] @var{m}[1,] @var{m}[2,]
+@var{m}[3,]), (@var{m}[4,] @var{m}[5,] @var{m}[6,] @var{m}[7,]),
+(@var{m}[8,] @var{m}[9,] @var{m}[10,] @var{m}[11,]), (@var{m}[12,]
+@var{m}[13,] @var{m}[14,] @var{m}[15,]),)×((@var{v}[0,]),
+(@var{v}[1,]), (@var{v}[2,]), (@var{v}[3,]),)}
+
+
+
+Projection and texture transformations are similarly defined.
+
+Calling @code{glLoadTransposeMatrix} with matrix @math{@var{M}} is
+identical in operation to @code{glLoadMatrix} with
+@math{@var{M}^@var{T}}, where @math{@var{T}} represents the transpose.
+
+@heading Errors
+@code{GL_INVALID_OPERATION} is generated if @code{glLoadTransposeMatrix}
+is executed between the execution of @code{glBegin} and the
+corresponding execution of @code{glEnd}.
+
+@end defun
+
+@defun glLogicOp
+@heading specify a logical pixel operation for color index rendering
+@heading Parameters
+@table @asis
+@item @var{opcode}
+Specifies a symbolic constant that selects a logical operation. The
+following symbols are accepted: @code{GL_CLEAR}, @code{GL_SET},
+@code{GL_COPY}, @code{GL_COPY_INVERTED}, @code{GL_NOOP},
+@code{GL_INVERT}, @code{GL_AND}, @code{GL_NAND}, @code{GL_OR},
+@code{GL_NOR}, @code{GL_XOR}, @code{GL_EQUIV}, @code{GL_AND_REVERSE},
+@code{GL_AND_INVERTED}, @code{GL_OR_REVERSE}, and @code{GL_OR_INVERTED}.
+The initial value is @code{GL_COPY}.
+
+@end table
+
+@heading Description
+@code{glLogicOp} specifies a logical operation that, when enabled, is
+applied between the incoming color index or RGBA color and the color
+index or RGBA color at the corresponding location in the frame buffer.
+To enable or disable the logical operation, call @code{glEnable} and
+@code{glDisable} using the symbolic constant @code{GL_COLOR_LOGIC_OP}
+for RGBA mode or @code{GL_INDEX_LOGIC_OP} for color index mode. The
+initial value is disabled for both operations.
+
+
+
+@table @asis
+@item @strong{Opcode}
+@strong{Resulting Operation}
+
+@item @code{GL_CLEAR}
+0
+
+@item @code{GL_SET}
+1
+
+@item @code{GL_COPY}
+s
+
+@item @code{GL_COPY_INVERTED}
+~s
+
+@item @code{GL_NOOP}
+d
+
+@item @code{GL_INVERT}
+~d
+
+@item @code{GL_AND}
+s & d
+
+@item @code{GL_NAND}
+~(s & d)
+
+@item @code{GL_OR}
+s | d
+
+@item @code{GL_NOR}
+~(s | d)
+
+@item @code{GL_XOR}
+s ^ d
+
+@item @code{GL_EQUIV}
+~(s ^ d)
+
+@item @code{GL_AND_REVERSE}
+s & ~d
+
+@item @code{GL_AND_INVERTED}
+~s & d
+
+@item @code{GL_OR_REVERSE}
+s | ~d
+
+@item @code{GL_OR_INVERTED}
+~s | d
+
+@end table
+
+@var{opcode} is a symbolic constant chosen from the list above. In the
+explanation of the logical operations, @var{s} represents the incoming
+color index and @var{d} represents the index in the frame buffer.
+Standard C-language operators are used. As these bitwise operators
+suggest, the logical operation is applied independently to each bit pair
+of the source and destination indices or colors.
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{opcode} is not an accepted
+value.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glLogicOp} is executed
+between the execution of @code{glBegin} and the corresponding execution
+of @code{glEnd}.
+
+@end defun
+
+@defun glMap1
+@heading define a one-dimensional evaluator
+@heading Parameters
+@table @asis
+@item @var{target}
+Specifies the kind of values that are generated by the evaluator.
+Symbolic constants @code{GL_MAP1_VERTEX_3}, @code{GL_MAP1_VERTEX_4},
+@code{GL_MAP1_INDEX}, @code{GL_MAP1_COLOR_4}, @code{GL_MAP1_NORMAL},
+@code{GL_MAP1_TEXTURE_COORD_1}, @code{GL_MAP1_TEXTURE_COORD_2},
+@code{GL_MAP1_TEXTURE_COORD_3}, and @code{GL_MAP1_TEXTURE_COORD_4} are
+accepted.
+
+@item @var{u1}
+@itemx @var{u2}
+Specify a linear mapping of @math{@var{u}}, as presented to
+@code{glEvalCoord1}, to @math{@var{u}^}, the variable that is evaluated
+by the equations specified by this command.
+
+@item @var{stride}
+Specifies the number of floats or doubles between the beginning of one
+control point and the beginning of the next one in the data structure
+referenced in @var{points}. This allows control points to be embedded in
+arbitrary data structures. The only constraint is that the values for a
+particular control point must occupy contiguous memory locations.
+
+@item @var{order}
+Specifies the number of control points. Must be positive.
+
+@item @var{points}
+Specifies a pointer to the array of control points.
+
+@end table
+
+@heading Description
+Evaluators provide a way to use polynomial or rational polynomial
+mapping to produce vertices, normals, texture coordinates, and colors.
+The values produced by an evaluator are sent to further stages of GL
+processing just as if they had been presented using @code{glVertex},
+@code{glNormal}, @code{glTexCoord}, and @code{glColor} commands, except
+that the generated values do not update the current normal, texture
+coordinates, or color.
+
+All polynomial or rational polynomial splines of any degree (up to the
+maximum degree supported by the GL implementation) can be described
+using evaluators. These include almost all splines used in computer
+graphics: B-splines, Bezier curves, Hermite splines, and so on.
+
+Evaluators define curves based on Bernstein polynomials. Define
+@math{@var{p}(@var{u}^,)} as
+
+@math{@var{p}(@var{u}^,)=Σ@var{i}=0@var{n}@var{B}_@var{i},^@var{n}(@var{u}^,)@var{R}_@var{i}}
+
+
+
+where @math{@var{R}_@var{i}} is a control point and
+@math{@var{B}_@var{i},^@var{n}(@var{u}^,)} is the @math{@var{i}}th
+Bernstein polynomial of degree @math{@var{n}} (@var{order} =
+@math{@var{n}+1}):
+
+@math{@var{B}_@var{i},^@var{n}(@var{u}^,)=((@var{n}),
+(@var{i}),,)@var{u}^,^@var{i}(1-@var{u}^,)^@var{n}-@var{i},,}
+
+Recall that
+
+@math{0^0==1} and @math{((@var{n}), (0),,)==1}
+
+@code{glMap1} is used to define the basis and to specify what kind of
+values are produced. Once defined, a map can be enabled and disabled by
+calling @code{glEnable} and @code{glDisable} with the map name, one of
+the nine predefined values for @var{target} described below.
+@code{glEvalCoord1} evaluates the one-dimensional maps that are enabled.
+When @code{glEvalCoord1} presents a value @math{@var{u}}, the Bernstein
+functions are evaluated using @math{@var{u}^}, where
+@math{@var{u}^=@var{u}-@var{u1},/@var{u2}-@var{u1},}
+
+@var{target} is a symbolic constant that indicates what kind of control
+points are provided in @var{points}, and what output is generated when
+the map is evaluated. It can assume one of nine predefined values:
+
+@table @asis
+@item @code{GL_MAP1_VERTEX_3}
+Each control point is three floating-point values representing
+@math{@var{x}}, @math{@var{y}}, and @math{@var{z}}. Internal
+@code{glVertex3} commands are generated when the map is evaluated.
+
+@item @code{GL_MAP1_VERTEX_4}
+Each control point is four floating-point values representing
+@math{@var{x}}, @math{@var{y}}, @math{@var{z}}, and @math{@var{w}}.
+Internal @code{glVertex4} commands are generated when the map is
+evaluated.
+
+@item @code{GL_MAP1_INDEX}
+Each control point is a single floating-point value representing a color
+index. Internal @code{glIndex} commands are generated when the map is
+evaluated but the current index is not updated with the value of these
+@code{glIndex} commands.
+
+@item @code{GL_MAP1_COLOR_4}
+Each control point is four floating-point values representing red,
+green, blue, and alpha. Internal @code{glColor4} commands are generated
+when the map is evaluated but the current color is not updated with the
+value of these @code{glColor4} commands.
+
+@item @code{GL_MAP1_NORMAL}
+Each control point is three floating-point values representing the
+@math{@var{x}}, @math{@var{y}}, and @math{@var{z}} components of a
+normal vector. Internal @code{glNormal} commands are generated when the
+map is evaluated but the current normal is not updated with the value of
+these @code{glNormal} commands.
+
+@item @code{GL_MAP1_TEXTURE_COORD_1}
+Each control point is a single floating-point value representing the
+@math{@var{s}} texture coordinate. Internal @code{glTexCoord1} commands
+are generated when the map is evaluated but the current texture
+coordinates are not updated with the value of these @code{glTexCoord}
+commands.
+
+@item @code{GL_MAP1_TEXTURE_COORD_2}
+Each control point is two floating-point values representing the
+@math{@var{s}} and @math{@var{t}} texture coordinates. Internal
+@code{glTexCoord2} commands are generated when the map is evaluated but
+the current texture coordinates are not updated with the value of these
+@code{glTexCoord} commands.
+
+@item @code{GL_MAP1_TEXTURE_COORD_3}
+Each control point is three floating-point values representing the
+@math{@var{s}}, @math{@var{t}}, and @math{@var{r}} texture coordinates.
+Internal @code{glTexCoord3} commands are generated when the map is
+evaluated but the current texture coordinates are not updated with the
+value of these @code{glTexCoord} commands.
+
+@item @code{GL_MAP1_TEXTURE_COORD_4}
+Each control point is four floating-point values representing the
+@math{@var{s}}, @math{@var{t}}, @math{@var{r}}, and @math{@var{q}}
+texture coordinates. Internal @code{glTexCoord4} commands are generated
+when the map is evaluated but the current texture coordinates are not
+updated with the value of these @code{glTexCoord} commands.
+
+@end table
+
+@var{stride}, @var{order}, and @var{points} define the array addressing
+for accessing the control points. @var{points} is the location of the
+first control point, which occupies one, two, three, or four contiguous
+memory locations, depending on which map is being defined. @var{order}
+is the number of control points in the array. @var{stride} specifies how
+many float or double locations to advance the internal memory pointer to
+reach the next control point.
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{target} is not an accepted
+value.
+
+@code{GL_INVALID_VALUE} is generated if @var{u1} is equal to @var{u2}.
+
+@code{GL_INVALID_VALUE} is generated if @var{stride} is less than the
+number of values in a control point.
+
+@code{GL_INVALID_VALUE} is generated if @var{order} is less than 1 or
+greater than the return value of @code{GL_MAX_EVAL_ORDER}.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glMap1} is executed
+between the execution of @code{glBegin} and the corresponding execution
+of @code{glEnd}.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glMap1} is called and
+the value of @code{GL_ACTIVE_TEXTURE} is not @code{GL_TEXTURE0}.
+
+@end defun
+
+@defun glMap2
+@heading define a two-dimensional evaluator
+@heading Parameters
+@table @asis
+@item @var{target}
+Specifies the kind of values that are generated by the evaluator.
+Symbolic constants @code{GL_MAP2_VERTEX_3}, @code{GL_MAP2_VERTEX_4},
+@code{GL_MAP2_INDEX}, @code{GL_MAP2_COLOR_4}, @code{GL_MAP2_NORMAL},
+@code{GL_MAP2_TEXTURE_COORD_1}, @code{GL_MAP2_TEXTURE_COORD_2},
+@code{GL_MAP2_TEXTURE_COORD_3}, and @code{GL_MAP2_TEXTURE_COORD_4} are
+accepted.
+
+@item @var{u1}
+@itemx @var{u2}
+Specify a linear mapping of @math{@var{u}}, as presented to
+@code{glEvalCoord2}, to @math{@var{u}^}, one of the two variables that
+are evaluated by the equations specified by this command. Initially,
+@var{u1} is 0 and @var{u2} is 1.
+
+@item @var{ustride}
+Specifies the number of floats or doubles between the beginning of
+control point @math{@var{R}_@var{ij}} and the beginning of control point
+@math{@var{R}_(@var{i}+1,)@var{j},}, where @math{@var{i}} and
+@math{@var{j}} are the @math{@var{u}} and @math{@var{v}} control point
+indices, respectively. This allows control points to be embedded in
+arbitrary data structures. The only constraint is that the values for a
+particular control point must occupy contiguous memory locations. The
+initial value of @var{ustride} is 0.
+
+@item @var{uorder}
+Specifies the dimension of the control point array in the @math{@var{u}}
+axis. Must be positive. The initial value is 1.
+
+@item @var{v1}
+@itemx @var{v2}
+Specify a linear mapping of @math{@var{v}}, as presented to
+@code{glEvalCoord2}, to @math{@var{v}^}, one of the two variables that
+are evaluated by the equations specified by this command. Initially,
+@var{v1} is 0 and @var{v2} is 1.
+
+@item @var{vstride}
+Specifies the number of floats or doubles between the beginning of
+control point @math{@var{R}_@var{ij}} and the beginning of control point
+@math{@var{R}_@var{i}(@var{j}+1,),}, where @math{@var{i}} and
+@math{@var{j}} are the @math{@var{u}} and @math{@var{v}} control point
+indices, respectively. This allows control points to be embedded in
+arbitrary data structures. The only constraint is that the values for a
+particular control point must occupy contiguous memory locations. The
+initial value of @var{vstride} is 0.
+
+@item @var{vorder}
+Specifies the dimension of the control point array in the @math{@var{v}}
+axis. Must be positive. The initial value is 1.
+
+@item @var{points}
+Specifies a pointer to the array of control points.
+
+@end table
+
+@heading Description
+Evaluators provide a way to use polynomial or rational polynomial
+mapping to produce vertices, normals, texture coordinates, and colors.
+The values produced by an evaluator are sent on to further stages of GL
+processing just as if they had been presented using @code{glVertex},
+@code{glNormal}, @code{glTexCoord}, and @code{glColor} commands, except
+that the generated values do not update the current normal, texture
+coordinates, or color.
+
+All polynomial or rational polynomial splines of any degree (up to the
+maximum degree supported by the GL implementation) can be described
+using evaluators. These include almost all surfaces used in computer
+graphics, including B-spline surfaces, NURBS surfaces, Bezier surfaces,
+and so on.
+
+Evaluators define surfaces based on bivariate Bernstein polynomials.
+Define @math{@var{p}(@var{u}^,@var{v}^)} as
+
+@math{@var{p}(@var{u}^,@var{v}^)=Σ@var{i}=0@var{n}Σ@var{j}=0@var{m}@var{B}_@var{i},^@var{n}(@var{u}^,)@var{B}_@var{j},^@var{m}(@var{v}^,)@var{R}_@var{ij}}
+
+
+
+where @math{@var{R}_@var{ij}} is a control point,
+@math{@var{B}_@var{i},^@var{n}(@var{u}^,)} is the @math{@var{i}}th
+Bernstein polynomial of degree @math{@var{n}} (@var{uorder} =
+@math{@var{n}+1})
+
+@math{@var{B}_@var{i},^@var{n}(@var{u}^,)=((@var{n}),
+(@var{i}),,)@var{u}^,^@var{i}(1-@var{u}^,)^@var{n}-@var{i},,}
+
+and @math{@var{B}_@var{j},^@var{m}(@var{v}^,)} is the @math{@var{j}}th
+Bernstein polynomial of degree @math{@var{m}} (@var{vorder} =
+@math{@var{m}+1})
+
+@math{@var{B}_@var{j},^@var{m}(@var{v}^,)=((@var{m}),
+(@var{j}),,)@var{v}^,^@var{j}(1-@var{v}^,)^@var{m}-@var{j},,}
+
+Recall that @math{0^0==1} and @math{((@var{n}), (0),,)==1}
+
+@code{glMap2} is used to define the basis and to specify what kind of
+values are produced. Once defined, a map can be enabled and disabled by
+calling @code{glEnable} and @code{glDisable} with the map name, one of
+the nine predefined values for @var{target}, described below. When
+@code{glEvalCoord2} presents values @math{@var{u}} and @math{@var{v}},
+the bivariate Bernstein polynomials are evaluated using @math{@var{u}^}
+and @math{@var{v}^}, where
+
+@math{@var{u}^=@var{u}-@var{u1},/@var{u2}-@var{u1},}
+
+@math{@var{v}^=@var{v}-@var{v1},/@var{v2}-@var{v1},}
+
+@var{target} is a symbolic constant that indicates what kind of control
+points are provided in @var{points}, and what output is generated when
+the map is evaluated. It can assume one of nine predefined values:
+
+@table @asis
+@item @code{GL_MAP2_VERTEX_3}
+Each control point is three floating-point values representing
+@math{@var{x}}, @math{@var{y}}, and @math{@var{z}}. Internal
+@code{glVertex3} commands are generated when the map is evaluated.
+
+@item @code{GL_MAP2_VERTEX_4}
+Each control point is four floating-point values representing
+@math{@var{x}}, @math{@var{y}}, @math{@var{z}}, and @math{@var{w}}.
+Internal @code{glVertex4} commands are generated when the map is
+evaluated.
+
+@item @code{GL_MAP2_INDEX}
+Each control point is a single floating-point value representing a color
+index. Internal @code{glIndex} commands are generated when the map is
+evaluated but the current index is not updated with the value of these
+@code{glIndex} commands.
+
+@item @code{GL_MAP2_COLOR_4}
+Each control point is four floating-point values representing red,
+green, blue, and alpha. Internal @code{glColor4} commands are generated
+when the map is evaluated but the current color is not updated with the
+value of these @code{glColor4} commands.
+
+@item @code{GL_MAP2_NORMAL}
+Each control point is three floating-point values representing the
+@math{@var{x}}, @math{@var{y}}, and @math{@var{z}} components of a
+normal vector. Internal @code{glNormal} commands are generated when the
+map is evaluated but the current normal is not updated with the value of
+these @code{glNormal} commands.
+
+@item @code{GL_MAP2_TEXTURE_COORD_1}
+Each control point is a single floating-point value representing the
+@math{@var{s}} texture coordinate. Internal @code{glTexCoord1} commands
+are generated when the map is evaluated but the current texture
+coordinates are not updated with the value of these @code{glTexCoord}
+commands.
+
+@item @code{GL_MAP2_TEXTURE_COORD_2}
+Each control point is two floating-point values representing the
+@math{@var{s}} and @math{@var{t}} texture coordinates. Internal
+@code{glTexCoord2} commands are generated when the map is evaluated but
+the current texture coordinates are not updated with the value of these
+@code{glTexCoord} commands.
+
+@item @code{GL_MAP2_TEXTURE_COORD_3}
+Each control point is three floating-point values representing the
+@math{@var{s}}, @math{@var{t}}, and @math{@var{r}} texture coordinates.
+Internal @code{glTexCoord3} commands are generated when the map is
+evaluated but the current texture coordinates are not updated with the
+value of these @code{glTexCoord} commands.
+
+@item @code{GL_MAP2_TEXTURE_COORD_4}
+Each control point is four floating-point values representing the
+@math{@var{s}}, @math{@var{t}}, @math{@var{r}}, and @math{@var{q}}
+texture coordinates. Internal @code{glTexCoord4} commands are generated
+when the map is evaluated but the current texture coordinates are not
+updated with the value of these @code{glTexCoord} commands.
+
+@end table
+
+@var{ustride}, @var{uorder}, @var{vstride}, @var{vorder}, and
+@var{points} define the array addressing for accessing the control
+points. @var{points} is the location of the first control point, which
+occupies one, two, three, or four contiguous memory locations, depending
+on which map is being defined. There are
+@math{@var{uorder}×@var{vorder}} control points in the array.
+@var{ustride} specifies how many float or double locations are skipped
+to advance the internal memory pointer from control point
+@math{@var{R}_@var{i}@var{j},} to control point
+@math{@var{R}_(@var{i}+1,)@var{j},}. @var{vstride} specifies how many
+float or double locations are skipped to advance the internal memory
+pointer from control point @math{@var{R}_@var{i}@var{j},} to control
+point @math{@var{R}_@var{i}(@var{j}+1,),}.
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{target} is not an accepted
+value.
+
+@code{GL_INVALID_VALUE} is generated if @var{u1} is equal to @var{u2},
+or if @var{v1} is equal to @var{v2}.
+
+@code{GL_INVALID_VALUE} is generated if either @var{ustride} or
+@var{vstride} is less than the number of values in a control point.
+
+@code{GL_INVALID_VALUE} is generated if either @var{uorder} or
+@var{vorder} is less than 1 or greater than the return value of
+@code{GL_MAX_EVAL_ORDER}.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glMap2} is executed
+between the execution of @code{glBegin} and the corresponding execution
+of @code{glEnd}.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glMap2} is called and
+the value of @code{GL_ACTIVE_TEXTURE} is not @code{GL_TEXTURE0}.
+
+@end defun
+
+@defun glMapBuffer
+@heading map a buffer object's data store
+@heading Parameters
+@table @asis
+@item @var{target}
+Specifies the target buffer object being mapped. The symbolic constant
+must be @code{GL_ARRAY_BUFFER}, @code{GL_ELEMENT_ARRAY_BUFFER},
+@code{GL_PIXEL_PACK_BUFFER}, or @code{GL_PIXEL_UNPACK_BUFFER}.
+
+@item @var{access}
+Specifies the access policy, indicating whether it will be possible to
+read from, write to, or both read from and write to the buffer object's
+mapped data store. The symbolic constant must be @code{GL_READ_ONLY},
+@code{GL_WRITE_ONLY}, or @code{GL_READ_WRITE}.
+
+@end table
+
+@heading Description
+@code{glMapBuffer} maps to the client's address space the entire data
+store of the buffer object currently bound to @var{target}. The data can
+then be directly read and/or written relative to the returned pointer,
+depending on the specified @var{access} policy. If the GL is unable to
+map the buffer object's data store, @code{glMapBuffer} generates an
+error and returns @code{NULL}. This may occur for system-specific
+reasons, such as low virtual memory availability.
+
+If a mapped data store is accessed in a way inconsistent with the
+specified @var{access} policy, no error is generated, but performance
+may be negatively impacted and system errors, including program
+termination, may result. Unlike the @var{usage} parameter of
+@code{glBufferData}, @var{access} is not a hint, and does in fact
+constrain the usage of the mapped data store on some GL implementations.
+In order to achieve the highest performance available, a buffer object's
+data store should be used in ways consistent with both its specified
+@var{usage} and @var{access} parameters.
+
+A mapped data store must be unmapped with @code{glUnmapBuffer} before
+its buffer object is used. Otherwise an error will be generated by any
+GL command that attempts to dereference the buffer object's data store.
+When a data store is unmapped, the pointer to its data store becomes
+invalid. @code{glUnmapBuffer} returns @code{GL_TRUE} unless the data
+store contents have become corrupt during the time the data store was
+mapped. This can occur for system-specific reasons that affect the
+availability of graphics memory, such as screen mode changes. In such
+situations, @code{GL_FALSE} is returned and the data store contents are
+undefined. An application must detect this rare condition and
+reinitialize the data store.
+
+A buffer object's mapped data store is automatically unmapped when the
+buffer object is deleted or its data store is recreated with
+@code{glBufferData}.
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{target} is not
+@code{GL_ARRAY_BUFFER}, @code{GL_ELEMENT_ARRAY_BUFFER},
+@code{GL_PIXEL_PACK_BUFFER}, or @code{GL_PIXEL_UNPACK_BUFFER}.
+
+@code{GL_INVALID_ENUM} is generated if @var{access} is not
+@code{GL_READ_ONLY}, @code{GL_WRITE_ONLY}, or @code{GL_READ_WRITE}.
+
+@code{GL_OUT_OF_MEMORY} is generated when @code{glMapBuffer} is executed
+if the GL is unable to map the buffer object's data store. This may
+occur for a variety of system-specific reasons, such as the absence of
+sufficient remaining virtual memory.
+
+@code{GL_INVALID_OPERATION} is generated if the reserved buffer object
+name 0 is bound to @var{target}.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glMapBuffer} is
+executed for a buffer object whose data store is already mapped.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glUnmapBuffer} is
+executed for a buffer object whose data store is not currently mapped.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glMapBuffer} or
+@code{glUnmapBuffer} is executed between the execution of @code{glBegin}
+and the corresponding execution of @code{glEnd}.
+
+@end defun
+
+@defun glMapGrid
+@heading define a one- or two-dimensional mesh
+@heading Parameters
+@table @asis
+@item @var{un}
+Specifies the number of partitions in the grid range interval [@var{u1},
+@var{u2}]. Must be positive.
+
+@item @var{u1}
+@itemx @var{u2}
+Specify the mappings for integer grid domain values @math{@var{i}=0} and
+@math{@var{i}=@var{un}}.
+
+@item @var{vn}
+Specifies the number of partitions in the grid range interval [@var{v1},
+@var{v2}] (@code{glMapGrid2} only).
+
+@item @var{v1}
+@itemx @var{v2}
+Specify the mappings for integer grid domain values @math{@var{j}=0} and
+@math{@var{j}=@var{vn}} (@code{glMapGrid2} only).
+
+@end table
+
+@heading Description
+@code{glMapGrid} and @code{glEvalMesh} are used together to efficiently
+generate and evaluate a series of evenly-spaced map domain values.
+@code{glEvalMesh} steps through the integer domain of a one- or
+two-dimensional grid, whose range is the domain of the evaluation maps
+specified by @code{glMap1} and @code{glMap2}.
+
+@code{glMapGrid1} and @code{glMapGrid2} specify the linear grid mappings
+between the @math{@var{i}} (or @math{@var{i}} and @math{@var{j}})
+integer grid coordinates, to the @math{@var{u}} (or @math{@var{u}} and
+@math{@var{v}}) floating-point evaluation map coordinates. See
+@code{glMap1} and @code{glMap2} for details of how @math{@var{u}} and
+@math{@var{v}} coordinates are evaluated.
+
+@code{glMapGrid1} specifies a single linear mapping such that integer
+grid coordinate 0 maps exactly to @var{u1}, and integer grid coordinate
+@var{un} maps exactly to @var{u2}. All other integer grid coordinates
+@math{@var{i}} are mapped so that
+
+@math{@var{u}=@var{i}(@var{u2}-@var{u1},)/@var{un}+@var{u1}}
+
+@code{glMapGrid2} specifies two such linear mappings. One maps integer
+grid coordinate @math{@var{i}=0} exactly to @var{u1}, and integer grid
+coordinate @math{@var{i}=@var{un}} exactly to @var{u2}. The other maps
+integer grid coordinate @math{@var{j}=0} exactly to @var{v1}, and
+integer grid coordinate @math{@var{j}=@var{vn}} exactly to @var{v2}.
+Other integer grid coordinates @math{@var{i}} and @math{@var{j}} are
+mapped such that
+
+@math{@var{u}=@var{i}(@var{u2}-@var{u1},)/@var{un}+@var{u1}}
+
+@math{@var{v}=@var{j}(@var{v2}-@var{v1},)/@var{vn}+@var{v1}}
+
+The mappings specified by @code{glMapGrid} are used identically by
+@code{glEvalMesh} and @code{glEvalPoint}.
+
+@heading Errors
+@code{GL_INVALID_VALUE} is generated if either @var{un} or @var{vn} is
+not positive.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glMapGrid} is executed
+between the execution of @code{glBegin} and the corresponding execution
+of @code{glEnd}.
+
+@end defun
+
+@defun glMaterial
+@heading specify material parameters for the lighting model
+@heading Parameters
+@table @asis
+@item @var{face}
+Specifies which face or faces are being updated. Must be one of
+@code{GL_FRONT}, @code{GL_BACK}, or @code{GL_FRONT_AND_BACK}.
+
+@item @var{pname}
+Specifies the single-valued material parameter of the face or faces that
+is being updated. Must be @code{GL_SHININESS}.
+
+@item @var{param}
+Specifies the value that parameter @code{GL_SHININESS} will be set to.
+
+@end table
+
+@heading Description
+@code{glMaterial} assigns values to material parameters. There are two
+matched sets of material parameters. One, the @var{front-facing} set, is
+used to shade points, lines, bitmaps, and all polygons (when two-sided
+lighting is disabled), or just front-facing polygons (when two-sided
+lighting is enabled). The other set, @var{back-facing}, is used to shade
+back-facing polygons only when two-sided lighting is enabled. Refer to
+the @code{glLightModel} reference page for details concerning one- and
+two-sided lighting calculations.
+
+@code{glMaterial} takes three arguments. The first, @var{face},
+specifies whether the @code{GL_FRONT} materials, the @code{GL_BACK}
+materials, or both @code{GL_FRONT_AND_BACK} materials will be modified.
+The second, @var{pname}, specifies which of several parameters in one or
+both sets will be modified. The third, @var{params}, specifies what
+value or values will be assigned to the specified parameter.
+
+Material parameters are used in the lighting equation that is optionally
+applied to each vertex. The equation is discussed in the
+@code{glLightModel} reference page. The parameters that can be specified
+using @code{glMaterial}, and their interpretations by the lighting
+equation, are as follows:
+
+@table @asis
+@item @code{GL_AMBIENT}
+@var{params} contains four integer or floating-point values that specify
+the ambient RGBA reflectance of the material. Integer values are mapped
+linearly such that the most positive representable value maps to 1.0,
+and the most negative representable value maps to @math{-1.0}.
+Floating-point values are mapped directly. Neither integer nor
+floating-point values are clamped. The initial ambient reflectance for
+both front- and back-facing materials is (0.2, 0.2, 0.2, 1.0).
+
+@item @code{GL_DIFFUSE}
+@var{params} contains four integer or floating-point values that specify
+the diffuse RGBA reflectance of the material. Integer values are mapped
+linearly such that the most positive representable value maps to 1.0,
+and the most negative representable value maps to @math{-1.0}.
+Floating-point values are mapped directly. Neither integer nor
+floating-point values are clamped. The initial diffuse reflectance for
+both front- and back-facing materials is (0.8, 0.8, 0.8, 1.0).
+
+@item @code{GL_SPECULAR}
+@var{params} contains four integer or floating-point values that specify
+the specular RGBA reflectance of the material. Integer values are mapped
+linearly such that the most positive representable value maps to 1.0,
+and the most negative representable value maps to @math{-1.0}.
+Floating-point values are mapped directly. Neither integer nor
+floating-point values are clamped. The initial specular reflectance for
+both front- and back-facing materials is (0, 0, 0, 1).
+
+@item @code{GL_EMISSION}
+@var{params} contains four integer or floating-point values that specify
+the RGBA emitted light intensity of the material. Integer values are
+mapped linearly such that the most positive representable value maps to
+1.0, and the most negative representable value maps to @math{-1.0}.
+Floating-point values are mapped directly. Neither integer nor
+floating-point values are clamped. The initial emission intensity for
+both front- and back-facing materials is (0, 0, 0, 1).
+
+@item @code{GL_SHININESS}
+@var{params} is a single integer or floating-point value that specifies
+the RGBA specular exponent of the material. Integer and floating-point
+values are mapped directly. Only values in the range @math{[0,128]} are
+accepted. The initial specular exponent for both front- and back-facing
+materials is 0.
+
+@item @code{GL_AMBIENT_AND_DIFFUSE}
+Equivalent to calling @code{glMaterial} twice with the same parameter
+values, once with @code{GL_AMBIENT} and once with @code{GL_DIFFUSE}.
+
+@item @code{GL_COLOR_INDEXES}
+@var{params} contains three integer or floating-point values specifying
+the color indices for ambient, diffuse, and specular lighting. These
+three values, and @code{GL_SHININESS}, are the only material values used
+by the color index mode lighting equation. Refer to the
+@code{glLightModel} reference page for a discussion of color index
+lighting.
+
+@end table
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if either @var{face} or @var{pname}
+is not an accepted value.
+
+@code{GL_INVALID_VALUE} is generated if a specular exponent outside the
+range @math{[0,128]} is specified.
+
+@end defun
+
+@defun glMatrixMode
+@heading specify which matrix is the current matrix
+@heading Parameters
+@table @asis
+@item @var{mode}
+Specifies which matrix stack is the target for subsequent matrix
+operations. Three values are accepted: @code{GL_MODELVIEW},
+@code{GL_PROJECTION}, and @code{GL_TEXTURE}. The initial value is
+@code{GL_MODELVIEW}. Additionally, if the @code{ARB_imaging} extension
+is supported, @code{GL_COLOR} is also accepted.
+
+@end table
+
+@heading Description
+@code{glMatrixMode} sets the current matrix mode. @var{mode} can assume
+one of four values:
+
+@table @asis
+@item @code{GL_MODELVIEW}
+Applies subsequent matrix operations to the modelview matrix stack.
+
+@item @code{GL_PROJECTION}
+Applies subsequent matrix operations to the projection matrix stack.
+
+@item @code{GL_TEXTURE}
+Applies subsequent matrix operations to the texture matrix stack.
+
+@item @code{GL_COLOR}
+Applies subsequent matrix operations to the color matrix stack.
+
+@end table
+
+To find out which matrix stack is currently the target of all matrix
+operations, call @code{glGet} with argument @code{GL_MATRIX_MODE}. The
+initial value is @code{GL_MODELVIEW}.
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{mode} is not an accepted
+value.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glMatrixMode} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glMinmax
+@heading define minmax table
+@heading Parameters
+@table @asis
+@item @var{target}
+The minmax table whose parameters are to be set. Must be
+@code{GL_MINMAX}.
+
+@item @var{internalformat}
+The format of entries in the minmax table. Must be one of
+@code{GL_ALPHA}, @code{GL_ALPHA4}, @code{GL_ALPHA8}, @code{GL_ALPHA12},
+@code{GL_ALPHA16}, @code{GL_LUMINANCE}, @code{GL_LUMINANCE4},
+@code{GL_LUMINANCE8}, @code{GL_LUMINANCE12}, @code{GL_LUMINANCE16},
+@code{GL_LUMINANCE_ALPHA}, @code{GL_LUMINANCE4_ALPHA4},
+@code{GL_LUMINANCE6_ALPHA2}, @code{GL_LUMINANCE8_ALPHA8},
+@code{GL_LUMINANCE12_ALPHA4}, @code{GL_LUMINANCE12_ALPHA12},
+@code{GL_LUMINANCE16_ALPHA16}, @code{GL_R3_G3_B2}, @code{GL_RGB},
+@code{GL_RGB4}, @code{GL_RGB5}, @code{GL_RGB8}, @code{GL_RGB10},
+@code{GL_RGB12}, @code{GL_RGB16}, @code{GL_RGBA}, @code{GL_RGBA2},
+@code{GL_RGBA4}, @code{GL_RGB5_A1}, @code{GL_RGBA8}, @code{GL_RGB10_A2},
+@code{GL_RGBA12}, or @code{GL_RGBA16}.
+
+@item @var{sink}
+If @code{GL_TRUE}, pixels will be consumed by the minmax process and no
+drawing or texture loading will take place. If @code{GL_FALSE}, pixels
+will proceed to the final conversion process after minmax.
+
+@end table
+
+@heading Description
+When @code{GL_MINMAX} is enabled, the RGBA components of incoming pixels
+are compared to the minimum and maximum values for each component, which
+are stored in the two-element minmax table. (The first element stores
+the minima, and the second element stores the maxima.) If a pixel
+component is greater than the corresponding component in the maximum
+element, then the maximum element is updated with the pixel component
+value. If a pixel component is less than the corresponding component in
+the minimum element, then the minimum element is updated with the pixel
+component value. (In both cases, if the internal format of the minmax
+table includes luminance, then the R color component of incoming pixels
+is used for comparison.) The contents of the minmax table may be
+retrieved at a later time by calling @code{glGetMinmax}. The minmax
+operation is enabled or disabled by calling @code{glEnable} or
+@code{glDisable}, respectively, with an argument of @code{GL_MINMAX}.
+
+@code{glMinmax} redefines the current minmax table to have entries of
+the format specified by @var{internalformat}. The maximum element is
+initialized with the smallest possible component values, and the minimum
+element is initialized with the largest possible component values. The
+values in the previous minmax table, if any, are lost. If @var{sink} is
+@code{GL_TRUE}, then pixels are discarded after minmax; no further
+processing of the pixels takes place, and no drawing, texture loading,
+or pixel readback will result.
+
+
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{target} is not one of the
+allowable values.
+
+@code{GL_INVALID_ENUM} is generated if @var{internalformat} is not one
+of the allowable values.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glMinmax} is executed
+between the execution of @code{glBegin} and the corresponding execution
+of @code{glEnd}.
+
+@end defun
+
+@defun glMultiDrawArrays
+@heading render multiple sets of primitives from array data
+@heading Parameters
+@table @asis
+@item @var{mode}
+Specifies what kind of primitives to render. Symbolic constants
+@code{GL_POINTS}, @code{GL_LINE_STRIP}, @code{GL_LINE_LOOP},
+@code{GL_LINES}, @code{GL_TRIANGLE_STRIP}, @code{GL_TRIANGLE_FAN},
+@code{GL_TRIANGLES}, @code{GL_QUAD_STRIP}, @code{GL_QUADS}, and
+@code{GL_POLYGON} are accepted.
+
+@item @var{first}
+Points to an array of starting indices in the enabled arrays.
+
+@item @var{count}
+Points to an array of the number of indices to be rendered.
+
+@item @var{primcount}
+Specifies the size of the first and count
+
+@end table
+
+@heading Description
+@code{glMultiDrawArrays} specifies multiple sets of geometric primitives
+with very few subroutine calls. Instead of calling a GL procedure to
+pass each individual vertex, normal, texture coordinate, edge flag, or
+color, you can prespecify separate arrays of vertices, normals, and
+colors and use them to construct a sequence of primitives with a single
+call to @code{glMultiDrawArrays}.
+
+@code{glMultiDrawArrays} behaves identically to @code{glDrawArrays}
+except that @var{primcount} separate ranges of elements are specified
+instead.
+
+When @code{glMultiDrawArrays} is called, it uses @var{count} sequential
+elements from each enabled array to construct a sequence of geometric
+primitives, beginning with element @var{first}. @var{mode} specifies
+what kind of primitives are constructed, and how the array elements
+construct those primitives. If @code{GL_VERTEX_ARRAY} is not enabled, no
+geometric primitives are generated.
+
+Vertex attributes that are modified by @code{glMultiDrawArrays} have an
+unspecified value after @code{glMultiDrawArrays} returns. For example,
+if @code{GL_COLOR_ARRAY} is enabled, the value of the current color is
+undefined after @code{glMultiDrawArrays} executes. Attributes that
+aren't modified remain well defined.
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{mode} is not an accepted
+value.
+
+@code{GL_INVALID_VALUE} is generated if @var{primcount} is negative.
+
+@code{GL_INVALID_OPERATION} is generated if a non-zero buffer object
+name is bound to an enabled array and the buffer object's data store is
+currently mapped.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glMultiDrawArrays} is
+executed between the execution of @code{glBegin} and the corresponding
+@code{glEnd}.
+
+@end defun
+
+@defun glMultiDrawElements
+@heading render multiple sets of primitives by specifying indices of array data elements
+@heading Parameters
+@table @asis
+@item @var{mode}
+Specifies what kind of primitives to render. Symbolic constants
+@code{GL_POINTS}, @code{GL_LINE_STRIP}, @code{GL_LINE_LOOP},
+@code{GL_LINES}, @code{GL_TRIANGLE_STRIP}, @code{GL_TRIANGLE_FAN},
+@code{GL_TRIANGLES}, @code{GL_QUAD_STRIP}, @code{GL_QUADS}, and
+@code{GL_POLYGON} are accepted.
+
+@item @var{count}
+Points to an array of the elements counts.
+
+@item @var{type}
+Specifies the type of the values in @var{indices}. Must be one of
+@code{GL_UNSIGNED_BYTE}, @code{GL_UNSIGNED_SHORT}, or
+@code{GL_UNSIGNED_INT}.
+
+@item @var{indices}
+Specifies a pointer to the location where the indices are stored.
+
+@item @var{primcount}
+Specifies the size of the @var{count} array.
+
+@end table
+
+@heading Description
+@code{glMultiDrawElements} specifies multiple sets of geometric
+primitives with very few subroutine calls. Instead of calling a GL
+function to pass each individual vertex, normal, texture coordinate,
+edge flag, or color, you can prespecify separate arrays of vertices,
+normals, and so on, and use them to construct a sequence of primitives
+with a single call to @code{glMultiDrawElements}.
+
+@code{glMultiDrawElements} is identical in operation to
+@code{glDrawElements} except that @var{primcount} separate lists of
+elements are specified.
+
+Vertex attributes that are modified by @code{glMultiDrawElements} have
+an unspecified value after @code{glMultiDrawElements} returns. For
+example, if @code{GL_COLOR_ARRAY} is enabled, the value of the current
+color is undefined after @code{glMultiDrawElements} executes. Attributes
+that aren't modified maintain their previous values.
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{mode} is not an accepted
+value.
+
+@code{GL_INVALID_VALUE} is generated if @var{primcount} is negative.
+
+@code{GL_INVALID_OPERATION} is generated if a non-zero buffer object
+name is bound to an enabled array or the element array and the buffer
+object's data store is currently mapped.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glMultiDrawElements}
+is executed between the execution of @code{glBegin} and the
+corresponding @code{glEnd}.
+
+@end defun
+
+@defun glMultiTexCoord
+@heading set the current texture coordinates
+@heading Parameters
+@table @asis
+@item @var{target}
+Specifies the texture unit whose coordinates should be modified. The
+number of texture units is implementation dependent, but must be at
+least two. Symbolic constant must be one of
+@code{GL_TEXTURE}@math{@var{i}}, where i ranges from 0 to
+@code{GL_MAX_TEXTURE_COORDS} - 1, which is an implementation-dependent
+value.
+
+@item @var{s}
+@itemx @var{t}
+@itemx @var{r}
+@itemx @var{q}
+Specify @var{s}, @var{t}, @var{r}, and @var{q} texture coordinates for
+@var{target} texture unit. Not all parameters are present in all forms
+of the command.
+
+@end table
+
+@heading Description
+@code{glMultiTexCoord} specifies texture coordinates in one, two, three,
+or four dimensions. @code{glMultiTexCoord1} sets the current texture
+coordinates to @math{(@var{s},001)}; a call to @code{glMultiTexCoord2}
+sets them to @math{(@var{s},@var{t}01)}. Similarly,
+@code{glMultiTexCoord3} specifies the texture coordinates as
+@math{(@var{s},@var{t}@var{r}1)}, and @code{glMultiTexCoord4} defines
+all four components explicitly as
+@math{(@var{s},@var{t}@var{r}@var{q})}.
+
+The current texture coordinates are part of the data that is associated
+with each vertex and with the current raster position. Initially, the
+values for @math{(@var{s},@var{t}@var{r}@var{q})} are @math{(0,001)}.
+
+
+
+@end defun
+
+@defun glMultMatrix
+@heading multiply the current matrix with the specified matrix
+@heading Parameters
+@table @asis
+@item @var{m}
+Points to 16 consecutive values that are used as the elements of a
+@math{4×4} column-major matrix.
+
+@end table
+
+@heading Description
+@code{glMultMatrix} multiplies the current matrix with the one specified
+using @var{m}, and replaces the current matrix with the product.
+
+The current matrix is determined by the current matrix mode (see
+@code{glMatrixMode}). It is either the projection matrix, modelview
+matrix, or the texture matrix.
+
+@heading Errors
+@code{GL_INVALID_OPERATION} is generated if @code{glMultMatrix} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glMultTransposeMatrix
+@heading multiply the current matrix with the specified row-major ordered matrix
+@heading Parameters
+@table @asis
+@item @var{m}
+Points to 16 consecutive values that are used as the elements of a
+@math{4×4} row-major matrix.
+
+@end table
+
+@heading Description
+@code{glMultTransposeMatrix} multiplies the current matrix with the one
+specified using @var{m}, and replaces the current matrix with the
+product.
+
+The current matrix is determined by the current matrix mode (see
+@code{glMatrixMode}). It is either the projection matrix, modelview
+matrix, or the texture matrix.
+
+@heading Errors
+@code{GL_INVALID_OPERATION} is generated if @code{glMultTransposeMatrix}
+is executed between the execution of @code{glBegin} and the
+corresponding execution of @code{glEnd}.
+
+@end defun
+
+@defun glNewList
+@heading create or replace a display list
+@heading Parameters
+@table @asis
+@item @var{list}
+Specifies the display-list name.
+
+@item @var{mode}
+Specifies the compilation mode, which can be @code{GL_COMPILE} or
+@code{GL_COMPILE_AND_EXECUTE}.
+
+@end table
+
+@heading Description
+Display lists are groups of GL commands that have been stored for
+subsequent execution. Display lists are created with @code{glNewList}.
+All subsequent commands are placed in the display list, in the order
+issued, until @code{glEndList} is called.
+
+@code{glNewList} has two arguments. The first argument, @var{list}, is a
+positive integer that becomes the unique name for the display list.
+Names can be created and reserved with @code{glGenLists} and tested for
+uniqueness with @code{glIsList}. The second argument, @var{mode}, is a
+symbolic constant that can assume one of two values:
+
+@table @asis
+@item @code{GL_COMPILE}
+Commands are merely compiled.
+
+@item @code{GL_COMPILE_AND_EXECUTE}
+Commands are executed as they are compiled into the display list.
+
+@end table
+
+Certain commands are not compiled into the display list but are executed
+immediately, regardless of the display-list mode. These commands are
+@code{glAreTexturesResident}, @code{glColorPointer},
+@code{glDeleteLists}, @code{glDeleteTextures},
+@code{glDisableClientState}, @code{glEdgeFlagPointer},
+@code{glEnableClientState}, @code{glFeedbackBuffer}, @code{glFinish},
+@code{glFlush}, @code{glGenLists}, @code{glGenTextures},
+@code{glIndexPointer}, @code{glInterleavedArrays}, @code{glIsEnabled},
+@code{glIsList}, @code{glIsTexture}, @code{glNormalPointer},
+@code{glPopClientAttrib}, @code{glPixelStore},
+@code{glPushClientAttrib}, @code{glReadPixels}, @code{glRenderMode},
+@code{glSelectBuffer}, @code{glTexCoordPointer}, @code{glVertexPointer},
+and all of the @code{glGet} commands.
+
+Similarly, @code{glTexImage1D}, @code{glTexImage2D}, and
+@code{glTexImage3D} are executed immediately and not compiled into the
+display list when their first argument is @code{GL_PROXY_TEXTURE_1D},
+@code{GL_PROXY_TEXTURE_1D}, or @code{GL_PROXY_TEXTURE_3D}, respectively.
+
+When the @code{ARB_imaging} extension is supported, @code{glHistogram}
+executes immediately when its argument is @code{GL_PROXY_HISTOGRAM}.
+Similarly, @code{glColorTable} executes immediately when its first
+argument is @code{GL_PROXY_COLOR_TABLE},
+@code{GL_PROXY_POST_CONVOLUTION_COLOR_TABLE}, or
+@code{GL_PROXY_POST_COLOR_MATRIX_COLOR_TABLE}.
+
+For OpenGL versions 1.3 and greater, or when the @code{ARB_multitexture}
+extension is supported, @code{glClientActiveTexture} is not compiled
+into display lists, but executed immediately.
+
+When @code{glEndList} is encountered, the display-list definition is
+completed by associating the list with the unique name @var{list}
+(specified in the @code{glNewList} command). If a display list with name
+@var{list} already exists, it is replaced only when @code{glEndList} is
+called.
+
+@heading Errors
+@code{GL_INVALID_VALUE} is generated if @var{list} is 0.
+
+@code{GL_INVALID_ENUM} is generated if @var{mode} is not an accepted
+value.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glEndList} is called
+without a preceding @code{glNewList}, or if @code{glNewList} is called
+while a display list is being defined.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glNewList} or
+@code{glEndList} is executed between the execution of @code{glBegin} and
+the corresponding execution of @code{glEnd}.
+
+@code{GL_OUT_OF_MEMORY} is generated if there is insufficient memory to
+compile the display list. If the GL version is 1.1 or greater, no change
+is made to the previous contents of the display list, if any, and no
+other change is made to the GL state. (It is as if no attempt had been
+made to create the new display list.)
+
+@end defun
+
+@defun glNormalPointer
+@heading define an array of normals
+@heading Parameters
+@table @asis
+@item @var{type}
+Specifies the data type of each coordinate in the array. Symbolic
+constants @code{GL_BYTE}, @code{GL_SHORT}, @code{GL_INT},
+@code{GL_FLOAT}, and @code{GL_DOUBLE} are accepted. The initial value is
+@code{GL_FLOAT}.
+
+@item @var{stride}
+Specifies the byte offset between consecutive normals. If @var{stride}
+is 0, the normals are understood to be tightly packed in the array. The
+initial value is 0.
+
+@item @var{pointer}
+Specifies a pointer to the first coordinate of the first normal in the
+array. The initial value is 0.
+
+@end table
+
+@heading Description
+@code{glNormalPointer} specifies the location and data format of an
+array of normals to use when rendering. @var{type} specifies the data
+type of each normal coordinate, and @var{stride} specifies the byte
+stride from one normal to the next, allowing vertices and attributes to
+be packed into a single array or stored in separate arrays.
+(Single-array storage may be more efficient on some implementations; see
+@code{glInterleavedArrays}.)
+
+If a non-zero named buffer object is bound to the @code{GL_ARRAY_BUFFER}
+target (see @code{glBindBuffer}) while a normal array is specified,
+@var{pointer} is treated as a byte offset into the buffer object's data
+store. Also, the buffer object binding (@code{GL_ARRAY_BUFFER_BINDING})
+is saved as normal vertex array client-side state
+(@code{GL_NORMAL_ARRAY_BUFFER_BINDING}).
+
+When a normal array is specified, @var{type}, @var{stride}, and
+@var{pointer} are saved as client-side state, in addition to the current
+vertex array buffer object binding.
+
+To enable and disable the normal array, call @code{glEnableClientState}
+and @code{glDisableClientState} with the argument
+@code{GL_NORMAL_ARRAY}. If enabled, the normal array is used when
+@code{glDrawArrays}, @code{glMultiDrawArrays}, @code{glDrawElements},
+@code{glMultiDrawElements}, @code{glDrawRangeElements}, or
+@code{glArrayElement} is called.
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{type} is not an accepted
+value.
+
+@code{GL_INVALID_VALUE} is generated if @var{stride} is negative.
+
+@end defun
+
+@defun glNormal
+@heading set the current normal vector
+@heading Parameters
+@table @asis
+@item @var{nx}
+@itemx @var{ny}
+@itemx @var{nz}
+Specify the @math{@var{x}}, @math{@var{y}}, and @math{@var{z}}
+coordinates of the new current normal. The initial value of the current
+normal is the unit vector, (0, 0, 1).
+
+
+
+@end table
+
+@heading Description
+The current normal is set to the given coordinates whenever
+@code{glNormal} is issued. Byte, short, or integer arguments are
+converted to floating-point format with a linear mapping that maps the
+most positive representable integer value to 1.0 and the most negative
+representable integer value to @math{-1.0}.
+
+Normals specified with @code{glNormal} need not have unit length. If
+@code{GL_NORMALIZE} is enabled, then normals of any length specified
+with @code{glNormal} are normalized after transformation. If
+@code{GL_RESCALE_NORMAL} is enabled, normals are scaled by a scaling
+factor derived from the modelview matrix. @code{GL_RESCALE_NORMAL}
+requires that the originally specified normals were of unit length, and
+that the modelview matrix contain only uniform scales for proper
+results. To enable and disable normalization, call @code{glEnable} and
+@code{glDisable} with either @code{GL_NORMALIZE} or
+@code{GL_RESCALE_NORMAL}. Normalization is initially disabled.
+
+@end defun
+
+@defun glOrtho
+@heading multiply the current matrix with an orthographic matrix
+@heading Parameters
+@table @asis
+@item @var{left}
+@itemx @var{right}
+Specify the coordinates for the left and right vertical clipping planes.
+
+@item @var{bottom}
+@itemx @var{top}
+Specify the coordinates for the bottom and top horizontal clipping
+planes.
+
+@item @var{nearVal}
+@itemx @var{farVal}
+Specify the distances to the nearer and farther depth clipping planes.
+These values are negative if the plane is to be behind the viewer.
+
+@end table
+
+@heading Description
+@code{glOrtho} describes a transformation that produces a parallel
+projection. The current matrix (see @code{glMatrixMode}) is multiplied
+by this matrix and the result replaces the current matrix, as if
+@code{glMultMatrix} were called with the following matrix as its
+argument:
+
+@math{((2/@var{right}-@var{left},, 0 0 @var{t}_@var{x},), (0
+2/@var{top}-@var{bottom},, 0 @var{t}_@var{y},), (0 0
+-2/@var{farVal}-@var{nearVal},, @var{t}_@var{z},), (0 0 0 1),)}
+
+where
+@math{@var{t}_@var{x}=-@var{right}+@var{left},/@var{right}-@var{left},,}@math{@var{t}_@var{y}=-@var{top}+@var{bottom},/@var{top}-@var{bottom},,}@math{@var{t}_@var{z}=-@var{farVal}+@var{nearVal},/@var{farVal}-@var{nearVal},,}
+
+Typically, the matrix mode is @code{GL_PROJECTION}, and
+@math{(@var{left},@var{bottom}-@var{nearVal})} and
+@math{(@var{right},@var{top}-@var{nearVal})} specify the points on the
+near clipping plane that are mapped to the lower left and upper right
+corners of the window, respectively, assuming that the eye is located at
+(0, 0, 0). @math{-@var{farVal}} specifies the location of the far
+clipping plane. Both @var{nearVal} and @var{farVal} can be either
+positive or negative.
+
+Use @code{glPushMatrix} and @code{glPopMatrix} to save and restore the
+current matrix stack.
+
+@heading Errors
+@code{GL_INVALID_VALUE} is generated if @var{left} = @var{right}, or
+@var{bottom} = @var{top}, or @var{near} = @var{far}.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glOrtho} is executed
+between the execution of @code{glBegin} and the corresponding execution
+of @code{glEnd}.
+
+@end defun
+
+@defun glPassThrough
+@heading place a marker in the feedback buffer
+@heading Parameters
+@table @asis
+@item @var{token}
+Specifies a marker value to be placed in the feedback buffer following a
+@code{GL_PASS_THROUGH_TOKEN}.
+
+@end table
+
+@heading Description
+
+
+Feedback is a GL render mode. The mode is selected by calling
+@code{glRenderMode} with @code{GL_FEEDBACK}. When the GL is in feedback
+mode, no pixels are produced by rasterization. Instead, information
+about primitives that would have been rasterized is fed back to the
+application using the GL. See the @code{glFeedbackBuffer} reference page
+for a description of the feedback buffer and the values in it.
+
+@code{glPassThrough} inserts a user-defined marker in the feedback
+buffer when it is executed in feedback mode. @var{token} is returned as
+if it were a primitive; it is indicated with its own unique identifying
+value: @code{GL_PASS_THROUGH_TOKEN}. The order of @code{glPassThrough}
+commands with respect to the specification of graphics primitives is
+maintained.
+
+@heading Errors
+@code{GL_INVALID_OPERATION} is generated if @code{glPassThrough} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glPixelMap
+@heading set up pixel transfer maps
+@heading Parameters
+@table @asis
+@item @var{map}
+Specifies a symbolic map name. Must be one of the following:
+@code{GL_PIXEL_MAP_I_TO_I}, @code{GL_PIXEL_MAP_S_TO_S},
+@code{GL_PIXEL_MAP_I_TO_R}, @code{GL_PIXEL_MAP_I_TO_G},
+@code{GL_PIXEL_MAP_I_TO_B}, @code{GL_PIXEL_MAP_I_TO_A},
+@code{GL_PIXEL_MAP_R_TO_R}, @code{GL_PIXEL_MAP_G_TO_G},
+@code{GL_PIXEL_MAP_B_TO_B}, or @code{GL_PIXEL_MAP_A_TO_A}.
+
+@item @var{mapsize}
+Specifies the size of the map being defined.
+
+@item @var{values}
+Specifies an array of @var{mapsize} values.
+
+@end table
+
+@heading Description
+@code{glPixelMap} sets up translation tables, or @var{maps}, used by
+@code{glCopyPixels}, @code{glCopyTexImage1D}, @code{glCopyTexImage2D},
+@code{glCopyTexSubImage1D}, @code{glCopyTexSubImage2D},
+@code{glCopyTexSubImage3D}, @code{glDrawPixels}, @code{glReadPixels},
+@code{glTexImage1D}, @code{glTexImage2D}, @code{glTexImage3D},
+@code{glTexSubImage1D}, @code{glTexSubImage2D}, and
+@code{glTexSubImage3D}. Additionally, if the @code{ARB_imaging} subset
+is supported, the routines @code{glColorTable}, @code{glColorSubTable},
+@code{glConvolutionFilter1D}, @code{glConvolutionFilter2D},
+@code{glHistogram}, @code{glMinmax}, and @code{glSeparableFilter2D}. Use
+of these maps is described completely in the @code{glPixelTransfer}
+reference page, and partly in the reference pages for the pixel and
+texture image commands. Only the specification of the maps is described
+in this reference page.
+
+@var{map} is a symbolic map name, indicating one of ten maps to set.
+@var{mapsize} specifies the number of entries in the map, and
+@var{values} is a pointer to an array of @var{mapsize} map values.
+
+If a non-zero named buffer object is bound to the
+@code{GL_PIXEL_UNPACK_BUFFER} target (see @code{glBindBuffer}) while a
+pixel transfer map is specified, @var{values} is treated as a byte
+offset into the buffer object's data store.
+
+The ten maps are as follows:
+
+@table @asis
+@item @code{GL_PIXEL_MAP_I_TO_I}
+Maps color indices to color indices.
+
+@item @code{GL_PIXEL_MAP_S_TO_S}
+Maps stencil indices to stencil indices.
+
+@item @code{GL_PIXEL_MAP_I_TO_R}
+Maps color indices to red components.
+
+@item @code{GL_PIXEL_MAP_I_TO_G}
+Maps color indices to green components.
+
+@item @code{GL_PIXEL_MAP_I_TO_B}
+Maps color indices to blue components.
+
+@item @code{GL_PIXEL_MAP_I_TO_A}
+Maps color indices to alpha components.
+
+@item @code{GL_PIXEL_MAP_R_TO_R}
+Maps red components to red components.
+
+@item @code{GL_PIXEL_MAP_G_TO_G}
+Maps green components to green components.
+
+@item @code{GL_PIXEL_MAP_B_TO_B}
+Maps blue components to blue components.
+
+@item @code{GL_PIXEL_MAP_A_TO_A}
+Maps alpha components to alpha components.
+
+@end table
+
+The entries in a map can be specified as single-precision floating-point
+numbers, unsigned short integers, or unsigned int integers. Maps that
+store color component values (all but @code{GL_PIXEL_MAP_I_TO_I} and
+@code{GL_PIXEL_MAP_S_TO_S}) retain their values in floating-point
+format, with unspecified mantissa and exponent sizes. Floating-point
+values specified by @code{glPixelMapfv} are converted directly to the
+internal floating-point format of these maps, then clamped to the range
+[0,1]. Unsigned integer values specified by @code{glPixelMapusv} and
+@code{glPixelMapuiv} are converted linearly such that the largest
+representable integer maps to 1.0, and 0 maps to 0.0.
+
+Maps that store indices, @code{GL_PIXEL_MAP_I_TO_I} and
+@code{GL_PIXEL_MAP_S_TO_S}, retain their values in fixed-point format,
+with an unspecified number of bits to the right of the binary point.
+Floating-point values specified by @code{glPixelMapfv} are converted
+directly to the internal fixed-point format of these maps. Unsigned
+integer values specified by @code{glPixelMapusv} and
+@code{glPixelMapuiv} specify integer values, with all 0's to the right
+of the binary point.
+
+The following table shows the initial sizes and values for each of the
+maps. Maps that are indexed by either color or stencil indices must have
+@var{mapsize} = @math{2^@var{n}} for some @math{@var{n}} or the results
+are undefined. The maximum allowable size for each map depends on the
+implementation and can be determined by calling @code{glGet} with
+argument @code{GL_MAX_PIXEL_MAP_TABLE}. The single maximum applies to
+all maps; it is at least 32.
+
+@table @asis
+@item @strong{@var{map}}
+@strong{Lookup Index}, @strong{Lookup Value}, @strong{Initial Size},
+@strong{Initial Value}
+
+@item @code{GL_PIXEL_MAP_I_TO_I}
+color index , color index , 1 , 0
+
+@item @code{GL_PIXEL_MAP_S_TO_S}
+stencil index , stencil index , 1 , 0
+
+@item @code{GL_PIXEL_MAP_I_TO_R}
+color index , R , 1 , 0
+
+@item @code{GL_PIXEL_MAP_I_TO_G}
+color index , G , 1 , 0
+
+@item @code{GL_PIXEL_MAP_I_TO_B}
+color index , B , 1 , 0
+
+@item @code{GL_PIXEL_MAP_I_TO_A}
+color index , A , 1 , 0
+
+@item @code{GL_PIXEL_MAP_R_TO_R}
+R , R , 1 , 0
+
+@item @code{GL_PIXEL_MAP_G_TO_G}
+G , G , 1 , 0
+
+@item @code{GL_PIXEL_MAP_B_TO_B}
+B , B , 1 , 0
+
+@item @code{GL_PIXEL_MAP_A_TO_A}
+A , A , 1 , 0
+
+@end table
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{map} is not an accepted
+value.
+
+@code{GL_INVALID_VALUE} is generated if @var{mapsize} is less than one
+or larger than @code{GL_MAX_PIXEL_MAP_TABLE}.
+
+@code{GL_INVALID_VALUE} is generated if @var{map} is
+@code{GL_PIXEL_MAP_I_TO_I}, @code{GL_PIXEL_MAP_S_TO_S},
+@code{GL_PIXEL_MAP_I_TO_R}, @code{GL_PIXEL_MAP_I_TO_G},
+@code{GL_PIXEL_MAP_I_TO_B}, or @code{GL_PIXEL_MAP_I_TO_A}, and
+@var{mapsize} is not a power of two.
+
+@code{GL_INVALID_OPERATION} is generated if a non-zero buffer object
+name is bound to the @code{GL_PIXEL_UNPACK_BUFFER} target and the buffer
+object's data store is currently mapped.
+
+@code{GL_INVALID_OPERATION} is generated if a non-zero buffer object
+name is bound to the @code{GL_PIXEL_UNPACK_BUFFER} target and the data
+would be unpacked from the buffer object such that the memory reads
+required would exceed the data store size.
+
+@code{GL_INVALID_OPERATION} is generated by @code{glPixelMapfv} if a
+non-zero buffer object name is bound to the
+@code{GL_PIXEL_UNPACK_BUFFER} target and @var{values} is not evenly
+divisible into the number of bytes needed to store in memory a GLfloat
+datum.
+
+@code{GL_INVALID_OPERATION} is generated by @code{glPixelMapuiv} if a
+non-zero buffer object name is bound to the
+@code{GL_PIXEL_UNPACK_BUFFER} target and @var{values} is not evenly
+divisible into the number of bytes needed to store in memory a GLuint
+datum.
+
+@code{GL_INVALID_OPERATION} is generated by @code{glPixelMapusv} if a
+non-zero buffer object name is bound to the
+@code{GL_PIXEL_UNPACK_BUFFER} target and @var{values} is not evenly
+divisible into the number of bytes needed to store in memory a GLushort
+datum.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glPixelMap} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glPixelStore
+@heading set pixel storage modes
+@heading Parameters
+@table @asis
+@item @var{pname}
+Specifies the symbolic name of the parameter to be set. Six values
+affect the packing of pixel data into memory: @code{GL_PACK_SWAP_BYTES},
+@code{GL_PACK_LSB_FIRST}, @code{GL_PACK_ROW_LENGTH},
+@code{GL_PACK_IMAGE_HEIGHT}, @code{GL_PACK_SKIP_PIXELS},
+@code{GL_PACK_SKIP_ROWS}, @code{GL_PACK_SKIP_IMAGES}, and
+@code{GL_PACK_ALIGNMENT}. Six more affect the unpacking of pixel data
+@var{from} memory: @code{GL_UNPACK_SWAP_BYTES},
+@code{GL_UNPACK_LSB_FIRST}, @code{GL_UNPACK_ROW_LENGTH},
+@code{GL_UNPACK_IMAGE_HEIGHT}, @code{GL_UNPACK_SKIP_PIXELS},
+@code{GL_UNPACK_SKIP_ROWS}, @code{GL_UNPACK_SKIP_IMAGES}, and
+@code{GL_UNPACK_ALIGNMENT}.
+
+@item @var{param}
+Specifies the value that @var{pname} is set to.
+
+@end table
+
+@heading Description
+@code{glPixelStore} sets pixel storage modes that affect the operation
+of subsequent @code{glDrawPixels} and @code{glReadPixels} as well as the
+unpacking of polygon stipple patterns (see @code{glPolygonStipple}),
+bitmaps (see @code{glBitmap}), texture patterns (see
+@code{glTexImage1D}, @code{glTexImage2D}, @code{glTexImage3D},
+@code{glTexSubImage1D}, @code{glTexSubImage2D}, @code{glTexSubImage3D}).
+Additionally, if the @code{ARB_imaging} extension is supported, pixel
+storage modes affect convolution filters (see
+@code{glConvolutionFilter1D}, @code{glConvolutionFilter2D}, and
+@code{glSeparableFilter2D}, color table (see @code{glColorTable}, and
+@code{glColorSubTable}, and unpacking histogram (See
+@code{glHistogram}), and minmax (See @code{glMinmax}) data.
+
+@var{pname} is a symbolic constant indicating the parameter to be set,
+and @var{param} is the new value. Six of the twelve storage parameters
+affect how pixel data is returned to client memory. They are as follows:
+
+@table @asis
+@item @code{GL_PACK_SWAP_BYTES}
+If true, byte ordering for multibyte color components, depth components,
+color indices, or stencil indices is reversed. That is, if a four-byte
+component consists of bytes @math{@var{b}_0}, @math{@var{b}_1},
+@math{@var{b}_2}, @math{@var{b}_3}, it is stored in memory as
+@math{@var{b}_3}, @math{@var{b}_2}, @math{@var{b}_1}, @math{@var{b}_0}
+if @code{GL_PACK_SWAP_BYTES} is true. @code{GL_PACK_SWAP_BYTES} has no
+effect on the memory order of components within a pixel, only on the
+order of bytes within components or indices. For example, the three
+components of a @code{GL_RGB} format pixel are always stored with red
+first, green second, and blue third, regardless of the value of
+@code{GL_PACK_SWAP_BYTES}.
+
+@item @code{GL_PACK_LSB_FIRST}
+If true, bits are ordered within a byte from least significant to most
+significant; otherwise, the first bit in each byte is the most
+significant one. This parameter is significant for bitmap data only.
+
+@item @code{GL_PACK_ROW_LENGTH}
+If greater than 0, @code{GL_PACK_ROW_LENGTH} defines the number of
+pixels in a row. If the first pixel of a row is placed at location
+@math{@var{p}} in memory, then the location of the first pixel of the
+next row is obtained by skipping
+
+@math{@var{k}=@{(@var{n}@var{l}),
+(@var{a}/@var{s},⌈@var{s}@var{n}@var{l},/@var{a},⌉)(@var{s}>=@var{a}),
+(@var{s}<@var{a}),}
+
+components or indices, where @math{@var{n}} is the number of components
+or indices in a pixel, @math{@var{l}} is the number of pixels in a row
+(@code{GL_PACK_ROW_LENGTH} if it is greater than 0, the
+@math{@var{width}} argument to the pixel routine otherwise),
+@math{@var{a}} is the value of @code{GL_PACK_ALIGNMENT}, and
+@math{@var{s}} is the size, in bytes, of a single component (if
+@math{@var{a}<@var{s}}, then it is as if @math{@var{a}=@var{s}}). In the
+case of 1-bit values, the location of the next row is obtained by
+skipping
+
+@math{@var{k}=8@var{a}⌈@var{n}@var{l},/8@var{a},,⌉}
+
+components or indices.
+
+The word @var{component} in this description refers to the nonindex
+values red, green, blue, alpha, and depth. Storage format @code{GL_RGB},
+for example, has three components per pixel: first red, then green, and
+finally blue.
+
+@item @code{GL_PACK_IMAGE_HEIGHT}
+If greater than 0, @code{GL_PACK_IMAGE_HEIGHT} defines the number of
+pixels in an image three-dimensional texture volume, where ``image'' is
+defined by all pixels sharing the same third dimension index. If the
+first pixel of a row is placed at location @math{@var{p}} in memory,
+then the location of the first pixel of the next row is obtained by
+skipping
+
+@math{@var{k}=@{(@var{n}@var{l}@var{h}),
+(@var{a}/@var{s},⌈@var{s}@var{n}@var{l}@var{h},/@var{a},⌉)(@var{s}>=@var{a}),
+(@var{s}<@var{a}),}
+
+components or indices, where @math{@var{n}} is the number of components
+or indices in a pixel, @math{@var{l}} is the number of pixels in a row
+(@code{GL_PACK_ROW_LENGTH} if it is greater than 0, the
+@math{@var{width}} argument to @code{glTexImage3D} otherwise),
+@math{@var{h}} is the number of rows in a pixel image
+(@code{GL_PACK_IMAGE_HEIGHT} if it is greater than 0, the
+@math{@var{height}} argument to the @code{glTexImage3D} routine
+otherwise), @math{@var{a}} is the value of @code{GL_PACK_ALIGNMENT}, and
+@math{@var{s}} is the size, in bytes, of a single component (if
+@math{@var{a}<@var{s}}, then it is as if @math{@var{a}=@var{s}}).
+
+The word @var{component} in this description refers to the nonindex
+values red, green, blue, alpha, and depth. Storage format @code{GL_RGB},
+for example, has three components per pixel: first red, then green, and
+finally blue.
+
+@item @code{GL_PACK_SKIP_PIXELS}, @code{GL_PACK_SKIP_ROWS}, and @code{GL_PACK_SKIP_IMAGES}
+These values are provided as a convenience to the programmer; they
+provide no functionality that cannot be duplicated simply by
+incrementing the pointer passed to @code{glReadPixels}. Setting
+@code{GL_PACK_SKIP_PIXELS} to @math{@var{i}} is equivalent to
+incrementing the pointer by @math{@var{i}@var{n}} components or
+indices, where @math{@var{n}} is the number of components or indices in
+each pixel. Setting @code{GL_PACK_SKIP_ROWS} to @math{@var{j}} is
+equivalent to incrementing the pointer by @math{@var{j}@var{m}}
+components or indices, where @math{@var{m}} is the number of components
+or indices per row, as just computed in the @code{GL_PACK_ROW_LENGTH}
+section. Setting @code{GL_PACK_SKIP_IMAGES} to @math{@var{k}} is
+equivalent to incrementing the pointer by @math{@var{k}@var{p}}, where
+@math{@var{p}} is the number of components or indices per image, as
+computed in the @code{GL_PACK_IMAGE_HEIGHT} section.
+
+@item @code{GL_PACK_ALIGNMENT}
+Specifies the alignment requirements for the start of each pixel row in
+memory. The allowable values are 1 (byte-alignment), 2 (rows aligned to
+even-numbered bytes), 4 (word-alignment), and 8 (rows start on
+double-word boundaries).
+
+@end table
+
+The other six of the twelve storage parameters affect how pixel data is
+read from client memory. These values are significant for
+@code{glDrawPixels}, @code{glTexImage1D}, @code{glTexImage2D},
+@code{glTexImage3D}, @code{glTexSubImage1D}, @code{glTexSubImage2D},
+@code{glTexSubImage3D}, @code{glBitmap}, and @code{glPolygonStipple}.
+
+Additionally, if the @code{ARB_imaging} extension is supported,
+@code{glColorTable}, @code{glColorSubTable},
+@code{glConvolutionFilter1D}, @code{glConvolutionFilter2D}, and
+@code{glSeparableFilter2D}. They are as follows:
+
+@table @asis
+@item @code{GL_UNPACK_SWAP_BYTES}
+If true, byte ordering for multibyte color components, depth components,
+color indices, or stencil indices is reversed. That is, if a four-byte
+component consists of bytes @math{@var{b}_0}, @math{@var{b}_1},
+@math{@var{b}_2}, @math{@var{b}_3}, it is taken from memory as
+@math{@var{b}_3}, @math{@var{b}_2}, @math{@var{b}_1}, @math{@var{b}_0}
+if @code{GL_UNPACK_SWAP_BYTES} is true. @code{GL_UNPACK_SWAP_BYTES} has
+no effect on the memory order of components within a pixel, only on the
+order of bytes within components or indices. For example, the three
+components of a @code{GL_RGB} format pixel are always stored with red
+first, green second, and blue third, regardless of the value of
+@code{GL_UNPACK_SWAP_BYTES}.
+
+@item @code{GL_UNPACK_LSB_FIRST}
+If true, bits are ordered within a byte from least significant to most
+significant; otherwise, the first bit in each byte is the most
+significant one. This is relevant only for bitmap data.
+
+@item @code{GL_UNPACK_ROW_LENGTH}
+If greater than 0, @code{GL_UNPACK_ROW_LENGTH} defines the number of
+pixels in a row. If the first pixel of a row is placed at location
+@math{@var{p}} in memory, then the location of the first pixel of the
+next row is obtained by skipping
+
+@math{@var{k}=@{(@var{n}@var{l}),
+(@var{a}/@var{s},⌈@var{s}@var{n}@var{l},/@var{a},⌉)(@var{s}>=@var{a}),
+(@var{s}<@var{a}),}
+
+components or indices, where @math{@var{n}} is the number of components
+or indices in a pixel, @math{@var{l}} is the number of pixels in a row
+(@code{GL_UNPACK_ROW_LENGTH} if it is greater than 0, the
+@math{@var{width}} argument to the pixel routine otherwise),
+@math{@var{a}} is the value of @code{GL_UNPACK_ALIGNMENT}, and
+@math{@var{s}} is the size, in bytes, of a single component (if
+@math{@var{a}<@var{s}}, then it is as if @math{@var{a}=@var{s}}). In the
+case of 1-bit values, the location of the next row is obtained by
+skipping
+
+@math{@var{k}=8@var{a}⌈@var{n}@var{l},/8@var{a},,⌉}
+
+components or indices.
+
+The word @var{component} in this description refers to the nonindex
+values red, green, blue, alpha, and depth. Storage format @code{GL_RGB},
+for example, has three components per pixel: first red, then green, and
+finally blue.
+
+@item @code{GL_UNPACK_IMAGE_HEIGHT}
+If greater than 0, @code{GL_UNPACK_IMAGE_HEIGHT} defines the number of
+pixels in an image of a three-dimensional texture volume. Where
+``image'' is defined by all pixel sharing the same third dimension
+index. If the first pixel of a row is placed at location @math{@var{p}}
+in memory, then the location of the first pixel of the next row is
+obtained by skipping
+
+@math{@var{k}=@{(@var{n}@var{l}@var{h}),
+(@var{a}/@var{s},⌈@var{s}@var{n}@var{l}@var{h},/@var{a},⌉)(@var{s}>=@var{a}),
+(@var{s}<@var{a}),}
+
+components or indices, where @math{@var{n}} is the number of components
+or indices in a pixel, @math{@var{l}} is the number of pixels in a row
+(@code{GL_UNPACK_ROW_LENGTH} if it is greater than 0, the
+@math{@var{width}} argument to @code{glTexImage3D} otherwise),
+@math{@var{h}} is the number of rows in an image
+(@code{GL_UNPACK_IMAGE_HEIGHT} if it is greater than 0, the
+@math{@var{height}} argument to @code{glTexImage3D} otherwise),
+@math{@var{a}} is the value of @code{GL_UNPACK_ALIGNMENT}, and
+@math{@var{s}} is the size, in bytes, of a single component (if
+@math{@var{a}<@var{s}}, then it is as if @math{@var{a}=@var{s}}).
+
+The word @var{component} in this description refers to the nonindex
+values red, green, blue, alpha, and depth. Storage format @code{GL_RGB},
+for example, has three components per pixel: first red, then green, and
+finally blue.
+
+@item @code{GL_UNPACK_SKIP_PIXELS} and @code{GL_UNPACK_SKIP_ROWS}
+These values are provided as a convenience to the programmer; they
+provide no functionality that cannot be duplicated by incrementing the
+pointer passed to @code{glDrawPixels}, @code{glTexImage1D},
+@code{glTexImage2D}, @code{glTexSubImage1D}, @code{glTexSubImage2D},
+@code{glBitmap}, or @code{glPolygonStipple}. Setting
+@code{GL_UNPACK_SKIP_PIXELS} to @math{@var{i}} is equivalent to
+incrementing the pointer by @math{@var{i}@var{n}} components or
+indices, where @math{@var{n}} is the number of components or indices in
+each pixel. Setting @code{GL_UNPACK_SKIP_ROWS} to @math{@var{j}} is
+equivalent to incrementing the pointer by @math{@var{j}@var{k}}
+components or indices, where @math{@var{k}} is the number of components
+or indices per row, as just computed in the @code{GL_UNPACK_ROW_LENGTH}
+section.
+
+@item @code{GL_UNPACK_ALIGNMENT}
+Specifies the alignment requirements for the start of each pixel row in
+memory. The allowable values are 1 (byte-alignment), 2 (rows aligned to
+even-numbered bytes), 4 (word-alignment), and 8 (rows start on
+double-word boundaries).
+
+@end table
+
+The following table gives the type, initial value, and range of valid
+values for each storage parameter that can be set with
+@code{glPixelStore}.
+
+
+
+@table @asis
+@item @strong{@var{pname}}
+@strong{Type}, @strong{Initial Value}, @strong{Valid Range}
+
+@item @code{GL_PACK_SWAP_BYTES}
+boolean , false , true or false
+
+@item @code{GL_PACK_LSB_FIRST}
+boolean , false , true or false
+
+@item @code{GL_PACK_ROW_LENGTH}
+integer , 0 , @math{[0,∞)}
+
+@item @code{GL_PACK_IMAGE_HEIGHT}
+integer , 0 , @math{[0,∞)}
+
+@item @code{GL_PACK_SKIP_ROWS}
+integer , 0 , @math{[0,∞)}
+
+@item @code{GL_PACK_SKIP_PIXELS}
+integer , 0 , @math{[0,∞)}
+
+@item @code{GL_PACK_SKIP_IMAGES}
+integer , 0 , @math{[0,∞)}
+
+@item @code{GL_PACK_ALIGNMENT}
+integer , 4 , 1, 2, 4, or 8
+
+@item @code{GL_UNPACK_SWAP_BYTES}
+boolean , false , true or false
+
+@item @code{GL_UNPACK_LSB_FIRST}
+boolean , false , true or false
+
+@item @code{GL_UNPACK_ROW_LENGTH}
+integer , 0 , @math{[0,∞)}
+
+@item @code{GL_UNPACK_IMAGE_HEIGHT}
+integer , 0 , @math{[0,∞)}
+
+@item @code{GL_UNPACK_SKIP_ROWS}
+integer , 0 , @math{[0,∞)}
+
+@item @code{GL_UNPACK_SKIP_PIXELS}
+integer , 0 , @math{[0,∞)}
+
+@item @code{GL_UNPACK_SKIP_IMAGES}
+integer , 0 , @math{[0,∞)}
+
+@item @code{GL_UNPACK_ALIGNMENT}
+integer , 4 , 1, 2, 4, or 8
+
+@end table
+
+@code{glPixelStoref} can be used to set any pixel store parameter. If
+the parameter type is boolean, then if @var{param} is 0, the parameter
+is false; otherwise it is set to true. If @var{pname} is a integer type
+parameter, @var{param} is rounded to the nearest integer.
+
+Likewise, @code{glPixelStorei} can also be used to set any of the pixel
+store parameters. Boolean parameters are set to false if @var{param} is
+0 and true otherwise.
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{pname} is not an accepted
+value.
+
+@code{GL_INVALID_VALUE} is generated if a negative row length, pixel
+skip, or row skip value is specified, or if alignment is specified as
+other than 1, 2, 4, or 8.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glPixelStore} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glPixelTransfer
+@heading set pixel transfer modes
+@heading Parameters
+@table @asis
+@item @var{pname}
+Specifies the symbolic name of the pixel transfer parameter to be set.
+Must be one of the following: @code{GL_MAP_COLOR},
+@code{GL_MAP_STENCIL}, @code{GL_INDEX_SHIFT}, @code{GL_INDEX_OFFSET},
+@code{GL_RED_SCALE}, @code{GL_RED_BIAS}, @code{GL_GREEN_SCALE},
+@code{GL_GREEN_BIAS}, @code{GL_BLUE_SCALE}, @code{GL_BLUE_BIAS},
+@code{GL_ALPHA_SCALE}, @code{GL_ALPHA_BIAS}, @code{GL_DEPTH_SCALE}, or
+@code{GL_DEPTH_BIAS}.
+
+Additionally, if the @code{ARB_imaging} extension is supported, the
+following symbolic names are accepted:
+@code{GL_POST_COLOR_MATRIX_RED_SCALE},
+@code{GL_POST_COLOR_MATRIX_GREEN_SCALE},
+@code{GL_POST_COLOR_MATRIX_BLUE_SCALE},
+@code{GL_POST_COLOR_MATRIX_ALPHA_SCALE},
+@code{GL_POST_COLOR_MATRIX_RED_BIAS},
+@code{GL_POST_COLOR_MATRIX_GREEN_BIAS},
+@code{GL_POST_COLOR_MATRIX_BLUE_BIAS},
+@code{GL_POST_COLOR_MATRIX_ALPHA_BIAS},
+@code{GL_POST_CONVOLUTION_RED_SCALE},
+@code{GL_POST_CONVOLUTION_GREEN_SCALE},
+@code{GL_POST_CONVOLUTION_BLUE_SCALE},
+@code{GL_POST_CONVOLUTION_ALPHA_SCALE},
+@code{GL_POST_CONVOLUTION_RED_BIAS},
+@code{GL_POST_CONVOLUTION_GREEN_BIAS},
+@code{GL_POST_CONVOLUTION_BLUE_BIAS}, and
+@code{GL_POST_CONVOLUTION_ALPHA_BIAS}.
+
+@item @var{param}
+Specifies the value that @var{pname} is set to.
+
+@end table
+
+@heading Description
+@code{glPixelTransfer} sets pixel transfer modes that affect the
+operation of subsequent @code{glCopyPixels}, @code{glCopyTexImage1D},
+@code{glCopyTexImage2D}, @code{glCopyTexSubImage1D},
+@code{glCopyTexSubImage2D}, @code{glCopyTexSubImage3D},
+@code{glDrawPixels}, @code{glReadPixels}, @code{glTexImage1D},
+@code{glTexImage2D}, @code{glTexImage3D}, @code{glTexSubImage1D},
+@code{glTexSubImage2D}, and @code{glTexSubImage3D} commands.
+Additionally, if the @code{ARB_imaging} subset is supported, the
+routines @code{glColorTable}, @code{glColorSubTable},
+@code{glConvolutionFilter1D}, @code{glConvolutionFilter2D},
+@code{glHistogram}, @code{glMinmax}, and @code{glSeparableFilter2D} are
+also affected. The algorithms that are specified by pixel transfer modes
+operate on pixels after they are read from the frame buffer
+(@code{glCopyPixels}@code{glCopyTexImage1D}, @code{glCopyTexImage2D},
+@code{glCopyTexSubImage1D}, @code{glCopyTexSubImage2D},
+@code{glCopyTexSubImage3D}, and @code{glReadPixels}), or unpacked from
+client memory (@code{glDrawPixels}, @code{glTexImage1D},
+@code{glTexImage2D}, @code{glTexImage3D}, @code{glTexSubImage1D},
+@code{glTexSubImage2D}, and @code{glTexSubImage3D}). Pixel transfer
+operations happen in the same order, and in the same manner, regardless
+of the command that resulted in the pixel operation. Pixel storage modes
+(see @code{glPixelStore}) control the unpacking of pixels being read
+from client memory and the packing of pixels being written back into
+client memory.
+
+Pixel transfer operations handle four fundamental pixel types:
+@var{color}, @var{color index}, @var{depth}, and @var{stencil}.
+@var{Color} pixels consist of four floating-point values with
+unspecified mantissa and exponent sizes, scaled such that 0 represents
+zero intensity and 1 represents full intensity. @var{Color indices}
+comprise a single fixed-point value, with unspecified precision to the
+right of the binary point. @var{Depth} pixels comprise a single
+floating-point value, with unspecified mantissa and exponent sizes,
+scaled such that 0.0 represents the minimum depth buffer value, and 1.0
+represents the maximum depth buffer value. Finally, @var{stencil} pixels
+comprise a single fixed-point value, with unspecified precision to the
+right of the binary point.
+
+The pixel transfer operations performed on the four basic pixel types
+are as follows:
+
+@table @asis
+@item @var{Color}
+Each of the four color components is multiplied by a scale factor, then
+added to a bias factor. That is, the red component is multiplied by
+@code{GL_RED_SCALE}, then added to @code{GL_RED_BIAS}; the green
+component is multiplied by @code{GL_GREEN_SCALE}, then added to
+@code{GL_GREEN_BIAS}; the blue component is multiplied by
+@code{GL_BLUE_SCALE}, then added to @code{GL_BLUE_BIAS}; and the alpha
+component is multiplied by @code{GL_ALPHA_SCALE}, then added to
+@code{GL_ALPHA_BIAS}. After all four color components are scaled and
+biased, each is clamped to the range @math{[0,1]}. All color, scale, and
+bias values are specified with @code{glPixelTransfer}.
+
+If @code{GL_MAP_COLOR} is true, each color component is scaled by the
+size of the corresponding color-to-color map, then replaced by the
+contents of that map indexed by the scaled component. That is, the red
+component is scaled by @code{GL_PIXEL_MAP_R_TO_R_SIZE}, then replaced by
+the contents of @code{GL_PIXEL_MAP_R_TO_R} indexed by itself. The green
+component is scaled by @code{GL_PIXEL_MAP_G_TO_G_SIZE}, then replaced by
+the contents of @code{GL_PIXEL_MAP_G_TO_G} indexed by itself. The blue
+component is scaled by @code{GL_PIXEL_MAP_B_TO_B_SIZE}, then replaced by
+the contents of @code{GL_PIXEL_MAP_B_TO_B} indexed by itself. And the
+alpha component is scaled by @code{GL_PIXEL_MAP_A_TO_A_SIZE}, then
+replaced by the contents of @code{GL_PIXEL_MAP_A_TO_A} indexed by
+itself. All components taken from the maps are then clamped to the range
+@math{[0,1]}. @code{GL_MAP_COLOR} is specified with
+@code{glPixelTransfer}. The contents of the various maps are specified
+with @code{glPixelMap}.
+
+If the @code{ARB_imaging} extension is supported, each of the four color
+components may be scaled and biased after transformation by the color
+matrix. That is, the red component is multiplied by
+@code{GL_POST_COLOR_MATRIX_RED_SCALE}, then added to
+@code{GL_POST_COLOR_MATRIX_RED_BIAS}; the green component is multiplied
+by @code{GL_POST_COLOR_MATRIX_GREEN_SCALE}, then added to
+@code{GL_POST_COLOR_MATRIX_GREEN_BIAS}; the blue component is multiplied
+by @code{GL_POST_COLOR_MATRIX_BLUE_SCALE}, then added to
+@code{GL_POST_COLOR_MATRIX_BLUE_BIAS}; and the alpha component is
+multiplied by @code{GL_POST_COLOR_MATRIX_ALPHA_SCALE}, then added to
+@code{GL_POST_COLOR_MATRIX_ALPHA_BIAS}. After all four color components
+are scaled and biased, each is clamped to the range @math{[0,1]}.
+
+Similarly, if the @code{ARB_imaging} extension is supported, each of the
+four color components may be scaled and biased after processing by the
+enabled convolution filter. That is, the red component is multiplied by
+@code{GL_POST_CONVOLUTION_RED_SCALE}, then added to
+@code{GL_POST_CONVOLUTION_RED_BIAS}; the green component is multiplied
+by @code{GL_POST_CONVOLUTION_GREEN_SCALE}, then added to
+@code{GL_POST_CONVOLUTION_GREEN_BIAS}; the blue component is multiplied
+by @code{GL_POST_CONVOLUTION_BLUE_SCALE}, then added to
+@code{GL_POST_CONVOLUTION_BLUE_BIAS}; and the alpha component is
+multiplied by @code{GL_POST_CONVOLUTION_ALPHA_SCALE}, then added to
+@code{GL_POST_CONVOLUTION_ALPHA_BIAS}. After all four color components
+are scaled and biased, each is clamped to the range @math{[0,1]}.
+
+@item @var{Color index}
+Each color index is shifted left by @code{GL_INDEX_SHIFT} bits; any bits
+beyond the number of fraction bits carried by the fixed-point index are
+filled with zeros. If @code{GL_INDEX_SHIFT} is negative, the shift is to
+the right, again zero filled. Then @code{GL_INDEX_OFFSET} is added to
+the index. @code{GL_INDEX_SHIFT} and @code{GL_INDEX_OFFSET} are
+specified with @code{glPixelTransfer}.
+
+From this point, operation diverges depending on the required format of
+the resulting pixels. If the resulting pixels are to be written to a
+color index buffer, or if they are being read back to client memory in
+@code{GL_COLOR_INDEX} format, the pixels continue to be treated as
+indices. If @code{GL_MAP_COLOR} is true, each index is masked by
+@math{2^@var{n}-1}, where @math{@var{n}} is
+@code{GL_PIXEL_MAP_I_TO_I_SIZE}, then replaced by the contents of
+@code{GL_PIXEL_MAP_I_TO_I} indexed by the masked value.
+@code{GL_MAP_COLOR} is specified with @code{glPixelTransfer}. The
+contents of the index map is specified with @code{glPixelMap}.
+
+If the resulting pixels are to be written to an RGBA color buffer, or if
+they are read back to client memory in a format other than
+@code{GL_COLOR_INDEX}, the pixels are converted from indices to colors
+by referencing the four maps @code{GL_PIXEL_MAP_I_TO_R},
+@code{GL_PIXEL_MAP_I_TO_G}, @code{GL_PIXEL_MAP_I_TO_B}, and
+@code{GL_PIXEL_MAP_I_TO_A}. Before being dereferenced, the index is
+masked by @math{2^@var{n}-1}, where @math{@var{n}} is
+@code{GL_PIXEL_MAP_I_TO_R_SIZE} for the red map,
+@code{GL_PIXEL_MAP_I_TO_G_SIZE} for the green map,
+@code{GL_PIXEL_MAP_I_TO_B_SIZE} for the blue map, and
+@code{GL_PIXEL_MAP_I_TO_A_SIZE} for the alpha map. All components taken
+from the maps are then clamped to the range @math{[0,1]}. The contents
+of the four maps is specified with @code{glPixelMap}.
+
+@item @var{Depth}
+Each depth value is multiplied by @code{GL_DEPTH_SCALE}, added to
+@code{GL_DEPTH_BIAS}, then clamped to the range @math{[0,1]}.
+
+@item @var{Stencil}
+Each index is shifted @code{GL_INDEX_SHIFT} bits just as a color index
+is, then added to @code{GL_INDEX_OFFSET}. If @code{GL_MAP_STENCIL} is
+true, each index is masked by @math{2^@var{n}-1}, where @math{@var{n}}
+is @code{GL_PIXEL_MAP_S_TO_S_SIZE}, then replaced by the contents of
+@code{GL_PIXEL_MAP_S_TO_S} indexed by the masked value.
+
+@end table
+
+The following table gives the type, initial value, and range of valid
+values for each of the pixel transfer parameters that are set with
+@code{glPixelTransfer}.
+
+
+
+@table @asis
+@item @strong{@var{pname}}
+@strong{Type}, @strong{Initial Value}, @strong{Valid Range}
+
+@item @code{GL_MAP_COLOR}
+boolean , false , true/false
+
+@item @code{GL_MAP_STENCIL}
+boolean , false , true/false
+
+@item @code{GL_INDEX_SHIFT}
+integer , 0 , @math{(-∞,∞)}
+
+@item @code{GL_INDEX_OFFSET}
+integer , 0 , @math{(-∞,∞)}
+
+@item @code{GL_RED_SCALE}
+float , 1 , @math{(-∞,∞)}
+
+@item @code{GL_GREEN_SCALE}
+float , 1 , @math{(-∞,∞)}
+
+@item @code{GL_BLUE_SCALE}
+float , 1 , @math{(-∞,∞)}
+
+@item @code{GL_ALPHA_SCALE}
+float , 1 , @math{(-∞,∞)}
+
+@item @code{GL_DEPTH_SCALE}
+float , 1 , @math{(-∞,∞)}
+
+@item @code{GL_RED_BIAS}
+float , 0 , @math{(-∞,∞)}
+
+@item @code{GL_GREEN_BIAS}
+float , 0 , @math{(-∞,∞)}
+
+@item @code{GL_BLUE_BIAS}
+float , 0 , @math{(-∞,∞)}
+
+@item @code{GL_ALPHA_BIAS}
+float , 0 , @math{(-∞,∞)}
+
+@item @code{GL_DEPTH_BIAS}
+float , 0 , @math{(-∞,∞)}
+
+@item @code{GL_POST_COLOR_MATRIX_RED_SCALE}
+float , 1 , @math{(-∞,∞)}
+
+@item @code{GL_POST_COLOR_MATRIX_GREEN_SCALE}
+float , 1 , @math{(-∞,∞)}
+
+@item @code{GL_POST_COLOR_MATRIX_BLUE_SCALE}
+float , 1 , @math{(-∞,∞)}
+
+@item @code{GL_POST_COLOR_MATRIX_ALPHA_SCALE}
+float , 1 , @math{(-∞,∞)}
+
+@item @code{GL_POST_COLOR_MATRIX_RED_BIAS}
+float , 0 , @math{(-∞,∞)}
+
+@item @code{GL_POST_COLOR_MATRIX_GREEN_BIAS}
+float , 0 , @math{(-∞,∞)}
+
+@item @code{GL_POST_COLOR_MATRIX_BLUE_BIAS}
+float , 0 , @math{(-∞,∞)}
+
+@item @code{GL_POST_COLOR_MATRIX_ALPHA_BIAS}
+float , 0 , @math{(-∞,∞)}
+
+@item @code{GL_POST_CONVOLUTION_RED_SCALE}
+float , 1 , @math{(-∞,∞)}
+
+@item @code{GL_POST_CONVOLUTION_GREEN_SCALE}
+float , 1 , @math{(-∞,∞)}
+
+@item @code{GL_POST_CONVOLUTION_BLUE_SCALE}
+float , 1 , @math{(-∞,∞)}
+
+@item @code{GL_POST_CONVOLUTION_ALPHA_SCALE}
+float , 1 , @math{(-∞,∞)}
+
+@item @code{GL_POST_CONVOLUTION_RED_BIAS}
+float , 0 , @math{(-∞,∞)}
+
+@item @code{GL_POST_CONVOLUTION_GREEN_BIAS}
+float , 0 , @math{(-∞,∞)}
+
+@item @code{GL_POST_CONVOLUTION_BLUE_BIAS}
+float , 0 , @math{(-∞,∞)}
+
+@item @code{GL_POST_CONVOLUTION_ALPHA_BIAS}
+float , 0 , @math{(-∞,∞)}
+
+@end table
+
+@code{glPixelTransferf} can be used to set any pixel transfer parameter.
+If the parameter type is boolean, 0 implies false and any other value
+implies true. If @var{pname} is an integer parameter, @var{param} is
+rounded to the nearest integer.
+
+Likewise, @code{glPixelTransferi} can be used to set any of the pixel
+transfer parameters. Boolean parameters are set to false if @var{param}
+is 0 and to true otherwise. @var{param} is converted to floating point
+before being assigned to real-valued parameters.
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{pname} is not an accepted
+value.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glPixelTransfer} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glPixelZoom
+@heading specify the pixel zoom factors
+@heading Parameters
+@table @asis
+@item @var{xfactor}
+@itemx @var{yfactor}
+Specify the @math{@var{x}} and @math{@var{y}} zoom factors for pixel
+write operations.
+
+@end table
+
+@heading Description
+@code{glPixelZoom} specifies values for the @math{@var{x}} and
+@math{@var{y}} zoom factors. During the execution of @code{glDrawPixels}
+or @code{glCopyPixels}, if (@math{@var{xr}}, @math{@var{yr}}) is the
+current raster position, and a given element is in the @math{@var{m}}th
+row and @math{@var{n}}th column of the pixel rectangle, then pixels
+whose centers are in the rectangle with corners at
+
+(@math{@var{xr}+@var{n}·@var{xfactor}},
+@math{@var{yr}+@var{m}·@var{yfactor}})
+
+(@math{@var{xr}+(@var{n}+1,)·@var{xfactor}},
+@math{@var{yr}+(@var{m}+1,)·@var{yfactor}})
+
+are candidates for replacement. Any pixel whose center lies on the
+bottom or left edge of this rectangular region is also modified.
+
+Pixel zoom factors are not limited to positive values. Negative zoom
+factors reflect the resulting image about the current raster position.
+
+@heading Errors
+@code{GL_INVALID_OPERATION} is generated if @code{glPixelZoom} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glPointParameter
+@heading specify point parameters
+@heading Parameters
+@table @asis
+@item @var{pname}
+Specifies a single-valued point parameter. @code{GL_POINT_SIZE_MIN},
+@code{GL_POINT_SIZE_MAX}, @code{GL_POINT_FADE_THRESHOLD_SIZE}, and
+@code{GL_POINT_SPRITE_COORD_ORIGIN} are accepted.
+
+@item @var{param}
+Specifies the value that @var{pname} will be set to.
+
+@end table
+
+@heading Description
+The following values are accepted for @var{pname}:
+
+@table @asis
+@item @code{GL_POINT_SIZE_MIN}
+
+
+@var{params} is a single floating-point value that specifies the minimum
+point size. The default value is 0.0.
+
+@item @code{GL_POINT_SIZE_MAX}
+
+
+@var{params} is a single floating-point value that specifies the maximum
+point size. The default value is 1.0.
+
+@item @code{GL_POINT_FADE_THRESHOLD_SIZE}
+
+
+@var{params} is a single floating-point value that specifies the
+threshold value to which point sizes are clamped if they exceed the
+specified value. The default value is 1.0.
+
+@item @code{GL_POINT_DISTANCE_ATTENUATION}
+
+
+@var{params} is an array of three floating-point values that specify the
+coefficients used for scaling the computed point size. The default
+values are @math{(1,00)}.
+
+@item @code{GL_POINT_SPRITE_COORD_ORIGIN}
+
+
+@var{params} is a single enum specifying the point sprite texture
+coordinate origin, either @code{GL_LOWER_LEFT} or @code{GL_UPPER_LEFT}.
+The default value is @code{GL_UPPER_LEFT}.
+
+@end table
+
+@heading Errors
+@code{GL_INVALID_VALUE} is generated If the value specified for
+@code{GL_POINT_SIZE_MIN}, @code{GL_POINT_SIZE_MAX}, or
+@code{GL_POINT_FADE_THRESHOLD_SIZE} is less than zero.
+
+@code{GL_INVALID_ENUM} is generated If the value specified for
+@code{GL_POINT_SPRITE_COORD_ORIGIN} is not @code{GL_LOWER_LEFT} or
+@code{GL_UPPER_LEFT}.
+
+If the value for @code{GL_POINT_SIZE_MIN} is greater than
+@code{GL_POINT_SIZE_MAX}, the point size after clamping is undefined,
+but no error is generated.
+
+
+
+@end defun
+
+@defun glPointSize
+@heading specify the diameter of rasterized points
+@heading Parameters
+@table @asis
+@item @var{size}
+Specifies the diameter of rasterized points. The initial value is 1.
+
+@end table
+
+@heading Description
+@code{glPointSize} specifies the rasterized diameter of both aliased and
+antialiased points. Using a point size other than 1 has different
+effects, depending on whether point antialiasing is enabled. To enable
+and disable point antialiasing, call @code{glEnable} and
+@code{glDisable} with argument @code{GL_POINT_SMOOTH}. Point
+antialiasing is initially disabled.
+
+The specified point size is multiplied with a distance attenuation
+factor and clamped to the specified point size range, and further
+clamped to the implementation-dependent point size range to produce the
+derived point size using
+
+@math{@var{pointSize}=@var{clamp}(@var{size}×√(1/@var{a}+@var{b}×@var{d}+@var{c}×@var{d}^2,,,),,)}
+
+where @math{@var{d}} is the eye-coordinate distance from the eye to the
+vertex, and @math{@var{a}}, @math{@var{b}}, and @math{@var{c}} are the
+distance attenuation coefficients (see @code{glPointParameter}).
+
+If multisampling is disabled, the computed point size is used as the
+point's width.
+
+If multisampling is enabled, the point may be faded by modifying the
+point alpha value (see @code{glSampleCoverage}) instead of allowing the
+point width to go below a given threshold (see @code{glPointParameter}).
+In this case, the width is further modified in the following manner:
+
+@math{@var{pointWidth}=@{(@var{pointSize}),
+(@var{threshold})(@var{pointSize}>=@var{threshold}),
+(@var{otherwise}),}
+
+The point alpha value is modified by computing:
+
+@math{@var{pointAlpha}=@{(1),
+((@var{pointSize}/@var{threshold},)^2)(@var{pointSize}>=@var{threshold}),
+(@var{otherwise}),}
+
+If point antialiasing is disabled, the actual size is determined by
+rounding the supplied size to the nearest integer. (If the rounding
+results in the value 0, it is as if the point size were 1.) If the
+rounded size is odd, then the center point (@math{@var{x}},
+@math{@var{y}}) of the pixel fragment that represents the point is
+computed as
+
+@math{(⌊@var{x}_@var{w},⌋+.5,⌊@var{y}_@var{w},⌋+.5)}
+
+where @math{@var{w}} subscripts indicate window coordinates. All pixels
+that lie within the square grid of the rounded size centered at
+(@math{@var{x}}, @math{@var{y}}) make up the fragment. If the size is
+even, the center point is
+
+@math{(⌊@var{x}_@var{w}+.5,⌋,⌊@var{y}_@var{w}+.5,⌋)}
+
+and the rasterized fragment's centers are the half-integer window
+coordinates within the square of the rounded size centered at
+@math{(@var{x},@var{y})}. All pixel fragments produced in rasterizing a
+nonantialiased point are assigned the same associated data, that of the
+vertex corresponding to the point.
+
+If antialiasing is enabled, then point rasterization produces a fragment
+for each pixel square that intersects the region lying within the circle
+having diameter equal to the current point size and centered at the
+point's @math{(@var{x}_@var{w},@var{y}_@var{w})}. The coverage value for
+each fragment is the window coordinate area of the intersection of the
+circular region with the corresponding pixel square. This value is saved
+and used in the final rasterization step. The data associated with each
+fragment is the data associated with the point being rasterized.
+
+Not all sizes are supported when point antialiasing is enabled. If an
+unsupported size is requested, the nearest supported size is used. Only
+size 1 is guaranteed to be supported; others depend on the
+implementation. To query the range of supported sizes and the size
+difference between supported sizes within the range, call @code{glGet}
+with arguments @code{GL_SMOOTH_POINT_SIZE_RANGE} and
+@code{GL_SMOOTH_POINT_SIZE_GRANULARITY}. For aliased points, query the
+supported ranges and granularity with @code{glGet} with arguments
+@code{GL_ALIASED_POINT_SIZE_RANGE}.
+
+@heading Errors
+@code{GL_INVALID_VALUE} is generated if @var{size} is less than or equal
+to 0.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glPointSize} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glPolygonMode
+@heading select a polygon rasterization mode
+@heading Parameters
+@table @asis
+@item @var{face}
+Specifies the polygons that @var{mode} applies to. Must be
+@code{GL_FRONT} for front-facing polygons, @code{GL_BACK} for
+back-facing polygons, or @code{GL_FRONT_AND_BACK} for front- and
+back-facing polygons.
+
+@item @var{mode}
+Specifies how polygons will be rasterized. Accepted values are
+@code{GL_POINT}, @code{GL_LINE}, and @code{GL_FILL}. The initial value
+is @code{GL_FILL} for both front- and back-facing polygons.
+
+@end table
+
+@heading Description
+@code{glPolygonMode} controls the interpretation of polygons for
+rasterization. @var{face} describes which polygons @var{mode} applies
+to: front-facing polygons (@code{GL_FRONT}), back-facing polygons
+(@code{GL_BACK}), or both (@code{GL_FRONT_AND_BACK}). The polygon mode
+affects only the final rasterization of polygons. In particular, a
+polygon's vertices are lit and the polygon is clipped and possibly
+culled before these modes are applied.
+
+Three modes are defined and can be specified in @var{mode}:
+
+@table @asis
+@item @code{GL_POINT}
+Polygon vertices that are marked as the start of a boundary edge are
+drawn as points. Point attributes such as @code{GL_POINT_SIZE} and
+@code{GL_POINT_SMOOTH} control the rasterization of the points. Polygon
+rasterization attributes other than @code{GL_POLYGON_MODE} have no
+effect.
+
+@item @code{GL_LINE}
+Boundary edges of the polygon are drawn as line segments. They are
+treated as connected line segments for line stippling; the line stipple
+counter and pattern are not reset between segments (see
+@code{glLineStipple}). Line attributes such as @code{GL_LINE_WIDTH} and
+@code{GL_LINE_SMOOTH} control the rasterization of the lines. Polygon
+rasterization attributes other than @code{GL_POLYGON_MODE} have no
+effect.
+
+@item @code{GL_FILL}
+The interior of the polygon is filled. Polygon attributes such as
+@code{GL_POLYGON_STIPPLE} and @code{GL_POLYGON_SMOOTH} control the
+rasterization of the polygon.
+
+@end table
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if either @var{face} or @var{mode}
+is not an accepted value.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glPolygonMode} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glPolygonOffset
+@heading set the scale and units used to calculate depth values
+@heading Parameters
+@table @asis
+@item @var{factor}
+Specifies a scale factor that is used to create a variable depth offset
+for each polygon. The initial value is 0.
+
+@item @var{units}
+Is multiplied by an implementation-specific value to create a constant
+depth offset. The initial value is 0.
+
+@end table
+
+@heading Description
+When @code{GL_POLYGON_OFFSET_FILL}, @code{GL_POLYGON_OFFSET_LINE}, or
+@code{GL_POLYGON_OFFSET_POINT} is enabled, each fragment's @var{depth}
+value will be offset after it is interpolated from the @var{depth}
+values of the appropriate vertices. The value of the offset is
+@math{@var{factor}×@var{DZ}+@var{r}×@var{units}}, where @math{@var{DZ}}
+is a measurement of the change in depth relative to the screen area of
+the polygon, and @math{@var{r}} is the smallest value that is guaranteed
+to produce a resolvable offset for a given implementation. The offset is
+added before the depth test is performed and before the value is written
+into the depth buffer.
+
+@code{glPolygonOffset} is useful for rendering hidden-line images, for
+applying decals to surfaces, and for rendering solids with highlighted
+edges.
+
+@heading Errors
+@code{GL_INVALID_OPERATION} is generated if @code{glPolygonOffset} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glPolygonStipple
+@heading set the polygon stippling pattern
+@heading Parameters
+@table @asis
+@item @var{pattern}
+Specifies a pointer to a @math{32×32} stipple pattern that will be
+unpacked from memory in the same way that @code{glDrawPixels} unpacks
+pixels.
+
+@end table
+
+@heading Description
+Polygon stippling, like line stippling (see @code{glLineStipple}), masks
+out certain fragments produced by rasterization, creating a pattern.
+Stippling is independent of polygon antialiasing.
+
+@var{pattern} is a pointer to a @math{32×32} stipple pattern that is
+stored in memory just like the pixel data supplied to a
+@code{glDrawPixels} call with height and @var{width} both equal to 32, a
+pixel format of @code{GL_COLOR_INDEX}, and data type of
+@code{GL_BITMAP}. That is, the stipple pattern is represented as a
+@math{32×32} array of 1-bit color indices packed in unsigned bytes.
+@code{glPixelStore} parameters like @code{GL_UNPACK_SWAP_BYTES} and
+@code{GL_UNPACK_LSB_FIRST} affect the assembling of the bits into a
+stipple pattern. Pixel transfer operations (shift, offset, pixel map)
+are not applied to the stipple image, however.
+
+If a non-zero named buffer object is bound to the
+@code{GL_PIXEL_UNPACK_BUFFER} target (see @code{glBindBuffer}) while a
+stipple pattern is specified, @var{pattern} is treated as a byte offset
+into the buffer object's data store.
+
+To enable and disable polygon stippling, call @code{glEnable} and
+@code{glDisable} with argument @code{GL_POLYGON_STIPPLE}. Polygon
+stippling is initially disabled. If it's enabled, a rasterized polygon
+fragment with window coordinates @math{@var{x}_@var{w}} and
+@math{@var{y}_@var{w}} is sent to the next stage of the GL if and only
+if the (@math{@var{x}_@var{w}%32})th bit in the
+(@math{@var{y}_@var{w}%32})th row of the stipple pattern is 1 (one).
+When polygon stippling is disabled, it is as if the stipple pattern
+consists of all 1's.
+
+@heading Errors
+@code{GL_INVALID_OPERATION} is generated if a non-zero buffer object
+name is bound to the @code{GL_PIXEL_UNPACK_BUFFER} target and the buffer
+object's data store is currently mapped.
+
+@code{GL_INVALID_OPERATION} is generated if a non-zero buffer object
+name is bound to the @code{GL_PIXEL_UNPACK_BUFFER} target and the data
+would be unpacked from the buffer object such that the memory reads
+required would exceed the data store size.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glPolygonStipple} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glPrioritizeTextures
+@heading set texture residence priority
+@heading Parameters
+@table @asis
+@item @var{n}
+Specifies the number of textures to be prioritized.
+
+@item @var{textures}
+Specifies an array containing the names of the textures to be
+prioritized.
+
+@item @var{priorities}
+Specifies an array containing the texture priorities. A priority given
+in an element of @var{priorities} applies to the texture named by the
+corresponding element of @var{textures}.
+
+@end table
+
+@heading Description
+@code{glPrioritizeTextures} assigns the @var{n} texture priorities given
+in @var{priorities} to the @var{n} textures named in @var{textures}.
+
+The GL establishes a ``working set'' of textures that are resident in
+texture memory. These textures may be bound to a texture target much
+more efficiently than textures that are not resident. By specifying a
+priority for each texture, @code{glPrioritizeTextures} allows
+applications to guide the GL implementation in determining which
+textures should be resident.
+
+The priorities given in @var{priorities} are clamped to the range
+@math{[0,1]} before they are assigned. 0 indicates the lowest priority;
+textures with priority 0 are least likely to be resident. 1 indicates
+the highest priority; textures with priority 1 are most likely to be
+resident. However, textures are not guaranteed to be resident until they
+are used.
+
+@code{glPrioritizeTextures} silently ignores attempts to prioritize
+texture 0 or any texture name that does not correspond to an existing
+texture.
+
+@code{glPrioritizeTextures} does not require that any of the textures
+named by @var{textures} be bound to a texture target.
+@code{glTexParameter} may also be used to set a texture's priority, but
+only if the texture is currently bound. This is the only way to set the
+priority of a default texture.
+
+@heading Errors
+@code{GL_INVALID_VALUE} is generated if @var{n} is negative.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glPrioritizeTextures}
+is executed between the execution of @code{glBegin} and the
+corresponding execution of @code{glEnd}.
+
+@end defun
+
+@defun glPushAttrib
+@heading push and pop the server attribute stack
+@heading Parameters
+@table @asis
+@item @var{mask}
+Specifies a mask that indicates which attributes to save. Values for
+@var{mask} are listed below.
+
+@end table
+
+@heading Description
+@code{glPushAttrib} takes one argument, a mask that indicates which
+groups of state variables to save on the attribute stack. Symbolic
+constants are used to set bits in the mask. @var{mask} is typically
+constructed by specifying the bitwise-or of several of these constants
+together. The special mask @code{GL_ALL_ATTRIB_BITS} can be used to save
+all stackable states.
+
+The symbolic mask constants and their associated GL state are as follows
+(the second column lists which attributes are saved):
+
+
+
+@table @asis
+@item @code{GL_ACCUM_BUFFER_BIT}
+Accumulation buffer clear value
+
+@item @code{GL_COLOR_BUFFER_BIT}
+@code{GL_ALPHA_TEST} enable bit
+
+@item
+Alpha test function and reference value
+
+@item
+@code{GL_BLEND} enable bit
+
+@item
+Blending source and destination functions
+
+@item
+Constant blend color
+
+@item
+Blending equation
+
+@item
+@code{GL_DITHER} enable bit
+
+@item
+@code{GL_DRAW_BUFFER} setting
+
+@item
+@code{GL_COLOR_LOGIC_OP} enable bit
+
+@item
+@code{GL_INDEX_LOGIC_OP} enable bit
+
+@item
+Logic op function
+
+@item
+Color mode and index mode clear values
+
+@item
+Color mode and index mode writemasks
+
+@item @code{GL_CURRENT_BIT}
+Current RGBA color
+
+@item
+Current color index
+
+@item
+Current normal vector
+
+@item
+Current texture coordinates
+
+@item
+Current raster position
+
+@item
+@code{GL_CURRENT_RASTER_POSITION_VALID} flag
+
+@item
+RGBA color associated with current raster position
+
+@item
+Color index associated with current raster position
+
+@item
+Texture coordinates associated with current raster position
+
+@item
+@code{GL_EDGE_FLAG} flag
+
+@item @code{GL_DEPTH_BUFFER_BIT}
+@code{GL_DEPTH_TEST} enable bit
+
+@item
+Depth buffer test function
+
+@item
+Depth buffer clear value
+
+@item
+@code{GL_DEPTH_WRITEMASK} enable bit
+
+@item @code{GL_ENABLE_BIT}
+@code{GL_ALPHA_TEST} flag
+
+@item
+@code{GL_AUTO_NORMAL} flag
+
+@item
+@code{GL_BLEND} flag
+
+@item
+Enable bits for the user-definable clipping planes
+
+@item
+@code{GL_COLOR_MATERIAL}
+
+@item
+@code{GL_CULL_FACE} flag
+
+@item
+@code{GL_DEPTH_TEST} flag
+
+@item
+@code{GL_DITHER} flag
+
+@item
+@code{GL_FOG} flag
+
+@item
+@code{GL_LIGHT}@var{i} where @code{0} <= @var{i} < @code{GL_MAX_LIGHTS}
+
+@item
+@code{GL_LIGHTING} flag
+
+@item
+@code{GL_LINE_SMOOTH} flag
+
+@item
+@code{GL_LINE_STIPPLE} flag
+
+@item
+@code{GL_COLOR_LOGIC_OP} flag
+
+@item
+@code{GL_INDEX_LOGIC_OP} flag
+
+@item
+@code{GL_MAP1_}@var{x} where @var{x} is a map type
+
+@item
+@code{GL_MAP2_}@var{x} where @var{x} is a map type
+
+@item
+@code{GL_MULTISAMPLE} flag
+
+@item
+@code{GL_NORMALIZE} flag
+
+@item
+@code{GL_POINT_SMOOTH} flag
+
+@item
+@code{GL_POLYGON_OFFSET_LINE} flag
+
+@item
+@code{GL_POLYGON_OFFSET_FILL} flag
+
+@item
+@code{GL_POLYGON_OFFSET_POINT} flag
+
+@item
+@code{GL_POLYGON_SMOOTH} flag
+
+@item
+@code{GL_POLYGON_STIPPLE} flag
+
+@item
+@code{GL_SAMPLE_ALPHA_TO_COVERAGE} flag
+
+@item
+@code{GL_SAMPLE_ALPHA_TO_ONE} flag
+
+@item
+@code{GL_SAMPLE_COVERAGE} flag
+
+@item
+@code{GL_SCISSOR_TEST} flag
+
+@item
+@code{GL_STENCIL_TEST} flag
+
+@item
+@code{GL_TEXTURE_1D} flag
+
+@item
+@code{GL_TEXTURE_2D} flag
+
+@item
+@code{GL_TEXTURE_3D} flag
+
+@item
+Flags @code{GL_TEXTURE_GEN_}@var{x} where @var{x} is S, T, R, or Q
+
+@item @code{GL_EVAL_BIT}
+@code{GL_MAP1_}@var{x} enable bits, where @var{x} is a map type
+
+@item
+@code{GL_MAP2_}@var{x} enable bits, where @var{x} is a map type
+
+@item
+1D grid endpoints and divisions
+
+@item
+2D grid endpoints and divisions
+
+@item
+@code{GL_AUTO_NORMAL} enable bit
+
+@item @code{GL_FOG_BIT}
+@code{GL_FOG} enable bit
+
+@item
+Fog color
+
+@item
+Fog density
+
+@item
+Linear fog start
+
+@item
+Linear fog end
+
+@item
+Fog index
+
+@item
+@code{GL_FOG_MODE} value
+
+@item @code{GL_HINT_BIT}
+@code{GL_PERSPECTIVE_CORRECTION_HINT} setting
+
+@item
+@code{GL_POINT_SMOOTH_HINT} setting
+
+@item
+@code{GL_LINE_SMOOTH_HINT} setting
+
+@item
+@code{GL_POLYGON_SMOOTH_HINT} setting
+
+@item
+@code{GL_FOG_HINT} setting
+
+@item
+@code{GL_GENERATE_MIPMAP_HINT} setting
+
+@item
+@code{GL_TEXTURE_COMPRESSION_HINT} setting
+
+@item @code{GL_LIGHTING_BIT}
+@code{GL_COLOR_MATERIAL} enable bit
+
+@item
+@code{GL_COLOR_MATERIAL_FACE} value
+
+@item
+Color material parameters that are tracking the current color
+
+@item
+Ambient scene color
+
+@item
+@code{GL_LIGHT_MODEL_LOCAL_VIEWER} value
+
+@item
+@code{GL_LIGHT_MODEL_TWO_SIDE} setting
+
+@item
+@code{GL_LIGHTING} enable bit
+
+@item
+Enable bit for each light
+
+@item
+Ambient, diffuse, and specular intensity for each light
+
+@item
+Direction, position, exponent, and cutoff angle for each light
+
+@item
+Constant, linear, and quadratic attenuation factors for each light
+
+@item
+Ambient, diffuse, specular, and emissive color for each material
+
+@item
+Ambient, diffuse, and specular color indices for each material
+
+@item
+Specular exponent for each material
+
+@item
+@code{GL_SHADE_MODEL} setting
+
+@item @code{GL_LINE_BIT}
+@code{GL_LINE_SMOOTH} flag
+
+@item
+@code{GL_LINE_STIPPLE} enable bit
+
+@item
+Line stipple pattern and repeat counter
+
+@item
+Line width
+
+@item @code{GL_LIST_BIT}
+@code{GL_LIST_BASE} setting
+
+@item @code{GL_MULTISAMPLE_BIT}
+@code{GL_MULTISAMPLE} flag
+
+@item
+@code{GL_SAMPLE_ALPHA_TO_COVERAGE} flag
+
+@item
+@code{GL_SAMPLE_ALPHA_TO_ONE} flag
+
+@item
+@code{GL_SAMPLE_COVERAGE} flag
+
+@item
+@code{GL_SAMPLE_COVERAGE_VALUE} value
+
+@item
+@code{GL_SAMPLE_COVERAGE_INVERT} value
+
+@item @code{GL_PIXEL_MODE_BIT}
+@code{GL_RED_BIAS} and @code{GL_RED_SCALE} settings
+
+@item
+@code{GL_GREEN_BIAS} and @code{GL_GREEN_SCALE} values
+
+@item
+@code{GL_BLUE_BIAS} and @code{GL_BLUE_SCALE}
+
+@item
+@code{GL_ALPHA_BIAS} and @code{GL_ALPHA_SCALE}
+
+@item
+@code{GL_DEPTH_BIAS} and @code{GL_DEPTH_SCALE}
+
+@item
+@code{GL_INDEX_OFFSET} and @code{GL_INDEX_SHIFT} values
+
+@item
+@code{GL_MAP_COLOR} and @code{GL_MAP_STENCIL} flags
+
+@item
+@code{GL_ZOOM_X} and @code{GL_ZOOM_Y} factors
+
+@item
+@code{GL_READ_BUFFER} setting
+
+@item @code{GL_POINT_BIT}
+@code{GL_POINT_SMOOTH} flag
+
+@item
+Point size
+
+@item @code{GL_POLYGON_BIT}
+@code{GL_CULL_FACE} enable bit
+
+@item
+@code{GL_CULL_FACE_MODE} value
+
+@item
+@code{GL_FRONT_FACE} indicator
+
+@item
+@code{GL_POLYGON_MODE} setting
+
+@item
+@code{GL_POLYGON_SMOOTH} flag
+
+@item
+@code{GL_POLYGON_STIPPLE} enable bit
+
+@item
+@code{GL_POLYGON_OFFSET_FILL} flag
+
+@item
+@code{GL_POLYGON_OFFSET_LINE} flag
+
+@item
+@code{GL_POLYGON_OFFSET_POINT} flag
+
+@item
+@code{GL_POLYGON_OFFSET_FACTOR}
+
+@item
+@code{GL_POLYGON_OFFSET_UNITS}
+
+@item @code{GL_POLYGON_STIPPLE_BIT}
+Polygon stipple image
+
+@item @code{GL_SCISSOR_BIT}
+@code{GL_SCISSOR_TEST} flag
+
+@item
+Scissor box
+
+@item @code{GL_STENCIL_BUFFER_BIT}
+@code{GL_STENCIL_TEST} enable bit
+
+@item
+Stencil function and reference value
+
+@item
+Stencil value mask
+
+@item
+Stencil fail, pass, and depth buffer pass actions
+
+@item
+Stencil buffer clear value
+
+@item
+Stencil buffer writemask
+
+@item @code{GL_TEXTURE_BIT}
+Enable bits for the four texture coordinates
+
+@item
+Border color for each texture image
+
+@item
+Minification function for each texture image
+
+@item
+Magnification function for each texture image
+
+@item
+Texture coordinates and wrap mode for each texture image
+
+@item
+Color and mode for each texture environment
+
+@item
+Enable bits @code{GL_TEXTURE_GEN_}@var{x}, @var{x} is S, T, R, and Q
+
+@item
+@code{GL_TEXTURE_GEN_MODE} setting for S, T, R, and Q
+
+@item
+@code{glTexGen} plane equations for S, T, R, and Q
+
+@item
+Current texture bindings (for example, @code{GL_TEXTURE_BINDING_2D})
+
+@item @code{GL_TRANSFORM_BIT}
+Coefficients of the six clipping planes
+
+@item
+Enable bits for the user-definable clipping planes
+
+@item
+@code{GL_MATRIX_MODE} value
+
+@item
+@code{GL_NORMALIZE} flag
+
+@item
+@code{GL_RESCALE_NORMAL} flag
+
+@item @code{GL_VIEWPORT_BIT}
+Depth range (near and far)
+
+@item
+Viewport origin and extent
+
+@end table
+
+@code{glPopAttrib} restores the values of the state variables saved with
+the last @code{glPushAttrib} command. Those not saved are left
+unchanged.
+
+It is an error to push attributes onto a full stack or to pop attributes
+off an empty stack. In either case, the error flag is set and no other
+change is made to GL state.
+
+Initially, the attribute stack is empty.
+
+@heading Errors
+@code{GL_STACK_OVERFLOW} is generated if @code{glPushAttrib} is called
+while the attribute stack is full.
+
+@code{GL_STACK_UNDERFLOW} is generated if @code{glPopAttrib} is called
+while the attribute stack is empty.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glPushAttrib} or
+@code{glPopAttrib} is executed between the execution of @code{glBegin}
+and the corresponding execution of @code{glEnd}.
+
+@end defun
+
+@defun glPushClientAttrib
+@heading push and pop the client attribute stack
+@heading Parameters
+@table @asis
+@item @var{mask}
+Specifies a mask that indicates which attributes to save. Values for
+@var{mask} are listed below.
+
+@end table
+
+@heading Description
+@code{glPushClientAttrib} takes one argument, a mask that indicates
+which groups of client-state variables to save on the client attribute
+stack. Symbolic constants are used to set bits in the mask. @var{mask}
+is typically constructed by specifying the bitwise-or of several of
+these constants together. The special mask
+@code{GL_CLIENT_ALL_ATTRIB_BITS} can be used to save all stackable
+client state.
+
+The symbolic mask constants and their associated GL client state are as
+follows (the second column lists which attributes are saved):
+
+@code{GL_CLIENT_PIXEL_STORE_BIT} Pixel storage modes
+@code{GL_CLIENT_VERTEX_ARRAY_BIT} Vertex arrays (and enables)
+
+@code{glPopClientAttrib} restores the values of the client-state
+variables saved with the last @code{glPushClientAttrib}. Those not saved
+are left unchanged.
+
+It is an error to push attributes onto a full client attribute stack or
+to pop attributes off an empty stack. In either case, the error flag is
+set, and no other change is made to GL state.
+
+Initially, the client attribute stack is empty.
+
+@heading Errors
+@code{GL_STACK_OVERFLOW} is generated if @code{glPushClientAttrib} is
+called while the attribute stack is full.
+
+@code{GL_STACK_UNDERFLOW} is generated if @code{glPopClientAttrib} is
+called while the attribute stack is empty.
+
+@end defun
+
+@defun glPushMatrix
+@heading push and pop the current matrix stack
+@heading Description
+There is a stack of matrices for each of the matrix modes. In
+@code{GL_MODELVIEW} mode, the stack depth is at least 32. In the other
+modes, @code{GL_COLOR}, @code{GL_PROJECTION}, and @code{GL_TEXTURE}, the
+depth is at least 2. The current matrix in any mode is the matrix on the
+top of the stack for that mode.
+
+@code{glPushMatrix} pushes the current matrix stack down by one,
+duplicating the current matrix. That is, after a @code{glPushMatrix}
+call, the matrix on top of the stack is identical to the one below it.
+
+@code{glPopMatrix} pops the current matrix stack, replacing the current
+matrix with the one below it on the stack.
+
+Initially, each of the stacks contains one matrix, an identity matrix.
+
+It is an error to push a full matrix stack or to pop a matrix stack that
+contains only a single matrix. In either case, the error flag is set and
+no other change is made to GL state.
+
+@heading Errors
+@code{GL_STACK_OVERFLOW} is generated if @code{glPushMatrix} is called
+while the current matrix stack is full.
+
+@code{GL_STACK_UNDERFLOW} is generated if @code{glPopMatrix} is called
+while the current matrix stack contains only a single matrix.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glPushMatrix} or
+@code{glPopMatrix} is executed between the execution of @code{glBegin}
+and the corresponding execution of @code{glEnd}.
+
+@end defun
+
+@defun glPushName
+@heading push and pop the name stack
+@heading Parameters
+@table @asis
+@item @var{name}
+Specifies a name that will be pushed onto the name stack.
+
+@end table
+
+@heading Description
+The name stack is used during selection mode to allow sets of rendering
+commands to be uniquely identified. It consists of an ordered set of
+unsigned integers and is initially empty.
+
+@code{glPushName} causes @var{name} to be pushed onto the name stack.
+@code{glPopName} pops one name off the top of the stack.
+
+The maximum name stack depth is implementation-dependent; call
+@code{GL_MAX_NAME_STACK_DEPTH} to find out the value for a particular
+implementation. It is an error to push a name onto a full stack or to
+pop a name off an empty stack. It is also an error to manipulate the
+name stack between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}. In any of these cases, the error flag is set
+and no other change is made to GL state.
+
+The name stack is always empty while the render mode is not
+@code{GL_SELECT}. Calls to @code{glPushName} or @code{glPopName} while
+the render mode is not @code{GL_SELECT} are ignored.
+
+@heading Errors
+@code{GL_STACK_OVERFLOW} is generated if @code{glPushName} is called
+while the name stack is full.
+
+@code{GL_STACK_UNDERFLOW} is generated if @code{glPopName} is called
+while the name stack is empty.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glPushName} or
+@code{glPopName} is executed between a call to @code{glBegin} and the
+corresponding call to @code{glEnd}.
+
+@end defun
+
+@defun glRasterPos
+@heading specify the raster position for pixel operations
+@heading Parameters
+@table @asis
+@item @var{x}
+@itemx @var{y}
+@itemx @var{z}
+@itemx @var{w}
+Specify the @math{@var{x}}, @math{@var{y}}, @math{@var{z}}, and
+@math{@var{w}} object coordinates (if present) for the raster position.
+
+@end table
+
+@heading Description
+The GL maintains a 3D position in window coordinates. This position,
+called the raster position, is used to position pixel and bitmap write
+operations. It is maintained with subpixel accuracy. See
+@code{glBitmap}, @code{glDrawPixels}, and @code{glCopyPixels}.
+
+The current raster position consists of three window coordinates
+(@math{@var{x}}, @math{@var{y}}, @math{@var{z}}), a clip coordinate
+value (@math{@var{w}}), an eye coordinate distance, a valid bit, and
+associated color data and texture coordinates. The @math{@var{w}}
+coordinate is a clip coordinate, because @math{@var{w}} is not projected
+to window coordinates. @code{glRasterPos4} specifies object coordinates
+@math{@var{x}}, @math{@var{y}}, @math{@var{z}}, and @math{@var{w}}
+explicitly. @code{glRasterPos3} specifies object coordinate
+@math{@var{x}}, @math{@var{y}}, and @math{@var{z}} explicitly, while
+@math{@var{w}} is implicitly set to 1. @code{glRasterPos2} uses the
+argument values for @math{@var{x}} and @math{@var{y}} while implicitly
+setting @math{@var{z}} and @math{@var{w}} to 0 and 1.
+
+The object coordinates presented by @code{glRasterPos} are treated just
+like those of a @code{glVertex} command: They are transformed by the
+current modelview and projection matrices and passed to the clipping
+stage. If the vertex is not culled, then it is projected and scaled to
+window coordinates, which become the new current raster position, and
+the @code{GL_CURRENT_RASTER_POSITION_VALID} flag is set. If the vertex
+@var{is} culled, then the valid bit is cleared and the current raster
+position and associated color and texture coordinates are undefined.
+
+The current raster position also includes some associated color data and
+texture coordinates. If lighting is enabled, then
+@code{GL_CURRENT_RASTER_COLOR} (in RGBA mode) or
+@code{GL_CURRENT_RASTER_INDEX} (in color index mode) is set to the color
+produced by the lighting calculation (see @code{glLight},
+@code{glLightModel}, and @code{glShadeModel}). If lighting is disabled,
+current color (in RGBA mode, state variable @code{GL_CURRENT_COLOR}) or
+color index (in color index mode, state variable
+@code{GL_CURRENT_INDEX}) is used to update the current raster color.
+@code{GL_CURRENT_RASTER_SECONDARY_COLOR} (in RGBA mode) is likewise
+updated.
+
+Likewise, @code{GL_CURRENT_RASTER_TEXTURE_COORDS} is updated as a
+function of @code{GL_CURRENT_TEXTURE_COORDS}, based on the texture
+matrix and the texture generation functions (see @code{glTexGen}).
+Finally, the distance from the origin of the eye coordinate system to
+the vertex as transformed by only the modelview matrix replaces
+@code{GL_CURRENT_RASTER_DISTANCE}.
+
+Initially, the current raster position is (0, 0, 0, 1), the current
+raster distance is 0, the valid bit is set, the associated RGBA color is
+(1, 1, 1, 1), the associated color index is 1, and the associated
+texture coordinates are (0, 0, 0, 1). In RGBA mode,
+@code{GL_CURRENT_RASTER_INDEX} is always 1; in color index mode, the
+current raster RGBA color always maintains its initial value.
+
+@heading Errors
+@code{GL_INVALID_OPERATION} is generated if @code{glRasterPos} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glReadBuffer
+@heading select a color buffer source for pixels
+@heading Parameters
+@table @asis
+@item @var{mode}
+Specifies a color buffer. Accepted values are @code{GL_FRONT_LEFT},
+@code{GL_FRONT_RIGHT}, @code{GL_BACK_LEFT}, @code{GL_BACK_RIGHT},
+@code{GL_FRONT}, @code{GL_BACK}, @code{GL_LEFT}, @code{GL_RIGHT}, and
+@code{GL_AUX}@var{i}, where @var{i} is between 0 and the value of
+@code{GL_AUX_BUFFERS} minus 1.
+
+@end table
+
+@heading Description
+@code{glReadBuffer} specifies a color buffer as the source for
+subsequent @code{glReadPixels}, @code{glCopyTexImage1D},
+@code{glCopyTexImage2D}, @code{glCopyTexSubImage1D},
+@code{glCopyTexSubImage2D}, @code{glCopyTexSubImage3D}, and
+@code{glCopyPixels} commands. @var{mode} accepts one of twelve or more
+predefined values. (@code{GL_AUX0} through @code{GL_AUX3} are always
+defined.) In a fully configured system, @code{GL_FRONT}, @code{GL_LEFT},
+and @code{GL_FRONT_LEFT} all name the front left buffer,
+@code{GL_FRONT_RIGHT} and @code{GL_RIGHT} name the front right buffer,
+and @code{GL_BACK_LEFT} and @code{GL_BACK} name the back left buffer.
+
+Nonstereo double-buffered configurations have only a front left and a
+back left buffer. Single-buffered configurations have a front left and a
+front right buffer if stereo, and only a front left buffer if nonstereo.
+It is an error to specify a nonexistent buffer to @code{glReadBuffer}.
+
+@var{mode} is initially @code{GL_FRONT} in single-buffered
+configurations and @code{GL_BACK} in double-buffered configurations.
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{mode} is not one of the
+twelve (or more) accepted values.
+
+@code{GL_INVALID_OPERATION} is generated if @var{mode} specifies a
+buffer that does not exist.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glReadBuffer} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glReadPixels
+@heading read a block of pixels from the frame buffer
+@heading Parameters
+@table @asis
+@item @var{x}
+@itemx @var{y}
+Specify the window coordinates of the first pixel that is read from the
+frame buffer. This location is the lower left corner of a rectangular
+block of pixels.
+
+@item @var{width}
+@itemx @var{height}
+Specify the dimensions of the pixel rectangle. @var{width} and
+@var{height} of one correspond to a single pixel.
+
+@item @var{format}
+Specifies the format of the pixel data. The following symbolic values
+are accepted: @code{GL_COLOR_INDEX}, @code{GL_STENCIL_INDEX},
+@code{GL_DEPTH_COMPONENT}, @code{GL_RED}, @code{GL_GREEN},
+@code{GL_BLUE}, @code{GL_ALPHA}, @code{GL_RGB}, @code{GL_BGR},
+@code{GL_RGBA}, @code{GL_BGRA}, @code{GL_LUMINANCE}, and
+@code{GL_LUMINANCE_ALPHA}.
+
+@item @var{type}
+Specifies the data type of the pixel data. Must be one of
+@code{GL_UNSIGNED_BYTE}, @code{GL_BYTE}, @code{GL_BITMAP},
+@code{GL_UNSIGNED_SHORT}, @code{GL_SHORT}, @code{GL_UNSIGNED_INT},
+@code{GL_INT}, @code{GL_FLOAT}, @code{GL_UNSIGNED_BYTE_3_3_2},
+@code{GL_UNSIGNED_BYTE_2_3_3_REV}, @code{GL_UNSIGNED_SHORT_5_6_5},
+@code{GL_UNSIGNED_SHORT_5_6_5_REV}, @code{GL_UNSIGNED_SHORT_4_4_4_4},
+@code{GL_UNSIGNED_SHORT_4_4_4_4_REV}, @code{GL_UNSIGNED_SHORT_5_5_5_1},
+@code{GL_UNSIGNED_SHORT_1_5_5_5_REV}, @code{GL_UNSIGNED_INT_8_8_8_8},
+@code{GL_UNSIGNED_INT_8_8_8_8_REV}, @code{GL_UNSIGNED_INT_10_10_10_2},
+or @code{GL_UNSIGNED_INT_2_10_10_10_REV}.
+
+@item @var{data}
+Returns the pixel data.
+
+@end table
+
+@heading Description
+@code{glReadPixels} returns pixel data from the frame buffer, starting
+with the pixel whose lower left corner is at location (@var{x},
+@var{y}), into client memory starting at location @var{data}. Several
+parameters control the processing of the pixel data before it is placed
+into client memory. These parameters are set with three commands:
+@code{glPixelStore}, @code{glPixelTransfer}, and @code{glPixelMap}. This
+reference page describes the effects on @code{glReadPixels} of most, but
+not all of the parameters specified by these three commands.
+
+If a non-zero named buffer object is bound to the
+@code{GL_PIXEL_PACK_BUFFER} target (see @code{glBindBuffer}) while a
+block of pixels is requested, @var{data} is treated as a byte offset
+into the buffer object's data store rather than a pointer to client
+memory.
+
+When the @code{ARB_imaging} extension is supported, the pixel data may
+be processed by additional operations including color table lookup,
+color matrix transformations, convolutions, histograms, and minimum and
+maximum pixel value computations.
+
+@code{glReadPixels} returns values from each pixel with lower left
+corner at @math{(@var{x}+@var{i},@var{y}+@var{j})} for
+@math{0<=@var{i}<@var{width}} and @math{0<=@var{j}<@var{height}}. This
+pixel is said to be the @math{@var{i}}th pixel in the @math{@var{j}}th
+row. Pixels are returned in row order from the lowest to the highest
+row, left to right in each row.
+
+@var{format} specifies the format for the returned pixel values;
+accepted values are:
+
+@table @asis
+@item @code{GL_COLOR_INDEX}
+Color indices are read from the color buffer selected by
+@code{glReadBuffer}. Each index is converted to fixed point, shifted
+left or right depending on the value and sign of @code{GL_INDEX_SHIFT},
+and added to @code{GL_INDEX_OFFSET}. If @code{GL_MAP_COLOR} is
+@code{GL_TRUE}, indices are replaced by their mappings in the table
+@code{GL_PIXEL_MAP_I_TO_I}.
+
+@item @code{GL_STENCIL_INDEX}
+Stencil values are read from the stencil buffer. Each index is converted
+to fixed point, shifted left or right depending on the value and sign of
+@code{GL_INDEX_SHIFT}, and added to @code{GL_INDEX_OFFSET}. If
+@code{GL_MAP_STENCIL} is @code{GL_TRUE}, indices are replaced by their
+mappings in the table @code{GL_PIXEL_MAP_S_TO_S}.
+
+@item @code{GL_DEPTH_COMPONENT}
+Depth values are read from the depth buffer. Each component is converted
+to floating point such that the minimum depth value maps to 0 and the
+maximum value maps to 1. Each component is then multiplied by
+@code{GL_DEPTH_SCALE}, added to @code{GL_DEPTH_BIAS}, and finally
+clamped to the range @math{[0,1]}.
+
+@item @code{GL_RED}
+@item @code{GL_GREEN}
+@item @code{GL_BLUE}
+@item @code{GL_ALPHA}
+@item @code{GL_RGB}
+@item @code{GL_BGR}
+@item @code{GL_RGBA}
+@item @code{GL_BGRA}
+@item @code{GL_LUMINANCE}
+@item @code{GL_LUMINANCE_ALPHA}
+Processing differs depending on whether color buffers store color
+indices or RGBA color components. If color indices are stored, they are
+read from the color buffer selected by @code{glReadBuffer}. Each index
+is converted to fixed point, shifted left or right depending on the
+value and sign of @code{GL_INDEX_SHIFT}, and added to
+@code{GL_INDEX_OFFSET}. Indices are then replaced by the red, green,
+blue, and alpha values obtained by indexing the tables
+@code{GL_PIXEL_MAP_I_TO_R}, @code{GL_PIXEL_MAP_I_TO_G},
+@code{GL_PIXEL_MAP_I_TO_B}, and @code{GL_PIXEL_MAP_I_TO_A}. Each table
+must be of size @math{2^@var{n}}, but @math{@var{n}} may be different
+for different tables. Before an index is used to look up a value in a
+table of size @math{2^@var{n}}, it must be masked against
+@math{2^@var{n}-1}.
+
+If RGBA color components are stored in the color buffers, they are read
+from the color buffer selected by @code{glReadBuffer}. Each color
+component is converted to floating point such that zero intensity maps
+to 0.0 and full intensity maps to 1.0. Each component is then multiplied
+by @code{GL_c_SCALE} and added to @code{GL_c_BIAS}, where @var{c} is
+RED, GREEN, BLUE, or ALPHA. Finally, if @code{GL_MAP_COLOR} is
+@code{GL_TRUE}, each component is clamped to the range @math{[0,1]},
+scaled to the size of its corresponding table, and is then replaced by
+its mapping in the table @code{GL_PIXEL_MAP_c_TO_c}, where @var{c} is R,
+G, B, or A.
+
+Unneeded data is then discarded. For example, @code{GL_RED} discards the
+green, blue, and alpha components, while @code{GL_RGB} discards only the
+alpha component. @code{GL_LUMINANCE} computes a single-component value
+as the sum of the red, green, and blue components, and
+@code{GL_LUMINANCE_ALPHA} does the same, while keeping alpha as a second
+value. The final values are clamped to the range @math{[0,1]}.
+
+@end table
+
+The shift, scale, bias, and lookup factors just described are all
+specified by @code{glPixelTransfer}. The lookup table contents
+themselves are specified by @code{glPixelMap}.
+
+Finally, the indices or components are converted to the proper format,
+as specified by @var{type}. If @var{format} is @code{GL_COLOR_INDEX} or
+@code{GL_STENCIL_INDEX} and @var{type} is not @code{GL_FLOAT}, each
+index is masked with the mask value given in the following table. If
+@var{type} is @code{GL_FLOAT}, then each integer index is converted to
+single-precision floating-point format.
+
+If @var{format} is @code{GL_RED}, @code{GL_GREEN}, @code{GL_BLUE},
+@code{GL_ALPHA}, @code{GL_RGB}, @code{GL_BGR}, @code{GL_RGBA},
+@code{GL_BGRA}, @code{GL_LUMINANCE}, or @code{GL_LUMINANCE_ALPHA} and
+@var{type} is not @code{GL_FLOAT}, each component is multiplied by the
+multiplier shown in the following table. If type is @code{GL_FLOAT},
+then each component is passed as is (or converted to the client's
+single-precision floating-point format if it is different from the one
+used by the GL).
+
+
+
+@table @asis
+@item @var{type}
+@strong{Index Mask}, @strong{Component Conversion}
+
+@item @code{GL_UNSIGNED_BYTE}
+@math{2^8-1}, @math{(2^8-1,)@var{c}}
+
+@item @code{GL_BYTE}
+@math{2^7-1}, @math{(2^8-1,)@var{c}-1,/2}
+
+@item @code{GL_BITMAP}
+@math{1}, @math{1}
+
+@item @code{GL_UNSIGNED_SHORT}
+@math{2^16-1}, @math{(2^16-1,)@var{c}}
+
+@item @code{GL_SHORT}
+@math{2^15-1}, @math{(2^16-1,)@var{c}-1,/2}
+
+@item @code{GL_UNSIGNED_INT}
+@math{2^32-1}, @math{(2^32-1,)@var{c}}
+
+@item @code{GL_INT}
+@math{2^31-1}, @math{(2^32-1,)@var{c}-1,/2}
+
+@item @code{GL_FLOAT}
+none , @math{@var{c}}
+
+@end table
+
+Return values are placed in memory as follows. If @var{format} is
+@code{GL_COLOR_INDEX}, @code{GL_STENCIL_INDEX},
+@code{GL_DEPTH_COMPONENT}, @code{GL_RED}, @code{GL_GREEN},
+@code{GL_BLUE}, @code{GL_ALPHA}, or @code{GL_LUMINANCE}, a single value
+is returned and the data for the @math{@var{i}}th pixel in the
+@math{@var{j}}th row is placed in location
+@math{(@var{j},)@var{width}+@var{i}}. @code{GL_RGB} and @code{GL_BGR}
+return three values, @code{GL_RGBA} and @code{GL_BGRA} return four
+values, and @code{GL_LUMINANCE_ALPHA} returns two values for each pixel,
+with all values corresponding to a single pixel occupying contiguous
+space in @var{data}. Storage parameters set by @code{glPixelStore}, such
+as @code{GL_PACK_LSB_FIRST} and @code{GL_PACK_SWAP_BYTES}, affect the
+way that data is written into memory. See @code{glPixelStore} for a
+description.
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{format} or @var{type} is not
+an accepted value.
+
+@code{GL_INVALID_ENUM} is generated if @var{type} is @code{GL_BITMAP}
+and @var{format} is not @code{GL_COLOR_INDEX} or
+@code{GL_STENCIL_INDEX}.
+
+@code{GL_INVALID_VALUE} is generated if either @var{width} or
+@var{height} is negative.
+
+@code{GL_INVALID_OPERATION} is generated if @var{format} is
+@code{GL_COLOR_INDEX} and the color buffers store RGBA color components.
+
+@code{GL_INVALID_OPERATION} is generated if @var{format} is
+@code{GL_STENCIL_INDEX} and there is no stencil buffer.
+
+@code{GL_INVALID_OPERATION} is generated if @var{format} is
+@code{GL_DEPTH_COMPONENT} and there is no depth buffer.
+
+@code{GL_INVALID_OPERATION} is generated if @var{type} is one of
+@code{GL_UNSIGNED_BYTE_3_3_2}, @code{GL_UNSIGNED_BYTE_2_3_3_REV},
+@code{GL_UNSIGNED_SHORT_5_6_5}, or @code{GL_UNSIGNED_SHORT_5_6_5_REV}
+and @var{format} is not @code{GL_RGB}.
+
+@code{GL_INVALID_OPERATION} is generated if @var{type} is one of
+@code{GL_UNSIGNED_SHORT_4_4_4_4}, @code{GL_UNSIGNED_SHORT_4_4_4_4_REV},
+@code{GL_UNSIGNED_SHORT_5_5_5_1}, @code{GL_UNSIGNED_SHORT_1_5_5_5_REV},
+@code{GL_UNSIGNED_INT_8_8_8_8}, @code{GL_UNSIGNED_INT_8_8_8_8_REV},
+@code{GL_UNSIGNED_INT_10_10_10_2}, or
+@code{GL_UNSIGNED_INT_2_10_10_10_REV} and @var{format} is neither
+@code{GL_RGBA} nor @code{GL_BGRA}.
+
+The formats @code{GL_BGR}, and @code{GL_BGRA} and types
+@code{GL_UNSIGNED_BYTE_3_3_2}, @code{GL_UNSIGNED_BYTE_2_3_3_REV},
+@code{GL_UNSIGNED_SHORT_5_6_5}, @code{GL_UNSIGNED_SHORT_5_6_5_REV},
+@code{GL_UNSIGNED_SHORT_4_4_4_4}, @code{GL_UNSIGNED_SHORT_4_4_4_4_REV},
+@code{GL_UNSIGNED_SHORT_5_5_5_1}, @code{GL_UNSIGNED_SHORT_1_5_5_5_REV},
+@code{GL_UNSIGNED_INT_8_8_8_8}, @code{GL_UNSIGNED_INT_8_8_8_8_REV},
+@code{GL_UNSIGNED_INT_10_10_10_2}, and
+@code{GL_UNSIGNED_INT_2_10_10_10_REV} are available only if the GL
+version is 1.2 or greater.
+
+@code{GL_INVALID_OPERATION} is generated if a non-zero buffer object
+name is bound to the @code{GL_PIXEL_PACK_BUFFER} target and the buffer
+object's data store is currently mapped.
+
+@code{GL_INVALID_OPERATION} is generated if a non-zero buffer object
+name is bound to the @code{GL_PIXEL_PACK_BUFFER} target and the data
+would be packed to the buffer object such that the memory writes
+required would exceed the data store size.
+
+@code{GL_INVALID_OPERATION} is generated if a non-zero buffer object
+name is bound to the @code{GL_PIXEL_PACK_BUFFER} target and @var{data}
+is not evenly divisible into the number of bytes needed to store in
+memory a datum indicated by @var{type}.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glReadPixels} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glRect
+@heading draw a rectangle
+@heading Parameters
+@table @asis
+@item @var{x1}
+@itemx @var{y1}
+Specify one vertex of a rectangle.
+
+@item @var{x2}
+@itemx @var{y2}
+Specify the opposite vertex of the rectangle.
+
+@end table
+
+@heading Description
+@code{glRect} supports efficient specification of rectangles as two
+corner points. Each rectangle command takes four arguments, organized
+either as two consecutive pairs of @math{(@var{x},@var{y})} coordinates
+or as two pointers to arrays, each containing an
+@math{(@var{x},@var{y})} pair. The resulting rectangle is defined in the
+@math{@var{z}=0} plane.
+
+@code{glRect}(@var{x1}, @var{y1}, @var{x2}, @var{y2}) is exactly
+equivalent to the following sequence: Note that if the second vertex is
+above and to the right of the first vertex, the rectangle is constructed
+with a counterclockwise winding.
+
+@example
+
+glBegin(@code{GL_POLYGON});
+glVertex2(@var{x1}, @var{y1});
+glVertex2(@var{x2}, @var{y1});
+glVertex2(@var{x2}, @var{y2});
+glVertex2(@var{x1}, @var{y2});
+glEnd();
+@end example
+
+@heading Errors
+@code{GL_INVALID_OPERATION} is generated if @code{glRect} is executed
+between the execution of @code{glBegin} and the corresponding execution
+of @code{glEnd}.
+
+@end defun
+
+@defun glRenderMode
+@heading set rasterization mode
+@heading Parameters
+@table @asis
+@item @var{mode}
+Specifies the rasterization mode. Three values are accepted:
+@code{GL_RENDER}, @code{GL_SELECT}, and @code{GL_FEEDBACK}. The initial
+value is @code{GL_RENDER}.
+
+@end table
+
+@heading Description
+@code{glRenderMode} sets the rasterization mode. It takes one argument,
+@var{mode}, which can assume one of three predefined values:
+
+@table @asis
+@item @code{GL_RENDER}
+Render mode. Primitives are rasterized, producing pixel fragments, which
+are written into the frame buffer. This is the normal mode and also the
+default mode.
+
+@item @code{GL_SELECT}
+Selection mode. No pixel fragments are produced, and no change to the
+frame buffer contents is made. Instead, a record of the names of
+primitives that would have been drawn if the render mode had been
+@code{GL_RENDER} is returned in a select buffer, which must be created
+(see @code{glSelectBuffer}) before selection mode is entered.
+
+@item @code{GL_FEEDBACK}
+Feedback mode. No pixel fragments are produced, and no change to the
+frame buffer contents is made. Instead, the coordinates and attributes
+of vertices that would have been drawn if the render mode had been
+@code{GL_RENDER} is returned in a feedback buffer, which must be created
+(see @code{glFeedbackBuffer}) before feedback mode is entered.
+
+@end table
+
+The return value of @code{glRenderMode} is determined by the render mode
+at the time @code{glRenderMode} is called, rather than by @var{mode}.
+The values returned for the three render modes are as follows:
+
+@table @asis
+@item @code{GL_RENDER}
+0.
+
+@item @code{GL_SELECT}
+The number of hit records transferred to the select buffer.
+
+@item @code{GL_FEEDBACK}
+The number of values (not vertices) transferred to the feedback buffer.
+
+@end table
+
+See the @code{glSelectBuffer} and @code{glFeedbackBuffer} reference
+pages for more details concerning selection and feedback operation.
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{mode} is not one of the
+three accepted values.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glSelectBuffer} is
+called while the render mode is @code{GL_SELECT}, or if
+@code{glRenderMode} is called with argument @code{GL_SELECT} before
+@code{glSelectBuffer} is called at least once.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glFeedbackBuffer} is
+called while the render mode is @code{GL_FEEDBACK}, or if
+@code{glRenderMode} is called with argument @code{GL_FEEDBACK} before
+@code{glFeedbackBuffer} is called at least once.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glRenderMode} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glResetHistogram
+@heading reset histogram table entries to zero
+@heading Parameters
+@table @asis
+@item @var{target}
+Must be @code{GL_HISTOGRAM}.
+
+@end table
+
+@heading Description
+@code{glResetHistogram} resets all the elements of the current histogram
+table to zero.
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{target} is not
+@code{GL_HISTOGRAM}.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glResetHistogram} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glResetMinmax
+@heading reset minmax table entries to initial values
+@heading Parameters
+@table @asis
+@item @var{target}
+Must be @code{GL_MINMAX}.
+
+@end table
+
+@heading Description
+@code{glResetMinmax} resets the elements of the current minmax table to
+their initial values: the ``maximum'' element receives the minimum
+possible component values, and the ``minimum'' element receives the
+maximum possible component values.
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{target} is not
+@code{GL_MINMAX}.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glResetMinmax} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glRotate
+@heading multiply the current matrix by a rotation matrix
+@heading Parameters
+@table @asis
+@item @var{angle}
+Specifies the angle of rotation, in degrees.
+
+@item @var{x}
+@itemx @var{y}
+@itemx @var{z}
+Specify the @var{x}, @var{y}, and @var{z} coordinates of a vector,
+respectively.
+
+@end table
+
+@heading Description
+@code{glRotate} produces a rotation of @var{angle} degrees around the
+vector @math{(@var{x},@var{y}@var{z})}. The current matrix (see
+@code{glMatrixMode}) is multiplied by a rotation matrix with the product
+replacing the current matrix, as if @code{glMultMatrix} were called with
+the following matrix as its argument:
+
+@math{((@var{x}^2(1-@var{c},)+@var{c}
+@var{x}@var{y}(1-@var{c},)-@var{z}@var{s}
+@var{x}@var{z}(1-@var{c},)+@var{y}@var{s} 0),
+(@var{y}@var{x}(1-@var{c},)+@var{z}@var{s}
+@var{y}^2(1-@var{c},)+@var{c}
+@var{y}@var{z}(1-@var{c},)-@var{x}@var{s} 0),
+(@var{x}@var{z}(1-@var{c},)-@var{y}@var{s}
+@var{y}@var{z}(1-@var{c},)+@var{x}@var{s}
+@var{z}^2(1-@var{c},)+@var{c} 0), (0 0 0 1),)}
+
+
+
+Where @math{@var{c}=@var{cos}(@var{angle},)},
+@math{@var{s}=@var{sin}(@var{angle},)}, and
+@math{∥(@var{x},@var{y}@var{z}),∥=1} (if not, the GL will normalize this
+vector).
+
+
+
+
+
+If the matrix mode is either @code{GL_MODELVIEW} or
+@code{GL_PROJECTION}, all objects drawn after @code{glRotate} is called
+are rotated. Use @code{glPushMatrix} and @code{glPopMatrix} to save and
+restore the unrotated coordinate system.
+
+@heading Errors
+@code{GL_INVALID_OPERATION} is generated if @code{glRotate} is executed
+between the execution of @code{glBegin} and the corresponding execution
+of @code{glEnd}.
+
+@end defun
+
+@defun glSampleCoverage
+@heading specify multisample coverage parameters
+@heading Parameters
+@table @asis
+@item @var{value}
+Specify a single floating-point sample coverage value. The value is
+clamped to the range @math{[0,1]}. The initial value is 1.0.
+
+@item @var{invert}
+Specify a single boolean value representing if the coverage masks should
+be inverted. @code{GL_TRUE} and @code{GL_FALSE} are accepted. The
+initial value is @code{GL_FALSE}.
+
+@end table
+
+@heading Description
+Multisampling samples a pixel multiple times at various
+implementation-dependent subpixel locations to generate antialiasing
+effects. Multisampling transparently antialiases points, lines,
+polygons, bitmaps, and images if it is enabled.
+
+@var{value} is used in constructing a temporary mask used in determining
+which samples will be used in resolving the final fragment color. This
+mask is bitwise-anded with the coverage mask generated from the
+multisampling computation. If the @var{invert} flag is set, the
+temporary mask is inverted (all bits flipped) and then the bitwise-and
+is computed.
+
+If an implementation does not have any multisample buffers available, or
+multisampling is disabled, rasterization occurs with only a single
+sample computing a pixel's final RGB color.
+
+Provided an implementation supports multisample buffers, and
+multisampling is enabled, then a pixel's final color is generated by
+combining several samples per pixel. Each sample contains color, depth,
+and stencil information, allowing those operations to be performed on
+each sample.
+
+@heading Errors
+@code{GL_INVALID_OPERATION} is generated if @code{glSampleCoverage} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glScale
+@heading multiply the current matrix by a general scaling matrix
+@heading Parameters
+@table @asis
+@item @var{x}
+@itemx @var{y}
+@itemx @var{z}
+Specify scale factors along the @var{x}, @var{y}, and @var{z} axes,
+respectively.
+
+@end table
+
+@heading Description
+@code{glScale} produces a nonuniform scaling along the @var{x}, @var{y},
+and @var{z} axes. The three parameters indicate the desired scale factor
+along each of the three axes.
+
+The current matrix (see @code{glMatrixMode}) is multiplied by this scale
+matrix, and the product replaces the current matrix as if
+@code{glMultMatrix} were called with the following matrix as its
+argument:
+
+@math{((@var{x} 0 0 0), (0 @var{y} 0 0), (0 0 @var{z} 0), (0 0 0 1),)}
+
+If the matrix mode is either @code{GL_MODELVIEW} or
+@code{GL_PROJECTION}, all objects drawn after @code{glScale} is called
+are scaled.
+
+Use @code{glPushMatrix} and @code{glPopMatrix} to save and restore the
+unscaled coordinate system.
+
+@heading Errors
+@code{GL_INVALID_OPERATION} is generated if @code{glScale} is executed
+between the execution of @code{glBegin} and the corresponding execution
+of @code{glEnd}.
+
+@end defun
+
+@defun glScissor
+@heading define the scissor box
+@heading Parameters
+@table @asis
+@item @var{x}
+@itemx @var{y}
+Specify the lower left corner of the scissor box. Initially (0, 0).
+
+@item @var{width}
+@itemx @var{height}
+Specify the width and height of the scissor box. When a GL context is
+first attached to a window, @var{width} and @var{height} are set to the
+dimensions of that window.
+
+@end table
+
+@heading Description
+@code{glScissor} defines a rectangle, called the scissor box, in window
+coordinates. The first two arguments, @var{x} and @var{y}, specify the
+lower left corner of the box. @var{width} and @var{height} specify the
+width and height of the box.
+
+To enable and disable the scissor test, call @code{glEnable} and
+@code{glDisable} with argument @code{GL_SCISSOR_TEST}. The test is
+initially disabled. While the test is enabled, only pixels that lie
+within the scissor box can be modified by drawing commands. Window
+coordinates have integer values at the shared corners of frame buffer
+pixels. @code{glScissor(0,0,1,1)} allows modification of only the lower
+left pixel in the window, and @code{glScissor(0,0,0,0)} doesn't allow
+modification of any pixels in the window.
+
+When the scissor test is disabled, it is as though the scissor box
+includes the entire window.
+
+@heading Errors
+@code{GL_INVALID_VALUE} is generated if either @var{width} or
+@var{height} is negative.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glScissor} is executed
+between the execution of @code{glBegin} and the corresponding execution
+of @code{glEnd}.
+
+@end defun
+
+@defun glSecondaryColorPointer
+@heading define an array of secondary colors
+@heading Parameters
+@table @asis
+@item @var{size}
+Specifies the number of components per color. Must be 3.
+
+@item @var{type}
+Specifies the data type of each color component in the array. Symbolic
+constants @code{GL_BYTE}, @code{GL_UNSIGNED_BYTE}, @code{GL_SHORT},
+@code{GL_UNSIGNED_SHORT}, @code{GL_INT}, @code{GL_UNSIGNED_INT},
+@code{GL_FLOAT}, or @code{GL_DOUBLE} are accepted. The initial value is
+@code{GL_FLOAT}.
+
+@item @var{stride}
+Specifies the byte offset between consecutive colors. If @var{stride} is
+0, the colors are understood to be tightly packed in the array. The
+initial value is 0.
+
+@item @var{pointer}
+Specifies a pointer to the first component of the first color element in
+the array. The initial value is 0.
+
+@end table
+
+@heading Description
+@code{glSecondaryColorPointer} specifies the location and data format of
+an array of color components to use when rendering. @var{size} specifies
+the number of components per color, and must be 3. @var{type} specifies
+the data type of each color component, and @var{stride} specifies the
+byte stride from one color to the next, allowing vertices and attributes
+to be packed into a single array or stored in separate arrays.
+
+If a non-zero named buffer object is bound to the @code{GL_ARRAY_BUFFER}
+target (see @code{glBindBuffer}) while a secondary color array is
+specified, @var{pointer} is treated as a byte offset into the buffer
+object's data store. Also, the buffer object binding
+(@code{GL_ARRAY_BUFFER_BINDING}) is saved as secondary color vertex
+array client-side state
+(@code{GL_SECONDARY_COLOR_ARRAY_BUFFER_BINDING}).
+
+When a secondary color array is specified, @var{size}, @var{type},
+@var{stride}, and @var{pointer} are saved as client-side state, in
+addition to the current vertex array buffer object binding.
+
+To enable and disable the secondary color array, call
+@code{glEnableClientState} and @code{glDisableClientState} with the
+argument @code{GL_SECONDARY_COLOR_ARRAY}. If enabled, the secondary
+color array is used when @code{glArrayElement}, @code{glDrawArrays},
+@code{glMultiDrawArrays}, @code{glDrawElements},
+@code{glMultiDrawElements}, or @code{glDrawRangeElements} is called.
+
+@heading Errors
+@code{GL_INVALID_VALUE} is generated if @var{size} is not 3.
+
+@code{GL_INVALID_ENUM} is generated if @var{type} is not an accepted
+value.
+
+@code{GL_INVALID_VALUE} is generated if @var{stride} is negative.
+
+@end defun
+
+@defun glSecondaryColor
+@heading set the current secondary color
+@heading Parameters
+@table @asis
+@item @var{red}
+@itemx @var{green}
+@itemx @var{blue}
+Specify new red, green, and blue values for the current secondary color.
+
+@end table
+
+@heading Description
+The GL stores both a primary four-valued RGBA color and a secondary
+four-valued RGBA color (where alpha is always set to 0.0) that is
+associated with every vertex.
+
+The secondary color is interpolated and applied to each fragment during
+rasterization when @code{GL_COLOR_SUM} is enabled. When lighting is
+enabled, and @code{GL_SEPARATE_SPECULAR_COLOR} is specified, the value
+of the secondary color is assigned the value computed from the specular
+term of the lighting computation. Both the primary and secondary current
+colors are applied to each fragment, regardless of the state of
+@code{GL_COLOR_SUM}, under such conditions. When
+@code{GL_SEPARATE_SPECULAR_COLOR} is specified, the value returned from
+querying the current secondary color is undefined.
+
+@code{glSecondaryColor3b}, @code{glSecondaryColor3s}, and
+@code{glSecondaryColor3i} take three signed byte, short, or long
+integers as arguments. When @strong{v} is appended to the name, the
+color commands can take a pointer to an array of such values.
+
+Color values are stored in floating-point format, with unspecified
+mantissa and exponent sizes. Unsigned integer color components, when
+specified, are linearly mapped to floating-point values such that the
+largest representable value maps to 1.0 (full intensity), and 0 maps to
+0.0 (zero intensity). Signed integer color components, when specified,
+are linearly mapped to floating-point values such that the most positive
+representable value maps to 1.0, and the most negative representable
+value maps to @math{-1.0}. (Note that this mapping does not convert 0
+precisely to 0.0). Floating-point values are mapped directly.
+
+Neither floating-point nor signed integer values are clamped to the
+range @math{[0,1]} before the current color is updated. However, color
+components are clamped to this range before they are interpolated or
+written into a color buffer.
+
+@end defun
+
+@defun glSelectBuffer
+@heading establish a buffer for selection mode values
+@heading Parameters
+@table @asis
+@item @var{size}
+Specifies the size of @var{buffer}.
+
+@item @var{buffer}
+Returns the selection data.
+
+@end table
+
+@heading Description
+@code{glSelectBuffer} has two arguments: @var{buffer} is a pointer to an
+array of unsigned integers, and @var{size} indicates the size of the
+array. @var{buffer} returns values from the name stack (see
+@code{glInitNames}, @code{glLoadName}, @code{glPushName}) when the
+rendering mode is @code{GL_SELECT} (see @code{glRenderMode}).
+@code{glSelectBuffer} must be issued before selection mode is enabled,
+and it must not be issued while the rendering mode is @code{GL_SELECT}.
+
+A programmer can use selection to determine which primitives are drawn
+into some region of a window. The region is defined by the current
+modelview and perspective matrices.
+
+In selection mode, no pixel fragments are produced from rasterization.
+Instead, if a primitive or a raster position intersects the clipping
+volume defined by the viewing frustum and the user-defined clipping
+planes, this primitive causes a selection hit. (With polygons, no hit
+occurs if the polygon is culled.) When a change is made to the name
+stack, or when @code{glRenderMode} is called, a hit record is copied to
+@var{buffer} if any hits have occurred since the last such event (name
+stack change or @code{glRenderMode} call). The hit record consists of
+the number of names in the name stack at the time of the event, followed
+by the minimum and maximum depth values of all vertices that hit since
+the previous event, followed by the name stack contents, bottom name
+first.
+
+Depth values (which are in the range [0,1]) are multiplied by
+@math{2^32-1}, before being placed in the hit record.
+
+An internal index into @var{buffer} is reset to 0 whenever selection
+mode is entered. Each time a hit record is copied into @var{buffer}, the
+index is incremented to point to the cell just past the end of the block
+of names\(emthat is, to the next available cell If the hit record is
+larger than the number of remaining locations in @var{buffer}, as much
+data as can fit is copied, and the overflow flag is set. If the name
+stack is empty when a hit record is copied, that record consists of 0
+followed by the minimum and maximum depth values.
+
+To exit selection mode, call @code{glRenderMode} with an argument other
+than @code{GL_SELECT}. Whenever @code{glRenderMode} is called while the
+render mode is @code{GL_SELECT}, it returns the number of hit records
+copied to @var{buffer}, resets the overflow flag and the selection
+buffer pointer, and initializes the name stack to be empty. If the
+overflow bit was set when @code{glRenderMode} was called, a negative hit
+record count is returned.
+
+@heading Errors
+@code{GL_INVALID_VALUE} is generated if @var{size} is negative.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glSelectBuffer} is
+called while the render mode is @code{GL_SELECT}, or if
+@code{glRenderMode} is called with argument @code{GL_SELECT} before
+@code{glSelectBuffer} is called at least once.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glSelectBuffer} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glSeparableFilter2D
+@heading define a separable two-dimensional convolution filter
+@heading Parameters
+@table @asis
+@item @var{target}
+Must be @code{GL_SEPARABLE_2D}.
+
+@item @var{internalformat}
+The internal format of the convolution filter kernel. The allowable
+values are @code{GL_ALPHA}, @code{GL_ALPHA4}, @code{GL_ALPHA8},
+@code{GL_ALPHA12}, @code{GL_ALPHA16}, @code{GL_LUMINANCE},
+@code{GL_LUMINANCE4}, @code{GL_LUMINANCE8}, @code{GL_LUMINANCE12},
+@code{GL_LUMINANCE16}, @code{GL_LUMINANCE_ALPHA},
+@code{GL_LUMINANCE4_ALPHA4}, @code{GL_LUMINANCE6_ALPHA2},
+@code{GL_LUMINANCE8_ALPHA8}, @code{GL_LUMINANCE12_ALPHA4},
+@code{GL_LUMINANCE12_ALPHA12}, @code{GL_LUMINANCE16_ALPHA16},
+@code{GL_INTENSITY}, @code{GL_INTENSITY4}, @code{GL_INTENSITY8},
+@code{GL_INTENSITY12}, @code{GL_INTENSITY16}, @code{GL_R3_G3_B2},
+@code{GL_RGB}, @code{GL_RGB4}, @code{GL_RGB5}, @code{GL_RGB8},
+@code{GL_RGB10}, @code{GL_RGB12}, @code{GL_RGB16}, @code{GL_RGBA},
+@code{GL_RGBA2}, @code{GL_RGBA4}, @code{GL_RGB5_A1}, @code{GL_RGBA8},
+@code{GL_RGB10_A2}, @code{GL_RGBA12}, or @code{GL_RGBA16}.
+
+@item @var{width}
+The number of elements in the pixel array referenced by @var{row}. (This
+is the width of the separable filter kernel.)
+
+@item @var{height}
+The number of elements in the pixel array referenced by @var{column}.
+(This is the height of the separable filter kernel.)
+
+@item @var{format}
+The format of the pixel data in @var{row} and @var{column}. The
+allowable values are @code{GL_RED}, @code{GL_GREEN}, @code{GL_BLUE},
+@code{GL_ALPHA}, @code{GL_RGB}, @code{GL_BGR}, @code{GL_RGBA},
+@code{GL_BGRA}, @code{GL_INTENSITY}, @code{GL_LUMINANCE}, and
+@code{GL_LUMINANCE_ALPHA}.
+
+@item @var{type}
+The type of the pixel data in @var{row} and @var{column}. Symbolic
+constants @code{GL_UNSIGNED_BYTE}, @code{GL_BYTE}, @code{GL_BITMAP},
+@code{GL_UNSIGNED_SHORT}, @code{GL_SHORT}, @code{GL_UNSIGNED_INT},
+@code{GL_INT}, @code{GL_FLOAT}, @code{GL_UNSIGNED_BYTE_3_3_2},
+@code{GL_UNSIGNED_BYTE_2_3_3_REV}, @code{GL_UNSIGNED_SHORT_5_6_5},
+@code{GL_UNSIGNED_SHORT_5_6_5_REV}, @code{GL_UNSIGNED_SHORT_4_4_4_4},
+@code{GL_UNSIGNED_SHORT_4_4_4_4_REV}, @code{GL_UNSIGNED_SHORT_5_5_5_1},
+@code{GL_UNSIGNED_SHORT_1_5_5_5_REV}, @code{GL_UNSIGNED_INT_8_8_8_8},
+@code{GL_UNSIGNED_INT_8_8_8_8_REV}, @code{GL_UNSIGNED_INT_10_10_10_2},
+and @code{GL_UNSIGNED_INT_2_10_10_10_REV} are accepted.
+
+@item @var{row}
+Pointer to a one-dimensional array of pixel data that is processed to
+build the row filter kernel.
+
+@item @var{column}
+Pointer to a one-dimensional array of pixel data that is processed to
+build the column filter kernel.
+
+@end table
+
+@heading Description
+@code{glSeparableFilter2D} builds a two-dimensional separable
+convolution filter kernel from two arrays of pixels.
+
+The pixel arrays specified by (@var{width}, @var{format}, @var{type},
+@var{row}) and (@var{height}, @var{format}, @var{type}, @var{column})
+are processed just as if they had been passed to @code{glDrawPixels},
+but processing stops after the final expansion to RGBA is completed.
+
+If a non-zero named buffer object is bound to the
+@code{GL_PIXEL_UNPACK_BUFFER} target (see @code{glBindBuffer}) while a
+convolution filter is specified, @var{row} and @var{column} are treated
+as byte offsets into the buffer object's data store.
+
+Next, the R, G, B, and A components of all pixels in both arrays are
+scaled by the four separable 2D @code{GL_CONVOLUTION_FILTER_SCALE}
+parameters and biased by the four separable 2D
+@code{GL_CONVOLUTION_FILTER_BIAS} parameters. (The scale and bias
+parameters are set by @code{glConvolutionParameter} using the
+@code{GL_SEPARABLE_2D} target and the names
+@code{GL_CONVOLUTION_FILTER_SCALE} and
+@code{GL_CONVOLUTION_FILTER_BIAS}. The parameters themselves are vectors
+of four values that are applied to red, green, blue, and alpha, in that
+order.) The R, G, B, and A values are not clamped to [0,1] at any time
+during this process.
+
+Each pixel is then converted to the internal format specified by
+@var{internalformat}. This conversion simply maps the component values
+of the pixel (R, G, B, and A) to the values included in the internal
+format (red, green, blue, alpha, luminance, and intensity). The mapping
+is as follows:
+
+@table @asis
+@item @strong{Internal Format}
+@strong{Red}, @strong{Green}, @strong{Blue}, @strong{Alpha},
+@strong{Luminance}, @strong{Intensity}
+
+@item @code{GL_LUMINANCE}
+, , , , R ,
+
+@item @code{GL_LUMINANCE_ALPHA}
+, , , A , R ,
+
+@item @code{GL_INTENSITY}
+, , , , , R
+
+@item @code{GL_RGB}
+R , G , B , , ,
+
+@item @code{GL_RGBA}
+R , G , B , A , ,
+
+@end table
+
+The red, green, blue, alpha, luminance, and/or intensity components of
+the resulting pixels are stored in floating-point rather than integer
+format. They form two one-dimensional filter kernel images. The row
+image is indexed by coordinate @var{i} starting at zero and increasing
+from left to right. Each location in the row image is derived from
+element @var{i} of @var{row}. The column image is indexed by coordinate
+@var{j} starting at zero and increasing from bottom to top. Each
+location in the column image is derived from element @var{j} of
+@var{column}.
+
+Note that after a convolution is performed, the resulting color
+components are also scaled by their corresponding
+@code{GL_POST_CONVOLUTION_c_SCALE} parameters and biased by their
+corresponding @code{GL_POST_CONVOLUTION_c_BIAS} parameters (where
+@var{c} takes on the values @strong{RED}, @strong{GREEN}, @strong{BLUE},
+and @strong{ALPHA}). These parameters are set by @code{glPixelTransfer}.
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{target} is not
+@code{GL_SEPARABLE_2D}.
+
+@code{GL_INVALID_ENUM} is generated if @var{internalformat} is not one
+of the allowable values.
+
+@code{GL_INVALID_ENUM} is generated if @var{format} is not one of the
+allowable values.
+
+@code{GL_INVALID_ENUM} is generated if @var{type} is not one of the
+allowable values.
+
+@code{GL_INVALID_VALUE} is generated if @var{width} is less than zero or
+greater than the maximum supported value. This value may be queried with
+@code{glGetConvolutionParameter} using target @code{GL_SEPARABLE_2D} and
+name @code{GL_MAX_CONVOLUTION_WIDTH}.
+
+@code{GL_INVALID_VALUE} is generated if @var{height} is less than zero
+or greater than the maximum supported value. This value may be queried
+with @code{glGetConvolutionParameter} using target
+@code{GL_SEPARABLE_2D} and name @code{GL_MAX_CONVOLUTION_HEIGHT}.
+
+@code{GL_INVALID_OPERATION} is generated if @var{height} is one of
+@code{GL_UNSIGNED_BYTE_3_3_2}, @code{GL_UNSIGNED_BYTE_2_3_3_REV},
+@code{GL_UNSIGNED_SHORT_5_6_5}, or @code{GL_UNSIGNED_SHORT_5_6_5_REV}
+and @var{format} is not @code{GL_RGB}.
+
+@code{GL_INVALID_OPERATION} is generated if @var{height} is one of
+@code{GL_UNSIGNED_SHORT_4_4_4_4}, @code{GL_UNSIGNED_SHORT_4_4_4_4_REV},
+@code{GL_UNSIGNED_SHORT_5_5_5_1}, @code{GL_UNSIGNED_SHORT_1_5_5_5_REV},
+@code{GL_UNSIGNED_INT_8_8_8_8}, @code{GL_UNSIGNED_INT_8_8_8_8_REV},
+@code{GL_UNSIGNED_INT_10_10_10_2}, or
+@code{GL_UNSIGNED_INT_2_10_10_10_REV} and @var{format} is neither
+@code{GL_RGBA} nor @code{GL_BGRA}.
+
+@code{GL_INVALID_OPERATION} is generated if a non-zero buffer object
+name is bound to the @code{GL_PIXEL_UNPACK_BUFFER} target and the buffer
+object's data store is currently mapped.
+
+@code{GL_INVALID_OPERATION} is generated if a non-zero buffer object
+name is bound to the @code{GL_PIXEL_UNPACK_BUFFER} target and the data
+would be unpacked from the buffer object such that the memory reads
+required would exceed the data store size.
+
+@code{GL_INVALID_OPERATION} is generated if a non-zero buffer object
+name is bound to the @code{GL_PIXEL_UNPACK_BUFFER} target and @var{row}
+or @var{column} is not evenly divisible into the number of bytes needed
+to store in memory a datum indicated by @var{type}.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glSeparableFilter2D}
+is executed between the execution of @code{glBegin} and the
+corresponding execution of @code{glEnd}.
+
+@end defun
+
+@defun glShadeModel
+@heading select flat or smooth shading
+@heading Parameters
+@table @asis
+@item @var{mode}
+Specifies a symbolic value representing a shading technique. Accepted
+values are @code{GL_FLAT} and @code{GL_SMOOTH}. The initial value is
+@code{GL_SMOOTH}.
+
+@end table
+
+@heading Description
+GL primitives can have either flat or smooth shading. Smooth shading,
+the default, causes the computed colors of vertices to be interpolated
+as the primitive is rasterized, typically assigning different colors to
+each resulting pixel fragment. Flat shading selects the computed color
+of just one vertex and assigns it to all the pixel fragments generated
+by rasterizing a single primitive. In either case, the computed color of
+a vertex is the result of lighting if lighting is enabled, or it is the
+current color at the time the vertex was specified if lighting is
+disabled.
+
+Flat and smooth shading are indistinguishable for points. Starting when
+@code{glBegin} is issued and counting vertices and primitives from 1,
+the GL gives each flat-shaded line segment @math{@var{i}} the computed
+color of vertex @math{@var{i}+1}, its second vertex. Counting similarly
+from 1, the GL gives each flat-shaded polygon the computed color of the
+vertex listed in the following table. This is the last vertex to specify
+the polygon in all cases except single polygons, where the first vertex
+specifies the flat-shaded color.
+
+
+
+@table @asis
+@item @strong{
+Primitive Type of Polygon @math{@var{i}}}
+@strong{Vertex}
+
+@item
+Single polygon
+ (@math{@var{i}==1})
+1
+
+@item
+Triangle strip
+@math{@var{i}+2}
+
+@item
+Triangle fan
+@math{@var{i}+2}
+
+@item
+Independent triangle
+@math{3@var{i}}
+
+@item
+Quad strip
+@math{2@var{i}+2}
+
+@item
+Independent quad
+@math{4@var{i}}
+
+@end table
+
+Flat and smooth shading are specified by @code{glShadeModel} with
+@var{mode} set to @code{GL_FLAT} and @code{GL_SMOOTH}, respectively.
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{mode} is any value other
+than @code{GL_FLAT} or @code{GL_SMOOTH}.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glShadeModel} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glShaderSource
+@heading Replaces the source code in a shader object
+@heading Parameters
+@table @asis
+@item @var{shader}
+Specifies the handle of the shader object whose source code is to be
+replaced.
+
+@item @var{count}
+Specifies the number of elements in the @var{string} and @var{length}
+arrays.
+
+@item @var{string}
+Specifies an array of pointers to strings containing the source code to
+be loaded into the shader.
+
+@item @var{length}
+Specifies an array of string lengths.
+
+@end table
+
+@heading Description
+@code{glShaderSource} sets the source code in @var{shader} to the source
+code in the array of strings specified by @var{string}. Any source code
+previously stored in the shader object is completely replaced. The
+number of strings in the array is specified by @var{count}. If
+@var{length} is @code{NULL}, each string is assumed to be null
+terminated. If @var{length} is a value other than @code{NULL}, it points
+to an array containing a string length for each of the corresponding
+elements of @var{string}. Each element in the @var{length} array may
+contain the length of the corresponding string (the null character is
+not counted as part of the string length) or a value less than 0 to
+indicate that the string is null terminated. The source code strings are
+not scanned or parsed at this time; they are simply copied into the
+specified shader object.
+
+@heading Errors
+@code{GL_INVALID_VALUE} is generated if @var{shader} is not a value
+generated by OpenGL.
+
+@code{GL_INVALID_OPERATION} is generated if @var{shader} is not a shader
+object.
+
+@code{GL_INVALID_VALUE} is generated if @var{count} is less than 0.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glShaderSource} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glStencilFuncSeparate
+@heading set front and/or back function and reference value for stencil testing
+@heading Parameters
+@table @asis
+@item @var{face}
+Specifies whether front and/or back stencil state is updated. Three
+symbolic constants are valid: @code{GL_FRONT}, @code{GL_BACK}, and
+@code{GL_FRONT_AND_BACK}.
+
+@item @var{func}
+Specifies the test function. Eight symbolic constants are valid:
+@code{GL_NEVER}, @code{GL_LESS}, @code{GL_LEQUAL}, @code{GL_GREATER},
+@code{GL_GEQUAL}, @code{GL_EQUAL}, @code{GL_NOTEQUAL}, and
+@code{GL_ALWAYS}. The initial value is @code{GL_ALWAYS}.
+
+@item @var{ref}
+Specifies the reference value for the stencil test. @var{ref} is clamped
+to the range @math{[0,2^@var{n}-1]}, where @math{@var{n}} is the number
+of bitplanes in the stencil buffer. The initial value is 0.
+
+@item @var{mask}
+Specifies a mask that is ANDed with both the reference value and the
+stored stencil value when the test is done. The initial value is all
+1's.
+
+@end table
+
+@heading Description
+Stenciling, like depth-buffering, enables and disables drawing on a
+per-pixel basis. You draw into the stencil planes using GL drawing
+primitives, then render geometry and images, using the stencil planes to
+mask out portions of the screen. Stenciling is typically used in
+multipass rendering algorithms to achieve special effects, such as
+decals, outlining, and constructive solid geometry rendering.
+
+The stencil test conditionally eliminates a pixel based on the outcome
+of a comparison between the reference value and the value in the stencil
+buffer. To enable and disable the test, call @code{glEnable} and
+@code{glDisable} with argument @code{GL_STENCIL_TEST}. To specify
+actions based on the outcome of the stencil test, call
+@code{glStencilOp} or @code{glStencilOpSeparate}.
+
+There can be two separate sets of @var{func}, @var{ref}, and @var{mask}
+parameters; one affects back-facing polygons, and the other affects
+front-facing polygons as well as other non-polygon primitives.
+@code{glStencilFunc} sets both front and back stencil state to the same
+values, as if @code{glStencilFuncSeparate} were called with @var{face}
+set to @code{GL_FRONT_AND_BACK}.
+
+@var{func} is a symbolic constant that determines the stencil comparison
+function. It accepts one of eight values, shown in the following list.
+@var{ref} is an integer reference value that is used in the stencil
+comparison. It is clamped to the range @math{[0,2^@var{n}-1]}, where
+@math{@var{n}} is the number of bitplanes in the stencil buffer.
+@var{mask} is bitwise ANDed with both the reference value and the stored
+stencil value, with the ANDed values participating in the comparison.
+
+If @var{stencil} represents the value stored in the corresponding
+stencil buffer location, the following list shows the effect of each
+comparison function that can be specified by @var{func}. Only if the
+comparison succeeds is the pixel passed through to the next stage in the
+rasterization process (see @code{glStencilOp}). All tests treat
+@var{stencil} values as unsigned integers in the range
+@math{[0,2^@var{n}-1]}, where @math{@var{n}} is the number of bitplanes
+in the stencil buffer.
+
+The following values are accepted by @var{func}:
+
+@table @asis
+@item @code{GL_NEVER}
+Always fails.
+
+@item @code{GL_LESS}
+Passes if ( @var{ref} & @var{mask} ) < ( @var{stencil} & @var{mask} ).
+
+@item @code{GL_LEQUAL}
+Passes if ( @var{ref} & @var{mask} ) <= ( @var{stencil} & @var{mask} ).
+
+@item @code{GL_GREATER}
+Passes if ( @var{ref} & @var{mask} ) > ( @var{stencil} & @var{mask} ).
+
+@item @code{GL_GEQUAL}
+Passes if ( @var{ref} & @var{mask} ) >= ( @var{stencil} & @var{mask} ).
+
+@item @code{GL_EQUAL}
+Passes if ( @var{ref} & @var{mask} ) = ( @var{stencil} & @var{mask} ).
+
+@item @code{GL_NOTEQUAL}
+Passes if ( @var{ref} & @var{mask} ) != ( @var{stencil} & @var{mask} ).
+
+@item @code{GL_ALWAYS}
+Always passes.
+
+@end table
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{func} is not one of the
+eight accepted values.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glStencilFuncSeparate}
+is executed between the execution of @code{glBegin} and the
+corresponding execution of @code{glEnd}.
+
+@end defun
+
+@defun glStencilFunc
+@heading set front and back function and reference value for stencil testing
+@heading Parameters
+@table @asis
+@item @var{func}
+Specifies the test function. Eight symbolic constants are valid:
+@code{GL_NEVER}, @code{GL_LESS}, @code{GL_LEQUAL}, @code{GL_GREATER},
+@code{GL_GEQUAL}, @code{GL_EQUAL}, @code{GL_NOTEQUAL}, and
+@code{GL_ALWAYS}. The initial value is @code{GL_ALWAYS}.
+
+@item @var{ref}
+Specifies the reference value for the stencil test. @var{ref} is clamped
+to the range @math{[0,2^@var{n}-1]}, where @math{@var{n}} is the number
+of bitplanes in the stencil buffer. The initial value is 0.
+
+@item @var{mask}
+Specifies a mask that is ANDed with both the reference value and the
+stored stencil value when the test is done. The initial value is all
+1's.
+
+@end table
+
+@heading Description
+Stenciling, like depth-buffering, enables and disables drawing on a
+per-pixel basis. Stencil planes are first drawn into using GL drawing
+primitives, then geometry and images are rendered using the stencil
+planes to mask out portions of the screen. Stenciling is typically used
+in multipass rendering algorithms to achieve special effects, such as
+decals, outlining, and constructive solid geometry rendering.
+
+The stencil test conditionally eliminates a pixel based on the outcome
+of a comparison between the reference value and the value in the stencil
+buffer. To enable and disable the test, call @code{glEnable} and
+@code{glDisable} with argument @code{GL_STENCIL_TEST}. To specify
+actions based on the outcome of the stencil test, call
+@code{glStencilOp} or @code{glStencilOpSeparate}.
+
+There can be two separate sets of @var{func}, @var{ref}, and @var{mask}
+parameters; one affects back-facing polygons, and the other affects
+front-facing polygons as well as other non-polygon primitives.
+@code{glStencilFunc} sets both front and back stencil state to the same
+values. Use @code{glStencilFuncSeparate} to set front and back stencil
+state to different values.
+
+@var{func} is a symbolic constant that determines the stencil comparison
+function. It accepts one of eight values, shown in the following list.
+@var{ref} is an integer reference value that is used in the stencil
+comparison. It is clamped to the range @math{[0,2^@var{n}-1]}, where
+@math{@var{n}} is the number of bitplanes in the stencil buffer.
+@var{mask} is bitwise ANDed with both the reference value and the stored
+stencil value, with the ANDed values participating in the comparison.
+
+If @var{stencil} represents the value stored in the corresponding
+stencil buffer location, the following list shows the effect of each
+comparison function that can be specified by @var{func}. Only if the
+comparison succeeds is the pixel passed through to the next stage in the
+rasterization process (see @code{glStencilOp}). All tests treat
+@var{stencil} values as unsigned integers in the range
+@math{[0,2^@var{n}-1]}, where @math{@var{n}} is the number of bitplanes
+in the stencil buffer.
+
+The following values are accepted by @var{func}:
+
+@table @asis
+@item @code{GL_NEVER}
+Always fails.
+
+@item @code{GL_LESS}
+Passes if ( @var{ref} & @var{mask} ) < ( @var{stencil} & @var{mask} ).
+
+@item @code{GL_LEQUAL}
+Passes if ( @var{ref} & @var{mask} ) <= ( @var{stencil} & @var{mask} ).
+
+@item @code{GL_GREATER}
+Passes if ( @var{ref} & @var{mask} ) > ( @var{stencil} & @var{mask} ).
+
+@item @code{GL_GEQUAL}
+Passes if ( @var{ref} & @var{mask} ) >= ( @var{stencil} & @var{mask} ).
+
+@item @code{GL_EQUAL}
+Passes if ( @var{ref} & @var{mask} ) = ( @var{stencil} & @var{mask} ).
+
+@item @code{GL_NOTEQUAL}
+Passes if ( @var{ref} & @var{mask} ) != ( @var{stencil} & @var{mask} ).
+
+@item @code{GL_ALWAYS}
+Always passes.
+
+@end table
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{func} is not one of the
+eight accepted values.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glStencilFunc} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glStencilMaskSeparate
+@heading control the front and/or back writing of individual bits in the stencil planes
+@heading Parameters
+@table @asis
+@item @var{face}
+Specifies whether the front and/or back stencil writemask is updated.
+Three symbolic constants are valid: @code{GL_FRONT}, @code{GL_BACK}, and
+@code{GL_FRONT_AND_BACK}.
+
+@item @var{mask}
+Specifies a bit mask to enable and disable writing of individual bits in
+the stencil planes. Initially, the mask is all 1's.
+
+@end table
+
+@heading Description
+@code{glStencilMaskSeparate} controls the writing of individual bits in
+the stencil planes. The least significant @math{@var{n}} bits of
+@var{mask}, where @math{@var{n}} is the number of bits in the stencil
+buffer, specify a mask. Where a 1 appears in the mask, it's possible to
+write to the corresponding bit in the stencil buffer. Where a 0 appears,
+the corresponding bit is write-protected. Initially, all bits are
+enabled for writing.
+
+There can be two separate @var{mask} writemasks; one affects back-facing
+polygons, and the other affects front-facing polygons as well as other
+non-polygon primitives. @code{glStencilMask} sets both front and back
+stencil writemasks to the same values, as if
+@code{glStencilMaskSeparate} were called with @var{face} set to
+@code{GL_FRONT_AND_BACK}.
+
+@heading Errors
+@code{GL_INVALID_OPERATION} is generated if @code{glStencilMaskSeparate}
+is executed between the execution of @code{glBegin} and the
+corresponding execution of @code{glEnd}.
+
+@end defun
+
+@defun glStencilMask
+@heading control the front and back writing of individual bits in the stencil planes
+@heading Parameters
+@table @asis
+@item @var{mask}
+Specifies a bit mask to enable and disable writing of individual bits in
+the stencil planes. Initially, the mask is all 1's.
+
+@end table
+
+@heading Description
+@code{glStencilMask} controls the writing of individual bits in the
+stencil planes. The least significant @math{@var{n}} bits of @var{mask},
+where @math{@var{n}} is the number of bits in the stencil buffer,
+specify a mask. Where a 1 appears in the mask, it's possible to write to
+the corresponding bit in the stencil buffer. Where a 0 appears, the
+corresponding bit is write-protected. Initially, all bits are enabled
+for writing.
+
+There can be two separate @var{mask} writemasks; one affects back-facing
+polygons, and the other affects front-facing polygons as well as other
+non-polygon primitives. @code{glStencilMask} sets both front and back
+stencil writemasks to the same values. Use @code{glStencilMaskSeparate}
+to set front and back stencil writemasks to different values.
+
+@heading Errors
+@code{GL_INVALID_OPERATION} is generated if @code{glStencilMask} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glStencilOpSeparate
+@heading set front and/or back stencil test actions
+@heading Parameters
+@table @asis
+@item @var{face}
+Specifies whether front and/or back stencil state is updated. Three
+symbolic constants are valid: @code{GL_FRONT}, @code{GL_BACK}, and
+@code{GL_FRONT_AND_BACK}.
+
+@item @var{sfail}
+Specifies the action to take when the stencil test fails. Eight symbolic
+constants are accepted: @code{GL_KEEP}, @code{GL_ZERO},
+@code{GL_REPLACE}, @code{GL_INCR}, @code{GL_INCR_WRAP}, @code{GL_DECR},
+@code{GL_DECR_WRAP}, and @code{GL_INVERT}. The initial value is
+@code{GL_KEEP}.
+
+@item @var{dpfail}
+Specifies the stencil action when the stencil test passes, but the depth
+test fails. @var{dpfail} accepts the same symbolic constants as
+@var{sfail}. The initial value is @code{GL_KEEP}.
+
+@item @var{dppass}
+Specifies the stencil action when both the stencil test and the depth
+test pass, or when the stencil test passes and either there is no depth
+buffer or depth testing is not enabled. @var{dppass} accepts the same
+symbolic constants as @var{sfail}. The initial value is @code{GL_KEEP}.
+
+@end table
+
+@heading Description
+Stenciling, like depth-buffering, enables and disables drawing on a
+per-pixel basis. You draw into the stencil planes using GL drawing
+primitives, then render geometry and images, using the stencil planes to
+mask out portions of the screen. Stenciling is typically used in
+multipass rendering algorithms to achieve special effects, such as
+decals, outlining, and constructive solid geometry rendering.
+
+The stencil test conditionally eliminates a pixel based on the outcome
+of a comparison between the value in the stencil buffer and a reference
+value. To enable and disable the test, call @code{glEnable} and
+@code{glDisable} with argument @code{GL_STENCIL_TEST}; to control it,
+call @code{glStencilFunc} or @code{glStencilFuncSeparate}.
+
+There can be two separate sets of @var{sfail}, @var{dpfail}, and
+@var{dppass} parameters; one affects back-facing polygons, and the other
+affects front-facing polygons as well as other non-polygon primitives.
+@code{glStencilOp} sets both front and back stencil state to the same
+values, as if @code{glStencilOpSeparate} were called with @var{face} set
+to @code{GL_FRONT_AND_BACK}.
+
+@code{glStencilOpSeparate} takes three arguments that indicate what
+happens to the stored stencil value while stenciling is enabled. If the
+stencil test fails, no change is made to the pixel's color or depth
+buffers, and @var{sfail} specifies what happens to the stencil buffer
+contents. The following eight actions are possible.
+
+@table @asis
+@item @code{GL_KEEP}
+Keeps the current value.
+
+@item @code{GL_ZERO}
+Sets the stencil buffer value to 0.
+
+@item @code{GL_REPLACE}
+Sets the stencil buffer value to @var{ref}, as specified by
+@code{glStencilFunc}.
+
+@item @code{GL_INCR}
+Increments the current stencil buffer value. Clamps to the maximum
+representable unsigned value.
+
+@item @code{GL_INCR_WRAP}
+Increments the current stencil buffer value. Wraps stencil buffer value
+to zero when incrementing the maximum representable unsigned value.
+
+@item @code{GL_DECR}
+Decrements the current stencil buffer value. Clamps to 0.
+
+@item @code{GL_DECR_WRAP}
+Decrements the current stencil buffer value. Wraps stencil buffer value
+to the maximum representable unsigned value when decrementing a stencil
+buffer value of zero.
+
+@item @code{GL_INVERT}
+Bitwise inverts the current stencil buffer value.
+
+@end table
+
+Stencil buffer values are treated as unsigned integers. When incremented
+and decremented, values are clamped to 0 and @math{2^@var{n}-1}, where
+@math{@var{n}} is the value returned by querying @code{GL_STENCIL_BITS}.
+
+The other two arguments to @code{glStencilOpSeparate} specify stencil
+buffer actions that depend on whether subsequent depth buffer tests
+succeed (@var{dppass}) or fail (@var{dpfail}) (see @code{glDepthFunc}).
+The actions are specified using the same eight symbolic constants as
+@var{sfail}. Note that @var{dpfail} is ignored when there is no depth
+buffer, or when the depth buffer is not enabled. In these cases,
+@var{sfail} and @var{dppass} specify stencil action when the stencil
+test fails and passes, respectively.
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{face} is any value other
+than @code{GL_FRONT}, @code{GL_BACK}, or @code{GL_FRONT_AND_BACK}.
+
+@code{GL_INVALID_ENUM} is generated if @var{sfail}, @var{dpfail}, or
+@var{dppass} is any value other than the eight defined constant values.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glStencilOpSeparate}
+is executed between the execution of @code{glBegin} and the
+corresponding execution of @code{glEnd}.
+
+@end defun
+
+@defun glStencilOp
+@heading set front and back stencil test actions
+@heading Parameters
+@table @asis
+@item @var{sfail}
+Specifies the action to take when the stencil test fails. Eight symbolic
+constants are accepted: @code{GL_KEEP}, @code{GL_ZERO},
+@code{GL_REPLACE}, @code{GL_INCR}, @code{GL_INCR_WRAP}, @code{GL_DECR},
+@code{GL_DECR_WRAP}, and @code{GL_INVERT}. The initial value is
+@code{GL_KEEP}.
+
+@item @var{dpfail}
+Specifies the stencil action when the stencil test passes, but the depth
+test fails. @var{dpfail} accepts the same symbolic constants as
+@var{sfail}. The initial value is @code{GL_KEEP}.
+
+@item @var{dppass}
+Specifies the stencil action when both the stencil test and the depth
+test pass, or when the stencil test passes and either there is no depth
+buffer or depth testing is not enabled. @var{dppass} accepts the same
+symbolic constants as @var{sfail}. The initial value is @code{GL_KEEP}.
+
+@end table
+
+@heading Description
+Stenciling, like depth-buffering, enables and disables drawing on a
+per-pixel basis. You draw into the stencil planes using GL drawing
+primitives, then render geometry and images, using the stencil planes to
+mask out portions of the screen. Stenciling is typically used in
+multipass rendering algorithms to achieve special effects, such as
+decals, outlining, and constructive solid geometry rendering.
+
+The stencil test conditionally eliminates a pixel based on the outcome
+of a comparison between the value in the stencil buffer and a reference
+value. To enable and disable the test, call @code{glEnable} and
+@code{glDisable} with argument @code{GL_STENCIL_TEST}; to control it,
+call @code{glStencilFunc} or @code{glStencilFuncSeparate}.
+
+There can be two separate sets of @var{sfail}, @var{dpfail}, and
+@var{dppass} parameters; one affects back-facing polygons, and the other
+affects front-facing polygons as well as other non-polygon primitives.
+@code{glStencilOp} sets both front and back stencil state to the same
+values. Use @code{glStencilOpSeparate} to set front and back stencil
+state to different values.
+
+@code{glStencilOp} takes three arguments that indicate what happens to
+the stored stencil value while stenciling is enabled. If the stencil
+test fails, no change is made to the pixel's color or depth buffers, and
+@var{sfail} specifies what happens to the stencil buffer contents. The
+following eight actions are possible.
+
+@table @asis
+@item @code{GL_KEEP}
+Keeps the current value.
+
+@item @code{GL_ZERO}
+Sets the stencil buffer value to 0.
+
+@item @code{GL_REPLACE}
+Sets the stencil buffer value to @var{ref}, as specified by
+@code{glStencilFunc}.
+
+@item @code{GL_INCR}
+Increments the current stencil buffer value. Clamps to the maximum
+representable unsigned value.
+
+@item @code{GL_INCR_WRAP}
+Increments the current stencil buffer value. Wraps stencil buffer value
+to zero when incrementing the maximum representable unsigned value.
+
+@item @code{GL_DECR}
+Decrements the current stencil buffer value. Clamps to 0.
+
+@item @code{GL_DECR_WRAP}
+Decrements the current stencil buffer value. Wraps stencil buffer value
+to the maximum representable unsigned value when decrementing a stencil
+buffer value of zero.
+
+@item @code{GL_INVERT}
+Bitwise inverts the current stencil buffer value.
+
+@end table
+
+Stencil buffer values are treated as unsigned integers. When incremented
+and decremented, values are clamped to 0 and @math{2^@var{n}-1}, where
+@math{@var{n}} is the value returned by querying @code{GL_STENCIL_BITS}.
+
+The other two arguments to @code{glStencilOp} specify stencil buffer
+actions that depend on whether subsequent depth buffer tests succeed
+(@var{dppass}) or fail (@var{dpfail}) (see @code{glDepthFunc}). The
+actions are specified using the same eight symbolic constants as
+@var{sfail}. Note that @var{dpfail} is ignored when there is no depth
+buffer, or when the depth buffer is not enabled. In these cases,
+@var{sfail} and @var{dppass} specify stencil action when the stencil
+test fails and passes, respectively.
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{sfail}, @var{dpfail}, or
+@var{dppass} is any value other than the eight defined constant values.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glStencilOp} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glTexCoordPointer
+@heading define an array of texture coordinates
+@heading Parameters
+@table @asis
+@item @var{size}
+Specifies the number of coordinates per array element. Must be 1, 2, 3,
+or 4. The initial value is 4.
+
+@item @var{type}
+Specifies the data type of each texture coordinate. Symbolic constants
+@code{GL_SHORT}, @code{GL_INT}, @code{GL_FLOAT}, or @code{GL_DOUBLE} are
+accepted. The initial value is @code{GL_FLOAT}.
+
+@item @var{stride}
+Specifies the byte offset between consecutive texture coordinate sets.
+If @var{stride} is 0, the array elements are understood to be tightly
+packed. The initial value is 0.
+
+@item @var{pointer}
+Specifies a pointer to the first coordinate of the first texture
+coordinate set in the array. The initial value is 0.
+
+@end table
+
+@heading Description
+@code{glTexCoordPointer} specifies the location and data format of an
+array of texture coordinates to use when rendering. @var{size} specifies
+the number of coordinates per texture coordinate set, and must be 1, 2,
+3, or 4. @var{type} specifies the data type of each texture coordinate,
+and @var{stride} specifies the byte stride from one texture coordinate
+set to the next, allowing vertices and attributes to be packed into a
+single array or stored in separate arrays. (Single-array storage may be
+more efficient on some implementations; see @code{glInterleavedArrays}.)
+
+If a non-zero named buffer object is bound to the @code{GL_ARRAY_BUFFER}
+target (see @code{glBindBuffer}) while a texture coordinate array is
+specified, @var{pointer} is treated as a byte offset into the buffer
+object's data store. Also, the buffer object binding
+(@code{GL_ARRAY_BUFFER_BINDING}) is saved as texture coordinate vertex
+array client-side state (@code{GL_TEXTURE_COORD_ARRAY_BUFFER_BINDING}).
+
+When a texture coordinate array is specified, @var{size}, @var{type},
+@var{stride}, and @var{pointer} are saved as client-side state, in
+addition to the current vertex array buffer object binding.
+
+To enable and disable a texture coordinate array, call
+@code{glEnableClientState} and @code{glDisableClientState} with the
+argument @code{GL_TEXTURE_COORD_ARRAY}. If enabled, the texture
+coordinate array is used when @code{glArrayElement},
+@code{glDrawArrays}, @code{glMultiDrawArrays}, @code{glDrawElements},
+@code{glMultiDrawElements}, or @code{glDrawRangeElements} is called.
+
+@heading Errors
+@code{GL_INVALID_VALUE} is generated if @var{size} is not 1, 2, 3, or 4.
+
+@code{GL_INVALID_ENUM} is generated if @var{type} is not an accepted
+value.
+
+@code{GL_INVALID_VALUE} is generated if @var{stride} is negative.
+
+@end defun
+
+@defun glTexCoord
+@heading set the current texture coordinates
+@heading Parameters
+@table @asis
+@item @var{s}
+@itemx @var{t}
+@itemx @var{r}
+@itemx @var{q}
+Specify @var{s}, @var{t}, @var{r}, and @var{q} texture coordinates. Not
+all parameters are present in all forms of the command.
+
+@end table
+
+@heading Description
+@code{glTexCoord} specifies texture coordinates in one, two, three, or
+four dimensions. @code{glTexCoord1} sets the current texture coordinates
+to @math{(@var{s},001)}; a call to @code{glTexCoord2} sets them to
+@math{(@var{s},@var{t}01)}. Similarly, @code{glTexCoord3} specifies the
+texture coordinates as @math{(@var{s},@var{t}@var{r}1)}, and
+@code{glTexCoord4} defines all four components explicitly as
+@math{(@var{s},@var{t}@var{r}@var{q})}.
+
+The current texture coordinates are part of the data that is associated
+with each vertex and with the current raster position. Initially, the
+values for @var{s}, @var{t}, @var{r}, and @var{q} are (0, 0, 0, 1).
+
+
+
+@end defun
+
+@defun glTexEnv
+@heading set texture environment parameters
+@heading Parameters
+@table @asis
+@item @var{target}
+Specifies a texture environment. May be @code{GL_TEXTURE_ENV},
+@code{GL_TEXTURE_FILTER_CONTROL} or @code{GL_POINT_SPRITE}.
+
+@item @var{pname}
+Specifies the symbolic name of a single-valued texture environment
+parameter. May be either @code{GL_TEXTURE_ENV_MODE},
+@code{GL_TEXTURE_LOD_BIAS}, @code{GL_COMBINE_RGB},
+@code{GL_COMBINE_ALPHA}, @code{GL_SRC0_RGB}, @code{GL_SRC1_RGB},
+@code{GL_SRC2_RGB}, @code{GL_SRC0_ALPHA}, @code{GL_SRC1_ALPHA},
+@code{GL_SRC2_ALPHA}, @code{GL_OPERAND0_RGB}, @code{GL_OPERAND1_RGB},
+@code{GL_OPERAND2_RGB}, @code{GL_OPERAND0_ALPHA},
+@code{GL_OPERAND1_ALPHA}, @code{GL_OPERAND2_ALPHA}, @code{GL_RGB_SCALE},
+@code{GL_ALPHA_SCALE}, or @code{GL_COORD_REPLACE}.
+
+@item @var{param}
+Specifies a single symbolic constant, one of @code{GL_ADD},
+@code{GL_ADD_SIGNED}, @code{GL_INTERPOLATE}, @code{GL_MODULATE},
+@code{GL_DECAL}, @code{GL_BLEND}, @code{GL_REPLACE}, @code{GL_SUBTRACT},
+@code{GL_COMBINE}, @code{GL_TEXTURE}, @code{GL_CONSTANT},
+@code{GL_PRIMARY_COLOR}, @code{GL_PREVIOUS}, @code{GL_SRC_COLOR},
+@code{GL_ONE_MINUS_SRC_COLOR}, @code{GL_SRC_ALPHA},
+@code{GL_ONE_MINUS_SRC_ALPHA}, a single boolean value for the point
+sprite texture coordinate replacement, a single floating-point value for
+the texture level-of-detail bias, or 1.0, 2.0, or 4.0 when specifying
+the @code{GL_RGB_SCALE} or @code{GL_ALPHA_SCALE}.
+
+@end table
+
+@heading Description
+A texture environment specifies how texture values are interpreted when
+a fragment is textured. When @var{target} is
+@code{GL_TEXTURE_FILTER_CONTROL}, @var{pname} must be
+@code{GL_TEXTURE_LOD_BIAS}. When @var{target} is @code{GL_TEXTURE_ENV},
+@var{pname} can be @code{GL_TEXTURE_ENV_MODE},
+@code{GL_TEXTURE_ENV_COLOR}, @code{GL_COMBINE_RGB},
+@code{GL_COMBINE_ALPHA}, @code{GL_RGB_SCALE}, @code{GL_ALPHA_SCALE},
+@code{GL_SRC0_RGB}, @code{GL_SRC1_RGB}, @code{GL_SRC2_RGB},
+@code{GL_SRC0_ALPHA}, @code{GL_SRC1_ALPHA}, or @code{GL_SRC2_ALPHA}.
+
+If @var{pname} is @code{GL_TEXTURE_ENV_MODE}, then @var{params} is (or
+points to) the symbolic name of a texture function. Six texture
+functions may be specified: @code{GL_ADD}, @code{GL_MODULATE},
+@code{GL_DECAL}, @code{GL_BLEND}, @code{GL_REPLACE}, or
+@code{GL_COMBINE}.
+
+The following table shows the correspondence of filtered texture values
+@math{@var{R}_@var{t}}, @math{@var{G}_@var{t}}, @math{@var{B}_@var{t}},
+@math{@var{A}_@var{t}}, @math{@var{L}_@var{t}}, @math{@var{I}_@var{t}}
+to texture source components. @math{@var{C}_@var{s}} and
+@math{@var{A}_@var{s}} are used by the texture functions described
+below.
+
+
+
+@table @asis
+@item
+Texture Base Internal Format
+@math{@code{C}_@var{s}}, @math{@code{A}_@var{s}}
+
+@item @code{GL_ALPHA}
+(0, 0, 0) , @math{@var{A}_@var{t}}
+
+@item @code{GL_LUMINANCE}
+( @math{@var{L}_@var{t}}, @math{@var{L}_@var{t}}, @math{@var{L}_@var{t}}
+) , 1
+
+@item @code{GL_LUMINANCE_ALPHA}
+( @math{@var{L}_@var{t}}, @math{@var{L}_@var{t}}, @math{@var{L}_@var{t}}
+) , @math{@var{A}_@var{t}}
+
+@item @code{GL_INTENSITY}
+( @math{@var{I}_@var{t}}, @math{@var{I}_@var{t}}, @math{@var{I}_@var{t}}
+) , @math{@var{I}_@var{t}}
+
+@item @code{GL_RGB}
+( @math{@var{R}_@var{t}}, @math{@var{G}_@var{t}}, @math{@var{B}_@var{t}}
+) , 1
+
+@item @code{GL_RGBA}
+( @math{@var{R}_@var{t}}, @math{@var{G}_@var{t}}, @math{@var{B}_@var{t}}
+) , @math{@var{A}_@var{t}}
+
+@end table
+
+A texture function acts on the fragment to be textured using the texture
+image value that applies to the fragment (see @code{glTexParameter}) and
+produces an RGBA color for that fragment. The following table shows how
+the RGBA color is produced for each of the first five texture functions
+that can be chosen. @math{@var{C}} is a triple of color values (RGB) and
+@math{@var{A}} is the associated alpha value. RGBA values extracted from
+a texture image are in the range [0,1]. The subscript @math{@var{p}}
+refers to the color computed from the previous texture stage (or the
+incoming fragment if processing texture stage 0), the subscript
+@math{@var{s}} to the texture source color, the subscript @math{@var{c}}
+to the texture environment color, and the subscript @math{@var{v}}
+indicates a value produced by the texture function.
+
+
+
+@table @asis
+@item
+Texture Base Internal Format
+@code{Value}, @code{GL_REPLACE} Function , @code{GL_MODULATE} Function ,
+@code{GL_DECAL} Function , @code{GL_BLEND} Function , @code{GL_ADD}
+Function
+
+@item @code{GL_ALPHA}
+@math{@var{C}_@var{v}=}, @math{@var{C}_@var{p}}, @math{@var{C}_@var{p}},
+undefined , @math{@var{C}_@var{p}}, @math{@var{C}_@var{p}}
+
+@item
+@math{@var{A}_@var{v}=}, @math{@var{A}_@var{s}},
+@math{@var{A}_@var{p}@var{A}_@var{s}}, ,
+@math{@var{A}_@var{v}=@var{A}_@var{p}@var{A}_@var{s}},
+@math{@var{A}_@var{p}@var{A}_@var{s}}
+
+@item @code{GL_LUMINANCE}
+@math{@var{C}_@var{v}=}, @math{@var{C}_@var{s}},
+@math{@var{C}_@var{p}@var{C}_@var{s}}, undefined ,
+@math{@var{C}_@var{p}(1-@var{C}_@var{s},)+@var{C}_@var{c}@var{C}_@var{s}},
+@math{@var{C}_@var{p}+@var{C}_@var{s}}
+
+@item
+(or 1)
+@math{@var{A}_@var{v}=}, @math{@var{A}_@var{p}}, @math{@var{A}_@var{p}},
+, @math{@var{A}_@var{p}}, @math{@var{A}_@var{p}}
+
+@item @code{GL_LUMINANCE_ALPHA}
+@math{@var{C}_@var{v}=}, @math{@var{C}_@var{s}},
+@math{@var{C}_@var{p}@var{C}_@var{s}}, undefined ,
+@math{@var{C}_@var{p}(1-@var{C}_@var{s},)+@var{C}_@var{c}@var{C}_@var{s}},
+@math{@var{C}_@var{p}+@var{C}_@var{s}}
+
+@item
+(or 2)
+@math{@var{A}_@var{v}=}, @math{@var{A}_@var{s}},
+@math{@var{A}_@var{p}@var{A}_@var{s}}, ,
+@math{@var{A}_@var{p}@var{A}_@var{s}},
+@math{@var{A}_@var{p}@var{A}_@var{s}}
+
+@item @code{GL_INTENSITY}
+@math{@var{C}_@var{v}=}, @math{@var{C}_@var{s}},
+@math{@var{C}_@var{p}@var{C}_@var{s}}, undefined ,
+@math{@var{C}_@var{p}(1-@var{C}_@var{s},)+@var{C}_@var{c}@var{C}_@var{s}},
+@math{@var{C}_@var{p}+@var{C}_@var{s}}
+
+@item
+@math{@var{A}_@var{v}=}, @math{@var{A}_@var{s}},
+@math{@var{A}_@var{p}@var{A}_@var{s}}, ,
+@math{@var{A}_@var{p}(1-@var{A}_@var{s},)+@var{A}_@var{c}@var{A}_@var{s}},
+@math{@var{A}_@var{p}+@var{A}_@var{s}}
+
+@item @code{GL_RGB}
+@math{@var{C}_@var{v}=}, @math{@var{C}_@var{s}},
+@math{@var{C}_@var{p}@var{C}_@var{s}}, @math{@var{C}_@var{s}},
+@math{@var{C}_@var{p}(1-@var{C}_@var{s},)+@var{C}_@var{c}@var{C}_@var{s}},
+@math{@var{C}_@var{p}+@var{C}_@var{s}}
+
+@item
+(or 3)
+@math{@var{A}_@var{v}=}, @math{@var{A}_@var{p}}, @math{@var{A}_@var{p}},
+@math{@var{A}_@var{p}}, @math{@var{A}_@var{p}}, @math{@var{A}_@var{p}}
+
+@item @code{GL_RGBA}
+@math{@var{C}_@var{v}=}, @math{@var{C}_@var{s}},
+@math{@var{C}_@var{p}@var{C}_@var{s}},
+@math{@var{C}_@var{p}(1-@var{A}_@var{s},)+@var{C}_@var{s}@var{A}_@var{s}},
+@math{@var{C}_@var{p}(1-@var{C}_@var{s},)+@var{C}_@var{c}@var{C}_@var{s}},
+@math{@var{C}_@var{p}+@var{C}_@var{s}}
+
+@item
+(or 4)
+@math{@var{A}_@var{v}=}, @math{@var{A}_@var{s}},
+@math{@var{A}_@var{p}@var{A}_@var{s}}, @math{@var{A}_@var{p}},
+@math{@var{A}_@var{p}@var{A}_@var{s}},
+@math{@var{A}_@var{p}@var{A}_@var{s}}
+
+@end table
+
+If @var{pname} is @code{GL_TEXTURE_ENV_MODE}, and @var{params} is
+@code{GL_COMBINE}, the form of the texture function depends on the
+values of @code{GL_COMBINE_RGB} and @code{GL_COMBINE_ALPHA}.
+
+The following describes how the texture sources, as specified by
+@code{GL_SRC0_RGB}, @code{GL_SRC1_RGB}, @code{GL_SRC2_RGB},
+@code{GL_SRC0_ALPHA}, @code{GL_SRC1_ALPHA}, and @code{GL_SRC2_ALPHA},
+are combined to produce a final texture color. In the following tables,
+@code{GL_SRC0_c} is represented by @math{@var{Arg0}}, @code{GL_SRC1_c}
+is represented by @math{@var{Arg1}}, and @code{GL_SRC2_c} is represented
+by @math{@var{Arg2}}.
+
+@code{GL_COMBINE_RGB} accepts any of @code{GL_REPLACE},
+@code{GL_MODULATE}, @code{GL_ADD}, @code{GL_ADD_SIGNED},
+@code{GL_INTERPOLATE}, @code{GL_SUBTRACT}, @code{GL_DOT3_RGB}, or
+@code{GL_DOT3_RGBA}.
+
+
+
+@table @asis
+@item @strong{@code{GL_COMBINE_RGB}}
+@strong{Texture Function}
+
+@item @code{GL_REPLACE}
+@math{@var{Arg0}}
+
+@item @code{GL_MODULATE}
+@math{@var{Arg0}×@var{Arg1}}
+
+@item @code{GL_ADD}
+@math{@var{Arg0}+@var{Arg1}}
+
+@item @code{GL_ADD_SIGNED}
+@math{@var{Arg0}+@var{Arg1}-0.5}
+
+@item @code{GL_INTERPOLATE}
+@math{@var{Arg0}×@var{Arg2}+@var{Arg1}×(1-@var{Arg2},)}
+
+@item @code{GL_SUBTRACT}
+@math{@var{Arg0}-@var{Arg1}}
+
+@item @code{GL_DOT3_RGB}
+or @code{GL_DOT3_RGBA}
+@math{4×(((@var{Arg0}_@var{r},-0.5,)×(@var{Arg1}_@var{r},-0.5,),)+((@var{Arg0}_@var{g},-0.5,)×(@var{Arg1}_@var{g},-0.5,),)+((@var{Arg0}_@var{b},-0.5,)×(@var{Arg1}_@var{b},-0.5,),),)}
+
+@end table
+
+The scalar results for @code{GL_DOT3_RGB} and @code{GL_DOT3_RGBA} are
+placed into each of the 3 (RGB) or 4 (RGBA) components on output.
+
+Likewise, @code{GL_COMBINE_ALPHA} accepts any of @code{GL_REPLACE},
+@code{GL_MODULATE}, @code{GL_ADD}, @code{GL_ADD_SIGNED},
+@code{GL_INTERPOLATE}, or @code{GL_SUBTRACT}. The following table
+describes how alpha values are combined:
+
+
+
+@table @asis
+@item @strong{@code{GL_COMBINE_ALPHA}}
+@strong{Texture Function}
+
+@item @code{GL_REPLACE}
+@math{@var{Arg0}}
+
+@item @code{GL_MODULATE}
+@math{@var{Arg0}×@var{Arg1}}
+
+@item @code{GL_ADD}
+@math{@var{Arg0}+@var{Arg1}}
+
+@item @code{GL_ADD_SIGNED}
+@math{@var{Arg0}+@var{Arg1}-0.5}
+
+@item @code{GL_INTERPOLATE}
+@math{@var{Arg0}×@var{Arg2}+@var{Arg1}×(1-@var{Arg2},)}
+
+@item @code{GL_SUBTRACT}
+@math{@var{Arg0}-@var{Arg1}}
+
+@end table
+
+In the following tables, the value @math{@var{C}_@var{s}} represents the
+color sampled from the currently bound texture, @math{@var{C}_@var{c}}
+represents the constant texture-environment color,
+@math{@var{C}_@var{f}} represents the primary color of the incoming
+fragment, and @math{@var{C}_@var{p}} represents the color computed from
+the previous texture stage or @math{@var{C}_@var{f}} if processing
+texture stage 0. Likewise, @math{@var{A}_@var{s}},
+@math{@var{A}_@var{c}}, @math{@var{A}_@var{f}}, and
+@math{@var{A}_@var{p}} represent the respective alpha values.
+
+The following table describes the values assigned to @math{@var{Arg0}},
+@math{@var{Arg1}}, and @math{@var{Arg2}} based upon the RGB sources and
+operands:
+
+
+
+@table @asis
+@item @strong{@code{GL_SRCn_RGB}}
+@strong{@code{GL_OPERANDn_RGB}}, @strong{Argument Value}
+
+@item @code{GL_TEXTURE}
+@code{GL_SRC_COLOR}, @math{@var{C}_@var{s},}
+
+@item
+@code{GL_ONE_MINUS_SRC_COLOR}, @math{1-@var{C}_@var{s},}
+
+@item
+@code{GL_SRC_ALPHA}, @math{@var{A}_@var{s},}
+
+@item
+@code{GL_ONE_MINUS_SRC_ALPHA}, @math{1-@var{A}_@var{s},}
+
+@item @code{GL_TEXTUREn}
+@code{GL_SRC_COLOR}, @math{@var{C}_@var{s},}
+
+@item
+@code{GL_ONE_MINUS_SRC_COLOR}, @math{1-@var{C}_@var{s},}
+
+@item
+@code{GL_SRC_ALPHA}, @math{@var{A}_@var{s},}
+
+@item
+@code{GL_ONE_MINUS_SRC_ALPHA}, @math{1-@var{A}_@var{s},}
+
+@item @code{GL_CONSTANT}
+@code{GL_SRC_COLOR}, @math{@var{C}_@var{c},}
+
+@item
+@code{GL_ONE_MINUS_SRC_COLOR}, @math{1-@var{C}_@var{c},}
+
+@item
+@code{GL_SRC_ALPHA}, @math{@var{A}_@var{c},}
+
+@item
+@code{GL_ONE_MINUS_SRC_ALPHA}, @math{1-@var{A}_@var{c},}
+
+@item @code{GL_PRIMARY_COLOR}
+@code{GL_SRC_COLOR}, @math{@var{C}_@var{f},}
+
+@item
+@code{GL_ONE_MINUS_SRC_COLOR}, @math{1-@var{C}_@var{f},}
+
+@item
+@code{GL_SRC_ALPHA}, @math{@var{A}_@var{f},}
+
+@item
+@code{GL_ONE_MINUS_SRC_ALPHA}, @math{1-@var{A}_@var{f},}
+
+@item @code{GL_PREVIOUS}
+@code{GL_SRC_COLOR}, @math{@var{C}_@var{p},}
+
+@item
+@code{GL_ONE_MINUS_SRC_COLOR}, @math{1-@var{C}_@var{p},}
+
+@item
+@code{GL_SRC_ALPHA}, @math{@var{A}_@var{p},}
+
+@item
+@code{GL_ONE_MINUS_SRC_ALPHA}, @math{1-@var{A}_@var{p},}
+
+@end table
+
+For @code{GL_TEXTUREn} sources, @math{@var{C}_@var{s}} and
+@math{@var{A}_@var{s}} represent the color and alpha, respectively,
+produced from texture stage @math{@var{n}}.
+
+The follow table describes the values assigned to @math{@var{Arg0}},
+@math{@var{Arg1}}, and @math{@var{Arg2}} based upon the alpha sources
+and operands:
+
+
+
+@table @asis
+@item @strong{@code{GL_SRCn_ALPHA}}
+@strong{@code{GL_OPERANDn_ALPHA}}, @strong{Argument Value}
+
+@item @code{GL_TEXTURE}
+@code{GL_SRC_ALPHA}, @math{@var{A}_@var{s},}
+
+@item
+@code{GL_ONE_MINUS_SRC_ALPHA}, @math{1-@var{A}_@var{s},}
+
+@item @code{GL_TEXTUREn}
+@code{GL_SRC_ALPHA}, @math{@var{A}_@var{s},}
+
+@item
+@code{GL_ONE_MINUS_SRC_ALPHA}, @math{1-@var{A}_@var{s},}
+
+@item @code{GL_CONSTANT}
+@code{GL_SRC_ALPHA}, @math{@var{A}_@var{c},}
+
+@item
+@code{GL_ONE_MINUS_SRC_ALPHA}, @math{1-@var{A}_@var{c},}
+
+@item @code{GL_PRIMARY_COLOR}
+@code{GL_SRC_ALPHA}, @math{@var{A}_@var{f},}
+
+@item
+@code{GL_ONE_MINUS_SRC_ALPHA}, @math{1-@var{A}_@var{f},}
+
+@item @code{GL_PREVIOUS}
+@code{GL_SRC_ALPHA}, @math{@var{A}_@var{p},}
+
+@item
+@code{GL_ONE_MINUS_SRC_ALPHA}, @math{1-@var{A}_@var{p},}
+
+@end table
+
+The RGB and alpha results of the texture function are multipled by the
+values of @code{GL_RGB_SCALE} and @code{GL_ALPHA_SCALE}, respectively,
+and clamped to the range @math{[0,1]}.
+
+If @var{pname} is @code{GL_TEXTURE_ENV_COLOR}, @var{params} is a pointer
+to an array that holds an RGBA color consisting of four values. Integer
+color components are interpreted linearly such that the most positive
+integer maps to 1.0, and the most negative integer maps to -1.0. The
+values are clamped to the range [0,1] when they are specified.
+@math{@var{C}_@var{c}} takes these four values.
+
+If @var{pname} is @code{GL_TEXTURE_LOD_BIAS}, the value specified is
+added to the texture level-of-detail parameter, that selects which
+mipmap, or mipmaps depending upon the selected
+@code{GL_TEXTURE_MIN_FILTER}, will be sampled.
+
+@code{GL_TEXTURE_ENV_MODE} defaults to @code{GL_MODULATE} and
+@code{GL_TEXTURE_ENV_COLOR} defaults to (0, 0, 0, 0).
+
+If @var{target} is @code{GL_POINT_SPRITE} and @var{pname} is
+@code{GL_COORD_REPLACE}, the boolean value specified is used to either
+enable or disable point sprite texture coordinate replacement. The
+default value is @code{GL_FALSE}.
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated when @var{target} or @var{pname} is
+not one of the accepted defined values, or when @var{params} should have
+a defined constant value (based on the value of @var{pname}) and does
+not.
+
+@code{GL_INVALID_VALUE} is generated if the @var{params} value for
+@code{GL_RGB_SCALE} or @code{GL_ALPHA_SCALE} are not one of 1.0, 2.0, or
+4.0.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glTexEnv} is executed
+between the execution of @code{glBegin} and the corresponding execution
+of @code{glEnd}.
+
+@end defun
+
+@defun glTexGen
+@heading control the generation of texture coordinates
+@heading Parameters
+@table @asis
+@item @var{coord}
+Specifies a texture coordinate. Must be one of @code{GL_S}, @code{GL_T},
+@code{GL_R}, or @code{GL_Q}.
+
+@item @var{pname}
+Specifies the symbolic name of the texture-coordinate generation
+function. Must be @code{GL_TEXTURE_GEN_MODE}.
+
+@item @var{param}
+Specifies a single-valued texture generation parameter, one of
+@code{GL_OBJECT_LINEAR}, @code{GL_EYE_LINEAR}, @code{GL_SPHERE_MAP},
+@code{GL_NORMAL_MAP}, or @code{GL_REFLECTION_MAP}.
+
+@end table
+
+@heading Description
+@code{glTexGen} selects a texture-coordinate generation function or
+supplies coefficients for one of the functions. @var{coord} names one of
+the (@var{s}, @var{t}, @var{r}, @var{q}) texture coordinates; it must be
+one of the symbols @code{GL_S}, @code{GL_T}, @code{GL_R}, or
+@code{GL_Q}. @var{pname} must be one of three symbolic constants:
+@code{GL_TEXTURE_GEN_MODE}, @code{GL_OBJECT_PLANE}, or
+@code{GL_EYE_PLANE}. If @var{pname} is @code{GL_TEXTURE_GEN_MODE}, then
+@var{params} chooses a mode, one of @code{GL_OBJECT_LINEAR},
+@code{GL_EYE_LINEAR}, @code{GL_SPHERE_MAP}, @code{GL_NORMAL_MAP}, or
+@code{GL_REFLECTION_MAP}. If @var{pname} is either
+@code{GL_OBJECT_PLANE} or @code{GL_EYE_PLANE}, @var{params} contains
+coefficients for the corresponding texture generation function.
+
+If the texture generation function is @code{GL_OBJECT_LINEAR}, the
+function
+
+@math{@var{g}=@var{p}_1×@var{x}_@var{o}+@var{p}_2×@var{y}_@var{o}+@var{p}_3×@var{z}_@var{o}+@var{p}_4×@var{w}_@var{o}}
+
+is used, where @math{@var{g}} is the value computed for the coordinate
+named in @var{coord}, @math{@var{p}_1}, @math{@var{p}_2},
+@math{@var{p}_3}, and @math{@var{p}_4} are the four values supplied in
+@var{params}, and @math{@var{x}_@var{o}}, @math{@var{y}_@var{o}},
+@math{@var{z}_@var{o}}, and @math{@var{w}_@var{o}} are the object
+coordinates of the vertex. This function can be used, for example, to
+texture-map terrain using sea level as a reference plane (defined by
+@math{@var{p}_1}, @math{@var{p}_2}, @math{@var{p}_3}, and
+@math{@var{p}_4}). The altitude of a terrain vertex is computed by the
+@code{GL_OBJECT_LINEAR} coordinate generation function as its distance
+from sea level; that altitude can then be used to index the texture
+image to map white snow onto peaks and green grass onto foothills.
+
+If the texture generation function is @code{GL_EYE_LINEAR}, the function
+
+@math{@var{g}=@var{p}_1,^″×@var{x}_@var{e}+@var{p}_2,^″×@var{y}_@var{e}+@var{p}_3,^″×@var{z}_@var{e}+@var{p}_4,^″×@var{w}_@var{e}}
+
+is used, where
+
+@math{(@var{p}_1,^″@var{p}_2,^″@var{p}_3,^″@var{p}_4,^″,)=(@var{p}_1@var{p}_2@var{p}_3@var{p}_4,)@var{M}^-1}
+
+and @math{@var{x}_@var{e}}, @math{@var{y}_@var{e}},
+@math{@var{z}_@var{e}}, and @math{@var{w}_@var{e}} are the eye
+coordinates of the vertex, @math{@var{p}_1}, @math{@var{p}_2},
+@math{@var{p}_3}, and @math{@var{p}_4} are the values supplied in
+@var{params}, and @math{@var{M}} is the modelview matrix when
+@code{glTexGen} is invoked. If @math{@var{M}} is poorly conditioned or
+singular, texture coordinates generated by the resulting function may be
+inaccurate or undefined.
+
+Note that the values in @var{params} define a reference plane in eye
+coordinates. The modelview matrix that is applied to them may not be the
+same one in effect when the polygon vertices are transformed. This
+function establishes a field of texture coordinates that can produce
+dynamic contour lines on moving objects.
+
+If the texture generation function is @code{GL_SPHERE_MAP} and
+@var{coord} is either @code{GL_S} or @code{GL_T}, @math{@var{s}} and
+@math{@var{t}} texture coordinates are generated as follows. Let @var{u}
+be the unit vector pointing from the origin to the polygon vertex (in
+eye coordinates). Let @var{n} sup prime be the current normal, after
+transformation to eye coordinates. Let
+
+@math{@var{f}=(@var{f}_@var{x}@var{f}_@var{y}@var{f}_@var{z},)^@var{T}}
+be the reflection vector such that
+
+@math{@var{f}=@var{u}-2@var{n}^″@var{n}^″,^@var{T}@var{u}}
+
+Finally, let
+@math{@var{m}=2√(@var{f}_@var{x},^2+@var{f}_@var{y},^2+(@var{f}_@var{z}+1,)^2,)}.
+Then the values assigned to the @math{@var{s}} and @math{@var{t}}
+texture coordinates are
+
+@math{@var{s}=@var{f}_@var{x}/@var{m}+1/2}
+
+@math{@var{t}=@var{f}_@var{y}/@var{m}+1/2}
+
+To enable or disable a texture-coordinate generation function, call
+@code{glEnable} or @code{glDisable} with one of the symbolic
+texture-coordinate names (@code{GL_TEXTURE_GEN_S},
+@code{GL_TEXTURE_GEN_T}, @code{GL_TEXTURE_GEN_R}, or
+@code{GL_TEXTURE_GEN_Q}) as the argument. When enabled, the specified
+texture coordinate is computed according to the generating function
+associated with that coordinate. When disabled, subsequent vertices take
+the specified texture coordinate from the current set of texture
+coordinates. Initially, all texture generation functions are set to
+@code{GL_EYE_LINEAR} and are disabled. Both @math{@var{s}} plane
+equations are (1, 0, 0, 0), both @math{@var{t}} plane equations are (0,
+1, 0, 0), and all @math{@var{r}} and @math{@var{q}} plane equations are
+(0, 0, 0, 0).
+
+When the @code{ARB_multitexture} extension is supported, @code{glTexGen}
+sets the texture generation parameters for the currently active texture
+unit, selected with @code{glActiveTexture}.
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated when @var{coord} or @var{pname} is
+not an accepted defined value, or when @var{pname} is
+@code{GL_TEXTURE_GEN_MODE} and @var{params} is not an accepted defined
+value.
+
+@code{GL_INVALID_ENUM} is generated when @var{pname} is
+@code{GL_TEXTURE_GEN_MODE}, @var{params} is @code{GL_SPHERE_MAP}, and
+@var{coord} is either @code{GL_R} or @code{GL_Q}.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glTexGen} is executed
+between the execution of @code{glBegin} and the corresponding execution
+of @code{glEnd}.
+
+@end defun
+
+@defun glTexImage1D
+@heading specify a one-dimensional texture image
+@heading Parameters
+@table @asis
+@item @var{target}
+Specifies the target texture. Must be @code{GL_TEXTURE_1D} or
+@code{GL_PROXY_TEXTURE_1D}.
+
+@item @var{level}
+Specifies the level-of-detail number. Level 0 is the base image level.
+Level @var{n} is the @var{n}th mipmap reduction image.
+
+@item @var{internalFormat}
+Specifies the number of color components in the texture. Must be 1, 2,
+3, or 4, or one of the following symbolic constants: @code{GL_ALPHA},
+@code{GL_ALPHA4}, @code{GL_ALPHA8}, @code{GL_ALPHA12},
+@code{GL_ALPHA16}, @code{GL_COMPRESSED_ALPHA},
+@code{GL_COMPRESSED_LUMINANCE}, @code{GL_COMPRESSED_LUMINANCE_ALPHA},
+@code{GL_COMPRESSED_INTENSITY}, @code{GL_COMPRESSED_RGB},
+@code{GL_COMPRESSED_RGBA}, @code{GL_DEPTH_COMPONENT},
+@code{GL_DEPTH_COMPONENT16}, @code{GL_DEPTH_COMPONENT24},
+@code{GL_DEPTH_COMPONENT32}, @code{GL_LUMINANCE}, @code{GL_LUMINANCE4},
+@code{GL_LUMINANCE8}, @code{GL_LUMINANCE12}, @code{GL_LUMINANCE16},
+@code{GL_LUMINANCE_ALPHA}, @code{GL_LUMINANCE4_ALPHA4},
+@code{GL_LUMINANCE6_ALPHA2}, @code{GL_LUMINANCE8_ALPHA8},
+@code{GL_LUMINANCE12_ALPHA4}, @code{GL_LUMINANCE12_ALPHA12},
+@code{GL_LUMINANCE16_ALPHA16}, @code{GL_INTENSITY},
+@code{GL_INTENSITY4}, @code{GL_INTENSITY8}, @code{GL_INTENSITY12},
+@code{GL_INTENSITY16}, @code{GL_R3_G3_B2}, @code{GL_RGB},
+@code{GL_RGB4}, @code{GL_RGB5}, @code{GL_RGB8}, @code{GL_RGB10},
+@code{GL_RGB12}, @code{GL_RGB16}, @code{GL_RGBA}, @code{GL_RGBA2},
+@code{GL_RGBA4}, @code{GL_RGB5_A1}, @code{GL_RGBA8}, @code{GL_RGB10_A2},
+@code{GL_RGBA12}, @code{GL_RGBA16}, @code{GL_SLUMINANCE},
+@code{GL_SLUMINANCE8}, @code{GL_SLUMINANCE_ALPHA},
+@code{GL_SLUMINANCE8_ALPHA8}, @code{GL_SRGB}, @code{GL_SRGB8},
+@code{GL_SRGB_ALPHA}, or @code{GL_SRGB8_ALPHA8}.
+
+@item @var{width}
+Specifies the width of the texture image including the border if any. If
+the GL version does not support non-power-of-two sizes, this value must
+be @math{2^@var{n}+2(@var{border},)} for some integer @math{@var{n}}.
+All implementations support texture images that are at least 64 texels
+wide. The height of the 1D texture image is 1.
+
+@item @var{border}
+Specifies the width of the border. Must be either 0 or 1.
+
+@item @var{format}
+Specifies the format of the pixel data. The following symbolic values
+are accepted: @code{GL_COLOR_INDEX}, @code{GL_RED}, @code{GL_GREEN},
+@code{GL_BLUE}, @code{GL_ALPHA}, @code{GL_RGB}, @code{GL_BGR},
+@code{GL_RGBA}, @code{GL_BGRA}, @code{GL_LUMINANCE}, and
+@code{GL_LUMINANCE_ALPHA}.
+
+@item @var{type}
+Specifies the data type of the pixel data. The following symbolic values
+are accepted: @code{GL_UNSIGNED_BYTE}, @code{GL_BYTE}, @code{GL_BITMAP},
+@code{GL_UNSIGNED_SHORT}, @code{GL_SHORT}, @code{GL_UNSIGNED_INT},
+@code{GL_INT}, @code{GL_FLOAT}, @code{GL_UNSIGNED_BYTE_3_3_2},
+@code{GL_UNSIGNED_BYTE_2_3_3_REV}, @code{GL_UNSIGNED_SHORT_5_6_5},
+@code{GL_UNSIGNED_SHORT_5_6_5_REV}, @code{GL_UNSIGNED_SHORT_4_4_4_4},
+@code{GL_UNSIGNED_SHORT_4_4_4_4_REV}, @code{GL_UNSIGNED_SHORT_5_5_5_1},
+@code{GL_UNSIGNED_SHORT_1_5_5_5_REV}, @code{GL_UNSIGNED_INT_8_8_8_8},
+@code{GL_UNSIGNED_INT_8_8_8_8_REV}, @code{GL_UNSIGNED_INT_10_10_10_2},
+and @code{GL_UNSIGNED_INT_2_10_10_10_REV}.
+
+@item @var{data}
+Specifies a pointer to the image data in memory.
+
+@end table
+
+@heading Description
+Texturing maps a portion of a specified texture image onto each
+graphical primitive for which texturing is enabled. To enable and
+disable one-dimensional texturing, call @code{glEnable} and
+@code{glDisable} with argument @code{GL_TEXTURE_1D}.
+
+Texture images are defined with @code{glTexImage1D}. The arguments
+describe the parameters of the texture image, such as width, width of
+the border, level-of-detail number (see @code{glTexParameter}), and the
+internal resolution and format used to store the image. The last three
+arguments describe how the image is represented in memory; they are
+identical to the pixel formats used for @code{glDrawPixels}.
+
+If @var{target} is @code{GL_PROXY_TEXTURE_1D}, no data is read from
+@var{data}, but all of the texture image state is recalculated, checked
+for consistency, and checked against the implementation's capabilities.
+If the implementation cannot handle a texture of the requested texture
+size, it sets all of the image state to 0, but does not generate an
+error (see @code{glGetError}). To query for an entire mipmap array, use
+an image array level greater than or equal to 1.
+
+If @var{target} is @code{GL_TEXTURE_1D}, data is read from @var{data} as
+a sequence of signed or unsigned bytes, shorts, or longs, or
+single-precision floating-point values, depending on @var{type}. These
+values are grouped into sets of one, two, three, or four values,
+depending on @var{format}, to form elements. If @var{type} is
+@code{GL_BITMAP}, the data is considered as a string of unsigned bytes
+(and @var{format} must be @code{GL_COLOR_INDEX}). Each data byte is
+treated as eight 1-bit elements, with bit ordering determined by
+@code{GL_UNPACK_LSB_FIRST} (see @code{glPixelStore}).
+
+If a non-zero named buffer object is bound to the
+@code{GL_PIXEL_UNPACK_BUFFER} target (see @code{glBindBuffer}) while a
+texture image is specified, @var{data} is treated as a byte offset into
+the buffer object's data store.
+
+The first element corresponds to the left end of the texture array.
+Subsequent elements progress left-to-right through the remaining texels
+in the texture array. The final element corresponds to the right end of
+the texture array.
+
+@var{format} determines the composition of each element in @var{data}.
+It can assume one of these symbolic values:
+
+@table @asis
+@item @code{GL_COLOR_INDEX}
+Each element is a single value, a color index. The GL converts it to
+fixed point (with an unspecified number of zero bits to the right of the
+binary point), shifted left or right depending on the value and sign of
+@code{GL_INDEX_SHIFT}, and added to @code{GL_INDEX_OFFSET} (see
+@code{glPixelTransfer}). The resulting index is converted to a set of
+color components using the @code{GL_PIXEL_MAP_I_TO_R},
+@code{GL_PIXEL_MAP_I_TO_G}, @code{GL_PIXEL_MAP_I_TO_B}, and
+@code{GL_PIXEL_MAP_I_TO_A} tables, and clamped to the range [0,1].
+
+@item @code{GL_RED}
+Each element is a single red component. The GL converts it to floating
+point and assembles it into an RGBA element by attaching 0 for green and
+blue, and 1 for alpha. Each component is then multiplied by the signed
+scale factor @code{GL_c_SCALE}, added to the signed bias
+@code{GL_c_BIAS}, and clamped to the range [0,1] (see
+@code{glPixelTransfer}).
+
+@item @code{GL_GREEN}
+Each element is a single green component. The GL converts it to floating
+point and assembles it into an RGBA element by attaching 0 for red and
+blue, and 1 for alpha. Each component is then multiplied by the signed
+scale factor @code{GL_c_SCALE}, added to the signed bias
+@code{GL_c_BIAS}, and clamped to the range [0,1] (see
+@code{glPixelTransfer}).
+
+@item @code{GL_BLUE}
+Each element is a single blue component. The GL converts it to floating
+point and assembles it into an RGBA element by attaching 0 for red and
+green, and 1 for alpha. Each component is then multiplied by the signed
+scale factor @code{GL_c_SCALE}, added to the signed bias
+@code{GL_c_BIAS}, and clamped to the range [0,1] (see
+@code{glPixelTransfer}).
+
+@item @code{GL_ALPHA}
+Each element is a single alpha component. The GL converts it to floating
+point and assembles it into an RGBA element by attaching 0 for red,
+green, and blue. Each component is then multiplied by the signed scale
+factor @code{GL_c_SCALE}, added to the signed bias @code{GL_c_BIAS}, and
+clamped to the range [0,1] (see @code{glPixelTransfer}).
+
+@item @code{GL_INTENSITY}
+Each element is a single intensity value. The GL converts it to floating
+point, then assembles it into an RGBA element by replicating the
+intensity value three times for red, green, blue, and alpha. Each
+component is then multiplied by the signed scale factor
+@code{GL_c_SCALE}, added to the signed bias @code{GL_c_BIAS}, and
+clamped to the range [0,1] (see @code{glPixelTransfer}).
+
+@item @code{GL_RGB}
+@item @code{GL_BGR}
+Each element is an RGB triple. The GL converts it to floating point and
+assembles it into an RGBA element by attaching 1 for alpha. Each
+component is then multiplied by the signed scale factor
+@code{GL_c_SCALE}, added to the signed bias @code{GL_c_BIAS}, and
+clamped to the range [0,1] (see @code{glPixelTransfer}).
+
+@item @code{GL_RGBA}
+@item @code{GL_BGRA}
+Each element contains all four components. Each component is multiplied
+by the signed scale factor @code{GL_c_SCALE}, added to the signed bias
+@code{GL_c_BIAS}, and clamped to the range [0,1] (see
+@code{glPixelTransfer}).
+
+@item @code{GL_LUMINANCE}
+Each element is a single luminance value. The GL converts it to floating
+point, then assembles it into an RGBA element by replicating the
+luminance value three times for red, green, and blue and attaching 1 for
+alpha. Each component is then multiplied by the signed scale factor
+@code{GL_c_SCALE}, added to the signed bias @code{GL_c_BIAS}, and
+clamped to the range [0,1] (see @code{glPixelTransfer}).
+
+@item @code{GL_LUMINANCE_ALPHA}
+Each element is a luminance/alpha pair. The GL converts it to floating
+point, then assembles it into an RGBA element by replicating the
+luminance value three times for red, green, and blue. Each component is
+then multiplied by the signed scale factor @code{GL_c_SCALE}, added to
+the signed bias @code{GL_c_BIAS}, and clamped to the range [0,1] (see
+@code{glPixelTransfer}).
+
+@item @code{GL_DEPTH_COMPONENT}
+Each element is a single depth value. The GL converts it to floating
+point, multiplies by the signed scale factor @code{GL_DEPTH_SCALE}, adds
+the signed bias @code{GL_DEPTH_BIAS}, and clamps to the range [0,1] (see
+@code{glPixelTransfer}).
+
+@end table
+
+Refer to the @code{glDrawPixels} reference page for a description of the
+acceptable values for the @var{type} parameter.
+
+If an application wants to store the texture at a certain resolution or
+in a certain format, it can request the resolution and format with
+@var{internalFormat}. The GL will choose an internal representation that
+closely approximates that requested by @var{internalFormat}, but it may
+not match exactly. (The representations specified by
+@code{GL_LUMINANCE}, @code{GL_LUMINANCE_ALPHA}, @code{GL_RGB}, and
+@code{GL_RGBA} must match exactly. The numeric values 1, 2, 3, and 4 may
+also be used to specify the above representations.)
+
+If the @var{internalFormat} parameter is one of the generic compressed
+formats, @code{GL_COMPRESSED_ALPHA}, @code{GL_COMPRESSED_INTENSITY},
+@code{GL_COMPRESSED_LUMINANCE}, @code{GL_COMPRESSED_LUMINANCE_ALPHA},
+@code{GL_COMPRESSED_RGB}, or @code{GL_COMPRESSED_RGBA}, the GL will
+replace the internal format with the symbolic constant for a specific
+internal format and compress the texture before storage. If no
+corresponding internal format is available, or the GL can not compress
+that image for any reason, the internal format is instead replaced with
+a corresponding base internal format.
+
+If the @var{internalFormat} parameter is @code{GL_SRGB},
+@code{GL_SRGB8}, @code{GL_SRGB_ALPHA}, @code{GL_SRGB8_ALPHA8},
+@code{GL_SLUMINANCE}, @code{GL_SLUMINANCE8}, @code{GL_SLUMINANCE_ALPHA},
+or @code{GL_SLUMINANCE8_ALPHA8}, the texture is treated as if the red,
+green, blue, or luminance components are encoded in the sRGB color
+space. Any alpha component is left unchanged. The conversion from the
+sRGB encoded component @math{@var{c}_@var{s}} to a linear component
+@math{@var{c}_@var{l}} is:
+
+@math{@var{c}_@var{l}=@{(@var{c}_@var{s}/12.92 if
+@var{c}_@var{s}≤0.04045), ((@code{c}_@code{s}+0.055/1.055)^2.4 if
+@var{c}_@var{s}>0.04045)}
+
+Assume @math{@var{c}_@var{s}} is the sRGB component in the range [0,1].
+
+Use the @code{GL_PROXY_TEXTURE_1D} target to try out a resolution and
+format. The implementation will update and recompute its best match for
+the requested storage resolution and format. To then query this state,
+call @code{glGetTexLevelParameter}. If the texture cannot be
+accommodated, texture state is set to 0.
+
+A one-component texture image uses only the red component of the RGBA
+color from @var{data}. A two-component image uses the R and A values. A
+three-component image uses the R, G, and B values. A four-component
+image uses all of the RGBA components.
+
+Depth textures can be treated as LUMINANCE, INTENSITY or ALPHA textures
+during texture filtering and application. Image-based shadowing can be
+ enabled by comparing texture r coordinates to depth texture values to
+generate a boolean result. See @code{glTexParameter} for details on
+texture comparison.
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{target} is not
+@code{GL_TEXTURE_1D} or @code{GL_PROXY_TEXTURE_1D}.
+
+@code{GL_INVALID_ENUM} is generated if @var{format} is not an accepted
+format constant. Format constants other than @code{GL_STENCIL_INDEX} are
+accepted.
+
+@code{GL_INVALID_ENUM} is generated if @var{type} is not a type
+constant.
+
+@code{GL_INVALID_ENUM} is generated if @var{type} is @code{GL_BITMAP}
+and @var{format} is not @code{GL_COLOR_INDEX}.
+
+@code{GL_INVALID_VALUE} is generated if @var{level} is less than 0.
+
+@code{GL_INVALID_VALUE} may be generated if @var{level} is greater than
+@math{@var{log}_2(@var{max},)}, where @var{max} is the returned value
+of @code{GL_MAX_TEXTURE_SIZE}.
+
+@code{GL_INVALID_VALUE} is generated if @var{internalFormat} is not 1,
+2, 3, 4, or one of the accepted resolution and format symbolic
+constants.
+
+@code{GL_INVALID_VALUE} is generated if @var{width} is less than 0 or
+greater than 2 + @code{GL_MAX_TEXTURE_SIZE}.
+
+@code{GL_INVALID_VALUE} is generated if non-power-of-two textures are
+not supported and the @var{width} cannot be represented as
+@math{2^@var{n}+2(@var{border},)} for some integer value of @var{n}.
+
+@code{GL_INVALID_VALUE} is generated if @var{border} is not 0 or 1.
+
+@code{GL_INVALID_OPERATION} is generated if @var{type} is one of
+@code{GL_UNSIGNED_BYTE_3_3_2}, @code{GL_UNSIGNED_BYTE_2_3_3_REV},
+@code{GL_UNSIGNED_SHORT_5_6_5}, or @code{GL_UNSIGNED_SHORT_5_6_5_REV}
+and @var{format} is not @code{GL_RGB}.
+
+@code{GL_INVALID_OPERATION} is generated if @var{type} is one of
+@code{GL_UNSIGNED_SHORT_4_4_4_4}, @code{GL_UNSIGNED_SHORT_4_4_4_4_REV},
+@code{GL_UNSIGNED_SHORT_5_5_5_1}, @code{GL_UNSIGNED_SHORT_1_5_5_5_REV},
+@code{GL_UNSIGNED_INT_8_8_8_8}, @code{GL_UNSIGNED_INT_8_8_8_8_REV},
+@code{GL_UNSIGNED_INT_10_10_10_2}, or
+@code{GL_UNSIGNED_INT_2_10_10_10_REV} and @var{format} is neither
+@code{GL_RGBA} nor @code{GL_BGRA}.
+
+@code{GL_INVALID_OPERATION} is generated if @var{format} is
+@code{GL_DEPTH_COMPONENT} and @var{internalFormat} is not
+@code{GL_DEPTH_COMPONENT}, @code{GL_DEPTH_COMPONENT16},
+@code{GL_DEPTH_COMPONENT24}, or @code{GL_DEPTH_COMPONENT32}.
+
+@code{GL_INVALID_OPERATION} is generated if @var{internalFormat} is
+@code{GL_DEPTH_COMPONENT}, @code{GL_DEPTH_COMPONENT16},
+@code{GL_DEPTH_COMPONENT24}, or @code{GL_DEPTH_COMPONENT32}, and
+@var{format} is not @code{GL_DEPTH_COMPONENT}.
+
+@code{GL_INVALID_OPERATION} is generated if a non-zero buffer object
+name is bound to the @code{GL_PIXEL_UNPACK_BUFFER} target and the buffer
+object's data store is currently mapped.
+
+@code{GL_INVALID_OPERATION} is generated if a non-zero buffer object
+name is bound to the @code{GL_PIXEL_UNPACK_BUFFER} target and the data
+would be unpacked from the buffer object such that the memory reads
+required would exceed the data store size.
+
+@code{GL_INVALID_OPERATION} is generated if a non-zero buffer object
+name is bound to the @code{GL_PIXEL_UNPACK_BUFFER} target and @var{data}
+is not evenly divisible into the number of bytes needed to store in
+memory a datum indicated by @var{type}.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glTexImage1D} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glTexImage2D
+@heading specify a two-dimensional texture image
+@heading Parameters
+@table @asis
+@item @var{target}
+Specifies the target texture. Must be @code{GL_TEXTURE_2D},
+@code{GL_PROXY_TEXTURE_2D}, @code{GL_TEXTURE_CUBE_MAP_POSITIVE_X},
+@code{GL_TEXTURE_CUBE_MAP_NEGATIVE_X},
+@code{GL_TEXTURE_CUBE_MAP_POSITIVE_Y},
+@code{GL_TEXTURE_CUBE_MAP_NEGATIVE_Y},
+@code{GL_TEXTURE_CUBE_MAP_POSITIVE_Z},
+@code{GL_TEXTURE_CUBE_MAP_NEGATIVE_Z}, or
+@code{GL_PROXY_TEXTURE_CUBE_MAP}.
+
+@item @var{level}
+Specifies the level-of-detail number. Level 0 is the base image level.
+Level @var{n} is the @var{n}th mipmap reduction image.
+
+@item @var{internalFormat}
+Specifies the number of color components in the texture. Must be 1, 2,
+3, or 4, or one of the following symbolic constants: @code{GL_ALPHA},
+@code{GL_ALPHA4}, @code{GL_ALPHA8}, @code{GL_ALPHA12},
+@code{GL_ALPHA16}, @code{GL_COMPRESSED_ALPHA},
+@code{GL_COMPRESSED_LUMINANCE}, @code{GL_COMPRESSED_LUMINANCE_ALPHA},
+@code{GL_COMPRESSED_INTENSITY}, @code{GL_COMPRESSED_RGB},
+@code{GL_COMPRESSED_RGBA}, @code{GL_DEPTH_COMPONENT},
+@code{GL_DEPTH_COMPONENT16}, @code{GL_DEPTH_COMPONENT24},
+@code{GL_DEPTH_COMPONENT32}, @code{GL_LUMINANCE}, @code{GL_LUMINANCE4},
+@code{GL_LUMINANCE8}, @code{GL_LUMINANCE12}, @code{GL_LUMINANCE16},
+@code{GL_LUMINANCE_ALPHA}, @code{GL_LUMINANCE4_ALPHA4},
+@code{GL_LUMINANCE6_ALPHA2}, @code{GL_LUMINANCE8_ALPHA8},
+@code{GL_LUMINANCE12_ALPHA4}, @code{GL_LUMINANCE12_ALPHA12},
+@code{GL_LUMINANCE16_ALPHA16}, @code{GL_INTENSITY},
+@code{GL_INTENSITY4}, @code{GL_INTENSITY8}, @code{GL_INTENSITY12},
+@code{GL_INTENSITY16}, @code{GL_R3_G3_B2}, @code{GL_RGB},
+@code{GL_RGB4}, @code{GL_RGB5}, @code{GL_RGB8}, @code{GL_RGB10},
+@code{GL_RGB12}, @code{GL_RGB16}, @code{GL_RGBA}, @code{GL_RGBA2},
+@code{GL_RGBA4}, @code{GL_RGB5_A1}, @code{GL_RGBA8}, @code{GL_RGB10_A2},
+@code{GL_RGBA12}, @code{GL_RGBA16}, @code{GL_SLUMINANCE},
+@code{GL_SLUMINANCE8}, @code{GL_SLUMINANCE_ALPHA},
+@code{GL_SLUMINANCE8_ALPHA8}, @code{GL_SRGB}, @code{GL_SRGB8},
+@code{GL_SRGB_ALPHA}, or @code{GL_SRGB8_ALPHA8}.
+
+@item @var{width}
+Specifies the width of the texture image including the border if any. If
+the GL version does not support non-power-of-two sizes, this value must
+be @math{2^@var{n}+2(@var{border},)} for some integer @math{@var{n}}.
+All implementations support texture images that are at least 64 texels
+wide.
+
+@item @var{height}
+Specifies the height of the texture image including the border if any.
+If the GL version does not support non-power-of-two sizes, this value
+must be @math{2^@var{m}+2(@var{border},)} for some integer
+@math{@var{m}}. All implementations support texture images that are at
+least 64 texels high.
+
+@item @var{border}
+Specifies the width of the border. Must be either 0 or 1.
+
+@item @var{format}
+Specifies the format of the pixel data. The following symbolic values
+are accepted: @code{GL_COLOR_INDEX}, @code{GL_RED}, @code{GL_GREEN},
+@code{GL_BLUE}, @code{GL_ALPHA}, @code{GL_RGB}, @code{GL_BGR},
+@code{GL_RGBA}, @code{GL_BGRA}, @code{GL_LUMINANCE}, and
+@code{GL_LUMINANCE_ALPHA}.
+
+@item @var{type}
+Specifies the data type of the pixel data. The following symbolic values
+are accepted: @code{GL_UNSIGNED_BYTE}, @code{GL_BYTE}, @code{GL_BITMAP},
+@code{GL_UNSIGNED_SHORT}, @code{GL_SHORT}, @code{GL_UNSIGNED_INT},
+@code{GL_INT}, @code{GL_FLOAT}, @code{GL_UNSIGNED_BYTE_3_3_2},
+@code{GL_UNSIGNED_BYTE_2_3_3_REV}, @code{GL_UNSIGNED_SHORT_5_6_5},
+@code{GL_UNSIGNED_SHORT_5_6_5_REV}, @code{GL_UNSIGNED_SHORT_4_4_4_4},
+@code{GL_UNSIGNED_SHORT_4_4_4_4_REV}, @code{GL_UNSIGNED_SHORT_5_5_5_1},
+@code{GL_UNSIGNED_SHORT_1_5_5_5_REV}, @code{GL_UNSIGNED_INT_8_8_8_8},
+@code{GL_UNSIGNED_INT_8_8_8_8_REV}, @code{GL_UNSIGNED_INT_10_10_10_2},
+and @code{GL_UNSIGNED_INT_2_10_10_10_REV}.
+
+@item @var{data}
+Specifies a pointer to the image data in memory.
+
+@end table
+
+@heading Description
+Texturing maps a portion of a specified texture image onto each
+graphical primitive for which texturing is enabled. To enable and
+disable two-dimensional texturing, call @code{glEnable} and
+@code{glDisable} with argument @code{GL_TEXTURE_2D}. To enable and
+disable texturing using cube-mapped texture, call @code{glEnable} and
+@code{glDisable} with argument @code{GL_TEXTURE_CUBE_MAP}.
+
+To define texture images, call @code{glTexImage2D}. The arguments
+describe the parameters of the texture image, such as height, width,
+width of the border, level-of-detail number (see @code{glTexParameter}),
+and number of color components provided. The last three arguments
+describe how the image is represented in memory; they are identical to
+the pixel formats used for @code{glDrawPixels}.
+
+If @var{target} is @code{GL_PROXY_TEXTURE_2D} or
+@code{GL_PROXY_TEXTURE_CUBE_MAP}, no data is read from @var{data}, but
+all of the texture image state is recalculated, checked for consistency,
+and checked against the implementation's capabilities. If the
+implementation cannot handle a texture of the requested texture size, it
+sets all of the image state to 0, but does not generate an error (see
+@code{glGetError}). To query for an entire mipmap array, use an image
+array level greater than or equal to 1.
+
+If @var{target} is @code{GL_TEXTURE_2D}, or one of the
+@code{GL_TEXTURE_CUBE_MAP} targets, data is read from @var{data} as a
+sequence of signed or unsigned bytes, shorts, or longs, or
+single-precision floating-point values, depending on @var{type}. These
+values are grouped into sets of one, two, three, or four values,
+depending on @var{format}, to form elements. If @var{type} is
+@code{GL_BITMAP}, the data is considered as a string of unsigned bytes
+(and @var{format} must be @code{GL_COLOR_INDEX}). Each data byte is
+treated as eight 1-bit elements, with bit ordering determined by
+@code{GL_UNPACK_LSB_FIRST} (see @code{glPixelStore}).
+
+If a non-zero named buffer object is bound to the
+@code{GL_PIXEL_UNPACK_BUFFER} target (see @code{glBindBuffer}) while a
+texture image is specified, @var{data} is treated as a byte offset into
+the buffer object's data store.
+
+The first element corresponds to the lower left corner of the texture
+image. Subsequent elements progress left-to-right through the remaining
+texels in the lowest row of the texture image, and then in successively
+higher rows of the texture image. The final element corresponds to the
+upper right corner of the texture image.
+
+@var{format} determines the composition of each element in @var{data}.
+It can assume one of these symbolic values:
+
+@table @asis
+@item @code{GL_COLOR_INDEX}
+Each element is a single value, a color index. The GL converts it to
+fixed point (with an unspecified number of zero bits to the right of the
+binary point), shifted left or right depending on the value and sign of
+@code{GL_INDEX_SHIFT}, and added to @code{GL_INDEX_OFFSET} (see
+@code{glPixelTransfer}). The resulting index is converted to a set of
+color components using the @code{GL_PIXEL_MAP_I_TO_R},
+@code{GL_PIXEL_MAP_I_TO_G}, @code{GL_PIXEL_MAP_I_TO_B}, and
+@code{GL_PIXEL_MAP_I_TO_A} tables, and clamped to the range [0,1].
+
+@item @code{GL_RED}
+Each element is a single red component. The GL converts it to floating
+point and assembles it into an RGBA element by attaching 0 for green and
+blue, and 1 for alpha. Each component is then multiplied by the signed
+scale factor @code{GL_c_SCALE}, added to the signed bias
+@code{GL_c_BIAS}, and clamped to the range [0,1] (see
+@code{glPixelTransfer}).
+
+@item @code{GL_GREEN}
+Each element is a single green component. The GL converts it to floating
+point and assembles it into an RGBA element by attaching 0 for red and
+blue, and 1 for alpha. Each component is then multiplied by the signed
+scale factor @code{GL_c_SCALE}, added to the signed bias
+@code{GL_c_BIAS}, and clamped to the range [0,1] (see
+@code{glPixelTransfer}).
+
+@item @code{GL_BLUE}
+Each element is a single blue component. The GL converts it to floating
+point and assembles it into an RGBA element by attaching 0 for red and
+green, and 1 for alpha. Each component is then multiplied by the signed
+scale factor @code{GL_c_SCALE}, added to the signed bias
+@code{GL_c_BIAS}, and clamped to the range [0,1] (see
+@code{glPixelTransfer}).
+
+@item @code{GL_ALPHA}
+Each element is a single alpha component. The GL converts it to floating
+point and assembles it into an RGBA element by attaching 0 for red,
+green, and blue. Each component is then multiplied by the signed scale
+factor @code{GL_c_SCALE}, added to the signed bias @code{GL_c_BIAS}, and
+clamped to the range [0,1] (see @code{glPixelTransfer}).
+
+@item @code{GL_INTENSITY}
+Each element is a single intensity value. The GL converts it to floating
+point, then assembles it into an RGBA element by replicating the
+intensity value three times for red, green, blue, and alpha. Each
+component is then multiplied by the signed scale factor
+@code{GL_c_SCALE}, added to the signed bias @code{GL_c_BIAS}, and
+clamped to the range [0,1] (see @code{glPixelTransfer}).
+
+@item @code{GL_RGB}
+@item @code{GL_BGR}
+Each element is an RGB triple. The GL converts it to floating point and
+assembles it into an RGBA element by attaching 1 for alpha. Each
+component is then multiplied by the signed scale factor
+@code{GL_c_SCALE}, added to the signed bias @code{GL_c_BIAS}, and
+clamped to the range [0,1] (see @code{glPixelTransfer}).
+
+@item @code{GL_RGBA}
+@item @code{GL_BGRA}
+Each element contains all four components. Each component is multiplied
+by the signed scale factor @code{GL_c_SCALE}, added to the signed bias
+@code{GL_c_BIAS}, and clamped to the range [0,1] (see
+@code{glPixelTransfer}).
+
+@item @code{GL_LUMINANCE}
+Each element is a single luminance value. The GL converts it to floating
+point, then assembles it into an RGBA element by replicating the
+luminance value three times for red, green, and blue and attaching 1 for
+alpha. Each component is then multiplied by the signed scale factor
+@code{GL_c_SCALE}, added to the signed bias @code{GL_c_BIAS}, and
+clamped to the range [0,1] (see @code{glPixelTransfer}).
+
+@item @code{GL_LUMINANCE_ALPHA}
+Each element is a luminance/alpha pair. The GL converts it to floating
+point, then assembles it into an RGBA element by replicating the
+luminance value three times for red, green, and blue. Each component is
+then multiplied by the signed scale factor @code{GL_c_SCALE}, added to
+the signed bias @code{GL_c_BIAS}, and clamped to the range [0,1] (see
+@code{glPixelTransfer}).
+
+@item @code{GL_DEPTH_COMPONENT}
+Each element is a single depth value. The GL converts it to floating
+point, multiplies by the signed scale factor @code{GL_DEPTH_SCALE}, adds
+the signed bias @code{GL_DEPTH_BIAS}, and clamps to the range [0,1] (see
+@code{glPixelTransfer}).
+
+@end table
+
+Refer to the @code{glDrawPixels} reference page for a description of the
+acceptable values for the @var{type} parameter.
+
+If an application wants to store the texture at a certain resolution or
+in a certain format, it can request the resolution and format with
+@var{internalFormat}. The GL will choose an internal representation that
+closely approximates that requested by @var{internalFormat}, but it may
+not match exactly. (The representations specified by
+@code{GL_LUMINANCE}, @code{GL_LUMINANCE_ALPHA}, @code{GL_RGB}, and
+@code{GL_RGBA} must match exactly. The numeric values 1, 2, 3, and 4 may
+also be used to specify the above representations.)
+
+If the @var{internalFormat} parameter is one of the generic compressed
+formats, @code{GL_COMPRESSED_ALPHA}, @code{GL_COMPRESSED_INTENSITY},
+@code{GL_COMPRESSED_LUMINANCE}, @code{GL_COMPRESSED_LUMINANCE_ALPHA},
+@code{GL_COMPRESSED_RGB}, or @code{GL_COMPRESSED_RGBA}, the GL will
+replace the internal format with the symbolic constant for a specific
+internal format and compress the texture before storage. If no
+corresponding internal format is available, or the GL can not compress
+that image for any reason, the internal format is instead replaced with
+a corresponding base internal format.
+
+If the @var{internalFormat} parameter is @code{GL_SRGB},
+@code{GL_SRGB8}, @code{GL_SRGB_ALPHA}, @code{GL_SRGB8_ALPHA8},
+@code{GL_SLUMINANCE}, @code{GL_SLUMINANCE8}, @code{GL_SLUMINANCE_ALPHA},
+or @code{GL_SLUMINANCE8_ALPHA8}, the texture is treated as if the red,
+green, blue, or luminance components are encoded in the sRGB color
+space. Any alpha component is left unchanged. The conversion from the
+sRGB encoded component @math{@var{c}_@var{s}} to a linear component
+@math{@var{c}_@var{l}} is:
+
+@math{@var{c}_@var{l}=@{(@var{c}_@var{s}/12.92 if
+@var{c}_@var{s}≤0.04045), ((@code{c}_@code{s}+0.055/1.055)^2.4 if
+@var{c}_@var{s}>0.04045)}
+
+Assume @math{@var{c}_@var{s}} is the sRGB component in the range [0,1].
+
+Use the @code{GL_PROXY_TEXTURE_2D} or @code{GL_PROXY_TEXTURE_CUBE_MAP}
+target to try out a resolution and format. The implementation will
+update and recompute its best match for the requested storage resolution
+and format. To then query this state, call
+@code{glGetTexLevelParameter}. If the texture cannot be accommodated,
+texture state is set to 0.
+
+A one-component texture image uses only the red component of the RGBA
+color extracted from @var{data}. A two-component image uses the R and A
+values. A three-component image uses the R, G, and B values. A
+four-component image uses all of the RGBA components.
+
+Depth textures can be treated as LUMINANCE, INTENSITY or ALPHA textures
+during texture filtering and application. Image-based shadowing can be
+ enabled by comparing texture r coordinates to depth texture values to
+generate a boolean result. See @code{glTexParameter} for details on
+texture comparison.
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{target} is not
+@code{GL_TEXTURE_2D}, @code{GL_PROXY_TEXTURE_2D},
+@code{GL_PROXY_TEXTURE_CUBE_MAP}, @code{GL_TEXTURE_CUBE_MAP_POSITIVE_X},
+@code{GL_TEXTURE_CUBE_MAP_NEGATIVE_X},
+@code{GL_TEXTURE_CUBE_MAP_POSITIVE_Y},
+@code{GL_TEXTURE_CUBE_MAP_NEGATIVE_Y},
+@code{GL_TEXTURE_CUBE_MAP_POSITIVE_Z}, or
+@code{GL_TEXTURE_CUBE_MAP_NEGATIVE_Z}.
+
+@code{GL_INVALID_ENUM} is generated if @var{target} is one of the six
+cube map 2D image targets and the width and height parameters are not
+equal.
+
+@code{GL_INVALID_ENUM} is generated if @var{type} is not a type
+constant.
+
+@code{GL_INVALID_ENUM} is generated if @var{type} is @code{GL_BITMAP}
+and @var{format} is not @code{GL_COLOR_INDEX}.
+
+@code{GL_INVALID_VALUE} is generated if @var{width} or @var{height} is
+less than 0 or greater than 2 + @code{GL_MAX_TEXTURE_SIZE}.
+
+@code{GL_INVALID_VALUE} is generated if @var{level} is less than 0.
+
+@code{GL_INVALID_VALUE} may be generated if @var{level} is greater than
+@math{@var{log}_2(@var{max},)}, where @var{max} is the returned value
+of @code{GL_MAX_TEXTURE_SIZE}.
+
+@code{GL_INVALID_VALUE} is generated if @var{internalFormat} is not 1,
+2, 3, 4, or one of the accepted resolution and format symbolic
+constants.
+
+@code{GL_INVALID_VALUE} is generated if @var{width} or @var{height} is
+less than 0 or greater than 2 + @code{GL_MAX_TEXTURE_SIZE}.
+
+@code{GL_INVALID_VALUE} is generated if non-power-of-two textures are
+not supported and the @var{width} or @var{height} cannot be represented
+as @math{2^@var{k}+2(@var{border},)} for some integer value of @var{k}.
+
+@code{GL_INVALID_VALUE} is generated if @var{border} is not 0 or 1.
+
+@code{GL_INVALID_OPERATION} is generated if @var{type} is one of
+@code{GL_UNSIGNED_BYTE_3_3_2}, @code{GL_UNSIGNED_BYTE_2_3_3_REV},
+@code{GL_UNSIGNED_SHORT_5_6_5}, or @code{GL_UNSIGNED_SHORT_5_6_5_REV}
+and @var{format} is not @code{GL_RGB}.
+
+@code{GL_INVALID_OPERATION} is generated if @var{type} is one of
+@code{GL_UNSIGNED_SHORT_4_4_4_4}, @code{GL_UNSIGNED_SHORT_4_4_4_4_REV},
+@code{GL_UNSIGNED_SHORT_5_5_5_1}, @code{GL_UNSIGNED_SHORT_1_5_5_5_REV},
+@code{GL_UNSIGNED_INT_8_8_8_8}, @code{GL_UNSIGNED_INT_8_8_8_8_REV},
+@code{GL_UNSIGNED_INT_10_10_10_2}, or
+@code{GL_UNSIGNED_INT_2_10_10_10_REV} and @var{format} is neither
+@code{GL_RGBA} nor @code{GL_BGRA}.
+
+@code{GL_INVALID_OPERATION} is generated if @var{target} is not
+@code{GL_TEXTURE_2D} or @code{GL_PROXY_TEXTURE_2D} and
+@var{internalFormat} is @code{GL_DEPTH_COMPONENT},
+@code{GL_DEPTH_COMPONENT16}, @code{GL_DEPTH_COMPONENT24}, or
+@code{GL_DEPTH_COMPONENT32}.
+
+@code{GL_INVALID_OPERATION} is generated if @var{format} is
+@code{GL_DEPTH_COMPONENT} and @var{internalFormat} is not
+@code{GL_DEPTH_COMPONENT}, @code{GL_DEPTH_COMPONENT16},
+@code{GL_DEPTH_COMPONENT24}, or @code{GL_DEPTH_COMPONENT32}.
+
+@code{GL_INVALID_OPERATION} is generated if @var{internalFormat} is
+@code{GL_DEPTH_COMPONENT}, @code{GL_DEPTH_COMPONENT16},
+@code{GL_DEPTH_COMPONENT24}, or @code{GL_DEPTH_COMPONENT32}, and
+@var{format} is not @code{GL_DEPTH_COMPONENT}.
+
+@code{GL_INVALID_OPERATION} is generated if a non-zero buffer object
+name is bound to the @code{GL_PIXEL_UNPACK_BUFFER} target and the buffer
+object's data store is currently mapped.
+
+@code{GL_INVALID_OPERATION} is generated if a non-zero buffer object
+name is bound to the @code{GL_PIXEL_UNPACK_BUFFER} target and the data
+would be unpacked from the buffer object such that the memory reads
+required would exceed the data store size.
+
+@code{GL_INVALID_OPERATION} is generated if a non-zero buffer object
+name is bound to the @code{GL_PIXEL_UNPACK_BUFFER} target and @var{data}
+is not evenly divisible into the number of bytes needed to store in
+memory a datum indicated by @var{type}.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glTexImage2D} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glTexImage3D
+@heading specify a three-dimensional texture image
+@heading Parameters
+@table @asis
+@item @var{target}
+Specifies the target texture. Must be @code{GL_TEXTURE_3D} or
+@code{GL_PROXY_TEXTURE_3D}.
+
+@item @var{level}
+Specifies the level-of-detail number. Level 0 is the base image level.
+Level @math{@var{n}} is the @math{@var{n}^@var{th}} mipmap reduction
+image.
+
+@item @var{internalFormat}
+Specifies the number of color components in the texture. Must be 1, 2,
+3, or 4, or one of the following symbolic constants: @code{GL_ALPHA},
+@code{GL_ALPHA4}, @code{GL_ALPHA8}, @code{GL_ALPHA12},
+@code{GL_ALPHA16}, @code{GL_COMPRESSED_ALPHA},
+@code{GL_COMPRESSED_LUMINANCE}, @code{GL_COMPRESSED_LUMINANCE_ALPHA},
+@code{GL_COMPRESSED_INTENSITY}, @code{GL_COMPRESSED_RGB},
+@code{GL_COMPRESSED_RGBA}, @code{GL_LUMINANCE}, @code{GL_LUMINANCE4},
+@code{GL_LUMINANCE8}, @code{GL_LUMINANCE12}, @code{GL_LUMINANCE16},
+@code{GL_LUMINANCE_ALPHA}, @code{GL_LUMINANCE4_ALPHA4},
+@code{GL_LUMINANCE6_ALPHA2}, @code{GL_LUMINANCE8_ALPHA8},
+@code{GL_LUMINANCE12_ALPHA4}, @code{GL_LUMINANCE12_ALPHA12},
+@code{GL_LUMINANCE16_ALPHA16}, @code{GL_INTENSITY},
+@code{GL_INTENSITY4}, @code{GL_INTENSITY8}, @code{GL_INTENSITY12},
+@code{GL_INTENSITY16}, @code{GL_R3_G3_B2}, @code{GL_RGB},
+@code{GL_RGB4}, @code{GL_RGB5}, @code{GL_RGB8}, @code{GL_RGB10},
+@code{GL_RGB12}, @code{GL_RGB16}, @code{GL_RGBA}, @code{GL_RGBA2},
+@code{GL_RGBA4}, @code{GL_RGB5_A1}, @code{GL_RGBA8}, @code{GL_RGB10_A2},
+@code{GL_RGBA12}, @code{GL_RGBA16}, @code{GL_SLUMINANCE},
+@code{GL_SLUMINANCE8}, @code{GL_SLUMINANCE_ALPHA},
+@code{GL_SLUMINANCE8_ALPHA8}, @code{GL_SRGB}, @code{GL_SRGB8},
+@code{GL_SRGB_ALPHA}, or @code{GL_SRGB8_ALPHA8}.
+
+@item @var{width}
+Specifies the width of the texture image including the border if any. If
+the GL version does not support non-power-of-two sizes, this value must
+be @math{2^@var{n}+2(@var{border},)} for some integer @math{@var{n}}.
+All implementations support 3D texture images that are at least 16
+texels wide.
+
+@item @var{height}
+Specifies the height of the texture image including the border if any.
+If the GL version does not support non-power-of-two sizes, this value
+must be @math{2^@var{m}+2(@var{border},)} for some integer
+@math{@var{m}}. All implementations support 3D texture images that are
+at least 16 texels high.
+
+@item @var{depth}
+Specifies the depth of the texture image including the border if any. If
+the GL version does not support non-power-of-two sizes, this value must
+be @math{2^@var{k}+2(@var{border},)} for some integer @math{@var{k}}.
+All implementations support 3D texture images that are at least 16
+texels deep.
+
+@item @var{border}
+Specifies the width of the border. Must be either 0 or 1.
+
+@item @var{format}
+Specifies the format of the pixel data. The following symbolic values
+are accepted: @code{GL_COLOR_INDEX}, @code{GL_RED}, @code{GL_GREEN},
+@code{GL_BLUE}, @code{GL_ALPHA}, @code{GL_RGB}, @code{GL_BGR},
+@code{GL_RGBA}, @code{GL_BGRA}, @code{GL_LUMINANCE}, and
+@code{GL_LUMINANCE_ALPHA}.
+
+@item @var{type}
+Specifies the data type of the pixel data. The following symbolic values
+are accepted: @code{GL_UNSIGNED_BYTE}, @code{GL_BYTE}, @code{GL_BITMAP},
+@code{GL_UNSIGNED_SHORT}, @code{GL_SHORT}, @code{GL_UNSIGNED_INT},
+@code{GL_INT}, @code{GL_FLOAT}, @code{GL_UNSIGNED_BYTE_3_3_2},
+@code{GL_UNSIGNED_BYTE_2_3_3_REV}, @code{GL_UNSIGNED_SHORT_5_6_5},
+@code{GL_UNSIGNED_SHORT_5_6_5_REV}, @code{GL_UNSIGNED_SHORT_4_4_4_4},
+@code{GL_UNSIGNED_SHORT_4_4_4_4_REV}, @code{GL_UNSIGNED_SHORT_5_5_5_1},
+@code{GL_UNSIGNED_SHORT_1_5_5_5_REV}, @code{GL_UNSIGNED_INT_8_8_8_8},
+@code{GL_UNSIGNED_INT_8_8_8_8_REV}, @code{GL_UNSIGNED_INT_10_10_10_2},
+and @code{GL_UNSIGNED_INT_2_10_10_10_REV}.
+
+@item @var{data}
+Specifies a pointer to the image data in memory.
+
+@end table
+
+@heading Description
+Texturing maps a portion of a specified texture image onto each
+graphical primitive for which texturing is enabled. To enable and
+disable three-dimensional texturing, call @code{glEnable} and
+@code{glDisable} with argument @code{GL_TEXTURE_3D}.
+
+To define texture images, call @code{glTexImage3D}. The arguments
+describe the parameters of the texture image, such as height, width,
+depth, width of the border, level-of-detail number (see
+@code{glTexParameter}), and number of color components provided. The
+last three arguments describe how the image is represented in memory;
+they are identical to the pixel formats used for @code{glDrawPixels}.
+
+If @var{target} is @code{GL_PROXY_TEXTURE_3D}, no data is read from
+@var{data}, but all of the texture image state is recalculated, checked
+for consistency, and checked against the implementation's capabilities.
+If the implementation cannot handle a texture of the requested texture
+size, it sets all of the image state to 0, but does not generate an
+error (see @code{glGetError}). To query for an entire mipmap array, use
+an image array level greater than or equal to 1.
+
+If @var{target} is @code{GL_TEXTURE_3D}, data is read from @var{data} as
+a sequence of signed or unsigned bytes, shorts, or longs, or
+single-precision floating-point values, depending on @var{type}. These
+values are grouped into sets of one, two, three, or four values,
+depending on @var{format}, to form elements. If @var{type} is
+@code{GL_BITMAP}, the data is considered as a string of unsigned bytes
+(and @var{format} must be @code{GL_COLOR_INDEX}). Each data byte is
+treated as eight 1-bit elements, with bit ordering determined by
+@code{GL_UNPACK_LSB_FIRST} (see @code{glPixelStore}).
+
+If a non-zero named buffer object is bound to the
+@code{GL_PIXEL_UNPACK_BUFFER} target (see @code{glBindBuffer}) while a
+texture image is specified, @var{data} is treated as a byte offset into
+the buffer object's data store.
+
+The first element corresponds to the lower left corner of the texture
+image. Subsequent elements progress left-to-right through the remaining
+texels in the lowest row of the texture image, and then in successively
+higher rows of the texture image. The final element corresponds to the
+upper right corner of the texture image.
+
+@var{format} determines the composition of each element in @var{data}.
+It can assume one of these symbolic values:
+
+@table @asis
+@item @code{GL_COLOR_INDEX}
+Each element is a single value, a color index. The GL converts it to
+fixed point (with an unspecified number of zero bits to the right of the
+binary point), shifted left or right depending on the value and sign of
+@code{GL_INDEX_SHIFT}, and added to @code{GL_INDEX_OFFSET} (see
+@code{glPixelTransfer}). The resulting index is converted to a set of
+color components using the @code{GL_PIXEL_MAP_I_TO_R},
+@code{GL_PIXEL_MAP_I_TO_G}, @code{GL_PIXEL_MAP_I_TO_B}, and
+@code{GL_PIXEL_MAP_I_TO_A} tables, and clamped to the range [0,1].
+
+@item @code{GL_RED}
+Each element is a single red component. The GL converts it to floating
+point and assembles it into an RGBA element by attaching 0 for green and
+blue, and 1 for alpha. Each component is then multiplied by the signed
+scale factor @code{GL_c_SCALE}, added to the signed bias
+@code{GL_c_BIAS}, and clamped to the range [0,1] (see
+@code{glPixelTransfer}).
+
+@item @code{GL_GREEN}
+Each element is a single green component. The GL converts it to floating
+point and assembles it into an RGBA element by attaching 0 for red and
+blue, and 1 for alpha. Each component is then multiplied by the signed
+scale factor @code{GL_c_SCALE}, added to the signed bias
+@code{GL_c_BIAS}, and clamped to the range [0,1] (see
+@code{glPixelTransfer}).
+
+@item @code{GL_BLUE}
+Each element is a single blue component. The GL converts it to floating
+point and assembles it into an RGBA element by attaching 0 for red and
+green, and 1 for alpha. Each component is then multiplied by the signed
+scale factor @code{GL_c_SCALE}, added to the signed bias
+@code{GL_c_BIAS}, and clamped to the range [0,1] (see
+@code{glPixelTransfer}).
+
+@item @code{GL_ALPHA}
+Each element is a single alpha component. The GL converts it to floating
+point and assembles it into an RGBA element by attaching 0 for red,
+green, and blue. Each component is then multiplied by the signed scale
+factor @code{GL_c_SCALE}, added to the signed bias @code{GL_c_BIAS}, and
+clamped to the range [0,1] (see @code{glPixelTransfer}).
+
+@item @code{GL_INTENSITY}
+Each element is a single intensity value. The GL converts it to floating
+point, then assembles it into an RGBA element by replicating the
+intensity value three times for red, green, blue, and alpha. Each
+component is then multiplied by the signed scale factor
+@code{GL_c_SCALE}, added to the signed bias @code{GL_c_BIAS}, and
+clamped to the range [0,1] (see @code{glPixelTransfer}).
+
+@item @code{GL_RGB}
+@item @code{GL_BGR}
+Each element is an RGB triple. The GL converts it to floating point and
+assembles it into an RGBA element by attaching 1 for alpha. Each
+component is then multiplied by the signed scale factor
+@code{GL_c_SCALE}, added to the signed bias @code{GL_c_BIAS}, and
+clamped to the range [0,1] (see @code{glPixelTransfer}).
+
+@item @code{GL_RGBA}
+@item @code{GL_BGRA}
+Each element contains all four components. Each component is multiplied
+by the signed scale factor @code{GL_c_SCALE}, added to the signed bias
+@code{GL_c_BIAS}, and clamped to the range [0,1] (see
+@code{glPixelTransfer}).
+
+@item @code{GL_LUMINANCE}
+Each element is a single luminance value. The GL converts it to floating
+point, then assembles it into an RGBA element by replicating the
+luminance value three times for red, green, and blue and attaching 1 for
+alpha. Each component is then multiplied by the signed scale factor
+@code{GL_c_SCALE}, added to the signed bias @code{GL_c_BIAS}, and
+clamped to the range [0,1] (see @code{glPixelTransfer}).
+
+@item @code{GL_LUMINANCE_ALPHA}
+Each element is a luminance/alpha pair. The GL converts it to floating
+point, then assembles it into an RGBA element by replicating the
+luminance value three times for red, green, and blue. Each component is
+then multiplied by the signed scale factor @code{GL_c_SCALE}, added to
+the signed bias @code{GL_c_BIAS}, and clamped to the range [0,1] (see
+@code{glPixelTransfer}).
+
+@end table
+
+Refer to the @code{glDrawPixels} reference page for a description of the
+acceptable values for the @var{type} parameter.
+
+If an application wants to store the texture at a certain resolution or
+in a certain format, it can request the resolution and format with
+@var{internalFormat}. The GL will choose an internal representation that
+closely approximates that requested by @var{internalFormat}, but it may
+not match exactly. (The representations specified by
+@code{GL_LUMINANCE}, @code{GL_LUMINANCE_ALPHA}, @code{GL_RGB}, and
+@code{GL_RGBA} must match exactly. The numeric values 1, 2, 3, and 4 may
+also be used to specify the above representations.)
+
+If the @var{internalFormat} parameter is one of the generic compressed
+formats, @code{GL_COMPRESSED_ALPHA}, @code{GL_COMPRESSED_INTENSITY},
+@code{GL_COMPRESSED_LUMINANCE}, @code{GL_COMPRESSED_LUMINANCE_ALPHA},
+@code{GL_COMPRESSED_RGB}, or @code{GL_COMPRESSED_RGBA}, the GL will
+replace the internal format with the symbolic constant for a specific
+internal format and compress the texture before storage. If no
+corresponding internal format is available, or the GL can not compress
+that image for any reason, the internal format is instead replaced with
+a corresponding base internal format.
+
+If the @var{internalFormat} parameter is @code{GL_SRGB},
+@code{GL_SRGB8}, @code{GL_SRGB_ALPHA}, @code{GL_SRGB8_ALPHA8},
+@code{GL_SLUMINANCE}, @code{GL_SLUMINANCE8}, @code{GL_SLUMINANCE_ALPHA},
+or @code{GL_SLUMINANCE8_ALPHA8}, the texture is treated as if the red,
+green, blue, or luminance components are encoded in the sRGB color
+space. Any alpha component is left unchanged. The conversion from the
+sRGB encoded component @math{@var{c}_@var{s}} to a linear component
+@math{@var{c}_@var{l}} is:
+
+@math{@var{c}_@var{l}=@{(@var{c}_@var{s}/12.92 if
+@var{c}_@var{s}≤0.04045), ((@code{c}_@code{s}+0.055/1.055)^2.4 if
+@var{c}_@var{s}>0.04045)}
+
+Assume @math{@var{c}_@var{s}} is the sRGB component in the range [0,1].
+
+Use the @code{GL_PROXY_TEXTURE_3D} target to try out a resolution and
+format. The implementation will update and recompute its best match for
+the requested storage resolution and format. To then query this state,
+call @code{glGetTexLevelParameter}. If the texture cannot be
+accommodated, texture state is set to 0.
+
+A one-component texture image uses only the red component of the RGBA
+color extracted from @var{data}. A two-component image uses the R and A
+values. A three-component image uses the R, G, and B values. A
+four-component image uses all of the RGBA components.
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{target} is not
+@code{GL_TEXTURE_3D} or @code{GL_PROXY_TEXTURE_3D}.
+
+@code{GL_INVALID_ENUM} is generated if @var{format} is not an accepted
+format constant. Format constants other than @code{GL_STENCIL_INDEX} and
+@code{GL_DEPTH_COMPONENT} are accepted.
+
+@code{GL_INVALID_ENUM} is generated if @var{type} is not a type
+constant.
+
+@code{GL_INVALID_ENUM} is generated if @var{type} is @code{GL_BITMAP}
+and @var{format} is not @code{GL_COLOR_INDEX}.
+
+@code{GL_INVALID_VALUE} is generated if @var{level} is less than 0.
+
+@code{GL_INVALID_VALUE} may be generated if @var{level} is greater than
+@math{@var{log}_2(@var{max},)}, where @var{max} is the returned value
+of @code{GL_MAX_TEXTURE_SIZE}.
+
+@code{GL_INVALID_VALUE} is generated if @var{internalFormat} is not 1,
+2, 3, 4, or one of the accepted resolution and format symbolic
+constants.
+
+@code{GL_INVALID_VALUE} is generated if @var{width}, @var{height}, or
+@var{depth} is less than 0 or greater than 2 +
+@code{GL_MAX_TEXTURE_SIZE}.
+
+@code{GL_INVALID_VALUE} is generated if non-power-of-two textures are
+not supported and the @var{width}, @var{height}, or @var{depth} cannot
+be represented as @math{2^@var{k}+2(@var{border},)} for some integer
+value of @var{k}.
+
+@code{GL_INVALID_VALUE} is generated if @var{border} is not 0 or 1.
+
+@code{GL_INVALID_OPERATION} is generated if @var{type} is one of
+@code{GL_UNSIGNED_BYTE_3_3_2}, @code{GL_UNSIGNED_BYTE_2_3_3_REV},
+@code{GL_UNSIGNED_SHORT_5_6_5}, or @code{GL_UNSIGNED_SHORT_5_6_5_REV}
+and @var{format} is not @code{GL_RGB}.
+
+@code{GL_INVALID_OPERATION} is generated if @var{type} is one of
+@code{GL_UNSIGNED_SHORT_4_4_4_4}, @code{GL_UNSIGNED_SHORT_4_4_4_4_REV},
+@code{GL_UNSIGNED_SHORT_5_5_5_1}, @code{GL_UNSIGNED_SHORT_1_5_5_5_REV},
+@code{GL_UNSIGNED_INT_8_8_8_8}, @code{GL_UNSIGNED_INT_8_8_8_8_REV},
+@code{GL_UNSIGNED_INT_10_10_10_2}, or
+@code{GL_UNSIGNED_INT_2_10_10_10_REV} and @var{format} is neither
+@code{GL_RGBA} nor @code{GL_BGRA}.
+
+@code{GL_INVALID_OPERATION} is generated if @var{format} or
+@var{internalFormat} is @code{GL_DEPTH_COMPONENT},
+@code{GL_DEPTH_COMPONENT16}, @code{GL_DEPTH_COMPONENT24}, or
+@code{GL_DEPTH_COMPONENT32}.
+
+@code{GL_INVALID_OPERATION} is generated if a non-zero buffer object
+name is bound to the @code{GL_PIXEL_UNPACK_BUFFER} target and the buffer
+object's data store is currently mapped.
+
+@code{GL_INVALID_OPERATION} is generated if a non-zero buffer object
+name is bound to the @code{GL_PIXEL_UNPACK_BUFFER} target and the data
+would be unpacked from the buffer object such that the memory reads
+required would exceed the data store size.
+
+@code{GL_INVALID_OPERATION} is generated if a non-zero buffer object
+name is bound to the @code{GL_PIXEL_UNPACK_BUFFER} target and @var{data}
+is not evenly divisible into the number of bytes needed to store in
+memory a datum indicated by @var{type}.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glTexImage3D} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glTexParameter
+@heading set texture parameters
+@heading Parameters
+@table @asis
+@item @var{target}
+Specifies the target texture, which must be either @code{GL_TEXTURE_1D},
+@code{GL_TEXTURE_2D}, @code{GL_TEXTURE_3D}, or
+@code{GL_TEXTURE_CUBE_MAP}.
+
+@item @var{pname}
+Specifies the symbolic name of a single-valued texture parameter.
+@var{pname} can be one of the following: @code{GL_TEXTURE_MIN_FILTER},
+@code{GL_TEXTURE_MAG_FILTER}, @code{GL_TEXTURE_MIN_LOD},
+@code{GL_TEXTURE_MAX_LOD}, @code{GL_TEXTURE_BASE_LEVEL},
+@code{GL_TEXTURE_MAX_LEVEL}, @code{GL_TEXTURE_WRAP_S},
+@code{GL_TEXTURE_WRAP_T}, @code{GL_TEXTURE_WRAP_R},
+@code{GL_TEXTURE_PRIORITY}, @code{GL_TEXTURE_COMPARE_MODE},
+@code{GL_TEXTURE_COMPARE_FUNC}, @code{GL_DEPTH_TEXTURE_MODE}, or
+@code{GL_GENERATE_MIPMAP}.
+
+@item @var{param}
+Specifies the value of @var{pname}.
+
+@end table
+
+@heading Description
+Texture mapping is a technique that applies an image onto an object's
+surface as if the image were a decal or cellophane shrink-wrap. The
+image is created in texture space, with an (@math{@var{s}},
+@math{@var{t}}) coordinate system. A texture is a one- or
+two-dimensional image and a set of parameters that determine how samples
+are derived from the image.
+
+@code{glTexParameter} assigns the value or values in @var{params} to the
+texture parameter specified as @var{pname}. @var{target} defines the
+target texture, either @code{GL_TEXTURE_1D}, @code{GL_TEXTURE_2D}, or
+@code{GL_TEXTURE_3D}. The following symbols are accepted in @var{pname}:
+
+@table @asis
+@item @code{GL_TEXTURE_MIN_FILTER}
+The texture minifying function is used whenever the pixel being textured
+maps to an area greater than one texture element. There are six defined
+minifying functions. Two of them use the nearest one or nearest four
+texture elements to compute the texture value. The other four use
+mipmaps.
+
+A mipmap is an ordered set of arrays representing the same image at
+progressively lower resolutions. If the texture has dimensions
+@math{2^@var{n}×2^@var{m}}, there are
+@math{@var{max}(@var{n},@var{m})+1} mipmaps. The first mipmap is the
+original texture, with dimensions @math{2^@var{n}×2^@var{m}}. Each
+subsequent mipmap has dimensions @math{2^@var{k}-1,×2^@var{l}-1,}, where
+@math{2^@var{k}×2^@var{l}} are the dimensions of the previous mipmap,
+until either @math{@var{k}=0} or @math{@var{l}=0}. At that point,
+subsequent mipmaps have dimension @math{1×2^@var{l}-1,} or
+@math{2^@var{k}-1,×1} until the final mipmap, which has dimension
+@math{1×1}. To define the mipmaps, call @code{glTexImage1D},
+@code{glTexImage2D}, @code{glTexImage3D}, @code{glCopyTexImage1D}, or
+@code{glCopyTexImage2D} with the @var{level} argument indicating the
+order of the mipmaps. Level 0 is the original texture; level
+@math{@var{max}(@var{n},@var{m})} is the final @math{1×1} mipmap.
+
+@var{params} supplies a function for minifying the texture as one of the
+following:
+
+As more texture elements are sampled in the minification process, fewer
+aliasing artifacts will be apparent. While the @code{GL_NEAREST} and
+@code{GL_LINEAR} minification functions can be faster than the other
+four, they sample only one or four texture elements to determine the
+texture value of the pixel being rendered and can produce moire patterns
+or ragged transitions. The initial value of @code{GL_TEXTURE_MIN_FILTER}
+is @code{GL_NEAREST_MIPMAP_LINEAR}.
+
+@item @code{GL_TEXTURE_MAG_FILTER}
+The texture magnification function is used when the pixel being textured
+maps to an area less than or equal to one texture element. It sets the
+texture magnification function to either @code{GL_NEAREST} or
+@code{GL_LINEAR} (see below). @code{GL_NEAREST} is generally faster than
+@code{GL_LINEAR}, but it can produce textured images with sharper edges
+because the transition between texture elements is not as smooth. The
+initial value of @code{GL_TEXTURE_MAG_FILTER} is @code{GL_LINEAR}.
+
+@end table
+
+@table @asis
+@item @code{GL_NEAREST}
+Returns the value of the texture element that is nearest (in Manhattan
+distance) to the center of the pixel being textured.
+
+@item @code{GL_LINEAR}
+Returns the weighted average of the four texture elements that are
+closest to the center of the pixel being textured. These can include
+border texture elements, depending on the values of
+@code{GL_TEXTURE_WRAP_S} and @code{GL_TEXTURE_WRAP_T}, and on the exact
+mapping.
+
+@item @code{GL_NEAREST_MIPMAP_NEAREST}
+Chooses the mipmap that most closely matches the size of the pixel being
+textured and uses the @code{GL_NEAREST} criterion (the texture element
+nearest to the center of the pixel) to produce a texture value.
+
+@item @code{GL_LINEAR_MIPMAP_NEAREST}
+Chooses the mipmap that most closely matches the size of the pixel being
+textured and uses the @code{GL_LINEAR} criterion (a weighted average of
+the four texture elements that are closest to the center of the pixel)
+to produce a texture value.
+
+@item @code{GL_NEAREST_MIPMAP_LINEAR}
+Chooses the two mipmaps that most closely match the size of the pixel
+being textured and uses the @code{GL_NEAREST} criterion (the texture
+element nearest to the center of the pixel) to produce a texture value
+from each mipmap. The final texture value is a weighted average of those
+two values.
+
+@item @code{GL_LINEAR_MIPMAP_LINEAR}
+Chooses the two mipmaps that most closely match the size of the pixel
+being textured and uses the @code{GL_LINEAR} criterion (a weighted
+average of the four texture elements that are closest to the center of
+the pixel) to produce a texture value from each mipmap. The final
+texture value is a weighted average of those two values.
+
+@end table
+
+@table @asis
+@item @code{GL_NEAREST}
+Returns the value of the texture element that is nearest (in Manhattan
+distance) to the center of the pixel being textured.
+
+@item @code{GL_LINEAR}
+Returns the weighted average of the four texture elements that are
+closest to the center of the pixel being textured. These can include
+border texture elements, depending on the values of
+@code{GL_TEXTURE_WRAP_S} and @code{GL_TEXTURE_WRAP_T}, and on the exact
+mapping.
+
+@end table
+
+
+
+@table @asis
+@item @code{GL_TEXTURE_MIN_LOD}
+Sets the minimum level-of-detail parameter. This floating-point value
+limits the selection of highest resolution mipmap (lowest mipmap level).
+The initial value is -1000.
+
+@end table
+
+
+
+@table @asis
+@item @code{GL_TEXTURE_MAX_LOD}
+Sets the maximum level-of-detail parameter. This floating-point value
+limits the selection of the lowest resolution mipmap (highest mipmap
+level). The initial value is 1000.
+
+@end table
+
+
+
+@table @asis
+@item @code{GL_TEXTURE_BASE_LEVEL}
+Specifies the index of the lowest defined mipmap level. This is an
+integer value. The initial value is 0.
+
+@end table
+
+
+
+@table @asis
+@item @code{GL_TEXTURE_MAX_LEVEL}
+Sets the index of the highest defined mipmap level. This is an integer
+value. The initial value is 1000.
+
+@end table
+
+
+
+@table @asis
+@item @code{GL_TEXTURE_WRAP_S}
+Sets the wrap parameter for texture coordinate @math{@var{s}} to either
+@code{GL_CLAMP}, @code{GL_CLAMP_TO_BORDER}, @code{GL_CLAMP_TO_EDGE},
+@code{GL_MIRRORED_REPEAT}, or @code{GL_REPEAT}. @code{GL_CLAMP} causes
+@math{@var{s}} coordinates to be clamped to the range [0,1] and is
+useful for preventing wrapping artifacts when mapping a single image
+onto an object. @code{GL_CLAMP_TO_BORDER} causes the @math{@var{s}}
+coordinate to be clamped to the range
+@math{[-1/2@var{N},,1+1/2@var{N},]}, where @math{@var{N}} is the size of
+the texture in the direction of clamping.@code{GL_CLAMP_TO_EDGE} causes
+@math{@var{s}} coordinates to be clamped to the range
+@math{[1/2@var{N},,1-1/2@var{N},]}, where @math{@var{N}} is the size of
+the texture in the direction of clamping. @code{GL_REPEAT} causes the
+integer part of the @math{@var{s}} coordinate to be ignored; the GL uses
+only the fractional part, thereby creating a repeating pattern.
+@code{GL_MIRRORED_REPEAT} causes the @math{@var{s}} coordinate to be set
+to the fractional part of the texture coordinate if the integer part of
+@math{@var{s}} is even; if the integer part of @math{@var{s}} is odd,
+then the @math{@var{s}} texture coordinate is set to
+@math{1-@var{frac}(@var{s},)}, where @math{@var{frac}(@var{s},)}
+represents the fractional part of @math{@var{s}}. Border texture
+elements are accessed only if wrapping is set to @code{GL_CLAMP} or
+@code{GL_CLAMP_TO_BORDER}. Initially, @code{GL_TEXTURE_WRAP_S} is set to
+@code{GL_REPEAT}.
+
+@end table
+
+
+
+@table @asis
+@item @code{GL_TEXTURE_WRAP_T}
+Sets the wrap parameter for texture coordinate @math{@var{t}} to either
+@code{GL_CLAMP}, @code{GL_CLAMP_TO_BORDER}, @code{GL_CLAMP_TO_EDGE},
+@code{GL_MIRRORED_REPEAT}, or @code{GL_REPEAT}. See the discussion under
+@code{GL_TEXTURE_WRAP_S}. Initially, @code{GL_TEXTURE_WRAP_T} is set to
+@code{GL_REPEAT}.
+
+@item @code{GL_TEXTURE_WRAP_R}
+Sets the wrap parameter for texture coordinate @math{@var{r}} to either
+@code{GL_CLAMP}, @code{GL_CLAMP_TO_BORDER}, @code{GL_CLAMP_TO_EDGE},
+@code{GL_MIRRORED_REPEAT}, or @code{GL_REPEAT}. See the discussion under
+@code{GL_TEXTURE_WRAP_S}. Initially, @code{GL_TEXTURE_WRAP_R} is set to
+@code{GL_REPEAT}.
+
+@item @code{GL_TEXTURE_BORDER_COLOR}
+Sets a border color. @var{params} contains four values that comprise the
+RGBA color of the texture border. Integer color components are
+interpreted linearly such that the most positive integer maps to 1.0,
+and the most negative integer maps to -1.0. The values are clamped to
+the range [0,1] when they are specified. Initially, the border color is
+(0, 0, 0, 0).
+
+@item @code{GL_TEXTURE_PRIORITY}
+Specifies the texture residence priority of the currently bound texture.
+Permissible values are in the range @math{[0,1]}. See
+@code{glPrioritizeTextures} and @code{glBindTexture} for more
+information.
+
+@item @code{GL_TEXTURE_COMPARE_MODE}
+Specifies the texture comparison mode for currently bound depth
+textures. That is, a texture whose internal format is
+@code{GL_DEPTH_COMPONENT_*}; see @code{glTexImage2D}) Permissible values
+are:
+
+@item @code{GL_TEXTURE_COMPARE_FUNC}
+Specifies the comparison operator used when
+@code{GL_TEXTURE_COMPARE_MODE} is set to @code{GL_COMPARE_R_TO_TEXTURE}.
+Permissible values are: where @math{@var{r}} is the current interpolated
+texture coordinate, and @math{@var{D}_@var{t}} is the depth texture
+value sampled from the currently bound depth texture.
+@math{@var{result}} is assigned to the either the luminance, intensity,
+or alpha (as specified by @code{GL_DEPTH_TEXTURE_MODE}.)
+
+@item @code{GL_DEPTH_TEXTURE_MODE}
+Specifies a single symbolic constant indicating how depth values should
+be treated during filtering and texture application. Accepted values are
+@code{GL_LUMINANCE}, @code{GL_INTENSITY}, and @code{GL_ALPHA}. The
+initial value is @code{GL_LUMINANCE}.
+
+@item @code{GL_GENERATE_MIPMAP}
+Specifies a boolean value that indicates if all levels of a mipmap array
+should be automatically updated when any modification to the base level
+mipmap is done. The initial value is @code{GL_FALSE}.
+
+@end table
+
+@table @asis
+@item @code{GL_COMPARE_R_TO_TEXTURE}
+Specifies that the interpolated and clamped @math{@var{r}} texture
+coordinate should be compared to the value in the currently bound depth
+texture. See the discussion of @code{GL_TEXTURE_COMPARE_FUNC} for
+details of how the comparison is evaluated. The result of the comparison
+is assigned to luminance, intensity, or alpha (as specified by
+@code{GL_DEPTH_TEXTURE_MODE}).
+
+@item @code{GL_NONE}
+Specifies that the luminance, intensity, or alpha (as specified by
+@code{GL_DEPTH_TEXTURE_MODE}) should be assigned the appropriate value
+from the currently bound depth texture.
+
+@end table
+
+@table @asis
+@item @strong{Texture Comparison Function}
+@strong{Computed result}
+
+@item @code{GL_LEQUAL}
+@math{@var{result}=@{(1.0), (0.0) (@var{r}<=@var{D}_@var{t},),
+(@var{r}>@var{D}_@var{t},),}
+
+@item @code{GL_GEQUAL}
+@math{@var{result}=@{(1.0), (0.0) (@var{r}>=@var{D}_@var{t},),
+(@var{r}<@var{D}_@var{t},),}
+
+@item @code{GL_LESS}
+@math{@var{result}=@{(1.0), (0.0) (@var{r}<@var{D}_@var{t},),
+(@var{r}>=@var{D}_@var{t},),}
+
+@item @code{GL_GREATER}
+@math{@var{result}=@{(1.0), (0.0) (@var{r}>@var{D}_@var{t},),
+(@var{r}<=@var{D}_@var{t},),}
+
+@item @code{GL_EQUAL}
+@math{@var{result}=@{(1.0), (0.0) (@var{r}=@var{D}_@var{t},),
+(@var{r}≠@var{D}_@var{t},),}
+
+@item @code{GL_NOTEQUAL}
+@math{@var{result}=@{(1.0), (0.0) (@var{r}≠@var{D}_@var{t},),
+(@var{r}=@var{D}_@var{t},),}
+
+@item @code{GL_ALWAYS}
+@math{@var{result}=@code{1.0}}
+
+@item @code{GL_NEVER}
+@math{@var{result}=@code{0.0}}
+
+@end table
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{target} or @var{pname} is
+not one of the accepted defined values.
+
+@code{GL_INVALID_ENUM} is generated if @var{params} should have a
+defined constant value (based on the value of @var{pname}) and does not.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glTexParameter} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glTexSubImage1D
+@heading specify a one-dimensional texture subimage
+@heading Parameters
+@table @asis
+@item @var{target}
+Specifies the target texture. Must be @code{GL_TEXTURE_1D}.
+
+@item @var{level}
+Specifies the level-of-detail number. Level 0 is the base image level.
+Level @var{n} is the @var{n}th mipmap reduction image.
+
+@item @var{xoffset}
+Specifies a texel offset in the x direction within the texture array.
+
+@item @var{width}
+Specifies the width of the texture subimage.
+
+@item @var{format}
+Specifies the format of the pixel data. The following symbolic values
+are accepted: @code{GL_COLOR_INDEX}, @code{GL_RED}, @code{GL_GREEN},
+@code{GL_BLUE}, @code{GL_ALPHA}, @code{GL_RGB}, @code{GL_BGR},
+@code{GL_RGBA}, @code{GL_BGRA}, @code{GL_LUMINANCE}, and
+@code{GL_LUMINANCE_ALPHA}.
+
+@item @var{type}
+Specifies the data type of the pixel data. The following symbolic values
+are accepted: @code{GL_UNSIGNED_BYTE}, @code{GL_BYTE}, @code{GL_BITMAP},
+@code{GL_UNSIGNED_SHORT}, @code{GL_SHORT}, @code{GL_UNSIGNED_INT},
+@code{GL_INT}, @code{GL_FLOAT}, @code{GL_UNSIGNED_BYTE_3_3_2},
+@code{GL_UNSIGNED_BYTE_2_3_3_REV}, @code{GL_UNSIGNED_SHORT_5_6_5},
+@code{GL_UNSIGNED_SHORT_5_6_5_REV}, @code{GL_UNSIGNED_SHORT_4_4_4_4},
+@code{GL_UNSIGNED_SHORT_4_4_4_4_REV}, @code{GL_UNSIGNED_SHORT_5_5_5_1},
+@code{GL_UNSIGNED_SHORT_1_5_5_5_REV}, @code{GL_UNSIGNED_INT_8_8_8_8},
+@code{GL_UNSIGNED_INT_8_8_8_8_REV}, @code{GL_UNSIGNED_INT_10_10_10_2},
+and @code{GL_UNSIGNED_INT_2_10_10_10_REV}.
+
+@item @var{data}
+Specifies a pointer to the image data in memory.
+
+@end table
+
+@heading Description
+Texturing maps a portion of a specified texture image onto each
+graphical primitive for which texturing is enabled. To enable or disable
+one-dimensional texturing, call @code{glEnable} and @code{glDisable}
+with argument @code{GL_TEXTURE_1D}.
+
+@code{glTexSubImage1D} redefines a contiguous subregion of an existing
+one-dimensional texture image. The texels referenced by @var{data}
+replace the portion of the existing texture array with x indices
+@var{xoffset} and @math{@var{xoffset}+@var{width}-1}, inclusive. This
+region may not include any texels outside the range of the texture array
+as it was originally specified. It is not an error to specify a
+subtexture with width of 0, but such a specification has no effect.
+
+If a non-zero named buffer object is bound to the
+@code{GL_PIXEL_UNPACK_BUFFER} target (see @code{glBindBuffer}) while a
+texture image is specified, @var{data} is treated as a byte offset into
+the buffer object's data store.
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{target} is not one of the
+allowable values.
+
+@code{GL_INVALID_ENUM} is generated if @var{format} is not an accepted
+format constant.
+
+@code{GL_INVALID_ENUM} is generated if @var{type} is not a type
+constant.
+
+@code{GL_INVALID_ENUM} is generated if @var{type} is @code{GL_BITMAP}
+and @var{format} is not @code{GL_COLOR_INDEX}.
+
+@code{GL_INVALID_VALUE} is generated if @var{level} is less than 0.
+
+@code{GL_INVALID_VALUE} may be generated if @var{level} is greater than
+@math{@var{log}_2}@var{max}, where @var{max} is the returned value of
+@code{GL_MAX_TEXTURE_SIZE}.
+
+@code{GL_INVALID_VALUE} is generated if @math{@var{xoffset}<-@var{b}},
+or if @math{(@var{xoffset}+@var{width},)>(@var{w}-@var{b},)}, where
+@math{@var{w}} is the @code{GL_TEXTURE_WIDTH}, and @math{@var{b}} is the
+width of the @code{GL_TEXTURE_BORDER} of the texture image being
+modified. Note that @math{@var{w}} includes twice the border width.
+
+@code{GL_INVALID_VALUE} is generated if @var{width} is less than 0.
+
+@code{GL_INVALID_OPERATION} is generated if the texture array has not
+been defined by a previous @code{glTexImage1D} operation.
+
+@code{GL_INVALID_OPERATION} is generated if @var{type} is one of
+@code{GL_UNSIGNED_BYTE_3_3_2}, @code{GL_UNSIGNED_BYTE_2_3_3_REV},
+@code{GL_UNSIGNED_SHORT_5_6_5}, or @code{GL_UNSIGNED_SHORT_5_6_5_REV}
+and @var{format} is not @code{GL_RGB}.
+
+@code{GL_INVALID_OPERATION} is generated if @var{type} is one of
+@code{GL_UNSIGNED_SHORT_4_4_4_4}, @code{GL_UNSIGNED_SHORT_4_4_4_4_REV},
+@code{GL_UNSIGNED_SHORT_5_5_5_1}, @code{GL_UNSIGNED_SHORT_1_5_5_5_REV},
+@code{GL_UNSIGNED_INT_8_8_8_8}, @code{GL_UNSIGNED_INT_8_8_8_8_REV},
+@code{GL_UNSIGNED_INT_10_10_10_2}, or
+@code{GL_UNSIGNED_INT_2_10_10_10_REV} and @var{format} is neither
+@code{GL_RGBA} nor @code{GL_BGRA}.
+
+@code{GL_INVALID_OPERATION} is generated if a non-zero buffer object
+name is bound to the @code{GL_PIXEL_UNPACK_BUFFER} target and the buffer
+object's data store is currently mapped.
+
+@code{GL_INVALID_OPERATION} is generated if a non-zero buffer object
+name is bound to the @code{GL_PIXEL_UNPACK_BUFFER} target and the data
+would be unpacked from the buffer object such that the memory reads
+required would exceed the data store size.
+
+@code{GL_INVALID_OPERATION} is generated if a non-zero buffer object
+name is bound to the @code{GL_PIXEL_UNPACK_BUFFER} target and @var{data}
+is not evenly divisible into the number of bytes needed to store in
+memory a datum indicated by @var{type}.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glTexSubImage1D} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glTexSubImage2D
+@heading specify a two-dimensional texture subimage
+@heading Parameters
+@table @asis
+@item @var{target}
+Specifies the target texture. Must be @code{GL_TEXTURE_2D},
+@code{GL_TEXTURE_CUBE_MAP_POSITIVE_X},
+@code{GL_TEXTURE_CUBE_MAP_NEGATIVE_X},
+@code{GL_TEXTURE_CUBE_MAP_POSITIVE_Y},
+@code{GL_TEXTURE_CUBE_MAP_NEGATIVE_Y},
+@code{GL_TEXTURE_CUBE_MAP_POSITIVE_Z}, or
+@code{GL_TEXTURE_CUBE_MAP_NEGATIVE_Z}.
+
+@item @var{level}
+Specifies the level-of-detail number. Level 0 is the base image level.
+Level @var{n} is the @var{n}th mipmap reduction image.
+
+@item @var{xoffset}
+Specifies a texel offset in the x direction within the texture array.
+
+@item @var{yoffset}
+Specifies a texel offset in the y direction within the texture array.
+
+@item @var{width}
+Specifies the width of the texture subimage.
+
+@item @var{height}
+Specifies the height of the texture subimage.
+
+@item @var{format}
+Specifies the format of the pixel data. The following symbolic values
+are accepted: @code{GL_COLOR_INDEX}, @code{GL_RED}, @code{GL_GREEN},
+@code{GL_BLUE}, @code{GL_ALPHA}, @code{GL_RGB}, @code{GL_BGR},
+@code{GL_RGBA}, @code{GL_BGRA}, @code{GL_LUMINANCE}, and
+@code{GL_LUMINANCE_ALPHA}.
+
+@item @var{type}
+Specifies the data type of the pixel data. The following symbolic values
+are accepted: @code{GL_UNSIGNED_BYTE}, @code{GL_BYTE}, @code{GL_BITMAP},
+@code{GL_UNSIGNED_SHORT}, @code{GL_SHORT}, @code{GL_UNSIGNED_INT},
+@code{GL_INT}, @code{GL_FLOAT}, @code{GL_UNSIGNED_BYTE_3_3_2},
+@code{GL_UNSIGNED_BYTE_2_3_3_REV}, @code{GL_UNSIGNED_SHORT_5_6_5},
+@code{GL_UNSIGNED_SHORT_5_6_5_REV}, @code{GL_UNSIGNED_SHORT_4_4_4_4},
+@code{GL_UNSIGNED_SHORT_4_4_4_4_REV}, @code{GL_UNSIGNED_SHORT_5_5_5_1},
+@code{GL_UNSIGNED_SHORT_1_5_5_5_REV}, @code{GL_UNSIGNED_INT_8_8_8_8},
+@code{GL_UNSIGNED_INT_8_8_8_8_REV}, @code{GL_UNSIGNED_INT_10_10_10_2},
+and @code{GL_UNSIGNED_INT_2_10_10_10_REV}.
+
+@item @var{data}
+Specifies a pointer to the image data in memory.
+
+@end table
+
+@heading Description
+Texturing maps a portion of a specified texture image onto each
+graphical primitive for which texturing is enabled. To enable and
+disable two-dimensional texturing, call @code{glEnable} and
+@code{glDisable} with argument @code{GL_TEXTURE_2D}.
+
+@code{glTexSubImage2D} redefines a contiguous subregion of an existing
+two-dimensional texture image. The texels referenced by @var{data}
+replace the portion of the existing texture array with x indices
+@var{xoffset} and @math{@var{xoffset}+@var{width}-1}, inclusive, and y
+indices @var{yoffset} and @math{@var{yoffset}+@var{height}-1},
+inclusive. This region may not include any texels outside the range of
+the texture array as it was originally specified. It is not an error to
+specify a subtexture with zero width or height, but such a specification
+has no effect.
+
+If a non-zero named buffer object is bound to the
+@code{GL_PIXEL_UNPACK_BUFFER} target (see @code{glBindBuffer}) while a
+texture image is specified, @var{data} is treated as a byte offset into
+the buffer object's data store.
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if @var{target} is not
+@code{GL_TEXTURE_2D}, @code{GL_TEXTURE_CUBE_MAP_POSITIVE_X},
+@code{GL_TEXTURE_CUBE_MAP_NEGATIVE_X},
+@code{GL_TEXTURE_CUBE_MAP_POSITIVE_Y},
+@code{GL_TEXTURE_CUBE_MAP_NEGATIVE_Y},
+@code{GL_TEXTURE_CUBE_MAP_POSITIVE_Z}, or
+@code{GL_TEXTURE_CUBE_MAP_NEGATIVE_Z}.
+
+@code{GL_INVALID_ENUM} is generated if @var{format} is not an accepted
+format constant.
+
+@code{GL_INVALID_ENUM} is generated if @var{type} is not a type
+constant.
+
+@code{GL_INVALID_ENUM} is generated if @var{type} is @code{GL_BITMAP}
+and @var{format} is not @code{GL_COLOR_INDEX}.
+
+@code{GL_INVALID_VALUE} is generated if @var{level} is less than 0.
+
+@code{GL_INVALID_VALUE} may be generated if @var{level} is greater than
+@math{@var{log}_2}@var{max}, where @var{max} is the returned value of
+@code{GL_MAX_TEXTURE_SIZE}.
+
+@code{GL_INVALID_VALUE} is generated if @math{@var{xoffset}<-@var{b}},
+@math{(@var{xoffset}+@var{width},)>(@var{w}-@var{b},)},
+@math{@var{yoffset}<-@var{b}}, or
+@math{(@var{yoffset}+@var{height},)>(@var{h}-@var{b},)}, where
+@math{@var{w}} is the @code{GL_TEXTURE_WIDTH}, @math{@var{h}} is the
+@code{GL_TEXTURE_HEIGHT}, and @math{@var{b}} is the border width of the
+texture image being modified. Note that @math{@var{w}} and
+@math{@var{h}} include twice the border width.
+
+@code{GL_INVALID_VALUE} is generated if @var{width} or @var{height} is
+less than 0.
+
+@code{GL_INVALID_OPERATION} is generated if the texture array has not
+been defined by a previous @code{glTexImage2D} operation.
+
+@code{GL_INVALID_OPERATION} is generated if @var{type} is one of
+@code{GL_UNSIGNED_BYTE_3_3_2}, @code{GL_UNSIGNED_BYTE_2_3_3_REV},
+@code{GL_UNSIGNED_SHORT_5_6_5}, or @code{GL_UNSIGNED_SHORT_5_6_5_REV}
+and @var{format} is not @code{GL_RGB}.
+
+@code{GL_INVALID_OPERATION} is generated if @var{type} is one of
+@code{GL_UNSIGNED_SHORT_4_4_4_4}, @code{GL_UNSIGNED_SHORT_4_4_4_4_REV},
+@code{GL_UNSIGNED_SHORT_5_5_5_1}, @code{GL_UNSIGNED_SHORT_1_5_5_5_REV},
+@code{GL_UNSIGNED_INT_8_8_8_8}, @code{GL_UNSIGNED_INT_8_8_8_8_REV},
+@code{GL_UNSIGNED_INT_10_10_10_2}, or
+@code{GL_UNSIGNED_INT_2_10_10_10_REV} and @var{format} is neither
+@code{GL_RGBA} nor @code{GL_BGRA}.
+
+@code{GL_INVALID_OPERATION} is generated if a non-zero buffer object
+name is bound to the @code{GL_PIXEL_UNPACK_BUFFER} target and the buffer
+object's data store is currently mapped.
+
+@code{GL_INVALID_OPERATION} is generated if a non-zero buffer object
+name is bound to the @code{GL_PIXEL_UNPACK_BUFFER} target and the data
+would be unpacked from the buffer object such that the memory reads
+required would exceed the data store size.
+
+@code{GL_INVALID_OPERATION} is generated if a non-zero buffer object
+name is bound to the @code{GL_PIXEL_UNPACK_BUFFER} target and @var{data}
+is not evenly divisible into the number of bytes needed to store in
+memory a datum indicated by @var{type}.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glTexSubImage2D} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glTexSubImage3D
+@heading specify a three-dimensional texture subimage
+@heading Parameters
+@table @asis
+@item @var{target}
+Specifies the target texture. Must be @code{GL_TEXTURE_3D}.
+
+@item @var{level}
+Specifies the level-of-detail number. Level 0 is the base image level.
+Level @var{n} is the @var{n}th mipmap reduction image.
+
+@item @var{xoffset}
+Specifies a texel offset in the x direction within the texture array.
+
+@item @var{yoffset}
+Specifies a texel offset in the y direction within the texture array.
+
+@item @var{zoffset}
+Specifies a texel offset in the z direction within the texture array.
+
+@item @var{width}
+Specifies the width of the texture subimage.
+
+@item @var{height}
+Specifies the height of the texture subimage.
+
+@item @var{depth}
+Specifies the depth of the texture subimage.
+
+@item @var{format}
+Specifies the format of the pixel data. The following symbolic values
+are accepted: @code{GL_COLOR_INDEX}, @code{GL_RED}, @code{GL_GREEN},
+@code{GL_BLUE}, @code{GL_ALPHA}, @code{GL_RGB}, @code{GL_BGR},
+@code{GL_RGBA}, @code{GL_BGRA}, @code{GL_LUMINANCE}, and
+@code{GL_LUMINANCE_ALPHA}.
+
+@item @var{type}
+Specifies the data type of the pixel data. The following symbolic values
+are accepted: @code{GL_UNSIGNED_BYTE}, @code{GL_BYTE}, @code{GL_BITMAP},
+@code{GL_UNSIGNED_SHORT}, @code{GL_SHORT}, @code{GL_UNSIGNED_INT},
+@code{GL_INT}, @code{GL_FLOAT}, @code{GL_UNSIGNED_BYTE_3_3_2},
+@code{GL_UNSIGNED_BYTE_2_3_3_REV}, @code{GL_UNSIGNED_SHORT_5_6_5},
+@code{GL_UNSIGNED_SHORT_5_6_5_REV}, @code{GL_UNSIGNED_SHORT_4_4_4_4},
+@code{GL_UNSIGNED_SHORT_4_4_4_4_REV}, @code{GL_UNSIGNED_SHORT_5_5_5_1},
+@code{GL_UNSIGNED_SHORT_1_5_5_5_REV}, @code{GL_UNSIGNED_INT_8_8_8_8},
+@code{GL_UNSIGNED_INT_8_8_8_8_REV}, @code{GL_UNSIGNED_INT_10_10_10_2},
+and @code{GL_UNSIGNED_INT_2_10_10_10_REV}.
+
+@item @var{data}
+Specifies a pointer to the image data in memory.
+
+@end table
+
+@heading Description
+Texturing maps a portion of a specified texture image onto each
+graphical primitive for which texturing is enabled. To enable and
+disable three-dimensional texturing, call @code{glEnable} and
+@code{glDisable} with argument @code{GL_TEXTURE_3D}.
+
+@code{glTexSubImage3D} redefines a contiguous subregion of an existing
+three-dimensional texture image. The texels referenced by @var{data}
+replace the portion of the existing texture array with x indices
+@var{xoffset} and @math{@var{xoffset}+@var{width}-1}, inclusive, y
+indices @var{yoffset} and @math{@var{yoffset}+@var{height}-1},
+inclusive, and z indices @var{zoffset} and
+@math{@var{zoffset}+@var{depth}-1}, inclusive. This region may not
+include any texels outside the range of the texture array as it was
+originally specified. It is not an error to specify a subtexture with
+zero width, height, or depth but such a specification has no effect.
+
+If a non-zero named buffer object is bound to the
+@code{GL_PIXEL_UNPACK_BUFFER} target (see @code{glBindBuffer}) while a
+texture image is specified, @var{data} is treated as a byte offset into
+the buffer object's data store.
+
+@heading Errors
+@code{GL_INVALID_ENUM} is generated if /@var{target} is not
+@code{GL_TEXTURE_3D}.
+
+@code{GL_INVALID_ENUM} is generated if @var{format} is not an accepted
+format constant.
+
+@code{GL_INVALID_ENUM} is generated if @var{type} is not a type
+constant.
+
+@code{GL_INVALID_ENUM} is generated if @var{type} is @code{GL_BITMAP}
+and @var{format} is not @code{GL_COLOR_INDEX}.
+
+@code{GL_INVALID_VALUE} is generated if @var{level} is less than 0.
+
+@code{GL_INVALID_VALUE} may be generated if @var{level} is greater than
+@math{@var{log}_2}@var{max}, where @var{max} is the returned value of
+@code{GL_MAX_TEXTURE_SIZE}.
+
+@code{GL_INVALID_VALUE} is generated if @math{@var{xoffset}<-@var{b}},
+@math{(@var{xoffset}+@var{width},)>(@var{w}-@var{b},)},
+@math{@var{yoffset}<-@var{b}}, or
+@math{(@var{yoffset}+@var{height},)>(@var{h}-@var{b},)}, or
+@math{@var{zoffset}<-@var{b}}, or
+@math{(@var{zoffset}+@var{depth},)>(@var{d}-@var{b},)}, where
+@math{@var{w}} is the @code{GL_TEXTURE_WIDTH}, @math{@var{h}} is the
+@code{GL_TEXTURE_HEIGHT}, @math{@var{d}} is the @code{GL_TEXTURE_DEPTH}
+and @math{@var{b}} is the border width of the texture image being
+modified. Note that @math{@var{w}}, @math{@var{h}}, and @math{@var{d}}
+include twice the border width.
+
+@code{GL_INVALID_VALUE} is generated if @var{width}, @var{height}, or
+@var{depth} is less than 0.
+
+@code{GL_INVALID_OPERATION} is generated if the texture array has not
+been defined by a previous @code{glTexImage3D} operation.
+
+@code{GL_INVALID_OPERATION} is generated if @var{type} is one of
+@code{GL_UNSIGNED_BYTE_3_3_2}, @code{GL_UNSIGNED_BYTE_2_3_3_REV},
+@code{GL_UNSIGNED_SHORT_5_6_5}, or @code{GL_UNSIGNED_SHORT_5_6_5_REV}
+and @var{format} is not @code{GL_RGB}.
+
+@code{GL_INVALID_OPERATION} is generated if @var{type} is one of
+@code{GL_UNSIGNED_SHORT_4_4_4_4}, @code{GL_UNSIGNED_SHORT_4_4_4_4_REV},
+@code{GL_UNSIGNED_SHORT_5_5_5_1}, @code{GL_UNSIGNED_SHORT_1_5_5_5_REV},
+@code{GL_UNSIGNED_INT_8_8_8_8}, @code{GL_UNSIGNED_INT_8_8_8_8_REV},
+@code{GL_UNSIGNED_INT_10_10_10_2}, or
+@code{GL_UNSIGNED_INT_2_10_10_10_REV} and @var{format} is neither
+@code{GL_RGBA} nor @code{GL_BGRA}.
+
+@code{GL_INVALID_OPERATION} is generated if a non-zero buffer object
+name is bound to the @code{GL_PIXEL_UNPACK_BUFFER} target and the buffer
+object's data store is currently mapped.
+
+@code{GL_INVALID_OPERATION} is generated if a non-zero buffer object
+name is bound to the @code{GL_PIXEL_UNPACK_BUFFER} target and the data
+would be unpacked from the buffer object such that the memory reads
+required would exceed the data store size.
+
+@code{GL_INVALID_OPERATION} is generated if a non-zero buffer object
+name is bound to the @code{GL_PIXEL_UNPACK_BUFFER} target and @var{data}
+is not evenly divisible into the number of bytes needed to store in
+memory a datum indicated by @var{type}.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glTexSubImage3D} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glTranslate
+@heading multiply the current matrix by a translation matrix
+@heading Parameters
+@table @asis
+@item @var{x}
+@itemx @var{y}
+@itemx @var{z}
+Specify the @var{x}, @var{y}, and @var{z} coordinates of a translation
+vector.
+
+@end table
+
+@heading Description
+@code{glTranslate} produces a translation by
+@math{(@var{x},@var{y}@var{z})}. The current matrix (see
+@code{glMatrixMode}) is multiplied by this translation matrix, with the
+product replacing the current matrix, as if @code{glMultMatrix} were
+called with the following matrix for its argument:
+
+@math{((1 0 0 @var{x}), (0 1 0 @var{y}), (0 0 1 @var{z}), (0 0 0 1),)}
+
+
+
+If the matrix mode is either @code{GL_MODELVIEW} or
+@code{GL_PROJECTION}, all objects drawn after a call to
+@code{glTranslate} are translated.
+
+Use @code{glPushMatrix} and @code{glPopMatrix} to save and restore the
+untranslated coordinate system.
+
+@heading Errors
+@code{GL_INVALID_OPERATION} is generated if @code{glTranslate} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glUniform1f
+@heading Specify the value of a uniform variable for the current program object
+@heading Parameters
+@table @asis
+@item @var{location}
+Specifies the location of the uniform variable to be modified.
+
+@item @var{v0}, @var{v1}, @var{v2}, @var{v3}
+Specifies the new values to be used for the specified uniform variable.
+
+@end table
+
+@heading Description
+@code{glUniform} modifies the value of a uniform variable or a uniform
+variable array. The location of the uniform variable to be modified is
+specified by @var{location}, which should be a value returned by
+@code{glGetUniformLocation}. @code{glUniform} operates on the program
+object that was made part of current state by calling
+@code{glUseProgram}.
+
+The commands @code{glUniform@{1|2|3|4@}@{f|i@}} are used to change the
+value of the uniform variable specified by @var{location} using the
+values passed as arguments. The number specified in the command should
+match the number of components in the data type of the specified uniform
+variable (e.g., @code{1} for float, int, bool; @code{2} for vec2, ivec2,
+bvec2, etc.). The suffix @code{f} indicates that floating-point values
+are being passed; the suffix @code{i} indicates that integer values are
+being passed, and this type should also match the data type of the
+specified uniform variable. The @code{i} variants of this function
+should be used to provide values for uniform variables defined as int,
+ivec2, ivec3, ivec4, or arrays of these. The @code{f} variants should be
+used to provide values for uniform variables of type float, vec2, vec3,
+vec4, or arrays of these. Either the @code{i} or the @code{f} variants
+may be used to provide values for uniform variables of type bool, bvec2,
+bvec3, bvec4, or arrays of these. The uniform variable will be set to
+false if the input value is 0 or 0.0f, and it will be set to true
+otherwise.
+
+All active uniform variables defined in a program object are initialized
+to 0 when the program object is linked successfully. They retain the
+values assigned to them by a call to @code{glUniform } until the next
+successful link operation occurs on the program object, when they are
+once again initialized to 0.
+
+The commands @code{glUniform@{1|2|3|4@}@{f|i@}v} can be used to modify a
+single uniform variable or a uniform variable array. These commands pass
+a count and a pointer to the values to be loaded into a uniform variable
+or a uniform variable array. A count of 1 should be used if modifying
+the value of a single uniform variable, and a count of 1 or greater can
+be used to modify an entire array or part of an array. When loading
+@var{n} elements starting at an arbitrary position @var{m} in a uniform
+variable array, elements @var{m} + @var{n} - 1 in the array will be
+replaced with the new values. If @var{m} + @var{n} - 1 is larger than
+the size of the uniform variable array, values for all array elements
+beyond the end of the array will be ignored. The number specified in the
+name of the command indicates the number of components for each element
+in @var{value}, and it should match the number of components in the data
+type of the specified uniform variable (e.g., @code{1} for float, int,
+bool; @code{2} for vec2, ivec2, bvec2, etc.). The data type specified in
+the name of the command must match the data type for the specified
+uniform variable as described previously for
+@code{glUniform@{1|2|3|4@}@{f|i@}}.
+
+For uniform variable arrays, each element of the array is considered to
+be of the type indicated in the name of the command (e.g.,
+@code{glUniform3f} or @code{glUniform3fv} can be used to load a uniform
+variable array of type vec3). The number of elements of the uniform
+variable array to be modified is specified by @var{count}
+
+The commands @code{glUniformMatrix@{2|3|4|2x3|3x2|2x4|4x2|3x4|4x3@}fv}
+are used to modify a matrix or an array of matrices. The numbers in the
+command name are interpreted as the dimensionality of the matrix. The
+number @code{2} indicates a 2 × 2 matrix (i.e., 4 values), the number
+@code{3} indicates a 3 × 3 matrix (i.e., 9 values), and the number
+@code{4} indicates a 4 × 4 matrix (i.e., 16 values). Non-square matrix
+dimensionality is explicit, with the first number representing the
+number of columns and the second number representing the number of rows.
+For example, @code{2x4} indicates a 2 × 4 matrix with 2 columns and 4
+rows (i.e., 8 values). If @var{transpose} is @code{GL_FALSE}, each
+matrix is assumed to be supplied in column major order. If
+@var{transpose} is @code{GL_TRUE}, each matrix is assumed to be supplied
+in row major order. The @var{count} argument indicates the number of
+matrices to be passed. A count of 1 should be used if modifying the
+value of a single matrix, and a count greater than 1 can be used to
+modify an array of matrices.
+
+@heading Errors
+@code{GL_INVALID_OPERATION} is generated if there is no current program
+object.
+
+@code{GL_INVALID_OPERATION} is generated if the size of the uniform
+variable declared in the shader does not match the size indicated by the
+@code{glUniform} command.
+
+@code{GL_INVALID_OPERATION} is generated if one of the integer variants
+of this function is used to load a uniform variable of type float, vec2,
+vec3, vec4, or an array of these, or if one of the floating-point
+variants of this function is used to load a uniform variable of type
+int, ivec2, ivec3, or ivec4, or an array of these.
+
+@code{GL_INVALID_OPERATION} is generated if @var{location} is an invalid
+uniform location for the current program object and @var{location} is
+not equal to -1.
+
+@code{GL_INVALID_VALUE} is generated if @var{count} is less than 0.
+
+@code{GL_INVALID_OPERATION} is generated if @var{count} is greater than
+1 and the indicated uniform variable is not an array variable.
+
+@code{GL_INVALID_OPERATION} is generated if a sampler is loaded using a
+command other than @code{glUniform1i} and @code{glUniform1iv}.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glUniform} is executed
+between the execution of @code{glBegin} and the corresponding execution
+of @code{glEnd}.
+
+@end defun
+
+@defun glUseProgram
+@heading Installs a program object as part of current rendering state
+@heading Parameters
+@table @asis
+@item @var{program}
+Specifies the handle of the program object whose executables are to be
+used as part of current rendering state.
+
+@end table
+
+@heading Description
+@code{glUseProgram} installs the program object specified by
+@var{program} as part of current rendering state. One or more
+executables are created in a program object by successfully attaching
+shader objects to it with @code{glAttachShader}, successfully compiling
+the shader objects with @code{glCompileShader}, and successfully linking
+the program object with @code{glLinkProgram}.
+
+A program object will contain an executable that will run on the vertex
+processor if it contains one or more shader objects of type
+@code{GL_VERTEX_SHADER} that have been successfully compiled and linked.
+Similarly, a program object will contain an executable that will run on
+the fragment processor if it contains one or more shader objects of type
+@code{GL_FRAGMENT_SHADER} that have been successfully compiled and
+linked.
+
+Successfully installing an executable on a programmable processor will
+cause the corresponding fixed functionality of OpenGL to be disabled.
+Specifically, if an executable is installed on the vertex processor, the
+OpenGL fixed functionality will be disabled as follows.
+
+@itemize
+@item
+The modelview matrix is not applied to vertex coordinates.
+
+@item
+The projection matrix is not applied to vertex coordinates.
+
+@item
+The texture matrices are not applied to texture coordinates.
+
+@item
+Normals are not transformed to eye coordinates.
+
+@item
+Normals are not rescaled or normalized.
+
+@item
+Normalization of @code{GL_AUTO_NORMAL} evaluated normals is not
+performed.
+
+@item
+Texture coordinates are not generated automatically.
+
+@item
+Per-vertex lighting is not performed.
+
+@item
+Color material computations are not performed.
+
+@item
+Color index lighting is not performed.
+
+@item
+This list also applies when setting the current raster position.
+
+@end itemize
+
+The executable that is installed on the vertex processor is expected to
+implement any or all of the desired functionality from the preceding
+list. Similarly, if an executable is installed on the fragment
+processor, the OpenGL fixed functionality will be disabled as follows.
+
+@itemize
+@item
+Texture environment and texture functions are not applied.
+
+@item
+Texture application is not applied.
+
+@item
+Color sum is not applied.
+
+@item
+Fog is not applied.
+
+@end itemize
+
+Again, the fragment shader that is installed is expected to implement
+any or all of the desired functionality from the preceding list.
+
+While a program object is in use, applications are free to modify
+attached shader objects, compile attached shader objects, attach
+additional shader objects, and detach or delete shader objects. None of
+these operations will affect the executables that are part of the
+current state. However, relinking the program object that is currently
+in use will install the program object as part of the current rendering
+state if the link operation was successful (see @code{glLinkProgram} ).
+If the program object currently in use is relinked unsuccessfully, its
+link status will be set to @code{GL_FALSE}, but the executables and
+associated state will remain part of the current state until a
+subsequent call to @code{glUseProgram} removes it from use. After it is
+removed from use, it cannot be made part of current state until it has
+been successfully relinked.
+
+If @var{program} contains shader objects of type @code{GL_VERTEX_SHADER}
+but it does not contain shader objects of type
+@code{GL_FRAGMENT_SHADER}, an executable will be installed on the vertex
+processor, but fixed functionality will be used for fragment processing.
+Similarly, if @var{program} contains shader objects of type
+@code{GL_FRAGMENT_SHADER} but it does not contain shader objects of type
+@code{GL_VERTEX_SHADER}, an executable will be installed on the fragment
+processor, but fixed functionality will be used for vertex processing.
+If @var{program} is 0, the programmable processors will be disabled, and
+fixed functionality will be used for both vertex and fragment
+processing.
+
+@heading Errors
+@code{GL_INVALID_VALUE} is generated if @var{program} is neither 0 nor a
+value generated by OpenGL.
+
+@code{GL_INVALID_OPERATION} is generated if @var{program} is not a
+program object.
+
+@code{GL_INVALID_OPERATION} is generated if @var{program} could not be
+made part of current state.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glUseProgram} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glValidateProgram
+@heading Validates a program object
+@heading Parameters
+@table @asis
+@item @var{program}
+Specifies the handle of the program object to be validated.
+
+@end table
+
+@heading Description
+@code{glValidateProgram} checks to see whether the executables contained
+in @var{program} can execute given the current OpenGL state. The
+information generated by the validation process will be stored in
+@var{program}'s information log. The validation information may consist
+of an empty string, or it may be a string containing information about
+how the current program object interacts with the rest of current OpenGL
+state. This provides a way for OpenGL implementers to convey more
+information about why the current program is inefficient, suboptimal,
+failing to execute, and so on.
+
+The status of the validation operation will be stored as part of the
+program object's state. This value will be set to @code{GL_TRUE} if the
+validation succeeded, and @code{GL_FALSE} otherwise. It can be queried
+by calling @code{glGetProgram} with arguments @var{program} and
+@code{GL_VALIDATE_STATUS}. If validation is successful, @var{program} is
+guaranteed to execute given the current state. Otherwise, @var{program}
+is guaranteed to not execute.
+
+This function is typically useful only during application development.
+The informational string stored in the information log is completely
+implementation dependent; therefore, an application should not expect
+different OpenGL implementations to produce identical information
+strings.
+
+@heading Errors
+@code{GL_INVALID_VALUE} is generated if @var{program} is not a value
+generated by OpenGL.
+
+@code{GL_INVALID_OPERATION} is generated if @var{program} is not a
+program object.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glValidateProgram} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glVertexAttribPointer
+@heading define an array of generic vertex attribute data
+@heading Parameters
+@table @asis
+@item @var{index}
+Specifies the index of the generic vertex attribute to be modified.
+
+@item @var{size}
+Specifies the number of components per generic vertex attribute. Must be
+1, 2, 3, or 4. The initial value is 4.
+
+@item @var{type}
+Specifies the data type of each component in the array. Symbolic
+constants @code{GL_BYTE}, @code{GL_UNSIGNED_BYTE}, @code{GL_SHORT},
+@code{GL_UNSIGNED_SHORT}, @code{GL_INT}, @code{GL_UNSIGNED_INT},
+@code{GL_FLOAT}, or @code{GL_DOUBLE} are accepted. The initial value is
+@code{GL_FLOAT}.
+
+@item @var{normalized}
+Specifies whether fixed-point data values should be normalized
+(@code{GL_TRUE}) or converted directly as fixed-point values
+(@code{GL_FALSE}) when they are accessed.
+
+@item @var{stride}
+Specifies the byte offset between consecutive generic vertex attributes.
+If @var{stride} is 0, the generic vertex attributes are understood to be
+tightly packed in the array. The initial value is 0.
+
+@item @var{pointer}
+Specifies a pointer to the first component of the first generic vertex
+attribute in the array. The initial value is 0.
+
+@end table
+
+@heading Description
+@code{glVertexAttribPointer} specifies the location and data format of
+the array of generic vertex attributes at index @var{index} to use when
+rendering. @var{size} specifies the number of components per attribute
+and must be 1, 2, 3, or 4. @var{type} specifies the data type of each
+component, and @var{stride} specifies the byte stride from one attribute
+to the next, allowing vertices and attributes to be packed into a single
+array or stored in separate arrays. If set to @code{GL_TRUE},
+@var{normalized} indicates that values stored in an integer format are
+to be mapped to the range [-1,1] (for signed values) or [0,1] (for
+unsigned values) when they are accessed and converted to floating point.
+Otherwise, values will be converted to floats directly without
+normalization.
+
+If a non-zero named buffer object is bound to the @code{GL_ARRAY_BUFFER}
+target (see @code{glBindBuffer}) while a generic vertex attribute array
+is specified, @var{pointer} is treated as a byte offset into the buffer
+object's data store. Also, the buffer object binding
+(@code{GL_ARRAY_BUFFER_BINDING}) is saved as generic vertex attribute
+array client-side state (@code{GL_VERTEX_ATTRIB_ARRAY_BUFFER_BINDING})
+for index @var{index}.
+
+When a generic vertex attribute array is specified, @var{size},
+@var{type}, @var{normalized}, @var{stride}, and @var{pointer} are saved
+as client-side state, in addition to the current vertex array buffer
+object binding.
+
+To enable and disable a generic vertex attribute array, call
+@code{glEnableVertexAttribArray} and @code{glDisableVertexAttribArray}
+with @var{index}. If enabled, the generic vertex attribute array is used
+when @code{glArrayElement}, @code{glDrawArrays},
+@code{glMultiDrawArrays}, @code{glDrawElements},
+@code{glMultiDrawElements}, or @code{glDrawRangeElements} is called.
+
+@heading Errors
+@code{GL_INVALID_VALUE} is generated if @var{index} is greater than or
+equal to @code{GL_MAX_VERTEX_ATTRIBS}.
+
+@code{GL_INVALID_VALUE} is generated if @var{size} is not 1, 2, 3, or 4.
+
+@code{GL_INVALID_ENUM} is generated if @var{type} is not an accepted
+value.
+
+@code{GL_INVALID_VALUE} is generated if @var{stride} is negative.
+
+@end defun
+
+@defun glVertexAttrib
+@heading Specifies the value of a generic vertex attribute
+@heading Parameters
+@table @asis
+@item @var{index}
+Specifies the index of the generic vertex attribute to be modified.
+
+@item @var{v0}, @var{v1}, @var{v2}, @var{v3}
+Specifies the new values to be used for the specified vertex attribute.
+
+@end table
+
+@heading Description
+OpenGL defines a number of standard vertex attributes that applications
+can modify with standard API entry points (color, normal, texture
+coordinates, etc.). The @code{glVertexAttrib} family of entry points
+allows an application to pass generic vertex attributes in numbered
+locations.
+
+Generic attributes are defined as four-component values that are
+organized into an array. The first entry of this array is numbered 0,
+and the size of the array is specified by the implementation-dependent
+constant @code{GL_MAX_VERTEX_ATTRIBS}. Individual elements of this array
+can be modified with a @code{glVertexAttrib} call that specifies the
+index of the element to be modified and a value for that element.
+
+These commands can be used to specify one, two, three, or all four
+components of the generic vertex attribute specified by @var{index}. A
+@code{1} in the name of the command indicates that only one value is
+passed, and it will be used to modify the first component of the generic
+vertex attribute. The second and third components will be set to 0, and
+the fourth component will be set to 1. Similarly, a @code{2} in the name
+of the command indicates that values are provided for the first two
+components, the third component will be set to 0, and the fourth
+component will be set to 1. A @code{3} in the name of the command
+indicates that values are provided for the first three components and
+the fourth component will be set to 1, whereas a @code{4} in the name
+indicates that values are provided for all four components.
+
+The letters @code{s}, @code{f}, @code{i}, @code{d}, @code{ub},
+@code{us}, and @code{ui} indicate whether the arguments are of type
+short, float, int, double, unsigned byte, unsigned short, or unsigned
+int. When @code{v} is appended to the name, the commands can take a
+pointer to an array of such values. The commands containing @code{N}
+indicate that the arguments will be passed as fixed-point values that
+are scaled to a normalized range according to the component conversion
+rules defined by the OpenGL specification. Signed values are understood
+to represent fixed-point values in the range [-1,1], and unsigned values
+are understood to represent fixed-point values in the range [0,1].
+
+OpenGL Shading Language attribute variables are allowed to be of type
+mat2, mat3, or mat4. Attributes of these types may be loaded using the
+@code{glVertexAttrib} entry points. Matrices must be loaded into
+successive generic attribute slots in column major order, with one
+column of the matrix in each generic attribute slot.
+
+A user-defined attribute variable declared in a vertex shader can be
+bound to a generic attribute index by calling
+@code{glBindAttribLocation}. This allows an application to use more
+descriptive variable names in a vertex shader. A subsequent change to
+the specified generic vertex attribute will be immediately reflected as
+a change to the corresponding attribute variable in the vertex shader.
+
+The binding between a generic vertex attribute index and a user-defined
+attribute variable in a vertex shader is part of the state of a program
+object, but the current value of the generic vertex attribute is not.
+The value of each generic vertex attribute is part of current state,
+just like standard vertex attributes, and it is maintained even if a
+different program object is used.
+
+An application may freely modify generic vertex attributes that are not
+bound to a named vertex shader attribute variable. These values are
+simply maintained as part of current state and will not be accessed by
+the vertex shader. If a generic vertex attribute bound to an attribute
+variable in a vertex shader is not updated while the vertex shader is
+executing, the vertex shader will repeatedly use the current value for
+the generic vertex attribute.
+
+The generic vertex attribute with index 0 is the same as the vertex
+position attribute previously defined by OpenGL. A @code{glVertex2},
+@code{glVertex3}, or @code{glVertex4} command is completely equivalent
+to the corresponding @code{glVertexAttrib} command with an index
+argument of 0. A vertex shader can access generic vertex attribute 0 by
+using the built-in attribute variable @var{gl_Vertex}. There are no
+current values for generic vertex attribute 0. This is the only generic
+vertex attribute with this property; calls to set other standard vertex
+attributes can be freely mixed with calls to set any of the other
+generic vertex attributes.
+
+@heading Errors
+@code{GL_INVALID_VALUE} is generated if @var{index} is greater than or
+equal to @code{GL_MAX_VERTEX_ATTRIBS}.
+
+@end defun
+
+@defun glVertexPointer
+@heading define an array of vertex data
+@heading Parameters
+@table @asis
+@item @var{size}
+Specifies the number of coordinates per vertex. Must be 2, 3, or 4. The
+initial value is 4.
+
+@item @var{type}
+Specifies the data type of each coordinate in the array. Symbolic
+constants @code{GL_SHORT}, @code{GL_INT}, @code{GL_FLOAT}, or
+@code{GL_DOUBLE} are accepted. The initial value is @code{GL_FLOAT}.
+
+@item @var{stride}
+Specifies the byte offset between consecutive vertices. If @var{stride}
+is 0, the vertices are understood to be tightly packed in the array. The
+initial value is 0.
+
+@item @var{pointer}
+Specifies a pointer to the first coordinate of the first vertex in the
+array. The initial value is 0.
+
+@end table
+
+@heading Description
+@code{glVertexPointer} specifies the location and data format of an
+array of vertex coordinates to use when rendering. @var{size} specifies
+the number of coordinates per vertex, and must be 2, 3, or 4. @var{type}
+specifies the data type of each coordinate, and @var{stride} specifies
+the byte stride from one vertex to the next, allowing vertices and
+attributes to be packed into a single array or stored in separate
+arrays. (Single-array storage may be more efficient on some
+implementations; see @code{glInterleavedArrays}.)
+
+If a non-zero named buffer object is bound to the @code{GL_ARRAY_BUFFER}
+target (see @code{glBindBuffer}) while a vertex array is specified,
+@var{pointer} is treated as a byte offset into the buffer object's data
+store. Also, the buffer object binding (@code{GL_ARRAY_BUFFER_BINDING})
+is saved as vertex array client-side state
+(@code{GL_VERTEX_ARRAY_BUFFER_BINDING}).
+
+When a vertex array is specified, @var{size}, @var{type}, @var{stride},
+and @var{pointer} are saved as client-side state, in addition to the
+current vertex array buffer object binding.
+
+To enable and disable the vertex array, call @code{glEnableClientState}
+and @code{glDisableClientState} with the argument
+@code{GL_VERTEX_ARRAY}. If enabled, the vertex array is used when
+@code{glArrayElement}, @code{glDrawArrays}, @code{glMultiDrawArrays},
+@code{glDrawElements}, @code{glMultiDrawElements}, or
+@code{glDrawRangeElements} is called.
+
+@heading Errors
+@code{GL_INVALID_VALUE} is generated if @var{size} is not 2, 3, or 4.
+
+@code{GL_INVALID_ENUM} is generated if @var{type} is not an accepted
+value.
+
+@code{GL_INVALID_VALUE} is generated if @var{stride} is negative.
+
+@end defun
+
+@defun glVertex
+@heading specify a vertex
+@heading Parameters
+@table @asis
+@item @var{x}
+@itemx @var{y}
+@itemx @var{z}
+@itemx @var{w}
+Specify @var{x}, @var{y}, @var{z}, and @var{w} coordinates of a vertex.
+Not all parameters are present in all forms of the command.
+
+@end table
+
+@heading Description
+@code{glVertex} commands are used within @code{glBegin}/@code{glEnd}
+pairs to specify point, line, and polygon vertices. The current color,
+normal, texture coordinates, and fog coordinate are associated with the
+vertex when @code{glVertex} is called.
+
+When only @math{@var{x}} and @math{@var{y}} are specified,
+@math{@var{z}} defaults to 0 and @math{@var{w}} defaults to 1. When
+@math{@var{x}}, @math{@var{y}}, and @math{@var{z}} are specified,
+@math{@var{w}} defaults to 1.
+
+@end defun
+
+@defun glViewport
+@heading set the viewport
+@heading Parameters
+@table @asis
+@item @var{x}
+@itemx @var{y}
+Specify the lower left corner of the viewport rectangle, in pixels. The
+initial value is (0,0).
+
+@item @var{width}
+@itemx @var{height}
+Specify the width and height of the viewport. When a GL context is first
+attached to a window, @var{width} and @var{height} are set to the
+dimensions of that window.
+
+@end table
+
+@heading Description
+@code{glViewport} specifies the affine transformation of @math{@var{x}}
+and @math{@var{y}} from normalized device coordinates to window
+coordinates. Let @math{(@var{x}_@var{nd},@var{y}_@var{nd})} be
+normalized device coordinates. Then the window coordinates
+@math{(@var{x}_@var{w},@var{y}_@var{w})} are computed as follows:
+
+@math{@var{x}_@var{w}=(@var{x}_@var{nd}+1,)(@var{width}/2,)+@var{x}}
+
+@math{@var{y}_@var{w}=(@var{y}_@var{nd}+1,)(@var{height}/2,)+@var{y}}
+
+Viewport width and height are silently clamped to a range that depends
+on the implementation. To query this range, call @code{glGet} with
+argument @code{GL_MAX_VIEWPORT_DIMS}.
+
+@heading Errors
+@code{GL_INVALID_VALUE} is generated if either @var{width} or
+@var{height} is negative.
+
+@code{GL_INVALID_OPERATION} is generated if @code{glViewport} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+@defun glWindowPos
+@heading specify the raster position in window coordinates for pixel operations
+@heading Parameters
+@table @asis
+@item @var{x}
+@itemx @var{y}
+@itemx @var{z}
+Specify the @math{@var{x}}, @math{@var{y}}, @math{@var{z}} coordinates
+for the raster position.
+
+@end table
+
+@heading Description
+The GL maintains a 3D position in window coordinates. This position,
+called the raster position, is used to position pixel and bitmap write
+operations. It is maintained with subpixel accuracy. See
+@code{glBitmap}, @code{glDrawPixels}, and @code{glCopyPixels}.
+
+@code{glWindowPos2} specifies the @math{@var{x}} and @math{@var{y}}
+coordinates, while @math{@var{z}} is implicitly set to 0.
+@code{glWindowPos3} specifies all three coordinates. The @math{@var{w}}
+coordinate of the current raster position is always set to 1.0.
+
+@code{glWindowPos} directly updates the @math{@var{x}} and
+@math{@var{y}} coordinates of the current raster position with the
+values specified. That is, the values are neither transformed by the
+current modelview and projection matrices, nor by the viewport-to-window
+transform. The @math{@var{z}} coordinate of the current raster position
+is updated in the following manner:
+
+@math{@var{z}=@{(@var{n}), (@var{f}),
+(@var{n}+@var{z}×(@var{f}-@var{n},),)(@var{if}@var{z}<=0),
+(@var{if}@var{z}>=1), (@code{otherwise},),}
+
+
+
+where @math{@var{n}} is @code{GL_DEPTH_RANGE}'s near value, and
+@math{@var{f}} is @code{GL_DEPTH_RANGE}'s far value. See
+@code{glDepthRange}.
+
+The specified coordinates are not clip-tested, causing the raster
+position to always be valid.
+
+The current raster position also includes some associated color data and
+texture coordinates. If lighting is enabled, then
+@code{GL_CURRENT_RASTER_COLOR} (in RGBA mode) or
+@code{GL_CURRENT_RASTER_INDEX} (in color index mode) is set to the color
+produced by the lighting calculation (see @code{glLight},
+@code{glLightModel}, and @code{glShadeModel}). If lighting is disabled,
+current color (in RGBA mode, state variable @code{GL_CURRENT_COLOR}) or
+color index (in color index mode, state variable
+@code{GL_CURRENT_INDEX}) is used to update the current raster color.
+@code{GL_CURRENT_RASTER_SECONDARY_COLOR} (in RGBA mode) is likewise
+updated.
+
+Likewise, @code{GL_CURRENT_RASTER_TEXTURE_COORDS} is updated as a
+function of @code{GL_CURRENT_TEXTURE_COORDS}, based on the texture
+matrix and the texture generation functions (see @code{glTexGen}). The
+@code{GL_CURRENT_RASTER_DISTANCE} is set to the
+@code{GL_CURRENT_FOG_COORD}.
+
+
+
+@heading Errors
+@code{GL_INVALID_OPERATION} is generated if @code{glWindowPos} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@end defun
+
+
+@c %end of fragment
--- /dev/null
+
+@c %start of fragment
+
+@copying
+This section of the manual was derived from the upstream OpenGL
+documentation. Each function's documentation has its own copyright
+statement; for full details, see the upstream documentation. The
+copyright notices and licenses present in this section are as follows.
+
+Copyright @copyright{} 1991-2006 Silicon Graphics, Inc. This document is
+licensed under the SGI Free Software B License. For details, see
+@uref{http://oss.sgi.com/projects/FreeB/,http://oss.sgi.com/projects/FreeB/}.
+
+@end copying
+
+The functions from this section may be had by loading the module:
+
+@example
+(use-modules (figl low-level glu))
+@end example
+
+@defun gluBeginCurve
+@heading delimit a NURBS curve definition
+@heading Parameters
+@table @asis
+@item @var{nurb}
+Specifies the NURBS object (created with @code{gluNewNurbsRenderer}).
+
+@end table
+
+@heading Description
+Use @code{gluBeginCurve} to mark the beginning of a NURBS curve
+definition. After calling @code{gluBeginCurve}, make one or more calls
+to @code{gluNurbsCurve} to define the attributes of the curve. Exactly
+one of the calls to @code{gluNurbsCurve} must have a curve type of
+@code{GLU_MAP1_VERTEX_3} or @code{GLU_MAP1_VERTEX_4}. To mark the end of
+the NURBS curve definition, call @code{gluEndCurve}.
+
+GL evaluators are used to render the NURBS curve as a series of line
+segments. Evaluator state is preserved during rendering with
+@code{glPushAttrib}(@code{GLU_EVAL_BIT}) and @code{glPopAttrib}(). See
+the @code{glPushAttrib} reference page for details on exactly what state
+these calls preserve.
+
+@end defun
+
+@defun gluBeginPolygon
+@heading delimit a polygon description
+@heading Parameters
+@table @asis
+@item @var{tess}
+Specifies the tessellation object (created with @code{gluNewTess}).
+
+@end table
+
+@heading Description
+@code{gluBeginPolygon} and @code{gluEndPolygon} delimit the definition
+of a nonconvex polygon. To define such a polygon, first call
+@code{gluBeginPolygon}. Then define the contours of the polygon by
+calling @code{gluTessVertex} for each vertex and @code{gluNextContour}
+to start each new contour. Finally, call @code{gluEndPolygon} to signal
+the end of the definition. See the @code{gluTessVertex} and
+@code{gluNextContour} reference pages for more details.
+
+Once @code{gluEndPolygon} is called, the polygon is tessellated, and the
+resulting triangles are described through callbacks. See
+@code{gluTessCallback} for descriptions of the callback functions.
+
+@end defun
+
+@defun gluBeginSurface
+@heading delimit a NURBS surface definition
+@heading Parameters
+@table @asis
+@item @var{nurb}
+Specifies the NURBS object (created with @code{gluNewNurbsRenderer}).
+
+@end table
+
+@heading Description
+Use @code{gluBeginSurface} to mark the beginning of a NURBS surface
+definition. After calling @code{gluBeginSurface}, make one or more calls
+to @code{gluNurbsSurface} to define the attributes of the surface.
+Exactly one of these calls to @code{gluNurbsSurface} must have a surface
+type of @code{GLU_MAP2_VERTEX_3} or @code{GLU_MAP2_VERTEX_4}. To mark
+the end of the NURBS surface definition, call @code{gluEndSurface}.
+
+Trimming of NURBS surfaces is supported with @code{gluBeginTrim},
+@code{gluPwlCurve}, @code{gluNurbsCurve}, and @code{gluEndTrim}. See the
+@code{gluBeginTrim} reference page for details.
+
+GL evaluators are used to render the NURBS surface as a set of polygons.
+Evaluator state is preserved during rendering with
+@code{glPushAttrib}(@code{GLU_EVAL_BIT}) and @code{glPopAttrib}. See the
+@code{glPushAttrib} reference page for details on exactly what state
+these calls preserve.
+
+@end defun
+
+@defun gluBeginTrim
+@heading delimit a NURBS trimming loop definition
+@heading Parameters
+@table @asis
+@item @var{nurb}
+Specifies the NURBS object (created with @code{gluNewNurbsRenderer}).
+
+@end table
+
+@heading Description
+Use @code{gluBeginTrim} to mark the beginning of a trimming loop and
+@code{gluEndTrim} to mark the end of a trimming loop. A trimming loop is
+a set of oriented curve segments (forming a closed curve) that define
+boundaries of a NURBS surface. You include these trimming loops in the
+definition of a NURBS surface, between calls to @code{gluBeginSurface}
+and @code{gluEndSurface}.
+
+The definition for a NURBS surface can contain many trimming loops. For
+example, if you wrote a definition for a NURBS surface that resembled a
+rectangle with a hole punched out, the definition would contain two
+trimming loops. One loop would define the outer edge of the rectangle;
+the other would define the hole punched out of the rectangle. The
+definitions of each of these trimming loops would be bracketed by a
+@code{gluBeginTrim}/@code{gluEndTrim} pair.
+
+The definition of a single closed trimming loop can consist of multiple
+curve segments, each described as a piecewise linear curve (see
+@code{gluPwlCurve}) or as a single NURBS curve (see
+@code{gluNurbsCurve}), or as a combination of both in any order. The
+only library calls that can appear in a trimming loop definition
+(between the calls to @code{gluBeginTrim} and @code{gluEndTrim}) are
+@code{gluPwlCurve} and @code{gluNurbsCurve}.
+
+The area of the NURBS surface that is displayed is the region in the
+domain to the left of the trimming curve as the curve parameter
+increases. Thus, the retained region of the NURBS surface is inside a
+counterclockwise trimming loop and outside a clockwise trimming loop.
+For the rectangle mentioned earlier, the trimming loop for the outer
+edge of the rectangle runs counterclockwise, while the trimming loop for
+the punched-out hole runs clockwise.
+
+If you use more than one curve to define a single trimming loop, the
+curve segments must form a closed loop (that is, the endpoint of each
+curve must be the starting point of the next curve, and the endpoint of
+the final curve must be the starting point of the first curve). If the
+endpoints of the curve are sufficiently close together but not exactly
+coincident, they will be coerced to match. If the endpoints are not
+sufficiently close, an error results (see @code{gluNurbsCallback}).
+
+If a trimming loop definition contains multiple curves, the direction of
+the curves must be consistent (that is, the inside must be to the left
+of all of the curves). Nested trimming loops are legal as long as the
+curve orientations alternate correctly. If trimming curves are
+self-intersecting, or intersect one another, an error results.
+
+If no trimming information is given for a NURBS surface, the entire
+surface is drawn.
+
+@end defun
+
+@defun gluBuild1DMipmapLevels
+@heading builds a subset of one-dimensional mipmap levels
+@heading Parameters
+@table @asis
+@item @var{target}
+Specifies the target texture. Must be @code{GLU_TEXTURE_1D}.
+
+@item @var{internalFormat}
+Requests the internal storage format of the texture image. The most
+current version of the SGI implementation of GLU does not check this
+value for validity before passing it on to the underlying OpenGL
+implementation. A value that is not accepted by the OpenGL
+implementation will lead to an OpenGL error. The benefit of not checking
+this value at the GLU level is that OpenGL extensions can add new
+internal texture formats without requiring a revision of the GLU
+implementation. Older implementations of GLU check this value and raise
+a GLU error if it is not 1, 2, 3, or 4 or one of the following symbolic
+constants: @code{GLU_ALPHA}, @code{GLU_ALPHA4}, @code{GLU_ALPHA8},
+@code{GLU_ALPHA12}, @code{GLU_ALPHA16}, @code{GLU_LUMINANCE},
+@code{GLU_LUMINANCE4}, @code{GLU_LUMINANCE8}, @code{GLU_LUMINANCE12},
+@code{GLU_LUMINANCE16}, @code{GLU_LUMINANCE_ALPHA},
+@code{GLU_LUMINANCE4_ALPHA4}, @code{GLU_LUMINANCE6_ALPHA2},
+@code{GLU_LUMINANCE8_ALPHA8}, @code{GLU_LUMINANCE12_ALPHA4},
+@code{GLU_LUMINANCE12_ALPHA12}, @code{GLU_LUMINANCE16_ALPHA16},
+@code{GLU_INTENSITY}, @code{GLU_INTENSITY4}, @code{GLU_INTENSITY8},
+@code{GLU_INTENSITY12}, @code{GLU_INTENSITY16}, @code{GLU_RGB},
+@code{GLU_R3_G3_B2}, @code{GLU_RGB4}, @code{GLU_RGB5}, @code{GLU_RGB8},
+@code{GLU_RGB10}, @code{GLU_RGB12}, @code{GLU_RGB16}, @code{GLU_RGBA},
+@code{GLU_RGBA2}, @code{GLU_RGBA4}, @code{GLU_RGB5_A1},
+@code{GLU_RGBA8}, @code{GLU_RGB10_A2}, @code{GLU_RGBA12}, or
+@code{GLU_RGBA16}.
+
+@item @var{width}
+Specifies the width in pixels of the texture image. This should be a
+power of 2.
+
+@item @var{format}
+Specifies the format of the pixel data. Must be one of:
+@code{GLU_COLOR_INDEX}, @code{GLU_DEPTH_COMPONENT}, @code{GLU_RED},
+@code{GLU_GREEN}, @code{GLU_BLUE}, @code{GLU_ALPHA}, @code{GLU_RGB},
+@code{GLU_RGBA}, @code{GLU_BGR}, @code{GLU_BGRA}, @code{GLU_LUMINANCE},
+or @code{GLU_LUMINANCE_ALPHA}.
+
+@item @var{type}
+Specifies the data type for @var{data}. Must be one of:
+@code{GLU_UNSIGNED_BYTE}, @code{GLU_BYTE}, @code{GLU_BITMAP},
+@code{GLU_UNSIGNED_SHORT}, @code{GLU_SHORT}, @code{GLU_UNSIGNED_INT},
+@code{GLU_INT}, @code{GLU_FLOAT}, @code{GLU_UNSIGNED_BYTE_3_3_2},
+@code{GLU_UNSIGNED_BYTE_2_3_3_REV}, @code{GLU_UNSIGNED_SHORT_5_6_5},
+@code{GLU_UNSIGNED_SHORT_5_6_5_REV}, @code{GLU_UNSIGNED_SHORT_4_4_4_4},
+@code{GLU_UNSIGNED_SHORT_4_4_4_4_REV},
+@code{GLU_UNSIGNED_SHORT_5_5_5_1},
+@code{GLU_UNSIGNED_SHORT_1_5_5_5_REV}, @code{GLU_UNSIGNED_INT_8_8_8_8},
+@code{GLU_UNSIGNED_INT_8_8_8_8_REV}, @code{GLU_UNSIGNED_INT_10_10_10_2},
+or @code{GLU_UNSIGNED_INT_2_10_10_10_REV}.
+
+@item @var{level}
+Specifies the mipmap level of the image data.
+
+@item @var{base}
+Specifies the minimum mipmap level to pass to @code{glTexImage1D}.
+
+@item @var{max}
+Specifies the maximum mipmap level to pass to @code{glTexImage1D}.
+
+@item @var{data}
+Specifies a pointer to the image data in memory.
+
+@end table
+
+@heading Description
+@code{gluBuild1DMipmapLevels} builds a subset of prefiltered
+one-dimensional texture maps of decreasing resolutions called a mipmap.
+This is used for the antialiasing of texture mapped primitives.
+
+A return value of zero indicates success, otherwise a GLU error code is
+returned (see @code{gluErrorString}).
+
+A series of mipmap levels from @var{base} to @var{max} is built by
+decimating @var{data} in half until size @math{1×1} is reached. At each
+level, each texel in the halved mipmap level is an average of the
+corresponding two texels in the larger mipmap level. @code{glTexImage1D}
+is called to load these mipmap levels from @var{base} to @var{max}. If
+@var{max} is larger than the highest mipmap level for the texture of the
+specified size, then a GLU error code is returned (see
+@code{gluErrorString}) and nothing is loaded.
+
+For example, if @var{level} is 2 and @var{width} is 16, the following
+levels are possible: @math{16×1}, @math{8×1}, @math{4×1}, @math{2×1},
+@math{1×1}. These correspond to levels 2 through 6 respectively. If
+@var{base} is 3 and @var{max} is 5, then only mipmap levels @math{8×1},
+@math{4×1} and @math{2×1} are loaded. However, if @var{max} is 7, then
+an error is returned and nothing is loaded since @var{max} is larger
+than the highest mipmap level which is, in this case, 6.
+
+The highest mipmap level can be derived from the formula
+@math{@var{log}_2(@var{width}×2^@var{level},)}.
+
+See the @code{glTexImage1D} reference page for a description of the
+acceptable values for @var{type} parameter. See the @code{glDrawPixels}
+reference page for a description of the acceptable values for
+@var{level} parameter.
+
+@heading Errors
+@code{GLU_INVALID_VALUE} is returned if @var{level} > @var{base},
+@var{base} < 0, @var{max} < @var{base} or @var{max} is > the highest
+mipmap level for @var{data}.
+
+@code{GLU_INVALID_VALUE} is returned if @var{width} is < 1.
+
+@code{GLU_INVALID_ENUM} is returned if @var{internalFormat},
+@var{format}, or @var{type} are not legal.
+
+@code{GLU_INVALID_OPERATION} is returned if @var{type} is
+@code{GLU_UNSIGNED_BYTE_3_3_2} or @code{GLU_UNSIGNED_BYTE_2_3_3_REV} and
+@var{format} is not @code{GLU_RGB}.
+
+@code{GLU_INVALID_OPERATION} is returned if @var{type} is
+@code{GLU_UNSIGNED_SHORT_5_6_5} or @code{GLU_UNSIGNED_SHORT_5_6_5_REV}
+and @var{format} is not @code{GLU_RGB}.
+
+@code{GLU_INVALID_OPERATION} is returned if @var{type} is
+@code{GLU_UNSIGNED_SHORT_4_4_4_4} or
+@code{GLU_UNSIGNED_SHORT_4_4_4_4_REV} and @var{format} is neither
+@code{GLU_RGBA} nor @code{GLU_BGRA}.
+
+@code{GLU_INVALID_OPERATION} is returned if @var{type} is
+@code{GLU_UNSIGNED_SHORT_5_5_5_1} or
+@code{GLU_UNSIGNED_SHORT_1_5_5_5_REV} and @var{format} is neither
+@code{GLU_RGBA} nor @code{GLU_BGRA}.
+
+@code{GLU_INVALID_OPERATION} is returned if @var{type} is
+@code{GLU_UNSIGNED_INT_8_8_8_8} or @code{GLU_UNSIGNED_INT_8_8_8_8_REV}
+and @var{format} is neither @code{GLU_RGBA} nor @code{GLU_BGRA}.
+
+@code{GLU_INVALID_OPERATION} is returned if @var{type} is
+@code{GLU_UNSIGNED_INT_10_10_10_2} or
+@code{GLU_UNSIGNED_INT_2_10_10_10_REV} and @var{format} is neither
+@code{GLU_RGBA} nor @code{GLU_BGRA}.
+
+@end defun
+
+@defun gluBuild1DMipmaps
+@heading builds a one-dimensional mipmap
+@heading Parameters
+@table @asis
+@item @var{target}
+Specifies the target texture. Must be @code{GLU_TEXTURE_1D}.
+
+@item @var{internalFormat}
+Requests the internal storage format of the texture image. The most
+current version of the SGI implementation of GLU does not check this
+value for validity before passing it on to the underlying OpenGL
+implementation. A value that is not accepted by the OpenGL
+implementation will lead to an OpenGL error. The benefit of not checking
+this value at the GLU level is that OpenGL extensions can add new
+internal texture formats without requiring a revision of the GLU
+implementation. Older implementations of GLU check this value and raise
+a GLU error if it is not 1, 2, 3, or 4 or one of the following symbolic
+constants: @code{GLU_ALPHA}, @code{GLU_ALPHA4}, @code{GLU_ALPHA8},
+@code{GLU_ALPHA12}, @code{GLU_ALPHA16}, @code{GLU_LUMINANCE},
+@code{GLU_LUMINANCE4}, @code{GLU_LUMINANCE8}, @code{GLU_LUMINANCE12},
+@code{GLU_LUMINANCE16}, @code{GLU_LUMINANCE_ALPHA},
+@code{GLU_LUMINANCE4_ALPHA4}, @code{GLU_LUMINANCE6_ALPHA2},
+@code{GLU_LUMINANCE8_ALPHA8}, @code{GLU_LUMINANCE12_ALPHA4},
+@code{GLU_LUMINANCE12_ALPHA12}, @code{GLU_LUMINANCE16_ALPHA16},
+@code{GLU_INTENSITY}, @code{GLU_INTENSITY4}, @code{GLU_INTENSITY8},
+@code{GLU_INTENSITY12}, @code{GLU_INTENSITY16}, @code{GLU_RGB},
+@code{GLU_R3_G3_B2}, @code{GLU_RGB4}, @code{GLU_RGB5}, @code{GLU_RGB8},
+@code{GLU_RGB10}, @code{GLU_RGB12}, @code{GLU_RGB16}, @code{GLU_RGBA},
+@code{GLU_RGBA2}, @code{GLU_RGBA4}, @code{GLU_RGB5_A1},
+@code{GLU_RGBA8}, @code{GLU_RGB10_A2}, @code{GLU_RGBA12}, or
+@code{GLU_RGBA16}.
+
+@item @var{width}
+Specifies the width, in pixels, of the texture image.
+
+@item @var{format}
+Specifies the format of the pixel data. Must be one of
+@code{GLU_COLOR_INDEX}, @code{GLU_DEPTH_COMPONENT}, @code{GLU_RED},
+@code{GLU_GREEN}, @code{GLU_BLUE}, @code{GLU_ALPHA}, @code{GLU_RGB},
+@code{GLU_RGBA}, @code{GLU_BGR}, @code{GLU_BGRA}, @code{GLU_LUMINANCE},
+or @code{GLU_LUMINANCE_ALPHA}.
+
+@item @var{type}
+Specifies the data type for @var{data}. Must be one of
+@code{GLU_UNSIGNED_BYTE}, @code{GLU_BYTE}, @code{GLU_BITMAP},
+@code{GLU_UNSIGNED_SHORT}, @code{GLU_SHORT}, @code{GLU_UNSIGNED_INT},
+@code{GLU_INT}, @code{GLU_FLOAT}, @code{GLU_UNSIGNED_BYTE_3_3_2},
+@code{GLU_UNSIGNED_BYTE_2_3_3_REV}, @code{GLU_UNSIGNED_SHORT_5_6_5},
+@code{GLU_UNSIGNED_SHORT_5_6_5_REV}, @code{GLU_UNSIGNED_SHORT_4_4_4_4},
+@code{GLU_UNSIGNED_SHORT_4_4_4_4_REV},
+@code{GLU_UNSIGNED_SHORT_5_5_5_1},
+@code{GLU_UNSIGNED_SHORT_1_5_5_5_REV}, @code{GLU_UNSIGNED_INT_8_8_8_8},
+@code{GLU_UNSIGNED_INT_8_8_8_8_REV}, @code{GLU_UNSIGNED_INT_10_10_10_2},
+or @code{GLU_UNSIGNED_INT_2_10_10_10_REV}.
+
+@item @var{data}
+Specifies a pointer to the image data in memory.
+
+@end table
+
+@heading Description
+@code{gluBuild1DMipmaps} builds a series of prefiltered one-dimensional
+texture maps of decreasing resolutions called a mipmap. This is used for
+the antialiasing of texture mapped primitives.
+
+A return value of zero indicates success, otherwise a GLU error code is
+returned (see @code{gluErrorString}).
+
+Initially, the @var{width} of @var{data} is checked to see if it is a
+power of 2. If not, a copy of @var{data} is scaled up or down to the
+nearest power of 2. (If @var{width} is exactly between powers of 2, then
+the copy of @var{data} will scale upwards.) This copy will be used for
+subsequent mipmapping operations described below. For example, if
+@var{width} is 57, then a copy of @var{data} will scale up to 64 before
+mipmapping takes place.
+
+Then, proxy textures (see @code{glTexImage1D}) are used to determine if
+the implementation can fit the requested texture. If not, @var{width} is
+continually halved until it fits.
+
+Next, a series of mipmap levels is built by decimating a copy of
+@var{data} in half until size @math{1×1} is reached. At each level, each
+texel in the halved mipmap level is an average of the corresponding two
+texels in the larger mipmap level.
+
+@code{glTexImage1D} is called to load each of these mipmap levels. Level
+0 is a copy of @var{data}. The highest level is
+@math{@var{log}_2,(@var{width},)}. For example, if @var{width} is 64
+and the implementation can store a texture of this size, the following
+mipmap levels are built: @math{64×1}, @math{32×1}, @math{16×1},
+@math{8×1}, @math{4×1}, @math{2×1}, and @math{1×1}. These correspond to
+levels 0 through 6, respectively.
+
+See the @code{glTexImage1D} reference page for a description of the
+acceptable values for the @var{type} parameter. See the
+@code{glDrawPixels} reference page for a description of the acceptable
+values for the @var{data} parameter.
+
+@heading Errors
+@code{GLU_INVALID_VALUE} is returned if @var{width} is < 1.
+
+@code{GLU_INVALID_ENUM} is returned if @var{format} or @var{type} are
+not legal.
+
+@code{GLU_INVALID_OPERATION} is returned if @var{type} is
+@code{GLU_UNSIGNED_BYTE_3_3_2} or @code{GLU_UNSIGNED_BYTE_2_3_3_REV} and
+@var{format} is not @code{GLU_RGB}.
+
+@code{GLU_INVALID_OPERATION} is returned if @var{type} is
+@code{GLU_UNSIGNED_SHORT_5_6_5} or @code{GLU_UNSIGNED_SHORT_5_6_5_REV}
+and @var{format} is not @code{GLU_RGB}.
+
+@code{GLU_INVALID_OPERATION} is returned if @var{type} is
+@code{GLU_UNSIGNED_SHORT_4_4_4_4} or
+@code{GLU_UNSIGNED_SHORT_4_4_4_4_REV} and @var{format} is neither
+@code{GLU_RGBA} nor @code{GLU_BGRA}.
+
+@code{GLU_INVALID_OPERATION} is returned if @var{type} is
+@code{GLU_UNSIGNED_SHORT_5_5_5_1} or
+@code{GLU_UNSIGNED_SHORT_1_5_5_5_REV} and @var{format} is neither
+@code{GLU_RGBA} nor @code{GLU_BGRA}.
+
+@code{GLU_INVALID_OPERATION} is returned if @var{type} is
+@code{GLU_UNSIGNED_INT_8_8_8_8} or @code{GLU_UNSIGNED_INT_8_8_8_8_REV}
+and @var{format} is neither @code{GLU_RGBA} nor @code{GLU_BGRA}.
+
+@code{GLU_INVALID_OPERATION} is returned if @var{type} is
+@code{GLU_UNSIGNED_INT_10_10_10_2} or
+@code{GLU_UNSIGNED_INT_2_10_10_10_REV} and @var{format} is neither
+@code{GLU_RGBA} nor @code{GLU_BGRA}.
+
+@end defun
+
+@defun gluBuild2DMipmapLevels
+@heading builds a subset of two-dimensional mipmap levels
+@heading Parameters
+@table @asis
+@item @var{target}
+Specifies the target texture. Must be @code{GLU_TEXTURE_2D}.
+
+@item @var{internalFormat}
+Requests the internal storage format of the texture image. The most
+current version of the SGI implementation of GLU does not check this
+value for validity before passing it on to the underlying OpenGL
+implementation. A value that is not accepted by the OpenGL
+implementation will lead to an OpenGL error. The benefit of not checking
+this value at the GLU level is that OpenGL extensions can add new
+internal texture formats without requiring a revision of the GLU
+implementation. Older implementations of GLU check this value and raise
+a GLU error if it is not 1, 2, 3, or 4 or one of the following symbolic
+constants: @code{GLU_ALPHA}, @code{GLU_ALPHA4}, @code{GLU_ALPHA8},
+@code{GLU_ALPHA12}, @code{GLU_ALPHA16}, @code{GLU_LUMINANCE},
+@code{GLU_LUMINANCE4}, @code{GLU_LUMINANCE8}, @code{GLU_LUMINANCE12},
+@code{GLU_LUMINANCE16}, @code{GLU_LUMINANCE_ALPHA},
+@code{GLU_LUMINANCE4_ALPHA4}, @code{GLU_LUMINANCE6_ALPHA2},
+@code{GLU_LUMINANCE8_ALPHA8}, @code{GLU_LUMINANCE12_ALPHA4},
+@code{GLU_LUMINANCE12_ALPHA12}, @code{GLU_LUMINANCE16_ALPHA16},
+@code{GLU_INTENSITY}, @code{GLU_INTENSITY4}, @code{GLU_INTENSITY8},
+@code{GLU_INTENSITY12}, @code{GLU_INTENSITY16}, @code{GLU_RGB},
+@code{GLU_R3_G3_B2}, @code{GLU_RGB4}, @code{GLU_RGB5}, @code{GLU_RGB8},
+@code{GLU_RGB10}, @code{GLU_RGB12}, @code{GLU_RGB16}, @code{GLU_RGBA},
+@code{GLU_RGBA2}, @code{GLU_RGBA4}, @code{GLU_RGB5_A1},
+@code{GLU_RGBA8}, @code{GLU_RGB10_A2}, @code{GLU_RGBA12}, or
+@code{GLU_RGBA16}.
+
+@item @var{width}
+@itemx @var{height}
+Specifies the width and height, respectively, in pixels of the texture
+image. These should be a power of 2.
+
+@item @var{format}
+Specifies the format of the pixel data. Must be one of
+@code{GLU_COLOR_INDEX}, @code{GLU_DEPTH_COMPONENT}, @code{GLU_RED},
+@code{GLU_GREEN}, @code{GLU_BLUE}, @code{GLU_ALPHA}, @code{GLU_RGB},
+@code{GLU_RGBA}, @code{GLU_BGR}, @code{GLU_BGRA}, @code{GLU_LUMINANCE},
+or @code{GLU_LUMINANCE_ALPHA}.
+
+@item @var{type}
+Specifies the data type for @var{data}. Must be one of
+@code{GLU_UNSIGNED_BYTE}, @code{GLU_BYTE}, @code{GLU_BITMAP},
+@code{GLU_UNSIGNED_SHORT}, @code{GLU_SHORT}, @code{GLU_UNSIGNED_INT},
+@code{GLU_INT}, @code{GLU_FLOAT}, @code{GLU_UNSIGNED_BYTE_3_3_2},
+@code{GLU_UNSIGNED_BYTE_2_3_3_REV}, @code{GLU_UNSIGNED_SHORT_5_6_5},
+@code{GLU_UNSIGNED_SHORT_5_6_5_REV}, @code{GLU_UNSIGNED_SHORT_4_4_4_4},
+@code{GLU_UNSIGNED_SHORT_4_4_4_4_REV},
+@code{GLU_UNSIGNED_SHORT_5_5_5_1},
+@code{GLU_UNSIGNED_SHORT_1_5_5_5_REV}, @code{GLU_UNSIGNED_INT_8_8_8_8},
+@code{GLU_UNSIGNED_INT_8_8_8_8_REV}, @code{GLU_UNSIGNED_INT_10_10_10_2},
+or @code{GLU_UNSIGNED_INT_2_10_10_10_REV}.
+
+@item @var{level}
+Specifies the mipmap level of the image data.
+
+@item @var{base}
+Specifies the minimum mipmap level to pass to @code{glTexImage2D}.
+
+@item @var{max}
+Specifies the maximum mipmap level to pass to @code{glTexImage2D}.
+
+@item @var{data}
+Specifies a pointer to the image data in memory.
+
+@end table
+
+@heading Description
+@code{gluBuild2DMipmapLevels} builds a subset of prefiltered
+two-dimensional texture maps of decreasing resolutions called a mipmap.
+This is used for the antialiasing of texture mapped primitives.
+
+A return value of zero indicates success, otherwise a GLU error code is
+returned (see @code{gluErrorString}).
+
+A series of mipmap levels from @var{base} to @var{max} is built by
+decimating @var{data} in half along both dimensions until size
+@math{1×1} is reached. At each level, each texel in the halved mipmap
+level is an average of the corresponding four texels in the larger
+mipmap level. (In the case of rectangular images, the decimation will
+ultimately reach an @math{@var{N}×1} or @math{1×@var{N}} configuration.
+Here, two texels are averaged instead.) @code{glTexImage2D} is called to
+load these mipmap levels from @var{base} to @var{max}. If @var{max} is
+larger than the highest mipmap level for the texture of the specified
+size, then a GLU error code is returned (see @code{gluErrorString}) and
+nothing is loaded.
+
+For example, if @var{level} is 2 and @var{width} is 16 and @var{height}
+is 8, the following levels are possible: @math{16×8}, @math{8×4},
+@math{4×2}, @math{2×1}, @math{1×1}. These correspond to levels 2 through
+6 respectively. If @var{base} is 3 and @var{max} is 5, then only mipmap
+levels @math{8×4}, @math{4×2}, and @math{2×1} are loaded. However, if
+@var{max} is 7, then an error is returned and nothing is loaded since
+@var{max} is larger than the highest mipmap level which is, in this
+case, 6.
+
+The highest mipmap level can be derived from the formula
+@math{@var{log}_2(@var{max}(@var{width},@var{height})×2^@var{level},)}.
+
+See the @code{glTexImage1D} reference page for a description of the
+acceptable values for @var{format} parameter. See the
+@code{glDrawPixels} reference page for a description of the acceptable
+values for @var{type} parameter.
+
+@heading Errors
+@code{GLU_INVALID_VALUE} is returned if @var{level} > @var{base},
+@var{base} < 0, @var{max} < @var{base}, or @var{max} is > the highest
+mipmap level for @var{data}.
+
+@code{GLU_INVALID_VALUE} is returned if @var{width} or @var{height} is <
+1.
+
+@code{GLU_INVALID_ENUM} is returned if @var{internalFormat},
+@var{format}, or @var{type} is not legal.
+
+@code{GLU_INVALID_OPERATION} is returned if @var{type} is
+@code{GLU_UNSIGNED_BYTE_3_3_2} or @code{GLU_UNSIGNED_BYTE_2_3_3_REV} and
+@var{format} is not @code{GLU_RGB}.
+
+@code{GLU_INVALID_OPERATION} is returned if @var{type} is
+@code{GLU_UNSIGNED_SHORT_5_6_5} or @code{GLU_UNSIGNED_SHORT_5_6_5_REV}
+and @var{format} is not @code{GLU_RGB}.
+
+@code{GLU_INVALID_OPERATION} is returned if @var{type} is
+@code{GLU_UNSIGNED_SHORT_4_4_4_4} or
+@code{GLU_UNSIGNED_SHORT_4_4_4_4_REV} and @var{format} is neither
+@code{GLU_RGBA} nor @code{GLU_BGRA}.
+
+@code{GLU_INVALID_OPERATION} is returned if @var{type} is
+@code{GLU_UNSIGNED_SHORT_5_5_5_1} or
+@code{GLU_UNSIGNED_SHORT_1_5_5_5_REV} and @var{format} is neither
+@code{GLU_RGBA} nor @code{GLU_BGRA}.
+
+@code{GLU_INVALID_OPERATION} is returned if @var{type} is
+@code{GLU_UNSIGNED_INT_8_8_8_8} or @code{GLU_UNSIGNED_INT_8_8_8_8_REV}
+and @var{format} is neither @code{GLU_RGBA} nor @code{GLU_BGRA}.
+
+@code{GLU_INVALID_OPERATION} is returned if @var{type} is
+@code{GLU_UNSIGNED_INT_10_10_10_2} or
+@code{GLU_UNSIGNED_INT_2_10_10_10_REV} and @var{format} is neither
+@code{GLU_RGBA} nor @code{GLU_BGRA}.
+
+@end defun
+
+@defun gluBuild2DMipmaps
+@heading builds a two-dimensional mipmap
+@heading Parameters
+@table @asis
+@item @var{target}
+Specifies the target texture. Must be @code{GLU_TEXTURE_2D}.
+
+@item @var{internalFormat}
+Requests the internal storage format of the texture image. The most
+current version of the SGI implementation of GLU does not check this
+value for validity before passing it on to the underlying OpenGL
+implementation. A value that is not accepted by the OpenGL
+implementation will lead to an OpenGL error. The benefit of not checking
+this value at the GLU level is that OpenGL extensions can add new
+internal texture formats without requiring a revision of the GLU
+implementation. Older implementations of GLU check this value and raise
+a GLU error if it is not 1, 2, 3, or 4 or one of the following symbolic
+constants: @code{GLU_ALPHA}, @code{GLU_ALPHA4}, @code{GLU_ALPHA8},
+@code{GLU_ALPHA12}, @code{GLU_ALPHA16}, @code{GLU_LUMINANCE},
+@code{GLU_LUMINANCE4}, @code{GLU_LUMINANCE8}, @code{GLU_LUMINANCE12},
+@code{GLU_LUMINANCE16}, @code{GLU_LUMINANCE_ALPHA},
+@code{GLU_LUMINANCE4_ALPHA4}, @code{GLU_LUMINANCE6_ALPHA2},
+@code{GLU_LUMINANCE8_ALPHA8}, @code{GLU_LUMINANCE12_ALPHA4},
+@code{GLU_LUMINANCE12_ALPHA12}, @code{GLU_LUMINANCE16_ALPHA16},
+@code{GLU_INTENSITY}, @code{GLU_INTENSITY4}, @code{GLU_INTENSITY8},
+@code{GLU_INTENSITY12}, @code{GLU_INTENSITY16}, @code{GLU_RGB},
+@code{GLU_R3_G3_B2}, @code{GLU_RGB4}, @code{GLU_RGB5}, @code{GLU_RGB8},
+@code{GLU_RGB10}, @code{GLU_RGB12}, @code{GLU_RGB16}, @code{GLU_RGBA},
+@code{GLU_RGBA2}, @code{GLU_RGBA4}, @code{GLU_RGB5_A1},
+@code{GLU_RGBA8}, @code{GLU_RGB10_A2}, @code{GLU_RGBA12}, or
+@code{GLU_RGBA16}.
+
+@item @var{width}
+@itemx @var{height}
+Specifies in pixels the width and height, respectively, of the texture
+image.
+
+@item @var{format}
+Specifies the format of the pixel data. Must be one of
+@code{GLU_COLOR_INDEX}, @code{GLU_DEPTH_COMPONENT}, @code{GLU_RED},
+@code{GLU_GREEN}, @code{GLU_BLUE}, @code{GLU_ALPHA}, @code{GLU_RGB},
+@code{GLU_RGBA}, @code{GLU_BGR}, @code{GLU_BGRA}, @code{GLU_LUMINANCE},
+or @code{GLU_LUMINANCE_ALPHA}.
+
+@item @var{type}
+Specifies the data type for @var{data}. Must be one of
+@code{GLU_UNSIGNED_BYTE}, @code{GLU_BYTE}, @code{GLU_BITMAP},
+@code{GLU_UNSIGNED_SHORT}, @code{GLU_SHORT}, @code{GLU_UNSIGNED_INT},
+@code{GLU_INT}, @code{GLU_FLOAT}, @code{GLU_UNSIGNED_BYTE_3_3_2},
+@code{GLU_UNSIGNED_BYTE_2_3_3_REV}, @code{GLU_UNSIGNED_SHORT_5_6_5},
+@code{GLU_UNSIGNED_SHORT_5_6_5_REV}, @code{GLU_UNSIGNED_SHORT_4_4_4_4},
+@code{GLU_UNSIGNED_SHORT_4_4_4_4_REV},
+@code{GLU_UNSIGNED_SHORT_5_5_5_1},
+@code{GLU_UNSIGNED_SHORT_1_5_5_5_REV}, @code{GLU_UNSIGNED_INT_8_8_8_8},
+@code{GLU_UNSIGNED_INT_8_8_8_8_REV}, @code{GLU_UNSIGNED_INT_10_10_10_2},
+or @code{GLU_UNSIGNED_INT_2_10_10_10_REV}.
+
+@item @var{data}
+Specifies a pointer to the image data in memory.
+
+@end table
+
+@heading Description
+@code{gluBuild2DMipmaps} builds a series of prefiltered two-dimensional
+texture maps of decreasing resolutions called a mipmap. This is used for
+the antialiasing of texture-mapped primitives.
+
+A return value of zero indicates success, otherwise a GLU error code is
+returned (see @code{gluErrorString}).
+
+Initially, the @var{width} and @var{height} of @var{data} are checked to
+see if they are a power of 2. If not, a copy of @var{data} (not
+@var{data}), is scaled up or down to the nearest power of 2. This copy
+will be used for subsequent mipmapping operations described below. (If
+@var{width} or @var{height} is exactly between powers of 2, then the
+copy of @var{data} will scale upwards.) For example, if @var{width} is
+57 and @var{height} is 23, then a copy of @var{data} will scale up to 64
+in @var{width} and down to 16 in depth, before mipmapping takes place.
+
+Then, proxy textures (see @code{glTexImage2D}) are used to determine if
+the implementation can fit the requested texture. If not, both
+dimensions are continually halved until it fits. (If the OpenGL version
+is \(<= 1.0, both maximum texture dimensions are clamped to the value
+returned by @code{glGetIntegerv} with the argument
+@code{GLU_MAX_TEXTURE_SIZE}.)
+
+Next, a series of mipmap levels is built by decimating a copy of
+@var{data} in half along both dimensions until size @math{1×1} is
+reached. At each level, each texel in the halved mipmap level is an
+average of the corresponding four texels in the larger mipmap level. (In
+the case of rectangular images, the decimation will ultimately reach an
+@math{@var{N}×1} or @math{1×@var{N}} configuration. Here, two texels are
+averaged instead.)
+
+@code{glTexImage2D} is called to load each of these mipmap levels. Level
+0 is a copy of @var{data}. The highest level is
+@math{@var{log}_2,(@var{max}(@var{width},@var{height}),)}. For
+example, if @var{width} is 64 and @var{height} is 16 and the
+implementation can store a texture of this size, the following mipmap
+levels are built: @math{64×16}, @math{32×8}, @math{16×4}, @math{8×2},
+@math{4×1}, @math{2×1}, and @math{1×1} These correspond to levels 0
+through 6, respectively.
+
+See the @code{glTexImage1D} reference page for a description of the
+acceptable values for @var{format} parameter. See the
+@code{glDrawPixels} reference page for a description of the acceptable
+values for @var{type} parameter.
+
+@heading Errors
+@code{GLU_INVALID_VALUE} is returned if @var{width} or @var{height} is <
+1.
+
+@code{GLU_INVALID_ENUM} is returned if @var{internalFormat},
+@var{format}, or @var{type} is not legal.
+
+@code{GLU_INVALID_OPERATION} is returned if @var{type} is
+@code{GLU_UNSIGNED_BYTE_3_3_2} or @code{GLU_UNSIGNED_BYTE_2_3_3_REV} and
+@var{format} is not @code{GLU_RGB}.
+
+@code{GLU_INVALID_OPERATION} is returned if @var{type} is
+@code{GLU_UNSIGNED_SHORT_5_6_5} or @code{GLU_UNSIGNED_SHORT_5_6_5_REV}
+and @var{format} is not @code{GLU_RGB}.
+
+@code{GLU_INVALID_OPERATION} is returned if @var{type} is
+@code{GLU_UNSIGNED_SHORT_4_4_4_4} or
+@code{GLU_UNSIGNED_SHORT_4_4_4_4_REV} and @var{format} is neither
+@code{GLU_RGBA} nor @code{GLU_BGRA}.
+
+@code{GLU_INVALID_OPERATION} is returned if @var{type} is
+@code{GLU_UNSIGNED_SHORT_5_5_5_1} or
+@code{GLU_UNSIGNED_SHORT_1_5_5_5_REV} and @var{format} is neither
+@code{GLU_RGBA} nor @code{GLU_BGRA}.
+
+@code{GLU_INVALID_OPERATION} is returned if @var{type} is
+@code{GLU_UNSIGNED_INT_8_8_8_8} or @code{GLU_UNSIGNED_INT_8_8_8_8_REV}
+and @var{format} is neither @code{GLU_RGBA} nor @code{GLU_BGRA}.
+
+@code{GLU_INVALID_OPERATION} is returned if @var{type} is
+@code{GLU_UNSIGNED_INT_10_10_10_2} or
+@code{GLU_UNSIGNED_INT_2_10_10_10_REV} and @var{format} is neither
+@code{GLU_RGBA} nor @code{GLU_BGRA}.
+
+@end defun
+
+@defun gluBuild3DMipmapLevels
+@heading builds a subset of three-dimensional mipmap levels
+@heading Parameters
+@table @asis
+@item @var{target}
+Specifies the target texture. Must be @code{GLU_TEXTURE_3D}.
+
+@item @var{internalFormat}
+Requests the internal storage format of the texture image. The most
+current version of the SGI implementation of GLU does not check this
+value for validity before passing it on to the underlying OpenGL
+implementation. A value that is not accepted by the OpenGL
+implementation will lead to an OpenGL error. The benefit of not checking
+this value at the GLU level is that OpenGL extensions can add new
+internal texture formats without requiring a revision of the GLU
+implementation. Older implementations of GLU check this value and raise
+a GLU error if it is not 1, 2, 3, or 4 or one of the following symbolic
+constants: @code{GLU_ALPHA}, @code{GLU_ALPHA4}, @code{GLU_ALPHA8},
+@code{GLU_ALPHA12}, @code{GLU_ALPHA16}, @code{GLU_LUMINANCE},
+@code{GLU_LUMINANCE4}, @code{GLU_LUMINANCE8}, @code{GLU_LUMINANCE12},
+@code{GLU_LUMINANCE16}, @code{GLU_LUMINANCE_ALPHA},
+@code{GLU_LUMINANCE4_ALPHA4}, @code{GLU_LUMINANCE6_ALPHA2},
+@code{GLU_LUMINANCE8_ALPHA8}, @code{GLU_LUMINANCE12_ALPHA4},
+@code{GLU_LUMINANCE12_ALPHA12}, @code{GLU_LUMINANCE16_ALPHA16},
+@code{GLU_INTENSITY}, @code{GLU_INTENSITY4}, @code{GLU_INTENSITY8},
+@code{GLU_INTENSITY12}, @code{GLU_INTENSITY16}, @code{GLU_RGB},
+@code{GLU_R3_G3_B2}, @code{GLU_RGB4}, @code{GLU_RGB5}, @code{GLU_RGB8},
+@code{GLU_RGB10}, @code{GLU_RGB12}, @code{GLU_RGB16}, @code{GLU_RGBA},
+@code{GLU_RGBA2}, @code{GLU_RGBA4}, @code{GLU_RGB5_A1},
+@code{GLU_RGBA8}, @code{GLU_RGB10_A2}, @code{GLU_RGBA12}, or
+@code{GLU_RGBA16}.
+
+@item @var{width}
+@itemx @var{height}
+@itemx @var{depth}
+Specifies in pixels the width, height and depth respectively, of the
+texture image. These should be a power of 2.
+
+@item @var{format}
+Specifies the format of the pixel data. Must be one of
+@code{GLU_COLOR_INDEX}, @code{GLU_DEPTH_COMPONENT}, @code{GLU_RED},
+@code{GLU_GREEN}, @code{GLU_BLUE}, @code{GLU_ALPHA}, @code{GLU_RGB},
+@code{GLU_RGBA}, @code{GLU_BGR}, @code{GLU_BGRA}, @code{GLU_LUMINANCE},
+or @code{GLU_LUMINANCE_ALPHA}.
+
+@item @var{type}
+Specifies the data type for @var{data}. Must be one of
+@code{GLU_UNSIGNED_BYTE}, @code{GLU_BYTE}, @code{GLU_BITMAP},
+@code{GLU_UNSIGNED_SHORT}, @code{GLU_SHORT}, @code{GLU_UNSIGNED_INT},
+@code{GLU_INT}, @code{GLU_FLOAT}, @code{GLU_UNSIGNED_BYTE_3_3_2},
+@code{GLU_UNSIGNED_BYTE_2_3_3_REV}, @code{GLU_UNSIGNED_SHORT_5_6_5},
+@code{GLU_UNSIGNED_SHORT_5_6_5_REV}, @code{GLU_UNSIGNED_SHORT_4_4_4_4},
+@code{GLU_UNSIGNED_SHORT_4_4_4_4_REV},
+@code{GLU_UNSIGNED_SHORT_5_5_5_1},
+@code{GLU_UNSIGNED_SHORT_1_5_5_5_REV}, @code{GLU_UNSIGNED_INT_8_8_8_8},
+@code{GLU_UNSIGNED_INT_8_8_8_8_REV}, @code{GLU_UNSIGNED_INT_10_10_10_2},
+or @code{GLU_UNSIGNED_INT_2_10_10_10_REV}.
+
+@item @var{level}
+Specifies the mipmap level of the image data.
+
+@item @var{base}
+Specifies the minimum mipmap level to pass to @code{glTexImage3D}.
+
+@item @var{max}
+Specifies the maximum mipmap level to pass to @code{glTexImage3D}.
+
+@item @var{data}
+Specifies a pointer to the image data in memory.
+
+@end table
+
+@heading Description
+@code{gluBuild3DMipmapLevels} builds a subset of prefiltered
+three-dimensional texture maps of decreasing resolutions called a
+mipmap. This is used for the antialiasing of texture mapped primitives.
+
+A return value of zero indicates success, otherwise a GLU error code is
+returned (see @code{gluErrorString}).
+
+A series of mipmap levels from @var{base} to @var{max} is built by
+decimating @var{data} in half along both dimensions until size
+@math{1×1×1} is reached. At each level, each texel in the halved mipmap
+level is an average of the corresponding eight texels in the larger
+mipmap level. (If exactly one of the dimensions is 1, four texels are
+averaged. If exactly two of the dimensions are 1, two texels are
+averaged.) @code{glTexImage3D} is called to load these mipmap levels
+from @var{base} to @var{max}. If @var{max} is larger than the highest
+mipmap level for the texture of the specified size, then a GLU error
+code is returned (see @code{gluErrorString}) and nothing is loaded.
+
+For example, if @var{level} is 2 and @var{width} is 16, @var{height} is
+8 and @var{depth} is 4, the following levels are possible:
+@math{16×8×4}, @math{8×4×2}, @math{4×2×1}, @math{2×1×1}, @math{1×1×1}.
+These correspond to levels 2 through 6 respectively. If @var{base} is 3
+and @var{max} is 5, then only mipmap levels @math{8×4×2}, @math{4×2×1},
+and @math{2×1×1} are loaded. However, if @var{max} is 7, then an error
+is returned and nothing is loaded, since @var{max} is larger than the
+highest mipmap level which is, in this case, 6.
+
+The highest mipmap level can be derived from the formula
+@math{@var{log}_2(@var{max}(@var{width},@var{height}@var{depth})×2^@var{level},)}.
+
+See the @code{glTexImage1D} reference page for a description of the
+acceptable values for @var{format} parameter. See the
+@code{glDrawPixels} reference page for a description of the acceptable
+values for @var{type} parameter.
+
+@heading Errors
+@code{GLU_INVALID_VALUE} is returned if @var{level} > @var{base},
+@var{base} < 0, @var{max} < @var{base}, or @var{max} is > the highest
+mipmap level for @var{data}.
+
+@code{GLU_INVALID_VALUE} is returned if @var{width}, @var{height}, or
+@var{depth} is < 1.
+
+@code{GLU_INVALID_ENUM} is returned if @var{internalFormat},
+@var{format}, or @var{type} is not legal.
+
+@code{GLU_INVALID_OPERATION} is returned if @var{type} is
+@code{GLU_UNSIGNED_BYTE_3_3_2} or @code{GLU_UNSIGNED_BYTE_2_3_3_REV} and
+@var{format} is not @code{GLU_RGB}.
+
+@code{GLU_INVALID_OPERATION} is returned if @var{type} is
+@code{GLU_UNSIGNED_SHORT_5_6_5} or @code{GLU_UNSIGNED_SHORT_5_6_5_REV}
+and @var{format} is not @code{GLU_RGB}.
+
+@code{GLU_INVALID_OPERATION} is returned if @var{type} is
+@code{GLU_UNSIGNED_SHORT_4_4_4_4} or
+@code{GLU_UNSIGNED_SHORT_4_4_4_4_REV} and @var{format} is neither
+@code{GLU_RGBA} nor @code{GLU_BGRA}.
+
+@code{GLU_INVALID_OPERATION} is returned if @var{type} is
+@code{GLU_UNSIGNED_SHORT_5_5_5_1} or
+@code{GLU_UNSIGNED_SHORT_1_5_5_5_REV} and @var{format} is neither
+@code{GLU_RGBA} nor @code{GLU_BGRA}.
+
+@code{GLU_INVALID_OPERATION} is returned if @var{type} is
+@code{GLU_UNSIGNED_INT_8_8_8_8} or @code{GLU_UNSIGNED_INT_8_8_8_8_REV}
+and @var{format} is neither @code{GLU_RGBA} nor @code{GLU_BGRA}.
+
+@code{GLU_INVALID_OPERATION} is returned if @var{type} is
+@code{GLU_UNSIGNED_INT_10_10_10_2} or
+@code{GLU_UNSIGNED_INT_2_10_10_10_REV} and @var{format} is neither
+@code{GLU_RGBA} nor @code{GLU_BGRA}.
+
+@end defun
+
+@defun gluBuild3DMipmaps
+@heading builds a three-dimensional mipmap
+@heading Parameters
+@table @asis
+@item @var{target}
+Specifies the target texture. Must be @code{GLU_TEXTURE_3D}.
+
+@item @var{internalFormat}
+Requests the internal storage format of the texture image. The most
+current version of the SGI implementation of GLU does not check this
+value for validity before passing it on to the underlying OpenGL
+implementation. A value that is not accepted by the OpenGL
+implementation will lead to an OpenGL error. The benefit of not checking
+this value at the GLU level is that OpenGL extensions can add new
+internal texture formats without requiring a revision of the GLU
+implementation. Older implementations of GLU check this value and raise
+a GLU error if it is not 1, 2, 3, or 4 or one of the following symbolic
+constants: @code{GLU_ALPHA}, @code{GLU_ALPHA4}, @code{GLU_ALPHA8},
+@code{GLU_ALPHA12}, @code{GLU_ALPHA16}, @code{GLU_LUMINANCE},
+@code{GLU_LUMINANCE4}, @code{GLU_LUMINANCE8}, @code{GLU_LUMINANCE12},
+@code{GLU_LUMINANCE16}, @code{GLU_LUMINANCE_ALPHA},
+@code{GLU_LUMINANCE4_ALPHA4}, @code{GLU_LUMINANCE6_ALPHA2},
+@code{GLU_LUMINANCE8_ALPHA8}, @code{GLU_LUMINANCE12_ALPHA4},
+@code{GLU_LUMINANCE12_ALPHA12}, @code{GLU_LUMINANCE16_ALPHA16},
+@code{GLU_INTENSITY}, @code{GLU_INTENSITY4}, @code{GLU_INTENSITY8},
+@code{GLU_INTENSITY12}, @code{GLU_INTENSITY16}, @code{GLU_RGB},
+@code{GLU_R3_G3_B2}, @code{GLU_RGB4}, @code{GLU_RGB5}, @code{GLU_RGB8},
+@code{GLU_RGB10}, @code{GLU_RGB12}, @code{GLU_RGB16}, @code{GLU_RGBA},
+@code{GLU_RGBA2}, @code{GLU_RGBA4}, @code{GLU_RGB5_A1},
+@code{GLU_RGBA8}, @code{GLU_RGB10_A2}, @code{GLU_RGBA12}, or
+@code{GLU_RGBA16}.
+
+@item @var{width}
+@itemx @var{height}
+@itemx @var{depth}
+Specifies in pixels the width, height and depth respectively, in pixels
+of the texture image.
+
+@item @var{format}
+Specifies the format of the pixel data. Must be one of
+@code{GLU_COLOR_INDEX}, @code{GLU_DEPTH_COMPONENT}, @code{GLU_RED},
+@code{GLU_GREEN}, @code{GLU_BLUE}, @code{GLU_ALPHA}, @code{GLU_RGB},
+@code{GLU_RGBA}, @code{GLU_BGR}, @code{GLU_BGRA}, @code{GLU_LUMINANCE},
+or @code{GLU_LUMINANCE_ALPHA}.
+
+@item @var{type}
+Specifies the data type for @var{data}. Must be one of:
+@code{GLU_UNSIGNED_BYTE}, @code{GLU_BYTE}, @code{GLU_BITMAP},
+@code{GLU_UNSIGNED_SHORT}, @code{GLU_SHORT}, @code{GLU_UNSIGNED_INT},
+@code{GLU_INT}, @code{GLU_FLOAT}, @code{GLU_UNSIGNED_BYTE_3_3_2},
+@code{GLU_UNSIGNED_BYTE_2_3_3_REV}, @code{GLU_UNSIGNED_SHORT_5_6_5},
+@code{GLU_UNSIGNED_SHORT_5_6_5_REV}, @code{GLU_UNSIGNED_SHORT_4_4_4_4},
+@code{GLU_UNSIGNED_SHORT_4_4_4_4_REV},
+@code{GLU_UNSIGNED_SHORT_5_5_5_1},
+@code{GLU_UNSIGNED_SHORT_1_5_5_5_REV}, @code{GLU_UNSIGNED_INT_8_8_8_8},
+@code{GLU_UNSIGNED_INT_8_8_8_8_REV}, @code{GLU_UNSIGNED_INT_10_10_10_2},
+or @code{GLU_UNSIGNED_INT_2_10_10_10_REV}.
+
+@item @var{data}
+Specifies a pointer to the image data in memory.
+
+@end table
+
+@heading Description
+@code{gluBuild3DMipmaps} builds a series of prefiltered
+three-dimensional texture maps of decreasing resolutions called a
+mipmap. This is used for the antialiasing of texture-mapped primitives.
+
+A return value of zero indicates success, otherwise a GLU error code is
+returned (see @code{gluErrorString}).
+
+Initially, the @var{width}, @var{height} and @var{depth} of @var{data}
+are checked to see if they are a power of 2. If not, a copy of
+@var{data} is made and scaled up or down to the nearest power of 2. (If
+@var{width}, @var{height}, or @var{depth} is exactly between powers of
+2, then the copy of @var{data} will scale upwards.) This copy will be
+used for subsequent mipmapping operations described below. For example,
+if @var{width} is 57, @var{height} is 23, and @var{depth} is 24, then a
+copy of @var{data} will scale up to 64 in width, down to 16 in height,
+and up to 32 in depth before mipmapping takes place.
+
+Then, proxy textures (see @code{glTexImage3D}) are used to determine if
+the implementation can fit the requested texture. If not, all three
+dimensions are continually halved until it fits.
+
+Next, a series of mipmap levels is built by decimating a copy of
+@var{data} in half along all three dimensions until size @math{1×1×1} is
+reached. At each level, each texel in the halved mipmap level is an
+average of the corresponding eight texels in the larger mipmap level.
+(If exactly one of the dimensions is 1, four texels are averaged. If
+exactly two of the dimensions are 1, two texels are averaged.)
+
+@code{glTexImage3D} is called to load each of these mipmap levels. Level
+0 is a copy of @var{data}. The highest level is
+@math{@var{log}_2,(@var{max}(@var{width},@var{height}@var{depth}),)}.
+For example, if @var{width} is 64, @var{height} is 16, and @var{depth}
+is 32, and the implementation can store a texture of this size, the
+following mipmap levels are built: @math{64×16×32}, @math{32×8×16},
+@math{16×4×8}, @math{8×2×4}, @math{4×1×2}, @math{2×1×1}, and
+@math{1×1×1}. These correspond to levels 0 through 6, respectively.
+
+See the @code{glTexImage1D} reference page for a description of the
+acceptable values for @var{format} parameter. See the
+@code{glDrawPixels} reference page for a description of the acceptable
+values for @var{type} parameter.
+
+@heading Errors
+@code{GLU_INVALID_VALUE} is returned if @var{width}, @var{height}, or
+@var{depth} is < 1.
+
+@code{GLU_INVALID_ENUM} is returned if @var{internalFormat},
+@var{format}, or @var{type} is not legal.
+
+@code{GLU_INVALID_OPERATION} is returned if @var{type} is
+@code{GLU_UNSIGNED_BYTE_3_3_2} or @code{GLU_UNSIGNED_BYTE_2_3_3_REV} and
+@var{format} is not @code{GLU_RGB}.
+
+@code{GLU_INVALID_OPERATION} is returned if @var{type} is
+@code{GLU_UNSIGNED_SHORT_5_6_5} or @code{GLU_UNSIGNED_SHORT_5_6_5_REV}
+and @var{format} is not @code{GLU_RGB}.
+
+@code{GLU_INVALID_OPERATION} is returned if @var{type} is
+@code{GLU_UNSIGNED_SHORT_4_4_4_4} or
+@code{GLU_UNSIGNED_SHORT_4_4_4_4_REV} and @var{format} is neither
+@code{GLU_RGBA} nor @code{GLU_BGRA}.
+
+@code{GLU_INVALID_OPERATION} is returned if @var{type} is
+@code{GLU_UNSIGNED_SHORT_5_5_5_1} or
+@code{GLU_UNSIGNED_SHORT_1_5_5_5_REV} and @var{format} is neither
+@code{GLU_RGBA} nor @code{GLU_BGRA}.
+
+@code{GLU_INVALID_OPERATION} is returned if @var{type} is
+@code{GLU_UNSIGNED_INT_8_8_8_8} or @code{GLU_UNSIGNED_INT_8_8_8_8_REV}
+and @var{format} is neither @code{GLU_RGBA} nor @code{GLU_BGRA}.
+
+@code{GLU_INVALID_OPERATION} is returned if @var{type} is
+@code{GLU_UNSIGNED_INT_10_10_10_2} or
+@code{GLU_UNSIGNED_INT_2_10_10_10_REV} and @var{format} is neither
+@code{GLU_RGBA} nor @code{GLU_BGRA}.
+
+@end defun
+
+@defun gluCheckExtension
+@heading determines if an extension name is supported
+@heading Parameters
+@table @asis
+@item @var{extName}
+Specifies an extension name.
+
+@item @var{extString}
+Specifies a space-separated list of extension names supported.
+
+@end table
+
+@heading Description
+@code{gluCheckExtension} returns @code{GLU_TRUE} if @var{extName} is
+supported otherwise @code{GLU_FALSE} is returned.
+
+This is used to check for the presence for OpenGL, GLU, or GLX extension
+names by passing the extension strings returned by @code{glGetString},
+@code{gluGetString}, @code{glXGetClientString},
+@code{glXQueryExtensionsString}, or @code{glXQueryServerString},
+respectively, as @var{extString}.
+
+@end defun
+
+@defun gluCylinder
+@heading draw a cylinder
+@heading Parameters
+@table @asis
+@item @var{quad}
+Specifies the quadrics object (created with @code{gluNewQuadric}).
+
+@item @var{base}
+Specifies the radius of the cylinder at @var{z} = 0.
+
+@item @var{top}
+Specifies the radius of the cylinder at @var{z} = @var{height}.
+
+@item @var{height}
+Specifies the height of the cylinder.
+
+@item @var{slices}
+Specifies the number of subdivisions around the @var{z} axis.
+
+@item @var{stacks}
+Specifies the number of subdivisions along the @var{z} axis.
+
+@end table
+
+@heading Description
+@code{gluCylinder} draws a cylinder oriented along the @var{z} axis. The
+base of the cylinder is placed at @var{z} = 0 and the top at
+@math{@var{z}=@var{height}}. Like a sphere, a cylinder is subdivided
+around the @var{z} axis into slices and along the @var{z} axis into
+stacks.
+
+Note that if @var{top} is set to 0.0, this routine generates a cone.
+
+If the orientation is set to @code{GLU_OUTSIDE} (with
+@code{gluQuadricOrientation}), then any generated normals point away
+from the @var{z} axis. Otherwise, they point toward the @var{z} axis.
+
+If texturing is turned on (with @code{gluQuadricTexture}), then texture
+coordinates are generated so that @var{t} ranges linearly from 0.0 at
+@var{z} = 0 to 1.0 at @var{z} = @var{height}, and @var{s} ranges from
+0.0 at the +@var{y} axis, to 0.25 at the +@var{x} axis, to 0.5 at the
+-@var{y} axis, to 0.75 at the \-@var{x} axis, and back to 1.0 at the
++@var{y} axis.
+
+@end defun
+
+@defun gluDeleteNurbsRenderer
+@heading destroy a NURBS object
+@heading Parameters
+@table @asis
+@item @var{nurb}
+Specifies the NURBS object to be destroyed.
+
+@end table
+
+@heading Description
+@code{gluDeleteNurbsRenderer} destroys the NURBS object (which was
+created with @code{gluNewNurbsRenderer}) and frees any memory it uses.
+Once @code{gluDeleteNurbsRenderer} has been called, @var{nurb} cannot be
+used again.
+
+@end defun
+
+@defun gluDeleteQuadric
+@heading destroy a quadrics object
+@heading Parameters
+@table @asis
+@item @var{quad}
+Specifies the quadrics object to be destroyed.
+
+@end table
+
+@heading Description
+@code{gluDeleteQuadric} destroys the quadrics object (created with
+@code{gluNewQuadric}) and frees any memory it uses. Once
+@code{gluDeleteQuadric} has been called, @var{quad} cannot be used
+again.
+
+@end defun
+
+@defun gluDeleteTess
+@heading destroy a tessellation object
+@heading Parameters
+@table @asis
+@item @var{tess}
+Specifies the tessellation object to destroy.
+
+@end table
+
+@heading Description
+@code{gluDeleteTess} destroys the indicated tessellation object (which
+was created with @code{gluNewTess}) and frees any memory that it used.
+
+@end defun
+
+@defun gluDisk
+@heading draw a disk
+@heading Parameters
+@table @asis
+@item @var{quad}
+Specifies the quadrics object (created with @code{gluNewQuadric}).
+
+@item @var{inner}
+Specifies the inner radius of the disk (may be 0).
+
+@item @var{outer}
+Specifies the outer radius of the disk.
+
+@item @var{slices}
+Specifies the number of subdivisions around the @var{z} axis.
+
+@item @var{loops}
+Specifies the number of concentric rings about the origin into which the
+disk is subdivided.
+
+@end table
+
+@heading Description
+@code{gluDisk} renders a disk on the @var{z} = 0 plane. The disk has a
+radius of @var{outer} and contains a concentric circular hole with a
+radius of @var{inner}. If @var{inner} is 0, then no hole is generated.
+The disk is subdivided around the @var{z} axis into slices (like pizza
+slices) and also about the @var{z} axis into rings (as specified by
+@var{slices} and @var{loops}, respectively).
+
+With respect to orientation, the +@var{z} side of the disk is considered
+to be ``outside'' (see @code{gluQuadricOrientation}). This means that if
+the orientation is set to @code{GLU_OUTSIDE}, then any normals generated
+point along the +@var{z} axis. Otherwise, they point along the \-@var{z}
+axis.
+
+If texturing has been turned on (with @code{gluQuadricTexture}), texture
+coordinates are generated linearly such that where
+@math{@var{r}=@var{outer}}, the value at (@var{r}, 0, 0) is (1, 0.5), at
+(0, @var{r}, 0) it is (0.5, 1), at (\-@var{r}, 0, 0) it is (0, 0.5), and
+at (0, \-@var{r}, 0) it is (0.5, 0).
+
+@end defun
+
+@defun gluErrorString
+@heading produce an error string from a GL or GLU error code
+@heading Parameters
+@table @asis
+@item @var{error}
+Specifies a GL or GLU error code.
+
+@end table
+
+@heading Description
+@code{gluErrorString} produces an error string from a GL or GLU error
+code. The string is in ISO Latin 1 format. For example,
+@code{gluErrorString}(@code{GLU_OUT_OF_MEMORY}) returns the string
+@var{out of memory}.
+
+The standard GLU error codes are @code{GLU_INVALID_ENUM},
+@code{GLU_INVALID_VALUE}, and @code{GLU_OUT_OF_MEMORY}. Certain other
+GLU functions can return specialized error codes through callbacks. See
+the @code{glGetError} reference page for the list of GL error codes.
+
+@heading Errors
+@code{NULL} is returned if @var{error} is not a valid GL or GLU error
+code.
+
+@end defun
+
+@defun gluGetNurbsProperty
+@heading get a NURBS property
+@heading Parameters
+@table @asis
+@item @var{nurb}
+Specifies the NURBS object (created with @code{gluNewNurbsRenderer}).
+
+@item @var{property}
+Specifies the property whose value is to be fetched. Valid values are
+@code{GLU_CULLING}, @code{GLU_SAMPLING_TOLERANCE},
+@code{GLU_DISPLAY_MODE}, @code{GLU_AUTO_LOAD_MATRIX},
+@code{GLU_PARAMETRIC_TOLERANCE}, @code{GLU_SAMPLING_METHOD},
+@code{GLU_U_STEP}, @code{GLU_V_STEP}, and @code{GLU_NURBS_MODE}.
+
+@item @var{data}
+Specifies a pointer to the location into which the value of the named
+property is written.
+
+@end table
+
+@heading Description
+@code{gluGetNurbsProperty} retrieves properties stored in a NURBS
+object. These properties affect the way that NURBS curves and surfaces
+are rendered. See the @code{gluNurbsProperty} reference page for
+information about what the properties are and what they do.
+
+@end defun
+
+@defun gluGetString
+@heading return a string describing the GLU version or GLU extensions
+@heading Parameters
+@table @asis
+@item @var{name}
+Specifies a symbolic constant, one of @code{GLU_VERSION}, or
+@code{GLU_EXTENSIONS}.
+
+@end table
+
+@heading Description
+@code{gluGetString} returns a pointer to a static string describing the
+GLU version or the GLU extensions that are supported.
+
+The version number is one of the following forms:
+
+@var{major_number.minor_number}@var{major_number.minor_number.release_number}.
+
+The version string is of the following form:
+
+@var{version number<space>vendor-specific information}
+
+Vendor-specific information is optional. Its format and contents depend
+on the implementation.
+
+The standard GLU contains a basic set of features and capabilities. If a
+company or group of companies wish to support other features, these may
+be included as extensions to the GLU. If @var{name} is
+@code{GLU_EXTENSIONS}, then @code{gluGetString} returns a
+space-separated list of names of supported GLU extensions. (Extension
+names never contain spaces.)
+
+All strings are null-terminated.
+
+@heading Errors
+NULL is returned if @var{name} is not @code{GLU_VERSION} or
+@code{GLU_EXTENSIONS}.
+
+
+
+@end defun
+
+@defun gluGetTessProperty
+@heading get a tessellation object property
+@heading Parameters
+@table @asis
+@item @var{tess}
+Specifies the tessellation object (created with @code{gluNewTess}).
+
+@item @var{which}
+Specifies the property whose value is to be fetched. Valid values are
+@code{GLU_TESS_WINDING_RULE}, @code{GLU_TESS_BOUNDARY_ONLY}, and
+@code{GLU_TESS_TOLERANCE}.
+
+@item @var{data}
+Specifies a pointer to the location into which the value of the named
+property is written.
+
+@end table
+
+@heading Description
+@code{gluGetTessProperty} retrieves properties stored in a tessellation
+object. These properties affect the way that tessellation objects are
+interpreted and rendered. See the @code{gluTessProperty} reference page
+for information about the properties and what they do.
+
+@end defun
+
+@defun gluLoadSamplingMatrices
+@heading load NURBS sampling and culling matrices
+@heading Parameters
+@table @asis
+@item @var{nurb}
+Specifies the NURBS object (created with @code{gluNewNurbsRenderer}).
+
+@item @var{model}
+Specifies a modelview matrix (as from a @code{glGetFloatv} call).
+
+@item @var{perspective}
+Specifies a projection matrix (as from a @code{glGetFloatv} call).
+
+@item @var{view}
+Specifies a viewport (as from a @code{glGetIntegerv} call).
+
+@end table
+
+@heading Description
+@code{gluLoadSamplingMatrices} uses @var{model}, @var{perspective}, and
+@var{view} to recompute the sampling and culling matrices stored in
+@var{nurb}. The sampling matrix determines how finely a NURBS curve or
+surface must be tessellated to satisfy the sampling tolerance (as
+determined by the @code{GLU_SAMPLING_TOLERANCE} property). The culling
+matrix is used in deciding if a NURBS curve or surface should be culled
+before rendering (when the @code{GLU_CULLING} property is turned on).
+
+@code{gluLoadSamplingMatrices} is necessary only if the
+@code{GLU_AUTO_LOAD_MATRIX} property is turned off (see
+@code{gluNurbsProperty}). Although it can be convenient to leave the
+@code{GLU_AUTO_LOAD_MATRIX} property turned on, there can be a
+performance penalty for doing so. (A round trip to the GL server is
+needed to fetch the current values of the modelview matrix, projection
+matrix, and viewport.)
+
+@end defun
+
+@defun gluLookAt
+@heading define a viewing transformation
+@heading Parameters
+@table @asis
+@item @var{eyeX}
+@itemx @var{eyeY}
+@itemx @var{eyeZ}
+Specifies the position of the eye point.
+
+@item @var{centerX}
+@itemx @var{centerY}
+@itemx @var{centerZ}
+Specifies the position of the reference point.
+
+@item @var{upX}
+@itemx @var{upY}
+@itemx @var{upZ}
+Specifies the direction of the @var{up} vector.
+
+@end table
+
+@heading Description
+@code{gluLookAt} creates a viewing matrix derived from an eye point, a
+reference point indicating the center of the scene, and an @var{UP}
+vector.
+
+The matrix maps the reference point to the negative @var{z} axis and the
+eye point to the origin. When a typical projection matrix is used, the
+center of the scene therefore maps to the center of the viewport.
+Similarly, the direction described by the @var{UP} vector projected onto
+the viewing plane is mapped to the positive @var{y} axis so that it
+points upward in the viewport. The @var{UP} vector must not be parallel
+to the line of sight from the eye point to the reference point.
+
+Let
+
+@math{@var{F}=((@var{centerX}-@var{eyeX}), (@var{centerY}-@var{eyeY}),
+(@var{centerZ}-@var{eyeZ}),)}
+
+
+
+Let @var{UP} be the vector @math{(@var{upX},@var{upY}@var{upZ})}.
+
+Then normalize as follows: @math{@var{f}=@var{F}/∥@var{F},∥,}
+
+@math{@var{UP}^″=@var{UP}/∥@var{UP},∥,}
+
+
+
+Finally, let @math{@var{s}=@var{f}×@var{UP}^″}, and
+@math{@var{u}=@var{s}×@var{f}}.
+
+
+
+M is then constructed as follows: @math{@var{M}=((@var{s}[0,]
+@var{s}[1,] @var{s}[2,] 0), (@var{u}[0,] @var{u}[1,] @var{u}[2,]
+0), (-@var{f}[0,] -@var{f}[1,] -@var{f}[2,] 0), (0 0 0 1),)}
+
+and @code{gluLookAt} is equivalent to
+
+@example
+
+glMultMatrixf(M);
+glTranslated(-eyex, -eyey, -eyez);
+@end example
+
+@end defun
+
+@defun gluNewNurbsRenderer
+@heading create a NURBS object
+@heading Description
+@code{gluNewNurbsRenderer} creates and returns a pointer to a new NURBS
+object. This object must be referred to when calling NURBS rendering and
+control functions. A return value of 0 means that there is not enough
+memory to allocate the object.
+
+@end defun
+
+@defun gluNewQuadric
+@heading create a quadrics object
+@heading Description
+@code{gluNewQuadric} creates and returns a pointer to a new quadrics
+object. This object must be referred to when calling quadrics rendering
+and control functions. A return value of 0 means that there is not
+enough memory to allocate the object.
+
+@end defun
+
+@defun gluNewTess
+@heading create a tessellation object
+@heading Description
+@code{gluNewTess} creates and returns a pointer to a new tessellation
+object. This object must be referred to when calling tessellation
+functions. A return value of 0 means that there is not enough memory to
+allocate the object.
+
+@end defun
+
+@defun gluNextContour
+@heading mark the beginning of another contour
+@heading Parameters
+@table @asis
+@item @var{tess}
+Specifies the tessellation object (created with @code{gluNewTess}).
+
+@item @var{type}
+Specifies the type of the contour being defined. Valid values are
+@code{GLU_EXTERIOR}, @code{GLU_INTERIOR}, @code{GLU_UNKNOWN},
+@code{GLU_CCW}, and @code{GLU_CW}.
+
+@end table
+
+@heading Description
+@code{gluNextContour} is used in describing polygons with multiple
+contours. After the first contour has been described through a series of
+@code{gluTessVertex} calls, a @code{gluNextContour} call indicates that
+the previous contour is complete and that the next contour is about to
+begin. Another series of @code{gluTessVertex} calls is then used to
+describe the new contour. This process can be repeated until all
+contours have been described.
+
+@var{type} defines what type of contour follows. The legal contour types
+are as follows:
+
+@table @asis
+@item @code{GLU_EXTERIOR}
+An exterior contour defines an exterior boundary of the polygon.
+
+@item @code{GLU_INTERIOR}
+An interior contour defines an interior boundary of the polygon (such as
+a hole).
+
+@item @code{GLU_UNKNOWN}
+An unknown contour is analyzed by the library to determine if it is
+interior or exterior.
+
+@item @code{GLU_CCW},
+@item @code{GLU_CW}
+The first @code{GLU_CCW} or @code{GLU_CW} contour defined is considered
+to be exterior. All other contours are considered to be exterior if they
+are oriented in the same direction (clockwise or counterclockwise) as
+the first contour, and interior if they are not.
+
+@end table
+
+If one contour is of type @code{GLU_CCW} or @code{GLU_CW}, then all
+contours must be of the same type (if they are not, then all
+@code{GLU_CCW} and @code{GLU_CW} contours will be changed to
+@code{GLU_UNKNOWN}).
+
+Note that there is no real difference between the @code{GLU_CCW} and
+@code{GLU_CW} contour types.
+
+Before the first contour is described, @code{gluNextContour} can be
+called to define the type of the first contour. If @code{gluNextContour}
+is not called before the first contour, then the first contour is marked
+@code{GLU_EXTERIOR}.
+
+This command is obsolete and is provided for backward compatibility
+only. Calls to @code{gluNextContour} are mapped to
+@code{gluTessEndContour} followed by @code{gluTessBeginContour}.
+
+@end defun
+
+@defun gluNurbsCallbackDataEXT
+@heading set a user data pointer
+@heading Parameters
+@table @asis
+@item @var{nurb}
+Specifies the NURBS object (created with @code{gluNewNurbsRenderer}).
+
+@item @var{userData}
+Specifies a pointer to the user's data.
+
+@end table
+
+@heading Description
+@code{gluNurbsCallbackDataEXT} is used to pass a pointer to the
+application's data to NURBS tessellator. A copy of this pointer will be
+passed by the tessellator in the NURBS callback functions (set by
+@code{gluNurbsCallback}).
+
+@end defun
+
+@defun gluNurbsCallbackData
+@heading set a user data pointer
+@heading Parameters
+@table @asis
+@item @var{nurb}
+Specifies the NURBS object (created with @code{gluNewNurbsRenderer}).
+
+@item @var{userData}
+Specifies a pointer to the user's data.
+
+@end table
+
+@heading Description
+@code{gluNurbsCallbackData} is used to pass a pointer to the
+application's data to NURBS tessellator. A copy of this pointer will be
+passed by the tessellator in the NURBS callback functions (set by
+@code{gluNurbsCallback}).
+
+@end defun
+
+@defun gluNurbsCallback
+@heading define a callback for a NURBS object
+@heading Parameters
+@table @asis
+@item @var{nurb}
+Specifies the NURBS object (created with @code{gluNewNurbsRenderer}).
+
+@item @var{which}
+Specifies the callback being defined. Valid values are
+@code{GLU_NURBS_BEGIN}, @code{GLU_NURBS_VERTEX},
+@code{GLU_NURBS_NORMAL}, @code{GLU_NURBS_COLOR},
+@code{GLU_NURBS_TEXTURE_COORD}, @code{GLU_NURBS_END},
+@code{GLU_NURBS_BEGIN_DATA}, @code{GLU_NURBS_VERTEX_DATA},
+@code{GLU_NURBS_NORMAL_DATA}, @code{GLU_NURBS_COLOR_DATA},
+@code{GLU_NURBS_TEXTURE_COORD_DATA}, @code{GLU_NURBS_END_DATA}, and
+@code{GLU_NURBS_ERROR}.
+
+@item @var{CallBackFunc}
+Specifies the function that the callback calls.
+
+@end table
+
+@heading Description
+@code{gluNurbsCallback} is used to define a callback to be used by a
+NURBS object. If the specified callback is already defined, then it is
+replaced. If @var{CallBackFunc} is NULL, then this callback will not get
+invoked and the related data, if any, will be lost.
+
+Except the error callback, these callbacks are used by NURBS tessellator
+(when @code{GLU_NURBS_MODE} is set to be @code{GLU_NURBS_TESSELLATOR})
+to return back the OpenGL polygon primitives resulting from the
+tessellation. Note that there are two versions of each callback: one
+with a user data pointer and one without. If both versions for a
+particular callback are specified then the callback with the user data
+pointer will be used. Note that ``userData'' is a copy of the pointer
+that was specified at the last call to @code{gluNurbsCallbackData}.
+
+The error callback function is effective no matter which value that
+@code{GLU_NURBS_MODE} is set to. All other callback functions are
+effective only when @code{GLU_NURBS_MODE} is set to
+@code{GLU_NURBS_TESSELLATOR}.
+
+The legal callbacks are as follows:
+
+@table @asis
+@item @code{GLU_NURBS_BEGIN}
+
+
+The begin callback indicates the start of a primitive. The function
+takes a single argument of type GLenum, which can be one of
+@code{GLU_LINES}, @code{GLU_LINE_STRIP}, @code{GLU_TRIANGLE_FAN},
+@code{GLU_TRIANGLE_STRIP}, @code{GLU_TRIANGLES}, or
+@code{GLU_QUAD_STRIP}. The default begin callback function is NULL. The
+function prototype for this callback looks like:
+
+@item @code{GLU_NURBS_BEGIN_DATA}
+
+
+The same as the @code{GLU_NURBS_BEGIN} callback except that it takes an
+additional pointer argument. This pointer is a copy of the pointer that
+was specified at the last call to @code{gluNurbsCallbackData}. The
+default callback function is NULL. The function prototype for this
+callback function looks like:
+
+@item @code{GLU_NURBS_VERTEX}
+
+
+The vertex callback indicates a vertex of the primitive. The coordinates
+of the vertex are stored in the parameter ``vertex''. All the generated
+vertices have dimension 3; that is, homogeneous coordinates have been
+transformed into affine coordinates. The default vertex callback
+function is NULL. The function prototype for this callback function
+looks like:
+
+@item @code{GLU_NURBS_VERTEX_DATA}
+
+
+This is the same as the @code{GLU_NURBS_VERTEX} callback, except that it
+takes an additional pointer argument. This pointer is a copy of the
+pointer that was specified at the last call to
+@code{gluNurbsCallbackData}. The default callback function is NULL. The
+function prototype for this callback function looks like:
+
+@item @code{GLU_NURBS_NORMAL}
+
+
+The normal callback is invoked as the vertex normal is generated. The
+components of the normal are stored in the parameter ``normal.'' In the
+case of a NURBS curve, the callback function is effective only when the
+user provides a normal map (@code{GLU_MAP1_NORMAL}). In the case of a
+NURBS surface, if a normal map (@code{GLU_MAP2_NORMAL}) is provided,
+then the generated normal is computed from the normal map. If a normal
+map is not provided, then a surface normal is computed in a manner
+similar to that described for evaluators when @code{GLU_AUTO_NORMAL} is
+enabled. The default normal callback function is NULL. The function
+prototype for this callback function looks like:
+
+@item @code{GLU_NURBS_NORMAL_DATA}
+
+
+The same as the @code{GLU_NURBS_NORMAL} callback except that it takes an
+additional pointer argument. This pointer is a copy of the pointer that
+was specified at the last call to @code{gluNurbsCallbackData}. The
+default callback function is NULL. The function prototype for this
+callback function looks like:
+
+@item @code{GLU_NURBS_COLOR}
+
+
+The color callback is invoked as the color of a vertex is generated. The
+components of the color are stored in the parameter ``color.'' This
+callback is effective only when the user provides a color map
+(@code{GLU_MAP1_COLOR_4} or @code{GLU_MAP2_COLOR_4}). ``color'' contains
+four components: R, G, B, A. The default color callback function is
+NULL. The prototype for this callback function looks like:
+
+@item @code{GLU_NURBS_COLOR_DATA}
+
+
+The same as the @code{GLU_NURBS_COLOR} callback except that it takes an
+additional pointer argument. This pointer is a copy of the pointer that
+was specified at the last call to @code{gluNurbsCallbackData}. The
+default callback function is NULL. The function prototype for this
+callback function looks like:
+
+@item @code{GLU_NURBS_TEXTURE_COORD}
+
+
+The texture callback is invoked as the texture coordinates of a vertex
+are generated. These coordinates are stored in the parameter
+``texCoord.'' The number of texture coordinates can be 1, 2, 3, or 4
+depending on which type of texture map is specified
+(@code{GLU_MAP1_TEXTURE_COORD_1}, @code{GLU_MAP1_TEXTURE_COORD_2},
+@code{GLU_MAP1_TEXTURE_COORD_3}, @code{GLU_MAP1_TEXTURE_COORD_4},
+@code{GLU_MAP2_TEXTURE_COORD_1}, @code{GLU_MAP2_TEXTURE_COORD_2},
+@code{GLU_MAP2_TEXTURE_COORD_3}, @code{GLU_MAP2_TEXTURE_COORD_4}). If no
+texture map is specified, this callback function will not be called. The
+default texture callback function is NULL. The function prototype for
+this callback function looks like:
+
+@item @code{GLU_NURBS_TEXTURE_COORD_DATA}
+
+
+This is the same as the @code{GLU_NURBS_TEXTURE_COORD} callback, except
+that it takes an additional pointer argument. This pointer is a copy of
+the pointer that was specified at the last call to
+@code{gluNurbsCallbackData}. The default callback function is NULL. The
+function prototype for this callback function looks like:
+
+@item @code{GLU_NURBS_END}
+
+
+The end callback is invoked at the end of a primitive. The default end
+callback function is NULL. The function prototype for this callback
+function looks like:
+
+@item @code{GLU_NURBS_END_DATA}
+
+
+This is the same as the @code{GLU_NURBS_END} callback, except that it
+takes an additional pointer argument. This pointer is a copy of the
+pointer that was specified at the last call to
+@code{gluNurbsCallbackData}. The default callback function is NULL. The
+function prototype for this callback function looks like:
+
+@item @code{GLU_NURBS_ERROR}
+
+
+The error function is called when an error is encountered. Its single
+argument is of type GLenum, and it indicates the specific error that
+occurred. There are 37 errors unique to NURBS, named
+@code{GLU_NURBS_ERROR1} through @code{GLU_NURBS_ERROR37}. Character
+strings describing these errors can be retrieved with
+@code{gluErrorString}.
+
+@end table
+
+@example
+
+void begin( GLenum type );
+@end example
+
+@example
+
+void beginData(GLenum type, void *userData);
+@end example
+
+@example
+
+void vertex( GLfloat *vertex );
+@end example
+
+@example
+
+void vertexData( GLfloat *vertex, void *userData );
+@end example
+
+@example
+
+void normal( GLfloat *normal );
+@end example
+
+@example
+
+void normalData( GLfloat *normal, void *userData );
+@end example
+
+@example
+
+void color( GLfloat *color );
+@end example
+
+@example
+
+void colorData( GLfloat *color, void *userData );
+@end example
+
+@example
+
+void texCoord( GLfloat *texCoord );
+@end example
+
+@example
+
+void texCoordData( GLfloat *texCoord, void *userData );
+@end example
+
+@example
+
+void end( void );
+@end example
+
+@example
+
+void endData( void *userData );
+@end example
+
+@end defun
+
+@defun gluNurbsCurve
+@heading define the shape of a NURBS curve
+@heading Parameters
+@table @asis
+@item @var{nurb}
+Specifies the NURBS object (created with @code{gluNewNurbsRenderer}).
+
+@item @var{knotCount}
+Specifies the number of knots in @var{knots}. @var{knotCount} equals the
+number of control points plus the order.
+
+@item @var{knots}
+Specifies an array of @var{knotCount} nondecreasing knot values.
+
+@item @var{stride}
+Specifies the offset (as a number of single-precision floating-point
+values) between successive curve control points.
+
+@item @var{control}
+Specifies a pointer to an array of control points. The coordinates must
+agree with @var{type}, specified below.
+
+@item @var{order}
+Specifies the order of the NURBS curve. @var{order} equals degree + 1,
+hence a cubic curve has an order of 4.
+
+@item @var{type}
+Specifies the type of the curve. If this curve is defined within a
+@code{gluBeginCurve}/@code{gluEndCurve} pair, then the type can be any
+of the valid one-dimensional evaluator types (such as
+@code{GLU_MAP1_VERTEX_3} or @code{GLU_MAP1_COLOR_4}). Between a
+@code{gluBeginTrim}/@code{gluEndTrim} pair, the only valid types are
+@code{GLU_MAP1_TRIM_2} and @code{GLU_MAP1_TRIM_3}.
+
+@end table
+
+@heading Description
+Use @code{gluNurbsCurve} to describe a NURBS curve.
+
+When @code{gluNurbsCurve} appears between a
+@code{gluBeginCurve}/@code{gluEndCurve} pair, it is used to describe a
+curve to be rendered. Positional, texture, and color coordinates are
+associated by presenting each as a separate @code{gluNurbsCurve} between
+a @code{gluBeginCurve}/@code{gluEndCurve} pair. No more than one call to
+@code{gluNurbsCurve} for each of color, position, and texture data can
+be made within a single @code{gluBeginCurve}/@code{gluEndCurve} pair.
+Exactly one call must be made to describe the position of the curve (a
+@var{type} of @code{GLU_MAP1_VERTEX_3} or @code{GLU_MAP1_VERTEX_4}).
+
+When @code{gluNurbsCurve} appears between a
+@code{gluBeginTrim}/@code{gluEndTrim} pair, it is used to describe a
+trimming curve on a NURBS surface. If @var{type} is
+@code{GLU_MAP1_TRIM_2}, then it describes a curve in two-dimensional
+(@var{u} and @var{v}) parameter space. If it is @code{GLU_MAP1_TRIM_3},
+then it describes a curve in two-dimensional homogeneous (@var{u},
+@var{v}, and @var{w}) parameter space. See the @code{gluBeginTrim}
+reference page for more discussion about trimming curves.
+
+@end defun
+
+@defun gluNurbsProperty
+@heading set a NURBS property
+@heading Parameters
+@table @asis
+@item @var{nurb}
+Specifies the NURBS object (created with @code{gluNewNurbsRenderer}).
+
+@item @var{property}
+Specifies the property to be set. Valid values are
+@code{GLU_SAMPLING_TOLERANCE}, @code{GLU_DISPLAY_MODE},
+@code{GLU_CULLING}, @code{GLU_AUTO_LOAD_MATRIX},
+@code{GLU_PARAMETRIC_TOLERANCE}, @code{GLU_SAMPLING_METHOD},
+@code{GLU_U_STEP}, @code{GLU_V_STEP}, or @code{GLU_NURBS_MODE}.
+
+@item @var{value}
+Specifies the value of the indicated property. It may be a numeric value
+or one of @code{GLU_OUTLINE_POLYGON}, @code{GLU_FILL},
+@code{GLU_OUTLINE_PATCH}, @code{GLU_TRUE}, @code{GLU_FALSE},
+@code{GLU_PATH_LENGTH}, @code{GLU_PARAMETRIC_ERROR},
+@code{GLU_DOMAIN_DISTANCE}, @code{GLU_NURBS_RENDERER}, or
+@code{GLU_NURBS_TESSELLATOR}.
+
+@end table
+
+@heading Description
+@code{gluNurbsProperty} is used to control properties stored in a NURBS
+object. These properties affect the way that a NURBS curve is rendered.
+The accepted values for @var{property} are as follows:
+
+@table @asis
+@item @code{GLU_NURBS_MODE}
+@var{value} should be set to be either @code{GLU_NURBS_RENDERER} or
+@code{GLU_NURBS_TESSELLATOR}. When set to @code{GLU_NURBS_RENDERER},
+NURBS objects are tessellated into OpenGL primitives and sent to the
+pipeline for rendering. When set to @code{GLU_NURBS_TESSELLATOR}, NURBS
+objects are tessellated into OpenGL primitives but the vertices,
+normals, colors, and/or textures are retrieved back through a callback
+interface (see @code{gluNurbsCallback}). This allows the user to cache
+the tessellated results for further processing. The initial value is
+@code{GLU_NURBS_RENDERER}.
+
+@item @code{GLU_SAMPLING_METHOD}
+Specifies how a NURBS surface should be tessellated. @var{value} may be
+one of @code{GLU_PATH_LENGTH}, @code{GLU_PARAMETRIC_ERROR},
+@code{GLU_DOMAIN_DISTANCE}, @code{GLU_OBJECT_PATH_LENGTH}, or
+@code{GLU_OBJECT_PARAMETRIC_ERROR}. When set to @code{GLU_PATH_LENGTH},
+the surface is rendered so that the maximum length, in pixels, of the
+edges of the tessellation polygons is no greater than what is specified
+by @code{GLU_SAMPLING_TOLERANCE}.
+
+@code{GLU_PARAMETRIC_ERROR} specifies that the surface is rendered in
+such a way that the value specified by @code{GLU_PARAMETRIC_TOLERANCE}
+describes the maximum distance, in pixels, between the tessellation
+polygons and the surfaces they approximate.
+
+@code{GLU_DOMAIN_DISTANCE} allows users to specify, in parametric
+coordinates, how many sample points per unit length are taken in
+@var{u}, @var{v} direction.
+
+@code{GLU_OBJECT_PATH_LENGTH} is similar to @code{GLU_PATH_LENGTH}
+except that it is view independent; that is, the surface is rendered so
+that the maximum length, in object space, of edges of the tessellation
+polygons is no greater than what is specified by
+@code{GLU_SAMPLING_TOLERANCE}.
+
+@code{GLU_OBJECT_PARAMETRIC_ERROR} is similar to
+@code{GLU_PARAMETRIC_ERROR} except that it is view independent; that is,
+the surface is rendered in such a way that the value specified by
+@code{GLU_PARAMETRIC_TOLERANCE} describes the maximum distance, in
+object space, between the tessellation polygons and the surfaces they
+approximate.
+
+The initial value of @code{GLU_SAMPLING_METHOD} is
+@code{GLU_PATH_LENGTH}.
+
+@item @code{GLU_SAMPLING_TOLERANCE}
+Specifies the maximum length, in pixels or in object space length unit,
+to use when the sampling method is set to @code{GLU_PATH_LENGTH} or
+@code{GLU_OBJECT_PATH_LENGTH}. The NURBS code is conservative when
+rendering a curve or surface, so the actual length can be somewhat
+shorter. The initial value is 50.0 pixels.
+
+@item @code{GLU_PARAMETRIC_TOLERANCE}
+Specifies the maximum distance, in pixels or in object space length
+unit, to use when the sampling method is @code{GLU_PARAMETRIC_ERROR} or
+@code{GLU_OBJECT_PARAMETRIC_ERROR}. The initial value is 0.5.
+
+@item @code{GLU_U_STEP}
+Specifies the number of sample points per unit length taken along the
+@var{u} axis in parametric coordinates. It is needed when
+@code{GLU_SAMPLING_METHOD} is set to @code{GLU_DOMAIN_DISTANCE}. The
+initial value is 100.
+
+@item @code{GLU_V_STEP}
+Specifies the number of sample points per unit length taken along the
+@var{v} axis in parametric coordinate. It is needed when
+@code{GLU_SAMPLING_METHOD} is set to @code{GLU_DOMAIN_DISTANCE}. The
+initial value is 100.
+
+@item @code{GLU_DISPLAY_MODE}
+@var{value} can be set to @code{GLU_OUTLINE_POLYGON}, @code{GLU_FILL},
+or @code{GLU_OUTLINE_PATCH}. When @code{GLU_NURBS_MODE} is set to be
+@code{GLU_NURBS_RENDERER}, @var{value} defines how a NURBS surface
+should be rendered. When @var{value} is set to @code{GLU_FILL}, the
+surface is rendered as a set of polygons. When @var{value} is set to
+@code{GLU_OUTLINE_POLYGON}, the NURBS library draws only the outlines of
+the polygons created by tessellation. When @var{value} is set to
+@code{GLU_OUTLINE_PATCH} just the outlines of patches and trim curves
+defined by the user are drawn.
+
+When @code{GLU_NURBS_MODE} is set to be @code{GLU_NURBS_TESSELLATOR},
+@var{value} defines how a NURBS surface should be tessellated. When
+@code{GLU_DISPLAY_MODE} is set to @code{GLU_FILL} or
+@code{GLU_OUTLINE_POLYGON}, the NURBS surface is tessellated into OpenGL
+triangle primitives that can be retrieved back through callback
+functions. If @code{GLU_DISPLAY_MODE} is set to
+@code{GLU_OUTLINE_PATCH}, only the outlines of the patches and trim
+curves are generated as a sequence of line strips that can be retrieved
+back through callback functions.
+
+The initial value is @code{GLU_FILL}.
+
+@item @code{GLU_CULLING}
+@var{value} is a boolean value that, when set to @code{GLU_TRUE},
+indicates that a NURBS curve should be discarded prior to tessellation
+if its control points lie outside the current viewport. The initial
+value is @code{GLU_FALSE}.
+
+@item @code{GLU_AUTO_LOAD_MATRIX}
+@var{value} is a boolean value. When set to @code{GLU_TRUE}, the NURBS
+code downloads the projection matrix, the modelview matrix, and the
+viewport from the GL server to compute sampling and culling matrices for
+each NURBS curve that is rendered. Sampling and culling matrices are
+required to determine the tessellation of a NURBS surface into line
+segments or polygons and to cull a NURBS surface if it lies outside the
+viewport.
+
+If this mode is set to @code{GLU_FALSE}, then the program needs to
+provide a projection matrix, a modelview matrix, and a viewport for the
+NURBS renderer to use to construct sampling and culling matrices. This
+can be done with the @code{gluLoadSamplingMatrices} function. This mode
+is initially set to @code{GLU_TRUE}. Changing it from @code{GLU_TRUE} to
+@code{GLU_FALSE} does not affect the sampling and culling matrices until
+@code{gluLoadSamplingMatrices} is called.
+
+@end table
+
+@end defun
+
+@defun gluNurbsSurface
+@heading define the shape of a NURBS surface
+@heading Parameters
+@table @asis
+@item @var{nurb}
+Specifies the NURBS object (created with @code{gluNewNurbsRenderer}).
+
+@item @var{sKnotCount}
+Specifies the number of knots in the parametric @var{u} direction.
+
+@item @var{sKnots}
+Specifies an array of @var{sKnotCount} nondecreasing knot values in the
+parametric @var{u} direction.
+
+@item @var{tKnotCount}
+Specifies the number of knots in the parametric @var{v} direction.
+
+@item @var{tKnots}
+Specifies an array of @var{tKnotCount} nondecreasing knot values in the
+parametric @var{v} direction.
+
+@item @var{sStride}
+Specifies the offset (as a number of single-precision floating-point
+values) between successive control points in the parametric @var{u}
+direction in @var{control}.
+
+@item @var{tStride}
+Specifies the offset (in single-precision floating-point values) between
+successive control points in the parametric @var{v} direction in
+@var{control}.
+
+@item @var{control}
+Specifies an array containing control points for the NURBS surface. The
+offsets between successive control points in the parametric @var{u} and
+@var{v} directions are given by @var{sStride} and @var{tStride}.
+
+@item @var{sOrder}
+Specifies the order of the NURBS surface in the parametric @var{u}
+direction. The order is one more than the degree, hence a surface that
+is cubic in @var{u} has a @var{u} order of 4.
+
+@item @var{tOrder}
+Specifies the order of the NURBS surface in the parametric @var{v}
+direction. The order is one more than the degree, hence a surface that
+is cubic in @var{v} has a @var{v} order of 4.
+
+@item @var{type}
+Specifies type of the surface. @var{type} can be any of the valid
+two-dimensional evaluator types (such as @code{GLU_MAP2_VERTEX_3} or
+@code{GLU_MAP2_COLOR_4}).
+
+@end table
+
+@heading Description
+Use @code{gluNurbsSurface} within a NURBS (Non-Uniform Rational
+B-Spline) surface definition to describe the shape of a NURBS surface
+(before any trimming). To mark the beginning of a NURBS surface
+definition, use the @code{gluBeginSurface} command. To mark the end of a
+NURBS surface definition, use the @code{gluEndSurface} command. Call
+@code{gluNurbsSurface} within a NURBS surface definition only.
+
+Positional, texture, and color coordinates are associated with a surface
+by presenting each as a separate @code{gluNurbsSurface} between a
+@code{gluBeginSurface}/@code{gluEndSurface} pair. No more than one call
+to @code{gluNurbsSurface} for each of color, position, and texture data
+can be made within a single @code{gluBeginSurface}/@code{gluEndSurface}
+pair. Exactly one call must be made to describe the position of the
+surface (a @var{type} of @code{GLU_MAP2_VERTEX_3} or
+@code{GLU_MAP2_VERTEX_4}).
+
+A NURBS surface can be trimmed by using the commands
+@code{gluNurbsCurve} and @code{gluPwlCurve} between calls to
+@code{gluBeginTrim} and @code{gluEndTrim}.
+
+Note that a @code{gluNurbsSurface} with @var{sKnotCount} knots in the
+@var{u} direction and @var{tKnotCount} knots in the @var{v} direction
+with orders @var{sOrder} and @var{tOrder} must have (@var{sKnotCount} -
+@var{sOrder}) @math{@var{times}} (@var{tKnotCount} - @var{tOrder})
+control points.
+
+@end defun
+
+@defun gluOrtho2D
+@heading define a 2D orthographic projection matrix
+@heading Parameters
+@table @asis
+@item @var{left}
+@itemx @var{right}
+Specify the coordinates for the left and right vertical clipping planes.
+
+@item @var{bottom}
+@itemx @var{top}
+Specify the coordinates for the bottom and top horizontal clipping
+planes.
+
+@end table
+
+@heading Description
+@code{gluOrtho2D} sets up a two-dimensional orthographic viewing region.
+This is equivalent to calling @code{glOrtho} with @math{@var{near}=-1}
+and @math{@var{far}=1}.
+
+@end defun
+
+@defun gluPartialDisk
+@heading draw an arc of a disk
+@heading Parameters
+@table @asis
+@item @var{quad}
+Specifies a quadrics object (created with @code{gluNewQuadric}).
+
+@item @var{inner}
+Specifies the inner radius of the partial disk (can be 0).
+
+@item @var{outer}
+Specifies the outer radius of the partial disk.
+
+@item @var{slices}
+Specifies the number of subdivisions around the @var{z} axis.
+
+@item @var{loops}
+Specifies the number of concentric rings about the origin into which the
+partial disk is subdivided.
+
+@item @var{start}
+Specifies the starting angle, in degrees, of the disk portion.
+
+@item @var{sweep}
+Specifies the sweep angle, in degrees, of the disk portion.
+
+@end table
+
+@heading Description
+@code{gluPartialDisk} renders a partial disk on the @math{@var{z}=0}
+plane. A partial disk is similar to a full disk, except that only the
+subset of the disk from @var{start} through @var{start} + @var{sweep} is
+included (where 0 degrees is along the +\f2y\f axis, 90 degrees along
+the +@var{x} axis, 180 degrees along the \-@var{y} axis, and 270 degrees
+along the \-@var{x} axis).
+
+The partial disk has a radius of @var{outer} and contains a concentric
+circular hole with a radius of @var{inner}. If @var{inner} is 0, then no
+hole is generated. The partial disk is subdivided around the @var{z}
+axis into slices (like pizza slices) and also about the @var{z} axis
+into rings (as specified by @var{slices} and @var{loops}, respectively).
+
+With respect to orientation, the +@var{z} side of the partial disk is
+considered to be outside (see @code{gluQuadricOrientation}). This means
+that if the orientation is set to @code{GLU_OUTSIDE}, then any normals
+generated point along the +@var{z} axis. Otherwise, they point along the
+\-@var{z} axis.
+
+If texturing is turned on (with @code{gluQuadricTexture}), texture
+coordinates are generated linearly such that where
+@math{@var{r}=@var{outer}}, the value at (@var{r}, 0, 0) is (1.0, 0.5),
+at (0, @var{r}, 0) it is (0.5, 1.0), at (\-@var{r}, 0, 0) it is (0.0,
+0.5), and at (0, \-@var{r}, 0) it is (0.5, 0.0).
+
+@end defun
+
+@defun gluPerspective
+@heading set up a perspective projection matrix
+@heading Parameters
+@table @asis
+@item @var{fovy}
+Specifies the field of view angle, in degrees, in the @var{y} direction.
+
+@item @var{aspect}
+Specifies the aspect ratio that determines the field of view in the
+@var{x} direction. The aspect ratio is the ratio of @var{x} (width) to
+@var{y} (height).
+
+@item @var{zNear}
+Specifies the distance from the viewer to the near clipping plane
+(always positive).
+
+@item @var{zFar}
+Specifies the distance from the viewer to the far clipping plane (always
+positive).
+
+@end table
+
+@heading Description
+@code{gluPerspective} specifies a viewing frustum into the world
+coordinate system. In general, the aspect ratio in @code{gluPerspective}
+should match the aspect ratio of the associated viewport. For example,
+@math{@var{aspect}=2.0} means the viewer's angle of view is twice as
+wide in @var{x} as it is in @var{y}. If the viewport is twice as wide as
+it is tall, it displays the image without distortion.
+
+The matrix generated by @code{gluPerspective} is multipled by the
+current matrix, just as if @code{glMultMatrix} were called with the
+generated matrix. To load the perspective matrix onto the current matrix
+stack instead, precede the call to @code{gluPerspective} with a call to
+@code{glLoadIdentity}.
+
+Given @var{f} defined as follows:
+
+@math{@var{f}=@var{cotangent}(@var{fovy}/2,)} The generated matrix is
+
+@math{((@var{f}/@var{aspect} 0 0 0), (0 @var{f} 0 0), (0 0
+@var{zFar}+@var{zNear},/@var{zNear}-@var{zFar},
+2×@var{zFar}×@var{zNear},/@var{zNear}-@var{zFar},), (0 0 -1 0),)}
+
+@end defun
+
+@defun gluPickMatrix
+@heading define a picking region
+@heading Parameters
+@table @asis
+@item @var{x}
+@itemx @var{y}
+Specify the center of a picking region in window coordinates.
+
+@item @var{delX}
+@itemx @var{delY}
+Specify the width and height, respectively, of the picking region in
+window coordinates.
+
+@item @var{viewport}
+Specifies the current viewport (as from a @code{glGetIntegerv} call).
+
+@end table
+
+@heading Description
+@code{gluPickMatrix} creates a projection matrix that can be used to
+restrict drawing to a small region of the viewport. This is typically
+useful to determine what objects are being drawn near the cursor. Use
+@code{gluPickMatrix} to restrict drawing to a small region around the
+cursor. Then, enter selection mode (with @code{glRenderMode}) and
+rerender the scene. All primitives that would have been drawn near the
+cursor are identified and stored in the selection buffer.
+
+The matrix created by @code{gluPickMatrix} is multiplied by the current
+matrix just as if @code{glMultMatrix} is called with the generated
+matrix. To effectively use the generated pick matrix for picking, first
+call @code{glLoadIdentity} to load an identity matrix onto the
+perspective matrix stack. Then call @code{gluPickMatrix}, and, finally,
+call a command (such as @code{gluPerspective}) to multiply the
+perspective matrix by the pick matrix.
+
+When using @code{gluPickMatrix} to pick NURBS, be careful to turn off
+the NURBS property @code{GLU_AUTO_LOAD_MATRIX}. If
+@code{GLU_AUTO_LOAD_MATRIX} is not turned off, then any NURBS surface
+rendered is subdivided differently with the pick matrix than the way it
+was subdivided without the pick matrix.
+
+@end defun
+
+@defun gluProject
+@heading map object coordinates to window coordinates
+@heading Parameters
+@table @asis
+@item @var{objX}
+@itemx @var{objY}
+@itemx @var{objZ}
+Specify the object coordinates.
+
+@item @var{model}
+Specifies the current modelview matrix (as from a @code{glGetDoublev}
+call).
+
+@item @var{proj}
+Specifies the current projection matrix (as from a @code{glGetDoublev}
+call).
+
+@item @var{view}
+Specifies the current viewport (as from a @code{glGetIntegerv} call).
+
+@item @var{winX}
+@itemx @var{winY}
+@itemx @var{winZ}
+Return the computed window coordinates.
+
+@end table
+
+@heading Description
+@code{gluProject} transforms the specified object coordinates into
+window coordinates using @var{model}, @var{proj}, and @var{view}. The
+result is stored in @var{winX}, @var{winY}, and @var{winZ}. A return
+value of @code{GLU_TRUE} indicates success, a return value of
+@code{GLU_FALSE} indicates failure.
+
+To compute the coordinates, let
+@math{@var{v}=(@var{objX},@var{objY}@var{objZ}1.0)} represented as a
+matrix with 4 rows and 1 column. Then @code{gluProject} computes
+@math{@var{v}^″} as follows:
+
+@math{@var{v}^″=@var{P}×@var{M}×@var{v}}
+
+where @math{@var{P}} is the current projection matrix @var{proj} and
+@math{@var{M}} is the current modelview matrix @var{model} (both
+represented as @math{4×4} matrices in column-major order).
+
+The window coordinates are then computed as follows:
+
+@math{@var{winX}=@var{view}(0,)+@var{view}(2,)×(@var{v}^″(0,)+1,)/2}@math{@var{winY}=@var{view}(1,)+@var{view}(3,)×(@var{v}^″(1,)+1,)/2}
+@math{@var{winZ}=(@var{v}^″(2,)+1,)/2}
+
+
+
+@end defun
+
+@defun gluPwlCurve
+@heading describe a piecewise linear NURBS trimming curve
+@heading Parameters
+@table @asis
+@item @var{nurb}
+Specifies the NURBS object (created with @code{gluNewNurbsRenderer}).
+
+@item @var{count}
+Specifies the number of points on the curve.
+
+@item @var{data}
+Specifies an array containing the curve points.
+
+@item @var{stride}
+Specifies the offset (a number of single-precision floating-point
+values) between points on the curve.
+
+@item @var{type}
+Specifies the type of curve. Must be either @code{GLU_MAP1_TRIM_2} or
+@code{GLU_MAP1_TRIM_3}.
+
+@end table
+
+@heading Description
+@code{gluPwlCurve} describes a piecewise linear trimming curve for a
+NURBS surface. A piecewise linear curve consists of a list of
+coordinates of points in the parameter space for the NURBS surface to be
+trimmed. These points are connected with line segments to form a curve.
+If the curve is an approximation to a curve that is not piecewise
+linear, the points should be close enough in parameter space that the
+resulting path appears curved at the resolution used in the application.
+
+If @var{type} is @code{GLU_MAP1_TRIM_2}, then it describes a curve in
+two-dimensional (@var{u} and @var{v}) parameter space. If it is
+@code{GLU_MAP1_TRIM_3}, then it describes a curve in two-dimensional
+homogeneous (@var{u}, @var{v}, and @var{w}) parameter space. See the
+@code{gluBeginTrim} reference page for more information about trimming
+curves.
+
+@end defun
+
+@defun gluQuadricCallback
+@heading define a callback for a quadrics object
+@heading Parameters
+@table @asis
+@item @var{quad}
+Specifies the quadrics object (created with @code{gluNewQuadric}).
+
+@item @var{which}
+Specifies the callback being defined. The only valid value is
+@code{GLU_ERROR}.
+
+@item @var{CallBackFunc}
+Specifies the function to be called.
+
+@end table
+
+@heading Description
+@code{gluQuadricCallback} is used to define a new callback to be used by
+a quadrics object. If the specified callback is already defined, then it
+is replaced. If @var{CallBackFunc} is NULL, then any existing callback
+is erased.
+
+The one legal callback is @code{GLU_ERROR}:
+
+@table @asis
+@item @code{GLU_ERROR}
+The function is called when an error is encountered. Its single argument
+is of type GLenum, and it indicates the specific error that occurred.
+Character strings describing these errors can be retrieved with the
+@code{gluErrorString} call.
+
+@end table
+
+@end defun
+
+@defun gluQuadricDrawStyle
+@heading specify the draw style desired for quadrics
+@heading Parameters
+@table @asis
+@item @var{quad}
+Specifies the quadrics object (created with @code{gluNewQuadric}).
+
+@item @var{draw}
+Specifies the desired draw style. Valid values are @code{GLU_FILL},
+@code{GLU_LINE}, @code{GLU_SILHOUETTE}, and @code{GLU_POINT}.
+
+@end table
+
+@heading Description
+@code{gluQuadricDrawStyle} specifies the draw style for quadrics
+rendered with @var{quad}. The legal values are as follows:
+
+@table @asis
+@item @code{GLU_FILL}
+Quadrics are rendered with polygon primitives. The polygons are drawn in
+a counterclockwise fashion with respect to their normals (as defined
+with @code{gluQuadricOrientation}).
+
+@item @code{GLU_LINE}
+Quadrics are rendered as a set of lines.
+
+@item @code{GLU_SILHOUETTE}
+Quadrics are rendered as a set of lines, except that edges separating
+coplanar faces will not be drawn.
+
+@item @code{GLU_POINT}
+Quadrics are rendered as a set of points.
+
+@end table
+
+@end defun
+
+@defun gluQuadricNormals
+@heading specify what kind of normals are desired for quadrics
+@heading Parameters
+@table @asis
+@item @var{quad}
+Specifies the quadrics object (created with @code{gluNewQuadric}).
+
+@item @var{normal}
+Specifies the desired type of normals. Valid values are @code{GLU_NONE},
+@code{GLU_FLAT}, and @code{GLU_SMOOTH}.
+
+@end table
+
+@heading Description
+@code{gluQuadricNormals} specifies what kind of normals are desired for
+quadrics rendered with @var{quad}. The legal values are as follows:
+
+@table @asis
+@item @code{GLU_NONE}
+No normals are generated.
+
+@item @code{GLU_FLAT}
+One normal is generated for every facet of a quadric.
+
+@item @code{GLU_SMOOTH}
+One normal is generated for every vertex of a quadric. This is the
+initial value.
+
+@end table
+
+@end defun
+
+@defun gluQuadricOrientation
+@heading specify inside/outside orientation for quadrics
+@heading Parameters
+@table @asis
+@item @var{quad}
+Specifies the quadrics object (created with @code{gluNewQuadric}).
+
+@item @var{orientation}
+Specifies the desired orientation. Valid values are @code{GLU_OUTSIDE}
+and @code{GLU_INSIDE}.
+
+@end table
+
+@heading Description
+@code{gluQuadricOrientation} specifies what kind of orientation is
+desired for quadrics rendered with @var{quad}. The @var{orientation}
+values are as follows:
+
+@table @asis
+@item @code{GLU_OUTSIDE}
+Quadrics are drawn with normals pointing outward (the initial value).
+
+@item @code{GLU_INSIDE}
+Quadrics are drawn with normals pointing inward.
+
+@end table
+
+Note that the interpretation of @var{outward} and @var{inward} depends
+on the quadric being drawn.
+
+@end defun
+
+@defun gluQuadricTexture
+@heading specify if texturing is desired for quadrics
+@heading Parameters
+@table @asis
+@item @var{quad}
+Specifies the quadrics object (created with @code{gluNewQuadric}).
+
+@item @var{texture}
+Specifies a flag indicating if texture coordinates should be generated.
+
+@end table
+
+@heading Description
+@code{gluQuadricTexture} specifies if texture coordinates should be
+generated for quadrics rendered with @var{quad}. If the value of
+@var{texture} is @code{GLU_TRUE}, then texture coordinates are
+generated, and if @var{texture} is @code{GLU_FALSE}, they are not. The
+initial value is @code{GLU_FALSE}.
+
+The manner in which texture coordinates are generated depends upon the
+specific quadric rendered.
+
+@end defun
+
+@defun gluScaleImage
+@heading scale an image to an arbitrary size
+@heading Parameters
+@table @asis
+@item @var{format}
+Specifies the format of the pixel data. The following symbolic values
+are valid: @code{GLU_COLOR_INDEX}, @code{GLU_STENCIL_INDEX},
+@code{GLU_DEPTH_COMPONENT}, @code{GLU_RED}, @code{GLU_GREEN},
+@code{GLU_BLUE}, @code{GLU_ALPHA}, @code{GLU_RGB}, @code{GLU_RGBA},
+@code{GLU_BGR}, @code{GLU_BGRA}, @code{GLU_LUMINANCE}, and
+@code{GLU_LUMINANCE_ALPHA}.
+
+@item @var{wIn}
+@itemx @var{hIn}
+Specify in pixels the width and height, respectively, of the source
+image.
+
+@item @var{typeIn}
+Specifies the data type for @var{dataIn}. Must be one of
+@code{GLU_UNSIGNED_BYTE}, @code{GLU_BYTE}, @code{GLU_BITMAP},
+@code{GLU_UNSIGNED_SHORT}, @code{GLU_SHORT}, @code{GLU_UNSIGNED_INT},
+@code{GLU_INT}, @code{GLU_FLOAT}, @code{GLU_UNSIGNED_BYTE_3_3_2},
+@code{GLU_UNSIGNED_BYTE_2_3_3_REV}, @code{GLU_UNSIGNED_SHORT_5_6_5},
+@code{GLU_UNSIGNED_SHORT_5_6_5_REV}, @code{GLU_UNSIGNED_SHORT_4_4_4_4},
+@code{GLU_UNSIGNED_SHORT_4_4_4_4_REV},
+@code{GLU_UNSIGNED_SHORT_5_5_5_1},
+@code{GLU_UNSIGNED_SHORT_1_5_5_5_REV}, @code{GLU_UNSIGNED_INT_8_8_8_8},
+@code{GLU_UNSIGNED_INT_8_8_8_8_REV}, @code{GLU_UNSIGNED_INT_10_10_10_2},
+or @code{GLU_UNSIGNED_INT_2_10_10_10_REV}.
+
+@item @var{dataIn}
+Specifies a pointer to the source image.
+
+@item @var{wOut}
+@itemx @var{hOut}
+Specify the width and height, respectively, in pixels of the destination
+image.
+
+@item @var{typeOut}
+Specifies the data type for @var{dataOut}. Must be one of
+@code{GLU_UNSIGNED_BYTE}, @code{GLU_BYTE}, @code{GLU_BITMAP},
+@code{GLU_UNSIGNED_SHORT}, @code{GLU_SHORT}, @code{GLU_UNSIGNED_INT},
+@code{GLU_INT}, @code{GLU_FLOAT}, @code{GLU_UNSIGNED_BYTE_3_3_2},
+@code{GLU_UNSIGNED_BYTE_2_3_3_REV}, @code{GLU_UNSIGNED_SHORT_5_6_5},
+@code{GLU_UNSIGNED_SHORT_5_6_5_REV}, @code{GLU_UNSIGNED_SHORT_4_4_4_4},
+@code{GLU_UNSIGNED_SHORT_4_4_4_4_REV},
+@code{GLU_UNSIGNED_SHORT_5_5_5_1},
+@code{GLU_UNSIGNED_SHORT_1_5_5_5_REV}, @code{GLU_UNSIGNED_INT_8_8_8_8},
+@code{GLU_UNSIGNED_INT_8_8_8_8_REV}, @code{GLU_UNSIGNED_INT_10_10_10_2},
+or @code{GLU_UNSIGNED_INT_2_10_10_10_REV}.
+
+@item @var{dataOut}
+Specifies a pointer to the destination image.
+
+@end table
+
+@heading Description
+@code{gluScaleImage} scales a pixel image using the appropriate pixel
+store modes to unpack data from the source image and pack data into the
+destination image.
+
+When shrinking an image, @code{gluScaleImage} uses a box filter to
+sample the source image and create pixels for the destination image.
+When magnifying an image, the pixels from the source image are linearly
+interpolated to create the destination image.
+
+A return value of zero indicates success, otherwise a GLU error code is
+returned (see @code{gluErrorString}).
+
+See the @code{glReadPixels} reference page for a description of the
+acceptable values for the @var{format}, @var{typeIn}, and @var{typeOut}
+parameters.
+
+@heading Errors
+@code{GLU_INVALID_VALUE} is returned if @var{wIn}, @var{hIn},
+@var{wOut}, or @var{hOut} is negative.
+
+@code{GLU_INVALID_ENUM} is returned if @var{format}, @var{typeIn}, or
+@var{typeOut} is not legal.
+
+@code{GLU_INVALID_OPERATION} is returned if @var{typeIn} or
+@var{typeOut} is @code{GLU_UNSIGNED_BYTE_3_3_2} or
+@code{GLU_UNSIGNED_BYTE_2_3_3_REV} and @var{format} is not
+@code{GLU_RGB}.
+
+@code{GLU_INVALID_OPERATION} is returned if @var{typeIn} or
+@var{typeOut} is @code{GLU_UNSIGNED_SHORT_5_6_5} or
+@code{GLU_UNSIGNED_SHORT_5_6_5_REV} and @var{format} is not
+@code{GLU_RGB}.
+
+@code{GLU_INVALID_OPERATION} is returned if @var{typeIn} or
+@var{typeOut} is @code{GLU_UNSIGNED_SHORT_4_4_4_4} or
+@code{GLU_UNSIGNED_SHORT_4_4_4_4_REV} and @var{format} is neither
+@code{GLU_RGBA} nor @code{GLU_BGRA}.
+
+@code{GLU_INVALID_OPERATION} is returned if @var{typeIn} or
+@var{typeOut} is @code{GLU_UNSIGNED_SHORT_5_5_5_1} or
+@code{GLU_UNSIGNED_SHORT_1_5_5_5_REV} and @var{format} is neither
+@code{GLU_RGBA} nor @code{GLU_BGRA}.
+
+@code{GLU_INVALID_OPERATION} is returned if @var{typeIn} or
+@var{typeOut} is @code{GLU_UNSIGNED_INT_8_8_8_8} or
+@code{GLU_UNSIGNED_INT_8_8_8_8_REV} and @var{format} is neither
+@code{GLU_RGBA} nor @code{GLU_BGRA}.
+
+@code{GLU_INVALID_OPERATION} is returned if @var{typeIn} or
+@var{typeOut} is @code{GLU_UNSIGNED_INT_10_10_10_2} or
+@code{GLU_UNSIGNED_INT_2_10_10_10_REV} and @var{format} is neither
+@code{GLU_RGBA} nor @code{GLU_BGRA}.
+
+@end defun
+
+@defun gluSphere
+@heading draw a sphere
+@heading Parameters
+@table @asis
+@item @var{quad}
+Specifies the quadrics object (created with @code{gluNewQuadric}).
+
+@item @var{radius}
+Specifies the radius of the sphere.
+
+@item @var{slices}
+Specifies the number of subdivisions around the @var{z} axis (similar to
+lines of longitude).
+
+@item @var{stacks}
+Specifies the number of subdivisions along the @var{z} axis (similar to
+lines of latitude).
+
+@end table
+
+@heading Description
+@code{gluSphere} draws a sphere of the given radius centered around the
+origin. The sphere is subdivided around the @var{z} axis into slices and
+along the @var{z} axis into stacks (similar to lines of longitude and
+latitude).
+
+If the orientation is set to @code{GLU_OUTSIDE} (with
+@code{gluQuadricOrientation}), then any normals generated point away
+from the center of the sphere. Otherwise, they point toward the center
+of the sphere.
+
+If texturing is turned on (with @code{gluQuadricTexture}), then texture
+coordinates are generated so that @var{t} ranges from 0.0 at
+@math{@var{z}=-@var{radius}} to 1.0 at @math{@var{z}=@var{radius}}
+(@var{t} increases linearly along longitudinal lines), and @var{s}
+ranges from 0.0 at the +@var{y} axis, to 0.25 at the +@var{x} axis, to
+0.5 at the \-@var{y} axis, to 0.75 at the \-@var{x} axis, and back to
+1.0 at the +@var{y} axis.
+
+@end defun
+
+@defun gluTessBeginContour
+@heading delimit a contour description
+@heading Parameters
+@table @asis
+@item @var{tess}
+Specifies the tessellation object (created with @code{gluNewTess}).
+
+@end table
+
+@heading Description
+@code{gluTessBeginContour} and @code{gluTessEndContour} delimit the
+definition of a polygon contour. Within each
+@code{gluTessBeginContour}/@code{gluTessEndContour} pair, there can be
+zero or more calls to @code{gluTessVertex}. The vertices specify a
+closed contour (the last vertex of each contour is automatically linked
+to the first). See the @code{gluTessVertex} reference page for more
+details. @code{gluTessBeginContour} can only be called between
+@code{gluTessBeginPolygon} and @code{gluTessEndPolygon}.
+
+@end defun
+
+@defun gluTessBeginPolygon
+@heading delimit a polygon description
+@heading Parameters
+@table @asis
+@item @var{tess}
+Specifies the tessellation object (created with @code{gluNewTess}).
+
+@item @var{data}
+Specifies a pointer to user polygon data.
+
+@end table
+
+@heading Description
+@code{gluTessBeginPolygon} and @code{gluTessEndPolygon} delimit the
+definition of a convex, concave or self-intersecting polygon. Within
+each @code{gluTessBeginPolygon}/@code{gluTessEndPolygon} pair, there
+must be one or more calls to
+@code{gluTessBeginContour}/@code{gluTessEndContour}. Within each
+contour, there are zero or more calls to @code{gluTessVertex}. The
+vertices specify a closed contour (the last vertex of each contour is
+automatically linked to the first). See the @code{gluTessVertex},
+@code{gluTessBeginContour}, and @code{gluTessEndContour} reference pages
+for more details.
+
+@var{data} is a pointer to a user-defined data structure. If the
+appropriate callback(s) are specified (see @code{gluTessCallback}), then
+this pointer is returned to the callback function(s). Thus, it is a
+convenient way to store per-polygon information.
+
+Once @code{gluTessEndPolygon} is called, the polygon is tessellated, and
+the resulting triangles are described through callbacks. See
+@code{gluTessCallback} for descriptions of the callback functions.
+
+@end defun
+
+@defun gluTessCallback
+@heading define a callback for a tessellation object
+@heading Parameters
+@table @asis
+@item @var{tess}
+Specifies the tessellation object (created with @code{gluNewTess}).
+
+@item @var{which}
+Specifies the callback being defined. The following values are valid:
+@code{GLU_TESS_BEGIN}, @code{GLU_TESS_BEGIN_DATA},
+@code{GLU_TESS_EDGE_FLAG}, @code{GLU_TESS_EDGE_FLAG_DATA},
+@code{GLU_TESS_VERTEX}, @code{GLU_TESS_VERTEX_DATA},
+@code{GLU_TESS_END}, @code{GLU_TESS_END_DATA}, @code{GLU_TESS_COMBINE},
+@code{GLU_TESS_COMBINE_DATA}, @code{GLU_TESS_ERROR}, and
+@code{GLU_TESS_ERROR_DATA}.
+
+@item @var{CallBackFunc}
+Specifies the function to be called.
+
+@end table
+
+@heading Description
+@code{gluTessCallback} is used to indicate a callback to be used by a
+tessellation object. If the specified callback is already defined, then
+it is replaced. If @var{CallBackFunc} is NULL, then the existing
+callback becomes undefined.
+
+These callbacks are used by the tessellation object to describe how a
+polygon specified by the user is broken into triangles. Note that there
+are two versions of each callback: one with user-specified polygon data
+and one without. If both versions of a particular callback are
+specified, then the callback with user-specified polygon data will be
+used. Note that the @var{polygon_data} parameter used by some of the
+functions is a copy of the pointer that was specified when
+@code{gluTessBeginPolygon} was called. The legal callbacks are as
+follows:
+
+@table @asis
+@item @code{GLU_TESS_BEGIN}
+The begin callback is invoked like @code{glBegin} to indicate the start
+of a (triangle) primitive. The function takes a single argument of type
+GLenum. If the @code{GLU_TESS_BOUNDARY_ONLY} property is set to
+@code{GLU_FALSE}, then the argument is set to either
+@code{GLU_TRIANGLE_FAN}, @code{GLU_TRIANGLE_STRIP}, or
+@code{GLU_TRIANGLES}. If the @code{GLU_TESS_BOUNDARY_ONLY} property is
+set to @code{GLU_TRUE}, then the argument will be set to
+@code{GLU_LINE_LOOP}. The function prototype for this callback is:
+
+@item @code{GLU_TESS_BEGIN_DATA}
+The same as the @code{GLU_TESS_BEGIN} callback except that it takes an
+additional pointer argument. This pointer is identical to the opaque
+pointer provided when @code{gluTessBeginPolygon} was called. The
+function prototype for this callback is:
+
+@item @code{GLU_TESS_EDGE_FLAG}
+The edge flag callback is similar to @code{glEdgeFlag}. The function
+takes a single boolean flag that indicates which edges lie on the
+polygon boundary. If the flag is @code{GLU_TRUE}, then each vertex that
+follows begins an edge that lies on the polygon boundary, that is, an
+edge that separates an interior region from an exterior one. If the flag
+is @code{GLU_FALSE}, then each vertex that follows begins an edge that
+lies in the polygon interior. The edge flag callback (if defined) is
+invoked before the first vertex callback.
+
+Since triangle fans and triangle strips do not support edge flags, the
+begin callback is not called with @code{GLU_TRIANGLE_FAN} or
+@code{GLU_TRIANGLE_STRIP} if a non-NULL edge flag callback is provided.
+(If the callback is initialized to NULL, there is no impact on
+performance). Instead, the fans and strips are converted to independent
+triangles. The function prototype for this callback is:
+
+@item @code{GLU_TESS_EDGE_FLAG_DATA}
+The same as the @code{GLU_TESS_EDGE_FLAG} callback except that it takes
+an additional pointer argument. This pointer is identical to the opaque
+pointer provided when @code{gluTessBeginPolygon} was called. The
+function prototype for this callback is:
+
+@item @code{GLU_TESS_VERTEX}
+The vertex callback is invoked between the begin and end callbacks. It
+is similar to @code{glVertex}, and it defines the vertices of the
+triangles created by the tessellation process. The function takes a
+pointer as its only argument. This pointer is identical to the opaque
+pointer provided by the user when the vertex was described (see
+@code{gluTessVertex}). The function prototype for this callback is:
+
+@item @code{GLU_TESS_VERTEX_DATA}
+The same as the @code{GLU_TESS_VERTEX} callback except that it takes an
+additional pointer argument. This pointer is identical to the opaque
+pointer provided when @code{gluTessBeginPolygon} was called. The
+function prototype for this callback is:
+
+@item @code{GLU_TESS_END}
+The end callback serves the same purpose as @code{glEnd}. It indicates
+the end of a primitive and it takes no arguments. The function prototype
+for this callback is:
+
+@item @code{GLU_TESS_END_DATA}
+The same as the @code{GLU_TESS_END} callback except that it takes an
+additional pointer argument. This pointer is identical to the opaque
+pointer provided when @code{gluTessBeginPolygon} was called. The
+function prototype for this callback is:
+
+@item @code{GLU_TESS_COMBINE}
+The combine callback is called to create a new vertex when the
+tessellation detects an intersection or wishes to merge features. The
+function takes four arguments: an array of three elements each of type
+GLdouble, an array of four pointers, an array of four elements each of
+type GLfloat, and a pointer to a pointer. The prototype is:
+
+The vertex is defined as a linear combination of up to four existing
+vertices, stored in @var{vertex_data}. The coefficients of the linear
+combination are given by @var{weight}; these weights always add up to 1.
+All vertex pointers are valid even when some of the weights are 0.
+@var{coords} gives the location of the new vertex.
+
+The user must allocate another vertex, interpolate parameters using
+@var{vertex_data} and @var{weight}, and return the new vertex pointer in
+@var{outData}. This handle is supplied during rendering callbacks. The
+user is responsible for freeing the memory some time after
+@code{gluTessEndPolygon} is called.
+
+For example, if the polygon lies in an arbitrary plane in 3-space, and a
+color is associated with each vertex, the @code{GLU_TESS_COMBINE}
+callback might look like this:
+
+If the tessellation detects an intersection, then the
+@code{GLU_TESS_COMBINE} or @code{GLU_TESS_COMBINE_DATA} callback (see
+below) must be defined, and it must write a non-NULL pointer into
+@var{dataOut}. Otherwise the @code{GLU_TESS_NEED_COMBINE_CALLBACK} error
+occurs, and no output is generated.
+
+@item @code{GLU_TESS_COMBINE_DATA}
+The same as the @code{GLU_TESS_COMBINE} callback except that it takes an
+additional pointer argument. This pointer is identical to the opaque
+pointer provided when @code{gluTessBeginPolygon} was called. The
+function prototype for this callback is:
+
+@item @code{GLU_TESS_ERROR}
+The error callback is called when an error is encountered. The one
+argument is of type GLenum; it indicates the specific error that
+occurred and will be set to one of
+@code{GLU_TESS_MISSING_BEGIN_POLYGON},
+@code{GLU_TESS_MISSING_END_POLYGON},
+@code{GLU_TESS_MISSING_BEGIN_CONTOUR},
+@code{GLU_TESS_MISSING_END_CONTOUR}, @code{GLU_TESS_COORD_TOO_LARGE},
+@code{GLU_TESS_NEED_COMBINE_CALLBACK}, or @code{GLU_OUT_OF_MEMORY}.
+Character strings describing these errors can be retrieved with the
+@code{gluErrorString} call. The function prototype for this callback is:
+
+The GLU library will recover from the first four errors by inserting the
+missing call(s). @code{GLU_TESS_COORD_TOO_LARGE} indicates that some
+vertex coordinate exceeded the predefined constant
+@code{GLU_TESS_MAX_COORD} in absolute value, and that the value has been
+clamped. (Coordinate values must be small enough so that two can be
+multiplied together without overflow.)
+@code{GLU_TESS_NEED_COMBINE_CALLBACK} indicates that the tessellation
+detected an intersection between two edges in the input data, and the
+@code{GLU_TESS_COMBINE} or @code{GLU_TESS_COMBINE_DATA} callback was not
+provided. No output is generated. @code{GLU_OUT_OF_MEMORY} indicates
+that there is not enough memory so no output is generated.
+
+@item @code{GLU_TESS_ERROR_DATA}
+The same as the @code{GLU_TESS_ERROR} callback except that it takes an
+additional pointer argument. This pointer is identical to the opaque
+pointer provided when @code{gluTessBeginPolygon} was called. The
+function prototype for this callback is:
+
+@end table
+
+@example
+
+void begin( GLenum type );
+@end example
+
+@example
+
+void beginData( GLenum type, void *polygon_data );
+@end example
+
+@example
+
+void edgeFlag( GLboolean flag );
+@end example
+
+@example
+
+void edgeFlagData( GLboolean flag, void *polygon_data );
+@end example
+
+@example
+
+void vertex( void *vertex_data );
+@end example
+
+@example
+
+void vertexData( void *vertex_data, void *polygon_data );
+@end example
+
+@example
+
+void end( void );
+@end example
+
+@example
+
+void endData( void *polygon_data );
+@end example
+
+@example
+
+void combine( GLdouble coords[3], void *vertex_data[4],
+ GLfloat weight[4], void **outData );
+@end example
+
+@example
+
+void myCombine( GLdouble coords[3], VERTEX *d[4],
+ GLfloat w[4], VERTEX **dataOut )
+@{
+ VERTEX *new = new_vertex();
+
+ new->x = coords[0];
+ new->y = coords[1];
+ new->z = coords[2];
+ new->r = w[0]*d[0]->r + w[1]*d[1]->r + w[2]*d[2]->r + w[3]*d[3]->r;
+ new->g = w[0]*d[0]->g + w[1]*d[1]->g + w[2]*d[2]->g + w[3]*d[3]->g;
+ new->b = w[0]*d[0]->b + w[1]*d[1]->b + w[2]*d[2]->b + w[3]*d[3]->b;
+ new->a = w[0]*d[0]->a + w[1]*d[1]->a + w[2]*d[2]->a + w[3]*d[3]->a;
+ *dataOut = new;
+@}
+@end example
+
+@example
+
+void combineData( GLdouble coords[3], void *vertex_data[4],
+ GLfloat weight[4], void **outData,
+ void *polygon_data );
+@end example
+
+@example
+
+void error( GLenum errno );
+@end example
+
+@example
+
+void errorData( GLenum errno, void *polygon_data );
+@end example
+
+@end defun
+
+@defun gluTessEndPolygon
+@heading delimit a polygon description
+@heading Parameters
+@table @asis
+@item @var{tess}
+Specifies the tessellation object (created with @code{gluNewTess}).
+
+@end table
+
+@heading Description
+@code{gluTessBeginPolygon} and @code{gluTessEndPolygon} delimit the
+definition of a convex, concave, or self-intersecting polygon. Within
+each @code{gluTessBeginPolygon}/@code{gluTessEndPolygon} pair, there
+must be one or more calls to
+@code{gluTessBeginContour}/@code{gluTessEndContour}. Within each
+contour, there are zero or more calls to @code{gluTessVertex}. The
+vertices specify a closed contour (the last vertex of each contour is
+automatically linked to the first). See the @code{gluTessVertex},
+@code{gluTessBeginContour}, and @code{gluTessEndContour} reference pages
+for more details.
+
+Once @code{gluTessEndPolygon} is called, the polygon is tessellated, and
+the resulting triangles are described through callbacks. See
+@code{gluTessCallback} for descriptions of the callback functions.
+
+@end defun
+
+@defun gluTessNormal
+@heading specify a normal for a polygon
+@heading Parameters
+@table @asis
+@item @var{tess}
+Specifies the tessellation object (created with @code{gluNewTess}).
+
+@item @var{valueX}
+Specifies the first component of the normal.
+
+@item @var{valueY}
+Specifies the second component of the normal.
+
+@item @var{valueZ}
+Specifies the third component of the normal.
+
+@end table
+
+@heading Description
+@code{gluTessNormal} describes a normal for a polygon that the program
+is defining. All input data will be projected onto a plane perpendicular
+to one of the three coordinate axes before tessellation and all output
+triangles will be oriented CCW with respect to the normal (CW
+orientation can be obtained by reversing the sign of the supplied
+normal). For example, if you know that all polygons lie in the x-y
+plane, call @code{gluTessNormal}(tess, 0.0, 0.0, 1.0) before rendering
+any polygons.
+
+If the supplied normal is (0.0, 0.0, 0.0) (the initial value), the
+normal is determined as follows. The direction of the normal, up to its
+sign, is found by fitting a plane to the vertices, without regard to how
+the vertices are connected. It is expected that the input data lies
+approximately in the plane; otherwise, projection perpendicular to one
+of the three coordinate axes may substantially change the geometry. The
+sign of the normal is chosen so that the sum of the signed areas of all
+input contours is nonnegative (where a CCW contour has positive area).
+
+The supplied normal persists until it is changed by another call to
+@code{gluTessNormal}.
+
+@end defun
+
+@defun gluTessProperty
+@heading set a tessellation object property
+@heading Parameters
+@table @asis
+@item @var{tess}
+Specifies the tessellation object (created with @code{gluNewTess}).
+
+@item @var{which}
+Specifies the property to be set. Valid values are
+@code{GLU_TESS_WINDING_RULE}, @code{GLU_TESS_BOUNDARY_ONLY}, and
+@code{GLU_TESS_TOLERANCE}.
+
+@item @var{data}
+Specifies the value of the indicated property.
+
+@end table
+
+@heading Description
+@code{gluTessProperty} is used to control properties stored in a
+tessellation object. These properties affect the way that the polygons
+are interpreted and rendered. The legal values for @var{which} are as
+follows:
+
+@table @asis
+@item @code{GLU_TESS_WINDING_RULE}
+Determines which parts of the polygon are on the ``interior''.
+@var{data} may be set to one of @code{GLU_TESS_WINDING_ODD},
+@code{GLU_TESS_WINDING_NONZERO}, @code{GLU_TESS_WINDING_POSITIVE},
+@code{GLU_TESS_WINDING_NEGATIVE}, or
+@code{GLU_TESS_WINDING_ABS_GEQ_TWO}.
+
+To understand how the winding rule works, consider that the input
+contours partition the plane into regions. The winding rule determines
+which of these regions are inside the polygon.
+
+For a single contour C, the winding number of a point x is simply the
+signed number of revolutions we make around x as we travel once around C
+(where CCW is positive). When there are several contours, the individual
+winding numbers are summed. This procedure associates a signed integer
+value with each point x in the plane. Note that the winding number is
+the same for all points in a single region.
+
+The winding rule classifies a region as ``inside'' if its winding number
+belongs to the chosen category (odd, nonzero, positive, negative, or
+absolute value of at least two). The previous GLU tessellator (prior to
+GLU 1.2) used the ``odd'' rule. The ``nonzero'' rule is another common
+way to define the interior. The other three rules are useful for polygon
+CSG operations.
+
+@item @code{GLU_TESS_BOUNDARY_ONLY}
+Is a boolean value (``value'' should be set to GL_TRUE or GL_FALSE).
+When set to GL_TRUE, a set of closed contours separating the polygon
+interior and exterior are returned instead of a tessellation. Exterior
+contours are oriented CCW with respect to the normal; interior contours
+are oriented CW. The @code{GLU_TESS_BEGIN} and
+@code{GLU_TESS_BEGIN_DATA} callbacks use the type GL_LINE_LOOP for each
+contour.
+
+@item @code{GLU_TESS_TOLERANCE}
+Specifies a tolerance for merging features to reduce the size of the
+output. For example, two vertices that are very close to each other
+might be replaced by a single vertex. The tolerance is multiplied by the
+largest coordinate magnitude of any input vertex; this specifies the
+maximum distance that any feature can move as the result of a single
+merge operation. If a single feature takes part in several merge
+operations, the total distance moved could be larger.
+
+Feature merging is completely optional; the tolerance is only a hint.
+The implementation is free to merge in some cases and not in others, or
+to never merge features at all. The initial tolerance is 0.
+
+The current implementation merges vertices only if they are exactly
+coincident, regardless of the current tolerance. A vertex is spliced
+into an edge only if the implementation is unable to distinguish which
+side of the edge the vertex lies on. Two edges are merged only when both
+endpoints are identical.
+
+@end table
+
+@end defun
+
+@defun gluTessVertex
+@heading specify a vertex on a polygon
+@heading Parameters
+@table @asis
+@item @var{tess}
+Specifies the tessellation object (created with @code{gluNewTess}).
+
+@item @var{location}
+Specifies the location of the vertex.
+
+@item @var{data}
+Specifies an opaque pointer passed back to the program with the vertex
+callback (as specified by @code{gluTessCallback}).
+
+@end table
+
+@heading Description
+@code{gluTessVertex} describes a vertex on a polygon that the program
+defines. Successive @code{gluTessVertex} calls describe a closed
+contour. For example, to describe a quadrilateral, @code{gluTessVertex}
+should be called four times. @code{gluTessVertex} can only be called
+between @code{gluTessBeginContour} and @code{gluTessEndContour}.
+
+@var{data} normally points to a structure containing the vertex
+location, as well as other per-vertex attributes such as color and
+normal. This pointer is passed back to the user through the
+@code{GLU_TESS_VERTEX} or @code{GLU_TESS_VERTEX_DATA} callback after
+tessellation (see the @code{gluTessCallback} reference page).
+
+@end defun
+
+@defun gluUnProject4
+@heading map window and clip coordinates to object coordinates
+@heading Parameters
+@table @asis
+@item @var{winX}
+@itemx @var{winY}
+@itemx @var{winZ}
+Specify the window coordinates to be mapped.
+
+@item @var{clipW}
+Specify the clip w coordinate to be mapped.
+
+@item @var{model}
+Specifies the modelview matrix (as from a @code{glGetDoublev} call).
+
+@item @var{proj}
+Specifies the projection matrix (as from a @code{glGetDoublev} call).
+
+@item @var{view}
+Specifies the viewport (as from a @code{glGetIntegerv} call).
+
+@item @var{nearVal}
+@itemx @var{farVal}
+Specifies the near and far planes (as from a @code{glGetDoublev} call).
+
+@item @var{objX}
+@itemx @var{objY}
+@itemx @var{objZ}
+@itemx @var{objW}
+Returns the computed object coordinates.
+
+@end table
+
+@heading Description
+@code{gluUnProject4} maps the specified window coordinatesi: @var{winX},
+@var{winY}, and @var{winZ} and its clip w coordinate @var{clipW} into
+object coordinates @math{(@var{objX},@var{objY}@var{objZ}@var{objW})}
+using @var{model}, @var{proj}, and @var{view}. @var{clipW} can be other
+than 1 as for vertices in @code{glFeedbackBuffer} when data type
+@code{GLU_4D_COLOR_TEXTURE} is returned. This also handles the case
+where the @var{nearVal} and @var{farVal} planes are different from the
+default, 0 and 1, respectively. A return value of @code{GLU_TRUE}
+indicates success; a return value of @code{GLU_FALSE} indicates failure.
+
+To compute the coordinates
+@math{(@var{objX},@var{objY}@var{objZ}@var{objW})}, @code{gluUnProject4}
+multiplies the normalized device coordinates by the inverse of
+@var{model} * @var{proj} as follows:
+
+@math{((@var{objX}), (@var{objY}), (@var{objZ}),
+(@var{objW}),)=@var{INV}(@var{P}@var{M},)((2(@var{winX}-@var{view}[0,],),/@var{view}[2,],-1),
+(2(@var{winY}-@var{view}[1,],),/@var{view}[3,],-1),
+(2(@var{winZ}-@var{nearVal},),/(@var{farVal}-@var{nearVal},),-1),
+(@var{clipW}),)}
+
+@math{@var{INV}} denotes matrix inversion.
+
+@code{gluUnProject4} is equivalent to @code{gluUnProject} when
+@var{clipW} is 1, @var{nearVal} is 0, and @var{farVal} is 1.
+
+@end defun
+
+@defun gluUnProject
+@heading map window coordinates to object coordinates
+@heading Parameters
+@table @asis
+@item @var{winX}
+@itemx @var{winY}
+@itemx @var{winZ}
+Specify the window coordinates to be mapped.
+
+@item @var{model}
+Specifies the modelview matrix (as from a @code{glGetDoublev} call).
+
+@item @var{proj}
+Specifies the projection matrix (as from a @code{glGetDoublev} call).
+
+@item @var{view}
+Specifies the viewport (as from a @code{glGetIntegerv} call).
+
+@item @var{objX}
+@itemx @var{objY}
+@itemx @var{objZ}
+Returns the computed object coordinates.
+
+@end table
+
+@heading Description
+@code{gluUnProject} maps the specified window coordinates into object
+coordinates using @var{model}, @var{proj}, and @var{view}. The result is
+stored in @var{objX}, @var{objY}, and @var{objZ}. A return value of
+@code{GLU_TRUE} indicates success; a return value of @code{GLU_FALSE}
+indicates failure.
+
+To compute the coordinates @math{(@var{objX},@var{objY}@var{objZ})},
+@code{gluUnProject} multiplies the normalized device coordinates by the
+inverse of @var{model} * @var{proj} as follows:
+
+@math{((@var{objX}), (@var{objY}), (@var{objZ}),
+(@var{W}),)=@var{INV}(@var{P}@var{M},)((2(@var{winX}-@var{view}[0,],),/@var{view}[2,],-1),
+(2(@var{winY}-@var{view}[1,],),/@var{view}[3,],-1),
+(2(@var{winZ},)-1), (1),)}@math{@var{INV}} denotes matrix inversion. W
+is an unused variable, included for consistent matrix notation.
+
+@end defun
+
+
+@c %end of fragment
--- /dev/null
+
+@c %start of fragment
+
+@copying
+This section of the manual was derived from the upstream OpenGL
+documentation. Each function's documentation has its own copyright
+statement; for full details, see the upstream documentation. The
+copyright notices and licenses present in this section are as follows.
+
+Copyright @copyright{} 1991-2006 Silicon Graphics, Inc. This document is
+licensed under the SGI Free Software B License. For details, see
+@uref{http://oss.sgi.com/projects/FreeB/,http://oss.sgi.com/projects/FreeB/}.
+
+@end copying
+
+The functions from this section may be had by loading the module:
+
+@example
+(use-modules (figl low-level glx))
+@end example
+
+@defun glXChooseFBConfig
+@heading return a list of GLX frame buffer configurations that match the specified attributes
+@heading Parameters
+@table @asis
+@item @var{dpy}
+Specifies the connection to the X server.
+
+@item @var{screen}
+Specifies the screen number.
+
+@item @var{attrib_list}
+Specifies a list of attribute/value pairs. The last attribute must be
+@code{None}.
+
+@item @var{nelements}
+Returns the number of elements in the list returned by
+@code{glXChooseFBConfig}.
+
+@end table
+
+@heading Description
+@code{glXChooseFBConfig} returns GLX frame buffer configurations that
+match the attributes specified in @var{attrib_list}, or @code{NULL} if
+no matches are found. If @var{attrib_list} is @code{NULL}, then
+@code{glXChooseFBConfig} returns an array of GLX frame buffer
+configurations that are available on the specified screen. If an error
+occurs, no frame buffer configurations exist on the specified screen, or
+if no frame buffer configurations match the specified attributes, then
+@code{NULL} is returned. Use @code{XFree} to free the memory returned by
+@code{glXChooseFBConfig}.
+
+All attributes in @var{attrib_list}, including boolean attributes, are
+immediately followed by the corresponding desired value. The list is
+terminated with @code{None}. If an attribute is not specified in
+@var{attrib_list}, then the default value (see below) is used (and the
+attribute is said to be specified implicitly). For example, if
+@code{GLX_STEREO} is not specified, then it is assumed to be
+@code{False}. For some attributes, the default is @code{GLX_DONT_CARE},
+meaning that any value is OK for this attribute, so the attribute will
+not be checked.
+
+Attributes are matched in an attribute-specific manner. Some of the
+attributes, such as @code{GLX_LEVEL}, must match the specified value
+exactly; others, such as, @code{GLX_RED_SIZE} must meet or exceed the
+specified minimum values. If more than one GLX frame buffer
+configuration is found, then a list of configurations, sorted according
+to the ``best'' match criteria, is returned. The match criteria for each
+attribute and the exact sorting order is defined below.
+
+The interpretations of the various GLX visual attributes are as follows:
+
+@table @asis
+@item @code{GLX_FBCONFIG_ID}
+
+
+Must be followed by a valid XID that indicates the desired GLX frame
+buffer configuration. When a @code{GLX_FBCONFIG_ID} is specified, all
+attributes are ignored. The default value is @code{GLX_DONT_CARE}.
+
+@item @code{GLX_BUFFER_SIZE}
+
+
+Must be followed by a nonnegative integer that indicates the desired
+color index buffer size. The smallest index buffer of at least the
+specified size is preferred. This attribute is ignored if
+@code{GLX_COLOR_INDEX_BIT} is not set in @code{GLX_RENDER_TYPE}. The
+default value is 0.
+
+@item @code{GLX_LEVEL}
+
+
+Must be followed by an integer buffer-level specification. This
+specification is honored exactly. Buffer level 0 corresponds to the
+default frame buffer of the display. Buffer level 1 is the first overlay
+frame buffer, level two the second overlay frame buffer, and so on.
+Negative buffer levels correspond to underlay frame buffers. The default
+value is 0.
+
+@item @code{GLX_DOUBLEBUFFER}
+
+
+Must be followed by @code{True} or @code{False}. If @code{True} is
+specified, then only double-buffered frame buffer configurations are
+considered; if @code{False} is specified, then only single-buffered
+frame buffer configurations are considered. The default value is
+@code{GLX_DONT_CARE}.
+
+@item @code{GLX_STEREO}
+
+
+Must be followed by @code{True} or @code{False}. If @code{True} is
+specified, then only stereo frame buffer configurations are considered;
+if @code{False} is specified, then only monoscopic frame buffer
+configurations are considered. The default value is @code{False}.
+
+@item @code{GLX_AUX_BUFFERS}
+
+
+Must be followed by a nonnegative integer that indicates the desired
+number of auxiliary buffers. Configurations with the smallest number of
+auxiliary buffers that meet or exceed the specified number are
+preferred. The default value is 0.
+
+@item @code{GLX_RED_SIZE}, @code{GLX_GREEN_SIZE}, @code{GLX_BLUE_SIZE}, @code{GLX_ALPHA_SIZE}
+
+
+Each attribute, if present, must be followed by a nonnegative minimum
+size specification or @code{GLX_DONT_CARE}. The largest available total
+RGBA color buffer size (sum of @code{GLX_RED_SIZE},
+@code{GLX_GREEN_SIZE}, @code{GLX_BLUE_SIZE}, and @code{GLX_ALPHA_SIZE})
+of at least the minimum size specified for each color component is
+preferred. If the requested number of bits for a color component is 0 or
+@code{GLX_DONT_CARE}, it is not considered. The default value for each
+color component is 0.
+
+@item @code{GLX_DEPTH_SIZE}
+
+
+Must be followed by a nonnegative minimum size specification. If this
+value is zero, frame buffer configurations with no depth buffer are
+preferred. Otherwise, the largest available depth buffer of at least the
+minimum size is preferred. The default value is 0.
+
+@item @code{GLX_STENCIL_SIZE}
+
+
+Must be followed by a nonnegative integer that indicates the desired
+number of stencil bitplanes. The smallest stencil buffer of at least the
+specified size is preferred. If the desired value is zero, frame buffer
+configurations with no stencil buffer are preferred. The default value
+is 0.
+
+@item @code{GLX_ACCUM_RED_SIZE}
+
+
+Must be followed by a nonnegative minimum size specification. If this
+value is zero, frame buffer configurations with no red accumulation
+buffer are preferred. Otherwise, the largest possible red accumulation
+buffer of at least the minimum size is preferred. The default value is
+0.
+
+@item @code{GLX_ACCUM_GREEN_SIZE}
+
+
+Must be followed by a nonnegative minimum size specification. If this
+value is zero, frame buffer configurations with no green accumulation
+buffer are preferred. Otherwise, the largest possible green accumulation
+buffer of at least the minimum size is preferred. The default value is
+0.
+
+@item @code{GLX_ACCUM_BLUE_SIZE}
+
+
+Must be followed by a nonnegative minimum size specification. If this
+value is zero, frame buffer configurations with no blue accumulation
+buffer are preferred. Otherwise, the largest possible blue accumulation
+buffer of at least the minimum size is preferred. The default value is
+0.
+
+@item @code{GLX_ACCUM_ALPHA_SIZE}
+
+
+Must be followed by a nonnegative minimum size specification. If this
+value is zero, frame buffer configurations with no alpha accumulation
+buffer are preferred. Otherwise, the largest possible alpha accumulation
+buffer of at least the minimum size is preferred. The default value is
+0.
+
+@item @code{GLX_RENDER_TYPE}
+
+
+Must be followed by a mask indicating which OpenGL rendering modes the
+frame buffer configuration must support. Valid bits are
+@code{GLX_RGBA_BIT} and @code{GLX_COLOR_INDEX_BIT}. If the mask is set
+to @code{GLX_RGBA_BIT} | @code{GLX_COLOR_INDEX_BIT}, then only frame
+buffer configurations that can be bound to both RGBA contexts and color
+index contexts will be considered. The default value is
+@code{GLX_RGBA_BIT}.
+
+@item @code{GLX_DRAWABLE_TYPE}
+
+
+Must be followed by a mask indicating which GLX drawable types the frame
+buffer configuration must support. Valid bits are @code{GLX_WINDOW_BIT},
+@code{GLX_PIXMAP_BIT}, and @code{GLX_PBUFFER_BIT}. For example, if mask
+is set to @code{GLX_WINDOW_BIT} | @code{GLX_PIXMAP_BIT}, only frame
+buffer configurations that support both windows and GLX pixmaps will be
+considered. The default value is @code{GLX_WINDOW_BIT}.
+
+@item @code{GLX_X_RENDERABLE}
+
+
+Must be followed by @code{True} or @code{False}. If @code{True} is
+specified, then only frame buffer configurations that have associated X
+visuals (and can be used to render to Windows and/or GLX pixmaps) will
+be considered. The default value is @code{GLX_DONT_CARE}.
+
+@item @code{GLX_X_VISUAL_TYPE}
+
+
+Must be followed by one of @code{GLX_TRUE_COLOR},
+@code{GLX_DIRECT_COLOR}, @code{GLX_PSEUDO_COLOR},
+@code{GLX_STATIC_COLOR}, @code{GLX_GRAY_SCALE}, or
+@code{GLX_STATIC_GRAY}, indicating the desired X visual type. Not all
+frame buffer configurations have an associated X visual. If
+@code{GLX_DRAWABLE_TYPE} is specified in @var{attrib_list} and the mask
+that follows does not have @code{GLX_WINDOW_BIT} set, then this value is
+ignored. It is also ignored if @code{GLX_X_RENDERABLE} is specified as
+@code{False}. RGBA rendering may be supported for visuals of type
+@code{GLX_TRUE_COLOR}, @code{GLX_DIRECT_COLOR}, @code{GLX_PSEUDO_COLOR},
+or @code{GLX_STATIC_COLOR}, but color index rendering is only supported
+for visuals of type @code{GLX_PSEUDO_COLOR} or @code{GLX_STATIC_COLOR}
+(i.e., single-channel visuals). The tokens @code{GLX_GRAY_SCALE} and
+@code{GLX_STATIC_GRAY} will not match current OpenGL enabled visuals,
+but are included for future use. The default value for
+@code{GLX_X_VISUAL_TYPE} is @code{GLX_DONT_CARE}.
+
+@item @code{GLX_CONFIG_CAVEAT}
+
+
+Must be followed by one of @code{GLX_NONE}, @code{GLX_SLOW_CONFIG},
+@code{GLX_NON_CONFORMANT_CONFIG}. If @code{GLX_NONE} is specified, then
+only frame buffer configurations with no caveats will be considered; if
+@code{GLX_SLOW_CONFIG} is specified, then only slow frame buffer
+configurations will be considered; if @code{GLX_NON_CONFORMANT_CONFIG}
+is specified, then only nonconformant frame buffer configurations will
+be considered. The default value is @code{GLX_DONT_CARE}.
+
+@item @code{GLX_TRANSPARENT_TYPE}
+
+
+Must be followed by one of @code{GLX_NONE}, @code{GLX_TRANSPARENT_RGB},
+@code{GLX_TRANSPARENT_INDEX}. If @code{GLX_NONE} is specified, then only
+opaque frame buffer configurations will be considered; if
+@code{GLX_TRANSPARENT_RGB} is specified, then only transparent frame
+buffer configurations that support RGBA rendering will be considered; if
+@code{GLX_TRANSPARENT_INDEX} is specified, then only transparent frame
+buffer configurations that support color index rendering will be
+considered. The default value is @code{GLX_NONE}.
+
+@item @code{GLX_TRANSPARENT_INDEX_VALUE}
+
+
+Must be followed by an integer value indicating the transparent index
+value; the value must be between 0 and the maximum frame buffer value
+for indices. Only frame buffer configurations that use the specified
+transparent index value will be considered. The default value is
+@code{GLX_DONT_CARE}. This attribute is ignored unless
+@code{GLX_TRANSPARENT_TYPE} is included in @var{attrib_list} and
+specified as @code{GLX_TRANSPARENT_INDEX}.
+
+@item @code{GLX_TRANSPARENT_RED_VALUE}
+
+
+Must be followed by an integer value indicating the transparent red
+value; the value must be between 0 and the maximum frame buffer value
+for red. Only frame buffer configurations that use the specified
+transparent red value will be considered. The default value is
+@code{GLX_DONT_CARE}. This attribute is ignored unless
+@code{GLX_TRANSPARENT_TYPE} is included in @var{attrib_list} and
+specified as @code{GLX_TRANSPARENT_RGB}.
+
+@item @code{GLX_TRANSPARENT_GREEN_VALUE}
+
+
+Must be followed by an integer value indicating the transparent green
+value; the value must be between 0 and the maximum frame buffer value
+for green. Only frame buffer configurations that use the specified
+transparent green value will be considered. The default value is
+@code{GLX_DONT_CARE}. This attribute is ignored unless
+@code{GLX_TRANSPARENT_TYPE} is included in @var{attrib_list} and
+specified as @code{GLX_TRANSPARENT_RGB}.
+
+@item @code{GLX_TRANSPARENT_BLUE_VALUE}
+
+
+Must be followed by an integer value indicating the transparent blue
+value; the value must be between 0 and the maximum frame buffer value
+for blue. Only frame buffer configurations that use the specified
+transparent blue value will be considered. The default value is
+@code{GLX_DONT_CARE}. This attribute is ignored unless
+@code{GLX_TRANSPARENT_TYPE} is included in @var{attrib_list} and
+specified as @code{GLX_TRANSPARENT_RGB}.
+
+@item @code{GLX_TRANSPARENT_ALPHA_VALUE}
+
+
+Must be followed by an integer value indicating the transparent alpha
+value; the value must be between 0 and the maximum frame buffer value
+for alpha. Only frame buffer configurations that use the specified
+transparent alpha value will be considered. The default value is
+@code{GLX_DONT_CARE}.
+
+@end table
+
+When more than one GLX frame buffer configuration matches the specified
+attributes, a list of matching configurations is returned. The list is
+sorted according to the following precedence rules, which are applied in
+ascending order (i.e., configurations that are considered equal by a
+lower numbered rule are sorted by the higher numbered rule):
+
+@table @asis
+@item 1.
+By @code{GLX_CONFIG_CAVEAT} where the precedence is @code{GLX_NONE},
+@code{GLX_SLOW_CONFIG}, and @code{GLX_NON_CONFORMANT_CONFIG}.
+
+@item 2.
+Larger total number of RGBA color components (@code{GLX_RED_SIZE},
+@code{GLX_GREEN_SIZE}, @code{GLX_BLUE_SIZE}, plus @code{GLX_ALPHA_SIZE})
+that have higher number of bits. If the requested number of bits in
+@var{attrib_list} is zero or @code{GLX_DONT_CARE} for a particular color
+component, then the number of bits for that component is not considered.
+
+@item 3.
+Smaller @code{GLX_BUFFER_SIZE}.
+
+@item 4.
+Single buffered configuration (@code{GLX_DOUBLEBUFFER} being
+@code{False} precedes a double buffered one.
+
+@item 5.
+Smaller @code{GLX_AUX_BUFFERS}.
+
+@item 6.
+Larger @code{GLX_DEPTH_SIZE}.
+
+@item 7.
+Smaller @code{GLX_STENCIL_SIZE}.
+
+@item 8.
+Larger total number of accumulation buffer color components
+(@code{GLX_ACCUM_RED_SIZE}, @code{GLX_ACCUM_GREEN_SIZE},
+@code{GLX_ACCUM_BLUE_SIZE}, plus @code{GLX_ACCUM_ALPHA_SIZE}) that have
+higher number of bits. If the requested number of bits in
+@var{attrib_list} is zero or @code{GLX_DONT_CARE} for a particular color
+component, then the number of bits for that component is not considered.
+
+@item 9.
+By @code{GLX_X_VISUAL_TYPE} where the precedence order is
+@code{GLX_TRUE_COLOR}, @code{GLX_DIRECT_COLOR}, @code{GLX_PSEUDO_COLOR},
+@code{GLX_STATIC_COLOR}, @code{GLX_GRAY_SCALE}, @code{GLX_STATIC_GRAY}.
+
+@end table
+
+@heading Errors
+@code{NULL} is returned if an undefined GLX attribute is encountered in
+@var{attrib_list}, if @var{screen} is invalid, or if @var{dpy} does not
+support the GLX extension.
+
+@end defun
+
+@defun glXChooseVisual
+@heading return a visual that matches specified attributes
+@heading Parameters
+@table @asis
+@item @var{dpy}
+Specifies the connection to the X server.
+
+@item @var{screen}
+Specifies the screen number.
+
+@item @var{attribList}
+Specifies a list of boolean attributes and integer attribute/value
+pairs. The last attribute must be @code{None}.
+
+@end table
+
+@heading Description
+@code{glXChooseVisual} returns a pointer to an XVisualInfo structure
+describing the visual that best meets a minimum specification. The
+boolean GLX attributes of the visual that is returned will match the
+specified values, and the integer GLX attributes will meet or exceed the
+specified minimum values. If all other attributes are equivalent, then
+TrueColor and PseudoColor visuals have priority over DirectColor and
+StaticColor visuals, respectively. If no conforming visual exists,
+@code{NULL} is returned. To free the data returned by this function, use
+@code{XFree}.
+
+All boolean GLX attributes default to @code{False} except
+@code{GLX_USE_GL}, which defaults to @code{True}. All integer GLX
+attributes default to zero. Default specifications are superseded by
+attributes included in @var{attribList}. Boolean attributes included in
+@var{attribList} are understood to be @code{True}. Integer attributes
+and enumerated type attributes are followed immediately by the
+corresponding desired or minimum value. The list must be terminated with
+@code{None}.
+
+The interpretations of the various GLX visual attributes are as follows:
+
+@table @asis
+@item @code{GLX_USE_GL}
+Ignored. Only visuals that can be rendered with GLX are considered.
+
+@item @code{GLX_BUFFER_SIZE}
+Must be followed by a nonnegative integer that indicates the desired
+color index buffer size. The smallest index buffer of at least the
+specified size is preferred. Ignored if @code{GLX_RGBA} is asserted.
+
+@item @code{GLX_LEVEL}
+Must be followed by an integer buffer-level specification. This
+specification is honored exactly. Buffer level zero corresponds to the
+main frame buffer of the display. Buffer level one is the first overlay
+frame buffer, level two the second overlay frame buffer, and so on.
+Negative buffer levels correspond to underlay frame buffers.
+
+@item @code{GLX_RGBA}
+If present, only TrueColor and DirectColor visuals are considered.
+Otherwise, only PseudoColor and StaticColor visuals are considered.
+
+@item @code{GLX_DOUBLEBUFFER}
+If present, only double-buffered visuals are considered. Otherwise, only
+single-buffered visuals are considered.
+
+@item @code{GLX_STEREO}
+If present, only stereo visuals are considered. Otherwise, only
+monoscopic visuals are considered.
+
+@item @code{GLX_AUX_BUFFERS}
+Must be followed by a nonnegative integer that indicates the desired
+number of auxiliary buffers. Visuals with the smallest number of
+auxiliary buffers that meets or exceeds the specified number are
+preferred.
+
+@item @code{GLX_RED_SIZE}
+Must be followed by a nonnegative minimum size specification. If this
+value is zero, the smallest available red buffer is preferred.
+Otherwise, the largest available red buffer of at least the minimum size
+is preferred.
+
+@item @code{GLX_GREEN_SIZE}
+Must be followed by a nonnegative minimum size specification. If this
+value is zero, the smallest available green buffer is preferred.
+Otherwise, the largest available green buffer of at least the minimum
+size is preferred.
+
+@item @code{GLX_BLUE_SIZE}
+Must be followed by a nonnegative minimum size specification. If this
+value is zero, the smallest available blue buffer is preferred.
+Otherwise, the largest available blue buffer of at least the minimum
+size is preferred.
+
+@item @code{GLX_ALPHA_SIZE}
+Must be followed by a nonnegative minimum size specification. If this
+value is zero, the smallest available alpha buffer is preferred.
+Otherwise, the largest available alpha buffer of at least the minimum
+size is preferred.
+
+@item @code{GLX_DEPTH_SIZE}
+Must be followed by a nonnegative minimum size specification. If this
+value is zero, visuals with no depth buffer are preferred. Otherwise,
+the largest available depth buffer of at least the minimum size is
+preferred.
+
+@item @code{GLX_STENCIL_SIZE}
+Must be followed by a nonnegative integer that indicates the desired
+number of stencil bitplanes. The smallest stencil buffer of at least the
+specified size is preferred. If the desired value is zero, visuals with
+no stencil buffer are preferred.
+
+@item @code{GLX_ACCUM_RED_SIZE}
+Must be followed by a nonnegative minimum size specification. If this
+value is zero, visuals with no red accumulation buffer are preferred.
+Otherwise, the largest possible red accumulation buffer of at least the
+minimum size is preferred.
+
+@item @code{GLX_ACCUM_GREEN_SIZE}
+Must be followed by a nonnegative minimum size specification. If this
+value is zero, visuals with no green accumulation buffer are preferred.
+Otherwise, the largest possible green accumulation buffer of at least
+the minimum size is preferred.
+
+@item @code{GLX_ACCUM_BLUE_SIZE}
+Must be followed by a nonnegative minimum size specification. If this
+value is zero, visuals with no blue accumulation buffer are preferred.
+Otherwise, the largest possible blue accumulation buffer of at least the
+minimum size is preferred.
+
+@item @code{GLX_ACCUM_ALPHA_SIZE}
+Must be followed by a nonnegative minimum size specification. If this
+value is zero, visuals with no alpha accumulation buffer are preferred.
+Otherwise, the largest possible alpha accumulation buffer of at least
+the minimum size is preferred.
+
+@end table
+
+@heading Errors
+@code{NULL} is returned if an undefined GLX attribute is encountered in
+@var{attribList}.
+
+@end defun
+
+@defun glXCopyContext
+@heading copy state from one rendering context to another
+@heading Parameters
+@table @asis
+@item @var{dpy}
+Specifies the connection to the X server.
+
+@item @var{src}
+Specifies the source context.
+
+@item @var{dst}
+Specifies the destination context.
+
+@item @var{mask}
+Specifies which portions of @var{src} state are to be copied to
+@var{dst}.
+
+@end table
+
+@heading Description
+@code{glXCopyContext} copies selected groups of state variables from
+@var{src} to @var{dst}. @var{mask} indicates which groups of state
+variables are to be copied. @var{mask} contains the bitwise OR of the
+same symbolic names that are passed to the GL command
+@code{glPushAttrib}. The single symbolic constant
+@code{GLX_ALL_ATTRIB_BITS} can be used to copy the maximum possible
+portion of rendering state.
+
+The copy can be done only if the renderers named by @var{src} and
+@var{dst} share an address space. Two rendering contexts share an
+address space if both are nondirect using the same server, or if both
+are direct and owned by a single process. Note that in the nondirect
+case it is not necessary for the calling threads to share an address
+space, only for their related rendering contexts to share an address
+space.
+
+Not all values for GL state can be copied. For example, pixel pack and
+unpack state, render mode state, and select and feedback state are not
+copied. The state that can be copied is exactly the state that is
+manipulated by the GL command @code{glPushAttrib}.
+
+An implicit @code{glFlush} is done by @code{glXCopyContext} if @var{src}
+is the current context for the calling thread.
+
+@heading Errors
+@code{BadMatch} is generated if rendering contexts @var{src} and
+@var{dst} do not share an address space or were not created with respect
+to the same screen.
+
+@code{BadAccess} is generated if @var{dst} is current to any thread
+(including the calling thread) at the time @code{glXCopyContext} is
+called.
+
+@code{GLXBadCurrentWindow} is generated if @var{src} is the current
+context and the current drawable is a window that is no longer valid.
+
+@code{GLXBadContext} is generated if either @var{src} or @var{dst} is
+not a valid GLX context.
+
+@end defun
+
+@defun glXCreateContext
+@heading create a new GLX rendering context
+@heading Parameters
+@table @asis
+@item @var{dpy}
+Specifies the connection to the X server.
+
+@item @var{vis}
+Specifies the visual that defines the frame buffer resources available
+to the rendering context. It is a pointer to an @code{XVisualInfo}
+structure, not a visual ID or a pointer to a @code{Visual}.
+
+@item @var{shareList}
+Specifies the context with which to share display lists. @code{NULL}
+indicates that no sharing is to take place.
+
+@item @var{direct}
+Specifies whether rendering is to be done with a direct connection to
+the graphics system if possible (@code{True}) or through the X server
+(@code{False}).
+
+@end table
+
+@heading Description
+@code{glXCreateContext} creates a GLX rendering context and returns its
+handle. This context can be used to render into both windows and GLX
+pixmaps. If @code{glXCreateContext} fails to create a rendering context,
+@code{NULL} is returned.
+
+If @var{direct} is @code{True}, then a direct rendering context is
+created if the implementation supports direct rendering, if the
+connection is to an X server that is local, and if a direct rendering
+context is available. (An implementation may return an indirect context
+when @var{direct} is @code{True}.) If @var{direct} is @code{False}, then
+a rendering context that renders through the X server is always created.
+Direct rendering provides a performance advantage in some
+implementations. However, direct rendering contexts cannot be shared
+outside a single process, and they may be unable to render to GLX
+pixmaps.
+
+If @var{shareList} is not @code{NULL}, then all display-list indexes and
+definitions are shared by context @var{shareList} and by the newly
+created context. An arbitrary number of contexts can share a single
+display-list space. However, all rendering contexts that share a single
+display-list space must themselves exist in the same address space. Two
+rendering contexts share an address space if both are nondirect using
+the same server, or if both are direct and owned by a single process.
+Note that in the nondirect case, it is not necessary for the calling
+threads to share an address space, only for their related rendering
+contexts to share an address space.
+
+If the GL version is 1.1 or greater, then all texture objects except
+object 0 are shared by any contexts that share display lists.
+
+@heading Errors
+@code{NULL} is returned if execution fails on the client side.
+
+@code{BadMatch} is generated if the context to be created would not
+share the address space or the screen of the context specified by
+@var{shareList}.
+
+@code{BadValue} is generated if @var{vis} is not a valid visual (for
+example, if a particular GLX implementation does not support it).
+
+@code{GLXBadContext} is generated if @var{shareList} is not a GLX
+context and is not @code{NULL}.
+
+@code{BadAlloc} is generated if the server does not have enough
+resources to allocate the new context.
+
+@end defun
+
+@defun glXCreateGLXPixmap
+@heading create an off-screen GLX rendering area
+@heading Parameters
+@table @asis
+@item @var{dpy}
+Specifies the connection to the X server.
+
+@item @var{vis}
+Specifies the visual that defines the structure of the rendering area.
+It is a pointer to an @code{XVisualInfo} structure, not a visual ID or a
+pointer to a @code{Visual}.
+
+@item @var{pixmap}
+Specifies the X pixmap that will be used as the front left color buffer
+of the off-screen rendering area.
+
+@end table
+
+@heading Description
+@code{glXCreateGLXPixmap} creates an off-screen rendering area and
+returns its XID. Any GLX rendering context that was created with respect
+to @var{vis} can be used to render into this off-screen area. Use
+@code{glXMakeCurrent} to associate the rendering area with a GLX
+rendering context.
+
+The X pixmap identified by @var{pixmap} is used as the front left buffer
+of the resulting off-screen rendering area. All other buffers specified
+by @var{vis}, including color buffers other than the front left buffer,
+are created without externally visible names. GLX pixmaps with
+double-buffering are supported. However, @code{glXSwapBuffers} is
+ignored by these pixmaps.
+
+Some implementations may not support GLX pixmaps with direct rendering
+contexts.
+
+@heading Errors
+@code{BadMatch} is generated if the depth of @var{pixmap} does not match
+the depth value reported by core X11 for @var{vis}, or if @var{pixmap}
+was not created with respect to the same screen as @var{vis}.
+
+@code{BadValue} is generated if @var{vis} is not a valid XVisualInfo
+pointer (for example, if a particular GLX implementation does not
+support this visual).
+
+@code{BadPixmap} is generated if @var{pixmap} is not a valid pixmap.
+
+@code{BadAlloc} is generated if the server cannot allocate the GLX
+pixmap.
+
+@end defun
+
+@defun glXCreateNewContext
+@heading create a new GLX rendering context
+@heading Parameters
+@table @asis
+@item @var{dpy}
+Specifies the connection to the X server.
+
+@item @var{config}
+Specifies the GLXFBConfig structure with the desired attributes for the
+context.
+
+@item @var{render_type}
+Specifies the type of the context to be created. Must be one of
+@code{GLX_RGBA_TYPE} or @code{GLX_COLOR_INDEX_TYPE}.
+
+@item @var{share_list}
+Specifies the context with which to share display lists. @code{NULL}
+indicates that no sharing is to take place.
+
+@item @var{share_list}
+Specifies whether rendering is to be done with a direct connection to
+the graphics system if possible (@code{True}) or through the X server
+(@code{False}).
+
+@end table
+
+@heading Description
+@code{glXCreateNewContext} creates a GLX rendering context and returns
+its handle. This context can be used to render into GLX windows,
+pixmaps, or pixel buffers. If @code{glXCreateNewContext} fails to create
+a rendering context, @code{NULL} is returned.
+
+If @var{render_type} is @code{GLX_RGBA_TYPE}, then a context that
+supports RGBA rendering is created. If @var{config} is
+@code{GLX_COLOR_INDEX_TYPE}, then context supporting color-index
+rendering is created.
+
+If @var{render_type} is not @code{NULL}, then all display-list indexes
+and definitions are shared by context @var{render_type} and by the newly
+created context. An arbitrary number of contexts can share a single
+display-list space. However, all rendering contexts that share a single
+display-list space must themselves exist in the same address space. Two
+rendering contexts share an address space if both are nondirect using
+the same server, or if both are direct and owned by a single process.
+Note that in the nondirect case, it is not necessary for the calling
+threads to share an address space, only for their related rendering
+contexts to share an address space.
+
+If @var{share_list} is @code{True}, then a direct-rendering context is
+created if the implementation supports direct rendering, if the
+connection is to an X server that is local, and if a direct-rendering
+context is available. (An implementation may return an indirect context
+when @var{share_list} is @code{True}.) If @var{share_list} is
+@code{False}, then a rendering context that renders through the X server
+is always created. Direct rendering provides a performance advantage in
+some implementations. However, direct-rendering contexts cannot be
+shared outside a single process, and they may be unable to render to GLX
+pixmaps.
+
+@heading Errors
+@code{NULL} is returned if execution fails on the client side.
+
+@code{GLXBadContext} is generated if @var{render_type} is not a GLX
+context and is not @code{NULL}.
+
+@code{GLXBadFBConfig} is generated if @var{config} is not a valid
+GLXFBConfig.
+
+@code{BadMatch} is generated if the context to be created would not
+share the address space or the screen of the context specified by
+@var{render_type}.
+
+@code{BadAlloc} is generated if the server does not have enough
+resources to allocate the new context.
+
+@code{BadValue} is generated if @var{config} is not a valid visual (for
+example, if a particular GLX implementation does not support it).
+
+@end defun
+
+@defun glXCreatePbuffer
+@heading create an off-screen rendering area
+@heading Parameters
+@table @asis
+@item @var{dpy}
+Specifies the connection to the X server.
+
+@item @var{config}
+Specifies a GLXFBConfig structure with the desired attributes for the
+window.
+
+@item @var{attrib_list}
+Specifies a list of attribute value pairs, which must be terminated with
+@code{None} or @code{NULL}. Accepted attributes are
+@code{GLX_PBUFFER_WIDTH}, @code{GLX_PBUFFER_HEIGHT},
+@code{GLX_PRESERVED_CONTENTS}, and @code{GLX_LARGEST_PBUFFER}.
+
+@end table
+
+@heading Description
+@code{glXCreatePbuffer} creates an off-screen rendering area and returns
+its XID. Any GLX rendering context that was created with respect to
+@var{config} can be used to render into this window. Use
+@code{glXMakeContextCurrent} to associate the rendering area with a GLX
+rendering context.
+
+The accepted attributes for a GLXPbuffer are:
+
+@table @asis
+@item @code{GLX_PBUFFER_WIDTH}
+Specify the pixel width of the requested GLXPbuffer. The default value
+is 0.
+
+@item @code{GLX_PBUFFER_HEIGHT}
+Specify the pixel height of the requested GLXPbuffer. The default value
+is 0.
+
+@item @code{GLX_LARGEST_PBUFFER}
+Specify to obtain the largest available pixel buffer, if the requested
+allocation would have failed. The width and height of the allocated
+pixel buffer will never exceed the specified @code{GLX_PBUFFER_WIDTH} or
+@code{GLX_PBUFFER_HEIGHT}, respectively. Use @code{glXQueryDrawable} to
+retrieve the dimensions of the allocated pixel buffer. The default value
+is @code{False}.
+
+@item @code{GLX_PRESERVED_CONTENTS}
+Specify if the contents of the pixel buffer should be preserved when a
+resource conflict occurs. If set to @code{False}, the contents of the
+pixel buffer may be lost at any time. If set to @code{True}, or not
+specified in @var{attrib_list}, then the contents of the pixel buffer
+will be preserved (most likely by copying the contents into main system
+memory from the frame buffer). In either case, the client can register
+(using @code{glXSelectEvent}, to receive pixel buffer clobber events
+that are generated when the pbuffer contents have been preserved or
+damaged.
+
+@end table
+
+GLXPbuffers contain the color and ancillary buffers specified by
+@var{config}. It is possible to create a pixel buffer with back buffers
+and to swap those buffers using @code{glXSwapBuffers}.
+
+@heading Errors
+@code{BadAlloc} is generated if there are insufficient resources to
+allocate the requested GLXPbuffer.
+
+@code{GLXBadFBConfig} is generated if @var{config} is not a valid
+GLXFBConfig.
+
+@code{BadMatch} is generated if @var{config} does not support rendering
+to pixel buffers (e.g., @code{GLX_DRAWABLE_TYPE} does not contain
+@code{GLX_PBUFFER_BIT}).
+
+@end defun
+
+@defun glXCreatePixmap
+@heading create an off-screen rendering area
+@heading Parameters
+@table @asis
+@item @var{dpy}
+Specifies the connection to the X server.
+
+@item @var{config}
+Specifies a GLXFBConfig structure with the desired attributes for the
+window.
+
+@item @var{pixmap}
+Specifies the X pixmap to be used as the rendering area.
+
+@item @var{attrib_list}
+Currently unused. This must be set to @code{NULL} or be an empty list
+(i.e., one in which the first element is @code{None}).
+
+@end table
+
+@heading Description
+@code{glXCreatePixmap} creates an off-screen rendering area and returns
+its XID. Any GLX rendering context that was created with respect to
+@var{config} can be used to render into this window. Use
+@code{glXMakeCurrent} to associate the rendering area with a GLX
+rendering context.
+
+@heading Errors
+@code{BadMatch} is generated if @var{pixmap} was not created with a
+visual that corresponds to @var{config}.
+
+@code{BadMatch} is generated if @var{config} does not support rendering
+to windows (e.g., @code{GLX_DRAWABLE_TYPE} does not contain
+@code{GLX_WINDOW_BIT}).
+
+@code{BadWindow} is generated if @var{pixmap} is not a valid window XID.
+@code{BadAlloc} is generated if there is already a GLXFBConfig
+associated with @var{pixmap}.
+
+@code{BadAlloc} is generated if the X server cannot allocate a new GLX
+window.
+
+@code{GLXBadFBConfig} is generated if @var{config} is not a valid
+GLXFBConfig.
+
+
+
+@end defun
+
+@defun glXCreateWindow
+@heading create an on-screen rendering area
+@heading Parameters
+@table @asis
+@item @var{dpy}
+Specifies the connection to the X server.
+
+@item @var{config}
+Specifies a GLXFBConfig structure with the desired attributes for the
+window.
+
+@item @var{win}
+Specifies the X window to be used as the rendering area.
+
+@item @var{attrib_list}
+Currently unused. This must be set to @code{NULL} or be an empty list
+(i.e., one in which the first element is @code{None}).
+
+@end table
+
+@heading Description
+@code{glXCreateWindow} creates an on-screen rendering area from an
+existing X window that was created with a visual matching @var{config}.
+The XID of the GLXWindow is returned. Any GLX rendering context that was
+created with respect to @var{config} can be used to render into this
+window. Use @code{glXMakeContextCurrent} to associate the rendering area
+with a GLX rendering context.
+
+@heading Errors
+@code{BadMatch} is generated if @var{win} was not created with a visual
+that corresponds to @var{config}.
+
+@code{BadMatch} is generated if @var{config} does not support rendering
+to windows (i.e., @code{GLX_DRAWABLE_TYPE} does not contain
+@code{GLX_WINDOW_BIT}).
+
+@code{BadWindow} is generated if @var{win} is not a valid pixmap XID.
+
+@code{BadAlloc} is generated if there is already a GLXFBConfig
+associated with @var{win}.
+
+@code{BadAlloc} is generated if the X server cannot allocate a new GLX
+window.
+
+@code{GLXBadFBConfig} is generated if @var{config} is not a valid
+GLXFBConfig.
+
+
+
+@end defun
+
+@defun glXDestroyContext
+@heading destroy a GLX context
+@heading Parameters
+@table @asis
+@item @var{dpy}
+Specifies the connection to the X server.
+
+@item @var{ctx}
+Specifies the GLX context to be destroyed.
+
+@end table
+
+@heading Description
+If the GLX rendering context @var{ctx} is not current to any thread,
+@code{glXDestroyContext} destroys it immediately. Otherwise, @var{ctx}
+is destroyed when it becomes not current to any thread. In either case,
+the resource ID referenced by @var{ctx} is freed immediately.
+
+@heading Errors
+@code{GLXBadContext} is generated if @var{ctx} is not a valid GLX
+context.
+
+@end defun
+
+@defun glXDestroyGLXPixmap
+@heading destroy a GLX pixmap
+@heading Parameters
+@table @asis
+@item @var{dpy}
+Specifies the connection to the X server.
+
+@item @var{pix}
+Specifies the GLX pixmap to be destroyed.
+
+@end table
+
+@heading Description
+If the GLX pixmap @var{pix} is not current to any client,
+@code{glXDestroyGLXPixmap} destroys it immediately. Otherwise, @var{pix}
+is destroyed when it becomes not current to any client. In either case,
+the resource ID is freed immediately.
+
+@heading Errors
+@code{GLXBadPixmap} is generated if @var{pix} is not a valid GLX pixmap.
+
+@end defun
+
+@defun glXDestroyPbuffer
+@heading destroy an off-screen rendering area
+@heading Parameters
+@table @asis
+@item @var{dpy}
+Specifies the connection to the X server.
+
+@item @var{pbuf}
+Specifies the GLXPbuffer to be destroyed.
+
+@end table
+
+@heading Description
+@code{glXDestroyPbuffer} destroys a GLXPbuffer created by
+@code{glXCreatePbuffer}.
+
+@heading Errors
+@code{GLXBadPbuffer} is generated if @var{pbuf} is not a valid
+GLXPbuffer.
+
+@end defun
+
+@defun glXDestroyPixmap
+@heading destroy an off-screen rendering area
+@heading Parameters
+@table @asis
+@item @var{dpy}
+Specifies the connection to the X server.
+
+@item @var{pixmap}
+Specifies the GLXPixmap to be destroyed.
+
+@end table
+
+@heading Description
+@code{glXDestroyPixmap} destroys a GLXPixmap created by
+@code{glXCreatePixmap}.
+
+@heading Errors
+@code{GLXBadPixmap} is generated if @var{pixmap} is not a valid
+GLXPixmap.
+
+@end defun
+
+@defun glXDestroyWindow
+@heading destroy an on-screen rendering area
+@heading Parameters
+@table @asis
+@item @var{dpy}
+Specifies the connection to the X server.
+
+@item @var{win}
+Specifies the GLXWindow to be destroyed.
+
+@end table
+
+@heading Description
+@code{glXDestroyWindow} destroys a GLXWindow created by
+@code{glXCreateWindow}.
+
+@heading Errors
+@code{GLXBadWindow} is generated if @var{win} is not a valid GLXPixmap.
+
+@end defun
+
+@defun glXFreeContextEXT
+@heading free client-side memory for imported context
+@heading Parameters
+@table @asis
+@item @var{dpy}
+Specifies the connection to the X server.
+
+@item @var{ctx}
+Specifies a GLX rendering context.
+
+@end table
+
+@heading Description
+@code{glXFreeContextEXT} frees the client-side part of a GLXContext that
+was created with @code{glXImportContextEXT}. @code{glXFreeContextEXT}
+does not free the server-side context information or the XID associated
+with the server-side context.
+
+@code{glXFreeContextEXT} is part of the @code{EXT_import_context}
+extension, not part of the core GLX command set. If
+_glxextstring(EXT_import_context) is included in the string returned by
+@code{glXQueryExtensionsString}, when called with argument
+@code{GLX_EXTENSIONS}, extension @code{EXT_vertex_array} is supported.
+
+@heading Errors
+@code{GLXBadContext} is generated if @var{ctx} does not refer to a valid
+context.
+
+@end defun
+
+@defun glXGetClientString
+@heading return a string describing the client
+@heading Parameters
+@table @asis
+@item @var{dpy}
+Specifies the connection to the X server.
+
+@item @var{name}
+Specifies which string is returned. The symbolic constants
+@code{GLX_VENDOR}, @code{GLX_VERSION}, and @code{GLX_EXTENSIONS} are
+accepted.
+
+@end table
+
+@heading Description
+@code{glXGetClientString} returns a string describing some aspect of the
+client library. The possible values for @var{name} are
+@code{GLX_VENDOR}, @code{GLX_VERSION}, and @code{GLX_EXTENSIONS}. If
+@var{name} is not set to one of these values, @code{glXGetClientString}
+returns @code{NULL}. The format and contents of the vendor string is
+implementation dependent.
+
+The extensions string is null-terminated and contains a space-separated
+list of extension names. (The extension names never contain spaces.) If
+there are no extensions to GLX, then the empty string is returned.
+
+The version string is laid out as follows:
+
+<major_version.minor_version><space><vendor-specific info>
+
+Both the major and minor portions of the version number are of arbitrary
+length. The vendor-specific information is optional. However, if it is
+present, the format and contents are implementation specific.
+
+@end defun
+
+@defun glXGetConfig
+@heading return information about GLX visuals
+@heading Parameters
+@table @asis
+@item @var{dpy}
+Specifies the connection to the X server.
+
+@item @var{vis}
+Specifies the visual to be queried. It is a pointer to an
+@code{XVisualInfo} structure, not a visual ID or a pointer to a
+@code{Visual}.
+
+@item @var{attrib}
+Specifies the visual attribute to be returned.
+
+@item @var{value}
+Returns the requested value.
+
+@end table
+
+@heading Description
+@code{glXGetConfig} sets @var{value} to the @var{attrib} value of
+windows or GLX pixmaps created with respect to @var{vis}.
+@code{glXGetConfig} returns an error code if it fails for any reason.
+Otherwise, zero is returned.
+
+@var{attrib} is one of the following:
+
+
+
+@table @asis
+@item @code{GLX_USE_GL}
+@code{True} if OpenGL rendering is supported by this visual,
+@code{False} otherwise.
+
+@item @code{GLX_BUFFER_SIZE}
+Number of bits per color buffer. For RGBA visuals,
+@code{GLX_BUFFER_SIZE} is the sum of @code{GLX_RED_SIZE},
+@code{GLX_GREEN_SIZE}, @code{GLX_BLUE_SIZE}, and @code{GLX_ALPHA_SIZE}.
+For color index visuals, @code{GLX_BUFFER_SIZE} is the size of the color
+indexes.
+
+@item @code{GLX_LEVEL}
+Frame buffer level of the visual. Level zero is the default frame
+buffer. Positive levels correspond to frame buffers that overlay the
+default buffer, and negative levels correspond to frame buffers that
+underlay the default buffer.
+
+@item @code{GLX_RGBA}
+@code{True} if color buffers store red, green, blue, and alpha values.
+@code{False} if they store color indexes.
+
+@item @code{GLX_DOUBLEBUFFER}
+@code{True} if color buffers exist in front/back pairs that can be
+swapped, @code{False} otherwise.
+
+@item @code{GLX_STEREO}
+@code{True} if color buffers exist in left/right pairs, @code{False}
+otherwise.
+
+@item @code{GLX_AUX_BUFFERS}
+Number of auxiliary color buffers that are available. Zero indicates
+that no auxiliary color buffers exist.
+
+@item @code{GLX_RED_SIZE}
+Number of bits of red stored in each color buffer. Undefined if
+@code{GLX_RGBA} is @code{False}.
+
+@item @code{GLX_GREEN_SIZE}
+Number of bits of green stored in each color buffer. Undefined if
+@code{GLX_RGBA} is @code{False}.
+
+@item @code{GLX_BLUE_SIZE}
+Number of bits of blue stored in each color buffer. Undefined if
+@code{GLX_RGBA} is @code{False}.
+
+@item @code{GLX_ALPHA_SIZE}
+Number of bits of alpha stored in each color buffer. Undefined if
+@code{GLX_RGBA} is @code{False}.
+
+@item @code{GLX_DEPTH_SIZE}
+Number of bits in the depth buffer.
+
+@item @code{GLX_STENCIL_SIZE}
+Number of bits in the stencil buffer.
+
+@item @code{GLX_ACCUM_RED_SIZE}
+Number of bits of red stored in the accumulation buffer.
+
+@item @code{GLX_ACCUM_GREEN_SIZE}
+Number of bits of green stored in the accumulation buffer.
+
+@item @code{GLX_ACCUM_BLUE_SIZE}
+Number of bits of blue stored in the accumulation buffer.
+
+@item @code{GLX_ACCUM_ALPHA_SIZE}
+Number of bits of alpha stored in the accumulation buffer.
+
+@end table
+
+The X protocol allows a single visual ID to be instantiated with
+different numbers of bits per pixel. Windows or GLX pixmaps that will be
+rendered with OpenGL, however, must be instantiated with a color buffer
+depth of @code{GLX_BUFFER_SIZE}.
+
+Although a GLX implementation can export many visuals that support GL
+rendering, it must support at least one RGBA visual. This visual must
+have at least one color buffer, a stencil buffer of at least 1 bit, a
+depth buffer of at least 12 bits, and an accumulation buffer. Alpha
+bitplanes are optional in this visual. However, its color buffer size
+must be as great as that of the deepest @code{TrueColor},
+@code{DirectColor}, @code{PseudoColor}, or @code{StaticColor} visual
+supported on level zero, and it must itself be made available on level
+zero.
+
+In addition, if the X server exports a @code{PseudoColor} or
+@code{StaticColor} visual on framebuffer level 0, a color index visual
+is also required on that level. It must have at least one color buffer,
+a stencil buffer of at least 1 bit, and a depth buffer of at least 12
+bits. This visual must have as many color bitplanes as the deepest
+@code{PseudoColor} or @code{StaticColor} visual supported on level 0.
+
+Applications are best written to select the visual that most closely
+meets their requirements. Creating windows or GLX pixmaps with
+unnecessary buffers can result in reduced rendering performance as well
+as poor resource allocation.
+
+@heading Errors
+@code{GLX_NO_EXTENSION} is returned if @var{dpy} does not support the
+GLX extension.
+
+@code{GLX_BAD_SCREEN} is returned if the screen of @var{vis} does not
+correspond to a screen.
+
+@code{GLX_BAD_ATTRIBUTE} is returned if @var{attrib} is not a valid GLX
+attribute.
+
+@code{GLX_BAD_VISUAL} is returned if @var{vis} doesn't support GLX and
+an attribute other than @code{GLX_USE_GL} is requested.
+
+@end defun
+
+@defun glXGetContextIDEXT
+@heading get the XID for a context.
+@heading Parameters
+@table @asis
+@item @var{ctx}
+Specifies a GLX rendering context.
+
+@end table
+
+@heading Description
+@code{glXGetContextIDEXT} returns the XID associated with a GLXContext.
+
+No round trip is forced to the server; unlike most X calls that return a
+value, @code{glXGetContextIDEXT} does not flush any pending events.
+
+@code{glXGetContextIDEXT} is part of the @code{EXT_import_context}
+extension, not part of the core GLX command set. If
+_glxextstring(EXT_import_context) is included in the string returned by
+@code{glXQueryExtensionsString}, when called with argument
+@code{GLX_EXTENSIONS}, extension @code{EXT_import_context} is supported.
+
+@heading Errors
+@code{GLXBadContext} is generated if @var{ctx} does not refer to a valid
+context.
+
+@end defun
+
+@defun glXGetCurrentContext
+@heading return the current context
+@heading Description
+@code{glXGetCurrentContext} returns the current context, as specified by
+@code{glXMakeCurrent}. If there is no current context, @code{NULL} is
+returned.
+
+@code{glXGetCurrentContext} returns client-side information. It does not
+make a round trip to the server.
+
+
+
+@end defun
+
+@defun glXGetCurrentDisplay
+@heading get display for current context
+@heading Description
+@code{glXGetCurrentDisplay} returns the display for the current context.
+If no context is current, @code{NULL} is returned.
+
+@code{glXGetCurrentDisplay} returns client-side information. It does not
+make a round-trip to the server, and therefore does not flush any
+pending events.
+
+@end defun
+
+@defun glXGetCurrentDrawable
+@heading return the current drawable
+@heading Description
+@code{glXGetCurrentDrawable} returns the current drawable, as specified
+by @code{glXMakeCurrent}. If there is no current drawable, @code{None}
+is returned.
+
+@code{glXGetCurrentDrawable} returns client-side information. It does
+not make a round trip to the server.
+
+@end defun
+
+@defun glXGetCurrentReadDrawable
+@heading return the current drawable
+@heading Description
+@code{glXGetCurrentReadDrawable} returns the current read drawable, as
+specified by @code{read} parameter of @code{glXMakeContextCurrent}. If
+there is no current drawable, @code{None} is returned.
+
+@code{glXGetCurrentReadDrawable} returns client-side information. It
+does not make a round-trip to the server.
+
+@end defun
+
+@defun glXGetFBConfigAttrib
+@heading return information about a GLX frame buffer configuration
+@heading Parameters
+@table @asis
+@item @var{dpy}
+Specifies the connection to the X server.
+
+@item @var{config}
+Specifies the GLX frame buffer configuration to be queried.
+
+@item @var{attribute}
+Specifies the attribute to be returned.
+
+@item @var{value}
+Returns the requested value.
+
+@end table
+
+@heading Description
+@code{glXGetFBConfigAttrib} sets @var{value} to the @var{attribute}
+value of GLX drawables created with respect to @var{config}.
+@code{glXGetFBConfigAttrib} returns an error code if it fails for any
+reason. Otherwise, @code{Success} is returned.
+
+@var{attribute} is one of the following:
+
+
+
+@table @asis
+@item @code{GLX_FBCONFIG_ID}
+XID of the given GLXFBConfig.
+
+@item @code{GLX_BUFFER_SIZE}
+
+
+Number of bits per color buffer. If the frame buffer configuration
+supports RGBA contexts, then @code{GLX_BUFFER_SIZE} is the sum of
+@code{GLX_RED_SIZE}, @code{GLX_GREEN_SIZE}, @code{GLX_BLUE_SIZE}, and
+@code{GLX_ALPHA_SIZE}. If the frame buffer configuration supports only
+color index contexts, @code{GLX_BUFFER_SIZE} is the size of the color
+indexes.
+
+@item @code{GLX_LEVEL}
+
+
+Frame buffer level of the configuration. Level zero is the default frame
+buffer. Positive levels correspond to frame buffers that overlay the
+default buffer, and negative levels correspond to frame buffers that
+underlie the default buffer.
+
+@item @code{GLX_DOUBLEBUFFER}
+
+
+@code{True} if color buffers exist in front/back pairs that can be
+swapped, @code{False} otherwise.
+
+@item @code{GLX_STEREO}
+
+
+@code{True} if color buffers exist in left/right pairs, @code{False}
+otherwise.
+
+@item @code{GLX_AUX_BUFFERS}
+
+
+Number of auxiliary color buffers that are available. Zero indicates
+that no auxiliary color buffers exist.
+
+@item @code{GLX_RED_SIZE}
+
+
+Number of bits of red stored in each color buffer. Undefined if RGBA
+contexts are not supported by the frame buffer configuration.
+
+@item @code{GLX_GREEN_SIZE}
+
+
+Number of bits of green stored in each color buffer. Undefined if RGBA
+contexts are not supported by the frame buffer configuration.
+
+@item @code{GLX_BLUE_SIZE}
+
+
+Number of bits of blue stored in each color buffer. Undefined if RGBA
+contexts are not supported by the frame buffer configuration.
+
+@item @code{GLX_ALPHA_SIZE}
+
+
+Number of bits of alpha stored in each color buffer. Undefined if RGBA
+contexts are not supported by the frame buffer configuration.
+
+@item @code{GLX_DEPTH_SIZE}
+
+
+Number of bits in the depth buffer.
+
+@item @code{GLX_STENCIL_SIZE}
+
+
+Number of bits in the stencil buffer.
+
+@item @code{GLX_ACCUM_RED_SIZE}
+
+
+Number of bits of red stored in the accumulation buffer.
+
+@item @code{GLX_ACCUM_GREEN_SIZE}
+
+
+Number of bits of green stored in the accumulation buffer.
+
+@item @code{GLX_ACCUM_BLUE_SIZE}
+
+
+Number of bits of blue stored in the accumulation buffer.
+
+@item @code{GLX_ACCUM_ALPHA_SIZE}
+
+
+Number of bits of alpha stored in the accumulation buffer.
+
+@item @code{GLX_RENDER_TYPE}
+
+
+Mask indicating what type of GLX contexts can be made current to the
+frame buffer configuration. Valid bits are @code{GLX_RGBA_BIT} and
+@code{GLX_COLOR_INDEX_BIT}.
+
+@item @code{GLX_DRAWABLE_TYPE}
+
+
+Mask indicating what drawable types the frame buffer configuration
+supports. Valid bits are @code{GLX_WINDOW_BIT}, @code{GLX_PIXMAP_BIT},
+and @code{GLX_PBUFFER_BIT}.
+
+@item @code{GLX_X_RENDERABLE}
+
+
+@code{True} if drawables created with the frame buffer configuration can
+be rendered to by X.
+
+@item @code{GLX_VISUAL_ID}
+
+
+XID of the corresponding visual, or zero if there is no associated
+visual (i.e., if @code{GLX_X_RENDERABLE} is @code{False} or
+@code{GLX_DRAWABLE_TYPE} does not have the @code{GLX_WINDOW_BIT} bit
+set).
+
+@item @code{GLX_X_VISUAL_TYPE}
+
+
+Visual type of associated visual. The returned value will be one of:
+@code{GLX_TRUE_COLOR}, @code{GLX_DIRECT_COLOR}, @code{GLX_PSEUDO_COLOR},
+@code{GLX_STATIC_COLOR}, @code{GLX_GRAY_SCALE}, @code{GLX_STATIC_GRAY},
+or @code{GLX_NONE}, if there is no associated visual (i.e., if
+@code{GLX_X_RENDERABLE} is @code{False} or @code{GLX_DRAWABLE_TYPE} does
+not have the @code{GLX_WINDOW_BIT} bit set).
+
+@item @code{GLX_CONFIG_CAVEAT}
+
+
+One of @code{GLX_NONE}, @code{GLX_SLOW_CONFIG}, or
+@code{GLX_NON_CONFORMANT_CONFIG}, indicating that the frame buffer
+configuration has no caveats, some aspect of the frame buffer
+configuration runs slower than other frame buffer configurations, or
+some aspect of the frame buffer configuration is nonconformant,
+respectively.
+
+@item @code{GLX_TRANSPARENT_TYPE}
+
+
+One of @code{GLX_NONE}, @code{GLX_TRANSPARENT_RGB},
+@code{GLX_TRANSPARENT_INDEX}, indicating that the frame buffer
+configuration is opaque, is transparent for particular values of red,
+green, and blue, or is transparent for particular index values,
+respectively.
+
+@item @code{GLX_TRANSPARENT_INDEX_VALUE}
+
+
+Integer value between 0 and the maximum frame buffer value for indices,
+indicating the transparent index value for the frame buffer
+configuration. Undefined if @code{GLX_TRANSPARENT_TYPE} is not
+@code{GLX_TRANSPARENT_INDEX}.
+
+@item @code{GLX_TRANSPARENT_RED_VALUE}
+
+
+Integer value between 0 and the maximum frame buffer value for red,
+indicating the transparent red value for the frame buffer configuration.
+Undefined if @code{GLX_TRANSPARENT_TYPE} is not
+@code{GLX_TRANSPARENT_RGB}.
+
+@item @code{GLX_TRANSPARENT_GREEN_VALUE}
+
+
+Integer value between 0 and the maximum frame buffer value for green,
+indicating the transparent green value for the frame buffer
+configuration. Undefined if @code{GLX_TRANSPARENT_TYPE} is not
+@code{GLX_TRANSPARENT_RGB}.
+
+@item @code{GLX_TRANSPARENT_BLUE_VALUE}
+
+
+Integer value between 0 and the maximum frame buffer value for blue,
+indicating the transparent blue value for the frame buffer
+configuration. Undefined if @code{GLX_TRANSPARENT_TYPE} is not
+@code{GLX_TRANSPARENT_RGB}.
+
+@item @code{GLX_TRANSPARENT_ALPHA_VALUE}
+
+
+Integer value between 0 and the maximum frame buffer value for alpha,
+indicating the transparent blue value for the frame buffer
+configuration. Undefined if @code{GLX_TRANSPARENT_TYPE} is not
+@code{GLX_TRANSPARENT_RGB}.
+
+@item @code{GLX_MAX_PBUFFER_WIDTH}
+
+
+The maximum width that can be specified to @code{glXCreatePbuffer}.
+
+@item @code{GLX_MAX_PBUFFER_HEIGHT}
+
+
+The maximum height that can be specified to @code{glXCreatePbuffer}.
+
+@item @code{GLX_MAX_PBUFFER_PIXELS}
+
+
+The maximum number of pixels (width times height) for a pixel buffer.
+Note that this value may be less than @code{GLX_MAX_PBUFFER_WIDTH} times
+@code{GLX_MAX_PBUFFER_HEIGHT}. Also, this value is static and assumes
+that no other pixel buffers or X resources are contending for the frame
+buffer memory. As a result, it may not be possible to allocate a pixel
+buffer of the size given by @code{GLX_MAX_PBUFFER_PIXELS}.
+
+@end table
+
+Applications should choose the frame buffer configuration that most
+closely meets their requirements. Creating windows, GLX pixmaps, or GLX
+pixel buffers with unnecessary buffers can result in reduced rendering
+performance as well as poor resource allocation.
+
+@heading Errors
+@code{GLX_NO_EXTENSION} is returned if @var{dpy} does not support the
+GLX extension. @code{GLX_BAD_ATTRIBUTE} is returned if @var{attribute}
+is not a valid GLX attribute.
+
+@end defun
+
+@defun glXGetFBConfigs
+@heading list all GLX frame buffer configurations for a given screen
+@heading Parameters
+@table @asis
+@item @var{dpy}
+Specifies the connection to the X server.
+
+@item @var{screen}
+Specifies the screen number.
+
+@item @var{nelements}
+Returns the number of GLXFBConfigs returned.
+
+@end table
+
+@heading Description
+@code{glXGetFBConfigs} returns a list of all GLXFBConfigs available on
+the screen specified by @var{screen}. Use @code{glXGetFBConfigAttrib} to
+obtain attribute values from a specific GLXFBConfig.
+
+@end defun
+
+@defun glXGetProcAddress
+@heading obtain a pointer to an OpenGL or GLX function
+@heading Parameters
+@table @asis
+@item @var{procName}
+Specifies the name of the OpenGL or GLX function whose address is to be
+returned.
+
+@end table
+
+@heading Description
+@code{glXGetProcAddress} returns the address of the function specified
+in @var{procName}. This is necessary in environments where the OpenGL
+link library exports a different set of functions than the runtime
+library.
+
+@end defun
+
+@defun glXGetSelectedEvent
+@heading returns GLX events that are selected for a window or a GLX pixel buffer
+@heading Parameters
+@table @asis
+@item @var{dpy}
+Specifies the connection to the X server.
+
+@item @var{draw}
+Specifies a GLX drawable. Must be a GLX pixel buffer or a window.
+
+@item @var{event_mask}
+Returns the events that are selected for @var{draw}.
+
+@end table
+
+@heading Description
+@code{glXGetSelectedEvent} returns in @var{event_mask} the events
+selected for @var{draw}.
+
+@heading Errors
+@code{GLXBadDrawable} is generated if @var{draw} is not a valid window
+or a valid GLX pixel buffer.
+
+@end defun
+
+@defun glXGetVisualFromFBConfig
+@heading return visual that is associated with the frame buffer configuration
+@heading Parameters
+@table @asis
+@item @var{dpy}
+Specifies the connection to the X server.
+
+@item @var{config}
+Specifies the GLX frame buffer configuration.
+
+@end table
+
+@heading Description
+If @var{config} is a valid GLX frame buffer configuration and it has an
+associated X Visual, then information describing that visual is
+returned; otherwise @code{NULL} is returned. Use @code{XFree} to free
+the data returned.
+
+@heading Errors
+Returns @code{NULL} if @var{config} is not a valid GLXFBConfig.
+
+@end defun
+
+@defun glXImportContextEXT
+@heading import another process's indirect rendering context.
+@heading Parameters
+@table @asis
+@item @var{dpy}
+Specifies the connection to the X server.
+
+@item @var{contextID}
+Specifies a GLX rendering context.
+
+@end table
+
+@heading Description
+@code{glXImportContextEXT} creates a GLXContext given the XID of an
+existing GLXContext. It may be used in place of @code{glXCreateContext},
+to share another process's indirect rendering context.
+
+Only the server-side context information can be shared between X
+clients; client-side state, such as pixel storage modes, cannot be
+shared. Thus, @code{glXImportContextEXT} must allocate memory to store
+client-side information. This memory is freed by calling
+@code{glXFreeContextEXT}.
+
+This call does not create a new XID. It merely makes an existing object
+available to the importing client (Display *). Like any XID, it goes
+away when the creating client drops its connection or the ID is
+explicitly deleted. Note that this is when the XID goes away. The object
+goes away when the XID goes away AND the context is not current to any
+thread.
+
+If @var{contextID} refers to a direct rendering context then no error is
+generated but @code{glXImportContextEXT} returns NULL.
+
+@code{glXImportContextEXT} is part of the @code{EXT_import_context}
+extension, not part of the core GLX command set. If
+_glxextstring(EXT_import_context) is included in the string returned by
+@code{glXQueryExtensionsString}, when called with argument
+@code{GLX_EXTENSIONS}, extension @code{EXT_import_context} is supported.
+
+@heading Errors
+@code{GLXBadContext} is generated if @var{contextID} does not refer to a
+valid context.
+
+@end defun
+
+@defun glXIntro
+@heading Introduction to OpenGL in the X window system
+@end defun
+
+@defun glXIsDirect
+@heading indicate whether direct rendering is enabled
+@heading Parameters
+@table @asis
+@item @var{dpy}
+Specifies the connection to the X server.
+
+@item @var{ctx}
+Specifies the GLX context that is being queried.
+
+@end table
+
+@heading Description
+@code{glXIsDirect} returns @code{True} if @var{ctx} is a direct
+rendering context, @code{False} otherwise. Direct rendering contexts
+pass rendering commands directly from the calling process's address
+space to the rendering system, bypassing the X server. Nondirect
+rendering contexts pass all rendering commands to the X server.
+
+@heading Errors
+@code{GLXBadContext} is generated if @var{ctx} is not a valid GLX
+context.
+
+@end defun
+
+@defun glXMakeContextCurrent
+@heading attach a GLX context to a GLX drawable
+@heading Parameters
+@table @asis
+@item @var{display}
+Specifies the connection to the X server.
+
+@item @var{draw}
+Specifies a GLX drawable to render into. Must be an XID representing a
+GLXWindow, GLXPixmap, or GLXPbuffer.
+
+@item @var{read}
+Specifies a GLX drawable to read from. Must be an XID representing a
+GLXWindow, GLXPixmap, or GLXPbuffer.
+
+@item @var{ctx}
+Specifies the GLX context to be bound to @var{read} and @var{ctx}.
+
+@end table
+
+@heading Description
+@code{glXMakeContextCurrent} binds @var{ctx} to the current rendering
+thread and to the @var{draw} and @var{read} GLX drawables. @var{draw}
+and @var{read} may be the same.
+
+@var{draw} is used for all OpenGL operations except:
+
+Any pixel data that are read based on the value of
+@code{GLX_READ_BUFFER}. Note that accumulation operations use the value
+of @code{GLX_READ_BUFFER}, but are not allowed unless @var{draw} is
+identical to @var{read}.
+
+Any depth values that are retrieved by @code{glReadPixels} or
+@code{glCopyPixels}.
+
+Any stencil values that are retrieved by @code{glReadPixels} or
+@code{glCopyPixels}.
+
+Frame buffer values are taken from @var{draw}.
+
+If the current rendering thread has a current rendering context, that
+context is flushed and replaced by @var{ctx}.
+
+The first time that @var{ctx} is made current, the viewport and scissor
+dimensions are set to the size of the @var{draw} drawable. The viewport
+and scissor are not modified when @var{ctx} is subsequently made
+current.
+
+To release the current context without assigning a new one, call
+@code{glXMakeContextCurrent} with @var{draw} and @var{read} set to
+@code{None} and @var{ctx} set to @code{NULL}.
+
+@code{glXMakeContextCurrent} returns @code{True} if it is successful,
+@code{False} otherwise. If @code{False} is returned, the previously
+current rendering context and drawable (if any) remain unchanged.
+
+@heading Errors
+@code{BadMatch} is generated if @var{draw} and @var{read} are not
+compatible.
+
+@code{BadAccess} is generated if @var{ctx} is current to some other
+thread.
+
+@code{GLXContextState} is generated if there is a current rendering
+context and its render mode is either @code{GLX_FEEDBACK} or
+@code{GLX_SELECT}.
+
+@code{GLXBadContext} is generated if @var{ctx} is not a valid GLX
+rendering context.
+
+@code{GLXBadDrawable} is generated if @var{draw} or @var{read} is not a
+valid GLX drawable.
+
+@code{GLXBadWindow} is generated if the underlying X window for either
+@var{draw} or @var{read} is no longer valid.
+
+@code{GLXBadCurrentDrawable} is generated if the previous context of the
+calling thread has unflushed commands and the previous drawable is no
+longer valid.
+
+@code{BadAlloc} is generated if the X server does not have enough
+resources to allocate the buffers.
+
+@code{BadMatch} is generated if:
+
+@var{draw} and @var{read} cannot fit into frame buffer memory
+simultaneously.
+
+@var{draw} or @var{read} is a GLXPixmap and @var{ctx} is a
+direct-rendering context.
+
+@var{draw} or @var{read} is a GLXPixmap and @var{ctx} was previously
+bound to a GLXWindow or GLXPbuffer.
+
+@var{draw} or @var{read} is a GLXWindow or GLXPbuffer and @var{ctx} was
+previously bound to a GLXPixmap.
+
+@end defun
+
+@defun glXMakeCurrent
+@heading attach a GLX context to a window or a GLX pixmap
+@heading Parameters
+@table @asis
+@item @var{dpy}
+Specifies the connection to the X server.
+
+@item @var{drawable}
+Specifies a GLX drawable. Must be either an X window ID or a GLX pixmap
+ID.
+
+@item @var{ctx}
+Specifies a GLX rendering context that is to be attached to
+@var{drawable}.
+
+@end table
+
+@heading Description
+@code{glXMakeCurrent} does two things: It makes @var{ctx} the current
+GLX rendering context of the calling thread, replacing the previously
+current context if there was one, and it attaches @var{ctx} to a GLX
+drawable, either a window or a GLX pixmap. As a result of these two
+actions, subsequent GL rendering calls use rendering context @var{ctx}
+to modify GLX drawable @var{drawable} (for reading and writing). Because
+@code{glXMakeCurrent} always replaces the current rendering context with
+@var{ctx}, there can be only one current context per thread.
+
+Pending commands to the previous context, if any, are flushed before it
+is released.
+
+The first time @var{ctx} is made current to any thread, its viewport is
+set to the full size of @var{drawable}. Subsequent calls by any thread
+to @code{glXMakeCurrent} with @var{ctx} have no effect on its viewport.
+
+To release the current context without assigning a new one, call
+@code{glXMakeCurrent} with @var{drawable} set to @code{None} and
+@var{ctx} set to @code{NULL}.
+
+@code{glXMakeCurrent} returns @code{True} if it is successful,
+@code{False} otherwise. If @code{False} is returned, the previously
+current rendering context and drawable (if any) remain unchanged.
+
+@heading Errors
+@code{BadMatch} is generated if @var{drawable} was not created with the
+same X screen and visual as @var{ctx}. It is also generated if
+@var{drawable} is @code{None} and @var{ctx} is not @code{NULL}.
+
+@code{BadAccess} is generated if @var{ctx} was current to another thread
+at the time @code{glXMakeCurrent} was called.
+
+@code{GLXBadDrawable} is generated if @var{drawable} is not a valid GLX
+drawable.
+
+@code{GLXBadContext} is generated if @var{ctx} is not a valid GLX
+context.
+
+@code{GLXBadContextState} is generated if @code{glXMakeCurrent} is
+executed between the execution of @code{glBegin} and the corresponding
+execution of @code{glEnd}.
+
+@code{GLXBadContextState} is also generated if the rendering context
+current to the calling thread has GL renderer state @code{GLX_FEEDBACK}
+or @code{GLX_SELECT}.
+
+@code{GLXBadCurrentWindow} is generated if there are pending GL commands
+for the previous context and the current drawable is a window that is no
+longer valid.
+
+@code{BadAlloc} may be generated if the server has delayed allocation of
+ancillary buffers until @code{glXMakeCurrent} is called, only to find
+that it has insufficient resources to complete the allocation.
+
+@end defun
+
+@defun glXQueryContextInfoEXT
+@heading query context information
+@heading Parameters
+@table @asis
+@item @var{dpy}
+Specifies the connection to the X server.
+
+@item @var{ctx}
+Specifies a GLX rendering context.
+
+@item @var{attribute}
+Specifies that a context parameter should be retrieved. Must be one of
+@code{GLX_SHARED_CONTEXT_EXT}, @code{GLX_VISUAL_ID_EXT}, or
+@code{GLX_SCREEN_EXT}.
+
+@item @var{value}
+Contains the return value for @var{attribute}.
+
+@end table
+
+@heading Description
+@code{glXQueryContextInfoEXT} sets @var{value} to the value of
+@var{attribute} with respect to @var{ctx}. @code{glXQueryContextInfoEXT}
+returns an error code if it fails for any reason. Otherwise,
+@code{Success} is returned.
+
+@var{attribute} may be one of the following:
+
+@table @asis
+@item @code{GLX_SHARED_CONTEXT_EXT}
+Returns the XID of the share list context associated with @var{ctx} at
+its creation.
+
+@item @code{GLX_VISUAL_ID_EXT}
+Returns the XID of the GLX Visual associated with @var{ctx}.
+
+@item @code{GLX_SCREEN_EXT}
+Returns the screen number associated with @var{ctx}.
+
+@end table
+
+This call may cause a round-trip to the server.
+
+@code{glXQueryContextInfoEXT} is part of the @code{EXT_import_context}
+extension, not part of the core GLX command set. If
+_glxextstring(EXT_import_context) is included in the string returned by
+@code{glXQueryExtensionsString}, when called with argument
+@code{GLX_EXTENSIONS}, extension @code{EXT_import_context} is supported.
+
+@heading Errors
+@code{GLXBadContext} is generated if @var{ctx} does not refer to a valid
+context.
+
+@code{GLX_BAD_ATTRIBUTE} is returned if @var{attribute} is not a valid
+GLX context attribute.
+
+fred @code{GLX_BAD_CONTEXT} is returned if @var{attribute} is not a
+valid context.
+
+@end defun
+
+@defun glXQueryContext
+@heading query context information
+@heading Parameters
+@table @asis
+@item @var{dpy}
+Specifies the connection to the X server.
+
+@item @var{ctx}
+Specifies a GLX rendering context.
+
+@item @var{attribute}
+Specifies that a context parameter should be retrieved. Must be one of
+@code{GLX_FBCONFIG_ID}, @code{GLX_RENDER_TYPE}, or @code{GLX_SCREEN}.
+
+@item @var{value}
+Contains the return value for @var{attribute}.
+
+@end table
+
+@heading Description
+@code{glXQueryContext} sets @var{value} to the value of @var{attribute}
+with respect to @var{ctx}. @var{attribute} may be one of the following:
+
+@table @asis
+@item @code{GLX_FBCONFIG_ID}
+Returns the XID of the GLXFBConfig associated with @var{ctx}.
+
+@item @code{GLX_RENDER_TYPE}
+Returns the rendering type supported by @var{ctx}.
+
+@item @code{GLX_SCREEN}
+Returns the screen number associated with @var{ctx}.
+
+@end table
+
+@code{Success} is returned unless @var{attribute} is not a valid GLX
+context attribute, in which case @code{GLX_BAD_ATTRIBUTE} is returned.
+
+This call may cause a round-trip to the server.
+
+@heading Errors
+@code{GLXBadContext} is generated if @var{ctx} does not refer to a valid
+context.
+
+@end defun
+
+@defun glXQueryDrawable
+@heading returns an attribute assoicated with a GLX drawable
+@heading Parameters
+@table @asis
+@item @var{dpy}
+Specifies the connection to the X server.
+
+@item @var{draw}
+Specifies the GLX drawable to be queried.
+
+@item @var{attribute}
+Specifies the attribute to be returned. Must be one of @code{GLX_WIDTH},
+@code{GLX_HEIGHT}, @code{GLX_PRESERVED_CONTENTS},
+@code{GLX_LARGEST_PBUFFER}, or @code{GLX_FBCONFIG_ID}.
+
+@item @var{value}
+Contains the return value for @var{attribute}.
+
+@end table
+
+@heading Description
+@code{glXQueryDrawable} sets @var{value} to the value of @var{attribute}
+with respect to the GLXDrawable @var{draw}.
+
+@var{attribute} may be one of the following:
+
+@table @asis
+@item @code{GLX_WIDTH}
+Returns the width of @var{ctx}.
+
+@item @code{GLX_HEIGHT}
+Returns the height of @var{ctx}.
+
+@item @code{GLX_PRESERVED_CONTENTS}
+Returns @code{True} if the contents of a GLXPbuffer are preserved when a
+resource conflict occurs; @code{False} otherwise.
+
+@item @code{GLX_LARGEST_PBUFFER}
+Returns the value set when @code{glXCreatePbuffer} was called to create
+the GLXPbuffer. If @code{False} is returned, then the call to
+@code{glXCreatePbuffer} will fail to create a GLXPbuffer if the
+requested size is larger than the implementation maximum or available
+resources. If @code{True} is returned, a GLXPbuffer of the maximum
+availble size (if less than the requested width and height) is created.
+
+@item @code{GLX_FBCONFIG_ID}
+Returns the XID for @var{draw}.
+
+@end table
+
+If @var{draw} is a GLXWindow or GLXPixmap and @var{attribute} is set to
+@code{GLX_PRESERVED_CONTENTS} or @code{GLX_LARGETST_PBUFFER}, the
+contents of @var{value} are undefined. If @var{attribute} is not one of
+the attributes listed above, the contents of @var{value} are unedfined.
+
+@heading Errors
+A @code{GLXBadDrawable} is generated if @var{draw} is not a valid
+GLXDrawable.
+
+@end defun
+
+@defun glXQueryExtensionsString
+@heading return list of supported extensions
+@heading Parameters
+@table @asis
+@item @var{dpy}
+Specifies the connection to the X server.
+
+@item @var{screen}
+Specifies the screen number.
+
+@end table
+
+@heading Description
+@code{glXQueryExtensionsString} returns a pointer to a string describing
+which GLX extensions are supported on the connection. The string is
+null-terminated and contains a space-separated list of extension names.
+(The extension names themselves never contain spaces.) If there are no
+extensions to GLX, then the empty string is returned.
+
+@end defun
+
+@defun glXQueryExtension
+@heading indicate whether the GLX extension is supported
+@heading Parameters
+@table @asis
+@item @var{dpy}
+Specifies the connection to the X server.
+
+@item @var{errorBase}
+Returns the base error code of the GLX server extension.
+
+@item @var{eventBase}
+Returns the base event code of the GLX server extension.
+
+@end table
+
+@heading Description
+@code{glXQueryExtension} returns @code{True} if the X server of
+connection @var{dpy} supports the GLX extension, @code{False} otherwise.
+If @code{True} is returned, then @var{errorBase} and @var{eventBase}
+return the error base and event base of the GLX extension. These values
+should be added to the constant error and event values to determine the
+actual event or error values. Otherwise, @var{errorBase} and
+@var{eventBase} are unchanged.
+
+@var{errorBase} and @var{eventBase} do not return values if they are
+specified as @code{NULL}.
+
+@end defun
+
+@defun glXQueryServerString
+@heading return string describing the server
+@heading Parameters
+@table @asis
+@item @var{dpy}
+Specifies the connection to the X server.
+
+@item @var{screen}
+Specifies the screen number.
+
+@item @var{name}
+Specifies which string is returned: one of @code{GLX_VENDOR},
+@code{GLX_VERSION}, or @code{GLX_EXTENSIONS}.
+
+@end table
+
+@heading Description
+@code{glXQueryServerString} returns a pointer to a static,
+null-terminated string describing some aspect of the server's GLX
+extension. The possible values for @var{name} and the format of the
+strings is the same as for @code{glXGetClientString}. If @var{name} is
+not set to a recognized value, @code{NULL} is returned.
+
+@end defun
+
+@defun glXQueryVersion
+@heading return the version numbers of the GLX extension
+@heading Parameters
+@table @asis
+@item @var{dpy}
+Specifies the connection to the X server.
+
+@item @var{major}
+Returns the major version number of the GLX server extension.
+
+@item @var{minor}
+Returns the minor version number of the GLX server extension.
+
+@end table
+
+@heading Description
+@code{glXQueryVersion} returns the major and minor version numbers of
+the GLX extension implemented by the server associated with connection
+@var{dpy}. Implementations with the same major version number are upward
+compatible, meaning that the implementation with the higher minor number
+is a superset of the version with the lower minor number.
+
+@var{major} and @var{minor} do not return values if they are specified
+as @code{NULL}.
+
+@heading Errors
+@code{glXQueryVersion} returns @code{False} if it fails, @code{True}
+otherwise.
+
+@var{major} and @var{minor} are not updated when @code{False} is
+returned.
+
+@end defun
+
+@defun glXSelectEvent
+@heading select GLX events for a window or a GLX pixel buffer
+@heading Parameters
+@table @asis
+@item @var{dpy}
+Specifies the connection to the X server.
+
+@item @var{draw}
+Specifies a GLX drawable. Must be a GLX pixel buffer or a window.
+
+@item @var{event_mask}
+Specifies the events to be returned for @var{draw}.
+
+@end table
+
+@heading Description
+@code{glXSelectEvent} sets the GLX event mask for a GLX pixel buffer or
+a window. Calling @code{glXSelectEvent} overrides any previous event
+mask that was set by the client for @var{draw}. Note that it does not
+affect the event masks that other clients may have specified for
+@var{draw} since each client rendering to @var{draw} has a separate
+event mask for it.
+
+Currently, only one GLX event, @code{GLX_PBUFFER_CLOBBER_MASK}, can be
+selected. The following data is returned to the client when a
+@code{GLX_PBUFFER_CLOBBER_MASK} event occurs:
+
+typedef struct @{
+
+@table @asis
+@item
+int @var{event_type};
+/* GLX_DAMAGED or GLX_SAVED */
+
+@item
+int @var{draw_type};
+/* GLX_WINDOW or GLX_PBUFFER */
+
+@item
+unsigned long @var{serial};
+/* # of last request processed by server */
+
+@item
+Bool @var{send_event};
+/* true if this came for SendEvent request */
+
+@item
+Display @var{*display};
+/* display the event was read from */
+
+@item
+GLXDrawable @var{drawable};
+/* i.d. of Drawable */
+
+@item
+unsigned int @var{buffer_mask};
+/* mask indicating affected buffers */
+
+@item
+int @var{x, y};
+
+
+@item
+int @var{width, height};
+
+
+@item
+int @var{count};
+/* if nonzero, at least this many more */
+
+@end table
+
+@} GLXPbufferClobberEvent; The valid bit masks used in @var{buffer_mask}
+are:
+
+
+
+@table @asis
+@item @strong{Bitmask}
+@strong{Corresponding Buffer}
+
+@item @code{GLX_FRONT_LEFT_BUFFER_BIT}
+Front left color buffer
+
+@item @code{GLX_FRONT_RIGHT_BUFFER_BIT}
+Front right color buffer
+
+@item @code{GLX_BACK_LEFT_BUFFER_BIT}
+Back left color buffer
+
+@item @code{GLX_BACK_RIGHT_BUFFER_BIT}
+Back right color buffer
+
+@item @code{GLX_AUX_BUFFERS_BIT}
+Auxiliary buffer
+
+@item @code{GLX_DEPTH_BUFFER_BIT}
+Depth buffer
+
+@item @code{GLX_STENCIL_BUFFER_BIT}
+Stencil buffer
+
+@item @code{GLX_ACCUM_BUFFER_BIT}
+Accumulation buffer
+
+@end table
+
+A single X server operation can cause several buffer clobber events to
+be sent. (e.g., a single GLX pixel buffer may be damaged and cause
+multiple buffer clobber events to be generated). Each event specifies
+one region of the GLX drawable that was affected by the X Server
+operation. The @var{buffer_mask} field indicates which color buffers and
+ancillary buffers were affected. All the buffer clobber events generated
+by a single X server action are guaranteed to be contiguous in the event
+queue. The conditions under which this event is generated and the
+@var{event_type} varies, depending on the type of the GLX drawable.
+
+When the @code{GLX_AUX_BUFFERS_BIT} is set in @var{buffer_mask}, then
+@var{aux_buffer} is set to indicate which buffer was affected. If more
+than one aux buffer was affected, then additional events are generated
+as part of the same contiguous event group. Each additional event will
+have only the @code{GLX_AUX_BUFFERS_BIT} set in @var{buffer_mask}, and
+the @var{aux_buffer} field will be set appropriately. For nonstereo
+drawables, @code{GLX_FRONT_LEFT_BUFFER_BIT} and
+@code{GLX_BACK_LEFT_BUFFER_BIT} are used to specify the front and back
+color buffers.
+
+For preserved GLX pixel buffers, a buffer clobber event with type
+@code{GLX_SAVED} is generated whenever the contents of the GLX pixel
+buffer is moved out of offscreen memory. The event(s) describes which
+portions of the GLX pixel buffer were affected. Clients who receive many
+buffer clobber events, referring to different save actions, should
+consider freeing the GLX pixel buffer resource in order to prevent the
+system from thrashing due to insufficient resources.
+
+For an unpreserved GLXPbuffer, a buffer clobber event, with type
+@code{GLX_DAMAGED}, is generated whenever a portion of the GLX pixel
+buffer becomes invalid. The client may wish to regenerate the invalid
+portions of the GLX pixel buffer.
+
+For Windows, buffer clobber events, with type @code{GLX_SAVED}, occur
+whenever an ancillary buffer, associated with the window, gets clobbered
+or moved out of off-screen memory. The event contains information
+indicating which color buffers and ancillary buffers\(emand which
+portions of those buffers\(emwere affected.
+
+@heading Errors
+@code{GLXBadDrawable} is generated if @var{draw} is not a valid window
+or a valid GLX pixel buffer.
+
+@end defun
+
+@defun glXSwapBuffers
+@heading exchange front and back buffers
+@heading Parameters
+@table @asis
+@item @var{dpy}
+Specifies the connection to the X server.
+
+@item @var{drawable}
+Specifies the drawable whose buffers are to be swapped.
+
+@end table
+
+@heading Description
+@code{glXSwapBuffers} promotes the contents of the back buffer of
+@var{drawable} to become the contents of the front buffer of
+@var{drawable}. The contents of the back buffer then become undefined.
+The update typically takes place during the vertical retrace of the
+monitor, rather than immediately after @code{glXSwapBuffers} is called.
+
+@code{glXSwapBuffers} performs an implicit @code{glFlush} before it
+returns. Subsequent OpenGL commands may be issued immediately after
+calling @code{glXSwapBuffers}, but are not executed until the buffer
+exchange is completed.
+
+If @var{drawable} was not created with respect to a double-buffered
+visual, @code{glXSwapBuffers} has no effect, and no error is generated.
+
+@heading Errors
+@code{GLXBadDrawable} is generated if @var{drawable} is not a valid GLX
+drawable.
+
+@code{GLXBadCurrentWindow} is generated if @var{dpy} and @var{drawable}
+are respectively the display and drawable associated with the current
+context of the calling thread, and @var{drawable} identifies a window
+that is no longer valid.
+
+@end defun
+
+@defun glXUseXFont
+@heading create bitmap display lists from an X font
+@heading Parameters
+@table @asis
+@item @var{font}
+Specifies the font from which character glyphs are to be taken.
+
+@item @var{first}
+Specifies the index of the first glyph to be taken.
+
+@item @var{count}
+Specifies the number of glyphs to be taken.
+
+@item @var{listBase}
+Specifies the index of the first display list to be generated.
+
+@end table
+
+@heading Description
+@code{glXUseXFont} generates @var{count} display lists, named
+@var{listBase} through @math{@var{listBase}+@var{count}-1}, each
+containing a single @code{glBitmap} command. The parameters of the
+@code{glBitmap} command of display list @math{@var{listBase}+@var{i}}
+are derived from glyph @math{@var{first}+@var{i}}. Bitmap parameters
+@math{@var{xorig}}, @math{@var{yorig}}, @math{@var{width}}, and
+@math{@var{height}} are computed from font metrics as
+@math{@var{descent}-1}, @math{-@var{lbearing}},
+@math{@var{rbearing}-@var{lbearing}}, and
+@math{@var{ascent}+@var{descent}}, respectively. @math{@var{xmove}} is
+taken from the glyph's @math{@var{width}} metric, and @math{@var{ymove}}
+is set to zero. Finally, the glyph's image is converted to the
+appropriate format for @code{glBitmap}.
+
+Using @code{glXUseXFont} may be more efficient than accessing the X font
+and generating the display lists explicitly, both because the display
+lists are created on the server without requiring a round trip of the
+glyph data, and because the server may choose to delay the creation of
+each bitmap until it is accessed.
+
+Empty display lists are created for all glyphs that are requested and
+are not defined in @var{font}. @code{glXUseXFont} is ignored if there is
+no current GLX context.
+
+@heading Errors
+@code{BadFont} is generated if @var{font} is not a valid font.
+
+@code{GLXBadContextState} is generated if the current GLX context is in
+display-list construction mode.
+
+@code{GLXBadCurrentWindow} is generated if the drawable associated with
+the current context of the calling thread is a window, and that window
+is no longer valid.
+
+@end defun
+
+@defun glXWaitGL
+@heading complete GL execution prior to subsequent X calls
+@heading Description
+GL rendering calls made prior to @code{glXWaitGL} are guaranteed to be
+executed before X rendering calls made after @code{glXWaitGL}. Although
+this same result can be achieved using @code{glFinish}, @code{glXWaitGL}
+does not require a round trip to the server, and it is therefore more
+efficient in cases where client and server are on separate machines.
+
+@code{glXWaitGL} is ignored if there is no current GLX context.
+
+@heading Errors
+@code{GLXBadCurrentWindow} is generated if the drawable associated with
+the current context of the calling thread is a window, and that window
+is no longer valid.
+
+@end defun
+
+@defun glXWaitX
+@heading complete X execution prior to subsequent GL calls
+@heading Description
+X rendering calls made prior to @code{glXWaitX} are guaranteed to be
+executed before GL rendering calls made after @code{glXWaitX}. Although
+the same result can be achieved using @code{XSync}, @code{glXWaitX} does
+not require a round trip to the server, and it is therefore more
+efficient in cases where client and server are on separate machines.
+
+@code{glXWaitX} is ignored if there is no current GLX context.
+
+@heading Errors
+@code{GLXBadCurrentWindow} is generated if the drawable associated with
+the current context of the calling thread is a window, and that window
+is no longer valid.
+
+@end defun
+
+
+@c %end of fragment
;;; Code:
(define-module (figl config)
- #:export (upstream-man-pages))
+ #:export (abs-top-srcdir
+ upstream-man-pages))
+
+(define (abs-top-srcdir)
+ "@abs_top_srcdir@")
(define (upstream-man-pages)
"@abs_top_srcdir@/upstream-man-pages")
+++ /dev/null
-(define-gl-procedure
- glAccum
- "glAccum"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glAccum"))
- (paramdef "GLenum " (parameter "op"))
- (paramdef "GLfloat " (parameter "value"))))
- "operate on the accumulation buffer
-==================================
-
-
-Parameters
-==========
-
-OP
- Specifies the accumulation buffer operation. Symbolic constants
- `GL_ACCUM', `GL_LOAD', `GL_ADD', `GL_MULT', and `GL_RETURN' are
- accepted.
-
-VALUE
- Specifies a floating-point value used in the accumulation buffer
- operation. OP determines how VALUE is used.
-
-
-Description
-===========
-
-The accumulation buffer is an extended-range color buffer. Images are
-not rendered into it. Rather, images rendered into one of the color
-buffers are added to the contents of the accumulation buffer after
-rendering. Effects such as antialiasing (of points, lines, and
-polygons), motion blur, and depth of field can be created by
-accumulating images generated with different transformation matrices.
-
-Each pixel in the accumulation buffer consists of red, green, blue, and
-alpha values. The number of bits per component in the accumulation
-buffer depends on the implementation. You can examine this number by
-calling `glGetIntegerv' four times, with arguments `GL_ACCUM_RED_BITS',
-`GL_ACCUM_GREEN_BITS', `GL_ACCUM_BLUE_BITS', and `GL_ACCUM_ALPHA_BITS'.
-Regardless of the number of bits per component, the range of values
-stored by each component is [-1,1]. The accumulation buffer pixels are
-mapped one-to-one with frame buffer pixels.
-
-`glAccum' operates on the accumulation buffer. The first argument, OP,
-is a symbolic constant that selects an accumulation buffer operation.
-The second argument, VALUE, is a floating-point value to be used in that
-operation. Five operations are specified: `GL_ACCUM', `GL_LOAD',
-`GL_ADD', `GL_MULT', and `GL_RETURN'.
-
-All accumulation buffer operations are limited to the area of the
-current scissor box and applied identically to the red, green, blue, and
-alpha components of each pixel. If a `glAccum' operation results in a
-value outside the range [-1,1], the contents of an accumulation buffer
-pixel component are undefined.
-
-The operations are as follows:
-
-`GL_ACCUM'
- Obtains R, G, B, and A values from the buffer currently selected
- for reading (see `glReadBuffer'). Each component value is divided
- by 2^N-1, where N is the number of bits allocated to each color
- component in the currently selected buffer. The result is a
- floating-point value in the range [0,1], which is multiplied by
- VALUE and added to the corresponding pixel component in the
- accumulation buffer, thereby updating the accumulation buffer.
-
-`GL_LOAD'
- Similar to `GL_ACCUM', except that the current value in the
- accumulation buffer is not used in the calculation of the new
- value. That is, the R, G, B, and A values from the currently
- selected buffer are divided by 2^N-1, multiplied by VALUE, and then
- stored in the corresponding accumulation buffer cell, overwriting
- the current value.
-
-`GL_ADD'
- Adds VALUE to each R, G, B, and A in the accumulation buffer.
-
-`GL_MULT'
- Multiplies each R, G, B, and A in the accumulation buffer by VALUE
- and returns the scaled component to its corresponding accumulation
- buffer location.
-
-`GL_RETURN'
- Transfers accumulation buffer values to the color buffer or buffers
- currently selected for writing. Each R, G, B, and A component is
- multiplied by VALUE, then multiplied by 2^N-1, clamped to the range
- [0,2^N-1], and stored in the corresponding display buffer cell. The
- only fragment operations that are applied to this transfer are
- pixel ownership, scissor, dithering, and color writemasks.
-
-To clear the accumulation buffer, call `glClearAccum' with R, G, B, and
-A values to set it to, then call `glClear' with the accumulation buffer
-enabled.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if OP is not an accepted value.
-
-`GL_INVALID_OPERATION' is generated if there is no accumulation buffer.
-
-`GL_INVALID_OPERATION' is generated if `glAccum' is executed between the
-execution of `glBegin' and the corresponding execution of `glEnd'.")
-
-(define-gl-procedure
- glActiveTexture
- "glActiveTexture"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glActiveTexture"))
- (paramdef "GLenum " (parameter "texture"))))
- "select active texture unit
-==========================
-
-
-Parameters
-==========
-
-TEXTURE
- Specifies which texture unit to make active. The number of texture
- units is implementation dependent, but must be at least two.
- TEXTURE must be one of `GL_TEXTURE'I, where i ranges from 0 to the
- larger of (`GL_MAX_TEXTURE_COORDS' - 1) and
- (`GL_MAX_COMBINED_TEXTURE_IMAGE_UNITS' - 1). The initial value is
- `GL_TEXTURE0'.
-
-
-Description
-===========
-
-`glActiveTexture' selects which texture unit subsequent texture state
-calls will affect. The number of texture units an implementation
-supports is implementation dependent, but must be at least 2.
-
-Vertex arrays are client-side GL resources, which are selected by the
-`glClientActiveTexture' routine.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if TEXTURE is not one of `GL_TEXTURE'I,
-where i ranges from 0 to the larger of (`GL_MAX_TEXTURE_COORDS' - 1) and
-(`GL_MAX_COMBINED_TEXTURE_IMAGE_UNITS' - 1).")
-
-(define-gl-procedure
- glAlphaFunc
- "glAlphaFunc"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glAlphaFunc"))
- (paramdef "GLenum " (parameter "func"))
- (paramdef "GLclampf " (parameter "ref"))))
- "specify the alpha test function
-===============================
-
-
-Parameters
-==========
-
-FUNC
- Specifies the alpha comparison function. Symbolic constants
- `GL_NEVER', `GL_LESS', `GL_EQUAL', `GL_LEQUAL', `GL_GREATER',
- `GL_NOTEQUAL', `GL_GEQUAL', and `GL_ALWAYS' are accepted. The
- initial value is `GL_ALWAYS'.
-
-REF
- Specifies the reference value that incoming alpha values are
- compared to. This value is clamped to the range [0,1], where 0
- represents the lowest possible alpha value and 1 the highest
- possible value. The initial reference value is 0.
-
-
-Description
-===========
-
-The alpha test discards fragments depending on the outcome of a
-comparison between an incoming fragment's alpha value and a constant
-reference value. `glAlphaFunc' specifies the reference value and the
-comparison function. The comparison is performed only if alpha testing
-is enabled. By default, it is not enabled. (See `glEnable' and
-`glDisable' of `GL_ALPHA_TEST'.)
-
-FUNC and REF specify the conditions under which the pixel is drawn. The
-incoming alpha value is compared to REF using the function specified by
-FUNC. If the value passes the comparison, the incoming fragment is drawn
-if it also passes subsequent stencil and depth buffer tests. If the
-value fails the comparison, no change is made to the frame buffer at
-that pixel location. The comparison functions are as follows:
-
-`GL_NEVER'
- Never passes.
-
-`GL_LESS'
- Passes if the incoming alpha value is less than the reference
- value.
-
-`GL_EQUAL'
- Passes if the incoming alpha value is equal to the reference value.
-
-`GL_LEQUAL'
- Passes if the incoming alpha value is less than or equal to the
- reference value.
-
-`GL_GREATER'
- Passes if the incoming alpha value is greater than the reference
- value.
-
-`GL_NOTEQUAL'
- Passes if the incoming alpha value is not equal to the reference
- value.
-
-`GL_GEQUAL'
- Passes if the incoming alpha value is greater than or equal to the
- reference value.
-
-`GL_ALWAYS'
- Always passes (initial value).
-
-`glAlphaFunc' operates on all pixel write operations, including those
-resulting from the scan conversion of points, lines, polygons, and
-bitmaps, and from pixel draw and copy operations. `glAlphaFunc' does not
-affect screen clear operations.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if FUNC is not an accepted value.
-
-`GL_INVALID_OPERATION' is generated if `glAlphaFunc' is executed between
-the execution of `glBegin' and the corresponding execution of `glEnd'.")
-
-(define-gl-procedure
- glAreTexturesResident
- "glAreTexturesResident"
- (funcsynopsis
- (funcprototype
- (funcdef
- "GLboolean "
- (function "glAreTexturesResident"))
- (paramdef "GLsizei " (parameter "n"))
- (paramdef
- "const GLuint * "
- (parameter "textures"))
- (paramdef
- "GLboolean * "
- (parameter "residences"))))
- "determine if textures are loaded in texture memory
-==================================================
-
-
-Parameters
-==========
-
-N
- Specifies the number of textures to be queried.
-
-TEXTURES
- Specifies an array containing the names of the textures to be
- queried.
-
-RESIDENCES
- Specifies an array in which the texture residence status is
- returned. The residence status of a texture named by an element of
- TEXTURES is returned in the corresponding element of RESIDENCES.
-
-
-Description
-===========
-
-GL establishes a ``working set'' of textures that are resident in
-texture memory. These textures can be bound to a texture target much
-more efficiently than textures that are not resident.
-
-`glAreTexturesResident' queries the texture residence status of the N
-textures named by the elements of TEXTURES. If all the named textures
-are resident, `glAreTexturesResident' returns `GL_TRUE', and the
-contents of RESIDENCES are undisturbed. If not all the named textures
-are resident, `glAreTexturesResident' returns `GL_FALSE', and detailed
-status is returned in the N elements of RESIDENCES. If an element of
-RESIDENCES is `GL_TRUE', then the texture named by the corresponding
-element of TEXTURES is resident.
-
-The residence status of a single bound texture may also be queried by
-calling `glGetTexParameter' with the TARGET argument set to the target
-to which the texture is bound, and the PNAME argument set to
-`GL_TEXTURE_RESIDENT'. This is the only way that the residence status of
-a default texture can be queried.
-
-
-Errors
-======
-
-`GL_INVALID_VALUE' is generated if N is negative.
-
-`GL_INVALID_VALUE' is generated if any element in TEXTURES is 0 or does
-not name a texture. In that case, the function returns `GL_FALSE' and
-the contents of RESIDENCES is indeterminate.
-
-`GL_INVALID_OPERATION' is generated if `glAreTexturesResident' is
-executed between the execution of `glBegin' and the corresponding
-execution of `glEnd'.")
-
-(define-gl-procedure
- glArrayElement
- "glArrayElement"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glArrayElement"))
- (paramdef "GLint " (parameter "i"))))
- "render a vertex using the specified vertex array element
-========================================================
-
-
-Parameters
-==========
-
-I
- Specifies an index into the enabled vertex data arrays.
-
-
-Description
-===========
-
-`glArrayElement' commands are used within `glBegin'/`glEnd' pairs to
-specify vertex and attribute data for point, line, and polygon
-primitives. If `GL_VERTEX_ARRAY' is enabled when `glArrayElement' is
-called, a single vertex is drawn, using vertex and attribute data taken
-from location I of the enabled arrays. If `GL_VERTEX_ARRAY' is not
-enabled, no drawing occurs but the attributes corresponding to the
-enabled arrays are modified.
-
-Use `glArrayElement' to construct primitives by indexing vertex data,
-rather than by streaming through arrays of data in first-to-last order.
-Because each call specifies only a single vertex, it is possible to
-explicitly specify per-primitive attributes such as a single normal for
-each triangle.
-
-Changes made to array data between the execution of `glBegin' and the
-corresponding execution of `glEnd' may affect calls to `glArrayElement'
-that are made within the same `glBegin'/`glEnd' period in nonsequential
-ways. That is, a call to `glArrayElement' that precedes a change to
-array data may access the changed data, and a call that follows a change
-to array data may access original data.
-
-
-Errors
-======
-
-`GL_INVALID_VALUE' may be generated if I is negative.
-
-`GL_INVALID_OPERATION' is generated if a non-zero buffer object name is
-bound to an enabled array and the buffer object's data store is
-currently mapped.")
-
-(define-gl-procedure
- glAttachShader
- "glAttachShader"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glAttachShader"))
- (paramdef "GLuint " (parameter "program"))
- (paramdef "GLuint " (parameter "shader"))))
- "Attaches a shader object to a program object
-============================================
-
-
-Parameters
-==========
-
-PROGRAM
- Specifies the program object to which a shader object will be
- attached.
-
-SHADER
- Specifies the shader object that is to be attached.
-
-
-Description
-===========
-
-In order to create an executable, there must be a way to specify the
-list of things that will be linked together. Program objects provide
-this mechanism. Shaders that are to be linked together in a program
-object must first be attached to that program object. `glAttachShader'
-attaches the shader object specified by SHADER to the program object
-specified by PROGRAM. This indicates that SHADER will be included in
-link operations that will be performed on PROGRAM.
-
-All operations that can be performed on a shader object are valid
-whether or not the shader object is attached to a program object. It is
-permissible to attach a shader object to a program object before source
-code has been loaded into the shader object or before the shader object
-has been compiled. It is permissible to attach multiple shader objects
-of the same type because each may contain a portion of the complete
-shader. It is also permissible to attach a shader object to more than
-one program object. If a shader object is deleted while it is attached
-to a program object, it will be flagged for deletion, and deletion will
-not occur until `glDetachShader' is called to detach it from all program
-objects to which it is attached.
-
-
-Errors
-======
-
-`GL_INVALID_VALUE' is generated if either PROGRAM or SHADER is not a
-value generated by OpenGL.
-
-`GL_INVALID_OPERATION' is generated if PROGRAM is not a program object.
-
-`GL_INVALID_OPERATION' is generated if SHADER is not a shader object.
-
-`GL_INVALID_OPERATION' is generated if SHADER is already attached to
-PROGRAM.
-
-`GL_INVALID_OPERATION' is generated if `glAttachShader' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glBeginQuery
- "glBeginQuery"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glBeginQuery"))
- (paramdef "GLenum " (parameter "target"))
- (paramdef "GLuint " (parameter "id"))))
- "delimit the boundaries of a query object
-========================================
-
-
-Parameters
-==========
-
-TARGET
- Specifies the target type of query object established between
- `glBeginQuery' and the subsequent `glEndQuery'. The symbolic
- constant must be `GL_SAMPLES_PASSED'.
-
-ID
- Specifies the name of a query object.
-
-
-Description
-===========
-
-`glBeginQuery' and `glEndQuery' delimit the boundaries of a query
-object. If a query object with name ID does not yet exist it is created.
-
-When `glBeginQuery' is executed, the query object's samples-passed
-counter is reset to 0. Subsequent rendering will increment the counter
-once for every sample that passes the depth test. When `glEndQuery' is
-executed, the samples-passed counter is assigned to the query object's
-result value. This value can be queried by calling `glGetQueryObject'
-with PNAME`GL_QUERY_RESULT'.
-
-Querying the `GL_QUERY_RESULT' implicitly flushes the GL pipeline until
-the rendering delimited by the query object has completed and the result
-is available. `GL_QUERY_RESULT_AVAILABLE' can be queried to determine if
-the result is immediately available or if the rendering is not yet
-complete.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if TARGET is not `GL_SAMPLES_PASSED'.
-
-`GL_INVALID_OPERATION' is generated if `glBeginQuery' is executed while
-a query object of the same TARGET is already active.
-
-`GL_INVALID_OPERATION' is generated if `glEndQuery' is executed when a
-query object of the same TARGET is not active.
-
-`GL_INVALID_OPERATION' is generated if ID is 0.
-
-`GL_INVALID_OPERATION' is generated if ID is the name of an already
-active query object.
-
-`GL_INVALID_OPERATION' is generated if `glBeginQuery' or `glEndQuery' is
-executed between the execution of `glBegin' and the corresponding
-execution of `glEnd'.")
-
-(define-gl-procedure
- glBegin
- "glBegin"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glBegin"))
- (paramdef "GLenum " (parameter "mode"))))
- "delimit the vertices of a primitive or a group of like primitives
-=================================================================
-
-
-Parameters
-==========
-
-MODE
- Specifies the primitive or primitives that will be created from
- vertices presented between `glBegin' and the subsequent `glEnd'.
- Ten symbolic constants are accepted: `GL_POINTS', `GL_LINES',
- `GL_LINE_STRIP', `GL_LINE_LOOP', `GL_TRIANGLES',
- `GL_TRIANGLE_STRIP', `GL_TRIANGLE_FAN', `GL_QUADS',
- `GL_QUAD_STRIP', and `GL_POLYGON'.
-
-
-Description
-===========
-
-`glBegin' and `glEnd' delimit the vertices that define a primitive or a
-group of like primitives. `glBegin' accepts a single argument that
-specifies in which of ten ways the vertices are interpreted. Taking N as
-an integer count starting at one, and N as the total number of vertices
-specified, the interpretations are as follows:
-
-`GL_POINTS'
- Treats each vertex as a single point. Vertex N defines point N. N
- points are drawn.
-
-`GL_LINES'
- Treats each pair of vertices as an independent line segment.
- Vertices 2\u2062N-1 and 2\u2062N define line N. N/2 lines are drawn.
-
-`GL_LINE_STRIP'
- Draws a connected group of line segments from the first vertex to
- the last. Vertices N and N+1 define line N. N-1 lines are drawn.
-
-`GL_LINE_LOOP'
- Draws a connected group of line segments from the first vertex to
- the last, then back to the first. Vertices N and N+1 define line N.
- The last line, however, is defined by vertices N and 1. N lines are
- drawn.
-
-`GL_TRIANGLES'
- Treats each triplet of vertices as an independent triangle.
- Vertices 3\u2062N-2, 3\u2062N-1, and 3\u2062N define triangle N. N/3 triangles are
- drawn.
-
-`GL_TRIANGLE_STRIP'
- Draws a connected group of triangles. One triangle is defined for
- each vertex presented after the first two vertices. For odd N,
- vertices N, N+1, and N+2 define triangle N. For even N, vertices
- N+1, N, and N+2 define triangle N. N-2 triangles are drawn.
-
-`GL_TRIANGLE_FAN'
- Draws a connected group of triangles. One triangle is defined for
- each vertex presented after the first two vertices. Vertices 1,
- N+1, and N+2 define triangle N. N-2 triangles are drawn.
-
-`GL_QUADS'
- Treats each group of four vertices as an independent quadrilateral.
- Vertices 4\u2062N-3, 4\u2062N-2, 4\u2062N-1, and 4\u2062N define quadrilateral N. N/4
- quadrilaterals are drawn.
-
-`GL_QUAD_STRIP'
- Draws a connected group of quadrilaterals. One quadrilateral is
- defined for each pair of vertices presented after the first pair.
- Vertices 2\u2062N-1, 2\u2062N, 2\u2062N+2, and 2\u2062N+1 define quadrilateral N. N/2-1
- quadrilaterals are drawn. Note that the order in which vertices are
- used to construct a quadrilateral from strip data is different from
- that used with independent data.
-
-`GL_POLYGON'
- Draws a single, convex polygon. Vertices 1 through N define this
- polygon.
-
-Only a subset of GL commands can be used between `glBegin' and `glEnd'.
-The commands are `glVertex', `glColor', `glSecondaryColor', `glIndex',
-`glNormal', `glFogCoord', `glTexCoord', `glMultiTexCoord',
-`glVertexAttrib', `glEvalCoord', `glEvalPoint', `glArrayElement',
-`glMaterial', and `glEdgeFlag'. Also, it is acceptable to use
-`glCallList' or `glCallLists' to execute display lists that include only
-the preceding commands. If any other GL command is executed between
-`glBegin' and `glEnd', the error flag is set and the command is ignored.
-
-Regardless of the value chosen for MODE, there is no limit to the number
-of vertices that can be defined between `glBegin' and `glEnd'. Lines,
-triangles, quadrilaterals, and polygons that are incompletely specified
-are not drawn. Incomplete specification results when either too few
-vertices are provided to specify even a single primitive or when an
-incorrect multiple of vertices is specified. The incomplete primitive is
-ignored; the rest are drawn.
-
-The minimum specification of vertices for each primitive is as follows:
-1 for a point, 2 for a line, 3 for a triangle, 4 for a quadrilateral,
-and 3 for a polygon. Modes that require a certain multiple of vertices
-are `GL_LINES' (2), `GL_TRIANGLES' (3), `GL_QUADS' (4), and
-`GL_QUAD_STRIP' (2).
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if MODE is set to an unaccepted value.
-
-`GL_INVALID_OPERATION' is generated if `glBegin' is executed between a
-`glBegin' and the corresponding execution of `glEnd'.
-
-`GL_INVALID_OPERATION' is generated if `glEnd' is executed without being
-preceded by a `glBegin'.
-
-`GL_INVALID_OPERATION' is generated if a command other than `glVertex',
-`glColor', `glSecondaryColor', `glIndex', `glNormal', `glFogCoord',
-`glTexCoord', `glMultiTexCoord', `glVertexAttrib', `glEvalCoord',
-`glEvalPoint', `glArrayElement', `glMaterial', `glEdgeFlag',
-`glCallList', or `glCallLists' is executed between the execution of
-`glBegin' and the corresponding execution `glEnd'.
-
-Execution of `glEnableClientState', `glDisableClientState',
-`glEdgeFlagPointer', `glFogCoordPointer', `glTexCoordPointer',
-`glColorPointer', `glSecondaryColorPointer', `glIndexPointer',
-`glNormalPointer', `glVertexPointer', `glVertexAttribPointer',
-`glInterleavedArrays', or `glPixelStore' is not allowed after a call to
-`glBegin' and before the corresponding call to `glEnd', but an error may
-or may not be generated.")
-
-(define-gl-procedure
- glBindAttribLocation
- "glBindAttribLocation"
- (funcsynopsis
- (funcprototype
- (funcdef
- "void "
- (function "glBindAttribLocation"))
- (paramdef "GLuint " (parameter "program"))
- (paramdef "GLuint " (parameter "index"))
- (paramdef "const GLchar *" (parameter "name"))))
- "Associates a generic vertex attribute index with a named attribute variable
-===========================================================================
-
-
-Parameters
-==========
-
-PROGRAM
- Specifies the handle of the program object in which the association
- is to be made.
-
-INDEX
- Specifies the index of the generic vertex attribute to be bound.
-
-NAME
- Specifies a null terminated string containing the name of the
- vertex shader attribute variable to which INDEX is to be bound.
-
-
-Description
-===========
-
-`glBindAttribLocation' is used to associate a user-defined attribute
-variable in the program object specified by PROGRAM with a generic
-vertex attribute index. The name of the user-defined attribute variable
-is passed as a null terminated string in NAME. The generic vertex
-attribute index to be bound to this variable is specified by INDEX. When
-PROGRAM is made part of current state, values provided via the generic
-vertex attribute INDEX will modify the value of the user-defined
-attribute variable specified by NAME.
-
-If NAME refers to a matrix attribute variable, INDEX refers to the first
-column of the matrix. Other matrix columns are then automatically bound
-to locations INDEX+1 for a matrix of type mat2; INDEX+1 and INDEX+2 for
-a matrix of type mat3; and INDEX+1, INDEX+2, and INDEX+3 for a matrix of
-type mat4.
-
-This command makes it possible for vertex shaders to use descriptive
-names for attribute variables rather than generic variables that are
-numbered from 0 to `GL_MAX_VERTEX_ATTRIBS' -1. The values sent to each
-generic attribute index are part of current state, just like standard
-vertex attributes such as color, normal, and vertex position. If a
-different program object is made current by calling `glUseProgram', the
-generic vertex attributes are tracked in such a way that the same values
-will be observed by attributes in the new program object that are also
-bound to INDEX.
-
-Attribute variable name-to-generic attribute index bindings for a
-program object can be explicitly assigned at any time by calling
-`glBindAttribLocation'. Attribute bindings do not go into effect until
-`glLinkProgram' is called. After a program object has been linked
-successfully, the index values for generic attributes remain fixed (and
-their values can be queried) until the next link command occurs.
-
-Applications are not allowed to bind any of the standard OpenGL vertex
-attributes using this command, as they are bound automatically when
-needed. Any attribute binding that occurs after the program object has
-been linked will not take effect until the next time the program object
-is linked.
-
-
-Errors
-======
-
-`GL_INVALID_VALUE' is generated if INDEX is greater than or equal to
-`GL_MAX_VERTEX_ATTRIBS'.
-
-`GL_INVALID_OPERATION' is generated if NAME starts with the reserved
-prefix \"gl_\".
-
-`GL_INVALID_VALUE' is generated if PROGRAM is not a value generated by
-OpenGL.
-
-`GL_INVALID_OPERATION' is generated if PROGRAM is not a program object.
-
-`GL_INVALID_OPERATION' is generated if `glBindAttribLocation' is
-executed between the execution of `glBegin' and the corresponding
-execution of `glEnd'.")
-
-(define-gl-procedure
- glBindBuffer
- "glBindBuffer"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glBindBuffer"))
- (paramdef "GLenum " (parameter "target"))
- (paramdef "GLuint " (parameter "buffer"))))
- "bind a named buffer object
-==========================
-
-
-Parameters
-==========
-
-TARGET
- Specifies the target to which the buffer object is bound. The
- symbolic constant must be `GL_ARRAY_BUFFER',
- `GL_ELEMENT_ARRAY_BUFFER', `GL_PIXEL_PACK_BUFFER', or
- `GL_PIXEL_UNPACK_BUFFER'.
-
-BUFFER
- Specifies the name of a buffer object.
-
-
-Description
-===========
-
-`glBindBuffer' lets you create or use a named buffer object. Calling
-`glBindBuffer' with TARGET set to `GL_ARRAY_BUFFER',
-`GL_ELEMENT_ARRAY_BUFFER', `GL_PIXEL_PACK_BUFFER' or
-`GL_PIXEL_UNPACK_BUFFER' and BUFFER set to the name of the new buffer
-object binds the buffer object name to the target. When a buffer object
-is bound to a target, the previous binding for that target is
-automatically broken.
-
-Buffer object names are unsigned integers. The value zero is reserved,
-but there is no default buffer object for each buffer object target.
-Instead, BUFFER set to zero effectively unbinds any buffer object
-previously bound, and restores client memory usage for that buffer
-object target. Buffer object names and the corresponding buffer object
-contents are local to the shared display-list space (see
-`glXCreateContext') of the current GL rendering context; two rendering
-contexts share buffer object names only if they also share display
-lists.
-
-You may use `glGenBuffers' to generate a set of new buffer object names.
-
-The state of a buffer object immediately after it is first bound is an
-unmapped zero-sized memory buffer with `GL_READ_WRITE' access and
-`GL_STATIC_DRAW' usage.
-
-While a non-zero buffer object name is bound, GL operations on the
-target to which it is bound affect the bound buffer object, and queries
-of the target to which it is bound return state from the bound buffer
-object. While buffer object name zero is bound, as in the initial state,
-attempts to modify or query state on the target to which it is bound
-generates an `GL_INVALID_OPERATION' error.
-
-When vertex array pointer state is changed, for example by a call to
-`glNormalPointer', the current buffer object binding
-(`GL_ARRAY_BUFFER_BINDING') is copied into the corresponding client
-state for the vertex array type being changed, for example
-`GL_NORMAL_ARRAY_BUFFER_BINDING'. While a non-zero buffer object is
-bound to the `GL_ARRAY_BUFFER' target, the vertex array pointer
-parameter that is traditionally interpreted as a pointer to client-side
-memory is instead interpreted as an offset within the buffer object
-measured in basic machine units.
-
-While a non-zero buffer object is bound to the `GL_ELEMENT_ARRAY_BUFFER'
-target, the indices parameter of `glDrawElements',
-`glDrawRangeElements', or `glMultiDrawElements' that is traditionally
-interpreted as a pointer to client-side memory is instead interpreted as
-an offset within the buffer object measured in basic machine units.
-
-While a non-zero buffer object is bound to the `GL_PIXEL_PACK_BUFFER'
-target, the following commands are affected: `glGetCompressedTexImage',
-`glGetConvolutionFilter', `glGetHistogram', `glGetMinmax',
-`glGetPixelMap', `glGetPolygonStipple', `glGetSeparableFilter',
-`glGetTexImage', and `glReadPixels'. The pointer parameter that is
-traditionally interpreted as a pointer to client-side memory where the
-pixels are to be packed is instead interpreted as an offset within the
-buffer object measured in basic machine units.
-
-While a non-zero buffer object is bound to the `GL_PIXEL_UNPACK_BUFFER'
-target, the following commands are affected: `glBitmap',
-`glColorSubTable', `glColorTable', `glCompressedTexImage1D',
-`glCompressedTexImage2D', `glCompressedTexImage3D',
-`glCompressedTexSubImage1D', `glCompressedTexSubImage2D',
-`glCompressedTexSubImage3D', `glConvolutionFilter1D',
-`glConvolutionFilter2D', `glDrawPixels', `glPixelMap',
-`glPolygonStipple', `glSeparableFilter2D', `glTexImage1D',
-`glTexImage2D', `glTexImage3D', `glTexSubImage1D', `glTexSubImage2D',
-and `glTexSubImage3D'. The pointer parameter that is traditionally
-interpreted as a pointer to client-side memory from which the pixels are
-to be unpacked is instead interpreted as an offset within the buffer
-object measured in basic machine units.
-
-A buffer object binding created with `glBindBuffer' remains active until
-a different buffer object name is bound to the same target, or until the
-bound buffer object is deleted with `glDeleteBuffers'.
-
-Once created, a named buffer object may be re-bound to any target as
-often as needed. However, the GL implementation may make choices about
-how to optimize the storage of a buffer object based on its initial
-binding target.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if TARGET is not one of the allowable
-values.
-
-`GL_INVALID_OPERATION' is generated if `glBindBuffer' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glBindTexture
- "glBindTexture"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glBindTexture"))
- (paramdef "GLenum " (parameter "target"))
- (paramdef "GLuint " (parameter "texture"))))
- "bind a named texture to a texturing target
-==========================================
-
-
-Parameters
-==========
-
-TARGET
- Specifies the target to which the texture is bound. Must be either
- `GL_TEXTURE_1D', `GL_TEXTURE_2D', `GL_TEXTURE_3D', or
- `GL_TEXTURE_CUBE_MAP'.
-
-TEXTURE
- Specifies the name of a texture.
-
-
-Description
-===========
-
-`glBindTexture' lets you create or use a named texture. Calling
-`glBindTexture' with TARGET set to `GL_TEXTURE_1D', `GL_TEXTURE_2D',
-`GL_TEXTURE_3D' or `GL_TEXTURE_CUBE_MAP' and TEXTURE set to the name of
-the new texture binds the texture name to the target. When a texture is
-bound to a target, the previous binding for that target is automatically
-broken.
-
-Texture names are unsigned integers. The value zero is reserved to
-represent the default texture for each texture target. Texture names and
-the corresponding texture contents are local to the shared display-list
-space (see `glXCreateContext') of the current GL rendering context; two
-rendering contexts share texture names only if they also share display
-lists.
-
-You may use `glGenTextures' to generate a set of new texture names.
-
-When a texture is first bound, it assumes the specified target: A
-texture first bound to `GL_TEXTURE_1D' becomes one-dimensional texture,
-a texture first bound to `GL_TEXTURE_2D' becomes two-dimensional
-texture, a texture first bound to `GL_TEXTURE_3D' becomes
-three-dimensional texture, and a texture first bound to
-`GL_TEXTURE_CUBE_MAP' becomes a cube-mapped texture. The state of a
-one-dimensional texture immediately after it is first bound is
-equivalent to the state of the default `GL_TEXTURE_1D' at GL
-initialization, and similarly for two- and three-dimensional textures
-and cube-mapped textures.
-
-While a texture is bound, GL operations on the target to which it is
-bound affect the bound texture, and queries of the target to which it is
-bound return state from the bound texture. If texture mapping is active
-on the target to which a texture is bound, the bound texture is used. In
-effect, the texture targets become aliases for the textures currently
-bound to them, and the texture name zero refers to the default textures
-that were bound to them at initialization.
-
-A texture binding created with `glBindTexture' remains active until a
-different texture is bound to the same target, or until the bound
-texture is deleted with `glDeleteTextures'.
-
-Once created, a named texture may be re-bound to its same original
-target as often as needed. It is usually much faster to use
-`glBindTexture' to bind an existing named texture to one of the texture
-targets than it is to reload the texture image using `glTexImage1D',
-`glTexImage2D', or `glTexImage3D'. For additional control over
-performance, use `glPrioritizeTextures'.
-
-`glBindTexture' is included in display lists.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if TARGET is not one of the allowable
-values.
-
-`GL_INVALID_OPERATION' is generated if TEXTURE was previously created
-with a target that doesn't match that of TARGET.
-
-`GL_INVALID_OPERATION' is generated if `glBindTexture' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glBitmap
- "glBitmap"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glBitmap"))
- (paramdef "GLsizei " (parameter "width"))
- (paramdef "GLsizei " (parameter "height"))
- (paramdef "GLfloat " (parameter "xorig"))
- (paramdef "GLfloat " (parameter "yorig"))
- (paramdef "GLfloat " (parameter "xmove"))
- (paramdef "GLfloat " (parameter "ymove"))
- (paramdef
- "const GLubyte * "
- (parameter "bitmap"))))
- "draw a bitmap
-=============
-
-
-Parameters
-==========
-
-WIDTH
- HEIGHT
-
- Specify the pixel width and height of the bitmap image.
-
-XORIG
- YORIG
-
- Specify the location of the origin in the bitmap image. The origin
- is measured from the lower left corner of the bitmap, with right
- and up being the positive axes.
-
-XMOVE
- YMOVE
-
- Specify the X and Y offsets to be added to the current raster
- position after the bitmap is drawn.
-
-BITMAP
- Specifies the address of the bitmap image.
-
-
-Description
-===========
-
-A bitmap is a binary image. When drawn, the bitmap is positioned
-relative to the current raster position, and frame buffer pixels
-corresponding to 1's in the bitmap are written using the current raster
-color or index. Frame buffer pixels corresponding to 0's in the bitmap
-are not modified.
-
-`glBitmap' takes seven arguments. The first pair specifies the width and
-height of the bitmap image. The second pair specifies the location of
-the bitmap origin relative to the lower left corner of the bitmap image.
-The third pair of arguments specifies X and Y offsets to be added to the
-current raster position after the bitmap has been drawn. The final
-argument is a pointer to the bitmap image itself.
-
-If a non-zero named buffer object is bound to the
-`GL_PIXEL_UNPACK_BUFFER' target (see `glBindBuffer') while a bitmap
-image is specified, BITMAP is treated as a byte offset into the buffer
-object's data store.
-
-The bitmap image is interpreted like image data for the `glDrawPixels'
-command, with WIDTH and HEIGHT corresponding to the width and height
-arguments of that command, and with TYPE set to `GL_BITMAP' and FORMAT
-set to `GL_COLOR_INDEX'. Modes specified using `glPixelStore' affect the
-interpretation of bitmap image data; modes specified using
-`glPixelTransfer' do not.
-
-If the current raster position is invalid, `glBitmap' is ignored.
-Otherwise, the lower left corner of the bitmap image is positioned at
-the window coordinates
-
-X_W=⌊X_R-X_O,⌋
-
-Y_W=⌊Y_R-Y_O,⌋
-
-where (X_R,Y_R) is the raster position and (X_O,Y_O) is the bitmap
-origin. Fragments are then generated for each pixel corresponding to a 1
-(one) in the bitmap image. These fragments are generated using the
-current raster Z coordinate, color or color index, and current raster
-texture coordinates. They are then treated just as if they had been
-generated by a point, line, or polygon, including texture mapping,
-fogging, and all per-fragment operations such as alpha and depth
-testing.
-
-After the bitmap has been drawn, the X and Y coordinates of the current
-raster position are offset by XMOVE and YMOVE. No change is made to the
-Z coordinate of the current raster position, or to the current raster
-color, texture coordinates, or index.
-
-
-Errors
-======
-
-`GL_INVALID_VALUE' is generated if WIDTH or HEIGHT is negative.
-
-`GL_INVALID_OPERATION' is generated if a non-zero buffer object name is
-bound to the `GL_PIXEL_UNPACK_BUFFER' target and the buffer object's
-data store is currently mapped.
-
-`GL_INVALID_OPERATION' is generated if a non-zero buffer object name is
-bound to the `GL_PIXEL_UNPACK_BUFFER' target and the data would be
-unpacked from the buffer object such that the memory reads required
-would exceed the data store size.
-
-`GL_INVALID_OPERATION' is generated if `glBitmap' is executed between
-the execution of `glBegin' and the corresponding execution of `glEnd'.")
-
-(define-gl-procedure
- glBlendColor
- "glBlendColor"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glBlendColor"))
- (paramdef "GLclampf " (parameter "red"))
- (paramdef "GLclampf " (parameter "green"))
- (paramdef "GLclampf " (parameter "blue"))
- (paramdef "GLclampf " (parameter "alpha"))))
- "set the blend color
-===================
-
-
-Parameters
-==========
-
-RED
- GREEN
-
- BLUE
-
- ALPHA
-
- specify the components of `GL_BLEND_COLOR'
-
-
-Description
-===========
-
-The `GL_BLEND_COLOR' may be used to calculate the source and destination
-blending factors. The color components are clamped to the range [0,1]
-before being stored. See `glBlendFunc' for a complete description of the
-blending operations. Initially the `GL_BLEND_COLOR' is set to (0, 0, 0,
-0).
-
-
-Errors
-======
-
-`GL_INVALID_OPERATION' is generated if `glBlendColor' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glBlendEquationSeparate
- "glBlendEquationSeparate"
- (funcsynopsis
- (funcprototype
- (funcdef
- "void "
- (function "glBlendEquationSeparate"))
- (paramdef "GLenum " (parameter "modeRGB"))
- (paramdef "GLenum " (parameter "modeAlpha"))))
- "set the RGB blend equation and the alpha blend equation separately
-==================================================================
-
-
-Parameters
-==========
-
-MODERGB
- specifies the RGB blend equation, how the red, green, and blue
- components of the source and destination colors are combined. It
- must be `GL_FUNC_ADD', `GL_FUNC_SUBTRACT',
- `GL_FUNC_REVERSE_SUBTRACT', `GL_MIN', `GL_MAX'.
-
-MODEALPHA
- specifies the alpha blend equation, how the alpha component of the
- source and destination colors are combined. It must be
- `GL_FUNC_ADD', `GL_FUNC_SUBTRACT', `GL_FUNC_REVERSE_SUBTRACT',
- `GL_MIN', `GL_MAX'.
-
-
-Description
-===========
-
-The blend equations determines how a new pixel (the ''source'' color) is
-combined with a pixel already in the framebuffer (the ''destination''
-color). This function specifies one blend equation for the RGB-color
-components and one blend equation for the alpha component.
-
-The blend equations use the source and destination blend factors
-specified by either `glBlendFunc' or `glBlendFuncSeparate'. See
-`glBlendFunc' or `glBlendFuncSeparate' for a description of the various
-blend factors.
-
-In the equations that follow, source and destination color components
-are referred to as (R_S,G_SB_SA_S) and (R_D,G_DB_DA_D), respectively.
-The result color is referred to as (R_R,G_RB_RA_R). The source and
-destination blend factors are denoted (S_R,S_GS_BS_A) and
-(D_R,D_GD_BD_A), respectively. For these equations all color components
-are understood to have values in the range [0,1]. * Mode * * RGB
-Components *, * Alpha Component *`GL_FUNC_ADD'
-RR=R_S\u2062S_R+R_D\u2062D_RGR=G_S\u2062S_G+G_D\u2062D_GBR=B_S\u2062S_B+B_D\u2062D_B,
-AR=A_S\u2062S_A+A_D\u2062D_A`GL_FUNC_SUBTRACT'
-RR=R_S\u2062S_R-R_D\u2062D_RGR=G_S\u2062S_G-G_D\u2062D_GBR=B_S\u2062S_B-B_D\u2062D_B,
-AR=A_S\u2062S_A-A_D\u2062D_A`GL_FUNC_REVERSE_SUBTRACT'
-RR=R_D\u2062D_R-R_S\u2062S_RGR=G_D\u2062D_G-G_S\u2062S_GBR=B_D\u2062D_B-B_S\u2062S_B,
-AR=A_D\u2062D_A-A_S\u2062S_A`GL_MIN'
-RR=MIN\u2061(R_S,R_D)GR=MIN\u2061(G_S,G_D)BR=MIN\u2061(B_S,B_D),
-AR=MIN\u2061(A_S,A_D)`GL_MAX'
-RR=MAX\u2061(R_S,R_D)GR=MAX\u2061(G_S,G_D)BR=MAX\u2061(B_S,B_D), AR=MAX\u2061(A_S,A_D)
-
-The results of these equations are clamped to the range [0,1].
-
-The `GL_MIN' and `GL_MAX' equations are useful for applications that
-analyze image data (image thresholding against a constant color, for
-example). The `GL_FUNC_ADD' equation is useful for antialiasing and
-transparency, among other things.
-
-Initially, both the RGB blend equation and the alpha blend equation are
-set to `GL_FUNC_ADD'.
-
-
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if either MODERGB or MODEALPHA is not one
-of `GL_FUNC_ADD', `GL_FUNC_SUBTRACT', `GL_FUNC_REVERSE_SUBTRACT',
-`GL_MAX', or `GL_MIN'.
-
-`GL_INVALID_OPERATION' is generated if `glBlendEquationSeparate' is
-executed between the execution of `glBegin' and the corresponding
-execution of `glEnd'.")
-
-(define-gl-procedure
- glBlendEquation
- "glBlendEquation"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glBlendEquation"))
- (paramdef "GLenum " (parameter "mode"))))
- "specify the equation used for both the RGB blend equation and the Alpha blend equation
-======================================================================================
-
-
-Parameters
-==========
-
-MODE
- specifies how source and destination colors are combined. It must
- be `GL_FUNC_ADD', `GL_FUNC_SUBTRACT', `GL_FUNC_REVERSE_SUBTRACT',
- `GL_MIN', `GL_MAX'.
-
-
-Description
-===========
-
-The blend equations determine how a new pixel (the ''source'' color) is
-combined with a pixel already in the framebuffer (the ''destination''
-color). This function sets both the RGB blend equation and the alpha
-blend equation to a single equation.
-
-These equations use the source and destination blend factors specified
-by either `glBlendFunc' or `glBlendFuncSeparate'. See `glBlendFunc' or
-`glBlendFuncSeparate' for a description of the various blend factors.
-
-In the equations that follow, source and destination color components
-are referred to as (R_S,G_SB_SA_S) and (R_D,G_DB_DA_D), respectively.
-The result color is referred to as (R_R,G_RB_RA_R). The source and
-destination blend factors are denoted (S_R,S_GS_BS_A) and
-(D_R,D_GD_BD_A), respectively. For these equations all color components
-are understood to have values in the range [0,1]. * Mode * * RGB
-Components *, * Alpha Component *`GL_FUNC_ADD'
-RR=R_S\u2062S_R+R_D\u2062D_RGR=G_S\u2062S_G+G_D\u2062D_GBR=B_S\u2062S_B+B_D\u2062D_B,
-AR=A_S\u2062S_A+A_D\u2062D_A`GL_FUNC_SUBTRACT'
-RR=R_S\u2062S_R-R_D\u2062D_RGR=G_S\u2062S_G-G_D\u2062D_GBR=B_S\u2062S_B-B_D\u2062D_B,
-AR=A_S\u2062S_A-A_D\u2062D_A`GL_FUNC_REVERSE_SUBTRACT'
-RR=R_D\u2062D_R-R_S\u2062S_RGR=G_D\u2062D_G-G_S\u2062S_GBR=B_D\u2062D_B-B_S\u2062S_B,
-AR=A_D\u2062D_A-A_S\u2062S_A`GL_MIN'
-RR=MIN\u2061(R_S,R_D)GR=MIN\u2061(G_S,G_D)BR=MIN\u2061(B_S,B_D),
-AR=MIN\u2061(A_S,A_D)`GL_MAX'
-RR=MAX\u2061(R_S,R_D)GR=MAX\u2061(G_S,G_D)BR=MAX\u2061(B_S,B_D), AR=MAX\u2061(A_S,A_D)
-
-The results of these equations are clamped to the range [0,1].
-
-The `GL_MIN' and `GL_MAX' equations are useful for applications that
-analyze image data (image thresholding against a constant color, for
-example). The `GL_FUNC_ADD' equation is useful for antialiasing and
-transparency, among other things.
-
-Initially, both the RGB blend equation and the alpha blend equation are
-set to `GL_FUNC_ADD'.
-
-
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if MODE is not one of `GL_FUNC_ADD',
-`GL_FUNC_SUBTRACT', `GL_FUNC_REVERSE_SUBTRACT', `GL_MAX', or `GL_MIN'.
-
-`GL_INVALID_OPERATION' is generated if `glBlendEquation' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glBlendFuncSeparate
- "glBlendFuncSeparate"
- (funcsynopsis
- (funcprototype
- (funcdef
- "void "
- (function "glBlendFuncSeparate"))
- (paramdef "GLenum " (parameter "srcRGB"))
- (paramdef "GLenum " (parameter "dstRGB"))
- (paramdef "GLenum " (parameter "srcAlpha"))
- (paramdef "GLenum " (parameter "dstAlpha"))))
- "specify pixel arithmetic for RGB and alpha components separately
-================================================================
-
-
-Parameters
-==========
-
-SRCRGB
- Specifies how the red, green, and blue blending factors are
- computed. The following symbolic constants are accepted: `GL_ZERO',
- `GL_ONE', `GL_SRC_COLOR', `GL_ONE_MINUS_SRC_COLOR', `GL_DST_COLOR',
- `GL_ONE_MINUS_DST_COLOR', `GL_SRC_ALPHA', `GL_ONE_MINUS_SRC_ALPHA',
- `GL_DST_ALPHA', `GL_ONE_MINUS_DST_ALPHA', `GL_CONSTANT_COLOR',
- `GL_ONE_MINUS_CONSTANT_COLOR', `GL_CONSTANT_ALPHA',
- `GL_ONE_MINUS_CONSTANT_ALPHA', and `GL_SRC_ALPHA_SATURATE'. The
- initial value is `GL_ONE'.
-
-DSTRGB
- Specifies how the red, green, and blue destination blending factors
- are computed. The following symbolic constants are accepted:
- `GL_ZERO', `GL_ONE', `GL_SRC_COLOR', `GL_ONE_MINUS_SRC_COLOR',
- `GL_DST_COLOR', `GL_ONE_MINUS_DST_COLOR', `GL_SRC_ALPHA',
- `GL_ONE_MINUS_SRC_ALPHA', `GL_DST_ALPHA', `GL_ONE_MINUS_DST_ALPHA'.
- `GL_CONSTANT_COLOR', `GL_ONE_MINUS_CONSTANT_COLOR',
- `GL_CONSTANT_ALPHA', and `GL_ONE_MINUS_CONSTANT_ALPHA'. The initial
- value is `GL_ZERO'.
-
-SRCALPHA
- Specified how the alpha source blending factor is computed. The
- same symbolic constants are accepted as for SRCRGB. The initial
- value is `GL_ONE'.
-
-DSTALPHA
- Specified how the alpha destination blending factor is computed.
- The same symbolic constants are accepted as for DSTRGB. The initial
- value is `GL_ZERO'.
-
-
-Description
-===========
-
-In RGBA mode, pixels can be drawn using a function that blends the
-incoming (source) RGBA values with the RGBA values that are already in
-the frame buffer (the destination values). Blending is initially
-disabled. Use `glEnable' and `glDisable' with argument `GL_BLEND' to
-enable and disable blending.
-
-`glBlendFuncSeparate' defines the operation of blending when it is
-enabled. SRCRGB specifies which method is used to scale the source
-RGB-color components. DSTRGB specifies which method is used to scale the
-destination RGB-color components. Likewise, SRCALPHA specifies which
-method is used to scale the source alpha color component, and DSTALPHA
-specifies which method is used to scale the destination alpha component.
-The possible methods are described in the following table. Each method
-defines four scale factors, one each for red, green, blue, and alpha.
-
-In the table and in subsequent equations, source and destination color
-components are referred to as (R_S,G_SB_SA_S) and (R_D,G_DB_DA_D). The
-color specified by `glBlendColor' is referred to as (R_C,G_CB_CA_C).
-They are understood to have integer values between 0 and
-(K_R,K_GK_BK_A), where
-
-K_C=2^M_C,-1
-
-and (M_R,M_GM_BM_A) is the number of red, green, blue, and alpha
-bitplanes.
-
-Source and destination scale factors are referred to as (S_R,S_GS_BS_A)
-and (D_R,D_GD_BD_A). All scale factors have range [0,1].
-
-
-
-* Parameter *
-*
-RGB Factor *, *
-Alpha Factor *`GL_ZERO'
-(0,00), 0`GL_ONE'
-(1,11), 1`GL_SRC_COLOR'
-(R_S/K_R,G_S/K_GB_S/K_B), A_S/K_A`GL_ONE_MINUS_SRC_COLOR'
-(1,111)-(R_S/K_R,G_S/K_GB_S/K_B), 1-A_S/K_A`GL_DST_COLOR'
-(R_D/K_R,G_D/K_GB_D/K_B), A_D/K_A`GL_ONE_MINUS_DST_COLOR'
-(1,11)-(R_D/K_R,G_D/K_GB_D/K_B), 1-A_D/K_A`GL_SRC_ALPHA'
-(A_S/K_A,A_S/K_AA_S/K_A), A_S/K_A`GL_ONE_MINUS_SRC_ALPHA'
-(1,11)-(A_S/K_A,A_S/K_AA_S/K_A), 1-A_S/K_A`GL_DST_ALPHA'
-(A_D/K_A,A_D/K_AA_D/K_A), A_D/K_A`GL_ONE_MINUS_DST_ALPHA'
-(1,11)-(A_D/K_A,A_D/K_AA_D/K_A), 1-A_D/K_A`GL_CONSTANT_COLOR'
-(R_C,G_CB_C), A_C`GL_ONE_MINUS_CONSTANT_COLOR'
-(1,11)-(R_C,G_CB_C), 1-A_C`GL_CONSTANT_ALPHA'
-(A_C,A_CA_C), A_C`GL_ONE_MINUS_CONSTANT_ALPHA'
-(1,11)-(A_C,A_CA_C), 1-A_C`GL_SRC_ALPHA_SATURATE'
-(I,II), 1In the table,
-
-I=MIN\u2061(A_S,1-A_D,)
-
-To determine the blended RGBA values of a pixel when drawing in RGBA
-mode, the system uses the following equations:
-
-R_D=MIN\u2061(K_R,R_S\u2062S_R+R_D\u2062D_R)G_D=MIN\u2061(K_G,G_S\u2062S_G+G_D\u2062D_G)B_D=MIN\u2061(K_B,B
-_S\u2062S_B+B_D\u2062D_B)A_D=MIN\u2061(K_A,A_S\u2062S_A+A_D\u2062D_A)
-
-Despite the apparent precision of the above equations, blending
-arithmetic is not exactly specified, because blending operates with
-imprecise integer color values. However, a blend factor that should be
-equal to 1 is guaranteed not to modify its multiplicand, and a blend
-factor equal to 0 reduces its multiplicand to 0. For example, when
-SRCRGB is `GL_SRC_ALPHA', DSTRGB is `GL_ONE_MINUS_SRC_ALPHA', and A_S is
-equal to K_A, the equations reduce to simple replacement:
-
-R_D=R_SG_D=G_SB_D=B_SA_D=A_S
-
-
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if either SRCRGB or DSTRGB is not an
-accepted value.
-
-`GL_INVALID_OPERATION' is generated if `glBlendFuncSeparate' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glBlendFunc
- "glBlendFunc"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glBlendFunc"))
- (paramdef "GLenum " (parameter "sfactor"))
- (paramdef "GLenum " (parameter "dfactor"))))
- "specify pixel arithmetic
-========================
-
-
-Parameters
-==========
-
-SFACTOR
- Specifies how the red, green, blue, and alpha source blending
- factors are computed. The following symbolic constants are
- accepted: `GL_ZERO', `GL_ONE', `GL_SRC_COLOR',
- `GL_ONE_MINUS_SRC_COLOR', `GL_DST_COLOR', `GL_ONE_MINUS_DST_COLOR',
- `GL_SRC_ALPHA', `GL_ONE_MINUS_SRC_ALPHA', `GL_DST_ALPHA',
- `GL_ONE_MINUS_DST_ALPHA', `GL_CONSTANT_COLOR',
- `GL_ONE_MINUS_CONSTANT_COLOR', `GL_CONSTANT_ALPHA',
- `GL_ONE_MINUS_CONSTANT_ALPHA', and `GL_SRC_ALPHA_SATURATE'. The
- initial value is `GL_ONE'.
-
-DFACTOR
- Specifies how the red, green, blue, and alpha destination blending
- factors are computed. The following symbolic constants are
- accepted: `GL_ZERO', `GL_ONE', `GL_SRC_COLOR',
- `GL_ONE_MINUS_SRC_COLOR', `GL_DST_COLOR', `GL_ONE_MINUS_DST_COLOR',
- `GL_SRC_ALPHA', `GL_ONE_MINUS_SRC_ALPHA', `GL_DST_ALPHA',
- `GL_ONE_MINUS_DST_ALPHA'. `GL_CONSTANT_COLOR',
- `GL_ONE_MINUS_CONSTANT_COLOR', `GL_CONSTANT_ALPHA', and
- `GL_ONE_MINUS_CONSTANT_ALPHA'. The initial value is `GL_ZERO'.
-
-
-Description
-===========
-
-In RGBA mode, pixels can be drawn using a function that blends the
-incoming (source) RGBA values with the RGBA values that are already in
-the frame buffer (the destination values). Blending is initially
-disabled. Use `glEnable' and `glDisable' with argument `GL_BLEND' to
-enable and disable blending.
-
-`glBlendFunc' defines the operation of blending when it is enabled.
-SFACTOR specifies which method is used to scale the source color
-components. DFACTOR specifies which method is used to scale the
-destination color components. The possible methods are described in the
-following table. Each method defines four scale factors, one each for
-red, green, blue, and alpha. In the table and in subsequent equations,
-source and destination color components are referred to as
-(R_S,G_SB_SA_S) and (R_D,G_DB_DA_D). The color specified by
-`glBlendColor' is referred to as (R_C,G_CB_CA_C). They are understood to
-have integer values between 0 and (K_R,K_GK_BK_A), where
-
-K_C=2^M_C,-1
-
-and (M_R,M_GM_BM_A) is the number of red, green, blue, and alpha
-bitplanes.
-
-Source and destination scale factors are referred to as (S_R,S_GS_BS_A)
-and (D_R,D_GD_BD_A). The scale factors described in the table, denoted
-(F_R,F_GF_BF_A), represent either source or destination factors. All
-scale factors have range [0,1].
-
-
-
-* Parameter *
-*(F_R,F_GF_BF_A)*`GL_ZERO'
-(0,000)`GL_ONE'
-(1,111)`GL_SRC_COLOR'
-(R_S/K_R,G_S/K_GB_S/K_BA_S/K_A)`GL_ONE_MINUS_SRC_COLOR'
-(1,111)-(R_S/K_R,G_S/K_GB_S/K_BA_S/K_A)`GL_DST_COLOR'
-(R_D/K_R,G_D/K_GB_D/K_BA_D/K_A)`GL_ONE_MINUS_DST_COLOR'
-(1,111)-(R_D/K_R,G_D/K_GB_D/K_BA_D/K_A)`GL_SRC_ALPHA'
-(A_S/K_A,A_S/K_AA_S/K_AA_S/K_A)`GL_ONE_MINUS_SRC_ALPHA'
-(1,111)-(A_S/K_A,A_S/K_AA_S/K_AA_S/K_A)`GL_DST_ALPHA'
-(A_D/K_A,A_D/K_AA_D/K_AA_D/K_A)`GL_ONE_MINUS_DST_ALPHA'
-(1,111)-(A_D/K_A,A_D/K_AA_D/K_AA_D/K_A)`GL_CONSTANT_COLOR'
-(R_C,G_CB_CA_C)`GL_ONE_MINUS_CONSTANT_COLOR'
-(1,111)-(R_C,G_CB_CA_C)`GL_CONSTANT_ALPHA'
-(A_C,A_CA_CA_C)`GL_ONE_MINUS_CONSTANT_ALPHA'
-(1,111)-(A_C,A_CA_CA_C)`GL_SRC_ALPHA_SATURATE'
-(I,II1)In the table,
-
-I=MIN\u2061(A_S,K_A-A_D)/K_A
-
-To determine the blended RGBA values of a pixel when drawing in RGBA
-mode, the system uses the following equations:
-
-R_D=MIN\u2061(K_R,R_S\u2062S_R+R_D\u2062D_R)G_D=MIN\u2061(K_G,G_S\u2062S_G+G_D\u2062D_G)B_D=MIN\u2061(K_B,B
-_S\u2062S_B+B_D\u2062D_B)A_D=MIN\u2061(K_A,A_S\u2062S_A+A_D\u2062D_A)
-
-Despite the apparent precision of the above equations, blending
-arithmetic is not exactly specified, because blending operates with
-imprecise integer color values. However, a blend factor that should be
-equal to 1 is guaranteed not to modify its multiplicand, and a blend
-factor equal to 0 reduces its multiplicand to 0. For example, when
-SFACTOR is `GL_SRC_ALPHA', DFACTOR is `GL_ONE_MINUS_SRC_ALPHA', and A_S
-is equal to K_A, the equations reduce to simple replacement:
-
-R_D=R_SG_D=G_SB_D=B_SA_D=A_S
-
-
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if either SFACTOR or DFACTOR is not an
-accepted value.
-
-`GL_INVALID_OPERATION' is generated if `glBlendFunc' is executed between
-the execution of `glBegin' and the corresponding execution of `glEnd'.")
-
-(define-gl-procedure
- glBufferData
- "glBufferData"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glBufferData"))
- (paramdef "GLenum " (parameter "target"))
- (paramdef "GLsizeiptr " (parameter "size"))
- (paramdef "const GLvoid * " (parameter "data"))
- (paramdef "GLenum " (parameter "usage"))))
- "creates and initializes a buffer object's data store
-====================================================
-
-
-Parameters
-==========
-
-TARGET
- Specifies the target buffer object. The symbolic constant must be
- `GL_ARRAY_BUFFER', `GL_ELEMENT_ARRAY_BUFFER',
- `GL_PIXEL_PACK_BUFFER', or `GL_PIXEL_UNPACK_BUFFER'.
-
-SIZE
- Specifies the size in bytes of the buffer object's new data store.
-
-DATA
- Specifies a pointer to data that will be copied into the data store
- for initialization, or `NULL' if no data is to be copied.
-
-USAGE
- Specifies the expected usage pattern of the data store. The
- symbolic constant must be `GL_STREAM_DRAW', `GL_STREAM_READ',
- `GL_STREAM_COPY', `GL_STATIC_DRAW', `GL_STATIC_READ',
- `GL_STATIC_COPY', `GL_DYNAMIC_DRAW', `GL_DYNAMIC_READ', or
- `GL_DYNAMIC_COPY'.
-
-
-Description
-===========
-
-`glBufferData' creates a new data store for the buffer object currently
-bound to TARGET. Any pre-existing data store is deleted. The new data
-store is created with the specified SIZE in bytes and USAGE. If DATA is
-not `NULL', the data store is initialized with data from this pointer.
-In its initial state, the new data store is not mapped, it has a `NULL'
-mapped pointer, and its mapped access is `GL_READ_WRITE'.
-
-USAGE is a hint to the GL implementation as to how a buffer object's
-data store will be accessed. This enables the GL implementation to make
-more intelligent decisions that may significantly impact buffer object
-performance. It does not, however, constrain the actual usage of the
-data store. USAGE can be broken down into two parts: first, the
-frequency of access (modification and usage), and second, the nature of
-that access. The frequency of access may be one of these:
-
-STREAM
- The data store contents will be modified once and used at most a
- few times.
-
-STATIC
- The data store contents will be modified once and used many times.
-
-DYNAMIC
- The data store contents will be modified repeatedly and used many
- times.
-
-The nature of access may be one of these:
-
-DRAW
- The data store contents are modified by the application, and used
- as the source for GL drawing and image specification commands.
-
-READ
- The data store contents are modified by reading data from the GL,
- and used to return that data when queried by the application.
-
-COPY
- The data store contents are modified by reading data from the GL,
- and used as the source for GL drawing and image specification
- commands.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if TARGET is not `GL_ARRAY_BUFFER',
-`GL_ELEMENT_ARRAY_BUFFER', `GL_PIXEL_PACK_BUFFER', or
-`GL_PIXEL_UNPACK_BUFFER'.
-
-`GL_INVALID_ENUM' is generated if USAGE is not `GL_STREAM_DRAW',
-`GL_STREAM_READ', `GL_STREAM_COPY', `GL_STATIC_DRAW', `GL_STATIC_READ',
-`GL_STATIC_COPY', `GL_DYNAMIC_DRAW', `GL_DYNAMIC_READ', or
-`GL_DYNAMIC_COPY'.
-
-`GL_INVALID_VALUE' is generated if SIZE is negative.
-
-`GL_INVALID_OPERATION' is generated if the reserved buffer object name 0
-is bound to TARGET.
-
-`GL_OUT_OF_MEMORY' is generated if the GL is unable to create a data
-store with the specified SIZE.
-
-`GL_INVALID_OPERATION' is generated if `glBufferData' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glBufferSubData
- "glBufferSubData"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glBufferSubData"))
- (paramdef "GLenum " (parameter "target"))
- (paramdef "GLintptr " (parameter "offset"))
- (paramdef "GLsizeiptr " (parameter "size"))
- (paramdef "const GLvoid * " (parameter "data"))))
- "updates a subset of a buffer object's data store
-================================================
-
-
-Parameters
-==========
-
-TARGET
- Specifies the target buffer object. The symbolic constant must be
- `GL_ARRAY_BUFFER', `GL_ELEMENT_ARRAY_BUFFER',
- `GL_PIXEL_PACK_BUFFER', or `GL_PIXEL_UNPACK_BUFFER'.
-
-OFFSET
- Specifies the offset into the buffer object's data store where data
- replacement will begin, measured in bytes.
-
-SIZE
- Specifies the size in bytes of the data store region being
- replaced.
-
-DATA
- Specifies a pointer to the new data that will be copied into the
- data store.
-
-
-Description
-===========
-
-`glBufferSubData' redefines some or all of the data store for the buffer
-object currently bound to TARGET. Data starting at byte offset OFFSET
-and extending for SIZE bytes is copied to the data store from the memory
-pointed to by DATA. An error is thrown if OFFSET and SIZE together
-define a range beyond the bounds of the buffer object's data store.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if TARGET is not `GL_ARRAY_BUFFER',
-`GL_ELEMENT_ARRAY_BUFFER', `GL_PIXEL_PACK_BUFFER', or
-`GL_PIXEL_UNPACK_BUFFER'.
-
-`GL_INVALID_VALUE' is generated if OFFSET or SIZE is negative, or if
-together they define a region of memory that extends beyond the buffer
-object's allocated data store.
-
-`GL_INVALID_OPERATION' is generated if the reserved buffer object name 0
-is bound to TARGET.
-
-`GL_INVALID_OPERATION' is generated if the buffer object being updated
-is mapped.
-
-`GL_INVALID_OPERATION' is generated if `glBufferSubData' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glCallLists
- "glCallLists"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glCallLists"))
- (paramdef "GLsizei " (parameter "n"))
- (paramdef "GLenum " (parameter "type"))
- (paramdef "const GLvoid * " (parameter "lists"))))
- "execute a list of display lists
-===============================
-
-
-Parameters
-==========
-
-N
- Specifies the number of display lists to be executed.
-
-TYPE
- Specifies the type of values in LISTS. Symbolic constants
- `GL_BYTE', `GL_UNSIGNED_BYTE', `GL_SHORT', `GL_UNSIGNED_SHORT',
- `GL_INT', `GL_UNSIGNED_INT', `GL_FLOAT', `GL_2_BYTES',
- `GL_3_BYTES', and `GL_4_BYTES' are accepted.
-
-LISTS
- Specifies the address of an array of name offsets in the display
- list. The pointer type is void because the offsets can be bytes,
- shorts, ints, or floats, depending on the value of TYPE.
-
-
-Description
-===========
-
-`glCallLists' causes each display list in the list of names passed as
-LISTS to be executed. As a result, the commands saved in each display
-list are executed in order, just as if they were called without using a
-display list. Names of display lists that have not been defined are
-ignored.
-
-`glCallLists' provides an efficient means for executing more than one
-display list. TYPE allows lists with various name formats to be
-accepted. The formats are as follows:
-
-`GL_BYTE'
- LISTS is treated as an array of signed bytes, each in the range
- -128 through 127.
-
-`GL_UNSIGNED_BYTE'
- LISTS is treated as an array of unsigned bytes, each in the range 0
- through 255.
-
-`GL_SHORT'
- LISTS is treated as an array of signed two-byte integers, each in
- the range -32768 through 32767.
-
-`GL_UNSIGNED_SHORT'
- LISTS is treated as an array of unsigned two-byte integers, each in
- the range 0 through 65535.
-
-`GL_INT'
- LISTS is treated as an array of signed four-byte integers.
-
-`GL_UNSIGNED_INT'
- LISTS is treated as an array of unsigned four-byte integers.
-
-`GL_FLOAT'
- LISTS is treated as an array of four-byte floating-point values.
-
-`GL_2_BYTES'
- LISTS is treated as an array of unsigned bytes. Each pair of bytes
- specifies a single display-list name. The value of the pair is
- computed as 256 times the unsigned value of the first byte plus the
- unsigned value of the second byte.
-
-`GL_3_BYTES'
- LISTS is treated as an array of unsigned bytes. Each triplet of
- bytes specifies a single display-list name. The value of the
- triplet is computed as 65536 times the unsigned value of the first
- byte, plus 256 times the unsigned value of the second byte, plus
- the unsigned value of the third byte.
-
-`GL_4_BYTES'
- LISTS is treated as an array of unsigned bytes. Each quadruplet of
- bytes specifies a single display-list name. The value of the
- quadruplet is computed as 16777216 times the unsigned value of the
- first byte, plus 65536 times the unsigned value of the second byte,
- plus 256 times the unsigned value of the third byte, plus the
- unsigned value of the fourth byte.
-
-The list of display-list names is not null-terminated. Rather, N
-specifies how many names are to be taken from LISTS.
-
-An additional level of indirection is made available with the
-`glListBase' command, which specifies an unsigned offset that is added
-to each display-list name specified in LISTS before that display list is
-executed.
-
-`glCallLists' can appear inside a display list. To avoid the possibility
-of infinite recursion resulting from display lists calling one another,
-a limit is placed on the nesting level of display lists during
-display-list execution. This limit must be at least 64, and it depends
-on the implementation.
-
-GL state is not saved and restored across a call to `glCallLists'. Thus,
-changes made to GL state during the execution of the display lists
-remain after execution is completed. Use `glPushAttrib', `glPopAttrib',
-`glPushMatrix', and `glPopMatrix' to preserve GL state across
-`glCallLists' calls.
-
-
-Errors
-======
-
-`GL_INVALID_VALUE' is generated if N is negative.
-
-`GL_INVALID_ENUM' is generated if TYPE is not one of `GL_BYTE',
-`GL_UNSIGNED_BYTE', `GL_SHORT', `GL_UNSIGNED_SHORT', `GL_INT',
-`GL_UNSIGNED_INT', `GL_FLOAT', `GL_2_BYTES', `GL_3_BYTES', `GL_4_BYTES'.")
-
-(define-gl-procedure
- glCallList
- "glCallList"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glCallList"))
- (paramdef "GLuint " (parameter "list"))))
- "execute a display list
-======================
-
-
-Parameters
-==========
-
-LIST
- Specifies the integer name of the display list to be executed.
-
-
-Description
-===========
-
-`glCallList' causes the named display list to be executed. The commands
-saved in the display list are executed in order, just as if they were
-called without using a display list. If LIST has not been defined as a
-display list, `glCallList' is ignored.
-
-`glCallList' can appear inside a display list. To avoid the possibility
-of infinite recursion resulting from display lists calling one another,
-a limit is placed on the nesting level of display lists during
-display-list execution. This limit is at least 64, and it depends on the
-implementation.
-
-GL state is not saved and restored across a call to `glCallList'. Thus,
-changes made to GL state during the execution of a display list remain
-after execution of the display list is completed. Use `glPushAttrib',
-`glPopAttrib', `glPushMatrix', and `glPopMatrix' to preserve GL state
-across `glCallList' calls.")
-
-(define-gl-procedure
- glClearAccum
- "glClearAccum"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glClearAccum"))
- (paramdef "GLfloat " (parameter "red"))
- (paramdef "GLfloat " (parameter "green"))
- (paramdef "GLfloat " (parameter "blue"))
- (paramdef "GLfloat " (parameter "alpha"))))
- "specify clear values for the accumulation buffer
-================================================
-
-
-Parameters
-==========
-
-RED
- GREEN
-
- BLUE
-
- ALPHA
-
- Specify the red, green, blue, and alpha values used when the
- accumulation buffer is cleared. The initial values are all 0.
-
-
-Description
-===========
-
-`glClearAccum' specifies the red, green, blue, and alpha values used by
-`glClear' to clear the accumulation buffer.
-
-Values specified by `glClearAccum' are clamped to the range [-1,1].
-
-
-Errors
-======
-
-`GL_INVALID_OPERATION' is generated if `glClearAccum' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glClearColor
- "glClearColor"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glClearColor"))
- (paramdef "GLclampf " (parameter "red"))
- (paramdef "GLclampf " (parameter "green"))
- (paramdef "GLclampf " (parameter "blue"))
- (paramdef "GLclampf " (parameter "alpha"))))
- "specify clear values for the color buffers
-==========================================
-
-
-Parameters
-==========
-
-RED
- GREEN
-
- BLUE
-
- ALPHA
-
- Specify the red, green, blue, and alpha values used when the color
- buffers are cleared. The initial values are all 0.
-
-
-Description
-===========
-
-`glClearColor' specifies the red, green, blue, and alpha values used by
-`glClear' to clear the color buffers. Values specified by `glClearColor'
-are clamped to the range [0,1].
-
-
-Errors
-======
-
-`GL_INVALID_OPERATION' is generated if `glClearColor' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glClearDepth
- "glClearDepth"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glClearDepth"))
- (paramdef "GLclampd " (parameter "depth"))))
- "specify the clear value for the depth buffer
-============================================
-
-
-Parameters
-==========
-
-DEPTH
- Specifies the depth value used when the depth buffer is cleared.
- The initial value is 1.
-
-
-Description
-===========
-
-`glClearDepth' specifies the depth value used by `glClear' to clear the
-depth buffer. Values specified by `glClearDepth' are clamped to the
-range [0,1].
-
-
-Errors
-======
-
-`GL_INVALID_OPERATION' is generated if `glClearDepth' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glClearIndex
- "glClearIndex"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glClearIndex"))
- (paramdef "GLfloat " (parameter "c"))))
- "specify the clear value for the color index buffers
-===================================================
-
-
-Parameters
-==========
-
-C
- Specifies the index used when the color index buffers are cleared.
- The initial value is 0.
-
-
-Description
-===========
-
-`glClearIndex' specifies the index used by `glClear' to clear the color
-index buffers. C is not clamped. Rather, C is converted to a fixed-point
-value with unspecified precision to the right of the binary point. The
-integer part of this value is then masked with 2^M-1, where M is the
-number of bits in a color index stored in the frame buffer.
-
-
-Errors
-======
-
-`GL_INVALID_OPERATION' is generated if `glClearIndex' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glClearStencil
- "glClearStencil"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glClearStencil"))
- (paramdef "GLint " (parameter "s"))))
- "specify the clear value for the stencil buffer
-==============================================
-
-
-Parameters
-==========
-
-S
- Specifies the index used when the stencil buffer is cleared. The
- initial value is 0.
-
-
-Description
-===========
-
-`glClearStencil' specifies the index used by `glClear' to clear the
-stencil buffer. S is masked with 2^M-1, where M is the number of bits in
-the stencil buffer.
-
-
-Errors
-======
-
-`GL_INVALID_OPERATION' is generated if `glClearStencil' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glClear
- "glClear"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glClear"))
- (paramdef "GLbitfield " (parameter "mask"))))
- "clear buffers to preset values
-==============================
-
-
-Parameters
-==========
-
-MASK
- Bitwise OR of masks that indicate the buffers to be cleared. The
- four masks are `GL_COLOR_BUFFER_BIT', `GL_DEPTH_BUFFER_BIT',
- `GL_ACCUM_BUFFER_BIT', and `GL_STENCIL_BUFFER_BIT'.
-
-
-Description
-===========
-
-`glClear' sets the bitplane area of the window to values previously
-selected by `glClearColor', `glClearIndex', `glClearDepth',
-`glClearStencil', and `glClearAccum'. Multiple color buffers can be
-cleared simultaneously by selecting more than one buffer at a time using
-`glDrawBuffer'.
-
-The pixel ownership test, the scissor test, dithering, and the buffer
-writemasks affect the operation of `glClear'. The scissor box bounds the
-cleared region. Alpha function, blend function, logical operation,
-stenciling, texture mapping, and depth-buffering are ignored by
-`glClear'.
-
-`glClear' takes a single argument that is the bitwise OR of several
-values indicating which buffer is to be cleared.
-
-The values are as follows:
-
-`GL_COLOR_BUFFER_BIT'
- Indicates the buffers currently enabled for color writing.
-
-`GL_DEPTH_BUFFER_BIT'
- Indicates the depth buffer.
-
-`GL_ACCUM_BUFFER_BIT'
- Indicates the accumulation buffer.
-
-`GL_STENCIL_BUFFER_BIT'
- Indicates the stencil buffer.
-
-The value to which each buffer is cleared depends on the setting of the
-clear value for that buffer.
-
-
-Errors
-======
-
-`GL_INVALID_VALUE' is generated if any bit other than the four defined
-bits is set in MASK.
-
-`GL_INVALID_OPERATION' is generated if `glClear' is executed between the
-execution of `glBegin' and the corresponding execution of `glEnd'.")
-
-(define-gl-procedure
- glClientActiveTexture
- "glClientActiveTexture"
- (funcsynopsis
- (funcprototype
- (funcdef
- "void "
- (function "glClientActiveTexture"))
- (paramdef "GLenum " (parameter "texture"))))
- "select active texture unit
-==========================
-
-
-Parameters
-==========
-
-TEXTURE
- Specifies which texture unit to make active. The number of texture
- units is implementation dependent, but must be at least two.
- TEXTURE must be one of `GL_TEXTURE'I, where i ranges from 0 to the
- value of `GL_MAX_TEXTURE_COORDS' - 1, which is an
- implementation-dependent value. The initial value is `GL_TEXTURE0'.
-
-
-Description
-===========
-
-`glClientActiveTexture' selects the vertex array client state parameters
-to be modified by `glTexCoordPointer', and enabled or disabled with
-`glEnableClientState' or `glDisableClientState', respectively, when
-called with a parameter of `GL_TEXTURE_COORD_ARRAY'.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if TEXTURE is not one of `GL_TEXTURE'I,
-where i ranges from 0 to the value of `GL_MAX_TEXTURE_COORDS' - 1.")
-
-(define-gl-procedure
- glClipPlane
- "glClipPlane"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glClipPlane"))
- (paramdef "GLenum " (parameter "plane"))
- (paramdef
- "const GLdouble * "
- (parameter "equation"))))
- "specify a plane against which all geometry is clipped
-=====================================================
-
-
-Parameters
-==========
-
-PLANE
- Specifies which clipping plane is being positioned. Symbolic names
- of the form `GL_CLIP_PLANE'I, where I is an integer between 0 and
- `GL_MAX_CLIP_PLANES'-1, are accepted.
-
-EQUATION
- Specifies the address of an array of four double-precision
- floating-point values. These values are interpreted as a plane
- equation.
-
-
-Description
-===========
-
-Geometry is always clipped against the boundaries of a six-plane frustum
-in X, Y, and Z. `glClipPlane' allows the specification of additional
-planes, not necessarily perpendicular to the X, Y, or Z axis, against
-which all geometry is clipped. To determine the maximum number of
-additional clipping planes, call `glGetIntegerv' with argument
-`GL_MAX_CLIP_PLANES'. All implementations support at least six such
-clipping planes. Because the resulting clipping region is the
-intersection of the defined half-spaces, it is always convex.
-
-`glClipPlane' specifies a half-space using a four-component plane
-equation. When `glClipPlane' is called, EQUATION is transformed by the
-inverse of the modelview matrix and stored in the resulting eye
-coordinates. Subsequent changes to the modelview matrix have no effect
-on the stored plane-equation components. If the dot product of the eye
-coordinates of a vertex with the stored plane equation components is
-positive or zero, the vertex is IN with respect to that clipping plane.
-Otherwise, it is OUT.
-
-To enable and disable clipping planes, call `glEnable' and `glDisable'
-with the argument `GL_CLIP_PLANE'I, where I is the plane number.
-
-All clipping planes are initially defined as (0, 0, 0, 0) in eye
-coordinates and are disabled.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if PLANE is not an accepted value.
-
-`GL_INVALID_OPERATION' is generated if `glClipPlane' is executed between
-the execution of `glBegin' and the corresponding execution of `glEnd'.")
-
-(define-gl-procedure
- glColorMask
- "glColorMask"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glColorMask"))
- (paramdef "GLboolean " (parameter "red"))
- (paramdef "GLboolean " (parameter "green"))
- (paramdef "GLboolean " (parameter "blue"))
- (paramdef "GLboolean " (parameter "alpha"))))
- "enable and disable writing of frame buffer color components
-===========================================================
-
-
-Parameters
-==========
-
-RED
- GREEN
-
- BLUE
-
- ALPHA
-
- Specify whether red, green, blue, and alpha can or cannot be
- written into the frame buffer. The initial values are all
- `GL_TRUE', indicating that the color components can be written.
-
-
-Description
-===========
-
-`glColorMask' specifies whether the individual color components in the
-frame buffer can or cannot be written. If RED is `GL_FALSE', for
-example, no change is made to the red component of any pixel in any of
-the color buffers, regardless of the drawing operation attempted.
-
-Changes to individual bits of components cannot be controlled. Rather,
-changes are either enabled or disabled for entire color components.
-
-
-Errors
-======
-
-`GL_INVALID_OPERATION' is generated if `glColorMask' is executed between
-the execution of `glBegin' and the corresponding execution of `glEnd'.")
-
-(define-gl-procedure
- glColorMaterial
- "glColorMaterial"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glColorMaterial"))
- (paramdef "GLenum " (parameter "face"))
- (paramdef "GLenum " (parameter "mode"))))
- "cause a material color to track the current color
-=================================================
-
-
-Parameters
-==========
-
-FACE
- Specifies whether front, back, or both front and back material
- parameters should track the current color. Accepted values are
- `GL_FRONT', `GL_BACK', and `GL_FRONT_AND_BACK'. The initial value
- is `GL_FRONT_AND_BACK'.
-
-MODE
- Specifies which of several material parameters track the current
- color. Accepted values are `GL_EMISSION', `GL_AMBIENT',
- `GL_DIFFUSE', `GL_SPECULAR', and `GL_AMBIENT_AND_DIFFUSE'. The
- initial value is `GL_AMBIENT_AND_DIFFUSE'.
-
-
-Description
-===========
-
-`glColorMaterial' specifies which material parameters track the current
-color. When `GL_COLOR_MATERIAL' is enabled, the material parameter or
-parameters specified by MODE, of the material or materials specified by
-FACE, track the current color at all times.
-
-To enable and disable `GL_COLOR_MATERIAL', call `glEnable' and
-`glDisable' with argument `GL_COLOR_MATERIAL'. `GL_COLOR_MATERIAL' is
-initially disabled.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if FACE or MODE is not an accepted value.
-
-`GL_INVALID_OPERATION' is generated if `glColorMaterial' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glColorPointer
- "glColorPointer"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glColorPointer"))
- (paramdef "GLint " (parameter "size"))
- (paramdef "GLenum " (parameter "type"))
- (paramdef "GLsizei " (parameter "stride"))
- (paramdef
- "const GLvoid * "
- (parameter "pointer"))))
- "define an array of colors
-=========================
-
-
-Parameters
-==========
-
-SIZE
- Specifies the number of components per color. Must be 3 or 4. The
- initial value is 4.
-
-TYPE
- Specifies the data type of each color component in the array.
- Symbolic constants `GL_BYTE', `GL_UNSIGNED_BYTE', `GL_SHORT',
- `GL_UNSIGNED_SHORT', `GL_INT', `GL_UNSIGNED_INT', `GL_FLOAT', and
- `GL_DOUBLE' are accepted. The initial value is `GL_FLOAT'.
-
-STRIDE
- Specifies the byte offset between consecutive colors. If STRIDE is
- 0, the colors are understood to be tightly packed in the array. The
- initial value is 0.
-
-POINTER
- Specifies a pointer to the first component of the first color
- element in the array. The initial value is 0.
-
-
-Description
-===========
-
-`glColorPointer' specifies the location and data format of an array of
-color components to use when rendering. SIZE specifies the number of
-components per color, and must be 3 or 4. TYPE specifies the data type
-of each color component, and STRIDE specifies the byte stride from one
-color to the next, allowing vertices and attributes to be packed into a
-single array or stored in separate arrays. (Single-array storage may be
-more efficient on some implementations; see `glInterleavedArrays'.)
-
-If a non-zero named buffer object is bound to the `GL_ARRAY_BUFFER'
-target (see `glBindBuffer') while a color array is specified, POINTER is
-treated as a byte offset into the buffer object's data store. Also, the
-buffer object binding (`GL_ARRAY_BUFFER_BINDING') is saved as color
-vertex array client-side state (`GL_COLOR_ARRAY_BUFFER_BINDING').
-
-When a color array is specified, SIZE, TYPE, STRIDE, and POINTER are
-saved as client-side state, in addition to the current vertex array
-buffer object binding.
-
-To enable and disable the color array, call `glEnableClientState' and
-`glDisableClientState' with the argument `GL_COLOR_ARRAY'. If enabled,
-the color array is used when `glDrawArrays', `glMultiDrawArrays',
-`glDrawElements', `glMultiDrawElements', `glDrawRangeElements', or
-`glArrayElement' is called.
-
-
-Errors
-======
-
-`GL_INVALID_VALUE' is generated if SIZE is not 3 or 4.
-
-`GL_INVALID_ENUM' is generated if TYPE is not an accepted value.
-
-`GL_INVALID_VALUE' is generated if STRIDE is negative.")
-
-(define-gl-procedure
- glColorSubTable
- "glColorSubTable"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glColorSubTable"))
- (paramdef "GLenum " (parameter "target"))
- (paramdef "GLsizei " (parameter "start"))
- (paramdef "GLsizei " (parameter "count"))
- (paramdef "GLenum " (parameter "format"))
- (paramdef "GLenum " (parameter "type"))
- (paramdef "const GLvoid * " (parameter "data"))))
- "respecify a portion of a color table
-====================================
-
-
-Parameters
-==========
-
-TARGET
- Must be one of `GL_COLOR_TABLE', `GL_POST_CONVOLUTION_COLOR_TABLE',
- or `GL_POST_COLOR_MATRIX_COLOR_TABLE'.
-
-START
- The starting index of the portion of the color table to be
- replaced.
-
-COUNT
- The number of table entries to replace.
-
-FORMAT
- The format of the pixel data in DATA. The allowable values are
- `GL_RED', `GL_GREEN', `GL_BLUE', `GL_ALPHA', `GL_LUMINANCE',
- `GL_LUMINANCE_ALPHA', `GL_RGB', `GL_BGR', `GL_RGBA', and `GL_BGRA'.
-
-TYPE
- The type of the pixel data in DATA. The allowable values are
- `GL_UNSIGNED_BYTE', `GL_BYTE', `GL_UNSIGNED_SHORT', `GL_SHORT',
- `GL_UNSIGNED_INT', `GL_INT', `GL_FLOAT', `GL_UNSIGNED_BYTE_3_3_2',
- `GL_UNSIGNED_BYTE_2_3_3_REV', `GL_UNSIGNED_SHORT_5_6_5',
- `GL_UNSIGNED_SHORT_5_6_5_REV', `GL_UNSIGNED_SHORT_4_4_4_4',
- `GL_UNSIGNED_SHORT_4_4_4_4_REV', `GL_UNSIGNED_SHORT_5_5_5_1',
- `GL_UNSIGNED_SHORT_1_5_5_5_REV', `GL_UNSIGNED_INT_8_8_8_8',
- `GL_UNSIGNED_INT_8_8_8_8_REV', `GL_UNSIGNED_INT_10_10_10_2', and
- `GL_UNSIGNED_INT_2_10_10_10_REV'.
-
-DATA
- Pointer to a one-dimensional array of pixel data that is processed
- to replace the specified region of the color table.
-
-
-Description
-===========
-
-`glColorSubTable' is used to respecify a contiguous portion of a color
-table previously defined using `glColorTable'. The pixels referenced by
-DATA replace the portion of the existing table from indices START to
-START+COUNT-1, inclusive. This region may not include any entries
-outside the range of the color table as it was originally specified. It
-is not an error to specify a subtexture with width of 0, but such a
-specification has no effect.
-
-If a non-zero named buffer object is bound to the
-`GL_PIXEL_UNPACK_BUFFER' target (see `glBindBuffer') while a portion of
-a color table is respecified, DATA is treated as a byte offset into the
-buffer object's data store.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if TARGET is not one of the allowable
-values.
-
-`GL_INVALID_ENUM' is generated if FORMAT is not one of the allowable
-values.
-
-`GL_INVALID_ENUM' is generated if TYPE is not one of the allowable
-values.
-
-`GL_INVALID_VALUE' is generated if START+COUNT>WIDTH.
-
-`GL_INVALID_OPERATION' is generated if a non-zero buffer object name is
-bound to the `GL_PIXEL_UNPACK_BUFFER' target and the buffer object's
-data store is currently mapped.
-
-`GL_INVALID_OPERATION' is generated if a non-zero buffer object name is
-bound to the `GL_PIXEL_UNPACK_BUFFER' target and the data would be
-unpacked from the buffer object such that the memory reads required
-would exceed the data store size.
-
-`GL_INVALID_OPERATION' is generated if a non-zero buffer object name is
-bound to the `GL_PIXEL_UNPACK_BUFFER' target and DATA is not evenly
-divisible into the number of bytes needed to store in memory a datum
-indicated by TYPE.
-
-`GL_INVALID_OPERATION' is generated if `glColorSubTable' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glColorTableParameter
- "glColorTableParameter"
- (funcsynopsis
- (funcprototype
- (funcdef
- "void "
- (function "glColorTableParameterfv"))
- (paramdef "GLenum " (parameter "target"))
- (paramdef "GLenum " (parameter "pname"))
- (paramdef
- "const GLfloat * "
- (parameter "params"))))
- "set color lookup table parameters
-=================================
-
-
-Parameters
-==========
-
-TARGET
- The target color table. Must be `GL_COLOR_TABLE',
- `GL_POST_CONVOLUTION_COLOR_TABLE', or
- `GL_POST_COLOR_MATRIX_COLOR_TABLE'.
-
-PNAME
- The symbolic name of a texture color lookup table parameter. Must
- be one of `GL_COLOR_TABLE_SCALE' or `GL_COLOR_TABLE_BIAS'.
-
-PARAMS
- A pointer to an array where the values of the parameters are
- stored.
-
-
-Description
-===========
-
-`glColorTableParameter' is used to specify the scale factors and bias
-terms applied to color components when they are loaded into a color
-table. TARGET indicates which color table the scale and bias terms apply
-to; it must be set to `GL_COLOR_TABLE',
-`GL_POST_CONVOLUTION_COLOR_TABLE', or
-`GL_POST_COLOR_MATRIX_COLOR_TABLE'.
-
-PNAME must be `GL_COLOR_TABLE_SCALE' to set the scale factors. In this
-case, PARAMS points to an array of four values, which are the scale
-factors for red, green, blue, and alpha, in that order.
-
-PNAME must be `GL_COLOR_TABLE_BIAS' to set the bias terms. In this case,
-PARAMS points to an array of four values, which are the bias terms for
-red, green, blue, and alpha, in that order.
-
-The color tables themselves are specified by calling `glColorTable'.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if TARGET or PNAME is not an acceptable
-value.
-
-`GL_INVALID_OPERATION' is generated if `glColorTableParameter' is
-executed between the execution of `glBegin' and the corresponding
-execution of `glEnd'.")
-
-(define-gl-procedure
- glColorTable
- "glColorTable"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glColorTable"))
- (paramdef "GLenum " (parameter "target"))
- (paramdef "GLenum " (parameter "internalformat"))
- (paramdef "GLsizei " (parameter "width"))
- (paramdef "GLenum " (parameter "format"))
- (paramdef "GLenum " (parameter "type"))
- (paramdef "const GLvoid * " (parameter "data"))))
- "define a color lookup table
-===========================
-
-
-Parameters
-==========
-
-TARGET
- Must be one of `GL_COLOR_TABLE', `GL_POST_CONVOLUTION_COLOR_TABLE',
- `GL_POST_COLOR_MATRIX_COLOR_TABLE', `GL_PROXY_COLOR_TABLE',
- `GL_PROXY_POST_CONVOLUTION_COLOR_TABLE', or
- `GL_PROXY_POST_COLOR_MATRIX_COLOR_TABLE'.
-
-INTERNALFORMAT
- The internal format of the color table. The allowable values are
- `GL_ALPHA', `GL_ALPHA4', `GL_ALPHA8', `GL_ALPHA12', `GL_ALPHA16',
- `GL_LUMINANCE', `GL_LUMINANCE4', `GL_LUMINANCE8', `GL_LUMINANCE12',
- `GL_LUMINANCE16', `GL_LUMINANCE_ALPHA', `GL_LUMINANCE4_ALPHA4',
- `GL_LUMINANCE6_ALPHA2', `GL_LUMINANCE8_ALPHA8',
- `GL_LUMINANCE12_ALPHA4', `GL_LUMINANCE12_ALPHA12',
- `GL_LUMINANCE16_ALPHA16', `GL_INTENSITY', `GL_INTENSITY4',
- `GL_INTENSITY8', `GL_INTENSITY12', `GL_INTENSITY16', `GL_R3_G3_B2',
- `GL_RGB', `GL_RGB4', `GL_RGB5', `GL_RGB8', `GL_RGB10', `GL_RGB12',
- `GL_RGB16', `GL_RGBA', `GL_RGBA2', `GL_RGBA4', `GL_RGB5_A1',
- `GL_RGBA8', `GL_RGB10_A2', `GL_RGBA12', and `GL_RGBA16'.
-
-WIDTH
- The number of entries in the color lookup table specified by DATA.
-
-FORMAT
- The format of the pixel data in DATA. The allowable values are
- `GL_RED', `GL_GREEN', `GL_BLUE', `GL_ALPHA', `GL_LUMINANCE',
- `GL_LUMINANCE_ALPHA', `GL_RGB', `GL_BGR', `GL_RGBA', and `GL_BGRA'.
-
-TYPE
- The type of the pixel data in DATA. The allowable values are
- `GL_UNSIGNED_BYTE', `GL_BYTE', `GL_UNSIGNED_SHORT', `GL_SHORT',
- `GL_UNSIGNED_INT', `GL_INT', `GL_FLOAT', `GL_UNSIGNED_BYTE_3_3_2',
- `GL_UNSIGNED_BYTE_2_3_3_REV', `GL_UNSIGNED_SHORT_5_6_5',
- `GL_UNSIGNED_SHORT_5_6_5_REV', `GL_UNSIGNED_SHORT_4_4_4_4',
- `GL_UNSIGNED_SHORT_4_4_4_4_REV', `GL_UNSIGNED_SHORT_5_5_5_1',
- `GL_UNSIGNED_SHORT_1_5_5_5_REV', `GL_UNSIGNED_INT_8_8_8_8',
- `GL_UNSIGNED_INT_8_8_8_8_REV', `GL_UNSIGNED_INT_10_10_10_2', and
- `GL_UNSIGNED_INT_2_10_10_10_REV'.
-
-DATA
- Pointer to a one-dimensional array of pixel data that is processed
- to build the color table.
-
-
-Description
-===========
-
-`glColorTable' may be used in two ways: to test the actual size and
-color resolution of a lookup table given a particular set of parameters,
-or to load the contents of a color lookup table. Use the targets
-`GL_PROXY_*' for the first case and the other targets for the second
-case.
-
-If a non-zero named buffer object is bound to the
-`GL_PIXEL_UNPACK_BUFFER' target (see `glBindBuffer') while a color table
-is specified, DATA is treated as a byte offset into the buffer object's
-data store.
-
-If TARGET is `GL_COLOR_TABLE', `GL_POST_CONVOLUTION_COLOR_TABLE', or
-`GL_POST_COLOR_MATRIX_COLOR_TABLE', `glColorTable' builds a color lookup
-table from an array of pixels. The pixel array specified by WIDTH,
-FORMAT, TYPE, and DATA is extracted from memory and processed just as if
-`glDrawPixels' were called, but processing stops after the final
-expansion to RGBA is completed.
-
-The four scale parameters and the four bias parameters that are defined
-for the table are then used to scale and bias the R, G, B, and A
-components of each pixel. (Use `glColorTableParameter' to set these
-scale and bias parameters.)
-
-Next, the R, G, B, and A values are clamped to the range [0,1]. Each
-pixel is then converted to the internal format specified by
-INTERNALFORMAT. This conversion simply maps the component values of the
-pixel (R, G, B, and A) to the values included in the internal format
-(red, green, blue, alpha, luminance, and intensity). The mapping is as
-follows:
-
-
-
-* Internal Format *
-*
-Red *, *
-Green *, *
-Blue *, *
-Alpha *, *
-Luminance *, *
-Intensity *`GL_ALPHA'
-, , ,
-A , , `GL_LUMINANCE'
-, , , ,
-R , `GL_LUMINANCE_ALPHA'
-, , ,
-A ,
-R , `GL_INTENSITY'
-, , , , ,
-R `GL_RGB'
-
-R ,
-G ,
-B , , , `GL_RGBA'
-
-R ,
-G ,
-B ,
-A , , Finally, the red, green, blue, alpha, luminance, and/or intensity
-components of the resulting pixels are stored in the color table. They
-form a one-dimensional table with indices in the range [0,WIDTH-1].
-
-If TARGET is `GL_PROXY_*', `glColorTable' recomputes and stores the
-values of the proxy color table's state variables
-`GL_COLOR_TABLE_FORMAT', `GL_COLOR_TABLE_WIDTH',
-`GL_COLOR_TABLE_RED_SIZE', `GL_COLOR_TABLE_GREEN_SIZE',
-`GL_COLOR_TABLE_BLUE_SIZE', `GL_COLOR_TABLE_ALPHA_SIZE',
-`GL_COLOR_TABLE_LUMINANCE_SIZE', and `GL_COLOR_TABLE_INTENSITY_SIZE'.
-There is no effect on the image or state of any actual color table. If
-the specified color table is too large to be supported, then all the
-proxy state variables listed above are set to zero. Otherwise, the color
-table could be supported by `glColorTable' using the corresponding
-non-proxy target, and the proxy state variables are set as if that
-target were being defined.
-
-The proxy state variables can be retrieved by calling
-`glGetColorTableParameter' with a target of `GL_PROXY_*'. This allows
-the application to decide if a particular `glColorTable' command would
-succeed, and to determine what the resulting color table attributes
-would be.
-
-If a color table is enabled, and its width is non-zero, then its
-contents are used to replace a subset of the components of each RGBA
-pixel group, based on the internal format of the table.
-
-Each pixel group has color components (R, G, B, A) that are in the range
-[0.0,1.0]. The color components are rescaled to the size of the color
-lookup table to form an index. Then a subset of the components based on
-the internal format of the table are replaced by the table entry
-selected by that index. If the color components and contents of the
-table are represented as follows:
-
-
-
-* Representation *
-*
-Meaning *`r'
-
-Table index computed from `R'`g'
-
-Table index computed from `G'`b'
-
-Table index computed from `B'`a'
-
-Table index computed from `A'`L[i]'
-
-Luminance value at table index `i'`I[i]'
-
-Intensity value at table index `i'`R[i]'
-
-Red value at table index `i'`G[i]'
-
-Green value at table index `i'`B[i]'
-
-Blue value at table index `i'`A[i]'
-
-Alpha value at table index `i'then the result of color table lookup is as follows:
-
-
-
-**
-*
-Resulting Texture Components ** Table Internal Format *
-*
-R *, *
-G *, *
-B *, *
-A *`GL_ALPHA'
-`R', `G', `B', `A[a]'`GL_LUMINANCE'
-`L[r]', `L[g]', `L[b]', `At'`GL_LUMINANCE_ALPHA'
-`L[r]', `L[g]', `L[b]', `A[a]'`GL_INTENSITY'
-`I[r]', `I[g]', `I[b]', `I[a]'`GL_RGB'
-`R[r]', `G[g]', `B[b]', `A'`GL_RGBA'
-`R[r]', `G[g]', `B[b]', `A[a]'When `GL_COLOR_TABLE' is enabled, the colors resulting from the pixel
-map operation (if it is enabled) are mapped by the color lookup table
-before being passed to the convolution operation. The colors resulting
-from the convolution operation are modified by the post convolution
-color lookup table when `GL_POST_CONVOLUTION_COLOR_TABLE' is enabled.
-These modified colors are then sent to the color matrix operation.
-Finally, if `GL_POST_COLOR_MATRIX_COLOR_TABLE' is enabled, the colors
-resulting from the color matrix operation are mapped by the post color
-matrix color lookup table before being used by the histogram operation.
-
-
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if TARGET is not one of the allowable
-values.
-
-`GL_INVALID_ENUM' is generated if INTERNALFORMAT is not one of the
-allowable values.
-
-`GL_INVALID_ENUM' is generated if FORMAT is not one of the allowable
-values.
-
-`GL_INVALID_ENUM' is generated if TYPE is not one of the allowable
-values.
-
-`GL_INVALID_VALUE' is generated if WIDTH is less than zero.
-
-`GL_TABLE_TOO_LARGE' is generated if the requested color table is too
-large to be supported by the implementation, and TARGET is not a
-`GL_PROXY_*' target.
-
-`GL_INVALID_OPERATION' is generated if a non-zero buffer object name is
-bound to the `GL_PIXEL_UNPACK_BUFFER' target and the buffer object's
-data store is currently mapped.
-
-`GL_INVALID_OPERATION' is generated if a non-zero buffer object name is
-bound to the `GL_PIXEL_UNPACK_BUFFER' target and the data would be
-unpacked from the buffer object such that the memory reads required
-would exceed the data store size.
-
-`GL_INVALID_OPERATION' is generated if a non-zero buffer object name is
-bound to the `GL_PIXEL_UNPACK_BUFFER' target and DATA is not evenly
-divisible into the number of bytes needed to store in memory a datum
-indicated by TYPE.
-
-`GL_INVALID_OPERATION' is generated if `glColorTable' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glColor
- "glColor"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glColor3b"))
- (paramdef "GLbyte " (parameter "red"))
- (paramdef "GLbyte " (parameter "green"))
- (paramdef "GLbyte " (parameter "blue"))))
- "set the current color
-=====================
-
-
-Parameters
-==========
-
-RED
- GREEN
-
- BLUE
-
- Specify new red, green, and blue values for the current color.
-
-ALPHA
- Specifies a new alpha value for the current color. Included only in
- the four-argument `glColor4' commands.
-
-
-Description
-===========
-
-The GL stores both a current single-valued color index and a current
-four-valued RGBA color. `glColor' sets a new four-valued RGBA color.
-`glColor' has two major variants: `glColor3' and `glColor4'. `glColor3'
-variants specify new red, green, and blue values explicitly and set the
-current alpha value to 1.0 (full intensity) implicitly. `glColor4'
-variants specify all four color components explicitly.
-
-`glColor3b', `glColor4b', `glColor3s', `glColor4s', `glColor3i', and
-`glColor4i' take three or four signed byte, short, or long integers as
-arguments. When *v* is appended to the name, the color commands can take
-a pointer to an array of such values.
-
-Current color values are stored in floating-point format, with
-unspecified mantissa and exponent sizes. Unsigned integer color
-components, when specified, are linearly mapped to floating-point values
-such that the largest representable value maps to 1.0 (full intensity),
-and 0 maps to 0.0 (zero intensity). Signed integer color components,
-when specified, are linearly mapped to floating-point values such that
-the most positive representable value maps to 1.0, and the most negative
-representable value maps to -1.0. (Note that this mapping does not
-convert 0 precisely to 0.0.) Floating-point values are mapped directly.
-
-Neither floating-point nor signed integer values are clamped to the
-range [0,1] before the current color is updated. However, color
-components are clamped to this range before they are interpolated or
-written into a color buffer.")
-
-(define-gl-procedure
- glCompileShader
- "glCompileShader"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glCompileShader"))
- (paramdef "GLuint " (parameter "shader"))))
- "Compiles a shader object
-========================
-
-
-Parameters
-==========
-
-SHADER
- Specifies the shader object to be compiled.
-
-
-Description
-===========
-
-`glCompileShader' compiles the source code strings that have been stored
-in the shader object specified by SHADER.
-
-The compilation status will be stored as part of the shader object's
-state. This value will be set to `GL_TRUE' if the shader was compiled
-without errors and is ready for use, and `GL_FALSE' otherwise. It can be
-queried by calling `glGetShader' with arguments SHADER and
-`GL_COMPILE_STATUS'.
-
-Compilation of a shader can fail for a number of reasons as specified by
-the OpenGL Shading Language Specification. Whether or not the
-compilation was successful, information about the compilation can be
-obtained from the shader object's information log by calling
-`glGetShaderInfoLog'.
-
-
-Errors
-======
-
-`GL_INVALID_VALUE' is generated if SHADER is not a value generated by
-OpenGL.
-
-`GL_INVALID_OPERATION' is generated if SHADER is not a shader object.
-
-`GL_INVALID_OPERATION' is generated if `glCompileShader' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glCompressedTexImage1D
- "glCompressedTexImage1D"
- (funcsynopsis
- (funcprototype
- (funcdef
- "void "
- (function "glCompressedTexImage1D"))
- (paramdef "GLenum " (parameter "target"))
- (paramdef "GLint " (parameter "level"))
- (paramdef "GLenum " (parameter "internalformat"))
- (paramdef "GLsizei " (parameter "width"))
- (paramdef "GLint " (parameter "border"))
- (paramdef "GLsizei " (parameter "imageSize"))
- (paramdef "const GLvoid * " (parameter "data"))))
- "specify a one-dimensional texture image in a compressed format
-==============================================================
-
-
-Parameters
-==========
-
-TARGET
- Specifies the target texture. Must be `GL_TEXTURE_1D' or
- `GL_PROXY_TEXTURE_1D'.
-
-LEVEL
- Specifies the level-of-detail number. Level 0 is the base image
- level. Level N is the Nth mipmap reduction image.
-
-INTERNALFORMAT
- Specifies the format of the compressed image data stored at address
- DATA.
-
-WIDTH
- Specifies the width of the texture image including the border if
- any. If the GL version does not support non-power-of-two sizes,
- this value must be 2^N+2\u2061(BORDER,) for some integer N. All
- implementations support texture images that are at least 64 texels
- wide. The height of the 1D texture image is 1.
-
-BORDER
- Specifies the width of the border. Must be either 0 or 1.
-
-IMAGESIZE
- Specifies the number of unsigned bytes of image data starting at
- the address specified by DATA.
-
-DATA
- Specifies a pointer to the compressed image data in memory.
-
-
-Description
-===========
-
-Texturing maps a portion of a specified texture image onto each
-graphical primitive for which texturing is enabled. To enable and
-disable one-dimensional texturing, call `glEnable' and `glDisable' with
-argument `GL_TEXTURE_1D'.
-
-`glCompressedTexImage1D' loads a previously defined, and retrieved,
-compressed one-dimensional texture image if TARGET is `GL_TEXTURE_1D'
-(see `glTexImage1D').
-
-If TARGET is `GL_PROXY_TEXTURE_1D', no data is read from DATA, but all
-of the texture image state is recalculated, checked for consistency, and
-checked against the implementation's capabilities. If the implementation
-cannot handle a texture of the requested texture size, it sets all of
-the image state to 0, but does not generate an error (see `glGetError').
-To query for an entire mipmap array, use an image array level greater
-than or equal to 1.
-
-INTERNALFORMAT must be extension-specified compressed-texture format.
-When a texture is loaded with `glTexImage1D' using a generic compressed
-texture format (e.g., `GL_COMPRESSED_RGB') the GL selects from one of
-its extensions supporting compressed textures. In order to load the
-compressed texture image using `glCompressedTexImage1D', query the
-compressed texture image's size and format using
-`glGetTexLevelParameter'.
-
-If a non-zero named buffer object is bound to the
-`GL_PIXEL_UNPACK_BUFFER' target (see `glBindBuffer') while a texture
-image is specified, DATA is treated as a byte offset into the buffer
-object's data store.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if INTERNALFORMAT is one of the generic
-compressed internal formats: `GL_COMPRESSED_ALPHA',
-`GL_COMPRESSED_LUMINANCE', `GL_COMPRESSED_LUMINANCE_ALPHA',
-`GL_COMPRESSED_INTENSITY', `GL_COMPRESSED_RGB', or `GL_COMPRESSED_RGBA'.
-
-`GL_INVALID_VALUE' is generated if IMAGESIZE is not consistent with the
-format, dimensions, and contents of the specified compressed image data.
-
-`GL_INVALID_OPERATION' is generated if parameter combinations are not
-supported by the specific compressed internal format as specified in the
-specific texture compression extension.
-
-`GL_INVALID_OPERATION' is generated if a non-zero buffer object name is
-bound to the `GL_PIXEL_UNPACK_BUFFER' target and the buffer object's
-data store is currently mapped.
-
-`GL_INVALID_OPERATION' is generated if a non-zero buffer object name is
-bound to the `GL_PIXEL_UNPACK_BUFFER' target and the data would be
-unpacked from the buffer object such that the memory reads required
-would exceed the data store size.
-
-`GL_INVALID_OPERATION' is generated if `glCompressedTexImage1D' is
-executed between the execution of `glBegin' and the corresponding
-execution of `glEnd'.
-
-Undefined results, including abnormal program termination, are generated
-if DATA is not encoded in a manner consistent with the extension
-specification defining the internal compression format.")
-
-(define-gl-procedure
- glCompressedTexImage2D
- "glCompressedTexImage2D"
- (funcsynopsis
- (funcprototype
- (funcdef
- "void "
- (function "glCompressedTexImage2D"))
- (paramdef "GLenum " (parameter "target"))
- (paramdef "GLint " (parameter "level"))
- (paramdef "GLenum " (parameter "internalformat"))
- (paramdef "GLsizei " (parameter "width"))
- (paramdef "GLsizei " (parameter "height"))
- (paramdef "GLint " (parameter "border"))
- (paramdef "GLsizei " (parameter "imageSize"))
- (paramdef "const GLvoid * " (parameter "data"))))
- "specify a two-dimensional texture image in a compressed format
-==============================================================
-
-
-Parameters
-==========
-
-TARGET
- Specifies the target texture. Must be `GL_TEXTURE_2D',
- `GL_PROXY_TEXTURE_2D', `GL_TEXTURE_CUBE_MAP_POSITIVE_X',
- `GL_TEXTURE_CUBE_MAP_NEGATIVE_X', `GL_TEXTURE_CUBE_MAP_POSITIVE_Y',
- `GL_TEXTURE_CUBE_MAP_NEGATIVE_Y', `GL_TEXTURE_CUBE_MAP_POSITIVE_Z',
- `GL_TEXTURE_CUBE_MAP_NEGATIVE_Z', or `GL_PROXY_TEXTURE_CUBE_MAP'.
-
-LEVEL
- Specifies the level-of-detail number. Level 0 is the base image
- level. Level N is the Nth mipmap reduction image.
-
-INTERNALFORMAT
- Specifies the format of the compressed image data stored at address
- DATA.
-
-WIDTH
- Specifies the width of the texture image including the border if
- any. If the GL version does not support non-power-of-two sizes,
- this value must be 2^N+2\u2061(BORDER,) for some integer N. All
- implementations support 2D texture images that are at least 64
- texels wide and cube-mapped texture images that are at least 16
- texels wide.
-
-HEIGHT
- Specifies the height of the texture image including the border if
- any. If the GL version does not support non-power-of-two sizes,
- this value must be Must be 2^N+2\u2061(BORDER,) for some integer N. All
- implementations support 2D texture images that are at least 64
- texels high and cube-mapped texture images that are at least 16
- texels high.
-
-BORDER
- Specifies the width of the border. Must be either 0 or 1.
-
-IMAGESIZE
- Specifies the number of unsigned bytes of image data starting at
- the address specified by DATA.
-
-DATA
- Specifies a pointer to the compressed image data in memory.
-
-
-Description
-===========
-
-Texturing maps a portion of a specified texture image onto each
-graphical primitive for which texturing is enabled. To enable and
-disable two-dimensional texturing, call `glEnable' and `glDisable' with
-argument `GL_TEXTURE_2D'. To enable and disable texturing using
-cube-mapped textures, call `glEnable' and `glDisable' with argument
-`GL_TEXTURE_CUBE_MAP'.
-
-`glCompressedTexImage2D' loads a previously defined, and retrieved,
-compressed two-dimensional texture image if TARGET is `GL_TEXTURE_2D'
-(see `glTexImage2D').
-
-If TARGET is `GL_PROXY_TEXTURE_2D', no data is read from DATA, but all
-of the texture image state is recalculated, checked for consistency, and
-checked against the implementation's capabilities. If the implementation
-cannot handle a texture of the requested texture size, it sets all of
-the image state to 0, but does not generate an error (see `glGetError').
-To query for an entire mipmap array, use an image array level greater
-than or equal to 1.
-
-INTERNALFORMAT must be an extension-specified compressed-texture format.
-When a texture is loaded with `glTexImage2D' using a generic compressed
-texture format (e.g., `GL_COMPRESSED_RGB'), the GL selects from one of
-its extensions supporting compressed textures. In order to load the
-compressed texture image using `glCompressedTexImage2D', query the
-compressed texture image's size and format using
-`glGetTexLevelParameter'.
-
-If a non-zero named buffer object is bound to the
-`GL_PIXEL_UNPACK_BUFFER' target (see `glBindBuffer') while a texture
-image is specified, DATA is treated as a byte offset into the buffer
-object's data store.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if INTERNALFORMAT is one of the generic
-compressed internal formats: `GL_COMPRESSED_ALPHA',
-`GL_COMPRESSED_LUMINANCE', `GL_COMPRESSED_LUMINANCE_ALPHA',
-`GL_COMPRESSED_INTENSITY', `GL_COMPRESSED_RGB', or `GL_COMPRESSED_RGBA'.
-
-`GL_INVALID_VALUE' is generated if IMAGESIZE is not consistent with the
-format, dimensions, and contents of the specified compressed image data.
-
-`GL_INVALID_OPERATION' is generated if parameter combinations are not
-supported by the specific compressed internal format as specified in the
-specific texture compression extension.
-
-`GL_INVALID_OPERATION' is generated if a non-zero buffer object name is
-bound to the `GL_PIXEL_UNPACK_BUFFER' target and the buffer object's
-data store is currently mapped.
-
-`GL_INVALID_OPERATION' is generated if a non-zero buffer object name is
-bound to the `GL_PIXEL_UNPACK_BUFFER' target and the data would be
-unpacked from the buffer object such that the memory reads required
-would exceed the data store size.
-
-`GL_INVALID_OPERATION' is generated if `glCompressedTexImage2D' is
-executed between the execution of `glBegin' and the corresponding
-execution of `glEnd'.
-
-Undefined results, including abnormal program termination, are generated
-if DATA is not encoded in a manner consistent with the extension
-specification defining the internal compression format.")
-
-(define-gl-procedure
- glCompressedTexImage3D
- "glCompressedTexImage3D"
- (funcsynopsis
- (funcprototype
- (funcdef
- "void "
- (function "glCompressedTexImage3D"))
- (paramdef "GLenum " (parameter "target"))
- (paramdef "GLint " (parameter "level"))
- (paramdef "GLenum " (parameter "internalformat"))
- (paramdef "GLsizei " (parameter "width"))
- (paramdef "GLsizei " (parameter "height"))
- (paramdef "GLsizei " (parameter "depth"))
- (paramdef "GLint " (parameter "border"))
- (paramdef "GLsizei " (parameter "imageSize"))
- (paramdef "const GLvoid * " (parameter "data"))))
- "specify a three-dimensional texture image in a compressed format
-================================================================
-
-
-Parameters
-==========
-
-TARGET
- Specifies the target texture. Must be `GL_TEXTURE_3D' or
- `GL_PROXY_TEXTURE_3D'.
-
-LEVEL
- Specifies the level-of-detail number. Level 0 is the base image
- level. Level N is the Nth mipmap reduction image.
-
-INTERNALFORMAT
- Specifies the format of the compressed image data stored at address
- DATA.
-
-WIDTH
- Specifies the width of the texture image including the border if
- any. If the GL version does not support non-power-of-two sizes,
- this value must be 2^N+2\u2061(BORDER,) for some integer N. All
- implementations support 3D texture images that are at least 16
- texels wide.
-
-HEIGHT
- Specifies the height of the texture image including the border if
- any. If the GL version does not support non-power-of-two sizes,
- this value must be 2^N+2\u2061(BORDER,) for some integer N. All
- implementations support 3D texture images that are at least 16
- texels high.
-
-DEPTH
- Specifies the depth of the texture image including the border if
- any. If the GL version does not support non-power-of-two sizes,
- this value must be 2^N+2\u2061(BORDER,) for some integer N. All
- implementations support 3D texture images that are at least 16
- texels deep.
-
-BORDER
- Specifies the width of the border. Must be either 0 or 1.
-
-IMAGESIZE
- Specifies the number of unsigned bytes of image data starting at
- the address specified by DATA.
-
-DATA
- Specifies a pointer to the compressed image data in memory.
-
-
-Description
-===========
-
-Texturing maps a portion of a specified texture image onto each
-graphical primitive for which texturing is enabled. To enable and
-disable three-dimensional texturing, call `glEnable' and `glDisable'
-with argument `GL_TEXTURE_3D'.
-
-`glCompressedTexImage3D' loads a previously defined, and retrieved,
-compressed three-dimensional texture image if TARGET is `GL_TEXTURE_3D'
-(see `glTexImage3D').
-
-If TARGET is `GL_PROXY_TEXTURE_3D', no data is read from DATA, but all
-of the texture image state is recalculated, checked for consistency, and
-checked against the implementation's capabilities. If the implementation
-cannot handle a texture of the requested texture size, it sets all of
-the image state to 0, but does not generate an error (see `glGetError').
-To query for an entire mipmap array, use an image array level greater
-than or equal to 1.
-
-INTERNALFORMAT must be an extension-specified compressed-texture format.
-When a texture is loaded with `glTexImage2D' using a generic compressed
-texture format (e.g., `GL_COMPRESSED_RGB'), the GL selects from one of
-its extensions supporting compressed textures. In order to load the
-compressed texture image using `glCompressedTexImage3D', query the
-compressed texture image's size and format using
-`glGetTexLevelParameter'.
-
-If a non-zero named buffer object is bound to the
-`GL_PIXEL_UNPACK_BUFFER' target (see `glBindBuffer') while a texture
-image is specified, DATA is treated as a byte offset into the buffer
-object's data store.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if INTERNALFORMAT is one of the generic
-compressed internal formats: `GL_COMPRESSED_ALPHA',
-`GL_COMPRESSED_LUMINANCE', `GL_COMPRESSED_LUMINANCE_ALPHA',
-`GL_COMPRESSED_INTENSITY', `GL_COMPRESSED_RGB', or `GL_COMPRESSED_RGBA'.
-
-`GL_INVALID_VALUE' is generated if IMAGESIZE is not consistent with the
-format, dimensions, and contents of the specified compressed image data.
-
-`GL_INVALID_OPERATION' is generated if parameter combinations are not
-supported by the specific compressed internal format as specified in the
-specific texture compression extension.
-
-`GL_INVALID_OPERATION' is generated if a non-zero buffer object name is
-bound to the `GL_PIXEL_UNPACK_BUFFER' target and the buffer object's
-data store is currently mapped.
-
-`GL_INVALID_OPERATION' is generated if a non-zero buffer object name is
-bound to the `GL_PIXEL_UNPACK_BUFFER' target and the data would be
-unpacked from the buffer object such that the memory reads required
-would exceed the data store size.
-
-`GL_INVALID_OPERATION' is generated if `glCompressedTexImage3D' is
-executed between the execution of `glBegin' and the corresponding
-execution of `glEnd'.
-
-Undefined results, including abnormal program termination, are generated
-if DATA is not encoded in a manner consistent with the extension
-specification defining the internal compression format.")
-
-(define-gl-procedure
- glCompressedTexSubImage1D
- "glCompressedTexSubImage1D"
- (funcsynopsis
- (funcprototype
- (funcdef
- "void "
- (function "glCompressedTexSubImage1D"))
- (paramdef "GLenum " (parameter "target"))
- (paramdef "GLint " (parameter "level"))
- (paramdef "GLint " (parameter "xoffset"))
- (paramdef "GLsizei " (parameter "width"))
- (paramdef "GLenum " (parameter "format"))
- (paramdef "GLsizei " (parameter "imageSize"))
- (paramdef "const GLvoid * " (parameter "data"))))
- "specify a one-dimensional texture subimage in a compressed format
-=================================================================
-
-
-Parameters
-==========
-
-TARGET
- Specifies the target texture. Must be `GL_TEXTURE_1D'.
-
-LEVEL
- Specifies the level-of-detail number. Level 0 is the base image
- level. Level N is the Nth mipmap reduction image.
-
-XOFFSET
- Specifies a texel offset in the x direction within the texture
- array.
-
-WIDTH
- Specifies the width of the texture subimage.
-
-FORMAT
- Specifies the format of the compressed image data stored at address
- DATA.
-
-IMAGESIZE
- Specifies the number of unsigned bytes of image data starting at
- the address specified by DATA.
-
-DATA
- Specifies a pointer to the compressed image data in memory.
-
-
-Description
-===========
-
-Texturing maps a portion of a specified texture image onto each
-graphical primitive for which texturing is enabled. To enable and
-disable one-dimensional texturing, call `glEnable' and `glDisable' with
-argument `GL_TEXTURE_1D'.
-
-`glCompressedTexSubImage1D' redefines a contiguous subregion of an
-existing one-dimensional texture image. The texels referenced by DATA
-replace the portion of the existing texture array with x indices XOFFSET
-and XOFFSET+WIDTH-1, inclusive. This region may not include any texels
-outside the range of the texture array as it was originally specified.
-It is not an error to specify a subtexture with width of 0, but such a
-specification has no effect.
-
-FORMAT must be an extension-specified compressed-texture format. The
-FORMAT of the compressed texture image is selected by the GL
-implementation that compressed it (see `glTexImage1D'), and should be
-queried at the time the texture was compressed with
-`glGetTexLevelParameter'.
-
-If a non-zero named buffer object is bound to the
-`GL_PIXEL_UNPACK_BUFFER' target (see `glBindBuffer') while a texture
-image is specified, DATA is treated as a byte offset into the buffer
-object's data store.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if FORMAT is one of these generic
-compressed internal formats: `GL_COMPRESSED_ALPHA',
-`GL_COMPRESSED_LUMINANCE', `GL_COMPRESSED_LUMINANCE_ALPHA',
-`GL_COMPRESSED_INTENSITY', `GL_COMPRESSED_RGB', `GL_COMPRESSED_RGBA',
-`GL_COMPRESSED_SLUMINANCE', `GL_COMPRESSED_SLUMINANCE_ALPHA',
-`GL_COMPRESSED_SRGB', `GL_COMPRESSED_SRGBA', or
-`GL_COMPRESSED_SRGB_ALPHA'.
-
-`GL_INVALID_VALUE' is generated if IMAGESIZE is not consistent with the
-format, dimensions, and contents of the specified compressed image data.
-
-`GL_INVALID_OPERATION' is generated if parameter combinations are not
-supported by the specific compressed internal format as specified in the
-specific texture compression extension.
-
-`GL_INVALID_OPERATION' is generated if a non-zero buffer object name is
-bound to the `GL_PIXEL_UNPACK_BUFFER' target and the buffer object's
-data store is currently mapped.
-
-`GL_INVALID_OPERATION' is generated if a non-zero buffer object name is
-bound to the `GL_PIXEL_UNPACK_BUFFER' target and the data would be
-unpacked from the buffer object such that the memory reads required
-would exceed the data store size.
-
-`GL_INVALID_OPERATION' is generated if `glCompressedTexSubImage1D' is
-executed between the execution of `glBegin' and the corresponding
-execution of `glEnd'.
-
-Undefined results, including abnormal program termination, are generated
-if DATA is not encoded in a manner consistent with the extension
-specification defining the internal compression format.")
-
-(define-gl-procedure
- glCompressedTexSubImage2D
- "glCompressedTexSubImage2D"
- (funcsynopsis
- (funcprototype
- (funcdef
- "void "
- (function "glCompressedTexSubImage2D"))
- (paramdef "GLenum " (parameter "target"))
- (paramdef "GLint " (parameter "level"))
- (paramdef "GLint " (parameter "xoffset"))
- (paramdef "GLint " (parameter "yoffset"))
- (paramdef "GLsizei " (parameter "width"))
- (paramdef "GLsizei " (parameter "height"))
- (paramdef "GLenum " (parameter "format"))
- (paramdef "GLsizei " (parameter "imageSize"))
- (paramdef "const GLvoid * " (parameter "data"))))
- "specify a two-dimensional texture subimage in a compressed format
-=================================================================
-
-
-Parameters
-==========
-
-TARGET
- Specifies the target texture. Must be `GL_TEXTURE_2D',
- `GL_TEXTURE_CUBE_MAP_POSITIVE_X', `GL_TEXTURE_CUBE_MAP_NEGATIVE_X',
- `GL_TEXTURE_CUBE_MAP_POSITIVE_Y', `GL_TEXTURE_CUBE_MAP_NEGATIVE_Y',
- `GL_TEXTURE_CUBE_MAP_POSITIVE_Z', or
- `GL_TEXTURE_CUBE_MAP_NEGATIVE_Z'.
-
-LEVEL
- Specifies the level-of-detail number. Level 0 is the base image
- level. Level N is the Nth mipmap reduction image.
-
-XOFFSET
- Specifies a texel offset in the x direction within the texture
- array.
-
-YOFFSET
- Specifies a texel offset in the y direction within the texture
- array.
-
-WIDTH
- Specifies the width of the texture subimage.
-
-HEIGHT
- Specifies the height of the texture subimage.
-
-FORMAT
- Specifies the format of the compressed image data stored at address
- DATA.
-
-IMAGESIZE
- Specifies the number of unsigned bytes of image data starting at
- the address specified by DATA.
-
-DATA
- Specifies a pointer to the compressed image data in memory.
-
-
-Description
-===========
-
-Texturing maps a portion of a specified texture image onto each
-graphical primitive for which texturing is enabled. To enable and
-disable two-dimensional texturing, call `glEnable' and `glDisable' with
-argument `GL_TEXTURE_2D'. To enable and disable texturing using
-cube-mapped texture, call `glEnable' and `glDisable' with argument
-`GL_TEXTURE_CUBE_MAP'.
-
-`glCompressedTexSubImage2D' redefines a contiguous subregion of an
-existing two-dimensional texture image. The texels referenced by DATA
-replace the portion of the existing texture array with x indices XOFFSET
-and XOFFSET+WIDTH-1, and the y indices YOFFSET and YOFFSET+HEIGHT-1,
-inclusive. This region may not include any texels outside the range of
-the texture array as it was originally specified. It is not an error to
-specify a subtexture with width of 0, but such a specification has no
-effect.
-
-FORMAT must be an extension-specified compressed-texture format. The
-FORMAT of the compressed texture image is selected by the GL
-implementation that compressed it (see `glTexImage2D') and should be
-queried at the time the texture was compressed with
-`glGetTexLevelParameter'.
-
-If a non-zero named buffer object is bound to the
-`GL_PIXEL_UNPACK_BUFFER' target (see `glBindBuffer') while a texture
-image is specified, DATA is treated as a byte offset into the buffer
-object's data store.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if FORMAT is one of these generic
-compressed internal formats: `GL_COMPRESSED_ALPHA',
-`GL_COMPRESSED_LUMINANCE', `GL_COMPRESSED_LUMINANCE_ALPHA',
-`GL_COMPRESSED_INTENSITY', `GL_COMPRESSED_RGB', `GL_COMPRESSED_RGBA',
-`GL_COMPRESSED_SLUMINANCE', `GL_COMPRESSED_SLUMINANCE_ALPHA',
-`GL_COMPRESSED_SRGB', `GL_COMPRESSED_SRGBA', or
-`GL_COMPRESSED_SRGB_ALPHA'.
-
-`GL_INVALID_VALUE' is generated if IMAGESIZE is not consistent with the
-format, dimensions, and contents of the specified compressed image data.
-
-`GL_INVALID_OPERATION' is generated if parameter combinations are not
-supported by the specific compressed internal format as specified in the
-specific texture compression extension.
-
-`GL_INVALID_OPERATION' is generated if a non-zero buffer object name is
-bound to the `GL_PIXEL_UNPACK_BUFFER' target and the buffer object's
-data store is currently mapped.
-
-`GL_INVALID_OPERATION' is generated if a non-zero buffer object name is
-bound to the `GL_PIXEL_UNPACK_BUFFER' target and the data would be
-unpacked from the buffer object such that the memory reads required
-would exceed the data store size.
-
-`GL_INVALID_OPERATION' is generated if `glCompressedTexSubImage2D' is
-executed between the execution of `glBegin' and the corresponding
-execution of `glEnd'.
-
-Undefined results, including abnormal program termination, are generated
-if DATA is not encoded in a manner consistent with the extension
-specification defining the internal compression format.")
-
-(define-gl-procedure
- glCompressedTexSubImage3D
- "glCompressedTexSubImage3D"
- (funcsynopsis
- (funcprototype
- (funcdef
- "void "
- (function "glCompressedTexSubImage3D"))
- (paramdef "GLenum " (parameter "target"))
- (paramdef "GLint " (parameter "level"))
- (paramdef "GLint " (parameter "xoffset"))
- (paramdef "GLint " (parameter "yoffset"))
- (paramdef "GLint " (parameter "zoffset"))
- (paramdef "GLsizei " (parameter "width"))
- (paramdef "GLsizei " (parameter "height"))
- (paramdef "GLsizei " (parameter "depth"))
- (paramdef "GLenum " (parameter "format"))
- (paramdef "GLsizei " (parameter "imageSize"))
- (paramdef "const GLvoid * " (parameter "data"))))
- "specify a three-dimensional texture subimage in a compressed format
-===================================================================
-
-
-Parameters
-==========
-
-TARGET
- Specifies the target texture. Must be `GL_TEXTURE_3D'.
-
-LEVEL
- Specifies the level-of-detail number. Level 0 is the base image
- level. Level N is the Nth mipmap reduction image.
-
-XOFFSET
- Specifies a texel offset in the x direction within the texture
- array.
-
-YOFFSET
- Specifies a texel offset in the y direction within the texture
- array.
-
-WIDTH
- Specifies the width of the texture subimage.
-
-HEIGHT
- Specifies the height of the texture subimage.
-
-DEPTH
- Specifies the depth of the texture subimage.
-
-FORMAT
- Specifies the format of the compressed image data stored at address
- DATA.
-
-IMAGESIZE
- Specifies the number of unsigned bytes of image data starting at
- the address specified by DATA.
-
-DATA
- Specifies a pointer to the compressed image data in memory.
-
-
-Description
-===========
-
-Texturing maps a portion of a specified texture image onto each
-graphical primitive for which texturing is enabled. To enable and
-disable three-dimensional texturing, call `glEnable' and `glDisable'
-with argument `GL_TEXTURE_3D'.
-
-`glCompressedTexSubImage3D' redefines a contiguous subregion of an
-existing three-dimensional texture image. The texels referenced by DATA
-replace the portion of the existing texture array with x indices XOFFSET
-and XOFFSET+WIDTH-1, and the y indices YOFFSET and YOFFSET+HEIGHT-1, and
-the z indices ZOFFSET and ZOFFSET+DEPTH-1, inclusive. This region may
-not include any texels outside the range of the texture array as it was
-originally specified. It is not an error to specify a subtexture with
-width of 0, but such a specification has no effect.
-
-FORMAT must be an extension-specified compressed-texture format. The
-FORMAT of the compressed texture image is selected by the GL
-implementation that compressed it (see `glTexImage3D') and should be
-queried at the time the texture was compressed with
-`glGetTexLevelParameter'.
-
-If a non-zero named buffer object is bound to the
-`GL_PIXEL_UNPACK_BUFFER' target (see `glBindBuffer') while a texture
-image is specified, DATA is treated as a byte offset into the buffer
-object's data store.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if FORMAT is one of these generic
-compressed internal formats: `GL_COMPRESSED_ALPHA',
-`GL_COMPRESSED_LUMINANCE', `GL_COMPRESSED_LUMINANCE_ALPHA',
-`GL_COMPRESSED_INTENSITY', `GL_COMPRESSED_RGB', `GL_COMPRESSED_RGBA',
-`GL_COMPRESSED_SLUMINANCE', `GL_COMPRESSED_SLUMINANCE_ALPHA',
-`GL_COMPRESSED_SRGB', `GL_COMPRESSED_SRGBA', or
-`GL_COMPRESSED_SRGB_ALPHA'.
-
-`GL_INVALID_VALUE' is generated if IMAGESIZE is not consistent with the
-format, dimensions, and contents of the specified compressed image data.
-
-`GL_INVALID_OPERATION' is generated if parameter combinations are not
-supported by the specific compressed internal format as specified in the
-specific texture compression extension.
-
-`GL_INVALID_OPERATION' is generated if a non-zero buffer object name is
-bound to the `GL_PIXEL_UNPACK_BUFFER' target and the buffer object's
-data store is currently mapped.
-
-`GL_INVALID_OPERATION' is generated if a non-zero buffer object name is
-bound to the `GL_PIXEL_UNPACK_BUFFER' target and the data would be
-unpacked from the buffer object such that the memory reads required
-would exceed the data store size.
-
-`GL_INVALID_OPERATION' is generated if `glCompressedTexSubImage3D' is
-executed between the execution of `glBegin' and the corresponding
-execution of `glEnd'.
-
-Undefined results, including abnormal program termination, are generated
-if DATA is not encoded in a manner consistent with the extension
-specification defining the internal compression format.")
-
-(define-gl-procedure
- glConvolutionFilter1D
- "glConvolutionFilter1D"
- (funcsynopsis
- (funcprototype
- (funcdef
- "void "
- (function "glConvolutionFilter1D"))
- (paramdef "GLenum " (parameter "target"))
- (paramdef "GLenum " (parameter "internalformat"))
- (paramdef "GLsizei " (parameter "width"))
- (paramdef "GLenum " (parameter "format"))
- (paramdef "GLenum " (parameter "type"))
- (paramdef "const GLvoid * " (parameter "data"))))
- "define a one-dimensional convolution filter
-===========================================
-
-
-Parameters
-==========
-
-TARGET
- Must be `GL_CONVOLUTION_1D'.
-
-INTERNALFORMAT
- The internal format of the convolution filter kernel. The allowable
- values are `GL_ALPHA', `GL_ALPHA4', `GL_ALPHA8', `GL_ALPHA12',
- `GL_ALPHA16', `GL_LUMINANCE', `GL_LUMINANCE4', `GL_LUMINANCE8',
- `GL_LUMINANCE12', `GL_LUMINANCE16', `GL_LUMINANCE_ALPHA',
- `GL_LUMINANCE4_ALPHA4', `GL_LUMINANCE6_ALPHA2',
- `GL_LUMINANCE8_ALPHA8', `GL_LUMINANCE12_ALPHA4',
- `GL_LUMINANCE12_ALPHA12', `GL_LUMINANCE16_ALPHA16', `GL_INTENSITY',
- `GL_INTENSITY4', `GL_INTENSITY8', `GL_INTENSITY12',
- `GL_INTENSITY16', `GL_R3_G3_B2', `GL_RGB', `GL_RGB4', `GL_RGB5',
- `GL_RGB8', `GL_RGB10', `GL_RGB12', `GL_RGB16', `GL_RGBA',
- `GL_RGBA2', `GL_RGBA4', `GL_RGB5_A1', `GL_RGBA8', `GL_RGB10_A2',
- `GL_RGBA12', or `GL_RGBA16'.
-
-WIDTH
- The width of the pixel array referenced by DATA.
-
-FORMAT
- The format of the pixel data in DATA. The allowable values are
- `GL_ALPHA', `GL_LUMINANCE', `GL_LUMINANCE_ALPHA', `GL_INTENSITY',
- `GL_RGB', and `GL_RGBA'.
-
-TYPE
- The type of the pixel data in DATA. Symbolic constants
- `GL_UNSIGNED_BYTE', `GL_BYTE', `GL_BITMAP', `GL_UNSIGNED_SHORT',
- `GL_SHORT', `GL_UNSIGNED_INT', `GL_INT', `GL_FLOAT',
- `GL_UNSIGNED_BYTE_3_3_2', `GL_UNSIGNED_BYTE_2_3_3_REV',
- `GL_UNSIGNED_SHORT_5_6_5', `GL_UNSIGNED_SHORT_5_6_5_REV',
- `GL_UNSIGNED_SHORT_4_4_4_4', `GL_UNSIGNED_SHORT_4_4_4_4_REV',
- `GL_UNSIGNED_SHORT_5_5_5_1', `GL_UNSIGNED_SHORT_1_5_5_5_REV',
- `GL_UNSIGNED_INT_8_8_8_8', `GL_UNSIGNED_INT_8_8_8_8_REV',
- `GL_UNSIGNED_INT_10_10_10_2', and `GL_UNSIGNED_INT_2_10_10_10_REV'
- are accepted.
-
-DATA
- Pointer to a one-dimensional array of pixel data that is processed
- to build the convolution filter kernel.
-
-
-Description
-===========
-
-`glConvolutionFilter1D' builds a one-dimensional convolution filter
-kernel from an array of pixels.
-
-The pixel array specified by WIDTH, FORMAT, TYPE, and DATA is extracted
-from memory and processed just as if `glDrawPixels' were called, but
-processing stops after the final expansion to RGBA is completed.
-
-If a non-zero named buffer object is bound to the
-`GL_PIXEL_UNPACK_BUFFER' target (see `glBindBuffer') while a convolution
-filter is specified, DATA is treated as a byte offset into the buffer
-object's data store.
-
-The R, G, B, and A components of each pixel are next scaled by the four
-1D `GL_CONVOLUTION_FILTER_SCALE' parameters and biased by the four 1D
-`GL_CONVOLUTION_FILTER_BIAS' parameters. (The scale and bias parameters
-are set by `glConvolutionParameter' using the `GL_CONVOLUTION_1D' target
-and the names `GL_CONVOLUTION_FILTER_SCALE' and
-`GL_CONVOLUTION_FILTER_BIAS'. The parameters themselves are vectors of
-four values that are applied to red, green, blue, and alpha, in that
-order.) The R, G, B, and A values are not clamped to [0,1] at any time
-during this process.
-
-Each pixel is then converted to the internal format specified by
-INTERNALFORMAT. This conversion simply maps the component values of the
-pixel (R, G, B, and A) to the values included in the internal format
-(red, green, blue, alpha, luminance, and intensity). The mapping is as
-follows:
-
-
-
-* Internal Format *
-*
-Red *, *
-Green *, *
-Blue *, *
-Alpha *, *
-Luminance *, *
-Intensity *`GL_ALPHA'
-, , ,
-A , , `GL_LUMINANCE'
-, , , ,
-R , `GL_LUMINANCE_ALPHA'
-, , ,
-A ,
-R , `GL_INTENSITY'
-, , , , ,
-R `GL_RGB'
-
-R ,
-G ,
-B , , , `GL_RGBA'
-
-R ,
-G ,
-B ,
-A , , The red, green, blue, alpha, luminance, and/or intensity components of
-the resulting pixels are stored in floating-point rather than integer
-format. They form a one-dimensional filter kernel image indexed with
-coordinate I such that I starts at 0 and increases from left to right.
-Kernel location I is derived from the Ith pixel, counting from 0.
-
-Note that after a convolution is performed, the resulting color
-components are also scaled by their corresponding
-`GL_POST_CONVOLUTION_c_SCALE' parameters and biased by their
-corresponding `GL_POST_CONVOLUTION_c_BIAS' parameters (where C takes on
-the values *RED*, *GREEN*, *BLUE*, and *ALPHA*). These parameters are
-set by `glPixelTransfer'.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if TARGET is not `GL_CONVOLUTION_1D'.
-
-`GL_INVALID_ENUM' is generated if INTERNALFORMAT is not one of the
-allowable values.
-
-`GL_INVALID_ENUM' is generated if FORMAT is not one of the allowable
-values.
-
-`GL_INVALID_ENUM' is generated if TYPE is not one of the allowable
-values.
-
-`GL_INVALID_VALUE' is generated if WIDTH is less than zero or greater
-than the maximum supported value. This value may be queried with
-`glGetConvolutionParameter' using target `GL_CONVOLUTION_1D' and name
-`GL_MAX_CONVOLUTION_WIDTH'.
-
-`GL_INVALID_OPERATION' is generated if FORMAT is one of
-`GL_UNSIGNED_BYTE_3_3_2', `GL_UNSIGNED_BYTE_2_3_3_REV',
-`GL_UNSIGNED_SHORT_5_6_5', or `GL_UNSIGNED_SHORT_5_6_5_REV' and TYPE is
-not `GL_RGB'.
-
-`GL_INVALID_OPERATION' is generated if FORMAT is one of
-`GL_UNSIGNED_SHORT_4_4_4_4', `GL_UNSIGNED_SHORT_4_4_4_4_REV',
-`GL_UNSIGNED_SHORT_5_5_5_1', `GL_UNSIGNED_SHORT_1_5_5_5_REV',
-`GL_UNSIGNED_INT_8_8_8_8', `GL_UNSIGNED_INT_8_8_8_8_REV',
-`GL_UNSIGNED_INT_10_10_10_2', or `GL_UNSIGNED_INT_2_10_10_10_REV' and
-TYPE is neither `GL_RGBA' nor `GL_BGRA'.
-
-`GL_INVALID_OPERATION' is generated if a non-zero buffer object name is
-bound to the `GL_PIXEL_UNPACK_BUFFER' target and the buffer object's
-data store is currently mapped.
-
-`GL_INVALID_OPERATION' is generated if a non-zero buffer object name is
-bound to the `GL_PIXEL_UNPACK_BUFFER' target and the data would be
-unpacked from the buffer object such that the memory reads required
-would exceed the data store size.
-
-`GL_INVALID_OPERATION' is generated if a non-zero buffer object name is
-bound to the `GL_PIXEL_UNPACK_BUFFER' target and DATA is not evenly
-divisible into the number of bytes needed to store in memory a datum
-indicated by TYPE.
-
-`GL_INVALID_OPERATION' is generated if `glConvolutionFilter1D' is
-executed between the execution of `glBegin' and the corresponding
-execution of `glEnd'.")
-
-(define-gl-procedure
- glConvolutionFilter2D
- "glConvolutionFilter2D"
- (funcsynopsis
- (funcprototype
- (funcdef
- "void "
- (function "glConvolutionFilter2D"))
- (paramdef "GLenum " (parameter "target"))
- (paramdef "GLenum " (parameter "internalformat"))
- (paramdef "GLsizei " (parameter "width"))
- (paramdef "GLsizei " (parameter "height"))
- (paramdef "GLenum " (parameter "format"))
- (paramdef "GLenum " (parameter "type"))
- (paramdef "const GLvoid * " (parameter "data"))))
- "define a two-dimensional convolution filter
-===========================================
-
-
-Parameters
-==========
-
-TARGET
- Must be `GL_CONVOLUTION_2D'.
-
-INTERNALFORMAT
- The internal format of the convolution filter kernel. The allowable
- values are `GL_ALPHA', `GL_ALPHA4', `GL_ALPHA8', `GL_ALPHA12',
- `GL_ALPHA16', `GL_LUMINANCE', `GL_LUMINANCE4', `GL_LUMINANCE8',
- `GL_LUMINANCE12', `GL_LUMINANCE16', `GL_LUMINANCE_ALPHA',
- `GL_LUMINANCE4_ALPHA4', `GL_LUMINANCE6_ALPHA2',
- `GL_LUMINANCE8_ALPHA8', `GL_LUMINANCE12_ALPHA4',
- `GL_LUMINANCE12_ALPHA12', `GL_LUMINANCE16_ALPHA16', `GL_INTENSITY',
- `GL_INTENSITY4', `GL_INTENSITY8', `GL_INTENSITY12',
- `GL_INTENSITY16', `GL_R3_G3_B2', `GL_RGB', `GL_RGB4', `GL_RGB5',
- `GL_RGB8', `GL_RGB10', `GL_RGB12', `GL_RGB16', `GL_RGBA',
- `GL_RGBA2', `GL_RGBA4', `GL_RGB5_A1', `GL_RGBA8', `GL_RGB10_A2',
- `GL_RGBA12', or `GL_RGBA16'.
-
-WIDTH
- The width of the pixel array referenced by DATA.
-
-HEIGHT
- The height of the pixel array referenced by DATA.
-
-FORMAT
- The format of the pixel data in DATA. The allowable values are
- `GL_RED', `GL_GREEN', `GL_BLUE', `GL_ALPHA', `GL_RGB', `GL_BGR',
- `GL_RGBA', `GL_BGRA', `GL_LUMINANCE', and `GL_LUMINANCE_ALPHA'.
-
-TYPE
- The type of the pixel data in DATA. Symbolic constants
- `GL_UNSIGNED_BYTE', `GL_BYTE', `GL_BITMAP', `GL_UNSIGNED_SHORT',
- `GL_SHORT', `GL_UNSIGNED_INT', `GL_INT', `GL_FLOAT',
- `GL_UNSIGNED_BYTE_3_3_2', `GL_UNSIGNED_BYTE_2_3_3_REV',
- `GL_UNSIGNED_SHORT_5_6_5', `GL_UNSIGNED_SHORT_5_6_5_REV',
- `GL_UNSIGNED_SHORT_4_4_4_4', `GL_UNSIGNED_SHORT_4_4_4_4_REV',
- `GL_UNSIGNED_SHORT_5_5_5_1', `GL_UNSIGNED_SHORT_1_5_5_5_REV',
- `GL_UNSIGNED_INT_8_8_8_8', `GL_UNSIGNED_INT_8_8_8_8_REV',
- `GL_UNSIGNED_INT_10_10_10_2', and `GL_UNSIGNED_INT_2_10_10_10_REV'
- are accepted.
-
-DATA
- Pointer to a two-dimensional array of pixel data that is processed
- to build the convolution filter kernel.
-
-
-Description
-===========
-
-`glConvolutionFilter2D' builds a two-dimensional convolution filter
-kernel from an array of pixels.
-
-The pixel array specified by WIDTH, HEIGHT, FORMAT, TYPE, and DATA is
-extracted from memory and processed just as if `glDrawPixels' were
-called, but processing stops after the final expansion to RGBA is
-completed.
-
-If a non-zero named buffer object is bound to the
-`GL_PIXEL_UNPACK_BUFFER' target (see `glBindBuffer') while a convolution
-filter is specified, DATA is treated as a byte offset into the buffer
-object's data store.
-
-The R, G, B, and A components of each pixel are next scaled by the four
-2D `GL_CONVOLUTION_FILTER_SCALE' parameters and biased by the four 2D
-`GL_CONVOLUTION_FILTER_BIAS' parameters. (The scale and bias parameters
-are set by `glConvolutionParameter' using the `GL_CONVOLUTION_2D' target
-and the names `GL_CONVOLUTION_FILTER_SCALE' and
-`GL_CONVOLUTION_FILTER_BIAS'. The parameters themselves are vectors of
-four values that are applied to red, green, blue, and alpha, in that
-order.) The R, G, B, and A values are not clamped to [0,1] at any time
-during this process.
-
-Each pixel is then converted to the internal format specified by
-INTERNALFORMAT. This conversion simply maps the component values of the
-pixel (R, G, B, and A) to the values included in the internal format
-(red, green, blue, alpha, luminance, and intensity). The mapping is as
-follows:
-
-
-
-* Internal Format *
-*
-Red *, *
-Green *, *
-Blue *, *
-Alpha *, *
-Luminance *, *
-Intensity *`GL_ALPHA'
-, , ,
-A , , `GL_LUMINANCE'
-, , , ,
-R , `GL_LUMINANCE_ALPHA'
-, , ,
-A ,
-R , `GL_INTENSITY'
-, , , , ,
-R `GL_RGB'
-
-R ,
-G ,
-B , , , `GL_RGBA'
-
-R ,
-G ,
-B ,
-A , , The red, green, blue, alpha, luminance, and/or intensity components of
-the resulting pixels are stored in floating-point rather than integer
-format. They form a two-dimensional filter kernel image indexed with
-coordinates I and J such that I starts at zero and increases from left
-to right, and J starts at zero and increases from bottom to top. Kernel
-location I,J is derived from the Nth pixel, where N is I+J*WIDTH.
-
-Note that after a convolution is performed, the resulting color
-components are also scaled by their corresponding
-`GL_POST_CONVOLUTION_c_SCALE' parameters and biased by their
-corresponding `GL_POST_CONVOLUTION_c_BIAS' parameters (where C takes on
-the values *RED*, *GREEN*, *BLUE*, and *ALPHA*). These parameters are
-set by `glPixelTransfer'.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if TARGET is not `GL_CONVOLUTION_2D'.
-
-`GL_INVALID_ENUM' is generated if INTERNALFORMAT is not one of the
-allowable values.
-
-`GL_INVALID_ENUM' is generated if FORMAT is not one of the allowable
-values.
-
-`GL_INVALID_ENUM' is generated if TYPE is not one of the allowable
-values.
-
-`GL_INVALID_VALUE' is generated if WIDTH is less than zero or greater
-than the maximum supported value. This value may be queried with
-`glGetConvolutionParameter' using target `GL_CONVOLUTION_2D' and name
-`GL_MAX_CONVOLUTION_WIDTH'.
-
-`GL_INVALID_VALUE' is generated if HEIGHT is less than zero or greater
-than the maximum supported value. This value may be queried with
-`glGetConvolutionParameter' using target `GL_CONVOLUTION_2D' and name
-`GL_MAX_CONVOLUTION_HEIGHT'.
-
-`GL_INVALID_OPERATION' is generated if HEIGHT is one of
-`GL_UNSIGNED_BYTE_3_3_2', `GL_UNSIGNED_BYTE_2_3_3_REV',
-`GL_UNSIGNED_SHORT_5_6_5', or `GL_UNSIGNED_SHORT_5_6_5_REV' and FORMAT
-is not `GL_RGB'.
-
-`GL_INVALID_OPERATION' is generated if HEIGHT is one of
-`GL_UNSIGNED_SHORT_4_4_4_4', `GL_UNSIGNED_SHORT_4_4_4_4_REV',
-`GL_UNSIGNED_SHORT_5_5_5_1', `GL_UNSIGNED_SHORT_1_5_5_5_REV',
-`GL_UNSIGNED_INT_8_8_8_8', `GL_UNSIGNED_INT_8_8_8_8_REV',
-`GL_UNSIGNED_INT_10_10_10_2', or `GL_UNSIGNED_INT_2_10_10_10_REV' and
-FORMAT is neither `GL_RGBA' nor `GL_BGRA'.
-
-`GL_INVALID_OPERATION' is generated if a non-zero buffer object name is
-bound to the `GL_PIXEL_UNPACK_BUFFER' target and the buffer object's
-data store is currently mapped.
-
-`GL_INVALID_OPERATION' is generated if a non-zero buffer object name is
-bound to the `GL_PIXEL_UNPACK_BUFFER' target and the data would be
-unpacked from the buffer object such that the memory reads required
-would exceed the data store size.
-
-`GL_INVALID_OPERATION' is generated if a non-zero buffer object name is
-bound to the `GL_PIXEL_UNPACK_BUFFER' target and DATA is not evenly
-divisible into the number of bytes needed to store in memory a datum
-indicated by TYPE.
-
-`GL_INVALID_OPERATION' is generated if `glConvolutionFilter2D' is
-executed between the execution of `glBegin' and the corresponding
-execution of `glEnd'.")
-
-(define-gl-procedure
- glConvolutionParameter
- "glConvolutionParameter"
- (funcsynopsis
- (funcprototype
- (funcdef
- "void "
- (function "glConvolutionParameterf"))
- (paramdef "GLenum " (parameter "target"))
- (paramdef "GLenum " (parameter "pname"))
- (paramdef "GLfloat " (parameter "params"))))
- "set convolution parameters
-==========================
-
-
-Parameters
-==========
-
-TARGET
- The target for the convolution parameter. Must be one of
- `GL_CONVOLUTION_1D', `GL_CONVOLUTION_2D', or `GL_SEPARABLE_2D'.
-
-PNAME
- The parameter to be set. Must be `GL_CONVOLUTION_BORDER_MODE'.
-
-PARAMS
- The parameter value. Must be one of `GL_REDUCE',
- `GL_CONSTANT_BORDER', `GL_REPLICATE_BORDER'.
-
-
-
-
-Description
-===========
-
-`glConvolutionParameter' sets the value of a convolution parameter.
-
-TARGET selects the convolution filter to be affected:
-`GL_CONVOLUTION_1D', `GL_CONVOLUTION_2D', or `GL_SEPARABLE_2D' for the
-1D, 2D, or separable 2D filter, respectively.
-
-PNAME selects the parameter to be changed. `GL_CONVOLUTION_FILTER_SCALE'
-and `GL_CONVOLUTION_FILTER_BIAS' affect the definition of the
-convolution filter kernel; see `glConvolutionFilter1D',
-`glConvolutionFilter2D', and `glSeparableFilter2D' for details. In these
-cases, PARAMSv is an array of four values to be applied to red, green,
-blue, and alpha values, respectively. The initial value for
-`GL_CONVOLUTION_FILTER_SCALE' is (1, 1, 1, 1), and the initial value for
-`GL_CONVOLUTION_FILTER_BIAS' is (0, 0, 0, 0).
-
-A PNAME value of `GL_CONVOLUTION_BORDER_MODE' controls the convolution
-border mode. The accepted modes are:
-
-`GL_REDUCE'
- The image resulting from convolution is smaller than the source
- image. If the filter width is WF and height is HF, and the source
- image width is WS and height is HS, then the convolved image width
- will be WS-WF+1 and height will be HS-HF+1. (If this reduction
- would generate an image with zero or negative width and/or height,
- the output is simply null, with no error generated.) The
- coordinates of the image resulting from convolution are zero
- through WS-WF in width and zero through HS-HF in height.
-
-`GL_CONSTANT_BORDER'
- The image resulting from convolution is the same size as the source
- image, and processed as if the source image were surrounded by
- pixels with their color specified by the
- `GL_CONVOLUTION_BORDER_COLOR'.
-
-`GL_REPLICATE_BORDER'
- The image resulting from convolution is the same size as the source
- image, and processed as if the outermost pixel on the border of the
- source image were replicated.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if TARGET is not one of the allowable
-values.
-
-`GL_INVALID_ENUM' is generated if PNAME is not one of the allowable
-values.
-
-`GL_INVALID_ENUM' is generated if PNAME is `GL_CONVOLUTION_BORDER_MODE'
-and PARAMS is not one of `GL_REDUCE', `GL_CONSTANT_BORDER', or
-`GL_REPLICATE_BORDER'.
-
-`GL_INVALID_OPERATION' is generated if `glConvolutionParameter' is
-executed between the execution of `glBegin' and the corresponding
-execution of `glEnd'.")
-
-(define-gl-procedure
- glCopyColorSubTable
- "glCopyColorSubTable"
- (funcsynopsis
- (funcprototype
- (funcdef
- "void "
- (function "glCopyColorSubTable"))
- (paramdef "GLenum " (parameter "target"))
- (paramdef "GLsizei " (parameter "start"))
- (paramdef "GLint " (parameter "x"))
- (paramdef "GLint " (parameter "y"))
- (paramdef "GLsizei " (parameter "width"))))
- "respecify a portion of a color table
-====================================
-
-
-Parameters
-==========
-
-TARGET
- Must be one of `GL_COLOR_TABLE', `GL_POST_CONVOLUTION_COLOR_TABLE',
- or `GL_POST_COLOR_MATRIX_COLOR_TABLE'.
-
-START
- The starting index of the portion of the color table to be
- replaced.
-
-X
- Y
-
- The window coordinates of the left corner of the row of pixels to
- be copied.
-
-WIDTH
- The number of table entries to replace.
-
-
-Description
-===========
-
-`glCopyColorSubTable' is used to respecify a contiguous portion of a
-color table previously defined using `glColorTable'. The pixels copied
-from the framebuffer replace the portion of the existing table from
-indices START to START+X-1, inclusive. This region may not include any
-entries outside the range of the color table, as was originally
-specified. It is not an error to specify a subtexture with width of 0,
-but such a specification has no effect.
-
-
-Errors
-======
-
-`GL_INVALID_VALUE' is generated if TARGET is not a previously defined
-color table.
-
-`GL_INVALID_VALUE' is generated if TARGET is not one of the allowable
-values.
-
-`GL_INVALID_VALUE' is generated if START+X>WIDTH.
-
-`GL_INVALID_OPERATION' is generated if `glCopyColorSubTable' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glCopyColorTable
- "glCopyColorTable"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glCopyColorTable"))
- (paramdef "GLenum " (parameter "target"))
- (paramdef "GLenum " (parameter "internalformat"))
- (paramdef "GLint " (parameter "x"))
- (paramdef "GLint " (parameter "y"))
- (paramdef "GLsizei " (parameter "width"))))
- "copy pixels into a color table
-==============================
-
-
-Parameters
-==========
-
-TARGET
- The color table target. Must be `GL_COLOR_TABLE',
- `GL_POST_CONVOLUTION_COLOR_TABLE', or
- `GL_POST_COLOR_MATRIX_COLOR_TABLE'.
-
-INTERNALFORMAT
- The internal storage format of the texture image. Must be one of
- the following symbolic constants: `GL_ALPHA', `GL_ALPHA4',
- `GL_ALPHA8', `GL_ALPHA12', `GL_ALPHA16', `GL_LUMINANCE',
- `GL_LUMINANCE4', `GL_LUMINANCE8', `GL_LUMINANCE12',
- `GL_LUMINANCE16', `GL_LUMINANCE_ALPHA', `GL_LUMINANCE4_ALPHA4',
- `GL_LUMINANCE6_ALPHA2', `GL_LUMINANCE8_ALPHA8',
- `GL_LUMINANCE12_ALPHA4', `GL_LUMINANCE12_ALPHA12',
- `GL_LUMINANCE16_ALPHA16', `GL_INTENSITY', `GL_INTENSITY4',
- `GL_INTENSITY8', `GL_INTENSITY12', `GL_INTENSITY16', `GL_R3_G3_B2',
- `GL_RGB', `GL_RGB4', `GL_RGB5', `GL_RGB8', `GL_RGB10', `GL_RGB12',
- `GL_RGB16', `GL_RGBA', `GL_RGBA2', `GL_RGBA4', `GL_RGB5_A1',
- `GL_RGBA8', `GL_RGB10_A2', `GL_RGBA12', or `GL_RGBA16'.
-
-X
- The x coordinate of the lower-left corner of the pixel rectangle to
- be transferred to the color table.
-
-Y
- The y coordinate of the lower-left corner of the pixel rectangle to
- be transferred to the color table.
-
-WIDTH
- The width of the pixel rectangle.
-
-
-Description
-===========
-
-`glCopyColorTable' loads a color table with pixels from the current
-`GL_READ_BUFFER' (rather than from main memory, as is the case for
-`glColorTable').
-
-The screen-aligned pixel rectangle with lower-left corner at (X,\\ Y)
-having width WIDTH and height 1 is loaded into the color table. If any
-pixels within this region are outside the window that is associated with
-the GL context, the values obtained for those pixels are undefined.
-
-The pixels in the rectangle are processed just as if `glReadPixels' were
-called, with INTERNALFORMAT set to RGBA, but processing stops after the
-final conversion to RGBA.
-
-The four scale parameters and the four bias parameters that are defined
-for the table are then used to scale and bias the R, G, B, and A
-components of each pixel. The scale and bias parameters are set by
-calling `glColorTableParameter'.
-
-Next, the R, G, B, and A values are clamped to the range [0,1]. Each
-pixel is then converted to the internal format specified by
-INTERNALFORMAT. This conversion simply maps the component values of the
-pixel (R, G, B, and A) to the values included in the internal format
-(red, green, blue, alpha, luminance, and intensity). The mapping is as
-follows:
-
-
-
-* Internal Format *
-*
-Red *, *
-Green *, *
-Blue *, *
-Alpha *, *
-Luminance *, *
-Intensity *`GL_ALPHA'
-, , ,
-A , , `GL_LUMINANCE'
-, , , ,
-R , `GL_LUMINANCE_ALPHA'
-, , ,
-A ,
-R , `GL_INTENSITY'
-, , , , ,
-R `GL_RGB'
-
-R ,
-G ,
-B , , , `GL_RGBA'
-
-R ,
-G ,
-B ,
-A , , Finally, the red, green, blue, alpha, luminance, and/or intensity
-components of the resulting pixels are stored in the color table. They
-form a one-dimensional table with indices in the range [0,WIDTH-1].
-
-
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated when TARGET is not one of the allowable
-values.
-
-`GL_INVALID_VALUE' is generated if WIDTH is less than zero.
-
-`GL_INVALID_VALUE' is generated if INTERNALFORMAT is not one of the
-allowable values.
-
-`GL_TABLE_TOO_LARGE' is generated if the requested color table is too
-large to be supported by the implementation.
-
-`GL_INVALID_OPERATION' is generated if `glCopyColorTable' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glCopyConvolutionFilter1D
- "glCopyConvolutionFilter1D"
- (funcsynopsis
- (funcprototype
- (funcdef
- "void "
- (function "glCopyConvolutionFilter1D"))
- (paramdef "GLenum " (parameter "target"))
- (paramdef "GLenum " (parameter "internalformat"))
- (paramdef "GLint " (parameter "x"))
- (paramdef "GLint " (parameter "y"))
- (paramdef "GLsizei " (parameter "width"))))
- "copy pixels into a one-dimensional convolution filter
-=====================================================
-
-
-Parameters
-==========
-
-TARGET
- Must be `GL_CONVOLUTION_1D'.
-
-INTERNALFORMAT
- The internal format of the convolution filter kernel. The allowable
- values are `GL_ALPHA', `GL_ALPHA4', `GL_ALPHA8', `GL_ALPHA12',
- `GL_ALPHA16', `GL_LUMINANCE', `GL_LUMINANCE4', `GL_LUMINANCE8',
- `GL_LUMINANCE12', `GL_LUMINANCE16', `GL_LUMINANCE_ALPHA',
- `GL_LUMINANCE4_ALPHA4', `GL_LUMINANCE6_ALPHA2',
- `GL_LUMINANCE8_ALPHA8', `GL_LUMINANCE12_ALPHA4',
- `GL_LUMINANCE12_ALPHA12', `GL_LUMINANCE16_ALPHA16', `GL_INTENSITY',
- `GL_INTENSITY4', `GL_INTENSITY8', `GL_INTENSITY12',
- `GL_INTENSITY16', `GL_R3_G3_B2', `GL_RGB', `GL_RGB4', `GL_RGB5',
- `GL_RGB8', `GL_RGB10', `GL_RGB12', `GL_RGB16', `GL_RGBA',
- `GL_RGBA2', `GL_RGBA4', `GL_RGB5_A1', `GL_RGBA8', `GL_RGB10_A2',
- `GL_RGBA12', or `GL_RGBA16'.
-
-X
- Y
-
- The window space coordinates of the lower-left coordinate of the
- pixel array to copy.
-
-WIDTH
- The width of the pixel array to copy.
-
-
-Description
-===========
-
-`glCopyConvolutionFilter1D' defines a one-dimensional convolution filter
-kernel with pixels from the current `GL_READ_BUFFER' (rather than from
-main memory, as is the case for `glConvolutionFilter1D').
-
-The screen-aligned pixel rectangle with lower-left corner at (X,\\ Y),
-width WIDTH and height 1 is used to define the convolution filter. If
-any pixels within this region are outside the window that is associated
-with the GL context, the values obtained for those pixels are undefined.
-
-The pixels in the rectangle are processed exactly as if `glReadPixels'
-had been called with FORMAT set to RGBA, but the process stops just
-before final conversion. The R, G, B, and A components of each pixel are
-next scaled by the four 1D `GL_CONVOLUTION_FILTER_SCALE' parameters and
-biased by the four 1D `GL_CONVOLUTION_FILTER_BIAS' parameters. (The
-scale and bias parameters are set by `glConvolutionParameter' using the
-`GL_CONVOLUTION_1D' target and the names `GL_CONVOLUTION_FILTER_SCALE'
-and `GL_CONVOLUTION_FILTER_BIAS'. The parameters themselves are vectors
-of four values that are applied to red, green, blue, and alpha, in that
-order.) The R, G, B, and A values are not clamped to [0,1] at any time
-during this process.
-
-Each pixel is then converted to the internal format specified by
-INTERNALFORMAT. This conversion simply maps the component values of the
-pixel (R, G, B, and A) to the values included in the internal format
-(red, green, blue, alpha, luminance, and intensity). The mapping is as
-follows:
-
-
-
-* Internal Format *
-*
-Red *, *
-Green *, *
-Blue *, *
-Alpha *, *
-Luminance *, *
-Intensity *`GL_ALPHA'
-, , ,
-A , , `GL_LUMINANCE'
-, , , ,
-R , `GL_LUMINANCE_ALPHA'
-, , ,
-A ,
-R , `GL_INTENSITY'
-, , , , ,
-R `GL_RGB'
-
-R ,
-G ,
-B , , , `GL_RGBA'
-
-R ,
-G ,
-B ,
-A , , The red, green, blue, alpha, luminance, and/or intensity components of
-the resulting pixels are stored in floating-point rather than integer
-format.
-
-Pixel ordering is such that lower x screen coordinates correspond to
-lower I filter image coordinates.
-
-Note that after a convolution is performed, the resulting color
-components are also scaled by their corresponding
-`GL_POST_CONVOLUTION_c_SCALE' parameters and biased by their
-corresponding `GL_POST_CONVOLUTION_c_BIAS' parameters (where C takes on
-the values *RED*, *GREEN*, *BLUE*, and *ALPHA*). These parameters are
-set by `glPixelTransfer'.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if TARGET is not `GL_CONVOLUTION_1D'.
-
-`GL_INVALID_ENUM' is generated if INTERNALFORMAT is not one of the
-allowable values.
-
-`GL_INVALID_VALUE' is generated if WIDTH is less than zero or greater
-than the maximum supported value. This value may be queried with
-`glGetConvolutionParameter' using target `GL_CONVOLUTION_1D' and name
-`GL_MAX_CONVOLUTION_WIDTH'.
-
-`GL_INVALID_OPERATION' is generated if `glCopyConvolutionFilter1D' is
-executed between the execution of `glBegin' and the corresponding
-execution of `glEnd'.")
-
-(define-gl-procedure
- glCopyConvolutionFilter2D
- "glCopyConvolutionFilter2D"
- (funcsynopsis
- (funcprototype
- (funcdef
- "void "
- (function "glCopyConvolutionFilter2D"))
- (paramdef "GLenum " (parameter "target"))
- (paramdef "GLenum " (parameter "internalformat"))
- (paramdef "GLint " (parameter "x"))
- (paramdef "GLint " (parameter "y"))
- (paramdef "GLsizei " (parameter "width"))
- (paramdef "GLsizei " (parameter "height"))))
- "copy pixels into a two-dimensional convolution filter
-=====================================================
-
-
-Parameters
-==========
-
-TARGET
- Must be `GL_CONVOLUTION_2D'.
-
-INTERNALFORMAT
- The internal format of the convolution filter kernel. The allowable
- values are `GL_ALPHA', `GL_ALPHA4', `GL_ALPHA8', `GL_ALPHA12',
- `GL_ALPHA16', `GL_LUMINANCE', `GL_LUMINANCE4', `GL_LUMINANCE8',
- `GL_LUMINANCE12', `GL_LUMINANCE16', `GL_LUMINANCE_ALPHA',
- `GL_LUMINANCE4_ALPHA4', `GL_LUMINANCE6_ALPHA2',
- `GL_LUMINANCE8_ALPHA8', `GL_LUMINANCE12_ALPHA4',
- `GL_LUMINANCE12_ALPHA12', `GL_LUMINANCE16_ALPHA16', `GL_INTENSITY',
- `GL_INTENSITY4', `GL_INTENSITY8', `GL_INTENSITY12',
- `GL_INTENSITY16', `GL_R3_G3_B2', `GL_RGB', `GL_RGB4', `GL_RGB5',
- `GL_RGB8', `GL_RGB10', `GL_RGB12', `GL_RGB16', `GL_RGBA',
- `GL_RGBA2', `GL_RGBA4', `GL_RGB5_A1', `GL_RGBA8', `GL_RGB10_A2',
- `GL_RGBA12', or `GL_RGBA16'.
-
-X
- Y
-
- The window space coordinates of the lower-left coordinate of the
- pixel array to copy.
-
-WIDTH
- The width of the pixel array to copy.
-
-HEIGHT
- The height of the pixel array to copy.
-
-
-Description
-===========
-
-`glCopyConvolutionFilter2D' defines a two-dimensional convolution filter
-kernel with pixels from the current `GL_READ_BUFFER' (rather than from
-main memory, as is the case for `glConvolutionFilter2D').
-
-The screen-aligned pixel rectangle with lower-left corner at (X,\\ Y),
-width WIDTH and height HEIGHT is used to define the convolution filter.
-If any pixels within this region are outside the window that is
-associated with the GL context, the values obtained for those pixels are
-undefined.
-
-The pixels in the rectangle are processed exactly as if `glReadPixels'
-had been called with FORMAT set to RGBA, but the process stops just
-before final conversion. The R, G, B, and A components of each pixel are
-next scaled by the four 2D `GL_CONVOLUTION_FILTER_SCALE' parameters and
-biased by the four 2D `GL_CONVOLUTION_FILTER_BIAS' parameters. (The
-scale and bias parameters are set by `glConvolutionParameter' using the
-`GL_CONVOLUTION_2D' target and the names `GL_CONVOLUTION_FILTER_SCALE'
-and `GL_CONVOLUTION_FILTER_BIAS'. The parameters themselves are vectors
-of four values that are applied to red, green, blue, and alpha, in that
-order.) The R, G, B, and A values are not clamped to [0,1] at any time
-during this process.
-
-Each pixel is then converted to the internal format specified by
-INTERNALFORMAT. This conversion simply maps the component values of the
-pixel (R, G, B, and A) to the values included in the internal format
-(red, green, blue, alpha, luminance, and intensity). The mapping is as
-follows:
-
-
-
-* Internal Format *
-*
-Red *, *
-Green *, *
-Blue *, *
-Alpha *, *
-Luminance *, *
-Intensity *`GL_ALPHA'
-, , ,
-A , , `GL_LUMINANCE'
-, , , ,
-R , `GL_LUMINANCE_ALPHA'
-, , ,
-A ,
-R , `GL_INTENSITY'
-, , , , ,
-R `GL_RGB'
-
-R ,
-G ,
-B , , , `GL_RGBA'
-
-R ,
-G ,
-B ,
-A , , The red, green, blue, alpha, luminance, and/or intensity components of
-the resulting pixels are stored in floating-point rather than integer
-format.
-
-Pixel ordering is such that lower x screen coordinates correspond to
-lower I filter image coordinates, and lower y screen coordinates
-correspond to lower J filter image coordinates.
-
-Note that after a convolution is performed, the resulting color
-components are also scaled by their corresponding
-`GL_POST_CONVOLUTION_c_SCALE' parameters and biased by their
-corresponding `GL_POST_CONVOLUTION_c_BIAS' parameters (where C takes on
-the values *RED*, *GREEN*, *BLUE*, and *ALPHA*). These parameters are
-set by `glPixelTransfer'.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if TARGET is not `GL_CONVOLUTION_2D'.
-
-`GL_INVALID_ENUM' is generated if INTERNALFORMAT is not one of the
-allowable values.
-
-`GL_INVALID_VALUE' is generated if WIDTH is less than zero or greater
-than the maximum supported value. This value may be queried with
-`glGetConvolutionParameter' using target `GL_CONVOLUTION_2D' and name
-`GL_MAX_CONVOLUTION_WIDTH'.
-
-`GL_INVALID_VALUE' is generated if HEIGHT is less than zero or greater
-than the maximum supported value. This value may be queried with
-`glGetConvolutionParameter' using target `GL_CONVOLUTION_2D' and name
-`GL_MAX_CONVOLUTION_HEIGHT'.
-
-`GL_INVALID_OPERATION' is generated if `glCopyConvolutionFilter2D' is
-executed between the execution of `glBegin' and the corresponding
-execution of `glEnd'.")
-
-(define-gl-procedure
- glCopyPixels
- "glCopyPixels"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glCopyPixels"))
- (paramdef "GLint " (parameter "x"))
- (paramdef "GLint " (parameter "y"))
- (paramdef "GLsizei " (parameter "width"))
- (paramdef "GLsizei " (parameter "height"))
- (paramdef "GLenum " (parameter "type"))))
- "copy pixels in the frame buffer
-===============================
-
-
-Parameters
-==========
-
-X
- Y
-
- Specify the window coordinates of the lower left corner of the
- rectangular region of pixels to be copied.
-
-WIDTH
- HEIGHT
-
- Specify the dimensions of the rectangular region of pixels to be
- copied. Both must be nonnegative.
-
-TYPE
- Specifies whether color values, depth values, or stencil values are
- to be copied. Symbolic constants `GL_COLOR', `GL_DEPTH', and
- `GL_STENCIL' are accepted.
-
-
-Description
-===========
-
-`glCopyPixels' copies a screen-aligned rectangle of pixels from the
-specified frame buffer location to a region relative to the current
-raster position. Its operation is well defined only if the entire pixel
-source region is within the exposed portion of the window. Results of
-copies from outside the window, or from regions of the window that are
-not exposed, are hardware dependent and undefined.
-
-X and Y specify the window coordinates of the lower left corner of the
-rectangular region to be copied. WIDTH and HEIGHT specify the dimensions
-of the rectangular region to be copied. Both WIDTH and HEIGHT must not
-be negative.
-
-Several parameters control the processing of the pixel data while it is
-being copied. These parameters are set with three commands:
-`glPixelTransfer', `glPixelMap', and `glPixelZoom'. This reference page
-describes the effects on `glCopyPixels' of most, but not all, of the
-parameters specified by these three commands.
-
-`glCopyPixels' copies values from each pixel with the lower left-hand
-corner at (X+I,Y+J) for 0<=I<WIDTH and 0<=J<HEIGHT. This pixel is said
-to be the Ith pixel in the Jth row. Pixels are copied in row order from
-the lowest to the highest row, left to right in each row.
-
-TYPE specifies whether color, depth, or stencil data is to be copied.
-The details of the transfer for each data type are as follows:
-
-`GL_COLOR'
- Indices or RGBA colors are read from the buffer currently specified
- as the read source buffer (see `glReadBuffer'). If the GL is in
- color index mode, each index that is read from this buffer is
- converted to a fixed-point format with an unspecified number of
- bits to the right of the binary point. Each index is then shifted
- left by `GL_INDEX_SHIFT' bits, and added to `GL_INDEX_OFFSET'. If
- `GL_INDEX_SHIFT' is negative, the shift is to the right. In either
- case, zero bits fill otherwise unspecified bit locations in the
- result. If `GL_MAP_COLOR' is true, the index is replaced with the
- value that it references in lookup table `GL_PIXEL_MAP_I_TO_I'.
- Whether the lookup replacement of the index is done or not, the
- integer part of the index is then ANDed with 2^B-1, where B is the
- number of bits in a color index buffer.
-
- If the GL is in RGBA mode, the red, green, blue, and alpha
- components of each pixel that is read are converted to an internal
- floating-point format with unspecified precision. The conversion
- maps the largest representable component value to 1.0, and
- component value 0 to 0.0. The resulting floating-point color values
- are then multiplied by `GL_c_SCALE' and added to `GL_c_BIAS', where
- C is RED, GREEN, BLUE, and ALPHA for the respective color
- components. The results are clamped to the range [0,1]. If
- `GL_MAP_COLOR' is true, each color component is scaled by the size
- of lookup table `GL_PIXEL_MAP_c_TO_c', then replaced by the value
- that it references in that table. C is R, G, B, or A.
-
- If the `ARB_imaging' extension is supported, the color values may
- be additionally processed by color-table lookups, color-matrix
- transformations, and convolution filters.
-
- The GL then converts the resulting indices or RGBA colors to
- fragments by attaching the current raster position Z coordinate and
- texture coordinates to each pixel, then assigning window
- coordinates (X_R+I,Y_R+J), where (X_R,Y_R) is the current raster
- position, and the pixel was the Ith pixel in the Jth row. These
- pixel fragments are then treated just like the fragments generated
- by rasterizing points, lines, or polygons. Texture mapping, fog,
- and all the fragment operations are applied before the fragments
- are written to the frame buffer.
-
-`GL_DEPTH'
- Depth values are read from the depth buffer and converted directly
- to an internal floating-point format with unspecified precision.
- The resulting floating-point depth value is then multiplied by
- `GL_DEPTH_SCALE' and added to `GL_DEPTH_BIAS'. The result is
- clamped to the range [0,1].
-
- The GL then converts the resulting depth components to fragments by
- attaching the current raster position color or color index and
- texture coordinates to each pixel, then assigning window
- coordinates (X_R+I,Y_R+J), where (X_R,Y_R) is the current raster
- position, and the pixel was the Ith pixel in the Jth row. These
- pixel fragments are then treated just like the fragments generated
- by rasterizing points, lines, or polygons. Texture mapping, fog,
- and all the fragment operations are applied before the fragments
- are written to the frame buffer.
-
-`GL_STENCIL'
- Stencil indices are read from the stencil buffer and converted to
- an internal fixed-point format with an unspecified number of bits
- to the right of the binary point. Each fixed-point index is then
- shifted left by `GL_INDEX_SHIFT' bits, and added to
- `GL_INDEX_OFFSET'. If `GL_INDEX_SHIFT' is negative, the shift is to
- the right. In either case, zero bits fill otherwise unspecified bit
- locations in the result. If `GL_MAP_STENCIL' is true, the index is
- replaced with the value that it references in lookup table
- `GL_PIXEL_MAP_S_TO_S'. Whether the lookup replacement of the index
- is done or not, the integer part of the index is then ANDed with
- 2^B-1, where B is the number of bits in the stencil buffer. The
- resulting stencil indices are then written to the stencil buffer
- such that the index read from the Ith location of the Jth row is
- written to location (X_R+I,Y_R+J), where (X_R,Y_R) is the current
- raster position. Only the pixel ownership test, the scissor test,
- and the stencil writemask affect these write operations.
-
-The rasterization described thus far assumes pixel zoom factors of 1.0.
-If `glPixelZoom' is used to change the X and Y pixel zoom factors,
-pixels are converted to fragments as follows. If (X_R,Y_R) is the
-current raster position, and a given pixel is in the Ith location in the
-Jth row of the source pixel rectangle, then fragments are generated for
-pixels whose centers are in the rectangle with corners at
-
-(X_R+ZOOM_X,\u2062I,Y_R+ZOOM_Y,\u2062J)
-
-and
-
-(X_R+ZOOM_X,\u2061(I+1,),Y_R+ZOOM_Y,\u2061(J+1,))
-
-where ZOOM_X is the value of `GL_ZOOM_X' and ZOOM_Y is the value of
-`GL_ZOOM_Y'.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if TYPE is not an accepted value.
-
-`GL_INVALID_VALUE' is generated if either WIDTH or HEIGHT is negative.
-
-`GL_INVALID_OPERATION' is generated if TYPE is `GL_DEPTH' and there is
-no depth buffer.
-
-`GL_INVALID_OPERATION' is generated if TYPE is `GL_STENCIL' and there is
-no stencil buffer.
-
-`GL_INVALID_OPERATION' is generated if `glCopyPixels' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glCopyTexImage1D
- "glCopyTexImage1D"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glCopyTexImage1D"))
- (paramdef "GLenum " (parameter "target"))
- (paramdef "GLint " (parameter "level"))
- (paramdef "GLenum " (parameter "internalformat"))
- (paramdef "GLint " (parameter "x"))
- (paramdef "GLint " (parameter "y"))
- (paramdef "GLsizei " (parameter "width"))
- (paramdef "GLint " (parameter "border"))))
- "copy pixels into a 1D texture image
-===================================
-
-
-Parameters
-==========
-
-TARGET
- Specifies the target texture. Must be `GL_TEXTURE_1D'.
-
-LEVEL
- Specifies the level-of-detail number. Level 0 is the base image
- level. Level N is the Nth mipmap reduction image.
-
-INTERNALFORMAT
- Specifies the internal format of the texture. Must be one of the
- following symbolic constants: `GL_ALPHA', `GL_ALPHA4', `GL_ALPHA8',
- `GL_ALPHA12', `GL_ALPHA16', `GL_COMPRESSED_ALPHA',
- `GL_COMPRESSED_LUMINANCE', `GL_COMPRESSED_LUMINANCE_ALPHA',
- `GL_COMPRESSED_INTENSITY', `GL_COMPRESSED_RGB',
- `GL_COMPRESSED_RGBA', `GL_DEPTH_COMPONENT', `GL_DEPTH_COMPONENT16',
- `GL_DEPTH_COMPONENT24', `GL_DEPTH_COMPONENT32', `GL_LUMINANCE',
- `GL_LUMINANCE4', `GL_LUMINANCE8', `GL_LUMINANCE12',
- `GL_LUMINANCE16', `GL_LUMINANCE_ALPHA', `GL_LUMINANCE4_ALPHA4',
- `GL_LUMINANCE6_ALPHA2', `GL_LUMINANCE8_ALPHA8',
- `GL_LUMINANCE12_ALPHA4', `GL_LUMINANCE12_ALPHA12',
- `GL_LUMINANCE16_ALPHA16', `GL_INTENSITY', `GL_INTENSITY4',
- `GL_INTENSITY8', `GL_INTENSITY12', `GL_INTENSITY16', `GL_RGB',
- `GL_R3_G3_B2', `GL_RGB4', `GL_RGB5', `GL_RGB8', `GL_RGB10',
- `GL_RGB12', `GL_RGB16', `GL_RGBA', `GL_RGBA2', `GL_RGBA4',
- `GL_RGB5_A1', `GL_RGBA8', `GL_RGB10_A2', `GL_RGBA12', `GL_RGBA16',
- `GL_SLUMINANCE', `GL_SLUMINANCE8', `GL_SLUMINANCE_ALPHA',
- `GL_SLUMINANCE8_ALPHA8', `GL_SRGB', `GL_SRGB8', `GL_SRGB_ALPHA', or
- `GL_SRGB8_ALPHA8'.
-
-X
- Y
-
- Specify the window coordinates of the left corner of the row of
- pixels to be copied.
-
-WIDTH
- Specifies the width of the texture image. Must be 0 or
- 2^N+2\u2061(BORDER,) for some integer N. The height of the texture image
- is 1.
-
-BORDER
- Specifies the width of the border. Must be either 0 or 1.
-
-
-Description
-===========
-
-`glCopyTexImage1D' defines a one-dimensional texture image with pixels
-from the current `GL_READ_BUFFER'.
-
-The screen-aligned pixel row with left corner at (X,Y) and with a length
-of WIDTH+2\u2061(BORDER,) defines the texture array at the mipmap level
-specified by LEVEL. INTERNALFORMAT specifies the internal format of the
-texture array.
-
-The pixels in the row are processed exactly as if `glCopyPixels' had
-been called, but the process stops just before final conversion. At this
-point all pixel component values are clamped to the range [0,1] and then
-converted to the texture's internal format for storage in the texel
-array.
-
-Pixel ordering is such that lower X screen coordinates correspond to
-lower texture coordinates.
-
-If any of the pixels within the specified row of the current
-`GL_READ_BUFFER' are outside the window associated with the current
-rendering context, then the values obtained for those pixels are
-undefined.
-
-`glCopyTexImage1D' defines a one-dimensional texture image with pixels
-from the current `GL_READ_BUFFER'.
-
-When INTERNALFORMAT is one of the sRGB types, the GL does not
-automatically convert the source pixels to the sRGB color space. In this
-case, the `glPixelMap' function can be used to accomplish the
-conversion.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if TARGET is not one of the allowable
-values.
-
-`GL_INVALID_VALUE' is generated if LEVEL is less than 0.
-
-`GL_INVALID_VALUE' may be generated if LEVEL is greater than LOG_2\u2062MAX,
-where MAX is the returned value of `GL_MAX_TEXTURE_SIZE'.
-
-`GL_INVALID_VALUE' is generated if INTERNALFORMAT is not an allowable
-value.
-
-`GL_INVALID_VALUE' is generated if WIDTH is less than 0 or greater than
-2 + `GL_MAX_TEXTURE_SIZE'.
-
-`GL_INVALID_VALUE' is generated if non-power-of-two textures are not
-supported and the WIDTH cannot be represented as 2^N+2\u2061(BORDER,) for
-some integer value of N.
-
-`GL_INVALID_VALUE' is generated if BORDER is not 0 or 1.
-
-`GL_INVALID_OPERATION' is generated if `glCopyTexImage1D' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.
-
-`GL_INVALID_OPERATION' is generated if INTERNALFORMAT is
-`GL_DEPTH_COMPONENT', `GL_DEPTH_COMPONENT16', `GL_DEPTH_COMPONENT24', or
-`GL_DEPTH_COMPONENT32' and there is no depth buffer.")
-
-(define-gl-procedure
- glCopyTexImage2D
- "glCopyTexImage2D"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glCopyTexImage2D"))
- (paramdef "GLenum " (parameter "target"))
- (paramdef "GLint " (parameter "level"))
- (paramdef "GLenum " (parameter "internalformat"))
- (paramdef "GLint " (parameter "x"))
- (paramdef "GLint " (parameter "y"))
- (paramdef "GLsizei " (parameter "width"))
- (paramdef "GLsizei " (parameter "height"))
- (paramdef "GLint " (parameter "border"))))
- "copy pixels into a 2D texture image
-===================================
-
-
-Parameters
-==========
-
-TARGET
- Specifies the target texture. Must be `GL_TEXTURE_2D',
- `GL_TEXTURE_CUBE_MAP_POSITIVE_X', `GL_TEXTURE_CUBE_MAP_NEGATIVE_X',
- `GL_TEXTURE_CUBE_MAP_POSITIVE_Y', `GL_TEXTURE_CUBE_MAP_NEGATIVE_Y',
- `GL_TEXTURE_CUBE_MAP_POSITIVE_Z', or
- `GL_TEXTURE_CUBE_MAP_NEGATIVE_Z'.
-
-LEVEL
- Specifies the level-of-detail number. Level 0 is the base image
- level. Level N is the Nth mipmap reduction image.
-
-INTERNALFORMAT
- Specifies the internal format of the texture. Must be one of the
- following symbolic constants: `GL_ALPHA', `GL_ALPHA4', `GL_ALPHA8',
- `GL_ALPHA12', `GL_ALPHA16', `GL_COMPRESSED_ALPHA',
- `GL_COMPRESSED_LUMINANCE', `GL_COMPRESSED_LUMINANCE_ALPHA',
- `GL_COMPRESSED_INTENSITY', `GL_COMPRESSED_RGB',
- `GL_COMPRESSED_RGBA', `GL_DEPTH_COMPONENT', `GL_DEPTH_COMPONENT16',
- `GL_DEPTH_COMPONENT24', `GL_DEPTH_COMPONENT32', `GL_LUMINANCE',
- `GL_LUMINANCE4', `GL_LUMINANCE8', `GL_LUMINANCE12',
- `GL_LUMINANCE16', `GL_LUMINANCE_ALPHA', `GL_LUMINANCE4_ALPHA4',
- `GL_LUMINANCE6_ALPHA2', `GL_LUMINANCE8_ALPHA8',
- `GL_LUMINANCE12_ALPHA4', `GL_LUMINANCE12_ALPHA12',
- `GL_LUMINANCE16_ALPHA16', `GL_INTENSITY', `GL_INTENSITY4',
- `GL_INTENSITY8', `GL_INTENSITY12', `GL_INTENSITY16', `GL_RGB',
- `GL_R3_G3_B2', `GL_RGB4', `GL_RGB5', `GL_RGB8', `GL_RGB10',
- `GL_RGB12', `GL_RGB16', `GL_RGBA', `GL_RGBA2', `GL_RGBA4',
- `GL_RGB5_A1', `GL_RGBA8', `GL_RGB10_A2', `GL_RGBA12', `GL_RGBA16',
- `GL_SLUMINANCE', `GL_SLUMINANCE8', `GL_SLUMINANCE_ALPHA',
- `GL_SLUMINANCE8_ALPHA8', `GL_SRGB', `GL_SRGB8', `GL_SRGB_ALPHA', or
- `GL_SRGB8_ALPHA8'.
-
-X
- Y
-
- Specify the window coordinates of the lower left corner of the
- rectangular region of pixels to be copied.
-
-WIDTH
- Specifies the width of the texture image. Must be 0 or
- 2^N+2\u2061(BORDER,) for some integer N.
-
-HEIGHT
- Specifies the height of the texture image. Must be 0 or
- 2^M+2\u2061(BORDER,) for some integer M.
-
-BORDER
- Specifies the width of the border. Must be either 0 or 1.
-
-
-Description
-===========
-
-`glCopyTexImage2D' defines a two-dimensional texture image, or cube-map
-texture image with pixels from the current `GL_READ_BUFFER'.
-
-The screen-aligned pixel rectangle with lower left corner at (X, Y) and
-with a width of WIDTH+2\u2061(BORDER,) and a height of HEIGHT+2\u2061(BORDER,)
-defines the texture array at the mipmap level specified by LEVEL.
-INTERNALFORMAT specifies the internal format of the texture array.
-
-The pixels in the rectangle are processed exactly as if `glCopyPixels'
-had been called, but the process stops just before final conversion. At
-this point all pixel component values are clamped to the range [0,1] and
-then converted to the texture's internal format for storage in the texel
-array.
-
-Pixel ordering is such that lower X and Y screen coordinates correspond
-to lower S and T texture coordinates.
-
-If any of the pixels within the specified rectangle of the current
-`GL_READ_BUFFER' are outside the window associated with the current
-rendering context, then the values obtained for those pixels are
-undefined.
-
-When INTERNALFORMAT is one of the sRGB types, the GL does not
-automatically convert the source pixels to the sRGB color space. In this
-case, the `glPixelMap' function can be used to accomplish the
-conversion.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if TARGET is not `GL_TEXTURE_2D',
-`GL_TEXTURE_CUBE_MAP_POSITIVE_X', `GL_TEXTURE_CUBE_MAP_NEGATIVE_X',
-`GL_TEXTURE_CUBE_MAP_POSITIVE_Y', `GL_TEXTURE_CUBE_MAP_NEGATIVE_Y',
-`GL_TEXTURE_CUBE_MAP_POSITIVE_Z', or `GL_TEXTURE_CUBE_MAP_NEGATIVE_Z'.
-
-`GL_INVALID_VALUE' is generated if LEVEL is less than 0.
-
-`GL_INVALID_VALUE' may be generated if LEVEL is greater than LOG_2\u2062MAX,
-where MAX is the returned value of `GL_MAX_TEXTURE_SIZE'.
-
-`GL_INVALID_VALUE' is generated if WIDTH is less than 0 or greater than
-2 + `GL_MAX_TEXTURE_SIZE'.
-
-`GL_INVALID_VALUE' is generated if non-power-of-two textures are not
-supported and the WIDTH or DEPTH cannot be represented as
-2^K+2\u2061(BORDER,) for some integer K.
-
-`GL_INVALID_VALUE' is generated if BORDER is not 0 or 1.
-
-`GL_INVALID_VALUE' is generated if INTERNALFORMAT is not an accepted
-format.
-
-`GL_INVALID_OPERATION' is generated if `glCopyTexImage2D' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.
-
-`GL_INVALID_OPERATION' is generated if INTERNALFORMAT is
-`GL_DEPTH_COMPONENT', `GL_DEPTH_COMPONENT16', `GL_DEPTH_COMPONENT24', or
-`GL_DEPTH_COMPONENT32' and there is no depth buffer.")
-
-(define-gl-procedure
- glCopyTexSubImage1D
- "glCopyTexSubImage1D"
- (funcsynopsis
- (funcprototype
- (funcdef
- "void "
- (function "glCopyTexSubImage1D"))
- (paramdef "GLenum " (parameter "target"))
- (paramdef "GLint " (parameter "level"))
- (paramdef "GLint " (parameter "xoffset"))
- (paramdef "GLint " (parameter "x"))
- (paramdef "GLint " (parameter "y"))
- (paramdef "GLsizei " (parameter "width"))))
- "copy a one-dimensional texture subimage
-=======================================
-
-
-Parameters
-==========
-
-TARGET
- Specifies the target texture. Must be `GL_TEXTURE_1D'.
-
-LEVEL
- Specifies the level-of-detail number. Level 0 is the base image
- level. Level N is the Nth mipmap reduction image.
-
-XOFFSET
- Specifies the texel offset within the texture array.
-
-X
- Y
-
- Specify the window coordinates of the left corner of the row of
- pixels to be copied.
-
-WIDTH
- Specifies the width of the texture subimage.
-
-
-Description
-===========
-
-`glCopyTexSubImage1D' replaces a portion of a one-dimensional texture
-image with pixels from the current `GL_READ_BUFFER' (rather than from
-main memory, as is the case for `glTexSubImage1D').
-
-The screen-aligned pixel row with left corner at (X,\\ Y), and with
-length WIDTH replaces the portion of the texture array with x indices
-XOFFSET through XOFFSET+WIDTH-1, inclusive. The destination in the
-texture array may not include any texels outside the texture array as it
-was originally specified.
-
-The pixels in the row are processed exactly as if `glCopyPixels' had
-been called, but the process stops just before final conversion. At this
-point, all pixel component values are clamped to the range [0,1] and
-then converted to the texture's internal format for storage in the texel
-array.
-
-It is not an error to specify a subtexture with zero width, but such a
-specification has no effect. If any of the pixels within the specified
-row of the current `GL_READ_BUFFER' are outside the read window
-associated with the current rendering context, then the values obtained
-for those pixels are undefined.
-
-No change is made to the INTERNALFORMAT, WIDTH, or BORDER parameters of
-the specified texture array or to texel values outside the specified
-subregion.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if /TARGET is not `GL_TEXTURE_1D'.
-
-`GL_INVALID_OPERATION' is generated if the texture array has not been
-defined by a previous `glTexImage1D' or `glCopyTexImage1D' operation.
-
-`GL_INVALID_VALUE' is generated if LEVEL is less than 0.
-
-`GL_INVALID_VALUE' may be generated if LEVEL>LOG_2\u2061(MAX,), where MAX is
-the returned value of `GL_MAX_TEXTURE_SIZE'.
-
-`GL_INVALID_VALUE' is generated if XOFFSET<-B, or
-(XOFFSET+WIDTH,)>(W-B,), where W is the `GL_TEXTURE_WIDTH' and B is the
-`GL_TEXTURE_BORDER' of the texture image being modified. Note that W
-includes twice the border width.")
-
-(define-gl-procedure
- glCopyTexSubImage2D
- "glCopyTexSubImage2D"
- (funcsynopsis
- (funcprototype
- (funcdef
- "void "
- (function "glCopyTexSubImage2D"))
- (paramdef "GLenum " (parameter "target"))
- (paramdef "GLint " (parameter "level"))
- (paramdef "GLint " (parameter "xoffset"))
- (paramdef "GLint " (parameter "yoffset"))
- (paramdef "GLint " (parameter "x"))
- (paramdef "GLint " (parameter "y"))
- (paramdef "GLsizei " (parameter "width"))
- (paramdef "GLsizei " (parameter "height"))))
- "copy a two-dimensional texture subimage
-=======================================
-
-
-Parameters
-==========
-
-TARGET
- Specifies the target texture. Must be `GL_TEXTURE_2D',
- `GL_TEXTURE_CUBE_MAP_POSITIVE_X', `GL_TEXTURE_CUBE_MAP_NEGATIVE_X',
- `GL_TEXTURE_CUBE_MAP_POSITIVE_Y', `GL_TEXTURE_CUBE_MAP_NEGATIVE_Y',
- `GL_TEXTURE_CUBE_MAP_POSITIVE_Z', or
- `GL_TEXTURE_CUBE_MAP_NEGATIVE_Z'.
-
-LEVEL
- Specifies the level-of-detail number. Level 0 is the base image
- level. Level N is the Nth mipmap reduction image.
-
-XOFFSET
- Specifies a texel offset in the x direction within the texture
- array.
-
-YOFFSET
- Specifies a texel offset in the y direction within the texture
- array.
-
-X
- Y
-
- Specify the window coordinates of the lower left corner of the
- rectangular region of pixels to be copied.
-
-WIDTH
- Specifies the width of the texture subimage.
-
-HEIGHT
- Specifies the height of the texture subimage.
-
-
-Description
-===========
-
-`glCopyTexSubImage2D' replaces a rectangular portion of a
-two-dimensional texture image or cube-map texture image with pixels from
-the current `GL_READ_BUFFER' (rather than from main memory, as is the
-case for `glTexSubImage2D').
-
-The screen-aligned pixel rectangle with lower left corner at (X,Y) and
-with width WIDTH and height HEIGHT replaces the portion of the texture
-array with x indices XOFFSET through XOFFSET+WIDTH-1, inclusive, and y
-indices YOFFSET through YOFFSET+HEIGHT-1, inclusive, at the mipmap level
-specified by LEVEL.
-
-The pixels in the rectangle are processed exactly as if `glCopyPixels'
-had been called, but the process stops just before final conversion. At
-this point, all pixel component values are clamped to the range [0,1]
-and then converted to the texture's internal format for storage in the
-texel array.
-
-The destination rectangle in the texture array may not include any
-texels outside the texture array as it was originally specified. It is
-not an error to specify a subtexture with zero width or height, but such
-a specification has no effect.
-
-If any of the pixels within the specified rectangle of the current
-`GL_READ_BUFFER' are outside the read window associated with the current
-rendering context, then the values obtained for those pixels are
-undefined.
-
-No change is made to the INTERNALFORMAT, WIDTH, HEIGHT, or BORDER
-parameters of the specified texture array or to texel values outside the
-specified subregion.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if TARGET is not `GL_TEXTURE_2D',
-`GL_TEXTURE_CUBE_MAP_POSITIVE_X', `GL_TEXTURE_CUBE_MAP_NEGATIVE_X',
-`GL_TEXTURE_CUBE_MAP_POSITIVE_Y', `GL_TEXTURE_CUBE_MAP_NEGATIVE_Y',
-`GL_TEXTURE_CUBE_MAP_POSITIVE_Z', or `GL_TEXTURE_CUBE_MAP_NEGATIVE_Z'.
-
-`GL_INVALID_OPERATION' is generated if the texture array has not been
-defined by a previous `glTexImage2D' or `glCopyTexImage2D' operation.
-
-`GL_INVALID_VALUE' is generated if LEVEL is less than 0.
-
-`GL_INVALID_VALUE' may be generated if LEVEL>LOG_2\u2061(MAX,), where MAX is
-the returned value of `GL_MAX_TEXTURE_SIZE'.
-
-`GL_INVALID_VALUE' is generated if XOFFSET<-B, (XOFFSET+WIDTH,)>(W-B,),
-YOFFSET<-B, or (YOFFSET+HEIGHT,)>(H-B,), where W is the
-`GL_TEXTURE_WIDTH', H is the `GL_TEXTURE_HEIGHT', and B is the
-`GL_TEXTURE_BORDER' of the texture image being modified. Note that W and
-H include twice the border width.
-
-`GL_INVALID_OPERATION' is generated if `glCopyTexSubImage2D' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glCopyTexSubImage3D
- "glCopyTexSubImage3D"
- (funcsynopsis
- (funcprototype
- (funcdef
- "void "
- (function "glCopyTexSubImage3D"))
- (paramdef "GLenum " (parameter "target"))
- (paramdef "GLint " (parameter "level"))
- (paramdef "GLint " (parameter "xoffset"))
- (paramdef "GLint " (parameter "yoffset"))
- (paramdef "GLint " (parameter "zoffset"))
- (paramdef "GLint " (parameter "x"))
- (paramdef "GLint " (parameter "y"))
- (paramdef "GLsizei " (parameter "width"))
- (paramdef "GLsizei " (parameter "height"))))
- "copy a three-dimensional texture subimage
-=========================================
-
-
-Parameters
-==========
-
-TARGET
- Specifies the target texture. Must be `GL_TEXTURE_3D'
-
-LEVEL
- Specifies the level-of-detail number. Level 0 is the base image
- level. Level N is the Nth mipmap reduction image.
-
-XOFFSET
- Specifies a texel offset in the x direction within the texture
- array.
-
-YOFFSET
- Specifies a texel offset in the y direction within the texture
- array.
-
-ZOFFSET
- Specifies a texel offset in the z direction within the texture
- array.
-
-X
- Y
-
- Specify the window coordinates of the lower left corner of the
- rectangular region of pixels to be copied.
-
-WIDTH
- Specifies the width of the texture subimage.
-
-HEIGHT
- Specifies the height of the texture subimage.
-
-
-Description
-===========
-
-`glCopyTexSubImage3D' replaces a rectangular portion of a
-three-dimensional texture image with pixels from the current
-`GL_READ_BUFFER' (rather than from main memory, as is the case for
-`glTexSubImage3D').
-
-The screen-aligned pixel rectangle with lower left corner at (X,\\ Y) and
-with width WIDTH and height HEIGHT replaces the portion of the texture
-array with x indices XOFFSET through XOFFSET+WIDTH-1, inclusive, and y
-indices YOFFSET through YOFFSET+HEIGHT-1, inclusive, at z index ZOFFSET
-and at the mipmap level specified by LEVEL.
-
-The pixels in the rectangle are processed exactly as if `glCopyPixels'
-had been called, but the process stops just before final conversion. At
-this point, all pixel component values are clamped to the range [0,1]
-and then converted to the texture's internal format for storage in the
-texel array.
-
-The destination rectangle in the texture array may not include any
-texels outside the texture array as it was originally specified. It is
-not an error to specify a subtexture with zero width or height, but such
-a specification has no effect.
-
-If any of the pixels within the specified rectangle of the current
-`GL_READ_BUFFER' are outside the read window associated with the current
-rendering context, then the values obtained for those pixels are
-undefined.
-
-No change is made to the INTERNALFORMAT, WIDTH, HEIGHT, DEPTH, or BORDER
-parameters of the specified texture array or to texel values outside the
-specified subregion.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if /TARGET is not `GL_TEXTURE_3D'.
-
-`GL_INVALID_OPERATION' is generated if the texture array has not been
-defined by a previous `glTexImage3D' operation.
-
-`GL_INVALID_VALUE' is generated if LEVEL is less than 0.
-
-`GL_INVALID_VALUE' may be generated if LEVEL>LOG_2\u2061(MAX,), where MAX is
-the returned value of `GL_MAX_3D_TEXTURE_SIZE'.
-
-`GL_INVALID_VALUE' is generated if XOFFSET<-B, (XOFFSET+WIDTH,)>(W-B,),
-YOFFSET<-B, (YOFFSET+HEIGHT,)>(H-B,), ZOFFSET<-B, or
-(ZOFFSET+1,)>(D-B,), where W is the `GL_TEXTURE_WIDTH', H is the
-`GL_TEXTURE_HEIGHT', D is the `GL_TEXTURE_DEPTH', and B is the
-`GL_TEXTURE_BORDER' of the texture image being modified. Note that W, H,
-and D include twice the border width.
-
-`GL_INVALID_OPERATION' is generated if `glCopyTexSubImage3D' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glCreateProgram
- "glCreateProgram"
- (funcsynopsis
- (funcprototype
- (funcdef "GLuint " (function "glCreateProgram"))
- (paramdef (parameter "void"))))
- "Creates a program object
-========================
-
-
-Description
-===========
-
-`glCreateProgram' creates an empty program object and returns a non-zero
-value by which it can be referenced. A program object is an object to
-which shader objects can be attached. This provides a mechanism to
-specify the shader objects that will be linked to create a program. It
-also provides a means for checking the compatibility of the shaders that
-will be used to create a program (for instance, checking the
-compatibility between a vertex shader and a fragment shader). When no
-longer needed as part of a program object, shader objects can be
-detached.
-
-One or more executables are created in a program object by successfully
-attaching shader objects to it with `glAttachShader', successfully
-compiling the shader objects with `glCompileShader', and successfully
-linking the program object with `glLinkProgram'. These executables are
-made part of current state when `glUseProgram' is called. Program
-objects can be deleted by calling `glDeleteProgram'. The memory
-associated with the program object will be deleted when it is no longer
-part of current rendering state for any context.
-
-
-Errors
-======
-
-This function returns 0 if an error occurs creating the program object.
-
-`GL_INVALID_OPERATION' is generated if `glCreateProgram' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glCreateShader
- "glCreateShader"
- (funcsynopsis
- (funcprototype
- (funcdef "GLuint " (function "glCreateShader"))
- (paramdef "GLenum " (parameter "shaderType"))))
- "Creates a shader object
-=======================
-
-
-Parameters
-==========
-
-SHADERTYPE
- Specifies the type of shader to be created. Must be either
- `GL_VERTEX_SHADER' or `GL_FRAGMENT_SHADER'.
-
-
-Description
-===========
-
-`glCreateShader' creates an empty shader object and returns a non-zero
-value by which it can be referenced. A shader object is used to maintain
-the source code strings that define a shader. SHADERTYPE indicates the
-type of shader to be created. Two types of shaders are supported. A
-shader of type `GL_VERTEX_SHADER' is a shader that is intended to run on
-the programmable vertex processor and replace the fixed functionality
-vertex processing in OpenGL. A shader of type `GL_FRAGMENT_SHADER' is a
-shader that is intended to run on the programmable fragment processor
-and replace the fixed functionality fragment processing in OpenGL.
-
-When created, a shader object's `GL_SHADER_TYPE' parameter is set to
-either `GL_VERTEX_SHADER' or `GL_FRAGMENT_SHADER', depending on the
-value of SHADERTYPE.
-
-
-Errors
-======
-
-This function returns 0 if an error occurs creating the shader object.
-
-`GL_INVALID_ENUM' is generated if SHADERTYPE is not an accepted value.
-
-`GL_INVALID_OPERATION' is generated if `glCreateShader' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glCullFace
- "glCullFace"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glCullFace"))
- (paramdef "GLenum " (parameter "mode"))))
- "specify whether front- or back-facing facets can be culled
-==========================================================
-
-
-Parameters
-==========
-
-MODE
- Specifies whether front- or back-facing facets are candidates for
- culling. Symbolic constants `GL_FRONT', `GL_BACK', and
- `GL_FRONT_AND_BACK' are accepted. The initial value is `GL_BACK'.
-
-
-Description
-===========
-
-`glCullFace' specifies whether front- or back-facing facets are culled
-(as specified by MODE) when facet culling is enabled. Facet culling is
-initially disabled. To enable and disable facet culling, call the
-`glEnable' and `glDisable' commands with the argument `GL_CULL_FACE'.
-Facets include triangles, quadrilaterals, polygons, and rectangles.
-
-`glFrontFace' specifies which of the clockwise and counterclockwise
-facets are front-facing and back-facing. See `glFrontFace'.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if MODE is not an accepted value.
-
-`GL_INVALID_OPERATION' is generated if `glCullFace' is executed between
-the execution of `glBegin' and the corresponding execution of `glEnd'.")
-
-(define-gl-procedure
- glDeleteBuffers
- "glDeleteBuffers"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glDeleteBuffers"))
- (paramdef "GLsizei " (parameter "n"))
- (paramdef
- "const GLuint * "
- (parameter "buffers"))))
- "delete named buffer objects
-===========================
-
-
-Parameters
-==========
-
-N
- Specifies the number of buffer objects to be deleted.
-
-BUFFERS
- Specifies an array of buffer objects to be deleted.
-
-
-Description
-===========
-
-`glDeleteBuffers' deletes N buffer objects named by the elements of the
-array BUFFERS. After a buffer object is deleted, it has no contents, and
-its name is free for reuse (for example by `glGenBuffers'). If a buffer
-object that is currently bound is deleted, the binding reverts to 0 (the
-absence of any buffer object, which reverts to client memory usage).
-
-`glDeleteBuffers' silently ignores 0's and names that do not correspond
-to existing buffer objects.
-
-
-Errors
-======
-
-`GL_INVALID_VALUE' is generated if N is negative.
-
-`GL_INVALID_OPERATION' is generated if `glDeleteBuffers' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glDeleteLists
- "glDeleteLists"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glDeleteLists"))
- (paramdef "GLuint " (parameter "list"))
- (paramdef "GLsizei " (parameter "range"))))
- "delete a contiguous group of display lists
-==========================================
-
-
-Parameters
-==========
-
-LIST
- Specifies the integer name of the first display list to delete.
-
-RANGE
- Specifies the number of display lists to delete.
-
-
-Description
-===========
-
-`glDeleteLists' causes a contiguous group of display lists to be
-deleted. LIST is the name of the first display list to be deleted, and
-RANGE is the number of display lists to delete. All display lists D with
-LIST<=D<=LIST+RANGE-1 are deleted.
-
-All storage locations allocated to the specified display lists are
-freed, and the names are available for reuse at a later time. Names
-within the range that do not have an associated display list are
-ignored. If RANGE is 0, nothing happens.
-
-
-Errors
-======
-
-`GL_INVALID_VALUE' is generated if RANGE is negative.
-
-`GL_INVALID_OPERATION' is generated if `glDeleteLists' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glDeleteProgram
- "glDeleteProgram"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glDeleteProgram"))
- (paramdef "GLuint " (parameter "program"))))
- "Deletes a program object
-========================
-
-
-Parameters
-==========
-
-PROGRAM
- Specifies the program object to be deleted.
-
-
-Description
-===========
-
-`glDeleteProgram' frees the memory and invalidates the name associated
-with the program object specified by PROGRAM. This command effectively
-undoes the effects of a call to `glCreateProgram'.
-
-If a program object is in use as part of current rendering state, it
-will be flagged for deletion, but it will not be deleted until it is no
-longer part of current state for any rendering context. If a program
-object to be deleted has shader objects attached to it, those shader
-objects will be automatically detached but not deleted unless they have
-already been flagged for deletion by a previous call to
-`glDeleteShader'. A value of 0 for PROGRAM will be silently ignored.
-
-To determine whether a program object has been flagged for deletion,
-call `glGetProgram' with arguments PROGRAM and `GL_DELETE_STATUS'.
-
-
-Errors
-======
-
-`GL_INVALID_VALUE' is generated if PROGRAM is not a value generated by
-OpenGL.
-
-`GL_INVALID_OPERATION' is generated if `glDeleteProgram' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glDeleteQueries
- "glDeleteQueries"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glDeleteQueries"))
- (paramdef "GLsizei " (parameter "n"))
- (paramdef "const GLuint * " (parameter "ids"))))
- "delete named query objects
-==========================
-
-
-Parameters
-==========
-
-N
- Specifies the number of query objects to be deleted.
-
-IDS
- Specifies an array of query objects to be deleted.
-
-
-Description
-===========
-
-`glDeleteQueries' deletes N query objects named by the elements of the
-array IDS. After a query object is deleted, it has no contents, and its
-name is free for reuse (for example by `glGenQueries').
-
-`glDeleteQueries' silently ignores 0's and names that do not correspond
-to existing query objects.
-
-
-Errors
-======
-
-`GL_INVALID_VALUE' is generated if N is negative.
-
-`GL_INVALID_OPERATION' is generated if `glDeleteQueries' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glDeleteShader
- "glDeleteShader"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glDeleteShader"))
- (paramdef "GLuint " (parameter "shader"))))
- "Deletes a shader object
-=======================
-
-
-Parameters
-==========
-
-SHADER
- Specifies the shader object to be deleted.
-
-
-Description
-===========
-
-`glDeleteShader' frees the memory and invalidates the name associated
-with the shader object specified by SHADER. This command effectively
-undoes the effects of a call to `glCreateShader'.
-
-If a shader object to be deleted is attached to a program object, it
-will be flagged for deletion, but it will not be deleted until it is no
-longer attached to any program object, for any rendering context (i.e.,
-it must be detached from wherever it was attached before it will be
-deleted). A value of 0 for SHADER will be silently ignored.
-
-To determine whether an object has been flagged for deletion, call
-`glGetShader' with arguments SHADER and `GL_DELETE_STATUS'.
-
-
-Errors
-======
-
-`GL_INVALID_VALUE' is generated if SHADER is not a value generated by
-OpenGL.
-
-`GL_INVALID_OPERATION' is generated if `glDeleteShader' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glDeleteTextures
- "glDeleteTextures"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glDeleteTextures"))
- (paramdef "GLsizei " (parameter "n"))
- (paramdef
- "const GLuint * "
- (parameter "textures"))))
- "delete named textures
-=====================
-
-
-Parameters
-==========
-
-N
- Specifies the number of textures to be deleted.
-
-TEXTURES
- Specifies an array of textures to be deleted.
-
-
-Description
-===========
-
-`glDeleteTextures' deletes N textures named by the elements of the array
-TEXTURES. After a texture is deleted, it has no contents or
-dimensionality, and its name is free for reuse (for example by
-`glGenTextures'). If a texture that is currently bound is deleted, the
-binding reverts to 0 (the default texture).
-
-`glDeleteTextures' silently ignores 0's and names that do not correspond
-to existing textures.
-
-
-Errors
-======
-
-`GL_INVALID_VALUE' is generated if N is negative.
-
-`GL_INVALID_OPERATION' is generated if `glDeleteTextures' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glDepthFunc
- "glDepthFunc"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glDepthFunc"))
- (paramdef "GLenum " (parameter "func"))))
- "specify the value used for depth buffer comparisons
-===================================================
-
-
-Parameters
-==========
-
-FUNC
- Specifies the depth comparison function. Symbolic constants
- `GL_NEVER', `GL_LESS', `GL_EQUAL', `GL_LEQUAL', `GL_GREATER',
- `GL_NOTEQUAL', `GL_GEQUAL', and `GL_ALWAYS' are accepted. The
- initial value is `GL_LESS'.
-
-
-Description
-===========
-
-`glDepthFunc' specifies the function used to compare each incoming pixel
-depth value with the depth value present in the depth buffer. The
-comparison is performed only if depth testing is enabled. (See
-`glEnable' and `glDisable' of `GL_DEPTH_TEST'.)
-
-FUNC specifies the conditions under which the pixel will be drawn. The
-comparison functions are as follows:
-
-`GL_NEVER'
- Never passes.
-
-`GL_LESS'
- Passes if the incoming depth value is less than the stored depth
- value.
-
-`GL_EQUAL'
- Passes if the incoming depth value is equal to the stored depth
- value.
-
-`GL_LEQUAL'
- Passes if the incoming depth value is less than or equal to the
- stored depth value.
-
-`GL_GREATER'
- Passes if the incoming depth value is greater than the stored depth
- value.
-
-`GL_NOTEQUAL'
- Passes if the incoming depth value is not equal to the stored depth
- value.
-
-`GL_GEQUAL'
- Passes if the incoming depth value is greater than or equal to the
- stored depth value.
-
-`GL_ALWAYS'
- Always passes.
-
-The initial value of FUNC is `GL_LESS'. Initially, depth testing is
-disabled. If depth testing is disabled or if no depth buffer exists, it
-is as if the depth test always passes.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if FUNC is not an accepted value.
-
-`GL_INVALID_OPERATION' is generated if `glDepthFunc' is executed between
-the execution of `glBegin' and the corresponding execution of `glEnd'.")
-
-(define-gl-procedure
- glDepthMask
- "glDepthMask"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glDepthMask"))
- (paramdef "GLboolean " (parameter "flag"))))
- "enable or disable writing into the depth buffer
-===============================================
-
-
-Parameters
-==========
-
-FLAG
- Specifies whether the depth buffer is enabled for writing. If FLAG
- is `GL_FALSE', depth buffer writing is disabled. Otherwise, it is
- enabled. Initially, depth buffer writing is enabled.
-
-
-Description
-===========
-
-`glDepthMask' specifies whether the depth buffer is enabled for writing.
-If FLAG is `GL_FALSE', depth buffer writing is disabled. Otherwise, it
-is enabled. Initially, depth buffer writing is enabled.
-
-
-Errors
-======
-
-`GL_INVALID_OPERATION' is generated if `glDepthMask' is executed between
-the execution of `glBegin' and the corresponding execution of `glEnd'.")
-
-(define-gl-procedure
- glDepthRange
- "glDepthRange"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glDepthRange"))
- (paramdef "GLclampd " (parameter "nearVal"))
- (paramdef "GLclampd " (parameter "farVal"))))
- "specify mapping of depth values from normalized device coordinates to window coordinates
-========================================================================================
-
-
-Parameters
-==========
-
-NEARVAL
- Specifies the mapping of the near clipping plane to window
- coordinates. The initial value is 0.
-
-FARVAL
- Specifies the mapping of the far clipping plane to window
- coordinates. The initial value is 1.
-
-
-Description
-===========
-
-After clipping and division by W, depth coordinates range from -1 to 1,
-corresponding to the near and far clipping planes. `glDepthRange'
-specifies a linear mapping of the normalized depth coordinates in this
-range to window depth coordinates. Regardless of the actual depth buffer
-implementation, window coordinate depth values are treated as though
-they range from 0 through 1 (like color components). Thus, the values
-accepted by `glDepthRange' are both clamped to this range before they
-are accepted.
-
-The setting of (0,1) maps the near plane to 0 and the far plane to 1.
-With this mapping, the depth buffer range is fully utilized.
-
-
-Errors
-======
-
-`GL_INVALID_OPERATION' is generated if `glDepthRange' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glDetachShader
- "glDetachShader"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glDetachShader"))
- (paramdef "GLuint " (parameter "program"))
- (paramdef "GLuint " (parameter "shader"))))
- "Detaches a shader object from a program object to which it is attached
-======================================================================
-
-
-Parameters
-==========
-
-PROGRAM
- Specifies the program object from which to detach the shader
- object.
-
-SHADER
- Specifies the shader object to be detached.
-
-
-Description
-===========
-
-`glDetachShader' detaches the shader object specified by SHADER from the
-program object specified by PROGRAM. This command can be used to undo
-the effect of the command `glAttachShader'.
-
-If SHADER has already been flagged for deletion by a call to
-`glDeleteShader' and it is not attached to any other program object, it
-will be deleted after it has been detached.
-
-
-Errors
-======
-
-`GL_INVALID_VALUE' is generated if either PROGRAM or SHADER is a value
-that was not generated by OpenGL.
-
-`GL_INVALID_OPERATION' is generated if PROGRAM is not a program object.
-
-`GL_INVALID_OPERATION' is generated if SHADER is not a shader object.
-
-`GL_INVALID_OPERATION' is generated if SHADER is not attached to
-PROGRAM.
-
-`GL_INVALID_OPERATION' is generated if `glDetachShader' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glDrawArrays
- "glDrawArrays"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glDrawArrays"))
- (paramdef "GLenum " (parameter "mode"))
- (paramdef "GLint " (parameter "first"))
- (paramdef "GLsizei " (parameter "count"))))
- "render primitives from array data
-=================================
-
-
-Parameters
-==========
-
-MODE
- Specifies what kind of primitives to render. Symbolic constants
- `GL_POINTS', `GL_LINE_STRIP', `GL_LINE_LOOP', `GL_LINES',
- `GL_TRIANGLE_STRIP', `GL_TRIANGLE_FAN', `GL_TRIANGLES',
- `GL_QUAD_STRIP', `GL_QUADS', and `GL_POLYGON' are accepted.
-
-FIRST
- Specifies the starting index in the enabled arrays.
-
-COUNT
- Specifies the number of indices to be rendered.
-
-
-Description
-===========
-
-`glDrawArrays' specifies multiple geometric primitives with very few
-subroutine calls. Instead of calling a GL procedure to pass each
-individual vertex, normal, texture coordinate, edge flag, or color, you
-can prespecify separate arrays of vertices, normals, and colors and use
-them to construct a sequence of primitives with a single call to
-`glDrawArrays'.
-
-When `glDrawArrays' is called, it uses COUNT sequential elements from
-each enabled array to construct a sequence of geometric primitives,
-beginning with element FIRST. MODE specifies what kind of primitives are
-constructed and how the array elements construct those primitives. If
-`GL_VERTEX_ARRAY' is not enabled, no geometric primitives are generated.
-
-Vertex attributes that are modified by `glDrawArrays' have an
-unspecified value after `glDrawArrays' returns. For example, if
-`GL_COLOR_ARRAY' is enabled, the value of the current color is undefined
-after `glDrawArrays' executes. Attributes that aren't modified remain
-well defined.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if MODE is not an accepted value.
-
-`GL_INVALID_VALUE' is generated if COUNT is negative.
-
-`GL_INVALID_OPERATION' is generated if a non-zero buffer object name is
-bound to an enabled array and the buffer object's data store is
-currently mapped.
-
-`GL_INVALID_OPERATION' is generated if `glDrawArrays' is executed
-between the execution of `glBegin' and the corresponding `glEnd'.")
-
-(define-gl-procedure
- glDrawBuffers
- "glDrawBuffers"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glDrawBuffers"))
- (paramdef "GLsizei " (parameter "n"))
- (paramdef "const GLenum *" (parameter "bufs"))))
- "Specifies a list of color buffers to be drawn into
-==================================================
-
-
-Parameters
-==========
-
-N
- Specifies the number of buffers in BUFS.
-
-BUFS
- Points to an array of symbolic constants specifying the buffers
- into which fragment colors or data values will be written.
-
-
-Description
-===========
-
-`glDrawBuffers' defines an array of buffers into which fragment color
-values or fragment data will be written. If no fragment shader is
-active, rendering operations will generate only one fragment color per
-fragment and it will be written into each of the buffers specified by
-BUFS. If a fragment shader is active and it writes a value to the output
-variable `gl_FragColor', then that value will be written into each of
-the buffers specified by BUFS. If a fragment shader is active and it
-writes a value to one or more elements of the output array variable
-`gl_FragData[]', then the value of `gl_FragData[0] ' will be written
-into the first buffer specified by BUFS, the value of `gl_FragData[1] '
-will be written into the second buffer specified by BUFS, and so on up
-to `gl_FragData[n-1]'. The draw buffer used for `gl_FragData[n]' and
-beyond is implicitly set to be `GL_NONE'.
-
-The symbolic constants contained in BUFS may be any of the following:
-
-`GL_NONE'
- The fragment color/data value is not written into any color buffer.
-
-`GL_FRONT_LEFT'
- The fragment color/data value is written into the front left color
- buffer.
-
-`GL_FRONT_RIGHT'
- The fragment color/data value is written into the front right color
- buffer.
-
-`GL_BACK_LEFT'
- The fragment color/data value is written into the back left color
- buffer.
-
-`GL_BACK_RIGHT'
- The fragment color/data value is written into the back right color
- buffer.
-
-`GL_AUXi'
- The fragment color/data value is written into auxiliary buffer `i'.
-
-Except for `GL_NONE', the preceding symbolic constants may not appear
-more than once in BUFS. The maximum number of draw buffers supported is
-implementation dependent and can be queried by calling `glGet' with the
-argument `GL_MAX_DRAW_BUFFERS'. The number of auxiliary buffers can be
-queried by calling `glGet' with the argument `GL_AUX_BUFFERS'.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if one of the values in BUFS is not an
-accepted value.
-
-`GL_INVALID_ENUM' is generated if N is less than 0.
-
-`GL_INVALID_OPERATION' is generated if a symbolic constant other than
-`GL_NONE' appears more than once in BUFS.
-
-`GL_INVALID_OPERATION' is generated if any of the entries in BUFS (other
-than `GL_NONE' ) indicates a color buffer that does not exist in the
-current GL context.
-
-`GL_INVALID_VALUE' is generated if N is greater than
-`GL_MAX_DRAW_BUFFERS'.
-
-`GL_INVALID_OPERATION' is generated if `glDrawBuffers' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glDrawBuffer
- "glDrawBuffer"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glDrawBuffer"))
- (paramdef "GLenum " (parameter "mode"))))
- "specify which color buffers are to be drawn into
-================================================
-
-
-Parameters
-==========
-
-MODE
- Specifies up to four color buffers to be drawn into. Symbolic
- constants `GL_NONE', `GL_FRONT_LEFT', `GL_FRONT_RIGHT',
- `GL_BACK_LEFT', `GL_BACK_RIGHT', `GL_FRONT', `GL_BACK', `GL_LEFT',
- `GL_RIGHT', `GL_FRONT_AND_BACK', and `GL_AUX'I, where I is between
- 0 and the value of `GL_AUX_BUFFERS' minus 1, are accepted.
- (`GL_AUX_BUFFERS' is not the upper limit; use `glGet' to query the
- number of available aux buffers.) The initial value is `GL_FRONT'
- for single-buffered contexts, and `GL_BACK' for double-buffered
- contexts.
-
-
-Description
-===========
-
-When colors are written to the frame buffer, they are written into the
-color buffers specified by `glDrawBuffer'. The specifications are as
-follows:
-
-`GL_NONE'
- No color buffers are written.
-
-`GL_FRONT_LEFT'
- Only the front left color buffer is written.
-
-`GL_FRONT_RIGHT'
- Only the front right color buffer is written.
-
-`GL_BACK_LEFT'
- Only the back left color buffer is written.
-
-`GL_BACK_RIGHT'
- Only the back right color buffer is written.
-
-`GL_FRONT'
- Only the front left and front right color buffers are written. If
- there is no front right color buffer, only the front left color
- buffer is written.
-
-`GL_BACK'
- Only the back left and back right color buffers are written. If
- there is no back right color buffer, only the back left color
- buffer is written.
-
-`GL_LEFT'
- Only the front left and back left color buffers are written. If
- there is no back left color buffer, only the front left color
- buffer is written.
-
-`GL_RIGHT'
- Only the front right and back right color buffers are written. If
- there is no back right color buffer, only the front right color
- buffer is written.
-
-`GL_FRONT_AND_BACK'
- All the front and back color buffers (front left, front right, back
- left, back right) are written. If there are no back color buffers,
- only the front left and front right color buffers are written. If
- there are no right color buffers, only the front left and back left
- color buffers are written. If there are no right or back color
- buffers, only the front left color buffer is written.
-
-`GL_AUX'I
- Only auxiliary color buffer I is written.
-
-If more than one color buffer is selected for drawing, then blending or
-logical operations are computed and applied independently for each color
-buffer and can produce different results in each buffer.
-
-Monoscopic contexts include only LEFT buffers, and stereoscopic contexts
-include both LEFT and RIGHT buffers. Likewise, single-buffered contexts
-include only FRONT buffers, and double-buffered contexts include both
-FRONT and BACK buffers. The context is selected at GL initialization.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if MODE is not an accepted value.
-
-`GL_INVALID_OPERATION' is generated if none of the buffers indicated by
-MODE exists.
-
-`GL_INVALID_OPERATION' is generated if `glDrawBuffer' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glDrawElements
- "glDrawElements"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glDrawElements"))
- (paramdef "GLenum " (parameter "mode"))
- (paramdef "GLsizei " (parameter "count"))
- (paramdef "GLenum " (parameter "type"))
- (paramdef
- "const GLvoid * "
- (parameter "indices"))))
- "render primitives from array data
-=================================
-
-
-Parameters
-==========
-
-MODE
- Specifies what kind of primitives to render. Symbolic constants
- `GL_POINTS', `GL_LINE_STRIP', `GL_LINE_LOOP', `GL_LINES',
- `GL_TRIANGLE_STRIP', `GL_TRIANGLE_FAN', `GL_TRIANGLES',
- `GL_QUAD_STRIP', `GL_QUADS', and `GL_POLYGON' are accepted.
-
-COUNT
- Specifies the number of elements to be rendered.
-
-TYPE
- Specifies the type of the values in INDICES. Must be one of
- `GL_UNSIGNED_BYTE', `GL_UNSIGNED_SHORT', or `GL_UNSIGNED_INT'.
-
-INDICES
- Specifies a pointer to the location where the indices are stored.
-
-
-Description
-===========
-
-`glDrawElements' specifies multiple geometric primitives with very few
-subroutine calls. Instead of calling a GL function to pass each
-individual vertex, normal, texture coordinate, edge flag, or color, you
-can prespecify separate arrays of vertices, normals, and so on, and use
-them to construct a sequence of primitives with a single call to
-`glDrawElements'.
-
-When `glDrawElements' is called, it uses COUNT sequential elements from
-an enabled array, starting at INDICES to construct a sequence of
-geometric primitives. MODE specifies what kind of primitives are
-constructed and how the array elements construct these primitives. If
-more than one array is enabled, each is used. If `GL_VERTEX_ARRAY' is
-not enabled, no geometric primitives are constructed.
-
-Vertex attributes that are modified by `glDrawElements' have an
-unspecified value after `glDrawElements' returns. For example, if
-`GL_COLOR_ARRAY' is enabled, the value of the current color is undefined
-after `glDrawElements' executes. Attributes that aren't modified
-maintain their previous values.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if MODE is not an accepted value.
-
-`GL_INVALID_VALUE' is generated if COUNT is negative.
-
-`GL_INVALID_OPERATION' is generated if a non-zero buffer object name is
-bound to an enabled array or the element array and the buffer object's
-data store is currently mapped.
-
-`GL_INVALID_OPERATION' is generated if `glDrawElements' is executed
-between the execution of `glBegin' and the corresponding `glEnd'.")
-
-(define-gl-procedure
- glDrawPixels
- "glDrawPixels"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glDrawPixels"))
- (paramdef "GLsizei " (parameter "width"))
- (paramdef "GLsizei " (parameter "height"))
- (paramdef "GLenum " (parameter "format"))
- (paramdef "GLenum " (parameter "type"))
- (paramdef "const GLvoid * " (parameter "data"))))
- "write a block of pixels to the frame buffer
-===========================================
-
-
-Parameters
-==========
-
-WIDTH
- HEIGHT
-
- Specify the dimensions of the pixel rectangle to be written into
- the frame buffer.
-
-FORMAT
- Specifies the format of the pixel data. Symbolic constants
- `GL_COLOR_INDEX', `GL_STENCIL_INDEX', `GL_DEPTH_COMPONENT',
- `GL_RGB', `GL_BGR', `GL_RGBA', `GL_BGRA', `GL_RED', `GL_GREEN',
- `GL_BLUE', `GL_ALPHA', `GL_LUMINANCE', and `GL_LUMINANCE_ALPHA' are
- accepted.
-
-TYPE
- Specifies the data type for DATA. Symbolic constants
- `GL_UNSIGNED_BYTE', `GL_BYTE', `GL_BITMAP', `GL_UNSIGNED_SHORT',
- `GL_SHORT', `GL_UNSIGNED_INT', `GL_INT', `GL_FLOAT',
- `GL_UNSIGNED_BYTE_3_3_2', `GL_UNSIGNED_BYTE_2_3_3_REV',
- `GL_UNSIGNED_SHORT_5_6_5', `GL_UNSIGNED_SHORT_5_6_5_REV',
- `GL_UNSIGNED_SHORT_4_4_4_4', `GL_UNSIGNED_SHORT_4_4_4_4_REV',
- `GL_UNSIGNED_SHORT_5_5_5_1', `GL_UNSIGNED_SHORT_1_5_5_5_REV',
- `GL_UNSIGNED_INT_8_8_8_8', `GL_UNSIGNED_INT_8_8_8_8_REV',
- `GL_UNSIGNED_INT_10_10_10_2', and `GL_UNSIGNED_INT_2_10_10_10_REV'
- are accepted.
-
-DATA
- Specifies a pointer to the pixel data.
-
-
-Description
-===========
-
-`glDrawPixels' reads pixel data from memory and writes it into the frame
-buffer relative to the current raster position, provided that the raster
-position is valid. Use `glRasterPos' or `glWindowPos' to set the current
-raster position; use `glGet' with argument
-`GL_CURRENT_RASTER_POSITION_VALID' to determine if the specified raster
-position is valid, and `glGet' with argument
-`GL_CURRENT_RASTER_POSITION' to query the raster position.
-
-Several parameters define the encoding of pixel data in memory and
-control the processing of the pixel data before it is placed in the
-frame buffer. These parameters are set with four commands:
-`glPixelStore', `glPixelTransfer', `glPixelMap', and `glPixelZoom'. This
-reference page describes the effects on `glDrawPixels' of many, but not
-all, of the parameters specified by these four commands.
-
-Data is read from DATA as a sequence of signed or unsigned bytes, signed
-or unsigned shorts, signed or unsigned integers, or single-precision
-floating-point values, depending on TYPE. When TYPE is one of
-`GL_UNSIGNED_BYTE', `GL_BYTE', `GL_UNSIGNED_SHORT', `GL_SHORT',
-`GL_UNSIGNED_INT', `GL_INT', or `GL_FLOAT' each of these bytes, shorts,
-integers, or floating-point values is interpreted as one color or depth
-component, or one index, depending on FORMAT. When TYPE is one of
-`GL_UNSIGNED_BYTE_3_3_2', `GL_UNSIGNED_SHORT_5_6_5',
-`GL_UNSIGNED_SHORT_4_4_4_4', `GL_UNSIGNED_SHORT_5_5_5_1',
-`GL_UNSIGNED_INT_8_8_8_8', or `GL_UNSIGNED_INT_10_10_10_2', each
-unsigned value is interpreted as containing all the components for a
-single pixel, with the color components arranged according to FORMAT.
-When TYPE is one of `GL_UNSIGNED_BYTE_2_3_3_REV',
-`GL_UNSIGNED_SHORT_5_6_5_REV', `GL_UNSIGNED_SHORT_4_4_4_4_REV',
-`GL_UNSIGNED_SHORT_1_5_5_5_REV', `GL_UNSIGNED_INT_8_8_8_8_REV', or
-`GL_UNSIGNED_INT_2_10_10_10_REV', each unsigned value is interpreted as
-containing all color components, specified by FORMAT, for a single pixel
-in a reversed order. Indices are always treated individually. Color
-components are treated as groups of one, two, three, or four values,
-again based on FORMAT. Both individual indices and groups of components
-are referred to as pixels. If TYPE is `GL_BITMAP', the data must be
-unsigned bytes, and FORMAT must be either `GL_COLOR_INDEX' or
-`GL_STENCIL_INDEX'. Each unsigned byte is treated as eight 1-bit pixels,
-with bit ordering determined by `GL_UNPACK_LSB_FIRST' (see
-`glPixelStore').
-
-WIDTH×HEIGHT pixels are read from memory, starting at location DATA. By
-default, these pixels are taken from adjacent memory locations, except
-that after all WIDTH pixels are read, the read pointer is advanced to
-the next four-byte boundary. The four-byte row alignment is specified by
-`glPixelStore' with argument `GL_UNPACK_ALIGNMENT', and it can be set to
-one, two, four, or eight bytes. Other pixel store parameters specify
-different read pointer advancements, both before the first pixel is read
-and after all WIDTH pixels are read. See the `glPixelStore' reference
-page for details on these options.
-
-If a non-zero named buffer object is bound to the
-`GL_PIXEL_UNPACK_BUFFER' target (see `glBindBuffer') while a block of
-pixels is specified, DATA is treated as a byte offset into the buffer
-object's data store.
-
-The WIDTH×HEIGHT pixels that are read from memory are each operated on
-in the same way, based on the values of several parameters specified by
-`glPixelTransfer' and `glPixelMap'. The details of these operations, as
-well as the target buffer into which the pixels are drawn, are specific
-to the format of the pixels, as specified by FORMAT. FORMAT can assume
-one of 13 symbolic values:
-
-`GL_COLOR_INDEX'
- Each pixel is a single value, a color index. It is converted to
- fixed-point format, with an unspecified number of bits to the right
- of the binary point, regardless of the memory data type.
- Floating-point values convert to true fixed-point values. Signed
- and unsigned integer data is converted with all fraction bits set
- to 0. Bitmap data convert to either 0 or 1.
-
- Each fixed-point index is then shifted left by `GL_INDEX_SHIFT'
- bits and added to `GL_INDEX_OFFSET'. If `GL_INDEX_SHIFT' is
- negative, the shift is to the right. In either case, zero bits fill
- otherwise unspecified bit locations in the result.
-
- If the GL is in RGBA mode, the resulting index is converted to an
- RGBA pixel with the help of the `GL_PIXEL_MAP_I_TO_R',
- `GL_PIXEL_MAP_I_TO_G', `GL_PIXEL_MAP_I_TO_B', and
- `GL_PIXEL_MAP_I_TO_A' tables. If the GL is in color index mode, and
- if `GL_MAP_COLOR' is true, the index is replaced with the value
- that it references in lookup table `GL_PIXEL_MAP_I_TO_I'. Whether
- the lookup replacement of the index is done or not, the integer
- part of the index is then ANDed with 2^B-1, where B is the number
- of bits in a color index buffer.
-
- The GL then converts the resulting indices or RGBA colors to
- fragments by attaching the current raster position Z coordinate and
- texture coordinates to each pixel, then assigning X and Y window
- coordinates to the Nth fragment such that X_N=X_R+N%WIDTH
- Y_N=Y_R+⌊N/WIDTH,⌋
-
- where (X_R,Y_R) is the current raster position. These pixel
- fragments are then treated just like the fragments generated by
- rasterizing points, lines, or polygons. Texture mapping, fog, and
- all the fragment operations are applied before the fragments are
- written to the frame buffer.
-
-`GL_STENCIL_INDEX'
- Each pixel is a single value, a stencil index. It is converted to
- fixed-point format, with an unspecified number of bits to the right
- of the binary point, regardless of the memory data type.
- Floating-point values convert to true fixed-point values. Signed
- and unsigned integer data is converted with all fraction bits set
- to 0. Bitmap data convert to either 0 or 1.
-
- Each fixed-point index is then shifted left by `GL_INDEX_SHIFT'
- bits, and added to `GL_INDEX_OFFSET'. If `GL_INDEX_SHIFT' is
- negative, the shift is to the right. In either case, zero bits fill
- otherwise unspecified bit locations in the result. If
- `GL_MAP_STENCIL' is true, the index is replaced with the value that
- it references in lookup table `GL_PIXEL_MAP_S_TO_S'. Whether the
- lookup replacement of the index is done or not, the integer part of
- the index is then ANDed with 2^B-1, where B is the number of bits
- in the stencil buffer. The resulting stencil indices are then
- written to the stencil buffer such that the Nth index is written to
- location
-
- X_N=X_R+N%WIDTH Y_N=Y_R+⌊N/WIDTH,⌋
-
- where (X_R,Y_R) is the current raster position. Only the pixel
- ownership test, the scissor test, and the stencil writemask affect
- these write operations.
-
-`GL_DEPTH_COMPONENT'
- Each pixel is a single-depth component. Floating-point data is
- converted directly to an internal floating-point format with
- unspecified precision. Signed integer data is mapped linearly to
- the internal floating-point format such that the most positive
- representable integer value maps to 1.0, and the most negative
- representable value maps to -1.0. Unsigned integer data is mapped
- similarly: the largest integer value maps to 1.0, and 0 maps to
- 0.0. The resulting floating-point depth value is then multiplied by
- `GL_DEPTH_SCALE' and added to `GL_DEPTH_BIAS'. The result is
- clamped to the range [0,1].
-
- The GL then converts the resulting depth components to fragments by
- attaching the current raster position color or color index and
- texture coordinates to each pixel, then assigning X and Y window
- coordinates to the Nth fragment such that
-
- X_N=X_R+N%WIDTH Y_N=Y_R+⌊N/WIDTH,⌋
-
- where (X_R,Y_R) is the current raster position. These pixel
- fragments are then treated just like the fragments generated by
- rasterizing points, lines, or polygons. Texture mapping, fog, and
- all the fragment operations are applied before the fragments are
- written to the frame buffer.
-
-`GL_RGBA'
-`GL_BGRA'
- Each pixel is a four-component group: For `GL_RGBA', the red
- component is first, followed by green, followed by blue, followed
- by alpha; for `GL_BGRA' the order is blue, green, red and then
- alpha. Floating-point values are converted directly to an internal
- floating-point format with unspecified precision. Signed integer
- values are mapped linearly to the internal floating-point format
- such that the most positive representable integer value maps to
- 1.0, and the most negative representable value maps to -1.0. (Note
- that this mapping does not convert 0 precisely to 0.0.) Unsigned
- integer data is mapped similarly: The largest integer value maps to
- 1.0, and 0 maps to 0.0. The resulting floating-point color values
- are then multiplied by `GL_c_SCALE' and added to `GL_c_BIAS', where
- C is RED, GREEN, BLUE, and ALPHA for the respective color
- components. The results are clamped to the range [0,1].
-
- If `GL_MAP_COLOR' is true, each color component is scaled by the
- size of lookup table `GL_PIXEL_MAP_c_TO_c', then replaced by the
- value that it references in that table. C is R, G, B, or A
- respectively.
-
- The GL then converts the resulting RGBA colors to fragments by
- attaching the current raster position Z coordinate and texture
- coordinates to each pixel, then assigning X and Y window
- coordinates to the Nth fragment such that
-
- X_N=X_R+N%WIDTH Y_N=Y_R+⌊N/WIDTH,⌋
-
- where (X_R,Y_R) is the current raster position. These pixel
- fragments are then treated just like the fragments generated by
- rasterizing points, lines, or polygons. Texture mapping, fog, and
- all the fragment operations are applied before the fragments are
- written to the frame buffer.
-
-`GL_RED'
- Each pixel is a single red component. This component is converted
- to the internal floating-point format in the same way the red
- component of an RGBA pixel is. It is then converted to an RGBA
- pixel with green and blue set to 0, and alpha set to 1. After this
- conversion, the pixel is treated as if it had been read as an RGBA
- pixel.
-
-`GL_GREEN'
- Each pixel is a single green component. This component is converted
- to the internal floating-point format in the same way the green
- component of an RGBA pixel is. It is then converted to an RGBA
- pixel with red and blue set to 0, and alpha set to 1. After this
- conversion, the pixel is treated as if it had been read as an RGBA
- pixel.
-
-`GL_BLUE'
- Each pixel is a single blue component. This component is converted
- to the internal floating-point format in the same way the blue
- component of an RGBA pixel is. It is then converted to an RGBA
- pixel with red and green set to 0, and alpha set to 1. After this
- conversion, the pixel is treated as if it had been read as an RGBA
- pixel.
-
-`GL_ALPHA'
- Each pixel is a single alpha component. This component is converted
- to the internal floating-point format in the same way the alpha
- component of an RGBA pixel is. It is then converted to an RGBA
- pixel with red, green, and blue set to 0. After this conversion,
- the pixel is treated as if it had been read as an RGBA pixel.
-
-`GL_RGB'
-`GL_BGR'
- Each pixel is a three-component group: red first, followed by
- green, followed by blue; for `GL_BGR', the first component is blue,
- followed by green and then red. Each component is converted to the
- internal floating-point format in the same way the red, green, and
- blue components of an RGBA pixel are. The color triple is converted
- to an RGBA pixel with alpha set to 1. After this conversion, the
- pixel is treated as if it had been read as an RGBA pixel.
-
-`GL_LUMINANCE'
- Each pixel is a single luminance component. This component is
- converted to the internal floating-point format in the same way the
- red component of an RGBA pixel is. It is then converted to an RGBA
- pixel with red, green, and blue set to the converted luminance
- value, and alpha set to 1. After this conversion, the pixel is
- treated as if it had been read as an RGBA pixel.
-
-`GL_LUMINANCE_ALPHA'
- Each pixel is a two-component group: luminance first, followed by
- alpha. The two components are converted to the internal
- floating-point format in the same way the red component of an RGBA
- pixel is. They are then converted to an RGBA pixel with red, green,
- and blue set to the converted luminance value, and alpha set to the
- converted alpha value. After this conversion, the pixel is treated
- as if it had been read as an RGBA pixel.
-
-The following table summarizes the meaning of the valid constants for
-the TYPE parameter:
-
-* Type * * Corresponding Type *`GL_UNSIGNED_BYTE' unsigned 8-bit integer
-`GL_BYTE' signed 8-bit integer `GL_BITMAP' single bits in unsigned 8-bit
-integers `GL_UNSIGNED_SHORT' unsigned 16-bit integer `GL_SHORT' signed
-16-bit integer `GL_UNSIGNED_INT' unsigned 32-bit integer `GL_INT' 32-bit
-integer `GL_FLOAT' single-precision floating-point
-`GL_UNSIGNED_BYTE_3_3_2' unsigned 8-bit integer
-`GL_UNSIGNED_BYTE_2_3_3_REV' unsigned 8-bit integer with reversed
-component ordering `GL_UNSIGNED_SHORT_5_6_5' unsigned 16-bit integer
-`GL_UNSIGNED_SHORT_5_6_5_REV' unsigned 16-bit integer with reversed
-component ordering `GL_UNSIGNED_SHORT_4_4_4_4' unsigned 16-bit integer
-`GL_UNSIGNED_SHORT_4_4_4_4_REV' unsigned 16-bit integer with reversed
-component ordering `GL_UNSIGNED_SHORT_5_5_5_1' unsigned 16-bit integer
-`GL_UNSIGNED_SHORT_1_5_5_5_REV' unsigned 16-bit integer with reversed
-component ordering `GL_UNSIGNED_INT_8_8_8_8' unsigned 32-bit integer
-`GL_UNSIGNED_INT_8_8_8_8_REV' unsigned 32-bit integer with reversed
-component ordering `GL_UNSIGNED_INT_10_10_10_2' unsigned 32-bit integer
-`GL_UNSIGNED_INT_2_10_10_10_REV' unsigned 32-bit integer with reversed
-component ordering
-
-
-
-The rasterization described so far assumes pixel zoom factors of 1. If
-`glPixelZoom' is used to change the X and Y pixel zoom factors, pixels
-are converted to fragments as follows. If (X_R,Y_R) is the current
-raster position, and a given pixel is in the Nth column and Mth row of
-the pixel rectangle, then fragments are generated for pixels whose
-centers are in the rectangle with corners at
-
-(X_R+ZOOM_X,\u2062N,Y_R+ZOOM_Y,\u2062M)(X_R+ZOOM_X,\u2061(N+1,),Y_R+ZOOM_Y,\u2061(M+1,))
-
-where ZOOM_X is the value of `GL_ZOOM_X' and ZOOM_Y is the value of
-`GL_ZOOM_Y'.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if FORMAT or TYPE is not one of the
-accepted values.
-
-`GL_INVALID_ENUM' is generated if TYPE is `GL_BITMAP' and FORMAT is not
-either `GL_COLOR_INDEX' or `GL_STENCIL_INDEX'.
-
-`GL_INVALID_VALUE' is generated if either WIDTH or HEIGHT is negative.
-
-`GL_INVALID_OPERATION' is generated if FORMAT is `GL_STENCIL_INDEX' and
-there is no stencil buffer.
-
-`GL_INVALID_OPERATION' is generated if FORMAT is `GL_RED', `GL_GREEN',
-`GL_BLUE', `GL_ALPHA', `GL_RGB', `GL_RGBA', `GL_BGR', `GL_BGRA',
-`GL_LUMINANCE', or `GL_LUMINANCE_ALPHA', and the GL is in color index
-mode.
-
-`GL_INVALID_OPERATION' is generated if FORMAT is one of
-`GL_UNSIGNED_BYTE_3_3_2', `GL_UNSIGNED_BYTE_2_3_3_REV',
-`GL_UNSIGNED_SHORT_5_6_5', or `GL_UNSIGNED_SHORT_5_6_5_REV' and FORMAT
-is not `GL_RGB'.
-
-`GL_INVALID_OPERATION' is generated if FORMAT is one of
-`GL_UNSIGNED_SHORT_4_4_4_4', `GL_UNSIGNED_SHORT_4_4_4_4_REV',
-`GL_UNSIGNED_SHORT_5_5_5_1', `GL_UNSIGNED_SHORT_1_5_5_5_REV',
-`GL_UNSIGNED_INT_8_8_8_8', `GL_UNSIGNED_INT_8_8_8_8_REV',
-`GL_UNSIGNED_INT_10_10_10_2', or `GL_UNSIGNED_INT_2_10_10_10_REV' and
-FORMAT is neither `GL_RGBA' nor `GL_BGRA'.
-
-`GL_INVALID_OPERATION' is generated if a non-zero buffer object name is
-bound to the `GL_PIXEL_UNPACK_BUFFER' target and the buffer object's
-data store is currently mapped.
-
-`GL_INVALID_OPERATION' is generated if a non-zero buffer object name is
-bound to the `GL_PIXEL_UNPACK_BUFFER' target and the data would be
-unpacked from the buffer object such that the memory reads required
-would exceed the data store size.
-
-`GL_INVALID_OPERATION' is generated if a non-zero buffer object name is
-bound to the `GL_PIXEL_UNPACK_BUFFER' target and DATA is not evenly
-divisible into the number of bytes needed to store in memory a datum
-indicated by TYPE.
-
-`GL_INVALID_OPERATION' is generated if `glDrawPixels' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glDrawRangeElements
- "glDrawRangeElements"
- (funcsynopsis
- (funcprototype
- (funcdef
- "void "
- (function "glDrawRangeElements"))
- (paramdef "GLenum " (parameter "mode"))
- (paramdef "GLuint " (parameter "start"))
- (paramdef "GLuint " (parameter "end"))
- (paramdef "GLsizei " (parameter "count"))
- (paramdef "GLenum " (parameter "type"))
- (paramdef
- "const GLvoid * "
- (parameter "indices"))))
- "render primitives from array data
-=================================
-
-
-Parameters
-==========
-
-MODE
- Specifies what kind of primitives to render. Symbolic constants
- `GL_POINTS', `GL_LINE_STRIP', `GL_LINE_LOOP', `GL_LINES',
- `GL_TRIANGLE_STRIP', `GL_TRIANGLE_FAN', `GL_TRIANGLES',
- `GL_QUAD_STRIP', `GL_QUADS', and `GL_POLYGON' are accepted.
-
-START
- Specifies the minimum array index contained in INDICES.
-
-END
- Specifies the maximum array index contained in INDICES.
-
-COUNT
- Specifies the number of elements to be rendered.
-
-TYPE
- Specifies the type of the values in INDICES. Must be one of
- `GL_UNSIGNED_BYTE', `GL_UNSIGNED_SHORT', or `GL_UNSIGNED_INT'.
-
-INDICES
- Specifies a pointer to the location where the indices are stored.
-
-
-Description
-===========
-
-`glDrawRangeElements' is a restricted form of `glDrawElements'. MODE,
-START, END, and COUNT match the corresponding arguments to
-`glDrawElements', with the additional constraint that all values in the
-arrays COUNT must lie between START and END, inclusive.
-
-Implementations denote recommended maximum amounts of vertex and index
-data, which may be queried by calling `glGet' with argument
-`GL_MAX_ELEMENTS_VERTICES' and `GL_MAX_ELEMENTS_INDICES'. If END-START+1
-is greater than the value of `GL_MAX_ELEMENTS_VERTICES', or if COUNT is
-greater than the value of `GL_MAX_ELEMENTS_INDICES', then the call may
-operate at reduced performance. There is no requirement that all
-vertices in the range [START,END] be referenced. However, the
-implementation may partially process unused vertices, reducing
-performance from what could be achieved with an optimal index set.
-
-When `glDrawRangeElements' is called, it uses COUNT sequential elements
-from an enabled array, starting at START to construct a sequence of
-geometric primitives. MODE specifies what kind of primitives are
-constructed, and how the array elements construct these primitives. If
-more than one array is enabled, each is used. If `GL_VERTEX_ARRAY' is
-not enabled, no geometric primitives are constructed.
-
-Vertex attributes that are modified by `glDrawRangeElements' have an
-unspecified value after `glDrawRangeElements' returns. For example, if
-`GL_COLOR_ARRAY' is enabled, the value of the current color is undefined
-after `glDrawRangeElements' executes. Attributes that aren't modified
-maintain their previous values.
-
-
-Errors
-======
-
-It is an error for indices to lie outside the range [START,END], but
-implementations may not check for this situation. Such indices cause
-implementation-dependent behavior.
-
-`GL_INVALID_ENUM' is generated if MODE is not an accepted value.
-
-`GL_INVALID_VALUE' is generated if COUNT is negative.
-
-`GL_INVALID_VALUE' is generated if END<START.
-
-`GL_INVALID_OPERATION' is generated if a non-zero buffer object name is
-bound to an enabled array or the element array and the buffer object's
-data store is currently mapped.
-
-`GL_INVALID_OPERATION' is generated if `glDrawRangeElements' is executed
-between the execution of `glBegin' and the corresponding `glEnd'.")
-
-(define-gl-procedure
- glEdgeFlagPointer
- "glEdgeFlagPointer"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glEdgeFlagPointer"))
- (paramdef "GLsizei " (parameter "stride"))
- (paramdef
- "const GLvoid * "
- (parameter "pointer"))))
- "define an array of edge flags
-=============================
-
-
-Parameters
-==========
-
-STRIDE
- Specifies the byte offset between consecutive edge flags. If STRIDE
- is 0, the edge flags are understood to be tightly packed in the
- array. The initial value is 0.
-
-POINTER
- Specifies a pointer to the first edge flag in the array. The
- initial value is 0.
-
-
-Description
-===========
-
-`glEdgeFlagPointer' specifies the location and data format of an array
-of boolean edge flags to use when rendering. STRIDE specifies the byte
-stride from one edge flag to the next, allowing vertices and attributes
-to be packed into a single array or stored in separate arrays.
-
-If a non-zero named buffer object is bound to the `GL_ARRAY_BUFFER'
-target (see `glBindBuffer') while an edge flag array is specified,
-POINTER is treated as a byte offset into the buffer object's data store.
-Also, the buffer object binding (`GL_ARRAY_BUFFER_BINDING') is saved as
-edge flag vertex array client-side state
-(`GL_EDGE_FLAG_ARRAY_BUFFER_BINDING').
-
-When an edge flag array is specified, STRIDE and POINTER are saved as
-client-side state, in addition to the current vertex array buffer object
-binding.
-
-To enable and disable the edge flag array, call `glEnableClientState'
-and `glDisableClientState' with the argument `GL_EDGE_FLAG_ARRAY'. If
-enabled, the edge flag array is used when `glDrawArrays',
-`glMultiDrawArrays', `glDrawElements', `glMultiDrawElements',
-`glDrawRangeElements', or `glArrayElement' is called.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if STRIDE is negative.")
-
-(define-gl-procedure
- glEdgeFlag
- "glEdgeFlag"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glEdgeFlag"))
- (paramdef "GLboolean " (parameter "flag"))))
- "flag edges as either boundary or nonboundary
-============================================
-
-
-Parameters
-==========
-
-FLAG
- Specifies the current edge flag value, either `GL_TRUE' or
- `GL_FALSE'. The initial value is `GL_TRUE'.
-
-
-Description
-===========
-
-Each vertex of a polygon, separate triangle, or separate quadrilateral
-specified between a `glBegin'/`glEnd' pair is marked as the start of
-either a boundary or nonboundary edge. If the current edge flag is true
-when the vertex is specified, the vertex is marked as the start of a
-boundary edge. Otherwise, the vertex is marked as the start of a
-nonboundary edge. `glEdgeFlag' sets the edge flag bit to `GL_TRUE' if
-FLAG is `GL_TRUE' and to `GL_FALSE' otherwise.
-
-The vertices of connected triangles and connected quadrilaterals are
-always marked as boundary, regardless of the value of the edge flag.
-
-Boundary and nonboundary edge flags on vertices are significant only if
-`GL_POLYGON_MODE' is set to `GL_POINT' or `GL_LINE'. See
-`glPolygonMode'.")
-
-(define-gl-procedure
- glEnableClientState
- "glEnableClientState"
- (funcsynopsis
- (funcprototype
- (funcdef
- "void "
- (function "glEnableClientState"))
- (paramdef "GLenum " (parameter "cap"))))
- "enable or disable client-side capability
-========================================
-
-
-Parameters
-==========
-
-CAP
- Specifies the capability to enable. Symbolic constants
- `GL_COLOR_ARRAY', `GL_EDGE_FLAG_ARRAY', `GL_FOG_COORD_ARRAY',
- `GL_INDEX_ARRAY', `GL_NORMAL_ARRAY', `GL_SECONDARY_COLOR_ARRAY',
- `GL_TEXTURE_COORD_ARRAY', and `GL_VERTEX_ARRAY' are accepted.
-
-
-Description
-===========
-
-`glEnableClientState' and `glDisableClientState' enable or disable
-individual client-side capabilities. By default, all client-side
-capabilities are disabled. Both `glEnableClientState' and
-`glDisableClientState' take a single argument, CAP, which can assume one
-of the following values:
-
-`GL_COLOR_ARRAY'
- If enabled, the color array is enabled for writing and used during
- rendering when `glArrayElement', `glDrawArrays', `glDrawElements',
- `glDrawRangeElements'`glMultiDrawArrays', or `glMultiDrawElements'
- is called. See `glColorPointer'.
-
-`GL_EDGE_FLAG_ARRAY'
- If enabled, the edge flag array is enabled for writing and used
- during rendering when `glArrayElement', `glDrawArrays',
- `glDrawElements', `glDrawRangeElements'`glMultiDrawArrays', or
- `glMultiDrawElements' is called. See `glEdgeFlagPointer'.
-
-`GL_FOG_COORD_ARRAY'
- If enabled, the fog coordinate array is enabled for writing and
- used during rendering when `glArrayElement', `glDrawArrays',
- `glDrawElements', `glDrawRangeElements'`glMultiDrawArrays', or
- `glMultiDrawElements' is called. See `glFogCoordPointer'.
-
-`GL_INDEX_ARRAY'
- If enabled, the index array is enabled for writing and used during
- rendering when `glArrayElement', `glDrawArrays', `glDrawElements',
- `glDrawRangeElements'`glMultiDrawArrays', or `glMultiDrawElements'
- is called. See `glIndexPointer'.
-
-`GL_NORMAL_ARRAY'
- If enabled, the normal array is enabled for writing and used during
- rendering when `glArrayElement', `glDrawArrays', `glDrawElements',
- `glDrawRangeElements'`glMultiDrawArrays', or `glMultiDrawElements'
- is called. See `glNormalPointer'.
-
-`GL_SECONDARY_COLOR_ARRAY'
- If enabled, the secondary color array is enabled for writing and
- used during rendering when `glArrayElement', `glDrawArrays',
- `glDrawElements', `glDrawRangeElements'`glMultiDrawArrays', or
- `glMultiDrawElements' is called. See `glColorPointer'.
-
-`GL_TEXTURE_COORD_ARRAY'
- If enabled, the texture coordinate array is enabled for writing and
- used during rendering when `glArrayElement', `glDrawArrays',
- `glDrawElements', `glDrawRangeElements'`glMultiDrawArrays', or
- `glMultiDrawElements' is called. See `glTexCoordPointer'.
-
-`GL_VERTEX_ARRAY'
- If enabled, the vertex array is enabled for writing and used during
- rendering when `glArrayElement', `glDrawArrays', `glDrawElements',
- `glDrawRangeElements'`glMultiDrawArrays', or `glMultiDrawElements'
- is called. See `glVertexPointer'.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if CAP is not an accepted value.
-
-`glEnableClientState' is not allowed between the execution of `glBegin'
-and the corresponding `glEnd', but an error may or may not be generated.
-If no error is generated, the behavior is undefined.")
-
-(define-gl-procedure
- glEnableVertexAttribArray
- "glEnableVertexAttribArray"
- (funcsynopsis
- (funcprototype
- (funcdef
- "void "
- (function "glEnableVertexAttribArray"))
- (paramdef "GLuint " (parameter "index")))
- (funcprototype
- (funcdef
- "void "
- (function "glDisableVertexAttribArray"))
- (paramdef "GLuint " (parameter "index"))))
- "Enable or disable a generic vertex attribute array
-==================================================
-
-
-Parameters
-==========
-
-INDEX
- Specifies the index of the generic vertex attribute to be enabled
- or disabled.
-
-
-Description
-===========
-
-`glEnableVertexAttribArray' enables the generic vertex attribute array
-specified by INDEX. `glDisableVertexAttribArray' disables the generic
-vertex attribute array specified by INDEX. By default, all client-side
-capabilities are disabled, including all generic vertex attribute
-arrays. If enabled, the values in the generic vertex attribute array
-will be accessed and used for rendering when calls are made to vertex
-array commands such as `glDrawArrays', `glDrawElements',
-`glDrawRangeElements', `glArrayElement', `glMultiDrawElements', or
-`glMultiDrawArrays'.
-
-
-Errors
-======
-
-`GL_INVALID_VALUE' is generated if INDEX is greater than or equal to
-`GL_MAX_VERTEX_ATTRIBS'.
-
-`GL_INVALID_OPERATION' is generated if either `glEnableVertexAttribArray
-' or `glDisableVertexAttribArray ' is executed between the execution of
-`glBegin' and the corresponding execution of `glEnd'.")
-
-(define-gl-procedure
- glEnable
- "glEnable"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glEnable"))
- (paramdef "GLenum " (parameter "cap"))))
- "enable or disable server-side GL capabilities
-=============================================
-
-
-Parameters
-==========
-
-CAP
- Specifies a symbolic constant indicating a GL capability.
-
-
-Description
-===========
-
-`glEnable' and `glDisable' enable and disable various capabilities. Use
-`glIsEnabled' or `glGet' to determine the current setting of any
-capability. The initial value for each capability with the exception of
-`GL_DITHER' and `GL_MULTISAMPLE' is `GL_FALSE'. The initial value for
-`GL_DITHER' and `GL_MULTISAMPLE' is `GL_TRUE'.
-
-Both `glEnable' and `glDisable' take a single argument, CAP, which can
-assume one of the following values:
-
-`GL_ALPHA_TEST'
-
-
- If enabled, do alpha testing. See `glAlphaFunc'.
-
-`GL_AUTO_NORMAL'
-
-
- If enabled, generate normal vectors when either `GL_MAP2_VERTEX_3'
- or `GL_MAP2_VERTEX_4' is used to generate vertices. See `glMap2'.
-
-`GL_BLEND'
-
-
- If enabled, blend the computed fragment color values with the
- values in the color buffers. See `glBlendFunc'.
-
-`GL_CLIP_PLANE'I
-
-
- If enabled, clip geometry against user-defined clipping plane I.
- See `glClipPlane'.
-
-`GL_COLOR_LOGIC_OP'
-
-
- If enabled, apply the currently selected logical operation to the
- computed fragment color and color buffer values. See `glLogicOp'.
-
-`GL_COLOR_MATERIAL'
-
-
- If enabled, have one or more material parameters track the current
- color. See `glColorMaterial'.
-
-`GL_COLOR_SUM'
-
-
- If enabled and no fragment shader is active, add the secondary
- color value to the computed fragment color. See `glSecondaryColor'.
-
-`GL_COLOR_TABLE'
-
-
- If enabled, perform a color table lookup on the incoming RGBA color
- values. See `glColorTable'.
-
-`GL_CONVOLUTION_1D'
-
-
- If enabled, perform a 1D convolution operation on incoming RGBA
- color values. See `glConvolutionFilter1D'.
-
-`GL_CONVOLUTION_2D'
-
-
- If enabled, perform a 2D convolution operation on incoming RGBA
- color values. See `glConvolutionFilter2D'.
-
-`GL_CULL_FACE'
-
-
- If enabled, cull polygons based on their winding in window
- coordinates. See `glCullFace'.
-
-`GL_DEPTH_TEST'
-
-
- If enabled, do depth comparisons and update the depth buffer. Note
- that even if the depth buffer exists and the depth mask is
- non-zero, the depth buffer is not updated if the depth test is
- disabled. See `glDepthFunc' and `glDepthRange'.
-
-`GL_DITHER'
-
-
- If enabled, dither color components or indices before they are
- written to the color buffer.
-
-`GL_FOG'
-
-
- If enabled and no fragment shader is active, blend a fog color into
- the post-texturing color. See `glFog'.
-
-`GL_HISTOGRAM'
-
-
- If enabled, histogram incoming RGBA color values. See
- `glHistogram'.
-
-`GL_INDEX_LOGIC_OP'
-
-
- If enabled, apply the currently selected logical operation to the
- incoming index and color buffer indices. See `glLogicOp'.
-
-`GL_LIGHT'I
-
-
- If enabled, include light I in the evaluation of the lighting
- equation. See `glLightModel' and `glLight'.
-
-`GL_LIGHTING'
-
-
- If enabled and no vertex shader is active, use the current lighting
- parameters to compute the vertex color or index. Otherwise, simply
- associate the current color or index with each vertex. See
- `glMaterial', `glLightModel', and `glLight'.
-
-`GL_LINE_SMOOTH'
-
-
- If enabled, draw lines with correct filtering. Otherwise, draw
- aliased lines. See `glLineWidth'.
-
-`GL_LINE_STIPPLE'
-
-
- If enabled, use the current line stipple pattern when drawing
- lines. See `glLineStipple'.
-
-`GL_MAP1_COLOR_4'
-
-
- If enabled, calls to `glEvalCoord1', `glEvalMesh1', and
- `glEvalPoint1' generate RGBA values. See `glMap1'.
-
-`GL_MAP1_INDEX'
-
-
- If enabled, calls to `glEvalCoord1', `glEvalMesh1', and
- `glEvalPoint1' generate color indices. See `glMap1'.
-
-`GL_MAP1_NORMAL'
-
-
- If enabled, calls to `glEvalCoord1', `glEvalMesh1', and
- `glEvalPoint1' generate normals. See `glMap1'.
-
-`GL_MAP1_TEXTURE_COORD_1'
-
-
- If enabled, calls to `glEvalCoord1', `glEvalMesh1', and
- `glEvalPoint1' generate S texture coordinates. See `glMap1'.
-
-`GL_MAP1_TEXTURE_COORD_2'
-
-
- If enabled, calls to `glEvalCoord1', `glEvalMesh1', and
- `glEvalPoint1' generate S and T texture coordinates. See `glMap1'.
-
-`GL_MAP1_TEXTURE_COORD_3'
-
-
- If enabled, calls to `glEvalCoord1', `glEvalMesh1', and
- `glEvalPoint1' generate S, T, and R texture coordinates. See
- `glMap1'.
-
-`GL_MAP1_TEXTURE_COORD_4'
-
-
- If enabled, calls to `glEvalCoord1', `glEvalMesh1', and
- `glEvalPoint1' generate S, T, R, and Q texture coordinates. See
- `glMap1'.
-
-`GL_MAP1_VERTEX_3'
-
-
- If enabled, calls to `glEvalCoord1', `glEvalMesh1', and
- `glEvalPoint1' generate X, Y, and Z vertex coordinates. See
- `glMap1'.
-
-`GL_MAP1_VERTEX_4'
-
-
- If enabled, calls to `glEvalCoord1', `glEvalMesh1', and
- `glEvalPoint1' generate homogeneous X, Y, Z, and W vertex
- coordinates. See `glMap1'.
-
-`GL_MAP2_COLOR_4'
-
-
- If enabled, calls to `glEvalCoord2', `glEvalMesh2', and
- `glEvalPoint2' generate RGBA values. See `glMap2'.
-
-`GL_MAP2_INDEX'
-
-
- If enabled, calls to `glEvalCoord2', `glEvalMesh2', and
- `glEvalPoint2' generate color indices. See `glMap2'.
-
-`GL_MAP2_NORMAL'
-
-
- If enabled, calls to `glEvalCoord2', `glEvalMesh2', and
- `glEvalPoint2' generate normals. See `glMap2'.
-
-`GL_MAP2_TEXTURE_COORD_1'
-
-
- If enabled, calls to `glEvalCoord2', `glEvalMesh2', and
- `glEvalPoint2' generate S texture coordinates. See `glMap2'.
-
-`GL_MAP2_TEXTURE_COORD_2'
-
-
- If enabled, calls to `glEvalCoord2', `glEvalMesh2', and
- `glEvalPoint2' generate S and T texture coordinates. See `glMap2'.
-
-`GL_MAP2_TEXTURE_COORD_3'
-
-
- If enabled, calls to `glEvalCoord2', `glEvalMesh2', and
- `glEvalPoint2' generate S, T, and R texture coordinates. See
- `glMap2'.
-
-`GL_MAP2_TEXTURE_COORD_4'
-
-
- If enabled, calls to `glEvalCoord2', `glEvalMesh2', and
- `glEvalPoint2' generate S, T, R, and Q texture coordinates. See
- `glMap2'.
-
-`GL_MAP2_VERTEX_3'
-
-
- If enabled, calls to `glEvalCoord2', `glEvalMesh2', and
- `glEvalPoint2' generate X, Y, and Z vertex coordinates. See
- `glMap2'.
-
-`GL_MAP2_VERTEX_4'
-
-
- If enabled, calls to `glEvalCoord2', `glEvalMesh2', and
- `glEvalPoint2' generate homogeneous X, Y, Z, and W vertex
- coordinates. See `glMap2'.
-
-`GL_MINMAX'
-
-
- If enabled, compute the minimum and maximum values of incoming RGBA
- color values. See `glMinmax'.
-
-`GL_MULTISAMPLE'
-
-
- If enabled, use multiple fragment samples in computing the final
- color of a pixel. See `glSampleCoverage'.
-
-`GL_NORMALIZE'
-
-
- If enabled and no vertex shader is active, normal vectors are
- normalized to unit length after transformation and before lighting.
- This method is generally less efficient than `GL_RESCALE_NORMAL'.
- See `glNormal' and `glNormalPointer'.
-
-`GL_POINT_SMOOTH'
-
-
- If enabled, draw points with proper filtering. Otherwise, draw
- aliased points. See `glPointSize'.
-
-`GL_POINT_SPRITE'
-
-
- If enabled, calculate texture coordinates for points based on
- texture environment and point parameter settings. Otherwise texture
- coordinates are constant across points.
-
-`GL_POLYGON_OFFSET_FILL'
-
-
- If enabled, and if the polygon is rendered in `GL_FILL' mode, an
- offset is added to depth values of a polygon's fragments before the
- depth comparison is performed. See `glPolygonOffset'.
-
-`GL_POLYGON_OFFSET_LINE'
-
-
- If enabled, and if the polygon is rendered in `GL_LINE' mode, an
- offset is added to depth values of a polygon's fragments before the
- depth comparison is performed. See `glPolygonOffset'.
-
-`GL_POLYGON_OFFSET_POINT'
-
-
- If enabled, an offset is added to depth values of a polygon's
- fragments before the depth comparison is performed, if the polygon
- is rendered in `GL_POINT' mode. See `glPolygonOffset'.
-
-`GL_POLYGON_SMOOTH'
-
-
- If enabled, draw polygons with proper filtering. Otherwise, draw
- aliased polygons. For correct antialiased polygons, an alpha buffer
- is needed and the polygons must be sorted front to back.
-
-`GL_POLYGON_STIPPLE'
-
-
- If enabled, use the current polygon stipple pattern when rendering
- polygons. See `glPolygonStipple'.
-
-`GL_POST_COLOR_MATRIX_COLOR_TABLE'
-
-
- If enabled, perform a color table lookup on RGBA color values after
- color matrix transformation. See `glColorTable'.
-
-`GL_POST_CONVOLUTION_COLOR_TABLE'
-
-
- If enabled, perform a color table lookup on RGBA color values after
- convolution. See `glColorTable'.
-
-`GL_RESCALE_NORMAL'
-
-
- If enabled and no vertex shader is active, normal vectors are
- scaled after transformation and before lighting by a factor
- computed from the modelview matrix. If the modelview matrix scales
- space uniformly, this has the effect of restoring the transformed
- normal to unit length. This method is generally more efficient than
- `GL_NORMALIZE'. See `glNormal' and `glNormalPointer'.
-
-`GL_SAMPLE_ALPHA_TO_COVERAGE'
-
-
- If enabled, compute a temporary coverage value where each bit is
- determined by the alpha value at the corresponding sample location.
- The temporary coverage value is then ANDed with the fragment
- coverage value.
-
-`GL_SAMPLE_ALPHA_TO_ONE'
-
-
- If enabled, each sample alpha value is replaced by the maximum
- representable alpha value.
-
-`GL_SAMPLE_COVERAGE'
-
-
- If enabled, the fragment's coverage is ANDed with the temporary
- coverage value. If `GL_SAMPLE_COVERAGE_INVERT' is set to `GL_TRUE',
- invert the coverage value. See `glSampleCoverage'.
-
-`GL_SEPARABLE_2D'
-
-
- If enabled, perform a two-dimensional convolution operation using a
- separable convolution filter on incoming RGBA color values. See
- `glSeparableFilter2D'.
-
-`GL_SCISSOR_TEST'
-
-
- If enabled, discard fragments that are outside the scissor
- rectangle. See `glScissor'.
-
-`GL_STENCIL_TEST'
-
-
- If enabled, do stencil testing and update the stencil buffer. See
- `glStencilFunc' and `glStencilOp'.
-
-`GL_TEXTURE_1D'
-
-
- If enabled and no fragment shader is active, one-dimensional
- texturing is performed (unless two- or three-dimensional or
- cube-mapped texturing is also enabled). See `glTexImage1D'.
-
-`GL_TEXTURE_2D'
-
-
- If enabled and no fragment shader is active, two-dimensional
- texturing is performed (unless three-dimensional or cube-mapped
- texturing is also enabled). See `glTexImage2D'.
-
-`GL_TEXTURE_3D'
-
-
- If enabled and no fragment shader is active, three-dimensional
- texturing is performed (unless cube-mapped texturing is also
- enabled). See `glTexImage3D'.
-
-`GL_TEXTURE_CUBE_MAP'
-
-
- If enabled and no fragment shader is active, cube-mapped texturing
- is performed. See `glTexImage2D'.
-
-`GL_TEXTURE_GEN_Q'
-
-
- If enabled and no vertex shader is active, the Q texture coordinate
- is computed using the texture generation function defined with
- `glTexGen'. Otherwise, the current Q texture coordinate is used.
- See `glTexGen'.
-
-`GL_TEXTURE_GEN_R'
-
-
- If enabled and no vertex shader is active, the R texture coordinate
- is computed using the texture generation function defined with
- `glTexGen'. Otherwise, the current R texture coordinate is used.
- See `glTexGen'.
-
-`GL_TEXTURE_GEN_S'
-
-
- If enabled and no vertex shader is active, the S texture coordinate
- is computed using the texture generation function defined with
- `glTexGen'. Otherwise, the current S texture coordinate is used.
- See `glTexGen'.
-
-`GL_TEXTURE_GEN_T'
-
-
- If enabled and no vertex shader is active, the T texture coordinate
- is computed using the texture generation function defined with
- `glTexGen'. Otherwise, the current T texture coordinate is used.
- See `glTexGen'.
-
-`GL_VERTEX_PROGRAM_POINT_SIZE'
-
-
- If enabled and a vertex shader is active, then the derived point
- size is taken from the (potentially clipped) shader builtin
- `gl_PointSize' and clamped to the implementation-dependent point
- size range.
-
-`GL_VERTEX_PROGRAM_TWO_SIDE'
-
-
- If enabled and a vertex shader is active, it specifies that the GL
- will choose between front and back colors based on the polygon's
- face direction of which the vertex being shaded is a part. It has
- no effect on points or lines.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if CAP is not one of the values listed
-previously.
-
-`GL_INVALID_OPERATION' is generated if `glEnable' or `glDisable' is
-executed between the execution of `glBegin' and the corresponding
-execution of `glEnd'.")
-
-(define-gl-procedure
- glEvalCoord
- "glEvalCoord"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glEvalCoord1f"))
- (paramdef "GLfloat " (parameter "u"))))
- "evaluate enabled one- and two-dimensional maps
-==============================================
-
-
-Parameters
-==========
-
-U
- Specifies a value that is the domain coordinate U to the basis
- function defined in a previous `glMap1' or `glMap2' command.
-
-V
- Specifies a value that is the domain coordinate V to the basis
- function defined in a previous `glMap2' command. This argument is
- not present in a `glEvalCoord1' command.
-
-
-Description
-===========
-
-`glEvalCoord1' evaluates enabled one-dimensional maps at argument U.
-`glEvalCoord2' does the same for two-dimensional maps using two domain
-values, U and V. To define a map, call `glMap1' and `glMap2'; to enable
-and disable it, call `glEnable' and `glDisable'.
-
-When one of the `glEvalCoord' commands is issued, all currently enabled
-maps of the indicated dimension are evaluated. Then, for each enabled
-map, it is as if the corresponding GL command had been issued with the
-computed value. That is, if `GL_MAP1_INDEX' or `GL_MAP2_INDEX' is
-enabled, a `glIndex' command is simulated. If `GL_MAP1_COLOR_4' or
-`GL_MAP2_COLOR_4' is enabled, a `glColor' command is simulated. If
-`GL_MAP1_NORMAL' or `GL_MAP2_NORMAL' is enabled, a normal vector is
-produced, and if any of `GL_MAP1_TEXTURE_COORD_1',
-`GL_MAP1_TEXTURE_COORD_2', `GL_MAP1_TEXTURE_COORD_3',
-`GL_MAP1_TEXTURE_COORD_4', `GL_MAP2_TEXTURE_COORD_1',
-`GL_MAP2_TEXTURE_COORD_2', `GL_MAP2_TEXTURE_COORD_3', or
-`GL_MAP2_TEXTURE_COORD_4' is enabled, then an appropriate `glTexCoord'
-command is simulated.
-
-For color, color index, normal, and texture coordinates the GL uses
-evaluated values instead of current values for those evaluations that
-are enabled, and current values otherwise, However, the evaluated values
-do not update the current values. Thus, if `glVertex' commands are
-interspersed with `glEvalCoord' commands, the color, normal, and texture
-coordinates associated with the `glVertex' commands are not affected by
-the values generated by the `glEvalCoord' commands, but only by the most
-recent `glColor', `glIndex', `glNormal', and `glTexCoord' commands.
-
-No commands are issued for maps that are not enabled. If more than one
-texture evaluation is enabled for a particular dimension (for example,
-`GL_MAP2_TEXTURE_COORD_1' and `GL_MAP2_TEXTURE_COORD_2'), then only the
-evaluation of the map that produces the larger number of coordinates (in
-this case, `GL_MAP2_TEXTURE_COORD_2') is carried out. `GL_MAP1_VERTEX_4'
-overrides `GL_MAP1_VERTEX_3', and `GL_MAP2_VERTEX_4' overrides
-`GL_MAP2_VERTEX_3', in the same manner. If neither a three- nor a
-four-component vertex map is enabled for the specified dimension, the
-`glEvalCoord' command is ignored.
-
-If you have enabled automatic normal generation, by calling `glEnable'
-with argument `GL_AUTO_NORMAL', `glEvalCoord2' generates surface normals
-analytically, regardless of the contents or enabling of the
-`GL_MAP2_NORMAL' map. Let
-
-`m'=∂`p',/∂U,,×∂`p',/∂V,,
-
-Then the generated normal `n' is `n'=`m'/∥`m',∥,
-
-If automatic normal generation is disabled, the corresponding normal map
-`GL_MAP2_NORMAL', if enabled, is used to produce a normal. If neither
-automatic normal generation nor a normal map is enabled, no normal is
-generated for `glEvalCoord2' commands.")
-
-(define-gl-procedure
- glEvalMesh
- "glEvalMesh"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glEvalMesh1"))
- (paramdef "GLenum " (parameter "mode"))
- (paramdef "GLint " (parameter "i1"))
- (paramdef "GLint " (parameter "i2"))))
- "compute a one- or two-dimensional grid of points or lines
-=========================================================
-
-
-Parameters
-==========
-
-MODE
- In `glEvalMesh1', specifies whether to compute a one-dimensional
- mesh of points or lines. Symbolic constants `GL_POINT' and
- `GL_LINE' are accepted.
-
-I1
- I2
-
- Specify the first and last integer values for grid domain variable
- I.
-
-
-Description
-===========
-
-`glMapGrid' and `glEvalMesh' are used in tandem to efficiently generate
-and evaluate a series of evenly-spaced map domain values. `glEvalMesh'
-steps through the integer domain of a one- or two-dimensional grid,
-whose range is the domain of the evaluation maps specified by `glMap1'
-and `glMap2'. MODE determines whether the resulting vertices are
-connected as points, lines, or filled polygons.
-
-In the one-dimensional case, `glEvalMesh1', the mesh is generated as if
-the following code fragment were executed:
-
-glBegin( TYPE ); for ( i = I1; i <= I2; i += 1 ) glEvalCoord1( i·ΔU+U_1
-); glEnd(); where
-
-ΔU=(U_2-U_1,)/N
-
-and N, U_1, and U_2 are the arguments to the most recent `glMapGrid1'
-command. TYPE is `GL_POINTS' if MODE is `GL_POINT', or `GL_LINES' if
-MODE is `GL_LINE'.
-
-The one absolute numeric requirement is that if I=N, then the value
-computed from I·ΔU+U_1 is exactly U_2.
-
-In the two-dimensional case, `glEvalMesh2', let .cp ΔU=(U_2-U_1,)/N
-
-ΔV=(V_2-V_1,)/M
-
-where N, U_1, U_2, M, V_1, and V_2 are the arguments to the most recent
-`glMapGrid2' command. Then, if MODE is `GL_FILL', the `glEvalMesh2'
-command is equivalent to:
-
-for ( j = J1; j < J2; j += 1 ) { glBegin( GL_QUAD_STRIP ); for ( i = I1;
-i <= I2; i += 1 ) { glEvalCoord2( i·ΔU+U_1,j·ΔV+V_1 ); glEvalCoord2(
-i·ΔU+U_1,(j+1,)·ΔV+V_1 ); } glEnd(); }
-
-If MODE is `GL_LINE', then a call to `glEvalMesh2' is equivalent to:
-
-for ( j = J1; j <= J2; j += 1 ) { glBegin( GL_LINE_STRIP ); for ( i =
-I1; i <= I2; i += 1 ) glEvalCoord2( i·ΔU+U_1,j·ΔV+V_1 ); glEnd(); } for
-( i = I1; i <= I2; i += 1 ) { glBegin( GL_LINE_STRIP ); for ( j = J1; j
-<= J1; j += 1 ) glEvalCoord2( i·ΔU+U_1,j·ΔV+V_1 ); glEnd(); }
-
-And finally, if MODE is `GL_POINT', then a call to `glEvalMesh2' is
-equivalent to:
-
-glBegin( GL_POINTS ); for ( j = J1; j <= J2; j += 1 ) for ( i = I1; i <=
-I2; i += 1 ) glEvalCoord2( i·ΔU+U_1,j·ΔV+V_1 ); glEnd();
-
-In all three cases, the only absolute numeric requirements are that if
-I=N, then the value computed from I·ΔU+U_1 is exactly U_2, and if J=M,
-then the value computed from J·ΔV+V_1 is exactly V_2.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if MODE is not an accepted value.
-
-`GL_INVALID_OPERATION' is generated if `glEvalMesh' is executed between
-the execution of `glBegin' and the corresponding execution of `glEnd'.")
-
-(define-gl-procedure
- glEvalPoint
- "glEvalPoint"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glEvalPoint1"))
- (paramdef "GLint " (parameter "i"))))
- "generate and evaluate a single point in a mesh
-==============================================
-
-
-Parameters
-==========
-
-I
- Specifies the integer value for grid domain variable I.
-
-J
- Specifies the integer value for grid domain variable J
- (`glEvalPoint2' only).
-
-
-Description
-===========
-
-`glMapGrid' and `glEvalMesh' are used in tandem to efficiently generate
-and evaluate a series of evenly spaced map domain values. `glEvalPoint'
-can be used to evaluate a single grid point in the same gridspace that
-is traversed by `glEvalMesh'. Calling `glEvalPoint1' is equivalent to
-calling glEvalCoord1( i·ΔU+U_1 ); where ΔU=(U_2-U_1,)/N
-
-and N, U_1, and U_2 are the arguments to the most recent `glMapGrid1'
-command. The one absolute numeric requirement is that if I=N, then the
-value computed from I·ΔU+U_1 is exactly U_2.
-
-In the two-dimensional case, `glEvalPoint2', let
-
-ΔU=(U_2-U_1,)/NΔV=(V_2-V_1,)/M
-
-where N, U_1, U_2, M, V_1, and V_2 are the arguments to the most recent
-`glMapGrid2' command. Then the `glEvalPoint2' command is equivalent to
-calling glEvalCoord2( i·ΔU+U_1,j·ΔV+V_1 ); The only absolute numeric
-requirements are that if I=N, then the value computed from I·ΔU+U_1 is
-exactly U_2, and if J=M, then the value computed from J·ΔV+V_1 is
-exactly V_2.")
-
-(define-gl-procedure
- glFeedbackBuffer
- "glFeedbackBuffer"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glFeedbackBuffer"))
- (paramdef "GLsizei " (parameter "size"))
- (paramdef "GLenum " (parameter "type"))
- (paramdef "GLfloat * " (parameter "buffer"))))
- "controls feedback mode
-======================
-
-
-Parameters
-==========
-
-SIZE
- Specifies the maximum number of values that can be written into
- BUFFER.
-
-TYPE
- Specifies a symbolic constant that describes the information that
- will be returned for each vertex. `GL_2D', `GL_3D', `GL_3D_COLOR',
- `GL_3D_COLOR_TEXTURE', and `GL_4D_COLOR_TEXTURE' are accepted.
-
-BUFFER
- Returns the feedback data.
-
-
-Description
-===========
-
-The `glFeedbackBuffer' function controls feedback. Feedback, like
-selection, is a GL mode. The mode is selected by calling `glRenderMode'
-with `GL_FEEDBACK'. When the GL is in feedback mode, no pixels are
-produced by rasterization. Instead, information about primitives that
-would have been rasterized is fed back to the application using the GL.
-
-`glFeedbackBuffer' has three arguments: BUFFER is a pointer to an array
-of floating-point values into which feedback information is placed. SIZE
-indicates the size of the array. TYPE is a symbolic constant describing
-the information that is fed back for each vertex. `glFeedbackBuffer'
-must be issued before feedback mode is enabled (by calling
-`glRenderMode' with argument `GL_FEEDBACK'). Setting `GL_FEEDBACK'
-without establishing the feedback buffer, or calling `glFeedbackBuffer'
-while the GL is in feedback mode, is an error.
-
-When `glRenderMode' is called while in feedback mode, it returns the
-number of entries placed in the feedback array and resets the feedback
-array pointer to the base of the feedback buffer. The returned value
-never exceeds SIZE. If the feedback data required more room than was
-available in BUFFER, `glRenderMode' returns a negative value. To take
-the GL out of feedback mode, call `glRenderMode' with a parameter value
-other than `GL_FEEDBACK'.
-
-While in feedback mode, each primitive, bitmap, or pixel rectangle that
-would be rasterized generates a block of values that are copied into the
-feedback array. If doing so would cause the number of entries to exceed
-the maximum, the block is partially written so as to fill the array (if
-there is any room left at all), and an overflow flag is set. Each block
-begins with a code indicating the primitive type, followed by values
-that describe the primitive's vertices and associated data. Entries are
-also written for bitmaps and pixel rectangles. Feedback occurs after
-polygon culling and `glPolygonMode' interpretation of polygons has taken
-place, so polygons that are culled are not returned in the feedback
-buffer. It can also occur after polygons with more than three edges are
-broken up into triangles, if the GL implementation renders polygons by
-performing this decomposition.
-
-The `glPassThrough' command can be used to insert a marker into the
-feedback buffer. See `glPassThrough'.
-
-Following is the grammar for the blocks of values written into the
-feedback buffer. Each primitive is indicated with a unique identifying
-value followed by some number of vertices. Polygon entries include an
-integer value indicating how many vertices follow. A vertex is fed back
-as some number of floating-point values, as determined by TYPE. Colors
-are fed back as four values in RGBA mode and one value in color index
-mode.
-
-feedbackList ← feedbackItem feedbackList | feedbackItem feedbackItem ←
-point | lineSegment | polygon | bitmap | pixelRectangle | passThru point
-←`GL_POINT_TOKEN' vertex lineSegment ←`GL_LINE_TOKEN' vertex vertex |
-`GL_LINE_RESET_TOKEN' vertex vertex polygon ←`GL_POLYGON_TOKEN' n
-polySpec polySpec ← polySpec vertex | vertex vertex vertex bitmap
-←`GL_BITMAP_TOKEN' vertex pixelRectangle ←`GL_DRAW_PIXEL_TOKEN' vertex |
-`GL_COPY_PIXEL_TOKEN' vertex passThru ←`GL_PASS_THROUGH_TOKEN' value
-vertex ← 2d | 3d | 3dColor | 3dColorTexture | 4dColorTexture 2d ← value
-value 3d ← value value value 3dColor ← value value value color
-3dColorTexture ← value value value color tex 4dColorTexture ← value
-value value value color tex color ← rgba | index rgba ← value value
-value value index ← value tex ← value value value value
-
-VALUE is a floating-point number, and N is a floating-point integer
-giving the number of vertices in the polygon. `GL_POINT_TOKEN',
-`GL_LINE_TOKEN', `GL_LINE_RESET_TOKEN', `GL_POLYGON_TOKEN',
-`GL_BITMAP_TOKEN', `GL_DRAW_PIXEL_TOKEN', `GL_COPY_PIXEL_TOKEN' and
-`GL_PASS_THROUGH_TOKEN' are symbolic floating-point constants.
-`GL_LINE_RESET_TOKEN' is returned whenever the line stipple pattern is
-reset. The data returned as a vertex depends on the feedback TYPE.
-
-The following table gives the correspondence between TYPE and the number
-of values per vertex. K is 1 in color index mode and 4 in RGBA mode.
-
-
-
-* Type *
-*
-Coordinates *, *
-Color *, *
-Texture *, *
-Total Number of Values *`GL_2D'
-X, Y, , ,
-2 `GL_3D'
-X, Y, Z, , ,
-3 `GL_3D_COLOR'
-X, Y, Z, K, , 3+K`GL_3D_COLOR_TEXTURE'
-X, Y, Z, K,
-4 , 7+K`GL_4D_COLOR_TEXTURE'
-X, Y, Z, W, K,
-4 , 8+KFeedback vertex coordinates are in window coordinates, except W, which
-is in clip coordinates. Feedback colors are lighted, if lighting is
-enabled. Feedback texture coordinates are generated, if texture
-coordinate generation is enabled. They are always transformed by the
-texture matrix.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if TYPE is not an accepted value.
-
-`GL_INVALID_VALUE' is generated if SIZE is negative.
-
-`GL_INVALID_OPERATION' is generated if `glFeedbackBuffer' is called
-while the render mode is `GL_FEEDBACK', or if `glRenderMode' is called
-with argument `GL_FEEDBACK' before `glFeedbackBuffer' is called at least
-once.
-
-`GL_INVALID_OPERATION' is generated if `glFeedbackBuffer' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glFinish
- "glFinish"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glFinish"))
- (paramdef (parameter "void"))))
- "block until all GL execution is complete
-========================================
-
-
-Description
-===========
-
-`glFinish' does not return until the effects of all previously called GL
-commands are complete. Such effects include all changes to GL state, all
-changes to connection state, and all changes to the frame buffer
-contents.
-
-
-Errors
-======
-
-`GL_INVALID_OPERATION' is generated if `glFinish' is executed between
-the execution of `glBegin' and the corresponding execution of `glEnd'.")
-
-(define-gl-procedure
- glFlush
- "glFlush"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glFlush"))
- (paramdef (parameter "void"))))
- "force execution of GL commands in finite time
-=============================================
-
-
-Description
-===========
-
-Different GL implementations buffer commands in several different
-locations, including network buffers and the graphics accelerator
-itself. `glFlush' empties all of these buffers, causing all issued
-commands to be executed as quickly as they are accepted by the actual
-rendering engine. Though this execution may not be completed in any
-particular time period, it does complete in finite time.
-
-Because any GL program might be executed over a network, or on an
-accelerator that buffers commands, all programs should call `glFlush'
-whenever they count on having all of their previously issued commands
-completed. For example, call `glFlush' before waiting for user input
-that depends on the generated image.
-
-
-Errors
-======
-
-`GL_INVALID_OPERATION' is generated if `glFlush' is executed between the
-execution of `glBegin' and the corresponding execution of `glEnd'.")
-
-(define-gl-procedure
- glFogCoordPointer
- "glFogCoordPointer"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glFogCoordPointer"))
- (paramdef "GLenum " (parameter "type"))
- (paramdef "GLsizei " (parameter "stride"))
- (paramdef "GLvoid * " (parameter "pointer"))))
- "define an array of fog coordinates
-==================================
-
-
-Parameters
-==========
-
-TYPE
- Specifies the data type of each fog coordinate. Symbolic constants
- `GL_FLOAT', or `GL_DOUBLE' are accepted. The initial value is
- `GL_FLOAT'.
-
-STRIDE
- Specifies the byte offset between consecutive fog coordinates. If
- STRIDE is 0, the array elements are understood to be tightly
- packed. The initial value is 0.
-
-POINTER
- Specifies a pointer to the first coordinate of the first fog
- coordinate in the array. The initial value is 0.
-
-
-Description
-===========
-
-`glFogCoordPointer' specifies the location and data format of an array
-of fog coordinates to use when rendering. TYPE specifies the data type
-of each fog coordinate, and STRIDE specifies the byte stride from one
-fog coordinate to the next, allowing vertices and attributes to be
-packed into a single array or stored in separate arrays.
-
-If a non-zero named buffer object is bound to the `GL_ARRAY_BUFFER'
-target (see `glBindBuffer') while a fog coordinate array is specified,
-POINTER is treated as a byte offset into the buffer object's data store.
-Also, the buffer object binding (`GL_ARRAY_BUFFER_BINDING') is saved as
-fog coordinate vertex array client-side state
-(`GL_FOG_COORD_ARRAY_BUFFER_BINDING').
-
-When a fog coordinate array is specified, TYPE, STRIDE, and POINTER are
-saved as client-side state, in addition to the current vertex array
-buffer object binding.
-
-To enable and disable the fog coordinate array, call
-`glEnableClientState' and `glDisableClientState' with the argument
-`GL_FOG_COORD_ARRAY'. If enabled, the fog coordinate array is used when
-`glDrawArrays', `glMultiDrawArrays', `glDrawElements',
-`glMultiDrawElements', `glDrawRangeElements', or `glArrayElement' is
-called.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if TYPE is not either `GL_FLOAT' or
-`GL_DOUBLE'.
-
-`GL_INVALID_VALUE' is generated if STRIDE is negative.")
-
-(define-gl-procedure
- glFogCoord
- "glFogCoord"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glFogCoordd"))
- (paramdef "GLdouble " (parameter "coord"))))
- "set the current fog coordinates
-===============================
-
-
-Parameters
-==========
-
-COORD
- Specify the fog distance.
-
-
-Description
-===========
-
-`glFogCoord' specifies the fog coordinate that is associated with each
-vertex and the current raster position. The value specified is
-interpolated and used in computing the fog color (see `glFog').")
-
-(define-gl-procedure
- glFog
- "glFog"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glFogf"))
- (paramdef "GLenum " (parameter "pname"))
- (paramdef "GLfloat " (parameter "param"))))
- "specify fog parameters
-======================
-
-
-Parameters
-==========
-
-PNAME
- Specifies a single-valued fog parameter. `GL_FOG_MODE',
- `GL_FOG_DENSITY', `GL_FOG_START', `GL_FOG_END', `GL_FOG_INDEX', and
- `GL_FOG_COORD_SRC' are accepted.
-
-PARAM
- Specifies the value that PNAME will be set to.
-
-
-Description
-===========
-
-Fog is initially disabled. While enabled, fog affects rasterized
-geometry, bitmaps, and pixel blocks, but not buffer clear operations. To
-enable and disable fog, call `glEnable' and `glDisable' with argument
-`GL_FOG'.
-
-`glFog' assigns the value or values in PARAMS to the fog parameter
-specified by PNAME. The following values are accepted for PNAME:
-
-`GL_FOG_MODE'
- PARAMS is a single integer or floating-point value that specifies
- the equation to be used to compute the fog blend factor, F. Three
- symbolic constants are accepted: `GL_LINEAR', `GL_EXP', and
- `GL_EXP2'. The equations corresponding to these symbolic constants
- are defined below. The initial fog mode is `GL_EXP'.
-
-`GL_FOG_DENSITY'
- PARAMS is a single integer or floating-point value that specifies
- DENSITY, the fog density used in both exponential fog equations.
- Only nonnegative densities are accepted. The initial fog density is
- 1.
-
-`GL_FOG_START'
- PARAMS is a single integer or floating-point value that specifies
- START, the near distance used in the linear fog equation. The
- initial near distance is 0.
-
-`GL_FOG_END'
- PARAMS is a single integer or floating-point value that specifies
- END, the far distance used in the linear fog equation. The initial
- far distance is 1.
-
-`GL_FOG_INDEX'
- PARAMS is a single integer or floating-point value that specifies
- I_F, the fog color index. The initial fog index is 0.
-
-`GL_FOG_COLOR'
- PARAMS contains four integer or floating-point values that specify
- C_F, the fog color. Integer values are mapped linearly such that
- the most positive representable value maps to 1.0, and the most
- negative representable value maps to -1.0. Floating-point values
- are mapped directly. After conversion, all color components are
- clamped to the range [0,1]. The initial fog color is (0, 0, 0, 0).
-
-`GL_FOG_COORD_SRC'
- PARAMS contains either of the following symbolic constants:
- `GL_FOG_COORD' or `GL_FRAGMENT_DEPTH'. `GL_FOG_COORD' specifies
- that the current fog coordinate should be used as distance value in
- the fog color computation. `GL_FRAGMENT_DEPTH' specifies that the
- current fragment depth should be used as distance value in the fog
- computation.
-
-Fog blends a fog color with each rasterized pixel fragment's
-post-texturing color using a blending factor F. Factor F is computed in
-one of three ways, depending on the fog mode. Let C be either the
-distance in eye coordinate from the origin (in the case that the
-`GL_FOG_COORD_SRC' is `GL_FRAGMENT_DEPTH') or the current fog coordinate
-(in the case that `GL_FOG_COORD_SRC' is `GL_FOG_COORD'). The equation
-for `GL_LINEAR' fog is F=END-C,/END-START,
-
-The equation for `GL_EXP' fog is F=E^-(DENSITY·C,),
-
-The equation for `GL_EXP2' fog is F=E^-(DENSITY·C,),^2
-
-Regardless of the fog mode, F is clamped to the range [0,1] after it is
-computed. Then, if the GL is in RGBA color mode, the fragment's red,
-green, and blue colors, represented by C_R, are replaced by
-
-C_R,^″=F×C_R+(1-F,)×C_F
-
-Fog does not affect a fragment's alpha component.
-
-In color index mode, the fragment's color index I_R is replaced by
-
-I_R,^″=I_R+(1-F,)×I_F
-
-
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if PNAME is not an accepted value, or if
-PNAME is `GL_FOG_MODE' and PARAMS is not an accepted value.
-
-`GL_INVALID_VALUE' is generated if PNAME is `GL_FOG_DENSITY' and PARAMS
-is negative.
-
-`GL_INVALID_OPERATION' is generated if `glFog' is executed between the
-execution of `glBegin' and the corresponding execution of `glEnd'.")
-
-(define-gl-procedure
- glFrontFace
- "glFrontFace"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glFrontFace"))
- (paramdef "GLenum " (parameter "mode"))))
- "define front- and back-facing polygons
-======================================
-
-
-Parameters
-==========
-
-MODE
- Specifies the orientation of front-facing polygons. `GL_CW' and
- `GL_CCW' are accepted. The initial value is `GL_CCW'.
-
-
-Description
-===========
-
-In a scene composed entirely of opaque closed surfaces, back-facing
-polygons are never visible. Eliminating these invisible polygons has the
-obvious benefit of speeding up the rendering of the image. To enable and
-disable elimination of back-facing polygons, call `glEnable' and
-`glDisable' with argument `GL_CULL_FACE'.
-
-The projection of a polygon to window coordinates is said to have
-clockwise winding if an imaginary object following the path from its
-first vertex, its second vertex, and so on, to its last vertex, and
-finally back to its first vertex, moves in a clockwise direction about
-the interior of the polygon. The polygon's winding is said to be
-counterclockwise if the imaginary object following the same path moves
-in a counterclockwise direction about the interior of the polygon.
-`glFrontFace' specifies whether polygons with clockwise winding in
-window coordinates, or counterclockwise winding in window coordinates,
-are taken to be front-facing. Passing `GL_CCW' to MODE selects
-counterclockwise polygons as front-facing; `GL_CW' selects clockwise
-polygons as front-facing. By default, counterclockwise polygons are
-taken to be front-facing.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if MODE is not an accepted value.
-
-`GL_INVALID_OPERATION' is generated if `glFrontFace' is executed between
-the execution of `glBegin' and the corresponding execution of `glEnd'.")
-
-(define-gl-procedure
- glFrustum
- "glFrustum"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glFrustum"))
- (paramdef "GLdouble " (parameter "left"))
- (paramdef "GLdouble " (parameter "right"))
- (paramdef "GLdouble " (parameter "bottom"))
- (paramdef "GLdouble " (parameter "top"))
- (paramdef "GLdouble " (parameter "nearVal"))
- (paramdef "GLdouble " (parameter "farVal"))))
- "multiply the current matrix by a perspective matrix
-===================================================
-
-
-Parameters
-==========
-
-LEFT
- RIGHT
-
- Specify the coordinates for the left and right vertical clipping
- planes.
-
-BOTTOM
- TOP
-
- Specify the coordinates for the bottom and top horizontal clipping
- planes.
-
-NEARVAL
- FARVAL
-
- Specify the distances to the near and far depth clipping planes.
- Both distances must be positive.
-
-
-Description
-===========
-
-`glFrustum' describes a perspective matrix that produces a perspective
-projection. The current matrix (see `glMatrixMode') is multiplied by
-this matrix and the result replaces the current matrix, as if
-`glMultMatrix' were called with the following matrix as its argument:
-
-
-
-[(2\u2062NEARVAL,/RIGHT-LEFT,, 0 A 0), (0 2\u2062NEARVAL,/TOP-BOTTOM,, B 0), (0 0
-C D), (0 0 -1 0),]
-
-A=RIGHT+LEFT,/RIGHT-LEFT,
-
-B=TOP+BOTTOM,/TOP-BOTTOM,
-
-C=-FARVAL+NEARVAL,/FARVAL-NEARVAL,,
-
-D=-2\u2062FARVAL\u2062NEARVAL,/FARVAL-NEARVAL,,
-
-
-
-Typically, the matrix mode is `GL_PROJECTION', and (LEFT,BOTTOM-NEARVAL)
-and (RIGHT,TOP-NEARVAL) specify the points on the near clipping plane
-that are mapped to the lower left and upper right corners of the window,
-assuming that the eye is located at (0, 0, 0). -FARVAL specifies the
-location of the far clipping plane. Both NEARVAL and FARVAL must be
-positive.
-
-Use `glPushMatrix' and `glPopMatrix' to save and restore the current
-matrix stack.
-
-
-Errors
-======
-
-`GL_INVALID_VALUE' is generated if NEARVAL or FARVAL is not positive, or
-if LEFT = RIGHT, or BOTTOM = TOP, or NEAR = FAR.
-
-`GL_INVALID_OPERATION' is generated if `glFrustum' is executed between
-the execution of `glBegin' and the corresponding execution of `glEnd'.")
-
-(define-gl-procedure
- glGenBuffers
- "glGenBuffers"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glGenBuffers"))
- (paramdef "GLsizei " (parameter "n"))
- (paramdef "GLuint * " (parameter "buffers"))))
- "generate buffer object names
-============================
-
-
-Parameters
-==========
-
-N
- Specifies the number of buffer object names to be generated.
-
-BUFFERS
- Specifies an array in which the generated buffer object names are
- stored.
-
-
-Description
-===========
-
-`glGenBuffers' returns N buffer object names in BUFFERS. There is no
-guarantee that the names form a contiguous set of integers; however, it
-is guaranteed that none of the returned names was in use immediately
-before the call to `glGenBuffers'.
-
-Buffer object names returned by a call to `glGenBuffers' are not
-returned by subsequent calls, unless they are first deleted with
-`glDeleteBuffers'.
-
-No buffer objects are associated with the returned buffer object names
-until they are first bound by calling `glBindBuffer'.
-
-
-Errors
-======
-
-`GL_INVALID_VALUE' is generated if N is negative.
-
-`GL_INVALID_OPERATION' is generated if `glGenBuffers' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glGenLists
- "glGenLists"
- (funcsynopsis
- (funcprototype
- (funcdef "GLuint " (function "glGenLists"))
- (paramdef "GLsizei " (parameter "range"))))
- "generate a contiguous set of empty display lists
-================================================
-
-
-Parameters
-==========
-
-RANGE
- Specifies the number of contiguous empty display lists to be
- generated.
-
-
-Description
-===========
-
-`glGenLists' has one argument, RANGE. It returns an integer N such that
-RANGE contiguous empty display lists, named N, N+1, ..., N+RANGE-1, are
-created. If RANGE is 0, if there is no group of RANGE contiguous names
-available, or if any error is generated, no display lists are generated,
-and 0 is returned.
-
-
-Errors
-======
-
-`GL_INVALID_VALUE' is generated if RANGE is negative.
-
-`GL_INVALID_OPERATION' is generated if `glGenLists' is executed between
-the execution of `glBegin' and the corresponding execution of `glEnd'.")
-
-(define-gl-procedure
- glGenQueries
- "glGenQueries"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glGenQueries"))
- (paramdef "GLsizei " (parameter "n"))
- (paramdef "GLuint * " (parameter "ids"))))
- "generate query object names
-===========================
-
-
-Parameters
-==========
-
-N
- Specifies the number of query object names to be generated.
-
-IDS
- Specifies an array in which the generated query object names are
- stored.
-
-
-Description
-===========
-
-`glGenQueries' returns N query object names in IDS. There is no
-guarantee that the names form a contiguous set of integers; however, it
-is guaranteed that none of the returned names was in use immediately
-before the call to `glGenQueries'.
-
-Query object names returned by a call to `glGenQueries' are not returned
-by subsequent calls, unless they are first deleted with
-`glDeleteQueries'.
-
-No query objects are associated with the returned query object names
-until they are first used by calling `glBeginQuery'.
-
-
-Errors
-======
-
-`GL_INVALID_VALUE' is generated if N is negative.
-
-`GL_INVALID_OPERATION' is generated if `glGenQueries' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glGenTextures
- "glGenTextures"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glGenTextures"))
- (paramdef "GLsizei " (parameter "n"))
- (paramdef "GLuint * " (parameter "textures"))))
- "generate texture names
-======================
-
-
-Parameters
-==========
-
-N
- Specifies the number of texture names to be generated.
-
-TEXTURES
- Specifies an array in which the generated texture names are stored.
-
-
-Description
-===========
-
-`glGenTextures' returns N texture names in TEXTURES. There is no
-guarantee that the names form a contiguous set of integers; however, it
-is guaranteed that none of the returned names was in use immediately
-before the call to `glGenTextures'.
-
-The generated textures have no dimensionality; they assume the
-dimensionality of the texture target to which they are first bound (see
-`glBindTexture').
-
-Texture names returned by a call to `glGenTextures' are not returned by
-subsequent calls, unless they are first deleted with `glDeleteTextures'.
-
-
-Errors
-======
-
-`GL_INVALID_VALUE' is generated if N is negative.
-
-`GL_INVALID_OPERATION' is generated if `glGenTextures' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glGetActiveAttrib
- "glGetActiveAttrib"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glGetActiveAttrib"))
- (paramdef "GLuint " (parameter "program"))
- (paramdef "GLuint " (parameter "index"))
- (paramdef "GLsizei " (parameter "bufSize"))
- (paramdef "GLsizei *" (parameter "length"))
- (paramdef "GLint *" (parameter "size"))
- (paramdef "GLenum *" (parameter "type"))
- (paramdef "GLchar *" (parameter "name"))))
- "Returns information about an active attribute variable for the specified program object
-=======================================================================================
-
-
-Parameters
-==========
-
-PROGRAM
- Specifies the program object to be queried.
-
-INDEX
- Specifies the index of the attribute variable to be queried.
-
-BUFSIZE
- Specifies the maximum number of characters OpenGL is allowed to
- write in the character buffer indicated by NAME.
-
-LENGTH
- Returns the number of characters actually written by OpenGL in the
- string indicated by NAME (excluding the null terminator) if a value
- other than `NULL' is passed.
-
-SIZE
- Returns the size of the attribute variable.
-
-TYPE
- Returns the data type of the attribute variable.
-
-NAME
- Returns a null terminated string containing the name of the
- attribute variable.
-
-
-Description
-===========
-
-`glGetActiveAttrib' returns information about an active attribute
-variable in the program object specified by PROGRAM. The number of
-active attributes can be obtained by calling `glGetProgram' with the
-value `GL_ACTIVE_ATTRIBUTES'. A value of 0 for INDEX selects the first
-active attribute variable. Permissible values for INDEX range from 0 to
-the number of active attribute variables minus 1.
-
-A vertex shader may use either built-in attribute variables,
-user-defined attribute variables, or both. Built-in attribute variables
-have a prefix of \"gl_\" and reference conventional OpenGL vertex
-attribtes (e.g., GL_VERTEX, GL_NORMAL, etc., see the OpenGL Shading
-Language specification for a complete list.) User-defined attribute
-variables have arbitrary names and obtain their values through numbered
-generic vertex attributes. An attribute variable (either built-in or
-user-defined) is considered active if it is determined during the link
-operation that it may be accessed during program execution. Therefore,
-PROGRAM should have previously been the target of a call to
-`glLinkProgram', but it is not necessary for it to have been linked
-successfully.
-
-The size of the character buffer required to store the longest attribute
-variable name in PROGRAM can be obtained by calling `glGetProgram' with
-the value `GL_ACTIVE_ATTRIBUTE_MAX_LENGTH'. This value should be used to
-allocate a buffer of sufficient size to store the returned attribute
-name. The size of this character buffer is passed in BUFSIZE, and a
-pointer to this character buffer is passed in NAME.
-
-`glGetActiveAttrib' returns the name of the attribute variable indicated
-by INDEX, storing it in the character buffer specified by NAME. The
-string returned will be null terminated. The actual number of characters
-written into this buffer is returned in LENGTH, and this count does not
-include the null termination character. If the length of the returned
-string is not required, a value of `NULL' can be passed in the LENGTH
-argument.
-
-The TYPE argument will return a pointer to the attribute variable's data
-type. The symbolic constants `GL_FLOAT', `GL_FLOAT_VEC2',
-`GL_FLOAT_VEC3', `GL_FLOAT_VEC4', `GL_FLOAT_MAT2', `GL_FLOAT_MAT3',
-`GL_FLOAT_MAT4', `GL_FLOAT_MAT2x3', `GL_FLOAT_MAT2x4',
-`GL_FLOAT_MAT3x2', `GL_FLOAT_MAT3x4', `GL_FLOAT_MAT4x2', or
-`GL_FLOAT_MAT4x3' may be returned. The SIZE argument will return the
-size of the attribute, in units of the type returned in TYPE.
-
-The list of active attribute variables may include both built-in
-attribute variables (which begin with the prefix \"gl_\") as well as
-user-defined attribute variable names.
-
-This function will return as much information as it can about the
-specified active attribute variable. If no information is available,
-LENGTH will be 0, and NAME will be an empty string. This situation could
-occur if this function is called after a link operation that failed. If
-an error occurs, the return values LENGTH, SIZE, TYPE, and NAME will be
-unmodified.
-
-
-Errors
-======
-
-`GL_INVALID_VALUE' is generated if PROGRAM is not a value generated by
-OpenGL.
-
-`GL_INVALID_OPERATION' is generated if PROGRAM is not a program object.
-
-`GL_INVALID_VALUE' is generated if INDEX is greater than or equal to the
-number of active attribute variables in PROGRAM.
-
-`GL_INVALID_OPERATION' is generated if `glGetActiveAttrib' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.
-
-`GL_INVALID_VALUE' is generated if BUFSIZE is less than 0.")
-
-(define-gl-procedure
- glGetActiveUniform
- "glGetActiveUniform"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glGetActiveUniform"))
- (paramdef "GLuint " (parameter "program"))
- (paramdef "GLuint " (parameter "index"))
- (paramdef "GLsizei " (parameter "bufSize"))
- (paramdef "GLsizei *" (parameter "length"))
- (paramdef "GLint *" (parameter "size"))
- (paramdef "GLenum *" (parameter "type"))
- (paramdef "GLchar *" (parameter "name"))))
- "Returns information about an active uniform variable for the specified program object
-=====================================================================================
-
-
-Parameters
-==========
-
-PROGRAM
- Specifies the program object to be queried.
-
-INDEX
- Specifies the index of the uniform variable to be queried.
-
-BUFSIZE
- Specifies the maximum number of characters OpenGL is allowed to
- write in the character buffer indicated by NAME.
-
-LENGTH
- Returns the number of characters actually written by OpenGL in the
- string indicated by NAME (excluding the null terminator) if a value
- other than `NULL' is passed.
-
-SIZE
- Returns the size of the uniform variable.
-
-TYPE
- Returns the data type of the uniform variable.
-
-NAME
- Returns a null terminated string containing the name of the uniform
- variable.
-
-
-Description
-===========
-
-`glGetActiveUniform' returns information about an active uniform
-variable in the program object specified by PROGRAM. The number of
-active uniform variables can be obtained by calling `glGetProgram' with
-the value `GL_ACTIVE_UNIFORMS'. A value of 0 for INDEX selects the first
-active uniform variable. Permissible values for INDEX range from 0 to
-the number of active uniform variables minus 1.
-
-Shaders may use either built-in uniform variables, user-defined uniform
-variables, or both. Built-in uniform variables have a prefix of \"gl_\"
-and reference existing OpenGL state or values derived from such state
-(e.g., GL_FOG, GL_MODELVIEWMATRIX, etc., see the OpenGL Shading Language
-specification for a complete list.) User-defined uniform variables have
-arbitrary names and obtain their values from the application through
-calls to `glUniform'. A uniform variable (either built-in or
-user-defined) is considered active if it is determined during the link
-operation that it may be accessed during program execution. Therefore,
-PROGRAM should have previously been the target of a call to
-`glLinkProgram', but it is not necessary for it to have been linked
-successfully.
-
-The size of the character buffer required to store the longest uniform
-variable name in PROGRAM can be obtained by calling `glGetProgram' with
-the value `GL_ACTIVE_UNIFORM_MAX_LENGTH'. This value should be used to
-allocate a buffer of sufficient size to store the returned uniform
-variable name. The size of this character buffer is passed in BUFSIZE,
-and a pointer to this character buffer is passed in NAME.
-
-`glGetActiveUniform' returns the name of the uniform variable indicated
-by INDEX, storing it in the character buffer specified by NAME. The
-string returned will be null terminated. The actual number of characters
-written into this buffer is returned in LENGTH, and this count does not
-include the null termination character. If the length of the returned
-string is not required, a value of `NULL' can be passed in the LENGTH
-argument.
-
-The TYPE argument will return a pointer to the uniform variable's data
-type. The symbolic constants `GL_FLOAT', `GL_FLOAT_VEC2',
-`GL_FLOAT_VEC3', `GL_FLOAT_VEC4', `GL_INT', `GL_INT_VEC2',
-`GL_INT_VEC3', `GL_INT_VEC4', `GL_BOOL', `GL_BOOL_VEC2', `GL_BOOL_VEC3',
-`GL_BOOL_VEC4', `GL_FLOAT_MAT2', `GL_FLOAT_MAT3', `GL_FLOAT_MAT4',
-`GL_FLOAT_MAT2x3', `GL_FLOAT_MAT2x4', `GL_FLOAT_MAT3x2',
-`GL_FLOAT_MAT3x4', `GL_FLOAT_MAT4x2', `GL_FLOAT_MAT4x3',
-`GL_SAMPLER_1D', `GL_SAMPLER_2D', `GL_SAMPLER_3D', `GL_SAMPLER_CUBE',
-`GL_SAMPLER_1D_SHADOW', or `GL_SAMPLER_2D_SHADOW' may be returned.
-
-If one or more elements of an array are active, the name of the array is
-returned in NAME, the type is returned in TYPE, and the SIZE parameter
-returns the highest array element index used, plus one, as determined by
-the compiler and/or linker. Only one active uniform variable will be
-reported for a uniform array.
-
-Uniform variables that are declared as structures or arrays of
-structures will not be returned directly by this function. Instead, each
-of these uniform variables will be reduced to its fundamental components
-containing the \".\" and \"[]\" operators such that each of the names is
-valid as an argument to `glGetUniformLocation'. Each of these reduced
-uniform variables is counted as one active uniform variable and is
-assigned an index. A valid name cannot be a structure, an array of
-structures, or a subcomponent of a vector or matrix.
-
-The size of the uniform variable will be returned in SIZE. Uniform
-variables other than arrays will have a size of 1. Structures and arrays
-of structures will be reduced as described earlier, such that each of
-the names returned will be a data type in the earlier list. If this
-reduction results in an array, the size returned will be as described
-for uniform arrays; otherwise, the size returned will be 1.
-
-The list of active uniform variables may include both built-in uniform
-variables (which begin with the prefix \"gl_\") as well as user-defined
-uniform variable names.
-
-This function will return as much information as it can about the
-specified active uniform variable. If no information is available,
-LENGTH will be 0, and NAME will be an empty string. This situation could
-occur if this function is called after a link operation that failed. If
-an error occurs, the return values LENGTH, SIZE, TYPE, and NAME will be
-unmodified.
-
-
-Errors
-======
-
-`GL_INVALID_VALUE' is generated if PROGRAM is not a value generated by
-OpenGL.
-
-`GL_INVALID_OPERATION' is generated if PROGRAM is not a program object.
-
-`GL_INVALID_VALUE' is generated if INDEX is greater than or equal to the
-number of active uniform variables in PROGRAM.
-
-`GL_INVALID_OPERATION' is generated if `glGetActiveUniform' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.
-
-`GL_INVALID_VALUE' is generated if BUFSIZE is less than 0.")
-
-(define-gl-procedure
- glGetAttachedShaders
- "glGetAttachedShaders"
- (funcsynopsis
- (funcprototype
- (funcdef
- "void "
- (function "glGetAttachedShaders"))
- (paramdef "GLuint " (parameter "program"))
- (paramdef "GLsizei " (parameter "maxCount"))
- (paramdef "GLsizei *" (parameter "count"))
- (paramdef "GLuint *" (parameter "shaders"))))
- "Returns the handles of the shader objects attached to a program object
-======================================================================
-
-
-Parameters
-==========
-
-PROGRAM
- Specifies the program object to be queried.
-
-MAXCOUNT
- Specifies the size of the array for storing the returned object
- names.
-
-COUNT
- Returns the number of names actually returned in OBJECTS.
-
-SHADERS
- Specifies an array that is used to return the names of attached
- shader objects.
-
-
-Description
-===========
-
-`glGetAttachedShaders' returns the names of the shader objects attached
-to PROGRAM. The names of shader objects that are attached to PROGRAM
-will be returned in SHADERS. The actual number of shader names written
-into SHADERS is returned in COUNT. If no shader objects are attached to
-PROGRAM, COUNT is set to 0. The maximum number of shader names that may
-be returned in SHADERS is specified by MAXCOUNT.
-
-If the number of names actually returned is not required (for instance,
-if it has just been obtained by calling `glGetProgram'), a value of
-`NULL' may be passed for count. If no shader objects are attached to
-PROGRAM, a value of 0 will be returned in COUNT. The actual number of
-attached shaders can be obtained by calling `glGetProgram' with the
-value `GL_ATTACHED_SHADERS'.
-
-
-Errors
-======
-
-`GL_INVALID_VALUE' is generated if PROGRAM is not a value generated by
-OpenGL.
-
-`GL_INVALID_OPERATION' is generated if PROGRAM is not a program object.
-
-`GL_INVALID_VALUE' is generated if MAXCOUNT is less than 0.
-
-`GL_INVALID_OPERATION' is generated if `glGetAttachedShaders' is
-executed between the execution of `glBegin' and the corresponding
-execution of `glEnd'.")
-
-(define-gl-procedure
- glGetAttribLocation
- "glGetAttribLocation"
- (funcsynopsis
- (funcprototype
- (funcdef
- "GLint "
- (function "glGetAttribLocation"))
- (paramdef "GLuint " (parameter "program"))
- (paramdef "const GLchar *" (parameter "name"))))
- "Returns the location of an attribute variable
-=============================================
-
-
-Parameters
-==========
-
-PROGRAM
- Specifies the program object to be queried.
-
-NAME
- Points to a null terminated string containing the name of the
- attribute variable whose location is to be queried.
-
-
-Description
-===========
-
-`glGetAttribLocation' queries the previously linked program object
-specified by PROGRAM for the attribute variable specified by NAME and
-returns the index of the generic vertex attribute that is bound to that
-attribute variable. If NAME is a matrix attribute variable, the index of
-the first column of the matrix is returned. If the named attribute
-variable is not an active attribute in the specified program object or
-if NAME starts with the reserved prefix \"gl_\", a value of -1 is
-returned.
-
-The association between an attribute variable name and a generic
-attribute index can be specified at any time by calling
-`glBindAttribLocation'. Attribute bindings do not go into effect until
-`glLinkProgram' is called. After a program object has been linked
-successfully, the index values for attribute variables remain fixed
-until the next link command occurs. The attribute values can only be
-queried after a link if the link was successful. `glGetAttribLocation'
-returns the binding that actually went into effect the last time
-`glLinkProgram' was called for the specified program object. Attribute
-bindings that have been specified since the last link operation are not
-returned by `glGetAttribLocation'.
-
-
-Errors
-======
-
-`GL_INVALID_OPERATION' is generated if PROGRAM is not a value generated
-by OpenGL.
-
-`GL_INVALID_OPERATION' is generated if PROGRAM is not a program object.
-
-`GL_INVALID_OPERATION' is generated if PROGRAM has not been successfully
-linked.
-
-`GL_INVALID_OPERATION' is generated if `glGetAttribLocation' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glGetBufferParameteriv
- "glGetBufferParameteriv"
- (funcsynopsis
- (funcprototype
- (funcdef
- "void "
- (function "glGetBufferParameteriv"))
- (paramdef "GLenum " (parameter "target"))
- (paramdef "GLenum " (parameter "value"))
- (paramdef "GLint * " (parameter "data"))))
- "return parameters of a buffer object
-====================================
-
-
-Parameters
-==========
-
-TARGET
- Specifies the target buffer object. The symbolic constant must be
- `GL_ARRAY_BUFFER', `GL_ELEMENT_ARRAY_BUFFER',
- `GL_PIXEL_PACK_BUFFER', or `GL_PIXEL_UNPACK_BUFFER'.
-
-VALUE
- Specifies the symbolic name of a buffer object parameter. Accepted
- values are `GL_BUFFER_ACCESS', `GL_BUFFER_MAPPED',
- `GL_BUFFER_SIZE', or `GL_BUFFER_USAGE'.
-
-DATA
- Returns the requested parameter.
-
-
-Description
-===========
-
-`glGetBufferParameteriv' returns in DATA a selected parameter of the
-buffer object specified by TARGET.
-
-VALUE names a specific buffer object parameter, as follows:
-
-`GL_BUFFER_ACCESS'
- PARAMS returns the access policy set while mapping the buffer
- object. The initial value is `GL_READ_WRITE'.
-
-`GL_BUFFER_MAPPED'
- PARAMS returns a flag indicating whether the buffer object is
- currently mapped. The initial value is `GL_FALSE'.
-
-`GL_BUFFER_SIZE'
- PARAMS returns the size of the buffer object, measured in bytes.
- The initial value is 0.
-
-`GL_BUFFER_USAGE'
- PARAMS returns the buffer object's usage pattern. The initial value
- is `GL_STATIC_DRAW'.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if TARGET or VALUE is not an accepted
-value.
-
-`GL_INVALID_OPERATION' is generated if the reserved buffer object name 0
-is bound to TARGET.
-
-`GL_INVALID_OPERATION' is generated if `glGetBufferParameteriv' is
-executed between the execution of `glBegin' and the corresponding
-execution of `glEnd'.")
-
-(define-gl-procedure
- glGetBufferPointerv
- "glGetBufferPointerv"
- (funcsynopsis
- (funcprototype
- (funcdef
- "void "
- (function "glGetBufferPointerv"))
- (paramdef "GLenum " (parameter "target"))
- (paramdef "GLenum " (parameter "pname"))
- (paramdef "GLvoid ** " (parameter "params"))))
- "return the pointer to a mapped buffer object's data store
-=========================================================
-
-
-Parameters
-==========
-
-TARGET
- Specifies the target buffer object. The symbolic constant must be
- `GL_ARRAY_BUFFER', `GL_ELEMENT_ARRAY_BUFFER',
- `GL_PIXEL_PACK_BUFFER', or `GL_PIXEL_UNPACK_BUFFER'.
-
-PNAME
- Specifies the pointer to be returned. The symbolic constant must be
- `GL_BUFFER_MAP_POINTER'.
-
-PARAMS
- Returns the pointer value specified by PNAME.
-
-
-Description
-===========
-
-`glGetBufferPointerv' returns pointer information. PNAME is a symbolic
-constant indicating the pointer to be returned, which must be
-`GL_BUFFER_MAP_POINTER', the pointer to which the buffer object's data
-store is mapped. If the data store is not currently mapped, `NULL' is
-returned. PARAMS is a pointer to a location in which to place the
-returned pointer value.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if TARGET or PNAME is not an accepted
-value.
-
-`GL_INVALID_OPERATION' is generated if the reserved buffer object name 0
-is bound to TARGET.
-
-`GL_INVALID_OPERATION' is generated if `glGetBufferPointerv' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glGetBufferSubData
- "glGetBufferSubData"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glGetBufferSubData"))
- (paramdef "GLenum " (parameter "target"))
- (paramdef "GLintptr " (parameter "offset"))
- (paramdef "GLsizeiptr " (parameter "size"))
- (paramdef "GLvoid * " (parameter "data"))))
- "returns a subset of a buffer object's data store
-================================================
-
-
-Parameters
-==========
-
-TARGET
- Specifies the target buffer object. The symbolic constant must be
- `GL_ARRAY_BUFFER', `GL_ELEMENT_ARRAY_BUFFER',
- `GL_PIXEL_PACK_BUFFER', or `GL_PIXEL_UNPACK_BUFFER'.
-
-OFFSET
- Specifies the offset into the buffer object's data store from which
- data will be returned, measured in bytes.
-
-SIZE
- Specifies the size in bytes of the data store region being
- returned.
-
-DATA
- Specifies a pointer to the location where buffer object data is
- returned.
-
-
-Description
-===========
-
-`glGetBufferSubData' returns some or all of the data from the buffer
-object currently bound to TARGET. Data starting at byte offset OFFSET
-and extending for SIZE bytes is copied from the data store to the memory
-pointed to by DATA. An error is thrown if the buffer object is currently
-mapped, or if OFFSET and SIZE together define a range beyond the bounds
-of the buffer object's data store.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if TARGET is not `GL_ARRAY_BUFFER',
-`GL_ELEMENT_ARRAY_BUFFER', `GL_PIXEL_PACK_BUFFER', or
-`GL_PIXEL_UNPACK_BUFFER'.
-
-`GL_INVALID_VALUE' is generated if OFFSET or SIZE is negative, or if
-together they define a region of memory that extends beyond the buffer
-object's allocated data store.
-
-`GL_INVALID_OPERATION' is generated if the reserved buffer object name 0
-is bound to TARGET.
-
-`GL_INVALID_OPERATION' is generated if the buffer object being queried
-is mapped.
-
-`GL_INVALID_OPERATION' is generated if `glGetBufferSubData' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glGetClipPlane
- "glGetClipPlane"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glGetClipPlane"))
- (paramdef "GLenum " (parameter "plane"))
- (paramdef "GLdouble * " (parameter "equation"))))
- "return the coefficients of the specified clipping plane
-=======================================================
-
-
-Parameters
-==========
-
-PLANE
- Specifies a clipping plane. The number of clipping planes depends
- on the implementation, but at least six clipping planes are
- supported. They are identified by symbolic names of the form
- `GL_CLIP_PLANE'I where i ranges from 0 to the value of
- `GL_MAX_CLIP_PLANES' - 1.
-
-EQUATION
- Returns four double-precision values that are the coefficients of
- the plane equation of PLANE in eye coordinates. The initial value
- is (0, 0, 0, 0).
-
-
-Description
-===========
-
-`glGetClipPlane' returns in EQUATION the four coefficients of the plane
-equation for PLANE.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if PLANE is not an accepted value.
-
-`GL_INVALID_OPERATION' is generated if `glGetClipPlane' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glGetColorTableParameter
- "glGetColorTableParameter"
- (funcsynopsis
- (funcprototype
- (funcdef
- "void "
- (function "glGetColorTableParameterfv"))
- (paramdef "GLenum " (parameter "target"))
- (paramdef "GLenum " (parameter "pname"))
- (paramdef "GLfloat * " (parameter "params"))))
- "get color lookup table parameters
-=================================
-
-
-Parameters
-==========
-
-TARGET
- The target color table. Must be `GL_COLOR_TABLE',
- `GL_POST_CONVOLUTION_COLOR_TABLE',
- `GL_POST_COLOR_MATRIX_COLOR_TABLE', `GL_PROXY_COLOR_TABLE',
- `GL_PROXY_POST_CONVOLUTION_COLOR_TABLE', or
- `GL_PROXY_POST_COLOR_MATRIX_COLOR_TABLE'.
-
-PNAME
- The symbolic name of a color lookup table parameter. Must be one of
- `GL_COLOR_TABLE_BIAS', `GL_COLOR_TABLE_SCALE',
- `GL_COLOR_TABLE_FORMAT', `GL_COLOR_TABLE_WIDTH',
- `GL_COLOR_TABLE_RED_SIZE', `GL_COLOR_TABLE_GREEN_SIZE',
- `GL_COLOR_TABLE_BLUE_SIZE', `GL_COLOR_TABLE_ALPHA_SIZE',
- `GL_COLOR_TABLE_LUMINANCE_SIZE', or
- `GL_COLOR_TABLE_INTENSITY_SIZE'.
-
-PARAMS
- A pointer to an array where the values of the parameter will be
- stored.
-
-
-Description
-===========
-
-Returns parameters specific to color table TARGET.
-
-When PNAME is set to `GL_COLOR_TABLE_SCALE' or `GL_COLOR_TABLE_BIAS',
-`glGetColorTableParameter' returns the color table scale or bias
-parameters for the table specified by TARGET. For these queries, TARGET
-must be set to `GL_COLOR_TABLE', `GL_POST_CONVOLUTION_COLOR_TABLE', or
-`GL_POST_COLOR_MATRIX_COLOR_TABLE' and PARAMS points to an array of four
-elements, which receive the scale or bias factors for red, green, blue,
-and alpha, in that order.
-
-`glGetColorTableParameter' can also be used to retrieve the format and
-size parameters for a color table. For these queries, set TARGET to
-either the color table target or the proxy color table target. The
-format and size parameters are set by `glColorTable'.
-
-The following table lists the format and size parameters that may be
-queried. For each symbolic constant listed below for PNAME, PARAMS must
-point to an array of the given length and receive the values indicated.
-
-
-
-* Parameter *
-*
-N *, *
-Meaning *`GL_COLOR_TABLE_FORMAT'
-
-1 ,
-Internal format (e.g., `GL_RGBA') `GL_COLOR_TABLE_WIDTH'
-
-1 ,
-Number of elements in table `GL_COLOR_TABLE_RED_SIZE'
-
-1 ,
-Size of red component, in bits `GL_COLOR_TABLE_GREEN_SIZE'
-
-1 ,
-Size of green component `GL_COLOR_TABLE_BLUE_SIZE'
-
-1 ,
-Size of blue component `GL_COLOR_TABLE_ALPHA_SIZE'
-
-1 ,
-Size of alpha component `GL_COLOR_TABLE_LUMINANCE_SIZE'
-
-1 ,
-Size of luminance component `GL_COLOR_TABLE_INTENSITY_SIZE'
-
-1 ,
-Size of intensity component
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if TARGET or PNAME is not an acceptable
-value.
-
-`GL_INVALID_OPERATION' is generated if `glGetColorTableParameter' is
-executed between the execution of `glBegin' and the corresponding
-execution of `glEnd'.")
-
-(define-gl-procedure
- glGetColorTable
- "glGetColorTable"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glGetColorTable"))
- (paramdef "GLenum " (parameter "target"))
- (paramdef "GLenum " (parameter "format"))
- (paramdef "GLenum " (parameter "type"))
- (paramdef "GLvoid * " (parameter "table"))))
- "retrieve contents of a color lookup table
-=========================================
-
-
-Parameters
-==========
-
-TARGET
- Must be `GL_COLOR_TABLE', `GL_POST_CONVOLUTION_COLOR_TABLE', or
- `GL_POST_COLOR_MATRIX_COLOR_TABLE'.
-
-FORMAT
- The format of the pixel data in TABLE. The possible values are
- `GL_RED', `GL_GREEN', `GL_BLUE', `GL_ALPHA', `GL_LUMINANCE',
- `GL_LUMINANCE_ALPHA', `GL_RGB', `GL_BGR', `GL_RGBA', and `GL_BGRA'.
-
-TYPE
- The type of the pixel data in TABLE. Symbolic constants
- `GL_UNSIGNED_BYTE', `GL_BYTE', `GL_BITMAP', `GL_UNSIGNED_SHORT',
- `GL_SHORT', `GL_UNSIGNED_INT', `GL_INT', `GL_FLOAT',
- `GL_UNSIGNED_BYTE_3_3_2', `GL_UNSIGNED_BYTE_2_3_3_REV',
- `GL_UNSIGNED_SHORT_5_6_5', `GL_UNSIGNED_SHORT_5_6_5_REV',
- `GL_UNSIGNED_SHORT_4_4_4_4', `GL_UNSIGNED_SHORT_4_4_4_4_REV',
- `GL_UNSIGNED_SHORT_5_5_5_1', `GL_UNSIGNED_SHORT_1_5_5_5_REV',
- `GL_UNSIGNED_INT_8_8_8_8', `GL_UNSIGNED_INT_8_8_8_8_REV',
- `GL_UNSIGNED_INT_10_10_10_2', and `GL_UNSIGNED_INT_2_10_10_10_REV'
- are accepted.
-
-TABLE
- Pointer to a one-dimensional array of pixel data containing the
- contents of the color table.
-
-
-Description
-===========
-
-`glGetColorTable' returns in TABLE the contents of the color table
-specified by TARGET. No pixel transfer operations are performed, but
-pixel storage modes that are applicable to `glReadPixels' are performed.
-
-If a non-zero named buffer object is bound to the `GL_PIXEL_PACK_BUFFER'
-target (see `glBindBuffer') while a histogram table is requested, TABLE
-is treated as a byte offset into the buffer object's data store.
-
-Color components that are requested in the specified FORMAT, but which
-are not included in the internal format of the color lookup table, are
-returned as zero. The assignments of internal color components to the
-components requested by FORMAT are
-
-* Internal Component *
-*
-Resulting Component *Red
-
-Red Green
-
-Green Blue
-
-Blue Alpha
-
-Alpha Luminance
-
-Red Intensity
-
-Red
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if TARGET is not one of the allowable
-values.
-
-`GL_INVALID_ENUM' is generated if FORMAT is not one of the allowable
-values.
-
-`GL_INVALID_ENUM' is generated if TYPE is not one of the allowable
-values.
-
-`GL_INVALID_OPERATION' is generated if TYPE is one of
-`GL_UNSIGNED_BYTE_3_3_2', `GL_UNSIGNED_BYTE_2_3_3_REV',
-`GL_UNSIGNED_SHORT_5_6_5', or `GL_UNSIGNED_SHORT_5_6_5_REV' and FORMAT
-is not `GL_RGB'.
-
-`GL_INVALID_OPERATION' is generated if TYPE is one of
-`GL_UNSIGNED_SHORT_4_4_4_4', `GL_UNSIGNED_SHORT_4_4_4_4_REV',
-`GL_UNSIGNED_SHORT_5_5_5_1', `GL_UNSIGNED_SHORT_1_5_5_5_REV',
-`GL_UNSIGNED_INT_8_8_8_8', `GL_UNSIGNED_INT_8_8_8_8_REV',
-`GL_UNSIGNED_INT_10_10_10_2', or `GL_UNSIGNED_INT_2_10_10_10_REV' and
-FORMAT is neither `GL_RGBA' nor `GL_BGRA'.
-
-`GL_INVALID_OPERATION' is generated if a non-zero buffer object name is
-bound to the `GL_PIXEL_PACK_BUFFER' target and the buffer object's data
-store is currently mapped.
-
-`GL_INVALID_OPERATION' is generated if a non-zero buffer object name is
-bound to the `GL_PIXEL_PACK_BUFFER' target and the data would be packed
-to the buffer object such that the memory writes required would exceed
-the data store size.
-
-`GL_INVALID_OPERATION' is generated if a non-zero buffer object name is
-bound to the `GL_PIXEL_PACK_BUFFER' target and TABLE is not evenly
-divisible into the number of bytes needed to store in memory a datum
-indicated by TYPE.
-
-`GL_INVALID_OPERATION' is generated if `glGetColorTable' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glGetCompressedTexImage
- "glGetCompressedTexImage"
- (funcsynopsis
- (funcprototype
- (funcdef
- "void "
- (function "glGetCompressedTexImage"))
- (paramdef "GLenum " (parameter "target"))
- (paramdef "GLint " (parameter "lod"))
- (paramdef "GLvoid * " (parameter "img"))))
- "return a compressed texture image
-=================================
-
-
-Parameters
-==========
-
-TARGET
- Specifies which texture is to be obtained. `GL_TEXTURE_1D',
- `GL_TEXTURE_2D', and
- `GL_TEXTURE_3D'`GL_TEXTURE_CUBE_MAP_POSITIVE_X',
- `GL_TEXTURE_CUBE_MAP_NEGATIVE_X', `GL_TEXTURE_CUBE_MAP_POSITIVE_Y',
- `GL_TEXTURE_CUBE_MAP_NEGATIVE_Y', `GL_TEXTURE_CUBE_MAP_POSITIVE_Z',
- and `GL_TEXTURE_CUBE_MAP_NEGATIVE_Z' are accepted.
-
-LOD
- Specifies the level-of-detail number of the desired image. Level 0
- is the base image level. Level N is the Nth mipmap reduction image.
-
-IMG
- Returns the compressed texture image.
-
-
-Description
-===========
-
-`glGetCompressedTexImage' returns the compressed texture image
-associated with TARGET and LOD into IMG. IMG should be an array of
-`GL_TEXTURE_COMPRESSED_IMAGE_SIZE' bytes. TARGET specifies whether the
-desired texture image was one specified by `glTexImage1D'
-(`GL_TEXTURE_1D'), `glTexImage2D' (`GL_TEXTURE_2D' or any of
-`GL_TEXTURE_CUBE_MAP_*'), or `glTexImage3D' (`GL_TEXTURE_3D'). LOD
-specifies the level-of-detail number of the desired image.
-
-If a non-zero named buffer object is bound to the `GL_PIXEL_PACK_BUFFER'
-target (see `glBindBuffer') while a texture image is requested, IMG is
-treated as a byte offset into the buffer object's data store.
-
-To minimize errors, first verify that the texture is compressed by
-calling `glGetTexLevelParameter' with argument `GL_TEXTURE_COMPRESSED'.
-If the texture is compressed, then determine the amount of memory
-required to store the compressed texture by calling
-`glGetTexLevelParameter' with argument
-`GL_TEXTURE_COMPRESSED_IMAGE_SIZE'. Finally, retrieve the internal
-format of the texture by calling `glGetTexLevelParameter' with argument
-`GL_TEXTURE_INTERNAL_FORMAT'. To store the texture for later use,
-associate the internal format and size with the retrieved texture image.
-These data can be used by the respective texture or subtexture loading
-routine used for loading TARGET textures.
-
-
-Errors
-======
-
-`GL_INVALID_VALUE' is generated if LOD is less than zero or greater than
-the maximum number of LODs permitted by the implementation.
-
-`GL_INVALID_OPERATION' is generated if `glGetCompressedTexImage' is used
-to retrieve a texture that is in an uncompressed internal format.
-
-`GL_INVALID_OPERATION' is generated if a non-zero buffer object name is
-bound to the `GL_PIXEL_PACK_BUFFER' target and the buffer object's data
-store is currently mapped.
-
-`GL_INVALID_OPERATION' is generated if a non-zero buffer object name is
-bound to the `GL_PIXEL_PACK_BUFFER' target and the data would be packed
-to the buffer object such that the memory writes required would exceed
-the data store size.
-
-`GL_INVALID_OPERATION' is generated if `glGetCompressedTexImage' is
-executed between the execution of `glBegin' and the corresponding
-execution of `glEnd'.")
-
-(define-gl-procedure
- glGetConvolutionFilter
- "glGetConvolutionFilter"
- (funcsynopsis
- (funcprototype
- (funcdef
- "void "
- (function "glGetConvolutionFilter"))
- (paramdef "GLenum " (parameter "target"))
- (paramdef "GLenum " (parameter "format"))
- (paramdef "GLenum " (parameter "type"))
- (paramdef "GLvoid * " (parameter "image"))))
- "get current 1D or 2D convolution filter kernel
-==============================================
-
-
-Parameters
-==========
-
-TARGET
- The filter to be retrieved. Must be one of `GL_CONVOLUTION_1D' or
- `GL_CONVOLUTION_2D'.
-
-FORMAT
- Format of the output image. Must be one of `GL_RED', `GL_GREEN',
- `GL_BLUE', `GL_ALPHA', `GL_RGB', `GL_BGR', `GL_RGBA', `GL_BGRA',
- `GL_LUMINANCE', or `GL_LUMINANCE_ALPHA'.
-
-TYPE
- Data type of components in the output image. Symbolic constants
- `GL_UNSIGNED_BYTE', `GL_BYTE', `GL_BITMAP', `GL_UNSIGNED_SHORT',
- `GL_SHORT', `GL_UNSIGNED_INT', `GL_INT', `GL_FLOAT',
- `GL_UNSIGNED_BYTE_3_3_2', `GL_UNSIGNED_BYTE_2_3_3_REV',
- `GL_UNSIGNED_SHORT_5_6_5', `GL_UNSIGNED_SHORT_5_6_5_REV',
- `GL_UNSIGNED_SHORT_4_4_4_4', `GL_UNSIGNED_SHORT_4_4_4_4_REV',
- `GL_UNSIGNED_SHORT_5_5_5_1', `GL_UNSIGNED_SHORT_1_5_5_5_REV',
- `GL_UNSIGNED_INT_8_8_8_8', `GL_UNSIGNED_INT_8_8_8_8_REV',
- `GL_UNSIGNED_INT_10_10_10_2', and `GL_UNSIGNED_INT_2_10_10_10_REV'
- are accepted.
-
-IMAGE
- Pointer to storage for the output image.
-
-
-Description
-===========
-
-`glGetConvolutionFilter' returns the current 1D or 2D convolution filter
-kernel as an image. The one- or two-dimensional image is placed in IMAGE
-according to the specifications in FORMAT and TYPE. No pixel transfer
-operations are performed on this image, but the relevant pixel storage
-modes are applied.
-
-If a non-zero named buffer object is bound to the `GL_PIXEL_PACK_BUFFER'
-target (see `glBindBuffer') while a convolution filter is requested,
-IMAGE is treated as a byte offset into the buffer object's data store.
-
-Color components that are present in FORMAT but not included in the
-internal format of the filter are returned as zero. The assignments of
-internal color components to the components of FORMAT are as follows.
-
-* Internal Component *
-*
-Resulting Component *Red
-
-Red Green
-
-Green Blue
-
-Blue Alpha
-
-Alpha Luminance
-
-Red Intensity
-
-Red
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if TARGET is not one of the allowable
-values.
-
-`GL_INVALID_ENUM' is generated if FORMAT is not one of the allowable
-values.
-
-`GL_INVALID_ENUM' is generated if TYPE is not one of the allowable
-values.
-
-`GL_INVALID_OPERATION' is generated if TYPE is one of
-`GL_UNSIGNED_BYTE_3_3_2', `GL_UNSIGNED_BYTE_2_3_3_REV',
-`GL_UNSIGNED_SHORT_5_6_5', or `GL_UNSIGNED_SHORT_5_6_5_REV' and FORMAT
-is not `GL_RGB'.
-
-`GL_INVALID_OPERATION' is generated if TYPE is one of
-`GL_UNSIGNED_SHORT_4_4_4_4', `GL_UNSIGNED_SHORT_4_4_4_4_REV',
-`GL_UNSIGNED_SHORT_5_5_5_1', `GL_UNSIGNED_SHORT_1_5_5_5_REV',
-`GL_UNSIGNED_INT_8_8_8_8', `GL_UNSIGNED_INT_8_8_8_8_REV',
-`GL_UNSIGNED_INT_10_10_10_2', or `GL_UNSIGNED_INT_2_10_10_10_REV' and
-FORMAT is neither `GL_RGBA' nor `GL_BGRA'.
-
-`GL_INVALID_OPERATION' is generated if a non-zero buffer object name is
-bound to the `GL_PIXEL_PACK_BUFFER' target and the buffer object's data
-store is currently mapped.
-
-`GL_INVALID_OPERATION' is generated if a non-zero buffer object name is
-bound to the `GL_PIXEL_PACK_BUFFER' target and the data would be packed
-to the buffer object such that the memory writes required would exceed
-the data store size.
-
-`GL_INVALID_OPERATION' is generated if a non-zero buffer object name is
-bound to the `GL_PIXEL_PACK_BUFFER' target and IMAGE is not evenly
-divisible into the number of bytes needed to store in memory a datum
-indicated by TYPE.
-
-`GL_INVALID_OPERATION' is generated if `glGetConvolutionFilter' is
-executed between the execution of `glBegin' and the corresponding
-execution of `glEnd'.")
-
-(define-gl-procedure
- glGetConvolutionParameter
- "glGetConvolutionParameter"
- (funcsynopsis
- (funcprototype
- (funcdef
- "void "
- (function "glGetConvolutionParameterfv"))
- (paramdef "GLenum " (parameter "target"))
- (paramdef "GLenum " (parameter "pname"))
- (paramdef "GLfloat * " (parameter "params"))))
- "get convolution parameters
-==========================
-
-
-Parameters
-==========
-
-TARGET
- The filter whose parameters are to be retrieved. Must be one of
- `GL_CONVOLUTION_1D', `GL_CONVOLUTION_2D', or `GL_SEPARABLE_2D'.
-
-PNAME
- The parameter to be retrieved. Must be one of
- `GL_CONVOLUTION_BORDER_MODE', `GL_CONVOLUTION_BORDER_COLOR',
- `GL_CONVOLUTION_FILTER_SCALE', `GL_CONVOLUTION_FILTER_BIAS',
- `GL_CONVOLUTION_FORMAT', `GL_CONVOLUTION_WIDTH',
- `GL_CONVOLUTION_HEIGHT', `GL_MAX_CONVOLUTION_WIDTH', or
- `GL_MAX_CONVOLUTION_HEIGHT'.
-
-PARAMS
- Pointer to storage for the parameters to be retrieved.
-
-
-Description
-===========
-
-`glGetConvolutionParameter' retrieves convolution parameters. TARGET
-determines which convolution filter is queried. PNAME determines which
-parameter is returned:
-
-`GL_CONVOLUTION_BORDER_MODE'
-
-
- The convolution border mode. See `glConvolutionParameter' for a
- list of border modes.
-
-`GL_CONVOLUTION_BORDER_COLOR'
-
-
- The current convolution border color. PARAMS must be a pointer to
- an array of four elements, which will receive the red, green, blue,
- and alpha border colors.
-
-`GL_CONVOLUTION_FILTER_SCALE'
-
-
- The current filter scale factors. PARAMS must be a pointer to an
- array of four elements, which will receive the red, green, blue,
- and alpha filter scale factors in that order.
-
-`GL_CONVOLUTION_FILTER_BIAS'
-
-
- The current filter bias factors. PARAMS must be a pointer to an
- array of four elements, which will receive the red, green, blue,
- and alpha filter bias terms in that order.
-
-`GL_CONVOLUTION_FORMAT'
-
-
- The current internal format. See `glConvolutionFilter1D',
- `glConvolutionFilter2D', and `glSeparableFilter2D' for lists of
- allowable formats.
-
-`GL_CONVOLUTION_WIDTH'
-
-
- The current filter image width.
-
-`GL_CONVOLUTION_HEIGHT'
-
-
- The current filter image height.
-
-`GL_MAX_CONVOLUTION_WIDTH'
-
-
- The maximum acceptable filter image width.
-
-`GL_MAX_CONVOLUTION_HEIGHT'
-
-
- The maximum acceptable filter image height.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if TARGET is not one of the allowable
-values.
-
-`GL_INVALID_ENUM' is generated if PNAME is not one of the allowable
-values.
-
-`GL_INVALID_ENUM' is generated if TARGET is `GL_CONVOLUTION_1D' and
-PNAME is `GL_CONVOLUTION_HEIGHT' or `GL_MAX_CONVOLUTION_HEIGHT'.
-
-`GL_INVALID_OPERATION' is generated if `glGetConvolutionParameter' is
-executed between the execution of `glBegin' and the corresponding
-execution of `glEnd'.")
-
-(define-gl-procedure
- glGetError
- "glGetError"
- (funcsynopsis
- (funcprototype
- (funcdef "GLenum " (function "glGetError"))
- (paramdef (parameter "void"))))
- "return error information
-========================
-
-
-Description
-===========
-
-`glGetError' returns the value of the error flag. Each detectable error
-is assigned a numeric code and symbolic name. When an error occurs, the
-error flag is set to the appropriate error code value. No other errors
-are recorded until `glGetError' is called, the error code is returned,
-and the flag is reset to `GL_NO_ERROR'. If a call to `glGetError'
-returns `GL_NO_ERROR', there has been no detectable error since the last
-call to `glGetError', or since the GL was initialized.
-
-To allow for distributed implementations, there may be several error
-flags. If any single error flag has recorded an error, the value of that
-flag is returned and that flag is reset to `GL_NO_ERROR' when
-`glGetError' is called. If more than one flag has recorded an error,
-`glGetError' returns and clears an arbitrary error flag value. Thus,
-`glGetError' should always be called in a loop, until it returns
-`GL_NO_ERROR', if all error flags are to be reset.
-
-Initially, all error flags are set to `GL_NO_ERROR'.
-
-The following errors are currently defined:
-
-`GL_NO_ERROR'
- No error has been recorded. The value of this symbolic constant is
- guaranteed to be 0.
-
-`GL_INVALID_ENUM'
- An unacceptable value is specified for an enumerated argument. The
- offending command is ignored and has no other side effect than to
- set the error flag.
-
-`GL_INVALID_VALUE'
- A numeric argument is out of range. The offending command is
- ignored and has no other side effect than to set the error flag.
-
-`GL_INVALID_OPERATION'
- The specified operation is not allowed in the current state. The
- offending command is ignored and has no other side effect than to
- set the error flag.
-
-`GL_STACK_OVERFLOW'
- This command would cause a stack overflow. The offending command is
- ignored and has no other side effect than to set the error flag.
-
-`GL_STACK_UNDERFLOW'
- This command would cause a stack underflow. The offending command
- is ignored and has no other side effect than to set the error flag.
-
-`GL_OUT_OF_MEMORY'
- There is not enough memory left to execute the command. The state
- of the GL is undefined, except for the state of the error flags,
- after this error is recorded.
-
-`GL_TABLE_TOO_LARGE'
- The specified table exceeds the implementation's maximum supported
- table size. The offending command is ignored and has no other side
- effect than to set the error flag.
-
-When an error flag is set, results of a GL operation are undefined only
-if `GL_OUT_OF_MEMORY' has occurred. In all other cases, the command
-generating the error is ignored and has no effect on the GL state or
-frame buffer contents. If the generating command returns a value, it
-returns 0. If `glGetError' itself generates an error, it returns 0.
-
-
-Errors
-======
-
-`GL_INVALID_OPERATION' is generated if `glGetError' is executed between
-the execution of `glBegin' and the corresponding execution of `glEnd'.
-In this case, `glGetError' returns 0.")
-
-(define-gl-procedure
- glGetHistogramParameter
- "glGetHistogramParameter"
- (funcsynopsis
- (funcprototype
- (funcdef
- "void "
- (function "glGetHistogramParameterfv"))
- (paramdef "GLenum " (parameter "target"))
- (paramdef "GLenum " (parameter "pname"))
- (paramdef "GLfloat * " (parameter "params"))))
- "get histogram parameters
-========================
-
-
-Parameters
-==========
-
-TARGET
- Must be one of `GL_HISTOGRAM' or `GL_PROXY_HISTOGRAM'.
-
-PNAME
- The name of the parameter to be retrieved. Must be one of
- `GL_HISTOGRAM_WIDTH', `GL_HISTOGRAM_FORMAT',
- `GL_HISTOGRAM_RED_SIZE', `GL_HISTOGRAM_GREEN_SIZE',
- `GL_HISTOGRAM_BLUE_SIZE', `GL_HISTOGRAM_ALPHA_SIZE',
- `GL_HISTOGRAM_LUMINANCE_SIZE', or `GL_HISTOGRAM_SINK'.
-
-PARAMS
- Pointer to storage for the returned values.
-
-
-Description
-===========
-
-`glGetHistogramParameter' is used to query parameter values for the
-current histogram or for a proxy. The histogram state information may be
-queried by calling `glGetHistogramParameter' with a TARGET of
-`GL_HISTOGRAM' (to obtain information for the current histogram table)
-or `GL_PROXY_HISTOGRAM' (to obtain information from the most recent
-proxy request) and one of the following values for the PNAME argument:
-
-
-
-* Parameter *
-*
-Description *`GL_HISTOGRAM_WIDTH'
-
-Histogram table width `GL_HISTOGRAM_FORMAT'
-
-Internal format `GL_HISTOGRAM_RED_SIZE'
-
-Red component counter size, in bits `GL_HISTOGRAM_GREEN_SIZE'
-
-Green component counter size, in bits `GL_HISTOGRAM_BLUE_SIZE'
-
-Blue component counter size, in bits `GL_HISTOGRAM_ALPHA_SIZE'
-
-Alpha component counter size, in bits `GL_HISTOGRAM_LUMINANCE_SIZE'
-
-Luminance component counter size, in bits `GL_HISTOGRAM_SINK'
-
-Value of the SINK parameter
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if TARGET is not one of the allowable
-values.
-
-`GL_INVALID_ENUM' is generated if PNAME is not one of the allowable
-values.
-
-`GL_INVALID_OPERATION' is generated if `glGetHistogramParameter' is
-executed between the execution of `glBegin' and the corresponding
-execution of `glEnd'.")
-
-(define-gl-procedure
- glGetHistogram
- "glGetHistogram"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glGetHistogram"))
- (paramdef "GLenum " (parameter "target"))
- (paramdef "GLboolean " (parameter "reset"))
- (paramdef "GLenum " (parameter "format"))
- (paramdef "GLenum " (parameter "type"))
- (paramdef "GLvoid * " (parameter "values"))))
- "get histogram table
-===================
-
-
-Parameters
-==========
-
-TARGET
- Must be `GL_HISTOGRAM'.
-
-RESET
- If `GL_TRUE', each component counter that is actually returned is
- reset to zero. (Other counters are unaffected.) If `GL_FALSE', none
- of the counters in the histogram table is modified.
-
-FORMAT
- The format of values to be returned in VALUES. Must be one of
- `GL_RED', `GL_GREEN', `GL_BLUE', `GL_ALPHA', `GL_RGB', `GL_BGR',
- `GL_RGBA', `GL_BGRA', `GL_LUMINANCE', or `GL_LUMINANCE_ALPHA'.
-
-TYPE
- The type of values to be returned in VALUES. Symbolic constants
- `GL_UNSIGNED_BYTE', `GL_BYTE', `GL_BITMAP', `GL_UNSIGNED_SHORT',
- `GL_SHORT', `GL_UNSIGNED_INT', `GL_INT', `GL_FLOAT',
- `GL_UNSIGNED_BYTE_3_3_2', `GL_UNSIGNED_BYTE_2_3_3_REV',
- `GL_UNSIGNED_SHORT_5_6_5', `GL_UNSIGNED_SHORT_5_6_5_REV',
- `GL_UNSIGNED_SHORT_4_4_4_4', `GL_UNSIGNED_SHORT_4_4_4_4_REV',
- `GL_UNSIGNED_SHORT_5_5_5_1', `GL_UNSIGNED_SHORT_1_5_5_5_REV',
- `GL_UNSIGNED_INT_8_8_8_8', `GL_UNSIGNED_INT_8_8_8_8_REV',
- `GL_UNSIGNED_INT_10_10_10_2', and `GL_UNSIGNED_INT_2_10_10_10_REV'
- are accepted.
-
-VALUES
- A pointer to storage for the returned histogram table.
-
-
-Description
-===========
-
-`glGetHistogram' returns the current histogram table as a
-one-dimensional image with the same width as the histogram. No pixel
-transfer operations are performed on this image, but pixel storage modes
-that are applicable to 1D images are honored.
-
-If a non-zero named buffer object is bound to the `GL_PIXEL_PACK_BUFFER'
-target (see `glBindBuffer') while a histogram table is requested, VALUES
-is treated as a byte offset into the buffer object's data store.
-
-Color components that are requested in the specified FORMAT, but which
-are not included in the internal format of the histogram, are returned
-as zero. The assignments of internal color components to the components
-requested by FORMAT are:
-
-* Internal Component *
-*
-Resulting Component *Red
-
-Red Green
-
-Green Blue
-
-Blue Alpha
-
-Alpha Luminance
-
-Red
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if TARGET is not `GL_HISTOGRAM'.
-
-`GL_INVALID_ENUM' is generated if FORMAT is not one of the allowable
-values.
-
-`GL_INVALID_ENUM' is generated if TYPE is not one of the allowable
-values.
-
-`GL_INVALID_OPERATION' is generated if TYPE is one of
-`GL_UNSIGNED_BYTE_3_3_2', `GL_UNSIGNED_BYTE_2_3_3_REV',
-`GL_UNSIGNED_SHORT_5_6_5', or `GL_UNSIGNED_SHORT_5_6_5_REV' and FORMAT
-is not `GL_RGB'.
-
-`GL_INVALID_OPERATION' is generated if TYPE is one of
-`GL_UNSIGNED_SHORT_4_4_4_4', `GL_UNSIGNED_SHORT_4_4_4_4_REV',
-`GL_UNSIGNED_SHORT_5_5_5_1', `GL_UNSIGNED_SHORT_1_5_5_5_REV',
-`GL_UNSIGNED_INT_8_8_8_8', `GL_UNSIGNED_INT_8_8_8_8_REV',
-`GL_UNSIGNED_INT_10_10_10_2', or `GL_UNSIGNED_INT_2_10_10_10_REV' and
-FORMAT is neither `GL_RGBA' nor `GL_BGRA'.
-
-`GL_INVALID_OPERATION' is generated if a non-zero buffer object name is
-bound to the `GL_PIXEL_PACK_BUFFER' target and the buffer object's data
-store is currently mapped.
-
-`GL_INVALID_OPERATION' is generated if a non-zero buffer object name is
-bound to the `GL_PIXEL_PACK_BUFFER' target and the data would be packed
-to the buffer object such that the memory writes required would exceed
-the data store size.
-
-`GL_INVALID_OPERATION' is generated if a non-zero buffer object name is
-bound to the `GL_PIXEL_PACK_BUFFER' target and VALUES is not evenly
-divisible into the number of bytes needed to store in memory a datum
-indicated by TYPE.
-
-`GL_INVALID_OPERATION' is generated if `glGetHistogram' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glGetLight
- "glGetLight"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glGetLightfv"))
- (paramdef "GLenum " (parameter "light"))
- (paramdef "GLenum " (parameter "pname"))
- (paramdef "GLfloat * " (parameter "params"))))
- "return light source parameter values
-====================================
-
-
-Parameters
-==========
-
-LIGHT
- Specifies a light source. The number of possible lights depends on
- the implementation, but at least eight lights are supported. They
- are identified by symbolic names of the form `GL_LIGHT'I where I
- ranges from 0 to the value of `GL_MAX_LIGHTS' - 1.
-
-PNAME
- Specifies a light source parameter for LIGHT. Accepted symbolic
- names are `GL_AMBIENT', `GL_DIFFUSE', `GL_SPECULAR', `GL_POSITION',
- `GL_SPOT_DIRECTION', `GL_SPOT_EXPONENT', `GL_SPOT_CUTOFF',
- `GL_CONSTANT_ATTENUATION', `GL_LINEAR_ATTENUATION', and
- `GL_QUADRATIC_ATTENUATION'.
-
-PARAMS
- Returns the requested data.
-
-
-Description
-===========
-
-`glGetLight' returns in PARAMS the value or values of a light source
-parameter. LIGHT names the light and is a symbolic name of the form
-`GL_LIGHT'I where i ranges from 0 to the value of `GL_MAX_LIGHTS' - 1.
-`GL_MAX_LIGHTS' is an implementation dependent constant that is greater
-than or equal to eight. PNAME specifies one of ten light source
-parameters, again by symbolic name.
-
-The following parameters are defined:
-
-`GL_AMBIENT'
- PARAMS returns four integer or floating-point values representing
- the ambient intensity of the light source. Integer values, when
- requested, are linearly mapped from the internal floating-point
- representation such that 1.0 maps to the most positive
- representable integer value, and -1.0 maps to the most negative
- representable integer value. If the internal value is outside the
- range [-1,1], the corresponding integer return value is undefined.
- The initial value is (0, 0, 0, 1).
-
-`GL_DIFFUSE'
- PARAMS returns four integer or floating-point values representing
- the diffuse intensity of the light source. Integer values, when
- requested, are linearly mapped from the internal floating-point
- representation such that 1.0 maps to the most positive
- representable integer value, and -1.0 maps to the most negative
- representable integer value. If the internal value is outside the
- range [-1,1], the corresponding integer return value is undefined.
- The initial value for `GL_LIGHT0' is (1, 1, 1, 1); for other
- lights, the initial value is (0, 0, 0, 0).
-
-`GL_SPECULAR'
- PARAMS returns four integer or floating-point values representing
- the specular intensity of the light source. Integer values, when
- requested, are linearly mapped from the internal floating-point
- representation such that 1.0 maps to the most positive
- representable integer value, and -1.0 maps to the most negative
- representable integer value. If the internal value is outside the
- range [-1,1], the corresponding integer return value is undefined.
- The initial value for `GL_LIGHT0' is (1, 1, 1, 1); for other
- lights, the initial value is (0, 0, 0, 0).
-
-`GL_POSITION'
- PARAMS returns four integer or floating-point values representing
- the position of the light source. Integer values, when requested,
- are computed by rounding the internal floating-point values to the
- nearest integer value. The returned values are those maintained in
- eye coordinates. They will not be equal to the values specified
- using `glLight', unless the modelview matrix was identity at the
- time `glLight' was called. The initial value is (0, 0, 1, 0).
-
-`GL_SPOT_DIRECTION'
- PARAMS returns three integer or floating-point values representing
- the direction of the light source. Integer values, when requested,
- are computed by rounding the internal floating-point values to the
- nearest integer value. The returned values are those maintained in
- eye coordinates. They will not be equal to the values specified
- using `glLight', unless the modelview matrix was identity at the
- time `glLight' was called. Although spot direction is normalized
- before being used in the lighting equation, the returned values are
- the transformed versions of the specified values prior to
- normalization. The initial value is (0,0-1).
-
-`GL_SPOT_EXPONENT'
- PARAMS returns a single integer or floating-point value
- representing the spot exponent of the light. An integer value, when
- requested, is computed by rounding the internal floating-point
- representation to the nearest integer. The initial value is 0.
-
-`GL_SPOT_CUTOFF'
- PARAMS returns a single integer or floating-point value
- representing the spot cutoff angle of the light. An integer value,
- when requested, is computed by rounding the internal floating-point
- representation to the nearest integer. The initial value is 180.
-
-`GL_CONSTANT_ATTENUATION'
- PARAMS returns a single integer or floating-point value
- representing the constant (not distance-related) attenuation of the
- light. An integer value, when requested, is computed by rounding
- the internal floating-point representation to the nearest integer.
- The initial value is 1.
-
-`GL_LINEAR_ATTENUATION'
- PARAMS returns a single integer or floating-point value
- representing the linear attenuation of the light. An integer value,
- when requested, is computed by rounding the internal floating-point
- representation to the nearest integer. The initial value is 0.
-
-`GL_QUADRATIC_ATTENUATION'
- PARAMS returns a single integer or floating-point value
- representing the quadratic attenuation of the light. An integer
- value, when requested, is computed by rounding the internal
- floating-point representation to the nearest integer. The initial
- value is 0.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if LIGHT or PNAME is not an accepted
-value.
-
-`GL_INVALID_OPERATION' is generated if `glGetLight' is executed between
-the execution of `glBegin' and the corresponding execution of `glEnd'.")
-
-(define-gl-procedure
- glGetMap
- "glGetMap"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glGetMapdv"))
- (paramdef "GLenum " (parameter "target"))
- (paramdef "GLenum " (parameter "query"))
- (paramdef "GLdouble * " (parameter "v"))))
- "return evaluator parameters
-===========================
-
-
-Parameters
-==========
-
-TARGET
- Specifies the symbolic name of a map. Accepted values are
- `GL_MAP1_COLOR_4', `GL_MAP1_INDEX', `GL_MAP1_NORMAL',
- `GL_MAP1_TEXTURE_COORD_1', `GL_MAP1_TEXTURE_COORD_2',
- `GL_MAP1_TEXTURE_COORD_3', `GL_MAP1_TEXTURE_COORD_4',
- `GL_MAP1_VERTEX_3', `GL_MAP1_VERTEX_4', `GL_MAP2_COLOR_4',
- `GL_MAP2_INDEX', `GL_MAP2_NORMAL', `GL_MAP2_TEXTURE_COORD_1',
- `GL_MAP2_TEXTURE_COORD_2', `GL_MAP2_TEXTURE_COORD_3',
- `GL_MAP2_TEXTURE_COORD_4', `GL_MAP2_VERTEX_3', and
- `GL_MAP2_VERTEX_4'.
-
-QUERY
- Specifies which parameter to return. Symbolic names `GL_COEFF',
- `GL_ORDER', and `GL_DOMAIN' are accepted.
-
-V
- Returns the requested data.
-
-
-Description
-===========
-
-`glMap1' and `glMap2' define evaluators. `glGetMap' returns evaluator
-parameters. TARGET chooses a map, QUERY selects a specific parameter,
-and V points to storage where the values will be returned.
-
-The acceptable values for the TARGET parameter are described in the
-`glMap1' and `glMap2' reference pages.
-
-QUERY can assume the following values:
-
-`GL_COEFF'
- V returns the control points for the evaluator function.
- One-dimensional evaluators return ORDER control points, and
- two-dimensional evaluators return UORDER×VORDER control points.
- Each control point consists of one, two, three, or four integer,
- single-precision floating-point, or double-precision floating-point
- values, depending on the type of the evaluator. The GL returns
- two-dimensional control points in row-major order, incrementing the
- UORDER index quickly and the VORDER index after each row. Integer
- values, when requested, are computed by rounding the internal
- floating-point values to the nearest integer values.
-
-`GL_ORDER'
- V returns the order of the evaluator function. One-dimensional
- evaluators return a single value, ORDER. The initial value is 1.
- Two-dimensional evaluators return two values, UORDER and VORDER.
- The initial value is 1,1.
-
-`GL_DOMAIN'
- V returns the linear U and V mapping parameters. One-dimensional
- evaluators return two values, U1 and U2, as specified by `glMap1'.
- Two-dimensional evaluators return four values (U1, U2, V1, and V2)
- as specified by `glMap2'. Integer values, when requested, are
- computed by rounding the internal floating-point values to the
- nearest integer values.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if either TARGET or QUERY is not an
-accepted value.
-
-`GL_INVALID_OPERATION' is generated if `glGetMap' is executed between
-the execution of `glBegin' and the corresponding execution of `glEnd'.")
-
-(define-gl-procedure
- glGetMaterial
- "glGetMaterial"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glGetMaterialfv"))
- (paramdef "GLenum " (parameter "face"))
- (paramdef "GLenum " (parameter "pname"))
- (paramdef "GLfloat * " (parameter "params"))))
- "return material parameters
-==========================
-
-
-Parameters
-==========
-
-FACE
- Specifies which of the two materials is being queried. `GL_FRONT'
- or `GL_BACK' are accepted, representing the front and back
- materials, respectively.
-
-PNAME
- Specifies the material parameter to return. `GL_AMBIENT',
- `GL_DIFFUSE', `GL_SPECULAR', `GL_EMISSION', `GL_SHININESS', and
- `GL_COLOR_INDEXES' are accepted.
-
-PARAMS
- Returns the requested data.
-
-
-Description
-===========
-
-`glGetMaterial' returns in PARAMS the value or values of parameter PNAME
-of material FACE. Six parameters are defined:
-
-`GL_AMBIENT'
- PARAMS returns four integer or floating-point values representing
- the ambient reflectance of the material. Integer values, when
- requested, are linearly mapped from the internal floating-point
- representation such that 1.0 maps to the most positive
- representable integer value, and -1.0 maps to the most negative
- representable integer value. If the internal value is outside the
- range [-1,1], the corresponding integer return value is undefined.
- The initial value is (0.2, 0.2, 0.2, 1.0)
-
-`GL_DIFFUSE'
- PARAMS returns four integer or floating-point values representing
- the diffuse reflectance of the material. Integer values, when
- requested, are linearly mapped from the internal floating-point
- representation such that 1.0 maps to the most positive
- representable integer value, and -1.0 maps to the most negative
- representable integer value. If the internal value is outside the
- range [-1,1], the corresponding integer return value is undefined.
- The initial value is (0.8, 0.8, 0.8, 1.0).
-
-`GL_SPECULAR'
- PARAMS returns four integer or floating-point values representing
- the specular reflectance of the material. Integer values, when
- requested, are linearly mapped from the internal floating-point
- representation such that 1.0 maps to the most positive
- representable integer value, and -1.0 maps to the most negative
- representable integer value. If the internal value is outside the
- range [-1,1], the corresponding integer return value is undefined.
- The initial value is (0, 0, 0, 1).
-
-`GL_EMISSION'
- PARAMS returns four integer or floating-point values representing
- the emitted light intensity of the material. Integer values, when
- requested, are linearly mapped from the internal floating-point
- representation such that 1.0 maps to the most positive
- representable integer value, and -1.0 maps to the most negative
- representable integer value. If the internal value is outside the
- range [-1,1], the corresponding integer return value is undefined.
- The initial value is (0, 0, 0, 1).
-
-`GL_SHININESS'
- PARAMS returns one integer or floating-point value representing the
- specular exponent of the material. Integer values, when requested,
- are computed by rounding the internal floating-point value to the
- nearest integer value. The initial value is 0.
-
-`GL_COLOR_INDEXES'
- PARAMS returns three integer or floating-point values representing
- the ambient, diffuse, and specular indices of the material. These
- indices are used only for color index lighting. (All the other
- parameters are used only for RGBA lighting.) Integer values, when
- requested, are computed by rounding the internal floating-point
- values to the nearest integer values.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if FACE or PNAME is not an accepted
-value.
-
-`GL_INVALID_OPERATION' is generated if `glGetMaterial' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glGetMinmaxParameter
- "glGetMinmaxParameter"
- (funcsynopsis
- (funcprototype
- (funcdef
- "void "
- (function "glGetMinmaxParameterfv"))
- (paramdef "GLenum " (parameter "target"))
- (paramdef "GLenum " (parameter "pname"))
- (paramdef "GLfloat * " (parameter "params"))))
- "get minmax parameters
-=====================
-
-
-Parameters
-==========
-
-TARGET
- Must be `GL_MINMAX'.
-
-PNAME
- The parameter to be retrieved. Must be one of `GL_MINMAX_FORMAT' or
- `GL_MINMAX_SINK'.
-
-PARAMS
- A pointer to storage for the retrieved parameters.
-
-
-Description
-===========
-
-`glGetMinmaxParameter' retrieves parameters for the current minmax table
-by setting PNAME to one of the following values:
-
-
-
-* Parameter *
-*
-Description *`GL_MINMAX_FORMAT'
-
-Internal format of minmax table `GL_MINMAX_SINK'
-
-Value of the SINK parameter
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if TARGET is not `GL_MINMAX'.
-
-`GL_INVALID_ENUM' is generated if PNAME is not one of the allowable
-values.
-
-`GL_INVALID_OPERATION' is generated if `glGetMinmaxParameter' is
-executed between the execution of `glBegin' and the corresponding
-execution of `glEnd'.")
-
-(define-gl-procedure
- glGetMinmax
- "glGetMinmax"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glGetMinmax"))
- (paramdef "GLenum " (parameter "target"))
- (paramdef "GLboolean " (parameter "reset"))
- (paramdef "GLenum " (parameter "format"))
- (paramdef "GLenum " (parameter "types"))
- (paramdef "GLvoid * " (parameter "values"))))
- "get minimum and maximum pixel values
-====================================
-
-
-Parameters
-==========
-
-TARGET
- Must be `GL_MINMAX'.
-
-RESET
- If `GL_TRUE', all entries in the minmax table that are actually
- returned are reset to their initial values. (Other entries are
- unaltered.) If `GL_FALSE', the minmax table is unaltered.
-
-FORMAT
- The format of the data to be returned in VALUES. Must be one of
- `GL_RED', `GL_GREEN', `GL_BLUE', `GL_ALPHA', `GL_RGB', `GL_BGR',
- `GL_RGBA', `GL_BGRA', `GL_LUMINANCE', or `GL_LUMINANCE_ALPHA'.
-
-TYPES
- The type of the data to be returned in VALUES. Symbolic constants
- `GL_UNSIGNED_BYTE', `GL_BYTE', `GL_BITMAP', `GL_UNSIGNED_SHORT',
- `GL_SHORT', `GL_UNSIGNED_INT', `GL_INT', `GL_FLOAT',
- `GL_UNSIGNED_BYTE_3_3_2', `GL_UNSIGNED_BYTE_2_3_3_REV',
- `GL_UNSIGNED_SHORT_5_6_5', `GL_UNSIGNED_SHORT_5_6_5_REV',
- `GL_UNSIGNED_SHORT_4_4_4_4', `GL_UNSIGNED_SHORT_4_4_4_4_REV',
- `GL_UNSIGNED_SHORT_5_5_5_1', `GL_UNSIGNED_SHORT_1_5_5_5_REV',
- `GL_UNSIGNED_INT_8_8_8_8', `GL_UNSIGNED_INT_8_8_8_8_REV',
- `GL_UNSIGNED_INT_10_10_10_2', and `GL_UNSIGNED_INT_2_10_10_10_REV'
- are accepted.
-
-VALUES
- A pointer to storage for the returned values.
-
-
-Description
-===========
-
-`glGetMinmax' returns the accumulated minimum and maximum pixel values
-(computed on a per-component basis) in a one-dimensional image of width
-2. The first set of return values are the minima, and the second set of
-return values are the maxima. The format of the return values is
-determined by FORMAT, and their type is determined by TYPES.
-
-If a non-zero named buffer object is bound to the `GL_PIXEL_PACK_BUFFER'
-target (see `glBindBuffer') while minimum and maximum pixel values are
-requested, VALUES is treated as a byte offset into the buffer object's
-data store.
-
-No pixel transfer operations are performed on the return values, but
-pixel storage modes that are applicable to one-dimensional images are
-performed. Color components that are requested in the specified FORMAT,
-but that are not included in the internal format of the minmax table,
-are returned as zero. The assignment of internal color components to the
-components requested by FORMAT are as follows:
-
-
-
-* Internal Component *
-*
-Resulting Component *Red
-
-Red Green
-
-Green Blue
-
-Blue Alpha
-
-Alpha Luminance
-
-Red If RESET is `GL_TRUE', the minmax table entries corresponding to the
-return values are reset to their initial values. Minimum and maximum
-values that are not returned are not modified, even if RESET is
-`GL_TRUE'.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if TARGET is not `GL_MINMAX'.
-
-`GL_INVALID_ENUM' is generated if FORMAT is not one of the allowable
-values.
-
-`GL_INVALID_ENUM' is generated if TYPES is not one of the allowable
-values.
-
-`GL_INVALID_OPERATION' is generated if TYPES is one of
-`GL_UNSIGNED_BYTE_3_3_2', `GL_UNSIGNED_BYTE_2_3_3_REV',
-`GL_UNSIGNED_SHORT_5_6_5', or `GL_UNSIGNED_SHORT_5_6_5_REV' and FORMAT
-is not `GL_RGB'.
-
-`GL_INVALID_OPERATION' is generated if TYPES is one of
-`GL_UNSIGNED_SHORT_4_4_4_4', `GL_UNSIGNED_SHORT_4_4_4_4_REV',
-`GL_UNSIGNED_SHORT_5_5_5_1', `GL_UNSIGNED_SHORT_1_5_5_5_REV',
-`GL_UNSIGNED_INT_8_8_8_8', `GL_UNSIGNED_INT_8_8_8_8_REV',
-`GL_UNSIGNED_INT_10_10_10_2', or `GL_UNSIGNED_INT_2_10_10_10_REV' and
-FORMAT is neither `GL_RGBA' nor `GL_BGRA'.
-
-`GL_INVALID_OPERATION' is generated if a non-zero buffer object name is
-bound to the `GL_PIXEL_PACK_BUFFER' target and the buffer object's data
-store is currently mapped.
-
-`GL_INVALID_OPERATION' is generated if a non-zero buffer object name is
-bound to the `GL_PIXEL_PACK_BUFFER' target and the data would be packed
-to the buffer object such that the memory writes required would exceed
-the data store size.
-
-`GL_INVALID_OPERATION' is generated if a non-zero buffer object name is
-bound to the `GL_PIXEL_PACK_BUFFER' target and VALUES is not evenly
-divisible into the number of bytes needed to store in memory a datum
-indicated by TYPE.
-
-`GL_INVALID_OPERATION' is generated if `glGetMinmax' is executed between
-the execution of `glBegin' and the corresponding execution of `glEnd'.")
-
-(define-gl-procedure
- glGetPixelMap
- "glGetPixelMap"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glGetPixelMapfv"))
- (paramdef "GLenum " (parameter "map"))
- (paramdef "GLfloat * " (parameter "data"))))
- "return the specified pixel map
-==============================
-
-
-Parameters
-==========
-
-MAP
- Specifies the name of the pixel map to return. Accepted values are
- `GL_PIXEL_MAP_I_TO_I', `GL_PIXEL_MAP_S_TO_S',
- `GL_PIXEL_MAP_I_TO_R', `GL_PIXEL_MAP_I_TO_G',
- `GL_PIXEL_MAP_I_TO_B', `GL_PIXEL_MAP_I_TO_A',
- `GL_PIXEL_MAP_R_TO_R', `GL_PIXEL_MAP_G_TO_G',
- `GL_PIXEL_MAP_B_TO_B', and `GL_PIXEL_MAP_A_TO_A'.
-
-DATA
- Returns the pixel map contents.
-
-
-Description
-===========
-
-See the `glPixelMap' reference page for a description of the acceptable
-values for the MAP parameter. `glGetPixelMap' returns in DATA the
-contents of the pixel map specified in MAP. Pixel maps are used during
-the execution of `glReadPixels', `glDrawPixels', `glCopyPixels',
-`glTexImage1D', `glTexImage2D', `glTexImage3D', `glTexSubImage1D',
-`glTexSubImage2D', `glTexSubImage3D', `glCopyTexImage1D',
-`glCopyTexImage2D', `glCopyTexSubImage1D', `glCopyTexSubImage2D', and
-`glCopyTexSubImage3D'. to map color indices, stencil indices, color
-components, and depth components to other values.
-
-If a non-zero named buffer object is bound to the `GL_PIXEL_PACK_BUFFER'
-target (see `glBindBuffer') while a pixel map is requested, DATA is
-treated as a byte offset into the buffer object's data store.
-
-Unsigned integer values, if requested, are linearly mapped from the
-internal fixed or floating-point representation such that 1.0 maps to
-the largest representable integer value, and 0.0 maps to 0. Return
-unsigned integer values are undefined if the map value was not in the
-range [0,1].
-
-To determine the required size of MAP, call `glGet' with the appropriate
-symbolic constant.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if MAP is not an accepted value.
-
-`GL_INVALID_OPERATION' is generated if a non-zero buffer object name is
-bound to the `GL_PIXEL_PACK_BUFFER' target and the buffer object's data
-store is currently mapped.
-
-`GL_INVALID_OPERATION' is generated if a non-zero buffer object name is
-bound to the `GL_PIXEL_PACK_BUFFER' target and the data would be packed
-to the buffer object such that the memory writes required would exceed
-the data store size.
-
-`GL_INVALID_OPERATION' is generated by `glGetPixelMapfv' if a non-zero
-buffer object name is bound to the `GL_PIXEL_PACK_BUFFER' target and
-DATA is not evenly divisible into the number of bytes needed to store in
-memory a GLfloat datum.
-
-`GL_INVALID_OPERATION' is generated by `glGetPixelMapuiv' if a non-zero
-buffer object name is bound to the `GL_PIXEL_PACK_BUFFER' target and
-DATA is not evenly divisible into the number of bytes needed to store in
-memory a GLuint datum.
-
-`GL_INVALID_OPERATION' is generated by `glGetPixelMapusv' if a non-zero
-buffer object name is bound to the `GL_PIXEL_PACK_BUFFER' target and
-DATA is not evenly divisible into the number of bytes needed to store in
-memory a GLushort datum.
-
-`GL_INVALID_OPERATION' is generated if `glGetPixelMap' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glGetPointerv
- "glGetPointerv"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glGetPointerv"))
- (paramdef "GLenum " (parameter "pname"))
- (paramdef "GLvoid ** " (parameter "params"))))
- "return the address of the specified pointer
-===========================================
-
-
-Parameters
-==========
-
-PNAME
- Specifies the array or buffer pointer to be returned. Symbolic
- constants `GL_COLOR_ARRAY_POINTER', `GL_EDGE_FLAG_ARRAY_POINTER',
- `GL_FOG_COORD_ARRAY_POINTER', `GL_FEEDBACK_BUFFER_POINTER',
- `GL_INDEX_ARRAY_POINTER', `GL_NORMAL_ARRAY_POINTER',
- `GL_SECONDARY_COLOR_ARRAY_POINTER', `GL_SELECTION_BUFFER_POINTER',
- `GL_TEXTURE_COORD_ARRAY_POINTER', or `GL_VERTEX_ARRAY_POINTER' are
- accepted.
-
-PARAMS
- Returns the pointer value specified by PNAME.
-
-
-Description
-===========
-
-`glGetPointerv' returns pointer information. PNAME is a symbolic
-constant indicating the pointer to be returned, and PARAMS is a pointer
-to a location in which to place the returned data.
-
-For all PNAME arguments except `GL_FEEDBACK_BUFFER_POINTER' and
-`GL_SELECTION_BUFFER_POINTER', if a non-zero named buffer object was
-bound to the `GL_ARRAY_BUFFER' target (see `glBindBuffer') when the
-desired pointer was previously specified, the pointer returned is a byte
-offset into the buffer object's data store. Buffer objects are only
-available in OpenGL versions 1.5 and greater.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if PNAME is not an accepted value.")
-
-(define-gl-procedure
- glGetPolygonStipple
- "glGetPolygonStipple"
- (funcsynopsis
- (funcprototype
- (funcdef
- "void "
- (function "glGetPolygonStipple"))
- (paramdef "GLubyte * " (parameter "pattern"))))
- "return the polygon stipple pattern
-==================================
-
-
-Parameters
-==========
-
-PATTERN
- Returns the stipple pattern. The initial value is all 1's.
-
-
-Description
-===========
-
-`glGetPolygonStipple' returns to PATTERN a 32×32 polygon stipple
-pattern. The pattern is packed into memory as if `glReadPixels' with
-both HEIGHT and WIDTH of 32, TYPE of `GL_BITMAP', and FORMAT of
-`GL_COLOR_INDEX' were called, and the stipple pattern were stored in an
-internal 32×32 color index buffer. Unlike `glReadPixels', however, pixel
-transfer operations (shift, offset, pixel map) are not applied to the
-returned stipple image.
-
-If a non-zero named buffer object is bound to the `GL_PIXEL_PACK_BUFFER'
-target (see `glBindBuffer') while a polygon stipple pattern is
-requested, PATTERN is treated as a byte offset into the buffer object's
-data store.
-
-
-Errors
-======
-
-`GL_INVALID_OPERATION' is generated if a non-zero buffer object name is
-bound to the `GL_PIXEL_PACK_BUFFER' target and the buffer object's data
-store is currently mapped.
-
-`GL_INVALID_OPERATION' is generated if a non-zero buffer object name is
-bound to the `GL_PIXEL_PACK_BUFFER' target and the data would be packed
-to the buffer object such that the memory writes required would exceed
-the data store size.
-
-`GL_INVALID_OPERATION' is generated if `glGetPolygonStipple' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glGetProgramInfoLog
- "glGetProgramInfoLog"
- (funcsynopsis
- (funcprototype
- (funcdef
- "void "
- (function "glGetProgramInfoLog"))
- (paramdef "GLuint " (parameter "program"))
- (paramdef "GLsizei " (parameter "maxLength"))
- (paramdef "GLsizei *" (parameter "length"))
- (paramdef "GLchar *" (parameter "infoLog"))))
- "Returns the information log for a program object
-================================================
-
-
-Parameters
-==========
-
-PROGRAM
- Specifies the program object whose information log is to be
- queried.
-
-MAXLENGTH
- Specifies the size of the character buffer for storing the returned
- information log.
-
-LENGTH
- Returns the length of the string returned in INFOLOG (excluding the
- null terminator).
-
-INFOLOG
- Specifies an array of characters that is used to return the
- information log.
-
-
-Description
-===========
-
-`glGetProgramInfoLog' returns the information log for the specified
-program object. The information log for a program object is modified
-when the program object is linked or validated. The string that is
-returned will be null terminated.
-
-`glGetProgramInfoLog' returns in INFOLOG as much of the information log
-as it can, up to a maximum of MAXLENGTH characters. The number of
-characters actually returned, excluding the null termination character,
-is specified by LENGTH. If the length of the returned string is not
-required, a value of `NULL' can be passed in the LENGTH argument. The
-size of the buffer required to store the returned information log can be
-obtained by calling `glGetProgram' with the value `GL_INFO_LOG_LENGTH'.
-
-The information log for a program object is either an empty string, or a
-string containing information about the last link operation, or a string
-containing information about the last validation operation. It may
-contain diagnostic messages, warning messages, and other information.
-When a program object is created, its information log will be a string
-of length 0.
-
-
-Errors
-======
-
-`GL_INVALID_VALUE' is generated if PROGRAM is not a value generated by
-OpenGL.
-
-`GL_INVALID_OPERATION' is generated if PROGRAM is not a program object.
-
-`GL_INVALID_VALUE' is generated if MAXLENGTH is less than 0.
-
-`GL_INVALID_OPERATION' is generated if `glGetProgramInfoLog' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glGetProgramiv
- "glGetProgramiv"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glGetProgramiv"))
- (paramdef "GLuint " (parameter "program"))
- (paramdef "GLenum " (parameter "pname"))
- (paramdef "GLint *" (parameter "params"))))
- "Returns a parameter from a program object
-=========================================
-
-
-Parameters
-==========
-
-PROGRAM
- Specifies the program object to be queried.
-
-PNAME
- Specifies the object parameter. Accepted symbolic names are
- `GL_DELETE_STATUS', `GL_LINK_STATUS', `GL_VALIDATE_STATUS',
- `GL_INFO_LOG_LENGTH', `GL_ATTACHED_SHADERS',
- `GL_ACTIVE_ATTRIBUTES', `GL_ACTIVE_ATTRIBUTE_MAX_LENGTH',
- `GL_ACTIVE_UNIFORMS', `GL_ACTIVE_UNIFORM_MAX_LENGTH'.
-
-PARAMS
- Returns the requested object parameter.
-
-
-Description
-===========
-
-`glGetProgram' returns in PARAMS the value of a parameter for a specific
-program object. The following parameters are defined:
-
-`GL_DELETE_STATUS'
-
-
- PARAMS returns `GL_TRUE' if PROGRAM is currently flagged for
- deletion, and `GL_FALSE' otherwise.
-
-`GL_LINK_STATUS'
-
-
- PARAMS returns `GL_TRUE' if the last link operation on PROGRAM was
- successful, and `GL_FALSE' otherwise.
-
-`GL_VALIDATE_STATUS'
-
-
- PARAMS returns `GL_TRUE' or if the last validation operation on
- PROGRAM was successful, and `GL_FALSE' otherwise.
-
-`GL_INFO_LOG_LENGTH'
-
-
- PARAMS returns the number of characters in the information log for
- PROGRAM including the null termination character (i.e., the size of
- the character buffer required to store the information log). If
- PROGRAM has no information log, a value of 0 is returned.
-
-`GL_ATTACHED_SHADERS'
-
-
- PARAMS returns the number of shader objects attached to PROGRAM.
-
-`GL_ACTIVE_ATTRIBUTES'
-
-
- PARAMS returns the number of active attribute variables for
- PROGRAM.
-
-`GL_ACTIVE_ATTRIBUTE_MAX_LENGTH'
-
-
- PARAMS returns the length of the longest active attribute name for
- PROGRAM, including the null termination character (i.e., the size
- of the character buffer required to store the longest attribute
- name). If no active attributes exist, 0 is returned.
-
-`GL_ACTIVE_UNIFORMS'
-
-
- PARAMS returns the number of active uniform variables for PROGRAM.
-
-`GL_ACTIVE_UNIFORM_MAX_LENGTH'
-
-
- PARAMS returns the length of the longest active uniform variable
- name for PROGRAM, including the null termination character (i.e.,
- the size of the character buffer required to store the longest
- uniform variable name). If no active uniform variables exist, 0 is
- returned.
-
-
-Errors
-======
-
-`GL_INVALID_VALUE' is generated if PROGRAM is not a value generated by
-OpenGL.
-
-`GL_INVALID_OPERATION' is generated if PROGRAM does not refer to a
-program object.
-
-`GL_INVALID_ENUM' is generated if PNAME is not an accepted value.
-
-`GL_INVALID_OPERATION' is generated if `glGetProgram' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glGetQueryiv
- "glGetQueryiv"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glGetQueryiv"))
- (paramdef "GLenum " (parameter "target"))
- (paramdef "GLenum " (parameter "pname"))
- (paramdef "GLint * " (parameter "params"))))
- "return parameters of a query object target
-==========================================
-
-
-Parameters
-==========
-
-TARGET
- Specifies a query object target. Must be `GL_SAMPLES_PASSED'.
-
-PNAME
- Specifies the symbolic name of a query object target parameter.
- Accepted values are `GL_CURRENT_QUERY' or `GL_QUERY_COUNTER_BITS'.
-
-PARAMS
- Returns the requested data.
-
-
-Description
-===========
-
-`glGetQueryiv' returns in PARAMS a selected parameter of the query
-object target specified by TARGET.
-
-PNAME names a specific query object target parameter. When TARGET is
-`GL_SAMPLES_PASSED', PNAME can be as follows:
-
-`GL_CURRENT_QUERY'
- PARAMS returns the name of the currently active occlusion query
- object. If no occlusion query is active, 0 is returned. The initial
- value is 0.
-
-`GL_QUERY_COUNTER_BITS'
- PARAMS returns the number of bits in the query counter used to
- accumulate passing samples. If the number of bits returned is 0,
- the implementation does not support a query counter, and the
- results obtained from `glGetQueryObject' are useless.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if TARGET or PNAME is not an accepted
-value.
-
-`GL_INVALID_OPERATION' is generated if `glGetQueryiv' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glGetQueryObject
- "glGetQueryObject"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glGetQueryObjectiv"))
- (paramdef "GLuint " (parameter "id"))
- (paramdef "GLenum " (parameter "pname"))
- (paramdef "GLint * " (parameter "params"))))
- "return parameters of a query object
-===================================
-
-
-Parameters
-==========
-
-ID
- Specifies the name of a query object.
-
-PNAME
- Specifies the symbolic name of a query object parameter. Accepted
- values are `GL_QUERY_RESULT' or `GL_QUERY_RESULT_AVAILABLE'.
-
-PARAMS
- Returns the requested data.
-
-
-Description
-===========
-
-`glGetQueryObject' returns in PARAMS a selected parameter of the query
-object specified by ID.
-
-PNAME names a specific query object parameter. PNAME can be as follows:
-
-`GL_QUERY_RESULT'
- PARAMS returns the value of the query object's passed samples
- counter. The initial value is 0.
-
-`GL_QUERY_RESULT_AVAILABLE'
- PARAMS returns whether the passed samples counter is immediately
- available. If a delay would occur waiting for the query result,
- `GL_FALSE' is returned. Otherwise, `GL_TRUE' is returned, which
- also indicates that the results of all previous queries are
- available as well.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if PNAME is not an accepted value.
-
-`GL_INVALID_OPERATION' is generated if ID is not the name of a query
-object.
-
-`GL_INVALID_OPERATION' is generated if ID is the name of a currently
-active query object.
-
-`GL_INVALID_OPERATION' is generated if `glGetQueryObject' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glGetSeparableFilter
- "glGetSeparableFilter"
- (funcsynopsis
- (funcprototype
- (funcdef
- "void "
- (function "glGetSeparableFilter"))
- (paramdef "GLenum " (parameter "target"))
- (paramdef "GLenum " (parameter "format"))
- (paramdef "GLenum " (parameter "type"))
- (paramdef "GLvoid * " (parameter "row"))
- (paramdef "GLvoid * " (parameter "column"))
- (paramdef "GLvoid * " (parameter "span"))))
- "get separable convolution filter kernel images
-==============================================
-
-
-Parameters
-==========
-
-TARGET
- The separable filter to be retrieved. Must be `GL_SEPARABLE_2D'.
-
-FORMAT
- Format of the output images. Must be one of `GL_RED', `GL_GREEN',
- `GL_BLUE', `GL_ALPHA', `GL_RGB', `GL_BGR'`GL_RGBA', `GL_BGRA',
- `GL_LUMINANCE', or `GL_LUMINANCE_ALPHA'.
-
-TYPE
- Data type of components in the output images. Symbolic constants
- `GL_UNSIGNED_BYTE', `GL_BYTE', `GL_BITMAP', `GL_UNSIGNED_SHORT',
- `GL_SHORT', `GL_UNSIGNED_INT', `GL_INT', `GL_FLOAT',
- `GL_UNSIGNED_BYTE_3_3_2', `GL_UNSIGNED_BYTE_2_3_3_REV',
- `GL_UNSIGNED_SHORT_5_6_5', `GL_UNSIGNED_SHORT_5_6_5_REV',
- `GL_UNSIGNED_SHORT_4_4_4_4', `GL_UNSIGNED_SHORT_4_4_4_4_REV',
- `GL_UNSIGNED_SHORT_5_5_5_1', `GL_UNSIGNED_SHORT_1_5_5_5_REV',
- `GL_UNSIGNED_INT_8_8_8_8', `GL_UNSIGNED_INT_8_8_8_8_REV',
- `GL_UNSIGNED_INT_10_10_10_2', and `GL_UNSIGNED_INT_2_10_10_10_REV'
- are accepted.
-
-ROW
- Pointer to storage for the row filter image.
-
-COLUMN
- Pointer to storage for the column filter image.
-
-SPAN
- Pointer to storage for the span filter image (currently unused).
-
-
-Description
-===========
-
-`glGetSeparableFilter' returns the two one-dimensional filter kernel
-images for the current separable 2D convolution filter. The row image is
-placed in ROW and the column image is placed in COLUMN according to the
-specifications in FORMAT and TYPE. (In the current implementation, SPAN
-is not affected in any way.) No pixel transfer operations are performed
-on the images, but the relevant pixel storage modes are applied.
-
-If a non-zero named buffer object is bound to the `GL_PIXEL_PACK_BUFFER'
-target (see `glBindBuffer') while a separable convolution filter is
-requested, ROW, COLUMN, and SPAN are treated as a byte offset into the
-buffer object's data store.
-
-Color components that are present in FORMAT but not included in the
-internal format of the filters are returned as zero. The assignments of
-internal color components to the components of FORMAT are as follows:
-
-
-
-* Internal Component *
-*
-Resulting Component *Red
-
-Red Green
-
-Green Blue
-
-Blue Alpha
-
-Alpha Luminance
-
-Red Intensity
-
-Red
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if TARGET is not `GL_SEPARABLE_2D'.
-
-`GL_INVALID_ENUM' is generated if FORMAT is not one of the allowable
-values.
-
-`GL_INVALID_ENUM' is generated if TYPE is not one of the allowable
-values.
-
-`GL_INVALID_OPERATION' is generated if TYPE is one of
-`GL_UNSIGNED_BYTE_3_3_2', `GL_UNSIGNED_BYTE_2_3_3_REV',
-`GL_UNSIGNED_SHORT_5_6_5', or `GL_UNSIGNED_SHORT_5_6_5_REV' and FORMAT
-is not `GL_RGB'.
-
-`GL_INVALID_OPERATION' is generated if TYPE is one of
-`GL_UNSIGNED_SHORT_4_4_4_4', `GL_UNSIGNED_SHORT_4_4_4_4_REV',
-`GL_UNSIGNED_SHORT_5_5_5_1', `GL_UNSIGNED_SHORT_1_5_5_5_REV',
-`GL_UNSIGNED_INT_8_8_8_8', `GL_UNSIGNED_INT_8_8_8_8_REV',
-`GL_UNSIGNED_INT_10_10_10_2', or `GL_UNSIGNED_INT_2_10_10_10_REV' and
-FORMAT is neither `GL_RGBA' nor `GL_BGRA'.
-
-`GL_INVALID_OPERATION' is generated if a non-zero buffer object name is
-bound to the `GL_PIXEL_PACK_BUFFER' target and the buffer object's data
-store is currently mapped.
-
-`GL_INVALID_OPERATION' is generated if a non-zero buffer object name is
-bound to the `GL_PIXEL_PACK_BUFFER' target and the data would be packed
-to the buffer object such that the memory writes required would exceed
-the data store size.
-
-`GL_INVALID_OPERATION' is generated if a non-zero buffer object name is
-bound to the `GL_PIXEL_PACK_BUFFER' target and ROW or COLUMN is not
-evenly divisible into the number of bytes needed to store in memory a
-datum indicated by TYPE.
-
-`GL_INVALID_OPERATION' is generated if `glGetSeparableFilter' is
-executed between the execution of `glBegin' and the corresponding
-execution of `glEnd'.")
-
-(define-gl-procedure
- glGetShaderInfoLog
- "glGetShaderInfoLog"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glGetShaderInfoLog"))
- (paramdef "GLuint " (parameter "shader"))
- (paramdef "GLsizei " (parameter "maxLength"))
- (paramdef "GLsizei *" (parameter "length"))
- (paramdef "GLchar *" (parameter "infoLog"))))
- "Returns the information log for a shader object
-===============================================
-
-
-Parameters
-==========
-
-SHADER
- Specifies the shader object whose information log is to be queried.
-
-MAXLENGTH
- Specifies the size of the character buffer for storing the returned
- information log.
-
-LENGTH
- Returns the length of the string returned in INFOLOG (excluding the
- null terminator).
-
-INFOLOG
- Specifies an array of characters that is used to return the
- information log.
-
-
-Description
-===========
-
-`glGetShaderInfoLog' returns the information log for the specified
-shader object. The information log for a shader object is modified when
-the shader is compiled. The string that is returned will be null
-terminated.
-
-`glGetShaderInfoLog' returns in INFOLOG as much of the information log
-as it can, up to a maximum of MAXLENGTH characters. The number of
-characters actually returned, excluding the null termination character,
-is specified by LENGTH. If the length of the returned string is not
-required, a value of `NULL' can be passed in the LENGTH argument. The
-size of the buffer required to store the returned information log can be
-obtained by calling `glGetShader' with the value `GL_INFO_LOG_LENGTH'.
-
-The information log for a shader object is a string that may contain
-diagnostic messages, warning messages, and other information about the
-last compile operation. When a shader object is created, its information
-log will be a string of length 0.
-
-
-Errors
-======
-
-`GL_INVALID_VALUE' is generated if SHADER is not a value generated by
-OpenGL.
-
-`GL_INVALID_OPERATION' is generated if SHADER is not a shader object.
-
-`GL_INVALID_VALUE' is generated if MAXLENGTH is less than 0.
-
-`GL_INVALID_OPERATION' is generated if `glGetShaderInfoLog' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glGetShaderSource
- "glGetShaderSource"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glGetShaderSource"))
- (paramdef "GLuint " (parameter "shader"))
- (paramdef "GLsizei " (parameter "bufSize"))
- (paramdef "GLsizei *" (parameter "length"))
- (paramdef "GLchar *" (parameter "source"))))
- "Returns the source code string from a shader object
-===================================================
-
-
-Parameters
-==========
-
-SHADER
- Specifies the shader object to be queried.
-
-BUFSIZE
- Specifies the size of the character buffer for storing the returned
- source code string.
-
-LENGTH
- Returns the length of the string returned in SOURCE (excluding the
- null terminator).
-
-SOURCE
- Specifies an array of characters that is used to return the source
- code string.
-
-
-Description
-===========
-
-`glGetShaderSource' returns the concatenation of the source code strings
-from the shader object specified by SHADER. The source code strings for
-a shader object are the result of a previous call to `glShaderSource'.
-The string returned by the function will be null terminated.
-
-`glGetShaderSource' returns in SOURCE as much of the source code string
-as it can, up to a maximum of BUFSIZE characters. The number of
-characters actually returned, excluding the null termination character,
-is specified by LENGTH. If the length of the returned string is not
-required, a value of `NULL' can be passed in the LENGTH argument. The
-size of the buffer required to store the returned source code string can
-be obtained by calling `glGetShader' with the value
-`GL_SHADER_SOURCE_LENGTH'.
-
-
-Errors
-======
-
-`GL_INVALID_VALUE' is generated if SHADER is not a value generated by
-OpenGL.
-
-`GL_INVALID_OPERATION' is generated if SHADER is not a shader object.
-
-`GL_INVALID_VALUE' is generated if BUFSIZE is less than 0.
-
-`GL_INVALID_OPERATION' is generated if `glGetShaderSource' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glGetShaderiv
- "glGetShaderiv"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glGetShaderiv"))
- (paramdef "GLuint " (parameter "shader"))
- (paramdef "GLenum " (parameter "pname"))
- (paramdef "GLint *" (parameter "params"))))
- "Returns a parameter from a shader object
-========================================
-
-
-Parameters
-==========
-
-SHADER
- Specifies the shader object to be queried.
-
-PNAME
- Specifies the object parameter. Accepted symbolic names are
- `GL_SHADER_TYPE', `GL_DELETE_STATUS', `GL_COMPILE_STATUS',
- `GL_INFO_LOG_LENGTH', `GL_SHADER_SOURCE_LENGTH'.
-
-PARAMS
- Returns the requested object parameter.
-
-
-Description
-===========
-
-`glGetShader' returns in PARAMS the value of a parameter for a specific
-shader object. The following parameters are defined:
-
-`GL_SHADER_TYPE'
- PARAMS returns `GL_VERTEX_SHADER' if SHADER is a vertex shader
- object, and `GL_FRAGMENT_SHADER' if SHADER is a fragment shader
- object.
-
-`GL_DELETE_STATUS'
- PARAMS returns `GL_TRUE' if SHADER is currently flagged for
- deletion, and `GL_FALSE' otherwise.
-
-`GL_COMPILE_STATUS'
- PARAMS returns `GL_TRUE' if the last compile operation on SHADER
- was successful, and `GL_FALSE' otherwise.
-
-`GL_INFO_LOG_LENGTH'
- PARAMS returns the number of characters in the information log for
- SHADER including the null termination character (i.e., the size of
- the character buffer required to store the information log). If
- SHADER has no information log, a value of 0 is returned.
-
-`GL_SHADER_SOURCE_LENGTH'
- PARAMS returns the length of the concatenation of the source
- strings that make up the shader source for the SHADER, including
- the null termination character. (i.e., the size of the character
- buffer required to store the shader source). If no source code
- exists, 0 is returned.
-
-
-Errors
-======
-
-`GL_INVALID_VALUE' is generated if SHADER is not a value generated by
-OpenGL.
-
-`GL_INVALID_OPERATION' is generated if SHADER does not refer to a shader
-object.
-
-`GL_INVALID_ENUM' is generated if PNAME is not an accepted value.
-
-`GL_INVALID_OPERATION' is generated if `glGetShader' is executed between
-the execution of `glBegin' and the corresponding execution of `glEnd'.")
-
-(define-gl-procedure
- glGetString
- "glGetString"
- (funcsynopsis
- (funcprototype
- (funcdef
- "const GLubyte* "
- (function "glGetString"))
- (paramdef "GLenum " (parameter "name"))))
- "return a string describing the current GL connection
-====================================================
-
-
-Parameters
-==========
-
-NAME
- Specifies a symbolic constant, one of `GL_VENDOR', `GL_RENDERER',
- `GL_VERSION', `GL_SHADING_LANGUAGE_VERSION', or `GL_EXTENSIONS'.
-
-
-Description
-===========
-
-`glGetString' returns a pointer to a static string describing some
-aspect of the current GL connection. NAME can be one of the following:
-
-`GL_VENDOR'
-
-
- Returns the company responsible for this GL implementation. This
- name does not change from release to release.
-
-`GL_RENDERER'
-
-
- Returns the name of the renderer. This name is typically specific
- to a particular configuration of a hardware platform. It does not
- change from release to release.
-
-`GL_VERSION'
-
-
- Returns a version or release number.
-
-`GL_SHADING_LANGUAGE_VERSION'
-
-
- Returns a version or release number for the shading language.
-
-`GL_EXTENSIONS'
-
-
- Returns a space-separated list of supported extensions to GL.
-
-Because the GL does not include queries for the performance
-characteristics of an implementation, some applications are written to
-recognize known platforms and modify their GL usage based on known
-performance characteristics of these platforms. Strings `GL_VENDOR' and
-`GL_RENDERER' together uniquely specify a platform. They do not change
-from release to release and should be used by platform-recognition
-algorithms.
-
-Some applications want to make use of features that are not part of the
-standard GL. These features may be implemented as extensions to the
-standard GL. The `GL_EXTENSIONS' string is a space-separated list of
-supported GL extensions. (Extension names never contain a space
-character.)
-
-The `GL_VERSION' and `GL_SHADING_LANGUAGE_VERSION' strings begin with a
-version number. The version number uses one of these forms:
-
-MAJOR_NUMBER.MINOR_NUMBERMAJOR_NUMBER.MINOR_NUMBER.RELEASE_NUMBER
-
-Vendor-specific information may follow the version number. Its format
-depends on the implementation, but a space always separates the version
-number and the vendor-specific information.
-
-All strings are null-terminated.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if NAME is not an accepted value.
-
-`GL_INVALID_OPERATION' is generated if `glGetString' is executed between
-the execution of `glBegin' and the corresponding execution of `glEnd'.")
-
-(define-gl-procedure
- glGetTexEnv
- "glGetTexEnv"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glGetTexEnvfv"))
- (paramdef "GLenum " (parameter "target"))
- (paramdef "GLenum " (parameter "pname"))
- (paramdef "GLfloat * " (parameter "params"))))
- "return texture environment parameters
-=====================================
-
-
-Parameters
-==========
-
-TARGET
- Specifies a texture environment. May be `GL_TEXTURE_ENV',
- `GL_TEXTURE_FILTER_CONTROL', or `GL_POINT_SPRITE'.
-
-PNAME
- Specifies the symbolic name of a texture environment parameter.
- Accepted values are `GL_TEXTURE_ENV_MODE', `GL_TEXTURE_ENV_COLOR',
- `GL_TEXTURE_LOD_BIAS', `GL_COMBINE_RGB', `GL_COMBINE_ALPHA',
- `GL_SRC0_RGB', `GL_SRC1_RGB', `GL_SRC2_RGB', `GL_SRC0_ALPHA',
- `GL_SRC1_ALPHA', `GL_SRC2_ALPHA', `GL_OPERAND0_RGB',
- `GL_OPERAND1_RGB', `GL_OPERAND2_RGB', `GL_OPERAND0_ALPHA',
- `GL_OPERAND1_ALPHA', `GL_OPERAND2_ALPHA', `GL_RGB_SCALE',
- `GL_ALPHA_SCALE', or `GL_COORD_REPLACE'.
-
-PARAMS
- Returns the requested data.
-
-
-Description
-===========
-
-`glGetTexEnv' returns in PARAMS selected values of a texture environment
-that was specified with `glTexEnv'. TARGET specifies a texture
-environment.
-
-When TARGET is `GL_TEXTURE_FILTER_CONTROL', PNAME must be
-`GL_TEXTURE_LOD_BIAS'. When TARGET is `GL_POINT_SPRITE', PNAME must be
-`GL_COORD_REPLACE'. When TARGET is `GL_TEXTURE_ENV', PNAME can be
-`GL_TEXTURE_ENV_MODE', `GL_TEXTURE_ENV_COLOR', `GL_COMBINE_RGB',
-`GL_COMBINE_ALPHA', `GL_RGB_SCALE', `GL_ALPHA_SCALE', `GL_SRC0_RGB',
-`GL_SRC1_RGB', `GL_SRC2_RGB', `GL_SRC0_ALPHA', `GL_SRC1_ALPHA', or
-`GL_SRC2_ALPHA'.
-
-PNAME names a specific texture environment parameter, as follows:
-
-`GL_TEXTURE_ENV_MODE'
- PARAMS returns the single-valued texture environment mode, a
- symbolic constant. The initial value is `GL_MODULATE'.
-
-`GL_TEXTURE_ENV_COLOR'
- PARAMS returns four integer or floating-point values that are the
- texture environment color. Integer values, when requested, are
- linearly mapped from the internal floating-point representation
- such that 1.0 maps to the most positive representable integer, and
- -1.0 maps to the most negative representable integer. The initial
- value is (0, 0, 0, 0).
-
-`GL_TEXTURE_LOD_BIAS'
- PARAMS returns a single floating-point value that is the texture
- level-of-detail bias. The initial value is 0.
-
-`GL_COMBINE_RGB'
- PARAMS returns a single symbolic constant value representing the
- current RGB combine mode. The initial value is `GL_MODULATE'.
-
-`GL_COMBINE_ALPHA'
- PARAMS returns a single symbolic constant value representing the
- current alpha combine mode. The initial value is `GL_MODULATE'.
-
-`GL_SRC0_RGB'
- PARAMS returns a single symbolic constant value representing the
- texture combiner zero's RGB source. The initial value is
- `GL_TEXTURE'.
-
-`GL_SRC1_RGB'
- PARAMS returns a single symbolic constant value representing the
- texture combiner one's RGB source. The initial value is
- `GL_PREVIOUS'.
-
-`GL_SRC2_RGB'
- PARAMS returns a single symbolic constant value representing the
- texture combiner two's RGB source. The initial value is
- `GL_CONSTANT'.
-
-`GL_SRC0_ALPHA'
- PARAMS returns a single symbolic constant value representing the
- texture combiner zero's alpha source. The initial value is
- `GL_TEXTURE'.
-
-`GL_SRC1_ALPHA'
- PARAMS returns a single symbolic constant value representing the
- texture combiner one's alpha source. The initial value is
- `GL_PREVIOUS'.
-
-`GL_SRC2_ALPHA'
- PARAMS returns a single symbolic constant value representing the
- texture combiner two's alpha source. The initial value is
- `GL_CONSTANT'.
-
-`GL_OPERAND0_RGB'
- PARAMS returns a single symbolic constant value representing the
- texture combiner zero's RGB operand. The initial value is
- `GL_SRC_COLOR'.
-
-`GL_OPERAND1_RGB'
- PARAMS returns a single symbolic constant value representing the
- texture combiner one's RGB operand. The initial value is
- `GL_SRC_COLOR'.
-
-`GL_OPERAND2_RGB'
- PARAMS returns a single symbolic constant value representing the
- texture combiner two's RGB operand. The initial value is
- `GL_SRC_ALPHA'.
-
-`GL_OPERAND0_ALPHA'
- PARAMS returns a single symbolic constant value representing the
- texture combiner zero's alpha operand. The initial value is
- `GL_SRC_ALPHA'.
-
-`GL_OPERAND1_ALPHA'
- PARAMS returns a single symbolic constant value representing the
- texture combiner one's alpha operand. The initial value is
- `GL_SRC_ALPHA'.
-
-`GL_OPERAND2_ALPHA'
- PARAMS returns a single symbolic constant value representing the
- texture combiner two's alpha operand. The initial value is
- `GL_SRC_ALPHA'.
-
-`GL_RGB_SCALE'
- PARAMS returns a single floating-point value representing the
- current RGB texture combiner scaling factor. The initial value is
- 1.0.
-
-`GL_ALPHA_SCALE'
- PARAMS returns a single floating-point value representing the
- current alpha texture combiner scaling factor. The initial value is
- 1.0.
-
-`GL_COORD_REPLACE'
- PARAMS returns a single boolean value representing the current
- point sprite texture coordinate replacement enable state. The
- initial value is `GL_FALSE'.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if TARGET or PNAME is not an accepted
-value.
-
-`GL_INVALID_OPERATION' is generated if `glGetTexEnv' is executed between
-the execution of `glBegin' and the corresponding execution of `glEnd'.")
-
-(define-gl-procedure
- glGetTexGen
- "glGetTexGen"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glGetTexGendv"))
- (paramdef "GLenum " (parameter "coord"))
- (paramdef "GLenum " (parameter "pname"))
- (paramdef "GLdouble * " (parameter "params"))))
- "return texture coordinate generation parameters
-===============================================
-
-
-Parameters
-==========
-
-COORD
- Specifies a texture coordinate. Must be `GL_S', `GL_T', `GL_R', or
- `GL_Q'.
-
-PNAME
- Specifies the symbolic name of the value(s) to be returned. Must be
- either `GL_TEXTURE_GEN_MODE' or the name of one of the texture
- generation plane equations: `GL_OBJECT_PLANE' or `GL_EYE_PLANE'.
-
-PARAMS
- Returns the requested data.
-
-
-Description
-===========
-
-`glGetTexGen' returns in PARAMS selected parameters of a texture
-coordinate generation function that was specified using `glTexGen'.
-COORD names one of the (S, T, R, Q) texture coordinates, using the
-symbolic constant `GL_S', `GL_T', `GL_R', or `GL_Q'.
-
-PNAME specifies one of three symbolic names:
-
-`GL_TEXTURE_GEN_MODE'
- PARAMS returns the single-valued texture generation function, a
- symbolic constant. The initial value is `GL_EYE_LINEAR'.
-
-`GL_OBJECT_PLANE'
- PARAMS returns the four plane equation coefficients that specify
- object linear-coordinate generation. Integer values, when
- requested, are mapped directly from the internal floating-point
- representation.
-
-`GL_EYE_PLANE'
- PARAMS returns the four plane equation coefficients that specify
- eye linear-coordinate generation. Integer values, when requested,
- are mapped directly from the internal floating-point
- representation. The returned values are those maintained in eye
- coordinates. They are not equal to the values specified using
- `glTexGen', unless the modelview matrix was identity when
- `glTexGen' was called.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if COORD or PNAME is not an accepted
-value.
-
-`GL_INVALID_OPERATION' is generated if `glGetTexGen' is executed between
-the execution of `glBegin' and the corresponding execution of `glEnd'.")
-
-(define-gl-procedure
- glGetTexImage
- "glGetTexImage"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glGetTexImage"))
- (paramdef "GLenum " (parameter "target"))
- (paramdef "GLint " (parameter "level"))
- (paramdef "GLenum " (parameter "format"))
- (paramdef "GLenum " (parameter "type"))
- (paramdef "GLvoid * " (parameter "img"))))
- "return a texture image
-======================
-
-
-Parameters
-==========
-
-TARGET
- Specifies which texture is to be obtained. `GL_TEXTURE_1D',
- `GL_TEXTURE_2D', `GL_TEXTURE_3D', `GL_TEXTURE_CUBE_MAP_POSITIVE_X',
- `GL_TEXTURE_CUBE_MAP_NEGATIVE_X', `GL_TEXTURE_CUBE_MAP_POSITIVE_Y',
- `GL_TEXTURE_CUBE_MAP_NEGATIVE_Y', `GL_TEXTURE_CUBE_MAP_POSITIVE_Z',
- and `GL_TEXTURE_CUBE_MAP_NEGATIVE_Z' are accepted.
-
-LEVEL
- Specifies the level-of-detail number of the desired image. Level 0
- is the base image level. Level N is the Nth mipmap reduction image.
-
-FORMAT
- Specifies a pixel format for the returned data. The supported
- formats are `GL_RED', `GL_GREEN', `GL_BLUE', `GL_ALPHA', `GL_RGB',
- `GL_BGR', `GL_RGBA', `GL_BGRA', `GL_LUMINANCE', and
- `GL_LUMINANCE_ALPHA'.
-
-TYPE
- Specifies a pixel type for the returned data. The supported types
- are `GL_UNSIGNED_BYTE', `GL_BYTE', `GL_UNSIGNED_SHORT', `GL_SHORT',
- `GL_UNSIGNED_INT', `GL_INT', `GL_FLOAT', `GL_UNSIGNED_BYTE_3_3_2',
- `GL_UNSIGNED_BYTE_2_3_3_REV', `GL_UNSIGNED_SHORT_5_6_5',
- `GL_UNSIGNED_SHORT_5_6_5_REV', `GL_UNSIGNED_SHORT_4_4_4_4',
- `GL_UNSIGNED_SHORT_4_4_4_4_REV', `GL_UNSIGNED_SHORT_5_5_5_1',
- `GL_UNSIGNED_SHORT_1_5_5_5_REV', `GL_UNSIGNED_INT_8_8_8_8',
- `GL_UNSIGNED_INT_8_8_8_8_REV', `GL_UNSIGNED_INT_10_10_10_2', and
- `GL_UNSIGNED_INT_2_10_10_10_REV'.
-
-IMG
- Returns the texture image. Should be a pointer to an array of the
- type specified by TYPE.
-
-
-Description
-===========
-
-`glGetTexImage' returns a texture image into IMG. TARGET specifies
-whether the desired texture image is one specified by `glTexImage1D'
-(`GL_TEXTURE_1D'), `glTexImage2D' (`GL_TEXTURE_2D' or any of
-`GL_TEXTURE_CUBE_MAP_*'), or `glTexImage3D' (`GL_TEXTURE_3D'). LEVEL
-specifies the level-of-detail number of the desired image. FORMAT and
-TYPE specify the format and type of the desired image array. See the
-reference pages `glTexImage1D' and `glDrawPixels' for a description of
-the acceptable values for the FORMAT and TYPE parameters, respectively.
-
-If a non-zero named buffer object is bound to the `GL_PIXEL_PACK_BUFFER'
-target (see `glBindBuffer') while a texture image is requested, IMG is
-treated as a byte offset into the buffer object's data store.
-
-To understand the operation of `glGetTexImage', consider the selected
-internal four-component texture image to be an RGBA color buffer the
-size of the image. The semantics of `glGetTexImage' are then identical
-to those of `glReadPixels', with the exception that no pixel transfer
-operations are performed, when called with the same FORMAT and TYPE,
-with X and Y set to 0, WIDTH set to the width of the texture image
-(including border if one was specified), and HEIGHT set to 1 for 1D
-images, or to the height of the texture image (including border if one
-was specified) for 2D images. Because the internal texture image is an
-RGBA image, pixel formats `GL_COLOR_INDEX', `GL_STENCIL_INDEX', and
-`GL_DEPTH_COMPONENT' are not accepted, and pixel type `GL_BITMAP' is not
-accepted.
-
-If the selected texture image does not contain four components, the
-following mappings are applied. Single-component textures are treated as
-RGBA buffers with red set to the single-component value, green set to 0,
-blue set to 0, and alpha set to 1. Two-component textures are treated as
-RGBA buffers with red set to the value of component zero, alpha set to
-the value of component one, and green and blue set to 0. Finally,
-three-component textures are treated as RGBA buffers with red set to
-component zero, green set to component one, blue set to component two,
-and alpha set to 1.
-
-To determine the required size of IMG, use `glGetTexLevelParameter' to
-determine the dimensions of the internal texture image, then scale the
-required number of pixels by the storage required for each pixel, based
-on FORMAT and TYPE. Be sure to take the pixel storage parameters into
-account, especially `GL_PACK_ALIGNMENT'.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if TARGET, FORMAT, or TYPE is not an
-accepted value.
-
-`GL_INVALID_VALUE' is generated if LEVEL is less than 0.
-
-`GL_INVALID_VALUE' may be generated if LEVEL is greater than
-LOG_2\u2061(MAX,), where MAX is the returned value of `GL_MAX_TEXTURE_SIZE'.
-
-`GL_INVALID_OPERATION' is returned if TYPE is one of
-`GL_UNSIGNED_BYTE_3_3_2', `GL_UNSIGNED_BYTE_2_3_3_REV',
-`GL_UNSIGNED_SHORT_5_6_5', or `GL_UNSIGNED_SHORT_5_6_5_REV' and FORMAT
-is not `GL_RGB'.
-
-`GL_INVALID_OPERATION' is returned if TYPE is one of
-`GL_UNSIGNED_SHORT_4_4_4_4', `GL_UNSIGNED_SHORT_4_4_4_4_REV',
-`GL_UNSIGNED_SHORT_5_5_5_1', `GL_UNSIGNED_SHORT_1_5_5_5_REV',
-`GL_UNSIGNED_INT_8_8_8_8', `GL_UNSIGNED_INT_8_8_8_8_REV',
-`GL_UNSIGNED_INT_10_10_10_2', or `GL_UNSIGNED_INT_2_10_10_10_REV', and
-FORMAT is neither `GL_RGBA' or `GL_BGRA'.
-
-`GL_INVALID_OPERATION' is generated if a non-zero buffer object name is
-bound to the `GL_PIXEL_PACK_BUFFER' target and the buffer object's data
-store is currently mapped.
-
-`GL_INVALID_OPERATION' is generated if a non-zero buffer object name is
-bound to the `GL_PIXEL_PACK_BUFFER' target and the data would be packed
-to the buffer object such that the memory writes required would exceed
-the data store size.
-
-`GL_INVALID_OPERATION' is generated if a non-zero buffer object name is
-bound to the `GL_PIXEL_PACK_BUFFER' target and IMG is not evenly
-divisible into the number of bytes needed to store in memory a datum
-indicated by TYPE.
-
-`GL_INVALID_OPERATION' is generated if `glGetTexImage' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glGetTexLevelParameter
- "glGetTexLevelParameter"
- (funcsynopsis
- (funcprototype
- (funcdef
- "void "
- (function "glGetTexLevelParameterfv"))
- (paramdef "GLenum " (parameter "target"))
- (paramdef "GLint " (parameter "level"))
- (paramdef "GLenum " (parameter "pname"))
- (paramdef "GLfloat * " (parameter "params"))))
- "return texture parameter values for a specific level of detail
-==============================================================
-
-
-Parameters
-==========
-
-TARGET
- Specifies the symbolic name of the target texture, either
- `GL_TEXTURE_1D', `GL_TEXTURE_2D', `GL_TEXTURE_3D',
- `GL_PROXY_TEXTURE_1D', `GL_PROXY_TEXTURE_2D',
- `GL_PROXY_TEXTURE_3D', `GL_TEXTURE_CUBE_MAP_POSITIVE_X',
- `GL_TEXTURE_CUBE_MAP_NEGATIVE_X', `GL_TEXTURE_CUBE_MAP_POSITIVE_Y',
- `GL_TEXTURE_CUBE_MAP_NEGATIVE_Y', `GL_TEXTURE_CUBE_MAP_POSITIVE_Z',
- `GL_TEXTURE_CUBE_MAP_NEGATIVE_Z', or `GL_PROXY_TEXTURE_CUBE_MAP'.
-
-LEVEL
- Specifies the level-of-detail number of the desired image. Level 0
- is the base image level. Level N is the Nth mipmap reduction image.
-
-PNAME
- Specifies the symbolic name of a texture parameter.
- `GL_TEXTURE_WIDTH', `GL_TEXTURE_HEIGHT', `GL_TEXTURE_DEPTH',
- `GL_TEXTURE_INTERNAL_FORMAT', `GL_TEXTURE_BORDER',
- `GL_TEXTURE_RED_SIZE', `GL_TEXTURE_GREEN_SIZE',
- `GL_TEXTURE_BLUE_SIZE', `GL_TEXTURE_ALPHA_SIZE',
- `GL_TEXTURE_LUMINANCE_SIZE', `GL_TEXTURE_INTENSITY_SIZE',
- `GL_TEXTURE_DEPTH_SIZE', `GL_TEXTURE_COMPRESSED', and
- `GL_TEXTURE_COMPRESSED_IMAGE_SIZE' are accepted.
-
-PARAMS
- Returns the requested data.
-
-
-Description
-===========
-
-`glGetTexLevelParameter' returns in PARAMS texture parameter values for
-a specific level-of-detail value, specified as LEVEL. TARGET defines the
-target texture, either `GL_TEXTURE_1D', `GL_TEXTURE_2D',
-`GL_TEXTURE_3D', `GL_PROXY_TEXTURE_1D', `GL_PROXY_TEXTURE_2D',
-`GL_PROXY_TEXTURE_3D', `GL_TEXTURE_CUBE_MAP_POSITIVE_X',
-`GL_TEXTURE_CUBE_MAP_NEGATIVE_X', `GL_TEXTURE_CUBE_MAP_POSITIVE_Y',
-`GL_TEXTURE_CUBE_MAP_NEGATIVE_Y', `GL_TEXTURE_CUBE_MAP_POSITIVE_Z',
-`GL_TEXTURE_CUBE_MAP_NEGATIVE_Z', or `GL_PROXY_TEXTURE_CUBE_MAP'.
-
-`GL_MAX_TEXTURE_SIZE', and `GL_MAX_3D_TEXTURE_SIZE' are not really
-descriptive enough. It has to report the largest square texture image
-that can be accommodated with mipmaps and borders, but a long skinny
-texture, or a texture without mipmaps and borders, may easily fit in
-texture memory. The proxy targets allow the user to more accurately
-query whether the GL can accommodate a texture of a given configuration.
-If the texture cannot be accommodated, the texture state variables,
-which may be queried with `glGetTexLevelParameter', are set to 0. If the
-texture can be accommodated, the texture state values will be set as
-they would be set for a non-proxy target.
-
-PNAME specifies the texture parameter whose value or values will be
-returned.
-
-The accepted parameter names are as follows:
-
-`GL_TEXTURE_WIDTH'
-
-
- PARAMS returns a single value, the width of the texture image. This
- value includes the border of the texture image. The initial value
- is 0.
-
-`GL_TEXTURE_HEIGHT'
-
-
- PARAMS returns a single value, the height of the texture image.
- This value includes the border of the texture image. The initial
- value is 0.
-
-`GL_TEXTURE_DEPTH'
-
-
- PARAMS returns a single value, the depth of the texture image. This
- value includes the border of the texture image. The initial value
- is 0.
-
-`GL_TEXTURE_INTERNAL_FORMAT'
-
-
- PARAMS returns a single value, the internal format of the texture
- image.
-
-`GL_TEXTURE_BORDER'
-
-
- PARAMS returns a single value, the width in pixels of the border of
- the texture image. The initial value is 0.
-
-`GL_TEXTURE_RED_SIZE',
-`GL_TEXTURE_GREEN_SIZE',
-`GL_TEXTURE_BLUE_SIZE',
-`GL_TEXTURE_ALPHA_SIZE',
-`GL_TEXTURE_LUMINANCE_SIZE',
-`GL_TEXTURE_INTENSITY_SIZE',
-`GL_TEXTURE_DEPTH_SIZE'
-
-
- The internal storage resolution of an individual component. The
- resolution chosen by the GL will be a close match for the
- resolution requested by the user with the component argument of
- `glTexImage1D', `glTexImage2D', `glTexImage3D', `glCopyTexImage1D',
- and `glCopyTexImage2D'. The initial value is 0.
-
-`GL_TEXTURE_COMPRESSED'
-
-
- PARAMS returns a single boolean value indicating if the texture
- image is stored in a compressed internal format. The initiali value
- is `GL_FALSE'.
-
-`GL_TEXTURE_COMPRESSED_IMAGE_SIZE'
-
-
- PARAMS returns a single integer value, the number of unsigned bytes
- of the compressed texture image that would be returned from
- `glGetCompressedTexImage'.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if TARGET or PNAME is not an accepted
-value.
-
-`GL_INVALID_VALUE' is generated if LEVEL is less than 0.
-
-`GL_INVALID_VALUE' may be generated if LEVEL is greater than LOG_2MAX,
-where MAX is the returned value of `GL_MAX_TEXTURE_SIZE'.
-
-`GL_INVALID_OPERATION' is generated if `glGetTexLevelParameter' is
-executed between the execution of `glBegin' and the corresponding
-execution of `glEnd'.
-
-`GL_INVALID_OPERATION' is generated if
-`GL_TEXTURE_COMPRESSED_IMAGE_SIZE' is queried on texture images with an
-uncompressed internal format or on proxy targets.")
-
-(define-gl-procedure
- glGetTexParameter
- "glGetTexParameter"
- (funcsynopsis
- (funcprototype
- (funcdef
- "void "
- (function "glGetTexParameterfv"))
- (paramdef "GLenum " (parameter "target"))
- (paramdef "GLenum " (parameter "pname"))
- (paramdef "GLfloat * " (parameter "params"))))
- "return texture parameter values
-===============================
-
-
-Parameters
-==========
-
-TARGET
- Specifies the symbolic name of the target texture. `GL_TEXTURE_1D',
- `GL_TEXTURE_2D', `GL_TEXTURE_3D', and `GL_TEXTURE_CUBE_MAP' are
- accepted.
-
-PNAME
- Specifies the symbolic name of a texture parameter.
- `GL_TEXTURE_MAG_FILTER', `GL_TEXTURE_MIN_FILTER',
- `GL_TEXTURE_MIN_LOD', `GL_TEXTURE_MAX_LOD',
- `GL_TEXTURE_BASE_LEVEL', `GL_TEXTURE_MAX_LEVEL',
- `GL_TEXTURE_WRAP_S', `GL_TEXTURE_WRAP_T', `GL_TEXTURE_WRAP_R',
- `GL_TEXTURE_BORDER_COLOR', `GL_TEXTURE_PRIORITY',
- `GL_TEXTURE_RESIDENT', `GL_TEXTURE_COMPARE_MODE',
- `GL_TEXTURE_COMPARE_FUNC', `GL_DEPTH_TEXTURE_MODE', and
- `GL_GENERATE_MIPMAP' are accepted.
-
-PARAMS
- Returns the texture parameters.
-
-
-Description
-===========
-
-`glGetTexParameter' returns in PARAMS the value or values of the texture
-parameter specified as PNAME. TARGET defines the target texture, either
-`GL_TEXTURE_1D', `GL_TEXTURE_2D', `GL_TEXTURE_3D', or
-`GL_TEXTURE_CUBE_MAP', to specify one-, two-, or three-dimensional or
-cube-mapped texturing. PNAME accepts the same symbols as
-`glTexParameter', with the same interpretations:
-
-`GL_TEXTURE_MAG_FILTER'
- Returns the single-valued texture magnification filter, a symbolic
- constant. The initial value is `GL_LINEAR'.
-
-`GL_TEXTURE_MIN_FILTER'
- Returns the single-valued texture minification filter, a symbolic
- constant. The initial value is `GL_NEAREST_MIPMAP_LINEAR'.
-
-`GL_TEXTURE_MIN_LOD'
- Returns the single-valued texture minimum level-of-detail value.
- The initial value is -1000.
-
-`GL_TEXTURE_MAX_LOD'
- Returns the single-valued texture maximum level-of-detail value.
- The initial value is 1000.
-
-`GL_TEXTURE_BASE_LEVEL'
- Returns the single-valued base texture mipmap level. The initial
- value is 0.
-
-`GL_TEXTURE_MAX_LEVEL'
- Returns the single-valued maximum texture mipmap array level. The
- initial value is 1000.
-
-`GL_TEXTURE_WRAP_S'
- Returns the single-valued wrapping function for texture coordinate
- S, a symbolic constant. The initial value is `GL_REPEAT'.
-
-`GL_TEXTURE_WRAP_T'
- Returns the single-valued wrapping function for texture coordinate
- T, a symbolic constant. The initial value is `GL_REPEAT'.
-
-`GL_TEXTURE_WRAP_R'
- Returns the single-valued wrapping function for texture coordinate
- R, a symbolic constant. The initial value is `GL_REPEAT'.
-
-`GL_TEXTURE_BORDER_COLOR'
- Returns four integer or floating-point numbers that comprise the
- RGBA color of the texture border. Floating-point values are
- returned in the range [0,1]. Integer values are returned as a
- linear mapping of the internal floating-point representation such
- that 1.0 maps to the most positive representable integer and -1.0
- maps to the most negative representable integer. The initial value
- is (0, 0, 0, 0).
-
-`GL_TEXTURE_PRIORITY'
- Returns the residence priority of the target texture (or the named
- texture bound to it). The initial value is 1. See
- `glPrioritizeTextures'.
-
-`GL_TEXTURE_RESIDENT'
- Returns the residence status of the target texture. If the value
- returned in PARAMS is `GL_TRUE', the texture is resident in texture
- memory. See `glAreTexturesResident'.
-
-`GL_TEXTURE_COMPARE_MODE'
- Returns a single-valued texture comparison mode, a symbolic
- constant. The initial value is `GL_NONE'. See `glTexParameter'.
-
-`GL_TEXTURE_COMPARE_FUNC'
- Returns a single-valued texture comparison function, a symbolic
- constant. The initial value is `GL_LEQUAL'. See `glTexParameter'.
-
-`GL_DEPTH_TEXTURE_MODE'
- Returns a single-valued texture format indicating how the depth
- values should be converted into color components. The initial value
- is `GL_LUMINANCE'. See `glTexParameter'.
-
-`GL_GENERATE_MIPMAP'
- Returns a single boolean value indicating if automatic mipmap level
- updates are enabled. See `glTexParameter'.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if TARGET or PNAME is not an accepted
-value.
-
-`GL_INVALID_OPERATION' is generated if `glGetTexParameter' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glGetUniformLocation
- "glGetUniformLocation"
- (funcsynopsis
- (funcprototype
- (funcdef
- "GLint "
- (function "glGetUniformLocation"))
- (paramdef "GLuint " (parameter "program"))
- (paramdef "const GLchar *" (parameter "name"))))
- "Returns the location of a uniform variable
-==========================================
-
-
-Parameters
-==========
-
-PROGRAM
- Specifies the program object to be queried.
-
-NAME
- Points to a null terminated string containing the name of the
- uniform variable whose location is to be queried.
-
-
-Description
-===========
-
-`glGetUniformLocation ' returns an integer that represents the location
-of a specific uniform variable within a program object. NAME must be a
-null terminated string that contains no white space. NAME must be an
-active uniform variable name in PROGRAM that is not a structure, an
-array of structures, or a subcomponent of a vector or a matrix. This
-function returns -1 if NAME does not correspond to an active uniform
-variable in PROGRAM or if NAME starts with the reserved prefix \"gl_\".
-
-Uniform variables that are structures or arrays of structures may be
-queried by calling `glGetUniformLocation' for each field within the
-structure. The array element operator \"[]\" and the structure field
-operator \".\" may be used in NAME in order to select elements within an
-array or fields within a structure. The result of using these operators
-is not allowed to be another structure, an array of structures, or a
-subcomponent of a vector or a matrix. Except if the last part of NAME
-indicates a uniform variable array, the location of the first element of
-an array can be retrieved by using the name of the array, or by using
-the name appended by \"[0]\".
-
-The actual locations assigned to uniform variables are not known until
-the program object is linked successfully. After linking has occurred,
-the command `glGetUniformLocation' can be used to obtain the location of
-a uniform variable. This location value can then be passed to
-`glUniform' to set the value of the uniform variable or to
-`glGetUniform' in order to query the current value of the uniform
-variable. After a program object has been linked successfully, the index
-values for uniform variables remain fixed until the next link command
-occurs. Uniform variable locations and values can only be queried after
-a link if the link was successful.
-
-
-Errors
-======
-
-`GL_INVALID_VALUE' is generated if PROGRAM is not a value generated by
-OpenGL.
-
-`GL_INVALID_OPERATION' is generated if PROGRAM is not a program object.
-
-`GL_INVALID_OPERATION' is generated if PROGRAM has not been successfully
-linked.
-
-`GL_INVALID_OPERATION' is generated if `glGetUniformLocation' is
-executed between the execution of `glBegin' and the corresponding
-execution of `glEnd'.")
-
-(define-gl-procedure
- glGetUniformfv
- "glGetUniformfv"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glGetUniformfv"))
- (paramdef "GLuint " (parameter "program"))
- (paramdef "GLint " (parameter "location"))
- (paramdef "GLfloat *" (parameter "params")))
- (funcprototype
- (funcdef "void " (function "glGetUniformiv"))
- (paramdef "GLuint " (parameter "program"))
- (paramdef "GLint " (parameter "location"))
- (paramdef "GLint *" (parameter "params"))))
- "Returns the value of a uniform variable
-=======================================
-
-
-Parameters
-==========
-
-PROGRAM
- Specifies the program object to be queried.
-
-LOCATION
- Specifies the location of the uniform variable to be queried.
-
-PARAMS
- Returns the value of the specified uniform variable.
-
-
-Description
-===========
-
-`glGetUniform' returns in PARAMS the value(s) of the specified uniform
-variable. The type of the uniform variable specified by LOCATION
-determines the number of values returned. If the uniform variable is
-defined in the shader as a boolean, int, or float, a single value will
-be returned. If it is defined as a vec2, ivec2, or bvec2, two values
-will be returned. If it is defined as a vec3, ivec3, or bvec3, three
-values will be returned, and so on. To query values stored in uniform
-variables declared as arrays, call `glGetUniform' for each element of
-the array. To query values stored in uniform variables declared as
-structures, call `glGetUniform' for each field in the structure. The
-values for uniform variables declared as a matrix will be returned in
-column major order.
-
-The locations assigned to uniform variables are not known until the
-program object is linked. After linking has occurred, the command
-`glGetUniformLocation' can be used to obtain the location of a uniform
-variable. This location value can then be passed to `glGetUniform' in
-order to query the current value of the uniform variable. After a
-program object has been linked successfully, the index values for
-uniform variables remain fixed until the next link command occurs. The
-uniform variable values can only be queried after a link if the link was
-successful.
-
-
-Errors
-======
-
-`GL_INVALID_VALUE' is generated if PROGRAM is not a value generated by
-OpenGL.
-
-`GL_INVALID_OPERATION' is generated if PROGRAM is not a program object.
-
-`GL_INVALID_OPERATION' is generated if PROGRAM has not been successfully
-linked.
-
-`GL_INVALID_OPERATION' is generated if LOCATION does not correspond to a
-valid uniform variable location for the specified program object.
-
-`GL_INVALID_OPERATION' is generated if `glGetUniform' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glGetVertexAttribPointerv
- "glGetVertexAttribPointerv"
- (funcsynopsis
- (funcprototype
- (funcdef
- "void "
- (function "glGetVertexAttribPointerv"))
- (paramdef "GLuint " (parameter "index"))
- (paramdef "GLenum " (parameter "pname"))
- (paramdef "GLvoid **" (parameter "pointer"))))
- "return the address of the specified generic vertex attribute pointer
-====================================================================
-
-
-Parameters
-==========
-
-INDEX
- Specifies the generic vertex attribute parameter to be returned.
-
-PNAME
- Specifies the symbolic name of the generic vertex attribute
- parameter to be returned. Must be `GL_VERTEX_ATTRIB_ARRAY_POINTER'.
-
-POINTER
- Returns the pointer value.
-
-
-Description
-===========
-
-`glGetVertexAttribPointerv' returns pointer information. INDEX is the
-generic vertex attribute to be queried, PNAME is a symbolic constant
-indicating the pointer to be returned, and PARAMS is a pointer to a
-location in which to place the returned data.
-
-If a non-zero named buffer object was bound to the `GL_ARRAY_BUFFER'
-target (see `glBindBuffer') when the desired pointer was previously
-specified, the POINTER returned is a byte offset into the buffer
-object's data store.
-
-
-Errors
-======
-
-`GL_INVALID_VALUE' is generated if INDEX is greater than or equal to
-`GL_MAX_VERTEX_ATTRIBS'.
-
-`GL_INVALID_ENUM' is generated if PNAME is not an accepted value.")
-
-(define-gl-procedure
- glGetVertexAttribdv
- "glGetVertexAttribdv"
- (funcsynopsis
- (funcprototype
- (funcdef
- "void "
- (function "glGetVertexAttribdv"))
- (paramdef "GLuint " (parameter "index"))
- (paramdef "GLenum " (parameter "pname"))
- (paramdef "GLdouble *" (parameter "params")))
- (funcprototype
- (funcdef
- "void "
- (function "glGetVertexAttribfv"))
- (paramdef "GLuint " (parameter "index"))
- (paramdef "GLenum " (parameter "pname"))
- (paramdef "GLfloat *" (parameter "params")))
- (funcprototype
- (funcdef
- "void "
- (function "glGetVertexAttribiv"))
- (paramdef "GLuint " (parameter "index"))
- (paramdef "GLenum " (parameter "pname"))
- (paramdef "GLint *" (parameter "params"))))
- "Return a generic vertex attribute parameter
-===========================================
-
-
-Parameters
-==========
-
-INDEX
- Specifies the generic vertex attribute parameter to be queried.
-
-PNAME
- Specifies the symbolic name of the vertex attribute parameter to be
- queried. Accepted values are
- `GL_VERTEX_ATTRIB_ARRAY_BUFFER_BINDING',
- `GL_VERTEX_ATTRIB_ARRAY_ENABLED', `GL_VERTEX_ATTRIB_ARRAY_SIZE',
- `GL_VERTEX_ATTRIB_ARRAY_STRIDE', `GL_VERTEX_ATTRIB_ARRAY_TYPE',
- `GL_VERTEX_ATTRIB_ARRAY_NORMALIZED', or `GL_CURRENT_VERTEX_ATTRIB'.
-
-PARAMS
- Returns the requested data.
-
-
-Description
-===========
-
-`glGetVertexAttrib' returns in PARAMS the value of a generic vertex
-attribute parameter. The generic vertex attribute to be queried is
-specified by INDEX, and the parameter to be queried is specified by
-PNAME.
-
-The accepted parameter names are as follows:
-
-`GL_VERTEX_ATTRIB_ARRAY_BUFFER_BINDING'
-
-
- PARAMS returns a single value, the name of the buffer object
- currently bound to the binding point corresponding to generic
- vertex attribute array INDEX. If no buffer object is bound, 0 is
- returned. The initial value is 0.
-
-`GL_VERTEX_ATTRIB_ARRAY_ENABLED'
-
-
- PARAMS returns a single value that is non-zero (true) if the vertex
- attribute array for INDEX is enabled and 0 (false) if it is
- disabled. The initial value is `GL_FALSE'.
-
-`GL_VERTEX_ATTRIB_ARRAY_SIZE'
-
-
- PARAMS returns a single value, the size of the vertex attribute
- array for INDEX. The size is the number of values for each element
- of the vertex attribute array, and it will be 1, 2, 3, or 4. The
- initial value is 4.
-
-`GL_VERTEX_ATTRIB_ARRAY_STRIDE'
-
-
- PARAMS returns a single value, the array stride for (number of
- bytes between successive elements in) the vertex attribute array
- for INDEX. A value of 0 indicates that the array elements are
- stored sequentially in memory. The initial value is 0.
-
-`GL_VERTEX_ATTRIB_ARRAY_TYPE'
-
-
- PARAMS returns a single value, a symbolic constant indicating the
- array type for the vertex attribute array for INDEX. Possible
- values are `GL_BYTE', `GL_UNSIGNED_BYTE', `GL_SHORT',
- `GL_UNSIGNED_SHORT', `GL_INT', `GL_UNSIGNED_INT', `GL_FLOAT', and
- `GL_DOUBLE'. The initial value is `GL_FLOAT'.
-
-`GL_VERTEX_ATTRIB_ARRAY_NORMALIZED'
-
-
- PARAMS returns a single value that is non-zero (true) if
- fixed-point data types for the vertex attribute array indicated by
- INDEX are normalized when they are converted to floating point, and
- 0 (false) otherwise. The initial value is `GL_FALSE'.
-
-`GL_CURRENT_VERTEX_ATTRIB'
-
-
- PARAMS returns four values that represent the current value for the
- generic vertex attribute specified by index. Generic vertex
- attribute 0 is unique in that it has no current state, so an error
- will be generated if INDEX is 0. The initial value for all other
- generic vertex attributes is (0,0,0,1).
-
-All of the parameters except `GL_CURRENT_VERTEX_ATTRIB' represent
-client-side state.
-
-
-Errors
-======
-
-`GL_INVALID_VALUE' is generated if INDEX is greater than or equal to
-`GL_MAX_VERTEX_ATTRIBS'.
-
-`GL_INVALID_ENUM' is generated if PNAME is not an accepted value.
-
-`GL_INVALID_OPERATION' is generated if INDEX is 0 and PNAME is
-`GL_CURRENT_VERTEX_ATTRIB'.")
-
-(define-gl-procedure
- glGet
- "glGet"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glGetBooleanv"))
- (paramdef "GLenum " (parameter "pname"))
- (paramdef "GLboolean * " (parameter "params"))))
- "return the value or values of a selected parameter
-==================================================
-
-
-Parameters
-==========
-
-PNAME
- Specifies the parameter value to be returned. The symbolic
- constants in the list below are accepted.
-
-PARAMS
- Returns the value or values of the specified parameter.
-
-
-Description
-===========
-
-These four commands return values for simple state variables in GL.
-PNAME is a symbolic constant indicating the state variable to be
-returned, and PARAMS is a pointer to an array of the indicated type in
-which to place the returned data.
-
-Type conversion is performed if PARAMS has a different type than the
-state variable value being requested. If `glGetBooleanv' is called, a
-floating-point (or integer) value is converted to `GL_FALSE' if and only
-if it is 0.0 (or 0). Otherwise, it is converted to `GL_TRUE'. If
-`glGetIntegerv' is called, boolean values are returned as `GL_TRUE' or
-`GL_FALSE', and most floating-point values are rounded to the nearest
-integer value. Floating-point colors and normals, however, are returned
-with a linear mapping that maps 1.0 to the most positive representable
-integer value and -1.0 to the most negative representable integer value.
-If `glGetFloatv' or `glGetDoublev' is called, boolean values are
-returned as `GL_TRUE' or `GL_FALSE', and integer values are converted to
-floating-point values.
-
-The following symbolic constants are accepted by PNAME:
-
-`GL_ACCUM_ALPHA_BITS'
-
-
- PARAMS returns one value, the number of alpha bitplanes in the
- accumulation buffer.
-
-`GL_ACCUM_BLUE_BITS'
-
-
- PARAMS returns one value, the number of blue bitplanes in the
- accumulation buffer.
-
-`GL_ACCUM_CLEAR_VALUE'
-
-
- PARAMS returns four values: the red, green, blue, and alpha values
- used to clear the accumulation buffer. Integer values, if
- requested, are linearly mapped from the internal floating-point
- representation such that 1.0 returns the most positive
- representable integer value, and -1.0 returns the most negative
- representable integer value. The initial value is (0, 0, 0, 0). See
- `glClearAccum'.
-
-`GL_ACCUM_GREEN_BITS'
-
-
- PARAMS returns one value, the number of green bitplanes in the
- accumulation buffer.
-
-`GL_ACCUM_RED_BITS'
-
-
- PARAMS returns one value, the number of red bitplanes in the
- accumulation buffer.
-
-`GL_ACTIVE_TEXTURE'
-
-
- PARAMS returns a single value indicating the active multitexture
- unit. The initial value is `GL_TEXTURE0'. See `glActiveTexture'.
-
-`GL_ALIASED_POINT_SIZE_RANGE'
-
-
- PARAMS returns two values, the smallest and largest supported sizes
- for aliased points.
-
-`GL_ALIASED_LINE_WIDTH_RANGE'
-
-
- PARAMS returns two values, the smallest and largest supported
- widths for aliased lines.
-
-`GL_ALPHA_BIAS'
-
-
- PARAMS returns one value, the alpha bias factor used during pixel
- transfers. The initial value is 0. See `glPixelTransfer'.
-
-`GL_ALPHA_BITS'
-
-
- PARAMS returns one value, the number of alpha bitplanes in each
- color buffer.
-
-`GL_ALPHA_SCALE'
-
-
- PARAMS returns one value, the alpha scale factor used during pixel
- transfers. The initial value is 1. See `glPixelTransfer'.
-
-`GL_ALPHA_TEST'
-
-
- PARAMS returns a single boolean value indicating whether alpha
- testing of fragments is enabled. The initial value is `GL_FALSE'.
- See `glAlphaFunc'.
-
-`GL_ALPHA_TEST_FUNC'PARAMS returns one value,
-
-
- the symbolic name of the alpha test function. The initial value is
- `GL_ALWAYS'. See `glAlphaFunc'.
-
-`GL_ALPHA_TEST_REF'
-
-
- PARAMS returns one value, the reference value for the alpha test.
- The initial value is 0. See `glAlphaFunc'. An integer value, if
- requested, is linearly mapped from the internal floating-point
- representation such that 1.0 returns the most positive
- representable integer value, and -1.0 returns the most negative
- representable integer value.
-
-`GL_ARRAY_BUFFER_BINDING'
-
-
- PARAMS returns a single value, the name of the buffer object
- currently bound to the target `GL_ARRAY_BUFFER'. If no buffer
- object is bound to this target, 0 is returned. The initial value is
- 0. See `glBindBuffer'.
-
-`GL_ATTRIB_STACK_DEPTH'
-
-
- PARAMS returns one value, the depth of the attribute stack. If the
- stack is empty, 0 is returned. The initial value is 0. See
- `glPushAttrib'.
-
-`GL_AUTO_NORMAL'
-
-
- PARAMS returns a single boolean value indicating whether 2D map
- evaluation automatically generates surface normals. The initial
- value is `GL_FALSE'. See `glMap2'.
-
-`GL_AUX_BUFFERS'
-
-
- PARAMS returns one value, the number of auxiliary color buffers
- available.
-
-`GL_BLEND'
-
-
- PARAMS returns a single boolean value indicating whether blending
- is enabled. The initial value is `GL_FALSE'. See `glBlendFunc'.
-
-`GL_BLEND_COLOR'
-
-
- PARAMS returns four values, the red, green, blue, and alpha values
- which are the components of the blend color. See `glBlendColor'.
-
-`GL_BLEND_DST_ALPHA'
-
-
- PARAMS returns one value, the symbolic constant identifying the
- alpha destination blend function. The initial value is `GL_ZERO'.
- See `glBlendFunc' and `glBlendFuncSeparate'.
-
-`GL_BLEND_DST_RGB'
-
-
- PARAMS returns one value, the symbolic constant identifying the RGB
- destination blend function. The initial value is `GL_ZERO'. See
- `glBlendFunc' and `glBlendFuncSeparate'.
-
-`GL_BLEND_EQUATION_RGB'
-
-
- PARAMS returns one value, a symbolic constant indicating whether
- the RGB blend equation is `GL_FUNC_ADD', `GL_FUNC_SUBTRACT',
- `GL_FUNC_REVERSE_SUBTRACT', `GL_MIN' or `GL_MAX'. See
- `glBlendEquationSeparate'.
-
-`GL_BLEND_EQUATION_ALPHA'
-
-
- PARAMS returns one value, a symbolic constant indicating whether
- the Alpha blend equation is `GL_FUNC_ADD', `GL_FUNC_SUBTRACT',
- `GL_FUNC_REVERSE_SUBTRACT', `GL_MIN' or `GL_MAX'. See
- `glBlendEquationSeparate'.
-
-`GL_BLEND_SRC_ALPHA'
-
-
- PARAMS returns one value, the symbolic constant identifying the
- alpha source blend function. The initial value is `GL_ONE'. See
- `glBlendFunc' and `glBlendFuncSeparate'.
-
-`GL_BLEND_SRC_RGB'
-
-
- PARAMS returns one value, the symbolic constant identifying the RGB
- source blend function. The initial value is `GL_ONE'. See
- `glBlendFunc' and `glBlendFuncSeparate'.
-
-`GL_BLUE_BIAS'
-
-
- PARAMS returns one value, the blue bias factor used during pixel
- transfers. The initial value is 0. See `glPixelTransfer'.
-
-`GL_BLUE_BITS'
-
-
- PARAMS returns one value, the number of blue bitplanes in each
- color buffer.
-
-`GL_BLUE_SCALE'
-
-
- PARAMS returns one value, the blue scale factor used during pixel
- transfers. The initial value is 1. See `glPixelTransfer'.
-
-`GL_CLIENT_ACTIVE_TEXTURE'
-
-
- PARAMS returns a single integer value indicating the current client
- active multitexture unit. The initial value is `GL_TEXTURE0'. See
- `glClientActiveTexture'.
-
-`GL_CLIENT_ATTRIB_STACK_DEPTH'
-
-
- PARAMS returns one value indicating the depth of the attribute
- stack. The initial value is 0. See `glPushClientAttrib'.
-
-`GL_CLIP_PLANE'I
-
-
- PARAMS returns a single boolean value indicating whether the
- specified clipping plane is enabled. The initial value is
- `GL_FALSE'. See `glClipPlane'.
-
-`GL_COLOR_ARRAY'
-
-
- PARAMS returns a single boolean value indicating whether the color
- array is enabled. The initial value is `GL_FALSE'. See
- `glColorPointer'.
-
-`GL_COLOR_ARRAY_BUFFER_BINDING'
-
-
- PARAMS returns a single value, the name of the buffer object
- associated with the color array. This buffer object would have been
- bound to the target `GL_ARRAY_BUFFER' at the time of the most
- recent call to `glColorPointer'. If no buffer object was bound to
- this target, 0 is returned. The initial value is 0. See
- `glBindBuffer'.
-
-`GL_COLOR_ARRAY_SIZE'
-
-
- PARAMS returns one value, the number of components per color in the
- color array. The initial value is 4. See `glColorPointer'.
-
-`GL_COLOR_ARRAY_STRIDE'
-
-
- PARAMS returns one value, the byte offset between consecutive
- colors in the color array. The initial value is 0. See
- `glColorPointer'.
-
-`GL_COLOR_ARRAY_TYPE'
-
-
- PARAMS returns one value, the data type of each component in the
- color array. The initial value is `GL_FLOAT'. See `glColorPointer'.
-
-`GL_COLOR_CLEAR_VALUE'
-
-
- PARAMS returns four values: the red, green, blue, and alpha values
- used to clear the color buffers. Integer values, if requested, are
- linearly mapped from the internal floating-point representation
- such that 1.0 returns the most positive representable integer
- value, and -1.0 returns the most negative representable integer
- value. The initial value is (0, 0, 0, 0). See `glClearColor'.
-
-`GL_COLOR_LOGIC_OP'
-
-
- PARAMS returns a single boolean value indicating whether a
- fragment's RGBA color values are merged into the framebuffer using
- a logical operation. The initial value is `GL_FALSE'. See
- `glLogicOp'.
-
-`GL_COLOR_MATERIAL'
-
-
- PARAMS returns a single boolean value indicating whether one or
- more material parameters are tracking the current color. The
- initial value is `GL_FALSE'. See `glColorMaterial'.
-
-`GL_COLOR_MATERIAL_FACE'
-
-
- PARAMS returns one value, a symbolic constant indicating which
- materials have a parameter that is tracking the current color. The
- initial value is `GL_FRONT_AND_BACK'. See `glColorMaterial'.
-
-`GL_COLOR_MATERIAL_PARAMETER'
-
-
- PARAMS returns one value, a symbolic constant indicating which
- material parameters are tracking the current color. The initial
- value is `GL_AMBIENT_AND_DIFFUSE'. See `glColorMaterial'.
-
-`GL_COLOR_MATRIX'
-
-
- PARAMS returns sixteen values: the color matrix on the top of the
- color matrix stack. Initially this matrix is the identity matrix.
- See `glPushMatrix'.
-
-`GL_COLOR_MATRIX_STACK_DEPTH'
-
-
- PARAMS returns one value, the maximum supported depth of the
- projection matrix stack. The value must be at least 2. See
- `glPushMatrix'.
-
-`GL_COLOR_SUM'
-
-
- PARAMS returns a single boolean value indicating whether primary
- and secondary color sum is enabled. See `glSecondaryColor'.
-
-`GL_COLOR_TABLE'
-
-
- PARAMS returns a single boolean value indicating whether the color
- table lookup is enabled. See `glColorTable'.
-
-`GL_COLOR_WRITEMASK'
-
-
- PARAMS returns four boolean values: the red, green, blue, and alpha
- write enables for the color buffers. The initial value is
- (`GL_TRUE', `GL_TRUE', `GL_TRUE', `GL_TRUE'). See `glColorMask'.
-
-`GL_COMPRESSED_TEXTURE_FORMATS'
-
-
- PARAMS returns a list of symbolic constants of length
- `GL_NUM_COMPRESSED_TEXTURE_FORMATS' indicating which compressed
- texture formats are available. See `glCompressedTexImage2D'.
-
-`GL_CONVOLUTION_1D'
-
-
- PARAMS returns a single boolean value indicating whether 1D
- convolution is enabled. The initial value is `GL_FALSE'. See
- `glConvolutionFilter1D'.
-
-`GL_CONVOLUTION_2D'
-
-
- PARAMS returns a single boolean value indicating whether 2D
- convolution is enabled. The initial value is `GL_FALSE'. See
- `glConvolutionFilter2D'.
-
-`GL_CULL_FACE'
-
-
- PARAMS returns a single boolean value indicating whether polygon
- culling is enabled. The initial value is `GL_FALSE'. See
- `glCullFace'.
-
-`GL_CULL_FACE_MODE'
-
-
- PARAMS returns one value, a symbolic constant indicating which
- polygon faces are to be culled. The initial value is `GL_BACK'. See
- `glCullFace'.
-
-`GL_CURRENT_COLOR'
-
-
- PARAMS returns four values: the red, green, blue, and alpha values
- of the current color. Integer values, if requested, are linearly
- mapped from the internal floating-point representation such that
- 1.0 returns the most positive representable integer value, and -1.0
- returns the most negative representable integer value. The initial
- value is (1, 1, 1, 1). See `glColor'.
-
-`GL_CURRENT_FOG_COORD'
-
-
- PARAMS returns one value, the current fog coordinate. The initial
- value is 0. See `glFogCoord'.
-
-`GL_CURRENT_INDEX'
-
-
- PARAMS returns one value, the current color index. The initial
- value is 1. See `glIndex'.
-
-`GL_CURRENT_NORMAL'
-
-
- PARAMS returns three values: the X, Y, and Z values of the current
- normal. Integer values, if requested, are linearly mapped from the
- internal floating-point representation such that 1.0 returns the
- most positive representable integer value, and -1.0 returns the
- most negative representable integer value. The initial value is (0,
- 0, 1). See `glNormal'.
-
-`GL_CURRENT_PROGRAM'
-
-
- PARAMS returns one value, the name of the program object that is
- currently active, or 0 if no program object is active. See
- `glUseProgram'.
-
-`GL_CURRENT_RASTER_COLOR'
-
-
- PARAMS returns four values: the red, green, blue, and alpha color
- values of the current raster position. Integer values, if
- requested, are linearly mapped from the internal floating-point
- representation such that 1.0 returns the most positive
- representable integer value, and -1.0 returns the most negative
- representable integer value. The initial value is (1, 1, 1, 1). See
- `glRasterPos'.
-
-`GL_CURRENT_RASTER_DISTANCE'
-
-
- PARAMS returns one value, the distance from the eye to the current
- raster position. The initial value is 0. See `glRasterPos'.
-
-`GL_CURRENT_RASTER_INDEX'
-
-
- PARAMS returns one value, the color index of the current raster
- position. The initial value is 1. See `glRasterPos'.
-
-`GL_CURRENT_RASTER_POSITION'
-
-
- PARAMS returns four values: the X, Y, Z, and W components of the
- current raster position. X, Y, and Z are in window coordinates, and
- W is in clip coordinates. The initial value is (0, 0, 0, 1). See
- `glRasterPos'.
-
-`GL_CURRENT_RASTER_POSITION_VALID'
-
-
- PARAMS returns a single boolean value indicating whether the
- current raster position is valid. The initial value is `GL_TRUE'.
- See `glRasterPos'.
-
-`GL_CURRENT_RASTER_SECONDARY_COLOR'
-
-
- PARAMS returns four values: the red, green, blue, and alpha
- secondary color values of the current raster position. Integer
- values, if requested, are linearly mapped from the internal
- floating-point representation such that 1.0 returns the most
- positive representable integer value, and -1.0 returns the most
- negative representable integer value. The initial value is (1, 1,
- 1, 1). See `glRasterPos'.
-
-`GL_CURRENT_RASTER_TEXTURE_COORDS'
-
-
- PARAMS returns four values: the S, T, R, and Q texture coordinates
- of the current raster position. The initial value is (0, 0, 0, 1).
- See `glRasterPos' and `glMultiTexCoord'.
-
-`GL_CURRENT_SECONDARY_COLOR'
-
-
- PARAMS returns four values: the red, green, blue, and alpha values
- of the current secondary color. Integer values, if requested, are
- linearly mapped from the internal floating-point representation
- such that 1.0 returns the most positive representable integer
- value, and -1.0 returns the most negative representable integer
- value. The initial value is (0, 0, 0, 0). See `glSecondaryColor'.
-
-`GL_CURRENT_TEXTURE_COORDS'
-
-
- PARAMS returns four values: the S, T, R, and Q current texture
- coordinates. The initial value is (0, 0, 0, 1). See
- `glMultiTexCoord'.
-
-`GL_DEPTH_BIAS'
-
-
- PARAMS returns one value, the depth bias factor used during pixel
- transfers. The initial value is 0. See `glPixelTransfer'.
-
-`GL_DEPTH_BITS'
-
-
- PARAMS returns one value, the number of bitplanes in the depth
- buffer.
-
-`GL_DEPTH_CLEAR_VALUE'
-
-
- PARAMS returns one value, the value that is used to clear the depth
- buffer. Integer values, if requested, are linearly mapped from the
- internal floating-point representation such that 1.0 returns the
- most positive representable integer value, and -1.0 returns the
- most negative representable integer value. The initial value is 1.
- See `glClearDepth'.
-
-`GL_DEPTH_FUNC'
-
-
- PARAMS returns one value, the symbolic constant that indicates the
- depth comparison function. The initial value is `GL_LESS'. See
- `glDepthFunc'.
-
-`GL_DEPTH_RANGE'
-
-
- PARAMS returns two values: the near and far mapping limits for the
- depth buffer. Integer values, if requested, are linearly mapped
- from the internal floating-point representation such that 1.0
- returns the most positive representable integer value, and -1.0
- returns the most negative representable integer value. The initial
- value is (0, 1). See `glDepthRange'.
-
-`GL_DEPTH_SCALE'
-
-
- PARAMS returns one value, the depth scale factor used during pixel
- transfers. The initial value is 1. See `glPixelTransfer'.
-
-`GL_DEPTH_TEST'
-
-
- PARAMS returns a single boolean value indicating whether depth
- testing of fragments is enabled. The initial value is `GL_FALSE'.
- See `glDepthFunc' and `glDepthRange'.
-
-`GL_DEPTH_WRITEMASK'
-
-
- PARAMS returns a single boolean value indicating if the depth
- buffer is enabled for writing. The initial value is `GL_TRUE'. See
- `glDepthMask'.
-
-`GL_DITHER'
-
-
- PARAMS returns a single boolean value indicating whether dithering
- of fragment colors and indices is enabled. The initial value is
- `GL_TRUE'.
-
-`GL_DOUBLEBUFFER'
-
-
- PARAMS returns a single boolean value indicating whether double
- buffering is supported.
-
-`GL_DRAW_BUFFER'
-
-
- PARAMS returns one value, a symbolic constant indicating which
- buffers are being drawn to. See `glDrawBuffer'. The initial value
- is `GL_BACK' if there are back buffers, otherwise it is `GL_FRONT'.
-
-`GL_DRAW_BUFFER'I
-
-
- PARAMS returns one value, a symbolic constant indicating which
- buffers are being drawn to by the corresponding output color. See
- `glDrawBuffers'. The initial value of `GL_DRAW_BUFFER0' is
- `GL_BACK' if there are back buffers, otherwise it is `GL_FRONT'.
- The initial values of draw buffers for all other output colors is
- `GL_NONE'.
-
-`GL_EDGE_FLAG'
-
-
- PARAMS returns a single boolean value indicating whether the
- current edge flag is `GL_TRUE' or `GL_FALSE'. The initial value is
- `GL_TRUE'. See `glEdgeFlag'.
-
-`GL_EDGE_FLAG_ARRAY'
-
-
- PARAMS returns a single boolean value indicating whether the edge
- flag array is enabled. The initial value is `GL_FALSE'. See
- `glEdgeFlagPointer'.
-
-`GL_EDGE_FLAG_ARRAY_BUFFER_BINDING'
-
-
- PARAMS returns a single value, the name of the buffer object
- associated with the edge flag array. This buffer object would have
- been bound to the target `GL_ARRAY_BUFFER' at the time of the most
- recent call to `glEdgeFlagPointer'. If no buffer object was bound
- to this target, 0 is returned. The initial value is 0. See
- `glBindBuffer'.
-
-`GL_EDGE_FLAG_ARRAY_STRIDE'
-
-
- PARAMS returns one value, the byte offset between consecutive edge
- flags in the edge flag array. The initial value is 0. See
- `glEdgeFlagPointer'.
-
-`GL_ELEMENT_ARRAY_BUFFER_BINDING'
-
-
- PARAMS returns a single value, the name of the buffer object
- currently bound to the target `GL_ELEMENT_ARRAY_BUFFER'. If no
- buffer object is bound to this target, 0 is returned. The initial
- value is 0. See `glBindBuffer'.
-
-`GL_FEEDBACK_BUFFER_SIZE'
-
-
- PARAMS returns one value, the size of the feedback buffer. See
- `glFeedbackBuffer'.
-
-`GL_FEEDBACK_BUFFER_TYPE'
-
-
- PARAMS returns one value, the type of the feedback buffer. See
- `glFeedbackBuffer'.
-
-`GL_FOG'
-
-
- PARAMS returns a single boolean value indicating whether fogging is
- enabled. The initial value is `GL_FALSE'. See `glFog'.
-
-`GL_FOG_COORD_ARRAY'
-
-
- PARAMS returns a single boolean value indicating whether the fog
- coordinate array is enabled. The initial value is `GL_FALSE'. See
- `glFogCoordPointer'.
-
-`GL_FOG_COORD_ARRAY_BUFFER_BINDING'
-
-
- PARAMS returns a single value, the name of the buffer object
- associated with the fog coordinate array. This buffer object would
- have been bound to the target `GL_ARRAY_BUFFER' at the time of the
- most recent call to `glFogCoordPointer'. If no buffer object was
- bound to this target, 0 is returned. The initial value is 0. See
- `glBindBuffer'.
-
-`GL_FOG_COORD_ARRAY_STRIDE'
-
-
- PARAMS returns one value, the byte offset between consecutive fog
- coordinates in the fog coordinate array. The initial value is 0.
- See `glFogCoordPointer'.
-
-`GL_FOG_COORD_ARRAY_TYPE'
-
-
- PARAMS returns one value, the type of the fog coordinate array. The
- initial value is `GL_FLOAT'. See `glFogCoordPointer'.
-
-`GL_FOG_COORD_SRC'
-
-
- PARAMS returns one value, a symbolic constant indicating the source
- of the fog coordinate. The initial value is `GL_FRAGMENT_DEPTH'.
- See `glFog'.
-
-`GL_FOG_COLOR'
-
-
- PARAMS returns four values: the red, green, blue, and alpha
- components of the fog color. Integer values, if requested, are
- linearly mapped from the internal floating-point representation
- such that 1.0 returns the most positive representable integer
- value, and -1.0 returns the most negative representable integer
- value. The initial value is (0, 0, 0, 0). See `glFog'.
-
-`GL_FOG_DENSITY'
-
-
- PARAMS returns one value, the fog density parameter. The initial
- value is 1. See `glFog'.
-
-`GL_FOG_END'
-
-
- PARAMS returns one value, the end factor for the linear fog
- equation. The initial value is 1. See `glFog'.
-
-`GL_FOG_HINT'
-
-
- PARAMS returns one value, a symbolic constant indicating the mode
- of the fog hint. The initial value is `GL_DONT_CARE'. See `glHint'.
-
-`GL_FOG_INDEX'
-
-
- PARAMS returns one value, the fog color index. The initial value is
- 0. See `glFog'.
-
-`GL_FOG_MODE'
-
-
- PARAMS returns one value, a symbolic constant indicating which fog
- equation is selected. The initial value is `GL_EXP'. See `glFog'.
-
-`GL_FOG_START'
-
-
- PARAMS returns one value, the start factor for the linear fog
- equation. The initial value is 0. See `glFog'.
-
-`GL_FRAGMENT_SHADER_DERIVATIVE_HINT'
-
-
- PARAMS returns one value, a symbolic constant indicating the mode
- of the derivative accuracy hint for fragment shaders. The initial
- value is `GL_DONT_CARE'. See `glHint'.
-
-`GL_FRONT_FACE'
-
-
- PARAMS returns one value, a symbolic constant indicating whether
- clockwise or counterclockwise polygon winding is treated as
- front-facing. The initial value is `GL_CCW'. See `glFrontFace'.
-
-`GL_GENERATE_MIPMAP_HINT'
-
-
- PARAMS returns one value, a symbolic constant indicating the mode
- of the mipmap generation filtering hint. The initial value is
- `GL_DONT_CARE'. See `glHint'.
-
-`GL_GREEN_BIAS'
-
-
- PARAMS returns one value, the green bias factor used during pixel
- transfers. The initial value is 0.
-
-`GL_GREEN_BITS'
-
-
- PARAMS returns one value, the number of green bitplanes in each
- color buffer.
-
-`GL_GREEN_SCALE'
-
-
- PARAMS returns one value, the green scale factor used during pixel
- transfers. The initial value is 1. See `glPixelTransfer'.
-
-`GL_HISTOGRAM'
-
-
- PARAMS returns a single boolean value indicating whether histogram
- is enabled. The initial value is `GL_FALSE'. See `glHistogram'.
-
-`GL_INDEX_ARRAY'
-
-
- PARAMS returns a single boolean value indicating whether the color
- index array is enabled. The initial value is `GL_FALSE'. See
- `glIndexPointer'.
-
-`GL_INDEX_ARRAY_BUFFER_BINDING'
-
-
- PARAMS returns a single value, the name of the buffer object
- associated with the color index array. This buffer object would
- have been bound to the target `GL_ARRAY_BUFFER' at the time of the
- most recent call to `glIndexPointer'. If no buffer object was bound
- to this target, 0 is returned. The initial value is 0. See
- `glBindBuffer'.
-
-`GL_INDEX_ARRAY_STRIDE'
-
-
- PARAMS returns one value, the byte offset between consecutive color
- indexes in the color index array. The initial value is 0. See
- `glIndexPointer'.
-
-`GL_INDEX_ARRAY_TYPE'
-
-
- PARAMS returns one value, the data type of indexes in the color
- index array. The initial value is `GL_FLOAT'. See `glIndexPointer'.
-
-`GL_INDEX_BITS'
-
-
- PARAMS returns one value, the number of bitplanes in each color
- index buffer.
-
-`GL_INDEX_CLEAR_VALUE'
-
-
- PARAMS returns one value, the color index used to clear the color
- index buffers. The initial value is 0. See `glClearIndex'.
-
-`GL_INDEX_LOGIC_OP'
-
-
- PARAMS returns a single boolean value indicating whether a
- fragment's index values are merged into the framebuffer using a
- logical operation. The initial value is `GL_FALSE'. See
- `glLogicOp'.
-
-`GL_INDEX_MODE'
-
-
- PARAMS returns a single boolean value indicating whether the GL is
- in color index mode (`GL_TRUE') or RGBA mode (`GL_FALSE').
-
-`GL_INDEX_OFFSET'
-
-
- PARAMS returns one value, the offset added to color and stencil
- indices during pixel transfers. The initial value is 0. See
- `glPixelTransfer'.
-
-`GL_INDEX_SHIFT'
-
-
- PARAMS returns one value, the amount that color and stencil indices
- are shifted during pixel transfers. The initial value is 0. See
- `glPixelTransfer'.
-
-`GL_INDEX_WRITEMASK'
-
-
- PARAMS returns one value, a mask indicating which bitplanes of each
- color index buffer can be written. The initial value is all 1's.
- See `glIndexMask'.
-
-`GL_LIGHT'I
-
-
- PARAMS returns a single boolean value indicating whether the
- specified light is enabled. The initial value is `GL_FALSE'. See
- `glLight' and `glLightModel'.
-
-`GL_LIGHTING'
-
-
- PARAMS returns a single boolean value indicating whether lighting
- is enabled. The initial value is `GL_FALSE'. See `glLightModel'.
-
-`GL_LIGHT_MODEL_AMBIENT'
-
-
- PARAMS returns four values: the red, green, blue, and alpha
- components of the ambient intensity of the entire scene. Integer
- values, if requested, are linearly mapped from the internal
- floating-point representation such that 1.0 returns the most
- positive representable integer value, and -1.0 returns the most
- negative representable integer value. The initial value is (0.2,
- 0.2, 0.2, 1.0). See `glLightModel'.
-
-`GL_LIGHT_MODEL_COLOR_CONTROL'
-
-
- PARAMS returns single enumerated value indicating whether specular
- reflection calculations are separated from normal lighting
- computations. The initial value is `GL_SINGLE_COLOR'.
-
-`GL_LIGHT_MODEL_LOCAL_VIEWER'
-
-
- PARAMS returns a single boolean value indicating whether specular
- reflection calculations treat the viewer as being local to the
- scene. The initial value is `GL_FALSE'. See `glLightModel'.
-
-`GL_LIGHT_MODEL_TWO_SIDE'
-
-
- PARAMS returns a single boolean value indicating whether separate
- materials are used to compute lighting for front- and back-facing
- polygons. The initial value is `GL_FALSE'. See `glLightModel'.
-
-`GL_LINE_SMOOTH'
-
-
- PARAMS returns a single boolean value indicating whether
- antialiasing of lines is enabled. The initial value is `GL_FALSE'.
- See `glLineWidth'.
-
-`GL_LINE_SMOOTH_HINT'
-
-
- PARAMS returns one value, a symbolic constant indicating the mode
- of the line antialiasing hint. The initial value is `GL_DONT_CARE'.
- See `glHint'.
-
-`GL_LINE_STIPPLE'
-
-
- PARAMS returns a single boolean value indicating whether stippling
- of lines is enabled. The initial value is `GL_FALSE'. See
- `glLineStipple'.
-
-`GL_LINE_STIPPLE_PATTERN'
-
-
- PARAMS returns one value, the 16-bit line stipple pattern. The
- initial value is all 1's. See `glLineStipple'.
-
-`GL_LINE_STIPPLE_REPEAT'
-
-
- PARAMS returns one value, the line stipple repeat factor. The
- initial value is 1. See `glLineStipple'.
-
-`GL_LINE_WIDTH'
-
-
- PARAMS returns one value, the line width as specified with
- `glLineWidth'. The initial value is 1.
-
-`GL_LINE_WIDTH_GRANULARITY'
-
-
- PARAMS returns one value, the width difference between adjacent
- supported widths for antialiased lines. See `glLineWidth'.
-
-`GL_LINE_WIDTH_RANGE'
-
-
- PARAMS returns two values: the smallest and largest supported
- widths for antialiased lines. See `glLineWidth'.
-
-`GL_LIST_BASE'
-
-
- PARAMS returns one value, the base offset added to all names in
- arrays presented to `glCallLists'. The initial value is 0. See
- `glListBase'.
-
-`GL_LIST_INDEX'
-
-
- PARAMS returns one value, the name of the display list currently
- under construction. 0 is returned if no display list is currently
- under construction. The initial value is 0. See `glNewList'.
-
-`GL_LIST_MODE'
-
-
- PARAMS returns one value, a symbolic constant indicating the
- construction mode of the display list currently under construction.
- The initial value is 0. See `glNewList'.
-
-`GL_LOGIC_OP_MODE'
-
-
- PARAMS returns one value, a symbolic constant indicating the
- selected logic operation mode. The initial value is `GL_COPY'. See
- `glLogicOp'.
-
-`GL_MAP1_COLOR_4'
-
-
- PARAMS returns a single boolean value indicating whether 1D
- evaluation generates colors. The initial value is `GL_FALSE'. See
- `glMap1'.
-
-`GL_MAP1_GRID_DOMAIN'
-
-
- PARAMS returns two values: the endpoints of the 1D map's grid
- domain. The initial value is (0, 1). See `glMapGrid'.
-
-`GL_MAP1_GRID_SEGMENTS'
-
-
- PARAMS returns one value, the number of partitions in the 1D map's
- grid domain. The initial value is 1. See `glMapGrid'.
-
-`GL_MAP1_INDEX'
-
-
- PARAMS returns a single boolean value indicating whether 1D
- evaluation generates color indices. The initial value is
- `GL_FALSE'. See `glMap1'.
-
-`GL_MAP1_NORMAL'
-
-
- PARAMS returns a single boolean value indicating whether 1D
- evaluation generates normals. The initial value is `GL_FALSE'. See
- `glMap1'.
-
-`GL_MAP1_TEXTURE_COORD_1'
-
-
- PARAMS returns a single boolean value indicating whether 1D
- evaluation generates 1D texture coordinates. The initial value is
- `GL_FALSE'. See `glMap1'.
-
-`GL_MAP1_TEXTURE_COORD_2'
-
-
- PARAMS returns a single boolean value indicating whether 1D
- evaluation generates 2D texture coordinates. The initial value is
- `GL_FALSE'. See `glMap1'.
-
-`GL_MAP1_TEXTURE_COORD_3'
-
-
- PARAMS returns a single boolean value indicating whether 1D
- evaluation generates 3D texture coordinates. The initial value is
- `GL_FALSE'. See `glMap1'.
-
-`GL_MAP1_TEXTURE_COORD_4'
-
-
- PARAMS returns a single boolean value indicating whether 1D
- evaluation generates 4D texture coordinates. The initial value is
- `GL_FALSE'. See `glMap1'.
-
-`GL_MAP1_VERTEX_3'
-
-
- PARAMS returns a single boolean value indicating whether 1D
- evaluation generates 3D vertex coordinates. The initial value is
- `GL_FALSE'. See `glMap1'.
-
-`GL_MAP1_VERTEX_4'
-
-
- PARAMS returns a single boolean value indicating whether 1D
- evaluation generates 4D vertex coordinates. The initial value is
- `GL_FALSE'. See `glMap1'.
-
-`GL_MAP2_COLOR_4'
-
-
- PARAMS returns a single boolean value indicating whether 2D
- evaluation generates colors. The initial value is `GL_FALSE'. See
- `glMap2'.
-
-`GL_MAP2_GRID_DOMAIN'
-
-
- PARAMS returns four values: the endpoints of the 2D map's I and J
- grid domains. The initial value is (0,1; 0,1). See `glMapGrid'.
-
-`GL_MAP2_GRID_SEGMENTS'
-
-
- PARAMS returns two values: the number of partitions in the 2D map's
- I and J grid domains. The initial value is (1,1). See `glMapGrid'.
-
-`GL_MAP2_INDEX'
-
-
- PARAMS returns a single boolean value indicating whether 2D
- evaluation generates color indices. The initial value is
- `GL_FALSE'. See `glMap2'.
-
-`GL_MAP2_NORMAL'
-
-
- PARAMS returns a single boolean value indicating whether 2D
- evaluation generates normals. The initial value is `GL_FALSE'. See
- `glMap2'.
-
-`GL_MAP2_TEXTURE_COORD_1'
-
-
- PARAMS returns a single boolean value indicating whether 2D
- evaluation generates 1D texture coordinates. The initial value is
- `GL_FALSE'. See `glMap2'.
-
-`GL_MAP2_TEXTURE_COORD_2'
-
-
- PARAMS returns a single boolean value indicating whether 2D
- evaluation generates 2D texture coordinates. The initial value is
- `GL_FALSE'. See `glMap2'.
-
-`GL_MAP2_TEXTURE_COORD_3'
-
-
- PARAMS returns a single boolean value indicating whether 2D
- evaluation generates 3D texture coordinates. The initial value is
- `GL_FALSE'. See `glMap2'.
-
-`GL_MAP2_TEXTURE_COORD_4'
-
-
- PARAMS returns a single boolean value indicating whether 2D
- evaluation generates 4D texture coordinates. The initial value is
- `GL_FALSE'. See `glMap2'.
-
-`GL_MAP2_VERTEX_3'
-
-
- PARAMS returns a single boolean value indicating whether 2D
- evaluation generates 3D vertex coordinates. The initial value is
- `GL_FALSE'. See `glMap2'.
-
-`GL_MAP2_VERTEX_4'
-
-
- PARAMS returns a single boolean value indicating whether 2D
- evaluation generates 4D vertex coordinates. The initial value is
- `GL_FALSE'. See `glMap2'.
-
-`GL_MAP_COLOR'
-
-
- PARAMS returns a single boolean value indicating if colors and
- color indices are to be replaced by table lookup during pixel
- transfers. The initial value is `GL_FALSE'. See `glPixelTransfer'.
-
-`GL_MAP_STENCIL'
-
-
- PARAMS returns a single boolean value indicating if stencil indices
- are to be replaced by table lookup during pixel transfers. The
- initial value is `GL_FALSE'. See `glPixelTransfer'.
-
-`GL_MATRIX_MODE'
-
-
- PARAMS returns one value, a symbolic constant indicating which
- matrix stack is currently the target of all matrix operations. The
- initial value is `GL_MODELVIEW'. See `glMatrixMode'.
-
-`GL_MAX_3D_TEXTURE_SIZE'
-
-
- PARAMS returns one value, a rough estimate of the largest 3D
- texture that the GL can handle. The value must be at least 16. If
- the GL version is 1.2 or greater, use `GL_PROXY_TEXTURE_3D' to
- determine if a texture is too large. See `glTexImage3D'.
-
-`GL_MAX_CLIENT_ATTRIB_STACK_DEPTH'
-
-
- PARAMS returns one value indicating the maximum supported depth of
- the client attribute stack. See `glPushClientAttrib'.
-
-`GL_MAX_ATTRIB_STACK_DEPTH'
-
-
- PARAMS returns one value, the maximum supported depth of the
- attribute stack. The value must be at least 16. See `glPushAttrib'.
-
-`GL_MAX_CLIP_PLANES'
-
-
- PARAMS returns one value, the maximum number of application-defined
- clipping planes. The value must be at least 6. See `glClipPlane'.
-
-`GL_MAX_COLOR_MATRIX_STACK_DEPTH'
-
-
- PARAMS returns one value, the maximum supported depth of the color
- matrix stack. The value must be at least 2. See `glPushMatrix'.
-
-`GL_MAX_COMBINED_TEXTURE_IMAGE_UNITS'
-
-
- PARAMS returns one value, the maximum supported texture image units
- that can be used to access texture maps from the vertex shader and
- the fragment processor combined. If both the vertex shader and the
- fragment processing stage access the same texture image unit, then
- that counts as using two texture image units against this limit.
- The value must be at least 2. See `glActiveTexture'.
-
-`GL_MAX_CUBE_MAP_TEXTURE_SIZE'
-
-
- PARAMS returns one value. The value gives a rough estimate of the
- largest cube-map texture that the GL can handle. The value must be
- at least 16. If the GL version is 1.3 or greater, use
- `GL_PROXY_TEXTURE_CUBE_MAP' to determine if a texture is too large.
- See `glTexImage2D'.
-
-`GL_MAX_DRAW_BUFFERS'
-
-
- PARAMS returns one value, the maximum number of simultaneous output
- colors allowed from a fragment shader using the `gl_FragData'
- built-in array. The value must be at least 1. See `glDrawBuffers'.
-
-`GL_MAX_ELEMENTS_INDICES'
-
-
- PARAMS returns one value, the recommended maximum number of vertex
- array indices. See `glDrawRangeElements'.
-
-`GL_MAX_ELEMENTS_VERTICES'
-
-
- PARAMS returns one value, the recommended maximum number of vertex
- array vertices. See `glDrawRangeElements'.
-
-`GL_MAX_EVAL_ORDER'
-
-
- PARAMS returns one value, the maximum equation order supported by
- 1D and 2D evaluators. The value must be at least 8. See `glMap1'
- and `glMap2'.
-
-`GL_MAX_FRAGMENT_UNIFORM_COMPONENTS'
-
-
- PARAMS returns one value, the maximum number of individual
- floating-point, integer, or boolean values that can be held in
- uniform variable storage for a fragment shader. The value must be
- at least 64. See `glUniform'.
-
-`GL_MAX_LIGHTS'
-
-
- PARAMS returns one value, the maximum number of lights. The value
- must be at least 8. See `glLight'.
-
-`GL_MAX_LIST_NESTING'
-
-
- PARAMS returns one value, the maximum recursion depth allowed
- during display-list traversal. The value must be at least 64. See
- `glCallList'.
-
-`GL_MAX_MODELVIEW_STACK_DEPTH'
-
-
- PARAMS returns one value, the maximum supported depth of the
- modelview matrix stack. The value must be at least 32. See
- `glPushMatrix'.
-
-`GL_MAX_NAME_STACK_DEPTH'
-
-
- PARAMS returns one value, the maximum supported depth of the
- selection name stack. The value must be at least 64. See
- `glPushName'.
-
-`GL_MAX_PIXEL_MAP_TABLE'
-
-
- PARAMS returns one value, the maximum supported size of a
- `glPixelMap' lookup table. The value must be at least 32. See
- `glPixelMap'.
-
-`GL_MAX_PROJECTION_STACK_DEPTH'
-
-
- PARAMS returns one value, the maximum supported depth of the
- projection matrix stack. The value must be at least 2. See
- `glPushMatrix'.
-
-`GL_MAX_TEXTURE_COORDS'
-
-
- PARAMS returns one value, the maximum number of texture coordinate
- sets available to vertex and fragment shaders. The value must be at
- least 2. See `glActiveTexture' and `glClientActiveTexture'.
-
-`GL_MAX_TEXTURE_IMAGE_UNITS'
-
-
- PARAMS returns one value, the maximum supported texture image units
- that can be used to access texture maps from the fragment shader.
- The value must be at least 2. See `glActiveTexture'.
-
-`GL_MAX_TEXTURE_LOD_BIAS'
-
-
- PARAMS returns one value, the maximum, absolute value of the
- texture level-of-detail bias. The value must be at least 4.
-
-`GL_MAX_TEXTURE_SIZE'
-
-
- PARAMS returns one value. The value gives a rough estimate of the
- largest texture that the GL can handle. The value must be at least
- 64. If the GL version is 1.1 or greater, use `GL_PROXY_TEXTURE_1D'
- or `GL_PROXY_TEXTURE_2D' to determine if a texture is too large.
- See `glTexImage1D' and `glTexImage2D'.
-
-`GL_MAX_TEXTURE_STACK_DEPTH'
-
-
- PARAMS returns one value, the maximum supported depth of the
- texture matrix stack. The value must be at least 2. See
- `glPushMatrix'.
-
-`GL_MAX_TEXTURE_UNITS'
-
-
- PARAMS returns a single value indicating the number of conventional
- texture units supported. Each conventional texture unit includes
- both a texture coordinate set and a texture image unit.
- Conventional texture units may be used for fixed-function
- (non-shader) rendering. The value must be at least 2. Additional
- texture coordinate sets and texture image units may be accessed
- from vertex and fragment shaders. See `glActiveTexture' and
- `glClientActiveTexture'.
-
-`GL_MAX_VARYING_FLOATS'
-
-
- PARAMS returns one value, the maximum number of interpolators
- available for processing varying variables used by vertex and
- fragment shaders. This value represents the number of individual
- floating-point values that can be interpolated; varying variables
- declared as vectors, matrices, and arrays will all consume multiple
- interpolators. The value must be at least 32.
-
-`GL_MAX_VERTEX_ATTRIBS'
-
-
- PARAMS returns one value, the maximum number of 4-component generic
- vertex attributes accessible to a vertex shader. The value must be
- at least 16. See `glVertexAttrib'.
-
-`GL_MAX_VERTEX_TEXTURE_IMAGE_UNITS'
-
-
- PARAMS returns one value, the maximum supported texture image units
- that can be used to access texture maps from the vertex shader. The
- value may be 0. See `glActiveTexture'.
-
-`GL_MAX_VERTEX_UNIFORM_COMPONENTS'
-
-
- PARAMS returns one value, the maximum number of individual
- floating-point, integer, or boolean values that can be held in
- uniform variable storage for a vertex shader. The value must be at
- least 512. See `glUniform'.
-
-`GL_MAX_VIEWPORT_DIMS'
-
-
- PARAMS returns two values: the maximum supported width and height
- of the viewport. These must be at least as large as the visible
- dimensions of the display being rendered to. See `glViewport'.
-
-`GL_MINMAX'
-
-
- PARAMS returns a single boolean value indicating whether pixel
- minmax values are computed. The initial value is `GL_FALSE'. See
- `glMinmax'.
-
-`GL_MODELVIEW_MATRIX'
-
-
- PARAMS returns sixteen values: the modelview matrix on the top of
- the modelview matrix stack. Initially this matrix is the identity
- matrix. See `glPushMatrix'.
-
-`GL_MODELVIEW_STACK_DEPTH'
-
-
- PARAMS returns one value, the number of matrices on the modelview
- matrix stack. The initial value is 1. See `glPushMatrix'.
-
-`GL_NAME_STACK_DEPTH'
-
-
- PARAMS returns one value, the number of names on the selection name
- stack. The initial value is 0. See `glPushName'.
-
-`GL_NORMAL_ARRAY'
-
-
- PARAMS returns a single boolean value, indicating whether the
- normal array is enabled. The initial value is `GL_FALSE'. See
- `glNormalPointer'.
-
-`GL_NORMAL_ARRAY_BUFFER_BINDING'
-
-
- PARAMS returns a single value, the name of the buffer object
- associated with the normal array. This buffer object would have
- been bound to the target `GL_ARRAY_BUFFER' at the time of the most
- recent call to `glNormalPointer'. If no buffer object was bound to
- this target, 0 is returned. The initial value is 0. See
- `glBindBuffer'.
-
-`GL_NORMAL_ARRAY_STRIDE'
-
-
- PARAMS returns one value, the byte offset between consecutive
- normals in the normal array. The initial value is 0. See
- `glNormalPointer'.
-
-`GL_NORMAL_ARRAY_TYPE'
-
-
- PARAMS returns one value, the data type of each coordinate in the
- normal array. The initial value is `GL_FLOAT'. See
- `glNormalPointer'.
-
-`GL_NORMALIZE'
-
-
- PARAMS returns a single boolean value indicating whether normals
- are automatically scaled to unit length after they have been
- transformed to eye coordinates. The initial value is `GL_FALSE'.
- See `glNormal'.
-
-`GL_NUM_COMPRESSED_TEXTURE_FORMATS'
-
-
- PARAMS returns a single integer value indicating the number of
- available compressed texture formats. The minimum value is 0. See
- `glCompressedTexImage2D'.
-
-`GL_PACK_ALIGNMENT'
-
-
- PARAMS returns one value, the byte alignment used for writing pixel
- data to memory. The initial value is 4. See `glPixelStore'.
-
-`GL_PACK_IMAGE_HEIGHT'
-
-
- PARAMS returns one value, the image height used for writing pixel
- data to memory. The initial value is 0. See `glPixelStore'.
-
-`GL_PACK_LSB_FIRST'
-
-
- PARAMS returns a single boolean value indicating whether single-bit
- pixels being written to memory are written first to the least
- significant bit of each unsigned byte. The initial value is
- `GL_FALSE'. See `glPixelStore'.
-
-`GL_PACK_ROW_LENGTH'
-
-
- PARAMS returns one value, the row length used for writing pixel
- data to memory. The initial value is 0. See `glPixelStore'.
-
-`GL_PACK_SKIP_IMAGES'
-
-
- PARAMS returns one value, the number of pixel images skipped before
- the first pixel is written into memory. The initial value is 0. See
- `glPixelStore'.
-
-`GL_PACK_SKIP_PIXELS'
-
-
- PARAMS returns one value, the number of pixel locations skipped
- before the first pixel is written into memory. The initial value is
- 0. See `glPixelStore'.
-
-`GL_PACK_SKIP_ROWS'
-
-
- PARAMS returns one value, the number of rows of pixel locations
- skipped before the first pixel is written into memory. The initial
- value is 0. See `glPixelStore'.
-
-`GL_PACK_SWAP_BYTES'
-
-
- PARAMS returns a single boolean value indicating whether the bytes
- of two-byte and four-byte pixel indices and components are swapped
- before being written to memory. The initial value is `GL_FALSE'.
- See `glPixelStore'.
-
-`GL_PERSPECTIVE_CORRECTION_HINT'
-
-
- PARAMS returns one value, a symbolic constant indicating the mode
- of the perspective correction hint. The initial value is
- `GL_DONT_CARE'. See `glHint'.
-
-`GL_PIXEL_MAP_A_TO_A_SIZE'
-
-
- PARAMS returns one value, the size of the alpha-to-alpha pixel
- translation table. The initial value is 1. See `glPixelMap'.
-
-`GL_PIXEL_MAP_B_TO_B_SIZE'
-
-
- PARAMS returns one value, the size of the blue-to-blue pixel
- translation table. The initial value is 1. See `glPixelMap'.
-
-`GL_PIXEL_MAP_G_TO_G_SIZE'
-
-
- PARAMS returns one value, the size of the green-to-green pixel
- translation table. The initial value is 1. See `glPixelMap'.
-
-`GL_PIXEL_MAP_I_TO_A_SIZE'
-
-
- PARAMS returns one value, the size of the index-to-alpha pixel
- translation table. The initial value is 1. See `glPixelMap'.
-
-`GL_PIXEL_MAP_I_TO_B_SIZE'
-
-
- PARAMS returns one value, the size of the index-to-blue pixel
- translation table. The initial value is 1. See `glPixelMap'.
-
-`GL_PIXEL_MAP_I_TO_G_SIZE'
-
-
- PARAMS returns one value, the size of the index-to-green pixel
- translation table. The initial value is 1. See `glPixelMap'.
-
-`GL_PIXEL_MAP_I_TO_I_SIZE'
-
-
- PARAMS returns one value, the size of the index-to-index pixel
- translation table. The initial value is 1. See `glPixelMap'.
-
-`GL_PIXEL_MAP_I_TO_R_SIZE'
-
-
- PARAMS returns one value, the size of the index-to-red pixel
- translation table. The initial value is 1. See `glPixelMap'.
-
-`GL_PIXEL_MAP_R_TO_R_SIZE'
-
-
- PARAMS returns one value, the size of the red-to-red pixel
- translation table. The initial value is 1. See `glPixelMap'.
-
-`GL_PIXEL_MAP_S_TO_S_SIZE'
-
-
- PARAMS returns one value, the size of the stencil-to-stencil pixel
- translation table. The initial value is 1. See `glPixelMap'.
-
-`GL_PIXEL_PACK_BUFFER_BINDING'
-
-
- PARAMS returns a single value, the name of the buffer object
- currently bound to the target `GL_PIXEL_PACK_BUFFER'. If no buffer
- object is bound to this target, 0 is returned. The initial value is
- 0. See `glBindBuffer'.
-
-`GL_PIXEL_UNPACK_BUFFER_BINDING'
-
-
- PARAMS returns a single value, the name of the buffer object
- currently bound to the target `GL_PIXEL_UNPACK_BUFFER'. If no
- buffer object is bound to this target, 0 is returned. The initial
- value is 0. See `glBindBuffer'.
-
-`GL_POINT_DISTANCE_ATTENUATION'
-
-
- PARAMS returns three values, the coefficients for computing the
- attenuation value for points. See `glPointParameter'.
-
-`GL_POINT_FADE_THRESHOLD_SIZE'
-
-
- PARAMS returns one value, the point size threshold for determining
- the point size. See `glPointParameter'.
-
-`GL_POINT_SIZE'
-
-
- PARAMS returns one value, the point size as specified by
- `glPointSize'. The initial value is 1.
-
-`GL_POINT_SIZE_GRANULARITY'
-
-
- PARAMS returns one value, the size difference between adjacent
- supported sizes for antialiased points. See `glPointSize'.
-
-`GL_POINT_SIZE_MAX'
-
-
- PARAMS returns one value, the upper bound for the attenuated point
- sizes. The initial value is 0.0. See `glPointParameter'.
-
-`GL_POINT_SIZE_MIN'
-
-
- PARAMS returns one value, the lower bound for the attenuated point
- sizes. The initial value is 1.0. See `glPointParameter'.
-
-`GL_POINT_SIZE_RANGE'
-
-
- PARAMS returns two values: the smallest and largest supported sizes
- for antialiased points. The smallest size must be at most 1, and
- the largest size must be at least 1. See `glPointSize'.
-
-`GL_POINT_SMOOTH'
-
-
- PARAMS returns a single boolean value indicating whether
- antialiasing of points is enabled. The initial value is `GL_FALSE'.
- See `glPointSize'.
-
-`GL_POINT_SMOOTH_HINT'
-
-
- PARAMS returns one value, a symbolic constant indicating the mode
- of the point antialiasing hint. The initial value is
- `GL_DONT_CARE'. See `glHint'.
-
-`GL_POINT_SPRITE'
-
-
- PARAMS returns a single boolean value indicating whether point
- sprite is enabled. The initial value is `GL_FALSE'.
-
-`GL_POLYGON_MODE'
-
-
- PARAMS returns two values: symbolic constants indicating whether
- front-facing and back-facing polygons are rasterized as points,
- lines, or filled polygons. The initial value is `GL_FILL'. See
- `glPolygonMode'.
-
-`GL_POLYGON_OFFSET_FACTOR'
-
-
- PARAMS returns one value, the scaling factor used to determine the
- variable offset that is added to the depth value of each fragment
- generated when a polygon is rasterized. The initial value is 0. See
- `glPolygonOffset'.
-
-`GL_POLYGON_OFFSET_UNITS'
-
-
- PARAMS returns one value. This value is multiplied by an
- implementation-specific value and then added to the depth value of
- each fragment generated when a polygon is rasterized. The initial
- value is 0. See `glPolygonOffset'.
-
-`GL_POLYGON_OFFSET_FILL'
-
-
- PARAMS returns a single boolean value indicating whether polygon
- offset is enabled for polygons in fill mode. The initial value is
- `GL_FALSE'. See `glPolygonOffset'.
-
-`GL_POLYGON_OFFSET_LINE'
-
-
- PARAMS returns a single boolean value indicating whether polygon
- offset is enabled for polygons in line mode. The initial value is
- `GL_FALSE'. See `glPolygonOffset'.
-
-`GL_POLYGON_OFFSET_POINT'
-
-
- PARAMS returns a single boolean value indicating whether polygon
- offset is enabled for polygons in point mode. The initial value is
- `GL_FALSE'. See `glPolygonOffset'.
-
-`GL_POLYGON_SMOOTH'
-
-
- PARAMS returns a single boolean value indicating whether
- antialiasing of polygons is enabled. The initial value is
- `GL_FALSE'. See `glPolygonMode'.
-
-`GL_POLYGON_SMOOTH_HINT'
-
-
- PARAMS returns one value, a symbolic constant indicating the mode
- of the polygon antialiasing hint. The initial value is
- `GL_DONT_CARE'. See `glHint'.
-
-`GL_POLYGON_STIPPLE'
-
-
- PARAMS returns a single boolean value indicating whether polygon
- stippling is enabled. The initial value is `GL_FALSE'. See
- `glPolygonStipple'.
-
-`GL_POST_COLOR_MATRIX_COLOR_TABLE'
-
-
- PARAMS returns a single boolean value indicating whether post color
- matrix transformation lookup is enabled. The initial value is
- `GL_FALSE'. See `glColorTable'.
-
-`GL_POST_COLOR_MATRIX_RED_BIAS'
-
-
- PARAMS returns one value, the red bias factor applied to RGBA
- fragments after color matrix transformations. The initial value is
- 0. See `glPixelTransfer'.
-
-`GL_POST_COLOR_MATRIX_GREEN_BIAS'
-
-
- PARAMS returns one value, the green bias factor applied to RGBA
- fragments after color matrix transformations. The initial value is
- 0. See `glPixelTransfer'
-
-`GL_POST_COLOR_MATRIX_BLUE_BIAS'
-
-
- PARAMS returns one value, the blue bias factor applied to RGBA
- fragments after color matrix transformations. The initial value is
- 0. See `glPixelTransfer'.
-
-`GL_POST_COLOR_MATRIX_ALPHA_BIAS'
-
-
- PARAMS returns one value, the alpha bias factor applied to RGBA
- fragments after color matrix transformations. The initial value is
- 0. See `glPixelTransfer'.
-
-`GL_POST_COLOR_MATRIX_RED_SCALE'
-
-
- PARAMS returns one value, the red scale factor applied to RGBA
- fragments after color matrix transformations. The initial value is
- 1. See `glPixelTransfer'.
-
-`GL_POST_COLOR_MATRIX_GREEN_SCALE'
-
-
- PARAMS returns one value, the green scale factor applied to RGBA
- fragments after color matrix transformations. The initial value is
- 1. See `glPixelTransfer'.
-
-`GL_POST_COLOR_MATRIX_BLUE_SCALE'
-
-
- PARAMS returns one value, the blue scale factor applied to RGBA
- fragments after color matrix transformations. The initial value is
- 1. See `glPixelTransfer'.
-
-`GL_POST_COLOR_MATRIX_ALPHA_SCALE'
-
-
- PARAMS returns one value, the alpha scale factor applied to RGBA
- fragments after color matrix transformations. The initial value is
- 1. See `glPixelTransfer'.
-
-`GL_POST_CONVOLUTION_COLOR_TABLE'
-
-
- PARAMS returns a single boolean value indicating whether post
- convolution lookup is enabled. The initial value is `GL_FALSE'. See
- `glColorTable'.
-
-`GL_POST_CONVOLUTION_RED_BIAS'
-
-
- PARAMS returns one value, the red bias factor applied to RGBA
- fragments after convolution. The initial value is 0. See
- `glPixelTransfer'.
-
-`GL_POST_CONVOLUTION_GREEN_BIAS'
-
-
- PARAMS returns one value, the green bias factor applied to RGBA
- fragments after convolution. The initial value is 0. See
- `glPixelTransfer'.
-
-`GL_POST_CONVOLUTION_BLUE_BIAS'
-
-
- PARAMS returns one value, the blue bias factor applied to RGBA
- fragments after convolution. The initial value is 0. See
- `glPixelTransfer'.
-
-`GL_POST_CONVOLUTION_ALPHA_BIAS'
-
-
- PARAMS returns one value, the alpha bias factor applied to RGBA
- fragments after convolution. The initial value is 0. See
- `glPixelTransfer'.
-
-`GL_POST_CONVOLUTION_RED_SCALE'
-
-
- PARAMS returns one value, the red scale factor applied to RGBA
- fragments after convolution. The initial value is 1. See
- `glPixelTransfer'.
-
-`GL_POST_CONVOLUTION_GREEN_SCALE'
-
-
- PARAMS returns one value, the green scale factor applied to RGBA
- fragments after convolution. The initial value is 1. See
- `glPixelTransfer'.
-
-`GL_POST_CONVOLUTION_BLUE_SCALE'
-
-
- PARAMS returns one value, the blue scale factor applied to RGBA
- fragments after convolution. The initial value is 1. See
- `glPixelTransfer'.
-
-`GL_POST_CONVOLUTION_ALPHA_SCALE'
-
-
- PARAMS returns one value, the alpha scale factor applied to RGBA
- fragments after convolution. The initial value is 1. See
- `glPixelTransfer'.
-
-`GL_PROJECTION_MATRIX'
-
-
- PARAMS returns sixteen values: the projection matrix on the top of
- the projection matrix stack. Initially this matrix is the identity
- matrix. See `glPushMatrix'.
-
-`GL_PROJECTION_STACK_DEPTH'
-
-
- PARAMS returns one value, the number of matrices on the projection
- matrix stack. The initial value is 1. See `glPushMatrix'.
-
-`GL_READ_BUFFER'
-
-
- PARAMS returns one value, a symbolic constant indicating which
- color buffer is selected for reading. The initial value is
- `GL_BACK' if there is a back buffer, otherwise it is `GL_FRONT'.
- See `glReadPixels' and `glAccum'.
-
-`GL_RED_BIAS'
-
-
- PARAMS returns one value, the red bias factor used during pixel
- transfers. The initial value is 0.
-
-`GL_RED_BITS'
-
-
- PARAMS returns one value, the number of red bitplanes in each color
- buffer.
-
-`GL_RED_SCALE'
-
-
- PARAMS returns one value, the red scale factor used during pixel
- transfers. The initial value is 1. See `glPixelTransfer'.
-
-`GL_RENDER_MODE'
-
-
- PARAMS returns one value, a symbolic constant indicating whether
- the GL is in render, select, or feedback mode. The initial value is
- `GL_RENDER'. See `glRenderMode'.
-
-`GL_RESCALE_NORMAL'
-
-
- PARAMS returns single boolean value indicating whether normal
- rescaling is enabled. See `glEnable'.
-
-`GL_RGBA_MODE'
-
-
- PARAMS returns a single boolean value indicating whether the GL is
- in RGBA mode (true) or color index mode (false). See `glColor'.
-
-`GL_SAMPLE_BUFFERS'
-
-
- PARAMS returns a single integer value indicating the number of
- sample buffers associated with the framebuffer. See
- `glSampleCoverage'.
-
-`GL_SAMPLE_COVERAGE_VALUE'
-
-
- PARAMS returns a single positive floating-point value indicating
- the current sample coverage value. See `glSampleCoverage'.
-
-`GL_SAMPLE_COVERAGE_INVERT'
-
-
- PARAMS returns a single boolean value indicating if the temporary
- coverage value should be inverted. See `glSampleCoverage'.
-
-`GL_SAMPLES'
-
-
- PARAMS returns a single integer value indicating the coverage mask
- size. See `glSampleCoverage'.
-
-`GL_SCISSOR_BOX'
-
-
- PARAMS returns four values: the X and Y window coordinates of the
- scissor box, followed by its width and height. Initially the X and
- Y window coordinates are both 0 and the width and height are set to
- the size of the window. See `glScissor'.
-
-`GL_SCISSOR_TEST'
-
-
- PARAMS returns a single boolean value indicating whether scissoring
- is enabled. The initial value is `GL_FALSE'. See `glScissor'.
-
-`GL_SECONDARY_COLOR_ARRAY'
-
-
- PARAMS returns a single boolean value indicating whether the
- secondary color array is enabled. The initial value is `GL_FALSE'.
- See `glSecondaryColorPointer'.
-
-`GL_SECONDARY_COLOR_ARRAY_BUFFER_BINDING'
-
-
- PARAMS returns a single value, the name of the buffer object
- associated with the secondary color array. This buffer object would
- have been bound to the target `GL_ARRAY_BUFFER' at the time of the
- most recent call to `glSecondaryColorPointer'. If no buffer object
- was bound to this target, 0 is returned. The initial value is 0.
- See `glBindBuffer'.
-
-`GL_SECONDARY_COLOR_ARRAY_SIZE'
-
-
- PARAMS returns one value, the number of components per color in the
- secondary color array. The initial value is 3. See
- `glSecondaryColorPointer'.
-
-`GL_SECONDARY_COLOR_ARRAY_STRIDE'
-
-
- PARAMS returns one value, the byte offset between consecutive
- colors in the secondary color array. The initial value is 0. See
- `glSecondaryColorPointer'.
-
-`GL_SECONDARY_COLOR_ARRAY_TYPE'
-
-
- PARAMS returns one value, the data type of each component in the
- secondary color array. The initial value is `GL_FLOAT'. See
- `glSecondaryColorPointer'.
-
-`GL_SELECTION_BUFFER_SIZE'
-
-
- PARAMS return one value, the size of the selection buffer. See
- `glSelectBuffer'.
-
-`GL_SEPARABLE_2D'
-
-
- PARAMS returns a single boolean value indicating whether 2D
- separable convolution is enabled. The initial value is `GL_FALSE'.
- See `glSeparableFilter2D'.
-
-`GL_SHADE_MODEL'
-
-
- PARAMS returns one value, a symbolic constant indicating whether
- the shading mode is flat or smooth. The initial value is
- `GL_SMOOTH'. See `glShadeModel'.
-
-`GL_SMOOTH_LINE_WIDTH_RANGE'
-
-
- PARAMS returns two values, the smallest and largest supported
- widths for antialiased lines. See `glLineWidth'.
-
-`GL_SMOOTH_LINE_WIDTH_GRANULARITY'
-
-
- PARAMS returns one value, the granularity of widths for antialiased
- lines. See `glLineWidth'.
-
-`GL_SMOOTH_POINT_SIZE_RANGE'
-
-
- PARAMS returns two values, the smallest and largest supported
- widths for antialiased points. See `glPointSize'.
-
-`GL_SMOOTH_POINT_SIZE_GRANULARITY'
-
-
- PARAMS returns one value, the granularity of sizes for antialiased
- points. See `glPointSize'.
-
-`GL_STENCIL_BACK_FAIL'
-
-
- PARAMS returns one value, a symbolic constant indicating what
- action is taken for back-facing polygons when the stencil test
- fails. The initial value is `GL_KEEP'. See `glStencilOpSeparate'.
-
-`GL_STENCIL_BACK_FUNC'
-
-
- PARAMS returns one value, a symbolic constant indicating what
- function is used for back-facing polygons to compare the stencil
- reference value with the stencil buffer value. The initial value is
- `GL_ALWAYS'. See `glStencilFuncSeparate'.
-
-`GL_STENCIL_BACK_PASS_DEPTH_FAIL'
-
-
- PARAMS returns one value, a symbolic constant indicating what
- action is taken for back-facing polygons when the stencil test
- passes, but the depth test fails. The initial value is `GL_KEEP'.
- See `glStencilOpSeparate'.
-
-`GL_STENCIL_BACK_PASS_DEPTH_PASS'
-
-
- PARAMS returns one value, a symbolic constant indicating what
- action is taken for back-facing polygons when the stencil test
- passes and the depth test passes. The initial value is `GL_KEEP'.
- See `glStencilOpSeparate'.
-
-`GL_STENCIL_BACK_REF'
-
-
- PARAMS returns one value, the reference value that is compared with
- the contents of the stencil buffer for back-facing polygons. The
- initial value is 0. See `glStencilFuncSeparate'.
-
-`GL_STENCIL_BACK_VALUE_MASK'
-
-
- PARAMS returns one value, the mask that is used for back-facing
- polygons to mask both the stencil reference value and the stencil
- buffer value before they are compared. The initial value is all
- 1's. See `glStencilFuncSeparate'.
-
-`GL_STENCIL_BACK_WRITEMASK'
-
-
- PARAMS returns one value, the mask that controls writing of the
- stencil bitplanes for back-facing polygons. The initial value is
- all 1's. See `glStencilMaskSeparate'.
-
-`GL_STENCIL_BITS'
-
-
- PARAMS returns one value, the number of bitplanes in the stencil
- buffer.
-
-`GL_STENCIL_CLEAR_VALUE'
-
-
- PARAMS returns one value, the index to which the stencil bitplanes
- are cleared. The initial value is 0. See `glClearStencil'.
-
-`GL_STENCIL_FAIL'
-
-
- PARAMS returns one value, a symbolic constant indicating what
- action is taken when the stencil test fails. The initial value is
- `GL_KEEP'. See `glStencilOp'. If the GL version is 2.0 or greater,
- this stencil state only affects non-polygons and front-facing
- polygons. Back-facing polygons use separate stencil state. See
- `glStencilOpSeparate'.
-
-`GL_STENCIL_FUNC'
-
-
- PARAMS returns one value, a symbolic constant indicating what
- function is used to compare the stencil reference value with the
- stencil buffer value. The initial value is `GL_ALWAYS'. See
- `glStencilFunc'. If the GL version is 2.0 or greater, this stencil
- state only affects non-polygons and front-facing polygons.
- Back-facing polygons use separate stencil state. See
- `glStencilFuncSeparate'.
-
-`GL_STENCIL_PASS_DEPTH_FAIL'
-
-
- PARAMS returns one value, a symbolic constant indicating what
- action is taken when the stencil test passes, but the depth test
- fails. The initial value is `GL_KEEP'. See `glStencilOp'. If the GL
- version is 2.0 or greater, this stencil state only affects
- non-polygons and front-facing polygons. Back-facing polygons use
- separate stencil state. See `glStencilOpSeparate'.
-
-`GL_STENCIL_PASS_DEPTH_PASS'
-
-
- PARAMS returns one value, a symbolic constant indicating what
- action is taken when the stencil test passes and the depth test
- passes. The initial value is `GL_KEEP'. See `glStencilOp'. If the
- GL version is 2.0 or greater, this stencil state only affects
- non-polygons and front-facing polygons. Back-facing polygons use
- separate stencil state. See `glStencilOpSeparate'.
-
-`GL_STENCIL_REF'
-
-
- PARAMS returns one value, the reference value that is compared with
- the contents of the stencil buffer. The initial value is 0. See
- `glStencilFunc'. If the GL version is 2.0 or greater, this stencil
- state only affects non-polygons and front-facing polygons.
- Back-facing polygons use separate stencil state. See
- `glStencilFuncSeparate'.
-
-`GL_STENCIL_TEST'
-
-
- PARAMS returns a single boolean value indicating whether stencil
- testing of fragments is enabled. The initial value is `GL_FALSE'.
- See `glStencilFunc' and `glStencilOp'.
-
-`GL_STENCIL_VALUE_MASK'
-
-
- PARAMS returns one value, the mask that is used to mask both the
- stencil reference value and the stencil buffer value before they
- are compared. The initial value is all 1's. See `glStencilFunc'. If
- the GL version is 2.0 or greater, this stencil state only affects
- non-polygons and front-facing polygons. Back-facing polygons use
- separate stencil state. See `glStencilFuncSeparate'.
-
-`GL_STENCIL_WRITEMASK'
-
-
- PARAMS returns one value, the mask that controls writing of the
- stencil bitplanes. The initial value is all 1's. See
- `glStencilMask'. If the GL version is 2.0 or greater, this stencil
- state only affects non-polygons and front-facing polygons.
- Back-facing polygons use separate stencil state. See
- `glStencilMaskSeparate'.
-
-`GL_STEREO'
-
-
- PARAMS returns a single boolean value indicating whether stereo
- buffers (left and right) are supported.
-
-`GL_SUBPIXEL_BITS'
-
-
- PARAMS returns one value, an estimate of the number of bits of
- subpixel resolution that are used to position rasterized geometry
- in window coordinates. The value must be at least 4.
-
-`GL_TEXTURE_1D'
-
-
- PARAMS returns a single boolean value indicating whether 1D texture
- mapping is enabled. The initial value is `GL_FALSE'. See
- `glTexImage1D'.
-
-`GL_TEXTURE_BINDING_1D'
-
-
- PARAMS returns a single value, the name of the texture currently
- bound to the target `GL_TEXTURE_1D'. The initial value is 0. See
- `glBindTexture'.
-
-`GL_TEXTURE_2D'
-
-
- PARAMS returns a single boolean value indicating whether 2D texture
- mapping is enabled. The initial value is `GL_FALSE'. See
- `glTexImage2D'.
-
-`GL_TEXTURE_BINDING_2D'
-
-
- PARAMS returns a single value, the name of the texture currently
- bound to the target `GL_TEXTURE_2D'. The initial value is 0. See
- `glBindTexture'.
-
-`GL_TEXTURE_3D'
-
-
- PARAMS returns a single boolean value indicating whether 3D texture
- mapping is enabled. The initial value is `GL_FALSE'. See
- `glTexImage3D'.
-
-`GL_TEXTURE_BINDING_3D'
-
-
- PARAMS returns a single value, the name of the texture currently
- bound to the target `GL_TEXTURE_3D'. The initial value is 0. See
- `glBindTexture'.
-
-`GL_TEXTURE_BINDING_CUBE_MAP'
-
-
- PARAMS returns a single value, the name of the texture currently
- bound to the target `GL_TEXTURE_CUBE_MAP'. The initial value is 0.
- See `glBindTexture'.
-
-`GL_TEXTURE_COMPRESSION_HINT'
-
-
- PARAMS returns a single value indicating the mode of the texture
- compression hint. The initial value is `GL_DONT_CARE'.
-
-`GL_TEXTURE_COORD_ARRAY'
-
-
- PARAMS returns a single boolean value indicating whether the
- texture coordinate array is enabled. The initial value is
- `GL_FALSE'. See `glTexCoordPointer'.
-
-`GL_TEXTURE_COORD_ARRAY_BUFFER_BINDING'
-
-
- PARAMS returns a single value, the name of the buffer object
- associated with the texture coordinate array. This buffer object
- would have been bound to the target `GL_ARRAY_BUFFER' at the time
- of the most recent call to `glTexCoordPointer'. If no buffer object
- was bound to this target, 0 is returned. The initial value is 0.
- See `glBindBuffer'.
-
-`GL_TEXTURE_COORD_ARRAY_SIZE'
-
-
- PARAMS returns one value, the number of coordinates per element in
- the texture coordinate array. The initial value is 4. See
- `glTexCoordPointer'.
-
-`GL_TEXTURE_COORD_ARRAY_STRIDE'
-
-
- PARAMS returns one value, the byte offset between consecutive
- elements in the texture coordinate array. The initial value is 0.
- See `glTexCoordPointer'.
-
-`GL_TEXTURE_COORD_ARRAY_TYPE'
-
-
- PARAMS returns one value, the data type of the coordinates in the
- texture coordinate array. The initial value is `GL_FLOAT'. See
- `glTexCoordPointer'.
-
-`GL_TEXTURE_CUBE_MAP'
-
-
- PARAMS returns a single boolean value indicating whether
- cube-mapped texture mapping is enabled. The initial value is
- `GL_FALSE'. See `glTexImage2D'.
-
-`GL_TEXTURE_GEN_Q'
-
-
- PARAMS returns a single boolean value indicating whether automatic
- generation of the Q texture coordinate is enabled. The initial
- value is `GL_FALSE'. See `glTexGen'.
-
-`GL_TEXTURE_GEN_R'
-
-
- PARAMS returns a single boolean value indicating whether automatic
- generation of the R texture coordinate is enabled. The initial
- value is `GL_FALSE'. See `glTexGen'.
-
-`GL_TEXTURE_GEN_S'
-
-
- PARAMS returns a single boolean value indicating whether automatic
- generation of the S texture coordinate is enabled. The initial
- value is `GL_FALSE'. See `glTexGen'.
-
-`GL_TEXTURE_GEN_T'
-
-
- PARAMS returns a single boolean value indicating whether automatic
- generation of the T texture coordinate is enabled. The initial
- value is `GL_FALSE'. See `glTexGen'.
-
-`GL_TEXTURE_MATRIX'
-
-
- PARAMS returns sixteen values: the texture matrix on the top of the
- texture matrix stack. Initially this matrix is the identity matrix.
- See `glPushMatrix'.
-
-`GL_TEXTURE_STACK_DEPTH'
-
-
- PARAMS returns one value, the number of matrices on the texture
- matrix stack. The initial value is 1. See `glPushMatrix'.
-
-`GL_TRANSPOSE_COLOR_MATRIX'
-
-
- PARAMS returns 16 values, the elements of the color matrix in
- row-major order. See `glLoadTransposeMatrix'.
-
-`GL_TRANSPOSE_MODELVIEW_MATRIX'
-
-
- PARAMS returns 16 values, the elements of the modelview matrix in
- row-major order. See `glLoadTransposeMatrix'.
-
-`GL_TRANSPOSE_PROJECTION_MATRIX'
-
-
- PARAMS returns 16 values, the elements of the projection matrix in
- row-major order. See `glLoadTransposeMatrix'.
-
-`GL_TRANSPOSE_TEXTURE_MATRIX'
-
-
- PARAMS returns 16 values, the elements of the texture matrix in
- row-major order. See `glLoadTransposeMatrix'.
-
-`GL_UNPACK_ALIGNMENT'
-
-
- PARAMS returns one value, the byte alignment used for reading pixel
- data from memory. The initial value is 4. See `glPixelStore'.
-
-`GL_UNPACK_IMAGE_HEIGHT'
-
-
- PARAMS returns one value, the image height used for reading pixel
- data from memory. The initial is 0. See `glPixelStore'.
-
-`GL_UNPACK_LSB_FIRST'
-
-
- PARAMS returns a single boolean value indicating whether single-bit
- pixels being read from memory are read first from the least
- significant bit of each unsigned byte. The initial value is
- `GL_FALSE'. See `glPixelStore'.
-
-`GL_UNPACK_ROW_LENGTH'
-
-
- PARAMS returns one value, the row length used for reading pixel
- data from memory. The initial value is 0. See `glPixelStore'.
-
-`GL_UNPACK_SKIP_IMAGES'
-
-
- PARAMS returns one value, the number of pixel images skipped before
- the first pixel is read from memory. The initial value is 0. See
- `glPixelStore'.
-
-`GL_UNPACK_SKIP_PIXELS'
-
-
- PARAMS returns one value, the number of pixel locations skipped
- before the first pixel is read from memory. The initial value is 0.
- See `glPixelStore'.
-
-`GL_UNPACK_SKIP_ROWS'
-
-
- PARAMS returns one value, the number of rows of pixel locations
- skipped before the first pixel is read from memory. The initial
- value is 0. See `glPixelStore'.
-
-`GL_UNPACK_SWAP_BYTES'
-
-
- PARAMS returns a single boolean value indicating whether the bytes
- of two-byte and four-byte pixel indices and components are swapped
- after being read from memory. The initial value is `GL_FALSE'. See
- `glPixelStore'.
-
-`GL_VERTEX_ARRAY'
-
-
- PARAMS returns a single boolean value indicating whether the vertex
- array is enabled. The initial value is `GL_FALSE'. See
- `glVertexPointer'.
-
-`GL_VERTEX_ARRAY_BUFFER_BINDING'
-
-
- PARAMS returns a single value, the name of the buffer object
- associated with the vertex array. This buffer object would have
- been bound to the target `GL_ARRAY_BUFFER' at the time of the most
- recent call to `glVertexPointer'. If no buffer object was bound to
- this target, 0 is returned. The initial value is 0. See
- `glBindBuffer'.
-
-`GL_VERTEX_ARRAY_SIZE'
-
-
- PARAMS returns one value, the number of coordinates per vertex in
- the vertex array. The initial value is 4. See `glVertexPointer'.
-
-`GL_VERTEX_ARRAY_STRIDE'
-
-
- PARAMS returns one value, the byte offset between consecutive
- vertices in the vertex array. The initial value is 0. See
- `glVertexPointer'.
-
-`GL_VERTEX_ARRAY_TYPE'
-
-
- PARAMS returns one value, the data type of each coordinate in the
- vertex array. The initial value is `GL_FLOAT'. See
- `glVertexPointer'.
-
-`GL_VERTEX_PROGRAM_POINT_SIZE'
-
-
- PARAMS returns a single boolean value indicating whether vertex
- program point size mode is enabled. If enabled, and a vertex shader
- is active, then the point size is taken from the shader built-in
- `gl_PointSize'. If disabled, and a vertex shader is active, then
- the point size is taken from the point state as specified by
- `glPointSize'. The initial value is `GL_FALSE'.
-
-`GL_VERTEX_PROGRAM_TWO_SIDE'
-
-
- PARAMS returns a single boolean value indicating whether vertex
- program two-sided color mode is enabled. If enabled, and a vertex
- shader is active, then the GL chooses the back color output for
- back-facing polygons, and the front color output for non-polygons
- and front-facing polygons. If disabled, and a vertex shader is
- active, then the front color output is always selected. The initial
- value is `GL_FALSE'.
-
-`GL_VIEWPORT'
-
-
- PARAMS returns four values: the X and Y window coordinates of the
- viewport, followed by its width and height. Initially the X and Y
- window coordinates are both set to 0, and the width and height are
- set to the width and height of the window into which the GL will do
- its rendering. See `glViewport'.
-
-`GL_ZOOM_X'
-
-
- PARAMS returns one value, the X pixel zoom factor. The initial
- value is 1. See `glPixelZoom'.
-
-`GL_ZOOM_Y'
-
-
- PARAMS returns one value, the Y pixel zoom factor. The initial
- value is 1. See `glPixelZoom'.
-
-Many of the boolean parameters can also be queried more easily using
-`glIsEnabled'.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if PNAME is not an accepted value.
-
-`GL_INVALID_OPERATION' is generated if `glGet' is executed between the
-execution of `glBegin' and the corresponding execution of `glEnd'.")
-
-(define-gl-procedure
- glHint
- "glHint"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glHint"))
- (paramdef "GLenum " (parameter "target"))
- (paramdef "GLenum " (parameter "mode"))))
- "specify implementation-specific hints
-=====================================
-
-
-Parameters
-==========
-
-TARGET
- Specifies a symbolic constant indicating the behavior to be
- controlled. `GL_FOG_HINT', `GL_GENERATE_MIPMAP_HINT',
- `GL_LINE_SMOOTH_HINT', `GL_PERSPECTIVE_CORRECTION_HINT',
- `GL_POINT_SMOOTH_HINT', `GL_POLYGON_SMOOTH_HINT',
- `GL_TEXTURE_COMPRESSION_HINT', and
- `GL_FRAGMENT_SHADER_DERIVATIVE_HINT' are accepted.
-
-MODE
- Specifies a symbolic constant indicating the desired behavior.
- `GL_FASTEST', `GL_NICEST', and `GL_DONT_CARE' are accepted.
-
-
-Description
-===========
-
-Certain aspects of GL behavior, when there is room for interpretation,
-can be controlled with hints. A hint is specified with two arguments.
-TARGET is a symbolic constant indicating the behavior to be controlled,
-and MODE is another symbolic constant indicating the desired behavior.
-The initial value for each TARGET is `GL_DONT_CARE'. MODE can be one of
-the following:
-
-`GL_FASTEST'
-
-
- The most efficient option should be chosen.
-
-`GL_NICEST'
-
-
- The most correct, or highest quality, option should be chosen.
-
-`GL_DONT_CARE'
-
-
- No preference.
-
-Though the implementation aspects that can be hinted are well defined,
-the interpretation of the hints depends on the implementation. The hint
-aspects that can be specified with TARGET, along with suggested
-semantics, are as follows:
-
-`GL_FOG_HINT'
-
-
- Indicates the accuracy of fog calculation. If per-pixel fog
- calculation is not efficiently supported by the GL implementation,
- hinting `GL_DONT_CARE' or `GL_FASTEST' can result in per-vertex
- calculation of fog effects.
-
-`GL_FRAGMENT_SHADER_DERIVATIVE_HINT'
-
-
- Indicates the accuracy of the derivative calculation for the GL
- shading language fragment processing built-in functions: `dFdx',
- `dFdy', and `fwidth'.
-
-`GL_GENERATE_MIPMAP_HINT'
-
-
- Indicates the quality of filtering when generating mipmap images.
-
-`GL_LINE_SMOOTH_HINT'
-
-
- Indicates the sampling quality of antialiased lines. If a larger
- filter function is applied, hinting `GL_NICEST' can result in more
- pixel fragments being generated during rasterization.
-
-`GL_PERSPECTIVE_CORRECTION_HINT'
-
-
- Indicates the quality of color, texture coordinate, and fog
- coordinate interpolation. If perspective-corrected parameter
- interpolation is not efficiently supported by the GL
- implementation, hinting `GL_DONT_CARE' or `GL_FASTEST' can result
- in simple linear interpolation of colors and/or texture
- coordinates.
-
-`GL_POINT_SMOOTH_HINT'
-
-
- Indicates the sampling quality of antialiased points. If a larger
- filter function is applied, hinting `GL_NICEST' can result in more
- pixel fragments being generated during rasterization.
-
-`GL_POLYGON_SMOOTH_HINT'
-
-
- Indicates the sampling quality of antialiased polygons. Hinting
- `GL_NICEST' can result in more pixel fragments being generated
- during rasterization, if a larger filter function is applied.
-
-`GL_TEXTURE_COMPRESSION_HINT'
-
-
- Indicates the quality and performance of the compressing texture
- images. Hinting `GL_FASTEST' indicates that texture images should
- be compressed as quickly as possible, while `GL_NICEST' indicates
- that texture images should be compressed with as little image
- quality loss as possible. `GL_NICEST' should be selected if the
- texture is to be retrieved by `glGetCompressedTexImage' for reuse.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if either TARGET or MODE is not an
-accepted value.
-
-`GL_INVALID_OPERATION' is generated if `glHint' is executed between the
-execution of `glBegin' and the corresponding execution of `glEnd'.")
-
-(define-gl-procedure
- glHistogram
- "glHistogram"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glHistogram"))
- (paramdef "GLenum " (parameter "target"))
- (paramdef "GLsizei " (parameter "width"))
- (paramdef "GLenum " (parameter "internalformat"))
- (paramdef "GLboolean " (parameter "sink"))))
- "define histogram table
-======================
-
-
-Parameters
-==========
-
-TARGET
- The histogram whose parameters are to be set. Must be one of
- `GL_HISTOGRAM' or `GL_PROXY_HISTOGRAM'.
-
-WIDTH
- The number of entries in the histogram table. Must be a power of 2.
-
-INTERNALFORMAT
- The format of entries in the histogram table. Must be one of
- `GL_ALPHA', `GL_ALPHA4', `GL_ALPHA8', `GL_ALPHA12', `GL_ALPHA16',
- `GL_LUMINANCE', `GL_LUMINANCE4', `GL_LUMINANCE8', `GL_LUMINANCE12',
- `GL_LUMINANCE16', `GL_LUMINANCE_ALPHA', `GL_LUMINANCE4_ALPHA4',
- `GL_LUMINANCE6_ALPHA2', `GL_LUMINANCE8_ALPHA8',
- `GL_LUMINANCE12_ALPHA4', `GL_LUMINANCE12_ALPHA12',
- `GL_LUMINANCE16_ALPHA16', `GL_R3_G3_B2', `GL_RGB', `GL_RGB4',
- `GL_RGB5', `GL_RGB8', `GL_RGB10', `GL_RGB12', `GL_RGB16',
- `GL_RGBA', `GL_RGBA2', `GL_RGBA4', `GL_RGB5_A1', `GL_RGBA8',
- `GL_RGB10_A2', `GL_RGBA12', or `GL_RGBA16'.
-
-SINK
- If `GL_TRUE', pixels will be consumed by the histogramming process
- and no drawing or texture loading will take place. If `GL_FALSE',
- pixels will proceed to the minmax process after histogramming.
-
-
-Description
-===========
-
-When `GL_HISTOGRAM' is enabled, RGBA color components are converted to
-histogram table indices by clamping to the range [0,1], multiplying by
-the width of the histogram table, and rounding to the nearest integer.
-The table entries selected by the RGBA indices are then incremented. (If
-the internal format of the histogram table includes luminance, then the
-index derived from the R color component determines the luminance table
-entry to be incremented.) If a histogram table entry is incremented
-beyond its maximum value, then its value becomes undefined. (This is not
-an error.)
-
-Histogramming is performed only for RGBA pixels (though these may be
-specified originally as color indices and converted to RGBA by index
-table lookup). Histogramming is enabled with `glEnable' and disabled
-with `glDisable'.
-
-When TARGET is `GL_HISTOGRAM', `glHistogram' redefines the current
-histogram table to have WIDTH entries of the format specified by
-INTERNALFORMAT. The entries are indexed 0 through WIDTH-1, and all
-entries are initialized to zero. The values in the previous histogram
-table, if any, are lost. If SINK is `GL_TRUE', then pixels are discarded
-after histogramming; no further processing of the pixels takes place,
-and no drawing, texture loading, or pixel readback will result.
-
-When TARGET is `GL_PROXY_HISTOGRAM', `glHistogram' computes all state
-information as if the histogram table were to be redefined, but does not
-actually define the new table. If the requested histogram table is too
-large to be supported, then the state information will be set to zero.
-This provides a way to determine if a histogram table with the given
-parameters can be supported.
-
-
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if TARGET is not one of the allowable
-values.
-
-`GL_INVALID_VALUE' is generated if WIDTH is less than zero or is not a
-power of 2.
-
-`GL_INVALID_ENUM' is generated if INTERNALFORMAT is not one of the
-allowable values.
-
-`GL_TABLE_TOO_LARGE' is generated if TARGET is `GL_HISTOGRAM' and the
-histogram table specified is too large for the implementation.
-
-`GL_INVALID_OPERATION' is generated if `glHistogram' is executed between
-the execution of `glBegin' and the corresponding execution of `glEnd'.")
-
-(define-gl-procedure
- glIndexMask
- "glIndexMask"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glIndexMask"))
- (paramdef "GLuint " (parameter "mask"))))
- "control the writing of individual bits in the color index buffers
-=================================================================
-
-
-Parameters
-==========
-
-MASK
- Specifies a bit mask to enable and disable the writing of
- individual bits in the color index buffers. Initially, the mask is
- all 1's.
-
-
-Description
-===========
-
-`glIndexMask' controls the writing of individual bits in the color index
-buffers. The least significant N bits of MASK, where N is the number of
-bits in a color index buffer, specify a mask. Where a 1 (one) appears in
-the mask, it's possible to write to the corresponding bit in the color
-index buffer (or buffers). Where a 0 (zero) appears, the corresponding
-bit is write-protected.
-
-This mask is used only in color index mode, and it affects only the
-buffers currently selected for writing (see `glDrawBuffer'). Initially,
-all bits are enabled for writing.
-
-
-Errors
-======
-
-`GL_INVALID_OPERATION' is generated if `glIndexMask' is executed between
-the execution of `glBegin' and the corresponding execution of `glEnd'.")
-
-(define-gl-procedure
- glIndexPointer
- "glIndexPointer"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glIndexPointer"))
- (paramdef "GLenum " (parameter "type"))
- (paramdef "GLsizei " (parameter "stride"))
- (paramdef
- "const GLvoid * "
- (parameter "pointer"))))
- "define an array of color indexes
-================================
-
-
-Parameters
-==========
-
-TYPE
- Specifies the data type of each color index in the array. Symbolic
- constants `GL_UNSIGNED_BYTE', `GL_SHORT', `GL_INT', `GL_FLOAT', and
- `GL_DOUBLE' are accepted. The initial value is `GL_FLOAT'.
-
-STRIDE
- Specifies the byte offset between consecutive color indexes. If
- STRIDE is 0, the color indexes are understood to be tightly packed
- in the array. The initial value is 0.
-
-POINTER
- Specifies a pointer to the first index in the array. The initial
- value is 0.
-
-
-Description
-===========
-
-`glIndexPointer' specifies the location and data format of an array of
-color indexes to use when rendering. TYPE specifies the data type of
-each color index and STRIDE specifies the byte stride from one color
-index to the next, allowing vertices and attributes to be packed into a
-single array or stored in separate arrays.
-
-If a non-zero named buffer object is bound to the `GL_ARRAY_BUFFER'
-target (see `glBindBuffer') while a color index array is specified,
-POINTER is treated as a byte offset into the buffer object's data store.
-Also, the buffer object binding (`GL_ARRAY_BUFFER_BINDING') is saved as
-color index vertex array client-side state
-(`GL_INDEX_ARRAY_BUFFER_BINDING').
-
-When a color index array is specified, TYPE, STRIDE, and POINTER are
-saved as client-side state, in addition to the current vertex array
-buffer object binding.
-
-To enable and disable the color index array, call `glEnableClientState'
-and `glDisableClientState' with the argument `GL_INDEX_ARRAY'. If
-enabled, the color index array is used when `glDrawArrays',
-`glMultiDrawArrays', `glDrawElements', `glMultiDrawElements',
-`glDrawRangeElements', or `glArrayElement' is called.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if TYPE is not an accepted value.
-
-`GL_INVALID_VALUE' is generated if STRIDE is negative.")
-
-(define-gl-procedure
- glIndex
- "glIndex"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glIndexs"))
- (paramdef "GLshort " (parameter "c"))))
- "set the current color index
-===========================
-
-
-Parameters
-==========
-
-C
- Specifies the new value for the current color index.
-
-
-
-
-Description
-===========
-
-`glIndex' updates the current (single-valued) color index. It takes one
-argument, the new value for the current color index.
-
-The current index is stored as a floating-point value. Integer values
-are converted directly to floating-point values, with no special
-mapping. The initial value is 1.
-
-Index values outside the representable range of the color index buffer
-are not clamped. However, before an index is dithered (if enabled) and
-written to the frame buffer, it is converted to fixed-point format. Any
-bits in the integer portion of the resulting fixed-point value that do
-not correspond to bits in the frame buffer are masked out.")
-
-(define-gl-procedure
- glInitNames
- "glInitNames"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glInitNames"))
- (paramdef (parameter "void"))))
- "initialize the name stack
-=========================
-
-
-Description
-===========
-
-The name stack is used during selection mode to allow sets of rendering
-commands to be uniquely identified. It consists of an ordered set of
-unsigned integers. `glInitNames' causes the name stack to be initialized
-to its default empty state.
-
-The name stack is always empty while the render mode is not `GL_SELECT'.
-Calls to `glInitNames' while the render mode is not `GL_SELECT' are
-ignored.
-
-
-Errors
-======
-
-`GL_INVALID_OPERATION' is generated if `glInitNames' is executed between
-the execution of `glBegin' and the corresponding execution of `glEnd'.")
-
-(define-gl-procedure
- glInterleavedArrays
- "glInterleavedArrays"
- (funcsynopsis
- (funcprototype
- (funcdef
- "void "
- (function "glInterleavedArrays"))
- (paramdef "GLenum " (parameter "format"))
- (paramdef "GLsizei " (parameter "stride"))
- (paramdef
- "const GLvoid * "
- (parameter "pointer"))))
- "simultaneously specify and enable several interleaved arrays
-============================================================
-
-
-Parameters
-==========
-
-FORMAT
- Specifies the type of array to enable. Symbolic constants `GL_V2F',
- `GL_V3F', `GL_C4UB_V2F', `GL_C4UB_V3F', `GL_C3F_V3F', `GL_N3F_V3F',
- `GL_C4F_N3F_V3F', `GL_T2F_V3F', `GL_T4F_V4F', `GL_T2F_C4UB_V3F',
- `GL_T2F_C3F_V3F', `GL_T2F_N3F_V3F', `GL_T2F_C4F_N3F_V3F', and
- `GL_T4F_C4F_N3F_V4F' are accepted.
-
-STRIDE
- Specifies the offset in bytes between each aggregate array element.
-
-
-Description
-===========
-
-`glInterleavedArrays' lets you specify and enable individual color,
-normal, texture and vertex arrays whose elements are part of a larger
-aggregate array element. For some implementations, this is more
-efficient than specifying the arrays separately.
-
-If STRIDE is 0, the aggregate elements are stored consecutively.
-Otherwise, STRIDE bytes occur between the beginning of one aggregate
-array element and the beginning of the next aggregate array element.
-
-FORMAT serves as a ``key'' describing the extraction of individual
-arrays from the aggregate array. If FORMAT contains a T, then texture
-coordinates are extracted from the interleaved array. If C is present,
-color values are extracted. If N is present, normal coordinates are
-extracted. Vertex coordinates are always extracted.
-
-The digits 2, 3, and 4 denote how many values are extracted. F indicates
-that values are extracted as floating-point values. Colors may also be
-extracted as 4 unsigned bytes if 4UB follows the C. If a color is
-extracted as 4 unsigned bytes, the vertex array element which follows is
-located at the first possible floating-point aligned address.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if FORMAT is not an accepted value.
-
-`GL_INVALID_VALUE' is generated if STRIDE is negative.")
-
-(define-gl-procedure
- glIsBuffer
- "glIsBuffer"
- (funcsynopsis
- (funcprototype
- (funcdef "GLboolean " (function "glIsBuffer"))
- (paramdef "GLuint " (parameter "buffer"))))
- "determine if a name corresponds to a buffer object
-==================================================
-
-
-Parameters
-==========
-
-BUFFER
- Specifies a value that may be the name of a buffer object.
-
-
-Description
-===========
-
-`glIsBuffer' returns `GL_TRUE' if BUFFER is currently the name of a
-buffer object. If BUFFER is zero, or is a non-zero value that is not
-currently the name of a buffer object, or if an error occurs,
-`glIsBuffer' returns `GL_FALSE'.
-
-A name returned by `glGenBuffers', but not yet associated with a buffer
-object by calling `glBindBuffer', is not the name of a buffer object.
-
-
-Errors
-======
-
-`GL_INVALID_OPERATION' is generated if `glIsBuffer' is executed between
-the execution of `glBegin' and the corresponding execution of `glEnd'.")
-
-(define-gl-procedure
- glIsEnabled
- "glIsEnabled"
- (funcsynopsis
- (funcprototype
- (funcdef "GLboolean " (function "glIsEnabled"))
- (paramdef "GLenum " (parameter "cap"))))
- "test whether a capability is enabled
-====================================
-
-
-Parameters
-==========
-
-CAP
- Specifies a symbolic constant indicating a GL capability.
-
-
-Description
-===========
-
-`glIsEnabled' returns `GL_TRUE' if CAP is an enabled capability and
-returns `GL_FALSE' otherwise. Initially all capabilities except
-`GL_DITHER' are disabled; `GL_DITHER' is initially enabled.
-
-The following capabilities are accepted for CAP:
-
-
-
-* Constant *
-*
-See *`GL_ALPHA_TEST'
-`glAlphaFunc'`GL_AUTO_NORMAL'
-`glEvalCoord'`GL_BLEND'
-`glBlendFunc', `glLogicOp'`GL_CLIP_PLANE'I
-`glClipPlane'`GL_COLOR_ARRAY'
-`glColorPointer'`GL_COLOR_LOGIC_OP'
-`glLogicOp'`GL_COLOR_MATERIAL'
-`glColorMaterial'`GL_COLOR_SUM'
-`glSecondaryColor'`GL_COLOR_TABLE'
-`glColorTable'`GL_CONVOLUTION_1D'
-`glConvolutionFilter1D'`GL_CONVOLUTION_2D'
-`glConvolutionFilter2D'`GL_CULL_FACE'
-`glCullFace'`GL_DEPTH_TEST'
-`glDepthFunc', `glDepthRange'`GL_DITHER'
-`glEnable'`GL_EDGE_FLAG_ARRAY'
-`glEdgeFlagPointer'`GL_FOG'
-`glFog'`GL_FOG_COORD_ARRAY'
-`glFogCoordPointer'`GL_HISTOGRAM'
-`glHistogram'`GL_INDEX_ARRAY'
-`glIndexPointer'`GL_INDEX_LOGIC_OP'
-`glLogicOp'`GL_LIGHT'I
-`glLightModel', `glLight'`GL_LIGHTING'
-`glMaterial', `glLightModel', `glLight'`GL_LINE_SMOOTH'
-`glLineWidth'`GL_LINE_STIPPLE'
-`glLineStipple'`GL_MAP1_COLOR_4'
-`glMap1'`GL_MAP1_INDEX'
-`glMap1'`GL_MAP1_NORMAL'
-`glMap1'`GL_MAP1_TEXTURE_COORD_1'
-`glMap1'`GL_MAP1_TEXTURE_COORD_2'
-`glMap1'`GL_MAP1_TEXTURE_COORD_3'
-`glMap1'`GL_MAP1_TEXTURE_COORD_4'
-`glMap1'`GL_MAP2_COLOR_4'
-`glMap2'`GL_MAP2_INDEX'
-`glMap2'`GL_MAP2_NORMAL'
-`glMap2'`GL_MAP2_TEXTURE_COORD_1'
-`glMap2'`GL_MAP2_TEXTURE_COORD_2'
-`glMap2'`GL_MAP2_TEXTURE_COORD_3'
-`glMap2'`GL_MAP2_TEXTURE_COORD_4'
-`glMap2'`GL_MAP2_VERTEX_3'
-`glMap2'`GL_MAP2_VERTEX_4'
-`glMap2'`GL_MINMAX'
-`glMinmax'`GL_MULTISAMPLE'
-`glSampleCoverage'`GL_NORMAL_ARRAY'
-`glNormalPointer'`GL_NORMALIZE'
-`glNormal'`GL_POINT_SMOOTH'
-`glPointSize'`GL_POINT_SPRITE'
-`glEnable'`GL_POLYGON_SMOOTH'
-`glPolygonMode'`GL_POLYGON_OFFSET_FILL'
-`glPolygonOffset'`GL_POLYGON_OFFSET_LINE'
-`glPolygonOffset'`GL_POLYGON_OFFSET_POINT'
-`glPolygonOffset'`GL_POLYGON_STIPPLE'
-`glPolygonStipple'`GL_POST_COLOR_MATRIX_COLOR_TABLE'
-`glColorTable'`GL_POST_CONVOLUTION_COLOR_TABLE'
-`glColorTable'`GL_RESCALE_NORMAL'
-`glNormal'`GL_SAMPLE_ALPHA_TO_COVERAGE'
-`glSampleCoverage'`GL_SAMPLE_ALPHA_TO_ONE'
-`glSampleCoverage'`GL_SAMPLE_COVERAGE'
-`glSampleCoverage'`GL_SCISSOR_TEST'
-`glScissor'`GL_SECONDARY_COLOR_ARRAY'
-`glSecondaryColorPointer'`GL_SEPARABLE_2D'
-`glSeparableFilter2D'`GL_STENCIL_TEST'
-`glStencilFunc', `glStencilOp'`GL_TEXTURE_1D'
-`glTexImage1D'`GL_TEXTURE_2D'
-`glTexImage2D'`GL_TEXTURE_3D'
-`glTexImage3D'`GL_TEXTURE_COORD_ARRAY'
-`glTexCoordPointer'`GL_TEXTURE_CUBE_MAP'
-`glTexImage2D'`GL_TEXTURE_GEN_Q'
-`glTexGen'`GL_TEXTURE_GEN_R'
-`glTexGen'`GL_TEXTURE_GEN_S'
-`glTexGen'`GL_TEXTURE_GEN_T'
-`glTexGen'`GL_VERTEX_ARRAY'
-`glVertexPointer'`GL_VERTEX_PROGRAM_POINT_SIZE'
-`glEnable'`GL_VERTEX_PROGRAM_TWO_SIDE'
-`glEnable'
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if CAP is not an accepted value.
-
-`GL_INVALID_OPERATION' is generated if `glIsEnabled' is executed between
-the execution of `glBegin' and the corresponding execution of `glEnd'.")
-
-(define-gl-procedure
- glIsList
- "glIsList"
- (funcsynopsis
- (funcprototype
- (funcdef "GLboolean " (function "glIsList"))
- (paramdef "GLuint " (parameter "list"))))
- "determine if a name corresponds to a display list
-=================================================
-
-
-Parameters
-==========
-
-LIST
- Specifies a potential display list name.
-
-
-Description
-===========
-
-`glIsList' returns `GL_TRUE' if LIST is the name of a display list and
-returns `GL_FALSE' if it is not, or if an error occurs.
-
-A name returned by `glGenLists', but not yet associated with a display
-list by calling `glNewList', is not the name of a display list.
-
-
-Errors
-======
-
-`GL_INVALID_OPERATION' is generated if `glIsList' is executed between
-the execution of `glBegin' and the corresponding execution of `glEnd'.")
-
-(define-gl-procedure
- glIsProgram
- "glIsProgram"
- (funcsynopsis
- (funcprototype
- (funcdef "GLboolean " (function "glIsProgram"))
- (paramdef "GLuint " (parameter "program"))))
- "Determines if a name corresponds to a program object
-====================================================
-
-
-Parameters
-==========
-
-PROGRAM
- Specifies a potential program object.
-
-
-Description
-===========
-
-`glIsProgram' returns `GL_TRUE' if PROGRAM is the name of a program
-object previously created with `glCreateProgram' and not yet deleted
-with `glDeleteProgram'. If PROGRAM is zero or a non-zero value that is
-not the name of a program object, or if an error occurs, `glIsProgram'
-returns `GL_FALSE'.
-
-
-Errors
-======
-
-`GL_INVALID_OPERATION' is generated if `glIsProgram' is executed between
-the execution of `glBegin' and the corresponding execution of `glEnd'.")
-
-(define-gl-procedure
- glIsQuery
- "glIsQuery"
- (funcsynopsis
- (funcprototype
- (funcdef "GLboolean " (function "glIsQuery"))
- (paramdef "GLuint " (parameter "id"))))
- "determine if a name corresponds to a query object
-=================================================
-
-
-Parameters
-==========
-
-ID
- Specifies a value that may be the name of a query object.
-
-
-Description
-===========
-
-`glIsQuery' returns `GL_TRUE' if ID is currently the name of a query
-object. If ID is zero, or is a non-zero value that is not currently the
-name of a query object, or if an error occurs, `glIsQuery' returns
-`GL_FALSE'.
-
-A name returned by `glGenQueries', but not yet associated with a query
-object by calling `glBeginQuery', is not the name of a query object.
-
-
-Errors
-======
-
-`GL_INVALID_OPERATION' is generated if `glIsQuery' is executed between
-the execution of `glBegin' and the corresponding execution of `glEnd'.")
-
-(define-gl-procedure
- glIsShader
- "glIsShader"
- (funcsynopsis
- (funcprototype
- (funcdef "GLboolean " (function "glIsShader"))
- (paramdef "GLuint " (parameter "shader"))))
- "Determines if a name corresponds to a shader object
-===================================================
-
-
-Parameters
-==========
-
-SHADER
- Specifies a potential shader object.
-
-
-Description
-===========
-
-`glIsShader' returns `GL_TRUE' if SHADER is the name of a shader object
-previously created with `glCreateShader' and not yet deleted with
-`glDeleteShader'. If SHADER is zero or a non-zero value that is not the
-name of a shader object, or if an error occurs, `glIsShader ' returns
-`GL_FALSE'.
-
-
-Errors
-======
-
-`GL_INVALID_OPERATION' is generated if `glIsShader' is executed between
-the execution of `glBegin' and the corresponding execution of `glEnd'.")
-
-(define-gl-procedure
- glIsTexture
- "glIsTexture"
- (funcsynopsis
- (funcprototype
- (funcdef "GLboolean " (function "glIsTexture"))
- (paramdef "GLuint " (parameter "texture"))))
- "determine if a name corresponds to a texture
-============================================
-
-
-Parameters
-==========
-
-TEXTURE
- Specifies a value that may be the name of a texture.
-
-
-Description
-===========
-
-`glIsTexture' returns `GL_TRUE' if TEXTURE is currently the name of a
-texture. If TEXTURE is zero, or is a non-zero value that is not
-currently the name of a texture, or if an error occurs, `glIsTexture'
-returns `GL_FALSE'.
-
-A name returned by `glGenTextures', but not yet associated with a
-texture by calling `glBindTexture', is not the name of a texture.
-
-
-Errors
-======
-
-`GL_INVALID_OPERATION' is generated if `glIsTexture' is executed between
-the execution of `glBegin' and the corresponding execution of `glEnd'.")
-
-(define-gl-procedure
- glLightModel
- "glLightModel"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glLightModelf"))
- (paramdef "GLenum " (parameter "pname"))
- (paramdef "GLfloat " (parameter "param"))))
- "set the lighting model parameters
-=================================
-
-
-Parameters
-==========
-
-PNAME
- Specifies a single-valued lighting model parameter.
- `GL_LIGHT_MODEL_LOCAL_VIEWER', `GL_LIGHT_MODEL_COLOR_CONTROL', and
- `GL_LIGHT_MODEL_TWO_SIDE' are accepted.
-
-PARAM
- Specifies the value that PARAM will be set to.
-
-
-Description
-===========
-
-`glLightModel' sets the lighting model parameter. PNAME names a
-parameter and PARAMS gives the new value. There are three lighting model
-parameters:
-
-`GL_LIGHT_MODEL_AMBIENT'
-
-
- PARAMS contains four integer or floating-point values that specify
- the ambient RGBA intensity of the entire scene. Integer values are
- mapped linearly such that the most positive representable value
- maps to 1.0, and the most negative representable value maps to
- -1.0. Floating-point values are mapped directly. Neither integer
- nor floating-point values are clamped. The initial ambient scene
- intensity is (0.2, 0.2, 0.2, 1.0).
-
-`GL_LIGHT_MODEL_COLOR_CONTROL'
-
-
- PARAMS must be either `GL_SEPARATE_SPECULAR_COLOR' or
- `GL_SINGLE_COLOR'. `GL_SINGLE_COLOR' specifies that a single color
- is generated from the lighting computation for a vertex.
- `GL_SEPARATE_SPECULAR_COLOR' specifies that the specular color
- computation of lighting be stored separately from the remainder of
- the lighting computation. The specular color is summed into the
- generated fragment's color after the application of texture mapping
- (if enabled). The initial value is `GL_SINGLE_COLOR'.
-
-`GL_LIGHT_MODEL_LOCAL_VIEWER'
-
-
- PARAMS is a single integer or floating-point value that specifies
- how specular reflection angles are computed. If PARAMS is 0 (or
- 0.0), specular reflection angles take the view direction to be
- parallel to and in the direction of the -Z axis, regardless of the
- location of the vertex in eye coordinates. Otherwise, specular
- reflections are computed from the origin of the eye coordinate
- system. The initial value is 0.
-
-`GL_LIGHT_MODEL_TWO_SIDE'
-
-
- PARAMS is a single integer or floating-point value that specifies
- whether one- or two-sided lighting calculations are done for
- polygons. It has no effect on the lighting calculations for points,
- lines, or bitmaps. If PARAMS is 0 (or 0.0), one-sided lighting is
- specified, and only the FRONT material parameters are used in the
- lighting equation. Otherwise, two-sided lighting is specified. In
- this case, vertices of back-facing polygons are lighted using the
- BACK material parameters and have their normals reversed before the
- lighting equation is evaluated. Vertices of front-facing polygons
- are always lighted using the FRONT material parameters, with no
- change to their normals. The initial value is 0.
-
-In RGBA mode, the lighted color of a vertex is the sum of the material
-emission intensity, the product of the material ambient reflectance and
-the lighting model full-scene ambient intensity, and the contribution of
-each enabled light source. Each light source contributes the sum of
-three terms: ambient, diffuse, and specular. The ambient light source
-contribution is the product of the material ambient reflectance and the
-light's ambient intensity. The diffuse light source contribution is the
-product of the material diffuse reflectance, the light's diffuse
-intensity, and the dot product of the vertex's normal with the
-normalized vector from the vertex to the light source. The specular
-light source contribution is the product of the material specular
-reflectance, the light's specular intensity, and the dot product of the
-normalized vertex-to-eye and vertex-to-light vectors, raised to the
-power of the shininess of the material. All three light source
-contributions are attenuated equally based on the distance from the
-vertex to the light source and on light source direction, spread
-exponent, and spread cutoff angle. All dot products are replaced with 0
-if they evaluate to a negative value.
-
-The alpha component of the resulting lighted color is set to the alpha
-value of the material diffuse reflectance.
-
-In color index mode, the value of the lighted index of a vertex ranges
-from the ambient to the specular values passed to `glMaterial' using
-`GL_COLOR_INDEXES'. Diffuse and specular coefficients, computed with a
-(.30, .59, .11) weighting of the lights' colors, the shininess of the
-material, and the same reflection and attenuation equations as in the
-RGBA case, determine how much above ambient the resulting index is.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if PNAME is not an accepted value.
-
-`GL_INVALID_ENUM' is generated if PNAME is
-`GL_LIGHT_MODEL_COLOR_CONTROL' and PARAMS is not one of
-`GL_SINGLE_COLOR' or `GL_SEPARATE_SPECULAR_COLOR'.
-
-`GL_INVALID_OPERATION' is generated if `glLightModel' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glLight
- "glLight"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glLightf"))
- (paramdef "GLenum " (parameter "light"))
- (paramdef "GLenum " (parameter "pname"))
- (paramdef "GLfloat " (parameter "param"))))
- "set light source parameters
-===========================
-
-
-Parameters
-==========
-
-LIGHT
- Specifies a light. The number of lights depends on the
- implementation, but at least eight lights are supported. They are
- identified by symbolic names of the form `GL_LIGHT'I, where i
- ranges from 0 to the value of `GL_MAX_LIGHTS' - 1.
-
-PNAME
- Specifies a single-valued light source parameter for LIGHT.
- `GL_SPOT_EXPONENT', `GL_SPOT_CUTOFF', `GL_CONSTANT_ATTENUATION',
- `GL_LINEAR_ATTENUATION', and `GL_QUADRATIC_ATTENUATION' are
- accepted.
-
-PARAM
- Specifies the value that parameter PNAME of light source LIGHT will
- be set to.
-
-
-Description
-===========
-
-`glLight' sets the values of individual light source parameters. LIGHT
-names the light and is a symbolic name of the form `GL_LIGHT'I, where i
-ranges from 0 to the value of `GL_MAX_LIGHTS' - 1. PNAME specifies one
-of ten light source parameters, again by symbolic name. PARAMS is either
-a single value or a pointer to an array that contains the new values.
-
-To enable and disable lighting calculation, call `glEnable' and
-`glDisable' with argument `GL_LIGHTING'. Lighting is initially disabled.
-When it is enabled, light sources that are enabled contribute to the
-lighting calculation. Light source I is enabled and disabled using
-`glEnable' and `glDisable' with argument `GL_LIGHT'I.
-
-The ten light parameters are as follows:
-
-`GL_AMBIENT'
- PARAMS contains four integer or floating-point values that specify
- the ambient RGBA intensity of the light. Integer values are mapped
- linearly such that the most positive representable value maps to
- 1.0, and the most negative representable value maps to -1.0.
- Floating-point values are mapped directly. Neither integer nor
- floating-point values are clamped. The initial ambient light
- intensity is (0, 0, 0, 1).
-
-`GL_DIFFUSE'
- PARAMS contains four integer or floating-point values that specify
- the diffuse RGBA intensity of the light. Integer values are mapped
- linearly such that the most positive representable value maps to
- 1.0, and the most negative representable value maps to -1.0.
- Floating-point values are mapped directly. Neither integer nor
- floating-point values are clamped. The initial value for
- `GL_LIGHT0' is (1, 1, 1, 1); for other lights, the initial value is
- (0, 0, 0, 1).
-
-`GL_SPECULAR'
- PARAMS contains four integer or floating-point values that specify
- the specular RGBA intensity of the light. Integer values are mapped
- linearly such that the most positive representable value maps to
- 1.0, and the most negative representable value maps to -1.0.
- Floating-point values are mapped directly. Neither integer nor
- floating-point values are clamped. The initial value for
- `GL_LIGHT0' is (1, 1, 1, 1); for other lights, the initial value is
- (0, 0, 0, 1).
-
-`GL_POSITION'
- PARAMS contains four integer or floating-point values that specify
- the position of the light in homogeneous object coordinates. Both
- integer and floating-point values are mapped directly. Neither
- integer nor floating-point values are clamped.
-
- The position is transformed by the modelview matrix when `glLight'
- is called (just as if it were a point), and it is stored in eye
- coordinates. If the W component of the position is 0, the light is
- treated as a directional source. Diffuse and specular lighting
- calculations take the light's direction, but not its actual
- position, into account, and attenuation is disabled. Otherwise,
- diffuse and specular lighting calculations are based on the actual
- location of the light in eye coordinates, and attenuation is
- enabled. The initial position is (0, 0, 1, 0); thus, the initial
- light source is directional, parallel to, and in the direction of
- the -Z axis.
-
-`GL_SPOT_DIRECTION'
- PARAMS contains three integer or floating-point values that specify
- the direction of the light in homogeneous object coordinates. Both
- integer and floating-point values are mapped directly. Neither
- integer nor floating-point values are clamped.
-
- The spot direction is transformed by the upper 3x3 of the modelview
- matrix when `glLight' is called, and it is stored in eye
- coordinates. It is significant only when `GL_SPOT_CUTOFF' is not
- 180, which it is initially. The initial direction is (0,0-1).
-
-`GL_SPOT_EXPONENT'
- PARAMS is a single integer or floating-point value that specifies
- the intensity distribution of the light. Integer and floating-point
- values are mapped directly. Only values in the range [0,128] are
- accepted.
-
- Effective light intensity is attenuated by the cosine of the angle
- between the direction of the light and the direction from the light
- to the vertex being lighted, raised to the power of the spot
- exponent. Thus, higher spot exponents result in a more focused
- light source, regardless of the spot cutoff angle (see
- `GL_SPOT_CUTOFF', next paragraph). The initial spot exponent is 0,
- resulting in uniform light distribution.
-
-`GL_SPOT_CUTOFF'
- PARAMS is a single integer or floating-point value that specifies
- the maximum spread angle of a light source. Integer and
- floating-point values are mapped directly. Only values in the range
- [0,90] and the special value 180 are accepted. If the angle between
- the direction of the light and the direction from the light to the
- vertex being lighted is greater than the spot cutoff angle, the
- light is completely masked. Otherwise, its intensity is controlled
- by the spot exponent and the attenuation factors. The initial spot
- cutoff is 180, resulting in uniform light distribution.
-
-`GL_CONSTANT_ATTENUATION'
-`GL_LINEAR_ATTENUATION'
-`GL_QUADRATIC_ATTENUATION'
- PARAMS is a single integer or floating-point value that specifies
- one of the three light attenuation factors. Integer and
- floating-point values are mapped directly. Only nonnegative values
- are accepted. If the light is positional, rather than directional,
- its intensity is attenuated by the reciprocal of the sum of the
- constant factor, the linear factor times the distance between the
- light and the vertex being lighted, and the quadratic factor times
- the square of the same distance. The initial attenuation factors
- are (1, 0, 0), resulting in no attenuation.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if either LIGHT or PNAME is not an
-accepted value.
-
-`GL_INVALID_VALUE' is generated if a spot exponent value is specified
-outside the range [0,128], or if spot cutoff is specified outside the
-range [0,90] (except for the special value 180), or if a negative
-attenuation factor is specified.
-
-`GL_INVALID_OPERATION' is generated if `glLight' is executed between the
-execution of `glBegin' and the corresponding execution of `glEnd'.")
-
-(define-gl-procedure
- glLineStipple
- "glLineStipple"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glLineStipple"))
- (paramdef "GLint " (parameter "factor"))
- (paramdef "GLushort " (parameter "pattern"))))
- "specify the line stipple pattern
-================================
-
-
-Parameters
-==========
-
-FACTOR
- Specifies a multiplier for each bit in the line stipple pattern. If
- FACTOR is 3, for example, each bit in the pattern is used three
- times before the next bit in the pattern is used. FACTOR is clamped
- to the range [1, 256] and defaults to 1.
-
-PATTERN
- Specifies a 16-bit integer whose bit pattern determines which
- fragments of a line will be drawn when the line is rasterized. Bit
- zero is used first; the default pattern is all 1's.
-
-
-Description
-===========
-
-Line stippling masks out certain fragments produced by rasterization;
-those fragments will not be drawn. The masking is achieved by using
-three parameters: the 16-bit line stipple pattern PATTERN, the repeat
-count FACTOR, and an integer stipple counter S.
-
-Counter S is reset to 0 whenever `glBegin' is called and before each
-line segment of a `glBegin'(`GL_LINES')/`glEnd' sequence is generated.
-It is incremented after each fragment of a unit width aliased line
-segment is generated or after each I fragments of an I width line
-segment are generated. The I fragments associated with count S are
-masked out if
-
-PATTERN bit (S/FACTOR,)%16
-
-is 0, otherwise these fragments are sent to the frame buffer. Bit zero
-of PATTERN is the least significant bit.
-
-Antialiased lines are treated as a sequence of 1×WIDTH rectangles for
-purposes of stippling. Whether rectangle S is rasterized or not depends
-on the fragment rule described for aliased lines, counting rectangles
-rather than groups of fragments.
-
-To enable and disable line stippling, call `glEnable' and `glDisable'
-with argument `GL_LINE_STIPPLE'. When enabled, the line stipple pattern
-is applied as described above. When disabled, it is as if the pattern
-were all 1's. Initially, line stippling is disabled.
-
-
-Errors
-======
-
-`GL_INVALID_OPERATION' is generated if `glLineStipple' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glLineWidth
- "glLineWidth"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glLineWidth"))
- (paramdef "GLfloat " (parameter "width"))))
- "specify the width of rasterized lines
-=====================================
-
-
-Parameters
-==========
-
-WIDTH
- Specifies the width of rasterized lines. The initial value is 1.
-
-
-Description
-===========
-
-`glLineWidth' specifies the rasterized width of both aliased and
-antialiased lines. Using a line width other than 1 has different
-effects, depending on whether line antialiasing is enabled. To enable
-and disable line antialiasing, call `glEnable' and `glDisable' with
-argument `GL_LINE_SMOOTH'. Line antialiasing is initially disabled.
-
-If line antialiasing is disabled, the actual width is determined by
-rounding the supplied width to the nearest integer. (If the rounding
-results in the value 0, it is as if the line width were 1.) If
-∣ΔX,∣>=∣ΔY,∣, I pixels are filled in each column that is rasterized,
-where I is the rounded value of WIDTH. Otherwise, I pixels are filled in
-each row that is rasterized.
-
-If antialiasing is enabled, line rasterization produces a fragment for
-each pixel square that intersects the region lying within the rectangle
-having width equal to the current line width, length equal to the actual
-length of the line, and centered on the mathematical line segment. The
-coverage value for each fragment is the window coordinate area of the
-intersection of the rectangular region with the corresponding pixel
-square. This value is saved and used in the final rasterization step.
-
-Not all widths can be supported when line antialiasing is enabled. If an
-unsupported width is requested, the nearest supported width is used.
-Only width 1 is guaranteed to be supported; others depend on the
-implementation. Likewise, there is a range for aliased line widths as
-well. To query the range of supported widths and the size difference
-between supported widths within the range, call `glGet' with arguments
-`GL_ALIASED_LINE_WIDTH_RANGE', `GL_SMOOTH_LINE_WIDTH_RANGE', and
-`GL_SMOOTH_LINE_WIDTH_GRANULARITY'.
-
-
-Errors
-======
-
-`GL_INVALID_VALUE' is generated if WIDTH is less than or equal to 0.
-
-`GL_INVALID_OPERATION' is generated if `glLineWidth' is executed between
-the execution of `glBegin' and the corresponding execution of `glEnd'.")
-
-(define-gl-procedure
- glLinkProgram
- "glLinkProgram"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glLinkProgram"))
- (paramdef "GLuint " (parameter "program"))))
- "Links a program object
-======================
-
-
-Parameters
-==========
-
-PROGRAM
- Specifies the handle of the program object to be linked.
-
-
-Description
-===========
-
-`glLinkProgram' links the program object specified by PROGRAM. If any
-shader objects of type `GL_VERTEX_SHADER' are attached to PROGRAM, they
-will be used to create an executable that will run on the programmable
-vertex processor. If any shader objects of type `GL_FRAGMENT_SHADER' are
-attached to PROGRAM, they will be used to create an executable that will
-run on the programmable fragment processor.
-
-The status of the link operation will be stored as part of the program
-object's state. This value will be set to `GL_TRUE' if the program
-object was linked without errors and is ready for use, and `GL_FALSE'
-otherwise. It can be queried by calling `glGetProgram' with arguments
-PROGRAM and `GL_LINK_STATUS'.
-
-As a result of a successful link operation, all active user-defined
-uniform variables belonging to PROGRAM will be initialized to 0, and
-each of the program object's active uniform variables will be assigned a
-location that can be queried by calling `glGetUniformLocation'. Also,
-any active user-defined attribute variables that have not been bound to
-a generic vertex attribute index will be bound to one at this time.
-
-Linking of a program object can fail for a number of reasons as
-specified in the OPENGL SHADING LANGUAGE SPECIFICATION. The following
-lists some of the conditions that will cause a link error.
-
- * The storage limit for uniform variables has been exceeded.
-
- * The number of active uniform variables supported by the
- implementation has been exceeded.
-
- * The `main' function is missing for the vertex shader or the
- fragment shader.
-
- * A varying variable actually used in the fragment shader is not
- declared in the same way (or is not declared at all) in the vertex
- shader.
-
- * A reference to a function or variable name is unresolved.
-
- * A shared global is declared with two different types or two
- different initial values.
-
- * One or more of the attached shader objects has not been
- successfully compiled.
-
- * Binding a generic attribute matrix caused some rows of the matrix
- to fall outside the allowed maximum of `GL_MAX_VERTEX_ATTRIBS'.
-
- * Not enough contiguous vertex attribute slots could be found to bind
- attribute matrices.
-
-When a program object has been successfully linked, the program object
-can be made part of current state by calling `glUseProgram'. Whether or
-not the link operation was successful, the program object's information
-log will be overwritten. The information log can be retrieved by calling
-`glGetProgramInfoLog'.
-
-`glLinkProgram' will also install the generated executables as part of
-the current rendering state if the link operation was successful and the
-specified program object is already currently in use as a result of a
-previous call to `glUseProgram'. If the program object currently in use
-is relinked unsuccessfully, its link status will be set to `GL_FALSE' ,
-but the executables and associated state will remain part of the current
-state until a subsequent call to `glUseProgram' removes it from use.
-After it is removed from use, it cannot be made part of current state
-until it has been successfully relinked.
-
-If PROGRAM contains shader objects of type `GL_VERTEX_SHADER' but does
-not contain shader objects of type `GL_FRAGMENT_SHADER', the vertex
-shader will be linked against the implicit interface for fixed
-functionality fragment processing. Similarly, if PROGRAM contains shader
-objects of type `GL_FRAGMENT_SHADER' but it does not contain shader
-objects of type `GL_VERTEX_SHADER', the fragment shader will be linked
-against the implicit interface for fixed functionality vertex
-processing.
-
-The program object's information log is updated and the program is
-generated at the time of the link operation. After the link operation,
-applications are free to modify attached shader objects, compile
-attached shader objects, detach shader objects, delete shader objects,
-and attach additional shader objects. None of these operations affects
-the information log or the program that is part of the program object.
-
-
-Errors
-======
-
-`GL_INVALID_VALUE' is generated if PROGRAM is not a value generated by
-OpenGL.
-
-`GL_INVALID_OPERATION' is generated if PROGRAM is not a program object.
-
-`GL_INVALID_OPERATION' is generated if `glLinkProgram' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glListBase
- "glListBase"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glListBase"))
- (paramdef "GLuint " (parameter "base"))))
- "set the display-list base for
-==============================
-
-
-Parameters
-==========
-
-BASE
- Specifies an integer offset that will be added to `glCallLists'
- offsets to generate display-list names. The initial value is 0.
-
-
-Description
-===========
-
-`glCallLists' specifies an array of offsets. Display-list names are
-generated by adding BASE to each offset. Names that reference valid
-display lists are executed; the others are ignored.
-
-
-Errors
-======
-
-`GL_INVALID_OPERATION' is generated if `glListBase' is executed between
-the execution of `glBegin' and the corresponding execution of `glEnd'.")
-
-(define-gl-procedure
- glLoadIdentity
- "glLoadIdentity"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glLoadIdentity"))
- (paramdef (parameter "void"))))
- "replace the current matrix with the identity matrix
-===================================================
-
-
-Description
-===========
-
-`glLoadIdentity' replaces the current matrix with the identity matrix.
-It is semantically equivalent to calling `glLoadMatrix' with the
-identity matrix
-
-
-
-((1 0 0 0), (0 1 0 0), (0 0 1 0), (0 0 0 1),,)
-
-
-
-but in some cases it is more efficient.
-
-
-Errors
-======
-
-`GL_INVALID_OPERATION' is generated if `glLoadIdentity' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glLoadMatrix
- "glLoadMatrix"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glLoadMatrixd"))
- (paramdef "const GLdouble * " (parameter "m"))))
- "replace the current matrix with the specified matrix
-====================================================
-
-
-Parameters
-==========
-
-M
- Specifies a pointer to 16 consecutive values, which are used as the
- elements of a 4×4 column-major matrix.
-
-
-Description
-===========
-
-`glLoadMatrix' replaces the current matrix with the one whose elements
-are specified by M. The current matrix is the projection matrix,
-modelview matrix, or texture matrix, depending on the current matrix
-mode (see `glMatrixMode').
-
-The current matrix, M, defines a transformation of coordinates. For
-instance, assume M refers to the modelview matrix. If
-V=(V\u2061[0,],V\u2061[1,]V\u2061[2,]V\u2061[3,]) is the set of object coordinates of a
-vertex, and M points to an array of 16 single- or double-precision
-floating-point values M={M\u2061[0,],M\u2061[1,]...M\u2061[15,]}, then the modelview
-transformation M\u2061(V,) does the following:
-
-M\u2061(V,)=((M\u2061[0,] M\u2061[4,] M\u2061[8,] M\u2061[12,]), (M\u2061[1,] M\u2061[5,] M\u2061[9,] M\u2061[13,]),
-(M\u2061[2,] M\u2061[6,] M\u2061[10,] M\u2061[14,]), (M\u2061[3,] M\u2061[7,] M\u2061[11,]
-M\u2061[15,]),)×((V\u2061[0,]), (V\u2061[1,]), (V\u2061[2,]), (V\u2061[3,]),)
-
-
-
-Projection and texture transformations are similarly defined.
-
-
-Errors
-======
-
-`GL_INVALID_OPERATION' is generated if `glLoadMatrix' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glLoadName
- "glLoadName"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glLoadName"))
- (paramdef "GLuint " (parameter "name"))))
- "load a name onto the name stack
-===============================
-
-
-Parameters
-==========
-
-NAME
- Specifies a name that will replace the top value on the name stack.
-
-
-Description
-===========
-
-The name stack is used during selection mode to allow sets of rendering
-commands to be uniquely identified. It consists of an ordered set of
-unsigned integers and is initially empty.
-
-`glLoadName' causes NAME to replace the value on the top of the name
-stack.
-
-The name stack is always empty while the render mode is not `GL_SELECT'.
-Calls to `glLoadName' while the render mode is not `GL_SELECT' are
-ignored.
-
-
-Errors
-======
-
-`GL_INVALID_OPERATION' is generated if `glLoadName' is called while the
-name stack is empty.
-
-`GL_INVALID_OPERATION' is generated if `glLoadName' is executed between
-the execution of `glBegin' and the corresponding execution of `glEnd'.")
-
-(define-gl-procedure
- glLoadTransposeMatrix
- "glLoadTransposeMatrix"
- (funcsynopsis
- (funcprototype
- (funcdef
- "void "
- (function "glLoadTransposeMatrixd"))
- (paramdef "const GLdouble * " (parameter "m"))))
- "replace the current matrix with the specified row-major ordered matrix
-======================================================================
-
-
-Parameters
-==========
-
-M
- Specifies a pointer to 16 consecutive values, which are used as the
- elements of a 4×4 row-major matrix.
-
-
-Description
-===========
-
-`glLoadTransposeMatrix' replaces the current matrix with the one whose
-elements are specified by M. The current matrix is the projection
-matrix, modelview matrix, or texture matrix, depending on the current
-matrix mode (see `glMatrixMode').
-
-The current matrix, M, defines a transformation of coordinates. For
-instance, assume M refers to the modelview matrix. If
-V=(V\u2061[0,],V\u2061[1,]V\u2061[2,]V\u2061[3,]) is the set of object coordinates of a
-vertex, and M points to an array of 16 single- or double-precision
-floating-point values M={M\u2061[0,],M\u2061[1,]...M\u2061[15,]}, then the modelview
-transformation M\u2061(V,) does the following:
-
-M\u2061(V,)=((M\u2061[0,] M\u2061[1,] M\u2061[2,] M\u2061[3,]), (M\u2061[4,] M\u2061[5,] M\u2061[6,] M\u2061[7,]),
-(M\u2061[8,] M\u2061[9,] M\u2061[10,] M\u2061[11,]), (M\u2061[12,] M\u2061[13,] M\u2061[14,]
-M\u2061[15,]),)×((V\u2061[0,]), (V\u2061[1,]), (V\u2061[2,]), (V\u2061[3,]),)
-
-
-
-Projection and texture transformations are similarly defined.
-
-Calling `glLoadTransposeMatrix' with matrix M is identical in operation
-to `glLoadMatrix' with M^T, where T represents the transpose.
-
-
-Errors
-======
-
-`GL_INVALID_OPERATION' is generated if `glLoadTransposeMatrix' is
-executed between the execution of `glBegin' and the corresponding
-execution of `glEnd'.")
-
-(define-gl-procedure
- glLogicOp
- "glLogicOp"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glLogicOp"))
- (paramdef "GLenum " (parameter "opcode"))))
- "specify a logical pixel operation for color index rendering
-===========================================================
-
-
-Parameters
-==========
-
-OPCODE
- Specifies a symbolic constant that selects a logical operation. The
- following symbols are accepted: `GL_CLEAR', `GL_SET', `GL_COPY',
- `GL_COPY_INVERTED', `GL_NOOP', `GL_INVERT', `GL_AND', `GL_NAND',
- `GL_OR', `GL_NOR', `GL_XOR', `GL_EQUIV', `GL_AND_REVERSE',
- `GL_AND_INVERTED', `GL_OR_REVERSE', and `GL_OR_INVERTED'. The
- initial value is `GL_COPY'.
-
-
-Description
-===========
-
-`glLogicOp' specifies a logical operation that, when enabled, is applied
-between the incoming color index or RGBA color and the color index or
-RGBA color at the corresponding location in the frame buffer. To enable
-or disable the logical operation, call `glEnable' and `glDisable' using
-the symbolic constant `GL_COLOR_LOGIC_OP' for RGBA mode or
-`GL_INDEX_LOGIC_OP' for color index mode. The initial value is disabled
-for both operations.
-
-
-
-* Opcode *
-*
-Resulting Operation *`GL_CLEAR'
-
-0 `GL_SET'
-
-1 `GL_COPY'
-
-s `GL_COPY_INVERTED'
-
-~s `GL_NOOP'
-
-d `GL_INVERT'
-
-~d `GL_AND'
-
-s & d `GL_NAND'
-
-~(s & d) `GL_OR'
-
-s | d `GL_NOR'
-
-~(s | d) `GL_XOR'
-
-s ^ d `GL_EQUIV'
-
-~(s ^ d) `GL_AND_REVERSE'
-
-s & ~d `GL_AND_INVERTED'
-
-~s & d `GL_OR_REVERSE'
-
-s | ~d `GL_OR_INVERTED'
-
-~s | d OPCODE is a symbolic constant chosen from the list above. In the
-explanation of the logical operations, S represents the incoming color
-index and D represents the index in the frame buffer. Standard
-C-language operators are used. As these bitwise operators suggest, the
-logical operation is applied independently to each bit pair of the
-source and destination indices or colors.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if OPCODE is not an accepted value.
-
-`GL_INVALID_OPERATION' is generated if `glLogicOp' is executed between
-the execution of `glBegin' and the corresponding execution of `glEnd'.")
-
-(define-gl-procedure
- glMap1
- "glMap1"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glMap1f"))
- (paramdef "GLenum " (parameter "target"))
- (paramdef "GLfloat " (parameter "u1"))
- (paramdef "GLfloat " (parameter "u2"))
- (paramdef "GLint " (parameter "stride"))
- (paramdef "GLint " (parameter "order"))
- (paramdef
- "const GLfloat * "
- (parameter "points"))))
- "define a one-dimensional evaluator
-==================================
-
-
-Parameters
-==========
-
-TARGET
- Specifies the kind of values that are generated by the evaluator.
- Symbolic constants `GL_MAP1_VERTEX_3', `GL_MAP1_VERTEX_4',
- `GL_MAP1_INDEX', `GL_MAP1_COLOR_4', `GL_MAP1_NORMAL',
- `GL_MAP1_TEXTURE_COORD_1', `GL_MAP1_TEXTURE_COORD_2',
- `GL_MAP1_TEXTURE_COORD_3', and `GL_MAP1_TEXTURE_COORD_4' are
- accepted.
-
-U1
- U2
-
- Specify a linear mapping of U, as presented to `glEvalCoord1', to
- U^, the variable that is evaluated by the equations specified by
- this command.
-
-STRIDE
- Specifies the number of floats or doubles between the beginning of
- one control point and the beginning of the next one in the data
- structure referenced in POINTS. This allows control points to be
- embedded in arbitrary data structures. The only constraint is that
- the values for a particular control point must occupy contiguous
- memory locations.
-
-ORDER
- Specifies the number of control points. Must be positive.
-
-POINTS
- Specifies a pointer to the array of control points.
-
-
-Description
-===========
-
-Evaluators provide a way to use polynomial or rational polynomial
-mapping to produce vertices, normals, texture coordinates, and colors.
-The values produced by an evaluator are sent to further stages of GL
-processing just as if they had been presented using `glVertex',
-`glNormal', `glTexCoord', and `glColor' commands, except that the
-generated values do not update the current normal, texture coordinates,
-or color.
-
-All polynomial or rational polynomial splines of any degree (up to the
-maximum degree supported by the GL implementation) can be described
-using evaluators. These include almost all splines used in computer
-graphics: B-splines, Bezier curves, Hermite splines, and so on.
-
-Evaluators define curves based on Bernstein polynomials. Define P\u2061(U^,)
-as
-
-P\u2061(U^,)=ΣI=0NB_I,^N\u2061(U^,)\u2062R_I
-
-
-
-where R_I is a control point and B_I,^N\u2061(U^,) is the Ith Bernstein
-polynomial of degree N (ORDER = N+1):
-
-B_I,^N\u2061(U^,)=((N), (I),,)\u2062U^,^I\u2062(1-U^,)^N-I,,
-
-Recall that
-
-0^0==1 and ((N), (0),,)==1
-
-`glMap1' is used to define the basis and to specify what kind of values
-are produced. Once defined, a map can be enabled and disabled by calling
-`glEnable' and `glDisable' with the map name, one of the nine predefined
-values for TARGET described below. `glEvalCoord1' evaluates the
-one-dimensional maps that are enabled. When `glEvalCoord1' presents a
-value U, the Bernstein functions are evaluated using U^, where
-U^=U-U1,/U2-U1,
-
-TARGET is a symbolic constant that indicates what kind of control points
-are provided in POINTS, and what output is generated when the map is
-evaluated. It can assume one of nine predefined values:
-
-`GL_MAP1_VERTEX_3'
- Each control point is three floating-point values representing X,
- Y, and Z. Internal `glVertex3' commands are generated when the map
- is evaluated.
-
-`GL_MAP1_VERTEX_4'
- Each control point is four floating-point values representing X, Y,
- Z, and W. Internal `glVertex4' commands are generated when the map
- is evaluated.
-
-`GL_MAP1_INDEX'
- Each control point is a single floating-point value representing a
- color index. Internal `glIndex' commands are generated when the map
- is evaluated but the current index is not updated with the value of
- these `glIndex' commands.
-
-`GL_MAP1_COLOR_4'
- Each control point is four floating-point values representing red,
- green, blue, and alpha. Internal `glColor4' commands are generated
- when the map is evaluated but the current color is not updated with
- the value of these `glColor4' commands.
-
-`GL_MAP1_NORMAL'
- Each control point is three floating-point values representing the
- X, Y, and Z components of a normal vector. Internal `glNormal'
- commands are generated when the map is evaluated but the current
- normal is not updated with the value of these `glNormal' commands.
-
-`GL_MAP1_TEXTURE_COORD_1'
- Each control point is a single floating-point value representing
- the S texture coordinate. Internal `glTexCoord1' commands are
- generated when the map is evaluated but the current texture
- coordinates are not updated with the value of these `glTexCoord'
- commands.
-
-`GL_MAP1_TEXTURE_COORD_2'
- Each control point is two floating-point values representing the S
- and T texture coordinates. Internal `glTexCoord2' commands are
- generated when the map is evaluated but the current texture
- coordinates are not updated with the value of these `glTexCoord'
- commands.
-
-`GL_MAP1_TEXTURE_COORD_3'
- Each control point is three floating-point values representing the
- S, T, and R texture coordinates. Internal `glTexCoord3' commands
- are generated when the map is evaluated but the current texture
- coordinates are not updated with the value of these `glTexCoord'
- commands.
-
-`GL_MAP1_TEXTURE_COORD_4'
- Each control point is four floating-point values representing the
- S, T, R, and Q texture coordinates. Internal `glTexCoord4' commands
- are generated when the map is evaluated but the current texture
- coordinates are not updated with the value of these `glTexCoord'
- commands.
-
-STRIDE, ORDER, and POINTS define the array addressing for accessing the
-control points. POINTS is the location of the first control point, which
-occupies one, two, three, or four contiguous memory locations, depending
-on which map is being defined. ORDER is the number of control points in
-the array. STRIDE specifies how many float or double locations to
-advance the internal memory pointer to reach the next control point.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if TARGET is not an accepted value.
-
-`GL_INVALID_VALUE' is generated if U1 is equal to U2.
-
-`GL_INVALID_VALUE' is generated if STRIDE is less than the number of
-values in a control point.
-
-`GL_INVALID_VALUE' is generated if ORDER is less than 1 or greater than
-the return value of `GL_MAX_EVAL_ORDER'.
-
-`GL_INVALID_OPERATION' is generated if `glMap1' is executed between the
-execution of `glBegin' and the corresponding execution of `glEnd'.
-
-`GL_INVALID_OPERATION' is generated if `glMap1' is called and the value
-of `GL_ACTIVE_TEXTURE' is not `GL_TEXTURE0'.")
-
-(define-gl-procedure
- glMap2
- "glMap2"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glMap2f"))
- (paramdef "GLenum " (parameter "target"))
- (paramdef "GLfloat " (parameter "u1"))
- (paramdef "GLfloat " (parameter "u2"))
- (paramdef "GLint " (parameter "ustride"))
- (paramdef "GLint " (parameter "uorder"))
- (paramdef "GLfloat " (parameter "v1"))
- (paramdef "GLfloat " (parameter "v2"))
- (paramdef "GLint " (parameter "vstride"))
- (paramdef "GLint " (parameter "vorder"))
- (paramdef
- "const GLfloat * "
- (parameter "points"))))
- "define a two-dimensional evaluator
-==================================
-
-
-Parameters
-==========
-
-TARGET
- Specifies the kind of values that are generated by the evaluator.
- Symbolic constants `GL_MAP2_VERTEX_3', `GL_MAP2_VERTEX_4',
- `GL_MAP2_INDEX', `GL_MAP2_COLOR_4', `GL_MAP2_NORMAL',
- `GL_MAP2_TEXTURE_COORD_1', `GL_MAP2_TEXTURE_COORD_2',
- `GL_MAP2_TEXTURE_COORD_3', and `GL_MAP2_TEXTURE_COORD_4' are
- accepted.
-
-U1
- U2
-
- Specify a linear mapping of U, as presented to `glEvalCoord2', to
- U^, one of the two variables that are evaluated by the equations
- specified by this command. Initially, U1 is 0 and U2 is 1.
-
-USTRIDE
- Specifies the number of floats or doubles between the beginning of
- control point R_IJ and the beginning of control point R_(I+1,)\u2062J,,
- where I and J are the U and V control point indices, respectively.
- This allows control points to be embedded in arbitrary data
- structures. The only constraint is that the values for a particular
- control point must occupy contiguous memory locations. The initial
- value of USTRIDE is 0.
-
-UORDER
- Specifies the dimension of the control point array in the U axis.
- Must be positive. The initial value is 1.
-
-V1
- V2
-
- Specify a linear mapping of V, as presented to `glEvalCoord2', to
- V^, one of the two variables that are evaluated by the equations
- specified by this command. Initially, V1 is 0 and V2 is 1.
-
-VSTRIDE
- Specifies the number of floats or doubles between the beginning of
- control point R_IJ and the beginning of control point R_I\u2061(J+1,),,
- where I and J are the U and V control point indices, respectively.
- This allows control points to be embedded in arbitrary data
- structures. The only constraint is that the values for a particular
- control point must occupy contiguous memory locations. The initial
- value of VSTRIDE is 0.
-
-VORDER
- Specifies the dimension of the control point array in the V axis.
- Must be positive. The initial value is 1.
-
-POINTS
- Specifies a pointer to the array of control points.
-
-
-Description
-===========
-
-Evaluators provide a way to use polynomial or rational polynomial
-mapping to produce vertices, normals, texture coordinates, and colors.
-The values produced by an evaluator are sent on to further stages of GL
-processing just as if they had been presented using `glVertex',
-`glNormal', `glTexCoord', and `glColor' commands, except that the
-generated values do not update the current normal, texture coordinates,
-or color.
-
-All polynomial or rational polynomial splines of any degree (up to the
-maximum degree supported by the GL implementation) can be described
-using evaluators. These include almost all surfaces used in computer
-graphics, including B-spline surfaces, NURBS surfaces, Bezier surfaces,
-and so on.
-
-Evaluators define surfaces based on bivariate Bernstein polynomials.
-Define P\u2061(U^,V^) as
-
-P\u2061(U^,V^)=ΣI=0NΣJ=0MB_I,^N\u2061(U^,)\u2062B_J,^M\u2061(V^,)\u2062R_IJ
-
-
-
-where R_IJ is a control point, B_I,^N\u2061(U^,) is the Ith Bernstein
-polynomial of degree N (UORDER = N+1)
-
-B_I,^N\u2061(U^,)=((N), (I),,)\u2062U^,^I\u2062(1-U^,)^N-I,,
-
-and B_J,^M\u2061(V^,) is the Jth Bernstein polynomial of degree M (VORDER =
-M+1)
-
-B_J,^M\u2061(V^,)=((M), (J),,)\u2062V^,^J\u2062(1-V^,)^M-J,,
-
-Recall that 0^0==1 and ((N), (0),,)==1
-
-`glMap2' is used to define the basis and to specify what kind of values
-are produced. Once defined, a map can be enabled and disabled by calling
-`glEnable' and `glDisable' with the map name, one of the nine predefined
-values for TARGET, described below. When `glEvalCoord2' presents values
-U and V, the bivariate Bernstein polynomials are evaluated using U^ and
-V^, where
-
-U^=U-U1,/U2-U1,
-
-V^=V-V1,/V2-V1,
-
-TARGET is a symbolic constant that indicates what kind of control points
-are provided in POINTS, and what output is generated when the map is
-evaluated. It can assume one of nine predefined values:
-
-`GL_MAP2_VERTEX_3'
- Each control point is three floating-point values representing X,
- Y, and Z. Internal `glVertex3' commands are generated when the map
- is evaluated.
-
-`GL_MAP2_VERTEX_4'
- Each control point is four floating-point values representing X, Y,
- Z, and W. Internal `glVertex4' commands are generated when the map
- is evaluated.
-
-`GL_MAP2_INDEX'
- Each control point is a single floating-point value representing a
- color index. Internal `glIndex' commands are generated when the map
- is evaluated but the current index is not updated with the value of
- these `glIndex' commands.
-
-`GL_MAP2_COLOR_4'
- Each control point is four floating-point values representing red,
- green, blue, and alpha. Internal `glColor4' commands are generated
- when the map is evaluated but the current color is not updated with
- the value of these `glColor4' commands.
-
-`GL_MAP2_NORMAL'
- Each control point is three floating-point values representing the
- X, Y, and Z components of a normal vector. Internal `glNormal'
- commands are generated when the map is evaluated but the current
- normal is not updated with the value of these `glNormal' commands.
-
-`GL_MAP2_TEXTURE_COORD_1'
- Each control point is a single floating-point value representing
- the S texture coordinate. Internal `glTexCoord1' commands are
- generated when the map is evaluated but the current texture
- coordinates are not updated with the value of these `glTexCoord'
- commands.
-
-`GL_MAP2_TEXTURE_COORD_2'
- Each control point is two floating-point values representing the S
- and T texture coordinates. Internal `glTexCoord2' commands are
- generated when the map is evaluated but the current texture
- coordinates are not updated with the value of these `glTexCoord'
- commands.
-
-`GL_MAP2_TEXTURE_COORD_3'
- Each control point is three floating-point values representing the
- S, T, and R texture coordinates. Internal `glTexCoord3' commands
- are generated when the map is evaluated but the current texture
- coordinates are not updated with the value of these `glTexCoord'
- commands.
-
-`GL_MAP2_TEXTURE_COORD_4'
- Each control point is four floating-point values representing the
- S, T, R, and Q texture coordinates. Internal `glTexCoord4' commands
- are generated when the map is evaluated but the current texture
- coordinates are not updated with the value of these `glTexCoord'
- commands.
-
-USTRIDE, UORDER, VSTRIDE, VORDER, and POINTS define the array addressing
-for accessing the control points. POINTS is the location of the first
-control point, which occupies one, two, three, or four contiguous memory
-locations, depending on which map is being defined. There are
-UORDER×VORDER control points in the array. USTRIDE specifies how many
-float or double locations are skipped to advance the internal memory
-pointer from control point R_I\u2062J, to control point R_(I+1,)\u2062J,. VSTRIDE
-specifies how many float or double locations are skipped to advance the
-internal memory pointer from control point R_I\u2062J, to control point
-R_I\u2061(J+1,),.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if TARGET is not an accepted value.
-
-`GL_INVALID_VALUE' is generated if U1 is equal to U2, or if V1 is equal
-to V2.
-
-`GL_INVALID_VALUE' is generated if either USTRIDE or VSTRIDE is less
-than the number of values in a control point.
-
-`GL_INVALID_VALUE' is generated if either UORDER or VORDER is less than
-1 or greater than the return value of `GL_MAX_EVAL_ORDER'.
-
-`GL_INVALID_OPERATION' is generated if `glMap2' is executed between the
-execution of `glBegin' and the corresponding execution of `glEnd'.
-
-`GL_INVALID_OPERATION' is generated if `glMap2' is called and the value
-of `GL_ACTIVE_TEXTURE' is not `GL_TEXTURE0'.")
-
-(define-gl-procedure
- glMapBuffer
- "glMapBuffer"
- (funcsynopsis
- (funcprototype
- (funcdef "void * " (function "glMapBuffer"))
- (paramdef "GLenum " (parameter "target"))
- (paramdef "GLenum " (parameter "access"))))
- "map a buffer object's data store
-================================
-
-
-Parameters
-==========
-
-TARGET
- Specifies the target buffer object being mapped. The symbolic
- constant must be `GL_ARRAY_BUFFER', `GL_ELEMENT_ARRAY_BUFFER',
- `GL_PIXEL_PACK_BUFFER', or `GL_PIXEL_UNPACK_BUFFER'.
-
-ACCESS
- Specifies the access policy, indicating whether it will be possible
- to read from, write to, or both read from and write to the buffer
- object's mapped data store. The symbolic constant must be
- `GL_READ_ONLY', `GL_WRITE_ONLY', or `GL_READ_WRITE'.
-
-
-Description
-===========
-
-`glMapBuffer' maps to the client's address space the entire data store
-of the buffer object currently bound to TARGET. The data can then be
-directly read and/or written relative to the returned pointer, depending
-on the specified ACCESS policy. If the GL is unable to map the buffer
-object's data store, `glMapBuffer' generates an error and returns
-`NULL'. This may occur for system-specific reasons, such as low virtual
-memory availability.
-
-If a mapped data store is accessed in a way inconsistent with the
-specified ACCESS policy, no error is generated, but performance may be
-negatively impacted and system errors, including program termination,
-may result. Unlike the USAGE parameter of `glBufferData', ACCESS is not
-a hint, and does in fact constrain the usage of the mapped data store on
-some GL implementations. In order to achieve the highest performance
-available, a buffer object's data store should be used in ways
-consistent with both its specified USAGE and ACCESS parameters.
-
-A mapped data store must be unmapped with `glUnmapBuffer' before its
-buffer object is used. Otherwise an error will be generated by any GL
-command that attempts to dereference the buffer object's data store.
-When a data store is unmapped, the pointer to its data store becomes
-invalid. `glUnmapBuffer' returns `GL_TRUE' unless the data store
-contents have become corrupt during the time the data store was mapped.
-This can occur for system-specific reasons that affect the availability
-of graphics memory, such as screen mode changes. In such situations,
-`GL_FALSE' is returned and the data store contents are undefined. An
-application must detect this rare condition and reinitialize the data
-store.
-
-A buffer object's mapped data store is automatically unmapped when the
-buffer object is deleted or its data store is recreated with
-`glBufferData'.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if TARGET is not `GL_ARRAY_BUFFER',
-`GL_ELEMENT_ARRAY_BUFFER', `GL_PIXEL_PACK_BUFFER', or
-`GL_PIXEL_UNPACK_BUFFER'.
-
-`GL_INVALID_ENUM' is generated if ACCESS is not `GL_READ_ONLY',
-`GL_WRITE_ONLY', or `GL_READ_WRITE'.
-
-`GL_OUT_OF_MEMORY' is generated when `glMapBuffer' is executed if the GL
-is unable to map the buffer object's data store. This may occur for a
-variety of system-specific reasons, such as the absence of sufficient
-remaining virtual memory.
-
-`GL_INVALID_OPERATION' is generated if the reserved buffer object name 0
-is bound to TARGET.
-
-`GL_INVALID_OPERATION' is generated if `glMapBuffer' is executed for a
-buffer object whose data store is already mapped.
-
-`GL_INVALID_OPERATION' is generated if `glUnmapBuffer' is executed for a
-buffer object whose data store is not currently mapped.
-
-`GL_INVALID_OPERATION' is generated if `glMapBuffer' or `glUnmapBuffer'
-is executed between the execution of `glBegin' and the corresponding
-execution of `glEnd'.")
-
-(define-gl-procedure
- glMapGrid
- "glMapGrid"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glMapGrid1d"))
- (paramdef "GLint " (parameter "un"))
- (paramdef "GLdouble " (parameter "u1"))
- (paramdef "GLdouble " (parameter "u2"))))
- "define a one- or two-dimensional mesh
-=====================================
-
-
-Parameters
-==========
-
-UN
- Specifies the number of partitions in the grid range interval [U1,
- U2]. Must be positive.
-
-U1
- U2
-
- Specify the mappings for integer grid domain values I=0 and I=UN.
-
-VN
- Specifies the number of partitions in the grid range interval [V1,
- V2] (`glMapGrid2' only).
-
-V1
- V2
-
- Specify the mappings for integer grid domain values J=0 and J=VN
- (`glMapGrid2' only).
-
-
-Description
-===========
-
-`glMapGrid' and `glEvalMesh' are used together to efficiently generate
-and evaluate a series of evenly-spaced map domain values. `glEvalMesh'
-steps through the integer domain of a one- or two-dimensional grid,
-whose range is the domain of the evaluation maps specified by `glMap1'
-and `glMap2'.
-
-`glMapGrid1' and `glMapGrid2' specify the linear grid mappings between
-the I (or I and J) integer grid coordinates, to the U (or U and V)
-floating-point evaluation map coordinates. See `glMap1' and `glMap2' for
-details of how U and V coordinates are evaluated.
-
-`glMapGrid1' specifies a single linear mapping such that integer grid
-coordinate 0 maps exactly to U1, and integer grid coordinate UN maps
-exactly to U2. All other integer grid coordinates I are mapped so that
-
-U=I\u2061(U2-U1,)/UN+U1
-
-`glMapGrid2' specifies two such linear mappings. One maps integer grid
-coordinate I=0 exactly to U1, and integer grid coordinate I=UN exactly
-to U2. The other maps integer grid coordinate J=0 exactly to V1, and
-integer grid coordinate J=VN exactly to V2. Other integer grid
-coordinates I and J are mapped such that
-
-U=I\u2061(U2-U1,)/UN+U1
-
-V=J\u2061(V2-V1,)/VN+V1
-
-The mappings specified by `glMapGrid' are used identically by
-`glEvalMesh' and `glEvalPoint'.
-
-
-Errors
-======
-
-`GL_INVALID_VALUE' is generated if either UN or VN is not positive.
-
-`GL_INVALID_OPERATION' is generated if `glMapGrid' is executed between
-the execution of `glBegin' and the corresponding execution of `glEnd'.")
-
-(define-gl-procedure
- glMaterial
- "glMaterial"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glMaterialf"))
- (paramdef "GLenum " (parameter "face"))
- (paramdef "GLenum " (parameter "pname"))
- (paramdef "GLfloat " (parameter "param"))))
- "specify material parameters for the lighting model
-==================================================
-
-
-Parameters
-==========
-
-FACE
- Specifies which face or faces are being updated. Must be one of
- `GL_FRONT', `GL_BACK', or `GL_FRONT_AND_BACK'.
-
-PNAME
- Specifies the single-valued material parameter of the face or faces
- that is being updated. Must be `GL_SHININESS'.
-
-PARAM
- Specifies the value that parameter `GL_SHININESS' will be set to.
-
-
-Description
-===========
-
-`glMaterial' assigns values to material parameters. There are two
-matched sets of material parameters. One, the FRONT-FACING set, is used
-to shade points, lines, bitmaps, and all polygons (when two-sided
-lighting is disabled), or just front-facing polygons (when two-sided
-lighting is enabled). The other set, BACK-FACING, is used to shade
-back-facing polygons only when two-sided lighting is enabled. Refer to
-the `glLightModel' reference page for details concerning one- and
-two-sided lighting calculations.
-
-`glMaterial' takes three arguments. The first, FACE, specifies whether
-the `GL_FRONT' materials, the `GL_BACK' materials, or both
-`GL_FRONT_AND_BACK' materials will be modified. The second, PNAME,
-specifies which of several parameters in one or both sets will be
-modified. The third, PARAMS, specifies what value or values will be
-assigned to the specified parameter.
-
-Material parameters are used in the lighting equation that is optionally
-applied to each vertex. The equation is discussed in the `glLightModel'
-reference page. The parameters that can be specified using `glMaterial',
-and their interpretations by the lighting equation, are as follows:
-
-`GL_AMBIENT'
- PARAMS contains four integer or floating-point values that specify
- the ambient RGBA reflectance of the material. Integer values are
- mapped linearly such that the most positive representable value
- maps to 1.0, and the most negative representable value maps to
- -1.0. Floating-point values are mapped directly. Neither integer
- nor floating-point values are clamped. The initial ambient
- reflectance for both front- and back-facing materials is (0.2, 0.2,
- 0.2, 1.0).
-
-`GL_DIFFUSE'
- PARAMS contains four integer or floating-point values that specify
- the diffuse RGBA reflectance of the material. Integer values are
- mapped linearly such that the most positive representable value
- maps to 1.0, and the most negative representable value maps to
- -1.0. Floating-point values are mapped directly. Neither integer
- nor floating-point values are clamped. The initial diffuse
- reflectance for both front- and back-facing materials is (0.8, 0.8,
- 0.8, 1.0).
-
-`GL_SPECULAR'
- PARAMS contains four integer or floating-point values that specify
- the specular RGBA reflectance of the material. Integer values are
- mapped linearly such that the most positive representable value
- maps to 1.0, and the most negative representable value maps to
- -1.0. Floating-point values are mapped directly. Neither integer
- nor floating-point values are clamped. The initial specular
- reflectance for both front- and back-facing materials is (0, 0, 0,
- 1).
-
-`GL_EMISSION'
- PARAMS contains four integer or floating-point values that specify
- the RGBA emitted light intensity of the material. Integer values
- are mapped linearly such that the most positive representable value
- maps to 1.0, and the most negative representable value maps to
- -1.0. Floating-point values are mapped directly. Neither integer
- nor floating-point values are clamped. The initial emission
- intensity for both front- and back-facing materials is (0, 0, 0,
- 1).
-
-`GL_SHININESS'
- PARAMS is a single integer or floating-point value that specifies
- the RGBA specular exponent of the material. Integer and
- floating-point values are mapped directly. Only values in the range
- [0,128] are accepted. The initial specular exponent for both front-
- and back-facing materials is 0.
-
-`GL_AMBIENT_AND_DIFFUSE'
- Equivalent to calling `glMaterial' twice with the same parameter
- values, once with `GL_AMBIENT' and once with `GL_DIFFUSE'.
-
-`GL_COLOR_INDEXES'
- PARAMS contains three integer or floating-point values specifying
- the color indices for ambient, diffuse, and specular lighting.
- These three values, and `GL_SHININESS', are the only material
- values used by the color index mode lighting equation. Refer to the
- `glLightModel' reference page for a discussion of color index
- lighting.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if either FACE or PNAME is not an
-accepted value.
-
-`GL_INVALID_VALUE' is generated if a specular exponent outside the range
-[0,128] is specified.")
-
-(define-gl-procedure
- glMatrixMode
- "glMatrixMode"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glMatrixMode"))
- (paramdef "GLenum " (parameter "mode"))))
- "specify which matrix is the current matrix
-==========================================
-
-
-Parameters
-==========
-
-MODE
- Specifies which matrix stack is the target for subsequent matrix
- operations. Three values are accepted: `GL_MODELVIEW',
- `GL_PROJECTION', and `GL_TEXTURE'. The initial value is
- `GL_MODELVIEW'. Additionally, if the `ARB_imaging' extension is
- supported, `GL_COLOR' is also accepted.
-
-
-Description
-===========
-
-`glMatrixMode' sets the current matrix mode. MODE can assume one of four
-values:
-
-`GL_MODELVIEW'
- Applies subsequent matrix operations to the modelview matrix stack.
-
-`GL_PROJECTION'
- Applies subsequent matrix operations to the projection matrix
- stack.
-
-`GL_TEXTURE'
- Applies subsequent matrix operations to the texture matrix stack.
-
-`GL_COLOR'
- Applies subsequent matrix operations to the color matrix stack.
-
-To find out which matrix stack is currently the target of all matrix
-operations, call `glGet' with argument `GL_MATRIX_MODE'. The initial
-value is `GL_MODELVIEW'.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if MODE is not an accepted value.
-
-`GL_INVALID_OPERATION' is generated if `glMatrixMode' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glMinmax
- "glMinmax"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glMinmax"))
- (paramdef "GLenum " (parameter "target"))
- (paramdef "GLenum " (parameter "internalformat"))
- (paramdef "GLboolean " (parameter "sink"))))
- "define minmax table
-===================
-
-
-Parameters
-==========
-
-TARGET
- The minmax table whose parameters are to be set. Must be
- `GL_MINMAX'.
-
-INTERNALFORMAT
- The format of entries in the minmax table. Must be one of
- `GL_ALPHA', `GL_ALPHA4', `GL_ALPHA8', `GL_ALPHA12', `GL_ALPHA16',
- `GL_LUMINANCE', `GL_LUMINANCE4', `GL_LUMINANCE8', `GL_LUMINANCE12',
- `GL_LUMINANCE16', `GL_LUMINANCE_ALPHA', `GL_LUMINANCE4_ALPHA4',
- `GL_LUMINANCE6_ALPHA2', `GL_LUMINANCE8_ALPHA8',
- `GL_LUMINANCE12_ALPHA4', `GL_LUMINANCE12_ALPHA12',
- `GL_LUMINANCE16_ALPHA16', `GL_R3_G3_B2', `GL_RGB', `GL_RGB4',
- `GL_RGB5', `GL_RGB8', `GL_RGB10', `GL_RGB12', `GL_RGB16',
- `GL_RGBA', `GL_RGBA2', `GL_RGBA4', `GL_RGB5_A1', `GL_RGBA8',
- `GL_RGB10_A2', `GL_RGBA12', or `GL_RGBA16'.
-
-SINK
- If `GL_TRUE', pixels will be consumed by the minmax process and no
- drawing or texture loading will take place. If `GL_FALSE', pixels
- will proceed to the final conversion process after minmax.
-
-
-Description
-===========
-
-When `GL_MINMAX' is enabled, the RGBA components of incoming pixels are
-compared to the minimum and maximum values for each component, which are
-stored in the two-element minmax table. (The first element stores the
-minima, and the second element stores the maxima.) If a pixel component
-is greater than the corresponding component in the maximum element, then
-the maximum element is updated with the pixel component value. If a
-pixel component is less than the corresponding component in the minimum
-element, then the minimum element is updated with the pixel component
-value. (In both cases, if the internal format of the minmax table
-includes luminance, then the R color component of incoming pixels is
-used for comparison.) The contents of the minmax table may be retrieved
-at a later time by calling `glGetMinmax'. The minmax operation is
-enabled or disabled by calling `glEnable' or `glDisable', respectively,
-with an argument of `GL_MINMAX'.
-
-`glMinmax' redefines the current minmax table to have entries of the
-format specified by INTERNALFORMAT. The maximum element is initialized
-with the smallest possible component values, and the minimum element is
-initialized with the largest possible component values. The values in
-the previous minmax table, if any, are lost. If SINK is `GL_TRUE', then
-pixels are discarded after minmax; no further processing of the pixels
-takes place, and no drawing, texture loading, or pixel readback will
-result.
-
-
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if TARGET is not one of the allowable
-values.
-
-`GL_INVALID_ENUM' is generated if INTERNALFORMAT is not one of the
-allowable values.
-
-`GL_INVALID_OPERATION' is generated if `glMinmax' is executed between
-the execution of `glBegin' and the corresponding execution of `glEnd'.")
-
-(define-gl-procedure
- glMultiDrawArrays
- "glMultiDrawArrays"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glMultiDrawArrays"))
- (paramdef "GLenum " (parameter "mode"))
- (paramdef "GLint * " (parameter "first"))
- (paramdef "GLsizei * " (parameter "count"))
- (paramdef "GLsizei " (parameter "primcount"))))
- "render multiple sets of primitives from array data
-==================================================
-
-
-Parameters
-==========
-
-MODE
- Specifies what kind of primitives to render. Symbolic constants
- `GL_POINTS', `GL_LINE_STRIP', `GL_LINE_LOOP', `GL_LINES',
- `GL_TRIANGLE_STRIP', `GL_TRIANGLE_FAN', `GL_TRIANGLES',
- `GL_QUAD_STRIP', `GL_QUADS', and `GL_POLYGON' are accepted.
-
-FIRST
- Points to an array of starting indices in the enabled arrays.
-
-COUNT
- Points to an array of the number of indices to be rendered.
-
-PRIMCOUNT
- Specifies the size of the first and count
-
-
-Description
-===========
-
-`glMultiDrawArrays' specifies multiple sets of geometric primitives with
-very few subroutine calls. Instead of calling a GL procedure to pass
-each individual vertex, normal, texture coordinate, edge flag, or color,
-you can prespecify separate arrays of vertices, normals, and colors and
-use them to construct a sequence of primitives with a single call to
-`glMultiDrawArrays'.
-
-`glMultiDrawArrays' behaves identically to `glDrawArrays' except that
-PRIMCOUNT separate ranges of elements are specified instead.
-
-When `glMultiDrawArrays' is called, it uses COUNT sequential elements
-from each enabled array to construct a sequence of geometric primitives,
-beginning with element FIRST. MODE specifies what kind of primitives are
-constructed, and how the array elements construct those primitives. If
-`GL_VERTEX_ARRAY' is not enabled, no geometric primitives are generated.
-
-Vertex attributes that are modified by `glMultiDrawArrays' have an
-unspecified value after `glMultiDrawArrays' returns. For example, if
-`GL_COLOR_ARRAY' is enabled, the value of the current color is undefined
-after `glMultiDrawArrays' executes. Attributes that aren't modified
-remain well defined.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if MODE is not an accepted value.
-
-`GL_INVALID_VALUE' is generated if PRIMCOUNT is negative.
-
-`GL_INVALID_OPERATION' is generated if a non-zero buffer object name is
-bound to an enabled array and the buffer object's data store is
-currently mapped.
-
-`GL_INVALID_OPERATION' is generated if `glMultiDrawArrays' is executed
-between the execution of `glBegin' and the corresponding `glEnd'.")
-
-(define-gl-procedure
- glMultiDrawElements
- "glMultiDrawElements"
- (funcsynopsis
- (funcprototype
- (funcdef
- "void "
- (function "glMultiDrawElements"))
- (paramdef "GLenum " (parameter "mode"))
- (paramdef "const GLsizei * " (parameter "count"))
- (paramdef "GLenum " (parameter "type"))
- (paramdef
- "const GLvoid ** "
- (parameter "indices"))
- (paramdef "GLsizei " (parameter "primcount"))))
- "render multiple sets of primitives by specifying indices of array data elements
-===============================================================================
-
-
-Parameters
-==========
-
-MODE
- Specifies what kind of primitives to render. Symbolic constants
- `GL_POINTS', `GL_LINE_STRIP', `GL_LINE_LOOP', `GL_LINES',
- `GL_TRIANGLE_STRIP', `GL_TRIANGLE_FAN', `GL_TRIANGLES',
- `GL_QUAD_STRIP', `GL_QUADS', and `GL_POLYGON' are accepted.
-
-COUNT
- Points to an array of the elements counts.
-
-TYPE
- Specifies the type of the values in INDICES. Must be one of
- `GL_UNSIGNED_BYTE', `GL_UNSIGNED_SHORT', or `GL_UNSIGNED_INT'.
-
-INDICES
- Specifies a pointer to the location where the indices are stored.
-
-PRIMCOUNT
- Specifies the size of the COUNT array.
-
-
-Description
-===========
-
-`glMultiDrawElements' specifies multiple sets of geometric primitives
-with very few subroutine calls. Instead of calling a GL function to pass
-each individual vertex, normal, texture coordinate, edge flag, or color,
-you can prespecify separate arrays of vertices, normals, and so on, and
-use them to construct a sequence of primitives with a single call to
-`glMultiDrawElements'.
-
-`glMultiDrawElements' is identical in operation to `glDrawElements'
-except that PRIMCOUNT separate lists of elements are specified.
-
-Vertex attributes that are modified by `glMultiDrawElements' have an
-unspecified value after `glMultiDrawElements' returns. For example, if
-`GL_COLOR_ARRAY' is enabled, the value of the current color is undefined
-after `glMultiDrawElements' executes. Attributes that aren't modified
-maintain their previous values.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if MODE is not an accepted value.
-
-`GL_INVALID_VALUE' is generated if PRIMCOUNT is negative.
-
-`GL_INVALID_OPERATION' is generated if a non-zero buffer object name is
-bound to an enabled array or the element array and the buffer object's
-data store is currently mapped.
-
-`GL_INVALID_OPERATION' is generated if `glMultiDrawElements' is executed
-between the execution of `glBegin' and the corresponding `glEnd'.")
-
-(define-gl-procedure
- glMultiTexCoord
- "glMultiTexCoord"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glMultiTexCoord1s"))
- (paramdef "GLenum " (parameter "target"))
- (paramdef "GLshort " (parameter "s"))))
- "set the current texture coordinates
-===================================
-
-
-Parameters
-==========
-
-TARGET
- Specifies the texture unit whose coordinates should be modified.
- The number of texture units is implementation dependent, but must
- be at least two. Symbolic constant must be one of `GL_TEXTURE'I,
- where i ranges from 0 to `GL_MAX_TEXTURE_COORDS' - 1, which is an
- implementation-dependent value.
-
-S
- T
-
- R
-
- Q
-
- Specify S, T, R, and Q texture coordinates for TARGET texture unit.
- Not all parameters are present in all forms of the command.
-
-
-Description
-===========
-
-`glMultiTexCoord' specifies texture coordinates in one, two, three, or
-four dimensions. `glMultiTexCoord1' sets the current texture coordinates
-to (S,001); a call to `glMultiTexCoord2' sets them to (S,T01).
-Similarly, `glMultiTexCoord3' specifies the texture coordinates as
-(S,TR1), and `glMultiTexCoord4' defines all four components explicitly
-as (S,TRQ).
-
-The current texture coordinates are part of the data that is associated
-with each vertex and with the current raster position. Initially, the
-values for (S,TRQ) are (0,001).")
-
-(define-gl-procedure
- glMultMatrix
- "glMultMatrix"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glMultMatrixd"))
- (paramdef "const GLdouble * " (parameter "m"))))
- "multiply the current matrix with the specified matrix
-=====================================================
-
-
-Parameters
-==========
-
-M
- Points to 16 consecutive values that are used as the elements of a
- 4×4 column-major matrix.
-
-
-Description
-===========
-
-`glMultMatrix' multiplies the current matrix with the one specified
-using M, and replaces the current matrix with the product.
-
-The current matrix is determined by the current matrix mode (see
-`glMatrixMode'). It is either the projection matrix, modelview matrix,
-or the texture matrix.
-
-
-Errors
-======
-
-`GL_INVALID_OPERATION' is generated if `glMultMatrix' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glMultTransposeMatrix
- "glMultTransposeMatrix"
- (funcsynopsis
- (funcprototype
- (funcdef
- "void "
- (function "glMultTransposeMatrixd"))
- (paramdef "const GLdouble * " (parameter "m"))))
- "multiply the current matrix with the specified row-major ordered matrix
-=======================================================================
-
-
-Parameters
-==========
-
-M
- Points to 16 consecutive values that are used as the elements of a
- 4×4 row-major matrix.
-
-
-Description
-===========
-
-`glMultTransposeMatrix' multiplies the current matrix with the one
-specified using M, and replaces the current matrix with the product.
-
-The current matrix is determined by the current matrix mode (see
-`glMatrixMode'). It is either the projection matrix, modelview matrix,
-or the texture matrix.
-
-
-Errors
-======
-
-`GL_INVALID_OPERATION' is generated if `glMultTransposeMatrix' is
-executed between the execution of `glBegin' and the corresponding
-execution of `glEnd'.")
-
-(define-gl-procedure
- glNewList
- "glNewList"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glNewList"))
- (paramdef "GLuint " (parameter "list"))
- (paramdef "GLenum " (parameter "mode"))))
- "create or replace a display list
-================================
-
-
-Parameters
-==========
-
-LIST
- Specifies the display-list name.
-
-MODE
- Specifies the compilation mode, which can be `GL_COMPILE' or
- `GL_COMPILE_AND_EXECUTE'.
-
-
-Description
-===========
-
-Display lists are groups of GL commands that have been stored for
-subsequent execution. Display lists are created with `glNewList'. All
-subsequent commands are placed in the display list, in the order issued,
-until `glEndList' is called.
-
-`glNewList' has two arguments. The first argument, LIST, is a positive
-integer that becomes the unique name for the display list. Names can be
-created and reserved with `glGenLists' and tested for uniqueness with
-`glIsList'. The second argument, MODE, is a symbolic constant that can
-assume one of two values:
-
-`GL_COMPILE'
- Commands are merely compiled.
-
-`GL_COMPILE_AND_EXECUTE'
- Commands are executed as they are compiled into the display list.
-
-Certain commands are not compiled into the display list but are executed
-immediately, regardless of the display-list mode. These commands are
-`glAreTexturesResident', `glColorPointer', `glDeleteLists',
-`glDeleteTextures', `glDisableClientState', `glEdgeFlagPointer',
-`glEnableClientState', `glFeedbackBuffer', `glFinish', `glFlush',
-`glGenLists', `glGenTextures', `glIndexPointer', `glInterleavedArrays',
-`glIsEnabled', `glIsList', `glIsTexture', `glNormalPointer',
-`glPopClientAttrib', `glPixelStore', `glPushClientAttrib',
-`glReadPixels', `glRenderMode', `glSelectBuffer', `glTexCoordPointer',
-`glVertexPointer', and all of the `glGet' commands.
-
-Similarly, `glTexImage1D', `glTexImage2D', and `glTexImage3D' are
-executed immediately and not compiled into the display list when their
-first argument is `GL_PROXY_TEXTURE_1D', `GL_PROXY_TEXTURE_1D', or
-`GL_PROXY_TEXTURE_3D', respectively.
-
-When the `ARB_imaging' extension is supported, `glHistogram' executes
-immediately when its argument is `GL_PROXY_HISTOGRAM'. Similarly,
-`glColorTable' executes immediately when its first argument is
-`GL_PROXY_COLOR_TABLE', `GL_PROXY_POST_CONVOLUTION_COLOR_TABLE', or
-`GL_PROXY_POST_COLOR_MATRIX_COLOR_TABLE'.
-
-For OpenGL versions 1.3 and greater, or when the `ARB_multitexture'
-extension is supported, `glClientActiveTexture' is not compiled into
-display lists, but executed immediately.
-
-When `glEndList' is encountered, the display-list definition is
-completed by associating the list with the unique name LIST (specified
-in the `glNewList' command). If a display list with name LIST already
-exists, it is replaced only when `glEndList' is called.
-
-
-Errors
-======
-
-`GL_INVALID_VALUE' is generated if LIST is 0.
-
-`GL_INVALID_ENUM' is generated if MODE is not an accepted value.
-
-`GL_INVALID_OPERATION' is generated if `glEndList' is called without a
-preceding `glNewList', or if `glNewList' is called while a display list
-is being defined.
-
-`GL_INVALID_OPERATION' is generated if `glNewList' or `glEndList' is
-executed between the execution of `glBegin' and the corresponding
-execution of `glEnd'.
-
-`GL_OUT_OF_MEMORY' is generated if there is insufficient memory to
-compile the display list. If the GL version is 1.1 or greater, no change
-is made to the previous contents of the display list, if any, and no
-other change is made to the GL state. (It is as if no attempt had been
-made to create the new display list.)")
-
-(define-gl-procedure
- glNormalPointer
- "glNormalPointer"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glNormalPointer"))
- (paramdef "GLenum " (parameter "type"))
- (paramdef "GLsizei " (parameter "stride"))
- (paramdef
- "const GLvoid * "
- (parameter "pointer"))))
- "define an array of normals
-==========================
-
-
-Parameters
-==========
-
-TYPE
- Specifies the data type of each coordinate in the array. Symbolic
- constants `GL_BYTE', `GL_SHORT', `GL_INT', `GL_FLOAT', and
- `GL_DOUBLE' are accepted. The initial value is `GL_FLOAT'.
-
-STRIDE
- Specifies the byte offset between consecutive normals. If STRIDE is
- 0, the normals are understood to be tightly packed in the array.
- The initial value is 0.
-
-POINTER
- Specifies a pointer to the first coordinate of the first normal in
- the array. The initial value is 0.
-
-
-Description
-===========
-
-`glNormalPointer' specifies the location and data format of an array of
-normals to use when rendering. TYPE specifies the data type of each
-normal coordinate, and STRIDE specifies the byte stride from one normal
-to the next, allowing vertices and attributes to be packed into a single
-array or stored in separate arrays. (Single-array storage may be more
-efficient on some implementations; see `glInterleavedArrays'.)
-
-If a non-zero named buffer object is bound to the `GL_ARRAY_BUFFER'
-target (see `glBindBuffer') while a normal array is specified, POINTER
-is treated as a byte offset into the buffer object's data store. Also,
-the buffer object binding (`GL_ARRAY_BUFFER_BINDING') is saved as normal
-vertex array client-side state (`GL_NORMAL_ARRAY_BUFFER_BINDING').
-
-When a normal array is specified, TYPE, STRIDE, and POINTER are saved as
-client-side state, in addition to the current vertex array buffer object
-binding.
-
-To enable and disable the normal array, call `glEnableClientState' and
-`glDisableClientState' with the argument `GL_NORMAL_ARRAY'. If enabled,
-the normal array is used when `glDrawArrays', `glMultiDrawArrays',
-`glDrawElements', `glMultiDrawElements', `glDrawRangeElements', or
-`glArrayElement' is called.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if TYPE is not an accepted value.
-
-`GL_INVALID_VALUE' is generated if STRIDE is negative.")
-
-(define-gl-procedure
- glNormal
- "glNormal"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glNormal3b"))
- (paramdef "GLbyte " (parameter "nx"))
- (paramdef "GLbyte " (parameter "ny"))
- (paramdef "GLbyte " (parameter "nz"))))
- "set the current normal vector
-=============================
-
-
-Parameters
-==========
-
-NX
- NY
-
- NZ
-
- Specify the X, Y, and Z coordinates of the new current normal. The
- initial value of the current normal is the unit vector, (0, 0, 1).
-
-
-
-
-Description
-===========
-
-The current normal is set to the given coordinates whenever `glNormal'
-is issued. Byte, short, or integer arguments are converted to
-floating-point format with a linear mapping that maps the most positive
-representable integer value to 1.0 and the most negative representable
-integer value to -1.0.
-
-Normals specified with `glNormal' need not have unit length. If
-`GL_NORMALIZE' is enabled, then normals of any length specified with
-`glNormal' are normalized after transformation. If `GL_RESCALE_NORMAL'
-is enabled, normals are scaled by a scaling factor derived from the
-modelview matrix. `GL_RESCALE_NORMAL' requires that the originally
-specified normals were of unit length, and that the modelview matrix
-contain only uniform scales for proper results. To enable and disable
-normalization, call `glEnable' and `glDisable' with either
-`GL_NORMALIZE' or `GL_RESCALE_NORMAL'. Normalization is initially
-disabled.")
-
-(define-gl-procedure
- glOrtho
- "glOrtho"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glOrtho"))
- (paramdef "GLdouble " (parameter "left"))
- (paramdef "GLdouble " (parameter "right"))
- (paramdef "GLdouble " (parameter "bottom"))
- (paramdef "GLdouble " (parameter "top"))
- (paramdef "GLdouble " (parameter "nearVal"))
- (paramdef "GLdouble " (parameter "farVal"))))
- "multiply the current matrix with an orthographic matrix
-=======================================================
-
-
-Parameters
-==========
-
-LEFT
- RIGHT
-
- Specify the coordinates for the left and right vertical clipping
- planes.
-
-BOTTOM
- TOP
-
- Specify the coordinates for the bottom and top horizontal clipping
- planes.
-
-NEARVAL
- FARVAL
-
- Specify the distances to the nearer and farther depth clipping
- planes. These values are negative if the plane is to be behind the
- viewer.
-
-
-Description
-===========
-
-`glOrtho' describes a transformation that produces a parallel
-projection. The current matrix (see `glMatrixMode') is multiplied by
-this matrix and the result replaces the current matrix, as if
-`glMultMatrix' were called with the following matrix as its argument:
-
-((2/RIGHT-LEFT,, 0 0 T_X,), (0 2/TOP-BOTTOM,, 0 T_Y,), (0 0
--2/FARVAL-NEARVAL,, T_Z,), (0 0 0 1),)
-
-where
-T_X=-RIGHT+LEFT,/RIGHT-LEFT,,T_Y=-TOP+BOTTOM,/TOP-BOTTOM,,T_Z=-FARVAL+NE
-ARVAL,/FARVAL-NEARVAL,,
-
-Typically, the matrix mode is `GL_PROJECTION', and (LEFT,BOTTOM-NEARVAL)
-and (RIGHT,TOP-NEARVAL) specify the points on the near clipping plane
-that are mapped to the lower left and upper right corners of the window,
-respectively, assuming that the eye is located at (0, 0, 0). -FARVAL
-specifies the location of the far clipping plane. Both NEARVAL and
-FARVAL can be either positive or negative.
-
-Use `glPushMatrix' and `glPopMatrix' to save and restore the current
-matrix stack.
-
-
-Errors
-======
-
-`GL_INVALID_VALUE' is generated if LEFT = RIGHT, or BOTTOM = TOP, or
-NEAR = FAR.
-
-`GL_INVALID_OPERATION' is generated if `glOrtho' is executed between the
-execution of `glBegin' and the corresponding execution of `glEnd'.")
-
-(define-gl-procedure
- glPassThrough
- "glPassThrough"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glPassThrough"))
- (paramdef "GLfloat " (parameter "token"))))
- "place a marker in the feedback buffer
-=====================================
-
-
-Parameters
-==========
-
-TOKEN
- Specifies a marker value to be placed in the feedback buffer
- following a `GL_PASS_THROUGH_TOKEN'.
-
-
-Description
-===========
-
-
-
-Feedback is a GL render mode. The mode is selected by calling
-`glRenderMode' with `GL_FEEDBACK'. When the GL is in feedback mode, no
-pixels are produced by rasterization. Instead, information about
-primitives that would have been rasterized is fed back to the
-application using the GL. See the `glFeedbackBuffer' reference page for
-a description of the feedback buffer and the values in it.
-
-`glPassThrough' inserts a user-defined marker in the feedback buffer
-when it is executed in feedback mode. TOKEN is returned as if it were a
-primitive; it is indicated with its own unique identifying value:
-`GL_PASS_THROUGH_TOKEN'. The order of `glPassThrough' commands with
-respect to the specification of graphics primitives is maintained.
-
-
-Errors
-======
-
-`GL_INVALID_OPERATION' is generated if `glPassThrough' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glPixelMap
- "glPixelMap"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glPixelMapfv"))
- (paramdef "GLenum " (parameter "map"))
- (paramdef "GLsizei " (parameter "mapsize"))
- (paramdef
- "const GLfloat * "
- (parameter "values"))))
- "set up pixel transfer maps
-==========================
-
-
-Parameters
-==========
-
-MAP
- Specifies a symbolic map name. Must be one of the following:
- `GL_PIXEL_MAP_I_TO_I', `GL_PIXEL_MAP_S_TO_S',
- `GL_PIXEL_MAP_I_TO_R', `GL_PIXEL_MAP_I_TO_G',
- `GL_PIXEL_MAP_I_TO_B', `GL_PIXEL_MAP_I_TO_A',
- `GL_PIXEL_MAP_R_TO_R', `GL_PIXEL_MAP_G_TO_G',
- `GL_PIXEL_MAP_B_TO_B', or `GL_PIXEL_MAP_A_TO_A'.
-
-MAPSIZE
- Specifies the size of the map being defined.
-
-VALUES
- Specifies an array of MAPSIZE values.
-
-
-Description
-===========
-
-`glPixelMap' sets up translation tables, or MAPS, used by
-`glCopyPixels', `glCopyTexImage1D', `glCopyTexImage2D',
-`glCopyTexSubImage1D', `glCopyTexSubImage2D', `glCopyTexSubImage3D',
-`glDrawPixels', `glReadPixels', `glTexImage1D', `glTexImage2D',
-`glTexImage3D', `glTexSubImage1D', `glTexSubImage2D', and
-`glTexSubImage3D'. Additionally, if the `ARB_imaging' subset is
-supported, the routines `glColorTable', `glColorSubTable',
-`glConvolutionFilter1D', `glConvolutionFilter2D', `glHistogram',
-`glMinmax', and `glSeparableFilter2D'. Use of these maps is described
-completely in the `glPixelTransfer' reference page, and partly in the
-reference pages for the pixel and texture image commands. Only the
-specification of the maps is described in this reference page.
-
-MAP is a symbolic map name, indicating one of ten maps to set. MAPSIZE
-specifies the number of entries in the map, and VALUES is a pointer to
-an array of MAPSIZE map values.
-
-If a non-zero named buffer object is bound to the
-`GL_PIXEL_UNPACK_BUFFER' target (see `glBindBuffer') while a pixel
-transfer map is specified, VALUES is treated as a byte offset into the
-buffer object's data store.
-
-The ten maps are as follows:
-
-`GL_PIXEL_MAP_I_TO_I'
- Maps color indices to color indices.
-
-`GL_PIXEL_MAP_S_TO_S'
- Maps stencil indices to stencil indices.
-
-`GL_PIXEL_MAP_I_TO_R'
- Maps color indices to red components.
-
-`GL_PIXEL_MAP_I_TO_G'
- Maps color indices to green components.
-
-`GL_PIXEL_MAP_I_TO_B'
- Maps color indices to blue components.
-
-`GL_PIXEL_MAP_I_TO_A'
- Maps color indices to alpha components.
-
-`GL_PIXEL_MAP_R_TO_R'
- Maps red components to red components.
-
-`GL_PIXEL_MAP_G_TO_G'
- Maps green components to green components.
-
-`GL_PIXEL_MAP_B_TO_B'
- Maps blue components to blue components.
-
-`GL_PIXEL_MAP_A_TO_A'
- Maps alpha components to alpha components.
-
-The entries in a map can be specified as single-precision floating-point
-numbers, unsigned short integers, or unsigned int integers. Maps that
-store color component values (all but `GL_PIXEL_MAP_I_TO_I' and
-`GL_PIXEL_MAP_S_TO_S') retain their values in floating-point format,
-with unspecified mantissa and exponent sizes. Floating-point values
-specified by `glPixelMapfv' are converted directly to the internal
-floating-point format of these maps, then clamped to the range [0,1].
-Unsigned integer values specified by `glPixelMapusv' and `glPixelMapuiv'
-are converted linearly such that the largest representable integer maps
-to 1.0, and 0 maps to 0.0.
-
-Maps that store indices, `GL_PIXEL_MAP_I_TO_I' and
-`GL_PIXEL_MAP_S_TO_S', retain their values in fixed-point format, with
-an unspecified number of bits to the right of the binary point.
-Floating-point values specified by `glPixelMapfv' are converted directly
-to the internal fixed-point format of these maps. Unsigned integer
-values specified by `glPixelMapusv' and `glPixelMapuiv' specify integer
-values, with all 0's to the right of the binary point.
-
-The following table shows the initial sizes and values for each of the
-maps. Maps that are indexed by either color or stencil indices must have
-MAPSIZE = 2^N for some N or the results are undefined. The maximum
-allowable size for each map depends on the implementation and can be
-determined by calling `glGet' with argument `GL_MAX_PIXEL_MAP_TABLE'.
-The single maximum applies to all maps; it is at least 32.
-
-*MAP*
-*
-Lookup Index *, *
-Lookup Value *, *
-Initial Size *, *
-Initial Value *`GL_PIXEL_MAP_I_TO_I'
-
-color index ,
-color index ,
-1 ,
-0 `GL_PIXEL_MAP_S_TO_S'
-
-stencil index ,
-stencil index ,
-1 ,
-0 `GL_PIXEL_MAP_I_TO_R'
-
-color index ,
-R ,
-1 ,
-0 `GL_PIXEL_MAP_I_TO_G'
-
-color index ,
-G ,
-1 ,
-0 `GL_PIXEL_MAP_I_TO_B'
-
-color index ,
-B ,
-1 ,
-0 `GL_PIXEL_MAP_I_TO_A'
-
-color index ,
-A ,
-1 ,
-0 `GL_PIXEL_MAP_R_TO_R'
-
-R ,
-R ,
-1 ,
-0 `GL_PIXEL_MAP_G_TO_G'
-
-G ,
-G ,
-1 ,
-0 `GL_PIXEL_MAP_B_TO_B'
-
-B ,
-B ,
-1 ,
-0 `GL_PIXEL_MAP_A_TO_A'
-
-A ,
-A ,
-1 ,
-0
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if MAP is not an accepted value.
-
-`GL_INVALID_VALUE' is generated if MAPSIZE is less than one or larger
-than `GL_MAX_PIXEL_MAP_TABLE'.
-
-`GL_INVALID_VALUE' is generated if MAP is `GL_PIXEL_MAP_I_TO_I',
-`GL_PIXEL_MAP_S_TO_S', `GL_PIXEL_MAP_I_TO_R', `GL_PIXEL_MAP_I_TO_G',
-`GL_PIXEL_MAP_I_TO_B', or `GL_PIXEL_MAP_I_TO_A', and MAPSIZE is not a
-power of two.
-
-`GL_INVALID_OPERATION' is generated if a non-zero buffer object name is
-bound to the `GL_PIXEL_UNPACK_BUFFER' target and the buffer object's
-data store is currently mapped.
-
-`GL_INVALID_OPERATION' is generated if a non-zero buffer object name is
-bound to the `GL_PIXEL_UNPACK_BUFFER' target and the data would be
-unpacked from the buffer object such that the memory reads required
-would exceed the data store size.
-
-`GL_INVALID_OPERATION' is generated by `glPixelMapfv' if a non-zero
-buffer object name is bound to the `GL_PIXEL_UNPACK_BUFFER' target and
-VALUES is not evenly divisible into the number of bytes needed to store
-in memory a GLfloat datum.
-
-`GL_INVALID_OPERATION' is generated by `glPixelMapuiv' if a non-zero
-buffer object name is bound to the `GL_PIXEL_UNPACK_BUFFER' target and
-VALUES is not evenly divisible into the number of bytes needed to store
-in memory a GLuint datum.
-
-`GL_INVALID_OPERATION' is generated by `glPixelMapusv' if a non-zero
-buffer object name is bound to the `GL_PIXEL_UNPACK_BUFFER' target and
-VALUES is not evenly divisible into the number of bytes needed to store
-in memory a GLushort datum.
-
-`GL_INVALID_OPERATION' is generated if `glPixelMap' is executed between
-the execution of `glBegin' and the corresponding execution of `glEnd'.")
-
-(define-gl-procedure
- glPixelStore
- "glPixelStore"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glPixelStoref"))
- (paramdef "GLenum " (parameter "pname"))
- (paramdef "GLfloat " (parameter "param"))))
- "set pixel storage modes
-=======================
-
-
-Parameters
-==========
-
-PNAME
- Specifies the symbolic name of the parameter to be set. Six values
- affect the packing of pixel data into memory: `GL_PACK_SWAP_BYTES',
- `GL_PACK_LSB_FIRST', `GL_PACK_ROW_LENGTH', `GL_PACK_IMAGE_HEIGHT',
- `GL_PACK_SKIP_PIXELS', `GL_PACK_SKIP_ROWS', `GL_PACK_SKIP_IMAGES',
- and `GL_PACK_ALIGNMENT'. Six more affect the unpacking of pixel
- data FROM memory: `GL_UNPACK_SWAP_BYTES', `GL_UNPACK_LSB_FIRST',
- `GL_UNPACK_ROW_LENGTH', `GL_UNPACK_IMAGE_HEIGHT',
- `GL_UNPACK_SKIP_PIXELS', `GL_UNPACK_SKIP_ROWS',
- `GL_UNPACK_SKIP_IMAGES', and `GL_UNPACK_ALIGNMENT'.
-
-PARAM
- Specifies the value that PNAME is set to.
-
-
-Description
-===========
-
-`glPixelStore' sets pixel storage modes that affect the operation of
-subsequent `glDrawPixels' and `glReadPixels' as well as the unpacking of
-polygon stipple patterns (see `glPolygonStipple'), bitmaps (see
-`glBitmap'), texture patterns (see `glTexImage1D', `glTexImage2D',
-`glTexImage3D', `glTexSubImage1D', `glTexSubImage2D',
-`glTexSubImage3D'). Additionally, if the `ARB_imaging' extension is
-supported, pixel storage modes affect convolution filters (see
-`glConvolutionFilter1D', `glConvolutionFilter2D', and
-`glSeparableFilter2D', color table (see `glColorTable', and
-`glColorSubTable', and unpacking histogram (See `glHistogram'), and
-minmax (See `glMinmax') data.
-
-PNAME is a symbolic constant indicating the parameter to be set, and
-PARAM is the new value. Six of the twelve storage parameters affect how
-pixel data is returned to client memory. They are as follows:
-
-`GL_PACK_SWAP_BYTES'
- If true, byte ordering for multibyte color components, depth
- components, color indices, or stencil indices is reversed. That is,
- if a four-byte component consists of bytes B_0, B_1, B_2, B_3, it
- is stored in memory as B_3, B_2, B_1, B_0 if `GL_PACK_SWAP_BYTES'
- is true. `GL_PACK_SWAP_BYTES' has no effect on the memory order of
- components within a pixel, only on the order of bytes within
- components or indices. For example, the three components of a
- `GL_RGB' format pixel are always stored with red first, green
- second, and blue third, regardless of the value of
- `GL_PACK_SWAP_BYTES'.
-
-`GL_PACK_LSB_FIRST'
- If true, bits are ordered within a byte from least significant to
- most significant; otherwise, the first bit in each byte is the most
- significant one. This parameter is significant for bitmap data
- only.
-
-`GL_PACK_ROW_LENGTH'
- If greater than 0, `GL_PACK_ROW_LENGTH' defines the number of
- pixels in a row. If the first pixel of a row is placed at location
- P in memory, then the location of the first pixel of the next row
- is obtained by skipping
-
- K={(N\u2062L), (A/S,\u2062⌈S\u2062N\u2062L,/A,⌉)\u2062(S>=A), (S<A),
-
- components or indices, where N is the number of components or
- indices in a pixel, L is the number of pixels in a row
- (`GL_PACK_ROW_LENGTH' if it is greater than 0, the WIDTH argument
- to the pixel routine otherwise), A is the value of
- `GL_PACK_ALIGNMENT', and S is the size, in bytes, of a single
- component (if A<S, then it is as if A=S). In the case of 1-bit
- values, the location of the next row is obtained by skipping
-
- K=8\u2062A\u2062⌈N\u2062L,/8\u2062A,,⌉
-
- components or indices.
-
- The word COMPONENT in this description refers to the nonindex
- values red, green, blue, alpha, and depth. Storage format `GL_RGB',
- for example, has three components per pixel: first red, then green,
- and finally blue.
-
-`GL_PACK_IMAGE_HEIGHT'
- If greater than 0, `GL_PACK_IMAGE_HEIGHT' defines the number of
- pixels in an image three-dimensional texture volume, where
- ``image'' is defined by all pixels sharing the same third dimension
- index. If the first pixel of a row is placed at location P in
- memory, then the location of the first pixel of the next row is
- obtained by skipping
-
- K={(N\u2062L\u2062H), (A/S,\u2062⌈S\u2062N\u2062L\u2062H,/A,⌉)\u2062(S>=A), (S<A),
-
- components or indices, where N is the number of components or
- indices in a pixel, L is the number of pixels in a row
- (`GL_PACK_ROW_LENGTH' if it is greater than 0, the WIDTH argument
- to `glTexImage3D' otherwise), H is the number of rows in a pixel
- image (`GL_PACK_IMAGE_HEIGHT' if it is greater than 0, the HEIGHT
- argument to the `glTexImage3D' routine otherwise), A is the value
- of `GL_PACK_ALIGNMENT', and S is the size, in bytes, of a single
- component (if A<S, then it is as if A=S).
-
- The word COMPONENT in this description refers to the nonindex
- values red, green, blue, alpha, and depth. Storage format `GL_RGB',
- for example, has three components per pixel: first red, then green,
- and finally blue.
-
-`GL_PACK_SKIP_PIXELS', `GL_PACK_SKIP_ROWS', and `GL_PACK_SKIP_IMAGES'
- These values are provided as a convenience to the programmer; they
- provide no functionality that cannot be duplicated simply by
- incrementing the pointer passed to `glReadPixels'. Setting
- `GL_PACK_SKIP_PIXELS' to I is equivalent to incrementing the
- pointer by I\u2062N components or indices, where N is the number of
- components or indices in each pixel. Setting `GL_PACK_SKIP_ROWS' to
- J is equivalent to incrementing the pointer by J\u2062M components or
- indices, where M is the number of components or indices per row, as
- just computed in the `GL_PACK_ROW_LENGTH' section. Setting
- `GL_PACK_SKIP_IMAGES' to K is equivalent to incrementing the
- pointer by K\u2062P, where P is the number of components or indices per
- image, as computed in the `GL_PACK_IMAGE_HEIGHT' section.
-
-`GL_PACK_ALIGNMENT'
- Specifies the alignment requirements for the start of each pixel
- row in memory. The allowable values are 1 (byte-alignment), 2 (rows
- aligned to even-numbered bytes), 4 (word-alignment), and 8 (rows
- start on double-word boundaries).
-
-The other six of the twelve storage parameters affect how pixel data is
-read from client memory. These values are significant for
-`glDrawPixels', `glTexImage1D', `glTexImage2D', `glTexImage3D',
-`glTexSubImage1D', `glTexSubImage2D', `glTexSubImage3D', `glBitmap', and
-`glPolygonStipple'.
-
-Additionally, if the `ARB_imaging' extension is supported,
-`glColorTable', `glColorSubTable', `glConvolutionFilter1D',
-`glConvolutionFilter2D', and `glSeparableFilter2D'. They are as follows:
-
-`GL_UNPACK_SWAP_BYTES'
- If true, byte ordering for multibyte color components, depth
- components, color indices, or stencil indices is reversed. That is,
- if a four-byte component consists of bytes B_0, B_1, B_2, B_3, it
- is taken from memory as B_3, B_2, B_1, B_0 if
- `GL_UNPACK_SWAP_BYTES' is true. `GL_UNPACK_SWAP_BYTES' has no
- effect on the memory order of components within a pixel, only on
- the order of bytes within components or indices. For example, the
- three components of a `GL_RGB' format pixel are always stored with
- red first, green second, and blue third, regardless of the value of
- `GL_UNPACK_SWAP_BYTES'.
-
-`GL_UNPACK_LSB_FIRST'
- If true, bits are ordered within a byte from least significant to
- most significant; otherwise, the first bit in each byte is the most
- significant one. This is relevant only for bitmap data.
-
-`GL_UNPACK_ROW_LENGTH'
- If greater than 0, `GL_UNPACK_ROW_LENGTH' defines the number of
- pixels in a row. If the first pixel of a row is placed at location
- P in memory, then the location of the first pixel of the next row
- is obtained by skipping
-
- K={(N\u2062L), (A/S,\u2062⌈S\u2062N\u2062L,/A,⌉)\u2062(S>=A), (S<A),
-
- components or indices, where N is the number of components or
- indices in a pixel, L is the number of pixels in a row
- (`GL_UNPACK_ROW_LENGTH' if it is greater than 0, the WIDTH argument
- to the pixel routine otherwise), A is the value of
- `GL_UNPACK_ALIGNMENT', and S is the size, in bytes, of a single
- component (if A<S, then it is as if A=S). In the case of 1-bit
- values, the location of the next row is obtained by skipping
-
- K=8\u2062A\u2062⌈N\u2062L,/8\u2062A,,⌉
-
- components or indices.
-
- The word COMPONENT in this description refers to the nonindex
- values red, green, blue, alpha, and depth. Storage format `GL_RGB',
- for example, has three components per pixel: first red, then green,
- and finally blue.
-
-`GL_UNPACK_IMAGE_HEIGHT'
- If greater than 0, `GL_UNPACK_IMAGE_HEIGHT' defines the number of
- pixels in an image of a three-dimensional texture volume. Where
- ``image'' is defined by all pixel sharing the same third dimension
- index. If the first pixel of a row is placed at location P in
- memory, then the location of the first pixel of the next row is
- obtained by skipping
-
- K={(N\u2062L\u2062H), (A/S,\u2062⌈S\u2062N\u2062L\u2062H,/A,⌉)\u2062(S>=A), (S<A),
-
- components or indices, where N is the number of components or
- indices in a pixel, L is the number of pixels in a row
- (`GL_UNPACK_ROW_LENGTH' if it is greater than 0, the WIDTH argument
- to `glTexImage3D' otherwise), H is the number of rows in an image
- (`GL_UNPACK_IMAGE_HEIGHT' if it is greater than 0, the HEIGHT
- argument to `glTexImage3D' otherwise), A is the value of
- `GL_UNPACK_ALIGNMENT', and S is the size, in bytes, of a single
- component (if A<S, then it is as if A=S).
-
- The word COMPONENT in this description refers to the nonindex
- values red, green, blue, alpha, and depth. Storage format `GL_RGB',
- for example, has three components per pixel: first red, then green,
- and finally blue.
-
-`GL_UNPACK_SKIP_PIXELS' and `GL_UNPACK_SKIP_ROWS'
- These values are provided as a convenience to the programmer; they
- provide no functionality that cannot be duplicated by incrementing
- the pointer passed to `glDrawPixels', `glTexImage1D',
- `glTexImage2D', `glTexSubImage1D', `glTexSubImage2D', `glBitmap',
- or `glPolygonStipple'. Setting `GL_UNPACK_SKIP_PIXELS' to I is
- equivalent to incrementing the pointer by I\u2062N components or
- indices, where N is the number of components or indices in each
- pixel. Setting `GL_UNPACK_SKIP_ROWS' to J is equivalent to
- incrementing the pointer by J\u2062K components or indices, where K is
- the number of components or indices per row, as just computed in
- the `GL_UNPACK_ROW_LENGTH' section.
-
-`GL_UNPACK_ALIGNMENT'
- Specifies the alignment requirements for the start of each pixel
- row in memory. The allowable values are 1 (byte-alignment), 2 (rows
- aligned to even-numbered bytes), 4 (word-alignment), and 8 (rows
- start on double-word boundaries).
-
-The following table gives the type, initial value, and range of valid
-values for each storage parameter that can be set with `glPixelStore'.
-
-
-
-*PNAME*
-*
-Type *, *
-Initial Value *, *
-Valid Range *`GL_PACK_SWAP_BYTES'
-
-boolean ,
-false ,
-true or false `GL_PACK_LSB_FIRST'
-
-boolean ,
-false ,
-true or false `GL_PACK_ROW_LENGTH'
-
-integer ,
-0 , [0,∞)`GL_PACK_IMAGE_HEIGHT'
-
-integer ,
-0 , [0,∞)`GL_PACK_SKIP_ROWS'
-
-integer ,
-0 , [0,∞)`GL_PACK_SKIP_PIXELS'
-
-integer ,
-0 , [0,∞)`GL_PACK_SKIP_IMAGES'
-
-integer ,
-0 , [0,∞)`GL_PACK_ALIGNMENT'
-
-integer ,
-4 ,
-1, 2, 4, or 8 `GL_UNPACK_SWAP_BYTES'
-
-boolean ,
-false ,
-true or false `GL_UNPACK_LSB_FIRST'
-
-boolean ,
-false ,
-true or false `GL_UNPACK_ROW_LENGTH'
-
-integer ,
-0 , [0,∞)`GL_UNPACK_IMAGE_HEIGHT'
-
-integer ,
-0 , [0,∞)`GL_UNPACK_SKIP_ROWS'
-
-integer ,
-0 , [0,∞)`GL_UNPACK_SKIP_PIXELS'
-
-integer ,
-0 , [0,∞)`GL_UNPACK_SKIP_IMAGES'
-
-integer ,
-0 , [0,∞)`GL_UNPACK_ALIGNMENT'
-
-integer ,
-4 ,
-1, 2, 4, or 8 `glPixelStoref' can be used to set any pixel store parameter. If the
-parameter type is boolean, then if PARAM is 0, the parameter is false;
-otherwise it is set to true. If PNAME is a integer type parameter, PARAM
-is rounded to the nearest integer.
-
-Likewise, `glPixelStorei' can also be used to set any of the pixel store
-parameters. Boolean parameters are set to false if PARAM is 0 and true
-otherwise.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if PNAME is not an accepted value.
-
-`GL_INVALID_VALUE' is generated if a negative row length, pixel skip, or
-row skip value is specified, or if alignment is specified as other than
-1, 2, 4, or 8.
-
-`GL_INVALID_OPERATION' is generated if `glPixelStore' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glPixelTransfer
- "glPixelTransfer"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glPixelTransferf"))
- (paramdef "GLenum " (parameter "pname"))
- (paramdef "GLfloat " (parameter "param"))))
- "set pixel transfer modes
-========================
-
-
-Parameters
-==========
-
-PNAME
- Specifies the symbolic name of the pixel transfer parameter to be
- set. Must be one of the following: `GL_MAP_COLOR',
- `GL_MAP_STENCIL', `GL_INDEX_SHIFT', `GL_INDEX_OFFSET',
- `GL_RED_SCALE', `GL_RED_BIAS', `GL_GREEN_SCALE', `GL_GREEN_BIAS',
- `GL_BLUE_SCALE', `GL_BLUE_BIAS', `GL_ALPHA_SCALE', `GL_ALPHA_BIAS',
- `GL_DEPTH_SCALE', or `GL_DEPTH_BIAS'.
-
- Additionally, if the `ARB_imaging' extension is supported, the
- following symbolic names are accepted:
- `GL_POST_COLOR_MATRIX_RED_SCALE',
- `GL_POST_COLOR_MATRIX_GREEN_SCALE',
- `GL_POST_COLOR_MATRIX_BLUE_SCALE',
- `GL_POST_COLOR_MATRIX_ALPHA_SCALE',
- `GL_POST_COLOR_MATRIX_RED_BIAS', `GL_POST_COLOR_MATRIX_GREEN_BIAS',
- `GL_POST_COLOR_MATRIX_BLUE_BIAS',
- `GL_POST_COLOR_MATRIX_ALPHA_BIAS', `GL_POST_CONVOLUTION_RED_SCALE',
- `GL_POST_CONVOLUTION_GREEN_SCALE',
- `GL_POST_CONVOLUTION_BLUE_SCALE',
- `GL_POST_CONVOLUTION_ALPHA_SCALE', `GL_POST_CONVOLUTION_RED_BIAS',
- `GL_POST_CONVOLUTION_GREEN_BIAS', `GL_POST_CONVOLUTION_BLUE_BIAS',
- and `GL_POST_CONVOLUTION_ALPHA_BIAS'.
-
-PARAM
- Specifies the value that PNAME is set to.
-
-
-Description
-===========
-
-`glPixelTransfer' sets pixel transfer modes that affect the operation of
-subsequent `glCopyPixels', `glCopyTexImage1D', `glCopyTexImage2D',
-`glCopyTexSubImage1D', `glCopyTexSubImage2D', `glCopyTexSubImage3D',
-`glDrawPixels', `glReadPixels', `glTexImage1D', `glTexImage2D',
-`glTexImage3D', `glTexSubImage1D', `glTexSubImage2D', and
-`glTexSubImage3D' commands. Additionally, if the `ARB_imaging' subset is
-supported, the routines `glColorTable', `glColorSubTable',
-`glConvolutionFilter1D', `glConvolutionFilter2D', `glHistogram',
-`glMinmax', and `glSeparableFilter2D' are also affected. The algorithms
-that are specified by pixel transfer modes operate on pixels after they
-are read from the frame buffer (`glCopyPixels'`glCopyTexImage1D',
-`glCopyTexImage2D', `glCopyTexSubImage1D', `glCopyTexSubImage2D',
-`glCopyTexSubImage3D', and `glReadPixels'), or unpacked from client
-memory (`glDrawPixels', `glTexImage1D', `glTexImage2D', `glTexImage3D',
-`glTexSubImage1D', `glTexSubImage2D', and `glTexSubImage3D'). Pixel
-transfer operations happen in the same order, and in the same manner,
-regardless of the command that resulted in the pixel operation. Pixel
-storage modes (see `glPixelStore') control the unpacking of pixels being
-read from client memory and the packing of pixels being written back
-into client memory.
-
-Pixel transfer operations handle four fundamental pixel types: COLOR,
-COLOR INDEX, DEPTH, and STENCIL. COLOR pixels consist of four
-floating-point values with unspecified mantissa and exponent sizes,
-scaled such that 0 represents zero intensity and 1 represents full
-intensity. COLOR INDICES comprise a single fixed-point value, with
-unspecified precision to the right of the binary point. DEPTH pixels
-comprise a single floating-point value, with unspecified mantissa and
-exponent sizes, scaled such that 0.0 represents the minimum depth buffer
-value, and 1.0 represents the maximum depth buffer value. Finally,
-STENCIL pixels comprise a single fixed-point value, with unspecified
-precision to the right of the binary point.
-
-The pixel transfer operations performed on the four basic pixel types
-are as follows:
-
-COLOR
- Each of the four color components is multiplied by a scale factor,
- then added to a bias factor. That is, the red component is
- multiplied by `GL_RED_SCALE', then added to `GL_RED_BIAS'; the
- green component is multiplied by `GL_GREEN_SCALE', then added to
- `GL_GREEN_BIAS'; the blue component is multiplied by
- `GL_BLUE_SCALE', then added to `GL_BLUE_BIAS'; and the alpha
- component is multiplied by `GL_ALPHA_SCALE', then added to
- `GL_ALPHA_BIAS'. After all four color components are scaled and
- biased, each is clamped to the range [0,1]. All color, scale, and
- bias values are specified with `glPixelTransfer'.
-
- If `GL_MAP_COLOR' is true, each color component is scaled by the
- size of the corresponding color-to-color map, then replaced by the
- contents of that map indexed by the scaled component. That is, the
- red component is scaled by `GL_PIXEL_MAP_R_TO_R_SIZE', then
- replaced by the contents of `GL_PIXEL_MAP_R_TO_R' indexed by
- itself. The green component is scaled by
- `GL_PIXEL_MAP_G_TO_G_SIZE', then replaced by the contents of
- `GL_PIXEL_MAP_G_TO_G' indexed by itself. The blue component is
- scaled by `GL_PIXEL_MAP_B_TO_B_SIZE', then replaced by the contents
- of `GL_PIXEL_MAP_B_TO_B' indexed by itself. And the alpha component
- is scaled by `GL_PIXEL_MAP_A_TO_A_SIZE', then replaced by the
- contents of `GL_PIXEL_MAP_A_TO_A' indexed by itself. All components
- taken from the maps are then clamped to the range [0,1].
- `GL_MAP_COLOR' is specified with `glPixelTransfer'. The contents of
- the various maps are specified with `glPixelMap'.
-
- If the `ARB_imaging' extension is supported, each of the four color
- components may be scaled and biased after transformation by the
- color matrix. That is, the red component is multiplied by
- `GL_POST_COLOR_MATRIX_RED_SCALE', then added to
- `GL_POST_COLOR_MATRIX_RED_BIAS'; the green component is multiplied
- by `GL_POST_COLOR_MATRIX_GREEN_SCALE', then added to
- `GL_POST_COLOR_MATRIX_GREEN_BIAS'; the blue component is multiplied
- by `GL_POST_COLOR_MATRIX_BLUE_SCALE', then added to
- `GL_POST_COLOR_MATRIX_BLUE_BIAS'; and the alpha component is
- multiplied by `GL_POST_COLOR_MATRIX_ALPHA_SCALE', then added to
- `GL_POST_COLOR_MATRIX_ALPHA_BIAS'. After all four color components
- are scaled and biased, each is clamped to the range [0,1].
-
- Similarly, if the `ARB_imaging' extension is supported, each of the
- four color components may be scaled and biased after processing by
- the enabled convolution filter. That is, the red component is
- multiplied by `GL_POST_CONVOLUTION_RED_SCALE', then added to
- `GL_POST_CONVOLUTION_RED_BIAS'; the green component is multiplied
- by `GL_POST_CONVOLUTION_GREEN_SCALE', then added to
- `GL_POST_CONVOLUTION_GREEN_BIAS'; the blue component is multiplied
- by `GL_POST_CONVOLUTION_BLUE_SCALE', then added to
- `GL_POST_CONVOLUTION_BLUE_BIAS'; and the alpha component is
- multiplied by `GL_POST_CONVOLUTION_ALPHA_SCALE', then added to
- `GL_POST_CONVOLUTION_ALPHA_BIAS'. After all four color components
- are scaled and biased, each is clamped to the range [0,1].
-
-COLOR INDEX
- Each color index is shifted left by `GL_INDEX_SHIFT' bits; any bits
- beyond the number of fraction bits carried by the fixed-point index
- are filled with zeros. If `GL_INDEX_SHIFT' is negative, the shift
- is to the right, again zero filled. Then `GL_INDEX_OFFSET' is added
- to the index. `GL_INDEX_SHIFT' and `GL_INDEX_OFFSET' are specified
- with `glPixelTransfer'.
-
- From this point, operation diverges depending on the required
- format of the resulting pixels. If the resulting pixels are to be
- written to a color index buffer, or if they are being read back to
- client memory in `GL_COLOR_INDEX' format, the pixels continue to be
- treated as indices. If `GL_MAP_COLOR' is true, each index is masked
- by 2^N-1, where N is `GL_PIXEL_MAP_I_TO_I_SIZE', then replaced by
- the contents of `GL_PIXEL_MAP_I_TO_I' indexed by the masked value.
- `GL_MAP_COLOR' is specified with `glPixelTransfer'. The contents of
- the index map is specified with `glPixelMap'.
-
- If the resulting pixels are to be written to an RGBA color buffer,
- or if they are read back to client memory in a format other than
- `GL_COLOR_INDEX', the pixels are converted from indices to colors
- by referencing the four maps `GL_PIXEL_MAP_I_TO_R',
- `GL_PIXEL_MAP_I_TO_G', `GL_PIXEL_MAP_I_TO_B', and
- `GL_PIXEL_MAP_I_TO_A'. Before being dereferenced, the index is
- masked by 2^N-1, where N is `GL_PIXEL_MAP_I_TO_R_SIZE' for the red
- map, `GL_PIXEL_MAP_I_TO_G_SIZE' for the green map,
- `GL_PIXEL_MAP_I_TO_B_SIZE' for the blue map, and
- `GL_PIXEL_MAP_I_TO_A_SIZE' for the alpha map. All components taken
- from the maps are then clamped to the range [0,1]. The contents of
- the four maps is specified with `glPixelMap'.
-
-DEPTH
- Each depth value is multiplied by `GL_DEPTH_SCALE', added to
- `GL_DEPTH_BIAS', then clamped to the range [0,1].
-
-STENCIL
- Each index is shifted `GL_INDEX_SHIFT' bits just as a color index
- is, then added to `GL_INDEX_OFFSET'. If `GL_MAP_STENCIL' is true,
- each index is masked by 2^N-1, where N is
- `GL_PIXEL_MAP_S_TO_S_SIZE', then replaced by the contents of
- `GL_PIXEL_MAP_S_TO_S' indexed by the masked value.
-
-The following table gives the type, initial value, and range of valid
-values for each of the pixel transfer parameters that are set with
-`glPixelTransfer'.
-
-
-
-*PNAME*
-*
-Type *, *
-Initial Value *, *
-Valid Range *`GL_MAP_COLOR'
-
-boolean ,
-false ,
-true/false `GL_MAP_STENCIL'
-
-boolean ,
-false ,
-true/false `GL_INDEX_SHIFT'
-
-integer ,
-0 , (-∞,∞)`GL_INDEX_OFFSET'
-
-integer ,
-0 , (-∞,∞)`GL_RED_SCALE'
-
-float ,
-1 , (-∞,∞)`GL_GREEN_SCALE'
-
-float ,
-1 , (-∞,∞)`GL_BLUE_SCALE'
-
-float ,
-1 , (-∞,∞)`GL_ALPHA_SCALE'
-
-float ,
-1 , (-∞,∞)`GL_DEPTH_SCALE'
-
-float ,
-1 , (-∞,∞)`GL_RED_BIAS'
-
-float ,
-0 , (-∞,∞)`GL_GREEN_BIAS'
-
-float ,
-0 , (-∞,∞)`GL_BLUE_BIAS'
-
-float ,
-0 , (-∞,∞)`GL_ALPHA_BIAS'
-
-float ,
-0 , (-∞,∞)`GL_DEPTH_BIAS'
-
-float ,
-0 , (-∞,∞)`GL_POST_COLOR_MATRIX_RED_SCALE'
-
-float ,
-1 , (-∞,∞)`GL_POST_COLOR_MATRIX_GREEN_SCALE'
-
-float ,
-1 , (-∞,∞)`GL_POST_COLOR_MATRIX_BLUE_SCALE'
-
-float ,
-1 , (-∞,∞)`GL_POST_COLOR_MATRIX_ALPHA_SCALE'
-
-float ,
-1 , (-∞,∞)`GL_POST_COLOR_MATRIX_RED_BIAS'
-
-float ,
-0 , (-∞,∞)`GL_POST_COLOR_MATRIX_GREEN_BIAS'
-
-float ,
-0 , (-∞,∞)`GL_POST_COLOR_MATRIX_BLUE_BIAS'
-
-float ,
-0 , (-∞,∞)`GL_POST_COLOR_MATRIX_ALPHA_BIAS'
-
-float ,
-0 , (-∞,∞)`GL_POST_CONVOLUTION_RED_SCALE'
-
-float ,
-1 , (-∞,∞)`GL_POST_CONVOLUTION_GREEN_SCALE'
-
-float ,
-1 , (-∞,∞)`GL_POST_CONVOLUTION_BLUE_SCALE'
-
-float ,
-1 , (-∞,∞)`GL_POST_CONVOLUTION_ALPHA_SCALE'
-
-float ,
-1 , (-∞,∞)`GL_POST_CONVOLUTION_RED_BIAS'
-
-float ,
-0 , (-∞,∞)`GL_POST_CONVOLUTION_GREEN_BIAS'
-
-float ,
-0 , (-∞,∞)`GL_POST_CONVOLUTION_BLUE_BIAS'
-
-float ,
-0 , (-∞,∞)`GL_POST_CONVOLUTION_ALPHA_BIAS'
-
-float ,
-0 , (-∞,∞)`glPixelTransferf' can be used to set any pixel transfer parameter. If
-the parameter type is boolean, 0 implies false and any other value
-implies true. If PNAME is an integer parameter, PARAM is rounded to the
-nearest integer.
-
-Likewise, `glPixelTransferi' can be used to set any of the pixel
-transfer parameters. Boolean parameters are set to false if PARAM is 0
-and to true otherwise. PARAM is converted to floating point before being
-assigned to real-valued parameters.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if PNAME is not an accepted value.
-
-`GL_INVALID_OPERATION' is generated if `glPixelTransfer' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glPixelZoom
- "glPixelZoom"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glPixelZoom"))
- (paramdef "GLfloat " (parameter "xfactor"))
- (paramdef "GLfloat " (parameter "yfactor"))))
- "specify the pixel zoom factors
-==============================
-
-
-Parameters
-==========
-
-XFACTOR
- YFACTOR
-
- Specify the X and Y zoom factors for pixel write operations.
-
-
-Description
-===========
-
-`glPixelZoom' specifies values for the X and Y zoom factors. During the
-execution of `glDrawPixels' or `glCopyPixels', if (XR, YR) is the
-current raster position, and a given element is in the Mth row and Nth
-column of the pixel rectangle, then pixels whose centers are in the
-rectangle with corners at
-
-(XR+N·XFACTOR, YR+M·YFACTOR)
-
-(XR+(N+1,)·XFACTOR, YR+(M+1,)·YFACTOR)
-
-are candidates for replacement. Any pixel whose center lies on the
-bottom or left edge of this rectangular region is also modified.
-
-Pixel zoom factors are not limited to positive values. Negative zoom
-factors reflect the resulting image about the current raster position.
-
-
-Errors
-======
-
-`GL_INVALID_OPERATION' is generated if `glPixelZoom' is executed between
-the execution of `glBegin' and the corresponding execution of `glEnd'.")
-
-(define-gl-procedure
- glPointParameter
- "glPointParameter"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glPointParameterf"))
- (paramdef "GLenum " (parameter "pname"))
- (paramdef "GLfloat " (parameter "param"))))
- "specify point parameters
-========================
-
-
-Parameters
-==========
-
-PNAME
- Specifies a single-valued point parameter. `GL_POINT_SIZE_MIN',
- `GL_POINT_SIZE_MAX', `GL_POINT_FADE_THRESHOLD_SIZE', and
- `GL_POINT_SPRITE_COORD_ORIGIN' are accepted.
-
-PARAM
- Specifies the value that PNAME will be set to.
-
-
-Description
-===========
-
-The following values are accepted for PNAME:
-
-`GL_POINT_SIZE_MIN'
-
-
- PARAMS is a single floating-point value that specifies the minimum
- point size. The default value is 0.0.
-
-`GL_POINT_SIZE_MAX'
-
-
- PARAMS is a single floating-point value that specifies the maximum
- point size. The default value is 1.0.
-
-`GL_POINT_FADE_THRESHOLD_SIZE'
-
-
- PARAMS is a single floating-point value that specifies the
- threshold value to which point sizes are clamped if they exceed the
- specified value. The default value is 1.0.
-
-`GL_POINT_DISTANCE_ATTENUATION'
-
-
- PARAMS is an array of three floating-point values that specify the
- coefficients used for scaling the computed point size. The default
- values are (1,00).
-
-`GL_POINT_SPRITE_COORD_ORIGIN'
-
-
- PARAMS is a single enum specifying the point sprite texture
- coordinate origin, either `GL_LOWER_LEFT' or `GL_UPPER_LEFT'. The
- default value is `GL_UPPER_LEFT'.
-
-
-Errors
-======
-
-`GL_INVALID_VALUE' is generated If the value specified for
-`GL_POINT_SIZE_MIN', `GL_POINT_SIZE_MAX', or
-`GL_POINT_FADE_THRESHOLD_SIZE' is less than zero.
-
-`GL_INVALID_ENUM' is generated If the value specified for
-`GL_POINT_SPRITE_COORD_ORIGIN' is not `GL_LOWER_LEFT' or
-`GL_UPPER_LEFT'.
-
-If the value for `GL_POINT_SIZE_MIN' is greater than
-`GL_POINT_SIZE_MAX', the point size after clamping is undefined, but no
-error is generated.")
-
-(define-gl-procedure
- glPointSize
- "glPointSize"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glPointSize"))
- (paramdef "GLfloat " (parameter "size"))))
- "specify the diameter of rasterized points
-=========================================
-
-
-Parameters
-==========
-
-SIZE
- Specifies the diameter of rasterized points. The initial value is
- 1.
-
-
-Description
-===========
-
-`glPointSize' specifies the rasterized diameter of both aliased and
-antialiased points. Using a point size other than 1 has different
-effects, depending on whether point antialiasing is enabled. To enable
-and disable point antialiasing, call `glEnable' and `glDisable' with
-argument `GL_POINT_SMOOTH'. Point antialiasing is initially disabled.
-
-The specified point size is multiplied with a distance attenuation
-factor and clamped to the specified point size range, and further
-clamped to the implementation-dependent point size range to produce the
-derived point size using
-
-POINTSIZE=CLAMP\u2062(SIZE×√(1/A+B×D+C×D^2,,,),,)
-
-where D is the eye-coordinate distance from the eye to the vertex, and
-A, B, and C are the distance attenuation coefficients (see
-`glPointParameter').
-
-If multisampling is disabled, the computed point size is used as the
-point's width.
-
-If multisampling is enabled, the point may be faded by modifying the
-point alpha value (see `glSampleCoverage') instead of allowing the point
-width to go below a given threshold (see `glPointParameter'). In this
-case, the width is further modified in the following manner:
-
-POINTWIDTH={(POINTSIZE), (THRESHOLD)\u2062(POINTSIZE>=THRESHOLD),
-(OTHERWISE),
-
-The point alpha value is modified by computing:
-
-POINTALPHA={(1), ((POINTSIZE/THRESHOLD,)^2)\u2062(POINTSIZE>=THRESHOLD),
-(OTHERWISE),
-
-If point antialiasing is disabled, the actual size is determined by
-rounding the supplied size to the nearest integer. (If the rounding
-results in the value 0, it is as if the point size were 1.) If the
-rounded size is odd, then the center point (X, Y) of the pixel fragment
-that represents the point is computed as
-
-(⌊X_W,⌋+.5,⌊Y_W,⌋+.5)
-
-where W subscripts indicate window coordinates. All pixels that lie
-within the square grid of the rounded size centered at (X, Y) make up
-the fragment. If the size is even, the center point is
-
-(⌊X_W+.5,⌋,⌊Y_W+.5,⌋)
-
-and the rasterized fragment's centers are the half-integer window
-coordinates within the square of the rounded size centered at (X,Y). All
-pixel fragments produced in rasterizing a nonantialiased point are
-assigned the same associated data, that of the vertex corresponding to
-the point.
-
-If antialiasing is enabled, then point rasterization produces a fragment
-for each pixel square that intersects the region lying within the circle
-having diameter equal to the current point size and centered at the
-point's (X_W,Y_W). The coverage value for each fragment is the window
-coordinate area of the intersection of the circular region with the
-corresponding pixel square. This value is saved and used in the final
-rasterization step. The data associated with each fragment is the data
-associated with the point being rasterized.
-
-Not all sizes are supported when point antialiasing is enabled. If an
-unsupported size is requested, the nearest supported size is used. Only
-size 1 is guaranteed to be supported; others depend on the
-implementation. To query the range of supported sizes and the size
-difference between supported sizes within the range, call `glGet' with
-arguments `GL_SMOOTH_POINT_SIZE_RANGE' and
-`GL_SMOOTH_POINT_SIZE_GRANULARITY'. For aliased points, query the
-supported ranges and granularity with `glGet' with arguments
-`GL_ALIASED_POINT_SIZE_RANGE'.
-
-
-Errors
-======
-
-`GL_INVALID_VALUE' is generated if SIZE is less than or equal to 0.
-
-`GL_INVALID_OPERATION' is generated if `glPointSize' is executed between
-the execution of `glBegin' and the corresponding execution of `glEnd'.")
-
-(define-gl-procedure
- glPolygonMode
- "glPolygonMode"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glPolygonMode"))
- (paramdef "GLenum " (parameter "face"))
- (paramdef "GLenum " (parameter "mode"))))
- "select a polygon rasterization mode
-===================================
-
-
-Parameters
-==========
-
-FACE
- Specifies the polygons that MODE applies to. Must be `GL_FRONT' for
- front-facing polygons, `GL_BACK' for back-facing polygons, or
- `GL_FRONT_AND_BACK' for front- and back-facing polygons.
-
-MODE
- Specifies how polygons will be rasterized. Accepted values are
- `GL_POINT', `GL_LINE', and `GL_FILL'. The initial value is
- `GL_FILL' for both front- and back-facing polygons.
-
-
-Description
-===========
-
-`glPolygonMode' controls the interpretation of polygons for
-rasterization. FACE describes which polygons MODE applies to:
-front-facing polygons (`GL_FRONT'), back-facing polygons (`GL_BACK'), or
-both (`GL_FRONT_AND_BACK'). The polygon mode affects only the final
-rasterization of polygons. In particular, a polygon's vertices are lit
-and the polygon is clipped and possibly culled before these modes are
-applied.
-
-Three modes are defined and can be specified in MODE:
-
-`GL_POINT'
- Polygon vertices that are marked as the start of a boundary edge
- are drawn as points. Point attributes such as `GL_POINT_SIZE' and
- `GL_POINT_SMOOTH' control the rasterization of the points. Polygon
- rasterization attributes other than `GL_POLYGON_MODE' have no
- effect.
-
-`GL_LINE'
- Boundary edges of the polygon are drawn as line segments. They are
- treated as connected line segments for line stippling; the line
- stipple counter and pattern are not reset between segments (see
- `glLineStipple'). Line attributes such as `GL_LINE_WIDTH' and
- `GL_LINE_SMOOTH' control the rasterization of the lines. Polygon
- rasterization attributes other than `GL_POLYGON_MODE' have no
- effect.
-
-`GL_FILL'
- The interior of the polygon is filled. Polygon attributes such as
- `GL_POLYGON_STIPPLE' and `GL_POLYGON_SMOOTH' control the
- rasterization of the polygon.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if either FACE or MODE is not an accepted
-value.
-
-`GL_INVALID_OPERATION' is generated if `glPolygonMode' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glPolygonOffset
- "glPolygonOffset"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glPolygonOffset"))
- (paramdef "GLfloat " (parameter "factor"))
- (paramdef "GLfloat " (parameter "units"))))
- "set the scale and units used to calculate depth values
-======================================================
-
-
-Parameters
-==========
-
-FACTOR
- Specifies a scale factor that is used to create a variable depth
- offset for each polygon. The initial value is 0.
-
-UNITS
- Is multiplied by an implementation-specific value to create a
- constant depth offset. The initial value is 0.
-
-
-Description
-===========
-
-When `GL_POLYGON_OFFSET_FILL', `GL_POLYGON_OFFSET_LINE', or
-`GL_POLYGON_OFFSET_POINT' is enabled, each fragment's DEPTH value will
-be offset after it is interpolated from the DEPTH values of the
-appropriate vertices. The value of the offset is FACTOR×DZ+R×UNITS,
-where DZ is a measurement of the change in depth relative to the screen
-area of the polygon, and R is the smallest value that is guaranteed to
-produce a resolvable offset for a given implementation. The offset is
-added before the depth test is performed and before the value is written
-into the depth buffer.
-
-`glPolygonOffset' is useful for rendering hidden-line images, for
-applying decals to surfaces, and for rendering solids with highlighted
-edges.
-
-
-Errors
-======
-
-`GL_INVALID_OPERATION' is generated if `glPolygonOffset' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glPolygonStipple
- "glPolygonStipple"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glPolygonStipple"))
- (paramdef
- "const GLubyte * "
- (parameter "pattern"))))
- "set the polygon stippling pattern
-=================================
-
-
-Parameters
-==========
-
-PATTERN
- Specifies a pointer to a 32×32 stipple pattern that will be
- unpacked from memory in the same way that `glDrawPixels' unpacks
- pixels.
-
-
-Description
-===========
-
-Polygon stippling, like line stippling (see `glLineStipple'), masks out
-certain fragments produced by rasterization, creating a pattern.
-Stippling is independent of polygon antialiasing.
-
-PATTERN is a pointer to a 32×32 stipple pattern that is stored in memory
-just like the pixel data supplied to a `glDrawPixels' call with height
-and WIDTH both equal to 32, a pixel format of `GL_COLOR_INDEX', and data
-type of `GL_BITMAP'. That is, the stipple pattern is represented as a
-32×32 array of 1-bit color indices packed in unsigned bytes.
-`glPixelStore' parameters like `GL_UNPACK_SWAP_BYTES' and
-`GL_UNPACK_LSB_FIRST' affect the assembling of the bits into a stipple
-pattern. Pixel transfer operations (shift, offset, pixel map) are not
-applied to the stipple image, however.
-
-If a non-zero named buffer object is bound to the
-`GL_PIXEL_UNPACK_BUFFER' target (see `glBindBuffer') while a stipple
-pattern is specified, PATTERN is treated as a byte offset into the
-buffer object's data store.
-
-To enable and disable polygon stippling, call `glEnable' and `glDisable'
-with argument `GL_POLYGON_STIPPLE'. Polygon stippling is initially
-disabled. If it's enabled, a rasterized polygon fragment with window
-coordinates X_W and Y_W is sent to the next stage of the GL if and only
-if the (X_W%32)th bit in the (Y_W%32)th row of the stipple pattern is 1
-(one). When polygon stippling is disabled, it is as if the stipple
-pattern consists of all 1's.
-
-
-Errors
-======
-
-`GL_INVALID_OPERATION' is generated if a non-zero buffer object name is
-bound to the `GL_PIXEL_UNPACK_BUFFER' target and the buffer object's
-data store is currently mapped.
-
-`GL_INVALID_OPERATION' is generated if a non-zero buffer object name is
-bound to the `GL_PIXEL_UNPACK_BUFFER' target and the data would be
-unpacked from the buffer object such that the memory reads required
-would exceed the data store size.
-
-`GL_INVALID_OPERATION' is generated if `glPolygonStipple' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glPrioritizeTextures
- "glPrioritizeTextures"
- (funcsynopsis
- (funcprototype
- (funcdef
- "void "
- (function "glPrioritizeTextures"))
- (paramdef "GLsizei " (parameter "n"))
- (paramdef
- "const GLuint * "
- (parameter "textures"))
- (paramdef
- "const GLclampf * "
- (parameter "priorities"))))
- "set texture residence priority
-==============================
-
-
-Parameters
-==========
-
-N
- Specifies the number of textures to be prioritized.
-
-TEXTURES
- Specifies an array containing the names of the textures to be
- prioritized.
-
-PRIORITIES
- Specifies an array containing the texture priorities. A priority
- given in an element of PRIORITIES applies to the texture named by
- the corresponding element of TEXTURES.
-
-
-Description
-===========
-
-`glPrioritizeTextures' assigns the N texture priorities given in
-PRIORITIES to the N textures named in TEXTURES.
-
-The GL establishes a ``working set'' of textures that are resident in
-texture memory. These textures may be bound to a texture target much
-more efficiently than textures that are not resident. By specifying a
-priority for each texture, `glPrioritizeTextures' allows applications to
-guide the GL implementation in determining which textures should be
-resident.
-
-The priorities given in PRIORITIES are clamped to the range [0,1] before
-they are assigned. 0 indicates the lowest priority; textures with
-priority 0 are least likely to be resident. 1 indicates the highest
-priority; textures with priority 1 are most likely to be resident.
-However, textures are not guaranteed to be resident until they are used.
-
-`glPrioritizeTextures' silently ignores attempts to prioritize texture 0
-or any texture name that does not correspond to an existing texture.
-
-`glPrioritizeTextures' does not require that any of the textures named
-by TEXTURES be bound to a texture target. `glTexParameter' may also be
-used to set a texture's priority, but only if the texture is currently
-bound. This is the only way to set the priority of a default texture.
-
-
-Errors
-======
-
-`GL_INVALID_VALUE' is generated if N is negative.
-
-`GL_INVALID_OPERATION' is generated if `glPrioritizeTextures' is
-executed between the execution of `glBegin' and the corresponding
-execution of `glEnd'.")
-
-(define-gl-procedure
- glPushAttrib
- "glPushAttrib"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glPushAttrib"))
- (paramdef "GLbitfield " (parameter "mask"))))
- "push and pop the server attribute stack
-=======================================
-
-
-Parameters
-==========
-
-MASK
- Specifies a mask that indicates which attributes to save. Values
- for MASK are listed below.
-
-
-Description
-===========
-
-`glPushAttrib' takes one argument, a mask that indicates which groups of
-state variables to save on the attribute stack. Symbolic constants are
-used to set bits in the mask. MASK is typically constructed by
-specifying the bitwise-or of several of these constants together. The
-special mask `GL_ALL_ATTRIB_BITS' can be used to save all stackable
-states.
-
-The symbolic mask constants and their associated GL state are as follows
-(the second column lists which attributes are saved):
-
-
-
-`GL_ACCUM_BUFFER_BIT'
-
-Accumulation buffer clear value `GL_COLOR_BUFFER_BIT'
-`GL_ALPHA_TEST' enable bit
-
-Alpha test function and reference value
-`GL_BLEND' enable bit
-
-Blending source and destination functions
-
-Constant blend color
-
-Blending equation
-`GL_DITHER' enable bit
-`GL_DRAW_BUFFER' setting
-`GL_COLOR_LOGIC_OP' enable bit
-`GL_INDEX_LOGIC_OP' enable bit
-
-Logic op function
-
-Color mode and index mode clear values
-
-Color mode and index mode writemasks `GL_CURRENT_BIT'
-
-Current RGBA color
-
-Current color index
-
-Current normal vector
-
-Current texture coordinates
-
-Current raster position
-`GL_CURRENT_RASTER_POSITION_VALID' flag
-
-RGBA color associated with current raster position
-
-Color index associated with current raster position
-
-Texture coordinates associated with current raster position
-`GL_EDGE_FLAG' flag `GL_DEPTH_BUFFER_BIT'
-`GL_DEPTH_TEST' enable bit
-
-Depth buffer test function
-
-Depth buffer clear value
-`GL_DEPTH_WRITEMASK' enable bit `GL_ENABLE_BIT'
-`GL_ALPHA_TEST' flag
-`GL_AUTO_NORMAL' flag
-`GL_BLEND' flag
-
-Enable bits for the user-definable clipping planes
-`GL_COLOR_MATERIAL'
-`GL_CULL_FACE' flag
-`GL_DEPTH_TEST' flag
-`GL_DITHER' flag
-`GL_FOG' flag
-`GL_LIGHT'I
-where `0' <= I < `GL_MAX_LIGHTS'
-`GL_LIGHTING' flag
-`GL_LINE_SMOOTH' flag
-`GL_LINE_STIPPLE' flag
-`GL_COLOR_LOGIC_OP' flag
-`GL_INDEX_LOGIC_OP' flag
-`GL_MAP1_'X where X is a map type
-`GL_MAP2_'X where X is a map type
-`GL_MULTISAMPLE' flag
-`GL_NORMALIZE' flag
-`GL_POINT_SMOOTH' flag
-`GL_POLYGON_OFFSET_LINE' flag
-`GL_POLYGON_OFFSET_FILL' flag
-`GL_POLYGON_OFFSET_POINT' flag
-`GL_POLYGON_SMOOTH' flag
-`GL_POLYGON_STIPPLE' flag
-`GL_SAMPLE_ALPHA_TO_COVERAGE' flag
-`GL_SAMPLE_ALPHA_TO_ONE' flag
-`GL_SAMPLE_COVERAGE' flag
-`GL_SCISSOR_TEST' flag
-`GL_STENCIL_TEST' flag
-`GL_TEXTURE_1D' flag
-`GL_TEXTURE_2D' flag
-`GL_TEXTURE_3D' flag
-
-Flags `GL_TEXTURE_GEN_'X where X is S, T, R, or Q `GL_EVAL_BIT'
-`GL_MAP1_'X enable bits, where X is a map type
-`GL_MAP2_'X enable bits, where X is a map type
-
-1D grid endpoints and divisions
-
-2D grid endpoints and divisions
-`GL_AUTO_NORMAL' enable bit `GL_FOG_BIT'
-`GL_FOG' enable bit
-
-Fog color
-
-Fog density
-
-Linear fog start
-
-Linear fog end
-
-Fog index
-`GL_FOG_MODE' value `GL_HINT_BIT'
-`GL_PERSPECTIVE_CORRECTION_HINT' setting
-`GL_POINT_SMOOTH_HINT' setting
-`GL_LINE_SMOOTH_HINT' setting
-`GL_POLYGON_SMOOTH_HINT' setting
-`GL_FOG_HINT' setting
-`GL_GENERATE_MIPMAP_HINT' setting
-`GL_TEXTURE_COMPRESSION_HINT' setting `GL_LIGHTING_BIT'
-`GL_COLOR_MATERIAL' enable bit
-`GL_COLOR_MATERIAL_FACE' value
-
-Color material parameters that are tracking the current color
-
-Ambient scene color
-`GL_LIGHT_MODEL_LOCAL_VIEWER' value
-`GL_LIGHT_MODEL_TWO_SIDE' setting
-`GL_LIGHTING' enable bit
-
-Enable bit for each light
-
-Ambient, diffuse, and specular intensity for each light
-
-Direction, position, exponent, and cutoff angle for each light
-
-Constant, linear, and quadratic attenuation factors for each light
-
-Ambient, diffuse, specular, and emissive color for each material
-
-Ambient, diffuse, and specular color indices for each material
-
-Specular exponent for each material
-`GL_SHADE_MODEL' setting `GL_LINE_BIT'
-`GL_LINE_SMOOTH' flag
-`GL_LINE_STIPPLE' enable bit
-
-Line stipple pattern and repeat counter
-
-Line width `GL_LIST_BIT'
-`GL_LIST_BASE' setting `GL_MULTISAMPLE_BIT'
-`GL_MULTISAMPLE' flag
-`GL_SAMPLE_ALPHA_TO_COVERAGE' flag
-`GL_SAMPLE_ALPHA_TO_ONE' flag
-`GL_SAMPLE_COVERAGE' flag
-`GL_SAMPLE_COVERAGE_VALUE' value
-`GL_SAMPLE_COVERAGE_INVERT' value `GL_PIXEL_MODE_BIT'
-`GL_RED_BIAS' and `GL_RED_SCALE' settings
-`GL_GREEN_BIAS' and `GL_GREEN_SCALE' values
-`GL_BLUE_BIAS' and `GL_BLUE_SCALE'
-`GL_ALPHA_BIAS' and `GL_ALPHA_SCALE'
-`GL_DEPTH_BIAS' and `GL_DEPTH_SCALE'
-`GL_INDEX_OFFSET' and `GL_INDEX_SHIFT' values
-`GL_MAP_COLOR' and `GL_MAP_STENCIL' flags
-`GL_ZOOM_X' and `GL_ZOOM_Y' factors
-`GL_READ_BUFFER' setting `GL_POINT_BIT'
-`GL_POINT_SMOOTH' flag
-
-Point size `GL_POLYGON_BIT'
-`GL_CULL_FACE' enable bit
-`GL_CULL_FACE_MODE' value
-`GL_FRONT_FACE' indicator
-`GL_POLYGON_MODE' setting
-`GL_POLYGON_SMOOTH' flag
-`GL_POLYGON_STIPPLE' enable bit
-`GL_POLYGON_OFFSET_FILL' flag
-`GL_POLYGON_OFFSET_LINE' flag
-`GL_POLYGON_OFFSET_POINT' flag
-`GL_POLYGON_OFFSET_FACTOR'
-`GL_POLYGON_OFFSET_UNITS'`GL_POLYGON_STIPPLE_BIT'
-
-Polygon stipple image `GL_SCISSOR_BIT'
-`GL_SCISSOR_TEST' flag
-
-Scissor box `GL_STENCIL_BUFFER_BIT'
-`GL_STENCIL_TEST' enable bit
-
-Stencil function and reference value
-
-Stencil value mask
-
-Stencil fail, pass, and depth buffer pass actions
-
-Stencil buffer clear value
-
-Stencil buffer writemask `GL_TEXTURE_BIT'
-
-Enable bits for the four texture coordinates
-
-Border color for each texture image
-
-Minification function for each texture image
-
-Magnification function for each texture image
-
-Texture coordinates and wrap mode for each texture image
-
-Color and mode for each texture environment
-
-Enable bits `GL_TEXTURE_GEN_'X, X is S, T, R, and Q
-`GL_TEXTURE_GEN_MODE' setting for S, T, R, and Q
-`glTexGen' plane equations for S, T, R, and Q
-
-Current texture bindings (for example, `GL_TEXTURE_BINDING_2D') `GL_TRANSFORM_BIT'
-
-Coefficients of the six clipping planes
-
-Enable bits for the user-definable clipping planes
-`GL_MATRIX_MODE' value
-`GL_NORMALIZE' flag
-`GL_RESCALE_NORMAL' flag `GL_VIEWPORT_BIT'
-
-Depth range (near and far)
-
-Viewport origin and extent `glPopAttrib' restores the values of the state variables saved with the
-last `glPushAttrib' command. Those not saved are left unchanged.
-
-It is an error to push attributes onto a full stack or to pop attributes
-off an empty stack. In either case, the error flag is set and no other
-change is made to GL state.
-
-Initially, the attribute stack is empty.
-
-
-Errors
-======
-
-`GL_STACK_OVERFLOW' is generated if `glPushAttrib' is called while the
-attribute stack is full.
-
-`GL_STACK_UNDERFLOW' is generated if `glPopAttrib' is called while the
-attribute stack is empty.
-
-`GL_INVALID_OPERATION' is generated if `glPushAttrib' or `glPopAttrib'
-is executed between the execution of `glBegin' and the corresponding
-execution of `glEnd'.")
-
-(define-gl-procedure
- glPushClientAttrib
- "glPushClientAttrib"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glPushClientAttrib"))
- (paramdef "GLbitfield " (parameter "mask"))))
- "push and pop the client attribute stack
-=======================================
-
-
-Parameters
-==========
-
-MASK
- Specifies a mask that indicates which attributes to save. Values
- for MASK are listed below.
-
-
-Description
-===========
-
-`glPushClientAttrib' takes one argument, a mask that indicates which
-groups of client-state variables to save on the client attribute stack.
-Symbolic constants are used to set bits in the mask. MASK is typically
-constructed by specifying the bitwise-or of several of these constants
-together. The special mask `GL_CLIENT_ALL_ATTRIB_BITS' can be used to
-save all stackable client state.
-
-The symbolic mask constants and their associated GL client state are as
-follows (the second column lists which attributes are saved):
-
-`GL_CLIENT_PIXEL_STORE_BIT' Pixel storage modes
-`GL_CLIENT_VERTEX_ARRAY_BIT' Vertex arrays (and enables)
-
-`glPopClientAttrib' restores the values of the client-state variables
-saved with the last `glPushClientAttrib'. Those not saved are left
-unchanged.
-
-It is an error to push attributes onto a full client attribute stack or
-to pop attributes off an empty stack. In either case, the error flag is
-set, and no other change is made to GL state.
-
-Initially, the client attribute stack is empty.
-
-
-Errors
-======
-
-`GL_STACK_OVERFLOW' is generated if `glPushClientAttrib' is called while
-the attribute stack is full.
-
-`GL_STACK_UNDERFLOW' is generated if `glPopClientAttrib' is called while
-the attribute stack is empty.")
-
-(define-gl-procedure
- glPushMatrix
- "glPushMatrix"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glPushMatrix"))
- (paramdef (parameter "void"))))
- "push and pop the current matrix stack
-=====================================
-
-
-Description
-===========
-
-There is a stack of matrices for each of the matrix modes. In
-`GL_MODELVIEW' mode, the stack depth is at least 32. In the other modes,
-`GL_COLOR', `GL_PROJECTION', and `GL_TEXTURE', the depth is at least 2.
-The current matrix in any mode is the matrix on the top of the stack for
-that mode.
-
-`glPushMatrix' pushes the current matrix stack down by one, duplicating
-the current matrix. That is, after a `glPushMatrix' call, the matrix on
-top of the stack is identical to the one below it.
-
-`glPopMatrix' pops the current matrix stack, replacing the current
-matrix with the one below it on the stack.
-
-Initially, each of the stacks contains one matrix, an identity matrix.
-
-It is an error to push a full matrix stack or to pop a matrix stack that
-contains only a single matrix. In either case, the error flag is set and
-no other change is made to GL state.
-
-
-Errors
-======
-
-`GL_STACK_OVERFLOW' is generated if `glPushMatrix' is called while the
-current matrix stack is full.
-
-`GL_STACK_UNDERFLOW' is generated if `glPopMatrix' is called while the
-current matrix stack contains only a single matrix.
-
-`GL_INVALID_OPERATION' is generated if `glPushMatrix' or `glPopMatrix'
-is executed between the execution of `glBegin' and the corresponding
-execution of `glEnd'.")
-
-(define-gl-procedure
- glPushName
- "glPushName"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glPushName"))
- (paramdef "GLuint " (parameter "name"))))
- "push and pop the name stack
-===========================
-
-
-Parameters
-==========
-
-NAME
- Specifies a name that will be pushed onto the name stack.
-
-
-Description
-===========
-
-The name stack is used during selection mode to allow sets of rendering
-commands to be uniquely identified. It consists of an ordered set of
-unsigned integers and is initially empty.
-
-`glPushName' causes NAME to be pushed onto the name stack. `glPopName'
-pops one name off the top of the stack.
-
-The maximum name stack depth is implementation-dependent; call
-`GL_MAX_NAME_STACK_DEPTH' to find out the value for a particular
-implementation. It is an error to push a name onto a full stack or to
-pop a name off an empty stack. It is also an error to manipulate the
-name stack between the execution of `glBegin' and the corresponding
-execution of `glEnd'. In any of these cases, the error flag is set and
-no other change is made to GL state.
-
-The name stack is always empty while the render mode is not `GL_SELECT'.
-Calls to `glPushName' or `glPopName' while the render mode is not
-`GL_SELECT' are ignored.
-
-
-Errors
-======
-
-`GL_STACK_OVERFLOW' is generated if `glPushName' is called while the
-name stack is full.
-
-`GL_STACK_UNDERFLOW' is generated if `glPopName' is called while the
-name stack is empty.
-
-`GL_INVALID_OPERATION' is generated if `glPushName' or `glPopName' is
-executed between a call to `glBegin' and the corresponding call to
-`glEnd'.")
-
-(define-gl-procedure
- glRasterPos
- "glRasterPos"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glRasterPos2s"))
- (paramdef "GLshort " (parameter "x"))
- (paramdef "GLshort " (parameter "y"))))
- "specify the raster position for pixel operations
-================================================
-
-
-Parameters
-==========
-
-X
- Y
-
- Z
-
- W
-
- Specify the X, Y, Z, and W object coordinates (if present) for the
- raster position.
-
-
-Description
-===========
-
-The GL maintains a 3D position in window coordinates. This position,
-called the raster position, is used to position pixel and bitmap write
-operations. It is maintained with subpixel accuracy. See `glBitmap',
-`glDrawPixels', and `glCopyPixels'.
-
-The current raster position consists of three window coordinates (X, Y,
-Z), a clip coordinate value (W), an eye coordinate distance, a valid
-bit, and associated color data and texture coordinates. The W coordinate
-is a clip coordinate, because W is not projected to window coordinates.
-`glRasterPos4' specifies object coordinates X, Y, Z, and W explicitly.
-`glRasterPos3' specifies object coordinate X, Y, and Z explicitly, while
-W is implicitly set to 1. `glRasterPos2' uses the argument values for X
-and Y while implicitly setting Z and W to 0 and 1.
-
-The object coordinates presented by `glRasterPos' are treated just like
-those of a `glVertex' command: They are transformed by the current
-modelview and projection matrices and passed to the clipping stage. If
-the vertex is not culled, then it is projected and scaled to window
-coordinates, which become the new current raster position, and the
-`GL_CURRENT_RASTER_POSITION_VALID' flag is set. If the vertex IS culled,
-then the valid bit is cleared and the current raster position and
-associated color and texture coordinates are undefined.
-
-The current raster position also includes some associated color data and
-texture coordinates. If lighting is enabled, then
-`GL_CURRENT_RASTER_COLOR' (in RGBA mode) or `GL_CURRENT_RASTER_INDEX'
-(in color index mode) is set to the color produced by the lighting
-calculation (see `glLight', `glLightModel', and `glShadeModel'). If
-lighting is disabled, current color (in RGBA mode, state variable
-`GL_CURRENT_COLOR') or color index (in color index mode, state variable
-`GL_CURRENT_INDEX') is used to update the current raster color.
-`GL_CURRENT_RASTER_SECONDARY_COLOR' (in RGBA mode) is likewise updated.
-
-Likewise, `GL_CURRENT_RASTER_TEXTURE_COORDS' is updated as a function of
-`GL_CURRENT_TEXTURE_COORDS', based on the texture matrix and the texture
-generation functions (see `glTexGen'). Finally, the distance from the
-origin of the eye coordinate system to the vertex as transformed by only
-the modelview matrix replaces `GL_CURRENT_RASTER_DISTANCE'.
-
-Initially, the current raster position is (0, 0, 0, 1), the current
-raster distance is 0, the valid bit is set, the associated RGBA color is
-(1, 1, 1, 1), the associated color index is 1, and the associated
-texture coordinates are (0, 0, 0, 1). In RGBA mode,
-`GL_CURRENT_RASTER_INDEX' is always 1; in color index mode, the current
-raster RGBA color always maintains its initial value.
-
-
-Errors
-======
-
-`GL_INVALID_OPERATION' is generated if `glRasterPos' is executed between
-the execution of `glBegin' and the corresponding execution of `glEnd'.")
-
-(define-gl-procedure
- glReadBuffer
- "glReadBuffer"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glReadBuffer"))
- (paramdef "GLenum " (parameter "mode"))))
- "select a color buffer source for pixels
-=======================================
-
-
-Parameters
-==========
-
-MODE
- Specifies a color buffer. Accepted values are `GL_FRONT_LEFT',
- `GL_FRONT_RIGHT', `GL_BACK_LEFT', `GL_BACK_RIGHT', `GL_FRONT',
- `GL_BACK', `GL_LEFT', `GL_RIGHT', and `GL_AUX'I, where I is between
- 0 and the value of `GL_AUX_BUFFERS' minus 1.
-
-
-Description
-===========
-
-`glReadBuffer' specifies a color buffer as the source for subsequent
-`glReadPixels', `glCopyTexImage1D', `glCopyTexImage2D',
-`glCopyTexSubImage1D', `glCopyTexSubImage2D', `glCopyTexSubImage3D', and
-`glCopyPixels' commands. MODE accepts one of twelve or more predefined
-values. (`GL_AUX0' through `GL_AUX3' are always defined.) In a fully
-configured system, `GL_FRONT', `GL_LEFT', and `GL_FRONT_LEFT' all name
-the front left buffer, `GL_FRONT_RIGHT' and `GL_RIGHT' name the front
-right buffer, and `GL_BACK_LEFT' and `GL_BACK' name the back left
-buffer.
-
-Nonstereo double-buffered configurations have only a front left and a
-back left buffer. Single-buffered configurations have a front left and a
-front right buffer if stereo, and only a front left buffer if nonstereo.
-It is an error to specify a nonexistent buffer to `glReadBuffer'.
-
-MODE is initially `GL_FRONT' in single-buffered configurations and
-`GL_BACK' in double-buffered configurations.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if MODE is not one of the twelve (or
-more) accepted values.
-
-`GL_INVALID_OPERATION' is generated if MODE specifies a buffer that does
-not exist.
-
-`GL_INVALID_OPERATION' is generated if `glReadBuffer' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glReadPixels
- "glReadPixels"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glReadPixels"))
- (paramdef "GLint " (parameter "x"))
- (paramdef "GLint " (parameter "y"))
- (paramdef "GLsizei " (parameter "width"))
- (paramdef "GLsizei " (parameter "height"))
- (paramdef "GLenum " (parameter "format"))
- (paramdef "GLenum " (parameter "type"))
- (paramdef "GLvoid * " (parameter "data"))))
- "read a block of pixels from the frame buffer
-============================================
-
-
-Parameters
-==========
-
-X
- Y
-
- Specify the window coordinates of the first pixel that is read from
- the frame buffer. This location is the lower left corner of a
- rectangular block of pixels.
-
-WIDTH
- HEIGHT
-
- Specify the dimensions of the pixel rectangle. WIDTH and HEIGHT of
- one correspond to a single pixel.
-
-FORMAT
- Specifies the format of the pixel data. The following symbolic
- values are accepted: `GL_COLOR_INDEX', `GL_STENCIL_INDEX',
- `GL_DEPTH_COMPONENT', `GL_RED', `GL_GREEN', `GL_BLUE', `GL_ALPHA',
- `GL_RGB', `GL_BGR', `GL_RGBA', `GL_BGRA', `GL_LUMINANCE', and
- `GL_LUMINANCE_ALPHA'.
-
-TYPE
- Specifies the data type of the pixel data. Must be one of
- `GL_UNSIGNED_BYTE', `GL_BYTE', `GL_BITMAP', `GL_UNSIGNED_SHORT',
- `GL_SHORT', `GL_UNSIGNED_INT', `GL_INT', `GL_FLOAT',
- `GL_UNSIGNED_BYTE_3_3_2', `GL_UNSIGNED_BYTE_2_3_3_REV',
- `GL_UNSIGNED_SHORT_5_6_5', `GL_UNSIGNED_SHORT_5_6_5_REV',
- `GL_UNSIGNED_SHORT_4_4_4_4', `GL_UNSIGNED_SHORT_4_4_4_4_REV',
- `GL_UNSIGNED_SHORT_5_5_5_1', `GL_UNSIGNED_SHORT_1_5_5_5_REV',
- `GL_UNSIGNED_INT_8_8_8_8', `GL_UNSIGNED_INT_8_8_8_8_REV',
- `GL_UNSIGNED_INT_10_10_10_2', or `GL_UNSIGNED_INT_2_10_10_10_REV'.
-
-DATA
- Returns the pixel data.
-
-
-Description
-===========
-
-`glReadPixels' returns pixel data from the frame buffer, starting with
-the pixel whose lower left corner is at location (X, Y), into client
-memory starting at location DATA. Several parameters control the
-processing of the pixel data before it is placed into client memory.
-These parameters are set with three commands: `glPixelStore',
-`glPixelTransfer', and `glPixelMap'. This reference page describes the
-effects on `glReadPixels' of most, but not all of the parameters
-specified by these three commands.
-
-If a non-zero named buffer object is bound to the `GL_PIXEL_PACK_BUFFER'
-target (see `glBindBuffer') while a block of pixels is requested, DATA
-is treated as a byte offset into the buffer object's data store rather
-than a pointer to client memory.
-
-When the `ARB_imaging' extension is supported, the pixel data may be
-processed by additional operations including color table lookup, color
-matrix transformations, convolutions, histograms, and minimum and
-maximum pixel value computations.
-
-`glReadPixels' returns values from each pixel with lower left corner at
-(X+I,Y+J) for 0<=I<WIDTH and 0<=J<HEIGHT. This pixel is said to be the
-Ith pixel in the Jth row. Pixels are returned in row order from the
-lowest to the highest row, left to right in each row.
-
-FORMAT specifies the format for the returned pixel values; accepted
-values are:
-
-`GL_COLOR_INDEX'
- Color indices are read from the color buffer selected by
- `glReadBuffer'. Each index is converted to fixed point, shifted
- left or right depending on the value and sign of `GL_INDEX_SHIFT',
- and added to `GL_INDEX_OFFSET'. If `GL_MAP_COLOR' is `GL_TRUE',
- indices are replaced by their mappings in the table
- `GL_PIXEL_MAP_I_TO_I'.
-
-`GL_STENCIL_INDEX'
- Stencil values are read from the stencil buffer. Each index is
- converted to fixed point, shifted left or right depending on the
- value and sign of `GL_INDEX_SHIFT', and added to `GL_INDEX_OFFSET'.
- If `GL_MAP_STENCIL' is `GL_TRUE', indices are replaced by their
- mappings in the table `GL_PIXEL_MAP_S_TO_S'.
-
-`GL_DEPTH_COMPONENT'
- Depth values are read from the depth buffer. Each component is
- converted to floating point such that the minimum depth value maps
- to 0 and the maximum value maps to 1. Each component is then
- multiplied by `GL_DEPTH_SCALE', added to `GL_DEPTH_BIAS', and
- finally clamped to the range [0,1].
-
-`GL_RED'
-`GL_GREEN'
-`GL_BLUE'
-`GL_ALPHA'
-`GL_RGB'
-`GL_BGR'
-`GL_RGBA'
-`GL_BGRA'
-`GL_LUMINANCE'
-`GL_LUMINANCE_ALPHA'
- Processing differs depending on whether color buffers store color
- indices or RGBA color components. If color indices are stored, they
- are read from the color buffer selected by `glReadBuffer'. Each
- index is converted to fixed point, shifted left or right depending
- on the value and sign of `GL_INDEX_SHIFT', and added to
- `GL_INDEX_OFFSET'. Indices are then replaced by the red, green,
- blue, and alpha values obtained by indexing the tables
- `GL_PIXEL_MAP_I_TO_R', `GL_PIXEL_MAP_I_TO_G',
- `GL_PIXEL_MAP_I_TO_B', and `GL_PIXEL_MAP_I_TO_A'. Each table must
- be of size 2^N, but N may be different for different tables. Before
- an index is used to look up a value in a table of size 2^N, it must
- be masked against 2^N-1.
-
- If RGBA color components are stored in the color buffers, they are
- read from the color buffer selected by `glReadBuffer'. Each color
- component is converted to floating point such that zero intensity
- maps to 0.0 and full intensity maps to 1.0. Each component is then
- multiplied by `GL_c_SCALE' and added to `GL_c_BIAS', where C is
- RED, GREEN, BLUE, or ALPHA. Finally, if `GL_MAP_COLOR' is
- `GL_TRUE', each component is clamped to the range [0,1], scaled to
- the size of its corresponding table, and is then replaced by its
- mapping in the table `GL_PIXEL_MAP_c_TO_c', where C is R, G, B, or
- A.
-
- Unneeded data is then discarded. For example, `GL_RED' discards the
- green, blue, and alpha components, while `GL_RGB' discards only the
- alpha component. `GL_LUMINANCE' computes a single-component value
- as the sum of the red, green, and blue components, and
- `GL_LUMINANCE_ALPHA' does the same, while keeping alpha as a second
- value. The final values are clamped to the range [0,1].
-
-The shift, scale, bias, and lookup factors just described are all
-specified by `glPixelTransfer'. The lookup table contents themselves are
-specified by `glPixelMap'.
-
-Finally, the indices or components are converted to the proper format,
-as specified by TYPE. If FORMAT is `GL_COLOR_INDEX' or
-`GL_STENCIL_INDEX' and TYPE is not `GL_FLOAT', each index is masked with
-the mask value given in the following table. If TYPE is `GL_FLOAT', then
-each integer index is converted to single-precision floating-point
-format.
-
-If FORMAT is `GL_RED', `GL_GREEN', `GL_BLUE', `GL_ALPHA', `GL_RGB',
-`GL_BGR', `GL_RGBA', `GL_BGRA', `GL_LUMINANCE', or `GL_LUMINANCE_ALPHA'
-and TYPE is not `GL_FLOAT', each component is multiplied by the
-multiplier shown in the following table. If type is `GL_FLOAT', then
-each component is passed as is (or converted to the client's
-single-precision floating-point format if it is different from the one
-used by the GL).
-
-
-
-TYPE
-*
-Index Mask *, *
-Component Conversion *`GL_UNSIGNED_BYTE'
-2^8-1, (2^8-1,)\u2062C`GL_BYTE'
-2^7-1, (2^8-1,)\u2062C-1,/2`GL_BITMAP'
-1, 1`GL_UNSIGNED_SHORT'
-2^16-1, (2^16-1,)\u2062C`GL_SHORT'
-2^15-1, (2^16-1,)\u2062C-1,/2`GL_UNSIGNED_INT'
-2^32-1, (2^32-1,)\u2062C`GL_INT'
-2^31-1, (2^32-1,)\u2062C-1,/2`GL_FLOAT'
-
-none , CReturn values are placed in memory as follows. If FORMAT is
-`GL_COLOR_INDEX', `GL_STENCIL_INDEX', `GL_DEPTH_COMPONENT', `GL_RED',
-`GL_GREEN', `GL_BLUE', `GL_ALPHA', or `GL_LUMINANCE', a single value is
-returned and the data for the Ith pixel in the Jth row is placed in
-location (J,)\u2062WIDTH+I. `GL_RGB' and `GL_BGR' return three values,
-`GL_RGBA' and `GL_BGRA' return four values, and `GL_LUMINANCE_ALPHA'
-returns two values for each pixel, with all values corresponding to a
-single pixel occupying contiguous space in DATA. Storage parameters set
-by `glPixelStore', such as `GL_PACK_LSB_FIRST' and `GL_PACK_SWAP_BYTES',
-affect the way that data is written into memory. See `glPixelStore' for
-a description.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if FORMAT or TYPE is not an accepted
-value.
-
-`GL_INVALID_ENUM' is generated if TYPE is `GL_BITMAP' and FORMAT is not
-`GL_COLOR_INDEX' or `GL_STENCIL_INDEX'.
-
-`GL_INVALID_VALUE' is generated if either WIDTH or HEIGHT is negative.
-
-`GL_INVALID_OPERATION' is generated if FORMAT is `GL_COLOR_INDEX' and
-the color buffers store RGBA color components.
-
-`GL_INVALID_OPERATION' is generated if FORMAT is `GL_STENCIL_INDEX' and
-there is no stencil buffer.
-
-`GL_INVALID_OPERATION' is generated if FORMAT is `GL_DEPTH_COMPONENT'
-and there is no depth buffer.
-
-`GL_INVALID_OPERATION' is generated if TYPE is one of
-`GL_UNSIGNED_BYTE_3_3_2', `GL_UNSIGNED_BYTE_2_3_3_REV',
-`GL_UNSIGNED_SHORT_5_6_5', or `GL_UNSIGNED_SHORT_5_6_5_REV' and FORMAT
-is not `GL_RGB'.
-
-`GL_INVALID_OPERATION' is generated if TYPE is one of
-`GL_UNSIGNED_SHORT_4_4_4_4', `GL_UNSIGNED_SHORT_4_4_4_4_REV',
-`GL_UNSIGNED_SHORT_5_5_5_1', `GL_UNSIGNED_SHORT_1_5_5_5_REV',
-`GL_UNSIGNED_INT_8_8_8_8', `GL_UNSIGNED_INT_8_8_8_8_REV',
-`GL_UNSIGNED_INT_10_10_10_2', or `GL_UNSIGNED_INT_2_10_10_10_REV' and
-FORMAT is neither `GL_RGBA' nor `GL_BGRA'.
-
-The formats `GL_BGR', and `GL_BGRA' and types `GL_UNSIGNED_BYTE_3_3_2',
-`GL_UNSIGNED_BYTE_2_3_3_REV', `GL_UNSIGNED_SHORT_5_6_5',
-`GL_UNSIGNED_SHORT_5_6_5_REV', `GL_UNSIGNED_SHORT_4_4_4_4',
-`GL_UNSIGNED_SHORT_4_4_4_4_REV', `GL_UNSIGNED_SHORT_5_5_5_1',
-`GL_UNSIGNED_SHORT_1_5_5_5_REV', `GL_UNSIGNED_INT_8_8_8_8',
-`GL_UNSIGNED_INT_8_8_8_8_REV', `GL_UNSIGNED_INT_10_10_10_2', and
-`GL_UNSIGNED_INT_2_10_10_10_REV' are available only if the GL version is
-1.2 or greater.
-
-`GL_INVALID_OPERATION' is generated if a non-zero buffer object name is
-bound to the `GL_PIXEL_PACK_BUFFER' target and the buffer object's data
-store is currently mapped.
-
-`GL_INVALID_OPERATION' is generated if a non-zero buffer object name is
-bound to the `GL_PIXEL_PACK_BUFFER' target and the data would be packed
-to the buffer object such that the memory writes required would exceed
-the data store size.
-
-`GL_INVALID_OPERATION' is generated if a non-zero buffer object name is
-bound to the `GL_PIXEL_PACK_BUFFER' target and DATA is not evenly
-divisible into the number of bytes needed to store in memory a datum
-indicated by TYPE.
-
-`GL_INVALID_OPERATION' is generated if `glReadPixels' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glRect
- "glRect"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glRectd"))
- (paramdef "GLdouble " (parameter "x1"))
- (paramdef "GLdouble " (parameter "y1"))
- (paramdef "GLdouble " (parameter "x2"))
- (paramdef "GLdouble " (parameter "y2"))))
- "draw a rectangle
-================
-
-
-Parameters
-==========
-
-X1
- Y1
-
- Specify one vertex of a rectangle.
-
-X2
- Y2
-
- Specify the opposite vertex of the rectangle.
-
-
-Description
-===========
-
-`glRect' supports efficient specification of rectangles as two corner
-points. Each rectangle command takes four arguments, organized either as
-two consecutive pairs of (X,Y) coordinates or as two pointers to arrays,
-each containing an (X,Y) pair. The resulting rectangle is defined in the
-Z=0 plane.
-
-`glRect'(X1, Y1, X2, Y2) is exactly equivalent to the following
-sequence: glBegin(`GL_POLYGON'); glVertex2(X1, Y1); glVertex2(X2, Y1);
-glVertex2(X2, Y2); glVertex2(X1, Y2); glEnd(); Note that if the second
-vertex is above and to the right of the first vertex, the rectangle is
-constructed with a counterclockwise winding.
-
-
-Errors
-======
-
-`GL_INVALID_OPERATION' is generated if `glRect' is executed between the
-execution of `glBegin' and the corresponding execution of `glEnd'.")
-
-(define-gl-procedure
- glRenderMode
- "glRenderMode"
- (funcsynopsis
- (funcprototype
- (funcdef "GLint " (function "glRenderMode"))
- (paramdef "GLenum " (parameter "mode"))))
- "set rasterization mode
-======================
-
-
-Parameters
-==========
-
-MODE
- Specifies the rasterization mode. Three values are accepted:
- `GL_RENDER', `GL_SELECT', and `GL_FEEDBACK'. The initial value is
- `GL_RENDER'.
-
-
-Description
-===========
-
-`glRenderMode' sets the rasterization mode. It takes one argument, MODE,
-which can assume one of three predefined values:
-
-`GL_RENDER'
- Render mode. Primitives are rasterized, producing pixel fragments,
- which are written into the frame buffer. This is the normal mode
- and also the default mode.
-
-`GL_SELECT'
- Selection mode. No pixel fragments are produced, and no change to
- the frame buffer contents is made. Instead, a record of the names
- of primitives that would have been drawn if the render mode had
- been `GL_RENDER' is returned in a select buffer, which must be
- created (see `glSelectBuffer') before selection mode is entered.
-
-`GL_FEEDBACK'
- Feedback mode. No pixel fragments are produced, and no change to
- the frame buffer contents is made. Instead, the coordinates and
- attributes of vertices that would have been drawn if the render
- mode had been `GL_RENDER' is returned in a feedback buffer, which
- must be created (see `glFeedbackBuffer') before feedback mode is
- entered.
-
-The return value of `glRenderMode' is determined by the render mode at
-the time `glRenderMode' is called, rather than by MODE. The values
-returned for the three render modes are as follows:
-
-`GL_RENDER'
- 0.
-
-`GL_SELECT'
- The number of hit records transferred to the select buffer.
-
-`GL_FEEDBACK'
- The number of values (not vertices) transferred to the feedback
- buffer.
-
-See the `glSelectBuffer' and `glFeedbackBuffer' reference pages for more
-details concerning selection and feedback operation.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if MODE is not one of the three accepted
-values.
-
-`GL_INVALID_OPERATION' is generated if `glSelectBuffer' is called while
-the render mode is `GL_SELECT', or if `glRenderMode' is called with
-argument `GL_SELECT' before `glSelectBuffer' is called at least once.
-
-`GL_INVALID_OPERATION' is generated if `glFeedbackBuffer' is called
-while the render mode is `GL_FEEDBACK', or if `glRenderMode' is called
-with argument `GL_FEEDBACK' before `glFeedbackBuffer' is called at least
-once.
-
-`GL_INVALID_OPERATION' is generated if `glRenderMode' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glResetHistogram
- "glResetHistogram"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glResetHistogram"))
- (paramdef "GLenum " (parameter "target"))))
- "reset histogram table entries to zero
-=====================================
-
-
-Parameters
-==========
-
-TARGET
- Must be `GL_HISTOGRAM'.
-
-
-Description
-===========
-
-`glResetHistogram' resets all the elements of the current histogram
-table to zero.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if TARGET is not `GL_HISTOGRAM'.
-
-`GL_INVALID_OPERATION' is generated if `glResetHistogram' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glResetMinmax
- "glResetMinmax"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glResetMinmax"))
- (paramdef "GLenum " (parameter "target"))))
- "reset minmax table entries to initial values
-============================================
-
-
-Parameters
-==========
-
-TARGET
- Must be `GL_MINMAX'.
-
-
-Description
-===========
-
-`glResetMinmax' resets the elements of the current minmax table to their
-initial values: the ``maximum'' element receives the minimum possible
-component values, and the ``minimum'' element receives the maximum
-possible component values.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if TARGET is not `GL_MINMAX'.
-
-`GL_INVALID_OPERATION' is generated if `glResetMinmax' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glRotate
- "glRotate"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glRotated"))
- (paramdef "GLdouble " (parameter "angle"))
- (paramdef "GLdouble " (parameter "x"))
- (paramdef "GLdouble " (parameter "y"))
- (paramdef "GLdouble " (parameter "z"))))
- "multiply the current matrix by a rotation matrix
-================================================
-
-
-Parameters
-==========
-
-ANGLE
- Specifies the angle of rotation, in degrees.
-
-X
- Y
-
- Z
-
- Specify the X, Y, and Z coordinates of a vector, respectively.
-
-
-Description
-===========
-
-`glRotate' produces a rotation of ANGLE degrees around the vector
-(X,YZ). The current matrix (see `glMatrixMode') is multiplied by a
-rotation matrix with the product replacing the current matrix, as if
-`glMultMatrix' were called with the following matrix as its argument:
-
-((X^2\u2061(1-C,)+C X\u2062Y\u2061(1-C,)-Z\u2062S X\u2062Z\u2061(1-C,)+Y\u2062S 0), (Y\u2062X\u2061(1-C,)+Z\u2062S
-Y^2\u2061(1-C,)+C Y\u2062Z\u2061(1-C,)-X\u2062S 0), (X\u2062Z\u2061(1-C,)-Y\u2062S Y\u2062Z\u2061(1-C,)+X\u2062S
-Z^2\u2061(1-C,)+C 0), (0 0 0 1),)
-
-
-
-Where C=COS\u2061(ANGLE,), S=SIN\u2061(ANGLE,), and ∥(X,YZ),∥=1 (if not, the GL
-will normalize this vector).
-
-
-
-
-
-If the matrix mode is either `GL_MODELVIEW' or `GL_PROJECTION', all
-objects drawn after `glRotate' is called are rotated. Use `glPushMatrix'
-and `glPopMatrix' to save and restore the unrotated coordinate system.
-
-
-Errors
-======
-
-`GL_INVALID_OPERATION' is generated if `glRotate' is executed between
-the execution of `glBegin' and the corresponding execution of `glEnd'.")
-
-(define-gl-procedure
- glSampleCoverage
- "glSampleCoverage"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glSampleCoverage"))
- (paramdef "GLclampf " (parameter "value"))
- (paramdef "GLboolean " (parameter "invert"))))
- "specify multisample coverage parameters
-=======================================
-
-
-Parameters
-==========
-
-VALUE
- Specify a single floating-point sample coverage value. The value is
- clamped to the range [0,1]. The initial value is 1.0.
-
-INVERT
- Specify a single boolean value representing if the coverage masks
- should be inverted. `GL_TRUE' and `GL_FALSE' are accepted. The
- initial value is `GL_FALSE'.
-
-
-Description
-===========
-
-Multisampling samples a pixel multiple times at various
-implementation-dependent subpixel locations to generate antialiasing
-effects. Multisampling transparently antialiases points, lines,
-polygons, bitmaps, and images if it is enabled.
-
-VALUE is used in constructing a temporary mask used in determining which
-samples will be used in resolving the final fragment color. This mask is
-bitwise-anded with the coverage mask generated from the multisampling
-computation. If the INVERT flag is set, the temporary mask is inverted
-(all bits flipped) and then the bitwise-and is computed.
-
-If an implementation does not have any multisample buffers available, or
-multisampling is disabled, rasterization occurs with only a single
-sample computing a pixel's final RGB color.
-
-Provided an implementation supports multisample buffers, and
-multisampling is enabled, then a pixel's final color is generated by
-combining several samples per pixel. Each sample contains color, depth,
-and stencil information, allowing those operations to be performed on
-each sample.
-
-
-Errors
-======
-
-`GL_INVALID_OPERATION' is generated if `glSampleCoverage' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glScale
- "glScale"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glScaled"))
- (paramdef "GLdouble " (parameter "x"))
- (paramdef "GLdouble " (parameter "y"))
- (paramdef "GLdouble " (parameter "z"))))
- "multiply the current matrix by a general scaling matrix
-=======================================================
-
-
-Parameters
-==========
-
-X
- Y
-
- Z
-
- Specify scale factors along the X, Y, and Z axes, respectively.
-
-
-Description
-===========
-
-`glScale' produces a nonuniform scaling along the X, Y, and Z axes. The
-three parameters indicate the desired scale factor along each of the
-three axes.
-
-The current matrix (see `glMatrixMode') is multiplied by this scale
-matrix, and the product replaces the current matrix as if `glMultMatrix'
-were called with the following matrix as its argument:
-
-((X 0 0 0), (0 Y 0 0), (0 0 Z 0), (0 0 0 1),)
-
-If the matrix mode is either `GL_MODELVIEW' or `GL_PROJECTION', all
-objects drawn after `glScale' is called are scaled.
-
-Use `glPushMatrix' and `glPopMatrix' to save and restore the unscaled
-coordinate system.
-
-
-Errors
-======
-
-`GL_INVALID_OPERATION' is generated if `glScale' is executed between the
-execution of `glBegin' and the corresponding execution of `glEnd'.")
-
-(define-gl-procedure
- glScissor
- "glScissor"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glScissor"))
- (paramdef "GLint " (parameter "x"))
- (paramdef "GLint " (parameter "y"))
- (paramdef "GLsizei " (parameter "width"))
- (paramdef "GLsizei " (parameter "height"))))
- "define the scissor box
-======================
-
-
-Parameters
-==========
-
-X
- Y
-
- Specify the lower left corner of the scissor box. Initially (0, 0).
-
-WIDTH
- HEIGHT
-
- Specify the width and height of the scissor box. When a GL context
- is first attached to a window, WIDTH and HEIGHT are set to the
- dimensions of that window.
-
-
-Description
-===========
-
-`glScissor' defines a rectangle, called the scissor box, in window
-coordinates. The first two arguments, X and Y, specify the lower left
-corner of the box. WIDTH and HEIGHT specify the width and height of the
-box.
-
-To enable and disable the scissor test, call `glEnable' and `glDisable'
-with argument `GL_SCISSOR_TEST'. The test is initially disabled. While
-the test is enabled, only pixels that lie within the scissor box can be
-modified by drawing commands. Window coordinates have integer values at
-the shared corners of frame buffer pixels. `glScissor(0,0,1,1)' allows
-modification of only the lower left pixel in the window, and
-`glScissor(0,0,0,0)' doesn't allow modification of any pixels in the
-window.
-
-When the scissor test is disabled, it is as though the scissor box
-includes the entire window.
-
-
-Errors
-======
-
-`GL_INVALID_VALUE' is generated if either WIDTH or HEIGHT is negative.
-
-`GL_INVALID_OPERATION' is generated if `glScissor' is executed between
-the execution of `glBegin' and the corresponding execution of `glEnd'.")
-
-(define-gl-procedure
- glSecondaryColorPointer
- "glSecondaryColorPointer"
- (funcsynopsis
- (funcprototype
- (funcdef
- "void "
- (function "glSecondaryColorPointer"))
- (paramdef "GLint " (parameter "size"))
- (paramdef "GLenum " (parameter "type"))
- (paramdef "GLsizei " (parameter "stride"))
- (paramdef
- "const GLvoid * "
- (parameter "pointer"))))
- "define an array of secondary colors
-===================================
-
-
-Parameters
-==========
-
-SIZE
- Specifies the number of components per color. Must be 3.
-
-TYPE
- Specifies the data type of each color component in the array.
- Symbolic constants `GL_BYTE', `GL_UNSIGNED_BYTE', `GL_SHORT',
- `GL_UNSIGNED_SHORT', `GL_INT', `GL_UNSIGNED_INT', `GL_FLOAT', or
- `GL_DOUBLE' are accepted. The initial value is `GL_FLOAT'.
-
-STRIDE
- Specifies the byte offset between consecutive colors. If STRIDE is
- 0, the colors are understood to be tightly packed in the array. The
- initial value is 0.
-
-POINTER
- Specifies a pointer to the first component of the first color
- element in the array. The initial value is 0.
-
-
-Description
-===========
-
-`glSecondaryColorPointer' specifies the location and data format of an
-array of color components to use when rendering. SIZE specifies the
-number of components per color, and must be 3. TYPE specifies the data
-type of each color component, and STRIDE specifies the byte stride from
-one color to the next, allowing vertices and attributes to be packed
-into a single array or stored in separate arrays.
-
-If a non-zero named buffer object is bound to the `GL_ARRAY_BUFFER'
-target (see `glBindBuffer') while a secondary color array is specified,
-POINTER is treated as a byte offset into the buffer object's data store.
-Also, the buffer object binding (`GL_ARRAY_BUFFER_BINDING') is saved as
-secondary color vertex array client-side state
-(`GL_SECONDARY_COLOR_ARRAY_BUFFER_BINDING').
-
-When a secondary color array is specified, SIZE, TYPE, STRIDE, and
-POINTER are saved as client-side state, in addition to the current
-vertex array buffer object binding.
-
-To enable and disable the secondary color array, call
-`glEnableClientState' and `glDisableClientState' with the argument
-`GL_SECONDARY_COLOR_ARRAY'. If enabled, the secondary color array is
-used when `glArrayElement', `glDrawArrays', `glMultiDrawArrays',
-`glDrawElements', `glMultiDrawElements', or `glDrawRangeElements' is
-called.
-
-
-Errors
-======
-
-`GL_INVALID_VALUE' is generated if SIZE is not 3.
-
-`GL_INVALID_ENUM' is generated if TYPE is not an accepted value.
-
-`GL_INVALID_VALUE' is generated if STRIDE is negative.")
-
-(define-gl-procedure
- glSecondaryColor
- "glSecondaryColor"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glSecondaryColor3b"))
- (paramdef "GLbyte " (parameter "red"))
- (paramdef "GLbyte " (parameter "green"))
- (paramdef "GLbyte " (parameter "blue"))))
- "set the current secondary color
-===============================
-
-
-Parameters
-==========
-
-RED
- GREEN
-
- BLUE
-
- Specify new red, green, and blue values for the current secondary
- color.
-
-
-Description
-===========
-
-The GL stores both a primary four-valued RGBA color and a secondary
-four-valued RGBA color (where alpha is always set to 0.0) that is
-associated with every vertex.
-
-The secondary color is interpolated and applied to each fragment during
-rasterization when `GL_COLOR_SUM' is enabled. When lighting is enabled,
-and `GL_SEPARATE_SPECULAR_COLOR' is specified, the value of the
-secondary color is assigned the value computed from the specular term of
-the lighting computation. Both the primary and secondary current colors
-are applied to each fragment, regardless of the state of `GL_COLOR_SUM',
-under such conditions. When `GL_SEPARATE_SPECULAR_COLOR' is specified,
-the value returned from querying the current secondary color is
-undefined.
-
-`glSecondaryColor3b', `glSecondaryColor3s', and `glSecondaryColor3i'
-take three signed byte, short, or long integers as arguments. When *v*
-is appended to the name, the color commands can take a pointer to an
-array of such values.
-
-Color values are stored in floating-point format, with unspecified
-mantissa and exponent sizes. Unsigned integer color components, when
-specified, are linearly mapped to floating-point values such that the
-largest representable value maps to 1.0 (full intensity), and 0 maps to
-0.0 (zero intensity). Signed integer color components, when specified,
-are linearly mapped to floating-point values such that the most positive
-representable value maps to 1.0, and the most negative representable
-value maps to -1.0. (Note that this mapping does not convert 0 precisely
-to 0.0). Floating-point values are mapped directly.
-
-Neither floating-point nor signed integer values are clamped to the
-range [0,1] before the current color is updated. However, color
-components are clamped to this range before they are interpolated or
-written into a color buffer.")
-
-(define-gl-procedure
- glSelectBuffer
- "glSelectBuffer"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glSelectBuffer"))
- (paramdef "GLsizei " (parameter "size"))
- (paramdef "GLuint * " (parameter "buffer"))))
- "establish a buffer for selection mode values
-============================================
-
-
-Parameters
-==========
-
-SIZE
- Specifies the size of BUFFER.
-
-BUFFER
- Returns the selection data.
-
-
-Description
-===========
-
-`glSelectBuffer' has two arguments: BUFFER is a pointer to an array of
-unsigned integers, and SIZE indicates the size of the array. BUFFER
-returns values from the name stack (see `glInitNames', `glLoadName',
-`glPushName') when the rendering mode is `GL_SELECT' (see
-`glRenderMode'). `glSelectBuffer' must be issued before selection mode
-is enabled, and it must not be issued while the rendering mode is
-`GL_SELECT'.
-
-A programmer can use selection to determine which primitives are drawn
-into some region of a window. The region is defined by the current
-modelview and perspective matrices.
-
-In selection mode, no pixel fragments are produced from rasterization.
-Instead, if a primitive or a raster position intersects the clipping
-volume defined by the viewing frustum and the user-defined clipping
-planes, this primitive causes a selection hit. (With polygons, no hit
-occurs if the polygon is culled.) When a change is made to the name
-stack, or when `glRenderMode' is called, a hit record is copied to
-BUFFER if any hits have occurred since the last such event (name stack
-change or `glRenderMode' call). The hit record consists of the number of
-names in the name stack at the time of the event, followed by the
-minimum and maximum depth values of all vertices that hit since the
-previous event, followed by the name stack contents, bottom name first.
-
-Depth values (which are in the range [0,1]) are multiplied by 2^32-1,
-before being placed in the hit record.
-
-An internal index into BUFFER is reset to 0 whenever selection mode is
-entered. Each time a hit record is copied into BUFFER, the index is
-incremented to point to the cell just past the end of the block of
-names\\(emthat is, to the next available cell If the hit record is larger
-than the number of remaining locations in BUFFER, as much data as can
-fit is copied, and the overflow flag is set. If the name stack is empty
-when a hit record is copied, that record consists of 0 followed by the
-minimum and maximum depth values.
-
-To exit selection mode, call `glRenderMode' with an argument other than
-`GL_SELECT'. Whenever `glRenderMode' is called while the render mode is
-`GL_SELECT', it returns the number of hit records copied to BUFFER,
-resets the overflow flag and the selection buffer pointer, and
-initializes the name stack to be empty. If the overflow bit was set when
-`glRenderMode' was called, a negative hit record count is returned.
-
-
-Errors
-======
-
-`GL_INVALID_VALUE' is generated if SIZE is negative.
-
-`GL_INVALID_OPERATION' is generated if `glSelectBuffer' is called while
-the render mode is `GL_SELECT', or if `glRenderMode' is called with
-argument `GL_SELECT' before `glSelectBuffer' is called at least once.
-
-`GL_INVALID_OPERATION' is generated if `glSelectBuffer' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glSeparableFilter2D
- "glSeparableFilter2D"
- (funcsynopsis
- (funcprototype
- (funcdef
- "void "
- (function "glSeparableFilter2D"))
- (paramdef "GLenum " (parameter "target"))
- (paramdef "GLenum " (parameter "internalformat"))
- (paramdef "GLsizei " (parameter "width"))
- (paramdef "GLsizei " (parameter "height"))
- (paramdef "GLenum " (parameter "format"))
- (paramdef "GLenum " (parameter "type"))
- (paramdef "const GLvoid * " (parameter "row"))
- (paramdef "const GLvoid * " (parameter "column"))))
- "define a separable two-dimensional convolution filter
-=====================================================
-
-
-Parameters
-==========
-
-TARGET
- Must be `GL_SEPARABLE_2D'.
-
-INTERNALFORMAT
- The internal format of the convolution filter kernel. The allowable
- values are `GL_ALPHA', `GL_ALPHA4', `GL_ALPHA8', `GL_ALPHA12',
- `GL_ALPHA16', `GL_LUMINANCE', `GL_LUMINANCE4', `GL_LUMINANCE8',
- `GL_LUMINANCE12', `GL_LUMINANCE16', `GL_LUMINANCE_ALPHA',
- `GL_LUMINANCE4_ALPHA4', `GL_LUMINANCE6_ALPHA2',
- `GL_LUMINANCE8_ALPHA8', `GL_LUMINANCE12_ALPHA4',
- `GL_LUMINANCE12_ALPHA12', `GL_LUMINANCE16_ALPHA16', `GL_INTENSITY',
- `GL_INTENSITY4', `GL_INTENSITY8', `GL_INTENSITY12',
- `GL_INTENSITY16', `GL_R3_G3_B2', `GL_RGB', `GL_RGB4', `GL_RGB5',
- `GL_RGB8', `GL_RGB10', `GL_RGB12', `GL_RGB16', `GL_RGBA',
- `GL_RGBA2', `GL_RGBA4', `GL_RGB5_A1', `GL_RGBA8', `GL_RGB10_A2',
- `GL_RGBA12', or `GL_RGBA16'.
-
-WIDTH
- The number of elements in the pixel array referenced by ROW. (This
- is the width of the separable filter kernel.)
-
-HEIGHT
- The number of elements in the pixel array referenced by COLUMN.
- (This is the height of the separable filter kernel.)
-
-FORMAT
- The format of the pixel data in ROW and COLUMN. The allowable
- values are `GL_RED', `GL_GREEN', `GL_BLUE', `GL_ALPHA', `GL_RGB',
- `GL_BGR', `GL_RGBA', `GL_BGRA', `GL_INTENSITY', `GL_LUMINANCE', and
- `GL_LUMINANCE_ALPHA'.
-
-TYPE
- The type of the pixel data in ROW and COLUMN. Symbolic constants
- `GL_UNSIGNED_BYTE', `GL_BYTE', `GL_BITMAP', `GL_UNSIGNED_SHORT',
- `GL_SHORT', `GL_UNSIGNED_INT', `GL_INT', `GL_FLOAT',
- `GL_UNSIGNED_BYTE_3_3_2', `GL_UNSIGNED_BYTE_2_3_3_REV',
- `GL_UNSIGNED_SHORT_5_6_5', `GL_UNSIGNED_SHORT_5_6_5_REV',
- `GL_UNSIGNED_SHORT_4_4_4_4', `GL_UNSIGNED_SHORT_4_4_4_4_REV',
- `GL_UNSIGNED_SHORT_5_5_5_1', `GL_UNSIGNED_SHORT_1_5_5_5_REV',
- `GL_UNSIGNED_INT_8_8_8_8', `GL_UNSIGNED_INT_8_8_8_8_REV',
- `GL_UNSIGNED_INT_10_10_10_2', and `GL_UNSIGNED_INT_2_10_10_10_REV'
- are accepted.
-
-ROW
- Pointer to a one-dimensional array of pixel data that is processed
- to build the row filter kernel.
-
-COLUMN
- Pointer to a one-dimensional array of pixel data that is processed
- to build the column filter kernel.
-
-
-Description
-===========
-
-`glSeparableFilter2D' builds a two-dimensional separable convolution
-filter kernel from two arrays of pixels.
-
-The pixel arrays specified by (WIDTH, FORMAT, TYPE, ROW) and (HEIGHT,
-FORMAT, TYPE, COLUMN) are processed just as if they had been passed to
-`glDrawPixels', but processing stops after the final expansion to RGBA
-is completed.
-
-If a non-zero named buffer object is bound to the
-`GL_PIXEL_UNPACK_BUFFER' target (see `glBindBuffer') while a convolution
-filter is specified, ROW and COLUMN are treated as byte offsets into the
-buffer object's data store.
-
-Next, the R, G, B, and A components of all pixels in both arrays are
-scaled by the four separable 2D `GL_CONVOLUTION_FILTER_SCALE' parameters
-and biased by the four separable 2D `GL_CONVOLUTION_FILTER_BIAS'
-parameters. (The scale and bias parameters are set by
-`glConvolutionParameter' using the `GL_SEPARABLE_2D' target and the
-names `GL_CONVOLUTION_FILTER_SCALE' and `GL_CONVOLUTION_FILTER_BIAS'.
-The parameters themselves are vectors of four values that are applied to
-red, green, blue, and alpha, in that order.) The R, G, B, and A values
-are not clamped to [0,1] at any time during this process.
-
-Each pixel is then converted to the internal format specified by
-INTERNALFORMAT. This conversion simply maps the component values of the
-pixel (R, G, B, and A) to the values included in the internal format
-(red, green, blue, alpha, luminance, and intensity). The mapping is as
-follows:
-
-* Internal Format *
-*
-Red *, *
-Green *, *
-Blue *, *
-Alpha *, *
-Luminance *, *
-Intensity *`GL_LUMINANCE'
-, , , ,
-R , `GL_LUMINANCE_ALPHA'
-, , ,
-A ,
-R , `GL_INTENSITY'
-, , , , ,
-R `GL_RGB'
-
-R ,
-G ,
-B , , , `GL_RGBA'
-
-R ,
-G ,
-B ,
-A , , The red, green, blue, alpha, luminance, and/or intensity components of
-the resulting pixels are stored in floating-point rather than integer
-format. They form two one-dimensional filter kernel images. The row
-image is indexed by coordinate I starting at zero and increasing from
-left to right. Each location in the row image is derived from element I
-of ROW. The column image is indexed by coordinate J starting at zero and
-increasing from bottom to top. Each location in the column image is
-derived from element J of COLUMN.
-
-Note that after a convolution is performed, the resulting color
-components are also scaled by their corresponding
-`GL_POST_CONVOLUTION_c_SCALE' parameters and biased by their
-corresponding `GL_POST_CONVOLUTION_c_BIAS' parameters (where C takes on
-the values *RED*, *GREEN*, *BLUE*, and *ALPHA*). These parameters are
-set by `glPixelTransfer'.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if TARGET is not `GL_SEPARABLE_2D'.
-
-`GL_INVALID_ENUM' is generated if INTERNALFORMAT is not one of the
-allowable values.
-
-`GL_INVALID_ENUM' is generated if FORMAT is not one of the allowable
-values.
-
-`GL_INVALID_ENUM' is generated if TYPE is not one of the allowable
-values.
-
-`GL_INVALID_VALUE' is generated if WIDTH is less than zero or greater
-than the maximum supported value. This value may be queried with
-`glGetConvolutionParameter' using target `GL_SEPARABLE_2D' and name
-`GL_MAX_CONVOLUTION_WIDTH'.
-
-`GL_INVALID_VALUE' is generated if HEIGHT is less than zero or greater
-than the maximum supported value. This value may be queried with
-`glGetConvolutionParameter' using target `GL_SEPARABLE_2D' and name
-`GL_MAX_CONVOLUTION_HEIGHT'.
-
-`GL_INVALID_OPERATION' is generated if HEIGHT is one of
-`GL_UNSIGNED_BYTE_3_3_2', `GL_UNSIGNED_BYTE_2_3_3_REV',
-`GL_UNSIGNED_SHORT_5_6_5', or `GL_UNSIGNED_SHORT_5_6_5_REV' and FORMAT
-is not `GL_RGB'.
-
-`GL_INVALID_OPERATION' is generated if HEIGHT is one of
-`GL_UNSIGNED_SHORT_4_4_4_4', `GL_UNSIGNED_SHORT_4_4_4_4_REV',
-`GL_UNSIGNED_SHORT_5_5_5_1', `GL_UNSIGNED_SHORT_1_5_5_5_REV',
-`GL_UNSIGNED_INT_8_8_8_8', `GL_UNSIGNED_INT_8_8_8_8_REV',
-`GL_UNSIGNED_INT_10_10_10_2', or `GL_UNSIGNED_INT_2_10_10_10_REV' and
-FORMAT is neither `GL_RGBA' nor `GL_BGRA'.
-
-`GL_INVALID_OPERATION' is generated if a non-zero buffer object name is
-bound to the `GL_PIXEL_UNPACK_BUFFER' target and the buffer object's
-data store is currently mapped.
-
-`GL_INVALID_OPERATION' is generated if a non-zero buffer object name is
-bound to the `GL_PIXEL_UNPACK_BUFFER' target and the data would be
-unpacked from the buffer object such that the memory reads required
-would exceed the data store size.
-
-`GL_INVALID_OPERATION' is generated if a non-zero buffer object name is
-bound to the `GL_PIXEL_UNPACK_BUFFER' target and ROW or COLUMN is not
-evenly divisible into the number of bytes needed to store in memory a
-datum indicated by TYPE.
-
-`GL_INVALID_OPERATION' is generated if `glSeparableFilter2D' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glShadeModel
- "glShadeModel"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glShadeModel"))
- (paramdef "GLenum " (parameter "mode"))))
- "select flat or smooth shading
-=============================
-
-
-Parameters
-==========
-
-MODE
- Specifies a symbolic value representing a shading technique.
- Accepted values are `GL_FLAT' and `GL_SMOOTH'. The initial value is
- `GL_SMOOTH'.
-
-
-Description
-===========
-
-GL primitives can have either flat or smooth shading. Smooth shading,
-the default, causes the computed colors of vertices to be interpolated
-as the primitive is rasterized, typically assigning different colors to
-each resulting pixel fragment. Flat shading selects the computed color
-of just one vertex and assigns it to all the pixel fragments generated
-by rasterizing a single primitive. In either case, the computed color of
-a vertex is the result of lighting if lighting is enabled, or it is the
-current color at the time the vertex was specified if lighting is
-disabled.
-
-Flat and smooth shading are indistinguishable for points. Starting when
-`glBegin' is issued and counting vertices and primitives from 1, the GL
-gives each flat-shaded line segment I the computed color of vertex I+1,
-its second vertex. Counting similarly from 1, the GL gives each
-flat-shaded polygon the computed color of the vertex listed in the
-following table. This is the last vertex to specify the polygon in all
-cases except single polygons, where the first vertex specifies the
-flat-shaded color.
-
-
-
-* Primitive Type of Polygon I*
-*
-Vertex *Single polygon (I==1)
-
-1 Triangle strip
-I+2Triangle fan
-I+2Independent triangle
-3\u2062IQuad strip
-2\u2062I+2Independent quad
-4\u2062IFlat and smooth shading are specified by `glShadeModel' with MODE set to
-`GL_FLAT' and `GL_SMOOTH', respectively.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if MODE is any value other than `GL_FLAT'
-or `GL_SMOOTH'.
-
-`GL_INVALID_OPERATION' is generated if `glShadeModel' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glShaderSource
- "glShaderSource"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glShaderSource"))
- (paramdef "GLuint " (parameter "shader"))
- (paramdef "GLsizei " (parameter "count"))
- (paramdef "const GLchar **" (parameter "string"))
- (paramdef "const GLint *" (parameter "length"))))
- "Replaces the source code in a shader object
-===========================================
-
-
-Parameters
-==========
-
-SHADER
- Specifies the handle of the shader object whose source code is to
- be replaced.
-
-COUNT
- Specifies the number of elements in the STRING and LENGTH arrays.
-
-STRING
- Specifies an array of pointers to strings containing the source
- code to be loaded into the shader.
-
-LENGTH
- Specifies an array of string lengths.
-
-
-Description
-===========
-
-`glShaderSource' sets the source code in SHADER to the source code in
-the array of strings specified by STRING. Any source code previously
-stored in the shader object is completely replaced. The number of
-strings in the array is specified by COUNT. If LENGTH is `NULL', each
-string is assumed to be null terminated. If LENGTH is a value other than
-`NULL', it points to an array containing a string length for each of the
-corresponding elements of STRING. Each element in the LENGTH array may
-contain the length of the corresponding string (the null character is
-not counted as part of the string length) or a value less than 0 to
-indicate that the string is null terminated. The source code strings are
-not scanned or parsed at this time; they are simply copied into the
-specified shader object.
-
-
-Errors
-======
-
-`GL_INVALID_VALUE' is generated if SHADER is not a value generated by
-OpenGL.
-
-`GL_INVALID_OPERATION' is generated if SHADER is not a shader object.
-
-`GL_INVALID_VALUE' is generated if COUNT is less than 0.
-
-`GL_INVALID_OPERATION' is generated if `glShaderSource' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glStencilFuncSeparate
- "glStencilFuncSeparate"
- (funcsynopsis
- (funcprototype
- (funcdef
- "void "
- (function "glStencilFuncSeparate"))
- (paramdef "GLenum " (parameter "face"))
- (paramdef "GLenum " (parameter "func"))
- (paramdef "GLint " (parameter "ref"))
- (paramdef "GLuint " (parameter "mask"))))
- "set front and/or back function and reference value for stencil testing
-======================================================================
-
-
-Parameters
-==========
-
-FACE
- Specifies whether front and/or back stencil state is updated. Three
- symbolic constants are valid: `GL_FRONT', `GL_BACK', and
- `GL_FRONT_AND_BACK'.
-
-FUNC
- Specifies the test function. Eight symbolic constants are valid:
- `GL_NEVER', `GL_LESS', `GL_LEQUAL', `GL_GREATER', `GL_GEQUAL',
- `GL_EQUAL', `GL_NOTEQUAL', and `GL_ALWAYS'. The initial value is
- `GL_ALWAYS'.
-
-REF
- Specifies the reference value for the stencil test. REF is clamped
- to the range [0,2^N-1], where N is the number of bitplanes in the
- stencil buffer. The initial value is 0.
-
-MASK
- Specifies a mask that is ANDed with both the reference value and
- the stored stencil value when the test is done. The initial value
- is all 1's.
-
-
-Description
-===========
-
-Stenciling, like depth-buffering, enables and disables drawing on a
-per-pixel basis. You draw into the stencil planes using GL drawing
-primitives, then render geometry and images, using the stencil planes to
-mask out portions of the screen. Stenciling is typically used in
-multipass rendering algorithms to achieve special effects, such as
-decals, outlining, and constructive solid geometry rendering.
-
-The stencil test conditionally eliminates a pixel based on the outcome
-of a comparison between the reference value and the value in the stencil
-buffer. To enable and disable the test, call `glEnable' and `glDisable'
-with argument `GL_STENCIL_TEST'. To specify actions based on the outcome
-of the stencil test, call `glStencilOp' or `glStencilOpSeparate'.
-
-There can be two separate sets of FUNC, REF, and MASK parameters; one
-affects back-facing polygons, and the other affects front-facing
-polygons as well as other non-polygon primitives. `glStencilFunc' sets
-both front and back stencil state to the same values, as if
-`glStencilFuncSeparate' were called with FACE set to
-`GL_FRONT_AND_BACK'.
-
-FUNC is a symbolic constant that determines the stencil comparison
-function. It accepts one of eight values, shown in the following list.
-REF is an integer reference value that is used in the stencil
-comparison. It is clamped to the range [0,2^N-1], where N is the number
-of bitplanes in the stencil buffer. MASK is bitwise ANDed with both the
-reference value and the stored stencil value, with the ANDed values
-participating in the comparison.
-
-If STENCIL represents the value stored in the corresponding stencil
-buffer location, the following list shows the effect of each comparison
-function that can be specified by FUNC. Only if the comparison succeeds
-is the pixel passed through to the next stage in the rasterization
-process (see `glStencilOp'). All tests treat STENCIL values as unsigned
-integers in the range [0,2^N-1], where N is the number of bitplanes in
-the stencil buffer.
-
-The following values are accepted by FUNC:
-
-`GL_NEVER'
- Always fails.
-
-`GL_LESS'
- Passes if ( REF & MASK ) < ( STENCIL & MASK ).
-
-`GL_LEQUAL'
- Passes if ( REF & MASK ) <= ( STENCIL & MASK ).
-
-`GL_GREATER'
- Passes if ( REF & MASK ) > ( STENCIL & MASK ).
-
-`GL_GEQUAL'
- Passes if ( REF & MASK ) >= ( STENCIL & MASK ).
-
-`GL_EQUAL'
- Passes if ( REF & MASK ) = ( STENCIL & MASK ).
-
-`GL_NOTEQUAL'
- Passes if ( REF & MASK ) != ( STENCIL & MASK ).
-
-`GL_ALWAYS'
- Always passes.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if FUNC is not one of the eight accepted
-values.
-
-`GL_INVALID_OPERATION' is generated if `glStencilFuncSeparate' is
-executed between the execution of `glBegin' and the corresponding
-execution of `glEnd'.")
-
-(define-gl-procedure
- glStencilFunc
- "glStencilFunc"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glStencilFunc"))
- (paramdef "GLenum " (parameter "func"))
- (paramdef "GLint " (parameter "ref"))
- (paramdef "GLuint " (parameter "mask"))))
- "set front and back function and reference value for stencil testing
-===================================================================
-
-
-Parameters
-==========
-
-FUNC
- Specifies the test function. Eight symbolic constants are valid:
- `GL_NEVER', `GL_LESS', `GL_LEQUAL', `GL_GREATER', `GL_GEQUAL',
- `GL_EQUAL', `GL_NOTEQUAL', and `GL_ALWAYS'. The initial value is
- `GL_ALWAYS'.
-
-REF
- Specifies the reference value for the stencil test. REF is clamped
- to the range [0,2^N-1], where N is the number of bitplanes in the
- stencil buffer. The initial value is 0.
-
-MASK
- Specifies a mask that is ANDed with both the reference value and
- the stored stencil value when the test is done. The initial value
- is all 1's.
-
-
-Description
-===========
-
-Stenciling, like depth-buffering, enables and disables drawing on a
-per-pixel basis. Stencil planes are first drawn into using GL drawing
-primitives, then geometry and images are rendered using the stencil
-planes to mask out portions of the screen. Stenciling is typically used
-in multipass rendering algorithms to achieve special effects, such as
-decals, outlining, and constructive solid geometry rendering.
-
-The stencil test conditionally eliminates a pixel based on the outcome
-of a comparison between the reference value and the value in the stencil
-buffer. To enable and disable the test, call `glEnable' and `glDisable'
-with argument `GL_STENCIL_TEST'. To specify actions based on the outcome
-of the stencil test, call `glStencilOp' or `glStencilOpSeparate'.
-
-There can be two separate sets of FUNC, REF, and MASK parameters; one
-affects back-facing polygons, and the other affects front-facing
-polygons as well as other non-polygon primitives. `glStencilFunc' sets
-both front and back stencil state to the same values. Use
-`glStencilFuncSeparate' to set front and back stencil state to different
-values.
-
-FUNC is a symbolic constant that determines the stencil comparison
-function. It accepts one of eight values, shown in the following list.
-REF is an integer reference value that is used in the stencil
-comparison. It is clamped to the range [0,2^N-1], where N is the number
-of bitplanes in the stencil buffer. MASK is bitwise ANDed with both the
-reference value and the stored stencil value, with the ANDed values
-participating in the comparison.
-
-If STENCIL represents the value stored in the corresponding stencil
-buffer location, the following list shows the effect of each comparison
-function that can be specified by FUNC. Only if the comparison succeeds
-is the pixel passed through to the next stage in the rasterization
-process (see `glStencilOp'). All tests treat STENCIL values as unsigned
-integers in the range [0,2^N-1], where N is the number of bitplanes in
-the stencil buffer.
-
-The following values are accepted by FUNC:
-
-`GL_NEVER'
- Always fails.
-
-`GL_LESS'
- Passes if ( REF & MASK ) < ( STENCIL & MASK ).
-
-`GL_LEQUAL'
- Passes if ( REF & MASK ) <= ( STENCIL & MASK ).
-
-`GL_GREATER'
- Passes if ( REF & MASK ) > ( STENCIL & MASK ).
-
-`GL_GEQUAL'
- Passes if ( REF & MASK ) >= ( STENCIL & MASK ).
-
-`GL_EQUAL'
- Passes if ( REF & MASK ) = ( STENCIL & MASK ).
-
-`GL_NOTEQUAL'
- Passes if ( REF & MASK ) != ( STENCIL & MASK ).
-
-`GL_ALWAYS'
- Always passes.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if FUNC is not one of the eight accepted
-values.
-
-`GL_INVALID_OPERATION' is generated if `glStencilFunc' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glStencilMaskSeparate
- "glStencilMaskSeparate"
- (funcsynopsis
- (funcprototype
- (funcdef
- "void "
- (function "glStencilMaskSeparate"))
- (paramdef "GLenum " (parameter "face"))
- (paramdef "GLuint " (parameter "mask"))))
- "control the front and/or back writing of individual bits in the stencil planes
-==============================================================================
-
-
-Parameters
-==========
-
-FACE
- Specifies whether the front and/or back stencil writemask is
- updated. Three symbolic constants are valid: `GL_FRONT', `GL_BACK',
- and `GL_FRONT_AND_BACK'.
-
-MASK
- Specifies a bit mask to enable and disable writing of individual
- bits in the stencil planes. Initially, the mask is all 1's.
-
-
-Description
-===========
-
-`glStencilMaskSeparate' controls the writing of individual bits in the
-stencil planes. The least significant N bits of MASK, where N is the
-number of bits in the stencil buffer, specify a mask. Where a 1 appears
-in the mask, it's possible to write to the corresponding bit in the
-stencil buffer. Where a 0 appears, the corresponding bit is
-write-protected. Initially, all bits are enabled for writing.
-
-There can be two separate MASK writemasks; one affects back-facing
-polygons, and the other affects front-facing polygons as well as other
-non-polygon primitives. `glStencilMask' sets both front and back stencil
-writemasks to the same values, as if `glStencilMaskSeparate' were called
-with FACE set to `GL_FRONT_AND_BACK'.
-
-
-Errors
-======
-
-`GL_INVALID_OPERATION' is generated if `glStencilMaskSeparate' is
-executed between the execution of `glBegin' and the corresponding
-execution of `glEnd'.")
-
-(define-gl-procedure
- glStencilMask
- "glStencilMask"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glStencilMask"))
- (paramdef "GLuint " (parameter "mask"))))
- "control the front and back writing of individual bits in the stencil planes
-===========================================================================
-
-
-Parameters
-==========
-
-MASK
- Specifies a bit mask to enable and disable writing of individual
- bits in the stencil planes. Initially, the mask is all 1's.
-
-
-Description
-===========
-
-`glStencilMask' controls the writing of individual bits in the stencil
-planes. The least significant N bits of MASK, where N is the number of
-bits in the stencil buffer, specify a mask. Where a 1 appears in the
-mask, it's possible to write to the corresponding bit in the stencil
-buffer. Where a 0 appears, the corresponding bit is write-protected.
-Initially, all bits are enabled for writing.
-
-There can be two separate MASK writemasks; one affects back-facing
-polygons, and the other affects front-facing polygons as well as other
-non-polygon primitives. `glStencilMask' sets both front and back stencil
-writemasks to the same values. Use `glStencilMaskSeparate' to set front
-and back stencil writemasks to different values.
-
-
-Errors
-======
-
-`GL_INVALID_OPERATION' is generated if `glStencilMask' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glStencilOpSeparate
- "glStencilOpSeparate"
- (funcsynopsis
- (funcprototype
- (funcdef
- "void "
- (function "glStencilOpSeparate"))
- (paramdef "GLenum " (parameter "face"))
- (paramdef "GLenum " (parameter "sfail"))
- (paramdef "GLenum " (parameter "dpfail"))
- (paramdef "GLenum " (parameter "dppass"))))
- "set front and/or back stencil test actions
-==========================================
-
-
-Parameters
-==========
-
-FACE
- Specifies whether front and/or back stencil state is updated. Three
- symbolic constants are valid: `GL_FRONT', `GL_BACK', and
- `GL_FRONT_AND_BACK'.
-
-SFAIL
- Specifies the action to take when the stencil test fails. Eight
- symbolic constants are accepted: `GL_KEEP', `GL_ZERO',
- `GL_REPLACE', `GL_INCR', `GL_INCR_WRAP', `GL_DECR', `GL_DECR_WRAP',
- and `GL_INVERT'. The initial value is `GL_KEEP'.
-
-DPFAIL
- Specifies the stencil action when the stencil test passes, but the
- depth test fails. DPFAIL accepts the same symbolic constants as
- SFAIL. The initial value is `GL_KEEP'.
-
-DPPASS
- Specifies the stencil action when both the stencil test and the
- depth test pass, or when the stencil test passes and either there
- is no depth buffer or depth testing is not enabled. DPPASS accepts
- the same symbolic constants as SFAIL. The initial value is
- `GL_KEEP'.
-
-
-Description
-===========
-
-Stenciling, like depth-buffering, enables and disables drawing on a
-per-pixel basis. You draw into the stencil planes using GL drawing
-primitives, then render geometry and images, using the stencil planes to
-mask out portions of the screen. Stenciling is typically used in
-multipass rendering algorithms to achieve special effects, such as
-decals, outlining, and constructive solid geometry rendering.
-
-The stencil test conditionally eliminates a pixel based on the outcome
-of a comparison between the value in the stencil buffer and a reference
-value. To enable and disable the test, call `glEnable' and `glDisable'
-with argument `GL_STENCIL_TEST'; to control it, call `glStencilFunc' or
-`glStencilFuncSeparate'.
-
-There can be two separate sets of SFAIL, DPFAIL, and DPPASS parameters;
-one affects back-facing polygons, and the other affects front-facing
-polygons as well as other non-polygon primitives. `glStencilOp' sets
-both front and back stencil state to the same values, as if
-`glStencilOpSeparate' were called with FACE set to `GL_FRONT_AND_BACK'.
-
-`glStencilOpSeparate' takes three arguments that indicate what happens
-to the stored stencil value while stenciling is enabled. If the stencil
-test fails, no change is made to the pixel's color or depth buffers, and
-SFAIL specifies what happens to the stencil buffer contents. The
-following eight actions are possible.
-
-`GL_KEEP'
- Keeps the current value.
-
-`GL_ZERO'
- Sets the stencil buffer value to 0.
-
-`GL_REPLACE'
- Sets the stencil buffer value to REF, as specified by
- `glStencilFunc'.
-
-`GL_INCR'
- Increments the current stencil buffer value. Clamps to the maximum
- representable unsigned value.
-
-`GL_INCR_WRAP'
- Increments the current stencil buffer value. Wraps stencil buffer
- value to zero when incrementing the maximum representable unsigned
- value.
-
-`GL_DECR'
- Decrements the current stencil buffer value. Clamps to 0.
-
-`GL_DECR_WRAP'
- Decrements the current stencil buffer value. Wraps stencil buffer
- value to the maximum representable unsigned value when decrementing
- a stencil buffer value of zero.
-
-`GL_INVERT'
- Bitwise inverts the current stencil buffer value.
-
-Stencil buffer values are treated as unsigned integers. When incremented
-and decremented, values are clamped to 0 and 2^N-1, where N is the value
-returned by querying `GL_STENCIL_BITS'.
-
-The other two arguments to `glStencilOpSeparate' specify stencil buffer
-actions that depend on whether subsequent depth buffer tests succeed
-(DPPASS) or fail (DPFAIL) (see `glDepthFunc'). The actions are specified
-using the same eight symbolic constants as SFAIL. Note that DPFAIL is
-ignored when there is no depth buffer, or when the depth buffer is not
-enabled. In these cases, SFAIL and DPPASS specify stencil action when
-the stencil test fails and passes, respectively.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if FACE is any value other than
-`GL_FRONT', `GL_BACK', or `GL_FRONT_AND_BACK'.
-
-`GL_INVALID_ENUM' is generated if SFAIL, DPFAIL, or DPPASS is any value
-other than the eight defined constant values.
-
-`GL_INVALID_OPERATION' is generated if `glStencilOpSeparate' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glStencilOp
- "glStencilOp"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glStencilOp"))
- (paramdef "GLenum " (parameter "sfail"))
- (paramdef "GLenum " (parameter "dpfail"))
- (paramdef "GLenum " (parameter "dppass"))))
- "set front and back stencil test actions
-=======================================
-
-
-Parameters
-==========
-
-SFAIL
- Specifies the action to take when the stencil test fails. Eight
- symbolic constants are accepted: `GL_KEEP', `GL_ZERO',
- `GL_REPLACE', `GL_INCR', `GL_INCR_WRAP', `GL_DECR', `GL_DECR_WRAP',
- and `GL_INVERT'. The initial value is `GL_KEEP'.
-
-DPFAIL
- Specifies the stencil action when the stencil test passes, but the
- depth test fails. DPFAIL accepts the same symbolic constants as
- SFAIL. The initial value is `GL_KEEP'.
-
-DPPASS
- Specifies the stencil action when both the stencil test and the
- depth test pass, or when the stencil test passes and either there
- is no depth buffer or depth testing is not enabled. DPPASS accepts
- the same symbolic constants as SFAIL. The initial value is
- `GL_KEEP'.
-
-
-Description
-===========
-
-Stenciling, like depth-buffering, enables and disables drawing on a
-per-pixel basis. You draw into the stencil planes using GL drawing
-primitives, then render geometry and images, using the stencil planes to
-mask out portions of the screen. Stenciling is typically used in
-multipass rendering algorithms to achieve special effects, such as
-decals, outlining, and constructive solid geometry rendering.
-
-The stencil test conditionally eliminates a pixel based on the outcome
-of a comparison between the value in the stencil buffer and a reference
-value. To enable and disable the test, call `glEnable' and `glDisable'
-with argument `GL_STENCIL_TEST'; to control it, call `glStencilFunc' or
-`glStencilFuncSeparate'.
-
-There can be two separate sets of SFAIL, DPFAIL, and DPPASS parameters;
-one affects back-facing polygons, and the other affects front-facing
-polygons as well as other non-polygon primitives. `glStencilOp' sets
-both front and back stencil state to the same values. Use
-`glStencilOpSeparate' to set front and back stencil state to different
-values.
-
-`glStencilOp' takes three arguments that indicate what happens to the
-stored stencil value while stenciling is enabled. If the stencil test
-fails, no change is made to the pixel's color or depth buffers, and
-SFAIL specifies what happens to the stencil buffer contents. The
-following eight actions are possible.
-
-`GL_KEEP'
- Keeps the current value.
-
-`GL_ZERO'
- Sets the stencil buffer value to 0.
-
-`GL_REPLACE'
- Sets the stencil buffer value to REF, as specified by
- `glStencilFunc'.
-
-`GL_INCR'
- Increments the current stencil buffer value. Clamps to the maximum
- representable unsigned value.
-
-`GL_INCR_WRAP'
- Increments the current stencil buffer value. Wraps stencil buffer
- value to zero when incrementing the maximum representable unsigned
- value.
-
-`GL_DECR'
- Decrements the current stencil buffer value. Clamps to 0.
-
-`GL_DECR_WRAP'
- Decrements the current stencil buffer value. Wraps stencil buffer
- value to the maximum representable unsigned value when decrementing
- a stencil buffer value of zero.
-
-`GL_INVERT'
- Bitwise inverts the current stencil buffer value.
-
-Stencil buffer values are treated as unsigned integers. When incremented
-and decremented, values are clamped to 0 and 2^N-1, where N is the value
-returned by querying `GL_STENCIL_BITS'.
-
-The other two arguments to `glStencilOp' specify stencil buffer actions
-that depend on whether subsequent depth buffer tests succeed (DPPASS) or
-fail (DPFAIL) (see `glDepthFunc'). The actions are specified using the
-same eight symbolic constants as SFAIL. Note that DPFAIL is ignored when
-there is no depth buffer, or when the depth buffer is not enabled. In
-these cases, SFAIL and DPPASS specify stencil action when the stencil
-test fails and passes, respectively.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if SFAIL, DPFAIL, or DPPASS is any value
-other than the eight defined constant values.
-
-`GL_INVALID_OPERATION' is generated if `glStencilOp' is executed between
-the execution of `glBegin' and the corresponding execution of `glEnd'.")
-
-(define-gl-procedure
- glTexCoordPointer
- "glTexCoordPointer"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glTexCoordPointer"))
- (paramdef "GLint " (parameter "size"))
- (paramdef "GLenum " (parameter "type"))
- (paramdef "GLsizei " (parameter "stride"))
- (paramdef
- "const GLvoid * "
- (parameter "pointer"))))
- "define an array of texture coordinates
-======================================
-
-
-Parameters
-==========
-
-SIZE
- Specifies the number of coordinates per array element. Must be 1,
- 2, 3, or 4. The initial value is 4.
-
-TYPE
- Specifies the data type of each texture coordinate. Symbolic
- constants `GL_SHORT', `GL_INT', `GL_FLOAT', or `GL_DOUBLE' are
- accepted. The initial value is `GL_FLOAT'.
-
-STRIDE
- Specifies the byte offset between consecutive texture coordinate
- sets. If STRIDE is 0, the array elements are understood to be
- tightly packed. The initial value is 0.
-
-POINTER
- Specifies a pointer to the first coordinate of the first texture
- coordinate set in the array. The initial value is 0.
-
-
-Description
-===========
-
-`glTexCoordPointer' specifies the location and data format of an array
-of texture coordinates to use when rendering. SIZE specifies the number
-of coordinates per texture coordinate set, and must be 1, 2, 3, or 4.
-TYPE specifies the data type of each texture coordinate, and STRIDE
-specifies the byte stride from one texture coordinate set to the next,
-allowing vertices and attributes to be packed into a single array or
-stored in separate arrays. (Single-array storage may be more efficient
-on some implementations; see `glInterleavedArrays'.)
-
-If a non-zero named buffer object is bound to the `GL_ARRAY_BUFFER'
-target (see `glBindBuffer') while a texture coordinate array is
-specified, POINTER is treated as a byte offset into the buffer object's
-data store. Also, the buffer object binding (`GL_ARRAY_BUFFER_BINDING')
-is saved as texture coordinate vertex array client-side state
-(`GL_TEXTURE_COORD_ARRAY_BUFFER_BINDING').
-
-When a texture coordinate array is specified, SIZE, TYPE, STRIDE, and
-POINTER are saved as client-side state, in addition to the current
-vertex array buffer object binding.
-
-To enable and disable a texture coordinate array, call
-`glEnableClientState' and `glDisableClientState' with the argument
-`GL_TEXTURE_COORD_ARRAY'. If enabled, the texture coordinate array is
-used when `glArrayElement', `glDrawArrays', `glMultiDrawArrays',
-`glDrawElements', `glMultiDrawElements', or `glDrawRangeElements' is
-called.
-
-
-Errors
-======
-
-`GL_INVALID_VALUE' is generated if SIZE is not 1, 2, 3, or 4.
-
-`GL_INVALID_ENUM' is generated if TYPE is not an accepted value.
-
-`GL_INVALID_VALUE' is generated if STRIDE is negative.")
-
-(define-gl-procedure
- glTexCoord
- "glTexCoord"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glTexCoord1s"))
- (paramdef "GLshort " (parameter "s"))))
- "set the current texture coordinates
-===================================
-
-
-Parameters
-==========
-
-S
- T
-
- R
-
- Q
-
- Specify S, T, R, and Q texture coordinates. Not all parameters are
- present in all forms of the command.
-
-
-Description
-===========
-
-`glTexCoord' specifies texture coordinates in one, two, three, or four
-dimensions. `glTexCoord1' sets the current texture coordinates to
-(S,001); a call to `glTexCoord2' sets them to (S,T01). Similarly,
-`glTexCoord3' specifies the texture coordinates as (S,TR1), and
-`glTexCoord4' defines all four components explicitly as (S,TRQ).
-
-The current texture coordinates are part of the data that is associated
-with each vertex and with the current raster position. Initially, the
-values for S, T, R, and Q are (0, 0, 0, 1).")
-
-(define-gl-procedure
- glTexEnv
- "glTexEnv"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glTexEnvf"))
- (paramdef "GLenum " (parameter "target"))
- (paramdef "GLenum " (parameter "pname"))
- (paramdef "GLfloat " (parameter "param"))))
- "set texture environment parameters
-==================================
-
-
-Parameters
-==========
-
-TARGET
- Specifies a texture environment. May be `GL_TEXTURE_ENV',
- `GL_TEXTURE_FILTER_CONTROL' or `GL_POINT_SPRITE'.
-
-PNAME
- Specifies the symbolic name of a single-valued texture environment
- parameter. May be either `GL_TEXTURE_ENV_MODE',
- `GL_TEXTURE_LOD_BIAS', `GL_COMBINE_RGB', `GL_COMBINE_ALPHA',
- `GL_SRC0_RGB', `GL_SRC1_RGB', `GL_SRC2_RGB', `GL_SRC0_ALPHA',
- `GL_SRC1_ALPHA', `GL_SRC2_ALPHA', `GL_OPERAND0_RGB',
- `GL_OPERAND1_RGB', `GL_OPERAND2_RGB', `GL_OPERAND0_ALPHA',
- `GL_OPERAND1_ALPHA', `GL_OPERAND2_ALPHA', `GL_RGB_SCALE',
- `GL_ALPHA_SCALE', or `GL_COORD_REPLACE'.
-
-PARAM
- Specifies a single symbolic constant, one of `GL_ADD',
- `GL_ADD_SIGNED', `GL_INTERPOLATE', `GL_MODULATE', `GL_DECAL',
- `GL_BLEND', `GL_REPLACE', `GL_SUBTRACT', `GL_COMBINE',
- `GL_TEXTURE', `GL_CONSTANT', `GL_PRIMARY_COLOR', `GL_PREVIOUS',
- `GL_SRC_COLOR', `GL_ONE_MINUS_SRC_COLOR', `GL_SRC_ALPHA',
- `GL_ONE_MINUS_SRC_ALPHA', a single boolean value for the point
- sprite texture coordinate replacement, a single floating-point
- value for the texture level-of-detail bias, or 1.0, 2.0, or 4.0
- when specifying the `GL_RGB_SCALE' or `GL_ALPHA_SCALE'.
-
-
-Description
-===========
-
-A texture environment specifies how texture values are interpreted when
-a fragment is textured. When TARGET is `GL_TEXTURE_FILTER_CONTROL',
-PNAME must be `GL_TEXTURE_LOD_BIAS'. When TARGET is `GL_TEXTURE_ENV',
-PNAME can be `GL_TEXTURE_ENV_MODE', `GL_TEXTURE_ENV_COLOR',
-`GL_COMBINE_RGB', `GL_COMBINE_ALPHA', `GL_RGB_SCALE', `GL_ALPHA_SCALE',
-`GL_SRC0_RGB', `GL_SRC1_RGB', `GL_SRC2_RGB', `GL_SRC0_ALPHA',
-`GL_SRC1_ALPHA', or `GL_SRC2_ALPHA'.
-
-If PNAME is `GL_TEXTURE_ENV_MODE', then PARAMS is (or points to) the
-symbolic name of a texture function. Six texture functions may be
-specified: `GL_ADD', `GL_MODULATE', `GL_DECAL', `GL_BLEND',
-`GL_REPLACE', or `GL_COMBINE'.
-
-The following table shows the correspondence of filtered texture values
-R_T, G_T, B_T, A_T, L_T, I_T to texture source components. C_S and A_S
-are used by the texture functions described below.
-
-
-
-Texture Base Internal Format
-`C'_S, `A'_S`GL_ALPHA'
-
-(0, 0, 0) , A_T`GL_LUMINANCE'
-
-( L_T, L_T, L_T
-) ,
-1 `GL_LUMINANCE_ALPHA'
-
-( L_T, L_T, L_T
-) , A_T`GL_INTENSITY'
-
-( I_T, I_T, I_T
-) , I_T`GL_RGB'
-
-( R_T, G_T, B_T
-) ,
-1 `GL_RGBA'
-
-( R_T, G_T, B_T
-) , A_TA texture function acts on the fragment to be textured using the texture
-image value that applies to the fragment (see `glTexParameter') and
-produces an RGBA color for that fragment. The following table shows how
-the RGBA color is produced for each of the first five texture functions
-that can be chosen. C is a triple of color values (RGB) and A is the
-associated alpha value. RGBA values extracted from a texture image are
-in the range [0,1]. The subscript P refers to the color computed from
-the previous texture stage (or the incoming fragment if processing
-texture stage 0), the subscript S to the texture source color, the
-subscript C to the texture environment color, and the subscript V
-indicates a value produced by the texture function.
-
-
-
-Texture Base Internal Format
-`Value', `GL_REPLACE' Function , `GL_MODULATE' Function , `GL_DECAL' Function , `GL_BLEND' Function , `GL_ADD' Function `GL_ALPHA'
-C_V=, C_P, C_P,
-undefined , C_P, C_P
-A_V=, A_S, A_P\u2062A_S, , A_V=A_P\u2062A_S, A_P\u2062A_S`GL_LUMINANCE'
-C_V=, C_S, C_P\u2062C_S,
-undefined , C_P\u2062(1-C_S,)+C_C\u2062C_S, C_P+C_S(or 1)
-A_V=, A_P, A_P, , A_P, A_P`GL_LUMINANCE_ALPHA'
-C_V=, C_S, C_P\u2062C_S,
-undefined , C_P\u2062(1-C_S,)+C_C\u2062C_S, C_P+C_S(or 2)
-A_V=, A_S, A_P\u2062A_S, , A_P\u2062A_S, A_P\u2062A_S`GL_INTENSITY'
-C_V=, C_S, C_P\u2062C_S,
-undefined , C_P\u2062(1-C_S,)+C_C\u2062C_S, C_P+C_S
-A_V=, A_S, A_P\u2062A_S, , A_P\u2062(1-A_S,)+A_C\u2062A_S, A_P+A_S`GL_RGB'
-C_V=, C_S, C_P\u2062C_S, C_S, C_P\u2062(1-C_S,)+C_C\u2062C_S, C_P+C_S(or 3)
-A_V=, A_P, A_P, A_P, A_P, A_P`GL_RGBA'
-C_V=, C_S, C_P\u2062C_S, C_P\u2062(1-A_S,)+C_S\u2062A_S, C_P\u2062(1-C_S,)+C_C\u2062C_S, C_P+C_S(or 4)
-A_V=, A_S, A_P\u2062A_S, A_P, A_P\u2062A_S, A_P\u2062A_SIf PNAME is `GL_TEXTURE_ENV_MODE', and PARAMS is `GL_COMBINE', the form
-of the texture function depends on the values of `GL_COMBINE_RGB' and
-`GL_COMBINE_ALPHA'.
-
-The following describes how the texture sources, as specified by
-`GL_SRC0_RGB', `GL_SRC1_RGB', `GL_SRC2_RGB', `GL_SRC0_ALPHA',
-`GL_SRC1_ALPHA', and `GL_SRC2_ALPHA', are combined to produce a final
-texture color. In the following tables, `GL_SRC0_c' is represented by
-ARG0, `GL_SRC1_c' is represented by ARG1, and `GL_SRC2_c' is represented
-by ARG2.
-
-`GL_COMBINE_RGB' accepts any of `GL_REPLACE', `GL_MODULATE', `GL_ADD',
-`GL_ADD_SIGNED', `GL_INTERPOLATE', `GL_SUBTRACT', `GL_DOT3_RGB', or
-`GL_DOT3_RGBA'.
-
-
-
-*`GL_COMBINE_RGB'*
-*
-Texture Function *`GL_REPLACE'
-ARG0`GL_MODULATE'
-ARG0×ARG1`GL_ADD'
-ARG0+ARG1`GL_ADD_SIGNED'
-ARG0+ARG1-0.5`GL_INTERPOLATE'
-ARG0×ARG2+ARG1×(1-ARG2,)`GL_SUBTRACT'
-ARG0-ARG1`GL_DOT3_RGB' or `GL_DOT3_RGBA'
-4×(((ARG0_R,-0.5,)×(ARG1_R,-0.5,),)+((ARG0_G,-0.5,)×(ARG1_G,-0.5,),)+((ARG0_B,-0.5,)×(ARG1_B,-0.5,),),)The scalar results for `GL_DOT3_RGB' and `GL_DOT3_RGBA' are placed into
-each of the 3 (RGB) or 4 (RGBA) components on output.
-
-Likewise, `GL_COMBINE_ALPHA' accepts any of `GL_REPLACE', `GL_MODULATE',
-`GL_ADD', `GL_ADD_SIGNED', `GL_INTERPOLATE', or `GL_SUBTRACT'. The
-following table describes how alpha values are combined:
-
-
-
-*`GL_COMBINE_ALPHA'*
-*
-Texture Function *`GL_REPLACE'
-ARG0`GL_MODULATE'
-ARG0×ARG1`GL_ADD'
-ARG0+ARG1`GL_ADD_SIGNED'
-ARG0+ARG1-0.5`GL_INTERPOLATE'
-ARG0×ARG2+ARG1×(1-ARG2,)`GL_SUBTRACT'
-ARG0-ARG1In the following tables, the value C_S represents the color sampled from
-the currently bound texture, C_C represents the constant
-texture-environment color, C_F represents the primary color of the
-incoming fragment, and C_P represents the color computed from the
-previous texture stage or C_F if processing texture stage 0. Likewise,
-A_S, A_C, A_F, and A_P represent the respective alpha values.
-
-The following table describes the values assigned to ARG0, ARG1, and
-ARG2 based upon the RGB sources and operands:
-
-
-
-*`GL_SRCn_RGB'*
-*`GL_OPERANDn_RGB'*, *
-Argument Value *`GL_TEXTURE'
-`GL_SRC_COLOR', C_S,
-`GL_ONE_MINUS_SRC_COLOR', 1-C_S,
-`GL_SRC_ALPHA', A_S,
-`GL_ONE_MINUS_SRC_ALPHA', 1-A_S,`GL_TEXTUREn'
-`GL_SRC_COLOR', C_S,
-`GL_ONE_MINUS_SRC_COLOR', 1-C_S,
-`GL_SRC_ALPHA', A_S,
-`GL_ONE_MINUS_SRC_ALPHA', 1-A_S,`GL_CONSTANT'
-`GL_SRC_COLOR', C_C,
-`GL_ONE_MINUS_SRC_COLOR', 1-C_C,
-`GL_SRC_ALPHA', A_C,
-`GL_ONE_MINUS_SRC_ALPHA', 1-A_C,`GL_PRIMARY_COLOR'
-`GL_SRC_COLOR', C_F,
-`GL_ONE_MINUS_SRC_COLOR', 1-C_F,
-`GL_SRC_ALPHA', A_F,
-`GL_ONE_MINUS_SRC_ALPHA', 1-A_F,`GL_PREVIOUS'
-`GL_SRC_COLOR', C_P,
-`GL_ONE_MINUS_SRC_COLOR', 1-C_P,
-`GL_SRC_ALPHA', A_P,
-`GL_ONE_MINUS_SRC_ALPHA', 1-A_P,For `GL_TEXTUREn' sources, C_S and A_S represent the color and alpha,
-respectively, produced from texture stage N.
-
-The follow table describes the values assigned to ARG0, ARG1, and ARG2
-based upon the alpha sources and operands:
-
-
-
-*`GL_SRCn_ALPHA'*
-*`GL_OPERANDn_ALPHA'*, *
-Argument Value *`GL_TEXTURE'
-`GL_SRC_ALPHA', A_S,
-`GL_ONE_MINUS_SRC_ALPHA', 1-A_S,`GL_TEXTUREn'
-`GL_SRC_ALPHA', A_S,
-`GL_ONE_MINUS_SRC_ALPHA', 1-A_S,`GL_CONSTANT'
-`GL_SRC_ALPHA', A_C,
-`GL_ONE_MINUS_SRC_ALPHA', 1-A_C,`GL_PRIMARY_COLOR'
-`GL_SRC_ALPHA', A_F,
-`GL_ONE_MINUS_SRC_ALPHA', 1-A_F,`GL_PREVIOUS'
-`GL_SRC_ALPHA', A_P,
-`GL_ONE_MINUS_SRC_ALPHA', 1-A_P,The RGB and alpha results of the texture function are multipled by the
-values of `GL_RGB_SCALE' and `GL_ALPHA_SCALE', respectively, and clamped
-to the range [0,1].
-
-If PNAME is `GL_TEXTURE_ENV_COLOR', PARAMS is a pointer to an array that
-holds an RGBA color consisting of four values. Integer color components
-are interpreted linearly such that the most positive integer maps to
-1.0, and the most negative integer maps to -1.0. The values are clamped
-to the range [0,1] when they are specified. C_C takes these four values.
-
-If PNAME is `GL_TEXTURE_LOD_BIAS', the value specified is added to the
-texture level-of-detail parameter, that selects which mipmap, or mipmaps
-depending upon the selected `GL_TEXTURE_MIN_FILTER', will be sampled.
-
-`GL_TEXTURE_ENV_MODE' defaults to `GL_MODULATE' and
-`GL_TEXTURE_ENV_COLOR' defaults to (0, 0, 0, 0).
-
-If TARGET is `GL_POINT_SPRITE' and PNAME is `GL_COORD_REPLACE', the
-boolean value specified is used to either enable or disable point sprite
-texture coordinate replacement. The default value is `GL_FALSE'.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated when TARGET or PNAME is not one of the
-accepted defined values, or when PARAMS should have a defined constant
-value (based on the value of PNAME) and does not.
-
-`GL_INVALID_VALUE' is generated if the PARAMS value for `GL_RGB_SCALE'
-or `GL_ALPHA_SCALE' are not one of 1.0, 2.0, or 4.0.
-
-`GL_INVALID_OPERATION' is generated if `glTexEnv' is executed between
-the execution of `glBegin' and the corresponding execution of `glEnd'.")
-
-(define-gl-procedure
- glTexGen
- "glTexGen"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glTexGeni"))
- (paramdef "GLenum " (parameter "coord"))
- (paramdef "GLenum " (parameter "pname"))
- (paramdef "GLint " (parameter "param"))))
- "control the generation of texture coordinates
-=============================================
-
-
-Parameters
-==========
-
-COORD
- Specifies a texture coordinate. Must be one of `GL_S', `GL_T',
- `GL_R', or `GL_Q'.
-
-PNAME
- Specifies the symbolic name of the texture-coordinate generation
- function. Must be `GL_TEXTURE_GEN_MODE'.
-
-PARAM
- Specifies a single-valued texture generation parameter, one of
- `GL_OBJECT_LINEAR', `GL_EYE_LINEAR', `GL_SPHERE_MAP',
- `GL_NORMAL_MAP', or `GL_REFLECTION_MAP'.
-
-
-Description
-===========
-
-`glTexGen' selects a texture-coordinate generation function or supplies
-coefficients for one of the functions. COORD names one of the (S, T, R,
-Q) texture coordinates; it must be one of the symbols `GL_S', `GL_T',
-`GL_R', or `GL_Q'. PNAME must be one of three symbolic constants:
-`GL_TEXTURE_GEN_MODE', `GL_OBJECT_PLANE', or `GL_EYE_PLANE'. If PNAME is
-`GL_TEXTURE_GEN_MODE', then PARAMS chooses a mode, one of
-`GL_OBJECT_LINEAR', `GL_EYE_LINEAR', `GL_SPHERE_MAP', `GL_NORMAL_MAP',
-or `GL_REFLECTION_MAP'. If PNAME is either `GL_OBJECT_PLANE' or
-`GL_EYE_PLANE', PARAMS contains coefficients for the corresponding
-texture generation function.
-
-If the texture generation function is `GL_OBJECT_LINEAR', the function
-
-G=P_1×X_O+P_2×Y_O+P_3×Z_O+P_4×W_O
-
-is used, where G is the value computed for the coordinate named in
-COORD, P_1, P_2, P_3, and P_4 are the four values supplied in PARAMS,
-and X_O, Y_O, Z_O, and W_O are the object coordinates of the vertex.
-This function can be used, for example, to texture-map terrain using sea
-level as a reference plane (defined by P_1, P_2, P_3, and P_4). The
-altitude of a terrain vertex is computed by the `GL_OBJECT_LINEAR'
-coordinate generation function as its distance from sea level; that
-altitude can then be used to index the texture image to map white snow
-onto peaks and green grass onto foothills.
-
-If the texture generation function is `GL_EYE_LINEAR', the function
-
-G=P_1,^″×X_E+P_2,^″×Y_E+P_3,^″×Z_E+P_4,^″×W_E
-
-is used, where
-
-(P_1,^″\u2062P_2,^″\u2062P_3,^″\u2062P_4,^″,)=(P_1\u2062P_2\u2062P_3\u2062P_4,)\u2062M^-1
-
-and X_E, Y_E, Z_E, and W_E are the eye coordinates of the vertex, P_1,
-P_2, P_3, and P_4 are the values supplied in PARAMS, and M is the
-modelview matrix when `glTexGen' is invoked. If M is poorly conditioned
-or singular, texture coordinates generated by the resulting function may
-be inaccurate or undefined.
-
-Note that the values in PARAMS define a reference plane in eye
-coordinates. The modelview matrix that is applied to them may not be the
-same one in effect when the polygon vertices are transformed. This
-function establishes a field of texture coordinates that can produce
-dynamic contour lines on moving objects.
-
-If the texture generation function is `GL_SPHERE_MAP' and COORD is
-either `GL_S' or `GL_T', S and T texture coordinates are generated as
-follows. Let U be the unit vector pointing from the origin to the
-polygon vertex (in eye coordinates). Let N sup prime be the current
-normal, after transformation to eye coordinates. Let
-
-F=(F_X\u2062F_Y\u2062F_Z,)^T be the reflection vector such that
-
-F=U-2\u2062N^″\u2062N^″,^T\u2062U
-
-Finally, let M=2\u2062√(F_X,^2+F_Y,^2+(F_Z+1,)^2,). Then the values assigned
-to the S and T texture coordinates are
-
-S=F_X/M+1/2
-
-T=F_Y/M+1/2
-
-To enable or disable a texture-coordinate generation function, call
-`glEnable' or `glDisable' with one of the symbolic texture-coordinate
-names (`GL_TEXTURE_GEN_S', `GL_TEXTURE_GEN_T', `GL_TEXTURE_GEN_R', or
-`GL_TEXTURE_GEN_Q') as the argument. When enabled, the specified texture
-coordinate is computed according to the generating function associated
-with that coordinate. When disabled, subsequent vertices take the
-specified texture coordinate from the current set of texture
-coordinates. Initially, all texture generation functions are set to
-`GL_EYE_LINEAR' and are disabled. Both S plane equations are (1, 0, 0,
-0), both T plane equations are (0, 1, 0, 0), and all R and Q plane
-equations are (0, 0, 0, 0).
-
-When the `ARB_multitexture' extension is supported, `glTexGen' sets the
-texture generation parameters for the currently active texture unit,
-selected with `glActiveTexture'.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated when COORD or PNAME is not an accepted
-defined value, or when PNAME is `GL_TEXTURE_GEN_MODE' and PARAMS is not
-an accepted defined value.
-
-`GL_INVALID_ENUM' is generated when PNAME is `GL_TEXTURE_GEN_MODE',
-PARAMS is `GL_SPHERE_MAP', and COORD is either `GL_R' or `GL_Q'.
-
-`GL_INVALID_OPERATION' is generated if `glTexGen' is executed between
-the execution of `glBegin' and the corresponding execution of `glEnd'.")
-
-(define-gl-procedure
- glTexImage1D
- "glTexImage1D"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glTexImage1D"))
- (paramdef "GLenum " (parameter "target"))
- (paramdef "GLint " (parameter "level"))
- (paramdef "GLint " (parameter "internalFormat"))
- (paramdef "GLsizei " (parameter "width"))
- (paramdef "GLint " (parameter "border"))
- (paramdef "GLenum " (parameter "format"))
- (paramdef "GLenum " (parameter "type"))
- (paramdef "const GLvoid * " (parameter "data"))))
- "specify a one-dimensional texture image
-=======================================
-
-
-Parameters
-==========
-
-TARGET
- Specifies the target texture. Must be `GL_TEXTURE_1D' or
- `GL_PROXY_TEXTURE_1D'.
-
-LEVEL
- Specifies the level-of-detail number. Level 0 is the base image
- level. Level N is the Nth mipmap reduction image.
-
-INTERNALFORMAT
- Specifies the number of color components in the texture. Must be 1,
- 2, 3, or 4, or one of the following symbolic constants: `GL_ALPHA',
- `GL_ALPHA4', `GL_ALPHA8', `GL_ALPHA12', `GL_ALPHA16',
- `GL_COMPRESSED_ALPHA', `GL_COMPRESSED_LUMINANCE',
- `GL_COMPRESSED_LUMINANCE_ALPHA', `GL_COMPRESSED_INTENSITY',
- `GL_COMPRESSED_RGB', `GL_COMPRESSED_RGBA', `GL_DEPTH_COMPONENT',
- `GL_DEPTH_COMPONENT16', `GL_DEPTH_COMPONENT24',
- `GL_DEPTH_COMPONENT32', `GL_LUMINANCE', `GL_LUMINANCE4',
- `GL_LUMINANCE8', `GL_LUMINANCE12', `GL_LUMINANCE16',
- `GL_LUMINANCE_ALPHA', `GL_LUMINANCE4_ALPHA4',
- `GL_LUMINANCE6_ALPHA2', `GL_LUMINANCE8_ALPHA8',
- `GL_LUMINANCE12_ALPHA4', `GL_LUMINANCE12_ALPHA12',
- `GL_LUMINANCE16_ALPHA16', `GL_INTENSITY', `GL_INTENSITY4',
- `GL_INTENSITY8', `GL_INTENSITY12', `GL_INTENSITY16', `GL_R3_G3_B2',
- `GL_RGB', `GL_RGB4', `GL_RGB5', `GL_RGB8', `GL_RGB10', `GL_RGB12',
- `GL_RGB16', `GL_RGBA', `GL_RGBA2', `GL_RGBA4', `GL_RGB5_A1',
- `GL_RGBA8', `GL_RGB10_A2', `GL_RGBA12', `GL_RGBA16',
- `GL_SLUMINANCE', `GL_SLUMINANCE8', `GL_SLUMINANCE_ALPHA',
- `GL_SLUMINANCE8_ALPHA8', `GL_SRGB', `GL_SRGB8', `GL_SRGB_ALPHA', or
- `GL_SRGB8_ALPHA8'.
-
-WIDTH
- Specifies the width of the texture image including the border if
- any. If the GL version does not support non-power-of-two sizes,
- this value must be 2^N+2\u2061(BORDER,) for some integer N. All
- implementations support texture images that are at least 64 texels
- wide. The height of the 1D texture image is 1.
-
-BORDER
- Specifies the width of the border. Must be either 0 or 1.
-
-FORMAT
- Specifies the format of the pixel data. The following symbolic
- values are accepted: `GL_COLOR_INDEX', `GL_RED', `GL_GREEN',
- `GL_BLUE', `GL_ALPHA', `GL_RGB', `GL_BGR', `GL_RGBA', `GL_BGRA',
- `GL_LUMINANCE', and `GL_LUMINANCE_ALPHA'.
-
-TYPE
- Specifies the data type of the pixel data. The following symbolic
- values are accepted: `GL_UNSIGNED_BYTE', `GL_BYTE', `GL_BITMAP',
- `GL_UNSIGNED_SHORT', `GL_SHORT', `GL_UNSIGNED_INT', `GL_INT',
- `GL_FLOAT', `GL_UNSIGNED_BYTE_3_3_2', `GL_UNSIGNED_BYTE_2_3_3_REV',
- `GL_UNSIGNED_SHORT_5_6_5', `GL_UNSIGNED_SHORT_5_6_5_REV',
- `GL_UNSIGNED_SHORT_4_4_4_4', `GL_UNSIGNED_SHORT_4_4_4_4_REV',
- `GL_UNSIGNED_SHORT_5_5_5_1', `GL_UNSIGNED_SHORT_1_5_5_5_REV',
- `GL_UNSIGNED_INT_8_8_8_8', `GL_UNSIGNED_INT_8_8_8_8_REV',
- `GL_UNSIGNED_INT_10_10_10_2', and `GL_UNSIGNED_INT_2_10_10_10_REV'.
-
-DATA
- Specifies a pointer to the image data in memory.
-
-
-Description
-===========
-
-Texturing maps a portion of a specified texture image onto each
-graphical primitive for which texturing is enabled. To enable and
-disable one-dimensional texturing, call `glEnable' and `glDisable' with
-argument `GL_TEXTURE_1D'.
-
-Texture images are defined with `glTexImage1D'. The arguments describe
-the parameters of the texture image, such as width, width of the border,
-level-of-detail number (see `glTexParameter'), and the internal
-resolution and format used to store the image. The last three arguments
-describe how the image is represented in memory; they are identical to
-the pixel formats used for `glDrawPixels'.
-
-If TARGET is `GL_PROXY_TEXTURE_1D', no data is read from DATA, but all
-of the texture image state is recalculated, checked for consistency, and
-checked against the implementation's capabilities. If the implementation
-cannot handle a texture of the requested texture size, it sets all of
-the image state to 0, but does not generate an error (see `glGetError').
-To query for an entire mipmap array, use an image array level greater
-than or equal to 1.
-
-If TARGET is `GL_TEXTURE_1D', data is read from DATA as a sequence of
-signed or unsigned bytes, shorts, or longs, or single-precision
-floating-point values, depending on TYPE. These values are grouped into
-sets of one, two, three, or four values, depending on FORMAT, to form
-elements. If TYPE is `GL_BITMAP', the data is considered as a string of
-unsigned bytes (and FORMAT must be `GL_COLOR_INDEX'). Each data byte is
-treated as eight 1-bit elements, with bit ordering determined by
-`GL_UNPACK_LSB_FIRST' (see `glPixelStore').
-
-If a non-zero named buffer object is bound to the
-`GL_PIXEL_UNPACK_BUFFER' target (see `glBindBuffer') while a texture
-image is specified, DATA is treated as a byte offset into the buffer
-object's data store.
-
-The first element corresponds to the left end of the texture array.
-Subsequent elements progress left-to-right through the remaining texels
-in the texture array. The final element corresponds to the right end of
-the texture array.
-
-FORMAT determines the composition of each element in DATA. It can assume
-one of these symbolic values:
-
-`GL_COLOR_INDEX'
- Each element is a single value, a color index. The GL converts it
- to fixed point (with an unspecified number of zero bits to the
- right of the binary point), shifted left or right depending on the
- value and sign of `GL_INDEX_SHIFT', and added to `GL_INDEX_OFFSET'
- (see `glPixelTransfer'). The resulting index is converted to a set
- of color components using the `GL_PIXEL_MAP_I_TO_R',
- `GL_PIXEL_MAP_I_TO_G', `GL_PIXEL_MAP_I_TO_B', and
- `GL_PIXEL_MAP_I_TO_A' tables, and clamped to the range [0,1].
-
-`GL_RED'
- Each element is a single red component. The GL converts it to
- floating point and assembles it into an RGBA element by attaching 0
- for green and blue, and 1 for alpha. Each component is then
- multiplied by the signed scale factor `GL_c_SCALE', added to the
- signed bias `GL_c_BIAS', and clamped to the range [0,1] (see
- `glPixelTransfer').
-
-`GL_GREEN'
- Each element is a single green component. The GL converts it to
- floating point and assembles it into an RGBA element by attaching 0
- for red and blue, and 1 for alpha. Each component is then
- multiplied by the signed scale factor `GL_c_SCALE', added to the
- signed bias `GL_c_BIAS', and clamped to the range [0,1] (see
- `glPixelTransfer').
-
-`GL_BLUE'
- Each element is a single blue component. The GL converts it to
- floating point and assembles it into an RGBA element by attaching 0
- for red and green, and 1 for alpha. Each component is then
- multiplied by the signed scale factor `GL_c_SCALE', added to the
- signed bias `GL_c_BIAS', and clamped to the range [0,1] (see
- `glPixelTransfer').
-
-`GL_ALPHA'
- Each element is a single alpha component. The GL converts it to
- floating point and assembles it into an RGBA element by attaching 0
- for red, green, and blue. Each component is then multiplied by the
- signed scale factor `GL_c_SCALE', added to the signed bias
- `GL_c_BIAS', and clamped to the range [0,1] (see
- `glPixelTransfer').
-
-`GL_INTENSITY'
- Each element is a single intensity value. The GL converts it to
- floating point, then assembles it into an RGBA element by
- replicating the intensity value three times for red, green, blue,
- and alpha. Each component is then multiplied by the signed scale
- factor `GL_c_SCALE', added to the signed bias `GL_c_BIAS', and
- clamped to the range [0,1] (see `glPixelTransfer').
-
-`GL_RGB'
-`GL_BGR'
- Each element is an RGB triple. The GL converts it to floating point
- and assembles it into an RGBA element by attaching 1 for alpha.
- Each component is then multiplied by the signed scale factor
- `GL_c_SCALE', added to the signed bias `GL_c_BIAS', and clamped to
- the range [0,1] (see `glPixelTransfer').
-
-`GL_RGBA'
-`GL_BGRA'
- Each element contains all four components. Each component is
- multiplied by the signed scale factor `GL_c_SCALE', added to the
- signed bias `GL_c_BIAS', and clamped to the range [0,1] (see
- `glPixelTransfer').
-
-`GL_LUMINANCE'
- Each element is a single luminance value. The GL converts it to
- floating point, then assembles it into an RGBA element by
- replicating the luminance value three times for red, green, and
- blue and attaching 1 for alpha. Each component is then multiplied
- by the signed scale factor `GL_c_SCALE', added to the signed bias
- `GL_c_BIAS', and clamped to the range [0,1] (see
- `glPixelTransfer').
-
-`GL_LUMINANCE_ALPHA'
- Each element is a luminance/alpha pair. The GL converts it to
- floating point, then assembles it into an RGBA element by
- replicating the luminance value three times for red, green, and
- blue. Each component is then multiplied by the signed scale factor
- `GL_c_SCALE', added to the signed bias `GL_c_BIAS', and clamped to
- the range [0,1] (see `glPixelTransfer').
-
-`GL_DEPTH_COMPONENT'
- Each element is a single depth value. The GL converts it to
- floating point, multiplies by the signed scale factor
- `GL_DEPTH_SCALE', adds the signed bias `GL_DEPTH_BIAS', and clamps
- to the range [0,1] (see `glPixelTransfer').
-
-Refer to the `glDrawPixels' reference page for a description of the
-acceptable values for the TYPE parameter.
-
-If an application wants to store the texture at a certain resolution or
-in a certain format, it can request the resolution and format with
-INTERNALFORMAT. The GL will choose an internal representation that
-closely approximates that requested by INTERNALFORMAT, but it may not
-match exactly. (The representations specified by `GL_LUMINANCE',
-`GL_LUMINANCE_ALPHA', `GL_RGB', and `GL_RGBA' must match exactly. The
-numeric values 1, 2, 3, and 4 may also be used to specify the above
-representations.)
-
-If the INTERNALFORMAT parameter is one of the generic compressed
-formats, `GL_COMPRESSED_ALPHA', `GL_COMPRESSED_INTENSITY',
-`GL_COMPRESSED_LUMINANCE', `GL_COMPRESSED_LUMINANCE_ALPHA',
-`GL_COMPRESSED_RGB', or `GL_COMPRESSED_RGBA', the GL will replace the
-internal format with the symbolic constant for a specific internal
-format and compress the texture before storage. If no corresponding
-internal format is available, or the GL can not compress that image for
-any reason, the internal format is instead replaced with a corresponding
-base internal format.
-
-If the INTERNALFORMAT parameter is `GL_SRGB', `GL_SRGB8',
-`GL_SRGB_ALPHA', `GL_SRGB8_ALPHA8', `GL_SLUMINANCE', `GL_SLUMINANCE8',
-`GL_SLUMINANCE_ALPHA', or `GL_SLUMINANCE8_ALPHA8', the texture is
-treated as if the red, green, blue, or luminance components are encoded
-in the sRGB color space. Any alpha component is left unchanged. The
-conversion from the sRGB encoded component C_S to a linear component C_L
-is:
-
-C_L={(C_S/12.92 if C_S≤0.04045), ((`c'_`s'+0.055/1.055)^2.4 if
-C_S>0.04045)
-
-Assume C_S is the sRGB component in the range [0,1].
-
-Use the `GL_PROXY_TEXTURE_1D' target to try out a resolution and format.
-The implementation will update and recompute its best match for the
-requested storage resolution and format. To then query this state, call
-`glGetTexLevelParameter'. If the texture cannot be accommodated, texture
-state is set to 0.
-
-A one-component texture image uses only the red component of the RGBA
-color from DATA. A two-component image uses the R and A values. A
-three-component image uses the R, G, and B values. A four-component
-image uses all of the RGBA components.
-
-Depth textures can be treated as LUMINANCE, INTENSITY or ALPHA textures
-during texture filtering and application.\xa0Image-based shadowing\xa0can\xa0be
-\xa0enabled\xa0by\xa0comparing texture r coordinates to depth texture values to
-generate a boolean result. See `glTexParameter' for details on texture
-comparison.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if TARGET is not `GL_TEXTURE_1D' or
-`GL_PROXY_TEXTURE_1D'.
-
-`GL_INVALID_ENUM' is generated if FORMAT is not an accepted format
-constant. Format constants other than `GL_STENCIL_INDEX' are accepted.
-
-`GL_INVALID_ENUM' is generated if TYPE is not a type constant.
-
-`GL_INVALID_ENUM' is generated if TYPE is `GL_BITMAP' and FORMAT is not
-`GL_COLOR_INDEX'.
-
-`GL_INVALID_VALUE' is generated if LEVEL is less than 0.
-
-`GL_INVALID_VALUE' may be generated if LEVEL is greater than
-LOG_2\u2061(MAX,), where MAX is the returned value of `GL_MAX_TEXTURE_SIZE'.
-
-`GL_INVALID_VALUE' is generated if INTERNALFORMAT is not 1, 2, 3, 4, or
-one of the accepted resolution and format symbolic constants.
-
-`GL_INVALID_VALUE' is generated if WIDTH is less than 0 or greater than
-2 + `GL_MAX_TEXTURE_SIZE'.
-
-`GL_INVALID_VALUE' is generated if non-power-of-two textures are not
-supported and the WIDTH cannot be represented as 2^N+2\u2061(BORDER,) for
-some integer value of N.
-
-`GL_INVALID_VALUE' is generated if BORDER is not 0 or 1.
-
-`GL_INVALID_OPERATION' is generated if TYPE is one of
-`GL_UNSIGNED_BYTE_3_3_2', `GL_UNSIGNED_BYTE_2_3_3_REV',
-`GL_UNSIGNED_SHORT_5_6_5', or `GL_UNSIGNED_SHORT_5_6_5_REV' and FORMAT
-is not `GL_RGB'.
-
-`GL_INVALID_OPERATION' is generated if TYPE is one of
-`GL_UNSIGNED_SHORT_4_4_4_4', `GL_UNSIGNED_SHORT_4_4_4_4_REV',
-`GL_UNSIGNED_SHORT_5_5_5_1', `GL_UNSIGNED_SHORT_1_5_5_5_REV',
-`GL_UNSIGNED_INT_8_8_8_8', `GL_UNSIGNED_INT_8_8_8_8_REV',
-`GL_UNSIGNED_INT_10_10_10_2', or `GL_UNSIGNED_INT_2_10_10_10_REV' and
-FORMAT is neither `GL_RGBA' nor `GL_BGRA'.
-
-`GL_INVALID_OPERATION' is generated if FORMAT is `GL_DEPTH_COMPONENT'
-and INTERNALFORMAT is not `GL_DEPTH_COMPONENT', `GL_DEPTH_COMPONENT16',
-`GL_DEPTH_COMPONENT24', or `GL_DEPTH_COMPONENT32'.
-
-`GL_INVALID_OPERATION' is generated if INTERNALFORMAT is
-`GL_DEPTH_COMPONENT', `GL_DEPTH_COMPONENT16', `GL_DEPTH_COMPONENT24', or
-`GL_DEPTH_COMPONENT32', and FORMAT is not `GL_DEPTH_COMPONENT'.
-
-`GL_INVALID_OPERATION' is generated if a non-zero buffer object name is
-bound to the `GL_PIXEL_UNPACK_BUFFER' target and the buffer object's
-data store is currently mapped.
-
-`GL_INVALID_OPERATION' is generated if a non-zero buffer object name is
-bound to the `GL_PIXEL_UNPACK_BUFFER' target and the data would be
-unpacked from the buffer object such that the memory reads required
-would exceed the data store size.
-
-`GL_INVALID_OPERATION' is generated if a non-zero buffer object name is
-bound to the `GL_PIXEL_UNPACK_BUFFER' target and DATA is not evenly
-divisible into the number of bytes needed to store in memory a datum
-indicated by TYPE.
-
-`GL_INVALID_OPERATION' is generated if `glTexImage1D' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glTexImage2D
- "glTexImage2D"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glTexImage2D"))
- (paramdef "GLenum " (parameter "target"))
- (paramdef "GLint " (parameter "level"))
- (paramdef "GLint " (parameter "internalFormat"))
- (paramdef "GLsizei " (parameter "width"))
- (paramdef "GLsizei " (parameter "height"))
- (paramdef "GLint " (parameter "border"))
- (paramdef "GLenum " (parameter "format"))
- (paramdef "GLenum " (parameter "type"))
- (paramdef "const GLvoid * " (parameter "data"))))
- "specify a two-dimensional texture image
-=======================================
-
-
-Parameters
-==========
-
-TARGET
- Specifies the target texture. Must be `GL_TEXTURE_2D',
- `GL_PROXY_TEXTURE_2D', `GL_TEXTURE_CUBE_MAP_POSITIVE_X',
- `GL_TEXTURE_CUBE_MAP_NEGATIVE_X', `GL_TEXTURE_CUBE_MAP_POSITIVE_Y',
- `GL_TEXTURE_CUBE_MAP_NEGATIVE_Y', `GL_TEXTURE_CUBE_MAP_POSITIVE_Z',
- `GL_TEXTURE_CUBE_MAP_NEGATIVE_Z', or `GL_PROXY_TEXTURE_CUBE_MAP'.
-
-LEVEL
- Specifies the level-of-detail number. Level 0 is the base image
- level. Level N is the Nth mipmap reduction image.
-
-INTERNALFORMAT
- Specifies the number of color components in the texture. Must be 1,
- 2, 3, or 4, or one of the following symbolic constants: `GL_ALPHA',
- `GL_ALPHA4', `GL_ALPHA8', `GL_ALPHA12', `GL_ALPHA16',
- `GL_COMPRESSED_ALPHA', `GL_COMPRESSED_LUMINANCE',
- `GL_COMPRESSED_LUMINANCE_ALPHA', `GL_COMPRESSED_INTENSITY',
- `GL_COMPRESSED_RGB', `GL_COMPRESSED_RGBA', `GL_DEPTH_COMPONENT',
- `GL_DEPTH_COMPONENT16', `GL_DEPTH_COMPONENT24',
- `GL_DEPTH_COMPONENT32', `GL_LUMINANCE', `GL_LUMINANCE4',
- `GL_LUMINANCE8', `GL_LUMINANCE12', `GL_LUMINANCE16',
- `GL_LUMINANCE_ALPHA', `GL_LUMINANCE4_ALPHA4',
- `GL_LUMINANCE6_ALPHA2', `GL_LUMINANCE8_ALPHA8',
- `GL_LUMINANCE12_ALPHA4', `GL_LUMINANCE12_ALPHA12',
- `GL_LUMINANCE16_ALPHA16', `GL_INTENSITY', `GL_INTENSITY4',
- `GL_INTENSITY8', `GL_INTENSITY12', `GL_INTENSITY16', `GL_R3_G3_B2',
- `GL_RGB', `GL_RGB4', `GL_RGB5', `GL_RGB8', `GL_RGB10', `GL_RGB12',
- `GL_RGB16', `GL_RGBA', `GL_RGBA2', `GL_RGBA4', `GL_RGB5_A1',
- `GL_RGBA8', `GL_RGB10_A2', `GL_RGBA12', `GL_RGBA16',
- `GL_SLUMINANCE', `GL_SLUMINANCE8', `GL_SLUMINANCE_ALPHA',
- `GL_SLUMINANCE8_ALPHA8', `GL_SRGB', `GL_SRGB8', `GL_SRGB_ALPHA', or
- `GL_SRGB8_ALPHA8'.
-
-WIDTH
- Specifies the width of the texture image including the border if
- any. If the GL version does not support non-power-of-two sizes,
- this value must be 2^N+2\u2061(BORDER,) for some integer N. All
- implementations support texture images that are at least 64 texels
- wide.
-
-HEIGHT
- Specifies the height of the texture image including the border if
- any. If the GL version does not support non-power-of-two sizes,
- this value must be 2^M+2\u2061(BORDER,) for some integer M. All
- implementations support texture images that are at least 64 texels
- high.
-
-BORDER
- Specifies the width of the border. Must be either 0 or 1.
-
-FORMAT
- Specifies the format of the pixel data. The following symbolic
- values are accepted: `GL_COLOR_INDEX', `GL_RED', `GL_GREEN',
- `GL_BLUE', `GL_ALPHA', `GL_RGB', `GL_BGR', `GL_RGBA', `GL_BGRA',
- `GL_LUMINANCE', and `GL_LUMINANCE_ALPHA'.
-
-TYPE
- Specifies the data type of the pixel data. The following symbolic
- values are accepted: `GL_UNSIGNED_BYTE', `GL_BYTE', `GL_BITMAP',
- `GL_UNSIGNED_SHORT', `GL_SHORT', `GL_UNSIGNED_INT', `GL_INT',
- `GL_FLOAT', `GL_UNSIGNED_BYTE_3_3_2', `GL_UNSIGNED_BYTE_2_3_3_REV',
- `GL_UNSIGNED_SHORT_5_6_5', `GL_UNSIGNED_SHORT_5_6_5_REV',
- `GL_UNSIGNED_SHORT_4_4_4_4', `GL_UNSIGNED_SHORT_4_4_4_4_REV',
- `GL_UNSIGNED_SHORT_5_5_5_1', `GL_UNSIGNED_SHORT_1_5_5_5_REV',
- `GL_UNSIGNED_INT_8_8_8_8', `GL_UNSIGNED_INT_8_8_8_8_REV',
- `GL_UNSIGNED_INT_10_10_10_2', and `GL_UNSIGNED_INT_2_10_10_10_REV'.
-
-DATA
- Specifies a pointer to the image data in memory.
-
-
-Description
-===========
-
-Texturing maps a portion of a specified texture image onto each
-graphical primitive for which texturing is enabled. To enable and
-disable two-dimensional texturing, call `glEnable' and `glDisable' with
-argument `GL_TEXTURE_2D'. To enable and disable texturing using
-cube-mapped texture, call `glEnable' and `glDisable' with argument
-`GL_TEXTURE_CUBE_MAP'.
-
-To define texture images, call `glTexImage2D'. The arguments describe
-the parameters of the texture image, such as height, width, width of the
-border, level-of-detail number (see `glTexParameter'), and number of
-color components provided. The last three arguments describe how the
-image is represented in memory; they are identical to the pixel formats
-used for `glDrawPixels'.
-
-If TARGET is `GL_PROXY_TEXTURE_2D' or `GL_PROXY_TEXTURE_CUBE_MAP', no
-data is read from DATA, but all of the texture image state is
-recalculated, checked for consistency, and checked against the
-implementation's capabilities. If the implementation cannot handle a
-texture of the requested texture size, it sets all of the image state to
-0, but does not generate an error (see `glGetError'). To query for an
-entire mipmap array, use an image array level greater than or equal to
-1.
-
-If TARGET is `GL_TEXTURE_2D', or one of the `GL_TEXTURE_CUBE_MAP'
-targets, data is read from DATA as a sequence of signed or unsigned
-bytes, shorts, or longs, or single-precision floating-point values,
-depending on TYPE. These values are grouped into sets of one, two,
-three, or four values, depending on FORMAT, to form elements. If TYPE is
-`GL_BITMAP', the data is considered as a string of unsigned bytes (and
-FORMAT must be `GL_COLOR_INDEX'). Each data byte is treated as eight
-1-bit elements, with bit ordering determined by `GL_UNPACK_LSB_FIRST'
-(see `glPixelStore').
-
-If a non-zero named buffer object is bound to the
-`GL_PIXEL_UNPACK_BUFFER' target (see `glBindBuffer') while a texture
-image is specified, DATA is treated as a byte offset into the buffer
-object's data store.
-
-The first element corresponds to the lower left corner of the texture
-image. Subsequent elements progress left-to-right through the remaining
-texels in the lowest row of the texture image, and then in successively
-higher rows of the texture image. The final element corresponds to the
-upper right corner of the texture image.
-
-FORMAT determines the composition of each element in DATA. It can assume
-one of these symbolic values:
-
-`GL_COLOR_INDEX'
- Each element is a single value, a color index. The GL converts it
- to fixed point (with an unspecified number of zero bits to the
- right of the binary point), shifted left or right depending on the
- value and sign of `GL_INDEX_SHIFT', and added to `GL_INDEX_OFFSET'
- (see `glPixelTransfer'). The resulting index is converted to a set
- of color components using the `GL_PIXEL_MAP_I_TO_R',
- `GL_PIXEL_MAP_I_TO_G', `GL_PIXEL_MAP_I_TO_B', and
- `GL_PIXEL_MAP_I_TO_A' tables, and clamped to the range [0,1].
-
-`GL_RED'
- Each element is a single red component. The GL converts it to
- floating point and assembles it into an RGBA element by attaching 0
- for green and blue, and 1 for alpha. Each component is then
- multiplied by the signed scale factor `GL_c_SCALE', added to the
- signed bias `GL_c_BIAS', and clamped to the range [0,1] (see
- `glPixelTransfer').
-
-`GL_GREEN'
- Each element is a single green component. The GL converts it to
- floating point and assembles it into an RGBA element by attaching 0
- for red and blue, and 1 for alpha. Each component is then
- multiplied by the signed scale factor `GL_c_SCALE', added to the
- signed bias `GL_c_BIAS', and clamped to the range [0,1] (see
- `glPixelTransfer').
-
-`GL_BLUE'
- Each element is a single blue component. The GL converts it to
- floating point and assembles it into an RGBA element by attaching 0
- for red and green, and 1 for alpha. Each component is then
- multiplied by the signed scale factor `GL_c_SCALE', added to the
- signed bias `GL_c_BIAS', and clamped to the range [0,1] (see
- `glPixelTransfer').
-
-`GL_ALPHA'
- Each element is a single alpha component. The GL converts it to
- floating point and assembles it into an RGBA element by attaching 0
- for red, green, and blue. Each component is then multiplied by the
- signed scale factor `GL_c_SCALE', added to the signed bias
- `GL_c_BIAS', and clamped to the range [0,1] (see
- `glPixelTransfer').
-
-`GL_INTENSITY'
- Each element is a single intensity value. The GL converts it to
- floating point, then assembles it into an RGBA element by
- replicating the intensity value three times for red, green, blue,
- and alpha. Each component is then multiplied by the signed scale
- factor `GL_c_SCALE', added to the signed bias `GL_c_BIAS', and
- clamped to the range [0,1] (see `glPixelTransfer').
-
-`GL_RGB'
-`GL_BGR'
- Each element is an RGB triple. The GL converts it to floating point
- and assembles it into an RGBA element by attaching 1 for alpha.
- Each component is then multiplied by the signed scale factor
- `GL_c_SCALE', added to the signed bias `GL_c_BIAS', and clamped to
- the range [0,1] (see `glPixelTransfer').
-
-`GL_RGBA'
-`GL_BGRA'
- Each element contains all four components. Each component is
- multiplied by the signed scale factor `GL_c_SCALE', added to the
- signed bias `GL_c_BIAS', and clamped to the range [0,1] (see
- `glPixelTransfer').
-
-`GL_LUMINANCE'
- Each element is a single luminance value. The GL converts it to
- floating point, then assembles it into an RGBA element by
- replicating the luminance value three times for red, green, and
- blue and attaching 1 for alpha. Each component is then multiplied
- by the signed scale factor `GL_c_SCALE', added to the signed bias
- `GL_c_BIAS', and clamped to the range [0,1] (see
- `glPixelTransfer').
-
-`GL_LUMINANCE_ALPHA'
- Each element is a luminance/alpha pair. The GL converts it to
- floating point, then assembles it into an RGBA element by
- replicating the luminance value three times for red, green, and
- blue. Each component is then multiplied by the signed scale factor
- `GL_c_SCALE', added to the signed bias `GL_c_BIAS', and clamped to
- the range [0,1] (see `glPixelTransfer').
-
-`GL_DEPTH_COMPONENT'
- Each element is a single depth value. The GL converts it to
- floating point, multiplies by the signed scale factor
- `GL_DEPTH_SCALE', adds the signed bias `GL_DEPTH_BIAS', and clamps
- to the range [0,1] (see `glPixelTransfer').
-
-Refer to the `glDrawPixels' reference page for a description of the
-acceptable values for the TYPE parameter.
-
-If an application wants to store the texture at a certain resolution or
-in a certain format, it can request the resolution and format with
-INTERNALFORMAT. The GL will choose an internal representation that
-closely approximates that requested by INTERNALFORMAT, but it may not
-match exactly. (The representations specified by `GL_LUMINANCE',
-`GL_LUMINANCE_ALPHA', `GL_RGB', and `GL_RGBA' must match exactly. The
-numeric values 1, 2, 3, and 4 may also be used to specify the above
-representations.)
-
-If the INTERNALFORMAT parameter is one of the generic compressed
-formats, `GL_COMPRESSED_ALPHA', `GL_COMPRESSED_INTENSITY',
-`GL_COMPRESSED_LUMINANCE', `GL_COMPRESSED_LUMINANCE_ALPHA',
-`GL_COMPRESSED_RGB', or `GL_COMPRESSED_RGBA', the GL will replace the
-internal format with the symbolic constant for a specific internal
-format and compress the texture before storage. If no corresponding
-internal format is available, or the GL can not compress that image for
-any reason, the internal format is instead replaced with a corresponding
-base internal format.
-
-If the INTERNALFORMAT parameter is `GL_SRGB', `GL_SRGB8',
-`GL_SRGB_ALPHA', `GL_SRGB8_ALPHA8', `GL_SLUMINANCE', `GL_SLUMINANCE8',
-`GL_SLUMINANCE_ALPHA', or `GL_SLUMINANCE8_ALPHA8', the texture is
-treated as if the red, green, blue, or luminance components are encoded
-in the sRGB color space. Any alpha component is left unchanged. The
-conversion from the sRGB encoded component C_S to a linear component C_L
-is:
-
-C_L={(C_S/12.92 if C_S≤0.04045), ((`c'_`s'+0.055/1.055)^2.4 if
-C_S>0.04045)
-
-Assume C_S is the sRGB component in the range [0,1].
-
-Use the `GL_PROXY_TEXTURE_2D' or `GL_PROXY_TEXTURE_CUBE_MAP' target to
-try out a resolution and format. The implementation will update and
-recompute its best match for the requested storage resolution and
-format. To then query this state, call `glGetTexLevelParameter'. If the
-texture cannot be accommodated, texture state is set to 0.
-
-A one-component texture image uses only the red component of the RGBA
-color extracted from DATA. A two-component image uses the R and A
-values. A three-component image uses the R, G, and B values. A
-four-component image uses all of the RGBA components.
-
-Depth textures can be treated as LUMINANCE, INTENSITY or ALPHA textures
-during texture filtering and application.\xa0Image-based shadowing\xa0can\xa0be
-\xa0enabled\xa0by\xa0comparing texture r coordinates to depth texture values to
-generate a boolean result. See `glTexParameter' for details on texture
-comparison.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if TARGET is not `GL_TEXTURE_2D',
-`GL_PROXY_TEXTURE_2D', `GL_PROXY_TEXTURE_CUBE_MAP',
-`GL_TEXTURE_CUBE_MAP_POSITIVE_X', `GL_TEXTURE_CUBE_MAP_NEGATIVE_X',
-`GL_TEXTURE_CUBE_MAP_POSITIVE_Y', `GL_TEXTURE_CUBE_MAP_NEGATIVE_Y',
-`GL_TEXTURE_CUBE_MAP_POSITIVE_Z', or `GL_TEXTURE_CUBE_MAP_NEGATIVE_Z'.
-
-`GL_INVALID_ENUM' is generated if TARGET is one of the six cube map 2D
-image targets and the width and height parameters are not equal.
-
-`GL_INVALID_ENUM' is generated if TYPE is not a type constant.
-
-`GL_INVALID_ENUM' is generated if TYPE is `GL_BITMAP' and FORMAT is not
-`GL_COLOR_INDEX'.
-
-`GL_INVALID_VALUE' is generated if WIDTH or HEIGHT is less than 0 or
-greater than 2 + `GL_MAX_TEXTURE_SIZE'.
-
-`GL_INVALID_VALUE' is generated if LEVEL is less than 0.
-
-`GL_INVALID_VALUE' may be generated if LEVEL is greater than
-LOG_2\u2061(MAX,), where MAX is the returned value of `GL_MAX_TEXTURE_SIZE'.
-
-`GL_INVALID_VALUE' is generated if INTERNALFORMAT is not 1, 2, 3, 4, or
-one of the accepted resolution and format symbolic constants.
-
-`GL_INVALID_VALUE' is generated if WIDTH or HEIGHT is less than 0 or
-greater than 2 + `GL_MAX_TEXTURE_SIZE'.
-
-`GL_INVALID_VALUE' is generated if non-power-of-two textures are not
-supported and the WIDTH or HEIGHT cannot be represented as
-2^K+2\u2061(BORDER,) for some integer value of K.
-
-`GL_INVALID_VALUE' is generated if BORDER is not 0 or 1.
-
-`GL_INVALID_OPERATION' is generated if TYPE is one of
-`GL_UNSIGNED_BYTE_3_3_2', `GL_UNSIGNED_BYTE_2_3_3_REV',
-`GL_UNSIGNED_SHORT_5_6_5', or `GL_UNSIGNED_SHORT_5_6_5_REV' and FORMAT
-is not `GL_RGB'.
-
-`GL_INVALID_OPERATION' is generated if TYPE is one of
-`GL_UNSIGNED_SHORT_4_4_4_4', `GL_UNSIGNED_SHORT_4_4_4_4_REV',
-`GL_UNSIGNED_SHORT_5_5_5_1', `GL_UNSIGNED_SHORT_1_5_5_5_REV',
-`GL_UNSIGNED_INT_8_8_8_8', `GL_UNSIGNED_INT_8_8_8_8_REV',
-`GL_UNSIGNED_INT_10_10_10_2', or `GL_UNSIGNED_INT_2_10_10_10_REV' and
-FORMAT is neither `GL_RGBA' nor `GL_BGRA'.
-
-`GL_INVALID_OPERATION' is generated if TARGET is not `GL_TEXTURE_2D' or
-`GL_PROXY_TEXTURE_2D' and INTERNALFORMAT is `GL_DEPTH_COMPONENT',
-`GL_DEPTH_COMPONENT16', `GL_DEPTH_COMPONENT24', or
-`GL_DEPTH_COMPONENT32'.
-
-`GL_INVALID_OPERATION' is generated if FORMAT is `GL_DEPTH_COMPONENT'
-and INTERNALFORMAT is not `GL_DEPTH_COMPONENT', `GL_DEPTH_COMPONENT16',
-`GL_DEPTH_COMPONENT24', or `GL_DEPTH_COMPONENT32'.
-
-`GL_INVALID_OPERATION' is generated if INTERNALFORMAT is
-`GL_DEPTH_COMPONENT', `GL_DEPTH_COMPONENT16', `GL_DEPTH_COMPONENT24', or
-`GL_DEPTH_COMPONENT32', and FORMAT is not `GL_DEPTH_COMPONENT'.
-
-`GL_INVALID_OPERATION' is generated if a non-zero buffer object name is
-bound to the `GL_PIXEL_UNPACK_BUFFER' target and the buffer object's
-data store is currently mapped.
-
-`GL_INVALID_OPERATION' is generated if a non-zero buffer object name is
-bound to the `GL_PIXEL_UNPACK_BUFFER' target and the data would be
-unpacked from the buffer object such that the memory reads required
-would exceed the data store size.
-
-`GL_INVALID_OPERATION' is generated if a non-zero buffer object name is
-bound to the `GL_PIXEL_UNPACK_BUFFER' target and DATA is not evenly
-divisible into the number of bytes needed to store in memory a datum
-indicated by TYPE.
-
-`GL_INVALID_OPERATION' is generated if `glTexImage2D' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glTexImage3D
- "glTexImage3D"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glTexImage3D"))
- (paramdef "GLenum " (parameter "target"))
- (paramdef "GLint " (parameter "level"))
- (paramdef "GLint " (parameter "internalFormat"))
- (paramdef "GLsizei " (parameter "width"))
- (paramdef "GLsizei " (parameter "height"))
- (paramdef "GLsizei " (parameter "depth"))
- (paramdef "GLint " (parameter "border"))
- (paramdef "GLenum " (parameter "format"))
- (paramdef "GLenum " (parameter "type"))
- (paramdef "const GLvoid * " (parameter "data"))))
- "specify a three-dimensional texture image
-=========================================
-
-
-Parameters
-==========
-
-TARGET
- Specifies the target texture. Must be `GL_TEXTURE_3D' or
- `GL_PROXY_TEXTURE_3D'.
-
-LEVEL
- Specifies the level-of-detail number. Level 0 is the base image
- level. Level N is the N^TH mipmap reduction image.
-
-INTERNALFORMAT
- Specifies the number of color components in the texture. Must be 1,
- 2, 3, or 4, or one of the following symbolic constants: `GL_ALPHA',
- `GL_ALPHA4', `GL_ALPHA8', `GL_ALPHA12', `GL_ALPHA16',
- `GL_COMPRESSED_ALPHA', `GL_COMPRESSED_LUMINANCE',
- `GL_COMPRESSED_LUMINANCE_ALPHA', `GL_COMPRESSED_INTENSITY',
- `GL_COMPRESSED_RGB', `GL_COMPRESSED_RGBA', `GL_LUMINANCE',
- `GL_LUMINANCE4', `GL_LUMINANCE8', `GL_LUMINANCE12',
- `GL_LUMINANCE16', `GL_LUMINANCE_ALPHA', `GL_LUMINANCE4_ALPHA4',
- `GL_LUMINANCE6_ALPHA2', `GL_LUMINANCE8_ALPHA8',
- `GL_LUMINANCE12_ALPHA4', `GL_LUMINANCE12_ALPHA12',
- `GL_LUMINANCE16_ALPHA16', `GL_INTENSITY', `GL_INTENSITY4',
- `GL_INTENSITY8', `GL_INTENSITY12', `GL_INTENSITY16', `GL_R3_G3_B2',
- `GL_RGB', `GL_RGB4', `GL_RGB5', `GL_RGB8', `GL_RGB10', `GL_RGB12',
- `GL_RGB16', `GL_RGBA', `GL_RGBA2', `GL_RGBA4', `GL_RGB5_A1',
- `GL_RGBA8', `GL_RGB10_A2', `GL_RGBA12', `GL_RGBA16',
- `GL_SLUMINANCE', `GL_SLUMINANCE8', `GL_SLUMINANCE_ALPHA',
- `GL_SLUMINANCE8_ALPHA8', `GL_SRGB', `GL_SRGB8', `GL_SRGB_ALPHA', or
- `GL_SRGB8_ALPHA8'.
-
-WIDTH
- Specifies the width of the texture image including the border if
- any. If the GL version does not support non-power-of-two sizes,
- this value must be 2^N+2\u2061(BORDER,) for some integer N. All
- implementations support 3D texture images that are at least 16
- texels wide.
-
-HEIGHT
- Specifies the height of the texture image including the border if
- any. If the GL version does not support non-power-of-two sizes,
- this value must be 2^M+2\u2061(BORDER,) for some integer M. All
- implementations support 3D texture images that are at least 16
- texels high.
-
-DEPTH
- Specifies the depth of the texture image including the border if
- any. If the GL version does not support non-power-of-two sizes,
- this value must be 2^K+2\u2061(BORDER,) for some integer K. All
- implementations support 3D texture images that are at least 16
- texels deep.
-
-BORDER
- Specifies the width of the border. Must be either 0 or 1.
-
-FORMAT
- Specifies the format of the pixel data. The following symbolic
- values are accepted: `GL_COLOR_INDEX', `GL_RED', `GL_GREEN',
- `GL_BLUE', `GL_ALPHA', `GL_RGB', `GL_BGR', `GL_RGBA', `GL_BGRA',
- `GL_LUMINANCE', and `GL_LUMINANCE_ALPHA'.
-
-TYPE
- Specifies the data type of the pixel data. The following symbolic
- values are accepted: `GL_UNSIGNED_BYTE', `GL_BYTE', `GL_BITMAP',
- `GL_UNSIGNED_SHORT', `GL_SHORT', `GL_UNSIGNED_INT', `GL_INT',
- `GL_FLOAT', `GL_UNSIGNED_BYTE_3_3_2', `GL_UNSIGNED_BYTE_2_3_3_REV',
- `GL_UNSIGNED_SHORT_5_6_5', `GL_UNSIGNED_SHORT_5_6_5_REV',
- `GL_UNSIGNED_SHORT_4_4_4_4', `GL_UNSIGNED_SHORT_4_4_4_4_REV',
- `GL_UNSIGNED_SHORT_5_5_5_1', `GL_UNSIGNED_SHORT_1_5_5_5_REV',
- `GL_UNSIGNED_INT_8_8_8_8', `GL_UNSIGNED_INT_8_8_8_8_REV',
- `GL_UNSIGNED_INT_10_10_10_2', and `GL_UNSIGNED_INT_2_10_10_10_REV'.
-
-DATA
- Specifies a pointer to the image data in memory.
-
-
-Description
-===========
-
-Texturing maps a portion of a specified texture image onto each
-graphical primitive for which texturing is enabled. To enable and
-disable three-dimensional texturing, call `glEnable' and `glDisable'
-with argument `GL_TEXTURE_3D'.
-
-To define texture images, call `glTexImage3D'. The arguments describe
-the parameters of the texture image, such as height, width, depth, width
-of the border, level-of-detail number (see `glTexParameter'), and number
-of color components provided. The last three arguments describe how the
-image is represented in memory; they are identical to the pixel formats
-used for `glDrawPixels'.
-
-If TARGET is `GL_PROXY_TEXTURE_3D', no data is read from DATA, but all
-of the texture image state is recalculated, checked for consistency, and
-checked against the implementation's capabilities. If the implementation
-cannot handle a texture of the requested texture size, it sets all of
-the image state to 0, but does not generate an error (see `glGetError').
-To query for an entire mipmap array, use an image array level greater
-than or equal to 1.
-
-If TARGET is `GL_TEXTURE_3D', data is read from DATA as a sequence of
-signed or unsigned bytes, shorts, or longs, or single-precision
-floating-point values, depending on TYPE. These values are grouped into
-sets of one, two, three, or four values, depending on FORMAT, to form
-elements. If TYPE is `GL_BITMAP', the data is considered as a string of
-unsigned bytes (and FORMAT must be `GL_COLOR_INDEX'). Each data byte is
-treated as eight 1-bit elements, with bit ordering determined by
-`GL_UNPACK_LSB_FIRST' (see `glPixelStore').
-
-If a non-zero named buffer object is bound to the
-`GL_PIXEL_UNPACK_BUFFER' target (see `glBindBuffer') while a texture
-image is specified, DATA is treated as a byte offset into the buffer
-object's data store.
-
-The first element corresponds to the lower left corner of the texture
-image. Subsequent elements progress left-to-right through the remaining
-texels in the lowest row of the texture image, and then in successively
-higher rows of the texture image. The final element corresponds to the
-upper right corner of the texture image.
-
-FORMAT determines the composition of each element in DATA. It can assume
-one of these symbolic values:
-
-`GL_COLOR_INDEX'
- Each element is a single value, a color index. The GL converts it
- to fixed point (with an unspecified number of zero bits to the
- right of the binary point), shifted left or right depending on the
- value and sign of `GL_INDEX_SHIFT', and added to `GL_INDEX_OFFSET'
- (see `glPixelTransfer'). The resulting index is converted to a set
- of color components using the `GL_PIXEL_MAP_I_TO_R',
- `GL_PIXEL_MAP_I_TO_G', `GL_PIXEL_MAP_I_TO_B', and
- `GL_PIXEL_MAP_I_TO_A' tables, and clamped to the range [0,1].
-
-`GL_RED'
- Each element is a single red component. The GL converts it to
- floating point and assembles it into an RGBA element by attaching 0
- for green and blue, and 1 for alpha. Each component is then
- multiplied by the signed scale factor `GL_c_SCALE', added to the
- signed bias `GL_c_BIAS', and clamped to the range [0,1] (see
- `glPixelTransfer').
-
-`GL_GREEN'
- Each element is a single green component. The GL converts it to
- floating point and assembles it into an RGBA element by attaching 0
- for red and blue, and 1 for alpha. Each component is then
- multiplied by the signed scale factor `GL_c_SCALE', added to the
- signed bias `GL_c_BIAS', and clamped to the range [0,1] (see
- `glPixelTransfer').
-
-`GL_BLUE'
- Each element is a single blue component. The GL converts it to
- floating point and assembles it into an RGBA element by attaching 0
- for red and green, and 1 for alpha. Each component is then
- multiplied by the signed scale factor `GL_c_SCALE', added to the
- signed bias `GL_c_BIAS', and clamped to the range [0,1] (see
- `glPixelTransfer').
-
-`GL_ALPHA'
- Each element is a single alpha component. The GL converts it to
- floating point and assembles it into an RGBA element by attaching 0
- for red, green, and blue. Each component is then multiplied by the
- signed scale factor `GL_c_SCALE', added to the signed bias
- `GL_c_BIAS', and clamped to the range [0,1] (see
- `glPixelTransfer').
-
-`GL_INTENSITY'
- Each element is a single intensity value. The GL converts it to
- floating point, then assembles it into an RGBA element by
- replicating the intensity value three times for red, green, blue,
- and alpha. Each component is then multiplied by the signed scale
- factor `GL_c_SCALE', added to the signed bias `GL_c_BIAS', and
- clamped to the range [0,1] (see `glPixelTransfer').
-
-`GL_RGB'
-`GL_BGR'
- Each element is an RGB triple. The GL converts it to floating point
- and assembles it into an RGBA element by attaching 1 for alpha.
- Each component is then multiplied by the signed scale factor
- `GL_c_SCALE', added to the signed bias `GL_c_BIAS', and clamped to
- the range [0,1] (see `glPixelTransfer').
-
-`GL_RGBA'
-`GL_BGRA'
- Each element contains all four components. Each component is
- multiplied by the signed scale factor `GL_c_SCALE', added to the
- signed bias `GL_c_BIAS', and clamped to the range [0,1] (see
- `glPixelTransfer').
-
-`GL_LUMINANCE'
- Each element is a single luminance value. The GL converts it to
- floating point, then assembles it into an RGBA element by
- replicating the luminance value three times for red, green, and
- blue and attaching 1 for alpha. Each component is then multiplied
- by the signed scale factor `GL_c_SCALE', added to the signed bias
- `GL_c_BIAS', and clamped to the range [0,1] (see
- `glPixelTransfer').
-
-`GL_LUMINANCE_ALPHA'
- Each element is a luminance/alpha pair. The GL converts it to
- floating point, then assembles it into an RGBA element by
- replicating the luminance value three times for red, green, and
- blue. Each component is then multiplied by the signed scale factor
- `GL_c_SCALE', added to the signed bias `GL_c_BIAS', and clamped to
- the range [0,1] (see `glPixelTransfer').
-
-Refer to the `glDrawPixels' reference page for a description of the
-acceptable values for the TYPE parameter.
-
-If an application wants to store the texture at a certain resolution or
-in a certain format, it can request the resolution and format with
-INTERNALFORMAT. The GL will choose an internal representation that
-closely approximates that requested by INTERNALFORMAT, but it may not
-match exactly. (The representations specified by `GL_LUMINANCE',
-`GL_LUMINANCE_ALPHA', `GL_RGB', and `GL_RGBA' must match exactly. The
-numeric values 1, 2, 3, and 4 may also be used to specify the above
-representations.)
-
-If the INTERNALFORMAT parameter is one of the generic compressed
-formats, `GL_COMPRESSED_ALPHA', `GL_COMPRESSED_INTENSITY',
-`GL_COMPRESSED_LUMINANCE', `GL_COMPRESSED_LUMINANCE_ALPHA',
-`GL_COMPRESSED_RGB', or `GL_COMPRESSED_RGBA', the GL will replace the
-internal format with the symbolic constant for a specific internal
-format and compress the texture before storage. If no corresponding
-internal format is available, or the GL can not compress that image for
-any reason, the internal format is instead replaced with a corresponding
-base internal format.
-
-If the INTERNALFORMAT parameter is `GL_SRGB', `GL_SRGB8',
-`GL_SRGB_ALPHA', `GL_SRGB8_ALPHA8', `GL_SLUMINANCE', `GL_SLUMINANCE8',
-`GL_SLUMINANCE_ALPHA', or `GL_SLUMINANCE8_ALPHA8', the texture is
-treated as if the red, green, blue, or luminance components are encoded
-in the sRGB color space. Any alpha component is left unchanged. The
-conversion from the sRGB encoded component C_S to a linear component C_L
-is:
-
-C_L={(C_S/12.92 if C_S≤0.04045), ((`c'_`s'+0.055/1.055)^2.4 if
-C_S>0.04045)
-
-Assume C_S is the sRGB component in the range [0,1].
-
-Use the `GL_PROXY_TEXTURE_3D' target to try out a resolution and format.
-The implementation will update and recompute its best match for the
-requested storage resolution and format. To then query this state, call
-`glGetTexLevelParameter'. If the texture cannot be accommodated, texture
-state is set to 0.
-
-A one-component texture image uses only the red component of the RGBA
-color extracted from DATA. A two-component image uses the R and A
-values. A three-component image uses the R, G, and B values. A
-four-component image uses all of the RGBA components.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if TARGET is not `GL_TEXTURE_3D' or
-`GL_PROXY_TEXTURE_3D'.
-
-`GL_INVALID_ENUM' is generated if FORMAT is not an accepted format
-constant. Format constants other than `GL_STENCIL_INDEX' and
-`GL_DEPTH_COMPONENT' are accepted.
-
-`GL_INVALID_ENUM' is generated if TYPE is not a type constant.
-
-`GL_INVALID_ENUM' is generated if TYPE is `GL_BITMAP' and FORMAT is not
-`GL_COLOR_INDEX'.
-
-`GL_INVALID_VALUE' is generated if LEVEL is less than 0.
-
-`GL_INVALID_VALUE' may be generated if LEVEL is greater than
-LOG_2\u2061(MAX,), where MAX is the returned value of `GL_MAX_TEXTURE_SIZE'.
-
-`GL_INVALID_VALUE' is generated if INTERNALFORMAT is not 1, 2, 3, 4, or
-one of the accepted resolution and format symbolic constants.
-
-`GL_INVALID_VALUE' is generated if WIDTH, HEIGHT, or DEPTH is less than
-0 or greater than 2 + `GL_MAX_TEXTURE_SIZE'.
-
-`GL_INVALID_VALUE' is generated if non-power-of-two textures are not
-supported and the WIDTH, HEIGHT, or DEPTH cannot be represented as
-2^K+2\u2061(BORDER,) for some integer value of K.
-
-`GL_INVALID_VALUE' is generated if BORDER is not 0 or 1.
-
-`GL_INVALID_OPERATION' is generated if TYPE is one of
-`GL_UNSIGNED_BYTE_3_3_2', `GL_UNSIGNED_BYTE_2_3_3_REV',
-`GL_UNSIGNED_SHORT_5_6_5', or `GL_UNSIGNED_SHORT_5_6_5_REV' and FORMAT
-is not `GL_RGB'.
-
-`GL_INVALID_OPERATION' is generated if TYPE is one of
-`GL_UNSIGNED_SHORT_4_4_4_4', `GL_UNSIGNED_SHORT_4_4_4_4_REV',
-`GL_UNSIGNED_SHORT_5_5_5_1', `GL_UNSIGNED_SHORT_1_5_5_5_REV',
-`GL_UNSIGNED_INT_8_8_8_8', `GL_UNSIGNED_INT_8_8_8_8_REV',
-`GL_UNSIGNED_INT_10_10_10_2', or `GL_UNSIGNED_INT_2_10_10_10_REV' and
-FORMAT is neither `GL_RGBA' nor `GL_BGRA'.
-
-`GL_INVALID_OPERATION' is generated if FORMAT or INTERNALFORMAT is
-`GL_DEPTH_COMPONENT', `GL_DEPTH_COMPONENT16', `GL_DEPTH_COMPONENT24', or
-`GL_DEPTH_COMPONENT32'.
-
-`GL_INVALID_OPERATION' is generated if a non-zero buffer object name is
-bound to the `GL_PIXEL_UNPACK_BUFFER' target and the buffer object's
-data store is currently mapped.
-
-`GL_INVALID_OPERATION' is generated if a non-zero buffer object name is
-bound to the `GL_PIXEL_UNPACK_BUFFER' target and the data would be
-unpacked from the buffer object such that the memory reads required
-would exceed the data store size.
-
-`GL_INVALID_OPERATION' is generated if a non-zero buffer object name is
-bound to the `GL_PIXEL_UNPACK_BUFFER' target and DATA is not evenly
-divisible into the number of bytes needed to store in memory a datum
-indicated by TYPE.
-
-`GL_INVALID_OPERATION' is generated if `glTexImage3D' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glTexParameter
- "glTexParameter"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glTexParameterf"))
- (paramdef "GLenum " (parameter "target"))
- (paramdef "GLenum " (parameter "pname"))
- (paramdef "GLfloat " (parameter "param"))))
- "set texture parameters
-======================
-
-
-Parameters
-==========
-
-TARGET
- Specifies the target texture, which must be either `GL_TEXTURE_1D',
- `GL_TEXTURE_2D', `GL_TEXTURE_3D', or `GL_TEXTURE_CUBE_MAP'.
-
-PNAME
- Specifies the symbolic name of a single-valued texture parameter.
- PNAME can be one of the following: `GL_TEXTURE_MIN_FILTER',
- `GL_TEXTURE_MAG_FILTER', `GL_TEXTURE_MIN_LOD',
- `GL_TEXTURE_MAX_LOD', `GL_TEXTURE_BASE_LEVEL',
- `GL_TEXTURE_MAX_LEVEL', `GL_TEXTURE_WRAP_S', `GL_TEXTURE_WRAP_T',
- `GL_TEXTURE_WRAP_R', `GL_TEXTURE_PRIORITY',
- `GL_TEXTURE_COMPARE_MODE', `GL_TEXTURE_COMPARE_FUNC',
- `GL_DEPTH_TEXTURE_MODE', or `GL_GENERATE_MIPMAP'.
-
-PARAM
- Specifies the value of PNAME.
-
-
-Description
-===========
-
-Texture mapping is a technique that applies an image onto an object's
-surface as if the image were a decal or cellophane shrink-wrap. The
-image is created in texture space, with an (S, T) coordinate system. A
-texture is a one- or two-dimensional image and a set of parameters that
-determine how samples are derived from the image.
-
-`glTexParameter' assigns the value or values in PARAMS to the texture
-parameter specified as PNAME. TARGET defines the target texture, either
-`GL_TEXTURE_1D', `GL_TEXTURE_2D', or `GL_TEXTURE_3D'. The following
-symbols are accepted in PNAME:
-
-`GL_TEXTURE_MIN_FILTER'
- The texture minifying function is used whenever the pixel being
- textured maps to an area greater than one texture element. There
- are six defined minifying functions. Two of them use the nearest
- one or nearest four texture elements to compute the texture value.
- The other four use mipmaps.
-
- A mipmap is an ordered set of arrays representing the same image at
- progressively lower resolutions. If the texture has dimensions
- 2^N×2^M, there are MAX\u2061(N,M)+1 mipmaps. The first mipmap is the
- original texture, with dimensions 2^N×2^M. Each subsequent mipmap
- has dimensions 2^K-1,×2^L-1,, where 2^K×2^L are the dimensions of
- the previous mipmap, until either K=0 or L=0. At that point,
- subsequent mipmaps have dimension 1×2^L-1, or 2^K-1,×1 until the
- final mipmap, which has dimension 1×1. To define the mipmaps, call
- `glTexImage1D', `glTexImage2D', `glTexImage3D', `glCopyTexImage1D',
- or `glCopyTexImage2D' with the LEVEL argument indicating the order
- of the mipmaps. Level 0 is the original texture; level MAX\u2061(N,M) is
- the final 1×1 mipmap.
-
- PARAMS supplies a function for minifying the texture as one of the
- following: `GL_NEAREST' Returns the value of the texture element
- that is nearest (in Manhattan distance) to the center of the pixel
- being textured. `GL_LINEAR' Returns the weighted average of the
- four texture elements that are closest to the center of the pixel
- being textured. These can include border texture elements,
- depending on the values of `GL_TEXTURE_WRAP_S' and
- `GL_TEXTURE_WRAP_T', and on the exact mapping.
- `GL_NEAREST_MIPMAP_NEAREST' Chooses the mipmap that most closely
- matches the size of the pixel being textured and uses the
- `GL_NEAREST' criterion (the texture element nearest to the center
- of the pixel) to produce a texture value.
- `GL_LINEAR_MIPMAP_NEAREST' Chooses the mipmap that most closely
- matches the size of the pixel being textured and uses the
- `GL_LINEAR' criterion (a weighted average of the four texture
- elements that are closest to the center of the pixel) to produce a
- texture value. `GL_NEAREST_MIPMAP_LINEAR' Chooses the two mipmaps
- that most closely match the size of the pixel being textured and
- uses the `GL_NEAREST' criterion (the texture element nearest to the
- center of the pixel) to produce a texture value from each mipmap.
- The final texture value is a weighted average of those two values.
- `GL_LINEAR_MIPMAP_LINEAR' Chooses the two mipmaps that most closely
- match the size of the pixel being textured and uses the `GL_LINEAR'
- criterion (a weighted average of the four texture elements that are
- closest to the center of the pixel) to produce a texture value from
- each mipmap. The final texture value is a weighted average of those
- two values.
-
- As more texture elements are sampled in the minification process,
- fewer aliasing artifacts will be apparent. While the `GL_NEAREST'
- and `GL_LINEAR' minification functions can be faster than the other
- four, they sample only one or four texture elements to determine
- the texture value of the pixel being rendered and can produce moire
- patterns or ragged transitions. The initial value of
- `GL_TEXTURE_MIN_FILTER' is `GL_NEAREST_MIPMAP_LINEAR'.
-
-`GL_TEXTURE_MAG_FILTER'
- The texture magnification function is used when the pixel being
- textured maps to an area less than or equal to one texture element.
- It sets the texture magnification function to either `GL_NEAREST'
- or `GL_LINEAR' (see below). `GL_NEAREST' is generally faster than
- `GL_LINEAR', but it can produce textured images with sharper edges
- because the transition between texture elements is not as smooth.
- The initial value of `GL_TEXTURE_MAG_FILTER' is `GL_LINEAR'.
- `GL_NEAREST' Returns the value of the texture element that is
- nearest (in Manhattan distance) to the center of the pixel being
- textured. `GL_LINEAR' Returns the weighted average of the four
- texture elements that are closest to the center of the pixel being
- textured. These can include border texture elements, depending on
- the values of `GL_TEXTURE_WRAP_S' and `GL_TEXTURE_WRAP_T', and on
- the exact mapping.
-
-
-
-`GL_TEXTURE_MIN_LOD'
- Sets the minimum level-of-detail parameter. This floating-point
- value limits the selection of highest resolution mipmap (lowest
- mipmap level). The initial value is -1000.
-
-
-
-`GL_TEXTURE_MAX_LOD'
- Sets the maximum level-of-detail parameter. This floating-point
- value limits the selection of the lowest resolution mipmap (highest
- mipmap level). The initial value is 1000.
-
-
-
-`GL_TEXTURE_BASE_LEVEL'
- Specifies the index of the lowest defined mipmap level. This is an
- integer value. The initial value is 0.
-
-
-
-`GL_TEXTURE_MAX_LEVEL'
- Sets the index of the highest defined mipmap level. This is an
- integer value. The initial value is 1000.
-
-
-
-`GL_TEXTURE_WRAP_S'
- Sets the wrap parameter for texture coordinate S to either
- `GL_CLAMP', `GL_CLAMP_TO_BORDER', `GL_CLAMP_TO_EDGE',
- `GL_MIRRORED_REPEAT', or `GL_REPEAT'. `GL_CLAMP' causes S
- coordinates to be clamped to the range [0,1] and is useful for
- preventing wrapping artifacts when mapping a single image onto an
- object. `GL_CLAMP_TO_BORDER' causes the S coordinate to be clamped
- to the range [-1/2N,,1+1/2N,], where N is the size of the texture
- in the direction of clamping.`GL_CLAMP_TO_EDGE' causes S
- coordinates to be clamped to the range [1/2N,,1-1/2N,], where N is
- the size of the texture in the direction of clamping. `GL_REPEAT'
- causes the integer part of the S coordinate to be ignored; the GL
- uses only the fractional part, thereby creating a repeating
- pattern. `GL_MIRRORED_REPEAT' causes the S coordinate to be set to
- the fractional part of the texture coordinate if the integer part
- of S is even; if the integer part of S is odd, then the S texture
- coordinate is set to 1-FRAC\u2061(S,), where FRAC\u2061(S,) represents the
- fractional part of S. Border texture elements are accessed only if
- wrapping is set to `GL_CLAMP' or `GL_CLAMP_TO_BORDER'. Initially,
- `GL_TEXTURE_WRAP_S' is set to `GL_REPEAT'.
-
-
-
-`GL_TEXTURE_WRAP_T'
- Sets the wrap parameter for texture coordinate T to either
- `GL_CLAMP', `GL_CLAMP_TO_BORDER', `GL_CLAMP_TO_EDGE',
- `GL_MIRRORED_REPEAT', or `GL_REPEAT'. See the discussion under
- `GL_TEXTURE_WRAP_S'. Initially, `GL_TEXTURE_WRAP_T' is set to
- `GL_REPEAT'.
-
-`GL_TEXTURE_WRAP_R'
- Sets the wrap parameter for texture coordinate R to either
- `GL_CLAMP', `GL_CLAMP_TO_BORDER', `GL_CLAMP_TO_EDGE',
- `GL_MIRRORED_REPEAT', or `GL_REPEAT'. See the discussion under
- `GL_TEXTURE_WRAP_S'. Initially, `GL_TEXTURE_WRAP_R' is set to
- `GL_REPEAT'.
-
-`GL_TEXTURE_BORDER_COLOR'
- Sets a border color. PARAMS contains four values that comprise the
- RGBA color of the texture border. Integer color components are
- interpreted linearly such that the most positive integer maps to
- 1.0, and the most negative integer maps to -1.0. The values are
- clamped to the range [0,1] when they are specified. Initially, the
- border color is (0, 0, 0, 0).
-
-`GL_TEXTURE_PRIORITY'
- Specifies the texture residence priority of the currently bound
- texture. Permissible values are in the range [0,1]. See
- `glPrioritizeTextures' and `glBindTexture' for more information.
-
-`GL_TEXTURE_COMPARE_MODE'
- Specifies the texture comparison mode for currently bound depth
- textures. That is, a texture whose internal format is
- `GL_DEPTH_COMPONENT_*'; see `glTexImage2D') Permissible values are:
- `GL_COMPARE_R_TO_TEXTURE' Specifies that the interpolated and
- clamped R texture coordinate should be compared to the value in the
- currently bound depth texture. See the discussion of
- `GL_TEXTURE_COMPARE_FUNC' for details of how the comparison is
- evaluated. The result of the comparison is assigned to luminance,
- intensity, or alpha (as specified by `GL_DEPTH_TEXTURE_MODE').
- `GL_NONE' Specifies that the luminance, intensity, or alpha (as
- specified by `GL_DEPTH_TEXTURE_MODE') should be assigned the
- appropriate value from the currently bound depth texture.
-
-`GL_TEXTURE_COMPARE_FUNC'
- Specifies the comparison operator used when
- `GL_TEXTURE_COMPARE_MODE' is set to `GL_COMPARE_R_TO_TEXTURE'.
- Permissible values are: * Texture Comparison Function * * Computed
- result * `GL_LEQUAL' RESULT={(1.0), (0.0)\u2062\xa0(R<=D_T,), (R>D_T,),
- `GL_GEQUAL' RESULT={(1.0), (0.0)\u2062\xa0(R>=D_T,), (R<D_T,), `GL_LESS'
- RESULT={(1.0), (0.0)\u2062\xa0(R<D_T,), (R>=D_T,), `GL_GREATER'
- RESULT={(1.0), (0.0)\u2062\xa0(R>D_T,), (R<=D_T,), `GL_EQUAL'
- RESULT={(1.0), (0.0)\u2062\xa0(R=D_T,), (R≠D_T,), `GL_NOTEQUAL'
- RESULT={(1.0), (0.0)\u2062\xa0(R≠D_T,), (R=D_T,), `GL_ALWAYS' RESULT=`1.0'
- `GL_NEVER' RESULT=`0.0' where R is the current interpolated texture
- coordinate, and D_T is the depth texture value sampled from the
- currently bound depth texture. RESULT is assigned to the either the
- luminance, intensity, or alpha (as specified by
- `GL_DEPTH_TEXTURE_MODE'.)
-
-`GL_DEPTH_TEXTURE_MODE'
- Specifies a single symbolic constant indicating how depth values
- should be treated during filtering and texture application.
- Accepted values are `GL_LUMINANCE', `GL_INTENSITY', and `GL_ALPHA'.
- The initial value is `GL_LUMINANCE'.
-
-`GL_GENERATE_MIPMAP'
- Specifies a boolean value that indicates if all levels of a mipmap
- array should be automatically updated when any modification to the
- base level mipmap is done. The initial value is `GL_FALSE'.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if TARGET or PNAME is not one of the
-accepted defined values.
-
-`GL_INVALID_ENUM' is generated if PARAMS should have a defined constant
-value (based on the value of PNAME) and does not.
-
-`GL_INVALID_OPERATION' is generated if `glTexParameter' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glTexSubImage1D
- "glTexSubImage1D"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glTexSubImage1D"))
- (paramdef "GLenum " (parameter "target"))
- (paramdef "GLint " (parameter "level"))
- (paramdef "GLint " (parameter "xoffset"))
- (paramdef "GLsizei " (parameter "width"))
- (paramdef "GLenum " (parameter "format"))
- (paramdef "GLenum " (parameter "type"))
- (paramdef "const GLvoid * " (parameter "data"))))
- "specify a one-dimensional texture subimage
-==========================================
-
-
-Parameters
-==========
-
-TARGET
- Specifies the target texture. Must be `GL_TEXTURE_1D'.
-
-LEVEL
- Specifies the level-of-detail number. Level 0 is the base image
- level. Level N is the Nth mipmap reduction image.
-
-XOFFSET
- Specifies a texel offset in the x direction within the texture
- array.
-
-WIDTH
- Specifies the width of the texture subimage.
-
-FORMAT
- Specifies the format of the pixel data. The following symbolic
- values are accepted: `GL_COLOR_INDEX', `GL_RED', `GL_GREEN',
- `GL_BLUE', `GL_ALPHA', `GL_RGB', `GL_BGR', `GL_RGBA', `GL_BGRA',
- `GL_LUMINANCE', and `GL_LUMINANCE_ALPHA'.
-
-TYPE
- Specifies the data type of the pixel data. The following symbolic
- values are accepted: `GL_UNSIGNED_BYTE', `GL_BYTE', `GL_BITMAP',
- `GL_UNSIGNED_SHORT', `GL_SHORT', `GL_UNSIGNED_INT', `GL_INT',
- `GL_FLOAT', `GL_UNSIGNED_BYTE_3_3_2', `GL_UNSIGNED_BYTE_2_3_3_REV',
- `GL_UNSIGNED_SHORT_5_6_5', `GL_UNSIGNED_SHORT_5_6_5_REV',
- `GL_UNSIGNED_SHORT_4_4_4_4', `GL_UNSIGNED_SHORT_4_4_4_4_REV',
- `GL_UNSIGNED_SHORT_5_5_5_1', `GL_UNSIGNED_SHORT_1_5_5_5_REV',
- `GL_UNSIGNED_INT_8_8_8_8', `GL_UNSIGNED_INT_8_8_8_8_REV',
- `GL_UNSIGNED_INT_10_10_10_2', and `GL_UNSIGNED_INT_2_10_10_10_REV'.
-
-DATA
- Specifies a pointer to the image data in memory.
-
-
-Description
-===========
-
-Texturing maps a portion of a specified texture image onto each
-graphical primitive for which texturing is enabled. To enable or disable
-one-dimensional texturing, call `glEnable' and `glDisable' with argument
-`GL_TEXTURE_1D'.
-
-`glTexSubImage1D' redefines a contiguous subregion of an existing
-one-dimensional texture image. The texels referenced by DATA replace the
-portion of the existing texture array with x indices XOFFSET and
-XOFFSET+WIDTH-1, inclusive. This region may not include any texels
-outside the range of the texture array as it was originally specified.
-It is not an error to specify a subtexture with width of 0, but such a
-specification has no effect.
-
-If a non-zero named buffer object is bound to the
-`GL_PIXEL_UNPACK_BUFFER' target (see `glBindBuffer') while a texture
-image is specified, DATA is treated as a byte offset into the buffer
-object's data store.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if TARGET is not one of the allowable
-values.
-
-`GL_INVALID_ENUM' is generated if FORMAT is not an accepted format
-constant.
-
-`GL_INVALID_ENUM' is generated if TYPE is not a type constant.
-
-`GL_INVALID_ENUM' is generated if TYPE is `GL_BITMAP' and FORMAT is not
-`GL_COLOR_INDEX'.
-
-`GL_INVALID_VALUE' is generated if LEVEL is less than 0.
-
-`GL_INVALID_VALUE' may be generated if LEVEL is greater than LOG_2MAX,
-where MAX is the returned value of `GL_MAX_TEXTURE_SIZE'.
-
-`GL_INVALID_VALUE' is generated if XOFFSET<-B, or if
-(XOFFSET+WIDTH,)>(W-B,), where W is the `GL_TEXTURE_WIDTH', and B is the
-width of the `GL_TEXTURE_BORDER' of the texture image being modified.
-Note that W includes twice the border width.
-
-`GL_INVALID_VALUE' is generated if WIDTH is less than 0.
-
-`GL_INVALID_OPERATION' is generated if the texture array has not been
-defined by a previous `glTexImage1D' operation.
-
-`GL_INVALID_OPERATION' is generated if TYPE is one of
-`GL_UNSIGNED_BYTE_3_3_2', `GL_UNSIGNED_BYTE_2_3_3_REV',
-`GL_UNSIGNED_SHORT_5_6_5', or `GL_UNSIGNED_SHORT_5_6_5_REV' and FORMAT
-is not `GL_RGB'.
-
-`GL_INVALID_OPERATION' is generated if TYPE is one of
-`GL_UNSIGNED_SHORT_4_4_4_4', `GL_UNSIGNED_SHORT_4_4_4_4_REV',
-`GL_UNSIGNED_SHORT_5_5_5_1', `GL_UNSIGNED_SHORT_1_5_5_5_REV',
-`GL_UNSIGNED_INT_8_8_8_8', `GL_UNSIGNED_INT_8_8_8_8_REV',
-`GL_UNSIGNED_INT_10_10_10_2', or `GL_UNSIGNED_INT_2_10_10_10_REV' and
-FORMAT is neither `GL_RGBA' nor `GL_BGRA'.
-
-`GL_INVALID_OPERATION' is generated if a non-zero buffer object name is
-bound to the `GL_PIXEL_UNPACK_BUFFER' target and the buffer object's
-data store is currently mapped.
-
-`GL_INVALID_OPERATION' is generated if a non-zero buffer object name is
-bound to the `GL_PIXEL_UNPACK_BUFFER' target and the data would be
-unpacked from the buffer object such that the memory reads required
-would exceed the data store size.
-
-`GL_INVALID_OPERATION' is generated if a non-zero buffer object name is
-bound to the `GL_PIXEL_UNPACK_BUFFER' target and DATA is not evenly
-divisible into the number of bytes needed to store in memory a datum
-indicated by TYPE.
-
-`GL_INVALID_OPERATION' is generated if `glTexSubImage1D' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glTexSubImage2D
- "glTexSubImage2D"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glTexSubImage2D"))
- (paramdef "GLenum " (parameter "target"))
- (paramdef "GLint " (parameter "level"))
- (paramdef "GLint " (parameter "xoffset"))
- (paramdef "GLint " (parameter "yoffset"))
- (paramdef "GLsizei " (parameter "width"))
- (paramdef "GLsizei " (parameter "height"))
- (paramdef "GLenum " (parameter "format"))
- (paramdef "GLenum " (parameter "type"))
- (paramdef "const GLvoid * " (parameter "data"))))
- "specify a two-dimensional texture subimage
-==========================================
-
-
-Parameters
-==========
-
-TARGET
- Specifies the target texture. Must be `GL_TEXTURE_2D',
- `GL_TEXTURE_CUBE_MAP_POSITIVE_X', `GL_TEXTURE_CUBE_MAP_NEGATIVE_X',
- `GL_TEXTURE_CUBE_MAP_POSITIVE_Y', `GL_TEXTURE_CUBE_MAP_NEGATIVE_Y',
- `GL_TEXTURE_CUBE_MAP_POSITIVE_Z', or
- `GL_TEXTURE_CUBE_MAP_NEGATIVE_Z'.
-
-LEVEL
- Specifies the level-of-detail number. Level 0 is the base image
- level. Level N is the Nth mipmap reduction image.
-
-XOFFSET
- Specifies a texel offset in the x direction within the texture
- array.
-
-YOFFSET
- Specifies a texel offset in the y direction within the texture
- array.
-
-WIDTH
- Specifies the width of the texture subimage.
-
-HEIGHT
- Specifies the height of the texture subimage.
-
-FORMAT
- Specifies the format of the pixel data. The following symbolic
- values are accepted: `GL_COLOR_INDEX', `GL_RED', `GL_GREEN',
- `GL_BLUE', `GL_ALPHA', `GL_RGB', `GL_BGR', `GL_RGBA', `GL_BGRA',
- `GL_LUMINANCE', and `GL_LUMINANCE_ALPHA'.
-
-TYPE
- Specifies the data type of the pixel data. The following symbolic
- values are accepted: `GL_UNSIGNED_BYTE', `GL_BYTE', `GL_BITMAP',
- `GL_UNSIGNED_SHORT', `GL_SHORT', `GL_UNSIGNED_INT', `GL_INT',
- `GL_FLOAT', `GL_UNSIGNED_BYTE_3_3_2', `GL_UNSIGNED_BYTE_2_3_3_REV',
- `GL_UNSIGNED_SHORT_5_6_5', `GL_UNSIGNED_SHORT_5_6_5_REV',
- `GL_UNSIGNED_SHORT_4_4_4_4', `GL_UNSIGNED_SHORT_4_4_4_4_REV',
- `GL_UNSIGNED_SHORT_5_5_5_1', `GL_UNSIGNED_SHORT_1_5_5_5_REV',
- `GL_UNSIGNED_INT_8_8_8_8', `GL_UNSIGNED_INT_8_8_8_8_REV',
- `GL_UNSIGNED_INT_10_10_10_2', and `GL_UNSIGNED_INT_2_10_10_10_REV'.
-
-DATA
- Specifies a pointer to the image data in memory.
-
-
-Description
-===========
-
-Texturing maps a portion of a specified texture image onto each
-graphical primitive for which texturing is enabled. To enable and
-disable two-dimensional texturing, call `glEnable' and `glDisable' with
-argument `GL_TEXTURE_2D'.
-
-`glTexSubImage2D' redefines a contiguous subregion of an existing
-two-dimensional texture image. The texels referenced by DATA replace the
-portion of the existing texture array with x indices XOFFSET and
-XOFFSET+WIDTH-1, inclusive, and y indices YOFFSET and YOFFSET+HEIGHT-1,
-inclusive. This region may not include any texels outside the range of
-the texture array as it was originally specified. It is not an error to
-specify a subtexture with zero width or height, but such a specification
-has no effect.
-
-If a non-zero named buffer object is bound to the
-`GL_PIXEL_UNPACK_BUFFER' target (see `glBindBuffer') while a texture
-image is specified, DATA is treated as a byte offset into the buffer
-object's data store.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if TARGET is not `GL_TEXTURE_2D',
-`GL_TEXTURE_CUBE_MAP_POSITIVE_X', `GL_TEXTURE_CUBE_MAP_NEGATIVE_X',
-`GL_TEXTURE_CUBE_MAP_POSITIVE_Y', `GL_TEXTURE_CUBE_MAP_NEGATIVE_Y',
-`GL_TEXTURE_CUBE_MAP_POSITIVE_Z', or `GL_TEXTURE_CUBE_MAP_NEGATIVE_Z'.
-
-`GL_INVALID_ENUM' is generated if FORMAT is not an accepted format
-constant.
-
-`GL_INVALID_ENUM' is generated if TYPE is not a type constant.
-
-`GL_INVALID_ENUM' is generated if TYPE is `GL_BITMAP' and FORMAT is not
-`GL_COLOR_INDEX'.
-
-`GL_INVALID_VALUE' is generated if LEVEL is less than 0.
-
-`GL_INVALID_VALUE' may be generated if LEVEL is greater than LOG_2MAX,
-where MAX is the returned value of `GL_MAX_TEXTURE_SIZE'.
-
-`GL_INVALID_VALUE' is generated if XOFFSET<-B, (XOFFSET+WIDTH,)>(W-B,),
-YOFFSET<-B, or (YOFFSET+HEIGHT,)>(H-B,), where W is the
-`GL_TEXTURE_WIDTH', H is the `GL_TEXTURE_HEIGHT', and B is the border
-width of the texture image being modified. Note that W and H include
-twice the border width.
-
-`GL_INVALID_VALUE' is generated if WIDTH or HEIGHT is less than 0.
-
-`GL_INVALID_OPERATION' is generated if the texture array has not been
-defined by a previous `glTexImage2D' operation.
-
-`GL_INVALID_OPERATION' is generated if TYPE is one of
-`GL_UNSIGNED_BYTE_3_3_2', `GL_UNSIGNED_BYTE_2_3_3_REV',
-`GL_UNSIGNED_SHORT_5_6_5', or `GL_UNSIGNED_SHORT_5_6_5_REV' and FORMAT
-is not `GL_RGB'.
-
-`GL_INVALID_OPERATION' is generated if TYPE is one of
-`GL_UNSIGNED_SHORT_4_4_4_4', `GL_UNSIGNED_SHORT_4_4_4_4_REV',
-`GL_UNSIGNED_SHORT_5_5_5_1', `GL_UNSIGNED_SHORT_1_5_5_5_REV',
-`GL_UNSIGNED_INT_8_8_8_8', `GL_UNSIGNED_INT_8_8_8_8_REV',
-`GL_UNSIGNED_INT_10_10_10_2', or `GL_UNSIGNED_INT_2_10_10_10_REV' and
-FORMAT is neither `GL_RGBA' nor `GL_BGRA'.
-
-`GL_INVALID_OPERATION' is generated if a non-zero buffer object name is
-bound to the `GL_PIXEL_UNPACK_BUFFER' target and the buffer object's
-data store is currently mapped.
-
-`GL_INVALID_OPERATION' is generated if a non-zero buffer object name is
-bound to the `GL_PIXEL_UNPACK_BUFFER' target and the data would be
-unpacked from the buffer object such that the memory reads required
-would exceed the data store size.
-
-`GL_INVALID_OPERATION' is generated if a non-zero buffer object name is
-bound to the `GL_PIXEL_UNPACK_BUFFER' target and DATA is not evenly
-divisible into the number of bytes needed to store in memory a datum
-indicated by TYPE.
-
-`GL_INVALID_OPERATION' is generated if `glTexSubImage2D' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glTexSubImage3D
- "glTexSubImage3D"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glTexSubImage3D"))
- (paramdef "GLenum " (parameter "target"))
- (paramdef "GLint " (parameter "level"))
- (paramdef "GLint " (parameter "xoffset"))
- (paramdef "GLint " (parameter "yoffset"))
- (paramdef "GLint " (parameter "zoffset"))
- (paramdef "GLsizei " (parameter "width"))
- (paramdef "GLsizei " (parameter "height"))
- (paramdef "GLsizei " (parameter "depth"))
- (paramdef "GLenum " (parameter "format"))
- (paramdef "GLenum " (parameter "type"))
- (paramdef "const GLvoid * " (parameter "data"))))
- "specify a three-dimensional texture subimage
-============================================
-
-
-Parameters
-==========
-
-TARGET
- Specifies the target texture. Must be `GL_TEXTURE_3D'.
-
-LEVEL
- Specifies the level-of-detail number. Level 0 is the base image
- level. Level N is the Nth mipmap reduction image.
-
-XOFFSET
- Specifies a texel offset in the x direction within the texture
- array.
-
-YOFFSET
- Specifies a texel offset in the y direction within the texture
- array.
-
-ZOFFSET
- Specifies a texel offset in the z direction within the texture
- array.
-
-WIDTH
- Specifies the width of the texture subimage.
-
-HEIGHT
- Specifies the height of the texture subimage.
-
-DEPTH
- Specifies the depth of the texture subimage.
-
-FORMAT
- Specifies the format of the pixel data. The following symbolic
- values are accepted: `GL_COLOR_INDEX', `GL_RED', `GL_GREEN',
- `GL_BLUE', `GL_ALPHA', `GL_RGB', `GL_BGR', `GL_RGBA', `GL_BGRA',
- `GL_LUMINANCE', and `GL_LUMINANCE_ALPHA'.
-
-TYPE
- Specifies the data type of the pixel data. The following symbolic
- values are accepted: `GL_UNSIGNED_BYTE', `GL_BYTE', `GL_BITMAP',
- `GL_UNSIGNED_SHORT', `GL_SHORT', `GL_UNSIGNED_INT', `GL_INT',
- `GL_FLOAT', `GL_UNSIGNED_BYTE_3_3_2', `GL_UNSIGNED_BYTE_2_3_3_REV',
- `GL_UNSIGNED_SHORT_5_6_5', `GL_UNSIGNED_SHORT_5_6_5_REV',
- `GL_UNSIGNED_SHORT_4_4_4_4', `GL_UNSIGNED_SHORT_4_4_4_4_REV',
- `GL_UNSIGNED_SHORT_5_5_5_1', `GL_UNSIGNED_SHORT_1_5_5_5_REV',
- `GL_UNSIGNED_INT_8_8_8_8', `GL_UNSIGNED_INT_8_8_8_8_REV',
- `GL_UNSIGNED_INT_10_10_10_2', and `GL_UNSIGNED_INT_2_10_10_10_REV'.
-
-DATA
- Specifies a pointer to the image data in memory.
-
-
-Description
-===========
-
-Texturing maps a portion of a specified texture image onto each
-graphical primitive for which texturing is enabled. To enable and
-disable three-dimensional texturing, call `glEnable' and `glDisable'
-with argument `GL_TEXTURE_3D'.
-
-`glTexSubImage3D' redefines a contiguous subregion of an existing
-three-dimensional texture image. The texels referenced by DATA replace
-the portion of the existing texture array with x indices XOFFSET and
-XOFFSET+WIDTH-1, inclusive, y indices YOFFSET and YOFFSET+HEIGHT-1,
-inclusive, and z indices ZOFFSET and ZOFFSET+DEPTH-1, inclusive. This
-region may not include any texels outside the range of the texture array
-as it was originally specified. It is not an error to specify a
-subtexture with zero width, height, or depth but such a specification
-has no effect.
-
-If a non-zero named buffer object is bound to the
-`GL_PIXEL_UNPACK_BUFFER' target (see `glBindBuffer') while a texture
-image is specified, DATA is treated as a byte offset into the buffer
-object's data store.
-
-
-Errors
-======
-
-`GL_INVALID_ENUM' is generated if /TARGET is not `GL_TEXTURE_3D'.
-
-`GL_INVALID_ENUM' is generated if FORMAT is not an accepted format
-constant.
-
-`GL_INVALID_ENUM' is generated if TYPE is not a type constant.
-
-`GL_INVALID_ENUM' is generated if TYPE is `GL_BITMAP' and FORMAT is not
-`GL_COLOR_INDEX'.
-
-`GL_INVALID_VALUE' is generated if LEVEL is less than 0.
-
-`GL_INVALID_VALUE' may be generated if LEVEL is greater than LOG_2MAX,
-where MAX is the returned value of `GL_MAX_TEXTURE_SIZE'.
-
-`GL_INVALID_VALUE' is generated if XOFFSET<-B, (XOFFSET+WIDTH,)>(W-B,),
-YOFFSET<-B, or (YOFFSET+HEIGHT,)>(H-B,), or ZOFFSET<-B, or
-(ZOFFSET+DEPTH,)>(D-B,), where W is the `GL_TEXTURE_WIDTH', H is the
-`GL_TEXTURE_HEIGHT', D is the `GL_TEXTURE_DEPTH' and B is the border
-width of the texture image being modified. Note that W, H, and D include
-twice the border width.
-
-`GL_INVALID_VALUE' is generated if WIDTH, HEIGHT, or DEPTH is less than
-0.
-
-`GL_INVALID_OPERATION' is generated if the texture array has not been
-defined by a previous `glTexImage3D' operation.
-
-`GL_INVALID_OPERATION' is generated if TYPE is one of
-`GL_UNSIGNED_BYTE_3_3_2', `GL_UNSIGNED_BYTE_2_3_3_REV',
-`GL_UNSIGNED_SHORT_5_6_5', or `GL_UNSIGNED_SHORT_5_6_5_REV' and FORMAT
-is not `GL_RGB'.
-
-`GL_INVALID_OPERATION' is generated if TYPE is one of
-`GL_UNSIGNED_SHORT_4_4_4_4', `GL_UNSIGNED_SHORT_4_4_4_4_REV',
-`GL_UNSIGNED_SHORT_5_5_5_1', `GL_UNSIGNED_SHORT_1_5_5_5_REV',
-`GL_UNSIGNED_INT_8_8_8_8', `GL_UNSIGNED_INT_8_8_8_8_REV',
-`GL_UNSIGNED_INT_10_10_10_2', or `GL_UNSIGNED_INT_2_10_10_10_REV' and
-FORMAT is neither `GL_RGBA' nor `GL_BGRA'.
-
-`GL_INVALID_OPERATION' is generated if a non-zero buffer object name is
-bound to the `GL_PIXEL_UNPACK_BUFFER' target and the buffer object's
-data store is currently mapped.
-
-`GL_INVALID_OPERATION' is generated if a non-zero buffer object name is
-bound to the `GL_PIXEL_UNPACK_BUFFER' target and the data would be
-unpacked from the buffer object such that the memory reads required
-would exceed the data store size.
-
-`GL_INVALID_OPERATION' is generated if a non-zero buffer object name is
-bound to the `GL_PIXEL_UNPACK_BUFFER' target and DATA is not evenly
-divisible into the number of bytes needed to store in memory a datum
-indicated by TYPE.
-
-`GL_INVALID_OPERATION' is generated if `glTexSubImage3D' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glTranslate
- "glTranslate"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glTranslated"))
- (paramdef "GLdouble " (parameter "x"))
- (paramdef "GLdouble " (parameter "y"))
- (paramdef "GLdouble " (parameter "z"))))
- "multiply the current matrix by a translation matrix
-===================================================
-
-
-Parameters
-==========
-
-X
- Y
-
- Z
-
- Specify the X, Y, and Z coordinates of a translation vector.
-
-
-Description
-===========
-
-`glTranslate' produces a translation by (X,YZ). The current matrix (see
-`glMatrixMode') is multiplied by this translation matrix, with the
-product replacing the current matrix, as if `glMultMatrix' were called
-with the following matrix for its argument:
-
-((1 0 0 X), (0 1 0 Y), (0 0 1 Z), (0 0 0 1),)
-
-
-
-If the matrix mode is either `GL_MODELVIEW' or `GL_PROJECTION', all
-objects drawn after a call to `glTranslate' are translated.
-
-Use `glPushMatrix' and `glPopMatrix' to save and restore the
-untranslated coordinate system.
-
-
-Errors
-======
-
-`GL_INVALID_OPERATION' is generated if `glTranslate' is executed between
-the execution of `glBegin' and the corresponding execution of `glEnd'.")
-
-(define-gl-procedure
- gluBeginCurve
- "gluBeginCurve"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "gluBeginCurve"))
- (paramdef "GLUnurbs* " (parameter "nurb"))))
- "delimit a NURBS curve definition
-================================
-
-
-Parameters
-==========
-
-NURB
- Specifies the NURBS object (created with `gluNewNurbsRenderer').
-
-
-Description
-===========
-
-Use `gluBeginCurve' to mark the beginning of a NURBS curve definition.
-After calling `gluBeginCurve', make one or more calls to `gluNurbsCurve'
-to define the attributes of the curve. Exactly one of the calls to
-`gluNurbsCurve' must have a curve type of `GLU_MAP1_VERTEX_3' or
-`GLU_MAP1_VERTEX_4'. To mark the end of the NURBS curve definition, call
-`gluEndCurve'.
-
-GL evaluators are used to render the NURBS curve as a series of line
-segments. Evaluator state is preserved during rendering with
-`glPushAttrib'(`GLU_EVAL_BIT') and `glPopAttrib'(). See the
-`glPushAttrib' reference page for details on exactly what state these
-calls preserve.")
-
-(define-gl-procedure
- gluBeginPolygon
- "gluBeginPolygon"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "gluBeginPolygon"))
- (paramdef "GLUtesselator* " (parameter "tess"))))
- "delimit a polygon description
-=============================
-
-
-Parameters
-==========
-
-TESS
- Specifies the tessellation object (created with `gluNewTess').
-
-
-Description
-===========
-
-`gluBeginPolygon' and `gluEndPolygon' delimit the definition of a
-nonconvex polygon. To define such a polygon, first call
-`gluBeginPolygon'. Then define the contours of the polygon by calling
-`gluTessVertex' for each vertex and `gluNextContour' to start each new
-contour. Finally, call `gluEndPolygon' to signal the end of the
-definition. See the `gluTessVertex' and `gluNextContour' reference pages
-for more details.
-
-Once `gluEndPolygon' is called, the polygon is tessellated, and the
-resulting triangles are described through callbacks. See
-`gluTessCallback' for descriptions of the callback functions.")
-
-(define-gl-procedure
- gluBeginSurface
- "gluBeginSurface"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "gluBeginSurface"))
- (paramdef "GLUnurbs* " (parameter "nurb"))))
- "delimit a NURBS surface definition
-==================================
-
-
-Parameters
-==========
-
-NURB
- Specifies the NURBS object (created with `gluNewNurbsRenderer').
-
-
-Description
-===========
-
-Use `gluBeginSurface' to mark the beginning of a NURBS surface
-definition. After calling `gluBeginSurface', make one or more calls to
-`gluNurbsSurface' to define the attributes of the surface. Exactly one
-of these calls to `gluNurbsSurface' must have a surface type of
-`GLU_MAP2_VERTEX_3' or `GLU_MAP2_VERTEX_4'. To mark the end of the NURBS
-surface definition, call `gluEndSurface'.
-
-Trimming of NURBS surfaces is supported with `gluBeginTrim',
-`gluPwlCurve', `gluNurbsCurve', and `gluEndTrim'. See the `gluBeginTrim'
-reference page for details.
-
-GL evaluators are used to render the NURBS surface as a set of polygons.
-Evaluator state is preserved during rendering with
-`glPushAttrib'(`GLU_EVAL_BIT') and `glPopAttrib'. See the `glPushAttrib'
-reference page for details on exactly what state these calls preserve.")
-
-(define-gl-procedure
- gluBeginTrim
- "gluBeginTrim"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "gluBeginTrim"))
- (paramdef "GLUnurbs* " (parameter "nurb"))))
- "delimit a NURBS trimming loop definition
-========================================
-
-
-Parameters
-==========
-
-NURB
- Specifies the NURBS object (created with `gluNewNurbsRenderer').
-
-
-Description
-===========
-
-Use `gluBeginTrim' to mark the beginning of a trimming loop and
-`gluEndTrim' to mark the end of a trimming loop. A trimming loop is a
-set of oriented curve segments (forming a closed curve) that define
-boundaries of a NURBS surface. You include these trimming loops in the
-definition of a NURBS surface, between calls to `gluBeginSurface' and
-`gluEndSurface'.
-
-The definition for a NURBS surface can contain many trimming loops. For
-example, if you wrote a definition for a NURBS surface that resembled a
-rectangle with a hole punched out, the definition would contain two
-trimming loops. One loop would define the outer edge of the rectangle;
-the other would define the hole punched out of the rectangle. The
-definitions of each of these trimming loops would be bracketed by a
-`gluBeginTrim'/`gluEndTrim' pair.
-
-The definition of a single closed trimming loop can consist of multiple
-curve segments, each described as a piecewise linear curve (see
-`gluPwlCurve') or as a single NURBS curve (see `gluNurbsCurve'), or as a
-combination of both in any order. The only library calls that can appear
-in a trimming loop definition (between the calls to `gluBeginTrim' and
-`gluEndTrim') are `gluPwlCurve' and `gluNurbsCurve'.
-
-The area of the NURBS surface that is displayed is the region in the
-domain to the left of the trimming curve as the curve parameter
-increases. Thus, the retained region of the NURBS surface is inside a
-counterclockwise trimming loop and outside a clockwise trimming loop.
-For the rectangle mentioned earlier, the trimming loop for the outer
-edge of the rectangle runs counterclockwise, while the trimming loop for
-the punched-out hole runs clockwise.
-
-If you use more than one curve to define a single trimming loop, the
-curve segments must form a closed loop (that is, the endpoint of each
-curve must be the starting point of the next curve, and the endpoint of
-the final curve must be the starting point of the first curve). If the
-endpoints of the curve are sufficiently close together but not exactly
-coincident, they will be coerced to match. If the endpoints are not
-sufficiently close, an error results (see `gluNurbsCallback').
-
-If a trimming loop definition contains multiple curves, the direction of
-the curves must be consistent (that is, the inside must be to the left
-of all of the curves). Nested trimming loops are legal as long as the
-curve orientations alternate correctly. If trimming curves are
-self-intersecting, or intersect one another, an error results.
-
-If no trimming information is given for a NURBS surface, the entire
-surface is drawn.")
-
-(define-gl-procedure
- gluBuild1DMipmapLevels
- "gluBuild1DMipmapLevels"
- (funcsynopsis
- (funcprototype
- (funcdef
- "GLint "
- (function "gluBuild1DMipmapLevels"))
- (paramdef "GLenum " (parameter "target"))
- (paramdef "GLint " (parameter "internalFormat"))
- (paramdef "GLsizei " (parameter "width"))
- (paramdef "GLenum " (parameter "format"))
- (paramdef "GLenum " (parameter "type"))
- (paramdef "GLint " (parameter "level"))
- (paramdef "GLint " (parameter "base"))
- (paramdef "GLint " (parameter "max"))
- (paramdef "const void * " (parameter "data"))))
- "builds a subset of one-dimensional mipmap levels
-================================================
-
-
-Parameters
-==========
-
-TARGET
- Specifies the target texture. Must be `GLU_TEXTURE_1D'.
-
-INTERNALFORMAT
- Requests the internal storage format of the texture image. The most
- current version of the SGI implementation of GLU does not check
- this value for validity before passing it on to the underlying
- OpenGL implementation. A value that is not accepted by the OpenGL
- implementation will lead to an OpenGL error. The benefit of not
- checking this value at the GLU level is that OpenGL extensions can
- add new internal texture formats without requiring a revision of
- the GLU implementation. Older implementations of GLU check this
- value and raise a GLU error if it is not 1, 2, 3, or 4 or one of
- the following symbolic constants: `GLU_ALPHA', `GLU_ALPHA4',
- `GLU_ALPHA8', `GLU_ALPHA12', `GLU_ALPHA16', `GLU_LUMINANCE',
- `GLU_LUMINANCE4', `GLU_LUMINANCE8', `GLU_LUMINANCE12',
- `GLU_LUMINANCE16', `GLU_LUMINANCE_ALPHA', `GLU_LUMINANCE4_ALPHA4',
- `GLU_LUMINANCE6_ALPHA2', `GLU_LUMINANCE8_ALPHA8',
- `GLU_LUMINANCE12_ALPHA4', `GLU_LUMINANCE12_ALPHA12',
- `GLU_LUMINANCE16_ALPHA16', `GLU_INTENSITY', `GLU_INTENSITY4',
- `GLU_INTENSITY8', `GLU_INTENSITY12', `GLU_INTENSITY16', `GLU_RGB',
- `GLU_R3_G3_B2', `GLU_RGB4', `GLU_RGB5', `GLU_RGB8', `GLU_RGB10',
- `GLU_RGB12', `GLU_RGB16', `GLU_RGBA', `GLU_RGBA2', `GLU_RGBA4',
- `GLU_RGB5_A1', `GLU_RGBA8', `GLU_RGB10_A2', `GLU_RGBA12', or
- `GLU_RGBA16'.
-
-WIDTH
- Specifies the width in pixels of the texture image. This should be
- a power of 2.
-
-FORMAT
- Specifies the format of the pixel data. Must be one of:
- `GLU_COLOR_INDEX', `GLU_DEPTH_COMPONENT', `GLU_RED', `GLU_GREEN',
- `GLU_BLUE', `GLU_ALPHA', `GLU_RGB', `GLU_RGBA', `GLU_BGR',
- `GLU_BGRA', `GLU_LUMINANCE', or `GLU_LUMINANCE_ALPHA'.
-
-TYPE
- Specifies the data type for DATA. Must be one of:
- `GLU_UNSIGNED_BYTE', `GLU_BYTE', `GLU_BITMAP',
- `GLU_UNSIGNED_SHORT', `GLU_SHORT', `GLU_UNSIGNED_INT', `GLU_INT',
- `GLU_FLOAT', `GLU_UNSIGNED_BYTE_3_3_2',
- `GLU_UNSIGNED_BYTE_2_3_3_REV', `GLU_UNSIGNED_SHORT_5_6_5',
- `GLU_UNSIGNED_SHORT_5_6_5_REV', `GLU_UNSIGNED_SHORT_4_4_4_4',
- `GLU_UNSIGNED_SHORT_4_4_4_4_REV', `GLU_UNSIGNED_SHORT_5_5_5_1',
- `GLU_UNSIGNED_SHORT_1_5_5_5_REV', `GLU_UNSIGNED_INT_8_8_8_8',
- `GLU_UNSIGNED_INT_8_8_8_8_REV', `GLU_UNSIGNED_INT_10_10_10_2', or
- `GLU_UNSIGNED_INT_2_10_10_10_REV'.
-
-LEVEL
- Specifies the mipmap level of the image data.
-
-BASE
- Specifies the minimum mipmap level to pass to `glTexImage1D'.
-
-MAX
- Specifies the maximum mipmap level to pass to `glTexImage1D'.
-
-DATA
- Specifies a pointer to the image data in memory.
-
-
-Description
-===========
-
-`gluBuild1DMipmapLevels' builds a subset of prefiltered one-dimensional
-texture maps of decreasing resolutions called a mipmap. This is used for
-the antialiasing of texture mapped primitives.
-
-A return value of zero indicates success, otherwise a GLU error code is
-returned (see `gluErrorString').
-
-A series of mipmap levels from BASE to MAX is built by decimating DATA
-in half until size 1×1 is reached. At each level, each texel in the
-halved mipmap level is an average of the corresponding two texels in the
-larger mipmap level. `glTexImage1D' is called to load these mipmap
-levels from BASE to MAX. If MAX is larger than the highest mipmap level
-for the texture of the specified size, then a GLU error code is returned
-(see `gluErrorString') and nothing is loaded.
-
-For example, if LEVEL is 2 and WIDTH is 16, the following levels are
-possible: 16×1, 8×1, 4×1, 2×1, 1×1. These correspond to levels 2 through
-6 respectively. If BASE is 3 and MAX is 5, then only mipmap levels 8×1,
-4×1 and 2×1 are loaded. However, if MAX is 7, then an error is returned
-and nothing is loaded since MAX is larger than the highest mipmap level
-which is, in this case, 6.
-
-The highest mipmap level can be derived from the formula
-LOG_2\u2061(WIDTH×2^LEVEL,).
-
-See the `glTexImage1D' reference page for a description of the
-acceptable values for TYPE parameter. See the `glDrawPixels' reference
-page for a description of the acceptable values for LEVEL parameter.
-
-
-Errors
-======
-
-`GLU_INVALID_VALUE' is returned if LEVEL > BASE, BASE < 0, MAX < BASE or
-MAX is > the highest mipmap level for DATA.
-
-`GLU_INVALID_VALUE' is returned if WIDTH is < 1.
-
-`GLU_INVALID_ENUM' is returned if INTERNALFORMAT, FORMAT, or TYPE are
-not legal.
-
-`GLU_INVALID_OPERATION' is returned if TYPE is `GLU_UNSIGNED_BYTE_3_3_2'
-or `GLU_UNSIGNED_BYTE_2_3_3_REV' and FORMAT is not `GLU_RGB'.
-
-`GLU_INVALID_OPERATION' is returned if TYPE is
-`GLU_UNSIGNED_SHORT_5_6_5' or `GLU_UNSIGNED_SHORT_5_6_5_REV' and FORMAT
-is not `GLU_RGB'.
-
-`GLU_INVALID_OPERATION' is returned if TYPE is
-`GLU_UNSIGNED_SHORT_4_4_4_4' or `GLU_UNSIGNED_SHORT_4_4_4_4_REV' and
-FORMAT is neither `GLU_RGBA' nor `GLU_BGRA'.
-
-`GLU_INVALID_OPERATION' is returned if TYPE is
-`GLU_UNSIGNED_SHORT_5_5_5_1' or `GLU_UNSIGNED_SHORT_1_5_5_5_REV' and
-FORMAT is neither `GLU_RGBA' nor `GLU_BGRA'.
-
-`GLU_INVALID_OPERATION' is returned if TYPE is
-`GLU_UNSIGNED_INT_8_8_8_8' or `GLU_UNSIGNED_INT_8_8_8_8_REV' and FORMAT
-is neither `GLU_RGBA' nor `GLU_BGRA'.
-
-`GLU_INVALID_OPERATION' is returned if TYPE is
-`GLU_UNSIGNED_INT_10_10_10_2' or `GLU_UNSIGNED_INT_2_10_10_10_REV' and
-FORMAT is neither `GLU_RGBA' nor `GLU_BGRA'.")
-
-(define-gl-procedure
- gluBuild1DMipmaps
- "gluBuild1DMipmaps"
- (funcsynopsis
- (funcprototype
- (funcdef "GLint " (function "gluBuild1DMipmaps"))
- (paramdef "GLenum " (parameter "target"))
- (paramdef "GLint " (parameter "internalFormat"))
- (paramdef "GLsizei " (parameter "width"))
- (paramdef "GLenum " (parameter "format"))
- (paramdef "GLenum " (parameter "type"))
- (paramdef "const void * " (parameter "data"))))
- "builds a one-dimensional mipmap
-===============================
-
-
-Parameters
-==========
-
-TARGET
- Specifies the target texture. Must be `GLU_TEXTURE_1D'.
-
-INTERNALFORMAT
- Requests the internal storage format of the texture image. The most
- current version of the SGI implementation of GLU does not check
- this value for validity before passing it on to the underlying
- OpenGL implementation. A value that is not accepted by the OpenGL
- implementation will lead to an OpenGL error. The benefit of not
- checking this value at the GLU level is that OpenGL extensions can
- add new internal texture formats without requiring a revision of
- the GLU implementation. Older implementations of GLU check this
- value and raise a GLU error if it is not 1, 2, 3, or 4 or one of
- the following symbolic constants: `GLU_ALPHA', `GLU_ALPHA4',
- `GLU_ALPHA8', `GLU_ALPHA12', `GLU_ALPHA16', `GLU_LUMINANCE',
- `GLU_LUMINANCE4', `GLU_LUMINANCE8', `GLU_LUMINANCE12',
- `GLU_LUMINANCE16', `GLU_LUMINANCE_ALPHA', `GLU_LUMINANCE4_ALPHA4',
- `GLU_LUMINANCE6_ALPHA2', `GLU_LUMINANCE8_ALPHA8',
- `GLU_LUMINANCE12_ALPHA4', `GLU_LUMINANCE12_ALPHA12',
- `GLU_LUMINANCE16_ALPHA16', `GLU_INTENSITY', `GLU_INTENSITY4',
- `GLU_INTENSITY8', `GLU_INTENSITY12', `GLU_INTENSITY16', `GLU_RGB',
- `GLU_R3_G3_B2', `GLU_RGB4', `GLU_RGB5', `GLU_RGB8', `GLU_RGB10',
- `GLU_RGB12', `GLU_RGB16', `GLU_RGBA', `GLU_RGBA2', `GLU_RGBA4',
- `GLU_RGB5_A1', `GLU_RGBA8', `GLU_RGB10_A2', `GLU_RGBA12', or
- `GLU_RGBA16'.
-
-WIDTH
- Specifies the width, in pixels, of the texture image.
-
-FORMAT
- Specifies the format of the pixel data. Must be one of
- `GLU_COLOR_INDEX', `GLU_DEPTH_COMPONENT', `GLU_RED', `GLU_GREEN',
- `GLU_BLUE', `GLU_ALPHA', `GLU_RGB', `GLU_RGBA', `GLU_BGR',
- `GLU_BGRA', `GLU_LUMINANCE', or `GLU_LUMINANCE_ALPHA'.
-
-TYPE
- Specifies the data type for DATA. Must be one of
- `GLU_UNSIGNED_BYTE', `GLU_BYTE', `GLU_BITMAP',
- `GLU_UNSIGNED_SHORT', `GLU_SHORT', `GLU_UNSIGNED_INT', `GLU_INT',
- `GLU_FLOAT', `GLU_UNSIGNED_BYTE_3_3_2',
- `GLU_UNSIGNED_BYTE_2_3_3_REV', `GLU_UNSIGNED_SHORT_5_6_5',
- `GLU_UNSIGNED_SHORT_5_6_5_REV', `GLU_UNSIGNED_SHORT_4_4_4_4',
- `GLU_UNSIGNED_SHORT_4_4_4_4_REV', `GLU_UNSIGNED_SHORT_5_5_5_1',
- `GLU_UNSIGNED_SHORT_1_5_5_5_REV', `GLU_UNSIGNED_INT_8_8_8_8',
- `GLU_UNSIGNED_INT_8_8_8_8_REV', `GLU_UNSIGNED_INT_10_10_10_2', or
- `GLU_UNSIGNED_INT_2_10_10_10_REV'.
-
-DATA
- Specifies a pointer to the image data in memory.
-
-
-Description
-===========
-
-`gluBuild1DMipmaps' builds a series of prefiltered one-dimensional
-texture maps of decreasing resolutions called a mipmap. This is used for
-the antialiasing of texture mapped primitives.
-
-A return value of zero indicates success, otherwise a GLU error code is
-returned (see `gluErrorString').
-
-Initially, the WIDTH of DATA is checked to see if it is a power of 2. If
-not, a copy of DATA is scaled up or down to the nearest power of 2. (If
-WIDTH is exactly between powers of 2, then the copy of DATA will scale
-upwards.) This copy will be used for subsequent mipmapping operations
-described below. For example, if WIDTH is 57, then a copy of DATA will
-scale up to 64 before mipmapping takes place.
-
-Then, proxy textures (see `glTexImage1D') are used to determine if the
-implementation can fit the requested texture. If not, WIDTH is
-continually halved until it fits.
-
-Next, a series of mipmap levels is built by decimating a copy of DATA in
-half until size 1×1 is reached. At each level, each texel in the halved
-mipmap level is an average of the corresponding two texels in the larger
-mipmap level.
-
-`glTexImage1D' is called to load each of these mipmap levels. Level 0 is
-a copy of DATA. The highest level is LOG_2,\u2061(WIDTH,). For example, if
-WIDTH is 64 and the implementation can store a texture of this size, the
-following mipmap levels are built: 64×1, 32×1, 16×1, 8×1, 4×1, 2×1, and
-1×1. These correspond to levels 0 through 6, respectively.
-
-See the `glTexImage1D' reference page for a description of the
-acceptable values for the TYPE parameter. See the `glDrawPixels'
-reference page for a description of the acceptable values for the DATA
-parameter.
-
-
-Errors
-======
-
-`GLU_INVALID_VALUE' is returned if WIDTH is < 1.
-
-`GLU_INVALID_ENUM' is returned if FORMAT or TYPE are not legal.
-
-`GLU_INVALID_OPERATION' is returned if TYPE is `GLU_UNSIGNED_BYTE_3_3_2'
-or `GLU_UNSIGNED_BYTE_2_3_3_REV' and FORMAT is not `GLU_RGB'.
-
-`GLU_INVALID_OPERATION' is returned if TYPE is
-`GLU_UNSIGNED_SHORT_5_6_5' or `GLU_UNSIGNED_SHORT_5_6_5_REV' and FORMAT
-is not `GLU_RGB'.
-
-`GLU_INVALID_OPERATION' is returned if TYPE is
-`GLU_UNSIGNED_SHORT_4_4_4_4' or `GLU_UNSIGNED_SHORT_4_4_4_4_REV' and
-FORMAT is neither `GLU_RGBA' nor `GLU_BGRA'.
-
-`GLU_INVALID_OPERATION' is returned if TYPE is
-`GLU_UNSIGNED_SHORT_5_5_5_1' or `GLU_UNSIGNED_SHORT_1_5_5_5_REV' and
-FORMAT is neither `GLU_RGBA' nor `GLU_BGRA'.
-
-`GLU_INVALID_OPERATION' is returned if TYPE is
-`GLU_UNSIGNED_INT_8_8_8_8' or `GLU_UNSIGNED_INT_8_8_8_8_REV' and FORMAT
-is neither `GLU_RGBA' nor `GLU_BGRA'.
-
-`GLU_INVALID_OPERATION' is returned if TYPE is
-`GLU_UNSIGNED_INT_10_10_10_2' or `GLU_UNSIGNED_INT_2_10_10_10_REV' and
-FORMAT is neither `GLU_RGBA' nor `GLU_BGRA'.")
-
-(define-gl-procedure
- gluBuild2DMipmapLevels
- "gluBuild2DMipmapLevels"
- (funcsynopsis
- (funcprototype
- (funcdef
- "GLint "
- (function "gluBuild2DMipmapLevels"))
- (paramdef "GLenum " (parameter "target"))
- (paramdef "GLint " (parameter "internalFormat"))
- (paramdef "GLsizei " (parameter "width"))
- (paramdef "GLsizei " (parameter "height"))
- (paramdef "GLenum " (parameter "format"))
- (paramdef "GLenum " (parameter "type"))
- (paramdef "GLint " (parameter "level"))
- (paramdef "GLint " (parameter "base"))
- (paramdef "GLint " (parameter "max"))
- (paramdef "const void * " (parameter "data"))))
- "builds a subset of two-dimensional mipmap levels
-================================================
-
-
-Parameters
-==========
-
-TARGET
- Specifies the target texture. Must be `GLU_TEXTURE_2D'.
-
-INTERNALFORMAT
- Requests the internal storage format of the texture image. The most
- current version of the SGI implementation of GLU does not check
- this value for validity before passing it on to the underlying
- OpenGL implementation. A value that is not accepted by the OpenGL
- implementation will lead to an OpenGL error. The benefit of not
- checking this value at the GLU level is that OpenGL extensions can
- add new internal texture formats without requiring a revision of
- the GLU implementation. Older implementations of GLU check this
- value and raise a GLU error if it is not 1, 2, 3, or 4 or one of
- the following symbolic constants: `GLU_ALPHA', `GLU_ALPHA4',
- `GLU_ALPHA8', `GLU_ALPHA12', `GLU_ALPHA16', `GLU_LUMINANCE',
- `GLU_LUMINANCE4', `GLU_LUMINANCE8', `GLU_LUMINANCE12',
- `GLU_LUMINANCE16', `GLU_LUMINANCE_ALPHA', `GLU_LUMINANCE4_ALPHA4',
- `GLU_LUMINANCE6_ALPHA2', `GLU_LUMINANCE8_ALPHA8',
- `GLU_LUMINANCE12_ALPHA4', `GLU_LUMINANCE12_ALPHA12',
- `GLU_LUMINANCE16_ALPHA16', `GLU_INTENSITY', `GLU_INTENSITY4',
- `GLU_INTENSITY8', `GLU_INTENSITY12', `GLU_INTENSITY16', `GLU_RGB',
- `GLU_R3_G3_B2', `GLU_RGB4', `GLU_RGB5', `GLU_RGB8', `GLU_RGB10',
- `GLU_RGB12', `GLU_RGB16', `GLU_RGBA', `GLU_RGBA2', `GLU_RGBA4',
- `GLU_RGB5_A1', `GLU_RGBA8', `GLU_RGB10_A2', `GLU_RGBA12', or
- `GLU_RGBA16'.
-
-WIDTH
- HEIGHT
-
- Specifies the width and height, respectively, in pixels of the
- texture image. These should be a power of 2.
-
-FORMAT
- Specifies the format of the pixel data. Must be one of
- `GLU_COLOR_INDEX', `GLU_DEPTH_COMPONENT', `GLU_RED', `GLU_GREEN',
- `GLU_BLUE', `GLU_ALPHA', `GLU_RGB', `GLU_RGBA', `GLU_BGR',
- `GLU_BGRA', `GLU_LUMINANCE', or `GLU_LUMINANCE_ALPHA'.
-
-TYPE
- Specifies the data type for DATA. Must be one of
- `GLU_UNSIGNED_BYTE', `GLU_BYTE', `GLU_BITMAP',
- `GLU_UNSIGNED_SHORT', `GLU_SHORT', `GLU_UNSIGNED_INT', `GLU_INT',
- `GLU_FLOAT', `GLU_UNSIGNED_BYTE_3_3_2',
- `GLU_UNSIGNED_BYTE_2_3_3_REV', `GLU_UNSIGNED_SHORT_5_6_5',
- `GLU_UNSIGNED_SHORT_5_6_5_REV', `GLU_UNSIGNED_SHORT_4_4_4_4',
- `GLU_UNSIGNED_SHORT_4_4_4_4_REV', `GLU_UNSIGNED_SHORT_5_5_5_1',
- `GLU_UNSIGNED_SHORT_1_5_5_5_REV', `GLU_UNSIGNED_INT_8_8_8_8',
- `GLU_UNSIGNED_INT_8_8_8_8_REV', `GLU_UNSIGNED_INT_10_10_10_2', or
- `GLU_UNSIGNED_INT_2_10_10_10_REV'.
-
-LEVEL
- Specifies the mipmap level of the image data.
-
-BASE
- Specifies the minimum mipmap level to pass to `glTexImage2D'.
-
-MAX
- Specifies the maximum mipmap level to pass to `glTexImage2D'.
-
-DATA
- Specifies a pointer to the image data in memory.
-
-
-Description
-===========
-
-`gluBuild2DMipmapLevels' builds a subset of prefiltered two-dimensional
-texture maps of decreasing resolutions called a mipmap. This is used for
-the antialiasing of texture mapped primitives.
-
-A return value of zero indicates success, otherwise a GLU error code is
-returned (see `gluErrorString').
-
-A series of mipmap levels from BASE to MAX is built by decimating DATA
-in half along both dimensions until size 1×1 is reached. At each level,
-each texel in the halved mipmap level is an average of the corresponding
-four texels in the larger mipmap level. (In the case of rectangular
-images, the decimation will ultimately reach an N×1 or 1×N
-configuration. Here, two texels are averaged instead.) `glTexImage2D' is
-called to load these mipmap levels from BASE to MAX. If MAX is larger
-than the highest mipmap level for the texture of the specified size,
-then a GLU error code is returned (see `gluErrorString') and nothing is
-loaded.
-
-For example, if LEVEL is 2 and WIDTH is 16 and HEIGHT is 8, the
-following levels are possible: 16×8, 8×4, 4×2, 2×1, 1×1. These
-correspond to levels 2 through 6 respectively. If BASE is 3 and MAX is
-5, then only mipmap levels 8×4, 4×2, and 2×1 are loaded. However, if MAX
-is 7, then an error is returned and nothing is loaded since MAX is
-larger than the highest mipmap level which is, in this case, 6.
-
-The highest mipmap level can be derived from the formula
-LOG_2\u2061(MAX\u2061(WIDTH,HEIGHT)×2^LEVEL,).
-
-See the `glTexImage1D' reference page for a description of the
-acceptable values for FORMAT parameter. See the `glDrawPixels' reference
-page for a description of the acceptable values for TYPE parameter.
-
-
-Errors
-======
-
-`GLU_INVALID_VALUE' is returned if LEVEL > BASE, BASE < 0, MAX < BASE,
-or MAX is > the highest mipmap level for DATA.
-
-`GLU_INVALID_VALUE' is returned if WIDTH or HEIGHT is < 1.
-
-`GLU_INVALID_ENUM' is returned if INTERNALFORMAT, FORMAT, or TYPE is not
-legal.
-
-`GLU_INVALID_OPERATION' is returned if TYPE is `GLU_UNSIGNED_BYTE_3_3_2'
-or `GLU_UNSIGNED_BYTE_2_3_3_REV' and FORMAT is not `GLU_RGB'.
-
-`GLU_INVALID_OPERATION' is returned if TYPE is
-`GLU_UNSIGNED_SHORT_5_6_5' or `GLU_UNSIGNED_SHORT_5_6_5_REV' and FORMAT
-is not `GLU_RGB'.
-
-`GLU_INVALID_OPERATION' is returned if TYPE is
-`GLU_UNSIGNED_SHORT_4_4_4_4' or `GLU_UNSIGNED_SHORT_4_4_4_4_REV' and
-FORMAT is neither `GLU_RGBA' nor `GLU_BGRA'.
-
-`GLU_INVALID_OPERATION' is returned if TYPE is
-`GLU_UNSIGNED_SHORT_5_5_5_1' or `GLU_UNSIGNED_SHORT_1_5_5_5_REV' and
-FORMAT is neither `GLU_RGBA' nor `GLU_BGRA'.
-
-`GLU_INVALID_OPERATION' is returned if TYPE is
-`GLU_UNSIGNED_INT_8_8_8_8' or `GLU_UNSIGNED_INT_8_8_8_8_REV' and FORMAT
-is neither `GLU_RGBA' nor `GLU_BGRA'.
-
-`GLU_INVALID_OPERATION' is returned if TYPE is
-`GLU_UNSIGNED_INT_10_10_10_2' or `GLU_UNSIGNED_INT_2_10_10_10_REV' and
-FORMAT is neither `GLU_RGBA' nor `GLU_BGRA'.")
-
-(define-gl-procedure
- gluBuild2DMipmaps
- "gluBuild2DMipmaps"
- (funcsynopsis
- (funcprototype
- (funcdef "GLint " (function "gluBuild2DMipmaps"))
- (paramdef "GLenum " (parameter "target"))
- (paramdef "GLint " (parameter "internalFormat"))
- (paramdef "GLsizei " (parameter "width"))
- (paramdef "GLsizei " (parameter "height"))
- (paramdef "GLenum " (parameter "format"))
- (paramdef "GLenum " (parameter "type"))
- (paramdef "const void * " (parameter "data"))))
- "builds a two-dimensional mipmap
-===============================
-
-
-Parameters
-==========
-
-TARGET
- Specifies the target texture. Must be `GLU_TEXTURE_2D'.
-
-INTERNALFORMAT
- Requests the internal storage format of the texture image. The most
- current version of the SGI implementation of GLU does not check
- this value for validity before passing it on to the underlying
- OpenGL implementation. A value that is not accepted by the OpenGL
- implementation will lead to an OpenGL error. The benefit of not
- checking this value at the GLU level is that OpenGL extensions can
- add new internal texture formats without requiring a revision of
- the GLU implementation. Older implementations of GLU check this
- value and raise a GLU error if it is not 1, 2, 3, or 4 or one of
- the following symbolic constants: `GLU_ALPHA', `GLU_ALPHA4',
- `GLU_ALPHA8', `GLU_ALPHA12', `GLU_ALPHA16', `GLU_LUMINANCE',
- `GLU_LUMINANCE4', `GLU_LUMINANCE8', `GLU_LUMINANCE12',
- `GLU_LUMINANCE16', `GLU_LUMINANCE_ALPHA', `GLU_LUMINANCE4_ALPHA4',
- `GLU_LUMINANCE6_ALPHA2', `GLU_LUMINANCE8_ALPHA8',
- `GLU_LUMINANCE12_ALPHA4', `GLU_LUMINANCE12_ALPHA12',
- `GLU_LUMINANCE16_ALPHA16', `GLU_INTENSITY', `GLU_INTENSITY4',
- `GLU_INTENSITY8', `GLU_INTENSITY12', `GLU_INTENSITY16', `GLU_RGB',
- `GLU_R3_G3_B2', `GLU_RGB4', `GLU_RGB5', `GLU_RGB8', `GLU_RGB10',
- `GLU_RGB12', `GLU_RGB16', `GLU_RGBA', `GLU_RGBA2', `GLU_RGBA4',
- `GLU_RGB5_A1', `GLU_RGBA8', `GLU_RGB10_A2', `GLU_RGBA12', or
- `GLU_RGBA16'.
-
-WIDTH
- HEIGHT
-
- Specifies in pixels the width and height, respectively, of the
- texture image.
-
-FORMAT
- Specifies the format of the pixel data. Must be one of
- `GLU_COLOR_INDEX', `GLU_DEPTH_COMPONENT', `GLU_RED', `GLU_GREEN',
- `GLU_BLUE', `GLU_ALPHA', `GLU_RGB', `GLU_RGBA', `GLU_BGR',
- `GLU_BGRA', `GLU_LUMINANCE', or `GLU_LUMINANCE_ALPHA'.
-
-TYPE
- Specifies the data type for DATA. Must be one of
- `GLU_UNSIGNED_BYTE', `GLU_BYTE', `GLU_BITMAP',
- `GLU_UNSIGNED_SHORT', `GLU_SHORT', `GLU_UNSIGNED_INT', `GLU_INT',
- `GLU_FLOAT', `GLU_UNSIGNED_BYTE_3_3_2',
- `GLU_UNSIGNED_BYTE_2_3_3_REV', `GLU_UNSIGNED_SHORT_5_6_5',
- `GLU_UNSIGNED_SHORT_5_6_5_REV', `GLU_UNSIGNED_SHORT_4_4_4_4',
- `GLU_UNSIGNED_SHORT_4_4_4_4_REV', `GLU_UNSIGNED_SHORT_5_5_5_1',
- `GLU_UNSIGNED_SHORT_1_5_5_5_REV', `GLU_UNSIGNED_INT_8_8_8_8',
- `GLU_UNSIGNED_INT_8_8_8_8_REV', `GLU_UNSIGNED_INT_10_10_10_2', or
- `GLU_UNSIGNED_INT_2_10_10_10_REV'.
-
-DATA
- Specifies a pointer to the image data in memory.
-
-
-Description
-===========
-
-`gluBuild2DMipmaps' builds a series of prefiltered two-dimensional
-texture maps of decreasing resolutions called a mipmap. This is used for
-the antialiasing of texture-mapped primitives.
-
-A return value of zero indicates success, otherwise a GLU error code is
-returned (see `gluErrorString').
-
-Initially, the WIDTH and HEIGHT of DATA are checked to see if they are a
-power of 2. If not, a copy of DATA (not DATA), is scaled up or down to
-the nearest power of 2. This copy will be used for subsequent mipmapping
-operations described below. (If WIDTH or HEIGHT is exactly between
-powers of 2, then the copy of DATA will scale upwards.) For example, if
-WIDTH is 57 and HEIGHT is 23, then a copy of DATA will scale up to 64 in
-WIDTH and down to 16 in depth, before mipmapping takes place.
-
-Then, proxy textures (see `glTexImage2D') are used to determine if the
-implementation can fit the requested texture. If not, both dimensions
-are continually halved until it fits. (If the OpenGL version is \\(<=
-1.0, both maximum texture dimensions are clamped to the value returned
-by `glGetIntegerv' with the argument `GLU_MAX_TEXTURE_SIZE'.)
-
-Next, a series of mipmap levels is built by decimating a copy of DATA in
-half along both dimensions until size 1×1 is reached. At each level,
-each texel in the halved mipmap level is an average of the corresponding
-four texels in the larger mipmap level. (In the case of rectangular
-images, the decimation will ultimately reach an N×1 or 1×N
-configuration. Here, two texels are averaged instead.)
-
-`glTexImage2D' is called to load each of these mipmap levels. Level 0 is
-a copy of DATA. The highest level is LOG_2,\u2061(MAX\u2061(WIDTH,HEIGHT),). For
-example, if WIDTH is 64 and HEIGHT is 16 and the implementation can
-store a texture of this size, the following mipmap levels are built:
-64×16, 32×8, 16×4, 8×2, 4×1, 2×1, and 1×1 These correspond to levels 0
-through 6, respectively.
-
-See the `glTexImage1D' reference page for a description of the
-acceptable values for FORMAT parameter. See the `glDrawPixels' reference
-page for a description of the acceptable values for TYPE parameter.
-
-
-Errors
-======
-
-`GLU_INVALID_VALUE' is returned if WIDTH or HEIGHT is < 1.
-
-`GLU_INVALID_ENUM' is returned if INTERNALFORMAT, FORMAT, or TYPE is not
-legal.
-
-`GLU_INVALID_OPERATION' is returned if TYPE is `GLU_UNSIGNED_BYTE_3_3_2'
-or `GLU_UNSIGNED_BYTE_2_3_3_REV' and FORMAT is not `GLU_RGB'.
-
-`GLU_INVALID_OPERATION' is returned if TYPE is
-`GLU_UNSIGNED_SHORT_5_6_5' or `GLU_UNSIGNED_SHORT_5_6_5_REV' and FORMAT
-is not `GLU_RGB'.
-
-`GLU_INVALID_OPERATION' is returned if TYPE is
-`GLU_UNSIGNED_SHORT_4_4_4_4' or `GLU_UNSIGNED_SHORT_4_4_4_4_REV' and
-FORMAT is neither `GLU_RGBA' nor `GLU_BGRA'.
-
-`GLU_INVALID_OPERATION' is returned if TYPE is
-`GLU_UNSIGNED_SHORT_5_5_5_1' or `GLU_UNSIGNED_SHORT_1_5_5_5_REV' and
-FORMAT is neither `GLU_RGBA' nor `GLU_BGRA'.
-
-`GLU_INVALID_OPERATION' is returned if TYPE is
-`GLU_UNSIGNED_INT_8_8_8_8' or `GLU_UNSIGNED_INT_8_8_8_8_REV' and FORMAT
-is neither `GLU_RGBA' nor `GLU_BGRA'.
-
-`GLU_INVALID_OPERATION' is returned if TYPE is
-`GLU_UNSIGNED_INT_10_10_10_2' or `GLU_UNSIGNED_INT_2_10_10_10_REV' and
-FORMAT is neither `GLU_RGBA' nor `GLU_BGRA'.")
-
-(define-gl-procedure
- gluBuild3DMipmapLevels
- "gluBuild3DMipmapLevels"
- (funcsynopsis
- (funcprototype
- (funcdef
- "GLint "
- (function "gluBuild3DMipmapLevels"))
- (paramdef "GLenum " (parameter "target"))
- (paramdef "GLint " (parameter "internalFormat"))
- (paramdef "GLsizei " (parameter "width"))
- (paramdef "GLsizei " (parameter "height"))
- (paramdef "GLsizei " (parameter "depth"))
- (paramdef "GLenum " (parameter "format"))
- (paramdef "GLenum " (parameter "type"))
- (paramdef "GLint " (parameter "level"))
- (paramdef "GLint " (parameter "base"))
- (paramdef "GLint " (parameter "max"))
- (paramdef "const void * " (parameter "data"))))
- "builds a subset of three-dimensional mipmap levels
-==================================================
-
-
-Parameters
-==========
-
-TARGET
- Specifies the target texture. Must be `GLU_TEXTURE_3D'.
-
-INTERNALFORMAT
- Requests the internal storage format of the texture image. The most
- current version of the SGI implementation of GLU does not check
- this value for validity before passing it on to the underlying
- OpenGL implementation. A value that is not accepted by the OpenGL
- implementation will lead to an OpenGL error. The benefit of not
- checking this value at the GLU level is that OpenGL extensions can
- add new internal texture formats without requiring a revision of
- the GLU implementation. Older implementations of GLU check this
- value and raise a GLU error if it is not 1, 2, 3, or 4 or one of
- the following symbolic constants: `GLU_ALPHA', `GLU_ALPHA4',
- `GLU_ALPHA8', `GLU_ALPHA12', `GLU_ALPHA16', `GLU_LUMINANCE',
- `GLU_LUMINANCE4', `GLU_LUMINANCE8', `GLU_LUMINANCE12',
- `GLU_LUMINANCE16', `GLU_LUMINANCE_ALPHA', `GLU_LUMINANCE4_ALPHA4',
- `GLU_LUMINANCE6_ALPHA2', `GLU_LUMINANCE8_ALPHA8',
- `GLU_LUMINANCE12_ALPHA4', `GLU_LUMINANCE12_ALPHA12',
- `GLU_LUMINANCE16_ALPHA16', `GLU_INTENSITY', `GLU_INTENSITY4',
- `GLU_INTENSITY8', `GLU_INTENSITY12', `GLU_INTENSITY16', `GLU_RGB',
- `GLU_R3_G3_B2', `GLU_RGB4', `GLU_RGB5', `GLU_RGB8', `GLU_RGB10',
- `GLU_RGB12', `GLU_RGB16', `GLU_RGBA', `GLU_RGBA2', `GLU_RGBA4',
- `GLU_RGB5_A1', `GLU_RGBA8', `GLU_RGB10_A2', `GLU_RGBA12', or
- `GLU_RGBA16'.
-
-WIDTH
- HEIGHT
-
- DEPTH
-
- Specifies in pixels the width, height and depth respectively, of
- the texture image. These should be a power of 2.
-
-FORMAT
- Specifies the format of the pixel data. Must be one of
- `GLU_COLOR_INDEX', `GLU_DEPTH_COMPONENT', `GLU_RED', `GLU_GREEN',
- `GLU_BLUE', `GLU_ALPHA', `GLU_RGB', `GLU_RGBA', `GLU_BGR',
- `GLU_BGRA', `GLU_LUMINANCE', or `GLU_LUMINANCE_ALPHA'.
-
-TYPE
- Specifies the data type for DATA. Must be one of
- `GLU_UNSIGNED_BYTE', `GLU_BYTE', `GLU_BITMAP',
- `GLU_UNSIGNED_SHORT', `GLU_SHORT', `GLU_UNSIGNED_INT', `GLU_INT',
- `GLU_FLOAT', `GLU_UNSIGNED_BYTE_3_3_2',
- `GLU_UNSIGNED_BYTE_2_3_3_REV', `GLU_UNSIGNED_SHORT_5_6_5',
- `GLU_UNSIGNED_SHORT_5_6_5_REV', `GLU_UNSIGNED_SHORT_4_4_4_4',
- `GLU_UNSIGNED_SHORT_4_4_4_4_REV', `GLU_UNSIGNED_SHORT_5_5_5_1',
- `GLU_UNSIGNED_SHORT_1_5_5_5_REV', `GLU_UNSIGNED_INT_8_8_8_8',
- `GLU_UNSIGNED_INT_8_8_8_8_REV', `GLU_UNSIGNED_INT_10_10_10_2', or
- `GLU_UNSIGNED_INT_2_10_10_10_REV'.
-
-LEVEL
- Specifies the mipmap level of the image data.
-
-BASE
- Specifies the minimum mipmap level to pass to `glTexImage3D'.
-
-MAX
- Specifies the maximum mipmap level to pass to `glTexImage3D'.
-
-DATA
- Specifies a pointer to the image data in memory.
-
-
-Description
-===========
-
-`gluBuild3DMipmapLevels' builds a subset of prefiltered
-three-dimensional texture maps of decreasing resolutions called a
-mipmap. This is used for the antialiasing of texture mapped primitives.
-
-A return value of zero indicates success, otherwise a GLU error code is
-returned (see `gluErrorString').
-
-A series of mipmap levels from BASE to MAX is built by decimating DATA
-in half along both dimensions until size 1×1×1 is reached. At each
-level, each texel in the halved mipmap level is an average of the
-corresponding eight texels in the larger mipmap level. (If exactly one
-of the dimensions is 1, four texels are averaged. If exactly two of the
-dimensions are 1, two texels are averaged.) `glTexImage3D' is called to
-load these mipmap levels from BASE to MAX. If MAX is larger than the
-highest mipmap level for the texture of the specified size, then a GLU
-error code is returned (see `gluErrorString') and nothing is loaded.
-
-For example, if LEVEL is 2 and WIDTH is 16, HEIGHT is 8 and DEPTH is 4,
-the following levels are possible: 16×8×4, 8×4×2, 4×2×1, 2×1×1, 1×1×1.
-These correspond to levels 2 through 6 respectively. If BASE is 3 and
-MAX is 5, then only mipmap levels 8×4×2, 4×2×1, and 2×1×1 are loaded.
-However, if MAX is 7, then an error is returned and nothing is loaded,
-since MAX is larger than the highest mipmap level which is, in this
-case, 6.
-
-The highest mipmap level can be derived from the formula
-LOG_2\u2061(MAX\u2061(WIDTH,HEIGHTDEPTH)×2^LEVEL,).
-
-See the `glTexImage1D' reference page for a description of the
-acceptable values for FORMAT parameter. See the `glDrawPixels' reference
-page for a description of the acceptable values for TYPE parameter.
-
-
-Errors
-======
-
-`GLU_INVALID_VALUE' is returned if LEVEL > BASE, BASE < 0, MAX < BASE,
-or MAX is > the highest mipmap level for DATA.
-
-`GLU_INVALID_VALUE' is returned if WIDTH, HEIGHT, or DEPTH is < 1.
-
-`GLU_INVALID_ENUM' is returned if INTERNALFORMAT, FORMAT, or TYPE is not
-legal.
-
-`GLU_INVALID_OPERATION' is returned if TYPE is `GLU_UNSIGNED_BYTE_3_3_2'
-or `GLU_UNSIGNED_BYTE_2_3_3_REV' and FORMAT is not `GLU_RGB'.
-
-`GLU_INVALID_OPERATION' is returned if TYPE is
-`GLU_UNSIGNED_SHORT_5_6_5' or `GLU_UNSIGNED_SHORT_5_6_5_REV' and FORMAT
-is not `GLU_RGB'.
-
-`GLU_INVALID_OPERATION' is returned if TYPE is
-`GLU_UNSIGNED_SHORT_4_4_4_4' or `GLU_UNSIGNED_SHORT_4_4_4_4_REV' and
-FORMAT is neither `GLU_RGBA' nor `GLU_BGRA'.
-
-`GLU_INVALID_OPERATION' is returned if TYPE is
-`GLU_UNSIGNED_SHORT_5_5_5_1' or `GLU_UNSIGNED_SHORT_1_5_5_5_REV' and
-FORMAT is neither `GLU_RGBA' nor `GLU_BGRA'.
-
-`GLU_INVALID_OPERATION' is returned if TYPE is
-`GLU_UNSIGNED_INT_8_8_8_8' or `GLU_UNSIGNED_INT_8_8_8_8_REV' and FORMAT
-is neither `GLU_RGBA' nor `GLU_BGRA'.
-
-`GLU_INVALID_OPERATION' is returned if TYPE is
-`GLU_UNSIGNED_INT_10_10_10_2' or `GLU_UNSIGNED_INT_2_10_10_10_REV' and
-FORMAT is neither `GLU_RGBA' nor `GLU_BGRA'.")
-
-(define-gl-procedure
- gluBuild3DMipmaps
- "gluBuild3DMipmaps"
- (funcsynopsis
- (funcprototype
- (funcdef "GLint " (function "gluBuild3DMipmaps"))
- (paramdef "GLenum " (parameter "target"))
- (paramdef "GLint " (parameter "internalFormat"))
- (paramdef "GLsizei " (parameter "width"))
- (paramdef "GLsizei " (parameter "height"))
- (paramdef "GLsizei " (parameter "depth"))
- (paramdef "GLenum " (parameter "format"))
- (paramdef "GLenum " (parameter "type"))
- (paramdef "const void * " (parameter "data"))))
- "builds a three-dimensional mipmap
-=================================
-
-
-Parameters
-==========
-
-TARGET
- Specifies the target texture. Must be `GLU_TEXTURE_3D'.
-
-INTERNALFORMAT
- Requests the internal storage format of the texture image. The most
- current version of the SGI implementation of GLU does not check
- this value for validity before passing it on to the underlying
- OpenGL implementation. A value that is not accepted by the OpenGL
- implementation will lead to an OpenGL error. The benefit of not
- checking this value at the GLU level is that OpenGL extensions can
- add new internal texture formats without requiring a revision of
- the GLU implementation. Older implementations of GLU check this
- value and raise a GLU error if it is not 1, 2, 3, or 4 or one of
- the following symbolic constants: `GLU_ALPHA', `GLU_ALPHA4',
- `GLU_ALPHA8', `GLU_ALPHA12', `GLU_ALPHA16', `GLU_LUMINANCE',
- `GLU_LUMINANCE4', `GLU_LUMINANCE8', `GLU_LUMINANCE12',
- `GLU_LUMINANCE16', `GLU_LUMINANCE_ALPHA', `GLU_LUMINANCE4_ALPHA4',
- `GLU_LUMINANCE6_ALPHA2', `GLU_LUMINANCE8_ALPHA8',
- `GLU_LUMINANCE12_ALPHA4', `GLU_LUMINANCE12_ALPHA12',
- `GLU_LUMINANCE16_ALPHA16', `GLU_INTENSITY', `GLU_INTENSITY4',
- `GLU_INTENSITY8', `GLU_INTENSITY12', `GLU_INTENSITY16', `GLU_RGB',
- `GLU_R3_G3_B2', `GLU_RGB4', `GLU_RGB5', `GLU_RGB8', `GLU_RGB10',
- `GLU_RGB12', `GLU_RGB16', `GLU_RGBA', `GLU_RGBA2', `GLU_RGBA4',
- `GLU_RGB5_A1', `GLU_RGBA8', `GLU_RGB10_A2', `GLU_RGBA12', or
- `GLU_RGBA16'.
-
-WIDTH
- HEIGHT
-
- DEPTH
-
- Specifies in pixels the width, height and depth respectively, in
- pixels of the texture image.
-
-FORMAT
- Specifies the format of the pixel data. Must be one of
- `GLU_COLOR_INDEX', `GLU_DEPTH_COMPONENT', `GLU_RED', `GLU_GREEN',
- `GLU_BLUE', `GLU_ALPHA', `GLU_RGB', `GLU_RGBA', `GLU_BGR',
- `GLU_BGRA', `GLU_LUMINANCE', or `GLU_LUMINANCE_ALPHA'.
-
-TYPE
- Specifies the data type for DATA. Must be one of:
- `GLU_UNSIGNED_BYTE', `GLU_BYTE', `GLU_BITMAP',
- `GLU_UNSIGNED_SHORT', `GLU_SHORT', `GLU_UNSIGNED_INT', `GLU_INT',
- `GLU_FLOAT', `GLU_UNSIGNED_BYTE_3_3_2',
- `GLU_UNSIGNED_BYTE_2_3_3_REV', `GLU_UNSIGNED_SHORT_5_6_5',
- `GLU_UNSIGNED_SHORT_5_6_5_REV', `GLU_UNSIGNED_SHORT_4_4_4_4',
- `GLU_UNSIGNED_SHORT_4_4_4_4_REV', `GLU_UNSIGNED_SHORT_5_5_5_1',
- `GLU_UNSIGNED_SHORT_1_5_5_5_REV', `GLU_UNSIGNED_INT_8_8_8_8',
- `GLU_UNSIGNED_INT_8_8_8_8_REV', `GLU_UNSIGNED_INT_10_10_10_2', or
- `GLU_UNSIGNED_INT_2_10_10_10_REV'.
-
-DATA
- Specifies a pointer to the image data in memory.
-
-
-Description
-===========
-
-`gluBuild3DMipmaps' builds a series of prefiltered three-dimensional
-texture maps of decreasing resolutions called a mipmap. This is used for
-the antialiasing of texture-mapped primitives.
-
-A return value of zero indicates success, otherwise a GLU error code is
-returned (see `gluErrorString').
-
-Initially, the WIDTH, HEIGHT and DEPTH of DATA are checked to see if
-they are a power of 2. If not, a copy of DATA is made and scaled up or
-down to the nearest power of 2. (If WIDTH, HEIGHT, or DEPTH is exactly
-between powers of 2, then the copy of DATA will scale upwards.) This
-copy will be used for subsequent mipmapping operations described below.
-For example, if WIDTH is 57, HEIGHT is 23, and DEPTH is 24, then a copy
-of DATA will scale up to 64 in width, down to 16 in height, and up to 32
-in depth before mipmapping takes place.
-
-Then, proxy textures (see `glTexImage3D') are used to determine if the
-implementation can fit the requested texture. If not, all three
-dimensions are continually halved until it fits.
-
-Next, a series of mipmap levels is built by decimating a copy of DATA in
-half along all three dimensions until size 1×1×1 is reached. At each
-level, each texel in the halved mipmap level is an average of the
-corresponding eight texels in the larger mipmap level. (If exactly one
-of the dimensions is 1, four texels are averaged. If exactly two of the
-dimensions are 1, two texels are averaged.)
-
-`glTexImage3D' is called to load each of these mipmap levels. Level 0 is
-a copy of DATA. The highest level is LOG_2,\u2061(MAX\u2061(WIDTH,HEIGHTDEPTH),).
-For example, if WIDTH is 64, HEIGHT is 16, and DEPTH is 32, and the
-implementation can store a texture of this size, the following mipmap
-levels are built: 64×16×32, 32×8×16, 16×4×8, 8×2×4, 4×1×2, 2×1×1, and
-1×1×1. These correspond to levels 0 through 6, respectively.
-
-See the `glTexImage1D' reference page for a description of the
-acceptable values for FORMAT parameter. See the `glDrawPixels' reference
-page for a description of the acceptable values for TYPE parameter.
-
-
-Errors
-======
-
-`GLU_INVALID_VALUE' is returned if WIDTH, HEIGHT, or DEPTH is < 1.
-
-`GLU_INVALID_ENUM' is returned if INTERNALFORMAT, FORMAT, or TYPE is not
-legal.
-
-`GLU_INVALID_OPERATION' is returned if TYPE is `GLU_UNSIGNED_BYTE_3_3_2'
-or `GLU_UNSIGNED_BYTE_2_3_3_REV' and FORMAT is not `GLU_RGB'.
-
-`GLU_INVALID_OPERATION' is returned if TYPE is
-`GLU_UNSIGNED_SHORT_5_6_5' or `GLU_UNSIGNED_SHORT_5_6_5_REV' and FORMAT
-is not `GLU_RGB'.
-
-`GLU_INVALID_OPERATION' is returned if TYPE is
-`GLU_UNSIGNED_SHORT_4_4_4_4' or `GLU_UNSIGNED_SHORT_4_4_4_4_REV' and
-FORMAT is neither `GLU_RGBA' nor `GLU_BGRA'.
-
-`GLU_INVALID_OPERATION' is returned if TYPE is
-`GLU_UNSIGNED_SHORT_5_5_5_1' or `GLU_UNSIGNED_SHORT_1_5_5_5_REV' and
-FORMAT is neither `GLU_RGBA' nor `GLU_BGRA'.
-
-`GLU_INVALID_OPERATION' is returned if TYPE is
-`GLU_UNSIGNED_INT_8_8_8_8' or `GLU_UNSIGNED_INT_8_8_8_8_REV' and FORMAT
-is neither `GLU_RGBA' nor `GLU_BGRA'.
-
-`GLU_INVALID_OPERATION' is returned if TYPE is
-`GLU_UNSIGNED_INT_10_10_10_2' or `GLU_UNSIGNED_INT_2_10_10_10_REV' and
-FORMAT is neither `GLU_RGBA' nor `GLU_BGRA'.")
-
-(define-gl-procedure
- gluCheckExtension
- "gluCheckExtension"
- (funcsynopsis
- (funcprototype
- (funcdef
- "GLboolean "
- (function "gluCheckExtension"))
- (paramdef
- "const GLubyte * "
- (parameter "extName"))
- (paramdef
- "const GLubyte * "
- (parameter "extString"))))
- "determines if an extension name is supported
-============================================
-
-
-Parameters
-==========
-
-EXTNAME
- Specifies an extension name.
-
-EXTSTRING
- Specifies a space-separated list of extension names supported.
-
-
-Description
-===========
-
-`gluCheckExtension' returns `GLU_TRUE' if EXTNAME is supported otherwise
-`GLU_FALSE' is returned.
-
-This is used to check for the presence for OpenGL, GLU, or GLX extension
-names by passing the extension strings returned by `glGetString',
-`gluGetString', `glXGetClientString', `glXQueryExtensionsString', or
-`glXQueryServerString', respectively, as EXTSTRING.")
-
-(define-gl-procedure
- gluCylinder
- "gluCylinder"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "gluCylinder"))
- (paramdef "GLUquadric* " (parameter "quad"))
- (paramdef "GLdouble " (parameter "base"))
- (paramdef "GLdouble " (parameter "top"))
- (paramdef "GLdouble " (parameter "height"))
- (paramdef "GLint " (parameter "slices"))
- (paramdef "GLint " (parameter "stacks"))))
- "draw a cylinder
-===============
-
-
-Parameters
-==========
-
-QUAD
- Specifies the quadrics object (created with `gluNewQuadric').
-
-BASE
- Specifies the radius of the cylinder at Z = 0.
-
-TOP
- Specifies the radius of the cylinder at Z = HEIGHT.
-
-HEIGHT
- Specifies the height of the cylinder.
-
-SLICES
- Specifies the number of subdivisions around the Z axis.
-
-STACKS
- Specifies the number of subdivisions along the Z axis.
-
-
-Description
-===========
-
-`gluCylinder' draws a cylinder oriented along the Z axis. The base of
-the cylinder is placed at Z = 0 and the top at Z=HEIGHT. Like a sphere,
-a cylinder is subdivided around the Z axis into slices and along the Z
-axis into stacks.
-
-Note that if TOP is set to 0.0, this routine generates a cone.
-
-If the orientation is set to `GLU_OUTSIDE' (with
-`gluQuadricOrientation'), then any generated normals point away from the
-Z axis. Otherwise, they point toward the Z axis.
-
-If texturing is turned on (with `gluQuadricTexture'), then texture
-coordinates are generated so that T ranges linearly from 0.0 at Z = 0 to
-1.0 at Z = HEIGHT, and S ranges from 0.0 at the +Y axis, to 0.25 at the
-+X axis, to 0.5 at the -Y axis, to 0.75 at the \\-X axis, and back to 1.0
-at the +Y axis.")
-
-(define-gl-procedure
- gluDeleteNurbsRenderer
- "gluDeleteNurbsRenderer"
- (funcsynopsis
- (funcprototype
- (funcdef
- "void "
- (function "gluDeleteNurbsRenderer"))
- (paramdef "GLUnurbs* " (parameter "nurb"))))
- "destroy a NURBS object
-======================
-
-
-Parameters
-==========
-
-NURB
- Specifies the NURBS object to be destroyed.
-
-
-Description
-===========
-
-`gluDeleteNurbsRenderer' destroys the NURBS object (which was created
-with `gluNewNurbsRenderer') and frees any memory it uses. Once
-`gluDeleteNurbsRenderer' has been called, NURB cannot be used again.")
-
-(define-gl-procedure
- gluDeleteQuadric
- "gluDeleteQuadric"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "gluDeleteQuadric"))
- (paramdef "GLUquadric* " (parameter "quad"))))
- "destroy a quadrics object
-=========================
-
-
-Parameters
-==========
-
-QUAD
- Specifies the quadrics object to be destroyed.
-
-
-Description
-===========
-
-`gluDeleteQuadric' destroys the quadrics object (created with
-`gluNewQuadric') and frees any memory it uses. Once `gluDeleteQuadric'
-has been called, QUAD cannot be used again.")
-
-(define-gl-procedure
- gluDeleteTess
- "gluDeleteTess"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "gluDeleteTess"))
- (paramdef "GLUtesselator* " (parameter "tess"))))
- "destroy a tessellation object
-=============================
-
-
-Parameters
-==========
-
-TESS
- Specifies the tessellation object to destroy.
-
-
-Description
-===========
-
-`gluDeleteTess' destroys the indicated tessellation object (which was
-created with `gluNewTess') and frees any memory that it used.")
-
-(define-gl-procedure
- gluDisk
- "gluDisk"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "gluDisk"))
- (paramdef "GLUquadric* " (parameter "quad"))
- (paramdef "GLdouble " (parameter "inner"))
- (paramdef "GLdouble " (parameter "outer"))
- (paramdef "GLint " (parameter "slices"))
- (paramdef "GLint " (parameter "loops"))))
- "draw a disk
-===========
-
-
-Parameters
-==========
-
-QUAD
- Specifies the quadrics object (created with `gluNewQuadric').
-
-INNER
- Specifies the inner radius of the disk (may be 0).
-
-OUTER
- Specifies the outer radius of the disk.
-
-SLICES
- Specifies the number of subdivisions around the Z axis.
-
-LOOPS
- Specifies the number of concentric rings about the origin into
- which the disk is subdivided.
-
-
-Description
-===========
-
-`gluDisk' renders a disk on the Z = 0 plane. The disk has a radius of
-OUTER and contains a concentric circular hole with a radius of INNER. If
-INNER is 0, then no hole is generated. The disk is subdivided around the
-Z axis into slices (like pizza slices) and also about the Z axis into
-rings (as specified by SLICES and LOOPS, respectively).
-
-With respect to orientation, the +Z side of the disk is considered to be
-``outside'' (see `gluQuadricOrientation'). This means that if the
-orientation is set to `GLU_OUTSIDE', then any normals generated point
-along the +Z axis. Otherwise, they point along the \\-Z axis.
-
-If texturing has been turned on (with `gluQuadricTexture'), texture
-coordinates are generated linearly such that where R=OUTER, the value at
-(R, 0, 0) is (1, 0.5), at (0, R, 0) it is (0.5, 1), at (\\-R, 0, 0) it is
-(0, 0.5), and at (0, \\-R, 0) it is (0.5, 0).")
-
-(define-gl-procedure
- gluErrorString
- "gluErrorString"
- (funcsynopsis
- (funcprototype
- (funcdef
- "const GLubyte * "
- (function "gluErrorString"))
- (paramdef "GLenum " (parameter "error"))))
- "produce an error string from a GL or GLU error code
-===================================================
-
-
-Parameters
-==========
-
-ERROR
- Specifies a GL or GLU error code.
-
-
-Description
-===========
-
-`gluErrorString' produces an error string from a GL or GLU error code.
-The string is in ISO Latin 1 format. For example,
-`gluErrorString'(`GLU_OUT_OF_MEMORY') returns the string OUT OF MEMORY.
-
-The standard GLU error codes are `GLU_INVALID_ENUM',
-`GLU_INVALID_VALUE', and `GLU_OUT_OF_MEMORY'. Certain other GLU
-functions can return specialized error codes through callbacks. See the
-`glGetError' reference page for the list of GL error codes.
-
-
-Errors
-======
-
-`NULL' is returned if ERROR is not a valid GL or GLU error code.")
-
-(define-gl-procedure
- gluGetNurbsProperty
- "gluGetNurbsProperty"
- (funcsynopsis
- (funcprototype
- (funcdef
- "void "
- (function "gluGetNurbsProperty"))
- (paramdef "GLUnurbs* " (parameter "nurb"))
- (paramdef "GLenum " (parameter "property"))
- (paramdef "GLfloat* " (parameter "data"))))
- "get a NURBS property
-====================
-
-
-Parameters
-==========
-
-NURB
- Specifies the NURBS object (created with `gluNewNurbsRenderer').
-
-PROPERTY
- Specifies the property whose value is to be fetched. Valid values
- are `GLU_CULLING', `GLU_SAMPLING_TOLERANCE', `GLU_DISPLAY_MODE',
- `GLU_AUTO_LOAD_MATRIX', `GLU_PARAMETRIC_TOLERANCE',
- `GLU_SAMPLING_METHOD', `GLU_U_STEP', `GLU_V_STEP', and
- `GLU_NURBS_MODE'.
-
-DATA
- Specifies a pointer to the location into which the value of the
- named property is written.
-
-
-Description
-===========
-
-`gluGetNurbsProperty' retrieves properties stored in a NURBS object.
-These properties affect the way that NURBS curves and surfaces are
-rendered. See the `gluNurbsProperty' reference page for information
-about what the properties are and what they do.")
-
-(define-gl-procedure
- gluGetString
- "gluGetString"
- (funcsynopsis
- (funcprototype
- (funcdef
- "const GLubyte * "
- (function "gluGetString"))
- (paramdef "GLenum " (parameter "name"))))
- "return a string describing the GLU version or GLU extensions
-=============================================================
-
-
-Parameters
-==========
-
-NAME
- Specifies a symbolic constant, one of `GLU_VERSION', or
- `GLU_EXTENSIONS'.
-
-
-Description
-===========
-
-`gluGetString' returns a pointer to a static string describing the GLU
-version or the GLU extensions that are supported.
-
-The version number is one of the following forms:
-
-MAJOR_NUMBER.MINOR_NUMBERMAJOR_NUMBER.MINOR_NUMBER.RELEASE_NUMBER.
-
-The version string is of the following form:
-
-VERSION NUMBER<SPACE>VENDOR-SPECIFIC INFORMATION
-
-Vendor-specific information is optional. Its format and contents depend
-on the implementation.
-
-The standard GLU contains a basic set of features and capabilities. If a
-company or group of companies wish to support other features, these may
-be included as extensions to the GLU. If NAME is `GLU_EXTENSIONS', then
-`gluGetString' returns a space-separated list of names of supported GLU
-extensions. (Extension names never contain spaces.)
-
-All strings are null-terminated.
-
-
-Errors
-======
-
-NULL is returned if NAME is not `GLU_VERSION' or `GLU_EXTENSIONS'.")
-
-(define-gl-procedure
- gluGetTessProperty
- "gluGetTessProperty"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "gluGetTessProperty"))
- (paramdef "GLUtesselator* " (parameter "tess"))
- (paramdef "GLenum " (parameter "which"))
- (paramdef "GLdouble* " (parameter "data"))))
- "get a tessellation object property
-==================================
-
-
-Parameters
-==========
-
-TESS
- Specifies the tessellation object (created with `gluNewTess').
-
-WHICH
- Specifies the property whose value is to be fetched. Valid values
- are `GLU_TESS_WINDING_RULE', `GLU_TESS_BOUNDARY_ONLY', and
- `GLU_TESS_TOLERANCE'.
-
-DATA
- Specifies a pointer to the location into which the value of the
- named property is written.
-
-
-Description
-===========
-
-`gluGetTessProperty' retrieves properties stored in a tessellation
-object. These properties affect the way that tessellation objects are
-interpreted and rendered. See the `gluTessProperty' reference page for
-information about the properties and what they do.")
-
-(define-gl-procedure
- gluLoadSamplingMatrices
- "gluLoadSamplingMatrices"
- (funcsynopsis
- (funcprototype
- (funcdef
- "void "
- (function "gluLoadSamplingMatrices"))
- (paramdef "GLUnurbs* " (parameter "nurb"))
- (paramdef "const GLfloat * " (parameter "model"))
- (paramdef
- "const GLfloat * "
- (parameter "perspective"))
- (paramdef "const GLint * " (parameter "view"))))
- "load NURBS sampling and culling matrices
-========================================
-
-
-Parameters
-==========
-
-NURB
- Specifies the NURBS object (created with `gluNewNurbsRenderer').
-
-MODEL
- Specifies a modelview matrix (as from a `glGetFloatv' call).
-
-PERSPECTIVE
- Specifies a projection matrix (as from a `glGetFloatv' call).
-
-VIEW
- Specifies a viewport (as from a `glGetIntegerv' call).
-
-
-Description
-===========
-
-`gluLoadSamplingMatrices' uses MODEL, PERSPECTIVE, and VIEW to recompute
-the sampling and culling matrices stored in NURB. The sampling matrix
-determines how finely a NURBS curve or surface must be tessellated to
-satisfy the sampling tolerance (as determined by the
-`GLU_SAMPLING_TOLERANCE' property). The culling matrix is used in
-deciding if a NURBS curve or surface should be culled before rendering
-(when the `GLU_CULLING' property is turned on).
-
-`gluLoadSamplingMatrices' is necessary only if the
-`GLU_AUTO_LOAD_MATRIX' property is turned off (see `gluNurbsProperty').
-Although it can be convenient to leave the `GLU_AUTO_LOAD_MATRIX'
-property turned on, there can be a performance penalty for doing so. (A
-round trip to the GL server is needed to fetch the current values of the
-modelview matrix, projection matrix, and viewport.)")
-
-(define-gl-procedure
- gluLookAt
- "gluLookAt"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "gluLookAt"))
- (paramdef "GLdouble " (parameter "eyeX"))
- (paramdef "GLdouble " (parameter "eyeY"))
- (paramdef "GLdouble " (parameter "eyeZ"))
- (paramdef "GLdouble " (parameter "centerX"))
- (paramdef "GLdouble " (parameter "centerY"))
- (paramdef "GLdouble " (parameter "centerZ"))
- (paramdef "GLdouble " (parameter "upX"))
- (paramdef "GLdouble " (parameter "upY"))
- (paramdef "GLdouble " (parameter "upZ"))))
- "define a viewing transformation
-===============================
-
-
-Parameters
-==========
-
-EYEX
- EYEY
-
- EYEZ
-
- Specifies the position of the eye point.
-
-CENTERX
- CENTERY
-
- CENTERZ
-
- Specifies the position of the reference point.
-
-UPX
- UPY
-
- UPZ
-
- Specifies the direction of the UP vector.
-
-
-Description
-===========
-
-`gluLookAt' creates a viewing matrix derived from an eye point, a
-reference point indicating the center of the scene, and an UP vector.
-
-The matrix maps the reference point to the negative Z axis and the eye
-point to the origin. When a typical projection matrix is used, the
-center of the scene therefore maps to the center of the viewport.
-Similarly, the direction described by the UP vector projected onto the
-viewing plane is mapped to the positive Y axis so that it points upward
-in the viewport. The UP vector must not be parallel to the line of sight
-from the eye point to the reference point.
-
-Let
-
-F=((CENTERX-EYEX), (CENTERY-EYEY), (CENTERZ-EYEZ),)
-
-
-
-Let UP be the vector (UPX,UPYUPZ).
-
-Then normalize as follows: F=F/∥F,∥,
-
-UP^″=UP/∥UP,∥,
-
-
-
-Finally, let S=F×UP^″, and U=S×F.
-
-
-
-M is then constructed as follows: M=((S\u2061[0,] S\u2061[1,] S\u2061[2,] 0), (U\u2061[0,]
-U\u2061[1,] U\u2061[2,] 0), (-F\u2061[0,] -F\u2061[1,] -F\u2061[2,] 0), (0 0 0 1),)
-
-and `gluLookAt' is equivalent to glMultMatrixf(M); glTranslated(-eyex,
--eyey, -eyez);")
-
-(define-gl-procedure
- gluNewNurbsRenderer
- "gluNewNurbsRenderer"
- (funcsynopsis
- (funcprototype
- (funcdef
- "GLUnurbs* "
- (function "gluNewNurbsRenderer"))))
- "create a NURBS object
-=====================
-
-
-Description
-===========
-
-`gluNewNurbsRenderer' creates and returns a pointer to a new NURBS
-object. This object must be referred to when calling NURBS rendering and
-control functions. A return value of 0 means that there is not enough
-memory to allocate the object.")
-
-(define-gl-procedure
- gluNewQuadric
- "gluNewQuadric"
- (funcsynopsis
- (funcprototype
- (funcdef
- "GLUquadric* "
- (function "gluNewQuadric"))))
- "create a quadrics object
-========================
-
-
-Description
-===========
-
-`gluNewQuadric' creates and returns a pointer to a new quadrics object.
-This object must be referred to when calling quadrics rendering and
-control functions. A return value of 0 means that there is not enough
-memory to allocate the object.")
-
-(define-gl-procedure
- gluNewTess
- "gluNewTess"
- (funcsynopsis
- (funcprototype
- (funcdef
- "GLUtesselator* "
- (function "gluNewTess"))))
- "create a tessellation object
-============================
-
-
-Description
-===========
-
-`gluNewTess' creates and returns a pointer to a new tessellation object.
-This object must be referred to when calling tessellation functions. A
-return value of 0 means that there is not enough memory to allocate the
-object.")
-
-(define-gl-procedure
- gluNextContour
- "gluNextContour"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "gluNextContour"))
- (paramdef "GLUtesselator* " (parameter "tess"))
- (paramdef "GLenum " (parameter "type"))))
- "mark the beginning of another contour
-=====================================
-
-
-Parameters
-==========
-
-TESS
- Specifies the tessellation object (created with `gluNewTess').
-
-TYPE
- Specifies the type of the contour being defined. Valid values are
- `GLU_EXTERIOR', `GLU_INTERIOR', `GLU_UNKNOWN', `GLU_CCW', and
- `GLU_CW'.
-
-
-Description
-===========
-
-`gluNextContour' is used in describing polygons with multiple contours.
-After the first contour has been described through a series of
-`gluTessVertex' calls, a `gluNextContour' call indicates that the
-previous contour is complete and that the next contour is about to
-begin. Another series of `gluTessVertex' calls is then used to describe
-the new contour. This process can be repeated until all contours have
-been described.
-
-TYPE defines what type of contour follows. The legal contour types are
-as follows:
-
-`GLU_EXTERIOR'
- An exterior contour defines an exterior boundary of the polygon.
-
-`GLU_INTERIOR'
- An interior contour defines an interior boundary of the polygon
- (such as a hole).
-
-`GLU_UNKNOWN'
- An unknown contour is analyzed by the library to determine if it is
- interior or exterior.
-
-`GLU_CCW',
-`GLU_CW'
- The first `GLU_CCW' or `GLU_CW' contour defined is considered to be
- exterior. All other contours are considered to be exterior if they
- are oriented in the same direction (clockwise or counterclockwise)
- as the first contour, and interior if they are not.
-
-If one contour is of type `GLU_CCW' or `GLU_CW', then all contours must
-be of the same type (if they are not, then all `GLU_CCW' and `GLU_CW'
-contours will be changed to `GLU_UNKNOWN').
-
-Note that there is no real difference between the `GLU_CCW' and `GLU_CW'
-contour types.
-
-Before the first contour is described, `gluNextContour' can be called to
-define the type of the first contour. If `gluNextContour' is not called
-before the first contour, then the first contour is marked
-`GLU_EXTERIOR'.
-
-This command is obsolete and is provided for backward compatibility
-only. Calls to `gluNextContour' are mapped to `gluTessEndContour'
-followed by `gluTessBeginContour'.")
-
-(define-gl-procedure
- glUniform1f
- "glUniform1f"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glUniform1f"))
- (paramdef "GLint " (parameter "location"))
- (paramdef "GLfloat " (parameter "v0")))
- (funcprototype
- (funcdef "void " (function "glUniform2f"))
- (paramdef "GLint " (parameter "location"))
- (paramdef "GLfloat " (parameter "v0"))
- (paramdef "GLfloat " (parameter "v1")))
- (funcprototype
- (funcdef "void " (function "glUniform3f"))
- (paramdef "GLint " (parameter "location"))
- (paramdef "GLfloat " (parameter "v0"))
- (paramdef "GLfloat " (parameter "v1"))
- (paramdef "GLfloat " (parameter "v2")))
- (funcprototype
- (funcdef "void " (function "glUniform4f"))
- (paramdef "GLint " (parameter "location"))
- (paramdef "GLfloat " (parameter "v0"))
- (paramdef "GLfloat " (parameter "v1"))
- (paramdef "GLfloat " (parameter "v2"))
- (paramdef "GLfloat " (parameter "v3")))
- (funcprototype
- (funcdef "void " (function "glUniform1i"))
- (paramdef "GLint " (parameter "location"))
- (paramdef "GLint " (parameter "v0")))
- (funcprototype
- (funcdef "void " (function "glUniform2i"))
- (paramdef "GLint " (parameter "location"))
- (paramdef "GLint " (parameter "v0"))
- (paramdef "GLint " (parameter "v1")))
- (funcprototype
- (funcdef "void " (function "glUniform3i"))
- (paramdef "GLint " (parameter "location"))
- (paramdef "GLint " (parameter "v0"))
- (paramdef "GLint " (parameter "v1"))
- (paramdef "GLint " (parameter "v2")))
- (funcprototype
- (funcdef "void " (function "glUniform4i"))
- (paramdef "GLint " (parameter "location"))
- (paramdef "GLint " (parameter "v0"))
- (paramdef "GLint " (parameter "v1"))
- (paramdef "GLint " (parameter "v2"))
- (paramdef "GLint " (parameter "v3"))))
- "Specify the value of a uniform variable for the current program object
-======================================================================
-
-
-Parameters
-==========
-
-LOCATION
- Specifies the location of the uniform variable to be modified.
-
-V0, V1, V2, V3
- Specifies the new values to be used for the specified uniform
- variable.
-
-
-Description
-===========
-
-`glUniform' modifies the value of a uniform variable or a uniform
-variable array. The location of the uniform variable to be modified is
-specified by LOCATION, which should be a value returned by
-`glGetUniformLocation'. `glUniform' operates on the program object that
-was made part of current state by calling `glUseProgram'.
-
-The commands `glUniform{1|2|3|4}{f|i}' are used to change the value of
-the uniform variable specified by LOCATION using the values passed as
-arguments. The number specified in the command should match the number
-of components in the data type of the specified uniform variable (e.g.,
-`1' for float, int, bool; `2' for vec2, ivec2, bvec2, etc.). The suffix
-`f' indicates that floating-point values are being passed; the suffix
-`i' indicates that integer values are being passed, and this type should
-also match the data type of the specified uniform variable. The `i'
-variants of this function should be used to provide values for uniform
-variables defined as int, ivec2, ivec3, ivec4, or arrays of these. The
-`f' variants should be used to provide values for uniform variables of
-type float, vec2, vec3, vec4, or arrays of these. Either the `i' or the
-`f' variants may be used to provide values for uniform variables of type
-bool, bvec2, bvec3, bvec4, or arrays of these. The uniform variable will
-be set to false if the input value is 0 or 0.0f, and it will be set to
-true otherwise.
-
-All active uniform variables defined in a program object are initialized
-to 0 when the program object is linked successfully. They retain the
-values assigned to them by a call to `glUniform ' until the next
-successful link operation occurs on the program object, when they are
-once again initialized to 0.
-
-The commands `glUniform{1|2|3|4}{f|i}v' can be used to modify a single
-uniform variable or a uniform variable array. These commands pass a
-count and a pointer to the values to be loaded into a uniform variable
-or a uniform variable array. A count of 1 should be used if modifying
-the value of a single uniform variable, and a count of 1 or greater can
-be used to modify an entire array or part of an array. When loading N
-elements starting at an arbitrary position M in a uniform variable
-array, elements M + N - 1 in the array will be replaced with the new
-values. If M + N - 1 is larger than the size of the uniform variable
-array, values for all array elements beyond the end of the array will be
-ignored. The number specified in the name of the command indicates the
-number of components for each element in VALUE, and it should match the
-number of components in the data type of the specified uniform variable
-(e.g., `1' for float, int, bool; `2' for vec2, ivec2, bvec2, etc.). The
-data type specified in the name of the command must match the data type
-for the specified uniform variable as described previously for
-`glUniform{1|2|3|4}{f|i}'.
-
-For uniform variable arrays, each element of the array is considered to
-be of the type indicated in the name of the command (e.g., `glUniform3f'
-or `glUniform3fv' can be used to load a uniform variable array of type
-vec3). The number of elements of the uniform variable array to be
-modified is specified by COUNT
-
-The commands `glUniformMatrix{2|3|4|2x3|3x2|2x4|4x2|3x4|4x3}fv' are used
-to modify a matrix or an array of matrices. The numbers in the command
-name are interpreted as the dimensionality of the matrix. The number `2'
-indicates a 2 × 2 matrix (i.e., 4 values), the number `3' indicates a 3
-× 3 matrix (i.e., 9 values), and the number `4' indicates a 4 × 4 matrix
-(i.e., 16 values). Non-square matrix dimensionality is explicit, with
-the first number representing the number of columns and the second
-number representing the number of rows. For example, `2x4' indicates a 2
-× 4 matrix with 2 columns and 4 rows (i.e., 8 values). If TRANSPOSE is
-`GL_FALSE', each matrix is assumed to be supplied in column major order.
-If TRANSPOSE is `GL_TRUE', each matrix is assumed to be supplied in row
-major order. The COUNT argument indicates the number of matrices to be
-passed. A count of 1 should be used if modifying the value of a single
-matrix, and a count greater than 1 can be used to modify an array of
-matrices.
-
-
-Errors
-======
-
-`GL_INVALID_OPERATION' is generated if there is no current program
-object.
-
-`GL_INVALID_OPERATION' is generated if the size of the uniform variable
-declared in the shader does not match the size indicated by the
-`glUniform' command.
-
-`GL_INVALID_OPERATION' is generated if one of the integer variants of
-this function is used to load a uniform variable of type float, vec2,
-vec3, vec4, or an array of these, or if one of the floating-point
-variants of this function is used to load a uniform variable of type
-int, ivec2, ivec3, or ivec4, or an array of these.
-
-`GL_INVALID_OPERATION' is generated if LOCATION is an invalid uniform
-location for the current program object and LOCATION is not equal to -1.
-
-`GL_INVALID_VALUE' is generated if COUNT is less than 0.
-
-`GL_INVALID_OPERATION' is generated if COUNT is greater than 1 and the
-indicated uniform variable is not an array variable.
-
-`GL_INVALID_OPERATION' is generated if a sampler is loaded using a
-command other than `glUniform1i' and `glUniform1iv'.
-
-`GL_INVALID_OPERATION' is generated if `glUniform' is executed between
-the execution of `glBegin' and the corresponding execution of `glEnd'.")
-
-(define-gl-procedure
- gluNurbsCallbackDataEXT
- "gluNurbsCallbackDataEXT"
- (funcsynopsis
- (funcprototype
- (funcdef
- "void "
- (function "gluNurbsCallbackDataEXT"))
- (paramdef "GLUnurbs* " (parameter "nurb"))
- (paramdef "GLvoid* " (parameter "userData"))))
- "set a user data pointer
-=======================
-
-
-Parameters
-==========
-
-NURB
- Specifies the NURBS object (created with `gluNewNurbsRenderer').
-
-USERDATA
- Specifies a pointer to the user's data.
-
-
-Description
-===========
-
-`gluNurbsCallbackDataEXT' is used to pass a pointer to the application's
-data to NURBS tessellator. A copy of this pointer will be passed by the
-tessellator in the NURBS callback functions (set by `gluNurbsCallback').")
-
-(define-gl-procedure
- gluNurbsCallbackData
- "gluNurbsCallbackData"
- (funcsynopsis
- (funcprototype
- (funcdef
- "void "
- (function "gluNurbsCallbackData"))
- (paramdef "GLUnurbs* " (parameter "nurb"))
- (paramdef "GLvoid* " (parameter "userData"))))
- "set a user data pointer
-=======================
-
-
-Parameters
-==========
-
-NURB
- Specifies the NURBS object (created with `gluNewNurbsRenderer').
-
-USERDATA
- Specifies a pointer to the user's data.
-
-
-Description
-===========
-
-`gluNurbsCallbackData' is used to pass a pointer to the application's
-data to NURBS tessellator. A copy of this pointer will be passed by the
-tessellator in the NURBS callback functions (set by `gluNurbsCallback').")
-
-(define-gl-procedure
- gluNurbsCallback
- "gluNurbsCallback"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "gluNurbsCallback"))
- (paramdef "GLUnurbs* " (parameter "nurb"))
- (paramdef "GLenum " (parameter "which"))
- (paramdef
- "_GLUfuncptr "
- (parameter "CallBackFunc"))))
- "define a callback for a NURBS object
-====================================
-
-
-Parameters
-==========
-
-NURB
- Specifies the NURBS object (created with `gluNewNurbsRenderer').
-
-WHICH
- Specifies the callback being defined. Valid values are
- `GLU_NURBS_BEGIN', `GLU_NURBS_VERTEX', `GLU_NURBS_NORMAL',
- `GLU_NURBS_COLOR', `GLU_NURBS_TEXTURE_COORD', `GLU_NURBS_END',
- `GLU_NURBS_BEGIN_DATA', `GLU_NURBS_VERTEX_DATA',
- `GLU_NURBS_NORMAL_DATA', `GLU_NURBS_COLOR_DATA',
- `GLU_NURBS_TEXTURE_COORD_DATA', `GLU_NURBS_END_DATA', and
- `GLU_NURBS_ERROR'.
-
-CALLBACKFUNC
- Specifies the function that the callback calls.
-
-
-Description
-===========
-
-`gluNurbsCallback' is used to define a callback to be used by a NURBS
-object. If the specified callback is already defined, then it is
-replaced. If CALLBACKFUNC is NULL, then this callback will not get
-invoked and the related data, if any, will be lost.
-
-Except the error callback, these callbacks are used by NURBS tessellator
-(when `GLU_NURBS_MODE' is set to be `GLU_NURBS_TESSELLATOR') to return
-back the OpenGL polygon primitives resulting from the tessellation. Note
-that there are two versions of each callback: one with a user data
-pointer and one without. If both versions for a particular callback are
-specified then the callback with the user data pointer will be used.
-Note that ``userData'' is a copy of the pointer that was specified at
-the last call to `gluNurbsCallbackData'.
-
-The error callback function is effective no matter which value that
-`GLU_NURBS_MODE' is set to. All other callback functions are effective
-only when `GLU_NURBS_MODE' is set to `GLU_NURBS_TESSELLATOR'.
-
-The legal callbacks are as follows:
-
-`GLU_NURBS_BEGIN'
-
-
- The begin callback indicates the start of a primitive. The function
- takes a single argument of type GLenum, which can be one of
- `GLU_LINES', `GLU_LINE_STRIP', `GLU_TRIANGLE_FAN',
- `GLU_TRIANGLE_STRIP', `GLU_TRIANGLES', or `GLU_QUAD_STRIP'. The
- default begin callback function is NULL. The function prototype for
- this callback looks like: void begin( GLenum type );
-
-`GLU_NURBS_BEGIN_DATA'
-
-
- The same as the `GLU_NURBS_BEGIN' callback except that it takes an
- additional pointer argument. This pointer is a copy of the pointer
- that was specified at the last call to `gluNurbsCallbackData'. The
- default callback function is NULL. The function prototype for this
- callback function looks like: void beginData(GLenum type, void
- *userData);
-
-`GLU_NURBS_VERTEX'
-
-
- The vertex callback indicates a vertex of the primitive. The
- coordinates of the vertex are stored in the parameter ``vertex''.
- All the generated vertices have dimension 3; that is, homogeneous
- coordinates have been transformed into affine coordinates. The
- default vertex callback function is NULL. The function prototype
- for this callback function looks like: void vertex( GLfloat *vertex
- );
-
-`GLU_NURBS_VERTEX_DATA'
-
-
- This is the same as the `GLU_NURBS_VERTEX' callback, except that it
- takes an additional pointer argument. This pointer is a copy of the
- pointer that was specified at the last call to
- `gluNurbsCallbackData'. The default callback function is NULL. The
- function prototype for this callback function looks like: void
- vertexData( GLfloat *vertex, void *userData );
-
-`GLU_NURBS_NORMAL'
-
-
- The normal callback is invoked as the vertex normal is generated.
- The components of the normal are stored in the parameter
- ``normal.'' In the case of a NURBS curve, the callback function is
- effective only when the user provides a normal map
- (`GLU_MAP1_NORMAL'). In the case of a NURBS surface, if a normal
- map (`GLU_MAP2_NORMAL') is provided, then the generated normal is
- computed from the normal map. If a normal map is not provided, then
- a surface normal is computed in a manner similar to that described
- for evaluators when `GLU_AUTO_NORMAL' is enabled. The default
- normal callback function is NULL. The function prototype for this
- callback function looks like: void normal( GLfloat *normal );
-
-`GLU_NURBS_NORMAL_DATA'
-
-
- The same as the `GLU_NURBS_NORMAL' callback except that it takes an
- additional pointer argument. This pointer is a copy of the pointer
- that was specified at the last call to `gluNurbsCallbackData'. The
- default callback function is NULL. The function prototype for this
- callback function looks like: void normalData( GLfloat *normal,
- void *userData );
-
-`GLU_NURBS_COLOR'
-
-
- The color callback is invoked as the color of a vertex is
- generated. The components of the color are stored in the parameter
- ``color.'' This callback is effective only when the user provides a
- color map (`GLU_MAP1_COLOR_4' or `GLU_MAP2_COLOR_4'). ``color''
- contains four components: R, G, B, A. The default color callback
- function is NULL. The prototype for this callback function looks
- like: void color( GLfloat *color );
-
-`GLU_NURBS_COLOR_DATA'
-
-
- The same as the `GLU_NURBS_COLOR' callback except that it takes an
- additional pointer argument. This pointer is a copy of the pointer
- that was specified at the last call to `gluNurbsCallbackData'. The
- default callback function is NULL. The function prototype for this
- callback function looks like: void colorData( GLfloat *color, void
- *userData );
-
-`GLU_NURBS_TEXTURE_COORD'
-
-
- The texture callback is invoked as the texture coordinates of a
- vertex are generated. These coordinates are stored in the parameter
- ``texCoord.'' The number of texture coordinates can be 1, 2, 3, or
- 4 depending on which type of texture map is specified
- (`GLU_MAP1_TEXTURE_COORD_1', `GLU_MAP1_TEXTURE_COORD_2',
- `GLU_MAP1_TEXTURE_COORD_3', `GLU_MAP1_TEXTURE_COORD_4',
- `GLU_MAP2_TEXTURE_COORD_1', `GLU_MAP2_TEXTURE_COORD_2',
- `GLU_MAP2_TEXTURE_COORD_3', `GLU_MAP2_TEXTURE_COORD_4'). If no
- texture map is specified, this callback function will not be
- called. The default texture callback function is NULL. The function
- prototype for this callback function looks like: void texCoord(
- GLfloat *texCoord );
-
-`GLU_NURBS_TEXTURE_COORD_DATA'
-
-
- This is the same as the `GLU_NURBS_TEXTURE_COORD' callback, except
- that it takes an additional pointer argument. This pointer is a
- copy of the pointer that was specified at the last call to
- `gluNurbsCallbackData'. The default callback function is NULL. The
- function prototype for this callback function looks like: void
- texCoordData( GLfloat *texCoord, void *userData );
-
-`GLU_NURBS_END'
-
-
- The end callback is invoked at the end of a primitive. The default
- end callback function is NULL. The function prototype for this
- callback function looks like: void end( void );
-
-`GLU_NURBS_END_DATA'
-
-
- This is the same as the `GLU_NURBS_END' callback, except that it
- takes an additional pointer argument. This pointer is a copy of the
- pointer that was specified at the last call to
- `gluNurbsCallbackData'. The default callback function is NULL. The
- function prototype for this callback function looks like: void
- endData( void *userData );
-
-`GLU_NURBS_ERROR'
-
-
- The error function is called when an error is encountered. Its
- single argument is of type GLenum, and it indicates the specific
- error that occurred. There are 37 errors unique to NURBS, named
- `GLU_NURBS_ERROR1' through `GLU_NURBS_ERROR37'. Character strings
- describing these errors can be retrieved with `gluErrorString'.")
-
-(define-gl-procedure
- gluNurbsCurve
- "gluNurbsCurve"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "gluNurbsCurve"))
- (paramdef "GLUnurbs* " (parameter "nurb"))
- (paramdef "GLint " (parameter "knotCount"))
- (paramdef "GLfloat * " (parameter "knots"))
- (paramdef "GLint " (parameter "stride"))
- (paramdef "GLfloat * " (parameter "control"))
- (paramdef "GLint " (parameter "order"))
- (paramdef "GLenum " (parameter "type"))))
- "define the shape of a NURBS curve
-=================================
-
-
-Parameters
-==========
-
-NURB
- Specifies the NURBS object (created with `gluNewNurbsRenderer').
-
-KNOTCOUNT
- Specifies the number of knots in KNOTS. KNOTCOUNT equals the number
- of control points plus the order.
-
-KNOTS
- Specifies an array of KNOTCOUNT nondecreasing knot values.
-
-STRIDE
- Specifies the offset (as a number of single-precision
- floating-point values) between successive curve control points.
-
-CONTROL
- Specifies a pointer to an array of control points. The coordinates
- must agree with TYPE, specified below.
-
-ORDER
- Specifies the order of the NURBS curve. ORDER equals degree + 1,
- hence a cubic curve has an order of 4.
-
-TYPE
- Specifies the type of the curve. If this curve is defined within a
- `gluBeginCurve'/`gluEndCurve' pair, then the type can be any of the
- valid one-dimensional evaluator types (such as `GLU_MAP1_VERTEX_3'
- or `GLU_MAP1_COLOR_4'). Between a `gluBeginTrim'/`gluEndTrim' pair,
- the only valid types are `GLU_MAP1_TRIM_2' and `GLU_MAP1_TRIM_3'.
-
-
-Description
-===========
-
-Use `gluNurbsCurve' to describe a NURBS curve.
-
-When `gluNurbsCurve' appears between a `gluBeginCurve'/`gluEndCurve'
-pair, it is used to describe a curve to be rendered. Positional,
-texture, and color coordinates are associated by presenting each as a
-separate `gluNurbsCurve' between a `gluBeginCurve'/`gluEndCurve' pair.
-No more than one call to `gluNurbsCurve' for each of color, position,
-and texture data can be made within a single
-`gluBeginCurve'/`gluEndCurve' pair. Exactly one call must be made to
-describe the position of the curve (a TYPE of `GLU_MAP1_VERTEX_3' or
-`GLU_MAP1_VERTEX_4').
-
-When `gluNurbsCurve' appears between a `gluBeginTrim'/`gluEndTrim' pair,
-it is used to describe a trimming curve on a NURBS surface. If TYPE is
-`GLU_MAP1_TRIM_2', then it describes a curve in two-dimensional (U and
-V) parameter space. If it is `GLU_MAP1_TRIM_3', then it describes a
-curve in two-dimensional homogeneous (U, V, and W) parameter space. See
-the `gluBeginTrim' reference page for more discussion about trimming
-curves.")
-
-(define-gl-procedure
- gluNurbsProperty
- "gluNurbsProperty"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "gluNurbsProperty"))
- (paramdef "GLUnurbs* " (parameter "nurb"))
- (paramdef "GLenum " (parameter "property"))
- (paramdef "GLfloat " (parameter "value"))))
- "set a NURBS property
-====================
-
-
-Parameters
-==========
-
-NURB
- Specifies the NURBS object (created with `gluNewNurbsRenderer').
-
-PROPERTY
- Specifies the property to be set. Valid values are
- `GLU_SAMPLING_TOLERANCE', `GLU_DISPLAY_MODE', `GLU_CULLING',
- `GLU_AUTO_LOAD_MATRIX', `GLU_PARAMETRIC_TOLERANCE',
- `GLU_SAMPLING_METHOD', `GLU_U_STEP', `GLU_V_STEP', or
- `GLU_NURBS_MODE'.
-
-VALUE
- Specifies the value of the indicated property. It may be a numeric
- value or one of `GLU_OUTLINE_POLYGON', `GLU_FILL',
- `GLU_OUTLINE_PATCH', `GLU_TRUE', `GLU_FALSE', `GLU_PATH_LENGTH',
- `GLU_PARAMETRIC_ERROR', `GLU_DOMAIN_DISTANCE',
- `GLU_NURBS_RENDERER', or `GLU_NURBS_TESSELLATOR'.
-
-
-Description
-===========
-
-`gluNurbsProperty' is used to control properties stored in a NURBS
-object. These properties affect the way that a NURBS curve is rendered.
-The accepted values for PROPERTY are as follows:
-
-`GLU_NURBS_MODE'
- VALUE should be set to be either `GLU_NURBS_RENDERER' or
- `GLU_NURBS_TESSELLATOR'. When set to `GLU_NURBS_RENDERER', NURBS
- objects are tessellated into OpenGL primitives and sent to the
- pipeline for rendering. When set to `GLU_NURBS_TESSELLATOR', NURBS
- objects are tessellated into OpenGL primitives but the vertices,
- normals, colors, and/or textures are retrieved back through a
- callback interface (see `gluNurbsCallback'). This allows the user
- to cache the tessellated results for further processing. The
- initial value is `GLU_NURBS_RENDERER'.
-
-`GLU_SAMPLING_METHOD'
- Specifies how a NURBS surface should be tessellated. VALUE may be
- one of `GLU_PATH_LENGTH', `GLU_PARAMETRIC_ERROR',
- `GLU_DOMAIN_DISTANCE', `GLU_OBJECT_PATH_LENGTH', or
- `GLU_OBJECT_PARAMETRIC_ERROR'. When set to `GLU_PATH_LENGTH', the
- surface is rendered so that the maximum length, in pixels, of the
- edges of the tessellation polygons is no greater than what is
- specified by `GLU_SAMPLING_TOLERANCE'.
-
- `GLU_PARAMETRIC_ERROR' specifies that the surface is rendered in
- such a way that the value specified by `GLU_PARAMETRIC_TOLERANCE'
- describes the maximum distance, in pixels, between the tessellation
- polygons and the surfaces they approximate.
-
- `GLU_DOMAIN_DISTANCE' allows users to specify, in parametric
- coordinates, how many sample points per unit length are taken in U,
- V direction.
-
- `GLU_OBJECT_PATH_LENGTH' is similar to `GLU_PATH_LENGTH' except
- that it is view independent; that is, the surface is rendered so
- that the maximum length, in object space, of edges of the
- tessellation polygons is no greater than what is specified by
- `GLU_SAMPLING_TOLERANCE'.
-
- `GLU_OBJECT_PARAMETRIC_ERROR' is similar to `GLU_PARAMETRIC_ERROR'
- except that it is view independent; that is, the surface is
- rendered in such a way that the value specified by
- `GLU_PARAMETRIC_TOLERANCE' describes the maximum distance, in
- object space, between the tessellation polygons and the surfaces
- they approximate.
-
- The initial value of `GLU_SAMPLING_METHOD' is `GLU_PATH_LENGTH'.
-
-`GLU_SAMPLING_TOLERANCE'
- Specifies the maximum length, in pixels or in object space length
- unit, to use when the sampling method is set to `GLU_PATH_LENGTH'
- or `GLU_OBJECT_PATH_LENGTH'. The NURBS code is conservative when
- rendering a curve or surface, so the actual length can be somewhat
- shorter. The initial value is 50.0 pixels.
-
-`GLU_PARAMETRIC_TOLERANCE'
- Specifies the maximum distance, in pixels or in object space length
- unit, to use when the sampling method is `GLU_PARAMETRIC_ERROR' or
- `GLU_OBJECT_PARAMETRIC_ERROR'. The initial value is 0.5.
-
-`GLU_U_STEP'
- Specifies the number of sample points per unit length taken along
- the U axis in parametric coordinates. It is needed when
- `GLU_SAMPLING_METHOD' is set to `GLU_DOMAIN_DISTANCE'. The initial
- value is 100.
-
-`GLU_V_STEP'
- Specifies the number of sample points per unit length taken along
- the V axis in parametric coordinate. It is needed when
- `GLU_SAMPLING_METHOD' is set to `GLU_DOMAIN_DISTANCE'. The initial
- value is 100.
-
-`GLU_DISPLAY_MODE'
- VALUE can be set to `GLU_OUTLINE_POLYGON', `GLU_FILL', or
- `GLU_OUTLINE_PATCH'. When `GLU_NURBS_MODE' is set to be
- `GLU_NURBS_RENDERER', VALUE defines how a NURBS surface should be
- rendered. When VALUE is set to `GLU_FILL', the surface is rendered
- as a set of polygons. When VALUE is set to `GLU_OUTLINE_POLYGON',
- the NURBS library draws only the outlines of the polygons created
- by tessellation. When VALUE is set to `GLU_OUTLINE_PATCH' just the
- outlines of patches and trim curves defined by the user are drawn.
-
- When `GLU_NURBS_MODE' is set to be `GLU_NURBS_TESSELLATOR', VALUE
- defines how a NURBS surface should be tessellated. When
- `GLU_DISPLAY_MODE' is set to `GLU_FILL' or `GLU_OUTLINE_POLYGON',
- the NURBS surface is tessellated into OpenGL triangle primitives
- that can be retrieved back through callback functions. If
- `GLU_DISPLAY_MODE' is set to `GLU_OUTLINE_PATCH', only the outlines
- of the patches and trim curves are generated as a sequence of line
- strips that can be retrieved back through callback functions.
-
- The initial value is `GLU_FILL'.
-
-`GLU_CULLING'
- VALUE is a boolean value that, when set to `GLU_TRUE', indicates
- that a NURBS curve should be discarded prior to tessellation if its
- control points lie outside the current viewport. The initial value
- is `GLU_FALSE'.
-
-`GLU_AUTO_LOAD_MATRIX'
- VALUE is a boolean value. When set to `GLU_TRUE', the NURBS code
- downloads the projection matrix, the modelview matrix, and the
- viewport from the GL server to compute sampling and culling
- matrices for each NURBS curve that is rendered. Sampling and
- culling matrices are required to determine the tessellation of a
- NURBS surface into line segments or polygons and to cull a NURBS
- surface if it lies outside the viewport.
-
- If this mode is set to `GLU_FALSE', then the program needs to
- provide a projection matrix, a modelview matrix, and a viewport for
- the NURBS renderer to use to construct sampling and culling
- matrices. This can be done with the `gluLoadSamplingMatrices'
- function. This mode is initially set to `GLU_TRUE'. Changing it
- from `GLU_TRUE' to `GLU_FALSE' does not affect the sampling and
- culling matrices until `gluLoadSamplingMatrices' is called.")
-
-(define-gl-procedure
- gluNurbsSurface
- "gluNurbsSurface"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "gluNurbsSurface"))
- (paramdef "GLUnurbs* " (parameter "nurb"))
- (paramdef "GLint " (parameter "sKnotCount"))
- (paramdef "GLfloat* " (parameter "sKnots"))
- (paramdef "GLint " (parameter "tKnotCount"))
- (paramdef "GLfloat* " (parameter "tKnots"))
- (paramdef "GLint " (parameter "sStride"))
- (paramdef "GLint " (parameter "tStride"))
- (paramdef "GLfloat* " (parameter "control"))
- (paramdef "GLint " (parameter "sOrder"))
- (paramdef "GLint " (parameter "tOrder"))
- (paramdef "GLenum " (parameter "type"))))
- "define the shape of a NURBS surface
-===================================
-
-
-Parameters
-==========
-
-NURB
- Specifies the NURBS object (created with `gluNewNurbsRenderer').
-
-SKNOTCOUNT
- Specifies the number of knots in the parametric U direction.
-
-SKNOTS
- Specifies an array of SKNOTCOUNT nondecreasing knot values in the
- parametric U direction.
-
-TKNOTCOUNT
- Specifies the number of knots in the parametric V direction.
-
-TKNOTS
- Specifies an array of TKNOTCOUNT nondecreasing knot values in the
- parametric V direction.
-
-SSTRIDE
- Specifies the offset (as a number of single-precision
- floating-point values) between successive control points in the
- parametric U direction in CONTROL.
-
-TSTRIDE
- Specifies the offset (in single-precision floating-point values)
- between successive control points in the parametric V direction in
- CONTROL.
-
-CONTROL
- Specifies an array containing control points for the NURBS surface.
- The offsets between successive control points in the parametric U
- and V directions are given by SSTRIDE and TSTRIDE.
-
-SORDER
- Specifies the order of the NURBS surface in the parametric U
- direction. The order is one more than the degree, hence a surface
- that is cubic in U has a U order of 4.
-
-TORDER
- Specifies the order of the NURBS surface in the parametric V
- direction. The order is one more than the degree, hence a surface
- that is cubic in V has a V order of 4.
-
-TYPE
- Specifies type of the surface. TYPE can be any of the valid
- two-dimensional evaluator types (such as `GLU_MAP2_VERTEX_3' or
- `GLU_MAP2_COLOR_4').
-
-
-Description
-===========
-
-Use `gluNurbsSurface' within a NURBS (Non-Uniform Rational B-Spline)
-surface definition to describe the shape of a NURBS surface (before any
-trimming). To mark the beginning of a NURBS surface definition, use the
-`gluBeginSurface' command. To mark the end of a NURBS surface
-definition, use the `gluEndSurface' command. Call `gluNurbsSurface'
-within a NURBS surface definition only.
-
-Positional, texture, and color coordinates are associated with a surface
-by presenting each as a separate `gluNurbsSurface' between a
-`gluBeginSurface'/`gluEndSurface' pair. No more than one call to
-`gluNurbsSurface' for each of color, position, and texture data can be
-made within a single `gluBeginSurface'/`gluEndSurface' pair. Exactly one
-call must be made to describe the position of the surface (a TYPE of
-`GLU_MAP2_VERTEX_3' or `GLU_MAP2_VERTEX_4').
-
-A NURBS surface can be trimmed by using the commands `gluNurbsCurve' and
-`gluPwlCurve' between calls to `gluBeginTrim' and `gluEndTrim'.
-
-Note that a `gluNurbsSurface' with SKNOTCOUNT knots in the U direction
-and TKNOTCOUNT knots in the V direction with orders SORDER and TORDER
-must have (SKNOTCOUNT - SORDER) TIMES (TKNOTCOUNT - TORDER) control
-points.")
-
-(define-gl-procedure
- gluOrtho2D
- "gluOrtho2D"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "gluOrtho2D"))
- (paramdef "GLdouble " (parameter "left"))
- (paramdef "GLdouble " (parameter "right"))
- (paramdef "GLdouble " (parameter "bottom"))
- (paramdef "GLdouble " (parameter "top"))))
- "define a 2D orthographic projection matrix
-==========================================
-
-
-Parameters
-==========
-
-LEFT
- RIGHT
-
- Specify the coordinates for the left and right vertical clipping
- planes.
-
-BOTTOM
- TOP
-
- Specify the coordinates for the bottom and top horizontal clipping
- planes.
-
-
-Description
-===========
-
-`gluOrtho2D' sets up a two-dimensional orthographic viewing region. This
-is equivalent to calling `glOrtho' with NEAR=-1 and FAR=1.")
-
-(define-gl-procedure
- gluPartialDisk
- "gluPartialDisk"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "gluPartialDisk"))
- (paramdef "GLUquadric* " (parameter "quad"))
- (paramdef "GLdouble " (parameter "inner"))
- (paramdef "GLdouble " (parameter "outer"))
- (paramdef "GLint " (parameter "slices"))
- (paramdef "GLint " (parameter "loops"))
- (paramdef "GLdouble " (parameter "start"))
- (paramdef "GLdouble " (parameter "sweep"))))
- "draw an arc of a disk
-=====================
-
-
-Parameters
-==========
-
-QUAD
- Specifies a quadrics object (created with `gluNewQuadric').
-
-INNER
- Specifies the inner radius of the partial disk (can be 0).
-
-OUTER
- Specifies the outer radius of the partial disk.
-
-SLICES
- Specifies the number of subdivisions around the Z axis.
-
-LOOPS
- Specifies the number of concentric rings about the origin into
- which the partial disk is subdivided.
-
-START
- Specifies the starting angle, in degrees, of the disk portion.
-
-SWEEP
- Specifies the sweep angle, in degrees, of the disk portion.
-
-
-Description
-===========
-
-`gluPartialDisk' renders a partial disk on the Z=0 plane. A partial disk
-is similar to a full disk, except that only the subset of the disk from
-START through START + SWEEP is included (where 0 degrees is along the
-+\\f2y\\f axis, 90 degrees along the +X axis, 180 degrees along the \\-Y
-axis, and 270 degrees along the \\-X axis).
-
-The partial disk has a radius of OUTER and contains a concentric
-circular hole with a radius of INNER. If INNER is 0, then no hole is
-generated. The partial disk is subdivided around the Z axis into slices
-(like pizza slices) and also about the Z axis into rings (as specified
-by SLICES and LOOPS, respectively).
-
-With respect to orientation, the +Z side of the partial disk is
-considered to be outside (see `gluQuadricOrientation'). This means that
-if the orientation is set to `GLU_OUTSIDE', then any normals generated
-point along the +Z axis. Otherwise, they point along the \\-Z axis.
-
-If texturing is turned on (with `gluQuadricTexture'), texture
-coordinates are generated linearly such that where R=OUTER, the value at
-(R, 0, 0) is (1.0, 0.5), at (0, R, 0) it is (0.5, 1.0), at (\\-R, 0, 0)
-it is (0.0, 0.5), and at (0, \\-R, 0) it is (0.5, 0.0).")
-
-(define-gl-procedure
- gluPerspective
- "gluPerspective"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "gluPerspective"))
- (paramdef "GLdouble " (parameter "fovy"))
- (paramdef "GLdouble " (parameter "aspect"))
- (paramdef "GLdouble " (parameter "zNear"))
- (paramdef "GLdouble " (parameter "zFar"))))
- "set up a perspective projection matrix
-======================================
-
-
-Parameters
-==========
-
-FOVY
- Specifies the field of view angle, in degrees, in the Y direction.
-
-ASPECT
- Specifies the aspect ratio that determines the field of view in the
- X direction. The aspect ratio is the ratio of X (width) to Y
- (height).
-
-ZNEAR
- Specifies the distance from the viewer to the near clipping plane
- (always positive).
-
-ZFAR
- Specifies the distance from the viewer to the far clipping plane
- (always positive).
-
-
-Description
-===========
-
-`gluPerspective' specifies a viewing frustum into the world coordinate
-system. In general, the aspect ratio in `gluPerspective' should match
-the aspect ratio of the associated viewport. For example, ASPECT=2.0
-means the viewer's angle of view is twice as wide in X as it is in Y. If
-the viewport is twice as wide as it is tall, it displays the image
-without distortion.
-
-The matrix generated by `gluPerspective' is multipled by the current
-matrix, just as if `glMultMatrix' were called with the generated matrix.
-To load the perspective matrix onto the current matrix stack instead,
-precede the call to `gluPerspective' with a call to `glLoadIdentity'.
-
-Given F defined as follows:
-
-F=COTANGENT\u2061(FOVY/2,) The generated matrix is
-
-((F/ASPECT 0 0 0), (0 F 0 0), (0 0 ZFAR+ZNEAR,/ZNEAR-ZFAR,
-2×ZFAR×ZNEAR,/ZNEAR-ZFAR,), (0 0 -1 0),)")
-
-(define-gl-procedure
- gluPickMatrix
- "gluPickMatrix"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "gluPickMatrix"))
- (paramdef "GLdouble " (parameter "x"))
- (paramdef "GLdouble " (parameter "y"))
- (paramdef "GLdouble " (parameter "delX"))
- (paramdef "GLdouble " (parameter "delY"))
- (paramdef "GLint * " (parameter "viewport"))))
- "define a picking region
-=======================
-
-
-Parameters
-==========
-
-X
- Y
-
- Specify the center of a picking region in window coordinates.
-
-DELX
- DELY
-
- Specify the width and height, respectively, of the picking region
- in window coordinates.
-
-VIEWPORT
- Specifies the current viewport (as from a `glGetIntegerv' call).
-
-
-Description
-===========
-
-`gluPickMatrix' creates a projection matrix that can be used to restrict
-drawing to a small region of the viewport. This is typically useful to
-determine what objects are being drawn near the cursor. Use
-`gluPickMatrix' to restrict drawing to a small region around the cursor.
-Then, enter selection mode (with `glRenderMode') and rerender the scene.
-All primitives that would have been drawn near the cursor are identified
-and stored in the selection buffer.
-
-The matrix created by `gluPickMatrix' is multiplied by the current
-matrix just as if `glMultMatrix' is called with the generated matrix. To
-effectively use the generated pick matrix for picking, first call
-`glLoadIdentity' to load an identity matrix onto the perspective matrix
-stack. Then call `gluPickMatrix', and, finally, call a command (such as
-`gluPerspective') to multiply the perspective matrix by the pick matrix.
-
-When using `gluPickMatrix' to pick NURBS, be careful to turn off the
-NURBS property `GLU_AUTO_LOAD_MATRIX'. If `GLU_AUTO_LOAD_MATRIX' is not
-turned off, then any NURBS surface rendered is subdivided differently
-with the pick matrix than the way it was subdivided without the pick
-matrix.")
-
-(define-gl-procedure
- gluProject
- "gluProject"
- (funcsynopsis
- (funcprototype
- (funcdef "GLint " (function "gluProject"))
- (paramdef "GLdouble " (parameter "objX"))
- (paramdef "GLdouble " (parameter "objY"))
- (paramdef "GLdouble " (parameter "objZ"))
- (paramdef
- "const GLdouble * "
- (parameter "model"))
- (paramdef "const GLdouble * " (parameter "proj"))
- (paramdef "const GLint * " (parameter "view"))
- (paramdef "GLdouble* " (parameter "winX"))
- (paramdef "GLdouble* " (parameter "winY"))
- (paramdef "GLdouble* " (parameter "winZ"))))
- "map object coordinates to window coordinates
-============================================
-
-
-Parameters
-==========
-
-OBJX
- OBJY
-
- OBJZ
-
- Specify the object coordinates.
-
-MODEL
- Specifies the current modelview matrix (as from a `glGetDoublev'
- call).
-
-PROJ
- Specifies the current projection matrix (as from a `glGetDoublev'
- call).
-
-VIEW
- Specifies the current viewport (as from a `glGetIntegerv' call).
-
-WINX
- WINY
-
- WINZ
-
- Return the computed window coordinates.
-
-
-Description
-===========
-
-`gluProject' transforms the specified object coordinates into window
-coordinates using MODEL, PROJ, and VIEW. The result is stored in WINX,
-WINY, and WINZ. A return value of `GLU_TRUE' indicates success, a return
-value of `GLU_FALSE' indicates failure.
-
-To compute the coordinates, let V=(OBJX,OBJYOBJZ1.0) represented as a
-matrix with 4 rows and 1 column. Then `gluProject' computes V^″ as
-follows:
-
-V^″=P×M×V
-
-where P is the current projection matrix PROJ and M is the current
-modelview matrix MODEL (both represented as 4×4 matrices in column-major
-order).
-
-The window coordinates are then computed as follows:
-
-WINX=VIEW\u2061(0,)+VIEW\u2061(2,)×(V^″\u2061(0,)+1,)/2WINY=VIEW\u2061(1,)+VIEW\u2061(3,)×(V^″\u2061(1
-,)+1,)/2 WINZ=(V^″\u2061(2,)+1,)/2")
-
-(define-gl-procedure
- gluPwlCurve
- "gluPwlCurve"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "gluPwlCurve"))
- (paramdef "GLUnurbs* " (parameter "nurb"))
- (paramdef "GLint " (parameter "count"))
- (paramdef "GLfloat* " (parameter "data"))
- (paramdef "GLint " (parameter "stride"))
- (paramdef "GLenum " (parameter "type"))))
- "describe a piecewise linear NURBS trimming curve
-================================================
-
-
-Parameters
-==========
-
-NURB
- Specifies the NURBS object (created with `gluNewNurbsRenderer').
-
-COUNT
- Specifies the number of points on the curve.
-
-DATA
- Specifies an array containing the curve points.
-
-STRIDE
- Specifies the offset (a number of single-precision floating-point
- values) between points on the curve.
-
-TYPE
- Specifies the type of curve. Must be either `GLU_MAP1_TRIM_2' or
- `GLU_MAP1_TRIM_3'.
-
-
-Description
-===========
-
-`gluPwlCurve' describes a piecewise linear trimming curve for a NURBS
-surface. A piecewise linear curve consists of a list of coordinates of
-points in the parameter space for the NURBS surface to be trimmed. These
-points are connected with line segments to form a curve. If the curve is
-an approximation to a curve that is not piecewise linear, the points
-should be close enough in parameter space that the resulting path
-appears curved at the resolution used in the application.
-
-If TYPE is `GLU_MAP1_TRIM_2', then it describes a curve in
-two-dimensional (U and V) parameter space. If it is `GLU_MAP1_TRIM_3',
-then it describes a curve in two-dimensional homogeneous (U, V, and W)
-parameter space. See the `gluBeginTrim' reference page for more
-information about trimming curves.")
-
-(define-gl-procedure
- gluQuadricCallback
- "gluQuadricCallback"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "gluQuadricCallback"))
- (paramdef "GLUquadric* " (parameter "quad"))
- (paramdef "GLenum " (parameter "which"))
- (paramdef
- "_GLUfuncptr "
- (parameter "CallBackFunc"))))
- "define a callback for a quadrics object
-=======================================
-
-
-Parameters
-==========
-
-QUAD
- Specifies the quadrics object (created with `gluNewQuadric').
-
-WHICH
- Specifies the callback being defined. The only valid value is
- `GLU_ERROR'.
-
-CALLBACKFUNC
- Specifies the function to be called.
-
-
-Description
-===========
-
-`gluQuadricCallback' is used to define a new callback to be used by a
-quadrics object. If the specified callback is already defined, then it
-is replaced. If CALLBACKFUNC is NULL, then any existing callback is
-erased.
-
-The one legal callback is `GLU_ERROR':
-
-`GLU_ERROR'
- The function is called when an error is encountered. Its single
- argument is of type GLenum, and it indicates the specific error
- that occurred. Character strings describing these errors can be
- retrieved with the `gluErrorString' call.")
-
-(define-gl-procedure
- gluQuadricDrawStyle
- "gluQuadricDrawStyle"
- (funcsynopsis
- (funcprototype
- (funcdef
- "void "
- (function "gluQuadricDrawStyle"))
- (paramdef "GLUquadric* " (parameter "quad"))
- (paramdef "GLenum " (parameter "draw"))))
- "specify the draw style desired for quadrics
-===========================================
-
-
-Parameters
-==========
-
-QUAD
- Specifies the quadrics object (created with `gluNewQuadric').
-
-DRAW
- Specifies the desired draw style. Valid values are `GLU_FILL',
- `GLU_LINE', `GLU_SILHOUETTE', and `GLU_POINT'.
-
-
-Description
-===========
-
-`gluQuadricDrawStyle' specifies the draw style for quadrics rendered
-with QUAD. The legal values are as follows:
-
-`GLU_FILL'
- Quadrics are rendered with polygon primitives. The polygons are
- drawn in a counterclockwise fashion with respect to their normals
- (as defined with `gluQuadricOrientation').
-
-`GLU_LINE'
- Quadrics are rendered as a set of lines.
-
-`GLU_SILHOUETTE'
- Quadrics are rendered as a set of lines, except that edges
- separating coplanar faces will not be drawn.
-
-`GLU_POINT'
- Quadrics are rendered as a set of points.")
-
-(define-gl-procedure
- gluQuadricNormals
- "gluQuadricNormals"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "gluQuadricNormals"))
- (paramdef "GLUquadric* " (parameter "quad"))
- (paramdef "GLenum " (parameter "normal"))))
- "specify what kind of normals are desired for quadrics
-=====================================================
-
-
-Parameters
-==========
-
-QUAD
- Specifies the quadrics object (created with `gluNewQuadric').
-
-NORMAL
- Specifies the desired type of normals. Valid values are `GLU_NONE',
- `GLU_FLAT', and `GLU_SMOOTH'.
-
-
-Description
-===========
-
-`gluQuadricNormals' specifies what kind of normals are desired for
-quadrics rendered with QUAD. The legal values are as follows:
-
-`GLU_NONE'
- No normals are generated.
-
-`GLU_FLAT'
- One normal is generated for every facet of a quadric.
-
-`GLU_SMOOTH'
- One normal is generated for every vertex of a quadric. This is the
- initial value.")
-
-(define-gl-procedure
- gluQuadricOrientation
- "gluQuadricOrientation"
- (funcsynopsis
- (funcprototype
- (funcdef
- "void "
- (function "gluQuadricOrientation"))
- (paramdef "GLUquadric* " (parameter "quad"))
- (paramdef "GLenum " (parameter "orientation"))))
- "specify inside/outside orientation for quadrics
-===============================================
-
-
-Parameters
-==========
-
-QUAD
- Specifies the quadrics object (created with `gluNewQuadric').
-
-ORIENTATION
- Specifies the desired orientation. Valid values are `GLU_OUTSIDE'
- and `GLU_INSIDE'.
-
-
-Description
-===========
-
-`gluQuadricOrientation' specifies what kind of orientation is desired
-for quadrics rendered with QUAD. The ORIENTATION values are as follows:
-
-`GLU_OUTSIDE'
- Quadrics are drawn with normals pointing outward (the initial
- value).
-
-`GLU_INSIDE'
- Quadrics are drawn with normals pointing inward.
-
-Note that the interpretation of OUTWARD and INWARD depends on the
-quadric being drawn.")
-
-(define-gl-procedure
- gluQuadricTexture
- "gluQuadricTexture"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "gluQuadricTexture"))
- (paramdef "GLUquadric* " (parameter "quad"))
- (paramdef "GLboolean " (parameter "texture"))))
- "specify if texturing is desired for quadrics
-============================================
-
-
-Parameters
-==========
-
-QUAD
- Specifies the quadrics object (created with `gluNewQuadric').
-
-TEXTURE
- Specifies a flag indicating if texture coordinates should be
- generated.
-
-
-Description
-===========
-
-`gluQuadricTexture' specifies if texture coordinates should be generated
-for quadrics rendered with QUAD. If the value of TEXTURE is `GLU_TRUE',
-then texture coordinates are generated, and if TEXTURE is `GLU_FALSE',
-they are not. The initial value is `GLU_FALSE'.
-
-The manner in which texture coordinates are generated depends upon the
-specific quadric rendered.")
-
-(define-gl-procedure
- gluScaleImage
- "gluScaleImage"
- (funcsynopsis
- (funcprototype
- (funcdef "GLint " (function "gluScaleImage"))
- (paramdef "GLenum " (parameter "format"))
- (paramdef "GLsizei " (parameter "wIn"))
- (paramdef "GLsizei " (parameter "hIn"))
- (paramdef "GLenum " (parameter "typeIn"))
- (paramdef "const void * " (parameter "dataIn"))
- (paramdef "GLsizei " (parameter "wOut"))
- (paramdef "GLsizei " (parameter "hOut"))
- (paramdef "GLenum " (parameter "typeOut"))
- (paramdef "GLvoid* " (parameter "dataOut"))))
- "scale an image to an arbitrary size
-===================================
-
-
-Parameters
-==========
-
-FORMAT
- Specifies the format of the pixel data. The following symbolic
- values are valid: `GLU_COLOR_INDEX', `GLU_STENCIL_INDEX',
- `GLU_DEPTH_COMPONENT', `GLU_RED', `GLU_GREEN', `GLU_BLUE',
- `GLU_ALPHA', `GLU_RGB', `GLU_RGBA', `GLU_BGR', `GLU_BGRA',
- `GLU_LUMINANCE', and `GLU_LUMINANCE_ALPHA'.
-
-WIN
- HIN
-
- Specify in pixels the width and height, respectively, of the source
- image.
-
-TYPEIN
- Specifies the data type for DATAIN. Must be one of
- `GLU_UNSIGNED_BYTE', `GLU_BYTE', `GLU_BITMAP',
- `GLU_UNSIGNED_SHORT', `GLU_SHORT', `GLU_UNSIGNED_INT', `GLU_INT',
- `GLU_FLOAT', `GLU_UNSIGNED_BYTE_3_3_2',
- `GLU_UNSIGNED_BYTE_2_3_3_REV', `GLU_UNSIGNED_SHORT_5_6_5',
- `GLU_UNSIGNED_SHORT_5_6_5_REV', `GLU_UNSIGNED_SHORT_4_4_4_4',
- `GLU_UNSIGNED_SHORT_4_4_4_4_REV', `GLU_UNSIGNED_SHORT_5_5_5_1',
- `GLU_UNSIGNED_SHORT_1_5_5_5_REV', `GLU_UNSIGNED_INT_8_8_8_8',
- `GLU_UNSIGNED_INT_8_8_8_8_REV', `GLU_UNSIGNED_INT_10_10_10_2', or
- `GLU_UNSIGNED_INT_2_10_10_10_REV'.
-
-DATAIN
- Specifies a pointer to the source image.
-
-WOUT
- HOUT
-
- Specify the width and height, respectively, in pixels of the
- destination image.
-
-TYPEOUT
- Specifies the data type for DATAOUT. Must be one of
- `GLU_UNSIGNED_BYTE', `GLU_BYTE', `GLU_BITMAP',
- `GLU_UNSIGNED_SHORT', `GLU_SHORT', `GLU_UNSIGNED_INT', `GLU_INT',
- `GLU_FLOAT', `GLU_UNSIGNED_BYTE_3_3_2',
- `GLU_UNSIGNED_BYTE_2_3_3_REV', `GLU_UNSIGNED_SHORT_5_6_5',
- `GLU_UNSIGNED_SHORT_5_6_5_REV', `GLU_UNSIGNED_SHORT_4_4_4_4',
- `GLU_UNSIGNED_SHORT_4_4_4_4_REV', `GLU_UNSIGNED_SHORT_5_5_5_1',
- `GLU_UNSIGNED_SHORT_1_5_5_5_REV', `GLU_UNSIGNED_INT_8_8_8_8',
- `GLU_UNSIGNED_INT_8_8_8_8_REV', `GLU_UNSIGNED_INT_10_10_10_2', or
- `GLU_UNSIGNED_INT_2_10_10_10_REV'.
-
-DATAOUT
- Specifies a pointer to the destination image.
-
-
-Description
-===========
-
-`gluScaleImage' scales a pixel image using the appropriate pixel store
-modes to unpack data from the source image and pack data into the
-destination image.
-
-When shrinking an image, `gluScaleImage' uses a box filter to sample the
-source image and create pixels for the destination image. When
-magnifying an image, the pixels from the source image are linearly
-interpolated to create the destination image.
-
-A return value of zero indicates success, otherwise a GLU error code is
-returned (see `gluErrorString').
-
-See the `glReadPixels' reference page for a description of the
-acceptable values for the FORMAT, TYPEIN, and TYPEOUT parameters.
-
-
-Errors
-======
-
-`GLU_INVALID_VALUE' is returned if WIN, HIN, WOUT, or HOUT is negative.
-
-`GLU_INVALID_ENUM' is returned if FORMAT, TYPEIN, or TYPEOUT is not
-legal.
-
-`GLU_INVALID_OPERATION' is returned if TYPEIN or TYPEOUT is
-`GLU_UNSIGNED_BYTE_3_3_2' or `GLU_UNSIGNED_BYTE_2_3_3_REV' and FORMAT is
-not `GLU_RGB'.
-
-`GLU_INVALID_OPERATION' is returned if TYPEIN or TYPEOUT is
-`GLU_UNSIGNED_SHORT_5_6_5' or `GLU_UNSIGNED_SHORT_5_6_5_REV' and FORMAT
-is not `GLU_RGB'.
-
-`GLU_INVALID_OPERATION' is returned if TYPEIN or TYPEOUT is
-`GLU_UNSIGNED_SHORT_4_4_4_4' or `GLU_UNSIGNED_SHORT_4_4_4_4_REV' and
-FORMAT is neither `GLU_RGBA' nor `GLU_BGRA'.
-
-`GLU_INVALID_OPERATION' is returned if TYPEIN or TYPEOUT is
-`GLU_UNSIGNED_SHORT_5_5_5_1' or `GLU_UNSIGNED_SHORT_1_5_5_5_REV' and
-FORMAT is neither `GLU_RGBA' nor `GLU_BGRA'.
-
-`GLU_INVALID_OPERATION' is returned if TYPEIN or TYPEOUT is
-`GLU_UNSIGNED_INT_8_8_8_8' or `GLU_UNSIGNED_INT_8_8_8_8_REV' and FORMAT
-is neither `GLU_RGBA' nor `GLU_BGRA'.
-
-`GLU_INVALID_OPERATION' is returned if TYPEIN or TYPEOUT is
-`GLU_UNSIGNED_INT_10_10_10_2' or `GLU_UNSIGNED_INT_2_10_10_10_REV' and
-FORMAT is neither `GLU_RGBA' nor `GLU_BGRA'.")
-
-(define-gl-procedure
- glUseProgram
- "glUseProgram"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glUseProgram"))
- (paramdef "GLuint " (parameter "program"))))
- "Installs a program object as part of current rendering state
-============================================================
-
-
-Parameters
-==========
-
-PROGRAM
- Specifies the handle of the program object whose executables are to
- be used as part of current rendering state.
-
-
-Description
-===========
-
-`glUseProgram' installs the program object specified by PROGRAM as part
-of current rendering state. One or more executables are created in a
-program object by successfully attaching shader objects to it with
-`glAttachShader', successfully compiling the shader objects with
-`glCompileShader', and successfully linking the program object with
-`glLinkProgram'.
-
-A program object will contain an executable that will run on the vertex
-processor if it contains one or more shader objects of type
-`GL_VERTEX_SHADER' that have been successfully compiled and linked.
-Similarly, a program object will contain an executable that will run on
-the fragment processor if it contains one or more shader objects of type
-`GL_FRAGMENT_SHADER' that have been successfully compiled and linked.
-
-Successfully installing an executable on a programmable processor will
-cause the corresponding fixed functionality of OpenGL to be disabled.
-Specifically, if an executable is installed on the vertex processor, the
-OpenGL fixed functionality will be disabled as follows.
-
- * The projection matrix is not applied to vertex coordinates.
-
- * The texture matrices are not applied to texture coordinates.
-
- * Normals are not transformed to eye coordinates.
-
- * Normals are not rescaled or normalized.
-
- * Normalization of `GL_AUTO_NORMAL' evaluated normals is not
- performed.
-
- * Texture coordinates are not generated automatically.
-
- * Per-vertex lighting is not performed.
-
- * Color material computations are not performed.
-
- * Color index lighting is not performed.
-
- * This list also applies when setting the current raster position.
-
-The executable that is installed on the vertex processor is expected to
-implement any or all of the desired functionality from the preceding
-list. Similarly, if an executable is installed on the fragment
-processor, the OpenGL fixed functionality will be disabled as follows.
-
- * Texture application is not applied.
-
- * Color sum is not applied.
-
- * Fog is not applied.
-
-Again, the fragment shader that is installed is expected to implement
-any or all of the desired functionality from the preceding list.
-
-While a program object is in use, applications are free to modify
-attached shader objects, compile attached shader objects, attach
-additional shader objects, and detach or delete shader objects. None of
-these operations will affect the executables that are part of the
-current state. However, relinking the program object that is currently
-in use will install the program object as part of the current rendering
-state if the link operation was successful (see `glLinkProgram' ). If
-the program object currently in use is relinked unsuccessfully, its link
-status will be set to `GL_FALSE', but the executables and associated
-state will remain part of the current state until a subsequent call to
-`glUseProgram' removes it from use. After it is removed from use, it
-cannot be made part of current state until it has been successfully
-relinked.
-
-If PROGRAM contains shader objects of type `GL_VERTEX_SHADER' but it
-does not contain shader objects of type `GL_FRAGMENT_SHADER', an
-executable will be installed on the vertex processor, but fixed
-functionality will be used for fragment processing. Similarly, if
-PROGRAM contains shader objects of type `GL_FRAGMENT_SHADER' but it does
-not contain shader objects of type `GL_VERTEX_SHADER', an executable
-will be installed on the fragment processor, but fixed functionality
-will be used for vertex processing. If PROGRAM is 0, the programmable
-processors will be disabled, and fixed functionality will be used for
-both vertex and fragment processing.
-
-
-Errors
-======
-
-`GL_INVALID_VALUE' is generated if PROGRAM is neither 0 nor a value
-generated by OpenGL.
-
-`GL_INVALID_OPERATION' is generated if PROGRAM is not a program object.
-
-`GL_INVALID_OPERATION' is generated if PROGRAM could not be made part of
-current state.
-
-`GL_INVALID_OPERATION' is generated if `glUseProgram' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- gluSphere
- "gluSphere"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "gluSphere"))
- (paramdef "GLUquadric* " (parameter "quad"))
- (paramdef "GLdouble " (parameter "radius"))
- (paramdef "GLint " (parameter "slices"))
- (paramdef "GLint " (parameter "stacks"))))
- "draw a sphere
-=============
-
-
-Parameters
-==========
-
-QUAD
- Specifies the quadrics object (created with `gluNewQuadric').
-
-RADIUS
- Specifies the radius of the sphere.
-
-SLICES
- Specifies the number of subdivisions around the Z axis (similar to
- lines of longitude).
-
-STACKS
- Specifies the number of subdivisions along the Z axis (similar to
- lines of latitude).
-
-
-Description
-===========
-
-`gluSphere' draws a sphere of the given radius centered around the
-origin. The sphere is subdivided around the Z axis into slices and along
-the Z axis into stacks (similar to lines of longitude and latitude).
-
-If the orientation is set to `GLU_OUTSIDE' (with
-`gluQuadricOrientation'), then any normals generated point away from the
-center of the sphere. Otherwise, they point toward the center of the
-sphere.
-
-If texturing is turned on (with `gluQuadricTexture'), then texture
-coordinates are generated so that T ranges from 0.0 at Z=-RADIUS to 1.0
-at Z=RADIUS (T increases linearly along longitudinal lines), and S
-ranges from 0.0 at the +Y axis, to 0.25 at the +X axis, to 0.5 at the
-\\-Y axis, to 0.75 at the \\-X axis, and back to 1.0 at the +Y axis.")
-
-(define-gl-procedure
- gluTessBeginContour
- "gluTessBeginContour"
- (funcsynopsis
- (funcprototype
- (funcdef
- "void "
- (function "gluTessBeginContour"))
- (paramdef "GLUtesselator* " (parameter "tess"))))
- "delimit a contour description
-=============================
-
-
-Parameters
-==========
-
-TESS
- Specifies the tessellation object (created with `gluNewTess').
-
-
-Description
-===========
-
-`gluTessBeginContour' and `gluTessEndContour' delimit the definition of
-a polygon contour. Within each `gluTessBeginContour'/`gluTessEndContour'
-pair, there can be zero or more calls to `gluTessVertex'. The vertices
-specify a closed contour (the last vertex of each contour is
-automatically linked to the first). See the `gluTessVertex' reference
-page for more details. `gluTessBeginContour' can only be called between
-`gluTessBeginPolygon' and `gluTessEndPolygon'.")
-
-(define-gl-procedure
- gluTessBeginPolygon
- "gluTessBeginPolygon"
- (funcsynopsis
- (funcprototype
- (funcdef
- "void "
- (function "gluTessBeginPolygon"))
- (paramdef "GLUtesselator* " (parameter "tess"))
- (paramdef "GLvoid* " (parameter "data"))))
- "delimit a polygon description
-=============================
-
-
-Parameters
-==========
-
-TESS
- Specifies the tessellation object (created with `gluNewTess').
-
-DATA
- Specifies a pointer to user polygon data.
-
-
-Description
-===========
-
-`gluTessBeginPolygon' and `gluTessEndPolygon' delimit the definition of
-a convex, concave or self-intersecting polygon. Within each
-`gluTessBeginPolygon'/`gluTessEndPolygon' pair, there must be one or
-more calls to `gluTessBeginContour'/`gluTessEndContour'. Within each
-contour, there are zero or more calls to `gluTessVertex'. The vertices
-specify a closed contour (the last vertex of each contour is
-automatically linked to the first). See the `gluTessVertex',
-`gluTessBeginContour', and `gluTessEndContour' reference pages for more
-details.
-
-DATA is a pointer to a user-defined data structure. If the appropriate
-callback(s) are specified (see `gluTessCallback'), then this pointer is
-returned to the callback function(s). Thus, it is a convenient way to
-store per-polygon information.
-
-Once `gluTessEndPolygon' is called, the polygon is tessellated, and the
-resulting triangles are described through callbacks. See
-`gluTessCallback' for descriptions of the callback functions.")
-
-(define-gl-procedure
- gluTessCallback
- "gluTessCallback"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "gluTessCallback"))
- (paramdef "GLUtesselator* " (parameter "tess"))
- (paramdef "GLenum " (parameter "which"))
- (paramdef
- "_GLUfuncptr "
- (parameter "CallBackFunc"))))
- "define a callback for a tessellation object
-===========================================
-
-
-Parameters
-==========
-
-TESS
- Specifies the tessellation object (created with `gluNewTess').
-
-WHICH
- Specifies the callback being defined. The following values are
- valid: `GLU_TESS_BEGIN', `GLU_TESS_BEGIN_DATA',
- `GLU_TESS_EDGE_FLAG', `GLU_TESS_EDGE_FLAG_DATA', `GLU_TESS_VERTEX',
- `GLU_TESS_VERTEX_DATA', `GLU_TESS_END', `GLU_TESS_END_DATA',
- `GLU_TESS_COMBINE', `GLU_TESS_COMBINE_DATA', `GLU_TESS_ERROR', and
- `GLU_TESS_ERROR_DATA'.
-
-CALLBACKFUNC
- Specifies the function to be called.
-
-
-Description
-===========
-
-`gluTessCallback' is used to indicate a callback to be used by a
-tessellation object. If the specified callback is already defined, then
-it is replaced. If CALLBACKFUNC is NULL, then the existing callback
-becomes undefined.
-
-These callbacks are used by the tessellation object to describe how a
-polygon specified by the user is broken into triangles. Note that there
-are two versions of each callback: one with user-specified polygon data
-and one without. If both versions of a particular callback are
-specified, then the callback with user-specified polygon data will be
-used. Note that the POLYGON_DATA parameter used by some of the functions
-is a copy of the pointer that was specified when `gluTessBeginPolygon'
-was called. The legal callbacks are as follows:
-
-`GLU_TESS_BEGIN'
- The begin callback is invoked like `glBegin' to indicate the start
- of a (triangle) primitive. The function takes a single argument of
- type GLenum. If the `GLU_TESS_BOUNDARY_ONLY' property is set to
- `GLU_FALSE', then the argument is set to either `GLU_TRIANGLE_FAN',
- `GLU_TRIANGLE_STRIP', or `GLU_TRIANGLES'. If the
- `GLU_TESS_BOUNDARY_ONLY' property is set to `GLU_TRUE', then the
- argument will be set to `GLU_LINE_LOOP'. The function prototype for
- this callback is: void begin( GLenum type );
-
-`GLU_TESS_BEGIN_DATA'
- The same as the `GLU_TESS_BEGIN' callback except that it takes an
- additional pointer argument. This pointer is identical to the
- opaque pointer provided when `gluTessBeginPolygon' was called. The
- function prototype for this callback is: void beginData( GLenum
- type, void *polygon_data );
-
-`GLU_TESS_EDGE_FLAG'
- The edge flag callback is similar to `glEdgeFlag'. The function
- takes a single boolean flag that indicates which edges lie on the
- polygon boundary. If the flag is `GLU_TRUE', then each vertex that
- follows begins an edge that lies on the polygon boundary, that is,
- an edge that separates an interior region from an exterior one. If
- the flag is `GLU_FALSE', then each vertex that follows begins an
- edge that lies in the polygon interior. The edge flag callback (if
- defined) is invoked before the first vertex callback.
-
- Since triangle fans and triangle strips do not support edge flags,
- the begin callback is not called with `GLU_TRIANGLE_FAN' or
- `GLU_TRIANGLE_STRIP' if a non-NULL edge flag callback is provided.
- (If the callback is initialized to NULL, there is no impact on
- performance). Instead, the fans and strips are converted to
- independent triangles. The function prototype for this callback is:
- void edgeFlag( GLboolean flag );
-
-`GLU_TESS_EDGE_FLAG_DATA'
- The same as the `GLU_TESS_EDGE_FLAG' callback except that it takes
- an additional pointer argument. This pointer is identical to the
- opaque pointer provided when `gluTessBeginPolygon' was called. The
- function prototype for this callback is: void edgeFlagData(
- GLboolean flag, void *polygon_data );
-
-`GLU_TESS_VERTEX'
- The vertex callback is invoked between the begin and end callbacks.
- It is similar to `glVertex', and it defines the vertices of the
- triangles created by the tessellation process. The function takes a
- pointer as its only argument. This pointer is identical to the
- opaque pointer provided by the user when the vertex was described
- (see `gluTessVertex'). The function prototype for this callback is:
- void vertex( void *vertex_data );
-
-`GLU_TESS_VERTEX_DATA'
- The same as the `GLU_TESS_VERTEX' callback except that it takes an
- additional pointer argument. This pointer is identical to the
- opaque pointer provided when `gluTessBeginPolygon' was called. The
- function prototype for this callback is: void vertexData( void
- *vertex_data, void *polygon_data );
-
-`GLU_TESS_END'
- The end callback serves the same purpose as `glEnd'. It indicates
- the end of a primitive and it takes no arguments. The function
- prototype for this callback is: void end( void );
-
-`GLU_TESS_END_DATA'
- The same as the `GLU_TESS_END' callback except that it takes an
- additional pointer argument. This pointer is identical to the
- opaque pointer provided when `gluTessBeginPolygon' was called. The
- function prototype for this callback is: void endData( void
- *polygon_data );
-
-`GLU_TESS_COMBINE'
- The combine callback is called to create a new vertex when the
- tessellation detects an intersection or wishes to merge features.
- The function takes four arguments: an array of three elements each
- of type GLdouble, an array of four pointers, an array of four
- elements each of type GLfloat, and a pointer to a pointer. The
- prototype is: void combine( GLdouble coords[3], void
- *vertex_data[4], GLfloat weight[4], void **outData );
-
- The vertex is defined as a linear combination of up to four
- existing vertices, stored in VERTEX_DATA. The coefficients of the
- linear combination are given by WEIGHT; these weights always add up
- to 1. All vertex pointers are valid even when some of the weights
- are 0. COORDS gives the location of the new vertex.
-
- The user must allocate another vertex, interpolate parameters using
- VERTEX_DATA and WEIGHT, and return the new vertex pointer in
- OUTDATA. This handle is supplied during rendering callbacks. The
- user is responsible for freeing the memory some time after
- `gluTessEndPolygon' is called.
-
- For example, if the polygon lies in an arbitrary plane in 3-space,
- and a color is associated with each vertex, the `GLU_TESS_COMBINE'
- callback might look like this: void myCombine( GLdouble coords[3],
- VERTEX *d[4], GLfloat w[4], VERTEX **dataOut ) { VERTEX *new =
- new_vertex(); new->x = coords[0]; new->y = coords[1]; new->z =
- coords[2]; new->r = w[0]*d[0]->r + w[1]*d[1]->r + w[2]*d[2]->r +
- w[3]*d[3]->r; new->g = w[0]*d[0]->g + w[1]*d[1]->g + w[2]*d[2]->g +
- w[3]*d[3]->g; new->b = w[0]*d[0]->b + w[1]*d[1]->b + w[2]*d[2]->b +
- w[3]*d[3]->b; new->a = w[0]*d[0]->a + w[1]*d[1]->a + w[2]*d[2]->a +
- w[3]*d[3]->a; *dataOut = new; }
-
- If the tessellation detects an intersection, then the
- `GLU_TESS_COMBINE' or `GLU_TESS_COMBINE_DATA' callback (see below)
- must be defined, and it must write a non-NULL pointer into DATAOUT.
- Otherwise the `GLU_TESS_NEED_COMBINE_CALLBACK' error occurs, and no
- output is generated.
-
-`GLU_TESS_COMBINE_DATA'
- The same as the `GLU_TESS_COMBINE' callback except that it takes an
- additional pointer argument. This pointer is identical to the
- opaque pointer provided when `gluTessBeginPolygon' was called. The
- function prototype for this callback is: void combineData( GLdouble
- coords[3], void *vertex_data[4], GLfloat weight[4], void **outData,
- void *polygon_data );
-
-`GLU_TESS_ERROR'
- The error callback is called when an error is encountered. The one
- argument is of type GLenum; it indicates the specific error that
- occurred and will be set to one of
- `GLU_TESS_MISSING_BEGIN_POLYGON', `GLU_TESS_MISSING_END_POLYGON',
- `GLU_TESS_MISSING_BEGIN_CONTOUR', `GLU_TESS_MISSING_END_CONTOUR',
- `GLU_TESS_COORD_TOO_LARGE', `GLU_TESS_NEED_COMBINE_CALLBACK', or
- `GLU_OUT_OF_MEMORY'. Character strings describing these errors can
- be retrieved with the `gluErrorString' call. The function prototype
- for this callback is: void error( GLenum errno );
-
- The GLU library will recover from the first four errors by
- inserting the missing call(s). `GLU_TESS_COORD_TOO_LARGE' indicates
- that some vertex coordinate exceeded the predefined constant
- `GLU_TESS_MAX_COORD' in absolute value, and that the value has been
- clamped. (Coordinate values must be small enough so that two can be
- multiplied together without overflow.)
- `GLU_TESS_NEED_COMBINE_CALLBACK' indicates that the tessellation
- detected an intersection between two edges in the input data, and
- the `GLU_TESS_COMBINE' or `GLU_TESS_COMBINE_DATA' callback was not
- provided. No output is generated. `GLU_OUT_OF_MEMORY' indicates
- that there is not enough memory so no output is generated.
-
-`GLU_TESS_ERROR_DATA'
- The same as the `GLU_TESS_ERROR' callback except that it takes an
- additional pointer argument. This pointer is identical to the
- opaque pointer provided when `gluTessBeginPolygon' was called. The
- function prototype for this callback is: void errorData( GLenum
- errno, void *polygon_data );")
-
-(define-gl-procedure
- gluTessEndPolygon
- "gluTessEndPolygon"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "gluTessEndPolygon"))
- (paramdef "GLUtesselator* " (parameter "tess"))))
- "delimit a polygon description
-=============================
-
-
-Parameters
-==========
-
-TESS
- Specifies the tessellation object (created with `gluNewTess').
-
-
-Description
-===========
-
-`gluTessBeginPolygon' and `gluTessEndPolygon' delimit the definition of
-a convex, concave, or self-intersecting polygon. Within each
-`gluTessBeginPolygon'/`gluTessEndPolygon' pair, there must be one or
-more calls to `gluTessBeginContour'/`gluTessEndContour'. Within each
-contour, there are zero or more calls to `gluTessVertex'. The vertices
-specify a closed contour (the last vertex of each contour is
-automatically linked to the first). See the `gluTessVertex',
-`gluTessBeginContour', and `gluTessEndContour' reference pages for more
-details.
-
-Once `gluTessEndPolygon' is called, the polygon is tessellated, and the
-resulting triangles are described through callbacks. See
-`gluTessCallback' for descriptions of the callback functions.")
-
-(define-gl-procedure
- gluTessNormal
- "gluTessNormal"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "gluTessNormal"))
- (paramdef "GLUtesselator* " (parameter "tess"))
- (paramdef "GLdouble " (parameter "valueX"))
- (paramdef "GLdouble " (parameter "valueY"))
- (paramdef "GLdouble " (parameter "valueZ"))))
- "specify a normal for a polygon
-==============================
-
-
-Parameters
-==========
-
-TESS
- Specifies the tessellation object (created with `gluNewTess').
-
-VALUEX
- Specifies the first component of the normal.
-
-VALUEY
- Specifies the second component of the normal.
-
-VALUEZ
- Specifies the third component of the normal.
-
-
-Description
-===========
-
-`gluTessNormal' describes a normal for a polygon that the program is
-defining. All input data will be projected onto a plane perpendicular to
-one of the three coordinate axes before tessellation and all output
-triangles will be oriented CCW with respect to the normal (CW
-orientation can be obtained by reversing the sign of the supplied
-normal). For example, if you know that all polygons lie in the x-y
-plane, call `gluTessNormal'(tess, 0.0, 0.0, 1.0) before rendering any
-polygons.
-
-If the supplied normal is (0.0, 0.0, 0.0) (the initial value), the
-normal is determined as follows. The direction of the normal, up to its
-sign, is found by fitting a plane to the vertices, without regard to how
-the vertices are connected. It is expected that the input data lies
-approximately in the plane; otherwise, projection perpendicular to one
-of the three coordinate axes may substantially change the geometry. The
-sign of the normal is chosen so that the sum of the signed areas of all
-input contours is nonnegative (where a CCW contour has positive area).
-
-The supplied normal persists until it is changed by another call to
-`gluTessNormal'.")
-
-(define-gl-procedure
- gluTessProperty
- "gluTessProperty"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "gluTessProperty"))
- (paramdef "GLUtesselator* " (parameter "tess"))
- (paramdef "GLenum " (parameter "which"))
- (paramdef "GLdouble " (parameter "data"))))
- "set a tessellation object property
-==================================
-
-
-Parameters
-==========
-
-TESS
- Specifies the tessellation object (created with `gluNewTess').
-
-WHICH
- Specifies the property to be set. Valid values are
- `GLU_TESS_WINDING_RULE', `GLU_TESS_BOUNDARY_ONLY', and
- `GLU_TESS_TOLERANCE'.
-
-DATA
- Specifies the value of the indicated property.
-
-
-Description
-===========
-
-`gluTessProperty' is used to control properties stored in a tessellation
-object. These properties affect the way that the polygons are
-interpreted and rendered. The legal values for WHICH are as follows:
-
-`GLU_TESS_WINDING_RULE'
- Determines which parts of the polygon are on the ``interior''. DATA
- may be set to one of `GLU_TESS_WINDING_ODD',
- `GLU_TESS_WINDING_NONZERO', `GLU_TESS_WINDING_POSITIVE',
- `GLU_TESS_WINDING_NEGATIVE', or `GLU_TESS_WINDING_ABS_GEQ_TWO'.
-
- To understand how the winding rule works, consider that the input
- contours partition the plane into regions. The winding rule
- determines which of these regions are inside the polygon.
-
- For a single contour C, the winding number of a point x is simply
- the signed number of revolutions we make around x as we travel once
- around C (where CCW is positive). When there are several contours,
- the individual winding numbers are summed. This procedure
- associates a signed integer value with each point x in the plane.
- Note that the winding number is the same for all points in a single
- region.
-
- The winding rule classifies a region as ``inside'' if its winding
- number belongs to the chosen category (odd, nonzero, positive,
- negative, or absolute value of at least two). The previous GLU
- tessellator (prior to GLU 1.2) used the ``odd'' rule. The
- ``nonzero'' rule is another common way to define the interior. The
- other three rules are useful for polygon CSG operations.
-
-`GLU_TESS_BOUNDARY_ONLY'
- Is a boolean value (``value'' should be set to GL_TRUE or
- GL_FALSE). When set to GL_TRUE, a set of closed contours separating
- the polygon interior and exterior are returned instead of a
- tessellation. Exterior contours are oriented CCW with respect to
- the normal; interior contours are oriented CW. The `GLU_TESS_BEGIN'
- and `GLU_TESS_BEGIN_DATA' callbacks use the type GL_LINE_LOOP for
- each contour.
-
-`GLU_TESS_TOLERANCE'
- Specifies a tolerance for merging features to reduce the size of
- the output. For example, two vertices that are very close to each
- other might be replaced by a single vertex. The tolerance is
- multiplied by the largest coordinate magnitude of any input vertex;
- this specifies the maximum distance that any feature can move as
- the result of a single merge operation. If a single feature takes
- part in several merge operations, the total distance moved could be
- larger.
-
- Feature merging is completely optional; the tolerance is only a
- hint. The implementation is free to merge in some cases and not in
- others, or to never merge features at all. The initial tolerance is
- 0.
-
- The current implementation merges vertices only if they are exactly
- coincident, regardless of the current tolerance. A vertex is
- spliced into an edge only if the implementation is unable to
- distinguish which side of the edge the vertex lies on. Two edges
- are merged only when both endpoints are identical.")
-
-(define-gl-procedure
- gluTessVertex
- "gluTessVertex"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "gluTessVertex"))
- (paramdef "GLUtesselator* " (parameter "tess"))
- (paramdef "GLdouble * " (parameter "location"))
- (paramdef "GLvoid* " (parameter "data"))))
- "specify a vertex on a polygon
-=============================
-
-
-Parameters
-==========
-
-TESS
- Specifies the tessellation object (created with `gluNewTess').
-
-LOCATION
- Specifies the location of the vertex.
-
-DATA
- Specifies an opaque pointer passed back to the program with the
- vertex callback (as specified by `gluTessCallback').
-
-
-Description
-===========
-
-`gluTessVertex' describes a vertex on a polygon that the program
-defines. Successive `gluTessVertex' calls describe a closed contour. For
-example, to describe a quadrilateral, `gluTessVertex' should be called
-four times. `gluTessVertex' can only be called between
-`gluTessBeginContour' and `gluTessEndContour'.
-
-DATA normally points to a structure containing the vertex location, as
-well as other per-vertex attributes such as color and normal. This
-pointer is passed back to the user through the `GLU_TESS_VERTEX' or
-`GLU_TESS_VERTEX_DATA' callback after tessellation (see the
-`gluTessCallback' reference page).")
-
-(define-gl-procedure
- gluUnProject4
- "gluUnProject4"
- (funcsynopsis
- (funcprototype
- (funcdef "GLint " (function "gluUnProject4"))
- (paramdef "GLdouble " (parameter "winX"))
- (paramdef "GLdouble " (parameter "winY"))
- (paramdef "GLdouble " (parameter "winZ"))
- (paramdef "GLdouble " (parameter "clipW"))
- (paramdef
- "const GLdouble * "
- (parameter "model"))
- (paramdef "const GLdouble * " (parameter "proj"))
- (paramdef "const GLint * " (parameter "view"))
- (paramdef "GLdouble " (parameter "nearVal"))
- (paramdef "GLdouble " (parameter "farVal"))
- (paramdef "GLdouble* " (parameter "objX"))
- (paramdef "GLdouble* " (parameter "objY"))
- (paramdef "GLdouble* " (parameter "objZ"))
- (paramdef "GLdouble* " (parameter "objW"))))
- "map window and clip coordinates to object coordinates
-=====================================================
-
-
-Parameters
-==========
-
-WINX
- WINY
-
- WINZ
-
- Specify the window coordinates to be mapped.
-
-CLIPW
- Specify the clip w coordinate to be mapped.
-
-MODEL
- Specifies the modelview matrix (as from a `glGetDoublev' call).
-
-PROJ
- Specifies the projection matrix (as from a `glGetDoublev' call).
-
-VIEW
- Specifies the viewport (as from a `glGetIntegerv' call).
-
-NEARVAL
- FARVAL
-
- Specifies the near and far planes (as from a `glGetDoublev' call).
-
-OBJX
- OBJY
-
- OBJZ
-
- OBJW
-
- Returns the computed object coordinates.
-
-
-Description
-===========
-
-`gluUnProject4' maps the specified window coordinatesi: WINX, WINY, and
-WINZ and its clip w coordinate CLIPW into object coordinates
-(OBJX,OBJYOBJZOBJW) using MODEL, PROJ, and VIEW. CLIPW can be other than
-1 as for vertices in `glFeedbackBuffer' when data type
-`GLU_4D_COLOR_TEXTURE' is returned. This also handles the case where the
-NEARVAL and FARVAL planes are different from the default, 0 and 1,
-respectively. A return value of `GLU_TRUE' indicates success; a return
-value of `GLU_FALSE' indicates failure.
-
-To compute the coordinates (OBJX,OBJYOBJZOBJW), `gluUnProject4'
-multiplies the normalized device coordinates by the inverse of MODEL *
-PROJ as follows:
-
-((OBJX), (OBJY), (OBJZ),
-(OBJW),)=INV\u2061(P\u2062M,)\u2062((2\u2061(WINX-VIEW\u2061[0,],),/VIEW\u2061[2,],-1),
-(2\u2061(WINY-VIEW\u2061[1,],),/VIEW\u2061[3,],-1),
-(2\u2061(WINZ-NEARVAL,),/(FARVAL-NEARVAL,),-1), (CLIPW),)
-
-INV denotes matrix inversion.
-
-`gluUnProject4' is equivalent to `gluUnProject' when CLIPW is 1, NEARVAL
-is 0, and FARVAL is 1.")
-
-(define-gl-procedure
- gluUnProject
- "gluUnProject"
- (funcsynopsis
- (funcprototype
- (funcdef "GLint " (function "gluUnProject"))
- (paramdef "GLdouble " (parameter "winX"))
- (paramdef "GLdouble " (parameter "winY"))
- (paramdef "GLdouble " (parameter "winZ"))
- (paramdef
- "const GLdouble * "
- (parameter "model"))
- (paramdef "const GLdouble * " (parameter "proj"))
- (paramdef "const GLint * " (parameter "view"))
- (paramdef "GLdouble* " (parameter "objX"))
- (paramdef "GLdouble* " (parameter "objY"))
- (paramdef "GLdouble* " (parameter "objZ"))))
- "map window coordinates to object coordinates
-============================================
-
-
-Parameters
-==========
-
-WINX
- WINY
-
- WINZ
-
- Specify the window coordinates to be mapped.
-
-MODEL
- Specifies the modelview matrix (as from a `glGetDoublev' call).
-
-PROJ
- Specifies the projection matrix (as from a `glGetDoublev' call).
-
-VIEW
- Specifies the viewport (as from a `glGetIntegerv' call).
-
-OBJX
- OBJY
-
- OBJZ
-
- Returns the computed object coordinates.
-
-
-Description
-===========
-
-`gluUnProject' maps the specified window coordinates into object
-coordinates using MODEL, PROJ, and VIEW. The result is stored in OBJX,
-OBJY, and OBJZ. A return value of `GLU_TRUE' indicates success; a return
-value of `GLU_FALSE' indicates failure.
-
-To compute the coordinates (OBJX,OBJYOBJZ), `gluUnProject' multiplies
-the normalized device coordinates by the inverse of MODEL * PROJ as
-follows:
-
-((OBJX), (OBJY), (OBJZ),
-(W),)=INV\u2061(P\u2062M,)\u2062((2\u2061(WINX-VIEW\u2061[0,],),/VIEW\u2061[2,],-1),
-(2\u2061(WINY-VIEW\u2061[1,],),/VIEW\u2061[3,],-1), (2\u2061(WINZ,)-1), (1),)INV denotes
-matrix inversion. W is an unused variable, included for consistent
-matrix notation.")
-
-(define-gl-procedure
- glValidateProgram
- "glValidateProgram"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glValidateProgram"))
- (paramdef "GLuint " (parameter "program"))))
- "Validates a program object
-==========================
-
-
-Parameters
-==========
-
-PROGRAM
- Specifies the handle of the program object to be validated.
-
-
-Description
-===========
-
-`glValidateProgram' checks to see whether the executables contained in
-PROGRAM can execute given the current OpenGL state. The information
-generated by the validation process will be stored in PROGRAM's
-information log. The validation information may consist of an empty
-string, or it may be a string containing information about how the
-current program object interacts with the rest of current OpenGL state.
-This provides a way for OpenGL implementers to convey more information
-about why the current program is inefficient, suboptimal, failing to
-execute, and so on.
-
-The status of the validation operation will be stored as part of the
-program object's state. This value will be set to `GL_TRUE' if the
-validation succeeded, and `GL_FALSE' otherwise. It can be queried by
-calling `glGetProgram' with arguments PROGRAM and `GL_VALIDATE_STATUS'.
-If validation is successful, PROGRAM is guaranteed to execute given the
-current state. Otherwise, PROGRAM is guaranteed to not execute.
-
-This function is typically useful only during application development.
-The informational string stored in the information log is completely
-implementation dependent; therefore, an application should not expect
-different OpenGL implementations to produce identical information
-strings.
-
-
-Errors
-======
-
-`GL_INVALID_VALUE' is generated if PROGRAM is not a value generated by
-OpenGL.
-
-`GL_INVALID_OPERATION' is generated if PROGRAM is not a program object.
-
-`GL_INVALID_OPERATION' is generated if `glValidateProgram' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.")
-
-(define-gl-procedure
- glVertexAttribPointer
- "glVertexAttribPointer"
- (funcsynopsis
- (funcprototype
- (funcdef
- "void "
- (function "glVertexAttribPointer"))
- (paramdef "GLuint " (parameter "index"))
- (paramdef "GLint " (parameter "size"))
- (paramdef "GLenum " (parameter "type"))
- (paramdef "GLboolean " (parameter "normalized"))
- (paramdef "GLsizei " (parameter "stride"))
- (paramdef
- "const GLvoid * "
- (parameter "pointer"))))
- "define an array of generic vertex attribute data
-================================================
-
-
-Parameters
-==========
-
-INDEX
- Specifies the index of the generic vertex attribute to be modified.
-
-SIZE
- Specifies the number of components per generic vertex attribute.
- Must be 1, 2, 3, or 4. The initial value is 4.
-
-TYPE
- Specifies the data type of each component in the array. Symbolic
- constants `GL_BYTE', `GL_UNSIGNED_BYTE', `GL_SHORT',
- `GL_UNSIGNED_SHORT', `GL_INT', `GL_UNSIGNED_INT', `GL_FLOAT', or
- `GL_DOUBLE' are accepted. The initial value is `GL_FLOAT'.
-
-NORMALIZED
- Specifies whether fixed-point data values should be normalized
- (`GL_TRUE') or converted directly as fixed-point values
- (`GL_FALSE') when they are accessed.
-
-STRIDE
- Specifies the byte offset between consecutive generic vertex
- attributes. If STRIDE is 0, the generic vertex attributes are
- understood to be tightly packed in the array. The initial value is
- 0.
-
-POINTER
- Specifies a pointer to the first component of the first generic
- vertex attribute in the array. The initial value is 0.
-
-
-Description
-===========
-
-`glVertexAttribPointer' specifies the location and data format of the
-array of generic vertex attributes at index INDEX to use when rendering.
-SIZE specifies the number of components per attribute and must be 1, 2,
-3, or 4. TYPE specifies the data type of each component, and STRIDE
-specifies the byte stride from one attribute to the next, allowing
-vertices and attributes to be packed into a single array or stored in
-separate arrays. If set to `GL_TRUE', NORMALIZED indicates that values
-stored in an integer format are to be mapped to the range [-1,1] (for
-signed values) or [0,1] (for unsigned values) when they are accessed and
-converted to floating point. Otherwise, values will be converted to
-floats directly without normalization.
-
-If a non-zero named buffer object is bound to the `GL_ARRAY_BUFFER'
-target (see `glBindBuffer') while a generic vertex attribute array is
-specified, POINTER is treated as a byte offset into the buffer object's
-data store. Also, the buffer object binding (`GL_ARRAY_BUFFER_BINDING')
-is saved as generic vertex attribute array client-side state
-(`GL_VERTEX_ATTRIB_ARRAY_BUFFER_BINDING') for index INDEX.
-
-When a generic vertex attribute array is specified, SIZE, TYPE,
-NORMALIZED, STRIDE, and POINTER are saved as client-side state, in
-addition to the current vertex array buffer object binding.
-
-To enable and disable a generic vertex attribute array, call
-`glEnableVertexAttribArray' and `glDisableVertexAttribArray' with INDEX.
-If enabled, the generic vertex attribute array is used when
-`glArrayElement', `glDrawArrays', `glMultiDrawArrays', `glDrawElements',
-`glMultiDrawElements', or `glDrawRangeElements' is called.
-
-
-Errors
-======
-
-`GL_INVALID_VALUE' is generated if INDEX is greater than or equal to
-`GL_MAX_VERTEX_ATTRIBS'.
-
-`GL_INVALID_VALUE' is generated if SIZE is not 1, 2, 3, or 4.
-
-`GL_INVALID_ENUM' is generated if TYPE is not an accepted value.
-
-`GL_INVALID_VALUE' is generated if STRIDE is negative.")
-
-(define-gl-procedure
- glVertexAttrib
- "glVertexAttrib"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glVertexAttrib1f"))
- (paramdef "GLuint " (parameter "index"))
- (paramdef "GLfloat " (parameter "v0")))
- (funcprototype
- (funcdef "void " (function "glVertexAttrib1s"))
- (paramdef "GLuint " (parameter "index"))
- (paramdef "GLshort " (parameter "v0")))
- (funcprototype
- (funcdef "void " (function "glVertexAttrib1d"))
- (paramdef "GLuint " (parameter "index"))
- (paramdef "GLdouble " (parameter "v0")))
- (funcprototype
- (funcdef "void " (function "glVertexAttrib2f"))
- (paramdef "GLuint " (parameter "index"))
- (paramdef "GLfloat " (parameter "v0"))
- (paramdef "GLfloat " (parameter "v1")))
- (funcprototype
- (funcdef "void " (function "glVertexAttrib2s"))
- (paramdef "GLuint " (parameter "index"))
- (paramdef "GLshort " (parameter "v0"))
- (paramdef "GLshort " (parameter "v1")))
- (funcprototype
- (funcdef "void " (function "glVertexAttrib2d"))
- (paramdef "GLuint " (parameter "index"))
- (paramdef "GLdouble " (parameter "v0"))
- (paramdef "GLdouble " (parameter "v1")))
- (funcprototype
- (funcdef "void " (function "glVertexAttrib3f"))
- (paramdef "GLuint " (parameter "index"))
- (paramdef "GLfloat " (parameter "v0"))
- (paramdef "GLfloat " (parameter "v1"))
- (paramdef "GLfloat " (parameter "v2")))
- (funcprototype
- (funcdef "void " (function "glVertexAttrib3s"))
- (paramdef "GLuint " (parameter "index"))
- (paramdef "GLshort " (parameter "v0"))
- (paramdef "GLshort " (parameter "v1"))
- (paramdef "GLshort " (parameter "v2")))
- (funcprototype
- (funcdef "void " (function "glVertexAttrib3d"))
- (paramdef "GLuint " (parameter "index"))
- (paramdef "GLdouble " (parameter "v0"))
- (paramdef "GLdouble " (parameter "v1"))
- (paramdef "GLdouble " (parameter "v2")))
- (funcprototype
- (funcdef "void " (function "glVertexAttrib4f"))
- (paramdef "GLuint " (parameter "index"))
- (paramdef "GLfloat " (parameter "v0"))
- (paramdef "GLfloat " (parameter "v1"))
- (paramdef "GLfloat " (parameter "v2"))
- (paramdef "GLfloat " (parameter "v3")))
- (funcprototype
- (funcdef "void " (function "glVertexAttrib4s"))
- (paramdef "GLuint " (parameter "index"))
- (paramdef "GLshort " (parameter "v0"))
- (paramdef "GLshort " (parameter "v1"))
- (paramdef "GLshort " (parameter "v2"))
- (paramdef "GLshort " (parameter "v3")))
- (funcprototype
- (funcdef "void " (function "glVertexAttrib4d"))
- (paramdef "GLuint " (parameter "index"))
- (paramdef "GLdouble " (parameter "v0"))
- (paramdef "GLdouble " (parameter "v1"))
- (paramdef "GLdouble " (parameter "v2"))
- (paramdef "GLdouble " (parameter "v3")))
- (funcprototype
- (funcdef "void " (function "glVertexAttrib4Nub"))
- (paramdef "GLuint " (parameter "index"))
- (paramdef "GLubyte " (parameter "v0"))
- (paramdef "GLubyte " (parameter "v1"))
- (paramdef "GLubyte " (parameter "v2"))
- (paramdef "GLubyte " (parameter "v3"))))
- "Specifies the value of a generic vertex attribute
-=================================================
-
-
-Parameters
-==========
-
-INDEX
- Specifies the index of the generic vertex attribute to be modified.
-
-V0, V1, V2, V3
- Specifies the new values to be used for the specified vertex
- attribute.
-
-
-Description
-===========
-
-OpenGL defines a number of standard vertex attributes that applications
-can modify with standard API entry points (color, normal, texture
-coordinates, etc.). The `glVertexAttrib' family of entry points allows
-an application to pass generic vertex attributes in numbered locations.
-
-Generic attributes are defined as four-component values that are
-organized into an array. The first entry of this array is numbered 0,
-and the size of the array is specified by the implementation-dependent
-constant `GL_MAX_VERTEX_ATTRIBS'. Individual elements of this array can
-be modified with a `glVertexAttrib' call that specifies the index of the
-element to be modified and a value for that element.
-
-These commands can be used to specify one, two, three, or all four
-components of the generic vertex attribute specified by INDEX. A `1' in
-the name of the command indicates that only one value is passed, and it
-will be used to modify the first component of the generic vertex
-attribute. The second and third components will be set to 0, and the
-fourth component will be set to 1. Similarly, a `2' in the name of the
-command indicates that values are provided for the first two components,
-the third component will be set to 0, and the fourth component will be
-set to 1. A `3' in the name of the command indicates that values are
-provided for the first three components and the fourth component will be
-set to 1, whereas a `4' in the name indicates that values are provided
-for all four components.
-
-The letters `s', `f', `i', `d', `ub', `us', and `ui' indicate whether
-the arguments are of type short, float, int, double, unsigned byte,
-unsigned short, or unsigned int. When `v' is appended to the name, the
-commands can take a pointer to an array of such values. The commands
-containing `N' indicate that the arguments will be passed as fixed-point
-values that are scaled to a normalized range according to the component
-conversion rules defined by the OpenGL specification. Signed values are
-understood to represent fixed-point values in the range [-1,1], and
-unsigned values are understood to represent fixed-point values in the
-range [0,1].
-
-OpenGL Shading Language attribute variables are allowed to be of type
-mat2, mat3, or mat4. Attributes of these types may be loaded using the
-`glVertexAttrib' entry points. Matrices must be loaded into successive
-generic attribute slots in column major order, with one column of the
-matrix in each generic attribute slot.
-
-A user-defined attribute variable declared in a vertex shader can be
-bound to a generic attribute index by calling `glBindAttribLocation'.
-This allows an application to use more descriptive variable names in a
-vertex shader. A subsequent change to the specified generic vertex
-attribute will be immediately reflected as a change to the corresponding
-attribute variable in the vertex shader.
-
-The binding between a generic vertex attribute index and a user-defined
-attribute variable in a vertex shader is part of the state of a program
-object, but the current value of the generic vertex attribute is not.
-The value of each generic vertex attribute is part of current state,
-just like standard vertex attributes, and it is maintained even if a
-different program object is used.
-
-An application may freely modify generic vertex attributes that are not
-bound to a named vertex shader attribute variable. These values are
-simply maintained as part of current state and will not be accessed by
-the vertex shader. If a generic vertex attribute bound to an attribute
-variable in a vertex shader is not updated while the vertex shader is
-executing, the vertex shader will repeatedly use the current value for
-the generic vertex attribute.
-
-The generic vertex attribute with index 0 is the same as the vertex
-position attribute previously defined by OpenGL. A `glVertex2',
-`glVertex3', or `glVertex4' command is completely equivalent to the
-corresponding `glVertexAttrib' command with an index argument of 0. A
-vertex shader can access generic vertex attribute 0 by using the
-built-in attribute variable GL_VERTEX. There are no current values for
-generic vertex attribute 0. This is the only generic vertex attribute
-with this property; calls to set other standard vertex attributes can be
-freely mixed with calls to set any of the other generic vertex
-attributes.
-
-
-Errors
-======
-
-`GL_INVALID_VALUE' is generated if INDEX is greater than or equal to
-`GL_MAX_VERTEX_ATTRIBS'.")
-
-(define-gl-procedure
- glVertexPointer
- "glVertexPointer"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glVertexPointer"))
- (paramdef "GLint " (parameter "size"))
- (paramdef "GLenum " (parameter "type"))
- (paramdef "GLsizei " (parameter "stride"))
- (paramdef
- "const GLvoid * "
- (parameter "pointer"))))
- "define an array of vertex data
-==============================
-
-
-Parameters
-==========
-
-SIZE
- Specifies the number of coordinates per vertex. Must be 2, 3, or 4.
- The initial value is 4.
-
-TYPE
- Specifies the data type of each coordinate in the array. Symbolic
- constants `GL_SHORT', `GL_INT', `GL_FLOAT', or `GL_DOUBLE' are
- accepted. The initial value is `GL_FLOAT'.
-
-STRIDE
- Specifies the byte offset between consecutive vertices. If STRIDE
- is 0, the vertices are understood to be tightly packed in the
- array. The initial value is 0.
-
-POINTER
- Specifies a pointer to the first coordinate of the first vertex in
- the array. The initial value is 0.
-
-
-Description
-===========
-
-`glVertexPointer' specifies the location and data format of an array of
-vertex coordinates to use when rendering. SIZE specifies the number of
-coordinates per vertex, and must be 2, 3, or 4. TYPE specifies the data
-type of each coordinate, and STRIDE specifies the byte stride from one
-vertex to the next, allowing vertices and attributes to be packed into a
-single array or stored in separate arrays. (Single-array storage may be
-more efficient on some implementations; see `glInterleavedArrays'.)
-
-If a non-zero named buffer object is bound to the `GL_ARRAY_BUFFER'
-target (see `glBindBuffer') while a vertex array is specified, POINTER
-is treated as a byte offset into the buffer object's data store. Also,
-the buffer object binding (`GL_ARRAY_BUFFER_BINDING') is saved as vertex
-array client-side state (`GL_VERTEX_ARRAY_BUFFER_BINDING').
-
-When a vertex array is specified, SIZE, TYPE, STRIDE, and POINTER are
-saved as client-side state, in addition to the current vertex array
-buffer object binding.
-
-To enable and disable the vertex array, call `glEnableClientState' and
-`glDisableClientState' with the argument `GL_VERTEX_ARRAY'. If enabled,
-the vertex array is used when `glArrayElement', `glDrawArrays',
-`glMultiDrawArrays', `glDrawElements', `glMultiDrawElements', or
-`glDrawRangeElements' is called.
-
-
-Errors
-======
-
-`GL_INVALID_VALUE' is generated if SIZE is not 2, 3, or 4.
-
-`GL_INVALID_ENUM' is generated if TYPE is not an accepted value.
-
-`GL_INVALID_VALUE' is generated if STRIDE is negative.")
-
-(define-gl-procedure
- glVertex
- "glVertex"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glVertex2s"))
- (paramdef "GLshort " (parameter "x"))
- (paramdef "GLshort " (parameter "y"))))
- "specify a vertex
-================
-
-
-Parameters
-==========
-
-X
- Y
-
- Z
-
- W
-
- Specify X, Y, Z, and W coordinates of a vertex. Not all parameters
- are present in all forms of the command.
-
-
-Description
-===========
-
-`glVertex' commands are used within `glBegin'/`glEnd' pairs to specify
-point, line, and polygon vertices. The current color, normal, texture
-coordinates, and fog coordinate are associated with the vertex when
-`glVertex' is called.
-
-When only X and Y are specified, Z defaults to 0 and W defaults to 1.
-When X, Y, and Z are specified, W defaults to 1.")
-
-(define-gl-procedure
- glViewport
- "glViewport"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glViewport"))
- (paramdef "GLint " (parameter "x"))
- (paramdef "GLint " (parameter "y"))
- (paramdef "GLsizei " (parameter "width"))
- (paramdef "GLsizei " (parameter "height"))))
- "set the viewport
-================
-
-
-Parameters
-==========
-
-X
- Y
-
- Specify the lower left corner of the viewport rectangle, in pixels.
- The initial value is (0,0).
-
-WIDTH
- HEIGHT
-
- Specify the width and height of the viewport. When a GL context is
- first attached to a window, WIDTH and HEIGHT are set to the
- dimensions of that window.
-
-
-Description
-===========
-
-`glViewport' specifies the affine transformation of X and Y from
-normalized device coordinates to window coordinates. Let (X_ND,Y_ND) be
-normalized device coordinates. Then the window coordinates (X_W,Y_W) are
-computed as follows:
-
-X_W=(X_ND+1,)\u2062(WIDTH/2,)+X
-
-Y_W=(Y_ND+1,)\u2062(HEIGHT/2,)+Y
-
-Viewport width and height are silently clamped to a range that depends
-on the implementation. To query this range, call `glGet' with argument
-`GL_MAX_VIEWPORT_DIMS'.
-
-
-Errors
-======
-
-`GL_INVALID_VALUE' is generated if either WIDTH or HEIGHT is negative.
-
-`GL_INVALID_OPERATION' is generated if `glViewport' is executed between
-the execution of `glBegin' and the corresponding execution of `glEnd'.")
-
-(define-gl-procedure
- glWindowPos
- "glWindowPos"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glWindowPos2s"))
- (paramdef "GLshort " (parameter "x"))
- (paramdef "GLshort " (parameter "y"))))
- "specify the raster position in window coordinates for pixel operations
-======================================================================
-
-
-Parameters
-==========
-
-X
- Y
-
- Z
-
- Specify the X, Y, Z coordinates for the raster position.
-
-
-Description
-===========
-
-The GL maintains a 3D position in window coordinates. This position,
-called the raster position, is used to position pixel and bitmap write
-operations. It is maintained with subpixel accuracy. See `glBitmap',
-`glDrawPixels', and `glCopyPixels'.
-
-`glWindowPos2' specifies the X and Y coordinates, while Z is implicitly
-set to 0. `glWindowPos3' specifies all three coordinates. The W
-coordinate of the current raster position is always set to 1.0.
-
-`glWindowPos' directly updates the X and Y coordinates of the current
-raster position with the values specified. That is, the values are
-neither transformed by the current modelview and projection matrices,
-nor by the viewport-to-window transform. The Z coordinate of the current
-raster position is updated in the following manner:
-
-Z={(N), (F), (N+Z×(F-N,),)\u2062(IF\u2062Z<=0), (IF\u2062Z>=1), (`otherwise',),
-
-
-
-where N is `GL_DEPTH_RANGE''s near value, and F is `GL_DEPTH_RANGE''s
-far value. See `glDepthRange'.
-
-The specified coordinates are not clip-tested, causing the raster
-position to always be valid.
-
-The current raster position also includes some associated color data and
-texture coordinates. If lighting is enabled, then
-`GL_CURRENT_RASTER_COLOR' (in RGBA mode) or `GL_CURRENT_RASTER_INDEX'
-(in color index mode) is set to the color produced by the lighting
-calculation (see `glLight', `glLightModel', and `glShadeModel'). If
-lighting is disabled, current color (in RGBA mode, state variable
-`GL_CURRENT_COLOR') or color index (in color index mode, state variable
-`GL_CURRENT_INDEX') is used to update the current raster color.
-`GL_CURRENT_RASTER_SECONDARY_COLOR' (in RGBA mode) is likewise updated.
-
-Likewise, `GL_CURRENT_RASTER_TEXTURE_COORDS' is updated as a function of
-`GL_CURRENT_TEXTURE_COORDS', based on the texture matrix and the texture
-generation functions (see `glTexGen'). The `GL_CURRENT_RASTER_DISTANCE'
-is set to the `GL_CURRENT_FOG_COORD'.
-
-
-
-
-Errors
-======
-
-`GL_INVALID_OPERATION' is generated if `glWindowPos' is executed between
-the execution of `glBegin' and the corresponding execution of `glEnd'.")
-
-(define-gl-procedure
- glXChooseFBConfig
- "glXChooseFBConfig"
- (funcsynopsis
- (funcprototype
- (funcdef
- "GLXFBConfig * "
- (function "glXChooseFBConfig"))
- (paramdef "Display * " (parameter "dpy"))
- (paramdef "int " (parameter "screen"))
- (paramdef
- "const int * "
- (parameter "attrib_list"))
- (paramdef "int * " (parameter "nelements"))))
- "return a list of GLX frame buffer configurations that match the specified attributes
-====================================================================================
-
-
-Parameters
-==========
-
-DPY
- Specifies the connection to the X server.
-
-SCREEN
- Specifies the screen number.
-
-ATTRIB_LIST
- Specifies a list of attribute/value pairs. The last attribute must
- be `None'.
-
-NELEMENTS
- Returns the number of elements in the list returned by
- `glXChooseFBConfig'.
-
-
-Description
-===========
-
-`glXChooseFBConfig' returns GLX frame buffer configurations that match
-the attributes specified in ATTRIB_LIST, or `NULL' if no matches are
-found. If ATTRIB_LIST is `NULL', then `glXChooseFBConfig' returns an
-array of GLX frame buffer configurations that are available on the
-specified screen. If an error occurs, no frame buffer configurations
-exist on the specified screen, or if no frame buffer configurations
-match the specified attributes, then `NULL' is returned. Use `XFree' to
-free the memory returned by `glXChooseFBConfig'.
-
-All attributes in ATTRIB_LIST, including boolean attributes, are
-immediately followed by the corresponding desired value. The list is
-terminated with `None'. If an attribute is not specified in ATTRIB_LIST,
-then the default value (see below) is used (and the attribute is said to
-be specified implicitly). For example, if `GLX_STEREO' is not specified,
-then it is assumed to be `False'. For some attributes, the default is
-`GLX_DONT_CARE', meaning that any value is OK for this attribute, so the
-attribute will not be checked.
-
-Attributes are matched in an attribute-specific manner. Some of the
-attributes, such as `GLX_LEVEL', must match the specified value exactly;
-others, such as, `GLX_RED_SIZE' must meet or exceed the specified
-minimum values. If more than one GLX frame buffer configuration is
-found, then a list of configurations, sorted according to the ``best''
-match criteria, is returned. The match criteria for each attribute and
-the exact sorting order is defined below.
-
-The interpretations of the various GLX visual attributes are as follows:
-
-`GLX_FBCONFIG_ID'
-
-
- Must be followed by a valid XID that indicates the desired GLX
- frame buffer configuration. When a `GLX_FBCONFIG_ID' is specified,
- all attributes are ignored. The default value is `GLX_DONT_CARE'.
-
-`GLX_BUFFER_SIZE'
-
-
- Must be followed by a nonnegative integer that indicates the
- desired color index buffer size. The smallest index buffer of at
- least the specified size is preferred. This attribute is ignored if
- `GLX_COLOR_INDEX_BIT' is not set in `GLX_RENDER_TYPE'. The default
- value is 0.
-
-`GLX_LEVEL'
-
-
- Must be followed by an integer buffer-level specification. This
- specification is honored exactly. Buffer level 0 corresponds to the
- default frame buffer of the display. Buffer level 1 is the first
- overlay frame buffer, level two the second overlay frame buffer,
- and so on. Negative buffer levels correspond to underlay frame
- buffers. The default value is 0.
-
-`GLX_DOUBLEBUFFER'
-
-
- Must be followed by `True' or `False'. If `True' is specified, then
- only double-buffered frame buffer configurations are considered; if
- `False' is specified, then only single-buffered frame buffer
- configurations are considered. The default value is
- `GLX_DONT_CARE'.
-
-`GLX_STEREO'
-
-
- Must be followed by `True' or `False'. If `True' is specified, then
- only stereo frame buffer configurations are considered; if `False'
- is specified, then only monoscopic frame buffer configurations are
- considered. The default value is `False'.
-
-`GLX_AUX_BUFFERS'
-
-
- Must be followed by a nonnegative integer that indicates the
- desired number of auxiliary buffers. Configurations with the
- smallest number of auxiliary buffers that meet or exceed the
- specified number are preferred. The default value is 0.
-
-`GLX_RED_SIZE', `GLX_GREEN_SIZE', `GLX_BLUE_SIZE', `GLX_ALPHA_SIZE'
-
-
- Each attribute, if present, must be followed by a nonnegative
- minimum size specification or `GLX_DONT_CARE'. The largest
- available total RGBA color buffer size (sum of `GLX_RED_SIZE',
- `GLX_GREEN_SIZE', `GLX_BLUE_SIZE', and `GLX_ALPHA_SIZE') of at
- least the minimum size specified for each color component is
- preferred. If the requested number of bits for a color component is
- 0 or `GLX_DONT_CARE', it is not considered. The default value for
- each color component is 0.
-
-`GLX_DEPTH_SIZE'
-
-
- Must be followed by a nonnegative minimum size specification. If
- this value is zero, frame buffer configurations with no depth
- buffer are preferred. Otherwise, the largest available depth buffer
- of at least the minimum size is preferred. The default value is 0.
-
-`GLX_STENCIL_SIZE'
-
-
- Must be followed by a nonnegative integer that indicates the
- desired number of stencil bitplanes. The smallest stencil buffer of
- at least the specified size is preferred. If the desired value is
- zero, frame buffer configurations with no stencil buffer are
- preferred. The default value is 0.
-
-`GLX_ACCUM_RED_SIZE'
-
-
- Must be followed by a nonnegative minimum size specification. If
- this value is zero, frame buffer configurations with no red
- accumulation buffer are preferred. Otherwise, the largest possible
- red accumulation buffer of at least the minimum size is preferred.
- The default value is 0.
-
-`GLX_ACCUM_GREEN_SIZE'
-
-
- Must be followed by a nonnegative minimum size specification. If
- this value is zero, frame buffer configurations with no green
- accumulation buffer are preferred. Otherwise, the largest possible
- green accumulation buffer of at least the minimum size is
- preferred. The default value is 0.
-
-`GLX_ACCUM_BLUE_SIZE'
-
-
- Must be followed by a nonnegative minimum size specification. If
- this value is zero, frame buffer configurations with no blue
- accumulation buffer are preferred. Otherwise, the largest possible
- blue accumulation buffer of at least the minimum size is preferred.
- The default value is 0.
-
-`GLX_ACCUM_ALPHA_SIZE'
-
-
- Must be followed by a nonnegative minimum size specification. If
- this value is zero, frame buffer configurations with no alpha
- accumulation buffer are preferred. Otherwise, the largest possible
- alpha accumulation buffer of at least the minimum size is
- preferred. The default value is 0.
-
-`GLX_RENDER_TYPE'
-
-
- Must be followed by a mask indicating which OpenGL rendering modes
- the frame buffer configuration must support. Valid bits are
- `GLX_RGBA_BIT' and `GLX_COLOR_INDEX_BIT'. If the mask is set to
- `GLX_RGBA_BIT' | `GLX_COLOR_INDEX_BIT', then only frame buffer
- configurations that can be bound to both RGBA contexts and color
- index contexts will be considered. The default value is
- `GLX_RGBA_BIT'.
-
-`GLX_DRAWABLE_TYPE'
-
-
- Must be followed by a mask indicating which GLX drawable types the
- frame buffer configuration must support. Valid bits are
- `GLX_WINDOW_BIT', `GLX_PIXMAP_BIT', and `GLX_PBUFFER_BIT'. For
- example, if mask is set to `GLX_WINDOW_BIT' | `GLX_PIXMAP_BIT',
- only frame buffer configurations that support both windows and GLX
- pixmaps will be considered. The default value is `GLX_WINDOW_BIT'.
-
-`GLX_X_RENDERABLE'
-
-
- Must be followed by `True' or `False'. If `True' is specified, then
- only frame buffer configurations that have associated X visuals
- (and can be used to render to Windows and/or GLX pixmaps) will be
- considered. The default value is `GLX_DONT_CARE'.
-
-`GLX_X_VISUAL_TYPE'
-
-
- Must be followed by one of `GLX_TRUE_COLOR', `GLX_DIRECT_COLOR',
- `GLX_PSEUDO_COLOR', `GLX_STATIC_COLOR', `GLX_GRAY_SCALE', or
- `GLX_STATIC_GRAY', indicating the desired X visual type. Not all
- frame buffer configurations have an associated X visual. If
- `GLX_DRAWABLE_TYPE' is specified in ATTRIB_LIST and the mask that
- follows does not have `GLX_WINDOW_BIT' set, then this value is
- ignored. It is also ignored if `GLX_X_RENDERABLE' is specified as
- `False'. RGBA rendering may be supported for visuals of type
- `GLX_TRUE_COLOR', `GLX_DIRECT_COLOR', `GLX_PSEUDO_COLOR', or
- `GLX_STATIC_COLOR', but color index rendering is only supported for
- visuals of type `GLX_PSEUDO_COLOR' or `GLX_STATIC_COLOR' (i.e.,
- single-channel visuals). The tokens `GLX_GRAY_SCALE' and
- `GLX_STATIC_GRAY' will not match current OpenGL enabled visuals,
- but are included for future use. The default value for
- `GLX_X_VISUAL_TYPE' is `GLX_DONT_CARE'.
-
-`GLX_CONFIG_CAVEAT'
-
-
- Must be followed by one of `GLX_NONE', `GLX_SLOW_CONFIG',
- `GLX_NON_CONFORMANT_CONFIG'. If `GLX_NONE' is specified, then only
- frame buffer configurations with no caveats will be considered; if
- `GLX_SLOW_CONFIG' is specified, then only slow frame buffer
- configurations will be considered; if `GLX_NON_CONFORMANT_CONFIG'
- is specified, then only nonconformant frame buffer configurations
- will be considered. The default value is `GLX_DONT_CARE'.
-
-`GLX_TRANSPARENT_TYPE'
-
-
- Must be followed by one of `GLX_NONE', `GLX_TRANSPARENT_RGB',
- `GLX_TRANSPARENT_INDEX'. If `GLX_NONE' is specified, then only
- opaque frame buffer configurations will be considered; if
- `GLX_TRANSPARENT_RGB' is specified, then only transparent frame
- buffer configurations that support RGBA rendering will be
- considered; if `GLX_TRANSPARENT_INDEX' is specified, then only
- transparent frame buffer configurations that support color index
- rendering will be considered. The default value is `GLX_NONE'.
-
-`GLX_TRANSPARENT_INDEX_VALUE'
-
-
- Must be followed by an integer value indicating the transparent
- index value; the value must be between 0 and the maximum frame
- buffer value for indices. Only frame buffer configurations that use
- the specified transparent index value will be considered. The
- default value is `GLX_DONT_CARE'. This attribute is ignored unless
- `GLX_TRANSPARENT_TYPE' is included in ATTRIB_LIST and specified as
- `GLX_TRANSPARENT_INDEX'.
-
-`GLX_TRANSPARENT_RED_VALUE'
-
-
- Must be followed by an integer value indicating the transparent red
- value; the value must be between 0 and the maximum frame buffer
- value for red. Only frame buffer configurations that use the
- specified transparent red value will be considered. The default
- value is `GLX_DONT_CARE'. This attribute is ignored unless
- `GLX_TRANSPARENT_TYPE' is included in ATTRIB_LIST and specified as
- `GLX_TRANSPARENT_RGB'.
-
-`GLX_TRANSPARENT_GREEN_VALUE'
-
-
- Must be followed by an integer value indicating the transparent
- green value; the value must be between 0 and the maximum frame
- buffer value for green. Only frame buffer configurations that use
- the specified transparent green value will be considered. The
- default value is `GLX_DONT_CARE'. This attribute is ignored unless
- `GLX_TRANSPARENT_TYPE' is included in ATTRIB_LIST and specified as
- `GLX_TRANSPARENT_RGB'.
-
-`GLX_TRANSPARENT_BLUE_VALUE'
-
-
- Must be followed by an integer value indicating the transparent
- blue value; the value must be between 0 and the maximum frame
- buffer value for blue. Only frame buffer configurations that use
- the specified transparent blue value will be considered. The
- default value is `GLX_DONT_CARE'. This attribute is ignored unless
- `GLX_TRANSPARENT_TYPE' is included in ATTRIB_LIST and specified as
- `GLX_TRANSPARENT_RGB'.
-
-`GLX_TRANSPARENT_ALPHA_VALUE'
-
-
- Must be followed by an integer value indicating the transparent
- alpha value; the value must be between 0 and the maximum frame
- buffer value for alpha. Only frame buffer configurations that use
- the specified transparent alpha value will be considered. The
- default value is `GLX_DONT_CARE'.
-
-When more than one GLX frame buffer configuration matches the specified
-attributes, a list of matching configurations is returned. The list is
-sorted according to the following precedence rules, which are applied in
-ascending order (i.e., configurations that are considered equal by a
-lower numbered rule are sorted by the higher numbered rule):
-
-1.
- By `GLX_CONFIG_CAVEAT' where the precedence is `GLX_NONE',
- `GLX_SLOW_CONFIG', and `GLX_NON_CONFORMANT_CONFIG'.
-
-2.
- Larger total number of RGBA color components (`GLX_RED_SIZE',
- `GLX_GREEN_SIZE', `GLX_BLUE_SIZE', plus `GLX_ALPHA_SIZE') that have
- higher number of bits. If the requested number of bits in
- ATTRIB_LIST is zero or `GLX_DONT_CARE' for a particular color
- component, then the number of bits for that component is not
- considered.
-
-3.
- Smaller `GLX_BUFFER_SIZE'.
-
-4.
- Single buffered configuration (`GLX_DOUBLEBUFFER' being `False'
- precedes a double buffered one.
-
-5.
- Smaller `GLX_AUX_BUFFERS'.
-
-6.
- Larger `GLX_DEPTH_SIZE'.
-
-7.
- Smaller `GLX_STENCIL_SIZE'.
-
-8.
- Larger total number of accumulation buffer color components
- (`GLX_ACCUM_RED_SIZE', `GLX_ACCUM_GREEN_SIZE',
- `GLX_ACCUM_BLUE_SIZE', plus `GLX_ACCUM_ALPHA_SIZE') that have
- higher number of bits. If the requested number of bits in
- ATTRIB_LIST is zero or `GLX_DONT_CARE' for a particular color
- component, then the number of bits for that component is not
- considered.
-
-9.
- By `GLX_X_VISUAL_TYPE' where the precedence order is
- `GLX_TRUE_COLOR', `GLX_DIRECT_COLOR', `GLX_PSEUDO_COLOR',
- `GLX_STATIC_COLOR', `GLX_GRAY_SCALE', `GLX_STATIC_GRAY'.
-
-
-Errors
-======
-
-`NULL' is returned if an undefined GLX attribute is encountered in
-ATTRIB_LIST, if SCREEN is invalid, or if DPY does not support the GLX
-extension.")
-
-(define-gl-procedure
- glXChooseVisual
- "glXChooseVisual"
- (funcsynopsis
- (funcprototype
- (funcdef
- "XVisualInfo* "
- (function "glXChooseVisual"))
- (paramdef "Display * " (parameter "dpy"))
- (paramdef "int " (parameter "screen"))
- (paramdef "int * " (parameter "attribList"))))
- "return a visual that matches specified attributes
-=================================================
-
-
-Parameters
-==========
-
-DPY
- Specifies the connection to the X server.
-
-SCREEN
- Specifies the screen number.
-
-ATTRIBLIST
- Specifies a list of boolean attributes and integer attribute/value
- pairs. The last attribute must be `None'.
-
-
-Description
-===========
-
-`glXChooseVisual' returns a pointer to an XVisualInfo structure
-describing the visual that best meets a minimum specification. The
-boolean GLX attributes of the visual that is returned will match the
-specified values, and the integer GLX attributes will meet or exceed the
-specified minimum values. If all other attributes are equivalent, then
-TrueColor and PseudoColor visuals have priority over DirectColor and
-StaticColor visuals, respectively. If no conforming visual exists,
-`NULL' is returned. To free the data returned by this function, use
-`XFree'.
-
-All boolean GLX attributes default to `False' except `GLX_USE_GL', which
-defaults to `True'. All integer GLX attributes default to zero. Default
-specifications are superseded by attributes included in ATTRIBLIST.
-Boolean attributes included in ATTRIBLIST are understood to be `True'.
-Integer attributes and enumerated type attributes are followed
-immediately by the corresponding desired or minimum value. The list must
-be terminated with `None'.
-
-The interpretations of the various GLX visual attributes are as follows:
-
-`GLX_USE_GL'
- Ignored. Only visuals that can be rendered with GLX are considered.
-
-`GLX_BUFFER_SIZE'
- Must be followed by a nonnegative integer that indicates the
- desired color index buffer size. The smallest index buffer of at
- least the specified size is preferred. Ignored if `GLX_RGBA' is
- asserted.
-
-`GLX_LEVEL'
- Must be followed by an integer buffer-level specification. This
- specification is honored exactly. Buffer level zero corresponds to
- the main frame buffer of the display. Buffer level one is the first
- overlay frame buffer, level two the second overlay frame buffer,
- and so on. Negative buffer levels correspond to underlay frame
- buffers.
-
-`GLX_RGBA'
- If present, only TrueColor and DirectColor visuals are considered.
- Otherwise, only PseudoColor and StaticColor visuals are considered.
-
-`GLX_DOUBLEBUFFER'
- If present, only double-buffered visuals are considered. Otherwise,
- only single-buffered visuals are considered.
-
-`GLX_STEREO'
- If present, only stereo visuals are considered. Otherwise, only
- monoscopic visuals are considered.
-
-`GLX_AUX_BUFFERS'
- Must be followed by a nonnegative integer that indicates the
- desired number of auxiliary buffers. Visuals with the smallest
- number of auxiliary buffers that meets or exceeds the specified
- number are preferred.
-
-`GLX_RED_SIZE'
- Must be followed by a nonnegative minimum size specification. If
- this value is zero, the smallest available red buffer is preferred.
- Otherwise, the largest available red buffer of at least the minimum
- size is preferred.
-
-`GLX_GREEN_SIZE'
- Must be followed by a nonnegative minimum size specification. If
- this value is zero, the smallest available green buffer is
- preferred. Otherwise, the largest available green buffer of at
- least the minimum size is preferred.
-
-`GLX_BLUE_SIZE'
- Must be followed by a nonnegative minimum size specification. If
- this value is zero, the smallest available blue buffer is
- preferred. Otherwise, the largest available blue buffer of at least
- the minimum size is preferred.
-
-`GLX_ALPHA_SIZE'
- Must be followed by a nonnegative minimum size specification. If
- this value is zero, the smallest available alpha buffer is
- preferred. Otherwise, the largest available alpha buffer of at
- least the minimum size is preferred.
-
-`GLX_DEPTH_SIZE'
- Must be followed by a nonnegative minimum size specification. If
- this value is zero, visuals with no depth buffer are preferred.
- Otherwise, the largest available depth buffer of at least the
- minimum size is preferred.
-
-`GLX_STENCIL_SIZE'
- Must be followed by a nonnegative integer that indicates the
- desired number of stencil bitplanes. The smallest stencil buffer of
- at least the specified size is preferred. If the desired value is
- zero, visuals with no stencil buffer are preferred.
-
-`GLX_ACCUM_RED_SIZE'
- Must be followed by a nonnegative minimum size specification. If
- this value is zero, visuals with no red accumulation buffer are
- preferred. Otherwise, the largest possible red accumulation buffer
- of at least the minimum size is preferred.
-
-`GLX_ACCUM_GREEN_SIZE'
- Must be followed by a nonnegative minimum size specification. If
- this value is zero, visuals with no green accumulation buffer are
- preferred. Otherwise, the largest possible green accumulation
- buffer of at least the minimum size is preferred.
-
-`GLX_ACCUM_BLUE_SIZE'
- Must be followed by a nonnegative minimum size specification. If
- this value is zero, visuals with no blue accumulation buffer are
- preferred. Otherwise, the largest possible blue accumulation buffer
- of at least the minimum size is preferred.
-
-`GLX_ACCUM_ALPHA_SIZE'
- Must be followed by a nonnegative minimum size specification. If
- this value is zero, visuals with no alpha accumulation buffer are
- preferred. Otherwise, the largest possible alpha accumulation
- buffer of at least the minimum size is preferred.
-
-
-Errors
-======
-
-`NULL' is returned if an undefined GLX attribute is encountered in
-ATTRIBLIST.")
-
-(define-gl-procedure
- glXCopyContext
- "glXCopyContext"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glXCopyContext"))
- (paramdef "Display * " (parameter "dpy"))
- (paramdef "GLXContext " (parameter "src"))
- (paramdef "GLXContext " (parameter "dst"))
- (paramdef "unsigned long " (parameter "mask"))))
- "copy state from one rendering context to another
-================================================
-
-
-Parameters
-==========
-
-DPY
- Specifies the connection to the X server.
-
-SRC
- Specifies the source context.
-
-DST
- Specifies the destination context.
-
-MASK
- Specifies which portions of SRC state are to be copied to DST.
-
-
-Description
-===========
-
-`glXCopyContext' copies selected groups of state variables from SRC to
-DST. MASK indicates which groups of state variables are to be copied.
-MASK contains the bitwise OR of the same symbolic names that are passed
-to the GL command `glPushAttrib'. The single symbolic constant
-`GLX_ALL_ATTRIB_BITS' can be used to copy the maximum possible portion
-of rendering state.
-
-The copy can be done only if the renderers named by SRC and DST share an
-address space. Two rendering contexts share an address space if both are
-nondirect using the same server, or if both are direct and owned by a
-single process. Note that in the nondirect case it is not necessary for
-the calling threads to share an address space, only for their related
-rendering contexts to share an address space.
-
-Not all values for GL state can be copied. For example, pixel pack and
-unpack state, render mode state, and select and feedback state are not
-copied. The state that can be copied is exactly the state that is
-manipulated by the GL command `glPushAttrib'.
-
-An implicit `glFlush' is done by `glXCopyContext' if SRC is the current
-context for the calling thread.
-
-
-Errors
-======
-
-`BadMatch' is generated if rendering contexts SRC and DST do not share
-an address space or were not created with respect to the same screen.
-
-`BadAccess' is generated if DST is current to any thread (including the
-calling thread) at the time `glXCopyContext' is called.
-
-`GLXBadCurrentWindow' is generated if SRC is the current context and the
-current drawable is a window that is no longer valid.
-
-`GLXBadContext' is generated if either SRC or DST is not a valid GLX
-context.")
-
-(define-gl-procedure
- glXCreateContext
- "glXCreateContext"
- (funcsynopsis
- (funcprototype
- (funcdef
- "GLXContext "
- (function "glXCreateContext"))
- (paramdef "Display * " (parameter "dpy"))
- (paramdef "XVisualInfo * " (parameter "vis"))
- (paramdef "GLXContext " (parameter "shareList"))
- (paramdef "Bool " (parameter "direct"))))
- "create a new GLX rendering context
-==================================
-
-
-Parameters
-==========
-
-DPY
- Specifies the connection to the X server.
-
-VIS
- Specifies the visual that defines the frame buffer resources
- available to the rendering context. It is a pointer to an
- `XVisualInfo' structure, not a visual ID or a pointer to a
- `Visual'.
-
-SHARELIST
- Specifies the context with which to share display lists. `NULL'
- indicates that no sharing is to take place.
-
-DIRECT
- Specifies whether rendering is to be done with a direct connection
- to the graphics system if possible (`True') or through the X server
- (`False').
-
-
-Description
-===========
-
-`glXCreateContext' creates a GLX rendering context and returns its
-handle. This context can be used to render into both windows and GLX
-pixmaps. If `glXCreateContext' fails to create a rendering context,
-`NULL' is returned.
-
-If DIRECT is `True', then a direct rendering context is created if the
-implementation supports direct rendering, if the connection is to an X
-server that is local, and if a direct rendering context is available.
-(An implementation may return an indirect context when DIRECT is
-`True'.) If DIRECT is `False', then a rendering context that renders
-through the X server is always created. Direct rendering provides a
-performance advantage in some implementations. However, direct rendering
-contexts cannot be shared outside a single process, and they may be
-unable to render to GLX pixmaps.
-
-If SHARELIST is not `NULL', then all display-list indexes and
-definitions are shared by context SHARELIST and by the newly created
-context. An arbitrary number of contexts can share a single display-list
-space. However, all rendering contexts that share a single display-list
-space must themselves exist in the same address space. Two rendering
-contexts share an address space if both are nondirect using the same
-server, or if both are direct and owned by a single process. Note that
-in the nondirect case, it is not necessary for the calling threads to
-share an address space, only for their related rendering contexts to
-share an address space.
-
-If the GL version is 1.1 or greater, then all texture objects except
-object 0 are shared by any contexts that share display lists.
-
-
-Errors
-======
-
-`NULL' is returned if execution fails on the client side.
-
-`BadMatch' is generated if the context to be created would not share the
-address space or the screen of the context specified by SHARELIST.
-
-`BadValue' is generated if VIS is not a valid visual (for example, if a
-particular GLX implementation does not support it).
-
-`GLXBadContext' is generated if SHARELIST is not a GLX context and is
-not `NULL'.
-
-`BadAlloc' is generated if the server does not have enough resources to
-allocate the new context.")
-
-(define-gl-procedure
- glXCreateGLXPixmap
- "glXCreateGLXPixmap"
- (funcsynopsis
- (funcprototype
- (funcdef
- "GLXPixmap "
- (function "glXCreateGLXPixmap"))
- (paramdef "Display * " (parameter "dpy"))
- (paramdef "XVisualInfo * " (parameter "vis"))
- (paramdef "Pixmap " (parameter "pixmap"))))
- "create an off-screen GLX rendering area
-=======================================
-
-
-Parameters
-==========
-
-DPY
- Specifies the connection to the X server.
-
-VIS
- Specifies the visual that defines the structure of the rendering
- area. It is a pointer to an `XVisualInfo' structure, not a visual
- ID or a pointer to a `Visual'.
-
-PIXMAP
- Specifies the X pixmap that will be used as the front left color
- buffer of the off-screen rendering area.
-
-
-Description
-===========
-
-`glXCreateGLXPixmap' creates an off-screen rendering area and returns
-its XID. Any GLX rendering context that was created with respect to VIS
-can be used to render into this off-screen area. Use `glXMakeCurrent' to
-associate the rendering area with a GLX rendering context.
-
-The X pixmap identified by PIXMAP is used as the front left buffer of
-the resulting off-screen rendering area. All other buffers specified by
-VIS, including color buffers other than the front left buffer, are
-created without externally visible names. GLX pixmaps with
-double-buffering are supported. However, `glXSwapBuffers' is ignored by
-these pixmaps.
-
-Some implementations may not support GLX pixmaps with direct rendering
-contexts.
-
-
-Errors
-======
-
-`BadMatch' is generated if the depth of PIXMAP does not match the depth
-value reported by core X11 for VIS, or if PIXMAP was not created with
-respect to the same screen as VIS.
-
-`BadValue' is generated if VIS is not a valid XVisualInfo pointer (for
-example, if a particular GLX implementation does not support this
-visual).
-
-`BadPixmap' is generated if PIXMAP is not a valid pixmap.
-
-`BadAlloc' is generated if the server cannot allocate the GLX pixmap.")
-
-(define-gl-procedure
- glXCreateNewContext
- "glXCreateNewContext"
- (funcsynopsis
- (funcprototype
- (funcdef
- "GLXContext "
- (function "glXCreateNewContext"))
- (paramdef "Display * " (parameter "dpy"))
- (paramdef "GLXFBConfig " (parameter "config"))
- (paramdef "int " (parameter "render_type"))
- (paramdef "GLXContext " (parameter "share_list"))
- (paramdef "Bool " (parameter "direct"))))
- "create a new GLX rendering context
-==================================
-
-
-Parameters
-==========
-
-DPY
- Specifies the connection to the X server.
-
-CONFIG
- Specifies the GLXFBConfig structure with the desired attributes for
- the context.
-
-RENDER_TYPE
- Specifies the type of the context to be created. Must be one of
- `GLX_RGBA_TYPE' or `GLX_COLOR_INDEX_TYPE'.
-
-SHARE_LIST
- Specifies the context with which to share display lists. `NULL'
- indicates that no sharing is to take place.
-
-SHARE_LIST
- Specifies whether rendering is to be done with a direct connection
- to the graphics system if possible (`True') or through the X server
- (`False').
-
-
-Description
-===========
-
-`glXCreateNewContext' creates a GLX rendering context and returns its
-handle. This context can be used to render into GLX windows, pixmaps, or
-pixel buffers. If `glXCreateNewContext' fails to create a rendering
-context, `NULL' is returned.
-
-If RENDER_TYPE is `GLX_RGBA_TYPE', then a context that supports RGBA
-rendering is created. If CONFIG is `GLX_COLOR_INDEX_TYPE', then context
-supporting color-index rendering is created.
-
-If RENDER_TYPE is not `NULL', then all display-list indexes and
-definitions are shared by context RENDER_TYPE and by the newly created
-context. An arbitrary number of contexts can share a single display-list
-space. However, all rendering contexts that share a single display-list
-space must themselves exist in the same address space. Two rendering
-contexts share an address space if both are nondirect using the same
-server, or if both are direct and owned by a single process. Note that
-in the nondirect case, it is not necessary for the calling threads to
-share an address space, only for their related rendering contexts to
-share an address space.
-
-If SHARE_LIST is `True', then a direct-rendering context is created if
-the implementation supports direct rendering, if the connection is to an
-X server that is local, and if a direct-rendering context is available.
-(An implementation may return an indirect context when SHARE_LIST is
-`True'.) If SHARE_LIST is `False', then a rendering context that renders
-through the X server is always created. Direct rendering provides a
-performance advantage in some implementations. However, direct-rendering
-contexts cannot be shared outside a single process, and they may be
-unable to render to GLX pixmaps.
-
-
-Errors
-======
-
-`NULL' is returned if execution fails on the client side.
-
-`GLXBadContext' is generated if RENDER_TYPE is not a GLX context and is
-not `NULL'.
-
-`GLXBadFBConfig' is generated if CONFIG is not a valid GLXFBConfig.
-
-`BadMatch' is generated if the context to be created would not share the
-address space or the screen of the context specified by RENDER_TYPE.
-
-`BadAlloc' is generated if the server does not have enough resources to
-allocate the new context.
-
-`BadValue' is generated if CONFIG is not a valid visual (for example, if
-a particular GLX implementation does not support it).")
-
-(define-gl-procedure
- glXCreatePbuffer
- "glXCreatePbuffer"
- (funcsynopsis
- (funcprototype
- (funcdef
- "GLXPbuffer "
- (function "glXCreatePbuffer"))
- (paramdef "Display * " (parameter "dpy"))
- (paramdef "GLXFBConfig " (parameter "config"))
- (paramdef
- "const int * "
- (parameter "attrib_list"))))
- "create an off-screen rendering area
-===================================
-
-
-Parameters
-==========
-
-DPY
- Specifies the connection to the X server.
-
-CONFIG
- Specifies a GLXFBConfig structure with the desired attributes for
- the window.
-
-ATTRIB_LIST
- Specifies a list of attribute value pairs, which must be terminated
- with `None' or `NULL'. Accepted attributes are `GLX_PBUFFER_WIDTH',
- `GLX_PBUFFER_HEIGHT', `GLX_PRESERVED_CONTENTS', and
- `GLX_LARGEST_PBUFFER'.
-
-
-Description
-===========
-
-`glXCreatePbuffer' creates an off-screen rendering area and returns its
-XID. Any GLX rendering context that was created with respect to CONFIG
-can be used to render into this window. Use `glXMakeContextCurrent' to
-associate the rendering area with a GLX rendering context.
-
-The accepted attributes for a GLXPbuffer are:
-
-`GLX_PBUFFER_WIDTH'
- Specify the pixel width of the requested GLXPbuffer. The default
- value is 0.
-
-`GLX_PBUFFER_HEIGHT'
- Specify the pixel height of the requested GLXPbuffer. The default
- value is 0.
-
-`GLX_LARGEST_PBUFFER'
- Specify to obtain the largest available pixel buffer, if the
- requested allocation would have failed. The width and height of the
- allocated pixel buffer will never exceed the specified
- `GLX_PBUFFER_WIDTH' or `GLX_PBUFFER_HEIGHT', respectively. Use
- `glXQueryDrawable' to retrieve the dimensions of the allocated
- pixel buffer. The default value is `False'.
-
-`GLX_PRESERVED_CONTENTS'
- Specify if the contents of the pixel buffer should be preserved
- when a resource conflict occurs. If set to `False', the contents of
- the pixel buffer may be lost at any time. If set to `True', or not
- specified in ATTRIB_LIST, then the contents of the pixel buffer
- will be preserved (most likely by copying the contents into main
- system memory from the frame buffer). In either case, the client
- can register (using `glXSelectEvent', to receive pixel buffer
- clobber events that are generated when the pbuffer contents have
- been preserved or damaged.
-
-GLXPbuffers contain the color and ancillary buffers specified by CONFIG.
-It is possible to create a pixel buffer with back buffers and to swap
-those buffers using `glXSwapBuffers'.
-
-
-Errors
-======
-
-`BadAlloc' is generated if there are insufficient resources to allocate
-the requested GLXPbuffer.
-
-`GLXBadFBConfig' is generated if CONFIG is not a valid GLXFBConfig.
-
-`BadMatch' is generated if CONFIG does not support rendering to pixel
-buffers (e.g., `GLX_DRAWABLE_TYPE' does not contain `GLX_PBUFFER_BIT').")
-
-(define-gl-procedure
- glXCreatePixmap
- "glXCreatePixmap"
- (funcsynopsis
- (funcprototype
- (funcdef
- "GLXPixmap "
- (function "glXCreatePixmap"))
- (paramdef "Display * " (parameter "dpy"))
- (paramdef "GLXFBConfig " (parameter "config"))
- (paramdef "Pixmap " (parameter "pixmap"))
- (paramdef
- "const int * "
- (parameter "attrib_list"))))
- "create an off-screen rendering area
-===================================
-
-
-Parameters
-==========
-
-DPY
- Specifies the connection to the X server.
-
-CONFIG
- Specifies a GLXFBConfig structure with the desired attributes for
- the window.
-
-PIXMAP
- Specifies the X pixmap to be used as the rendering area.
-
-ATTRIB_LIST
- Currently unused. This must be set to `NULL' or be an empty list
- (i.e., one in which the first element is `None').
-
-
-Description
-===========
-
-`glXCreatePixmap' creates an off-screen rendering area and returns its
-XID. Any GLX rendering context that was created with respect to CONFIG
-can be used to render into this window. Use `glXMakeCurrent' to
-associate the rendering area with a GLX rendering context.
-
-
-Errors
-======
-
-`BadMatch' is generated if PIXMAP was not created with a visual that
-corresponds to CONFIG.
-
-`BadMatch' is generated if CONFIG does not support rendering to windows
-(e.g., `GLX_DRAWABLE_TYPE' does not contain `GLX_WINDOW_BIT').
-
-`BadWindow' is generated if PIXMAP is not a valid window XID. `BadAlloc'
-is generated if there is already a GLXFBConfig associated with PIXMAP.
-
-`BadAlloc' is generated if the X server cannot allocate a new GLX
-window.
-
-`GLXBadFBConfig' is generated if CONFIG is not a valid GLXFBConfig.")
-
-(define-gl-procedure
- glXCreateWindow
- "glXCreateWindow"
- (funcsynopsis
- (funcprototype
- (funcdef
- "GLXWindow "
- (function "glXCreateWindow"))
- (paramdef "Display * " (parameter "dpy"))
- (paramdef "GLXFBConfig " (parameter "config"))
- (paramdef "Window " (parameter "win"))
- (paramdef
- "const int * "
- (parameter "attrib_list"))))
- "create an on-screen rendering area
-==================================
-
-
-Parameters
-==========
-
-DPY
- Specifies the connection to the X server.
-
-CONFIG
- Specifies a GLXFBConfig structure with the desired attributes for
- the window.
-
-WIN
- Specifies the X window to be used as the rendering area.
-
-ATTRIB_LIST
- Currently unused. This must be set to `NULL' or be an empty list
- (i.e., one in which the first element is `None').
-
-
-Description
-===========
-
-`glXCreateWindow' creates an on-screen rendering area from an existing X
-window that was created with a visual matching CONFIG. The XID of the
-GLXWindow is returned. Any GLX rendering context that was created with
-respect to CONFIG can be used to render into this window. Use
-`glXMakeContextCurrent' to associate the rendering area with a GLX
-rendering context.
-
-
-Errors
-======
-
-`BadMatch' is generated if WIN was not created with a visual that
-corresponds to CONFIG.
-
-`BadMatch' is generated if CONFIG does not support rendering to windows
-(i.e., `GLX_DRAWABLE_TYPE' does not contain `GLX_WINDOW_BIT').
-
-`BadWindow' is generated if WIN is not a valid pixmap XID.
-
-`BadAlloc' is generated if there is already a GLXFBConfig associated
-with WIN.
-
-`BadAlloc' is generated if the X server cannot allocate a new GLX
-window.
-
-`GLXBadFBConfig' is generated if CONFIG is not a valid GLXFBConfig.")
-
-(define-gl-procedure
- glXDestroyContext
- "glXDestroyContext"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glXDestroyContext"))
- (paramdef "Display * " (parameter "dpy"))
- (paramdef "GLXContext " (parameter "ctx"))))
- "destroy a GLX context
-=====================
-
-
-Parameters
-==========
-
-DPY
- Specifies the connection to the X server.
-
-CTX
- Specifies the GLX context to be destroyed.
-
-
-Description
-===========
-
-If the GLX rendering context CTX is not current to any thread,
-`glXDestroyContext' destroys it immediately. Otherwise, CTX is destroyed
-when it becomes not current to any thread. In either case, the resource
-ID referenced by CTX is freed immediately.
-
-
-Errors
-======
-
-`GLXBadContext' is generated if CTX is not a valid GLX context.")
-
-(define-gl-procedure
- glXDestroyGLXPixmap
- "glXDestroyGLXPixmap"
- (funcsynopsis
- (funcprototype
- (funcdef
- "void "
- (function "glXDestroyGLXPixmap"))
- (paramdef "Display * " (parameter "dpy"))
- (paramdef "GLXPixmap " (parameter "pix"))))
- "destroy a GLX pixmap
-====================
-
-
-Parameters
-==========
-
-DPY
- Specifies the connection to the X server.
-
-PIX
- Specifies the GLX pixmap to be destroyed.
-
-
-Description
-===========
-
-If the GLX pixmap PIX is not current to any client,
-`glXDestroyGLXPixmap' destroys it immediately. Otherwise, PIX is
-destroyed when it becomes not current to any client. In either case, the
-resource ID is freed immediately.
-
-
-Errors
-======
-
-`GLXBadPixmap' is generated if PIX is not a valid GLX pixmap.")
-
-(define-gl-procedure
- glXDestroyPbuffer
- "glXDestroyPbuffer"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glXDestroyPbuffer"))
- (paramdef "Display * " (parameter "dpy"))
- (paramdef "GLXPbuffer " (parameter "pbuf"))))
- "destroy an off-screen rendering area
-====================================
-
-
-Parameters
-==========
-
-DPY
- Specifies the connection to the X server.
-
-PBUF
- Specifies the GLXPbuffer to be destroyed.
-
-
-Description
-===========
-
-`glXDestroyPbuffer' destroys a GLXPbuffer created by `glXCreatePbuffer'.
-
-
-Errors
-======
-
-`GLXBadPbuffer' is generated if PBUF is not a valid GLXPbuffer.")
-
-(define-gl-procedure
- glXDestroyPixmap
- "glXDestroyPixmap"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glXDestroyPixmap"))
- (paramdef "Display * " (parameter "dpy"))
- (paramdef "GLXPixmap " (parameter "pixmap"))))
- "destroy an off-screen rendering area
-====================================
-
-
-Parameters
-==========
-
-DPY
- Specifies the connection to the X server.
-
-PIXMAP
- Specifies the GLXPixmap to be destroyed.
-
-
-Description
-===========
-
-`glXDestroyPixmap' destroys a GLXPixmap created by `glXCreatePixmap'.
-
-
-Errors
-======
-
-`GLXBadPixmap' is generated if PIXMAP is not a valid GLXPixmap.")
-
-(define-gl-procedure
- glXDestroyWindow
- "glXDestroyWindow"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glXDestroyWindow"))
- (paramdef "Display * " (parameter "dpy"))
- (paramdef "GLXWindow " (parameter "win"))))
- "destroy an on-screen rendering area
-===================================
-
-
-Parameters
-==========
-
-DPY
- Specifies the connection to the X server.
-
-WIN
- Specifies the GLXWindow to be destroyed.
-
-
-Description
-===========
-
-`glXDestroyWindow' destroys a GLXWindow created by `glXCreateWindow'.
-
-
-Errors
-======
-
-`GLXBadWindow' is generated if WIN is not a valid GLXPixmap.")
-
-(define-gl-procedure
- glXFreeContextEXT
- "glXFreeContextEXT"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glXFreeContextEXT"))
- (paramdef "Display * " (parameter "dpy"))
- (paramdef "GLXContext " (parameter "ctx"))))
- "free client-side memory for imported context
-============================================
-
-
-Parameters
-==========
-
-DPY
- Specifies the connection to the X server.
-
-CTX
- Specifies a GLX rendering context.
-
-
-Description
-===========
-
-`glXFreeContextEXT' frees the client-side part of a GLXContext that was
-created with `glXImportContextEXT'. `glXFreeContextEXT' does not free
-the server-side context information or the XID associated with the
-server-side context.
-
-`glXFreeContextEXT' is part of the `EXT_import_context' extension, not
-part of the core GLX command set. If _glxextstring(EXT_import_context)
-is included in the string returned by `glXQueryExtensionsString', when
-called with argument `GLX_EXTENSIONS', extension `EXT_vertex_array' is
-supported.
-
-
-Errors
-======
-
-`GLXBadContext' is generated if CTX does not refer to a valid context.")
-
-(define-gl-procedure
- glXGetClientString
- "glXGetClientString"
- (funcsynopsis
- (funcprototype
- (funcdef
- "const char * "
- (function "glXGetClientString"))
- (paramdef "Display * " (parameter "dpy"))
- (paramdef "int " (parameter "name"))))
- "return a string describing the client
-=====================================
-
-
-Parameters
-==========
-
-DPY
- Specifies the connection to the X server.
-
-NAME
- Specifies which string is returned. The symbolic constants
- `GLX_VENDOR', `GLX_VERSION', and `GLX_EXTENSIONS' are accepted.
-
-
-Description
-===========
-
-`glXGetClientString' returns a string describing some aspect of the
-client library. The possible values for NAME are `GLX_VENDOR',
-`GLX_VERSION', and `GLX_EXTENSIONS'. If NAME is not set to one of these
-values, `glXGetClientString' returns `NULL'. The format and contents of
-the vendor string is implementation dependent.
-
-The extensions string is null-terminated and contains a space-separated
-list of extension names. (The extension names never contain spaces.) If
-there are no extensions to GLX, then the empty string is returned.
-
-The version string is laid out as follows:
-
-<major_version.minor_version><space><vendor-specific info>
-
-Both the major and minor portions of the version number are of arbitrary
-length. The vendor-specific information is optional. However, if it is
-present, the format and contents are implementation specific.")
-
-(define-gl-procedure
- glXGetConfig
- "glXGetConfig"
- (funcsynopsis
- (funcprototype
- (funcdef "int " (function "glXGetConfig"))
- (paramdef "Display * " (parameter "dpy"))
- (paramdef "XVisualInfo * " (parameter "vis"))
- (paramdef "int " (parameter "attrib"))
- (paramdef "int * " (parameter "value"))))
- "return information about GLX visuals
-====================================
-
-
-Parameters
-==========
-
-DPY
- Specifies the connection to the X server.
-
-VIS
- Specifies the visual to be queried. It is a pointer to an
- `XVisualInfo' structure, not a visual ID or a pointer to a
- `Visual'.
-
-ATTRIB
- Specifies the visual attribute to be returned.
-
-VALUE
- Returns the requested value.
-
-
-Description
-===========
-
-`glXGetConfig' sets VALUE to the ATTRIB value of windows or GLX pixmaps
-created with respect to VIS. `glXGetConfig' returns an error code if it
-fails for any reason. Otherwise, zero is returned.
-
-ATTRIB is one of the following:
-
-
-
-`GLX_USE_GL'
- `True' if OpenGL rendering is supported by this visual, `False'
- otherwise.
-
-`GLX_BUFFER_SIZE'
- Number of bits per color buffer. For RGBA visuals,
- `GLX_BUFFER_SIZE' is the sum of `GLX_RED_SIZE', `GLX_GREEN_SIZE',
- `GLX_BLUE_SIZE', and `GLX_ALPHA_SIZE'. For color index visuals,
- `GLX_BUFFER_SIZE' is the size of the color indexes.
-
-`GLX_LEVEL'
- Frame buffer level of the visual. Level zero is the default frame
- buffer. Positive levels correspond to frame buffers that overlay
- the default buffer, and negative levels correspond to frame buffers
- that underlay the default buffer.
-
-`GLX_RGBA'
- `True' if color buffers store red, green, blue, and alpha values.
- `False' if they store color indexes.
-
-`GLX_DOUBLEBUFFER'
- `True' if color buffers exist in front/back pairs that can be
- swapped, `False' otherwise.
-
-`GLX_STEREO'
- `True' if color buffers exist in left/right pairs, `False'
- otherwise.
-
-`GLX_AUX_BUFFERS'
- Number of auxiliary color buffers that are available. Zero
- indicates that no auxiliary color buffers exist.
-
-`GLX_RED_SIZE'
- Number of bits of red stored in each color buffer. Undefined if
- `GLX_RGBA' is `False'.
-
-`GLX_GREEN_SIZE'
- Number of bits of green stored in each color buffer. Undefined if
- `GLX_RGBA' is `False'.
-
-`GLX_BLUE_SIZE'
- Number of bits of blue stored in each color buffer. Undefined if
- `GLX_RGBA' is `False'.
-
-`GLX_ALPHA_SIZE'
- Number of bits of alpha stored in each color buffer. Undefined if
- `GLX_RGBA' is `False'.
-
-`GLX_DEPTH_SIZE'
- Number of bits in the depth buffer.
-
-`GLX_STENCIL_SIZE'
- Number of bits in the stencil buffer.
-
-`GLX_ACCUM_RED_SIZE'
- Number of bits of red stored in the accumulation buffer.
-
-`GLX_ACCUM_GREEN_SIZE'
- Number of bits of green stored in the accumulation buffer.
-
-`GLX_ACCUM_BLUE_SIZE'
- Number of bits of blue stored in the accumulation buffer.
-
-`GLX_ACCUM_ALPHA_SIZE'
- Number of bits of alpha stored in the accumulation buffer.
-
-The X protocol allows a single visual ID to be instantiated with
-different numbers of bits per pixel. Windows or GLX pixmaps that will be
-rendered with OpenGL, however, must be instantiated with a color buffer
-depth of `GLX_BUFFER_SIZE'.
-
-Although a GLX implementation can export many visuals that support GL
-rendering, it must support at least one RGBA visual. This visual must
-have at least one color buffer, a stencil buffer of at least 1 bit, a
-depth buffer of at least 12 bits, and an accumulation buffer. Alpha
-bitplanes are optional in this visual. However, its color buffer size
-must be as great as that of the deepest `TrueColor', `DirectColor',
-`PseudoColor', or `StaticColor' visual supported on level zero, and it
-must itself be made available on level zero.
-
-In addition, if the X server exports a `PseudoColor' or `StaticColor'
-visual on framebuffer level 0, a color index visual is also required on
-that level. It must have at least one color buffer, a stencil buffer of
-at least 1 bit, and a depth buffer of at least 12 bits. This visual must
-have as many color bitplanes as the deepest `PseudoColor' or
-`StaticColor' visual supported on level 0.
-
-Applications are best written to select the visual that most closely
-meets their requirements. Creating windows or GLX pixmaps with
-unnecessary buffers can result in reduced rendering performance as well
-as poor resource allocation.
-
-
-Errors
-======
-
-`GLX_NO_EXTENSION' is returned if DPY does not support the GLX
-extension.
-
-`GLX_BAD_SCREEN' is returned if the screen of VIS does not correspond to
-a screen.
-
-`GLX_BAD_ATTRIBUTE' is returned if ATTRIB is not a valid GLX attribute.
-
-`GLX_BAD_VISUAL' is returned if VIS doesn't support GLX and an attribute
-other than `GLX_USE_GL' is requested.")
-
-(define-gl-procedure
- glXGetContextIDEXT
- "glXGetContextIDEXT"
- (funcsynopsis
- (funcprototype
- (funcdef
- "GLXContextID "
- (function "glXGetContextIDEXT"))
- (paramdef "const GLXContext " (parameter "ctx"))))
- "get the XID for a context.
-==========================
-
-
-Parameters
-==========
-
-CTX
- Specifies a GLX rendering context.
-
-
-Description
-===========
-
-`glXGetContextIDEXT' returns the XID associated with a GLXContext.
-
-No round trip is forced to the server; unlike most X calls that return a
-value, `glXGetContextIDEXT' does not flush any pending events.
-
-`glXGetContextIDEXT' is part of the `EXT_import_context' extension, not
-part of the core GLX command set. If _glxextstring(EXT_import_context)
-is included in the string returned by `glXQueryExtensionsString', when
-called with argument `GLX_EXTENSIONS', extension `EXT_import_context' is
-supported.
-
-
-Errors
-======
-
-`GLXBadContext' is generated if CTX does not refer to a valid context.")
-
-(define-gl-procedure
- glXGetCurrentContext
- "glXGetCurrentContext"
- (funcsynopsis
- (funcprototype
- (funcdef
- "GLXContext "
- (function "glXGetCurrentContext"))))
- "return the current context
-==========================
-
-
-Description
-===========
-
-`glXGetCurrentContext' returns the current context, as specified by
-`glXMakeCurrent'. If there is no current context, `NULL' is returned.
-
-`glXGetCurrentContext' returns client-side information. It does not make
-a round trip to the server.")
-
-(define-gl-procedure
- glXGetCurrentDisplay
- "glXGetCurrentDisplay"
- (funcsynopsis
- (funcprototype
- (funcdef
- "Display * "
- (function "glXGetCurrentDisplay"))))
- "get display for current context
-===============================
-
-
-Description
-===========
-
-`glXGetCurrentDisplay' returns the display for the current context. If
-no context is current, `NULL' is returned.
-
-`glXGetCurrentDisplay' returns client-side information. It does not make
-a round-trip to the server, and therefore does not flush any pending
-events.")
-
-(define-gl-procedure
- glXGetCurrentDrawable
- "glXGetCurrentDrawable"
- (funcsynopsis
- (funcprototype
- (funcdef
- "GLXDrawable "
- (function "glXGetCurrentDrawable"))))
- "return the current drawable
-===========================
-
-
-Description
-===========
-
-`glXGetCurrentDrawable' returns the current drawable, as specified by
-`glXMakeCurrent'. If there is no current drawable, `None' is returned.
-
-`glXGetCurrentDrawable' returns client-side information. It does not
-make a round trip to the server.")
-
-(define-gl-procedure
- glXGetCurrentReadDrawable
- "glXGetCurrentReadDrawable"
- (funcsynopsis
- (funcprototype
- (funcdef
- "GLXDrawable "
- (function "glXGetCurrentReadDrawable"))))
- "return the current drawable
-===========================
-
-
-Description
-===========
-
-`glXGetCurrentReadDrawable' returns the current read drawable, as
-specified by `read' parameter of `glXMakeContextCurrent'. If there is no
-current drawable, `None' is returned.
-
-`glXGetCurrentReadDrawable' returns client-side information. It does not
-make a round-trip to the server.")
-
-(define-gl-procedure
- glXGetFBConfigAttrib
- "glXGetFBConfigAttrib"
- (funcsynopsis
- (funcprototype
- (funcdef
- "int "
- (function "glXGetFBConfigAttrib"))
- (paramdef "Display * " (parameter "dpy"))
- (paramdef "GLXFBConfig " (parameter "config"))
- (paramdef "int " (parameter "attribute"))
- (paramdef "int * " (parameter "value"))))
- "return information about a GLX frame buffer configuration
-=========================================================
-
-
-Parameters
-==========
-
-DPY
- Specifies the connection to the X server.
-
-CONFIG
- Specifies the GLX frame buffer configuration to be queried.
-
-ATTRIBUTE
- Specifies the attribute to be returned.
-
-VALUE
- Returns the requested value.
-
-
-Description
-===========
-
-`glXGetFBConfigAttrib' sets VALUE to the ATTRIBUTE value of GLX
-drawables created with respect to CONFIG. `glXGetFBConfigAttrib' returns
-an error code if it fails for any reason. Otherwise, `Success' is
-returned.
-
-ATTRIBUTE is one of the following:
-
-
-
-`GLX_FBCONFIG_ID'
- XID of the given GLXFBConfig.
-
-`GLX_BUFFER_SIZE'
-
-
- Number of bits per color buffer. If the frame buffer configuration
- supports RGBA contexts, then `GLX_BUFFER_SIZE' is the sum of
- `GLX_RED_SIZE', `GLX_GREEN_SIZE', `GLX_BLUE_SIZE', and
- `GLX_ALPHA_SIZE'. If the frame buffer configuration supports only
- color index contexts, `GLX_BUFFER_SIZE' is the size of the color
- indexes.
-
-`GLX_LEVEL'
-
-
- Frame buffer level of the configuration. Level zero is the default
- frame buffer. Positive levels correspond to frame buffers that
- overlay the default buffer, and negative levels correspond to frame
- buffers that underlie the default buffer.
-
-`GLX_DOUBLEBUFFER'
-
-
- `True' if color buffers exist in front/back pairs that can be
- swapped, `False' otherwise.
-
-`GLX_STEREO'
-
-
- `True' if color buffers exist in left/right pairs, `False'
- otherwise.
-
-`GLX_AUX_BUFFERS'
-
-
- Number of auxiliary color buffers that are available. Zero
- indicates that no auxiliary color buffers exist.
-
-`GLX_RED_SIZE'
-
-
- Number of bits of red stored in each color buffer. Undefined if
- RGBA contexts are not supported by the frame buffer configuration.
-
-`GLX_GREEN_SIZE'
-
-
- Number of bits of green stored in each color buffer. Undefined if
- RGBA contexts are not supported by the frame buffer configuration.
-
-`GLX_BLUE_SIZE'
-
-
- Number of bits of blue stored in each color buffer. Undefined if
- RGBA contexts are not supported by the frame buffer configuration.
-
-`GLX_ALPHA_SIZE'
-
-
- Number of bits of alpha stored in each color buffer. Undefined if
- RGBA contexts are not supported by the frame buffer configuration.
-
-`GLX_DEPTH_SIZE'
-
-
- Number of bits in the depth buffer.
-
-`GLX_STENCIL_SIZE'
-
-
- Number of bits in the stencil buffer.
-
-`GLX_ACCUM_RED_SIZE'
-
-
- Number of bits of red stored in the accumulation buffer.
-
-`GLX_ACCUM_GREEN_SIZE'
-
-
- Number of bits of green stored in the accumulation buffer.
-
-`GLX_ACCUM_BLUE_SIZE'
-
-
- Number of bits of blue stored in the accumulation buffer.
-
-`GLX_ACCUM_ALPHA_SIZE'
-
-
- Number of bits of alpha stored in the accumulation buffer.
-
-`GLX_RENDER_TYPE'
-
-
- Mask indicating what type of GLX contexts can be made current to
- the frame buffer configuration. Valid bits are `GLX_RGBA_BIT' and
- `GLX_COLOR_INDEX_BIT'.
-
-`GLX_DRAWABLE_TYPE'
-
-
- Mask indicating what drawable types the frame buffer configuration
- supports. Valid bits are `GLX_WINDOW_BIT', `GLX_PIXMAP_BIT', and
- `GLX_PBUFFER_BIT'.
-
-`GLX_X_RENDERABLE'
-
-
- `True' if drawables created with the frame buffer configuration can
- be rendered to by X.
-
-`GLX_VISUAL_ID'
-
-
- XID of the corresponding visual, or zero if there is no associated
- visual (i.e., if `GLX_X_RENDERABLE' is `False' or
- `GLX_DRAWABLE_TYPE' does not have the `GLX_WINDOW_BIT' bit set).
-
-`GLX_X_VISUAL_TYPE'
-
-
- Visual type of associated visual. The returned value will be one
- of: `GLX_TRUE_COLOR', `GLX_DIRECT_COLOR', `GLX_PSEUDO_COLOR',
- `GLX_STATIC_COLOR', `GLX_GRAY_SCALE', `GLX_STATIC_GRAY', or
- `GLX_NONE', if there is no associated visual (i.e., if
- `GLX_X_RENDERABLE' is `False' or `GLX_DRAWABLE_TYPE' does not have
- the `GLX_WINDOW_BIT' bit set).
-
-`GLX_CONFIG_CAVEAT'
-
-
- One of `GLX_NONE', `GLX_SLOW_CONFIG', or
- `GLX_NON_CONFORMANT_CONFIG', indicating that the frame buffer
- configuration has no caveats, some aspect of the frame buffer
- configuration runs slower than other frame buffer configurations,
- or some aspect of the frame buffer configuration is nonconformant,
- respectively.
-
-`GLX_TRANSPARENT_TYPE'
-
-
- One of `GLX_NONE', `GLX_TRANSPARENT_RGB', `GLX_TRANSPARENT_INDEX',
- indicating that the frame buffer configuration is opaque, is
- transparent for particular values of red, green, and blue, or is
- transparent for particular index values, respectively.
-
-`GLX_TRANSPARENT_INDEX_VALUE'
-
-
- Integer value between 0 and the maximum frame buffer value for
- indices, indicating the transparent index value for the frame
- buffer configuration. Undefined if `GLX_TRANSPARENT_TYPE' is not
- `GLX_TRANSPARENT_INDEX'.
-
-`GLX_TRANSPARENT_RED_VALUE'
-
-
- Integer value between 0 and the maximum frame buffer value for red,
- indicating the transparent red value for the frame buffer
- configuration. Undefined if `GLX_TRANSPARENT_TYPE' is not
- `GLX_TRANSPARENT_RGB'.
-
-`GLX_TRANSPARENT_GREEN_VALUE'
-
-
- Integer value between 0 and the maximum frame buffer value for
- green, indicating the transparent green value for the frame buffer
- configuration. Undefined if `GLX_TRANSPARENT_TYPE' is not
- `GLX_TRANSPARENT_RGB'.
-
-`GLX_TRANSPARENT_BLUE_VALUE'
-
-
- Integer value between 0 and the maximum frame buffer value for
- blue, indicating the transparent blue value for the frame buffer
- configuration. Undefined if `GLX_TRANSPARENT_TYPE' is not
- `GLX_TRANSPARENT_RGB'.
-
-`GLX_TRANSPARENT_ALPHA_VALUE'
-
-
- Integer value between 0 and the maximum frame buffer value for
- alpha, indicating the transparent blue value for the frame buffer
- configuration. Undefined if `GLX_TRANSPARENT_TYPE' is not
- `GLX_TRANSPARENT_RGB'.
-
-`GLX_MAX_PBUFFER_WIDTH'
-
-
- The maximum width that can be specified to `glXCreatePbuffer'.
-
-`GLX_MAX_PBUFFER_HEIGHT'
-
-
- The maximum height that can be specified to `glXCreatePbuffer'.
-
-`GLX_MAX_PBUFFER_PIXELS'
-
-
- The maximum number of pixels (width times height) for a pixel
- buffer. Note that this value may be less than
- `GLX_MAX_PBUFFER_WIDTH' times `GLX_MAX_PBUFFER_HEIGHT'. Also, this
- value is static and assumes that no other pixel buffers or X
- resources are contending for the frame buffer memory. As a result,
- it may not be possible to allocate a pixel buffer of the size given
- by `GLX_MAX_PBUFFER_PIXELS'.
-
-Applications should choose the frame buffer configuration that most
-closely meets their requirements. Creating windows, GLX pixmaps, or GLX
-pixel buffers with unnecessary buffers can result in reduced rendering
-performance as well as poor resource allocation.
-
-
-Errors
-======
-
-`GLX_NO_EXTENSION' is returned if DPY does not support the GLX
-extension. `GLX_BAD_ATTRIBUTE' is returned if ATTRIBUTE is not a valid
-GLX attribute.")
-
-(define-gl-procedure
- glXGetFBConfigs
- "glXGetFBConfigs"
- (funcsynopsis
- (funcprototype
- (funcdef
- "GLXFBConfig * "
- (function "glXGetFBConfigs"))
- (paramdef "Display * " (parameter "dpy"))
- (paramdef "int " (parameter "screen"))
- (paramdef "int * " (parameter "nelements"))))
- "list all GLX frame buffer configurations for a given screen
-===========================================================
-
-
-Parameters
-==========
-
-DPY
- Specifies the connection to the X server.
-
-SCREEN
- Specifies the screen number.
-
-NELEMENTS
- Returns the number of GLXFBConfigs returned.
-
-
-Description
-===========
-
-`glXGetFBConfigs' returns a list of all GLXFBConfigs available on the
-screen specified by SCREEN. Use `glXGetFBConfigAttrib' to obtain
-attribute values from a specific GLXFBConfig.")
-
-(define-gl-procedure
- glXGetProcAddress
- "glXGetProcAddress"
- (funcsynopsis
- (funcprototype
- (funcdef
- "void(*)() "
- (function "glXGetProcAddress"))
- (paramdef
- "const GLubyte * "
- (parameter "procName"))))
- "obtain a pointer to an OpenGL or GLX function
-=============================================
-
-
-Parameters
-==========
-
-PROCNAME
- Specifies the name of the OpenGL or GLX function whose address is
- to be returned.
-
-
-Description
-===========
-
-`glXGetProcAddress' returns the address of the function specified in
-PROCNAME. This is necessary in environments where the OpenGL link
-library exports a different set of functions than the runtime library.")
-
-(define-gl-procedure
- glXGetSelectedEvent
- "glXGetSelectedEvent"
- (funcsynopsis
- (funcprototype
- (funcdef
- "void "
- (function "glXGetSelectedEvent"))
- (paramdef "Display * " (parameter "dpy"))
- (paramdef "GLXDrawable " (parameter "draw"))
- (paramdef
- "unsigned long * "
- (parameter "event_mask"))))
- "returns GLX events that are selected for a window or a GLX pixel buffer
-=======================================================================
-
-
-Parameters
-==========
-
-DPY
- Specifies the connection to the X server.
-
-DRAW
- Specifies a GLX drawable. Must be a GLX pixel buffer or a window.
-
-EVENT_MASK
- Returns the events that are selected for DRAW.
-
-
-Description
-===========
-
-`glXGetSelectedEvent' returns in EVENT_MASK the events selected for
-DRAW.
-
-
-Errors
-======
-
-`GLXBadDrawable' is generated if DRAW is not a valid window or a valid
-GLX pixel buffer.")
-
-(define-gl-procedure
- glXGetVisualFromFBConfig
- "glXGetVisualFromFBConfig"
- (funcsynopsis
- (funcprototype
- (funcdef
- "XVisualInfo * "
- (function "glXGetVisualFromFBConfig"))
- (paramdef "Display * " (parameter "dpy"))
- (paramdef "GLXFBConfig " (parameter "config"))))
- "return visual that is associated with the frame buffer configuration
-====================================================================
-
-
-Parameters
-==========
-
-DPY
- Specifies the connection to the X server.
-
-CONFIG
- Specifies the GLX frame buffer configuration.
-
-
-Description
-===========
-
-If CONFIG is a valid GLX frame buffer configuration and it has an
-associated X Visual, then information describing that visual is
-returned; otherwise `NULL' is returned. Use `XFree' to free the data
-returned.
-
-
-Errors
-======
-
-Returns `NULL' if CONFIG is not a valid GLXFBConfig.")
-
-(define-gl-procedure
- glXImportContextEXT
- "glXImportContextEXT"
- (funcsynopsis
- (funcprototype
- (funcdef
- "GLXContext "
- (function "glXImportContextEXT"))
- (paramdef "Display * " (parameter "dpy"))
- (paramdef
- "GLXContextID "
- (parameter "contextID"))))
- "import another process's indirect rendering context.
-====================================================
-
-
-Parameters
-==========
-
-DPY
- Specifies the connection to the X server.
-
-CONTEXTID
- Specifies a GLX rendering context.
-
-
-Description
-===========
-
-`glXImportContextEXT' creates a GLXContext given the XID of an existing
-GLXContext. It may be used in place of `glXCreateContext', to share
-another process's indirect rendering context.
-
-Only the server-side context information can be shared between X
-clients; client-side state, such as pixel storage modes, cannot be
-shared. Thus, `glXImportContextEXT' must allocate memory to store
-client-side information. This memory is freed by calling
-`glXFreeContextEXT'.
-
-This call does not create a new XID. It merely makes an existing object
-available to the importing client (Display *). Like any XID, it goes
-away when the creating client drops its connection or the ID is
-explicitly deleted. Note that this is when the XID goes away. The object
-goes away when the XID goes away AND the context is not current to any
-thread.
-
-If CONTEXTID refers to a direct rendering context then no error is
-generated but `glXImportContextEXT' returns NULL.
-
-`glXImportContextEXT' is part of the `EXT_import_context' extension, not
-part of the core GLX command set. If _glxextstring(EXT_import_context)
-is included in the string returned by `glXQueryExtensionsString', when
-called with argument `GLX_EXTENSIONS', extension `EXT_import_context' is
-supported.
-
-
-Errors
-======
-
-`GLXBadContext' is generated if CONTEXTID does not refer to a valid
-context.")
-
-(define-gl-procedure
- glXIntro
- "glXIntro"
- #f
- "Introduction to OpenGL in the X window system
-=============================================")
-
-(define-gl-procedure
- glXIsDirect
- "glXIsDirect"
- (funcsynopsis
- (funcprototype
- (funcdef "Bool " (function "glXIsDirect"))
- (paramdef "Display * " (parameter "dpy"))
- (paramdef "GLXContext " (parameter "ctx"))))
- "indicate whether direct rendering is enabled
-============================================
-
-
-Parameters
-==========
-
-DPY
- Specifies the connection to the X server.
-
-CTX
- Specifies the GLX context that is being queried.
-
-
-Description
-===========
-
-`glXIsDirect' returns `True' if CTX is a direct rendering context,
-`False' otherwise. Direct rendering contexts pass rendering commands
-directly from the calling process's address space to the rendering
-system, bypassing the X server. Nondirect rendering contexts pass all
-rendering commands to the X server.
-
-
-Errors
-======
-
-`GLXBadContext' is generated if CTX is not a valid GLX context.")
-
-(define-gl-procedure
- glXMakeContextCurrent
- "glXMakeContextCurrent"
- (funcsynopsis
- (funcprototype
- (funcdef
- "Bool "
- (function "glXMakeContextCurrent"))
- (paramdef "Display * " (parameter "display"))
- (paramdef "GLXDrawable " (parameter "draw"))
- (paramdef "GLXDrawable " (parameter "read"))
- (paramdef "GLXContext " (parameter "ctx"))))
- "attach a GLX context to a GLX drawable
-======================================
-
-
-Parameters
-==========
-
-DISPLAY
- Specifies the connection to the X server.
-
-DRAW
- Specifies a GLX drawable to render into. Must be an XID
- representing a GLXWindow, GLXPixmap, or GLXPbuffer.
-
-READ
- Specifies a GLX drawable to read from. Must be an XID representing
- a GLXWindow, GLXPixmap, or GLXPbuffer.
-
-CTX
- Specifies the GLX context to be bound to READ and CTX.
-
-
-Description
-===========
-
-`glXMakeContextCurrent' binds CTX to the current rendering thread and to
-the DRAW and READ GLX drawables. DRAW and READ may be the same.
-
-DRAW is used for all OpenGL operations except:
-
-Any pixel data that are read based on the value of `GLX_READ_BUFFER'.
-Note that accumulation operations use the value of `GLX_READ_BUFFER',
-but are not allowed unless DRAW is identical to READ.
-
-Any depth values that are retrieved by `glReadPixels' or `glCopyPixels'.
-
-Any stencil values that are retrieved by `glReadPixels' or
-`glCopyPixels'.
-
-Frame buffer values are taken from DRAW.
-
-If the current rendering thread has a current rendering context, that
-context is flushed and replaced by CTX.
-
-The first time that CTX is made current, the viewport and scissor
-dimensions are set to the size of the DRAW drawable. The viewport and
-scissor are not modified when CTX is subsequently made current.
-
-To release the current context without assigning a new one, call
-`glXMakeContextCurrent' with DRAW and READ set to `None' and CTX set to
-`NULL'.
-
-`glXMakeContextCurrent' returns `True' if it is successful, `False'
-otherwise. If `False' is returned, the previously current rendering
-context and drawable (if any) remain unchanged.
-
-
-Errors
-======
-
-`BadMatch' is generated if DRAW and READ are not compatible.
-
-`BadAccess' is generated if CTX is current to some other thread.
-
-`GLXContextState' is generated if there is a current rendering context
-and its render mode is either `GLX_FEEDBACK' or `GLX_SELECT'.
-
-`GLXBadContext' is generated if CTX is not a valid GLX rendering
-context.
-
-`GLXBadDrawable' is generated if DRAW or READ is not a valid GLX
-drawable.
-
-`GLXBadWindow' is generated if the underlying X window for either DRAW
-or READ is no longer valid.
-
-`GLXBadCurrentDrawable' is generated if the previous context of the
-calling thread has unflushed commands and the previous drawable is no
-longer valid.
-
-`BadAlloc' is generated if the X server does not have enough resources
-to allocate the buffers.
-
-`BadMatch' is generated if:
-
-DRAW and READ cannot fit into frame buffer memory simultaneously.
-
-DRAW or READ is a GLXPixmap and CTX is a direct-rendering context.
-
-DRAW or READ is a GLXPixmap and CTX was previously bound to a GLXWindow
-or GLXPbuffer.
-
-DRAW or READ is a GLXWindow or GLXPbuffer and CTX was previously bound
-to a GLXPixmap.")
-
-(define-gl-procedure
- glXMakeCurrent
- "glXMakeCurrent"
- (funcsynopsis
- (funcprototype
- (funcdef "Bool " (function "glXMakeCurrent"))
- (paramdef "Display * " (parameter "dpy"))
- (paramdef "GLXDrawable " (parameter "drawable"))
- (paramdef "GLXContext " (parameter "ctx"))))
- "attach a GLX context to a window or a GLX pixmap
-================================================
-
-
-Parameters
-==========
-
-DPY
- Specifies the connection to the X server.
-
-DRAWABLE
- Specifies a GLX drawable. Must be either an X window ID or a GLX
- pixmap ID.
-
-CTX
- Specifies a GLX rendering context that is to be attached to
- DRAWABLE.
-
-
-Description
-===========
-
-`glXMakeCurrent' does two things: It makes CTX the current GLX rendering
-context of the calling thread, replacing the previously current context
-if there was one, and it attaches CTX to a GLX drawable, either a window
-or a GLX pixmap. As a result of these two actions, subsequent GL
-rendering calls use rendering context CTX to modify GLX drawable
-DRAWABLE (for reading and writing). Because `glXMakeCurrent' always
-replaces the current rendering context with CTX, there can be only one
-current context per thread.
-
-Pending commands to the previous context, if any, are flushed before it
-is released.
-
-The first time CTX is made current to any thread, its viewport is set to
-the full size of DRAWABLE. Subsequent calls by any thread to
-`glXMakeCurrent' with CTX have no effect on its viewport.
-
-To release the current context without assigning a new one, call
-`glXMakeCurrent' with DRAWABLE set to `None' and CTX set to `NULL'.
-
-`glXMakeCurrent' returns `True' if it is successful, `False' otherwise.
-If `False' is returned, the previously current rendering context and
-drawable (if any) remain unchanged.
-
-
-Errors
-======
-
-`BadMatch' is generated if DRAWABLE was not created with the same X
-screen and visual as CTX. It is also generated if DRAWABLE is `None' and
-CTX is not `NULL'.
-
-`BadAccess' is generated if CTX was current to another thread at the
-time `glXMakeCurrent' was called.
-
-`GLXBadDrawable' is generated if DRAWABLE is not a valid GLX drawable.
-
-`GLXBadContext' is generated if CTX is not a valid GLX context.
-
-`GLXBadContextState' is generated if `glXMakeCurrent' is executed
-between the execution of `glBegin' and the corresponding execution of
-`glEnd'.
-
-`GLXBadContextState' is also generated if the rendering context current
-to the calling thread has GL renderer state `GLX_FEEDBACK' or
-`GLX_SELECT'.
-
-`GLXBadCurrentWindow' is generated if there are pending GL commands for
-the previous context and the current drawable is a window that is no
-longer valid.
-
-`BadAlloc' may be generated if the server has delayed allocation of
-ancillary buffers until `glXMakeCurrent' is called, only to find that it
-has insufficient resources to complete the allocation.")
-
-(define-gl-procedure
- glXQueryContextInfoEXT
- "glXQueryContextInfoEXT"
- (funcsynopsis
- (funcprototype
- (funcdef
- "int "
- (function "glXQueryContextInfoEXT"))
- (paramdef "Display * " (parameter "dpy"))
- (paramdef "GLXContext " (parameter "ctx"))
- (paramdef "int " (parameter "attribute"))
- (paramdef "int * " (parameter "value"))))
- "query context information
-=========================
-
-
-Parameters
-==========
-
-DPY
- Specifies the connection to the X server.
-
-CTX
- Specifies a GLX rendering context.
-
-ATTRIBUTE
- Specifies that a context parameter should be retrieved. Must be one
- of `GLX_SHARED_CONTEXT_EXT', `GLX_VISUAL_ID_EXT', or
- `GLX_SCREEN_EXT'.
-
-VALUE
- Contains the return value for ATTRIBUTE.
-
-
-Description
-===========
-
-`glXQueryContextInfoEXT' sets VALUE to the value of ATTRIBUTE with
-respect to CTX. `glXQueryContextInfoEXT' returns an error code if it
-fails for any reason. Otherwise, `Success' is returned.
-
-ATTRIBUTE may be one of the following:
-
-`GLX_SHARED_CONTEXT_EXT'
- Returns the XID of the share list context associated with CTX at
- its creation.
-
-`GLX_VISUAL_ID_EXT'
- Returns the XID of the GLX Visual associated with CTX.
-
-`GLX_SCREEN_EXT'
- Returns the screen number associated with CTX.
-
-This call may cause a round-trip to the server.
-
-`glXQueryContextInfoEXT' is part of the `EXT_import_context' extension,
-not part of the core GLX command set. If
-_glxextstring(EXT_import_context) is included in the string returned by
-`glXQueryExtensionsString', when called with argument `GLX_EXTENSIONS',
-extension `EXT_import_context' is supported.
-
-
-Errors
-======
-
-`GLXBadContext' is generated if CTX does not refer to a valid context.
-
-`GLX_BAD_ATTRIBUTE' is returned if ATTRIBUTE is not a valid GLX context
-attribute.
-
-fred `GLX_BAD_CONTEXT' is returned if ATTRIBUTE is not a valid context.")
-
-(define-gl-procedure
- glXQueryContext
- "glXQueryContext"
- (funcsynopsis
- (funcprototype
- (funcdef "int " (function "glXQueryContext"))
- (paramdef "Display * " (parameter "dpy"))
- (paramdef "GLXContext " (parameter "ctx"))
- (paramdef "int " (parameter "attribute"))
- (paramdef "int * " (parameter "value"))))
- "query context information
-=========================
-
-
-Parameters
-==========
-
-DPY
- Specifies the connection to the X server.
-
-CTX
- Specifies a GLX rendering context.
-
-ATTRIBUTE
- Specifies that a context parameter should be retrieved. Must be one
- of `GLX_FBCONFIG_ID', `GLX_RENDER_TYPE', or `GLX_SCREEN'.
-
-VALUE
- Contains the return value for ATTRIBUTE.
-
-
-Description
-===========
-
-`glXQueryContext' sets VALUE to the value of ATTRIBUTE with respect to
-CTX. ATTRIBUTE may be one of the following:
-
-`GLX_FBCONFIG_ID'
- Returns the XID of the GLXFBConfig associated with CTX.
-
-`GLX_RENDER_TYPE'
- Returns the rendering type supported by CTX.
-
-`GLX_SCREEN'
- Returns the screen number associated with CTX.
-
-`Success' is returned unless ATTRIBUTE is not a valid GLX context
-attribute, in which case `GLX_BAD_ATTRIBUTE' is returned.
-
-This call may cause a round-trip to the server.
-
-
-Errors
-======
-
-`GLXBadContext' is generated if CTX does not refer to a valid context.")
-
-(define-gl-procedure
- glXQueryDrawable
- "glXQueryDrawable"
- (funcsynopsis
- (funcprototype
- (funcdef "int " (function "glXQueryDrawable"))
- (paramdef "Display * " (parameter "dpy"))
- (paramdef "GLXDrawable " (parameter "draw"))
- (paramdef "int " (parameter "attribute"))
- (paramdef "unsigned int * " (parameter "value"))))
- "returns an attribute assoicated with a GLX drawable
-===================================================
-
-
-Parameters
-==========
-
-DPY
- Specifies the connection to the X server.
-
-DRAW
- Specifies the GLX drawable to be queried.
-
-ATTRIBUTE
- Specifies the attribute to be returned. Must be one of `GLX_WIDTH',
- `GLX_HEIGHT', `GLX_PRESERVED_CONTENTS', `GLX_LARGEST_PBUFFER', or
- `GLX_FBCONFIG_ID'.
-
-VALUE
- Contains the return value for ATTRIBUTE.
-
-
-Description
-===========
-
-`glXQueryDrawable' sets VALUE to the value of ATTRIBUTE with respect to
-the GLXDrawable DRAW.
-
-ATTRIBUTE may be one of the following:
-
-`GLX_WIDTH'
- Returns the width of CTX.
-
-`GLX_HEIGHT'
- Returns the height of CTX.
-
-`GLX_PRESERVED_CONTENTS'
- Returns `True' if the contents of a GLXPbuffer are preserved when a
- resource conflict occurs; `False' otherwise.
-
-`GLX_LARGEST_PBUFFER'
- Returns the value set when `glXCreatePbuffer' was called to create
- the GLXPbuffer. If `False' is returned, then the call to
- `glXCreatePbuffer' will fail to create a GLXPbuffer if the
- requested size is larger than the implementation maximum or
- available resources. If `True' is returned, a GLXPbuffer of the
- maximum availble size (if less than the requested width and height)
- is created.
-
-`GLX_FBCONFIG_ID'
- Returns the XID for DRAW.
-
-If DRAW is a GLXWindow or GLXPixmap and ATTRIBUTE is set to
-`GLX_PRESERVED_CONTENTS' or `GLX_LARGETST_PBUFFER', the contents of
-VALUE are undefined. If ATTRIBUTE is not one of the attributes listed
-above, the contents of VALUE are unedfined.
-
-
-Errors
-======
-
-A `GLXBadDrawable' is generated if DRAW is not a valid GLXDrawable.")
-
-(define-gl-procedure
- glXQueryExtensionsString
- "glXQueryExtensionsString"
- (funcsynopsis
- (funcprototype
- (funcdef
- "const char * "
- (function "glXQueryExtensionsString"))
- (paramdef "Display * " (parameter "dpy"))
- (paramdef "int " (parameter "screen"))))
- "return list of supported extensions
-===================================
-
-
-Parameters
-==========
-
-DPY
- Specifies the connection to the X server.
-
-SCREEN
- Specifies the screen number.
-
-
-Description
-===========
-
-`glXQueryExtensionsString' returns a pointer to a string describing
-which GLX extensions are supported on the connection. The string is
-null-terminated and contains a space-separated list of extension names.
-(The extension names themselves never contain spaces.) If there are no
-extensions to GLX, then the empty string is returned.")
-
-(define-gl-procedure
- glXQueryExtension
- "glXQueryExtension"
- (funcsynopsis
- (funcprototype
- (funcdef "Bool " (function "glXQueryExtension"))
- (paramdef "Display * " (parameter "dpy"))
- (paramdef "int * " (parameter "errorBase"))
- (paramdef "int * " (parameter "eventBase"))))
- "indicate whether the GLX extension is supported
-===============================================
-
-
-Parameters
-==========
-
-DPY
- Specifies the connection to the X server.
-
-ERRORBASE
- Returns the base error code of the GLX server extension.
-
-EVENTBASE
- Returns the base event code of the GLX server extension.
-
-
-Description
-===========
-
-`glXQueryExtension' returns `True' if the X server of connection DPY
-supports the GLX extension, `False' otherwise. If `True' is returned,
-then ERRORBASE and EVENTBASE return the error base and event base of the
-GLX extension. These values should be added to the constant error and
-event values to determine the actual event or error values. Otherwise,
-ERRORBASE and EVENTBASE are unchanged.
-
-ERRORBASE and EVENTBASE do not return values if they are specified as
-`NULL'.")
-
-(define-gl-procedure
- glXQueryServerString
- "glXQueryServerString"
- (funcsynopsis
- (funcprototype
- (funcdef
- "const char * "
- (function "glXQueryServerString"))
- (paramdef "Display * " (parameter "dpy"))
- (paramdef "int " (parameter "screen"))
- (paramdef "int " (parameter "name"))))
- "return string describing the server
-===================================
-
-
-Parameters
-==========
-
-DPY
- Specifies the connection to the X server.
-
-SCREEN
- Specifies the screen number.
-
-NAME
- Specifies which string is returned: one of `GLX_VENDOR',
- `GLX_VERSION', or `GLX_EXTENSIONS'.
-
-
-Description
-===========
-
-`glXQueryServerString' returns a pointer to a static, null-terminated
-string describing some aspect of the server's GLX extension. The
-possible values for NAME and the format of the strings is the same as
-for `glXGetClientString'. If NAME is not set to a recognized value,
-`NULL' is returned.")
-
-(define-gl-procedure
- glXQueryVersion
- "glXQueryVersion"
- (funcsynopsis
- (funcprototype
- (funcdef "Bool " (function "glXQueryVersion"))
- (paramdef "Display * " (parameter "dpy"))
- (paramdef "int * " (parameter "major"))
- (paramdef "int * " (parameter "minor"))))
- "return the version numbers of the GLX extension
-===============================================
-
-
-Parameters
-==========
-
-DPY
- Specifies the connection to the X server.
-
-MAJOR
- Returns the major version number of the GLX server extension.
-
-MINOR
- Returns the minor version number of the GLX server extension.
-
-
-Description
-===========
-
-`glXQueryVersion' returns the major and minor version numbers of the GLX
-extension implemented by the server associated with connection DPY.
-Implementations with the same major version number are upward
-compatible, meaning that the implementation with the higher minor number
-is a superset of the version with the lower minor number.
-
-MAJOR and MINOR do not return values if they are specified as `NULL'.
-
-
-Errors
-======
-
-`glXQueryVersion' returns `False' if it fails, `True' otherwise.
-
-MAJOR and MINOR are not updated when `False' is returned.")
-
-(define-gl-procedure
- glXSelectEvent
- "glXSelectEvent"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glXSelectEvent"))
- (paramdef "Display * " (parameter "dpy"))
- (paramdef "GLXDrawable " (parameter "draw"))
- (paramdef
- "unsigned long "
- (parameter "event_mask"))))
- "select GLX events for a window or a GLX pixel buffer
-====================================================
-
-
-Parameters
-==========
-
-DPY
- Specifies the connection to the X server.
-
-DRAW
- Specifies a GLX drawable. Must be a GLX pixel buffer or a window.
-
-EVENT_MASK
- Specifies the events to be returned for DRAW.
-
-
-Description
-===========
-
-`glXSelectEvent' sets the GLX event mask for a GLX pixel buffer or a
-window. Calling `glXSelectEvent' overrides any previous event mask that
-was set by the client for DRAW. Note that it does not affect the event
-masks that other clients may have specified for DRAW since each client
-rendering to DRAW has a separate event mask for it.
-
-Currently, only one GLX event, `GLX_PBUFFER_CLOBBER_MASK', can be
-selected. The following data is returned to the client when a
-`GLX_PBUFFER_CLOBBER_MASK' event occurs:
-
-typedef struct {
-
-int EVENT_TYPE;
-
-/* GLX_DAMAGED or GLX_SAVED */ int DRAW_TYPE;
-
-/* GLX_WINDOW or GLX_PBUFFER */ unsigned long SERIAL;
-
-/* # of last request processed by server */ Bool SEND_EVENT;
-
-/* true if this came for SendEvent request */ Display *DISPLAY;
-
-/* display the event was read from */ GLXDrawable DRAWABLE;
-
-/* i.d. of Drawable */ unsigned int BUFFER_MASK;
-
-/* mask indicating affected buffers */ int X, Y;
-int WIDTH, HEIGHT;
-int COUNT;
-
-/* if nonzero, at least this many more */ } GLXPbufferClobberEvent; The valid bit masks used in BUFFER_MASK are:
-
-
-
-* Bitmask *
-*
-Corresponding Buffer *`GLX_FRONT_LEFT_BUFFER_BIT'
-
-Front left color buffer `GLX_FRONT_RIGHT_BUFFER_BIT'
-
-Front right color buffer `GLX_BACK_LEFT_BUFFER_BIT'
-
-Back left color buffer `GLX_BACK_RIGHT_BUFFER_BIT'
-
-Back right color buffer `GLX_AUX_BUFFERS_BIT'
-
-Auxiliary buffer `GLX_DEPTH_BUFFER_BIT'
-
-Depth buffer `GLX_STENCIL_BUFFER_BIT'
-
-Stencil buffer `GLX_ACCUM_BUFFER_BIT'
-
-Accumulation buffer A single X server operation can cause several buffer clobber events to
-be sent. (e.g., a single GLX pixel buffer may be damaged and cause
-multiple buffer clobber events to be generated). Each event specifies
-one region of the GLX drawable that was affected by the X Server
-operation. The BUFFER_MASK field indicates which color buffers and
-ancillary buffers were affected. All the buffer clobber events generated
-by a single X server action are guaranteed to be contiguous in the event
-queue. The conditions under which this event is generated and the
-EVENT_TYPE varies, depending on the type of the GLX drawable.
-
-When the `GLX_AUX_BUFFERS_BIT' is set in BUFFER_MASK, then AUX_BUFFER is
-set to indicate which buffer was affected. If more than one aux buffer
-was affected, then additional events are generated as part of the same
-contiguous event group. Each additional event will have only the
-`GLX_AUX_BUFFERS_BIT' set in BUFFER_MASK, and the AUX_BUFFER field will
-be set appropriately. For nonstereo drawables,
-`GLX_FRONT_LEFT_BUFFER_BIT' and `GLX_BACK_LEFT_BUFFER_BIT' are used to
-specify the front and back color buffers.
-
-For preserved GLX pixel buffers, a buffer clobber event with type
-`GLX_SAVED' is generated whenever the contents of the GLX pixel buffer
-is moved out of offscreen memory. The event(s) describes which portions
-of the GLX pixel buffer were affected. Clients who receive many buffer
-clobber events, referring to different save actions, should consider
-freeing the GLX pixel buffer resource in order to prevent the system
-from thrashing due to insufficient resources.
-
-For an unpreserved GLXPbuffer, a buffer clobber event, with type
-`GLX_DAMAGED', is generated whenever a portion of the GLX pixel buffer
-becomes invalid. The client may wish to regenerate the invalid portions
-of the GLX pixel buffer.
-
-For Windows, buffer clobber events, with type `GLX_SAVED', occur
-whenever an ancillary buffer, associated with the window, gets clobbered
-or moved out of off-screen memory. The event contains information
-indicating which color buffers and ancillary buffers\\(emand which
-portions of those buffers\\(emwere affected.
-
-
-Errors
-======
-
-`GLXBadDrawable' is generated if DRAW is not a valid window or a valid
-GLX pixel buffer.")
-
-(define-gl-procedure
- glXSwapBuffers
- "glXSwapBuffers"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glXSwapBuffers"))
- (paramdef "Display * " (parameter "dpy"))
- (paramdef "GLXDrawable " (parameter "drawable"))))
- "exchange front and back buffers
-===============================
-
-
-Parameters
-==========
-
-DPY
- Specifies the connection to the X server.
-
-DRAWABLE
- Specifies the drawable whose buffers are to be swapped.
-
-
-Description
-===========
-
-`glXSwapBuffers' promotes the contents of the back buffer of DRAWABLE to
-become the contents of the front buffer of DRAWABLE. The contents of the
-back buffer then become undefined. The update typically takes place
-during the vertical retrace of the monitor, rather than immediately
-after `glXSwapBuffers' is called.
-
-`glXSwapBuffers' performs an implicit `glFlush' before it returns.
-Subsequent OpenGL commands may be issued immediately after calling
-`glXSwapBuffers', but are not executed until the buffer exchange is
-completed.
-
-If DRAWABLE was not created with respect to a double-buffered visual,
-`glXSwapBuffers' has no effect, and no error is generated.
-
-
-Errors
-======
-
-`GLXBadDrawable' is generated if DRAWABLE is not a valid GLX drawable.
-
-`GLXBadCurrentWindow' is generated if DPY and DRAWABLE are respectively
-the display and drawable associated with the current context of the
-calling thread, and DRAWABLE identifies a window that is no longer
-valid.")
-
-(define-gl-procedure
- glXUseXFont
- "glXUseXFont"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glXUseXFont"))
- (paramdef "Font " (parameter "font"))
- (paramdef "int " (parameter "first"))
- (paramdef "int " (parameter "count"))
- (paramdef "int " (parameter "listBase"))))
- "create bitmap display lists from an X font
-==========================================
-
-
-Parameters
-==========
-
-FONT
- Specifies the font from which character glyphs are to be taken.
-
-FIRST
- Specifies the index of the first glyph to be taken.
-
-COUNT
- Specifies the number of glyphs to be taken.
-
-LISTBASE
- Specifies the index of the first display list to be generated.
-
-
-Description
-===========
-
-`glXUseXFont' generates COUNT display lists, named LISTBASE through
-LISTBASE+COUNT-1, each containing a single `glBitmap' command. The
-parameters of the `glBitmap' command of display list LISTBASE+I are
-derived from glyph FIRST+I. Bitmap parameters XORIG, YORIG, WIDTH, and
-HEIGHT are computed from font metrics as DESCENT-1, -LBEARING,
-RBEARING-LBEARING, and ASCENT+DESCENT, respectively. XMOVE is taken from
-the glyph's WIDTH metric, and YMOVE is set to zero. Finally, the glyph's
-image is converted to the appropriate format for `glBitmap'.
-
-Using `glXUseXFont' may be more efficient than accessing the X font and
-generating the display lists explicitly, both because the display lists
-are created on the server without requiring a round trip of the glyph
-data, and because the server may choose to delay the creation of each
-bitmap until it is accessed.
-
-Empty display lists are created for all glyphs that are requested and
-are not defined in FONT. `glXUseXFont' is ignored if there is no current
-GLX context.
-
-
-Errors
-======
-
-`BadFont' is generated if FONT is not a valid font.
-
-`GLXBadContextState' is generated if the current GLX context is in
-display-list construction mode.
-
-`GLXBadCurrentWindow' is generated if the drawable associated with the
-current context of the calling thread is a window, and that window is no
-longer valid.")
-
-(define-gl-procedure
- glXWaitGL
- "glXWaitGL"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glXWaitGL"))
- (paramdef (parameter "void"))))
- "complete GL execution prior to subsequent X calls
-=================================================
-
-
-Description
-===========
-
-GL rendering calls made prior to `glXWaitGL' are guaranteed to be
-executed before X rendering calls made after `glXWaitGL'. Although this
-same result can be achieved using `glFinish', `glXWaitGL' does not
-require a round trip to the server, and it is therefore more efficient
-in cases where client and server are on separate machines.
-
-`glXWaitGL' is ignored if there is no current GLX context.
-
-
-Errors
-======
-
-`GLXBadCurrentWindow' is generated if the drawable associated with the
-current context of the calling thread is a window, and that window is no
-longer valid.")
-
-(define-gl-procedure
- glXWaitX
- "glXWaitX"
- (funcsynopsis
- (funcprototype
- (funcdef "void " (function "glXWaitX"))
- (paramdef (parameter "void"))))
- "complete X execution prior to subsequent GL calls
-=================================================
-
-
-Description
-===========
-
-X rendering calls made prior to `glXWaitX' are guaranteed to be executed
-before GL rendering calls made after `glXWaitX'. Although the same
-result can be achieved using `XSync', `glXWaitX' does not require a
-round trip to the server, and it is therefore more efficient in cases
-where client and server are on separate machines.
-
-`glXWaitX' is ignored if there is no current GLX context.
-
-
-Errors
-======
-
-`GLXBadCurrentWindow' is generated if the drawable associated with the
-current context of the calling thread is a window, and that window is no
-longer valid.")
-
(define-module (figl low-level))
-(define-syntax-rule (define-gl-procedure scheme-name c-name prototype
- docstring)
- (begin
- (define (scheme-name)
- docstring
- (cons c-name 'prototype))
- (export scheme-name)))
-
-(include-from-path "figl/low-level.inc.scm")
--- /dev/null
+;;; figl -*- mode: scheme; coding: utf-8 -*-
+;;; Copyright (C) 2013 Andy Wingo <wingo@pobox.com>
+;;;
+;;; Figl is free software: you can redistribute it and/or modify it
+;;; under the terms of the GNU Lesser General Public License as
+;;; published by the Free Software Foundation, either version 3 of the
+;;; License, or (at your option) any later version.
+;;;
+;;; Figl is distributed in the hope that it will be useful, but WITHOUT
+;;; ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+;;; or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
+;;; Public License for more details.
+;;;
+;;; You should have received a copy of the GNU Lesser General Public
+;;; License along with this program. If not, see
+;;; <http://www.gnu.org/licenses/>.
+;;;
+;;; Derived from upstream OpenGL documentation.
+;;;
+;;; Copyright
+;;; =========
+;;;
+;;; Copyright (C) 1991-2006 Silicon Graphics, Inc. This document is licensed
+;;; under the SGI Free Software B License. For details, see
+;;; http://oss.sgi.com/projects/FreeB/ (http://oss.sgi.com/projects/FreeB/).
+;;;
+;;; Copyright
+;;; =========
+;;;
+;;; Copyright (C) 2003-2005 3Dlabs Inc. Ltd. This material may be
+;;; distributed subject to the terms and conditions set forth in the Open
+;;; Publication License, v 1.0, 8 June 1999. http://opencontent.org/openpub/
+;;; (http://opencontent.org/openpub/).
+;;;
+;;; Copyright
+;;; =========
+;;;
+;;; Copyright (C) 2005 Addison-Wesley. This material may be distributed
+;;; subject to the terms and conditions set forth in the Open Publication
+;;; License, v 1.0, 8 June 1999. http://opencontent.org/openpub/
+;;; (http://opencontent.org/openpub/).
+;;;
+;;; Copyright
+;;; =========
+;;;
+;;; Copyright (C) 2006 Khronos Group. This material may be distributed
+;;; subject to the terms and conditions set forth in the Open Publication
+;;; License, v 1.0, 8 June 1999. http://opencontent.org/openpub/
+;;; (http://opencontent.org/openpub/).
+;;;
+;;; Automatically generated; you probably don't want to edit this. To
+;;; update, run "make update" in the top-level build tree.
+;;;
+
+(define-module
+ (figl low-level gl)
+ #:use-module
+ (figl low-level support)
+ #:export
+ (glAccum
+ glActiveTexture
+ glAlphaFunc
+ glAreTexturesResident
+ glArrayElement
+ glAttachShader
+ glBeginQuery
+ glBegin
+ glBindAttribLocation
+ glBindBuffer
+ glBindTexture
+ glBitmap
+ glBlendColor
+ glBlendEquationSeparate
+ glBlendEquation
+ glBlendFuncSeparate
+ glBlendFunc
+ glBufferData
+ glBufferSubData
+ glCallLists
+ glCallList
+ glClearAccum
+ glClearColor
+ glClearDepth
+ glClearIndex
+ glClearStencil
+ glClear
+ glClientActiveTexture
+ glClipPlane
+ glColorMask
+ glColorMaterial
+ glColorPointer
+ glColorSubTable
+ glColorTableParameter
+ glColorTable
+ glColor
+ glCompileShader
+ glCompressedTexImage1D
+ glCompressedTexImage2D
+ glCompressedTexImage3D
+ glCompressedTexSubImage1D
+ glCompressedTexSubImage2D
+ glCompressedTexSubImage3D
+ glConvolutionFilter1D
+ glConvolutionFilter2D
+ glConvolutionParameter
+ glCopyColorSubTable
+ glCopyColorTable
+ glCopyConvolutionFilter1D
+ glCopyConvolutionFilter2D
+ glCopyPixels
+ glCopyTexImage1D
+ glCopyTexImage2D
+ glCopyTexSubImage1D
+ glCopyTexSubImage2D
+ glCopyTexSubImage3D
+ glCreateProgram
+ glCreateShader
+ glCullFace
+ glDeleteBuffers
+ glDeleteLists
+ glDeleteProgram
+ glDeleteQueries
+ glDeleteShader
+ glDeleteTextures
+ glDepthFunc
+ glDepthMask
+ glDepthRange
+ glDetachShader
+ glDrawArrays
+ glDrawBuffers
+ glDrawBuffer
+ glDrawElements
+ glDrawPixels
+ glDrawRangeElements
+ glEdgeFlagPointer
+ glEdgeFlag
+ glEnableClientState
+ glEnableVertexAttribArray
+ glEnable
+ glEvalCoord
+ glEvalMesh
+ glEvalPoint
+ glFeedbackBuffer
+ glFinish
+ glFlush
+ glFogCoordPointer
+ glFogCoord
+ glFog
+ glFrontFace
+ glFrustum
+ glGenBuffers
+ glGenLists
+ glGenQueries
+ glGenTextures
+ glGetActiveAttrib
+ glGetActiveUniform
+ glGetAttachedShaders
+ glGetAttribLocation
+ glGetBufferParameteriv
+ glGetBufferPointerv
+ glGetBufferSubData
+ glGetClipPlane
+ glGetColorTableParameter
+ glGetColorTable
+ glGetCompressedTexImage
+ glGetConvolutionFilter
+ glGetConvolutionParameter
+ glGetError
+ glGetHistogramParameter
+ glGetHistogram
+ glGetLight
+ glGetMap
+ glGetMaterial
+ glGetMinmaxParameter
+ glGetMinmax
+ glGetPixelMap
+ glGetPointerv
+ glGetPolygonStipple
+ glGetProgramInfoLog
+ glGetProgramiv
+ glGetQueryiv
+ glGetQueryObject
+ glGetSeparableFilter
+ glGetShaderInfoLog
+ glGetShaderSource
+ glGetShaderiv
+ glGetString
+ glGetTexEnv
+ glGetTexGen
+ glGetTexImage
+ glGetTexLevelParameter
+ glGetTexParameter
+ glGetUniformLocation
+ glGetUniformfv
+ glGetVertexAttribPointerv
+ glGetVertexAttribdv
+ glGet
+ glHint
+ glHistogram
+ glIndexMask
+ glIndexPointer
+ glIndex
+ glInitNames
+ glInterleavedArrays
+ glIsBuffer
+ glIsEnabled
+ glIsList
+ glIsProgram
+ glIsQuery
+ glIsShader
+ glIsTexture
+ glLightModel
+ glLight
+ glLineStipple
+ glLineWidth
+ glLinkProgram
+ glListBase
+ glLoadIdentity
+ glLoadMatrix
+ glLoadName
+ glLoadTransposeMatrix
+ glLogicOp
+ glMap1
+ glMap2
+ glMapBuffer
+ glMapGrid
+ glMaterial
+ glMatrixMode
+ glMinmax
+ glMultiDrawArrays
+ glMultiDrawElements
+ glMultiTexCoord
+ glMultMatrix
+ glMultTransposeMatrix
+ glNewList
+ glNormalPointer
+ glNormal
+ glOrtho
+ glPassThrough
+ glPixelMap
+ glPixelStore
+ glPixelTransfer
+ glPixelZoom
+ glPointParameter
+ glPointSize
+ glPolygonMode
+ glPolygonOffset
+ glPolygonStipple
+ glPrioritizeTextures
+ glPushAttrib
+ glPushClientAttrib
+ glPushMatrix
+ glPushName
+ glRasterPos
+ glReadBuffer
+ glReadPixels
+ glRect
+ glRenderMode
+ glResetHistogram
+ glResetMinmax
+ glRotate
+ glSampleCoverage
+ glScale
+ glScissor
+ glSecondaryColorPointer
+ glSecondaryColor
+ glSelectBuffer
+ glSeparableFilter2D
+ glShadeModel
+ glShaderSource
+ glStencilFuncSeparate
+ glStencilFunc
+ glStencilMaskSeparate
+ glStencilMask
+ glStencilOpSeparate
+ glStencilOp
+ glTexCoordPointer
+ glTexCoord
+ glTexEnv
+ glTexGen
+ glTexImage1D
+ glTexImage2D
+ glTexImage3D
+ glTexParameter
+ glTexSubImage1D
+ glTexSubImage2D
+ glTexSubImage3D
+ glTranslate
+ glUniform1f
+ glUseProgram
+ glValidateProgram
+ glVertexAttribPointer
+ glVertexAttrib
+ glVertexPointer
+ glVertex
+ glViewport
+ glWindowPos))
+
+(define-gl-procedure
+ glAccum
+ "glAccum"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glAccum"))
+ (paramdef "GLenum " (parameter "op"))
+ (paramdef "GLfloat " (parameter "value"))))
+ '(*fragment*
+ (heading "operate on the accumulation buffer")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "op")))
+ (para "
+Specifies the accumulation buffer operation.
+ Symbolic constants "
+ (code "GL_ACCUM")
+ ", "
+ (code "GL_LOAD")
+ ", "
+ (code "GL_ADD")
+ ", "
+ (code "GL_MULT")
+ ",
+ and "
+ (code "GL_RETURN")
+ " are accepted. "))
+ (entry (% (heading (var "value")))
+ (para "
+Specifies a floating-point value used in the accumulation buffer operation. "
+ (var "op")
+ " determines how "
+ (var "value")
+ " is used. ")))
+ (heading "Description")
+ (para "
+The accumulation buffer is an extended-range color buffer.
+ Images are not rendered into it.
+ Rather,
+ images rendered into one of the color buffers
+ are added to the contents of the accumulation buffer after rendering.
+ Effects such as antialiasing (of points, lines, and polygons),
+ motion blur,
+ and depth of field can be created
+ by accumulating images generated with different transformation matrices. ")
+ (para "
+Each pixel in the accumulation buffer consists of
+ red, green, blue, and alpha values.
+ The number of bits per component in the accumulation buffer
+ depends on the implementation. You can examine this number
+ by calling "
+ (code "glGetIntegerv")
+ " four times,
+ with arguments "
+ (code "GL_ACCUM_RED_BITS")
+ ", "
+ (code "GL_ACCUM_GREEN_BITS")
+ ", "
+ (code "GL_ACCUM_BLUE_BITS")
+ ",
+ and "
+ (code "GL_ACCUM_ALPHA_BITS")
+ ".
+ Regardless of the number of bits per component,
+ the range of values stored by each component is "
+ (math "[" "-1" "," "1" "]")
+ ".
+ The accumulation buffer pixels are mapped one-to-one with frame buffer pixels. ")
+ (para (code "glAccum")
+ " operates on the accumulation buffer.
+ The first argument, "
+ (var "op")
+ ",
+ is a symbolic constant that selects an accumulation buffer operation.
+ The second argument, "
+ (var "value")
+ ",
+ is a floating-point value to be used in that operation.
+ Five operations are specified: "
+ (code "GL_ACCUM")
+ ", "
+ (code "GL_LOAD")
+ ", "
+ (code "GL_ADD")
+ ", "
+ (code "GL_MULT")
+ ", and "
+ (code "GL_RETURN")
+ ". ")
+ (para "
+All accumulation buffer operations are limited
+ to the area of the current scissor box and applied identically to
+ the red, green, blue, and alpha components of each pixel.
+ If a "
+ (code "glAccum")
+ " operation results in a value outside the range "
+ (math "[" "-1" "," "1" "]")
+ ",
+ the contents of an accumulation buffer pixel component are undefined. ")
+ (para "
+The operations are as follows: ")
+ (table (% (formatter (asis)))
+ (entry (% (heading (code "GL_ACCUM")))
+ (para "
+Obtains R, G, B, and A values
+ from the buffer currently selected for reading (see "
+ (code "glReadBuffer")
+ ").
+ Each component value is divided by "
+ (math "2" "^" (var "n") "-" "1")
+ ",
+ where "
+ (math (var "n"))
+ "
+is the number of bits allocated to each color component
+ in the currently selected buffer.
+ The result is a floating-point value in the range "
+ (math "[" "0" "," "1" "]")
+ ",
+ which is multiplied by "
+ (var "value")
+ " and added to the corresponding pixel component
+ in the accumulation buffer,
+ thereby updating the accumulation buffer. "))
+ (entry (% (heading (code "GL_LOAD")))
+ (para "
+Similar to "
+ (code "GL_ACCUM")
+ ",
+ except that the current value in the accumulation buffer is not used
+ in the calculation of the new value.
+ That is, the R, G, B, and A values from the currently selected buffer
+ are divided by "
+ (math "2" "^" (var "n") "-" "1")
+ ",
+ multiplied by "
+ (var "value")
+ ",
+ and then stored in the corresponding accumulation buffer cell,
+ overwriting the current value. "))
+ (entry (% (heading (code "GL_ADD")))
+ (para "
+Adds "
+ (var "value")
+ " to each R, G, B, and A
+ in the accumulation buffer. "))
+ (entry (% (heading (code "GL_MULT")))
+ (para "
+Multiplies each R, G, B, and A
+ in the accumulation buffer by "
+ (var "value")
+ " and returns the scaled component
+ to its corresponding accumulation buffer location. "))
+ (entry (% (heading (code "GL_RETURN")))
+ (para "
+Transfers accumulation buffer values
+ to the color buffer or buffers currently selected for writing.
+ Each R, G, B, and A component is multiplied by "
+ (var "value")
+ ",
+ then multiplied by "
+ (math "2" "^" (var "n") "-" "1")
+ ",
+ clamped to the range "
+ (math "[" "0" "," "2" "^" (var "n") "-" "1" "]")
+ ",
+ and stored
+ in the corresponding display buffer cell.
+ The only fragment operations that are applied to this transfer are
+ pixel ownership,
+ scissor,
+ dithering,
+ and color writemasks. ")))
+ (para "
+To clear the accumulation buffer, call "
+ (code "glClearAccum")
+ " with R, G, B,
+ and A values to set it to, then call "
+ (code "glClear")
+ " with the
+ accumulation buffer enabled. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "op")
+ " is not an accepted value. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if there is no accumulation buffer. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glAccum")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ " and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glActiveTexture
+ "glActiveTexture"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glActiveTexture"))
+ (paramdef "GLenum " (parameter "texture"))))
+ '(*fragment*
+ (heading "select active texture unit")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "texture")))
+ (para "
+Specifies which texture unit to make active. The number
+ of texture units is implementation dependent, but must be at least
+ two. "
+ (var "texture")
+ " must be one of "
+ (code "GL_TEXTURE")
+ (math (var "i"))
+ ",
+ where
+ i ranges from 0 to the larger of ("
+ (code "GL_MAX_TEXTURE_COORDS")
+ " - 1)
+ and ("
+ (code "GL_MAX_COMBINED_TEXTURE_IMAGE_UNITS")
+ " - 1).
+ The initial value is "
+ (code "GL_TEXTURE0")
+ ". ")))
+ (heading "Description")
+ (para (code "glActiveTexture")
+ " selects which texture unit subsequent texture state calls will
+ affect. The number of texture units an implementation supports is
+ implementation dependent, but must be at least 2. ")
+ (para "
+Vertex arrays are client-side GL resources, which are selected by the "
+ (code "glClientActiveTexture")
+ " routine. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "texture")
+ " is not one of "
+ (code "GL_TEXTURE")
+ (math (var "i"))
+ ",
+ where i ranges from 0 to the larger of ("
+ (code "GL_MAX_TEXTURE_COORDS")
+ " - 1)
+ and ("
+ (code "GL_MAX_COMBINED_TEXTURE_IMAGE_UNITS")
+ " - 1). ")))
+
+(define-gl-procedure
+ glAlphaFunc
+ "glAlphaFunc"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glAlphaFunc"))
+ (paramdef "GLenum " (parameter "func"))
+ (paramdef "GLclampf " (parameter "ref"))))
+ '(*fragment*
+ (heading "specify the alpha test function")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "func")))
+ (para "
+Specifies the alpha comparison function.
+ Symbolic constants "
+ (code "GL_NEVER")
+ ", "
+ (code "GL_LESS")
+ ", "
+ (code "GL_EQUAL")
+ ", "
+ (code "GL_LEQUAL")
+ ", "
+ (code "GL_GREATER")
+ ", "
+ (code "GL_NOTEQUAL")
+ ", "
+ (code "GL_GEQUAL")
+ ", and "
+ (code "GL_ALWAYS")
+ " are accepted. The initial value is "
+ (code "GL_ALWAYS")
+ ". "))
+ (entry (% (heading (var "ref")))
+ (para "
+Specifies the reference value that incoming alpha values are compared to.
+ This value is clamped to the range "
+ (math "[" "0" "," "1" "]")
+ ",
+ where 0 represents the lowest possible alpha value
+ and 1 the highest possible value.
+ The initial reference value is 0. ")))
+ (heading "Description")
+ (para "
+The alpha test discards fragments depending on the outcome of a comparison
+ between an incoming fragment's alpha value and a constant reference value. "
+ (code "glAlphaFunc")
+ " specifies the reference value and the comparison function.
+ The comparison is performed only if alpha testing is enabled. By
+ default, it is not enabled.
+ (See "
+ (code "glEnable")
+ " and "
+ (code "glDisable")
+ " of "
+ (code "GL_ALPHA_TEST")
+ ".) ")
+ (para (var "func")
+ " and "
+ (var "ref")
+ " specify the conditions under which
+ the pixel is drawn.
+ The incoming alpha value is compared to "
+ (var "ref")
+ "
+using the function specified by "
+ (var "func")
+ ".
+ If the value passes the comparison,
+ the incoming fragment is drawn
+ if it also passes subsequent stencil and depth buffer tests.
+ If the value fails the comparison,
+ no change is made to the frame buffer at that pixel location. The
+ comparison functions are as follows: ")
+ (table (% (formatter (asis)))
+ (entry (% (heading (code "GL_NEVER")))
+ (para "
+Never passes. "))
+ (entry (% (heading (code "GL_LESS")))
+ (para "
+Passes if the incoming alpha value is less than the reference value. "))
+ (entry (% (heading (code "GL_EQUAL")))
+ (para "
+Passes if the incoming alpha value is equal to the reference value. "))
+ (entry (% (heading (code "GL_LEQUAL")))
+ (para "
+Passes if the incoming alpha value is less than or equal to the reference value. "))
+ (entry (% (heading (code "GL_GREATER")))
+ (para "
+Passes if the incoming alpha value is greater than the reference value. "))
+ (entry (% (heading (code "GL_NOTEQUAL")))
+ (para "
+Passes if the incoming alpha value is not equal to the reference value. "))
+ (entry (% (heading (code "GL_GEQUAL")))
+ (para "
+Passes if the incoming alpha value is greater than or equal to
+ the reference value. "))
+ (entry (% (heading (code "GL_ALWAYS")))
+ (para "
+Always passes (initial value). ")))
+ (para (code "glAlphaFunc")
+ " operates on all pixel write operations,
+ including those resulting from the scan conversion of points,
+ lines,
+ polygons,
+ and bitmaps,
+ and from pixel draw and copy operations. "
+ (code "glAlphaFunc")
+ " does not affect screen clear operations. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "func")
+ " is not an accepted value. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glAlphaFunc")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glAreTexturesResident
+ "glAreTexturesResident"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "GLboolean "
+ (function "glAreTexturesResident"))
+ (paramdef "GLsizei " (parameter "n"))
+ (paramdef
+ "const GLuint * "
+ (parameter "textures"))
+ (paramdef
+ "GLboolean * "
+ (parameter "residences"))))
+ '(*fragment*
+ (heading
+ "determine if textures are loaded in texture memory")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "n")))
+ (para "
+Specifies the number of textures to be queried. "))
+ (entry (% (heading (var "textures")))
+ (para "
+Specifies an array containing the names of the textures to be queried. "))
+ (entry (% (heading (var "residences")))
+ (para "
+Specifies an array in which the texture residence status is returned.
+ The residence status of a texture named by an element of "
+ (var "textures")
+ " is
+ returned in the corresponding element of "
+ (var "residences")
+ ". ")))
+ (heading "Description")
+ (para "
+GL establishes
+ a ``working set'' of textures that are resident in texture memory.
+ These textures can be bound to a texture target much more efficiently
+ than textures that are not resident. ")
+ (para (code "glAreTexturesResident")
+ " queries the texture residence status of the "
+ (var "n")
+ " textures named by
+ the elements of "
+ (var "textures")
+ ".
+ If all the named textures are resident, "
+ (code "glAreTexturesResident")
+ " returns "
+ (code "GL_TRUE")
+ ",
+ and the contents of "
+ (var "residences")
+ " are undisturbed.
+ If not all the named textures are resident, "
+ (code "glAreTexturesResident")
+ " returns "
+ (code "GL_FALSE")
+ ",
+ and detailed status is returned in the "
+ (var "n")
+ " elements of "
+ (var "residences")
+ ".
+ If an element of "
+ (var "residences")
+ " is "
+ (code "GL_TRUE")
+ ", then the texture named by
+ the corresponding element of "
+ (var "textures")
+ " is resident. ")
+ (para "
+The residence status of a single bound texture may also be queried
+ by calling "
+ (code "glGetTexParameter")
+ " with the "
+ (var "target")
+ " argument set to the
+ target to which the texture is bound, and the "
+ (var "pname")
+ " argument
+ set to "
+ (code "GL_TEXTURE_RESIDENT")
+ ".
+ This is the only way that the residence status of a default texture can be
+ queried. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "n")
+ " is negative. ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if any element in "
+ (var "textures")
+ "
+is 0 or does not name a texture. In that case, the function returns "
+ (code "GL_FALSE")
+ " and the contents of "
+ (var "residences")
+ " is indeterminate. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glAreTexturesResident")
+ " is executed
+ between the execution of "
+ (code "glBegin")
+ " and the corresponding
+ execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glArrayElement
+ "glArrayElement"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glArrayElement"))
+ (paramdef "GLint " (parameter "i"))))
+ '(*fragment*
+ (heading
+ "render a vertex using the specified vertex array element")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "i")))
+ (para "
+Specifies an index into the enabled vertex data arrays. ")))
+ (heading "Description")
+ (para (code "glArrayElement")
+ " commands are used within "
+ (code "glBegin")
+ "/"
+ (code "glEnd")
+ " pairs to
+ specify vertex and attribute data for point, line, and polygon
+ primitives. If "
+ (code "GL_VERTEX_ARRAY")
+ " is enabled when "
+ (code "glArrayElement")
+ " is called, a
+ single vertex is drawn, using
+ vertex and attribute data taken from location "
+ (var "i")
+ " of the enabled
+ arrays. If "
+ (code "GL_VERTEX_ARRAY")
+ " is not enabled, no drawing occurs but
+ the attributes corresponding to the enabled arrays are modified. ")
+ (para "
+Use "
+ (code "glArrayElement")
+ " to construct primitives by indexing vertex data, rather than
+ by streaming through arrays of data in first-to-last order. Because
+ each call specifies only a single vertex, it is possible to explicitly
+ specify per-primitive attributes such as a single normal for each
+ triangle. ")
+ (para "
+Changes made to array data between the execution of "
+ (code "glBegin")
+ " and the
+ corresponding execution of "
+ (code "glEnd")
+ " may affect calls to "
+ (code "glArrayElement")
+ " that are made
+ within the same "
+ (code "glBegin")
+ "/"
+ (code "glEnd")
+ " period in nonsequential ways.
+ That is, a call to "
+ (code "glArrayElement")
+ " that precedes a change to array data may
+ access the changed data, and a call that follows a change to array data
+ may access original data. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_VALUE")
+ " may be generated if "
+ (var "i")
+ " is negative. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a non-zero buffer object name is bound to an
+ enabled array and the buffer object's data store is currently mapped. ")))
+
+(define-gl-procedure
+ glAttachShader
+ "glAttachShader"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glAttachShader"))
+ (paramdef "GLuint " (parameter "program"))
+ (paramdef "GLuint " (parameter "shader"))))
+ '(*fragment*
+ (heading
+ "Attaches a shader object to a program object")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "program")))
+ (para "Specifies the program object to which a shader
+\t\t object will be attached."))
+ (entry (% (heading (var "shader")))
+ (para "Specifies the shader object that is to be attached.")))
+ (heading "Description")
+ (para "In order to create an executable, there must be a way to
+\tspecify the list of things that will be linked together. Program
+\tobjects provide this mechanism. Shaders that are to be linked
+\ttogether in a program object must first be attached to that
+\tprogram object. "
+ (code "glAttachShader")
+ " attaches the
+\tshader object specified by "
+ (var "shader")
+ " to the
+\tprogram object specified by "
+ (var "program")
+ ". This
+\tindicates that "
+ (var "shader")
+ " will be included in
+\tlink operations that will be performed on\t"
+ (var "program")
+ ".")
+ (para "All operations that can be performed on a shader object
+\tare valid whether or not the shader object is attached to a
+\tprogram object. It is permissible to attach a shader object to a
+\tprogram object before source code has been loaded into the
+\tshader object or before the shader object has been compiled. It
+\tis permissible to attach multiple shader objects of the same
+\ttype because each may contain a portion of the complete shader.
+\tIt is also permissible to attach a shader object to more than
+\tone program object. If a shader object is deleted while it is
+\tattached to a program object, it will be flagged for deletion,
+\tand deletion will not occur until\t"
+ (code "glDetachShader")
+ "
+is called to detach it from all program objects to which it is
+\tattached.")
+ (heading "Errors")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if either\t"
+ (var "program")
+ " or "
+ (var "shader")
+ "
+is not a value generated by OpenGL.")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if\t"
+ (var "program")
+ " is not a program object.")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if\t"
+ (var "shader")
+ " is not a shader object.")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if\t"
+ (var "shader")
+ " is already attached to\t"
+ (var "program")
+ ".")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if\t"
+ (code "glAttachShader")
+ " is executed between the
+\texecution of\t"
+ (code "glBegin")
+ "
+and the corresponding execution of\t"
+ (code "glEnd")
+ ".")))
+
+(define-gl-procedure
+ glBeginQuery
+ "glBeginQuery"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glBeginQuery"))
+ (paramdef "GLenum " (parameter "target"))
+ (paramdef "GLuint " (parameter "id"))))
+ '(*fragment*
+ (heading
+ "delimit the boundaries of a query object")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "target")))
+ (para "
+Specifies the target type of query object established between "
+ (code "glBeginQuery")
+ " and the subsequent "
+ (code "glEndQuery")
+ ".
+ The symbolic constant must be "
+ (code "GL_SAMPLES_PASSED")
+ ". "))
+ (entry (% (heading (var "id")))
+ (para "
+Specifies the name of a query object. ")))
+ (heading "Description")
+ (para (code "glBeginQuery")
+ " and "
+ (code "glEndQuery")
+ " delimit the
+ boundaries of a query object. If a query object with name "
+ (var "id")
+ " does not yet exist it is created. ")
+ (para "
+When "
+ (code "glBeginQuery")
+ " is executed, the query object's samples-passed counter is reset to 0. Subsequent
+ rendering will increment the counter once for every sample that passes the depth test. When "
+ (code "glEndQuery")
+ "
+is executed, the samples-passed counter is assigned to the query object's result value. This value can be queried by
+ calling "
+ (code "glGetQueryObject")
+ " with "
+ (var "pname")
+ (code "GL_QUERY_RESULT")
+ ". ")
+ (para "
+Querying the "
+ (code "GL_QUERY_RESULT")
+ " implicitly flushes the GL pipeline until the rendering delimited by the
+ query object has completed and the result is available. "
+ (code "GL_QUERY_RESULT_AVAILABLE")
+ " can be queried to
+ determine if the result is immediately available or if the rendering is not yet complete. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "target")
+ " is not "
+ (code "GL_SAMPLES_PASSED")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glBeginQuery")
+ " is executed while
+ a query object of the same "
+ (var "target")
+ " is already active. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glEndQuery")
+ "
+is executed when a query object of the same "
+ (var "target")
+ " is not active. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (var "id")
+ " is 0. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (var "id")
+ " is the name of an already active query object. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glBeginQuery")
+ " or "
+ (code "glEndQuery")
+ " is executed between the execution of "
+ (code "glBegin")
+ " and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glBegin
+ "glBegin"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glBegin"))
+ (paramdef "GLenum " (parameter "mode"))))
+ '(*fragment*
+ (heading
+ "delimit the vertices of a primitive or a group of like primitives")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "mode")))
+ (para "
+Specifies the primitive or primitives that will be created from vertices
+ presented between "
+ (code "glBegin")
+ " and the subsequent "
+ (code "glEnd")
+ ".
+ Ten symbolic constants are accepted: "
+ (code "GL_POINTS")
+ ", "
+ (code "GL_LINES")
+ ", "
+ (code "GL_LINE_STRIP")
+ ", "
+ (code "GL_LINE_LOOP")
+ ", "
+ (code "GL_TRIANGLES")
+ ", "
+ (code "GL_TRIANGLE_STRIP")
+ ", "
+ (code "GL_TRIANGLE_FAN")
+ ", "
+ (code "GL_QUADS")
+ ", "
+ (code "GL_QUAD_STRIP")
+ ", and "
+ (code "GL_POLYGON")
+ ". ")))
+ (heading "Description")
+ (para (code "glBegin")
+ " and "
+ (code "glEnd")
+ " delimit the vertices that define a primitive or
+ a group of like primitives. "
+ (code "glBegin")
+ " accepts a single argument that specifies in which of ten ways the
+ vertices are interpreted.
+ Taking "
+ (math (var "n"))
+ "
+as an integer count starting at one,
+ and "
+ (math (var "N"))
+ "
+as the total number of vertices specified,
+ the interpretations are as follows: ")
+ (table (% (formatter (asis)))
+ (entry (% (heading (code "GL_POINTS")))
+ (para "
+Treats each vertex as a single point.
+ Vertex "
+ (math (var "n"))
+ "
+defines point "
+ (math (var "n"))
+ ". "
+ (math (var "N"))
+ "
+points are drawn. "))
+ (entry (% (heading (code "GL_LINES")))
+ (para "
+Treats each pair of vertices as an independent line segment.
+ Vertices "
+ (math "2" "\u2062" (var "n") "-" "1")
+ "
+and "
+ (math "2" "\u2062" (var "n"))
+ "
+define line "
+ (math (var "n"))
+ ". "
+ (math (var "N") "/" "2")
+ "
+lines are drawn. "))
+ (entry (% (heading (code "GL_LINE_STRIP")))
+ (para "
+Draws a connected group of line segments from the first vertex
+ to the last.
+ Vertices "
+ (math (var "n"))
+ "
+and "
+ (math (var "n") "+" "1")
+ "
+define line "
+ (math (var "n"))
+ ". "
+ (math (var "N") "-" "1")
+ "
+lines are drawn. "))
+ (entry (% (heading (code "GL_LINE_LOOP")))
+ (para "
+Draws a connected group of line segments from the first vertex
+ to the last,
+ then back to the first.
+ Vertices "
+ (math (var "n"))
+ "
+and "
+ (math (var "n") "+" "1")
+ "
+define line "
+ (math (var "n"))
+ ".
+ The last line, however, is defined by vertices "
+ (math (var "N"))
+ "
+and "
+ (math "1")
+ ". "
+ (math (var "N"))
+ "
+lines are drawn. "))
+ (entry (% (heading (code "GL_TRIANGLES")))
+ (para "
+Treats each triplet of vertices as an independent triangle.
+ Vertices "
+ (math "3" "\u2062" (var "n") "-" "2")
+ ", "
+ (math "3" "\u2062" (var "n") "-" "1")
+ ",
+ and "
+ (math "3" "\u2062" (var "n"))
+ "
+define triangle "
+ (math (var "n"))
+ ". "
+ (math (var "N") "/" "3")
+ "
+triangles are drawn. "))
+ (entry (% (heading (code "GL_TRIANGLE_STRIP")))
+ (para "
+Draws a connected group of triangles. One triangle is defined for each
+ vertex presented after the first two vertices. For odd "
+ (math (var "n"))
+ ",
+ vertices "
+ (math (var "n"))
+ ", "
+ (math (var "n") "+" "1")
+ ",
+ and "
+ (math (var "n") "+" "2")
+ "
+define triangle "
+ (math (var "n"))
+ ".
+ For even "
+ (math (var "n"))
+ ",
+ vertices "
+ (math (var "n") "+" "1")
+ ", "
+ (math (var "n"))
+ ",
+ and "
+ (math (var "n") "+" "2")
+ "
+define triangle "
+ (math (var "n"))
+ ". "
+ (math (var "N") "-" "2")
+ "
+triangles are
+ drawn. "))
+ (entry (% (heading (code "GL_TRIANGLE_FAN")))
+ (para "
+Draws a connected group of triangles.
+ One triangle is defined for each vertex presented after the first two vertices.
+ Vertices "
+ (math "1")
+ ", "
+ (math (var "n") "+" "1")
+ ",
+ and "
+ (math (var "n") "+" "2")
+ "
+define triangle "
+ (math (var "n"))
+ ". "
+ (math (var "N") "-" "2")
+ "
+triangles are drawn. "))
+ (entry (% (heading (code "GL_QUADS")))
+ (para "
+Treats each group of four vertices as an independent quadrilateral.
+ Vertices "
+ (math "4" "\u2062" (var "n") "-" "3")
+ ", "
+ (math "4" "\u2062" (var "n") "-" "2")
+ ", "
+ (math "4" "\u2062" (var "n") "-" "1")
+ ",
+ and "
+ (math "4" "\u2062" (var "n"))
+ "
+define quadrilateral "
+ (math (var "n"))
+ ". "
+ (math (var "N") "/" "4")
+ "
+quadrilaterals are drawn. "))
+ (entry (% (heading (code "GL_QUAD_STRIP")))
+ (para "
+Draws a connected group of quadrilaterals.
+ One quadrilateral is defined for each pair of vertices presented
+ after the first pair.
+ Vertices "
+ (math "2" "\u2062" (var "n") "-" "1")
+ ", "
+ (math "2" "\u2062" (var "n"))
+ ", "
+ (math "2" "\u2062" (var "n") "+" "2")
+ ",
+ and "
+ (math "2" "\u2062" (var "n") "+" "1")
+ "
+define quadrilateral "
+ (math (var "n"))
+ ". "
+ (math (var "N") "/" "2" "-" "1")
+ "
+quadrilaterals are drawn.
+ Note that the order in which vertices are used to construct a quadrilateral
+ from strip data is different from that used with independent data. "))
+ (entry (% (heading (code "GL_POLYGON")))
+ (para "
+Draws a single,
+ convex polygon.
+ Vertices "
+ (math "1")
+ "
+through "
+ (math (var "N"))
+ "
+define this polygon. ")))
+ (para "
+Only a subset of GL commands can be used between "
+ (code "glBegin")
+ " and "
+ (code "glEnd")
+ ".
+ The commands are "
+ (code "glVertex")
+ ", "
+ (code "glColor")
+ ", "
+ (code "glSecondaryColor")
+ ", "
+ (code "glIndex")
+ ", "
+ (code "glNormal")
+ ", "
+ (code "glFogCoord")
+ ", "
+ (code "glTexCoord")
+ ", "
+ (code "glMultiTexCoord")
+ ", "
+ (code "glVertexAttrib")
+ ", "
+ (code "glEvalCoord")
+ ", "
+ (code "glEvalPoint")
+ ", "
+ (code "glArrayElement")
+ ", "
+ (code "glMaterial")
+ ", and "
+ (code "glEdgeFlag")
+ ".
+ Also,
+ it is acceptable to use "
+ (code "glCallList")
+ " or "
+ (code "glCallLists")
+ " to execute
+ display lists that include only the preceding commands.
+ If any other GL command is executed between "
+ (code "glBegin")
+ " and "
+ (code "glEnd")
+ ",
+ the error flag is set and the command is ignored. ")
+ (para "
+Regardless of the value chosen for "
+ (var "mode")
+ ",
+ there is no limit to the number of vertices that can be defined
+ between "
+ (code "glBegin")
+ " and "
+ (code "glEnd")
+ ".
+ Lines,
+ triangles,
+ quadrilaterals,
+ and polygons that are incompletely specified are not drawn.
+ Incomplete specification results when either too few vertices are
+ provided to specify even a single primitive or when an incorrect multiple
+ of vertices is specified. The incomplete primitive is ignored; the rest are drawn. ")
+ (para "
+The minimum specification of vertices
+ for each primitive is as follows:
+ 1 for a point,
+ 2 for a line,
+ 3 for a triangle,
+ 4 for a quadrilateral,
+ and 3 for a polygon.
+ Modes that require a certain multiple of vertices are "
+ (code "GL_LINES")
+ " (2), "
+ (code "GL_TRIANGLES")
+ " (3), "
+ (code "GL_QUADS")
+ " (4),
+ and "
+ (code "GL_QUAD_STRIP")
+ " (2). ")
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "mode")
+ " is set to an unaccepted value. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glBegin")
+ " is executed between a "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glEnd")
+ " is executed without being
+ preceded by a "
+ (code "glBegin")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a command other than "
+ (code "glVertex")
+ ", "
+ (code "glColor")
+ ", "
+ (code "glSecondaryColor")
+ ", "
+ (code "glIndex")
+ ", "
+ (code "glNormal")
+ ", "
+ (code "glFogCoord")
+ ", "
+ (code "glTexCoord")
+ ", "
+ (code "glMultiTexCoord")
+ ", "
+ (code "glVertexAttrib")
+ ", "
+ (code "glEvalCoord")
+ ", "
+ (code "glEvalPoint")
+ ", "
+ (code "glArrayElement")
+ ", "
+ (code "glMaterial")
+ ", "
+ (code "glEdgeFlag")
+ ", "
+ (code "glCallList")
+ ", or "
+ (code "glCallLists")
+ " is executed between
+ the execution of "
+ (code "glBegin")
+ " and the corresponding
+ execution "
+ (code "glEnd")
+ ". ")
+ (para "
+Execution of "
+ (code "glEnableClientState")
+ ", "
+ (code "glDisableClientState")
+ ", "
+ (code "glEdgeFlagPointer")
+ ", "
+ (code "glFogCoordPointer")
+ ", "
+ (code "glTexCoordPointer")
+ ", "
+ (code "glColorPointer")
+ ", "
+ (code "glSecondaryColorPointer")
+ ", "
+ (code "glIndexPointer")
+ ", "
+ (code "glNormalPointer")
+ ", "
+ (code "glVertexPointer")
+ ", "
+ (code "glVertexAttribPointer")
+ ", "
+ (code "glInterleavedArrays")
+ ", or "
+ (code "glPixelStore")
+ " is not allowed after a call to "
+ (code "glBegin")
+ " and before
+ the corresponding call to "
+ (code "glEnd")
+ ",
+ but an error may or may not be generated. ")))
+
+(define-gl-procedure
+ glBindAttribLocation
+ "glBindAttribLocation"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "void "
+ (function "glBindAttribLocation"))
+ (paramdef "GLuint " (parameter "program"))
+ (paramdef "GLuint " (parameter "index"))
+ (paramdef "const GLchar *" (parameter "name"))))
+ '(*fragment*
+ (heading
+ "Associates a generic vertex attribute index with a named attribute variable")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "program")))
+ (para "Specifies the handle of the program object in
+\t\t which the association is to be made."))
+ (entry (% (heading (var "index")))
+ (para "Specifies the index of the generic vertex
+\t\t attribute to be bound."))
+ (entry (% (heading (var "name")))
+ (para "Specifies a null terminated string containing
+\t\t the name of the vertex shader attribute variable to
+\t\t which "
+ (var "index")
+ " is to be
+\t\t bound.")))
+ (heading "Description")
+ (para (code "glBindAttribLocation")
+ " is used to
+\tassociate a user-defined attribute variable in the program
+\tobject specified by "
+ (var "program")
+ " with a
+\tgeneric vertex attribute index. The name of the user-defined
+\tattribute variable is passed as a null terminated string in\t"
+ (var "name")
+ ". The generic vertex attribute index
+\tto be bound to this variable is specified by\t"
+ (var "index")
+ ". When\t"
+ (var "program")
+ " is made part of current state,
+\tvalues provided via the generic vertex attribute\t"
+ (var "index")
+ " will modify the value of the
+\tuser-defined attribute variable specified by\t"
+ (var "name")
+ ".")
+ (para "If "
+ (var "name")
+ " refers to a matrix
+\tattribute variable, "
+ (var "index")
+ " refers to the
+\tfirst column of the matrix. Other matrix columns are then
+\tautomatically bound to locations "
+ (var "index+1")
+ "
+for a matrix of type mat2; "
+ (var "index+1")
+ " and\t"
+ (var "index+2")
+ " for a matrix of type mat3; and\t"
+ (var "index+1")
+ ", "
+ (var "index+2")
+ ",
+\tand "
+ (var "index+3")
+ " for a matrix of type
+\tmat4.")
+ (para "This command makes it possible for vertex shaders to use
+\tdescriptive names for attribute variables rather than generic
+\tvariables that are numbered from 0 to\t"
+ (code "GL_MAX_VERTEX_ATTRIBS")
+ " -1. The values sent
+\tto each generic attribute index are part of current state, just
+\tlike standard vertex attributes such as color, normal, and
+\tvertex position. If a different program object is made current
+\tby calling\t"
+ (code "glUseProgram")
+ ",
+\tthe generic vertex attributes are tracked in such a way that the
+\tsame values will be observed by attributes in the new program
+\tobject that are also bound to\t"
+ (var "index")
+ ".")
+ (para "Attribute variable
+\tname-to-generic attribute index bindings for a program object
+\tcan be explicitly assigned at any time by calling\t"
+ (code "glBindAttribLocation")
+ ". Attribute bindings do
+\tnot go into effect until\t"
+ (code "glLinkProgram")
+ "
+is called. After a program object has been linked successfully,
+\tthe index values for generic attributes remain fixed (and their
+\tvalues can be queried) until the next link command
+\toccurs.")
+ (para "Applications are not allowed to bind any of the standard
+\tOpenGL vertex attributes using this command, as they are bound
+\tautomatically when needed. Any attribute binding that occurs
+\tafter the program object has been linked will not take effect
+\tuntil the next time the program object is linked.")
+ (heading "Errors")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if\t"
+ (var "index")
+ " is greater than or equal to\t"
+ (code "GL_MAX_VERTEX_ATTRIBS")
+ ".")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if\t"
+ (var "name")
+ " starts with the reserved prefix
+\t\"gl_\".")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if\t"
+ (var "program")
+ " is not a value generated by
+\tOpenGL.")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if\t"
+ (var "program")
+ " is not a program object.")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if\t"
+ (code "glBindAttribLocation")
+ " is executed between
+\tthe execution of\t"
+ (code "glBegin")
+ "
+and the corresponding execution of\t"
+ (code "glEnd")
+ ".")))
+
+(define-gl-procedure
+ glBindBuffer
+ "glBindBuffer"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glBindBuffer"))
+ (paramdef "GLenum " (parameter "target"))
+ (paramdef "GLuint " (parameter "buffer"))))
+ '(*fragment*
+ (heading "bind a named buffer object")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "target")))
+ (para "
+Specifies the target to which the buffer object is bound.
+ The symbolic constant must be "
+ (code "GL_ARRAY_BUFFER")
+ ", "
+ (code "GL_ELEMENT_ARRAY_BUFFER")
+ ", "
+ (code "GL_PIXEL_PACK_BUFFER")
+ ", or "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ ". "))
+ (entry (% (heading (var "buffer")))
+ (para "
+Specifies the name of a buffer object. ")))
+ (heading "Description")
+ (para (code "glBindBuffer")
+ " lets you create or use a named buffer object. Calling "
+ (code "glBindBuffer")
+ " with "
+ (var "target")
+ " set to "
+ (code "GL_ARRAY_BUFFER")
+ ", "
+ (code "GL_ELEMENT_ARRAY_BUFFER")
+ ", "
+ (code "GL_PIXEL_PACK_BUFFER")
+ " or "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ " and "
+ (var "buffer")
+ " set to the name
+ of the new buffer object binds the buffer object name to the target.
+ When a buffer object is bound to a target, the previous binding for that
+ target is automatically broken. ")
+ (para "
+Buffer object names are unsigned integers. The value zero is reserved, but
+ there is no default buffer object for each buffer object target. Instead, "
+ (var "buffer")
+ " set to zero
+ effectively unbinds any buffer object previously bound, and restores client memory usage for that buffer object target.
+ Buffer object names and the corresponding buffer object contents are local to
+ the shared display-list space (see "
+ (code "glXCreateContext")
+ ") of the current
+ GL rendering context;
+ two rendering contexts share buffer object names only if they
+ also share display lists. ")
+ (para "
+You may use "
+ (code "glGenBuffers")
+ " to generate a set of new buffer object names. ")
+ (para "
+The state of a buffer object immediately after it is first bound is an unmapped zero-sized memory buffer with "
+ (code "GL_READ_WRITE")
+ " access and "
+ (code "GL_STATIC_DRAW")
+ " usage. ")
+ (para "
+While a non-zero buffer object name is bound, GL operations on the target to which it is
+ bound affect the bound buffer object, and queries of the target to which it is bound return state
+ from the bound buffer object. While buffer object name zero is bound, as in the initial state,
+ attempts to modify or query state on the target to which it is bound generates an "
+ (code "GL_INVALID_OPERATION")
+ " error. ")
+ (para "
+When vertex array pointer state is changed, for example by a call to "
+ (code "glNormalPointer")
+ ",
+ the current buffer object binding ("
+ (code "GL_ARRAY_BUFFER_BINDING")
+ ") is copied into the
+ corresponding client state for the vertex array type being changed, for example "
+ (code "GL_NORMAL_ARRAY_BUFFER_BINDING")
+ ". While a non-zero buffer object is bound to the "
+ (code "GL_ARRAY_BUFFER")
+ " target, the vertex array pointer parameter that is traditionally
+ interpreted as a pointer to client-side memory is instead interpreted as an offset within the
+ buffer object measured in basic machine units. ")
+ (para "
+While a non-zero buffer object is bound to the "
+ (code "GL_ELEMENT_ARRAY_BUFFER")
+ " target,
+ the indices parameter of "
+ (code "glDrawElements")
+ ", "
+ (code "glDrawRangeElements")
+ ", or "
+ (code "glMultiDrawElements")
+ " that is traditionally
+ interpreted as a pointer to client-side memory is instead interpreted as an offset within the
+ buffer object measured in basic machine units. ")
+ (para "
+While a non-zero buffer object is bound to the "
+ (code "GL_PIXEL_PACK_BUFFER")
+ " target,
+ the following commands are affected: "
+ (code "glGetCompressedTexImage")
+ ", "
+ (code "glGetConvolutionFilter")
+ ", "
+ (code "glGetHistogram")
+ ", "
+ (code "glGetMinmax")
+ ", "
+ (code "glGetPixelMap")
+ ", "
+ (code "glGetPolygonStipple")
+ ", "
+ (code "glGetSeparableFilter")
+ ", "
+ (code "glGetTexImage")
+ ", and "
+ (code "glReadPixels")
+ ". The pointer parameter that is
+ traditionally interpreted as a pointer to client-side memory where the pixels are to be packed is instead
+ interpreted as an offset within the buffer object measured in basic machine units. ")
+ (para "
+While a non-zero buffer object is bound to the "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ " target,
+ the following commands are affected: "
+ (code "glBitmap")
+ ", "
+ (code "glColorSubTable")
+ ", "
+ (code "glColorTable")
+ ", "
+ (code "glCompressedTexImage1D")
+ ", "
+ (code "glCompressedTexImage2D")
+ ", "
+ (code "glCompressedTexImage3D")
+ ", "
+ (code "glCompressedTexSubImage1D")
+ ", "
+ (code "glCompressedTexSubImage2D")
+ ", "
+ (code "glCompressedTexSubImage3D")
+ ", "
+ (code "glConvolutionFilter1D")
+ ", "
+ (code "glConvolutionFilter2D")
+ ", "
+ (code "glDrawPixels")
+ ", "
+ (code "glPixelMap")
+ ", "
+ (code "glPolygonStipple")
+ ", "
+ (code "glSeparableFilter2D")
+ ", "
+ (code "glTexImage1D")
+ ", "
+ (code "glTexImage2D")
+ ", "
+ (code "glTexImage3D")
+ ", "
+ (code "glTexSubImage1D")
+ ", "
+ (code "glTexSubImage2D")
+ ", and "
+ (code "glTexSubImage3D")
+ ". The pointer parameter that is
+ traditionally interpreted as a pointer to client-side memory from which the pixels are to be unpacked is
+ instead interpreted as an offset within the buffer object measured in basic machine units. ")
+ (para "
+A buffer object binding created with "
+ (code "glBindBuffer")
+ " remains active until a different
+ buffer object name is bound to the same target, or until the bound buffer object is
+ deleted with "
+ (code "glDeleteBuffers")
+ ". ")
+ (para "
+Once created, a named buffer object may be re-bound to any target as often as needed. However,
+ the GL implementation may make choices about how to optimize the storage of a buffer object based
+ on its initial binding target. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "target")
+ " is not one of the allowable
+ values. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glBindBuffer")
+ " is executed
+ between the execution of "
+ (code "glBegin")
+ " and the corresponding
+ execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glBindTexture
+ "glBindTexture"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glBindTexture"))
+ (paramdef "GLenum " (parameter "target"))
+ (paramdef "GLuint " (parameter "texture"))))
+ '(*fragment*
+ (heading
+ "bind a named texture to a texturing target")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "target")))
+ (para "
+Specifies the target to which the texture is bound.
+ Must be either "
+ (code "GL_TEXTURE_1D")
+ ", "
+ (code "GL_TEXTURE_2D")
+ ", "
+ (code "GL_TEXTURE_3D")
+ ", or "
+ (code "GL_TEXTURE_CUBE_MAP")
+ ". "))
+ (entry (% (heading (var "texture")))
+ (para "
+Specifies the name of a texture. ")))
+ (heading "Description")
+ (para (code "glBindTexture")
+ " lets you create or use a named texture. Calling "
+ (code "glBindTexture")
+ " with "
+ (var "target")
+ " set to "
+ (code "GL_TEXTURE_1D")
+ ", "
+ (code "GL_TEXTURE_2D")
+ ", "
+ (code "GL_TEXTURE_3D")
+ " or "
+ (code "GL_TEXTURE_CUBE_MAP")
+ " and "
+ (var "texture")
+ " set to the name
+ of the new texture binds the texture name to the target.
+ When a texture is bound to a target, the previous binding for that
+ target is automatically broken. ")
+ (para "
+Texture names are unsigned integers. The value zero is reserved to
+ represent the default texture for each texture target.
+ Texture names and the corresponding texture contents are local to
+ the shared display-list space (see "
+ (code "glXCreateContext")
+ ") of the current
+ GL rendering context;
+ two rendering contexts share texture names only if they
+ also share display lists. ")
+ (para "
+You may use "
+ (code "glGenTextures")
+ " to generate a set of new texture names. ")
+ (para "
+When a texture is first bound, it assumes the specified target:
+ A texture first bound to "
+ (code "GL_TEXTURE_1D")
+ " becomes one-dimensional texture, a
+ texture first bound to "
+ (code "GL_TEXTURE_2D")
+ " becomes two-dimensional texture, a
+ texture first bound to "
+ (code "GL_TEXTURE_3D")
+ " becomes three-dimensional texture, and a
+ texture first bound to "
+ (code "GL_TEXTURE_CUBE_MAP")
+ "
+becomes a cube-mapped texture. The state of a one-dimensional texture
+ immediately after it is first bound is equivalent to the state of the
+ default "
+ (code "GL_TEXTURE_1D")
+ " at GL initialization, and similarly for two-
+ and three-dimensional textures and cube-mapped textures. ")
+ (para "
+While a texture is bound, GL operations on the target to which it is
+ bound affect the bound texture, and queries of the target to which it
+ is bound return state from the bound texture. If texture mapping is active
+ on the target to which a texture is bound, the bound texture is used.
+ In effect, the texture targets become aliases for the textures currently
+ bound to them, and the texture name zero refers to the default textures
+ that were bound to them at initialization. ")
+ (para "
+A texture binding created with "
+ (code "glBindTexture")
+ " remains active until a different
+ texture is bound to the same target, or until the bound texture is
+ deleted with "
+ (code "glDeleteTextures")
+ ". ")
+ (para "
+Once created, a named texture may be re-bound to its same original target as often as needed.
+ It is usually much faster to use "
+ (code "glBindTexture")
+ " to bind an existing named
+ texture to one of the texture targets than it is to reload the texture image
+ using "
+ (code "glTexImage1D")
+ ", "
+ (code "glTexImage2D")
+ ", or "
+ (code "glTexImage3D")
+ ".
+ For additional control over performance, use "
+ (code "glPrioritizeTextures")
+ ". ")
+ (para (code "glBindTexture")
+ " is included in display lists. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "target")
+ " is not one of the allowable
+ values. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (var "texture")
+ " was previously created with a target
+ that doesn't match that of "
+ (var "target")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glBindTexture")
+ " is executed
+ between the execution of "
+ (code "glBegin")
+ " and the corresponding
+ execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glBitmap
+ "glBitmap"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glBitmap"))
+ (paramdef "GLsizei " (parameter "width"))
+ (paramdef "GLsizei " (parameter "height"))
+ (paramdef "GLfloat " (parameter "xorig"))
+ (paramdef "GLfloat " (parameter "yorig"))
+ (paramdef "GLfloat " (parameter "xmove"))
+ (paramdef "GLfloat " (parameter "ymove"))
+ (paramdef
+ "const GLubyte * "
+ (parameter "bitmap"))))
+ '(*fragment*
+ (heading "draw a bitmap")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "width")))
+ (itemx (var "height"))
+ (para "
+Specify the pixel width and height of the bitmap image. "))
+ (entry (% (heading (var "xorig")))
+ (itemx (var "yorig"))
+ (para "
+Specify the location of the origin in the bitmap image.
+ The origin is measured from the lower left corner of the bitmap,
+ with right and up being the positive axes. "))
+ (entry (% (heading (var "xmove")))
+ (itemx (var "ymove"))
+ (para "
+Specify the "
+ (var "x")
+ " and "
+ (var "y")
+ " offsets to be added to the current raster position
+ after the bitmap is drawn. "))
+ (entry (% (heading (var "bitmap")))
+ (para "
+Specifies the address of the bitmap image. ")))
+ (heading "Description")
+ (para "
+A bitmap is a binary image.
+ When drawn,
+ the bitmap is positioned relative to the current raster position,
+ and frame buffer pixels corresponding to 1's in the bitmap are
+ written using the current raster color or index.
+ Frame buffer pixels corresponding to 0's in the bitmap are not modified. ")
+ (para (code "glBitmap")
+ " takes seven arguments.
+ The first pair specifies the width and height of the bitmap image.
+ The second pair specifies the location of the bitmap origin relative
+ to the lower left corner of the bitmap image.
+ The third pair of arguments specifies "
+ (var "x")
+ " and "
+ (var "y")
+ " offsets to be added
+ to the current raster position after the bitmap has been drawn.
+ The final argument is a pointer to the bitmap image itself. ")
+ (para "
+If a non-zero named buffer object is bound to the "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ " target
+ (see "
+ (code "glBindBuffer")
+ ") while a bitmap image is
+ specified, "
+ (var "bitmap")
+ " is treated as a byte offset into the buffer object's data store. ")
+ (para "
+The bitmap image is interpreted like image data for the "
+ (code "glDrawPixels")
+ "
+command,
+ with "
+ (var "width")
+ " and "
+ (var "height")
+ " corresponding to the width and height arguments
+ of that command,
+ and with "
+ (var "type")
+ " set to "
+ (code "GL_BITMAP")
+ "
+and "
+ (var "format")
+ " set to "
+ (code "GL_COLOR_INDEX")
+ ".
+ Modes specified using "
+ (code "glPixelStore")
+ " affect the
+ interpretation of bitmap image data;
+ modes specified using "
+ (code "glPixelTransfer")
+ " do not. ")
+ (para "
+If the current raster position is invalid, "
+ (code "glBitmap")
+ " is ignored.
+ Otherwise,
+ the lower left corner of the bitmap image is positioned at the window coordinates ")
+ (para (math (var "x")
+ "_"
+ (var "w")
+ "="
+ "⌊"
+ (var "x")
+ "_"
+ (var "r")
+ "-"
+ (var "x")
+ "_"
+ (var "o")
+ ","
+ "⌋"))
+ (para (math (var "y")
+ "_"
+ (var "w")
+ "="
+ "⌊"
+ (var "y")
+ "_"
+ (var "r")
+ "-"
+ (var "y")
+ "_"
+ (var "o")
+ ","
+ "⌋"))
+ (para "
+where "
+ (math "("
+ (var "x")
+ "_"
+ (var "r")
+ ","
+ (var "y")
+ "_"
+ (var "r")
+ ")")
+ "
+is the raster position
+ and "
+ (math "("
+ (var "x")
+ "_"
+ (var "o")
+ ","
+ (var "y")
+ "_"
+ (var "o")
+ ")")
+ "
+is the bitmap origin.
+ Fragments are then generated for each pixel corresponding to a 1 (one)
+ in the bitmap image.
+ These fragments are generated using the current raster "
+ (var "z")
+ " coordinate,
+ color or color index, and current raster texture coordinates.
+ They are then treated just as if they had been generated
+ by a point, line, or polygon,
+ including texture mapping,
+ fogging,
+ and all per-fragment operations such as alpha and depth testing. ")
+ (para "
+After the bitmap has been drawn,
+ the "
+ (var "x")
+ " and "
+ (var "y")
+ " coordinates of the current raster position are offset by "
+ (var "xmove")
+ " and "
+ (var "ymove")
+ ".
+ No change is made to the "
+ (var "z")
+ " coordinate of the current raster position,
+ or to the current raster color, texture coordinates, or index. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "width")
+ " or "
+ (var "height")
+ " is negative. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a non-zero buffer object name is bound to the "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ " target and the buffer object's data store is currently mapped. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a non-zero buffer object name is bound to the "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ " target and the data would be unpacked from the buffer
+ object such that the memory reads required would exceed the data store size. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glBitmap")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ " and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glBlendColor
+ "glBlendColor"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glBlendColor"))
+ (paramdef "GLclampf " (parameter "red"))
+ (paramdef "GLclampf " (parameter "green"))
+ (paramdef "GLclampf " (parameter "blue"))
+ (paramdef "GLclampf " (parameter "alpha"))))
+ '(*fragment*
+ (heading "set the blend color")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "red")))
+ (itemx (var "green"))
+ (itemx (var "blue"))
+ (itemx (var "alpha"))
+ (para "
+specify the components of "
+ (code "GL_BLEND_COLOR"))))
+ (heading "Description")
+ (para "
+The "
+ (code "GL_BLEND_COLOR")
+ " may be used to calculate the source and destination
+ blending factors. The color components are clamped to the range "
+ (math "[" "0" "," "1" "]")
+ "
+before being stored. See "
+ (code "glBlendFunc")
+ " for a complete description of the
+ blending operations.
+ Initially the "
+ (code "GL_BLEND_COLOR")
+ " is set to (0, 0, 0, 0). ")
+ (heading "Errors")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glBlendColor")
+ " is executed
+ between the execution of "
+ (code "glBegin")
+ " and the corresponding
+ execution of "
+ (code "glEnd")
+ ". ")
+ (para)))
+
+(define-gl-procedure
+ glBlendEquationSeparate
+ "glBlendEquationSeparate"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "void "
+ (function "glBlendEquationSeparate"))
+ (paramdef "GLenum " (parameter "modeRGB"))
+ (paramdef "GLenum " (parameter "modeAlpha"))))
+ '(*fragment*
+ (heading
+ "set the RGB blend equation and the alpha blend equation separately")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "modeRGB")))
+ (para "
+specifies the RGB blend equation, how the red, green, and blue components of the source and destination colors are combined.
+ It must be "
+ (code "GL_FUNC_ADD")
+ ", "
+ (code "GL_FUNC_SUBTRACT")
+ ", "
+ (code "GL_FUNC_REVERSE_SUBTRACT")
+ ", "
+ (code "GL_MIN")
+ ", "
+ (code "GL_MAX")
+ ". "))
+ (entry (% (heading (var "modeAlpha")))
+ (para "
+specifies the alpha blend equation, how the alpha component of the source and destination colors are combined.
+ It must be "
+ (code "GL_FUNC_ADD")
+ ", "
+ (code "GL_FUNC_SUBTRACT")
+ ", "
+ (code "GL_FUNC_REVERSE_SUBTRACT")
+ ", "
+ (code "GL_MIN")
+ ", "
+ (code "GL_MAX")
+ ". ")))
+ (heading "Description")
+ (para "
+The blend equations determines how a new pixel (the ''source'' color)
+ is combined with a pixel already in the framebuffer (the ''destination''
+ color). This function specifies one blend equation for the RGB-color
+ components and one blend equation for the alpha component. ")
+ (para "
+The blend equations use the source and destination blend factors
+ specified by either "
+ (code "glBlendFunc")
+ " or "
+ (code "glBlendFuncSeparate")
+ ".
+ See "
+ (code "glBlendFunc")
+ " or "
+ (code "glBlendFuncSeparate")
+ "
+for a description of the various blend factors. ")
+ (para "
+In the equations that follow, source and destination
+ color components are referred to as "
+ (math "("
+ (var "R")
+ "_"
+ (var "s")
+ ","
+ (var "G")
+ "_"
+ (var "s")
+ (var "B")
+ "_"
+ (var "s")
+ (var "A")
+ "_"
+ (var "s")
+ ")")
+ "
+and "
+ (math "("
+ (var "R")
+ "_"
+ (var "d")
+ ","
+ (var "G")
+ "_"
+ (var "d")
+ (var "B")
+ "_"
+ (var "d")
+ (var "A")
+ "_"
+ (var "d")
+ ")")
+ ",
+ respectively.
+ The result color is referred to as "
+ (math "("
+ (var "R")
+ "_"
+ (var "r")
+ ","
+ (var "G")
+ "_"
+ (var "r")
+ (var "B")
+ "_"
+ (var "r")
+ (var "A")
+ "_"
+ (var "r")
+ ")")
+ ".
+ The source and destination blend factors are denoted "
+ (math "("
+ (var "s")
+ "_"
+ (var "R")
+ ","
+ (var "s")
+ "_"
+ (var "G")
+ (var "s")
+ "_"
+ (var "B")
+ (var "s")
+ "_"
+ (var "A")
+ ")")
+ "
+and "
+ (math "("
+ (var "d")
+ "_"
+ (var "R")
+ ","
+ (var "d")
+ "_"
+ (var "G")
+ (var "d")
+ "_"
+ (var "B")
+ (var "d")
+ "_"
+ (var "A")
+ ")")
+ ",
+ respectively.
+ For these equations all color components are understood to have values
+ in the range "
+ (math "[" "0" "," "1" "]")
+ ". ")
+ (table (% (formatter (asis)))
+ (entry (% (heading (strong "Mode")))
+ (para (strong "RGB Components")
+ ", "
+ (strong "Alpha Component")))
+ (entry (% (heading (code "GL_FUNC_ADD")))
+ (para (math (var "Rr")
+ "="
+ (var "R")
+ "_"
+ (var "s")
+ "\u2062"
+ (var "s")
+ "_"
+ (var "R")
+ "+"
+ (var "R")
+ "_"
+ (var "d")
+ "\u2062"
+ (var "d")
+ "_"
+ (var "R"))
+ (math (var "Gr")
+ "="
+ (var "G")
+ "_"
+ (var "s")
+ "\u2062"
+ (var "s")
+ "_"
+ (var "G")
+ "+"
+ (var "G")
+ "_"
+ (var "d")
+ "\u2062"
+ (var "d")
+ "_"
+ (var "G"))
+ (math (var "Br")
+ "="
+ (var "B")
+ "_"
+ (var "s")
+ "\u2062"
+ (var "s")
+ "_"
+ (var "B")
+ "+"
+ (var "B")
+ "_"
+ (var "d")
+ "\u2062"
+ (var "d")
+ "_"
+ (var "B"))
+ ", "
+ (math (var "Ar")
+ "="
+ (var "A")
+ "_"
+ (var "s")
+ "\u2062"
+ (var "s")
+ "_"
+ (var "A")
+ "+"
+ (var "A")
+ "_"
+ (var "d")
+ "\u2062"
+ (var "d")
+ "_"
+ (var "A"))))
+ (entry (% (heading (code "GL_FUNC_SUBTRACT")))
+ (para (math (var "Rr")
+ "="
+ (var "R")
+ "_"
+ (var "s")
+ "\u2062"
+ (var "s")
+ "_"
+ (var "R")
+ "-"
+ (var "R")
+ "_"
+ (var "d")
+ "\u2062"
+ (var "d")
+ "_"
+ (var "R"))
+ (math (var "Gr")
+ "="
+ (var "G")
+ "_"
+ (var "s")
+ "\u2062"
+ (var "s")
+ "_"
+ (var "G")
+ "-"
+ (var "G")
+ "_"
+ (var "d")
+ "\u2062"
+ (var "d")
+ "_"
+ (var "G"))
+ (math (var "Br")
+ "="
+ (var "B")
+ "_"
+ (var "s")
+ "\u2062"
+ (var "s")
+ "_"
+ (var "B")
+ "-"
+ (var "B")
+ "_"
+ (var "d")
+ "\u2062"
+ (var "d")
+ "_"
+ (var "B"))
+ ", "
+ (math (var "Ar")
+ "="
+ (var "A")
+ "_"
+ (var "s")
+ "\u2062"
+ (var "s")
+ "_"
+ (var "A")
+ "-"
+ (var "A")
+ "_"
+ (var "d")
+ "\u2062"
+ (var "d")
+ "_"
+ (var "A"))))
+ (entry (% (heading (code "GL_FUNC_REVERSE_SUBTRACT")))
+ (para (math (var "Rr")
+ "="
+ (var "R")
+ "_"
+ (var "d")
+ "\u2062"
+ (var "d")
+ "_"
+ (var "R")
+ "-"
+ (var "R")
+ "_"
+ (var "s")
+ "\u2062"
+ (var "s")
+ "_"
+ (var "R"))
+ (math (var "Gr")
+ "="
+ (var "G")
+ "_"
+ (var "d")
+ "\u2062"
+ (var "d")
+ "_"
+ (var "G")
+ "-"
+ (var "G")
+ "_"
+ (var "s")
+ "\u2062"
+ (var "s")
+ "_"
+ (var "G"))
+ (math (var "Br")
+ "="
+ (var "B")
+ "_"
+ (var "d")
+ "\u2062"
+ (var "d")
+ "_"
+ (var "B")
+ "-"
+ (var "B")
+ "_"
+ (var "s")
+ "\u2062"
+ (var "s")
+ "_"
+ (var "B"))
+ ", "
+ (math (var "Ar")
+ "="
+ (var "A")
+ "_"
+ (var "d")
+ "\u2062"
+ (var "d")
+ "_"
+ (var "A")
+ "-"
+ (var "A")
+ "_"
+ (var "s")
+ "\u2062"
+ (var "s")
+ "_"
+ (var "A"))))
+ (entry (% (heading (code "GL_MIN")))
+ (para (math (var "Rr")
+ "="
+ (var "min")
+ "\u2061"
+ "("
+ (var "R")
+ "_"
+ (var "s")
+ ","
+ (var "R")
+ "_"
+ (var "d")
+ ")")
+ (math (var "Gr")
+ "="
+ (var "min")
+ "\u2061"
+ "("
+ (var "G")
+ "_"
+ (var "s")
+ ","
+ (var "G")
+ "_"
+ (var "d")
+ ")")
+ (math (var "Br")
+ "="
+ (var "min")
+ "\u2061"
+ "("
+ (var "B")
+ "_"
+ (var "s")
+ ","
+ (var "B")
+ "_"
+ (var "d")
+ ")")
+ ", "
+ (math (var "Ar")
+ "="
+ (var "min")
+ "\u2061"
+ "("
+ (var "A")
+ "_"
+ (var "s")
+ ","
+ (var "A")
+ "_"
+ (var "d")
+ ")")))
+ (entry (% (heading (code "GL_MAX")))
+ (para (math (var "Rr")
+ "="
+ (var "max")
+ "\u2061"
+ "("
+ (var "R")
+ "_"
+ (var "s")
+ ","
+ (var "R")
+ "_"
+ (var "d")
+ ")")
+ (math (var "Gr")
+ "="
+ (var "max")
+ "\u2061"
+ "("
+ (var "G")
+ "_"
+ (var "s")
+ ","
+ (var "G")
+ "_"
+ (var "d")
+ ")")
+ (math (var "Br")
+ "="
+ (var "max")
+ "\u2061"
+ "("
+ (var "B")
+ "_"
+ (var "s")
+ ","
+ (var "B")
+ "_"
+ (var "d")
+ ")")
+ ", "
+ (math (var "Ar")
+ "="
+ (var "max")
+ "\u2061"
+ "("
+ (var "A")
+ "_"
+ (var "s")
+ ","
+ (var "A")
+ "_"
+ (var "d")
+ ")"))))
+ (para "
+The results of these equations are clamped to the range "
+ (math "[" "0" "," "1" "]")
+ ". ")
+ (para "
+The "
+ (code "GL_MIN")
+ " and "
+ (code "GL_MAX")
+ " equations are useful for applications
+ that analyze image data (image thresholding against a constant color,
+ for example).
+ The "
+ (code "GL_FUNC_ADD")
+ " equation is useful
+ for antialiasing and transparency, among other things. ")
+ (para "
+Initially, both the RGB blend equation and the alpha blend equation are set to "
+ (code "GL_FUNC_ADD")
+ ". ")
+ (para)
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if either "
+ (var "modeRGB")
+ " or "
+ (var "modeAlpha")
+ " is not one of "
+ (code "GL_FUNC_ADD")
+ ", "
+ (code "GL_FUNC_SUBTRACT")
+ ", "
+ (code "GL_FUNC_REVERSE_SUBTRACT")
+ ", "
+ (code "GL_MAX")
+ ", or "
+ (code "GL_MIN")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glBlendEquationSeparate")
+ " is executed
+ between the execution of "
+ (code "glBegin")
+ " and the corresponding
+ execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glBlendEquation
+ "glBlendEquation"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glBlendEquation"))
+ (paramdef "GLenum " (parameter "mode"))))
+ '(*fragment*
+ (heading
+ "specify the equation used for both the RGB blend equation and the Alpha blend equation")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "mode")))
+ (para "
+specifies how source and destination colors are combined.
+ It must be "
+ (code "GL_FUNC_ADD")
+ ", "
+ (code "GL_FUNC_SUBTRACT")
+ ", "
+ (code "GL_FUNC_REVERSE_SUBTRACT")
+ ", "
+ (code "GL_MIN")
+ ", "
+ (code "GL_MAX")
+ ". ")))
+ (heading "Description")
+ (para "
+The blend equations determine how a new pixel (the ''source'' color)
+ is combined with a pixel already in the framebuffer (the ''destination''
+ color). This function sets both the RGB blend equation and the alpha
+ blend equation to a single equation. ")
+ (para "
+These equations use the source and destination blend factors
+ specified by either "
+ (code "glBlendFunc")
+ " or "
+ (code "glBlendFuncSeparate")
+ ".
+ See "
+ (code "glBlendFunc")
+ " or "
+ (code "glBlendFuncSeparate")
+ "
+for a description of the various blend factors. ")
+ (para "
+In the equations that follow, source and destination
+ color components are referred to as "
+ (math "("
+ (var "R")
+ "_"
+ (var "s")
+ ","
+ (var "G")
+ "_"
+ (var "s")
+ (var "B")
+ "_"
+ (var "s")
+ (var "A")
+ "_"
+ (var "s")
+ ")")
+ "
+and "
+ (math "("
+ (var "R")
+ "_"
+ (var "d")
+ ","
+ (var "G")
+ "_"
+ (var "d")
+ (var "B")
+ "_"
+ (var "d")
+ (var "A")
+ "_"
+ (var "d")
+ ")")
+ ",
+ respectively.
+ The result color is referred to as "
+ (math "("
+ (var "R")
+ "_"
+ (var "r")
+ ","
+ (var "G")
+ "_"
+ (var "r")
+ (var "B")
+ "_"
+ (var "r")
+ (var "A")
+ "_"
+ (var "r")
+ ")")
+ ".
+ The source and destination blend factors are denoted "
+ (math "("
+ (var "s")
+ "_"
+ (var "R")
+ ","
+ (var "s")
+ "_"
+ (var "G")
+ (var "s")
+ "_"
+ (var "B")
+ (var "s")
+ "_"
+ (var "A")
+ ")")
+ "
+and "
+ (math "("
+ (var "d")
+ "_"
+ (var "R")
+ ","
+ (var "d")
+ "_"
+ (var "G")
+ (var "d")
+ "_"
+ (var "B")
+ (var "d")
+ "_"
+ (var "A")
+ ")")
+ ",
+ respectively.
+ For these equations all color components are understood to have values
+ in the range "
+ (math "[" "0" "," "1" "]")
+ ". ")
+ (table (% (formatter (asis)))
+ (entry (% (heading (strong "Mode")))
+ (para (strong "RGB Components")
+ ", "
+ (strong "Alpha Component")))
+ (entry (% (heading (code "GL_FUNC_ADD")))
+ (para (math (var "Rr")
+ "="
+ (var "R")
+ "_"
+ (var "s")
+ "\u2062"
+ (var "s")
+ "_"
+ (var "R")
+ "+"
+ (var "R")
+ "_"
+ (var "d")
+ "\u2062"
+ (var "d")
+ "_"
+ (var "R"))
+ (math (var "Gr")
+ "="
+ (var "G")
+ "_"
+ (var "s")
+ "\u2062"
+ (var "s")
+ "_"
+ (var "G")
+ "+"
+ (var "G")
+ "_"
+ (var "d")
+ "\u2062"
+ (var "d")
+ "_"
+ (var "G"))
+ (math (var "Br")
+ "="
+ (var "B")
+ "_"
+ (var "s")
+ "\u2062"
+ (var "s")
+ "_"
+ (var "B")
+ "+"
+ (var "B")
+ "_"
+ (var "d")
+ "\u2062"
+ (var "d")
+ "_"
+ (var "B"))
+ ", "
+ (math (var "Ar")
+ "="
+ (var "A")
+ "_"
+ (var "s")
+ "\u2062"
+ (var "s")
+ "_"
+ (var "A")
+ "+"
+ (var "A")
+ "_"
+ (var "d")
+ "\u2062"
+ (var "d")
+ "_"
+ (var "A"))))
+ (entry (% (heading (code "GL_FUNC_SUBTRACT")))
+ (para (math (var "Rr")
+ "="
+ (var "R")
+ "_"
+ (var "s")
+ "\u2062"
+ (var "s")
+ "_"
+ (var "R")
+ "-"
+ (var "R")
+ "_"
+ (var "d")
+ "\u2062"
+ (var "d")
+ "_"
+ (var "R"))
+ (math (var "Gr")
+ "="
+ (var "G")
+ "_"
+ (var "s")
+ "\u2062"
+ (var "s")
+ "_"
+ (var "G")
+ "-"
+ (var "G")
+ "_"
+ (var "d")
+ "\u2062"
+ (var "d")
+ "_"
+ (var "G"))
+ (math (var "Br")
+ "="
+ (var "B")
+ "_"
+ (var "s")
+ "\u2062"
+ (var "s")
+ "_"
+ (var "B")
+ "-"
+ (var "B")
+ "_"
+ (var "d")
+ "\u2062"
+ (var "d")
+ "_"
+ (var "B"))
+ ", "
+ (math (var "Ar")
+ "="
+ (var "A")
+ "_"
+ (var "s")
+ "\u2062"
+ (var "s")
+ "_"
+ (var "A")
+ "-"
+ (var "A")
+ "_"
+ (var "d")
+ "\u2062"
+ (var "d")
+ "_"
+ (var "A"))))
+ (entry (% (heading (code "GL_FUNC_REVERSE_SUBTRACT")))
+ (para (math (var "Rr")
+ "="
+ (var "R")
+ "_"
+ (var "d")
+ "\u2062"
+ (var "d")
+ "_"
+ (var "R")
+ "-"
+ (var "R")
+ "_"
+ (var "s")
+ "\u2062"
+ (var "s")
+ "_"
+ (var "R"))
+ (math (var "Gr")
+ "="
+ (var "G")
+ "_"
+ (var "d")
+ "\u2062"
+ (var "d")
+ "_"
+ (var "G")
+ "-"
+ (var "G")
+ "_"
+ (var "s")
+ "\u2062"
+ (var "s")
+ "_"
+ (var "G"))
+ (math (var "Br")
+ "="
+ (var "B")
+ "_"
+ (var "d")
+ "\u2062"
+ (var "d")
+ "_"
+ (var "B")
+ "-"
+ (var "B")
+ "_"
+ (var "s")
+ "\u2062"
+ (var "s")
+ "_"
+ (var "B"))
+ ", "
+ (math (var "Ar")
+ "="
+ (var "A")
+ "_"
+ (var "d")
+ "\u2062"
+ (var "d")
+ "_"
+ (var "A")
+ "-"
+ (var "A")
+ "_"
+ (var "s")
+ "\u2062"
+ (var "s")
+ "_"
+ (var "A"))))
+ (entry (% (heading (code "GL_MIN")))
+ (para (math (var "Rr")
+ "="
+ (var "min")
+ "\u2061"
+ "("
+ (var "R")
+ "_"
+ (var "s")
+ ","
+ (var "R")
+ "_"
+ (var "d")
+ ")")
+ (math (var "Gr")
+ "="
+ (var "min")
+ "\u2061"
+ "("
+ (var "G")
+ "_"
+ (var "s")
+ ","
+ (var "G")
+ "_"
+ (var "d")
+ ")")
+ (math (var "Br")
+ "="
+ (var "min")
+ "\u2061"
+ "("
+ (var "B")
+ "_"
+ (var "s")
+ ","
+ (var "B")
+ "_"
+ (var "d")
+ ")")
+ ", "
+ (math (var "Ar")
+ "="
+ (var "min")
+ "\u2061"
+ "("
+ (var "A")
+ "_"
+ (var "s")
+ ","
+ (var "A")
+ "_"
+ (var "d")
+ ")")))
+ (entry (% (heading (code "GL_MAX")))
+ (para (math (var "Rr")
+ "="
+ (var "max")
+ "\u2061"
+ "("
+ (var "R")
+ "_"
+ (var "s")
+ ","
+ (var "R")
+ "_"
+ (var "d")
+ ")")
+ (math (var "Gr")
+ "="
+ (var "max")
+ "\u2061"
+ "("
+ (var "G")
+ "_"
+ (var "s")
+ ","
+ (var "G")
+ "_"
+ (var "d")
+ ")")
+ (math (var "Br")
+ "="
+ (var "max")
+ "\u2061"
+ "("
+ (var "B")
+ "_"
+ (var "s")
+ ","
+ (var "B")
+ "_"
+ (var "d")
+ ")")
+ ", "
+ (math (var "Ar")
+ "="
+ (var "max")
+ "\u2061"
+ "("
+ (var "A")
+ "_"
+ (var "s")
+ ","
+ (var "A")
+ "_"
+ (var "d")
+ ")"))))
+ (para "
+The results of these equations are clamped to the range "
+ (math "[" "0" "," "1" "]")
+ ". ")
+ (para "
+The "
+ (code "GL_MIN")
+ " and "
+ (code "GL_MAX")
+ " equations are useful for applications
+ that analyze image data (image thresholding against a constant color,
+ for example).
+ The "
+ (code "GL_FUNC_ADD")
+ " equation is useful
+ for antialiasing and transparency, among other things. ")
+ (para "
+Initially, both the RGB blend equation and the alpha blend equation are set to "
+ (code "GL_FUNC_ADD")
+ ". ")
+ (para)
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "mode")
+ " is not one of "
+ (code "GL_FUNC_ADD")
+ ", "
+ (code "GL_FUNC_SUBTRACT")
+ ", "
+ (code "GL_FUNC_REVERSE_SUBTRACT")
+ ", "
+ (code "GL_MAX")
+ ", or "
+ (code "GL_MIN")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glBlendEquation")
+ " is executed
+ between the execution of "
+ (code "glBegin")
+ " and the corresponding
+ execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glBlendFuncSeparate
+ "glBlendFuncSeparate"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "void "
+ (function "glBlendFuncSeparate"))
+ (paramdef "GLenum " (parameter "srcRGB"))
+ (paramdef "GLenum " (parameter "dstRGB"))
+ (paramdef "GLenum " (parameter "srcAlpha"))
+ (paramdef "GLenum " (parameter "dstAlpha"))))
+ '(*fragment*
+ (heading
+ "specify pixel arithmetic for RGB and alpha components separately")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "srcRGB")))
+ (para "
+Specifies how the red, green, and blue blending factors are computed.
+ The following symbolic constants are accepted: "
+ (code "GL_ZERO")
+ ", "
+ (code "GL_ONE")
+ ", "
+ (code "GL_SRC_COLOR")
+ ", "
+ (code "GL_ONE_MINUS_SRC_COLOR")
+ ", "
+ (code "GL_DST_COLOR")
+ ", "
+ (code "GL_ONE_MINUS_DST_COLOR")
+ ", "
+ (code "GL_SRC_ALPHA")
+ ", "
+ (code "GL_ONE_MINUS_SRC_ALPHA")
+ ", "
+ (code "GL_DST_ALPHA")
+ ", "
+ (code "GL_ONE_MINUS_DST_ALPHA")
+ ", "
+ (code "GL_CONSTANT_COLOR")
+ ", "
+ (code "GL_ONE_MINUS_CONSTANT_COLOR")
+ ", "
+ (code "GL_CONSTANT_ALPHA")
+ ", "
+ (code "GL_ONE_MINUS_CONSTANT_ALPHA")
+ ", and "
+ (code "GL_SRC_ALPHA_SATURATE")
+ ".
+ The initial value is "
+ (code "GL_ONE")
+ ". "))
+ (entry (% (heading (var "dstRGB")))
+ (para "
+Specifies how the red, green, and blue destination blending factors are
+ computed. The following symbolic constants are accepted: "
+ (code "GL_ZERO")
+ ", "
+ (code "GL_ONE")
+ ", "
+ (code "GL_SRC_COLOR")
+ ", "
+ (code "GL_ONE_MINUS_SRC_COLOR")
+ ", "
+ (code "GL_DST_COLOR")
+ ", "
+ (code "GL_ONE_MINUS_DST_COLOR")
+ ", "
+ (code "GL_SRC_ALPHA")
+ ", "
+ (code "GL_ONE_MINUS_SRC_ALPHA")
+ ", "
+ (code "GL_DST_ALPHA")
+ ", "
+ (code "GL_ONE_MINUS_DST_ALPHA")
+ ". "
+ (code "GL_CONSTANT_COLOR")
+ ", "
+ (code "GL_ONE_MINUS_CONSTANT_COLOR")
+ ", "
+ (code "GL_CONSTANT_ALPHA")
+ ", and "
+ (code "GL_ONE_MINUS_CONSTANT_ALPHA")
+ ".
+ The initial value is "
+ (code "GL_ZERO")
+ ". "))
+ (entry (% (heading (var "srcAlpha")))
+ (para "
+Specified how the alpha source blending factor is computed. The same
+ symbolic constants are accepted as for "
+ (var "srcRGB")
+ ".
+ The initial value is "
+ (code "GL_ONE")
+ ". "))
+ (entry (% (heading (var "dstAlpha")))
+ (para "
+Specified how the alpha destination blending factor is computed. The same
+ symbolic constants are accepted as for "
+ (var "dstRGB")
+ ".
+ The initial value is "
+ (code "GL_ZERO")
+ ". ")))
+ (heading "Description")
+ (para "
+In RGBA mode, pixels can be drawn using a function that blends
+ the incoming (source) RGBA values with the RGBA values
+ that are already in the frame buffer (the destination values).
+ Blending is initially disabled.
+ Use "
+ (code "glEnable")
+ " and "
+ (code "glDisable")
+ " with argument "
+ (code "GL_BLEND")
+ "
+to enable and disable blending. ")
+ (para (code "glBlendFuncSeparate")
+ " defines the operation of blending when it is enabled. "
+ (var "srcRGB")
+ " specifies which method is used to scale the
+ source RGB-color components. "
+ (var "dstRGB")
+ " specifies which method is used to scale the
+ destination RGB-color components.
+ Likewise, "
+ (var "srcAlpha")
+ " specifies which method is used to scale the source alpha
+ color component, and "
+ (var "dstAlpha")
+ " specifies which method is used to scale the
+ destination alpha component.
+ The possible methods are described in the following table.
+ Each method defines four scale factors,
+ one each for red, green, blue, and alpha. ")
+ (para "
+In the table and in subsequent equations, source and destination
+ color components are referred to as "
+ (math "("
+ (var "R")
+ "_"
+ (var "s")
+ ","
+ (var "G")
+ "_"
+ (var "s")
+ (var "B")
+ "_"
+ (var "s")
+ (var "A")
+ "_"
+ (var "s")
+ ")")
+ "
+and "
+ (math "("
+ (var "R")
+ "_"
+ (var "d")
+ ","
+ (var "G")
+ "_"
+ (var "d")
+ (var "B")
+ "_"
+ (var "d")
+ (var "A")
+ "_"
+ (var "d")
+ ")")
+ ".
+ The color specified by "
+ (code "glBlendColor")
+ " is referred to as "
+ (math "("
+ (var "R")
+ "_"
+ (var "c")
+ ","
+ (var "G")
+ "_"
+ (var "c")
+ (var "B")
+ "_"
+ (var "c")
+ (var "A")
+ "_"
+ (var "c")
+ ")")
+ ".
+ They are understood to have integer values between 0 and "
+ (math "("
+ (var "k")
+ "_"
+ (var "R")
+ ","
+ (var "k")
+ "_"
+ (var "G")
+ (var "k")
+ "_"
+ (var "B")
+ (var "k")
+ "_"
+ (var "A")
+ ")")
+ ",
+ where ")
+ (para (para (math (var "k")
+ "_"
+ (var "c")
+ "="
+ "2"
+ "^"
+ (var "m")
+ "_"
+ (var "c")
+ ","
+ "-"
+ "1")))
+ (para "
+and "
+ (math "("
+ (var "m")
+ "_"
+ (var "R")
+ ","
+ (var "m")
+ "_"
+ (var "G")
+ (var "m")
+ "_"
+ (var "B")
+ (var "m")
+ "_"
+ (var "A")
+ ")")
+ "
+is the number of red,
+ green,
+ blue,
+ and alpha bitplanes. ")
+ (para "
+Source and destination scale factors are referred to as "
+ (math "("
+ (var "s")
+ "_"
+ (var "R")
+ ","
+ (var "s")
+ "_"
+ (var "G")
+ (var "s")
+ "_"
+ (var "B")
+ (var "s")
+ "_"
+ (var "A")
+ ")")
+ "
+and "
+ (math "("
+ (var "d")
+ "_"
+ (var "R")
+ ","
+ (var "d")
+ "_"
+ (var "G")
+ (var "d")
+ "_"
+ (var "B")
+ (var "d")
+ "_"
+ (var "A")
+ ")")
+ ".
+ All scale factors have range "
+ (math "[" "0" "," "1" "]")
+ ". ")
+ (para)
+ (table (% (formatter (asis)))
+ (entry (% (heading (strong "Parameter")))
+ (para (strong "RGB Factor")
+ ", "
+ (strong "Alpha Factor")))
+ (entry (% (heading (code "GL_ZERO")))
+ (para (math "(" "0" "," "0" "0" ")")
+ ", "
+ (math "0")))
+ (entry (% (heading (code "GL_ONE")))
+ (para (math "(" "1" "," "1" "1" ")")
+ ", "
+ (math "1")))
+ (entry (% (heading (code "GL_SRC_COLOR")))
+ (para (math "("
+ (var "R")
+ "_"
+ (var "s")
+ "/"
+ (var "k")
+ "_"
+ (var "R")
+ ","
+ (var "G")
+ "_"
+ (var "s")
+ "/"
+ (var "k")
+ "_"
+ (var "G")
+ (var "B")
+ "_"
+ (var "s")
+ "/"
+ (var "k")
+ "_"
+ (var "B")
+ ")")
+ ", "
+ (math (var "A")
+ "_"
+ (var "s")
+ "/"
+ (var "k")
+ "_"
+ (var "A"))))
+ (entry (% (heading (code "GL_ONE_MINUS_SRC_COLOR")))
+ (para (math "("
+ "1"
+ ","
+ "1"
+ "1"
+ "1"
+ ")"
+ "-"
+ "("
+ (var "R")
+ "_"
+ (var "s")
+ "/"
+ (var "k")
+ "_"
+ (var "R")
+ ","
+ (var "G")
+ "_"
+ (var "s")
+ "/"
+ (var "k")
+ "_"
+ (var "G")
+ (var "B")
+ "_"
+ (var "s")
+ "/"
+ (var "k")
+ "_"
+ (var "B")
+ ")")
+ ", "
+ (math "1"
+ "-"
+ (var "A")
+ "_"
+ (var "s")
+ "/"
+ (var "k")
+ "_"
+ (var "A"))))
+ (entry (% (heading (code "GL_DST_COLOR")))
+ (para (math "("
+ (var "R")
+ "_"
+ (var "d")
+ "/"
+ (var "k")
+ "_"
+ (var "R")
+ ","
+ (var "G")
+ "_"
+ (var "d")
+ "/"
+ (var "k")
+ "_"
+ (var "G")
+ (var "B")
+ "_"
+ (var "d")
+ "/"
+ (var "k")
+ "_"
+ (var "B")
+ ")")
+ ", "
+ (math (var "A")
+ "_"
+ (var "d")
+ "/"
+ (var "k")
+ "_"
+ (var "A"))))
+ (entry (% (heading (code "GL_ONE_MINUS_DST_COLOR")))
+ (para (math "("
+ "1"
+ ","
+ "1"
+ "1"
+ ")"
+ "-"
+ "("
+ (var "R")
+ "_"
+ (var "d")
+ "/"
+ (var "k")
+ "_"
+ (var "R")
+ ","
+ (var "G")
+ "_"
+ (var "d")
+ "/"
+ (var "k")
+ "_"
+ (var "G")
+ (var "B")
+ "_"
+ (var "d")
+ "/"
+ (var "k")
+ "_"
+ (var "B")
+ ")")
+ ", "
+ (math "1"
+ "-"
+ (var "A")
+ "_"
+ (var "d")
+ "/"
+ (var "k")
+ "_"
+ (var "A"))))
+ (entry (% (heading (code "GL_SRC_ALPHA")))
+ (para (math "("
+ (var "A")
+ "_"
+ (var "s")
+ "/"
+ (var "k")
+ "_"
+ (var "A")
+ ","
+ (var "A")
+ "_"
+ (var "s")
+ "/"
+ (var "k")
+ "_"
+ (var "A")
+ (var "A")
+ "_"
+ (var "s")
+ "/"
+ (var "k")
+ "_"
+ (var "A")
+ ")")
+ ", "
+ (math (var "A")
+ "_"
+ (var "s")
+ "/"
+ (var "k")
+ "_"
+ (var "A"))))
+ (entry (% (heading (code "GL_ONE_MINUS_SRC_ALPHA")))
+ (para (math "("
+ "1"
+ ","
+ "1"
+ "1"
+ ")"
+ "-"
+ "("
+ (var "A")
+ "_"
+ (var "s")
+ "/"
+ (var "k")
+ "_"
+ (var "A")
+ ","
+ (var "A")
+ "_"
+ (var "s")
+ "/"
+ (var "k")
+ "_"
+ (var "A")
+ (var "A")
+ "_"
+ (var "s")
+ "/"
+ (var "k")
+ "_"
+ (var "A")
+ ")")
+ ", "
+ (math "1"
+ "-"
+ (var "A")
+ "_"
+ (var "s")
+ "/"
+ (var "k")
+ "_"
+ (var "A"))))
+ (entry (% (heading (code "GL_DST_ALPHA")))
+ (para (math "("
+ (var "A")
+ "_"
+ (var "d")
+ "/"
+ (var "k")
+ "_"
+ (var "A")
+ ","
+ (var "A")
+ "_"
+ (var "d")
+ "/"
+ (var "k")
+ "_"
+ (var "A")
+ (var "A")
+ "_"
+ (var "d")
+ "/"
+ (var "k")
+ "_"
+ (var "A")
+ ")")
+ ", "
+ (math (var "A")
+ "_"
+ (var "d")
+ "/"
+ (var "k")
+ "_"
+ (var "A"))))
+ (entry (% (heading (code "GL_ONE_MINUS_DST_ALPHA")))
+ (para (math "("
+ "1"
+ ","
+ "1"
+ "1"
+ ")"
+ "-"
+ "("
+ (var "A")
+ "_"
+ (var "d")
+ "/"
+ (var "k")
+ "_"
+ (var "A")
+ ","
+ (var "A")
+ "_"
+ (var "d")
+ "/"
+ (var "k")
+ "_"
+ (var "A")
+ (var "A")
+ "_"
+ (var "d")
+ "/"
+ (var "k")
+ "_"
+ (var "A")
+ ")")
+ ", "
+ (math "1"
+ "-"
+ (var "A")
+ "_"
+ (var "d")
+ "/"
+ (var "k")
+ "_"
+ (var "A"))))
+ (entry (% (heading (code "GL_CONSTANT_COLOR")))
+ (para (math "("
+ (var "R")
+ "_"
+ (var "c")
+ ","
+ (var "G")
+ "_"
+ (var "c")
+ (var "B")
+ "_"
+ (var "c")
+ ")")
+ ", "
+ (math (var "A") "_" (var "c"))))
+ (entry (% (heading (code "GL_ONE_MINUS_CONSTANT_COLOR")))
+ (para (math "("
+ "1"
+ ","
+ "1"
+ "1"
+ ")"
+ "-"
+ "("
+ (var "R")
+ "_"
+ (var "c")
+ ","
+ (var "G")
+ "_"
+ (var "c")
+ (var "B")
+ "_"
+ (var "c")
+ ")")
+ ", "
+ (math "1" "-" (var "A") "_" (var "c"))))
+ (entry (% (heading (code "GL_CONSTANT_ALPHA")))
+ (para (math "("
+ (var "A")
+ "_"
+ (var "c")
+ ","
+ (var "A")
+ "_"
+ (var "c")
+ (var "A")
+ "_"
+ (var "c")
+ ")")
+ ", "
+ (math (var "A") "_" (var "c"))))
+ (entry (% (heading (code "GL_ONE_MINUS_CONSTANT_ALPHA")))
+ (para (math "("
+ "1"
+ ","
+ "1"
+ "1"
+ ")"
+ "-"
+ "("
+ (var "A")
+ "_"
+ (var "c")
+ ","
+ (var "A")
+ "_"
+ (var "c")
+ (var "A")
+ "_"
+ (var "c")
+ ")")
+ ", "
+ (math "1" "-" (var "A") "_" (var "c"))))
+ (entry (% (heading (code "GL_SRC_ALPHA_SATURATE")))
+ (para (math "(" (var "i") "," (var "i") (var "i") ")")
+ ", "
+ (math "1"))))
+ (para "
+In the table, ")
+ (para (para (math (var "i")
+ "="
+ (var "min")
+ "\u2061"
+ "("
+ (var "A")
+ "_"
+ (var "s")
+ ","
+ "1"
+ "-"
+ (var "A")
+ "_"
+ (var "d")
+ ","
+ ")")))
+ (para "
+To determine the blended RGBA values of a pixel when drawing in RGBA mode,
+ the system uses the following equations: ")
+ (para (para (math (var "R")
+ "_"
+ (var "d")
+ "="
+ (var "min")
+ "\u2061"
+ "("
+ (var "k")
+ "_"
+ (var "R")
+ ","
+ (var "R")
+ "_"
+ (var "s")
+ "\u2062"
+ (var "s")
+ "_"
+ (var "R")
+ "+"
+ (var "R")
+ "_"
+ (var "d")
+ "\u2062"
+ (var "d")
+ "_"
+ (var "R")
+ ")")
+ (math (var "G")
+ "_"
+ (var "d")
+ "="
+ (var "min")
+ "\u2061"
+ "("
+ (var "k")
+ "_"
+ (var "G")
+ ","
+ (var "G")
+ "_"
+ (var "s")
+ "\u2062"
+ (var "s")
+ "_"
+ (var "G")
+ "+"
+ (var "G")
+ "_"
+ (var "d")
+ "\u2062"
+ (var "d")
+ "_"
+ (var "G")
+ ")")
+ (math (var "B")
+ "_"
+ (var "d")
+ "="
+ (var "min")
+ "\u2061"
+ "("
+ (var "k")
+ "_"
+ (var "B")
+ ","
+ (var "B")
+ "_"
+ (var "s")
+ "\u2062"
+ (var "s")
+ "_"
+ (var "B")
+ "+"
+ (var "B")
+ "_"
+ (var "d")
+ "\u2062"
+ (var "d")
+ "_"
+ (var "B")
+ ")")
+ (math (var "A")
+ "_"
+ (var "d")
+ "="
+ (var "min")
+ "\u2061"
+ "("
+ (var "k")
+ "_"
+ (var "A")
+ ","
+ (var "A")
+ "_"
+ (var "s")
+ "\u2062"
+ (var "s")
+ "_"
+ (var "A")
+ "+"
+ (var "A")
+ "_"
+ (var "d")
+ "\u2062"
+ (var "d")
+ "_"
+ (var "A")
+ ")")))
+ (para "
+Despite the apparent precision of the above equations, blending arithmetic
+ is not exactly specified, because blending operates with imprecise integer
+ color values. However, a blend factor that should be equal to 1 is
+ guaranteed not to modify its multiplicand, and a blend factor equal to 0
+ reduces its multiplicand to 0. For example, when "
+ (var "srcRGB")
+ " is "
+ (code "GL_SRC_ALPHA")
+ ", "
+ (var "dstRGB")
+ " is "
+ (code "GL_ONE_MINUS_SRC_ALPHA")
+ ", and "
+ (math (var "A") "_" (var "s"))
+ "
+is
+ equal to "
+ (math (var "k") "_" (var "A"))
+ ",
+ the equations reduce to simple replacement: ")
+ (para (para (math (var "R")
+ "_"
+ (var "d")
+ "="
+ (var "R")
+ "_"
+ (var "s"))
+ (math (var "G")
+ "_"
+ (var "d")
+ "="
+ (var "G")
+ "_"
+ (var "s"))
+ (math (var "B")
+ "_"
+ (var "d")
+ "="
+ (var "B")
+ "_"
+ (var "s"))
+ (math (var "A")
+ "_"
+ (var "d")
+ "="
+ (var "A")
+ "_"
+ (var "s"))))
+ (para)
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if either "
+ (var "srcRGB")
+ " or "
+ (var "dstRGB")
+ " is not an
+ accepted value. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glBlendFuncSeparate")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glBlendFunc
+ "glBlendFunc"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glBlendFunc"))
+ (paramdef "GLenum " (parameter "sfactor"))
+ (paramdef "GLenum " (parameter "dfactor"))))
+ '(*fragment*
+ (heading "specify pixel arithmetic")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "sfactor")))
+ (para "
+Specifies how the red, green, blue,
+ and alpha source blending factors are computed.
+ The following symbolic constants are accepted: "
+ (code "GL_ZERO")
+ ", "
+ (code "GL_ONE")
+ ", "
+ (code "GL_SRC_COLOR")
+ ", "
+ (code "GL_ONE_MINUS_SRC_COLOR")
+ ", "
+ (code "GL_DST_COLOR")
+ ", "
+ (code "GL_ONE_MINUS_DST_COLOR")
+ ", "
+ (code "GL_SRC_ALPHA")
+ ", "
+ (code "GL_ONE_MINUS_SRC_ALPHA")
+ ", "
+ (code "GL_DST_ALPHA")
+ ", "
+ (code "GL_ONE_MINUS_DST_ALPHA")
+ ", "
+ (code "GL_CONSTANT_COLOR")
+ ", "
+ (code "GL_ONE_MINUS_CONSTANT_COLOR")
+ ", "
+ (code "GL_CONSTANT_ALPHA")
+ ", "
+ (code "GL_ONE_MINUS_CONSTANT_ALPHA")
+ ", and "
+ (code "GL_SRC_ALPHA_SATURATE")
+ ".
+ The initial value is "
+ (code "GL_ONE")
+ ". "))
+ (entry (% (heading (var "dfactor")))
+ (para "
+Specifies how the red, green, blue,
+ and alpha destination blending factors are computed.
+ The following symbolic constants are accepted: "
+ (code "GL_ZERO")
+ ", "
+ (code "GL_ONE")
+ ", "
+ (code "GL_SRC_COLOR")
+ ", "
+ (code "GL_ONE_MINUS_SRC_COLOR")
+ ", "
+ (code "GL_DST_COLOR")
+ ", "
+ (code "GL_ONE_MINUS_DST_COLOR")
+ ", "
+ (code "GL_SRC_ALPHA")
+ ", "
+ (code "GL_ONE_MINUS_SRC_ALPHA")
+ ", "
+ (code "GL_DST_ALPHA")
+ ", "
+ (code "GL_ONE_MINUS_DST_ALPHA")
+ ". "
+ (code "GL_CONSTANT_COLOR")
+ ", "
+ (code "GL_ONE_MINUS_CONSTANT_COLOR")
+ ", "
+ (code "GL_CONSTANT_ALPHA")
+ ", and "
+ (code "GL_ONE_MINUS_CONSTANT_ALPHA")
+ ".
+ The initial value is "
+ (code "GL_ZERO")
+ ". ")))
+ (heading "Description")
+ (para "
+In RGBA mode, pixels can be drawn using a function that blends
+ the incoming (source) RGBA values with the RGBA values
+ that are already in the frame buffer (the destination values).
+ Blending is initially disabled.
+ Use "
+ (code "glEnable")
+ " and "
+ (code "glDisable")
+ " with argument "
+ (code "GL_BLEND")
+ "
+to enable and disable blending. ")
+ (para (code "glBlendFunc")
+ " defines the operation of blending when it is enabled. "
+ (var "sfactor")
+ " specifies which method is used to scale the
+ source color components. "
+ (var "dfactor")
+ " specifies which method is used to scale the
+ destination color components.
+ The possible methods are described in the following table.
+ Each method defines four scale factors,
+ one each for red, green, blue, and alpha.
+ In the table and in subsequent equations, source and destination
+ color components are referred to as "
+ (math "("
+ (var "R")
+ "_"
+ (var "s")
+ ","
+ (var "G")
+ "_"
+ (var "s")
+ (var "B")
+ "_"
+ (var "s")
+ (var "A")
+ "_"
+ (var "s")
+ ")")
+ "
+and "
+ (math "("
+ (var "R")
+ "_"
+ (var "d")
+ ","
+ (var "G")
+ "_"
+ (var "d")
+ (var "B")
+ "_"
+ (var "d")
+ (var "A")
+ "_"
+ (var "d")
+ ")")
+ ".
+ The color specified by "
+ (code "glBlendColor")
+ " is referred to as "
+ (math "("
+ (var "R")
+ "_"
+ (var "c")
+ ","
+ (var "G")
+ "_"
+ (var "c")
+ (var "B")
+ "_"
+ (var "c")
+ (var "A")
+ "_"
+ (var "c")
+ ")")
+ ".
+ They are understood to have integer values between 0 and "
+ (math "("
+ (var "k")
+ "_"
+ (var "R")
+ ","
+ (var "k")
+ "_"
+ (var "G")
+ (var "k")
+ "_"
+ (var "B")
+ (var "k")
+ "_"
+ (var "A")
+ ")")
+ ",
+ where ")
+ (para (para (math (var "k")
+ "_"
+ (var "c")
+ "="
+ "2"
+ "^"
+ (var "m")
+ "_"
+ (var "c")
+ ","
+ "-"
+ "1")))
+ (para "
+and "
+ (math "("
+ (var "m")
+ "_"
+ (var "R")
+ ","
+ (var "m")
+ "_"
+ (var "G")
+ (var "m")
+ "_"
+ (var "B")
+ (var "m")
+ "_"
+ (var "A")
+ ")")
+ "
+is the number of red,
+ green,
+ blue,
+ and alpha bitplanes. ")
+ (para "
+Source and destination scale factors are referred to as "
+ (math "("
+ (var "s")
+ "_"
+ (var "R")
+ ","
+ (var "s")
+ "_"
+ (var "G")
+ (var "s")
+ "_"
+ (var "B")
+ (var "s")
+ "_"
+ (var "A")
+ ")")
+ "
+and "
+ (math "("
+ (var "d")
+ "_"
+ (var "R")
+ ","
+ (var "d")
+ "_"
+ (var "G")
+ (var "d")
+ "_"
+ (var "B")
+ (var "d")
+ "_"
+ (var "A")
+ ")")
+ ".
+ The scale factors described in the table,
+ denoted "
+ (math "("
+ (var "f")
+ "_"
+ (var "R")
+ ","
+ (var "f")
+ "_"
+ (var "G")
+ (var "f")
+ "_"
+ (var "B")
+ (var "f")
+ "_"
+ (var "A")
+ ")")
+ ",
+ represent either source or destination factors.
+ All scale factors have range "
+ (math "[" "0" "," "1" "]")
+ ". ")
+ (para)
+ (table (% (formatter (asis)))
+ (entry (% (heading (strong "Parameter")))
+ (para (strong
+ (math "("
+ (var "f")
+ "_"
+ (var "R")
+ ","
+ (var "f")
+ "_"
+ (var "G")
+ (var "f")
+ "_"
+ (var "B")
+ (var "f")
+ "_"
+ (var "A")
+ ")"))))
+ (entry (% (heading (code "GL_ZERO")))
+ (para (math "(" "0" "," "0" "0" "0" ")")))
+ (entry (% (heading (code "GL_ONE")))
+ (para (math "(" "1" "," "1" "1" "1" ")")))
+ (entry (% (heading (code "GL_SRC_COLOR")))
+ (para (math "("
+ (var "R")
+ "_"
+ (var "s")
+ "/"
+ (var "k")
+ "_"
+ (var "R")
+ ","
+ (var "G")
+ "_"
+ (var "s")
+ "/"
+ (var "k")
+ "_"
+ (var "G")
+ (var "B")
+ "_"
+ (var "s")
+ "/"
+ (var "k")
+ "_"
+ (var "B")
+ (var "A")
+ "_"
+ (var "s")
+ "/"
+ (var "k")
+ "_"
+ (var "A")
+ ")")))
+ (entry (% (heading (code "GL_ONE_MINUS_SRC_COLOR")))
+ (para (math "("
+ "1"
+ ","
+ "1"
+ "1"
+ "1"
+ ")"
+ "-"
+ "("
+ (var "R")
+ "_"
+ (var "s")
+ "/"
+ (var "k")
+ "_"
+ (var "R")
+ ","
+ (var "G")
+ "_"
+ (var "s")
+ "/"
+ (var "k")
+ "_"
+ (var "G")
+ (var "B")
+ "_"
+ (var "s")
+ "/"
+ (var "k")
+ "_"
+ (var "B")
+ (var "A")
+ "_"
+ (var "s")
+ "/"
+ (var "k")
+ "_"
+ (var "A")
+ ")")))
+ (entry (% (heading (code "GL_DST_COLOR")))
+ (para (math "("
+ (var "R")
+ "_"
+ (var "d")
+ "/"
+ (var "k")
+ "_"
+ (var "R")
+ ","
+ (var "G")
+ "_"
+ (var "d")
+ "/"
+ (var "k")
+ "_"
+ (var "G")
+ (var "B")
+ "_"
+ (var "d")
+ "/"
+ (var "k")
+ "_"
+ (var "B")
+ (var "A")
+ "_"
+ (var "d")
+ "/"
+ (var "k")
+ "_"
+ (var "A")
+ ")")))
+ (entry (% (heading (code "GL_ONE_MINUS_DST_COLOR")))
+ (para (math "("
+ "1"
+ ","
+ "1"
+ "1"
+ "1"
+ ")"
+ "-"
+ "("
+ (var "R")
+ "_"
+ (var "d")
+ "/"
+ (var "k")
+ "_"
+ (var "R")
+ ","
+ (var "G")
+ "_"
+ (var "d")
+ "/"
+ (var "k")
+ "_"
+ (var "G")
+ (var "B")
+ "_"
+ (var "d")
+ "/"
+ (var "k")
+ "_"
+ (var "B")
+ (var "A")
+ "_"
+ (var "d")
+ "/"
+ (var "k")
+ "_"
+ (var "A")
+ ")")))
+ (entry (% (heading (code "GL_SRC_ALPHA")))
+ (para (math "("
+ (var "A")
+ "_"
+ (var "s")
+ "/"
+ (var "k")
+ "_"
+ (var "A")
+ ","
+ (var "A")
+ "_"
+ (var "s")
+ "/"
+ (var "k")
+ "_"
+ (var "A")
+ (var "A")
+ "_"
+ (var "s")
+ "/"
+ (var "k")
+ "_"
+ (var "A")
+ (var "A")
+ "_"
+ (var "s")
+ "/"
+ (var "k")
+ "_"
+ (var "A")
+ ")")))
+ (entry (% (heading (code "GL_ONE_MINUS_SRC_ALPHA")))
+ (para (math "("
+ "1"
+ ","
+ "1"
+ "1"
+ "1"
+ ")"
+ "-"
+ "("
+ (var "A")
+ "_"
+ (var "s")
+ "/"
+ (var "k")
+ "_"
+ (var "A")
+ ","
+ (var "A")
+ "_"
+ (var "s")
+ "/"
+ (var "k")
+ "_"
+ (var "A")
+ (var "A")
+ "_"
+ (var "s")
+ "/"
+ (var "k")
+ "_"
+ (var "A")
+ (var "A")
+ "_"
+ (var "s")
+ "/"
+ (var "k")
+ "_"
+ (var "A")
+ ")")))
+ (entry (% (heading (code "GL_DST_ALPHA")))
+ (para (math "("
+ (var "A")
+ "_"
+ (var "d")
+ "/"
+ (var "k")
+ "_"
+ (var "A")
+ ","
+ (var "A")
+ "_"
+ (var "d")
+ "/"
+ (var "k")
+ "_"
+ (var "A")
+ (var "A")
+ "_"
+ (var "d")
+ "/"
+ (var "k")
+ "_"
+ (var "A")
+ (var "A")
+ "_"
+ (var "d")
+ "/"
+ (var "k")
+ "_"
+ (var "A")
+ ")")))
+ (entry (% (heading (code "GL_ONE_MINUS_DST_ALPHA")))
+ (para (math "("
+ "1"
+ ","
+ "1"
+ "1"
+ "1"
+ ")"
+ "-"
+ "("
+ (var "A")
+ "_"
+ (var "d")
+ "/"
+ (var "k")
+ "_"
+ (var "A")
+ ","
+ (var "A")
+ "_"
+ (var "d")
+ "/"
+ (var "k")
+ "_"
+ (var "A")
+ (var "A")
+ "_"
+ (var "d")
+ "/"
+ (var "k")
+ "_"
+ (var "A")
+ (var "A")
+ "_"
+ (var "d")
+ "/"
+ (var "k")
+ "_"
+ (var "A")
+ ")")))
+ (entry (% (heading (code "GL_CONSTANT_COLOR")))
+ (para (math "("
+ (var "R")
+ "_"
+ (var "c")
+ ","
+ (var "G")
+ "_"
+ (var "c")
+ (var "B")
+ "_"
+ (var "c")
+ (var "A")
+ "_"
+ (var "c")
+ ")")))
+ (entry (% (heading (code "GL_ONE_MINUS_CONSTANT_COLOR")))
+ (para (math "("
+ "1"
+ ","
+ "1"
+ "1"
+ "1"
+ ")"
+ "-"
+ "("
+ (var "R")
+ "_"
+ (var "c")
+ ","
+ (var "G")
+ "_"
+ (var "c")
+ (var "B")
+ "_"
+ (var "c")
+ (var "A")
+ "_"
+ (var "c")
+ ")")))
+ (entry (% (heading (code "GL_CONSTANT_ALPHA")))
+ (para (math "("
+ (var "A")
+ "_"
+ (var "c")
+ ","
+ (var "A")
+ "_"
+ (var "c")
+ (var "A")
+ "_"
+ (var "c")
+ (var "A")
+ "_"
+ (var "c")
+ ")")))
+ (entry (% (heading (code "GL_ONE_MINUS_CONSTANT_ALPHA")))
+ (para (math "("
+ "1"
+ ","
+ "1"
+ "1"
+ "1"
+ ")"
+ "-"
+ "("
+ (var "A")
+ "_"
+ (var "c")
+ ","
+ (var "A")
+ "_"
+ (var "c")
+ (var "A")
+ "_"
+ (var "c")
+ (var "A")
+ "_"
+ (var "c")
+ ")")))
+ (entry (% (heading (code "GL_SRC_ALPHA_SATURATE")))
+ (para (math "("
+ (var "i")
+ ","
+ (var "i")
+ (var "i")
+ "1"
+ ")"))))
+ (para "
+In the table, ")
+ (para (para (math (var "i")
+ "="
+ (var "min")
+ "\u2061"
+ "("
+ (var "A")
+ "_"
+ (var "s")
+ ","
+ (var "k")
+ "_"
+ (var "A")
+ "-"
+ (var "A")
+ "_"
+ (var "d")
+ ")"
+ "/"
+ (var "k")
+ "_"
+ (var "A"))))
+ (para "
+To determine the blended RGBA values of a pixel when drawing in RGBA mode,
+ the system uses the following equations: ")
+ (para (para (math (var "R")
+ "_"
+ (var "d")
+ "="
+ (var "min")
+ "\u2061"
+ "("
+ (var "k")
+ "_"
+ (var "R")
+ ","
+ (var "R")
+ "_"
+ (var "s")
+ "\u2062"
+ (var "s")
+ "_"
+ (var "R")
+ "+"
+ (var "R")
+ "_"
+ (var "d")
+ "\u2062"
+ (var "d")
+ "_"
+ (var "R")
+ ")")
+ (math (var "G")
+ "_"
+ (var "d")
+ "="
+ (var "min")
+ "\u2061"
+ "("
+ (var "k")
+ "_"
+ (var "G")
+ ","
+ (var "G")
+ "_"
+ (var "s")
+ "\u2062"
+ (var "s")
+ "_"
+ (var "G")
+ "+"
+ (var "G")
+ "_"
+ (var "d")
+ "\u2062"
+ (var "d")
+ "_"
+ (var "G")
+ ")")
+ (math (var "B")
+ "_"
+ (var "d")
+ "="
+ (var "min")
+ "\u2061"
+ "("
+ (var "k")
+ "_"
+ (var "B")
+ ","
+ (var "B")
+ "_"
+ (var "s")
+ "\u2062"
+ (var "s")
+ "_"
+ (var "B")
+ "+"
+ (var "B")
+ "_"
+ (var "d")
+ "\u2062"
+ (var "d")
+ "_"
+ (var "B")
+ ")")
+ (math (var "A")
+ "_"
+ (var "d")
+ "="
+ (var "min")
+ "\u2061"
+ "("
+ (var "k")
+ "_"
+ (var "A")
+ ","
+ (var "A")
+ "_"
+ (var "s")
+ "\u2062"
+ (var "s")
+ "_"
+ (var "A")
+ "+"
+ (var "A")
+ "_"
+ (var "d")
+ "\u2062"
+ (var "d")
+ "_"
+ (var "A")
+ ")")))
+ (para "
+Despite the apparent precision of the above equations,
+ blending arithmetic is not exactly specified,
+ because blending operates with imprecise integer color values.
+ However,
+ a blend factor that should be equal to 1
+ is guaranteed not to modify its multiplicand,
+ and a blend factor equal to 0 reduces its multiplicand to 0.
+ For example,
+ when "
+ (var "sfactor")
+ " is "
+ (code "GL_SRC_ALPHA")
+ ", "
+ (var "dfactor")
+ " is "
+ (code "GL_ONE_MINUS_SRC_ALPHA")
+ ",
+ and "
+ (math (var "A") "_" (var "s"))
+ "
+is equal to "
+ (math (var "k") "_" (var "A"))
+ ",
+ the equations reduce to simple replacement: ")
+ (para (para (math (var "R")
+ "_"
+ (var "d")
+ "="
+ (var "R")
+ "_"
+ (var "s"))
+ (math (var "G")
+ "_"
+ (var "d")
+ "="
+ (var "G")
+ "_"
+ (var "s"))
+ (math (var "B")
+ "_"
+ (var "d")
+ "="
+ (var "B")
+ "_"
+ (var "s"))
+ (math (var "A")
+ "_"
+ (var "d")
+ "="
+ (var "A")
+ "_"
+ (var "s"))))
+ (para)
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if either "
+ (var "sfactor")
+ " or "
+ (var "dfactor")
+ " is not an
+ accepted value. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glBlendFunc")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glBufferData
+ "glBufferData"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glBufferData"))
+ (paramdef "GLenum " (parameter "target"))
+ (paramdef "GLsizeiptr " (parameter "size"))
+ (paramdef "const GLvoid * " (parameter "data"))
+ (paramdef "GLenum " (parameter "usage"))))
+ '(*fragment*
+ (heading
+ "creates and initializes a buffer object's data store")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "target")))
+ (para "
+Specifies the target buffer object.
+ The symbolic constant must be "
+ (code "GL_ARRAY_BUFFER")
+ ", "
+ (code "GL_ELEMENT_ARRAY_BUFFER")
+ ", "
+ (code "GL_PIXEL_PACK_BUFFER")
+ ", or "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ ". "))
+ (entry (% (heading (var "size")))
+ (para "
+Specifies the size in bytes of the buffer object's new data store. "))
+ (entry (% (heading (var "data")))
+ (para "
+Specifies a pointer to data that will be copied into the data store for initialization,
+ or "
+ (code "NULL")
+ " if no data is to be copied. "))
+ (entry (% (heading (var "usage")))
+ (para "
+Specifies the expected usage pattern of the data store. The symbolic constant must be "
+ (code "GL_STREAM_DRAW")
+ ", "
+ (code "GL_STREAM_READ")
+ ", "
+ (code "GL_STREAM_COPY")
+ ", "
+ (code "GL_STATIC_DRAW")
+ ", "
+ (code "GL_STATIC_READ")
+ ", "
+ (code "GL_STATIC_COPY")
+ ", "
+ (code "GL_DYNAMIC_DRAW")
+ ", "
+ (code "GL_DYNAMIC_READ")
+ ", or "
+ (code "GL_DYNAMIC_COPY")
+ ". ")))
+ (heading "Description")
+ (para (code "glBufferData")
+ " creates a new data store for the buffer object currently bound to "
+ (var "target")
+ ". Any pre-existing data store is deleted. The new data store is created with the
+ specified "
+ (var "size")
+ " in bytes and "
+ (var "usage")
+ ". If "
+ (var "data")
+ "
+is not "
+ (code "NULL")
+ ", the data store is initialized with data from this pointer. In its initial
+ state, the new data store is not mapped, it has a "
+ (code "NULL")
+ " mapped pointer, and its mapped access
+ is "
+ (code "GL_READ_WRITE")
+ ". ")
+ (para (var "usage")
+ " is a hint to the GL implementation as to how a buffer object's data store will be
+ accessed. This enables the GL implementation to make more intelligent decisions that may significantly
+ impact buffer object performance. It does not, however, constrain the actual usage of the data store. "
+ (var "usage")
+ " can be broken down into two parts: first, the frequency of access (modification
+ and usage), and second, the nature of that access. The frequency of access may be one of these: ")
+ (table (% (formatter (asis)))
+ (entry (% (heading "STREAM"))
+ (para "
+The data store contents will be modified once and used at most a few times. "))
+ (entry (% (heading "STATIC"))
+ (para "
+The data store contents will be modified once and used many times. "))
+ (entry (% (heading "DYNAMIC"))
+ (para "
+The data store contents will be modified repeatedly and used many times. ")))
+ (para "
+The nature of access may be one of these: ")
+ (table (% (formatter (asis)))
+ (entry (% (heading "DRAW"))
+ (para "
+The data store contents are modified by the application, and used as the source for GL drawing and
+ image specification commands. "))
+ (entry (% (heading "READ"))
+ (para "
+The data store contents are modified by reading data from the GL, and used to return that data
+ when queried by the application. "))
+ (entry (% (heading "COPY"))
+ (para "
+The data store contents are modified by reading data from the GL, and used as the source for GL
+ drawing and image specification commands. ")))
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "target")
+ " is not "
+ (code "GL_ARRAY_BUFFER")
+ ", "
+ (code "GL_ELEMENT_ARRAY_BUFFER")
+ ", "
+ (code "GL_PIXEL_PACK_BUFFER")
+ ", or "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ ". ")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "usage")
+ " is not "
+ (code "GL_STREAM_DRAW")
+ ", "
+ (code "GL_STREAM_READ")
+ ", "
+ (code "GL_STREAM_COPY")
+ ", "
+ (code "GL_STATIC_DRAW")
+ ", "
+ (code "GL_STATIC_READ")
+ ", "
+ (code "GL_STATIC_COPY")
+ ", "
+ (code "GL_DYNAMIC_DRAW")
+ ", "
+ (code "GL_DYNAMIC_READ")
+ ", or "
+ (code "GL_DYNAMIC_COPY")
+ ". ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "size")
+ " is negative. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if the reserved buffer object name 0 is bound to "
+ (var "target")
+ ". ")
+ (para (code "GL_OUT_OF_MEMORY")
+ " is generated if the GL is unable to create a data store with the specified "
+ (var "size")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glBufferData")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ " and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glBufferSubData
+ "glBufferSubData"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glBufferSubData"))
+ (paramdef "GLenum " (parameter "target"))
+ (paramdef "GLintptr " (parameter "offset"))
+ (paramdef "GLsizeiptr " (parameter "size"))
+ (paramdef "const GLvoid * " (parameter "data"))))
+ '(*fragment*
+ (heading
+ "updates a subset of a buffer object's data store")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "target")))
+ (para "
+Specifies the target buffer object.
+ The symbolic constant must be "
+ (code "GL_ARRAY_BUFFER")
+ ", "
+ (code "GL_ELEMENT_ARRAY_BUFFER")
+ ", "
+ (code "GL_PIXEL_PACK_BUFFER")
+ ", or "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ ". "))
+ (entry (% (heading (var "offset")))
+ (para "
+Specifies the offset into the buffer object's data store where data replacement will begin,
+ measured in bytes. "))
+ (entry (% (heading (var "size")))
+ (para "
+Specifies the size in bytes of the data store region being replaced. "))
+ (entry (% (heading (var "data")))
+ (para "
+Specifies a pointer to the new data that will be copied into the data store. ")))
+ (heading "Description")
+ (para (code "glBufferSubData")
+ " redefines some or all of the data store for the buffer object currently
+ bound to "
+ (var "target")
+ ". Data starting at byte offset "
+ (var "offset")
+ " and
+ extending for "
+ (var "size")
+ " bytes is copied to the data store from the memory pointed to by "
+ (var "data")
+ ". An error is thrown if "
+ (var "offset")
+ " and "
+ (var "size")
+ "
+together define a range beyond the bounds of the buffer object's data store. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "target")
+ " is not "
+ (code "GL_ARRAY_BUFFER")
+ ", "
+ (code "GL_ELEMENT_ARRAY_BUFFER")
+ ", "
+ (code "GL_PIXEL_PACK_BUFFER")
+ ", or "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ ". ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "offset")
+ " or "
+ (var "size")
+ " is negative, or if together they define a region of memory
+ that extends beyond the buffer object's allocated data store. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if the reserved buffer object name 0 is bound to "
+ (var "target")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if the buffer object being updated is mapped. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glBufferSubData")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ " and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glCallLists
+ "glCallLists"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glCallLists"))
+ (paramdef "GLsizei " (parameter "n"))
+ (paramdef "GLenum " (parameter "type"))
+ (paramdef "const GLvoid * " (parameter "lists"))))
+ '(*fragment*
+ (heading "execute a list of display lists")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "n")))
+ (para "
+Specifies the number of display lists to be executed. "))
+ (entry (% (heading (var "type")))
+ (para "
+Specifies the type of values in "
+ (var "lists")
+ ".
+ Symbolic constants "
+ (code "GL_BYTE")
+ ", "
+ (code "GL_UNSIGNED_BYTE")
+ ", "
+ (code "GL_SHORT")
+ ", "
+ (code "GL_UNSIGNED_SHORT")
+ ", "
+ (code "GL_INT")
+ ", "
+ (code "GL_UNSIGNED_INT")
+ ", "
+ (code "GL_FLOAT")
+ ", "
+ (code "GL_2_BYTES")
+ ", "
+ (code "GL_3_BYTES")
+ ", and "
+ (code "GL_4_BYTES")
+ " are accepted. "))
+ (entry (% (heading (var "lists")))
+ (para "
+Specifies the address of an array of name offsets in the display list.
+ The pointer type is void because the offsets can be bytes,
+ shorts,
+ ints,
+ or floats,
+ depending on the value of "
+ (var "type")
+ ". ")))
+ (heading "Description")
+ (para (code "glCallLists")
+ " causes each display list in the list of names passed as "
+ (var "lists")
+ "
+to be executed.
+ As a result,
+ the commands saved in each display list are executed in order,
+ just as if they were called without using a display list.
+ Names of display lists that have not been defined are ignored. ")
+ (para (code "glCallLists")
+ " provides an efficient means for executing more than one display list. "
+ (var "type")
+ " allows lists with various name formats to be accepted.
+ The formats are as
+ follows: ")
+ (table (% (formatter (asis)))
+ (entry (% (heading (code "GL_BYTE")))
+ (para (var "lists")
+ " is treated as an array of signed bytes,
+ each in the range "
+ (math "-128")
+ "
+through 127. "))
+ (entry (% (heading (code "GL_UNSIGNED_BYTE")))
+ (para (var "lists")
+ " is treated as an array of unsigned bytes,
+ each in the range 0 through 255. "))
+ (entry (% (heading (code "GL_SHORT")))
+ (para (var "lists")
+ " is treated as an array of signed two-byte integers,
+ each in the range "
+ (math "-32768")
+ "
+through 32767. "))
+ (entry (% (heading (code "GL_UNSIGNED_SHORT")))
+ (para (var "lists")
+ " is treated as an array of unsigned two-byte integers,
+ each in the range 0 through 65535. "))
+ (entry (% (heading (code "GL_INT")))
+ (para (var "lists")
+ " is treated as an array of signed four-byte integers. "))
+ (entry (% (heading (code "GL_UNSIGNED_INT")))
+ (para (var "lists")
+ " is treated as an array of unsigned four-byte integers. "))
+ (entry (% (heading (code "GL_FLOAT")))
+ (para (var "lists")
+ " is treated as an array of four-byte floating-point values. "))
+ (entry (% (heading (code "GL_2_BYTES")))
+ (para (var "lists")
+ " is treated as an array of unsigned bytes.
+ Each pair of bytes specifies a single display-list name.
+ The value of the pair is computed as 256 times the unsigned value
+ of the first byte plus the unsigned value of the second byte. "))
+ (entry (% (heading (code "GL_3_BYTES")))
+ (para (var "lists")
+ " is treated as an array of unsigned bytes.
+ Each triplet of bytes specifies a single display-list name.
+ The value of the triplet is computed as 65536 times the unsigned value
+ of the first byte,
+ plus 256 times the unsigned value of the second byte,
+ plus the unsigned value of the third byte. "))
+ (entry (% (heading (code "GL_4_BYTES")))
+ (para (var "lists")
+ " is treated as an array of unsigned bytes.
+ Each quadruplet of bytes specifies a single display-list name.
+ The value of the quadruplet is computed as 16777216 times the unsigned value
+ of the first byte,
+ plus 65536 times the unsigned value of the second byte,
+ plus 256 times the unsigned value of the third byte,
+ plus the unsigned value of the fourth byte. ")))
+ (para "
+The list of display-list names is not null-terminated.
+ Rather, "
+ (var "n")
+ " specifies how many names are to be taken from "
+ (var "lists")
+ ". ")
+ (para "
+An additional level of indirection is made available with the "
+ (code "glListBase")
+ " command,
+ which specifies an unsigned offset that is added to each display-list
+ name specified in "
+ (var "lists")
+ " before that display list is executed. ")
+ (para (code "glCallLists")
+ " can appear inside a display list.
+ To avoid the possibility of infinite recursion resulting from display lists
+ calling one another,
+ a limit is placed on the nesting level of display
+ lists during display-list execution.
+ This limit must be at least 64, and it depends on the implementation. ")
+ (para "
+GL state is not saved and restored across a call to "
+ (code "glCallLists")
+ ".
+ Thus,
+ changes made to GL state during the execution of the display lists
+ remain after execution is completed.
+ Use "
+ (code "glPushAttrib")
+ ", "
+ (code "glPopAttrib")
+ ", "
+ (code "glPushMatrix")
+ ",
+ and "
+ (code "glPopMatrix")
+ " to preserve GL state across "
+ (code "glCallLists")
+ " calls. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "n")
+ " is negative. ")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "type")
+ " is not one of "
+ (code "GL_BYTE")
+ ", "
+ (code "GL_UNSIGNED_BYTE")
+ ", "
+ (code "GL_SHORT")
+ ", "
+ (code "GL_UNSIGNED_SHORT")
+ ", "
+ (code "GL_INT")
+ ", "
+ (code "GL_UNSIGNED_INT")
+ ", "
+ (code "GL_FLOAT")
+ ", "
+ (code "GL_2_BYTES")
+ ", "
+ (code "GL_3_BYTES")
+ ", "
+ (code "GL_4_BYTES")
+ ". ")))
+
+(define-gl-procedure
+ glCallList
+ "glCallList"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glCallList"))
+ (paramdef "GLuint " (parameter "list"))))
+ '(*fragment*
+ (heading "execute a display list")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "list")))
+ (para "
+Specifies the integer name of the display list to be executed. ")))
+ (heading "Description")
+ (para (code "glCallList")
+ " causes the named display list to be executed.
+ The commands saved in the display list are executed in order,
+ just as if they were called without using a display list.
+ If "
+ (var "list")
+ " has not been defined as a display list, "
+ (code "glCallList")
+ " is ignored. ")
+ (para (code "glCallList")
+ " can appear inside a display list.
+ To avoid the possibility of infinite recursion resulting from display lists
+ calling one another,
+ a limit is placed on the nesting level of display
+ lists during display-list execution.
+ This limit is at least 64, and it depends on the implementation. ")
+ (para "
+GL state is not saved and restored across a call to "
+ (code "glCallList")
+ ".
+ Thus,
+ changes made to GL state during the execution of a display list
+ remain after execution of the display list is completed.
+ Use "
+ (code "glPushAttrib")
+ ", "
+ (code "glPopAttrib")
+ ", "
+ (code "glPushMatrix")
+ ",
+ and "
+ (code "glPopMatrix")
+ " to preserve GL state across "
+ (code "glCallList")
+ " calls. ")))
+
+(define-gl-procedure
+ glClearAccum
+ "glClearAccum"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glClearAccum"))
+ (paramdef "GLfloat " (parameter "red"))
+ (paramdef "GLfloat " (parameter "green"))
+ (paramdef "GLfloat " (parameter "blue"))
+ (paramdef "GLfloat " (parameter "alpha"))))
+ '(*fragment*
+ (heading
+ "specify clear values for the accumulation buffer")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "red")))
+ (itemx (var "green"))
+ (itemx (var "blue"))
+ (itemx (var "alpha"))
+ (para "
+Specify the red, green, blue, and alpha values used when the
+ accumulation buffer is cleared.
+ The initial values are all 0. ")))
+ (heading "Description")
+ (para (code "glClearAccum")
+ " specifies the red, green, blue, and alpha values used by "
+ (code "glClear")
+ "
+to clear the accumulation buffer. ")
+ (para "
+Values specified by "
+ (code "glClearAccum")
+ " are clamped to the
+ range "
+ (math "[" "-1" "," "1" "]")
+ ". ")
+ (heading "Errors")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glClearAccum")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glClearColor
+ "glClearColor"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glClearColor"))
+ (paramdef "GLclampf " (parameter "red"))
+ (paramdef "GLclampf " (parameter "green"))
+ (paramdef "GLclampf " (parameter "blue"))
+ (paramdef "GLclampf " (parameter "alpha"))))
+ '(*fragment*
+ (heading
+ "specify clear values for the color buffers")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "red")))
+ (itemx (var "green"))
+ (itemx (var "blue"))
+ (itemx (var "alpha"))
+ (para "
+Specify the red, green, blue, and alpha values used when the
+ color buffers are cleared.
+ The initial values are all 0. ")))
+ (heading "Description")
+ (para (code "glClearColor")
+ " specifies the red,
+ green,
+ blue,
+ and alpha values used by "
+ (code "glClear")
+ " to clear the color buffers.
+ Values specified by "
+ (code "glClearColor")
+ " are clamped to the range "
+ (math "[" "0" "," "1" "]")
+ ". ")
+ (heading "Errors")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glClearColor")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glClearDepth
+ "glClearDepth"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glClearDepth"))
+ (paramdef "GLclampd " (parameter "depth"))))
+ '(*fragment*
+ (heading
+ "specify the clear value for the depth buffer")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "depth")))
+ (para "
+Specifies the depth value used when the depth buffer is cleared. The
+ initial value is 1. ")))
+ (heading "Description")
+ (para (code "glClearDepth")
+ " specifies the depth value used by "
+ (code "glClear")
+ " to clear the depth buffer.
+ Values specified by "
+ (code "glClearDepth")
+ " are clamped to the range "
+ (math "[" "0" "," "1" "]")
+ ". ")
+ (heading "Errors")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glClearDepth")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glClearIndex
+ "glClearIndex"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glClearIndex"))
+ (paramdef "GLfloat " (parameter "c"))))
+ '(*fragment*
+ (heading
+ "specify the clear value for the color index buffers")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "c")))
+ (para "
+Specifies the index used when the color index buffers are cleared.
+ The initial value is 0. ")))
+ (heading "Description")
+ (para (code "glClearIndex")
+ " specifies the index used by "
+ (code "glClear")
+ "
+to clear the color index buffers. "
+ (var "c")
+ " is not clamped.
+ Rather, "
+ (var "c")
+ " is converted to a fixed-point value with unspecified precision
+ to the right of the binary point.
+ The integer part of this value is then masked with "
+ (math "2" "^" (var "m") "-" "1")
+ ",
+ where "
+ (math (var "m"))
+ "
+is the number of bits in a color index stored in the frame buffer. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glClearIndex")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glClearStencil
+ "glClearStencil"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glClearStencil"))
+ (paramdef "GLint " (parameter "s"))))
+ '(*fragment*
+ (heading
+ "specify the clear value for the stencil buffer")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "s")))
+ (para "
+Specifies the index used when the stencil buffer is cleared.
+ The initial value is 0. ")))
+ (heading "Description")
+ (para (code "glClearStencil")
+ " specifies the index used by "
+ (code "glClear")
+ " to clear the stencil buffer. "
+ (var "s")
+ " is masked with "
+ (math "2" "^" (var "m") "-" "1")
+ ",
+ where "
+ (math (var "m"))
+ "
+is the number of bits in the stencil buffer. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glClearStencil")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glClear
+ "glClear"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glClear"))
+ (paramdef "GLbitfield " (parameter "mask"))))
+ '(*fragment*
+ (heading "clear buffers to preset values")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "mask")))
+ (para "
+Bitwise OR of masks that indicate the buffers to be cleared.
+ The four masks are "
+ (code "GL_COLOR_BUFFER_BIT")
+ ", "
+ (code "GL_DEPTH_BUFFER_BIT")
+ ", "
+ (code "GL_ACCUM_BUFFER_BIT")
+ ", and "
+ (code "GL_STENCIL_BUFFER_BIT")
+ ". ")))
+ (heading "Description")
+ (para (code "glClear")
+ " sets the bitplane area of the window to values previously selected
+ by "
+ (code "glClearColor")
+ ", "
+ (code "glClearIndex")
+ ", "
+ (code "glClearDepth")
+ ", "
+ (code "glClearStencil")
+ ", and "
+ (code "glClearAccum")
+ ".
+ Multiple color buffers can be cleared simultaneously by selecting
+ more than one buffer at a time using "
+ (code "glDrawBuffer")
+ ". ")
+ (para "
+The pixel ownership test,
+ the scissor test,
+ dithering, and the buffer writemasks affect the operation of "
+ (code "glClear")
+ ".
+ The scissor box bounds the cleared region.
+ Alpha function,
+ blend function,
+ logical operation,
+ stenciling,
+ texture mapping,
+ and depth-buffering are ignored by "
+ (code "glClear")
+ ". ")
+ (para (code "glClear")
+ " takes a single argument that is the bitwise OR of several
+ values indicating which buffer is to be cleared. ")
+ (para "
+The values are as follows: ")
+ (table (% (formatter (asis)))
+ (entry (% (heading (code "GL_COLOR_BUFFER_BIT")))
+ (para "
+Indicates the buffers currently enabled for color
+ writing. "))
+ (entry (% (heading (code "GL_DEPTH_BUFFER_BIT")))
+ (para "
+Indicates the depth buffer. "))
+ (entry (% (heading (code "GL_ACCUM_BUFFER_BIT")))
+ (para "
+Indicates the accumulation buffer. "))
+ (entry (% (heading (code "GL_STENCIL_BUFFER_BIT")))
+ (para "
+Indicates the stencil buffer. ")))
+ (para "
+The value to which each buffer is cleared depends on the setting of the
+ clear value for that buffer. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if any bit other than the four defined
+ bits is set in "
+ (var "mask")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glClear")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glClientActiveTexture
+ "glClientActiveTexture"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "void "
+ (function "glClientActiveTexture"))
+ (paramdef "GLenum " (parameter "texture"))))
+ '(*fragment*
+ (heading "select active texture unit")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "texture")))
+ (para "
+Specifies which texture unit to make active. The number
+ of texture units is implementation dependent, but must be at least
+ two. "
+ (var "texture")
+ " must be one of "
+ (code "GL_TEXTURE")
+ (math (var "i"))
+ ",
+ where i ranges from 0 to the value of "
+ (code "GL_MAX_TEXTURE_COORDS")
+ " - 1, which is an
+ implementation-dependent value. The initial value is "
+ (code "GL_TEXTURE0")
+ ". ")))
+ (heading "Description")
+ (para (code "glClientActiveTexture")
+ " selects the vertex array client state parameters to be modified by "
+ (code "glTexCoordPointer")
+ ", and enabled or disabled with "
+ (code "glEnableClientState")
+ " or "
+ (code "glDisableClientState")
+ ", respectively,
+ when called with a parameter of "
+ (code "GL_TEXTURE_COORD_ARRAY")
+ ". ")
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "texture")
+ " is not one of "
+ (code "GL_TEXTURE")
+ (math (var "i"))
+ ",
+ where
+ i ranges from 0 to the value of "
+ (code "GL_MAX_TEXTURE_COORDS")
+ " - 1. ")))
+
+(define-gl-procedure
+ glClipPlane
+ "glClipPlane"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glClipPlane"))
+ (paramdef "GLenum " (parameter "plane"))
+ (paramdef
+ "const GLdouble * "
+ (parameter "equation"))))
+ '(*fragment*
+ (heading
+ "specify a plane against which all geometry is clipped")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "plane")))
+ (para "
+Specifies which clipping plane is being positioned.
+ Symbolic names of the form "
+ (code "GL_CLIP_PLANE")
+ (var "i")
+ ",
+ where "
+ (var "i")
+ " is an integer between 0 and "
+ (code "GL_MAX_CLIP_PLANES")
+ (math "-1")
+ ",
+ are accepted. "))
+ (entry (% (heading (var "equation")))
+ (para "
+Specifies the address of an array of four double-precision floating-point values.
+ These values are interpreted as a plane equation. ")))
+ (heading "Description")
+ (para "
+Geometry is always clipped against the boundaries of a six-plane frustum
+ in "
+ (var "x")
+ ", "
+ (var "y")
+ ", and "
+ (var "z")
+ ". "
+ (code "glClipPlane")
+ " allows the specification of additional planes,
+ not necessarily perpendicular to the "
+ (var "x")
+ ", "
+ (var "y")
+ ", or "
+ (var "z")
+ " axis,
+ against which all geometry is clipped.
+ To determine the maximum number of additional clipping planes, call "
+ (code "glGetIntegerv")
+ " with argument "
+ (code "GL_MAX_CLIP_PLANES")
+ ". All
+ implementations support at least six such clipping planes.
+ Because the resulting clipping region is the intersection
+ of the defined half-spaces,
+ it is always convex. ")
+ (para (code "glClipPlane")
+ " specifies a half-space using a four-component plane equation.
+ When "
+ (code "glClipPlane")
+ " is called, "
+ (var "equation")
+ " is transformed by the inverse of the modelview matrix
+ and stored in the resulting eye coordinates.
+ Subsequent changes to the modelview matrix have no effect on the
+ stored plane-equation components.
+ If the dot product of the eye coordinates of a vertex with the
+ stored plane equation components is positive or zero,
+ the vertex is "
+ (var "in")
+ " with respect to that clipping plane.
+ Otherwise, it is "
+ (var "out")
+ ". ")
+ (para "
+To enable and disable clipping planes, call "
+ (code "glEnable")
+ " and "
+ (code "glDisable")
+ " with the argument "
+ (code "GL_CLIP_PLANE")
+ (var "i")
+ ",
+ where "
+ (var "i")
+ " is the plane number. ")
+ (para "
+All clipping planes are initially defined as (0, 0, 0, 0) in eye coordinates
+ and are
+ disabled. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "plane")
+ " is not an accepted value. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glClipPlane")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glColorMask
+ "glColorMask"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glColorMask"))
+ (paramdef "GLboolean " (parameter "red"))
+ (paramdef "GLboolean " (parameter "green"))
+ (paramdef "GLboolean " (parameter "blue"))
+ (paramdef "GLboolean " (parameter "alpha"))))
+ '(*fragment*
+ (heading
+ "enable and disable writing of frame buffer color components")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "red")))
+ (itemx (var "green"))
+ (itemx (var "blue"))
+ (itemx (var "alpha"))
+ (para "
+Specify whether red, green, blue, and alpha can or cannot be written
+ into the frame buffer.
+ The initial values are all "
+ (code "GL_TRUE")
+ ",
+ indicating that the color components can be written. ")))
+ (heading "Description")
+ (para (code "glColorMask")
+ " specifies whether the individual color components in the frame buffer
+ can or cannot be written.
+ If "
+ (var "red")
+ " is "
+ (code "GL_FALSE")
+ ",
+ for example,
+ no change is made to the red component of any pixel in any of the
+ color buffers,
+ regardless of the drawing operation attempted. ")
+ (para "
+Changes to individual bits of components cannot be controlled.
+ Rather,
+ changes are either enabled or disabled for entire color components. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glColorMask")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glColorMaterial
+ "glColorMaterial"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glColorMaterial"))
+ (paramdef "GLenum " (parameter "face"))
+ (paramdef "GLenum " (parameter "mode"))))
+ '(*fragment*
+ (heading
+ "cause a material color to track the current color")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "face")))
+ (para "
+Specifies whether front,
+ back,
+ or both front and back material parameters should track the current color.
+ Accepted values are "
+ (code "GL_FRONT")
+ ", "
+ (code "GL_BACK")
+ ",
+ and "
+ (code "GL_FRONT_AND_BACK")
+ ".
+ The initial value is "
+ (code "GL_FRONT_AND_BACK")
+ ". "))
+ (entry (% (heading (var "mode")))
+ (para "
+Specifies which of several material parameters track the current color.
+ Accepted values are "
+ (code "GL_EMISSION")
+ ", "
+ (code "GL_AMBIENT")
+ ", "
+ (code "GL_DIFFUSE")
+ ", "
+ (code "GL_SPECULAR")
+ ",
+ and "
+ (code "GL_AMBIENT_AND_DIFFUSE")
+ ".
+ The initial value is "
+ (code "GL_AMBIENT_AND_DIFFUSE")
+ ". ")))
+ (heading "Description")
+ (para (code "glColorMaterial")
+ " specifies which material parameters track the current color.
+ When "
+ (code "GL_COLOR_MATERIAL")
+ " is enabled,
+ the material parameter or parameters specified by "
+ (var "mode")
+ ",
+ of the material or materials specified by "
+ (var "face")
+ ",
+ track the current color at all times. ")
+ (para "
+To enable and disable "
+ (code "GL_COLOR_MATERIAL")
+ ", call "
+ (code "glEnable")
+ " and "
+ (code "glDisable")
+ " with argument "
+ (code "GL_COLOR_MATERIAL")
+ ". "
+ (code "GL_COLOR_MATERIAL")
+ " is initially disabled. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "face")
+ " or "
+ (var "mode")
+ " is not an
+ accepted value. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glColorMaterial")
+ " is executed between
+ the execution of "
+ (code "glBegin")
+ " and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glColorPointer
+ "glColorPointer"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glColorPointer"))
+ (paramdef "GLint " (parameter "size"))
+ (paramdef "GLenum " (parameter "type"))
+ (paramdef "GLsizei " (parameter "stride"))
+ (paramdef
+ "const GLvoid * "
+ (parameter "pointer"))))
+ '(*fragment*
+ (heading "define an array of colors")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "size")))
+ (para "
+Specifies the number of components per color. Must be 3 or 4.
+ The initial value is 4. "))
+ (entry (% (heading (var "type")))
+ (para "
+Specifies the data type of each color component in the array.
+ Symbolic constants "
+ (code "GL_BYTE")
+ ", "
+ (code "GL_UNSIGNED_BYTE")
+ ", "
+ (code "GL_SHORT")
+ ", "
+ (code "GL_UNSIGNED_SHORT")
+ ", "
+ (code "GL_INT")
+ ", "
+ (code "GL_UNSIGNED_INT")
+ ", "
+ (code "GL_FLOAT")
+ ",
+ and "
+ (code "GL_DOUBLE")
+ "
+are accepted.
+ The initial value is "
+ (code "GL_FLOAT")
+ ". "))
+ (entry (% (heading (var "stride")))
+ (para "
+Specifies the byte offset between consecutive colors.
+ If "
+ (var "stride")
+ " is 0, the colors are understood to be
+ tightly packed in the array. The initial value is 0. "))
+ (entry (% (heading (var "pointer")))
+ (para "
+Specifies a pointer to the first component of the first color element
+ in the array. The initial value is 0. ")))
+ (heading "Description")
+ (para (code "glColorPointer")
+ " specifies the location and data format of an array of color components
+ to use when rendering. "
+ (var "size")
+ " specifies the number of components per color, and must be 3 or 4. "
+ (var "type")
+ " specifies the data type of each color component, and "
+ (var "stride")
+ "
+specifies the byte stride from one color to the next, allowing vertices and
+ attributes to be packed into a single array or stored in separate arrays.
+ (Single-array storage may be more efficient on some implementations;
+ see "
+ (code "glInterleavedArrays")
+ ".) ")
+ (para "
+If a non-zero named buffer object is bound to the "
+ (code "GL_ARRAY_BUFFER")
+ " target
+ (see "
+ (code "glBindBuffer")
+ ") while a color array is
+ specified, "
+ (var "pointer")
+ " is treated as a byte offset into the buffer object's data store.
+ Also, the buffer object binding ("
+ (code "GL_ARRAY_BUFFER_BINDING")
+ ") is saved as color vertex array
+ client-side state ("
+ (code "GL_COLOR_ARRAY_BUFFER_BINDING")
+ "). ")
+ (para "
+When a color array is specified, "
+ (var "size")
+ ", "
+ (var "type")
+ ", "
+ (var "stride")
+ ", and "
+ (var "pointer")
+ " are saved as client-side
+ state, in addition to the current vertex array buffer object binding. ")
+ (para "
+To enable and disable the color array, call "
+ (code "glEnableClientState")
+ " and "
+ (code "glDisableClientState")
+ " with the argument "
+ (code "GL_COLOR_ARRAY")
+ ". If
+ enabled, the color array is used
+ when "
+ (code "glDrawArrays")
+ ", "
+ (code "glMultiDrawArrays")
+ ", "
+ (code "glDrawElements")
+ ", "
+ (code "glMultiDrawElements")
+ ", "
+ (code "glDrawRangeElements")
+ ", or "
+ (code "glArrayElement")
+ " is called. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "size")
+ " is not 3 or 4. ")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "type")
+ " is not an accepted value. ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "stride")
+ " is negative. ")))
+
+(define-gl-procedure
+ glColorSubTable
+ "glColorSubTable"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glColorSubTable"))
+ (paramdef "GLenum " (parameter "target"))
+ (paramdef "GLsizei " (parameter "start"))
+ (paramdef "GLsizei " (parameter "count"))
+ (paramdef "GLenum " (parameter "format"))
+ (paramdef "GLenum " (parameter "type"))
+ (paramdef "const GLvoid * " (parameter "data"))))
+ '(*fragment*
+ (heading "respecify a portion of a color table")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "target")))
+ (para "
+Must be one of "
+ (code "GL_COLOR_TABLE")
+ ", "
+ (code "GL_POST_CONVOLUTION_COLOR_TABLE")
+ ", or "
+ (code "GL_POST_COLOR_MATRIX_COLOR_TABLE")
+ ". "))
+ (entry (% (heading (var "start")))
+ (para "
+The starting index of the portion of the color table to be replaced. "))
+ (entry (% (heading (var "count")))
+ (para "
+The number of table entries to replace. "))
+ (entry (% (heading (var "format")))
+ (para "
+The format of the pixel data in "
+ (var "data")
+ ".
+ The allowable values are "
+ (code "GL_RED")
+ ", "
+ (code "GL_GREEN")
+ ", "
+ (code "GL_BLUE")
+ ", "
+ (code "GL_ALPHA")
+ ", "
+ (code "GL_LUMINANCE")
+ ", "
+ (code "GL_LUMINANCE_ALPHA")
+ ", "
+ (code "GL_RGB")
+ ", "
+ (code "GL_BGR")
+ ", "
+ (code "GL_RGBA")
+ ", and "
+ (code "GL_BGRA")
+ ". "))
+ (entry (% (heading (var "type")))
+ (para "
+The type of the pixel data in "
+ (var "data")
+ ".
+ The allowable values are "
+ (code "GL_UNSIGNED_BYTE")
+ ", "
+ (code "GL_BYTE")
+ ", "
+ (code "GL_UNSIGNED_SHORT")
+ ", "
+ (code "GL_SHORT")
+ ", "
+ (code "GL_UNSIGNED_INT")
+ ", "
+ (code "GL_INT")
+ ", "
+ (code "GL_FLOAT")
+ ", "
+ (code "GL_UNSIGNED_BYTE_3_3_2")
+ ", "
+ (code "GL_UNSIGNED_BYTE_2_3_3_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_6_5")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_6_5_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_4_4_4_4")
+ ", "
+ (code "GL_UNSIGNED_SHORT_4_4_4_4_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_5_5_1")
+ ", "
+ (code "GL_UNSIGNED_SHORT_1_5_5_5_REV")
+ ", "
+ (code "GL_UNSIGNED_INT_8_8_8_8")
+ ", "
+ (code "GL_UNSIGNED_INT_8_8_8_8_REV")
+ ", "
+ (code "GL_UNSIGNED_INT_10_10_10_2")
+ ", and "
+ (code "GL_UNSIGNED_INT_2_10_10_10_REV")
+ ". "))
+ (entry (% (heading (var "data")))
+ (para "
+Pointer to a one-dimensional array of pixel data that is processed to
+ replace the specified region of the color table. ")))
+ (heading "Description")
+ (para (code "glColorSubTable")
+ " is used to respecify a contiguous portion of a color table previously
+ defined using "
+ (code "glColorTable")
+ ". The pixels referenced by "
+ (var "data")
+ " replace the
+ portion of the existing table from indices "
+ (var "start")
+ " to "
+ (math (var "start") "+" (var "count") "-" "1")
+ ",
+ inclusive. This region may not include any
+ entries outside the range of the color table as it was originally specified.
+ It is not an error to specify a subtexture with width of 0, but such a
+ specification has no effect. ")
+ (para "
+If a non-zero named buffer object is bound to the "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ " target
+ (see "
+ (code "glBindBuffer")
+ ") while a portion of a color table is
+ respecified, "
+ (var "data")
+ " is treated as a byte offset into the buffer object's data store. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "target")
+ " is not one of the allowable
+ values. ")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "format")
+ " is not one of the allowable
+ values. ")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "type")
+ " is not one of the allowable
+ values. ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (math (var "start")
+ "+"
+ (var "count")
+ ">"
+ (var "width"))
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a non-zero buffer object name is bound to the "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ " target and the buffer object's data store is currently mapped. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a non-zero buffer object name is bound to the "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ " target and the data would be unpacked from the buffer
+ object such that the memory reads required would exceed the data store size. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a non-zero buffer object name is bound to the "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ " target and "
+ (var "data")
+ " is not evenly divisible
+ into the number of bytes needed to store in memory a datum indicated by "
+ (var "type")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glColorSubTable")
+ " is executed
+ between the execution of "
+ (code "glBegin")
+ " and the corresponding
+ execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glColorTableParameter
+ "glColorTableParameter"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "void "
+ (function "glColorTableParameterfv"))
+ (paramdef "GLenum " (parameter "target"))
+ (paramdef "GLenum " (parameter "pname"))
+ (paramdef
+ "const GLfloat * "
+ (parameter "params"))))
+ '(*fragment*
+ (heading "set color lookup table parameters")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "target")))
+ (para "
+The target color table.
+ Must be "
+ (code "GL_COLOR_TABLE")
+ ", "
+ (code "GL_POST_CONVOLUTION_COLOR_TABLE")
+ ", or "
+ (code "GL_POST_COLOR_MATRIX_COLOR_TABLE")
+ ". "))
+ (entry (% (heading (var "pname")))
+ (para "
+The symbolic name of a texture color lookup table parameter.
+ Must be one of "
+ (code "GL_COLOR_TABLE_SCALE")
+ " or "
+ (code "GL_COLOR_TABLE_BIAS")
+ ". "))
+ (entry (% (heading (var "params")))
+ (para "
+A pointer to an array where the values of the parameters are stored. ")))
+ (heading "Description")
+ (para (code "glColorTableParameter")
+ " is used to specify the scale factors and bias terms applied to
+ color components when they are loaded into a color table. "
+ (var "target")
+ "
+indicates which color table the scale and bias terms apply to; it
+ must be set to "
+ (code "GL_COLOR_TABLE")
+ ", "
+ (code "GL_POST_CONVOLUTION_COLOR_TABLE")
+ ", or "
+ (code "GL_POST_COLOR_MATRIX_COLOR_TABLE")
+ ". ")
+ (para (var "pname")
+ " must be "
+ (code "GL_COLOR_TABLE_SCALE")
+ " to set the
+ scale factors.
+ In this case, "
+ (var "params")
+ " points to an array of four values, which are
+ the scale factors for red, green, blue, and alpha, in that order. ")
+ (para (var "pname")
+ " must be "
+ (code "GL_COLOR_TABLE_BIAS")
+ " to set the
+ bias terms. In this case, "
+ (var "params")
+ " points to an array of four values, which are the bias
+ terms for red, green, blue, and alpha, in that order. ")
+ (para "
+The color tables themselves are specified by
+ calling "
+ (code "glColorTable")
+ ". ")
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "target")
+ " or "
+ (var "pname")
+ " is not
+ an acceptable value. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glColorTableParameter")
+ " is executed
+ between the execution of "
+ (code "glBegin")
+ " and the corresponding
+ execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glColorTable
+ "glColorTable"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glColorTable"))
+ (paramdef "GLenum " (parameter "target"))
+ (paramdef "GLenum " (parameter "internalformat"))
+ (paramdef "GLsizei " (parameter "width"))
+ (paramdef "GLenum " (parameter "format"))
+ (paramdef "GLenum " (parameter "type"))
+ (paramdef "const GLvoid * " (parameter "data"))))
+ '(*fragment*
+ (heading "define a color lookup table")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "target")))
+ (para "
+Must be one of "
+ (code "GL_COLOR_TABLE")
+ ", "
+ (code "GL_POST_CONVOLUTION_COLOR_TABLE")
+ ", "
+ (code "GL_POST_COLOR_MATRIX_COLOR_TABLE")
+ ", "
+ (code "GL_PROXY_COLOR_TABLE")
+ ", "
+ (code "GL_PROXY_POST_CONVOLUTION_COLOR_TABLE")
+ ",
+ or "
+ (code "GL_PROXY_POST_COLOR_MATRIX_COLOR_TABLE")
+ ". "))
+ (entry (% (heading (var "internalformat")))
+ (para "
+The internal format of the color table.
+ The allowable values are "
+ (code "GL_ALPHA")
+ ", "
+ (code "GL_ALPHA4")
+ ", "
+ (code "GL_ALPHA8")
+ ", "
+ (code "GL_ALPHA12")
+ ", "
+ (code "GL_ALPHA16")
+ ", "
+ (code "GL_LUMINANCE")
+ ", "
+ (code "GL_LUMINANCE4")
+ ", "
+ (code "GL_LUMINANCE8")
+ ", "
+ (code "GL_LUMINANCE12")
+ ", "
+ (code "GL_LUMINANCE16")
+ ", "
+ (code "GL_LUMINANCE_ALPHA")
+ ", "
+ (code "GL_LUMINANCE4_ALPHA4")
+ ", "
+ (code "GL_LUMINANCE6_ALPHA2")
+ ", "
+ (code "GL_LUMINANCE8_ALPHA8")
+ ", "
+ (code "GL_LUMINANCE12_ALPHA4")
+ ", "
+ (code "GL_LUMINANCE12_ALPHA12")
+ ", "
+ (code "GL_LUMINANCE16_ALPHA16")
+ ", "
+ (code "GL_INTENSITY")
+ ", "
+ (code "GL_INTENSITY4")
+ ", "
+ (code "GL_INTENSITY8")
+ ", "
+ (code "GL_INTENSITY12")
+ ", "
+ (code "GL_INTENSITY16")
+ ", "
+ (code "GL_R3_G3_B2")
+ ", "
+ (code "GL_RGB")
+ ", "
+ (code "GL_RGB4")
+ ", "
+ (code "GL_RGB5")
+ ", "
+ (code "GL_RGB8")
+ ", "
+ (code "GL_RGB10")
+ ", "
+ (code "GL_RGB12")
+ ", "
+ (code "GL_RGB16")
+ ", "
+ (code "GL_RGBA")
+ ", "
+ (code "GL_RGBA2")
+ ", "
+ (code "GL_RGBA4")
+ ", "
+ (code "GL_RGB5_A1")
+ ", "
+ (code "GL_RGBA8")
+ ", "
+ (code "GL_RGB10_A2")
+ ", "
+ (code "GL_RGBA12")
+ ", and "
+ (code "GL_RGBA16")
+ ". "))
+ (entry (% (heading (var "width")))
+ (para "
+The number of entries in the color lookup table specified by "
+ (var "data")
+ ". "))
+ (entry (% (heading (var "format")))
+ (para "
+The format of the pixel data in "
+ (var "data")
+ ".
+ The allowable values are "
+ (code "GL_RED")
+ ", "
+ (code "GL_GREEN")
+ ", "
+ (code "GL_BLUE")
+ ", "
+ (code "GL_ALPHA")
+ ", "
+ (code "GL_LUMINANCE")
+ ", "
+ (code "GL_LUMINANCE_ALPHA")
+ ", "
+ (code "GL_RGB")
+ ", "
+ (code "GL_BGR")
+ ", "
+ (code "GL_RGBA")
+ ", and "
+ (code "GL_BGRA")
+ ". "))
+ (entry (% (heading (var "type")))
+ (para "
+The type of the pixel data in "
+ (var "data")
+ ".
+ The allowable values are "
+ (code "GL_UNSIGNED_BYTE")
+ ", "
+ (code "GL_BYTE")
+ ", "
+ (code "GL_UNSIGNED_SHORT")
+ ", "
+ (code "GL_SHORT")
+ ", "
+ (code "GL_UNSIGNED_INT")
+ ", "
+ (code "GL_INT")
+ ", "
+ (code "GL_FLOAT")
+ ", "
+ (code "GL_UNSIGNED_BYTE_3_3_2")
+ ", "
+ (code "GL_UNSIGNED_BYTE_2_3_3_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_6_5")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_6_5_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_4_4_4_4")
+ ", "
+ (code "GL_UNSIGNED_SHORT_4_4_4_4_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_5_5_1")
+ ", "
+ (code "GL_UNSIGNED_SHORT_1_5_5_5_REV")
+ ", "
+ (code "GL_UNSIGNED_INT_8_8_8_8")
+ ", "
+ (code "GL_UNSIGNED_INT_8_8_8_8_REV")
+ ", "
+ (code "GL_UNSIGNED_INT_10_10_10_2")
+ ", and "
+ (code "GL_UNSIGNED_INT_2_10_10_10_REV")
+ ". "))
+ (entry (% (heading (var "data")))
+ (para "
+Pointer to a one-dimensional array of pixel data that is processed to
+ build the color table. ")))
+ (heading "Description")
+ (para (code "glColorTable")
+ " may be used in two ways:
+ to test the actual size and color resolution of a lookup table
+ given a particular set of parameters,
+ or to load the contents of a color lookup
+ table.
+ Use the targets "
+ (code "GL_PROXY_*")
+ " for the first case
+ and the other targets for the second case. ")
+ (para "
+If a non-zero named buffer object is bound to the "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ " target
+ (see "
+ (code "glBindBuffer")
+ ") while a color table is
+ specified, "
+ (var "data")
+ " is treated as a byte offset into the buffer object's data store. ")
+ (para "
+If "
+ (var "target")
+ " is "
+ (code "GL_COLOR_TABLE")
+ ", "
+ (code "GL_POST_CONVOLUTION_COLOR_TABLE")
+ ",
+ or "
+ (code "GL_POST_COLOR_MATRIX_COLOR_TABLE")
+ ", "
+ (code "glColorTable")
+ " builds a color lookup table from an array of pixels.
+ The pixel array specified by "
+ (var "width")
+ ", "
+ (var "format")
+ ", "
+ (var "type")
+ ", and "
+ (var "data")
+ "
+is extracted from memory and
+ processed just as if "
+ (code "glDrawPixels")
+ " were called, but processing
+ stops after the final expansion to RGBA is completed. ")
+ (para "
+The four scale parameters and the four bias parameters that are defined
+ for the table are then used to scale and bias the R, G, B, and A components
+ of each pixel.
+ (Use "
+ (code "glColorTableParameter")
+ " to set these scale and bias
+ parameters.) ")
+ (para "
+Next, the R, G, B, and A values are clamped to the range "
+ (math "[" "0" "," "1" "]")
+ ".
+ Each pixel is then converted to the internal format specified by "
+ (var "internalformat")
+ ".
+ This conversion simply maps the component values of the pixel (R, G, B,
+ and A) to the values included in the internal format (red, green, blue,
+ alpha, luminance, and intensity). The mapping is as follows: ")
+ (para)
+ (table (% (formatter (asis)))
+ (entry (% (heading (strong "Internal Format")))
+ (para (strong "Red")
+ ", "
+ (strong "Green")
+ ", "
+ (strong "Blue")
+ ", "
+ (strong "Alpha")
+ ", "
+ (strong "Luminance")
+ ", "
+ (strong "Intensity")))
+ (entry (% (heading (code "GL_ALPHA")))
+ (para ", " ", " ", " "
+A " ", " ", "))
+ (entry (% (heading (code "GL_LUMINANCE")))
+ (para ", " ", " ", " ", " "
+R " ", "))
+ (entry (% (heading (code "GL_LUMINANCE_ALPHA")))
+ (para ", " ", " ", " "
+A " ", " "
+R " ", "))
+ (entry (% (heading (code "GL_INTENSITY")))
+ (para ", " ", " ", " ", " ", " "
+R "))
+ (entry (% (heading (code "GL_RGB")))
+ (para "
+R " ", " "
+G " ", " "
+B " ", " ", " ", "))
+ (entry (% (heading (code "GL_RGBA")))
+ (para "
+R "
+ ", "
+ "
+G "
+ ", "
+ "
+B "
+ ", "
+ "
+A "
+ ", "
+ ", ")))
+ (para "
+Finally, the red, green, blue, alpha, luminance, and/or intensity components of
+ the resulting pixels are stored in the color table.
+ They form a one-dimensional table with indices in the range "
+ (math "[" "0" "," (var "width") "-" "1" "]")
+ ". ")
+ (para "
+If "
+ (var "target")
+ " is "
+ (code "GL_PROXY_*")
+ ", "
+ (code "glColorTable")
+ " recomputes and stores the values of the proxy color table's state
+ variables "
+ (code "GL_COLOR_TABLE_FORMAT")
+ ", "
+ (code "GL_COLOR_TABLE_WIDTH")
+ ", "
+ (code "GL_COLOR_TABLE_RED_SIZE")
+ ", "
+ (code "GL_COLOR_TABLE_GREEN_SIZE")
+ ", "
+ (code "GL_COLOR_TABLE_BLUE_SIZE")
+ ", "
+ (code "GL_COLOR_TABLE_ALPHA_SIZE")
+ ", "
+ (code "GL_COLOR_TABLE_LUMINANCE_SIZE")
+ ", and "
+ (code "GL_COLOR_TABLE_INTENSITY_SIZE")
+ ".
+ There is no effect on the image or state of any actual color table.
+ If the specified color table is too large to be supported, then all the
+ proxy state variables listed above are set to zero.
+ Otherwise, the color table could be supported by "
+ (code "glColorTable")
+ "
+using the corresponding non-proxy target,
+ and the proxy state variables are set as if that target were being defined. ")
+ (para "
+The proxy state variables can be retrieved by calling "
+ (code "glGetColorTableParameter")
+ " with a target of "
+ (code "GL_PROXY_*")
+ ".
+ This allows the application to decide if a particular "
+ (code "glColorTable")
+ "
+command would succeed, and to determine what the resulting color table
+ attributes would be. ")
+ (para "
+If a color table is enabled, and its width is non-zero, then its
+ contents are used to replace a subset of the components of each RGBA
+ pixel group, based on the internal format of the table. ")
+ (para "
+Each pixel group has color components (R, G, B, A)
+ that are in the range "
+ (math "[" "0.0" "," "1.0" "]")
+ ".
+ The color components are rescaled to
+ the size of the color lookup table to form an index.
+ Then a subset of the components based on the internal format of the table are
+ replaced by the table entry selected by that index.
+ If the color components and contents of the table are represented as follows: ")
+ (para)
+ (table (% (formatter (asis)))
+ (entry (% (heading (strong "Representation")))
+ (para (strong "Meaning")))
+ (entry (% (heading (code "r")))
+ (para "
+Table index computed from " (code "R")))
+ (entry (% (heading (code "g")))
+ (para "
+Table index computed from " (code "G")))
+ (entry (% (heading (code "b")))
+ (para "
+Table index computed from " (code "B")))
+ (entry (% (heading (code "a")))
+ (para "
+Table index computed from " (code "A")))
+ (entry (% (heading (code "L[i]")))
+ (para "
+Luminance value at table index "
+ (code "i")))
+ (entry (% (heading (code "I[i]")))
+ (para "
+Intensity value at table index "
+ (code "i")))
+ (entry (% (heading (code "R[i]")))
+ (para "
+Red value at table index " (code "i")))
+ (entry (% (heading (code "G[i]")))
+ (para "
+Green value at table index " (code "i")))
+ (entry (% (heading (code "B[i]")))
+ (para "
+Blue value at table index " (code "i")))
+ (entry (% (heading (code "A[i]")))
+ (para "
+Alpha value at table index " (code "i"))))
+ (para "
+then the result of color table lookup is as follows: ")
+ (para)
+ (table (% (formatter (asis)))
+ (entry (% (heading (strong)))
+ (para (strong "Resulting Texture Components")))
+ (entry (% (heading (strong "Table Internal Format")))
+ (para (strong "R")
+ ", "
+ (strong "G")
+ ", "
+ (strong "B")
+ ", "
+ (strong "A")))
+ (entry (% (heading (code "GL_ALPHA")))
+ (para (code "R")
+ ", "
+ (code "G")
+ ", "
+ (code "B")
+ ", "
+ (code "A[a]")))
+ (entry (% (heading (code "GL_LUMINANCE")))
+ (para (code "L[r]")
+ ", "
+ (code "L[g]")
+ ", "
+ (code "L[b]")
+ ", "
+ (code "At")))
+ (entry (% (heading (code "GL_LUMINANCE_ALPHA")))
+ (para (code "L[r]")
+ ", "
+ (code "L[g]")
+ ", "
+ (code "L[b]")
+ ", "
+ (code "A[a]")))
+ (entry (% (heading (code "GL_INTENSITY")))
+ (para (code "I[r]")
+ ", "
+ (code "I[g]")
+ ", "
+ (code "I[b]")
+ ", "
+ (code "I[a]")))
+ (entry (% (heading (code "GL_RGB")))
+ (para (code "R[r]")
+ ", "
+ (code "G[g]")
+ ", "
+ (code "B[b]")
+ ", "
+ (code "A")))
+ (entry (% (heading (code "GL_RGBA")))
+ (para (code "R[r]")
+ ", "
+ (code "G[g]")
+ ", "
+ (code "B[b]")
+ ", "
+ (code "A[a]"))))
+ (para "
+When "
+ (code "GL_COLOR_TABLE")
+ " is enabled, the colors resulting from
+ the pixel map operation (if it is enabled) are mapped
+ by the color lookup table before being passed to the convolution
+ operation. The colors resulting from the convolution operation
+ are modified by the post convolution color lookup table when "
+ (code "GL_POST_CONVOLUTION_COLOR_TABLE")
+ "
+is enabled. These modified colors are then sent to the color matrix operation.
+ Finally, if "
+ (code "GL_POST_COLOR_MATRIX_COLOR_TABLE")
+ "
+is enabled, the colors resulting from the color matrix operation
+ are mapped by the post color matrix color lookup table before being
+ used by the histogram operation. ")
+ (para)
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "target")
+ " is not one of the allowable
+ values. ")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "internalformat")
+ " is not one of the
+ allowable values. ")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "format")
+ " is not one of the allowable
+ values. ")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "type")
+ " is not one of the allowable
+ values. ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "width")
+ " is less than zero. ")
+ (para (code "GL_TABLE_TOO_LARGE")
+ " is generated if the requested color table
+ is too large to be supported by the implementation, and "
+ (var "target")
+ " is
+ not a "
+ (code "GL_PROXY_*")
+ " target. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a non-zero buffer object name is bound to the "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ " target and the buffer object's data store is currently mapped. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a non-zero buffer object name is bound to the "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ " target and the data would be unpacked from the buffer
+ object such that the memory reads required would exceed the data store size. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a non-zero buffer object name is bound to the "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ " target and "
+ (var "data")
+ " is not evenly divisible
+ into the number of bytes needed to store in memory a datum indicated by "
+ (var "type")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glColorTable")
+ " is executed
+ between the execution of "
+ (code "glBegin")
+ " and the corresponding
+ execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glColor
+ "glColor"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glColor3b"))
+ (paramdef "GLbyte " (parameter "red"))
+ (paramdef "GLbyte " (parameter "green"))
+ (paramdef "GLbyte " (parameter "blue"))))
+ '(*fragment*
+ (heading "set the current color")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "red")))
+ (itemx (var "green"))
+ (itemx (var "blue"))
+ (para "
+Specify new red, green, and blue values for the current color. "))
+ (entry (% (heading (var "alpha")))
+ (para "
+Specifies a new alpha value for the current color.
+ Included only in the four-argument "
+ (code "glColor4")
+ " commands. ")))
+ (heading "Description")
+ (para "
+The GL stores both a current single-valued color index
+ and a current four-valued RGBA color. "
+ (code "glColor")
+ " sets a new four-valued RGBA color. "
+ (code "glColor")
+ " has two major variants: "
+ (code "glColor3")
+ " and "
+ (code "glColor4")
+ ". "
+ (code "glColor3")
+ " variants specify new red,
+ green,
+ and blue values explicitly
+ and set the current alpha value to 1.0 (full intensity) implicitly. "
+ (code "glColor4")
+ " variants specify all four color components explicitly. ")
+ (para (code "glColor3b")
+ ", "
+ (code "glColor4b")
+ ", "
+ (code "glColor3s")
+ ", "
+ (code "glColor4s")
+ ", "
+ (code "glColor3i")
+ ", and "
+ (code "glColor4i")
+ " take
+ three or four signed byte, short, or long integers as arguments.
+ When "
+ (strong "v")
+ " is appended to the name,
+ the color commands can take a pointer to an array of such values. ")
+ (para "
+Current color values are stored in floating-point format,
+ with unspecified mantissa and exponent sizes.
+ Unsigned integer color components,
+ when specified,
+ are linearly mapped to floating-point values such that the largest
+ representable value maps to 1.0 (full intensity),
+ and 0 maps to 0.0 (zero intensity).
+ Signed integer color components,
+ when specified,
+ are linearly mapped to floating-point values such that the most positive
+ representable value maps to 1.0,
+ and the most negative representable value maps to "
+ (math "-1.0")
+ ".
+ (Note that
+ this mapping does not convert 0 precisely to 0.0.)
+ Floating-point values are mapped directly. ")
+ (para "
+Neither floating-point nor signed integer values are clamped
+ to the range "
+ (math "[" "0" "," "1" "]")
+ "
+before the current color is updated.
+ However,
+ color components are clamped to this range before they are interpolated
+ or written into a color buffer. ")))
+
+(define-gl-procedure
+ glCompileShader
+ "glCompileShader"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glCompileShader"))
+ (paramdef "GLuint " (parameter "shader"))))
+ '(*fragment*
+ (heading "Compiles a shader object")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "shader")))
+ (para "Specifies the shader object to be
+\t\t compiled.")))
+ (heading "Description")
+ (para (code "glCompileShader")
+ " compiles the source
+\tcode strings that have been stored in the shader object
+\tspecified by "
+ (var "shader")
+ ".")
+ (para "The compilation status will be stored as part of the
+\tshader object's state. This value will be set to\t"
+ (code "GL_TRUE")
+ " if the shader was compiled without
+\terrors and is ready for use, and "
+ (code "GL_FALSE")
+ "
+otherwise. It can be queried by calling\t"
+ (code "glGetShader")
+ "
+with arguments "
+ (var "shader")
+ " and\t"
+ (code "GL_COMPILE_STATUS")
+ ".")
+ (para "Compilation of a shader can fail for a number of reasons
+\tas specified by the OpenGL Shading Language Specification.
+\tWhether or not the compilation was successful, information about
+\tthe compilation can be obtained from the shader object's
+\tinformation log by calling\t"
+ (code "glGetShaderInfoLog")
+ ".")
+ (heading "Errors")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if\t"
+ (var "shader")
+ " is not a value generated by
+\tOpenGL.")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if\t"
+ (var "shader")
+ " is not a shader object.")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if\t"
+ (code "glCompileShader")
+ " is executed between the
+\texecution of\t"
+ (code "glBegin")
+ "
+and the corresponding execution of\t"
+ (code "glEnd")
+ ".")))
+
+(define-gl-procedure
+ glCompressedTexImage1D
+ "glCompressedTexImage1D"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "void "
+ (function "glCompressedTexImage1D"))
+ (paramdef "GLenum " (parameter "target"))
+ (paramdef "GLint " (parameter "level"))
+ (paramdef "GLenum " (parameter "internalformat"))
+ (paramdef "GLsizei " (parameter "width"))
+ (paramdef "GLint " (parameter "border"))
+ (paramdef "GLsizei " (parameter "imageSize"))
+ (paramdef "const GLvoid * " (parameter "data"))))
+ '(*fragment*
+ (heading
+ "specify a one-dimensional texture image in a compressed format")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "target")))
+ (para "
+Specifies the target texture.
+ Must be "
+ (code "GL_TEXTURE_1D")
+ " or "
+ (code "GL_PROXY_TEXTURE_1D")
+ ". "))
+ (entry (% (heading (var "level")))
+ (para "
+Specifies the level-of-detail number.
+ Level 0 is the base image level.
+ Level "
+ (var "n")
+ " is the "
+ (var "n")
+ "th mipmap reduction image. "))
+ (entry (% (heading (var "internalformat")))
+ (para "
+Specifies the format of the compressed image data stored at address "
+ (var "data")
+ ". "))
+ (entry (% (heading (var "width")))
+ (para "
+Specifies the width of the texture image including the border if any. If the GL version does not support non-power-of-two sizes, this value must be "
+ (math "2"
+ "^"
+ (var "n")
+ "+"
+ "2"
+ "\u2061"
+ "("
+ (var "border")
+ ","
+ ")")
+ "
+for some integer "
+ (math (var "n"))
+ ".
+ All implementations support texture images that are at least 64 texels wide. The height of the 1D texture image is 1. "))
+ (entry (% (heading (var "border")))
+ (para "
+Specifies the width of the border. Must be either 0 or 1. "))
+ (entry (% (heading (var "imageSize")))
+ (para "
+Specifies the number of unsigned bytes of image data starting at the address specified by "
+ (var "data")
+ ". "))
+ (entry (% (heading (var "data")))
+ (para "
+Specifies a pointer to the compressed image data in memory. ")))
+ (heading "Description")
+ (para "
+Texturing maps a portion of a specified texture image onto each graphical primitive for which texturing is enabled. To enable and disable one-dimensional texturing, call "
+ (code "glEnable")
+ " and "
+ (code "glDisable")
+ " with argument "
+ (code "GL_TEXTURE_1D")
+ ". ")
+ (para (code "glCompressedTexImage1D")
+ " loads a previously defined, and retrieved, compressed one-dimensional texture image if "
+ (var "target")
+ " is "
+ (code "GL_TEXTURE_1D")
+ " (see "
+ (code "glTexImage1D")
+ "). ")
+ (para "
+If "
+ (var "target")
+ " is "
+ (code "GL_PROXY_TEXTURE_1D")
+ ", no data is read from "
+ (var "data")
+ ", but
+ all of the texture image state is recalculated, checked for consistency, and checked against the implementation's capabilities. If the implementation cannot handle a texture of the requested texture size, it sets all of the image state to 0, but does not generate an error (see "
+ (code "glGetError")
+ "). To query for an entire mipmap array, use an image array level greater than or equal to 1. ")
+ (para (var "internalformat")
+ " must be extension-specified compressed-texture format. When a texture is loaded with "
+ (code "glTexImage1D")
+ " using a generic compressed texture format (e.g., "
+ (code "GL_COMPRESSED_RGB")
+ ") the GL selects from one of
+ its extensions supporting compressed textures. In order to load the
+ compressed texture image using "
+ (code "glCompressedTexImage1D")
+ ", query the compressed texture image's size and format using "
+ (code "glGetTexLevelParameter")
+ ". ")
+ (para "
+If a non-zero named buffer object is bound to the "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ " target
+ (see "
+ (code "glBindBuffer")
+ ") while a texture image is
+ specified, "
+ (var "data")
+ " is treated as a byte offset into the buffer object's data store. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "internalformat")
+ " is one of the generic compressed internal formats: "
+ (code "GL_COMPRESSED_ALPHA")
+ ", "
+ (code "GL_COMPRESSED_LUMINANCE")
+ ", "
+ (code "GL_COMPRESSED_LUMINANCE_ALPHA")
+ ", "
+ (code "GL_COMPRESSED_INTENSITY")
+ ", "
+ (code "GL_COMPRESSED_RGB")
+ ", or "
+ (code "GL_COMPRESSED_RGBA")
+ ". ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "imageSize")
+ " is not consistent with
+ the format, dimensions, and contents of the specified compressed image
+ data. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if parameter combinations are not
+ supported by the specific compressed internal format as specified in the
+ specific texture compression extension. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a non-zero buffer object name is bound to the "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ " target and the buffer object's data store is currently mapped. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a non-zero buffer object name is bound to the "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ " target and the data would be unpacked from the buffer
+ object such that the memory reads required would exceed the data store size. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glCompressedTexImage1D")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")
+ (para "
+Undefined results, including abnormal program termination, are generated if "
+ (var "data")
+ " is not encoded in a manner consistent with the extension
+ specification defining the internal compression format. ")))
+
+(define-gl-procedure
+ glCompressedTexImage2D
+ "glCompressedTexImage2D"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "void "
+ (function "glCompressedTexImage2D"))
+ (paramdef "GLenum " (parameter "target"))
+ (paramdef "GLint " (parameter "level"))
+ (paramdef "GLenum " (parameter "internalformat"))
+ (paramdef "GLsizei " (parameter "width"))
+ (paramdef "GLsizei " (parameter "height"))
+ (paramdef "GLint " (parameter "border"))
+ (paramdef "GLsizei " (parameter "imageSize"))
+ (paramdef "const GLvoid * " (parameter "data"))))
+ '(*fragment*
+ (heading
+ "specify a two-dimensional texture image in a compressed format")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "target")))
+ (para "
+Specifies the target texture.
+ Must be "
+ (code "GL_TEXTURE_2D")
+ ", "
+ (code "GL_PROXY_TEXTURE_2D")
+ ", "
+ (code "GL_TEXTURE_CUBE_MAP_POSITIVE_X")
+ ", "
+ (code "GL_TEXTURE_CUBE_MAP_NEGATIVE_X")
+ ", "
+ (code "GL_TEXTURE_CUBE_MAP_POSITIVE_Y")
+ ", "
+ (code "GL_TEXTURE_CUBE_MAP_NEGATIVE_Y")
+ ", "
+ (code "GL_TEXTURE_CUBE_MAP_POSITIVE_Z")
+ ", "
+ (code "GL_TEXTURE_CUBE_MAP_NEGATIVE_Z")
+ ", or "
+ (code "GL_PROXY_TEXTURE_CUBE_MAP")
+ ". "))
+ (entry (% (heading (var "level")))
+ (para "
+Specifies the level-of-detail number.
+ Level 0 is the base image level.
+ Level "
+ (var "n")
+ " is the "
+ (var "n")
+ "th mipmap reduction image. "))
+ (entry (% (heading (var "internalformat")))
+ (para "
+Specifies the format of the compressed image data stored at address "
+ (var "data")
+ ". "))
+ (entry (% (heading (var "width")))
+ (para "
+Specifies the width of the texture image including the border if any. If the GL version does not support non-power-of-two sizes, this value must be "
+ (math "2"
+ "^"
+ (var "n")
+ "+"
+ "2"
+ "\u2061"
+ "("
+ (var "border")
+ ","
+ ")")
+ "
+for some integer "
+ (math (var "n"))
+ ".
+ All
+ implementations support 2D texture images that are at least 64 texels
+ wide and cube-mapped texture images that are at least 16 texels wide. "))
+ (entry (% (heading (var "height")))
+ (para "
+Specifies the height of the texture image including the border if any. If the GL version does not support non-power-of-two sizes, this value must be
+ Must be "
+ (math "2"
+ "^"
+ (var "n")
+ "+"
+ "2"
+ "\u2061"
+ "("
+ (var "border")
+ ","
+ ")")
+ "
+for some integer "
+ (math (var "n"))
+ ".
+ All
+ implementations support 2D texture images that are at least 64 texels
+ high and cube-mapped texture images that are at least 16 texels high. "))
+ (entry (% (heading (var "border")))
+ (para "
+Specifies the width of the border.
+ Must be either 0 or 1. "))
+ (entry (% (heading (var "imageSize")))
+ (para "
+Specifies the number of unsigned bytes of image data starting at the
+ address specified by "
+ (var "data")
+ ". "))
+ (entry (% (heading (var "data")))
+ (para "
+Specifies a pointer to the compressed image data in memory. ")))
+ (heading "Description")
+ (para "
+Texturing maps a portion of a specified texture image onto each graphical
+ primitive for which texturing is enabled. To enable and disable
+ two-dimensional texturing, call "
+ (code "glEnable")
+ " and "
+ (code "glDisable")
+ " with argument "
+ (code "GL_TEXTURE_2D")
+ ". To enable and disable texturing using
+ cube-mapped textures, call "
+ (code "glEnable")
+ " and "
+ (code "glDisable")
+ " with argument "
+ (code "GL_TEXTURE_CUBE_MAP")
+ ". ")
+ (para (code "glCompressedTexImage2D")
+ " loads a previously defined, and retrieved, compressed two-dimensional
+ texture image if "
+ (var "target")
+ " is "
+ (code "GL_TEXTURE_2D")
+ " (see "
+ (code "glTexImage2D")
+ "). ")
+ (para "
+If "
+ (var "target")
+ " is "
+ (code "GL_PROXY_TEXTURE_2D")
+ ", no data is read from "
+ (var "data")
+ ", but
+ all of the texture image state is recalculated, checked for consistency,
+ and checked against the implementation's capabilities. If the
+ implementation cannot handle a texture of the requested texture size, it
+ sets all of the image state to 0, but does not generate an error (see "
+ (code "glGetError")
+ "). To query for an entire mipmap array, use an image array level
+ greater than or equal to 1. ")
+ (para (var "internalformat")
+ " must be an extension-specified compressed-texture format.
+ When a texture is loaded with "
+ (code "glTexImage2D")
+ " using a generic compressed
+ texture format (e.g., "
+ (code "GL_COMPRESSED_RGB")
+ "), the GL selects from one of
+ its extensions supporting compressed textures. In order to load the
+ compressed texture image using "
+ (code "glCompressedTexImage2D")
+ ", query the compressed texture image's
+ size and format using "
+ (code "glGetTexLevelParameter")
+ ". ")
+ (para "
+If a non-zero named buffer object is bound to the "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ " target
+ (see "
+ (code "glBindBuffer")
+ ") while a texture image is
+ specified, "
+ (var "data")
+ " is treated as a byte offset into the buffer object's data store. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "internalformat")
+ " is one of the generic compressed internal formats: "
+ (code "GL_COMPRESSED_ALPHA")
+ ", "
+ (code "GL_COMPRESSED_LUMINANCE")
+ ", "
+ (code "GL_COMPRESSED_LUMINANCE_ALPHA")
+ ", "
+ (code "GL_COMPRESSED_INTENSITY")
+ ", "
+ (code "GL_COMPRESSED_RGB")
+ ", or "
+ (code "GL_COMPRESSED_RGBA")
+ ". ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "imageSize")
+ " is not consistent with
+ the format, dimensions, and contents of the specified compressed image
+ data. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if parameter combinations are not
+ supported by the specific compressed internal format as specified in the
+ specific texture compression extension. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a non-zero buffer object name is bound to the "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ " target and the buffer object's data store is currently mapped. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a non-zero buffer object name is bound to the "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ " target and the data would be unpacked from the buffer
+ object such that the memory reads required would exceed the data store size. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glCompressedTexImage2D")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")
+ (para "
+Undefined results, including abnormal program termination, are generated if "
+ (var "data")
+ " is not encoded in a manner consistent with the extension
+ specification defining the internal compression format. ")))
+
+(define-gl-procedure
+ glCompressedTexImage3D
+ "glCompressedTexImage3D"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "void "
+ (function "glCompressedTexImage3D"))
+ (paramdef "GLenum " (parameter "target"))
+ (paramdef "GLint " (parameter "level"))
+ (paramdef "GLenum " (parameter "internalformat"))
+ (paramdef "GLsizei " (parameter "width"))
+ (paramdef "GLsizei " (parameter "height"))
+ (paramdef "GLsizei " (parameter "depth"))
+ (paramdef "GLint " (parameter "border"))
+ (paramdef "GLsizei " (parameter "imageSize"))
+ (paramdef "const GLvoid * " (parameter "data"))))
+ '(*fragment*
+ (heading
+ "specify a three-dimensional texture image in a compressed format")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "target")))
+ (para "
+Specifies the target texture.
+ Must be "
+ (code "GL_TEXTURE_3D")
+ " or "
+ (code "GL_PROXY_TEXTURE_3D")
+ ". "))
+ (entry (% (heading (var "level")))
+ (para "
+Specifies the level-of-detail number.
+ Level 0 is the base image level.
+ Level "
+ (var "n")
+ " is the "
+ (var "n")
+ "th mipmap reduction image. "))
+ (entry (% (heading (var "internalformat")))
+ (para "
+Specifies the format of the compressed image data stored at address "
+ (var "data")
+ ". "))
+ (entry (% (heading (var "width")))
+ (para "
+Specifies the width of the texture image including the border if any. If the GL version does not support non-power-of-two sizes, this value must be "
+ (math "2"
+ "^"
+ (var "n")
+ "+"
+ "2"
+ "\u2061"
+ "("
+ (var "border")
+ ","
+ ")")
+ "
+for some integer "
+ (math (var "n"))
+ ".
+ All
+ implementations support 3D texture images that are at least 16 texels
+ wide. "))
+ (entry (% (heading (var "height")))
+ (para "
+Specifies the height of the texture image including the border if any. If the GL version does not support non-power-of-two sizes, this value must be "
+ (math "2"
+ "^"
+ (var "n")
+ "+"
+ "2"
+ "\u2061"
+ "("
+ (var "border")
+ ","
+ ")")
+ "
+for some integer "
+ (math (var "n"))
+ ".
+ All
+ implementations support 3D texture images that are at least 16 texels
+ high. "))
+ (entry (% (heading (var "depth")))
+ (para "
+Specifies the depth of the texture image including the border if any. If the GL version does not support non-power-of-two sizes, this value must be "
+ (math "2"
+ "^"
+ (var "n")
+ "+"
+ "2"
+ "\u2061"
+ "("
+ (var "border")
+ ","
+ ")")
+ "
+for some integer "
+ (math (var "n"))
+ ".
+ All
+ implementations support 3D texture images that are at least 16 texels
+ deep. "))
+ (entry (% (heading (var "border")))
+ (para "
+Specifies the width of the border.
+ Must be either 0 or 1. "))
+ (entry (% (heading (var "imageSize")))
+ (para "
+Specifies the number of unsigned bytes of image data starting at the
+ address specified by "
+ (var "data")
+ ". "))
+ (entry (% (heading (var "data")))
+ (para "
+Specifies a pointer to the compressed image data in memory. ")))
+ (heading "Description")
+ (para "
+Texturing maps a portion of a specified texture image onto each graphical
+ primitive for which texturing is enabled. To enable and disable
+ three-dimensional texturing, call "
+ (code "glEnable")
+ " and "
+ (code "glDisable")
+ " with argument "
+ (code "GL_TEXTURE_3D")
+ ". ")
+ (para (code "glCompressedTexImage3D")
+ " loads a previously defined, and retrieved, compressed three-dimensional
+ texture image if "
+ (var "target")
+ " is "
+ (code "GL_TEXTURE_3D")
+ " (see "
+ (code "glTexImage3D")
+ "). ")
+ (para "
+If "
+ (var "target")
+ " is "
+ (code "GL_PROXY_TEXTURE_3D")
+ ", no data is read from "
+ (var "data")
+ ", but
+ all of the texture image state is recalculated, checked for consistency,
+ and checked against the implementation's capabilities. If the
+ implementation cannot handle a texture of the requested texture size, it
+ sets all of the image state to 0, but does not generate an error (see "
+ (code "glGetError")
+ "). To query for an entire mipmap array, use an image array level
+ greater than or equal to 1. ")
+ (para (var "internalformat")
+ " must be an extension-specified compressed-texture format.
+ When a texture is loaded with "
+ (code "glTexImage2D")
+ " using a generic compressed
+ texture format (e.g., "
+ (code "GL_COMPRESSED_RGB")
+ "), the GL selects from one of
+ its extensions supporting compressed textures. In order to load the
+ compressed texture image using "
+ (code "glCompressedTexImage3D")
+ ", query the compressed texture image's
+ size and format using "
+ (code "glGetTexLevelParameter")
+ ". ")
+ (para "
+If a non-zero named buffer object is bound to the "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ " target
+ (see "
+ (code "glBindBuffer")
+ ") while a texture image is
+ specified, "
+ (var "data")
+ " is treated as a byte offset into the buffer object's data store. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "internalformat")
+ " is one of the generic compressed internal formats: "
+ (code "GL_COMPRESSED_ALPHA")
+ ", "
+ (code "GL_COMPRESSED_LUMINANCE")
+ ", "
+ (code "GL_COMPRESSED_LUMINANCE_ALPHA")
+ ", "
+ (code "GL_COMPRESSED_INTENSITY")
+ ", "
+ (code "GL_COMPRESSED_RGB")
+ ", or "
+ (code "GL_COMPRESSED_RGBA")
+ ". ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "imageSize")
+ " is not consistent with
+ the format, dimensions, and contents of the specified compressed image data. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if parameter combinations are not
+ supported by the specific compressed internal format as specified in the
+ specific texture compression extension. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a non-zero buffer object name is bound to the "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ " target and the buffer object's data store is currently mapped. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a non-zero buffer object name is bound to the "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ " target and the data would be unpacked from the buffer
+ object such that the memory reads required would exceed the data store size. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glCompressedTexImage3D")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")
+ (para "
+Undefined results, including abnormal program termination, are generated if "
+ (var "data")
+ " is not encoded in a manner consistent with the extension specification defining the internal compression format. ")))
+
+(define-gl-procedure
+ glCompressedTexSubImage1D
+ "glCompressedTexSubImage1D"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "void "
+ (function "glCompressedTexSubImage1D"))
+ (paramdef "GLenum " (parameter "target"))
+ (paramdef "GLint " (parameter "level"))
+ (paramdef "GLint " (parameter "xoffset"))
+ (paramdef "GLsizei " (parameter "width"))
+ (paramdef "GLenum " (parameter "format"))
+ (paramdef "GLsizei " (parameter "imageSize"))
+ (paramdef "const GLvoid * " (parameter "data"))))
+ '(*fragment*
+ (heading
+ "specify a one-dimensional texture subimage in a compressed format")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "target")))
+ (para "
+Specifies the target texture.
+ Must be "
+ (code "GL_TEXTURE_1D")
+ ". "))
+ (entry (% (heading (var "level")))
+ (para "
+Specifies the level-of-detail number.
+ Level 0 is the base image level.
+ Level "
+ (var "n")
+ " is the "
+ (var "n")
+ "th mipmap reduction image. "))
+ (entry (% (heading (var "xoffset")))
+ (para "
+Specifies a texel offset in the x direction within the texture array. "))
+ (entry (% (heading (var "width")))
+ (para "
+Specifies the width of the texture subimage. "))
+ (entry (% (heading (var "format")))
+ (para "
+Specifies the format of the compressed image data stored at address "
+ (var "data")
+ ". "))
+ (entry (% (heading (var "imageSize")))
+ (para "
+Specifies the number of unsigned bytes of image data starting at the
+ address specified by "
+ (var "data")
+ ". "))
+ (entry (% (heading (var "data")))
+ (para "
+Specifies a pointer to the compressed image data in memory. ")))
+ (heading "Description")
+ (para "
+Texturing maps a portion of a specified texture image onto each graphical
+ primitive for which texturing is enabled. To enable and disable
+ one-dimensional texturing, call "
+ (code "glEnable")
+ " and "
+ (code "glDisable")
+ " with argument "
+ (code "GL_TEXTURE_1D")
+ ". ")
+ (para (code "glCompressedTexSubImage1D")
+ " redefines a contiguous subregion of an existing one-dimensional
+ texture image. The texels referenced by "
+ (var "data")
+ " replace the portion of the
+ existing texture array with x indices "
+ (var "xoffset")
+ " and "
+ (math (var "xoffset") "+" (var "width") "-" "1")
+ ",
+ inclusive. This region may not include any texels
+ outside the range of the texture array as it was originally specified. It
+ is not an error to specify a subtexture with width of 0, but such a
+ specification has no effect. ")
+ (para (var "format")
+ " must be an extension-specified
+ compressed-texture format. The "
+ (var "format")
+ " of the compressed texture
+ image is selected by the GL implementation that compressed it (see "
+ (code "glTexImage1D")
+ "), and should be queried at the time the texture was
+ compressed with "
+ (code "glGetTexLevelParameter")
+ ". ")
+ (para "
+If a non-zero named buffer object is bound to the "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ " target
+ (see "
+ (code "glBindBuffer")
+ ") while a texture image is
+ specified, "
+ (var "data")
+ " is treated as a byte offset into the buffer object's data store. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "format")
+ " is one of these generic compressed internal formats: "
+ (code "GL_COMPRESSED_ALPHA")
+ ", "
+ (code "GL_COMPRESSED_LUMINANCE")
+ ", "
+ (code "GL_COMPRESSED_LUMINANCE_ALPHA")
+ ", "
+ (code "GL_COMPRESSED_INTENSITY")
+ ", "
+ (code "GL_COMPRESSED_RGB")
+ ", "
+ (code "GL_COMPRESSED_RGBA")
+ ",\t"
+ (code "GL_COMPRESSED_SLUMINANCE")
+ ",\t"
+ (code "GL_COMPRESSED_SLUMINANCE_ALPHA")
+ ",\t"
+ (code "GL_COMPRESSED_SRGB")
+ ",\t"
+ (code "GL_COMPRESSED_SRGBA")
+ ", or\t"
+ (code "GL_COMPRESSED_SRGB_ALPHA")
+ ". ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "imageSize")
+ " is not consistent with
+ the format, dimensions, and contents of the specified compressed image
+ data. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if parameter combinations are not
+ supported by the specific compressed internal format as specified in the
+ specific texture compression extension. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a non-zero buffer object name is bound to the "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ " target and the buffer object's data store is currently mapped. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a non-zero buffer object name is bound to the "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ " target and the data would be unpacked from the buffer
+ object such that the memory reads required would exceed the data store size. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glCompressedTexSubImage1D")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")
+ (para "
+Undefined results, including abnormal program termination, are generated if "
+ (var "data")
+ " is not encoded in a manner consistent with the extension
+ specification defining the internal compression format. ")))
+
+(define-gl-procedure
+ glCompressedTexSubImage2D
+ "glCompressedTexSubImage2D"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "void "
+ (function "glCompressedTexSubImage2D"))
+ (paramdef "GLenum " (parameter "target"))
+ (paramdef "GLint " (parameter "level"))
+ (paramdef "GLint " (parameter "xoffset"))
+ (paramdef "GLint " (parameter "yoffset"))
+ (paramdef "GLsizei " (parameter "width"))
+ (paramdef "GLsizei " (parameter "height"))
+ (paramdef "GLenum " (parameter "format"))
+ (paramdef "GLsizei " (parameter "imageSize"))
+ (paramdef "const GLvoid * " (parameter "data"))))
+ '(*fragment*
+ (heading
+ "specify a two-dimensional texture subimage in a compressed format")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "target")))
+ (para "
+Specifies the target texture.
+ Must be "
+ (code "GL_TEXTURE_2D")
+ ", "
+ (code "GL_TEXTURE_CUBE_MAP_POSITIVE_X")
+ ", "
+ (code "GL_TEXTURE_CUBE_MAP_NEGATIVE_X")
+ ", "
+ (code "GL_TEXTURE_CUBE_MAP_POSITIVE_Y")
+ ", "
+ (code "GL_TEXTURE_CUBE_MAP_NEGATIVE_Y")
+ ", "
+ (code "GL_TEXTURE_CUBE_MAP_POSITIVE_Z")
+ ", or "
+ (code "GL_TEXTURE_CUBE_MAP_NEGATIVE_Z")
+ ". "))
+ (entry (% (heading (var "level")))
+ (para "
+Specifies the level-of-detail number.
+ Level 0 is the base image level.
+ Level "
+ (var "n")
+ " is the "
+ (var "n")
+ "th mipmap reduction image. "))
+ (entry (% (heading (var "xoffset")))
+ (para "
+Specifies a texel offset in the x direction within the texture array. "))
+ (entry (% (heading (var "yoffset")))
+ (para "
+Specifies a texel offset in the y direction within the texture array. "))
+ (entry (% (heading (var "width")))
+ (para "
+Specifies the width of the texture subimage. "))
+ (entry (% (heading (var "height")))
+ (para "
+Specifies the height of the texture subimage. "))
+ (entry (% (heading (var "format")))
+ (para "
+Specifies the format of the compressed image data stored at address "
+ (var "data")
+ ". "))
+ (entry (% (heading (var "imageSize")))
+ (para "
+Specifies the number of unsigned bytes of image data starting at the
+ address specified by "
+ (var "data")
+ ". "))
+ (entry (% (heading (var "data")))
+ (para "
+Specifies a pointer to the compressed image data in memory. ")))
+ (heading "Description")
+ (para "
+Texturing maps a portion of a specified texture image onto each graphical
+ primitive for which texturing is enabled. To enable and disable
+ two-dimensional texturing, call "
+ (code "glEnable")
+ " and "
+ (code "glDisable")
+ " with argument "
+ (code "GL_TEXTURE_2D")
+ ". To enable and disable texturing using
+ cube-mapped texture, call "
+ (code "glEnable")
+ " and "
+ (code "glDisable")
+ " with argument "
+ (code "GL_TEXTURE_CUBE_MAP")
+ ". ")
+ (para (code "glCompressedTexSubImage2D")
+ " redefines a contiguous subregion of an existing two-dimensional
+ texture image. The texels referenced by "
+ (var "data")
+ " replace the portion of the
+ existing texture array with x indices "
+ (var "xoffset")
+ " and "
+ (math (var "xoffset") "+" (var "width") "-" "1")
+ ",
+ and the y indices "
+ (var "yoffset")
+ " and "
+ (math (var "yoffset") "+" (var "height") "-" "1")
+ ",
+ inclusive.
+ This region may not include any texels
+ outside the range of the texture array as it was originally specified. It
+ is not an error to specify a subtexture with width of 0, but such a
+ specification has no effect. ")
+ (para (var "format")
+ " must be an extension-specified
+ compressed-texture format. The "
+ (var "format")
+ " of the compressed texture
+ image is selected by the GL implementation that compressed it (see "
+ (code "glTexImage2D")
+ ") and should be queried at the time the texture was
+ compressed with "
+ (code "glGetTexLevelParameter")
+ ". ")
+ (para "
+If a non-zero named buffer object is bound to the "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ " target
+ (see "
+ (code "glBindBuffer")
+ ") while a texture image is
+ specified, "
+ (var "data")
+ " is treated as a byte offset into the buffer object's data store. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "format")
+ " is one of these generic compressed internal formats: "
+ (code "GL_COMPRESSED_ALPHA")
+ ", "
+ (code "GL_COMPRESSED_LUMINANCE")
+ ", "
+ (code "GL_COMPRESSED_LUMINANCE_ALPHA")
+ ", "
+ (code "GL_COMPRESSED_INTENSITY")
+ ", "
+ (code "GL_COMPRESSED_RGB")
+ ", "
+ (code "GL_COMPRESSED_RGBA")
+ ",\t"
+ (code "GL_COMPRESSED_SLUMINANCE")
+ ",\t"
+ (code "GL_COMPRESSED_SLUMINANCE_ALPHA")
+ ",\t"
+ (code "GL_COMPRESSED_SRGB")
+ ",\t"
+ (code "GL_COMPRESSED_SRGBA")
+ ", or\t"
+ (code "GL_COMPRESSED_SRGB_ALPHA")
+ ". ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "imageSize")
+ " is not consistent with
+ the format, dimensions, and contents of the specified compressed image
+ data. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if parameter combinations are not
+ supported by the specific compressed internal format as specified in the
+ specific texture compression extension. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a non-zero buffer object name is bound to the "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ " target and the buffer object's data store is currently mapped. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a non-zero buffer object name is bound to the "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ " target and the data would be unpacked from the buffer
+ object such that the memory reads required would exceed the data store size. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glCompressedTexSubImage2D")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")
+ (para "
+Undefined results, including abnormal program termination, are generated if "
+ (var "data")
+ " is not encoded in a manner consistent with the extension
+ specification defining the internal compression format. ")))
+
+(define-gl-procedure
+ glCompressedTexSubImage3D
+ "glCompressedTexSubImage3D"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "void "
+ (function "glCompressedTexSubImage3D"))
+ (paramdef "GLenum " (parameter "target"))
+ (paramdef "GLint " (parameter "level"))
+ (paramdef "GLint " (parameter "xoffset"))
+ (paramdef "GLint " (parameter "yoffset"))
+ (paramdef "GLint " (parameter "zoffset"))
+ (paramdef "GLsizei " (parameter "width"))
+ (paramdef "GLsizei " (parameter "height"))
+ (paramdef "GLsizei " (parameter "depth"))
+ (paramdef "GLenum " (parameter "format"))
+ (paramdef "GLsizei " (parameter "imageSize"))
+ (paramdef "const GLvoid * " (parameter "data"))))
+ '(*fragment*
+ (heading
+ "specify a three-dimensional texture subimage in a compressed format")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "target")))
+ (para "
+Specifies the target texture.
+ Must be "
+ (code "GL_TEXTURE_3D")
+ ". "))
+ (entry (% (heading (var "level")))
+ (para "
+Specifies the level-of-detail number.
+ Level 0 is the base image level.
+ Level "
+ (var "n")
+ " is the "
+ (var "n")
+ "th mipmap reduction image. "))
+ (entry (% (heading (var "xoffset")))
+ (para "
+Specifies a texel offset in the x direction within the texture array. "))
+ (entry (% (heading (var "yoffset")))
+ (para "
+Specifies a texel offset in the y direction within the texture array. "))
+ (entry (% (heading (var "width")))
+ (para "
+Specifies the width of the texture subimage. "))
+ (entry (% (heading (var "height")))
+ (para "
+Specifies the height of the texture subimage. "))
+ (entry (% (heading (var "depth")))
+ (para "
+Specifies the depth of the texture subimage. "))
+ (entry (% (heading (var "format")))
+ (para "
+Specifies the format of the compressed image data stored at address "
+ (var "data")
+ ". "))
+ (entry (% (heading (var "imageSize")))
+ (para "
+Specifies the number of unsigned bytes of image data starting at the
+ address specified by "
+ (var "data")
+ ". "))
+ (entry (% (heading (var "data")))
+ (para "
+Specifies a pointer to the compressed image data in memory. ")))
+ (heading "Description")
+ (para "
+Texturing maps a portion of a specified texture image onto each graphical
+ primitive for which texturing is enabled. To enable and disable
+ three-dimensional texturing, call "
+ (code "glEnable")
+ " and "
+ (code "glDisable")
+ " with argument "
+ (code "GL_TEXTURE_3D")
+ ". ")
+ (para (code "glCompressedTexSubImage3D")
+ " redefines a contiguous subregion of an existing three-dimensional
+ texture image. The texels referenced by "
+ (var "data")
+ " replace the portion of the
+ existing texture array with x indices "
+ (var "xoffset")
+ " and "
+ (math (var "xoffset") "+" (var "width") "-" "1")
+ ",
+ and the y indices "
+ (var "yoffset")
+ " and "
+ (math (var "yoffset") "+" (var "height") "-" "1")
+ ",
+ and the z indices "
+ (var "zoffset")
+ " and "
+ (math (var "zoffset") "+" (var "depth") "-" "1")
+ ",
+ inclusive. This region may not include
+ any texels outside the range of the texture array as it was originally
+ specified. It is not an error to specify a subtexture with width of 0,
+ but such a specification has no effect. ")
+ (para (var "format")
+ " must be an extension-specified
+ compressed-texture format. The "
+ (var "format")
+ " of the compressed texture
+ image is selected by the GL implementation that compressed it (see "
+ (code "glTexImage3D")
+ ") and should be queried at the time the texture was
+ compressed with "
+ (code "glGetTexLevelParameter")
+ ". ")
+ (para "
+If a non-zero named buffer object is bound to the "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ " target
+ (see "
+ (code "glBindBuffer")
+ ") while a texture image is
+ specified, "
+ (var "data")
+ " is treated as a byte offset into the buffer object's data store. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "format")
+ " is one of these generic compressed internal formats: "
+ (code "GL_COMPRESSED_ALPHA")
+ ", "
+ (code "GL_COMPRESSED_LUMINANCE")
+ ", "
+ (code "GL_COMPRESSED_LUMINANCE_ALPHA")
+ ", "
+ (code "GL_COMPRESSED_INTENSITY")
+ ", "
+ (code "GL_COMPRESSED_RGB")
+ ", "
+ (code "GL_COMPRESSED_RGBA")
+ ",\t"
+ (code "GL_COMPRESSED_SLUMINANCE")
+ ",\t"
+ (code "GL_COMPRESSED_SLUMINANCE_ALPHA")
+ ",\t"
+ (code "GL_COMPRESSED_SRGB")
+ ",\t"
+ (code "GL_COMPRESSED_SRGBA")
+ ", or\t"
+ (code "GL_COMPRESSED_SRGB_ALPHA")
+ ". ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "imageSize")
+ " is not consistent with
+ the format, dimensions, and contents of the specified compressed image
+ data. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if parameter combinations are not
+ supported by the specific compressed internal format as specified in the
+ specific texture compression extension. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a non-zero buffer object name is bound to the "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ " target and the buffer object's data store is currently mapped. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a non-zero buffer object name is bound to the "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ " target and the data would be unpacked from the buffer
+ object such that the memory reads required would exceed the data store size. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glCompressedTexSubImage3D")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")
+ (para "
+Undefined results, including abnormal program termination, are generated if "
+ (var "data")
+ " is not encoded in a manner consistent with the extension
+ specification defining the internal compression format. ")))
+
+(define-gl-procedure
+ glConvolutionFilter1D
+ "glConvolutionFilter1D"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "void "
+ (function "glConvolutionFilter1D"))
+ (paramdef "GLenum " (parameter "target"))
+ (paramdef "GLenum " (parameter "internalformat"))
+ (paramdef "GLsizei " (parameter "width"))
+ (paramdef "GLenum " (parameter "format"))
+ (paramdef "GLenum " (parameter "type"))
+ (paramdef "const GLvoid * " (parameter "data"))))
+ '(*fragment*
+ (heading
+ "define a one-dimensional convolution filter")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "target")))
+ (para "
+Must be "
+ (code "GL_CONVOLUTION_1D")
+ ". "))
+ (entry (% (heading (var "internalformat")))
+ (para "
+The internal format of the convolution filter kernel.
+ The allowable values are "
+ (code "GL_ALPHA")
+ ", "
+ (code "GL_ALPHA4")
+ ", "
+ (code "GL_ALPHA8")
+ ", "
+ (code "GL_ALPHA12")
+ ", "
+ (code "GL_ALPHA16")
+ ", "
+ (code "GL_LUMINANCE")
+ ", "
+ (code "GL_LUMINANCE4")
+ ", "
+ (code "GL_LUMINANCE8")
+ ", "
+ (code "GL_LUMINANCE12")
+ ", "
+ (code "GL_LUMINANCE16")
+ ", "
+ (code "GL_LUMINANCE_ALPHA")
+ ", "
+ (code "GL_LUMINANCE4_ALPHA4")
+ ", "
+ (code "GL_LUMINANCE6_ALPHA2")
+ ", "
+ (code "GL_LUMINANCE8_ALPHA8")
+ ", "
+ (code "GL_LUMINANCE12_ALPHA4")
+ ", "
+ (code "GL_LUMINANCE12_ALPHA12")
+ ", "
+ (code "GL_LUMINANCE16_ALPHA16")
+ ", "
+ (code "GL_INTENSITY")
+ ", "
+ (code "GL_INTENSITY4")
+ ", "
+ (code "GL_INTENSITY8")
+ ", "
+ (code "GL_INTENSITY12")
+ ", "
+ (code "GL_INTENSITY16")
+ ", "
+ (code "GL_R3_G3_B2")
+ ", "
+ (code "GL_RGB")
+ ", "
+ (code "GL_RGB4")
+ ", "
+ (code "GL_RGB5")
+ ", "
+ (code "GL_RGB8")
+ ", "
+ (code "GL_RGB10")
+ ", "
+ (code "GL_RGB12")
+ ", "
+ (code "GL_RGB16")
+ ", "
+ (code "GL_RGBA")
+ ", "
+ (code "GL_RGBA2")
+ ", "
+ (code "GL_RGBA4")
+ ", "
+ (code "GL_RGB5_A1")
+ ", "
+ (code "GL_RGBA8")
+ ", "
+ (code "GL_RGB10_A2")
+ ", "
+ (code "GL_RGBA12")
+ ", or "
+ (code "GL_RGBA16")
+ ". "))
+ (entry (% (heading (var "width")))
+ (para "
+The width of the pixel array referenced by "
+ (var "data")
+ ". "))
+ (entry (% (heading (var "format")))
+ (para "
+The format of the pixel data in "
+ (var "data")
+ ".
+ The allowable values are "
+ (code "GL_ALPHA")
+ ", "
+ (code "GL_LUMINANCE")
+ ", "
+ (code "GL_LUMINANCE_ALPHA")
+ ", "
+ (code "GL_INTENSITY")
+ ", "
+ (code "GL_RGB")
+ ", and "
+ (code "GL_RGBA")
+ ". "))
+ (entry (% (heading (var "type")))
+ (para "
+The type of the pixel data in "
+ (var "data")
+ ".
+ Symbolic constants "
+ (code "GL_UNSIGNED_BYTE")
+ ", "
+ (code "GL_BYTE")
+ ", "
+ (code "GL_BITMAP")
+ ", "
+ (code "GL_UNSIGNED_SHORT")
+ ", "
+ (code "GL_SHORT")
+ ", "
+ (code "GL_UNSIGNED_INT")
+ ", "
+ (code "GL_INT")
+ ", "
+ (code "GL_FLOAT")
+ ", "
+ (code "GL_UNSIGNED_BYTE_3_3_2")
+ ", "
+ (code "GL_UNSIGNED_BYTE_2_3_3_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_6_5")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_6_5_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_4_4_4_4")
+ ", "
+ (code "GL_UNSIGNED_SHORT_4_4_4_4_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_5_5_1")
+ ", "
+ (code "GL_UNSIGNED_SHORT_1_5_5_5_REV")
+ ", "
+ (code "GL_UNSIGNED_INT_8_8_8_8")
+ ", "
+ (code "GL_UNSIGNED_INT_8_8_8_8_REV")
+ ", "
+ (code "GL_UNSIGNED_INT_10_10_10_2")
+ ", and "
+ (code "GL_UNSIGNED_INT_2_10_10_10_REV")
+ "
+are accepted. "))
+ (entry (% (heading (var "data")))
+ (para "
+Pointer to a one-dimensional array of pixel data that is processed to
+ build the convolution filter kernel. ")))
+ (heading "Description")
+ (para (code "glConvolutionFilter1D")
+ " builds a one-dimensional convolution filter kernel from an array of
+ pixels. ")
+ (para "
+The pixel array specified by "
+ (var "width")
+ ", "
+ (var "format")
+ ", "
+ (var "type")
+ ", and "
+ (var "data")
+ "
+is extracted from memory and
+ processed just as if "
+ (code "glDrawPixels")
+ " were called, but processing
+ stops after the final expansion to RGBA is completed. ")
+ (para "
+If a non-zero named buffer object is bound to the "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ " target
+ (see "
+ (code "glBindBuffer")
+ ") while a convolution filter is
+ specified, "
+ (var "data")
+ " is treated as a byte offset into the buffer object's data store. ")
+ (para "
+The R, G, B, and A components of each pixel are next scaled by the four
+ 1D "
+ (code "GL_CONVOLUTION_FILTER_SCALE")
+ " parameters and biased by the
+ four 1D "
+ (code "GL_CONVOLUTION_FILTER_BIAS")
+ " parameters.
+ (The scale and bias parameters are set by "
+ (code "glConvolutionParameter")
+ "
+using the "
+ (code "GL_CONVOLUTION_1D")
+ " target and the names "
+ (code "GL_CONVOLUTION_FILTER_SCALE")
+ " and "
+ (code "GL_CONVOLUTION_FILTER_BIAS")
+ ".
+ The parameters themselves are vectors of four values that are applied to red,
+ green, blue, and alpha, in that order.)
+ The R, G, B, and A values are not clamped to [0,1] at any time during this
+ process. ")
+ (para "
+Each pixel is then converted to the internal format specified by "
+ (var "internalformat")
+ ".
+ This conversion simply maps the component values of the pixel (R, G, B,
+ and A) to the values included in the internal format (red, green, blue,
+ alpha, luminance, and intensity). The mapping is as follows: ")
+ (para)
+ (table (% (formatter (asis)))
+ (entry (% (heading (strong "Internal Format")))
+ (para (strong "Red")
+ ", "
+ (strong "Green")
+ ", "
+ (strong "Blue")
+ ", "
+ (strong "Alpha")
+ ", "
+ (strong "Luminance")
+ ", "
+ (strong "Intensity")))
+ (entry (% (heading (code "GL_ALPHA")))
+ (para ", " ", " ", " "
+A " ", " ", "))
+ (entry (% (heading (code "GL_LUMINANCE")))
+ (para ", " ", " ", " ", " "
+R " ", "))
+ (entry (% (heading (code "GL_LUMINANCE_ALPHA")))
+ (para ", " ", " ", " "
+A " ", " "
+R " ", "))
+ (entry (% (heading (code "GL_INTENSITY")))
+ (para ", " ", " ", " ", " ", " "
+R "))
+ (entry (% (heading (code "GL_RGB")))
+ (para "
+R " ", " "
+G " ", " "
+B " ", " ", " ", "))
+ (entry (% (heading (code "GL_RGBA")))
+ (para "
+R "
+ ", "
+ "
+G "
+ ", "
+ "
+B "
+ ", "
+ "
+A "
+ ", "
+ ", ")))
+ (para "
+The red, green, blue, alpha, luminance, and/or intensity components of
+ the resulting pixels are stored in floating-point rather than integer
+ format.
+ They form a one-dimensional filter kernel image indexed with coordinate "
+ (var "i")
+ " such that "
+ (var "i")
+ " starts at 0 and increases from left to right.
+ Kernel location "
+ (var "i")
+ " is derived from the "
+ (var "i")
+ "th pixel, counting from 0. ")
+ (para "
+Note that after a convolution is performed, the resulting color
+ components are also scaled by their corresponding "
+ (code "GL_POST_CONVOLUTION_c_SCALE")
+ " parameters and biased by their
+ corresponding "
+ (code "GL_POST_CONVOLUTION_c_BIAS")
+ " parameters (where "
+ (var "c")
+ " takes on the values "
+ (strong "RED")
+ ", "
+ (strong "GREEN")
+ ", "
+ (strong "BLUE")
+ ", and "
+ (strong "ALPHA")
+ ").
+ These parameters are set by "
+ (code "glPixelTransfer")
+ ". ")
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "target")
+ " is not "
+ (code "GL_CONVOLUTION_1D")
+ ". ")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "internalformat")
+ " is not one of the
+ allowable values. ")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "format")
+ " is not one of the allowable
+ values. ")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "type")
+ " is not one of the allowable
+ values. ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "width")
+ " is less than zero or greater
+ than the maximum supported value.
+ This value may be queried with "
+ (code "glGetConvolutionParameter")
+ "
+using target "
+ (code "GL_CONVOLUTION_1D")
+ " and name "
+ (code "GL_MAX_CONVOLUTION_WIDTH")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (var "format")
+ " is one of "
+ (code "GL_UNSIGNED_BYTE_3_3_2")
+ ", "
+ (code "GL_UNSIGNED_BYTE_2_3_3_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_6_5")
+ ", or "
+ (code "GL_UNSIGNED_SHORT_5_6_5_REV")
+ "
+and "
+ (var "type")
+ " is not "
+ (code "GL_RGB")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (var "format")
+ " is one of "
+ (code "GL_UNSIGNED_SHORT_4_4_4_4")
+ ", "
+ (code "GL_UNSIGNED_SHORT_4_4_4_4_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_5_5_1")
+ ", "
+ (code "GL_UNSIGNED_SHORT_1_5_5_5_REV")
+ ", "
+ (code "GL_UNSIGNED_INT_8_8_8_8")
+ ", "
+ (code "GL_UNSIGNED_INT_8_8_8_8_REV")
+ ", "
+ (code "GL_UNSIGNED_INT_10_10_10_2")
+ ", or "
+ (code "GL_UNSIGNED_INT_2_10_10_10_REV")
+ "
+and "
+ (var "type")
+ " is neither "
+ (code "GL_RGBA")
+ " nor "
+ (code "GL_BGRA")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a non-zero buffer object name is bound to the "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ " target and the buffer object's data store is currently mapped. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a non-zero buffer object name is bound to the "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ " target and the data would be unpacked from the buffer
+ object such that the memory reads required would exceed the data store size. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a non-zero buffer object name is bound to the "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ " target and "
+ (var "data")
+ " is not evenly divisible
+ into the number of bytes needed to store in memory a datum indicated by "
+ (var "type")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glConvolutionFilter1D")
+ " is executed
+ between the execution of "
+ (code "glBegin")
+ " and the corresponding
+ execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glConvolutionFilter2D
+ "glConvolutionFilter2D"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "void "
+ (function "glConvolutionFilter2D"))
+ (paramdef "GLenum " (parameter "target"))
+ (paramdef "GLenum " (parameter "internalformat"))
+ (paramdef "GLsizei " (parameter "width"))
+ (paramdef "GLsizei " (parameter "height"))
+ (paramdef "GLenum " (parameter "format"))
+ (paramdef "GLenum " (parameter "type"))
+ (paramdef "const GLvoid * " (parameter "data"))))
+ '(*fragment*
+ (heading
+ "define a two-dimensional convolution filter")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "target")))
+ (para "
+Must be "
+ (code "GL_CONVOLUTION_2D")
+ ". "))
+ (entry (% (heading (var "internalformat")))
+ (para "
+The internal format of the convolution filter kernel.
+ The allowable values are "
+ (code "GL_ALPHA")
+ ", "
+ (code "GL_ALPHA4")
+ ", "
+ (code "GL_ALPHA8")
+ ", "
+ (code "GL_ALPHA12")
+ ", "
+ (code "GL_ALPHA16")
+ ", "
+ (code "GL_LUMINANCE")
+ ", "
+ (code "GL_LUMINANCE4")
+ ", "
+ (code "GL_LUMINANCE8")
+ ", "
+ (code "GL_LUMINANCE12")
+ ", "
+ (code "GL_LUMINANCE16")
+ ", "
+ (code "GL_LUMINANCE_ALPHA")
+ ", "
+ (code "GL_LUMINANCE4_ALPHA4")
+ ", "
+ (code "GL_LUMINANCE6_ALPHA2")
+ ", "
+ (code "GL_LUMINANCE8_ALPHA8")
+ ", "
+ (code "GL_LUMINANCE12_ALPHA4")
+ ", "
+ (code "GL_LUMINANCE12_ALPHA12")
+ ", "
+ (code "GL_LUMINANCE16_ALPHA16")
+ ", "
+ (code "GL_INTENSITY")
+ ", "
+ (code "GL_INTENSITY4")
+ ", "
+ (code "GL_INTENSITY8")
+ ", "
+ (code "GL_INTENSITY12")
+ ", "
+ (code "GL_INTENSITY16")
+ ", "
+ (code "GL_R3_G3_B2")
+ ", "
+ (code "GL_RGB")
+ ", "
+ (code "GL_RGB4")
+ ", "
+ (code "GL_RGB5")
+ ", "
+ (code "GL_RGB8")
+ ", "
+ (code "GL_RGB10")
+ ", "
+ (code "GL_RGB12")
+ ", "
+ (code "GL_RGB16")
+ ", "
+ (code "GL_RGBA")
+ ", "
+ (code "GL_RGBA2")
+ ", "
+ (code "GL_RGBA4")
+ ", "
+ (code "GL_RGB5_A1")
+ ", "
+ (code "GL_RGBA8")
+ ", "
+ (code "GL_RGB10_A2")
+ ", "
+ (code "GL_RGBA12")
+ ", or "
+ (code "GL_RGBA16")
+ ". "))
+ (entry (% (heading (var "width")))
+ (para "
+The width of the pixel array referenced by "
+ (var "data")
+ ". "))
+ (entry (% (heading (var "height")))
+ (para "
+The height of the pixel array referenced by "
+ (var "data")
+ ". "))
+ (entry (% (heading (var "format")))
+ (para "
+The format of the pixel data in "
+ (var "data")
+ ".
+ The allowable values are "
+ (code "GL_RED")
+ ", "
+ (code "GL_GREEN")
+ ", "
+ (code "GL_BLUE")
+ ", "
+ (code "GL_ALPHA")
+ ", "
+ (code "GL_RGB")
+ ", "
+ (code "GL_BGR")
+ ", "
+ (code "GL_RGBA")
+ ", "
+ (code "GL_BGRA")
+ ", "
+ (code "GL_LUMINANCE")
+ ", and "
+ (code "GL_LUMINANCE_ALPHA")
+ ". "))
+ (entry (% (heading (var "type")))
+ (para "
+The type of the pixel data in "
+ (var "data")
+ ".
+ Symbolic constants "
+ (code "GL_UNSIGNED_BYTE")
+ ", "
+ (code "GL_BYTE")
+ ", "
+ (code "GL_BITMAP")
+ ", "
+ (code "GL_UNSIGNED_SHORT")
+ ", "
+ (code "GL_SHORT")
+ ", "
+ (code "GL_UNSIGNED_INT")
+ ", "
+ (code "GL_INT")
+ ", "
+ (code "GL_FLOAT")
+ ", "
+ (code "GL_UNSIGNED_BYTE_3_3_2")
+ ", "
+ (code "GL_UNSIGNED_BYTE_2_3_3_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_6_5")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_6_5_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_4_4_4_4")
+ ", "
+ (code "GL_UNSIGNED_SHORT_4_4_4_4_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_5_5_1")
+ ", "
+ (code "GL_UNSIGNED_SHORT_1_5_5_5_REV")
+ ", "
+ (code "GL_UNSIGNED_INT_8_8_8_8")
+ ", "
+ (code "GL_UNSIGNED_INT_8_8_8_8_REV")
+ ", "
+ (code "GL_UNSIGNED_INT_10_10_10_2")
+ ", and "
+ (code "GL_UNSIGNED_INT_2_10_10_10_REV")
+ "
+are accepted. "))
+ (entry (% (heading (var "data")))
+ (para "
+Pointer to a two-dimensional array of pixel data that is processed to
+ build the convolution filter kernel. ")))
+ (heading "Description")
+ (para (code "glConvolutionFilter2D")
+ " builds a two-dimensional convolution filter kernel from an array of
+ pixels. ")
+ (para "
+The pixel array specified by "
+ (var "width")
+ ", "
+ (var "height")
+ ", "
+ (var "format")
+ ", "
+ (var "type")
+ ", and "
+ (var "data")
+ " is extracted from memory and processed just as if "
+ (code "glDrawPixels")
+ " were called, but processing stops after the final
+ expansion to RGBA is completed. ")
+ (para "
+If a non-zero named buffer object is bound to the "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ " target
+ (see "
+ (code "glBindBuffer")
+ ") while a convolution filter is
+ specified, "
+ (var "data")
+ " is treated as a byte offset into the buffer object's data store. ")
+ (para "
+The R, G, B, and A components of each pixel are next scaled by the four
+ 2D "
+ (code "GL_CONVOLUTION_FILTER_SCALE")
+ " parameters and biased by the
+ four 2D "
+ (code "GL_CONVOLUTION_FILTER_BIAS")
+ " parameters.
+ (The scale and bias parameters are set by "
+ (code "glConvolutionParameter")
+ "
+using the "
+ (code "GL_CONVOLUTION_2D")
+ " target and the names "
+ (code "GL_CONVOLUTION_FILTER_SCALE")
+ " and "
+ (code "GL_CONVOLUTION_FILTER_BIAS")
+ ".
+ The parameters themselves are vectors of four values that are applied to red,
+ green, blue, and alpha, in that order.)
+ The R, G, B, and A values are not clamped to [0,1] at any time during this
+ process. ")
+ (para "
+Each pixel is then converted to the internal format specified by "
+ (var "internalformat")
+ ".
+ This conversion simply maps the component values of the pixel (R, G, B,
+ and A) to the values included in the internal format (red, green, blue,
+ alpha, luminance, and intensity). The mapping is as follows: ")
+ (para)
+ (table (% (formatter (asis)))
+ (entry (% (heading (strong "Internal Format")))
+ (para (strong "Red")
+ ", "
+ (strong "Green")
+ ", "
+ (strong "Blue")
+ ", "
+ (strong "Alpha")
+ ", "
+ (strong "Luminance")
+ ", "
+ (strong "Intensity")))
+ (entry (% (heading (code "GL_ALPHA")))
+ (para ", " ", " ", " "
+A " ", " ", "))
+ (entry (% (heading (code "GL_LUMINANCE")))
+ (para ", " ", " ", " ", " "
+R " ", "))
+ (entry (% (heading (code "GL_LUMINANCE_ALPHA")))
+ (para ", " ", " ", " "
+A " ", " "
+R " ", "))
+ (entry (% (heading (code "GL_INTENSITY")))
+ (para ", " ", " ", " ", " ", " "
+R "))
+ (entry (% (heading (code "GL_RGB")))
+ (para "
+R " ", " "
+G " ", " "
+B " ", " ", " ", "))
+ (entry (% (heading (code "GL_RGBA")))
+ (para "
+R "
+ ", "
+ "
+G "
+ ", "
+ "
+B "
+ ", "
+ "
+A "
+ ", "
+ ", ")))
+ (para "
+The red, green, blue, alpha, luminance, and/or intensity components of
+ the resulting pixels are stored in floating-point rather than integer
+ format.
+ They form a two-dimensional filter kernel image indexed with coordinates "
+ (var "i")
+ " and "
+ (var "j")
+ " such that "
+ (var "i")
+ " starts at zero and increases from left
+ to right, and "
+ (var "j")
+ " starts at zero and increases from bottom to top.
+ Kernel location "
+ (var "i,j")
+ " is derived from the "
+ (var "N")
+ "th pixel,
+ where "
+ (var "N")
+ " is "
+ (var "i")
+ "+"
+ (var "j")
+ "*"
+ (var "width")
+ ". ")
+ (para "
+Note that after a convolution is performed, the resulting color
+ components are also scaled by their corresponding "
+ (code "GL_POST_CONVOLUTION_c_SCALE")
+ " parameters and biased by their
+ corresponding "
+ (code "GL_POST_CONVOLUTION_c_BIAS")
+ " parameters (where "
+ (var "c")
+ " takes on the values "
+ (strong "RED")
+ ", "
+ (strong "GREEN")
+ ", "
+ (strong "BLUE")
+ ", and "
+ (strong "ALPHA")
+ ").
+ These parameters are set by "
+ (code "glPixelTransfer")
+ ". ")
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "target")
+ " is not "
+ (code "GL_CONVOLUTION_2D")
+ ". ")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "internalformat")
+ " is not one of the
+ allowable values. ")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "format")
+ " is not one of the allowable
+ values. ")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "type")
+ " is not one of the allowable
+ values. ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "width")
+ " is less than zero or greater
+ than the maximum supported value.
+ This value may be queried with "
+ (code "glGetConvolutionParameter")
+ "
+using target "
+ (code "GL_CONVOLUTION_2D")
+ " and name "
+ (code "GL_MAX_CONVOLUTION_WIDTH")
+ ". ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "height")
+ " is less than zero or greater
+ than the maximum supported value.
+ This value may be queried with "
+ (code "glGetConvolutionParameter")
+ "
+using target "
+ (code "GL_CONVOLUTION_2D")
+ " and name "
+ (code "GL_MAX_CONVOLUTION_HEIGHT")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (var "height")
+ " is one of "
+ (code "GL_UNSIGNED_BYTE_3_3_2")
+ ", "
+ (code "GL_UNSIGNED_BYTE_2_3_3_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_6_5")
+ ", or "
+ (code "GL_UNSIGNED_SHORT_5_6_5_REV")
+ "
+and "
+ (var "format")
+ " is not "
+ (code "GL_RGB")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (var "height")
+ " is one of "
+ (code "GL_UNSIGNED_SHORT_4_4_4_4")
+ ", "
+ (code "GL_UNSIGNED_SHORT_4_4_4_4_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_5_5_1")
+ ", "
+ (code "GL_UNSIGNED_SHORT_1_5_5_5_REV")
+ ", "
+ (code "GL_UNSIGNED_INT_8_8_8_8")
+ ", "
+ (code "GL_UNSIGNED_INT_8_8_8_8_REV")
+ ", "
+ (code "GL_UNSIGNED_INT_10_10_10_2")
+ ", or "
+ (code "GL_UNSIGNED_INT_2_10_10_10_REV")
+ "
+and "
+ (var "format")
+ " is neither "
+ (code "GL_RGBA")
+ " nor "
+ (code "GL_BGRA")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a non-zero buffer object name is bound to the "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ " target and the buffer object's data store is currently mapped. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a non-zero buffer object name is bound to the "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ " target and the data would be unpacked from the buffer
+ object such that the memory reads required would exceed the data store size. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a non-zero buffer object name is bound to the "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ " target and "
+ (var "data")
+ " is not evenly divisible
+ into the number of bytes needed to store in memory a datum indicated by "
+ (var "type")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glConvolutionFilter2D")
+ " is executed
+ between the execution of "
+ (code "glBegin")
+ " and the corresponding
+ execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glConvolutionParameter
+ "glConvolutionParameter"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "void "
+ (function "glConvolutionParameterf"))
+ (paramdef "GLenum " (parameter "target"))
+ (paramdef "GLenum " (parameter "pname"))
+ (paramdef "GLfloat " (parameter "params"))))
+ '(*fragment*
+ (heading "set convolution parameters")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "target")))
+ (para "
+The target for the convolution parameter.
+ Must be one of "
+ (code "GL_CONVOLUTION_1D")
+ ", "
+ (code "GL_CONVOLUTION_2D")
+ ", or "
+ (code "GL_SEPARABLE_2D")
+ ". "))
+ (entry (% (heading (var "pname")))
+ (para "
+The parameter to be set.
+ Must be "
+ (code "GL_CONVOLUTION_BORDER_MODE")
+ ". "))
+ (entry (% (heading (var "params")))
+ (para "
+The parameter value.
+ Must be one of "
+ (code "GL_REDUCE")
+ ", "
+ (code "GL_CONSTANT_BORDER")
+ ", "
+ (code "GL_REPLICATE_BORDER")
+ ". ")
+ (para)))
+ (heading "Description")
+ (para (code "glConvolutionParameter")
+ " sets the value of a convolution parameter. ")
+ (para (var "target")
+ " selects the convolution filter to be affected: "
+ (code "GL_CONVOLUTION_1D")
+ ", "
+ (code "GL_CONVOLUTION_2D")
+ ", or "
+ (code "GL_SEPARABLE_2D")
+ "
+for the 1D, 2D, or separable 2D filter, respectively. ")
+ (para (var "pname")
+ " selects the parameter to be changed. "
+ (code "GL_CONVOLUTION_FILTER_SCALE")
+ " and "
+ (code "GL_CONVOLUTION_FILTER_BIAS")
+ "
+affect the definition of the convolution filter kernel; see "
+ (code "glConvolutionFilter1D")
+ ", "
+ (code "glConvolutionFilter2D")
+ ", and "
+ (code "glSeparableFilter2D")
+ " for details.
+ In these cases, "
+ (var "params")
+ "v is an array of four values to be applied to
+ red, green, blue, and alpha values, respectively. The initial value for "
+ (code "GL_CONVOLUTION_FILTER_SCALE")
+ " is (1, 1, 1, 1), and the initial value
+ for "
+ (code "GL_CONVOLUTION_FILTER_BIAS")
+ " is (0, 0, 0, 0). ")
+ (para "
+A "
+ (var "pname")
+ " value of "
+ (code "GL_CONVOLUTION_BORDER_MODE")
+ " controls the
+ convolution border mode. The accepted modes are: ")
+ (table (% (formatter (asis)))
+ (entry (% (heading (code "GL_REDUCE")))
+ (para "
+The image resulting from convolution is
+ smaller than the source image.
+ If the filter width is "
+ (math (var "Wf"))
+ "
+and height is "
+ (math (var "Hf"))
+ ",
+ and the source image width is "
+ (math (var "Ws"))
+ "
+and height is "
+ (math (var "Hs"))
+ ",
+ then the convolved image width will be "
+ (math (var "Ws") "-" (var "Wf") "+" "1")
+ "
+and height
+ will be "
+ (math (var "Hs") "-" (var "Hf") "+" "1")
+ ".
+ (If this reduction would generate an image with zero or negative width
+ and/or height, the output is simply null, with no error generated.)
+ The coordinates of the image resulting from convolution are zero
+ through "
+ (math (var "Ws") "-" (var "Wf"))
+ "
+in width and zero through "
+ (math (var "Hs") "-" (var "Hf"))
+ "
+in
+ height. "))
+ (entry (% (heading (code "GL_CONSTANT_BORDER")))
+ (para "
+The image resulting from convolution is the same size as the source image, and
+ processed as if the source image were surrounded by pixels with their color
+ specified by the "
+ (code "GL_CONVOLUTION_BORDER_COLOR")
+ ". "))
+ (entry (% (heading (code "GL_REPLICATE_BORDER")))
+ (para "
+The image resulting from convolution is the same size as the source image, and
+ processed as if the outermost pixel on the border of the source image were
+ replicated. ")))
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "target")
+ " is not one of the allowable
+ values. ")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "pname")
+ " is not one of the allowable
+ values. ")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "pname")
+ " is "
+ (code "GL_CONVOLUTION_BORDER_MODE")
+ " and "
+ (var "params")
+ " is not one of "
+ (code "GL_REDUCE")
+ ", "
+ (code "GL_CONSTANT_BORDER")
+ ", or "
+ (code "GL_REPLICATE_BORDER")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glConvolutionParameter")
+ " is executed
+ between the execution of "
+ (code "glBegin")
+ " and the corresponding
+ execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glCopyColorSubTable
+ "glCopyColorSubTable"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "void "
+ (function "glCopyColorSubTable"))
+ (paramdef "GLenum " (parameter "target"))
+ (paramdef "GLsizei " (parameter "start"))
+ (paramdef "GLint " (parameter "x"))
+ (paramdef "GLint " (parameter "y"))
+ (paramdef "GLsizei " (parameter "width"))))
+ '(*fragment*
+ (heading "respecify a portion of a color table")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "target")))
+ (para "
+Must be one of "
+ (code "GL_COLOR_TABLE")
+ ", "
+ (code "GL_POST_CONVOLUTION_COLOR_TABLE")
+ ", or "
+ (code "GL_POST_COLOR_MATRIX_COLOR_TABLE")
+ ". "))
+ (entry (% (heading (var "start")))
+ (para "
+The starting index of the portion of the color table to be replaced. "))
+ (entry (% (heading (var "x")))
+ (itemx (var "y"))
+ (para "
+The window coordinates of the left corner of the row of pixels to be
+ copied. "))
+ (entry (% (heading (var "width")))
+ (para "
+The number of table entries to replace. ")))
+ (heading "Description")
+ (para (code "glCopyColorSubTable")
+ " is used to respecify a contiguous portion of a color table previously
+ defined using "
+ (code "glColorTable")
+ ". The pixels copied from the framebuffer
+ replace the portion of the existing table from indices "
+ (var "start")
+ " to "
+ (math (var "start") "+" (var "x") "-" "1")
+ ",
+ inclusive. This region may not include any
+ entries outside the range of the color table, as was originally specified.
+ It is not an error to specify a subtexture with width of 0, but such a
+ specification has no effect. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "target")
+ " is not a previously defined
+ color table. ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "target")
+ " is not one of the allowable
+ values. ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (math (var "start")
+ "+"
+ (var "x")
+ ">"
+ (var "width"))
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glCopyColorSubTable")
+ " is executed
+ between the execution of "
+ (code "glBegin")
+ " and the corresponding
+ execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glCopyColorTable
+ "glCopyColorTable"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glCopyColorTable"))
+ (paramdef "GLenum " (parameter "target"))
+ (paramdef "GLenum " (parameter "internalformat"))
+ (paramdef "GLint " (parameter "x"))
+ (paramdef "GLint " (parameter "y"))
+ (paramdef "GLsizei " (parameter "width"))))
+ '(*fragment*
+ (heading "copy pixels into a color table")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "target")))
+ (para "
+The color table target. Must be "
+ (code "GL_COLOR_TABLE")
+ ", "
+ (code "GL_POST_CONVOLUTION_COLOR_TABLE")
+ ",
+ or "
+ (code "GL_POST_COLOR_MATRIX_COLOR_TABLE")
+ ". "))
+ (entry (% (heading (var "internalformat")))
+ (para "
+The internal storage format of the texture image.
+ Must be one of the following symbolic constants: "
+ (code "GL_ALPHA")
+ ", "
+ (code "GL_ALPHA4")
+ ", "
+ (code "GL_ALPHA8")
+ ", "
+ (code "GL_ALPHA12")
+ ", "
+ (code "GL_ALPHA16")
+ ", "
+ (code "GL_LUMINANCE")
+ ", "
+ (code "GL_LUMINANCE4")
+ ", "
+ (code "GL_LUMINANCE8")
+ ", "
+ (code "GL_LUMINANCE12")
+ ", "
+ (code "GL_LUMINANCE16")
+ ", "
+ (code "GL_LUMINANCE_ALPHA")
+ ", "
+ (code "GL_LUMINANCE4_ALPHA4")
+ ", "
+ (code "GL_LUMINANCE6_ALPHA2")
+ ", "
+ (code "GL_LUMINANCE8_ALPHA8")
+ ", "
+ (code "GL_LUMINANCE12_ALPHA4")
+ ", "
+ (code "GL_LUMINANCE12_ALPHA12")
+ ", "
+ (code "GL_LUMINANCE16_ALPHA16")
+ ", "
+ (code "GL_INTENSITY")
+ ", "
+ (code "GL_INTENSITY4")
+ ", "
+ (code "GL_INTENSITY8")
+ ", "
+ (code "GL_INTENSITY12")
+ ", "
+ (code "GL_INTENSITY16")
+ ", "
+ (code "GL_R3_G3_B2")
+ ", "
+ (code "GL_RGB")
+ ", "
+ (code "GL_RGB4")
+ ", "
+ (code "GL_RGB5")
+ ", "
+ (code "GL_RGB8")
+ ", "
+ (code "GL_RGB10")
+ ", "
+ (code "GL_RGB12")
+ ", "
+ (code "GL_RGB16")
+ ", "
+ (code "GL_RGBA")
+ ", "
+ (code "GL_RGBA2")
+ ", "
+ (code "GL_RGBA4")
+ ", "
+ (code "GL_RGB5_A1")
+ ", "
+ (code "GL_RGBA8")
+ ", "
+ (code "GL_RGB10_A2")
+ ", "
+ (code "GL_RGBA12")
+ ", or "
+ (code "GL_RGBA16")
+ ". "))
+ (entry (% (heading (var "x")))
+ (para "
+The x coordinate of the lower-left corner of the pixel rectangle
+ to be transferred to the color table. "))
+ (entry (% (heading (var "y")))
+ (para "
+The y coordinate of the lower-left corner of the pixel rectangle
+ to be transferred to the color table. "))
+ (entry (% (heading (var "width")))
+ (para "
+The width of the pixel rectangle. ")))
+ (heading "Description")
+ (para (code "glCopyColorTable")
+ " loads a color table with pixels from the current "
+ (code "GL_READ_BUFFER")
+ " (rather than from main memory, as is the case for "
+ (code "glColorTable")
+ "). ")
+ (para "
+The screen-aligned pixel rectangle with lower-left corner at ("
+ (var "x")
+ ",\\ "
+ (var "y")
+ ")
+ having width "
+ (var "width")
+ " and height 1
+ is loaded into the color table. If any pixels within
+ this region are outside the window that is associated with the GL
+ context, the values obtained for those pixels are undefined. ")
+ (para "
+The pixels in the rectangle are processed just as if "
+ (code "glReadPixels")
+ " were called, with "
+ (var "internalformat")
+ " set to RGBA,
+ but processing stops after the final conversion to RGBA. ")
+ (para "
+The four scale parameters and the four bias parameters that are defined
+ for the table are then used to scale and bias the R, G, B, and A components
+ of each pixel. The scale and bias parameters are set by calling "
+ (code "glColorTableParameter")
+ ". ")
+ (para "
+Next, the R, G, B, and A values are clamped to the range "
+ (math "[" "0" "," "1" "]")
+ ".
+ Each pixel is then converted to the internal format specified by "
+ (var "internalformat")
+ ". This conversion simply maps the component values of the pixel (R, G, B,
+ and A) to the values included in the internal format (red, green, blue,
+ alpha, luminance, and intensity). The mapping is as follows: ")
+ (para)
+ (table (% (formatter (asis)))
+ (entry (% (heading (strong "Internal Format")))
+ (para (strong "Red")
+ ", "
+ (strong "Green")
+ ", "
+ (strong "Blue")
+ ", "
+ (strong "Alpha")
+ ", "
+ (strong "Luminance")
+ ", "
+ (strong "Intensity")))
+ (entry (% (heading (code "GL_ALPHA")))
+ (para ", " ", " ", " "
+A " ", " ", "))
+ (entry (% (heading (code "GL_LUMINANCE")))
+ (para ", " ", " ", " ", " "
+R " ", "))
+ (entry (% (heading (code "GL_LUMINANCE_ALPHA")))
+ (para ", " ", " ", " "
+A " ", " "
+R " ", "))
+ (entry (% (heading (code "GL_INTENSITY")))
+ (para ", " ", " ", " ", " ", " "
+R "))
+ (entry (% (heading (code "GL_RGB")))
+ (para "
+R " ", " "
+G " ", " "
+B " ", " ", " ", "))
+ (entry (% (heading (code "GL_RGBA")))
+ (para "
+R "
+ ", "
+ "
+G "
+ ", "
+ "
+B "
+ ", "
+ "
+A "
+ ", "
+ ", ")))
+ (para "
+Finally, the red, green, blue, alpha, luminance, and/or intensity components of
+ the resulting pixels are stored in the color table.
+ They form a one-dimensional table with indices in the range "
+ (math "[" "0" "," (var "width") "-" "1" "]")
+ ". ")
+ (para)
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated when "
+ (var "target")
+ " is not one of the
+ allowable values. ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "width")
+ " is less than zero. ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "internalformat")
+ " is not one of the
+ allowable values. ")
+ (para (code "GL_TABLE_TOO_LARGE")
+ " is generated if the requested color table
+ is too large to be supported by the implementation. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glCopyColorTable")
+ " is executed
+ between the execution of "
+ (code "glBegin")
+ " and the corresponding
+ execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glCopyConvolutionFilter1D
+ "glCopyConvolutionFilter1D"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "void "
+ (function "glCopyConvolutionFilter1D"))
+ (paramdef "GLenum " (parameter "target"))
+ (paramdef "GLenum " (parameter "internalformat"))
+ (paramdef "GLint " (parameter "x"))
+ (paramdef "GLint " (parameter "y"))
+ (paramdef "GLsizei " (parameter "width"))))
+ '(*fragment*
+ (heading
+ "copy pixels into a one-dimensional convolution filter")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "target")))
+ (para "
+Must be "
+ (code "GL_CONVOLUTION_1D")
+ ". "))
+ (entry (% (heading (var "internalformat")))
+ (para "
+The internal format of the convolution filter kernel.
+ The allowable values are "
+ (code "GL_ALPHA")
+ ", "
+ (code "GL_ALPHA4")
+ ", "
+ (code "GL_ALPHA8")
+ ", "
+ (code "GL_ALPHA12")
+ ", "
+ (code "GL_ALPHA16")
+ ", "
+ (code "GL_LUMINANCE")
+ ", "
+ (code "GL_LUMINANCE4")
+ ", "
+ (code "GL_LUMINANCE8")
+ ", "
+ (code "GL_LUMINANCE12")
+ ", "
+ (code "GL_LUMINANCE16")
+ ", "
+ (code "GL_LUMINANCE_ALPHA")
+ ", "
+ (code "GL_LUMINANCE4_ALPHA4")
+ ", "
+ (code "GL_LUMINANCE6_ALPHA2")
+ ", "
+ (code "GL_LUMINANCE8_ALPHA8")
+ ", "
+ (code "GL_LUMINANCE12_ALPHA4")
+ ", "
+ (code "GL_LUMINANCE12_ALPHA12")
+ ", "
+ (code "GL_LUMINANCE16_ALPHA16")
+ ", "
+ (code "GL_INTENSITY")
+ ", "
+ (code "GL_INTENSITY4")
+ ", "
+ (code "GL_INTENSITY8")
+ ", "
+ (code "GL_INTENSITY12")
+ ", "
+ (code "GL_INTENSITY16")
+ ", "
+ (code "GL_R3_G3_B2")
+ ", "
+ (code "GL_RGB")
+ ", "
+ (code "GL_RGB4")
+ ", "
+ (code "GL_RGB5")
+ ", "
+ (code "GL_RGB8")
+ ", "
+ (code "GL_RGB10")
+ ", "
+ (code "GL_RGB12")
+ ", "
+ (code "GL_RGB16")
+ ", "
+ (code "GL_RGBA")
+ ", "
+ (code "GL_RGBA2")
+ ", "
+ (code "GL_RGBA4")
+ ", "
+ (code "GL_RGB5_A1")
+ ", "
+ (code "GL_RGBA8")
+ ", "
+ (code "GL_RGB10_A2")
+ ", "
+ (code "GL_RGBA12")
+ ", or "
+ (code "GL_RGBA16")
+ ". "))
+ (entry (% (heading (var "x")))
+ (itemx (var "y"))
+ (para "
+The window space coordinates of the lower-left coordinate of the
+ pixel array to copy. "))
+ (entry (% (heading (var "width")))
+ (para "
+The width of the pixel array to copy. ")))
+ (heading "Description")
+ (para (code "glCopyConvolutionFilter1D")
+ " defines a one-dimensional convolution filter kernel with pixels
+ from the current "
+ (code "GL_READ_BUFFER")
+ " (rather than from main memory,
+ as is the case for "
+ (code "glConvolutionFilter1D")
+ "). ")
+ (para "
+The screen-aligned pixel rectangle with lower-left corner at ("
+ (var "x")
+ ",\\ "
+ (var "y")
+ "),
+ width "
+ (var "width")
+ " and height 1 is used to define
+ the convolution filter. If any pixels within this region are
+ outside the window that is associated with the GL context, the
+ values obtained for those pixels are undefined. ")
+ (para "
+The pixels in the rectangle are processed exactly as if "
+ (code "glReadPixels")
+ "
+had been called with "
+ (var "format")
+ "
+set to RGBA, but the process stops just before final conversion.
+ The R, G, B, and A components of each pixel are next scaled by the four
+ 1D "
+ (code "GL_CONVOLUTION_FILTER_SCALE")
+ " parameters and biased by the
+ four 1D "
+ (code "GL_CONVOLUTION_FILTER_BIAS")
+ " parameters.
+ (The scale and bias parameters are set by "
+ (code "glConvolutionParameter")
+ "
+using the "
+ (code "GL_CONVOLUTION_1D")
+ " target and the names "
+ (code "GL_CONVOLUTION_FILTER_SCALE")
+ " and "
+ (code "GL_CONVOLUTION_FILTER_BIAS")
+ ".
+ The parameters themselves are vectors of four values that are applied to red,
+ green, blue, and alpha, in that order.)
+ The R, G, B, and A values are not clamped to [0,1] at any time during this
+ process. ")
+ (para "
+Each pixel is then converted to the internal format specified by "
+ (var "internalformat")
+ ".
+ This conversion simply maps the component values of the pixel (R, G, B,
+ and A) to the values included in the internal format (red, green, blue,
+ alpha, luminance, and intensity). The mapping is as follows: ")
+ (para)
+ (table (% (formatter (asis)))
+ (entry (% (heading (strong "Internal Format")))
+ (para (strong "Red")
+ ", "
+ (strong "Green")
+ ", "
+ (strong "Blue")
+ ", "
+ (strong "Alpha")
+ ", "
+ (strong "Luminance")
+ ", "
+ (strong "Intensity")))
+ (entry (% (heading (code "GL_ALPHA")))
+ (para ", " ", " ", " "
+A " ", " ", "))
+ (entry (% (heading (code "GL_LUMINANCE")))
+ (para ", " ", " ", " ", " "
+R " ", "))
+ (entry (% (heading (code "GL_LUMINANCE_ALPHA")))
+ (para ", " ", " ", " "
+A " ", " "
+R " ", "))
+ (entry (% (heading (code "GL_INTENSITY")))
+ (para ", " ", " ", " ", " ", " "
+R "))
+ (entry (% (heading (code "GL_RGB")))
+ (para "
+R " ", " "
+G " ", " "
+B " ", " ", " ", "))
+ (entry (% (heading (code "GL_RGBA")))
+ (para "
+R "
+ ", "
+ "
+G "
+ ", "
+ "
+B "
+ ", "
+ "
+A "
+ ", "
+ ", ")))
+ (para "
+The red, green, blue, alpha, luminance, and/or intensity components of
+ the resulting pixels are stored in floating-point rather than integer
+ format. ")
+ (para "
+Pixel ordering is such that lower x screen coordinates correspond to
+ lower "
+ (var "i")
+ " filter image coordinates. ")
+ (para "
+Note that after a convolution is performed, the resulting color
+ components are also scaled by their corresponding "
+ (code "GL_POST_CONVOLUTION_c_SCALE")
+ " parameters and biased by their
+ corresponding "
+ (code "GL_POST_CONVOLUTION_c_BIAS")
+ " parameters (where "
+ (var "c")
+ " takes on the values "
+ (strong "RED")
+ ", "
+ (strong "GREEN")
+ ", "
+ (strong "BLUE")
+ ", and "
+ (strong "ALPHA")
+ ").
+ These parameters are set by "
+ (code "glPixelTransfer")
+ ". ")
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "target")
+ " is not "
+ (code "GL_CONVOLUTION_1D")
+ ". ")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "internalformat")
+ " is not one of the
+ allowable values. ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "width")
+ " is less than zero or greater
+ than the maximum supported value.
+ This value may be queried with "
+ (code "glGetConvolutionParameter")
+ "
+using target "
+ (code "GL_CONVOLUTION_1D")
+ " and name "
+ (code "GL_MAX_CONVOLUTION_WIDTH")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glCopyConvolutionFilter1D")
+ " is executed
+ between the execution of "
+ (code "glBegin")
+ " and the corresponding
+ execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glCopyConvolutionFilter2D
+ "glCopyConvolutionFilter2D"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "void "
+ (function "glCopyConvolutionFilter2D"))
+ (paramdef "GLenum " (parameter "target"))
+ (paramdef "GLenum " (parameter "internalformat"))
+ (paramdef "GLint " (parameter "x"))
+ (paramdef "GLint " (parameter "y"))
+ (paramdef "GLsizei " (parameter "width"))
+ (paramdef "GLsizei " (parameter "height"))))
+ '(*fragment*
+ (heading
+ "copy pixels into a two-dimensional convolution filter")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "target")))
+ (para "
+Must be "
+ (code "GL_CONVOLUTION_2D")
+ ". "))
+ (entry (% (heading (var "internalformat")))
+ (para "
+The internal format of the convolution filter kernel.
+ The allowable values are "
+ (code "GL_ALPHA")
+ ", "
+ (code "GL_ALPHA4")
+ ", "
+ (code "GL_ALPHA8")
+ ", "
+ (code "GL_ALPHA12")
+ ", "
+ (code "GL_ALPHA16")
+ ", "
+ (code "GL_LUMINANCE")
+ ", "
+ (code "GL_LUMINANCE4")
+ ", "
+ (code "GL_LUMINANCE8")
+ ", "
+ (code "GL_LUMINANCE12")
+ ", "
+ (code "GL_LUMINANCE16")
+ ", "
+ (code "GL_LUMINANCE_ALPHA")
+ ", "
+ (code "GL_LUMINANCE4_ALPHA4")
+ ", "
+ (code "GL_LUMINANCE6_ALPHA2")
+ ", "
+ (code "GL_LUMINANCE8_ALPHA8")
+ ", "
+ (code "GL_LUMINANCE12_ALPHA4")
+ ", "
+ (code "GL_LUMINANCE12_ALPHA12")
+ ", "
+ (code "GL_LUMINANCE16_ALPHA16")
+ ", "
+ (code "GL_INTENSITY")
+ ", "
+ (code "GL_INTENSITY4")
+ ", "
+ (code "GL_INTENSITY8")
+ ", "
+ (code "GL_INTENSITY12")
+ ", "
+ (code "GL_INTENSITY16")
+ ", "
+ (code "GL_R3_G3_B2")
+ ", "
+ (code "GL_RGB")
+ ", "
+ (code "GL_RGB4")
+ ", "
+ (code "GL_RGB5")
+ ", "
+ (code "GL_RGB8")
+ ", "
+ (code "GL_RGB10")
+ ", "
+ (code "GL_RGB12")
+ ", "
+ (code "GL_RGB16")
+ ", "
+ (code "GL_RGBA")
+ ", "
+ (code "GL_RGBA2")
+ ", "
+ (code "GL_RGBA4")
+ ", "
+ (code "GL_RGB5_A1")
+ ", "
+ (code "GL_RGBA8")
+ ", "
+ (code "GL_RGB10_A2")
+ ", "
+ (code "GL_RGBA12")
+ ", or "
+ (code "GL_RGBA16")
+ ". "))
+ (entry (% (heading (var "x")))
+ (itemx (var "y"))
+ (para "
+The window space coordinates of the lower-left coordinate of the
+ pixel array to copy. "))
+ (entry (% (heading (var "width")))
+ (para "
+The width of the pixel array to copy. "))
+ (entry (% (heading (var "height")))
+ (para "
+The height of the pixel array to copy. ")))
+ (heading "Description")
+ (para (code "glCopyConvolutionFilter2D")
+ " defines a two-dimensional convolution filter kernel with pixels
+ from the current "
+ (code "GL_READ_BUFFER")
+ " (rather than from main memory,
+ as is the case for "
+ (code "glConvolutionFilter2D")
+ "). ")
+ (para "
+The screen-aligned pixel rectangle with lower-left corner at ("
+ (var "x")
+ ",\\ "
+ (var "y")
+ "),
+ width "
+ (var "width")
+ " and height "
+ (var "height")
+ "
+is used to define the convolution filter. If any pixels within this
+ region are
+ outside the window that is associated with the GL context, the
+ values obtained for those pixels are undefined. ")
+ (para "
+The pixels in the rectangle are processed
+ exactly as if "
+ (code "glReadPixels")
+ " had been called with "
+ (var "format")
+ "
+set to RGBA, but the process stops just before final conversion.
+ The R, G, B, and A components of each pixel are next scaled by the four
+ 2D "
+ (code "GL_CONVOLUTION_FILTER_SCALE")
+ " parameters and biased by the
+ four 2D "
+ (code "GL_CONVOLUTION_FILTER_BIAS")
+ " parameters.
+ (The scale and bias parameters are set by "
+ (code "glConvolutionParameter")
+ "
+using the "
+ (code "GL_CONVOLUTION_2D")
+ " target and the names "
+ (code "GL_CONVOLUTION_FILTER_SCALE")
+ " and "
+ (code "GL_CONVOLUTION_FILTER_BIAS")
+ ".
+ The parameters themselves are vectors of four values that are applied to red,
+ green, blue, and alpha, in that order.)
+ The R, G, B, and A values are not clamped to [0,1] at any time during this
+ process. ")
+ (para "
+Each pixel is then converted to the internal format specified by "
+ (var "internalformat")
+ ".
+ This conversion simply maps the component values of the pixel (R, G, B,
+ and A) to the values included in the internal format (red, green, blue,
+ alpha, luminance, and intensity). The mapping is as follows: ")
+ (para)
+ (table (% (formatter (asis)))
+ (entry (% (heading (strong "Internal Format")))
+ (para (strong "Red")
+ ", "
+ (strong "Green")
+ ", "
+ (strong "Blue")
+ ", "
+ (strong "Alpha")
+ ", "
+ (strong "Luminance")
+ ", "
+ (strong "Intensity")))
+ (entry (% (heading (code "GL_ALPHA")))
+ (para ", " ", " ", " "
+A " ", " ", "))
+ (entry (% (heading (code "GL_LUMINANCE")))
+ (para ", " ", " ", " ", " "
+R " ", "))
+ (entry (% (heading (code "GL_LUMINANCE_ALPHA")))
+ (para ", " ", " ", " "
+A " ", " "
+R " ", "))
+ (entry (% (heading (code "GL_INTENSITY")))
+ (para ", " ", " ", " ", " ", " "
+R "))
+ (entry (% (heading (code "GL_RGB")))
+ (para "
+R " ", " "
+G " ", " "
+B " ", " ", " ", "))
+ (entry (% (heading (code "GL_RGBA")))
+ (para "
+R "
+ ", "
+ "
+G "
+ ", "
+ "
+B "
+ ", "
+ "
+A "
+ ", "
+ ", ")))
+ (para "
+The red, green, blue, alpha, luminance, and/or intensity components of
+ the resulting pixels are stored in floating-point rather than integer
+ format. ")
+ (para "
+Pixel ordering is such that lower x screen coordinates correspond to
+ lower "
+ (var "i")
+ " filter image coordinates, and lower y screen coordinates
+ correspond to lower "
+ (var "j")
+ " filter image coordinates. ")
+ (para "
+Note that after a convolution is performed, the resulting color
+ components are also scaled by their corresponding "
+ (code "GL_POST_CONVOLUTION_c_SCALE")
+ " parameters and biased by their
+ corresponding "
+ (code "GL_POST_CONVOLUTION_c_BIAS")
+ " parameters (where "
+ (var "c")
+ " takes on the values "
+ (strong "RED")
+ ", "
+ (strong "GREEN")
+ ", "
+ (strong "BLUE")
+ ", and "
+ (strong "ALPHA")
+ ").
+ These parameters are set by "
+ (code "glPixelTransfer")
+ ". ")
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "target")
+ " is not "
+ (code "GL_CONVOLUTION_2D")
+ ". ")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "internalformat")
+ " is not one of the
+ allowable values. ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "width")
+ " is less than zero or greater
+ than the maximum supported value.
+ This value may be queried with "
+ (code "glGetConvolutionParameter")
+ "
+using target "
+ (code "GL_CONVOLUTION_2D")
+ " and name "
+ (code "GL_MAX_CONVOLUTION_WIDTH")
+ ". ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "height")
+ " is less than zero or greater
+ than the maximum supported value.
+ This value may be queried with "
+ (code "glGetConvolutionParameter")
+ "
+using target "
+ (code "GL_CONVOLUTION_2D")
+ " and name "
+ (code "GL_MAX_CONVOLUTION_HEIGHT")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glCopyConvolutionFilter2D")
+ " is executed
+ between the execution of "
+ (code "glBegin")
+ " and the corresponding
+ execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glCopyPixels
+ "glCopyPixels"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glCopyPixels"))
+ (paramdef "GLint " (parameter "x"))
+ (paramdef "GLint " (parameter "y"))
+ (paramdef "GLsizei " (parameter "width"))
+ (paramdef "GLsizei " (parameter "height"))
+ (paramdef "GLenum " (parameter "type"))))
+ '(*fragment*
+ (heading "copy pixels in the frame buffer")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "x")))
+ (itemx (var "y"))
+ (para "
+Specify the window coordinates of the lower left corner
+ of the rectangular region of pixels to be copied. "))
+ (entry (% (heading (var "width")))
+ (itemx (var "height"))
+ (para "
+Specify the dimensions of the rectangular region of pixels to be copied.
+ Both must be nonnegative. "))
+ (entry (% (heading (var "type")))
+ (para "
+Specifies whether color values,
+ depth values,
+ or stencil values are to be copied.
+ Symbolic constants "
+ (code "GL_COLOR")
+ ", "
+ (code "GL_DEPTH")
+ ",
+ and "
+ (code "GL_STENCIL")
+ " are accepted. ")))
+ (heading "Description")
+ (para (code "glCopyPixels")
+ " copies a screen-aligned rectangle of pixels
+ from the specified frame buffer location to a region relative to the
+ current raster position.
+ Its operation is well defined only if the entire pixel source region
+ is within the exposed portion of the window.
+ Results of copies from outside the window,
+ or from regions of the window that are not exposed,
+ are hardware dependent and undefined. ")
+ (para (var "x")
+ " and "
+ (var "y")
+ " specify the window coordinates of
+ the lower left corner of the rectangular region to be copied. "
+ (var "width")
+ " and "
+ (var "height")
+ " specify the dimensions of the
+ rectangular region to be copied.
+ Both "
+ (var "width")
+ " and "
+ (var "height")
+ " must not be negative. ")
+ (para "
+Several parameters control the processing of the pixel data
+ while it is being copied.
+ These parameters are set with three commands: "
+ (code "glPixelTransfer")
+ ", "
+ (code "glPixelMap")
+ ", and "
+ (code "glPixelZoom")
+ ".
+ This reference page describes the effects on "
+ (code "glCopyPixels")
+ " of most,
+ but not all, of the parameters specified by these three commands. ")
+ (para (code "glCopyPixels")
+ " copies values from each pixel with the lower left-hand corner at "
+ (math "("
+ (var "x")
+ "+"
+ (var "i")
+ ","
+ (var "y")
+ "+"
+ (var "j")
+ ")")
+ "
+for "
+ (math "0" "<=" (var "i") "<" (var "width"))
+ "
+and "
+ (math "0" "<=" (var "j") "<" (var "height"))
+ ".
+ This pixel is said to be the "
+ (math (var "i"))
+ "th
+ pixel in the "
+ (math (var "j"))
+ "th
+ row.
+ Pixels are copied in row order from the lowest to the highest row,
+ left to right in each row. ")
+ (para (var "type")
+ " specifies whether color, depth, or stencil data is to be copied.
+ The details of the transfer for each data type are as follows: ")
+ (table (% (formatter (asis)))
+ (entry (% (heading (code "GL_COLOR")))
+ (para "
+Indices or RGBA colors are read from the buffer currently specified as the
+ read source buffer (see "
+ (code "glReadBuffer")
+ ").
+ If the GL is in color index mode,
+ each index that is read from this buffer is converted
+ to a fixed-point format with an unspecified
+ number of bits to the right of the binary point.
+ Each index is then shifted left by "
+ (code "GL_INDEX_SHIFT")
+ " bits,
+ and added to "
+ (code "GL_INDEX_OFFSET")
+ ".
+ If "
+ (code "GL_INDEX_SHIFT")
+ " is negative,
+ the shift is to the right.
+ In either case, zero bits fill otherwise unspecified bit locations in the
+ result.
+ If "
+ (code "GL_MAP_COLOR")
+ " is true,
+ the index is replaced with the value that it references in lookup table "
+ (code "GL_PIXEL_MAP_I_TO_I")
+ ".
+ Whether the lookup replacement of the index is done or not,
+ the integer part of the index is then ANDed with "
+ (math "2" "^" (var "b") "-" "1")
+ ",
+ where "
+ (math (var "b"))
+ "
+is the number of bits in a color index buffer. ")
+ (para "
+If the GL is in RGBA mode,
+ the red, green, blue, and alpha components of each pixel that is read
+ are converted to an internal floating-point format with unspecified
+ precision.
+ The conversion maps the largest representable component value to 1.0,
+ and component value 0 to 0.0.
+ The resulting floating-point color values are then multiplied
+ by "
+ (code "GL_c_SCALE")
+ " and added to "
+ (code "GL_c_BIAS")
+ ",
+ where "
+ (var "c")
+ " is RED, GREEN, BLUE, and ALPHA
+ for the respective color components.
+ The results are clamped to the range [0,1].
+ If "
+ (code "GL_MAP_COLOR")
+ " is true,
+ each color component is scaled by the size of lookup table "
+ (code "GL_PIXEL_MAP_c_TO_c")
+ ",
+ then replaced by the value that it references in that table. "
+ (var "c")
+ " is R, G, B, or A. ")
+ (para "
+If the "
+ (code "ARB_imaging")
+ " extension is supported, the color values may
+ be
+ additionally processed by color-table lookups, color-matrix
+ transformations, and convolution filters. ")
+ (para "
+The GL then converts the resulting indices or RGBA colors to fragments
+ by attaching the current raster position "
+ (var "z")
+ " coordinate and
+ texture coordinates to each pixel,
+ then assigning window coordinates "
+ (math "("
+ (var "x")
+ "_"
+ (var "r")
+ "+"
+ (var "i")
+ ","
+ (var "y")
+ "_"
+ (var "r")
+ "+"
+ (var "j")
+ ")")
+ ",
+ where "
+ (math "("
+ (var "x")
+ "_"
+ (var "r")
+ ","
+ (var "y")
+ "_"
+ (var "r")
+ ")")
+ "
+is the current raster position,
+ and the pixel was the "
+ (math (var "i"))
+ "th
+ pixel in the "
+ (math (var "j"))
+ "th
+ row.
+ These pixel fragments are then treated just like the fragments generated by
+ rasterizing points, lines, or polygons.
+ Texture mapping,
+ fog,
+ and all the fragment operations are applied before the fragments are written
+ to the frame buffer. "))
+ (entry (% (heading (code "GL_DEPTH")))
+ (para "
+Depth values are read from the depth buffer and
+ converted directly to an internal floating-point format
+ with unspecified precision.
+ The resulting floating-point depth value is then multiplied
+ by "
+ (code "GL_DEPTH_SCALE")
+ " and added to "
+ (code "GL_DEPTH_BIAS")
+ ".
+ The result is clamped to the range [0,1]. ")
+ (para "
+The GL then converts the resulting depth components to fragments
+ by attaching the current raster position color or color index and
+ texture coordinates to each pixel,
+ then assigning window coordinates "
+ (math "("
+ (var "x")
+ "_"
+ (var "r")
+ "+"
+ (var "i")
+ ","
+ (var "y")
+ "_"
+ (var "r")
+ "+"
+ (var "j")
+ ")")
+ ",
+ where "
+ (math "("
+ (var "x")
+ "_"
+ (var "r")
+ ","
+ (var "y")
+ "_"
+ (var "r")
+ ")")
+ "
+is the current raster position,
+ and the pixel was the "
+ (math (var "i"))
+ "th
+ pixel in the "
+ (math (var "j"))
+ "th
+ row.
+ These pixel fragments are then treated just like the fragments generated by
+ rasterizing points, lines, or polygons.
+ Texture mapping,
+ fog,
+ and all the fragment operations are applied before the fragments are written
+ to the frame buffer. "))
+ (entry (% (heading (code "GL_STENCIL")))
+ (para "
+Stencil indices are read from the stencil buffer and
+ converted to an internal fixed-point format
+ with an unspecified number of bits to the right of the binary point.
+ Each fixed-point index is then shifted left by "
+ (code "GL_INDEX_SHIFT")
+ " bits,
+ and added to "
+ (code "GL_INDEX_OFFSET")
+ ".
+ If "
+ (code "GL_INDEX_SHIFT")
+ " is negative,
+ the shift is to the right.
+ In either case, zero bits fill otherwise unspecified bit locations in the
+ result.
+ If "
+ (code "GL_MAP_STENCIL")
+ " is true,
+ the index is replaced with the value that it references in lookup table "
+ (code "GL_PIXEL_MAP_S_TO_S")
+ ".
+ Whether the lookup replacement of the index is done or not,
+ the integer part of the index is then ANDed with "
+ (math "2" "^" (var "b") "-" "1")
+ ",
+ where "
+ (math (var "b"))
+ "
+is the number of bits in the stencil buffer.
+ The resulting stencil indices are then written to the stencil buffer
+ such that the index read from the "
+ (math (var "i"))
+ "th
+ location of the "
+ (math (var "j"))
+ "th
+ row
+ is written to location "
+ (math "("
+ (var "x")
+ "_"
+ (var "r")
+ "+"
+ (var "i")
+ ","
+ (var "y")
+ "_"
+ (var "r")
+ "+"
+ (var "j")
+ ")")
+ ",
+ where "
+ (math "("
+ (var "x")
+ "_"
+ (var "r")
+ ","
+ (var "y")
+ "_"
+ (var "r")
+ ")")
+ "
+is the current raster position.
+ Only the pixel ownership test,
+ the scissor test,
+ and the stencil writemask affect these write operations. ")))
+ (para "
+The rasterization described thus far assumes pixel zoom factors of 1.0.
+ If "
+ (code "glPixelZoom")
+ " is used to change the "
+ (math (var "x"))
+ "
+and "
+ (math (var "y"))
+ "
+pixel zoom factors,
+ pixels are converted to fragments as follows.
+ If "
+ (math "("
+ (var "x")
+ "_"
+ (var "r")
+ ","
+ (var "y")
+ "_"
+ (var "r")
+ ")")
+ "
+is the current raster position,
+ and a given pixel is in the "
+ (math (var "i"))
+ "th
+ location in the "
+ (math (var "j"))
+ "th
+ row of the source
+ pixel rectangle,
+ then fragments are generated for pixels whose centers are in the rectangle
+ with corners at ")
+ (para (math "("
+ (var "x")
+ "_"
+ (var "r")
+ "+"
+ (var "zoom")
+ "_"
+ (var "x")
+ ","
+ "\u2062"
+ (var "i")
+ ","
+ (var "y")
+ "_"
+ (var "r")
+ "+"
+ (var "zoom")
+ "_"
+ (var "y")
+ ","
+ "\u2062"
+ (var "j")
+ ")"))
+ (para "
+and ")
+ (para (math "("
+ (var "x")
+ "_"
+ (var "r")
+ "+"
+ (var "zoom")
+ "_"
+ (var "x")
+ ","
+ "\u2061"
+ "("
+ (var "i")
+ "+"
+ "1"
+ ","
+ ")"
+ ","
+ (var "y")
+ "_"
+ (var "r")
+ "+"
+ (var "zoom")
+ "_"
+ (var "y")
+ ","
+ "\u2061"
+ "("
+ (var "j")
+ "+"
+ "1"
+ ","
+ ")"
+ ")"))
+ (para "
+where "
+ (math (var "zoom") "_" (var "x"))
+ "
+is the value of "
+ (code "GL_ZOOM_X")
+ " and "
+ (math (var "zoom") "_" (var "y"))
+ "
+is the value of "
+ (code "GL_ZOOM_Y")
+ ". ")
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "type")
+ " is not an accepted value. ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if either "
+ (var "width")
+ " or "
+ (var "height")
+ " is negative. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (var "type")
+ " is "
+ (code "GL_DEPTH")
+ "
+and there is no depth buffer. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (var "type")
+ " is "
+ (code "GL_STENCIL")
+ "
+and there is no stencil buffer. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glCopyPixels")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glCopyTexImage1D
+ "glCopyTexImage1D"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glCopyTexImage1D"))
+ (paramdef "GLenum " (parameter "target"))
+ (paramdef "GLint " (parameter "level"))
+ (paramdef "GLenum " (parameter "internalformat"))
+ (paramdef "GLint " (parameter "x"))
+ (paramdef "GLint " (parameter "y"))
+ (paramdef "GLsizei " (parameter "width"))
+ (paramdef "GLint " (parameter "border"))))
+ '(*fragment*
+ (heading "copy pixels into a 1D texture image")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "target")))
+ (para "
+Specifies the target texture.
+ Must be "
+ (code "GL_TEXTURE_1D")
+ ". "))
+ (entry (% (heading (var "level")))
+ (para "
+Specifies the level-of-detail number.
+ Level 0 is the base image level.
+ Level "
+ (var "n")
+ " is the "
+ (var "n")
+ "th mipmap reduction image. "))
+ (entry (% (heading (var "internalformat")))
+ (para "
+Specifies the internal format of the texture.
+ Must be one of the following symbolic constants: "
+ (code "GL_ALPHA")
+ ", "
+ (code "GL_ALPHA4")
+ ", "
+ (code "GL_ALPHA8")
+ ", "
+ (code "GL_ALPHA12")
+ ", "
+ (code "GL_ALPHA16")
+ ", "
+ (code "GL_COMPRESSED_ALPHA")
+ ", "
+ (code "GL_COMPRESSED_LUMINANCE")
+ ", "
+ (code "GL_COMPRESSED_LUMINANCE_ALPHA")
+ ", "
+ (code "GL_COMPRESSED_INTENSITY")
+ ", "
+ (code "GL_COMPRESSED_RGB")
+ ", "
+ (code "GL_COMPRESSED_RGBA")
+ ", "
+ (code "GL_DEPTH_COMPONENT")
+ ", "
+ (code "GL_DEPTH_COMPONENT16")
+ ", "
+ (code "GL_DEPTH_COMPONENT24")
+ ", "
+ (code "GL_DEPTH_COMPONENT32")
+ ", "
+ (code "GL_LUMINANCE")
+ ", "
+ (code "GL_LUMINANCE4")
+ ", "
+ (code "GL_LUMINANCE8")
+ ", "
+ (code "GL_LUMINANCE12")
+ ", "
+ (code "GL_LUMINANCE16")
+ ", "
+ (code "GL_LUMINANCE_ALPHA")
+ ", "
+ (code "GL_LUMINANCE4_ALPHA4")
+ ", "
+ (code "GL_LUMINANCE6_ALPHA2")
+ ", "
+ (code "GL_LUMINANCE8_ALPHA8")
+ ", "
+ (code "GL_LUMINANCE12_ALPHA4")
+ ", "
+ (code "GL_LUMINANCE12_ALPHA12")
+ ", "
+ (code "GL_LUMINANCE16_ALPHA16")
+ ", "
+ (code "GL_INTENSITY")
+ ", "
+ (code "GL_INTENSITY4")
+ ", "
+ (code "GL_INTENSITY8")
+ ", "
+ (code "GL_INTENSITY12")
+ ", "
+ (code "GL_INTENSITY16")
+ ", "
+ (code "GL_RGB")
+ ", "
+ (code "GL_R3_G3_B2")
+ ", "
+ (code "GL_RGB4")
+ ", "
+ (code "GL_RGB5")
+ ", "
+ (code "GL_RGB8")
+ ", "
+ (code "GL_RGB10")
+ ", "
+ (code "GL_RGB12")
+ ", "
+ (code "GL_RGB16")
+ ", "
+ (code "GL_RGBA")
+ ", "
+ (code "GL_RGBA2")
+ ", "
+ (code "GL_RGBA4")
+ ", "
+ (code "GL_RGB5_A1")
+ ", "
+ (code "GL_RGBA8")
+ ", "
+ (code "GL_RGB10_A2")
+ ", "
+ (code "GL_RGBA12")
+ ", "
+ (code "GL_RGBA16")
+ ", "
+ (code "GL_SLUMINANCE")
+ ", "
+ (code "GL_SLUMINANCE8")
+ ", "
+ (code "GL_SLUMINANCE_ALPHA")
+ ", "
+ (code "GL_SLUMINANCE8_ALPHA8")
+ ", "
+ (code "GL_SRGB")
+ ", "
+ (code "GL_SRGB8")
+ ", "
+ (code "GL_SRGB_ALPHA")
+ ", or "
+ (code "GL_SRGB8_ALPHA8")
+ ". "))
+ (entry (% (heading (var "x")))
+ (itemx (var "y"))
+ (para "
+Specify the window coordinates of the left corner
+ of the row of pixels to be copied. "))
+ (entry (% (heading (var "width")))
+ (para "
+Specifies the width of the texture image.
+ Must be 0 or "
+ (math "2"
+ "^"
+ (var "n")
+ "+"
+ "2"
+ "\u2061"
+ "("
+ (var "border")
+ ","
+ ")")
+ "
+for some integer "
+ (math (var "n"))
+ ".
+ The height of the texture image is 1. "))
+ (entry (% (heading (var "border")))
+ (para "
+Specifies the width of the border.
+ Must be either 0 or 1. ")))
+ (heading "Description")
+ (para (code "glCopyTexImage1D")
+ " defines a one-dimensional texture image with pixels from the current "
+ (code "GL_READ_BUFFER")
+ ". ")
+ (para "
+The screen-aligned pixel row with left corner at "
+ (math "(" (var "x") "," (var "y") ")")
+ "
+and with a length of "
+ (math (var "width")
+ "+"
+ "2"
+ "\u2061"
+ "("
+ (var "border")
+ ","
+ ")")
+ "
+defines the texture array
+ at the mipmap level specified by "
+ (var "level")
+ ". "
+ (var "internalformat")
+ " specifies the internal format of the texture array. ")
+ (para "
+The pixels in the row are processed exactly as if "
+ (code "glCopyPixels")
+ " had been called, but the process stops just before
+ final conversion.
+ At this point all pixel component values are clamped to the range "
+ (math "[" "0" "," "1" "]")
+ "
+and then converted to the texture's internal format for storage in the texel
+ array. ")
+ (para "
+Pixel ordering is such that lower "
+ (math (var "x"))
+ "
+screen coordinates correspond to
+ lower texture coordinates. ")
+ (para "
+If any of the pixels within the specified row of the current "
+ (code "GL_READ_BUFFER")
+ " are outside the window associated with the current
+ rendering context, then the values obtained for those pixels are undefined. ")
+ (para (code "glCopyTexImage1D")
+ " defines a one-dimensional texture image with pixels from the current "
+ (code "GL_READ_BUFFER")
+ ". ")
+ (para "
+When "
+ (var "internalformat")
+ " is one of the sRGB types, the GL does not automatically convert the source pixels to the sRGB color space. In this case, the "
+ (code "glPixelMap")
+ " function can be used to accomplish the conversion. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "target")
+ " is not one of the allowable values. ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "level")
+ " is less than 0. ")
+ (para (code "GL_INVALID_VALUE")
+ " may be generated if "
+ (var "level")
+ " is greater
+ than "
+ (math (var "log") "_" "2" "\u2062" (var "max"))
+ ",
+ where "
+ (math (var "max"))
+ "
+is the returned value of "
+ (code "GL_MAX_TEXTURE_SIZE")
+ ". ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "internalformat")
+ " is not an allowable value. ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "width")
+ " is less than 0 or greater than
+ 2 + "
+ (code "GL_MAX_TEXTURE_SIZE")
+ ". ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if non-power-of-two textures are not supported and the "
+ (var "width")
+ " cannot be represented as "
+ (math "2"
+ "^"
+ (var "n")
+ "+"
+ "2"
+ "\u2061"
+ "("
+ (var "border")
+ ","
+ ")")
+ "
+for some integer value of "
+ (var "n")
+ ". ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "border")
+ " is not 0 or 1. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glCopyTexImage1D")
+ " is executed between the execution of "
+ (code "glBegin")
+ " and the corresponding execution of "
+ (code "glEnd")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (var "internalformat")
+ " is "
+ (code "GL_DEPTH_COMPONENT")
+ ", "
+ (code "GL_DEPTH_COMPONENT16")
+ ", "
+ (code "GL_DEPTH_COMPONENT24")
+ ", or "
+ (code "GL_DEPTH_COMPONENT32")
+ " and there is no depth
+ buffer. ")))
+
+(define-gl-procedure
+ glCopyTexImage2D
+ "glCopyTexImage2D"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glCopyTexImage2D"))
+ (paramdef "GLenum " (parameter "target"))
+ (paramdef "GLint " (parameter "level"))
+ (paramdef "GLenum " (parameter "internalformat"))
+ (paramdef "GLint " (parameter "x"))
+ (paramdef "GLint " (parameter "y"))
+ (paramdef "GLsizei " (parameter "width"))
+ (paramdef "GLsizei " (parameter "height"))
+ (paramdef "GLint " (parameter "border"))))
+ '(*fragment*
+ (heading "copy pixels into a 2D texture image")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "target")))
+ (para "
+Specifies the target texture.
+ Must be "
+ (code "GL_TEXTURE_2D")
+ ", "
+ (code "GL_TEXTURE_CUBE_MAP_POSITIVE_X")
+ ", "
+ (code "GL_TEXTURE_CUBE_MAP_NEGATIVE_X")
+ ", "
+ (code "GL_TEXTURE_CUBE_MAP_POSITIVE_Y")
+ ", "
+ (code "GL_TEXTURE_CUBE_MAP_NEGATIVE_Y")
+ ", "
+ (code "GL_TEXTURE_CUBE_MAP_POSITIVE_Z")
+ ", or "
+ (code "GL_TEXTURE_CUBE_MAP_NEGATIVE_Z")
+ ". "))
+ (entry (% (heading (var "level")))
+ (para "
+Specifies the level-of-detail number.
+ Level 0 is the base image level.
+ Level "
+ (var "n")
+ " is the "
+ (var "n")
+ "th mipmap reduction image. "))
+ (entry (% (heading (var "internalformat")))
+ (para "
+Specifies the internal format of the texture.
+ Must be one of the following symbolic constants: "
+ (code "GL_ALPHA")
+ ", "
+ (code "GL_ALPHA4")
+ ", "
+ (code "GL_ALPHA8")
+ ", "
+ (code "GL_ALPHA12")
+ ", "
+ (code "GL_ALPHA16")
+ ", "
+ (code "GL_COMPRESSED_ALPHA")
+ ", "
+ (code "GL_COMPRESSED_LUMINANCE")
+ ", "
+ (code "GL_COMPRESSED_LUMINANCE_ALPHA")
+ ", "
+ (code "GL_COMPRESSED_INTENSITY")
+ ", "
+ (code "GL_COMPRESSED_RGB")
+ ", "
+ (code "GL_COMPRESSED_RGBA")
+ ", "
+ (code "GL_DEPTH_COMPONENT")
+ ", "
+ (code "GL_DEPTH_COMPONENT16")
+ ", "
+ (code "GL_DEPTH_COMPONENT24")
+ ", "
+ (code "GL_DEPTH_COMPONENT32")
+ ", "
+ (code "GL_LUMINANCE")
+ ", "
+ (code "GL_LUMINANCE4")
+ ", "
+ (code "GL_LUMINANCE8")
+ ", "
+ (code "GL_LUMINANCE12")
+ ", "
+ (code "GL_LUMINANCE16")
+ ", "
+ (code "GL_LUMINANCE_ALPHA")
+ ", "
+ (code "GL_LUMINANCE4_ALPHA4")
+ ", "
+ (code "GL_LUMINANCE6_ALPHA2")
+ ", "
+ (code "GL_LUMINANCE8_ALPHA8")
+ ", "
+ (code "GL_LUMINANCE12_ALPHA4")
+ ", "
+ (code "GL_LUMINANCE12_ALPHA12")
+ ", "
+ (code "GL_LUMINANCE16_ALPHA16")
+ ", "
+ (code "GL_INTENSITY")
+ ", "
+ (code "GL_INTENSITY4")
+ ", "
+ (code "GL_INTENSITY8")
+ ", "
+ (code "GL_INTENSITY12")
+ ", "
+ (code "GL_INTENSITY16")
+ ", "
+ (code "GL_RGB")
+ ", "
+ (code "GL_R3_G3_B2")
+ ", "
+ (code "GL_RGB4")
+ ", "
+ (code "GL_RGB5")
+ ", "
+ (code "GL_RGB8")
+ ", "
+ (code "GL_RGB10")
+ ", "
+ (code "GL_RGB12")
+ ", "
+ (code "GL_RGB16")
+ ", "
+ (code "GL_RGBA")
+ ", "
+ (code "GL_RGBA2")
+ ", "
+ (code "GL_RGBA4")
+ ", "
+ (code "GL_RGB5_A1")
+ ", "
+ (code "GL_RGBA8")
+ ", "
+ (code "GL_RGB10_A2")
+ ", "
+ (code "GL_RGBA12")
+ ", "
+ (code "GL_RGBA16")
+ ", "
+ (code "GL_SLUMINANCE")
+ ", "
+ (code "GL_SLUMINANCE8")
+ ", "
+ (code "GL_SLUMINANCE_ALPHA")
+ ", "
+ (code "GL_SLUMINANCE8_ALPHA8")
+ ", "
+ (code "GL_SRGB")
+ ", "
+ (code "GL_SRGB8")
+ ", "
+ (code "GL_SRGB_ALPHA")
+ ", or "
+ (code "GL_SRGB8_ALPHA8")
+ ". "))
+ (entry (% (heading (var "x")))
+ (itemx (var "y"))
+ (para "
+Specify the window coordinates of the lower left corner
+ of the rectangular region of pixels to be copied. "))
+ (entry (% (heading (var "width")))
+ (para "
+Specifies the width of the texture image.
+ Must be 0 or "
+ (math "2"
+ "^"
+ (var "n")
+ "+"
+ "2"
+ "\u2061"
+ "("
+ (var "border")
+ ","
+ ")")
+ "
+for some integer "
+ (math (var "n"))
+ ". "))
+ (entry (% (heading (var "height")))
+ (para "
+Specifies the height of the texture image.
+ Must be 0 or "
+ (math "2"
+ "^"
+ (var "m")
+ "+"
+ "2"
+ "\u2061"
+ "("
+ (var "border")
+ ","
+ ")")
+ "
+for some integer "
+ (math (var "m"))
+ ". "))
+ (entry (% (heading (var "border")))
+ (para "
+Specifies the width of the border.
+ Must be either 0 or 1. ")))
+ (heading "Description")
+ (para (code "glCopyTexImage2D")
+ " defines a two-dimensional texture image, or cube-map texture image
+ with pixels from the current "
+ (code "GL_READ_BUFFER")
+ ". ")
+ (para "
+The screen-aligned pixel rectangle with lower left corner at ("
+ (var "x")
+ ", "
+ (var "y")
+ ") and with a width of "
+ (math (var "width")
+ "+"
+ "2"
+ "\u2061"
+ "("
+ (var "border")
+ ","
+ ")")
+ "
+and a height of "
+ (math (var "height")
+ "+"
+ "2"
+ "\u2061"
+ "("
+ (var "border")
+ ","
+ ")")
+ "
+defines the texture array
+ at the mipmap level specified by "
+ (var "level")
+ ". "
+ (var "internalformat")
+ " specifies the internal format of the texture array. ")
+ (para "
+The pixels in the rectangle are processed exactly as if "
+ (code "glCopyPixels")
+ " had been called, but the process stops just before
+ final conversion.
+ At this point all pixel component values are clamped to the range "
+ (math "[" "0" "," "1" "]")
+ "
+and then converted to the texture's internal format for storage in the texel
+ array. ")
+ (para "
+Pixel ordering is such that lower "
+ (math (var "x"))
+ "
+and "
+ (math (var "y"))
+ "
+screen coordinates correspond to
+ lower "
+ (math (var "s"))
+ "
+and "
+ (math (var "t"))
+ "
+texture coordinates. ")
+ (para "
+If any of the pixels within the specified rectangle of the current "
+ (code "GL_READ_BUFFER")
+ " are outside the window associated with the current
+ rendering context, then the values obtained for those pixels are undefined. ")
+ (para "
+When "
+ (var "internalformat")
+ " is one of the sRGB types, the GL does not automatically convert the source pixels to the sRGB color space. In this case, the "
+ (code "glPixelMap")
+ " function can be used to accomplish the conversion. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "target")
+ " is not "
+ (code "GL_TEXTURE_2D")
+ ", "
+ (code "GL_TEXTURE_CUBE_MAP_POSITIVE_X")
+ ", "
+ (code "GL_TEXTURE_CUBE_MAP_NEGATIVE_X")
+ ", "
+ (code "GL_TEXTURE_CUBE_MAP_POSITIVE_Y")
+ ", "
+ (code "GL_TEXTURE_CUBE_MAP_NEGATIVE_Y")
+ ", "
+ (code "GL_TEXTURE_CUBE_MAP_POSITIVE_Z")
+ ", or "
+ (code "GL_TEXTURE_CUBE_MAP_NEGATIVE_Z")
+ ". ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "level")
+ " is less than 0. ")
+ (para (code "GL_INVALID_VALUE")
+ " may be generated if "
+ (var "level")
+ " is greater
+ than "
+ (math (var "log") "_" "2" "\u2062" (var "max"))
+ ",
+ where "
+ (math (var "max"))
+ "
+is the returned value of "
+ (code "GL_MAX_TEXTURE_SIZE")
+ ". ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "width")
+ " is less than 0
+ or greater than
+ 2 + "
+ (code "GL_MAX_TEXTURE_SIZE")
+ ". ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if non-power-of-two textures are not supported and the "
+ (var "width")
+ " or "
+ (var "depth")
+ " cannot be represented as "
+ (math "2"
+ "^"
+ (var "k")
+ "+"
+ "2"
+ "\u2061"
+ "("
+ (var "border")
+ ","
+ ")")
+ "
+for some integer "
+ (math (var "k"))
+ ". ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "border")
+ " is not 0 or 1. ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "internalformat")
+ " is not an
+ accepted format. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glCopyTexImage2D")
+ " is executed
+ between the execution of "
+ (code "glBegin")
+ " and the corresponding
+ execution of "
+ (code "glEnd")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (var "internalformat")
+ " is "
+ (code "GL_DEPTH_COMPONENT")
+ ", "
+ (code "GL_DEPTH_COMPONENT16")
+ ", "
+ (code "GL_DEPTH_COMPONENT24")
+ ", or "
+ (code "GL_DEPTH_COMPONENT32")
+ " and there is no depth
+ buffer. ")))
+
+(define-gl-procedure
+ glCopyTexSubImage1D
+ "glCopyTexSubImage1D"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "void "
+ (function "glCopyTexSubImage1D"))
+ (paramdef "GLenum " (parameter "target"))
+ (paramdef "GLint " (parameter "level"))
+ (paramdef "GLint " (parameter "xoffset"))
+ (paramdef "GLint " (parameter "x"))
+ (paramdef "GLint " (parameter "y"))
+ (paramdef "GLsizei " (parameter "width"))))
+ '(*fragment*
+ (heading
+ "copy a one-dimensional texture subimage")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "target")))
+ (para "
+Specifies the target texture.
+ Must be "
+ (code "GL_TEXTURE_1D")
+ ". "))
+ (entry (% (heading (var "level")))
+ (para "
+Specifies the level-of-detail number.
+ Level 0 is the base image level.
+ Level "
+ (var "n")
+ " is the "
+ (var "n")
+ "th mipmap reduction image. "))
+ (entry (% (heading (var "xoffset")))
+ (para "
+Specifies the texel offset within the texture array. "))
+ (entry (% (heading (var "x")))
+ (itemx (var "y"))
+ (para "
+Specify the window coordinates of the left corner
+ of the row of pixels to be copied. "))
+ (entry (% (heading (var "width")))
+ (para "
+Specifies the width of the texture subimage. ")))
+ (heading "Description")
+ (para (code "glCopyTexSubImage1D")
+ " replaces a portion of a one-dimensional
+ texture image with pixels from the current "
+ (code "GL_READ_BUFFER")
+ " (rather
+ than from main memory, as is the case for "
+ (code "glTexSubImage1D")
+ "). ")
+ (para "
+The screen-aligned pixel row with left corner at ("
+ (var "x")
+ ",\\ "
+ (var "y")
+ "), and with
+ length "
+ (var "width")
+ " replaces the portion of the
+ texture array with x indices "
+ (var "xoffset")
+ " through "
+ (math (var "xoffset") "+" (var "width") "-" "1")
+ ",
+ inclusive. The destination in the texture array may not
+ include any texels outside the texture array as it was
+ originally specified. ")
+ (para "
+The pixels in the row are processed exactly as if "
+ (code "glCopyPixels")
+ " had been called, but the process stops just before
+ final conversion.
+ At this point, all pixel component values are clamped to the range "
+ (math "[" "0" "," "1" "]")
+ "
+and then converted to the texture's internal format for storage in the texel
+ array. ")
+ (para "
+It is not an error to specify a subtexture with zero width, but
+ such a specification has no effect.
+ If any of the pixels within the specified row of the current "
+ (code "GL_READ_BUFFER")
+ " are outside the read window associated with the current
+ rendering context, then the values obtained for those pixels are undefined. ")
+ (para "
+No change is made to the "
+ (var "internalformat")
+ ", "
+ (var "width")
+ ",
+ or "
+ (var "border")
+ " parameters of the specified texture
+ array or to texel values outside the specified subregion. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if /"
+ (var "target")
+ " is not "
+ (code "GL_TEXTURE_1D")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if the texture array has not
+ been defined by a previous "
+ (code "glTexImage1D")
+ " or "
+ (code "glCopyTexImage1D")
+ " operation. ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "level")
+ " is less than 0. ")
+ (para (code "GL_INVALID_VALUE")
+ " may be generated if "
+ (math (var "level")
+ ">"
+ (var "log")
+ "_"
+ "2"
+ "\u2061"
+ "("
+ (var "max")
+ ","
+ ")")
+ ",
+ where "
+ (var "max")
+ " is the returned value of "
+ (code "GL_MAX_TEXTURE_SIZE")
+ ". ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (math (var "xoffset") "<" "-" (var "b"))
+ ",
+ or "
+ (math "("
+ (var "xoffset")
+ "+"
+ (var "width")
+ ","
+ ")"
+ ">"
+ "("
+ (var "w")
+ "-"
+ (var "b")
+ ","
+ ")")
+ ",
+ where "
+ (math (var "w"))
+ "
+is the "
+ (code "GL_TEXTURE_WIDTH")
+ " and "
+ (math (var "b"))
+ "
+is the "
+ (code "GL_TEXTURE_BORDER")
+ "
+of the texture image being modified.
+ Note that "
+ (math (var "w"))
+ "
+includes twice the border width. ")
+ (para)))
+
+(define-gl-procedure
+ glCopyTexSubImage2D
+ "glCopyTexSubImage2D"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "void "
+ (function "glCopyTexSubImage2D"))
+ (paramdef "GLenum " (parameter "target"))
+ (paramdef "GLint " (parameter "level"))
+ (paramdef "GLint " (parameter "xoffset"))
+ (paramdef "GLint " (parameter "yoffset"))
+ (paramdef "GLint " (parameter "x"))
+ (paramdef "GLint " (parameter "y"))
+ (paramdef "GLsizei " (parameter "width"))
+ (paramdef "GLsizei " (parameter "height"))))
+ '(*fragment*
+ (heading
+ "copy a two-dimensional texture subimage")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "target")))
+ (para "
+Specifies the target texture.
+ Must be "
+ (code "GL_TEXTURE_2D")
+ ", "
+ (code "GL_TEXTURE_CUBE_MAP_POSITIVE_X")
+ ", "
+ (code "GL_TEXTURE_CUBE_MAP_NEGATIVE_X")
+ ", "
+ (code "GL_TEXTURE_CUBE_MAP_POSITIVE_Y")
+ ", "
+ (code "GL_TEXTURE_CUBE_MAP_NEGATIVE_Y")
+ ", "
+ (code "GL_TEXTURE_CUBE_MAP_POSITIVE_Z")
+ ", or "
+ (code "GL_TEXTURE_CUBE_MAP_NEGATIVE_Z")
+ ". "))
+ (entry (% (heading (var "level")))
+ (para "
+Specifies the level-of-detail number.
+ Level 0 is the base image level.
+ Level "
+ (var "n")
+ " is the "
+ (var "n")
+ "th mipmap reduction image. "))
+ (entry (% (heading (var "xoffset")))
+ (para "
+Specifies a texel offset in the x direction within the texture array. "))
+ (entry (% (heading (var "yoffset")))
+ (para "
+Specifies a texel offset in the y direction within the texture array. "))
+ (entry (% (heading (var "x")))
+ (itemx (var "y"))
+ (para "
+Specify the window coordinates of the lower left corner
+ of the rectangular region of pixels to be copied. "))
+ (entry (% (heading (var "width")))
+ (para "
+Specifies the width of the texture subimage. "))
+ (entry (% (heading (var "height")))
+ (para "
+Specifies the height of the texture subimage. ")))
+ (heading "Description")
+ (para (code "glCopyTexSubImage2D")
+ " replaces a rectangular portion of a two-dimensional texture image or
+ cube-map texture image with pixels from the current "
+ (code "GL_READ_BUFFER")
+ "
+(rather than from main memory, as is the case for "
+ (code "glTexSubImage2D")
+ "). ")
+ (para "
+The screen-aligned pixel rectangle with lower left corner at "
+ (math "(" (var "x") "," (var "y") ")")
+ "
+and with
+ width "
+ (var "width")
+ " and height "
+ (var "height")
+ " replaces the portion of the
+ texture array with x indices "
+ (var "xoffset")
+ " through "
+ (math (var "xoffset") "+" (var "width") "-" "1")
+ ",
+ inclusive, and y indices "
+ (var "yoffset")
+ " through "
+ (math (var "yoffset") "+" (var "height") "-" "1")
+ ",
+ inclusive, at the mipmap level specified by "
+ (var "level")
+ ". ")
+ (para "
+The pixels in the rectangle are processed exactly as if "
+ (code "glCopyPixels")
+ " had been called, but the process stops just before
+ final conversion.
+ At this point, all pixel component values are clamped to the range "
+ (math "[" "0" "," "1" "]")
+ "
+and then converted to the texture's internal format for storage in the texel
+ array. ")
+ (para "
+The destination rectangle in the texture array may not include any texels
+ outside the texture array as it was originally specified.
+ It is not an error to specify a subtexture with zero width or height, but
+ such a specification has no effect. ")
+ (para "
+If any of the pixels within the specified rectangle of the current "
+ (code "GL_READ_BUFFER")
+ " are outside the read window associated with the current
+ rendering context, then the values obtained for those pixels are undefined. ")
+ (para "
+No change is made to the "
+ (var "internalformat")
+ ", "
+ (var "width")
+ ", "
+ (var "height")
+ ", or "
+ (var "border")
+ " parameters of the specified texture
+ array or to texel values outside the specified subregion. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "target")
+ " is not "
+ (code "GL_TEXTURE_2D")
+ ", "
+ (code "GL_TEXTURE_CUBE_MAP_POSITIVE_X")
+ ", "
+ (code "GL_TEXTURE_CUBE_MAP_NEGATIVE_X")
+ ", "
+ (code "GL_TEXTURE_CUBE_MAP_POSITIVE_Y")
+ ", "
+ (code "GL_TEXTURE_CUBE_MAP_NEGATIVE_Y")
+ ", "
+ (code "GL_TEXTURE_CUBE_MAP_POSITIVE_Z")
+ ", or "
+ (code "GL_TEXTURE_CUBE_MAP_NEGATIVE_Z")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if the texture array has not been
+ defined by a previous "
+ (code "glTexImage2D")
+ " or "
+ (code "glCopyTexImage2D")
+ " operation. ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "level")
+ " is less than 0. ")
+ (para (code "GL_INVALID_VALUE")
+ " may be generated if "
+ (math (var "level")
+ ">"
+ (var "log")
+ "_"
+ "2"
+ "\u2061"
+ "("
+ (var "max")
+ ","
+ ")")
+ ",
+ where "
+ (math (var "max"))
+ "
+is the returned value of "
+ (code "GL_MAX_TEXTURE_SIZE")
+ ". ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (math (var "xoffset") "<" "-" (var "b"))
+ ", "
+ (math "("
+ (var "xoffset")
+ "+"
+ (var "width")
+ ","
+ ")"
+ ">"
+ "("
+ (var "w")
+ "-"
+ (var "b")
+ ","
+ ")")
+ ", "
+ (math (var "yoffset") "<" "-" (var "b"))
+ ",
+ or "
+ (math "("
+ (var "yoffset")
+ "+"
+ (var "height")
+ ","
+ ")"
+ ">"
+ "("
+ (var "h")
+ "-"
+ (var "b")
+ ","
+ ")")
+ ",
+ where "
+ (math (var "w"))
+ "
+is the "
+ (code "GL_TEXTURE_WIDTH")
+ ", "
+ (math (var "h"))
+ "
+is the "
+ (code "GL_TEXTURE_HEIGHT")
+ ",
+ and "
+ (math (var "b"))
+ "
+is the "
+ (code "GL_TEXTURE_BORDER")
+ "
+of the texture image being modified.
+ Note that "
+ (math (var "w"))
+ "
+and "
+ (math (var "h"))
+ "
+include twice the border width. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glCopyTexSubImage2D")
+ " is executed
+ between the execution of "
+ (code "glBegin")
+ " and the corresponding
+ execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glCopyTexSubImage3D
+ "glCopyTexSubImage3D"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "void "
+ (function "glCopyTexSubImage3D"))
+ (paramdef "GLenum " (parameter "target"))
+ (paramdef "GLint " (parameter "level"))
+ (paramdef "GLint " (parameter "xoffset"))
+ (paramdef "GLint " (parameter "yoffset"))
+ (paramdef "GLint " (parameter "zoffset"))
+ (paramdef "GLint " (parameter "x"))
+ (paramdef "GLint " (parameter "y"))
+ (paramdef "GLsizei " (parameter "width"))
+ (paramdef "GLsizei " (parameter "height"))))
+ '(*fragment*
+ (heading
+ "copy a three-dimensional texture subimage")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "target")))
+ (para "
+Specifies the target texture.
+ Must be "
+ (code "GL_TEXTURE_3D")))
+ (entry (% (heading (var "level")))
+ (para "
+Specifies the level-of-detail number.
+ Level 0 is the base image level.
+ Level "
+ (var "n")
+ " is the "
+ (var "n")
+ "th mipmap reduction image. "))
+ (entry (% (heading (var "xoffset")))
+ (para "
+Specifies a texel offset in the x direction within the texture array. "))
+ (entry (% (heading (var "yoffset")))
+ (para "
+Specifies a texel offset in the y direction within the texture array. "))
+ (entry (% (heading (var "zoffset")))
+ (para "
+Specifies a texel offset in the z direction within the texture array. "))
+ (entry (% (heading (var "x")))
+ (itemx (var "y"))
+ (para "
+Specify the window coordinates of the lower left corner
+ of the rectangular region of pixels to be copied. "))
+ (entry (% (heading (var "width")))
+ (para "
+Specifies the width of the texture subimage. "))
+ (entry (% (heading (var "height")))
+ (para "
+Specifies the height of the texture subimage. ")))
+ (heading "Description")
+ (para (code "glCopyTexSubImage3D")
+ " replaces a rectangular portion of a three-dimensional
+ texture image with pixels from the current "
+ (code "GL_READ_BUFFER")
+ " (rather
+ than from main memory, as is the case for "
+ (code "glTexSubImage3D")
+ "). ")
+ (para "
+The screen-aligned pixel rectangle with lower left corner at
+ ("
+ (var "x")
+ ",\\ "
+ (var "y")
+ ") and with
+ width "
+ (var "width")
+ " and height "
+ (var "height")
+ " replaces the portion of the
+ texture array with x indices "
+ (var "xoffset")
+ " through "
+ (math (var "xoffset") "+" (var "width") "-" "1")
+ ",
+ inclusive, and y indices "
+ (var "yoffset")
+ " through "
+ (math (var "yoffset") "+" (var "height") "-" "1")
+ ",
+ inclusive, at z index "
+ (var "zoffset")
+ " and at the mipmap level specified by "
+ (var "level")
+ ". ")
+ (para "
+The pixels in the rectangle are processed exactly as if "
+ (code "glCopyPixels")
+ " had been called, but the process stops just before
+ final conversion.
+ At this point, all pixel component values are clamped to the range "
+ (math "[" "0" "," "1" "]")
+ "
+and then converted to the texture's internal format for storage in the texel
+ array. ")
+ (para "
+The destination rectangle in the texture array may not include any texels
+ outside the texture array as it was originally specified.
+ It is not an error to specify a subtexture with zero width or height, but
+ such a specification has no effect. ")
+ (para "
+If any of the pixels within the specified rectangle of the current "
+ (code "GL_READ_BUFFER")
+ " are outside the read window associated with the current
+ rendering context, then the values obtained for those pixels are undefined. ")
+ (para "
+No change is made to the "
+ (var "internalformat")
+ ", "
+ (var "width")
+ ", "
+ (var "height")
+ ", "
+ (var "depth")
+ ", or "
+ (var "border")
+ " parameters of the specified texture
+ array or to texel values outside the specified subregion. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if /"
+ (var "target")
+ " is not "
+ (code "GL_TEXTURE_3D")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if the texture array has not
+ been defined by a previous "
+ (code "glTexImage3D")
+ " operation. ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "level")
+ " is less than 0. ")
+ (para (code "GL_INVALID_VALUE")
+ " may be generated if "
+ (math (var "level")
+ ">"
+ (var "log")
+ "_"
+ "2"
+ "\u2061"
+ "("
+ (var "max")
+ ","
+ ")")
+ ",
+ where "
+ (math (var "max"))
+ "
+is the returned value of "
+ (code "GL_MAX_3D_TEXTURE_SIZE")
+ ". ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (math (var "xoffset") "<" "-" (var "b"))
+ ", "
+ (math "("
+ (var "xoffset")
+ "+"
+ (var "width")
+ ","
+ ")"
+ ">"
+ "("
+ (var "w")
+ "-"
+ (var "b")
+ ","
+ ")")
+ ", "
+ (math (var "yoffset") "<" "-" (var "b"))
+ ", "
+ (math "("
+ (var "yoffset")
+ "+"
+ (var "height")
+ ","
+ ")"
+ ">"
+ "("
+ (var "h")
+ "-"
+ (var "b")
+ ","
+ ")")
+ ", "
+ (math (var "zoffset") "<" "-" (var "b"))
+ ",
+ or "
+ (math "("
+ (var "zoffset")
+ "+"
+ "1"
+ ","
+ ")"
+ ">"
+ "("
+ (var "d")
+ "-"
+ (var "b")
+ ","
+ ")")
+ ",
+ where "
+ (math (var "w"))
+ "
+is the "
+ (code "GL_TEXTURE_WIDTH")
+ ", "
+ (math (var "h"))
+ "
+is the "
+ (code "GL_TEXTURE_HEIGHT")
+ ", "
+ (math (var "d"))
+ "
+is the "
+ (code "GL_TEXTURE_DEPTH")
+ ",
+ and "
+ (math (var "b"))
+ "
+is the "
+ (code "GL_TEXTURE_BORDER")
+ "
+of the texture image being modified.
+ Note that "
+ (math (var "w"))
+ ", "
+ (math (var "h"))
+ ",
+ and "
+ (math (var "d"))
+ "
+include twice the border width. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glCopyTexSubImage3D")
+ " is executed
+ between the execution of "
+ (code "glBegin")
+ " and the corresponding
+ execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glCreateProgram
+ "glCreateProgram"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "GLuint " (function "glCreateProgram"))
+ (paramdef (parameter "void"))))
+ '(*fragment*
+ (heading "Creates a program object")
+ (heading "Description")
+ (para (code "glCreateProgram")
+ " creates an empty
+\tprogram object and returns a non-zero value by which it can be
+\treferenced. A program object is an object to which shader
+\tobjects can be attached. This provides a mechanism to specify
+\tthe shader objects that will be linked to create a program. It
+\talso provides a means for checking the compatibility of the
+\tshaders that will be used to create a program (for instance,
+\tchecking the compatibility between a vertex shader and a
+\tfragment shader). When no longer needed as part of a program
+\tobject, shader objects can be detached.")
+ (para "One or more executables are created in a program object by
+\tsuccessfully attaching shader objects to it with\t"
+ (code "glAttachShader")
+ ",
+\tsuccessfully compiling the shader objects with\t"
+ (code "glCompileShader")
+ ",
+\tand successfully linking the program object with\t"
+ (code "glLinkProgram")
+ ".
+\tThese executables are made part of current state when\t"
+ (code "glUseProgram")
+ "
+is called. Program objects can be deleted by calling\t"
+ (code "glDeleteProgram")
+ ".
+\tThe memory associated with the program object will be deleted
+\twhen it is no longer part of current rendering state for any
+\tcontext.")
+ (heading "Errors")
+ (para "This function returns 0 if an error occurs creating the program object.")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if\t"
+ (code "glCreateProgram")
+ " is executed between the
+\texecution of\t"
+ (code "glBegin")
+ "
+and the corresponding execution of\t"
+ (code "glEnd")
+ ".")))
+
+(define-gl-procedure
+ glCreateShader
+ "glCreateShader"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "GLuint " (function "glCreateShader"))
+ (paramdef "GLenum " (parameter "shaderType"))))
+ '(*fragment*
+ (heading "Creates a shader object")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "shaderType")))
+ (para "Specifies the type of shader to be created.
+\t\t Must be either "
+ (code "GL_VERTEX_SHADER")
+ "
+or "
+ (code "GL_FRAGMENT_SHADER")
+ ".")))
+ (heading "Description")
+ (para (code "glCreateShader")
+ " creates an empty
+\tshader object and returns a non-zero value by which it can be
+\treferenced. A shader object is used to maintain the source code
+\tstrings that define a shader. "
+ (var "shaderType")
+ "
+indicates the type of shader to be created. Two types of shaders
+\tare supported. A shader of type\t"
+ (code "GL_VERTEX_SHADER")
+ " is a shader that is
+\tintended to run on the programmable vertex processor and replace
+\tthe fixed functionality vertex processing in OpenGL. A shader of
+\ttype "
+ (code "GL_FRAGMENT_SHADER")
+ " is a shader that is
+\tintended to run on the programmable fragment processor and
+\treplace the fixed functionality fragment processing in
+\tOpenGL.")
+ (para "When created, a shader object's\t"
+ (code "GL_SHADER_TYPE")
+ " parameter is set to either\t"
+ (code "GL_VERTEX_SHADER")
+ " or\t"
+ (code "GL_FRAGMENT_SHADER")
+ ", depending on the value
+\tof "
+ (var "shaderType")
+ ".")
+ (heading "Errors")
+ (para "This function returns 0 if an error occurs creating the
+\tshader object.")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if\t"
+ (var "shaderType")
+ " is not an accepted value.")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if\t"
+ (code "glCreateShader")
+ " is executed between the
+\texecution of\t"
+ (code "glBegin")
+ "
+and the corresponding execution of\t"
+ (code "glEnd")
+ ".")))
+
+(define-gl-procedure
+ glCullFace
+ "glCullFace"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glCullFace"))
+ (paramdef "GLenum " (parameter "mode"))))
+ '(*fragment*
+ (heading
+ "specify whether front- or back-facing facets can be culled")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "mode")))
+ (para "
+Specifies whether front- or back-facing facets are candidates for culling.
+ Symbolic constants "
+ (code "GL_FRONT")
+ ", "
+ (code "GL_BACK")
+ ", and "
+ (code "GL_FRONT_AND_BACK")
+ " are accepted.
+ The initial value is "
+ (code "GL_BACK")
+ ". ")))
+ (heading "Description")
+ (para (code "glCullFace")
+ " specifies whether front- or back-facing facets are culled
+ (as specified by "
+ (var "mode")
+ ") when facet culling is enabled. Facet
+ culling is initially disabled.
+ To enable and disable facet culling, call the "
+ (code "glEnable")
+ " and "
+ (code "glDisable")
+ " commands
+ with the argument "
+ (code "GL_CULL_FACE")
+ ".
+ Facets include triangles,
+ quadrilaterals,
+ polygons, and
+ rectangles. ")
+ (para (code "glFrontFace")
+ " specifies which of the clockwise and counterclockwise facets
+ are front-facing and back-facing.
+ See "
+ (code "glFrontFace")
+ ". ")
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "mode")
+ " is not an accepted value. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glCullFace")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glDeleteBuffers
+ "glDeleteBuffers"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glDeleteBuffers"))
+ (paramdef "GLsizei " (parameter "n"))
+ (paramdef
+ "const GLuint * "
+ (parameter "buffers"))))
+ '(*fragment*
+ (heading "delete named buffer objects")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "n")))
+ (para "
+Specifies the number of buffer objects to be deleted. "))
+ (entry (% (heading (var "buffers")))
+ (para "
+Specifies an array of buffer objects to be deleted. ")))
+ (heading "Description")
+ (para (code "glDeleteBuffers")
+ " deletes "
+ (var "n")
+ " buffer objects named by the elements of the array "
+ (var "buffers")
+ ".
+ After a buffer object is deleted, it has no contents,
+ and its name is free for reuse (for example by "
+ (code "glGenBuffers")
+ ").
+ If a buffer object that is currently bound is deleted, the binding reverts
+ to 0 (the absence of any buffer object, which reverts to client memory usage). ")
+ (para (code "glDeleteBuffers")
+ " silently ignores 0's and names that do not correspond to
+ existing buffer objects. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "n")
+ " is negative. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glDeleteBuffers")
+ " is executed
+ between the execution of "
+ (code "glBegin")
+ " and the corresponding
+ execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glDeleteLists
+ "glDeleteLists"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glDeleteLists"))
+ (paramdef "GLuint " (parameter "list"))
+ (paramdef "GLsizei " (parameter "range"))))
+ '(*fragment*
+ (heading
+ "delete a contiguous group of display lists")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "list")))
+ (para "
+Specifies the integer name of the first display list to delete. "))
+ (entry (% (heading (var "range")))
+ (para "
+Specifies the number of display lists to delete. ")))
+ (heading "Description")
+ (para (code "glDeleteLists")
+ " causes a contiguous group of display lists to be deleted. "
+ (var "list")
+ " is the name of the first display list to be deleted,
+ and "
+ (var "range")
+ " is the number of display lists to delete.
+ All display lists "
+ (math (var "d"))
+ "
+with "
+ (math (var "list")
+ "<="
+ (var "d")
+ "<="
+ (var "list")
+ "+"
+ (var "range")
+ "-"
+ "1")
+ "
+are deleted. ")
+ (para "
+All storage locations allocated to the specified display lists are freed,
+ and the names are available for reuse at a later time.
+ Names within the range that do not have an associated display list are ignored.
+ If "
+ (var "range")
+ " is 0, nothing happens. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "range")
+ " is negative. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glDeleteLists")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glDeleteProgram
+ "glDeleteProgram"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glDeleteProgram"))
+ (paramdef "GLuint " (parameter "program"))))
+ '(*fragment*
+ (heading "Deletes a program object")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "program")))
+ (para "Specifies the program object to be
+\t\t deleted.")))
+ (heading "Description")
+ (para (code "glDeleteProgram")
+ " frees the memory and
+\tinvalidates the name associated with the program object
+\tspecified by "
+ (var "program.")
+ " This command
+\teffectively undoes the effects of a call to\t"
+ (code "glCreateProgram")
+ ".")
+ (para "If a program object is in use as part of current rendering
+\tstate, it will be flagged for deletion, but it will not be
+\tdeleted until it is no longer part of current state for any
+\trendering context. If a program object to be deleted has shader
+\tobjects attached to it, those shader objects will be
+\tautomatically detached but not deleted unless they have already
+\tbeen flagged for deletion by a previous call to\t"
+ (code "glDeleteShader")
+ ".
+\tA value of 0 for "
+ (var "program")
+ " will be silently
+\tignored.")
+ (para "To determine whether a program object has been flagged for
+\tdeletion, call\t"
+ (code "glGetProgram")
+ "
+with arguments "
+ (var "program")
+ " and\t"
+ (code "GL_DELETE_STATUS")
+ ".")
+ (heading "Errors")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if\t"
+ (var "program")
+ " is not a value generated by
+\tOpenGL.")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if\t"
+ (code "glDeleteProgram")
+ " is executed between the
+\texecution of\t"
+ (code "glBegin")
+ "
+and the corresponding execution of\t"
+ (code "glEnd")
+ ".")))
+
+(define-gl-procedure
+ glDeleteQueries
+ "glDeleteQueries"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glDeleteQueries"))
+ (paramdef "GLsizei " (parameter "n"))
+ (paramdef "const GLuint * " (parameter "ids"))))
+ '(*fragment*
+ (heading "delete named query objects")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "n")))
+ (para "
+Specifies the number of query objects to be deleted. "))
+ (entry (% (heading (var "ids")))
+ (para "
+Specifies an array of query objects to be deleted. ")))
+ (heading "Description")
+ (para (code "glDeleteQueries")
+ " deletes "
+ (var "n")
+ " query objects named by the elements of the array "
+ (var "ids")
+ ".
+ After a query object is deleted, it has no contents,
+ and its name is free for reuse (for example by "
+ (code "glGenQueries")
+ "). ")
+ (para (code "glDeleteQueries")
+ " silently ignores 0's and names that do not correspond to
+ existing query objects. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "n")
+ " is negative. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glDeleteQueries")
+ " is executed
+ between the execution of "
+ (code "glBegin")
+ " and the corresponding
+ execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glDeleteShader
+ "glDeleteShader"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glDeleteShader"))
+ (paramdef "GLuint " (parameter "shader"))))
+ '(*fragment*
+ (heading "Deletes a shader object")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "shader")))
+ (para "Specifies the shader object to be deleted.")))
+ (heading "Description")
+ (para (code "glDeleteShader")
+ " frees the memory and
+\tinvalidates the name associated with the shader object specified
+\tby "
+ (var "shader")
+ ". This command effectively
+\tundoes the effects of a call to\t"
+ (code "glCreateShader")
+ ".")
+ (para "If a shader object to be deleted is attached to a program
+\tobject, it will be flagged for deletion, but it will not be
+\tdeleted until it is no longer attached to any program object,
+\tfor any rendering context (i.e., it must be detached from
+\twherever it was attached before it will be deleted). A value of
+\t0 for "
+ (var "shader")
+ " will be silently
+\tignored.")
+ (para "To determine whether an object has been flagged for
+\tdeletion, call\t"
+ (code "glGetShader")
+ "
+with arguments "
+ (var "shader")
+ " and\t"
+ (code "GL_DELETE_STATUS")
+ ".")
+ (heading "Errors")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if\t"
+ (var "shader")
+ " is not a value generated by
+\tOpenGL.")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if\t"
+ (code "glDeleteShader")
+ " is executed between the
+\texecution of\t"
+ (code "glBegin")
+ "
+and the corresponding execution of\t"
+ (code "glEnd")
+ ".")))
+
+(define-gl-procedure
+ glDeleteTextures
+ "glDeleteTextures"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glDeleteTextures"))
+ (paramdef "GLsizei " (parameter "n"))
+ (paramdef
+ "const GLuint * "
+ (parameter "textures"))))
+ '(*fragment*
+ (heading "delete named textures")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "n")))
+ (para "
+Specifies the number of textures to be deleted. "))
+ (entry (% (heading (var "textures")))
+ (para "
+Specifies an array of textures to be deleted. ")))
+ (heading "Description")
+ (para (code "glDeleteTextures")
+ " deletes "
+ (var "n")
+ " textures named by the elements of the array "
+ (var "textures")
+ ".
+ After a texture is deleted, it has no contents or dimensionality,
+ and its name is free for reuse (for example by "
+ (code "glGenTextures")
+ ").
+ If a texture that is currently bound is deleted, the binding reverts
+ to 0 (the default texture). ")
+ (para (code "glDeleteTextures")
+ " silently ignores 0's and names that do not correspond to
+ existing textures. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "n")
+ " is negative. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glDeleteTextures")
+ " is executed
+ between the execution of "
+ (code "glBegin")
+ " and the corresponding
+ execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glDepthFunc
+ "glDepthFunc"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glDepthFunc"))
+ (paramdef "GLenum " (parameter "func"))))
+ '(*fragment*
+ (heading
+ "specify the value used for depth buffer comparisons")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "func")))
+ (para "
+Specifies the depth comparison function.
+ Symbolic constants "
+ (code "GL_NEVER")
+ ", "
+ (code "GL_LESS")
+ ", "
+ (code "GL_EQUAL")
+ ", "
+ (code "GL_LEQUAL")
+ ", "
+ (code "GL_GREATER")
+ ", "
+ (code "GL_NOTEQUAL")
+ ", "
+ (code "GL_GEQUAL")
+ ", and "
+ (code "GL_ALWAYS")
+ " are accepted.
+ The initial value is "
+ (code "GL_LESS")
+ ". ")))
+ (heading "Description")
+ (para (code "glDepthFunc")
+ " specifies the function used to compare each incoming pixel depth value
+ with the depth value present in the depth buffer.
+ The comparison is performed only if depth testing is enabled.
+ (See "
+ (code "glEnable")
+ " and "
+ (code "glDisable")
+ " of "
+ (code "GL_DEPTH_TEST")
+ ".) ")
+ (para (var "func")
+ " specifies the conditions under which the pixel will be drawn.
+ The comparison functions are as follows: ")
+ (table (% (formatter (asis)))
+ (entry (% (heading (code "GL_NEVER")))
+ (para "
+Never passes. "))
+ (entry (% (heading (code "GL_LESS")))
+ (para "
+Passes if the incoming depth value is less than the stored depth value. "))
+ (entry (% (heading (code "GL_EQUAL")))
+ (para "
+Passes if the incoming depth value is equal to the stored depth value. "))
+ (entry (% (heading (code "GL_LEQUAL")))
+ (para "
+Passes if the incoming depth value is less than or equal to
+ the stored depth value. "))
+ (entry (% (heading (code "GL_GREATER")))
+ (para "
+Passes if the incoming depth value is greater than the stored depth value. "))
+ (entry (% (heading (code "GL_NOTEQUAL")))
+ (para "
+Passes if the incoming depth value is not equal to the stored depth value. "))
+ (entry (% (heading (code "GL_GEQUAL")))
+ (para "
+Passes if the incoming depth value is greater than or equal to
+ the stored depth value. "))
+ (entry (% (heading (code "GL_ALWAYS")))
+ (para "
+Always passes. ")))
+ (para "
+The initial value of "
+ (var "func")
+ " is "
+ (code "GL_LESS")
+ ".
+ Initially, depth testing is disabled. If depth testing is disabled or if no
+ depth buffer exists, it is as if the depth test always passes. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "func")
+ " is not an accepted value. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glDepthFunc")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glDepthMask
+ "glDepthMask"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glDepthMask"))
+ (paramdef "GLboolean " (parameter "flag"))))
+ '(*fragment*
+ (heading
+ "enable or disable writing into the depth buffer")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "flag")))
+ (para "
+Specifies whether the depth buffer is enabled for writing.
+ If "
+ (var "flag")
+ " is "
+ (code "GL_FALSE")
+ ",
+ depth buffer writing is disabled.
+ Otherwise, it is enabled.
+ Initially, depth buffer writing is enabled. ")))
+ (heading "Description")
+ (para (code "glDepthMask")
+ " specifies whether the depth buffer is enabled for writing.
+ If "
+ (var "flag")
+ " is "
+ (code "GL_FALSE")
+ ",
+ depth buffer writing is disabled.
+ Otherwise, it is enabled.
+ Initially, depth buffer writing is enabled. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glDepthMask")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glDepthRange
+ "glDepthRange"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glDepthRange"))
+ (paramdef "GLclampd " (parameter "nearVal"))
+ (paramdef "GLclampd " (parameter "farVal"))))
+ '(*fragment*
+ (heading
+ "specify mapping of depth values from normalized device coordinates to window coordinates")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "nearVal")))
+ (para "
+Specifies the mapping of the near clipping plane to window coordinates.
+ The initial value is 0. "))
+ (entry (% (heading (var "farVal")))
+ (para "
+Specifies the mapping of the far clipping plane to window coordinates.
+ The initial value is 1. ")))
+ (heading "Description")
+ (para "
+After clipping and division by "
+ (var "w")
+ ",
+ depth coordinates range from "
+ (math "-1")
+ "
+to 1,
+ corresponding to the near and far clipping planes. "
+ (code "glDepthRange")
+ " specifies a linear mapping of the normalized depth coordinates
+ in this range to window depth coordinates.
+ Regardless of the actual depth buffer implementation,
+ window coordinate depth values are treated as though they range
+ from 0 through 1 (like color components).
+ Thus,
+ the values accepted by "
+ (code "glDepthRange")
+ " are both clamped to this range
+ before they are accepted. ")
+ (para "
+The setting of (0,1) maps the near plane to 0 and
+ the far plane to 1.
+ With this mapping,
+ the depth buffer range is fully utilized. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glDepthRange")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glDetachShader
+ "glDetachShader"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glDetachShader"))
+ (paramdef "GLuint " (parameter "program"))
+ (paramdef "GLuint " (parameter "shader"))))
+ '(*fragment*
+ (heading
+ "Detaches a shader object from a program object to which it is attached")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "program")))
+ (para "Specifies the program object from which to
+\t\t detach the shader object."))
+ (entry (% (heading (var "shader")))
+ (para "Specifies the shader object to be
+\t\t detached.")))
+ (heading "Description")
+ (para (code "glDetachShader")
+ " detaches the shader
+\tobject specified by "
+ (var "shader")
+ " from the
+\tprogram object specified by "
+ (var "program")
+ ". This
+\tcommand can be used to undo the effect of the command\t"
+ (code "glAttachShader")
+ ".")
+ (para "If "
+ (var "shader")
+ " has already been flagged
+\tfor deletion by a call to\t"
+ (code "glDeleteShader")
+ "
+and it is not attached to any other program object, it will be
+\tdeleted after it has been detached.")
+ (heading "Errors")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if either\t"
+ (var "program")
+ " or "
+ (var "shader")
+ "
+is a value that was not generated by OpenGL.")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if\t"
+ (var "program")
+ " is not a program object.")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if\t"
+ (var "shader")
+ " is not a shader object.")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if\t"
+ (var "shader")
+ " is not attached to\t"
+ (var "program")
+ ".")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if\t"
+ (code "glDetachShader")
+ " is executed between the
+\texecution of\t"
+ (code "glBegin")
+ "
+and the corresponding execution of\t"
+ (code "glEnd")
+ ".")))
+
+(define-gl-procedure
+ glDrawArrays
+ "glDrawArrays"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glDrawArrays"))
+ (paramdef "GLenum " (parameter "mode"))
+ (paramdef "GLint " (parameter "first"))
+ (paramdef "GLsizei " (parameter "count"))))
+ '(*fragment*
+ (heading "render primitives from array data")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "mode")))
+ (para "
+Specifies what kind of primitives to render.
+ Symbolic constants "
+ (code "GL_POINTS")
+ ", "
+ (code "GL_LINE_STRIP")
+ ", "
+ (code "GL_LINE_LOOP")
+ ", "
+ (code "GL_LINES")
+ ", "
+ (code "GL_TRIANGLE_STRIP")
+ ", "
+ (code "GL_TRIANGLE_FAN")
+ ", "
+ (code "GL_TRIANGLES")
+ ", "
+ (code "GL_QUAD_STRIP")
+ ", "
+ (code "GL_QUADS")
+ ",
+ and "
+ (code "GL_POLYGON")
+ " are accepted. "))
+ (entry (% (heading (var "first")))
+ (para "
+Specifies the starting index in the enabled arrays. "))
+ (entry (% (heading (var "count")))
+ (para "
+Specifies the number of indices to be rendered. ")))
+ (heading "Description")
+ (para (code "glDrawArrays")
+ " specifies multiple geometric primitives
+ with very few subroutine calls. Instead of calling a GL procedure
+ to pass each individual vertex, normal, texture coordinate, edge
+ flag, or color, you can prespecify
+ separate arrays of vertices, normals, and colors and use them to
+ construct a sequence of primitives with a single
+ call to "
+ (code "glDrawArrays")
+ ". ")
+ (para "
+When "
+ (code "glDrawArrays")
+ " is called, it uses "
+ (var "count")
+ " sequential elements from each
+ enabled array to construct a sequence of geometric primitives,
+ beginning with element "
+ (var "first")
+ ". "
+ (var "mode")
+ " specifies what kind of
+ primitives are constructed and how the array elements
+ construct those primitives. If "
+ (code "GL_VERTEX_ARRAY")
+ " is not enabled, no
+ geometric primitives are generated. ")
+ (para "
+Vertex attributes that are modified by "
+ (code "glDrawArrays")
+ " have an
+ unspecified value after "
+ (code "glDrawArrays")
+ " returns. For example, if "
+ (code "GL_COLOR_ARRAY")
+ " is enabled, the value of the current color is
+ undefined after "
+ (code "glDrawArrays")
+ " executes. Attributes that aren't
+ modified remain well defined. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "mode")
+ " is not an accepted value. ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "count")
+ " is negative. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a non-zero buffer object name is bound to an
+ enabled array and the buffer object's data store is currently mapped. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glDrawArrays")
+ " is executed between
+ the execution of "
+ (code "glBegin")
+ " and the corresponding "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glDrawBuffers
+ "glDrawBuffers"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glDrawBuffers"))
+ (paramdef "GLsizei " (parameter "n"))
+ (paramdef "const GLenum *" (parameter "bufs"))))
+ '(*fragment*
+ (heading
+ "Specifies a list of color buffers to be drawn into")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "n")))
+ (para "Specifies the number of buffers in "
+ (var "bufs")
+ "."))
+ (entry (% (heading (var "bufs")))
+ (para "Points to an array of symbolic constants
+\t\t specifying the buffers into which fragment colors or
+\t\t data values will be written.")))
+ (heading "Description")
+ (para (code "glDrawBuffers")
+ " defines an array of
+\tbuffers into which fragment color values or fragment data will
+\tbe written. If no fragment shader is active, rendering
+\toperations will generate only one fragment color per fragment
+\tand it will be written into each of the buffers specified by\t"
+ (var "bufs")
+ ". If a fragment shader is active and
+\tit writes a value to the output variable\t"
+ (code "gl_FragColor")
+ ", then that value will be
+\twritten into each of the buffers specified by\t"
+ (var "bufs")
+ ". If a fragment shader is active and
+\tit writes a value to one or more elements of the output array
+\tvariable "
+ (code "gl_FragData[]")
+ ", then the value of\t"
+ (code "gl_FragData[0] ")
+ " will be written into the
+\tfirst buffer specified by "
+ (var "bufs")
+ ", the value
+\tof "
+ (code "gl_FragData[1] ")
+ " will be written into the
+\tsecond buffer specified by "
+ (var "bufs")
+ ", and so
+\ton up to "
+ (code "gl_FragData[n-1]")
+ ". The draw buffer
+\tused for "
+ (code "gl_FragData[n]")
+ " and beyond is
+\timplicitly set to be "
+ (code "GL_NONE")
+ ".")
+ (para "The symbolic constants contained in\t"
+ (var "bufs")
+ " may be any of the following:")
+ (table (% (formatter (asis)))
+ (entry (% (heading (code "GL_NONE")))
+ (para "The fragment color/data value is not written into
+\t\t any color buffer."))
+ (entry (% (heading (code "GL_FRONT_LEFT")))
+ (para "The fragment color/data value is written into the
+\t\t front left color buffer."))
+ (entry (% (heading (code "GL_FRONT_RIGHT")))
+ (para "The fragment color/data value is written into the
+\t\t front right color buffer."))
+ (entry (% (heading (code "GL_BACK_LEFT")))
+ (para "The fragment color/data value is written into the
+\t\t back left color buffer."))
+ (entry (% (heading (code "GL_BACK_RIGHT")))
+ (para "The fragment color/data value is written into the
+\t\t back right color buffer."))
+ (entry (% (heading (code "GL_AUXi")))
+ (para "The fragment color/data value is written into
+\t\t auxiliary buffer "
+ (code "i")
+ ".")))
+ (para "Except for "
+ (code "GL_NONE")
+ ", the preceding
+\tsymbolic constants may not appear more than once in\t"
+ (var "bufs")
+ ". The maximum number of draw buffers
+\tsupported is implementation dependent and can be queried by
+\tcalling\t"
+ (code "glGet")
+ "
+with the argument "
+ (code "GL_MAX_DRAW_BUFFERS")
+ ". The
+\tnumber of auxiliary buffers can be queried by calling\t"
+ (code "glGet")
+ "
+with the argument "
+ (code "GL_AUX_BUFFERS")
+ ".")
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if one of the
+\tvalues in "
+ (var "bufs")
+ " is not an accepted
+\tvalue.")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if\t"
+ (var "n")
+ " is less than 0.")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a
+\tsymbolic constant other than "
+ (code "GL_NONE")
+ "
+appears more than once in "
+ (var "bufs")
+ ".")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if any of
+\tthe entries in "
+ (var "bufs")
+ " (other than\t"
+ (code "GL_NONE")
+ " ) indicates a color buffer that
+\tdoes not exist in the current GL context.")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if\t"
+ (var "n")
+ " is greater than\t"
+ (code "GL_MAX_DRAW_BUFFERS")
+ ".")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if\t"
+ (code "glDrawBuffers")
+ " is executed between the
+\texecution of\t"
+ (code "glBegin")
+ "
+and the corresponding execution of\t"
+ (code "glEnd")
+ ".")))
+
+(define-gl-procedure
+ glDrawBuffer
+ "glDrawBuffer"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glDrawBuffer"))
+ (paramdef "GLenum " (parameter "mode"))))
+ '(*fragment*
+ (heading
+ "specify which color buffers are to be drawn into")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "mode")))
+ (para "
+Specifies up to four color buffers to be drawn into.
+ Symbolic constants "
+ (code "GL_NONE")
+ ", "
+ (code "GL_FRONT_LEFT")
+ ", "
+ (code "GL_FRONT_RIGHT")
+ ", "
+ (code "GL_BACK_LEFT")
+ ", "
+ (code "GL_BACK_RIGHT")
+ ", "
+ (code "GL_FRONT")
+ ", "
+ (code "GL_BACK")
+ ", "
+ (code "GL_LEFT")
+ ", "
+ (code "GL_RIGHT")
+ ", "
+ (code "GL_FRONT_AND_BACK")
+ ", and "
+ (code "GL_AUX")
+ (var "i")
+ ",
+ where "
+ (var "i")
+ " is between 0 and the value of "
+ (code "GL_AUX_BUFFERS")
+ " minus 1,
+ are accepted. ("
+ (code "GL_AUX_BUFFERS")
+ " is not the upper limit; use "
+ (code "glGet")
+ "
+to query the number of available aux buffers.)
+ The initial value is "
+ (code "GL_FRONT")
+ " for single-buffered contexts,
+ and "
+ (code "GL_BACK")
+ " for double-buffered contexts. ")))
+ (heading "Description")
+ (para "
+When colors are written to the frame buffer,
+ they are written into the color buffers specified by "
+ (code "glDrawBuffer")
+ ".
+ The specifications are as follows: ")
+ (table (% (formatter (asis)))
+ (entry (% (heading (code "GL_NONE")))
+ (para "
+No color buffers are written. "))
+ (entry (% (heading (code "GL_FRONT_LEFT")))
+ (para "
+Only the front left color buffer is written. "))
+ (entry (% (heading (code "GL_FRONT_RIGHT")))
+ (para "
+Only the front right color buffer is written. "))
+ (entry (% (heading (code "GL_BACK_LEFT")))
+ (para "
+Only the back left color buffer is written. "))
+ (entry (% (heading (code "GL_BACK_RIGHT")))
+ (para "
+Only the back right color buffer is written. "))
+ (entry (% (heading (code "GL_FRONT")))
+ (para "
+Only the front left and front right color buffers are written.
+ If there is no front right color buffer,
+ only the front left color buffer is written. "))
+ (entry (% (heading (code "GL_BACK")))
+ (para "
+Only the back left and back right color buffers are written.
+ If there is no back right color buffer,
+ only the back left color buffer is written. "))
+ (entry (% (heading (code "GL_LEFT")))
+ (para "
+Only the front left and back left color buffers are written.
+ If there is no back left color buffer,
+ only the front left color buffer is written. "))
+ (entry (% (heading (code "GL_RIGHT")))
+ (para "
+Only the front right and back right color buffers are written.
+ If there is no back right color buffer,
+ only the front right color buffer is written. "))
+ (entry (% (heading (code "GL_FRONT_AND_BACK")))
+ (para "
+All the front and back color buffers
+ (front left, front right, back left, back right)
+ are written.
+ If there are no back color buffers,
+ only the front left and front right color buffers are written.
+ If there are no right color buffers,
+ only the front left and back left color buffers are written.
+ If there are no right or back color buffers,
+ only the front left color buffer is written. "))
+ (entry (% (heading (code "GL_AUX") (var "i")))
+ (para "
+Only auxiliary color buffer "
+ (var "i")
+ " is written. ")))
+ (para "
+If more than one color buffer is selected for drawing,
+ then blending or logical operations are computed and applied independently
+ for each color buffer and can produce different results in each buffer. ")
+ (para "
+Monoscopic contexts include only "
+ (var "left")
+ "
+buffers, and stereoscopic contexts include both "
+ (var "left")
+ "
+and "
+ (var "right")
+ "
+buffers.
+ Likewise, single-buffered contexts include only "
+ (var "front")
+ "
+buffers, and double-buffered contexts include both "
+ (var "front")
+ "
+and "
+ (var "back")
+ "
+buffers.
+ The context is selected at GL initialization. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "mode")
+ " is not an accepted value. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if none of the buffers indicated
+ by "
+ (var "mode")
+ " exists. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glDrawBuffer")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glDrawElements
+ "glDrawElements"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glDrawElements"))
+ (paramdef "GLenum " (parameter "mode"))
+ (paramdef "GLsizei " (parameter "count"))
+ (paramdef "GLenum " (parameter "type"))
+ (paramdef
+ "const GLvoid * "
+ (parameter "indices"))))
+ '(*fragment*
+ (heading "render primitives from array data")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "mode")))
+ (para "
+Specifies what kind of primitives to render.
+ Symbolic constants "
+ (code "GL_POINTS")
+ ", "
+ (code "GL_LINE_STRIP")
+ ", "
+ (code "GL_LINE_LOOP")
+ ", "
+ (code "GL_LINES")
+ ", "
+ (code "GL_TRIANGLE_STRIP")
+ ", "
+ (code "GL_TRIANGLE_FAN")
+ ", "
+ (code "GL_TRIANGLES")
+ ", "
+ (code "GL_QUAD_STRIP")
+ ", "
+ (code "GL_QUADS")
+ ",
+ and "
+ (code "GL_POLYGON")
+ " are accepted. "))
+ (entry (% (heading (var "count")))
+ (para "
+Specifies the number of elements to be rendered. "))
+ (entry (% (heading (var "type")))
+ (para "
+Specifies the type of the values in "
+ (var "indices")
+ ". Must be one of "
+ (code "GL_UNSIGNED_BYTE")
+ ", "
+ (code "GL_UNSIGNED_SHORT")
+ ", or "
+ (code "GL_UNSIGNED_INT")
+ ". "))
+ (entry (% (heading (var "indices")))
+ (para "
+Specifies a pointer to the location where the indices are stored. ")))
+ (heading "Description")
+ (para (code "glDrawElements")
+ " specifies multiple geometric primitives
+ with very few subroutine calls. Instead of calling a GL function
+ to pass each individual vertex, normal, texture coordinate, edge
+ flag, or color, you can prespecify
+ separate arrays of vertices, normals, and so on, and use them to
+ construct a sequence of primitives with a single
+ call to "
+ (code "glDrawElements")
+ ". ")
+ (para "
+When "
+ (code "glDrawElements")
+ " is called, it uses "
+ (var "count")
+ " sequential elements from an
+ enabled array, starting at "
+ (var "indices")
+ " to construct a sequence of
+ geometric primitives. "
+ (var "mode")
+ " specifies what kind of primitives are
+ constructed and how the array elements construct these primitives. If
+ more than one array is enabled, each is used. If "
+ (code "GL_VERTEX_ARRAY")
+ " is not enabled, no geometric primitives are
+ constructed. ")
+ (para "
+Vertex attributes that are modified by "
+ (code "glDrawElements")
+ " have an
+ unspecified value after "
+ (code "glDrawElements")
+ " returns. For example, if "
+ (code "GL_COLOR_ARRAY")
+ " is enabled, the value of the current color is
+ undefined after "
+ (code "glDrawElements")
+ " executes. Attributes that aren't
+ modified maintain their previous values. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "mode")
+ " is not an accepted value. ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "count")
+ " is negative. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a non-zero buffer object name is bound to an
+ enabled array or the element array and the buffer object's data store is currently mapped. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glDrawElements")
+ " is executed between
+ the execution of "
+ (code "glBegin")
+ " and the corresponding "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glDrawPixels
+ "glDrawPixels"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glDrawPixels"))
+ (paramdef "GLsizei " (parameter "width"))
+ (paramdef "GLsizei " (parameter "height"))
+ (paramdef "GLenum " (parameter "format"))
+ (paramdef "GLenum " (parameter "type"))
+ (paramdef "const GLvoid * " (parameter "data"))))
+ '(*fragment*
+ (heading
+ "write a block of pixels to the frame buffer")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "width")))
+ (itemx (var "height"))
+ (para "
+Specify the dimensions of the pixel rectangle to be written
+ into the frame buffer. "))
+ (entry (% (heading (var "format")))
+ (para "
+Specifies the format of the pixel data.
+ Symbolic constants "
+ (code "GL_COLOR_INDEX")
+ ", "
+ (code "GL_STENCIL_INDEX")
+ ", "
+ (code "GL_DEPTH_COMPONENT")
+ ", "
+ (code "GL_RGB")
+ ", "
+ (code "GL_BGR")
+ ", "
+ (code "GL_RGBA")
+ ", "
+ (code "GL_BGRA")
+ ", "
+ (code "GL_RED")
+ ", "
+ (code "GL_GREEN")
+ ", "
+ (code "GL_BLUE")
+ ", "
+ (code "GL_ALPHA")
+ ", "
+ (code "GL_LUMINANCE")
+ ", and "
+ (code "GL_LUMINANCE_ALPHA")
+ " are accepted. "))
+ (entry (% (heading (var "type")))
+ (para "
+Specifies the data type for "
+ (var "data")
+ ".
+ Symbolic constants "
+ (code "GL_UNSIGNED_BYTE")
+ ", "
+ (code "GL_BYTE")
+ ", "
+ (code "GL_BITMAP")
+ ", "
+ (code "GL_UNSIGNED_SHORT")
+ ", "
+ (code "GL_SHORT")
+ ", "
+ (code "GL_UNSIGNED_INT")
+ ", "
+ (code "GL_INT")
+ ", "
+ (code "GL_FLOAT")
+ ", "
+ (code "GL_UNSIGNED_BYTE_3_3_2")
+ ", "
+ (code "GL_UNSIGNED_BYTE_2_3_3_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_6_5")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_6_5_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_4_4_4_4")
+ ", "
+ (code "GL_UNSIGNED_SHORT_4_4_4_4_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_5_5_1")
+ ", "
+ (code "GL_UNSIGNED_SHORT_1_5_5_5_REV")
+ ", "
+ (code "GL_UNSIGNED_INT_8_8_8_8")
+ ", "
+ (code "GL_UNSIGNED_INT_8_8_8_8_REV")
+ ", "
+ (code "GL_UNSIGNED_INT_10_10_10_2")
+ ", and "
+ (code "GL_UNSIGNED_INT_2_10_10_10_REV")
+ "
+are accepted. "))
+ (entry (% (heading (var "data")))
+ (para "
+Specifies a pointer to the pixel data. ")))
+ (heading "Description")
+ (para (code "glDrawPixels")
+ " reads pixel data from memory and writes it into the frame buffer
+ relative to the current raster position, provided that the raster
+ position is valid. Use "
+ (code "glRasterPos")
+ " or "
+ (code "glWindowPos")
+ " to set the current raster position; use "
+ (code "glGet")
+ " with argument "
+ (code "GL_CURRENT_RASTER_POSITION_VALID")
+ "
+to determine if the specified raster position is valid, and "
+ (code "glGet")
+ " with argument "
+ (code "GL_CURRENT_RASTER_POSITION")
+ "
+to query the raster position. ")
+ (para "
+Several parameters define the encoding of pixel data in memory
+ and control the processing of the pixel data
+ before it is placed in the frame buffer.
+ These parameters are set with four commands: "
+ (code "glPixelStore")
+ ", "
+ (code "glPixelTransfer")
+ ", "
+ (code "glPixelMap")
+ ", and "
+ (code "glPixelZoom")
+ ".
+ This reference page describes the effects on "
+ (code "glDrawPixels")
+ " of many,
+ but not all, of the parameters specified by these four commands. ")
+ (para "
+Data is read from "
+ (var "data")
+ " as a sequence of signed or unsigned bytes,
+ signed or unsigned shorts, signed or unsigned integers, or
+ single-precision floating-point values, depending on "
+ (var "type")
+ ".
+ When "
+ (var "type")
+ " is one of "
+ (code "GL_UNSIGNED_BYTE")
+ ", "
+ (code "GL_BYTE")
+ ", "
+ (code "GL_UNSIGNED_SHORT")
+ ", "
+ (code "GL_SHORT")
+ ", "
+ (code "GL_UNSIGNED_INT")
+ ", "
+ (code "GL_INT")
+ ", or "
+ (code "GL_FLOAT")
+ " each of these bytes, shorts, integers, or
+ floating-point values is interpreted as one color or depth component, or
+ one index, depending on "
+ (var "format")
+ ".
+ When "
+ (var "type")
+ " is one of "
+ (code "GL_UNSIGNED_BYTE_3_3_2")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_6_5")
+ ", "
+ (code "GL_UNSIGNED_SHORT_4_4_4_4")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_5_5_1")
+ ", "
+ (code "GL_UNSIGNED_INT_8_8_8_8")
+ ", or "
+ (code "GL_UNSIGNED_INT_10_10_10_2")
+ ", each unsigned value is interpreted as
+ containing all the components for a single pixel, with the color
+ components arranged according to "
+ (var "format")
+ ".
+ When "
+ (var "type")
+ " is one of "
+ (code "GL_UNSIGNED_BYTE_2_3_3_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_6_5_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_4_4_4_4_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_1_5_5_5_REV")
+ ", "
+ (code "GL_UNSIGNED_INT_8_8_8_8_REV")
+ ", or "
+ (code "GL_UNSIGNED_INT_2_10_10_10_REV")
+ ", each unsigned value is interpreted
+ as containing all color components, specified by "
+ (var "format")
+ ", for a single
+ pixel in a reversed order. Indices are always treated individually.
+ Color components are treated as groups of one, two, three, or four
+ values, again based on "
+ (var "format")
+ ". Both individual indices and groups of
+ components are referred to as pixels.
+ If "
+ (var "type")
+ " is "
+ (code "GL_BITMAP")
+ ", the data must be unsigned bytes, and "
+ (var "format")
+ " must be either "
+ (code "GL_COLOR_INDEX")
+ " or "
+ (code "GL_STENCIL_INDEX")
+ ".
+ Each unsigned byte is treated as eight 1-bit pixels, with bit ordering
+ determined by "
+ (code "GL_UNPACK_LSB_FIRST")
+ " (see "
+ (code "glPixelStore")
+ "). ")
+ (para (math (var "width") "×" (var "height"))
+ "
+pixels are read from memory,
+ starting at location "
+ (var "data")
+ ".
+ By default, these pixels are taken from adjacent memory locations,
+ except that after all "
+ (var "width")
+ " pixels are read,
+ the read pointer is advanced to the next four-byte boundary.
+ The four-byte row alignment is specified by "
+ (code "glPixelStore")
+ " with
+ argument "
+ (code "GL_UNPACK_ALIGNMENT")
+ ",
+ and it can be set to one, two, four, or eight bytes.
+ Other pixel store parameters specify different read pointer advancements,
+ both before the first pixel is read
+ and after all "
+ (var "width")
+ " pixels are read.
+ See the "
+ (code "glPixelStore")
+ " reference page for details on these options. ")
+ (para "
+If a non-zero named buffer object is bound to the "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ " target
+ (see "
+ (code "glBindBuffer")
+ ") while a block of pixels is
+ specified, "
+ (var "data")
+ " is treated as a byte offset into the buffer object's data store. ")
+ (para "
+The "
+ (math (var "width") "×" (var "height"))
+ "
+pixels that are read from memory are
+ each operated on in the same way,
+ based on the values of several parameters specified by "
+ (code "glPixelTransfer")
+ "
+and "
+ (code "glPixelMap")
+ ".
+ The details of these operations,
+ as well as the target buffer into which the pixels are drawn,
+ are specific to the format of the pixels,
+ as specified by "
+ (var "format")
+ ". "
+ (var "format")
+ " can assume one of 13 symbolic values: ")
+ (table (% (formatter (asis)))
+ (entry (% (heading (code "GL_COLOR_INDEX")))
+ (para "
+Each pixel is a single value,
+ a color index.
+ It is converted to fixed-point format,
+ with an unspecified number of bits to the right of the binary point,
+ regardless of the memory data type.
+ Floating-point values convert to true fixed-point values.
+ Signed and unsigned integer data is converted with all fraction bits
+ set to 0.
+ Bitmap data convert to either 0 or 1. ")
+ (para "
+Each fixed-point index is then shifted left by "
+ (code "GL_INDEX_SHIFT")
+ " bits
+ and added to "
+ (code "GL_INDEX_OFFSET")
+ ".
+ If "
+ (code "GL_INDEX_SHIFT")
+ " is negative,
+ the shift is to the right.
+ In either case, zero bits fill otherwise unspecified bit locations in the
+ result. ")
+ (para "
+If the GL is in RGBA mode,
+ the resulting index is converted to an RGBA pixel
+ with the help of the "
+ (code "GL_PIXEL_MAP_I_TO_R")
+ ", "
+ (code "GL_PIXEL_MAP_I_TO_G")
+ ", "
+ (code "GL_PIXEL_MAP_I_TO_B")
+ ",
+ and "
+ (code "GL_PIXEL_MAP_I_TO_A")
+ " tables.
+ If the GL is in color index mode,
+ and if "
+ (code "GL_MAP_COLOR")
+ " is true,
+ the index is replaced with the value that it references in lookup table "
+ (code "GL_PIXEL_MAP_I_TO_I")
+ ".
+ Whether the lookup replacement of the index is done or not,
+ the integer part of the index is then ANDed with "
+ (math "2" "^" (var "b") "-" "1")
+ ",
+ where "
+ (math (var "b"))
+ "
+is the number of bits in a color index buffer. ")
+ (para "
+The GL then converts the resulting indices or RGBA colors to fragments
+ by attaching the current raster position "
+ (var "z")
+ " coordinate and
+ texture coordinates to each pixel,
+ then assigning "
+ (math (var "x"))
+ "
+and "
+ (math (var "y"))
+ "
+window coordinates to the "
+ (math (var "n"))
+ "th
+ fragment such that "
+ (math (var "x")
+ "_"
+ (var "n")
+ "="
+ (var "x")
+ "_"
+ (var "r")
+ "+"
+ (var "n")
+ "%"
+ (var "width"))
+ (para (math (var "y")
+ "_"
+ (var "n")
+ "="
+ (var "y")
+ "_"
+ (var "r")
+ "+"
+ "⌊"
+ (var "n")
+ "/"
+ (var "width")
+ ","
+ "⌋"))
+ (para))
+ (para "
+where "
+ (math "("
+ (var "x")
+ "_"
+ (var "r")
+ ","
+ (var "y")
+ "_"
+ (var "r")
+ ")")
+ "
+is the current raster position.
+ These pixel fragments are then treated just like the fragments generated by
+ rasterizing points, lines, or polygons.
+ Texture mapping,
+ fog,
+ and all the fragment operations are applied before the fragments are written
+ to the frame buffer. "))
+ (entry (% (heading (code "GL_STENCIL_INDEX")))
+ (para "
+Each pixel is a single value,
+ a stencil index.
+ It is converted to fixed-point format,
+ with an unspecified number of bits to the right of the binary point,
+ regardless of the memory data type.
+ Floating-point values convert to true fixed-point values.
+ Signed and unsigned integer data is converted with all fraction bits
+ set to 0.
+ Bitmap data convert to either 0 or 1. ")
+ (para "
+Each fixed-point index is then shifted left by "
+ (code "GL_INDEX_SHIFT")
+ " bits,
+ and added to "
+ (code "GL_INDEX_OFFSET")
+ ".
+ If "
+ (code "GL_INDEX_SHIFT")
+ " is negative,
+ the shift is to the right.
+ In either case, zero bits fill otherwise unspecified bit locations in the
+ result.
+ If "
+ (code "GL_MAP_STENCIL")
+ " is true,
+ the index is replaced with the value that it references in lookup table "
+ (code "GL_PIXEL_MAP_S_TO_S")
+ ".
+ Whether the lookup replacement of the index is done or not,
+ the integer part of the index is then ANDed with "
+ (math "2" "^" (var "b") "-" "1")
+ ",
+ where "
+ (math (var "b"))
+ "
+is the number of bits in the stencil buffer.
+ The resulting stencil indices are then written to the stencil buffer
+ such that the "
+ (math (var "n"))
+ "th
+ index is written to location ")
+ (para (math (var "x")
+ "_"
+ (var "n")
+ "="
+ (var "x")
+ "_"
+ (var "r")
+ "+"
+ (var "n")
+ "%"
+ (var "width"))
+ (para (math (var "y")
+ "_"
+ (var "n")
+ "="
+ (var "y")
+ "_"
+ (var "r")
+ "+"
+ "⌊"
+ (var "n")
+ "/"
+ (var "width")
+ ","
+ "⌋")))
+ (para "
+where "
+ (math "("
+ (var "x")
+ "_"
+ (var "r")
+ ","
+ (var "y")
+ "_"
+ (var "r")
+ ")")
+ "
+is the current raster position.
+ Only the pixel ownership test,
+ the scissor test,
+ and the stencil writemask affect these write operations. "))
+ (entry (% (heading (code "GL_DEPTH_COMPONENT")))
+ (para "
+Each pixel is a single-depth component.
+ Floating-point data is converted directly to an internal floating-point
+ format with unspecified precision.
+ Signed integer data is mapped linearly to the internal floating-point
+ format such that the most positive representable integer value maps to 1.0,
+ and the most negative representable value maps to "
+ (math "-1.0")
+ ".
+ Unsigned integer data is mapped similarly:
+ the largest integer value maps to 1.0,
+ and 0 maps to 0.0.
+ The resulting floating-point depth value is then multiplied
+ by "
+ (code "GL_DEPTH_SCALE")
+ " and added to "
+ (code "GL_DEPTH_BIAS")
+ ".
+ The result is clamped to the range "
+ (math "[" "0" "," "1" "]")
+ ". ")
+ (para "
+The GL then converts the resulting depth components to fragments
+ by attaching the current raster position color or color index and
+ texture coordinates to each pixel,
+ then assigning "
+ (math (var "x"))
+ "
+and "
+ (math (var "y"))
+ "
+window coordinates to the "
+ (math (var "n"))
+ "th
+ fragment such that ")
+ (para (math (var "x")
+ "_"
+ (var "n")
+ "="
+ (var "x")
+ "_"
+ (var "r")
+ "+"
+ (var "n")
+ "%"
+ (var "width"))
+ (para (math (var "y")
+ "_"
+ (var "n")
+ "="
+ (var "y")
+ "_"
+ (var "r")
+ "+"
+ "⌊"
+ (var "n")
+ "/"
+ (var "width")
+ ","
+ "⌋")))
+ (para "
+where "
+ (math "("
+ (var "x")
+ "_"
+ (var "r")
+ ","
+ (var "y")
+ "_"
+ (var "r")
+ ")")
+ "
+is the current raster position.
+ These pixel fragments are then treated just like the fragments generated by
+ rasterizing points, lines, or polygons.
+ Texture mapping,
+ fog,
+ and all the fragment operations are applied before the fragments are written
+ to the frame buffer. "))
+ (entry (% (heading (code "GL_RGBA"))))
+ (entry (% (heading (code "GL_BGRA")))
+ (para "
+Each pixel is a four-component group: For "
+ (code "GL_RGBA")
+ ", the red
+ component is first, followed by green, followed by blue, followed by
+ alpha; for "
+ (code "GL_BGRA")
+ " the order is blue, green, red and then alpha.
+ Floating-point values are converted directly to an internal floating-point
+ format with unspecified precision.
+ Signed integer values are mapped linearly to the internal floating-point
+ format such that the most positive representable integer value maps to 1.0,
+ and the most negative representable value maps to "
+ (math "-1.0")
+ ".
+ (Note that
+ this mapping does not convert 0 precisely to 0.0.)
+ Unsigned integer data is mapped similarly:
+ The largest integer value maps to 1.0,
+ and 0 maps to 0.0.
+ The resulting floating-point color values are then multiplied
+ by "
+ (code "GL_c_SCALE")
+ " and added to "
+ (code "GL_c_BIAS")
+ ",
+ where "
+ (var "c")
+ " is RED, GREEN, BLUE, and ALPHA
+ for the respective color components.
+ The results are clamped to the range "
+ (math "[" "0" "," "1" "]")
+ ". ")
+ (para "
+If "
+ (code "GL_MAP_COLOR")
+ " is true,
+ each color component is scaled by the size of lookup table "
+ (code "GL_PIXEL_MAP_c_TO_c")
+ ",
+ then replaced by the value that it references in that table. "
+ (var "c")
+ " is R, G, B, or A respectively. ")
+ (para "
+The GL then converts the resulting RGBA colors to fragments
+ by attaching the current raster position "
+ (var "z")
+ " coordinate and
+ texture coordinates to each pixel,
+ then assigning "
+ (math (var "x"))
+ "
+and "
+ (math (var "y"))
+ "
+window coordinates to the "
+ (math (var "n"))
+ "th
+ fragment such that ")
+ (para (math (var "x")
+ "_"
+ (var "n")
+ "="
+ (var "x")
+ "_"
+ (var "r")
+ "+"
+ (var "n")
+ "%"
+ (var "width"))
+ (para (math (var "y")
+ "_"
+ (var "n")
+ "="
+ (var "y")
+ "_"
+ (var "r")
+ "+"
+ "⌊"
+ (var "n")
+ "/"
+ (var "width")
+ ","
+ "⌋")))
+ (para "
+where "
+ (math "("
+ (var "x")
+ "_"
+ (var "r")
+ ","
+ (var "y")
+ "_"
+ (var "r")
+ ")")
+ "
+is the current raster position.
+ These pixel fragments are then treated just like the fragments generated by
+ rasterizing points, lines, or polygons.
+ Texture mapping,
+ fog,
+ and all the fragment operations are applied before the fragments are written
+ to the frame buffer. "))
+ (entry (% (heading (code "GL_RED")))
+ (para "
+Each pixel is a single red component.
+ This component is converted to the internal floating-point format in
+ the same way the red component of an RGBA pixel is. It is
+ then converted to an RGBA pixel with green and blue set to 0,
+ and alpha set to 1.
+ After this conversion, the pixel is treated as if it had been read
+ as an RGBA pixel. "))
+ (entry (% (heading (code "GL_GREEN")))
+ (para "
+Each pixel is a single green component.
+ This component is converted to the internal floating-point format in
+ the same way the green component of an RGBA pixel is.
+ It is then converted to an RGBA pixel with red and blue set to 0,
+ and alpha set to 1.
+ After this conversion, the pixel is treated as if it had been read
+ as an RGBA pixel. "))
+ (entry (% (heading (code "GL_BLUE")))
+ (para "
+Each pixel is a single blue component.
+ This component is converted to the internal floating-point format in
+ the same way the blue component of an RGBA pixel is.
+ It is then converted to an RGBA pixel with red and green set to 0,
+ and alpha set to 1.
+ After this conversion, the pixel is treated as if it had been read
+ as an RGBA pixel. "))
+ (entry (% (heading (code "GL_ALPHA")))
+ (para "
+Each pixel is a single alpha component.
+ This component is converted to the internal floating-point format in
+ the same way the alpha component of an RGBA pixel is.
+ It is then converted to an RGBA pixel with red, green, and blue set to 0.
+ After this conversion, the pixel is treated as if it had been read
+ as an RGBA pixel. "))
+ (entry (% (heading (code "GL_RGB"))))
+ (entry (% (heading (code "GL_BGR")))
+ (para "
+Each pixel is a three-component group:
+ red first, followed by green, followed by blue; for "
+ (code "GL_BGR")
+ ", the
+ first component is blue, followed by green and then red.
+ Each component is converted to the internal floating-point format in
+ the same way the red, green, and blue components of an RGBA pixel are.
+ The color triple is converted to an RGBA pixel with alpha set to 1.
+ After this conversion, the pixel is treated as if it had been read
+ as an RGBA pixel. "))
+ (entry (% (heading (code "GL_LUMINANCE")))
+ (para "
+Each pixel is a single luminance component.
+ This component is converted to the internal floating-point format in
+ the same way the red component of an RGBA pixel is.
+ It is then converted to an RGBA pixel with red, green, and blue set to the
+ converted luminance value,
+ and alpha set to 1.
+ After this conversion, the pixel is treated as if it had been read
+ as an RGBA pixel. "))
+ (entry (% (heading (code "GL_LUMINANCE_ALPHA")))
+ (para "
+Each pixel is a two-component group:
+ luminance first, followed by alpha.
+ The two components are converted to the internal floating-point format in
+ the same way the red component of an RGBA pixel is.
+ They are then converted to an RGBA pixel with red, green, and blue set to the
+ converted luminance value,
+ and alpha set to the converted alpha value.
+ After this conversion, the pixel is treated as if it had been read
+ as an RGBA pixel. ")))
+ (para "
+The following table summarizes the meaning of the valid constants for the "
+ (var "type")
+ " parameter: ")
+ (para)
+ (table (% (formatter (asis)))
+ (entry (% (heading (strong "Type")))
+ (para (strong "Corresponding Type")))
+ (entry (% (heading (code "GL_UNSIGNED_BYTE")))
+ (para "
+unsigned 8-bit integer "))
+ (entry (% (heading (code "GL_BYTE")))
+ (para "
+signed 8-bit integer "))
+ (entry (% (heading (code "GL_BITMAP")))
+ (para "
+single bits in unsigned 8-bit integers "))
+ (entry (% (heading (code "GL_UNSIGNED_SHORT")))
+ (para "
+unsigned 16-bit integer "))
+ (entry (% (heading (code "GL_SHORT")))
+ (para "
+signed 16-bit integer "))
+ (entry (% (heading (code "GL_UNSIGNED_INT")))
+ (para "
+unsigned 32-bit integer "))
+ (entry (% (heading (code "GL_INT")))
+ (para "
+32-bit integer "))
+ (entry (% (heading (code "GL_FLOAT")))
+ (para "
+single-precision floating-point "))
+ (entry (% (heading (code "GL_UNSIGNED_BYTE_3_3_2")))
+ (para "
+unsigned 8-bit integer "))
+ (entry (% (heading (code "GL_UNSIGNED_BYTE_2_3_3_REV")))
+ (para "
+unsigned 8-bit integer with reversed component ordering "))
+ (entry (% (heading (code "GL_UNSIGNED_SHORT_5_6_5")))
+ (para "
+unsigned 16-bit integer "))
+ (entry (% (heading (code "GL_UNSIGNED_SHORT_5_6_5_REV")))
+ (para "
+unsigned 16-bit integer with reversed component ordering "))
+ (entry (% (heading (code "GL_UNSIGNED_SHORT_4_4_4_4")))
+ (para "
+unsigned 16-bit integer "))
+ (entry (% (heading (code "GL_UNSIGNED_SHORT_4_4_4_4_REV")))
+ (para "
+unsigned 16-bit integer with reversed component ordering "))
+ (entry (% (heading (code "GL_UNSIGNED_SHORT_5_5_5_1")))
+ (para "
+unsigned 16-bit integer "))
+ (entry (% (heading (code "GL_UNSIGNED_SHORT_1_5_5_5_REV")))
+ (para "
+unsigned 16-bit integer with reversed component ordering "))
+ (entry (% (heading (code "GL_UNSIGNED_INT_8_8_8_8")))
+ (para "
+unsigned 32-bit integer "))
+ (entry (% (heading (code "GL_UNSIGNED_INT_8_8_8_8_REV")))
+ (para "
+unsigned 32-bit integer with reversed component ordering "))
+ (entry (% (heading (code "GL_UNSIGNED_INT_10_10_10_2")))
+ (para "
+unsigned 32-bit integer "))
+ (entry (% (heading (code "GL_UNSIGNED_INT_2_10_10_10_REV")))
+ (para "
+unsigned 32-bit integer with reversed component ordering ")))
+ (para)
+ (para "
+The rasterization described so far assumes pixel zoom factors of 1.
+ If "
+ (code "glPixelZoom")
+ " is used to change the "
+ (math (var "x"))
+ "
+and "
+ (math (var "y"))
+ "
+pixel zoom factors,
+ pixels are converted to fragments as follows.
+ If "
+ (math "("
+ (var "x")
+ "_"
+ (var "r")
+ ","
+ (var "y")
+ "_"
+ (var "r")
+ ")")
+ "
+is the current raster position,
+ and a given pixel is in the "
+ (math (var "n"))
+ "th
+ column and "
+ (math (var "m"))
+ "th
+ row
+ of the pixel rectangle,
+ then fragments are generated for pixels whose centers are in the rectangle
+ with corners at ")
+ (para (math "("
+ (var "x")
+ "_"
+ (var "r")
+ "+"
+ (var "zoom")
+ "_"
+ (var "x")
+ ","
+ "\u2062"
+ (var "n")
+ ","
+ (var "y")
+ "_"
+ (var "r")
+ "+"
+ (var "zoom")
+ "_"
+ (var "y")
+ ","
+ "\u2062"
+ (var "m")
+ ")")
+ (para (math "("
+ (var "x")
+ "_"
+ (var "r")
+ "+"
+ (var "zoom")
+ "_"
+ (var "x")
+ ","
+ "\u2061"
+ "("
+ (var "n")
+ "+"
+ "1"
+ ","
+ ")"
+ ","
+ (var "y")
+ "_"
+ (var "r")
+ "+"
+ (var "zoom")
+ "_"
+ (var "y")
+ ","
+ "\u2061"
+ "("
+ (var "m")
+ "+"
+ "1"
+ ","
+ ")"
+ ")")))
+ (para "
+where "
+ (math (var "zoom") "_" (var "x"))
+ "
+is the value of "
+ (code "GL_ZOOM_X")
+ " and "
+ (math (var "zoom") "_" (var "y"))
+ "
+is the value of "
+ (code "GL_ZOOM_Y")
+ ". ")
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "format")
+ " or "
+ (var "type")
+ " is not one of
+ the accepted values. ")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "type")
+ " is "
+ (code "GL_BITMAP")
+ " and "
+ (var "format")
+ " is not either "
+ (code "GL_COLOR_INDEX")
+ " or "
+ (code "GL_STENCIL_INDEX")
+ ". ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if either "
+ (var "width")
+ " or "
+ (var "height")
+ " is negative. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (var "format")
+ " is "
+ (code "GL_STENCIL_INDEX")
+ "
+and there is no stencil buffer. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (var "format")
+ " is "
+ (code "GL_RED")
+ ", "
+ (code "GL_GREEN")
+ ", "
+ (code "GL_BLUE")
+ ", "
+ (code "GL_ALPHA")
+ ", "
+ (code "GL_RGB")
+ ", "
+ (code "GL_RGBA")
+ ", "
+ (code "GL_BGR")
+ ", "
+ (code "GL_BGRA")
+ ", "
+ (code "GL_LUMINANCE")
+ ",
+ or "
+ (code "GL_LUMINANCE_ALPHA")
+ ",
+ and the GL is in color index mode. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (var "format")
+ " is one of "
+ (code "GL_UNSIGNED_BYTE_3_3_2")
+ ", "
+ (code "GL_UNSIGNED_BYTE_2_3_3_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_6_5")
+ ", or "
+ (code "GL_UNSIGNED_SHORT_5_6_5_REV")
+ "
+and "
+ (var "format")
+ " is not "
+ (code "GL_RGB")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (var "format")
+ " is one of "
+ (code "GL_UNSIGNED_SHORT_4_4_4_4")
+ ", "
+ (code "GL_UNSIGNED_SHORT_4_4_4_4_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_5_5_1")
+ ", "
+ (code "GL_UNSIGNED_SHORT_1_5_5_5_REV")
+ ", "
+ (code "GL_UNSIGNED_INT_8_8_8_8")
+ ", "
+ (code "GL_UNSIGNED_INT_8_8_8_8_REV")
+ ", "
+ (code "GL_UNSIGNED_INT_10_10_10_2")
+ ", or "
+ (code "GL_UNSIGNED_INT_2_10_10_10_REV")
+ "
+and "
+ (var "format")
+ " is neither "
+ (code "GL_RGBA")
+ " nor "
+ (code "GL_BGRA")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a non-zero buffer object name is bound to the "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ " target and the buffer object's data store is currently mapped. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a non-zero buffer object name is bound to the "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ " target and the data would be unpacked from the buffer
+ object such that the memory reads required would exceed the data store size. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a non-zero buffer object name is bound to the "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ " target and "
+ (var "data")
+ " is not evenly divisible
+ into the number of bytes needed to store in memory a datum indicated by "
+ (var "type")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glDrawPixels")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glDrawRangeElements
+ "glDrawRangeElements"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "void "
+ (function "glDrawRangeElements"))
+ (paramdef "GLenum " (parameter "mode"))
+ (paramdef "GLuint " (parameter "start"))
+ (paramdef "GLuint " (parameter "end"))
+ (paramdef "GLsizei " (parameter "count"))
+ (paramdef "GLenum " (parameter "type"))
+ (paramdef
+ "const GLvoid * "
+ (parameter "indices"))))
+ '(*fragment*
+ (heading "render primitives from array data")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "mode")))
+ (para "
+Specifies what kind of primitives to render.
+ Symbolic constants "
+ (code "GL_POINTS")
+ ", "
+ (code "GL_LINE_STRIP")
+ ", "
+ (code "GL_LINE_LOOP")
+ ", "
+ (code "GL_LINES")
+ ", "
+ (code "GL_TRIANGLE_STRIP")
+ ", "
+ (code "GL_TRIANGLE_FAN")
+ ", "
+ (code "GL_TRIANGLES")
+ ", "
+ (code "GL_QUAD_STRIP")
+ ", "
+ (code "GL_QUADS")
+ ",
+ and "
+ (code "GL_POLYGON")
+ " are accepted. "))
+ (entry (% (heading (var "start")))
+ (para "
+Specifies the minimum array index contained in "
+ (var "indices")
+ ". "))
+ (entry (% (heading (var "end")))
+ (para "
+Specifies the maximum array index contained in "
+ (var "indices")
+ ". "))
+ (entry (% (heading (var "count")))
+ (para "
+Specifies the number of elements to be rendered. "))
+ (entry (% (heading (var "type")))
+ (para "
+Specifies the type of the values in "
+ (var "indices")
+ ". Must be one of "
+ (code "GL_UNSIGNED_BYTE")
+ ", "
+ (code "GL_UNSIGNED_SHORT")
+ ", or "
+ (code "GL_UNSIGNED_INT")
+ ". "))
+ (entry (% (heading (var "indices")))
+ (para "
+Specifies a pointer to the location where the indices are stored. ")))
+ (heading "Description")
+ (para (code "glDrawRangeElements")
+ " is a restricted form of "
+ (code "glDrawElements")
+ ". "
+ (var "mode")
+ ", "
+ (var "start")
+ ", "
+ (var "end")
+ ",
+ and "
+ (var "count")
+ " match the corresponding arguments to "
+ (code "glDrawElements")
+ ", with
+ the additional constraint that all values in the arrays "
+ (var "count")
+ " must lie
+ between "
+ (var "start")
+ " and "
+ (var "end")
+ ", inclusive. ")
+ (para "
+Implementations denote recommended maximum amounts of vertex and
+ index data,
+ which may be queried by calling "
+ (code "glGet")
+ " with argument "
+ (code "GL_MAX_ELEMENTS_VERTICES")
+ " and "
+ (code "GL_MAX_ELEMENTS_INDICES")
+ ".
+ If "
+ (math (var "end") "-" (var "start") "+" "1")
+ "
+is greater than the value of "
+ (code "GL_MAX_ELEMENTS_VERTICES")
+ ", or if "
+ (var "count")
+ " is greater than the value of "
+ (code "GL_MAX_ELEMENTS_INDICES")
+ ", then the call may operate at reduced
+ performance. There is no requirement that all vertices in the range "
+ (math "[" (var "start") "," (var "end") "]")
+ "
+be referenced. However, the implementation may
+ partially process unused vertices, reducing performance from what could
+ be achieved with an optimal index set. ")
+ (para "
+When "
+ (code "glDrawRangeElements")
+ " is called, it uses "
+ (var "count")
+ " sequential elements from an
+ enabled array, starting at "
+ (var "start")
+ " to construct a sequence of
+ geometric primitives. "
+ (var "mode")
+ " specifies what kind of primitives are
+ constructed, and how the array elements construct these primitives. If
+ more than one array is enabled, each is used. If "
+ (code "GL_VERTEX_ARRAY")
+ " is not enabled, no geometric primitives are
+ constructed. ")
+ (para "
+Vertex attributes that are modified by "
+ (code "glDrawRangeElements")
+ " have an
+ unspecified value after "
+ (code "glDrawRangeElements")
+ " returns. For example, if "
+ (code "GL_COLOR_ARRAY")
+ " is enabled, the value of the current color is
+ undefined after "
+ (code "glDrawRangeElements")
+ " executes. Attributes that aren't
+ modified maintain their previous values. ")
+ (heading "Errors")
+ (para "
+It is an error for indices to lie outside the range "
+ (math "[" (var "start") "," (var "end") "]")
+ ",
+ but implementations may not check for this situation. Such indices
+ cause implementation-dependent behavior. ")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "mode")
+ " is not an accepted value. ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "count")
+ " is negative. ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (math (var "end") "<" (var "start"))
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a non-zero buffer object name is bound to an
+ enabled array or the element array and the buffer object's data store is currently mapped. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glDrawRangeElements")
+ " is executed between
+ the execution of "
+ (code "glBegin")
+ " and the corresponding "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glEdgeFlagPointer
+ "glEdgeFlagPointer"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glEdgeFlagPointer"))
+ (paramdef "GLsizei " (parameter "stride"))
+ (paramdef
+ "const GLvoid * "
+ (parameter "pointer"))))
+ '(*fragment*
+ (heading "define an array of edge flags")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "stride")))
+ (para "
+Specifies the byte offset between consecutive edge flags.
+ If "
+ (var "stride")
+ " is 0, the edge flags are understood
+ to be tightly packed in the array. The initial value is 0. "))
+ (entry (% (heading (var "pointer")))
+ (para "
+Specifies a pointer to the first edge flag in the array. The initial
+ value is 0. ")))
+ (heading "Description")
+ (para (code "glEdgeFlagPointer")
+ " specifies the location and data format of an array of boolean edge
+ flags to use when rendering. "
+ (var "stride")
+ " specifies the byte stride from one
+ edge flag to the next, allowing vertices and attributes
+ to be packed into a single array or stored in separate arrays. ")
+ (para "
+If a non-zero named buffer object is bound to the "
+ (code "GL_ARRAY_BUFFER")
+ " target
+ (see "
+ (code "glBindBuffer")
+ ") while an edge flag array is
+ specified, "
+ (var "pointer")
+ " is treated as a byte offset into the buffer object's data store.
+ Also, the buffer object binding ("
+ (code "GL_ARRAY_BUFFER_BINDING")
+ ") is saved as edge flag vertex array
+ client-side state ("
+ (code "GL_EDGE_FLAG_ARRAY_BUFFER_BINDING")
+ "). ")
+ (para "
+When an edge flag array is
+ specified, "
+ (var "stride")
+ " and "
+ (var "pointer")
+ " are saved as client-side
+ state, in addition to the current vertex array buffer object binding. ")
+ (para "
+To enable and disable the edge flag array, call "
+ (code "glEnableClientState")
+ " and "
+ (code "glDisableClientState")
+ " with the argument "
+ (code "GL_EDGE_FLAG_ARRAY")
+ ". If
+ enabled, the edge flag array is used
+ when "
+ (code "glDrawArrays")
+ ", "
+ (code "glMultiDrawArrays")
+ ", "
+ (code "glDrawElements")
+ ", "
+ (code "glMultiDrawElements")
+ ", "
+ (code "glDrawRangeElements")
+ ", or "
+ (code "glArrayElement")
+ " is called. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "stride")
+ " is negative. ")))
+
+(define-gl-procedure
+ glEdgeFlag
+ "glEdgeFlag"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glEdgeFlag"))
+ (paramdef "GLboolean " (parameter "flag"))))
+ '(*fragment*
+ (heading
+ "flag edges as either boundary or nonboundary")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "flag")))
+ (para "
+Specifies the current edge flag value,
+ either "
+ (code "GL_TRUE")
+ " or "
+ (code "GL_FALSE")
+ ". The initial value is "
+ (code "GL_TRUE")
+ ". ")))
+ (heading "Description")
+ (para "
+Each vertex of a polygon,
+ separate triangle,
+ or separate quadrilateral specified between a "
+ (code "glBegin")
+ "/"
+ (code "glEnd")
+ " pair
+ is marked as the start of either a boundary or nonboundary edge.
+ If the current edge flag is true when the vertex is specified,
+ the vertex is marked as the start of a boundary edge.
+ Otherwise, the vertex is marked as the start of a nonboundary edge. "
+ (code "glEdgeFlag")
+ " sets the edge flag bit to "
+ (code "GL_TRUE")
+ " if "
+ (var "flag")
+ " is "
+ (code "GL_TRUE")
+ "
+and to "
+ (code "GL_FALSE")
+ " otherwise. ")
+ (para "
+The vertices of connected triangles and connected quadrilaterals are always
+ marked as boundary,
+ regardless of the value of the edge flag. ")
+ (para "
+Boundary and nonboundary edge flags on vertices are significant only if "
+ (code "GL_POLYGON_MODE")
+ " is set to "
+ (code "GL_POINT")
+ " or "
+ (code "GL_LINE")
+ ".
+ See "
+ (code "glPolygonMode")
+ ". ")))
+
+(define-gl-procedure
+ glEnableClientState
+ "glEnableClientState"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "void "
+ (function "glEnableClientState"))
+ (paramdef "GLenum " (parameter "cap"))))
+ '(*fragment*
+ (heading
+ "enable or disable client-side capability")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "cap")))
+ (para "
+Specifies the capability to enable.
+ Symbolic constants "
+ (code "GL_COLOR_ARRAY")
+ ", "
+ (code "GL_EDGE_FLAG_ARRAY")
+ ", "
+ (code "GL_FOG_COORD_ARRAY")
+ ", "
+ (code "GL_INDEX_ARRAY")
+ ", "
+ (code "GL_NORMAL_ARRAY")
+ ", "
+ (code "GL_SECONDARY_COLOR_ARRAY")
+ ", "
+ (code "GL_TEXTURE_COORD_ARRAY")
+ ", and "
+ (code "GL_VERTEX_ARRAY")
+ "
+are accepted. ")))
+ (heading "Description")
+ (para (code "glEnableClientState")
+ " and "
+ (code "glDisableClientState")
+ "
+enable or disable individual client-side capabilities. By default, all
+ client-side capabilities are disabled.
+ Both "
+ (code "glEnableClientState")
+ " and "
+ (code "glDisableClientState")
+ " take a
+ single argument, "
+ (var "cap")
+ ", which can assume one of the following
+ values: ")
+ (table (% (formatter (asis)))
+ (entry (% (heading (code "GL_COLOR_ARRAY")))
+ (para "
+If enabled, the color array is enabled for writing and used during
+ rendering when "
+ (code "glArrayElement")
+ ", "
+ (code "glDrawArrays")
+ ", "
+ (code "glDrawElements")
+ ", "
+ (code "glDrawRangeElements")
+ (code "glMultiDrawArrays")
+ ", or "
+ (code "glMultiDrawElements")
+ " is called. See "
+ (code "glColorPointer")
+ ". "))
+ (entry (% (heading (code "GL_EDGE_FLAG_ARRAY")))
+ (para "
+If enabled, the edge flag array is enabled for writing and used during
+ rendering when "
+ (code "glArrayElement")
+ ", "
+ (code "glDrawArrays")
+ ", "
+ (code "glDrawElements")
+ ", "
+ (code "glDrawRangeElements")
+ (code "glMultiDrawArrays")
+ ", or "
+ (code "glMultiDrawElements")
+ " is called. See "
+ (code "glEdgeFlagPointer")
+ ". "))
+ (entry (% (heading (code "GL_FOG_COORD_ARRAY")))
+ (para "
+If enabled, the fog coordinate array is enabled for writing and used during
+ rendering when "
+ (code "glArrayElement")
+ ", "
+ (code "glDrawArrays")
+ ", "
+ (code "glDrawElements")
+ ", "
+ (code "glDrawRangeElements")
+ (code "glMultiDrawArrays")
+ ", or "
+ (code "glMultiDrawElements")
+ " is called. See "
+ (code "glFogCoordPointer")
+ ". "))
+ (entry (% (heading (code "GL_INDEX_ARRAY")))
+ (para "
+If enabled, the index array is enabled for writing and used during
+ rendering when "
+ (code "glArrayElement")
+ ", "
+ (code "glDrawArrays")
+ ", "
+ (code "glDrawElements")
+ ", "
+ (code "glDrawRangeElements")
+ (code "glMultiDrawArrays")
+ ", or "
+ (code "glMultiDrawElements")
+ " is called. See "
+ (code "glIndexPointer")
+ ". "))
+ (entry (% (heading (code "GL_NORMAL_ARRAY")))
+ (para "
+If enabled, the normal array is enabled for writing and used during
+ rendering when "
+ (code "glArrayElement")
+ ", "
+ (code "glDrawArrays")
+ ", "
+ (code "glDrawElements")
+ ", "
+ (code "glDrawRangeElements")
+ (code "glMultiDrawArrays")
+ ", or "
+ (code "glMultiDrawElements")
+ " is called. See "
+ (code "glNormalPointer")
+ ". "))
+ (entry (% (heading (code "GL_SECONDARY_COLOR_ARRAY")))
+ (para "
+If enabled, the secondary color array is enabled for writing and used
+ during rendering when "
+ (code "glArrayElement")
+ ", "
+ (code "glDrawArrays")
+ ", "
+ (code "glDrawElements")
+ ", "
+ (code "glDrawRangeElements")
+ (code "glMultiDrawArrays")
+ ", or "
+ (code "glMultiDrawElements")
+ " is called. See "
+ (code "glColorPointer")
+ ". "))
+ (entry (% (heading (code "GL_TEXTURE_COORD_ARRAY")))
+ (para "
+If enabled, the texture coordinate array is enabled for writing and used
+ during rendering when "
+ (code "glArrayElement")
+ ", "
+ (code "glDrawArrays")
+ ", "
+ (code "glDrawElements")
+ ", "
+ (code "glDrawRangeElements")
+ (code "glMultiDrawArrays")
+ ", or "
+ (code "glMultiDrawElements")
+ " is called. See "
+ (code "glTexCoordPointer")
+ ". "))
+ (entry (% (heading (code "GL_VERTEX_ARRAY")))
+ (para "
+If enabled, the vertex array is enabled for writing and used during
+ rendering when "
+ (code "glArrayElement")
+ ", "
+ (code "glDrawArrays")
+ ", "
+ (code "glDrawElements")
+ ", "
+ (code "glDrawRangeElements")
+ (code "glMultiDrawArrays")
+ ", or "
+ (code "glMultiDrawElements")
+ " is called. See "
+ (code "glVertexPointer")
+ ". ")))
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "cap")
+ " is not an accepted value. ")
+ (para (code "glEnableClientState")
+ " is not allowed between the execution of "
+ (code "glBegin")
+ " and the
+ corresponding "
+ (code "glEnd")
+ ", but an error may or may not be generated. If
+ no error is generated, the behavior is undefined. ")))
+
+(define-gl-procedure
+ glEnableVertexAttribArray
+ "glEnableVertexAttribArray"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "void "
+ (function "glEnableVertexAttribArray"))
+ (paramdef "GLuint " (parameter "index")))
+ (funcprototype
+ (funcdef
+ "void "
+ (function "glDisableVertexAttribArray"))
+ (paramdef "GLuint " (parameter "index"))))
+ '(*fragment*
+ (heading
+ "Enable or disable a generic vertex attribute array")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "index")))
+ (para "Specifies the index of the generic vertex
+\t\t attribute to be enabled or disabled.")))
+ (heading "Description")
+ (para (code "glEnableVertexAttribArray")
+ " enables the
+\tgeneric vertex attribute array specified by\t"
+ (var "index")
+ ".\t"
+ (code "glDisableVertexAttribArray")
+ " disables the
+\tgeneric vertex attribute array specified by\t"
+ (var "index")
+ ". By default, all client-side
+\tcapabilities are disabled, including all generic vertex
+\tattribute arrays. If enabled, the values in the generic vertex
+\tattribute array will be accessed and used for rendering when
+\tcalls are made to vertex array commands such as\t"
+ (code "glDrawArrays")
+ ",\t"
+ (code "glDrawElements")
+ ",\t"
+ (code "glDrawRangeElements")
+ ",\t"
+ (code "glArrayElement")
+ ",\t"
+ (code "glMultiDrawElements")
+ ",
+\tor\t"
+ (code "glMultiDrawArrays")
+ ".")
+ (heading "Errors")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if\t"
+ (var "index")
+ " is greater than or equal to\t"
+ (code "GL_MAX_VERTEX_ATTRIBS")
+ ".")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if either\t"
+ (code "glEnableVertexAttribArray ")
+ " or\t"
+ (code "glDisableVertexAttribArray ")
+ " is executed
+\tbetween the execution of\t"
+ (code "glBegin")
+ "
+and the corresponding execution of\t"
+ (code "glEnd")
+ ".")))
+
+(define-gl-procedure
+ glEnable
+ "glEnable"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glEnable"))
+ (paramdef "GLenum " (parameter "cap"))))
+ '(*fragment*
+ (heading
+ "enable or disable server-side GL capabilities")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "cap")))
+ (para "
+Specifies a symbolic constant indicating a GL capability. ")))
+ (heading "Description")
+ (para (code "glEnable")
+ " and "
+ (code "glDisable")
+ " enable and disable various capabilities.
+ Use "
+ (code "glIsEnabled")
+ " or "
+ (code "glGet")
+ " to determine the current setting
+ of any capability. The initial value for each capability with the
+ exception of "
+ (code "GL_DITHER")
+ " and "
+ (code "GL_MULTISAMPLE")
+ " is "
+ (code "GL_FALSE")
+ ". The initial value for "
+ (code "GL_DITHER")
+ " and "
+ (code "GL_MULTISAMPLE")
+ " is "
+ (code "GL_TRUE")
+ ". ")
+ (para "
+Both "
+ (code "glEnable")
+ " and "
+ (code "glDisable")
+ " take a single argument, "
+ (var "cap")
+ ",
+ which can assume one of the following values: ")
+ (table (% (formatter (asis)))
+ (entry (% (heading (code "GL_ALPHA_TEST")))
+ (para)
+ (para "
+If enabled,
+ do alpha testing. See "
+ (code "glAlphaFunc")
+ ". "))
+ (entry (% (heading (code "GL_AUTO_NORMAL")))
+ (para)
+ (para "
+If enabled,
+ generate normal vectors when either "
+ (code "GL_MAP2_VERTEX_3")
+ " or "
+ (code "GL_MAP2_VERTEX_4")
+ " is used to generate vertices.
+ See "
+ (code "glMap2")
+ ". "))
+ (entry (% (heading (code "GL_BLEND")))
+ (para)
+ (para "
+If enabled,
+ blend the computed fragment color values with the values in the color
+ buffers. See "
+ (code "glBlendFunc")
+ ". "))
+ (entry (% (heading (code "GL_CLIP_PLANE") (var "i")))
+ (para)
+ (para "
+If enabled,
+ clip geometry against user-defined clipping plane "
+ (var "i")
+ ".
+ See "
+ (code "glClipPlane")
+ ". "))
+ (entry (% (heading (code "GL_COLOR_LOGIC_OP")))
+ (para)
+ (para "
+If enabled,
+ apply the currently selected logical operation to the computed fragment
+ color and color buffer values. See "
+ (code "glLogicOp")
+ ". "))
+ (entry (% (heading (code "GL_COLOR_MATERIAL")))
+ (para)
+ (para "
+If enabled,
+ have one or more material parameters track the current color.
+ See "
+ (code "glColorMaterial")
+ ". "))
+ (entry (% (heading (code "GL_COLOR_SUM")))
+ (para)
+ (para "
+If enabled and no fragment shader is active,
+ add the secondary color value to the computed fragment color.
+ See "
+ (code "glSecondaryColor")
+ ". "))
+ (entry (% (heading (code "GL_COLOR_TABLE")))
+ (para)
+ (para "
+If enabled,
+ perform a color table lookup on the incoming RGBA color values.
+ See "
+ (code "glColorTable")
+ ". "))
+ (entry (% (heading (code "GL_CONVOLUTION_1D")))
+ (para)
+ (para "
+If enabled,
+ perform a 1D convolution operation on incoming RGBA color values.
+ See "
+ (code "glConvolutionFilter1D")
+ ". "))
+ (entry (% (heading (code "GL_CONVOLUTION_2D")))
+ (para)
+ (para "
+If enabled,
+ perform a 2D convolution operation on incoming RGBA color values.
+ See "
+ (code "glConvolutionFilter2D")
+ ". "))
+ (entry (% (heading (code "GL_CULL_FACE")))
+ (para)
+ (para "
+If enabled,
+ cull polygons based on their winding in window coordinates.
+ See "
+ (code "glCullFace")
+ ". "))
+ (entry (% (heading (code "GL_DEPTH_TEST")))
+ (para)
+ (para "
+If enabled,
+ do depth comparisons and update the depth buffer. Note that even if
+ the depth buffer exists and the depth mask is non-zero, the
+ depth buffer is not updated if the depth test is disabled. See "
+ (code "glDepthFunc")
+ " and "
+ (code "glDepthRange")
+ ". "))
+ (entry (% (heading (code "GL_DITHER")))
+ (para)
+ (para "
+If enabled,
+ dither color components or indices before they are written to the
+ color buffer. "))
+ (entry (% (heading (code "GL_FOG")))
+ (para)
+ (para "
+If enabled and no fragment shader is active,
+ blend a fog color into the post-texturing color.
+ See "
+ (code "glFog")
+ ". "))
+ (entry (% (heading (code "GL_HISTOGRAM")))
+ (para)
+ (para "
+If enabled,
+ histogram incoming RGBA color values.
+ See "
+ (code "glHistogram")
+ ". "))
+ (entry (% (heading (code "GL_INDEX_LOGIC_OP")))
+ (para)
+ (para "
+If enabled,
+ apply the currently selected logical operation to the incoming index and color
+ buffer indices.
+ See "
+ (code "glLogicOp")
+ ". "))
+ (entry (% (heading (code "GL_LIGHT") (var "i")))
+ (para)
+ (para "
+If enabled,
+ include light "
+ (var "i")
+ " in the evaluation of the lighting
+ equation. See "
+ (code "glLightModel")
+ " and "
+ (code "glLight")
+ ". "))
+ (entry (% (heading (code "GL_LIGHTING")))
+ (para)
+ (para "
+If enabled and no vertex shader is active,
+ use the current lighting parameters to compute the vertex color or index.
+ Otherwise, simply associate the current color or index with each
+ vertex. See "
+ (code "glMaterial")
+ ", "
+ (code "glLightModel")
+ ", and "
+ (code "glLight")
+ ". "))
+ (entry (% (heading (code "GL_LINE_SMOOTH")))
+ (para)
+ (para "
+If enabled,
+ draw lines with correct filtering.
+ Otherwise,
+ draw aliased lines.
+ See "
+ (code "glLineWidth")
+ ". "))
+ (entry (% (heading (code "GL_LINE_STIPPLE")))
+ (para)
+ (para "
+If enabled,
+ use the current line stipple pattern when drawing lines. See "
+ (code "glLineStipple")
+ ". "))
+ (entry (% (heading (code "GL_MAP1_COLOR_4")))
+ (para)
+ (para "
+If enabled,
+ calls to "
+ (code "glEvalCoord1")
+ ", "
+ (code "glEvalMesh1")
+ ", and "
+ (code "glEvalPoint1")
+ " generate RGBA values.
+ See "
+ (code "glMap1")
+ ". "))
+ (entry (% (heading (code "GL_MAP1_INDEX")))
+ (para)
+ (para "
+If enabled,
+ calls to "
+ (code "glEvalCoord1")
+ ", "
+ (code "glEvalMesh1")
+ ", and "
+ (code "glEvalPoint1")
+ " generate color indices.
+ See "
+ (code "glMap1")
+ ". "))
+ (entry (% (heading (code "GL_MAP1_NORMAL")))
+ (para)
+ (para "
+If enabled,
+ calls to "
+ (code "glEvalCoord1")
+ ", "
+ (code "glEvalMesh1")
+ ", and "
+ (code "glEvalPoint1")
+ " generate normals.
+ See "
+ (code "glMap1")
+ ". "))
+ (entry (% (heading (code "GL_MAP1_TEXTURE_COORD_1")))
+ (para)
+ (para "
+If enabled,
+ calls to "
+ (code "glEvalCoord1")
+ ", "
+ (code "glEvalMesh1")
+ ", and "
+ (code "glEvalPoint1")
+ " generate "
+ (var "s")
+ "
+texture coordinates.
+ See "
+ (code "glMap1")
+ ". "))
+ (entry (% (heading (code "GL_MAP1_TEXTURE_COORD_2")))
+ (para)
+ (para "
+If enabled,
+ calls to "
+ (code "glEvalCoord1")
+ ", "
+ (code "glEvalMesh1")
+ ", and "
+ (code "glEvalPoint1")
+ " generate "
+ (var "s")
+ " and "
+ (var "t")
+ " texture coordinates.
+ See "
+ (code "glMap1")
+ ". "))
+ (entry (% (heading (code "GL_MAP1_TEXTURE_COORD_3")))
+ (para)
+ (para "
+If enabled,
+ calls to "
+ (code "glEvalCoord1")
+ ", "
+ (code "glEvalMesh1")
+ ", and "
+ (code "glEvalPoint1")
+ " generate "
+ (var "s")
+ ", "
+ (var "t")
+ ", and "
+ (var "r")
+ " texture coordinates.
+ See "
+ (code "glMap1")
+ ". "))
+ (entry (% (heading (code "GL_MAP1_TEXTURE_COORD_4")))
+ (para)
+ (para "
+If enabled,
+ calls to "
+ (code "glEvalCoord1")
+ ", "
+ (code "glEvalMesh1")
+ ", and "
+ (code "glEvalPoint1")
+ " generate "
+ (var "s")
+ ", "
+ (var "t")
+ ", "
+ (var "r")
+ ", and "
+ (var "q")
+ " texture coordinates.
+ See "
+ (code "glMap1")
+ ". "))
+ (entry (% (heading (code "GL_MAP1_VERTEX_3")))
+ (para)
+ (para "
+If enabled,
+ calls to "
+ (code "glEvalCoord1")
+ ", "
+ (code "glEvalMesh1")
+ ", and "
+ (code "glEvalPoint1")
+ " generate "
+ (var "x")
+ ", "
+ (var "y")
+ ", and "
+ (var "z")
+ " vertex coordinates.
+ See "
+ (code "glMap1")
+ ". "))
+ (entry (% (heading (code "GL_MAP1_VERTEX_4")))
+ (para)
+ (para "
+If enabled,
+ calls to "
+ (code "glEvalCoord1")
+ ", "
+ (code "glEvalMesh1")
+ ", and "
+ (code "glEvalPoint1")
+ " generate
+ homogeneous "
+ (var "x")
+ ", "
+ (var "y")
+ ", "
+ (var "z")
+ ", and "
+ (var "w")
+ " vertex coordinates.
+ See "
+ (code "glMap1")
+ ". "))
+ (entry (% (heading (code "GL_MAP2_COLOR_4")))
+ (para)
+ (para "
+If enabled,
+ calls to "
+ (code "glEvalCoord2")
+ ", "
+ (code "glEvalMesh2")
+ ", and "
+ (code "glEvalPoint2")
+ " generate RGBA values.
+ See "
+ (code "glMap2")
+ ". "))
+ (entry (% (heading (code "GL_MAP2_INDEX")))
+ (para)
+ (para "
+If enabled,
+ calls to "
+ (code "glEvalCoord2")
+ ", "
+ (code "glEvalMesh2")
+ ", and "
+ (code "glEvalPoint2")
+ " generate color indices.
+ See "
+ (code "glMap2")
+ ". "))
+ (entry (% (heading (code "GL_MAP2_NORMAL")))
+ (para)
+ (para "
+If enabled,
+ calls to "
+ (code "glEvalCoord2")
+ ", "
+ (code "glEvalMesh2")
+ ", and "
+ (code "glEvalPoint2")
+ " generate normals.
+ See "
+ (code "glMap2")
+ ". "))
+ (entry (% (heading (code "GL_MAP2_TEXTURE_COORD_1")))
+ (para)
+ (para "
+If enabled,
+ calls to "
+ (code "glEvalCoord2")
+ ", "
+ (code "glEvalMesh2")
+ ", and "
+ (code "glEvalPoint2")
+ " generate "
+ (var "s")
+ "
+texture coordinates.
+ See "
+ (code "glMap2")
+ ". "))
+ (entry (% (heading (code "GL_MAP2_TEXTURE_COORD_2")))
+ (para)
+ (para "
+If enabled,
+ calls to "
+ (code "glEvalCoord2")
+ ", "
+ (code "glEvalMesh2")
+ ", and "
+ (code "glEvalPoint2")
+ " generate "
+ (var "s")
+ " and "
+ (var "t")
+ " texture coordinates.
+ See "
+ (code "glMap2")
+ ". "))
+ (entry (% (heading (code "GL_MAP2_TEXTURE_COORD_3")))
+ (para)
+ (para "
+If enabled,
+ calls to "
+ (code "glEvalCoord2")
+ ", "
+ (code "glEvalMesh2")
+ ", and "
+ (code "glEvalPoint2")
+ " generate "
+ (var "s")
+ ", "
+ (var "t")
+ ", and "
+ (var "r")
+ " texture coordinates.
+ See "
+ (code "glMap2")
+ ". "))
+ (entry (% (heading (code "GL_MAP2_TEXTURE_COORD_4")))
+ (para)
+ (para "
+If enabled,
+ calls to "
+ (code "glEvalCoord2")
+ ", "
+ (code "glEvalMesh2")
+ ", and "
+ (code "glEvalPoint2")
+ " generate "
+ (var "s")
+ ", "
+ (var "t")
+ ", "
+ (var "r")
+ ", and "
+ (var "q")
+ " texture coordinates.
+ See "
+ (code "glMap2")
+ ". "))
+ (entry (% (heading (code "GL_MAP2_VERTEX_3")))
+ (para)
+ (para "
+If enabled,
+ calls to "
+ (code "glEvalCoord2")
+ ", "
+ (code "glEvalMesh2")
+ ", and "
+ (code "glEvalPoint2")
+ " generate "
+ (var "x")
+ ", "
+ (var "y")
+ ", and "
+ (var "z")
+ " vertex coordinates.
+ See "
+ (code "glMap2")
+ ". "))
+ (entry (% (heading (code "GL_MAP2_VERTEX_4")))
+ (para)
+ (para "
+If enabled,
+ calls to "
+ (code "glEvalCoord2")
+ ", "
+ (code "glEvalMesh2")
+ ", and "
+ (code "glEvalPoint2")
+ " generate
+ homogeneous "
+ (var "x")
+ ", "
+ (var "y")
+ ", "
+ (var "z")
+ ", and "
+ (var "w")
+ " vertex coordinates.
+ See "
+ (code "glMap2")
+ ". "))
+ (entry (% (heading (code "GL_MINMAX")))
+ (para)
+ (para "
+If enabled,
+ compute the minimum and maximum values of incoming RGBA color values.
+ See "
+ (code "glMinmax")
+ ". "))
+ (entry (% (heading (code "GL_MULTISAMPLE")))
+ (para)
+ (para "
+If enabled,
+ use multiple fragment samples in computing the final color of a pixel.
+ See "
+ (code "glSampleCoverage")
+ ". "))
+ (entry (% (heading (code "GL_NORMALIZE")))
+ (para)
+ (para "
+If enabled and no vertex shader is active,
+ normal vectors are normalized to unit length
+ after transformation and before lighting. This method is generally
+ less efficient than "
+ (code "GL_RESCALE_NORMAL")
+ ". See "
+ (code "glNormal")
+ " and "
+ (code "glNormalPointer")
+ ". "))
+ (entry (% (heading (code "GL_POINT_SMOOTH")))
+ (para)
+ (para "
+If enabled,
+ draw points with proper filtering.
+ Otherwise,
+ draw aliased points.
+ See "
+ (code "glPointSize")
+ ". "))
+ (entry (% (heading (code "GL_POINT_SPRITE")))
+ (para)
+ (para "
+If enabled,
+ calculate texture coordinates for points based on texture
+ environment and point parameter settings. Otherwise texture coordinates
+ are constant across points. "))
+ (entry (% (heading (code "GL_POLYGON_OFFSET_FILL")))
+ (para)
+ (para "
+If enabled, and if the polygon is rendered in "
+ (code "GL_FILL")
+ " mode, an offset is added to depth values of a polygon's
+ fragments before the depth comparison is performed.
+ See "
+ (code "glPolygonOffset")
+ ". "))
+ (entry (% (heading (code "GL_POLYGON_OFFSET_LINE")))
+ (para)
+ (para "
+If enabled, and if the polygon is rendered in "
+ (code "GL_LINE")
+ " mode, an offset is added to depth values of a polygon's
+ fragments before the depth comparison is performed.
+ See "
+ (code "glPolygonOffset")
+ ". "))
+ (entry (% (heading (code "GL_POLYGON_OFFSET_POINT")))
+ (para)
+ (para "
+If enabled, an offset is added to depth values of a polygon's fragments
+ before the depth comparison is performed, if the polygon is rendered in "
+ (code "GL_POINT")
+ " mode. See "
+ (code "glPolygonOffset")
+ ". "))
+ (entry (% (heading (code "GL_POLYGON_SMOOTH")))
+ (para)
+ (para "
+If enabled, draw polygons with proper filtering.
+ Otherwise, draw aliased polygons. For correct antialiased polygons,
+ an alpha buffer is needed and the polygons must be sorted front to
+ back. "))
+ (entry (% (heading (code "GL_POLYGON_STIPPLE")))
+ (para)
+ (para "
+If enabled,
+ use the current polygon stipple pattern when rendering
+ polygons. See "
+ (code "glPolygonStipple")
+ ". "))
+ (entry (% (heading
+ (code "GL_POST_COLOR_MATRIX_COLOR_TABLE")))
+ (para)
+ (para "
+If enabled,
+ perform a color table lookup on RGBA color values after color matrix
+ transformation.
+ See "
+ (code "glColorTable")
+ ". "))
+ (entry (% (heading
+ (code "GL_POST_CONVOLUTION_COLOR_TABLE")))
+ (para)
+ (para "
+If enabled,
+ perform a color table lookup on RGBA color values after convolution.
+ See "
+ (code "glColorTable")
+ ". "))
+ (entry (% (heading (code "GL_RESCALE_NORMAL")))
+ (para)
+ (para "
+If enabled and no vertex shader is active,
+ normal vectors are scaled after transformation and before
+ lighting by a factor computed from the modelview matrix. If the
+ modelview matrix scales space uniformly, this has the effect of
+ restoring the transformed normal to unit length. This method is generally
+ more efficient than "
+ (code "GL_NORMALIZE")
+ ". See "
+ (code "glNormal")
+ " and "
+ (code "glNormalPointer")
+ ". "))
+ (entry (% (heading (code "GL_SAMPLE_ALPHA_TO_COVERAGE")))
+ (para)
+ (para "
+If enabled,
+ compute a temporary coverage value where each bit is determined by the
+ alpha value at the corresponding sample location. The temporary coverage
+ value is then ANDed with the fragment coverage value. "))
+ (entry (% (heading (code "GL_SAMPLE_ALPHA_TO_ONE")))
+ (para)
+ (para "
+If enabled,
+ each sample alpha value is replaced by the maximum representable alpha value. "))
+ (entry (% (heading (code "GL_SAMPLE_COVERAGE")))
+ (para)
+ (para "
+If enabled,
+ the fragment's coverage is ANDed with the temporary coverage value. If "
+ (code "GL_SAMPLE_COVERAGE_INVERT")
+ " is set to "
+ (code "GL_TRUE")
+ ", invert the coverage
+ value.
+ See "
+ (code "glSampleCoverage")
+ ". "))
+ (entry (% (heading (code "GL_SEPARABLE_2D")))
+ (para)
+ (para "
+If enabled, perform a two-dimensional convolution operation using a separable
+ convolution filter on incoming RGBA color values.
+ See "
+ (code "glSeparableFilter2D")
+ ". "))
+ (entry (% (heading (code "GL_SCISSOR_TEST")))
+ (para)
+ (para "
+If enabled,
+ discard fragments that are outside the scissor rectangle.
+ See "
+ (code "glScissor")
+ ". "))
+ (entry (% (heading (code "GL_STENCIL_TEST")))
+ (para)
+ (para "
+If enabled,
+ do stencil testing and update the stencil buffer.
+ See "
+ (code "glStencilFunc")
+ " and "
+ (code "glStencilOp")
+ ". "))
+ (entry (% (heading (code "GL_TEXTURE_1D")))
+ (para)
+ (para "
+If enabled and no fragment shader is active,
+ one-dimensional texturing is performed
+ (unless two- or three-dimensional or cube-mapped texturing is also enabled).
+ See "
+ (code "glTexImage1D")
+ ". "))
+ (entry (% (heading (code "GL_TEXTURE_2D")))
+ (para)
+ (para "
+If enabled and no fragment shader is active,
+ two-dimensional texturing is performed
+ (unless three-dimensional or cube-mapped texturing is also enabled).
+ See "
+ (code "glTexImage2D")
+ ". "))
+ (entry (% (heading (code "GL_TEXTURE_3D")))
+ (para)
+ (para "
+If enabled and no fragment shader is active,
+ three-dimensional texturing is performed
+ (unless cube-mapped texturing is also enabled).
+ See "
+ (code "glTexImage3D")
+ ". "))
+ (entry (% (heading (code "GL_TEXTURE_CUBE_MAP")))
+ (para)
+ (para "
+If enabled and no fragment shader is active,
+ cube-mapped texturing is performed.
+ See "
+ (code "glTexImage2D")
+ ". "))
+ (entry (% (heading (code "GL_TEXTURE_GEN_Q")))
+ (para)
+ (para "
+If enabled and no vertex shader is active,
+ the "
+ (var "q")
+ " texture coordinate is computed using
+ the texture generation function defined with "
+ (code "glTexGen")
+ ".
+ Otherwise, the current "
+ (var "q")
+ " texture coordinate is used.
+ See "
+ (code "glTexGen")
+ ". "))
+ (entry (% (heading (code "GL_TEXTURE_GEN_R")))
+ (para)
+ (para "
+If enabled and no vertex shader is active,
+ the "
+ (var "r")
+ " texture coordinate is computed using
+ the texture generation function defined with "
+ (code "glTexGen")
+ ".
+ Otherwise, the current "
+ (var "r")
+ " texture coordinate is used.
+ See "
+ (code "glTexGen")
+ ". "))
+ (entry (% (heading (code "GL_TEXTURE_GEN_S")))
+ (para)
+ (para "
+If enabled and no vertex shader is active,
+ the "
+ (var "s")
+ " texture coordinate is computed using
+ the texture generation function defined with "
+ (code "glTexGen")
+ ".
+ Otherwise, the current "
+ (var "s")
+ " texture coordinate is used.
+ See "
+ (code "glTexGen")
+ ". "))
+ (entry (% (heading (code "GL_TEXTURE_GEN_T")))
+ (para)
+ (para "
+If enabled and no vertex shader is active,
+ the "
+ (var "t")
+ " texture coordinate is computed using
+ the texture generation function defined with "
+ (code "glTexGen")
+ ".
+ Otherwise, the current "
+ (var "t")
+ " texture coordinate is used.
+ See "
+ (code "glTexGen")
+ ". "))
+ (entry (% (heading (code "GL_VERTEX_PROGRAM_POINT_SIZE")))
+ (para)
+ (para "
+If enabled
+ and a vertex shader is active, then the derived point size is taken from the (potentially clipped) shader builtin "
+ (code "gl_PointSize")
+ " and clamped to the implementation-dependent point size range. "))
+ (entry (% (heading (code "GL_VERTEX_PROGRAM_TWO_SIDE")))
+ (para)
+ (para "
+If enabled
+ and a vertex shader is active, it specifies that the GL will choose between front and back colors based on the
+ polygon's face direction of which the vertex being shaded is a part. It has no effect on points or lines. ")))
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "cap")
+ " is not one of the values
+ listed previously. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glEnable")
+ " or "
+ (code "glDisable")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glEvalCoord
+ "glEvalCoord"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glEvalCoord1f"))
+ (paramdef "GLfloat " (parameter "u"))))
+ '(*fragment*
+ (heading
+ "evaluate enabled one- and two-dimensional maps")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "u")))
+ (para "
+Specifies a value that is the domain coordinate "
+ (math (var "u"))
+ "
+to the basis function
+ defined in a previous "
+ (code "glMap1")
+ " or "
+ (code "glMap2")
+ " command. "))
+ (entry (% (heading (var "v")))
+ (para "
+Specifies a value that is the domain coordinate "
+ (math (var "v"))
+ "
+to the basis function
+ defined in a previous "
+ (code "glMap2")
+ " command.
+ This argument is not present in a "
+ (code "glEvalCoord1")
+ " command. ")))
+ (heading "Description")
+ (para (code "glEvalCoord1")
+ " evaluates enabled one-dimensional maps at argument "
+ (var "u")
+ ". "
+ (code "glEvalCoord2")
+ " does the same for two-dimensional maps using
+ two domain values, "
+ (var "u")
+ " and "
+ (var "v")
+ ".
+ To define a map, call "
+ (code "glMap1")
+ " and "
+ (code "glMap2")
+ "; to enable and
+ disable it, call "
+ (code "glEnable")
+ " and "
+ (code "glDisable")
+ ". ")
+ (para "
+When one of the "
+ (code "glEvalCoord")
+ " commands is issued,
+ all currently enabled maps of the indicated dimension are evaluated.
+ Then,
+ for each enabled map,
+ it is as if the corresponding GL command had been issued with the
+ computed value.
+ That is,
+ if "
+ (code "GL_MAP1_INDEX")
+ " or "
+ (code "GL_MAP2_INDEX")
+ " is enabled,
+ a "
+ (code "glIndex")
+ " command is simulated.
+ If "
+ (code "GL_MAP1_COLOR_4")
+ " or "
+ (code "GL_MAP2_COLOR_4")
+ " is enabled,
+ a "
+ (code "glColor")
+ " command is simulated.
+ If "
+ (code "GL_MAP1_NORMAL")
+ " or "
+ (code "GL_MAP2_NORMAL")
+ " is enabled,
+ a normal vector is produced,
+ and if any of "
+ (code "GL_MAP1_TEXTURE_COORD_1")
+ ", "
+ (code "GL_MAP1_TEXTURE_COORD_2")
+ ", "
+ (code "GL_MAP1_TEXTURE_COORD_3")
+ ", "
+ (code "GL_MAP1_TEXTURE_COORD_4")
+ ", "
+ (code "GL_MAP2_TEXTURE_COORD_1")
+ ", "
+ (code "GL_MAP2_TEXTURE_COORD_2")
+ ", "
+ (code "GL_MAP2_TEXTURE_COORD_3")
+ ", or "
+ (code "GL_MAP2_TEXTURE_COORD_4")
+ " is enabled, then an appropriate "
+ (code "glTexCoord")
+ " command is simulated. ")
+ (para "
+For color,
+ color index,
+ normal,
+ and texture coordinates the GL uses evaluated values instead of current values for those evaluations
+ that are enabled,
+ and current values otherwise,
+ However,
+ the evaluated values do not update the current values.
+ Thus, if "
+ (code "glVertex")
+ " commands are interspersed with "
+ (code "glEvalCoord")
+ "
+commands, the color,
+ normal,
+ and texture coordinates associated with the "
+ (code "glVertex")
+ " commands are not
+ affected by the values generated by the "
+ (code "glEvalCoord")
+ " commands,
+ but only by the most recent "
+ (code "glColor")
+ ", "
+ (code "glIndex")
+ ", "
+ (code "glNormal")
+ ", and "
+ (code "glTexCoord")
+ " commands. ")
+ (para "
+No commands are issued for maps that are not enabled.
+ If more than one texture evaluation is enabled for a particular dimension
+ (for example, "
+ (code "GL_MAP2_TEXTURE_COORD_1")
+ " and "
+ (code "GL_MAP2_TEXTURE_COORD_2")
+ "),
+ then only the evaluation of the map that produces the larger
+ number of coordinates
+ (in this case, "
+ (code "GL_MAP2_TEXTURE_COORD_2")
+ ")
+ is carried out. "
+ (code "GL_MAP1_VERTEX_4")
+ " overrides "
+ (code "GL_MAP1_VERTEX_3")
+ ",
+ and "
+ (code "GL_MAP2_VERTEX_4")
+ " overrides "
+ (code "GL_MAP2_VERTEX_3")
+ ",
+ in the same manner.
+ If neither a three- nor a four-component vertex map is enabled for the
+ specified dimension,
+ the "
+ (code "glEvalCoord")
+ " command is ignored. ")
+ (para "
+If you have enabled automatic normal generation,
+ by calling "
+ (code "glEnable")
+ " with argument "
+ (code "GL_AUTO_NORMAL")
+ ", "
+ (code "glEvalCoord2")
+ " generates surface normals analytically,
+ regardless of the contents or enabling of the "
+ (code "GL_MAP2_NORMAL")
+ " map.
+ Let ")
+ (para (math (code "m")
+ "="
+ "∂"
+ (code "p")
+ ","
+ "/"
+ "∂"
+ (var "u")
+ ","
+ ","
+ "×"
+ "∂"
+ (code "p")
+ ","
+ "/"
+ "∂"
+ (var "v")
+ ","
+ ","))
+ (para "
+Then the generated normal "
+ (math (code "n"))
+ "
+is "
+ (math (code "n")
+ "="
+ (code "m")
+ "/"
+ "∥"
+ (code "m")
+ ","
+ "∥"
+ ","))
+ (para "
+If automatic normal generation is disabled,
+ the corresponding normal map "
+ (code "GL_MAP2_NORMAL")
+ ",
+ if enabled,
+ is used to produce a normal.
+ If neither automatic normal generation nor a normal map is enabled,
+ no normal is generated for "
+ (code "glEvalCoord2")
+ " commands. ")))
+
+(define-gl-procedure
+ glEvalMesh
+ "glEvalMesh"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glEvalMesh1"))
+ (paramdef "GLenum " (parameter "mode"))
+ (paramdef "GLint " (parameter "i1"))
+ (paramdef "GLint " (parameter "i2"))))
+ '(*fragment*
+ (heading
+ "compute a one- or two-dimensional grid of points or lines")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "mode")))
+ (para "
+In "
+ (code "glEvalMesh1")
+ ", specifies whether to compute a one-dimensional mesh of points or lines.
+ Symbolic constants "
+ (code "GL_POINT")
+ " and "
+ (code "GL_LINE")
+ " are accepted. "))
+ (entry (% (heading (var "i1")))
+ (itemx (var "i2"))
+ (para "
+Specify the first and last integer values for grid domain variable "
+ (math (var "i"))
+ ". ")))
+ (heading "Description")
+ (para (code "glMapGrid")
+ " and "
+ (code "glEvalMesh")
+ " are used in tandem to efficiently
+ generate and evaluate a series of evenly-spaced map domain values. "
+ (code "glEvalMesh")
+ " steps through the integer domain of a one- or two-dimensional grid,
+ whose range is the domain of the evaluation maps specified by "
+ (code "glMap1")
+ " and "
+ (code "glMap2")
+ ". "
+ (var "mode")
+ " determines whether the resulting vertices are connected as
+ points,
+ lines,
+ or filled polygons. ")
+ (para "
+In the one-dimensional case, "
+ (code "glEvalMesh1")
+ ",
+ the mesh is generated as if the following code fragment were executed: ")
+ (para "
+where ")
+ (example
+ "
+glBegin( "
+ (var "type")
+ " );
+for ( i = "
+ (var "i1")
+ "; i <= "
+ (var "i2")
+ "; i += 1 )
+ glEvalCoord1( "
+ (math "i"
+ "·"
+ "Δ"
+ (var "u")
+ "+"
+ (var "u")
+ "_"
+ "1")
+ " );
+glEnd(); ")
+ (para (math "Δ"
+ (var "u")
+ "="
+ "("
+ (var "u")
+ "_"
+ "2"
+ "-"
+ (var "u")
+ "_"
+ "1"
+ ","
+ ")"
+ "/"
+ (var "n")))
+ (para "
+and "
+ (math (var "n"))
+ ", "
+ (math (var "u") "_" "1")
+ ",
+ and "
+ (math (var "u") "_" "2")
+ "
+are the arguments to the most recent "
+ (code "glMapGrid1")
+ " command. "
+ (var "type")
+ " is "
+ (code "GL_POINTS")
+ " if "
+ (var "mode")
+ " is "
+ (code "GL_POINT")
+ ",
+ or "
+ (code "GL_LINES")
+ " if "
+ (var "mode")
+ " is "
+ (code "GL_LINE")
+ ". ")
+ (para "
+The one absolute numeric requirement is that if "
+ (math (var "i") "=" (var "n"))
+ ",
+ then the
+ value computed from "
+ (math (var "i")
+ "·"
+ "Δ"
+ (var "u")
+ "+"
+ (var "u")
+ "_"
+ "1")
+ "
+is exactly "
+ (math (var "u") "_" "2")
+ ". ")
+ (para "
+In the two-dimensional case, "
+ (code "glEvalMesh2")
+ ", let
+ .cp "
+ (math "Δ"
+ (var "u")
+ "="
+ "("
+ (var "u")
+ "_"
+ "2"
+ "-"
+ (var "u")
+ "_"
+ "1"
+ ","
+ ")"
+ "/"
+ (var "n")))
+ (para (math "Δ"
+ (var "v")
+ "="
+ "("
+ (var "v")
+ "_"
+ "2"
+ "-"
+ (var "v")
+ "_"
+ "1"
+ ","
+ ")"
+ "/"
+ (var "m")))
+ (para "
+where "
+ (math (var "n"))
+ ", "
+ (math (var "u") "_" "1")
+ ", "
+ (math (var "u") "_" "2")
+ ", "
+ (math (var "m"))
+ ", "
+ (math (var "v") "_" "1")
+ ",
+ and "
+ (math (var "v") "_" "2")
+ "
+are the
+ arguments to the most recent "
+ (code "glMapGrid2")
+ " command. Then, if "
+ (var "mode")
+ " is "
+ (code "GL_FILL")
+ ", the "
+ (code "glEvalMesh2")
+ " command is equivalent
+ to: ")
+ (para)
+ (example
+ "
+for ( j = "
+ (var "j1")
+ "; j < "
+ (var "j2")
+ "; j += 1 ) {
+ glBegin( GL_QUAD_STRIP );
+ for ( i = "
+ (var "i1")
+ "; i <= "
+ (var "i2")
+ "; i += 1 ) {
+ glEvalCoord2( "
+ (math "i"
+ "·"
+ "Δ"
+ (var "u")
+ "+"
+ (var "u")
+ "_"
+ "1"
+ ","
+ "j"
+ "·"
+ "Δ"
+ (var "v")
+ "+"
+ (var "v")
+ "_"
+ "1")
+ " );
+ glEvalCoord2( "
+ (math "i"
+ "·"
+ "Δ"
+ (var "u")
+ "+"
+ (var "u")
+ "_"
+ "1"
+ ","
+ "("
+ "j"
+ "+"
+ "1"
+ ","
+ ")"
+ "·"
+ "Δ"
+ (var "v")
+ "+"
+ (var "v")
+ "_"
+ "1")
+ " );
+ }
+ glEnd();
+} ")
+ (para "
+If "
+ (var "mode")
+ " is "
+ (code "GL_LINE")
+ ", then a call to "
+ (code "glEvalMesh2")
+ " is equivalent to: ")
+ (para)
+ (example
+ "
+for ( j = "
+ (var "j1")
+ "; j <= "
+ (var "j2")
+ "; j += 1 ) {
+ glBegin( GL_LINE_STRIP );
+ for ( i = "
+ (var "i1")
+ "; i <= "
+ (var "i2")
+ "; i += 1 )
+ glEvalCoord2( "
+ (math "i"
+ "·"
+ "Δ"
+ (var "u")
+ "+"
+ (var "u")
+ "_"
+ "1"
+ ","
+ "j"
+ "·"
+ "Δ"
+ (var "v")
+ "+"
+ (var "v")
+ "_"
+ "1")
+ " );
+ glEnd();
+}
+
+for ( i = "
+ (var "i1")
+ "; i <= "
+ (var "i2")
+ "; i += 1 ) {
+ glBegin( GL_LINE_STRIP );
+ for ( j = "
+ (var "j1")
+ "; j <= "
+ (var "j1")
+ "; j += 1 )
+ glEvalCoord2( "
+ (math "i"
+ "·"
+ "Δ"
+ (var "u")
+ "+"
+ (var "u")
+ "_"
+ "1"
+ ","
+ "j"
+ "·"
+ "Δ"
+ (var "v")
+ "+"
+ (var "v")
+ "_"
+ "1")
+ " );
+ glEnd();
+} ")
+ (para "
+And finally, if "
+ (var "mode")
+ " is "
+ (code "GL_POINT")
+ ", then a call to "
+ (code "glEvalMesh2")
+ " is equivalent to: ")
+ (para)
+ (example
+ "
+glBegin( GL_POINTS );
+for ( j = "
+ (var "j1")
+ "; j <= "
+ (var "j2")
+ "; j += 1 )
+ for ( i = "
+ (var "i1")
+ "; i <= "
+ (var "i2")
+ "; i += 1 )
+ glEvalCoord2( "
+ (math "i"
+ "·"
+ "Δ"
+ (var "u")
+ "+"
+ (var "u")
+ "_"
+ "1"
+ ","
+ "j"
+ "·"
+ "Δ"
+ (var "v")
+ "+"
+ (var "v")
+ "_"
+ "1")
+ " );
+glEnd(); ")
+ (para "
+In all three cases, the only absolute numeric requirements are that if "
+ (math (var "i") "=" (var "n"))
+ ",
+ then the value computed from "
+ (math (var "i")
+ "·"
+ "Δ"
+ (var "u")
+ "+"
+ (var "u")
+ "_"
+ "1")
+ "
+is exactly "
+ (math (var "u") "_" "2")
+ ",
+ and if "
+ (math (var "j") "=" (var "m"))
+ ",
+ then the value computed from "
+ (math (var "j")
+ "·"
+ "Δ"
+ (var "v")
+ "+"
+ (var "v")
+ "_"
+ "1")
+ "
+is exactly "
+ (math (var "v") "_" "2")
+ ". ")
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "mode")
+ " is not an accepted value. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glEvalMesh")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glEvalPoint
+ "glEvalPoint"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glEvalPoint1"))
+ (paramdef "GLint " (parameter "i"))))
+ '(*fragment*
+ (heading
+ "generate and evaluate a single point in a mesh")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "i")))
+ (para "
+Specifies the integer value for grid domain variable "
+ (math (var "i"))
+ ". "))
+ (entry (% (heading (var "j")))
+ (para "
+Specifies the integer value for grid domain variable "
+ (math (var "j"))
+ "
+("
+ (code "glEvalPoint2")
+ " only). ")))
+ (heading "Description")
+ (para (code "glMapGrid")
+ " and "
+ (code "glEvalMesh")
+ " are used in tandem to efficiently
+ generate and evaluate a series of evenly spaced map domain values. "
+ (code "glEvalPoint")
+ " can be used to evaluate a single grid point in the same gridspace
+ that is traversed by "
+ (code "glEvalMesh")
+ ".
+ Calling "
+ (code "glEvalPoint1")
+ " is equivalent to calling "
+ "
+where "
+ (math "Δ"
+ (var "u")
+ "="
+ "("
+ (var "u")
+ "_"
+ "2"
+ "-"
+ (var "u")
+ "_"
+ "1"
+ ","
+ ")"
+ "/"
+ (var "n")))
+ (example
+ "
+glEvalCoord1( "
+ (math "i"
+ "·"
+ "Δ"
+ (var "u")
+ "+"
+ (var "u")
+ "_"
+ "1")
+ " ); ")
+ (para "
+and "
+ (math (var "n"))
+ ", "
+ (math (var "u") "_" "1")
+ ",
+ and "
+ (math (var "u") "_" "2")
+ "
+are the arguments to the most recent "
+ (code "glMapGrid1")
+ " command.
+ The one absolute numeric requirement is that if "
+ (math (var "i") "=" (var "n"))
+ ",
+ then the value computed from "
+ (math (var "i")
+ "·"
+ "Δ"
+ (var "u")
+ "+"
+ (var "u")
+ "_"
+ "1")
+ "
+is exactly "
+ (math (var "u") "_" "2")
+ ". ")
+ (para "
+In the two-dimensional case, "
+ (code "glEvalPoint2")
+ ", let ")
+ (para (math "Δ"
+ (var "u")
+ "="
+ "("
+ (var "u")
+ "_"
+ "2"
+ "-"
+ (var "u")
+ "_"
+ "1"
+ ","
+ ")"
+ "/"
+ (var "n"))
+ (para (math "Δ"
+ (var "v")
+ "="
+ "("
+ (var "v")
+ "_"
+ "2"
+ "-"
+ (var "v")
+ "_"
+ "1"
+ ","
+ ")"
+ "/"
+ (var "m"))))
+ (para "
+where "
+ (math (var "n"))
+ ", "
+ (math (var "u") "_" "1")
+ ", "
+ (math (var "u") "_" "2")
+ ", "
+ (math (var "m"))
+ ", "
+ (math (var "v") "_" "1")
+ ",
+ and "
+ (math (var "v") "_" "2")
+ "
+are the arguments to the most recent "
+ (code "glMapGrid2")
+ " command.
+ Then the "
+ (code "glEvalPoint2")
+ " command is equivalent to calling "
+ "
+The only absolute numeric requirements are that if "
+ (math (var "i") "=" (var "n"))
+ ",
+ then the value computed from "
+ (math (var "i")
+ "·"
+ "Δ"
+ (var "u")
+ "+"
+ (var "u")
+ "_"
+ "1")
+ "
+is exactly "
+ (math (var "u") "_" "2")
+ ",
+ and if "
+ (math (var "j") "=" (var "m"))
+ ",
+ then the value computed from "
+ (math (var "j")
+ "·"
+ "Δ"
+ (var "v")
+ "+"
+ (var "v")
+ "_"
+ "1")
+ "
+is exactly "
+ (math (var "v") "_" "2")
+ ". ")
+ (example
+ "
+glEvalCoord2( "
+ (math "i"
+ "·"
+ "Δ"
+ (var "u")
+ "+"
+ (var "u")
+ "_"
+ "1"
+ ","
+ "j"
+ "·"
+ "Δ"
+ (var "v")
+ "+"
+ (var "v")
+ "_"
+ "1")
+ " ); ")))
+
+(define-gl-procedure
+ glFeedbackBuffer
+ "glFeedbackBuffer"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glFeedbackBuffer"))
+ (paramdef "GLsizei " (parameter "size"))
+ (paramdef "GLenum " (parameter "type"))
+ (paramdef "GLfloat * " (parameter "buffer"))))
+ '(*fragment*
+ (heading "controls feedback mode")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "size")))
+ (para "
+Specifies the maximum number of values that can be written into "
+ (var "buffer")
+ ". "))
+ (entry (% (heading (var "type")))
+ (para "
+Specifies a symbolic constant that describes the information
+ that will be returned for each vertex. "
+ (code "GL_2D")
+ ", "
+ (code "GL_3D")
+ ", "
+ (code "GL_3D_COLOR")
+ ", "
+ (code "GL_3D_COLOR_TEXTURE")
+ ", and "
+ (code "GL_4D_COLOR_TEXTURE")
+ " are accepted. "))
+ (entry (% (heading (var "buffer")))
+ (para "
+Returns the feedback data. ")))
+ (heading "Description")
+ (para "
+The "
+ (code "glFeedbackBuffer")
+ " function controls feedback.
+ Feedback, like selection, is a GL mode.
+ The mode is selected by calling "
+ (code "glRenderMode")
+ " with "
+ (code "GL_FEEDBACK")
+ ".
+ When the GL is in feedback mode,
+ no pixels are produced by rasterization.
+ Instead, information about primitives that would have been
+ rasterized is fed back to the application using the GL. ")
+ (para (code "glFeedbackBuffer")
+ " has three arguments: "
+ (var "buffer")
+ " is a pointer to an array of floating-point values
+ into which feedback information is placed. "
+ (var "size")
+ " indicates the size of the array. "
+ (var "type")
+ " is a symbolic constant describing the information
+ that is fed back for each vertex. "
+ (code "glFeedbackBuffer")
+ " must be issued before feedback mode is enabled
+ (by calling "
+ (code "glRenderMode")
+ " with argument "
+ (code "GL_FEEDBACK")
+ ").
+ Setting "
+ (code "GL_FEEDBACK")
+ " without establishing the feedback buffer,
+ or calling "
+ (code "glFeedbackBuffer")
+ " while the GL is in feedback mode,
+ is an error. ")
+ (para "
+When "
+ (code "glRenderMode")
+ " is called while in feedback mode, it returns the number of entries
+ placed in the feedback array and resets the feedback array pointer to the base
+ of the feedback buffer. The returned value never exceeds "
+ (var "size")
+ ". If the feedback
+ data required more room than was available in "
+ (var "buffer")
+ ", "
+ (code "glRenderMode")
+ " returns a negative value.
+ To take the GL out of feedback mode, call "
+ (code "glRenderMode")
+ " with a parameter value other than "
+ (code "GL_FEEDBACK")
+ ". ")
+ (para "
+While in feedback mode,
+ each primitive, bitmap, or pixel rectangle that would be rasterized
+ generates a block of values that are copied into the feedback array.
+ If doing so would cause the number of entries to exceed the maximum,
+ the block is partially written so as to fill the array
+ (if there is any room left at all),
+ and an overflow flag is set.
+ Each block begins with a code indicating the primitive type,
+ followed by values that describe the primitive's vertices and
+ associated data.
+ Entries are also written for bitmaps and pixel rectangles.
+ Feedback occurs after polygon culling and "
+ (code "glPolygonMode")
+ " interpretation
+ of polygons has taken place,
+ so polygons that are culled are not returned in the feedback buffer.
+ It can also occur after polygons with more than three edges are broken up
+ into triangles,
+ if the GL implementation renders polygons by performing this decomposition. ")
+ (para "
+The "
+ (code "glPassThrough")
+ " command can be used to insert a marker
+ into the feedback buffer.
+ See "
+ (code "glPassThrough")
+ ". ")
+ (para "
+Following is the grammar for the blocks of values written
+ into the feedback buffer.
+ Each primitive is indicated with a unique identifying value
+ followed by some number of vertices.
+ Polygon entries include an integer value indicating how many vertices follow.
+ A vertex is fed back as some number of floating-point values,
+ as determined by "
+ (var "type")
+ ".
+ Colors are fed back as four values in RGBA mode and one value
+ in color index mode. ")
+ (para (para "
+feedbackList "
+ (math "←")
+ " feedbackItem feedbackList | feedbackItem ")
+ (para "
+feedbackItem "
+ (math "←")
+ " point | lineSegment | polygon | bitmap | pixelRectangle | passThru ")
+ (para "
+point "
+ (math "←")
+ (code "GL_POINT_TOKEN")
+ " vertex ")
+ (para "
+lineSegment "
+ (math "←")
+ (code "GL_LINE_TOKEN")
+ " vertex vertex | "
+ (code "GL_LINE_RESET_TOKEN")
+ " vertex vertex ")
+ (para "
+polygon "
+ (math "←")
+ (code "GL_POLYGON_TOKEN")
+ " n polySpec ")
+ (para "
+polySpec "
+ (math "←")
+ " polySpec vertex | vertex vertex vertex ")
+ (para "
+bitmap "
+ (math "←")
+ (code "GL_BITMAP_TOKEN")
+ " vertex ")
+ (para "
+pixelRectangle "
+ (math "←")
+ (code "GL_DRAW_PIXEL_TOKEN")
+ " vertex | "
+ (code "GL_COPY_PIXEL_TOKEN")
+ " vertex ")
+ (para "
+passThru "
+ (math "←")
+ (code "GL_PASS_THROUGH_TOKEN")
+ " value ")
+ (para "
+vertex "
+ (math "←")
+ " 2d | 3d | 3dColor | 3dColorTexture | 4dColorTexture ")
+ (para "
+2d " (math "←") " value value ")
+ (para "
+3d " (math "←") " value value value ")
+ (para "
+3dColor "
+ (math "←")
+ " value value value color ")
+ (para "
+3dColorTexture "
+ (math "←")
+ " value value value color tex ")
+ (para "
+4dColorTexture "
+ (math "←")
+ " value value value value color tex ")
+ (para "
+color " (math "←") " rgba | index ")
+ (para "
+rgba "
+ (math "←")
+ " value value value value ")
+ (para "
+index " (math "←") " value ")
+ (para "
+tex "
+ (math "←")
+ " value value value value ")
+ (para))
+ (para (var "value")
+ "
+is a floating-point number,
+ and "
+ (var "n")
+ "
+is a floating-point integer giving the number of vertices in the polygon. "
+ (code "GL_POINT_TOKEN")
+ ", "
+ (code "GL_LINE_TOKEN")
+ ", "
+ (code "GL_LINE_RESET_TOKEN")
+ ", "
+ (code "GL_POLYGON_TOKEN")
+ ", "
+ (code "GL_BITMAP_TOKEN")
+ ", "
+ (code "GL_DRAW_PIXEL_TOKEN")
+ ", "
+ (code "GL_COPY_PIXEL_TOKEN")
+ " and "
+ (code "GL_PASS_THROUGH_TOKEN")
+ " are symbolic floating-point constants. "
+ (code "GL_LINE_RESET_TOKEN")
+ " is returned whenever the line stipple pattern
+ is reset.
+ The data returned as a vertex depends on the feedback "
+ (var "type")
+ ". ")
+ (para "
+The following table gives the correspondence between "
+ (var "type")
+ "
+and the number of values per vertex. "
+ (var "k")
+ " is 1 in color index mode and 4 in RGBA mode. ")
+ (para)
+ (table (% (formatter (asis)))
+ (entry (% (heading (strong "Type")))
+ (para (strong "Coordinates")
+ ", "
+ (strong "Color")
+ ", "
+ (strong "Texture")
+ ", "
+ (strong "Total Number of Values")))
+ (entry (% (heading (code "GL_2D")))
+ (para (var "x")
+ ", "
+ (var "y")
+ ", "
+ ", "
+ ", "
+ "
+2 "))
+ (entry (% (heading (code "GL_3D")))
+ (para (var "x")
+ ", "
+ (var "y")
+ ", "
+ (var "z")
+ ", "
+ ", "
+ ", "
+ "
+3 "))
+ (entry (% (heading (code "GL_3D_COLOR")))
+ (para (var "x")
+ ", "
+ (var "y")
+ ", "
+ (var "z")
+ ", "
+ (math (var "k"))
+ ", "
+ ", "
+ (math "3" "+" (var "k"))))
+ (entry (% (heading (code "GL_3D_COLOR_TEXTURE")))
+ (para (var "x")
+ ", "
+ (var "y")
+ ", "
+ (var "z")
+ ", "
+ (math (var "k"))
+ ", "
+ "
+4 "
+ ", "
+ (math "7" "+" (var "k"))))
+ (entry (% (heading (code "GL_4D_COLOR_TEXTURE")))
+ (para (var "x")
+ ", "
+ (var "y")
+ ", "
+ (var "z")
+ ", "
+ (var "w")
+ ", "
+ (math (var "k"))
+ ", "
+ "
+4 "
+ ", "
+ (math "8" "+" (var "k")))))
+ (para "
+Feedback vertex coordinates are in window coordinates,
+ except "
+ (var "w")
+ ",
+ which is in clip coordinates.
+ Feedback colors are lighted, if lighting is enabled.
+ Feedback texture coordinates are generated,
+ if texture coordinate generation is enabled.
+ They are always transformed by the texture matrix. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "type")
+ " is not an accepted value. ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "size")
+ " is negative. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glFeedbackBuffer")
+ " is called while the
+ render mode is "
+ (code "GL_FEEDBACK")
+ ",
+ or if "
+ (code "glRenderMode")
+ " is called with argument "
+ (code "GL_FEEDBACK")
+ " before "
+ (code "glFeedbackBuffer")
+ " is called at least once. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glFeedbackBuffer")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glFinish
+ "glFinish"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glFinish"))
+ (paramdef (parameter "void"))))
+ '(*fragment*
+ (heading
+ "block until all GL execution is complete")
+ (heading "Description")
+ (para (code "glFinish")
+ " does not return until the effects of all previously
+ called GL commands are complete.
+ Such effects include all changes to GL state,
+ all changes to connection state,
+ and all changes to the frame buffer contents. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glFinish")
+ " is executed between
+ the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glFlush
+ "glFlush"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glFlush"))
+ (paramdef (parameter "void"))))
+ '(*fragment*
+ (heading
+ "force execution of GL commands in finite time")
+ (heading "Description")
+ (para "
+Different GL implementations buffer commands in several different locations,
+ including network buffers and the graphics accelerator itself. "
+ (code "glFlush")
+ " empties all of these buffers,
+ causing all issued commands to be executed as quickly as
+ they are accepted by the actual rendering engine.
+ Though this execution may not be completed in any particular
+ time period,
+ it does complete in finite time. ")
+ (para "
+Because any GL program might be executed over a network,
+ or on an accelerator that buffers commands,
+ all programs should call "
+ (code "glFlush")
+ " whenever they count on having
+ all of their previously issued commands completed.
+ For example,
+ call "
+ (code "glFlush")
+ " before waiting for user input that depends on
+ the generated image. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glFlush")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glFogCoordPointer
+ "glFogCoordPointer"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glFogCoordPointer"))
+ (paramdef "GLenum " (parameter "type"))
+ (paramdef "GLsizei " (parameter "stride"))
+ (paramdef "GLvoid * " (parameter "pointer"))))
+ '(*fragment*
+ (heading "define an array of fog coordinates")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "type")))
+ (para "
+Specifies the data type of each fog coordinate.
+ Symbolic constants "
+ (code "GL_FLOAT")
+ ",
+ or "
+ (code "GL_DOUBLE")
+ "
+are accepted. The initial value is "
+ (code "GL_FLOAT")
+ ". "))
+ (entry (% (heading (var "stride")))
+ (para "
+Specifies the byte offset between consecutive fog coordinates.
+ If "
+ (var "stride")
+ " is 0, the array elements are understood
+ to be tightly packed. The initial value is 0. "))
+ (entry (% (heading (var "pointer")))
+ (para "
+Specifies a pointer to the first coordinate of the first fog coordinate in the
+ array. The initial value is 0. ")))
+ (heading "Description")
+ (para (code "glFogCoordPointer")
+ " specifies the location and data format of an array of fog coordinates
+ to use when rendering. "
+ (var "type")
+ " specifies the data type of each fog
+ coordinate, and "
+ (var "stride")
+ " specifies the byte stride from one fog coordinate to
+ the next, allowing vertices and attributes to be packed into a single array
+ or stored in separate arrays. ")
+ (para "
+If a non-zero named buffer object is bound to the "
+ (code "GL_ARRAY_BUFFER")
+ " target
+ (see "
+ (code "glBindBuffer")
+ ") while a fog coordinate array is
+ specified, "
+ (var "pointer")
+ " is treated as a byte offset into the buffer object's data store.
+ Also, the buffer object binding ("
+ (code "GL_ARRAY_BUFFER_BINDING")
+ ") is saved as fog coordinate vertex array
+ client-side state ("
+ (code "GL_FOG_COORD_ARRAY_BUFFER_BINDING")
+ "). ")
+ (para "
+When a fog coordinate array is specified, "
+ (var "type")
+ ", "
+ (var "stride")
+ ", and "
+ (var "pointer")
+ " are saved as client-side
+ state, in addition to the current vertex array buffer object binding. ")
+ (para "
+To enable and disable the fog coordinate array, call "
+ (code "glEnableClientState")
+ " and "
+ (code "glDisableClientState")
+ " with the argument "
+ (code "GL_FOG_COORD_ARRAY")
+ ". If
+ enabled, the fog coordinate array is used
+ when "
+ (code "glDrawArrays")
+ ", "
+ (code "glMultiDrawArrays")
+ ", "
+ (code "glDrawElements")
+ ", "
+ (code "glMultiDrawElements")
+ ", "
+ (code "glDrawRangeElements")
+ ", or "
+ (code "glArrayElement")
+ " is called. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "type")
+ " is not either "
+ (code "GL_FLOAT")
+ "
+or "
+ (code "GL_DOUBLE")
+ ". ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "stride")
+ " is negative. ")))
+
+(define-gl-procedure
+ glFogCoord
+ "glFogCoord"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glFogCoordd"))
+ (paramdef "GLdouble " (parameter "coord"))))
+ '(*fragment*
+ (heading "set the current fog coordinates")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "coord")))
+ (para "
+Specify the fog distance. ")))
+ (heading "Description")
+ (para (code "glFogCoord")
+ " specifies the fog coordinate that is associated with each vertex and
+ the current raster position. The value specified is interpolated and used
+ in computing the fog color (see "
+ (code "glFog")
+ "). ")))
+
+(define-gl-procedure
+ glFog
+ "glFog"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glFogf"))
+ (paramdef "GLenum " (parameter "pname"))
+ (paramdef "GLfloat " (parameter "param"))))
+ '(*fragment*
+ (heading "specify fog parameters")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "pname")))
+ (para "
+Specifies a single-valued fog parameter. "
+ (code "GL_FOG_MODE")
+ ", "
+ (code "GL_FOG_DENSITY")
+ ", "
+ (code "GL_FOG_START")
+ ", "
+ (code "GL_FOG_END")
+ ", "
+ (code "GL_FOG_INDEX")
+ ", and "
+ (code "GL_FOG_COORD_SRC")
+ "
+are accepted. "))
+ (entry (% (heading (var "param")))
+ (para "
+Specifies the value that "
+ (var "pname")
+ " will be set to. ")))
+ (heading "Description")
+ (para "
+Fog is initially disabled.
+ While enabled, fog affects rasterized geometry,
+ bitmaps, and pixel blocks, but not buffer clear operations. To enable
+ and disable fog, call "
+ (code "glEnable")
+ " and "
+ (code "glDisable")
+ " with argument "
+ (code "GL_FOG")
+ ". ")
+ (para (code "glFog")
+ " assigns the value or values in "
+ (var "params")
+ " to the fog parameter
+ specified by "
+ (var "pname")
+ ".
+ The following values are accepted for "
+ (var "pname")
+ ": ")
+ (table (% (formatter (asis)))
+ (entry (% (heading (code "GL_FOG_MODE")))
+ (para (var "params")
+ " is a single integer or floating-point value that specifies
+ the equation to be used to compute the fog blend factor, "
+ (math (var "f"))
+ ".
+ Three symbolic constants are accepted: "
+ (code "GL_LINEAR")
+ ", "
+ (code "GL_EXP")
+ ",
+ and "
+ (code "GL_EXP2")
+ ".
+ The equations corresponding to these symbolic constants are defined below.
+ The initial fog mode is "
+ (code "GL_EXP")
+ ". "))
+ (entry (% (heading (code "GL_FOG_DENSITY")))
+ (para (var "params")
+ " is a single integer or floating-point value that specifies "
+ (math (var "density"))
+ ",
+ the fog density used in both exponential fog equations.
+ Only nonnegative densities are accepted.
+ The initial fog density is 1. "))
+ (entry (% (heading (code "GL_FOG_START")))
+ (para (var "params")
+ " is a single integer or floating-point value that specifies "
+ (math (var "start"))
+ ",
+ the near distance used in the linear fog equation.
+ The initial near distance is 0. "))
+ (entry (% (heading (code "GL_FOG_END")))
+ (para (var "params")
+ " is a single integer or floating-point value that specifies "
+ (math (var "end"))
+ ",
+ the far distance used in the linear fog equation.
+ The initial far distance is 1. "))
+ (entry (% (heading (code "GL_FOG_INDEX")))
+ (para (var "params")
+ " is a single integer or floating-point value that specifies "
+ (math (var "i") "_" (var "f"))
+ ",
+ the fog color index.
+ The initial fog index is 0. "))
+ (entry (% (heading (code "GL_FOG_COLOR")))
+ (para (var "params")
+ " contains four integer or floating-point values that specify "
+ (math (var "C") "_" (var "f"))
+ ",
+ the fog color.
+ Integer values are mapped linearly such that the most positive representable
+ value maps to 1.0,
+ and the most negative representable value maps to "
+ (math "-1.0")
+ ".
+ Floating-point values are mapped directly.
+ After conversion,
+ all color components are clamped to the range "
+ (math "[" "0" "," "1" "]")
+ ".
+ The initial fog color is (0, 0, 0, 0). "))
+ (entry (% (heading (code "GL_FOG_COORD_SRC")))
+ (para (var "params")
+ " contains either of the following symbolic constants: "
+ (code "GL_FOG_COORD")
+ " or "
+ (code "GL_FRAGMENT_DEPTH")
+ ". "
+ (code "GL_FOG_COORD")
+ "
+specifies that the current fog coordinate should be used as distance value
+ in the fog color computation. "
+ (code "GL_FRAGMENT_DEPTH")
+ " specifies that the
+ current fragment depth should be used as distance value in the fog
+ computation. ")))
+ (para "
+Fog blends a fog color with each rasterized pixel fragment's post-texturing
+ color using a blending factor "
+ (math (var "f"))
+ ".
+ Factor "
+ (math (var "f"))
+ "
+is computed in one of three ways,
+ depending on the fog mode.
+ Let "
+ (math (var "c"))
+ "
+be either the distance in eye coordinate from the origin (in the
+ case that the "
+ (code "GL_FOG_COORD_SRC")
+ " is "
+ (code "GL_FRAGMENT_DEPTH")
+ ") or
+ the current fog coordinate (in the case that "
+ (code "GL_FOG_COORD_SRC")
+ "
+is "
+ (code "GL_FOG_COORD")
+ ").
+ The equation for "
+ (code "GL_LINEAR")
+ " fog is "
+ (math (var "f")
+ "="
+ (var "end")
+ "-"
+ (var "c")
+ ","
+ "/"
+ (var "end")
+ "-"
+ (var "start")
+ ","))
+ (para "
+The equation for "
+ (code "GL_EXP")
+ " fog is "
+ (math (var "f")
+ "="
+ (var "e")
+ "^"
+ "-"
+ "("
+ (var "density")
+ "·"
+ (var "c")
+ ","
+ ")"
+ ","))
+ (para "
+The equation for "
+ (code "GL_EXP2")
+ " fog is "
+ (math (var "f")
+ "="
+ (var "e")
+ "^"
+ "-"
+ "("
+ (var "density")
+ "·"
+ (var "c")
+ ","
+ ")"
+ ","
+ "^"
+ "2"))
+ (para "
+Regardless of the fog mode, "
+ (math (var "f"))
+ "
+is clamped to the range "
+ (math "[" "0" "," "1" "]")
+ "
+after it is computed.
+ Then,
+ if the GL is in RGBA color mode,
+ the fragment's red, green, and blue colors, represented by "
+ (math (var "C") "_" (var "r"))
+ ",
+ are replaced by ")
+ (para (math (var "C")
+ "_"
+ (var "r")
+ ","
+ "^"
+ "″"
+ "="
+ (var "f")
+ "×"
+ (var "C")
+ "_"
+ (var "r")
+ "+"
+ "("
+ "1"
+ "-"
+ (var "f")
+ ","
+ ")"
+ "×"
+ (var "C")
+ "_"
+ (var "f")))
+ (para "
+Fog does not affect a fragment's alpha component. ")
+ (para "
+In color index mode, the fragment's color index "
+ (math (var "i") "_" (var "r"))
+ "
+is replaced by ")
+ (para (math (var "i")
+ "_"
+ (var "r")
+ ","
+ "^"
+ "″"
+ "="
+ (var "i")
+ "_"
+ (var "r")
+ "+"
+ "("
+ "1"
+ "-"
+ (var "f")
+ ","
+ ")"
+ "×"
+ (var "i")
+ "_"
+ (var "f")))
+ (para)
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "pname")
+ " is not an accepted value,
+ or if "
+ (var "pname")
+ " is "
+ (code "GL_FOG_MODE")
+ " and "
+ (var "params")
+ " is not an accepted value. ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "pname")
+ " is "
+ (code "GL_FOG_DENSITY")
+ "
+and "
+ (var "params")
+ " is negative. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glFog")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glFrontFace
+ "glFrontFace"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glFrontFace"))
+ (paramdef "GLenum " (parameter "mode"))))
+ '(*fragment*
+ (heading
+ "define front- and back-facing polygons")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "mode")))
+ (para "
+Specifies the orientation of front-facing polygons. "
+ (code "GL_CW")
+ " and "
+ (code "GL_CCW")
+ " are accepted.
+ The initial value is "
+ (code "GL_CCW")
+ ". ")))
+ (heading "Description")
+ (para "
+In a scene composed entirely of opaque closed surfaces,
+ back-facing polygons are never visible.
+ Eliminating these invisible polygons has the obvious benefit
+ of speeding up the rendering of the image.
+ To enable and disable elimination of back-facing polygons, call "
+ (code "glEnable")
+ "
+and "
+ (code "glDisable")
+ " with argument "
+ (code "GL_CULL_FACE")
+ ". ")
+ (para "
+The projection of a polygon to window coordinates is said to have
+ clockwise winding if an imaginary object following the path
+ from its first vertex,
+ its second vertex,
+ and so on,
+ to its last vertex,
+ and finally back to its first vertex,
+ moves in a clockwise direction about the interior of the polygon.
+ The polygon's winding is said to be counterclockwise if the imaginary
+ object following the same path moves in a counterclockwise direction
+ about the interior of the polygon. "
+ (code "glFrontFace")
+ " specifies whether polygons with clockwise winding in window coordinates,
+ or counterclockwise winding in window coordinates,
+ are taken to be front-facing.
+ Passing "
+ (code "GL_CCW")
+ " to "
+ (var "mode")
+ " selects counterclockwise polygons as
+ front-facing; "
+ (code "GL_CW")
+ " selects clockwise polygons as front-facing.
+ By default, counterclockwise polygons are taken to be front-facing. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "mode")
+ " is not an accepted value. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glFrontFace")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glFrustum
+ "glFrustum"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glFrustum"))
+ (paramdef "GLdouble " (parameter "left"))
+ (paramdef "GLdouble " (parameter "right"))
+ (paramdef "GLdouble " (parameter "bottom"))
+ (paramdef "GLdouble " (parameter "top"))
+ (paramdef "GLdouble " (parameter "nearVal"))
+ (paramdef "GLdouble " (parameter "farVal"))))
+ '(*fragment*
+ (heading
+ "multiply the current matrix by a perspective matrix")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "left")))
+ (itemx (var "right"))
+ (para "
+Specify the coordinates for the left and right vertical clipping planes. "))
+ (entry (% (heading (var "bottom")))
+ (itemx (var "top"))
+ (para "
+Specify the coordinates for the bottom and top horizontal clipping planes. "))
+ (entry (% (heading (var "nearVal")))
+ (itemx (var "farVal"))
+ (para "
+Specify the distances to the near and far depth clipping planes.
+ Both distances must be positive. ")))
+ (heading "Description")
+ (para (code "glFrustum")
+ " describes a perspective matrix that produces a perspective projection.
+ The current matrix (see "
+ (code "glMatrixMode")
+ ") is multiplied by this matrix
+ and the result replaces the current matrix, as if "
+ (code "glMultMatrix")
+ " were called with the following matrix
+ as its argument: ")
+ (para)
+ (para (math "["
+ "("
+ "2"
+ "\u2062"
+ (var "nearVal")
+ ","
+ "/"
+ (var "right")
+ "-"
+ (var "left")
+ ","
+ ","
+ " "
+ "0"
+ " "
+ (var "A")
+ " "
+ "0"
+ ")"
+ ", "
+ "("
+ "0"
+ " "
+ "2"
+ "\u2062"
+ (var "nearVal")
+ ","
+ "/"
+ (var "top")
+ "-"
+ (var "bottom")
+ ","
+ ","
+ " "
+ (var "B")
+ " "
+ "0"
+ ")"
+ ", "
+ "("
+ "0"
+ " "
+ "0"
+ " "
+ (var "C")
+ " "
+ (var "D")
+ ")"
+ ", "
+ "("
+ "0"
+ " "
+ "0"
+ " "
+ "-1"
+ " "
+ "0"
+ ")"
+ ","
+ "]"))
+ (para (math (var "A")
+ "="
+ (var "right")
+ "+"
+ (var "left")
+ ","
+ "/"
+ (var "right")
+ "-"
+ (var "left")
+ ","))
+ (para (math (var "B")
+ "="
+ (var "top")
+ "+"
+ (var "bottom")
+ ","
+ "/"
+ (var "top")
+ "-"
+ (var "bottom")
+ ","))
+ (para (math (var "C")
+ "="
+ "-"
+ (var "farVal")
+ "+"
+ (var "nearVal")
+ ","
+ "/"
+ (var "farVal")
+ "-"
+ (var "nearVal")
+ ","
+ ","))
+ (para (math (var "D")
+ "="
+ "-"
+ "2"
+ "\u2062"
+ (var "farVal")
+ "\u2062"
+ (var "nearVal")
+ ","
+ "/"
+ (var "farVal")
+ "-"
+ (var "nearVal")
+ ","
+ ","))
+ (para)
+ (para "
+Typically, the matrix mode is "
+ (code "GL_PROJECTION")
+ ", and "
+ (math "("
+ (var "left")
+ ","
+ (var "bottom")
+ "-"
+ (var "nearVal")
+ ")")
+ "
+and "
+ (math "("
+ (var "right")
+ ","
+ (var "top")
+ "-"
+ (var "nearVal")
+ ")")
+ "
+specify the points on the near clipping plane that are mapped
+ to the lower left and upper right corners of the window,
+ assuming that the eye is located at (0, 0, 0). "
+ (math "-" (var "farVal"))
+ "
+specifies the location of the far clipping plane.
+ Both "
+ (var "nearVal")
+ " and "
+ (var "farVal")
+ " must be positive. ")
+ (para "
+Use "
+ (code "glPushMatrix")
+ " and "
+ (code "glPopMatrix")
+ " to save and restore
+ the current matrix stack. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "nearVal")
+ " or "
+ (var "farVal")
+ " is not
+ positive, or if "
+ (var "left")
+ " = "
+ (var "right")
+ ", or "
+ (var "bottom")
+ " = "
+ (var "top")
+ ",
+ or "
+ (var "near")
+ " = "
+ (var "far")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glFrustum")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glGenBuffers
+ "glGenBuffers"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glGenBuffers"))
+ (paramdef "GLsizei " (parameter "n"))
+ (paramdef "GLuint * " (parameter "buffers"))))
+ '(*fragment*
+ (heading "generate buffer object names")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "n")))
+ (para "
+Specifies the number of buffer object names to be generated. "))
+ (entry (% (heading (var "buffers")))
+ (para "
+Specifies an array in which the generated buffer object names are stored. ")))
+ (heading "Description")
+ (para (code "glGenBuffers")
+ " returns "
+ (var "n")
+ " buffer object names in "
+ (var "buffers")
+ ".
+ There is no guarantee that the names form a contiguous set of integers;
+ however, it is guaranteed that none of the returned names was in use
+ immediately before the call to "
+ (code "glGenBuffers")
+ ". ")
+ (para "
+Buffer object names returned by a call to "
+ (code "glGenBuffers")
+ " are not returned by
+ subsequent calls, unless they are first deleted with "
+ (code "glDeleteBuffers")
+ ". ")
+ (para "
+No buffer objects are associated with the returned buffer object names until they are first bound by calling "
+ (code "glBindBuffer")
+ ". ")
+ (heading "Errors")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "n")
+ " is negative. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glGenBuffers")
+ " is executed
+ between the execution of "
+ (code "glBegin")
+ " and the corresponding
+ execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glGenLists
+ "glGenLists"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "GLuint " (function "glGenLists"))
+ (paramdef "GLsizei " (parameter "range"))))
+ '(*fragment*
+ (heading
+ "generate a contiguous set of empty display lists")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "range")))
+ (para "
+Specifies the number of contiguous empty display lists
+ to be generated. ")))
+ (heading "Description")
+ (para (code "glGenLists")
+ " has one argument, "
+ (var "range")
+ ".
+ It returns an integer "
+ (var "n")
+ " such that "
+ (var "range")
+ " contiguous
+ empty display lists,
+ named "
+ (math (var "n"))
+ ", "
+ (math (var "n") "+" "1")
+ ", "
+ (math (var "..."))
+ ", "
+ (math (var "n") "+" (var "range") "-" "1")
+ ",
+ are created.
+ If "
+ (var "range")
+ " is 0,
+ if there is no group of "
+ (var "range")
+ " contiguous names available,
+ or if any error is generated,
+ no display lists are generated,
+ and 0 is returned. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "range")
+ " is negative. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glGenLists")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glGenQueries
+ "glGenQueries"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glGenQueries"))
+ (paramdef "GLsizei " (parameter "n"))
+ (paramdef "GLuint * " (parameter "ids"))))
+ '(*fragment*
+ (heading "generate query object names")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "n")))
+ (para "
+Specifies the number of query object names to be generated. "))
+ (entry (% (heading (var "ids")))
+ (para "
+Specifies an array in which the generated query object names are stored. ")))
+ (heading "Description")
+ (para (code "glGenQueries")
+ " returns "
+ (var "n")
+ " query object names in "
+ (var "ids")
+ ".
+ There is no guarantee that the names form a contiguous set of integers;
+ however, it is guaranteed that none of the returned names was in use
+ immediately before the call to "
+ (code "glGenQueries")
+ ". ")
+ (para "
+Query object names returned by a call to "
+ (code "glGenQueries")
+ " are not returned by
+ subsequent calls, unless they are first deleted with "
+ (code "glDeleteQueries")
+ ". ")
+ (para "
+No query objects are associated with the returned query object names until they are first used by calling "
+ (code "glBeginQuery")
+ ". ")
+ (heading "Errors")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "n")
+ " is negative. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glGenQueries")
+ " is executed
+ between the execution of "
+ (code "glBegin")
+ " and the corresponding
+ execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glGenTextures
+ "glGenTextures"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glGenTextures"))
+ (paramdef "GLsizei " (parameter "n"))
+ (paramdef "GLuint * " (parameter "textures"))))
+ '(*fragment*
+ (heading "generate texture names")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "n")))
+ (para "
+Specifies the number of texture names to be generated. "))
+ (entry (% (heading (var "textures")))
+ (para "
+Specifies an array in which the generated texture names are stored. ")))
+ (heading "Description")
+ (para (code "glGenTextures")
+ " returns "
+ (var "n")
+ " texture names in "
+ (var "textures")
+ ".
+ There is no guarantee that the names form a contiguous set of integers;
+ however, it is guaranteed that none of the returned names was in use
+ immediately before the call to "
+ (code "glGenTextures")
+ ". ")
+ (para "
+The generated textures have no dimensionality; they assume the dimensionality
+ of the texture target to which they are first bound
+ (see "
+ (code "glBindTexture")
+ "). ")
+ (para "
+Texture names returned by a call to "
+ (code "glGenTextures")
+ " are not returned by
+ subsequent calls, unless they are first deleted with "
+ (code "glDeleteTextures")
+ ". ")
+ (heading "Errors")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "n")
+ " is negative. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glGenTextures")
+ " is executed
+ between the execution of "
+ (code "glBegin")
+ " and the corresponding
+ execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glGetActiveAttrib
+ "glGetActiveAttrib"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glGetActiveAttrib"))
+ (paramdef "GLuint " (parameter "program"))
+ (paramdef "GLuint " (parameter "index"))
+ (paramdef "GLsizei " (parameter "bufSize"))
+ (paramdef "GLsizei *" (parameter "length"))
+ (paramdef "GLint *" (parameter "size"))
+ (paramdef "GLenum *" (parameter "type"))
+ (paramdef "GLchar *" (parameter "name"))))
+ '(*fragment*
+ (heading
+ "Returns information about an active attribute variable for the specified program object")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "program")))
+ (para "Specifies the program object to be
+\t\t queried."))
+ (entry (% (heading (var "index")))
+ (para "Specifies the index of the attribute variable
+\t\t to be queried."))
+ (entry (% (heading (var "bufSize")))
+ (para "Specifies the maximum number of characters
+\t\t OpenGL is allowed to write in the character buffer
+\t\t indicated by "
+ (var "name")
+ "."))
+ (entry (% (heading (var "length")))
+ (para "Returns the number of characters actually
+\t\t written by OpenGL in the string indicated by "
+ (var "name")
+ " (excluding the null
+\t\t terminator) if a value other than "
+ (code "NULL")
+ " is passed."))
+ (entry (% (heading (var "size")))
+ (para "Returns the size of the attribute
+\t\t variable."))
+ (entry (% (heading (var "type")))
+ (para "Returns the data type of the attribute
+\t\t variable."))
+ (entry (% (heading (var "name")))
+ (para "Returns a null terminated string containing
+\t\t the name of the attribute variable.")))
+ (heading "Description")
+ (para (code "glGetActiveAttrib")
+ " returns information
+\tabout an active attribute variable in the program object
+\tspecified by "
+ (var "program")
+ ". The number of
+\tactive attributes can be obtained by calling\t"
+ (code "glGetProgram")
+ "
+with the value "
+ (code "GL_ACTIVE_ATTRIBUTES")
+ ". A
+\tvalue of 0 for "
+ (var "index")
+ " selects the first
+\tactive attribute variable. Permissible values for\t"
+ (var "index")
+ " range from 0 to the number of
+\tactive attribute variables minus 1.")
+ (para "A vertex shader may use either built-in attribute
+\tvariables, user-defined attribute variables, or both. Built-in
+\tattribute variables have a prefix of \"gl_\" and
+\treference conventional OpenGL vertex attribtes (e.g.,\t"
+ (var "gl_Vertex")
+ ",\t"
+ (var "gl_Normal")
+ ", etc., see the OpenGL Shading
+\tLanguage specification for a complete list.) User-defined
+\tattribute variables have arbitrary names and obtain their values
+\tthrough numbered generic vertex attributes. An attribute
+\tvariable (either built-in or user-defined) is considered active
+\tif it is determined during the link operation that it may be
+\taccessed during program execution. Therefore,\t"
+ (var "program")
+ " should have previously been the
+\ttarget of a call to\t"
+ (code "glLinkProgram")
+ ",
+\tbut it is not necessary for it to have been linked
+\tsuccessfully.")
+ (para "The size of the character buffer required to store the
+\tlongest attribute variable name in\t"
+ (var "program")
+ " can be obtained by calling\t"
+ (code "glGetProgram")
+ "
+with the value\t"
+ (code "GL_ACTIVE_ATTRIBUTE_MAX_LENGTH")
+ ". This value
+\tshould be used to allocate a buffer of sufficient size to store
+\tthe returned attribute name. The size of this character buffer
+\tis passed in "
+ (var "bufSize")
+ ", and a pointer to
+\tthis character buffer is passed in\t"
+ (var "name")
+ ".")
+ (para (code "glGetActiveAttrib")
+ " returns the name of
+\tthe attribute variable indicated by\t"
+ (var "index")
+ ", storing it in the character buffer
+\tspecified by "
+ (var "name")
+ ". The string returned
+\twill be null terminated. The actual number of characters written
+\tinto this buffer is returned in "
+ (var "length")
+ ",
+\tand this count does not include the null termination character.
+\tIf the length of the returned string is not required, a value of\t"
+ (code "NULL")
+ " can be passed in the\t"
+ (var "length")
+ " argument.")
+ (para "The "
+ (var "type")
+ " argument will return a
+\tpointer to the attribute variable's data type. The symbolic
+\tconstants "
+ (code "GL_FLOAT")
+ ",\t"
+ (code "GL_FLOAT_VEC2")
+ ",\t"
+ (code "GL_FLOAT_VEC3")
+ ",\t"
+ (code "GL_FLOAT_VEC4")
+ ",\t"
+ (code "GL_FLOAT_MAT2")
+ ",\t"
+ (code "GL_FLOAT_MAT3")
+ ",\t"
+ (code "GL_FLOAT_MAT4")
+ ",\t"
+ (code "GL_FLOAT_MAT2x3")
+ ",\t"
+ (code "GL_FLOAT_MAT2x4")
+ ",\t"
+ (code "GL_FLOAT_MAT3x2")
+ ",\t"
+ (code "GL_FLOAT_MAT3x4")
+ ",\t"
+ (code "GL_FLOAT_MAT4x2")
+ ", or\t"
+ (code "GL_FLOAT_MAT4x3")
+ " may be returned. The\t"
+ (var "size")
+ " argument will return the size of the
+\tattribute, in units of the type returned in\t"
+ (var "type")
+ ".")
+ (para "The list of active attribute variables may include both
+\tbuilt-in attribute variables (which begin with the prefix
+\t\"gl_\") as well as user-defined attribute variable
+\tnames.")
+ (para "This function will return as much information as it can
+\tabout the specified active attribute variable. If no information
+\tis available, "
+ (var "length")
+ " will be 0, and\t"
+ (var "name")
+ " will be an empty string. This
+\tsituation could occur if this function is called after a link
+\toperation that failed. If an error occurs, the return values\t"
+ (var "length")
+ ", "
+ (var "size")
+ ",\t"
+ (var "type")
+ ", and "
+ (var "name")
+ "
+will be unmodified.")
+ (heading "Errors")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if\t"
+ (var "program")
+ " is not a value generated by
+\tOpenGL.")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if\t"
+ (var "program")
+ " is not a program object.")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if\t"
+ (var "index")
+ " is greater than or equal to the
+\tnumber of active attribute variables in\t"
+ (var "program")
+ ".")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if\t"
+ (code "glGetActiveAttrib")
+ " is executed between the
+\texecution of\t"
+ (code "glBegin")
+ "
+and the corresponding execution of\t"
+ (code "glEnd")
+ ".")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if\t"
+ (var "bufSize")
+ " is less than 0.")))
+
+(define-gl-procedure
+ glGetActiveUniform
+ "glGetActiveUniform"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glGetActiveUniform"))
+ (paramdef "GLuint " (parameter "program"))
+ (paramdef "GLuint " (parameter "index"))
+ (paramdef "GLsizei " (parameter "bufSize"))
+ (paramdef "GLsizei *" (parameter "length"))
+ (paramdef "GLint *" (parameter "size"))
+ (paramdef "GLenum *" (parameter "type"))
+ (paramdef "GLchar *" (parameter "name"))))
+ '(*fragment*
+ (heading
+ "Returns information about an active uniform variable for the specified program object")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "program")))
+ (para "Specifies the program object to be
+\t\t queried."))
+ (entry (% (heading (var "index")))
+ (para "Specifies the index of the uniform variable to
+\t\t be queried."))
+ (entry (% (heading (var "bufSize")))
+ (para "Specifies the maximum number of characters
+\t\t OpenGL is allowed to write in the character buffer
+\t\t indicated by "
+ (var "name")
+ "."))
+ (entry (% (heading (var "length")))
+ (para "Returns the number of characters actually
+\t\t written by OpenGL in the string indicated by "
+ (var "name")
+ " (excluding the null
+\t\t terminator) if a value other than "
+ (code "NULL")
+ " is passed."))
+ (entry (% (heading (var "size")))
+ (para "Returns the size of the uniform
+\t\t variable."))
+ (entry (% (heading (var "type")))
+ (para "Returns the data type of the uniform
+\t\t variable."))
+ (entry (% (heading (var "name")))
+ (para "Returns a null terminated string containing
+\t\t the name of the uniform variable.")))
+ (heading "Description")
+ (para (code "glGetActiveUniform")
+ " returns
+\tinformation about an active uniform variable in the program
+\tobject specified by "
+ (var "program")
+ ". The number
+\tof active uniform variables can be obtained by calling\t"
+ (code "glGetProgram")
+ "
+with the value "
+ (code "GL_ACTIVE_UNIFORMS")
+ ". A value
+\tof 0 for "
+ (var "index")
+ " selects the first active
+\tuniform variable. Permissible values for\t"
+ (var "index")
+ " range from 0 to the number of
+\tactive uniform variables minus 1.")
+ (para "Shaders may use either built-in uniform variables,
+\tuser-defined uniform variables, or both. Built-in uniform
+\tvariables have a prefix of \"gl_\" and reference
+\texisting OpenGL state or values derived from such state (e.g.,\t"
+ (var "gl_Fog")
+ ",\t"
+ (var "gl_ModelViewMatrix")
+ ", etc., see the OpenGL
+\tShading Language specification for a complete list.)
+\tUser-defined uniform variables have arbitrary names and obtain
+\ttheir values from the application through calls to\t"
+ (code "glUniform")
+ ".
+\tA uniform variable (either built-in or user-defined) is
+\tconsidered active if it is determined during the link operation
+\tthat it may be accessed during program execution. Therefore,\t"
+ (var "program")
+ " should have previously been the
+\ttarget of a call to\t"
+ (code "glLinkProgram")
+ ",
+\tbut it is not necessary for it to have been linked
+\tsuccessfully.")
+ (para "The size of the character buffer required to store the
+\tlongest uniform variable name in "
+ (var "program")
+ "
+can be obtained by calling\t"
+ (code "glGetProgram")
+ "
+with the value\t"
+ (code "GL_ACTIVE_UNIFORM_MAX_LENGTH")
+ ". This value
+\tshould be used to allocate a buffer of sufficient size to store
+\tthe returned uniform variable name. The size of this character
+\tbuffer is passed in "
+ (var "bufSize")
+ ", and a
+\tpointer to this character buffer is passed in\t"
+ (var "name."))
+ (para (code "glGetActiveUniform")
+ " returns the name
+\tof the uniform variable indicated by\t"
+ (var "index")
+ ", storing it in the character buffer
+\tspecified by "
+ (var "name")
+ ". The string returned
+\twill be null terminated. The actual number of characters written
+\tinto this buffer is returned in "
+ (var "length")
+ ",
+\tand this count does not include the null termination character.
+\tIf the length of the returned string is not required, a value of\t"
+ (code "NULL")
+ " can be passed in the\t"
+ (var "length")
+ " argument.")
+ (para "The "
+ (var "type")
+ "
+argument will return a pointer to the uniform variable's data
+\ttype. The symbolic constants\t"
+ (code "GL_FLOAT")
+ ",\t"
+ (code "GL_FLOAT_VEC2")
+ ",\t"
+ (code "GL_FLOAT_VEC3")
+ ",\t"
+ (code "GL_FLOAT_VEC4")
+ ",\t"
+ (code "GL_INT")
+ ",\t"
+ (code "GL_INT_VEC2")
+ ",\t"
+ (code "GL_INT_VEC3")
+ ",\t"
+ (code "GL_INT_VEC4")
+ ",\t"
+ (code "GL_BOOL")
+ ",\t"
+ (code "GL_BOOL_VEC2")
+ ",\t"
+ (code "GL_BOOL_VEC3")
+ ",\t"
+ (code "GL_BOOL_VEC4")
+ ",\t"
+ (code "GL_FLOAT_MAT2")
+ ",\t"
+ (code "GL_FLOAT_MAT3")
+ ",\t"
+ (code "GL_FLOAT_MAT4")
+ ",\t"
+ (code "GL_FLOAT_MAT2x3")
+ ",\t"
+ (code "GL_FLOAT_MAT2x4")
+ ",\t"
+ (code "GL_FLOAT_MAT3x2")
+ ",\t"
+ (code "GL_FLOAT_MAT3x4")
+ ",\t"
+ (code "GL_FLOAT_MAT4x2")
+ ",\t"
+ (code "GL_FLOAT_MAT4x3")
+ ",\t"
+ (code "GL_SAMPLER_1D")
+ ",\t"
+ (code "GL_SAMPLER_2D")
+ ",\t"
+ (code "GL_SAMPLER_3D")
+ ",\t"
+ (code "GL_SAMPLER_CUBE")
+ ",\t"
+ (code "GL_SAMPLER_1D_SHADOW")
+ ", or\t"
+ (code "GL_SAMPLER_2D_SHADOW")
+ "
+may be returned.")
+ (para "If one or more elements of an array are active, the name
+\tof the array is returned in "
+ (var "name")
+ ", the
+\ttype is returned in "
+ (var "type")
+ ", and the\t"
+ (var "size")
+ " parameter returns the highest array
+\telement index used, plus one, as determined by the compiler
+\tand/or linker. Only one active uniform variable will be reported
+\tfor a uniform array.")
+ (para "Uniform variables that are declared as structures or
+\tarrays of structures will not be returned directly by this
+\tfunction. Instead, each of these uniform variables will be
+\treduced to its fundamental components containing the
+\t\".\" and \"[]\" operators such that each of the
+\tnames is valid as an argument to\t"
+ (code "glGetUniformLocation")
+ ".
+\tEach of these reduced uniform variables is counted as one active
+\tuniform variable and is assigned an index. A valid name cannot
+\tbe a structure, an array of structures, or a subcomponent of a
+\tvector or matrix.")
+ (para "The size of the uniform variable will be returned in\t"
+ (var "size")
+ ". Uniform variables other than arrays
+\twill have a size of 1. Structures and arrays of structures will
+\tbe reduced as described earlier, such that each of the names
+\treturned will be a data type in the earlier list. If this
+\treduction results in an array, the size returned will be as
+\tdescribed for uniform arrays; otherwise, the size returned will
+\tbe 1.")
+ (para "The list of active uniform variables may include both
+\tbuilt-in uniform variables (which begin with the prefix
+\t\"gl_\") as well as user-defined uniform variable
+\tnames.")
+ (para "This function will return as much information as it can
+\tabout the specified active uniform variable. If no information
+\tis available, "
+ (var "length")
+ " will be 0, and\t"
+ (var "name")
+ " will be an empty string. This
+\tsituation could occur if this function is called after a link
+\toperation that failed. If an error occurs, the return values\t"
+ (var "length")
+ ", "
+ (var "size")
+ ",\t"
+ (var "type")
+ ", and "
+ (var "name")
+ "
+will be unmodified.")
+ (heading "Errors")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if\t"
+ (var "program")
+ " is not a value generated by
+\tOpenGL.")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if\t"
+ (var "program")
+ " is not a program object.")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if\t"
+ (var "index")
+ " is greater than or equal to the
+\tnumber of active uniform variables in\t"
+ (var "program")
+ ".")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if\t"
+ (code "glGetActiveUniform")
+ " is executed between the
+\texecution of\t"
+ (code "glBegin")
+ "
+and the corresponding execution of\t"
+ (code "glEnd")
+ ".")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if\t"
+ (var "bufSize")
+ " is less than 0.")))
+
+(define-gl-procedure
+ glGetAttachedShaders
+ "glGetAttachedShaders"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "void "
+ (function "glGetAttachedShaders"))
+ (paramdef "GLuint " (parameter "program"))
+ (paramdef "GLsizei " (parameter "maxCount"))
+ (paramdef "GLsizei *" (parameter "count"))
+ (paramdef "GLuint *" (parameter "shaders"))))
+ '(*fragment*
+ (heading
+ "Returns the handles of the shader objects attached to a program object")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "program")))
+ (para "Specifies the program object to be
+\t\t queried."))
+ (entry (% (heading (var "maxCount")))
+ (para "Specifies the size of the array for storing
+\t\t the returned object names."))
+ (entry (% (heading (var "count")))
+ (para "Returns the number of names actually returned
+\t\t in "
+ (var "objects")
+ "."))
+ (entry (% (heading (var "shaders")))
+ (para "Specifies an array that is used to return the
+\t\t names of attached shader objects.")))
+ (heading "Description")
+ (para (code "glGetAttachedShaders")
+ " returns the
+\tnames of the shader objects attached to\t"
+ (var "program")
+ ". The names of shader objects that
+\tare attached to "
+ (var "program")
+ " will be returned
+\tin "
+ (var "shaders.")
+ " The actual number of shader
+\tnames written into "
+ (var "shaders")
+ " is returned in\t"
+ (var "count.")
+ " If no shader objects are attached
+\tto "
+ (var "program")
+ ", "
+ (var "count")
+ "
+is set to 0. The maximum number of shader names that may be
+\treturned in "
+ (var "shaders")
+ " is specified by\t"
+ (var "maxCount")
+ ". ")
+ (para "If the number of names actually returned is not required
+\t(for instance, if it has just been obtained by calling\t"
+ (code "glGetProgram")
+ "),
+\ta value of "
+ (code "NULL")
+ " may be passed for count. If
+\tno shader objects are attached to\t"
+ (var "program")
+ ", a value of 0 will be returned in\t"
+ (var "count")
+ ". The actual number of attached
+\tshaders can be obtained by calling\t"
+ (code "glGetProgram")
+ "
+with the value "
+ (code "GL_ATTACHED_SHADERS")
+ ".")
+ (heading "Errors")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if\t"
+ (var "program")
+ " is not a value generated by
+\tOpenGL.")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if\t"
+ (var "program")
+ " is not a program object.")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if\t"
+ (var "maxCount")
+ " is less than 0.")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if\t"
+ (code "glGetAttachedShaders")
+ "
+is executed between the execution of\t"
+ (code "glBegin")
+ "
+and the corresponding execution of\t"
+ (code "glEnd")
+ ".")))
+
+(define-gl-procedure
+ glGetAttribLocation
+ "glGetAttribLocation"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "GLint "
+ (function "glGetAttribLocation"))
+ (paramdef "GLuint " (parameter "program"))
+ (paramdef "const GLchar *" (parameter "name"))))
+ '(*fragment*
+ (heading
+ "Returns the location of an attribute variable")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "program")))
+ (para "Specifies the program object to be
+\t\t queried."))
+ (entry (% (heading (var "name")))
+ (para "Points to a null terminated string containing
+\t\t the name of the attribute variable whose location is
+\t\t to be queried.")))
+ (heading "Description")
+ (para (code "glGetAttribLocation")
+ " queries the
+\tpreviously linked program object specified by\t"
+ (var "program")
+ " for the attribute variable
+\tspecified by "
+ (var "name")
+ " and returns the index
+\tof the generic vertex attribute that is bound to that attribute
+\tvariable. If "
+ (var "name")
+ " is a matrix attribute
+\tvariable, the index of the first column of the matrix is
+\treturned. If the named attribute variable is not an active
+\tattribute in the specified program object or if\t"
+ (var "name")
+ " starts with the reserved prefix
+\t\"gl_\", a value of -1 is returned.")
+ (para "The association between an attribute variable name and a
+\tgeneric attribute index can be specified at any time by calling\t"
+ (code "glBindAttribLocation")
+ ".
+\tAttribute bindings do not go into effect until\t"
+ (code "glLinkProgram")
+ "
+is called. After a program object has been linked successfully,
+\tthe index values for attribute variables remain fixed until the
+\tnext link command occurs. The attribute values can only be
+\tqueried after a link if the link was successful.\t"
+ (code "glGetAttribLocation")
+ " returns the binding
+\tthat actually went into effect the last time\t"
+ (code "glLinkProgram")
+ "
+was called for the specified program object. Attribute bindings
+\tthat have been specified since the last link operation are not
+\treturned by "
+ (code "glGetAttribLocation")
+ ".")
+ (heading "Errors")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if\t"
+ (var "program")
+ " is not a value generated by
+\tOpenGL.")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if\t"
+ (var "program")
+ " is not a program object.")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if\t"
+ (var "program")
+ " has not been successfully
+\tlinked.")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if\t"
+ (code "glGetAttribLocation")
+ " is executed between the
+\texecution of\t"
+ (code "glBegin")
+ "
+and the corresponding execution of\t"
+ (code "glEnd")
+ ".")))
+
+(define-gl-procedure
+ glGetBufferParameteriv
+ "glGetBufferParameteriv"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "void "
+ (function "glGetBufferParameteriv"))
+ (paramdef "GLenum " (parameter "target"))
+ (paramdef "GLenum " (parameter "value"))
+ (paramdef "GLint * " (parameter "data"))))
+ '(*fragment*
+ (heading "return parameters of a buffer object")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "target")))
+ (para "
+Specifies the target buffer object.
+ The symbolic constant must be "
+ (code "GL_ARRAY_BUFFER")
+ ", "
+ (code "GL_ELEMENT_ARRAY_BUFFER")
+ ", "
+ (code "GL_PIXEL_PACK_BUFFER")
+ ", or "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ ". "))
+ (entry (% (heading (var "value")))
+ (para "
+Specifies the symbolic name of a buffer object parameter.
+ Accepted values are "
+ (code "GL_BUFFER_ACCESS")
+ ", "
+ (code "GL_BUFFER_MAPPED")
+ ", "
+ (code "GL_BUFFER_SIZE")
+ ", or "
+ (code "GL_BUFFER_USAGE")
+ ". "))
+ (entry (% (heading (var "data")))
+ (para "
+Returns the requested parameter. ")))
+ (heading "Description")
+ (para (code "glGetBufferParameteriv")
+ " returns in "
+ (var "data")
+ " a selected parameter of the buffer object
+ specified by "
+ (var "target")
+ ". ")
+ (para (var "value")
+ " names a specific buffer object parameter, as follows: ")
+ (table (% (formatter (asis)))
+ (entry (% (heading (code "GL_BUFFER_ACCESS")))
+ (para (var "params")
+ " returns the access policy set while mapping the buffer object.
+ The initial value is "
+ (code "GL_READ_WRITE")
+ ". "))
+ (entry (% (heading (code "GL_BUFFER_MAPPED")))
+ (para (var "params")
+ " returns a flag indicating whether the buffer object is currently
+ mapped. The initial value is "
+ (code "GL_FALSE")
+ ". "))
+ (entry (% (heading (code "GL_BUFFER_SIZE")))
+ (para (var "params")
+ " returns the size of the buffer object, measured in bytes.
+ The initial value is 0. "))
+ (entry (% (heading (code "GL_BUFFER_USAGE")))
+ (para (var "params")
+ " returns the buffer object's usage pattern. The initial value is "
+ (code "GL_STATIC_DRAW")
+ ". ")))
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "target")
+ " or "
+ (var "value")
+ " is not an
+ accepted value. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if the reserved buffer object name 0 is bound to "
+ (var "target")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glGetBufferParameteriv")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glGetBufferPointerv
+ "glGetBufferPointerv"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "void "
+ (function "glGetBufferPointerv"))
+ (paramdef "GLenum " (parameter "target"))
+ (paramdef "GLenum " (parameter "pname"))
+ (paramdef "GLvoid ** " (parameter "params"))))
+ '(*fragment*
+ (heading
+ "return the pointer to a mapped buffer object's data store")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "target")))
+ (para "
+Specifies the target buffer object.
+ The symbolic constant must be "
+ (code "GL_ARRAY_BUFFER")
+ ", "
+ (code "GL_ELEMENT_ARRAY_BUFFER")
+ ", "
+ (code "GL_PIXEL_PACK_BUFFER")
+ ", or "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ ". "))
+ (entry (% (heading (var "pname")))
+ (para "
+Specifies the pointer to be returned. The symbolic constant must be "
+ (code "GL_BUFFER_MAP_POINTER")
+ ". "))
+ (entry (% (heading (var "params")))
+ (para "
+Returns the pointer value specified by "
+ (var "pname")
+ ". ")))
+ (heading "Description")
+ (para (code "glGetBufferPointerv")
+ " returns pointer information. "
+ (var "pname")
+ " is a symbolic constant
+ indicating the pointer to be returned, which must be "
+ (code "GL_BUFFER_MAP_POINTER")
+ ", the pointer
+ to which the buffer object's data store is mapped. If the data store is not currently mapped, "
+ (code "NULL")
+ " is returned. "
+ (var "params")
+ " is a pointer to a location in which to place the returned pointer value. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "target")
+ " or "
+ (var "pname")
+ " is not an
+ accepted value. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if the reserved buffer object name 0 is bound to "
+ (var "target")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glGetBufferPointerv")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glGetBufferSubData
+ "glGetBufferSubData"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glGetBufferSubData"))
+ (paramdef "GLenum " (parameter "target"))
+ (paramdef "GLintptr " (parameter "offset"))
+ (paramdef "GLsizeiptr " (parameter "size"))
+ (paramdef "GLvoid * " (parameter "data"))))
+ '(*fragment*
+ (heading
+ "returns a subset of a buffer object's data store")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "target")))
+ (para "
+Specifies the target buffer object.
+ The symbolic constant must be "
+ (code "GL_ARRAY_BUFFER")
+ ", "
+ (code "GL_ELEMENT_ARRAY_BUFFER")
+ ", "
+ (code "GL_PIXEL_PACK_BUFFER")
+ ", or "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ ". "))
+ (entry (% (heading (var "offset")))
+ (para "
+Specifies the offset into the buffer object's data store from which data will be returned,
+ measured in bytes. "))
+ (entry (% (heading (var "size")))
+ (para "
+Specifies the size in bytes of the data store region being returned. "))
+ (entry (% (heading (var "data")))
+ (para "
+Specifies a pointer to the location where buffer object data is returned. ")))
+ (heading "Description")
+ (para (code "glGetBufferSubData")
+ " returns some or all of the data from the buffer object currently
+ bound to "
+ (var "target")
+ ". Data starting at byte offset "
+ (var "offset")
+ " and
+ extending for "
+ (var "size")
+ " bytes is copied from the data store to the memory pointed to by "
+ (var "data")
+ ". An error is thrown if the buffer object is currently mapped, or if "
+ (var "offset")
+ " and "
+ (var "size")
+ " together define a range beyond the bounds
+ of the buffer object's data store. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "target")
+ " is not "
+ (code "GL_ARRAY_BUFFER")
+ ", "
+ (code "GL_ELEMENT_ARRAY_BUFFER")
+ ", "
+ (code "GL_PIXEL_PACK_BUFFER")
+ ", or "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ ". ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "offset")
+ " or "
+ (var "size")
+ " is negative, or if together they define a region of memory
+ that extends beyond the buffer object's allocated data store. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if the reserved buffer object name 0 is bound to "
+ (var "target")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if the buffer object being queried is mapped. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glGetBufferSubData")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ " and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glGetClipPlane
+ "glGetClipPlane"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glGetClipPlane"))
+ (paramdef "GLenum " (parameter "plane"))
+ (paramdef "GLdouble * " (parameter "equation"))))
+ '(*fragment*
+ (heading
+ "return the coefficients of the specified clipping plane")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "plane")))
+ (para "
+Specifies a clipping plane.
+ The number of clipping planes depends on the implementation,
+ but at least six clipping planes are supported.
+ They are identified by symbolic names of the form "
+ (code "GL_CLIP_PLANE")
+ (math (var "i"))
+ "
+where i ranges from 0 to the value of "
+ (code "GL_MAX_CLIP_PLANES")
+ " - 1. "))
+ (entry (% (heading (var "equation")))
+ (para "
+Returns four double-precision values that are the coefficients of the plane equation of "
+ (var "plane")
+ " in eye coordinates.
+ The initial value is (0, 0, 0, 0). ")))
+ (heading "Description")
+ (para (code "glGetClipPlane")
+ " returns in "
+ (var "equation")
+ " the four coefficients of the plane equation
+ for "
+ (var "plane")
+ ". ")
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "plane")
+ " is not an accepted value. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glGetClipPlane")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glGetColorTableParameter
+ "glGetColorTableParameter"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "void "
+ (function "glGetColorTableParameterfv"))
+ (paramdef "GLenum " (parameter "target"))
+ (paramdef "GLenum " (parameter "pname"))
+ (paramdef "GLfloat * " (parameter "params"))))
+ '(*fragment*
+ (heading "get color lookup table parameters")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "target")))
+ (para "
+The target color table.
+ Must be "
+ (code "GL_COLOR_TABLE")
+ ", "
+ (code "GL_POST_CONVOLUTION_COLOR_TABLE")
+ ", "
+ (code "GL_POST_COLOR_MATRIX_COLOR_TABLE")
+ ", "
+ (code "GL_PROXY_COLOR_TABLE")
+ ", "
+ (code "GL_PROXY_POST_CONVOLUTION_COLOR_TABLE")
+ ", or "
+ (code "GL_PROXY_POST_COLOR_MATRIX_COLOR_TABLE")
+ ". "))
+ (entry (% (heading (var "pname")))
+ (para "
+The symbolic name of a color lookup table parameter.
+ Must be one of "
+ (code "GL_COLOR_TABLE_BIAS")
+ ", "
+ (code "GL_COLOR_TABLE_SCALE")
+ ", "
+ (code "GL_COLOR_TABLE_FORMAT")
+ ", "
+ (code "GL_COLOR_TABLE_WIDTH")
+ ", "
+ (code "GL_COLOR_TABLE_RED_SIZE")
+ ", "
+ (code "GL_COLOR_TABLE_GREEN_SIZE")
+ ", "
+ (code "GL_COLOR_TABLE_BLUE_SIZE")
+ ", "
+ (code "GL_COLOR_TABLE_ALPHA_SIZE")
+ ", "
+ (code "GL_COLOR_TABLE_LUMINANCE_SIZE")
+ ", or "
+ (code "GL_COLOR_TABLE_INTENSITY_SIZE")
+ ". "))
+ (entry (% (heading (var "params")))
+ (para "
+A pointer to an array where the values of the parameter will be stored. ")))
+ (heading "Description")
+ (para "
+Returns parameters specific to color table "
+ (var "target")
+ ". ")
+ (para "
+When "
+ (var "pname")
+ " is set to "
+ (code "GL_COLOR_TABLE_SCALE")
+ " or "
+ (code "GL_COLOR_TABLE_BIAS")
+ ", "
+ (code "glGetColorTableParameter")
+ " returns the color
+ table scale or bias parameters for the table specified by "
+ (var "target")
+ ".
+ For these queries, "
+ (var "target")
+ " must be set to "
+ (code "GL_COLOR_TABLE")
+ ", "
+ (code "GL_POST_CONVOLUTION_COLOR_TABLE")
+ ",
+ or "
+ (code "GL_POST_COLOR_MATRIX_COLOR_TABLE")
+ " and "
+ (var "params")
+ " points to an array of four elements, which receive
+ the scale or bias factors for red, green, blue, and alpha, in that order. ")
+ (para (code "glGetColorTableParameter")
+ " can also be used to retrieve the format and size parameters
+ for a color table. For these queries, set "
+ (var "target")
+ " to either the
+ color table target or the proxy color table target.
+ The format and size parameters are set by "
+ (code "glColorTable")
+ ". ")
+ (para "
+The following table lists the format and size parameters that may
+ be queried.
+ For each symbolic constant listed below for "
+ (var "pname")
+ ", "
+ (var "params")
+ " must point to an array of the
+ given length and receive the values indicated. ")
+ (para)
+ (table (% (formatter (asis)))
+ (entry (% (heading (strong "Parameter")))
+ (para (strong "N") ", " (strong "Meaning")))
+ (entry (% (heading (code "GL_COLOR_TABLE_FORMAT")))
+ (para "
+1 "
+ ", "
+ "
+Internal format (e.g., "
+ (code "GL_RGBA")
+ ") "))
+ (entry (% (heading (code "GL_COLOR_TABLE_WIDTH")))
+ (para "
+1 " ", " "
+Number of elements in table "))
+ (entry (% (heading (code "GL_COLOR_TABLE_RED_SIZE")))
+ (para "
+1 "
+ ", "
+ "
+Size of red component, in bits "))
+ (entry (% (heading (code "GL_COLOR_TABLE_GREEN_SIZE")))
+ (para "
+1 " ", " "
+Size of green component "))
+ (entry (% (heading (code "GL_COLOR_TABLE_BLUE_SIZE")))
+ (para "
+1 " ", " "
+Size of blue component "))
+ (entry (% (heading (code "GL_COLOR_TABLE_ALPHA_SIZE")))
+ (para "
+1 " ", " "
+Size of alpha component "))
+ (entry (% (heading (code "GL_COLOR_TABLE_LUMINANCE_SIZE")))
+ (para "
+1 " ", " "
+Size of luminance component "))
+ (entry (% (heading (code "GL_COLOR_TABLE_INTENSITY_SIZE")))
+ (para "
+1 " ", " "
+Size of intensity component ")))
+ (para)
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "target")
+ " or "
+ (var "pname")
+ " is not
+ an acceptable value. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glGetColorTableParameter")
+ " is executed
+ between the execution of "
+ (code "glBegin")
+ " and the corresponding
+ execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glGetColorTable
+ "glGetColorTable"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glGetColorTable"))
+ (paramdef "GLenum " (parameter "target"))
+ (paramdef "GLenum " (parameter "format"))
+ (paramdef "GLenum " (parameter "type"))
+ (paramdef "GLvoid * " (parameter "table"))))
+ '(*fragment*
+ (heading
+ "retrieve contents of a color lookup table")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "target")))
+ (para "
+Must be "
+ (code "GL_COLOR_TABLE")
+ ", "
+ (code "GL_POST_CONVOLUTION_COLOR_TABLE")
+ ",
+ or "
+ (code "GL_POST_COLOR_MATRIX_COLOR_TABLE")
+ ". "))
+ (entry (% (heading (var "format")))
+ (para "
+The format of the pixel data in "
+ (var "table")
+ ".
+ The possible values are "
+ (code "GL_RED")
+ ", "
+ (code "GL_GREEN")
+ ", "
+ (code "GL_BLUE")
+ ", "
+ (code "GL_ALPHA")
+ ", "
+ (code "GL_LUMINANCE")
+ ", "
+ (code "GL_LUMINANCE_ALPHA")
+ ", "
+ (code "GL_RGB")
+ ", "
+ (code "GL_BGR")
+ ", "
+ (code "GL_RGBA")
+ ", and "
+ (code "GL_BGRA")
+ ". "))
+ (entry (% (heading (var "type")))
+ (para "
+The type of the pixel data in "
+ (var "table")
+ ".
+ Symbolic constants "
+ (code "GL_UNSIGNED_BYTE")
+ ", "
+ (code "GL_BYTE")
+ ", "
+ (code "GL_BITMAP")
+ ", "
+ (code "GL_UNSIGNED_SHORT")
+ ", "
+ (code "GL_SHORT")
+ ", "
+ (code "GL_UNSIGNED_INT")
+ ", "
+ (code "GL_INT")
+ ", "
+ (code "GL_FLOAT")
+ ", "
+ (code "GL_UNSIGNED_BYTE_3_3_2")
+ ", "
+ (code "GL_UNSIGNED_BYTE_2_3_3_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_6_5")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_6_5_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_4_4_4_4")
+ ", "
+ (code "GL_UNSIGNED_SHORT_4_4_4_4_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_5_5_1")
+ ", "
+ (code "GL_UNSIGNED_SHORT_1_5_5_5_REV")
+ ", "
+ (code "GL_UNSIGNED_INT_8_8_8_8")
+ ", "
+ (code "GL_UNSIGNED_INT_8_8_8_8_REV")
+ ", "
+ (code "GL_UNSIGNED_INT_10_10_10_2")
+ ", and "
+ (code "GL_UNSIGNED_INT_2_10_10_10_REV")
+ "
+are accepted. "))
+ (entry (% (heading (var "table")))
+ (para "
+Pointer to a one-dimensional array of pixel data containing the contents
+ of the color table. ")))
+ (heading "Description")
+ (para (code "glGetColorTable")
+ " returns in "
+ (var "table")
+ " the contents of the color table specified
+ by "
+ (var "target")
+ ". No pixel transfer operations are performed, but pixel
+ storage modes that are applicable to "
+ (code "glReadPixels")
+ " are performed. ")
+ (para "
+If a non-zero named buffer object is bound to the "
+ (code "GL_PIXEL_PACK_BUFFER")
+ " target
+ (see "
+ (code "glBindBuffer")
+ ") while a histogram table is
+ requested, "
+ (var "table")
+ " is treated as a byte offset into the buffer object's data store. ")
+ (para "
+Color components that are requested in
+ the specified "
+ (var "format")
+ ", but which are not included in the internal
+ format of the color lookup table, are returned as zero. The
+ assignments of internal color components to the components
+ requested by "
+ (var "format")
+ " are ")
+ (table (% (formatter (asis)))
+ (entry (% (heading (strong "Internal Component")))
+ (para (strong "Resulting Component")))
+ (entry (% (heading "
+Red ")) (para "
+Red "))
+ (entry (% (heading "
+Green ")) (para "
+Green "))
+ (entry (% (heading "
+Blue ")) (para "
+Blue "))
+ (entry (% (heading "
+Alpha ")) (para "
+Alpha "))
+ (entry (% (heading "
+Luminance "))
+ (para "
+Red "))
+ (entry (% (heading "
+Intensity "))
+ (para "
+Red ")))
+ (para)
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "target")
+ " is not one of the allowable
+ values. ")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "format")
+ " is not one of the allowable
+ values. ")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "type")
+ " is not one of the allowable
+ values. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (var "type")
+ " is one of "
+ (code "GL_UNSIGNED_BYTE_3_3_2")
+ ", "
+ (code "GL_UNSIGNED_BYTE_2_3_3_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_6_5")
+ ", or "
+ (code "GL_UNSIGNED_SHORT_5_6_5_REV")
+ "
+and "
+ (var "format")
+ " is not "
+ (code "GL_RGB")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (var "type")
+ " is one of "
+ (code "GL_UNSIGNED_SHORT_4_4_4_4")
+ ", "
+ (code "GL_UNSIGNED_SHORT_4_4_4_4_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_5_5_1")
+ ", "
+ (code "GL_UNSIGNED_SHORT_1_5_5_5_REV")
+ ", "
+ (code "GL_UNSIGNED_INT_8_8_8_8")
+ ", "
+ (code "GL_UNSIGNED_INT_8_8_8_8_REV")
+ ", "
+ (code "GL_UNSIGNED_INT_10_10_10_2")
+ ", or "
+ (code "GL_UNSIGNED_INT_2_10_10_10_REV")
+ "
+and "
+ (var "format")
+ " is neither "
+ (code "GL_RGBA")
+ " nor "
+ (code "GL_BGRA")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a non-zero buffer object name is bound to the "
+ (code "GL_PIXEL_PACK_BUFFER")
+ " target and the buffer object's data store is currently mapped. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a non-zero buffer object name is bound to the "
+ (code "GL_PIXEL_PACK_BUFFER")
+ " target and the data would be packed to the buffer
+ object such that the memory writes required would exceed the data store size. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a non-zero buffer object name is bound to the "
+ (code "GL_PIXEL_PACK_BUFFER")
+ " target and "
+ (var "table")
+ " is not evenly divisible
+ into the number of bytes needed to store in memory a datum indicated by "
+ (var "type")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glGetColorTable")
+ " is executed
+ between the execution of "
+ (code "glBegin")
+ " and the corresponding
+ execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glGetCompressedTexImage
+ "glGetCompressedTexImage"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "void "
+ (function "glGetCompressedTexImage"))
+ (paramdef "GLenum " (parameter "target"))
+ (paramdef "GLint " (parameter "lod"))
+ (paramdef "GLvoid * " (parameter "img"))))
+ '(*fragment*
+ (heading "return a compressed texture image")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "target")))
+ (para "
+Specifies which texture is to be obtained. "
+ (code "GL_TEXTURE_1D")
+ ", "
+ (code "GL_TEXTURE_2D")
+ ", and "
+ (code "GL_TEXTURE_3D")
+ (code "GL_TEXTURE_CUBE_MAP_POSITIVE_X")
+ ", "
+ (code "GL_TEXTURE_CUBE_MAP_NEGATIVE_X")
+ ", "
+ (code "GL_TEXTURE_CUBE_MAP_POSITIVE_Y")
+ ", "
+ (code "GL_TEXTURE_CUBE_MAP_NEGATIVE_Y")
+ ", "
+ (code "GL_TEXTURE_CUBE_MAP_POSITIVE_Z")
+ ", and "
+ (code "GL_TEXTURE_CUBE_MAP_NEGATIVE_Z")
+ "
+are accepted. "))
+ (entry (% (heading (var "lod")))
+ (para "
+Specifies the level-of-detail number of the desired image.
+ Level 0 is the base image level.
+ Level "
+ (math (var "n"))
+ "
+is the "
+ (math (var "n"))
+ "th
+ mipmap reduction image. "))
+ (entry (% (heading (var "img")))
+ (para "
+Returns the compressed texture image. ")))
+ (heading "Description")
+ (para (code "glGetCompressedTexImage")
+ " returns the compressed texture image associated with "
+ (var "target")
+ " and "
+ (var "lod")
+ "
+into "
+ (var "img")
+ ". "
+ (var "img")
+ " should be an array of "
+ (code "GL_TEXTURE_COMPRESSED_IMAGE_SIZE")
+ " bytes. "
+ (var "target")
+ " specifies whether the desired texture image was one specified by "
+ (code "glTexImage1D")
+ " ("
+ (code "GL_TEXTURE_1D")
+ "), "
+ (code "glTexImage2D")
+ " ("
+ (code "GL_TEXTURE_2D")
+ " or any of "
+ (code "GL_TEXTURE_CUBE_MAP_*")
+ "), or "
+ (code "glTexImage3D")
+ " ("
+ (code "GL_TEXTURE_3D")
+ "). "
+ (var "lod")
+ " specifies the level-of-detail number of the desired image. ")
+ (para "
+If a non-zero named buffer object is bound to the "
+ (code "GL_PIXEL_PACK_BUFFER")
+ " target
+ (see "
+ (code "glBindBuffer")
+ ") while a texture image is
+ requested, "
+ (var "img")
+ " is treated as a byte offset into the buffer object's data store. ")
+ (para "
+To minimize errors, first verify that the texture is compressed by calling "
+ (code "glGetTexLevelParameter")
+ " with argument "
+ (code "GL_TEXTURE_COMPRESSED")
+ ". If
+ the texture is compressed, then determine the amount of memory required to
+ store the compressed texture by calling "
+ (code "glGetTexLevelParameter")
+ " with
+ argument "
+ (code "GL_TEXTURE_COMPRESSED_IMAGE_SIZE")
+ ". Finally, retrieve the
+ internal format of the texture by calling "
+ (code "glGetTexLevelParameter")
+ " with
+ argument "
+ (code "GL_TEXTURE_INTERNAL_FORMAT")
+ ".
+ To store the texture for later use, associate the internal format and size
+ with the retrieved texture image. These data can be used by the respective
+ texture or subtexture loading routine used for loading "
+ (var "target")
+ " textures. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "lod")
+ " is less than zero or greater
+ than the maximum number of LODs permitted by the implementation. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glGetCompressedTexImage")
+ " is used to retrieve a
+ texture that is in an uncompressed internal format. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a non-zero buffer object name is bound to the "
+ (code "GL_PIXEL_PACK_BUFFER")
+ " target and the buffer object's data store is currently mapped. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a non-zero buffer object name is bound to the "
+ (code "GL_PIXEL_PACK_BUFFER")
+ " target and the data would be packed to the buffer
+ object such that the memory writes required would exceed the data store size. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glGetCompressedTexImage")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glGetConvolutionFilter
+ "glGetConvolutionFilter"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "void "
+ (function "glGetConvolutionFilter"))
+ (paramdef "GLenum " (parameter "target"))
+ (paramdef "GLenum " (parameter "format"))
+ (paramdef "GLenum " (parameter "type"))
+ (paramdef "GLvoid * " (parameter "image"))))
+ '(*fragment*
+ (heading
+ "get current 1D or 2D convolution filter kernel")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "target")))
+ (para "
+The filter to be retrieved.
+ Must be one of "
+ (code "GL_CONVOLUTION_1D")
+ " or "
+ (code "GL_CONVOLUTION_2D")
+ ". "))
+ (entry (% (heading (var "format")))
+ (para "
+Format of the output image.
+ Must be one of "
+ (code "GL_RED")
+ ", "
+ (code "GL_GREEN")
+ ", "
+ (code "GL_BLUE")
+ ", "
+ (code "GL_ALPHA")
+ ", "
+ (code "GL_RGB")
+ ", "
+ (code "GL_BGR")
+ ", "
+ (code "GL_RGBA")
+ ", "
+ (code "GL_BGRA")
+ ", "
+ (code "GL_LUMINANCE")
+ ", or "
+ (code "GL_LUMINANCE_ALPHA")
+ ". "))
+ (entry (% (heading (var "type")))
+ (para "
+Data type of components in the output image.
+ Symbolic constants "
+ (code "GL_UNSIGNED_BYTE")
+ ", "
+ (code "GL_BYTE")
+ ", "
+ (code "GL_BITMAP")
+ ", "
+ (code "GL_UNSIGNED_SHORT")
+ ", "
+ (code "GL_SHORT")
+ ", "
+ (code "GL_UNSIGNED_INT")
+ ", "
+ (code "GL_INT")
+ ", "
+ (code "GL_FLOAT")
+ ", "
+ (code "GL_UNSIGNED_BYTE_3_3_2")
+ ", "
+ (code "GL_UNSIGNED_BYTE_2_3_3_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_6_5")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_6_5_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_4_4_4_4")
+ ", "
+ (code "GL_UNSIGNED_SHORT_4_4_4_4_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_5_5_1")
+ ", "
+ (code "GL_UNSIGNED_SHORT_1_5_5_5_REV")
+ ", "
+ (code "GL_UNSIGNED_INT_8_8_8_8")
+ ", "
+ (code "GL_UNSIGNED_INT_8_8_8_8_REV")
+ ", "
+ (code "GL_UNSIGNED_INT_10_10_10_2")
+ ", and "
+ (code "GL_UNSIGNED_INT_2_10_10_10_REV")
+ "
+are accepted. "))
+ (entry (% (heading (var "image")))
+ (para "
+Pointer to storage for the output image. ")))
+ (heading "Description")
+ (para (code "glGetConvolutionFilter")
+ " returns the current 1D or 2D convolution filter kernel as an image.
+ The one- or two-dimensional image is placed in "
+ (var "image")
+ " according to the
+ specifications in "
+ (var "format")
+ " and "
+ (var "type")
+ ".
+ No pixel transfer operations are performed on this image, but the relevant
+ pixel storage modes are applied. ")
+ (para "
+If a non-zero named buffer object is bound to the "
+ (code "GL_PIXEL_PACK_BUFFER")
+ " target
+ (see "
+ (code "glBindBuffer")
+ ") while a convolution filter is
+ requested, "
+ (var "image")
+ " is treated as a byte offset into the buffer object's data store. ")
+ (para "
+Color components that are present in "
+ (var "format")
+ " but not included in the
+ internal format of the filter are returned as zero.
+ The assignments of internal color components to the components of "
+ (var "format")
+ "
+are as follows. ")
+ (table (% (formatter (asis)))
+ (entry (% (heading (strong "Internal Component")))
+ (para (strong "Resulting Component")))
+ (entry (% (heading "
+Red ")) (para "
+Red "))
+ (entry (% (heading "
+Green ")) (para "
+Green "))
+ (entry (% (heading "
+Blue ")) (para "
+Blue "))
+ (entry (% (heading "
+Alpha ")) (para "
+Alpha "))
+ (entry (% (heading "
+Luminance "))
+ (para "
+Red "))
+ (entry (% (heading "
+Intensity "))
+ (para "
+Red ")))
+ (para)
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "target")
+ " is not one of the allowable
+ values. ")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "format")
+ " is not one of the allowable
+ values. ")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "type")
+ " is not one of the allowable
+ values. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (var "type")
+ " is one of "
+ (code "GL_UNSIGNED_BYTE_3_3_2")
+ ", "
+ (code "GL_UNSIGNED_BYTE_2_3_3_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_6_5")
+ ", or "
+ (code "GL_UNSIGNED_SHORT_5_6_5_REV")
+ "
+and "
+ (var "format")
+ " is not "
+ (code "GL_RGB")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (var "type")
+ " is one of "
+ (code "GL_UNSIGNED_SHORT_4_4_4_4")
+ ", "
+ (code "GL_UNSIGNED_SHORT_4_4_4_4_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_5_5_1")
+ ", "
+ (code "GL_UNSIGNED_SHORT_1_5_5_5_REV")
+ ", "
+ (code "GL_UNSIGNED_INT_8_8_8_8")
+ ", "
+ (code "GL_UNSIGNED_INT_8_8_8_8_REV")
+ ", "
+ (code "GL_UNSIGNED_INT_10_10_10_2")
+ ", or "
+ (code "GL_UNSIGNED_INT_2_10_10_10_REV")
+ "
+and "
+ (var "format")
+ " is neither "
+ (code "GL_RGBA")
+ " nor "
+ (code "GL_BGRA")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a non-zero buffer object name is bound to the "
+ (code "GL_PIXEL_PACK_BUFFER")
+ " target and the buffer object's data store is currently mapped. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a non-zero buffer object name is bound to the "
+ (code "GL_PIXEL_PACK_BUFFER")
+ " target and the data would be packed to the buffer
+ object such that the memory writes required would exceed the data store size. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a non-zero buffer object name is bound to the "
+ (code "GL_PIXEL_PACK_BUFFER")
+ " target and "
+ (var "image")
+ " is not evenly divisible
+ into the number of bytes needed to store in memory a datum indicated by "
+ (var "type")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glGetConvolutionFilter")
+ " is executed
+ between the execution of "
+ (code "glBegin")
+ " and the corresponding
+ execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glGetConvolutionParameter
+ "glGetConvolutionParameter"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "void "
+ (function "glGetConvolutionParameterfv"))
+ (paramdef "GLenum " (parameter "target"))
+ (paramdef "GLenum " (parameter "pname"))
+ (paramdef "GLfloat * " (parameter "params"))))
+ '(*fragment*
+ (heading "get convolution parameters")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "target")))
+ (para "
+The filter whose parameters are to be retrieved.
+ Must be one of "
+ (code "GL_CONVOLUTION_1D")
+ ", "
+ (code "GL_CONVOLUTION_2D")
+ ", or "
+ (code "GL_SEPARABLE_2D")
+ ". "))
+ (entry (% (heading (var "pname")))
+ (para "
+The parameter to be retrieved.
+ Must be one of "
+ (code "GL_CONVOLUTION_BORDER_MODE")
+ ", "
+ (code "GL_CONVOLUTION_BORDER_COLOR")
+ ", "
+ (code "GL_CONVOLUTION_FILTER_SCALE")
+ ", "
+ (code "GL_CONVOLUTION_FILTER_BIAS")
+ ", "
+ (code "GL_CONVOLUTION_FORMAT")
+ ", "
+ (code "GL_CONVOLUTION_WIDTH")
+ ", "
+ (code "GL_CONVOLUTION_HEIGHT")
+ ", "
+ (code "GL_MAX_CONVOLUTION_WIDTH")
+ ", or "
+ (code "GL_MAX_CONVOLUTION_HEIGHT")
+ ". "))
+ (entry (% (heading (var "params")))
+ (para "
+Pointer to storage for the parameters to be retrieved. ")))
+ (heading "Description")
+ (para (code "glGetConvolutionParameter")
+ " retrieves convolution parameters. "
+ (var "target")
+ " determines which convolution filter is queried. "
+ (var "pname")
+ " determines which parameter is returned: ")
+ (table (% (formatter (asis)))
+ (entry (% (heading (code "GL_CONVOLUTION_BORDER_MODE")))
+ (para)
+ (para "
+The convolution border mode.
+ See "
+ (code "glConvolutionParameter")
+ " for a list of border modes. "))
+ (entry (% (heading (code "GL_CONVOLUTION_BORDER_COLOR")))
+ (para)
+ (para "
+The current convolution border color. "
+ (var "params")
+ " must be a pointer to an array of four elements,
+ which will receive the red, green, blue, and alpha border colors. "))
+ (entry (% (heading (code "GL_CONVOLUTION_FILTER_SCALE")))
+ (para)
+ (para "
+The current filter scale factors. "
+ (var "params")
+ " must be a pointer to an array of four elements,
+ which will receive the red, green, blue, and alpha filter scale
+ factors in that order. "))
+ (entry (% (heading (code "GL_CONVOLUTION_FILTER_BIAS")))
+ (para)
+ (para "
+The current filter bias factors. "
+ (var "params")
+ " must be a pointer to an array of four elements,
+ which will receive the red, green, blue, and alpha filter bias
+ terms in that order. "))
+ (entry (% (heading (code "GL_CONVOLUTION_FORMAT")))
+ (para)
+ (para "
+The current internal format.
+ See "
+ (code "glConvolutionFilter1D")
+ ", "
+ (code "glConvolutionFilter2D")
+ ",
+ and "
+ (code "glSeparableFilter2D")
+ " for lists of allowable
+ formats. "))
+ (entry (% (heading (code "GL_CONVOLUTION_WIDTH")))
+ (para)
+ (para "
+The current filter image width. "))
+ (entry (% (heading (code "GL_CONVOLUTION_HEIGHT")))
+ (para)
+ (para "
+The current filter image height. "))
+ (entry (% (heading (code "GL_MAX_CONVOLUTION_WIDTH")))
+ (para)
+ (para "
+The maximum acceptable filter image width. "))
+ (entry (% (heading (code "GL_MAX_CONVOLUTION_HEIGHT")))
+ (para)
+ (para "
+The maximum acceptable filter image height. ")))
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "target")
+ " is not one of the allowable
+ values. ")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "pname")
+ " is not one of the allowable
+ values. ")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "target")
+ " is "
+ (code "GL_CONVOLUTION_1D")
+ "
+and "
+ (var "pname")
+ " is "
+ (code "GL_CONVOLUTION_HEIGHT")
+ " or "
+ (code "GL_MAX_CONVOLUTION_HEIGHT")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glGetConvolutionParameter")
+ " is executed
+ between the execution of "
+ (code "glBegin")
+ " and the corresponding
+ execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glGetError
+ "glGetError"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "GLenum " (function "glGetError"))
+ (paramdef (parameter "void"))))
+ '(*fragment*
+ (heading "return error information")
+ (heading "Description")
+ (para (code "glGetError")
+ " returns the value of the error flag.
+ Each detectable error is assigned a numeric code and symbolic name.
+ When an error occurs,
+ the error flag is set to the appropriate error code value.
+ No other errors are recorded until "
+ (code "glGetError")
+ " is called,
+ the error code is returned,
+ and the flag is reset to "
+ (code "GL_NO_ERROR")
+ ".
+ If a call to "
+ (code "glGetError")
+ " returns "
+ (code "GL_NO_ERROR")
+ ",
+ there has been no detectable error since the last call to "
+ (code "glGetError")
+ ",
+ or since the GL was initialized. ")
+ (para "
+To allow for distributed implementations,
+ there may be several error flags.
+ If any single error flag has recorded an error,
+ the value of that flag is returned
+ and that flag is reset to "
+ (code "GL_NO_ERROR")
+ "
+when "
+ (code "glGetError")
+ " is called.
+ If more than one flag has recorded an error, "
+ (code "glGetError")
+ " returns and clears an arbitrary error flag value.
+ Thus, "
+ (code "glGetError")
+ " should always be called in a loop,
+ until it returns "
+ (code "GL_NO_ERROR")
+ ",
+ if all error flags are to be reset. ")
+ (para "
+Initially, all error flags are set to "
+ (code "GL_NO_ERROR")
+ ". ")
+ (para "
+The following errors are currently defined: ")
+ (table (% (formatter (asis)))
+ (entry (% (heading (code "GL_NO_ERROR")))
+ (para "
+No error has been recorded.
+ The value of this symbolic constant is guaranteed to be 0. "))
+ (entry (% (heading (code "GL_INVALID_ENUM")))
+ (para "
+An unacceptable value is specified for an enumerated argument.
+ The offending command is ignored
+ and has no other side effect than to set the error flag. "))
+ (entry (% (heading (code "GL_INVALID_VALUE")))
+ (para "
+A numeric argument is out of range.
+ The offending command is ignored
+ and has no other side effect than to set the error flag. "))
+ (entry (% (heading (code "GL_INVALID_OPERATION")))
+ (para "
+The specified operation is not allowed in the current state.
+ The offending command is ignored
+ and has no other side effect than to set the error flag. "))
+ (entry (% (heading (code "GL_STACK_OVERFLOW")))
+ (para "
+This command would cause a stack overflow.
+ The offending command is ignored
+ and has no other side effect than to set the error flag. "))
+ (entry (% (heading (code "GL_STACK_UNDERFLOW")))
+ (para "
+This command would cause a stack underflow.
+ The offending command is ignored
+ and has no other side effect than to set the error flag. "))
+ (entry (% (heading (code "GL_OUT_OF_MEMORY")))
+ (para "
+There is not enough memory left to execute the command.
+ The state of the GL is undefined,
+ except for the state of the error flags,
+ after this error is recorded. "))
+ (entry (% (heading (code "GL_TABLE_TOO_LARGE")))
+ (para "
+The specified table exceeds the implementation's maximum supported table
+ size. The offending command is ignored and has no other side effect
+ than to set the error flag. ")))
+ (para "
+When an error flag is set,
+ results of a GL operation are undefined only if "
+ (code "GL_OUT_OF_MEMORY")
+ "
+has occurred.
+ In all other cases,
+ the command generating the error is ignored and has no effect on the GL state
+ or frame buffer contents.
+ If the generating command returns a value, it returns 0.
+ If "
+ (code "glGetError")
+ " itself generates an error, it returns 0. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glGetError")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ".
+ In this case, "
+ (code "glGetError")
+ " returns 0. ")))
+
+(define-gl-procedure
+ glGetHistogramParameter
+ "glGetHistogramParameter"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "void "
+ (function "glGetHistogramParameterfv"))
+ (paramdef "GLenum " (parameter "target"))
+ (paramdef "GLenum " (parameter "pname"))
+ (paramdef "GLfloat * " (parameter "params"))))
+ '(*fragment*
+ (heading "get histogram parameters")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "target")))
+ (para "
+Must be one of "
+ (code "GL_HISTOGRAM")
+ " or "
+ (code "GL_PROXY_HISTOGRAM")
+ ". "))
+ (entry (% (heading (var "pname")))
+ (para "
+The name of the parameter to be retrieved.
+ Must be one of "
+ (code "GL_HISTOGRAM_WIDTH")
+ ", "
+ (code "GL_HISTOGRAM_FORMAT")
+ ", "
+ (code "GL_HISTOGRAM_RED_SIZE")
+ ", "
+ (code "GL_HISTOGRAM_GREEN_SIZE")
+ ", "
+ (code "GL_HISTOGRAM_BLUE_SIZE")
+ ", "
+ (code "GL_HISTOGRAM_ALPHA_SIZE")
+ ", "
+ (code "GL_HISTOGRAM_LUMINANCE_SIZE")
+ ", or "
+ (code "GL_HISTOGRAM_SINK")
+ ". "))
+ (entry (% (heading (var "params")))
+ (para "
+Pointer to storage for the returned values. ")))
+ (heading "Description")
+ (para (code "glGetHistogramParameter")
+ " is used to query parameter values for the current histogram or for
+ a proxy. The histogram state information may be queried by calling "
+ (code "glGetHistogramParameter")
+ " with a "
+ (var "target")
+ " of "
+ (code "GL_HISTOGRAM")
+ " (to
+ obtain information for the current histogram table) or "
+ (code "GL_PROXY_HISTOGRAM")
+ " (to obtain information from the most recent
+ proxy request) and one of the following values for the "
+ (var "pname")
+ " argument: ")
+ (para)
+ (table (% (formatter (asis)))
+ (entry (% (heading (strong "Parameter")))
+ (para (strong "Description")))
+ (entry (% (heading (code "GL_HISTOGRAM_WIDTH")))
+ (para "
+Histogram table width "))
+ (entry (% (heading (code "GL_HISTOGRAM_FORMAT")))
+ (para "
+Internal format "))
+ (entry (% (heading (code "GL_HISTOGRAM_RED_SIZE")))
+ (para "
+Red component counter size, in bits "))
+ (entry (% (heading (code "GL_HISTOGRAM_GREEN_SIZE")))
+ (para "
+Green component counter size, in bits "))
+ (entry (% (heading (code "GL_HISTOGRAM_BLUE_SIZE")))
+ (para "
+Blue component counter size, in bits "))
+ (entry (% (heading (code "GL_HISTOGRAM_ALPHA_SIZE")))
+ (para "
+Alpha component counter size, in bits "))
+ (entry (% (heading (code "GL_HISTOGRAM_LUMINANCE_SIZE")))
+ (para "
+Luminance component counter size, in bits "))
+ (entry (% (heading (code "GL_HISTOGRAM_SINK")))
+ (para "
+Value of the "
+ (var "sink")
+ " parameter ")))
+ (para)
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "target")
+ " is not one of the allowable
+ values. ")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "pname")
+ " is not one of the allowable
+ values. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glGetHistogramParameter")
+ " is executed
+ between the execution of "
+ (code "glBegin")
+ " and the corresponding
+ execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glGetHistogram
+ "glGetHistogram"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glGetHistogram"))
+ (paramdef "GLenum " (parameter "target"))
+ (paramdef "GLboolean " (parameter "reset"))
+ (paramdef "GLenum " (parameter "format"))
+ (paramdef "GLenum " (parameter "type"))
+ (paramdef "GLvoid * " (parameter "values"))))
+ '(*fragment*
+ (heading "get histogram table")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "target")))
+ (para "
+Must be " (code "GL_HISTOGRAM") ". "))
+ (entry (% (heading (var "reset")))
+ (para "
+If "
+ (code "GL_TRUE")
+ ", each component counter that is actually returned
+ is reset to zero. (Other counters are unaffected.)
+ If "
+ (code "GL_FALSE")
+ ", none of the counters in the histogram table is modified. "))
+ (entry (% (heading (var "format")))
+ (para "
+The format of values to be returned in "
+ (var "values")
+ ".
+ Must be one of "
+ (code "GL_RED")
+ ", "
+ (code "GL_GREEN")
+ ", "
+ (code "GL_BLUE")
+ ", "
+ (code "GL_ALPHA")
+ ", "
+ (code "GL_RGB")
+ ", "
+ (code "GL_BGR")
+ ", "
+ (code "GL_RGBA")
+ ", "
+ (code "GL_BGRA")
+ ", "
+ (code "GL_LUMINANCE")
+ ", or "
+ (code "GL_LUMINANCE_ALPHA")
+ ". "))
+ (entry (% (heading (var "type")))
+ (para "
+The type of values to be returned in "
+ (var "values")
+ ".
+ Symbolic constants "
+ (code "GL_UNSIGNED_BYTE")
+ ", "
+ (code "GL_BYTE")
+ ", "
+ (code "GL_BITMAP")
+ ", "
+ (code "GL_UNSIGNED_SHORT")
+ ", "
+ (code "GL_SHORT")
+ ", "
+ (code "GL_UNSIGNED_INT")
+ ", "
+ (code "GL_INT")
+ ", "
+ (code "GL_FLOAT")
+ ", "
+ (code "GL_UNSIGNED_BYTE_3_3_2")
+ ", "
+ (code "GL_UNSIGNED_BYTE_2_3_3_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_6_5")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_6_5_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_4_4_4_4")
+ ", "
+ (code "GL_UNSIGNED_SHORT_4_4_4_4_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_5_5_1")
+ ", "
+ (code "GL_UNSIGNED_SHORT_1_5_5_5_REV")
+ ", "
+ (code "GL_UNSIGNED_INT_8_8_8_8")
+ ", "
+ (code "GL_UNSIGNED_INT_8_8_8_8_REV")
+ ", "
+ (code "GL_UNSIGNED_INT_10_10_10_2")
+ ", and "
+ (code "GL_UNSIGNED_INT_2_10_10_10_REV")
+ "
+are accepted. "))
+ (entry (% (heading (var "values")))
+ (para "
+A pointer to storage for the returned histogram table. ")))
+ (heading "Description")
+ (para (code "glGetHistogram")
+ " returns the current histogram table as a one-dimensional image
+ with the same width as the histogram.
+ No pixel transfer operations are performed on this image, but pixel storage
+ modes that are applicable to 1D images are honored. ")
+ (para "
+If a non-zero named buffer object is bound to the "
+ (code "GL_PIXEL_PACK_BUFFER")
+ " target
+ (see "
+ (code "glBindBuffer")
+ ") while a histogram table is
+ requested, "
+ (var "values")
+ " is treated as a byte offset into the buffer object's data store. ")
+ (para "
+Color components that are requested in the specified "
+ (var "format")
+ ", but which
+ are not included in the internal format of the histogram, are returned as
+ zero.
+ The assignments of internal color components to the components
+ requested by "
+ (var "format")
+ " are: ")
+ (table (% (formatter (asis)))
+ (entry (% (heading (strong "Internal Component")))
+ (para (strong "Resulting Component")))
+ (entry (% (heading "
+Red ")) (para "
+Red "))
+ (entry (% (heading "
+Green ")) (para "
+Green "))
+ (entry (% (heading "
+Blue ")) (para "
+Blue "))
+ (entry (% (heading "
+Alpha ")) (para "
+Alpha "))
+ (entry (% (heading "
+Luminance "))
+ (para "
+Red ")))
+ (para)
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "target")
+ " is not "
+ (code "GL_HISTOGRAM")
+ ". ")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "format")
+ " is not one of the allowable
+ values. ")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "type")
+ " is not one of the allowable
+ values. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (var "type")
+ " is one of "
+ (code "GL_UNSIGNED_BYTE_3_3_2")
+ ", "
+ (code "GL_UNSIGNED_BYTE_2_3_3_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_6_5")
+ ", or "
+ (code "GL_UNSIGNED_SHORT_5_6_5_REV")
+ "
+and "
+ (var "format")
+ " is not "
+ (code "GL_RGB")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (var "type")
+ " is one of "
+ (code "GL_UNSIGNED_SHORT_4_4_4_4")
+ ", "
+ (code "GL_UNSIGNED_SHORT_4_4_4_4_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_5_5_1")
+ ", "
+ (code "GL_UNSIGNED_SHORT_1_5_5_5_REV")
+ ", "
+ (code "GL_UNSIGNED_INT_8_8_8_8")
+ ", "
+ (code "GL_UNSIGNED_INT_8_8_8_8_REV")
+ ", "
+ (code "GL_UNSIGNED_INT_10_10_10_2")
+ ", or "
+ (code "GL_UNSIGNED_INT_2_10_10_10_REV")
+ "
+and "
+ (var "format")
+ " is neither "
+ (code "GL_RGBA")
+ " nor "
+ (code "GL_BGRA")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a non-zero buffer object name is bound to the "
+ (code "GL_PIXEL_PACK_BUFFER")
+ " target and the buffer object's data store is currently mapped. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a non-zero buffer object name is bound to the "
+ (code "GL_PIXEL_PACK_BUFFER")
+ " target and the data would be packed to the buffer
+ object such that the memory writes required would exceed the data store size. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a non-zero buffer object name is bound to the "
+ (code "GL_PIXEL_PACK_BUFFER")
+ " target and "
+ (var "values")
+ " is not evenly divisible
+ into the number of bytes needed to store in memory a datum indicated by "
+ (var "type")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glGetHistogram")
+ " is executed
+ between the execution of "
+ (code "glBegin")
+ " and the corresponding
+ execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glGetLight
+ "glGetLight"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glGetLightfv"))
+ (paramdef "GLenum " (parameter "light"))
+ (paramdef "GLenum " (parameter "pname"))
+ (paramdef "GLfloat * " (parameter "params"))))
+ '(*fragment*
+ (heading "return light source parameter values")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "light")))
+ (para "
+Specifies a light source.
+ The number of possible lights depends on the implementation,
+ but at least eight lights are supported.
+ They are identified by symbolic names of the form "
+ (code "GL_LIGHT")
+ (math (var "i"))
+ "
+where "
+ (math (var "i"))
+ "
+ranges from 0 to the value of "
+ (code "GL_MAX_LIGHTS")
+ " - 1. "))
+ (entry (% (heading (var "pname")))
+ (para "
+Specifies a light source parameter for "
+ (var "light")
+ ".
+ Accepted symbolic names are "
+ (code "GL_AMBIENT")
+ ", "
+ (code "GL_DIFFUSE")
+ ", "
+ (code "GL_SPECULAR")
+ ", "
+ (code "GL_POSITION")
+ ", "
+ (code "GL_SPOT_DIRECTION")
+ ", "
+ (code "GL_SPOT_EXPONENT")
+ ", "
+ (code "GL_SPOT_CUTOFF")
+ ", "
+ (code "GL_CONSTANT_ATTENUATION")
+ ", "
+ (code "GL_LINEAR_ATTENUATION")
+ ", and "
+ (code "GL_QUADRATIC_ATTENUATION")
+ ". "))
+ (entry (% (heading (var "params")))
+ (para "
+Returns the requested data. ")))
+ (heading "Description")
+ (para (code "glGetLight")
+ " returns in "
+ (var "params")
+ " the value or values of a light source parameter. "
+ (var "light")
+ " names the light and is a symbolic name of the form "
+ (code "GL_LIGHT")
+ (math (var "i"))
+ "
+where i ranges from 0 to the value of "
+ (code "GL_MAX_LIGHTS")
+ " - 1. "
+ (code "GL_MAX_LIGHTS")
+ " is an implementation dependent constant that is
+ greater than or equal to eight. "
+ (var "pname")
+ " specifies one of ten light source parameters,
+ again by symbolic name. ")
+ (para "
+The following parameters are defined: ")
+ (table (% (formatter (asis)))
+ (entry (% (heading (code "GL_AMBIENT")))
+ (para (var "params")
+ " returns four integer or floating-point values representing the
+ ambient intensity of the light source.
+ Integer values,
+ when requested,
+ are linearly mapped from the internal floating-point representation
+ such that 1.0 maps to the most positive representable integer value,
+ and "
+ (math "-1.0")
+ "
+maps to the most negative representable integer value.
+ If the internal value is outside the range "
+ (math "[" "-1" "," "1" "]")
+ ",
+ the corresponding integer return value is undefined. The initial value is
+ (0, 0, 0, 1). "))
+ (entry (% (heading (code "GL_DIFFUSE")))
+ (para (var "params")
+ " returns four integer or floating-point values representing the
+ diffuse intensity of the light source.
+ Integer values,
+ when requested,
+ are linearly mapped from the internal floating-point representation
+ such that 1.0 maps to the most positive representable integer value,
+ and "
+ (math "-1.0")
+ "
+maps to the most negative representable integer value.
+ If the internal value is outside the range "
+ (math "[" "-1" "," "1" "]")
+ ",
+ the corresponding integer return value is undefined. The initial value
+ for "
+ (code "GL_LIGHT0")
+ " is (1, 1, 1, 1); for other lights, the
+ initial value is (0, 0, 0, 0). "))
+ (entry (% (heading (code "GL_SPECULAR")))
+ (para (var "params")
+ " returns four integer or floating-point values representing the
+ specular intensity of the light source.
+ Integer values,
+ when requested,
+ are linearly mapped from the internal floating-point representation
+ such that 1.0 maps to the most positive representable integer value,
+ and "
+ (math "-1.0")
+ "
+maps to the most negative representable integer value.
+ If the internal value is outside the range "
+ (math "[" "-1" "," "1" "]")
+ ",
+ the corresponding integer return value is undefined. The initial value
+ for "
+ (code "GL_LIGHT0")
+ " is (1, 1, 1, 1); for other lights, the
+ initial value is (0, 0, 0, 0). "))
+ (entry (% (heading (code "GL_POSITION")))
+ (para (var "params")
+ " returns four integer or floating-point values representing the
+ position of the light source.
+ Integer values,
+ when requested,
+ are computed by rounding the internal floating-point values to the
+ nearest integer value.
+ The returned values are those maintained in eye coordinates.
+ They will not be equal to the values specified using "
+ (code "glLight")
+ ",
+ unless the modelview matrix was identity at the time "
+ (code "glLight")
+ " was
+ called. The initial value is (0, 0, 1, 0). "))
+ (entry (% (heading (code "GL_SPOT_DIRECTION")))
+ (para (var "params")
+ " returns three integer or floating-point values representing the
+ direction of the light source.
+ Integer values,
+ when requested,
+ are computed by rounding the internal floating-point values to the
+ nearest integer value.
+ The returned values are those maintained in eye coordinates.
+ They will not be equal to the values specified using "
+ (code "glLight")
+ ",
+ unless the modelview matrix was identity at the time "
+ (code "glLight")
+ " was called.
+ Although spot direction is normalized before being used in the lighting
+ equation,
+ the returned values are the transformed versions of the specified values
+ prior to normalization. The initial value is "
+ (math "(" "0" "," "0" "-1" ")")
+ ". "))
+ (entry (% (heading (code "GL_SPOT_EXPONENT")))
+ (para (var "params")
+ " returns a single integer or floating-point value representing the
+ spot exponent of the light.
+ An integer value,
+ when requested,
+ is computed by rounding the internal floating-point representation to
+ the nearest integer. The initial value is 0. "))
+ (entry (% (heading (code "GL_SPOT_CUTOFF")))
+ (para (var "params")
+ " returns a single integer or floating-point value representing the
+ spot cutoff angle of the light.
+ An integer value,
+ when requested,
+ is computed by rounding the internal floating-point representation to
+ the nearest integer. The initial value is 180. "))
+ (entry (% (heading (code "GL_CONSTANT_ATTENUATION")))
+ (para (var "params")
+ " returns a single integer or floating-point value representing the
+ constant (not distance-related) attenuation of the light.
+ An integer value,
+ when requested,
+ is computed by rounding the internal floating-point representation to
+ the nearest integer. The initial value is 1. "))
+ (entry (% (heading (code "GL_LINEAR_ATTENUATION")))
+ (para (var "params")
+ " returns a single integer or floating-point value representing the
+ linear attenuation of the light.
+ An integer value,
+ when requested,
+ is computed by rounding the internal floating-point representation to
+ the nearest integer. The initial value is 0. "))
+ (entry (% (heading (code "GL_QUADRATIC_ATTENUATION")))
+ (para (var "params")
+ " returns a single integer or floating-point value representing the
+ quadratic attenuation of the light.
+ An integer value,
+ when requested,
+ is computed by rounding the internal floating-point representation to
+ the nearest integer. The initial value is 0. ")))
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "light")
+ " or "
+ (var "pname")
+ " is not an
+ accepted value. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glGetLight")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glGetMap
+ "glGetMap"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glGetMapdv"))
+ (paramdef "GLenum " (parameter "target"))
+ (paramdef "GLenum " (parameter "query"))
+ (paramdef "GLdouble * " (parameter "v"))))
+ '(*fragment*
+ (heading "return evaluator parameters")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "target")))
+ (para "
+Specifies the symbolic name of a map.
+ Accepted values are "
+ (code "GL_MAP1_COLOR_4")
+ ", "
+ (code "GL_MAP1_INDEX")
+ ", "
+ (code "GL_MAP1_NORMAL")
+ ", "
+ (code "GL_MAP1_TEXTURE_COORD_1")
+ ", "
+ (code "GL_MAP1_TEXTURE_COORD_2")
+ ", "
+ (code "GL_MAP1_TEXTURE_COORD_3")
+ ", "
+ (code "GL_MAP1_TEXTURE_COORD_4")
+ ", "
+ (code "GL_MAP1_VERTEX_3")
+ ", "
+ (code "GL_MAP1_VERTEX_4")
+ ", "
+ (code "GL_MAP2_COLOR_4")
+ ", "
+ (code "GL_MAP2_INDEX")
+ ", "
+ (code "GL_MAP2_NORMAL")
+ ", "
+ (code "GL_MAP2_TEXTURE_COORD_1")
+ ", "
+ (code "GL_MAP2_TEXTURE_COORD_2")
+ ", "
+ (code "GL_MAP2_TEXTURE_COORD_3")
+ ", "
+ (code "GL_MAP2_TEXTURE_COORD_4")
+ ", "
+ (code "GL_MAP2_VERTEX_3")
+ ", and "
+ (code "GL_MAP2_VERTEX_4")
+ ". "))
+ (entry (% (heading (var "query")))
+ (para "
+Specifies which parameter to return.
+ Symbolic names "
+ (code "GL_COEFF")
+ ", "
+ (code "GL_ORDER")
+ ", and "
+ (code "GL_DOMAIN")
+ " are accepted. "))
+ (entry (% (heading (var "v")))
+ (para "
+Returns the requested data. ")))
+ (heading "Description")
+ (para (code "glMap1")
+ " and "
+ (code "glMap2")
+ " define evaluators. "
+ (code "glGetMap")
+ " returns evaluator parameters. "
+ (var "target")
+ " chooses a map, "
+ (var "query")
+ " selects a specific parameter,
+ and "
+ (var "v")
+ " points to storage where the values will be returned. ")
+ (para "
+The acceptable values for the "
+ (var "target")
+ " parameter are described
+ in the "
+ (code "glMap1")
+ " and "
+ (code "glMap2")
+ " reference pages. ")
+ (para (var "query")
+ " can assume the following values: ")
+ (table (% (formatter (asis)))
+ (entry (% (heading (code "GL_COEFF")))
+ (para (var "v")
+ " returns the control points for the evaluator function.
+ One-dimensional evaluators return "
+ (math (var "order"))
+ "
+control points,
+ and two-dimensional evaluators return "
+ (math (var "uorder") "×" (var "vorder"))
+ "
+control points.
+ Each control point consists of one, two, three, or four integer,
+ single-precision floating-point,
+ or double-precision floating-point values,
+ depending on the type of the evaluator.
+ The GL returns two-dimensional control points in row-major order,
+ incrementing the "
+ (math (var "uorder"))
+ "
+index quickly
+ and the "
+ (math (var "vorder"))
+ "
+index after each row.
+ Integer values,
+ when requested,
+ are computed by rounding the internal floating-point values to the
+ nearest integer values. "))
+ (entry (% (heading (code "GL_ORDER")))
+ (para (var "v")
+ " returns the order of the evaluator function.
+ One-dimensional evaluators return a single value, "
+ (math (var "order"))
+ ".
+ The initial value is 1.
+ Two-dimensional evaluators return two values, "
+ (math (var "uorder"))
+ "
+and "
+ (math (var "vorder"))
+ ".
+ The initial value is 1,1. "))
+ (entry (% (heading (code "GL_DOMAIN")))
+ (para (var "v")
+ " returns the linear "
+ (math (var "u"))
+ "
+and "
+ (math (var "v"))
+ "
+mapping parameters.
+ One-dimensional evaluators return two values, "
+ (math (var "u1"))
+ "
+and "
+ (math (var "u2"))
+ ",
+ as specified by "
+ (code "glMap1")
+ ".
+ Two-dimensional evaluators return four values
+ ("
+ (math (var "u1"))
+ ", "
+ (math (var "u2"))
+ ", "
+ (math (var "v1"))
+ ",
+ and "
+ (math (var "v2"))
+ ")
+ as specified by "
+ (code "glMap2")
+ ".
+ Integer values,
+ when requested,
+ are computed by rounding the internal floating-point values to the
+ nearest integer values. ")))
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if either "
+ (var "target")
+ " or "
+ (var "query")
+ " is not
+ an accepted value. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glGetMap")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glGetMaterial
+ "glGetMaterial"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glGetMaterialfv"))
+ (paramdef "GLenum " (parameter "face"))
+ (paramdef "GLenum " (parameter "pname"))
+ (paramdef "GLfloat * " (parameter "params"))))
+ '(*fragment*
+ (heading "return material parameters")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "face")))
+ (para "
+Specifies which of the two materials is being queried. "
+ (code "GL_FRONT")
+ " or "
+ (code "GL_BACK")
+ " are accepted,
+ representing the front and back materials,
+ respectively. "))
+ (entry (% (heading (var "pname")))
+ (para "
+Specifies the material parameter to return. "
+ (code "GL_AMBIENT")
+ ", "
+ (code "GL_DIFFUSE")
+ ", "
+ (code "GL_SPECULAR")
+ ", "
+ (code "GL_EMISSION")
+ ", "
+ (code "GL_SHININESS")
+ ", and "
+ (code "GL_COLOR_INDEXES")
+ "
+are accepted. "))
+ (entry (% (heading (var "params")))
+ (para "
+Returns the requested data. ")))
+ (heading "Description")
+ (para (code "glGetMaterial")
+ " returns in "
+ (var "params")
+ " the value or values of parameter "
+ (var "pname")
+ "
+of material "
+ (var "face")
+ ". Six parameters are defined: ")
+ (table (% (formatter (asis)))
+ (entry (% (heading (code "GL_AMBIENT")))
+ (para (var "params")
+ " returns four integer or floating-point values representing the
+ ambient reflectance of the material.
+ Integer values,
+ when requested,
+ are linearly mapped from the internal floating-point representation
+ such that 1.0 maps to the most positive representable integer value,
+ and "
+ (math "-1.0")
+ "
+maps to the most negative representable integer value.
+ If the internal value is outside the range "
+ (math "[" "-1" "," "1" "]")
+ ",
+ the corresponding integer return value is undefined. The initial value is
+ (0.2, 0.2, 0.2, 1.0) "))
+ (entry (% (heading (code "GL_DIFFUSE")))
+ (para (var "params")
+ " returns four integer or floating-point values representing the
+ diffuse reflectance of the material.
+ Integer values,
+ when requested,
+ are linearly mapped from the internal floating-point representation
+ such that 1.0 maps to the most positive representable integer value,
+ and "
+ (math "-1.0")
+ "
+maps to the most negative representable integer value.
+ If the internal value is outside the range "
+ (math "[" "-1" "," "1" "]")
+ ",
+ the corresponding integer return value is undefined. The initial value is
+ (0.8, 0.8, 0.8, 1.0). "))
+ (entry (% (heading (code "GL_SPECULAR")))
+ (para (var "params")
+ " returns four integer or floating-point values representing the
+ specular reflectance of the material.
+ Integer values,
+ when requested,
+ are linearly mapped from the internal floating-point representation
+ such that 1.0 maps to the most positive representable integer value,
+ and "
+ (math "-1.0")
+ "
+maps to the most negative representable integer value.
+ If the internal value is outside the range "
+ (math "[" "-1" "," "1" "]")
+ ",
+ the corresponding integer return value is undefined. The initial value is
+ (0, 0, 0, 1). "))
+ (entry (% (heading (code "GL_EMISSION")))
+ (para (var "params")
+ " returns four integer or floating-point values representing the
+ emitted light intensity of the material.
+ Integer values,
+ when requested,
+ are linearly mapped from the internal floating-point representation
+ such that 1.0 maps to the most positive representable integer value,
+ and "
+ (math "-1.0")
+ "
+maps to the most negative representable integer value.
+ If the internal value is outside the range "
+ (math "[" "-1" "," "1" "]")
+ ",
+ the corresponding integer return value is undefined. The initial value is
+ (0, 0, 0, 1). "))
+ (entry (% (heading (code "GL_SHININESS")))
+ (para (var "params")
+ " returns one integer or floating-point value representing the
+ specular exponent of the material.
+ Integer values,
+ when requested,
+ are computed by rounding the internal floating-point value to the
+ nearest integer value. The initial value is 0. "))
+ (entry (% (heading (code "GL_COLOR_INDEXES")))
+ (para (var "params")
+ " returns three integer or floating-point values representing the
+ ambient, diffuse, and specular indices of the material.
+ These indices are used only for color index lighting.
+ (All the other parameters are used only for RGBA lighting.)
+ Integer values,
+ when requested,
+ are computed by rounding the internal floating-point values to the
+ nearest integer values. ")))
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "face")
+ " or "
+ (var "pname")
+ " is not an
+ accepted value. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glGetMaterial")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glGetMinmaxParameter
+ "glGetMinmaxParameter"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "void "
+ (function "glGetMinmaxParameterfv"))
+ (paramdef "GLenum " (parameter "target"))
+ (paramdef "GLenum " (parameter "pname"))
+ (paramdef "GLfloat * " (parameter "params"))))
+ '(*fragment*
+ (heading "get minmax parameters")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "target")))
+ (para "
+Must be " (code "GL_MINMAX") ". "))
+ (entry (% (heading (var "pname")))
+ (para "
+The parameter to be retrieved.
+ Must be one of "
+ (code "GL_MINMAX_FORMAT")
+ " or "
+ (code "GL_MINMAX_SINK")
+ ". "))
+ (entry (% (heading (var "params")))
+ (para "
+A pointer to storage for the retrieved parameters. ")))
+ (heading "Description")
+ (para (code "glGetMinmaxParameter")
+ " retrieves parameters for the current minmax table by setting "
+ (var "pname")
+ " to one of the following values: ")
+ (para)
+ (table (% (formatter (asis)))
+ (entry (% (heading (strong "Parameter")))
+ (para (strong "Description")))
+ (entry (% (heading (code "GL_MINMAX_FORMAT")))
+ (para "
+Internal format of minmax table "))
+ (entry (% (heading (code "GL_MINMAX_SINK")))
+ (para "
+Value of the "
+ (var "sink")
+ " parameter ")))
+ (para)
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "target")
+ " is not "
+ (code "GL_MINMAX")
+ ". ")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "pname")
+ " is not one of the allowable
+ values. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glGetMinmaxParameter")
+ " is executed
+ between the execution of "
+ (code "glBegin")
+ " and the corresponding
+ execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glGetMinmax
+ "glGetMinmax"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glGetMinmax"))
+ (paramdef "GLenum " (parameter "target"))
+ (paramdef "GLboolean " (parameter "reset"))
+ (paramdef "GLenum " (parameter "format"))
+ (paramdef "GLenum " (parameter "types"))
+ (paramdef "GLvoid * " (parameter "values"))))
+ '(*fragment*
+ (heading "get minimum and maximum pixel values")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "target")))
+ (para "
+Must be " (code "GL_MINMAX") ". "))
+ (entry (% (heading (var "reset")))
+ (para "
+If "
+ (code "GL_TRUE")
+ ", all entries in the minmax table that are actually
+ returned are reset to their initial values. (Other entries are unaltered.)
+ If "
+ (code "GL_FALSE")
+ ", the minmax table is unaltered. "))
+ (entry (% (heading (var "format")))
+ (para "
+The format of the data to be returned in "
+ (var "values")
+ ".
+ Must be one of "
+ (code "GL_RED")
+ ", "
+ (code "GL_GREEN")
+ ", "
+ (code "GL_BLUE")
+ ", "
+ (code "GL_ALPHA")
+ ", "
+ (code "GL_RGB")
+ ", "
+ (code "GL_BGR")
+ ", "
+ (code "GL_RGBA")
+ ", "
+ (code "GL_BGRA")
+ ", "
+ (code "GL_LUMINANCE")
+ ", or "
+ (code "GL_LUMINANCE_ALPHA")
+ ". "))
+ (entry (% (heading (var "types")))
+ (para "
+The type of the data to be returned in "
+ (var "values")
+ ".
+ Symbolic constants "
+ (code "GL_UNSIGNED_BYTE")
+ ", "
+ (code "GL_BYTE")
+ ", "
+ (code "GL_BITMAP")
+ ", "
+ (code "GL_UNSIGNED_SHORT")
+ ", "
+ (code "GL_SHORT")
+ ", "
+ (code "GL_UNSIGNED_INT")
+ ", "
+ (code "GL_INT")
+ ", "
+ (code "GL_FLOAT")
+ ", "
+ (code "GL_UNSIGNED_BYTE_3_3_2")
+ ", "
+ (code "GL_UNSIGNED_BYTE_2_3_3_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_6_5")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_6_5_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_4_4_4_4")
+ ", "
+ (code "GL_UNSIGNED_SHORT_4_4_4_4_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_5_5_1")
+ ", "
+ (code "GL_UNSIGNED_SHORT_1_5_5_5_REV")
+ ", "
+ (code "GL_UNSIGNED_INT_8_8_8_8")
+ ", "
+ (code "GL_UNSIGNED_INT_8_8_8_8_REV")
+ ", "
+ (code "GL_UNSIGNED_INT_10_10_10_2")
+ ", and "
+ (code "GL_UNSIGNED_INT_2_10_10_10_REV")
+ "
+are accepted. "))
+ (entry (% (heading (var "values")))
+ (para "
+A pointer to storage for the returned values. ")))
+ (heading "Description")
+ (para (code "glGetMinmax")
+ " returns the accumulated minimum and maximum pixel values (computed on a
+ per-component basis) in a one-dimensional image of width 2. The first set
+ of return values are the minima, and the second set of return values
+ are the maxima.
+ The format of the return values is determined by "
+ (var "format")
+ ", and their type is
+ determined by "
+ (var "types")
+ ". ")
+ (para "
+If a non-zero named buffer object is bound to the "
+ (code "GL_PIXEL_PACK_BUFFER")
+ " target
+ (see "
+ (code "glBindBuffer")
+ ") while minimum and maximum pixel values are
+ requested, "
+ (var "values")
+ " is treated as a byte offset into the buffer object's data store. ")
+ (para "
+No pixel transfer operations are performed on the return values, but pixel
+ storage modes that are applicable to one-dimensional images are performed.
+ Color components that are requested in the specified "
+ (var "format")
+ ", but that
+ are not included in the internal format of the minmax table, are
+ returned as zero. The assignment of internal color components to the
+ components requested by "
+ (var "format")
+ " are as follows: ")
+ (para)
+ (table (% (formatter (asis)))
+ (entry (% (heading (strong "Internal Component")))
+ (para (strong "Resulting Component")))
+ (entry (% (heading "
+Red ")) (para "
+Red "))
+ (entry (% (heading "
+Green ")) (para "
+Green "))
+ (entry (% (heading "
+Blue ")) (para "
+Blue "))
+ (entry (% (heading "
+Alpha ")) (para "
+Alpha "))
+ (entry (% (heading "
+Luminance "))
+ (para "
+Red ")))
+ (para "
+If "
+ (var "reset")
+ " is "
+ (code "GL_TRUE")
+ ", the minmax table entries corresponding
+ to the return values are reset to their initial
+ values. Minimum and maximum values that are not returned are not
+ modified, even if "
+ (var "reset")
+ " is "
+ (code "GL_TRUE")
+ ". ")
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "target")
+ " is not "
+ (code "GL_MINMAX")
+ ". ")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "format")
+ " is not one of the allowable
+ values. ")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "types")
+ " is not one of the allowable
+ values. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (var "types")
+ " is one of "
+ (code "GL_UNSIGNED_BYTE_3_3_2")
+ ", "
+ (code "GL_UNSIGNED_BYTE_2_3_3_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_6_5")
+ ", or "
+ (code "GL_UNSIGNED_SHORT_5_6_5_REV")
+ "
+and "
+ (var "format")
+ " is not "
+ (code "GL_RGB")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (var "types")
+ " is one of "
+ (code "GL_UNSIGNED_SHORT_4_4_4_4")
+ ", "
+ (code "GL_UNSIGNED_SHORT_4_4_4_4_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_5_5_1")
+ ", "
+ (code "GL_UNSIGNED_SHORT_1_5_5_5_REV")
+ ", "
+ (code "GL_UNSIGNED_INT_8_8_8_8")
+ ", "
+ (code "GL_UNSIGNED_INT_8_8_8_8_REV")
+ ", "
+ (code "GL_UNSIGNED_INT_10_10_10_2")
+ ", or "
+ (code "GL_UNSIGNED_INT_2_10_10_10_REV")
+ "
+and "
+ (var "format")
+ " is neither "
+ (code "GL_RGBA")
+ " nor "
+ (code "GL_BGRA")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a non-zero buffer object name is bound to the "
+ (code "GL_PIXEL_PACK_BUFFER")
+ " target and the buffer object's data store is currently mapped. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a non-zero buffer object name is bound to the "
+ (code "GL_PIXEL_PACK_BUFFER")
+ " target and the data would be packed to the buffer
+ object such that the memory writes required would exceed the data store size. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a non-zero buffer object name is bound to the "
+ (code "GL_PIXEL_PACK_BUFFER")
+ " target and "
+ (var "values")
+ " is not evenly divisible
+ into the number of bytes needed to store in memory a datum indicated by "
+ (var "type")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glGetMinmax")
+ " is executed
+ between the execution of "
+ (code "glBegin")
+ " and the corresponding
+ execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glGetPixelMap
+ "glGetPixelMap"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glGetPixelMapfv"))
+ (paramdef "GLenum " (parameter "map"))
+ (paramdef "GLfloat * " (parameter "data"))))
+ '(*fragment*
+ (heading "return the specified pixel map")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "map")))
+ (para "
+Specifies the name of the pixel map to return.
+ Accepted values are "
+ (code "GL_PIXEL_MAP_I_TO_I")
+ ", "
+ (code "GL_PIXEL_MAP_S_TO_S")
+ ", "
+ (code "GL_PIXEL_MAP_I_TO_R")
+ ", "
+ (code "GL_PIXEL_MAP_I_TO_G")
+ ", "
+ (code "GL_PIXEL_MAP_I_TO_B")
+ ", "
+ (code "GL_PIXEL_MAP_I_TO_A")
+ ", "
+ (code "GL_PIXEL_MAP_R_TO_R")
+ ", "
+ (code "GL_PIXEL_MAP_G_TO_G")
+ ", "
+ (code "GL_PIXEL_MAP_B_TO_B")
+ ", and "
+ (code "GL_PIXEL_MAP_A_TO_A")
+ ". "))
+ (entry (% (heading (var "data")))
+ (para "
+Returns the pixel map contents. ")))
+ (heading "Description")
+ (para "
+See the "
+ (code "glPixelMap")
+ " reference page for a description of the acceptable
+ values for the "
+ (var "map")
+ " parameter. "
+ (code "glGetPixelMap")
+ " returns in "
+ (var "data")
+ " the contents of the pixel map
+ specified in "
+ (var "map")
+ ".
+ Pixel maps are used during the execution of "
+ (code "glReadPixels")
+ ", "
+ (code "glDrawPixels")
+ ", "
+ (code "glCopyPixels")
+ ", "
+ (code "glTexImage1D")
+ ", "
+ (code "glTexImage2D")
+ ", "
+ (code "glTexImage3D")
+ ", "
+ (code "glTexSubImage1D")
+ ", "
+ (code "glTexSubImage2D")
+ ", "
+ (code "glTexSubImage3D")
+ ", "
+ (code "glCopyTexImage1D")
+ ", "
+ (code "glCopyTexImage2D")
+ ", "
+ (code "glCopyTexSubImage1D")
+ ", "
+ (code "glCopyTexSubImage2D")
+ ", and "
+ (code "glCopyTexSubImage3D")
+ ".
+ to map color indices,
+ stencil indices,
+ color components,
+ and depth components to other values. ")
+ (para "
+If a non-zero named buffer object is bound to the "
+ (code "GL_PIXEL_PACK_BUFFER")
+ " target
+ (see "
+ (code "glBindBuffer")
+ ") while a pixel map is
+ requested, "
+ (var "data")
+ " is treated as a byte offset into the buffer object's data store. ")
+ (para "
+Unsigned integer values,
+ if requested,
+ are linearly mapped from the internal fixed or floating-point representation
+ such that 1.0 maps to the largest representable integer value,
+ and 0.0 maps to 0.
+ Return unsigned integer values are undefined if the map value was
+ not in the range [0,1]. ")
+ (para "
+To determine the required size of "
+ (var "map")
+ ",
+ call "
+ (code "glGet")
+ " with the appropriate symbolic
+ constant. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "map")
+ " is not an accepted value. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a non-zero buffer object name is bound to the "
+ (code "GL_PIXEL_PACK_BUFFER")
+ " target and the buffer object's data store is currently mapped. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a non-zero buffer object name is bound to the "
+ (code "GL_PIXEL_PACK_BUFFER")
+ " target and the data would be packed to the buffer
+ object such that the memory writes required would exceed the data store size. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated by "
+ (code "glGetPixelMapfv")
+ " if a non-zero buffer object name is bound to the "
+ (code "GL_PIXEL_PACK_BUFFER")
+ " target and "
+ (var "data")
+ " is not evenly divisible
+ into the number of bytes needed to store in memory a GLfloat datum. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated by "
+ (code "glGetPixelMapuiv")
+ " if a non-zero buffer object name is bound to the "
+ (code "GL_PIXEL_PACK_BUFFER")
+ " target and "
+ (var "data")
+ " is not evenly divisible
+ into the number of bytes needed to store in memory a GLuint datum. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated by "
+ (code "glGetPixelMapusv")
+ " if a non-zero buffer object name is bound to the "
+ (code "GL_PIXEL_PACK_BUFFER")
+ " target and "
+ (var "data")
+ " is not evenly divisible
+ into the number of bytes needed to store in memory a GLushort datum. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glGetPixelMap")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glGetPointerv
+ "glGetPointerv"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glGetPointerv"))
+ (paramdef "GLenum " (parameter "pname"))
+ (paramdef "GLvoid ** " (parameter "params"))))
+ '(*fragment*
+ (heading
+ "return the address of the specified pointer")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "pname")))
+ (para "
+Specifies the array or buffer pointer to be returned.
+ Symbolic constants "
+ (code "GL_COLOR_ARRAY_POINTER")
+ ", "
+ (code "GL_EDGE_FLAG_ARRAY_POINTER")
+ ", "
+ (code "GL_FOG_COORD_ARRAY_POINTER")
+ ", "
+ (code "GL_FEEDBACK_BUFFER_POINTER")
+ ", "
+ (code "GL_INDEX_ARRAY_POINTER")
+ ", "
+ (code "GL_NORMAL_ARRAY_POINTER")
+ ", "
+ (code "GL_SECONDARY_COLOR_ARRAY_POINTER")
+ ", "
+ (code "GL_SELECTION_BUFFER_POINTER")
+ ", "
+ (code "GL_TEXTURE_COORD_ARRAY_POINTER")
+ ",
+ or "
+ (code "GL_VERTEX_ARRAY_POINTER")
+ "
+are accepted. "))
+ (entry (% (heading (var "params")))
+ (para "
+Returns the pointer value specified by "
+ (var "pname")
+ ". ")))
+ (heading "Description")
+ (para (code "glGetPointerv")
+ " returns pointer information. "
+ (var "pname")
+ " is a symbolic constant
+ indicating the pointer to be returned, and "
+ (var "params")
+ " is a pointer to a
+ location in which to place the returned data. ")
+ (para "
+For all "
+ (var "pname")
+ " arguments except "
+ (code "GL_FEEDBACK_BUFFER_POINTER")
+ " and "
+ (code "GL_SELECTION_BUFFER_POINTER")
+ ",
+ if a non-zero named buffer object was bound to the "
+ (code "GL_ARRAY_BUFFER")
+ " target
+ (see "
+ (code "glBindBuffer")
+ ") when the desired pointer was previously
+ specified, the pointer returned is a byte offset into the buffer object's data store.
+ Buffer objects are only available in OpenGL versions 1.5 and greater. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "pname")
+ " is not an accepted value. ")))
+
+(define-gl-procedure
+ glGetPolygonStipple
+ "glGetPolygonStipple"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "void "
+ (function "glGetPolygonStipple"))
+ (paramdef "GLubyte * " (parameter "pattern"))))
+ '(*fragment*
+ (heading "return the polygon stipple pattern")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "pattern")))
+ (para "
+Returns the stipple pattern. The initial value is all 1's. ")))
+ (heading "Description")
+ (para (code "glGetPolygonStipple")
+ " returns to "
+ (var "pattern")
+ " a "
+ (math "32" "×" "32")
+ "
+polygon stipple pattern.
+ The pattern is packed into memory as if "
+ (code "glReadPixels")
+ "
+with both "
+ (var "height")
+ " and "
+ (var "width")
+ " of 32, "
+ (var "type")
+ " of "
+ (code "GL_BITMAP")
+ ",
+ and "
+ (var "format")
+ " of "
+ (code "GL_COLOR_INDEX")
+ " were called,
+ and the stipple pattern were stored in an internal "
+ (math "32" "×" "32")
+ "
+color
+ index buffer.
+ Unlike "
+ (code "glReadPixels")
+ ",
+ however,
+ pixel transfer operations
+ (shift, offset, pixel map)
+ are not applied to the returned stipple image. ")
+ (para "
+If a non-zero named buffer object is bound to the "
+ (code "GL_PIXEL_PACK_BUFFER")
+ " target
+ (see "
+ (code "glBindBuffer")
+ ") while a polygon stipple pattern is
+ requested, "
+ (var "pattern")
+ " is treated as a byte offset into the buffer object's data store. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a non-zero buffer object name is bound to the "
+ (code "GL_PIXEL_PACK_BUFFER")
+ " target and the buffer object's data store is currently mapped. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a non-zero buffer object name is bound to the "
+ (code "GL_PIXEL_PACK_BUFFER")
+ " target and the data would be packed to the buffer
+ object such that the memory writes required would exceed the data store size. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glGetPolygonStipple")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glGetProgramInfoLog
+ "glGetProgramInfoLog"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "void "
+ (function "glGetProgramInfoLog"))
+ (paramdef "GLuint " (parameter "program"))
+ (paramdef "GLsizei " (parameter "maxLength"))
+ (paramdef "GLsizei *" (parameter "length"))
+ (paramdef "GLchar *" (parameter "infoLog"))))
+ '(*fragment*
+ (heading
+ "Returns the information log for a program object")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "program")))
+ (para "Specifies the program object whose information
+\t\t log is to be queried."))
+ (entry (% (heading (var "maxLength")))
+ (para "Specifies the size of the character buffer for
+\t\t storing the returned information log."))
+ (entry (% (heading (var "length")))
+ (para "Returns the length of the string returned in "
+ (var "infoLog")
+ " (excluding the null
+\t\t terminator)."))
+ (entry (% (heading (var "infoLog")))
+ (para "Specifies an array of characters that is used
+\t\t to return the information log.")))
+ (heading "Description")
+ (para (code "glGetProgramInfoLog")
+ " returns the
+\tinformation log for the specified program object. The
+\tinformation log for a program object is modified when the
+\tprogram object is linked or validated. The string that is
+\treturned will be null terminated.")
+ (para (code "glGetProgramInfoLog")
+ " returns in\t"
+ (var "infoLog")
+ " as much of the information log as
+\tit can, up to a maximum of "
+ (var "maxLength")
+ "
+characters. The number of characters actually returned,
+\texcluding the null termination character, is specified by\t"
+ (var "length")
+ ". If the length of the returned
+\tstring is not required, a value of "
+ (code "NULL")
+ " can
+\tbe passed in the "
+ (var "length")
+ " argument. The
+\tsize of the buffer required to store the returned information
+\tlog can be obtained by calling\t"
+ (code "glGetProgram")
+ "
+with the value "
+ (code "GL_INFO_LOG_LENGTH")
+ ". ")
+ (para "The information log for a program object is either an
+\tempty string, or a string containing information about the last
+\tlink operation, or a string containing information about the
+\tlast validation operation. It may contain diagnostic messages,
+\twarning messages, and other information. When a program object
+\tis created, its information log will be a string of length
+\t0.")
+ (heading "Errors")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if\t"
+ (var "program")
+ " is not a value generated by
+\tOpenGL.")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if\t"
+ (var "program")
+ " is not a program object.")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if\t"
+ (var "maxLength")
+ " is less than 0.")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if\t"
+ (code "glGetProgramInfoLog")
+ " is executed between the
+\texecution of\t"
+ (code "glBegin")
+ "
+and the corresponding execution of\t"
+ (code "glEnd")
+ ".")))
+
+(define-gl-procedure
+ glGetProgramiv
+ "glGetProgramiv"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glGetProgramiv"))
+ (paramdef "GLuint " (parameter "program"))
+ (paramdef "GLenum " (parameter "pname"))
+ (paramdef "GLint *" (parameter "params"))))
+ '(*fragment*
+ (heading
+ "Returns a parameter from a program object")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "program")))
+ (para "Specifies the program object to be
+\t\t queried."))
+ (entry (% (heading (var "pname")))
+ (para "Specifies the object parameter. Accepted
+\t\t symbolic names are "
+ (code "GL_DELETE_STATUS")
+ ", "
+ (code "GL_LINK_STATUS")
+ ", "
+ (code "GL_VALIDATE_STATUS")
+ ", "
+ (code "GL_INFO_LOG_LENGTH")
+ ", "
+ (code "GL_ATTACHED_SHADERS")
+ ", "
+ (code "GL_ACTIVE_ATTRIBUTES")
+ ", "
+ (code "GL_ACTIVE_ATTRIBUTE_MAX_LENGTH")
+ ", "
+ (code "GL_ACTIVE_UNIFORMS")
+ ", "
+ (code "GL_ACTIVE_UNIFORM_MAX_LENGTH")
+ "."))
+ (entry (% (heading (var "params")))
+ (para "Returns the requested object parameter.")))
+ (heading "Description")
+ (para (code "glGetProgram")
+ "
+returns in "
+ (var "params")
+ "
+the value of a parameter for a specific program object. The following parameters are defined:")
+ (table (% (formatter (asis)))
+ (entry (% (heading (code "GL_DELETE_STATUS")))
+ (para)
+ (para (var "params")
+ " returns "
+ (code "GL_TRUE")
+ " if "
+ (var "program")
+ " is currently flagged
+\t\t for deletion, and "
+ (code "GL_FALSE")
+ "
+otherwise."))
+ (entry (% (heading (code "GL_LINK_STATUS")))
+ (para)
+ (para (var "params")
+ " returns "
+ (code "GL_TRUE")
+ " if the last link
+\t\t operation on "
+ (var "program")
+ " was
+\t\t successful, and "
+ (code "GL_FALSE")
+ "
+otherwise."))
+ (entry (% (heading (code "GL_VALIDATE_STATUS")))
+ (para)
+ (para (var "params")
+ " returns "
+ (code "GL_TRUE")
+ " or if the last
+\t\t validation operation on "
+ (var "program")
+ " was successful, and "
+ (code "GL_FALSE")
+ "
+otherwise."))
+ (entry (% (heading (code "GL_INFO_LOG_LENGTH")))
+ (para)
+ (para (var "params")
+ " returns the
+\t\t number of characters in the information log for "
+ (var "program")
+ " including the null
+\t\t termination character (i.e., the size of the
+\t\t character buffer required to store the information
+\t\t log). If "
+ (var "program")
+ " has no
+\t\t information log, a value of 0 is
+\t\t returned."))
+ (entry (% (heading (code "GL_ATTACHED_SHADERS")))
+ (para)
+ (para (var "params")
+ " returns the
+\t\t number of shader objects attached to "
+ (var "program")
+ "."))
+ (entry (% (heading (code "GL_ACTIVE_ATTRIBUTES")))
+ (para)
+ (para (var "params")
+ " returns the
+\t\t number of active attribute variables for "
+ (var "program")
+ "."))
+ (entry (% (heading (code "GL_ACTIVE_ATTRIBUTE_MAX_LENGTH")))
+ (para)
+ (para (var "params")
+ " returns the
+\t\t length of the longest active attribute name for "
+ (var "program")
+ ", including the null
+\t\t termination character (i.e., the size of the
+\t\t character buffer required to store the longest
+\t\t attribute name). If no active attributes exist, 0 is
+\t\t returned."))
+ (entry (% (heading (code "GL_ACTIVE_UNIFORMS")))
+ (para)
+ (para (var "params")
+ " returns the
+\t\t number of active uniform variables for "
+ (var "program")
+ "."))
+ (entry (% (heading (code "GL_ACTIVE_UNIFORM_MAX_LENGTH")))
+ (para)
+ (para (var "params")
+ " returns the
+\t\t length of the longest active uniform variable name
+\t\t for "
+ (var "program")
+ ", including the
+\t\t null termination character (i.e., the size of the
+\t\t character buffer required to store the longest
+\t\t uniform variable name). If no active uniform
+\t\t variables exist, 0 is returned.")))
+ (heading "Errors")
+ (para (code "GL_INVALID_VALUE")
+ "
+is generated if "
+ (var "program")
+ "
+is not a value generated by OpenGL.")
+ (para (code "GL_INVALID_OPERATION")
+ "
+is generated if "
+ (var "program")
+ "
+does not refer to a program object.")
+ (para (code "GL_INVALID_ENUM")
+ "
+is generated if "
+ (var "pname")
+ "
+is not an accepted value.")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if\t"
+ (code "glGetProgram")
+ " is executed between the
+\texecution of\t"
+ (code "glBegin")
+ "
+and the corresponding execution of\t"
+ (code "glEnd")
+ ".")))
+
+(define-gl-procedure
+ glGetQueryiv
+ "glGetQueryiv"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glGetQueryiv"))
+ (paramdef "GLenum " (parameter "target"))
+ (paramdef "GLenum " (parameter "pname"))
+ (paramdef "GLint * " (parameter "params"))))
+ '(*fragment*
+ (heading
+ "return parameters of a query object target")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "target")))
+ (para "
+Specifies a query object target.
+ Must be "
+ (code "GL_SAMPLES_PASSED")
+ ". "))
+ (entry (% (heading (var "pname")))
+ (para "
+Specifies the symbolic name of a query object target parameter.
+ Accepted values are "
+ (code "GL_CURRENT_QUERY")
+ " or "
+ (code "GL_QUERY_COUNTER_BITS")
+ ". "))
+ (entry (% (heading (var "params")))
+ (para "
+Returns the requested data. ")))
+ (heading "Description")
+ (para (code "glGetQueryiv")
+ " returns in "
+ (var "params")
+ " a selected parameter of the query object target
+ specified by "
+ (var "target")
+ ". ")
+ (para (var "pname")
+ " names a specific query object target parameter. When "
+ (var "target")
+ " is "
+ (code "GL_SAMPLES_PASSED")
+ ", "
+ (var "pname")
+ " can be as follows: ")
+ (table (% (formatter (asis)))
+ (entry (% (heading (code "GL_CURRENT_QUERY")))
+ (para (var "params")
+ " returns the name of the currently active occlusion query object.
+ If no occlusion query is active, 0 is returned. The initial value is 0. "))
+ (entry (% (heading (code "GL_QUERY_COUNTER_BITS")))
+ (para (var "params")
+ " returns the number of bits in the query counter used to accumulate passing samples.
+ If the number of bits returned is 0, the implementation does not support a query counter, and the results
+ obtained from "
+ (code "glGetQueryObject")
+ " are useless. ")))
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "target")
+ " or "
+ (var "pname")
+ " is not an
+ accepted value. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glGetQueryiv")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glGetQueryObject
+ "glGetQueryObject"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glGetQueryObjectiv"))
+ (paramdef "GLuint " (parameter "id"))
+ (paramdef "GLenum " (parameter "pname"))
+ (paramdef "GLint * " (parameter "params"))))
+ '(*fragment*
+ (heading "return parameters of a query object")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "id")))
+ (para "
+Specifies the name of a query object. "))
+ (entry (% (heading (var "pname")))
+ (para "
+Specifies the symbolic name of a query object parameter.
+ Accepted values are "
+ (code "GL_QUERY_RESULT")
+ " or "
+ (code "GL_QUERY_RESULT_AVAILABLE")
+ ". "))
+ (entry (% (heading (var "params")))
+ (para "
+Returns the requested data. ")))
+ (heading "Description")
+ (para (code "glGetQueryObject")
+ " returns in "
+ (var "params")
+ " a selected parameter of the query object
+ specified by "
+ (var "id")
+ ". ")
+ (para (var "pname")
+ " names a specific query object parameter. "
+ (var "pname")
+ " can be as follows: ")
+ (table (% (formatter (asis)))
+ (entry (% (heading (code "GL_QUERY_RESULT")))
+ (para (var "params")
+ " returns the value of the query object's passed samples counter.
+ The initial value is 0. "))
+ (entry (% (heading (code "GL_QUERY_RESULT_AVAILABLE")))
+ (para (var "params")
+ " returns whether the passed samples counter is immediately available.
+ If a delay would occur waiting for the query result, "
+ (code "GL_FALSE")
+ " is returned.
+ Otherwise, "
+ (code "GL_TRUE")
+ " is returned, which also indicates that the results of all
+ previous queries are available as well. ")))
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "pname")
+ " is not an accepted value. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (var "id")
+ " is not the name of a query object. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (var "id")
+ " is the name of a currently active
+ query object. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glGetQueryObject")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glGetSeparableFilter
+ "glGetSeparableFilter"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "void "
+ (function "glGetSeparableFilter"))
+ (paramdef "GLenum " (parameter "target"))
+ (paramdef "GLenum " (parameter "format"))
+ (paramdef "GLenum " (parameter "type"))
+ (paramdef "GLvoid * " (parameter "row"))
+ (paramdef "GLvoid * " (parameter "column"))
+ (paramdef "GLvoid * " (parameter "span"))))
+ '(*fragment*
+ (heading
+ "get separable convolution filter kernel images")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "target")))
+ (para "
+The separable filter to be retrieved.
+ Must be "
+ (code "GL_SEPARABLE_2D")
+ ". "))
+ (entry (% (heading (var "format")))
+ (para "
+Format of the output images.
+ Must be one of "
+ (code "GL_RED")
+ ", "
+ (code "GL_GREEN")
+ ", "
+ (code "GL_BLUE")
+ ", "
+ (code "GL_ALPHA")
+ ", "
+ (code "GL_RGB")
+ ", "
+ (code "GL_BGR")
+ (code "GL_RGBA")
+ ", "
+ (code "GL_BGRA")
+ ", "
+ (code "GL_LUMINANCE")
+ ", or "
+ (code "GL_LUMINANCE_ALPHA")
+ ". "))
+ (entry (% (heading (var "type")))
+ (para "
+Data type of components in the output images.
+ Symbolic constants "
+ (code "GL_UNSIGNED_BYTE")
+ ", "
+ (code "GL_BYTE")
+ ", "
+ (code "GL_BITMAP")
+ ", "
+ (code "GL_UNSIGNED_SHORT")
+ ", "
+ (code "GL_SHORT")
+ ", "
+ (code "GL_UNSIGNED_INT")
+ ", "
+ (code "GL_INT")
+ ", "
+ (code "GL_FLOAT")
+ ", "
+ (code "GL_UNSIGNED_BYTE_3_3_2")
+ ", "
+ (code "GL_UNSIGNED_BYTE_2_3_3_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_6_5")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_6_5_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_4_4_4_4")
+ ", "
+ (code "GL_UNSIGNED_SHORT_4_4_4_4_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_5_5_1")
+ ", "
+ (code "GL_UNSIGNED_SHORT_1_5_5_5_REV")
+ ", "
+ (code "GL_UNSIGNED_INT_8_8_8_8")
+ ", "
+ (code "GL_UNSIGNED_INT_8_8_8_8_REV")
+ ", "
+ (code "GL_UNSIGNED_INT_10_10_10_2")
+ ", and "
+ (code "GL_UNSIGNED_INT_2_10_10_10_REV")
+ "
+are accepted. "))
+ (entry (% (heading (var "row")))
+ (para "
+Pointer to storage for the row filter image. "))
+ (entry (% (heading (var "column")))
+ (para "
+Pointer to storage for the column filter image. "))
+ (entry (% (heading (var "span")))
+ (para "
+Pointer to storage for the span filter image (currently unused). ")))
+ (heading "Description")
+ (para (code "glGetSeparableFilter")
+ " returns the two one-dimensional filter kernel images for the
+ current separable 2D convolution filter.
+ The row image is placed in "
+ (var "row")
+ " and the column image is placed in "
+ (var "column")
+ " according to the specifications in "
+ (var "format")
+ " and "
+ (var "type")
+ ".
+ (In the current implementation, "
+ (var "span")
+ " is not affected in any way.)
+ No pixel transfer operations are performed on the images, but the relevant
+ pixel storage modes are applied. ")
+ (para "
+If a non-zero named buffer object is bound to the "
+ (code "GL_PIXEL_PACK_BUFFER")
+ " target
+ (see "
+ (code "glBindBuffer")
+ ") while a separable convolution filter is
+ requested, "
+ (var "row")
+ ", "
+ (var "column")
+ ", and "
+ (var "span")
+ " are treated as a byte offset into the buffer object's data store. ")
+ (para "
+Color components that are present in "
+ (var "format")
+ " but not included in the
+ internal format of the filters are returned as zero.
+ The assignments of internal color components to the components of "
+ (var "format")
+ "
+are as follows: ")
+ (para)
+ (table (% (formatter (asis)))
+ (entry (% (heading (strong "Internal Component")))
+ (para (strong "Resulting Component")))
+ (entry (% (heading "
+Red ")) (para "
+Red "))
+ (entry (% (heading "
+Green ")) (para "
+Green "))
+ (entry (% (heading "
+Blue ")) (para "
+Blue "))
+ (entry (% (heading "
+Alpha ")) (para "
+Alpha "))
+ (entry (% (heading "
+Luminance "))
+ (para "
+Red "))
+ (entry (% (heading "
+Intensity "))
+ (para "
+Red ")))
+ (para)
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "target")
+ " is not "
+ (code "GL_SEPARABLE_2D")
+ ". ")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "format")
+ " is not one of the allowable
+ values. ")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "type")
+ " is not one of the allowable
+ values. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (var "type")
+ " is one of "
+ (code "GL_UNSIGNED_BYTE_3_3_2")
+ ", "
+ (code "GL_UNSIGNED_BYTE_2_3_3_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_6_5")
+ ", or "
+ (code "GL_UNSIGNED_SHORT_5_6_5_REV")
+ "
+and "
+ (var "format")
+ " is not "
+ (code "GL_RGB")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (var "type")
+ " is one of "
+ (code "GL_UNSIGNED_SHORT_4_4_4_4")
+ ", "
+ (code "GL_UNSIGNED_SHORT_4_4_4_4_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_5_5_1")
+ ", "
+ (code "GL_UNSIGNED_SHORT_1_5_5_5_REV")
+ ", "
+ (code "GL_UNSIGNED_INT_8_8_8_8")
+ ", "
+ (code "GL_UNSIGNED_INT_8_8_8_8_REV")
+ ", "
+ (code "GL_UNSIGNED_INT_10_10_10_2")
+ ", or "
+ (code "GL_UNSIGNED_INT_2_10_10_10_REV")
+ "
+and "
+ (var "format")
+ " is neither "
+ (code "GL_RGBA")
+ " nor "
+ (code "GL_BGRA")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a non-zero buffer object name is bound to the "
+ (code "GL_PIXEL_PACK_BUFFER")
+ " target and the buffer object's data store is currently mapped. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a non-zero buffer object name is bound to the "
+ (code "GL_PIXEL_PACK_BUFFER")
+ " target and the data would be packed to the buffer
+ object such that the memory writes required would exceed the data store size. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a non-zero buffer object name is bound to the "
+ (code "GL_PIXEL_PACK_BUFFER")
+ " target and "
+ (var "row")
+ " or "
+ (var "column")
+ " is not evenly divisible
+ into the number of bytes needed to store in memory a datum indicated by "
+ (var "type")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glGetSeparableFilter")
+ " is executed
+ between the execution of "
+ (code "glBegin")
+ " and the corresponding
+ execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glGetShaderInfoLog
+ "glGetShaderInfoLog"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glGetShaderInfoLog"))
+ (paramdef "GLuint " (parameter "shader"))
+ (paramdef "GLsizei " (parameter "maxLength"))
+ (paramdef "GLsizei *" (parameter "length"))
+ (paramdef "GLchar *" (parameter "infoLog"))))
+ '(*fragment*
+ (heading
+ "Returns the information log for a shader object")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "shader")))
+ (para "Specifies the shader object whose information
+\t\t log is to be queried."))
+ (entry (% (heading (var "maxLength")))
+ (para "Specifies the size of the character buffer for
+\t\t storing the returned information log."))
+ (entry (% (heading (var "length")))
+ (para "Returns the length of the string returned in "
+ (var "infoLog")
+ " (excluding the null
+\t\t terminator)."))
+ (entry (% (heading (var "infoLog")))
+ (para "Specifies an array of characters that is used
+\t\t to return the information log.")))
+ (heading "Description")
+ (para (code "glGetShaderInfoLog")
+ " returns the
+\tinformation log for the specified shader object. The information
+\tlog for a shader object is modified when the shader is compiled.
+\tThe string that is returned will be null terminated.")
+ (para (code "glGetShaderInfoLog")
+ " returns in\t"
+ (var "infoLog")
+ " as much of the information log as
+\tit can, up to a maximum of "
+ (var "maxLength")
+ "
+characters. The number of characters actually returned,
+\texcluding the null termination character, is specified by\t"
+ (var "length")
+ ". If the length of the returned
+\tstring is not required, a value of "
+ (code "NULL")
+ " can
+\tbe passed in the "
+ (var "length")
+ " argument. The
+\tsize of the buffer required to store the returned information
+\tlog can be obtained by calling\t"
+ (code "glGetShader")
+ "
+with the value "
+ (code "GL_INFO_LOG_LENGTH")
+ ".")
+ (para "The information log for a shader object is a string that
+\tmay contain diagnostic messages, warning messages, and other
+\tinformation about the last compile operation. When a shader
+\tobject is created, its information log will be a string of
+\tlength 0.")
+ (heading "Errors")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if\t"
+ (var "shader")
+ " is not a value generated by
+\tOpenGL.")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if\t"
+ (var "shader")
+ " is not a shader object.")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if\t"
+ (var "maxLength")
+ " is less than 0.")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if\t"
+ (code "glGetShaderInfoLog")
+ " is executed between the
+\texecution of\t"
+ (code "glBegin")
+ "
+and the corresponding execution of\t"
+ (code "glEnd")
+ ".")))
+
+(define-gl-procedure
+ glGetShaderSource
+ "glGetShaderSource"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glGetShaderSource"))
+ (paramdef "GLuint " (parameter "shader"))
+ (paramdef "GLsizei " (parameter "bufSize"))
+ (paramdef "GLsizei *" (parameter "length"))
+ (paramdef "GLchar *" (parameter "source"))))
+ '(*fragment*
+ (heading
+ "Returns the source code string from a shader object")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "shader")))
+ (para "Specifies the shader object to be
+\t\t queried."))
+ (entry (% (heading (var "bufSize")))
+ (para "Specifies the size of the character buffer for
+\t\t storing the returned source code string."))
+ (entry (% (heading (var "length")))
+ (para "Returns the length of the string returned in "
+ (var "source")
+ " (excluding the null
+\t\t terminator)."))
+ (entry (% (heading (var "source")))
+ (para "Specifies an array of characters that is used
+\t\t to return the source code string.")))
+ (heading "Description")
+ (para (code "glGetShaderSource")
+ " returns the
+\tconcatenation of the source code strings from the shader object
+\tspecified by "
+ (var "shader")
+ ". The source code
+\tstrings for a shader object are the result of a previous call to\t"
+ (code "glShaderSource")
+ ".
+\tThe string returned by the function will be null
+\tterminated.")
+ (para (code "glGetShaderSource")
+ " returns in\t"
+ (var "source")
+ " as much of the source code string
+\tas it can, up to a maximum of "
+ (var "bufSize")
+ "
+characters. The number of characters actually returned,
+\texcluding the null termination character, is specified by\t"
+ (var "length")
+ ". If the length of the returned
+\tstring is not required, a value of "
+ (code "NULL")
+ " can
+\tbe passed in the "
+ (var "length")
+ " argument. The
+\tsize of the buffer required to store the returned source code
+\tstring can be obtained by calling\t"
+ (code "glGetShader")
+ "
+with the value\t"
+ (code "GL_SHADER_SOURCE_LENGTH")
+ ".")
+ (heading "Errors")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if\t"
+ (var "shader")
+ " is not a value generated by
+\tOpenGL.")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if\t"
+ (var "shader")
+ " is not a shader object.")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if\t"
+ (var "bufSize")
+ " is less than 0.")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if\t"
+ (code "glGetShaderSource")
+ " is executed between the
+\texecution of\t"
+ (code "glBegin")
+ "
+and the corresponding execution of\t"
+ (code "glEnd")
+ ".")))
+
+(define-gl-procedure
+ glGetShaderiv
+ "glGetShaderiv"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glGetShaderiv"))
+ (paramdef "GLuint " (parameter "shader"))
+ (paramdef "GLenum " (parameter "pname"))
+ (paramdef "GLint *" (parameter "params"))))
+ '(*fragment*
+ (heading
+ "Returns a parameter from a shader object")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "shader")))
+ (para "Specifies the shader object to be
+\t\t queried."))
+ (entry (% (heading (var "pname")))
+ (para "Specifies the object parameter. Accepted
+\t\t symbolic names are "
+ (code "GL_SHADER_TYPE")
+ ", "
+ (code "GL_DELETE_STATUS")
+ ", "
+ (code "GL_COMPILE_STATUS")
+ ", "
+ (code "GL_INFO_LOG_LENGTH")
+ ", "
+ (code "GL_SHADER_SOURCE_LENGTH")
+ "."))
+ (entry (% (heading (var "params")))
+ (para "Returns the requested object parameter.")))
+ (heading "Description")
+ (para (code "glGetShader")
+ "
+returns in "
+ (var "params")
+ "
+the value of a parameter for a specific shader object. The
+\tfollowing parameters are defined:")
+ (table (% (formatter (asis)))
+ (entry (% (heading (code "GL_SHADER_TYPE")))
+ (para (var "params")
+ " returns "
+ (code "GL_VERTEX_SHADER")
+ " if "
+ (var "shader")
+ " is a vertex shader
+\t\t object, and "
+ (code "GL_FRAGMENT_SHADER")
+ "
+if "
+ (var "shader")
+ " is a fragment
+\t\t shader object."))
+ (entry (% (heading (code "GL_DELETE_STATUS")))
+ (para (var "params")
+ " returns "
+ (code "GL_TRUE")
+ " if "
+ (var "shader")
+ " is currently flagged
+\t\t for deletion, and "
+ (code "GL_FALSE")
+ "
+otherwise."))
+ (entry (% (heading (code "GL_COMPILE_STATUS")))
+ (para (var "params")
+ " returns "
+ (code "GL_TRUE")
+ " if the last compile
+\t\t operation on "
+ (var "shader")
+ " was
+\t\t successful, and "
+ (code "GL_FALSE")
+ "
+otherwise."))
+ (entry (% (heading (code "GL_INFO_LOG_LENGTH")))
+ (para (var "params")
+ " returns the
+\t\t number of characters in the information log for "
+ (var "shader")
+ " including the null
+\t\t termination character (i.e., the size of the
+\t\t character buffer required to store the information
+\t\t log). If "
+ (var "shader")
+ " has no
+\t\t information log, a value of 0 is returned."))
+ (entry (% (heading (code "GL_SHADER_SOURCE_LENGTH")))
+ (para (var "params")
+ " returns the
+\t\t length of the concatenation of the source strings
+\t\t that make up the shader source for the "
+ (var "shader")
+ ", including the null
+\t\t termination character. (i.e., the size of the
+\t\t character buffer required to store the shader
+\t\t source). If no source code exists, 0 is
+\t\t returned.")))
+ (heading "Errors")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if\t"
+ (var "shader")
+ " is not a value generated by
+\tOpenGL.")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if\t"
+ (var "shader")
+ " does not refer to a shader
+\tobject.")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if\t"
+ (var "pname")
+ " is not an accepted value.")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if\t"
+ (code "glGetShader")
+ " is executed between the
+\texecution of\t"
+ (code "glBegin")
+ "
+and the corresponding execution of\t"
+ (code "glEnd")
+ ".")))
+
+(define-gl-procedure
+ glGetString
+ "glGetString"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "const GLubyte* "
+ (function "glGetString"))
+ (paramdef "GLenum " (parameter "name"))))
+ '(*fragment*
+ (heading
+ "return a string describing the current GL connection")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "name")))
+ (para "
+Specifies a symbolic constant, one of "
+ (code "GL_VENDOR")
+ ", "
+ (code "GL_RENDERER")
+ ", "
+ (code "GL_VERSION")
+ ", "
+ (code "GL_SHADING_LANGUAGE_VERSION")
+ ", or "
+ (code "GL_EXTENSIONS")
+ ". ")))
+ (heading "Description")
+ (para (code "glGetString")
+ " returns a pointer to a static string
+ describing some aspect of the current GL connection. "
+ (var "name")
+ " can be one of the following: ")
+ (table (% (formatter (asis)))
+ (entry (% (heading (code "GL_VENDOR")))
+ (para)
+ (para "
+Returns the company responsible for this GL implementation.
+ This name does not change from release to release. "))
+ (entry (% (heading (code "GL_RENDERER")))
+ (para)
+ (para "
+Returns the name of the renderer.
+ This name is typically specific to a particular configuration of a hardware
+ platform.
+ It does not change from release to release. "))
+ (entry (% (heading (code "GL_VERSION")))
+ (para)
+ (para "
+Returns a version or release number. "))
+ (entry (% (heading (code "GL_SHADING_LANGUAGE_VERSION")))
+ (para)
+ (para "
+Returns a version or release number for the shading language. "))
+ (entry (% (heading (code "GL_EXTENSIONS")))
+ (para)
+ (para "
+Returns a space-separated list of supported extensions to GL. ")))
+ (para "
+Because the GL does not include queries for the performance
+ characteristics of an implementation, some applications are written to
+ recognize known platforms and modify their GL usage based on known
+ performance characteristics of these platforms.
+ Strings "
+ (code "GL_VENDOR")
+ " and "
+ (code "GL_RENDERER")
+ " together uniquely specify
+ a platform. They do not change from release to release and should be used
+ by platform-recognition algorithms. ")
+ (para "
+Some applications want to make use of features that
+ are not part of the standard GL. These features
+ may be implemented as extensions to the standard GL.
+ The "
+ (code "GL_EXTENSIONS")
+ " string is a space-separated
+ list of supported GL extensions.
+ (Extension names never contain a space character.) ")
+ (para "
+The "
+ (code "GL_VERSION")
+ " and "
+ (code "GL_SHADING_LANGUAGE_VERSION")
+ " strings begin with a version number.
+ The version number uses one
+ of these forms: ")
+ (para (var "major_number.minor_number")
+ (var "major_number.minor_number.release_number"))
+ (para "
+Vendor-specific information may follow the version
+ number. Its format depends on the implementation, but
+ a space always separates the version number and
+ the vendor-specific information. ")
+ (para "
+All strings are null-terminated. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "name")
+ " is not an accepted value. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glGetString")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glGetTexEnv
+ "glGetTexEnv"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glGetTexEnvfv"))
+ (paramdef "GLenum " (parameter "target"))
+ (paramdef "GLenum " (parameter "pname"))
+ (paramdef "GLfloat * " (parameter "params"))))
+ '(*fragment*
+ (heading "return texture environment parameters")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "target")))
+ (para "
+Specifies a texture environment. May be "
+ (code "GL_TEXTURE_ENV")
+ ", "
+ (code "GL_TEXTURE_FILTER_CONTROL")
+ ", or "
+ (code "GL_POINT_SPRITE")
+ ". "))
+ (entry (% (heading (var "pname")))
+ (para "
+Specifies the symbolic name of a texture environment parameter.
+ Accepted values are "
+ (code "GL_TEXTURE_ENV_MODE")
+ ", "
+ (code "GL_TEXTURE_ENV_COLOR")
+ ", "
+ (code "GL_TEXTURE_LOD_BIAS")
+ ", "
+ (code "GL_COMBINE_RGB")
+ ", "
+ (code "GL_COMBINE_ALPHA")
+ ", "
+ (code "GL_SRC0_RGB")
+ ", "
+ (code "GL_SRC1_RGB")
+ ", "
+ (code "GL_SRC2_RGB")
+ ", "
+ (code "GL_SRC0_ALPHA")
+ ", "
+ (code "GL_SRC1_ALPHA")
+ ", "
+ (code "GL_SRC2_ALPHA")
+ ", "
+ (code "GL_OPERAND0_RGB")
+ ", "
+ (code "GL_OPERAND1_RGB")
+ ", "
+ (code "GL_OPERAND2_RGB")
+ ", "
+ (code "GL_OPERAND0_ALPHA")
+ ", "
+ (code "GL_OPERAND1_ALPHA")
+ ", "
+ (code "GL_OPERAND2_ALPHA")
+ ", "
+ (code "GL_RGB_SCALE")
+ ", "
+ (code "GL_ALPHA_SCALE")
+ ", or "
+ (code "GL_COORD_REPLACE")
+ ". "))
+ (entry (% (heading (var "params")))
+ (para "
+Returns the requested data. ")))
+ (heading "Description")
+ (para (code "glGetTexEnv")
+ " returns in "
+ (var "params")
+ " selected values of a texture environment that
+ was specified with "
+ (code "glTexEnv")
+ ". "
+ (var "target")
+ " specifies a texture environment. ")
+ (para "
+When "
+ (var "target")
+ " is "
+ (code "GL_TEXTURE_FILTER_CONTROL")
+ ", "
+ (var "pname")
+ " must be "
+ (code "GL_TEXTURE_LOD_BIAS")
+ ".
+ When "
+ (var "target")
+ " is "
+ (code "GL_POINT_SPRITE")
+ ", "
+ (var "pname")
+ " must be "
+ (code "GL_COORD_REPLACE")
+ ".
+ When "
+ (var "target")
+ " is "
+ (code "GL_TEXTURE_ENV")
+ ", "
+ (var "pname")
+ " can be "
+ (code "GL_TEXTURE_ENV_MODE")
+ ", "
+ (code "GL_TEXTURE_ENV_COLOR")
+ ", "
+ (code "GL_COMBINE_RGB")
+ ", "
+ (code "GL_COMBINE_ALPHA")
+ ", "
+ (code "GL_RGB_SCALE")
+ ", "
+ (code "GL_ALPHA_SCALE")
+ ", "
+ (code "GL_SRC0_RGB")
+ ", "
+ (code "GL_SRC1_RGB")
+ ", "
+ (code "GL_SRC2_RGB")
+ ", "
+ (code "GL_SRC0_ALPHA")
+ ", "
+ (code "GL_SRC1_ALPHA")
+ ", or "
+ (code "GL_SRC2_ALPHA")
+ ". ")
+ (para (var "pname")
+ " names a specific texture environment parameter, as follows: ")
+ (table (% (formatter (asis)))
+ (entry (% (heading (code "GL_TEXTURE_ENV_MODE")))
+ (para (var "params")
+ " returns the single-valued texture environment mode,
+ a symbolic constant. The initial value is "
+ (code "GL_MODULATE")
+ ". "))
+ (entry (% (heading (code "GL_TEXTURE_ENV_COLOR")))
+ (para (var "params")
+ " returns four integer or floating-point values that are the
+ texture environment color.
+ Integer values,
+ when requested,
+ are linearly mapped from the internal floating-point representation
+ such that 1.0 maps to the most positive representable integer,
+ and "
+ (math "-1.0")
+ "
+maps to the most negative representable integer. The initial
+ value is (0, 0, 0, 0). "))
+ (entry (% (heading (code "GL_TEXTURE_LOD_BIAS")))
+ (para (var "params")
+ " returns a single floating-point value that is the texture
+ level-of-detail bias. The initial value is 0. "))
+ (entry (% (heading (code "GL_COMBINE_RGB")))
+ (para (var "params")
+ " returns a single symbolic constant value representing the current
+ RGB combine mode. The initial value is "
+ (code "GL_MODULATE")
+ ". "))
+ (entry (% (heading (code "GL_COMBINE_ALPHA")))
+ (para (var "params")
+ " returns a single symbolic constant value representing the current
+ alpha combine mode. The initial value is "
+ (code "GL_MODULATE")
+ ". "))
+ (entry (% (heading (code "GL_SRC0_RGB")))
+ (para (var "params")
+ " returns a single symbolic constant value representing the texture
+ combiner zero's RGB source. The initial value is "
+ (code "GL_TEXTURE")
+ ". "))
+ (entry (% (heading (code "GL_SRC1_RGB")))
+ (para (var "params")
+ " returns a single symbolic constant value representing the texture
+ combiner one's RGB source. The initial value is "
+ (code "GL_PREVIOUS")
+ ". "))
+ (entry (% (heading (code "GL_SRC2_RGB")))
+ (para (var "params")
+ " returns a single symbolic constant value representing the texture
+ combiner two's RGB source. The initial value is "
+ (code "GL_CONSTANT")
+ ". "))
+ (entry (% (heading (code "GL_SRC0_ALPHA")))
+ (para (var "params")
+ " returns a single symbolic constant value representing the texture
+ combiner zero's alpha source. The initial value is "
+ (code "GL_TEXTURE")
+ ". "))
+ (entry (% (heading (code "GL_SRC1_ALPHA")))
+ (para (var "params")
+ " returns a single symbolic constant value representing the texture
+ combiner one's alpha source. The initial value is "
+ (code "GL_PREVIOUS")
+ ". "))
+ (entry (% (heading (code "GL_SRC2_ALPHA")))
+ (para (var "params")
+ " returns a single symbolic constant value representing the texture
+ combiner two's alpha source. The initial value is "
+ (code "GL_CONSTANT")
+ ". "))
+ (entry (% (heading (code "GL_OPERAND0_RGB")))
+ (para (var "params")
+ " returns a single symbolic constant value representing the texture
+ combiner zero's RGB operand. The initial value is "
+ (code "GL_SRC_COLOR")
+ ". "))
+ (entry (% (heading (code "GL_OPERAND1_RGB")))
+ (para (var "params")
+ " returns a single symbolic constant value representing the texture
+ combiner one's RGB operand. The initial value is "
+ (code "GL_SRC_COLOR")
+ ". "))
+ (entry (% (heading (code "GL_OPERAND2_RGB")))
+ (para (var "params")
+ " returns a single symbolic constant value representing the texture
+ combiner two's RGB operand. The initial value is "
+ (code "GL_SRC_ALPHA")
+ ". "))
+ (entry (% (heading (code "GL_OPERAND0_ALPHA")))
+ (para (var "params")
+ " returns a single symbolic constant value representing the texture
+ combiner zero's alpha operand. The initial value is "
+ (code "GL_SRC_ALPHA")
+ ". "))
+ (entry (% (heading (code "GL_OPERAND1_ALPHA")))
+ (para (var "params")
+ " returns a single symbolic constant value representing the texture
+ combiner one's alpha operand. The initial value is "
+ (code "GL_SRC_ALPHA")
+ ". "))
+ (entry (% (heading (code "GL_OPERAND2_ALPHA")))
+ (para (var "params")
+ " returns a single symbolic constant value representing the texture
+ combiner two's alpha operand. The initial value is "
+ (code "GL_SRC_ALPHA")
+ ". "))
+ (entry (% (heading (code "GL_RGB_SCALE")))
+ (para (var "params")
+ " returns a single floating-point value representing the current RGB
+ texture combiner scaling factor. The initial value is 1.0. "))
+ (entry (% (heading (code "GL_ALPHA_SCALE")))
+ (para (var "params")
+ " returns a single floating-point value representing the current alpha
+ texture combiner scaling factor. The initial value is 1.0. "))
+ (entry (% (heading (code "GL_COORD_REPLACE")))
+ (para (var "params")
+ " returns a single boolean value representing the current point sprite
+ texture coordinate replacement enable state. The initial value is "
+ (code "GL_FALSE")
+ ". ")))
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "target")
+ " or "
+ (var "pname")
+ " is not an
+ accepted value. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glGetTexEnv")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glGetTexGen
+ "glGetTexGen"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glGetTexGendv"))
+ (paramdef "GLenum " (parameter "coord"))
+ (paramdef "GLenum " (parameter "pname"))
+ (paramdef "GLdouble * " (parameter "params"))))
+ '(*fragment*
+ (heading
+ "return texture coordinate generation parameters")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "coord")))
+ (para "
+Specifies a texture coordinate.
+ Must be "
+ (code "GL_S")
+ ", "
+ (code "GL_T")
+ ", "
+ (code "GL_R")
+ ", or "
+ (code "GL_Q")
+ ". "))
+ (entry (% (heading (var "pname")))
+ (para "
+Specifies the symbolic name of the value(s) to be returned.
+ Must be either "
+ (code "GL_TEXTURE_GEN_MODE")
+ "
+or the name of one of the texture generation plane equations: "
+ (code "GL_OBJECT_PLANE")
+ " or "
+ (code "GL_EYE_PLANE")
+ ". "))
+ (entry (% (heading (var "params")))
+ (para "
+Returns the requested data. ")))
+ (heading "Description")
+ (para (code "glGetTexGen")
+ " returns in "
+ (var "params")
+ " selected parameters of a texture coordinate
+ generation function that was specified using "
+ (code "glTexGen")
+ ". "
+ (var "coord")
+ " names one of the ("
+ (var "s")
+ ", "
+ (var "t")
+ ", "
+ (var "r")
+ ", "
+ (var "q")
+ ")
+ texture coordinates,
+ using the symbolic constant "
+ (code "GL_S")
+ ", "
+ (code "GL_T")
+ ", "
+ (code "GL_R")
+ ", or "
+ (code "GL_Q")
+ ". ")
+ (para (var "pname")
+ " specifies one of three symbolic names: ")
+ (table (% (formatter (asis)))
+ (entry (% (heading (code "GL_TEXTURE_GEN_MODE")))
+ (para (var "params")
+ " returns the single-valued texture generation function,
+ a symbolic constant. The initial value is "
+ (code "GL_EYE_LINEAR")
+ ". "))
+ (entry (% (heading (code "GL_OBJECT_PLANE")))
+ (para (var "params")
+ " returns the four plane equation coefficients that specify
+ object linear-coordinate generation.
+ Integer values, when requested,
+ are mapped directly from the internal floating-point representation. "))
+ (entry (% (heading (code "GL_EYE_PLANE")))
+ (para (var "params")
+ " returns the four plane equation coefficients that specify
+ eye linear-coordinate generation.
+ Integer values,
+ when requested,
+ are mapped directly from the internal floating-point representation.
+ The returned values are those maintained in eye coordinates.
+ They are not equal to the values specified using "
+ (code "glTexGen")
+ ",
+ unless the modelview matrix was identity when "
+ (code "glTexGen")
+ " was called. ")))
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "coord")
+ " or "
+ (var "pname")
+ " is not an
+ accepted value. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glGetTexGen")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glGetTexImage
+ "glGetTexImage"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glGetTexImage"))
+ (paramdef "GLenum " (parameter "target"))
+ (paramdef "GLint " (parameter "level"))
+ (paramdef "GLenum " (parameter "format"))
+ (paramdef "GLenum " (parameter "type"))
+ (paramdef "GLvoid * " (parameter "img"))))
+ '(*fragment*
+ (heading "return a texture image")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "target")))
+ (para "
+Specifies which texture is to be obtained. "
+ (code "GL_TEXTURE_1D")
+ ", "
+ (code "GL_TEXTURE_2D")
+ ", "
+ (code "GL_TEXTURE_3D")
+ ", "
+ (code "GL_TEXTURE_CUBE_MAP_POSITIVE_X")
+ ", "
+ (code "GL_TEXTURE_CUBE_MAP_NEGATIVE_X")
+ ", "
+ (code "GL_TEXTURE_CUBE_MAP_POSITIVE_Y")
+ ", "
+ (code "GL_TEXTURE_CUBE_MAP_NEGATIVE_Y")
+ ", "
+ (code "GL_TEXTURE_CUBE_MAP_POSITIVE_Z")
+ ", and "
+ (code "GL_TEXTURE_CUBE_MAP_NEGATIVE_Z")
+ " are accepted. "))
+ (entry (% (heading (var "level")))
+ (para "
+Specifies the level-of-detail number of the desired image.
+ Level 0 is the base image level.
+ Level "
+ (math (var "n"))
+ "
+is the "
+ (math (var "n"))
+ "th
+ mipmap reduction image. "))
+ (entry (% (heading (var "format")))
+ (para "
+Specifies a pixel format for the returned data.
+ The supported formats are "
+ (code "GL_RED")
+ ", "
+ (code "GL_GREEN")
+ ", "
+ (code "GL_BLUE")
+ ", "
+ (code "GL_ALPHA")
+ ", "
+ (code "GL_RGB")
+ ", "
+ (code "GL_BGR")
+ ", "
+ (code "GL_RGBA")
+ ", "
+ (code "GL_BGRA")
+ ", "
+ (code "GL_LUMINANCE")
+ ", and "
+ (code "GL_LUMINANCE_ALPHA")
+ ". "))
+ (entry (% (heading (var "type")))
+ (para "
+Specifies a pixel type for the returned data.
+ The supported types are "
+ (code "GL_UNSIGNED_BYTE")
+ ", "
+ (code "GL_BYTE")
+ ", "
+ (code "GL_UNSIGNED_SHORT")
+ ", "
+ (code "GL_SHORT")
+ ", "
+ (code "GL_UNSIGNED_INT")
+ ", "
+ (code "GL_INT")
+ ", "
+ (code "GL_FLOAT")
+ ", "
+ (code "GL_UNSIGNED_BYTE_3_3_2")
+ ", "
+ (code "GL_UNSIGNED_BYTE_2_3_3_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_6_5")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_6_5_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_4_4_4_4")
+ ", "
+ (code "GL_UNSIGNED_SHORT_4_4_4_4_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_5_5_1")
+ ", "
+ (code "GL_UNSIGNED_SHORT_1_5_5_5_REV")
+ ", "
+ (code "GL_UNSIGNED_INT_8_8_8_8")
+ ", "
+ (code "GL_UNSIGNED_INT_8_8_8_8_REV")
+ ", "
+ (code "GL_UNSIGNED_INT_10_10_10_2")
+ ", and "
+ (code "GL_UNSIGNED_INT_2_10_10_10_REV")
+ ". "))
+ (entry (% (heading (var "img")))
+ (para "
+Returns the texture image.
+ Should be a pointer to an array of the type specified by "
+ (var "type")
+ ". ")))
+ (heading "Description")
+ (para (code "glGetTexImage")
+ " returns a texture image into "
+ (var "img")
+ ". "
+ (var "target")
+ " specifies whether the desired texture image is one specified by "
+ (code "glTexImage1D")
+ " ("
+ (code "GL_TEXTURE_1D")
+ "), "
+ (code "glTexImage2D")
+ " ("
+ (code "GL_TEXTURE_2D")
+ " or any of "
+ (code "GL_TEXTURE_CUBE_MAP_*")
+ "),
+ or "
+ (code "glTexImage3D")
+ " ("
+ (code "GL_TEXTURE_3D")
+ "). "
+ (var "level")
+ " specifies the level-of-detail number of the desired image. "
+ (var "format")
+ " and "
+ (var "type")
+ " specify the format and type of the desired image array.
+ See the reference pages "
+ (code "glTexImage1D")
+ " and "
+ (code "glDrawPixels")
+ "
+for a description of the acceptable values for the "
+ (var "format")
+ " and "
+ (var "type")
+ "
+parameters, respectively. ")
+ (para "
+If a non-zero named buffer object is bound to the "
+ (code "GL_PIXEL_PACK_BUFFER")
+ " target
+ (see "
+ (code "glBindBuffer")
+ ") while a texture image is
+ requested, "
+ (var "img")
+ " is treated as a byte offset into the buffer object's data store. ")
+ (para "
+To understand the operation of "
+ (code "glGetTexImage")
+ ", consider the selected internal
+ four-component texture image to be an RGBA color buffer the size of the image.
+ The semantics of "
+ (code "glGetTexImage")
+ " are then identical to those of "
+ (code "glReadPixels")
+ ",
+ with the exception that no pixel transfer operations are performed,
+ when called with the same "
+ (var "format")
+ " and "
+ (var "type")
+ ",
+ with "
+ (var "x")
+ " and "
+ (var "y")
+ " set to 0, "
+ (var "width")
+ " set to the width of the texture image
+ (including border if one was specified),
+ and "
+ (var "height")
+ " set to 1 for 1D images,
+ or to the height of the texture image
+ (including border if one was specified)
+ for 2D images.
+ Because the internal texture image is an RGBA image,
+ pixel formats "
+ (code "GL_COLOR_INDEX")
+ ", "
+ (code "GL_STENCIL_INDEX")
+ ",
+ and "
+ (code "GL_DEPTH_COMPONENT")
+ " are not accepted,
+ and pixel type "
+ (code "GL_BITMAP")
+ " is not accepted. ")
+ (para "
+If the selected texture image does not contain four components,
+ the following mappings are applied.
+ Single-component textures are treated as RGBA buffers with red set
+ to the single-component value,
+ green set to 0, blue set to 0, and alpha set to 1.
+ Two-component textures are treated as RGBA buffers with red set to
+ the value of component zero,
+ alpha set to the value of component one,
+ and green and blue set to 0.
+ Finally,
+ three-component textures are treated as RGBA buffers with red set to
+ component zero,
+ green set to component one,
+ blue set to component two,
+ and alpha set to 1. ")
+ (para "
+To determine the required size of "
+ (var "img")
+ ",
+ use "
+ (code "glGetTexLevelParameter")
+ " to determine the dimensions of the
+ internal texture image,
+ then scale the required number of pixels by the storage required for
+ each pixel,
+ based on "
+ (var "format")
+ " and "
+ (var "type")
+ ".
+ Be sure to take the pixel storage parameters into account,
+ especially "
+ (code "GL_PACK_ALIGNMENT")
+ ". ")
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "target")
+ ", "
+ (var "format")
+ ", or "
+ (var "type")
+ " is not
+ an accepted value. ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "level")
+ " is less than 0. ")
+ (para (code "GL_INVALID_VALUE")
+ " may be generated if "
+ (var "level")
+ " is greater
+ than "
+ (math (var "log")
+ "_"
+ "2"
+ "\u2061"
+ "("
+ (var "max")
+ ","
+ ")")
+ ",
+ where "
+ (math (var "max"))
+ "
+is the returned value of "
+ (code "GL_MAX_TEXTURE_SIZE")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is returned if "
+ (var "type")
+ " is one of "
+ (code "GL_UNSIGNED_BYTE_3_3_2")
+ ", "
+ (code "GL_UNSIGNED_BYTE_2_3_3_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_6_5")
+ ", or "
+ (code "GL_UNSIGNED_SHORT_5_6_5_REV")
+ " and "
+ (var "format")
+ " is not "
+ (code "GL_RGB")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is returned if "
+ (var "type")
+ " is one of "
+ (code "GL_UNSIGNED_SHORT_4_4_4_4")
+ ", "
+ (code "GL_UNSIGNED_SHORT_4_4_4_4_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_5_5_1")
+ ", "
+ (code "GL_UNSIGNED_SHORT_1_5_5_5_REV")
+ ", "
+ (code "GL_UNSIGNED_INT_8_8_8_8")
+ ", "
+ (code "GL_UNSIGNED_INT_8_8_8_8_REV")
+ ", "
+ (code "GL_UNSIGNED_INT_10_10_10_2")
+ ", or "
+ (code "GL_UNSIGNED_INT_2_10_10_10_REV")
+ ", and "
+ (var "format")
+ " is neither "
+ (code "GL_RGBA")
+ "
+or "
+ (code "GL_BGRA")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a non-zero buffer object name is bound to the "
+ (code "GL_PIXEL_PACK_BUFFER")
+ " target and the buffer object's data store is currently mapped. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a non-zero buffer object name is bound to the "
+ (code "GL_PIXEL_PACK_BUFFER")
+ " target and the data would be packed to the buffer
+ object such that the memory writes required would exceed the data store size. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a non-zero buffer object name is bound to the "
+ (code "GL_PIXEL_PACK_BUFFER")
+ " target and "
+ (var "img")
+ " is not evenly divisible
+ into the number of bytes needed to store in memory a datum indicated by "
+ (var "type")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glGetTexImage")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glGetTexLevelParameter
+ "glGetTexLevelParameter"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "void "
+ (function "glGetTexLevelParameterfv"))
+ (paramdef "GLenum " (parameter "target"))
+ (paramdef "GLint " (parameter "level"))
+ (paramdef "GLenum " (parameter "pname"))
+ (paramdef "GLfloat * " (parameter "params"))))
+ '(*fragment*
+ (heading
+ "return texture parameter values for a specific level of detail")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "target")))
+ (para "
+Specifies the symbolic name of the target texture,
+ either "
+ (code "GL_TEXTURE_1D")
+ ", "
+ (code "GL_TEXTURE_2D")
+ ", "
+ (code "GL_TEXTURE_3D")
+ ", "
+ (code "GL_PROXY_TEXTURE_1D")
+ ", "
+ (code "GL_PROXY_TEXTURE_2D")
+ ", "
+ (code "GL_PROXY_TEXTURE_3D")
+ ", "
+ (code "GL_TEXTURE_CUBE_MAP_POSITIVE_X")
+ ", "
+ (code "GL_TEXTURE_CUBE_MAP_NEGATIVE_X")
+ ", "
+ (code "GL_TEXTURE_CUBE_MAP_POSITIVE_Y")
+ ", "
+ (code "GL_TEXTURE_CUBE_MAP_NEGATIVE_Y")
+ ", "
+ (code "GL_TEXTURE_CUBE_MAP_POSITIVE_Z")
+ ", "
+ (code "GL_TEXTURE_CUBE_MAP_NEGATIVE_Z")
+ ", or "
+ (code "GL_PROXY_TEXTURE_CUBE_MAP")
+ ". "))
+ (entry (% (heading (var "level")))
+ (para "
+Specifies the level-of-detail number of the desired image.
+ Level 0 is the base image level.
+ Level "
+ (math (var "n"))
+ "
+is the "
+ (math (var "n"))
+ "th
+ mipmap reduction image. "))
+ (entry (% (heading (var "pname")))
+ (para "
+Specifies the symbolic name of a texture parameter. "
+ (code "GL_TEXTURE_WIDTH")
+ ", "
+ (code "GL_TEXTURE_HEIGHT")
+ ", "
+ (code "GL_TEXTURE_DEPTH")
+ ", "
+ (code "GL_TEXTURE_INTERNAL_FORMAT")
+ ", "
+ (code "GL_TEXTURE_BORDER")
+ ", "
+ (code "GL_TEXTURE_RED_SIZE")
+ ", "
+ (code "GL_TEXTURE_GREEN_SIZE")
+ ", "
+ (code "GL_TEXTURE_BLUE_SIZE")
+ ", "
+ (code "GL_TEXTURE_ALPHA_SIZE")
+ ", "
+ (code "GL_TEXTURE_LUMINANCE_SIZE")
+ ", "
+ (code "GL_TEXTURE_INTENSITY_SIZE")
+ ", "
+ (code "GL_TEXTURE_DEPTH_SIZE")
+ ", "
+ (code "GL_TEXTURE_COMPRESSED")
+ ", and "
+ (code "GL_TEXTURE_COMPRESSED_IMAGE_SIZE")
+ "
+are accepted. "))
+ (entry (% (heading (var "params")))
+ (para "
+Returns the requested data. ")))
+ (heading "Description")
+ (para (code "glGetTexLevelParameter")
+ " returns in "
+ (var "params")
+ " texture parameter values for a specific
+ level-of-detail value,
+ specified as "
+ (var "level")
+ ". "
+ (var "target")
+ " defines the target texture,
+ either "
+ (code "GL_TEXTURE_1D")
+ ", "
+ (code "GL_TEXTURE_2D")
+ ", "
+ (code "GL_TEXTURE_3D")
+ ", "
+ (code "GL_PROXY_TEXTURE_1D")
+ ", "
+ (code "GL_PROXY_TEXTURE_2D")
+ ", "
+ (code "GL_PROXY_TEXTURE_3D")
+ ", "
+ (code "GL_TEXTURE_CUBE_MAP_POSITIVE_X")
+ ", "
+ (code "GL_TEXTURE_CUBE_MAP_NEGATIVE_X")
+ ", "
+ (code "GL_TEXTURE_CUBE_MAP_POSITIVE_Y")
+ ", "
+ (code "GL_TEXTURE_CUBE_MAP_NEGATIVE_Y")
+ ", "
+ (code "GL_TEXTURE_CUBE_MAP_POSITIVE_Z")
+ ", "
+ (code "GL_TEXTURE_CUBE_MAP_NEGATIVE_Z")
+ ", or "
+ (code "GL_PROXY_TEXTURE_CUBE_MAP")
+ ". ")
+ (para (code "GL_MAX_TEXTURE_SIZE")
+ ", and "
+ (code "GL_MAX_3D_TEXTURE_SIZE")
+ " are not really
+ descriptive enough.
+ It has to report the largest square texture image that can be
+ accommodated with mipmaps and borders,
+ but a long skinny texture, or a texture without mipmaps and borders, may
+ easily fit in texture memory.
+ The proxy targets allow the user to more accurately query
+ whether the GL can accommodate a texture of a given configuration.
+ If the texture cannot be accommodated, the texture state variables, which
+ may be queried with "
+ (code "glGetTexLevelParameter")
+ ", are set to 0. If the texture can be accommodated,
+ the texture state values will be set as they would be set for a
+ non-proxy target. ")
+ (para (var "pname")
+ " specifies the texture parameter whose value or values
+ will be returned. ")
+ (para "
+The accepted parameter names are as follows: ")
+ (table (% (formatter (asis)))
+ (entry (% (heading (code "GL_TEXTURE_WIDTH")))
+ (para)
+ (para (var "params")
+ " returns a single value,
+ the width of the texture image.
+ This value includes the border of the texture image. The initial value is
+ 0. "))
+ (entry (% (heading (code "GL_TEXTURE_HEIGHT")))
+ (para)
+ (para (var "params")
+ " returns a single value,
+ the height of the texture image.
+ This value includes the border of the texture image. The initial value is
+ 0. "))
+ (entry (% (heading (code "GL_TEXTURE_DEPTH")))
+ (para)
+ (para (var "params")
+ " returns a single value,
+ the depth of the texture image.
+ This value includes the border of the texture image. The initial value is
+ 0. "))
+ (entry (% (heading (code "GL_TEXTURE_INTERNAL_FORMAT")))
+ (para)
+ (para (var "params")
+ " returns a single value,
+ the internal format of the texture image. "))
+ (entry (% (heading (code "GL_TEXTURE_BORDER")))
+ (para)
+ (para (var "params")
+ " returns a single value,
+ the width in pixels of the border of the texture image. The initial value
+ is 0. "))
+ (entry (% (heading (code "GL_TEXTURE_RED_SIZE") ",")))
+ (entry (% (heading (code "GL_TEXTURE_GREEN_SIZE") ",")))
+ (entry (% (heading (code "GL_TEXTURE_BLUE_SIZE") ",")))
+ (entry (% (heading (code "GL_TEXTURE_ALPHA_SIZE") ",")))
+ (entry (% (heading (code "GL_TEXTURE_LUMINANCE_SIZE") ",")))
+ (entry (% (heading (code "GL_TEXTURE_INTENSITY_SIZE") ",")))
+ (entry (% (heading (code "GL_TEXTURE_DEPTH_SIZE")))
+ (para)
+ (para "
+The internal storage resolution of an individual component.
+ The resolution chosen by the GL will be a close match for the resolution
+ requested by the user with the component argument of "
+ (code "glTexImage1D")
+ ", "
+ (code "glTexImage2D")
+ ", "
+ (code "glTexImage3D")
+ ", "
+ (code "glCopyTexImage1D")
+ ", and "
+ (code "glCopyTexImage2D")
+ ". The initial value is 0. "))
+ (entry (% (heading (code "GL_TEXTURE_COMPRESSED")))
+ (para)
+ (para (var "params")
+ " returns a single boolean value indicating if the texture image is
+ stored in a compressed internal format. The initiali value is "
+ (code "GL_FALSE")
+ ". "))
+ (entry (% (heading
+ (code "GL_TEXTURE_COMPRESSED_IMAGE_SIZE")))
+ (para)
+ (para (var "params")
+ " returns a single integer value, the number of unsigned bytes of the
+ compressed texture image that would be returned from "
+ (code "glGetCompressedTexImage")
+ ". ")))
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "target")
+ " or "
+ (var "pname")
+ " is not an
+ accepted value. ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "level")
+ " is less than 0. ")
+ (para (code "GL_INVALID_VALUE")
+ " may be generated if "
+ (var "level")
+ " is greater
+ than "
+ (math (var "log") "_" "2")
+ (var "max")
+ ",
+ where "
+ (var "max")
+ " is the returned value of "
+ (code "GL_MAX_TEXTURE_SIZE")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glGetTexLevelParameter")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "GL_TEXTURE_COMPRESSED_IMAGE_SIZE")
+ " is queried on texture images with an
+ uncompressed internal format or on proxy targets. ")))
+
+(define-gl-procedure
+ glGetTexParameter
+ "glGetTexParameter"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "void "
+ (function "glGetTexParameterfv"))
+ (paramdef "GLenum " (parameter "target"))
+ (paramdef "GLenum " (parameter "pname"))
+ (paramdef "GLfloat * " (parameter "params"))))
+ '(*fragment*
+ (heading "return texture parameter values")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "target")))
+ (para "
+Specifies the symbolic name of the target texture. "
+ (code "GL_TEXTURE_1D")
+ ", "
+ (code "GL_TEXTURE_2D")
+ ", "
+ (code "GL_TEXTURE_3D")
+ ", and "
+ (code "GL_TEXTURE_CUBE_MAP")
+ "
+are accepted. "))
+ (entry (% (heading (var "pname")))
+ (para "
+Specifies the symbolic name of a texture parameter. "
+ (code "GL_TEXTURE_MAG_FILTER")
+ ", "
+ (code "GL_TEXTURE_MIN_FILTER")
+ ", "
+ (code "GL_TEXTURE_MIN_LOD")
+ ", "
+ (code "GL_TEXTURE_MAX_LOD")
+ ", "
+ (code "GL_TEXTURE_BASE_LEVEL")
+ ", "
+ (code "GL_TEXTURE_MAX_LEVEL")
+ ", "
+ (code "GL_TEXTURE_WRAP_S")
+ ", "
+ (code "GL_TEXTURE_WRAP_T")
+ ", "
+ (code "GL_TEXTURE_WRAP_R")
+ ", "
+ (code "GL_TEXTURE_BORDER_COLOR")
+ ", "
+ (code "GL_TEXTURE_PRIORITY")
+ ", "
+ (code "GL_TEXTURE_RESIDENT")
+ ", "
+ (code "GL_TEXTURE_COMPARE_MODE")
+ ", "
+ (code "GL_TEXTURE_COMPARE_FUNC")
+ ", "
+ (code "GL_DEPTH_TEXTURE_MODE")
+ ", and "
+ (code "GL_GENERATE_MIPMAP")
+ "
+are accepted. "))
+ (entry (% (heading (var "params")))
+ (para "
+Returns the texture parameters. ")))
+ (heading "Description")
+ (para (code "glGetTexParameter")
+ " returns in "
+ (var "params")
+ " the value or values of the texture parameter
+ specified as "
+ (var "pname")
+ ". "
+ (var "target")
+ " defines the target texture,
+ either "
+ (code "GL_TEXTURE_1D")
+ ", "
+ (code "GL_TEXTURE_2D")
+ ", "
+ (code "GL_TEXTURE_3D")
+ ", or "
+ (code "GL_TEXTURE_CUBE_MAP")
+ ",
+ to specify one-, two-, or three-dimensional or cube-mapped texturing. "
+ (var "pname")
+ " accepts the same symbols as "
+ (code "glTexParameter")
+ ",
+ with the same interpretations: ")
+ (table (% (formatter (asis)))
+ (entry (% (heading (code "GL_TEXTURE_MAG_FILTER")))
+ (para "
+Returns the single-valued texture magnification filter,
+ a symbolic constant. The initial value is "
+ (code "GL_LINEAR")
+ ". "))
+ (entry (% (heading (code "GL_TEXTURE_MIN_FILTER")))
+ (para "
+Returns the single-valued texture minification filter,
+ a symbolic constant. The initial value is "
+ (code "GL_NEAREST_MIPMAP_LINEAR")
+ ". "))
+ (entry (% (heading (code "GL_TEXTURE_MIN_LOD")))
+ (para "
+Returns the single-valued texture minimum level-of-detail value. The
+ initial value is "
+ (math "-1000")
+ ". "))
+ (entry (% (heading (code "GL_TEXTURE_MAX_LOD")))
+ (para "
+Returns the single-valued texture maximum level-of-detail value. The
+ initial value is 1000. "))
+ (entry (% (heading (code "GL_TEXTURE_BASE_LEVEL")))
+ (para "
+Returns the single-valued base texture mipmap level. The initial value is 0. "))
+ (entry (% (heading (code "GL_TEXTURE_MAX_LEVEL")))
+ (para "
+Returns the single-valued maximum texture mipmap array level. The initial
+ value is 1000. "))
+ (entry (% (heading (code "GL_TEXTURE_WRAP_S")))
+ (para "
+Returns the single-valued wrapping function for texture coordinate "
+ (math (var "s"))
+ ",
+ a symbolic constant. The initial value is "
+ (code "GL_REPEAT")
+ ". "))
+ (entry (% (heading (code "GL_TEXTURE_WRAP_T")))
+ (para "
+Returns the single-valued wrapping function for texture coordinate "
+ (math (var "t"))
+ ",
+ a symbolic constant. The initial value is "
+ (code "GL_REPEAT")
+ ". "))
+ (entry (% (heading (code "GL_TEXTURE_WRAP_R")))
+ (para "
+Returns the single-valued wrapping function for texture coordinate "
+ (math (var "r"))
+ ",
+ a symbolic constant. The initial value is "
+ (code "GL_REPEAT")
+ ". "))
+ (entry (% (heading (code "GL_TEXTURE_BORDER_COLOR")))
+ (para "
+Returns four integer or floating-point numbers that comprise the RGBA color
+ of the texture border.
+ Floating-point values are returned in the range "
+ (math "[" "0" "," "1" "]")
+ ".
+ Integer values are returned as a linear mapping of the internal floating-point
+ representation such that 1.0 maps to the most positive representable
+ integer and "
+ (math "-1.0")
+ "
+maps to the most negative representable
+ integer. The initial value is (0, 0, 0, 0). "))
+ (entry (% (heading (code "GL_TEXTURE_PRIORITY")))
+ (para "
+Returns the residence priority of the target texture (or the named
+ texture bound to it). The initial value is 1.
+ See "
+ (code "glPrioritizeTextures")
+ ". "))
+ (entry (% (heading (code "GL_TEXTURE_RESIDENT")))
+ (para "
+Returns the residence status of the target texture.
+ If the value returned in "
+ (var "params")
+ " is "
+ (code "GL_TRUE")
+ ", the texture is
+ resident in texture memory.
+ See "
+ (code "glAreTexturesResident")
+ ". "))
+ (entry (% (heading (code "GL_TEXTURE_COMPARE_MODE")))
+ (para "
+Returns a single-valued texture comparison mode, a symbolic constant. The
+ initial value is "
+ (code "GL_NONE")
+ ". See "
+ (code "glTexParameter")
+ ". "))
+ (entry (% (heading (code "GL_TEXTURE_COMPARE_FUNC")))
+ (para "
+Returns a single-valued texture comparison function, a symbolic constant. The
+ initial value is "
+ (code "GL_LEQUAL")
+ ". See "
+ (code "glTexParameter")
+ ". "))
+ (entry (% (heading (code "GL_DEPTH_TEXTURE_MODE")))
+ (para "
+Returns a single-valued texture format indicating how the depth values
+ should be converted into color components. The initial value is "
+ (code "GL_LUMINANCE")
+ ". See "
+ (code "glTexParameter")
+ ". "))
+ (entry (% (heading (code "GL_GENERATE_MIPMAP")))
+ (para "
+Returns a single boolean value indicating if automatic mipmap level updates
+ are enabled.
+ See "
+ (code "glTexParameter")
+ ". ")))
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "target")
+ " or "
+ (var "pname")
+ " is not an
+ accepted value. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glGetTexParameter")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glGetUniformLocation
+ "glGetUniformLocation"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "GLint "
+ (function "glGetUniformLocation"))
+ (paramdef "GLuint " (parameter "program"))
+ (paramdef "const GLchar *" (parameter "name"))))
+ '(*fragment*
+ (heading
+ "Returns the location of a uniform variable")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "program")))
+ (para "Specifies the program object to be
+\t\t queried."))
+ (entry (% (heading (var "name")))
+ (para "Points to a null terminated string containing
+\t\t the name of the uniform variable whose location is
+\t\t to be queried.")))
+ (heading "Description")
+ (para (code "glGetUniformLocation ")
+ " returns an
+\tinteger that represents the location of a specific uniform
+\tvariable within a program object. "
+ (var "name")
+ "
+must be a null terminated string that contains no white space.\t"
+ (var "name")
+ " must be an active uniform variable
+\tname in "
+ (var "program")
+ " that is not a structure,
+\tan array of structures, or a subcomponent of a vector or a
+\tmatrix. This function returns -1 if "
+ (var "name")
+ "
+does not correspond to an active uniform variable in\t"
+ (var "program")
+ " or if "
+ (var "name")
+ "
+starts with the reserved prefix \"gl_\".")
+ (para "Uniform variables that are structures or arrays of
+\tstructures may be queried by calling\t"
+ (code "glGetUniformLocation")
+ " for each field within
+\tthe structure. The array element operator \"[]\" and the
+\tstructure field operator \".\" may be used in\t"
+ (var "name")
+ " in order to select elements within
+\tan array or fields within a structure. The result of using these
+\toperators is not allowed to be another structure, an array of
+\tstructures, or a subcomponent of a vector or a matrix. Except if
+\tthe last part of "
+ (var "name")
+ " indicates a uniform
+\tvariable array, the location of the first element of an array
+\tcan be retrieved by using the name of the array, or by using the
+\tname appended by \"[0]\".")
+ (para "The actual locations assigned to uniform variables are not
+\tknown until the program object is linked successfully. After
+\tlinking has occurred, the command\t"
+ (code "glGetUniformLocation")
+ " can be used to obtain
+\tthe location of a uniform variable. This location value can then
+\tbe passed to\t"
+ (code "glUniform")
+ "
+to set the value of the uniform variable or to\t"
+ (code "glGetUniform")
+ "
+in order to query the current value of the uniform variable.
+\tAfter a program object has been linked successfully, the index
+\tvalues for uniform variables remain fixed until the next link
+\tcommand occurs. Uniform variable locations and values can only
+\tbe queried after a link if the link was successful.")
+ (heading "Errors")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if\t"
+ (var "program")
+ " is not a value generated by
+\tOpenGL.")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if\t"
+ (var "program")
+ " is not a program object.")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if\t"
+ (var "program")
+ " has not been successfully
+\tlinked.")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if\t"
+ (code "glGetUniformLocation")
+ " is executed between
+\tthe execution of\t"
+ (code "glBegin")
+ "
+and the corresponding execution of\t"
+ (code "glEnd")
+ ".")))
+
+(define-gl-procedure
+ glGetUniformfv
+ "glGetUniformfv"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glGetUniformfv"))
+ (paramdef "GLuint " (parameter "program"))
+ (paramdef "GLint " (parameter "location"))
+ (paramdef "GLfloat *" (parameter "params")))
+ (funcprototype
+ (funcdef "void " (function "glGetUniformiv"))
+ (paramdef "GLuint " (parameter "program"))
+ (paramdef "GLint " (parameter "location"))
+ (paramdef "GLint *" (parameter "params"))))
+ '(*fragment*
+ (heading
+ "Returns the value of a uniform variable")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "program")))
+ (para "Specifies the program object to be
+\t\t queried."))
+ (entry (% (heading (var "location")))
+ (para "Specifies the location of the uniform variable
+\t\t to be queried."))
+ (entry (% (heading (var "params")))
+ (para "Returns the value of the specified uniform
+\t\t variable.")))
+ (heading "Description")
+ (para (code "glGetUniform")
+ " returns in\t"
+ (var "params")
+ " the value(s) of the specified
+\tuniform variable. The type of the uniform variable specified by\t"
+ (var "location")
+ " determines the number of values
+\treturned. If the uniform variable is defined in the shader as a
+\tboolean, int, or float, a single value will be returned. If it
+\tis defined as a vec2, ivec2, or bvec2, two values will be
+\treturned. If it is defined as a vec3, ivec3, or bvec3, three
+\tvalues will be returned, and so on. To query values stored in
+\tuniform variables declared as arrays, call\t"
+ (code "glGetUniform")
+ " for each element of the array.
+\tTo query values stored in uniform variables declared as
+\tstructures, call "
+ (code "glGetUniform")
+ " for each
+\tfield in the structure. The values for uniform variables
+\tdeclared as a matrix will be returned in column major
+\torder.")
+ (para "The locations assigned to uniform variables are not known
+\tuntil the program object is linked. After linking has occurred,
+\tthe command\t"
+ (code "glGetUniformLocation")
+ "
+can be used to obtain the location of a uniform variable. This
+\tlocation value can then be passed to\t"
+ (code "glGetUniform")
+ " in order to query the current
+\tvalue of the uniform variable. After a program object has been
+\tlinked successfully, the index values for uniform variables
+\tremain fixed until the next link command occurs. The uniform
+\tvariable values can only be queried after a link if the link was
+\tsuccessful.")
+ (heading "Errors")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if\t"
+ (var "program")
+ " is not a value generated by
+\tOpenGL.")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if\t"
+ (var "program")
+ " is not a program object.")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if\t"
+ (var "program")
+ " has not been successfully
+\tlinked.")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if\t"
+ (var "location")
+ " does not correspond to a valid
+\tuniform variable location for the specified program object.")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if\t"
+ (code "glGetUniform")
+ " is executed between the
+\texecution of\t"
+ (code "glBegin")
+ "
+and the corresponding execution of\t"
+ (code "glEnd")
+ ".")))
+
+(define-gl-procedure
+ glGetVertexAttribPointerv
+ "glGetVertexAttribPointerv"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "void "
+ (function "glGetVertexAttribPointerv"))
+ (paramdef "GLuint " (parameter "index"))
+ (paramdef "GLenum " (parameter "pname"))
+ (paramdef "GLvoid **" (parameter "pointer"))))
+ '(*fragment*
+ (heading
+ "return the address of the specified generic vertex attribute pointer")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "index")))
+ (para "Specifies the generic vertex attribute
+\t\t parameter to be returned."))
+ (entry (% (heading (var "pname")))
+ (para "Specifies the symbolic name of the generic
+\t\t vertex attribute parameter to be returned. Must be "
+ (code "GL_VERTEX_ATTRIB_ARRAY_POINTER")
+ "."))
+ (entry (% (heading (var "pointer")))
+ (para "Returns the pointer value.")))
+ (heading "Description")
+ (para (code "glGetVertexAttribPointerv")
+ " returns
+\tpointer information. "
+ (var "index")
+ " is the generic
+\tvertex attribute to be queried, "
+ (var "pname")
+ " is
+\ta symbolic constant indicating the pointer to be returned, and\t"
+ (var "params")
+ " is a pointer to a location in
+\twhich to place the returned data.")
+ (para "If a non-zero named buffer object was bound to the "
+ (code "GL_ARRAY_BUFFER")
+ " target
+ (see "
+ (code "glBindBuffer")
+ ") when the desired pointer was previously
+ specified, the "
+ (var "pointer")
+ " returned is a byte offset into the buffer object's data store. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_VALUE")
+ "
+is generated if "
+ (var "index")
+ "
+is greater than or equal to "
+ (code "GL_MAX_VERTEX_ATTRIBS")
+ ".")
+ (para (code "GL_INVALID_ENUM")
+ "
+is generated if "
+ (var "pname")
+ "
+is not an accepted value.")))
+
+(define-gl-procedure
+ glGetVertexAttribdv
+ "glGetVertexAttribdv"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "void "
+ (function "glGetVertexAttribdv"))
+ (paramdef "GLuint " (parameter "index"))
+ (paramdef "GLenum " (parameter "pname"))
+ (paramdef "GLdouble *" (parameter "params")))
+ (funcprototype
+ (funcdef
+ "void "
+ (function "glGetVertexAttribfv"))
+ (paramdef "GLuint " (parameter "index"))
+ (paramdef "GLenum " (parameter "pname"))
+ (paramdef "GLfloat *" (parameter "params")))
+ (funcprototype
+ (funcdef
+ "void "
+ (function "glGetVertexAttribiv"))
+ (paramdef "GLuint " (parameter "index"))
+ (paramdef "GLenum " (parameter "pname"))
+ (paramdef "GLint *" (parameter "params"))))
+ '(*fragment*
+ (heading
+ "Return a generic vertex attribute parameter")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "index")))
+ (para "Specifies the generic vertex attribute
+\t\t parameter to be queried."))
+ (entry (% (heading (var "pname")))
+ (para "Specifies the symbolic name of the vertex
+\t\t attribute parameter to be queried. Accepted values are "
+ (code "GL_VERTEX_ATTRIB_ARRAY_BUFFER_BINDING")
+ ", "
+ (code "GL_VERTEX_ATTRIB_ARRAY_ENABLED")
+ ", "
+ (code "GL_VERTEX_ATTRIB_ARRAY_SIZE")
+ ", "
+ (code "GL_VERTEX_ATTRIB_ARRAY_STRIDE")
+ ", "
+ (code "GL_VERTEX_ATTRIB_ARRAY_TYPE")
+ ", "
+ (code "GL_VERTEX_ATTRIB_ARRAY_NORMALIZED")
+ ", or "
+ (code "GL_CURRENT_VERTEX_ATTRIB")
+ "."))
+ (entry (% (heading (var "params")))
+ (para "Returns the requested data.")))
+ (heading "Description")
+ (para (code "glGetVertexAttrib")
+ " returns in\t"
+ (var "params")
+ " the value of a generic vertex
+\tattribute parameter. The generic vertex attribute to be queried
+\tis specified by "
+ (var "index")
+ ", and the parameter
+\tto be queried is specified by "
+ (var "pname")
+ ".")
+ (para "The accepted parameter names are as follows:")
+ (table (% (formatter (asis)))
+ (entry (% (heading
+ (code "GL_VERTEX_ATTRIB_ARRAY_BUFFER_BINDING")))
+ (para)
+ (para (var "params")
+ " returns a
+\t\t single value, the name of the buffer object currently bound to
+ the binding point corresponding to generic vertex attribute array "
+ (var "index")
+ ". If no buffer object is bound,
+ 0 is returned. The initial value is 0."))
+ (entry (% (heading (code "GL_VERTEX_ATTRIB_ARRAY_ENABLED")))
+ (para)
+ (para (var "params")
+ " returns a
+\t\t single value that is non-zero (true) if the vertex
+\t\t attribute array for "
+ (var "index")
+ " is
+\t\t enabled and 0 (false) if it is disabled. The initial
+\t\t value is "
+ (code "GL_FALSE")
+ "."))
+ (entry (% (heading (code "GL_VERTEX_ATTRIB_ARRAY_SIZE")))
+ (para)
+ (para (var "params")
+ " returns a
+\t\t single value, the size of the vertex attribute array
+\t\t for "
+ (var "index")
+ ". The size is the
+\t\t number of values for each element of the vertex
+\t\t attribute array, and it will be 1, 2, 3, or 4. The
+\t\t initial value is 4."))
+ (entry (% (heading (code "GL_VERTEX_ATTRIB_ARRAY_STRIDE")))
+ (para)
+ (para (var "params")
+ " returns a
+\t\t single value, the array stride for (number of bytes
+\t\t between successive elements in) the vertex attribute
+\t\t array for "
+ (var "index")
+ ". A value of 0
+\t\t indicates that the array elements are stored
+\t\t sequentially in memory. The initial value is 0."))
+ (entry (% (heading (code "GL_VERTEX_ATTRIB_ARRAY_TYPE")))
+ (para)
+ (para (var "params")
+ " returns a
+\t\t single value, a symbolic constant indicating the
+\t\t array type for the vertex attribute array for "
+ (var "index")
+ ". Possible values are "
+ (code "GL_BYTE")
+ ", "
+ (code "GL_UNSIGNED_BYTE")
+ ", "
+ (code "GL_SHORT")
+ ", "
+ (code "GL_UNSIGNED_SHORT")
+ ", "
+ (code "GL_INT")
+ ", "
+ (code "GL_UNSIGNED_INT")
+ ", "
+ (code "GL_FLOAT")
+ ", and "
+ (code "GL_DOUBLE")
+ ". The initial value is "
+ (code "GL_FLOAT")
+ "."))
+ (entry (% (heading
+ (code "GL_VERTEX_ATTRIB_ARRAY_NORMALIZED")))
+ (para)
+ (para (var "params")
+ " returns a
+\t\t single value that is non-zero (true) if fixed-point
+\t\t data types for the vertex attribute array indicated
+\t\t by "
+ (var "index")
+ " are normalized when
+\t\t they are converted to floating point, and 0 (false)
+\t\t otherwise. The initial value is "
+ (code "GL_FALSE")
+ "."))
+ (entry (% (heading (code "GL_CURRENT_VERTEX_ATTRIB")))
+ (para)
+ (para (var "params")
+ " returns four
+\t\t values that represent the current value for the
+\t\t generic vertex attribute specified by index. Generic
+\t\t vertex attribute 0 is unique in that it has no
+\t\t current state, so an error will be generated if "
+ (var "index")
+ " is 0. The initial value
+\t\t for all other generic vertex attributes is
+\t\t (0,0,0,1).")))
+ (para "All of the parameters except "
+ (code "GL_CURRENT_VERTEX_ATTRIB")
+ "
+represent client-side state.")
+ (heading "Errors")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if\t"
+ (var "index")
+ " is greater than or equal to\t"
+ (code "GL_MAX_VERTEX_ATTRIBS")
+ ".")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if\t"
+ (var "pname")
+ " is not an accepted value.")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if\t"
+ (var "index")
+ " is 0 and\t"
+ (var "pname")
+ " is\t"
+ (code "GL_CURRENT_VERTEX_ATTRIB")
+ ".")))
+
+(define-gl-procedure
+ glGet
+ "glGet"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glGetBooleanv"))
+ (paramdef "GLenum " (parameter "pname"))
+ (paramdef "GLboolean * " (parameter "params"))))
+ '(*fragment*
+ (heading
+ "return the value or values of a selected parameter")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "pname")))
+ (para "
+Specifies the parameter value to be returned.
+ The symbolic constants in the list below are accepted. "))
+ (entry (% (heading (var "params")))
+ (para "
+Returns the value or values of the specified parameter. ")))
+ (heading "Description")
+ (para "
+These four commands return values for simple state variables in GL. "
+ (var "pname")
+ " is a symbolic constant indicating the state variable to be returned,
+ and "
+ (var "params")
+ " is a pointer to an array of the indicated type in
+ which to place the returned data. ")
+ (para "
+Type conversion is performed if "
+ (var "params")
+ " has a different type than
+ the state variable value being requested.
+ If "
+ (code "glGetBooleanv")
+ " is called,
+ a floating-point (or integer) value is converted to "
+ (code "GL_FALSE")
+ " if
+ and only if it is 0.0 (or 0).
+ Otherwise,
+ it is converted to "
+ (code "GL_TRUE")
+ ".
+ If "
+ (code "glGetIntegerv")
+ " is called, boolean values are returned as "
+ (code "GL_TRUE")
+ " or "
+ (code "GL_FALSE")
+ ", and most floating-point values are
+ rounded to the nearest integer value. Floating-point colors and
+ normals, however, are returned with a linear mapping that maps 1.0 to
+ the most positive representable integer value
+ and "
+ (math "-1.0")
+ "
+to the most negative representable integer value.
+ If "
+ (code "glGetFloatv")
+ " or "
+ (code "glGetDoublev")
+ " is called,
+ boolean values are returned as "
+ (code "GL_TRUE")
+ " or "
+ (code "GL_FALSE")
+ ",
+ and integer values are converted to floating-point values. ")
+ (para "
+The following symbolic constants are accepted by "
+ (var "pname")
+ ": ")
+ (table (% (formatter (asis)))
+ (entry (% (heading (code "GL_ACCUM_ALPHA_BITS")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the number of alpha bitplanes in the accumulation buffer. "))
+ (entry (% (heading (code "GL_ACCUM_BLUE_BITS")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the number of blue bitplanes in the accumulation buffer. "))
+ (entry (% (heading (code "GL_ACCUM_CLEAR_VALUE")))
+ (para)
+ (para (var "params")
+ " returns four values:
+ the red, green, blue, and alpha values used to clear the accumulation buffer.
+ Integer values,
+ if requested,
+ are linearly mapped from the internal floating-point representation such
+ that 1.0 returns the most positive representable integer value,
+ and "
+ (math "-1.0")
+ "
+returns the most negative representable integer
+ value. The initial value is (0, 0, 0, 0).
+ See "
+ (code "glClearAccum")
+ ". "))
+ (entry (% (heading (code "GL_ACCUM_GREEN_BITS")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the number of green bitplanes in the accumulation buffer. "))
+ (entry (% (heading (code "GL_ACCUM_RED_BITS")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the number of red bitplanes in the accumulation buffer. "))
+ (entry (% (heading (code "GL_ACTIVE_TEXTURE")))
+ (para)
+ (para (var "params")
+ " returns a single value indicating the active multitexture unit.
+ The initial value is "
+ (code "GL_TEXTURE0")
+ ".
+ See "
+ (code "glActiveTexture")
+ ". "))
+ (entry (% (heading (code "GL_ALIASED_POINT_SIZE_RANGE")))
+ (para)
+ (para (var "params")
+ " returns two values,
+ the smallest and largest supported sizes for aliased points. "))
+ (entry (% (heading (code "GL_ALIASED_LINE_WIDTH_RANGE")))
+ (para)
+ (para (var "params")
+ " returns two values,
+ the smallest and largest supported widths for aliased lines. "))
+ (entry (% (heading (code "GL_ALPHA_BIAS")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the alpha bias factor used during pixel transfers. The initial value is 0.
+ See "
+ (code "glPixelTransfer")
+ ". "))
+ (entry (% (heading (code "GL_ALPHA_BITS")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the number of alpha bitplanes in each color buffer. "))
+ (entry (% (heading (code "GL_ALPHA_SCALE")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the alpha scale factor used
+ during pixel transfers. The initial value is 1.
+ See "
+ (code "glPixelTransfer")
+ ". "))
+ (entry (% (heading (code "GL_ALPHA_TEST")))
+ (para)
+ (para (var "params")
+ " returns a single boolean value indicating whether alpha testing
+ of fragments is enabled. The initial value is "
+ (code "GL_FALSE")
+ ".
+ See "
+ (code "glAlphaFunc")
+ ". "))
+ (entry (% (heading
+ (code "GL_ALPHA_TEST_FUNC")
+ (var "params")
+ " returns one value,"))
+ (para)
+ (para "
+the symbolic name of the alpha test function. The initial value is "
+ (code "GL_ALWAYS")
+ ".
+ See "
+ (code "glAlphaFunc")
+ ". "))
+ (entry (% (heading (code "GL_ALPHA_TEST_REF")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the reference value for the alpha test. The initial value is 0.
+ See "
+ (code "glAlphaFunc")
+ ".
+ An integer value,
+ if requested,
+ is linearly mapped from the internal floating-point representation such
+ that 1.0 returns the most positive representable integer value,
+ and "
+ (math "-1.0")
+ "
+returns the most negative representable integer value. "))
+ (entry (% (heading (code "GL_ARRAY_BUFFER_BINDING")))
+ (para)
+ (para (var "params")
+ " returns a single value, the name of the buffer object
+ currently bound to the target "
+ (code "GL_ARRAY_BUFFER")
+ ". If no buffer object
+ is bound to this target, 0 is returned. The initial value is 0.
+ See "
+ (code "glBindBuffer")
+ ". "))
+ (entry (% (heading (code "GL_ATTRIB_STACK_DEPTH")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the depth of the attribute stack.
+ If the stack is empty,
+ 0 is returned. The initial value is 0.
+ See "
+ (code "glPushAttrib")
+ ". "))
+ (entry (% (heading (code "GL_AUTO_NORMAL")))
+ (para)
+ (para (var "params")
+ " returns a single boolean value indicating whether 2D map evaluation
+ automatically generates surface normals. The initial value is "
+ (code "GL_FALSE")
+ ".
+ See "
+ (code "glMap2")
+ ". "))
+ (entry (% (heading (code "GL_AUX_BUFFERS")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the number of auxiliary color buffers available. "))
+ (entry (% (heading (code "GL_BLEND")))
+ (para)
+ (para (var "params")
+ " returns a single boolean value indicating whether blending is
+ enabled. The initial value is "
+ (code "GL_FALSE")
+ ".
+ See "
+ (code "glBlendFunc")
+ ". "))
+ (entry (% (heading (code "GL_BLEND_COLOR")))
+ (para)
+ (para (var "params")
+ " returns four values,
+ the red, green, blue, and alpha values which are the components of
+ the blend color.
+ See "
+ (code "glBlendColor")
+ ". "))
+ (entry (% (heading (code "GL_BLEND_DST_ALPHA")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the symbolic constant identifying the alpha destination blend
+ function. The initial value is "
+ (code "GL_ZERO")
+ ".
+ See "
+ (code "glBlendFunc")
+ " and "
+ (code "glBlendFuncSeparate")
+ ". "))
+ (entry (% (heading (code "GL_BLEND_DST_RGB")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the symbolic constant identifying the RGB destination blend
+ function. The initial value is "
+ (code "GL_ZERO")
+ ".
+ See "
+ (code "glBlendFunc")
+ " and "
+ (code "glBlendFuncSeparate")
+ ". "))
+ (entry (% (heading (code "GL_BLEND_EQUATION_RGB")))
+ (para)
+ (para (var "params")
+ " returns one value, a symbolic constant indicating whether
+ the RGB blend equation is "
+ (code "GL_FUNC_ADD")
+ ", "
+ (code "GL_FUNC_SUBTRACT")
+ ", "
+ (code "GL_FUNC_REVERSE_SUBTRACT")
+ ", "
+ (code "GL_MIN")
+ " or "
+ (code "GL_MAX")
+ ".
+ See "
+ (code "glBlendEquationSeparate")
+ ". "))
+ (entry (% (heading (code "GL_BLEND_EQUATION_ALPHA")))
+ (para)
+ (para (var "params")
+ " returns one value, a symbolic constant indicating whether
+ the Alpha blend equation is "
+ (code "GL_FUNC_ADD")
+ ", "
+ (code "GL_FUNC_SUBTRACT")
+ ", "
+ (code "GL_FUNC_REVERSE_SUBTRACT")
+ ", "
+ (code "GL_MIN")
+ " or "
+ (code "GL_MAX")
+ ".
+ See "
+ (code "glBlendEquationSeparate")
+ ". "))
+ (entry (% (heading (code "GL_BLEND_SRC_ALPHA")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the symbolic constant identifying the alpha source blend function. The initial
+ value is "
+ (code "GL_ONE")
+ ".
+ See "
+ (code "glBlendFunc")
+ " and "
+ (code "glBlendFuncSeparate")
+ ". "))
+ (entry (% (heading (code "GL_BLEND_SRC_RGB")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the symbolic constant identifying the RGB source blend function. The initial
+ value is "
+ (code "GL_ONE")
+ ".
+ See "
+ (code "glBlendFunc")
+ " and "
+ (code "glBlendFuncSeparate")
+ ". "))
+ (entry (% (heading (code "GL_BLUE_BIAS")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the blue bias factor used during pixel transfers. The initial value is 0.
+ See "
+ (code "glPixelTransfer")
+ ". "))
+ (entry (% (heading (code "GL_BLUE_BITS")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the number of blue bitplanes in each color buffer. "))
+ (entry (% (heading (code "GL_BLUE_SCALE")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the blue scale factor used during pixel transfers. The initial value is 1.
+ See "
+ (code "glPixelTransfer")
+ ". "))
+ (entry (% (heading (code "GL_CLIENT_ACTIVE_TEXTURE")))
+ (para)
+ (para (var "params")
+ " returns a single integer value indicating the current client active
+ multitexture unit. The initial value is "
+ (code "GL_TEXTURE0")
+ ".
+ See "
+ (code "glClientActiveTexture")
+ ". "))
+ (entry (% (heading (code "GL_CLIENT_ATTRIB_STACK_DEPTH")))
+ (para)
+ (para (var "params")
+ " returns one value indicating the depth of the
+ attribute stack. The initial value is 0.
+ See "
+ (code "glPushClientAttrib")
+ ". "))
+ (entry (% (heading (code "GL_CLIP_PLANE") (var "i")))
+ (para)
+ (para (var "params")
+ " returns a single boolean value indicating whether the specified
+ clipping plane is enabled. The initial value is "
+ (code "GL_FALSE")
+ ".
+ See "
+ (code "glClipPlane")
+ ". "))
+ (entry (% (heading (code "GL_COLOR_ARRAY")))
+ (para)
+ (para (var "params")
+ " returns a single boolean value indicating whether the color array is enabled. The initial value is "
+ (code "GL_FALSE")
+ ".
+ See "
+ (code "glColorPointer")
+ ". "))
+ (entry (% (heading (code "GL_COLOR_ARRAY_BUFFER_BINDING")))
+ (para)
+ (para (var "params")
+ " returns a single value, the name of the buffer object
+ associated with the color array. This buffer object would have been bound to the
+ target "
+ (code "GL_ARRAY_BUFFER")
+ " at the time of the most recent call to "
+ (code "glColorPointer")
+ ".
+ If no buffer object was bound to this target, 0 is returned. The initial value is 0.
+ See "
+ (code "glBindBuffer")
+ ". "))
+ (entry (% (heading (code "GL_COLOR_ARRAY_SIZE")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the number of components per color in the color array. The initial value
+ is 4.
+ See "
+ (code "glColorPointer")
+ ". "))
+ (entry (% (heading (code "GL_COLOR_ARRAY_STRIDE")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the byte offset between consecutive colors in the color array. The initial
+ value is 0.
+ See "
+ (code "glColorPointer")
+ ". "))
+ (entry (% (heading (code "GL_COLOR_ARRAY_TYPE")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the data type of each component in the color array. The initial value
+ is "
+ (code "GL_FLOAT")
+ ".
+ See "
+ (code "glColorPointer")
+ ". "))
+ (entry (% (heading (code "GL_COLOR_CLEAR_VALUE")))
+ (para)
+ (para (var "params")
+ " returns four values:
+ the red, green, blue, and alpha values used to clear the color buffers.
+ Integer values,
+ if requested,
+ are linearly mapped from the internal floating-point representation such
+ that 1.0 returns the most positive representable integer value,
+ and "
+ (math "-1.0")
+ "
+returns the most negative representable integer
+ value. The initial value is (0, 0, 0, 0).
+ See "
+ (code "glClearColor")
+ ". "))
+ (entry (% (heading (code "GL_COLOR_LOGIC_OP")))
+ (para)
+ (para (var "params")
+ " returns a single boolean value indicating whether a fragment's
+ RGBA color values are merged into the framebuffer using a logical
+ operation. The initial value is "
+ (code "GL_FALSE")
+ ".
+ See "
+ (code "glLogicOp")
+ ". "))
+ (entry (% (heading (code "GL_COLOR_MATERIAL")))
+ (para)
+ (para (var "params")
+ " returns a single boolean value indicating whether one or more
+ material parameters are tracking the current color. The initial value
+ is "
+ (code "GL_FALSE")
+ ".
+ See "
+ (code "glColorMaterial")
+ ". "))
+ (entry (% (heading (code "GL_COLOR_MATERIAL_FACE")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ a symbolic constant indicating which materials have a parameter that is
+ tracking the current color. The initial value is "
+ (code "GL_FRONT_AND_BACK")
+ ".
+ See "
+ (code "glColorMaterial")
+ ". "))
+ (entry (% (heading (code "GL_COLOR_MATERIAL_PARAMETER")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ a symbolic constant indicating which material parameters are
+ tracking the current color. The initial value is "
+ (code "GL_AMBIENT_AND_DIFFUSE")
+ ".
+ See "
+ (code "glColorMaterial")
+ ". "))
+ (entry (% (heading (code "GL_COLOR_MATRIX")))
+ (para)
+ (para (var "params")
+ " returns sixteen values:
+ the color matrix on the top of the color matrix stack. Initially
+ this matrix is the identity matrix.
+ See "
+ (code "glPushMatrix")
+ ". "))
+ (entry (% (heading (code "GL_COLOR_MATRIX_STACK_DEPTH")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the maximum supported depth of the projection matrix stack. The value must
+ be at least 2.
+ See "
+ (code "glPushMatrix")
+ ". "))
+ (entry (% (heading (code "GL_COLOR_SUM")))
+ (para)
+ (para (var "params")
+ " returns a single boolean value indicating whether primary and
+ secondary color sum is enabled.
+ See "
+ (code "glSecondaryColor")
+ ". "))
+ (entry (% (heading (code "GL_COLOR_TABLE")))
+ (para)
+ (para (var "params")
+ " returns a single boolean value indicating whether the color table
+ lookup is enabled.
+ See "
+ (code "glColorTable")
+ ". "))
+ (entry (% (heading (code "GL_COLOR_WRITEMASK")))
+ (para)
+ (para (var "params")
+ " returns four boolean values:
+ the red, green, blue, and alpha write enables for the color
+ buffers. The initial value is ("
+ (code "GL_TRUE")
+ ", "
+ (code "GL_TRUE")
+ ", "
+ (code "GL_TRUE")
+ ", "
+ (code "GL_TRUE")
+ ").
+ See "
+ (code "glColorMask")
+ ". "))
+ (entry (% (heading (code "GL_COMPRESSED_TEXTURE_FORMATS")))
+ (para)
+ (para (var "params")
+ " returns a list of symbolic
+ constants of length "
+ (code "GL_NUM_COMPRESSED_TEXTURE_FORMATS")
+ " indicating which compressed texture formats are available.
+ See "
+ (code "glCompressedTexImage2D")
+ ". "))
+ (entry (% (heading (code "GL_CONVOLUTION_1D")))
+ (para)
+ (para (var "params")
+ " returns a single boolean value indicating whether 1D convolution
+ is enabled. The initial value is "
+ (code "GL_FALSE")
+ ".
+ See "
+ (code "glConvolutionFilter1D")
+ ". "))
+ (entry (% (heading (code "GL_CONVOLUTION_2D")))
+ (para)
+ (para (var "params")
+ " returns a single boolean value indicating whether 2D convolution
+ is enabled. The initial value is "
+ (code "GL_FALSE")
+ ".
+ See "
+ (code "glConvolutionFilter2D")
+ ". "))
+ (entry (% (heading (code "GL_CULL_FACE")))
+ (para)
+ (para (var "params")
+ " returns a single boolean value indicating whether polygon culling
+ is enabled. The initial value is "
+ (code "GL_FALSE")
+ ".
+ See "
+ (code "glCullFace")
+ ". "))
+ (entry (% (heading (code "GL_CULL_FACE_MODE")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ a symbolic constant indicating which polygon faces are to be
+ culled. The initial value is "
+ (code "GL_BACK")
+ ".
+ See "
+ (code "glCullFace")
+ ". "))
+ (entry (% (heading (code "GL_CURRENT_COLOR")))
+ (para)
+ (para (var "params")
+ " returns four values:
+ the red, green, blue, and alpha values of the current color.
+ Integer values,
+ if requested,
+ are linearly mapped from the internal floating-point representation such
+ that 1.0 returns the most positive representable integer value,
+ and "
+ (math "-1.0")
+ "
+returns the most negative representable integer value.
+ The initial value is (1, 1, 1, 1).
+ See "
+ (code "glColor")
+ ". "))
+ (entry (% (heading (code "GL_CURRENT_FOG_COORD")))
+ (para)
+ (para (var "params")
+ " returns one value, the current fog coordinate. The initial value
+ is 0.
+ See "
+ (code "glFogCoord")
+ ". "))
+ (entry (% (heading (code "GL_CURRENT_INDEX")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the current color index. The initial value is 1.
+ See "
+ (code "glIndex")
+ ". "))
+ (entry (% (heading (code "GL_CURRENT_NORMAL")))
+ (para)
+ (para (var "params")
+ " returns three values:
+ the "
+ (var "x")
+ ", "
+ (var "y")
+ ", and "
+ (var "z")
+ " values of the current normal.
+ Integer values,
+ if requested,
+ are linearly mapped from the internal floating-point representation such
+ that 1.0 returns the most positive representable integer value,
+ and "
+ (math "-1.0")
+ "
+returns the most negative representable integer value.
+ The initial value is (0, 0, 1).
+ See "
+ (code "glNormal")
+ ". "))
+ (entry (% (heading (code "GL_CURRENT_PROGRAM")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the name of the program object that is currently active, or 0 if no program object is active.
+ See "
+ (code "glUseProgram")
+ ". "))
+ (entry (% (heading (code "GL_CURRENT_RASTER_COLOR")))
+ (para)
+ (para (var "params")
+ " returns four values:
+ the red, green, blue, and alpha color values of the current raster position.
+ Integer values,
+ if requested,
+ are linearly mapped from the internal floating-point representation such
+ that 1.0 returns the most positive representable integer value,
+ and "
+ (math "-1.0")
+ "
+returns the most negative representable integer
+ value. The initial value is (1, 1, 1, 1).
+ See "
+ (code "glRasterPos")
+ ". "))
+ (entry (% (heading (code "GL_CURRENT_RASTER_DISTANCE")))
+ (para)
+ (para (var "params")
+ " returns one value, the distance from the eye to the current
+ raster position. The initial value is 0.
+ See "
+ (code "glRasterPos")
+ ". "))
+ (entry (% (heading (code "GL_CURRENT_RASTER_INDEX")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the color index of the current raster position. The initial value is 1.
+ See "
+ (code "glRasterPos")
+ ". "))
+ (entry (% (heading (code "GL_CURRENT_RASTER_POSITION")))
+ (para)
+ (para (var "params")
+ " returns four values:
+ the "
+ (var "x")
+ ", "
+ (var "y")
+ ", "
+ (var "z")
+ ", and "
+ (var "w")
+ " components of the current
+ raster position. "
+ (var "x")
+ ", "
+ (var "y")
+ ", and "
+ (var "z")
+ " are in window coordinates,
+ and "
+ (var "w")
+ " is in clip coordinates. The initial value is (0, 0, 0, 1).
+ See "
+ (code "glRasterPos")
+ ". "))
+ (entry (% (heading
+ (code "GL_CURRENT_RASTER_POSITION_VALID")))
+ (para)
+ (para (var "params")
+ " returns a single boolean value indicating whether the current
+ raster position is valid. The initial value is "
+ (code "GL_TRUE")
+ ".
+ See "
+ (code "glRasterPos")
+ ". "))
+ (entry (% (heading
+ (code "GL_CURRENT_RASTER_SECONDARY_COLOR")))
+ (para)
+ (para (var "params")
+ " returns four values:
+ the red, green, blue, and alpha secondary color values of the current raster position.
+ Integer values,
+ if requested,
+ are linearly mapped from the internal floating-point representation such
+ that 1.0 returns the most positive representable integer value,
+ and "
+ (math "-1.0")
+ "
+returns the most negative representable integer
+ value. The initial value is (1, 1, 1, 1).
+ See "
+ (code "glRasterPos")
+ ". "))
+ (entry (% (heading
+ (code "GL_CURRENT_RASTER_TEXTURE_COORDS")))
+ (para)
+ (para (var "params")
+ " returns four values: the "
+ (var "s")
+ ", "
+ (var "t")
+ ", "
+ (var "r")
+ ", and "
+ (var "q")
+ "
+texture coordinates of the current raster position. The initial value is (0, 0, 0, 1).
+ See "
+ (code "glRasterPos")
+ " and "
+ (code "glMultiTexCoord")
+ ". "))
+ (entry (% (heading (code "GL_CURRENT_SECONDARY_COLOR")))
+ (para)
+ (para (var "params")
+ " returns four values: the red, green, blue, and alpha values of the
+ current secondary color. Integer values, if requested, are linearly mapped
+ from the internal floating-point representation such that 1.0 returns the
+ most positive representable integer value, and "
+ (math "-1.0")
+ "
+returns the most
+ negative representable integer value. The initial value is (0, 0, 0, 0).
+ See "
+ (code "glSecondaryColor")
+ ". "))
+ (entry (% (heading (code "GL_CURRENT_TEXTURE_COORDS")))
+ (para)
+ (para (var "params")
+ " returns four values:
+ the "
+ (var "s")
+ ", "
+ (var "t")
+ ", "
+ (var "r")
+ ", and "
+ (var "q")
+ " current texture
+ coordinates. The initial value is (0, 0, 0, 1).
+ See "
+ (code "glMultiTexCoord")
+ ". "))
+ (entry (% (heading (code "GL_DEPTH_BIAS")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the depth bias factor used during pixel transfers. The initial value is 0.
+ See "
+ (code "glPixelTransfer")
+ ". "))
+ (entry (% (heading (code "GL_DEPTH_BITS")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the number of bitplanes in the depth buffer. "))
+ (entry (% (heading (code "GL_DEPTH_CLEAR_VALUE")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the value that is used to clear the depth buffer.
+ Integer values,
+ if requested,
+ are linearly mapped from the internal floating-point representation such
+ that 1.0 returns the most positive representable integer value,
+ and "
+ (math "-1.0")
+ "
+returns the most negative representable integer
+ value. The initial value is 1.
+ See "
+ (code "glClearDepth")
+ ". "))
+ (entry (% (heading (code "GL_DEPTH_FUNC")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the symbolic constant that indicates the depth comparison
+ function. The initial value is "
+ (code "GL_LESS")
+ ".
+ See "
+ (code "glDepthFunc")
+ ". "))
+ (entry (% (heading (code "GL_DEPTH_RANGE")))
+ (para)
+ (para (var "params")
+ " returns two values:
+ the near and far mapping limits for the depth buffer.
+ Integer values,
+ if requested,
+ are linearly mapped from the internal floating-point representation such
+ that 1.0 returns the most positive representable integer value,
+ and "
+ (math "-1.0")
+ "
+returns the most negative representable integer
+ value. The initial value is (0, 1).
+ See "
+ (code "glDepthRange")
+ ". "))
+ (entry (% (heading (code "GL_DEPTH_SCALE")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the depth scale factor used during pixel transfers. The initial value is 1.
+ See "
+ (code "glPixelTransfer")
+ ". "))
+ (entry (% (heading (code "GL_DEPTH_TEST")))
+ (para)
+ (para (var "params")
+ " returns a single boolean value indicating whether depth testing
+ of fragments is enabled. The initial value is "
+ (code "GL_FALSE")
+ ".
+ See "
+ (code "glDepthFunc")
+ " and "
+ (code "glDepthRange")
+ ". "))
+ (entry (% (heading (code "GL_DEPTH_WRITEMASK")))
+ (para)
+ (para (var "params")
+ " returns a single boolean value indicating if the depth buffer
+ is enabled for writing. The initial value is "
+ (code "GL_TRUE")
+ ".
+ See "
+ (code "glDepthMask")
+ ". "))
+ (entry (% (heading (code "GL_DITHER")))
+ (para)
+ (para (var "params")
+ " returns a single boolean value indicating whether dithering of
+ fragment colors and indices is enabled. The initial value is "
+ (code "GL_TRUE")
+ ". "))
+ (entry (% (heading (code "GL_DOUBLEBUFFER")))
+ (para)
+ (para (var "params")
+ " returns a single boolean value indicating whether double buffering
+ is supported. "))
+ (entry (% (heading (code "GL_DRAW_BUFFER")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ a symbolic constant indicating which buffers are being drawn to.
+ See "
+ (code "glDrawBuffer")
+ ". The initial value is "
+ (code "GL_BACK")
+ " if there
+ are back buffers, otherwise it is "
+ (code "GL_FRONT")
+ ". "))
+ (entry (% (heading (code "GL_DRAW_BUFFER") (var "i")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ a symbolic constant indicating which buffers are being drawn to by the corresponding output color.
+ See "
+ (code "glDrawBuffers")
+ ".
+ The initial value of "
+ (code "GL_DRAW_BUFFER0")
+ " is "
+ (code "GL_BACK")
+ " if there
+ are back buffers, otherwise it is "
+ (code "GL_FRONT")
+ ". The
+ initial values of draw buffers for all other output colors is "
+ (code "GL_NONE")
+ ". "))
+ (entry (% (heading (code "GL_EDGE_FLAG")))
+ (para)
+ (para (var "params")
+ " returns a single boolean value indicating whether the current
+ edge flag is "
+ (code "GL_TRUE")
+ " or "
+ (code "GL_FALSE")
+ ". The initial value is "
+ (code "GL_TRUE")
+ ".
+ See "
+ (code "glEdgeFlag")
+ ". "))
+ (entry (% (heading (code "GL_EDGE_FLAG_ARRAY")))
+ (para)
+ (para (var "params")
+ " returns a single boolean value indicating whether the edge
+ flag array is enabled. The initial value is "
+ (code "GL_FALSE")
+ ".
+ See "
+ (code "glEdgeFlagPointer")
+ ". "))
+ (entry (% (heading
+ (code "GL_EDGE_FLAG_ARRAY_BUFFER_BINDING")))
+ (para)
+ (para (var "params")
+ " returns a single value, the name of the buffer object
+ associated with the edge flag array. This buffer object would have been bound to the
+ target "
+ (code "GL_ARRAY_BUFFER")
+ " at the time of the most recent call to "
+ (code "glEdgeFlagPointer")
+ ".
+ If no buffer object was bound to this target, 0 is returned. The initial value is 0.
+ See "
+ (code "glBindBuffer")
+ ". "))
+ (entry (% (heading (code "GL_EDGE_FLAG_ARRAY_STRIDE")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the byte offset between consecutive edge flags in the edge flag
+ array. The initial value is 0.
+ See "
+ (code "glEdgeFlagPointer")
+ ". "))
+ (entry (% (heading
+ (code "GL_ELEMENT_ARRAY_BUFFER_BINDING")))
+ (para)
+ (para (var "params")
+ " returns a single value, the name of the buffer object
+ currently bound to the target "
+ (code "GL_ELEMENT_ARRAY_BUFFER")
+ ". If no buffer object
+ is bound to this target, 0 is returned. The initial value is 0.
+ See "
+ (code "glBindBuffer")
+ ". "))
+ (entry (% (heading (code "GL_FEEDBACK_BUFFER_SIZE")))
+ (para)
+ (para (var "params")
+ " returns one value, the size of the feedback buffer.
+ See "
+ (code "glFeedbackBuffer")
+ ". "))
+ (entry (% (heading (code "GL_FEEDBACK_BUFFER_TYPE")))
+ (para)
+ (para (var "params")
+ " returns one value, the type of the feedback buffer.
+ See "
+ (code "glFeedbackBuffer")
+ ". "))
+ (entry (% (heading (code "GL_FOG")))
+ (para)
+ (para (var "params")
+ " returns a single boolean value indicating whether fogging is
+ enabled. The initial value is "
+ (code "GL_FALSE")
+ ".
+ See "
+ (code "glFog")
+ ". "))
+ (entry (% (heading (code "GL_FOG_COORD_ARRAY")))
+ (para)
+ (para (var "params")
+ " returns a single boolean value indicating whether the fog coordinate array is enabled. The initial value is "
+ (code "GL_FALSE")
+ ".
+ See "
+ (code "glFogCoordPointer")
+ ". "))
+ (entry (% (heading
+ (code "GL_FOG_COORD_ARRAY_BUFFER_BINDING")))
+ (para)
+ (para (var "params")
+ " returns a single value, the name of the buffer object
+ associated with the fog coordinate array. This buffer object would have been bound to the
+ target "
+ (code "GL_ARRAY_BUFFER")
+ " at the time of the most recent call to "
+ (code "glFogCoordPointer")
+ ".
+ If no buffer object was bound to this target, 0 is returned. The initial value is 0.
+ See "
+ (code "glBindBuffer")
+ ". "))
+ (entry (% (heading (code "GL_FOG_COORD_ARRAY_STRIDE")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the byte offset between consecutive fog coordinates in the fog coordinate
+ array. The initial value is 0.
+ See "
+ (code "glFogCoordPointer")
+ ". "))
+ (entry (% (heading (code "GL_FOG_COORD_ARRAY_TYPE")))
+ (para)
+ (para (var "params")
+ " returns one value, the type of the fog coordinate array.
+ The initial value is "
+ (code "GL_FLOAT")
+ ".
+ See "
+ (code "glFogCoordPointer")
+ ". "))
+ (entry (% (heading (code "GL_FOG_COORD_SRC")))
+ (para)
+ (para (var "params")
+ " returns one value, a symbolic constant indicating the source of the fog coordinate.
+ The initial value is "
+ (code "GL_FRAGMENT_DEPTH")
+ ".
+ See "
+ (code "glFog")
+ ". "))
+ (entry (% (heading (code "GL_FOG_COLOR")))
+ (para)
+ (para (var "params")
+ " returns four values:
+ the red, green, blue, and alpha components of the fog color.
+ Integer values,
+ if requested,
+ are linearly mapped from the internal floating-point representation such
+ that 1.0 returns the most positive representable integer value,
+ and "
+ (math "-1.0")
+ "
+returns the most negative representable integer
+ value. The initial value is (0, 0, 0, 0).
+ See "
+ (code "glFog")
+ ". "))
+ (entry (% (heading (code "GL_FOG_DENSITY")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the fog density parameter. The initial value is 1.
+ See "
+ (code "glFog")
+ ". "))
+ (entry (% (heading (code "GL_FOG_END")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the end factor for the linear fog equation. The initial value is 1.
+ See "
+ (code "glFog")
+ ". "))
+ (entry (% (heading (code "GL_FOG_HINT")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ a symbolic constant indicating the mode of the fog hint. The initial value
+ is "
+ (code "GL_DONT_CARE")
+ ".
+ See "
+ (code "glHint")
+ ". "))
+ (entry (% (heading (code "GL_FOG_INDEX")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the fog color index. The initial value is 0.
+ See "
+ (code "glFog")
+ ". "))
+ (entry (% (heading (code "GL_FOG_MODE")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ a symbolic constant indicating which fog equation is selected. The initial
+ value is "
+ (code "GL_EXP")
+ ".
+ See "
+ (code "glFog")
+ ". "))
+ (entry (% (heading (code "GL_FOG_START")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the start factor for the linear fog equation. The initial value is 0.
+ See "
+ (code "glFog")
+ ". "))
+ (entry (% (heading
+ (code "GL_FRAGMENT_SHADER_DERIVATIVE_HINT")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ a symbolic constant indicating the mode of the derivative accuracy hint
+ for fragment shaders. The initial value
+ is "
+ (code "GL_DONT_CARE")
+ ".
+ See "
+ (code "glHint")
+ ". "))
+ (entry (% (heading (code "GL_FRONT_FACE")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ a symbolic constant indicating whether clockwise or counterclockwise
+ polygon winding is treated as front-facing. The initial value is "
+ (code "GL_CCW")
+ ".
+ See "
+ (code "glFrontFace")
+ ". "))
+ (entry (% (heading (code "GL_GENERATE_MIPMAP_HINT")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ a symbolic constant indicating the mode of the mipmap generation filtering
+ hint. The initial value is "
+ (code "GL_DONT_CARE")
+ ".
+ See "
+ (code "glHint")
+ ". "))
+ (entry (% (heading (code "GL_GREEN_BIAS")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the green bias factor used during pixel transfers. The initial value is 0. "))
+ (entry (% (heading (code "GL_GREEN_BITS")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the number of green bitplanes in each color buffer. "))
+ (entry (% (heading (code "GL_GREEN_SCALE")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the green scale factor used during pixel transfers. The initial value is 1.
+ See "
+ (code "glPixelTransfer")
+ ". "))
+ (entry (% (heading (code "GL_HISTOGRAM")))
+ (para)
+ (para (var "params")
+ " returns a single boolean value indicating whether histogram is
+ enabled. The initial value is "
+ (code "GL_FALSE")
+ ".
+ See "
+ (code "glHistogram")
+ ". "))
+ (entry (% (heading (code "GL_INDEX_ARRAY")))
+ (para)
+ (para (var "params")
+ " returns a single boolean value indicating whether the color
+ index array is enabled. The initial value is "
+ (code "GL_FALSE")
+ ".
+ See "
+ (code "glIndexPointer")
+ ". "))
+ (entry (% (heading (code "GL_INDEX_ARRAY_BUFFER_BINDING")))
+ (para)
+ (para (var "params")
+ " returns a single value, the name of the buffer object
+ associated with the color index array. This buffer object would have been bound to the
+ target "
+ (code "GL_ARRAY_BUFFER")
+ " at the time of the most recent call to "
+ (code "glIndexPointer")
+ ".
+ If no buffer object was bound to this target, 0 is returned. The initial value is 0.
+ See "
+ (code "glBindBuffer")
+ ". "))
+ (entry (% (heading (code "GL_INDEX_ARRAY_STRIDE")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the byte offset between consecutive color indexes in the color index
+ array. The initial value is 0.
+ See "
+ (code "glIndexPointer")
+ ". "))
+ (entry (% (heading (code "GL_INDEX_ARRAY_TYPE")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the data type of indexes in the color index array. The initial value is "
+ (code "GL_FLOAT")
+ ".
+ See "
+ (code "glIndexPointer")
+ ". "))
+ (entry (% (heading (code "GL_INDEX_BITS")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the number of bitplanes in each color index buffer. "))
+ (entry (% (heading (code "GL_INDEX_CLEAR_VALUE")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the color index used to clear the color index buffers. The initial value
+ is 0.
+ See "
+ (code "glClearIndex")
+ ". "))
+ (entry (% (heading (code "GL_INDEX_LOGIC_OP")))
+ (para)
+ (para (var "params")
+ " returns a single boolean value indicating whether a fragment's index
+ values are merged into the framebuffer using a logical
+ operation. The initial value is "
+ (code "GL_FALSE")
+ ".
+ See "
+ (code "glLogicOp")
+ ". "))
+ (entry (% (heading (code "GL_INDEX_MODE")))
+ (para)
+ (para (var "params")
+ " returns a single boolean value indicating whether the GL is in
+ color index mode ("
+ (code "GL_TRUE")
+ ") or RGBA mode ("
+ (code "GL_FALSE")
+ "). "))
+ (entry (% (heading (code "GL_INDEX_OFFSET")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the offset added to color and stencil indices during pixel
+ transfers. The initial value is 0.
+ See "
+ (code "glPixelTransfer")
+ ". "))
+ (entry (% (heading (code "GL_INDEX_SHIFT")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the amount that color and stencil indices are shifted during pixel
+ transfers. The initial value is 0.
+ See "
+ (code "glPixelTransfer")
+ ". "))
+ (entry (% (heading (code "GL_INDEX_WRITEMASK")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ a mask indicating which bitplanes of each color index buffer can be
+ written. The initial value is all 1's.
+ See "
+ (code "glIndexMask")
+ ". "))
+ (entry (% (heading (code "GL_LIGHT") (var "i")))
+ (para)
+ (para (var "params")
+ " returns a single boolean value indicating whether the specified
+ light is enabled. The initial value is "
+ (code "GL_FALSE")
+ ".
+ See "
+ (code "glLight")
+ " and "
+ (code "glLightModel")
+ ". "))
+ (entry (% (heading (code "GL_LIGHTING")))
+ (para)
+ (para (var "params")
+ " returns a single boolean value indicating whether lighting is
+ enabled. The initial value is "
+ (code "GL_FALSE")
+ ".
+ See "
+ (code "glLightModel")
+ ". "))
+ (entry (% (heading (code "GL_LIGHT_MODEL_AMBIENT")))
+ (para)
+ (para (var "params")
+ " returns four values:
+ the red, green, blue, and alpha components of the ambient intensity of
+ the entire scene.
+ Integer values,
+ if requested,
+ are linearly mapped from the internal floating-point representation such
+ that 1.0 returns the most positive representable integer value,
+ and "
+ (math "-1.0")
+ "
+returns the most negative representable integer
+ value. The initial value is (0.2, 0.2, 0.2, 1.0).
+ See "
+ (code "glLightModel")
+ ". "))
+ (entry (% (heading (code "GL_LIGHT_MODEL_COLOR_CONTROL")))
+ (para)
+ (para (var "params")
+ " returns single enumerated value indicating whether specular
+ reflection calculations are separated from normal lighting computations.
+ The initial value is "
+ (code "GL_SINGLE_COLOR")
+ ". "))
+ (entry (% (heading (code "GL_LIGHT_MODEL_LOCAL_VIEWER")))
+ (para)
+ (para (var "params")
+ " returns a single boolean value indicating whether specular reflection
+ calculations treat the viewer as being local to the scene. The initial
+ value is "
+ (code "GL_FALSE")
+ ".
+ See "
+ (code "glLightModel")
+ ". "))
+ (entry (% (heading (code "GL_LIGHT_MODEL_TWO_SIDE")))
+ (para)
+ (para (var "params")
+ " returns a single boolean value indicating whether separate materials
+ are used to compute lighting for front- and back-facing
+ polygons. The initial value is "
+ (code "GL_FALSE")
+ ".
+ See "
+ (code "glLightModel")
+ ". "))
+ (entry (% (heading (code "GL_LINE_SMOOTH")))
+ (para)
+ (para (var "params")
+ " returns a single boolean value indicating whether antialiasing of
+ lines is enabled. The initial value is "
+ (code "GL_FALSE")
+ ".
+ See "
+ (code "glLineWidth")
+ ". "))
+ (entry (% (heading (code "GL_LINE_SMOOTH_HINT")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ a symbolic constant indicating the mode of the line antialiasing
+ hint. The initial value is "
+ (code "GL_DONT_CARE")
+ ".
+ See "
+ (code "glHint")
+ ". "))
+ (entry (% (heading (code "GL_LINE_STIPPLE")))
+ (para)
+ (para (var "params")
+ " returns a single boolean value indicating whether stippling of lines
+ is enabled. The initial value is "
+ (code "GL_FALSE")
+ ".
+ See "
+ (code "glLineStipple")
+ ". "))
+ (entry (% (heading (code "GL_LINE_STIPPLE_PATTERN")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the 16-bit line stipple pattern. The initial value is all 1's.
+ See "
+ (code "glLineStipple")
+ ". "))
+ (entry (% (heading (code "GL_LINE_STIPPLE_REPEAT")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the line stipple repeat factor. The initial value is 1.
+ See "
+ (code "glLineStipple")
+ ". "))
+ (entry (% (heading (code "GL_LINE_WIDTH")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the line width as specified with "
+ (code "glLineWidth")
+ ". The initial value is
+ 1. "))
+ (entry (% (heading (code "GL_LINE_WIDTH_GRANULARITY")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the width difference between adjacent supported widths for antialiased lines.
+ See "
+ (code "glLineWidth")
+ ". "))
+ (entry (% (heading (code "GL_LINE_WIDTH_RANGE")))
+ (para)
+ (para (var "params")
+ " returns two values:
+ the smallest and largest supported widths for antialiased
+ lines.
+ See "
+ (code "glLineWidth")
+ ". "))
+ (entry (% (heading (code "GL_LIST_BASE")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the base offset added to all names in arrays presented to "
+ (code "glCallLists")
+ ". The initial value is 0.
+ See "
+ (code "glListBase")
+ ". "))
+ (entry (% (heading (code "GL_LIST_INDEX")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the name of the display list currently under construction.
+ 0 is returned if no display list is currently under
+ construction. The initial value is 0.
+ See "
+ (code "glNewList")
+ ". "))
+ (entry (% (heading (code "GL_LIST_MODE")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ a symbolic constant indicating the construction mode of the display list
+ currently under construction. The initial value is 0.
+ See "
+ (code "glNewList")
+ ". "))
+ (entry (% (heading (code "GL_LOGIC_OP_MODE")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ a symbolic constant indicating the selected logic operation
+ mode. The initial value is "
+ (code "GL_COPY")
+ ".
+ See "
+ (code "glLogicOp")
+ ". "))
+ (entry (% (heading (code "GL_MAP1_COLOR_4")))
+ (para)
+ (para (var "params")
+ " returns a single boolean value indicating whether
+ 1D evaluation generates colors. The initial value is "
+ (code "GL_FALSE")
+ ".
+ See "
+ (code "glMap1")
+ ". "))
+ (entry (% (heading (code "GL_MAP1_GRID_DOMAIN")))
+ (para)
+ (para (var "params")
+ " returns two values:
+ the endpoints of the 1D map's grid domain. The initial value is (0, 1).
+ See "
+ (code "glMapGrid")
+ ". "))
+ (entry (% (heading (code "GL_MAP1_GRID_SEGMENTS")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the number of partitions in the 1D map's grid domain. The initial value
+ is 1.
+ See "
+ (code "glMapGrid")
+ ". "))
+ (entry (% (heading (code "GL_MAP1_INDEX")))
+ (para)
+ (para (var "params")
+ " returns a single boolean value indicating whether
+ 1D evaluation generates color indices. The initial value is "
+ (code "GL_FALSE")
+ ".
+ See "
+ (code "glMap1")
+ ". "))
+ (entry (% (heading (code "GL_MAP1_NORMAL")))
+ (para)
+ (para (var "params")
+ " returns a single boolean value indicating whether
+ 1D evaluation generates normals. The initial value is "
+ (code "GL_FALSE")
+ ".
+ See "
+ (code "glMap1")
+ ". "))
+ (entry (% (heading (code "GL_MAP1_TEXTURE_COORD_1")))
+ (para)
+ (para (var "params")
+ " returns a single boolean value indicating whether
+ 1D evaluation generates 1D texture coordinates. The initial value is "
+ (code "GL_FALSE")
+ ".
+ See "
+ (code "glMap1")
+ ". "))
+ (entry (% (heading (code "GL_MAP1_TEXTURE_COORD_2")))
+ (para)
+ (para (var "params")
+ " returns a single boolean value indicating whether
+ 1D evaluation generates 2D texture coordinates. The initial value is "
+ (code "GL_FALSE")
+ ".
+ See "
+ (code "glMap1")
+ ". "))
+ (entry (% (heading (code "GL_MAP1_TEXTURE_COORD_3")))
+ (para)
+ (para (var "params")
+ " returns a single boolean value indicating whether
+ 1D evaluation generates 3D texture coordinates. The initial value is "
+ (code "GL_FALSE")
+ ".
+ See "
+ (code "glMap1")
+ ". "))
+ (entry (% (heading (code "GL_MAP1_TEXTURE_COORD_4")))
+ (para)
+ (para (var "params")
+ " returns a single boolean value indicating whether
+ 1D evaluation generates 4D texture coordinates. The initial value is "
+ (code "GL_FALSE")
+ ".
+ See "
+ (code "glMap1")
+ ". "))
+ (entry (% (heading (code "GL_MAP1_VERTEX_3")))
+ (para)
+ (para (var "params")
+ " returns a single boolean value indicating whether
+ 1D evaluation generates 3D vertex coordinates. The initial value is "
+ (code "GL_FALSE")
+ ".
+ See "
+ (code "glMap1")
+ ". "))
+ (entry (% (heading (code "GL_MAP1_VERTEX_4")))
+ (para)
+ (para (var "params")
+ " returns a single boolean value indicating whether
+ 1D evaluation generates 4D vertex coordinates. The initial value is "
+ (code "GL_FALSE")
+ ".
+ See "
+ (code "glMap1")
+ ". "))
+ (entry (% (heading (code "GL_MAP2_COLOR_4")))
+ (para)
+ (para (var "params")
+ " returns a single boolean value indicating whether
+ 2D evaluation generates colors. The initial value is "
+ (code "GL_FALSE")
+ ".
+ See "
+ (code "glMap2")
+ ". "))
+ (entry (% (heading (code "GL_MAP2_GRID_DOMAIN")))
+ (para)
+ (para (var "params")
+ " returns four values:
+ the endpoints of the 2D map's "
+ (math (var "i"))
+ "
+and "
+ (math (var "j"))
+ "
+grid domains. The initial value
+ is (0,1; 0,1).
+ See "
+ (code "glMapGrid")
+ ". "))
+ (entry (% (heading (code "GL_MAP2_GRID_SEGMENTS")))
+ (para)
+ (para (var "params")
+ " returns two values:
+ the number of partitions in the 2D map's "
+ (math (var "i"))
+ "
+and "
+ (math (var "j"))
+ "
+grid
+ domains. The initial value is (1,1).
+ See "
+ (code "glMapGrid")
+ ". "))
+ (entry (% (heading (code "GL_MAP2_INDEX")))
+ (para)
+ (para (var "params")
+ " returns a single boolean value indicating whether
+ 2D evaluation generates color indices. The initial value is "
+ (code "GL_FALSE")
+ ".
+ See "
+ (code "glMap2")
+ ". "))
+ (entry (% (heading (code "GL_MAP2_NORMAL")))
+ (para)
+ (para (var "params")
+ " returns a single boolean value indicating whether
+ 2D evaluation generates normals. The initial value is "
+ (code "GL_FALSE")
+ ".
+ See "
+ (code "glMap2")
+ ". "))
+ (entry (% (heading (code "GL_MAP2_TEXTURE_COORD_1")))
+ (para)
+ (para (var "params")
+ " returns a single boolean value indicating whether
+ 2D evaluation generates 1D texture coordinates. The initial value is "
+ (code "GL_FALSE")
+ ".
+ See "
+ (code "glMap2")
+ ". "))
+ (entry (% (heading (code "GL_MAP2_TEXTURE_COORD_2")))
+ (para)
+ (para (var "params")
+ " returns a single boolean value indicating whether
+ 2D evaluation generates 2D texture coordinates. The initial value is "
+ (code "GL_FALSE")
+ ".
+ See "
+ (code "glMap2")
+ ". "))
+ (entry (% (heading (code "GL_MAP2_TEXTURE_COORD_3")))
+ (para)
+ (para (var "params")
+ " returns a single boolean value indicating whether
+ 2D evaluation generates 3D texture coordinates. The initial value is "
+ (code "GL_FALSE")
+ ".
+ See "
+ (code "glMap2")
+ ". "))
+ (entry (% (heading (code "GL_MAP2_TEXTURE_COORD_4")))
+ (para)
+ (para (var "params")
+ " returns a single boolean value indicating whether
+ 2D evaluation generates 4D texture coordinates. The initial value is "
+ (code "GL_FALSE")
+ ".
+ See "
+ (code "glMap2")
+ ". "))
+ (entry (% (heading (code "GL_MAP2_VERTEX_3")))
+ (para)
+ (para (var "params")
+ " returns a single boolean value indicating whether
+ 2D evaluation generates 3D vertex coordinates. The initial value is "
+ (code "GL_FALSE")
+ ".
+ See "
+ (code "glMap2")
+ ". "))
+ (entry (% (heading (code "GL_MAP2_VERTEX_4")))
+ (para)
+ (para (var "params")
+ " returns a single boolean value indicating whether
+ 2D evaluation generates 4D vertex coordinates. The initial value is "
+ (code "GL_FALSE")
+ ".
+ See "
+ (code "glMap2")
+ ". "))
+ (entry (% (heading (code "GL_MAP_COLOR")))
+ (para)
+ (para (var "params")
+ " returns a single boolean value indicating if colors and
+ color indices are to be replaced by table lookup during pixel
+ transfers. The initial value is "
+ (code "GL_FALSE")
+ ".
+ See "
+ (code "glPixelTransfer")
+ ". "))
+ (entry (% (heading (code "GL_MAP_STENCIL")))
+ (para)
+ (para (var "params")
+ " returns a single boolean value indicating if stencil indices
+ are to be replaced by table lookup during pixel transfers. The initial
+ value is "
+ (code "GL_FALSE")
+ ".
+ See "
+ (code "glPixelTransfer")
+ ". "))
+ (entry (% (heading (code "GL_MATRIX_MODE")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ a symbolic constant indicating which matrix stack is currently the
+ target of all matrix operations. The initial value is "
+ (code "GL_MODELVIEW")
+ ".
+ See "
+ (code "glMatrixMode")
+ ". "))
+ (entry (% (heading (code "GL_MAX_3D_TEXTURE_SIZE")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ a rough estimate of the largest 3D texture that the GL can handle.
+ The value must be at least 16.
+ If the GL version is 1.2 or greater, use "
+ (code "GL_PROXY_TEXTURE_3D")
+ " to determine if a texture is too large.
+ See "
+ (code "glTexImage3D")
+ ". "))
+ (entry (% (heading
+ (code "GL_MAX_CLIENT_ATTRIB_STACK_DEPTH")))
+ (para)
+ (para (var "params")
+ " returns one value indicating the maximum supported depth
+ of the client attribute stack.
+ See "
+ (code "glPushClientAttrib")
+ ". "))
+ (entry (% (heading (code "GL_MAX_ATTRIB_STACK_DEPTH")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the maximum supported depth of the attribute stack. The value must be
+ at least 16.
+ See "
+ (code "glPushAttrib")
+ ". "))
+ (entry (% (heading (code "GL_MAX_CLIP_PLANES")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the maximum number of application-defined clipping planes. The value must be at least 6.
+ See "
+ (code "glClipPlane")
+ ". "))
+ (entry (% (heading
+ (code "GL_MAX_COLOR_MATRIX_STACK_DEPTH")))
+ (para)
+ (para (var "params")
+ " returns one value, the maximum supported depth of the color matrix
+ stack. The value must be at least 2.
+ See "
+ (code "glPushMatrix")
+ ". "))
+ (entry (% (heading
+ (code "GL_MAX_COMBINED_TEXTURE_IMAGE_UNITS")))
+ (para)
+ (para (var "params")
+ " returns one value, the maximum supported texture image units that
+ can be used to access texture maps from the vertex shader and the fragment processor combined.
+ If both the vertex shader and the fragment processing stage access the same texture image
+ unit, then that counts as using two texture image units against this limit.
+ The value must be at least 2.
+ See "
+ (code "glActiveTexture")
+ ". "))
+ (entry (% (heading (code "GL_MAX_CUBE_MAP_TEXTURE_SIZE")))
+ (para)
+ (para (var "params")
+ " returns one value.
+ The value gives a rough estimate of the largest cube-map texture that
+ the GL can handle. The value must be at least 16.
+ If the GL version is 1.3 or greater, use "
+ (code "GL_PROXY_TEXTURE_CUBE_MAP")
+ "
+to determine if a texture is too large.
+ See "
+ (code "glTexImage2D")
+ ". "))
+ (entry (% (heading (code "GL_MAX_DRAW_BUFFERS")))
+ (para)
+ (para (var "params")
+ " returns one value, the maximum number
+ of simultaneous output colors allowed from a fragment shader using the "
+ (code "gl_FragData")
+ " built-in array. The value must be at least 1.
+ See "
+ (code "glDrawBuffers")
+ ". "))
+ (entry (% (heading (code "GL_MAX_ELEMENTS_INDICES")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the recommended maximum number of vertex array indices.
+ See "
+ (code "glDrawRangeElements")
+ ". "))
+ (entry (% (heading (code "GL_MAX_ELEMENTS_VERTICES")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the recommended maximum number of vertex array vertices.
+ See "
+ (code "glDrawRangeElements")
+ ". "))
+ (entry (% (heading (code "GL_MAX_EVAL_ORDER")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the maximum equation order supported by 1D and 2D
+ evaluators. The value must be at least 8.
+ See "
+ (code "glMap1")
+ " and "
+ (code "glMap2")
+ ". "))
+ (entry (% (heading
+ (code "GL_MAX_FRAGMENT_UNIFORM_COMPONENTS")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the maximum number of individual floating-point, integer, or boolean values that can be held
+ in uniform variable storage for a fragment shader. The value must be at least 64.
+ See "
+ (code "glUniform")
+ ". "))
+ (entry (% (heading (code "GL_MAX_LIGHTS")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the maximum number of lights. The value must be at least 8.
+ See "
+ (code "glLight")
+ ". "))
+ (entry (% (heading (code "GL_MAX_LIST_NESTING")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the maximum recursion depth allowed during display-list
+ traversal. The value must be at least 64.
+ See "
+ (code "glCallList")
+ ". "))
+ (entry (% (heading (code "GL_MAX_MODELVIEW_STACK_DEPTH")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the maximum supported depth of the modelview matrix stack. The value must
+ be at least 32.
+ See "
+ (code "glPushMatrix")
+ ". "))
+ (entry (% (heading (code "GL_MAX_NAME_STACK_DEPTH")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the maximum supported depth of the selection name stack. The value must be at least 64.
+ See "
+ (code "glPushName")
+ ". "))
+ (entry (% (heading (code "GL_MAX_PIXEL_MAP_TABLE")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the maximum supported size of a "
+ (code "glPixelMap")
+ " lookup table.
+ The value must be at least 32.
+ See "
+ (code "glPixelMap")
+ ". "))
+ (entry (% (heading (code "GL_MAX_PROJECTION_STACK_DEPTH")))
+ (para)
+ (para (var "params")
+ " returns one value, the maximum supported depth of the projection
+ matrix stack. The value must be at least 2.
+ See "
+ (code "glPushMatrix")
+ ". "))
+ (entry (% (heading (code "GL_MAX_TEXTURE_COORDS")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the maximum number of texture coordinate sets available to vertex and fragment shaders.
+ The value must be at least 2.
+ See "
+ (code "glActiveTexture")
+ " and "
+ (code "glClientActiveTexture")
+ ". "))
+ (entry (% (heading (code "GL_MAX_TEXTURE_IMAGE_UNITS")))
+ (para)
+ (para (var "params")
+ " returns one value, the maximum supported texture image units that
+ can be used to access texture maps from the fragment shader.
+ The value must be at least 2.
+ See "
+ (code "glActiveTexture")
+ ". "))
+ (entry (% (heading (code "GL_MAX_TEXTURE_LOD_BIAS")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the maximum, absolute value of the texture level-of-detail bias. The
+ value must be at least 4. "))
+ (entry (% (heading (code "GL_MAX_TEXTURE_SIZE")))
+ (para)
+ (para (var "params")
+ " returns one value.
+ The value gives a rough estimate of the largest texture that
+ the GL can handle. The value must be at least 64.
+ If the GL version is 1.1 or greater, use "
+ (code "GL_PROXY_TEXTURE_1D")
+ " or "
+ (code "GL_PROXY_TEXTURE_2D")
+ "
+to determine if a texture is too large.
+ See "
+ (code "glTexImage1D")
+ " and "
+ (code "glTexImage2D")
+ ". "))
+ (entry (% (heading (code "GL_MAX_TEXTURE_STACK_DEPTH")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the maximum supported depth of the texture matrix stack. The value must be at least 2.
+ See "
+ (code "glPushMatrix")
+ ". "))
+ (entry (% (heading (code "GL_MAX_TEXTURE_UNITS")))
+ (para)
+ (para (var "params")
+ " returns a single value indicating the number of conventional
+ texture units supported. Each conventional texture unit includes both a texture coordinate set
+ and a texture image unit. Conventional texture units may be used for fixed-function (non-shader)
+ rendering. The value must be at least 2. Additional texture coordinate sets and texture
+ image units may be accessed from vertex and fragment shaders.
+ See "
+ (code "glActiveTexture")
+ " and "
+ (code "glClientActiveTexture")
+ ". "))
+ (entry (% (heading (code "GL_MAX_VARYING_FLOATS")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the maximum number of interpolators available for processing varying variables used by
+ vertex and fragment shaders. This value represents the number of individual floating-point
+ values that can be interpolated; varying variables declared as vectors, matrices, and arrays
+ will all consume multiple interpolators. The value must be at least 32. "))
+ (entry (% (heading (code "GL_MAX_VERTEX_ATTRIBS")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the maximum number of 4-component generic vertex attributes accessible to a vertex shader.
+ The value must be at least 16.
+ See "
+ (code "glVertexAttrib")
+ ". "))
+ (entry (% (heading
+ (code "GL_MAX_VERTEX_TEXTURE_IMAGE_UNITS")))
+ (para)
+ (para (var "params")
+ " returns one value, the maximum supported texture image units that
+ can be used to access texture maps from the vertex shader. The value may be 0.
+ See "
+ (code "glActiveTexture")
+ ". "))
+ (entry (% (heading
+ (code "GL_MAX_VERTEX_UNIFORM_COMPONENTS")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the maximum number of individual floating-point, integer, or boolean values that can be held
+ in uniform variable storage for a vertex shader. The value must be at least 512.
+ See "
+ (code "glUniform")
+ ". "))
+ (entry (% (heading (code "GL_MAX_VIEWPORT_DIMS")))
+ (para)
+ (para (var "params")
+ " returns two values:
+ the maximum supported width and height of the viewport.
+ These must be at least as large as the visible dimensions of the display
+ being rendered to.
+ See "
+ (code "glViewport")
+ ". "))
+ (entry (% (heading (code "GL_MINMAX")))
+ (para)
+ (para (var "params")
+ " returns a single boolean value indicating whether pixel minmax
+ values are computed. The initial value is "
+ (code "GL_FALSE")
+ ".
+ See "
+ (code "glMinmax")
+ ". "))
+ (entry (% (heading (code "GL_MODELVIEW_MATRIX")))
+ (para)
+ (para (var "params")
+ " returns sixteen values:
+ the modelview matrix on the top of the modelview matrix stack. Initially
+ this matrix is the identity matrix.
+ See "
+ (code "glPushMatrix")
+ ". "))
+ (entry (% (heading (code "GL_MODELVIEW_STACK_DEPTH")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the number of matrices on the modelview matrix stack.
+ The initial value is 1.
+ See "
+ (code "glPushMatrix")
+ ". "))
+ (entry (% (heading (code "GL_NAME_STACK_DEPTH")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the number of names on the selection name stack. The initial value is 0.
+ See "
+ (code "glPushName")
+ ". "))
+ (entry (% (heading (code "GL_NORMAL_ARRAY")))
+ (para)
+ (para (var "params")
+ " returns a single boolean value, indicating whether the normal
+ array is enabled. The initial value is "
+ (code "GL_FALSE")
+ ".
+ See "
+ (code "glNormalPointer")
+ ". "))
+ (entry (% (heading (code "GL_NORMAL_ARRAY_BUFFER_BINDING")))
+ (para)
+ (para (var "params")
+ " returns a single value, the name of the buffer object
+ associated with the normal array. This buffer object would have been bound to the
+ target "
+ (code "GL_ARRAY_BUFFER")
+ " at the time of the most recent call to "
+ (code "glNormalPointer")
+ ".
+ If no buffer object was bound to this target, 0 is returned. The initial value is 0.
+ See "
+ (code "glBindBuffer")
+ ". "))
+ (entry (% (heading (code "GL_NORMAL_ARRAY_STRIDE")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the byte offset between consecutive normals in the normal
+ array. The initial value is 0.
+ See "
+ (code "glNormalPointer")
+ ". "))
+ (entry (% (heading (code "GL_NORMAL_ARRAY_TYPE")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the data type of each coordinate in the normal array. The initial value is "
+ (code "GL_FLOAT")
+ ".
+ See "
+ (code "glNormalPointer")
+ ". "))
+ (entry (% (heading (code "GL_NORMALIZE")))
+ (para)
+ (para (var "params")
+ " returns a single boolean value indicating whether normals are
+ automatically scaled to unit length after they have been transformed to
+ eye coordinates. The initial value is "
+ (code "GL_FALSE")
+ ".
+ See "
+ (code "glNormal")
+ ". "))
+ (entry (% (heading
+ (code "GL_NUM_COMPRESSED_TEXTURE_FORMATS")))
+ (para)
+ (para (var "params")
+ " returns a single integer value indicating the number of available
+ compressed texture formats. The minimum value is 0.
+ See "
+ (code "glCompressedTexImage2D")
+ ". "))
+ (entry (% (heading (code "GL_PACK_ALIGNMENT")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the byte alignment used for writing pixel data to memory. The initial
+ value is 4.
+ See "
+ (code "glPixelStore")
+ ". "))
+ (entry (% (heading (code "GL_PACK_IMAGE_HEIGHT")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the image height used for writing pixel data to memory. The initial
+ value is 0.
+ See "
+ (code "glPixelStore")
+ ". "))
+ (entry (% (heading (code "GL_PACK_LSB_FIRST")))
+ (para)
+ (para (var "params")
+ " returns a single boolean value indicating whether single-bit
+ pixels being written to memory are written first to the least significant
+ bit of each unsigned byte. The initial value is "
+ (code "GL_FALSE")
+ ".
+ See "
+ (code "glPixelStore")
+ ". "))
+ (entry (% (heading (code "GL_PACK_ROW_LENGTH")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the row length used for writing pixel data to memory. The initial value is
+ 0.
+ See "
+ (code "glPixelStore")
+ ". "))
+ (entry (% (heading (code "GL_PACK_SKIP_IMAGES")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the number of pixel images skipped before the first pixel is written
+ into memory. The initial value is 0.
+ See "
+ (code "glPixelStore")
+ ". "))
+ (entry (% (heading (code "GL_PACK_SKIP_PIXELS")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the number of pixel locations skipped before the first pixel is written
+ into memory. The initial value is 0.
+ See "
+ (code "glPixelStore")
+ ". "))
+ (entry (% (heading (code "GL_PACK_SKIP_ROWS")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the number of rows of pixel locations skipped before the first pixel is written
+ into memory. The initial value is 0.
+ See "
+ (code "glPixelStore")
+ ". "))
+ (entry (% (heading (code "GL_PACK_SWAP_BYTES")))
+ (para)
+ (para (var "params")
+ " returns a single boolean value indicating whether the bytes of
+ two-byte and four-byte pixel indices and components are swapped before being
+ written to memory. The initial value is "
+ (code "GL_FALSE")
+ ".
+ See "
+ (code "glPixelStore")
+ ". "))
+ (entry (% (heading (code "GL_PERSPECTIVE_CORRECTION_HINT")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ a symbolic constant indicating the mode of the perspective correction
+ hint. The initial value is "
+ (code "GL_DONT_CARE")
+ ".
+ See "
+ (code "glHint")
+ ". "))
+ (entry (% (heading (code "GL_PIXEL_MAP_A_TO_A_SIZE")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the size of the alpha-to-alpha pixel translation table.
+ The initial value is 1.
+ See "
+ (code "glPixelMap")
+ ". "))
+ (entry (% (heading (code "GL_PIXEL_MAP_B_TO_B_SIZE")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the size of the blue-to-blue pixel translation table.
+ The initial value is 1.
+ See "
+ (code "glPixelMap")
+ ". "))
+ (entry (% (heading (code "GL_PIXEL_MAP_G_TO_G_SIZE")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the size of the green-to-green pixel translation table.
+ The initial value is 1.
+ See "
+ (code "glPixelMap")
+ ". "))
+ (entry (% (heading (code "GL_PIXEL_MAP_I_TO_A_SIZE")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the size of the index-to-alpha pixel translation table.
+ The initial value is 1.
+ See "
+ (code "glPixelMap")
+ ". "))
+ (entry (% (heading (code "GL_PIXEL_MAP_I_TO_B_SIZE")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the size of the index-to-blue pixel translation table.
+ The initial value is 1.
+ See "
+ (code "glPixelMap")
+ ". "))
+ (entry (% (heading (code "GL_PIXEL_MAP_I_TO_G_SIZE")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the size of the index-to-green pixel translation table.
+ The initial value is 1.
+ See "
+ (code "glPixelMap")
+ ". "))
+ (entry (% (heading (code "GL_PIXEL_MAP_I_TO_I_SIZE")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the size of the index-to-index pixel translation table.
+ The initial value is 1.
+ See "
+ (code "glPixelMap")
+ ". "))
+ (entry (% (heading (code "GL_PIXEL_MAP_I_TO_R_SIZE")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the size of the index-to-red pixel translation table.
+ The initial value is 1.
+ See "
+ (code "glPixelMap")
+ ". "))
+ (entry (% (heading (code "GL_PIXEL_MAP_R_TO_R_SIZE")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the size of the red-to-red pixel translation table.
+ The initial value is 1.
+ See "
+ (code "glPixelMap")
+ ". "))
+ (entry (% (heading (code "GL_PIXEL_MAP_S_TO_S_SIZE")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the size of the stencil-to-stencil pixel translation table.
+ The initial value is 1.
+ See "
+ (code "glPixelMap")
+ ". "))
+ (entry (% (heading (code "GL_PIXEL_PACK_BUFFER_BINDING")))
+ (para)
+ (para (var "params")
+ " returns a single value, the name of the buffer object
+ currently bound to the target "
+ (code "GL_PIXEL_PACK_BUFFER")
+ ". If no buffer object
+ is bound to this target, 0 is returned. The initial value is 0.
+ See "
+ (code "glBindBuffer")
+ ". "))
+ (entry (% (heading (code "GL_PIXEL_UNPACK_BUFFER_BINDING")))
+ (para)
+ (para (var "params")
+ " returns a single value, the name of the buffer object
+ currently bound to the target "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ ". If no buffer object
+ is bound to this target, 0 is returned. The initial value is 0.
+ See "
+ (code "glBindBuffer")
+ ". "))
+ (entry (% (heading (code "GL_POINT_DISTANCE_ATTENUATION")))
+ (para)
+ (para (var "params")
+ " returns three values,
+ the coefficients for computing the attenuation value for points.
+ See "
+ (code "glPointParameter")
+ ". "))
+ (entry (% (heading (code "GL_POINT_FADE_THRESHOLD_SIZE")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the point size threshold for determining the point size.
+ See "
+ (code "glPointParameter")
+ ". "))
+ (entry (% (heading (code "GL_POINT_SIZE")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the point size as specified by "
+ (code "glPointSize")
+ ". The initial value is 1. "))
+ (entry (% (heading (code "GL_POINT_SIZE_GRANULARITY")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the size difference between adjacent supported sizes for antialiased points.
+ See "
+ (code "glPointSize")
+ ". "))
+ (entry (% (heading (code "GL_POINT_SIZE_MAX")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the upper bound for the attenuated point sizes. The initial value is 0.0.
+ See "
+ (code "glPointParameter")
+ ". "))
+ (entry (% (heading (code "GL_POINT_SIZE_MIN")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the lower bound for the attenuated point sizes. The initial value is 1.0.
+ See "
+ (code "glPointParameter")
+ ". "))
+ (entry (% (heading (code "GL_POINT_SIZE_RANGE")))
+ (para)
+ (para (var "params")
+ " returns two values:
+ the smallest and largest supported sizes for antialiased
+ points. The smallest size must be at most 1, and the largest size must
+ be at least 1.
+ See "
+ (code "glPointSize")
+ ". "))
+ (entry (% (heading (code "GL_POINT_SMOOTH")))
+ (para)
+ (para (var "params")
+ " returns a single boolean value indicating whether antialiasing of
+ points is enabled. The initial value is "
+ (code "GL_FALSE")
+ ".
+ See "
+ (code "glPointSize")
+ ". "))
+ (entry (% (heading (code "GL_POINT_SMOOTH_HINT")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ a symbolic constant indicating the mode of the point antialiasing
+ hint. The initial value is "
+ (code "GL_DONT_CARE")
+ ".
+ See "
+ (code "glHint")
+ ". "))
+ (entry (% (heading (code "GL_POINT_SPRITE")))
+ (para)
+ (para (var "params")
+ " returns a single boolean value indicating whether point sprite is
+ enabled. The initial value is "
+ (code "GL_FALSE")
+ ". "))
+ (entry (% (heading (code "GL_POLYGON_MODE")))
+ (para)
+ (para (var "params")
+ " returns two values:
+ symbolic constants indicating whether front-facing and back-facing polygons
+ are rasterized as points, lines, or filled polygons. The initial value is "
+ (code "GL_FILL")
+ ".
+ See "
+ (code "glPolygonMode")
+ ". "))
+ (entry (% (heading (code "GL_POLYGON_OFFSET_FACTOR")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the scaling factor used to determine the variable offset that is added
+ to the depth value of each fragment generated when a polygon is
+ rasterized. The initial value is 0.
+ See "
+ (code "glPolygonOffset")
+ ". "))
+ (entry (% (heading (code "GL_POLYGON_OFFSET_UNITS")))
+ (para)
+ (para (var "params")
+ " returns one value.
+ This value is multiplied by an implementation-specific value and then
+ added to the depth value of each fragment
+ generated when a polygon is rasterized. The initial value is 0.
+ See "
+ (code "glPolygonOffset")
+ ". "))
+ (entry (% (heading (code "GL_POLYGON_OFFSET_FILL")))
+ (para)
+ (para (var "params")
+ " returns a single boolean value indicating whether polygon offset
+ is enabled for polygons in fill mode. The initial value is "
+ (code "GL_FALSE")
+ ".
+ See "
+ (code "glPolygonOffset")
+ ". "))
+ (entry (% (heading (code "GL_POLYGON_OFFSET_LINE")))
+ (para)
+ (para (var "params")
+ " returns a single boolean value indicating whether polygon offset
+ is enabled for polygons in line mode. The initial value is "
+ (code "GL_FALSE")
+ ".
+ See "
+ (code "glPolygonOffset")
+ ". "))
+ (entry (% (heading (code "GL_POLYGON_OFFSET_POINT")))
+ (para)
+ (para (var "params")
+ " returns a single boolean value indicating whether polygon offset
+ is enabled for polygons in point mode. The initial value is "
+ (code "GL_FALSE")
+ ".
+ See "
+ (code "glPolygonOffset")
+ ". "))
+ (entry (% (heading (code "GL_POLYGON_SMOOTH")))
+ (para)
+ (para (var "params")
+ " returns a single boolean value indicating whether antialiasing of
+ polygons is enabled. The initial value is "
+ (code "GL_FALSE")
+ ".
+ See "
+ (code "glPolygonMode")
+ ". "))
+ (entry (% (heading (code "GL_POLYGON_SMOOTH_HINT")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ a symbolic constant indicating the mode of the polygon antialiasing
+ hint. The initial value is "
+ (code "GL_DONT_CARE")
+ ".
+ See "
+ (code "glHint")
+ ". "))
+ (entry (% (heading (code "GL_POLYGON_STIPPLE")))
+ (para)
+ (para (var "params")
+ " returns a single boolean value indicating whether polygon
+ stippling is enabled. The initial value is "
+ (code "GL_FALSE")
+ ".
+ See "
+ (code "glPolygonStipple")
+ ". "))
+ (entry (% (heading
+ (code "GL_POST_COLOR_MATRIX_COLOR_TABLE")))
+ (para)
+ (para (var "params")
+ " returns a single boolean value indicating whether post color
+ matrix transformation lookup is enabled.
+ The initial value is "
+ (code "GL_FALSE")
+ ".
+ See "
+ (code "glColorTable")
+ ". "))
+ (entry (% (heading (code "GL_POST_COLOR_MATRIX_RED_BIAS")))
+ (para)
+ (para (var "params")
+ " returns one value, the red bias factor applied to RGBA fragments
+ after color matrix transformations.
+ The initial value is 0.
+ See "
+ (code "glPixelTransfer")
+ ". "))
+ (entry (% (heading
+ (code "GL_POST_COLOR_MATRIX_GREEN_BIAS")))
+ (para)
+ (para (var "params")
+ " returns one value, the green bias factor applied to RGBA fragments
+ after color matrix transformations.
+ The initial value is 0.
+ See "
+ (code "glPixelTransfer")))
+ (entry (% (heading (code "GL_POST_COLOR_MATRIX_BLUE_BIAS")))
+ (para)
+ (para (var "params")
+ " returns one value, the blue bias factor applied to RGBA fragments
+ after color matrix transformations.
+ The initial value is 0.
+ See "
+ (code "glPixelTransfer")
+ ". "))
+ (entry (% (heading
+ (code "GL_POST_COLOR_MATRIX_ALPHA_BIAS")))
+ (para)
+ (para (var "params")
+ " returns one value, the alpha bias factor applied to RGBA fragments
+ after color matrix transformations.
+ The initial value is 0.
+ See "
+ (code "glPixelTransfer")
+ ". "))
+ (entry (% (heading (code "GL_POST_COLOR_MATRIX_RED_SCALE")))
+ (para)
+ (para (var "params")
+ " returns one value, the red scale factor applied to RGBA fragments
+ after color matrix transformations.
+ The initial value is 1.
+ See "
+ (code "glPixelTransfer")
+ ". "))
+ (entry (% (heading
+ (code "GL_POST_COLOR_MATRIX_GREEN_SCALE")))
+ (para)
+ (para (var "params")
+ " returns one value, the green scale factor applied to RGBA fragments
+ after color matrix transformations.
+ The initial value is 1.
+ See "
+ (code "glPixelTransfer")
+ ". "))
+ (entry (% (heading
+ (code "GL_POST_COLOR_MATRIX_BLUE_SCALE")))
+ (para)
+ (para (var "params")
+ " returns one value, the blue scale factor applied to RGBA fragments
+ after color matrix transformations.
+ The initial value is 1.
+ See "
+ (code "glPixelTransfer")
+ ". "))
+ (entry (% (heading
+ (code "GL_POST_COLOR_MATRIX_ALPHA_SCALE")))
+ (para)
+ (para (var "params")
+ " returns one value, the alpha scale factor applied to RGBA fragments
+ after color matrix transformations.
+ The initial value is 1.
+ See "
+ (code "glPixelTransfer")
+ ". "))
+ (entry (% (heading
+ (code "GL_POST_CONVOLUTION_COLOR_TABLE")))
+ (para)
+ (para (var "params")
+ " returns a single boolean value indicating whether post convolution
+ lookup is enabled. The initial value is "
+ (code "GL_FALSE")
+ ".
+ See "
+ (code "glColorTable")
+ ". "))
+ (entry (% (heading (code "GL_POST_CONVOLUTION_RED_BIAS")))
+ (para)
+ (para (var "params")
+ " returns one value, the red bias factor applied to RGBA fragments
+ after convolution. The initial value is 0.
+ See "
+ (code "glPixelTransfer")
+ ". "))
+ (entry (% (heading (code "GL_POST_CONVOLUTION_GREEN_BIAS")))
+ (para)
+ (para (var "params")
+ " returns one value, the green bias factor applied to RGBA fragments
+ after convolution. The initial value is 0.
+ See "
+ (code "glPixelTransfer")
+ ". "))
+ (entry (% (heading (code "GL_POST_CONVOLUTION_BLUE_BIAS")))
+ (para)
+ (para (var "params")
+ " returns one value, the blue bias factor applied to RGBA fragments
+ after convolution. The initial value is 0.
+ See "
+ (code "glPixelTransfer")
+ ". "))
+ (entry (% (heading (code "GL_POST_CONVOLUTION_ALPHA_BIAS")))
+ (para)
+ (para (var "params")
+ " returns one value, the alpha bias factor applied to RGBA fragments
+ after convolution. The initial value is 0.
+ See "
+ (code "glPixelTransfer")
+ ". "))
+ (entry (% (heading (code "GL_POST_CONVOLUTION_RED_SCALE")))
+ (para)
+ (para (var "params")
+ " returns one value, the red scale factor applied to RGBA fragments
+ after convolution. The initial value is 1.
+ See "
+ (code "glPixelTransfer")
+ ". "))
+ (entry (% (heading
+ (code "GL_POST_CONVOLUTION_GREEN_SCALE")))
+ (para)
+ (para (var "params")
+ " returns one value, the green scale factor applied to RGBA fragments
+ after convolution. The initial value is 1.
+ See "
+ (code "glPixelTransfer")
+ ". "))
+ (entry (% (heading (code "GL_POST_CONVOLUTION_BLUE_SCALE")))
+ (para)
+ (para (var "params")
+ " returns one value, the blue scale factor applied to RGBA fragments
+ after convolution. The initial value is 1.
+ See "
+ (code "glPixelTransfer")
+ ". "))
+ (entry (% (heading
+ (code "GL_POST_CONVOLUTION_ALPHA_SCALE")))
+ (para)
+ (para (var "params")
+ " returns one value, the alpha scale factor applied to RGBA fragments
+ after convolution. The initial value is 1.
+ See "
+ (code "glPixelTransfer")
+ ". "))
+ (entry (% (heading (code "GL_PROJECTION_MATRIX")))
+ (para)
+ (para (var "params")
+ " returns sixteen values:
+ the projection matrix on the top of the projection matrix
+ stack. Initially this matrix is the identity matrix.
+ See "
+ (code "glPushMatrix")
+ ". "))
+ (entry (% (heading (code "GL_PROJECTION_STACK_DEPTH")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the number of matrices on the projection matrix stack.
+ The initial value is 1.
+ See "
+ (code "glPushMatrix")
+ ". "))
+ (entry (% (heading (code "GL_READ_BUFFER")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ a symbolic constant indicating which color buffer is selected for
+ reading. The initial value is "
+ (code "GL_BACK")
+ " if there is a back buffer,
+ otherwise it is "
+ (code "GL_FRONT")
+ ".
+ See "
+ (code "glReadPixels")
+ " and "
+ (code "glAccum")
+ ". "))
+ (entry (% (heading (code "GL_RED_BIAS")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the red bias factor used during pixel transfers. The initial value is 0. "))
+ (entry (% (heading (code "GL_RED_BITS")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the number of red bitplanes in each color buffer. "))
+ (entry (% (heading (code "GL_RED_SCALE")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the red scale factor used during pixel transfers. The initial value is 1.
+ See "
+ (code "glPixelTransfer")
+ ". "))
+ (entry (% (heading (code "GL_RENDER_MODE")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ a symbolic constant indicating whether the GL is in render,
+ select,
+ or feedback mode. The initial value is "
+ (code "GL_RENDER")
+ ".
+ See "
+ (code "glRenderMode")
+ ". "))
+ (entry (% (heading (code "GL_RESCALE_NORMAL")))
+ (para)
+ (para (var "params")
+ " returns single boolean value
+ indicating whether normal rescaling is enabled.
+ See "
+ (code "glEnable")
+ ". "))
+ (entry (% (heading (code "GL_RGBA_MODE")))
+ (para)
+ (para (var "params")
+ " returns a single boolean value indicating whether the GL is in RGBA
+ mode (true) or color index mode (false).
+ See "
+ (code "glColor")
+ ". "))
+ (entry (% (heading (code "GL_SAMPLE_BUFFERS")))
+ (para)
+ (para (var "params")
+ " returns a single integer value indicating the number of sample buffers
+ associated with the framebuffer.
+ See "
+ (code "glSampleCoverage")
+ ". "))
+ (entry (% (heading (code "GL_SAMPLE_COVERAGE_VALUE")))
+ (para)
+ (para (var "params")
+ " returns a single positive floating-point value indicating the
+ current sample coverage value.
+ See "
+ (code "glSampleCoverage")
+ ". "))
+ (entry (% (heading (code "GL_SAMPLE_COVERAGE_INVERT")))
+ (para)
+ (para (var "params")
+ " returns a single boolean value indicating if the temporary
+ coverage value should be inverted.
+ See "
+ (code "glSampleCoverage")
+ ". "))
+ (entry (% (heading (code "GL_SAMPLES")))
+ (para)
+ (para (var "params")
+ " returns a single integer value indicating the coverage mask size.
+ See "
+ (code "glSampleCoverage")
+ ". "))
+ (entry (% (heading (code "GL_SCISSOR_BOX")))
+ (para)
+ (para (var "params")
+ " returns four values:
+ the "
+ (math (var "x"))
+ "
+and "
+ (math (var "y"))
+ "
+window coordinates of the scissor box,
+ followed by its width and height.
+ Initially the "
+ (math (var "x"))
+ "
+and "
+ (math (var "y"))
+ "
+window coordinates are both 0 and the
+ width and height are set to the size of the window.
+ See "
+ (code "glScissor")
+ ". "))
+ (entry (% (heading (code "GL_SCISSOR_TEST")))
+ (para)
+ (para (var "params")
+ " returns a single boolean value indicating whether scissoring is
+ enabled. The initial value is "
+ (code "GL_FALSE")
+ ".
+ See "
+ (code "glScissor")
+ ". "))
+ (entry (% (heading (code "GL_SECONDARY_COLOR_ARRAY")))
+ (para)
+ (para (var "params")
+ " returns a single boolean value indicating whether the secondary color array is enabled. The initial value is "
+ (code "GL_FALSE")
+ ".
+ See "
+ (code "glSecondaryColorPointer")
+ ". "))
+ (entry (% (heading
+ (code "GL_SECONDARY_COLOR_ARRAY_BUFFER_BINDING")))
+ (para)
+ (para (var "params")
+ " returns a single value, the name of the buffer object
+ associated with the secondary color array. This buffer object would have been bound to the
+ target "
+ (code "GL_ARRAY_BUFFER")
+ " at the time of the most recent call to "
+ (code "glSecondaryColorPointer")
+ ".
+ If no buffer object was bound to this target, 0 is returned. The initial value is 0.
+ See "
+ (code "glBindBuffer")
+ ". "))
+ (entry (% (heading (code "GL_SECONDARY_COLOR_ARRAY_SIZE")))
+ (para)
+ (para (var "params")
+ " returns one value, the number of components per color in the
+ secondary color array. The initial value is 3.
+ See "
+ (code "glSecondaryColorPointer")
+ ". "))
+ (entry (% (heading
+ (code "GL_SECONDARY_COLOR_ARRAY_STRIDE")))
+ (para)
+ (para (var "params")
+ " returns one value, the byte offset between consecutive colors in
+ the secondary color array. The initial value is 0.
+ See "
+ (code "glSecondaryColorPointer")
+ ". "))
+ (entry (% (heading (code "GL_SECONDARY_COLOR_ARRAY_TYPE")))
+ (para)
+ (para (var "params")
+ " returns one value, the data type of each component in the secondary
+ color array. The initial value is "
+ (code "GL_FLOAT")
+ ".
+ See "
+ (code "glSecondaryColorPointer")
+ ". "))
+ (entry (% (heading (code "GL_SELECTION_BUFFER_SIZE")))
+ (para)
+ (para (var "params")
+ " return one value,
+ the size of the selection buffer.
+ See "
+ (code "glSelectBuffer")
+ ". "))
+ (entry (% (heading (code "GL_SEPARABLE_2D")))
+ (para)
+ (para (var "params")
+ " returns a single boolean value indicating whether 2D separable
+ convolution is enabled. The initial value is "
+ (code "GL_FALSE")
+ ".
+ See "
+ (code "glSeparableFilter2D")
+ ". "))
+ (entry (% (heading (code "GL_SHADE_MODEL")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ a symbolic constant indicating whether the shading mode is flat or
+ smooth. The initial value is "
+ (code "GL_SMOOTH")
+ ".
+ See "
+ (code "glShadeModel")
+ ". "))
+ (entry (% (heading (code "GL_SMOOTH_LINE_WIDTH_RANGE")))
+ (para)
+ (para (var "params")
+ " returns two values,
+ the smallest and largest supported widths for antialiased lines.
+ See "
+ (code "glLineWidth")
+ ". "))
+ (entry (% (heading
+ (code "GL_SMOOTH_LINE_WIDTH_GRANULARITY")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the granularity of widths for antialiased lines.
+ See "
+ (code "glLineWidth")
+ ". "))
+ (entry (% (heading (code "GL_SMOOTH_POINT_SIZE_RANGE")))
+ (para)
+ (para (var "params")
+ " returns two values,
+ the smallest and largest supported widths for antialiased points.
+ See "
+ (code "glPointSize")
+ ". "))
+ (entry (% (heading
+ (code "GL_SMOOTH_POINT_SIZE_GRANULARITY")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the granularity of sizes for antialiased points.
+ See "
+ (code "glPointSize")
+ ". "))
+ (entry (% (heading (code "GL_STENCIL_BACK_FAIL")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ a symbolic constant indicating what action is taken for back-facing polygons when the stencil
+ test fails. The initial value is "
+ (code "GL_KEEP")
+ ".
+ See "
+ (code "glStencilOpSeparate")
+ ". "))
+ (entry (% (heading (code "GL_STENCIL_BACK_FUNC")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ a symbolic constant indicating what function is used for back-facing polygons to compare the
+ stencil reference value with the stencil buffer value. The initial value
+ is "
+ (code "GL_ALWAYS")
+ ".
+ See "
+ (code "glStencilFuncSeparate")
+ ". "))
+ (entry (% (heading
+ (code "GL_STENCIL_BACK_PASS_DEPTH_FAIL")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ a symbolic constant indicating what action is taken for back-facing polygons when the stencil
+ test passes,
+ but the depth test fails. The initial value is "
+ (code "GL_KEEP")
+ ".
+ See "
+ (code "glStencilOpSeparate")
+ ". "))
+ (entry (% (heading
+ (code "GL_STENCIL_BACK_PASS_DEPTH_PASS")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ a symbolic constant indicating what action is taken for back-facing polygons when the stencil
+ test passes and the depth test passes. The initial value is "
+ (code "GL_KEEP")
+ ".
+ See "
+ (code "glStencilOpSeparate")
+ ". "))
+ (entry (% (heading (code "GL_STENCIL_BACK_REF")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the reference value that is compared with the contents of the stencil
+ buffer for back-facing polygons. The initial value is 0.
+ See "
+ (code "glStencilFuncSeparate")
+ ". "))
+ (entry (% (heading (code "GL_STENCIL_BACK_VALUE_MASK")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the mask that is used for back-facing polygons to mask both the stencil reference value and the
+ stencil buffer value before they are compared. The initial value is all 1's.
+ See "
+ (code "glStencilFuncSeparate")
+ ". "))
+ (entry (% (heading (code "GL_STENCIL_BACK_WRITEMASK")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the mask that controls writing of the stencil bitplanes for back-facing polygons. The initial value
+ is all 1's.
+ See "
+ (code "glStencilMaskSeparate")
+ ". "))
+ (entry (% (heading (code "GL_STENCIL_BITS")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the number of bitplanes in the stencil buffer. "))
+ (entry (% (heading (code "GL_STENCIL_CLEAR_VALUE")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the index to which the stencil bitplanes are cleared. The initial value is
+ 0.
+ See "
+ (code "glClearStencil")
+ ". "))
+ (entry (% (heading (code "GL_STENCIL_FAIL")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ a symbolic constant indicating what action is taken when the stencil
+ test fails. The initial value is "
+ (code "GL_KEEP")
+ ".
+ See "
+ (code "glStencilOp")
+ ".
+ If the GL version is 2.0 or greater, this stencil state only affects non-polygons
+ and front-facing polygons. Back-facing polygons use separate stencil state.
+ See "
+ (code "glStencilOpSeparate")
+ ". "))
+ (entry (% (heading (code "GL_STENCIL_FUNC")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ a symbolic constant indicating what function is used to compare the
+ stencil reference value with the stencil buffer value. The initial value
+ is "
+ (code "GL_ALWAYS")
+ ".
+ See "
+ (code "glStencilFunc")
+ ".
+ If the GL version is 2.0 or greater, this stencil state only affects non-polygons
+ and front-facing polygons. Back-facing polygons use separate stencil state.
+ See "
+ (code "glStencilFuncSeparate")
+ ". "))
+ (entry (% (heading (code "GL_STENCIL_PASS_DEPTH_FAIL")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ a symbolic constant indicating what action is taken when the stencil
+ test passes,
+ but the depth test fails. The initial value is "
+ (code "GL_KEEP")
+ ".
+ See "
+ (code "glStencilOp")
+ ".
+ If the GL version is 2.0 or greater, this stencil state only affects non-polygons
+ and front-facing polygons. Back-facing polygons use separate stencil state.
+ See "
+ (code "glStencilOpSeparate")
+ ". "))
+ (entry (% (heading (code "GL_STENCIL_PASS_DEPTH_PASS")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ a symbolic constant indicating what action is taken when the stencil
+ test passes and the depth test passes. The initial value is "
+ (code "GL_KEEP")
+ ".
+ See "
+ (code "glStencilOp")
+ ".
+ If the GL version is 2.0 or greater, this stencil state only affects non-polygons
+ and front-facing polygons. Back-facing polygons use separate stencil state.
+ See "
+ (code "glStencilOpSeparate")
+ ". "))
+ (entry (% (heading (code "GL_STENCIL_REF")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the reference value that is compared with the contents of the stencil
+ buffer. The initial value is 0.
+ See "
+ (code "glStencilFunc")
+ ".
+ If the GL version is 2.0 or greater, this stencil state only affects non-polygons
+ and front-facing polygons. Back-facing polygons use separate stencil state.
+ See "
+ (code "glStencilFuncSeparate")
+ ". "))
+ (entry (% (heading (code "GL_STENCIL_TEST")))
+ (para)
+ (para (var "params")
+ " returns a single boolean value indicating whether stencil testing
+ of fragments is enabled. The initial value is "
+ (code "GL_FALSE")
+ ".
+ See "
+ (code "glStencilFunc")
+ " and "
+ (code "glStencilOp")
+ ". "))
+ (entry (% (heading (code "GL_STENCIL_VALUE_MASK")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the mask that is used to mask both the stencil reference value and the
+ stencil buffer value before they are compared. The initial value is all 1's.
+ See "
+ (code "glStencilFunc")
+ ".
+ If the GL version is 2.0 or greater, this stencil state only affects non-polygons
+ and front-facing polygons. Back-facing polygons use separate stencil state.
+ See "
+ (code "glStencilFuncSeparate")
+ ". "))
+ (entry (% (heading (code "GL_STENCIL_WRITEMASK")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the mask that controls writing of the stencil bitplanes. The initial value
+ is all 1's.
+ See "
+ (code "glStencilMask")
+ ".
+ If the GL version is 2.0 or greater, this stencil state only affects non-polygons
+ and front-facing polygons. Back-facing polygons use separate stencil state.
+ See "
+ (code "glStencilMaskSeparate")
+ ". "))
+ (entry (% (heading (code "GL_STEREO")))
+ (para)
+ (para (var "params")
+ " returns a single boolean value indicating whether stereo buffers
+ (left and right) are supported. "))
+ (entry (% (heading (code "GL_SUBPIXEL_BITS")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ an estimate of the number of bits of subpixel resolution that are used to
+ position rasterized geometry in window coordinates. The value must be at least 4. "))
+ (entry (% (heading (code "GL_TEXTURE_1D")))
+ (para)
+ (para (var "params")
+ " returns a single boolean value indicating whether 1D texture
+ mapping is enabled. The initial value is "
+ (code "GL_FALSE")
+ ".
+ See "
+ (code "glTexImage1D")
+ ". "))
+ (entry (% (heading (code "GL_TEXTURE_BINDING_1D")))
+ (para)
+ (para (var "params")
+ " returns a single value, the name of the texture
+ currently bound to the target "
+ (code "GL_TEXTURE_1D")
+ ". The initial value is 0.
+ See "
+ (code "glBindTexture")
+ ". "))
+ (entry (% (heading (code "GL_TEXTURE_2D")))
+ (para)
+ (para (var "params")
+ " returns a single boolean value indicating whether 2D texture
+ mapping is enabled. The initial value is "
+ (code "GL_FALSE")
+ ".
+ See "
+ (code "glTexImage2D")
+ ". "))
+ (entry (% (heading (code "GL_TEXTURE_BINDING_2D")))
+ (para)
+ (para (var "params")
+ " returns a single value, the name of the texture
+ currently bound to the target "
+ (code "GL_TEXTURE_2D")
+ ". The initial value is 0.
+ See "
+ (code "glBindTexture")
+ ". "))
+ (entry (% (heading (code "GL_TEXTURE_3D")))
+ (para)
+ (para (var "params")
+ " returns a single boolean value indicating whether 3D texture
+ mapping is enabled. The initial value is "
+ (code "GL_FALSE")
+ ".
+ See "
+ (code "glTexImage3D")
+ ". "))
+ (entry (% (heading (code "GL_TEXTURE_BINDING_3D")))
+ (para)
+ (para (var "params")
+ " returns a single value, the name of the texture
+ currently bound to the target "
+ (code "GL_TEXTURE_3D")
+ ". The initial value is 0.
+ See "
+ (code "glBindTexture")
+ ". "))
+ (entry (% (heading (code "GL_TEXTURE_BINDING_CUBE_MAP")))
+ (para)
+ (para (var "params")
+ " returns a single value, the name of the texture
+ currently bound to the target "
+ (code "GL_TEXTURE_CUBE_MAP")
+ ". The initial value is 0.
+ See "
+ (code "glBindTexture")
+ ". "))
+ (entry (% (heading (code "GL_TEXTURE_COMPRESSION_HINT")))
+ (para)
+ (para (var "params")
+ " returns a single value indicating the mode of the texture
+ compression hint. The initial value is "
+ (code "GL_DONT_CARE")
+ ". "))
+ (entry (% (heading (code "GL_TEXTURE_COORD_ARRAY")))
+ (para)
+ (para (var "params")
+ " returns a single boolean value indicating whether the texture
+ coordinate array is enabled. The initial value is "
+ (code "GL_FALSE")
+ ".
+ See "
+ (code "glTexCoordPointer")
+ ". "))
+ (entry (% (heading
+ (code "GL_TEXTURE_COORD_ARRAY_BUFFER_BINDING")))
+ (para)
+ (para (var "params")
+ " returns a single value, the name of the buffer object
+ associated with the texture coordinate array. This buffer object would have been bound to the
+ target "
+ (code "GL_ARRAY_BUFFER")
+ " at the time of the most recent call to "
+ (code "glTexCoordPointer")
+ ".
+ If no buffer object was bound to this target, 0 is returned. The initial value is 0.
+ See "
+ (code "glBindBuffer")
+ ". "))
+ (entry (% (heading (code "GL_TEXTURE_COORD_ARRAY_SIZE")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the number of coordinates per element in the texture coordinate
+ array. The initial value is 4.
+ See "
+ (code "glTexCoordPointer")
+ ". "))
+ (entry (% (heading (code "GL_TEXTURE_COORD_ARRAY_STRIDE")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the byte offset between consecutive elements in the texture coordinate
+ array. The initial value is 0.
+ See "
+ (code "glTexCoordPointer")
+ ". "))
+ (entry (% (heading (code "GL_TEXTURE_COORD_ARRAY_TYPE")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the data type of the coordinates in the texture coordinate
+ array. The initial value is "
+ (code "GL_FLOAT")
+ ".
+ See "
+ (code "glTexCoordPointer")
+ ". "))
+ (entry (% (heading (code "GL_TEXTURE_CUBE_MAP")))
+ (para)
+ (para (var "params")
+ " returns a single boolean value indicating whether cube-mapped texture
+ mapping is enabled. The initial value is "
+ (code "GL_FALSE")
+ ".
+ See "
+ (code "glTexImage2D")
+ ". "))
+ (entry (% (heading (code "GL_TEXTURE_GEN_Q")))
+ (para)
+ (para (var "params")
+ " returns a single boolean value indicating whether automatic generation
+ of the "
+ (var "q")
+ " texture coordinate is enabled. The initial value is "
+ (code "GL_FALSE")
+ ".
+ See "
+ (code "glTexGen")
+ ". "))
+ (entry (% (heading (code "GL_TEXTURE_GEN_R")))
+ (para)
+ (para (var "params")
+ " returns a single boolean value indicating whether automatic generation
+ of the "
+ (var "r")
+ " texture coordinate is enabled. The initial value is "
+ (code "GL_FALSE")
+ ".
+ See "
+ (code "glTexGen")
+ ". "))
+ (entry (% (heading (code "GL_TEXTURE_GEN_S")))
+ (para)
+ (para (var "params")
+ " returns a single boolean value indicating whether automatic generation
+ of the "
+ (var "S")
+ " texture coordinate is enabled. The initial value is "
+ (code "GL_FALSE")
+ ".
+ See "
+ (code "glTexGen")
+ ". "))
+ (entry (% (heading (code "GL_TEXTURE_GEN_T")))
+ (para)
+ (para (var "params")
+ " returns a single boolean value indicating whether automatic generation
+ of the T texture coordinate is enabled. The initial value is "
+ (code "GL_FALSE")
+ ".
+ See "
+ (code "glTexGen")
+ ". "))
+ (entry (% (heading (code "GL_TEXTURE_MATRIX")))
+ (para)
+ (para (var "params")
+ " returns sixteen values:
+ the texture matrix on the top of the texture matrix stack. Initially this
+ matrix is the identity matrix.
+ See "
+ (code "glPushMatrix")
+ ". "))
+ (entry (% (heading (code "GL_TEXTURE_STACK_DEPTH")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the number of matrices on the texture matrix stack.
+ The initial value is 1.
+ See "
+ (code "glPushMatrix")
+ ". "))
+ (entry (% (heading (code "GL_TRANSPOSE_COLOR_MATRIX")))
+ (para)
+ (para (var "params")
+ " returns 16 values, the elements of the color matrix in row-major
+ order.
+ See "
+ (code "glLoadTransposeMatrix")
+ ". "))
+ (entry (% (heading (code "GL_TRANSPOSE_MODELVIEW_MATRIX")))
+ (para)
+ (para (var "params")
+ " returns 16 values, the elements of the modelview matrix in row-major
+ order.
+ See "
+ (code "glLoadTransposeMatrix")
+ ". "))
+ (entry (% (heading (code "GL_TRANSPOSE_PROJECTION_MATRIX")))
+ (para)
+ (para (var "params")
+ " returns 16 values, the elements of the projection matrix in row-major
+ order.
+ See "
+ (code "glLoadTransposeMatrix")
+ ". "))
+ (entry (% (heading (code "GL_TRANSPOSE_TEXTURE_MATRIX")))
+ (para)
+ (para (var "params")
+ " returns 16 values, the elements of the texture matrix in row-major
+ order.
+ See "
+ (code "glLoadTransposeMatrix")
+ ". "))
+ (entry (% (heading (code "GL_UNPACK_ALIGNMENT")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the byte alignment used for reading pixel data from memory. The initial
+ value is 4.
+ See "
+ (code "glPixelStore")
+ ". "))
+ (entry (% (heading (code "GL_UNPACK_IMAGE_HEIGHT")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the image height used for reading pixel data from memory. The initial
+ is 0.
+ See "
+ (code "glPixelStore")
+ ". "))
+ (entry (% (heading (code "GL_UNPACK_LSB_FIRST")))
+ (para)
+ (para (var "params")
+ " returns a single boolean value indicating whether single-bit
+ pixels being read from memory are read first from the least significant
+ bit of each unsigned byte. The initial value is "
+ (code "GL_FALSE")
+ ".
+ See "
+ (code "glPixelStore")
+ ". "))
+ (entry (% (heading (code "GL_UNPACK_ROW_LENGTH")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the row length used for reading pixel data from memory. The initial value
+ is 0.
+ See "
+ (code "glPixelStore")
+ ". "))
+ (entry (% (heading (code "GL_UNPACK_SKIP_IMAGES")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the number of pixel images skipped before the first pixel is read
+ from memory. The initial value is 0.
+ See "
+ (code "glPixelStore")
+ ". "))
+ (entry (% (heading (code "GL_UNPACK_SKIP_PIXELS")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the number of pixel locations skipped before the first pixel is read
+ from memory. The initial value is 0.
+ See "
+ (code "glPixelStore")
+ ". "))
+ (entry (% (heading (code "GL_UNPACK_SKIP_ROWS")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the number of rows of pixel locations skipped before the first pixel is read
+ from memory. The initial value is 0.
+ See "
+ (code "glPixelStore")
+ ". "))
+ (entry (% (heading (code "GL_UNPACK_SWAP_BYTES")))
+ (para)
+ (para (var "params")
+ " returns a single boolean value indicating whether the bytes of
+ two-byte and four-byte pixel indices and components are swapped after being
+ read from memory. The initial value is "
+ (code "GL_FALSE")
+ ".
+ See "
+ (code "glPixelStore")
+ ". "))
+ (entry (% (heading (code "GL_VERTEX_ARRAY")))
+ (para)
+ (para (var "params")
+ " returns a single boolean value indicating whether the vertex
+ array is enabled. The initial value is "
+ (code "GL_FALSE")
+ ".
+ See "
+ (code "glVertexPointer")
+ ". "))
+ (entry (% (heading (code "GL_VERTEX_ARRAY_BUFFER_BINDING")))
+ (para)
+ (para (var "params")
+ " returns a single value, the name of the buffer object
+ associated with the vertex array. This buffer object would have been bound to the
+ target "
+ (code "GL_ARRAY_BUFFER")
+ " at the time of the most recent call to "
+ (code "glVertexPointer")
+ ".
+ If no buffer object was bound to this target, 0 is returned. The initial value is 0.
+ See "
+ (code "glBindBuffer")
+ ". "))
+ (entry (% (heading (code "GL_VERTEX_ARRAY_SIZE")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the number of coordinates per vertex in the vertex array. The initial
+ value is 4.
+ See "
+ (code "glVertexPointer")
+ ". "))
+ (entry (% (heading (code "GL_VERTEX_ARRAY_STRIDE")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the byte offset between consecutive vertices in the vertex
+ array. The initial value is 0.
+ See "
+ (code "glVertexPointer")
+ ". "))
+ (entry (% (heading (code "GL_VERTEX_ARRAY_TYPE")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the data type of each coordinate in the vertex array. The initial value is "
+ (code "GL_FLOAT")
+ ".
+ See "
+ (code "glVertexPointer")
+ ". "))
+ (entry (% (heading (code "GL_VERTEX_PROGRAM_POINT_SIZE")))
+ (para)
+ (para (var "params")
+ " returns a single boolean value indicating whether vertex
+ program point size mode is enabled. If enabled, and a vertex shader is active, then the
+ point size is taken from the shader built-in "
+ (code "gl_PointSize")
+ ". If disabled,
+ and a vertex shader is active, then the point size is taken from the point state as specified
+ by "
+ (code "glPointSize")
+ ".
+ The initial value is "
+ (code "GL_FALSE")
+ ". "))
+ (entry (% (heading (code "GL_VERTEX_PROGRAM_TWO_SIDE")))
+ (para)
+ (para (var "params")
+ " returns a single boolean value indicating whether vertex
+ program two-sided color mode is enabled. If enabled, and a vertex shader is active, then the
+ GL chooses the back color output for back-facing polygons, and the front color output for
+ non-polygons and front-facing polygons. If disabled, and a vertex shader is active, then the
+ front color output is always selected. The initial value is "
+ (code "GL_FALSE")
+ ". "))
+ (entry (% (heading (code "GL_VIEWPORT")))
+ (para)
+ (para (var "params")
+ " returns four values:
+ the "
+ (math (var "x"))
+ "
+and "
+ (math (var "y"))
+ "
+window coordinates of the viewport,
+ followed by its width and height.
+ Initially the "
+ (math (var "x"))
+ "
+and "
+ (math (var "y"))
+ "
+window coordinates are both set to 0,
+ and the width and height are set to the width and height of the window into
+ which the GL will do its rendering.
+ See "
+ (code "glViewport")
+ ". "))
+ (entry (% (heading (code "GL_ZOOM_X")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the "
+ (math (var "x"))
+ "
+pixel zoom factor. The initial value is 1.
+ See "
+ (code "glPixelZoom")
+ ". "))
+ (entry (% (heading (code "GL_ZOOM_Y")))
+ (para)
+ (para (var "params")
+ " returns one value,
+ the "
+ (math (var "y"))
+ "
+pixel zoom factor. The initial value is 1.
+ See "
+ (code "glPixelZoom")
+ ". ")))
+ (para "
+Many of the boolean parameters can also be queried more easily using "
+ (code "glIsEnabled")
+ ". ")
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "pname")
+ " is not an accepted value. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glGet")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")
+ (para)))
+
+(define-gl-procedure
+ glHint
+ "glHint"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glHint"))
+ (paramdef "GLenum " (parameter "target"))
+ (paramdef "GLenum " (parameter "mode"))))
+ '(*fragment*
+ (heading "specify implementation-specific hints")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "target")))
+ (para "
+Specifies a symbolic constant indicating the behavior to be controlled. "
+ (code "GL_FOG_HINT")
+ ", "
+ (code "GL_GENERATE_MIPMAP_HINT")
+ ", "
+ (code "GL_LINE_SMOOTH_HINT")
+ ", "
+ (code "GL_PERSPECTIVE_CORRECTION_HINT")
+ ", "
+ (code "GL_POINT_SMOOTH_HINT")
+ ", "
+ (code "GL_POLYGON_SMOOTH_HINT")
+ ", "
+ (code "GL_TEXTURE_COMPRESSION_HINT")
+ ", and "
+ (code "GL_FRAGMENT_SHADER_DERIVATIVE_HINT")
+ "
+are accepted. "))
+ (entry (% (heading (var "mode")))
+ (para "
+Specifies a symbolic constant indicating the desired behavior. "
+ (code "GL_FASTEST")
+ ", "
+ (code "GL_NICEST")
+ ", and "
+ (code "GL_DONT_CARE")
+ " are accepted. ")))
+ (heading "Description")
+ (para "
+Certain aspects of GL behavior,
+ when there is room for interpretation,
+ can be controlled with hints.
+ A hint is specified with two arguments. "
+ (var "target")
+ " is a symbolic
+ constant indicating the behavior to be controlled,
+ and "
+ (var "mode")
+ " is another symbolic constant indicating the desired
+ behavior. The initial value for each "
+ (var "target")
+ " is "
+ (code "GL_DONT_CARE")
+ ". "
+ (var "mode")
+ " can be one of the following: ")
+ (table (% (formatter (asis)))
+ (entry (% (heading (code "GL_FASTEST")))
+ (para)
+ (para "
+The most efficient option should be chosen. "))
+ (entry (% (heading (code "GL_NICEST")))
+ (para)
+ (para "
+The most correct,
+ or highest quality,
+ option should be chosen. "))
+ (entry (% (heading (code "GL_DONT_CARE")))
+ (para)
+ (para "
+No preference. ")))
+ (para "
+Though the implementation aspects that can be hinted are well defined,
+ the interpretation of the hints depends on the implementation.
+ The hint aspects that can be specified with "
+ (var "target")
+ ",
+ along with suggested semantics,
+ are as follows: ")
+ (table (% (formatter (asis)))
+ (entry (% (heading (code "GL_FOG_HINT")))
+ (para)
+ (para "
+Indicates the accuracy of fog calculation.
+ If per-pixel fog calculation is not efficiently supported
+ by the GL implementation,
+ hinting "
+ (code "GL_DONT_CARE")
+ " or "
+ (code "GL_FASTEST")
+ " can result in per-vertex
+ calculation of fog effects. "))
+ (entry (% (heading
+ (code "GL_FRAGMENT_SHADER_DERIVATIVE_HINT")))
+ (para)
+ (para "
+Indicates the accuracy of the derivative calculation for the GL shading language fragment processing built-in functions: "
+ (code "dFdx")
+ ", "
+ (code "dFdy")
+ ", and "
+ (code "fwidth")
+ ". "))
+ (entry (% (heading (code "GL_GENERATE_MIPMAP_HINT")))
+ (para)
+ (para "
+Indicates the quality of filtering when generating mipmap images. "))
+ (entry (% (heading (code "GL_LINE_SMOOTH_HINT")))
+ (para)
+ (para "
+Indicates the sampling quality of antialiased lines.
+ If a larger filter function is applied, hinting "
+ (code "GL_NICEST")
+ " can
+ result in more pixel fragments being generated during rasterization. "))
+ (entry (% (heading (code "GL_PERSPECTIVE_CORRECTION_HINT")))
+ (para)
+ (para "
+Indicates the quality of color, texture coordinate, and fog coordinate
+ interpolation. If perspective-corrected parameter interpolation is not
+ efficiently supported by the GL implementation, hinting "
+ (code "GL_DONT_CARE")
+ "
+or "
+ (code "GL_FASTEST")
+ " can result in simple linear interpolation of colors
+ and/or texture coordinates. "))
+ (entry (% (heading (code "GL_POINT_SMOOTH_HINT")))
+ (para)
+ (para "
+Indicates the sampling quality of antialiased points.
+ If a larger filter function is applied, hinting "
+ (code "GL_NICEST")
+ " can
+ result in more pixel fragments being generated during rasterization. "))
+ (entry (% (heading (code "GL_POLYGON_SMOOTH_HINT")))
+ (para)
+ (para "
+Indicates the sampling quality of antialiased polygons.
+ Hinting "
+ (code "GL_NICEST")
+ " can result in more pixel fragments being generated
+ during rasterization,
+ if a larger filter function is applied. "))
+ (entry (% (heading (code "GL_TEXTURE_COMPRESSION_HINT")))
+ (para)
+ (para "
+Indicates the quality and performance of the compressing texture images.
+ Hinting "
+ (code "GL_FASTEST")
+ " indicates that texture images should be compressed
+ as quickly as possible, while "
+ (code "GL_NICEST")
+ " indicates that texture images
+ should be compressed with as little image quality loss as possible. "
+ (code "GL_NICEST")
+ " should be selected if the texture is to be retrieved by "
+ (code "glGetCompressedTexImage")
+ " for reuse. ")))
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if either "
+ (var "target")
+ " or "
+ (var "mode")
+ " is not
+ an accepted value. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glHint")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glHistogram
+ "glHistogram"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glHistogram"))
+ (paramdef "GLenum " (parameter "target"))
+ (paramdef "GLsizei " (parameter "width"))
+ (paramdef "GLenum " (parameter "internalformat"))
+ (paramdef "GLboolean " (parameter "sink"))))
+ '(*fragment*
+ (heading "define histogram table")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "target")))
+ (para "
+The histogram whose parameters are to be set.
+ Must be one of "
+ (code "GL_HISTOGRAM")
+ " or "
+ (code "GL_PROXY_HISTOGRAM")
+ ". "))
+ (entry (% (heading (var "width")))
+ (para "
+The number of entries in the histogram table. Must be a power of 2. "))
+ (entry (% (heading (var "internalformat")))
+ (para "
+The format of entries in the histogram table.
+ Must be one of "
+ (code "GL_ALPHA")
+ ", "
+ (code "GL_ALPHA4")
+ ", "
+ (code "GL_ALPHA8")
+ ", "
+ (code "GL_ALPHA12")
+ ", "
+ (code "GL_ALPHA16")
+ ", "
+ (code "GL_LUMINANCE")
+ ", "
+ (code "GL_LUMINANCE4")
+ ", "
+ (code "GL_LUMINANCE8")
+ ", "
+ (code "GL_LUMINANCE12")
+ ", "
+ (code "GL_LUMINANCE16")
+ ", "
+ (code "GL_LUMINANCE_ALPHA")
+ ", "
+ (code "GL_LUMINANCE4_ALPHA4")
+ ", "
+ (code "GL_LUMINANCE6_ALPHA2")
+ ", "
+ (code "GL_LUMINANCE8_ALPHA8")
+ ", "
+ (code "GL_LUMINANCE12_ALPHA4")
+ ", "
+ (code "GL_LUMINANCE12_ALPHA12")
+ ", "
+ (code "GL_LUMINANCE16_ALPHA16")
+ ", "
+ (code "GL_R3_G3_B2")
+ ", "
+ (code "GL_RGB")
+ ", "
+ (code "GL_RGB4")
+ ", "
+ (code "GL_RGB5")
+ ", "
+ (code "GL_RGB8")
+ ", "
+ (code "GL_RGB10")
+ ", "
+ (code "GL_RGB12")
+ ", "
+ (code "GL_RGB16")
+ ", "
+ (code "GL_RGBA")
+ ", "
+ (code "GL_RGBA2")
+ ", "
+ (code "GL_RGBA4")
+ ", "
+ (code "GL_RGB5_A1")
+ ", "
+ (code "GL_RGBA8")
+ ", "
+ (code "GL_RGB10_A2")
+ ", "
+ (code "GL_RGBA12")
+ ", or "
+ (code "GL_RGBA16")
+ ". "))
+ (entry (% (heading (var "sink")))
+ (para "
+If "
+ (code "GL_TRUE")
+ ", pixels will be consumed by the histogramming
+ process and no drawing or texture loading will take place.
+ If "
+ (code "GL_FALSE")
+ ", pixels will proceed to the minmax process after
+ histogramming. ")))
+ (heading "Description")
+ (para "
+When "
+ (code "GL_HISTOGRAM")
+ " is enabled, RGBA color components are converted to
+ histogram table indices by clamping to the range [0,1], multiplying by
+ the width of the histogram table, and rounding to the nearest integer.
+ The table entries selected by the RGBA indices are then incremented.
+ (If the internal format of the histogram table includes luminance, then
+ the index derived from the R color component determines the luminance
+ table entry to be incremented.) If a histogram table entry is incremented
+ beyond its maximum value, then its value becomes undefined. (This is
+ not an error.) ")
+ (para "
+Histogramming is performed only for RGBA pixels (though these may
+ be specified originally as color indices and converted to RGBA by
+ index table lookup).
+ Histogramming is enabled with "
+ (code "glEnable")
+ " and disabled with "
+ (code "glDisable")
+ ". ")
+ (para "
+When "
+ (var "target")
+ " is "
+ (code "GL_HISTOGRAM")
+ ", "
+ (code "glHistogram")
+ " redefines the current
+ histogram table to have "
+ (var "width")
+ " entries of the format specified by "
+ (var "internalformat")
+ ".
+ The entries are indexed 0 through "
+ (math (var "width") "-" "1")
+ ",
+ and
+ all entries are initialized to zero.
+ The values in the previous histogram table, if any, are lost.
+ If "
+ (var "sink")
+ " is "
+ (code "GL_TRUE")
+ ", then pixels are discarded after histogramming;
+ no further processing of the pixels takes place, and no drawing,
+ texture loading, or pixel readback will result. ")
+ (para "
+When "
+ (var "target")
+ " is "
+ (code "GL_PROXY_HISTOGRAM")
+ ", "
+ (code "glHistogram")
+ " computes all
+ state information as if the histogram table were to be redefined,
+ but does not actually define the new table.
+ If the requested histogram table is too large to be supported, then the
+ state information will be set to zero.
+ This provides a way to determine if a histogram table with the given
+ parameters can be supported. ")
+ (para)
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "target")
+ " is not one of the allowable
+ values. ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "width")
+ " is less than zero or is
+ not a power of 2. ")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "internalformat")
+ " is not one of the
+ allowable values. ")
+ (para (code "GL_TABLE_TOO_LARGE")
+ " is generated if "
+ (var "target")
+ " is "
+ (code "GL_HISTOGRAM")
+ "
+and the histogram table specified is too large for the implementation. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glHistogram")
+ " is executed
+ between the execution of "
+ (code "glBegin")
+ " and the corresponding
+ execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glIndexMask
+ "glIndexMask"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glIndexMask"))
+ (paramdef "GLuint " (parameter "mask"))))
+ '(*fragment*
+ (heading
+ "control the writing of individual bits in the color index buffers")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "mask")))
+ (para "
+Specifies a bit mask to enable and disable the writing of individual bits
+ in the color index buffers.
+ Initially, the mask is all 1's. ")))
+ (heading "Description")
+ (para (code "glIndexMask")
+ " controls the writing of individual bits in the color index buffers.
+ The least significant "
+ (math (var "n"))
+ "
+bits of "
+ (var "mask")
+ ",
+ where "
+ (math (var "n"))
+ "
+is the number of bits in a color index buffer,
+ specify a mask.
+ Where a 1 (one) appears in the mask,
+ it's possible to write to the corresponding bit in the color index
+ buffer (or buffers).
+ Where a 0 (zero) appears,
+ the corresponding bit is write-protected. ")
+ (para "
+This mask is used only in color index mode,
+ and it affects only the buffers currently selected for writing
+ (see "
+ (code "glDrawBuffer")
+ ").
+ Initially, all bits are enabled for writing. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glIndexMask")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glIndexPointer
+ "glIndexPointer"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glIndexPointer"))
+ (paramdef "GLenum " (parameter "type"))
+ (paramdef "GLsizei " (parameter "stride"))
+ (paramdef
+ "const GLvoid * "
+ (parameter "pointer"))))
+ '(*fragment*
+ (heading "define an array of color indexes")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "type")))
+ (para "
+Specifies the data type of each color index in the array.
+ Symbolic constants "
+ (code "GL_UNSIGNED_BYTE")
+ ", "
+ (code "GL_SHORT")
+ ", "
+ (code "GL_INT")
+ ", "
+ (code "GL_FLOAT")
+ ",
+ and "
+ (code "GL_DOUBLE")
+ "
+are accepted. The initial value is "
+ (code "GL_FLOAT")
+ ". "))
+ (entry (% (heading (var "stride")))
+ (para "
+Specifies the byte offset between consecutive color indexes.
+ If "
+ (var "stride")
+ " is 0, the color indexes are understood to
+ be tightly packed in the array. The initial value is 0. "))
+ (entry (% (heading (var "pointer")))
+ (para "
+Specifies a pointer to the first index in the array.
+ The initial value is 0. ")))
+ (heading "Description")
+ (para (code "glIndexPointer")
+ " specifies the location and data format of an array of color indexes
+ to use when rendering. "
+ (var "type")
+ " specifies the data type of
+ each color index and "
+ (var "stride")
+ " specifies the byte stride from one
+ color index to the next, allowing vertices and attributes
+ to be packed into a single array or stored in separate arrays. ")
+ (para "
+If a non-zero named buffer object is bound to the "
+ (code "GL_ARRAY_BUFFER")
+ " target
+ (see "
+ (code "glBindBuffer")
+ ") while a color index array is
+ specified, "
+ (var "pointer")
+ " is treated as a byte offset into the buffer object's data store.
+ Also, the buffer object binding ("
+ (code "GL_ARRAY_BUFFER_BINDING")
+ ") is saved as color index vertex array
+ client-side state ("
+ (code "GL_INDEX_ARRAY_BUFFER_BINDING")
+ "). ")
+ (para "
+When a color index array is specified, "
+ (var "type")
+ ", "
+ (var "stride")
+ ", and "
+ (var "pointer")
+ " are saved as client-side
+ state, in addition to the current vertex array buffer object binding. ")
+ (para "
+To enable and disable the color index array, call "
+ (code "glEnableClientState")
+ " and "
+ (code "glDisableClientState")
+ " with the argument "
+ (code "GL_INDEX_ARRAY")
+ ". If
+ enabled, the color index array is used
+ when "
+ (code "glDrawArrays")
+ ", "
+ (code "glMultiDrawArrays")
+ ", "
+ (code "glDrawElements")
+ ", "
+ (code "glMultiDrawElements")
+ ", "
+ (code "glDrawRangeElements")
+ ", or "
+ (code "glArrayElement")
+ " is called. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "type")
+ " is not an accepted value. ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "stride")
+ " is negative. ")))
+
+(define-gl-procedure
+ glIndex
+ "glIndex"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glIndexs"))
+ (paramdef "GLshort " (parameter "c"))))
+ '(*fragment*
+ (heading "set the current color index")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "c")))
+ (para "
+Specifies the new value for the current color index. ")
+ (para)))
+ (heading "Description")
+ (para (code "glIndex")
+ " updates the current (single-valued) color index.
+ It takes one argument, the new value for the current color index. ")
+ (para "
+The current index is stored as a floating-point value.
+ Integer values are converted directly to floating-point values,
+ with no special mapping.
+ The initial value is 1. ")
+ (para "
+Index values outside the representable range of the color index buffer
+ are not clamped.
+ However,
+ before an index is dithered (if enabled) and written to the frame buffer,
+ it is converted to fixed-point format.
+ Any bits in the integer portion of the resulting fixed-point value
+ that do not correspond to bits in the frame buffer are masked out. ")))
+
+(define-gl-procedure
+ glInitNames
+ "glInitNames"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glInitNames"))
+ (paramdef (parameter "void"))))
+ '(*fragment*
+ (heading "initialize the name stack")
+ (heading "Description")
+ (para "
+The name stack is used during selection mode to allow sets of rendering
+ commands to be uniquely identified.
+ It consists of an ordered set of unsigned integers. "
+ (code "glInitNames")
+ " causes the name stack to be initialized to its default empty state. ")
+ (para "
+The name stack is always empty while the render mode is not "
+ (code "GL_SELECT")
+ ".
+ Calls to "
+ (code "glInitNames")
+ " while the render mode is not "
+ (code "GL_SELECT")
+ " are ignored. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glInitNames")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ " and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glInterleavedArrays
+ "glInterleavedArrays"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "void "
+ (function "glInterleavedArrays"))
+ (paramdef "GLenum " (parameter "format"))
+ (paramdef "GLsizei " (parameter "stride"))
+ (paramdef
+ "const GLvoid * "
+ (parameter "pointer"))))
+ '(*fragment*
+ (heading
+ "simultaneously specify and enable several interleaved arrays")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "format")))
+ (para "
+Specifies the type of array to enable. Symbolic constants "
+ (code "GL_V2F")
+ ", "
+ (code "GL_V3F")
+ ", "
+ (code "GL_C4UB_V2F")
+ ", "
+ (code "GL_C4UB_V3F")
+ ", "
+ (code "GL_C3F_V3F")
+ ", "
+ (code "GL_N3F_V3F")
+ ", "
+ (code "GL_C4F_N3F_V3F")
+ ", "
+ (code "GL_T2F_V3F")
+ ", "
+ (code "GL_T4F_V4F")
+ ", "
+ (code "GL_T2F_C4UB_V3F")
+ ", "
+ (code "GL_T2F_C3F_V3F")
+ ", "
+ (code "GL_T2F_N3F_V3F")
+ ", "
+ (code "GL_T2F_C4F_N3F_V3F")
+ ",
+ and "
+ (code "GL_T4F_C4F_N3F_V4F")
+ "
+are accepted. "))
+ (entry (% (heading (var "stride")))
+ (para "
+Specifies the offset in bytes between each aggregate array element. ")))
+ (heading "Description")
+ (para (code "glInterleavedArrays")
+ " lets you specify and enable individual color,
+ normal,
+ texture and vertex
+ arrays whose elements are part of a larger aggregate array element.
+ For some implementations, this is more efficient than specifying the arrays
+ separately. ")
+ (para "
+If "
+ (var "stride")
+ " is 0, the aggregate elements are stored consecutively.
+ Otherwise, "
+ (var "stride")
+ " bytes occur between the beginning of one
+ aggregate array element and the beginning of the next aggregate array
+ element. ")
+ (para (var "format")
+ " serves as a ``key''
+ describing the extraction of individual arrays from the aggregate array.
+ If "
+ (var "format")
+ " contains a T, then texture coordinates are
+ extracted from the interleaved array. If C is present, color values
+ are extracted. If N is present, normal coordinates are extracted.
+ Vertex coordinates are always extracted. ")
+ (para "
+The digits 2, 3, and 4 denote how many values are extracted.
+ F indicates that values are extracted as floating-point values.
+ Colors may also be extracted as 4 unsigned bytes if 4UB follows the
+ C. If a color is extracted as 4 unsigned bytes, the vertex
+ array element which follows is located at the first possible
+ floating-point aligned address. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "format")
+ " is not an accepted value. ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "stride")
+ " is negative. ")))
+
+(define-gl-procedure
+ glIsBuffer
+ "glIsBuffer"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "GLboolean " (function "glIsBuffer"))
+ (paramdef "GLuint " (parameter "buffer"))))
+ '(*fragment*
+ (heading
+ "determine if a name corresponds to a buffer object")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "buffer")))
+ (para "
+Specifies a value that may be the name of a buffer object. ")))
+ (heading "Description")
+ (para (code "glIsBuffer")
+ " returns "
+ (code "GL_TRUE")
+ " if "
+ (var "buffer")
+ " is currently the name of a buffer object.
+ If "
+ (var "buffer")
+ " is zero, or is a non-zero value that is not currently the
+ name of a buffer object, or if an error occurs, "
+ (code "glIsBuffer")
+ " returns "
+ (code "GL_FALSE")
+ ". ")
+ (para "
+A name returned by "
+ (code "glGenBuffers")
+ ", but not yet associated with a buffer object
+ by calling "
+ (code "glBindBuffer")
+ ", is not the name of a buffer object. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glIsBuffer")
+ " is executed
+ between the execution of "
+ (code "glBegin")
+ " and the corresponding
+ execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glIsEnabled
+ "glIsEnabled"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "GLboolean " (function "glIsEnabled"))
+ (paramdef "GLenum " (parameter "cap"))))
+ '(*fragment*
+ (heading "test whether a capability is enabled")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "cap")))
+ (para "
+Specifies a symbolic constant indicating a GL capability. ")))
+ (heading "Description")
+ (para (code "glIsEnabled")
+ " returns "
+ (code "GL_TRUE")
+ " if "
+ (var "cap")
+ " is an enabled capability
+ and returns "
+ (code "GL_FALSE")
+ " otherwise.
+ Initially all capabilities except "
+ (code "GL_DITHER")
+ " are disabled; "
+ (code "GL_DITHER")
+ " is initially enabled. ")
+ (para "
+The following capabilities are accepted for "
+ (var "cap")
+ ": ")
+ (para)
+ (table (% (formatter (asis)))
+ (entry (% (heading (strong "Constant")))
+ (para (strong "See")))
+ (entry (% (heading (code "GL_ALPHA_TEST")))
+ (para (code "glAlphaFunc")))
+ (entry (% (heading (code "GL_AUTO_NORMAL")))
+ (para (code "glEvalCoord")))
+ (entry (% (heading (code "GL_BLEND")))
+ (para (code "glBlendFunc")
+ ", "
+ (code "glLogicOp")))
+ (entry (% (heading (code "GL_CLIP_PLANE") (var "i")))
+ (para (code "glClipPlane")))
+ (entry (% (heading (code "GL_COLOR_ARRAY")))
+ (para (code "glColorPointer")))
+ (entry (% (heading (code "GL_COLOR_LOGIC_OP")))
+ (para (code "glLogicOp")))
+ (entry (% (heading (code "GL_COLOR_MATERIAL")))
+ (para (code "glColorMaterial")))
+ (entry (% (heading (code "GL_COLOR_SUM")))
+ (para (code "glSecondaryColor")))
+ (entry (% (heading (code "GL_COLOR_TABLE")))
+ (para (code "glColorTable")))
+ (entry (% (heading (code "GL_CONVOLUTION_1D")))
+ (para (code "glConvolutionFilter1D")))
+ (entry (% (heading (code "GL_CONVOLUTION_2D")))
+ (para (code "glConvolutionFilter2D")))
+ (entry (% (heading (code "GL_CULL_FACE")))
+ (para (code "glCullFace")))
+ (entry (% (heading (code "GL_DEPTH_TEST")))
+ (para (code "glDepthFunc")
+ ", "
+ (code "glDepthRange")))
+ (entry (% (heading (code "GL_DITHER")))
+ (para (code "glEnable")))
+ (entry (% (heading (code "GL_EDGE_FLAG_ARRAY")))
+ (para (code "glEdgeFlagPointer")))
+ (entry (% (heading (code "GL_FOG")))
+ (para (code "glFog")))
+ (entry (% (heading (code "GL_FOG_COORD_ARRAY")))
+ (para (code "glFogCoordPointer")))
+ (entry (% (heading (code "GL_HISTOGRAM")))
+ (para (code "glHistogram")))
+ (entry (% (heading (code "GL_INDEX_ARRAY")))
+ (para (code "glIndexPointer")))
+ (entry (% (heading (code "GL_INDEX_LOGIC_OP")))
+ (para (code "glLogicOp")))
+ (entry (% (heading (code "GL_LIGHT") (var "i")))
+ (para (code "glLightModel")
+ ", "
+ (code "glLight")))
+ (entry (% (heading (code "GL_LIGHTING")))
+ (para (code "glMaterial")
+ ", "
+ (code "glLightModel")
+ ", "
+ (code "glLight")))
+ (entry (% (heading (code "GL_LINE_SMOOTH")))
+ (para (code "glLineWidth")))
+ (entry (% (heading (code "GL_LINE_STIPPLE")))
+ (para (code "glLineStipple")))
+ (entry (% (heading (code "GL_MAP1_COLOR_4")))
+ (para (code "glMap1")))
+ (entry (% (heading (code "GL_MAP1_INDEX")))
+ (para (code "glMap1")))
+ (entry (% (heading (code "GL_MAP1_NORMAL")))
+ (para (code "glMap1")))
+ (entry (% (heading (code "GL_MAP1_TEXTURE_COORD_1")))
+ (para (code "glMap1")))
+ (entry (% (heading (code "GL_MAP1_TEXTURE_COORD_2")))
+ (para (code "glMap1")))
+ (entry (% (heading (code "GL_MAP1_TEXTURE_COORD_3")))
+ (para (code "glMap1")))
+ (entry (% (heading (code "GL_MAP1_TEXTURE_COORD_4")))
+ (para (code "glMap1")))
+ (entry (% (heading (code "GL_MAP2_COLOR_4")))
+ (para (code "glMap2")))
+ (entry (% (heading (code "GL_MAP2_INDEX")))
+ (para (code "glMap2")))
+ (entry (% (heading (code "GL_MAP2_NORMAL")))
+ (para (code "glMap2")))
+ (entry (% (heading (code "GL_MAP2_TEXTURE_COORD_1")))
+ (para (code "glMap2")))
+ (entry (% (heading (code "GL_MAP2_TEXTURE_COORD_2")))
+ (para (code "glMap2")))
+ (entry (% (heading (code "GL_MAP2_TEXTURE_COORD_3")))
+ (para (code "glMap2")))
+ (entry (% (heading (code "GL_MAP2_TEXTURE_COORD_4")))
+ (para (code "glMap2")))
+ (entry (% (heading (code "GL_MAP2_VERTEX_3")))
+ (para (code "glMap2")))
+ (entry (% (heading (code "GL_MAP2_VERTEX_4")))
+ (para (code "glMap2")))
+ (entry (% (heading (code "GL_MINMAX")))
+ (para (code "glMinmax")))
+ (entry (% (heading (code "GL_MULTISAMPLE")))
+ (para (code "glSampleCoverage")))
+ (entry (% (heading (code "GL_NORMAL_ARRAY")))
+ (para (code "glNormalPointer")))
+ (entry (% (heading (code "GL_NORMALIZE")))
+ (para (code "glNormal")))
+ (entry (% (heading (code "GL_POINT_SMOOTH")))
+ (para (code "glPointSize")))
+ (entry (% (heading (code "GL_POINT_SPRITE")))
+ (para (code "glEnable")))
+ (entry (% (heading (code "GL_POLYGON_SMOOTH")))
+ (para (code "glPolygonMode")))
+ (entry (% (heading (code "GL_POLYGON_OFFSET_FILL")))
+ (para (code "glPolygonOffset")))
+ (entry (% (heading (code "GL_POLYGON_OFFSET_LINE")))
+ (para (code "glPolygonOffset")))
+ (entry (% (heading (code "GL_POLYGON_OFFSET_POINT")))
+ (para (code "glPolygonOffset")))
+ (entry (% (heading (code "GL_POLYGON_STIPPLE")))
+ (para (code "glPolygonStipple")))
+ (entry (% (heading
+ (code "GL_POST_COLOR_MATRIX_COLOR_TABLE")))
+ (para (code "glColorTable")))
+ (entry (% (heading
+ (code "GL_POST_CONVOLUTION_COLOR_TABLE")))
+ (para (code "glColorTable")))
+ (entry (% (heading (code "GL_RESCALE_NORMAL")))
+ (para (code "glNormal")))
+ (entry (% (heading (code "GL_SAMPLE_ALPHA_TO_COVERAGE")))
+ (para (code "glSampleCoverage")))
+ (entry (% (heading (code "GL_SAMPLE_ALPHA_TO_ONE")))
+ (para (code "glSampleCoverage")))
+ (entry (% (heading (code "GL_SAMPLE_COVERAGE")))
+ (para (code "glSampleCoverage")))
+ (entry (% (heading (code "GL_SCISSOR_TEST")))
+ (para (code "glScissor")))
+ (entry (% (heading (code "GL_SECONDARY_COLOR_ARRAY")))
+ (para (code "glSecondaryColorPointer")))
+ (entry (% (heading (code "GL_SEPARABLE_2D")))
+ (para (code "glSeparableFilter2D")))
+ (entry (% (heading (code "GL_STENCIL_TEST")))
+ (para (code "glStencilFunc")
+ ", "
+ (code "glStencilOp")))
+ (entry (% (heading (code "GL_TEXTURE_1D")))
+ (para (code "glTexImage1D")))
+ (entry (% (heading (code "GL_TEXTURE_2D")))
+ (para (code "glTexImage2D")))
+ (entry (% (heading (code "GL_TEXTURE_3D")))
+ (para (code "glTexImage3D")))
+ (entry (% (heading (code "GL_TEXTURE_COORD_ARRAY")))
+ (para (code "glTexCoordPointer")))
+ (entry (% (heading (code "GL_TEXTURE_CUBE_MAP")))
+ (para (code "glTexImage2D")))
+ (entry (% (heading (code "GL_TEXTURE_GEN_Q")))
+ (para (code "glTexGen")))
+ (entry (% (heading (code "GL_TEXTURE_GEN_R")))
+ (para (code "glTexGen")))
+ (entry (% (heading (code "GL_TEXTURE_GEN_S")))
+ (para (code "glTexGen")))
+ (entry (% (heading (code "GL_TEXTURE_GEN_T")))
+ (para (code "glTexGen")))
+ (entry (% (heading (code "GL_VERTEX_ARRAY")))
+ (para (code "glVertexPointer")))
+ (entry (% (heading (code "GL_VERTEX_PROGRAM_POINT_SIZE")))
+ (para (code "glEnable")))
+ (entry (% (heading (code "GL_VERTEX_PROGRAM_TWO_SIDE")))
+ (para (code "glEnable"))))
+ (para)
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "cap")
+ " is not an accepted value. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glIsEnabled")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glIsList
+ "glIsList"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "GLboolean " (function "glIsList"))
+ (paramdef "GLuint " (parameter "list"))))
+ '(*fragment*
+ (heading
+ "determine if a name corresponds to a display list")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "list")))
+ (para "
+Specifies a potential display list name. ")))
+ (heading "Description")
+ (para (code "glIsList")
+ " returns "
+ (code "GL_TRUE")
+ " if "
+ (var "list")
+ " is the name
+ of a display list and returns "
+ (code "GL_FALSE")
+ " if it is not, or if an error occurs. ")
+ (para "
+A name returned by "
+ (code "glGenLists")
+ ", but not yet associated with a display list
+ by calling "
+ (code "glNewList")
+ ", is not the name of a display list. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glIsList")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glIsProgram
+ "glIsProgram"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "GLboolean " (function "glIsProgram"))
+ (paramdef "GLuint " (parameter "program"))))
+ '(*fragment*
+ (heading
+ "Determines if a name corresponds to a program object")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "program")))
+ (para "Specifies a potential program object.")))
+ (heading "Description")
+ (para (code "glIsProgram")
+ " returns\t"
+ (code "GL_TRUE")
+ " if "
+ (var "program")
+ "
+is the name of a program object previously created with "
+ (code "glCreateProgram")
+ " and not yet deleted with "
+ (code "glDeleteProgram")
+ ".
+\tIf "
+ (var "program")
+ " is zero or a non-zero value that
+\tis not the name of a program object, or if an error occurs, "
+ (code "glIsProgram")
+ " returns "
+ (code "GL_FALSE")
+ ".")
+ (heading "Errors")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if\t"
+ (code "glIsProgram")
+ " is executed between the
+\texecution of\t"
+ (code "glBegin")
+ "
+and the corresponding execution of\t"
+ (code "glEnd")
+ ".")))
+
+(define-gl-procedure
+ glIsQuery
+ "glIsQuery"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "GLboolean " (function "glIsQuery"))
+ (paramdef "GLuint " (parameter "id"))))
+ '(*fragment*
+ (heading
+ "determine if a name corresponds to a query object")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "id")))
+ (para "
+Specifies a value that may be the name of a query object. ")))
+ (heading "Description")
+ (para (code "glIsQuery")
+ " returns "
+ (code "GL_TRUE")
+ " if "
+ (var "id")
+ " is currently the name of a query object.
+ If "
+ (var "id")
+ " is zero, or is a non-zero value that is not currently the
+ name of a query object, or if an error occurs, "
+ (code "glIsQuery")
+ " returns "
+ (code "GL_FALSE")
+ ". ")
+ (para "
+A name returned by "
+ (code "glGenQueries")
+ ", but not yet associated with a query object
+ by calling "
+ (code "glBeginQuery")
+ ", is not the name of a query object. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glIsQuery")
+ " is executed
+ between the execution of "
+ (code "glBegin")
+ " and the corresponding
+ execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glIsShader
+ "glIsShader"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "GLboolean " (function "glIsShader"))
+ (paramdef "GLuint " (parameter "shader"))))
+ '(*fragment*
+ (heading
+ "Determines if a name corresponds to a shader object")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "shader")))
+ (para "Specifies a potential shader object.")))
+ (heading "Description")
+ (para (code "glIsShader")
+ " returns\t"
+ (code "GL_TRUE")
+ " if "
+ (var "shader")
+ " is
+\tthe name of a shader object previously created with "
+ (code "glCreateShader")
+ " and not yet deleted with "
+ (code "glDeleteShader")
+ ".
+ If "
+ (var "shader")
+ " is
+\tzero or a non-zero value that is not the name of a shader
+\tobject, or if an error occurs, "
+ (code "glIsShader ")
+ " returns\t"
+ (code "GL_FALSE")
+ ".")
+ (heading "Errors")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if\t"
+ (code "glIsShader")
+ " is executed between the
+\texecution of\t"
+ (code "glBegin")
+ "
+and the corresponding execution of\t"
+ (code "glEnd")
+ ".")))
+
+(define-gl-procedure
+ glIsTexture
+ "glIsTexture"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "GLboolean " (function "glIsTexture"))
+ (paramdef "GLuint " (parameter "texture"))))
+ '(*fragment*
+ (heading
+ "determine if a name corresponds to a texture")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "texture")))
+ (para "
+Specifies a value that may be the name of a texture. ")))
+ (heading "Description")
+ (para (code "glIsTexture")
+ " returns "
+ (code "GL_TRUE")
+ " if "
+ (var "texture")
+ " is currently the name of a texture.
+ If "
+ (var "texture")
+ " is zero, or is a non-zero value that is not currently the
+ name of a texture, or if an error occurs, "
+ (code "glIsTexture")
+ " returns "
+ (code "GL_FALSE")
+ ". ")
+ (para "
+A name returned by "
+ (code "glGenTextures")
+ ", but not yet associated with a texture
+ by calling "
+ (code "glBindTexture")
+ ", is not the name of a texture. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glIsTexture")
+ " is executed
+ between the execution of "
+ (code "glBegin")
+ " and the corresponding
+ execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glLightModel
+ "glLightModel"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glLightModelf"))
+ (paramdef "GLenum " (parameter "pname"))
+ (paramdef "GLfloat " (parameter "param"))))
+ '(*fragment*
+ (heading "set the lighting model parameters")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "pname")))
+ (para "
+Specifies a single-valued lighting model parameter. "
+ (code "GL_LIGHT_MODEL_LOCAL_VIEWER")
+ ", "
+ (code "GL_LIGHT_MODEL_COLOR_CONTROL")
+ ", and "
+ (code "GL_LIGHT_MODEL_TWO_SIDE")
+ " are accepted. "))
+ (entry (% (heading (var "param")))
+ (para "
+Specifies the value that "
+ (var "param")
+ " will be set to. ")))
+ (heading "Description")
+ (para (code "glLightModel")
+ " sets the lighting model parameter. "
+ (var "pname")
+ " names a parameter and "
+ (var "params")
+ " gives the new value.
+ There are three lighting model parameters: ")
+ (table (% (formatter (asis)))
+ (entry (% (heading (code "GL_LIGHT_MODEL_AMBIENT")))
+ (para)
+ (para (var "params")
+ " contains four integer or floating-point values that specify
+ the ambient RGBA intensity of the entire scene.
+ Integer values are mapped linearly such that the most positive representable
+ value maps to 1.0,
+ and the most negative representable value maps to "
+ (math "-1.0")
+ ".
+ Floating-point values are mapped directly.
+ Neither integer nor floating-point values are clamped.
+ The initial ambient scene intensity is (0.2, 0.2, 0.2, 1.0). "))
+ (entry (% (heading (code "GL_LIGHT_MODEL_COLOR_CONTROL")))
+ (para)
+ (para (var "params")
+ " must be either "
+ (code "GL_SEPARATE_SPECULAR_COLOR")
+ " or "
+ (code "GL_SINGLE_COLOR")
+ ". "
+ (code "GL_SINGLE_COLOR")
+ " specifies that a single color is generated from the
+ lighting computation for a vertex. "
+ (code "GL_SEPARATE_SPECULAR_COLOR")
+ "
+specifies that the specular color computation of lighting be stored
+ separately from the remainder of the lighting computation. The specular
+ color is summed into the generated fragment's color after the application
+ of texture mapping (if enabled). The initial value is "
+ (code "GL_SINGLE_COLOR")
+ ". "))
+ (entry (% (heading (code "GL_LIGHT_MODEL_LOCAL_VIEWER")))
+ (para)
+ (para (var "params")
+ " is a single integer or floating-point value that specifies
+ how specular reflection angles are computed.
+ If "
+ (var "params")
+ " is 0 (or 0.0), specular reflection angles take the
+ view direction to be parallel to and in the direction of the -"
+ (var "z")
+ " axis,
+ regardless of the location of the vertex in eye coordinates.
+ Otherwise, specular reflections are computed from the origin
+ of the eye coordinate system.
+ The initial value is 0. "))
+ (entry (% (heading (code "GL_LIGHT_MODEL_TWO_SIDE")))
+ (para)
+ (para (var "params")
+ " is a single integer or floating-point value that specifies
+ whether one- or two-sided lighting calculations are done for polygons.
+ It has no effect on the lighting calculations for points,
+ lines,
+ or bitmaps.
+ If "
+ (var "params")
+ " is 0 (or 0.0), one-sided lighting is specified,
+ and only the "
+ (var "front")
+ " material parameters are used in the
+ lighting equation.
+ Otherwise, two-sided lighting is specified.
+ In this case, vertices of back-facing polygons are lighted using the "
+ (var "back")
+ " material parameters
+ and have their normals reversed before the lighting equation is evaluated.
+ Vertices of front-facing polygons are always lighted using the "
+ (var "front")
+ " material parameters,
+ with no change to their normals. The initial value is 0. ")))
+ (para "
+In RGBA mode, the lighted color of a vertex is the sum of
+ the material emission intensity,
+ the product of the material ambient reflectance and the lighting model full-scene
+ ambient intensity,
+ and the contribution of each enabled light source.
+ Each light source contributes the sum of three terms:
+ ambient, diffuse, and specular.
+ The ambient light source contribution is the product of the material ambient
+ reflectance and the light's ambient intensity.
+ The diffuse light source contribution is the product of the material diffuse
+ reflectance,
+ the light's diffuse intensity,
+ and the dot product of the vertex's normal with the normalized vector from
+ the vertex to the light source.
+ The specular light source contribution is the product of the material specular
+ reflectance,
+ the light's specular intensity,
+ and the dot product of the normalized vertex-to-eye and vertex-to-light
+ vectors,
+ raised to the power of the shininess of the material.
+ All three light source contributions are attenuated equally based on
+ the distance from the vertex to the light source and on light source
+ direction, spread exponent, and spread cutoff angle.
+ All dot products are replaced with 0 if they evaluate to a negative value. ")
+ (para "
+The alpha component of the resulting lighted color is set to the alpha value
+ of the material diffuse reflectance. ")
+ (para "
+In color index mode,
+ the value of the lighted index of a vertex ranges from the ambient
+ to the specular values passed to "
+ (code "glMaterial")
+ " using "
+ (code "GL_COLOR_INDEXES")
+ ".
+ Diffuse and specular coefficients,
+ computed with a (.30, .59, .11) weighting of the lights' colors,
+ the shininess of the material,
+ and the same reflection and attenuation equations as in the RGBA case,
+ determine how much above ambient the resulting index is. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "pname")
+ " is not an accepted value. ")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "pname")
+ " is "
+ (code "GL_LIGHT_MODEL_COLOR_CONTROL")
+ " and "
+ (var "params")
+ " is not one of "
+ (code "GL_SINGLE_COLOR")
+ " or "
+ (code "GL_SEPARATE_SPECULAR_COLOR")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glLightModel")
+ " is executed between
+ the execution of "
+ (code "glBegin")
+ " and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glLight
+ "glLight"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glLightf"))
+ (paramdef "GLenum " (parameter "light"))
+ (paramdef "GLenum " (parameter "pname"))
+ (paramdef "GLfloat " (parameter "param"))))
+ '(*fragment*
+ (heading "set light source parameters")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "light")))
+ (para "
+Specifies a light.
+ The number of lights depends on the implementation,
+ but at least eight lights are supported.
+ They are identified by symbolic names of the form "
+ (code "GL_LIGHT")
+ (math (var "i"))
+ ",
+ where i ranges from 0 to the value of "
+ (code "GL_MAX_LIGHTS")
+ " - 1. "))
+ (entry (% (heading (var "pname")))
+ (para "
+Specifies a single-valued light source parameter for "
+ (var "light")
+ ". "
+ (code "GL_SPOT_EXPONENT")
+ ", "
+ (code "GL_SPOT_CUTOFF")
+ ", "
+ (code "GL_CONSTANT_ATTENUATION")
+ ", "
+ (code "GL_LINEAR_ATTENUATION")
+ ", and "
+ (code "GL_QUADRATIC_ATTENUATION")
+ " are accepted. "))
+ (entry (% (heading (var "param")))
+ (para "
+Specifies the value that parameter "
+ (var "pname")
+ " of light source "
+ (var "light")
+ "
+will be set to. ")))
+ (heading "Description")
+ (para (code "glLight")
+ " sets the values of individual light source parameters. "
+ (var "light")
+ " names the light and is a symbolic name of the form "
+ (code "GL_LIGHT")
+ (math (var "i"))
+ ",
+ where i ranges from 0 to the value of "
+ (code "GL_MAX_LIGHTS")
+ " - 1. "
+ (var "pname")
+ " specifies one of ten light source parameters,
+ again by symbolic name. "
+ (var "params")
+ " is either a single value or a pointer to an array that contains
+ the new values. ")
+ (para "
+To enable and disable lighting calculation, call "
+ (code "glEnable")
+ "
+and "
+ (code "glDisable")
+ " with argument "
+ (code "GL_LIGHTING")
+ ". Lighting is
+ initially disabled.
+ When it is enabled,
+ light sources that are enabled contribute to the lighting calculation.
+ Light source "
+ (math (var "i"))
+ "
+is enabled and disabled using "
+ (code "glEnable")
+ " and "
+ (code "glDisable")
+ " with argument "
+ (code "GL_LIGHT")
+ (math (var "i"))
+ ". ")
+ (para "
+The ten light parameters are as follows: ")
+ (table (% (formatter (asis)))
+ (entry (% (heading (code "GL_AMBIENT")))
+ (para (var "params")
+ " contains four integer or floating-point values that specify
+ the ambient RGBA intensity of the light.
+ Integer values are mapped linearly such that the most positive representable
+ value maps to 1.0,
+ and the most negative representable value maps to "
+ (math "-1.0")
+ ".
+ Floating-point values are mapped directly.
+ Neither integer nor floating-point values are clamped.
+ The initial ambient light intensity is (0, 0, 0, 1). "))
+ (entry (% (heading (code "GL_DIFFUSE")))
+ (para (var "params")
+ " contains four integer or floating-point values that specify
+ the diffuse RGBA intensity of the light.
+ Integer values are mapped linearly such that the most positive representable
+ value maps to 1.0,
+ and the most negative representable value maps to "
+ (math "-1.0")
+ ".
+ Floating-point values are mapped directly.
+ Neither integer nor floating-point values are clamped.
+ The initial value
+ for "
+ (code "GL_LIGHT0")
+ " is (1, 1, 1, 1); for other lights, the
+ initial value is (0, 0, 0, 1). "))
+ (entry (% (heading (code "GL_SPECULAR")))
+ (para (var "params")
+ " contains four integer or floating-point values that specify
+ the specular RGBA intensity of the light.
+ Integer values are mapped linearly such that the most positive representable
+ value maps to 1.0,
+ and the most negative representable value maps to "
+ (math "-1.0")
+ ".
+ Floating-point values are mapped directly.
+ Neither integer nor floating-point values are clamped.
+ The initial value
+ for "
+ (code "GL_LIGHT0")
+ " is (1, 1, 1, 1); for other lights, the
+ initial value is (0, 0, 0, 1). "))
+ (entry (% (heading (code "GL_POSITION")))
+ (para (var "params")
+ " contains four integer or floating-point values that specify
+ the position of the light in homogeneous object coordinates.
+ Both integer and floating-point values are mapped directly.
+ Neither integer nor floating-point values are clamped. ")
+ (para "
+The position is transformed by the modelview matrix when "
+ (code "glLight")
+ " is called (just as if it were a point),
+ and it is stored in eye coordinates.
+ If the "
+ (math (var "w"))
+ "
+component of the position is 0,
+ the light is treated as a directional source.
+ Diffuse and specular lighting calculations take the light's direction,
+ but not its actual position,
+ into account,
+ and attenuation is disabled.
+ Otherwise,
+ diffuse and specular lighting calculations are based on the actual location
+ of the light in eye coordinates,
+ and attenuation is enabled.
+ The initial position is (0, 0, 1, 0);
+ thus, the initial light source is directional,
+ parallel to, and in the direction of the "
+ (math "-" (var "z"))
+ "
+axis. "))
+ (entry (% (heading (code "GL_SPOT_DIRECTION")))
+ (para (var "params")
+ " contains three integer or floating-point values that specify
+ the direction of the light in homogeneous object coordinates.
+ Both integer and floating-point values are mapped directly.
+ Neither integer nor floating-point values are clamped. ")
+ (para "
+The spot direction is transformed by the upper 3x3 of the modelview matrix when "
+ (code "glLight")
+ " is called,
+ and it is stored in eye coordinates.
+ It is significant only when "
+ (code "GL_SPOT_CUTOFF")
+ " is not 180,
+ which it is initially.
+ The initial direction is "
+ (math "(" "0" "," "0" "-1" ")")
+ ". "))
+ (entry (% (heading (code "GL_SPOT_EXPONENT")))
+ (para (var "params")
+ " is a single integer or floating-point value that specifies
+ the intensity distribution of the light.
+ Integer and floating-point values are mapped directly.
+ Only values in the range "
+ (math "[" "0" "," "128" "]")
+ "
+are accepted. ")
+ (para "
+Effective light intensity is attenuated by the cosine of the angle between
+ the direction of the light and the direction from the light to the vertex
+ being lighted,
+ raised to the power of the spot exponent.
+ Thus, higher spot exponents result in a more focused light source,
+ regardless of the spot cutoff angle (see "
+ (code "GL_SPOT_CUTOFF")
+ ", next paragraph).
+ The initial spot exponent is 0,
+ resulting in uniform light distribution. "))
+ (entry (% (heading (code "GL_SPOT_CUTOFF")))
+ (para (var "params")
+ " is a single integer or floating-point value that specifies
+ the maximum spread angle of a light source.
+ Integer and floating-point values are mapped directly.
+ Only values in the range "
+ (math "[" "0" "," "90" "]")
+ "
+and the special value 180
+ are accepted.
+ If the angle between the direction of the light and the direction from the
+ light to the vertex being lighted is greater than the spot cutoff angle,
+ the light is completely masked.
+ Otherwise, its intensity is controlled by the spot exponent and the
+ attenuation factors.
+ The initial spot cutoff is 180,
+ resulting in uniform light distribution. "))
+ (entry (% (heading (code "GL_CONSTANT_ATTENUATION"))))
+ (entry (% (heading (code "GL_LINEAR_ATTENUATION"))))
+ (entry (% (heading (code "GL_QUADRATIC_ATTENUATION")))
+ (para (var "params")
+ " is a single integer or floating-point value that specifies
+ one of the three light attenuation factors.
+ Integer and floating-point values are mapped directly.
+ Only nonnegative values are accepted.
+ If the light is positional,
+ rather than directional,
+ its intensity is attenuated by the reciprocal of the sum of the constant
+ factor, the linear factor times the distance between the light
+ and the vertex being lighted,
+ and the quadratic factor times the square of the same distance.
+ The initial attenuation factors are (1, 0, 0),
+ resulting in no attenuation. ")))
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if either "
+ (var "light")
+ " or "
+ (var "pname")
+ "
+is not an accepted value. ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if a spot exponent value is specified
+ outside the range "
+ (math "[" "0" "," "128" "]")
+ ",
+ or if spot cutoff is specified outside the range "
+ (math "[" "0" "," "90" "]")
+ "
+(except for the
+ special value 180),
+ or if a negative attenuation factor is specified. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glLight")
+ " is executed between
+ the execution of "
+ (code "glBegin")
+ " and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glLineStipple
+ "glLineStipple"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glLineStipple"))
+ (paramdef "GLint " (parameter "factor"))
+ (paramdef "GLushort " (parameter "pattern"))))
+ '(*fragment*
+ (heading "specify the line stipple pattern")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "factor")))
+ (para "
+Specifies a multiplier for each bit in the line stipple pattern.
+ If "
+ (var "factor")
+ " is 3,
+ for example,
+ each bit in the pattern is used three times
+ before the next bit in the pattern is used. "
+ (var "factor")
+ " is clamped to the range [1, 256] and defaults to 1. "))
+ (entry (% (heading (var "pattern")))
+ (para "
+Specifies a 16-bit integer whose bit pattern determines
+ which fragments of a line will be drawn when the line is rasterized.
+ Bit zero is used first; the default pattern is all 1's. ")))
+ (heading "Description")
+ (para "
+Line stippling masks out certain fragments produced by rasterization;
+ those fragments will not be drawn.
+ The masking is achieved by using three parameters:
+ the 16-bit line stipple pattern "
+ (var "pattern")
+ ",
+ the repeat count "
+ (var "factor")
+ ",
+ and an integer stipple counter "
+ (math (var "s"))
+ ". ")
+ (para "
+Counter "
+ (math (var "s"))
+ "
+is reset to 0 whenever "
+ (code "glBegin")
+ " is called
+ and before each line segment of a "
+ (code "glBegin")
+ "("
+ (code "GL_LINES")
+ ")/"
+ (code "glEnd")
+ "
+sequence is generated.
+ It is incremented after each fragment of a unit width aliased line segment
+ is generated
+ or after each "
+ (math (var "i"))
+ "
+fragments of an "
+ (math (var "i"))
+ "
+width line segment are generated.
+ The "
+ (math (var "i"))
+ "
+fragments associated with count "
+ (math (var "s"))
+ "
+are masked out if ")
+ (para (var "pattern")
+ " bit "
+ (math "("
+ (var "s")
+ "/"
+ (var "factor")
+ ","
+ ")"
+ "%"
+ "16"))
+ (para "
+is 0, otherwise these fragments are sent to the frame buffer.
+ Bit zero of "
+ (var "pattern")
+ " is the least significant bit. ")
+ (para "
+Antialiased lines are treated as a sequence of "
+ (math "1" "×" (var "width"))
+ "
+rectangles
+ for purposes of stippling.
+ Whether rectangle "
+ (math (var "s"))
+ "
+is rasterized or not depends on the fragment rule
+ described for aliased lines,
+ counting rectangles rather than groups of fragments. ")
+ (para "
+To enable and disable line stippling, call "
+ (code "glEnable")
+ " and "
+ (code "glDisable")
+ "
+with argument "
+ (code "GL_LINE_STIPPLE")
+ ".
+ When enabled,
+ the line stipple pattern is applied as described above.
+ When disabled,
+ it is as if the pattern were all 1's.
+ Initially, line stippling is disabled. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glLineStipple")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glLineWidth
+ "glLineWidth"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glLineWidth"))
+ (paramdef "GLfloat " (parameter "width"))))
+ '(*fragment*
+ (heading "specify the width of rasterized lines")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "width")))
+ (para "
+Specifies the width of rasterized lines.
+ The initial value is 1. ")))
+ (heading "Description")
+ (para (code "glLineWidth")
+ " specifies the rasterized width of both aliased and antialiased
+ lines.
+ Using a line width other than 1 has different effects,
+ depending on whether line antialiasing is enabled.
+ To enable and disable line antialiasing, call "
+ (code "glEnable")
+ " and "
+ (code "glDisable")
+ "
+with argument "
+ (code "GL_LINE_SMOOTH")
+ ". Line antialiasing is initially
+ disabled. ")
+ (para "
+If line antialiasing is disabled,
+ the actual width is determined by rounding the supplied width
+ to the nearest integer.
+ (If the rounding results in the value 0,
+ it is as if the line width were 1.)
+ If "
+ (math "∣"
+ "Δ"
+ (var "x")
+ ","
+ "∣"
+ ">="
+ "∣"
+ "Δ"
+ (var "y")
+ ","
+ "∣")
+ ", "
+ (var "i")
+ " pixels are filled in each column that is rasterized,
+ where "
+ (var "i")
+ " is the rounded value of "
+ (var "width")
+ ".
+ Otherwise, "
+ (var "i")
+ " pixels are filled in each row that is rasterized. ")
+ (para "
+If antialiasing is enabled,
+ line rasterization produces a fragment for each pixel square
+ that intersects the region lying within the rectangle having width
+ equal to the current line width,
+ length equal to the actual length of the line,
+ and centered on the mathematical line segment.
+ The coverage value for each fragment is the window coordinate area
+ of the intersection of the rectangular region with the corresponding
+ pixel square.
+ This value is saved and used in the final rasterization step. ")
+ (para "
+Not all widths can be supported when line antialiasing is enabled. If an
+ unsupported width is requested, the nearest supported width is used.
+ Only width 1 is guaranteed to be supported; others depend on the
+ implementation. Likewise, there is a range for aliased line widths as well.
+ To query the range of supported widths and the size
+ difference between supported widths within the range, call "
+ (code "glGet")
+ "
+with arguments "
+ (code "GL_ALIASED_LINE_WIDTH_RANGE")
+ ", "
+ (code "GL_SMOOTH_LINE_WIDTH_RANGE")
+ ", and "
+ (code "GL_SMOOTH_LINE_WIDTH_GRANULARITY")
+ ". ")
+ (heading "Errors")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "width")
+ " is less than or equal to 0. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glLineWidth")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glLinkProgram
+ "glLinkProgram"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glLinkProgram"))
+ (paramdef "GLuint " (parameter "program"))))
+ '(*fragment*
+ (heading "Links a program object")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "program")))
+ (para "Specifies the handle of the program object to be linked.")))
+ (heading "Description")
+ (para (code "glLinkProgram")
+ " links the program
+\tobject specified by "
+ (var "program")
+ ". If any
+\tshader objects of type "
+ (code "GL_VERTEX_SHADER")
+ " are
+\tattached to "
+ (var "program")
+ ", they will be used to
+\tcreate an executable that will run on the programmable vertex
+\tprocessor. If any shader objects of type\t"
+ (code "GL_FRAGMENT_SHADER")
+ " are attached to\t"
+ (var "program")
+ ", they will be used to create an
+\texecutable that will run on the programmable fragment
+\tprocessor.")
+ (para "The status of the link operation will be stored as part of
+\tthe program object's state. This value will be set to\t"
+ (code "GL_TRUE")
+ " if the program object was linked
+\twithout errors and is ready for use, and\t"
+ (code "GL_FALSE")
+ " otherwise. It can be queried by
+\tcalling\t"
+ (code "glGetProgram")
+ "
+with arguments "
+ (var "program")
+ " and\t"
+ (code "GL_LINK_STATUS")
+ ".")
+ (para "As a result of a successful link operation, all active
+\tuser-defined uniform variables belonging to\t"
+ (var "program")
+ " will be initialized to 0, and
+\teach of the program object's active uniform variables will be
+\tassigned a location that can be queried by calling\t"
+ (code "glGetUniformLocation")
+ ".
+\tAlso, any active user-defined attribute variables that have not
+\tbeen bound to a generic vertex attribute index will be bound to
+\tone at this time.")
+ (para "Linking of a program object can fail for a number of
+\treasons as specified in the "
+ (var "OpenGL Shading Language
+\tSpecification")
+ ". The following lists some of the
+\tconditions that will cause a link error.")
+ (itemize
+ (item (para "The number of active attribute variables supported
+\t\tby the implementation has been exceeded."))
+ (item (para "The storage limit for uniform variables has been
+\t\texceeded."))
+ (item (para "The number of active uniform variables supported
+\t\tby the implementation has been exceeded."))
+ (item (para "The "
+ (code "main")
+ " function is missing
+\t\tfor the vertex shader or the fragment shader."))
+ (item (para "A varying variable actually used in the fragment
+\t\tshader is not declared in the same way (or is not
+\t\tdeclared at all) in the vertex shader."))
+ (item (para "A reference to a function or variable name is
+\t\tunresolved."))
+ (item (para "A shared global is declared with two different
+\t\ttypes or two different initial values."))
+ (item (para "One or more of the attached shader objects has not
+\t\tbeen successfully compiled."))
+ (item (para "Binding a generic attribute matrix caused some
+\t\trows of the matrix to fall outside the allowed maximum
+\t\tof "
+ (code "GL_MAX_VERTEX_ATTRIBS")
+ "."))
+ (item (para "Not enough contiguous vertex attribute slots could
+\t\tbe found to bind attribute matrices.")))
+ (para "When a program object has been successfully linked, the
+\tprogram object can be made part of current state by calling\t"
+ (code "glUseProgram")
+ ".
+\tWhether or not the link operation was successful, the program
+\tobject's information log will be overwritten. The information
+\tlog can be retrieved by calling\t"
+ (code "glGetProgramInfoLog")
+ ".")
+ (para (code "glLinkProgram")
+ " will also install the
+\tgenerated executables as part of the current rendering state if
+\tthe link operation was successful and the specified program
+\tobject is already currently in use as a result of a previous
+\tcall to\t"
+ (code "glUseProgram")
+ ".
+\tIf the program object currently in use is relinked
+\tunsuccessfully, its link status will be set to\t"
+ (code "GL_FALSE")
+ " , but the executables and
+\tassociated state will remain part of the current state until a
+\tsubsequent call to "
+ (code "glUseProgram")
+ " removes it
+\tfrom use. After it is removed from use, it cannot be made part
+\tof current state until it has been successfully relinked.")
+ (para "If "
+ (var "program")
+ " contains shader objects
+\tof type "
+ (code "GL_VERTEX_SHADER")
+ " but does not
+\tcontain shader objects of type\t"
+ (code "GL_FRAGMENT_SHADER")
+ ", the vertex shader will
+\tbe linked against the implicit interface for fixed functionality
+\tfragment processing. Similarly, if\t"
+ (var "program")
+ " contains shader objects of type\t"
+ (code "GL_FRAGMENT_SHADER")
+ " but it does not contain
+\tshader objects of type "
+ (code "GL_VERTEX_SHADER")
+ ",
+\tthe fragment shader will be linked against the implicit
+\tinterface for fixed functionality vertex processing.")
+ (para "The program object's information log is updated and the
+\tprogram is generated at the time of the link operation. After
+\tthe link operation, applications are free to modify attached
+\tshader objects, compile attached shader objects, detach shader
+\tobjects, delete shader objects, and attach additional shader
+\tobjects. None of these operations affects the information log or
+\tthe program that is part of the program object.")
+ (heading "Errors")
+ (para (code "GL_INVALID_VALUE")
+ "
+is generated if "
+ (var "program")
+ "
+is not a value generated by OpenGL.")
+ (para (code "GL_INVALID_OPERATION")
+ "
+is generated if "
+ (var "program")
+ "
+is not a program object.")
+ (para (code "GL_INVALID_OPERATION")
+ "
+is generated if "
+ (code "glLinkProgram")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ".")))
+
+(define-gl-procedure
+ glListBase
+ "glListBase"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glListBase"))
+ (paramdef "GLuint " (parameter "base"))))
+ '(*fragment*
+ (heading "set the display-list base for ")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "base")))
+ (para "
+Specifies an integer offset that will be added to "
+ (code "glCallLists")
+ "
+offsets to generate display-list names.
+ The initial value is 0. ")))
+ (heading "Description")
+ (para (code "glCallLists")
+ " specifies an array of offsets.
+ Display-list names are generated by adding "
+ (var "base")
+ " to each offset.
+ Names that reference valid display lists are executed;
+ the others are ignored. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glListBase")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glLoadIdentity
+ "glLoadIdentity"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glLoadIdentity"))
+ (paramdef (parameter "void"))))
+ '(*fragment*
+ (heading
+ "replace the current matrix with the identity matrix")
+ (heading "Description")
+ (para (code "glLoadIdentity")
+ " replaces the current matrix with the identity matrix.
+ It is semantically equivalent to calling "
+ (code "glLoadMatrix")
+ "
+with the identity matrix ")
+ (para)
+ (para (math "("
+ "("
+ "1"
+ " "
+ "0"
+ " "
+ "0"
+ " "
+ "0"
+ ")"
+ ", "
+ "("
+ "0"
+ " "
+ "1"
+ " "
+ "0"
+ " "
+ "0"
+ ")"
+ ", "
+ "("
+ "0"
+ " "
+ "0"
+ " "
+ "1"
+ " "
+ "0"
+ ")"
+ ", "
+ "("
+ "0"
+ " "
+ "0"
+ " "
+ "0"
+ " "
+ "1"
+ ")"
+ ","
+ ","
+ ")"))
+ (para)
+ (para "
+but in some cases it is more efficient. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glLoadIdentity")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glLoadMatrix
+ "glLoadMatrix"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glLoadMatrixd"))
+ (paramdef "const GLdouble * " (parameter "m"))))
+ '(*fragment*
+ (heading
+ "replace the current matrix with the specified matrix")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "m")))
+ (para "
+Specifies a pointer to 16 consecutive values, which are used as the
+ elements of a "
+ (math "4" "×" "4")
+ "
+column-major matrix. ")))
+ (heading "Description")
+ (para (code "glLoadMatrix")
+ " replaces the current matrix with the one whose elements are specified by "
+ (var "m")
+ ".
+ The current matrix is the projection matrix,
+ modelview matrix,
+ or texture matrix,
+ depending on the current matrix mode
+ (see "
+ (code "glMatrixMode")
+ "). ")
+ (para "
+The current matrix, M, defines a transformation of coordinates.
+ For instance, assume M refers to the modelview matrix.
+ If "
+ (math (var "v")
+ "="
+ "("
+ (var "v")
+ "\u2061"
+ "["
+ "0"
+ ","
+ "]"
+ ","
+ (var "v")
+ "\u2061"
+ "["
+ "1"
+ ","
+ "]"
+ (var "v")
+ "\u2061"
+ "["
+ "2"
+ ","
+ "]"
+ (var "v")
+ "\u2061"
+ "["
+ "3"
+ ","
+ "]"
+ ")")
+ "
+is the set of object coordinates
+ of a vertex,
+ and "
+ (var "m")
+ " points to an array of "
+ (math "16")
+ "
+single- or double-precision
+ floating-point values "
+ (math (var "m")
+ "="
+ "{"
+ (var "m")
+ "\u2061"
+ "["
+ "0"
+ ","
+ "]"
+ ","
+ (var "m")
+ "\u2061"
+ "["
+ "1"
+ ","
+ "]"
+ (var "...")
+ (var "m")
+ "\u2061"
+ "["
+ "15"
+ ","
+ "]"
+ "}")
+ ",
+ then the modelview transformation "
+ (math (var "M") "\u2061" "(" (var "v") "," ")")
+ "
+does the following: ")
+ (para (math (var "M")
+ "\u2061"
+ "("
+ (var "v")
+ ","
+ ")"
+ "="
+ "("
+ "("
+ (var "m")
+ "\u2061"
+ "["
+ "0"
+ ","
+ "]"
+ " "
+ (var "m")
+ "\u2061"
+ "["
+ "4"
+ ","
+ "]"
+ " "
+ (var "m")
+ "\u2061"
+ "["
+ "8"
+ ","
+ "]"
+ " "
+ (var "m")
+ "\u2061"
+ "["
+ "12"
+ ","
+ "]"
+ ")"
+ ", "
+ "("
+ (var "m")
+ "\u2061"
+ "["
+ "1"
+ ","
+ "]"
+ " "
+ (var "m")
+ "\u2061"
+ "["
+ "5"
+ ","
+ "]"
+ " "
+ (var "m")
+ "\u2061"
+ "["
+ "9"
+ ","
+ "]"
+ " "
+ (var "m")
+ "\u2061"
+ "["
+ "13"
+ ","
+ "]"
+ ")"
+ ", "
+ "("
+ (var "m")
+ "\u2061"
+ "["
+ "2"
+ ","
+ "]"
+ " "
+ (var "m")
+ "\u2061"
+ "["
+ "6"
+ ","
+ "]"
+ " "
+ (var "m")
+ "\u2061"
+ "["
+ "10"
+ ","
+ "]"
+ " "
+ (var "m")
+ "\u2061"
+ "["
+ "14"
+ ","
+ "]"
+ ")"
+ ", "
+ "("
+ (var "m")
+ "\u2061"
+ "["
+ "3"
+ ","
+ "]"
+ " "
+ (var "m")
+ "\u2061"
+ "["
+ "7"
+ ","
+ "]"
+ " "
+ (var "m")
+ "\u2061"
+ "["
+ "11"
+ ","
+ "]"
+ " "
+ (var "m")
+ "\u2061"
+ "["
+ "15"
+ ","
+ "]"
+ ")"
+ ","
+ ")"
+ "×"
+ "("
+ "("
+ (var "v")
+ "\u2061"
+ "["
+ "0"
+ ","
+ "]"
+ ")"
+ ", "
+ "("
+ (var "v")
+ "\u2061"
+ "["
+ "1"
+ ","
+ "]"
+ ")"
+ ", "
+ "("
+ (var "v")
+ "\u2061"
+ "["
+ "2"
+ ","
+ "]"
+ ")"
+ ", "
+ "("
+ (var "v")
+ "\u2061"
+ "["
+ "3"
+ ","
+ "]"
+ ")"
+ ","
+ ")"))
+ (para)
+ (para "
+Projection and texture transformations are similarly defined. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glLoadMatrix")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glLoadName
+ "glLoadName"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glLoadName"))
+ (paramdef "GLuint " (parameter "name"))))
+ '(*fragment*
+ (heading "load a name onto the name stack")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "name")))
+ (para "
+Specifies a name that will replace the top value on the name stack. ")))
+ (heading "Description")
+ (para "
+The name stack is used during selection mode to allow sets of rendering
+ commands to be uniquely identified.
+ It consists of an ordered set of unsigned integers and is initially empty. ")
+ (para (code "glLoadName")
+ " causes "
+ (var "name")
+ " to replace the value on the top of the name stack. ")
+ (para "
+The name stack is always empty while the render mode is not "
+ (code "GL_SELECT")
+ ".
+ Calls to "
+ (code "glLoadName")
+ " while the render mode is not "
+ (code "GL_SELECT")
+ " are ignored. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glLoadName")
+ " is called while the
+ name stack is empty. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glLoadName")
+ " is executed between
+ the execution of "
+ (code "glBegin")
+ " and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glLoadTransposeMatrix
+ "glLoadTransposeMatrix"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "void "
+ (function "glLoadTransposeMatrixd"))
+ (paramdef "const GLdouble * " (parameter "m"))))
+ '(*fragment*
+ (heading
+ "replace the current matrix with the specified row-major ordered matrix")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "m")))
+ (para "
+Specifies a pointer to 16 consecutive values, which are used as the
+ elements of a "
+ (math "4" "×" "4")
+ "
+row-major matrix. ")))
+ (heading "Description")
+ (para (code "glLoadTransposeMatrix")
+ " replaces the current matrix with the one whose elements are specified by "
+ (var "m")
+ ".
+ The current matrix is the projection matrix,
+ modelview matrix,
+ or texture matrix,
+ depending on the current matrix mode
+ (see "
+ (code "glMatrixMode")
+ "). ")
+ (para "
+The current matrix, M, defines a transformation of coordinates.
+ For instance, assume M refers to the modelview matrix.
+ If "
+ (math (var "v")
+ "="
+ "("
+ (var "v")
+ "\u2061"
+ "["
+ "0"
+ ","
+ "]"
+ ","
+ (var "v")
+ "\u2061"
+ "["
+ "1"
+ ","
+ "]"
+ (var "v")
+ "\u2061"
+ "["
+ "2"
+ ","
+ "]"
+ (var "v")
+ "\u2061"
+ "["
+ "3"
+ ","
+ "]"
+ ")")
+ "
+is the set of object coordinates
+ of a vertex,
+ and "
+ (var "m")
+ " points to an array of "
+ (math "16")
+ "
+single- or double-precision
+ floating-point values "
+ (math (var "m")
+ "="
+ "{"
+ (var "m")
+ "\u2061"
+ "["
+ "0"
+ ","
+ "]"
+ ","
+ (var "m")
+ "\u2061"
+ "["
+ "1"
+ ","
+ "]"
+ (var "...")
+ (var "m")
+ "\u2061"
+ "["
+ "15"
+ ","
+ "]"
+ "}")
+ ",
+ then the modelview transformation "
+ (math (var "M") "\u2061" "(" (var "v") "," ")")
+ "
+does the following: ")
+ (para (math (var "M")
+ "\u2061"
+ "("
+ (var "v")
+ ","
+ ")"
+ "="
+ "("
+ "("
+ (var "m")
+ "\u2061"
+ "["
+ "0"
+ ","
+ "]"
+ " "
+ (var "m")
+ "\u2061"
+ "["
+ "1"
+ ","
+ "]"
+ " "
+ (var "m")
+ "\u2061"
+ "["
+ "2"
+ ","
+ "]"
+ " "
+ (var "m")
+ "\u2061"
+ "["
+ "3"
+ ","
+ "]"
+ ")"
+ ", "
+ "("
+ (var "m")
+ "\u2061"
+ "["
+ "4"
+ ","
+ "]"
+ " "
+ (var "m")
+ "\u2061"
+ "["
+ "5"
+ ","
+ "]"
+ " "
+ (var "m")
+ "\u2061"
+ "["
+ "6"
+ ","
+ "]"
+ " "
+ (var "m")
+ "\u2061"
+ "["
+ "7"
+ ","
+ "]"
+ ")"
+ ", "
+ "("
+ (var "m")
+ "\u2061"
+ "["
+ "8"
+ ","
+ "]"
+ " "
+ (var "m")
+ "\u2061"
+ "["
+ "9"
+ ","
+ "]"
+ " "
+ (var "m")
+ "\u2061"
+ "["
+ "10"
+ ","
+ "]"
+ " "
+ (var "m")
+ "\u2061"
+ "["
+ "11"
+ ","
+ "]"
+ ")"
+ ", "
+ "("
+ (var "m")
+ "\u2061"
+ "["
+ "12"
+ ","
+ "]"
+ " "
+ (var "m")
+ "\u2061"
+ "["
+ "13"
+ ","
+ "]"
+ " "
+ (var "m")
+ "\u2061"
+ "["
+ "14"
+ ","
+ "]"
+ " "
+ (var "m")
+ "\u2061"
+ "["
+ "15"
+ ","
+ "]"
+ ")"
+ ","
+ ")"
+ "×"
+ "("
+ "("
+ (var "v")
+ "\u2061"
+ "["
+ "0"
+ ","
+ "]"
+ ")"
+ ", "
+ "("
+ (var "v")
+ "\u2061"
+ "["
+ "1"
+ ","
+ "]"
+ ")"
+ ", "
+ "("
+ (var "v")
+ "\u2061"
+ "["
+ "2"
+ ","
+ "]"
+ ")"
+ ", "
+ "("
+ (var "v")
+ "\u2061"
+ "["
+ "3"
+ ","
+ "]"
+ ")"
+ ","
+ ")"))
+ (para)
+ (para "
+Projection and texture transformations are similarly defined. ")
+ (para "
+Calling "
+ (code "glLoadTransposeMatrix")
+ " with matrix "
+ (math (var "M"))
+ "
+is identical in operation to "
+ (code "glLoadMatrix")
+ " with "
+ (math (var "M") "^" (var "T"))
+ ",
+ where "
+ (math (var "T"))
+ "
+represents the transpose. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glLoadTransposeMatrix")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glLogicOp
+ "glLogicOp"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glLogicOp"))
+ (paramdef "GLenum " (parameter "opcode"))))
+ '(*fragment*
+ (heading
+ "specify a logical pixel operation for color index rendering")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "opcode")))
+ (para "
+Specifies a symbolic constant that selects a logical operation.
+ The following symbols are accepted: "
+ (code "GL_CLEAR")
+ ", "
+ (code "GL_SET")
+ ", "
+ (code "GL_COPY")
+ ", "
+ (code "GL_COPY_INVERTED")
+ ", "
+ (code "GL_NOOP")
+ ", "
+ (code "GL_INVERT")
+ ", "
+ (code "GL_AND")
+ ", "
+ (code "GL_NAND")
+ ", "
+ (code "GL_OR")
+ ", "
+ (code "GL_NOR")
+ ", "
+ (code "GL_XOR")
+ ", "
+ (code "GL_EQUIV")
+ ", "
+ (code "GL_AND_REVERSE")
+ ", "
+ (code "GL_AND_INVERTED")
+ ", "
+ (code "GL_OR_REVERSE")
+ ", and "
+ (code "GL_OR_INVERTED")
+ ". The initial value is "
+ (code "GL_COPY")
+ ". ")))
+ (heading "Description")
+ (para (code "glLogicOp")
+ " specifies a logical operation that,
+ when enabled,
+ is applied between the incoming color index or RGBA color
+ and the color index or RGBA color at the corresponding location in the
+ frame buffer.
+ To enable or disable the logical operation, call "
+ (code "glEnable")
+ " and "
+ (code "glDisable")
+ "
+using the symbolic constant "
+ (code "GL_COLOR_LOGIC_OP")
+ " for RGBA mode or "
+ (code "GL_INDEX_LOGIC_OP")
+ " for color index mode. The initial value is
+ disabled for both operations. ")
+ (para)
+ (table (% (formatter (asis)))
+ (entry (% (heading (strong "Opcode")))
+ (para (strong "Resulting Operation")))
+ (entry (% (heading (code "GL_CLEAR")))
+ (para "
+0 "))
+ (entry (% (heading (code "GL_SET")))
+ (para "
+1 "))
+ (entry (% (heading (code "GL_COPY")))
+ (para "
+s "))
+ (entry (% (heading (code "GL_COPY_INVERTED")))
+ (para "
+~s "))
+ (entry (% (heading (code "GL_NOOP")))
+ (para "
+d "))
+ (entry (% (heading (code "GL_INVERT")))
+ (para "
+~d "))
+ (entry (% (heading (code "GL_AND")))
+ (para "
+s & d "))
+ (entry (% (heading (code "GL_NAND")))
+ (para "
+~(s & d) "))
+ (entry (% (heading (code "GL_OR")))
+ (para "
+s | d "))
+ (entry (% (heading (code "GL_NOR")))
+ (para "
+~(s | d) "))
+ (entry (% (heading (code "GL_XOR")))
+ (para "
+s ^ d "))
+ (entry (% (heading (code "GL_EQUIV")))
+ (para "
+~(s ^ d) "))
+ (entry (% (heading (code "GL_AND_REVERSE")))
+ (para "
+s & ~d "))
+ (entry (% (heading (code "GL_AND_INVERTED")))
+ (para "
+~s & d "))
+ (entry (% (heading (code "GL_OR_REVERSE")))
+ (para "
+s | ~d "))
+ (entry (% (heading (code "GL_OR_INVERTED")))
+ (para "
+~s | d ")))
+ (para (var "opcode")
+ " is a symbolic constant chosen from the list above.
+ In the explanation of the logical operations, "
+ (var "s")
+ " represents the incoming color index and "
+ (var "d")
+ " represents the index in the frame buffer.
+ Standard C-language operators are used.
+ As these bitwise operators suggest,
+ the logical operation is applied independently to each bit pair of the
+ source and destination indices or colors. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "opcode")
+ " is not an accepted value. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glLogicOp")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glMap1
+ "glMap1"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glMap1f"))
+ (paramdef "GLenum " (parameter "target"))
+ (paramdef "GLfloat " (parameter "u1"))
+ (paramdef "GLfloat " (parameter "u2"))
+ (paramdef "GLint " (parameter "stride"))
+ (paramdef "GLint " (parameter "order"))
+ (paramdef
+ "const GLfloat * "
+ (parameter "points"))))
+ '(*fragment*
+ (heading "define a one-dimensional evaluator")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "target")))
+ (para "
+Specifies the kind of values that are generated by the evaluator.
+ Symbolic constants "
+ (code "GL_MAP1_VERTEX_3")
+ ", "
+ (code "GL_MAP1_VERTEX_4")
+ ", "
+ (code "GL_MAP1_INDEX")
+ ", "
+ (code "GL_MAP1_COLOR_4")
+ ", "
+ (code "GL_MAP1_NORMAL")
+ ", "
+ (code "GL_MAP1_TEXTURE_COORD_1")
+ ", "
+ (code "GL_MAP1_TEXTURE_COORD_2")
+ ", "
+ (code "GL_MAP1_TEXTURE_COORD_3")
+ ", and "
+ (code "GL_MAP1_TEXTURE_COORD_4")
+ " are accepted. "))
+ (entry (% (heading (var "u1")))
+ (itemx (var "u2"))
+ (para "
+Specify a linear mapping of "
+ (math (var "u"))
+ ",
+ as presented to "
+ (code "glEvalCoord1")
+ ",
+ to "
+ (math (var "u") "^")
+ ",
+ the variable that is evaluated by the equations specified by this command. "))
+ (entry (% (heading (var "stride")))
+ (para "
+Specifies the number of floats or doubles between
+ the beginning of one control point and the beginning of the next one
+ in the data structure referenced in "
+ (var "points")
+ ".
+ This allows control points to be embedded in arbitrary data structures.
+ The only constraint is that the values for a particular control point
+ must occupy contiguous memory locations. "))
+ (entry (% (heading (var "order")))
+ (para "
+Specifies the number of control points.
+ Must be positive. "))
+ (entry (% (heading (var "points")))
+ (para "
+Specifies a pointer to the array of control points. ")))
+ (heading "Description")
+ (para "
+Evaluators provide a way to use polynomial or rational polynomial mapping
+ to produce vertices,
+ normals,
+ texture coordinates,
+ and colors.
+ The values produced by an evaluator are sent to further stages
+ of GL processing just as if they had been presented using "
+ (code "glVertex")
+ ", "
+ (code "glNormal")
+ ", "
+ (code "glTexCoord")
+ ", and "
+ (code "glColor")
+ " commands,
+ except that the generated values do not update the current normal,
+ texture coordinates,
+ or color. ")
+ (para "
+All polynomial or rational polynomial splines of any degree
+ (up to the maximum degree supported by the GL implementation)
+ can be described using evaluators.
+ These include almost all splines used in computer graphics: B-splines,
+ Bezier curves, Hermite splines, and so on. ")
+ (para "
+Evaluators define curves based on Bernstein polynomials.
+ Define "
+ (math (var "p")
+ "\u2061"
+ "("
+ (var "u")
+ "^"
+ ","
+ ")")
+ "
+as ")
+ (para (math (var "p")
+ "\u2061"
+ "("
+ (var "u")
+ "^"
+ ","
+ ")"
+ "="
+ "Σ"
+ (var "i")
+ "="
+ "0"
+ (var "n")
+ (var "B")
+ "_"
+ (var "i")
+ ","
+ "^"
+ (var "n")
+ "\u2061"
+ "("
+ (var "u")
+ "^"
+ ","
+ ")"
+ "\u2062"
+ (var "R")
+ "_"
+ (var "i")))
+ (para)
+ (para "
+where "
+ (math (var "R") "_" (var "i"))
+ "
+is a control point and "
+ (math (var "B")
+ "_"
+ (var "i")
+ ","
+ "^"
+ (var "n")
+ "\u2061"
+ "("
+ (var "u")
+ "^"
+ ","
+ ")")
+ "
+is the "
+ (math (var "i"))
+ "th
+ Bernstein polynomial of degree "
+ (math (var "n"))
+ "
+("
+ (var "order")
+ " = "
+ (math (var "n") "+" "1")
+ "): ")
+ (para (math (var "B")
+ "_"
+ (var "i")
+ ","
+ "^"
+ (var "n")
+ "\u2061"
+ "("
+ (var "u")
+ "^"
+ ","
+ ")"
+ "="
+ "("
+ "("
+ (var "n")
+ ")"
+ ", "
+ "("
+ (var "i")
+ ")"
+ ","
+ ","
+ ")"
+ "\u2062"
+ (var "u")
+ "^"
+ ","
+ "^"
+ (var "i")
+ "\u2062"
+ "("
+ "1"
+ "-"
+ (var "u")
+ "^"
+ ","
+ ")"
+ "^"
+ (var "n")
+ "-"
+ (var "i")
+ ","
+ ","))
+ (para "
+Recall that ")
+ (para (math "0" "^" "0" "==" "1")
+ "
+and "
+ (math "("
+ "("
+ (var "n")
+ ")"
+ ", "
+ "("
+ "0"
+ ")"
+ ","
+ ","
+ ")"
+ "=="
+ "1"))
+ (para (code "glMap1")
+ " is used to define the basis and to specify what kind of values
+ are produced.
+ Once defined,
+ a map can be enabled and disabled by calling "
+ (code "glEnable")
+ " and "
+ (code "glDisable")
+ "
+with the map name, one of the nine predefined values for "
+ (var "target")
+ "
+described below. "
+ (code "glEvalCoord1")
+ " evaluates the one-dimensional maps that are enabled.
+ When "
+ (code "glEvalCoord1")
+ " presents a value "
+ (math (var "u"))
+ ",
+ the Bernstein functions are evaluated using "
+ (math (var "u") "^")
+ ",
+ where "
+ (math (var "u")
+ "^"
+ "="
+ (var "u")
+ "-"
+ (var "u1")
+ ","
+ "/"
+ (var "u2")
+ "-"
+ (var "u1")
+ ","))
+ (para (var "target")
+ " is a symbolic constant that indicates what kind of control points
+ are provided in "
+ (var "points")
+ ",
+ and what output is generated when the map is evaluated.
+ It can assume one of nine predefined values: ")
+ (table (% (formatter (asis)))
+ (entry (% (heading (code "GL_MAP1_VERTEX_3")))
+ (para "
+Each control point is three floating-point values representing "
+ (math (var "x"))
+ ", "
+ (math (var "y"))
+ ",
+ and "
+ (math (var "z"))
+ ".
+ Internal "
+ (code "glVertex3")
+ " commands are generated when the map is evaluated. "))
+ (entry (% (heading (code "GL_MAP1_VERTEX_4")))
+ (para "
+Each control point is four floating-point values representing "
+ (math (var "x"))
+ ", "
+ (math (var "y"))
+ ", "
+ (math (var "z"))
+ ",
+ and "
+ (math (var "w"))
+ ".
+ Internal "
+ (code "glVertex4")
+ " commands are generated when the map is evaluated. "))
+ (entry (% (heading (code "GL_MAP1_INDEX")))
+ (para "
+Each control point is a single floating-point value representing a color index.
+ Internal "
+ (code "glIndex")
+ " commands are generated when the map is evaluated
+ but the current index is not updated with the value of these "
+ (code "glIndex")
+ "
+commands. "))
+ (entry (% (heading (code "GL_MAP1_COLOR_4")))
+ (para "
+Each control point is four floating-point values representing
+ red, green, blue, and alpha.
+ Internal "
+ (code "glColor4")
+ " commands are generated when the map is
+ evaluated but the current color is not updated with the value of these "
+ (code "glColor4")
+ " commands. "))
+ (entry (% (heading (code "GL_MAP1_NORMAL")))
+ (para "
+Each control point is three floating-point values representing
+ the "
+ (math (var "x"))
+ ", "
+ (math (var "y"))
+ ",
+ and "
+ (math (var "z"))
+ "
+components of a normal vector.
+ Internal "
+ (code "glNormal")
+ " commands are generated when the map is
+ evaluated but the current normal is not updated with the value of
+ these "
+ (code "glNormal")
+ " commands. "))
+ (entry (% (heading (code "GL_MAP1_TEXTURE_COORD_1")))
+ (para "
+Each control point is a single floating-point value representing
+ the "
+ (math (var "s"))
+ "
+texture coordinate.
+ Internal "
+ (code "glTexCoord1")
+ " commands are generated when the map is
+ evaluated but the current texture coordinates are not updated with the value
+ of these "
+ (code "glTexCoord")
+ " commands. "))
+ (entry (% (heading (code "GL_MAP1_TEXTURE_COORD_2")))
+ (para "
+Each control point is two floating-point values representing
+ the "
+ (math (var "s"))
+ "
+and "
+ (math (var "t"))
+ "
+texture coordinates.
+ Internal "
+ (code "glTexCoord2")
+ " commands are generated when the map is
+ evaluated but the current texture coordinates are not updated with the value
+ of these "
+ (code "glTexCoord")
+ " commands. "))
+ (entry (% (heading (code "GL_MAP1_TEXTURE_COORD_3")))
+ (para "
+Each control point is three floating-point values representing
+ the "
+ (math (var "s"))
+ ", "
+ (math (var "t"))
+ ",
+ and "
+ (math (var "r"))
+ "
+texture coordinates.
+ Internal "
+ (code "glTexCoord3")
+ " commands are generated when the map is
+ evaluated but the current texture coordinates are not updated with the value
+ of these "
+ (code "glTexCoord")
+ " commands. "))
+ (entry (% (heading (code "GL_MAP1_TEXTURE_COORD_4")))
+ (para "
+Each control point is four floating-point values representing
+ the "
+ (math (var "s"))
+ ", "
+ (math (var "t"))
+ ", "
+ (math (var "r"))
+ ",
+ and "
+ (math (var "q"))
+ "
+texture coordinates.
+ Internal "
+ (code "glTexCoord4")
+ " commands are generated when the map is evaluated but
+ the current texture coordinates are not updated with the value
+ of these "
+ (code "glTexCoord")
+ " commands. ")))
+ (para (var "stride")
+ ", "
+ (var "order")
+ ", and "
+ (var "points")
+ " define the array addressing for accessing the control points. "
+ (var "points")
+ " is the location of the first control point,
+ which occupies one, two, three, or four contiguous memory locations,
+ depending on which map is being defined. "
+ (var "order")
+ " is the number of control points in the array. "
+ (var "stride")
+ " specifies how many float or double locations to advance the internal
+ memory pointer to reach the next control point. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "target")
+ " is not an accepted value. ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "u1")
+ " is equal to "
+ (var "u2")
+ ". ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "stride")
+ " is less than the number
+ of values in a control point. ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "order")
+ " is less than 1 or
+ greater than the return value of "
+ (code "GL_MAX_EVAL_ORDER")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glMap1")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glMap1")
+ " is called and the value
+ of "
+ (code "GL_ACTIVE_TEXTURE")
+ " is not "
+ (code "GL_TEXTURE0")
+ ". ")))
+
+(define-gl-procedure
+ glMap2
+ "glMap2"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glMap2f"))
+ (paramdef "GLenum " (parameter "target"))
+ (paramdef "GLfloat " (parameter "u1"))
+ (paramdef "GLfloat " (parameter "u2"))
+ (paramdef "GLint " (parameter "ustride"))
+ (paramdef "GLint " (parameter "uorder"))
+ (paramdef "GLfloat " (parameter "v1"))
+ (paramdef "GLfloat " (parameter "v2"))
+ (paramdef "GLint " (parameter "vstride"))
+ (paramdef "GLint " (parameter "vorder"))
+ (paramdef
+ "const GLfloat * "
+ (parameter "points"))))
+ '(*fragment*
+ (heading "define a two-dimensional evaluator")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "target")))
+ (para "
+Specifies the kind of values that are generated by the evaluator.
+ Symbolic constants "
+ (code "GL_MAP2_VERTEX_3")
+ ", "
+ (code "GL_MAP2_VERTEX_4")
+ ", "
+ (code "GL_MAP2_INDEX")
+ ", "
+ (code "GL_MAP2_COLOR_4")
+ ", "
+ (code "GL_MAP2_NORMAL")
+ ", "
+ (code "GL_MAP2_TEXTURE_COORD_1")
+ ", "
+ (code "GL_MAP2_TEXTURE_COORD_2")
+ ", "
+ (code "GL_MAP2_TEXTURE_COORD_3")
+ ", and "
+ (code "GL_MAP2_TEXTURE_COORD_4")
+ " are accepted. "))
+ (entry (% (heading (var "u1")))
+ (itemx (var "u2"))
+ (para "
+Specify a linear mapping of "
+ (math (var "u"))
+ ",
+ as presented to "
+ (code "glEvalCoord2")
+ ",
+ to "
+ (math (var "u") "^")
+ ",
+ one of the two variables that are evaluated by the equations specified
+ by this command. Initially, "
+ (var "u1")
+ " is 0 and "
+ (var "u2")
+ " is 1. "))
+ (entry (% (heading (var "ustride")))
+ (para "
+Specifies the number of floats or doubles between
+ the beginning of control point "
+ (math (var "R") "_" (var "ij"))
+ "
+and the beginning of control point "
+ (math (var "R")
+ "_"
+ "("
+ (var "i")
+ "+"
+ "1"
+ ","
+ ")"
+ "\u2062"
+ (var "j")
+ ",")
+ ",
+ where "
+ (math (var "i"))
+ "
+and "
+ (math (var "j"))
+ "
+are the "
+ (math (var "u"))
+ "
+and "
+ (math (var "v"))
+ "
+control point indices, respectively.
+ This allows control points to be embedded in arbitrary data structures.
+ The only constraint is that the values for a particular control point
+ must occupy contiguous memory locations. The initial value of "
+ (var "ustride")
+ " is 0. "))
+ (entry (% (heading (var "uorder")))
+ (para "
+Specifies the dimension of the control point array in the "
+ (math (var "u"))
+ "
+axis.
+ Must be positive. The initial value is 1. "))
+ (entry (% (heading (var "v1")))
+ (itemx (var "v2"))
+ (para "
+Specify a linear mapping of "
+ (math (var "v"))
+ ",
+ as presented to "
+ (code "glEvalCoord2")
+ ",
+ to "
+ (math (var "v") "^")
+ ",
+ one of the two variables that are evaluated by the equations specified
+ by this command. Initially, "
+ (var "v1")
+ " is 0 and "
+ (var "v2")
+ " is 1. "))
+ (entry (% (heading (var "vstride")))
+ (para "
+Specifies the number of floats or doubles between
+ the beginning of control point "
+ (math (var "R") "_" (var "ij"))
+ "
+and the beginning of control point "
+ (math (var "R")
+ "_"
+ (var "i")
+ "\u2061"
+ "("
+ (var "j")
+ "+"
+ "1"
+ ","
+ ")"
+ ",")
+ ",
+ where "
+ (math (var "i"))
+ "
+and "
+ (math (var "j"))
+ "
+are the "
+ (math (var "u"))
+ "
+and "
+ (math (var "v"))
+ "
+control point indices, respectively.
+ This allows control points to be embedded in arbitrary data structures.
+ The only constraint is that the values for a particular control point
+ must occupy contiguous memory locations. The initial value of "
+ (var "vstride")
+ " is 0. "))
+ (entry (% (heading (var "vorder")))
+ (para "
+Specifies the dimension of the control point array in the "
+ (math (var "v"))
+ "
+axis.
+ Must be positive. The initial value is 1. "))
+ (entry (% (heading (var "points")))
+ (para "
+Specifies a pointer to the array of control points. ")))
+ (heading "Description")
+ (para "
+Evaluators provide a way to use polynomial or rational polynomial mapping
+ to produce vertices,
+ normals,
+ texture coordinates,
+ and colors.
+ The values produced by an evaluator are sent on to further stages
+ of GL processing just as if they had been presented using "
+ (code "glVertex")
+ ", "
+ (code "glNormal")
+ ", "
+ (code "glTexCoord")
+ ", and "
+ (code "glColor")
+ " commands,
+ except that the generated values do not update the current normal,
+ texture coordinates,
+ or color. ")
+ (para "
+All polynomial or rational polynomial splines of any degree
+ (up to the maximum degree supported by the GL implementation)
+ can be described using evaluators.
+ These include almost all surfaces used in computer graphics,
+ including B-spline surfaces,
+ NURBS surfaces,
+ Bezier surfaces, and so on. ")
+ (para "
+Evaluators define surfaces based on bivariate Bernstein polynomials.
+ Define "
+ (math (var "p")
+ "\u2061"
+ "("
+ (var "u")
+ "^"
+ ","
+ (var "v")
+ "^"
+ ")")
+ "
+as ")
+ (para (math (var "p")
+ "\u2061"
+ "("
+ (var "u")
+ "^"
+ ","
+ (var "v")
+ "^"
+ ")"
+ "="
+ "Σ"
+ (var "i")
+ "="
+ "0"
+ (var "n")
+ "Σ"
+ (var "j")
+ "="
+ "0"
+ (var "m")
+ (var "B")
+ "_"
+ (var "i")
+ ","
+ "^"
+ (var "n")
+ "\u2061"
+ "("
+ (var "u")
+ "^"
+ ","
+ ")"
+ "\u2062"
+ (var "B")
+ "_"
+ (var "j")
+ ","
+ "^"
+ (var "m")
+ "\u2061"
+ "("
+ (var "v")
+ "^"
+ ","
+ ")"
+ "\u2062"
+ (var "R")
+ "_"
+ (var "ij")))
+ (para)
+ (para "
+where "
+ (math (var "R") "_" (var "ij"))
+ "
+is a control point, "
+ (math (var "B")
+ "_"
+ (var "i")
+ ","
+ "^"
+ (var "n")
+ "\u2061"
+ "("
+ (var "u")
+ "^"
+ ","
+ ")")
+ "
+is the "
+ (math (var "i"))
+ "th
+ Bernstein polynomial of degree "
+ (math (var "n"))
+ "
+("
+ (var "uorder")
+ " = "
+ (math (var "n") "+" "1")
+ ") ")
+ (para (math (var "B")
+ "_"
+ (var "i")
+ ","
+ "^"
+ (var "n")
+ "\u2061"
+ "("
+ (var "u")
+ "^"
+ ","
+ ")"
+ "="
+ "("
+ "("
+ (var "n")
+ ")"
+ ", "
+ "("
+ (var "i")
+ ")"
+ ","
+ ","
+ ")"
+ "\u2062"
+ (var "u")
+ "^"
+ ","
+ "^"
+ (var "i")
+ "\u2062"
+ "("
+ "1"
+ "-"
+ (var "u")
+ "^"
+ ","
+ ")"
+ "^"
+ (var "n")
+ "-"
+ (var "i")
+ ","
+ ","))
+ (para "
+and "
+ (math (var "B")
+ "_"
+ (var "j")
+ ","
+ "^"
+ (var "m")
+ "\u2061"
+ "("
+ (var "v")
+ "^"
+ ","
+ ")")
+ "
+is the "
+ (math (var "j"))
+ "th
+ Bernstein polynomial of degree "
+ (math (var "m"))
+ "
+("
+ (var "vorder")
+ " = "
+ (math (var "m") "+" "1")
+ ") ")
+ (para (math (var "B")
+ "_"
+ (var "j")
+ ","
+ "^"
+ (var "m")
+ "\u2061"
+ "("
+ (var "v")
+ "^"
+ ","
+ ")"
+ "="
+ "("
+ "("
+ (var "m")
+ ")"
+ ", "
+ "("
+ (var "j")
+ ")"
+ ","
+ ","
+ ")"
+ "\u2062"
+ (var "v")
+ "^"
+ ","
+ "^"
+ (var "j")
+ "\u2062"
+ "("
+ "1"
+ "-"
+ (var "v")
+ "^"
+ ","
+ ")"
+ "^"
+ (var "m")
+ "-"
+ (var "j")
+ ","
+ ","))
+ (para "
+Recall that "
+ (math "0" "^" "0" "==" "1")
+ "
+and "
+ (math "("
+ "("
+ (var "n")
+ ")"
+ ", "
+ "("
+ "0"
+ ")"
+ ","
+ ","
+ ")"
+ "=="
+ "1"))
+ (para (code "glMap2")
+ " is used to define the basis and to specify what kind of values
+ are produced.
+ Once defined,
+ a map can be enabled and disabled by calling "
+ (code "glEnable")
+ " and "
+ (code "glDisable")
+ "
+with the map name, one of the nine predefined values for "
+ (var "target")
+ ",
+ described below.
+ When "
+ (code "glEvalCoord2")
+ " presents values "
+ (math (var "u"))
+ "
+and "
+ (math (var "v"))
+ ",
+ the bivariate Bernstein polynomials are evaluated using "
+ (math (var "u") "^")
+ "
+and "
+ (math (var "v") "^")
+ ",
+ where ")
+ (para (math (var "u")
+ "^"
+ "="
+ (var "u")
+ "-"
+ (var "u1")
+ ","
+ "/"
+ (var "u2")
+ "-"
+ (var "u1")
+ ","))
+ (para (math (var "v")
+ "^"
+ "="
+ (var "v")
+ "-"
+ (var "v1")
+ ","
+ "/"
+ (var "v2")
+ "-"
+ (var "v1")
+ ","))
+ (para (var "target")
+ " is a symbolic constant that indicates what kind of control points
+ are provided in "
+ (var "points")
+ ",
+ and what output is generated when the map is evaluated.
+ It can assume one of nine predefined values: ")
+ (table (% (formatter (asis)))
+ (entry (% (heading (code "GL_MAP2_VERTEX_3")))
+ (para "
+Each control point is three floating-point values representing "
+ (math (var "x"))
+ ", "
+ (math (var "y"))
+ ",
+ and "
+ (math (var "z"))
+ ".
+ Internal "
+ (code "glVertex3")
+ " commands are generated when the map is evaluated. "))
+ (entry (% (heading (code "GL_MAP2_VERTEX_4")))
+ (para "
+Each control point is four floating-point values representing "
+ (math (var "x"))
+ ", "
+ (math (var "y"))
+ ", "
+ (math (var "z"))
+ ",
+ and "
+ (math (var "w"))
+ ".
+ Internal "
+ (code "glVertex4")
+ " commands are generated when the map is evaluated. "))
+ (entry (% (heading (code "GL_MAP2_INDEX")))
+ (para "
+Each control point is a single floating-point value representing a color index.
+ Internal "
+ (code "glIndex")
+ " commands are generated when the map is evaluated
+ but the current index is not updated with the value of these "
+ (code "glIndex")
+ " commands. "))
+ (entry (% (heading (code "GL_MAP2_COLOR_4")))
+ (para "
+Each control point is four floating-point values representing
+ red, green, blue, and alpha.
+ Internal "
+ (code "glColor4")
+ " commands are generated when the map is
+ evaluated but the current color is not updated with the value of
+ these "
+ (code "glColor4")
+ " commands. "))
+ (entry (% (heading (code "GL_MAP2_NORMAL")))
+ (para "
+Each control point is three floating-point values representing
+ the "
+ (math (var "x"))
+ ", "
+ (math (var "y"))
+ ",
+ and "
+ (math (var "z"))
+ "
+components of a normal vector.
+ Internal "
+ (code "glNormal")
+ " commands are generated when the map is
+ evaluated but the current normal is not updated with the value of
+ these "
+ (code "glNormal")
+ " commands. "))
+ (entry (% (heading (code "GL_MAP2_TEXTURE_COORD_1")))
+ (para "
+Each control point is a single floating-point value representing
+ the "
+ (math (var "s"))
+ "
+texture coordinate.
+ Internal "
+ (code "glTexCoord1")
+ " commands are generated when the map is evaluated but
+ the current texture coordinates are not updated with the value
+ of these "
+ (code "glTexCoord")
+ " commands. "))
+ (entry (% (heading (code "GL_MAP2_TEXTURE_COORD_2")))
+ (para "
+Each control point is two floating-point values representing
+ the "
+ (math (var "s"))
+ "
+and "
+ (math (var "t"))
+ "
+texture coordinates.
+ Internal "
+ (code "glTexCoord2")
+ " commands are generated when the map is evaluated but
+ the current texture coordinates are not updated with the value
+ of these "
+ (code "glTexCoord")
+ " commands. "))
+ (entry (% (heading (code "GL_MAP2_TEXTURE_COORD_3")))
+ (para "
+Each control point is three floating-point values representing
+ the "
+ (math (var "s"))
+ ", "
+ (math (var "t"))
+ ",
+ and "
+ (math (var "r"))
+ "
+texture coordinates.
+ Internal "
+ (code "glTexCoord3")
+ " commands are generated when the map is
+ evaluated but the current texture coordinates are not updated with the value
+ of these "
+ (code "glTexCoord")
+ " commands. "))
+ (entry (% (heading (code "GL_MAP2_TEXTURE_COORD_4")))
+ (para "
+Each control point is four floating-point values representing
+ the "
+ (math (var "s"))
+ ", "
+ (math (var "t"))
+ ", "
+ (math (var "r"))
+ ",
+ and "
+ (math (var "q"))
+ "
+texture coordinates.
+ Internal "
+ (code "glTexCoord4")
+ " commands are generated when the map is evaluated but the current texture coordinates are not updated with the value
+ of these "
+ (code "glTexCoord")
+ " commands. ")))
+ (para (var "ustride")
+ ", "
+ (var "uorder")
+ ", "
+ (var "vstride")
+ ", "
+ (var "vorder")
+ ", and "
+ (var "points")
+ " define the array addressing for accessing the control points. "
+ (var "points")
+ " is the location of the first control point,
+ which occupies one, two, three, or four contiguous memory locations,
+ depending on which map is being defined.
+ There are "
+ (math (var "uorder") "×" (var "vorder"))
+ "
+control points in the array. "
+ (var "ustride")
+ " specifies how many float or double locations are skipped to advance
+ the internal memory pointer from control point "
+ (math (var "R")
+ "_"
+ (var "i")
+ "\u2062"
+ (var "j")
+ ",")
+ "
+to control point "
+ (math (var "R")
+ "_"
+ "("
+ (var "i")
+ "+"
+ "1"
+ ","
+ ")"
+ "\u2062"
+ (var "j")
+ ",")
+ ". "
+ (var "vstride")
+ " specifies how many float or double locations are skipped to advance
+ the internal memory pointer from control point "
+ (math (var "R")
+ "_"
+ (var "i")
+ "\u2062"
+ (var "j")
+ ",")
+ "
+to control point "
+ (math (var "R")
+ "_"
+ (var "i")
+ "\u2061"
+ "("
+ (var "j")
+ "+"
+ "1"
+ ","
+ ")"
+ ",")
+ ". ")
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "target")
+ " is not an accepted value. ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "u1")
+ " is equal to "
+ (var "u2")
+ ",
+ or if "
+ (var "v1")
+ " is equal to "
+ (var "v2")
+ ". ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if either "
+ (var "ustride")
+ " or "
+ (var "vstride")
+ "
+is less than the number of values in a control point. ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if either "
+ (var "uorder")
+ " or "
+ (var "vorder")
+ "
+is less than 1 or greater than the return value of "
+ (code "GL_MAX_EVAL_ORDER")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glMap2")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glMap2")
+ " is called and the value
+ of "
+ (code "GL_ACTIVE_TEXTURE")
+ " is not "
+ (code "GL_TEXTURE0")
+ ". ")))
+
+(define-gl-procedure
+ glMapBuffer
+ "glMapBuffer"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void * " (function "glMapBuffer"))
+ (paramdef "GLenum " (parameter "target"))
+ (paramdef "GLenum " (parameter "access"))))
+ '(*fragment*
+ (heading "map a buffer object's data store")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "target")))
+ (para "
+Specifies the target buffer object being mapped.
+ The symbolic constant must be "
+ (code "GL_ARRAY_BUFFER")
+ ", "
+ (code "GL_ELEMENT_ARRAY_BUFFER")
+ ", "
+ (code "GL_PIXEL_PACK_BUFFER")
+ ", or "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ ". "))
+ (entry (% (heading (var "access")))
+ (para "
+Specifies the access policy, indicating whether it will be possible to read from, write to,
+ or both read from and write to the buffer object's mapped data store. The symbolic constant must be "
+ (code "GL_READ_ONLY")
+ ", "
+ (code "GL_WRITE_ONLY")
+ ", or "
+ (code "GL_READ_WRITE")
+ ". ")))
+ (heading "Description")
+ (para (code "glMapBuffer")
+ " maps to the client's address space the entire data store of the buffer object
+ currently bound to "
+ (var "target")
+ ". The data can then be directly read and/or written relative to
+ the returned pointer, depending on the specified "
+ (var "access")
+ " policy. If the GL is unable to
+ map the buffer object's data store, "
+ (code "glMapBuffer")
+ " generates an error and returns "
+ (code "NULL")
+ ". This may occur for system-specific reasons, such as low virtual memory availability. ")
+ (para "
+If a mapped data store is accessed in a way inconsistent with the specified "
+ (var "access")
+ " policy,
+ no error is generated, but performance may be negatively impacted and system errors, including program
+ termination, may result. Unlike the "
+ (var "usage")
+ " parameter of "
+ (code "glBufferData")
+ ", "
+ (var "access")
+ " is not a hint, and does in fact constrain the usage of the mapped data store on
+ some GL implementations. In order to achieve the highest performance available, a buffer object's data store
+ should be used in ways consistent with both its specified "
+ (var "usage")
+ " and "
+ (var "access")
+ " parameters. ")
+ (para "
+A mapped data store must be unmapped with "
+ (code "glUnmapBuffer")
+ " before its buffer object is used.
+ Otherwise an error will be generated by any GL command that attempts to dereference the buffer object's data store.
+ When a data store is unmapped, the pointer to its data store becomes invalid. "
+ (code "glUnmapBuffer")
+ "
+returns "
+ (code "GL_TRUE")
+ " unless the data store contents have become corrupt during the time
+ the data store was mapped. This can occur for system-specific reasons that affect the availability of graphics
+ memory, such as screen mode changes. In such situations, "
+ (code "GL_FALSE")
+ " is returned and the
+ data store contents are undefined. An application must detect this rare condition and reinitialize the data store. ")
+ (para "
+A buffer object's mapped data store is automatically unmapped when the buffer object is deleted or its data store
+ is recreated with "
+ (code "glBufferData")
+ ". ")
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "target")
+ " is not "
+ (code "GL_ARRAY_BUFFER")
+ ", "
+ (code "GL_ELEMENT_ARRAY_BUFFER")
+ ", "
+ (code "GL_PIXEL_PACK_BUFFER")
+ ", or "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ ". ")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "access")
+ " is not "
+ (code "GL_READ_ONLY")
+ ", "
+ (code "GL_WRITE_ONLY")
+ ", or "
+ (code "GL_READ_WRITE")
+ ". ")
+ (para (code "GL_OUT_OF_MEMORY")
+ " is generated when "
+ (code "glMapBuffer")
+ " is executed
+ if the GL is unable to map the buffer object's data store. This may occur for a variety of system-specific
+ reasons, such as the absence of sufficient remaining virtual memory. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if the reserved buffer object name 0 is bound to "
+ (var "target")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glMapBuffer")
+ " is executed for
+ a buffer object whose data store is already mapped. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glUnmapBuffer")
+ " is executed for
+ a buffer object whose data store is not currently mapped. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glMapBuffer")
+ " or "
+ (code "glUnmapBuffer")
+ " is executed
+ between the execution of "
+ (code "glBegin")
+ " and the corresponding
+ execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glMapGrid
+ "glMapGrid"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glMapGrid1d"))
+ (paramdef "GLint " (parameter "un"))
+ (paramdef "GLdouble " (parameter "u1"))
+ (paramdef "GLdouble " (parameter "u2"))))
+ '(*fragment*
+ (heading "define a one- or two-dimensional mesh")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "un")))
+ (para "
+Specifies the number of partitions in the grid range interval
+ ["
+ (var "u1")
+ ", "
+ (var "u2")
+ "].
+ Must be positive. "))
+ (entry (% (heading (var "u1")))
+ (itemx (var "u2"))
+ (para "
+Specify the mappings for integer grid domain values "
+ (math (var "i") "=" "0")
+ "
+and "
+ (math (var "i") "=" (var "un"))
+ ". "))
+ (entry (% (heading (var "vn")))
+ (para "
+Specifies the number of partitions in the grid range interval
+ ["
+ (var "v1")
+ ", "
+ (var "v2")
+ "]
+ ("
+ (code "glMapGrid2")
+ " only). "))
+ (entry (% (heading (var "v1")))
+ (itemx (var "v2"))
+ (para "
+Specify the mappings for integer grid domain values "
+ (math (var "j") "=" "0")
+ "
+and "
+ (math (var "j") "=" (var "vn"))
+ "
+("
+ (code "glMapGrid2")
+ " only). ")))
+ (heading "Description")
+ (para (code "glMapGrid")
+ " and "
+ (code "glEvalMesh")
+ " are used together to efficiently
+ generate and evaluate a series of evenly-spaced map domain values. "
+ (code "glEvalMesh")
+ " steps through the integer domain
+ of a one- or two-dimensional grid,
+ whose range is the domain of the evaluation maps specified by "
+ (code "glMap1")
+ " and "
+ (code "glMap2")
+ ". ")
+ (para (code "glMapGrid1")
+ " and "
+ (code "glMapGrid2")
+ " specify the linear grid mappings
+ between the "
+ (math (var "i"))
+ "
+(or "
+ (math (var "i"))
+ "
+and "
+ (math (var "j"))
+ ")
+ integer grid coordinates,
+ to the "
+ (math (var "u"))
+ "
+(or "
+ (math (var "u"))
+ "
+and "
+ (math (var "v"))
+ ")
+ floating-point evaluation map coordinates.
+ See "
+ (code "glMap1")
+ " and "
+ (code "glMap2")
+ " for details of how "
+ (math (var "u"))
+ "
+and "
+ (math (var "v"))
+ "
+coordinates
+ are evaluated. ")
+ (para (code "glMapGrid1")
+ " specifies a single linear mapping
+ such that integer grid coordinate 0 maps exactly to "
+ (var "u1")
+ ",
+ and integer grid coordinate "
+ (var "un")
+ " maps exactly to "
+ (var "u2")
+ ".
+ All other integer grid coordinates "
+ (math (var "i"))
+ "
+are mapped so that ")
+ (para (math (var "u")
+ "="
+ (var "i")
+ "\u2061"
+ "("
+ (var "u2")
+ "-"
+ (var "u1")
+ ","
+ ")"
+ "/"
+ (var "un")
+ "+"
+ (var "u1")))
+ (para (code "glMapGrid2")
+ " specifies two such linear mappings.
+ One maps integer grid coordinate "
+ (math (var "i") "=" "0")
+ "
+exactly to "
+ (var "u1")
+ ",
+ and integer grid coordinate "
+ (math (var "i") "=" (var "un"))
+ "
+exactly to "
+ (var "u2")
+ ".
+ The other maps integer grid coordinate "
+ (math (var "j") "=" "0")
+ "
+exactly to "
+ (var "v1")
+ ",
+ and integer grid coordinate "
+ (math (var "j") "=" (var "vn"))
+ "
+exactly to "
+ (var "v2")
+ ".
+ Other integer grid coordinates "
+ (math (var "i"))
+ "
+and "
+ (math (var "j"))
+ "
+are mapped such that ")
+ (para (math (var "u")
+ "="
+ (var "i")
+ "\u2061"
+ "("
+ (var "u2")
+ "-"
+ (var "u1")
+ ","
+ ")"
+ "/"
+ (var "un")
+ "+"
+ (var "u1")))
+ (para (math (var "v")
+ "="
+ (var "j")
+ "\u2061"
+ "("
+ (var "v2")
+ "-"
+ (var "v1")
+ ","
+ ")"
+ "/"
+ (var "vn")
+ "+"
+ (var "v1")))
+ (para "
+The mappings specified by "
+ (code "glMapGrid")
+ " are used identically by "
+ (code "glEvalMesh")
+ " and "
+ (code "glEvalPoint")
+ ". ")
+ (heading "Errors")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if either "
+ (var "un")
+ " or "
+ (var "vn")
+ " is not
+ positive. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glMapGrid")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glMaterial
+ "glMaterial"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glMaterialf"))
+ (paramdef "GLenum " (parameter "face"))
+ (paramdef "GLenum " (parameter "pname"))
+ (paramdef "GLfloat " (parameter "param"))))
+ '(*fragment*
+ (heading
+ "specify material parameters for the lighting model")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "face")))
+ (para "
+Specifies which face or faces are being updated.
+ Must be one of "
+ (code "GL_FRONT")
+ ", "
+ (code "GL_BACK")
+ ", or "
+ (code "GL_FRONT_AND_BACK")
+ ". "))
+ (entry (% (heading (var "pname")))
+ (para "
+Specifies the single-valued material parameter of the face or faces
+ that is being updated.
+ Must be "
+ (code "GL_SHININESS")
+ ". "))
+ (entry (% (heading (var "param")))
+ (para "
+Specifies the value that parameter "
+ (code "GL_SHININESS")
+ " will be set to. ")))
+ (heading "Description")
+ (para (code "glMaterial")
+ " assigns values to material parameters.
+ There are two matched sets of material parameters.
+ One,
+ the "
+ (var "front-facing")
+ " set,
+ is used to shade points,
+ lines,
+ bitmaps,
+ and all polygons
+ (when two-sided lighting is disabled),
+ or just front-facing polygons
+ (when two-sided lighting is enabled).
+ The other set, "
+ (var "back-facing")
+ ",
+ is used to shade back-facing polygons only when two-sided lighting is enabled.
+ Refer to the "
+ (code "glLightModel")
+ " reference page for details concerning one- and
+ two-sided lighting calculations. ")
+ (para (code "glMaterial")
+ " takes three arguments.
+ The first, "
+ (var "face")
+ ",
+ specifies whether the "
+ (code "GL_FRONT")
+ " materials, the "
+ (code "GL_BACK")
+ " materials, or both "
+ (code "GL_FRONT_AND_BACK")
+ " materials will be modified.
+ The second, "
+ (var "pname")
+ ",
+ specifies which of several parameters in one or both sets will be modified.
+ The third, "
+ (var "params")
+ ",
+ specifies what value or values will be assigned to the specified parameter. ")
+ (para "
+Material parameters are used in the lighting equation that is optionally
+ applied to each vertex.
+ The equation is discussed in the "
+ (code "glLightModel")
+ " reference page.
+ The parameters that can be specified using "
+ (code "glMaterial")
+ ",
+ and their interpretations by the lighting equation, are as follows: ")
+ (table (% (formatter (asis)))
+ (entry (% (heading (code "GL_AMBIENT")))
+ (para (var "params")
+ " contains four integer or floating-point values that specify
+ the ambient RGBA reflectance of the material.
+ Integer values are mapped linearly such that the most positive representable
+ value maps to 1.0,
+ and the most negative representable value maps to "
+ (math "-1.0")
+ ".
+ Floating-point values are mapped directly.
+ Neither integer nor floating-point values are clamped.
+ The initial ambient reflectance for both front- and back-facing materials
+ is (0.2, 0.2, 0.2, 1.0). "))
+ (entry (% (heading (code "GL_DIFFUSE")))
+ (para (var "params")
+ " contains four integer or floating-point values that specify
+ the diffuse RGBA reflectance of the material.
+ Integer values are mapped linearly such that the most positive representable
+ value maps to 1.0,
+ and the most negative representable value maps to "
+ (math "-1.0")
+ ".
+ Floating-point values are mapped directly.
+ Neither integer nor floating-point values are clamped.
+ The initial diffuse reflectance for both front- and back-facing materials
+ is (0.8, 0.8, 0.8, 1.0). "))
+ (entry (% (heading (code "GL_SPECULAR")))
+ (para (var "params")
+ " contains four integer or floating-point values that specify
+ the specular RGBA reflectance of the material.
+ Integer values are mapped linearly such that the most positive representable
+ value maps to 1.0,
+ and the most negative representable value maps to "
+ (math "-1.0")
+ ".
+ Floating-point values are mapped directly.
+ Neither integer nor floating-point values are clamped.
+ The initial specular reflectance for both front- and back-facing materials
+ is (0, 0, 0, 1). "))
+ (entry (% (heading (code "GL_EMISSION")))
+ (para (var "params")
+ " contains four integer or floating-point values that specify
+ the RGBA emitted light intensity of the material.
+ Integer values are mapped linearly such that the most positive representable
+ value maps to 1.0,
+ and the most negative representable value maps to "
+ (math "-1.0")
+ ".
+ Floating-point values are mapped directly.
+ Neither integer nor floating-point values are clamped.
+ The initial emission intensity for both front- and back-facing materials
+ is (0, 0, 0, 1). "))
+ (entry (% (heading (code "GL_SHININESS")))
+ (para (var "params")
+ " is a single integer or floating-point value that specifies
+ the RGBA specular exponent of the material.
+ Integer and floating-point values are mapped directly.
+ Only values in the range "
+ (math "[" "0" "," "128" "]")
+ "
+are accepted.
+ The initial specular exponent for both front- and back-facing materials
+ is 0. "))
+ (entry (% (heading (code "GL_AMBIENT_AND_DIFFUSE")))
+ (para "
+Equivalent to calling "
+ (code "glMaterial")
+ " twice with the same parameter values,
+ once with "
+ (code "GL_AMBIENT")
+ " and once with "
+ (code "GL_DIFFUSE")
+ ". "))
+ (entry (% (heading (code "GL_COLOR_INDEXES")))
+ (para (var "params")
+ " contains three integer or floating-point values specifying
+ the color indices for ambient,
+ diffuse,
+ and specular lighting.
+ These three values,
+ and "
+ (code "GL_SHININESS")
+ ",
+ are the only material values used by the color index mode lighting equation.
+ Refer to the "
+ (code "glLightModel")
+ " reference page for a discussion
+ of color index lighting. ")))
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if either "
+ (var "face")
+ " or "
+ (var "pname")
+ " is not
+ an accepted value. ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if a specular exponent outside the range "
+ (math "[" "0" "," "128" "]")
+ "
+is specified. ")))
+
+(define-gl-procedure
+ glMatrixMode
+ "glMatrixMode"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glMatrixMode"))
+ (paramdef "GLenum " (parameter "mode"))))
+ '(*fragment*
+ (heading
+ "specify which matrix is the current matrix")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "mode")))
+ (para "
+Specifies which matrix stack is the target
+ for subsequent matrix operations.
+ Three values are accepted: "
+ (code "GL_MODELVIEW")
+ ", "
+ (code "GL_PROJECTION")
+ ", and "
+ (code "GL_TEXTURE")
+ ".
+ The initial value is "
+ (code "GL_MODELVIEW")
+ ".
+ Additionally, if the "
+ (code "ARB_imaging")
+ " extension is supported, "
+ (code "GL_COLOR")
+ " is also accepted. ")))
+ (heading "Description")
+ (para (code "glMatrixMode")
+ " sets the current matrix mode. "
+ (var "mode")
+ " can assume one of four values: ")
+ (table (% (formatter (asis)))
+ (entry (% (heading (code "GL_MODELVIEW")))
+ (para "
+Applies subsequent matrix operations to the modelview matrix stack. "))
+ (entry (% (heading (code "GL_PROJECTION")))
+ (para "
+Applies subsequent matrix operations to the projection matrix stack. "))
+ (entry (% (heading (code "GL_TEXTURE")))
+ (para "
+Applies subsequent matrix operations to the texture matrix stack. "))
+ (entry (% (heading (code "GL_COLOR")))
+ (para "
+Applies subsequent matrix operations to the color matrix stack. ")))
+ (para "
+To find out which matrix stack is currently the target of all matrix
+ operations, call "
+ (code "glGet")
+ " with argument "
+ (code "GL_MATRIX_MODE")
+ ". The initial
+ value is "
+ (code "GL_MODELVIEW")
+ ". ")
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "mode")
+ " is not an accepted value. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glMatrixMode")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glMinmax
+ "glMinmax"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glMinmax"))
+ (paramdef "GLenum " (parameter "target"))
+ (paramdef "GLenum " (parameter "internalformat"))
+ (paramdef "GLboolean " (parameter "sink"))))
+ '(*fragment*
+ (heading "define minmax table")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "target")))
+ (para "
+The minmax table whose parameters are to be set.
+ Must be "
+ (code "GL_MINMAX")
+ ". "))
+ (entry (% (heading (var "internalformat")))
+ (para "
+The format of entries in the minmax table.
+ Must be one of "
+ (code "GL_ALPHA")
+ ", "
+ (code "GL_ALPHA4")
+ ", "
+ (code "GL_ALPHA8")
+ ", "
+ (code "GL_ALPHA12")
+ ", "
+ (code "GL_ALPHA16")
+ ", "
+ (code "GL_LUMINANCE")
+ ", "
+ (code "GL_LUMINANCE4")
+ ", "
+ (code "GL_LUMINANCE8")
+ ", "
+ (code "GL_LUMINANCE12")
+ ", "
+ (code "GL_LUMINANCE16")
+ ", "
+ (code "GL_LUMINANCE_ALPHA")
+ ", "
+ (code "GL_LUMINANCE4_ALPHA4")
+ ", "
+ (code "GL_LUMINANCE6_ALPHA2")
+ ", "
+ (code "GL_LUMINANCE8_ALPHA8")
+ ", "
+ (code "GL_LUMINANCE12_ALPHA4")
+ ", "
+ (code "GL_LUMINANCE12_ALPHA12")
+ ", "
+ (code "GL_LUMINANCE16_ALPHA16")
+ ", "
+ (code "GL_R3_G3_B2")
+ ", "
+ (code "GL_RGB")
+ ", "
+ (code "GL_RGB4")
+ ", "
+ (code "GL_RGB5")
+ ", "
+ (code "GL_RGB8")
+ ", "
+ (code "GL_RGB10")
+ ", "
+ (code "GL_RGB12")
+ ", "
+ (code "GL_RGB16")
+ ", "
+ (code "GL_RGBA")
+ ", "
+ (code "GL_RGBA2")
+ ", "
+ (code "GL_RGBA4")
+ ", "
+ (code "GL_RGB5_A1")
+ ", "
+ (code "GL_RGBA8")
+ ", "
+ (code "GL_RGB10_A2")
+ ", "
+ (code "GL_RGBA12")
+ ", or "
+ (code "GL_RGBA16")
+ ". "))
+ (entry (% (heading (var "sink")))
+ (para "
+If "
+ (code "GL_TRUE")
+ ", pixels will be consumed by the minmax
+ process and no drawing or texture loading will take place.
+ If "
+ (code "GL_FALSE")
+ ", pixels will proceed to the final conversion process after
+ minmax. ")))
+ (heading "Description")
+ (para "
+When "
+ (code "GL_MINMAX")
+ " is enabled, the RGBA components of incoming pixels are
+ compared to the minimum and maximum values for each component, which are
+ stored in the two-element minmax table.
+ (The first element stores the minima, and the second element stores
+ the maxima.)
+ If a pixel component is greater than the corresponding component
+ in the maximum element, then the maximum element is updated with the
+ pixel component value.
+ If a pixel component is less than the corresponding component in
+ the minimum element, then the minimum element is updated with the
+ pixel component value.
+ (In both cases, if the internal format of the minmax table includes
+ luminance, then the R color component of incoming pixels is used
+ for comparison.)
+ The contents of the minmax table may be retrieved at a later time
+ by calling "
+ (code "glGetMinmax")
+ ".
+ The minmax operation is enabled or disabled by calling "
+ (code "glEnable")
+ " or "
+ (code "glDisable")
+ ", respectively, with an argument of "
+ (code "GL_MINMAX")
+ ". ")
+ (para (code "glMinmax")
+ " redefines the current minmax table to have entries of the format
+ specified by "
+ (var "internalformat")
+ ".
+ The maximum element is initialized with the smallest possible component
+ values, and the minimum element is initialized with the largest possible
+ component values.
+ The values in the previous minmax table, if any, are lost.
+ If "
+ (var "sink")
+ " is "
+ (code "GL_TRUE")
+ ", then pixels are discarded after minmax;
+ no further processing of the pixels takes place, and no drawing,
+ texture loading, or pixel readback will result. ")
+ (para)
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "target")
+ " is not one of the allowable
+ values. ")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "internalformat")
+ " is not one of the
+ allowable values. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glMinmax")
+ " is executed
+ between the execution of "
+ (code "glBegin")
+ " and the corresponding
+ execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glMultiDrawArrays
+ "glMultiDrawArrays"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glMultiDrawArrays"))
+ (paramdef "GLenum " (parameter "mode"))
+ (paramdef "GLint * " (parameter "first"))
+ (paramdef "GLsizei * " (parameter "count"))
+ (paramdef "GLsizei " (parameter "primcount"))))
+ '(*fragment*
+ (heading
+ "render multiple sets of primitives from array data")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "mode")))
+ (para "
+Specifies what kind of primitives to render.
+ Symbolic constants "
+ (code "GL_POINTS")
+ ", "
+ (code "GL_LINE_STRIP")
+ ", "
+ (code "GL_LINE_LOOP")
+ ", "
+ (code "GL_LINES")
+ ", "
+ (code "GL_TRIANGLE_STRIP")
+ ", "
+ (code "GL_TRIANGLE_FAN")
+ ", "
+ (code "GL_TRIANGLES")
+ ", "
+ (code "GL_QUAD_STRIP")
+ ", "
+ (code "GL_QUADS")
+ ",
+ and "
+ (code "GL_POLYGON")
+ " are accepted. "))
+ (entry (% (heading (var "first")))
+ (para "
+Points to an array of starting indices in the enabled arrays. "))
+ (entry (% (heading (var "count")))
+ (para "
+Points to an array of the number of indices to be rendered. "))
+ (entry (% (heading (var "primcount")))
+ (para "
+Specifies the size of the first and count ")))
+ (heading "Description")
+ (para (code "glMultiDrawArrays")
+ " specifies multiple sets of geometric primitives
+ with very few subroutine calls. Instead of calling a GL procedure
+ to pass each individual vertex, normal, texture coordinate, edge
+ flag, or color, you can prespecify
+ separate arrays of vertices, normals, and colors and use them to
+ construct a sequence of primitives with a single
+ call to "
+ (code "glMultiDrawArrays")
+ ". ")
+ (para (code "glMultiDrawArrays")
+ " behaves identically to "
+ (code "glDrawArrays")
+ " except that "
+ (var "primcount")
+ "
+separate ranges of elements are specified instead. ")
+ (para "
+When "
+ (code "glMultiDrawArrays")
+ " is called, it uses "
+ (var "count")
+ " sequential elements from each
+ enabled array to construct a sequence of geometric primitives,
+ beginning with element "
+ (var "first")
+ ". "
+ (var "mode")
+ " specifies what kind of
+ primitives are constructed, and how the array elements
+ construct those primitives. If "
+ (code "GL_VERTEX_ARRAY")
+ " is not enabled, no
+ geometric primitives are generated. ")
+ (para "
+Vertex attributes that are modified by "
+ (code "glMultiDrawArrays")
+ " have an
+ unspecified value after "
+ (code "glMultiDrawArrays")
+ " returns. For example, if "
+ (code "GL_COLOR_ARRAY")
+ " is enabled, the value of the current color is
+ undefined after "
+ (code "glMultiDrawArrays")
+ " executes. Attributes that aren't
+ modified remain well defined. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "mode")
+ " is not an accepted value. ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "primcount")
+ " is negative. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a non-zero buffer object name is bound to an
+ enabled array and the buffer object's data store is currently mapped. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glMultiDrawArrays")
+ " is executed between
+ the execution of "
+ (code "glBegin")
+ " and the corresponding "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glMultiDrawElements
+ "glMultiDrawElements"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "void "
+ (function "glMultiDrawElements"))
+ (paramdef "GLenum " (parameter "mode"))
+ (paramdef "const GLsizei * " (parameter "count"))
+ (paramdef "GLenum " (parameter "type"))
+ (paramdef
+ "const GLvoid ** "
+ (parameter "indices"))
+ (paramdef "GLsizei " (parameter "primcount"))))
+ '(*fragment*
+ (heading
+ "render multiple sets of primitives by specifying indices of array data elements")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "mode")))
+ (para "
+Specifies what kind of primitives to render.
+ Symbolic constants "
+ (code "GL_POINTS")
+ ", "
+ (code "GL_LINE_STRIP")
+ ", "
+ (code "GL_LINE_LOOP")
+ ", "
+ (code "GL_LINES")
+ ", "
+ (code "GL_TRIANGLE_STRIP")
+ ", "
+ (code "GL_TRIANGLE_FAN")
+ ", "
+ (code "GL_TRIANGLES")
+ ", "
+ (code "GL_QUAD_STRIP")
+ ", "
+ (code "GL_QUADS")
+ ",
+ and "
+ (code "GL_POLYGON")
+ " are accepted. "))
+ (entry (% (heading (var "count")))
+ (para "
+Points to an array of the elements counts. "))
+ (entry (% (heading (var "type")))
+ (para "
+Specifies the type of the values in "
+ (var "indices")
+ ". Must be one of "
+ (code "GL_UNSIGNED_BYTE")
+ ", "
+ (code "GL_UNSIGNED_SHORT")
+ ", or "
+ (code "GL_UNSIGNED_INT")
+ ". "))
+ (entry (% (heading (var "indices")))
+ (para "
+Specifies a pointer to the location where the indices are stored. "))
+ (entry (% (heading (var "primcount")))
+ (para "
+Specifies the size of the "
+ (var "count")
+ " array. ")))
+ (heading "Description")
+ (para (code "glMultiDrawElements")
+ " specifies multiple sets of geometric primitives with very few subroutine
+ calls. Instead of calling a GL function to pass each individual vertex,
+ normal, texture coordinate, edge flag, or color, you can prespecify
+ separate arrays of vertices, normals, and so on, and use them to construct a
+ sequence of primitives with a single call to "
+ (code "glMultiDrawElements")
+ ". ")
+ (para (code "glMultiDrawElements")
+ " is identical in operation to "
+ (code "glDrawElements")
+ " except that "
+ (var "primcount")
+ " separate lists of elements are specified. ")
+ (para "
+Vertex attributes that are modified by "
+ (code "glMultiDrawElements")
+ " have an
+ unspecified value after "
+ (code "glMultiDrawElements")
+ " returns. For example, if "
+ (code "GL_COLOR_ARRAY")
+ " is enabled, the value of the current color is
+ undefined after "
+ (code "glMultiDrawElements")
+ " executes. Attributes that aren't
+ modified maintain their previous values. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "mode")
+ " is not an accepted value. ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "primcount")
+ " is negative. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a non-zero buffer object name is bound to an
+ enabled array or the element array and the buffer object's data store is currently mapped. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glMultiDrawElements")
+ " is executed between
+ the execution of "
+ (code "glBegin")
+ " and the corresponding "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glMultiTexCoord
+ "glMultiTexCoord"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glMultiTexCoord1s"))
+ (paramdef "GLenum " (parameter "target"))
+ (paramdef "GLshort " (parameter "s"))))
+ '(*fragment*
+ (heading "set the current texture coordinates")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "target")))
+ (para "
+Specifies the texture unit whose coordinates should be modified. The number
+ of texture units is implementation dependent, but must be at least
+ two. Symbolic constant must be one of "
+ (code "GL_TEXTURE")
+ (math (var "i"))
+ ",
+ where i ranges from 0 to "
+ (code "GL_MAX_TEXTURE_COORDS")
+ " - 1,
+ which is an implementation-dependent value. "))
+ (entry (% (heading (var "s")))
+ (itemx (var "t"))
+ (itemx (var "r"))
+ (itemx (var "q"))
+ (para "
+Specify "
+ (var "s")
+ ", "
+ (var "t")
+ ", "
+ (var "r")
+ ", and "
+ (var "q")
+ " texture coordinates for "
+ (var "target")
+ " texture unit. Not all parameters are present in all forms
+ of the command. ")))
+ (heading "Description")
+ (para (code "glMultiTexCoord")
+ " specifies texture coordinates in one, two, three, or four
+ dimensions. "
+ (code "glMultiTexCoord1")
+ " sets the current texture
+ coordinates to "
+ (math "(" (var "s") "," "0" "0" "1" ")")
+ ";
+ a call to "
+ (code "glMultiTexCoord2")
+ "
+sets them to "
+ (math "(" (var "s") "," (var "t") "0" "1" ")")
+ ".
+ Similarly, "
+ (code "glMultiTexCoord3")
+ " specifies the texture coordinates as "
+ (math "("
+ (var "s")
+ ","
+ (var "t")
+ (var "r")
+ "1"
+ ")")
+ ",
+ and "
+ (code "glMultiTexCoord4")
+ "
+defines all four components explicitly as "
+ (math "("
+ (var "s")
+ ","
+ (var "t")
+ (var "r")
+ (var "q")
+ ")")
+ ". ")
+ (para "
+The current texture coordinates are part of the data
+ that is associated with each vertex and with the current
+ raster position.
+ Initially, the values for "
+ (math "("
+ (var "s")
+ ","
+ (var "t")
+ (var "r")
+ (var "q")
+ ")")
+ "
+are "
+ (math "(" "0" "," "0" "0" "1" ")")
+ ". ")
+ (para)))
+
+(define-gl-procedure
+ glMultMatrix
+ "glMultMatrix"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glMultMatrixd"))
+ (paramdef "const GLdouble * " (parameter "m"))))
+ '(*fragment*
+ (heading
+ "multiply the current matrix with the specified matrix")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "m")))
+ (para "
+Points to 16 consecutive values that are used as the elements of
+ a "
+ (math "4" "×" "4")
+ "
+column-major matrix. ")))
+ (heading "Description")
+ (para (code "glMultMatrix")
+ " multiplies the current matrix with the one specified using "
+ (var "m")
+ ", and
+ replaces the current matrix with the product. ")
+ (para "
+The current matrix is determined by the current matrix mode (see "
+ (code "glMatrixMode")
+ "). It is either the projection matrix,
+ modelview matrix,
+ or the texture matrix. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glMultMatrix")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glMultTransposeMatrix
+ "glMultTransposeMatrix"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "void "
+ (function "glMultTransposeMatrixd"))
+ (paramdef "const GLdouble * " (parameter "m"))))
+ '(*fragment*
+ (heading
+ "multiply the current matrix with the specified row-major ordered matrix")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "m")))
+ (para "
+Points to 16 consecutive values that are used as the elements of
+ a "
+ (math "4" "×" "4")
+ "
+row-major matrix. ")))
+ (heading "Description")
+ (para (code "glMultTransposeMatrix")
+ " multiplies the current matrix with the one specified using "
+ (var "m")
+ ", and
+ replaces the current matrix with the product. ")
+ (para "
+The current matrix is determined by the current matrix mode (see "
+ (code "glMatrixMode")
+ "). It is either the projection matrix, modelview matrix,
+ or the texture matrix. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glMultTransposeMatrix")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glNewList
+ "glNewList"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glNewList"))
+ (paramdef "GLuint " (parameter "list"))
+ (paramdef "GLenum " (parameter "mode"))))
+ '(*fragment*
+ (heading "create or replace a display list")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "list")))
+ (para "
+Specifies the display-list name. "))
+ (entry (% (heading (var "mode")))
+ (para "
+Specifies the compilation mode,
+ which can be "
+ (code "GL_COMPILE")
+ " or "
+ (code "GL_COMPILE_AND_EXECUTE")
+ ". ")))
+ (heading "Description")
+ (para "
+Display lists are groups of GL commands that have been stored
+ for subsequent execution.
+ Display lists are created with "
+ (code "glNewList")
+ ".
+ All subsequent commands are placed in the display list,
+ in the order issued,
+ until "
+ (code "glEndList")
+ " is called. ")
+ (para (code "glNewList")
+ " has two arguments.
+ The first argument, "
+ (var "list")
+ ",
+ is a positive integer that becomes the unique name for the display list.
+ Names can be created and reserved with "
+ (code "glGenLists")
+ "
+and tested for uniqueness with "
+ (code "glIsList")
+ ".
+ The second argument, "
+ (var "mode")
+ ",
+ is a symbolic constant that can assume one of two values: ")
+ (table (% (formatter (asis)))
+ (entry (% (heading (code "GL_COMPILE")))
+ (para "
+Commands are merely compiled. "))
+ (entry (% (heading (code "GL_COMPILE_AND_EXECUTE")))
+ (para "
+Commands are executed as they are compiled into the display list. ")))
+ (para "
+Certain commands are not compiled into the display list
+ but are executed immediately,
+ regardless of the display-list mode.
+ These commands are "
+ (code "glAreTexturesResident")
+ ", "
+ (code "glColorPointer")
+ ", "
+ (code "glDeleteLists")
+ ", "
+ (code "glDeleteTextures")
+ ", "
+ (code "glDisableClientState")
+ ", "
+ (code "glEdgeFlagPointer")
+ ", "
+ (code "glEnableClientState")
+ ", "
+ (code "glFeedbackBuffer")
+ ", "
+ (code "glFinish")
+ ", "
+ (code "glFlush")
+ ", "
+ (code "glGenLists")
+ ", "
+ (code "glGenTextures")
+ ", "
+ (code "glIndexPointer")
+ ", "
+ (code "glInterleavedArrays")
+ ", "
+ (code "glIsEnabled")
+ ", "
+ (code "glIsList")
+ ", "
+ (code "glIsTexture")
+ ", "
+ (code "glNormalPointer")
+ ", "
+ (code "glPopClientAttrib")
+ ", "
+ (code "glPixelStore")
+ ", "
+ (code "glPushClientAttrib")
+ ", "
+ (code "glReadPixels")
+ ", "
+ (code "glRenderMode")
+ ", "
+ (code "glSelectBuffer")
+ ", "
+ (code "glTexCoordPointer")
+ ", "
+ (code "glVertexPointer")
+ ",
+ and all of the "
+ (code "glGet")
+ " commands. ")
+ (para "
+Similarly, "
+ (code "glTexImage1D")
+ ", "
+ (code "glTexImage2D")
+ ", and "
+ (code "glTexImage3D")
+ "
+are executed immediately and not compiled into the display list when their
+ first argument is "
+ (code "GL_PROXY_TEXTURE_1D")
+ ", "
+ (code "GL_PROXY_TEXTURE_1D")
+ ", or "
+ (code "GL_PROXY_TEXTURE_3D")
+ ", respectively. ")
+ (para "
+When the "
+ (code "ARB_imaging")
+ " extension is supported, "
+ (code "glHistogram")
+ " executes immediately when its argument is "
+ (code "GL_PROXY_HISTOGRAM")
+ ". Similarly, "
+ (code "glColorTable")
+ " executes
+ immediately when its first argument is "
+ (code "GL_PROXY_COLOR_TABLE")
+ ", "
+ (code "GL_PROXY_POST_CONVOLUTION_COLOR_TABLE")
+ ", or "
+ (code "GL_PROXY_POST_COLOR_MATRIX_COLOR_TABLE")
+ ". ")
+ (para "
+For OpenGL versions 1.3 and greater, or when the "
+ (code "ARB_multitexture")
+ " extension is supported, "
+ (code "glClientActiveTexture")
+ " is not compiled into display lists, but
+ executed immediately. ")
+ (para "
+When "
+ (code "glEndList")
+ " is encountered,
+ the display-list definition is completed by associating the list
+ with the unique name "
+ (var "list")
+ "
+(specified in the "
+ (code "glNewList")
+ " command).
+ If a display list with name "
+ (var "list")
+ " already exists,
+ it is replaced only when "
+ (code "glEndList")
+ " is called. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "list")
+ " is 0. ")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "mode")
+ " is not an accepted value. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glEndList")
+ " is called
+ without a preceding "
+ (code "glNewList")
+ ",
+ or if "
+ (code "glNewList")
+ " is called while a display list is being defined. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glNewList")
+ " or "
+ (code "glEndList")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")
+ (para (code "GL_OUT_OF_MEMORY")
+ " is generated if there is insufficient memory to
+ compile the display list. If the GL version is 1.1 or greater, no
+ change is made to the previous contents of the display list, if any,
+ and no other change is made to the GL state. (It is as if no attempt
+ had been made to create the new display list.) ")))
+
+(define-gl-procedure
+ glNormalPointer
+ "glNormalPointer"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glNormalPointer"))
+ (paramdef "GLenum " (parameter "type"))
+ (paramdef "GLsizei " (parameter "stride"))
+ (paramdef
+ "const GLvoid * "
+ (parameter "pointer"))))
+ '(*fragment*
+ (heading "define an array of normals")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "type")))
+ (para "
+Specifies the data type of each coordinate in the array.
+ Symbolic constants "
+ (code "GL_BYTE")
+ ", "
+ (code "GL_SHORT")
+ ", "
+ (code "GL_INT")
+ ", "
+ (code "GL_FLOAT")
+ ", and "
+ (code "GL_DOUBLE")
+ "
+are accepted. The initial value is "
+ (code "GL_FLOAT")
+ ". "))
+ (entry (% (heading (var "stride")))
+ (para "
+Specifies the byte offset between consecutive normals. If "
+ (var "stride")
+ " is
+ 0, the normals are understood to be tightly packed in
+ the array. The initial value is 0. "))
+ (entry (% (heading (var "pointer")))
+ (para "
+Specifies a pointer to the first coordinate of the first normal in the
+ array. The initial value is 0. ")))
+ (heading "Description")
+ (para (code "glNormalPointer")
+ " specifies the location and data format of an array of normals
+ to use when rendering. "
+ (var "type")
+ " specifies the data type of each normal coordinate,
+ and "
+ (var "stride")
+ " specifies the byte stride from one
+ normal to the next, allowing vertices and attributes
+ to be packed into a single array or stored in separate arrays.
+ (Single-array storage may be more efficient on some implementations;
+ see "
+ (code "glInterleavedArrays")
+ ".) ")
+ (para "
+If a non-zero named buffer object is bound to the "
+ (code "GL_ARRAY_BUFFER")
+ " target
+ (see "
+ (code "glBindBuffer")
+ ") while a normal array is
+ specified, "
+ (var "pointer")
+ " is treated as a byte offset into the buffer object's data store.
+ Also, the buffer object binding ("
+ (code "GL_ARRAY_BUFFER_BINDING")
+ ") is saved as normal vertex array
+ client-side state ("
+ (code "GL_NORMAL_ARRAY_BUFFER_BINDING")
+ "). ")
+ (para "
+When a normal array is specified, "
+ (var "type")
+ ", "
+ (var "stride")
+ ", and "
+ (var "pointer")
+ " are saved as client-side
+ state, in addition to the current vertex array buffer object binding. ")
+ (para "
+To enable and disable the normal array, call "
+ (code "glEnableClientState")
+ " and "
+ (code "glDisableClientState")
+ " with the argument "
+ (code "GL_NORMAL_ARRAY")
+ ". If
+ enabled, the normal array is used
+ when "
+ (code "glDrawArrays")
+ ", "
+ (code "glMultiDrawArrays")
+ ", "
+ (code "glDrawElements")
+ ", "
+ (code "glMultiDrawElements")
+ ", "
+ (code "glDrawRangeElements")
+ ", or "
+ (code "glArrayElement")
+ " is called. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "type")
+ " is not an accepted value. ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "stride")
+ " is negative. ")))
+
+(define-gl-procedure
+ glNormal
+ "glNormal"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glNormal3b"))
+ (paramdef "GLbyte " (parameter "nx"))
+ (paramdef "GLbyte " (parameter "ny"))
+ (paramdef "GLbyte " (parameter "nz"))))
+ '(*fragment*
+ (heading "set the current normal vector")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "nx")))
+ (itemx (var "ny"))
+ (itemx (var "nz"))
+ (para "
+Specify the "
+ (math (var "x"))
+ ", "
+ (math (var "y"))
+ ",
+ and "
+ (math (var "z"))
+ "
+coordinates of the new current normal.
+ The initial value of the current normal is the unit vector, (0, 0, 1). ")
+ (para)))
+ (heading "Description")
+ (para "
+The current normal is set to the given coordinates
+ whenever "
+ (code "glNormal")
+ " is issued.
+ Byte, short, or integer arguments are converted to floating-point
+ format with a linear mapping that maps the most positive representable integer
+ value to 1.0
+ and the most negative representable integer value to "
+ (math "-1.0")
+ ". ")
+ (para "
+Normals specified with "
+ (code "glNormal")
+ " need not have unit length.
+ If "
+ (code "GL_NORMALIZE")
+ " is enabled,
+ then normals of any length specified with "
+ (code "glNormal")
+ " are normalized after transformation.
+ If "
+ (code "GL_RESCALE_NORMAL")
+ " is enabled, normals are scaled by a scaling factor
+ derived from the modelview matrix. "
+ (code "GL_RESCALE_NORMAL")
+ " requires that the
+ originally specified normals were of unit length, and that the modelview
+ matrix contain only uniform scales for proper results.
+ To enable and disable normalization, call "
+ (code "glEnable")
+ " and "
+ (code "glDisable")
+ "
+with either "
+ (code "GL_NORMALIZE")
+ " or "
+ (code "GL_RESCALE_NORMAL")
+ ".
+ Normalization is initially disabled. ")))
+
+(define-gl-procedure
+ glOrtho
+ "glOrtho"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glOrtho"))
+ (paramdef "GLdouble " (parameter "left"))
+ (paramdef "GLdouble " (parameter "right"))
+ (paramdef "GLdouble " (parameter "bottom"))
+ (paramdef "GLdouble " (parameter "top"))
+ (paramdef "GLdouble " (parameter "nearVal"))
+ (paramdef "GLdouble " (parameter "farVal"))))
+ '(*fragment*
+ (heading
+ "multiply the current matrix with an orthographic matrix")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "left")))
+ (itemx (var "right"))
+ (para "
+Specify the coordinates for the left and right vertical clipping planes. "))
+ (entry (% (heading (var "bottom")))
+ (itemx (var "top"))
+ (para "
+Specify the coordinates for the bottom and top horizontal clipping planes. "))
+ (entry (% (heading (var "nearVal")))
+ (itemx (var "farVal"))
+ (para "
+Specify the distances to the nearer and farther depth clipping planes.
+ These values are negative if the plane is to be behind the viewer. ")))
+ (heading "Description")
+ (para (code "glOrtho")
+ " describes a transformation that produces a parallel projection.
+ The current matrix (see "
+ (code "glMatrixMode")
+ ") is multiplied by this matrix
+ and the result replaces the current matrix, as if "
+ (code "glMultMatrix")
+ " were called with the following matrix
+ as its argument: ")
+ (para (math "("
+ "("
+ "2"
+ "/"
+ (var "right")
+ "-"
+ (var "left")
+ ","
+ ","
+ " "
+ "0"
+ " "
+ "0"
+ " "
+ (var "t")
+ "_"
+ (var "x")
+ ","
+ ")"
+ ", "
+ "("
+ "0"
+ " "
+ "2"
+ "/"
+ (var "top")
+ "-"
+ (var "bottom")
+ ","
+ ","
+ " "
+ "0"
+ " "
+ (var "t")
+ "_"
+ (var "y")
+ ","
+ ")"
+ ", "
+ "("
+ "0"
+ " "
+ "0"
+ " "
+ "-2"
+ "/"
+ (var "farVal")
+ "-"
+ (var "nearVal")
+ ","
+ ","
+ " "
+ (var "t")
+ "_"
+ (var "z")
+ ","
+ ")"
+ ", "
+ "("
+ "0"
+ " "
+ "0"
+ " "
+ "0"
+ " "
+ "1"
+ ")"
+ ","
+ ")"))
+ (para "
+where "
+ (math (var "t")
+ "_"
+ (var "x")
+ "="
+ "-"
+ (var "right")
+ "+"
+ (var "left")
+ ","
+ "/"
+ (var "right")
+ "-"
+ (var "left")
+ ","
+ ",")
+ (math (var "t")
+ "_"
+ (var "y")
+ "="
+ "-"
+ (var "top")
+ "+"
+ (var "bottom")
+ ","
+ "/"
+ (var "top")
+ "-"
+ (var "bottom")
+ ","
+ ",")
+ (math (var "t")
+ "_"
+ (var "z")
+ "="
+ "-"
+ (var "farVal")
+ "+"
+ (var "nearVal")
+ ","
+ "/"
+ (var "farVal")
+ "-"
+ (var "nearVal")
+ ","
+ ","))
+ (para "
+Typically, the matrix mode is "
+ (code "GL_PROJECTION")
+ ", and "
+ (math "("
+ (var "left")
+ ","
+ (var "bottom")
+ "-"
+ (var "nearVal")
+ ")")
+ "
+and "
+ (math "("
+ (var "right")
+ ","
+ (var "top")
+ "-"
+ (var "nearVal")
+ ")")
+ "
+specify the points on the near clipping plane that are mapped
+ to the lower left and upper right corners of the window,
+ respectively,
+ assuming that the eye is located at (0, 0, 0). "
+ (math "-" (var "farVal"))
+ "
+specifies the location of the far clipping plane.
+ Both "
+ (var "nearVal")
+ " and "
+ (var "farVal")
+ " can be either positive or negative. ")
+ (para "
+Use "
+ (code "glPushMatrix")
+ " and "
+ (code "glPopMatrix")
+ " to save and restore
+ the current matrix stack. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "left")
+ " = "
+ (var "right")
+ ", or "
+ (var "bottom")
+ " = "
+ (var "top")
+ ", or "
+ (var "near")
+ " = "
+ (var "far")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glOrtho")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glPassThrough
+ "glPassThrough"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glPassThrough"))
+ (paramdef "GLfloat " (parameter "token"))))
+ '(*fragment*
+ (heading "place a marker in the feedback buffer")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "token")))
+ (para "
+Specifies a marker value to be placed in the feedback buffer
+ following a "
+ (code "GL_PASS_THROUGH_TOKEN")
+ ". ")))
+ (heading "Description")
+ (para)
+ (para "
+Feedback is a GL render mode.
+ The mode is selected by calling "
+ (code "glRenderMode")
+ " with "
+ (code "GL_FEEDBACK")
+ ".
+ When the GL is in feedback mode,
+ no pixels are produced by rasterization.
+ Instead,
+ information about primitives that would have been rasterized
+ is fed back to the application using the GL.
+ See the "
+ (code "glFeedbackBuffer")
+ " reference page for a description of the
+ feedback buffer and the values in it. ")
+ (para (code "glPassThrough")
+ " inserts a user-defined marker in the feedback buffer
+ when it is executed in feedback mode. "
+ (var "token")
+ " is returned as if it were a primitive;
+ it is indicated with its own unique identifying value: "
+ (code "GL_PASS_THROUGH_TOKEN")
+ ".
+ The order of "
+ (code "glPassThrough")
+ " commands with respect to the specification
+ of graphics primitives is maintained. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glPassThrough")
+ " is executed between
+ the execution of "
+ (code "glBegin")
+ " and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glPixelMap
+ "glPixelMap"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glPixelMapfv"))
+ (paramdef "GLenum " (parameter "map"))
+ (paramdef "GLsizei " (parameter "mapsize"))
+ (paramdef
+ "const GLfloat * "
+ (parameter "values"))))
+ '(*fragment*
+ (heading "set up pixel transfer maps")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "map")))
+ (para "
+Specifies a symbolic map name.
+ Must be one of the following: "
+ (code "GL_PIXEL_MAP_I_TO_I")
+ ", "
+ (code "GL_PIXEL_MAP_S_TO_S")
+ ", "
+ (code "GL_PIXEL_MAP_I_TO_R")
+ ", "
+ (code "GL_PIXEL_MAP_I_TO_G")
+ ", "
+ (code "GL_PIXEL_MAP_I_TO_B")
+ ", "
+ (code "GL_PIXEL_MAP_I_TO_A")
+ ", "
+ (code "GL_PIXEL_MAP_R_TO_R")
+ ", "
+ (code "GL_PIXEL_MAP_G_TO_G")
+ ", "
+ (code "GL_PIXEL_MAP_B_TO_B")
+ ", or "
+ (code "GL_PIXEL_MAP_A_TO_A")
+ ". "))
+ (entry (% (heading (var "mapsize")))
+ (para "
+Specifies the size of the map being defined. "))
+ (entry (% (heading (var "values")))
+ (para "
+Specifies an array of "
+ (var "mapsize")
+ " values. ")))
+ (heading "Description")
+ (para (code "glPixelMap")
+ " sets up translation tables,
+ or "
+ (var "maps")
+ ",
+ used by "
+ (code "glCopyPixels")
+ ", "
+ (code "glCopyTexImage1D")
+ ", "
+ (code "glCopyTexImage2D")
+ ", "
+ (code "glCopyTexSubImage1D")
+ ", "
+ (code "glCopyTexSubImage2D")
+ ", "
+ (code "glCopyTexSubImage3D")
+ ", "
+ (code "glDrawPixels")
+ ", "
+ (code "glReadPixels")
+ ", "
+ (code "glTexImage1D")
+ ", "
+ (code "glTexImage2D")
+ ", "
+ (code "glTexImage3D")
+ ", "
+ (code "glTexSubImage1D")
+ ", "
+ (code "glTexSubImage2D")
+ ", and "
+ (code "glTexSubImage3D")
+ ".
+ Additionally, if the "
+ (code "ARB_imaging")
+ " subset is supported, the
+ routines "
+ (code "glColorTable")
+ ", "
+ (code "glColorSubTable")
+ ", "
+ (code "glConvolutionFilter1D")
+ ", "
+ (code "glConvolutionFilter2D")
+ ", "
+ (code "glHistogram")
+ ", "
+ (code "glMinmax")
+ ", and "
+ (code "glSeparableFilter2D")
+ ".
+ Use of these maps is described completely in the "
+ (code "glPixelTransfer")
+ " reference page,
+ and partly in the reference pages for the pixel and texture image commands.
+ Only the specification of the maps is described in this reference page. ")
+ (para (var "map")
+ " is a symbolic map name,
+ indicating one of ten maps to set. "
+ (var "mapsize")
+ " specifies the number of entries in the map,
+ and "
+ (var "values")
+ " is a pointer to an array of "
+ (var "mapsize")
+ " map values. ")
+ (para "
+If a non-zero named buffer object is bound to the "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ " target
+ (see "
+ (code "glBindBuffer")
+ ") while a pixel transfer map is
+ specified, "
+ (var "values")
+ " is treated as a byte offset into the buffer object's data store. ")
+ (para "
+The ten maps are as follows: ")
+ (table (% (formatter (asis)))
+ (entry (% (heading (code "GL_PIXEL_MAP_I_TO_I")))
+ (para "
+Maps color indices to color indices. "))
+ (entry (% (heading (code "GL_PIXEL_MAP_S_TO_S")))
+ (para "
+Maps stencil indices to stencil indices. "))
+ (entry (% (heading (code "GL_PIXEL_MAP_I_TO_R")))
+ (para "
+Maps color indices to red components. "))
+ (entry (% (heading (code "GL_PIXEL_MAP_I_TO_G")))
+ (para "
+Maps color indices to green components. "))
+ (entry (% (heading (code "GL_PIXEL_MAP_I_TO_B")))
+ (para "
+Maps color indices to blue components. "))
+ (entry (% (heading (code "GL_PIXEL_MAP_I_TO_A")))
+ (para "
+Maps color indices to alpha components. "))
+ (entry (% (heading (code "GL_PIXEL_MAP_R_TO_R")))
+ (para "
+Maps red components to red components. "))
+ (entry (% (heading (code "GL_PIXEL_MAP_G_TO_G")))
+ (para "
+Maps green components to green components. "))
+ (entry (% (heading (code "GL_PIXEL_MAP_B_TO_B")))
+ (para "
+Maps blue components to blue components. "))
+ (entry (% (heading (code "GL_PIXEL_MAP_A_TO_A")))
+ (para "
+Maps alpha components to alpha components. ")))
+ (para "
+The entries in a map can be specified as single-precision
+ floating-point numbers,
+ unsigned short integers,
+ or unsigned int integers.
+ Maps that store color component values
+ (all but "
+ (code "GL_PIXEL_MAP_I_TO_I")
+ " and "
+ (code "GL_PIXEL_MAP_S_TO_S")
+ ")
+ retain their values in floating-point format,
+ with unspecified mantissa and exponent sizes.
+ Floating-point values specified by "
+ (code "glPixelMapfv")
+ " are converted directly
+ to the internal floating-point format of these maps,
+ then clamped to the range [0,1].
+ Unsigned integer values specified by "
+ (code "glPixelMapusv")
+ " and "
+ (code "glPixelMapuiv")
+ " are converted linearly such that
+ the largest representable integer maps to 1.0,
+ and 0 maps to 0.0. ")
+ (para "
+Maps that store indices, "
+ (code "GL_PIXEL_MAP_I_TO_I")
+ " and "
+ (code "GL_PIXEL_MAP_S_TO_S")
+ ",
+ retain their values in fixed-point format,
+ with an unspecified number of bits to the right of the binary point.
+ Floating-point values specified by "
+ (code "glPixelMapfv")
+ " are converted directly
+ to the internal fixed-point format of these maps.
+ Unsigned integer values specified by "
+ (code "glPixelMapusv")
+ " and "
+ (code "glPixelMapuiv")
+ " specify integer values,
+ with all 0's to the right of the binary point. ")
+ (para "
+The following table shows the initial sizes and values for each of the maps.
+ Maps that are indexed by either color or stencil indices must have "
+ (var "mapsize")
+ " = "
+ (math "2" "^" (var "n"))
+ "
+for some "
+ (math (var "n"))
+ "
+or the results are undefined.
+ The maximum allowable size for each map depends on the implementation
+ and can be determined by calling "
+ (code "glGet")
+ " with argument "
+ (code "GL_MAX_PIXEL_MAP_TABLE")
+ ".
+ The single maximum applies to all maps; it is at
+ least 32. ")
+ (table (% (formatter (asis)))
+ (entry (% (heading (strong (var "map"))))
+ (para (strong "Lookup Index")
+ ", "
+ (strong "Lookup Value")
+ ", "
+ (strong "Initial Size")
+ ", "
+ (strong "Initial Value")))
+ (entry (% (heading (code "GL_PIXEL_MAP_I_TO_I")))
+ (para "
+color index "
+ ", "
+ "
+color index "
+ ", "
+ "
+1 "
+ ", "
+ "
+0 "))
+ (entry (% (heading (code "GL_PIXEL_MAP_S_TO_S")))
+ (para "
+stencil index "
+ ", "
+ "
+stencil index "
+ ", "
+ "
+1 "
+ ", "
+ "
+0 "))
+ (entry (% (heading (code "GL_PIXEL_MAP_I_TO_R")))
+ (para "
+color index "
+ ", "
+ "
+R "
+ ", "
+ "
+1 "
+ ", "
+ "
+0 "))
+ (entry (% (heading (code "GL_PIXEL_MAP_I_TO_G")))
+ (para "
+color index "
+ ", "
+ "
+G "
+ ", "
+ "
+1 "
+ ", "
+ "
+0 "))
+ (entry (% (heading (code "GL_PIXEL_MAP_I_TO_B")))
+ (para "
+color index "
+ ", "
+ "
+B "
+ ", "
+ "
+1 "
+ ", "
+ "
+0 "))
+ (entry (% (heading (code "GL_PIXEL_MAP_I_TO_A")))
+ (para "
+color index "
+ ", "
+ "
+A "
+ ", "
+ "
+1 "
+ ", "
+ "
+0 "))
+ (entry (% (heading (code "GL_PIXEL_MAP_R_TO_R")))
+ (para "
+R " ", " "
+R " ", " "
+1 " ", " "
+0 "))
+ (entry (% (heading (code "GL_PIXEL_MAP_G_TO_G")))
+ (para "
+G " ", " "
+G " ", " "
+1 " ", " "
+0 "))
+ (entry (% (heading (code "GL_PIXEL_MAP_B_TO_B")))
+ (para "
+B " ", " "
+B " ", " "
+1 " ", " "
+0 "))
+ (entry (% (heading (code "GL_PIXEL_MAP_A_TO_A")))
+ (para "
+A " ", " "
+A " ", " "
+1 " ", " "
+0 ")))
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "map")
+ " is not an accepted value. ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "mapsize")
+ " is less than one
+ or larger than "
+ (code "GL_MAX_PIXEL_MAP_TABLE")
+ ". ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "map")
+ " is "
+ (code "GL_PIXEL_MAP_I_TO_I")
+ ", "
+ (code "GL_PIXEL_MAP_S_TO_S")
+ ", "
+ (code "GL_PIXEL_MAP_I_TO_R")
+ ", "
+ (code "GL_PIXEL_MAP_I_TO_G")
+ ", "
+ (code "GL_PIXEL_MAP_I_TO_B")
+ ", or "
+ (code "GL_PIXEL_MAP_I_TO_A")
+ ",
+ and "
+ (var "mapsize")
+ " is not a power of two. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a non-zero buffer object name is bound to the "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ " target and the buffer object's data store is currently mapped. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a non-zero buffer object name is bound to the "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ " target and the data would be unpacked from the buffer
+ object such that the memory reads required would exceed the data store size. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated by "
+ (code "glPixelMapfv")
+ " if a non-zero buffer object name is bound to the "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ " target and "
+ (var "values")
+ " is not evenly divisible
+ into the number of bytes needed to store in memory a GLfloat datum. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated by "
+ (code "glPixelMapuiv")
+ " if a non-zero buffer object name is bound to the "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ " target and "
+ (var "values")
+ " is not evenly divisible
+ into the number of bytes needed to store in memory a GLuint datum. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated by "
+ (code "glPixelMapusv")
+ " if a non-zero buffer object name is bound to the "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ " target and "
+ (var "values")
+ " is not evenly divisible
+ into the number of bytes needed to store in memory a GLushort datum. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glPixelMap")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glPixelStore
+ "glPixelStore"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glPixelStoref"))
+ (paramdef "GLenum " (parameter "pname"))
+ (paramdef "GLfloat " (parameter "param"))))
+ '(*fragment*
+ (heading "set pixel storage modes")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "pname")))
+ (para "
+Specifies the symbolic name of the parameter to be set.
+ Six values affect the packing of pixel data into memory: "
+ (code "GL_PACK_SWAP_BYTES")
+ ", "
+ (code "GL_PACK_LSB_FIRST")
+ ", "
+ (code "GL_PACK_ROW_LENGTH")
+ ", "
+ (code "GL_PACK_IMAGE_HEIGHT")
+ ", "
+ (code "GL_PACK_SKIP_PIXELS")
+ ", "
+ (code "GL_PACK_SKIP_ROWS")
+ ", "
+ (code "GL_PACK_SKIP_IMAGES")
+ ", and "
+ (code "GL_PACK_ALIGNMENT")
+ ".
+ Six more affect the unpacking of pixel data "
+ (var "from")
+ " memory: "
+ (code "GL_UNPACK_SWAP_BYTES")
+ ", "
+ (code "GL_UNPACK_LSB_FIRST")
+ ", "
+ (code "GL_UNPACK_ROW_LENGTH")
+ ", "
+ (code "GL_UNPACK_IMAGE_HEIGHT")
+ ", "
+ (code "GL_UNPACK_SKIP_PIXELS")
+ ", "
+ (code "GL_UNPACK_SKIP_ROWS")
+ ", "
+ (code "GL_UNPACK_SKIP_IMAGES")
+ ", and "
+ (code "GL_UNPACK_ALIGNMENT")
+ ". "))
+ (entry (% (heading (var "param")))
+ (para "
+Specifies the value that "
+ (var "pname")
+ " is set to. ")))
+ (heading "Description")
+ (para (code "glPixelStore")
+ " sets pixel storage modes that affect the operation of subsequent "
+ (code "glDrawPixels")
+ " and "
+ (code "glReadPixels")
+ " as well as the unpacking of
+ polygon stipple patterns (see "
+ (code "glPolygonStipple")
+ "), bitmaps (see "
+ (code "glBitmap")
+ "), texture patterns (see "
+ (code "glTexImage1D")
+ ", "
+ (code "glTexImage2D")
+ ", "
+ (code "glTexImage3D")
+ ", "
+ (code "glTexSubImage1D")
+ ", "
+ (code "glTexSubImage2D")
+ ", "
+ (code "glTexSubImage3D")
+ ").
+ Additionally, if the "
+ (code "ARB_imaging")
+ " extension is supported, pixel
+ storage modes affect convolution filters
+ (see "
+ (code "glConvolutionFilter1D")
+ ", "
+ (code "glConvolutionFilter2D")
+ ", and "
+ (code "glSeparableFilter2D")
+ ", color table (see "
+ (code "glColorTable")
+ ", and "
+ (code "glColorSubTable")
+ ", and unpacking histogram (See "
+ (code "glHistogram")
+ "),
+ and minmax (See "
+ (code "glMinmax")
+ ") data. ")
+ (para (var "pname")
+ " is a symbolic constant indicating the parameter to be set, and "
+ (var "param")
+ " is the new value. Six of the twelve storage parameters affect
+ how pixel data is returned to client memory.
+ They are as follows: ")
+ (table (% (formatter (asis)))
+ (entry (% (heading (code "GL_PACK_SWAP_BYTES")))
+ (para "
+If true,
+ byte ordering for multibyte color components,
+ depth components,
+ color indices,
+ or stencil indices
+ is reversed.
+ That is,
+ if a four-byte component consists of bytes "
+ (math (var "b") "_" "0")
+ ", "
+ (math (var "b") "_" "1")
+ ", "
+ (math (var "b") "_" "2")
+ ", "
+ (math (var "b") "_" "3")
+ ",
+ it is stored in memory as "
+ (math (var "b") "_" "3")
+ ", "
+ (math (var "b") "_" "2")
+ ", "
+ (math (var "b") "_" "1")
+ ", "
+ (math (var "b") "_" "0")
+ "
+if "
+ (code "GL_PACK_SWAP_BYTES")
+ " is true. "
+ (code "GL_PACK_SWAP_BYTES")
+ " has no effect on the memory order of components
+ within a pixel,
+ only on the order of bytes within components or indices.
+ For example,
+ the three components of a "
+ (code "GL_RGB")
+ " format pixel are always stored with
+ red first,
+ green second,
+ and blue third,
+ regardless of the value of "
+ (code "GL_PACK_SWAP_BYTES")
+ ". "))
+ (entry (% (heading (code "GL_PACK_LSB_FIRST")))
+ (para "
+If true,
+ bits are ordered within a byte from least significant to most significant;
+ otherwise,
+ the first bit in each byte is the most significant one.
+ This parameter is significant for bitmap data only. "))
+ (entry (% (heading (code "GL_PACK_ROW_LENGTH")))
+ (para "
+If greater than 0, "
+ (code "GL_PACK_ROW_LENGTH")
+ " defines the number of pixels in a row.
+ If the first pixel of a row is placed at location "
+ (math (var "p"))
+ "
+in memory,
+ then the location of the first pixel of the next row is obtained by skipping ")
+ (para (math (var "k")
+ "="
+ "{"
+ "("
+ (var "n")
+ "\u2062"
+ (var "l")
+ ")"
+ ", "
+ "("
+ (var "a")
+ "/"
+ (var "s")
+ ","
+ "\u2062"
+ "⌈"
+ (var "s")
+ "\u2062"
+ (var "n")
+ "\u2062"
+ (var "l")
+ ","
+ "/"
+ (var "a")
+ ","
+ "⌉"
+ ")"
+ "\u2062"
+ "("
+ (var "s")
+ ">="
+ (var "a")
+ ")"
+ ", "
+ "("
+ (var "s")
+ "<"
+ (var "a")
+ ")"
+ ","))
+ (para "
+components or indices,
+ where "
+ (math (var "n"))
+ "
+is the number of components or indices in a pixel, "
+ (math (var "l"))
+ "
+is the number of pixels in a row
+ ("
+ (code "GL_PACK_ROW_LENGTH")
+ " if it is greater than 0,
+ the "
+ (math (var "width"))
+ "
+argument to the pixel routine otherwise), "
+ (math (var "a"))
+ "
+is the value of "
+ (code "GL_PACK_ALIGNMENT")
+ ", and "
+ (math (var "s"))
+ "
+is the size, in bytes, of a single component
+ (if "
+ (math (var "a") "<" (var "s"))
+ ",
+ then it is as if "
+ (math (var "a") "=" (var "s"))
+ ").
+ In the case of 1-bit values,
+ the location of the next row is obtained by skipping ")
+ (para (math (var "k")
+ "="
+ "8"
+ "\u2062"
+ (var "a")
+ "\u2062"
+ "⌈"
+ (var "n")
+ "\u2062"
+ (var "l")
+ ","
+ "/"
+ "8"
+ "\u2062"
+ (var "a")
+ ","
+ ","
+ "⌉"))
+ (para "
+components or indices. ")
+ (para "
+The word "
+ (var "component")
+ " in this description refers to the nonindex values
+ red,
+ green,
+ blue,
+ alpha,
+ and depth.
+ Storage format "
+ (code "GL_RGB")
+ ",
+ for example,
+ has three components per pixel:
+ first red,
+ then green,
+ and finally blue. "))
+ (entry (% (heading (code "GL_PACK_IMAGE_HEIGHT")))
+ (para "
+If greater than 0, "
+ (code "GL_PACK_IMAGE_HEIGHT")
+ " defines the number of pixels in an image
+ three-dimensional texture volume, where ``image'' is defined by all pixels
+ sharing the same third dimension index.
+ If the first pixel of a row is placed at location "
+ (math (var "p"))
+ "
+in memory,
+ then the location of the first pixel of the next row is obtained by skipping ")
+ (para (math (var "k")
+ "="
+ "{"
+ "("
+ (var "n")
+ "\u2062"
+ (var "l")
+ "\u2062"
+ (var "h")
+ ")"
+ ", "
+ "("
+ (var "a")
+ "/"
+ (var "s")
+ ","
+ "\u2062"
+ "⌈"
+ (var "s")
+ "\u2062"
+ (var "n")
+ "\u2062"
+ (var "l")
+ "\u2062"
+ (var "h")
+ ","
+ "/"
+ (var "a")
+ ","
+ "⌉"
+ ")"
+ "\u2062"
+ "("
+ (var "s")
+ ">="
+ (var "a")
+ ")"
+ ", "
+ "("
+ (var "s")
+ "<"
+ (var "a")
+ ")"
+ ","))
+ (para "
+components or indices, where "
+ (math (var "n"))
+ "
+is the number of components or indices
+ in a pixel, "
+ (math (var "l"))
+ "
+is the number of pixels in a row
+ ("
+ (code "GL_PACK_ROW_LENGTH")
+ " if it is greater than 0, the "
+ (math (var "width"))
+ "
+argument to "
+ (code "glTexImage3D")
+ " otherwise), "
+ (math (var "h"))
+ "
+is the number of
+ rows in a pixel image ("
+ (code "GL_PACK_IMAGE_HEIGHT")
+ " if it is greater than
+ 0, the "
+ (math (var "height"))
+ "
+argument to the "
+ (code "glTexImage3D")
+ " routine otherwise), "
+ (math (var "a"))
+ "
+is the value of "
+ (code "GL_PACK_ALIGNMENT")
+ ", and "
+ (math (var "s"))
+ "
+is the size, in bytes, of a single
+ component (if "
+ (math (var "a") "<" (var "s"))
+ ",
+ then it is as if "
+ (math (var "a") "=" (var "s"))
+ "). ")
+ (para "
+The word "
+ (var "component")
+ " in this description refers to the nonindex values
+ red,
+ green,
+ blue,
+ alpha,
+ and depth.
+ Storage format "
+ (code "GL_RGB")
+ ",
+ for example,
+ has three components per pixel:
+ first red,
+ then green,
+ and finally blue. "))
+ (entry (% (heading
+ (code "GL_PACK_SKIP_PIXELS")
+ ", "
+ (code "GL_PACK_SKIP_ROWS")
+ ", and "
+ (code "GL_PACK_SKIP_IMAGES")))
+ (para "
+These values are provided as a convenience to the programmer;
+ they provide no functionality that cannot be duplicated simply by
+ incrementing the pointer passed to "
+ (code "glReadPixels")
+ ".
+ Setting "
+ (code "GL_PACK_SKIP_PIXELS")
+ " to "
+ (math (var "i"))
+ "
+is equivalent to incrementing
+ the pointer by "
+ (math (var "i") "\u2062" (var "n"))
+ "
+components or indices,
+ where "
+ (math (var "n"))
+ "
+is the number of components or indices in each pixel.
+ Setting "
+ (code "GL_PACK_SKIP_ROWS")
+ " to "
+ (math (var "j"))
+ "
+is equivalent to incrementing
+ the pointer by "
+ (math (var "j") "\u2062" (var "m"))
+ "
+components or indices,
+ where "
+ (math (var "m"))
+ "
+is the number of components or indices per row,
+ as just computed in the "
+ (code "GL_PACK_ROW_LENGTH")
+ " section.
+ Setting "
+ (code "GL_PACK_SKIP_IMAGES")
+ " to "
+ (math (var "k"))
+ "
+is equivalent to incrementing
+ the pointer by "
+ (math (var "k") "\u2062" (var "p"))
+ ",
+ where "
+ (math (var "p"))
+ "
+is the number of components or indices
+ per image, as computed in the "
+ (code "GL_PACK_IMAGE_HEIGHT")
+ " section. "))
+ (entry (% (heading (code "GL_PACK_ALIGNMENT")))
+ (para "
+Specifies the alignment requirements for the start of each pixel row in memory.
+ The allowable values are
+ 1 (byte-alignment),
+ 2 (rows aligned to even-numbered bytes),
+ 4 (word-alignment), and
+ 8 (rows start on double-word boundaries). ")))
+ (para "
+The other six of the twelve storage parameters affect how pixel data is
+ read from client memory.
+ These values are significant for "
+ (code "glDrawPixels")
+ ", "
+ (code "glTexImage1D")
+ ", "
+ (code "glTexImage2D")
+ ", "
+ (code "glTexImage3D")
+ ", "
+ (code "glTexSubImage1D")
+ ", "
+ (code "glTexSubImage2D")
+ ", "
+ (code "glTexSubImage3D")
+ ", "
+ (code "glBitmap")
+ ", and "
+ (code "glPolygonStipple")
+ ". ")
+ (para "
+Additionally, if the "
+ (code "ARB_imaging")
+ " extension is supported, "
+ (code "glColorTable")
+ ", "
+ (code "glColorSubTable")
+ ", "
+ (code "glConvolutionFilter1D")
+ ", "
+ (code "glConvolutionFilter2D")
+ ", and "
+ (code "glSeparableFilter2D")
+ ".
+ They are as follows: ")
+ (table (% (formatter (asis)))
+ (entry (% (heading (code "GL_UNPACK_SWAP_BYTES")))
+ (para "
+If true,
+ byte ordering for multibyte color components,
+ depth components,
+ color indices,
+ or stencil indices
+ is reversed.
+ That is,
+ if a four-byte component consists of bytes "
+ (math (var "b") "_" "0")
+ ", "
+ (math (var "b") "_" "1")
+ ", "
+ (math (var "b") "_" "2")
+ ", "
+ (math (var "b") "_" "3")
+ ",
+ it is taken from memory as "
+ (math (var "b") "_" "3")
+ ", "
+ (math (var "b") "_" "2")
+ ", "
+ (math (var "b") "_" "1")
+ ", "
+ (math (var "b") "_" "0")
+ "
+if "
+ (code "GL_UNPACK_SWAP_BYTES")
+ " is true. "
+ (code "GL_UNPACK_SWAP_BYTES")
+ " has no effect on the memory order of components
+ within a pixel,
+ only on the order of bytes within components or indices.
+ For example,
+ the three components of a "
+ (code "GL_RGB")
+ " format pixel are always stored with
+ red first,
+ green second,
+ and blue third,
+ regardless of the value of "
+ (code "GL_UNPACK_SWAP_BYTES")
+ ". "))
+ (entry (% (heading (code "GL_UNPACK_LSB_FIRST")))
+ (para "
+If true,
+ bits are ordered within a byte from least significant to most significant;
+ otherwise,
+ the first bit in each byte is the most significant one.
+ This is relevant only for bitmap data. "))
+ (entry (% (heading (code "GL_UNPACK_ROW_LENGTH")))
+ (para "
+If greater than 0, "
+ (code "GL_UNPACK_ROW_LENGTH")
+ " defines the number of pixels in a row.
+ If the first pixel of a row is placed at location "
+ (math (var "p"))
+ "
+in memory,
+ then the location of the first pixel of the next row is obtained by skipping ")
+ (para (math (var "k")
+ "="
+ "{"
+ "("
+ (var "n")
+ "\u2062"
+ (var "l")
+ ")"
+ ", "
+ "("
+ (var "a")
+ "/"
+ (var "s")
+ ","
+ "\u2062"
+ "⌈"
+ (var "s")
+ "\u2062"
+ (var "n")
+ "\u2062"
+ (var "l")
+ ","
+ "/"
+ (var "a")
+ ","
+ "⌉"
+ ")"
+ "\u2062"
+ "("
+ (var "s")
+ ">="
+ (var "a")
+ ")"
+ ", "
+ "("
+ (var "s")
+ "<"
+ (var "a")
+ ")"
+ ","))
+ (para "
+components or indices,
+ where "
+ (math (var "n"))
+ "
+is the number of components or indices in a pixel, "
+ (math (var "l"))
+ "
+is the number of pixels in a row
+ ("
+ (code "GL_UNPACK_ROW_LENGTH")
+ " if it is greater than 0,
+ the "
+ (math (var "width"))
+ "
+argument to the pixel routine otherwise), "
+ (math (var "a"))
+ "
+is the value of "
+ (code "GL_UNPACK_ALIGNMENT")
+ ", and "
+ (math (var "s"))
+ "
+is the size, in bytes, of a single component
+ (if "
+ (math (var "a") "<" (var "s"))
+ ",
+ then it is as if "
+ (math (var "a") "=" (var "s"))
+ ").
+ In the case of 1-bit values,
+ the location of the next row is obtained by skipping ")
+ (para (math (var "k")
+ "="
+ "8"
+ "\u2062"
+ (var "a")
+ "\u2062"
+ "⌈"
+ (var "n")
+ "\u2062"
+ (var "l")
+ ","
+ "/"
+ "8"
+ "\u2062"
+ (var "a")
+ ","
+ ","
+ "⌉"))
+ (para "
+components or indices. ")
+ (para "
+The word "
+ (var "component")
+ " in this description refers to the nonindex values
+ red,
+ green,
+ blue,
+ alpha,
+ and depth.
+ Storage format "
+ (code "GL_RGB")
+ ",
+ for example,
+ has three components per pixel:
+ first red,
+ then green,
+ and finally blue. "))
+ (entry (% (heading (code "GL_UNPACK_IMAGE_HEIGHT")))
+ (para "
+If greater than 0, "
+ (code "GL_UNPACK_IMAGE_HEIGHT")
+ " defines the number of pixels in an image of
+ a three-dimensional texture volume. Where ``image'' is defined by all
+ pixel sharing the same third dimension index.
+ If the first pixel of a row is placed at location "
+ (math (var "p"))
+ "
+in memory,
+ then the location of the first pixel of the next row is obtained by skipping ")
+ (para (math (var "k")
+ "="
+ "{"
+ "("
+ (var "n")
+ "\u2062"
+ (var "l")
+ "\u2062"
+ (var "h")
+ ")"
+ ", "
+ "("
+ (var "a")
+ "/"
+ (var "s")
+ ","
+ "\u2062"
+ "⌈"
+ (var "s")
+ "\u2062"
+ (var "n")
+ "\u2062"
+ (var "l")
+ "\u2062"
+ (var "h")
+ ","
+ "/"
+ (var "a")
+ ","
+ "⌉"
+ ")"
+ "\u2062"
+ "("
+ (var "s")
+ ">="
+ (var "a")
+ ")"
+ ", "
+ "("
+ (var "s")
+ "<"
+ (var "a")
+ ")"
+ ","))
+ (para "
+components or indices,
+ where "
+ (math (var "n"))
+ "
+is the number of components or indices in a pixel, "
+ (math (var "l"))
+ "
+is the number of pixels in a row
+ ("
+ (code "GL_UNPACK_ROW_LENGTH")
+ " if it is greater than 0,
+ the "
+ (math (var "width"))
+ "
+argument to "
+ (code "glTexImage3D")
+ " otherwise), "
+ (math (var "h"))
+ "
+is the number of rows in an image ("
+ (code "GL_UNPACK_IMAGE_HEIGHT")
+ " if
+ it is greater than 0, the "
+ (math (var "height"))
+ "
+argument to "
+ (code "glTexImage3D")
+ " otherwise), "
+ (math (var "a"))
+ "
+is the value of "
+ (code "GL_UNPACK_ALIGNMENT")
+ ", and "
+ (math (var "s"))
+ "
+is the size, in bytes, of a single component
+ (if "
+ (math (var "a") "<" (var "s"))
+ ",
+ then it is as if "
+ (math (var "a") "=" (var "s"))
+ "). ")
+ (para "
+The word "
+ (var "component")
+ " in this description refers to the nonindex values
+ red,
+ green,
+ blue,
+ alpha,
+ and depth.
+ Storage format "
+ (code "GL_RGB")
+ ",
+ for example,
+ has three components per pixel:
+ first red,
+ then green,
+ and finally blue. "))
+ (entry (% (heading
+ (code "GL_UNPACK_SKIP_PIXELS")
+ " and "
+ (code "GL_UNPACK_SKIP_ROWS")))
+ (para "
+These values are provided as a convenience to the programmer;
+ they provide no functionality that cannot be duplicated by
+ incrementing the pointer passed to "
+ (code "glDrawPixels")
+ ", "
+ (code "glTexImage1D")
+ ", "
+ (code "glTexImage2D")
+ ", "
+ (code "glTexSubImage1D")
+ ", "
+ (code "glTexSubImage2D")
+ ", "
+ (code "glBitmap")
+ ", or "
+ (code "glPolygonStipple")
+ ".
+ Setting "
+ (code "GL_UNPACK_SKIP_PIXELS")
+ " to "
+ (math (var "i"))
+ "
+is equivalent to incrementing
+ the pointer by "
+ (math (var "i") "\u2062" (var "n"))
+ "
+components or indices,
+ where "
+ (math (var "n"))
+ "
+is the number of components or indices in each pixel.
+ Setting "
+ (code "GL_UNPACK_SKIP_ROWS")
+ " to "
+ (math (var "j"))
+ "
+is equivalent to incrementing
+ the pointer by "
+ (math (var "j") "\u2062" (var "k"))
+ "
+components or indices,
+ where "
+ (math (var "k"))
+ "
+is the number of components or indices per row,
+ as just computed in the "
+ (code "GL_UNPACK_ROW_LENGTH")
+ " section. "))
+ (entry (% (heading (code "GL_UNPACK_ALIGNMENT")))
+ (para "
+Specifies the alignment requirements for the start of each pixel row in memory.
+ The allowable values are
+ 1 (byte-alignment),
+ 2 (rows aligned to even-numbered bytes),
+ 4 (word-alignment), and
+ 8 (rows start on double-word boundaries). ")))
+ (para "
+The following table gives the type,
+ initial value,
+ and range of valid values for each storage parameter
+ that can be set with "
+ (code "glPixelStore")
+ ". ")
+ (para)
+ (table (% (formatter (asis)))
+ (entry (% (heading (strong (var "pname"))))
+ (para (strong "Type")
+ ", "
+ (strong "Initial Value")
+ ", "
+ (strong "Valid Range")))
+ (entry (% (heading (code "GL_PACK_SWAP_BYTES")))
+ (para "
+boolean "
+ ", "
+ "
+false "
+ ", "
+ "
+true or false "))
+ (entry (% (heading (code "GL_PACK_LSB_FIRST")))
+ (para "
+boolean "
+ ", "
+ "
+false "
+ ", "
+ "
+true or false "))
+ (entry (% (heading (code "GL_PACK_ROW_LENGTH")))
+ (para "
+integer "
+ ", "
+ "
+0 "
+ ", "
+ (math "[" "0" "," "∞" ")")))
+ (entry (% (heading (code "GL_PACK_IMAGE_HEIGHT")))
+ (para "
+integer "
+ ", "
+ "
+0 "
+ ", "
+ (math "[" "0" "," "∞" ")")))
+ (entry (% (heading (code "GL_PACK_SKIP_ROWS")))
+ (para "
+integer "
+ ", "
+ "
+0 "
+ ", "
+ (math "[" "0" "," "∞" ")")))
+ (entry (% (heading (code "GL_PACK_SKIP_PIXELS")))
+ (para "
+integer "
+ ", "
+ "
+0 "
+ ", "
+ (math "[" "0" "," "∞" ")")))
+ (entry (% (heading (code "GL_PACK_SKIP_IMAGES")))
+ (para "
+integer "
+ ", "
+ "
+0 "
+ ", "
+ (math "[" "0" "," "∞" ")")))
+ (entry (% (heading (code "GL_PACK_ALIGNMENT")))
+ (para "
+integer "
+ ", "
+ "
+4 "
+ ", "
+ "
+1, 2, 4, or 8 "))
+ (entry (% (heading (code "GL_UNPACK_SWAP_BYTES")))
+ (para "
+boolean "
+ ", "
+ "
+false "
+ ", "
+ "
+true or false "))
+ (entry (% (heading (code "GL_UNPACK_LSB_FIRST")))
+ (para "
+boolean "
+ ", "
+ "
+false "
+ ", "
+ "
+true or false "))
+ (entry (% (heading (code "GL_UNPACK_ROW_LENGTH")))
+ (para "
+integer "
+ ", "
+ "
+0 "
+ ", "
+ (math "[" "0" "," "∞" ")")))
+ (entry (% (heading (code "GL_UNPACK_IMAGE_HEIGHT")))
+ (para "
+integer "
+ ", "
+ "
+0 "
+ ", "
+ (math "[" "0" "," "∞" ")")))
+ (entry (% (heading (code "GL_UNPACK_SKIP_ROWS")))
+ (para "
+integer "
+ ", "
+ "
+0 "
+ ", "
+ (math "[" "0" "," "∞" ")")))
+ (entry (% (heading (code "GL_UNPACK_SKIP_PIXELS")))
+ (para "
+integer "
+ ", "
+ "
+0 "
+ ", "
+ (math "[" "0" "," "∞" ")")))
+ (entry (% (heading (code "GL_UNPACK_SKIP_IMAGES")))
+ (para "
+integer "
+ ", "
+ "
+0 "
+ ", "
+ (math "[" "0" "," "∞" ")")))
+ (entry (% (heading (code "GL_UNPACK_ALIGNMENT")))
+ (para "
+integer "
+ ", "
+ "
+4 "
+ ", "
+ "
+1, 2, 4, or 8 ")))
+ (para (code "glPixelStoref")
+ " can be used to set any pixel store parameter.
+ If the parameter type is boolean,
+ then if "
+ (var "param")
+ " is 0,
+ the parameter is false;
+ otherwise it is set to true.
+ If "
+ (var "pname")
+ " is a integer type parameter, "
+ (var "param")
+ " is rounded to the nearest integer. ")
+ (para "
+Likewise, "
+ (code "glPixelStorei")
+ " can also be used to set any of the
+ pixel store parameters.
+ Boolean parameters are set to false if "
+ (var "param")
+ " is 0 and true otherwise. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "pname")
+ " is not an accepted value. ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if a negative row length,
+ pixel skip,
+ or row skip value is specified,
+ or if alignment is specified as other than 1, 2, 4, or 8. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glPixelStore")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glPixelTransfer
+ "glPixelTransfer"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glPixelTransferf"))
+ (paramdef "GLenum " (parameter "pname"))
+ (paramdef "GLfloat " (parameter "param"))))
+ '(*fragment*
+ (heading "set pixel transfer modes")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "pname")))
+ (para "
+Specifies the symbolic name of the pixel transfer parameter to be set.
+ Must be one of the following: "
+ (code "GL_MAP_COLOR")
+ ", "
+ (code "GL_MAP_STENCIL")
+ ", "
+ (code "GL_INDEX_SHIFT")
+ ", "
+ (code "GL_INDEX_OFFSET")
+ ", "
+ (code "GL_RED_SCALE")
+ ", "
+ (code "GL_RED_BIAS")
+ ", "
+ (code "GL_GREEN_SCALE")
+ ", "
+ (code "GL_GREEN_BIAS")
+ ", "
+ (code "GL_BLUE_SCALE")
+ ", "
+ (code "GL_BLUE_BIAS")
+ ", "
+ (code "GL_ALPHA_SCALE")
+ ", "
+ (code "GL_ALPHA_BIAS")
+ ", "
+ (code "GL_DEPTH_SCALE")
+ ", or "
+ (code "GL_DEPTH_BIAS")
+ ". ")
+ (para "
+Additionally, if the "
+ (code "ARB_imaging")
+ " extension is supported, the
+ following symbolic names are accepted: "
+ (code "GL_POST_COLOR_MATRIX_RED_SCALE")
+ ", "
+ (code "GL_POST_COLOR_MATRIX_GREEN_SCALE")
+ ", "
+ (code "GL_POST_COLOR_MATRIX_BLUE_SCALE")
+ ", "
+ (code "GL_POST_COLOR_MATRIX_ALPHA_SCALE")
+ ", "
+ (code "GL_POST_COLOR_MATRIX_RED_BIAS")
+ ", "
+ (code "GL_POST_COLOR_MATRIX_GREEN_BIAS")
+ ", "
+ (code "GL_POST_COLOR_MATRIX_BLUE_BIAS")
+ ", "
+ (code "GL_POST_COLOR_MATRIX_ALPHA_BIAS")
+ ", "
+ (code "GL_POST_CONVOLUTION_RED_SCALE")
+ ", "
+ (code "GL_POST_CONVOLUTION_GREEN_SCALE")
+ ", "
+ (code "GL_POST_CONVOLUTION_BLUE_SCALE")
+ ", "
+ (code "GL_POST_CONVOLUTION_ALPHA_SCALE")
+ ", "
+ (code "GL_POST_CONVOLUTION_RED_BIAS")
+ ", "
+ (code "GL_POST_CONVOLUTION_GREEN_BIAS")
+ ", "
+ (code "GL_POST_CONVOLUTION_BLUE_BIAS")
+ ", and "
+ (code "GL_POST_CONVOLUTION_ALPHA_BIAS")
+ ". "))
+ (entry (% (heading (var "param")))
+ (para "
+Specifies the value that "
+ (var "pname")
+ " is set to. ")))
+ (heading "Description")
+ (para (code "glPixelTransfer")
+ " sets pixel transfer modes that affect the operation of subsequent "
+ (code "glCopyPixels")
+ ", "
+ (code "glCopyTexImage1D")
+ ", "
+ (code "glCopyTexImage2D")
+ ", "
+ (code "glCopyTexSubImage1D")
+ ", "
+ (code "glCopyTexSubImage2D")
+ ", "
+ (code "glCopyTexSubImage3D")
+ ", "
+ (code "glDrawPixels")
+ ", "
+ (code "glReadPixels")
+ ", "
+ (code "glTexImage1D")
+ ", "
+ (code "glTexImage2D")
+ ", "
+ (code "glTexImage3D")
+ ", "
+ (code "glTexSubImage1D")
+ ", "
+ (code "glTexSubImage2D")
+ ", and "
+ (code "glTexSubImage3D")
+ " commands.
+ Additionally, if the "
+ (code "ARB_imaging")
+ " subset is supported, the
+ routines "
+ (code "glColorTable")
+ ", "
+ (code "glColorSubTable")
+ ", "
+ (code "glConvolutionFilter1D")
+ ", "
+ (code "glConvolutionFilter2D")
+ ", "
+ (code "glHistogram")
+ ", "
+ (code "glMinmax")
+ ", and "
+ (code "glSeparableFilter2D")
+ " are also affected.
+ The algorithms that are specified by pixel transfer modes operate on
+ pixels after they are read from the frame buffer
+ ("
+ (code "glCopyPixels")
+ (code "glCopyTexImage1D")
+ ", "
+ (code "glCopyTexImage2D")
+ ", "
+ (code "glCopyTexSubImage1D")
+ ", "
+ (code "glCopyTexSubImage2D")
+ ", "
+ (code "glCopyTexSubImage3D")
+ ", and "
+ (code "glReadPixels")
+ "),
+ or unpacked from client memory
+ ("
+ (code "glDrawPixels")
+ ", "
+ (code "glTexImage1D")
+ ", "
+ (code "glTexImage2D")
+ ", "
+ (code "glTexImage3D")
+ ", "
+ (code "glTexSubImage1D")
+ ", "
+ (code "glTexSubImage2D")
+ ", and "
+ (code "glTexSubImage3D")
+ ").
+ Pixel transfer operations happen in the same order,
+ and in the same manner,
+ regardless of the command that resulted in the pixel operation.
+ Pixel storage modes
+ (see "
+ (code "glPixelStore")
+ ")
+ control the unpacking of pixels being read from client memory
+ and the packing of pixels being written back into client memory. ")
+ (para "
+Pixel transfer operations handle four fundamental pixel types: "
+ (var "color")
+ ", "
+ (var "color index")
+ ", "
+ (var "depth")
+ ", and "
+ (var "stencil")
+ ". "
+ (var "Color")
+ " pixels consist of four floating-point values
+ with unspecified mantissa and exponent sizes,
+ scaled such that 0 represents zero intensity
+ and 1 represents full intensity. "
+ (var "Color indices")
+ " comprise a single fixed-point value,
+ with unspecified precision to the right of the binary point. "
+ (var "Depth")
+ " pixels comprise a single floating-point value,
+ with unspecified mantissa and exponent sizes,
+ scaled such that 0.0 represents the minimum depth buffer value,
+ and 1.0 represents the maximum depth buffer value.
+ Finally, "
+ (var "stencil")
+ " pixels comprise a single fixed-point value,
+ with unspecified precision to the right of the binary point. ")
+ (para "
+The pixel transfer operations performed on the four basic pixel types are
+ as follows: ")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "Color")))
+ (para "
+Each of the four color components is multiplied by a scale factor,
+ then added to a bias factor.
+ That is,
+ the red component is multiplied by "
+ (code "GL_RED_SCALE")
+ ",
+ then added to "
+ (code "GL_RED_BIAS")
+ ";
+ the green component is multiplied by "
+ (code "GL_GREEN_SCALE")
+ ",
+ then added to "
+ (code "GL_GREEN_BIAS")
+ ";
+ the blue component is multiplied by "
+ (code "GL_BLUE_SCALE")
+ ",
+ then added to "
+ (code "GL_BLUE_BIAS")
+ "; and
+ the alpha component is multiplied by "
+ (code "GL_ALPHA_SCALE")
+ ",
+ then added to "
+ (code "GL_ALPHA_BIAS")
+ ".
+ After all four color components are scaled and biased,
+ each is clamped to the range "
+ (math "[" "0" "," "1" "]")
+ ".
+ All color, scale, and bias values are specified with "
+ (code "glPixelTransfer")
+ ". ")
+ (para "
+If "
+ (code "GL_MAP_COLOR")
+ " is true,
+ each color component is scaled by the size of the corresponding
+ color-to-color map,
+ then replaced by the contents of that map indexed by the scaled component.
+ That is,
+ the red component is scaled by "
+ (code "GL_PIXEL_MAP_R_TO_R_SIZE")
+ ",
+ then replaced by the contents of "
+ (code "GL_PIXEL_MAP_R_TO_R")
+ " indexed by itself.
+ The green component is scaled by "
+ (code "GL_PIXEL_MAP_G_TO_G_SIZE")
+ ",
+ then replaced by the contents of "
+ (code "GL_PIXEL_MAP_G_TO_G")
+ " indexed by itself.
+ The blue component is scaled by "
+ (code "GL_PIXEL_MAP_B_TO_B_SIZE")
+ ",
+ then replaced by the contents of "
+ (code "GL_PIXEL_MAP_B_TO_B")
+ " indexed by itself.
+ And
+ the alpha component is scaled by "
+ (code "GL_PIXEL_MAP_A_TO_A_SIZE")
+ ",
+ then replaced by the contents of "
+ (code "GL_PIXEL_MAP_A_TO_A")
+ " indexed by itself.
+ All components taken from the maps are then clamped to the range "
+ (math "[" "0" "," "1" "]")
+ ". "
+ (code "GL_MAP_COLOR")
+ " is specified with "
+ (code "glPixelTransfer")
+ ".
+ The contents of the various maps are specified with "
+ (code "glPixelMap")
+ ". ")
+ (para "
+If the "
+ (code "ARB_imaging")
+ " extension is supported, each of the four
+ color components may be scaled and biased after transformation by the
+ color matrix.
+ That is,
+ the red component is multiplied by "
+ (code "GL_POST_COLOR_MATRIX_RED_SCALE")
+ ",
+ then added to "
+ (code "GL_POST_COLOR_MATRIX_RED_BIAS")
+ ";
+ the green component is multiplied by "
+ (code "GL_POST_COLOR_MATRIX_GREEN_SCALE")
+ ",
+ then added to "
+ (code "GL_POST_COLOR_MATRIX_GREEN_BIAS")
+ ";
+ the blue component is multiplied by "
+ (code "GL_POST_COLOR_MATRIX_BLUE_SCALE")
+ ",
+ then added to "
+ (code "GL_POST_COLOR_MATRIX_BLUE_BIAS")
+ "; and
+ the alpha component is multiplied by "
+ (code "GL_POST_COLOR_MATRIX_ALPHA_SCALE")
+ ",
+ then added to "
+ (code "GL_POST_COLOR_MATRIX_ALPHA_BIAS")
+ ".
+ After all four color components are scaled and biased,
+ each is clamped to the range "
+ (math "[" "0" "," "1" "]")
+ ". ")
+ (para "
+Similarly, if the "
+ (code "ARB_imaging")
+ " extension is supported, each of
+ the four color components may be scaled and biased after processing by
+ the enabled convolution filter.
+ That is,
+ the red component is multiplied by "
+ (code "GL_POST_CONVOLUTION_RED_SCALE")
+ ",
+ then added to "
+ (code "GL_POST_CONVOLUTION_RED_BIAS")
+ ";
+ the green component is multiplied by "
+ (code "GL_POST_CONVOLUTION_GREEN_SCALE")
+ ",
+ then added to "
+ (code "GL_POST_CONVOLUTION_GREEN_BIAS")
+ ";
+ the blue component is multiplied by "
+ (code "GL_POST_CONVOLUTION_BLUE_SCALE")
+ ",
+ then added to "
+ (code "GL_POST_CONVOLUTION_BLUE_BIAS")
+ "; and
+ the alpha component is multiplied by "
+ (code "GL_POST_CONVOLUTION_ALPHA_SCALE")
+ ",
+ then added to "
+ (code "GL_POST_CONVOLUTION_ALPHA_BIAS")
+ ".
+ After all four color components are scaled and biased,
+ each is clamped to the range "
+ (math "[" "0" "," "1" "]")
+ ". "))
+ (entry (% (heading (var "Color index")))
+ (para "
+Each color index is shifted left by "
+ (code "GL_INDEX_SHIFT")
+ " bits; any bits
+ beyond the number of fraction bits carried
+ by the fixed-point index are filled with zeros.
+ If "
+ (code "GL_INDEX_SHIFT")
+ " is negative,
+ the shift is to the right,
+ again zero filled.
+ Then "
+ (code "GL_INDEX_OFFSET")
+ " is added to the index. "
+ (code "GL_INDEX_SHIFT")
+ " and "
+ (code "GL_INDEX_OFFSET")
+ " are specified with "
+ (code "glPixelTransfer")
+ ". ")
+ (para "
+From this point, operation diverges depending on the required format of
+ the resulting pixels.
+ If the resulting pixels are to be written to a color index buffer,
+ or if they are being read back to client memory in "
+ (code "GL_COLOR_INDEX")
+ " format,
+ the pixels continue to be treated as indices.
+ If "
+ (code "GL_MAP_COLOR")
+ " is true,
+ each index is masked by "
+ (math "2" "^" (var "n") "-" "1")
+ ",
+ where "
+ (math (var "n"))
+ "
+is "
+ (code "GL_PIXEL_MAP_I_TO_I_SIZE")
+ ",
+ then replaced by the contents of "
+ (code "GL_PIXEL_MAP_I_TO_I")
+ " indexed by the
+ masked value. "
+ (code "GL_MAP_COLOR")
+ " is specified with "
+ (code "glPixelTransfer")
+ ".
+ The contents of the index map is specified with "
+ (code "glPixelMap")
+ ". ")
+ (para "
+If the resulting pixels are to be written to an RGBA color buffer,
+ or if they are read back to client memory in a format other than "
+ (code "GL_COLOR_INDEX")
+ ",
+ the pixels are converted from indices to colors by referencing the
+ four maps "
+ (code "GL_PIXEL_MAP_I_TO_R")
+ ", "
+ (code "GL_PIXEL_MAP_I_TO_G")
+ ", "
+ (code "GL_PIXEL_MAP_I_TO_B")
+ ", and "
+ (code "GL_PIXEL_MAP_I_TO_A")
+ ".
+ Before being dereferenced,
+ the index is masked by "
+ (math "2" "^" (var "n") "-" "1")
+ ",
+ where "
+ (math (var "n"))
+ "
+is "
+ (code "GL_PIXEL_MAP_I_TO_R_SIZE")
+ " for the red map, "
+ (code "GL_PIXEL_MAP_I_TO_G_SIZE")
+ " for the green map, "
+ (code "GL_PIXEL_MAP_I_TO_B_SIZE")
+ " for the blue map, and "
+ (code "GL_PIXEL_MAP_I_TO_A_SIZE")
+ " for the alpha map.
+ All components taken from the maps are then clamped to the range "
+ (math "[" "0" "," "1" "]")
+ ".
+ The contents of the four maps is specified with "
+ (code "glPixelMap")
+ ". "))
+ (entry (% (heading (var "Depth")))
+ (para "
+Each depth value is multiplied by "
+ (code "GL_DEPTH_SCALE")
+ ",
+ added to "
+ (code "GL_DEPTH_BIAS")
+ ",
+ then clamped to the range "
+ (math "[" "0" "," "1" "]")
+ ". "))
+ (entry (% (heading (var "Stencil")))
+ (para "
+Each index is shifted "
+ (code "GL_INDEX_SHIFT")
+ " bits just as a color index is,
+ then added to "
+ (code "GL_INDEX_OFFSET")
+ ".
+ If "
+ (code "GL_MAP_STENCIL")
+ " is true,
+ each index is masked by "
+ (math "2" "^" (var "n") "-" "1")
+ ",
+ where "
+ (math (var "n"))
+ "
+is "
+ (code "GL_PIXEL_MAP_S_TO_S_SIZE")
+ ",
+ then replaced by the contents of "
+ (code "GL_PIXEL_MAP_S_TO_S")
+ " indexed by the
+ masked value. ")))
+ (para "
+The following table gives the type,
+ initial value,
+ and range of valid values for each of the pixel transfer parameters
+ that are set with "
+ (code "glPixelTransfer")
+ ". ")
+ (para)
+ (table (% (formatter (asis)))
+ (entry (% (heading (strong (var "pname"))))
+ (para (strong "Type")
+ ", "
+ (strong "Initial Value")
+ ", "
+ (strong "Valid Range")))
+ (entry (% (heading (code "GL_MAP_COLOR")))
+ (para "
+boolean "
+ ", "
+ "
+false "
+ ", "
+ "
+true/false "))
+ (entry (% (heading (code "GL_MAP_STENCIL")))
+ (para "
+boolean "
+ ", "
+ "
+false "
+ ", "
+ "
+true/false "))
+ (entry (% (heading (code "GL_INDEX_SHIFT")))
+ (para "
+integer "
+ ", "
+ "
+0 "
+ ", "
+ (math "(" "-" "∞" "," "∞" ")")))
+ (entry (% (heading (code "GL_INDEX_OFFSET")))
+ (para "
+integer "
+ ", "
+ "
+0 "
+ ", "
+ (math "(" "-" "∞" "," "∞" ")")))
+ (entry (% (heading (code "GL_RED_SCALE")))
+ (para "
+float "
+ ", "
+ "
+1 "
+ ", "
+ (math "(" "-" "∞" "," "∞" ")")))
+ (entry (% (heading (code "GL_GREEN_SCALE")))
+ (para "
+float "
+ ", "
+ "
+1 "
+ ", "
+ (math "(" "-" "∞" "," "∞" ")")))
+ (entry (% (heading (code "GL_BLUE_SCALE")))
+ (para "
+float "
+ ", "
+ "
+1 "
+ ", "
+ (math "(" "-" "∞" "," "∞" ")")))
+ (entry (% (heading (code "GL_ALPHA_SCALE")))
+ (para "
+float "
+ ", "
+ "
+1 "
+ ", "
+ (math "(" "-" "∞" "," "∞" ")")))
+ (entry (% (heading (code "GL_DEPTH_SCALE")))
+ (para "
+float "
+ ", "
+ "
+1 "
+ ", "
+ (math "(" "-" "∞" "," "∞" ")")))
+ (entry (% (heading (code "GL_RED_BIAS")))
+ (para "
+float "
+ ", "
+ "
+0 "
+ ", "
+ (math "(" "-" "∞" "," "∞" ")")))
+ (entry (% (heading (code "GL_GREEN_BIAS")))
+ (para "
+float "
+ ", "
+ "
+0 "
+ ", "
+ (math "(" "-" "∞" "," "∞" ")")))
+ (entry (% (heading (code "GL_BLUE_BIAS")))
+ (para "
+float "
+ ", "
+ "
+0 "
+ ", "
+ (math "(" "-" "∞" "," "∞" ")")))
+ (entry (% (heading (code "GL_ALPHA_BIAS")))
+ (para "
+float "
+ ", "
+ "
+0 "
+ ", "
+ (math "(" "-" "∞" "," "∞" ")")))
+ (entry (% (heading (code "GL_DEPTH_BIAS")))
+ (para "
+float "
+ ", "
+ "
+0 "
+ ", "
+ (math "(" "-" "∞" "," "∞" ")")))
+ (entry (% (heading (code "GL_POST_COLOR_MATRIX_RED_SCALE")))
+ (para "
+float "
+ ", "
+ "
+1 "
+ ", "
+ (math "(" "-" "∞" "," "∞" ")")))
+ (entry (% (heading
+ (code "GL_POST_COLOR_MATRIX_GREEN_SCALE")))
+ (para "
+float "
+ ", "
+ "
+1 "
+ ", "
+ (math "(" "-" "∞" "," "∞" ")")))
+ (entry (% (heading
+ (code "GL_POST_COLOR_MATRIX_BLUE_SCALE")))
+ (para "
+float "
+ ", "
+ "
+1 "
+ ", "
+ (math "(" "-" "∞" "," "∞" ")")))
+ (entry (% (heading
+ (code "GL_POST_COLOR_MATRIX_ALPHA_SCALE")))
+ (para "
+float "
+ ", "
+ "
+1 "
+ ", "
+ (math "(" "-" "∞" "," "∞" ")")))
+ (entry (% (heading (code "GL_POST_COLOR_MATRIX_RED_BIAS")))
+ (para "
+float "
+ ", "
+ "
+0 "
+ ", "
+ (math "(" "-" "∞" "," "∞" ")")))
+ (entry (% (heading
+ (code "GL_POST_COLOR_MATRIX_GREEN_BIAS")))
+ (para "
+float "
+ ", "
+ "
+0 "
+ ", "
+ (math "(" "-" "∞" "," "∞" ")")))
+ (entry (% (heading (code "GL_POST_COLOR_MATRIX_BLUE_BIAS")))
+ (para "
+float "
+ ", "
+ "
+0 "
+ ", "
+ (math "(" "-" "∞" "," "∞" ")")))
+ (entry (% (heading
+ (code "GL_POST_COLOR_MATRIX_ALPHA_BIAS")))
+ (para "
+float "
+ ", "
+ "
+0 "
+ ", "
+ (math "(" "-" "∞" "," "∞" ")")))
+ (entry (% (heading (code "GL_POST_CONVOLUTION_RED_SCALE")))
+ (para "
+float "
+ ", "
+ "
+1 "
+ ", "
+ (math "(" "-" "∞" "," "∞" ")")))
+ (entry (% (heading
+ (code "GL_POST_CONVOLUTION_GREEN_SCALE")))
+ (para "
+float "
+ ", "
+ "
+1 "
+ ", "
+ (math "(" "-" "∞" "," "∞" ")")))
+ (entry (% (heading (code "GL_POST_CONVOLUTION_BLUE_SCALE")))
+ (para "
+float "
+ ", "
+ "
+1 "
+ ", "
+ (math "(" "-" "∞" "," "∞" ")")))
+ (entry (% (heading
+ (code "GL_POST_CONVOLUTION_ALPHA_SCALE")))
+ (para "
+float "
+ ", "
+ "
+1 "
+ ", "
+ (math "(" "-" "∞" "," "∞" ")")))
+ (entry (% (heading (code "GL_POST_CONVOLUTION_RED_BIAS")))
+ (para "
+float "
+ ", "
+ "
+0 "
+ ", "
+ (math "(" "-" "∞" "," "∞" ")")))
+ (entry (% (heading (code "GL_POST_CONVOLUTION_GREEN_BIAS")))
+ (para "
+float "
+ ", "
+ "
+0 "
+ ", "
+ (math "(" "-" "∞" "," "∞" ")")))
+ (entry (% (heading (code "GL_POST_CONVOLUTION_BLUE_BIAS")))
+ (para "
+float "
+ ", "
+ "
+0 "
+ ", "
+ (math "(" "-" "∞" "," "∞" ")")))
+ (entry (% (heading (code "GL_POST_CONVOLUTION_ALPHA_BIAS")))
+ (para "
+float "
+ ", "
+ "
+0 "
+ ", "
+ (math "(" "-" "∞" "," "∞" ")"))))
+ (para (code "glPixelTransferf")
+ " can be used to set any pixel transfer parameter.
+ If the parameter type is boolean,
+ 0 implies false and any other value implies true.
+ If "
+ (var "pname")
+ " is an integer parameter, "
+ (var "param")
+ " is rounded to the nearest integer. ")
+ (para "
+Likewise, "
+ (code "glPixelTransferi")
+ " can be used to set any of the
+ pixel transfer parameters.
+ Boolean parameters are set to false if "
+ (var "param")
+ " is 0 and to true otherwise. "
+ (var "param")
+ " is converted to floating point before being assigned to real-valued parameters. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "pname")
+ " is not an accepted value. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glPixelTransfer")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glPixelZoom
+ "glPixelZoom"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glPixelZoom"))
+ (paramdef "GLfloat " (parameter "xfactor"))
+ (paramdef "GLfloat " (parameter "yfactor"))))
+ '(*fragment*
+ (heading "specify the pixel zoom factors")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "xfactor")))
+ (itemx (var "yfactor"))
+ (para "
+Specify the "
+ (math (var "x"))
+ "
+and "
+ (math (var "y"))
+ "
+zoom factors for pixel write operations. ")))
+ (heading "Description")
+ (para (code "glPixelZoom")
+ " specifies values for the "
+ (math (var "x"))
+ "
+and "
+ (math (var "y"))
+ "
+zoom factors.
+ During the execution of "
+ (code "glDrawPixels")
+ " or "
+ (code "glCopyPixels")
+ ",
+ if
+ ("
+ (math (var "xr"))
+ ", "
+ (math (var "yr"))
+ ")
+ is the current raster position,
+ and a given element is in the "
+ (math (var "m"))
+ "th
+ row and "
+ (math (var "n"))
+ "th
+ column of the pixel rectangle,
+ then pixels whose centers are in the rectangle with corners at ")
+ (para "
+("
+ (math (var "xr")
+ "+"
+ (var "n")
+ "·"
+ (var "xfactor"))
+ ", "
+ (math (var "yr")
+ "+"
+ (var "m")
+ "·"
+ (var "yfactor"))
+ ") ")
+ (para "
+("
+ (math (var "xr")
+ "+"
+ "("
+ (var "n")
+ "+"
+ "1"
+ ","
+ ")"
+ "·"
+ (var "xfactor"))
+ ", "
+ (math (var "yr")
+ "+"
+ "("
+ (var "m")
+ "+"
+ "1"
+ ","
+ ")"
+ "·"
+ (var "yfactor"))
+ ") ")
+ (para "
+are candidates for replacement.
+ Any pixel whose center lies on the bottom or left edge of this rectangular
+ region is also modified. ")
+ (para "
+Pixel zoom factors are not limited to positive values.
+ Negative zoom factors reflect the resulting image about the current
+ raster position. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glPixelZoom")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glPointParameter
+ "glPointParameter"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glPointParameterf"))
+ (paramdef "GLenum " (parameter "pname"))
+ (paramdef "GLfloat " (parameter "param"))))
+ '(*fragment*
+ (heading "specify point parameters")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "pname")))
+ (para "
+Specifies a single-valued point parameter. "
+ (code "GL_POINT_SIZE_MIN")
+ ", "
+ (code "GL_POINT_SIZE_MAX")
+ ", "
+ (code "GL_POINT_FADE_THRESHOLD_SIZE")
+ ", and "
+ (code "GL_POINT_SPRITE_COORD_ORIGIN")
+ "
+are accepted. "))
+ (entry (% (heading (var "param")))
+ (para "
+Specifies the value that "
+ (var "pname")
+ " will be set to. ")))
+ (heading "Description")
+ (para "
+The following values are accepted for "
+ (var "pname")
+ ": ")
+ (table (% (formatter (asis)))
+ (entry (% (heading (code "GL_POINT_SIZE_MIN")))
+ (para)
+ (para (var "params")
+ " is a single floating-point value that specifies the minimum point size. The default value is 0.0. "))
+ (entry (% (heading (code "GL_POINT_SIZE_MAX")))
+ (para)
+ (para (var "params")
+ " is a single floating-point value that specifies the maximum point size. The default value is 1.0. "))
+ (entry (% (heading (code "GL_POINT_FADE_THRESHOLD_SIZE")))
+ (para)
+ (para (var "params")
+ " is a single floating-point value that specifies the threshold value
+ to which point sizes are clamped if they exceed the specified value. The
+ default value is 1.0. "))
+ (entry (% (heading (code "GL_POINT_DISTANCE_ATTENUATION")))
+ (para)
+ (para (var "params")
+ " is an array of three floating-point values that specify the
+ coefficients used for scaling the computed point size. The default values
+ are "
+ (math "(" "1" "," "0" "0" ")")
+ ". "))
+ (entry (% (heading (code "GL_POINT_SPRITE_COORD_ORIGIN")))
+ (para)
+ (para (var "params")
+ " is a single enum specifying the point sprite texture coordinate origin, either "
+ (code "GL_LOWER_LEFT")
+ " or "
+ (code "GL_UPPER_LEFT")
+ ".
+ The default value is "
+ (code "GL_UPPER_LEFT")
+ ". ")))
+ (heading "Errors")
+ (para (code "GL_INVALID_VALUE")
+ " is generated If the value specified for "
+ (code "GL_POINT_SIZE_MIN")
+ ", "
+ (code "GL_POINT_SIZE_MAX")
+ ", or "
+ (code "GL_POINT_FADE_THRESHOLD_SIZE")
+ " is less than zero. ")
+ (para (code "GL_INVALID_ENUM")
+ " is generated If the value specified for "
+ (code "GL_POINT_SPRITE_COORD_ORIGIN")
+ " is not "
+ (code "GL_LOWER_LEFT")
+ " or "
+ (code "GL_UPPER_LEFT")
+ ". ")
+ (para "
+If the value for "
+ (code "GL_POINT_SIZE_MIN")
+ " is greater than "
+ (code "GL_POINT_SIZE_MAX")
+ ", the point size after clamping is undefined, but no
+ error is generated. ")
+ (para)))
+
+(define-gl-procedure
+ glPointSize
+ "glPointSize"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glPointSize"))
+ (paramdef "GLfloat " (parameter "size"))))
+ '(*fragment*
+ (heading
+ "specify the diameter of rasterized points")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "size")))
+ (para "
+Specifies the diameter of rasterized points.
+ The initial value is 1. ")))
+ (heading "Description")
+ (para (code "glPointSize")
+ " specifies the rasterized diameter of both aliased and antialiased
+ points. Using a point size other than 1 has different effects, depending
+ on whether point antialiasing is enabled. To enable and disable point
+ antialiasing, call "
+ (code "glEnable")
+ " and "
+ (code "glDisable")
+ " with argument "
+ (code "GL_POINT_SMOOTH")
+ ". Point antialiasing is initially disabled. ")
+ (para "
+The specified point size is multiplied with a distance attenuation factor
+ and clamped to the specified point size range, and further clamped to the
+ implementation-dependent point size range to produce the derived point size
+ using ")
+ (para (math (var "pointSize")
+ "="
+ (var "clamp")
+ "\u2062"
+ "("
+ (var "size")
+ "×"
+ "√"
+ "("
+ "1"
+ "/"
+ (var "a")
+ "+"
+ (var "b")
+ "×"
+ (var "d")
+ "+"
+ (var "c")
+ "×"
+ (var "d")
+ "^"
+ "2"
+ ","
+ ","
+ ","
+ ")"
+ ","
+ ","
+ ")"))
+ (para "
+where "
+ (math (var "d"))
+ "
+is the eye-coordinate distance from the eye to the vertex, and "
+ (math (var "a"))
+ ", "
+ (math (var "b"))
+ ",
+ and "
+ (math (var "c"))
+ "
+are the distance attenuation coefficients (see "
+ (code "glPointParameter")
+ "). ")
+ (para "
+If multisampling is disabled, the computed point size is used as the
+ point's width. ")
+ (para "
+If multisampling is enabled, the point may be faded by modifying the point
+ alpha value (see "
+ (code "glSampleCoverage")
+ ") instead of allowing the point width
+ to go below a given threshold (see "
+ (code "glPointParameter")
+ "). In this case,
+ the width is further modified in the following manner: ")
+ (para (math (var "pointWidth")
+ "="
+ "{"
+ "("
+ (var "pointSize")
+ ")"
+ ", "
+ "("
+ (var "threshold")
+ ")"
+ "\u2062"
+ "("
+ (var "pointSize")
+ ">="
+ (var "threshold")
+ ")"
+ ", "
+ "("
+ (var "otherwise")
+ ")"
+ ","))
+ (para "
+The point alpha value is modified by computing: ")
+ (para (math (var "pointAlpha")
+ "="
+ "{"
+ "("
+ "1"
+ ")"
+ ", "
+ "("
+ "("
+ (var "pointSize")
+ "/"
+ (var "threshold")
+ ","
+ ")"
+ "^"
+ "2"
+ ")"
+ "\u2062"
+ "("
+ (var "pointSize")
+ ">="
+ (var "threshold")
+ ")"
+ ", "
+ "("
+ (var "otherwise")
+ ")"
+ ","))
+ (para "
+If point antialiasing is disabled, the actual size is determined by
+ rounding the supplied size to the nearest integer. (If the rounding
+ results in the value 0, it is as if the point size were 1.) If the rounded
+ size is odd, then the center point
+ ("
+ (math (var "x"))
+ ", "
+ (math (var "y"))
+ ")
+ of the pixel fragment
+ that represents the point is computed as ")
+ (para (math "("
+ "⌊"
+ (var "x")
+ "_"
+ (var "w")
+ ","
+ "⌋"
+ "+"
+ ".5"
+ ","
+ "⌊"
+ (var "y")
+ "_"
+ (var "w")
+ ","
+ "⌋"
+ "+"
+ ".5"
+ ")"))
+ (para "
+where "
+ (math (var "w"))
+ "
+subscripts indicate window coordinates. All pixels that lie
+ within the square grid of the rounded size centered at
+ ("
+ (math (var "x"))
+ ", "
+ (math (var "y"))
+ ")
+ make
+ up the fragment. If the size is even, the center point is ")
+ (para (math "("
+ "⌊"
+ (var "x")
+ "_"
+ (var "w")
+ "+"
+ ".5"
+ ","
+ "⌋"
+ ","
+ "⌊"
+ (var "y")
+ "_"
+ (var "w")
+ "+"
+ ".5"
+ ","
+ "⌋"
+ ")"))
+ (para "
+and the rasterized fragment's centers are the half-integer window
+ coordinates within the square of the rounded size centered at "
+ (math "(" (var "x") "," (var "y") ")")
+ ".
+ All pixel fragments produced in rasterizing a nonantialiased point are
+ assigned the same associated data, that of the vertex corresponding to the
+ point. ")
+ (para "
+If antialiasing is enabled, then point rasterization produces a fragment
+ for each pixel square that intersects the region lying within the circle
+ having diameter equal to the current point size and centered at the point's "
+ (math "("
+ (var "x")
+ "_"
+ (var "w")
+ ","
+ (var "y")
+ "_"
+ (var "w")
+ ")")
+ ".
+ The coverage value for each fragment is the
+ window coordinate area of the intersection of the circular region with the
+ corresponding pixel square. This value is saved and used in the final
+ rasterization step. The data associated with each fragment is the data
+ associated with the point being rasterized. ")
+ (para "
+Not all sizes are supported when point antialiasing is enabled. If an
+ unsupported size is requested, the nearest supported size is used. Only
+ size 1 is guaranteed to be supported; others depend on the implementation.
+ To query the range of supported sizes and the size difference between
+ supported sizes within the range, call "
+ (code "glGet")
+ " with arguments "
+ (code "GL_SMOOTH_POINT_SIZE_RANGE")
+ " and "
+ (code "GL_SMOOTH_POINT_SIZE_GRANULARITY")
+ ".
+ For aliased points, query the supported ranges and granularity with "
+ (code "glGet")
+ " with arguments "
+ (code "GL_ALIASED_POINT_SIZE_RANGE")
+ ". ")
+ (heading "Errors")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "size")
+ " is less than or equal to 0. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glPointSize")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glPolygonMode
+ "glPolygonMode"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glPolygonMode"))
+ (paramdef "GLenum " (parameter "face"))
+ (paramdef "GLenum " (parameter "mode"))))
+ '(*fragment*
+ (heading "select a polygon rasterization mode")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "face")))
+ (para "
+Specifies the polygons that "
+ (var "mode")
+ " applies to.
+ Must be "
+ (code "GL_FRONT")
+ " for front-facing polygons, "
+ (code "GL_BACK")
+ " for back-facing polygons,
+ or "
+ (code "GL_FRONT_AND_BACK")
+ " for front- and back-facing polygons. "))
+ (entry (% (heading (var "mode")))
+ (para "
+Specifies how polygons will be rasterized.
+ Accepted values are "
+ (code "GL_POINT")
+ ", "
+ (code "GL_LINE")
+ ", and "
+ (code "GL_FILL")
+ ".
+ The initial value is "
+ (code "GL_FILL")
+ " for both front- and back-facing polygons. ")))
+ (heading "Description")
+ (para (code "glPolygonMode")
+ " controls the interpretation of polygons for rasterization. "
+ (var "face")
+ " describes which polygons "
+ (var "mode")
+ " applies to:
+ front-facing polygons ("
+ (code "GL_FRONT")
+ "),
+ back-facing polygons ("
+ (code "GL_BACK")
+ "),
+ or both ("
+ (code "GL_FRONT_AND_BACK")
+ ").
+ The polygon mode affects only the final rasterization of polygons.
+ In particular,
+ a polygon's vertices are lit and
+ the polygon is clipped and possibly culled before these modes are applied. ")
+ (para "
+Three modes are defined and can be specified in "
+ (var "mode")
+ ": ")
+ (table (% (formatter (asis)))
+ (entry (% (heading (code "GL_POINT")))
+ (para "
+Polygon vertices that are marked as the start of a boundary edge
+ are drawn as points.
+ Point attributes such as "
+ (code "GL_POINT_SIZE")
+ " and "
+ (code "GL_POINT_SMOOTH")
+ " control
+ the rasterization of the points.
+ Polygon rasterization attributes other than "
+ (code "GL_POLYGON_MODE")
+ " have no effect. "))
+ (entry (% (heading (code "GL_LINE")))
+ (para "
+Boundary edges of the polygon are drawn as line segments.
+ They are treated as connected line segments for line stippling;
+ the line stipple counter and pattern are not reset between segments
+ (see "
+ (code "glLineStipple")
+ ").
+ Line attributes such as "
+ (code "GL_LINE_WIDTH")
+ " and "
+ (code "GL_LINE_SMOOTH")
+ " control
+ the rasterization of the lines.
+ Polygon rasterization attributes other than "
+ (code "GL_POLYGON_MODE")
+ " have no effect. "))
+ (entry (% (heading (code "GL_FILL")))
+ (para "
+The interior of the polygon is filled.
+ Polygon attributes such as "
+ (code "GL_POLYGON_STIPPLE")
+ " and "
+ (code "GL_POLYGON_SMOOTH")
+ " control the rasterization of the polygon. ")))
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if either "
+ (var "face")
+ " or "
+ (var "mode")
+ " is not
+ an accepted value. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glPolygonMode")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glPolygonOffset
+ "glPolygonOffset"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glPolygonOffset"))
+ (paramdef "GLfloat " (parameter "factor"))
+ (paramdef "GLfloat " (parameter "units"))))
+ '(*fragment*
+ (heading
+ "set the scale and units used to calculate depth values")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "factor")))
+ (para "
+Specifies a scale factor that is used to create a variable
+ depth offset for each polygon. The initial value is 0. "))
+ (entry (% (heading (var "units")))
+ (para "
+Is multiplied by an implementation-specific value to
+ create a constant depth offset. The initial value is 0. ")))
+ (heading "Description")
+ (para "
+When "
+ (code "GL_POLYGON_OFFSET_FILL")
+ ", "
+ (code "GL_POLYGON_OFFSET_LINE")
+ ", or "
+ (code "GL_POLYGON_OFFSET_POINT")
+ " is enabled, each
+ fragment's "
+ (var "depth")
+ " value will be offset after it is interpolated
+ from the "
+ (var "depth")
+ " values of the appropriate vertices.
+ The value of the offset is "
+ (math (var "factor")
+ "×"
+ (var "DZ")
+ "+"
+ (var "r")
+ "×"
+ (var "units"))
+ ",
+ where "
+ (math (var "DZ"))
+ "
+is a measurement of the change in depth relative to the screen
+ area of the polygon, and "
+ (math (var "r"))
+ "
+is the smallest value that is guaranteed to
+ produce a resolvable offset for a given implementation.
+ The offset is added before the depth test is performed and before
+ the value is written into the depth buffer. ")
+ (para (code "glPolygonOffset")
+ " is useful for rendering hidden-line images, for applying decals
+ to surfaces, and for rendering solids with highlighted edges. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glPolygonOffset")
+ " is executed
+ between the execution of "
+ (code "glBegin")
+ " and the corresponding
+ execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glPolygonStipple
+ "glPolygonStipple"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glPolygonStipple"))
+ (paramdef
+ "const GLubyte * "
+ (parameter "pattern"))))
+ '(*fragment*
+ (heading "set the polygon stippling pattern")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "pattern")))
+ (para "
+Specifies a pointer to a "
+ (math "32" "×" "32")
+ "
+stipple pattern that will be unpacked
+ from memory in the same way that "
+ (code "glDrawPixels")
+ " unpacks pixels. ")))
+ (heading "Description")
+ (para "
+Polygon stippling,
+ like line stippling
+ (see "
+ (code "glLineStipple")
+ "),
+ masks out certain fragments produced by rasterization,
+ creating a pattern.
+ Stippling is independent of polygon antialiasing. ")
+ (para (var "pattern")
+ " is a pointer to a "
+ (math "32" "×" "32")
+ "
+stipple pattern that is stored
+ in memory just like the pixel data supplied to a "
+ (code "glDrawPixels")
+ "
+call with "
+ ""
+ "
+height
+ and "
+ (var "width")
+ "
+both equal to 32, a pixel format
+ of "
+ (code "GL_COLOR_INDEX")
+ ", and data type
+ of "
+ (code "GL_BITMAP")
+ ".
+ That is,
+ the stipple pattern is represented as a "
+ (math "32" "×" "32")
+ "
+array
+ of 1-bit color indices packed in unsigned bytes. "
+ (code "glPixelStore")
+ " parameters like "
+ (code "GL_UNPACK_SWAP_BYTES")
+ "
+and "
+ (code "GL_UNPACK_LSB_FIRST")
+ " affect the assembling of the bits into a
+ stipple pattern.
+ Pixel transfer operations
+ (shift, offset, pixel map)
+ are not applied to the stipple image,
+ however. ")
+ (para "
+If a non-zero named buffer object is bound to the "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ " target
+ (see "
+ (code "glBindBuffer")
+ ") while a stipple pattern is
+ specified, "
+ (var "pattern")
+ " is treated as a byte offset into the buffer object's data store. ")
+ (para "
+To enable and disable polygon stippling, call "
+ (code "glEnable")
+ " and "
+ (code "glDisable")
+ "
+with argument "
+ (code "GL_POLYGON_STIPPLE")
+ ". Polygon stippling is initially
+ disabled. If it's enabled,
+ a rasterized polygon fragment with window coordinates "
+ (math (var "x") "_" (var "w"))
+ "
+and "
+ (math (var "y") "_" (var "w"))
+ "
+is sent to the next stage of the GL if and only if the
+ ("
+ (math (var "x") "_" (var "w") "%" "32")
+ ")th
+ bit in the
+ ("
+ (math (var "y") "_" (var "w") "%" "32")
+ ")th
+ row
+ of the stipple pattern is 1 (one).
+ When polygon stippling is disabled, it is as if the stipple pattern
+ consists of all 1's. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a non-zero buffer object name is bound to the "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ " target and the buffer object's data store is currently mapped. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a non-zero buffer object name is bound to the "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ " target and the data would be unpacked from the buffer
+ object such that the memory reads required would exceed the data store size. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glPolygonStipple")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glPrioritizeTextures
+ "glPrioritizeTextures"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "void "
+ (function "glPrioritizeTextures"))
+ (paramdef "GLsizei " (parameter "n"))
+ (paramdef
+ "const GLuint * "
+ (parameter "textures"))
+ (paramdef
+ "const GLclampf * "
+ (parameter "priorities"))))
+ '(*fragment*
+ (heading "set texture residence priority")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "n")))
+ (para "
+Specifies the number of textures to be prioritized. "))
+ (entry (% (heading (var "textures")))
+ (para "
+Specifies an array containing the names of the textures to be prioritized. "))
+ (entry (% (heading (var "priorities")))
+ (para "
+Specifies an array containing the texture priorities.
+ A priority given in an element of "
+ (var "priorities")
+ " applies to the texture
+ named by the corresponding element of "
+ (var "textures")
+ ". ")))
+ (heading "Description")
+ (para (code "glPrioritizeTextures")
+ " assigns the "
+ (var "n")
+ " texture priorities given in "
+ (var "priorities")
+ " to the "
+ (var "n")
+ " textures named in "
+ (var "textures")
+ ". ")
+ (para "
+The GL establishes
+ a ``working set'' of textures that are resident in texture memory.
+ These textures may be bound to a texture target much more efficiently
+ than textures that are not resident.
+ By specifying a priority for each texture, "
+ (code "glPrioritizeTextures")
+ " allows applications to guide the GL implementation in determining
+ which textures should be resident. ")
+ (para "
+The priorities given in "
+ (var "priorities")
+ " are clamped to the range "
+ (math "[" "0" "," "1" "]")
+ "
+before they are assigned.
+ 0 indicates the lowest priority; textures with priority 0
+ are least likely to be resident.
+ 1 indicates the highest priority; textures with priority 1
+ are most likely to be resident.
+ However, textures are not guaranteed to be resident until they are used. ")
+ (para (code "glPrioritizeTextures")
+ " silently ignores attempts to prioritize texture 0 or any texture
+ name that does not correspond to an existing texture. ")
+ (para (code "glPrioritizeTextures")
+ " does not require that any of the textures named by "
+ (var "textures")
+ "
+be bound to a texture target. "
+ (code "glTexParameter")
+ " may also be used to set a texture's priority,
+ but only if the texture is currently bound.
+ This is the only way to set the priority of a default texture. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "n")
+ " is negative. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glPrioritizeTextures")
+ " is executed
+ between the execution of "
+ (code "glBegin")
+ " and the corresponding
+ execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glPushAttrib
+ "glPushAttrib"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glPushAttrib"))
+ (paramdef "GLbitfield " (parameter "mask"))))
+ '(*fragment*
+ (heading
+ "push and pop the server attribute stack")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "mask")))
+ (para "
+Specifies a mask that indicates which attributes to save. Values for "
+ (var "mask")
+ " are listed below. ")))
+ (heading "Description")
+ (para (code "glPushAttrib")
+ " takes one argument,
+ a mask that indicates which groups of state variables
+ to save on the attribute stack.
+ Symbolic constants are used to set bits in the mask. "
+ (var "mask")
+ "
+is typically constructed by specifying the bitwise-or of several
+ of these constants together.
+ The special mask "
+ (code "GL_ALL_ATTRIB_BITS")
+ "
+can be used to save all stackable states. ")
+ (para "
+The symbolic mask constants and their associated GL state are as follows
+ (the second column lists which attributes are saved): ")
+ (para)
+ (table (% (formatter (asis)))
+ (entry (% (heading (code "GL_ACCUM_BUFFER_BIT")))
+ (para "
+Accumulation buffer clear value "))
+ (entry (% (heading (code "GL_COLOR_BUFFER_BIT")))
+ (para (code "GL_ALPHA_TEST") " enable bit "))
+ (entry (% (heading))
+ (para "
+Alpha test function and reference value "))
+ (entry (% (heading))
+ (para (code "GL_BLEND") " enable bit "))
+ (entry (% (heading))
+ (para "
+Blending source and destination functions "))
+ (entry (% (heading))
+ (para "
+Constant blend color "))
+ (entry (% (heading))
+ (para "
+Blending equation "))
+ (entry (% (heading))
+ (para (code "GL_DITHER") " enable bit "))
+ (entry (% (heading))
+ (para (code "GL_DRAW_BUFFER") " setting "))
+ (entry (% (heading))
+ (para (code "GL_COLOR_LOGIC_OP") " enable bit "))
+ (entry (% (heading))
+ (para (code "GL_INDEX_LOGIC_OP") " enable bit "))
+ (entry (% (heading))
+ (para "
+Logic op function "))
+ (entry (% (heading))
+ (para "
+Color mode and index mode clear values "))
+ (entry (% (heading))
+ (para "
+Color mode and index mode writemasks "))
+ (entry (% (heading (code "GL_CURRENT_BIT")))
+ (para "
+Current RGBA color "))
+ (entry (% (heading))
+ (para "
+Current color index "))
+ (entry (% (heading))
+ (para "
+Current normal vector "))
+ (entry (% (heading))
+ (para "
+Current texture coordinates "))
+ (entry (% (heading))
+ (para "
+Current raster position "))
+ (entry (% (heading))
+ (para (code "GL_CURRENT_RASTER_POSITION_VALID")
+ " flag "))
+ (entry (% (heading))
+ (para "
+RGBA color associated with current raster position "))
+ (entry (% (heading))
+ (para "
+Color index associated with current raster position "))
+ (entry (% (heading))
+ (para "
+Texture coordinates associated with current raster position "))
+ (entry (% (heading))
+ (para (code "GL_EDGE_FLAG") " flag "))
+ (entry (% (heading (code "GL_DEPTH_BUFFER_BIT")))
+ (para (code "GL_DEPTH_TEST") " enable bit "))
+ (entry (% (heading))
+ (para "
+Depth buffer test function "))
+ (entry (% (heading))
+ (para "
+Depth buffer clear value "))
+ (entry (% (heading))
+ (para (code "GL_DEPTH_WRITEMASK") " enable bit "))
+ (entry (% (heading (code "GL_ENABLE_BIT")))
+ (para (code "GL_ALPHA_TEST") " flag "))
+ (entry (% (heading))
+ (para (code "GL_AUTO_NORMAL") " flag "))
+ (entry (% (heading))
+ (para (code "GL_BLEND") " flag "))
+ (entry (% (heading))
+ (para "
+Enable bits for the user-definable clipping planes "))
+ (entry (% (heading))
+ (para (code "GL_COLOR_MATERIAL")))
+ (entry (% (heading))
+ (para (code "GL_CULL_FACE") " flag "))
+ (entry (% (heading))
+ (para (code "GL_DEPTH_TEST") " flag "))
+ (entry (% (heading))
+ (para (code "GL_DITHER") " flag "))
+ (entry (% (heading))
+ (para (code "GL_FOG") " flag "))
+ (entry (% (heading))
+ (para (code "GL_LIGHT")
+ (var "i")
+ "
+where "
+ (code "0")
+ " <= "
+ (var "i")
+ " < "
+ (code "GL_MAX_LIGHTS")))
+ (entry (% (heading))
+ (para (code "GL_LIGHTING") " flag "))
+ (entry (% (heading))
+ (para (code "GL_LINE_SMOOTH") " flag "))
+ (entry (% (heading))
+ (para (code "GL_LINE_STIPPLE") " flag "))
+ (entry (% (heading))
+ (para (code "GL_COLOR_LOGIC_OP") " flag "))
+ (entry (% (heading))
+ (para (code "GL_INDEX_LOGIC_OP") " flag "))
+ (entry (% (heading))
+ (para (code "GL_MAP1_")
+ (var "x")
+ " where "
+ (var "x")
+ " is a map type "))
+ (entry (% (heading))
+ (para (code "GL_MAP2_")
+ (var "x")
+ " where "
+ (var "x")
+ " is a map type "))
+ (entry (% (heading))
+ (para (code "GL_MULTISAMPLE") " flag "))
+ (entry (% (heading))
+ (para (code "GL_NORMALIZE") " flag "))
+ (entry (% (heading))
+ (para (code "GL_POINT_SMOOTH") " flag "))
+ (entry (% (heading))
+ (para (code "GL_POLYGON_OFFSET_LINE") " flag "))
+ (entry (% (heading))
+ (para (code "GL_POLYGON_OFFSET_FILL") " flag "))
+ (entry (% (heading))
+ (para (code "GL_POLYGON_OFFSET_POINT") " flag "))
+ (entry (% (heading))
+ (para (code "GL_POLYGON_SMOOTH") " flag "))
+ (entry (% (heading))
+ (para (code "GL_POLYGON_STIPPLE") " flag "))
+ (entry (% (heading))
+ (para (code "GL_SAMPLE_ALPHA_TO_COVERAGE")
+ " flag "))
+ (entry (% (heading))
+ (para (code "GL_SAMPLE_ALPHA_TO_ONE") " flag "))
+ (entry (% (heading))
+ (para (code "GL_SAMPLE_COVERAGE") " flag "))
+ (entry (% (heading))
+ (para (code "GL_SCISSOR_TEST") " flag "))
+ (entry (% (heading))
+ (para (code "GL_STENCIL_TEST") " flag "))
+ (entry (% (heading))
+ (para (code "GL_TEXTURE_1D") " flag "))
+ (entry (% (heading))
+ (para (code "GL_TEXTURE_2D") " flag "))
+ (entry (% (heading))
+ (para (code "GL_TEXTURE_3D") " flag "))
+ (entry (% (heading))
+ (para "
+Flags "
+ (code "GL_TEXTURE_GEN_")
+ (var "x")
+ " where "
+ (var "x")
+ " is S, T, R, or Q "))
+ (entry (% (heading (code "GL_EVAL_BIT")))
+ (para (code "GL_MAP1_")
+ (var "x")
+ " enable bits, where "
+ (var "x")
+ " is a map type "))
+ (entry (% (heading))
+ (para (code "GL_MAP2_")
+ (var "x")
+ " enable bits, where "
+ (var "x")
+ " is a map type "))
+ (entry (% (heading))
+ (para "
+1D grid endpoints and divisions "))
+ (entry (% (heading))
+ (para "
+2D grid endpoints and divisions "))
+ (entry (% (heading))
+ (para (code "GL_AUTO_NORMAL") " enable bit "))
+ (entry (% (heading (code "GL_FOG_BIT")))
+ (para (code "GL_FOG") " enable bit "))
+ (entry (% (heading)) (para "
+Fog color "))
+ (entry (% (heading)) (para "
+Fog density "))
+ (entry (% (heading)) (para "
+Linear fog start "))
+ (entry (% (heading)) (para "
+Linear fog end "))
+ (entry (% (heading)) (para "
+Fog index "))
+ (entry (% (heading))
+ (para (code "GL_FOG_MODE") " value "))
+ (entry (% (heading (code "GL_HINT_BIT")))
+ (para (code "GL_PERSPECTIVE_CORRECTION_HINT")
+ " setting "))
+ (entry (% (heading))
+ (para (code "GL_POINT_SMOOTH_HINT") " setting "))
+ (entry (% (heading))
+ (para (code "GL_LINE_SMOOTH_HINT") " setting "))
+ (entry (% (heading))
+ (para (code "GL_POLYGON_SMOOTH_HINT")
+ " setting "))
+ (entry (% (heading))
+ (para (code "GL_FOG_HINT") " setting "))
+ (entry (% (heading))
+ (para (code "GL_GENERATE_MIPMAP_HINT")
+ " setting "))
+ (entry (% (heading))
+ (para (code "GL_TEXTURE_COMPRESSION_HINT")
+ " setting "))
+ (entry (% (heading (code "GL_LIGHTING_BIT")))
+ (para (code "GL_COLOR_MATERIAL") " enable bit "))
+ (entry (% (heading))
+ (para (code "GL_COLOR_MATERIAL_FACE") " value "))
+ (entry (% (heading))
+ (para "
+Color material parameters that are tracking the current color "))
+ (entry (% (heading))
+ (para "
+Ambient scene color "))
+ (entry (% (heading))
+ (para (code "GL_LIGHT_MODEL_LOCAL_VIEWER")
+ " value "))
+ (entry (% (heading))
+ (para (code "GL_LIGHT_MODEL_TWO_SIDE")
+ " setting "))
+ (entry (% (heading))
+ (para (code "GL_LIGHTING") " enable bit "))
+ (entry (% (heading))
+ (para "
+Enable bit for each light "))
+ (entry (% (heading))
+ (para "
+Ambient, diffuse, and specular intensity for each light "))
+ (entry (% (heading))
+ (para "
+Direction, position, exponent, and cutoff angle for each light "))
+ (entry (% (heading))
+ (para "
+Constant, linear, and quadratic attenuation factors for each light "))
+ (entry (% (heading))
+ (para "
+Ambient, diffuse, specular, and emissive color for each material "))
+ (entry (% (heading))
+ (para "
+Ambient, diffuse, and specular color indices for each material "))
+ (entry (% (heading))
+ (para "
+Specular exponent for each material "))
+ (entry (% (heading))
+ (para (code "GL_SHADE_MODEL") " setting "))
+ (entry (% (heading (code "GL_LINE_BIT")))
+ (para (code "GL_LINE_SMOOTH") " flag "))
+ (entry (% (heading))
+ (para (code "GL_LINE_STIPPLE") " enable bit "))
+ (entry (% (heading))
+ (para "
+Line stipple pattern and repeat counter "))
+ (entry (% (heading)) (para "
+Line width "))
+ (entry (% (heading (code "GL_LIST_BIT")))
+ (para (code "GL_LIST_BASE") " setting "))
+ (entry (% (heading (code "GL_MULTISAMPLE_BIT")))
+ (para (code "GL_MULTISAMPLE") " flag "))
+ (entry (% (heading))
+ (para (code "GL_SAMPLE_ALPHA_TO_COVERAGE")
+ " flag "))
+ (entry (% (heading))
+ (para (code "GL_SAMPLE_ALPHA_TO_ONE") " flag "))
+ (entry (% (heading))
+ (para (code "GL_SAMPLE_COVERAGE") " flag "))
+ (entry (% (heading))
+ (para (code "GL_SAMPLE_COVERAGE_VALUE")
+ " value "))
+ (entry (% (heading))
+ (para (code "GL_SAMPLE_COVERAGE_INVERT")
+ " value "))
+ (entry (% (heading (code "GL_PIXEL_MODE_BIT")))
+ (para (code "GL_RED_BIAS")
+ " and "
+ (code "GL_RED_SCALE")
+ " settings "))
+ (entry (% (heading))
+ (para (code "GL_GREEN_BIAS")
+ " and "
+ (code "GL_GREEN_SCALE")
+ " values "))
+ (entry (% (heading))
+ (para (code "GL_BLUE_BIAS")
+ " and "
+ (code "GL_BLUE_SCALE")))
+ (entry (% (heading))
+ (para (code "GL_ALPHA_BIAS")
+ " and "
+ (code "GL_ALPHA_SCALE")))
+ (entry (% (heading))
+ (para (code "GL_DEPTH_BIAS")
+ " and "
+ (code "GL_DEPTH_SCALE")))
+ (entry (% (heading))
+ (para (code "GL_INDEX_OFFSET")
+ " and "
+ (code "GL_INDEX_SHIFT")
+ " values "))
+ (entry (% (heading))
+ (para (code "GL_MAP_COLOR")
+ " and "
+ (code "GL_MAP_STENCIL")
+ " flags "))
+ (entry (% (heading))
+ (para (code "GL_ZOOM_X")
+ " and "
+ (code "GL_ZOOM_Y")
+ " factors "))
+ (entry (% (heading))
+ (para (code "GL_READ_BUFFER") " setting "))
+ (entry (% (heading (code "GL_POINT_BIT")))
+ (para (code "GL_POINT_SMOOTH") " flag "))
+ (entry (% (heading)) (para "
+Point size "))
+ (entry (% (heading (code "GL_POLYGON_BIT")))
+ (para (code "GL_CULL_FACE") " enable bit "))
+ (entry (% (heading))
+ (para (code "GL_CULL_FACE_MODE") " value "))
+ (entry (% (heading))
+ (para (code "GL_FRONT_FACE") " indicator "))
+ (entry (% (heading))
+ (para (code "GL_POLYGON_MODE") " setting "))
+ (entry (% (heading))
+ (para (code "GL_POLYGON_SMOOTH") " flag "))
+ (entry (% (heading))
+ (para (code "GL_POLYGON_STIPPLE") " enable bit "))
+ (entry (% (heading))
+ (para (code "GL_POLYGON_OFFSET_FILL") " flag "))
+ (entry (% (heading))
+ (para (code "GL_POLYGON_OFFSET_LINE") " flag "))
+ (entry (% (heading))
+ (para (code "GL_POLYGON_OFFSET_POINT") " flag "))
+ (entry (% (heading))
+ (para (code "GL_POLYGON_OFFSET_FACTOR")))
+ (entry (% (heading))
+ (para (code "GL_POLYGON_OFFSET_UNITS")))
+ (entry (% (heading (code "GL_POLYGON_STIPPLE_BIT")))
+ (para "
+Polygon stipple image "))
+ (entry (% (heading (code "GL_SCISSOR_BIT")))
+ (para (code "GL_SCISSOR_TEST") " flag "))
+ (entry (% (heading)) (para "
+Scissor box "))
+ (entry (% (heading (code "GL_STENCIL_BUFFER_BIT")))
+ (para (code "GL_STENCIL_TEST") " enable bit "))
+ (entry (% (heading))
+ (para "
+Stencil function and reference value "))
+ (entry (% (heading))
+ (para "
+Stencil value mask "))
+ (entry (% (heading))
+ (para "
+Stencil fail, pass, and depth buffer pass actions "))
+ (entry (% (heading))
+ (para "
+Stencil buffer clear value "))
+ (entry (% (heading))
+ (para "
+Stencil buffer writemask "))
+ (entry (% (heading (code "GL_TEXTURE_BIT")))
+ (para "
+Enable bits for the four texture coordinates "))
+ (entry (% (heading))
+ (para "
+Border color for each texture image "))
+ (entry (% (heading))
+ (para "
+Minification function for each texture image "))
+ (entry (% (heading))
+ (para "
+Magnification function for each texture image "))
+ (entry (% (heading))
+ (para "
+Texture coordinates and wrap mode for each texture image "))
+ (entry (% (heading))
+ (para "
+Color and mode for each texture environment "))
+ (entry (% (heading))
+ (para "
+Enable bits "
+ (code "GL_TEXTURE_GEN_")
+ (var "x")
+ ", "
+ (var "x")
+ " is S, T, R, and Q "))
+ (entry (% (heading))
+ (para (code "GL_TEXTURE_GEN_MODE")
+ " setting for S, T, R, and Q "))
+ (entry (% (heading))
+ (para (code "glTexGen")
+ " plane equations for S, T, R, and Q "))
+ (entry (% (heading))
+ (para "
+Current texture bindings (for example, "
+ (code "GL_TEXTURE_BINDING_2D")
+ ") "))
+ (entry (% (heading (code "GL_TRANSFORM_BIT")))
+ (para "
+Coefficients of the six clipping planes "))
+ (entry (% (heading))
+ (para "
+Enable bits for the user-definable clipping planes "))
+ (entry (% (heading))
+ (para (code "GL_MATRIX_MODE") " value "))
+ (entry (% (heading))
+ (para (code "GL_NORMALIZE") " flag "))
+ (entry (% (heading))
+ (para (code "GL_RESCALE_NORMAL") " flag "))
+ (entry (% (heading (code "GL_VIEWPORT_BIT")))
+ (para "
+Depth range (near and far) "))
+ (entry (% (heading))
+ (para "
+Viewport origin and extent ")))
+ (para (code "glPopAttrib")
+ " restores the values of the state variables saved with the last "
+ (code "glPushAttrib")
+ " command.
+ Those not saved are left unchanged. ")
+ (para "
+It is an error to push attributes onto a full stack
+ or to pop attributes off an empty stack.
+ In either case, the error flag is set
+ and no other change is made to GL state. ")
+ (para "
+Initially, the attribute stack is empty. ")
+ (heading "Errors")
+ (para (code "GL_STACK_OVERFLOW")
+ " is generated if "
+ (code "glPushAttrib")
+ " is called while
+ the attribute stack is full. ")
+ (para (code "GL_STACK_UNDERFLOW")
+ " is generated if "
+ (code "glPopAttrib")
+ " is called while
+ the attribute stack is empty. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glPushAttrib")
+ " or "
+ (code "glPopAttrib")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glPushClientAttrib
+ "glPushClientAttrib"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glPushClientAttrib"))
+ (paramdef "GLbitfield " (parameter "mask"))))
+ '(*fragment*
+ (heading
+ "push and pop the client attribute stack")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "mask")))
+ (para "
+Specifies a mask that indicates which attributes to save. Values for "
+ (var "mask")
+ " are listed below. ")))
+ (heading "Description")
+ (para (code "glPushClientAttrib")
+ " takes one argument,
+ a mask that indicates which groups of client-state variables
+ to save on the client attribute stack.
+ Symbolic constants are used to set bits in the mask. "
+ (var "mask")
+ "
+is typically constructed by specifying the bitwise-or of several
+\t of these constants together.
+ The special mask "
+ (code "GL_CLIENT_ALL_ATTRIB_BITS")
+ "
+can be used to save all stackable client state. ")
+ (para "
+The symbolic mask constants and their associated GL client state are as follows
+ (the second column lists which attributes are saved): ")
+ (para (code "GL_CLIENT_PIXEL_STORE_BIT")
+ "\tPixel storage modes "
+ (code "GL_CLIENT_VERTEX_ARRAY_BIT")
+ "\tVertex arrays (and enables) ")
+ (para (code "glPopClientAttrib")
+ " restores the values of the client-state variables
+ saved with the last "
+ (code "glPushClientAttrib")
+ ".
+ Those not saved are left unchanged. ")
+ (para "
+It is an error to push attributes onto a full client attribute stack
+ or to pop attributes off an empty stack.
+ In either case, the error flag is set,
+ and no other change is made to GL state. ")
+ (para "
+Initially, the client attribute stack is empty. ")
+ (heading "Errors")
+ (para (code "GL_STACK_OVERFLOW")
+ " is generated if "
+ (code "glPushClientAttrib")
+ " is called while
+ the attribute stack is full. ")
+ (para (code "GL_STACK_UNDERFLOW")
+ " is generated if "
+ (code "glPopClientAttrib")
+ " is called while
+ the attribute stack is empty. ")))
+
+(define-gl-procedure
+ glPushMatrix
+ "glPushMatrix"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glPushMatrix"))
+ (paramdef (parameter "void"))))
+ '(*fragment*
+ (heading "push and pop the current matrix stack")
+ (heading "Description")
+ (para "
+There is a stack of matrices for each of the matrix modes.
+ In "
+ (code "GL_MODELVIEW")
+ " mode,
+ the stack depth is at least 32.
+ In the other modes, "
+ (code "GL_COLOR")
+ ", "
+ (code "GL_PROJECTION")
+ ", and "
+ (code "GL_TEXTURE")
+ ",
+ the depth is at least 2.
+ The current matrix in any mode is the matrix on the top of the stack
+ for that mode. ")
+ (para (code "glPushMatrix")
+ " pushes the current matrix stack down by one,
+ duplicating the current matrix.
+ That is,
+ after a "
+ (code "glPushMatrix")
+ " call,
+ the matrix on top of the stack is identical to the one below it. ")
+ (para (code "glPopMatrix")
+ " pops the current matrix stack,
+ replacing the current matrix with the one below it on the stack. ")
+ (para "
+Initially, each of the stacks contains one matrix, an identity matrix. ")
+ (para "
+It is an error to push a full matrix stack
+ or to pop a matrix stack that contains only a single matrix.
+ In either case, the error flag is set
+ and no other change is made to GL state. ")
+ (heading "Errors")
+ (para (code "GL_STACK_OVERFLOW")
+ " is generated if "
+ (code "glPushMatrix")
+ " is called while
+ the current matrix stack is full. ")
+ (para (code "GL_STACK_UNDERFLOW")
+ " is generated if "
+ (code "glPopMatrix")
+ " is called while
+ the current matrix stack contains only a single matrix. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glPushMatrix")
+ " or "
+ (code "glPopMatrix")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glPushName
+ "glPushName"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glPushName"))
+ (paramdef "GLuint " (parameter "name"))))
+ '(*fragment*
+ (heading "push and pop the name stack")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "name")))
+ (para "
+Specifies a name that will be pushed onto the name stack. ")))
+ (heading "Description")
+ (para "
+The name stack is used during selection mode to allow sets of rendering
+ commands to be uniquely identified.
+ It consists of an ordered set of unsigned integers and is initially empty. ")
+ (para (code "glPushName")
+ " causes "
+ (var "name")
+ " to be pushed onto the name stack. "
+ (code "glPopName")
+ " pops one name off the top of the stack. ")
+ (para "
+The maximum name stack depth is implementation-dependent; call "
+ (code "GL_MAX_NAME_STACK_DEPTH")
+ " to find out the value for a particular
+ implementation. It is an
+ error to push a name onto a full stack
+ or to pop a name off an empty stack.
+ It is also an error to manipulate the name stack between the execution of "
+ (code "glBegin")
+ " and the corresponding execution of "
+ (code "glEnd")
+ ".
+ In any of these cases, the error flag is set and no other change is
+ made to GL state. ")
+ (para "
+The name stack is always empty while the render mode is not "
+ (code "GL_SELECT")
+ ".
+ Calls to "
+ (code "glPushName")
+ " or "
+ (code "glPopName")
+ " while the render mode is not "
+ (code "GL_SELECT")
+ " are ignored. ")
+ (heading "Errors")
+ (para (code "GL_STACK_OVERFLOW")
+ " is generated if "
+ (code "glPushName")
+ " is called while the
+ name stack is full. ")
+ (para (code "GL_STACK_UNDERFLOW")
+ " is generated if "
+ (code "glPopName")
+ " is called while the
+ name stack is empty. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glPushName")
+ " or "
+ (code "glPopName")
+ "
+is executed between a call to "
+ (code "glBegin")
+ " and the corresponding call to "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glRasterPos
+ "glRasterPos"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glRasterPos2s"))
+ (paramdef "GLshort " (parameter "x"))
+ (paramdef "GLshort " (parameter "y"))))
+ '(*fragment*
+ (heading
+ "specify the raster position for pixel operations")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "x")))
+ (itemx (var "y"))
+ (itemx (var "z"))
+ (itemx (var "w"))
+ (para "
+Specify the "
+ (math (var "x"))
+ ", "
+ (math (var "y"))
+ ", "
+ (math (var "z"))
+ ",
+ and "
+ (math (var "w"))
+ "
+object coordinates
+ (if present)
+ for the raster
+ position. ")))
+ (heading "Description")
+ (para "
+The GL maintains a 3D position in window coordinates.
+ This position,
+ called the raster position,
+ is used to position pixel and bitmap write operations. It is
+ maintained with subpixel accuracy.
+ See "
+ (code "glBitmap")
+ ", "
+ (code "glDrawPixels")
+ ", and "
+ (code "glCopyPixels")
+ ". ")
+ (para "
+The current raster position consists of three window coordinates
+ ("
+ (math (var "x"))
+ ", "
+ (math (var "y"))
+ ", "
+ (math (var "z"))
+ "),
+ a clip coordinate value
+ ("
+ (math (var "w"))
+ "),
+ an eye coordinate distance,
+ a valid bit,
+ and associated color data and texture coordinates.
+ The "
+ (math (var "w"))
+ "
+coordinate is a clip coordinate,
+ because "
+ (math (var "w"))
+ "
+is not projected to window coordinates. "
+ (code "glRasterPos4")
+ " specifies object coordinates "
+ (math (var "x"))
+ ", "
+ (math (var "y"))
+ ", "
+ (math (var "z"))
+ ",
+ and "
+ (math (var "w"))
+ "
+explicitly. "
+ (code "glRasterPos3")
+ " specifies object coordinate "
+ (math (var "x"))
+ ", "
+ (math (var "y"))
+ ",
+ and "
+ (math (var "z"))
+ "
+explicitly,
+ while "
+ (math (var "w"))
+ "
+is implicitly set to 1. "
+ (code "glRasterPos2")
+ " uses the argument values for "
+ (math (var "x"))
+ "
+and "
+ (math (var "y"))
+ "
+while
+ implicitly setting "
+ (math (var "z"))
+ "
+and "
+ (math (var "w"))
+ "
+to 0 and 1. ")
+ (para "
+The object coordinates presented by "
+ (code "glRasterPos")
+ " are treated just like those
+ of a "
+ (code "glVertex")
+ " command:
+ They are transformed by the current modelview and projection matrices
+ and passed to the clipping stage.
+ If the vertex is not culled,
+ then it is projected and scaled to window coordinates,
+ which become the new current raster position,
+ and the "
+ (code "GL_CURRENT_RASTER_POSITION_VALID")
+ " flag is set.
+ If the vertex "
+ (var "is")
+ "
+culled,
+ then the valid bit is cleared and the current raster position
+ and associated color and texture coordinates are undefined. ")
+ (para "
+The current raster position also includes some associated color data
+ and texture coordinates.
+ If lighting is enabled,
+ then "
+ (code "GL_CURRENT_RASTER_COLOR")
+ "
+(in RGBA mode)
+ or "
+ (code "GL_CURRENT_RASTER_INDEX")
+ "
+(in color index mode)
+ is set to the color produced by the lighting calculation
+ (see "
+ (code "glLight")
+ ", "
+ (code "glLightModel")
+ ", and "
+ (code "glShadeModel")
+ ").
+ If lighting is disabled,
+ current color
+ (in RGBA mode, state variable "
+ (code "GL_CURRENT_COLOR")
+ ")
+ or color index
+ (in color index mode, state variable "
+ (code "GL_CURRENT_INDEX")
+ ")
+ is used to update the current raster color. "
+ (code "GL_CURRENT_RASTER_SECONDARY_COLOR")
+ " (in RGBA mode) is likewise updated. ")
+ (para "
+Likewise, "
+ (code "GL_CURRENT_RASTER_TEXTURE_COORDS")
+ " is updated as a function
+ of "
+ (code "GL_CURRENT_TEXTURE_COORDS")
+ ",
+ based on the texture matrix and the texture generation functions
+ (see "
+ (code "glTexGen")
+ ").
+ Finally,
+ the distance from the origin of the eye coordinate system to the
+ vertex as transformed by only the modelview matrix replaces "
+ (code "GL_CURRENT_RASTER_DISTANCE")
+ ". ")
+ (para "
+Initially, the current raster position is (0, 0, 0, 1),
+ the current raster distance is 0,
+ the valid bit is set,
+ the associated RGBA color is (1, 1, 1, 1),
+ the associated color index is 1,
+ and the associated texture coordinates are (0, 0, 0, 1).
+ In RGBA mode, "
+ (code "GL_CURRENT_RASTER_INDEX")
+ " is always 1;
+ in color index mode,
+ the current raster RGBA color always maintains its initial value. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glRasterPos")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glReadBuffer
+ "glReadBuffer"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glReadBuffer"))
+ (paramdef "GLenum " (parameter "mode"))))
+ '(*fragment*
+ (heading
+ "select a color buffer source for pixels")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "mode")))
+ (para "
+Specifies a color buffer.
+ Accepted values are "
+ (code "GL_FRONT_LEFT")
+ ", "
+ (code "GL_FRONT_RIGHT")
+ ", "
+ (code "GL_BACK_LEFT")
+ ", "
+ (code "GL_BACK_RIGHT")
+ ", "
+ (code "GL_FRONT")
+ ", "
+ (code "GL_BACK")
+ ", "
+ (code "GL_LEFT")
+ ", "
+ (code "GL_RIGHT")
+ ", and "
+ (code "GL_AUX")
+ (var "i")
+ ",
+ where "
+ (var "i")
+ " is between 0 and the value of "
+ (code "GL_AUX_BUFFERS")
+ " minus 1. ")))
+ (heading "Description")
+ (para (code "glReadBuffer")
+ " specifies a color buffer as the source for subsequent "
+ (code "glReadPixels")
+ ", "
+ (code "glCopyTexImage1D")
+ ", "
+ (code "glCopyTexImage2D")
+ ", "
+ (code "glCopyTexSubImage1D")
+ ", "
+ (code "glCopyTexSubImage2D")
+ ", "
+ (code "glCopyTexSubImage3D")
+ ", and "
+ (code "glCopyPixels")
+ " commands. "
+ (var "mode")
+ " accepts one of twelve or more predefined values.
+ ("
+ (code "GL_AUX0")
+ " through "
+ (code "GL_AUX3")
+ " are always defined.)
+ In a fully configured system, "
+ (code "GL_FRONT")
+ ", "
+ (code "GL_LEFT")
+ ", and "
+ (code "GL_FRONT_LEFT")
+ " all name the front left buffer, "
+ (code "GL_FRONT_RIGHT")
+ " and "
+ (code "GL_RIGHT")
+ " name the front right buffer, and "
+ (code "GL_BACK_LEFT")
+ " and "
+ (code "GL_BACK")
+ " name the back left buffer. ")
+ (para "
+Nonstereo double-buffered configurations have only a front left and a
+ back left buffer.
+ Single-buffered configurations have a front left and a front right
+ buffer if stereo, and only a front left buffer if nonstereo.
+ It is an error to specify a nonexistent buffer to "
+ (code "glReadBuffer")
+ ". ")
+ (para (var "mode")
+ " is initially "
+ (code "GL_FRONT")
+ " in single-buffered configurations
+ and "
+ (code "GL_BACK")
+ " in double-buffered configurations. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "mode")
+ " is not one of the twelve
+ (or more) accepted values. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (var "mode")
+ " specifies a buffer
+ that does not exist. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glReadBuffer")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glReadPixels
+ "glReadPixels"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glReadPixels"))
+ (paramdef "GLint " (parameter "x"))
+ (paramdef "GLint " (parameter "y"))
+ (paramdef "GLsizei " (parameter "width"))
+ (paramdef "GLsizei " (parameter "height"))
+ (paramdef "GLenum " (parameter "format"))
+ (paramdef "GLenum " (parameter "type"))
+ (paramdef "GLvoid * " (parameter "data"))))
+ '(*fragment*
+ (heading
+ "read a block of pixels from the frame buffer")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "x")))
+ (itemx (var "y"))
+ (para "
+Specify the window coordinates of the first pixel
+ that is read from the frame buffer.
+ This location is the lower left corner of a rectangular block of pixels. "))
+ (entry (% (heading (var "width")))
+ (itemx (var "height"))
+ (para "
+Specify the dimensions of the pixel rectangle. "
+ (var "width")
+ " and "
+ (var "height")
+ " of one correspond to a single pixel. "))
+ (entry (% (heading (var "format")))
+ (para "
+Specifies the format of the pixel data.
+ The following symbolic values are accepted: "
+ (code "GL_COLOR_INDEX")
+ ", "
+ (code "GL_STENCIL_INDEX")
+ ", "
+ (code "GL_DEPTH_COMPONENT")
+ ", "
+ (code "GL_RED")
+ ", "
+ (code "GL_GREEN")
+ ", "
+ (code "GL_BLUE")
+ ", "
+ (code "GL_ALPHA")
+ ", "
+ (code "GL_RGB")
+ ", "
+ (code "GL_BGR")
+ ", "
+ (code "GL_RGBA")
+ ", "
+ (code "GL_BGRA")
+ ", "
+ (code "GL_LUMINANCE")
+ ", and "
+ (code "GL_LUMINANCE_ALPHA")
+ ". "))
+ (entry (% (heading (var "type")))
+ (para "
+Specifies the data type of the pixel data.
+ Must be one of "
+ (code "GL_UNSIGNED_BYTE")
+ ", "
+ (code "GL_BYTE")
+ ", "
+ (code "GL_BITMAP")
+ ", "
+ (code "GL_UNSIGNED_SHORT")
+ ", "
+ (code "GL_SHORT")
+ ", "
+ (code "GL_UNSIGNED_INT")
+ ", "
+ (code "GL_INT")
+ ", "
+ (code "GL_FLOAT")
+ ", "
+ (code "GL_UNSIGNED_BYTE_3_3_2")
+ ", "
+ (code "GL_UNSIGNED_BYTE_2_3_3_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_6_5")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_6_5_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_4_4_4_4")
+ ", "
+ (code "GL_UNSIGNED_SHORT_4_4_4_4_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_5_5_1")
+ ", "
+ (code "GL_UNSIGNED_SHORT_1_5_5_5_REV")
+ ", "
+ (code "GL_UNSIGNED_INT_8_8_8_8")
+ ", "
+ (code "GL_UNSIGNED_INT_8_8_8_8_REV")
+ ", "
+ (code "GL_UNSIGNED_INT_10_10_10_2")
+ ", or "
+ (code "GL_UNSIGNED_INT_2_10_10_10_REV")
+ ". "))
+ (entry (% (heading (var "data")))
+ (para "
+Returns the pixel data. ")))
+ (heading "Description")
+ (para (code "glReadPixels")
+ " returns pixel data from the frame buffer,
+ starting with the pixel whose lower left corner
+ is at location ("
+ (var "x")
+ ", "
+ (var "y")
+ "),
+ into client memory starting at location "
+ (var "data")
+ ".
+ Several parameters control the processing of the pixel data before
+ it is placed into client memory.
+ These parameters are set with three commands: "
+ (code "glPixelStore")
+ ", "
+ (code "glPixelTransfer")
+ ", and "
+ (code "glPixelMap")
+ ".
+ This reference page describes the effects on "
+ (code "glReadPixels")
+ " of most,
+ but not all of the parameters specified by these three commands. ")
+ (para "
+If a non-zero named buffer object is bound to the "
+ (code "GL_PIXEL_PACK_BUFFER")
+ " target
+ (see "
+ (code "glBindBuffer")
+ ") while a block of pixels is
+ requested, "
+ (var "data")
+ " is treated as a byte offset into the buffer object's data store
+ rather than a pointer to client memory. ")
+ (para "
+When the "
+ (code "ARB_imaging")
+ " extension is supported, the pixel data may
+ be processed by additional operations including color table lookup,
+ color matrix transformations, convolutions, histograms, and minimum and
+ maximum pixel value computations. ")
+ (para (code "glReadPixels")
+ " returns values from each pixel with lower left corner at "
+ (math "("
+ (var "x")
+ "+"
+ (var "i")
+ ","
+ (var "y")
+ "+"
+ (var "j")
+ ")")
+ "
+for "
+ (math "0" "<=" (var "i") "<" (var "width"))
+ "
+and "
+ (math "0" "<=" (var "j") "<" (var "height"))
+ ".
+ This pixel is said to be the "
+ (math (var "i"))
+ "th
+ pixel in the "
+ (math (var "j"))
+ "th
+ row.
+ Pixels are returned in row order from the lowest to the highest row,
+ left to right in each row. ")
+ (para (var "format")
+ " specifies the format for the returned pixel values;
+ accepted values are: ")
+ (table (% (formatter (asis)))
+ (entry (% (heading (code "GL_COLOR_INDEX")))
+ (para "
+Color indices are read from the color buffer
+ selected by "
+ (code "glReadBuffer")
+ ".
+ Each index is converted to fixed point,
+ shifted left or right depending on the value and sign of "
+ (code "GL_INDEX_SHIFT")
+ ",
+ and added to "
+ (code "GL_INDEX_OFFSET")
+ ".
+ If "
+ (code "GL_MAP_COLOR")
+ " is "
+ (code "GL_TRUE")
+ ",
+ indices are replaced by their mappings in the table "
+ (code "GL_PIXEL_MAP_I_TO_I")
+ ". "))
+ (entry (% (heading (code "GL_STENCIL_INDEX")))
+ (para "
+Stencil values are read from the stencil buffer.
+ Each index is converted to fixed point,
+ shifted left or right depending on the value and sign of "
+ (code "GL_INDEX_SHIFT")
+ ",
+ and added to "
+ (code "GL_INDEX_OFFSET")
+ ".
+ If "
+ (code "GL_MAP_STENCIL")
+ " is "
+ (code "GL_TRUE")
+ ",
+ indices are replaced by their mappings in the table "
+ (code "GL_PIXEL_MAP_S_TO_S")
+ ". "))
+ (entry (% (heading (code "GL_DEPTH_COMPONENT")))
+ (para "
+Depth values are read from the depth buffer.
+ Each component is converted to floating point such that the minimum depth
+ value maps to 0 and the maximum value maps to 1.
+ Each component is then multiplied by "
+ (code "GL_DEPTH_SCALE")
+ ",
+ added to "
+ (code "GL_DEPTH_BIAS")
+ ",
+ and finally clamped to the range "
+ (math "[" "0" "," "1" "]")
+ ". "))
+ (entry (% (heading (code "GL_RED"))))
+ (entry (% (heading (code "GL_GREEN"))))
+ (entry (% (heading (code "GL_BLUE"))))
+ (entry (% (heading (code "GL_ALPHA"))))
+ (entry (% (heading (code "GL_RGB"))))
+ (entry (% (heading (code "GL_BGR"))))
+ (entry (% (heading (code "GL_RGBA"))))
+ (entry (% (heading (code "GL_BGRA"))))
+ (entry (% (heading (code "GL_LUMINANCE"))))
+ (entry (% (heading (code "GL_LUMINANCE_ALPHA")))
+ (para "
+Processing differs depending on whether color buffers store color indices
+ or RGBA color components.
+ If color indices are stored,
+ they are read from the color buffer selected by "
+ (code "glReadBuffer")
+ ".
+ Each index is converted to fixed point,
+ shifted left or right depending on the value and sign of "
+ (code "GL_INDEX_SHIFT")
+ ",
+ and added to "
+ (code "GL_INDEX_OFFSET")
+ ".
+ Indices are then replaced by the red,
+ green,
+ blue,
+ and alpha values obtained by indexing the tables "
+ (code "GL_PIXEL_MAP_I_TO_R")
+ ", "
+ (code "GL_PIXEL_MAP_I_TO_G")
+ ", "
+ (code "GL_PIXEL_MAP_I_TO_B")
+ ", and "
+ (code "GL_PIXEL_MAP_I_TO_A")
+ ".
+ Each table must be of size "
+ (math "2" "^" (var "n"))
+ ",
+ but "
+ (math (var "n"))
+ "
+may be different for
+ different tables.
+ Before an index is used to look up a value in a table of
+ size "
+ (math "2" "^" (var "n"))
+ ",
+ it must be masked against "
+ (math "2" "^" (var "n") "-" "1")
+ ". ")
+ (para "
+If RGBA color components are stored in the color buffers,
+ they are read from the color buffer selected by "
+ (code "glReadBuffer")
+ ".
+ Each color component is converted to floating point such that zero intensity
+ maps to 0.0 and full intensity maps to 1.0.
+ Each component is then multiplied by "
+ (code "GL_c_SCALE")
+ " and
+ added to "
+ (code "GL_c_BIAS")
+ ",
+ where "
+ (var "c")
+ " is RED, GREEN, BLUE, or ALPHA.
+ Finally,
+ if "
+ (code "GL_MAP_COLOR")
+ " is "
+ (code "GL_TRUE")
+ ",
+ each component is clamped to the range "
+ (math "[" "0" "," "1" "]")
+ ",
+ scaled to the size of its corresponding table, and is then
+ replaced by its mapping in the table "
+ (code "GL_PIXEL_MAP_c_TO_c")
+ ",
+ where "
+ (var "c")
+ " is R, G, B, or A. ")
+ (para "
+Unneeded data is then discarded.
+ For example, "
+ (code "GL_RED")
+ " discards the green, blue, and alpha components,
+ while "
+ (code "GL_RGB")
+ " discards only the alpha component. "
+ (code "GL_LUMINANCE")
+ " computes a single-component value as the sum of
+ the red,
+ green,
+ and blue components,
+ and "
+ (code "GL_LUMINANCE_ALPHA")
+ " does the same,
+ while keeping alpha as a second value.
+ The final values are clamped to the range "
+ (math "[" "0" "," "1" "]")
+ ". ")))
+ (para "
+The shift,
+ scale,
+ bias,
+ and lookup factors just described are all specified by "
+ (code "glPixelTransfer")
+ ".
+ The lookup table contents themselves are specified by "
+ (code "glPixelMap")
+ ". ")
+ (para "
+Finally, the indices or components
+ are converted to the proper format,
+ as specified by "
+ (var "type")
+ ".
+ If "
+ (var "format")
+ " is "
+ (code "GL_COLOR_INDEX")
+ " or "
+ (code "GL_STENCIL_INDEX")
+ "
+and "
+ (var "type")
+ " is not "
+ (code "GL_FLOAT")
+ ",
+ each index is masked with the mask value given in the following table.
+ If "
+ (var "type")
+ " is "
+ (code "GL_FLOAT")
+ ", then each integer index is converted to
+ single-precision floating-point format. ")
+ (para "
+If "
+ (var "format")
+ " is "
+ (code "GL_RED")
+ ", "
+ (code "GL_GREEN")
+ ", "
+ (code "GL_BLUE")
+ ", "
+ (code "GL_ALPHA")
+ ", "
+ (code "GL_RGB")
+ ", "
+ (code "GL_BGR")
+ ", "
+ (code "GL_RGBA")
+ ", "
+ (code "GL_BGRA")
+ ", "
+ (code "GL_LUMINANCE")
+ ", or "
+ (code "GL_LUMINANCE_ALPHA")
+ " and "
+ (var "type")
+ " is not "
+ (code "GL_FLOAT")
+ ",
+ each component is multiplied by the multiplier shown in the following table.
+ If type is "
+ (code "GL_FLOAT")
+ ", then each component is passed as is
+ (or converted to the client's single-precision floating-point format if
+ it is different from the one used by the GL). ")
+ (para)
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "type")))
+ (para (strong "Index Mask")
+ ", "
+ (strong "Component Conversion")))
+ (entry (% (heading (code "GL_UNSIGNED_BYTE")))
+ (para (math "2" "^" "8" "-" "1")
+ ", "
+ (math "("
+ "2"
+ "^"
+ "8"
+ "-"
+ "1"
+ ","
+ ")"
+ "\u2062"
+ (var "c"))))
+ (entry (% (heading (code "GL_BYTE")))
+ (para (math "2" "^" "7" "-" "1")
+ ", "
+ (math "("
+ "2"
+ "^"
+ "8"
+ "-"
+ "1"
+ ","
+ ")"
+ "\u2062"
+ (var "c")
+ "-"
+ "1"
+ ","
+ "/"
+ "2")))
+ (entry (% (heading (code "GL_BITMAP")))
+ (para (math "1") ", " (math "1")))
+ (entry (% (heading (code "GL_UNSIGNED_SHORT")))
+ (para (math "2" "^" "16" "-" "1")
+ ", "
+ (math "("
+ "2"
+ "^"
+ "16"
+ "-"
+ "1"
+ ","
+ ")"
+ "\u2062"
+ (var "c"))))
+ (entry (% (heading (code "GL_SHORT")))
+ (para (math "2" "^" "15" "-" "1")
+ ", "
+ (math "("
+ "2"
+ "^"
+ "16"
+ "-"
+ "1"
+ ","
+ ")"
+ "\u2062"
+ (var "c")
+ "-"
+ "1"
+ ","
+ "/"
+ "2")))
+ (entry (% (heading (code "GL_UNSIGNED_INT")))
+ (para (math "2" "^" "32" "-" "1")
+ ", "
+ (math "("
+ "2"
+ "^"
+ "32"
+ "-"
+ "1"
+ ","
+ ")"
+ "\u2062"
+ (var "c"))))
+ (entry (% (heading (code "GL_INT")))
+ (para (math "2" "^" "31" "-" "1")
+ ", "
+ (math "("
+ "2"
+ "^"
+ "32"
+ "-"
+ "1"
+ ","
+ ")"
+ "\u2062"
+ (var "c")
+ "-"
+ "1"
+ ","
+ "/"
+ "2")))
+ (entry (% (heading (code "GL_FLOAT")))
+ (para "
+none " ", " (math (var "c")))))
+ (para "
+Return values are placed in memory as follows.
+ If "
+ (var "format")
+ " is "
+ (code "GL_COLOR_INDEX")
+ ", "
+ (code "GL_STENCIL_INDEX")
+ ", "
+ (code "GL_DEPTH_COMPONENT")
+ ", "
+ (code "GL_RED")
+ ", "
+ (code "GL_GREEN")
+ ", "
+ (code "GL_BLUE")
+ ", "
+ (code "GL_ALPHA")
+ ", or "
+ (code "GL_LUMINANCE")
+ ",
+ a single value is returned and the data for the "
+ (math (var "i"))
+ "th
+ pixel in the "
+ (math (var "j"))
+ "th
+ row
+ is placed in location "
+ (math "("
+ (var "j")
+ ","
+ ")"
+ "\u2062"
+ (var "width")
+ "+"
+ (var "i"))
+ ". "
+ (code "GL_RGB")
+ " and "
+ (code "GL_BGR")
+ " return three values, "
+ (code "GL_RGBA")
+ " and "
+ (code "GL_BGRA")
+ " return four values,
+ and "
+ (code "GL_LUMINANCE_ALPHA")
+ " returns two values for each pixel,
+ with all values corresponding to a single pixel occupying contiguous space
+ in "
+ (var "data")
+ ".
+ Storage parameters set by "
+ (code "glPixelStore")
+ ",
+ such as "
+ (code "GL_PACK_LSB_FIRST")
+ " and "
+ (code "GL_PACK_SWAP_BYTES")
+ ",
+ affect the way that data is written into memory.
+ See "
+ (code "glPixelStore")
+ " for a description. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "format")
+ " or "
+ (var "type")
+ " is not an
+ accepted value. ")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "type")
+ " is "
+ (code "GL_BITMAP")
+ " and "
+ (var "format")
+ " is
+ not "
+ (code "GL_COLOR_INDEX")
+ " or "
+ (code "GL_STENCIL_INDEX")
+ ". ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if either "
+ (var "width")
+ " or "
+ (var "height")
+ " is negative. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (var "format")
+ " is "
+ (code "GL_COLOR_INDEX")
+ "
+and the color buffers store RGBA color components. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (var "format")
+ " is "
+ (code "GL_STENCIL_INDEX")
+ "
+and there is no stencil buffer. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (var "format")
+ " is "
+ (code "GL_DEPTH_COMPONENT")
+ "
+and there is no depth buffer. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (var "type")
+ " is one of "
+ (code "GL_UNSIGNED_BYTE_3_3_2")
+ ", "
+ (code "GL_UNSIGNED_BYTE_2_3_3_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_6_5")
+ ", or "
+ (code "GL_UNSIGNED_SHORT_5_6_5_REV")
+ "
+and "
+ (var "format")
+ " is not "
+ (code "GL_RGB")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (var "type")
+ " is one of "
+ (code "GL_UNSIGNED_SHORT_4_4_4_4")
+ ", "
+ (code "GL_UNSIGNED_SHORT_4_4_4_4_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_5_5_1")
+ ", "
+ (code "GL_UNSIGNED_SHORT_1_5_5_5_REV")
+ ", "
+ (code "GL_UNSIGNED_INT_8_8_8_8")
+ ", "
+ (code "GL_UNSIGNED_INT_8_8_8_8_REV")
+ ", "
+ (code "GL_UNSIGNED_INT_10_10_10_2")
+ ", or "
+ (code "GL_UNSIGNED_INT_2_10_10_10_REV")
+ "
+and "
+ (var "format")
+ " is neither "
+ (code "GL_RGBA")
+ " nor "
+ (code "GL_BGRA")
+ ". ")
+ (para "
+The formats "
+ (code "GL_BGR")
+ ", and "
+ (code "GL_BGRA")
+ " and types "
+ (code "GL_UNSIGNED_BYTE_3_3_2")
+ ", "
+ (code "GL_UNSIGNED_BYTE_2_3_3_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_6_5")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_6_5_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_4_4_4_4")
+ ", "
+ (code "GL_UNSIGNED_SHORT_4_4_4_4_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_5_5_1")
+ ", "
+ (code "GL_UNSIGNED_SHORT_1_5_5_5_REV")
+ ", "
+ (code "GL_UNSIGNED_INT_8_8_8_8")
+ ", "
+ (code "GL_UNSIGNED_INT_8_8_8_8_REV")
+ ", "
+ (code "GL_UNSIGNED_INT_10_10_10_2")
+ ", and "
+ (code "GL_UNSIGNED_INT_2_10_10_10_REV")
+ " are available only if the GL version
+ is 1.2 or greater. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a non-zero buffer object name is bound to the "
+ (code "GL_PIXEL_PACK_BUFFER")
+ " target and the buffer object's data store is currently mapped. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a non-zero buffer object name is bound to the "
+ (code "GL_PIXEL_PACK_BUFFER")
+ " target and the data would be packed to the buffer
+ object such that the memory writes required would exceed the data store size. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a non-zero buffer object name is bound to the "
+ (code "GL_PIXEL_PACK_BUFFER")
+ " target and "
+ (var "data")
+ " is not evenly divisible
+ into the number of bytes needed to store in memory a datum indicated by "
+ (var "type")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glReadPixels")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glRect
+ "glRect"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glRectd"))
+ (paramdef "GLdouble " (parameter "x1"))
+ (paramdef "GLdouble " (parameter "y1"))
+ (paramdef "GLdouble " (parameter "x2"))
+ (paramdef "GLdouble " (parameter "y2"))))
+ '(*fragment*
+ (heading "draw a rectangle")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "x1")))
+ (itemx (var "y1"))
+ (para "
+Specify one vertex of a rectangle. "))
+ (entry (% (heading (var "x2")))
+ (itemx (var "y2"))
+ (para "
+Specify the opposite vertex of the rectangle. ")))
+ (heading "Description")
+ (para (code "glRect")
+ " supports efficient specification of rectangles as two corner points.
+ Each
+ rectangle command takes four arguments,
+ organized either as two consecutive pairs of "
+ (math "(" (var "x") "," (var "y") ")")
+ "
+coordinates
+ or as two pointers to arrays,
+ each containing an "
+ (math "(" (var "x") "," (var "y") ")")
+ "
+pair.
+ The resulting rectangle is defined in the "
+ (math (var "z") "=" "0")
+ "
+plane. ")
+ (para (code "glRect")
+ "("
+ (var "x1")
+ ", "
+ (var "y1")
+ ", "
+ (var "x2")
+ ", "
+ (var "y2")
+ ")
+ is exactly equivalent to the following sequence: "
+ "
+Note that if the second vertex is above and to the right of the first vertex,
+ the rectangle is constructed with a counterclockwise winding. ")
+ (example
+ "
+glBegin("
+ (code "GL_POLYGON")
+ ");
+glVertex2("
+ (var "x1")
+ ", "
+ (var "y1")
+ ");
+glVertex2("
+ (var "x2")
+ ", "
+ (var "y1")
+ ");
+glVertex2("
+ (var "x2")
+ ", "
+ (var "y2")
+ ");
+glVertex2("
+ (var "x1")
+ ", "
+ (var "y2")
+ ");
+glEnd(); ")
+ (heading "Errors")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glRect")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glRenderMode
+ "glRenderMode"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "GLint " (function "glRenderMode"))
+ (paramdef "GLenum " (parameter "mode"))))
+ '(*fragment*
+ (heading "set rasterization mode")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "mode")))
+ (para "
+Specifies the rasterization mode.
+ Three values are accepted: "
+ (code "GL_RENDER")
+ ", "
+ (code "GL_SELECT")
+ ", and "
+ (code "GL_FEEDBACK")
+ ".
+ The initial value is "
+ (code "GL_RENDER")
+ ". ")))
+ (heading "Description")
+ (para (code "glRenderMode")
+ " sets the rasterization mode.
+ It takes one argument, "
+ (var "mode")
+ ",
+ which can assume one of three predefined values: ")
+ (table (% (formatter (asis)))
+ (entry (% (heading (code "GL_RENDER")))
+ (para "
+Render mode. Primitives are rasterized,
+ producing pixel fragments,
+ which are written into the frame buffer.
+ This is the normal mode
+ and also the default mode. "))
+ (entry (% (heading (code "GL_SELECT")))
+ (para "
+Selection mode.
+ No pixel fragments are produced,
+ and no change to the frame buffer contents is made.
+ Instead,
+ a record of the names of primitives that would have been drawn
+ if the render mode had been "
+ (code "GL_RENDER")
+ " is returned in a select buffer,
+ which must be created (see "
+ (code "glSelectBuffer")
+ ") before selection mode
+ is entered. "))
+ (entry (% (heading (code "GL_FEEDBACK")))
+ (para "
+Feedback mode.
+ No pixel fragments are produced,
+ and no change to the frame buffer contents is made.
+ Instead,
+ the coordinates and attributes of vertices that would have been drawn
+ if the render mode had been "
+ (code "GL_RENDER")
+ " is returned in a feedback buffer,
+ which must be created (see "
+ (code "glFeedbackBuffer")
+ ") before feedback mode
+ is entered. ")))
+ (para "
+The return value of "
+ (code "glRenderMode")
+ " is determined by the render mode at the time "
+ (code "glRenderMode")
+ " is called,
+ rather than by "
+ (var "mode")
+ ".
+ The values returned for the three render modes are as follows: ")
+ (table (% (formatter (asis)))
+ (entry (% (heading (code "GL_RENDER")))
+ (para "
+0. "))
+ (entry (% (heading (code "GL_SELECT")))
+ (para "
+The number of hit records transferred to the select buffer. "))
+ (entry (% (heading (code "GL_FEEDBACK")))
+ (para "
+The number of values (not vertices) transferred to the feedback buffer. ")))
+ (para "
+See the "
+ (code "glSelectBuffer")
+ " and "
+ (code "glFeedbackBuffer")
+ " reference pages for
+ more details concerning selection and feedback operation. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "mode")
+ " is not one of the three
+ accepted values. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glSelectBuffer")
+ " is called
+ while the render mode is "
+ (code "GL_SELECT")
+ ",
+ or if "
+ (code "glRenderMode")
+ " is called with argument "
+ (code "GL_SELECT")
+ " before "
+ (code "glSelectBuffer")
+ " is called at least once. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glFeedbackBuffer")
+ " is called
+ while the render mode is "
+ (code "GL_FEEDBACK")
+ ",
+ or if "
+ (code "glRenderMode")
+ " is called with argument "
+ (code "GL_FEEDBACK")
+ " before "
+ (code "glFeedbackBuffer")
+ " is called at least once. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glRenderMode")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glResetHistogram
+ "glResetHistogram"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glResetHistogram"))
+ (paramdef "GLenum " (parameter "target"))))
+ '(*fragment*
+ (heading "reset histogram table entries to zero")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "target")))
+ (para "
+Must be " (code "GL_HISTOGRAM") ". ")))
+ (heading "Description")
+ (para (code "glResetHistogram")
+ " resets all the elements of the current histogram table to zero. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "target")
+ " is not "
+ (code "GL_HISTOGRAM")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glResetHistogram")
+ " is executed
+ between the execution of "
+ (code "glBegin")
+ " and the corresponding
+ execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glResetMinmax
+ "glResetMinmax"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glResetMinmax"))
+ (paramdef "GLenum " (parameter "target"))))
+ '(*fragment*
+ (heading
+ "reset minmax table entries to initial values")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "target")))
+ (para "
+Must be " (code "GL_MINMAX") ". ")))
+ (heading "Description")
+ (para (code "glResetMinmax")
+ " resets the elements of the current minmax table to their
+ initial values: the ``maximum'' element receives the minimum possible
+ component values, and the ``minimum'' element receives the maximum
+ possible component values. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "target")
+ " is not "
+ (code "GL_MINMAX")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glResetMinmax")
+ " is executed
+ between the execution of "
+ (code "glBegin")
+ " and the corresponding
+ execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glRotate
+ "glRotate"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glRotated"))
+ (paramdef "GLdouble " (parameter "angle"))
+ (paramdef "GLdouble " (parameter "x"))
+ (paramdef "GLdouble " (parameter "y"))
+ (paramdef "GLdouble " (parameter "z"))))
+ '(*fragment*
+ (heading
+ "multiply the current matrix by a rotation matrix")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "angle")))
+ (para "
+Specifies the angle of rotation, in degrees. "))
+ (entry (% (heading (var "x")))
+ (itemx (var "y"))
+ (itemx (var "z"))
+ (para "
+Specify the "
+ (var "x")
+ ", "
+ (var "y")
+ ", and "
+ (var "z")
+ " coordinates of a vector, respectively. ")))
+ (heading "Description")
+ (para (code "glRotate")
+ " produces a rotation of "
+ (var "angle")
+ " degrees around
+ the vector "
+ (math "(" (var "x") "," (var "y") (var "z") ")")
+ ".
+ The current matrix (see "
+ (code "glMatrixMode")
+ ") is multiplied by a rotation
+ matrix with the product
+ replacing the current matrix, as if "
+ (code "glMultMatrix")
+ " were called
+ with the following matrix as its argument: ")
+ (para (math "("
+ "("
+ (var "x")
+ "^"
+ "2"
+ "\u2061"
+ "("
+ "1"
+ "-"
+ (var "c")
+ ","
+ ")"
+ "+"
+ (var "c")
+ " "
+ (var "x")
+ "\u2062"
+ (var "y")
+ "\u2061"
+ "("
+ "1"
+ "-"
+ (var "c")
+ ","
+ ")"
+ "-"
+ (var "z")
+ "\u2062"
+ (var "s")
+ " "
+ (var "x")
+ "\u2062"
+ (var "z")
+ "\u2061"
+ "("
+ "1"
+ "-"
+ (var "c")
+ ","
+ ")"
+ "+"
+ (var "y")
+ "\u2062"
+ (var "s")
+ " "
+ "0"
+ ")"
+ ", "
+ "("
+ (var "y")
+ "\u2062"
+ (var "x")
+ "\u2061"
+ "("
+ "1"
+ "-"
+ (var "c")
+ ","
+ ")"
+ "+"
+ (var "z")
+ "\u2062"
+ (var "s")
+ " "
+ (var "y")
+ "^"
+ "2"
+ "\u2061"
+ "("
+ "1"
+ "-"
+ (var "c")
+ ","
+ ")"
+ "+"
+ (var "c")
+ " "
+ (var "y")
+ "\u2062"
+ (var "z")
+ "\u2061"
+ "("
+ "1"
+ "-"
+ (var "c")
+ ","
+ ")"
+ "-"
+ (var "x")
+ "\u2062"
+ (var "s")
+ " "
+ "0"
+ ")"
+ ", "
+ "("
+ (var "x")
+ "\u2062"
+ (var "z")
+ "\u2061"
+ "("
+ "1"
+ "-"
+ (var "c")
+ ","
+ ")"
+ "-"
+ (var "y")
+ "\u2062"
+ (var "s")
+ " "
+ (var "y")
+ "\u2062"
+ (var "z")
+ "\u2061"
+ "("
+ "1"
+ "-"
+ (var "c")
+ ","
+ ")"
+ "+"
+ (var "x")
+ "\u2062"
+ (var "s")
+ " "
+ (var "z")
+ "^"
+ "2"
+ "\u2061"
+ "("
+ "1"
+ "-"
+ (var "c")
+ ","
+ ")"
+ "+"
+ (var "c")
+ " "
+ "0"
+ ")"
+ ", "
+ "("
+ "0"
+ " "
+ "0"
+ " "
+ "0"
+ " "
+ "1"
+ ")"
+ ","
+ ")"))
+ (para)
+ (para "
+Where "
+ (math (var "c")
+ "="
+ (var "cos")
+ "\u2061"
+ "("
+ (var "angle")
+ ","
+ ")")
+ ", "
+ (math (var "s")
+ "="
+ (var "sin")
+ "\u2061"
+ "("
+ (var "angle")
+ ","
+ ")")
+ ",
+ and "
+ (math "∥"
+ "("
+ (var "x")
+ ","
+ (var "y")
+ (var "z")
+ ")"
+ ","
+ "∥"
+ "="
+ "1")
+ "
+(if not, the GL
+ will normalize this vector). ")
+ (para)
+ (para)
+ (para "
+If the matrix mode is either "
+ (code "GL_MODELVIEW")
+ " or "
+ (code "GL_PROJECTION")
+ ",
+ all objects drawn after "
+ (code "glRotate")
+ " is called are rotated.
+ Use "
+ (code "glPushMatrix")
+ " and "
+ (code "glPopMatrix")
+ " to save and restore
+ the unrotated coordinate system. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glRotate")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glSampleCoverage
+ "glSampleCoverage"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glSampleCoverage"))
+ (paramdef "GLclampf " (parameter "value"))
+ (paramdef "GLboolean " (parameter "invert"))))
+ '(*fragment*
+ (heading
+ "specify multisample coverage parameters")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "value")))
+ (para "
+Specify a single floating-point sample coverage value. The value is
+ clamped to the range "
+ (math "[" "0" "," "1" "]")
+ ".
+ The initial value is 1.0. "))
+ (entry (% (heading (var "invert")))
+ (para "
+Specify a single boolean value representing if the coverage masks should be
+ inverted. "
+ (code "GL_TRUE")
+ " and "
+ (code "GL_FALSE")
+ " are accepted. The initial value
+ is "
+ (code "GL_FALSE")
+ ". ")))
+ (heading "Description")
+ (para "
+Multisampling samples a pixel multiple times at various
+ implementation-dependent subpixel locations to generate antialiasing
+ effects. Multisampling transparently antialiases points, lines, polygons,
+ bitmaps, and images if it is enabled. ")
+ (para (var "value")
+ " is used in constructing a temporary mask used in determining which
+ samples will be used in resolving the final fragment color. This mask is
+ bitwise-anded with the coverage mask generated from the multisampling
+ computation. If the "
+ (var "invert")
+ " flag is set, the temporary mask is inverted
+ (all bits flipped) and then the bitwise-and is computed. ")
+ (para "
+If an implementation does not have any multisample buffers available, or
+ multisampling is disabled, rasterization occurs with only a single sample
+ computing a pixel's final RGB color. ")
+ (para "
+Provided an implementation supports multisample buffers, and multisampling
+ is enabled, then a pixel's final color is generated by combining several
+ samples per pixel. Each sample contains color, depth, and stencil
+ information, allowing those operations to be performed on each sample. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glSampleCoverage")
+ " is executed between the
+ execution of "
+ (code "glBegin")
+ " and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glScale
+ "glScale"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glScaled"))
+ (paramdef "GLdouble " (parameter "x"))
+ (paramdef "GLdouble " (parameter "y"))
+ (paramdef "GLdouble " (parameter "z"))))
+ '(*fragment*
+ (heading
+ "multiply the current matrix by a general scaling matrix")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "x")))
+ (itemx (var "y"))
+ (itemx (var "z"))
+ (para "
+Specify scale factors along the "
+ (var "x")
+ ", "
+ (var "y")
+ ", and "
+ (var "z")
+ " axes, respectively. ")))
+ (heading "Description")
+ (para (code "glScale")
+ " produces a nonuniform scaling along the "
+ (var "x")
+ ", "
+ (var "y")
+ ", and "
+ (var "z")
+ " axes.
+ The three parameters indicate the desired scale factor along
+ each of the three axes. ")
+ (para "
+The current matrix
+ (see "
+ (code "glMatrixMode")
+ ")
+ is multiplied by this scale matrix,
+ and the product replaces the current matrix
+ as if "
+ (code "glMultMatrix")
+ " were called with the following matrix
+ as its argument: ")
+ (para (math "("
+ "("
+ (var "x")
+ " "
+ "0"
+ " "
+ "0"
+ " "
+ "0"
+ ")"
+ ", "
+ "("
+ "0"
+ " "
+ (var "y")
+ " "
+ "0"
+ " "
+ "0"
+ ")"
+ ", "
+ "("
+ "0"
+ " "
+ "0"
+ " "
+ (var "z")
+ " "
+ "0"
+ ")"
+ ", "
+ "("
+ "0"
+ " "
+ "0"
+ " "
+ "0"
+ " "
+ "1"
+ ")"
+ ","
+ ")"))
+ (para "
+If the matrix mode is either "
+ (code "GL_MODELVIEW")
+ " or "
+ (code "GL_PROJECTION")
+ ",
+ all objects drawn after "
+ (code "glScale")
+ " is called are scaled. ")
+ (para "
+Use "
+ (code "glPushMatrix")
+ " and "
+ (code "glPopMatrix")
+ " to save and restore
+ the unscaled coordinate
+ system. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glScale")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glScissor
+ "glScissor"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glScissor"))
+ (paramdef "GLint " (parameter "x"))
+ (paramdef "GLint " (parameter "y"))
+ (paramdef "GLsizei " (parameter "width"))
+ (paramdef "GLsizei " (parameter "height"))))
+ '(*fragment*
+ (heading "define the scissor box")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "x")))
+ (itemx (var "y"))
+ (para "
+Specify the lower left corner of the scissor box.
+ Initially (0, 0). "))
+ (entry (% (heading (var "width")))
+ (itemx (var "height"))
+ (para "
+Specify the width and height of the scissor box.
+ When a GL context is first attached to a window, "
+ (var "width")
+ " and "
+ (var "height")
+ " are set to the dimensions of that
+ window. ")))
+ (heading "Description")
+ (para (code "glScissor")
+ " defines a rectangle, called the scissor box,
+ in window coordinates.
+ The first two arguments, "
+ (var "x")
+ " and "
+ (var "y")
+ ",
+ specify the lower left corner of the box. "
+ (var "width")
+ " and "
+ (var "height")
+ " specify the width and height of the box. ")
+ (para "
+To enable and disable the scissor test, call "
+ (code "glEnable")
+ " and "
+ (code "glDisable")
+ " with argument "
+ (code "GL_SCISSOR_TEST")
+ ". The test is initially disabled.
+ While the test is enabled, only pixels that lie within the scissor box
+ can be modified by drawing commands.
+ Window coordinates have integer values at the shared corners of
+ frame buffer pixels. "
+ (code "glScissor(0,0,1,1)")
+ " allows modification of only the lower left
+ pixel in the window, and "
+ (code "glScissor(0,0,0,0)")
+ " doesn't allow
+ modification of any pixels in the window. ")
+ (para "
+When the scissor test is disabled,
+ it is as though the scissor box includes the entire window. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if either "
+ (var "width")
+ " or "
+ (var "height")
+ " is negative. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glScissor")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glSecondaryColorPointer
+ "glSecondaryColorPointer"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "void "
+ (function "glSecondaryColorPointer"))
+ (paramdef "GLint " (parameter "size"))
+ (paramdef "GLenum " (parameter "type"))
+ (paramdef "GLsizei " (parameter "stride"))
+ (paramdef
+ "const GLvoid * "
+ (parameter "pointer"))))
+ '(*fragment*
+ (heading "define an array of secondary colors")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "size")))
+ (para "
+Specifies the number of components per color. Must be 3. "))
+ (entry (% (heading (var "type")))
+ (para "
+Specifies the data type of each color component in the array.
+ Symbolic constants "
+ (code "GL_BYTE")
+ ", "
+ (code "GL_UNSIGNED_BYTE")
+ ", "
+ (code "GL_SHORT")
+ ", "
+ (code "GL_UNSIGNED_SHORT")
+ ", "
+ (code "GL_INT")
+ ", "
+ (code "GL_UNSIGNED_INT")
+ ", "
+ (code "GL_FLOAT")
+ ",
+ or "
+ (code "GL_DOUBLE")
+ "
+are accepted.
+ The initial value is "
+ (code "GL_FLOAT")
+ ". "))
+ (entry (% (heading (var "stride")))
+ (para "
+Specifies the byte offset between consecutive colors.
+ If "
+ (var "stride")
+ " is 0, the colors are understood to be
+ tightly packed in the array. The initial value is 0. "))
+ (entry (% (heading (var "pointer")))
+ (para "
+Specifies a pointer to the first component of the first color element
+ in the array. The initial value is 0. ")))
+ (heading "Description")
+ (para (code "glSecondaryColorPointer")
+ " specifies the location and data format of an array of color components
+ to use when rendering. "
+ (var "size")
+ " specifies the number of components per color, and must be 3. "
+ (var "type")
+ " specifies the data type of each color component, and "
+ (var "stride")
+ "
+specifies the byte stride from one color to the next, allowing vertices and
+ attributes to be packed into a single array or stored in separate arrays. ")
+ (para "
+If a non-zero named buffer object is bound to the "
+ (code "GL_ARRAY_BUFFER")
+ " target
+ (see "
+ (code "glBindBuffer")
+ ") while a secondary color array is
+ specified, "
+ (var "pointer")
+ " is treated as a byte offset into the buffer object's data store.
+ Also, the buffer object binding ("
+ (code "GL_ARRAY_BUFFER_BINDING")
+ ") is saved as secondary color vertex array
+ client-side state ("
+ (code "GL_SECONDARY_COLOR_ARRAY_BUFFER_BINDING")
+ "). ")
+ (para "
+When a secondary color array is specified, "
+ (var "size")
+ ", "
+ (var "type")
+ ", "
+ (var "stride")
+ ", and "
+ (var "pointer")
+ " are saved as client-side
+ state, in addition to the current vertex array buffer object binding. ")
+ (para "
+To enable and disable the secondary color array, call "
+ (code "glEnableClientState")
+ " and "
+ (code "glDisableClientState")
+ " with the argument "
+ (code "GL_SECONDARY_COLOR_ARRAY")
+ ". If enabled, the secondary color array is used when "
+ (code "glArrayElement")
+ ", "
+ (code "glDrawArrays")
+ ", "
+ (code "glMultiDrawArrays")
+ ", "
+ (code "glDrawElements")
+ ", "
+ (code "glMultiDrawElements")
+ ", or "
+ (code "glDrawRangeElements")
+ "
+is called. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "size")
+ " is not 3. ")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "type")
+ " is not an accepted value. ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "stride")
+ " is negative. ")))
+
+(define-gl-procedure
+ glSecondaryColor
+ "glSecondaryColor"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glSecondaryColor3b"))
+ (paramdef "GLbyte " (parameter "red"))
+ (paramdef "GLbyte " (parameter "green"))
+ (paramdef "GLbyte " (parameter "blue"))))
+ '(*fragment*
+ (heading "set the current secondary color")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "red")))
+ (itemx (var "green"))
+ (itemx (var "blue"))
+ (para "
+Specify new red, green, and blue values for the current secondary color. ")))
+ (heading "Description")
+ (para "
+The GL stores both a primary four-valued RGBA color and a
+ secondary four-valued RGBA color (where alpha is always set to 0.0) that is
+ associated with every vertex. ")
+ (para "
+The secondary color is interpolated and applied to each fragment during
+ rasterization when "
+ (code "GL_COLOR_SUM")
+ " is enabled. When lighting is enabled,
+ and "
+ (code "GL_SEPARATE_SPECULAR_COLOR")
+ " is specified, the value of the
+ secondary color is assigned the value computed from the specular term of
+ the lighting computation. Both the primary and secondary current colors are
+ applied to each fragment, regardless of the state of "
+ (code "GL_COLOR_SUM")
+ ",
+ under such conditions. When "
+ (code "GL_SEPARATE_SPECULAR_COLOR")
+ " is specified,
+ the value returned from querying the current secondary color is undefined. ")
+ (para (code "glSecondaryColor3b")
+ ", "
+ (code "glSecondaryColor3s")
+ ", and "
+ (code "glSecondaryColor3i")
+ " take three signed byte, short, or long integers as
+ arguments. When "
+ (strong "v")
+ " is appended to the name, the color commands can
+ take a pointer to an array of such values. ")
+ (para "
+Color values are stored in floating-point format, with
+ unspecified mantissa and exponent sizes. Unsigned integer color
+ components, when specified, are linearly mapped to floating-point values
+ such that the largest representable value maps to 1.0 (full intensity), and
+ 0 maps to 0.0 (zero intensity). Signed integer color components, when
+ specified, are linearly mapped to floating-point values such that the most
+ positive representable value maps to 1.0, and the most negative
+ representable value maps to "
+ (math "-1.0")
+ ".
+ (Note that this mapping does not convert
+ 0 precisely to 0.0). Floating-point values are mapped directly. ")
+ (para "
+Neither floating-point nor signed integer values are clamped to the range "
+ (math "[" "0" "," "1" "]")
+ "
+before the current color is updated. However, color components are
+ clamped to this range before they are interpolated or written into a color
+ buffer. ")))
+
+(define-gl-procedure
+ glSelectBuffer
+ "glSelectBuffer"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glSelectBuffer"))
+ (paramdef "GLsizei " (parameter "size"))
+ (paramdef "GLuint * " (parameter "buffer"))))
+ '(*fragment*
+ (heading
+ "establish a buffer for selection mode values")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "size")))
+ (para "
+Specifies the size of "
+ (var "buffer")
+ ". "))
+ (entry (% (heading (var "buffer")))
+ (para "
+Returns the selection data. ")))
+ (heading "Description")
+ (para (code "glSelectBuffer")
+ " has two arguments: "
+ (var "buffer")
+ " is a pointer to an array of unsigned integers,
+ and "
+ (var "size")
+ " indicates the size of the array. "
+ (var "buffer")
+ " returns values from the name stack
+ (see "
+ (code "glInitNames")
+ ", "
+ (code "glLoadName")
+ ", "
+ (code "glPushName")
+ ")
+ when the rendering mode is "
+ (code "GL_SELECT")
+ " (see "
+ (code "glRenderMode")
+ "). "
+ (code "glSelectBuffer")
+ " must be issued before selection mode is enabled,
+ and it must not be issued while the rendering mode is "
+ (code "GL_SELECT")
+ ". ")
+ (para "
+A programmer can use selection to determine which primitives
+ are drawn into some region of a window.
+ The region is defined by the current modelview and perspective matrices. ")
+ (para "
+In selection mode, no pixel fragments are produced from rasterization.
+ Instead,
+ if a primitive or a raster position intersects the clipping
+ volume defined by the viewing frustum
+ and the user-defined clipping planes,
+ this primitive causes a selection hit.
+ (With polygons, no hit occurs if the polygon is culled.)
+ When a change is made to the name stack,
+ or when "
+ (code "glRenderMode")
+ " is called,
+ a hit record is copied to "
+ (var "buffer")
+ " if any hits have occurred since the
+ last such event
+ (name stack change or "
+ (code "glRenderMode")
+ " call).
+ The hit record consists of the number of names in the name stack at the
+ time of the event, followed by the minimum and maximum depth values
+ of all vertices that hit since the previous event,
+ followed by the name stack contents,
+ bottom name first. ")
+ (para "
+Depth values (which are in the range [0,1]) are multiplied by "
+ (math "2" "^" "32" "-" "1")
+ ",
+ before being placed in the hit record. ")
+ (para "
+An internal index into "
+ (var "buffer")
+ " is reset to 0 whenever selection mode
+ is entered.
+ Each time a hit record is copied into "
+ (var "buffer")
+ ",
+ the index is incremented to point to the cell just past the end
+ of the block of names\\(emthat is, to the next available cell
+ If the hit record is larger than the number of remaining locations in "
+ (var "buffer")
+ ",
+ as much data as can fit is copied,
+ and the overflow flag is set.
+ If the name stack is empty when a hit record is copied,
+ that record consists of 0 followed by the minimum and maximum depth values. ")
+ (para "
+To exit selection mode, call "
+ (code "glRenderMode")
+ " with an argument
+ other than "
+ (code "GL_SELECT")
+ ".
+ Whenever "
+ (code "glRenderMode")
+ " is called while the render mode is "
+ (code "GL_SELECT")
+ ",
+ it returns the number of hit records copied to "
+ (var "buffer")
+ ",
+ resets the overflow flag and the selection buffer pointer,
+ and initializes the name stack to be empty.
+ If the overflow bit was set when "
+ (code "glRenderMode")
+ " was called,
+ a negative hit record count is returned. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "size")
+ " is negative. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glSelectBuffer")
+ " is called while the
+ render mode is "
+ (code "GL_SELECT")
+ ",
+ or if "
+ (code "glRenderMode")
+ " is called with argument "
+ (code "GL_SELECT")
+ " before "
+ (code "glSelectBuffer")
+ " is called at least once. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glSelectBuffer")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glSeparableFilter2D
+ "glSeparableFilter2D"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "void "
+ (function "glSeparableFilter2D"))
+ (paramdef "GLenum " (parameter "target"))
+ (paramdef "GLenum " (parameter "internalformat"))
+ (paramdef "GLsizei " (parameter "width"))
+ (paramdef "GLsizei " (parameter "height"))
+ (paramdef "GLenum " (parameter "format"))
+ (paramdef "GLenum " (parameter "type"))
+ (paramdef "const GLvoid * " (parameter "row"))
+ (paramdef "const GLvoid * " (parameter "column"))))
+ '(*fragment*
+ (heading
+ "define a separable two-dimensional convolution filter")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "target")))
+ (para "
+Must be " (code "GL_SEPARABLE_2D") ". "))
+ (entry (% (heading (var "internalformat")))
+ (para "
+The internal format of the convolution filter kernel.
+ The allowable values are "
+ (code "GL_ALPHA")
+ ", "
+ (code "GL_ALPHA4")
+ ", "
+ (code "GL_ALPHA8")
+ ", "
+ (code "GL_ALPHA12")
+ ", "
+ (code "GL_ALPHA16")
+ ", "
+ (code "GL_LUMINANCE")
+ ", "
+ (code "GL_LUMINANCE4")
+ ", "
+ (code "GL_LUMINANCE8")
+ ", "
+ (code "GL_LUMINANCE12")
+ ", "
+ (code "GL_LUMINANCE16")
+ ", "
+ (code "GL_LUMINANCE_ALPHA")
+ ", "
+ (code "GL_LUMINANCE4_ALPHA4")
+ ", "
+ (code "GL_LUMINANCE6_ALPHA2")
+ ", "
+ (code "GL_LUMINANCE8_ALPHA8")
+ ", "
+ (code "GL_LUMINANCE12_ALPHA4")
+ ", "
+ (code "GL_LUMINANCE12_ALPHA12")
+ ", "
+ (code "GL_LUMINANCE16_ALPHA16")
+ ", "
+ (code "GL_INTENSITY")
+ ", "
+ (code "GL_INTENSITY4")
+ ", "
+ (code "GL_INTENSITY8")
+ ", "
+ (code "GL_INTENSITY12")
+ ", "
+ (code "GL_INTENSITY16")
+ ", "
+ (code "GL_R3_G3_B2")
+ ", "
+ (code "GL_RGB")
+ ", "
+ (code "GL_RGB4")
+ ", "
+ (code "GL_RGB5")
+ ", "
+ (code "GL_RGB8")
+ ", "
+ (code "GL_RGB10")
+ ", "
+ (code "GL_RGB12")
+ ", "
+ (code "GL_RGB16")
+ ", "
+ (code "GL_RGBA")
+ ", "
+ (code "GL_RGBA2")
+ ", "
+ (code "GL_RGBA4")
+ ", "
+ (code "GL_RGB5_A1")
+ ", "
+ (code "GL_RGBA8")
+ ", "
+ (code "GL_RGB10_A2")
+ ", "
+ (code "GL_RGBA12")
+ ", or "
+ (code "GL_RGBA16")
+ ". "))
+ (entry (% (heading (var "width")))
+ (para "
+The number of elements in the pixel array referenced by "
+ (var "row")
+ ".
+ (This is the width of the separable filter kernel.) "))
+ (entry (% (heading (var "height")))
+ (para "
+The number of elements in the pixel array referenced by "
+ (var "column")
+ ".
+ (This is the height of the separable filter kernel.) "))
+ (entry (% (heading (var "format")))
+ (para "
+The format of the pixel data in "
+ (var "row")
+ " and "
+ (var "column")
+ ".
+ The allowable values are "
+ (code "GL_RED")
+ ", "
+ (code "GL_GREEN")
+ ", "
+ (code "GL_BLUE")
+ ", "
+ (code "GL_ALPHA")
+ ", "
+ (code "GL_RGB")
+ ", "
+ (code "GL_BGR")
+ ", "
+ (code "GL_RGBA")
+ ", "
+ (code "GL_BGRA")
+ ", "
+ (code "GL_INTENSITY")
+ ", "
+ (code "GL_LUMINANCE")
+ ", and "
+ (code "GL_LUMINANCE_ALPHA")
+ ". "))
+ (entry (% (heading (var "type")))
+ (para "
+The type of the pixel data in "
+ (var "row")
+ " and "
+ (var "column")
+ ".
+ Symbolic constants "
+ (code "GL_UNSIGNED_BYTE")
+ ", "
+ (code "GL_BYTE")
+ ", "
+ (code "GL_BITMAP")
+ ", "
+ (code "GL_UNSIGNED_SHORT")
+ ", "
+ (code "GL_SHORT")
+ ", "
+ (code "GL_UNSIGNED_INT")
+ ", "
+ (code "GL_INT")
+ ", "
+ (code "GL_FLOAT")
+ ", "
+ (code "GL_UNSIGNED_BYTE_3_3_2")
+ ", "
+ (code "GL_UNSIGNED_BYTE_2_3_3_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_6_5")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_6_5_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_4_4_4_4")
+ ", "
+ (code "GL_UNSIGNED_SHORT_4_4_4_4_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_5_5_1")
+ ", "
+ (code "GL_UNSIGNED_SHORT_1_5_5_5_REV")
+ ", "
+ (code "GL_UNSIGNED_INT_8_8_8_8")
+ ", "
+ (code "GL_UNSIGNED_INT_8_8_8_8_REV")
+ ", "
+ (code "GL_UNSIGNED_INT_10_10_10_2")
+ ", and "
+ (code "GL_UNSIGNED_INT_2_10_10_10_REV")
+ "
+are accepted. "))
+ (entry (% (heading (var "row")))
+ (para "
+Pointer to a one-dimensional array of pixel data that is processed to
+ build the row filter kernel. "))
+ (entry (% (heading (var "column")))
+ (para "
+Pointer to a one-dimensional array of pixel data that is processed to
+ build the column filter kernel. ")))
+ (heading "Description")
+ (para (code "glSeparableFilter2D")
+ " builds a two-dimensional separable convolution filter kernel from
+ two arrays of pixels. ")
+ (para "
+The pixel arrays specified by ("
+ (var "width")
+ ", "
+ (var "format")
+ ", "
+ (var "type")
+ ", "
+ (var "row")
+ ")
+ and ("
+ (var "height")
+ ", "
+ (var "format")
+ ", "
+ (var "type")
+ ", "
+ (var "column")
+ ") are processed just as if
+ they had been passed to "
+ (code "glDrawPixels")
+ ",
+ but processing stops after the final expansion to RGBA is completed. ")
+ (para "
+If a non-zero named buffer object is bound to the "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ " target
+ (see "
+ (code "glBindBuffer")
+ ") while a convolution filter is
+ specified, "
+ (var "row")
+ " and "
+ (var "column")
+ " are treated as byte offsets into the buffer object's data store. ")
+ (para "
+Next, the R, G, B, and A components of all pixels in both arrays are scaled
+ by the four separable 2D "
+ (code "GL_CONVOLUTION_FILTER_SCALE")
+ " parameters and
+ biased by the four separable 2D "
+ (code "GL_CONVOLUTION_FILTER_BIAS")
+ " parameters.
+ (The scale and bias parameters are set by "
+ (code "glConvolutionParameter")
+ "
+using the "
+ (code "GL_SEPARABLE_2D")
+ " target and the names "
+ (code "GL_CONVOLUTION_FILTER_SCALE")
+ " and "
+ (code "GL_CONVOLUTION_FILTER_BIAS")
+ ".
+ The parameters themselves are vectors of four values that are applied to red,
+ green, blue, and alpha, in that order.)
+ The R, G, B, and A values are not clamped to [0,1] at any time during this
+ process. ")
+ (para "
+Each pixel is then converted to the internal format specified by "
+ (var "internalformat")
+ ".
+ This conversion simply maps the component values of the pixel (R, G, B,
+ and A) to the values included in the internal format (red, green, blue,
+ alpha, luminance, and intensity). The mapping is as follows: ")
+ (table (% (formatter (asis)))
+ (entry (% (heading (strong "Internal Format")))
+ (para (strong "Red")
+ ", "
+ (strong "Green")
+ ", "
+ (strong "Blue")
+ ", "
+ (strong "Alpha")
+ ", "
+ (strong "Luminance")
+ ", "
+ (strong "Intensity")))
+ (entry (% (heading (code "GL_LUMINANCE")))
+ (para ", " ", " ", " ", " "
+R " ", "))
+ (entry (% (heading (code "GL_LUMINANCE_ALPHA")))
+ (para ", " ", " ", " "
+A " ", " "
+R " ", "))
+ (entry (% (heading (code "GL_INTENSITY")))
+ (para ", " ", " ", " ", " ", " "
+R "))
+ (entry (% (heading (code "GL_RGB")))
+ (para "
+R " ", " "
+G " ", " "
+B " ", " ", " ", "))
+ (entry (% (heading (code "GL_RGBA")))
+ (para "
+R "
+ ", "
+ "
+G "
+ ", "
+ "
+B "
+ ", "
+ "
+A "
+ ", "
+ ", ")))
+ (para "
+The red, green, blue, alpha, luminance, and/or intensity components of
+ the resulting pixels are stored in floating-point rather than integer
+ format.
+ They form two one-dimensional filter kernel images.
+ The row image is indexed by coordinate "
+ (var "i")
+ " starting at zero and
+ increasing from left to right.
+ Each location in the row image is derived from element "
+ (var "i")
+ " of "
+ (var "row")
+ ".
+ The column image is indexed by coordinate "
+ (var "j")
+ " starting at zero
+ and increasing from bottom to top.
+ Each location in the column image is derived from element "
+ (var "j")
+ " of "
+ (var "column")
+ ". ")
+ (para "
+Note that after a convolution is performed, the resulting color
+ components are also scaled by their corresponding "
+ (code "GL_POST_CONVOLUTION_c_SCALE")
+ " parameters and biased by their
+ corresponding "
+ (code "GL_POST_CONVOLUTION_c_BIAS")
+ " parameters (where "
+ (var "c")
+ " takes on the values "
+ (strong "RED")
+ ", "
+ (strong "GREEN")
+ ", "
+ (strong "BLUE")
+ ", and "
+ (strong "ALPHA")
+ ").
+ These parameters are set by "
+ (code "glPixelTransfer")
+ ". ")
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "target")
+ " is not "
+ (code "GL_SEPARABLE_2D")
+ ". ")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "internalformat")
+ " is not one of the
+ allowable values. ")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "format")
+ " is not one of the allowable
+ values. ")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "type")
+ " is not one of the allowable
+ values. ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "width")
+ " is less than zero or greater
+ than the maximum supported value.
+ This value may be queried with "
+ (code "glGetConvolutionParameter")
+ "
+using target "
+ (code "GL_SEPARABLE_2D")
+ " and name "
+ (code "GL_MAX_CONVOLUTION_WIDTH")
+ ". ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "height")
+ " is less than zero or greater
+ than the maximum supported value.
+ This value may be queried with "
+ (code "glGetConvolutionParameter")
+ "
+using target "
+ (code "GL_SEPARABLE_2D")
+ " and name "
+ (code "GL_MAX_CONVOLUTION_HEIGHT")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (var "height")
+ " is one of "
+ (code "GL_UNSIGNED_BYTE_3_3_2")
+ ", "
+ (code "GL_UNSIGNED_BYTE_2_3_3_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_6_5")
+ ", or "
+ (code "GL_UNSIGNED_SHORT_5_6_5_REV")
+ "
+and "
+ (var "format")
+ " is not "
+ (code "GL_RGB")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (var "height")
+ " is one of "
+ (code "GL_UNSIGNED_SHORT_4_4_4_4")
+ ", "
+ (code "GL_UNSIGNED_SHORT_4_4_4_4_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_5_5_1")
+ ", "
+ (code "GL_UNSIGNED_SHORT_1_5_5_5_REV")
+ ", "
+ (code "GL_UNSIGNED_INT_8_8_8_8")
+ ", "
+ (code "GL_UNSIGNED_INT_8_8_8_8_REV")
+ ", "
+ (code "GL_UNSIGNED_INT_10_10_10_2")
+ ", or "
+ (code "GL_UNSIGNED_INT_2_10_10_10_REV")
+ "
+and "
+ (var "format")
+ " is neither "
+ (code "GL_RGBA")
+ " nor "
+ (code "GL_BGRA")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a non-zero buffer object name is bound to the "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ " target and the buffer object's data store is currently mapped. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a non-zero buffer object name is bound to the "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ " target and the data would be unpacked from the buffer
+ object such that the memory reads required would exceed the data store size. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a non-zero buffer object name is bound to the "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ " target and "
+ (var "row")
+ " or "
+ (var "column")
+ " is not evenly divisible
+ into the number of bytes needed to store in memory a datum indicated by "
+ (var "type")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glSeparableFilter2D")
+ " is executed
+ between the execution of "
+ (code "glBegin")
+ " and the corresponding
+ execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glShadeModel
+ "glShadeModel"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glShadeModel"))
+ (paramdef "GLenum " (parameter "mode"))))
+ '(*fragment*
+ (heading "select flat or smooth shading")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "mode")))
+ (para "
+Specifies a symbolic value representing a shading technique.
+ Accepted values are "
+ (code "GL_FLAT")
+ " and "
+ (code "GL_SMOOTH")
+ ".
+ The initial value is "
+ (code "GL_SMOOTH")
+ ". ")))
+ (heading "Description")
+ (para "
+GL primitives can have either flat or smooth shading.
+ Smooth shading,
+ the default,
+ causes the computed colors of vertices to be interpolated as the
+ primitive is rasterized,
+ typically assigning different colors to each resulting pixel fragment.
+ Flat shading selects the computed color of just one vertex
+ and assigns it to all the pixel fragments
+ generated by rasterizing a single primitive.
+ In either case, the computed color of a vertex is the result of
+ lighting if lighting is enabled,
+ or it is the current color at the time the vertex was specified if
+ lighting is disabled. ")
+ (para "
+Flat and smooth shading are indistinguishable for points.
+ Starting when "
+ (code "glBegin")
+ " is issued and counting vertices and
+ primitives from 1, the GL gives each flat-shaded line segment "
+ (math (var "i"))
+ "
+the
+ computed color of vertex "
+ (math (var "i") "+" "1")
+ ",
+ its second vertex.
+ Counting similarly from 1,
+ the GL gives each flat-shaded polygon the computed color of the vertex listed
+ in the following table.
+ This is the last vertex to specify the polygon in all cases except single
+ polygons,
+ where the first vertex specifies the flat-shaded color. ")
+ (para)
+ (table (% (formatter (asis)))
+ (entry (% (heading
+ (strong
+ "
+Primitive Type of Polygon "
+ (math (var "i")))))
+ (para (strong "Vertex")))
+ (entry (% (heading
+ "
+Single polygon
+ ("
+ (math (var "i") "==" "1")
+ ") "))
+ (para "
+1 "))
+ (entry (% (heading "
+Triangle strip "))
+ (para (math (var "i") "+" "2")))
+ (entry (% (heading "
+Triangle fan "))
+ (para (math (var "i") "+" "2")))
+ (entry (% (heading "
+Independent triangle "))
+ (para (math "3" "\u2062" (var "i"))))
+ (entry (% (heading "
+Quad strip "))
+ (para (math "2" "\u2062" (var "i") "+" "2")))
+ (entry (% (heading "
+Independent quad "))
+ (para (math "4" "\u2062" (var "i")))))
+ (para "
+Flat and smooth shading are specified by "
+ (code "glShadeModel")
+ " with "
+ (var "mode")
+ " set to "
+ (code "GL_FLAT")
+ " and "
+ (code "GL_SMOOTH")
+ ", respectively. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "mode")
+ " is any value other than "
+ (code "GL_FLAT")
+ " or "
+ (code "GL_SMOOTH")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glShadeModel")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glShaderSource
+ "glShaderSource"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glShaderSource"))
+ (paramdef "GLuint " (parameter "shader"))
+ (paramdef "GLsizei " (parameter "count"))
+ (paramdef "const GLchar **" (parameter "string"))
+ (paramdef "const GLint *" (parameter "length"))))
+ '(*fragment*
+ (heading
+ "Replaces the source code in a shader object")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "shader")))
+ (para "Specifies the handle of the shader object
+\t\t whose source code is to be replaced."))
+ (entry (% (heading (var "count")))
+ (para "Specifies the number of elements in the "
+ (var "string")
+ " and "
+ (var "length")
+ "
+arrays."))
+ (entry (% (heading (var "string")))
+ (para "Specifies an array of pointers to strings
+\t\t containing the source code to be loaded into the
+\t\t shader."))
+ (entry (% (heading (var "length")))
+ (para "Specifies an array of string lengths.")))
+ (heading "Description")
+ (para (code "glShaderSource")
+ " sets the source code
+\tin "
+ (var "shader")
+ " to the source code in the array
+\tof strings specified by "
+ (var "string")
+ ". Any
+\tsource code previously stored in the shader object is completely
+\treplaced. The number of strings in the array is specified by\t"
+ (var "count")
+ ". If "
+ (var "length")
+ "
+is "
+ (code "NULL")
+ ", each string is assumed to be null
+\tterminated. If "
+ (var "length")
+ " is a value other
+\tthan "
+ (code "NULL")
+ ", it points to an array containing
+\ta string length for each of the corresponding elements of\t"
+ (var "string")
+ ". Each element in the\t"
+ (var "length")
+ " array may contain the length of
+\tthe corresponding string (the null character is not counted as
+\tpart of the string length) or a value less than 0 to indicate
+\tthat the string is null terminated. The source code strings are
+\tnot scanned or parsed at this time; they are simply copied into
+\tthe specified shader object.")
+ (heading "Errors")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if\t"
+ (var "shader")
+ " is not a value generated by
+\tOpenGL.")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if\t"
+ (var "shader")
+ " is not a shader object.")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if\t"
+ (var "count")
+ " is less than 0.")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if\t"
+ (code "glShaderSource")
+ " is executed between the
+\texecution of\t"
+ (code "glBegin")
+ "
+and the corresponding execution of\t"
+ (code "glEnd")
+ ".")))
+
+(define-gl-procedure
+ glStencilFuncSeparate
+ "glStencilFuncSeparate"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "void "
+ (function "glStencilFuncSeparate"))
+ (paramdef "GLenum " (parameter "face"))
+ (paramdef "GLenum " (parameter "func"))
+ (paramdef "GLint " (parameter "ref"))
+ (paramdef "GLuint " (parameter "mask"))))
+ '(*fragment*
+ (heading
+ "set front and/or back function and reference value for stencil testing")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "face")))
+ (para "
+Specifies whether front and/or back stencil state is updated.
+ Three symbolic constants are valid: "
+ (code "GL_FRONT")
+ ", "
+ (code "GL_BACK")
+ ", and "
+ (code "GL_FRONT_AND_BACK")
+ ". "))
+ (entry (% (heading (var "func")))
+ (para "
+Specifies the test function.
+ Eight symbolic constants are valid: "
+ (code "GL_NEVER")
+ ", "
+ (code "GL_LESS")
+ ", "
+ (code "GL_LEQUAL")
+ ", "
+ (code "GL_GREATER")
+ ", "
+ (code "GL_GEQUAL")
+ ", "
+ (code "GL_EQUAL")
+ ", "
+ (code "GL_NOTEQUAL")
+ ", and "
+ (code "GL_ALWAYS")
+ ". The initial value is "
+ (code "GL_ALWAYS")
+ ". "))
+ (entry (% (heading (var "ref")))
+ (para "
+Specifies the reference value for the stencil test. "
+ (var "ref")
+ " is clamped to the range "
+ (math "[" "0" "," "2" "^" (var "n") "-" "1" "]")
+ ",
+ where "
+ (math (var "n"))
+ "
+is the number of bitplanes in the stencil buffer. The
+ initial value is 0. "))
+ (entry (% (heading (var "mask")))
+ (para "
+Specifies a mask that is ANDed with both the reference value
+ and the stored stencil value when the test is done. The initial value
+ is all 1's. ")))
+ (heading "Description")
+ (para "
+Stenciling,
+ like depth-buffering,
+ enables and disables drawing on a per-pixel basis.
+ You draw into the stencil planes using GL drawing primitives,
+ then render geometry and images,
+ using the stencil planes to mask out portions of the screen.
+ Stenciling is typically used in multipass rendering algorithms
+ to achieve special effects,
+ such as decals,
+ outlining,
+ and constructive solid geometry rendering. ")
+ (para "
+The stencil test conditionally eliminates a pixel based on the outcome
+ of a comparison between the reference value
+ and the value in the stencil buffer.
+ To enable and disable the test, call "
+ (code "glEnable")
+ " and "
+ (code "glDisable")
+ "
+with argument "
+ (code "GL_STENCIL_TEST")
+ ".
+ To specify actions based on the outcome of the stencil test, call "
+ (code "glStencilOp")
+ " or "
+ (code "glStencilOpSeparate")
+ ". ")
+ (para "
+There can be two separate sets of "
+ (var "func")
+ ", "
+ (var "ref")
+ ", and "
+ (var "mask")
+ " parameters; one affects back-facing polygons, and the other
+ affects front-facing polygons as well as other non-polygon primitives. "
+ (code "glStencilFunc")
+ " sets both front
+ and back stencil state to the same values, as if "
+ (code "glStencilFuncSeparate")
+ " were called
+ with "
+ (var "face")
+ " set to "
+ (code "GL_FRONT_AND_BACK")
+ ". ")
+ (para (var "func")
+ " is a symbolic constant that determines the stencil comparison function.
+ It accepts one of eight values,
+ shown in the following list. "
+ (var "ref")
+ " is an integer reference value that is used in the stencil comparison.
+ It is clamped to the range "
+ (math "[" "0" "," "2" "^" (var "n") "-" "1" "]")
+ ",
+ where "
+ (math (var "n"))
+ "
+is the number of bitplanes in the stencil buffer. "
+ (var "mask")
+ " is bitwise ANDed with both the reference value
+ and the stored stencil value,
+ with the ANDed values participating in the comparison. ")
+ (para "
+If "
+ (var "stencil")
+ " represents the value stored in the corresponding
+ stencil buffer location,
+ the following list shows the effect of each comparison function
+ that can be specified by "
+ (var "func")
+ ".
+ Only if the comparison succeeds is the pixel passed through
+ to the next stage in the rasterization process
+ (see "
+ (code "glStencilOp")
+ ").
+ All tests treat "
+ (var "stencil")
+ " values as unsigned integers in the range "
+ (math "[" "0" "," "2" "^" (var "n") "-" "1" "]")
+ ",
+ where "
+ (math (var "n"))
+ "
+is the number of bitplanes in the stencil buffer. ")
+ (para "
+The following values are accepted by "
+ (var "func")
+ ": ")
+ (table (% (formatter (asis)))
+ (entry (% (heading (code "GL_NEVER")))
+ (para "
+Always fails. "))
+ (entry (% (heading (code "GL_LESS")))
+ (para "
+Passes if ( "
+ (var "ref")
+ " & "
+ (var "mask")
+ " ) < ( "
+ (var "stencil")
+ " & "
+ (var "mask")
+ " ). "))
+ (entry (% (heading (code "GL_LEQUAL")))
+ (para "
+Passes if ( "
+ (var "ref")
+ " & "
+ (var "mask")
+ " ) <= ( "
+ (var "stencil")
+ " & "
+ (var "mask")
+ " ). "))
+ (entry (% (heading (code "GL_GREATER")))
+ (para "
+Passes if ( "
+ (var "ref")
+ " & "
+ (var "mask")
+ " ) > ( "
+ (var "stencil")
+ " & "
+ (var "mask")
+ " ). "))
+ (entry (% (heading (code "GL_GEQUAL")))
+ (para "
+Passes if ( "
+ (var "ref")
+ " & "
+ (var "mask")
+ " ) >= ( "
+ (var "stencil")
+ " & "
+ (var "mask")
+ " ). "))
+ (entry (% (heading (code "GL_EQUAL")))
+ (para "
+Passes if ( "
+ (var "ref")
+ " & "
+ (var "mask")
+ " ) = ( "
+ (var "stencil")
+ " & "
+ (var "mask")
+ " ). "))
+ (entry (% (heading (code "GL_NOTEQUAL")))
+ (para "
+Passes if ( "
+ (var "ref")
+ " & "
+ (var "mask")
+ " ) != ( "
+ (var "stencil")
+ " & "
+ (var "mask")
+ " ). "))
+ (entry (% (heading (code "GL_ALWAYS")))
+ (para "
+Always passes. ")))
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "func")
+ " is not one of the eight
+ accepted values. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glStencilFuncSeparate")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glStencilFunc
+ "glStencilFunc"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glStencilFunc"))
+ (paramdef "GLenum " (parameter "func"))
+ (paramdef "GLint " (parameter "ref"))
+ (paramdef "GLuint " (parameter "mask"))))
+ '(*fragment*
+ (heading
+ "set front and back function and reference value for stencil testing")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "func")))
+ (para "
+Specifies the test function.
+ Eight symbolic constants are valid: "
+ (code "GL_NEVER")
+ ", "
+ (code "GL_LESS")
+ ", "
+ (code "GL_LEQUAL")
+ ", "
+ (code "GL_GREATER")
+ ", "
+ (code "GL_GEQUAL")
+ ", "
+ (code "GL_EQUAL")
+ ", "
+ (code "GL_NOTEQUAL")
+ ", and "
+ (code "GL_ALWAYS")
+ ". The initial value is "
+ (code "GL_ALWAYS")
+ ". "))
+ (entry (% (heading (var "ref")))
+ (para "
+Specifies the reference value for the stencil test. "
+ (var "ref")
+ " is clamped to the range "
+ (math "[" "0" "," "2" "^" (var "n") "-" "1" "]")
+ ",
+ where "
+ (math (var "n"))
+ "
+is the number of bitplanes in the stencil buffer. The
+ initial value is 0. "))
+ (entry (% (heading (var "mask")))
+ (para "
+Specifies a mask that is ANDed with both the reference value
+ and the stored stencil value when the test is done. The initial value
+ is all 1's. ")))
+ (heading "Description")
+ (para "
+Stenciling,
+ like depth-buffering,
+ enables and disables drawing on a per-pixel basis.
+ Stencil planes are first drawn into using GL drawing primitives, then
+ geometry and images are rendered using the stencil planes to mask out
+ portions of the screen.
+ Stenciling is typically used in multipass rendering algorithms
+ to achieve special effects,
+ such as decals,
+ outlining,
+ and constructive solid geometry rendering. ")
+ (para "
+The stencil test conditionally eliminates a pixel based on the outcome
+ of a comparison between the reference value
+ and the value in the stencil buffer.
+ To enable and disable the test, call "
+ (code "glEnable")
+ " and "
+ (code "glDisable")
+ "
+with argument "
+ (code "GL_STENCIL_TEST")
+ ".
+ To specify actions based on the outcome of the stencil test, call "
+ (code "glStencilOp")
+ " or "
+ (code "glStencilOpSeparate")
+ ". ")
+ (para "
+There can be two separate sets of "
+ (var "func")
+ ", "
+ (var "ref")
+ ", and "
+ (var "mask")
+ " parameters; one affects back-facing polygons, and the other
+ affects front-facing polygons as well as other non-polygon primitives. "
+ (code "glStencilFunc")
+ " sets both front
+ and back stencil state to the same values. Use "
+ (code "glStencilFuncSeparate")
+ "
+to set front and back stencil state to different values. ")
+ (para (var "func")
+ " is a symbolic constant that determines the stencil comparison function.
+ It accepts one of eight values,
+ shown in the following list. "
+ (var "ref")
+ " is an integer reference value that is used in the stencil comparison.
+ It is clamped to the range "
+ (math "[" "0" "," "2" "^" (var "n") "-" "1" "]")
+ ",
+ where "
+ (math (var "n"))
+ "
+is the number of bitplanes in the stencil buffer. "
+ (var "mask")
+ " is bitwise ANDed with both the reference value
+ and the stored stencil value,
+ with the ANDed values participating in the comparison. ")
+ (para "
+If "
+ (var "stencil")
+ " represents the value stored in the corresponding
+ stencil buffer location,
+ the following list shows the effect of each comparison function
+ that can be specified by "
+ (var "func")
+ ".
+ Only if the comparison succeeds is the pixel passed through
+ to the next stage in the rasterization process
+ (see "
+ (code "glStencilOp")
+ ").
+ All tests treat "
+ (var "stencil")
+ " values as unsigned integers in the range "
+ (math "[" "0" "," "2" "^" (var "n") "-" "1" "]")
+ ",
+ where "
+ (math (var "n"))
+ "
+is the number of bitplanes in the stencil buffer. ")
+ (para "
+The following values are accepted by "
+ (var "func")
+ ": ")
+ (table (% (formatter (asis)))
+ (entry (% (heading (code "GL_NEVER")))
+ (para "
+Always fails. "))
+ (entry (% (heading (code "GL_LESS")))
+ (para "
+Passes if ( "
+ (var "ref")
+ " & "
+ (var "mask")
+ " ) < ( "
+ (var "stencil")
+ " & "
+ (var "mask")
+ " ). "))
+ (entry (% (heading (code "GL_LEQUAL")))
+ (para "
+Passes if ( "
+ (var "ref")
+ " & "
+ (var "mask")
+ " ) <= ( "
+ (var "stencil")
+ " & "
+ (var "mask")
+ " ). "))
+ (entry (% (heading (code "GL_GREATER")))
+ (para "
+Passes if ( "
+ (var "ref")
+ " & "
+ (var "mask")
+ " ) > ( "
+ (var "stencil")
+ " & "
+ (var "mask")
+ " ). "))
+ (entry (% (heading (code "GL_GEQUAL")))
+ (para "
+Passes if ( "
+ (var "ref")
+ " & "
+ (var "mask")
+ " ) >= ( "
+ (var "stencil")
+ " & "
+ (var "mask")
+ " ). "))
+ (entry (% (heading (code "GL_EQUAL")))
+ (para "
+Passes if ( "
+ (var "ref")
+ " & "
+ (var "mask")
+ " ) = ( "
+ (var "stencil")
+ " & "
+ (var "mask")
+ " ). "))
+ (entry (% (heading (code "GL_NOTEQUAL")))
+ (para "
+Passes if ( "
+ (var "ref")
+ " & "
+ (var "mask")
+ " ) != ( "
+ (var "stencil")
+ " & "
+ (var "mask")
+ " ). "))
+ (entry (% (heading (code "GL_ALWAYS")))
+ (para "
+Always passes. ")))
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "func")
+ " is not one of the eight
+ accepted values. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glStencilFunc")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glStencilMaskSeparate
+ "glStencilMaskSeparate"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "void "
+ (function "glStencilMaskSeparate"))
+ (paramdef "GLenum " (parameter "face"))
+ (paramdef "GLuint " (parameter "mask"))))
+ '(*fragment*
+ (heading
+ "control the front and/or back writing of individual bits in the stencil planes")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "face")))
+ (para "
+Specifies whether the front and/or back stencil writemask is updated.
+ Three symbolic constants are valid: "
+ (code "GL_FRONT")
+ ", "
+ (code "GL_BACK")
+ ", and "
+ (code "GL_FRONT_AND_BACK")
+ ". "))
+ (entry (% (heading (var "mask")))
+ (para "
+Specifies a bit mask to enable and disable writing of individual bits
+ in the stencil planes.
+ Initially, the mask is all 1's. ")))
+ (heading "Description")
+ (para (code "glStencilMaskSeparate")
+ " controls the writing of individual bits in the stencil planes.
+ The least significant "
+ (math (var "n"))
+ "
+bits of "
+ (var "mask")
+ ",
+ where "
+ (math (var "n"))
+ "
+is the number of bits in the stencil buffer,
+ specify a mask.
+ Where a 1 appears in the mask,
+ it's possible to write to the corresponding bit in the stencil buffer.
+ Where a 0 appears,
+ the corresponding bit is write-protected.
+ Initially, all bits are enabled for writing. ")
+ (para "
+There can be two separate "
+ (var "mask")
+ " writemasks; one affects back-facing polygons, and the other
+ affects front-facing polygons as well as other non-polygon primitives. "
+ (code "glStencilMask")
+ " sets both front
+ and back stencil writemasks to the same values, as if "
+ (code "glStencilMaskSeparate")
+ " were called
+ with "
+ (var "face")
+ " set to "
+ (code "GL_FRONT_AND_BACK")
+ ". ")
+ (heading "Errors")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glStencilMaskSeparate")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glStencilMask
+ "glStencilMask"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glStencilMask"))
+ (paramdef "GLuint " (parameter "mask"))))
+ '(*fragment*
+ (heading
+ "control the front and back writing of individual bits in the stencil planes")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "mask")))
+ (para "
+Specifies a bit mask to enable and disable writing of individual bits
+ in the stencil planes.
+ Initially, the mask is all 1's. ")))
+ (heading "Description")
+ (para (code "glStencilMask")
+ " controls the writing of individual bits in the stencil planes.
+ The least significant "
+ (math (var "n"))
+ "
+bits of "
+ (var "mask")
+ ",
+ where "
+ (math (var "n"))
+ "
+is the number of bits in the stencil buffer,
+ specify a mask.
+ Where a 1 appears in the mask,
+ it's possible to write to the corresponding bit in the stencil buffer.
+ Where a 0 appears,
+ the corresponding bit is write-protected.
+ Initially, all bits are enabled for writing. ")
+ (para "
+There can be two separate "
+ (var "mask")
+ " writemasks; one affects back-facing polygons, and the other
+ affects front-facing polygons as well as other non-polygon primitives. "
+ (code "glStencilMask")
+ " sets both front
+ and back stencil writemasks to the same values. Use "
+ (code "glStencilMaskSeparate")
+ "
+to set front and back stencil writemasks to different values. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glStencilMask")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glStencilOpSeparate
+ "glStencilOpSeparate"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "void "
+ (function "glStencilOpSeparate"))
+ (paramdef "GLenum " (parameter "face"))
+ (paramdef "GLenum " (parameter "sfail"))
+ (paramdef "GLenum " (parameter "dpfail"))
+ (paramdef "GLenum " (parameter "dppass"))))
+ '(*fragment*
+ (heading
+ "set front and/or back stencil test actions")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "face")))
+ (para "
+Specifies whether front and/or back stencil state is updated.
+ Three symbolic constants are valid: "
+ (code "GL_FRONT")
+ ", "
+ (code "GL_BACK")
+ ", and "
+ (code "GL_FRONT_AND_BACK")
+ ". "))
+ (entry (% (heading (var "sfail")))
+ (para "
+Specifies the action to take when the stencil test fails.
+ Eight symbolic constants are accepted: "
+ (code "GL_KEEP")
+ ", "
+ (code "GL_ZERO")
+ ", "
+ (code "GL_REPLACE")
+ ", "
+ (code "GL_INCR")
+ ", "
+ (code "GL_INCR_WRAP")
+ ", "
+ (code "GL_DECR")
+ ", "
+ (code "GL_DECR_WRAP")
+ ", and "
+ (code "GL_INVERT")
+ ". The initial value is "
+ (code "GL_KEEP")
+ ". "))
+ (entry (% (heading (var "dpfail")))
+ (para "
+Specifies the stencil action when the stencil test passes,
+ but the depth test fails. "
+ (var "dpfail")
+ " accepts the same symbolic constants as "
+ (var "sfail")
+ ". The initial value
+ is "
+ (code "GL_KEEP")
+ ". "))
+ (entry (% (heading (var "dppass")))
+ (para "
+Specifies the stencil action when both the stencil test and the depth
+ test pass, or when the stencil test passes and either there is no
+ depth buffer or depth testing is not enabled. "
+ (var "dppass")
+ " accepts the same symbolic constants as "
+ (var "sfail")
+ ". The initial value
+ is "
+ (code "GL_KEEP")
+ ". ")))
+ (heading "Description")
+ (para "
+Stenciling,
+ like depth-buffering,
+ enables and disables drawing on a per-pixel basis.
+ You draw into the stencil planes using GL drawing primitives,
+ then render geometry and images,
+ using the stencil planes to mask out portions of the screen.
+ Stenciling is typically used in multipass rendering algorithms
+ to achieve special effects,
+ such as decals,
+ outlining,
+ and constructive solid geometry rendering. ")
+ (para "
+The stencil test conditionally eliminates a pixel based on the outcome
+ of a comparison between the value in the stencil buffer and a
+ reference value. To enable and disable the test, call "
+ (code "glEnable")
+ "
+and "
+ (code "glDisable")
+ " with argument "
+ (code "GL_STENCIL_TEST")
+ "; to control it, call "
+ (code "glStencilFunc")
+ " or "
+ (code "glStencilFuncSeparate")
+ ". ")
+ (para "
+There can be two separate sets of "
+ (var "sfail")
+ ", "
+ (var "dpfail")
+ ", and "
+ (var "dppass")
+ " parameters; one affects back-facing polygons, and the other
+ affects front-facing polygons as well as other non-polygon primitives. "
+ (code "glStencilOp")
+ " sets both front
+ and back stencil state to the same values, as if "
+ (code "glStencilOpSeparate")
+ " were called
+ with "
+ (var "face")
+ " set to "
+ (code "GL_FRONT_AND_BACK")
+ ". ")
+ (para (code "glStencilOpSeparate")
+ " takes three arguments that indicate what happens
+ to the stored stencil value while stenciling is enabled.
+ If the stencil test fails,
+ no change is made to the pixel's color or depth buffers,
+ and "
+ (var "sfail")
+ " specifies what happens to the stencil buffer contents.
+ The following eight actions are possible. ")
+ (table (% (formatter (asis)))
+ (entry (% (heading (code "GL_KEEP")))
+ (para "
+Keeps the current value. "))
+ (entry (% (heading (code "GL_ZERO")))
+ (para "
+Sets the stencil buffer value to 0. "))
+ (entry (% (heading (code "GL_REPLACE")))
+ (para "
+Sets the stencil buffer value to "
+ (var "ref")
+ ",
+ as specified by "
+ (code "glStencilFunc")
+ ". "))
+ (entry (% (heading (code "GL_INCR")))
+ (para "
+Increments the current stencil buffer value.
+ Clamps to the maximum representable unsigned value. "))
+ (entry (% (heading (code "GL_INCR_WRAP")))
+ (para "
+Increments the current stencil buffer value.
+ Wraps stencil buffer value to zero when incrementing the maximum
+ representable unsigned value. "))
+ (entry (% (heading (code "GL_DECR")))
+ (para "
+Decrements the current stencil buffer value.
+ Clamps to 0. "))
+ (entry (% (heading (code "GL_DECR_WRAP")))
+ (para "
+Decrements the current stencil buffer value.
+ Wraps stencil buffer value to the maximum representable unsigned value when
+ decrementing a stencil buffer value of zero. "))
+ (entry (% (heading (code "GL_INVERT")))
+ (para "
+Bitwise inverts the current stencil buffer value. ")))
+ (para "
+Stencil buffer values are treated as unsigned integers.
+ When incremented and decremented,
+ values are clamped to 0 and "
+ (math "2" "^" (var "n") "-" "1")
+ ",
+ where "
+ (math (var "n"))
+ "
+is the value returned by querying "
+ (code "GL_STENCIL_BITS")
+ ". ")
+ (para "
+The other two arguments to "
+ (code "glStencilOpSeparate")
+ " specify stencil buffer actions
+ that depend on whether subsequent depth buffer tests succeed ("
+ (var "dppass")
+ ")
+ or fail ("
+ (var "dpfail")
+ ") (see "
+ (code "glDepthFunc")
+ ").
+ The actions are specified using the same eight symbolic constants as "
+ (var "sfail")
+ ".
+ Note that "
+ (var "dpfail")
+ " is ignored when there is no depth buffer,
+ or when the depth buffer is not enabled.
+ In these cases, "
+ (var "sfail")
+ " and "
+ (var "dppass")
+ " specify stencil action when the
+ stencil test fails and passes,
+ respectively. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "face")
+ " is any value
+ other than "
+ (code "GL_FRONT")
+ ", "
+ (code "GL_BACK")
+ ", or "
+ (code "GL_FRONT_AND_BACK")
+ ". ")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "sfail")
+ ", "
+ (var "dpfail")
+ ", or "
+ (var "dppass")
+ " is any value other than the eight defined constant values. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glStencilOpSeparate")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glStencilOp
+ "glStencilOp"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glStencilOp"))
+ (paramdef "GLenum " (parameter "sfail"))
+ (paramdef "GLenum " (parameter "dpfail"))
+ (paramdef "GLenum " (parameter "dppass"))))
+ '(*fragment*
+ (heading
+ "set front and back stencil test actions")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "sfail")))
+ (para "
+Specifies the action to take when the stencil test fails.
+ Eight symbolic constants are accepted: "
+ (code "GL_KEEP")
+ ", "
+ (code "GL_ZERO")
+ ", "
+ (code "GL_REPLACE")
+ ", "
+ (code "GL_INCR")
+ ", "
+ (code "GL_INCR_WRAP")
+ ", "
+ (code "GL_DECR")
+ ", "
+ (code "GL_DECR_WRAP")
+ ", and "
+ (code "GL_INVERT")
+ ". The initial value is "
+ (code "GL_KEEP")
+ ". "))
+ (entry (% (heading (var "dpfail")))
+ (para "
+Specifies the stencil action when the stencil test passes,
+ but the depth test fails. "
+ (var "dpfail")
+ " accepts the same symbolic constants as "
+ (var "sfail")
+ ". The initial value
+ is "
+ (code "GL_KEEP")
+ ". "))
+ (entry (% (heading (var "dppass")))
+ (para "
+Specifies the stencil action when both the stencil test and the depth
+ test pass, or when the stencil test passes and either there is no
+ depth buffer or depth testing is not enabled. "
+ (var "dppass")
+ " accepts the same symbolic constants as "
+ (var "sfail")
+ ". The initial value
+ is "
+ (code "GL_KEEP")
+ ". ")))
+ (heading "Description")
+ (para "
+Stenciling,
+ like depth-buffering,
+ enables and disables drawing on a per-pixel basis.
+ You draw into the stencil planes using GL drawing primitives,
+ then render geometry and images,
+ using the stencil planes to mask out portions of the screen.
+ Stenciling is typically used in multipass rendering algorithms
+ to achieve special effects,
+ such as decals,
+ outlining,
+ and constructive solid geometry rendering. ")
+ (para "
+The stencil test conditionally eliminates a pixel based on the outcome
+ of a comparison between the value in the stencil buffer and a
+ reference value. To enable and disable the test, call "
+ (code "glEnable")
+ "
+and "
+ (code "glDisable")
+ " with argument "
+ (code "GL_STENCIL_TEST")
+ "; to control it, call "
+ (code "glStencilFunc")
+ " or "
+ (code "glStencilFuncSeparate")
+ ". ")
+ (para "
+There can be two separate sets of "
+ (var "sfail")
+ ", "
+ (var "dpfail")
+ ", and "
+ (var "dppass")
+ " parameters; one affects back-facing polygons, and the other
+ affects front-facing polygons as well as other non-polygon primitives. "
+ (code "glStencilOp")
+ " sets both front
+ and back stencil state to the same values. Use "
+ (code "glStencilOpSeparate")
+ "
+to set front and back stencil state to different values. ")
+ (para (code "glStencilOp")
+ " takes three arguments that indicate what happens
+ to the stored stencil value while stenciling is enabled.
+ If the stencil test fails,
+ no change is made to the pixel's color or depth buffers,
+ and "
+ (var "sfail")
+ " specifies what happens to the stencil buffer contents.
+ The following eight actions are possible. ")
+ (table (% (formatter (asis)))
+ (entry (% (heading (code "GL_KEEP")))
+ (para "
+Keeps the current value. "))
+ (entry (% (heading (code "GL_ZERO")))
+ (para "
+Sets the stencil buffer value to 0. "))
+ (entry (% (heading (code "GL_REPLACE")))
+ (para "
+Sets the stencil buffer value to "
+ (var "ref")
+ ",
+ as specified by "
+ (code "glStencilFunc")
+ ". "))
+ (entry (% (heading (code "GL_INCR")))
+ (para "
+Increments the current stencil buffer value.
+ Clamps to the maximum representable unsigned value. "))
+ (entry (% (heading (code "GL_INCR_WRAP")))
+ (para "
+Increments the current stencil buffer value.
+ Wraps stencil buffer value to zero when incrementing the maximum
+ representable unsigned value. "))
+ (entry (% (heading (code "GL_DECR")))
+ (para "
+Decrements the current stencil buffer value.
+ Clamps to 0. "))
+ (entry (% (heading (code "GL_DECR_WRAP")))
+ (para "
+Decrements the current stencil buffer value.
+ Wraps stencil buffer value to the maximum representable unsigned value when
+ decrementing a stencil buffer value of zero. "))
+ (entry (% (heading (code "GL_INVERT")))
+ (para "
+Bitwise inverts the current stencil buffer value. ")))
+ (para "
+Stencil buffer values are treated as unsigned integers.
+ When incremented and decremented,
+ values are clamped to 0 and "
+ (math "2" "^" (var "n") "-" "1")
+ ",
+ where "
+ (math (var "n"))
+ "
+is the value returned by querying "
+ (code "GL_STENCIL_BITS")
+ ". ")
+ (para "
+The other two arguments to "
+ (code "glStencilOp")
+ " specify stencil buffer actions
+ that depend on whether subsequent depth buffer tests succeed ("
+ (var "dppass")
+ ")
+ or fail ("
+ (var "dpfail")
+ ") (see "
+ (code "glDepthFunc")
+ ").
+ The actions are specified using the same eight symbolic constants as "
+ (var "sfail")
+ ".
+ Note that "
+ (var "dpfail")
+ " is ignored when there is no depth buffer,
+ or when the depth buffer is not enabled.
+ In these cases, "
+ (var "sfail")
+ " and "
+ (var "dppass")
+ " specify stencil action when the
+ stencil test fails and passes,
+ respectively. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "sfail")
+ ", "
+ (var "dpfail")
+ ", or "
+ (var "dppass")
+ " is any value other than the eight defined constant values. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glStencilOp")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glTexCoordPointer
+ "glTexCoordPointer"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glTexCoordPointer"))
+ (paramdef "GLint " (parameter "size"))
+ (paramdef "GLenum " (parameter "type"))
+ (paramdef "GLsizei " (parameter "stride"))
+ (paramdef
+ "const GLvoid * "
+ (parameter "pointer"))))
+ '(*fragment*
+ (heading
+ "define an array of texture coordinates")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "size")))
+ (para "
+Specifies the number of coordinates per array element. Must be 1, 2, 3,
+ or 4. The initial value is 4. "))
+ (entry (% (heading (var "type")))
+ (para "
+Specifies the data type of each texture coordinate.
+ Symbolic constants "
+ (code "GL_SHORT")
+ ", "
+ (code "GL_INT")
+ ", "
+ (code "GL_FLOAT")
+ ",
+ or "
+ (code "GL_DOUBLE")
+ "
+are accepted. The initial value is "
+ (code "GL_FLOAT")
+ ". "))
+ (entry (% (heading (var "stride")))
+ (para "
+Specifies the byte offset between consecutive texture coordinate sets.
+ If "
+ (var "stride")
+ " is 0, the array elements are understood
+ to be tightly packed. The initial value is 0. "))
+ (entry (% (heading (var "pointer")))
+ (para "
+Specifies a pointer to the first coordinate of the first texture coordinate set in the
+ array. The initial value is 0. ")))
+ (heading "Description")
+ (para (code "glTexCoordPointer")
+ " specifies the location and data format of an array of texture
+ coordinates to use when rendering. "
+ (var "size")
+ " specifies the number of coordinates per
+ texture coordinate set, and must be 1, 2, 3, or 4. "
+ (var "type")
+ " specifies the data type of each texture coordinate,
+ and "
+ (var "stride")
+ " specifies the byte stride from one
+ texture coordinate set to the next, allowing vertices and attributes
+ to be packed into a single array or stored in separate arrays.
+ (Single-array storage may be more efficient on some implementations;
+ see "
+ (code "glInterleavedArrays")
+ ".) ")
+ (para "
+If a non-zero named buffer object is bound to the "
+ (code "GL_ARRAY_BUFFER")
+ " target
+ (see "
+ (code "glBindBuffer")
+ ") while a texture coordinate array is
+ specified, "
+ (var "pointer")
+ " is treated as a byte offset into the buffer object's data store.
+ Also, the buffer object binding ("
+ (code "GL_ARRAY_BUFFER_BINDING")
+ ") is saved as texture coordinate vertex array
+ client-side state ("
+ (code "GL_TEXTURE_COORD_ARRAY_BUFFER_BINDING")
+ "). ")
+ (para "
+When a texture coordinate array is specified, "
+ (var "size")
+ ", "
+ (var "type")
+ ", "
+ (var "stride")
+ ", and "
+ (var "pointer")
+ " are saved as client-side
+ state, in addition to the current vertex array buffer object binding. ")
+ (para "
+To enable and disable a texture coordinate array, call "
+ (code "glEnableClientState")
+ " and "
+ (code "glDisableClientState")
+ " with the argument "
+ (code "GL_TEXTURE_COORD_ARRAY")
+ ". If enabled, the texture coordinate array is used when "
+ (code "glArrayElement")
+ ", "
+ (code "glDrawArrays")
+ ", "
+ (code "glMultiDrawArrays")
+ ", "
+ (code "glDrawElements")
+ ", "
+ (code "glMultiDrawElements")
+ ", or "
+ (code "glDrawRangeElements")
+ "
+is called. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "size")
+ " is not 1, 2, 3, or 4. ")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "type")
+ " is not an accepted value. ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "stride")
+ " is negative. ")))
+
+(define-gl-procedure
+ glTexCoord
+ "glTexCoord"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glTexCoord1s"))
+ (paramdef "GLshort " (parameter "s"))))
+ '(*fragment*
+ (heading "set the current texture coordinates")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "s")))
+ (itemx (var "t"))
+ (itemx (var "r"))
+ (itemx (var "q"))
+ (para "
+Specify "
+ (var "s")
+ ", "
+ (var "t")
+ ", "
+ (var "r")
+ ", and "
+ (var "q")
+ " texture coordinates.
+ Not all parameters are present in all forms of the command. ")))
+ (heading "Description")
+ (para (code "glTexCoord")
+ " specifies texture coordinates in
+ one,
+ two,
+ three, or
+ four dimensions. "
+ (code "glTexCoord1")
+ " sets the current texture coordinates to "
+ (math "(" (var "s") "," "0" "0" "1" ")")
+ ";
+ a call to "
+ (code "glTexCoord2")
+ " sets them to "
+ (math "(" (var "s") "," (var "t") "0" "1" ")")
+ ".
+ Similarly, "
+ (code "glTexCoord3")
+ " specifies the texture coordinates as "
+ (math "("
+ (var "s")
+ ","
+ (var "t")
+ (var "r")
+ "1"
+ ")")
+ ",
+ and "
+ (code "glTexCoord4")
+ " defines all four components explicitly as "
+ (math "("
+ (var "s")
+ ","
+ (var "t")
+ (var "r")
+ (var "q")
+ ")")
+ ". ")
+ (para "
+The current texture coordinates are part of the data
+ that is associated with each vertex and with the current
+ raster position.
+ Initially, the values for "
+ (var "s")
+ ", "
+ (var "t")
+ ", "
+ (var "r")
+ ", and "
+ (var "q")
+ "
+are (0, 0, 0, 1). ")
+ (para)))
+
+(define-gl-procedure
+ glTexEnv
+ "glTexEnv"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glTexEnvf"))
+ (paramdef "GLenum " (parameter "target"))
+ (paramdef "GLenum " (parameter "pname"))
+ (paramdef "GLfloat " (parameter "param"))))
+ '(*fragment*
+ (heading "set texture environment parameters")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "target")))
+ (para "
+Specifies a texture environment.
+ May be "
+ (code "GL_TEXTURE_ENV")
+ ", "
+ (code "GL_TEXTURE_FILTER_CONTROL")
+ " or "
+ (code "GL_POINT_SPRITE")
+ ". "))
+ (entry (% (heading (var "pname")))
+ (para "
+Specifies the symbolic name of a single-valued texture environment parameter.
+ May be either "
+ (code "GL_TEXTURE_ENV_MODE")
+ ", "
+ (code "GL_TEXTURE_LOD_BIAS")
+ ", "
+ (code "GL_COMBINE_RGB")
+ ", "
+ (code "GL_COMBINE_ALPHA")
+ ", "
+ (code "GL_SRC0_RGB")
+ ", "
+ (code "GL_SRC1_RGB")
+ ", "
+ (code "GL_SRC2_RGB")
+ ", "
+ (code "GL_SRC0_ALPHA")
+ ", "
+ (code "GL_SRC1_ALPHA")
+ ", "
+ (code "GL_SRC2_ALPHA")
+ ", "
+ (code "GL_OPERAND0_RGB")
+ ", "
+ (code "GL_OPERAND1_RGB")
+ ", "
+ (code "GL_OPERAND2_RGB")
+ ", "
+ (code "GL_OPERAND0_ALPHA")
+ ", "
+ (code "GL_OPERAND1_ALPHA")
+ ", "
+ (code "GL_OPERAND2_ALPHA")
+ ", "
+ (code "GL_RGB_SCALE")
+ ", "
+ (code "GL_ALPHA_SCALE")
+ ", or "
+ (code "GL_COORD_REPLACE")
+ ". "))
+ (entry (% (heading (var "param")))
+ (para "
+Specifies a single symbolic constant, one of "
+ (code "GL_ADD")
+ ", "
+ (code "GL_ADD_SIGNED")
+ ", "
+ (code "GL_INTERPOLATE")
+ ", "
+ (code "GL_MODULATE")
+ ", "
+ (code "GL_DECAL")
+ ", "
+ (code "GL_BLEND")
+ ", "
+ (code "GL_REPLACE")
+ ", "
+ (code "GL_SUBTRACT")
+ ", "
+ (code "GL_COMBINE")
+ ", "
+ (code "GL_TEXTURE")
+ ", "
+ (code "GL_CONSTANT")
+ ", "
+ (code "GL_PRIMARY_COLOR")
+ ", "
+ (code "GL_PREVIOUS")
+ ", "
+ (code "GL_SRC_COLOR")
+ ", "
+ (code "GL_ONE_MINUS_SRC_COLOR")
+ ", "
+ (code "GL_SRC_ALPHA")
+ ", "
+ (code "GL_ONE_MINUS_SRC_ALPHA")
+ ",
+ a single boolean value for the point sprite texture coordinate replacement,
+ a single floating-point value for the texture level-of-detail bias,
+ or 1.0, 2.0, or 4.0 when specifying the "
+ (code "GL_RGB_SCALE")
+ " or "
+ (code "GL_ALPHA_SCALE")
+ ". ")))
+ (heading "Description")
+ (para "
+A texture environment specifies how texture values are interpreted when a
+ fragment is textured. When "
+ (var "target")
+ " is "
+ (code "GL_TEXTURE_FILTER_CONTROL")
+ ", "
+ (var "pname")
+ " must be "
+ (code "GL_TEXTURE_LOD_BIAS")
+ ". When "
+ (var "target")
+ " is "
+ (code "GL_TEXTURE_ENV")
+ ", "
+ (var "pname")
+ " can be "
+ (code "GL_TEXTURE_ENV_MODE")
+ ", "
+ (code "GL_TEXTURE_ENV_COLOR")
+ ", "
+ (code "GL_COMBINE_RGB")
+ ", "
+ (code "GL_COMBINE_ALPHA")
+ ", "
+ (code "GL_RGB_SCALE")
+ ", "
+ (code "GL_ALPHA_SCALE")
+ ", "
+ (code "GL_SRC0_RGB")
+ ", "
+ (code "GL_SRC1_RGB")
+ ", "
+ (code "GL_SRC2_RGB")
+ ", "
+ (code "GL_SRC0_ALPHA")
+ ", "
+ (code "GL_SRC1_ALPHA")
+ ", or "
+ (code "GL_SRC2_ALPHA")
+ ". ")
+ (para "
+If "
+ (var "pname")
+ " is "
+ (code "GL_TEXTURE_ENV_MODE")
+ ",
+ then "
+ (var "params")
+ " is (or points to) the symbolic name of a texture function.
+ Six texture functions may be specified: "
+ (code "GL_ADD")
+ ", "
+ (code "GL_MODULATE")
+ ", "
+ (code "GL_DECAL")
+ ", "
+ (code "GL_BLEND")
+ ", "
+ (code "GL_REPLACE")
+ ", or "
+ (code "GL_COMBINE")
+ ". ")
+ (para "
+The following table shows the correspondence of filtered texture
+ values "
+ (math (var "R") "_" (var "t"))
+ ", "
+ (math (var "G") "_" (var "t"))
+ ", "
+ (math (var "B") "_" (var "t"))
+ ", "
+ (math (var "A") "_" (var "t"))
+ ", "
+ (math (var "L") "_" (var "t"))
+ ", "
+ (math (var "I") "_" (var "t"))
+ "
+to texture source components. "
+ (math (var "C") "_" (var "s"))
+ "
+and "
+ (math (var "A") "_" (var "s"))
+ "
+are used by the texture functions described below. ")
+ (para)
+ (table (% (formatter (asis)))
+ (entry (% (heading "
+Texture Base Internal Format "))
+ (para (math (code "C") "_" (var "s"))
+ ", "
+ (math (code "A") "_" (var "s"))))
+ (entry (% (heading (code "GL_ALPHA")))
+ (para "
+(0, 0, 0) "
+ ", "
+ (math (var "A") "_" (var "t"))))
+ (entry (% (heading (code "GL_LUMINANCE")))
+ (para "
+( "
+ (math (var "L") "_" (var "t"))
+ ", "
+ (math (var "L") "_" (var "t"))
+ ", "
+ (math (var "L") "_" (var "t"))
+ "
+) "
+ ", "
+ "
+1 "))
+ (entry (% (heading (code "GL_LUMINANCE_ALPHA")))
+ (para "
+( "
+ (math (var "L") "_" (var "t"))
+ ", "
+ (math (var "L") "_" (var "t"))
+ ", "
+ (math (var "L") "_" (var "t"))
+ "
+) "
+ ", "
+ (math (var "A") "_" (var "t"))))
+ (entry (% (heading (code "GL_INTENSITY")))
+ (para "
+( "
+ (math (var "I") "_" (var "t"))
+ ", "
+ (math (var "I") "_" (var "t"))
+ ", "
+ (math (var "I") "_" (var "t"))
+ "
+) "
+ ", "
+ (math (var "I") "_" (var "t"))))
+ (entry (% (heading (code "GL_RGB")))
+ (para "
+( "
+ (math (var "R") "_" (var "t"))
+ ", "
+ (math (var "G") "_" (var "t"))
+ ", "
+ (math (var "B") "_" (var "t"))
+ "
+) "
+ ", "
+ "
+1 "))
+ (entry (% (heading (code "GL_RGBA")))
+ (para "
+( "
+ (math (var "R") "_" (var "t"))
+ ", "
+ (math (var "G") "_" (var "t"))
+ ", "
+ (math (var "B") "_" (var "t"))
+ "
+) "
+ ", "
+ (math (var "A") "_" (var "t")))))
+ (para "
+A texture function acts on the fragment to be textured using
+ the texture image value that applies to the fragment
+ (see "
+ (code "glTexParameter")
+ ")
+ and produces an RGBA color for that fragment.
+ The following table shows how the RGBA color is produced for each
+ of the first five texture functions that can be chosen. "
+ (math (var "C"))
+ "
+is a triple of color values (RGB) and "
+ (math (var "A"))
+ "
+is the associated alpha value.
+ RGBA values extracted from a texture image are in the range [0,1].
+ The subscript "
+ (math (var "p"))
+ "
+refers to the color computed from the previous texture stage (or the incoming fragment if processing texture stage 0),
+ the subscript "
+ (math (var "s"))
+ "
+to the texture source color,
+ the subscript "
+ (math (var "c"))
+ "
+to the texture environment color,
+ and the subscript "
+ (math (var "v"))
+ "
+indicates a value produced by the texture function. ")
+ (para)
+ (table (% (formatter (asis)))
+ (entry (% (heading "
+Texture Base Internal Format "))
+ (para (code "Value")
+ ", "
+ (code "GL_REPLACE")
+ " Function "
+ ", "
+ (code "GL_MODULATE")
+ " Function "
+ ", "
+ (code "GL_DECAL")
+ " Function "
+ ", "
+ (code "GL_BLEND")
+ " Function "
+ ", "
+ (code "GL_ADD")
+ " Function "))
+ (entry (% (heading (code "GL_ALPHA")))
+ (para (math (var "C") "_" (var "v") "=")
+ ", "
+ (math (var "C") "_" (var "p"))
+ ", "
+ (math (var "C") "_" (var "p"))
+ ", "
+ "
+undefined "
+ ", "
+ (math (var "C") "_" (var "p"))
+ ", "
+ (math (var "C") "_" (var "p"))))
+ (entry (% (heading))
+ (para (math (var "A") "_" (var "v") "=")
+ ", "
+ (math (var "A") "_" (var "s"))
+ ", "
+ (math (var "A")
+ "_"
+ (var "p")
+ "\u2062"
+ (var "A")
+ "_"
+ (var "s"))
+ ", "
+ ", "
+ (math (var "A")
+ "_"
+ (var "v")
+ "="
+ (var "A")
+ "_"
+ (var "p")
+ "\u2062"
+ (var "A")
+ "_"
+ (var "s"))
+ ", "
+ (math (var "A")
+ "_"
+ (var "p")
+ "\u2062"
+ (var "A")
+ "_"
+ (var "s"))))
+ (entry (% (heading (code "GL_LUMINANCE")))
+ (para (math (var "C") "_" (var "v") "=")
+ ", "
+ (math (var "C") "_" (var "s"))
+ ", "
+ (math (var "C")
+ "_"
+ (var "p")
+ "\u2062"
+ (var "C")
+ "_"
+ (var "s"))
+ ", "
+ "
+undefined "
+ ", "
+ (math (var "C")
+ "_"
+ (var "p")
+ "\u2062"
+ "("
+ "1"
+ "-"
+ (var "C")
+ "_"
+ (var "s")
+ ","
+ ")"
+ "+"
+ (var "C")
+ "_"
+ (var "c")
+ "\u2062"
+ (var "C")
+ "_"
+ (var "s"))
+ ", "
+ (math (var "C")
+ "_"
+ (var "p")
+ "+"
+ (var "C")
+ "_"
+ (var "s"))))
+ (entry (% (heading "
+(or 1) "))
+ (para (math (var "A") "_" (var "v") "=")
+ ", "
+ (math (var "A") "_" (var "p"))
+ ", "
+ (math (var "A") "_" (var "p"))
+ ", "
+ ", "
+ (math (var "A") "_" (var "p"))
+ ", "
+ (math (var "A") "_" (var "p"))))
+ (entry (% (heading (code "GL_LUMINANCE_ALPHA")))
+ (para (math (var "C") "_" (var "v") "=")
+ ", "
+ (math (var "C") "_" (var "s"))
+ ", "
+ (math (var "C")
+ "_"
+ (var "p")
+ "\u2062"
+ (var "C")
+ "_"
+ (var "s"))
+ ", "
+ "
+undefined "
+ ", "
+ (math (var "C")
+ "_"
+ (var "p")
+ "\u2062"
+ "("
+ "1"
+ "-"
+ (var "C")
+ "_"
+ (var "s")
+ ","
+ ")"
+ "+"
+ (var "C")
+ "_"
+ (var "c")
+ "\u2062"
+ (var "C")
+ "_"
+ (var "s"))
+ ", "
+ (math (var "C")
+ "_"
+ (var "p")
+ "+"
+ (var "C")
+ "_"
+ (var "s"))))
+ (entry (% (heading "
+(or 2) "))
+ (para (math (var "A") "_" (var "v") "=")
+ ", "
+ (math (var "A") "_" (var "s"))
+ ", "
+ (math (var "A")
+ "_"
+ (var "p")
+ "\u2062"
+ (var "A")
+ "_"
+ (var "s"))
+ ", "
+ ", "
+ (math (var "A")
+ "_"
+ (var "p")
+ "\u2062"
+ (var "A")
+ "_"
+ (var "s"))
+ ", "
+ (math (var "A")
+ "_"
+ (var "p")
+ "\u2062"
+ (var "A")
+ "_"
+ (var "s"))))
+ (entry (% (heading (code "GL_INTENSITY")))
+ (para (math (var "C") "_" (var "v") "=")
+ ", "
+ (math (var "C") "_" (var "s"))
+ ", "
+ (math (var "C")
+ "_"
+ (var "p")
+ "\u2062"
+ (var "C")
+ "_"
+ (var "s"))
+ ", "
+ "
+undefined "
+ ", "
+ (math (var "C")
+ "_"
+ (var "p")
+ "\u2062"
+ "("
+ "1"
+ "-"
+ (var "C")
+ "_"
+ (var "s")
+ ","
+ ")"
+ "+"
+ (var "C")
+ "_"
+ (var "c")
+ "\u2062"
+ (var "C")
+ "_"
+ (var "s"))
+ ", "
+ (math (var "C")
+ "_"
+ (var "p")
+ "+"
+ (var "C")
+ "_"
+ (var "s"))))
+ (entry (% (heading))
+ (para (math (var "A") "_" (var "v") "=")
+ ", "
+ (math (var "A") "_" (var "s"))
+ ", "
+ (math (var "A")
+ "_"
+ (var "p")
+ "\u2062"
+ (var "A")
+ "_"
+ (var "s"))
+ ", "
+ ", "
+ (math (var "A")
+ "_"
+ (var "p")
+ "\u2062"
+ "("
+ "1"
+ "-"
+ (var "A")
+ "_"
+ (var "s")
+ ","
+ ")"
+ "+"
+ (var "A")
+ "_"
+ (var "c")
+ "\u2062"
+ (var "A")
+ "_"
+ (var "s"))
+ ", "
+ (math (var "A")
+ "_"
+ (var "p")
+ "+"
+ (var "A")
+ "_"
+ (var "s"))))
+ (entry (% (heading (code "GL_RGB")))
+ (para (math (var "C") "_" (var "v") "=")
+ ", "
+ (math (var "C") "_" (var "s"))
+ ", "
+ (math (var "C")
+ "_"
+ (var "p")
+ "\u2062"
+ (var "C")
+ "_"
+ (var "s"))
+ ", "
+ (math (var "C") "_" (var "s"))
+ ", "
+ (math (var "C")
+ "_"
+ (var "p")
+ "\u2062"
+ "("
+ "1"
+ "-"
+ (var "C")
+ "_"
+ (var "s")
+ ","
+ ")"
+ "+"
+ (var "C")
+ "_"
+ (var "c")
+ "\u2062"
+ (var "C")
+ "_"
+ (var "s"))
+ ", "
+ (math (var "C")
+ "_"
+ (var "p")
+ "+"
+ (var "C")
+ "_"
+ (var "s"))))
+ (entry (% (heading "
+(or 3) "))
+ (para (math (var "A") "_" (var "v") "=")
+ ", "
+ (math (var "A") "_" (var "p"))
+ ", "
+ (math (var "A") "_" (var "p"))
+ ", "
+ (math (var "A") "_" (var "p"))
+ ", "
+ (math (var "A") "_" (var "p"))
+ ", "
+ (math (var "A") "_" (var "p"))))
+ (entry (% (heading (code "GL_RGBA")))
+ (para (math (var "C") "_" (var "v") "=")
+ ", "
+ (math (var "C") "_" (var "s"))
+ ", "
+ (math (var "C")
+ "_"
+ (var "p")
+ "\u2062"
+ (var "C")
+ "_"
+ (var "s"))
+ ", "
+ (math (var "C")
+ "_"
+ (var "p")
+ "\u2062"
+ "("
+ "1"
+ "-"
+ (var "A")
+ "_"
+ (var "s")
+ ","
+ ")"
+ "+"
+ (var "C")
+ "_"
+ (var "s")
+ "\u2062"
+ (var "A")
+ "_"
+ (var "s"))
+ ", "
+ (math (var "C")
+ "_"
+ (var "p")
+ "\u2062"
+ "("
+ "1"
+ "-"
+ (var "C")
+ "_"
+ (var "s")
+ ","
+ ")"
+ "+"
+ (var "C")
+ "_"
+ (var "c")
+ "\u2062"
+ (var "C")
+ "_"
+ (var "s"))
+ ", "
+ (math (var "C")
+ "_"
+ (var "p")
+ "+"
+ (var "C")
+ "_"
+ (var "s"))))
+ (entry (% (heading "
+(or 4) "))
+ (para (math (var "A") "_" (var "v") "=")
+ ", "
+ (math (var "A") "_" (var "s"))
+ ", "
+ (math (var "A")
+ "_"
+ (var "p")
+ "\u2062"
+ (var "A")
+ "_"
+ (var "s"))
+ ", "
+ (math (var "A") "_" (var "p"))
+ ", "
+ (math (var "A")
+ "_"
+ (var "p")
+ "\u2062"
+ (var "A")
+ "_"
+ (var "s"))
+ ", "
+ (math (var "A")
+ "_"
+ (var "p")
+ "\u2062"
+ (var "A")
+ "_"
+ (var "s")))))
+ (para "
+If "
+ (var "pname")
+ " is "
+ (code "GL_TEXTURE_ENV_MODE")
+ ", and "
+ (var "params")
+ " is "
+ (code "GL_COMBINE")
+ ", the
+ form of the texture function depends on the values of "
+ (code "GL_COMBINE_RGB")
+ "
+and "
+ (code "GL_COMBINE_ALPHA")
+ ". ")
+ (para "
+The following describes how the texture sources, as specified by "
+ (code "GL_SRC0_RGB")
+ ", "
+ (code "GL_SRC1_RGB")
+ ", "
+ (code "GL_SRC2_RGB")
+ ", "
+ (code "GL_SRC0_ALPHA")
+ ", "
+ (code "GL_SRC1_ALPHA")
+ ", and "
+ (code "GL_SRC2_ALPHA")
+ ",
+ are combined to produce a final texture color. In the following tables, "
+ (code "GL_SRC0_c")
+ " is represented by "
+ (math (var "Arg0"))
+ ", "
+ (code "GL_SRC1_c")
+ " is
+ represented by "
+ (math (var "Arg1"))
+ ",
+ and "
+ (code "GL_SRC2_c")
+ " is represented by "
+ (math (var "Arg2"))
+ ". ")
+ (para (code "GL_COMBINE_RGB")
+ " accepts any of "
+ (code "GL_REPLACE")
+ ", "
+ (code "GL_MODULATE")
+ ", "
+ (code "GL_ADD")
+ ", "
+ (code "GL_ADD_SIGNED")
+ ", "
+ (code "GL_INTERPOLATE")
+ ", "
+ (code "GL_SUBTRACT")
+ ", "
+ (code "GL_DOT3_RGB")
+ ", or "
+ (code "GL_DOT3_RGBA")
+ ". ")
+ (para)
+ (table (% (formatter (asis)))
+ (entry (% (heading (strong (code "GL_COMBINE_RGB"))))
+ (para (strong "Texture Function")))
+ (entry (% (heading (code "GL_REPLACE")))
+ (para (math (var "Arg0"))))
+ (entry (% (heading (code "GL_MODULATE")))
+ (para (math (var "Arg0") "×" (var "Arg1"))))
+ (entry (% (heading (code "GL_ADD")))
+ (para (math (var "Arg0") "+" (var "Arg1"))))
+ (entry (% (heading (code "GL_ADD_SIGNED")))
+ (para (math (var "Arg0") "+" (var "Arg1") "-" "0.5")))
+ (entry (% (heading (code "GL_INTERPOLATE")))
+ (para (math (var "Arg0")
+ "×"
+ (var "Arg2")
+ "+"
+ (var "Arg1")
+ "×"
+ "("
+ "1"
+ "-"
+ (var "Arg2")
+ ","
+ ")")))
+ (entry (% (heading (code "GL_SUBTRACT")))
+ (para (math (var "Arg0") "-" (var "Arg1"))))
+ (entry (% (heading
+ (code "GL_DOT3_RGB")
+ "
+or "
+ (code "GL_DOT3_RGBA")))
+ (para (math "4"
+ "×"
+ "("
+ "("
+ "("
+ (var "Arg0")
+ "_"
+ (var "r")
+ ","
+ "-"
+ "0.5"
+ ","
+ ")"
+ "×"
+ "("
+ (var "Arg1")
+ "_"
+ (var "r")
+ ","
+ "-"
+ "0.5"
+ ","
+ ")"
+ ","
+ ")"
+ "+"
+ "("
+ "("
+ (var "Arg0")
+ "_"
+ (var "g")
+ ","
+ "-"
+ "0.5"
+ ","
+ ")"
+ "×"
+ "("
+ (var "Arg1")
+ "_"
+ (var "g")
+ ","
+ "-"
+ "0.5"
+ ","
+ ")"
+ ","
+ ")"
+ "+"
+ "("
+ "("
+ (var "Arg0")
+ "_"
+ (var "b")
+ ","
+ "-"
+ "0.5"
+ ","
+ ")"
+ "×"
+ "("
+ (var "Arg1")
+ "_"
+ (var "b")
+ ","
+ "-"
+ "0.5"
+ ","
+ ")"
+ ","
+ ")"
+ ","
+ ")"))))
+ (para "
+The scalar results for "
+ (code "GL_DOT3_RGB")
+ " and "
+ (code "GL_DOT3_RGBA")
+ " are placed
+ into each of the 3 (RGB) or 4 (RGBA) components on output. ")
+ (para "
+Likewise, "
+ (code "GL_COMBINE_ALPHA")
+ " accepts any of "
+ (code "GL_REPLACE")
+ ", "
+ (code "GL_MODULATE")
+ ", "
+ (code "GL_ADD")
+ ", "
+ (code "GL_ADD_SIGNED")
+ ", "
+ (code "GL_INTERPOLATE")
+ ", or "
+ (code "GL_SUBTRACT")
+ ". The following table describes how alpha values are
+ combined: ")
+ (para)
+ (table (% (formatter (asis)))
+ (entry (% (heading (strong (code "GL_COMBINE_ALPHA"))))
+ (para (strong "Texture Function")))
+ (entry (% (heading (code "GL_REPLACE")))
+ (para (math (var "Arg0"))))
+ (entry (% (heading (code "GL_MODULATE")))
+ (para (math (var "Arg0") "×" (var "Arg1"))))
+ (entry (% (heading (code "GL_ADD")))
+ (para (math (var "Arg0") "+" (var "Arg1"))))
+ (entry (% (heading (code "GL_ADD_SIGNED")))
+ (para (math (var "Arg0") "+" (var "Arg1") "-" "0.5")))
+ (entry (% (heading (code "GL_INTERPOLATE")))
+ (para (math (var "Arg0")
+ "×"
+ (var "Arg2")
+ "+"
+ (var "Arg1")
+ "×"
+ "("
+ "1"
+ "-"
+ (var "Arg2")
+ ","
+ ")")))
+ (entry (% (heading (code "GL_SUBTRACT")))
+ (para (math (var "Arg0") "-" (var "Arg1")))))
+ (para "
+In the following tables, the value "
+ (math (var "C") "_" (var "s"))
+ "
+represents the color sampled
+ from the currently bound texture, "
+ (math (var "C") "_" (var "c"))
+ "
+represents the constant
+ texture-environment color, "
+ (math (var "C") "_" (var "f"))
+ "
+represents the primary color of the
+ incoming fragment, and "
+ (math (var "C") "_" (var "p"))
+ "
+represents the color computed from the
+ previous texture stage or "
+ (math (var "C") "_" (var "f"))
+ "
+if processing texture stage 0. Likewise, "
+ (math (var "A") "_" (var "s"))
+ ", "
+ (math (var "A") "_" (var "c"))
+ ", "
+ (math (var "A") "_" (var "f"))
+ ",
+ and "
+ (math (var "A") "_" (var "p"))
+ "
+represent the respective
+ alpha values. ")
+ (para "
+The following table describes the values assigned to "
+ (math (var "Arg0"))
+ ", "
+ (math (var "Arg1"))
+ ",
+ and "
+ (math (var "Arg2"))
+ "
+based upon the RGB sources and operands: ")
+ (para)
+ (table (% (formatter (asis)))
+ (entry (% (heading (strong (code "GL_SRCn_RGB"))))
+ (para (strong (code "GL_OPERANDn_RGB"))
+ ", "
+ (strong "Argument Value")))
+ (entry (% (heading (code "GL_TEXTURE")))
+ (para (code "GL_SRC_COLOR")
+ ", "
+ (math (var "C") "_" (var "s") ",")))
+ (entry (% (heading))
+ (para (code "GL_ONE_MINUS_SRC_COLOR")
+ ", "
+ (math "1" "-" (var "C") "_" (var "s") ",")))
+ (entry (% (heading))
+ (para (code "GL_SRC_ALPHA")
+ ", "
+ (math (var "A") "_" (var "s") ",")))
+ (entry (% (heading))
+ (para (code "GL_ONE_MINUS_SRC_ALPHA")
+ ", "
+ (math "1" "-" (var "A") "_" (var "s") ",")))
+ (entry (% (heading (code "GL_TEXTUREn")))
+ (para (code "GL_SRC_COLOR")
+ ", "
+ (math (var "C") "_" (var "s") ",")))
+ (entry (% (heading))
+ (para (code "GL_ONE_MINUS_SRC_COLOR")
+ ", "
+ (math "1" "-" (var "C") "_" (var "s") ",")))
+ (entry (% (heading))
+ (para (code "GL_SRC_ALPHA")
+ ", "
+ (math (var "A") "_" (var "s") ",")))
+ (entry (% (heading))
+ (para (code "GL_ONE_MINUS_SRC_ALPHA")
+ ", "
+ (math "1" "-" (var "A") "_" (var "s") ",")))
+ (entry (% (heading (code "GL_CONSTANT")))
+ (para (code "GL_SRC_COLOR")
+ ", "
+ (math (var "C") "_" (var "c") ",")))
+ (entry (% (heading))
+ (para (code "GL_ONE_MINUS_SRC_COLOR")
+ ", "
+ (math "1" "-" (var "C") "_" (var "c") ",")))
+ (entry (% (heading))
+ (para (code "GL_SRC_ALPHA")
+ ", "
+ (math (var "A") "_" (var "c") ",")))
+ (entry (% (heading))
+ (para (code "GL_ONE_MINUS_SRC_ALPHA")
+ ", "
+ (math "1" "-" (var "A") "_" (var "c") ",")))
+ (entry (% (heading (code "GL_PRIMARY_COLOR")))
+ (para (code "GL_SRC_COLOR")
+ ", "
+ (math (var "C") "_" (var "f") ",")))
+ (entry (% (heading))
+ (para (code "GL_ONE_MINUS_SRC_COLOR")
+ ", "
+ (math "1" "-" (var "C") "_" (var "f") ",")))
+ (entry (% (heading))
+ (para (code "GL_SRC_ALPHA")
+ ", "
+ (math (var "A") "_" (var "f") ",")))
+ (entry (% (heading))
+ (para (code "GL_ONE_MINUS_SRC_ALPHA")
+ ", "
+ (math "1" "-" (var "A") "_" (var "f") ",")))
+ (entry (% (heading (code "GL_PREVIOUS")))
+ (para (code "GL_SRC_COLOR")
+ ", "
+ (math (var "C") "_" (var "p") ",")))
+ (entry (% (heading))
+ (para (code "GL_ONE_MINUS_SRC_COLOR")
+ ", "
+ (math "1" "-" (var "C") "_" (var "p") ",")))
+ (entry (% (heading))
+ (para (code "GL_SRC_ALPHA")
+ ", "
+ (math (var "A") "_" (var "p") ",")))
+ (entry (% (heading))
+ (para (code "GL_ONE_MINUS_SRC_ALPHA")
+ ", "
+ (math "1" "-" (var "A") "_" (var "p") ","))))
+ (para "
+For "
+ (code "GL_TEXTUREn")
+ " sources, "
+ (math (var "C") "_" (var "s"))
+ "
+and "
+ (math (var "A") "_" (var "s"))
+ "
+represent the color
+ and alpha, respectively, produced from texture stage "
+ (math (var "n"))
+ ". ")
+ (para "
+The follow table describes the values assigned to "
+ (math (var "Arg0"))
+ ", "
+ (math (var "Arg1"))
+ ",
+ and "
+ (math (var "Arg2"))
+ "
+based upon the alpha sources and operands: ")
+ (para)
+ (table (% (formatter (asis)))
+ (entry (% (heading (strong (code "GL_SRCn_ALPHA"))))
+ (para (strong (code "GL_OPERANDn_ALPHA"))
+ ", "
+ (strong "Argument Value")))
+ (entry (% (heading (code "GL_TEXTURE")))
+ (para (code "GL_SRC_ALPHA")
+ ", "
+ (math (var "A") "_" (var "s") ",")))
+ (entry (% (heading))
+ (para (code "GL_ONE_MINUS_SRC_ALPHA")
+ ", "
+ (math "1" "-" (var "A") "_" (var "s") ",")))
+ (entry (% (heading (code "GL_TEXTUREn")))
+ (para (code "GL_SRC_ALPHA")
+ ", "
+ (math (var "A") "_" (var "s") ",")))
+ (entry (% (heading))
+ (para (code "GL_ONE_MINUS_SRC_ALPHA")
+ ", "
+ (math "1" "-" (var "A") "_" (var "s") ",")))
+ (entry (% (heading (code "GL_CONSTANT")))
+ (para (code "GL_SRC_ALPHA")
+ ", "
+ (math (var "A") "_" (var "c") ",")))
+ (entry (% (heading))
+ (para (code "GL_ONE_MINUS_SRC_ALPHA")
+ ", "
+ (math "1" "-" (var "A") "_" (var "c") ",")))
+ (entry (% (heading (code "GL_PRIMARY_COLOR")))
+ (para (code "GL_SRC_ALPHA")
+ ", "
+ (math (var "A") "_" (var "f") ",")))
+ (entry (% (heading))
+ (para (code "GL_ONE_MINUS_SRC_ALPHA")
+ ", "
+ (math "1" "-" (var "A") "_" (var "f") ",")))
+ (entry (% (heading (code "GL_PREVIOUS")))
+ (para (code "GL_SRC_ALPHA")
+ ", "
+ (math (var "A") "_" (var "p") ",")))
+ (entry (% (heading))
+ (para (code "GL_ONE_MINUS_SRC_ALPHA")
+ ", "
+ (math "1" "-" (var "A") "_" (var "p") ","))))
+ (para "
+The RGB and alpha results of the texture function are multipled by the
+ values of "
+ (code "GL_RGB_SCALE")
+ " and "
+ (code "GL_ALPHA_SCALE")
+ ", respectively, and
+ clamped to the range "
+ (math "[" "0" "," "1" "]")
+ ". ")
+ (para "
+If "
+ (var "pname")
+ " is "
+ (code "GL_TEXTURE_ENV_COLOR")
+ ", "
+ (var "params")
+ " is a pointer to an array that holds an RGBA color consisting of four
+ values.
+ Integer color components are interpreted linearly such that the most
+ positive integer maps to 1.0,
+ and the most negative integer maps to -1.0.
+ The values are clamped to the range [0,1] when they are specified. "
+ (math (var "C") "_" (var "c"))
+ "
+takes these four values. ")
+ (para "
+If "
+ (var "pname")
+ " is "
+ (code "GL_TEXTURE_LOD_BIAS")
+ ", the value specified is added to the
+ texture level-of-detail parameter, that selects which mipmap, or mipmaps
+ depending upon the selected "
+ (code "GL_TEXTURE_MIN_FILTER")
+ ", will be sampled. ")
+ (para (code "GL_TEXTURE_ENV_MODE")
+ " defaults to "
+ (code "GL_MODULATE")
+ " and "
+ (code "GL_TEXTURE_ENV_COLOR")
+ " defaults to (0, 0, 0, 0). ")
+ (para "
+If "
+ (var "target")
+ " is "
+ (code "GL_POINT_SPRITE")
+ " and "
+ (var "pname")
+ " is "
+ (code "GL_COORD_REPLACE")
+ ", the boolean value specified
+ is used to either enable or disable point sprite texture coordinate replacement. The default value is "
+ (code "GL_FALSE")
+ ". ")
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated when "
+ (var "target")
+ " or "
+ (var "pname")
+ " is not
+ one of the accepted defined values,
+ or when "
+ (var "params")
+ " should have a defined constant value
+ (based on the value of "
+ (var "pname")
+ ")
+ and does not. ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if the "
+ (var "params")
+ " value for "
+ (code "GL_RGB_SCALE")
+ " or "
+ (code "GL_ALPHA_SCALE")
+ " are not one of 1.0, 2.0,
+ or 4.0. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glTexEnv")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glTexGen
+ "glTexGen"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glTexGeni"))
+ (paramdef "GLenum " (parameter "coord"))
+ (paramdef "GLenum " (parameter "pname"))
+ (paramdef "GLint " (parameter "param"))))
+ '(*fragment*
+ (heading
+ "control the generation of texture coordinates")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "coord")))
+ (para "
+Specifies a texture coordinate.
+ Must be one of "
+ (code "GL_S")
+ ", "
+ (code "GL_T")
+ ", "
+ (code "GL_R")
+ ", or "
+ (code "GL_Q")
+ ". "))
+ (entry (% (heading (var "pname")))
+ (para "
+Specifies the symbolic name of the texture-coordinate generation function.
+ Must be "
+ (code "GL_TEXTURE_GEN_MODE")
+ ". "))
+ (entry (% (heading (var "param")))
+ (para "
+Specifies a single-valued texture generation parameter,
+ one of "
+ (code "GL_OBJECT_LINEAR")
+ ", "
+ (code "GL_EYE_LINEAR")
+ ", "
+ (code "GL_SPHERE_MAP")
+ ", "
+ (code "GL_NORMAL_MAP")
+ ", or "
+ (code "GL_REFLECTION_MAP")
+ ". ")))
+ (heading "Description")
+ (para (code "glTexGen")
+ " selects a texture-coordinate generation function
+ or supplies coefficients for one of the functions. "
+ (var "coord")
+ " names one of the ("
+ (var "s")
+ ", "
+ (var "t")
+ ", "
+ (var "r")
+ ", "
+ (var "q")
+ ") texture
+ coordinates; it must be one of the symbols "
+ (code "GL_S")
+ ", "
+ (code "GL_T")
+ ", "
+ (code "GL_R")
+ ", or "
+ (code "GL_Q")
+ ". "
+ (var "pname")
+ " must be one of three symbolic constants: "
+ (code "GL_TEXTURE_GEN_MODE")
+ ", "
+ (code "GL_OBJECT_PLANE")
+ ", or "
+ (code "GL_EYE_PLANE")
+ ".
+ If "
+ (var "pname")
+ " is "
+ (code "GL_TEXTURE_GEN_MODE")
+ ",
+ then "
+ (var "params")
+ " chooses a mode,
+ one of "
+ (code "GL_OBJECT_LINEAR")
+ ", "
+ (code "GL_EYE_LINEAR")
+ ", "
+ (code "GL_SPHERE_MAP")
+ ", "
+ (code "GL_NORMAL_MAP")
+ ", or "
+ (code "GL_REFLECTION_MAP")
+ ".
+ If "
+ (var "pname")
+ " is either "
+ (code "GL_OBJECT_PLANE")
+ " or "
+ (code "GL_EYE_PLANE")
+ ", "
+ (var "params")
+ " contains coefficients for the corresponding
+ texture generation function. ")
+ (para "
+If the texture generation function is "
+ (code "GL_OBJECT_LINEAR")
+ ",
+ the function ")
+ (para (math (var "g")
+ "="
+ (var "p")
+ "_"
+ "1"
+ "×"
+ (var "x")
+ "_"
+ (var "o")
+ "+"
+ (var "p")
+ "_"
+ "2"
+ "×"
+ (var "y")
+ "_"
+ (var "o")
+ "+"
+ (var "p")
+ "_"
+ "3"
+ "×"
+ (var "z")
+ "_"
+ (var "o")
+ "+"
+ (var "p")
+ "_"
+ "4"
+ "×"
+ (var "w")
+ "_"
+ (var "o")))
+ (para "
+is used, where "
+ (math (var "g"))
+ "
+is the value computed for the coordinate named in "
+ (var "coord")
+ ", "
+ (math (var "p") "_" "1")
+ ", "
+ (math (var "p") "_" "2")
+ ", "
+ (math (var "p") "_" "3")
+ ",
+ and "
+ (math (var "p") "_" "4")
+ "
+are the four values supplied in "
+ (var "params")
+ ", and "
+ (math (var "x") "_" (var "o"))
+ ", "
+ (math (var "y") "_" (var "o"))
+ ", "
+ (math (var "z") "_" (var "o"))
+ ",
+ and "
+ (math (var "w") "_" (var "o"))
+ "
+are the object coordinates of the vertex.
+ This function can be used, for example, to texture-map terrain using sea level
+ as a reference plane
+ (defined by "
+ (math (var "p") "_" "1")
+ ", "
+ (math (var "p") "_" "2")
+ ", "
+ (math (var "p") "_" "3")
+ ",
+ and "
+ (math (var "p") "_" "4")
+ ").
+ The altitude of a terrain vertex is computed by the "
+ (code "GL_OBJECT_LINEAR")
+ "
+coordinate generation function as its distance from sea level;
+ that altitude can then be used to index the texture image to map white snow
+ onto peaks and green grass onto foothills. ")
+ (para "
+If the texture generation function is "
+ (code "GL_EYE_LINEAR")
+ ", the function ")
+ (para (math (var "g")
+ "="
+ (var "p")
+ "_"
+ "1"
+ ","
+ "^"
+ "″"
+ "×"
+ (var "x")
+ "_"
+ (var "e")
+ "+"
+ (var "p")
+ "_"
+ "2"
+ ","
+ "^"
+ "″"
+ "×"
+ (var "y")
+ "_"
+ (var "e")
+ "+"
+ (var "p")
+ "_"
+ "3"
+ ","
+ "^"
+ "″"
+ "×"
+ (var "z")
+ "_"
+ (var "e")
+ "+"
+ (var "p")
+ "_"
+ "4"
+ ","
+ "^"
+ "″"
+ "×"
+ (var "w")
+ "_"
+ (var "e")))
+ (para "
+is used, where ")
+ (para (math "("
+ (var "p")
+ "_"
+ "1"
+ ","
+ "^"
+ "″"
+ "\u2062"
+ (var "p")
+ "_"
+ "2"
+ ","
+ "^"
+ "″"
+ "\u2062"
+ (var "p")
+ "_"
+ "3"
+ ","
+ "^"
+ "″"
+ "\u2062"
+ (var "p")
+ "_"
+ "4"
+ ","
+ "^"
+ "″"
+ ","
+ ")"
+ "="
+ "("
+ (var "p")
+ "_"
+ "1"
+ "\u2062"
+ (var "p")
+ "_"
+ "2"
+ "\u2062"
+ (var "p")
+ "_"
+ "3"
+ "\u2062"
+ (var "p")
+ "_"
+ "4"
+ ","
+ ")"
+ "\u2062"
+ (var "M")
+ "^"
+ "-1"))
+ (para "
+and "
+ (math (var "x") "_" (var "e"))
+ ", "
+ (math (var "y") "_" (var "e"))
+ ", "
+ (math (var "z") "_" (var "e"))
+ ",
+ and "
+ (math (var "w") "_" (var "e"))
+ "
+are the eye coordinates of the vertex, "
+ (math (var "p") "_" "1")
+ ", "
+ (math (var "p") "_" "2")
+ ", "
+ (math (var "p") "_" "3")
+ ",
+ and "
+ (math (var "p") "_" "4")
+ "
+are the values supplied in "
+ (var "params")
+ ", and "
+ (math (var "M"))
+ "
+is the modelview matrix when "
+ (code "glTexGen")
+ " is invoked.
+ If "
+ (math (var "M"))
+ "
+is poorly conditioned or singular,
+ texture coordinates generated by the resulting function may be inaccurate
+ or undefined. ")
+ (para "
+Note that the values in "
+ (var "params")
+ " define a reference plane in eye coordinates.
+ The modelview matrix that is applied to them may not be the same one
+ in effect when the polygon vertices are transformed.
+ This function establishes a field of texture coordinates
+ that can produce dynamic contour lines on moving objects. ")
+ (para "
+If the texture generation function is "
+ (code "GL_SPHERE_MAP")
+ " and "
+ (var "coord")
+ " is either "
+ (code "GL_S")
+ " or "
+ (code "GL_T")
+ ", "
+ (math (var "s"))
+ "
+and "
+ (math (var "t"))
+ "
+texture coordinates are generated as follows.
+ Let "
+ (var "u")
+ " be the unit vector pointing from the origin to the polygon vertex
+ (in eye coordinates).
+ Let "
+ (var "n")
+ " sup prime be the current normal,
+ after transformation to eye coordinates.
+ Let ")
+ (para (math (var "f")
+ "="
+ "("
+ (var "f")
+ "_"
+ (var "x")
+ "\u2062"
+ (var "f")
+ "_"
+ (var "y")
+ "\u2062"
+ (var "f")
+ "_"
+ (var "z")
+ ","
+ ")"
+ "^"
+ (var "T"))
+ "
+be the reflection vector such that ")
+ (para (math (var "f")
+ "="
+ (var "u")
+ "-"
+ "2"
+ "\u2062"
+ (var "n")
+ "^"
+ "″"
+ "\u2062"
+ (var "n")
+ "^"
+ "″"
+ ","
+ "^"
+ (var "T")
+ "\u2062"
+ (var "u")))
+ (para "
+Finally, let "
+ (math (var "m")
+ "="
+ "2"
+ "\u2062"
+ "√"
+ "("
+ (var "f")
+ "_"
+ (var "x")
+ ","
+ "^"
+ "2"
+ "+"
+ (var "f")
+ "_"
+ (var "y")
+ ","
+ "^"
+ "2"
+ "+"
+ "("
+ (var "f")
+ "_"
+ (var "z")
+ "+"
+ "1"
+ ","
+ ")"
+ "^"
+ "2"
+ ","
+ ")")
+ ".
+ Then the values assigned to the "
+ (math (var "s"))
+ "
+and "
+ (math (var "t"))
+ "
+texture coordinates are ")
+ (para (math (var "s")
+ "="
+ (var "f")
+ "_"
+ (var "x")
+ "/"
+ (var "m")
+ "+"
+ "1"
+ "/"
+ "2"))
+ (para (math (var "t")
+ "="
+ (var "f")
+ "_"
+ (var "y")
+ "/"
+ (var "m")
+ "+"
+ "1"
+ "/"
+ "2"))
+ (para "
+To enable or disable a texture-coordinate generation function, call "
+ (code "glEnable")
+ " or "
+ (code "glDisable")
+ "
+with one of the symbolic texture-coordinate names
+ ("
+ (code "GL_TEXTURE_GEN_S")
+ ", "
+ (code "GL_TEXTURE_GEN_T")
+ ", "
+ (code "GL_TEXTURE_GEN_R")
+ ", or "
+ (code "GL_TEXTURE_GEN_Q")
+ ") as the argument.
+ When enabled,
+ the specified texture coordinate is computed
+ according to the generating function associated with that coordinate.
+ When disabled,
+ subsequent vertices take the specified texture coordinate
+ from the current set of texture coordinates. Initially, all texture
+ generation functions are set to "
+ (code "GL_EYE_LINEAR")
+ " and are disabled.
+ Both "
+ (math (var "s"))
+ "
+plane equations are (1, 0, 0, 0),
+ both "
+ (math (var "t"))
+ "
+plane equations are (0, 1, 0, 0),
+ and all "
+ (math (var "r"))
+ "
+and "
+ (math (var "q"))
+ "
+plane equations are (0, 0, 0, 0). ")
+ (para "
+When the "
+ (code "ARB_multitexture")
+ " extension is supported, "
+ (code "glTexGen")
+ " sets the
+ texture generation parameters for the currently active texture unit,
+ selected with "
+ (code "glActiveTexture")
+ ". ")
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated when "
+ (var "coord")
+ " or "
+ (var "pname")
+ " is not an
+ accepted defined value,
+ or when "
+ (var "pname")
+ " is "
+ (code "GL_TEXTURE_GEN_MODE")
+ " and "
+ (var "params")
+ " is not an
+ accepted defined value. ")
+ (para (code "GL_INVALID_ENUM")
+ " is generated when "
+ (var "pname")
+ " is "
+ (code "GL_TEXTURE_GEN_MODE")
+ ", "
+ (var "params")
+ " is "
+ (code "GL_SPHERE_MAP")
+ ",
+ and "
+ (var "coord")
+ " is either "
+ (code "GL_R")
+ " or "
+ (code "GL_Q")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glTexGen")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glTexImage1D
+ "glTexImage1D"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glTexImage1D"))
+ (paramdef "GLenum " (parameter "target"))
+ (paramdef "GLint " (parameter "level"))
+ (paramdef "GLint " (parameter "internalFormat"))
+ (paramdef "GLsizei " (parameter "width"))
+ (paramdef "GLint " (parameter "border"))
+ (paramdef "GLenum " (parameter "format"))
+ (paramdef "GLenum " (parameter "type"))
+ (paramdef "const GLvoid * " (parameter "data"))))
+ '(*fragment*
+ (heading
+ "specify a one-dimensional texture image")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "target")))
+ (para "
+Specifies the target texture.
+ Must be "
+ (code "GL_TEXTURE_1D")
+ " or "
+ (code "GL_PROXY_TEXTURE_1D")
+ ". "))
+ (entry (% (heading (var "level")))
+ (para "
+Specifies the level-of-detail number.
+ Level 0 is the base image level.
+ Level "
+ (var "n")
+ " is the "
+ (var "n")
+ "th mipmap reduction image. "))
+ (entry (% (heading (var "internalFormat")))
+ (para "
+Specifies the number of color components in the texture.
+ Must be 1, 2, 3, or 4, or one of the following symbolic constants: "
+ (code "GL_ALPHA")
+ ", "
+ (code "GL_ALPHA4")
+ ", "
+ (code "GL_ALPHA8")
+ ", "
+ (code "GL_ALPHA12")
+ ", "
+ (code "GL_ALPHA16")
+ ", "
+ (code "GL_COMPRESSED_ALPHA")
+ ", "
+ (code "GL_COMPRESSED_LUMINANCE")
+ ", "
+ (code "GL_COMPRESSED_LUMINANCE_ALPHA")
+ ", "
+ (code "GL_COMPRESSED_INTENSITY")
+ ", "
+ (code "GL_COMPRESSED_RGB")
+ ", "
+ (code "GL_COMPRESSED_RGBA")
+ ", "
+ (code "GL_DEPTH_COMPONENT")
+ ", "
+ (code "GL_DEPTH_COMPONENT16")
+ ", "
+ (code "GL_DEPTH_COMPONENT24")
+ ", "
+ (code "GL_DEPTH_COMPONENT32")
+ ", "
+ (code "GL_LUMINANCE")
+ ", "
+ (code "GL_LUMINANCE4")
+ ", "
+ (code "GL_LUMINANCE8")
+ ", "
+ (code "GL_LUMINANCE12")
+ ", "
+ (code "GL_LUMINANCE16")
+ ", "
+ (code "GL_LUMINANCE_ALPHA")
+ ", "
+ (code "GL_LUMINANCE4_ALPHA4")
+ ", "
+ (code "GL_LUMINANCE6_ALPHA2")
+ ", "
+ (code "GL_LUMINANCE8_ALPHA8")
+ ", "
+ (code "GL_LUMINANCE12_ALPHA4")
+ ", "
+ (code "GL_LUMINANCE12_ALPHA12")
+ ", "
+ (code "GL_LUMINANCE16_ALPHA16")
+ ", "
+ (code "GL_INTENSITY")
+ ", "
+ (code "GL_INTENSITY4")
+ ", "
+ (code "GL_INTENSITY8")
+ ", "
+ (code "GL_INTENSITY12")
+ ", "
+ (code "GL_INTENSITY16")
+ ", "
+ (code "GL_R3_G3_B2")
+ ", "
+ (code "GL_RGB")
+ ", "
+ (code "GL_RGB4")
+ ", "
+ (code "GL_RGB5")
+ ", "
+ (code "GL_RGB8")
+ ", "
+ (code "GL_RGB10")
+ ", "
+ (code "GL_RGB12")
+ ", "
+ (code "GL_RGB16")
+ ", "
+ (code "GL_RGBA")
+ ", "
+ (code "GL_RGBA2")
+ ", "
+ (code "GL_RGBA4")
+ ", "
+ (code "GL_RGB5_A1")
+ ", "
+ (code "GL_RGBA8")
+ ", "
+ (code "GL_RGB10_A2")
+ ", "
+ (code "GL_RGBA12")
+ ", "
+ (code "GL_RGBA16")
+ ", "
+ (code "GL_SLUMINANCE")
+ ", "
+ (code "GL_SLUMINANCE8")
+ ", "
+ (code "GL_SLUMINANCE_ALPHA")
+ ", "
+ (code "GL_SLUMINANCE8_ALPHA8")
+ ", "
+ (code "GL_SRGB")
+ ", "
+ (code "GL_SRGB8")
+ ", "
+ (code "GL_SRGB_ALPHA")
+ ", or "
+ (code "GL_SRGB8_ALPHA8")
+ ". "))
+ (entry (% (heading (var "width")))
+ (para "
+Specifies the width of the texture image including the border if any. If the GL version does not support non-power-of-two sizes, this value must be "
+ (math "2"
+ "^"
+ (var "n")
+ "+"
+ "2"
+ "\u2061"
+ "("
+ (var "border")
+ ","
+ ")")
+ "
+for some integer "
+ (math (var "n"))
+ ".
+ All
+ implementations support texture images that are at least 64 texels
+ wide. The height of the 1D texture image is 1. "))
+ (entry (% (heading (var "border")))
+ (para "
+Specifies the width of the border.
+ Must be either 0 or 1. "))
+ (entry (% (heading (var "format")))
+ (para "
+Specifies the format of the pixel data.
+ The following symbolic values are accepted: "
+ (code "GL_COLOR_INDEX")
+ ", "
+ (code "GL_RED")
+ ", "
+ (code "GL_GREEN")
+ ", "
+ (code "GL_BLUE")
+ ", "
+ (code "GL_ALPHA")
+ ", "
+ (code "GL_RGB")
+ ", "
+ (code "GL_BGR")
+ ", "
+ (code "GL_RGBA")
+ ", "
+ (code "GL_BGRA")
+ ", "
+ (code "GL_LUMINANCE")
+ ", and "
+ (code "GL_LUMINANCE_ALPHA")
+ ". "))
+ (entry (% (heading (var "type")))
+ (para "
+Specifies the data type of the pixel data.
+ The following symbolic values are accepted: "
+ (code "GL_UNSIGNED_BYTE")
+ ", "
+ (code "GL_BYTE")
+ ", "
+ (code "GL_BITMAP")
+ ", "
+ (code "GL_UNSIGNED_SHORT")
+ ", "
+ (code "GL_SHORT")
+ ", "
+ (code "GL_UNSIGNED_INT")
+ ", "
+ (code "GL_INT")
+ ", "
+ (code "GL_FLOAT")
+ ", "
+ (code "GL_UNSIGNED_BYTE_3_3_2")
+ ", "
+ (code "GL_UNSIGNED_BYTE_2_3_3_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_6_5")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_6_5_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_4_4_4_4")
+ ", "
+ (code "GL_UNSIGNED_SHORT_4_4_4_4_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_5_5_1")
+ ", "
+ (code "GL_UNSIGNED_SHORT_1_5_5_5_REV")
+ ", "
+ (code "GL_UNSIGNED_INT_8_8_8_8")
+ ", "
+ (code "GL_UNSIGNED_INT_8_8_8_8_REV")
+ ", "
+ (code "GL_UNSIGNED_INT_10_10_10_2")
+ ", and "
+ (code "GL_UNSIGNED_INT_2_10_10_10_REV")
+ ". "))
+ (entry (% (heading (var "data")))
+ (para "
+Specifies a pointer to the image data in memory. ")))
+ (heading "Description")
+ (para "
+Texturing maps a portion of a specified texture image
+ onto each graphical primitive for which texturing is enabled.
+ To enable and disable one-dimensional texturing, call "
+ (code "glEnable")
+ "
+and "
+ (code "glDisable")
+ " with argument "
+ (code "GL_TEXTURE_1D")
+ ". ")
+ (para "
+Texture images are defined with "
+ (code "glTexImage1D")
+ ".
+ The arguments describe the parameters of the texture image,
+ such as width,
+ width of the border,
+ level-of-detail number
+ (see "
+ (code "glTexParameter")
+ "),
+ and the internal resolution and format used to store the image.
+ The last three arguments describe how the image is represented in
+ memory; they are identical to the pixel formats used for "
+ (code "glDrawPixels")
+ ". ")
+ (para "
+If "
+ (var "target")
+ " is "
+ (code "GL_PROXY_TEXTURE_1D")
+ ", no data is read from "
+ (var "data")
+ ", but
+ all of the texture image state is recalculated, checked for
+ consistency, and checked against the implementation's capabilities.
+ If the implementation cannot handle a texture of the
+ requested texture size, it sets all of the image state to 0,
+ but does not generate an error (see "
+ (code "glGetError")
+ "). To query for an
+ entire mipmap array, use an image array level greater than or equal to
+ 1. ")
+ (para "
+If "
+ (var "target")
+ " is "
+ (code "GL_TEXTURE_1D")
+ ",
+ data is read from "
+ (var "data")
+ " as a sequence of signed or unsigned bytes,
+ shorts,
+ or longs,
+ or single-precision floating-point values,
+ depending on "
+ (var "type")
+ ".
+ These values are grouped into sets of one,
+ two,
+ three,
+ or four values,
+ depending on "
+ (var "format")
+ ",
+ to form elements.
+ If "
+ (var "type")
+ " is "
+ (code "GL_BITMAP")
+ ",
+ the data is considered as a string of unsigned bytes
+ (and "
+ (var "format")
+ " must be "
+ (code "GL_COLOR_INDEX")
+ ").
+ Each data byte is treated as eight 1-bit elements,
+ with bit ordering determined by "
+ (code "GL_UNPACK_LSB_FIRST")
+ "
+(see "
+ (code "glPixelStore")
+ "). ")
+ (para "
+If a non-zero named buffer object is bound to the "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ " target
+ (see "
+ (code "glBindBuffer")
+ ") while a texture image is
+ specified, "
+ (var "data")
+ " is treated as a byte offset into the buffer object's data store. ")
+ (para "
+The first element corresponds to the left end of the texture array.
+ Subsequent elements progress left-to-right through the remaining texels
+ in the texture array.
+ The final element corresponds to the right end of the texture array. ")
+ (para (var "format")
+ " determines the composition of each element in "
+ (var "data")
+ ".
+ It can assume one of these symbolic values: ")
+ (table (% (formatter (asis)))
+ (entry (% (heading (code "GL_COLOR_INDEX")))
+ (para "
+Each element is a single value,
+ a color index.
+ The GL converts it to fixed point
+ (with an unspecified number of zero bits to the right of the binary point),
+ shifted left or right depending on the value and sign of "
+ (code "GL_INDEX_SHIFT")
+ ",
+ and added to "
+ (code "GL_INDEX_OFFSET")
+ "
+(see "
+ (code "glPixelTransfer")
+ ").
+ The resulting index is converted to a set of color components
+ using the "
+ (code "GL_PIXEL_MAP_I_TO_R")
+ ", "
+ (code "GL_PIXEL_MAP_I_TO_G")
+ ", "
+ (code "GL_PIXEL_MAP_I_TO_B")
+ ", and "
+ (code "GL_PIXEL_MAP_I_TO_A")
+ " tables,
+ and clamped to the range [0,1]. "))
+ (entry (% (heading (code "GL_RED")))
+ (para "
+Each element is a single red component.
+ The GL converts it to floating point and assembles it into an RGBA element
+ by attaching 0 for green and blue, and 1 for alpha.
+ Each component is then multiplied by the signed scale factor "
+ (code "GL_c_SCALE")
+ ",
+ added to the signed bias "
+ (code "GL_c_BIAS")
+ ",
+ and clamped to the range [0,1]
+ (see "
+ (code "glPixelTransfer")
+ "). "))
+ (entry (% (heading (code "GL_GREEN")))
+ (para "
+Each element is a single green component.
+ The GL converts it to floating point and assembles it into an RGBA element
+ by attaching 0 for red and blue, and 1 for alpha.
+ Each component is then multiplied by the signed scale factor "
+ (code "GL_c_SCALE")
+ ",
+ added to the signed bias "
+ (code "GL_c_BIAS")
+ ",
+ and clamped to the range [0,1]
+ (see "
+ (code "glPixelTransfer")
+ "). "))
+ (entry (% (heading (code "GL_BLUE")))
+ (para "
+Each element is a single blue component.
+ The GL converts it to floating point and assembles it into an RGBA element
+ by attaching 0 for red and green, and 1 for alpha.
+ Each component is then multiplied by the signed scale factor "
+ (code "GL_c_SCALE")
+ ",
+ added to the signed bias "
+ (code "GL_c_BIAS")
+ ",
+ and clamped to the range [0,1]
+ (see "
+ (code "glPixelTransfer")
+ "). "))
+ (entry (% (heading (code "GL_ALPHA")))
+ (para "
+Each element is a single alpha component.
+ The GL converts it to floating point and assembles it into an RGBA element
+ by attaching 0 for red, green, and blue.
+ Each component is then multiplied by the signed scale factor "
+ (code "GL_c_SCALE")
+ ",
+ added to the signed bias "
+ (code "GL_c_BIAS")
+ ",
+ and clamped to the range [0,1]
+ (see "
+ (code "glPixelTransfer")
+ "). "))
+ (entry (% (heading (code "GL_INTENSITY")))
+ (para "
+Each element is a single intensity value.
+ The GL converts it to floating point,
+ then assembles it into an RGBA element by replicating the intensity value
+ three times for red, green, blue, and alpha.
+ Each component is then multiplied by the signed scale factor "
+ (code "GL_c_SCALE")
+ ",
+ added to the signed bias "
+ (code "GL_c_BIAS")
+ ",
+ and clamped to the range [0,1]
+ (see "
+ (code "glPixelTransfer")
+ "). "))
+ (entry (% (heading (code "GL_RGB"))))
+ (entry (% (heading (code "GL_BGR")))
+ (para "
+Each element is an RGB triple.
+ The GL converts it to floating point and assembles it into an RGBA element
+ by attaching 1 for alpha.
+ Each component is then multiplied by the signed scale factor "
+ (code "GL_c_SCALE")
+ ",
+ added to the signed bias "
+ (code "GL_c_BIAS")
+ ",
+ and clamped to the range [0,1]
+ (see "
+ (code "glPixelTransfer")
+ "). "))
+ (entry (% (heading (code "GL_RGBA"))))
+ (entry (% (heading (code "GL_BGRA")))
+ (para "
+Each element contains all four components.
+ Each component is multiplied by the signed scale factor "
+ (code "GL_c_SCALE")
+ ",
+ added to the signed bias "
+ (code "GL_c_BIAS")
+ ",
+ and clamped to the range [0,1]
+ (see "
+ (code "glPixelTransfer")
+ "). "))
+ (entry (% (heading (code "GL_LUMINANCE")))
+ (para "
+Each element is a single luminance value.
+ The GL converts it to floating point,
+ then assembles it into an RGBA element by replicating the luminance value
+ three times for red, green, and blue and attaching 1 for alpha.
+ Each component is then multiplied by the signed scale factor "
+ (code "GL_c_SCALE")
+ ",
+ added to the signed bias "
+ (code "GL_c_BIAS")
+ ",
+ and clamped to the range [0,1]
+ (see "
+ (code "glPixelTransfer")
+ "). "))
+ (entry (% (heading (code "GL_LUMINANCE_ALPHA")))
+ (para "
+Each element is a luminance/alpha pair.
+ The GL converts it to floating point,
+ then assembles it into an RGBA element by replicating the luminance value
+ three times for red, green, and blue.
+ Each component is then multiplied by the signed scale factor "
+ (code "GL_c_SCALE")
+ ",
+ added to the signed bias "
+ (code "GL_c_BIAS")
+ ",
+ and clamped to the range [0,1] (see "
+ (code "glPixelTransfer")
+ "). "))
+ (entry (% (heading (code "GL_DEPTH_COMPONENT")))
+ (para "
+Each element is a single depth value.
+ The GL converts it to floating point, multiplies by the signed scale factor "
+ (code "GL_DEPTH_SCALE")
+ ", adds the signed bias "
+ (code "GL_DEPTH_BIAS")
+ ",
+ and clamps to the range [0,1] (see "
+ (code "glPixelTransfer")
+ "). ")))
+ (para "
+Refer to the "
+ (code "glDrawPixels")
+ " reference page for a description of
+ the acceptable values for the "
+ (var "type")
+ " parameter. ")
+ (para "
+If an application wants to store the texture at a certain
+ resolution or in a certain format, it can request the resolution
+ and format with "
+ (var "internalFormat")
+ ". The GL will choose an internal
+ representation that closely approximates that requested by "
+ (var "internalFormat")
+ ", but
+ it may not match exactly.
+ (The representations specified by "
+ (code "GL_LUMINANCE")
+ ", "
+ (code "GL_LUMINANCE_ALPHA")
+ ", "
+ (code "GL_RGB")
+ ",
+ and "
+ (code "GL_RGBA")
+ " must match exactly. The numeric values 1, 2, 3, and 4
+ may also be used to specify the above representations.) ")
+ (para "
+If the "
+ (var "internalFormat")
+ " parameter is one of the generic compressed formats,\t"
+ (code "GL_COMPRESSED_ALPHA")
+ ",\t"
+ (code "GL_COMPRESSED_INTENSITY")
+ ",\t"
+ (code "GL_COMPRESSED_LUMINANCE")
+ ",\t"
+ (code "GL_COMPRESSED_LUMINANCE_ALPHA")
+ ",\t"
+ (code "GL_COMPRESSED_RGB")
+ ", or\t"
+ (code "GL_COMPRESSED_RGBA")
+ ", the GL will replace the internal format with the symbolic constant for a specific internal format and compress the texture before storage. If no corresponding internal format is available, or the GL can not compress that image for any reason, the internal format is instead replaced with a corresponding base internal format. ")
+ (para "
+If the "
+ (var "internalFormat")
+ " parameter is "
+ (code "GL_SRGB")
+ ",\t"
+ (code "GL_SRGB8")
+ ",\t"
+ (code "GL_SRGB_ALPHA")
+ ",\t"
+ (code "GL_SRGB8_ALPHA8")
+ ",\t"
+ (code "GL_SLUMINANCE")
+ ",\t"
+ (code "GL_SLUMINANCE8")
+ ",\t"
+ (code "GL_SLUMINANCE_ALPHA")
+ ", or\t"
+ (code "GL_SLUMINANCE8_ALPHA8")
+ ", the texture is treated as if the red, green, blue, or luminance components are encoded in the sRGB color space. Any alpha component is left unchanged. The conversion from the sRGB encoded component\t"
+ (math (var "c") "_" (var "s"))
+ "
+to a linear component\t"
+ (math (var "c") "_" (var "l"))
+ "
+is:\t")
+ (para (math (var "c")
+ "_"
+ (var "l")
+ "="
+ "{"
+ "("
+ (var "c")
+ "_"
+ (var "s")
+ "/"
+ "12.92"
+ " "
+ " "
+ "if"
+ " "
+ (var "c")
+ "_"
+ (var "s")
+ "≤"
+ "0.04045"
+ ")"
+ ", "
+ "("
+ "("
+ (code "c")
+ "_"
+ (code "s")
+ "+"
+ "0.055"
+ "/"
+ "1.055"
+ ")"
+ "^"
+ "2.4"
+ " "
+ " "
+ "if"
+ " "
+ (var "c")
+ "_"
+ (var "s")
+ ">"
+ "0.04045"
+ ")"))
+ (para "
+Assume\t"
+ (math (var "c") "_" (var "s"))
+ "
+is the sRGB component in the range [0,1]. ")
+ (para "
+Use the "
+ (code "GL_PROXY_TEXTURE_1D")
+ " target to try out a resolution and
+ format. The implementation will
+ update and recompute its best match for the requested storage resolution
+ and format. To then query this state, call "
+ (code "glGetTexLevelParameter")
+ ".
+ If the texture cannot be accommodated, texture state is set to 0. ")
+ (para "
+A one-component texture image uses only the red component of the RGBA
+ color from "
+ (var "data")
+ ".
+ A two-component image uses the R and A values.
+ A three-component image uses the R, G, and B values.
+ A four-component image uses all of the RGBA components. ")
+ (para "
+Depth textures can be treated as LUMINANCE, INTENSITY or ALPHA textures during texture filtering and application.\xa0Image-based shadowing\xa0can\xa0be\xa0enabled\xa0by\xa0comparing texture r coordinates to depth texture values to generate a boolean result. See "
+ (code "glTexParameter")
+ " for details on texture comparison. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "target")
+ " is not "
+ (code "GL_TEXTURE_1D")
+ "
+or "
+ (code "GL_PROXY_TEXTURE_1D")
+ ". ")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "format")
+ " is not an accepted
+ format constant. Format constants other than "
+ (code "GL_STENCIL_INDEX")
+ "
+are accepted. ")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "type")
+ " is not a type constant. ")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "type")
+ " is "
+ (code "GL_BITMAP")
+ " and "
+ (var "format")
+ " is not "
+ (code "GL_COLOR_INDEX")
+ ". ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "level")
+ " is less than 0. ")
+ (para (code "GL_INVALID_VALUE")
+ " may be generated if "
+ (var "level")
+ " is greater than "
+ (math (var "log")
+ "_"
+ "2"
+ "\u2061"
+ "("
+ (var "max")
+ ","
+ ")")
+ ",
+ where "
+ (var "max")
+ " is the returned value of "
+ (code "GL_MAX_TEXTURE_SIZE")
+ ". ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "internalFormat")
+ " is not 1, 2, 3, 4, or
+ one of the accepted resolution and format symbolic constants. ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "width")
+ " is less than 0
+ or greater than 2 + "
+ (code "GL_MAX_TEXTURE_SIZE")
+ ". ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if non-power-of-two textures are not supported and the "
+ (var "width")
+ " cannot be represented as\t"
+ (math "2"
+ "^"
+ (var "n")
+ "+"
+ "2"
+ "\u2061"
+ "("
+ (var "border")
+ ","
+ ")")
+ "
+for some integer value of "
+ (var "n")
+ ". ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "border")
+ " is not 0 or 1. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (var "type")
+ " is one of "
+ (code "GL_UNSIGNED_BYTE_3_3_2")
+ ", "
+ (code "GL_UNSIGNED_BYTE_2_3_3_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_6_5")
+ ", or "
+ (code "GL_UNSIGNED_SHORT_5_6_5_REV")
+ "
+and "
+ (var "format")
+ " is not "
+ (code "GL_RGB")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (var "type")
+ " is one of "
+ (code "GL_UNSIGNED_SHORT_4_4_4_4")
+ ", "
+ (code "GL_UNSIGNED_SHORT_4_4_4_4_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_5_5_1")
+ ", "
+ (code "GL_UNSIGNED_SHORT_1_5_5_5_REV")
+ ", "
+ (code "GL_UNSIGNED_INT_8_8_8_8")
+ ", "
+ (code "GL_UNSIGNED_INT_8_8_8_8_REV")
+ ", "
+ (code "GL_UNSIGNED_INT_10_10_10_2")
+ ", or "
+ (code "GL_UNSIGNED_INT_2_10_10_10_REV")
+ "
+and "
+ (var "format")
+ " is neither "
+ (code "GL_RGBA")
+ " nor "
+ (code "GL_BGRA")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (var "format")
+ " is "
+ (code "GL_DEPTH_COMPONENT")
+ " and "
+ (var "internalFormat")
+ " is not "
+ (code "GL_DEPTH_COMPONENT")
+ ", "
+ (code "GL_DEPTH_COMPONENT16")
+ ", "
+ (code "GL_DEPTH_COMPONENT24")
+ ", or "
+ (code "GL_DEPTH_COMPONENT32")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (var "internalFormat")
+ " is "
+ (code "GL_DEPTH_COMPONENT")
+ ", "
+ (code "GL_DEPTH_COMPONENT16")
+ ", "
+ (code "GL_DEPTH_COMPONENT24")
+ ", or "
+ (code "GL_DEPTH_COMPONENT32")
+ ", and "
+ (var "format")
+ " is
+ not "
+ (code "GL_DEPTH_COMPONENT")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a non-zero buffer object name is bound to the "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ " target and the buffer object's data store is currently mapped. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a non-zero buffer object name is bound to the "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ " target and the data would be unpacked from the buffer
+ object such that the memory reads required would exceed the data store size. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a non-zero buffer object name is bound to the "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ " target and "
+ (var "data")
+ " is not evenly divisible
+ into the number of bytes needed to store in memory a datum indicated by "
+ (var "type")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glTexImage1D")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glTexImage2D
+ "glTexImage2D"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glTexImage2D"))
+ (paramdef "GLenum " (parameter "target"))
+ (paramdef "GLint " (parameter "level"))
+ (paramdef "GLint " (parameter "internalFormat"))
+ (paramdef "GLsizei " (parameter "width"))
+ (paramdef "GLsizei " (parameter "height"))
+ (paramdef "GLint " (parameter "border"))
+ (paramdef "GLenum " (parameter "format"))
+ (paramdef "GLenum " (parameter "type"))
+ (paramdef "const GLvoid * " (parameter "data"))))
+ '(*fragment*
+ (heading
+ "specify a two-dimensional texture image")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "target")))
+ (para "
+Specifies the target texture.
+ Must be "
+ (code "GL_TEXTURE_2D")
+ ", "
+ (code "GL_PROXY_TEXTURE_2D")
+ ", "
+ (code "GL_TEXTURE_CUBE_MAP_POSITIVE_X")
+ ", "
+ (code "GL_TEXTURE_CUBE_MAP_NEGATIVE_X")
+ ", "
+ (code "GL_TEXTURE_CUBE_MAP_POSITIVE_Y")
+ ", "
+ (code "GL_TEXTURE_CUBE_MAP_NEGATIVE_Y")
+ ", "
+ (code "GL_TEXTURE_CUBE_MAP_POSITIVE_Z")
+ ", "
+ (code "GL_TEXTURE_CUBE_MAP_NEGATIVE_Z")
+ ", or "
+ (code "GL_PROXY_TEXTURE_CUBE_MAP")
+ ". "))
+ (entry (% (heading (var "level")))
+ (para "
+Specifies the level-of-detail number.
+ Level 0 is the base image level.
+ Level "
+ (var "n")
+ " is the "
+ (var "n")
+ "th mipmap reduction image. "))
+ (entry (% (heading (var "internalFormat")))
+ (para "
+Specifies the number of color components in the texture.
+ Must be 1, 2, 3, or 4, or one of the following symbolic constants: "
+ (code "GL_ALPHA")
+ ", "
+ (code "GL_ALPHA4")
+ ", "
+ (code "GL_ALPHA8")
+ ", "
+ (code "GL_ALPHA12")
+ ", "
+ (code "GL_ALPHA16")
+ ", "
+ (code "GL_COMPRESSED_ALPHA")
+ ", "
+ (code "GL_COMPRESSED_LUMINANCE")
+ ", "
+ (code "GL_COMPRESSED_LUMINANCE_ALPHA")
+ ", "
+ (code "GL_COMPRESSED_INTENSITY")
+ ", "
+ (code "GL_COMPRESSED_RGB")
+ ", "
+ (code "GL_COMPRESSED_RGBA")
+ ", "
+ (code "GL_DEPTH_COMPONENT")
+ ", "
+ (code "GL_DEPTH_COMPONENT16")
+ ", "
+ (code "GL_DEPTH_COMPONENT24")
+ ", "
+ (code "GL_DEPTH_COMPONENT32")
+ ", "
+ (code "GL_LUMINANCE")
+ ", "
+ (code "GL_LUMINANCE4")
+ ", "
+ (code "GL_LUMINANCE8")
+ ", "
+ (code "GL_LUMINANCE12")
+ ", "
+ (code "GL_LUMINANCE16")
+ ", "
+ (code "GL_LUMINANCE_ALPHA")
+ ", "
+ (code "GL_LUMINANCE4_ALPHA4")
+ ", "
+ (code "GL_LUMINANCE6_ALPHA2")
+ ", "
+ (code "GL_LUMINANCE8_ALPHA8")
+ ", "
+ (code "GL_LUMINANCE12_ALPHA4")
+ ", "
+ (code "GL_LUMINANCE12_ALPHA12")
+ ", "
+ (code "GL_LUMINANCE16_ALPHA16")
+ ", "
+ (code "GL_INTENSITY")
+ ", "
+ (code "GL_INTENSITY4")
+ ", "
+ (code "GL_INTENSITY8")
+ ", "
+ (code "GL_INTENSITY12")
+ ", "
+ (code "GL_INTENSITY16")
+ ", "
+ (code "GL_R3_G3_B2")
+ ", "
+ (code "GL_RGB")
+ ", "
+ (code "GL_RGB4")
+ ", "
+ (code "GL_RGB5")
+ ", "
+ (code "GL_RGB8")
+ ", "
+ (code "GL_RGB10")
+ ", "
+ (code "GL_RGB12")
+ ", "
+ (code "GL_RGB16")
+ ", "
+ (code "GL_RGBA")
+ ", "
+ (code "GL_RGBA2")
+ ", "
+ (code "GL_RGBA4")
+ ", "
+ (code "GL_RGB5_A1")
+ ", "
+ (code "GL_RGBA8")
+ ", "
+ (code "GL_RGB10_A2")
+ ", "
+ (code "GL_RGBA12")
+ ", "
+ (code "GL_RGBA16")
+ ", "
+ (code "GL_SLUMINANCE")
+ ", "
+ (code "GL_SLUMINANCE8")
+ ", "
+ (code "GL_SLUMINANCE_ALPHA")
+ ", "
+ (code "GL_SLUMINANCE8_ALPHA8")
+ ", "
+ (code "GL_SRGB")
+ ", "
+ (code "GL_SRGB8")
+ ", "
+ (code "GL_SRGB_ALPHA")
+ ", or "
+ (code "GL_SRGB8_ALPHA8")
+ ". "))
+ (entry (% (heading (var "width")))
+ (para "
+Specifies the width of the texture image including the border if any. If the GL version does not support non-power-of-two sizes, this value must be "
+ (math "2"
+ "^"
+ (var "n")
+ "+"
+ "2"
+ "\u2061"
+ "("
+ (var "border")
+ ","
+ ")")
+ "
+for some integer "
+ (math (var "n"))
+ ".
+ All
+ implementations support texture images that are at least 64 texels
+ wide. "))
+ (entry (% (heading (var "height")))
+ (para "
+Specifies the height of the texture image including the border if any. If the GL version does not support non-power-of-two sizes, this value must be "
+ (math "2"
+ "^"
+ (var "m")
+ "+"
+ "2"
+ "\u2061"
+ "("
+ (var "border")
+ ","
+ ")")
+ "
+for some integer "
+ (math (var "m"))
+ ".
+ All
+ implementations support texture images that are at least 64 texels
+ high. "))
+ (entry (% (heading (var "border")))
+ (para "
+Specifies the width of the border.
+ Must be either 0 or 1. "))
+ (entry (% (heading (var "format")))
+ (para "
+Specifies the format of the pixel data.
+ The following symbolic values are accepted: "
+ (code "GL_COLOR_INDEX")
+ ", "
+ (code "GL_RED")
+ ", "
+ (code "GL_GREEN")
+ ", "
+ (code "GL_BLUE")
+ ", "
+ (code "GL_ALPHA")
+ ", "
+ (code "GL_RGB")
+ ", "
+ (code "GL_BGR")
+ ", "
+ (code "GL_RGBA")
+ ", "
+ (code "GL_BGRA")
+ ", "
+ (code "GL_LUMINANCE")
+ ", and "
+ (code "GL_LUMINANCE_ALPHA")
+ ". "))
+ (entry (% (heading (var "type")))
+ (para "
+Specifies the data type of the pixel data.
+ The following symbolic values are accepted: "
+ (code "GL_UNSIGNED_BYTE")
+ ", "
+ (code "GL_BYTE")
+ ", "
+ (code "GL_BITMAP")
+ ", "
+ (code "GL_UNSIGNED_SHORT")
+ ", "
+ (code "GL_SHORT")
+ ", "
+ (code "GL_UNSIGNED_INT")
+ ", "
+ (code "GL_INT")
+ ", "
+ (code "GL_FLOAT")
+ ", "
+ (code "GL_UNSIGNED_BYTE_3_3_2")
+ ", "
+ (code "GL_UNSIGNED_BYTE_2_3_3_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_6_5")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_6_5_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_4_4_4_4")
+ ", "
+ (code "GL_UNSIGNED_SHORT_4_4_4_4_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_5_5_1")
+ ", "
+ (code "GL_UNSIGNED_SHORT_1_5_5_5_REV")
+ ", "
+ (code "GL_UNSIGNED_INT_8_8_8_8")
+ ", "
+ (code "GL_UNSIGNED_INT_8_8_8_8_REV")
+ ", "
+ (code "GL_UNSIGNED_INT_10_10_10_2")
+ ", and "
+ (code "GL_UNSIGNED_INT_2_10_10_10_REV")
+ ". "))
+ (entry (% (heading (var "data")))
+ (para "
+Specifies a pointer to the image data in memory. ")))
+ (heading "Description")
+ (para "
+Texturing maps a portion of a specified texture image onto each graphical primitive for which texturing is enabled. To enable and disable two-dimensional texturing, call "
+ (code "glEnable")
+ " and "
+ (code "glDisable")
+ " with argument "
+ (code "GL_TEXTURE_2D")
+ ". To enable and disable texturing using cube-mapped texture, call "
+ (code "glEnable")
+ " and "
+ (code "glDisable")
+ " with argument "
+ (code "GL_TEXTURE_CUBE_MAP")
+ ". ")
+ (para "
+To define texture images, call "
+ (code "glTexImage2D")
+ ".
+ The arguments describe the parameters of the texture image,
+ such as height,
+ width,
+ width of the border,
+ level-of-detail number
+ (see "
+ (code "glTexParameter")
+ "),
+ and number of color components provided.
+ The last three arguments describe how the image is represented in memory;
+ they are identical to the pixel formats used for "
+ (code "glDrawPixels")
+ ". ")
+ (para "
+If "
+ (var "target")
+ " is "
+ (code "GL_PROXY_TEXTURE_2D")
+ " or "
+ (code "GL_PROXY_TEXTURE_CUBE_MAP")
+ ", no data is read from "
+ (var "data")
+ ", but
+ all of the texture image state is recalculated, checked for
+ consistency, and checked
+ against the implementation's capabilities. If the implementation cannot
+ handle a texture of the requested texture size, it sets
+ all of the image state to 0,
+ but does not generate an error (see "
+ (code "glGetError")
+ "). To query for an
+ entire mipmap array, use an image array level greater than or equal to
+ 1. ")
+ (para "
+If "
+ (var "target")
+ " is "
+ (code "GL_TEXTURE_2D")
+ ", or one of the "
+ (code "GL_TEXTURE_CUBE_MAP")
+ "
+targets, data is read from "
+ (var "data")
+ " as a sequence of signed or unsigned
+ bytes, shorts, or longs, or single-precision floating-point values,
+ depending on "
+ (var "type")
+ ". These values are grouped into sets of one, two,
+ three, or four values, depending on "
+ (var "format")
+ ", to form elements. If "
+ (var "type")
+ "
+is "
+ (code "GL_BITMAP")
+ ", the data is considered as a string of unsigned bytes
+ (and "
+ (var "format")
+ " must be "
+ (code "GL_COLOR_INDEX")
+ ").
+ Each data byte is treated as eight 1-bit elements,
+ with bit ordering determined by "
+ (code "GL_UNPACK_LSB_FIRST")
+ "
+(see "
+ (code "glPixelStore")
+ "). ")
+ (para "
+If a non-zero named buffer object is bound to the "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ " target
+ (see "
+ (code "glBindBuffer")
+ ") while a texture image is
+ specified, "
+ (var "data")
+ " is treated as a byte offset into the buffer object's data store. ")
+ (para "
+The first element corresponds to the lower left corner of the texture
+ image.
+ Subsequent elements progress left-to-right through the remaining texels
+ in the lowest row of the texture image, and then in successively higher
+ rows of the texture image.
+ The final element corresponds to the upper right corner of the texture
+ image. ")
+ (para (var "format")
+ " determines the composition of each element in "
+ (var "data")
+ ".
+ It can assume one of these symbolic values: ")
+ (table (% (formatter (asis)))
+ (entry (% (heading (code "GL_COLOR_INDEX")))
+ (para "
+Each element is a single value,
+ a color index.
+ The GL converts it to fixed point
+ (with an unspecified number of zero bits to the right of the binary point),
+ shifted left or right depending on the value and sign of "
+ (code "GL_INDEX_SHIFT")
+ ",
+ and added to "
+ (code "GL_INDEX_OFFSET")
+ "
+(see "
+ (code "glPixelTransfer")
+ ").
+ The resulting index is converted to a set of color components
+ using the "
+ (code "GL_PIXEL_MAP_I_TO_R")
+ ", "
+ (code "GL_PIXEL_MAP_I_TO_G")
+ ", "
+ (code "GL_PIXEL_MAP_I_TO_B")
+ ", and "
+ (code "GL_PIXEL_MAP_I_TO_A")
+ " tables,
+ and clamped to the range [0,1]. "))
+ (entry (% (heading (code "GL_RED")))
+ (para "
+Each element is a single red component.
+ The GL converts it to floating point and assembles it into an RGBA element
+ by attaching 0 for green and blue, and 1 for alpha.
+ Each component is then multiplied by the signed scale factor "
+ (code "GL_c_SCALE")
+ ",
+ added to the signed bias "
+ (code "GL_c_BIAS")
+ ",
+ and clamped to the range [0,1]
+ (see "
+ (code "glPixelTransfer")
+ "). "))
+ (entry (% (heading (code "GL_GREEN")))
+ (para "
+Each element is a single green component.
+ The GL converts it to floating point and assembles it into an RGBA element
+ by attaching 0 for red and blue, and 1 for alpha.
+ Each component is then multiplied by the signed scale factor "
+ (code "GL_c_SCALE")
+ ",
+ added to the signed bias "
+ (code "GL_c_BIAS")
+ ",
+ and clamped to the range [0,1]
+ (see "
+ (code "glPixelTransfer")
+ "). "))
+ (entry (% (heading (code "GL_BLUE")))
+ (para "
+Each element is a single blue component.
+ The GL converts it to floating point and assembles it into an RGBA element
+ by attaching 0 for red and green, and 1 for alpha.
+ Each component is then multiplied by the signed scale factor "
+ (code "GL_c_SCALE")
+ ",
+ added to the signed bias "
+ (code "GL_c_BIAS")
+ ",
+ and clamped to the range [0,1]
+ (see "
+ (code "glPixelTransfer")
+ "). "))
+ (entry (% (heading (code "GL_ALPHA")))
+ (para "
+Each element is a single alpha component.
+ The GL converts it to floating point and assembles it into an RGBA element
+ by attaching 0 for red, green, and blue.
+ Each component is then multiplied by the signed scale factor "
+ (code "GL_c_SCALE")
+ ",
+ added to the signed bias "
+ (code "GL_c_BIAS")
+ ",
+ and clamped to the range [0,1]
+ (see "
+ (code "glPixelTransfer")
+ "). "))
+ (entry (% (heading (code "GL_INTENSITY")))
+ (para "
+Each element is a single intensity value.
+ The GL converts it to floating point,
+ then assembles it into an RGBA element by replicating the intensity value
+ three times for red, green, blue, and alpha.
+ Each component is then multiplied by the signed scale factor "
+ (code "GL_c_SCALE")
+ ",
+ added to the signed bias "
+ (code "GL_c_BIAS")
+ ",
+ and clamped to the range [0,1]
+ (see "
+ (code "glPixelTransfer")
+ "). "))
+ (entry (% (heading (code "GL_RGB"))))
+ (entry (% (heading (code "GL_BGR")))
+ (para "
+Each element is an RGB triple.
+ The GL converts it to floating point and assembles it into an RGBA element
+ by attaching 1 for alpha.
+ Each component is then multiplied by the signed scale factor "
+ (code "GL_c_SCALE")
+ ",
+ added to the signed bias "
+ (code "GL_c_BIAS")
+ ",
+ and clamped to the range [0,1]
+ (see "
+ (code "glPixelTransfer")
+ "). "))
+ (entry (% (heading (code "GL_RGBA"))))
+ (entry (% (heading (code "GL_BGRA")))
+ (para "
+Each element contains all four components.
+ Each component is multiplied by the signed scale factor "
+ (code "GL_c_SCALE")
+ ",
+ added to the signed bias "
+ (code "GL_c_BIAS")
+ ",
+ and clamped to the range [0,1]
+ (see "
+ (code "glPixelTransfer")
+ "). "))
+ (entry (% (heading (code "GL_LUMINANCE")))
+ (para "
+Each element is a single luminance value.
+ The GL converts it to floating point,
+ then assembles it into an RGBA element by replicating the luminance value
+ three times for red, green, and blue and attaching 1 for alpha.
+ Each component is then multiplied by the signed scale factor "
+ (code "GL_c_SCALE")
+ ",
+ added to the signed bias "
+ (code "GL_c_BIAS")
+ ",
+ and clamped to the range [0,1]
+ (see "
+ (code "glPixelTransfer")
+ "). "))
+ (entry (% (heading (code "GL_LUMINANCE_ALPHA")))
+ (para "
+Each element is a luminance/alpha pair.
+ The GL converts it to floating point,
+ then assembles it into an RGBA element by replicating the luminance value
+ three times for red, green, and blue.
+ Each component is then multiplied by the signed scale factor "
+ (code "GL_c_SCALE")
+ ",
+ added to the signed bias "
+ (code "GL_c_BIAS")
+ ",
+ and clamped to the range [0,1] (see "
+ (code "glPixelTransfer")
+ "). "))
+ (entry (% (heading (code "GL_DEPTH_COMPONENT")))
+ (para "
+Each element is a single depth value.
+ The GL converts it to floating point, multiplies by the signed scale factor "
+ (code "GL_DEPTH_SCALE")
+ ", adds the signed bias "
+ (code "GL_DEPTH_BIAS")
+ ",
+ and clamps to the range [0,1] (see "
+ (code "glPixelTransfer")
+ "). ")))
+ (para "
+Refer to the "
+ (code "glDrawPixels")
+ " reference page for a description of
+ the acceptable values for the "
+ (var "type")
+ " parameter. ")
+ (para "
+If an application wants to store the texture at a certain
+ resolution or in a certain format, it can request the resolution
+ and format with "
+ (var "internalFormat")
+ ". The GL will choose an internal
+ representation that closely approximates that requested by "
+ (var "internalFormat")
+ ", but
+ it may not match exactly.
+ (The representations specified by "
+ (code "GL_LUMINANCE")
+ ", "
+ (code "GL_LUMINANCE_ALPHA")
+ ", "
+ (code "GL_RGB")
+ ",
+ and "
+ (code "GL_RGBA")
+ " must match exactly. The numeric values 1, 2, 3, and 4
+ may also be used to specify the above representations.) ")
+ (para "
+If the "
+ (var "internalFormat")
+ " parameter is one of the generic compressed formats,\t"
+ (code "GL_COMPRESSED_ALPHA")
+ ",\t"
+ (code "GL_COMPRESSED_INTENSITY")
+ ",\t"
+ (code "GL_COMPRESSED_LUMINANCE")
+ ",\t"
+ (code "GL_COMPRESSED_LUMINANCE_ALPHA")
+ ",\t"
+ (code "GL_COMPRESSED_RGB")
+ ", or\t"
+ (code "GL_COMPRESSED_RGBA")
+ ", the GL will replace the internal format with the symbolic constant for a specific internal format and compress the texture before storage. If no corresponding internal format is available, or the GL can not compress that image for any reason, the internal format is instead replaced with a corresponding base internal format. ")
+ (para "
+If the "
+ (var "internalFormat")
+ " parameter is "
+ (code "GL_SRGB")
+ ",\t"
+ (code "GL_SRGB8")
+ ",\t"
+ (code "GL_SRGB_ALPHA")
+ ",\t"
+ (code "GL_SRGB8_ALPHA8")
+ ",\t"
+ (code "GL_SLUMINANCE")
+ ",\t"
+ (code "GL_SLUMINANCE8")
+ ",\t"
+ (code "GL_SLUMINANCE_ALPHA")
+ ", or\t"
+ (code "GL_SLUMINANCE8_ALPHA8")
+ ", the texture is treated as if the red, green, blue, or luminance components are encoded in the sRGB color space. Any alpha component is left unchanged. The conversion from the sRGB encoded component\t"
+ (math (var "c") "_" (var "s"))
+ "
+to a linear component\t"
+ (math (var "c") "_" (var "l"))
+ "
+is:\t")
+ (para (math (var "c")
+ "_"
+ (var "l")
+ "="
+ "{"
+ "("
+ (var "c")
+ "_"
+ (var "s")
+ "/"
+ "12.92"
+ " "
+ " "
+ "if"
+ " "
+ (var "c")
+ "_"
+ (var "s")
+ "≤"
+ "0.04045"
+ ")"
+ ", "
+ "("
+ "("
+ (code "c")
+ "_"
+ (code "s")
+ "+"
+ "0.055"
+ "/"
+ "1.055"
+ ")"
+ "^"
+ "2.4"
+ " "
+ " "
+ "if"
+ " "
+ (var "c")
+ "_"
+ (var "s")
+ ">"
+ "0.04045"
+ ")"))
+ (para "
+Assume\t"
+ (math (var "c") "_" (var "s"))
+ "
+is the sRGB component in the range [0,1]. ")
+ (para "
+Use the "
+ (code "GL_PROXY_TEXTURE_2D")
+ " or "
+ (code "GL_PROXY_TEXTURE_CUBE_MAP")
+ " target to try out a resolution and
+ format. The implementation will
+ update and recompute its best match for the requested storage resolution
+ and format. To then query this state, call "
+ (code "glGetTexLevelParameter")
+ ".
+ If the texture cannot be accommodated, texture state is set to 0. ")
+ (para "
+A one-component texture image uses only the red component of the RGBA
+ color extracted from "
+ (var "data")
+ ".
+ A two-component image uses the R and A values.
+ A three-component image uses the R, G, and B values.
+ A four-component image uses all of the RGBA components. ")
+ (para "
+Depth textures can be treated as LUMINANCE, INTENSITY or ALPHA textures during texture filtering and application.\xa0Image-based shadowing\xa0can\xa0be\xa0enabled\xa0by\xa0comparing texture r coordinates to depth texture values to generate a boolean result. See "
+ (code "glTexParameter")
+ " for details on texture comparison. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "target")
+ " is not "
+ (code "GL_TEXTURE_2D")
+ ", "
+ (code "GL_PROXY_TEXTURE_2D")
+ ", "
+ (code "GL_PROXY_TEXTURE_CUBE_MAP")
+ ",\t"
+ (code "GL_TEXTURE_CUBE_MAP_POSITIVE_X")
+ ",\t"
+ (code "GL_TEXTURE_CUBE_MAP_NEGATIVE_X")
+ ",\t"
+ (code "GL_TEXTURE_CUBE_MAP_POSITIVE_Y")
+ ",\t"
+ (code "GL_TEXTURE_CUBE_MAP_NEGATIVE_Y")
+ ",\t"
+ (code "GL_TEXTURE_CUBE_MAP_POSITIVE_Z")
+ ", or\t"
+ (code "GL_TEXTURE_CUBE_MAP_NEGATIVE_Z")
+ ". ")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "target")
+ " is one of the six cube map 2D image targets and the width and height parameters are not equal. ")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "type")
+ " is not a type constant. ")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "type")
+ " is "
+ (code "GL_BITMAP")
+ " and "
+ (var "format")
+ " is not "
+ (code "GL_COLOR_INDEX")
+ ". ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "width")
+ " or "
+ (var "height")
+ " is less than 0
+ or greater than 2 + "
+ (code "GL_MAX_TEXTURE_SIZE")
+ ". ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "level")
+ " is less than 0. ")
+ (para (code "GL_INVALID_VALUE")
+ " may be generated if "
+ (var "level")
+ " is greater than "
+ (math (var "log")
+ "_"
+ "2"
+ "\u2061"
+ "("
+ (var "max")
+ ","
+ ")")
+ ",
+ where "
+ (var "max")
+ " is the returned value of "
+ (code "GL_MAX_TEXTURE_SIZE")
+ ". ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "internalFormat")
+ " is not 1, 2, 3, 4, or one of the
+ accepted resolution and format symbolic constants. ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "width")
+ " or "
+ (var "height")
+ " is less than 0
+ or greater than 2 + "
+ (code "GL_MAX_TEXTURE_SIZE")
+ ". ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if non-power-of-two textures are not supported and the "
+ (var "width")
+ " or "
+ (var "height")
+ " cannot be represented as "
+ (math "2"
+ "^"
+ (var "k")
+ "+"
+ "2"
+ "\u2061"
+ "("
+ (var "border")
+ ","
+ ")")
+ "
+for some
+ integer value of "
+ (var "k")
+ ". ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "border")
+ " is not 0 or 1. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (var "type")
+ " is one of "
+ (code "GL_UNSIGNED_BYTE_3_3_2")
+ ", "
+ (code "GL_UNSIGNED_BYTE_2_3_3_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_6_5")
+ ", or "
+ (code "GL_UNSIGNED_SHORT_5_6_5_REV")
+ "
+and "
+ (var "format")
+ " is not "
+ (code "GL_RGB")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (var "type")
+ " is one of "
+ (code "GL_UNSIGNED_SHORT_4_4_4_4")
+ ", "
+ (code "GL_UNSIGNED_SHORT_4_4_4_4_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_5_5_1")
+ ", "
+ (code "GL_UNSIGNED_SHORT_1_5_5_5_REV")
+ ", "
+ (code "GL_UNSIGNED_INT_8_8_8_8")
+ ", "
+ (code "GL_UNSIGNED_INT_8_8_8_8_REV")
+ ", "
+ (code "GL_UNSIGNED_INT_10_10_10_2")
+ ", or "
+ (code "GL_UNSIGNED_INT_2_10_10_10_REV")
+ "
+and "
+ (var "format")
+ " is neither "
+ (code "GL_RGBA")
+ " nor "
+ (code "GL_BGRA")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (var "target")
+ " is not "
+ (code "GL_TEXTURE_2D")
+ " or "
+ (code "GL_PROXY_TEXTURE_2D")
+ " and "
+ (var "internalFormat")
+ " is "
+ (code "GL_DEPTH_COMPONENT")
+ ", "
+ (code "GL_DEPTH_COMPONENT16")
+ ", "
+ (code "GL_DEPTH_COMPONENT24")
+ ", or "
+ (code "GL_DEPTH_COMPONENT32")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (var "format")
+ " is "
+ (code "GL_DEPTH_COMPONENT")
+ " and "
+ (var "internalFormat")
+ " is not "
+ (code "GL_DEPTH_COMPONENT")
+ ", "
+ (code "GL_DEPTH_COMPONENT16")
+ ", "
+ (code "GL_DEPTH_COMPONENT24")
+ ", or "
+ (code "GL_DEPTH_COMPONENT32")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (var "internalFormat")
+ " is "
+ (code "GL_DEPTH_COMPONENT")
+ ", "
+ (code "GL_DEPTH_COMPONENT16")
+ ", "
+ (code "GL_DEPTH_COMPONENT24")
+ ", or "
+ (code "GL_DEPTH_COMPONENT32")
+ ", and "
+ (var "format")
+ " is
+ not "
+ (code "GL_DEPTH_COMPONENT")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a non-zero buffer object name is bound to the "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ " target and the buffer object's data store is currently mapped. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a non-zero buffer object name is bound to the "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ " target and the data would be unpacked from the buffer
+ object such that the memory reads required would exceed the data store size. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a non-zero buffer object name is bound to the "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ " target and "
+ (var "data")
+ " is not evenly divisible
+ into the number of bytes needed to store in memory a datum indicated by "
+ (var "type")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glTexImage2D")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glTexImage3D
+ "glTexImage3D"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glTexImage3D"))
+ (paramdef "GLenum " (parameter "target"))
+ (paramdef "GLint " (parameter "level"))
+ (paramdef "GLint " (parameter "internalFormat"))
+ (paramdef "GLsizei " (parameter "width"))
+ (paramdef "GLsizei " (parameter "height"))
+ (paramdef "GLsizei " (parameter "depth"))
+ (paramdef "GLint " (parameter "border"))
+ (paramdef "GLenum " (parameter "format"))
+ (paramdef "GLenum " (parameter "type"))
+ (paramdef "const GLvoid * " (parameter "data"))))
+ '(*fragment*
+ (heading
+ "specify a three-dimensional texture image")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "target")))
+ (para "
+Specifies the target texture.
+ Must be "
+ (code "GL_TEXTURE_3D")
+ " or "
+ (code "GL_PROXY_TEXTURE_3D")
+ ". "))
+ (entry (% (heading (var "level")))
+ (para "
+Specifies the level-of-detail number.
+ Level 0 is the base image level.
+ Level "
+ (math (var "n"))
+ "
+is the "
+ (math (var "n") "^" (var "th"))
+ "
+mipmap reduction image. "))
+ (entry (% (heading (var "internalFormat")))
+ (para "
+Specifies the number of color components in the texture.
+ Must be 1, 2, 3, or 4, or one of the following symbolic constants: "
+ (code "GL_ALPHA")
+ ", "
+ (code "GL_ALPHA4")
+ ", "
+ (code "GL_ALPHA8")
+ ", "
+ (code "GL_ALPHA12")
+ ", "
+ (code "GL_ALPHA16")
+ ", "
+ (code "GL_COMPRESSED_ALPHA")
+ ", "
+ (code "GL_COMPRESSED_LUMINANCE")
+ ", "
+ (code "GL_COMPRESSED_LUMINANCE_ALPHA")
+ ", "
+ (code "GL_COMPRESSED_INTENSITY")
+ ", "
+ (code "GL_COMPRESSED_RGB")
+ ", "
+ (code "GL_COMPRESSED_RGBA")
+ ", "
+ (code "GL_LUMINANCE")
+ ", "
+ (code "GL_LUMINANCE4")
+ ", "
+ (code "GL_LUMINANCE8")
+ ", "
+ (code "GL_LUMINANCE12")
+ ", "
+ (code "GL_LUMINANCE16")
+ ", "
+ (code "GL_LUMINANCE_ALPHA")
+ ", "
+ (code "GL_LUMINANCE4_ALPHA4")
+ ", "
+ (code "GL_LUMINANCE6_ALPHA2")
+ ", "
+ (code "GL_LUMINANCE8_ALPHA8")
+ ", "
+ (code "GL_LUMINANCE12_ALPHA4")
+ ", "
+ (code "GL_LUMINANCE12_ALPHA12")
+ ", "
+ (code "GL_LUMINANCE16_ALPHA16")
+ ", "
+ (code "GL_INTENSITY")
+ ", "
+ (code "GL_INTENSITY4")
+ ", "
+ (code "GL_INTENSITY8")
+ ", "
+ (code "GL_INTENSITY12")
+ ", "
+ (code "GL_INTENSITY16")
+ ", "
+ (code "GL_R3_G3_B2")
+ ", "
+ (code "GL_RGB")
+ ", "
+ (code "GL_RGB4")
+ ", "
+ (code "GL_RGB5")
+ ", "
+ (code "GL_RGB8")
+ ", "
+ (code "GL_RGB10")
+ ", "
+ (code "GL_RGB12")
+ ", "
+ (code "GL_RGB16")
+ ", "
+ (code "GL_RGBA")
+ ", "
+ (code "GL_RGBA2")
+ ", "
+ (code "GL_RGBA4")
+ ", "
+ (code "GL_RGB5_A1")
+ ", "
+ (code "GL_RGBA8")
+ ", "
+ (code "GL_RGB10_A2")
+ ", "
+ (code "GL_RGBA12")
+ ", "
+ (code "GL_RGBA16")
+ ", "
+ (code "GL_SLUMINANCE")
+ ", "
+ (code "GL_SLUMINANCE8")
+ ", "
+ (code "GL_SLUMINANCE_ALPHA")
+ ", "
+ (code "GL_SLUMINANCE8_ALPHA8")
+ ", "
+ (code "GL_SRGB")
+ ", "
+ (code "GL_SRGB8")
+ ", "
+ (code "GL_SRGB_ALPHA")
+ ", or "
+ (code "GL_SRGB8_ALPHA8")
+ ". "))
+ (entry (% (heading (var "width")))
+ (para "
+Specifies the width of the texture image including the border if any. If the GL version does not support non-power-of-two sizes, this value must be "
+ (math "2"
+ "^"
+ (var "n")
+ "+"
+ "2"
+ "\u2061"
+ "("
+ (var "border")
+ ","
+ ")")
+ "
+for some integer "
+ (math (var "n"))
+ ".
+ All
+ implementations support 3D texture images that are at least 16 texels
+ wide. "))
+ (entry (% (heading (var "height")))
+ (para "
+Specifies the height of the texture image including the border if any. If the GL version does not support non-power-of-two sizes, this value must be "
+ (math "2"
+ "^"
+ (var "m")
+ "+"
+ "2"
+ "\u2061"
+ "("
+ (var "border")
+ ","
+ ")")
+ "
+for some integer "
+ (math (var "m"))
+ ".
+ All
+ implementations support 3D texture images that are at least 16 texels
+ high. "))
+ (entry (% (heading (var "depth")))
+ (para "
+Specifies the depth of the texture image including the border if any. If the GL version does not support non-power-of-two sizes, this value must be "
+ (math "2"
+ "^"
+ (var "k")
+ "+"
+ "2"
+ "\u2061"
+ "("
+ (var "border")
+ ","
+ ")")
+ "
+for some integer "
+ (math (var "k"))
+ ".
+ All
+ implementations support 3D texture images that are at least 16 texels
+ deep. "))
+ (entry (% (heading (var "border")))
+ (para "
+Specifies the width of the border.
+ Must be either 0 or 1. "))
+ (entry (% (heading (var "format")))
+ (para "
+Specifies the format of the pixel data.
+ The following symbolic values are accepted: "
+ (code "GL_COLOR_INDEX")
+ ", "
+ (code "GL_RED")
+ ", "
+ (code "GL_GREEN")
+ ", "
+ (code "GL_BLUE")
+ ", "
+ (code "GL_ALPHA")
+ ", "
+ (code "GL_RGB")
+ ", "
+ (code "GL_BGR")
+ ", "
+ (code "GL_RGBA")
+ ", "
+ (code "GL_BGRA")
+ ", "
+ (code "GL_LUMINANCE")
+ ", and "
+ (code "GL_LUMINANCE_ALPHA")
+ ". "))
+ (entry (% (heading (var "type")))
+ (para "
+Specifies the data type of the pixel data.
+ The following symbolic values are accepted: "
+ (code "GL_UNSIGNED_BYTE")
+ ", "
+ (code "GL_BYTE")
+ ", "
+ (code "GL_BITMAP")
+ ", "
+ (code "GL_UNSIGNED_SHORT")
+ ", "
+ (code "GL_SHORT")
+ ", "
+ (code "GL_UNSIGNED_INT")
+ ", "
+ (code "GL_INT")
+ ", "
+ (code "GL_FLOAT")
+ ", "
+ (code "GL_UNSIGNED_BYTE_3_3_2")
+ ", "
+ (code "GL_UNSIGNED_BYTE_2_3_3_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_6_5")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_6_5_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_4_4_4_4")
+ ", "
+ (code "GL_UNSIGNED_SHORT_4_4_4_4_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_5_5_1")
+ ", "
+ (code "GL_UNSIGNED_SHORT_1_5_5_5_REV")
+ ", "
+ (code "GL_UNSIGNED_INT_8_8_8_8")
+ ", "
+ (code "GL_UNSIGNED_INT_8_8_8_8_REV")
+ ", "
+ (code "GL_UNSIGNED_INT_10_10_10_2")
+ ", and "
+ (code "GL_UNSIGNED_INT_2_10_10_10_REV")
+ ". "))
+ (entry (% (heading (var "data")))
+ (para "
+Specifies a pointer to the image data in memory. ")))
+ (heading "Description")
+ (para "
+Texturing maps a portion of a specified texture image
+ onto each graphical primitive for which texturing is enabled.
+ To enable and disable three-dimensional texturing, call "
+ (code "glEnable")
+ "
+and "
+ (code "glDisable")
+ " with argument "
+ (code "GL_TEXTURE_3D")
+ ". ")
+ (para "
+To define texture images, call "
+ (code "glTexImage3D")
+ ".
+ The arguments describe the parameters of the texture image,
+ such as height,
+ width, depth,
+ width of the border,
+ level-of-detail number
+ (see "
+ (code "glTexParameter")
+ "),
+ and number of color components provided.
+ The last three arguments describe how the image is represented in memory;
+ they are identical to the pixel formats used for "
+ (code "glDrawPixels")
+ ". ")
+ (para "
+If "
+ (var "target")
+ " is "
+ (code "GL_PROXY_TEXTURE_3D")
+ ", no data is read from "
+ (var "data")
+ ", but
+ all of the texture image state is recalculated, checked for
+ consistency, and checked
+ against the implementation's capabilities. If the implementation cannot
+ handle a texture of the requested texture size, it sets
+ all of the image state to 0,
+ but does not generate an error (see "
+ (code "glGetError")
+ "). To query for an
+ entire mipmap array, use an image array level greater than or equal to
+ 1. ")
+ (para "
+If "
+ (var "target")
+ " is "
+ (code "GL_TEXTURE_3D")
+ ",
+ data is read from "
+ (var "data")
+ " as a sequence of signed or unsigned bytes,
+ shorts,
+ or longs,
+ or single-precision floating-point values,
+ depending on "
+ (var "type")
+ ".
+ These values are grouped into sets of one,
+ two,
+ three,
+ or four values,
+ depending on "
+ (var "format")
+ ",
+ to form elements.
+ If "
+ (var "type")
+ " is "
+ (code "GL_BITMAP")
+ ",
+ the data is considered as a string of unsigned bytes (and "
+ (var "format")
+ " must be "
+ (code "GL_COLOR_INDEX")
+ ").
+ Each data byte is treated as eight 1-bit elements,
+ with bit ordering determined by "
+ (code "GL_UNPACK_LSB_FIRST")
+ "
+(see "
+ (code "glPixelStore")
+ "). ")
+ (para "
+If a non-zero named buffer object is bound to the "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ " target
+ (see "
+ (code "glBindBuffer")
+ ") while a texture image is
+ specified, "
+ (var "data")
+ " is treated as a byte offset into the buffer object's data store. ")
+ (para "
+The first element corresponds to the lower left corner of the texture
+ image.
+ Subsequent elements progress left-to-right through the remaining texels
+ in the lowest row of the texture image, and then in successively higher
+ rows of the texture image.
+ The final element corresponds to the upper right corner of the texture
+ image. ")
+ (para (var "format")
+ " determines the composition of each element in "
+ (var "data")
+ ".
+ It can assume one of these symbolic values: ")
+ (table (% (formatter (asis)))
+ (entry (% (heading (code "GL_COLOR_INDEX")))
+ (para "
+Each element is a single value,
+ a color index.
+ The GL converts it to fixed point
+ (with an unspecified number of zero bits to the right of the binary point),
+ shifted left or right depending on the value and sign of "
+ (code "GL_INDEX_SHIFT")
+ ",
+ and added to "
+ (code "GL_INDEX_OFFSET")
+ "
+(see "
+ (code "glPixelTransfer")
+ ").
+ The resulting index is converted to a set of color components
+ using the "
+ (code "GL_PIXEL_MAP_I_TO_R")
+ ", "
+ (code "GL_PIXEL_MAP_I_TO_G")
+ ", "
+ (code "GL_PIXEL_MAP_I_TO_B")
+ ", and "
+ (code "GL_PIXEL_MAP_I_TO_A")
+ " tables,
+ and clamped to the range [0,1]. "))
+ (entry (% (heading (code "GL_RED")))
+ (para "
+Each element is a single red component.
+ The GL converts it to floating point and assembles it into an RGBA element
+ by attaching 0 for green and blue, and 1 for alpha.
+ Each component is then multiplied by the signed scale factor "
+ (code "GL_c_SCALE")
+ ",
+ added to the signed bias "
+ (code "GL_c_BIAS")
+ ",
+ and clamped to the range [0,1]
+ (see "
+ (code "glPixelTransfer")
+ "). "))
+ (entry (% (heading (code "GL_GREEN")))
+ (para "
+Each element is a single green component.
+ The GL converts it to floating point and assembles it into an RGBA element
+ by attaching 0 for red and blue, and 1 for alpha.
+ Each component is then multiplied by the signed scale factor "
+ (code "GL_c_SCALE")
+ ",
+ added to the signed bias "
+ (code "GL_c_BIAS")
+ ",
+ and clamped to the range [0,1]
+ (see "
+ (code "glPixelTransfer")
+ "). "))
+ (entry (% (heading (code "GL_BLUE")))
+ (para "
+Each element is a single blue component.
+ The GL converts it to floating point and assembles it into an RGBA element
+ by attaching 0 for red and green, and 1 for alpha.
+ Each component is then multiplied by the signed scale factor "
+ (code "GL_c_SCALE")
+ ",
+ added to the signed bias "
+ (code "GL_c_BIAS")
+ ",
+ and clamped to the range [0,1]
+ (see "
+ (code "glPixelTransfer")
+ "). "))
+ (entry (% (heading (code "GL_ALPHA")))
+ (para "
+Each element is a single alpha component.
+ The GL converts it to floating point and assembles it into an RGBA element
+ by attaching 0 for red, green, and blue.
+ Each component is then multiplied by the signed scale factor "
+ (code "GL_c_SCALE")
+ ",
+ added to the signed bias "
+ (code "GL_c_BIAS")
+ ",
+ and clamped to the range [0,1]
+ (see "
+ (code "glPixelTransfer")
+ "). "))
+ (entry (% (heading (code "GL_INTENSITY")))
+ (para "
+Each element is a single intensity value.
+ The GL converts it to floating point,
+ then assembles it into an RGBA element by replicating the intensity value
+ three times for red, green, blue, and alpha.
+ Each component is then multiplied by the signed scale factor "
+ (code "GL_c_SCALE")
+ ",
+ added to the signed bias "
+ (code "GL_c_BIAS")
+ ",
+ and clamped to the range [0,1]
+ (see "
+ (code "glPixelTransfer")
+ "). "))
+ (entry (% (heading (code "GL_RGB"))))
+ (entry (% (heading (code "GL_BGR")))
+ (para "
+Each element is an RGB triple.
+ The GL converts it to floating point and assembles it into an RGBA element
+ by attaching 1 for alpha.
+ Each component is then multiplied by the signed scale factor "
+ (code "GL_c_SCALE")
+ ",
+ added to the signed bias "
+ (code "GL_c_BIAS")
+ ",
+ and clamped to the range [0,1]
+ (see "
+ (code "glPixelTransfer")
+ "). "))
+ (entry (% (heading (code "GL_RGBA"))))
+ (entry (% (heading (code "GL_BGRA")))
+ (para "
+Each element contains all four components.
+ Each component is multiplied by the signed scale factor "
+ (code "GL_c_SCALE")
+ ",
+ added to the signed bias "
+ (code "GL_c_BIAS")
+ ",
+ and clamped to the range [0,1]
+ (see "
+ (code "glPixelTransfer")
+ "). "))
+ (entry (% (heading (code "GL_LUMINANCE")))
+ (para "
+Each element is a single luminance value.
+ The GL converts it to floating point,
+ then assembles it into an RGBA element by replicating the luminance value
+ three times for red, green, and blue and attaching 1 for alpha.
+ Each component is then multiplied by the signed scale factor "
+ (code "GL_c_SCALE")
+ ",
+ added to the signed bias "
+ (code "GL_c_BIAS")
+ ",
+ and clamped to the range [0,1]
+ (see "
+ (code "glPixelTransfer")
+ "). "))
+ (entry (% (heading (code "GL_LUMINANCE_ALPHA")))
+ (para "
+Each element is a luminance/alpha pair.
+ The GL converts it to floating point,
+ then assembles it into an RGBA element by replicating the luminance value
+ three times for red, green, and blue.
+ Each component is then multiplied by the signed scale factor "
+ (code "GL_c_SCALE")
+ ",
+ added to the signed bias "
+ (code "GL_c_BIAS")
+ ",
+ and clamped to the range [0,1] (see "
+ (code "glPixelTransfer")
+ "). ")))
+ (para "
+Refer to the "
+ (code "glDrawPixels")
+ " reference page for a description of
+ the acceptable values for the "
+ (var "type")
+ " parameter. ")
+ (para "
+If an application wants to store the texture at a certain
+ resolution or in a certain format, it can request the resolution
+ and format with "
+ (var "internalFormat")
+ ". The GL will choose an internal
+ representation that closely approximates that requested by "
+ (var "internalFormat")
+ ", but
+ it may not match exactly.
+ (The representations specified by "
+ (code "GL_LUMINANCE")
+ ", "
+ (code "GL_LUMINANCE_ALPHA")
+ ", "
+ (code "GL_RGB")
+ ",
+ and "
+ (code "GL_RGBA")
+ " must match exactly. The numeric values 1, 2, 3, and 4
+ may also be used to specify the above representations.) ")
+ (para "
+If the "
+ (var "internalFormat")
+ " parameter is one of the generic compressed formats,\t"
+ (code "GL_COMPRESSED_ALPHA")
+ ",\t"
+ (code "GL_COMPRESSED_INTENSITY")
+ ",\t"
+ (code "GL_COMPRESSED_LUMINANCE")
+ ",\t"
+ (code "GL_COMPRESSED_LUMINANCE_ALPHA")
+ ",\t"
+ (code "GL_COMPRESSED_RGB")
+ ", or\t"
+ (code "GL_COMPRESSED_RGBA")
+ ", the GL will replace the internal format with the symbolic constant for a specific internal format and compress the texture before storage. If no corresponding internal format is available, or the GL can not compress that image for any reason, the internal format is instead replaced with a corresponding base internal format. ")
+ (para "
+If the "
+ (var "internalFormat")
+ " parameter is "
+ (code "GL_SRGB")
+ ",\t"
+ (code "GL_SRGB8")
+ ",\t"
+ (code "GL_SRGB_ALPHA")
+ ",\t"
+ (code "GL_SRGB8_ALPHA8")
+ ",\t"
+ (code "GL_SLUMINANCE")
+ ",\t"
+ (code "GL_SLUMINANCE8")
+ ",\t"
+ (code "GL_SLUMINANCE_ALPHA")
+ ", or\t"
+ (code "GL_SLUMINANCE8_ALPHA8")
+ ", the texture is treated as if the red, green, blue, or luminance components are encoded in the sRGB color space. Any alpha component is left unchanged. The conversion from the sRGB encoded component\t"
+ (math (var "c") "_" (var "s"))
+ "
+to a linear component\t"
+ (math (var "c") "_" (var "l"))
+ "
+is:\t")
+ (para (math (var "c")
+ "_"
+ (var "l")
+ "="
+ "{"
+ "("
+ (var "c")
+ "_"
+ (var "s")
+ "/"
+ "12.92"
+ " "
+ " "
+ "if"
+ " "
+ (var "c")
+ "_"
+ (var "s")
+ "≤"
+ "0.04045"
+ ")"
+ ", "
+ "("
+ "("
+ (code "c")
+ "_"
+ (code "s")
+ "+"
+ "0.055"
+ "/"
+ "1.055"
+ ")"
+ "^"
+ "2.4"
+ " "
+ " "
+ "if"
+ " "
+ (var "c")
+ "_"
+ (var "s")
+ ">"
+ "0.04045"
+ ")"))
+ (para "
+Assume\t"
+ (math (var "c") "_" (var "s"))
+ "
+is the sRGB component in the range [0,1]. ")
+ (para "
+Use the "
+ (code "GL_PROXY_TEXTURE_3D")
+ " target to try out a resolution and
+ format. The implementation will
+ update and recompute its best match for the requested storage resolution
+ and format. To then query this state, call "
+ (code "glGetTexLevelParameter")
+ ".
+ If the texture cannot be accommodated, texture state is set to 0. ")
+ (para "
+A one-component texture image uses only the red component of the RGBA
+ color extracted from "
+ (var "data")
+ ".
+ A two-component image uses the R and A values.
+ A three-component image uses the R, G, and B values.
+ A four-component image uses all of the RGBA components. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "target")
+ " is not "
+ (code "GL_TEXTURE_3D")
+ "
+or "
+ (code "GL_PROXY_TEXTURE_3D")
+ ". ")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "format")
+ " is not an accepted
+ format constant. Format constants other than "
+ (code "GL_STENCIL_INDEX")
+ " and "
+ (code "GL_DEPTH_COMPONENT")
+ "
+are accepted. ")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "type")
+ " is not a type constant. ")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "type")
+ " is "
+ (code "GL_BITMAP")
+ " and "
+ (var "format")
+ " is not "
+ (code "GL_COLOR_INDEX")
+ ". ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "level")
+ " is less than 0. ")
+ (para (code "GL_INVALID_VALUE")
+ " may be generated if "
+ (var "level")
+ " is greater than "
+ (math (var "log")
+ "_"
+ "2"
+ "\u2061"
+ "("
+ (var "max")
+ ","
+ ")")
+ ",
+ where "
+ (var "max")
+ " is the returned value of "
+ (code "GL_MAX_TEXTURE_SIZE")
+ ". ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "internalFormat")
+ " is not 1, 2, 3, 4, or one of the
+ accepted resolution and format symbolic constants. ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "width")
+ ", "
+ (var "height")
+ ", or "
+ (var "depth")
+ " is less than 0 or greater than 2 + "
+ (code "GL_MAX_TEXTURE_SIZE")
+ ". ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if non-power-of-two textures are not supported and the "
+ (var "width")
+ ", "
+ (var "height")
+ ", or "
+ (var "depth")
+ " cannot be represented as "
+ (math "2"
+ "^"
+ (var "k")
+ "+"
+ "2"
+ "\u2061"
+ "("
+ (var "border")
+ ","
+ ")")
+ "
+for some
+ integer value of "
+ (var "k")
+ ". ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "border")
+ " is not 0 or 1. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (var "type")
+ " is one of "
+ (code "GL_UNSIGNED_BYTE_3_3_2")
+ ", "
+ (code "GL_UNSIGNED_BYTE_2_3_3_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_6_5")
+ ", or "
+ (code "GL_UNSIGNED_SHORT_5_6_5_REV")
+ "
+and "
+ (var "format")
+ " is not "
+ (code "GL_RGB")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (var "type")
+ " is one of "
+ (code "GL_UNSIGNED_SHORT_4_4_4_4")
+ ", "
+ (code "GL_UNSIGNED_SHORT_4_4_4_4_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_5_5_1")
+ ", "
+ (code "GL_UNSIGNED_SHORT_1_5_5_5_REV")
+ ", "
+ (code "GL_UNSIGNED_INT_8_8_8_8")
+ ", "
+ (code "GL_UNSIGNED_INT_8_8_8_8_REV")
+ ", "
+ (code "GL_UNSIGNED_INT_10_10_10_2")
+ ", or "
+ (code "GL_UNSIGNED_INT_2_10_10_10_REV")
+ "
+and "
+ (var "format")
+ " is neither "
+ (code "GL_RGBA")
+ " nor "
+ (code "GL_BGRA")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (var "format")
+ " or "
+ (var "internalFormat")
+ " is "
+ (code "GL_DEPTH_COMPONENT")
+ ", "
+ (code "GL_DEPTH_COMPONENT16")
+ ", "
+ (code "GL_DEPTH_COMPONENT24")
+ ", or "
+ (code "GL_DEPTH_COMPONENT32")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a non-zero buffer object name is bound to the "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ " target and the buffer object's data store is currently mapped. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a non-zero buffer object name is bound to the "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ " target and the data would be unpacked from the buffer
+ object such that the memory reads required would exceed the data store size. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a non-zero buffer object name is bound to the "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ " target and "
+ (var "data")
+ " is not evenly divisible
+ into the number of bytes needed to store in memory a datum indicated by "
+ (var "type")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glTexImage3D")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glTexParameter
+ "glTexParameter"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glTexParameterf"))
+ (paramdef "GLenum " (parameter "target"))
+ (paramdef "GLenum " (parameter "pname"))
+ (paramdef "GLfloat " (parameter "param"))))
+ '(*fragment*
+ (heading "set texture parameters")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "target")))
+ (para "
+Specifies the target texture,
+ which must be either "
+ (code "GL_TEXTURE_1D")
+ ", "
+ (code "GL_TEXTURE_2D")
+ ", "
+ (code "GL_TEXTURE_3D")
+ ", or "
+ (code "GL_TEXTURE_CUBE_MAP")
+ ". "))
+ (entry (% (heading (var "pname")))
+ (para "
+Specifies the symbolic name of a single-valued texture parameter. "
+ (var "pname")
+ " can be one of the following: "
+ (code "GL_TEXTURE_MIN_FILTER")
+ ", "
+ (code "GL_TEXTURE_MAG_FILTER")
+ ", "
+ (code "GL_TEXTURE_MIN_LOD")
+ ", "
+ (code "GL_TEXTURE_MAX_LOD")
+ ", "
+ (code "GL_TEXTURE_BASE_LEVEL")
+ ", "
+ (code "GL_TEXTURE_MAX_LEVEL")
+ ", "
+ (code "GL_TEXTURE_WRAP_S")
+ ", "
+ (code "GL_TEXTURE_WRAP_T")
+ ", "
+ (code "GL_TEXTURE_WRAP_R")
+ ", "
+ (code "GL_TEXTURE_PRIORITY")
+ ", "
+ (code "GL_TEXTURE_COMPARE_MODE")
+ ", "
+ (code "GL_TEXTURE_COMPARE_FUNC")
+ ", "
+ (code "GL_DEPTH_TEXTURE_MODE")
+ ", or "
+ (code "GL_GENERATE_MIPMAP")
+ ". "))
+ (entry (% (heading (var "param")))
+ (para "
+Specifies the value of "
+ (var "pname")
+ ". ")))
+ (heading "Description")
+ (para "
+Texture mapping is a technique that applies an image onto an object's surface
+ as if the image were a decal or cellophane shrink-wrap.
+ The image is created in texture space,
+ with an
+ ("
+ (math (var "s"))
+ ", "
+ (math (var "t"))
+ ")
+ coordinate system.
+ A texture is a one- or two-dimensional image and a set of parameters
+ that determine how samples are derived from the image. ")
+ (para (code "glTexParameter")
+ " assigns the value or values in "
+ (var "params")
+ " to the texture parameter
+ specified as "
+ (var "pname")
+ ". "
+ (var "target")
+ " defines the target texture,
+ either "
+ (code "GL_TEXTURE_1D")
+ ", "
+ (code "GL_TEXTURE_2D")
+ ", or "
+ (code "GL_TEXTURE_3D")
+ ".
+ The following symbols are accepted in "
+ (var "pname")
+ ": ")
+ (table (% (formatter (asis)))
+ (entry (% (heading (code "GL_TEXTURE_MIN_FILTER")))
+ (para "
+The texture minifying function is used whenever the pixel being textured
+ maps to an area greater than one texture element.
+ There are six defined minifying functions.
+ Two of them use the nearest one or nearest four texture elements
+ to compute the texture value.
+ The other four use mipmaps. ")
+ (para "
+A mipmap is an ordered set of arrays representing the same image
+ at progressively lower resolutions.
+ If the texture has dimensions "
+ (math "2" "^" (var "n") "×" "2" "^" (var "m"))
+ ",
+ there are "
+ (math (var "max")
+ "\u2061"
+ "("
+ (var "n")
+ ","
+ (var "m")
+ ")"
+ "+"
+ "1")
+ "
+mipmaps.
+ The first mipmap is the original texture,
+ with dimensions "
+ (math "2" "^" (var "n") "×" "2" "^" (var "m"))
+ ".
+ Each subsequent mipmap has dimensions "
+ (math "2"
+ "^"
+ (var "k")
+ "-"
+ "1"
+ ","
+ "×"
+ "2"
+ "^"
+ (var "l")
+ "-"
+ "1"
+ ",")
+ ",
+ where "
+ (math "2" "^" (var "k") "×" "2" "^" (var "l"))
+ "
+are the dimensions of the previous mipmap,
+ until either "
+ (math (var "k") "=" "0")
+ "
+or "
+ (math (var "l") "=" "0")
+ ".
+ At that point,
+ subsequent mipmaps have dimension "
+ (math "1" "×" "2" "^" (var "l") "-" "1" ",")
+ "
+or "
+ (math "2" "^" (var "k") "-" "1" "," "×" "1")
+ "
+until the final mipmap,
+ which has dimension "
+ (math "1" "×" "1")
+ ".
+ To define the mipmaps, call "
+ (code "glTexImage1D")
+ ", "
+ (code "glTexImage2D")
+ ", "
+ (code "glTexImage3D")
+ ", "
+ (code "glCopyTexImage1D")
+ ", or "
+ (code "glCopyTexImage2D")
+ "
+with the "
+ (var "level")
+ " argument indicating the order of the mipmaps.
+ Level 0 is the original texture;
+ level "
+ (math (var "max")
+ "\u2061"
+ "("
+ (var "n")
+ ","
+ (var "m")
+ ")")
+ "
+is the final "
+ (math "1" "×" "1")
+ "
+mipmap. ")
+ (para (var "params")
+ " supplies a function for minifying the texture as one of the
+ following: ")
+ (para "
+As more texture elements are sampled in the minification process,
+ fewer aliasing artifacts will be apparent.
+ While the "
+ (code "GL_NEAREST")
+ " and "
+ (code "GL_LINEAR")
+ " minification functions can be
+ faster than the other four,
+ they sample only one or four texture elements to determine the texture value
+ of the pixel being rendered and can produce moire patterns
+ or ragged transitions.
+ The initial value of "
+ (code "GL_TEXTURE_MIN_FILTER")
+ " is "
+ (code "GL_NEAREST_MIPMAP_LINEAR")
+ ". "))
+ (entry (% (heading (code "GL_TEXTURE_MAG_FILTER")))
+ (para "
+The texture magnification function is used when the pixel being textured
+ maps to an area less than or equal to one texture element.
+ It sets the texture magnification function to either "
+ (code "GL_NEAREST")
+ "
+or "
+ (code "GL_LINEAR")
+ " (see below). "
+ (code "GL_NEAREST")
+ " is generally faster
+ than "
+ (code "GL_LINEAR")
+ ",
+ but it can produce textured images with sharper edges
+ because the transition between texture elements is not as smooth.
+ The initial value of "
+ (code "GL_TEXTURE_MAG_FILTER")
+ " is "
+ (code "GL_LINEAR")
+ ". "
+ (para))))
+ (table (% (formatter (asis)))
+ (entry (% (heading (code "GL_NEAREST")))
+ (para "
+Returns the value of the texture element that is nearest
+ (in Manhattan distance)
+ to the center of the pixel being textured. "))
+ (entry (% (heading (code "GL_LINEAR")))
+ (para "
+Returns the weighted average of the four texture elements
+ that are closest to the center of the pixel being textured.
+ These can include border texture elements,
+ depending on the values of "
+ (code "GL_TEXTURE_WRAP_S")
+ " and "
+ (code "GL_TEXTURE_WRAP_T")
+ ",
+ and on the exact mapping. "))
+ (entry (% (heading (code "GL_NEAREST_MIPMAP_NEAREST")))
+ (para "
+Chooses the mipmap that most closely matches the size of the pixel
+ being textured and uses the "
+ (code "GL_NEAREST")
+ " criterion
+ (the texture element nearest to the center of the pixel)
+ to produce a texture value. "))
+ (entry (% (heading (code "GL_LINEAR_MIPMAP_NEAREST")))
+ (para "
+Chooses the mipmap that most closely matches the size of the pixel
+ being textured and uses the "
+ (code "GL_LINEAR")
+ " criterion
+ (a weighted average of the four texture elements that are closest
+ to the center of the pixel)
+ to produce a texture value. "))
+ (entry (% (heading (code "GL_NEAREST_MIPMAP_LINEAR")))
+ (para "
+Chooses the two mipmaps that most closely match the size of the pixel
+ being textured and uses the "
+ (code "GL_NEAREST")
+ " criterion
+ (the texture element nearest to the center of the pixel)
+ to produce a texture value from each mipmap.
+ The final texture value is a weighted average of those two values. "))
+ (entry (% (heading (code "GL_LINEAR_MIPMAP_LINEAR")))
+ (para "
+Chooses the two mipmaps that most closely match the size of the pixel
+ being textured and uses the "
+ (code "GL_LINEAR")
+ " criterion
+ (a weighted average of the four texture elements that are closest
+ to the center of the pixel)
+ to produce a texture value from each mipmap.
+ The final texture value is a weighted average of those two values. ")))
+ (table (% (formatter (asis)))
+ (entry (% (heading (code "GL_NEAREST")))
+ (para "
+Returns the value of the texture element that is nearest
+ (in Manhattan distance)
+ to the center of the pixel being textured. "))
+ (entry (% (heading (code "GL_LINEAR")))
+ (para "
+Returns the weighted average of the four texture elements
+ that are closest to the center of the pixel being textured.
+ These can include border texture elements,
+ depending on the values of "
+ (code "GL_TEXTURE_WRAP_S")
+ " and "
+ (code "GL_TEXTURE_WRAP_T")
+ ",
+ and on the exact mapping. ")))
+ (para)
+ (table (% (formatter (asis)))
+ (entry (% (heading (code "GL_TEXTURE_MIN_LOD")))
+ (para "
+Sets the minimum level-of-detail parameter. This floating-point value
+ limits the selection of highest resolution mipmap (lowest mipmap
+ level). The initial value is -1000. ")))
+ (para)
+ (table (% (formatter (asis)))
+ (entry (% (heading (code "GL_TEXTURE_MAX_LOD")))
+ (para "
+Sets the maximum level-of-detail parameter. This floating-point value
+ limits the selection of the lowest resolution mipmap (highest mipmap
+ level). The initial value is 1000. ")))
+ (para)
+ (table (% (formatter (asis)))
+ (entry (% (heading (code "GL_TEXTURE_BASE_LEVEL")))
+ (para "
+Specifies the index of the lowest defined mipmap level. This is an
+ integer value. The initial value is 0. ")))
+ (para)
+ (table (% (formatter (asis)))
+ (entry (% (heading (code "GL_TEXTURE_MAX_LEVEL")))
+ (para "
+Sets the index of the highest defined mipmap level. This is an integer
+ value. The initial value is 1000. ")))
+ (para)
+ (table (% (formatter (asis)))
+ (entry (% (heading (code "GL_TEXTURE_WRAP_S")))
+ (para "
+Sets the wrap parameter for texture coordinate "
+ (math (var "s"))
+ "
+to either "
+ (code "GL_CLAMP")
+ ", "
+ (code "GL_CLAMP_TO_BORDER")
+ ", "
+ (code "GL_CLAMP_TO_EDGE")
+ ", "
+ (code "GL_MIRRORED_REPEAT")
+ ", or "
+ (code "GL_REPEAT")
+ ". "
+ (code "GL_CLAMP")
+ " causes "
+ (math (var "s"))
+ "
+coordinates to be clamped to the
+ range [0,1] and is useful for preventing wrapping artifacts when mapping a
+ single image onto an object. "
+ (code "GL_CLAMP_TO_BORDER")
+ " causes the "
+ (math (var "s"))
+ "
+coordinate to be clamped to the range "
+ (math "["
+ "-1"
+ "/"
+ "2"
+ (var "N")
+ ","
+ ","
+ "1"
+ "+"
+ "1"
+ "/"
+ "2"
+ (var "N")
+ ","
+ "]")
+ ",
+ where "
+ (math (var "N"))
+ "
+is the size of the texture in the direction of
+ clamping."
+ (code "GL_CLAMP_TO_EDGE")
+ " causes "
+ (math (var "s"))
+ "
+coordinates to be clamped to the
+ range "
+ (math "["
+ "1"
+ "/"
+ "2"
+ (var "N")
+ ","
+ ","
+ "1"
+ "-"
+ "1"
+ "/"
+ "2"
+ (var "N")
+ ","
+ "]")
+ ",
+ where "
+ (math (var "N"))
+ "
+is the size
+ of the texture in the direction of clamping. "
+ (code "GL_REPEAT")
+ " causes the
+ integer part of the "
+ (math (var "s"))
+ "
+coordinate to be ignored; the GL uses only the
+ fractional part, thereby creating a repeating pattern. "
+ (code "GL_MIRRORED_REPEAT")
+ " causes the "
+ (math (var "s"))
+ "
+coordinate to be set to the
+ fractional part of the texture coordinate if the integer part of "
+ (math (var "s"))
+ "
+is
+ even; if the integer part of "
+ (math (var "s"))
+ "
+is odd, then the "
+ (math (var "s"))
+ "
+texture coordinate is
+ set to "
+ (math "1"
+ "-"
+ (var "frac")
+ "\u2061"
+ "("
+ (var "s")
+ ","
+ ")")
+ ",
+ where "
+ (math (var "frac")
+ "\u2061"
+ "("
+ (var "s")
+ ","
+ ")")
+ "
+represents the fractional part of "
+ (math (var "s"))
+ ".
+ Border texture
+ elements are accessed only if wrapping is set to "
+ (code "GL_CLAMP")
+ " or "
+ (code "GL_CLAMP_TO_BORDER")
+ ". Initially, "
+ (code "GL_TEXTURE_WRAP_S")
+ " is set to "
+ (code "GL_REPEAT")
+ ". ")))
+ (para)
+ (table (% (formatter (asis)))
+ (entry (% (heading (code "GL_TEXTURE_WRAP_T")))
+ (para "
+Sets the wrap parameter for texture coordinate "
+ (math (var "t"))
+ "
+to either "
+ (code "GL_CLAMP")
+ ", "
+ (code "GL_CLAMP_TO_BORDER")
+ ", "
+ (code "GL_CLAMP_TO_EDGE")
+ ", "
+ (code "GL_MIRRORED_REPEAT")
+ ", or "
+ (code "GL_REPEAT")
+ ". See the discussion under "
+ (code "GL_TEXTURE_WRAP_S")
+ ".
+ Initially, "
+ (code "GL_TEXTURE_WRAP_T")
+ " is set to "
+ (code "GL_REPEAT")
+ ". "))
+ (entry (% (heading (code "GL_TEXTURE_WRAP_R")))
+ (para "
+Sets the wrap parameter for texture coordinate "
+ (math (var "r"))
+ "
+to either "
+ (code "GL_CLAMP")
+ ", "
+ (code "GL_CLAMP_TO_BORDER")
+ ", "
+ (code "GL_CLAMP_TO_EDGE")
+ ", "
+ (code "GL_MIRRORED_REPEAT")
+ ", or "
+ (code "GL_REPEAT")
+ ". See the discussion under "
+ (code "GL_TEXTURE_WRAP_S")
+ ".
+ Initially, "
+ (code "GL_TEXTURE_WRAP_R")
+ " is set to "
+ (code "GL_REPEAT")
+ ". "))
+ (entry (% (heading (code "GL_TEXTURE_BORDER_COLOR")))
+ (para "
+Sets a border color. "
+ (var "params")
+ " contains four values that comprise the RGBA
+ color of the texture border. Integer color components are interpreted
+ linearly such that the most positive integer maps to 1.0, and the most
+ negative integer maps to -1.0. The values are clamped to the range [0,1]
+ when they are specified. Initially, the border color is (0, 0, 0, 0). "))
+ (entry (% (heading (code "GL_TEXTURE_PRIORITY")))
+ (para "
+Specifies the texture residence priority of the currently bound texture.
+ Permissible values are in the range "
+ (math "[" "0" "," "1" "]")
+ ".
+ See "
+ (code "glPrioritizeTextures")
+ " and "
+ (code "glBindTexture")
+ " for more information. "))
+ (entry (% (heading (code "GL_TEXTURE_COMPARE_MODE")))
+ (para "
+Specifies the texture comparison mode for currently bound depth textures.
+ That is, a texture whose internal format is "
+ (code "GL_DEPTH_COMPONENT_*")
+ "; see "
+ (code "glTexImage2D")
+ ")
+ Permissible values are: "))
+ (entry (% (heading (code "GL_TEXTURE_COMPARE_FUNC")))
+ (para "
+Specifies the comparison operator used when "
+ (code "GL_TEXTURE_COMPARE_MODE")
+ " is
+ set to "
+ (code "GL_COMPARE_R_TO_TEXTURE")
+ ". Permissible values are: "
+ "
+where "
+ (math (var "r"))
+ "
+is the current interpolated texture coordinate, and "
+ (math (var "D") "_" (var "t"))
+ "
+is the depth texture value sampled from the currently bound depth texture. "
+ (math (var "result"))
+ "
+is assigned to the either the luminance, intensity, or alpha (as
+ specified by "
+ (code "GL_DEPTH_TEXTURE_MODE")
+ ".) "))
+ (entry (% (heading (code "GL_DEPTH_TEXTURE_MODE")))
+ (para "
+Specifies a single symbolic constant indicating how depth values should be
+ treated during filtering and texture application. Accepted values are "
+ (code "GL_LUMINANCE")
+ ", "
+ (code "GL_INTENSITY")
+ ", and "
+ (code "GL_ALPHA")
+ ". The initial value
+ is "
+ (code "GL_LUMINANCE")
+ ". "))
+ (entry (% (heading (code "GL_GENERATE_MIPMAP")))
+ (para "
+Specifies a boolean value that indicates if all levels of a mipmap array
+ should be automatically updated when any modification to the base level
+ mipmap is done. The initial value is "
+ (code "GL_FALSE")
+ ". ")))
+ (table (% (formatter (asis)))
+ (entry (% (heading (code "GL_COMPARE_R_TO_TEXTURE")))
+ (para "
+Specifies that the interpolated and clamped "
+ (math (var "r"))
+ "
+texture coordinate should
+ be compared to the value in the currently bound depth texture. See the
+ discussion of "
+ (code "GL_TEXTURE_COMPARE_FUNC")
+ " for details of how the comparison
+ is evaluated. The result of the comparison is assigned to luminance,
+ intensity, or alpha (as specified by "
+ (code "GL_DEPTH_TEXTURE_MODE")
+ "). "))
+ (entry (% (heading (code "GL_NONE")))
+ (para "
+Specifies that the luminance, intensity, or alpha (as specified by "
+ (code "GL_DEPTH_TEXTURE_MODE")
+ ") should be assigned the
+ appropriate value from the currently bound depth texture. ")))
+ (table (% (formatter (asis)))
+ (entry (% (heading (strong "Texture Comparison Function")))
+ (para (strong "Computed result")))
+ (entry (% (heading (code "GL_LEQUAL")))
+ (para (math (var "result")
+ "="
+ "{"
+ "("
+ "1.0"
+ ")"
+ ", "
+ "("
+ "0.0"
+ ")"
+ "\u2062\xa0"
+ "("
+ (var "r")
+ "<="
+ (var "D")
+ "_"
+ (var "t")
+ ","
+ ")"
+ ", "
+ "("
+ (var "r")
+ ">"
+ (var "D")
+ "_"
+ (var "t")
+ ","
+ ")"
+ ",")))
+ (entry (% (heading (code "GL_GEQUAL")))
+ (para (math (var "result")
+ "="
+ "{"
+ "("
+ "1.0"
+ ")"
+ ", "
+ "("
+ "0.0"
+ ")"
+ "\u2062\xa0"
+ "("
+ (var "r")
+ ">="
+ (var "D")
+ "_"
+ (var "t")
+ ","
+ ")"
+ ", "
+ "("
+ (var "r")
+ "<"
+ (var "D")
+ "_"
+ (var "t")
+ ","
+ ")"
+ ",")))
+ (entry (% (heading (code "GL_LESS")))
+ (para (math (var "result")
+ "="
+ "{"
+ "("
+ "1.0"
+ ")"
+ ", "
+ "("
+ "0.0"
+ ")"
+ "\u2062\xa0"
+ "("
+ (var "r")
+ "<"
+ (var "D")
+ "_"
+ (var "t")
+ ","
+ ")"
+ ", "
+ "("
+ (var "r")
+ ">="
+ (var "D")
+ "_"
+ (var "t")
+ ","
+ ")"
+ ",")))
+ (entry (% (heading (code "GL_GREATER")))
+ (para (math (var "result")
+ "="
+ "{"
+ "("
+ "1.0"
+ ")"
+ ", "
+ "("
+ "0.0"
+ ")"
+ "\u2062\xa0"
+ "("
+ (var "r")
+ ">"
+ (var "D")
+ "_"
+ (var "t")
+ ","
+ ")"
+ ", "
+ "("
+ (var "r")
+ "<="
+ (var "D")
+ "_"
+ (var "t")
+ ","
+ ")"
+ ",")))
+ (entry (% (heading (code "GL_EQUAL")))
+ (para (math (var "result")
+ "="
+ "{"
+ "("
+ "1.0"
+ ")"
+ ", "
+ "("
+ "0.0"
+ ")"
+ "\u2062\xa0"
+ "("
+ (var "r")
+ "="
+ (var "D")
+ "_"
+ (var "t")
+ ","
+ ")"
+ ", "
+ "("
+ (var "r")
+ "≠"
+ (var "D")
+ "_"
+ (var "t")
+ ","
+ ")"
+ ",")))
+ (entry (% (heading (code "GL_NOTEQUAL")))
+ (para (math (var "result")
+ "="
+ "{"
+ "("
+ "1.0"
+ ")"
+ ", "
+ "("
+ "0.0"
+ ")"
+ "\u2062\xa0"
+ "("
+ (var "r")
+ "≠"
+ (var "D")
+ "_"
+ (var "t")
+ ","
+ ")"
+ ", "
+ "("
+ (var "r")
+ "="
+ (var "D")
+ "_"
+ (var "t")
+ ","
+ ")"
+ ",")))
+ (entry (% (heading (code "GL_ALWAYS")))
+ (para (math (var "result") "=" (code "1.0"))))
+ (entry (% (heading (code "GL_NEVER")))
+ (para (math (var "result") "=" (code "0.0")))))
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "target")
+ " or "
+ (var "pname")
+ " is not
+ one of the accepted defined values. ")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "params")
+ " should have a defined
+ constant value (based on the value of "
+ (var "pname")
+ ") and does not. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glTexParameter")
+ " is executed between the
+ execution of "
+ (code "glBegin")
+ " and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glTexSubImage1D
+ "glTexSubImage1D"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glTexSubImage1D"))
+ (paramdef "GLenum " (parameter "target"))
+ (paramdef "GLint " (parameter "level"))
+ (paramdef "GLint " (parameter "xoffset"))
+ (paramdef "GLsizei " (parameter "width"))
+ (paramdef "GLenum " (parameter "format"))
+ (paramdef "GLenum " (parameter "type"))
+ (paramdef "const GLvoid * " (parameter "data"))))
+ '(*fragment*
+ (heading
+ "specify a one-dimensional texture subimage")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "target")))
+ (para "
+Specifies the target texture.
+ Must be "
+ (code "GL_TEXTURE_1D")
+ ". "))
+ (entry (% (heading (var "level")))
+ (para "
+Specifies the level-of-detail number.
+ Level 0 is the base image level.
+ Level "
+ (var "n")
+ " is the "
+ (var "n")
+ "th mipmap reduction image. "))
+ (entry (% (heading (var "xoffset")))
+ (para "
+Specifies a texel offset in the x direction within the texture array. "))
+ (entry (% (heading (var "width")))
+ (para "
+Specifies the width of the texture subimage. "))
+ (entry (% (heading (var "format")))
+ (para "
+Specifies the format of the pixel data.
+ The following symbolic values are accepted: "
+ (code "GL_COLOR_INDEX")
+ ", "
+ (code "GL_RED")
+ ", "
+ (code "GL_GREEN")
+ ", "
+ (code "GL_BLUE")
+ ", "
+ (code "GL_ALPHA")
+ ", "
+ (code "GL_RGB")
+ ", "
+ (code "GL_BGR")
+ ", "
+ (code "GL_RGBA")
+ ", "
+ (code "GL_BGRA")
+ ", "
+ (code "GL_LUMINANCE")
+ ", and "
+ (code "GL_LUMINANCE_ALPHA")
+ ". "))
+ (entry (% (heading (var "type")))
+ (para "
+Specifies the data type of the pixel data.
+ The following symbolic values are accepted: "
+ (code "GL_UNSIGNED_BYTE")
+ ", "
+ (code "GL_BYTE")
+ ", "
+ (code "GL_BITMAP")
+ ", "
+ (code "GL_UNSIGNED_SHORT")
+ ", "
+ (code "GL_SHORT")
+ ", "
+ (code "GL_UNSIGNED_INT")
+ ", "
+ (code "GL_INT")
+ ", "
+ (code "GL_FLOAT")
+ ", "
+ (code "GL_UNSIGNED_BYTE_3_3_2")
+ ", "
+ (code "GL_UNSIGNED_BYTE_2_3_3_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_6_5")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_6_5_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_4_4_4_4")
+ ", "
+ (code "GL_UNSIGNED_SHORT_4_4_4_4_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_5_5_1")
+ ", "
+ (code "GL_UNSIGNED_SHORT_1_5_5_5_REV")
+ ", "
+ (code "GL_UNSIGNED_INT_8_8_8_8")
+ ", "
+ (code "GL_UNSIGNED_INT_8_8_8_8_REV")
+ ", "
+ (code "GL_UNSIGNED_INT_10_10_10_2")
+ ", and "
+ (code "GL_UNSIGNED_INT_2_10_10_10_REV")
+ ". "))
+ (entry (% (heading (var "data")))
+ (para "
+Specifies a pointer to the image data in memory. ")))
+ (heading "Description")
+ (para "
+Texturing maps a portion of a specified texture image
+ onto each graphical primitive for which texturing is enabled.
+ To enable or disable one-dimensional texturing, call "
+ (code "glEnable")
+ "
+and "
+ (code "glDisable")
+ " with argument "
+ (code "GL_TEXTURE_1D")
+ ". ")
+ (para (code "glTexSubImage1D")
+ " redefines a contiguous subregion of an existing one-dimensional
+ texture image.
+ The texels referenced by "
+ (var "data")
+ " replace the portion of the
+ existing texture array with x indices "
+ (var "xoffset")
+ " and "
+ (math (var "xoffset") "+" (var "width") "-" "1")
+ ",
+ inclusive.
+ This region may not include any texels outside the range of the
+ texture array as it was originally specified.
+ It is not an error to specify a subtexture with width of 0, but
+ such a specification has no effect. ")
+ (para "
+If a non-zero named buffer object is bound to the "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ " target
+ (see "
+ (code "glBindBuffer")
+ ") while a texture image is
+ specified, "
+ (var "data")
+ " is treated as a byte offset into the buffer object's data store. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "target")
+ " is not one of the
+ allowable values. ")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "format")
+ " is not an accepted
+ format constant. ")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "type")
+ " is not a type constant. ")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "type")
+ " is "
+ (code "GL_BITMAP")
+ " and "
+ (var "format")
+ " is not "
+ (code "GL_COLOR_INDEX")
+ ". ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "level")
+ " is less than 0. ")
+ (para (code "GL_INVALID_VALUE")
+ " may be generated if "
+ (var "level")
+ " is greater
+ than "
+ (math (var "log") "_" "2")
+ (var "max")
+ ",
+ where "
+ (var "max")
+ " is the returned value of "
+ (code "GL_MAX_TEXTURE_SIZE")
+ ". ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (math (var "xoffset") "<" "-" (var "b"))
+ ",
+ or if "
+ (math "("
+ (var "xoffset")
+ "+"
+ (var "width")
+ ","
+ ")"
+ ">"
+ "("
+ (var "w")
+ "-"
+ (var "b")
+ ","
+ ")")
+ ",
+ where "
+ (math (var "w"))
+ "
+is the "
+ (code "GL_TEXTURE_WIDTH")
+ ", and "
+ (math (var "b"))
+ "
+is
+ the width of the "
+ (code "GL_TEXTURE_BORDER")
+ "
+of the texture image being modified.
+ Note that "
+ (math (var "w"))
+ "
+includes twice the border width. ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "width")
+ " is less than 0. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if the texture array has not
+ been defined by a previous "
+ (code "glTexImage1D")
+ " operation. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (var "type")
+ " is one of "
+ (code "GL_UNSIGNED_BYTE_3_3_2")
+ ", "
+ (code "GL_UNSIGNED_BYTE_2_3_3_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_6_5")
+ ", or "
+ (code "GL_UNSIGNED_SHORT_5_6_5_REV")
+ "
+and "
+ (var "format")
+ " is not "
+ (code "GL_RGB")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (var "type")
+ " is one of "
+ (code "GL_UNSIGNED_SHORT_4_4_4_4")
+ ", "
+ (code "GL_UNSIGNED_SHORT_4_4_4_4_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_5_5_1")
+ ", "
+ (code "GL_UNSIGNED_SHORT_1_5_5_5_REV")
+ ", "
+ (code "GL_UNSIGNED_INT_8_8_8_8")
+ ", "
+ (code "GL_UNSIGNED_INT_8_8_8_8_REV")
+ ", "
+ (code "GL_UNSIGNED_INT_10_10_10_2")
+ ", or "
+ (code "GL_UNSIGNED_INT_2_10_10_10_REV")
+ "
+and "
+ (var "format")
+ " is neither "
+ (code "GL_RGBA")
+ " nor "
+ (code "GL_BGRA")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a non-zero buffer object name is bound to the "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ " target and the buffer object's data store is currently mapped. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a non-zero buffer object name is bound to the "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ " target and the data would be unpacked from the buffer
+ object such that the memory reads required would exceed the data store size. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a non-zero buffer object name is bound to the "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ " target and "
+ (var "data")
+ " is not evenly divisible
+ into the number of bytes needed to store in memory a datum indicated by "
+ (var "type")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glTexSubImage1D")
+ " is executed
+ between the execution of "
+ (code "glBegin")
+ " and the corresponding
+ execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glTexSubImage2D
+ "glTexSubImage2D"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glTexSubImage2D"))
+ (paramdef "GLenum " (parameter "target"))
+ (paramdef "GLint " (parameter "level"))
+ (paramdef "GLint " (parameter "xoffset"))
+ (paramdef "GLint " (parameter "yoffset"))
+ (paramdef "GLsizei " (parameter "width"))
+ (paramdef "GLsizei " (parameter "height"))
+ (paramdef "GLenum " (parameter "format"))
+ (paramdef "GLenum " (parameter "type"))
+ (paramdef "const GLvoid * " (parameter "data"))))
+ '(*fragment*
+ (heading
+ "specify a two-dimensional texture subimage")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "target")))
+ (para "
+Specifies the target texture.
+ Must be "
+ (code "GL_TEXTURE_2D")
+ ", "
+ (code "GL_TEXTURE_CUBE_MAP_POSITIVE_X")
+ ", "
+ (code "GL_TEXTURE_CUBE_MAP_NEGATIVE_X")
+ ", "
+ (code "GL_TEXTURE_CUBE_MAP_POSITIVE_Y")
+ ", "
+ (code "GL_TEXTURE_CUBE_MAP_NEGATIVE_Y")
+ ", "
+ (code "GL_TEXTURE_CUBE_MAP_POSITIVE_Z")
+ ", or "
+ (code "GL_TEXTURE_CUBE_MAP_NEGATIVE_Z")
+ ". "))
+ (entry (% (heading (var "level")))
+ (para "
+Specifies the level-of-detail number.
+ Level 0 is the base image level.
+ Level "
+ (var "n")
+ " is the "
+ (var "n")
+ "th mipmap reduction image. "))
+ (entry (% (heading (var "xoffset")))
+ (para "
+Specifies a texel offset in the x direction within the texture array. "))
+ (entry (% (heading (var "yoffset")))
+ (para "
+Specifies a texel offset in the y direction within the texture array. "))
+ (entry (% (heading (var "width")))
+ (para "
+Specifies the width of the texture subimage. "))
+ (entry (% (heading (var "height")))
+ (para "
+Specifies the height of the texture subimage. "))
+ (entry (% (heading (var "format")))
+ (para "
+Specifies the format of the pixel data.
+ The following symbolic values are accepted: "
+ (code "GL_COLOR_INDEX")
+ ", "
+ (code "GL_RED")
+ ", "
+ (code "GL_GREEN")
+ ", "
+ (code "GL_BLUE")
+ ", "
+ (code "GL_ALPHA")
+ ", "
+ (code "GL_RGB")
+ ", "
+ (code "GL_BGR")
+ ", "
+ (code "GL_RGBA")
+ ", "
+ (code "GL_BGRA")
+ ", "
+ (code "GL_LUMINANCE")
+ ", and "
+ (code "GL_LUMINANCE_ALPHA")
+ ". "))
+ (entry (% (heading (var "type")))
+ (para "
+Specifies the data type of the pixel data.
+ The following symbolic values are accepted: "
+ (code "GL_UNSIGNED_BYTE")
+ ", "
+ (code "GL_BYTE")
+ ", "
+ (code "GL_BITMAP")
+ ", "
+ (code "GL_UNSIGNED_SHORT")
+ ", "
+ (code "GL_SHORT")
+ ", "
+ (code "GL_UNSIGNED_INT")
+ ", "
+ (code "GL_INT")
+ ", "
+ (code "GL_FLOAT")
+ ", "
+ (code "GL_UNSIGNED_BYTE_3_3_2")
+ ", "
+ (code "GL_UNSIGNED_BYTE_2_3_3_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_6_5")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_6_5_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_4_4_4_4")
+ ", "
+ (code "GL_UNSIGNED_SHORT_4_4_4_4_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_5_5_1")
+ ", "
+ (code "GL_UNSIGNED_SHORT_1_5_5_5_REV")
+ ", "
+ (code "GL_UNSIGNED_INT_8_8_8_8")
+ ", "
+ (code "GL_UNSIGNED_INT_8_8_8_8_REV")
+ ", "
+ (code "GL_UNSIGNED_INT_10_10_10_2")
+ ", and "
+ (code "GL_UNSIGNED_INT_2_10_10_10_REV")
+ ". "))
+ (entry (% (heading (var "data")))
+ (para "
+Specifies a pointer to the image data in memory. ")))
+ (heading "Description")
+ (para "
+Texturing maps a portion of a specified texture image
+ onto each graphical primitive for which texturing is enabled.
+ To enable and disable two-dimensional texturing, call "
+ (code "glEnable")
+ "
+and "
+ (code "glDisable")
+ " with argument "
+ (code "GL_TEXTURE_2D")
+ ". ")
+ (para (code "glTexSubImage2D")
+ " redefines a contiguous subregion of an existing two-dimensional
+ texture image.
+ The texels referenced by "
+ (var "data")
+ " replace the portion of the
+ existing texture array with x indices "
+ (var "xoffset")
+ " and "
+ (math (var "xoffset") "+" (var "width") "-" "1")
+ ",
+ inclusive,
+ and y indices "
+ (var "yoffset")
+ " and "
+ (math (var "yoffset") "+" (var "height") "-" "1")
+ ",
+ inclusive.
+ This region may not include any texels outside the range of the
+ texture array as it was originally specified.
+ It is not an error to specify a subtexture with zero width or height, but
+ such a specification has no effect. ")
+ (para "
+If a non-zero named buffer object is bound to the "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ " target
+ (see "
+ (code "glBindBuffer")
+ ") while a texture image is
+ specified, "
+ (var "data")
+ " is treated as a byte offset into the buffer object's data store. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "target")
+ " is not "
+ (code "GL_TEXTURE_2D")
+ ", "
+ (code "GL_TEXTURE_CUBE_MAP_POSITIVE_X")
+ ", "
+ (code "GL_TEXTURE_CUBE_MAP_NEGATIVE_X")
+ ", "
+ (code "GL_TEXTURE_CUBE_MAP_POSITIVE_Y")
+ ", "
+ (code "GL_TEXTURE_CUBE_MAP_NEGATIVE_Y")
+ ", "
+ (code "GL_TEXTURE_CUBE_MAP_POSITIVE_Z")
+ ", or "
+ (code "GL_TEXTURE_CUBE_MAP_NEGATIVE_Z")
+ ". ")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "format")
+ " is not an accepted
+ format constant. ")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "type")
+ " is not a type constant. ")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "type")
+ " is "
+ (code "GL_BITMAP")
+ " and "
+ (var "format")
+ " is not "
+ (code "GL_COLOR_INDEX")
+ ". ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "level")
+ " is less than 0. ")
+ (para (code "GL_INVALID_VALUE")
+ " may be generated if "
+ (var "level")
+ " is greater
+ than "
+ (math (var "log") "_" "2")
+ (var "max")
+ ",
+ where "
+ (var "max")
+ " is the returned value of "
+ (code "GL_MAX_TEXTURE_SIZE")
+ ". ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (math (var "xoffset") "<" "-" (var "b"))
+ ", "
+ (math "("
+ (var "xoffset")
+ "+"
+ (var "width")
+ ","
+ ")"
+ ">"
+ "("
+ (var "w")
+ "-"
+ (var "b")
+ ","
+ ")")
+ ", "
+ (math (var "yoffset") "<" "-" (var "b"))
+ ",
+ or "
+ (math "("
+ (var "yoffset")
+ "+"
+ (var "height")
+ ","
+ ")"
+ ">"
+ "("
+ (var "h")
+ "-"
+ (var "b")
+ ","
+ ")")
+ ",
+ where "
+ (math (var "w"))
+ "
+is the "
+ (code "GL_TEXTURE_WIDTH")
+ ", "
+ (math (var "h"))
+ "
+is the "
+ (code "GL_TEXTURE_HEIGHT")
+ ", and "
+ (math (var "b"))
+ "
+is the border width
+ of the texture image being modified.
+ Note that "
+ (math (var "w"))
+ "
+and "
+ (math (var "h"))
+ "
+include twice the border width. ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "width")
+ " or "
+ (var "height")
+ " is less than 0. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if the texture array has not
+ been defined by a previous "
+ (code "glTexImage2D")
+ " operation. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (var "type")
+ " is one of "
+ (code "GL_UNSIGNED_BYTE_3_3_2")
+ ", "
+ (code "GL_UNSIGNED_BYTE_2_3_3_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_6_5")
+ ", or "
+ (code "GL_UNSIGNED_SHORT_5_6_5_REV")
+ "
+and "
+ (var "format")
+ " is not "
+ (code "GL_RGB")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (var "type")
+ " is one of "
+ (code "GL_UNSIGNED_SHORT_4_4_4_4")
+ ", "
+ (code "GL_UNSIGNED_SHORT_4_4_4_4_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_5_5_1")
+ ", "
+ (code "GL_UNSIGNED_SHORT_1_5_5_5_REV")
+ ", "
+ (code "GL_UNSIGNED_INT_8_8_8_8")
+ ", "
+ (code "GL_UNSIGNED_INT_8_8_8_8_REV")
+ ", "
+ (code "GL_UNSIGNED_INT_10_10_10_2")
+ ", or "
+ (code "GL_UNSIGNED_INT_2_10_10_10_REV")
+ "
+and "
+ (var "format")
+ " is neither "
+ (code "GL_RGBA")
+ " nor "
+ (code "GL_BGRA")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a non-zero buffer object name is bound to the "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ " target and the buffer object's data store is currently mapped. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a non-zero buffer object name is bound to the "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ " target and the data would be unpacked from the buffer
+ object such that the memory reads required would exceed the data store size. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a non-zero buffer object name is bound to the "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ " target and "
+ (var "data")
+ " is not evenly divisible
+ into the number of bytes needed to store in memory a datum indicated by "
+ (var "type")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glTexSubImage2D")
+ " is executed
+ between the execution of "
+ (code "glBegin")
+ " and the corresponding
+ execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glTexSubImage3D
+ "glTexSubImage3D"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glTexSubImage3D"))
+ (paramdef "GLenum " (parameter "target"))
+ (paramdef "GLint " (parameter "level"))
+ (paramdef "GLint " (parameter "xoffset"))
+ (paramdef "GLint " (parameter "yoffset"))
+ (paramdef "GLint " (parameter "zoffset"))
+ (paramdef "GLsizei " (parameter "width"))
+ (paramdef "GLsizei " (parameter "height"))
+ (paramdef "GLsizei " (parameter "depth"))
+ (paramdef "GLenum " (parameter "format"))
+ (paramdef "GLenum " (parameter "type"))
+ (paramdef "const GLvoid * " (parameter "data"))))
+ '(*fragment*
+ (heading
+ "specify a three-dimensional texture subimage")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "target")))
+ (para "
+Specifies the target texture.
+ Must be "
+ (code "GL_TEXTURE_3D")
+ ". "))
+ (entry (% (heading (var "level")))
+ (para "
+Specifies the level-of-detail number.
+ Level 0 is the base image level.
+ Level "
+ (var "n")
+ " is the "
+ (var "n")
+ "th mipmap reduction image. "))
+ (entry (% (heading (var "xoffset")))
+ (para "
+Specifies a texel offset in the x direction within the texture array. "))
+ (entry (% (heading (var "yoffset")))
+ (para "
+Specifies a texel offset in the y direction within the texture array. "))
+ (entry (% (heading (var "zoffset")))
+ (para "
+Specifies a texel offset in the z direction within the texture array. "))
+ (entry (% (heading (var "width")))
+ (para "
+Specifies the width of the texture subimage. "))
+ (entry (% (heading (var "height")))
+ (para "
+Specifies the height of the texture subimage. "))
+ (entry (% (heading (var "depth")))
+ (para "
+Specifies the depth of the texture subimage. "))
+ (entry (% (heading (var "format")))
+ (para "
+Specifies the format of the pixel data.
+ The following symbolic values are accepted: "
+ (code "GL_COLOR_INDEX")
+ ", "
+ (code "GL_RED")
+ ", "
+ (code "GL_GREEN")
+ ", "
+ (code "GL_BLUE")
+ ", "
+ (code "GL_ALPHA")
+ ", "
+ (code "GL_RGB")
+ ", "
+ (code "GL_BGR")
+ ", "
+ (code "GL_RGBA")
+ ", "
+ (code "GL_BGRA")
+ ", "
+ (code "GL_LUMINANCE")
+ ", and "
+ (code "GL_LUMINANCE_ALPHA")
+ ". "))
+ (entry (% (heading (var "type")))
+ (para "
+Specifies the data type of the pixel data.
+ The following symbolic values are accepted: "
+ (code "GL_UNSIGNED_BYTE")
+ ", "
+ (code "GL_BYTE")
+ ", "
+ (code "GL_BITMAP")
+ ", "
+ (code "GL_UNSIGNED_SHORT")
+ ", "
+ (code "GL_SHORT")
+ ", "
+ (code "GL_UNSIGNED_INT")
+ ", "
+ (code "GL_INT")
+ ", "
+ (code "GL_FLOAT")
+ ", "
+ (code "GL_UNSIGNED_BYTE_3_3_2")
+ ", "
+ (code "GL_UNSIGNED_BYTE_2_3_3_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_6_5")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_6_5_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_4_4_4_4")
+ ", "
+ (code "GL_UNSIGNED_SHORT_4_4_4_4_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_5_5_1")
+ ", "
+ (code "GL_UNSIGNED_SHORT_1_5_5_5_REV")
+ ", "
+ (code "GL_UNSIGNED_INT_8_8_8_8")
+ ", "
+ (code "GL_UNSIGNED_INT_8_8_8_8_REV")
+ ", "
+ (code "GL_UNSIGNED_INT_10_10_10_2")
+ ", and "
+ (code "GL_UNSIGNED_INT_2_10_10_10_REV")
+ ". "))
+ (entry (% (heading (var "data")))
+ (para "
+Specifies a pointer to the image data in memory. ")))
+ (heading "Description")
+ (para "
+Texturing maps a portion of a specified texture image
+ onto each graphical primitive for which texturing is enabled.
+ To enable and disable three-dimensional texturing, call "
+ (code "glEnable")
+ "
+and "
+ (code "glDisable")
+ " with argument "
+ (code "GL_TEXTURE_3D")
+ ". ")
+ (para (code "glTexSubImage3D")
+ " redefines a contiguous subregion of an existing three-dimensional
+ texture image.
+ The texels referenced by "
+ (var "data")
+ " replace the portion of the
+ existing texture array with x indices "
+ (var "xoffset")
+ " and "
+ (math (var "xoffset") "+" (var "width") "-" "1")
+ ",
+ inclusive,
+ y indices "
+ (var "yoffset")
+ " and "
+ (math (var "yoffset") "+" (var "height") "-" "1")
+ ",
+ inclusive,
+ and z indices "
+ (var "zoffset")
+ " and "
+ (math (var "zoffset") "+" (var "depth") "-" "1")
+ ",
+ inclusive.
+ This region may not include any texels outside the range of the
+ texture array as it was originally specified.
+ It is not an error to specify a subtexture with zero width, height, or
+ depth but such a specification has no effect. ")
+ (para "
+If a non-zero named buffer object is bound to the "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ " target
+ (see "
+ (code "glBindBuffer")
+ ") while a texture image is
+ specified, "
+ (var "data")
+ " is treated as a byte offset into the buffer object's data store. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if /"
+ (var "target")
+ " is not "
+ (code "GL_TEXTURE_3D")
+ ". ")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "format")
+ " is not an accepted
+ format constant. ")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "type")
+ " is not a type constant. ")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "type")
+ " is "
+ (code "GL_BITMAP")
+ " and "
+ (var "format")
+ " is not "
+ (code "GL_COLOR_INDEX")
+ ". ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "level")
+ " is less than 0. ")
+ (para (code "GL_INVALID_VALUE")
+ " may be generated if "
+ (var "level")
+ " is greater
+ than "
+ (math (var "log") "_" "2")
+ (var "max")
+ ",
+ where "
+ (var "max")
+ " is the returned value of "
+ (code "GL_MAX_TEXTURE_SIZE")
+ ". ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (math (var "xoffset") "<" "-" (var "b"))
+ ", "
+ (math "("
+ (var "xoffset")
+ "+"
+ (var "width")
+ ","
+ ")"
+ ">"
+ "("
+ (var "w")
+ "-"
+ (var "b")
+ ","
+ ")")
+ ", "
+ (math (var "yoffset") "<" "-" (var "b"))
+ ",
+ or "
+ (math "("
+ (var "yoffset")
+ "+"
+ (var "height")
+ ","
+ ")"
+ ">"
+ "("
+ (var "h")
+ "-"
+ (var "b")
+ ","
+ ")")
+ ",
+ or "
+ (math (var "zoffset") "<" "-" (var "b"))
+ ",
+ or "
+ (math "("
+ (var "zoffset")
+ "+"
+ (var "depth")
+ ","
+ ")"
+ ">"
+ "("
+ (var "d")
+ "-"
+ (var "b")
+ ","
+ ")")
+ ",
+ where "
+ (math (var "w"))
+ "
+is the "
+ (code "GL_TEXTURE_WIDTH")
+ ", "
+ (math (var "h"))
+ "
+is the "
+ (code "GL_TEXTURE_HEIGHT")
+ ", "
+ (math (var "d"))
+ "
+is the "
+ (code "GL_TEXTURE_DEPTH")
+ "
+and "
+ (math (var "b"))
+ "
+is the border width of the texture image being modified.
+ Note that "
+ (math (var "w"))
+ ", "
+ (math (var "h"))
+ ",
+ and "
+ (math (var "d"))
+ "
+include twice the border width. ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "width")
+ ", "
+ (var "height")
+ ", or "
+ (var "depth")
+ "
+is less than 0. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if the texture array has not
+ been defined by a previous "
+ (code "glTexImage3D")
+ " operation. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (var "type")
+ " is one of "
+ (code "GL_UNSIGNED_BYTE_3_3_2")
+ ", "
+ (code "GL_UNSIGNED_BYTE_2_3_3_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_6_5")
+ ", or "
+ (code "GL_UNSIGNED_SHORT_5_6_5_REV")
+ "
+and "
+ (var "format")
+ " is not "
+ (code "GL_RGB")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (var "type")
+ " is one of "
+ (code "GL_UNSIGNED_SHORT_4_4_4_4")
+ ", "
+ (code "GL_UNSIGNED_SHORT_4_4_4_4_REV")
+ ", "
+ (code "GL_UNSIGNED_SHORT_5_5_5_1")
+ ", "
+ (code "GL_UNSIGNED_SHORT_1_5_5_5_REV")
+ ", "
+ (code "GL_UNSIGNED_INT_8_8_8_8")
+ ", "
+ (code "GL_UNSIGNED_INT_8_8_8_8_REV")
+ ", "
+ (code "GL_UNSIGNED_INT_10_10_10_2")
+ ", or "
+ (code "GL_UNSIGNED_INT_2_10_10_10_REV")
+ "
+and "
+ (var "format")
+ " is neither "
+ (code "GL_RGBA")
+ " nor "
+ (code "GL_BGRA")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a non-zero buffer object name is bound to the "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ " target and the buffer object's data store is currently mapped. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a non-zero buffer object name is bound to the "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ " target and the data would be unpacked from the buffer
+ object such that the memory reads required would exceed the data store size. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a non-zero buffer object name is bound to the "
+ (code "GL_PIXEL_UNPACK_BUFFER")
+ " target and "
+ (var "data")
+ " is not evenly divisible
+ into the number of bytes needed to store in memory a datum indicated by "
+ (var "type")
+ ". ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glTexSubImage3D")
+ " is executed
+ between the execution of "
+ (code "glBegin")
+ " and the corresponding
+ execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glTranslate
+ "glTranslate"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glTranslated"))
+ (paramdef "GLdouble " (parameter "x"))
+ (paramdef "GLdouble " (parameter "y"))
+ (paramdef "GLdouble " (parameter "z"))))
+ '(*fragment*
+ (heading
+ "multiply the current matrix by a translation matrix")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "x")))
+ (itemx (var "y"))
+ (itemx (var "z"))
+ (para "
+Specify the "
+ (var "x")
+ ", "
+ (var "y")
+ ", and "
+ (var "z")
+ " coordinates of a translation vector. ")))
+ (heading "Description")
+ (para (code "glTranslate")
+ " produces a translation by "
+ (math "(" (var "x") "," (var "y") (var "z") ")")
+ ".
+ The current matrix
+ (see "
+ (code "glMatrixMode")
+ ")
+ is multiplied by this translation matrix,
+ with the product replacing the current matrix, as if "
+ (code "glMultMatrix")
+ " were called with the following matrix
+ for its argument: ")
+ (para (math "("
+ "("
+ "1"
+ " "
+ "0"
+ " "
+ "0"
+ " "
+ (var "x")
+ ")"
+ ", "
+ "("
+ "0"
+ " "
+ "1"
+ " "
+ "0"
+ " "
+ (var "y")
+ ")"
+ ", "
+ "("
+ "0"
+ " "
+ "0"
+ " "
+ "1"
+ " "
+ (var "z")
+ ")"
+ ", "
+ "("
+ "0"
+ " "
+ "0"
+ " "
+ "0"
+ " "
+ "1"
+ ")"
+ ","
+ ")"))
+ (para)
+ (para "
+If the matrix mode is either "
+ (code "GL_MODELVIEW")
+ " or "
+ (code "GL_PROJECTION")
+ ",
+ all objects drawn after a call to "
+ (code "glTranslate")
+ " are translated. ")
+ (para "
+Use "
+ (code "glPushMatrix")
+ " and "
+ (code "glPopMatrix")
+ " to save and restore
+ the untranslated coordinate system. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glTranslate")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glUniform1f
+ "glUniform1f"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glUniform1f"))
+ (paramdef "GLint " (parameter "location"))
+ (paramdef "GLfloat " (parameter "v0")))
+ (funcprototype
+ (funcdef "void " (function "glUniform2f"))
+ (paramdef "GLint " (parameter "location"))
+ (paramdef "GLfloat " (parameter "v0"))
+ (paramdef "GLfloat " (parameter "v1")))
+ (funcprototype
+ (funcdef "void " (function "glUniform3f"))
+ (paramdef "GLint " (parameter "location"))
+ (paramdef "GLfloat " (parameter "v0"))
+ (paramdef "GLfloat " (parameter "v1"))
+ (paramdef "GLfloat " (parameter "v2")))
+ (funcprototype
+ (funcdef "void " (function "glUniform4f"))
+ (paramdef "GLint " (parameter "location"))
+ (paramdef "GLfloat " (parameter "v0"))
+ (paramdef "GLfloat " (parameter "v1"))
+ (paramdef "GLfloat " (parameter "v2"))
+ (paramdef "GLfloat " (parameter "v3")))
+ (funcprototype
+ (funcdef "void " (function "glUniform1i"))
+ (paramdef "GLint " (parameter "location"))
+ (paramdef "GLint " (parameter "v0")))
+ (funcprototype
+ (funcdef "void " (function "glUniform2i"))
+ (paramdef "GLint " (parameter "location"))
+ (paramdef "GLint " (parameter "v0"))
+ (paramdef "GLint " (parameter "v1")))
+ (funcprototype
+ (funcdef "void " (function "glUniform3i"))
+ (paramdef "GLint " (parameter "location"))
+ (paramdef "GLint " (parameter "v0"))
+ (paramdef "GLint " (parameter "v1"))
+ (paramdef "GLint " (parameter "v2")))
+ (funcprototype
+ (funcdef "void " (function "glUniform4i"))
+ (paramdef "GLint " (parameter "location"))
+ (paramdef "GLint " (parameter "v0"))
+ (paramdef "GLint " (parameter "v1"))
+ (paramdef "GLint " (parameter "v2"))
+ (paramdef "GLint " (parameter "v3"))))
+ '(*fragment*
+ (heading
+ "Specify the value of a uniform variable for the current program object")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "location")))
+ (para "Specifies the location of the uniform variable
+\t\t to be modified."))
+ (entry (% (heading
+ (var "v0")
+ ", "
+ (var "v1")
+ ", "
+ (var "v2")
+ ", "
+ (var "v3")))
+ (para "Specifies the new values to be used for the
+\t\t specified uniform variable.")))
+ (heading "Description")
+ (para (code "glUniform")
+ " modifies the value of a
+\tuniform variable or a uniform variable array. The location of
+\tthe uniform variable to be modified is specified by\t"
+ (var "location")
+ ", which should be a value
+\treturned by\t"
+ (code "glGetUniformLocation")
+ ".\t"
+ (code "glUniform")
+ " operates on the program object
+\tthat was made part of current state by calling\t"
+ (code "glUseProgram")
+ ".")
+ (para "The commands "
+ (code "glUniform{1|2|3|4}{f|i}")
+ "
+are used to change the value of the uniform variable specified
+\tby "
+ (var "location")
+ " using the values passed as
+\targuments. The number specified in the command should match the
+\tnumber of components in the data type of the specified uniform
+\tvariable (e.g., "
+ (code "1")
+ " for float, int, bool;\t"
+ (code "2")
+ " for vec2, ivec2, bvec2, etc.). The suffix\t"
+ (code "f")
+ " indicates that floating-point values are
+\tbeing passed; the suffix "
+ (code "i")
+ " indicates that
+\tinteger values are being passed, and this type should also match
+\tthe data type of the specified uniform variable. The\t"
+ (code "i")
+ " variants of this function should be used
+\tto provide values for uniform variables defined as int, ivec2,
+\tivec3, ivec4, or arrays of these. The "
+ (code "f")
+ "
+variants should be used to provide values for uniform variables
+\tof type float, vec2, vec3, vec4, or arrays of these. Either the\t"
+ (code "i")
+ " or the "
+ (code "f")
+ " variants
+\tmay be used to provide values for uniform variables of type
+\tbool, bvec2, bvec3, bvec4, or arrays of these. The uniform
+\tvariable will be set to false if the input value is 0 or 0.0f,
+\tand it will be set to true otherwise.")
+ (para "All active uniform variables defined in a program object
+\tare initialized to 0 when the program object is linked
+\tsuccessfully. They retain the values assigned to them by a call
+\tto "
+ (code "glUniform ")
+ " until the next successful
+\tlink operation occurs on the program object, when they are once
+\tagain initialized to 0.")
+ (para "The commands "
+ (code "glUniform{1|2|3|4}{f|i}v")
+ "
+can be used to modify a single uniform variable or a uniform
+\tvariable array. These commands pass a count and a pointer to the
+\tvalues to be loaded into a uniform variable or a uniform
+\tvariable array. A count of 1 should be used if modifying the
+\tvalue of a single uniform variable, and a count of 1 or greater
+\tcan be used to modify an entire array or part of an array. When
+\tloading "
+ (var "n")
+ " elements starting at an arbitrary
+\tposition "
+ (var "m")
+ " in a uniform variable array,
+\telements "
+ (var "m")
+ " + "
+ (var "n")
+ " - 1 in
+\tthe array will be replaced with the new values. If\t"
+ (var "m")
+ " + "
+ (var "n")
+ " - 1 is
+\tlarger than the size of the uniform variable array, values for
+\tall array elements beyond the end of the array will be ignored.
+\tThe number specified in the name of the command indicates the
+\tnumber of components for each element in\t"
+ (var "value")
+ ", and it should match the number of
+\tcomponents in the data type of the specified uniform variable
+\t(e.g., "
+ (code "1")
+ " for float, int, bool;\t"
+ (code "2")
+ " for vec2, ivec2, bvec2, etc.). The data
+\ttype specified in the name of the command must match the data
+\ttype for the specified uniform variable as described previously
+\tfor "
+ (code "glUniform{1|2|3|4}{f|i}")
+ ".")
+ (para "For uniform variable arrays, each element of the array is
+\tconsidered to be of the type indicated in the name of the
+\tcommand (e.g., "
+ (code "glUniform3f")
+ " or\t"
+ (code "glUniform3fv")
+ " can be used to load a uniform
+\tvariable array of type vec3). The number of elements of the
+\tuniform variable array to be modified is specified by\t"
+ (var "count"))
+ (para "The commands\t"
+ (code "glUniformMatrix{2|3|4|2x3|3x2|2x4|4x2|3x4|4x3}fv")
+ " are used to modify a matrix or an array of matrices. The numbers in the
+\tcommand name are interpreted as the dimensionality of the matrix.
+\tThe number "
+ (code "2")
+ " indicates a 2 × 2 matrix
+\t(i.e., 4 values), the number "
+ (code "3")
+ " indicates a
+\t3 × 3 matrix (i.e., 9 values), and the number\t"
+ (code "4")
+ " indicates a 4 × 4 matrix (i.e., 16
+\tvalues). Non-square matrix dimensionality is explicit, with the first
+ number representing the number of columns and the second number
+ representing the number of rows. For example, "
+ (code "2x4")
+ " indicates a 2 × 4 matrix with 2 columns
+ and 4 rows (i.e., 8 values).
+ If "
+ (var "transpose")
+ " is\t"
+ (code "GL_FALSE")
+ ", each matrix is assumed to be
+\tsupplied in column major order. If\t"
+ (var "transpose")
+ " is\t"
+ (code "GL_TRUE")
+ ", each matrix is assumed to be
+\tsupplied in row major order. The "
+ (var "count")
+ "
+argument indicates the number of matrices to be passed. A count
+\tof 1 should be used if modifying the value of a single matrix,
+\tand a count greater than 1 can be used to modify an array of
+\tmatrices.")
+ (heading "Errors")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if there
+\tis no current program object.")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if the
+\tsize of the uniform variable declared in the shader does not
+\tmatch the size indicated by the "
+ (code "glUniform")
+ "
+command.")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if one of
+\tthe integer variants of this function is used to load a uniform
+\tvariable of type float, vec2, vec3, vec4, or an array of these,
+\tor if one of the floating-point variants of this function is
+\tused to load a uniform variable of type int, ivec2, ivec3, or
+\tivec4, or an array of these.")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if\t"
+ (var "location")
+ " is an invalid uniform location
+\tfor the current program object and\t"
+ (var "location")
+ " is not equal to -1.")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if\t"
+ (var "count")
+ " is less than 0.")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if\t"
+ (var "count")
+ " is greater than 1 and the indicated
+\tuniform variable is not an array variable.")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if a
+\tsampler is loaded using a command other than\t"
+ (code "glUniform1i")
+ " and\t"
+ (code "glUniform1iv")
+ ".")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if\t"
+ (code "glUniform")
+ " is executed between the execution
+\tof\t"
+ (code "glBegin")
+ "
+and the corresponding execution of\t"
+ (code "glEnd")
+ ".")))
+
+(define-gl-procedure
+ glUseProgram
+ "glUseProgram"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glUseProgram"))
+ (paramdef "GLuint " (parameter "program"))))
+ '(*fragment*
+ (heading
+ "Installs a program object as part of current rendering state")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "program")))
+ (para "Specifies the handle of the program object
+\t\t whose executables are to be used as part of current
+\t\t rendering state.")))
+ (heading "Description")
+ (para (code "glUseProgram")
+ " installs the program
+\tobject specified by "
+ (var "program")
+ " as part of
+\tcurrent rendering state. One or more executables are created in
+\ta program object by successfully attaching shader objects to it
+\twith\t"
+ (code "glAttachShader")
+ ",
+\tsuccessfully compiling the shader objects with\t"
+ (code "glCompileShader")
+ ",
+\tand successfully linking the program object with\t"
+ (code "glLinkProgram")
+ ".\t")
+ (para "A program object will contain an executable that will run
+\ton the vertex processor if it contains one or more shader
+\tobjects of type "
+ (code "GL_VERTEX_SHADER")
+ " that have
+\tbeen successfully compiled and linked. Similarly, a program
+\tobject will contain an executable that will run on the fragment
+\tprocessor if it contains one or more shader objects of type\t"
+ (code "GL_FRAGMENT_SHADER")
+ " that have been
+\tsuccessfully compiled and linked.")
+ (para "Successfully installing an executable on a programmable
+\tprocessor will cause the corresponding fixed functionality of
+\tOpenGL to be disabled. Specifically, if an executable is
+\tinstalled on the vertex processor, the OpenGL fixed
+\tfunctionality will be disabled as follows.")
+ (itemize
+ (item (para "The modelview matrix is not applied to vertex
+\t\tcoordinates."))
+ (item (para "The projection matrix is not applied to vertex
+\t\tcoordinates."))
+ (item (para "The texture matrices are not applied to texture
+\t\tcoordinates."))
+ (item (para "Normals are not transformed to eye
+\t\tcoordinates."))
+ (item (para "Normals are not rescaled or normalized."))
+ (item (para "Normalization of\t"
+ (code "GL_AUTO_NORMAL")
+ " evaluated normals is
+\t\tnot performed."))
+ (item (para "Texture coordinates are not generated
+\t\tautomatically."))
+ (item (para "Per-vertex lighting is not performed."))
+ (item (para "Color material computations are not
+\t\tperformed."))
+ (item (para "Color index lighting is not performed."))
+ (item (para "This list also applies when setting the current
+\t\traster position.")))
+ (para "The executable that is installed on the vertex processor
+\tis expected to implement any or all of the desired functionality
+\tfrom the preceding list. Similarly, if an executable is
+\tinstalled on the fragment processor, the OpenGL fixed
+\tfunctionality will be disabled as follows.")
+ (itemize
+ (item (para "Texture environment and texture functions are not
+\t\tapplied."))
+ (item (para "Texture application is not applied."))
+ (item (para "Color sum is not applied."))
+ (item (para "Fog is not applied.")))
+ (para "Again, the fragment shader that is installed is expected
+\tto implement any or all of the desired functionality from the
+\tpreceding list.")
+ (para "While a program object is in use, applications are free to
+\tmodify attached shader objects, compile attached shader objects,
+\tattach additional shader objects, and detach or delete shader
+\tobjects. None of these operations will affect the executables
+\tthat are part of the current state. However, relinking the
+\tprogram object that is currently in use will install the program
+\tobject as part of the current rendering state if the link
+\toperation was successful (see\t"
+ (code "glLinkProgram")
+ "
+). If the program object currently in use is relinked
+\tunsuccessfully, its link status will be set to\t"
+ (code "GL_FALSE")
+ ", but the executables and
+\tassociated state will remain part of the current state until a
+\tsubsequent call to "
+ (code "glUseProgram")
+ " removes it
+\tfrom use. After it is removed from use, it cannot be made part
+\tof current state until it has been successfully relinked.")
+ (para "If "
+ (var "program")
+ " contains shader objects
+\tof type "
+ (code "GL_VERTEX_SHADER")
+ " but it does not
+\tcontain shader objects of type\t"
+ (code "GL_FRAGMENT_SHADER")
+ ", an executable will be
+\tinstalled on the vertex processor, but fixed functionality will
+\tbe used for fragment processing. Similarly, if\t"
+ (var "program")
+ " contains shader objects of type\t"
+ (code "GL_FRAGMENT_SHADER")
+ " but it does not contain
+\tshader objects of type "
+ (code "GL_VERTEX_SHADER")
+ ", an
+\texecutable will be installed on the fragment processor, but
+\tfixed functionality will be used for vertex processing. If\t"
+ (var "program")
+ " is 0, the programmable processors
+\twill be disabled, and fixed functionality will be used for both
+\tvertex and fragment processing.")
+ (heading "Errors")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if\t"
+ (var "program")
+ " is neither 0 nor a value
+\tgenerated by OpenGL.")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if\t"
+ (var "program")
+ " is not a program object.")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if\t"
+ (var "program")
+ " could not be made part of current
+\tstate.")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if\t"
+ (code "glUseProgram")
+ " is executed between the
+\texecution of\t"
+ (code "glBegin")
+ "
+and the corresponding execution of\t"
+ (code "glEnd")
+ ".")))
+
+(define-gl-procedure
+ glValidateProgram
+ "glValidateProgram"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glValidateProgram"))
+ (paramdef "GLuint " (parameter "program"))))
+ '(*fragment*
+ (heading "Validates a program object")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "program")))
+ (para "Specifies the handle of the program object to
+\t\t be validated.")))
+ (heading "Description")
+ (para (code "glValidateProgram")
+ " checks to see
+\twhether the executables contained in\t"
+ (var "program")
+ " can execute given the current
+\tOpenGL state. The information generated by the validation
+\tprocess will be stored in "
+ (var "program")
+ "'s
+\tinformation log. The validation information may consist of an
+\tempty string, or it may be a string containing information about
+\thow the current program object interacts with the rest of
+\tcurrent OpenGL state. This provides a way for OpenGL
+\timplementers to convey more information about why the current
+\tprogram is inefficient, suboptimal, failing to execute, and so
+\ton.")
+ (para "The status of the validation operation will be stored as
+\tpart of the program object's state. This value will be set to\t"
+ (code "GL_TRUE")
+ " if the validation succeeded, and\t"
+ (code "GL_FALSE")
+ " otherwise. It can be queried by
+\tcalling\t"
+ (code "glGetProgram")
+ "
+with arguments "
+ (var "program")
+ " and\t"
+ (code "GL_VALIDATE_STATUS")
+ ". If validation is
+\tsuccessful, "
+ (var "program")
+ " is guaranteed to
+\texecute given the current state. Otherwise,\t"
+ (var "program")
+ " is guaranteed to not execute.")
+ (para "This function is typically useful only during application
+\tdevelopment. The informational string stored in the information
+\tlog is completely implementation dependent; therefore, an
+\tapplication should not expect different OpenGL implementations
+\tto produce identical information strings.")
+ (heading "Errors")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if\t"
+ (var "program")
+ " is not a value generated by
+\tOpenGL.")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if\t"
+ (var "program")
+ " is not a program object.")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if\t"
+ (code "glValidateProgram")
+ " is executed between the
+\texecution of\t"
+ (code "glBegin")
+ "
+and the corresponding execution of\t"
+ (code "glEnd")
+ ".")))
+
+(define-gl-procedure
+ glVertexAttribPointer
+ "glVertexAttribPointer"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "void "
+ (function "glVertexAttribPointer"))
+ (paramdef "GLuint " (parameter "index"))
+ (paramdef "GLint " (parameter "size"))
+ (paramdef "GLenum " (parameter "type"))
+ (paramdef "GLboolean " (parameter "normalized"))
+ (paramdef "GLsizei " (parameter "stride"))
+ (paramdef
+ "const GLvoid * "
+ (parameter "pointer"))))
+ '(*fragment*
+ (heading
+ "define an array of generic vertex attribute data")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "index")))
+ (para "Specifies the index of the generic vertex
+\t\t attribute to be modified."))
+ (entry (% (heading (var "size")))
+ (para "Specifies the number of components per
+\t\t generic vertex attribute. Must
+\t\t be 1, 2, 3, or 4. The initial value is 4."))
+ (entry (% (heading (var "type")))
+ (para "Specifies the data type of each component in
+\t\t the array. Symbolic constants "
+ (code "GL_BYTE")
+ ", "
+ (code "GL_UNSIGNED_BYTE")
+ ", "
+ (code "GL_SHORT")
+ ", "
+ (code "GL_UNSIGNED_SHORT")
+ ", "
+ (code "GL_INT")
+ ", "
+ (code "GL_UNSIGNED_INT")
+ ", "
+ (code "GL_FLOAT")
+ ", or "
+ (code "GL_DOUBLE")
+ " are
+\t\t accepted. The initial value is "
+ (code "GL_FLOAT")
+ "."))
+ (entry (% (heading (var "normalized")))
+ (para "Specifies whether fixed-point data values
+\t\t should be normalized ("
+ (code "GL_TRUE")
+ ")
+\t\t or converted directly as fixed-point values
+\t\t ("
+ (code "GL_FALSE")
+ ") when they are
+\t\t accessed."))
+ (entry (% (heading (var "stride")))
+ (para "Specifies the byte offset between consecutive
+\t\t generic vertex attributes. If "
+ (var "stride")
+ "
+is 0, the generic vertex attributes are
+\t\t understood to be tightly packed in the
+\t\t array. The initial value is 0."))
+ (entry (% (heading (var "pointer")))
+ (para "Specifies a pointer to the first component of
+\t\t the first generic vertex attribute in the array. The initial value is 0.")))
+ (heading "Description")
+ (para (code "glVertexAttribPointer")
+ " specifies the
+\tlocation and data format of the array of generic vertex attributes at index "
+ (var "index")
+ "
+to use when rendering. "
+ (var "size")
+ "
+specifies the number of components per attribute and must be 1,
+\t2, 3, or 4. "
+ (var "type")
+ " specifies the data type
+\tof each component, and "
+ (var "stride")
+ " specifies
+\tthe byte stride from one attribute to the next, allowing vertices and
+\tattributes to be packed into a single array or
+\tstored in separate arrays.
+ If set to "
+ (code "GL_TRUE")
+ ",\t"
+ (var "normalized")
+ " indicates that values stored
+\tin an integer format are to be mapped to the range [-1,1] (for
+\tsigned values) or [0,1] (for unsigned values) when they are
+\taccessed and converted to floating point. Otherwise, values will
+\tbe converted to floats directly without normalization.")
+ (para "If a non-zero named buffer object is bound to the "
+ (code "GL_ARRAY_BUFFER")
+ " target
+ (see "
+ (code "glBindBuffer")
+ ") while a generic vertex attribute array is
+ specified, "
+ (var "pointer")
+ " is treated as a byte offset into the buffer object's data store.
+ Also, the buffer object binding ("
+ (code "GL_ARRAY_BUFFER_BINDING")
+ ") is saved as generic vertex attribute array
+ client-side state ("
+ (code "GL_VERTEX_ATTRIB_ARRAY_BUFFER_BINDING")
+ ") for index "
+ (var "index")
+ ".")
+ (para "When a generic vertex attribute array is specified,\t"
+ (var "size")
+ ", "
+ (var "type")
+ ",\t"
+ (var "normalized")
+ ",\t"
+ (var "stride")
+ ", and\t"
+ (var "pointer")
+ " are saved as client-side
+\tstate, in addition to the current vertex array buffer object binding.")
+ (para "To enable and disable a generic vertex attribute array,
+\tcall\t"
+ (code "glEnableVertexAttribArray")
+ "
+and\t"
+ (code "glDisableVertexAttribArray")
+ "
+with "
+ (var "index")
+ ". If enabled, the generic
+\tvertex attribute array is used when "
+ (code "glArrayElement")
+ ", "
+ (code "glDrawArrays")
+ ", "
+ (code "glMultiDrawArrays")
+ ", "
+ (code "glDrawElements")
+ ", "
+ (code "glMultiDrawElements")
+ ", or "
+ (code "glDrawRangeElements")
+ "
+is called.")
+ (heading "Errors")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if\t"
+ (var "index")
+ " is greater than or equal to\t"
+ (code "GL_MAX_VERTEX_ATTRIBS")
+ ".")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if\t"
+ (var "size")
+ " is not 1, 2, 3, or 4.")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if\t"
+ (var "type")
+ " is not an accepted value.")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if\t"
+ (var "stride")
+ " is negative.")))
+
+(define-gl-procedure
+ glVertexAttrib
+ "glVertexAttrib"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glVertexAttrib1f"))
+ (paramdef "GLuint " (parameter "index"))
+ (paramdef "GLfloat " (parameter "v0")))
+ (funcprototype
+ (funcdef "void " (function "glVertexAttrib1s"))
+ (paramdef "GLuint " (parameter "index"))
+ (paramdef "GLshort " (parameter "v0")))
+ (funcprototype
+ (funcdef "void " (function "glVertexAttrib1d"))
+ (paramdef "GLuint " (parameter "index"))
+ (paramdef "GLdouble " (parameter "v0")))
+ (funcprototype
+ (funcdef "void " (function "glVertexAttrib2f"))
+ (paramdef "GLuint " (parameter "index"))
+ (paramdef "GLfloat " (parameter "v0"))
+ (paramdef "GLfloat " (parameter "v1")))
+ (funcprototype
+ (funcdef "void " (function "glVertexAttrib2s"))
+ (paramdef "GLuint " (parameter "index"))
+ (paramdef "GLshort " (parameter "v0"))
+ (paramdef "GLshort " (parameter "v1")))
+ (funcprototype
+ (funcdef "void " (function "glVertexAttrib2d"))
+ (paramdef "GLuint " (parameter "index"))
+ (paramdef "GLdouble " (parameter "v0"))
+ (paramdef "GLdouble " (parameter "v1")))
+ (funcprototype
+ (funcdef "void " (function "glVertexAttrib3f"))
+ (paramdef "GLuint " (parameter "index"))
+ (paramdef "GLfloat " (parameter "v0"))
+ (paramdef "GLfloat " (parameter "v1"))
+ (paramdef "GLfloat " (parameter "v2")))
+ (funcprototype
+ (funcdef "void " (function "glVertexAttrib3s"))
+ (paramdef "GLuint " (parameter "index"))
+ (paramdef "GLshort " (parameter "v0"))
+ (paramdef "GLshort " (parameter "v1"))
+ (paramdef "GLshort " (parameter "v2")))
+ (funcprototype
+ (funcdef "void " (function "glVertexAttrib3d"))
+ (paramdef "GLuint " (parameter "index"))
+ (paramdef "GLdouble " (parameter "v0"))
+ (paramdef "GLdouble " (parameter "v1"))
+ (paramdef "GLdouble " (parameter "v2")))
+ (funcprototype
+ (funcdef "void " (function "glVertexAttrib4f"))
+ (paramdef "GLuint " (parameter "index"))
+ (paramdef "GLfloat " (parameter "v0"))
+ (paramdef "GLfloat " (parameter "v1"))
+ (paramdef "GLfloat " (parameter "v2"))
+ (paramdef "GLfloat " (parameter "v3")))
+ (funcprototype
+ (funcdef "void " (function "glVertexAttrib4s"))
+ (paramdef "GLuint " (parameter "index"))
+ (paramdef "GLshort " (parameter "v0"))
+ (paramdef "GLshort " (parameter "v1"))
+ (paramdef "GLshort " (parameter "v2"))
+ (paramdef "GLshort " (parameter "v3")))
+ (funcprototype
+ (funcdef "void " (function "glVertexAttrib4d"))
+ (paramdef "GLuint " (parameter "index"))
+ (paramdef "GLdouble " (parameter "v0"))
+ (paramdef "GLdouble " (parameter "v1"))
+ (paramdef "GLdouble " (parameter "v2"))
+ (paramdef "GLdouble " (parameter "v3")))
+ (funcprototype
+ (funcdef "void " (function "glVertexAttrib4Nub"))
+ (paramdef "GLuint " (parameter "index"))
+ (paramdef "GLubyte " (parameter "v0"))
+ (paramdef "GLubyte " (parameter "v1"))
+ (paramdef "GLubyte " (parameter "v2"))
+ (paramdef "GLubyte " (parameter "v3"))))
+ '(*fragment*
+ (heading
+ "Specifies the value of a generic vertex attribute")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "index")))
+ (para "Specifies the index of the generic vertex
+\t\t attribute to be modified."))
+ (entry (% (heading
+ (var "v0")
+ ", "
+ (var "v1")
+ ", "
+ (var "v2")
+ ", "
+ (var "v3")))
+ (para "Specifies the new values to be used for the
+\t\t specified vertex attribute.")))
+ (heading "Description")
+ (para "OpenGL defines a number of standard vertex attributes that
+\tapplications can modify with standard API entry points (color,
+\tnormal, texture coordinates, etc.). The\t"
+ (code "glVertexAttrib")
+ " family of entry points
+\tallows an application to pass generic vertex attributes in
+\tnumbered locations.")
+ (para "Generic attributes are defined as four-component values
+\tthat are organized into an array. The first entry of this array
+\tis numbered 0, and the size of the array is specified by the
+\timplementation-dependent constant\t"
+ (code "GL_MAX_VERTEX_ATTRIBS")
+ ". Individual elements
+\tof this array can be modified with a\t"
+ (code "glVertexAttrib")
+ " call that specifies the
+\tindex of the element to be modified and a value for that
+\telement.")
+ (para "These commands can be used to specify one, two, three, or
+\tall four components of the generic vertex attribute specified by\t"
+ (var "index")
+ ". A "
+ (code "1")
+ " in the
+\tname of the command indicates that only one value is passed, and
+\tit will be used to modify the first component of the generic
+\tvertex attribute. The second and third components will be set to
+\t0, and the fourth component will be set to 1. Similarly, a\t"
+ (code "2")
+ " in the name of the command indicates that
+\tvalues are provided for the first two components, the third
+\tcomponent will be set to 0, and the fourth component will be set
+\tto 1. A "
+ (code "3")
+ " in the name of the command
+\tindicates that values are provided for the first three
+\tcomponents and the fourth component will be set to 1, whereas a\t"
+ (code "4")
+ " in the name indicates that values are
+\tprovided for all four components.")
+ (para "The letters "
+ (code "s")
+ ",\t"
+ (code "f")
+ ", "
+ (code "i")
+ ",\t"
+ (code "d")
+ ", "
+ (code "ub")
+ ",\t"
+ (code "us")
+ ", and "
+ (code "ui")
+ " indicate
+\twhether the arguments are of type short, float, int, double,
+\tunsigned byte, unsigned short, or unsigned int. When\t"
+ (code "v")
+ " is appended to the name, the commands can
+\ttake a pointer to an array of such values. The commands
+\tcontaining "
+ (code "N")
+ " indicate that the arguments
+\twill be passed as fixed-point values that are scaled to a
+\tnormalized range according to the component conversion rules
+\tdefined by the OpenGL specification. Signed values are
+\tunderstood to represent fixed-point values in the range [-1,1],
+\tand unsigned values are understood to represent fixed-point
+\tvalues in the range [0,1].")
+ (para "OpenGL Shading Language attribute variables are allowed to
+\tbe of type mat2, mat3, or mat4. Attributes of these types may be
+\tloaded using the "
+ (code "glVertexAttrib")
+ " entry
+\tpoints. Matrices must be loaded into successive generic
+\tattribute slots in column major order, with one column of the
+\tmatrix in each generic attribute slot.")
+ (para "A user-defined attribute variable declared in a vertex
+\tshader can be bound to a generic attribute index by calling\t"
+ (code "glBindAttribLocation")
+ ".
+\tThis allows an application to use more descriptive variable
+\tnames in a vertex shader. A subsequent change to the specified
+\tgeneric vertex attribute will be immediately reflected as a
+\tchange to the corresponding attribute variable in the vertex
+\tshader.")
+ (para "The binding between a generic vertex attribute index and a
+\tuser-defined attribute variable in a vertex shader is part of
+\tthe state of a program object, but the current value of the
+\tgeneric vertex attribute is not. The value of each generic
+\tvertex attribute is part of current state, just like standard
+\tvertex attributes, and it is maintained even if a different
+\tprogram object is used.")
+ (para "An application may freely modify generic vertex attributes
+\tthat are not bound to a named vertex shader attribute variable.
+\tThese values are simply maintained as part of current state and
+\twill not be accessed by the vertex shader. If a generic vertex
+\tattribute bound to an attribute variable in a vertex shader is
+\tnot updated while the vertex shader is executing, the vertex
+\tshader will repeatedly use the current value for the generic
+\tvertex attribute.")
+ (para "The generic vertex attribute with index 0 is the same as
+\tthe vertex position attribute previously defined by OpenGL. A\t"
+ (code "glVertex2")
+ ",\t"
+ (code "glVertex3")
+ ",
+\tor\t"
+ (code "glVertex4")
+ "
+command is completely equivalent to the corresponding\t"
+ (code "glVertexAttrib")
+ " command with an index
+\targument of 0. A vertex shader can access generic vertex
+\tattribute 0 by using the built-in attribute variable\t"
+ (var "gl_Vertex")
+ ". There are no current values
+\tfor generic vertex attribute 0. This is the only generic vertex
+\tattribute with this property; calls to set other standard vertex
+\tattributes can be freely mixed with calls to set any of the
+\tother generic vertex attributes.")
+ (heading "Errors")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if\t"
+ (var "index")
+ " is greater than or equal to\t"
+ (code "GL_MAX_VERTEX_ATTRIBS")
+ ".")))
+
+(define-gl-procedure
+ glVertexPointer
+ "glVertexPointer"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glVertexPointer"))
+ (paramdef "GLint " (parameter "size"))
+ (paramdef "GLenum " (parameter "type"))
+ (paramdef "GLsizei " (parameter "stride"))
+ (paramdef
+ "const GLvoid * "
+ (parameter "pointer"))))
+ '(*fragment*
+ (heading "define an array of vertex data")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "size")))
+ (para "
+Specifies the number of coordinates per vertex. Must be 2, 3, or
+ 4. The initial value is 4. "))
+ (entry (% (heading (var "type")))
+ (para "
+Specifies the data type of each coordinate in the array.
+ Symbolic constants "
+ (code "GL_SHORT")
+ ", "
+ (code "GL_INT")
+ ", "
+ (code "GL_FLOAT")
+ ",
+ or "
+ (code "GL_DOUBLE")
+ "
+are accepted. The initial value is "
+ (code "GL_FLOAT")
+ ". "))
+ (entry (% (heading (var "stride")))
+ (para "
+Specifies the byte offset between consecutive
+ vertices. If "
+ (var "stride")
+ " is 0, the vertices are understood to be tightly packed in
+ the array. The initial value
+ is 0. "))
+ (entry (% (heading (var "pointer")))
+ (para "
+Specifies a pointer to the first coordinate of the first vertex in the
+ array. The initial value is 0. ")))
+ (heading "Description")
+ (para (code "glVertexPointer")
+ " specifies the location and data format of an array of vertex coordinates
+ to use when rendering. "
+ (var "size")
+ " specifies the number of coordinates per vertex, and must be 2, 3, or 4. "
+ (var "type")
+ " specifies the data type of each coordinate, and "
+ (var "stride")
+ " specifies the byte stride from one
+ vertex to the next, allowing vertices and attributes
+ to be packed into a single array or stored in separate arrays.
+ (Single-array storage may be more efficient on some implementations;
+ see "
+ (code "glInterleavedArrays")
+ ".) ")
+ (para "
+If a non-zero named buffer object is bound to the "
+ (code "GL_ARRAY_BUFFER")
+ " target
+ (see "
+ (code "glBindBuffer")
+ ") while a vertex array is
+ specified, "
+ (var "pointer")
+ " is treated as a byte offset into the buffer object's data store.
+ Also, the buffer object binding ("
+ (code "GL_ARRAY_BUFFER_BINDING")
+ ") is saved as vertex array
+ client-side state ("
+ (code "GL_VERTEX_ARRAY_BUFFER_BINDING")
+ "). ")
+ (para "
+When a vertex array is specified, "
+ (var "size")
+ ", "
+ (var "type")
+ ", "
+ (var "stride")
+ ", and "
+ (var "pointer")
+ " are saved as client-side
+ state, in addition to the current vertex array buffer object binding. ")
+ (para "
+To enable and disable the vertex array, call "
+ (code "glEnableClientState")
+ " and "
+ (code "glDisableClientState")
+ " with the argument "
+ (code "GL_VERTEX_ARRAY")
+ ". If
+ enabled, the vertex array is used when "
+ (code "glArrayElement")
+ ", "
+ (code "glDrawArrays")
+ ", "
+ (code "glMultiDrawArrays")
+ ", "
+ (code "glDrawElements")
+ ", "
+ (code "glMultiDrawElements")
+ ", or "
+ (code "glDrawRangeElements")
+ "
+is called. ")
+ (heading "Errors")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "size")
+ " is not 2, 3, or 4. ")
+ (para (code "GL_INVALID_ENUM")
+ " is generated if "
+ (var "type")
+ " is not an accepted value. ")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if "
+ (var "stride")
+ " is negative. ")))
+
+(define-gl-procedure
+ glVertex
+ "glVertex"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glVertex2s"))
+ (paramdef "GLshort " (parameter "x"))
+ (paramdef "GLshort " (parameter "y"))))
+ '(*fragment*
+ (heading "specify a vertex")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "x")))
+ (itemx (var "y"))
+ (itemx (var "z"))
+ (itemx (var "w"))
+ (para "
+Specify "
+ (var "x")
+ ", "
+ (var "y")
+ ", "
+ (var "z")
+ ", and "
+ (var "w")
+ " coordinates of a vertex.
+ Not all parameters are present in all forms of the command. ")))
+ (heading "Description")
+ (para (code "glVertex")
+ " commands are used within "
+ (code "glBegin")
+ "/"
+ (code "glEnd")
+ " pairs to specify
+ point, line, and polygon vertices. The current color, normal, texture
+ coordinates, and fog coordinate are associated with the vertex when "
+ (code "glVertex")
+ "
+is called. ")
+ (para "
+When only "
+ (math (var "x"))
+ "
+and "
+ (math (var "y"))
+ "
+are specified, "
+ (math (var "z"))
+ "
+defaults to 0 and "
+ (math (var "w"))
+ "
+defaults to 1. When "
+ (math (var "x"))
+ ", "
+ (math (var "y"))
+ ",
+ and "
+ (math (var "z"))
+ "
+are specified, "
+ (math (var "w"))
+ "
+defaults to 1. ")))
+
+(define-gl-procedure
+ glViewport
+ "glViewport"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glViewport"))
+ (paramdef "GLint " (parameter "x"))
+ (paramdef "GLint " (parameter "y"))
+ (paramdef "GLsizei " (parameter "width"))
+ (paramdef "GLsizei " (parameter "height"))))
+ '(*fragment*
+ (heading "set the viewport")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "x")))
+ (itemx (var "y"))
+ (para "
+Specify the lower left corner of the viewport rectangle,
+ in pixels. The initial value is (0,0). "))
+ (entry (% (heading (var "width")))
+ (itemx (var "height"))
+ (para "
+Specify the width and height
+ of the viewport.
+ When a GL context is first attached to a window, "
+ (var "width")
+ " and "
+ (var "height")
+ " are set to the dimensions of that
+ window. ")))
+ (heading "Description")
+ (para (code "glViewport")
+ " specifies the affine transformation of "
+ (math (var "x"))
+ "
+and "
+ (math (var "y"))
+ "
+from
+ normalized device coordinates to window coordinates.
+ Let "
+ (math "("
+ (var "x")
+ "_"
+ (var "nd")
+ ","
+ (var "y")
+ "_"
+ (var "nd")
+ ")")
+ "
+be normalized device coordinates.
+ Then the window coordinates "
+ (math "("
+ (var "x")
+ "_"
+ (var "w")
+ ","
+ (var "y")
+ "_"
+ (var "w")
+ ")")
+ "
+are computed as follows: ")
+ (para (math (var "x")
+ "_"
+ (var "w")
+ "="
+ "("
+ (var "x")
+ "_"
+ (var "nd")
+ "+"
+ "1"
+ ","
+ ")"
+ "\u2062"
+ "("
+ (var "width")
+ "/"
+ "2"
+ ","
+ ")"
+ "+"
+ (var "x")))
+ (para (math (var "y")
+ "_"
+ (var "w")
+ "="
+ "("
+ (var "y")
+ "_"
+ (var "nd")
+ "+"
+ "1"
+ ","
+ ")"
+ "\u2062"
+ "("
+ (var "height")
+ "/"
+ "2"
+ ","
+ ")"
+ "+"
+ (var "y")))
+ (para "
+Viewport width and height are silently clamped
+ to a range that depends on the implementation.
+ To query this range, call "
+ (code "glGet")
+ " with argument "
+ (code "GL_MAX_VIEWPORT_DIMS")
+ ". ")
+ (heading "Errors")
+ (para (code "GL_INVALID_VALUE")
+ " is generated if either "
+ (var "width")
+ " or "
+ (var "height")
+ " is negative. ")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glViewport")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
+(define-gl-procedure
+ glWindowPos
+ "glWindowPos"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glWindowPos2s"))
+ (paramdef "GLshort " (parameter "x"))
+ (paramdef "GLshort " (parameter "y"))))
+ '(*fragment*
+ (heading
+ "specify the raster position in window coordinates for pixel operations")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "x")))
+ (itemx (var "y"))
+ (itemx (var "z"))
+ (para "
+Specify the "
+ (math (var "x"))
+ ", "
+ (math (var "y"))
+ ", "
+ (math (var "z"))
+ "
+coordinates for the raster position. ")))
+ (heading "Description")
+ (para "
+The GL maintains a 3D position in window coordinates. This position,
+ called the raster position, is used to position pixel and bitmap write
+ operations. It is maintained with subpixel accuracy. See "
+ (code "glBitmap")
+ ", "
+ (code "glDrawPixels")
+ ", and "
+ (code "glCopyPixels")
+ ". ")
+ (para (code "glWindowPos2")
+ " specifies the "
+ (math (var "x"))
+ "
+and "
+ (math (var "y"))
+ "
+coordinates, while "
+ (math (var "z"))
+ "
+is
+ implicitly set to 0. "
+ (code "glWindowPos3")
+ " specifies all three coordinates.
+ The "
+ (math (var "w"))
+ "
+coordinate of the current raster position is always set to 1.0. ")
+ (para (code "glWindowPos")
+ " directly updates the "
+ (math (var "x"))
+ "
+and "
+ (math (var "y"))
+ "
+coordinates of the current raster
+ position with the values specified. That is, the values are neither
+ transformed by the current modelview and projection matrices, nor by
+ the viewport-to-window transform. The "
+ (math (var "z"))
+ "
+coordinate of the current raster
+ position is updated in the following manner: ")
+ (para (math (var "z")
+ "="
+ "{"
+ "("
+ (var "n")
+ ")"
+ ", "
+ "("
+ (var "f")
+ ")"
+ ", "
+ "("
+ (var "n")
+ "+"
+ (var "z")
+ "×"
+ "("
+ (var "f")
+ "-"
+ (var "n")
+ ","
+ ")"
+ ","
+ ")"
+ "\u2062"
+ "("
+ (var "if")
+ "\u2062"
+ (var "z")
+ "<="
+ "0"
+ ")"
+ ", "
+ "("
+ (var "if")
+ "\u2062"
+ (var "z")
+ ">="
+ "1"
+ ")"
+ ", "
+ "("
+ (code "otherwise")
+ ","
+ ")"
+ ","))
+ (para)
+ (para "
+where "
+ (math (var "n"))
+ "
+is "
+ (code "GL_DEPTH_RANGE")
+ "'s near value, and "
+ (math (var "f"))
+ "
+is "
+ (code "GL_DEPTH_RANGE")
+ "'s far value. See "
+ (code "glDepthRange")
+ ". ")
+ (para "
+The specified coordinates are not clip-tested, causing the raster position
+ to always be valid. ")
+ (para "
+The current raster position also includes some associated color data and
+ texture coordinates. If lighting is enabled, then "
+ (code "GL_CURRENT_RASTER_COLOR")
+ " (in RGBA mode) or "
+ (code "GL_CURRENT_RASTER_INDEX")
+ "
+(in color index mode) is set to the color produced by the lighting
+ calculation (see "
+ (code "glLight")
+ ", "
+ (code "glLightModel")
+ ", and "
+ (code "glShadeModel")
+ ").
+ If lighting is disabled, current color (in RGBA mode, state variable "
+ (code "GL_CURRENT_COLOR")
+ ") or color index (in color index mode, state variable "
+ (code "GL_CURRENT_INDEX")
+ ") is used to update the current raster color. "
+ (code "GL_CURRENT_RASTER_SECONDARY_COLOR")
+ " (in RGBA mode) is likewise updated. ")
+ (para "
+Likewise, "
+ (code "GL_CURRENT_RASTER_TEXTURE_COORDS")
+ " is updated as a function of "
+ (code "GL_CURRENT_TEXTURE_COORDS")
+ ", based on the texture matrix and the texture
+ generation functions (see "
+ (code "glTexGen")
+ "). The "
+ (code "GL_CURRENT_RASTER_DISTANCE")
+ " is set to the "
+ (code "GL_CURRENT_FOG_COORD")
+ ". ")
+ (para)
+ (heading "Errors")
+ (para (code "GL_INVALID_OPERATION")
+ " is generated if "
+ (code "glWindowPos")
+ "
+is executed between the execution of "
+ (code "glBegin")
+ "
+and the corresponding execution of "
+ (code "glEnd")
+ ". ")))
+
--- /dev/null
+;;; figl -*- mode: scheme; coding: utf-8 -*-
+;;; Copyright (C) 2013 Andy Wingo <wingo@pobox.com>
+;;;
+;;; Figl is free software: you can redistribute it and/or modify it
+;;; under the terms of the GNU Lesser General Public License as
+;;; published by the Free Software Foundation, either version 3 of the
+;;; License, or (at your option) any later version.
+;;;
+;;; Figl is distributed in the hope that it will be useful, but WITHOUT
+;;; ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+;;; or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
+;;; Public License for more details.
+;;;
+;;; You should have received a copy of the GNU Lesser General Public
+;;; License along with this program. If not, see
+;;; <http://www.gnu.org/licenses/>.
+;;;
+;;; Derived from upstream OpenGL documentation.
+;;;
+;;; Copyright
+;;; =========
+;;;
+;;; Copyright (C) 1991-2006 Silicon Graphics, Inc. This document is licensed
+;;; under the SGI Free Software B License. For details, see
+;;; http://oss.sgi.com/projects/FreeB/ (http://oss.sgi.com/projects/FreeB/).
+;;;
+;;; Automatically generated; you probably don't want to edit this. To
+;;; update, run "make update" in the top-level build tree.
+;;;
+
+(define-module
+ (figl low-level glu)
+ #:use-module
+ (figl low-level support)
+ #:export
+ (gluBeginCurve
+ gluBeginPolygon
+ gluBeginSurface
+ gluBeginTrim
+ gluBuild1DMipmapLevels
+ gluBuild1DMipmaps
+ gluBuild2DMipmapLevels
+ gluBuild2DMipmaps
+ gluBuild3DMipmapLevels
+ gluBuild3DMipmaps
+ gluCheckExtension
+ gluCylinder
+ gluDeleteNurbsRenderer
+ gluDeleteQuadric
+ gluDeleteTess
+ gluDisk
+ gluErrorString
+ gluGetNurbsProperty
+ gluGetString
+ gluGetTessProperty
+ gluLoadSamplingMatrices
+ gluLookAt
+ gluNewNurbsRenderer
+ gluNewQuadric
+ gluNewTess
+ gluNextContour
+ gluNurbsCallbackDataEXT
+ gluNurbsCallbackData
+ gluNurbsCallback
+ gluNurbsCurve
+ gluNurbsProperty
+ gluNurbsSurface
+ gluOrtho2D
+ gluPartialDisk
+ gluPerspective
+ gluPickMatrix
+ gluProject
+ gluPwlCurve
+ gluQuadricCallback
+ gluQuadricDrawStyle
+ gluQuadricNormals
+ gluQuadricOrientation
+ gluQuadricTexture
+ gluScaleImage
+ gluSphere
+ gluTessBeginContour
+ gluTessBeginPolygon
+ gluTessCallback
+ gluTessEndPolygon
+ gluTessNormal
+ gluTessProperty
+ gluTessVertex
+ gluUnProject4
+ gluUnProject))
+
+(define-gl-procedure
+ gluBeginCurve
+ "gluBeginCurve"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "gluBeginCurve"))
+ (paramdef "GLUnurbs* " (parameter "nurb"))))
+ '(*fragment*
+ (heading "delimit a NURBS curve definition")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "nurb")))
+ (para "
+Specifies the NURBS object (created with "
+ (code "gluNewNurbsRenderer")
+ "). ")))
+ (heading "Description")
+ (para "
+Use "
+ (code "gluBeginCurve")
+ " to mark the beginning of a NURBS
+ curve definition.
+ After
+ calling "
+ (code "gluBeginCurve")
+ ", make one or more calls to "
+ (code "gluNurbsCurve")
+ " to define the attributes of the curve.
+ Exactly one of the calls to "
+ (code "gluNurbsCurve")
+ " must have
+ a curve type of "
+ (code "GLU_MAP1_VERTEX_3")
+ " or "
+ (code "GLU_MAP1_VERTEX_4")
+ ".
+ To mark the end of the NURBS curve definition, call "
+ (code "gluEndCurve")
+ ". ")
+ (para "
+GL evaluators are used to render the NURBS curve as a series of line
+ segments.
+ Evaluator state is preserved during rendering
+ with "
+ (code "glPushAttrib")
+ "("
+ (code "GLU_EVAL_BIT")
+ ") and "
+ (code "glPopAttrib")
+ "().
+ See the "
+ (code "glPushAttrib")
+ " reference page for details on exactly what state
+ these calls preserve. ")))
+
+(define-gl-procedure
+ gluBeginPolygon
+ "gluBeginPolygon"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "gluBeginPolygon"))
+ (paramdef "GLUtesselator* " (parameter "tess"))))
+ '(*fragment*
+ (heading "delimit a polygon description")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "tess")))
+ (para "
+Specifies the tessellation object (created with "
+ (code "gluNewTess")
+ "). ")))
+ (heading "Description")
+ (para (code "gluBeginPolygon")
+ " and "
+ (code "gluEndPolygon")
+ " delimit the definition of a
+ nonconvex polygon.
+ To define such a polygon, first call "
+ (code "gluBeginPolygon")
+ ".
+ Then define the contours of the polygon
+ by calling "
+ (code "gluTessVertex")
+ " for each vertex
+ and "
+ (code "gluNextContour")
+ " to start each new contour.
+ Finally, call "
+ (code "gluEndPolygon")
+ "
+to signal the end of the definition.
+ See the "
+ (code "gluTessVertex")
+ " and "
+ (code "gluNextContour")
+ " reference pages for more details. ")
+ (para "
+Once "
+ (code "gluEndPolygon")
+ " is called, the polygon is tessellated, and the
+ resulting triangles are described through callbacks.
+ See "
+ (code "gluTessCallback")
+ " for descriptions of the callback functions. ")))
+
+(define-gl-procedure
+ gluBeginSurface
+ "gluBeginSurface"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "gluBeginSurface"))
+ (paramdef "GLUnurbs* " (parameter "nurb"))))
+ '(*fragment*
+ (heading "delimit a NURBS surface definition")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "nurb")))
+ (para "
+Specifies the NURBS object (created with "
+ (code "gluNewNurbsRenderer")
+ "). ")))
+ (heading "Description")
+ (para "
+Use "
+ (code "gluBeginSurface")
+ " to mark the beginning of a NURBS
+ surface definition. After
+ calling "
+ (code "gluBeginSurface")
+ ", make one or more calls to "
+ (code "gluNurbsSurface")
+ " to define the attributes of the surface.
+ Exactly one of these calls to "
+ (code "gluNurbsSurface")
+ " must have a
+ surface type of "
+ (code "GLU_MAP2_VERTEX_3")
+ " or "
+ (code "GLU_MAP2_VERTEX_4")
+ ".
+ To mark the end of the NURBS surface definition, call "
+ (code "gluEndSurface")
+ ". ")
+ (para "
+Trimming of NURBS surfaces is supported with "
+ (code "gluBeginTrim")
+ ", "
+ (code "gluPwlCurve")
+ ", "
+ (code "gluNurbsCurve")
+ ", and "
+ (code "gluEndTrim")
+ ". See the "
+ (code "gluBeginTrim")
+ " reference page for details. ")
+ (para "
+GL evaluators are used to render the NURBS surface as a set of polygons.
+ Evaluator state is preserved during rendering
+ with "
+ (code "glPushAttrib")
+ "("
+ (code "GLU_EVAL_BIT")
+ ") and "
+ (code "glPopAttrib")
+ ".
+ See the "
+ (code "glPushAttrib")
+ " reference page for details on exactly what state
+ these calls preserve. ")))
+
+(define-gl-procedure
+ gluBeginTrim
+ "gluBeginTrim"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "gluBeginTrim"))
+ (paramdef "GLUnurbs* " (parameter "nurb"))))
+ '(*fragment*
+ (heading
+ "delimit a NURBS trimming loop definition")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "nurb")))
+ (para "
+Specifies the NURBS object (created with "
+ (code "gluNewNurbsRenderer")
+ "). ")))
+ (heading "Description")
+ (para "
+Use "
+ (code "gluBeginTrim")
+ " to mark the beginning of a
+ trimming loop and "
+ (code "gluEndTrim")
+ " to mark the end
+ of a trimming loop. A trimming loop is
+ a set of oriented curve segments (forming a closed curve) that
+ define boundaries of a NURBS surface. You include these
+ trimming loops in the definition of a NURBS
+ surface, between calls to "
+ (code "gluBeginSurface")
+ " and "
+ (code "gluEndSurface")
+ ". ")
+ (para "
+The definition for a NURBS surface can contain many
+ trimming loops. For example, if you wrote a definition
+ for a NURBS surface that resembled a rectangle with
+ a hole punched out, the definition would contain two
+ trimming loops. One loop would define the outer edge
+ of the rectangle; the other would define
+ the hole punched out of the rectangle. The definitions
+ of each of these trimming loops would be bracketed by a "
+ (code "gluBeginTrim")
+ "/"
+ (code "gluEndTrim")
+ " pair. ")
+ (para "
+The definition of a single closed trimming loop can consist
+ of multiple curve segments, each described as a piecewise
+ linear curve (see "
+ (code "gluPwlCurve")
+ ") or as a single NURBS
+ curve (see "
+ (code "gluNurbsCurve")
+ "), or as a combination of
+ both in any order. The only library calls that can
+ appear in a trimming loop definition (between the calls
+ to "
+ (code "gluBeginTrim")
+ " and "
+ (code "gluEndTrim")
+ ") are "
+ (code "gluPwlCurve")
+ " and "
+ (code "gluNurbsCurve")
+ ". ")
+ (para "
+The area of the NURBS surface that is displayed is the
+ region in the domain to the left of the trimming curve
+ as the curve parameter increases. Thus, the retained
+ region of the NURBS surface is inside a
+ counterclockwise trimming loop and outside a clockwise
+ trimming loop. For the rectangle mentioned earlier,
+ the trimming loop for the outer edge of the rectangle runs
+ counterclockwise, while the trimming loop for the punched-out hole
+ runs clockwise. ")
+ (para "
+If you use more than one curve to define a single trimming
+ loop, the curve segments must form a closed loop (that is,
+ the endpoint of each curve must be the starting point of the
+ next curve, and the endpoint of the final curve must
+ be the starting point of the first curve). If the
+ endpoints of the curve are sufficiently close together
+ but not exactly coincident, they will be coerced to match.
+ If the endpoints are not sufficiently close, an error results
+ (see "
+ (code "gluNurbsCallback")
+ "). ")
+ (para "
+If a trimming loop definition contains multiple curves,
+ the direction of the curves must be consistent (that is, the
+ inside must be to the left of all of the curves). Nested
+ trimming loops are legal as long as the curve orientations
+ alternate correctly.
+ If trimming curves are self-intersecting,
+ or intersect one another, an error results. ")
+ (para "
+If no trimming information is given
+ for a NURBS surface, the entire surface is drawn. ")))
+
+(define-gl-procedure
+ gluBuild1DMipmapLevels
+ "gluBuild1DMipmapLevels"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "GLint "
+ (function "gluBuild1DMipmapLevels"))
+ (paramdef "GLenum " (parameter "target"))
+ (paramdef "GLint " (parameter "internalFormat"))
+ (paramdef "GLsizei " (parameter "width"))
+ (paramdef "GLenum " (parameter "format"))
+ (paramdef "GLenum " (parameter "type"))
+ (paramdef "GLint " (parameter "level"))
+ (paramdef "GLint " (parameter "base"))
+ (paramdef "GLint " (parameter "max"))
+ (paramdef "const void * " (parameter "data"))))
+ '(*fragment*
+ (heading
+ "builds a subset of one-dimensional mipmap levels")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "target")))
+ (para "
+Specifies the target texture. Must be "
+ (code "GLU_TEXTURE_1D")
+ ". "))
+ (entry (% (heading (var "internalFormat")))
+ (para "
+Requests the internal storage format of the texture image. The most
+ current version of the SGI implementation of GLU does not check this
+ value for validity before passing it on to the underlying OpenGL
+ implementation. A value that is not accepted by the OpenGL
+ implementation will lead to an OpenGL error. The benefit of not
+ checking this value at the GLU level is that OpenGL extensions can add
+ new internal texture formats without requiring a revision of the GLU
+ implementation. Older implementations of GLU check this value and
+ raise a GLU error if it is not 1, 2, 3, or 4 or one of the following
+ symbolic constants: "
+ (code "GLU_ALPHA")
+ ", "
+ (code "GLU_ALPHA4")
+ ", "
+ (code "GLU_ALPHA8")
+ ", "
+ (code "GLU_ALPHA12")
+ ", "
+ (code "GLU_ALPHA16")
+ ", "
+ (code "GLU_LUMINANCE")
+ ", "
+ (code "GLU_LUMINANCE4")
+ ", "
+ (code "GLU_LUMINANCE8")
+ ", "
+ (code "GLU_LUMINANCE12")
+ ", "
+ (code "GLU_LUMINANCE16")
+ ", "
+ (code "GLU_LUMINANCE_ALPHA")
+ ", "
+ (code "GLU_LUMINANCE4_ALPHA4")
+ ", "
+ (code "GLU_LUMINANCE6_ALPHA2")
+ ", "
+ (code "GLU_LUMINANCE8_ALPHA8")
+ ", "
+ (code "GLU_LUMINANCE12_ALPHA4")
+ ", "
+ (code "GLU_LUMINANCE12_ALPHA12")
+ ", "
+ (code "GLU_LUMINANCE16_ALPHA16")
+ ", "
+ (code "GLU_INTENSITY")
+ ", "
+ (code "GLU_INTENSITY4")
+ ", "
+ (code "GLU_INTENSITY8")
+ ", "
+ (code "GLU_INTENSITY12")
+ ", "
+ (code "GLU_INTENSITY16")
+ ", "
+ (code "GLU_RGB")
+ ", "
+ (code "GLU_R3_G3_B2")
+ ", "
+ (code "GLU_RGB4")
+ ", "
+ (code "GLU_RGB5")
+ ", "
+ (code "GLU_RGB8")
+ ", "
+ (code "GLU_RGB10")
+ ", "
+ (code "GLU_RGB12")
+ ", "
+ (code "GLU_RGB16")
+ ", "
+ (code "GLU_RGBA")
+ ", "
+ (code "GLU_RGBA2")
+ ", "
+ (code "GLU_RGBA4")
+ ", "
+ (code "GLU_RGB5_A1")
+ ", "
+ (code "GLU_RGBA8")
+ ", "
+ (code "GLU_RGB10_A2")
+ ", "
+ (code "GLU_RGBA12")
+ ", or "
+ (code "GLU_RGBA16")
+ ". "))
+ (entry (% (heading (var "width")))
+ (para "
+Specifies the width in pixels of the texture image.
+ This should be a power of 2. "))
+ (entry (% (heading (var "format")))
+ (para "
+Specifies the format of the pixel data.
+ Must be one of: "
+ (code "GLU_COLOR_INDEX")
+ ", "
+ (code "GLU_DEPTH_COMPONENT")
+ ", "
+ (code "GLU_RED")
+ ", "
+ (code "GLU_GREEN")
+ ", "
+ (code "GLU_BLUE")
+ ", "
+ (code "GLU_ALPHA")
+ ", "
+ (code "GLU_RGB")
+ ", "
+ (code "GLU_RGBA")
+ ", "
+ (code "GLU_BGR")
+ ", "
+ (code "GLU_BGRA")
+ ", "
+ (code "GLU_LUMINANCE")
+ ", or "
+ (code "GLU_LUMINANCE_ALPHA")
+ ". "))
+ (entry (% (heading (var "type")))
+ (para "
+Specifies the data type for "
+ (var "data")
+ ".
+ Must be one of: "
+ (code "GLU_UNSIGNED_BYTE")
+ ", "
+ (code "GLU_BYTE")
+ ", "
+ (code "GLU_BITMAP")
+ ", "
+ (code "GLU_UNSIGNED_SHORT")
+ ", "
+ (code "GLU_SHORT")
+ ", "
+ (code "GLU_UNSIGNED_INT")
+ ", "
+ (code "GLU_INT")
+ ", "
+ (code "GLU_FLOAT")
+ ", "
+ (code "GLU_UNSIGNED_BYTE_3_3_2")
+ ", "
+ (code "GLU_UNSIGNED_BYTE_2_3_3_REV")
+ ", "
+ (code "GLU_UNSIGNED_SHORT_5_6_5")
+ ", "
+ (code "GLU_UNSIGNED_SHORT_5_6_5_REV")
+ ", "
+ (code "GLU_UNSIGNED_SHORT_4_4_4_4")
+ ", "
+ (code "GLU_UNSIGNED_SHORT_4_4_4_4_REV")
+ ", "
+ (code "GLU_UNSIGNED_SHORT_5_5_5_1")
+ ", "
+ (code "GLU_UNSIGNED_SHORT_1_5_5_5_REV")
+ ", "
+ (code "GLU_UNSIGNED_INT_8_8_8_8")
+ ", "
+ (code "GLU_UNSIGNED_INT_8_8_8_8_REV")
+ ", "
+ (code "GLU_UNSIGNED_INT_10_10_10_2")
+ ", or "
+ (code "GLU_UNSIGNED_INT_2_10_10_10_REV")
+ ". "))
+ (entry (% (heading (var "level")))
+ (para "
+Specifies the mipmap level of the image data. "))
+ (entry (% (heading (var "base")))
+ (para "
+Specifies the minimum mipmap level to pass to "
+ (code "glTexImage1D")
+ ". "))
+ (entry (% (heading (var "max")))
+ (para "
+Specifies the maximum mipmap level to pass to "
+ (code "glTexImage1D")
+ ". "))
+ (entry (% (heading (var "data")))
+ (para "
+Specifies a pointer to the image data in memory. ")))
+ (heading "Description")
+ (para (code "gluBuild1DMipmapLevels")
+ " builds a subset of prefiltered one-dimensional texture maps of decreasing
+ resolutions called a mipmap. This is used for the antialiasing of
+ texture mapped primitives. ")
+ (para "
+A return value of zero indicates success, otherwise a GLU error code is
+ returned (see "
+ (code "gluErrorString")
+ "). ")
+ (para "
+A series of mipmap levels from "
+ (var "base")
+ " to "
+ (var "max")
+ " is built by decimating "
+ (var "data")
+ " in half
+ until size "
+ (math "1" "×" "1")
+ "
+is reached. At each level, each texel in the
+ halved mipmap level is an average of the corresponding two texels in the larger
+ mipmap level. "
+ (code "glTexImage1D")
+ " is called to load these mipmap levels from "
+ (var "base")
+ "
+to "
+ (var "max")
+ ". If "
+ (var "max")
+ " is larger than the highest mipmap level for the
+ texture of the specified size, then a GLU error code is returned (see "
+ (code "gluErrorString")
+ ") and nothing is loaded. ")
+ (para "
+For example, if "
+ (var "level")
+ " is 2 and "
+ (var "width")
+ " is 16, the
+ following levels are possible: "
+ (math "16" "×" "1")
+ ", "
+ (math "8" "×" "1")
+ ", "
+ (math "4" "×" "1")
+ ", "
+ (math "2" "×" "1")
+ ", "
+ (math "1" "×" "1")
+ ".
+ These correspond
+ to levels 2 through 6 respectively.
+ If "
+ (var "base")
+ " is 3 and "
+ (var "max")
+ " is 5, then only mipmap levels "
+ (math "8" "×" "1")
+ ", "
+ (math "4" "×" "1")
+ "
+and "
+ (math "2" "×" "1")
+ "
+are
+ loaded. However, if "
+ (var "max")
+ " is 7, then an error is returned and nothing is
+ loaded since "
+ (var "max")
+ " is larger than the highest mipmap level which is, in
+ this case, 6. ")
+ (para "
+The highest mipmap level can be derived from the formula "
+ (math (var "log")
+ "_"
+ "2"
+ "\u2061"
+ "("
+ (var "width")
+ "×"
+ "2"
+ "^"
+ (var "level")
+ ","
+ ")")
+ ". ")
+ (para "
+See the "
+ (code "glTexImage1D")
+ " reference page for a description of the
+ acceptable values for "
+ (var "type")
+ " parameter. See the "
+ (code "glDrawPixels")
+ " reference page for a description of the acceptable values
+ for "
+ (var "level")
+ " parameter. ")
+ (heading "Errors")
+ (para (code "GLU_INVALID_VALUE")
+ " is returned if "
+ (var "level")
+ " > "
+ (var "base")
+ ", "
+ (var "base")
+ " < 0, "
+ (var "max")
+ " < "
+ (var "base")
+ " or "
+ (var "max")
+ " is > the highest mipmap level for "
+ (var "data")
+ ". ")
+ (para (code "GLU_INVALID_VALUE")
+ " is returned if "
+ (var "width")
+ " is < 1. ")
+ (para (code "GLU_INVALID_ENUM")
+ " is returned if "
+ (var "internalFormat")
+ ", "
+ (var "format")
+ ", or "
+ (var "type")
+ " are not
+ legal. ")
+ (para (code "GLU_INVALID_OPERATION")
+ " is returned if "
+ (var "type")
+ " is "
+ (code "GLU_UNSIGNED_BYTE_3_3_2")
+ " or "
+ (code "GLU_UNSIGNED_BYTE_2_3_3_REV")
+ "
+and "
+ (var "format")
+ " is not "
+ (code "GLU_RGB")
+ ". ")
+ (para (code "GLU_INVALID_OPERATION")
+ " is returned if "
+ (var "type")
+ " is "
+ (code "GLU_UNSIGNED_SHORT_5_6_5")
+ " or "
+ (code "GLU_UNSIGNED_SHORT_5_6_5_REV")
+ "
+and "
+ (var "format")
+ " is not "
+ (code "GLU_RGB")
+ ". ")
+ (para (code "GLU_INVALID_OPERATION")
+ " is returned if "
+ (var "type")
+ " is "
+ (code "GLU_UNSIGNED_SHORT_4_4_4_4")
+ " or "
+ (code "GLU_UNSIGNED_SHORT_4_4_4_4_REV")
+ "
+and "
+ (var "format")
+ " is neither "
+ (code "GLU_RGBA")
+ " nor "
+ (code "GLU_BGRA")
+ ". ")
+ (para (code "GLU_INVALID_OPERATION")
+ " is returned if "
+ (var "type")
+ " is "
+ (code "GLU_UNSIGNED_SHORT_5_5_5_1")
+ " or "
+ (code "GLU_UNSIGNED_SHORT_1_5_5_5_REV")
+ "
+and "
+ (var "format")
+ " is neither "
+ (code "GLU_RGBA")
+ " nor "
+ (code "GLU_BGRA")
+ ". ")
+ (para (code "GLU_INVALID_OPERATION")
+ " is returned if "
+ (var "type")
+ " is "
+ (code "GLU_UNSIGNED_INT_8_8_8_8")
+ " or "
+ (code "GLU_UNSIGNED_INT_8_8_8_8_REV")
+ "
+and "
+ (var "format")
+ " is neither "
+ (code "GLU_RGBA")
+ " nor "
+ (code "GLU_BGRA")
+ ". ")
+ (para (code "GLU_INVALID_OPERATION")
+ " is returned if "
+ (var "type")
+ " is "
+ (code "GLU_UNSIGNED_INT_10_10_10_2")
+ " or "
+ (code "GLU_UNSIGNED_INT_2_10_10_10_REV")
+ "
+and "
+ (var "format")
+ " is neither "
+ (code "GLU_RGBA")
+ " nor "
+ (code "GLU_BGRA")
+ ". ")))
+
+(define-gl-procedure
+ gluBuild1DMipmaps
+ "gluBuild1DMipmaps"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "GLint " (function "gluBuild1DMipmaps"))
+ (paramdef "GLenum " (parameter "target"))
+ (paramdef "GLint " (parameter "internalFormat"))
+ (paramdef "GLsizei " (parameter "width"))
+ (paramdef "GLenum " (parameter "format"))
+ (paramdef "GLenum " (parameter "type"))
+ (paramdef "const void * " (parameter "data"))))
+ '(*fragment*
+ (heading "builds a one-dimensional mipmap")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "target")))
+ (para "
+Specifies the target texture. Must be "
+ (code "GLU_TEXTURE_1D")
+ ". "))
+ (entry (% (heading (var "internalFormat")))
+ (para "
+Requests the internal storage format of the texture image. The most
+ current version of the SGI implementation of GLU does not check this
+ value for validity before passing it on to the underlying OpenGL
+ implementation. A value that is not accepted by the OpenGL
+ implementation will lead to an OpenGL error. The benefit of not
+ checking this value at the GLU level is that OpenGL extensions can add
+ new internal texture formats without requiring a revision of the GLU
+ implementation. Older implementations of GLU check this value and
+ raise a GLU error if it is not 1, 2, 3, or 4 or one of the following
+ symbolic constants: "
+ (code "GLU_ALPHA")
+ ", "
+ (code "GLU_ALPHA4")
+ ", "
+ (code "GLU_ALPHA8")
+ ", "
+ (code "GLU_ALPHA12")
+ ", "
+ (code "GLU_ALPHA16")
+ ", "
+ (code "GLU_LUMINANCE")
+ ", "
+ (code "GLU_LUMINANCE4")
+ ", "
+ (code "GLU_LUMINANCE8")
+ ", "
+ (code "GLU_LUMINANCE12")
+ ", "
+ (code "GLU_LUMINANCE16")
+ ", "
+ (code "GLU_LUMINANCE_ALPHA")
+ ", "
+ (code "GLU_LUMINANCE4_ALPHA4")
+ ", "
+ (code "GLU_LUMINANCE6_ALPHA2")
+ ", "
+ (code "GLU_LUMINANCE8_ALPHA8")
+ ", "
+ (code "GLU_LUMINANCE12_ALPHA4")
+ ", "
+ (code "GLU_LUMINANCE12_ALPHA12")
+ ", "
+ (code "GLU_LUMINANCE16_ALPHA16")
+ ", "
+ (code "GLU_INTENSITY")
+ ", "
+ (code "GLU_INTENSITY4")
+ ", "
+ (code "GLU_INTENSITY8")
+ ", "
+ (code "GLU_INTENSITY12")
+ ", "
+ (code "GLU_INTENSITY16")
+ ", "
+ (code "GLU_RGB")
+ ", "
+ (code "GLU_R3_G3_B2")
+ ", "
+ (code "GLU_RGB4")
+ ", "
+ (code "GLU_RGB5")
+ ", "
+ (code "GLU_RGB8")
+ ", "
+ (code "GLU_RGB10")
+ ", "
+ (code "GLU_RGB12")
+ ", "
+ (code "GLU_RGB16")
+ ", "
+ (code "GLU_RGBA")
+ ", "
+ (code "GLU_RGBA2")
+ ", "
+ (code "GLU_RGBA4")
+ ", "
+ (code "GLU_RGB5_A1")
+ ", "
+ (code "GLU_RGBA8")
+ ", "
+ (code "GLU_RGB10_A2")
+ ", "
+ (code "GLU_RGBA12")
+ ", or "
+ (code "GLU_RGBA16")
+ ". "))
+ (entry (% (heading (var "width")))
+ (para "
+Specifies the width, in pixels, of the texture image. "))
+ (entry (% (heading (var "format")))
+ (para "
+Specifies the format of the pixel data.
+ Must be one of "
+ (code "GLU_COLOR_INDEX")
+ ", "
+ (code "GLU_DEPTH_COMPONENT")
+ ", "
+ (code "GLU_RED")
+ ", "
+ (code "GLU_GREEN")
+ ", "
+ (code "GLU_BLUE")
+ ", "
+ (code "GLU_ALPHA")
+ ", "
+ (code "GLU_RGB")
+ ", "
+ (code "GLU_RGBA")
+ ", "
+ (code "GLU_BGR")
+ ", "
+ (code "GLU_BGRA")
+ ", "
+ (code "GLU_LUMINANCE")
+ ", or "
+ (code "GLU_LUMINANCE_ALPHA")
+ ". "))
+ (entry (% (heading (var "type")))
+ (para "
+Specifies the data type for "
+ (var "data")
+ ".
+ Must be one of "
+ (code "GLU_UNSIGNED_BYTE")
+ ", "
+ (code "GLU_BYTE")
+ ", "
+ (code "GLU_BITMAP")
+ ", "
+ (code "GLU_UNSIGNED_SHORT")
+ ", "
+ (code "GLU_SHORT")
+ ", "
+ (code "GLU_UNSIGNED_INT")
+ ", "
+ (code "GLU_INT")
+ ", "
+ (code "GLU_FLOAT")
+ ", "
+ (code "GLU_UNSIGNED_BYTE_3_3_2")
+ ", "
+ (code "GLU_UNSIGNED_BYTE_2_3_3_REV")
+ ", "
+ (code "GLU_UNSIGNED_SHORT_5_6_5")
+ ", "
+ (code "GLU_UNSIGNED_SHORT_5_6_5_REV")
+ ", "
+ (code "GLU_UNSIGNED_SHORT_4_4_4_4")
+ ", "
+ (code "GLU_UNSIGNED_SHORT_4_4_4_4_REV")
+ ", "
+ (code "GLU_UNSIGNED_SHORT_5_5_5_1")
+ ", "
+ (code "GLU_UNSIGNED_SHORT_1_5_5_5_REV")
+ ", "
+ (code "GLU_UNSIGNED_INT_8_8_8_8")
+ ", "
+ (code "GLU_UNSIGNED_INT_8_8_8_8_REV")
+ ", "
+ (code "GLU_UNSIGNED_INT_10_10_10_2")
+ ", or "
+ (code "GLU_UNSIGNED_INT_2_10_10_10_REV")
+ ". "))
+ (entry (% (heading (var "data")))
+ (para "
+Specifies a pointer to the image data in memory. ")))
+ (heading "Description")
+ (para (code "gluBuild1DMipmaps")
+ " builds a series of prefiltered one-dimensional texture maps of decreasing
+ resolutions called a mipmap. This is used for the antialiasing of
+ texture mapped primitives. ")
+ (para "
+A return value of zero indicates success, otherwise a GLU error code is
+ returned (see "
+ (code "gluErrorString")
+ "). ")
+ (para "
+Initially, the "
+ (var "width")
+ " of "
+ (var "data")
+ " is checked to see if it is
+ a power of 2. If not, a copy of "
+ (var "data")
+ " is scaled up or down to the
+ nearest power of 2. (If "
+ (var "width")
+ " is exactly between powers of 2, then
+ the copy of "
+ (var "data")
+ " will scale upwards.) This copy will be used for
+ subsequent mipmapping operations described below.
+ For example, if "
+ (var "width")
+ " is 57, then a copy of "
+ (var "data")
+ "
+will scale up to 64 before mipmapping
+ takes place. ")
+ (para "
+Then, proxy textures (see "
+ (code "glTexImage1D")
+ ") are used to determine if
+ the implementation can fit the requested texture. If not, "
+ (var "width")
+ " is
+ continually halved until it fits. ")
+ (para "
+Next, a series of mipmap levels is built by decimating a copy of "
+ (var "data")
+ " in half
+ until size "
+ (math "1" "×" "1")
+ "
+is reached. At each level, each texel in the
+ halved mipmap level is an average of the corresponding two texels in the larger
+ mipmap level. ")
+ (para (code "glTexImage1D")
+ " is called to load each of these mipmap levels.
+ Level 0 is a copy of "
+ (var "data")
+ ".
+ The highest level is "
+ (math (var "log")
+ "_"
+ "2"
+ ","
+ "\u2061"
+ "("
+ (var "width")
+ ","
+ ")")
+ ".
+ For example, if "
+ (var "width")
+ " is 64 and the implementation can store a texture of
+ this size, the following mipmap levels are
+ built: "
+ (math "64" "×" "1")
+ ", "
+ (math "32" "×" "1")
+ ", "
+ (math "16" "×" "1")
+ ", "
+ (math "8" "×" "1")
+ ", "
+ (math "4" "×" "1")
+ ", "
+ (math "2" "×" "1")
+ ",
+ and "
+ (math "1" "×" "1")
+ ".
+ These correspond to
+ levels 0 through 6, respectively. ")
+ (para "
+See the "
+ (code "glTexImage1D")
+ " reference page for a description of the
+ acceptable values for the "
+ (var "type")
+ " parameter. See the "
+ (code "glDrawPixels")
+ " reference page for a description of the acceptable values
+ for the "
+ (var "data")
+ " parameter. ")
+ (heading "Errors")
+ (para (code "GLU_INVALID_VALUE")
+ " is returned if "
+ (var "width")
+ " is < 1. ")
+ (para (code "GLU_INVALID_ENUM")
+ " is returned if "
+ (var "format")
+ " or "
+ (var "type")
+ " are not legal. ")
+ (para (code "GLU_INVALID_OPERATION")
+ " is returned if "
+ (var "type")
+ " is "
+ (code "GLU_UNSIGNED_BYTE_3_3_2")
+ " or "
+ (code "GLU_UNSIGNED_BYTE_2_3_3_REV")
+ "
+and "
+ (var "format")
+ " is not "
+ (code "GLU_RGB")
+ ". ")
+ (para (code "GLU_INVALID_OPERATION")
+ " is returned if "
+ (var "type")
+ " is "
+ (code "GLU_UNSIGNED_SHORT_5_6_5")
+ " or "
+ (code "GLU_UNSIGNED_SHORT_5_6_5_REV")
+ "
+and "
+ (var "format")
+ " is not "
+ (code "GLU_RGB")
+ ". ")
+ (para (code "GLU_INVALID_OPERATION")
+ " is returned if "
+ (var "type")
+ " is "
+ (code "GLU_UNSIGNED_SHORT_4_4_4_4")
+ " or "
+ (code "GLU_UNSIGNED_SHORT_4_4_4_4_REV")
+ "
+and "
+ (var "format")
+ " is neither "
+ (code "GLU_RGBA")
+ " nor "
+ (code "GLU_BGRA")
+ ". ")
+ (para (code "GLU_INVALID_OPERATION")
+ " is returned if "
+ (var "type")
+ " is "
+ (code "GLU_UNSIGNED_SHORT_5_5_5_1")
+ " or "
+ (code "GLU_UNSIGNED_SHORT_1_5_5_5_REV")
+ "
+and "
+ (var "format")
+ " is neither "
+ (code "GLU_RGBA")
+ " nor "
+ (code "GLU_BGRA")
+ ". ")
+ (para (code "GLU_INVALID_OPERATION")
+ " is returned if "
+ (var "type")
+ " is "
+ (code "GLU_UNSIGNED_INT_8_8_8_8")
+ " or "
+ (code "GLU_UNSIGNED_INT_8_8_8_8_REV")
+ "
+and "
+ (var "format")
+ " is neither "
+ (code "GLU_RGBA")
+ " nor "
+ (code "GLU_BGRA")
+ ". ")
+ (para (code "GLU_INVALID_OPERATION")
+ " is returned if "
+ (var "type")
+ " is "
+ (code "GLU_UNSIGNED_INT_10_10_10_2")
+ " or "
+ (code "GLU_UNSIGNED_INT_2_10_10_10_REV")
+ "
+and "
+ (var "format")
+ " is neither "
+ (code "GLU_RGBA")
+ " nor "
+ (code "GLU_BGRA")
+ ". ")))
+
+(define-gl-procedure
+ gluBuild2DMipmapLevels
+ "gluBuild2DMipmapLevels"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "GLint "
+ (function "gluBuild2DMipmapLevels"))
+ (paramdef "GLenum " (parameter "target"))
+ (paramdef "GLint " (parameter "internalFormat"))
+ (paramdef "GLsizei " (parameter "width"))
+ (paramdef "GLsizei " (parameter "height"))
+ (paramdef "GLenum " (parameter "format"))
+ (paramdef "GLenum " (parameter "type"))
+ (paramdef "GLint " (parameter "level"))
+ (paramdef "GLint " (parameter "base"))
+ (paramdef "GLint " (parameter "max"))
+ (paramdef "const void * " (parameter "data"))))
+ '(*fragment*
+ (heading
+ "builds a subset of two-dimensional mipmap levels")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "target")))
+ (para "
+Specifies the target texture. Must be "
+ (code "GLU_TEXTURE_2D")
+ ". "))
+ (entry (% (heading (var "internalFormat")))
+ (para "
+Requests the internal storage format of the texture image. The most
+ current version of the SGI implementation of GLU does not check this
+ value for validity before passing it on to the underlying OpenGL
+ implementation. A value that is not accepted by the OpenGL
+ implementation will lead to an OpenGL error. The benefit of not
+ checking this value at the GLU level is that OpenGL extensions can add
+ new internal texture formats without requiring a revision of the GLU
+ implementation. Older implementations of GLU check this value and
+ raise a GLU error if it is not 1, 2, 3, or 4 or one of the following
+ symbolic constants: "
+ (code "GLU_ALPHA")
+ ", "
+ (code "GLU_ALPHA4")
+ ", "
+ (code "GLU_ALPHA8")
+ ", "
+ (code "GLU_ALPHA12")
+ ", "
+ (code "GLU_ALPHA16")
+ ", "
+ (code "GLU_LUMINANCE")
+ ", "
+ (code "GLU_LUMINANCE4")
+ ", "
+ (code "GLU_LUMINANCE8")
+ ", "
+ (code "GLU_LUMINANCE12")
+ ", "
+ (code "GLU_LUMINANCE16")
+ ", "
+ (code "GLU_LUMINANCE_ALPHA")
+ ", "
+ (code "GLU_LUMINANCE4_ALPHA4")
+ ", "
+ (code "GLU_LUMINANCE6_ALPHA2")
+ ", "
+ (code "GLU_LUMINANCE8_ALPHA8")
+ ", "
+ (code "GLU_LUMINANCE12_ALPHA4")
+ ", "
+ (code "GLU_LUMINANCE12_ALPHA12")
+ ", "
+ (code "GLU_LUMINANCE16_ALPHA16")
+ ", "
+ (code "GLU_INTENSITY")
+ ", "
+ (code "GLU_INTENSITY4")
+ ", "
+ (code "GLU_INTENSITY8")
+ ", "
+ (code "GLU_INTENSITY12")
+ ", "
+ (code "GLU_INTENSITY16")
+ ", "
+ (code "GLU_RGB")
+ ", "
+ (code "GLU_R3_G3_B2")
+ ", "
+ (code "GLU_RGB4")
+ ", "
+ (code "GLU_RGB5")
+ ", "
+ (code "GLU_RGB8")
+ ", "
+ (code "GLU_RGB10")
+ ", "
+ (code "GLU_RGB12")
+ ", "
+ (code "GLU_RGB16")
+ ", "
+ (code "GLU_RGBA")
+ ", "
+ (code "GLU_RGBA2")
+ ", "
+ (code "GLU_RGBA4")
+ ", "
+ (code "GLU_RGB5_A1")
+ ", "
+ (code "GLU_RGBA8")
+ ", "
+ (code "GLU_RGB10_A2")
+ ", "
+ (code "GLU_RGBA12")
+ ", or "
+ (code "GLU_RGBA16")
+ ". "))
+ (entry (% (heading (var "width")))
+ (itemx (var "height"))
+ (para "
+Specifies the width and height, respectively, in pixels of the texture image.
+ These should be a power of 2. "))
+ (entry (% (heading (var "format")))
+ (para "
+Specifies the format of the pixel data.
+ Must be one of "
+ (code "GLU_COLOR_INDEX")
+ ", "
+ (code "GLU_DEPTH_COMPONENT")
+ ", "
+ (code "GLU_RED")
+ ", "
+ (code "GLU_GREEN")
+ ", "
+ (code "GLU_BLUE")
+ ", "
+ (code "GLU_ALPHA")
+ ", "
+ (code "GLU_RGB")
+ ", "
+ (code "GLU_RGBA")
+ ", "
+ (code "GLU_BGR")
+ ", "
+ (code "GLU_BGRA")
+ ", "
+ (code "GLU_LUMINANCE")
+ ", or "
+ (code "GLU_LUMINANCE_ALPHA")
+ ". "))
+ (entry (% (heading (var "type")))
+ (para "
+Specifies the data type for "
+ (var "data")
+ ".
+ Must be one of "
+ (code "GLU_UNSIGNED_BYTE")
+ ", "
+ (code "GLU_BYTE")
+ ", "
+ (code "GLU_BITMAP")
+ ", "
+ (code "GLU_UNSIGNED_SHORT")
+ ", "
+ (code "GLU_SHORT")
+ ", "
+ (code "GLU_UNSIGNED_INT")
+ ", "
+ (code "GLU_INT")
+ ", "
+ (code "GLU_FLOAT")
+ ", "
+ (code "GLU_UNSIGNED_BYTE_3_3_2")
+ ", "
+ (code "GLU_UNSIGNED_BYTE_2_3_3_REV")
+ ", "
+ (code "GLU_UNSIGNED_SHORT_5_6_5")
+ ", "
+ (code "GLU_UNSIGNED_SHORT_5_6_5_REV")
+ ", "
+ (code "GLU_UNSIGNED_SHORT_4_4_4_4")
+ ", "
+ (code "GLU_UNSIGNED_SHORT_4_4_4_4_REV")
+ ", "
+ (code "GLU_UNSIGNED_SHORT_5_5_5_1")
+ ", "
+ (code "GLU_UNSIGNED_SHORT_1_5_5_5_REV")
+ ", "
+ (code "GLU_UNSIGNED_INT_8_8_8_8")
+ ", "
+ (code "GLU_UNSIGNED_INT_8_8_8_8_REV")
+ ", "
+ (code "GLU_UNSIGNED_INT_10_10_10_2")
+ ", or "
+ (code "GLU_UNSIGNED_INT_2_10_10_10_REV")
+ ". "))
+ (entry (% (heading (var "level")))
+ (para "
+Specifies the mipmap level of the image data. "))
+ (entry (% (heading (var "base")))
+ (para "
+Specifies the minimum mipmap level to pass to "
+ (code "glTexImage2D")
+ ". "))
+ (entry (% (heading (var "max")))
+ (para "
+Specifies the maximum mipmap level to pass to "
+ (code "glTexImage2D")
+ ". "))
+ (entry (% (heading (var "data")))
+ (para "
+Specifies a pointer to the image data in memory. ")))
+ (heading "Description")
+ (para (code "gluBuild2DMipmapLevels")
+ " builds a subset of prefiltered two-dimensional texture maps of decreasing
+ resolutions called a mipmap. This is used for the antialiasing of
+ texture mapped primitives. ")
+ (para "
+A return value of zero indicates success, otherwise a GLU error code is
+ returned (see "
+ (code "gluErrorString")
+ "). ")
+ (para "
+A series of mipmap levels from "
+ (var "base")
+ " to "
+ (var "max")
+ " is built by decimating "
+ (var "data")
+ " in half along
+ both dimensions until size "
+ (math "1" "×" "1")
+ "
+is reached. At each level, each texel in the
+ halved mipmap level is an average of the corresponding four texels in the larger
+ mipmap level. (In the case of rectangular images, the decimation will ultimately
+ reach an "
+ (math (var "N") "×" "1")
+ "
+or "
+ (math "1" "×" (var "N"))
+ "
+configuration. Here, two texels are
+ averaged instead.) "
+ (code "glTexImage2D")
+ " is called to load these mipmap levels from "
+ (var "base")
+ "
+to "
+ (var "max")
+ ". If "
+ (var "max")
+ " is larger than the highest mipmap level for the
+ texture of the specified size, then a GLU error code is returned (see "
+ (code "gluErrorString")
+ ") and nothing is loaded. ")
+ (para "
+For example, if "
+ (var "level")
+ " is 2 and "
+ (var "width")
+ " is 16 and "
+ (var "height")
+ " is 8, the
+ following levels are possible: "
+ (math "16" "×" "8")
+ ", "
+ (math "8" "×" "4")
+ ", "
+ (math "4" "×" "2")
+ ", "
+ (math "2" "×" "1")
+ ", "
+ (math "1" "×" "1")
+ ".
+ These correspond to levels 2 through 6
+ respectively. If "
+ (var "base")
+ " is 3 and "
+ (var "max")
+ " is 5, then only mipmap levels "
+ (math "8" "×" "4")
+ ", "
+ (math "4" "×" "2")
+ ",
+ and "
+ (math "2" "×" "1")
+ "
+are loaded. However, if "
+ (var "max")
+ "
+is 7, then an error is returned and nothing is loaded since "
+ (var "max")
+ " is
+ larger than the highest mipmap level which is, in this case, 6. ")
+ (para "
+The highest mipmap level can be derived from the formula "
+ (math (var "log")
+ "_"
+ "2"
+ "\u2061"
+ "("
+ (var "max")
+ "\u2061"
+ "("
+ (var "width")
+ ","
+ (var "height")
+ ")"
+ "×"
+ "2"
+ "^"
+ (var "level")
+ ","
+ ")")
+ ". ")
+ (para "
+See the "
+ (code "glTexImage1D")
+ " reference page for a description of the
+ acceptable values for "
+ (var "format")
+ " parameter. See the "
+ (code "glDrawPixels")
+ " reference page for a description of the acceptable values
+ for "
+ (var "type")
+ " parameter. ")
+ (heading "Errors")
+ (para (code "GLU_INVALID_VALUE")
+ " is returned if "
+ (var "level")
+ " > "
+ (var "base")
+ ", "
+ (var "base")
+ " < 0, "
+ (var "max")
+ " < "
+ (var "base")
+ ", or "
+ (var "max")
+ " is > the highest mipmap level for "
+ (var "data")
+ ". ")
+ (para (code "GLU_INVALID_VALUE")
+ " is returned if "
+ (var "width")
+ " or "
+ (var "height")
+ " is < 1. ")
+ (para (code "GLU_INVALID_ENUM")
+ " is returned if "
+ (var "internalFormat")
+ ", "
+ (var "format")
+ ", or "
+ (var "type")
+ " is not
+ legal. ")
+ (para (code "GLU_INVALID_OPERATION")
+ " is returned if "
+ (var "type")
+ " is "
+ (code "GLU_UNSIGNED_BYTE_3_3_2")
+ " or "
+ (code "GLU_UNSIGNED_BYTE_2_3_3_REV")
+ "
+and "
+ (var "format")
+ " is not "
+ (code "GLU_RGB")
+ ". ")
+ (para (code "GLU_INVALID_OPERATION")
+ " is returned if "
+ (var "type")
+ " is "
+ (code "GLU_UNSIGNED_SHORT_5_6_5")
+ " or "
+ (code "GLU_UNSIGNED_SHORT_5_6_5_REV")
+ "
+and "
+ (var "format")
+ " is not "
+ (code "GLU_RGB")
+ ". ")
+ (para (code "GLU_INVALID_OPERATION")
+ " is returned if "
+ (var "type")
+ " is "
+ (code "GLU_UNSIGNED_SHORT_4_4_4_4")
+ " or "
+ (code "GLU_UNSIGNED_SHORT_4_4_4_4_REV")
+ "
+and "
+ (var "format")
+ " is neither "
+ (code "GLU_RGBA")
+ " nor "
+ (code "GLU_BGRA")
+ ". ")
+ (para (code "GLU_INVALID_OPERATION")
+ " is returned if "
+ (var "type")
+ " is "
+ (code "GLU_UNSIGNED_SHORT_5_5_5_1")
+ " or "
+ (code "GLU_UNSIGNED_SHORT_1_5_5_5_REV")
+ "
+and "
+ (var "format")
+ " is neither "
+ (code "GLU_RGBA")
+ " nor "
+ (code "GLU_BGRA")
+ ". ")
+ (para (code "GLU_INVALID_OPERATION")
+ " is returned if "
+ (var "type")
+ " is "
+ (code "GLU_UNSIGNED_INT_8_8_8_8")
+ " or "
+ (code "GLU_UNSIGNED_INT_8_8_8_8_REV")
+ "
+and "
+ (var "format")
+ " is neither "
+ (code "GLU_RGBA")
+ " nor "
+ (code "GLU_BGRA")
+ ". ")
+ (para (code "GLU_INVALID_OPERATION")
+ " is returned if "
+ (var "type")
+ " is "
+ (code "GLU_UNSIGNED_INT_10_10_10_2")
+ " or "
+ (code "GLU_UNSIGNED_INT_2_10_10_10_REV")
+ "
+and "
+ (var "format")
+ " is neither "
+ (code "GLU_RGBA")
+ " nor "
+ (code "GLU_BGRA")
+ ". ")))
+
+(define-gl-procedure
+ gluBuild2DMipmaps
+ "gluBuild2DMipmaps"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "GLint " (function "gluBuild2DMipmaps"))
+ (paramdef "GLenum " (parameter "target"))
+ (paramdef "GLint " (parameter "internalFormat"))
+ (paramdef "GLsizei " (parameter "width"))
+ (paramdef "GLsizei " (parameter "height"))
+ (paramdef "GLenum " (parameter "format"))
+ (paramdef "GLenum " (parameter "type"))
+ (paramdef "const void * " (parameter "data"))))
+ '(*fragment*
+ (heading "builds a two-dimensional mipmap")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "target")))
+ (para "
+Specifies the target texture. Must be "
+ (code "GLU_TEXTURE_2D")
+ ". "))
+ (entry (% (heading (var "internalFormat")))
+ (para "
+Requests the internal storage format of the texture image. The most
+ current version of the SGI implementation of GLU does not check this
+ value for validity before passing it on to the underlying OpenGL
+ implementation. A value that is not accepted by the OpenGL
+ implementation will lead to an OpenGL error. The benefit of not
+ checking this value at the GLU level is that OpenGL extensions can add
+ new internal texture formats without requiring a revision of the GLU
+ implementation. Older implementations of GLU check this value and
+ raise a GLU error if it is not 1, 2, 3, or 4 or one of the following
+ symbolic constants: "
+ (code "GLU_ALPHA")
+ ", "
+ (code "GLU_ALPHA4")
+ ", "
+ (code "GLU_ALPHA8")
+ ", "
+ (code "GLU_ALPHA12")
+ ", "
+ (code "GLU_ALPHA16")
+ ", "
+ (code "GLU_LUMINANCE")
+ ", "
+ (code "GLU_LUMINANCE4")
+ ", "
+ (code "GLU_LUMINANCE8")
+ ", "
+ (code "GLU_LUMINANCE12")
+ ", "
+ (code "GLU_LUMINANCE16")
+ ", "
+ (code "GLU_LUMINANCE_ALPHA")
+ ", "
+ (code "GLU_LUMINANCE4_ALPHA4")
+ ", "
+ (code "GLU_LUMINANCE6_ALPHA2")
+ ", "
+ (code "GLU_LUMINANCE8_ALPHA8")
+ ", "
+ (code "GLU_LUMINANCE12_ALPHA4")
+ ", "
+ (code "GLU_LUMINANCE12_ALPHA12")
+ ", "
+ (code "GLU_LUMINANCE16_ALPHA16")
+ ", "
+ (code "GLU_INTENSITY")
+ ", "
+ (code "GLU_INTENSITY4")
+ ", "
+ (code "GLU_INTENSITY8")
+ ", "
+ (code "GLU_INTENSITY12")
+ ", "
+ (code "GLU_INTENSITY16")
+ ", "
+ (code "GLU_RGB")
+ ", "
+ (code "GLU_R3_G3_B2")
+ ", "
+ (code "GLU_RGB4")
+ ", "
+ (code "GLU_RGB5")
+ ", "
+ (code "GLU_RGB8")
+ ", "
+ (code "GLU_RGB10")
+ ", "
+ (code "GLU_RGB12")
+ ", "
+ (code "GLU_RGB16")
+ ", "
+ (code "GLU_RGBA")
+ ", "
+ (code "GLU_RGBA2")
+ ", "
+ (code "GLU_RGBA4")
+ ", "
+ (code "GLU_RGB5_A1")
+ ", "
+ (code "GLU_RGBA8")
+ ", "
+ (code "GLU_RGB10_A2")
+ ", "
+ (code "GLU_RGBA12")
+ ", or "
+ (code "GLU_RGBA16")
+ ". "))
+ (entry (% (heading (var "width")))
+ (itemx (var "height"))
+ (para "
+Specifies in pixels the width and height, respectively, of the texture image. "))
+ (entry (% (heading (var "format")))
+ (para "
+Specifies the format of the pixel data.
+ Must be one of "
+ (code "GLU_COLOR_INDEX")
+ ", "
+ (code "GLU_DEPTH_COMPONENT")
+ ", "
+ (code "GLU_RED")
+ ", "
+ (code "GLU_GREEN")
+ ", "
+ (code "GLU_BLUE")
+ ", "
+ (code "GLU_ALPHA")
+ ", "
+ (code "GLU_RGB")
+ ", "
+ (code "GLU_RGBA")
+ ", "
+ (code "GLU_BGR")
+ ", "
+ (code "GLU_BGRA")
+ ", "
+ (code "GLU_LUMINANCE")
+ ", or "
+ (code "GLU_LUMINANCE_ALPHA")
+ ". "))
+ (entry (% (heading (var "type")))
+ (para "
+Specifies the data type for "
+ (var "data")
+ ".
+ Must be one of "
+ (code "GLU_UNSIGNED_BYTE")
+ ", "
+ (code "GLU_BYTE")
+ ", "
+ (code "GLU_BITMAP")
+ ", "
+ (code "GLU_UNSIGNED_SHORT")
+ ", "
+ (code "GLU_SHORT")
+ ", "
+ (code "GLU_UNSIGNED_INT")
+ ", "
+ (code "GLU_INT")
+ ", "
+ (code "GLU_FLOAT")
+ ", "
+ (code "GLU_UNSIGNED_BYTE_3_3_2")
+ ", "
+ (code "GLU_UNSIGNED_BYTE_2_3_3_REV")
+ ", "
+ (code "GLU_UNSIGNED_SHORT_5_6_5")
+ ", "
+ (code "GLU_UNSIGNED_SHORT_5_6_5_REV")
+ ", "
+ (code "GLU_UNSIGNED_SHORT_4_4_4_4")
+ ", "
+ (code "GLU_UNSIGNED_SHORT_4_4_4_4_REV")
+ ", "
+ (code "GLU_UNSIGNED_SHORT_5_5_5_1")
+ ", "
+ (code "GLU_UNSIGNED_SHORT_1_5_5_5_REV")
+ ", "
+ (code "GLU_UNSIGNED_INT_8_8_8_8")
+ ", "
+ (code "GLU_UNSIGNED_INT_8_8_8_8_REV")
+ ", "
+ (code "GLU_UNSIGNED_INT_10_10_10_2")
+ ", or "
+ (code "GLU_UNSIGNED_INT_2_10_10_10_REV")
+ ". "))
+ (entry (% (heading (var "data")))
+ (para "
+Specifies a pointer to the image data in memory. ")))
+ (heading "Description")
+ (para (code "gluBuild2DMipmaps")
+ " builds a series of prefiltered two-dimensional texture maps of decreasing
+ resolutions called a mipmap. This is used for the antialiasing of
+ texture-mapped primitives. ")
+ (para "
+A return value of zero indicates success, otherwise a GLU error code is
+ returned (see "
+ (code "gluErrorString")
+ "). ")
+ (para "
+Initially, the "
+ (var "width")
+ " and "
+ (var "height")
+ " of "
+ (var "data")
+ " are checked to see if they
+ are a power of 2. If not, a copy of "
+ (var "data")
+ " (not "
+ (var "data")
+ "), is scaled up
+ or down to the nearest power of 2. This copy will be used for subsequent
+ mipmapping operations described below. (If "
+ (var "width")
+ " or "
+ (var "height")
+ " is exactly
+ between powers of 2, then the copy of "
+ (var "data")
+ " will scale upwards.) For
+ example, if "
+ (var "width")
+ " is 57 and "
+ (var "height")
+ " is 23, then a copy of "
+ (var "data")
+ " will
+ scale up to 64 in "
+ (var "width")
+ " and down to 16 in depth, before mipmapping takes
+ place. ")
+ (para "
+Then, proxy textures (see "
+ (code "glTexImage2D")
+ ") are used to determine if
+ the implementation can fit the requested texture. If not, both dimensions
+ are continually halved until it fits. (If the OpenGL version is \\(<= 1.0,
+ both maximum texture dimensions are clamped to the value returned
+ by "
+ (code "glGetIntegerv")
+ " with the argument "
+ (code "GLU_MAX_TEXTURE_SIZE")
+ ".) ")
+ (para "
+Next, a series of mipmap levels is built by decimating a copy of "
+ (var "data")
+ "
+in half along both dimensions until size "
+ (math "1" "×" "1")
+ "
+is reached. At
+ each level,
+ each texel in the halved mipmap level is an average of the corresponding
+ four texels in the larger mipmap level. (In the case of rectangular
+ images, the decimation will ultimately reach an "
+ (math (var "N") "×" "1")
+ "
+or "
+ (math "1" "×" (var "N"))
+ "
+configuration. Here, two texels are averaged instead.) ")
+ (para (code "glTexImage2D")
+ " is called to load each of these mipmap levels.
+ Level 0 is a copy of "
+ (var "data")
+ ". The highest level is "
+ (math (var "log")
+ "_"
+ "2"
+ ","
+ "\u2061"
+ "("
+ (var "max")
+ "\u2061"
+ "("
+ (var "width")
+ ","
+ (var "height")
+ ")"
+ ","
+ ")")
+ ".
+ For example,
+ if "
+ (var "width")
+ " is 64 and "
+ (var "height")
+ " is 16
+ and the implementation can store a texture of this size, the following
+ mipmap levels are built: "
+ (math "64" "×" "16")
+ ", "
+ (math "32" "×" "8")
+ ", "
+ (math "16" "×" "4")
+ ", "
+ (math "8" "×" "2")
+ ", "
+ (math "4" "×" "1")
+ ", "
+ (math "2" "×" "1")
+ ",
+ and "
+ (math "1" "×" "1")
+ "
+These
+ correspond to levels 0 through 6, respectively. ")
+ (para "
+See the "
+ (code "glTexImage1D")
+ " reference page for a description of the
+ acceptable values for "
+ (var "format")
+ " parameter. See the "
+ (code "glDrawPixels")
+ " reference page for a description of the acceptable values
+ for "
+ (var "type")
+ " parameter. ")
+ (heading "Errors")
+ (para (code "GLU_INVALID_VALUE")
+ " is returned if "
+ (var "width")
+ " or "
+ (var "height")
+ " is < 1. ")
+ (para (code "GLU_INVALID_ENUM")
+ " is returned if "
+ (var "internalFormat")
+ ", "
+ (var "format")
+ ", or "
+ (var "type")
+ " is not
+ legal. ")
+ (para (code "GLU_INVALID_OPERATION")
+ " is returned if "
+ (var "type")
+ " is "
+ (code "GLU_UNSIGNED_BYTE_3_3_2")
+ " or "
+ (code "GLU_UNSIGNED_BYTE_2_3_3_REV")
+ "
+and "
+ (var "format")
+ " is not "
+ (code "GLU_RGB")
+ ". ")
+ (para (code "GLU_INVALID_OPERATION")
+ " is returned if "
+ (var "type")
+ " is "
+ (code "GLU_UNSIGNED_SHORT_5_6_5")
+ " or "
+ (code "GLU_UNSIGNED_SHORT_5_6_5_REV")
+ "
+and "
+ (var "format")
+ " is not "
+ (code "GLU_RGB")
+ ". ")
+ (para (code "GLU_INVALID_OPERATION")
+ " is returned if "
+ (var "type")
+ " is "
+ (code "GLU_UNSIGNED_SHORT_4_4_4_4")
+ " or "
+ (code "GLU_UNSIGNED_SHORT_4_4_4_4_REV")
+ "
+and "
+ (var "format")
+ " is neither "
+ (code "GLU_RGBA")
+ " nor "
+ (code "GLU_BGRA")
+ ". ")
+ (para (code "GLU_INVALID_OPERATION")
+ " is returned if "
+ (var "type")
+ " is "
+ (code "GLU_UNSIGNED_SHORT_5_5_5_1")
+ " or "
+ (code "GLU_UNSIGNED_SHORT_1_5_5_5_REV")
+ "
+and "
+ (var "format")
+ " is neither "
+ (code "GLU_RGBA")
+ " nor "
+ (code "GLU_BGRA")
+ ". ")
+ (para (code "GLU_INVALID_OPERATION")
+ " is returned if "
+ (var "type")
+ " is "
+ (code "GLU_UNSIGNED_INT_8_8_8_8")
+ " or "
+ (code "GLU_UNSIGNED_INT_8_8_8_8_REV")
+ "
+and "
+ (var "format")
+ " is neither "
+ (code "GLU_RGBA")
+ " nor "
+ (code "GLU_BGRA")
+ ". ")
+ (para (code "GLU_INVALID_OPERATION")
+ " is returned if "
+ (var "type")
+ " is "
+ (code "GLU_UNSIGNED_INT_10_10_10_2")
+ " or "
+ (code "GLU_UNSIGNED_INT_2_10_10_10_REV")
+ "
+and "
+ (var "format")
+ " is neither "
+ (code "GLU_RGBA")
+ " nor "
+ (code "GLU_BGRA")
+ ". ")))
+
+(define-gl-procedure
+ gluBuild3DMipmapLevels
+ "gluBuild3DMipmapLevels"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "GLint "
+ (function "gluBuild3DMipmapLevels"))
+ (paramdef "GLenum " (parameter "target"))
+ (paramdef "GLint " (parameter "internalFormat"))
+ (paramdef "GLsizei " (parameter "width"))
+ (paramdef "GLsizei " (parameter "height"))
+ (paramdef "GLsizei " (parameter "depth"))
+ (paramdef "GLenum " (parameter "format"))
+ (paramdef "GLenum " (parameter "type"))
+ (paramdef "GLint " (parameter "level"))
+ (paramdef "GLint " (parameter "base"))
+ (paramdef "GLint " (parameter "max"))
+ (paramdef "const void * " (parameter "data"))))
+ '(*fragment*
+ (heading
+ "builds a subset of three-dimensional mipmap levels")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "target")))
+ (para "
+Specifies the target texture. Must be "
+ (code "GLU_TEXTURE_3D")
+ ". "))
+ (entry (% (heading (var "internalFormat")))
+ (para "
+Requests the internal storage format of the texture image. The most
+ current version of the SGI implementation of GLU does not check this
+ value for validity before passing it on to the underlying OpenGL
+ implementation. A value that is not accepted by the OpenGL
+ implementation will lead to an OpenGL error. The benefit of not
+ checking this value at the GLU level is that OpenGL extensions can add
+ new internal texture formats without requiring a revision of the GLU
+ implementation. Older implementations of GLU check this value and
+ raise a GLU error if it is not 1, 2, 3, or 4 or one of the following
+ symbolic constants: "
+ (code "GLU_ALPHA")
+ ", "
+ (code "GLU_ALPHA4")
+ ", "
+ (code "GLU_ALPHA8")
+ ", "
+ (code "GLU_ALPHA12")
+ ", "
+ (code "GLU_ALPHA16")
+ ", "
+ (code "GLU_LUMINANCE")
+ ", "
+ (code "GLU_LUMINANCE4")
+ ", "
+ (code "GLU_LUMINANCE8")
+ ", "
+ (code "GLU_LUMINANCE12")
+ ", "
+ (code "GLU_LUMINANCE16")
+ ", "
+ (code "GLU_LUMINANCE_ALPHA")
+ ", "
+ (code "GLU_LUMINANCE4_ALPHA4")
+ ", "
+ (code "GLU_LUMINANCE6_ALPHA2")
+ ", "
+ (code "GLU_LUMINANCE8_ALPHA8")
+ ", "
+ (code "GLU_LUMINANCE12_ALPHA4")
+ ", "
+ (code "GLU_LUMINANCE12_ALPHA12")
+ ", "
+ (code "GLU_LUMINANCE16_ALPHA16")
+ ", "
+ (code "GLU_INTENSITY")
+ ", "
+ (code "GLU_INTENSITY4")
+ ", "
+ (code "GLU_INTENSITY8")
+ ", "
+ (code "GLU_INTENSITY12")
+ ", "
+ (code "GLU_INTENSITY16")
+ ", "
+ (code "GLU_RGB")
+ ", "
+ (code "GLU_R3_G3_B2")
+ ", "
+ (code "GLU_RGB4")
+ ", "
+ (code "GLU_RGB5")
+ ", "
+ (code "GLU_RGB8")
+ ", "
+ (code "GLU_RGB10")
+ ", "
+ (code "GLU_RGB12")
+ ", "
+ (code "GLU_RGB16")
+ ", "
+ (code "GLU_RGBA")
+ ", "
+ (code "GLU_RGBA2")
+ ", "
+ (code "GLU_RGBA4")
+ ", "
+ (code "GLU_RGB5_A1")
+ ", "
+ (code "GLU_RGBA8")
+ ", "
+ (code "GLU_RGB10_A2")
+ ", "
+ (code "GLU_RGBA12")
+ ", or "
+ (code "GLU_RGBA16")
+ ". "))
+ (entry (% (heading (var "width")))
+ (itemx (var "height"))
+ (itemx (var "depth"))
+ (para "
+Specifies in pixels the width, height and depth respectively, of the texture
+ image. These should be a power of 2. "))
+ (entry (% (heading (var "format")))
+ (para "
+Specifies the format of the pixel data.
+ Must be one of "
+ (code "GLU_COLOR_INDEX")
+ ", "
+ (code "GLU_DEPTH_COMPONENT")
+ ", "
+ (code "GLU_RED")
+ ", "
+ (code "GLU_GREEN")
+ ", "
+ (code "GLU_BLUE")
+ ", "
+ (code "GLU_ALPHA")
+ ", "
+ (code "GLU_RGB")
+ ", "
+ (code "GLU_RGBA")
+ ", "
+ (code "GLU_BGR")
+ ", "
+ (code "GLU_BGRA")
+ ", "
+ (code "GLU_LUMINANCE")
+ ", or "
+ (code "GLU_LUMINANCE_ALPHA")
+ ". "))
+ (entry (% (heading (var "type")))
+ (para "
+Specifies the data type for "
+ (var "data")
+ ".
+ Must be one of "
+ (code "GLU_UNSIGNED_BYTE")
+ ", "
+ (code "GLU_BYTE")
+ ", "
+ (code "GLU_BITMAP")
+ ", "
+ (code "GLU_UNSIGNED_SHORT")
+ ", "
+ (code "GLU_SHORT")
+ ", "
+ (code "GLU_UNSIGNED_INT")
+ ", "
+ (code "GLU_INT")
+ ", "
+ (code "GLU_FLOAT")
+ ", "
+ (code "GLU_UNSIGNED_BYTE_3_3_2")
+ ", "
+ (code "GLU_UNSIGNED_BYTE_2_3_3_REV")
+ ", "
+ (code "GLU_UNSIGNED_SHORT_5_6_5")
+ ", "
+ (code "GLU_UNSIGNED_SHORT_5_6_5_REV")
+ ", "
+ (code "GLU_UNSIGNED_SHORT_4_4_4_4")
+ ", "
+ (code "GLU_UNSIGNED_SHORT_4_4_4_4_REV")
+ ", "
+ (code "GLU_UNSIGNED_SHORT_5_5_5_1")
+ ", "
+ (code "GLU_UNSIGNED_SHORT_1_5_5_5_REV")
+ ", "
+ (code "GLU_UNSIGNED_INT_8_8_8_8")
+ ", "
+ (code "GLU_UNSIGNED_INT_8_8_8_8_REV")
+ ", "
+ (code "GLU_UNSIGNED_INT_10_10_10_2")
+ ", or "
+ (code "GLU_UNSIGNED_INT_2_10_10_10_REV")
+ ". "))
+ (entry (% (heading (var "level")))
+ (para "
+Specifies the mipmap level of the image data. "))
+ (entry (% (heading (var "base")))
+ (para "
+Specifies the minimum mipmap level to pass to "
+ (code "glTexImage3D")
+ ". "))
+ (entry (% (heading (var "max")))
+ (para "
+Specifies the maximum mipmap level to pass to "
+ (code "glTexImage3D")
+ ". "))
+ (entry (% (heading (var "data")))
+ (para "
+Specifies a pointer to the image data in memory. ")))
+ (heading "Description")
+ (para (code "gluBuild3DMipmapLevels")
+ " builds a subset of prefiltered three-dimensional texture maps of
+ decreasing resolutions called a mipmap. This is used for the antialiasing of
+ texture mapped primitives. ")
+ (para "
+A return value of zero indicates success, otherwise a GLU error code is
+ returned (see "
+ (code "gluErrorString")
+ "). ")
+ (para "
+A series of mipmap levels from "
+ (var "base")
+ " to "
+ (var "max")
+ " is built by
+ decimating "
+ (var "data")
+ " in half along both dimensions until size "
+ (math "1" "×" "1" "×" "1")
+ "
+is reached. At each level, each texel in the halved mipmap
+ level is an average of the corresponding eight texels in the larger
+ mipmap level. (If exactly one of the dimensions is 1, four texels are
+ averaged. If exactly two of the dimensions are 1, two texels are
+ averaged.) "
+ (code "glTexImage3D")
+ " is called to load these mipmap levels
+ from "
+ (var "base")
+ " to "
+ (var "max")
+ ". If "
+ (var "max")
+ " is larger than the highest mipmap
+ level for the texture of the specified size, then a GLU error code is
+ returned (see "
+ (code "gluErrorString")
+ ") and nothing is loaded. ")
+ (para "
+For example, if "
+ (var "level")
+ " is 2 and "
+ (var "width")
+ " is 16, "
+ (var "height")
+ " is 8 and "
+ (var "depth")
+ "
+is 4, the following levels are possible: "
+ (math "16" "×" "8" "×" "4")
+ ", "
+ (math "8" "×" "4" "×" "2")
+ ", "
+ (math "4" "×" "2" "×" "1")
+ ", "
+ (math "2" "×" "1" "×" "1")
+ ", "
+ (math "1" "×" "1" "×" "1")
+ ".
+ These correspond to levels 2 through 6 respectively. If "
+ (var "base")
+ " is
+ 3 and "
+ (var "max")
+ " is 5, then only mipmap levels "
+ (math "8" "×" "4" "×" "2")
+ ", "
+ (math "4" "×" "2" "×" "1")
+ ",
+ and "
+ (math "2" "×" "1" "×" "1")
+ "
+are loaded. However, if "
+ (var "max")
+ " is 7, then an error is returned and nothing is loaded, since "
+ (var "max")
+ " is larger than the highest mipmap level which is, in this case,
+ 6. ")
+ (para "
+The highest mipmap level can be derived from the formula "
+ (math (var "log")
+ "_"
+ "2"
+ "\u2061"
+ "("
+ (var "max")
+ "\u2061"
+ "("
+ (var "width")
+ ","
+ (var "height")
+ (var "depth")
+ ")"
+ "×"
+ "2"
+ "^"
+ (var "level")
+ ","
+ ")")
+ ". ")
+ (para "
+See the "
+ (code "glTexImage1D")
+ " reference page for a description of the
+ acceptable values for "
+ (var "format")
+ " parameter. See the "
+ (code "glDrawPixels")
+ " reference page for a description of the acceptable values
+ for "
+ (var "type")
+ " parameter. ")
+ (heading "Errors")
+ (para (code "GLU_INVALID_VALUE")
+ " is returned if "
+ (var "level")
+ " > "
+ (var "base")
+ ", "
+ (var "base")
+ " < 0, "
+ (var "max")
+ " < "
+ (var "base")
+ ", or "
+ (var "max")
+ " is > the highest mipmap level for "
+ (var "data")
+ ". ")
+ (para (code "GLU_INVALID_VALUE")
+ " is returned if "
+ (var "width")
+ ", "
+ (var "height")
+ ", or "
+ (var "depth")
+ " is < 1. ")
+ (para (code "GLU_INVALID_ENUM")
+ " is returned if "
+ (var "internalFormat")
+ ", "
+ (var "format")
+ ", or "
+ (var "type")
+ " is not
+ legal. ")
+ (para (code "GLU_INVALID_OPERATION")
+ " is returned if "
+ (var "type")
+ " is "
+ (code "GLU_UNSIGNED_BYTE_3_3_2")
+ " or "
+ (code "GLU_UNSIGNED_BYTE_2_3_3_REV")
+ "
+and "
+ (var "format")
+ " is not "
+ (code "GLU_RGB")
+ ". ")
+ (para (code "GLU_INVALID_OPERATION")
+ " is returned if "
+ (var "type")
+ " is "
+ (code "GLU_UNSIGNED_SHORT_5_6_5")
+ " or "
+ (code "GLU_UNSIGNED_SHORT_5_6_5_REV")
+ "
+and "
+ (var "format")
+ " is not "
+ (code "GLU_RGB")
+ ". ")
+ (para (code "GLU_INVALID_OPERATION")
+ " is returned if "
+ (var "type")
+ " is "
+ (code "GLU_UNSIGNED_SHORT_4_4_4_4")
+ " or "
+ (code "GLU_UNSIGNED_SHORT_4_4_4_4_REV")
+ "
+and "
+ (var "format")
+ " is neither "
+ (code "GLU_RGBA")
+ " nor "
+ (code "GLU_BGRA")
+ ". ")
+ (para (code "GLU_INVALID_OPERATION")
+ " is returned if "
+ (var "type")
+ " is "
+ (code "GLU_UNSIGNED_SHORT_5_5_5_1")
+ " or "
+ (code "GLU_UNSIGNED_SHORT_1_5_5_5_REV")
+ "
+and "
+ (var "format")
+ " is neither "
+ (code "GLU_RGBA")
+ " nor "
+ (code "GLU_BGRA")
+ ". ")
+ (para (code "GLU_INVALID_OPERATION")
+ " is returned if "
+ (var "type")
+ " is "
+ (code "GLU_UNSIGNED_INT_8_8_8_8")
+ " or "
+ (code "GLU_UNSIGNED_INT_8_8_8_8_REV")
+ "
+and "
+ (var "format")
+ " is neither "
+ (code "GLU_RGBA")
+ " nor "
+ (code "GLU_BGRA")
+ ". ")
+ (para (code "GLU_INVALID_OPERATION")
+ " is returned if "
+ (var "type")
+ " is "
+ (code "GLU_UNSIGNED_INT_10_10_10_2")
+ " or "
+ (code "GLU_UNSIGNED_INT_2_10_10_10_REV")
+ "
+and "
+ (var "format")
+ " is neither "
+ (code "GLU_RGBA")
+ " nor "
+ (code "GLU_BGRA")
+ ". ")))
+
+(define-gl-procedure
+ gluBuild3DMipmaps
+ "gluBuild3DMipmaps"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "GLint " (function "gluBuild3DMipmaps"))
+ (paramdef "GLenum " (parameter "target"))
+ (paramdef "GLint " (parameter "internalFormat"))
+ (paramdef "GLsizei " (parameter "width"))
+ (paramdef "GLsizei " (parameter "height"))
+ (paramdef "GLsizei " (parameter "depth"))
+ (paramdef "GLenum " (parameter "format"))
+ (paramdef "GLenum " (parameter "type"))
+ (paramdef "const void * " (parameter "data"))))
+ '(*fragment*
+ (heading "builds a three-dimensional mipmap")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "target")))
+ (para "
+Specifies the target texture. Must be "
+ (code "GLU_TEXTURE_3D")
+ ". "))
+ (entry (% (heading (var "internalFormat")))
+ (para "
+Requests the internal storage format of the texture image. The most
+ current version of the SGI implementation of GLU does not check this
+ value for validity before passing it on to the underlying OpenGL
+ implementation. A value that is not accepted by the OpenGL
+ implementation will lead to an OpenGL error. The benefit of not
+ checking this value at the GLU level is that OpenGL extensions can add
+ new internal texture formats without requiring a revision of the GLU
+ implementation. Older implementations of GLU check this value and
+ raise a GLU error if it is not 1, 2, 3, or 4 or one of the following
+ symbolic constants: "
+ (code "GLU_ALPHA")
+ ", "
+ (code "GLU_ALPHA4")
+ ", "
+ (code "GLU_ALPHA8")
+ ", "
+ (code "GLU_ALPHA12")
+ ", "
+ (code "GLU_ALPHA16")
+ ", "
+ (code "GLU_LUMINANCE")
+ ", "
+ (code "GLU_LUMINANCE4")
+ ", "
+ (code "GLU_LUMINANCE8")
+ ", "
+ (code "GLU_LUMINANCE12")
+ ", "
+ (code "GLU_LUMINANCE16")
+ ", "
+ (code "GLU_LUMINANCE_ALPHA")
+ ", "
+ (code "GLU_LUMINANCE4_ALPHA4")
+ ", "
+ (code "GLU_LUMINANCE6_ALPHA2")
+ ", "
+ (code "GLU_LUMINANCE8_ALPHA8")
+ ", "
+ (code "GLU_LUMINANCE12_ALPHA4")
+ ", "
+ (code "GLU_LUMINANCE12_ALPHA12")
+ ", "
+ (code "GLU_LUMINANCE16_ALPHA16")
+ ", "
+ (code "GLU_INTENSITY")
+ ", "
+ (code "GLU_INTENSITY4")
+ ", "
+ (code "GLU_INTENSITY8")
+ ", "
+ (code "GLU_INTENSITY12")
+ ", "
+ (code "GLU_INTENSITY16")
+ ", "
+ (code "GLU_RGB")
+ ", "
+ (code "GLU_R3_G3_B2")
+ ", "
+ (code "GLU_RGB4")
+ ", "
+ (code "GLU_RGB5")
+ ", "
+ (code "GLU_RGB8")
+ ", "
+ (code "GLU_RGB10")
+ ", "
+ (code "GLU_RGB12")
+ ", "
+ (code "GLU_RGB16")
+ ", "
+ (code "GLU_RGBA")
+ ", "
+ (code "GLU_RGBA2")
+ ", "
+ (code "GLU_RGBA4")
+ ", "
+ (code "GLU_RGB5_A1")
+ ", "
+ (code "GLU_RGBA8")
+ ", "
+ (code "GLU_RGB10_A2")
+ ", "
+ (code "GLU_RGBA12")
+ ", or "
+ (code "GLU_RGBA16")
+ ". "))
+ (entry (% (heading (var "width")))
+ (itemx (var "height"))
+ (itemx (var "depth"))
+ (para "
+Specifies in pixels the width, height and depth respectively, in pixels
+ of the texture image. "))
+ (entry (% (heading (var "format")))
+ (para "
+Specifies the format of the pixel data.
+ Must be one of "
+ (code "GLU_COLOR_INDEX")
+ ", "
+ (code "GLU_DEPTH_COMPONENT")
+ ", "
+ (code "GLU_RED")
+ ", "
+ (code "GLU_GREEN")
+ ", "
+ (code "GLU_BLUE")
+ ", "
+ (code "GLU_ALPHA")
+ ", "
+ (code "GLU_RGB")
+ ", "
+ (code "GLU_RGBA")
+ ", "
+ (code "GLU_BGR")
+ ", "
+ (code "GLU_BGRA")
+ ", "
+ (code "GLU_LUMINANCE")
+ ", or "
+ (code "GLU_LUMINANCE_ALPHA")
+ ". "))
+ (entry (% (heading (var "type")))
+ (para "
+Specifies the data type for "
+ (var "data")
+ ".
+ Must be one of: "
+ (code "GLU_UNSIGNED_BYTE")
+ ", "
+ (code "GLU_BYTE")
+ ", "
+ (code "GLU_BITMAP")
+ ", "
+ (code "GLU_UNSIGNED_SHORT")
+ ", "
+ (code "GLU_SHORT")
+ ", "
+ (code "GLU_UNSIGNED_INT")
+ ", "
+ (code "GLU_INT")
+ ", "
+ (code "GLU_FLOAT")
+ ", "
+ (code "GLU_UNSIGNED_BYTE_3_3_2")
+ ", "
+ (code "GLU_UNSIGNED_BYTE_2_3_3_REV")
+ ", "
+ (code "GLU_UNSIGNED_SHORT_5_6_5")
+ ", "
+ (code "GLU_UNSIGNED_SHORT_5_6_5_REV")
+ ", "
+ (code "GLU_UNSIGNED_SHORT_4_4_4_4")
+ ", "
+ (code "GLU_UNSIGNED_SHORT_4_4_4_4_REV")
+ ", "
+ (code "GLU_UNSIGNED_SHORT_5_5_5_1")
+ ", "
+ (code "GLU_UNSIGNED_SHORT_1_5_5_5_REV")
+ ", "
+ (code "GLU_UNSIGNED_INT_8_8_8_8")
+ ", "
+ (code "GLU_UNSIGNED_INT_8_8_8_8_REV")
+ ", "
+ (code "GLU_UNSIGNED_INT_10_10_10_2")
+ ", or "
+ (code "GLU_UNSIGNED_INT_2_10_10_10_REV")
+ ". "))
+ (entry (% (heading (var "data")))
+ (para "
+Specifies a pointer to the image data in memory. ")))
+ (heading "Description")
+ (para (code "gluBuild3DMipmaps")
+ " builds a series of prefiltered three-dimensional texture maps of
+ decreasing resolutions called a mipmap. This is used for the antialiasing of
+ texture-mapped primitives. ")
+ (para "
+A return value of zero indicates success, otherwise a GLU error code is
+ returned (see "
+ (code "gluErrorString")
+ "). ")
+ (para "
+Initially, the "
+ (var "width")
+ ", "
+ (var "height")
+ " and "
+ (var "depth")
+ " of "
+ (var "data")
+ " are checked to
+ see if they are a power of 2. If not, a copy of "
+ (var "data")
+ " is made and
+ scaled up or down to the nearest power of 2. (If "
+ (var "width")
+ ", "
+ (var "height")
+ ", or "
+ (var "depth")
+ " is exactly between powers of 2, then the copy of "
+ (var "data")
+ " will
+ scale upwards.) This copy will be used for subsequent mipmapping
+ operations described below. For example, if "
+ (var "width")
+ " is 57, "
+ (var "height")
+ " is
+ 23, and "
+ (var "depth")
+ " is 24, then a copy of "
+ (var "data")
+ " will scale up to 64 in
+ width, down to 16 in height, and up to 32 in depth before mipmapping
+ takes place. ")
+ (para "
+Then, proxy textures (see "
+ (code "glTexImage3D")
+ ") are used to determine if
+ the implementation can fit the requested texture. If not, all three dimensions
+ are continually halved until it fits. ")
+ (para "
+Next, a series of mipmap levels is built by decimating a copy of "
+ (var "data")
+ "
+in half along all three dimensions until size "
+ (math "1" "×" "1" "×" "1")
+ "
+is
+ reached. At each level, each texel in the halved mipmap level is an
+ average of the corresponding eight texels in the larger mipmap
+ level. (If exactly one of the dimensions is 1, four texels are averaged.
+ If exactly two of the dimensions are 1, two texels are averaged.) ")
+ (para (code "glTexImage3D")
+ " is called to load each of these mipmap levels.
+ Level 0 is a copy of "
+ (var "data")
+ ". The highest level is "
+ (math (var "log")
+ "_"
+ "2"
+ ","
+ "\u2061"
+ "("
+ (var "max")
+ "\u2061"
+ "("
+ (var "width")
+ ","
+ (var "height")
+ (var "depth")
+ ")"
+ ","
+ ")")
+ ".
+ For example, if "
+ (var "width")
+ " is 64, "
+ (var "height")
+ " is
+ 16, and "
+ (var "depth")
+ " is 32, and the implementation can store a texture of this
+ size, the following mipmap levels are built: "
+ (math "64" "×" "16" "×" "32")
+ ", "
+ (math "32" "×" "8" "×" "16")
+ ", "
+ (math "16" "×" "4" "×" "8")
+ ", "
+ (math "8" "×" "2" "×" "4")
+ ", "
+ (math "4" "×" "1" "×" "2")
+ ", "
+ (math "2" "×" "1" "×" "1")
+ ",
+ and "
+ (math "1" "×" "1" "×" "1")
+ ".
+ These correspond
+ to levels 0 through 6, respectively. ")
+ (para "
+See the "
+ (code "glTexImage1D")
+ " reference page for a description of the
+ acceptable values for "
+ (var "format")
+ " parameter. See the "
+ (code "glDrawPixels")
+ " reference page for a description of the acceptable values
+ for "
+ (var "type")
+ " parameter. ")
+ (heading "Errors")
+ (para (code "GLU_INVALID_VALUE")
+ " is returned if "
+ (var "width")
+ ", "
+ (var "height")
+ ", or "
+ (var "depth")
+ " is < 1. ")
+ (para (code "GLU_INVALID_ENUM")
+ " is returned if "
+ (var "internalFormat")
+ ", "
+ (var "format")
+ ", or "
+ (var "type")
+ " is not
+ legal. ")
+ (para (code "GLU_INVALID_OPERATION")
+ " is returned if "
+ (var "type")
+ " is "
+ (code "GLU_UNSIGNED_BYTE_3_3_2")
+ " or "
+ (code "GLU_UNSIGNED_BYTE_2_3_3_REV")
+ "
+and "
+ (var "format")
+ " is not "
+ (code "GLU_RGB")
+ ". ")
+ (para (code "GLU_INVALID_OPERATION")
+ " is returned if "
+ (var "type")
+ " is "
+ (code "GLU_UNSIGNED_SHORT_5_6_5")
+ " or "
+ (code "GLU_UNSIGNED_SHORT_5_6_5_REV")
+ "
+and "
+ (var "format")
+ " is not "
+ (code "GLU_RGB")
+ ". ")
+ (para (code "GLU_INVALID_OPERATION")
+ " is returned if "
+ (var "type")
+ " is "
+ (code "GLU_UNSIGNED_SHORT_4_4_4_4")
+ " or "
+ (code "GLU_UNSIGNED_SHORT_4_4_4_4_REV")
+ "
+and "
+ (var "format")
+ " is neither "
+ (code "GLU_RGBA")
+ " nor "
+ (code "GLU_BGRA")
+ ". ")
+ (para (code "GLU_INVALID_OPERATION")
+ " is returned if "
+ (var "type")
+ " is "
+ (code "GLU_UNSIGNED_SHORT_5_5_5_1")
+ " or "
+ (code "GLU_UNSIGNED_SHORT_1_5_5_5_REV")
+ "
+and "
+ (var "format")
+ " is neither "
+ (code "GLU_RGBA")
+ " nor "
+ (code "GLU_BGRA")
+ ". ")
+ (para (code "GLU_INVALID_OPERATION")
+ " is returned if "
+ (var "type")
+ " is "
+ (code "GLU_UNSIGNED_INT_8_8_8_8")
+ " or "
+ (code "GLU_UNSIGNED_INT_8_8_8_8_REV")
+ "
+and "
+ (var "format")
+ " is neither "
+ (code "GLU_RGBA")
+ " nor "
+ (code "GLU_BGRA")
+ ". ")
+ (para (code "GLU_INVALID_OPERATION")
+ " is returned if "
+ (var "type")
+ " is "
+ (code "GLU_UNSIGNED_INT_10_10_10_2")
+ " or "
+ (code "GLU_UNSIGNED_INT_2_10_10_10_REV")
+ "
+and "
+ (var "format")
+ " is neither "
+ (code "GLU_RGBA")
+ " nor "
+ (code "GLU_BGRA")
+ ". ")))
+
+(define-gl-procedure
+ gluCheckExtension
+ "gluCheckExtension"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "GLboolean "
+ (function "gluCheckExtension"))
+ (paramdef
+ "const GLubyte * "
+ (parameter "extName"))
+ (paramdef
+ "const GLubyte * "
+ (parameter "extString"))))
+ '(*fragment*
+ (heading
+ "determines if an extension name is supported")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "extName")))
+ (para "
+Specifies an extension name. "))
+ (entry (% (heading (var "extString")))
+ (para "
+Specifies a space-separated list of extension names supported. ")))
+ (heading "Description")
+ (para (code "gluCheckExtension")
+ " returns "
+ (code "GLU_TRUE")
+ " if "
+ (var "extName")
+ " is supported otherwise "
+ (code "GLU_FALSE")
+ " is returned. ")
+ (para "
+This is used to check for the presence for OpenGL, GLU, or GLX extension names
+ by passing the extension strings returned by "
+ (code "glGetString")
+ ", "
+ (code "gluGetString")
+ ", "
+ (code "glXGetClientString")
+ ", "
+ (code "glXQueryExtensionsString")
+ ", or "
+ (code "glXQueryServerString")
+ ",
+ respectively, as "
+ (var "extString")
+ ". ")))
+
+(define-gl-procedure
+ gluCylinder
+ "gluCylinder"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "gluCylinder"))
+ (paramdef "GLUquadric* " (parameter "quad"))
+ (paramdef "GLdouble " (parameter "base"))
+ (paramdef "GLdouble " (parameter "top"))
+ (paramdef "GLdouble " (parameter "height"))
+ (paramdef "GLint " (parameter "slices"))
+ (paramdef "GLint " (parameter "stacks"))))
+ '(*fragment*
+ (heading "draw a cylinder")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "quad")))
+ (para "
+Specifies the quadrics object (created with "
+ (code "gluNewQuadric")
+ "). "))
+ (entry (% (heading (var "base")))
+ (para "
+Specifies the radius of the cylinder at "
+ (var "z")
+ " = 0. "))
+ (entry (% (heading (var "top")))
+ (para "
+Specifies the radius of the cylinder at "
+ (var "z")
+ " = "
+ (var "height")
+ ". "))
+ (entry (% (heading (var "height")))
+ (para "
+Specifies the height of the cylinder. "))
+ (entry (% (heading (var "slices")))
+ (para "
+Specifies the number of subdivisions around the "
+ (var "z")
+ " axis. "))
+ (entry (% (heading (var "stacks")))
+ (para "
+Specifies the number of subdivisions along the "
+ (var "z")
+ " axis. ")))
+ (heading "Description")
+ (para (code "gluCylinder")
+ " draws a cylinder oriented along the "
+ (var "z")
+ " axis. The base of the cylinder
+ is placed at "
+ (var "z")
+ " = 0 and the top at "
+ (math (var "z") "=" (var "height"))
+ ".
+ Like a sphere,
+ a cylinder is subdivided around the "
+ (var "z")
+ " axis into slices and along the "
+ (var "z")
+ " axis into stacks. ")
+ (para "
+Note that if "
+ (var "top")
+ " is set to 0.0, this routine generates a cone. ")
+ (para "
+If the orientation is set to "
+ (code "GLU_OUTSIDE")
+ " (with "
+ (code "gluQuadricOrientation")
+ "), then any generated normals
+ point away from the "
+ (var "z")
+ " axis. Otherwise, they point toward the "
+ (var "z")
+ " axis. ")
+ (para "
+If texturing is turned on (with "
+ (code "gluQuadricTexture")
+ "), then texture
+ coordinates are generated so that "
+ (var "t")
+ " ranges linearly from 0.0
+ at "
+ (var "z")
+ " = 0 to 1.0 at "
+ (var "z")
+ " = "
+ (var "height")
+ ", and "
+ (var "s")
+ " ranges from 0.0 at the +"
+ (var "y")
+ " axis, to 0.25 at the +"
+ (var "x")
+ " axis,
+ to 0.5 at the -"
+ (var "y")
+ " axis, to 0.75 at the \\-"
+ (var "x")
+ " axis,
+ and back to 1.0 at the +"
+ (var "y")
+ " axis. ")))
+
+(define-gl-procedure
+ gluDeleteNurbsRenderer
+ "gluDeleteNurbsRenderer"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "void "
+ (function "gluDeleteNurbsRenderer"))
+ (paramdef "GLUnurbs* " (parameter "nurb"))))
+ '(*fragment*
+ (heading "destroy a NURBS object")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "nurb")))
+ (para "
+Specifies the NURBS object to be destroyed. ")))
+ (heading "Description")
+ (para (code "gluDeleteNurbsRenderer")
+ " destroys the NURBS object (which was created with "
+ (code "gluNewNurbsRenderer")
+ ") and frees any memory it uses.
+ Once "
+ (code "gluDeleteNurbsRenderer")
+ " has been called, "
+ (var "nurb")
+ " cannot be used again. ")))
+
+(define-gl-procedure
+ gluDeleteQuadric
+ "gluDeleteQuadric"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "gluDeleteQuadric"))
+ (paramdef "GLUquadric* " (parameter "quad"))))
+ '(*fragment*
+ (heading "destroy a quadrics object")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "quad")))
+ (para "
+Specifies the quadrics object to be destroyed. ")))
+ (heading "Description")
+ (para (code "gluDeleteQuadric")
+ " destroys the quadrics object (created with "
+ (code "gluNewQuadric")
+ ")
+ and frees any memory it uses.
+ Once "
+ (code "gluDeleteQuadric")
+ " has been called, "
+ (var "quad")
+ " cannot be used again. ")))
+
+(define-gl-procedure
+ gluDeleteTess
+ "gluDeleteTess"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "gluDeleteTess"))
+ (paramdef "GLUtesselator* " (parameter "tess"))))
+ '(*fragment*
+ (heading "destroy a tessellation object")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "tess")))
+ (para "
+Specifies the tessellation object to destroy. ")))
+ (heading "Description")
+ (para (code "gluDeleteTess")
+ " destroys the indicated tessellation object (which was created
+ with "
+ (code "gluNewTess")
+ ") and frees any memory that it used. ")))
+
+(define-gl-procedure
+ gluDisk
+ "gluDisk"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "gluDisk"))
+ (paramdef "GLUquadric* " (parameter "quad"))
+ (paramdef "GLdouble " (parameter "inner"))
+ (paramdef "GLdouble " (parameter "outer"))
+ (paramdef "GLint " (parameter "slices"))
+ (paramdef "GLint " (parameter "loops"))))
+ '(*fragment*
+ (heading "draw a disk")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "quad")))
+ (para "
+Specifies the quadrics object (created with "
+ (code "gluNewQuadric")
+ "). "))
+ (entry (% (heading (var "inner")))
+ (para "
+Specifies the inner radius of the disk (may be 0). "))
+ (entry (% (heading (var "outer")))
+ (para "
+Specifies the outer radius of the disk. "))
+ (entry (% (heading (var "slices")))
+ (para "
+Specifies the number of subdivisions around the "
+ (var "z")
+ " axis. "))
+ (entry (% (heading (var "loops")))
+ (para "
+Specifies the number of concentric rings about the origin into which
+ the disk is subdivided. ")))
+ (heading "Description")
+ (para (code "gluDisk")
+ " renders a disk on the "
+ (var "z")
+ " = 0 plane. The disk has a radius of "
+ (var "outer")
+ " and contains a concentric circular hole with a radius
+ of "
+ (var "inner")
+ ". If "
+ (var "inner")
+ " is 0, then no hole is generated. The disk is
+ subdivided around the "
+ (var "z")
+ " axis into slices (like pizza slices) and also
+ about the "
+ (var "z")
+ " axis into rings
+ (as specified by "
+ (var "slices")
+ " and "
+ (var "loops")
+ ", respectively). ")
+ (para "
+With respect to orientation, the +"
+ (var "z")
+ " side of the disk is considered to be
+ ``outside'' (see "
+ (code "gluQuadricOrientation")
+ ").
+ This means that if the
+ orientation is set to "
+ (code "GLU_OUTSIDE")
+ ", then any normals generated
+ point along the +"
+ (var "z")
+ " axis. Otherwise, they point along the \\-"
+ (var "z")
+ " axis. ")
+ (para "
+If texturing has been turned on (with "
+ (code "gluQuadricTexture")
+ "),
+ texture coordinates are generated
+ linearly such that where "
+ (math (var "r") "=" (var "outer"))
+ ",
+ the value at ("
+ (var "r")
+ ", 0, 0) is
+ (1, 0.5), at (0, "
+ (var "r")
+ ", 0) it is (0.5, 1), at (\\-"
+ (var "r")
+ ", 0, 0)
+ it is (0, 0.5), and
+ at (0, \\-"
+ (var "r")
+ ", 0) it is (0.5, 0). ")))
+
+(define-gl-procedure
+ gluErrorString
+ "gluErrorString"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "const GLubyte * "
+ (function "gluErrorString"))
+ (paramdef "GLenum " (parameter "error"))))
+ '(*fragment*
+ (heading
+ "produce an error string from a GL or GLU error code")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "error")))
+ (para "
+Specifies a GL or GLU error code. ")))
+ (heading "Description")
+ (para (code "gluErrorString")
+ " produces an error string from a GL or GLU error code. The string
+ is in ISO Latin 1 format. For example, "
+ (code "gluErrorString")
+ "("
+ (code "GLU_OUT_OF_MEMORY")
+ ") returns the string "
+ (var "out of memory")
+ ". ")
+ (para "
+The standard GLU error codes are "
+ (code "GLU_INVALID_ENUM")
+ ", "
+ (code "GLU_INVALID_VALUE")
+ ",
+ and "
+ (code "GLU_OUT_OF_MEMORY")
+ ".
+ Certain other GLU functions can return specialized error codes
+ through callbacks.
+ See the "
+ (code "glGetError")
+ " reference page for the list of
+ GL error codes. ")
+ (heading "Errors")
+ (para (code "NULL")
+ " is returned if "
+ (var "error")
+ " is not a valid GL or GLU error code. ")))
+
+(define-gl-procedure
+ gluGetNurbsProperty
+ "gluGetNurbsProperty"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "void "
+ (function "gluGetNurbsProperty"))
+ (paramdef "GLUnurbs* " (parameter "nurb"))
+ (paramdef "GLenum " (parameter "property"))
+ (paramdef "GLfloat* " (parameter "data"))))
+ '(*fragment*
+ (heading "get a NURBS property")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "nurb")))
+ (para "
+Specifies the NURBS object (created with "
+ (code "gluNewNurbsRenderer")
+ "). "))
+ (entry (% (heading (var "property")))
+ (para "
+Specifies the property whose value is to be fetched. Valid values are "
+ (code "GLU_CULLING")
+ ", "
+ (code "GLU_SAMPLING_TOLERANCE")
+ ", "
+ (code "GLU_DISPLAY_MODE")
+ ", "
+ (code "GLU_AUTO_LOAD_MATRIX")
+ ", "
+ (code "GLU_PARAMETRIC_TOLERANCE")
+ ", "
+ (code "GLU_SAMPLING_METHOD")
+ ", "
+ (code "GLU_U_STEP")
+ ", "
+ (code "GLU_V_STEP")
+ ", and "
+ (code "GLU_NURBS_MODE")
+ ". "))
+ (entry (% (heading (var "data")))
+ (para "
+Specifies a pointer to the location into which the value of the
+ named property is written. ")))
+ (heading "Description")
+ (para (code "gluGetNurbsProperty")
+ " retrieves properties stored in a NURBS object. These
+ properties affect the way that NURBS curves and surfaces
+ are rendered. See the "
+ (code "gluNurbsProperty")
+ " reference page for information about what the
+ properties are and what they do. ")))
+
+(define-gl-procedure
+ gluGetString
+ "gluGetString"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "const GLubyte * "
+ (function "gluGetString"))
+ (paramdef "GLenum " (parameter "name"))))
+ '(*fragment*
+ (heading
+ "return a string describing the GLU version or GLU extensions ")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "name")))
+ (para "
+Specifies a symbolic constant, one of "
+ (code "GLU_VERSION")
+ ", or "
+ (code "GLU_EXTENSIONS")
+ ". ")))
+ (heading "Description")
+ (para (code "gluGetString")
+ " returns a pointer to a static string describing the
+ GLU version or the GLU extensions that are supported. ")
+ (para "
+The version number is one of the following
+ forms: ")
+ (para (var "major_number.minor_number")
+ (var "major_number.minor_number.release_number")
+ ". ")
+ (para "
+The version string is of the following form: ")
+ (para (var "version number<space>vendor-specific information"))
+ (para "
+Vendor-specific information is optional.
+ Its format and contents depend on the implementation. ")
+ (para "
+The standard GLU contains a basic set of features and capabilities.
+ If a company or group of companies wish to support other features,
+ these may be included as extensions to the GLU.
+ If "
+ (var "name")
+ " is "
+ (code "GLU_EXTENSIONS")
+ ", then "
+ (code "gluGetString")
+ "
+returns a space-separated list of names of supported GLU extensions.
+ (Extension names never contain spaces.) ")
+ (para "
+All strings are null-terminated. ")
+ (heading "Errors")
+ (para "
+NULL is returned if "
+ (var "name")
+ " is not "
+ (code "GLU_VERSION")
+ " or "
+ (code "GLU_EXTENSIONS")
+ ". ")
+ (para)))
+
+(define-gl-procedure
+ gluGetTessProperty
+ "gluGetTessProperty"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "gluGetTessProperty"))
+ (paramdef "GLUtesselator* " (parameter "tess"))
+ (paramdef "GLenum " (parameter "which"))
+ (paramdef "GLdouble* " (parameter "data"))))
+ '(*fragment*
+ (heading "get a tessellation object property")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "tess")))
+ (para "
+Specifies the tessellation object (created with "
+ (code "gluNewTess")
+ "). "))
+ (entry (% (heading (var "which")))
+ (para "
+Specifies the property whose value is to be fetched. Valid values are "
+ (code "GLU_TESS_WINDING_RULE")
+ ", "
+ (code "GLU_TESS_BOUNDARY_ONLY")
+ ", and "
+ (code "GLU_TESS_TOLERANCE")
+ ". "))
+ (entry (% (heading (var "data")))
+ (para "
+Specifies a pointer to the location into which the value of the
+ named property is written. ")))
+ (heading "Description")
+ (para (code "gluGetTessProperty")
+ " retrieves properties stored in a tessellation object. These
+ properties affect the way that tessellation objects
+ are interpreted and rendered. See the "
+ (code "gluTessProperty")
+ " reference page for information about the
+ properties and what they do. ")))
+
+(define-gl-procedure
+ gluLoadSamplingMatrices
+ "gluLoadSamplingMatrices"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "void "
+ (function "gluLoadSamplingMatrices"))
+ (paramdef "GLUnurbs* " (parameter "nurb"))
+ (paramdef "const GLfloat * " (parameter "model"))
+ (paramdef
+ "const GLfloat * "
+ (parameter "perspective"))
+ (paramdef "const GLint * " (parameter "view"))))
+ '(*fragment*
+ (heading
+ "load NURBS sampling and culling matrices")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "nurb")))
+ (para "
+Specifies the NURBS object (created with "
+ (code "gluNewNurbsRenderer")
+ "). "))
+ (entry (% (heading (var "model")))
+ (para "
+Specifies a modelview matrix (as from a "
+ (code "glGetFloatv")
+ " call). "))
+ (entry (% (heading (var "perspective")))
+ (para "
+Specifies a projection matrix (as from a "
+ (code "glGetFloatv")
+ " call). "))
+ (entry (% (heading (var "view")))
+ (para "
+Specifies a viewport (as from a "
+ (code "glGetIntegerv")
+ " call). ")))
+ (heading "Description")
+ (para (code "gluLoadSamplingMatrices")
+ " uses "
+ (var "model")
+ ", "
+ (var "perspective")
+ ", and "
+ (var "view")
+ " to recompute the sampling and culling
+ matrices stored in "
+ (var "nurb")
+ ".
+ The sampling matrix determines how finely a NURBS curve or surface
+ must be tessellated to satisfy the sampling tolerance (as determined by the "
+ (code "GLU_SAMPLING_TOLERANCE")
+ " property).
+ The culling matrix is used in deciding if a NURBS curve or surface
+ should be culled before
+ rendering (when the "
+ (code "GLU_CULLING")
+ " property is turned on). ")
+ (para (code "gluLoadSamplingMatrices")
+ " is necessary only if the "
+ (code "GLU_AUTO_LOAD_MATRIX")
+ " property is turned
+ off (see "
+ (code "gluNurbsProperty")
+ ").
+ Although it can be convenient to leave the "
+ (code "GLU_AUTO_LOAD_MATRIX")
+ "
+property turned on, there can be a performance penalty for doing so.
+ (A round trip to the GL server is needed to fetch the current values
+ of the modelview matrix, projection matrix, and viewport.) ")))
+
+(define-gl-procedure
+ gluLookAt
+ "gluLookAt"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "gluLookAt"))
+ (paramdef "GLdouble " (parameter "eyeX"))
+ (paramdef "GLdouble " (parameter "eyeY"))
+ (paramdef "GLdouble " (parameter "eyeZ"))
+ (paramdef "GLdouble " (parameter "centerX"))
+ (paramdef "GLdouble " (parameter "centerY"))
+ (paramdef "GLdouble " (parameter "centerZ"))
+ (paramdef "GLdouble " (parameter "upX"))
+ (paramdef "GLdouble " (parameter "upY"))
+ (paramdef "GLdouble " (parameter "upZ"))))
+ '(*fragment*
+ (heading "define a viewing transformation")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "eyeX")))
+ (itemx (var "eyeY"))
+ (itemx (var "eyeZ"))
+ (para "
+Specifies the position of the eye point. "))
+ (entry (% (heading (var "centerX")))
+ (itemx (var "centerY"))
+ (itemx (var "centerZ"))
+ (para "
+Specifies the position of the reference point. "))
+ (entry (% (heading (var "upX")))
+ (itemx (var "upY"))
+ (itemx (var "upZ"))
+ (para "
+Specifies the direction of the "
+ (var "up")
+ " vector. ")))
+ (heading "Description")
+ (para (code "gluLookAt")
+ " creates a viewing matrix derived from an eye point, a reference
+ point indicating the center of the scene, and an "
+ (var "UP")
+ " vector. ")
+ (para "
+The matrix
+ maps the reference point to the negative "
+ (var "z")
+ " axis and the
+ eye point to the origin.
+ When a typical projection matrix is used,
+ the center of the scene therefore maps to the center of the viewport.
+ Similarly, the direction described by the "
+ (var "UP")
+ "
+vector projected onto the viewing plane is mapped to the positive "
+ (var "y")
+ " axis so that it points upward in the viewport.
+ The "
+ (var "UP")
+ " vector must not be parallel to the line of sight from the
+ eye point to the reference point. ")
+ (para "
+Let ")
+ (para (math (var "F")
+ "="
+ "("
+ "("
+ (var "centerX")
+ "-"
+ (var "eyeX")
+ ")"
+ ", "
+ "("
+ (var "centerY")
+ "-"
+ (var "eyeY")
+ ")"
+ ", "
+ "("
+ (var "centerZ")
+ "-"
+ (var "eyeZ")
+ ")"
+ ","
+ ")"))
+ (para)
+ (para "
+Let "
+ (var "UP")
+ " be the vector "
+ (math "("
+ (var "upX")
+ ","
+ (var "upY")
+ (var "upZ")
+ ")")
+ ". ")
+ (para "
+Then normalize as follows: "
+ (math (var "f")
+ "="
+ (var "F")
+ "/"
+ "∥"
+ (var "F")
+ ","
+ "∥"
+ ","))
+ (para (math (var "UP")
+ "^"
+ "″"
+ "="
+ (var "UP")
+ "/"
+ "∥"
+ (var "UP")
+ ","
+ "∥"
+ ","))
+ (para)
+ (para "
+Finally, let "
+ (math (var "s")
+ "="
+ (var "f")
+ "×"
+ (var "UP")
+ "^"
+ "″")
+ ",
+ and "
+ (math (var "u") "=" (var "s") "×" (var "f"))
+ ". ")
+ (para)
+ (para "
+M is then constructed as follows: "
+ (math (var "M")
+ "="
+ "("
+ "("
+ (var "s")
+ "\u2061"
+ "["
+ "0"
+ ","
+ "]"
+ " "
+ (var "s")
+ "\u2061"
+ "["
+ "1"
+ ","
+ "]"
+ " "
+ (var "s")
+ "\u2061"
+ "["
+ "2"
+ ","
+ "]"
+ " "
+ "0"
+ ")"
+ ", "
+ "("
+ (var "u")
+ "\u2061"
+ "["
+ "0"
+ ","
+ "]"
+ " "
+ (var "u")
+ "\u2061"
+ "["
+ "1"
+ ","
+ "]"
+ " "
+ (var "u")
+ "\u2061"
+ "["
+ "2"
+ ","
+ "]"
+ " "
+ "0"
+ ")"
+ ", "
+ "("
+ "-"
+ (var "f")
+ "\u2061"
+ "["
+ "0"
+ ","
+ "]"
+ " "
+ "-"
+ (var "f")
+ "\u2061"
+ "["
+ "1"
+ ","
+ "]"
+ " "
+ "-"
+ (var "f")
+ "\u2061"
+ "["
+ "2"
+ ","
+ "]"
+ " "
+ "0"
+ ")"
+ ", "
+ "("
+ "0"
+ " "
+ "0"
+ " "
+ "0"
+ " "
+ "1"
+ ")"
+ ","
+ ")"))
+ (para "
+and "
+ (code "gluLookAt")
+ " is equivalent to ")
+ (example
+ "
+glMultMatrixf(M);
+glTranslated(-eyex, -eyey, -eyez); ")))
+
+(define-gl-procedure
+ gluNewNurbsRenderer
+ "gluNewNurbsRenderer"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "GLUnurbs* "
+ (function "gluNewNurbsRenderer"))))
+ '(*fragment*
+ (heading "create a NURBS object")
+ (heading "Description")
+ (para (code "gluNewNurbsRenderer")
+ " creates and returns a pointer to
+ a new NURBS object.
+ This object must be referred to when calling
+ NURBS rendering and control functions. A return value of
+ 0 means that there is not enough memory to allocate the object. ")))
+
+(define-gl-procedure
+ gluNewQuadric
+ "gluNewQuadric"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "GLUquadric* "
+ (function "gluNewQuadric"))))
+ '(*fragment*
+ (heading "create a quadrics object")
+ (heading "Description")
+ (para (code "gluNewQuadric")
+ " creates and returns a pointer to
+ a new quadrics object. This object must be referred to when
+ calling quadrics rendering and control functions. A return value of
+ 0 means that there is not enough memory to allocate the object. ")))
+
+(define-gl-procedure
+ gluNewTess
+ "gluNewTess"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "GLUtesselator* "
+ (function "gluNewTess"))))
+ '(*fragment*
+ (heading "create a tessellation object")
+ (heading "Description")
+ (para (code "gluNewTess")
+ " creates and returns a pointer to a new tessellation object.
+ This object must be referred to when calling
+ tessellation functions. A return value of
+ 0 means that there is not enough memory to allocate the object. ")))
+
+(define-gl-procedure
+ gluNextContour
+ "gluNextContour"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "gluNextContour"))
+ (paramdef "GLUtesselator* " (parameter "tess"))
+ (paramdef "GLenum " (parameter "type"))))
+ '(*fragment*
+ (heading "mark the beginning of another contour")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "tess")))
+ (para "
+Specifies the tessellation object (created with "
+ (code "gluNewTess")
+ "). "))
+ (entry (% (heading (var "type")))
+ (para "
+Specifies the type of the contour being defined. Valid values are "
+ (code "GLU_EXTERIOR")
+ ", "
+ (code "GLU_INTERIOR")
+ ", "
+ (code "GLU_UNKNOWN")
+ ", "
+ (code "GLU_CCW")
+ ", and "
+ (code "GLU_CW")
+ ". ")))
+ (heading "Description")
+ (para (code "gluNextContour")
+ " is used in describing polygons with multiple contours. After the first
+ contour has been described through a series of "
+ (code "gluTessVertex")
+ " calls,
+ a "
+ (code "gluNextContour")
+ " call indicates that the previous contour is complete and that the
+ next contour is about to begin.
+ Another series of "
+ (code "gluTessVertex")
+ " calls is then used to describe the new
+ contour. This process can be repeated until all contours have been described. ")
+ (para (var "type")
+ " defines what type of contour follows.
+ The legal contour types are as follows: ")
+ (table (% (formatter (asis)))
+ (entry (% (heading (code "GLU_EXTERIOR")))
+ (para "
+An exterior contour defines an exterior boundary of the polygon. "))
+ (entry (% (heading (code "GLU_INTERIOR")))
+ (para "
+An interior contour defines an interior boundary of the polygon (such as
+ a hole). "))
+ (entry (% (heading (code "GLU_UNKNOWN")))
+ (para "
+An unknown contour is analyzed by the library to determine if it is interior
+ or exterior. "))
+ (entry (% (heading (code "GLU_CCW") ", ")))
+ (entry (% (heading (code "GLU_CW")))
+ (para "
+The first "
+ (code "GLU_CCW")
+ " or "
+ (code "GLU_CW")
+ " contour defined is considered to
+ be exterior. All other contours are considered to be exterior if they
+ are oriented in the same direction (clockwise or counterclockwise) as
+ the first contour, and interior if they are not. ")))
+ (para "
+If one contour is of type "
+ (code "GLU_CCW")
+ " or "
+ (code "GLU_CW")
+ ", then all
+ contours must be of the same type (if they are not, then all "
+ (code "GLU_CCW")
+ "
+and "
+ (code "GLU_CW")
+ " contours will be changed to "
+ (code "GLU_UNKNOWN")
+ "). ")
+ (para "
+Note that there is no real difference between the "
+ (code "GLU_CCW")
+ " and "
+ (code "GLU_CW")
+ " contour types. ")
+ (para "
+Before the first contour is described, "
+ (code "gluNextContour")
+ " can be called to
+ define the type of the first contour.
+ If "
+ (code "gluNextContour")
+ " is not called before the first contour, then the first contour is
+ marked "
+ (code "GLU_EXTERIOR")
+ ". ")
+ (para "
+This command is obsolete and is provided for backward compatibility
+ only. Calls to "
+ (code "gluNextContour")
+ " are mapped to "
+ (code "gluTessEndContour")
+ "
+followed by "
+ (code "gluTessBeginContour")
+ ". ")))
+
+(define-gl-procedure
+ gluNurbsCallbackDataEXT
+ "gluNurbsCallbackDataEXT"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "void "
+ (function "gluNurbsCallbackDataEXT"))
+ (paramdef "GLUnurbs* " (parameter "nurb"))
+ (paramdef "GLvoid* " (parameter "userData"))))
+ '(*fragment*
+ (heading "set a user data pointer")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "nurb")))
+ (para "
+Specifies the NURBS object (created with "
+ (code "gluNewNurbsRenderer")
+ "). "))
+ (entry (% (heading (var "userData")))
+ (para "
+Specifies a pointer to the user's data. ")))
+ (heading "Description")
+ (para (code "gluNurbsCallbackDataEXT")
+ " is used to pass a pointer to the application's data to NURBS
+ tessellator. A copy of this pointer will be passed by the tessellator
+ in the NURBS callback functions (set by "
+ (code "gluNurbsCallback")
+ "). ")))
+
+(define-gl-procedure
+ gluNurbsCallbackData
+ "gluNurbsCallbackData"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "void "
+ (function "gluNurbsCallbackData"))
+ (paramdef "GLUnurbs* " (parameter "nurb"))
+ (paramdef "GLvoid* " (parameter "userData"))))
+ '(*fragment*
+ (heading "set a user data pointer")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "nurb")))
+ (para "
+Specifies the NURBS object (created with "
+ (code "gluNewNurbsRenderer")
+ "). "))
+ (entry (% (heading (var "userData")))
+ (para "
+Specifies a pointer to the user's data. ")))
+ (heading "Description")
+ (para (code "gluNurbsCallbackData")
+ " is used to pass a pointer to the application's data to NURBS
+ tessellator. A copy of this pointer will be passed by the tessellator
+ in the NURBS callback functions (set by "
+ (code "gluNurbsCallback")
+ "). ")))
+
+(define-gl-procedure
+ gluNurbsCallback
+ "gluNurbsCallback"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "gluNurbsCallback"))
+ (paramdef "GLUnurbs* " (parameter "nurb"))
+ (paramdef "GLenum " (parameter "which"))
+ (paramdef
+ "_GLUfuncptr "
+ (parameter "CallBackFunc"))))
+ '(*fragment*
+ (heading "define a callback for a NURBS object")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "nurb")))
+ (para "
+Specifies the NURBS object (created with "
+ (code "gluNewNurbsRenderer")
+ "). "))
+ (entry (% (heading (var "which")))
+ (para "
+Specifies the callback being defined.
+ Valid values are "
+ (code "GLU_NURBS_BEGIN")
+ ", "
+ (code "GLU_NURBS_VERTEX")
+ ", "
+ (code "GLU_NURBS_NORMAL")
+ ", "
+ (code "GLU_NURBS_COLOR")
+ ", "
+ (code "GLU_NURBS_TEXTURE_COORD")
+ ", "
+ (code "GLU_NURBS_END")
+ ", "
+ (code "GLU_NURBS_BEGIN_DATA")
+ ", "
+ (code "GLU_NURBS_VERTEX_DATA")
+ ", "
+ (code "GLU_NURBS_NORMAL_DATA")
+ ", "
+ (code "GLU_NURBS_COLOR_DATA")
+ ", "
+ (code "GLU_NURBS_TEXTURE_COORD_DATA")
+ ", "
+ (code "GLU_NURBS_END_DATA")
+ ", and "
+ (code "GLU_NURBS_ERROR")
+ ". "))
+ (entry (% (heading (var "CallBackFunc")))
+ (para "
+Specifies the function that the callback calls. ")))
+ (heading "Description")
+ (para (code "gluNurbsCallback")
+ " is used to define a callback to be used by a NURBS
+ object.
+ If the specified callback is already defined, then it is replaced. If "
+ (var "CallBackFunc")
+ " is NULL, then this callback will not get
+ invoked and the related data, if any, will be lost. ")
+ (para "
+Except the error callback, these callbacks are used by NURBS tessellator (when "
+ (code "GLU_NURBS_MODE")
+ " is set to be "
+ (code "GLU_NURBS_TESSELLATOR")
+ ") to return back the OpenGL
+ polygon primitives resulting from the tessellation. Note that there are two
+ versions of each callback: one with a user data pointer and one without. If both versions for a particular callback are specified then the callback with
+ the user data pointer will be used. Note that ``userData'' is a copy of the pointer that was specified at the last call to "
+ (code "gluNurbsCallbackData")
+ ". ")
+ (para "
+The error callback function is effective no matter which value that "
+ (code "GLU_NURBS_MODE")
+ " is set to.
+ All other callback functions are effective only when "
+ (code "GLU_NURBS_MODE")
+ "
+is set to "
+ (code "GLU_NURBS_TESSELLATOR")
+ ". ")
+ (para "
+The legal callbacks are as follows: ")
+ (table (% (formatter (asis)))
+ (entry (% (heading (code "GLU_NURBS_BEGIN")))
+ (para)
+ (para "
+The begin callback indicates the start of a primitive. The function
+ takes a single argument of type GLenum, which can be one of "
+ (code "GLU_LINES")
+ ", "
+ (code "GLU_LINE_STRIP")
+ ", "
+ (code "GLU_TRIANGLE_FAN")
+ ", "
+ (code "GLU_TRIANGLE_STRIP")
+ ", "
+ (code "GLU_TRIANGLES")
+ ", or "
+ (code "GLU_QUAD_STRIP")
+ ". The
+ default begin callback function is NULL. The function prototype
+ for this callback looks like: "))
+ (entry (% (heading (code "GLU_NURBS_BEGIN_DATA")))
+ (para)
+ (para "
+The same as the "
+ (code "GLU_NURBS_BEGIN")
+ " callback except that it takes an
+ additional pointer argument. This pointer is a copy of the pointer that
+ was specified at the last call to "
+ (code "gluNurbsCallbackData")
+ ". The
+ default callback function is NULL. The function prototype for this
+ callback function looks like: "))
+ (entry (% (heading (code "GLU_NURBS_VERTEX")))
+ (para)
+ (para "
+The vertex callback indicates a vertex of the primitive. The
+ coordinates of the vertex are stored in the parameter ``vertex''. All
+ the generated vertices have dimension 3; that is, homogeneous
+ coordinates have been transformed into affine coordinates. The default
+ vertex callback function is NULL. The function prototype for this
+ callback function looks like: "))
+ (entry (% (heading (code "GLU_NURBS_VERTEX_DATA")))
+ (para)
+ (para "
+This is the same as the "
+ (code "GLU_NURBS_VERTEX")
+ " callback, except that
+ it takes an additional pointer argument. This pointer is a copy of the
+ pointer that was specified at the last call to "
+ (code "gluNurbsCallbackData")
+ ". The default callback function is NULL. The
+ function prototype for this callback function looks like: "))
+ (entry (% (heading (code "GLU_NURBS_NORMAL")))
+ (para)
+ (para "
+The normal callback is invoked as the vertex normal is generated.
+ The components of the normal are stored in the parameter ``normal.''
+ In the case of a NURBS curve, the callback function is effective only when
+ the user provides a normal map ("
+ (code "GLU_MAP1_NORMAL")
+ ").
+ In the case of a NURBS surface, if a normal map ("
+ (code "GLU_MAP2_NORMAL")
+ ")
+ is provided, then the generated normal is computed from the normal map.
+ If a normal map is not provided, then a surface normal is computed in
+ a manner similar to that described for evaluators when "
+ (code "GLU_AUTO_NORMAL")
+ "
+is enabled.
+ The default normal callback function is NULL. The function
+ prototype for this callback function looks like: "))
+ (entry (% (heading (code "GLU_NURBS_NORMAL_DATA")))
+ (para)
+ (para "
+The same as the "
+ (code "GLU_NURBS_NORMAL")
+ " callback except that it
+ takes an additional pointer argument. This pointer is a copy of the pointer
+ that was specified at the last call to "
+ (code "gluNurbsCallbackData")
+ ". The default callback function is NULL. The function prototype for this callback function looks like: "))
+ (entry (% (heading (code "GLU_NURBS_COLOR")))
+ (para)
+ (para "
+The color callback is invoked as the color of a vertex is generated.
+ The components of the color are stored in the parameter ``color.''
+ This callback is effective only when the user provides a color map
+ ("
+ (code "GLU_MAP1_COLOR_4")
+ " or "
+ (code "GLU_MAP2_COLOR_4")
+ "). ``color'' contains four
+ components: R, G, B, A. The default color callback function is NULL.
+ The prototype for this callback function looks like: "))
+ (entry (% (heading (code "GLU_NURBS_COLOR_DATA")))
+ (para)
+ (para "
+The same as the "
+ (code "GLU_NURBS_COLOR")
+ " callback except that it
+ takes an additional pointer argument. This pointer is a copy of the pointer
+ that was specified at the last call to "
+ (code "gluNurbsCallbackData")
+ ". The default callback function is NULL. The function prototype for this callback function looks like: "))
+ (entry (% (heading (code "GLU_NURBS_TEXTURE_COORD")))
+ (para)
+ (para "
+The texture callback is invoked as the texture coordinates
+ of a vertex are generated. These coordinates are stored in the parameter
+ ``texCoord.'' The number of texture coordinates can be 1, 2, 3, or 4 depending
+ on which type of texture map is specified
+ ("
+ (code "GLU_MAP1_TEXTURE_COORD_1")
+ ", "
+ (code "GLU_MAP1_TEXTURE_COORD_2")
+ ", "
+ (code "GLU_MAP1_TEXTURE_COORD_3")
+ ", "
+ (code "GLU_MAP1_TEXTURE_COORD_4")
+ ", "
+ (code "GLU_MAP2_TEXTURE_COORD_1")
+ ", "
+ (code "GLU_MAP2_TEXTURE_COORD_2")
+ ", "
+ (code "GLU_MAP2_TEXTURE_COORD_3")
+ ", "
+ (code "GLU_MAP2_TEXTURE_COORD_4")
+ ").
+ If no texture map is specified, this callback function will not be called.
+ The default texture callback function is NULL. The function prototype
+ for this callback function looks like: "))
+ (entry (% (heading (code "GLU_NURBS_TEXTURE_COORD_DATA")))
+ (para)
+ (para "
+This is the same as the "
+ (code "GLU_NURBS_TEXTURE_COORD")
+ " callback, except that it
+ takes an additional pointer argument. This pointer is a copy of the pointer
+ that was specified at the last call to "
+ (code "gluNurbsCallbackData")
+ ". The default callback function is NULL. The function prototype for this callback function looks like: "))
+ (entry (% (heading (code "GLU_NURBS_END")))
+ (para)
+ (para "
+The end callback is invoked at the end of a primitive. The default end callback function is NULL. The function prototype for this callback function looks like: "))
+ (entry (% (heading (code "GLU_NURBS_END_DATA")))
+ (para)
+ (para "
+This is the same as the "
+ (code "GLU_NURBS_END")
+ " callback, except that it
+ takes an additional pointer argument. This pointer is a copy of the pointer
+ that was specified at the last call to "
+ (code "gluNurbsCallbackData")
+ ". The default callback function is NULL. The function prototype for this callback function looks like: "))
+ (entry (% (heading (code "GLU_NURBS_ERROR")))
+ (para)
+ (para "
+The error function is called when an error is encountered.
+ Its single argument
+ is of type GLenum, and it indicates the specific error that occurred.
+ There are 37 errors unique to NURBS, named "
+ (code "GLU_NURBS_ERROR1")
+ " through "
+ (code "GLU_NURBS_ERROR37")
+ ".
+ Character strings describing these errors can be retrieved with "
+ (code "gluErrorString")
+ ". ")))
+ (example "
+void begin( GLenum type ); ")
+ (example
+ "
+void beginData(GLenum type, void *userData); ")
+ (example "
+void vertex( GLfloat *vertex ); ")
+ (example
+ "
+void vertexData( GLfloat *vertex, void *userData ); ")
+ (example "
+void normal( GLfloat *normal ); ")
+ (example
+ "
+void normalData( GLfloat *normal, void *userData ); ")
+ (example "
+void color( GLfloat *color ); ")
+ (example
+ "
+void colorData( GLfloat *color, void *userData ); ")
+ (example "
+void texCoord( GLfloat *texCoord ); ")
+ (example
+ "
+void texCoordData( GLfloat *texCoord, void *userData ); ")
+ (example "
+void end( void ); ")
+ (example "
+void endData( void *userData ); ")))
+
+(define-gl-procedure
+ gluNurbsCurve
+ "gluNurbsCurve"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "gluNurbsCurve"))
+ (paramdef "GLUnurbs* " (parameter "nurb"))
+ (paramdef "GLint " (parameter "knotCount"))
+ (paramdef "GLfloat * " (parameter "knots"))
+ (paramdef "GLint " (parameter "stride"))
+ (paramdef "GLfloat * " (parameter "control"))
+ (paramdef "GLint " (parameter "order"))
+ (paramdef "GLenum " (parameter "type"))))
+ '(*fragment*
+ (heading "define the shape of a NURBS curve")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "nurb")))
+ (para "
+Specifies the NURBS object (created with "
+ (code "gluNewNurbsRenderer")
+ "). "))
+ (entry (% (heading (var "knotCount")))
+ (para "
+Specifies the number of knots in "
+ (var "knots")
+ ". "
+ (var "knotCount")
+ " equals the number of control points plus the order. "))
+ (entry (% (heading (var "knots")))
+ (para "
+Specifies an array of "
+ (var "knotCount")
+ " nondecreasing knot values. "))
+ (entry (% (heading (var "stride")))
+ (para "
+Specifies the offset (as a number of single-precision floating-point values)
+ between successive curve control points. "))
+ (entry (% (heading (var "control")))
+ (para "
+Specifies a pointer to an array of control points. The coordinates must
+ agree with "
+ (var "type")
+ ", specified below. "))
+ (entry (% (heading (var "order")))
+ (para "
+Specifies the order of the NURBS curve. "
+ (var "order")
+ " equals degree + 1, hence
+ a cubic curve has an order of 4. "))
+ (entry (% (heading (var "type")))
+ (para "
+Specifies the type of the curve. If this curve is defined within a "
+ (code "gluBeginCurve")
+ "/"
+ (code "gluEndCurve")
+ " pair, then
+ the type can be any of the valid
+ one-dimensional evaluator types (such as "
+ (code "GLU_MAP1_VERTEX_3")
+ " or "
+ (code "GLU_MAP1_COLOR_4")
+ "). Between a "
+ (code "gluBeginTrim")
+ "/"
+ (code "gluEndTrim")
+ " pair,
+ the only valid types are "
+ (code "GLU_MAP1_TRIM_2")
+ " and "
+ (code "GLU_MAP1_TRIM_3")
+ ". ")))
+ (heading "Description")
+ (para "
+Use "
+ (code "gluNurbsCurve")
+ " to describe a NURBS curve. ")
+ (para "
+When "
+ (code "gluNurbsCurve")
+ " appears between a "
+ (code "gluBeginCurve")
+ "/"
+ (code "gluEndCurve")
+ " pair, it is
+ used to describe a curve to be rendered.
+ Positional, texture, and color coordinates are associated
+ by presenting each as a separate "
+ (code "gluNurbsCurve")
+ " between a "
+ (code "gluBeginCurve")
+ "/"
+ (code "gluEndCurve")
+ " pair. No more than
+ one call to "
+ (code "gluNurbsCurve")
+ " for each of color, position, and texture
+ data can be made within a single "
+ (code "gluBeginCurve")
+ "/"
+ (code "gluEndCurve")
+ "
+pair. Exactly one call must be made to describe the position of the
+ curve (a "
+ (var "type")
+ " of "
+ (code "GLU_MAP1_VERTEX_3")
+ " or "
+ (code "GLU_MAP1_VERTEX_4")
+ "). ")
+ (para "
+When "
+ (code "gluNurbsCurve")
+ " appears between a "
+ (code "gluBeginTrim")
+ "/"
+ (code "gluEndTrim")
+ " pair, it is
+ used to describe a trimming curve on a NURBS surface. If "
+ (var "type")
+ " is "
+ (code "GLU_MAP1_TRIM_2")
+ ", then it describes a curve in two-dimensional ("
+ (var "u")
+ " and "
+ (var "v")
+ ")
+ parameter space. If it is "
+ (code "GLU_MAP1_TRIM_3")
+ ", then it describes a
+ curve in two-dimensional homogeneous ("
+ (var "u")
+ ", "
+ (var "v")
+ ", and "
+ (var "w")
+ ")
+ parameter space.
+ See the "
+ (code "gluBeginTrim")
+ " reference page for more discussion about trimming
+ curves. ")))
+
+(define-gl-procedure
+ gluNurbsProperty
+ "gluNurbsProperty"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "gluNurbsProperty"))
+ (paramdef "GLUnurbs* " (parameter "nurb"))
+ (paramdef "GLenum " (parameter "property"))
+ (paramdef "GLfloat " (parameter "value"))))
+ '(*fragment*
+ (heading "set a NURBS property")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "nurb")))
+ (para "
+Specifies the NURBS object (created with "
+ (code "gluNewNurbsRenderer")
+ "). "))
+ (entry (% (heading (var "property")))
+ (para "
+Specifies the property to be set. Valid values are "
+ (code "GLU_SAMPLING_TOLERANCE")
+ ", "
+ (code "GLU_DISPLAY_MODE")
+ ", "
+ (code "GLU_CULLING")
+ ", "
+ (code "GLU_AUTO_LOAD_MATRIX")
+ ", "
+ (code "GLU_PARAMETRIC_TOLERANCE")
+ ", "
+ (code "GLU_SAMPLING_METHOD")
+ ", "
+ (code "GLU_U_STEP")
+ ", "
+ (code "GLU_V_STEP")
+ ", or "
+ (code "GLU_NURBS_MODE")
+ ". "))
+ (entry (% (heading (var "value")))
+ (para "
+Specifies the value of the indicated property.
+ It may be a numeric value or one of "
+ (code "GLU_OUTLINE_POLYGON")
+ ", "
+ (code "GLU_FILL")
+ ", "
+ (code "GLU_OUTLINE_PATCH")
+ ", "
+ (code "GLU_TRUE")
+ ", "
+ (code "GLU_FALSE")
+ ", "
+ (code "GLU_PATH_LENGTH")
+ ", "
+ (code "GLU_PARAMETRIC_ERROR")
+ ", "
+ (code "GLU_DOMAIN_DISTANCE")
+ ", "
+ (code "GLU_NURBS_RENDERER")
+ ", or "
+ (code "GLU_NURBS_TESSELLATOR")
+ ". ")))
+ (heading "Description")
+ (para (code "gluNurbsProperty")
+ " is used to control properties stored in a NURBS object. These
+ properties affect the way that a NURBS curve is rendered. The accepted
+ values for "
+ (var "property")
+ " are as follows: ")
+ (table (% (formatter (asis)))
+ (entry (% (heading (code "GLU_NURBS_MODE")))
+ (para (var "value")
+ " should be set to be either "
+ (code "GLU_NURBS_RENDERER")
+ " or "
+ (code "GLU_NURBS_TESSELLATOR")
+ ". When set to "
+ (code "GLU_NURBS_RENDERER")
+ ", NURBS objects
+ are tessellated into OpenGL primitives and sent to the pipeline for
+ rendering. When set to "
+ (code "GLU_NURBS_TESSELLATOR")
+ ", NURBS objects are
+ tessellated into OpenGL primitives but the vertices, normals, colors, and/or textures are
+ retrieved back through a callback interface (see "
+ (code "gluNurbsCallback")
+ "). This allows the user to cache the
+ tessellated results for further processing.
+ The initial value is "
+ (code "GLU_NURBS_RENDERER")
+ ". "))
+ (entry (% (heading (code "GLU_SAMPLING_METHOD")))
+ (para "
+Specifies how a NURBS surface should be
+ tessellated. "
+ (var "value")
+ " may be one of "
+ (code "GLU_PATH_LENGTH")
+ ", "
+ (code "GLU_PARAMETRIC_ERROR")
+ ", "
+ (code "GLU_DOMAIN_DISTANCE")
+ ", "
+ (code "GLU_OBJECT_PATH_LENGTH")
+ ", or "
+ (code "GLU_OBJECT_PARAMETRIC_ERROR")
+ ".
+ When set to "
+ (code "GLU_PATH_LENGTH")
+ ", the surface is rendered so that
+ the maximum length, in
+ pixels, of the edges of the tessellation polygons is no greater than
+ what is specified by "
+ (code "GLU_SAMPLING_TOLERANCE")
+ ". ")
+ (para (code "GLU_PARAMETRIC_ERROR")
+ " specifies that the surface is rendered in such a
+ way that the value specified by "
+ (code "GLU_PARAMETRIC_TOLERANCE")
+ " describes the
+ maximum distance, in pixels, between the tessellation polygons and the
+ surfaces they approximate. ")
+ (para (code "GLU_DOMAIN_DISTANCE")
+ " allows users to specify, in parametric coordinates,
+ how many sample points per unit length are taken in "
+ (var "u")
+ ", "
+ (var "v")
+ "
+direction. ")
+ (para (code "GLU_OBJECT_PATH_LENGTH")
+ " is similar to "
+ (code "GLU_PATH_LENGTH")
+ "
+except that it is view independent; that is, the surface is rendered so that the maximum length, in object space, of edges of the tessellation polygons is no greater than what is specified by "
+ (code "GLU_SAMPLING_TOLERANCE")
+ ". ")
+ (para (code "GLU_OBJECT_PARAMETRIC_ERROR")
+ " is similar to "
+ (code "GLU_PARAMETRIC_ERROR")
+ " except that it is view independent; that is, the surface is rendered in such a way that the value specified by "
+ (code "GLU_PARAMETRIC_TOLERANCE")
+ " describes the maximum distance, in object space, between the tessellation polygons and the surfaces they approximate. ")
+ (para "
+The initial value of "
+ (code "GLU_SAMPLING_METHOD")
+ " is "
+ (code "GLU_PATH_LENGTH")
+ ". "))
+ (entry (% (heading (code "GLU_SAMPLING_TOLERANCE")))
+ (para "
+Specifies the maximum length, in pixels or in object space length unit,
+ to use when the sampling method is set to "
+ (code "GLU_PATH_LENGTH")
+ " or "
+ (code "GLU_OBJECT_PATH_LENGTH")
+ ".
+ The NURBS code is conservative when rendering a curve
+ or surface, so the actual length can be somewhat shorter. The initial
+ value is 50.0 pixels. "))
+ (entry (% (heading (code "GLU_PARAMETRIC_TOLERANCE")))
+ (para "
+Specifies the maximum distance, in pixels or in object space length unit,
+ to use when the sampling method is "
+ (code "GLU_PARAMETRIC_ERROR")
+ " or "
+ (code "GLU_OBJECT_PARAMETRIC_ERROR")
+ ".
+ The initial value is 0.5. "))
+ (entry (% (heading (code "GLU_U_STEP")))
+ (para "
+Specifies the number of sample points per unit length taken
+ along the "
+ (var "u")
+ " axis in parametric coordinates. It is needed when "
+ (code "GLU_SAMPLING_METHOD")
+ " is set to "
+ (code "GLU_DOMAIN_DISTANCE")
+ ".
+ The initial value is 100. "))
+ (entry (% (heading (code "GLU_V_STEP")))
+ (para "
+Specifies the number of sample points per unit length taken
+ along the "
+ (var "v")
+ " axis in parametric coordinate. It is needed when "
+ (code "GLU_SAMPLING_METHOD")
+ " is set to "
+ (code "GLU_DOMAIN_DISTANCE")
+ ". The initial
+ value is 100. "))
+ (entry (% (heading (code "GLU_DISPLAY_MODE")))
+ (para (var "value")
+ " can be set to "
+ (code "GLU_OUTLINE_POLYGON")
+ ", "
+ (code "GLU_FILL")
+ ", or "
+ (code "GLU_OUTLINE_PATCH")
+ ".
+ When "
+ (code "GLU_NURBS_MODE")
+ " is set to be "
+ (code "GLU_NURBS_RENDERER")
+ ", "
+ (var "value")
+ " defines how a NURBS surface should be rendered.
+ When "
+ (var "value")
+ " is set to "
+ (code "GLU_FILL")
+ ", the surface is rendered as a
+ set of polygons. When "
+ (var "value")
+ " is set to "
+ (code "GLU_OUTLINE_POLYGON")
+ ", the NURBS library draws only the outlines
+ of the polygons created by tessellation. When "
+ (var "value")
+ " is set to "
+ (code "GLU_OUTLINE_PATCH")
+ " just the outlines of patches and trim
+ curves defined by the user are drawn. ")
+ (para "
+When "
+ (code "GLU_NURBS_MODE")
+ " is set to be "
+ (code "GLU_NURBS_TESSELLATOR")
+ ", "
+ (var "value")
+ " defines how a NURBS surface should be tessellated.
+ When "
+ (code "GLU_DISPLAY_MODE")
+ " is set to "
+ (code "GLU_FILL")
+ " or "
+ (code "GLU_OUTLINE_POLYGON")
+ ",
+ the NURBS surface is tessellated into OpenGL triangle primitives that can be
+ retrieved back through callback functions. If "
+ (code "GLU_DISPLAY_MODE")
+ " is set to "
+ (code "GLU_OUTLINE_PATCH")
+ ", only the outlines of the patches and trim curves are generated as a sequence of line strips that can be retrieved back through callback functions. ")
+ (para "
+The initial value is "
+ (code "GLU_FILL")
+ ". "))
+ (entry (% (heading (code "GLU_CULLING")))
+ (para (var "value")
+ " is a boolean value that, when set to "
+ (code "GLU_TRUE")
+ ", indicates that
+ a NURBS curve should be discarded prior to tessellation if its control points
+ lie outside the current viewport. The initial value is "
+ (code "GLU_FALSE")
+ ". "))
+ (entry (% (heading (code "GLU_AUTO_LOAD_MATRIX")))
+ (para (var "value")
+ " is a boolean value. When set to "
+ (code "GLU_TRUE")
+ ", the NURBS code
+ downloads the projection matrix, the modelview matrix, and the
+ viewport from the GL server to compute sampling and
+ culling
+ matrices for each NURBS curve that is rendered. Sampling and culling matrices
+ are required to determine the tessellation of a NURBS surface into line segments
+ or polygons and to cull a NURBS surface if it lies outside the viewport. ")
+ (para "
+If this mode is set to "
+ (code "GLU_FALSE")
+ ", then the program needs
+ to provide a projection matrix, a modelview matrix, and a viewport
+ for the NURBS renderer to use to construct sampling and culling matrices.
+ This can be done with the "
+ (code "gluLoadSamplingMatrices")
+ " function.
+ This mode is initially set to "
+ (code "GLU_TRUE")
+ ".
+ Changing it from "
+ (code "GLU_TRUE")
+ " to "
+ (code "GLU_FALSE")
+ " does not affect
+ the sampling and culling matrices until "
+ (code "gluLoadSamplingMatrices")
+ "
+is called. ")))))
+
+(define-gl-procedure
+ gluNurbsSurface
+ "gluNurbsSurface"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "gluNurbsSurface"))
+ (paramdef "GLUnurbs* " (parameter "nurb"))
+ (paramdef "GLint " (parameter "sKnotCount"))
+ (paramdef "GLfloat* " (parameter "sKnots"))
+ (paramdef "GLint " (parameter "tKnotCount"))
+ (paramdef "GLfloat* " (parameter "tKnots"))
+ (paramdef "GLint " (parameter "sStride"))
+ (paramdef "GLint " (parameter "tStride"))
+ (paramdef "GLfloat* " (parameter "control"))
+ (paramdef "GLint " (parameter "sOrder"))
+ (paramdef "GLint " (parameter "tOrder"))
+ (paramdef "GLenum " (parameter "type"))))
+ '(*fragment*
+ (heading "define the shape of a NURBS surface")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "nurb")))
+ (para "
+Specifies the NURBS object (created with "
+ (code "gluNewNurbsRenderer")
+ "). "))
+ (entry (% (heading (var "sKnotCount")))
+ (para "
+Specifies the number of knots in the parametric "
+ (var "u")
+ " direction. "))
+ (entry (% (heading (var "sKnots")))
+ (para "
+Specifies an array of "
+ (var "sKnotCount")
+ " nondecreasing knot values in the parametric "
+ (var "u")
+ " direction. "))
+ (entry (% (heading (var "tKnotCount")))
+ (para "
+Specifies the number of knots in the parametric "
+ (var "v")
+ " direction. "))
+ (entry (% (heading (var "tKnots")))
+ (para "
+Specifies an array of "
+ (var "tKnotCount")
+ " nondecreasing knot values in the parametric "
+ (var "v")
+ " direction. "))
+ (entry (% (heading (var "sStride")))
+ (para "
+Specifies the offset (as a number of single-precision floating-point values)
+ between successive control points in the parametric "
+ (var "u")
+ " direction
+ in "
+ (var "control")
+ ". "))
+ (entry (% (heading (var "tStride")))
+ (para "
+Specifies the offset (in single-precision floating-point values)
+ between successive control points in the parametric "
+ (var "v")
+ " direction
+ in "
+ (var "control")
+ ". "))
+ (entry (% (heading (var "control")))
+ (para "
+Specifies an array containing control points for the NURBS surface.
+ The offsets between successive control points in the parametric "
+ (var "u")
+ "
+and "
+ (var "v")
+ " directions are given by "
+ (var "sStride")
+ " and "
+ (var "tStride")
+ ". "))
+ (entry (% (heading (var "sOrder")))
+ (para "
+Specifies the order of the NURBS surface in the parametric "
+ (var "u")
+ " direction. The order is one more than the degree, hence
+ a surface that is cubic in "
+ (var "u")
+ " has a "
+ (var "u")
+ " order of 4. "))
+ (entry (% (heading (var "tOrder")))
+ (para "
+Specifies the order of the NURBS surface in the parametric "
+ (var "v")
+ " direction. The order is one more than the degree, hence
+ a surface that is cubic in "
+ (var "v")
+ " has a "
+ (var "v")
+ " order of 4. "))
+ (entry (% (heading (var "type")))
+ (para "
+Specifies type of the surface. "
+ (var "type")
+ " can be any of the valid
+ two-dimensional evaluator types (such as "
+ (code "GLU_MAP2_VERTEX_3")
+ " or "
+ (code "GLU_MAP2_COLOR_4")
+ "). ")))
+ (heading "Description")
+ (para "
+Use "
+ (code "gluNurbsSurface")
+ " within a NURBS (Non-Uniform Rational B-Spline) surface
+ definition to describe the shape of a NURBS surface (before
+ any trimming). To mark the beginning of
+ a NURBS surface definition, use the "
+ (code "gluBeginSurface")
+ " command.
+ To mark the end of a NURBS surface definition, use the "
+ (code "gluEndSurface")
+ " command. Call "
+ (code "gluNurbsSurface")
+ " within a NURBS
+ surface definition only. ")
+ (para "
+Positional, texture, and color coordinates are associated
+ with a surface by presenting each as a separate "
+ (code "gluNurbsSurface")
+ " between a "
+ (code "gluBeginSurface")
+ "/"
+ (code "gluEndSurface")
+ " pair. No more than
+ one call to "
+ (code "gluNurbsSurface")
+ " for each of color, position, and texture
+ data can be made within a single "
+ (code "gluBeginSurface")
+ "/"
+ (code "gluEndSurface")
+ "
+pair. Exactly one call must be made to describe the position of the
+ surface (a "
+ (var "type")
+ " of "
+ (code "GLU_MAP2_VERTEX_3")
+ " or "
+ (code "GLU_MAP2_VERTEX_4")
+ "). ")
+ (para "
+A NURBS surface can be trimmed by using the commands "
+ (code "gluNurbsCurve")
+ " and "
+ (code "gluPwlCurve")
+ " between calls to "
+ (code "gluBeginTrim")
+ " and "
+ (code "gluEndTrim")
+ ". ")
+ (para "
+Note that a "
+ (code "gluNurbsSurface")
+ " with "
+ (var "sKnotCount")
+ " knots in the "
+ (var "u")
+ " direction
+ and "
+ (var "tKnotCount")
+ " knots in the "
+ (var "v")
+ " direction with orders "
+ (var "sOrder")
+ " and "
+ (var "tOrder")
+ " must have
+ ("
+ (var "sKnotCount")
+ " - "
+ (var "sOrder")
+ ") "
+ (math (var "times"))
+ "
+("
+ (var "tKnotCount")
+ " - "
+ (var "tOrder")
+ ") control points. ")))
+
+(define-gl-procedure
+ gluOrtho2D
+ "gluOrtho2D"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "gluOrtho2D"))
+ (paramdef "GLdouble " (parameter "left"))
+ (paramdef "GLdouble " (parameter "right"))
+ (paramdef "GLdouble " (parameter "bottom"))
+ (paramdef "GLdouble " (parameter "top"))))
+ '(*fragment*
+ (heading
+ "define a 2D orthographic projection matrix")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "left")))
+ (itemx (var "right"))
+ (para "
+Specify the coordinates for the left and right vertical clipping planes. "))
+ (entry (% (heading (var "bottom")))
+ (itemx (var "top"))
+ (para "
+Specify the coordinates for the bottom and top horizontal clipping planes. ")))
+ (heading "Description")
+ (para (code "gluOrtho2D")
+ " sets up a two-dimensional orthographic viewing region.
+ This is equivalent to calling "
+ (code "glOrtho")
+ " with "
+ (math (var "near") "=" "-1")
+ "
+and "
+ (math (var "far") "=" "1")
+ ". ")))
+
+(define-gl-procedure
+ gluPartialDisk
+ "gluPartialDisk"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "gluPartialDisk"))
+ (paramdef "GLUquadric* " (parameter "quad"))
+ (paramdef "GLdouble " (parameter "inner"))
+ (paramdef "GLdouble " (parameter "outer"))
+ (paramdef "GLint " (parameter "slices"))
+ (paramdef "GLint " (parameter "loops"))
+ (paramdef "GLdouble " (parameter "start"))
+ (paramdef "GLdouble " (parameter "sweep"))))
+ '(*fragment*
+ (heading "draw an arc of a disk")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "quad")))
+ (para "
+Specifies a quadrics object (created with "
+ (code "gluNewQuadric")
+ "). "))
+ (entry (% (heading (var "inner")))
+ (para "
+Specifies the inner radius of the partial disk (can be 0). "))
+ (entry (% (heading (var "outer")))
+ (para "
+Specifies the outer radius of the partial disk. "))
+ (entry (% (heading (var "slices")))
+ (para "
+Specifies the number of subdivisions around the "
+ (var "z")
+ " axis. "))
+ (entry (% (heading (var "loops")))
+ (para "
+Specifies the number of concentric rings about the origin into which
+ the partial disk is subdivided. "))
+ (entry (% (heading (var "start")))
+ (para "
+Specifies the starting angle, in degrees, of the disk portion. "))
+ (entry (% (heading (var "sweep")))
+ (para "
+Specifies the sweep angle, in degrees, of the disk portion. ")))
+ (heading "Description")
+ (para (code "gluPartialDisk")
+ " renders a partial disk on the "
+ (math (var "z") "=" "0")
+ "
+plane. A partial disk is
+ similar to a full disk, except that only the subset of the disk from "
+ (var "start")
+ " through "
+ (var "start")
+ " + "
+ (var "sweep")
+ " is included (where 0 degrees is along the
+ +\\f2y\\f axis,
+ 90 degrees along the +"
+ (var "x")
+ " axis, 180 degrees along the \\-"
+ (var "y")
+ " axis, and
+ 270 degrees along the \\-"
+ (var "x")
+ " axis). ")
+ (para "
+The partial disk has a radius of "
+ (var "outer")
+ " and contains a concentric circular hole with a radius
+ of "
+ (var "inner")
+ ". If "
+ (var "inner")
+ " is 0, then no hole is generated. The partial disk is
+ subdivided around the "
+ (var "z")
+ " axis into slices (like pizza slices) and also
+ about the "
+ (var "z")
+ " axis into rings
+ (as specified by "
+ (var "slices")
+ " and "
+ (var "loops")
+ ", respectively). ")
+ (para "
+With respect to orientation, the +"
+ (var "z")
+ " side of the partial disk is considered to
+ be outside (see "
+ (code "gluQuadricOrientation")
+ ").
+ This means that if the
+ orientation is set to "
+ (code "GLU_OUTSIDE")
+ ", then any normals generated
+ point along the +"
+ (var "z")
+ " axis. Otherwise, they point along the \\-"
+ (var "z")
+ " axis. ")
+ (para "
+If texturing is turned on (with "
+ (code "gluQuadricTexture")
+ "), texture
+ coordinates are generated
+ linearly such that where "
+ (math (var "r") "=" (var "outer"))
+ ",
+ the value at ("
+ (var "r")
+ ", 0, 0) is
+ (1.0, 0.5), at (0, "
+ (var "r")
+ ", 0) it is (0.5, 1.0), at (\\-"
+ (var "r")
+ ", 0, 0)
+ it is (0.0, 0.5), and
+ at (0, \\-"
+ (var "r")
+ ", 0) it is (0.5, 0.0). ")))
+
+(define-gl-procedure
+ gluPerspective
+ "gluPerspective"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "gluPerspective"))
+ (paramdef "GLdouble " (parameter "fovy"))
+ (paramdef "GLdouble " (parameter "aspect"))
+ (paramdef "GLdouble " (parameter "zNear"))
+ (paramdef "GLdouble " (parameter "zFar"))))
+ '(*fragment*
+ (heading
+ "set up a perspective projection matrix")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "fovy")))
+ (para "
+Specifies the field of view angle, in degrees, in the "
+ (var "y")
+ " direction. "))
+ (entry (% (heading (var "aspect")))
+ (para "
+Specifies the aspect ratio that determines
+ the field of view in the "
+ (var "x")
+ " direction.
+ The aspect ratio is the ratio of "
+ (var "x")
+ " (width) to "
+ (var "y")
+ " (height). "))
+ (entry (% (heading (var "zNear")))
+ (para "
+Specifies the distance from the viewer to the near clipping plane
+ (always positive). "))
+ (entry (% (heading (var "zFar")))
+ (para "
+Specifies the distance from the viewer to the far clipping plane
+ (always positive). ")))
+ (heading "Description")
+ (para (code "gluPerspective")
+ " specifies a viewing frustum into the world coordinate system.
+ In general, the aspect ratio in "
+ (code "gluPerspective")
+ " should match the aspect ratio
+ of the associated viewport. For example, "
+ (math (var "aspect") "=" "2.0")
+ "
+means
+ the viewer's
+ angle of view is twice as wide in "
+ (var "x")
+ " as it is in "
+ (var "y")
+ ".
+ If the viewport is
+ twice as wide as it is tall, it displays the image without distortion. ")
+ (para "
+The matrix generated by "
+ (code "gluPerspective")
+ " is multipled by the current matrix,
+ just as if "
+ (code "glMultMatrix")
+ " were called with the generated matrix.
+ To load the perspective matrix onto the current matrix stack instead,
+ precede the call to "
+ (code "gluPerspective")
+ " with a call to "
+ (code "glLoadIdentity")
+ ". ")
+ (para "
+Given "
+ (var "f")
+ " defined as follows: ")
+ (para (math (var "f")
+ "="
+ (var "cotangent")
+ "\u2061"
+ "("
+ (var "fovy")
+ "/"
+ "2"
+ ","
+ ")")
+ "
+The generated matrix is ")
+ (para (math "("
+ "("
+ (var "f")
+ "/"
+ (var "aspect")
+ " "
+ "0"
+ " "
+ "0"
+ " "
+ "0"
+ ")"
+ ", "
+ "("
+ "0"
+ " "
+ (var "f")
+ " "
+ "0"
+ " "
+ "0"
+ ")"
+ ", "
+ "("
+ "0"
+ " "
+ "0"
+ " "
+ (var "zFar")
+ "+"
+ (var "zNear")
+ ","
+ "/"
+ (var "zNear")
+ "-"
+ (var "zFar")
+ ","
+ " "
+ "2"
+ "×"
+ (var "zFar")
+ "×"
+ (var "zNear")
+ ","
+ "/"
+ (var "zNear")
+ "-"
+ (var "zFar")
+ ","
+ ")"
+ ", "
+ "("
+ "0"
+ " "
+ "0"
+ " "
+ "-1"
+ " "
+ "0"
+ ")"
+ ","
+ ")"))))
+
+(define-gl-procedure
+ gluPickMatrix
+ "gluPickMatrix"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "gluPickMatrix"))
+ (paramdef "GLdouble " (parameter "x"))
+ (paramdef "GLdouble " (parameter "y"))
+ (paramdef "GLdouble " (parameter "delX"))
+ (paramdef "GLdouble " (parameter "delY"))
+ (paramdef "GLint * " (parameter "viewport"))))
+ '(*fragment*
+ (heading "define a picking region")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "x")))
+ (itemx (var "y"))
+ (para "
+Specify the center of a picking region in window coordinates. "))
+ (entry (% (heading (var "delX")))
+ (itemx (var "delY"))
+ (para "
+Specify the width and height, respectively, of the picking region in window
+ coordinates. "))
+ (entry (% (heading (var "viewport")))
+ (para "
+Specifies the current viewport (as from a "
+ (code "glGetIntegerv")
+ " call). ")))
+ (heading "Description")
+ (para (code "gluPickMatrix")
+ " creates a projection matrix that can be used to restrict drawing
+ to a small region of the viewport.
+ This is typically useful to
+ determine what objects are being drawn near the cursor.
+ Use "
+ (code "gluPickMatrix")
+ " to
+ restrict drawing to a small region around the cursor.
+ Then,
+ enter selection mode (with "
+ (code "glRenderMode")
+ ") and rerender the scene.
+ All primitives that would have been drawn near
+ the cursor are identified and stored in the selection buffer. ")
+ (para "
+The matrix created by "
+ (code "gluPickMatrix")
+ " is multiplied by the current matrix just
+ as if "
+ (code "glMultMatrix")
+ " is called with the generated matrix.
+ To effectively use the generated pick matrix for picking,
+ first call "
+ (code "glLoadIdentity")
+ " to load an identity matrix onto the
+ perspective matrix stack.
+ Then call "
+ (code "gluPickMatrix")
+ ",
+ and, finally, call a command (such as "
+ (code "gluPerspective")
+ ")
+ to multiply the perspective matrix by the pick matrix. ")
+ (para "
+When using "
+ (code "gluPickMatrix")
+ " to pick NURBS, be careful to turn off the NURBS
+ property "
+ (code "GLU_AUTO_LOAD_MATRIX")
+ ". If "
+ (code "GLU_AUTO_LOAD_MATRIX")
+ " is not
+ turned off, then any NURBS surface rendered is subdivided differently with
+ the pick matrix than the way it was subdivided without the pick matrix. ")))
+
+(define-gl-procedure
+ gluProject
+ "gluProject"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "GLint " (function "gluProject"))
+ (paramdef "GLdouble " (parameter "objX"))
+ (paramdef "GLdouble " (parameter "objY"))
+ (paramdef "GLdouble " (parameter "objZ"))
+ (paramdef
+ "const GLdouble * "
+ (parameter "model"))
+ (paramdef "const GLdouble * " (parameter "proj"))
+ (paramdef "const GLint * " (parameter "view"))
+ (paramdef "GLdouble* " (parameter "winX"))
+ (paramdef "GLdouble* " (parameter "winY"))
+ (paramdef "GLdouble* " (parameter "winZ"))))
+ '(*fragment*
+ (heading
+ "map object coordinates to window coordinates")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "objX")))
+ (itemx (var "objY"))
+ (itemx (var "objZ"))
+ (para "
+Specify the object coordinates. "))
+ (entry (% (heading (var "model")))
+ (para "
+Specifies the current modelview matrix (as from a "
+ (code "glGetDoublev")
+ " call). "))
+ (entry (% (heading (var "proj")))
+ (para "
+Specifies the current projection matrix (as from a "
+ (code "glGetDoublev")
+ " call). "))
+ (entry (% (heading (var "view")))
+ (para "
+Specifies the current viewport (as from a "
+ (code "glGetIntegerv")
+ " call). "))
+ (entry (% (heading (var "winX")))
+ (itemx (var "winY"))
+ (itemx (var "winZ"))
+ (para "
+Return the computed window coordinates. ")))
+ (heading "Description")
+ (para (code "gluProject")
+ " transforms the specified object coordinates into window coordinates
+ using "
+ (var "model")
+ ", "
+ (var "proj")
+ ", and "
+ (var "view")
+ ". The result is stored
+ in "
+ (var "winX")
+ ", "
+ (var "winY")
+ ", and "
+ (var "winZ")
+ ". A return value of "
+ (code "GLU_TRUE")
+ " indicates success, a return value of "
+ (code "GLU_FALSE")
+ "
+indicates failure. ")
+ (para "
+To compute the coordinates,
+ let "
+ (math (var "v")
+ "="
+ "("
+ (var "objX")
+ ","
+ (var "objY")
+ (var "objZ")
+ "1.0"
+ ")")
+ "
+represented as a matrix with 4 rows and 1 column.
+ Then "
+ (code "gluProject")
+ " computes "
+ (math (var "v") "^" "″")
+ "
+as follows: ")
+ (para (math (var "v")
+ "^"
+ "″"
+ "="
+ (var "P")
+ "×"
+ (var "M")
+ "×"
+ (var "v")))
+ (para "
+where "
+ (math (var "P"))
+ "
+is the current projection matrix "
+ (var "proj")
+ " and "
+ (math (var "M"))
+ "
+is the current
+ modelview matrix "
+ (var "model")
+ " (both represented as "
+ (math "4" "×" "4")
+ "
+matrices in column-major order). ")
+ (para "
+The window coordinates are then computed as follows: ")
+ (para (math (var "winX")
+ "="
+ (var "view")
+ "\u2061"
+ "("
+ "0"
+ ","
+ ")"
+ "+"
+ (var "view")
+ "\u2061"
+ "("
+ "2"
+ ","
+ ")"
+ "×"
+ "("
+ (var "v")
+ "^"
+ "″"
+ "\u2061"
+ "("
+ "0"
+ ","
+ ")"
+ "+"
+ "1"
+ ","
+ ")"
+ "/"
+ "2")
+ (para (math (var "winY")
+ "="
+ (var "view")
+ "\u2061"
+ "("
+ "1"
+ ","
+ ")"
+ "+"
+ (var "view")
+ "\u2061"
+ "("
+ "3"
+ ","
+ ")"
+ "×"
+ "("
+ (var "v")
+ "^"
+ "″"
+ "\u2061"
+ "("
+ "1"
+ ","
+ ")"
+ "+"
+ "1"
+ ","
+ ")"
+ "/"
+ "2"))
+ (para (math (var "winZ")
+ "="
+ "("
+ (var "v")
+ "^"
+ "″"
+ "\u2061"
+ "("
+ "2"
+ ","
+ ")"
+ "+"
+ "1"
+ ","
+ ")"
+ "/"
+ "2")))
+ (para)))
+
+(define-gl-procedure
+ gluPwlCurve
+ "gluPwlCurve"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "gluPwlCurve"))
+ (paramdef "GLUnurbs* " (parameter "nurb"))
+ (paramdef "GLint " (parameter "count"))
+ (paramdef "GLfloat* " (parameter "data"))
+ (paramdef "GLint " (parameter "stride"))
+ (paramdef "GLenum " (parameter "type"))))
+ '(*fragment*
+ (heading
+ "describe a piecewise linear NURBS trimming curve")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "nurb")))
+ (para "
+Specifies the NURBS object (created with "
+ (code "gluNewNurbsRenderer")
+ "). "))
+ (entry (% (heading (var "count")))
+ (para "
+Specifies the number of points on the curve. "))
+ (entry (% (heading (var "data")))
+ (para "
+Specifies an array containing the curve points. "))
+ (entry (% (heading (var "stride")))
+ (para "
+Specifies the offset (a number of single-precision floating-point values)
+ between points on the curve. "))
+ (entry (% (heading (var "type")))
+ (para "
+Specifies the type of curve.
+ Must be either "
+ (code "GLU_MAP1_TRIM_2")
+ " or "
+ (code "GLU_MAP1_TRIM_3")
+ ". ")))
+ (heading "Description")
+ (para (code "gluPwlCurve")
+ " describes a piecewise linear trimming curve for a NURBS surface.
+ A piecewise linear curve consists of a list of
+ coordinates of points in the parameter space for the
+ NURBS surface to be trimmed. These points are connected
+ with line segments to form a curve. If the curve is
+ an approximation to a curve that is not piecewise linear,
+ the points should be close enough in parameter space that the
+ resulting path appears curved at the resolution used in the application. ")
+ (para "
+If "
+ (var "type")
+ " is "
+ (code "GLU_MAP1_TRIM_2")
+ ", then it describes a curve in two-dimensional ("
+ (var "u")
+ " and "
+ (var "v")
+ ") parameter space. If it is "
+ (code "GLU_MAP1_TRIM_3")
+ ", then it
+ describes a curve in two-dimensional homogeneous ("
+ (var "u")
+ ", "
+ (var "v")
+ ",
+ and "
+ (var "w")
+ ") parameter space.
+ See the "
+ (code "gluBeginTrim")
+ " reference page for more information
+ about trimming curves. ")))
+
+(define-gl-procedure
+ gluQuadricCallback
+ "gluQuadricCallback"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "gluQuadricCallback"))
+ (paramdef "GLUquadric* " (parameter "quad"))
+ (paramdef "GLenum " (parameter "which"))
+ (paramdef
+ "_GLUfuncptr "
+ (parameter "CallBackFunc"))))
+ '(*fragment*
+ (heading
+ "define a callback for a quadrics object")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "quad")))
+ (para "
+Specifies the quadrics object (created with "
+ (code "gluNewQuadric")
+ "). "))
+ (entry (% (heading (var "which")))
+ (para "
+Specifies the callback being defined.
+ The only valid value is "
+ (code "GLU_ERROR")
+ ". "))
+ (entry (% (heading (var "CallBackFunc")))
+ (para "
+Specifies the function to be called. ")))
+ (heading "Description")
+ (para (code "gluQuadricCallback")
+ " is used to define a new callback to be used by a quadrics object.
+ If the specified callback is already defined, then it is replaced. If "
+ (var "CallBackFunc")
+ " is NULL, then any existing callback is erased. ")
+ (para "
+The one legal callback is "
+ (code "GLU_ERROR")
+ ": ")
+ (table (% (formatter (asis)))
+ (entry (% (heading (code "GLU_ERROR")))
+ (para "
+The function is called when an error is encountered. Its single argument
+ is of type GLenum, and it indicates the specific error that occurred.
+ Character strings describing these errors can be retrieved with the "
+ (code "gluErrorString")
+ " call. ")))))
+
+(define-gl-procedure
+ gluQuadricDrawStyle
+ "gluQuadricDrawStyle"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "void "
+ (function "gluQuadricDrawStyle"))
+ (paramdef "GLUquadric* " (parameter "quad"))
+ (paramdef "GLenum " (parameter "draw"))))
+ '(*fragment*
+ (heading
+ "specify the draw style desired for quadrics")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "quad")))
+ (para "
+Specifies the quadrics object (created with "
+ (code "gluNewQuadric")
+ "). "))
+ (entry (% (heading (var "draw")))
+ (para "
+Specifies the desired draw style. Valid values are "
+ (code "GLU_FILL")
+ ", "
+ (code "GLU_LINE")
+ ", "
+ (code "GLU_SILHOUETTE")
+ ", and "
+ (code "GLU_POINT")
+ ". ")))
+ (heading "Description")
+ (para (code "gluQuadricDrawStyle")
+ " specifies the draw style for quadrics rendered with "
+ (var "quad")
+ ". The legal values are as follows: ")
+ (table (% (formatter (asis)))
+ (entry (% (heading (code "GLU_FILL")))
+ (para "
+Quadrics are rendered with polygon primitives. The polygons
+ are drawn in a counterclockwise fashion with respect to their
+ normals (as defined with "
+ (code "gluQuadricOrientation")
+ "). "))
+ (entry (% (heading (code "GLU_LINE")))
+ (para "
+Quadrics are rendered as a set of lines. "))
+ (entry (% (heading (code "GLU_SILHOUETTE")))
+ (para "
+Quadrics are rendered as a set of lines, except that edges separating
+ coplanar faces will not be drawn. "))
+ (entry (% (heading (code "GLU_POINT")))
+ (para "
+Quadrics are rendered as a set of points. ")))))
+
+(define-gl-procedure
+ gluQuadricNormals
+ "gluQuadricNormals"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "gluQuadricNormals"))
+ (paramdef "GLUquadric* " (parameter "quad"))
+ (paramdef "GLenum " (parameter "normal"))))
+ '(*fragment*
+ (heading
+ "specify what kind of normals are desired for quadrics")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "quad")))
+ (para "
+Specifies the quadrics object (created with "
+ (code "gluNewQuadric")
+ "). "))
+ (entry (% (heading (var "normal")))
+ (para "
+Specifies the desired type of normals. Valid values are "
+ (code "GLU_NONE")
+ ", "
+ (code "GLU_FLAT")
+ ", and "
+ (code "GLU_SMOOTH")
+ ". ")))
+ (heading "Description")
+ (para (code "gluQuadricNormals")
+ " specifies what kind of normals are desired for quadrics rendered with "
+ (var "quad")
+ ". The legal values are as follows: ")
+ (table (% (formatter (asis)))
+ (entry (% (heading (code "GLU_NONE")))
+ (para "
+No normals are generated. "))
+ (entry (% (heading (code "GLU_FLAT")))
+ (para "
+One normal is generated for every facet of a quadric. "))
+ (entry (% (heading (code "GLU_SMOOTH")))
+ (para "
+One normal is generated for every vertex of a quadric. This is the
+ initial value. ")))))
+
+(define-gl-procedure
+ gluQuadricOrientation
+ "gluQuadricOrientation"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "void "
+ (function "gluQuadricOrientation"))
+ (paramdef "GLUquadric* " (parameter "quad"))
+ (paramdef "GLenum " (parameter "orientation"))))
+ '(*fragment*
+ (heading
+ "specify inside/outside orientation for quadrics")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "quad")))
+ (para "
+Specifies the quadrics object (created with "
+ (code "gluNewQuadric")
+ "). "))
+ (entry (% (heading (var "orientation")))
+ (para "
+Specifies the desired orientation. Valid values are "
+ (code "GLU_OUTSIDE")
+ " and "
+ (code "GLU_INSIDE")
+ ". ")))
+ (heading "Description")
+ (para (code "gluQuadricOrientation")
+ " specifies what kind of orientation is desired for quadrics rendered
+ with "
+ (var "quad")
+ ". The "
+ (var "orientation")
+ " values are as follows: ")
+ (table (% (formatter (asis)))
+ (entry (% (heading (code "GLU_OUTSIDE")))
+ (para "
+Quadrics are drawn with normals pointing outward (the initial value). "))
+ (entry (% (heading (code "GLU_INSIDE")))
+ (para "
+Quadrics are drawn with normals pointing inward. ")))
+ (para "
+Note that the interpretation of "
+ (var "outward")
+ " and "
+ (var "inward")
+ " depends on the
+ quadric being drawn. ")))
+
+(define-gl-procedure
+ gluQuadricTexture
+ "gluQuadricTexture"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "gluQuadricTexture"))
+ (paramdef "GLUquadric* " (parameter "quad"))
+ (paramdef "GLboolean " (parameter "texture"))))
+ '(*fragment*
+ (heading
+ "specify if texturing is desired for quadrics")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "quad")))
+ (para "
+Specifies the quadrics object (created with "
+ (code "gluNewQuadric")
+ "). "))
+ (entry (% (heading (var "texture")))
+ (para "
+Specifies a flag indicating if texture coordinates should be generated. ")))
+ (heading "Description")
+ (para (code "gluQuadricTexture")
+ " specifies if texture coordinates should be generated
+ for quadrics rendered with "
+ (var "quad")
+ ".
+ If the value of "
+ (var "texture")
+ " is "
+ (code "GLU_TRUE")
+ ", then texture coordinates
+ are generated, and if "
+ (var "texture")
+ " is "
+ (code "GLU_FALSE")
+ ", they are not. The
+ initial value is "
+ (code "GLU_FALSE")
+ ". ")
+ (para "
+The manner in which texture coordinates are generated depends
+ upon the specific quadric rendered. ")))
+
+(define-gl-procedure
+ gluScaleImage
+ "gluScaleImage"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "GLint " (function "gluScaleImage"))
+ (paramdef "GLenum " (parameter "format"))
+ (paramdef "GLsizei " (parameter "wIn"))
+ (paramdef "GLsizei " (parameter "hIn"))
+ (paramdef "GLenum " (parameter "typeIn"))
+ (paramdef "const void * " (parameter "dataIn"))
+ (paramdef "GLsizei " (parameter "wOut"))
+ (paramdef "GLsizei " (parameter "hOut"))
+ (paramdef "GLenum " (parameter "typeOut"))
+ (paramdef "GLvoid* " (parameter "dataOut"))))
+ '(*fragment*
+ (heading "scale an image to an arbitrary size")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "format")))
+ (para "
+Specifies the format of the pixel data.
+ The following symbolic values are valid: "
+ (code "GLU_COLOR_INDEX")
+ ", "
+ (code "GLU_STENCIL_INDEX")
+ ", "
+ (code "GLU_DEPTH_COMPONENT")
+ ", "
+ (code "GLU_RED")
+ ", "
+ (code "GLU_GREEN")
+ ", "
+ (code "GLU_BLUE")
+ ", "
+ (code "GLU_ALPHA")
+ ", "
+ (code "GLU_RGB")
+ ", "
+ (code "GLU_RGBA")
+ ", "
+ (code "GLU_BGR")
+ ", "
+ (code "GLU_BGRA")
+ ", "
+ (code "GLU_LUMINANCE")
+ ", and "
+ (code "GLU_LUMINANCE_ALPHA")
+ ". "))
+ (entry (% (heading (var "wIn")))
+ (itemx (var "hIn"))
+ (para "
+Specify in pixels the width and height, respectively, of the source image. "))
+ (entry (% (heading (var "typeIn")))
+ (para "
+Specifies the data type for "
+ (var "dataIn")
+ ". Must be one of "
+ (code "GLU_UNSIGNED_BYTE")
+ ", "
+ (code "GLU_BYTE")
+ ", "
+ (code "GLU_BITMAP")
+ ", "
+ (code "GLU_UNSIGNED_SHORT")
+ ", "
+ (code "GLU_SHORT")
+ ", "
+ (code "GLU_UNSIGNED_INT")
+ ", "
+ (code "GLU_INT")
+ ", "
+ (code "GLU_FLOAT")
+ ", "
+ (code "GLU_UNSIGNED_BYTE_3_3_2")
+ ", "
+ (code "GLU_UNSIGNED_BYTE_2_3_3_REV")
+ ", "
+ (code "GLU_UNSIGNED_SHORT_5_6_5")
+ ", "
+ (code "GLU_UNSIGNED_SHORT_5_6_5_REV")
+ ", "
+ (code "GLU_UNSIGNED_SHORT_4_4_4_4")
+ ", "
+ (code "GLU_UNSIGNED_SHORT_4_4_4_4_REV")
+ ", "
+ (code "GLU_UNSIGNED_SHORT_5_5_5_1")
+ ", "
+ (code "GLU_UNSIGNED_SHORT_1_5_5_5_REV")
+ ", "
+ (code "GLU_UNSIGNED_INT_8_8_8_8")
+ ", "
+ (code "GLU_UNSIGNED_INT_8_8_8_8_REV")
+ ", "
+ (code "GLU_UNSIGNED_INT_10_10_10_2")
+ ", or "
+ (code "GLU_UNSIGNED_INT_2_10_10_10_REV")
+ ". "))
+ (entry (% (heading (var "dataIn")))
+ (para "
+Specifies a pointer to the source image. "))
+ (entry (% (heading (var "wOut")))
+ (itemx (var "hOut"))
+ (para "
+Specify the width and height, respectively, in pixels of the destination image. "))
+ (entry (% (heading (var "typeOut")))
+ (para "
+Specifies the data type for "
+ (var "dataOut")
+ ". Must be one of "
+ (code "GLU_UNSIGNED_BYTE")
+ ", "
+ (code "GLU_BYTE")
+ ", "
+ (code "GLU_BITMAP")
+ ", "
+ (code "GLU_UNSIGNED_SHORT")
+ ", "
+ (code "GLU_SHORT")
+ ", "
+ (code "GLU_UNSIGNED_INT")
+ ", "
+ (code "GLU_INT")
+ ", "
+ (code "GLU_FLOAT")
+ ", "
+ (code "GLU_UNSIGNED_BYTE_3_3_2")
+ ", "
+ (code "GLU_UNSIGNED_BYTE_2_3_3_REV")
+ ", "
+ (code "GLU_UNSIGNED_SHORT_5_6_5")
+ ", "
+ (code "GLU_UNSIGNED_SHORT_5_6_5_REV")
+ ", "
+ (code "GLU_UNSIGNED_SHORT_4_4_4_4")
+ ", "
+ (code "GLU_UNSIGNED_SHORT_4_4_4_4_REV")
+ ", "
+ (code "GLU_UNSIGNED_SHORT_5_5_5_1")
+ ", "
+ (code "GLU_UNSIGNED_SHORT_1_5_5_5_REV")
+ ", "
+ (code "GLU_UNSIGNED_INT_8_8_8_8")
+ ", "
+ (code "GLU_UNSIGNED_INT_8_8_8_8_REV")
+ ", "
+ (code "GLU_UNSIGNED_INT_10_10_10_2")
+ ", or "
+ (code "GLU_UNSIGNED_INT_2_10_10_10_REV")
+ ". "))
+ (entry (% (heading (var "dataOut")))
+ (para "
+Specifies a pointer to the destination image. ")))
+ (heading "Description")
+ (para (code "gluScaleImage")
+ " scales a pixel image using the appropriate pixel store modes to
+ unpack data from the source image and pack data into the destination image. ")
+ (para "
+When shrinking an image, "
+ (code "gluScaleImage")
+ " uses a box filter to sample the source image
+ and create pixels for the destination image. When magnifying an image,
+ the pixels from the source image are linearly interpolated to create the
+ destination image. ")
+ (para "
+A return value of zero indicates success, otherwise a GLU error code is returned (see "
+ (code "gluErrorString")
+ "). ")
+ (para "
+See the "
+ (code "glReadPixels")
+ " reference page for a description of
+ the acceptable values for the "
+ (var "format")
+ ", "
+ (var "typeIn")
+ ", and "
+ (var "typeOut")
+ " parameters. ")
+ (heading "Errors")
+ (para (code "GLU_INVALID_VALUE")
+ " is returned if "
+ (var "wIn")
+ ", "
+ (var "hIn")
+ ", "
+ (var "wOut")
+ ", or "
+ (var "hOut")
+ "
+is negative. ")
+ (para (code "GLU_INVALID_ENUM")
+ " is returned if "
+ (var "format")
+ ", "
+ (var "typeIn")
+ ", or "
+ (var "typeOut")
+ " is not
+ legal. ")
+ (para (code "GLU_INVALID_OPERATION")
+ " is returned if "
+ (var "typeIn")
+ " or "
+ (var "typeOut")
+ " is "
+ (code "GLU_UNSIGNED_BYTE_3_3_2")
+ " or "
+ (code "GLU_UNSIGNED_BYTE_2_3_3_REV")
+ " and "
+ (var "format")
+ " is not "
+ (code "GLU_RGB")
+ ". ")
+ (para (code "GLU_INVALID_OPERATION")
+ " is returned if "
+ (var "typeIn")
+ " or "
+ (var "typeOut")
+ " is "
+ (code "GLU_UNSIGNED_SHORT_5_6_5")
+ " or "
+ (code "GLU_UNSIGNED_SHORT_5_6_5_REV")
+ " and "
+ (var "format")
+ " is not "
+ (code "GLU_RGB")
+ ". ")
+ (para (code "GLU_INVALID_OPERATION")
+ " is returned if "
+ (var "typeIn")
+ " or "
+ (var "typeOut")
+ " is "
+ (code "GLU_UNSIGNED_SHORT_4_4_4_4")
+ " or "
+ (code "GLU_UNSIGNED_SHORT_4_4_4_4_REV")
+ " and "
+ (var "format")
+ " is neither "
+ (code "GLU_RGBA")
+ " nor "
+ (code "GLU_BGRA")
+ ". ")
+ (para (code "GLU_INVALID_OPERATION")
+ " is returned if "
+ (var "typeIn")
+ " or "
+ (var "typeOut")
+ " is "
+ (code "GLU_UNSIGNED_SHORT_5_5_5_1")
+ " or "
+ (code "GLU_UNSIGNED_SHORT_1_5_5_5_REV")
+ "
+and "
+ (var "format")
+ " is neither "
+ (code "GLU_RGBA")
+ " nor "
+ (code "GLU_BGRA")
+ ". ")
+ (para (code "GLU_INVALID_OPERATION")
+ " is returned if "
+ (var "typeIn")
+ " or "
+ (var "typeOut")
+ " is "
+ (code "GLU_UNSIGNED_INT_8_8_8_8")
+ " or "
+ (code "GLU_UNSIGNED_INT_8_8_8_8_REV")
+ " and "
+ (var "format")
+ " is neither "
+ (code "GLU_RGBA")
+ " nor "
+ (code "GLU_BGRA")
+ ". ")
+ (para (code "GLU_INVALID_OPERATION")
+ " is returned if "
+ (var "typeIn")
+ " or "
+ (var "typeOut")
+ " is "
+ (code "GLU_UNSIGNED_INT_10_10_10_2")
+ " or "
+ (code "GLU_UNSIGNED_INT_2_10_10_10_REV")
+ "
+and "
+ (var "format")
+ " is neither "
+ (code "GLU_RGBA")
+ " nor "
+ (code "GLU_BGRA")
+ ". ")))
+
+(define-gl-procedure
+ gluSphere
+ "gluSphere"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "gluSphere"))
+ (paramdef "GLUquadric* " (parameter "quad"))
+ (paramdef "GLdouble " (parameter "radius"))
+ (paramdef "GLint " (parameter "slices"))
+ (paramdef "GLint " (parameter "stacks"))))
+ '(*fragment*
+ (heading "draw a sphere")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "quad")))
+ (para "
+Specifies the quadrics object (created with "
+ (code "gluNewQuadric")
+ "). "))
+ (entry (% (heading (var "radius")))
+ (para "
+Specifies the radius of the sphere. "))
+ (entry (% (heading (var "slices")))
+ (para "
+Specifies the number of subdivisions around the "
+ (var "z")
+ " axis
+ (similar to lines of longitude). "))
+ (entry (% (heading (var "stacks")))
+ (para "
+Specifies the number of subdivisions along the "
+ (var "z")
+ " axis
+ (similar to lines of
+ latitude). ")))
+ (heading "Description")
+ (para (code "gluSphere")
+ " draws a sphere of the given radius centered around the origin. The
+ sphere is subdivided around the "
+ (var "z")
+ " axis into slices and along the "
+ (var "z")
+ " axis
+ into stacks (similar to lines of longitude and latitude). ")
+ (para "
+If the orientation is set to "
+ (code "GLU_OUTSIDE")
+ " (with "
+ (code "gluQuadricOrientation")
+ "), then any normals generated
+ point away from the center of the sphere.
+ Otherwise, they point toward the center of the sphere. ")
+ (para "
+If texturing is turned on (with "
+ (code "gluQuadricTexture")
+ "), then texture
+ coordinates are
+ generated so that "
+ (var "t")
+ " ranges from 0.0 at "
+ (math (var "z") "=" "-" (var "radius"))
+ "
+to 1.0 at "
+ (math (var "z") "=" (var "radius"))
+ "
+("
+ (var "t")
+ " increases linearly along longitudinal
+ lines),
+ and "
+ (var "s")
+ " ranges from 0.0 at the +"
+ (var "y")
+ " axis, to 0.25 at the
+ +"
+ (var "x")
+ " axis,
+ to 0.5 at the \\-"
+ (var "y")
+ " axis, to 0.75 at the \\-"
+ (var "x")
+ " axis, and back to 1.0
+ at the +"
+ (var "y")
+ " axis. ")))
+
+(define-gl-procedure
+ gluTessBeginContour
+ "gluTessBeginContour"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "void "
+ (function "gluTessBeginContour"))
+ (paramdef "GLUtesselator* " (parameter "tess"))))
+ '(*fragment*
+ (heading "delimit a contour description")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "tess")))
+ (para "
+Specifies the tessellation object (created with "
+ (code "gluNewTess")
+ "). ")))
+ (heading "Description")
+ (para (code "gluTessBeginContour")
+ " and "
+ (code "gluTessEndContour")
+ " delimit the definition of a
+ polygon contour. Within each "
+ (code "gluTessBeginContour")
+ "/"
+ (code "gluTessEndContour")
+ "
+pair, there can be zero or more calls to "
+ (code "gluTessVertex")
+ ". The vertices
+ specify a closed contour (the last vertex of each contour is automatically linked
+ to the first). See the "
+ (code "gluTessVertex")
+ " reference page for more details. "
+ (code "gluTessBeginContour")
+ " can only be called between "
+ (code "gluTessBeginPolygon")
+ " and "
+ (code "gluTessEndPolygon")
+ ". ")))
+
+(define-gl-procedure
+ gluTessBeginPolygon
+ "gluTessBeginPolygon"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "void "
+ (function "gluTessBeginPolygon"))
+ (paramdef "GLUtesselator* " (parameter "tess"))
+ (paramdef "GLvoid* " (parameter "data"))))
+ '(*fragment*
+ (heading "delimit a polygon description")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "tess")))
+ (para "
+Specifies the tessellation object (created with "
+ (code "gluNewTess")
+ "). "))
+ (entry (% (heading (var "data")))
+ (para "
+Specifies a pointer to user polygon data. ")))
+ (heading "Description")
+ (para (code "gluTessBeginPolygon")
+ " and "
+ (code "gluTessEndPolygon")
+ " delimit the definition of a
+ convex, concave or self-intersecting polygon. Within each "
+ (code "gluTessBeginPolygon")
+ "/"
+ (code "gluTessEndPolygon")
+ "
+pair, there must be one or more calls to "
+ (code "gluTessBeginContour")
+ "/"
+ (code "gluTessEndContour")
+ ".
+ Within each contour, there are zero or more calls to "
+ (code "gluTessVertex")
+ ". The vertices
+ specify a closed contour (the last vertex of each contour is automatically linked
+ to the first). See the "
+ (code "gluTessVertex")
+ ", "
+ (code "gluTessBeginContour")
+ ", and "
+ (code "gluTessEndContour")
+ " reference pages for more details. ")
+ (para (var "data")
+ " is a pointer to a user-defined data structure. If the appropriate callback(s)
+ are specified (see "
+ (code "gluTessCallback")
+ "), then this pointer is returned to the
+ callback function(s). Thus, it is a convenient way to store per-polygon information. ")
+ (para "
+Once "
+ (code "gluTessEndPolygon")
+ " is called, the polygon is tessellated, and the
+ resulting triangles are described through callbacks.
+ See "
+ (code "gluTessCallback")
+ " for descriptions of the callback functions. ")))
+
+(define-gl-procedure
+ gluTessCallback
+ "gluTessCallback"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "gluTessCallback"))
+ (paramdef "GLUtesselator* " (parameter "tess"))
+ (paramdef "GLenum " (parameter "which"))
+ (paramdef
+ "_GLUfuncptr "
+ (parameter "CallBackFunc"))))
+ '(*fragment*
+ (heading
+ "define a callback for a tessellation object")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "tess")))
+ (para "
+Specifies the tessellation object (created with "
+ (code "gluNewTess")
+ "). "))
+ (entry (% (heading (var "which")))
+ (para "
+Specifies the callback being defined. The following values are valid: "
+ (code "GLU_TESS_BEGIN")
+ ", "
+ (code "GLU_TESS_BEGIN_DATA")
+ ", "
+ (code "GLU_TESS_EDGE_FLAG")
+ ", "
+ (code "GLU_TESS_EDGE_FLAG_DATA")
+ ", "
+ (code "GLU_TESS_VERTEX")
+ ", "
+ (code "GLU_TESS_VERTEX_DATA")
+ ", "
+ (code "GLU_TESS_END")
+ ", "
+ (code "GLU_TESS_END_DATA")
+ ", "
+ (code "GLU_TESS_COMBINE")
+ ", "
+ (code "GLU_TESS_COMBINE_DATA")
+ ", "
+ (code "GLU_TESS_ERROR")
+ ", and "
+ (code "GLU_TESS_ERROR_DATA")
+ ". "))
+ (entry (% (heading (var "CallBackFunc")))
+ (para "
+Specifies the function to be called. ")))
+ (heading "Description")
+ (para (code "gluTessCallback")
+ " is used to indicate a callback to be used by a tessellation object.
+ If the specified callback is already defined, then it is replaced. If "
+ (var "CallBackFunc")
+ " is NULL, then the existing callback becomes undefined. ")
+ (para "
+These callbacks are used by the tessellation object to describe how a
+ polygon specified by the user is broken into triangles. Note that there
+ are two versions of each callback: one with user-specified polygon data
+ and one without. If both versions of a particular callback are specified,
+ then the callback with user-specified polygon data will be used. Note
+ that the "
+ (var "polygon_data")
+ " parameter used by some of the functions is
+ a copy of the pointer that was specified when "
+ (code "gluTessBeginPolygon")
+ " was called. The legal callbacks are as follows: ")
+ (table (% (formatter (asis)))
+ (entry (% (heading (code "GLU_TESS_BEGIN")))
+ (para "
+The begin callback is invoked like "
+ (code "glBegin")
+ " to indicate the start of
+ a (triangle) primitive. The function takes a single argument of type
+ GLenum. If the "
+ (code "GLU_TESS_BOUNDARY_ONLY")
+ " property is set to "
+ (code "GLU_FALSE")
+ ", then the argument is set to either "
+ (code "GLU_TRIANGLE_FAN")
+ ", "
+ (code "GLU_TRIANGLE_STRIP")
+ ", or "
+ (code "GLU_TRIANGLES")
+ ".
+ If the "
+ (code "GLU_TESS_BOUNDARY_ONLY")
+ " property is set to "
+ (code "GLU_TRUE")
+ ",
+ then the argument will be set to "
+ (code "GLU_LINE_LOOP")
+ ". The function
+ prototype for this callback is: "))
+ (entry (% (heading (code "GLU_TESS_BEGIN_DATA")))
+ (para "
+The same as the "
+ (code "GLU_TESS_BEGIN")
+ " callback except that it
+ takes an additional pointer argument. This pointer is identical to the
+ opaque pointer provided when "
+ (code "gluTessBeginPolygon")
+ " was called. The function prototype for this callback
+ is: "))
+ (entry (% (heading (code "GLU_TESS_EDGE_FLAG")))
+ (para "
+The edge flag callback is similar to "
+ (code "glEdgeFlag")
+ ". The function
+ takes a single boolean flag that indicates which edges lie on the
+ polygon boundary. If the flag is "
+ (code "GLU_TRUE")
+ ", then each vertex
+ that follows begins an edge that lies on the polygon boundary, that is,
+ an edge that separates an interior region from an exterior one.
+ If the flag is "
+ (code "GLU_FALSE")
+ ", then each vertex that follows begins an edge
+ that lies in the polygon interior. The edge flag callback (if defined) is
+ invoked before the first vertex callback. ")
+ (para "
+Since triangle fans and triangle strips do not support edge flags, the begin
+ callback is not called with "
+ (code "GLU_TRIANGLE_FAN")
+ " or "
+ (code "GLU_TRIANGLE_STRIP")
+ "
+if a non-NULL edge flag callback is provided. (If the callback is
+ initialized to NULL, there is no impact on performance). Instead, the fans and
+ strips are converted to independent triangles. The function prototype
+ for this callback is: "))
+ (entry (% (heading (code "GLU_TESS_EDGE_FLAG_DATA")))
+ (para "
+The same as the "
+ (code "GLU_TESS_EDGE_FLAG")
+ " callback except that it takes an additional pointer
+ argument. This pointer is identical to the opaque pointer provided when "
+ (code "gluTessBeginPolygon")
+ " was called. The function prototype for this callback
+ is: "))
+ (entry (% (heading (code "GLU_TESS_VERTEX")))
+ (para "
+The vertex callback is invoked between the begin and end callbacks.
+ It is similar to "
+ (code "glVertex")
+ ", and it defines the vertices of the triangles
+ created by the tessellation process. The function
+ takes a pointer as its only argument. This pointer is identical to
+ the opaque pointer provided by the user when the vertex was described
+ (see "
+ (code "gluTessVertex")
+ "). The function prototype for this callback is: "))
+ (entry (% (heading (code "GLU_TESS_VERTEX_DATA")))
+ (para "
+The same as the "
+ (code "GLU_TESS_VERTEX")
+ " callback except that it takes an additional pointer
+ argument. This pointer is identical to the opaque pointer provided when "
+ (code "gluTessBeginPolygon")
+ " was called. The function prototype for this callback
+ is: "))
+ (entry (% (heading (code "GLU_TESS_END")))
+ (para "
+The end callback serves the same purpose as "
+ (code "glEnd")
+ ". It indicates the
+ end of a primitive and it takes no arguments. The function prototype for this
+ callback is: "))
+ (entry (% (heading (code "GLU_TESS_END_DATA")))
+ (para "
+The same as the "
+ (code "GLU_TESS_END")
+ " callback except that it takes an additional pointer
+ argument. This pointer is identical to the opaque pointer provided when "
+ (code "gluTessBeginPolygon")
+ " was called. The function prototype for this callback
+ is: "))
+ (entry (% (heading (code "GLU_TESS_COMBINE")))
+ (para "
+The combine callback is called to create a new vertex when the tessellation
+ detects an intersection or wishes to merge features. The function takes
+ four arguments: an array of three elements each of type GLdouble, an array
+ of four pointers, an array of four elements each of type GLfloat, and a
+ pointer to a pointer. The prototype is: ")
+ (para "
+The vertex is defined as a linear combination of up to four existing vertices,
+ stored in "
+ (var "vertex_data")
+ ". The coefficients of the linear
+ combination are given by "
+ (var "weight")
+ "; these weights always add up to 1.
+ All vertex pointers are valid even when some of the weights are 0. "
+ (var "coords")
+ " gives the location of the new vertex. ")
+ (para "
+The user must allocate another vertex, interpolate parameters using "
+ (var "vertex_data")
+ " and "
+ (var "weight")
+ ", and return the new vertex pointer in "
+ (var "outData")
+ ". This handle is supplied during rendering callbacks.
+ The user is responsible for freeing the memory some time after "
+ (code "gluTessEndPolygon")
+ " is called. ")
+ (para "
+For example, if the polygon lies in an arbitrary plane in 3-space,
+ and a color is associated with each vertex, the "
+ (code "GLU_TESS_COMBINE")
+ " callback might look like this: ")
+ (para "
+If the tessellation detects an intersection, then the "
+ (code "GLU_TESS_COMBINE")
+ " or "
+ (code "GLU_TESS_COMBINE_DATA")
+ " callback (see below) must be defined, and it must
+ write a non-NULL pointer into "
+ (var "dataOut")
+ ". Otherwise the "
+ (code "GLU_TESS_NEED_COMBINE_CALLBACK")
+ " error occurs, and no
+ output is generated. "))
+ (entry (% (heading (code "GLU_TESS_COMBINE_DATA")))
+ (para "
+The same as the "
+ (code "GLU_TESS_COMBINE")
+ " callback except that it takes an additional pointer
+ argument. This pointer is identical to the opaque pointer provided when "
+ (code "gluTessBeginPolygon")
+ " was called. The function prototype for this callback
+ is: "))
+ (entry (% (heading (code "GLU_TESS_ERROR")))
+ (para "
+The error callback is called when an error is encountered. The one argument
+ is of type GLenum; it indicates the specific error that occurred and will be
+ set to one of "
+ (code "GLU_TESS_MISSING_BEGIN_POLYGON")
+ ", "
+ (code "GLU_TESS_MISSING_END_POLYGON")
+ ", "
+ (code "GLU_TESS_MISSING_BEGIN_CONTOUR")
+ ", "
+ (code "GLU_TESS_MISSING_END_CONTOUR")
+ ", "
+ (code "GLU_TESS_COORD_TOO_LARGE")
+ ", "
+ (code "GLU_TESS_NEED_COMBINE_CALLBACK")
+ ", or "
+ (code "GLU_OUT_OF_MEMORY")
+ ". Character
+ strings describing these errors can be retrieved with the "
+ (code "gluErrorString")
+ " call. The function prototype for this callback is: ")
+ (para "
+The GLU library will recover from the first four
+ errors by inserting the missing call(s). "
+ (code "GLU_TESS_COORD_TOO_LARGE")
+ " indicates that some vertex coordinate exceeded
+ the predefined constant "
+ (code "GLU_TESS_MAX_COORD")
+ " in absolute value, and
+ that the value has been clamped. (Coordinate values must be small
+ enough so that two can be multiplied together without overflow.) "
+ (code "GLU_TESS_NEED_COMBINE_CALLBACK")
+ " indicates that the tessellation
+ detected an intersection between two edges in the input data, and the "
+ (code "GLU_TESS_COMBINE")
+ " or "
+ (code "GLU_TESS_COMBINE_DATA")
+ " callback was
+ not provided. No output is generated. "
+ (code "GLU_OUT_OF_MEMORY")
+ " indicates
+ that there is not enough memory so no output is generated. "))
+ (entry (% (heading (code "GLU_TESS_ERROR_DATA")))
+ (para "
+The same as the "
+ (code "GLU_TESS_ERROR")
+ " callback except that it takes an additional pointer
+ argument. This pointer is identical to the opaque pointer provided when "
+ (code "gluTessBeginPolygon")
+ " was called. The function prototype for this callback
+ is: ")))
+ (example "
+void begin( GLenum type ); ")
+ (example
+ "
+void beginData( GLenum type, void *polygon_data ); ")
+ (example "
+void edgeFlag( GLboolean flag ); ")
+ (example
+ "
+void edgeFlagData( GLboolean flag, void *polygon_data ); ")
+ (example "
+void vertex( void *vertex_data ); ")
+ (example
+ "
+void vertexData( void *vertex_data, void *polygon_data ); ")
+ (example "
+void end( void ); ")
+ (example "
+void endData( void *polygon_data ); ")
+ (example
+ "
+void combine( GLdouble coords[3], void *vertex_data[4],
+ GLfloat weight[4], void **outData ); ")
+ (example
+ "
+void myCombine( GLdouble coords[3], VERTEX *d[4],
+ GLfloat w[4], VERTEX **dataOut )
+{
+ VERTEX *new = new_vertex();
+
+ new->x = coords[0];
+ new->y = coords[1];
+ new->z = coords[2];
+ new->r = w[0]*d[0]->r + w[1]*d[1]->r + w[2]*d[2]->r + w[3]*d[3]->r;
+ new->g = w[0]*d[0]->g + w[1]*d[1]->g + w[2]*d[2]->g + w[3]*d[3]->g;
+ new->b = w[0]*d[0]->b + w[1]*d[1]->b + w[2]*d[2]->b + w[3]*d[3]->b;
+ new->a = w[0]*d[0]->a + w[1]*d[1]->a + w[2]*d[2]->a + w[3]*d[3]->a;
+ *dataOut = new;
+} ")
+ (example
+ "
+void combineData( GLdouble coords[3], void *vertex_data[4],
+ GLfloat weight[4], void **outData,
+ void *polygon_data ); ")
+ (example "
+void error( GLenum errno ); ")
+ (example
+ "
+void errorData( GLenum errno, void *polygon_data ); ")))
+
+(define-gl-procedure
+ gluTessEndPolygon
+ "gluTessEndPolygon"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "gluTessEndPolygon"))
+ (paramdef "GLUtesselator* " (parameter "tess"))))
+ '(*fragment*
+ (heading "delimit a polygon description")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "tess")))
+ (para "
+Specifies the tessellation object (created with "
+ (code "gluNewTess")
+ "). ")))
+ (heading "Description")
+ (para (code "gluTessBeginPolygon")
+ " and "
+ (code "gluTessEndPolygon")
+ " delimit the
+ definition of a convex, concave, or self-intersecting polygon. Within
+ each "
+ (code "gluTessBeginPolygon")
+ "/"
+ (code "gluTessEndPolygon")
+ " pair, there must be
+ one or more calls to "
+ (code "gluTessBeginContour")
+ "/"
+ (code "gluTessEndContour")
+ ".
+ Within each contour, there are zero or more calls to "
+ (code "gluTessVertex")
+ ".
+ The vertices specify a closed contour (the last vertex of each contour
+ is automatically linked to the first). See the "
+ (code "gluTessVertex")
+ ", "
+ (code "gluTessBeginContour")
+ ", and "
+ (code "gluTessEndContour")
+ " reference pages for
+ more details. ")
+ (para "
+Once "
+ (code "gluTessEndPolygon")
+ " is called, the polygon is tessellated, and the
+ resulting triangles are described through callbacks.
+ See "
+ (code "gluTessCallback")
+ " for descriptions of the callback functions. ")))
+
+(define-gl-procedure
+ gluTessNormal
+ "gluTessNormal"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "gluTessNormal"))
+ (paramdef "GLUtesselator* " (parameter "tess"))
+ (paramdef "GLdouble " (parameter "valueX"))
+ (paramdef "GLdouble " (parameter "valueY"))
+ (paramdef "GLdouble " (parameter "valueZ"))))
+ '(*fragment*
+ (heading "specify a normal for a polygon")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "tess")))
+ (para "
+Specifies the tessellation object (created with "
+ (code "gluNewTess")
+ "). "))
+ (entry (% (heading (var "valueX")))
+ (para "
+Specifies the first component of the normal. "))
+ (entry (% (heading (var "valueY")))
+ (para "
+Specifies the second component of the normal. "))
+ (entry (% (heading (var "valueZ")))
+ (para "
+Specifies the third component of the normal. ")))
+ (heading "Description")
+ (para (code "gluTessNormal")
+ " describes a normal for a polygon that the program is defining.
+ All input data will be projected onto a plane perpendicular to one of
+ the three coordinate axes before tessellation and all output triangles
+ will be oriented CCW with
+ respect to the normal (CW orientation can be obtained by reversing the
+ sign of the supplied normal). For example, if you know that all polygons
+ lie in the x-y plane, call "
+ (code "gluTessNormal")
+ "(tess, 0.0, 0.0, 1.0)
+ before rendering any polygons. ")
+ (para "
+If the supplied normal is (0.0, 0.0, 0.0) (the initial value), the normal is
+ determined as follows. The direction of the normal, up to its sign, is
+ found by fitting a plane to the vertices, without regard to how the
+ vertices are connected. It is expected that the input data lies approximately
+ in the plane; otherwise, projection perpendicular to one of the three
+ coordinate axes may substantially change the geometry. The sign of the
+ normal is chosen so that the sum of the signed areas of all input
+ contours is nonnegative (where a CCW contour has positive area). ")
+ (para "
+The supplied normal persists until it is changed by another call to "
+ (code "gluTessNormal")
+ ". ")))
+
+(define-gl-procedure
+ gluTessProperty
+ "gluTessProperty"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "gluTessProperty"))
+ (paramdef "GLUtesselator* " (parameter "tess"))
+ (paramdef "GLenum " (parameter "which"))
+ (paramdef "GLdouble " (parameter "data"))))
+ '(*fragment*
+ (heading "set a tessellation object property")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "tess")))
+ (para "
+Specifies the tessellation object (created with "
+ (code "gluNewTess")
+ "). "))
+ (entry (% (heading (var "which")))
+ (para "
+Specifies the property to be set. Valid values are "
+ (code "GLU_TESS_WINDING_RULE")
+ ", "
+ (code "GLU_TESS_BOUNDARY_ONLY")
+ ", and "
+ (code "GLU_TESS_TOLERANCE")
+ ". "))
+ (entry (% (heading (var "data")))
+ (para "
+Specifies the value of the indicated property. ")))
+ (heading "Description")
+ (para (code "gluTessProperty")
+ " is used to control properties stored in a tessellation object. These
+ properties affect the way that the polygons are interpreted and rendered.
+ The legal values for "
+ (var "which")
+ " are as follows: ")
+ (table (% (formatter (asis)))
+ (entry (% (heading (code "GLU_TESS_WINDING_RULE")))
+ (para "
+Determines which parts of the polygon are on the ``interior''. "
+ (var "data")
+ " may be set to one of "
+ (code "GLU_TESS_WINDING_ODD")
+ ", "
+ (code "GLU_TESS_WINDING_NONZERO")
+ ", "
+ (code "GLU_TESS_WINDING_POSITIVE")
+ ", "
+ (code "GLU_TESS_WINDING_NEGATIVE")
+ ", or "
+ (code "GLU_TESS_WINDING_ABS_GEQ_TWO")
+ ". ")
+ (para "
+To understand how the winding rule works, consider that the input
+ contours partition the plane into regions. The winding rule determines which
+ of these regions are inside the polygon. ")
+ (para "
+For a single contour C, the winding number of a point x is simply the signed
+ number of revolutions we make around x as we travel once around C
+ (where CCW is positive). When there are several contours, the individual
+ winding numbers are summed. This procedure associates a signed integer
+ value with each point x in the plane. Note that the winding number is the
+ same for all points in a single region. ")
+ (para "
+The winding rule classifies a region as ``inside'' if its winding number
+ belongs to the chosen category (odd, nonzero, positive, negative, or
+ absolute value of at least two). The previous GLU tessellator (prior to
+ GLU 1.2) used the ``odd'' rule. The ``nonzero'' rule is another common way to
+ define the interior. The other three rules are useful for polygon CSG
+ operations. "))
+ (entry (% (heading (code "GLU_TESS_BOUNDARY_ONLY")))
+ (para "
+Is a boolean value (``value'' should be set
+ to GL_TRUE or GL_FALSE). When set to GL_TRUE, a set of closed contours
+ separating the polygon interior and exterior are returned instead of a
+ tessellation. Exterior contours are oriented CCW with respect to the
+ normal; interior contours are oriented CW. The "
+ (code "GLU_TESS_BEGIN")
+ "
+and "
+ (code "GLU_TESS_BEGIN_DATA")
+ " callbacks use the type GL_LINE_LOOP for
+ each contour. "))
+ (entry (% (heading (code "GLU_TESS_TOLERANCE")))
+ (para "
+Specifies a tolerance for merging features to reduce the size of the output.
+ For example, two vertices that are very close to each other might be
+ replaced by a single vertex. The tolerance is multiplied by the largest
+ coordinate magnitude of any input vertex; this specifies the maximum
+ distance that any feature can move as the result of a single merge
+ operation. If a single feature takes part in several merge operations, the
+ total distance moved could be larger. ")
+ (para "
+Feature merging is completely optional; the tolerance is only a hint.
+ The implementation is free to merge in some cases and not in others, or to
+ never merge features at all. The initial tolerance is 0. ")
+ (para "
+The current implementation merges vertices only if they are exactly
+ coincident, regardless of the current tolerance. A vertex is spliced into
+ an edge only if the implementation is unable to distinguish which side of
+ the edge the vertex lies on. Two edges are merged only when both endpoints
+ are identical. ")))))
+
+(define-gl-procedure
+ gluTessVertex
+ "gluTessVertex"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "gluTessVertex"))
+ (paramdef "GLUtesselator* " (parameter "tess"))
+ (paramdef "GLdouble * " (parameter "location"))
+ (paramdef "GLvoid* " (parameter "data"))))
+ '(*fragment*
+ (heading "specify a vertex on a polygon")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "tess")))
+ (para "
+Specifies the tessellation object (created with "
+ (code "gluNewTess")
+ "). "))
+ (entry (% (heading (var "location")))
+ (para "
+Specifies the location of the vertex. "))
+ (entry (% (heading (var "data")))
+ (para "
+Specifies an opaque pointer passed back to the program with the vertex callback
+ (as specified by "
+ (code "gluTessCallback")
+ "). ")))
+ (heading "Description")
+ (para (code "gluTessVertex")
+ " describes a vertex on a polygon that the program defines. Successive "
+ (code "gluTessVertex")
+ " calls describe a closed contour. For example,
+ to describe a quadrilateral, "
+ (code "gluTessVertex")
+ " should be called four times. "
+ (code "gluTessVertex")
+ " can only be called between "
+ (code "gluTessBeginContour")
+ " and "
+ (code "gluTessEndContour")
+ ". ")
+ (para (var "data")
+ " normally points to a structure containing the vertex
+ location, as well as other per-vertex attributes such as color and normal.
+ This pointer is passed back to the user through the "
+ (code "GLU_TESS_VERTEX")
+ "
+or "
+ (code "GLU_TESS_VERTEX_DATA")
+ " callback after tessellation
+ (see the "
+ (code "gluTessCallback")
+ " reference page). ")))
+
+(define-gl-procedure
+ gluUnProject4
+ "gluUnProject4"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "GLint " (function "gluUnProject4"))
+ (paramdef "GLdouble " (parameter "winX"))
+ (paramdef "GLdouble " (parameter "winY"))
+ (paramdef "GLdouble " (parameter "winZ"))
+ (paramdef "GLdouble " (parameter "clipW"))
+ (paramdef
+ "const GLdouble * "
+ (parameter "model"))
+ (paramdef "const GLdouble * " (parameter "proj"))
+ (paramdef "const GLint * " (parameter "view"))
+ (paramdef "GLdouble " (parameter "nearVal"))
+ (paramdef "GLdouble " (parameter "farVal"))
+ (paramdef "GLdouble* " (parameter "objX"))
+ (paramdef "GLdouble* " (parameter "objY"))
+ (paramdef "GLdouble* " (parameter "objZ"))
+ (paramdef "GLdouble* " (parameter "objW"))))
+ '(*fragment*
+ (heading
+ "map window and clip coordinates to object coordinates")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "winX")))
+ (itemx (var "winY"))
+ (itemx (var "winZ"))
+ (para "
+Specify the window coordinates to be mapped. "))
+ (entry (% (heading (var "clipW")))
+ (para "
+Specify the clip w coordinate to be mapped. "))
+ (entry (% (heading (var "model")))
+ (para "
+Specifies the modelview matrix (as from a "
+ (code "glGetDoublev")
+ " call). "))
+ (entry (% (heading (var "proj")))
+ (para "
+Specifies the projection matrix (as from a "
+ (code "glGetDoublev")
+ " call). "))
+ (entry (% (heading (var "view")))
+ (para "
+Specifies the viewport (as from a "
+ (code "glGetIntegerv")
+ " call). "))
+ (entry (% (heading (var "nearVal")))
+ (itemx (var "farVal"))
+ (para "
+Specifies the near and far planes (as from a "
+ (code "glGetDoublev")
+ " call). "))
+ (entry (% (heading (var "objX")))
+ (itemx (var "objY"))
+ (itemx (var "objZ"))
+ (itemx (var "objW"))
+ (para "
+Returns the computed object coordinates. ")))
+ (heading "Description")
+ (para (code "gluUnProject4")
+ " maps the specified window coordinatesi: "
+ (var "winX")
+ ", "
+ (var "winY")
+ ", and "
+ (var "winZ")
+ "
+and its clip w coordinate "
+ (var "clipW")
+ "
+into object
+ coordinates "
+ (math "("
+ (var "objX")
+ ","
+ (var "objY")
+ (var "objZ")
+ (var "objW")
+ ")")
+ "
+using "
+ (var "model")
+ ", "
+ (var "proj")
+ ", and "
+ (var "view")
+ ". "
+ (var "clipW")
+ " can be other than
+ 1 as for vertices in "
+ (code "glFeedbackBuffer")
+ " when data type "
+ (code "GLU_4D_COLOR_TEXTURE")
+ " is returned.
+ This also handles the case
+ where the "
+ (var "nearVal")
+ " and "
+ (var "farVal")
+ " planes are different from the default,
+ 0 and 1, respectively.
+ A return
+ value of "
+ (code "GLU_TRUE")
+ " indicates success; a return value of "
+ (code "GLU_FALSE")
+ "
+indicates failure. ")
+ (para "
+To compute the coordinates "
+ (math "("
+ (var "objX")
+ ","
+ (var "objY")
+ (var "objZ")
+ (var "objW")
+ ")")
+ ", "
+ (code "gluUnProject4")
+ " multiplies the normalized device coordinates by the inverse of "
+ (var "model")
+ " * "
+ (var "proj")
+ " as follows: ")
+ (para (math "("
+ "("
+ (var "objX")
+ ")"
+ ", "
+ "("
+ (var "objY")
+ ")"
+ ", "
+ "("
+ (var "objZ")
+ ")"
+ ", "
+ "("
+ (var "objW")
+ ")"
+ ","
+ ")"
+ "="
+ (var "INV")
+ "\u2061"
+ "("
+ (var "P")
+ "\u2062"
+ (var "M")
+ ","
+ ")"
+ "\u2062"
+ "("
+ "("
+ "2"
+ "\u2061"
+ "("
+ (var "winX")
+ "-"
+ (var "view")
+ "\u2061"
+ "["
+ "0"
+ ","
+ "]"
+ ","
+ ")"
+ ","
+ "/"
+ (var "view")
+ "\u2061"
+ "["
+ "2"
+ ","
+ "]"
+ ","
+ "-"
+ "1"
+ ")"
+ ", "
+ "("
+ "2"
+ "\u2061"
+ "("
+ (var "winY")
+ "-"
+ (var "view")
+ "\u2061"
+ "["
+ "1"
+ ","
+ "]"
+ ","
+ ")"
+ ","
+ "/"
+ (var "view")
+ "\u2061"
+ "["
+ "3"
+ ","
+ "]"
+ ","
+ "-"
+ "1"
+ ")"
+ ", "
+ "("
+ "2"
+ "\u2061"
+ "("
+ (var "winZ")
+ "-"
+ (var "nearVal")
+ ","
+ ")"
+ ","
+ "/"
+ "("
+ (var "farVal")
+ "-"
+ (var "nearVal")
+ ","
+ ")"
+ ","
+ "-"
+ "1"
+ ")"
+ ", "
+ "("
+ (var "clipW")
+ ")"
+ ","
+ ")"))
+ (para (math (var "INV"))
+ "
+denotes matrix inversion. ")
+ (para (code "gluUnProject4")
+ " is equivalent to "
+ (code "gluUnProject")
+ " when "
+ (var "clipW")
+ " is 1, "
+ (var "nearVal")
+ " is 0, and "
+ (var "farVal")
+ " is 1. ")))
+
+(define-gl-procedure
+ gluUnProject
+ "gluUnProject"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "GLint " (function "gluUnProject"))
+ (paramdef "GLdouble " (parameter "winX"))
+ (paramdef "GLdouble " (parameter "winY"))
+ (paramdef "GLdouble " (parameter "winZ"))
+ (paramdef
+ "const GLdouble * "
+ (parameter "model"))
+ (paramdef "const GLdouble * " (parameter "proj"))
+ (paramdef "const GLint * " (parameter "view"))
+ (paramdef "GLdouble* " (parameter "objX"))
+ (paramdef "GLdouble* " (parameter "objY"))
+ (paramdef "GLdouble* " (parameter "objZ"))))
+ '(*fragment*
+ (heading
+ "map window coordinates to object coordinates")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "winX")))
+ (itemx (var "winY"))
+ (itemx (var "winZ"))
+ (para "
+Specify the window coordinates to be mapped. "))
+ (entry (% (heading (var "model")))
+ (para "
+Specifies the modelview matrix (as from a "
+ (code "glGetDoublev")
+ " call). "))
+ (entry (% (heading (var "proj")))
+ (para "
+Specifies the projection matrix (as from a "
+ (code "glGetDoublev")
+ " call). "))
+ (entry (% (heading (var "view")))
+ (para "
+Specifies the viewport (as from a "
+ (code "glGetIntegerv")
+ " call). "))
+ (entry (% (heading (var "objX")))
+ (itemx (var "objY"))
+ (itemx (var "objZ"))
+ (para "
+Returns the computed object coordinates. ")))
+ (heading "Description")
+ (para (code "gluUnProject")
+ " maps the specified window coordinates into object
+ coordinates using "
+ (var "model")
+ ", "
+ (var "proj")
+ ", and "
+ (var "view")
+ ".
+ The result is stored in "
+ (var "objX")
+ ", "
+ (var "objY")
+ ", and "
+ (var "objZ")
+ ". A return value of "
+ (code "GLU_TRUE")
+ " indicates success; a return value of "
+ (code "GLU_FALSE")
+ "
+indicates failure. ")
+ (para "
+To compute the coordinates "
+ (math "("
+ (var "objX")
+ ","
+ (var "objY")
+ (var "objZ")
+ ")")
+ ", "
+ (code "gluUnProject")
+ " multiplies the normalized device coordinates by the inverse of "
+ (var "model")
+ " * "
+ (var "proj")
+ " as follows: ")
+ (para (math "("
+ "("
+ (var "objX")
+ ")"
+ ", "
+ "("
+ (var "objY")
+ ")"
+ ", "
+ "("
+ (var "objZ")
+ ")"
+ ", "
+ "("
+ (var "W")
+ ")"
+ ","
+ ")"
+ "="
+ (var "INV")
+ "\u2061"
+ "("
+ (var "P")
+ "\u2062"
+ (var "M")
+ ","
+ ")"
+ "\u2062"
+ "("
+ "("
+ "2"
+ "\u2061"
+ "("
+ (var "winX")
+ "-"
+ (var "view")
+ "\u2061"
+ "["
+ "0"
+ ","
+ "]"
+ ","
+ ")"
+ ","
+ "/"
+ (var "view")
+ "\u2061"
+ "["
+ "2"
+ ","
+ "]"
+ ","
+ "-"
+ "1"
+ ")"
+ ", "
+ "("
+ "2"
+ "\u2061"
+ "("
+ (var "winY")
+ "-"
+ (var "view")
+ "\u2061"
+ "["
+ "1"
+ ","
+ "]"
+ ","
+ ")"
+ ","
+ "/"
+ (var "view")
+ "\u2061"
+ "["
+ "3"
+ ","
+ "]"
+ ","
+ "-"
+ "1"
+ ")"
+ ", "
+ "("
+ "2"
+ "\u2061"
+ "("
+ (var "winZ")
+ ","
+ ")"
+ "-"
+ "1"
+ ")"
+ ", "
+ "("
+ "1"
+ ")"
+ ","
+ ")")
+ (math (var "INV"))
+ "
+denotes matrix inversion.
+ W is an unused variable, included for consistent matrix notation. ")))
+
--- /dev/null
+;;; figl -*- mode: scheme; coding: utf-8 -*-
+;;; Copyright (C) 2013 Andy Wingo <wingo@pobox.com>
+;;;
+;;; Figl is free software: you can redistribute it and/or modify it
+;;; under the terms of the GNU Lesser General Public License as
+;;; published by the Free Software Foundation, either version 3 of the
+;;; License, or (at your option) any later version.
+;;;
+;;; Figl is distributed in the hope that it will be useful, but WITHOUT
+;;; ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+;;; or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
+;;; Public License for more details.
+;;;
+;;; You should have received a copy of the GNU Lesser General Public
+;;; License along with this program. If not, see
+;;; <http://www.gnu.org/licenses/>.
+;;;
+;;; Derived from upstream OpenGL documentation.
+;;;
+;;; Copyright
+;;; =========
+;;;
+;;; Copyright (C) 1991-2006 Silicon Graphics, Inc. This document is licensed
+;;; under the SGI Free Software B License. For details, see
+;;; http://oss.sgi.com/projects/FreeB/ (http://oss.sgi.com/projects/FreeB/).
+;;;
+;;; Automatically generated; you probably don't want to edit this. To
+;;; update, run "make update" in the top-level build tree.
+;;;
+
+(define-module
+ (figl low-level glx)
+ #:use-module
+ (figl low-level support)
+ #:export
+ (glXChooseFBConfig
+ glXChooseVisual
+ glXCopyContext
+ glXCreateContext
+ glXCreateGLXPixmap
+ glXCreateNewContext
+ glXCreatePbuffer
+ glXCreatePixmap
+ glXCreateWindow
+ glXDestroyContext
+ glXDestroyGLXPixmap
+ glXDestroyPbuffer
+ glXDestroyPixmap
+ glXDestroyWindow
+ glXFreeContextEXT
+ glXGetClientString
+ glXGetConfig
+ glXGetContextIDEXT
+ glXGetCurrentContext
+ glXGetCurrentDisplay
+ glXGetCurrentDrawable
+ glXGetCurrentReadDrawable
+ glXGetFBConfigAttrib
+ glXGetFBConfigs
+ glXGetProcAddress
+ glXGetSelectedEvent
+ glXGetVisualFromFBConfig
+ glXImportContextEXT
+ glXIntro
+ glXIsDirect
+ glXMakeContextCurrent
+ glXMakeCurrent
+ glXQueryContextInfoEXT
+ glXQueryContext
+ glXQueryDrawable
+ glXQueryExtensionsString
+ glXQueryExtension
+ glXQueryServerString
+ glXQueryVersion
+ glXSelectEvent
+ glXSwapBuffers
+ glXUseXFont
+ glXWaitGL
+ glXWaitX))
+
+(define-gl-procedure
+ glXChooseFBConfig
+ "glXChooseFBConfig"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "GLXFBConfig * "
+ (function "glXChooseFBConfig"))
+ (paramdef "Display * " (parameter "dpy"))
+ (paramdef "int " (parameter "screen"))
+ (paramdef
+ "const int * "
+ (parameter "attrib_list"))
+ (paramdef "int * " (parameter "nelements"))))
+ '(*fragment*
+ (heading
+ "return a list of GLX frame buffer configurations that match the specified attributes")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "dpy")))
+ (para "
+Specifies the connection to the X server. "))
+ (entry (% (heading (var "screen")))
+ (para "
+Specifies the screen number. "))
+ (entry (% (heading (var "attrib_list")))
+ (para "
+Specifies a list of attribute/value pairs.
+ The last attribute must be "
+ (code "None")
+ ". "))
+ (entry (% (heading (var "nelements")))
+ (para "
+Returns the number of elements in the list returned by "
+ (code "glXChooseFBConfig")
+ ". ")))
+ (heading "Description")
+ (para (code "glXChooseFBConfig")
+ " returns GLX frame buffer configurations that match the attributes
+ specified in "
+ (var "attrib_list")
+ ", or "
+ (code "NULL")
+ " if no matches are found.
+ If "
+ (var "attrib_list")
+ " is "
+ (code "NULL")
+ ", then "
+ (code "glXChooseFBConfig")
+ " returns an array of GLX
+ frame buffer configurations that are available on the specified screen.
+ If an error occurs, no frame buffer configurations exist on the
+ specified screen, or if no frame buffer configurations match the
+ specified attributes, then "
+ (code "NULL")
+ " is returned.
+ Use "
+ (code "XFree")
+ " to free the memory returned by "
+ (code "glXChooseFBConfig")
+ ". ")
+ (para "
+All attributes in "
+ (var "attrib_list")
+ ", including boolean attributes, are
+ immediately followed by the corresponding desired value. The list is
+ terminated with "
+ (code "None")
+ ". If an attribute is not specified in "
+ (var "attrib_list")
+ ",
+ then the default value (see below) is used (and the attribute is said to be
+ specified implicitly). For example, if "
+ (code "GLX_STEREO")
+ " is not specified, then
+ it is assumed to be "
+ (code "False")
+ ". For some attributes, the default is "
+ (code "GLX_DONT_CARE")
+ ", meaning that any value is OK for this attribute, so the
+ attribute will not be checked. ")
+ (para "
+Attributes are matched in an attribute-specific manner.
+ Some of the attributes, such as "
+ (code "GLX_LEVEL")
+ ", must match the specified
+ value exactly; others, such as, "
+ (code "GLX_RED_SIZE")
+ " must meet or exceed the
+ specified minimum values. If more than one GLX frame buffer configuration is found,
+ then a list of configurations, sorted
+ according to the ``best'' match criteria, is returned. The match
+ criteria for each attribute and the exact sorting order is
+ defined below. ")
+ (para "
+The interpretations of the various GLX visual attributes are as follows: ")
+ (table (% (formatter (asis)))
+ (entry (% (heading (code "GLX_FBCONFIG_ID")))
+ (para)
+ (para "
+Must be followed by a valid XID that indicates the desired GLX frame
+ buffer configuration. When a "
+ (code "GLX_FBCONFIG_ID")
+ " is specified, all
+ attributes are ignored. The default value is "
+ (code "GLX_DONT_CARE")
+ ". "))
+ (entry (% (heading (code "GLX_BUFFER_SIZE")))
+ (para)
+ (para "
+Must be followed by a nonnegative integer that indicates the desired
+ color index buffer size.
+ The smallest index buffer of at least the specified size is preferred.
+ This attribute is ignored if "
+ (code "GLX_COLOR_INDEX_BIT")
+ " is not set in "
+ (code "GLX_RENDER_TYPE")
+ ". The default value is 0. "))
+ (entry (% (heading (code "GLX_LEVEL")))
+ (para)
+ (para "
+Must be followed by an integer buffer-level specification.
+ This specification is honored exactly.
+ Buffer level 0 corresponds to the default frame buffer of the display.
+ Buffer level 1 is the first overlay frame buffer, level two the second
+ overlay frame buffer, and so on.
+ Negative buffer levels correspond to underlay frame buffers.
+ The default value is 0. "))
+ (entry (% (heading (code "GLX_DOUBLEBUFFER")))
+ (para)
+ (para "
+Must be followed by "
+ (code "True")
+ " or "
+ (code "False")
+ ". If "
+ (code "True")
+ " is specified, then
+ only double-buffered frame buffer configurations are considered;
+ if "
+ (code "False")
+ " is specified, then
+ only single-buffered frame buffer configurations are considered.
+ The default value is "
+ (code "GLX_DONT_CARE")
+ ". "))
+ (entry (% (heading (code "GLX_STEREO")))
+ (para)
+ (para "
+Must be followed by "
+ (code "True")
+ " or "
+ (code "False")
+ ". If "
+ (code "True")
+ " is specified, then
+ only stereo frame buffer configurations are considered;
+ if "
+ (code "False")
+ " is specified, then
+ only monoscopic frame buffer configurations are considered.
+ The default value is "
+ (code "False")
+ ". "))
+ (entry (% (heading (code "GLX_AUX_BUFFERS")))
+ (para)
+ (para "
+Must be followed by a nonnegative integer that indicates the desired
+ number of auxiliary buffers.
+ Configurations with the
+ smallest number of auxiliary buffers that meet or exceed
+ the specified number are preferred.
+ The default value is 0. "))
+ (entry (% (heading
+ (code "GLX_RED_SIZE")
+ ", "
+ (code "GLX_GREEN_SIZE")
+ ", "
+ (code "GLX_BLUE_SIZE")
+ ", "
+ (code "GLX_ALPHA_SIZE")))
+ (para)
+ (para "
+Each attribute, if present, must be followed by a nonnegative minimum size
+ specification or "
+ (code "GLX_DONT_CARE")
+ ".
+ The largest available total RGBA color buffer size (sum of "
+ (code "GLX_RED_SIZE")
+ ", "
+ (code "GLX_GREEN_SIZE")
+ ", "
+ (code "GLX_BLUE_SIZE")
+ ", and "
+ (code "GLX_ALPHA_SIZE")
+ ")
+ of at least the minimum size specified for each color component is preferred.
+ If the requested number of bits for a color component is 0 or "
+ (code "GLX_DONT_CARE")
+ ", it is not considered. The default value for each color
+ component is 0. "))
+ (entry (% (heading (code "GLX_DEPTH_SIZE")))
+ (para)
+ (para "
+Must be followed by a nonnegative minimum size specification.
+ If this value is zero,
+ frame buffer configurations with no depth buffer are preferred.
+ Otherwise, the largest available depth buffer of at least the minimum size
+ is preferred.
+ The default value is 0. "))
+ (entry (% (heading (code "GLX_STENCIL_SIZE")))
+ (para)
+ (para "
+Must be followed by a nonnegative integer that indicates the desired
+ number of stencil bitplanes.
+ The smallest stencil buffer of at least the specified size is preferred.
+ If the desired value is zero,
+ frame buffer configurations with no stencil buffer are preferred.
+ The default value is 0. "))
+ (entry (% (heading (code "GLX_ACCUM_RED_SIZE")))
+ (para)
+ (para "
+Must be followed by a nonnegative minimum size specification.
+ If this value is zero,
+ frame buffer configurations with no red accumulation buffer are preferred.
+ Otherwise, the largest possible red accumulation buffer
+ of at least the minimum size is preferred.
+ The default value is 0. "))
+ (entry (% (heading (code "GLX_ACCUM_GREEN_SIZE")))
+ (para)
+ (para "
+Must be followed by a nonnegative minimum size specification.
+ If this value is zero,
+ frame buffer configurations with no green accumulation buffer are preferred.
+ Otherwise, the largest possible green accumulation buffer
+ of at least the minimum size is preferred.
+ The default value is 0. "))
+ (entry (% (heading (code "GLX_ACCUM_BLUE_SIZE")))
+ (para)
+ (para "
+Must be followed by a nonnegative minimum size specification.
+ If this value is zero,
+ frame buffer configurations with no blue accumulation buffer are preferred.
+ Otherwise, the largest possible blue accumulation buffer
+ of at least the minimum size is preferred.
+ The default value is 0. "))
+ (entry (% (heading (code "GLX_ACCUM_ALPHA_SIZE")))
+ (para)
+ (para "
+Must be followed by a nonnegative minimum size specification.
+ If this value is zero,
+ frame buffer configurations with no alpha accumulation buffer are preferred.
+ Otherwise, the largest possible alpha accumulation buffer
+ of at least the minimum size is preferred.
+ The default value is 0. "))
+ (entry (% (heading (code "GLX_RENDER_TYPE")))
+ (para)
+ (para "
+Must be followed by a mask indicating which OpenGL rendering modes
+ the frame buffer configuration must support.
+ Valid bits are "
+ (code "GLX_RGBA_BIT")
+ " and "
+ (code "GLX_COLOR_INDEX_BIT")
+ ". If the mask is
+ set to "
+ (code "GLX_RGBA_BIT")
+ " | "
+ (code "GLX_COLOR_INDEX_BIT")
+ ",
+ then only frame buffer configurations that can be bound to both
+ RGBA contexts and color index contexts will be considered.
+ The default value is "
+ (code "GLX_RGBA_BIT")
+ ". "))
+ (entry (% (heading (code "GLX_DRAWABLE_TYPE")))
+ (para)
+ (para "
+Must be followed by a mask indicating which GLX drawable types
+ the frame buffer configuration must support. Valid bits are "
+ (code "GLX_WINDOW_BIT")
+ ", "
+ (code "GLX_PIXMAP_BIT")
+ ", and "
+ (code "GLX_PBUFFER_BIT")
+ ".
+ For example, if mask is set to "
+ (code "GLX_WINDOW_BIT")
+ " | "
+ (code "GLX_PIXMAP_BIT")
+ ",
+ only frame buffer configurations that support both windows and GLX pixmaps
+ will be considered.
+ The default value is "
+ (code "GLX_WINDOW_BIT")
+ ". "))
+ (entry (% (heading (code "GLX_X_RENDERABLE")))
+ (para)
+ (para "
+Must be followed by "
+ (code "True")
+ " or "
+ (code "False")
+ ".
+ If "
+ (code "True")
+ " is specified, then only frame buffer configurations that
+ have associated X visuals (and can be used to render to Windows and/or
+ GLX pixmaps) will be considered.
+ The default value is "
+ (code "GLX_DONT_CARE")
+ ". "))
+ (entry (% (heading (code "GLX_X_VISUAL_TYPE")))
+ (para)
+ (para "
+Must be followed by one of "
+ (code "GLX_TRUE_COLOR")
+ ", "
+ (code "GLX_DIRECT_COLOR")
+ ", "
+ (code "GLX_PSEUDO_COLOR")
+ ", "
+ (code "GLX_STATIC_COLOR")
+ ", "
+ (code "GLX_GRAY_SCALE")
+ ", or "
+ (code "GLX_STATIC_GRAY")
+ ", indicating the desired X visual type.
+ Not all frame buffer configurations have an associated X visual. If "
+ (code "GLX_DRAWABLE_TYPE")
+ " is specified in "
+ (var "attrib_list")
+ " and the
+ mask that follows does not have "
+ (code "GLX_WINDOW_BIT")
+ " set,
+ then this value is ignored. It is also ignored if "
+ (code "GLX_X_RENDERABLE")
+ " is specified as "
+ (code "False")
+ ".
+ RGBA rendering may be supported for visuals of type "
+ (code "GLX_TRUE_COLOR")
+ ", "
+ (code "GLX_DIRECT_COLOR")
+ ", "
+ (code "GLX_PSEUDO_COLOR")
+ ",
+ or "
+ (code "GLX_STATIC_COLOR")
+ ",
+ but color index rendering is only supported for visuals of type "
+ (code "GLX_PSEUDO_COLOR")
+ " or "
+ (code "GLX_STATIC_COLOR")
+ "
+(i.e., single-channel visuals).
+ The tokens "
+ (code "GLX_GRAY_SCALE")
+ " and "
+ (code "GLX_STATIC_GRAY")
+ " will
+ not match current OpenGL enabled visuals, but are included for future use.
+ The default value for "
+ (code "GLX_X_VISUAL_TYPE")
+ " is "
+ (code "GLX_DONT_CARE")
+ ". "))
+ (entry (% (heading (code "GLX_CONFIG_CAVEAT")))
+ (para)
+ (para "
+Must be followed by one of "
+ (code "GLX_NONE")
+ ", "
+ (code "GLX_SLOW_CONFIG")
+ ", "
+ (code "GLX_NON_CONFORMANT_CONFIG")
+ ".
+ If "
+ (code "GLX_NONE")
+ " is specified, then only frame buffer configurations with
+ no caveats will be considered; if "
+ (code "GLX_SLOW_CONFIG")
+ "
+is specified, then only slow frame buffer configurations will be considered; if "
+ (code "GLX_NON_CONFORMANT_CONFIG")
+ " is specified, then only
+ nonconformant frame buffer configurations will be considered.
+ The default value is "
+ (code "GLX_DONT_CARE")
+ ". "))
+ (entry (% (heading (code "GLX_TRANSPARENT_TYPE")))
+ (para)
+ (para "
+Must be followed by one of "
+ (code "GLX_NONE")
+ ", "
+ (code "GLX_TRANSPARENT_RGB")
+ ", "
+ (code "GLX_TRANSPARENT_INDEX")
+ ".
+ If "
+ (code "GLX_NONE")
+ " is specified, then only opaque
+ frame buffer configurations will be considered; if "
+ (code "GLX_TRANSPARENT_RGB")
+ "
+is specified, then only transparent
+ frame buffer configurations that support RGBA rendering will be considered;
+ if "
+ (code "GLX_TRANSPARENT_INDEX")
+ " is specified,
+ then only transparent frame buffer configurations that support color
+ index rendering will be considered.
+ The default value is "
+ (code "GLX_NONE")
+ ". "))
+ (entry (% (heading (code "GLX_TRANSPARENT_INDEX_VALUE")))
+ (para)
+ (para "
+Must be followed by an integer value indicating the transparent
+ index value; the value must be between 0 and the maximum
+ frame buffer value for indices.
+ Only frame buffer configurations that use the
+ specified transparent index value will be considered.
+ The default value is "
+ (code "GLX_DONT_CARE")
+ ".
+ This attribute is ignored unless "
+ (code "GLX_TRANSPARENT_TYPE")
+ " is
+ included in "
+ (var "attrib_list")
+ " and specified as "
+ (code "GLX_TRANSPARENT_INDEX")
+ ". "))
+ (entry (% (heading (code "GLX_TRANSPARENT_RED_VALUE")))
+ (para)
+ (para "
+Must be followed by an integer value indicating the transparent
+ red value; the value must be between 0 and the maximum
+ frame buffer value for red.
+ Only frame buffer configurations that use the
+ specified transparent red value will be considered.
+ The default value is "
+ (code "GLX_DONT_CARE")
+ ".
+ This attribute is
+ ignored unless "
+ (code "GLX_TRANSPARENT_TYPE")
+ " is included in "
+ (var "attrib_list")
+ " and specified as "
+ (code "GLX_TRANSPARENT_RGB")
+ ". "))
+ (entry (% (heading (code "GLX_TRANSPARENT_GREEN_VALUE")))
+ (para)
+ (para "
+Must be followed by an integer value indicating the transparent
+ green value; the value must be between 0 and the maximum
+ frame buffer value for green.
+ Only frame buffer configurations that use the
+ specified transparent green value will be considered.
+ The default value is "
+ (code "GLX_DONT_CARE")
+ ".
+ This attribute is
+ ignored unless "
+ (code "GLX_TRANSPARENT_TYPE")
+ " is included in "
+ (var "attrib_list")
+ " and specified as "
+ (code "GLX_TRANSPARENT_RGB")
+ ". "))
+ (entry (% (heading (code "GLX_TRANSPARENT_BLUE_VALUE")))
+ (para)
+ (para "
+Must be followed by an integer value indicating the transparent
+ blue value; the value must be between 0 and the maximum
+ frame buffer value for blue.
+ Only frame buffer configurations that use the
+ specified transparent blue value will be considered.
+ The default value is "
+ (code "GLX_DONT_CARE")
+ ".
+ This attribute is ignored unless "
+ (code "GLX_TRANSPARENT_TYPE")
+ " is included in "
+ (var "attrib_list")
+ " and specified as "
+ (code "GLX_TRANSPARENT_RGB")
+ ". "))
+ (entry (% (heading (code "GLX_TRANSPARENT_ALPHA_VALUE")))
+ (para)
+ (para "
+Must be followed by an integer value indicating the transparent
+ alpha value; the value must be between 0 and the maximum
+ frame buffer value for alpha.
+ Only frame buffer configurations that use the
+ specified transparent alpha value will be considered.
+ The default value is "
+ (code "GLX_DONT_CARE")
+ ". ")))
+ (para "
+When more than one GLX frame buffer configuration matches the specified attributes,
+ a list of matching configurations is returned. The list is sorted
+ according to the following precedence rules, which are applied in ascending
+ order (i.e., configurations
+ that are considered equal by a lower numbered rule are sorted by the higher
+ numbered rule): ")
+ (table (% (formatter (asis)))
+ (entry (% (heading "1."))
+ (para "
+By "
+ (code "GLX_CONFIG_CAVEAT")
+ " where the precedence is "
+ (code "GLX_NONE")
+ ", "
+ (code "GLX_SLOW_CONFIG")
+ ", and "
+ (code "GLX_NON_CONFORMANT_CONFIG")
+ ". "))
+ (entry (% (heading "2."))
+ (para "
+Larger total number of RGBA color components
+ ("
+ (code "GLX_RED_SIZE")
+ ", "
+ (code "GLX_GREEN_SIZE")
+ ", "
+ (code "GLX_BLUE_SIZE")
+ ",
+ plus "
+ (code "GLX_ALPHA_SIZE")
+ ")
+ that have higher number of bits. If the requested number of bits in "
+ (var "attrib_list")
+ " is zero or "
+ (code "GLX_DONT_CARE")
+ " for a particular color
+ component, then the number of bits for that component is not considered. "))
+ (entry (% (heading "3."))
+ (para "
+Smaller " (code "GLX_BUFFER_SIZE") ". "))
+ (entry (% (heading "4."))
+ (para "
+Single buffered configuration ("
+ (code "GLX_DOUBLEBUFFER")
+ " being "
+ (code "False")
+ " precedes a double buffered one. "))
+ (entry (% (heading "5."))
+ (para "
+Smaller " (code "GLX_AUX_BUFFERS") ". "))
+ (entry (% (heading "6."))
+ (para "
+Larger " (code "GLX_DEPTH_SIZE") ". "))
+ (entry (% (heading "7."))
+ (para "
+Smaller " (code "GLX_STENCIL_SIZE") ". "))
+ (entry (% (heading "8."))
+ (para "
+Larger total number of accumulation buffer color components
+ ("
+ (code "GLX_ACCUM_RED_SIZE")
+ ", "
+ (code "GLX_ACCUM_GREEN_SIZE")
+ ", "
+ (code "GLX_ACCUM_BLUE_SIZE")
+ ", plus "
+ (code "GLX_ACCUM_ALPHA_SIZE")
+ ") that have
+ higher number of bits. If the requested number of bits in "
+ (var "attrib_list")
+ " is
+ zero or "
+ (code "GLX_DONT_CARE")
+ " for a particular color component, then the
+ number of bits for that component is not considered. "))
+ (entry (% (heading "9."))
+ (para "
+By "
+ (code "GLX_X_VISUAL_TYPE")
+ " where the precedence order is "
+ (code "GLX_TRUE_COLOR")
+ ", "
+ (code "GLX_DIRECT_COLOR")
+ ", "
+ (code "GLX_PSEUDO_COLOR")
+ ", "
+ (code "GLX_STATIC_COLOR")
+ ", "
+ (code "GLX_GRAY_SCALE")
+ ", "
+ (code "GLX_STATIC_GRAY")
+ ". ")))
+ (heading "Errors")
+ (para (code "NULL")
+ " is returned if an undefined GLX attribute is
+ encountered in "
+ (var "attrib_list")
+ ", if "
+ (var "screen")
+ " is invalid, or if "
+ (var "dpy")
+ " does
+ not support the GLX extension. ")))
+
+(define-gl-procedure
+ glXChooseVisual
+ "glXChooseVisual"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "XVisualInfo* "
+ (function "glXChooseVisual"))
+ (paramdef "Display * " (parameter "dpy"))
+ (paramdef "int " (parameter "screen"))
+ (paramdef "int * " (parameter "attribList"))))
+ '(*fragment*
+ (heading
+ "return a visual that matches specified attributes")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "dpy")))
+ (para "
+Specifies the connection to the X server. "))
+ (entry (% (heading (var "screen")))
+ (para "
+Specifies the screen number. "))
+ (entry (% (heading (var "attribList")))
+ (para "
+Specifies a list of boolean attributes and integer attribute/value pairs.
+ The last attribute must be "
+ (code "None")
+ ". ")))
+ (heading "Description")
+ (para (code "glXChooseVisual")
+ " returns a pointer to an XVisualInfo structure describing the visual
+ that best meets a minimum specification.
+ The boolean GLX attributes of the visual that is returned will match the
+ specified values,
+ and the integer GLX attributes will meet or exceed the specified
+ minimum values.
+ If all other attributes are equivalent, then TrueColor and PseudoColor
+ visuals have priority over DirectColor and StaticColor visuals,
+ respectively.
+ If no conforming visual exists, "
+ (code "NULL")
+ " is returned.
+ To free the data returned by this function, use "
+ (code "XFree")
+ ". ")
+ (para "
+All boolean GLX attributes default to "
+ (code "False")
+ "
+except "
+ (code "GLX_USE_GL")
+ ",
+ which defaults to "
+ (code "True")
+ ".
+ All integer GLX attributes default to zero.
+ Default specifications are superseded by attributes included in "
+ (var "attribList")
+ ".
+ Boolean attributes included in "
+ (var "attribList")
+ " are understood to be "
+ (code "True")
+ ".
+ Integer attributes and enumerated type attributes are followed immediately
+ by the corresponding desired or
+ minimum value.
+ The list must be terminated with "
+ (code "None")
+ ". ")
+ (para "
+The interpretations of the various GLX visual attributes are as follows: ")
+ (table (% (formatter (asis)))
+ (entry (% (heading (code "GLX_USE_GL")))
+ (para "
+Ignored.
+ Only visuals that can be rendered with GLX are considered. "))
+ (entry (% (heading (code "GLX_BUFFER_SIZE")))
+ (para "
+Must be followed by a nonnegative integer that indicates the desired
+ color index buffer size.
+ The smallest index buffer of at least the specified size is preferred.
+ Ignored if "
+ (code "GLX_RGBA")
+ " is asserted. "))
+ (entry (% (heading (code "GLX_LEVEL")))
+ (para "
+Must be followed by an integer buffer-level specification.
+ This specification is honored exactly.
+ Buffer level zero corresponds to the main frame buffer of the display.
+ Buffer level one is the first overlay frame buffer, level two the second
+ overlay frame buffer, and so on.
+ Negative buffer levels correspond to underlay frame buffers. "))
+ (entry (% (heading (code "GLX_RGBA")))
+ (para "
+If present,
+ only TrueColor and DirectColor visuals are considered.
+ Otherwise,
+ only PseudoColor and StaticColor visuals are considered. "))
+ (entry (% (heading (code "GLX_DOUBLEBUFFER")))
+ (para "
+If present,
+ only double-buffered visuals are considered.
+ Otherwise,
+ only single-buffered visuals are considered. "))
+ (entry (% (heading (code "GLX_STEREO")))
+ (para "
+If present,
+ only stereo visuals are considered.
+ Otherwise,
+ only monoscopic visuals are considered. "))
+ (entry (% (heading (code "GLX_AUX_BUFFERS")))
+ (para "
+Must be followed by a nonnegative integer that indicates the desired
+ number of auxiliary buffers.
+ Visuals with the
+ smallest number of auxiliary buffers that meets or exceeds
+ the specified number are preferred. "))
+ (entry (% (heading (code "GLX_RED_SIZE")))
+ (para "
+Must be followed by a nonnegative minimum size specification.
+ If this value is zero,
+ the smallest available red buffer is preferred.
+ Otherwise, the largest available red buffer of at least the minimum size
+ is preferred. "))
+ (entry (% (heading (code "GLX_GREEN_SIZE")))
+ (para "
+Must be followed by a nonnegative minimum size specification.
+ If this value is zero,
+ the smallest available green buffer is preferred.
+ Otherwise, the largest available green buffer of at least the minimum size
+ is preferred. "))
+ (entry (% (heading (code "GLX_BLUE_SIZE")))
+ (para "
+Must be followed by a nonnegative minimum size specification.
+ If this value is zero,
+ the smallest available blue buffer is preferred.
+ Otherwise, the largest available blue buffer of at least the minimum size
+ is preferred. "))
+ (entry (% (heading (code "GLX_ALPHA_SIZE")))
+ (para "
+Must be followed by a nonnegative minimum size specification.
+ If this value is zero,
+ the smallest available alpha buffer is preferred.
+ Otherwise, the largest available alpha buffer of at least the minimum size
+ is preferred. "))
+ (entry (% (heading (code "GLX_DEPTH_SIZE")))
+ (para "
+Must be followed by a nonnegative minimum size specification.
+ If this value is zero,
+ visuals with no depth buffer are preferred.
+ Otherwise, the largest available depth buffer of at least the minimum size
+ is preferred. "))
+ (entry (% (heading (code "GLX_STENCIL_SIZE")))
+ (para "
+Must be followed by a nonnegative integer that indicates the desired
+ number of stencil bitplanes.
+ The smallest stencil buffer of at least the specified size is preferred.
+ If the desired value is zero,
+ visuals with no stencil buffer are preferred. "))
+ (entry (% (heading (code "GLX_ACCUM_RED_SIZE")))
+ (para "
+Must be followed by a nonnegative minimum size specification.
+ If this value is zero,
+ visuals with no red accumulation buffer are preferred.
+ Otherwise, the largest possible red accumulation buffer
+ of at least the minimum size is preferred. "))
+ (entry (% (heading (code "GLX_ACCUM_GREEN_SIZE")))
+ (para "
+Must be followed by a nonnegative minimum size specification.
+ If this value is zero,
+ visuals with no green accumulation buffer are preferred.
+ Otherwise, the largest possible green accumulation buffer
+ of at least the minimum size is preferred. "))
+ (entry (% (heading (code "GLX_ACCUM_BLUE_SIZE")))
+ (para "
+Must be followed by a nonnegative minimum size specification.
+ If this value is zero,
+ visuals with no blue accumulation buffer are preferred.
+ Otherwise, the largest possible blue accumulation buffer
+ of at least the minimum size is preferred. "))
+ (entry (% (heading (code "GLX_ACCUM_ALPHA_SIZE")))
+ (para "
+Must be followed by a nonnegative minimum size specification.
+ If this value is zero,
+ visuals with no alpha accumulation buffer are preferred.
+ Otherwise, the largest possible alpha accumulation buffer
+ of at least the minimum size is preferred. ")))
+ (heading "Errors")
+ (para (code "NULL")
+ " is returned if an undefined GLX attribute is encountered in "
+ (var "attribList")
+ ". ")))
+
+(define-gl-procedure
+ glXCopyContext
+ "glXCopyContext"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glXCopyContext"))
+ (paramdef "Display * " (parameter "dpy"))
+ (paramdef "GLXContext " (parameter "src"))
+ (paramdef "GLXContext " (parameter "dst"))
+ (paramdef "unsigned long " (parameter "mask"))))
+ '(*fragment*
+ (heading
+ "copy state from one rendering context to another")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "dpy")))
+ (para "
+Specifies the connection to the X server. "))
+ (entry (% (heading (var "src")))
+ (para "
+Specifies the source context. "))
+ (entry (% (heading (var "dst")))
+ (para "
+Specifies the destination context. "))
+ (entry (% (heading (var "mask")))
+ (para "
+Specifies which portions of "
+ (var "src")
+ " state are to be copied to "
+ (var "dst")
+ ". ")))
+ (heading "Description")
+ (para (code "glXCopyContext")
+ " copies selected groups of state variables from "
+ (var "src")
+ " to "
+ (var "dst")
+ ". "
+ (var "mask")
+ " indicates which groups of state variables are to be copied. "
+ (var "mask")
+ " contains the bitwise OR of the same symbolic names that are
+ passed to the GL command "
+ (code "glPushAttrib")
+ ".
+ The single symbolic constant "
+ (code "GLX_ALL_ATTRIB_BITS")
+ " can be used to
+ copy the maximum possible portion of rendering state. ")
+ (para "
+The copy can be done only if the renderers named by "
+ (var "src")
+ " and "
+ (var "dst")
+ "
+share an address space.
+ Two rendering contexts share an address space if both are nondirect
+ using the same server,
+ or if both are direct and owned by a single process.
+ Note that in the nondirect case it is not necessary for the calling
+ threads to share an address space,
+ only for their related rendering contexts to share an address space. ")
+ (para "
+Not all values for GL state can be copied.
+ For example,
+ pixel pack and unpack state,
+ render mode state,
+ and select and feedback state are not copied.
+ The state that can be copied is exactly the state that is manipulated
+ by the GL command "
+ (code "glPushAttrib")
+ ". ")
+ (para "
+An implicit "
+ (code "glFlush")
+ " is done by "
+ (code "glXCopyContext")
+ " if "
+ (var "src")
+ " is the current
+ context for the calling thread. ")
+ (heading "Errors")
+ (para (code "BadMatch")
+ " is generated if rendering contexts "
+ (var "src")
+ " and "
+ (var "dst")
+ "
+do not share an address space
+ or were not created with respect to the same screen. ")
+ (para (code "BadAccess")
+ " is generated if "
+ (var "dst")
+ " is current to any thread
+ (including the calling thread) at the time "
+ (code "glXCopyContext")
+ " is called. ")
+ (para (code "GLXBadCurrentWindow")
+ " is generated if "
+ (var "src")
+ " is the current
+ context and the current drawable is a window that is no longer valid. ")
+ (para (code "GLXBadContext")
+ " is generated if either "
+ (var "src")
+ " or "
+ (var "dst")
+ " is not
+ a valid GLX context. ")))
+
+(define-gl-procedure
+ glXCreateContext
+ "glXCreateContext"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "GLXContext "
+ (function "glXCreateContext"))
+ (paramdef "Display * " (parameter "dpy"))
+ (paramdef "XVisualInfo * " (parameter "vis"))
+ (paramdef "GLXContext " (parameter "shareList"))
+ (paramdef "Bool " (parameter "direct"))))
+ '(*fragment*
+ (heading "create a new GLX rendering context")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "dpy")))
+ (para "
+Specifies the connection to the X server. "))
+ (entry (% (heading (var "vis")))
+ (para "
+Specifies the visual that defines the frame buffer resources available to
+ the rendering context.
+ It is a pointer to an "
+ (code "XVisualInfo")
+ " structure,
+ not a visual ID or a pointer to a "
+ (code "Visual")
+ ". "))
+ (entry (% (heading (var "shareList")))
+ (para "
+Specifies the context with which to share display lists. "
+ (code "NULL")
+ " indicates that no sharing is to take place. "))
+ (entry (% (heading (var "direct")))
+ (para "
+Specifies whether rendering is to be done with a direct connection
+ to the graphics system if possible ("
+ (code "True")
+ ")
+ or through the X server ("
+ (code "False")
+ "). ")))
+ (heading "Description")
+ (para (code "glXCreateContext")
+ " creates a GLX rendering context and returns its handle.
+ This context can be used to render into both windows and GLX pixmaps.
+ If "
+ (code "glXCreateContext")
+ " fails to create a rendering context, "
+ (code "NULL")
+ " is returned. ")
+ (para "
+If "
+ (var "direct")
+ " is "
+ (code "True")
+ ",
+ then a direct rendering context is created if the
+ implementation supports direct rendering, if the connection is to an X
+ server that is local, and if a direct rendering context is available. (An implementation may return an indirect context when "
+ (var "direct")
+ " is "
+ (code "True")
+ ".)
+ If "
+ (var "direct")
+ " is "
+ (code "False")
+ ",
+ then a rendering context that renders through the X server is always created.
+ Direct rendering provides a performance advantage in some implementations.
+ However, direct rendering contexts cannot be shared outside a single process,
+ and they may be unable to render to GLX pixmaps. ")
+ (para "
+If "
+ (var "shareList")
+ " is not "
+ (code "NULL")
+ ",
+ then all display-list indexes and definitions are shared by
+ context "
+ (var "shareList")
+ " and by the newly created context.
+ An arbitrary number of contexts can share a single display-list space.
+ However,
+ all rendering contexts that share a single display-list space must
+ themselves exist in the same address space.
+ Two rendering contexts share an address space if both are nondirect
+ using the same server,
+ or if both are direct and owned by a single process.
+ Note that in the nondirect case, it is not necessary for the calling
+ threads to share an address space,
+ only for their related rendering contexts to share an address space. ")
+ (para "
+If the GL version is 1.1 or greater,
+ then all texture objects except object 0
+ are shared by any contexts that share display lists. ")
+ (heading "Errors")
+ (para (code "NULL")
+ " is returned if execution fails on the client side. ")
+ (para (code "BadMatch")
+ " is generated if the context to be created would not
+ share the address space or the screen of the context specified by "
+ (var "shareList")
+ ". ")
+ (para (code "BadValue")
+ " is generated if "
+ (var "vis")
+ " is not a valid visual (for
+ example, if a particular GLX implementation does not support it). ")
+ (para (code "GLXBadContext")
+ " is generated if "
+ (var "shareList")
+ " is not a GLX context
+ and is not "
+ (code "NULL")
+ ". ")
+ (para (code "BadAlloc")
+ " is generated if the server does not have enough
+ resources to allocate the new context. ")))
+
+(define-gl-procedure
+ glXCreateGLXPixmap
+ "glXCreateGLXPixmap"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "GLXPixmap "
+ (function "glXCreateGLXPixmap"))
+ (paramdef "Display * " (parameter "dpy"))
+ (paramdef "XVisualInfo * " (parameter "vis"))
+ (paramdef "Pixmap " (parameter "pixmap"))))
+ '(*fragment*
+ (heading
+ "create an off-screen GLX rendering area")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "dpy")))
+ (para "
+Specifies the connection to the X server. "))
+ (entry (% (heading (var "vis")))
+ (para "
+Specifies the visual that defines the structure of the rendering area.
+ It is a pointer to an "
+ (code "XVisualInfo")
+ " structure,
+ not a visual ID or a pointer to a "
+ (code "Visual")
+ ". "))
+ (entry (% (heading (var "pixmap")))
+ (para "
+Specifies the X pixmap that will be used as the front left color buffer
+ of the off-screen rendering area. ")))
+ (heading "Description")
+ (para (code "glXCreateGLXPixmap")
+ " creates an off-screen rendering area and returns its XID.
+ Any GLX rendering context that was created with respect to "
+ (var "vis")
+ "
+can be used to render into this off-screen area.
+ Use "
+ (code "glXMakeCurrent")
+ " to associate the rendering area with a GLX
+ rendering context. ")
+ (para "
+The X pixmap identified by "
+ (var "pixmap")
+ " is used as the front left buffer of the
+ resulting off-screen rendering area.
+ All other buffers specified by "
+ (var "vis")
+ ",
+ including color buffers other than the front left buffer,
+ are created without externally visible names.
+ GLX pixmaps with double-buffering are supported.
+ However, "
+ (code "glXSwapBuffers")
+ " is ignored by these pixmaps. ")
+ (para "
+Some implementations may not support GLX pixmaps with direct rendering
+ contexts. ")
+ (heading "Errors")
+ (para (code "BadMatch")
+ " is generated if the depth of "
+ (var "pixmap")
+ " does not match
+ the depth value reported by core X11 for "
+ (var "vis")
+ ",
+ or if "
+ (var "pixmap")
+ " was not created with respect to the same screen as "
+ (var "vis")
+ ". ")
+ (para (code "BadValue")
+ " is generated
+ if "
+ (var "vis")
+ " is not a valid XVisualInfo pointer (for example, if a
+ particular GLX implementation does not support this visual). ")
+ (para (code "BadPixmap")
+ " is generated if "
+ (var "pixmap")
+ " is not a valid pixmap. ")
+ (para (code "BadAlloc")
+ " is generated if the server cannot allocate the GLX
+ pixmap. ")))
+
+(define-gl-procedure
+ glXCreateNewContext
+ "glXCreateNewContext"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "GLXContext "
+ (function "glXCreateNewContext"))
+ (paramdef "Display * " (parameter "dpy"))
+ (paramdef "GLXFBConfig " (parameter "config"))
+ (paramdef "int " (parameter "render_type"))
+ (paramdef "GLXContext " (parameter "share_list"))
+ (paramdef "Bool " (parameter "direct"))))
+ '(*fragment*
+ (heading "create a new GLX rendering context")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "dpy")))
+ (para "
+Specifies the connection to the X server. "))
+ (entry (% (heading (var "config")))
+ (para "
+Specifies the GLXFBConfig structure with the desired attributes for the
+ context. "))
+ (entry (% (heading (var "render_type")))
+ (para "
+Specifies the type of the context to be created. Must be one of "
+ (code "GLX_RGBA_TYPE")
+ " or "
+ (code "GLX_COLOR_INDEX_TYPE")
+ ". "))
+ (entry (% (heading (var "share_list")))
+ (para "
+Specifies the context with which to share display lists. "
+ (code "NULL")
+ " indicates that no sharing is to take place. "))
+ (entry (% (heading (var "share_list")))
+ (para "
+Specifies whether rendering is to be done with a direct connection
+ to the graphics system if possible ("
+ (code "True")
+ ")
+ or through the X server ("
+ (code "False")
+ "). ")))
+ (heading "Description")
+ (para (code "glXCreateNewContext")
+ " creates a GLX rendering context and returns its handle.
+ This context can be used to render into GLX windows, pixmaps, or pixel
+ buffers.
+ If "
+ (code "glXCreateNewContext")
+ " fails to create a rendering context, "
+ (code "NULL")
+ " is returned. ")
+ (para "
+If "
+ (var "render_type")
+ " is "
+ (code "GLX_RGBA_TYPE")
+ ", then a context that supports RGBA
+ rendering is created. If "
+ (var "config")
+ " is "
+ (code "GLX_COLOR_INDEX_TYPE")
+ ", then
+ context supporting color-index rendering is created. ")
+ (para "
+If "
+ (var "render_type")
+ " is not "
+ (code "NULL")
+ ",
+ then all display-list indexes and definitions are shared by
+ context "
+ (var "render_type")
+ " and by the newly created context.
+ An arbitrary number of contexts can share a single display-list space.
+ However,
+ all rendering contexts that share a single display-list space must
+ themselves exist in the same address space.
+ Two rendering contexts share an address space if both are nondirect
+ using the same server,
+ or if both are direct and owned by a single process.
+ Note that in the nondirect case, it is not necessary for the calling
+ threads to share an address space,
+ only for their related rendering contexts to share an address space. ")
+ (para "
+If "
+ (var "share_list")
+ " is "
+ (code "True")
+ ",
+ then a direct-rendering context is created if the
+ implementation supports direct rendering, if the connection is to an X
+ server that is local, and if a direct-rendering context is available. (An implementation may return an indirect context when "
+ (var "share_list")
+ " is "
+ (code "True")
+ ".)
+ If "
+ (var "share_list")
+ " is "
+ (code "False")
+ ",
+ then a rendering context that renders through the X server is always created.
+ Direct rendering provides a performance advantage in some implementations.
+ However, direct-rendering contexts cannot be shared outside a single process,
+ and they may be unable to render to GLX pixmaps. ")
+ (heading "Errors")
+ (para (code "NULL")
+ " is returned if execution fails on the client side. ")
+ (para (code "GLXBadContext")
+ " is generated if "
+ (var "render_type")
+ " is not a GLX context
+ and is not "
+ (code "NULL")
+ ". ")
+ (para (code "GLXBadFBConfig")
+ " is generated if "
+ (var "config")
+ " is not a valid
+ GLXFBConfig. ")
+ (para (code "BadMatch")
+ " is generated if the context to be created would not
+ share the address space or the screen of the context specified by "
+ (var "render_type")
+ ". ")
+ (para (code "BadAlloc")
+ " is generated if the server does not have enough
+ resources to allocate the new context. ")
+ (para (code "BadValue")
+ " is generated if "
+ (var "config")
+ " is not a valid visual (for
+ example, if a particular GLX implementation does not support it). ")))
+
+(define-gl-procedure
+ glXCreatePbuffer
+ "glXCreatePbuffer"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "GLXPbuffer "
+ (function "glXCreatePbuffer"))
+ (paramdef "Display * " (parameter "dpy"))
+ (paramdef "GLXFBConfig " (parameter "config"))
+ (paramdef
+ "const int * "
+ (parameter "attrib_list"))))
+ '(*fragment*
+ (heading "create an off-screen rendering area")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "dpy")))
+ (para "
+Specifies the connection to the X server. "))
+ (entry (% (heading (var "config")))
+ (para "
+Specifies a GLXFBConfig structure with the desired attributes for the
+ window. "))
+ (entry (% (heading (var "attrib_list")))
+ (para "
+Specifies a list of attribute value pairs, which must be terminated with "
+ (code "None")
+ " or "
+ (code "NULL")
+ ". Accepted attributes are "
+ (code "GLX_PBUFFER_WIDTH")
+ ", "
+ (code "GLX_PBUFFER_HEIGHT")
+ ", "
+ (code "GLX_PRESERVED_CONTENTS")
+ ", and "
+ (code "GLX_LARGEST_PBUFFER")
+ ". ")))
+ (heading "Description")
+ (para (code "glXCreatePbuffer")
+ " creates an off-screen rendering area and returns its XID.
+ Any GLX rendering context that was created with respect to "
+ (var "config")
+ "
+can be used to render into this window.
+ Use "
+ (code "glXMakeContextCurrent")
+ " to associate the rendering area with a GLX
+ rendering context. ")
+ (para "
+The accepted attributes for a GLXPbuffer are: ")
+ (table (% (formatter (asis)))
+ (entry (% (heading (code "GLX_PBUFFER_WIDTH")))
+ (para "
+Specify the pixel width of the requested GLXPbuffer. The default value
+ is 0. "))
+ (entry (% (heading (code "GLX_PBUFFER_HEIGHT")))
+ (para "
+Specify the pixel height of the requested GLXPbuffer. The default value
+ is 0. "))
+ (entry (% (heading (code "GLX_LARGEST_PBUFFER")))
+ (para "
+Specify to obtain the largest available pixel buffer, if the requested
+ allocation would have failed. The width and height of the allocated
+ pixel buffer will never exceed the specified "
+ (code "GLX_PBUFFER_WIDTH")
+ " or "
+ (code "GLX_PBUFFER_HEIGHT")
+ ", respectively. Use "
+ (code "glXQueryDrawable")
+ " to
+ retrieve the dimensions of the allocated pixel buffer. The default value is "
+ (code "False")
+ ". "))
+ (entry (% (heading (code "GLX_PRESERVED_CONTENTS")))
+ (para "
+Specify if the contents of the pixel buffer should be preserved when a
+ resource conflict occurs. If set to "
+ (code "False")
+ ", the contents of the
+ pixel buffer may be lost at any time. If set to "
+ (code "True")
+ ", or not
+ specified in "
+ (var "attrib_list")
+ ", then the contents of the pixel buffer will be preserved
+ (most likely by copying the contents into main system memory from the
+ frame buffer). In either case, the client can register (using "
+ (code "glXSelectEvent")
+ ", to receive
+ pixel buffer clobber events that are generated when the pbuffer contents have
+ been preserved or damaged. ")))
+ (para "
+GLXPbuffers contain the color and ancillary buffers specified by "
+ (var "config")
+ ". It is possible to create a pixel buffer with back buffers and
+ to swap those buffers using "
+ (code "glXSwapBuffers")
+ ". ")
+ (heading "Errors")
+ (para (code "BadAlloc")
+ " is generated if there are insufficient resources to
+ allocate the requested GLXPbuffer. ")
+ (para (code "GLXBadFBConfig")
+ " is generated if "
+ (var "config")
+ " is not a valid
+ GLXFBConfig. ")
+ (para (code "BadMatch")
+ " is generated if "
+ (var "config")
+ " does not support rendering to
+ pixel buffers (e.g., "
+ (code "GLX_DRAWABLE_TYPE")
+ " does not contain "
+ (code "GLX_PBUFFER_BIT")
+ "). ")))
+
+(define-gl-procedure
+ glXCreatePixmap
+ "glXCreatePixmap"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "GLXPixmap "
+ (function "glXCreatePixmap"))
+ (paramdef "Display * " (parameter "dpy"))
+ (paramdef "GLXFBConfig " (parameter "config"))
+ (paramdef "Pixmap " (parameter "pixmap"))
+ (paramdef
+ "const int * "
+ (parameter "attrib_list"))))
+ '(*fragment*
+ (heading "create an off-screen rendering area")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "dpy")))
+ (para "
+Specifies the connection to the X server. "))
+ (entry (% (heading (var "config")))
+ (para "
+Specifies a GLXFBConfig structure with the desired attributes for the
+ window. "))
+ (entry (% (heading (var "pixmap")))
+ (para "
+Specifies the X pixmap to be used as the rendering area. "))
+ (entry (% (heading (var "attrib_list")))
+ (para "
+Currently unused. This must be set to "
+ (code "NULL")
+ " or be an empty list
+ (i.e., one in which the first element is "
+ (code "None")
+ "). ")))
+ (heading "Description")
+ (para (code "glXCreatePixmap")
+ " creates an off-screen rendering area and returns its XID.
+ Any GLX rendering context that was created with respect to "
+ (var "config")
+ "
+can be used to render into this window.
+ Use "
+ (code "glXMakeCurrent")
+ " to associate the rendering area with a GLX
+ rendering context. ")
+ (heading "Errors")
+ (para (code "BadMatch")
+ " is generated if "
+ (var "pixmap")
+ " was not created with a visual
+ that corresponds to "
+ (var "config")
+ ". ")
+ (para (code "BadMatch")
+ " is generated if "
+ (var "config")
+ " does not support rendering to
+ windows (e.g., "
+ (code "GLX_DRAWABLE_TYPE")
+ " does not contain "
+ (code "GLX_WINDOW_BIT")
+ "). ")
+ (para (code "BadWindow")
+ " is generated if "
+ (var "pixmap")
+ " is not a valid window XID. "
+ (code "BadAlloc")
+ " is generated if there is already a GLXFBConfig
+ associated with "
+ (var "pixmap")
+ ". ")
+ (para (code "BadAlloc")
+ " is generated if the X server cannot allocate a new
+ GLX window. ")
+ (para (code "GLXBadFBConfig")
+ " is generated if "
+ (var "config")
+ " is not a valid
+ GLXFBConfig. ")
+ (para)))
+
+(define-gl-procedure
+ glXCreateWindow
+ "glXCreateWindow"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "GLXWindow "
+ (function "glXCreateWindow"))
+ (paramdef "Display * " (parameter "dpy"))
+ (paramdef "GLXFBConfig " (parameter "config"))
+ (paramdef "Window " (parameter "win"))
+ (paramdef
+ "const int * "
+ (parameter "attrib_list"))))
+ '(*fragment*
+ (heading "create an on-screen rendering area")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "dpy")))
+ (para "
+Specifies the connection to the X server. "))
+ (entry (% (heading (var "config")))
+ (para "
+Specifies a GLXFBConfig structure with the desired attributes for the
+ window. "))
+ (entry (% (heading (var "win")))
+ (para "
+Specifies the X window to be used as the rendering area. "))
+ (entry (% (heading (var "attrib_list")))
+ (para "
+Currently unused. This must be set to "
+ (code "NULL")
+ " or be an empty list
+ (i.e., one in which the first element is "
+ (code "None")
+ "). ")))
+ (heading "Description")
+ (para (code "glXCreateWindow")
+ " creates an on-screen rendering area from an existing X window
+ that was created with a visual matching "
+ (var "config")
+ ". The XID of the
+ GLXWindow is returned.
+ Any GLX rendering context that was created with respect to "
+ (var "config")
+ "
+can be used to render into this window.
+ Use "
+ (code "glXMakeContextCurrent")
+ " to associate the rendering area with a GLX
+ rendering context. ")
+ (heading "Errors")
+ (para (code "BadMatch")
+ " is generated if "
+ (var "win")
+ " was not created with a visual
+ that corresponds to "
+ (var "config")
+ ". ")
+ (para (code "BadMatch")
+ " is generated if "
+ (var "config")
+ " does not support rendering to
+ windows (i.e., "
+ (code "GLX_DRAWABLE_TYPE")
+ " does not contain "
+ (code "GLX_WINDOW_BIT")
+ "). ")
+ (para (code "BadWindow")
+ " is generated if "
+ (var "win")
+ " is not a valid pixmap XID. ")
+ (para (code "BadAlloc")
+ " is generated if there is already a GLXFBConfig
+ associated with "
+ (var "win")
+ ". ")
+ (para (code "BadAlloc")
+ " is generated if the X server cannot allocate a new
+ GLX window. ")
+ (para (code "GLXBadFBConfig")
+ " is generated if "
+ (var "config")
+ " is not a valid
+ GLXFBConfig. ")
+ (para)))
+
+(define-gl-procedure
+ glXDestroyContext
+ "glXDestroyContext"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glXDestroyContext"))
+ (paramdef "Display * " (parameter "dpy"))
+ (paramdef "GLXContext " (parameter "ctx"))))
+ '(*fragment*
+ (heading "destroy a GLX context")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "dpy")))
+ (para "
+Specifies the connection to the X server. "))
+ (entry (% (heading (var "ctx")))
+ (para "
+Specifies the GLX context to be destroyed. ")))
+ (heading "Description")
+ (para "
+If the GLX rendering context "
+ (var "ctx")
+ " is not current to any thread, "
+ (code "glXDestroyContext")
+ " destroys it immediately.
+ Otherwise, "
+ (var "ctx")
+ " is destroyed when it becomes not current to any thread.
+ In either case, the resource ID
+ referenced by "
+ (var "ctx")
+ " is freed immediately. ")
+ (heading "Errors")
+ (para (code "GLXBadContext")
+ " is generated if "
+ (var "ctx")
+ " is not a valid GLX context. ")))
+
+(define-gl-procedure
+ glXDestroyGLXPixmap
+ "glXDestroyGLXPixmap"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "void "
+ (function "glXDestroyGLXPixmap"))
+ (paramdef "Display * " (parameter "dpy"))
+ (paramdef "GLXPixmap " (parameter "pix"))))
+ '(*fragment*
+ (heading "destroy a GLX pixmap")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "dpy")))
+ (para "
+Specifies the connection to the X server. "))
+ (entry (% (heading (var "pix")))
+ (para "
+Specifies the GLX pixmap to be destroyed. ")))
+ (heading "Description")
+ (para "
+If the GLX pixmap "
+ (var "pix")
+ " is not current to any client, "
+ (code "glXDestroyGLXPixmap")
+ " destroys it immediately.
+ Otherwise, "
+ (var "pix")
+ " is destroyed when it becomes not current to any client.
+ In either case, the resource ID
+ is freed immediately. ")
+ (heading "Errors")
+ (para (code "GLXBadPixmap")
+ " is generated if "
+ (var "pix")
+ " is not a valid GLX pixmap. ")))
+
+(define-gl-procedure
+ glXDestroyPbuffer
+ "glXDestroyPbuffer"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glXDestroyPbuffer"))
+ (paramdef "Display * " (parameter "dpy"))
+ (paramdef "GLXPbuffer " (parameter "pbuf"))))
+ '(*fragment*
+ (heading "destroy an off-screen rendering area")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "dpy")))
+ (para "
+Specifies the connection to the X server. "))
+ (entry (% (heading (var "pbuf")))
+ (para "
+Specifies the GLXPbuffer to be destroyed. ")))
+ (heading "Description")
+ (para (code "glXDestroyPbuffer")
+ " destroys a GLXPbuffer created by "
+ (code "glXCreatePbuffer")
+ ". ")
+ (heading "Errors")
+ (para (code "GLXBadPbuffer")
+ " is generated if "
+ (var "pbuf")
+ " is not a valid
+ GLXPbuffer. ")))
+
+(define-gl-procedure
+ glXDestroyPixmap
+ "glXDestroyPixmap"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glXDestroyPixmap"))
+ (paramdef "Display * " (parameter "dpy"))
+ (paramdef "GLXPixmap " (parameter "pixmap"))))
+ '(*fragment*
+ (heading "destroy an off-screen rendering area")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "dpy")))
+ (para "
+Specifies the connection to the X server. "))
+ (entry (% (heading (var "pixmap")))
+ (para "
+Specifies the GLXPixmap to be destroyed. ")))
+ (heading "Description")
+ (para (code "glXDestroyPixmap")
+ " destroys a GLXPixmap created by "
+ (code "glXCreatePixmap")
+ ". ")
+ (heading "Errors")
+ (para (code "GLXBadPixmap")
+ " is generated if "
+ (var "pixmap")
+ " is not a valid
+ GLXPixmap. ")))
+
+(define-gl-procedure
+ glXDestroyWindow
+ "glXDestroyWindow"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glXDestroyWindow"))
+ (paramdef "Display * " (parameter "dpy"))
+ (paramdef "GLXWindow " (parameter "win"))))
+ '(*fragment*
+ (heading "destroy an on-screen rendering area")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "dpy")))
+ (para "
+Specifies the connection to the X server. "))
+ (entry (% (heading (var "win")))
+ (para "
+Specifies the GLXWindow to be destroyed. ")))
+ (heading "Description")
+ (para (code "glXDestroyWindow")
+ " destroys a GLXWindow created by "
+ (code "glXCreateWindow")
+ ". ")
+ (heading "Errors")
+ (para (code "GLXBadWindow")
+ " is generated if "
+ (var "win")
+ " is not a valid
+ GLXPixmap. ")))
+
+(define-gl-procedure
+ glXFreeContextEXT
+ "glXFreeContextEXT"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glXFreeContextEXT"))
+ (paramdef "Display * " (parameter "dpy"))
+ (paramdef "GLXContext " (parameter "ctx"))))
+ '(*fragment*
+ (heading
+ "free client-side memory for imported context")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "dpy")))
+ (para "
+Specifies the connection to the X server. "))
+ (entry (% (heading (var "ctx")))
+ (para "
+Specifies a GLX rendering context. ")))
+ (heading "Description")
+ (para (code "glXFreeContextEXT")
+ " frees the client-side part of a GLXContext that
+ was created with "
+ (code "glXImportContextEXT")
+ ". "
+ (code "glXFreeContextEXT")
+ " does not
+ free the server-side context information or the XID
+ associated with the server-side context. ")
+ (para (code "glXFreeContextEXT")
+ " is part of the "
+ (code "EXT_import_context")
+ " extension,
+ not part of the core GLX command set. If _glxextstring(EXT_import_context)
+ is included in the string returned by "
+ (code "glXQueryExtensionsString")
+ ",
+ when called with argument "
+ (code "GLX_EXTENSIONS")
+ ",
+ extension "
+ (code "EXT_vertex_array")
+ " is supported. ")
+ (heading "Errors")
+ (para (code "GLXBadContext")
+ " is generated if "
+ (var "ctx")
+ " does not
+ refer to a valid context. ")))
+
+(define-gl-procedure
+ glXGetClientString
+ "glXGetClientString"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "const char * "
+ (function "glXGetClientString"))
+ (paramdef "Display * " (parameter "dpy"))
+ (paramdef "int " (parameter "name"))))
+ '(*fragment*
+ (heading "return a string describing the client")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "dpy")))
+ (para "
+Specifies the connection to the X server. "))
+ (entry (% (heading (var "name")))
+ (para "
+Specifies which string is returned.
+ The symbolic constants "
+ (code "GLX_VENDOR")
+ ", "
+ (code "GLX_VERSION")
+ ",
+ and "
+ (code "GLX_EXTENSIONS")
+ " are accepted. ")))
+ (heading "Description")
+ (para (code "glXGetClientString")
+ " returns a string
+ describing some aspect of the client library. The possible values for "
+ (var "name")
+ " are "
+ (code "GLX_VENDOR")
+ ", "
+ (code "GLX_VERSION")
+ ", and "
+ (code "GLX_EXTENSIONS")
+ ". If "
+ (var "name")
+ " is not set to one of these values, "
+ (code "glXGetClientString")
+ " returns "
+ (code "NULL")
+ ".
+ The format and contents of the vendor string is implementation dependent. ")
+ (para "
+The extensions string is null-terminated and contains a
+ space-separated list of extension names. (The extension names never
+ contain spaces.)
+ If there are no extensions to GLX, then the empty string is returned. ")
+ (para "
+The version string is laid out as follows: ")
+ (para "
+<major_version.minor_version><space><vendor-specific info> ")
+ (para "
+Both the major and minor portions of the version number are of arbitrary
+ length. The vendor-specific information is optional. However, if it is
+ present, the format and contents are implementation specific. ")))
+
+(define-gl-procedure
+ glXGetConfig
+ "glXGetConfig"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "int " (function "glXGetConfig"))
+ (paramdef "Display * " (parameter "dpy"))
+ (paramdef "XVisualInfo * " (parameter "vis"))
+ (paramdef "int " (parameter "attrib"))
+ (paramdef "int * " (parameter "value"))))
+ '(*fragment*
+ (heading "return information about GLX visuals")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "dpy")))
+ (para "
+Specifies the connection to the X server. "))
+ (entry (% (heading (var "vis")))
+ (para "
+Specifies the visual to be queried.
+ It is a pointer to an "
+ (code "XVisualInfo")
+ " structure,
+ not a visual ID or a pointer to a "
+ (code "Visual")
+ ". "))
+ (entry (% (heading (var "attrib")))
+ (para "
+Specifies the visual attribute to be returned. "))
+ (entry (% (heading (var "value")))
+ (para "
+Returns the requested value. ")))
+ (heading "Description")
+ (para (code "glXGetConfig")
+ " sets "
+ (var "value")
+ " to the "
+ (var "attrib")
+ " value of windows or GLX pixmaps
+ created with respect to "
+ (var "vis")
+ ". "
+ (code "glXGetConfig")
+ " returns an error code if it fails for any reason.
+ Otherwise, zero is returned. ")
+ (para (var "attrib")
+ " is one of the following: ")
+ (para)
+ (table (% (formatter (asis)))
+ (entry (% (heading (code "GLX_USE_GL")))
+ (para (code "True")
+ " if OpenGL rendering is supported by this visual, "
+ (code "False")
+ " otherwise. "))
+ (entry (% (heading (code "GLX_BUFFER_SIZE")))
+ (para "
+Number of bits per color buffer.
+ For RGBA visuals, "
+ (code "GLX_BUFFER_SIZE")
+ " is the sum of "
+ (code "GLX_RED_SIZE")
+ ", "
+ (code "GLX_GREEN_SIZE")
+ ", "
+ (code "GLX_BLUE_SIZE")
+ ", and "
+ (code "GLX_ALPHA_SIZE")
+ ".
+ For color index visuals, "
+ (code "GLX_BUFFER_SIZE")
+ " is the size of the
+ color indexes. "))
+ (entry (% (heading (code "GLX_LEVEL")))
+ (para "
+Frame buffer level of the visual.
+ Level zero is the default frame buffer.
+ Positive levels correspond to frame buffers that overlay the default buffer,
+ and negative levels correspond to frame buffers that underlay the default
+ buffer. "))
+ (entry (% (heading (code "GLX_RGBA")))
+ (para (code "True")
+ " if color buffers store red, green, blue, and alpha values. "
+ (code "False")
+ " if they store color indexes. "))
+ (entry (% (heading (code "GLX_DOUBLEBUFFER")))
+ (para (code "True")
+ " if color buffers exist in front/back pairs that can be swapped, "
+ (code "False")
+ " otherwise. "))
+ (entry (% (heading (code "GLX_STEREO")))
+ (para (code "True")
+ " if color buffers exist in left/right pairs, "
+ (code "False")
+ " otherwise. "))
+ (entry (% (heading (code "GLX_AUX_BUFFERS")))
+ (para "
+Number of auxiliary color buffers that are available.
+ Zero indicates that no auxiliary color buffers exist. "))
+ (entry (% (heading (code "GLX_RED_SIZE")))
+ (para "
+Number of bits of red stored in each color buffer.
+ Undefined if "
+ (code "GLX_RGBA")
+ " is "
+ (code "False")
+ ". "))
+ (entry (% (heading (code "GLX_GREEN_SIZE")))
+ (para "
+Number of bits of green stored in each color buffer.
+ Undefined if "
+ (code "GLX_RGBA")
+ " is "
+ (code "False")
+ ". "))
+ (entry (% (heading (code "GLX_BLUE_SIZE")))
+ (para "
+Number of bits of blue stored in each color buffer.
+ Undefined if "
+ (code "GLX_RGBA")
+ " is "
+ (code "False")
+ ". "))
+ (entry (% (heading (code "GLX_ALPHA_SIZE")))
+ (para "
+Number of bits of alpha stored in each color buffer.
+ Undefined if "
+ (code "GLX_RGBA")
+ " is "
+ (code "False")
+ ". "))
+ (entry (% (heading (code "GLX_DEPTH_SIZE")))
+ (para "
+Number of bits in the depth buffer. "))
+ (entry (% (heading (code "GLX_STENCIL_SIZE")))
+ (para "
+Number of bits in the stencil buffer. "))
+ (entry (% (heading (code "GLX_ACCUM_RED_SIZE")))
+ (para "
+Number of bits of red stored in the accumulation buffer. "))
+ (entry (% (heading (code "GLX_ACCUM_GREEN_SIZE")))
+ (para "
+Number of bits of green stored in the accumulation buffer. "))
+ (entry (% (heading (code "GLX_ACCUM_BLUE_SIZE")))
+ (para "
+Number of bits of blue stored in the accumulation buffer. "))
+ (entry (% (heading (code "GLX_ACCUM_ALPHA_SIZE")))
+ (para "
+Number of bits of alpha stored in the accumulation buffer. ")))
+ (para "
+The X protocol allows a single visual ID to be instantiated with
+ different numbers of bits per pixel.
+ Windows or GLX pixmaps that will be rendered with OpenGL, however,
+ must be instantiated with a color buffer depth of "
+ (code "GLX_BUFFER_SIZE")
+ ". ")
+ (para "
+Although a GLX implementation can export many visuals that support GL
+ rendering,
+ it must support
+ at least one RGBA visual. This visual must have at
+ least one color buffer,
+ a stencil buffer of at least 1 bit,
+ a depth buffer of at least 12 bits,
+ and an accumulation buffer.
+ Alpha bitplanes are optional in this visual.
+ However,
+ its color buffer size must be as great as that of the
+ deepest "
+ (code "TrueColor")
+ ", "
+ (code "DirectColor")
+ ", "
+ (code "PseudoColor")
+ ", or "
+ (code "StaticColor")
+ " visual supported on level zero,
+ and it must itself be made available on level zero. ")
+ (para "
+In addition, if the X server exports a "
+ (code "PseudoColor")
+ " or "
+ (code "StaticColor")
+ " visual on framebuffer level 0, a color index
+ visual is also required on that level.
+ It must have
+ at least one color buffer,
+ a stencil buffer of at least 1 bit,
+ and a depth buffer of at least 12 bits.
+ This visual must
+ have as many
+ color bitplanes as the deepest "
+ (code "PseudoColor")
+ " or "
+ (code "StaticColor")
+ " visual supported on level 0. ")
+ (para "
+Applications are best written to select the visual that most closely
+ meets their requirements.
+ Creating windows or GLX pixmaps with unnecessary buffers can result in
+ reduced rendering performance as well as poor resource allocation. ")
+ (heading "Errors")
+ (para (code "GLX_NO_EXTENSION")
+ " is returned if "
+ (var "dpy")
+ " does not support the GLX
+ extension. ")
+ (para (code "GLX_BAD_SCREEN")
+ " is returned if the screen of "
+ (var "vis")
+ " does not correspond
+ to a screen. ")
+ (para (code "GLX_BAD_ATTRIBUTE")
+ " is returned if "
+ (var "attrib")
+ " is not a valid GLX attribute. ")
+ (para (code "GLX_BAD_VISUAL")
+ " is returned if "
+ (var "vis")
+ " doesn't support GLX and an
+ attribute other than "
+ (code "GLX_USE_GL")
+ " is requested. ")))
+
+(define-gl-procedure
+ glXGetContextIDEXT
+ "glXGetContextIDEXT"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "GLXContextID "
+ (function "glXGetContextIDEXT"))
+ (paramdef "const GLXContext " (parameter "ctx"))))
+ '(*fragment*
+ (heading "get the XID for a context.")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "ctx")))
+ (para "
+Specifies a GLX rendering context. ")))
+ (heading "Description")
+ (para (code "glXGetContextIDEXT")
+ " returns the XID associated with a GLXContext. ")
+ (para "
+No round trip is forced to the server; unlike most X calls that
+ return a value, "
+ (code "glXGetContextIDEXT")
+ " does not flush any pending events. ")
+ (para (code "glXGetContextIDEXT")
+ " is part of the "
+ (code "EXT_import_context")
+ " extension,
+ not part of the core GLX command set. If _glxextstring(EXT_import_context)
+ is included in the string returned by "
+ (code "glXQueryExtensionsString")
+ ",
+ when called with argument "
+ (code "GLX_EXTENSIONS")
+ ",
+ extension "
+ (code "EXT_import_context")
+ " is supported. ")
+ (heading "Errors")
+ (para (code "GLXBadContext")
+ " is generated if "
+ (var "ctx")
+ " does not
+ refer to a valid context. ")))
+
+(define-gl-procedure
+ glXGetCurrentContext
+ "glXGetCurrentContext"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "GLXContext "
+ (function "glXGetCurrentContext"))))
+ '(*fragment*
+ (heading "return the current context")
+ (heading "Description")
+ (para (code "glXGetCurrentContext")
+ " returns the current context,
+ as specified by "
+ (code "glXMakeCurrent")
+ ".
+ If there is no current context, "
+ (code "NULL")
+ " is returned. ")
+ (para (code "glXGetCurrentContext")
+ " returns client-side information.
+ It does not make a round trip to the server. ")
+ (para)))
+
+(define-gl-procedure
+ glXGetCurrentDisplay
+ "glXGetCurrentDisplay"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "Display * "
+ (function "glXGetCurrentDisplay"))))
+ '(*fragment*
+ (heading "get display for current context")
+ (heading "Description")
+ (para (code "glXGetCurrentDisplay")
+ " returns the display for the current context. If no
+ context is current, "
+ (code "NULL")
+ " is returned. ")
+ (para (code "glXGetCurrentDisplay")
+ " returns client-side information. It does not make a round-trip
+ to the server, and therefore does not flush any pending events. ")))
+
+(define-gl-procedure
+ glXGetCurrentDrawable
+ "glXGetCurrentDrawable"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "GLXDrawable "
+ (function "glXGetCurrentDrawable"))))
+ '(*fragment*
+ (heading "return the current drawable")
+ (heading "Description")
+ (para (code "glXGetCurrentDrawable")
+ " returns the current drawable,
+ as specified by "
+ (code "glXMakeCurrent")
+ ".
+ If there is no current drawable, "
+ (code "None")
+ " is returned. ")
+ (para (code "glXGetCurrentDrawable")
+ " returns client-side information.
+ It does not make a round trip to the server. ")))
+
+(define-gl-procedure
+ glXGetCurrentReadDrawable
+ "glXGetCurrentReadDrawable"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "GLXDrawable "
+ (function "glXGetCurrentReadDrawable"))))
+ '(*fragment*
+ (heading "return the current drawable")
+ (heading "Description")
+ (para (code "glXGetCurrentReadDrawable")
+ " returns the current read drawable,
+ as specified by "
+ (code "read")
+ " parameter
+ of "
+ (code "glXMakeContextCurrent")
+ ".
+ If there is no current drawable, "
+ (code "None")
+ " is returned. ")
+ (para (code "glXGetCurrentReadDrawable")
+ " returns client-side information.
+ It does not make a round-trip to the server. ")))
+
+(define-gl-procedure
+ glXGetFBConfigAttrib
+ "glXGetFBConfigAttrib"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "int "
+ (function "glXGetFBConfigAttrib"))
+ (paramdef "Display * " (parameter "dpy"))
+ (paramdef "GLXFBConfig " (parameter "config"))
+ (paramdef "int " (parameter "attribute"))
+ (paramdef "int * " (parameter "value"))))
+ '(*fragment*
+ (heading
+ "return information about a GLX frame buffer configuration")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "dpy")))
+ (para "
+Specifies the connection to the X server. "))
+ (entry (% (heading (var "config")))
+ (para "
+Specifies the GLX frame buffer configuration to be queried. "))
+ (entry (% (heading (var "attribute")))
+ (para "
+Specifies the attribute to be returned. "))
+ (entry (% (heading (var "value")))
+ (para "
+Returns the requested value. ")))
+ (heading "Description")
+ (para (code "glXGetFBConfigAttrib")
+ " sets "
+ (var "value")
+ " to the "
+ (var "attribute")
+ " value of GLX drawables
+ created with respect to "
+ (var "config")
+ ". "
+ (code "glXGetFBConfigAttrib")
+ " returns an error code if it fails for any reason.
+ Otherwise, "
+ (code "Success")
+ " is returned. ")
+ (para (var "attribute")
+ " is one of the following: ")
+ (para)
+ (table (% (formatter (asis)))
+ (entry (% (heading (code "GLX_FBCONFIG_ID")))
+ (para "
+XID of the given GLXFBConfig. "))
+ (entry (% (heading (code "GLX_BUFFER_SIZE")))
+ (para)
+ (para "
+Number of bits per color buffer.
+ If the frame buffer configuration supports RGBA contexts, then "
+ (code "GLX_BUFFER_SIZE")
+ " is the sum of "
+ (code "GLX_RED_SIZE")
+ ", "
+ (code "GLX_GREEN_SIZE")
+ ", "
+ (code "GLX_BLUE_SIZE")
+ ", and "
+ (code "GLX_ALPHA_SIZE")
+ ".
+ If the frame buffer configuration supports only color index contexts, "
+ (code "GLX_BUFFER_SIZE")
+ " is the size of the
+ color indexes. "))
+ (entry (% (heading (code "GLX_LEVEL")))
+ (para)
+ (para "
+Frame buffer level of the configuration.
+ Level zero is the default frame buffer.
+ Positive levels correspond to frame buffers that overlay the default buffer,
+ and negative levels correspond to frame buffers that underlie the default
+ buffer. "))
+ (entry (% (heading (code "GLX_DOUBLEBUFFER")))
+ (para)
+ (para (code "True")
+ " if color buffers exist in front/back pairs that can be swapped, "
+ (code "False")
+ " otherwise. "))
+ (entry (% (heading (code "GLX_STEREO")))
+ (para)
+ (para (code "True")
+ " if color buffers exist in left/right pairs, "
+ (code "False")
+ " otherwise. "))
+ (entry (% (heading (code "GLX_AUX_BUFFERS")))
+ (para)
+ (para "
+Number of auxiliary color buffers that are available.
+ Zero indicates that no auxiliary color buffers exist. "))
+ (entry (% (heading (code "GLX_RED_SIZE")))
+ (para)
+ (para "
+Number of bits of red stored in each color buffer.
+ Undefined if RGBA contexts are not supported by the frame buffer configuration. "))
+ (entry (% (heading (code "GLX_GREEN_SIZE")))
+ (para)
+ (para "
+Number of bits of green stored in each color buffer.
+ Undefined if RGBA contexts are not supported by the frame buffer configuration. "))
+ (entry (% (heading (code "GLX_BLUE_SIZE")))
+ (para)
+ (para "
+Number of bits of blue stored in each color buffer.
+ Undefined if RGBA contexts are not supported by the frame buffer configuration. "))
+ (entry (% (heading (code "GLX_ALPHA_SIZE")))
+ (para)
+ (para "
+Number of bits of alpha stored in each color buffer.
+ Undefined if RGBA contexts are not supported by the frame buffer configuration. "))
+ (entry (% (heading (code "GLX_DEPTH_SIZE")))
+ (para)
+ (para "
+Number of bits in the depth buffer. "))
+ (entry (% (heading (code "GLX_STENCIL_SIZE")))
+ (para)
+ (para "
+Number of bits in the stencil buffer. "))
+ (entry (% (heading (code "GLX_ACCUM_RED_SIZE")))
+ (para)
+ (para "
+Number of bits of red stored in the accumulation buffer. "))
+ (entry (% (heading (code "GLX_ACCUM_GREEN_SIZE")))
+ (para)
+ (para "
+Number of bits of green stored in the accumulation buffer. "))
+ (entry (% (heading (code "GLX_ACCUM_BLUE_SIZE")))
+ (para)
+ (para "
+Number of bits of blue stored in the accumulation buffer. "))
+ (entry (% (heading (code "GLX_ACCUM_ALPHA_SIZE")))
+ (para)
+ (para "
+Number of bits of alpha stored in the accumulation buffer. "))
+ (entry (% (heading (code "GLX_RENDER_TYPE")))
+ (para)
+ (para "
+Mask indicating what type of GLX contexts can be made
+ current to the frame buffer configuration. Valid bits are "
+ (code "GLX_RGBA_BIT")
+ " and "
+ (code "GLX_COLOR_INDEX_BIT")
+ ". "))
+ (entry (% (heading (code "GLX_DRAWABLE_TYPE")))
+ (para)
+ (para "
+Mask indicating what drawable types the frame buffer configuration
+ supports. Valid bits are "
+ (code "GLX_WINDOW_BIT")
+ ", "
+ (code "GLX_PIXMAP_BIT")
+ ", and "
+ (code "GLX_PBUFFER_BIT")
+ ". "))
+ (entry (% (heading (code "GLX_X_RENDERABLE")))
+ (para)
+ (para (code "True")
+ " if drawables created with the
+ frame buffer configuration can be rendered to by X. "))
+ (entry (% (heading (code "GLX_VISUAL_ID")))
+ (para)
+ (para "
+XID of the corresponding visual, or zero
+ if there is no associated visual (i.e., if "
+ (code "GLX_X_RENDERABLE")
+ " is "
+ (code "False")
+ " or "
+ (code "GLX_DRAWABLE_TYPE")
+ " does not have the "
+ (code "GLX_WINDOW_BIT")
+ " bit set). "))
+ (entry (% (heading (code "GLX_X_VISUAL_TYPE")))
+ (para)
+ (para "
+Visual type of associated visual. The returned value will be one of: "
+ (code "GLX_TRUE_COLOR")
+ ", "
+ (code "GLX_DIRECT_COLOR")
+ ", "
+ (code "GLX_PSEUDO_COLOR")
+ ", "
+ (code "GLX_STATIC_COLOR")
+ ", "
+ (code "GLX_GRAY_SCALE")
+ ", "
+ (code "GLX_STATIC_GRAY")
+ ",
+ or "
+ (code "GLX_NONE")
+ ", if there is no associated visual (i.e., if "
+ (code "GLX_X_RENDERABLE")
+ " is "
+ (code "False")
+ " or "
+ (code "GLX_DRAWABLE_TYPE")
+ " does not have the "
+ (code "GLX_WINDOW_BIT")
+ " bit set). "))
+ (entry (% (heading (code "GLX_CONFIG_CAVEAT")))
+ (para)
+ (para "
+One of "
+ (code "GLX_NONE")
+ ", "
+ (code "GLX_SLOW_CONFIG")
+ ", or "
+ (code "GLX_NON_CONFORMANT_CONFIG")
+ ", indicating
+ that the frame buffer configuration has no caveats,
+ some aspect of the frame buffer configuration runs slower
+ than other frame buffer configurations, or some aspect of the
+ frame buffer configuration is nonconformant, respectively. "))
+ (entry (% (heading (code "GLX_TRANSPARENT_TYPE")))
+ (para)
+ (para "
+One of "
+ (code "GLX_NONE")
+ ", "
+ (code "GLX_TRANSPARENT_RGB")
+ ", "
+ (code "GLX_TRANSPARENT_INDEX")
+ ", indicating that
+ the frame buffer configuration is opaque, is transparent for particular
+ values of red, green, and blue, or is transparent for
+ particular index values, respectively. "))
+ (entry (% (heading (code "GLX_TRANSPARENT_INDEX_VALUE")))
+ (para)
+ (para "
+Integer value between 0 and the maximum
+ frame buffer value for indices, indicating the transparent
+ index value for the frame buffer configuration.
+ Undefined if "
+ (code "GLX_TRANSPARENT_TYPE")
+ "
+is not "
+ (code "GLX_TRANSPARENT_INDEX")
+ ". "))
+ (entry (% (heading (code "GLX_TRANSPARENT_RED_VALUE")))
+ (para)
+ (para "
+Integer value between 0 and the maximum
+ frame buffer value for red, indicating the transparent
+ red value for the frame buffer configuration.
+ Undefined if "
+ (code "GLX_TRANSPARENT_TYPE")
+ "
+is not "
+ (code "GLX_TRANSPARENT_RGB")
+ ". "))
+ (entry (% (heading (code "GLX_TRANSPARENT_GREEN_VALUE")))
+ (para)
+ (para "
+Integer value between 0 and the maximum
+ frame buffer value for green, indicating the transparent
+ green value for the frame buffer configuration.
+ Undefined if "
+ (code "GLX_TRANSPARENT_TYPE")
+ "
+is not "
+ (code "GLX_TRANSPARENT_RGB")
+ ". "))
+ (entry (% (heading (code "GLX_TRANSPARENT_BLUE_VALUE")))
+ (para)
+ (para "
+Integer value between 0 and the maximum
+ frame buffer value for blue, indicating the transparent
+ blue value for the frame buffer configuration.
+ Undefined if "
+ (code "GLX_TRANSPARENT_TYPE")
+ "
+is not "
+ (code "GLX_TRANSPARENT_RGB")
+ ". "))
+ (entry (% (heading (code "GLX_TRANSPARENT_ALPHA_VALUE")))
+ (para)
+ (para "
+Integer value between 0 and the maximum
+ frame buffer value for alpha, indicating the transparent
+ blue value for the frame buffer configuration.
+ Undefined if "
+ (code "GLX_TRANSPARENT_TYPE")
+ "
+is not "
+ (code "GLX_TRANSPARENT_RGB")
+ ". "))
+ (entry (% (heading (code "GLX_MAX_PBUFFER_WIDTH")))
+ (para)
+ (para "
+The maximum width that can be specified to "
+ (code "glXCreatePbuffer")
+ ". "))
+ (entry (% (heading (code "GLX_MAX_PBUFFER_HEIGHT")))
+ (para)
+ (para "
+The maximum height that can be specified to "
+ (code "glXCreatePbuffer")
+ ". "))
+ (entry (% (heading (code "GLX_MAX_PBUFFER_PIXELS")))
+ (para)
+ (para "
+The maximum number of pixels (width times height) for a
+ pixel buffer. Note that this value may be less than "
+ (code "GLX_MAX_PBUFFER_WIDTH")
+ " times "
+ (code "GLX_MAX_PBUFFER_HEIGHT")
+ ". Also, this
+ value is static and assumes that no other pixel buffers
+ or X resources are contending for the frame buffer memory.
+ As a result, it may not be possible to allocate a pixel buffer of
+ the size given by "
+ (code "GLX_MAX_PBUFFER_PIXELS")
+ ". ")))
+ (para "
+Applications should choose the frame buffer configuration that most closely
+ meets their requirements.
+ Creating windows, GLX pixmaps, or GLX pixel buffers with unnecessary buffers
+ can result in
+ reduced rendering performance as well as poor resource allocation. ")
+ (heading "Errors")
+ (para (code "GLX_NO_EXTENSION")
+ " is returned if "
+ (var "dpy")
+ " does not support the GLX
+ extension. "
+ (code "GLX_BAD_ATTRIBUTE")
+ " is returned if "
+ (var "attribute")
+ " is not a valid GLX attribute. ")))
+
+(define-gl-procedure
+ glXGetFBConfigs
+ "glXGetFBConfigs"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "GLXFBConfig * "
+ (function "glXGetFBConfigs"))
+ (paramdef "Display * " (parameter "dpy"))
+ (paramdef "int " (parameter "screen"))
+ (paramdef "int * " (parameter "nelements"))))
+ '(*fragment*
+ (heading
+ "list all GLX frame buffer configurations for a given screen")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "dpy")))
+ (para "
+Specifies the connection to the X server. "))
+ (entry (% (heading (var "screen")))
+ (para "
+Specifies the screen number. "))
+ (entry (% (heading (var "nelements")))
+ (para "
+Returns the number of GLXFBConfigs returned. ")))
+ (heading "Description")
+ (para (code "glXGetFBConfigs")
+ " returns a list of all GLXFBConfigs available on the screen
+ specified by "
+ (var "screen")
+ ". Use "
+ (code "glXGetFBConfigAttrib")
+ " to obtain attribute
+ values from a specific GLXFBConfig. ")))
+
+(define-gl-procedure
+ glXGetProcAddress
+ "glXGetProcAddress"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "void(*)() "
+ (function "glXGetProcAddress"))
+ (paramdef
+ "const GLubyte * "
+ (parameter "procName"))))
+ '(*fragment*
+ (heading
+ "obtain a pointer to an OpenGL or GLX function")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "procName")))
+ (para "
+Specifies the name of the OpenGL or GLX function whose address is to be returned. ")))
+ (heading "Description")
+ (para (code "glXGetProcAddress")
+ " returns the address of the function specified in "
+ (var "procName")
+ ". This is
+ necessary in environments where the OpenGL link library exports a different
+ set of functions than the runtime library. ")))
+
+(define-gl-procedure
+ glXGetSelectedEvent
+ "glXGetSelectedEvent"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "void "
+ (function "glXGetSelectedEvent"))
+ (paramdef "Display * " (parameter "dpy"))
+ (paramdef "GLXDrawable " (parameter "draw"))
+ (paramdef
+ "unsigned long * "
+ (parameter "event_mask"))))
+ '(*fragment*
+ (heading
+ "returns GLX events that are selected for a window or a GLX pixel buffer")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "dpy")))
+ (para "
+Specifies the connection to the X server. "))
+ (entry (% (heading (var "draw")))
+ (para "
+Specifies a GLX drawable. Must be a GLX pixel buffer or a window. "))
+ (entry (% (heading (var "event_mask")))
+ (para "
+Returns the events that are selected for "
+ (var "draw")
+ ". ")))
+ (heading "Description")
+ (para (code "glXGetSelectedEvent")
+ " returns in "
+ (var "event_mask")
+ " the events selected for "
+ (var "draw")
+ ". ")
+ (heading "Errors")
+ (para (code "GLXBadDrawable")
+ " is generated if "
+ (var "draw")
+ " is not a valid window
+ or a valid GLX pixel buffer. ")))
+
+(define-gl-procedure
+ glXGetVisualFromFBConfig
+ "glXGetVisualFromFBConfig"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "XVisualInfo * "
+ (function "glXGetVisualFromFBConfig"))
+ (paramdef "Display * " (parameter "dpy"))
+ (paramdef "GLXFBConfig " (parameter "config"))))
+ '(*fragment*
+ (heading
+ "return visual that is associated with the frame buffer configuration")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "dpy")))
+ (para "
+Specifies the connection to the X server. "))
+ (entry (% (heading (var "config")))
+ (para "
+Specifies the GLX frame buffer configuration. ")))
+ (heading "Description")
+ (para "
+If "
+ (var "config")
+ " is a valid GLX frame buffer configuration
+ and it has an associated X Visual, then
+ information describing that visual is returned; otherwise "
+ (code "NULL")
+ "
+is returned. Use "
+ (code "XFree")
+ " to free the data returned. ")
+ (heading "Errors")
+ (para "
+Returns "
+ (code "NULL")
+ " if "
+ (var "config")
+ " is not a valid GLXFBConfig. ")))
+
+(define-gl-procedure
+ glXImportContextEXT
+ "glXImportContextEXT"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "GLXContext "
+ (function "glXImportContextEXT"))
+ (paramdef "Display * " (parameter "dpy"))
+ (paramdef
+ "GLXContextID "
+ (parameter "contextID"))))
+ '(*fragment*
+ (heading
+ "import another process's indirect rendering context.")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "dpy")))
+ (para "
+Specifies the connection to the X server. "))
+ (entry (% (heading (var "contextID")))
+ (para "
+Specifies a GLX rendering context. ")))
+ (heading "Description")
+ (para (code "glXImportContextEXT")
+ " creates a GLXContext given the XID of an existing GLXContext.
+ It may be used in place of "
+ (code "glXCreateContext")
+ ",
+ to share another process's indirect rendering context. ")
+ (para "
+Only the server-side context information can be shared between
+ X clients; client-side state, such as pixel storage modes,
+ cannot be shared. Thus, "
+ (code "glXImportContextEXT")
+ " must allocate memory to store
+ client-side information. This memory is freed by calling "
+ (code "glXFreeContextEXT")
+ ". ")
+ (para "
+This call does not create a new XID. It merely makes an
+ existing object available to the importing client (Display *).
+ Like any XID, it goes away when the creating client drops its
+ connection or the ID is explicitly deleted. Note that this is
+ when the XID goes away. The object goes away when the XID
+ goes away AND the context is not current to any thread. ")
+ (para "
+If "
+ (var "contextID")
+ " refers to a
+ direct rendering context then no error is generated but "
+ (code "glXImportContextEXT")
+ " returns NULL. ")
+ (para (code "glXImportContextEXT")
+ " is part of the "
+ (code "EXT_import_context")
+ " extension,
+ not part of the core GLX command set. If _glxextstring(EXT_import_context)
+ is included in the string returned by "
+ (code "glXQueryExtensionsString")
+ ",
+ when called with argument "
+ (code "GLX_EXTENSIONS")
+ ",
+ extension "
+ (code "EXT_import_context")
+ " is supported. ")
+ (heading "Errors")
+ (para (code "GLXBadContext")
+ " is generated if "
+ (var "contextID")
+ " does not
+ refer to a valid context. ")))
+
+(define-gl-procedure
+ glXIntro
+ "glXIntro"
+ #f
+ '(*fragment*
+ (heading
+ "Introduction to OpenGL in the X window system")))
+
+(define-gl-procedure
+ glXIsDirect
+ "glXIsDirect"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "Bool " (function "glXIsDirect"))
+ (paramdef "Display * " (parameter "dpy"))
+ (paramdef "GLXContext " (parameter "ctx"))))
+ '(*fragment*
+ (heading
+ "indicate whether direct rendering is enabled")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "dpy")))
+ (para "
+Specifies the connection to the X server. "))
+ (entry (% (heading (var "ctx")))
+ (para "
+Specifies the GLX context that is being queried. ")))
+ (heading "Description")
+ (para (code "glXIsDirect")
+ " returns "
+ (code "True")
+ " if "
+ (var "ctx")
+ " is a direct rendering context, "
+ (code "False")
+ " otherwise.
+ Direct rendering contexts pass rendering commands directly from the calling
+ process's address space to the rendering system,
+ bypassing the X server.
+ Nondirect rendering contexts pass all rendering commands to the X server. ")
+ (heading "Errors")
+ (para (code "GLXBadContext")
+ " is generated if "
+ (var "ctx")
+ " is not a valid GLX context. ")))
+
+(define-gl-procedure
+ glXMakeContextCurrent
+ "glXMakeContextCurrent"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "Bool "
+ (function "glXMakeContextCurrent"))
+ (paramdef "Display * " (parameter "display"))
+ (paramdef "GLXDrawable " (parameter "draw"))
+ (paramdef "GLXDrawable " (parameter "read"))
+ (paramdef "GLXContext " (parameter "ctx"))))
+ '(*fragment*
+ (heading
+ "attach a GLX context to a GLX drawable")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "display")))
+ (para "
+Specifies the connection to the X server. "))
+ (entry (% (heading (var "draw")))
+ (para "
+Specifies a GLX drawable to render into.
+ Must be an XID representing a GLXWindow, GLXPixmap, or GLXPbuffer. "))
+ (entry (% (heading (var "read")))
+ (para "
+Specifies a GLX drawable to read from.
+ Must be an XID representing a GLXWindow, GLXPixmap, or GLXPbuffer. "))
+ (entry (% (heading (var "ctx")))
+ (para "
+Specifies the GLX context to be bound to "
+ (var "read")
+ " and "
+ (var "ctx")
+ ". ")))
+ (heading "Description")
+ (para (code "glXMakeContextCurrent")
+ " binds "
+ (var "ctx")
+ " to the current rendering thread and to the "
+ (var "draw")
+ "
+and "
+ (var "read")
+ " GLX drawables. "
+ (var "draw")
+ " and "
+ (var "read")
+ " may be the same. ")
+ (para (var "draw")
+ " is used for all OpenGL operations except: ")
+ (para "
+Any pixel data that are read based on the value of "
+ (code "GLX_READ_BUFFER")
+ ".
+ Note that accumulation operations use the value of "
+ (code "GLX_READ_BUFFER")
+ ",
+ but are not allowed unless "
+ (var "draw")
+ " is identical to "
+ (var "read")
+ ". ")
+ (para "
+Any depth values that are retrieved by "
+ (code "glReadPixels")
+ " or "
+ (code "glCopyPixels")
+ ". ")
+ (para "
+Any stencil values that are retrieved by "
+ (code "glReadPixels")
+ " or "
+ (code "glCopyPixels")
+ ". ")
+ (para "
+Frame buffer values are taken from "
+ (var "draw")
+ ". ")
+ (para "
+If the current rendering thread has a current rendering context, that
+ context is flushed and replaced by "
+ (var "ctx")
+ ". ")
+ (para "
+The first time that "
+ (var "ctx")
+ " is made current, the viewport and scissor
+ dimensions are set to the size of the "
+ (var "draw")
+ " drawable. The viewport
+ and scissor are not modified when "
+ (var "ctx")
+ " is subsequently made current. ")
+ (para "
+To release the current context without assigning a new one,
+ call "
+ (code "glXMakeContextCurrent")
+ " with "
+ (var "draw")
+ " and "
+ (var "read")
+ " set to "
+ (code "None")
+ " and "
+ (var "ctx")
+ "
+set to "
+ (code "NULL")
+ ". ")
+ (para (code "glXMakeContextCurrent")
+ " returns "
+ (code "True")
+ " if it is successful, "
+ (code "False")
+ " otherwise.
+ If "
+ (code "False")
+ " is returned, the previously current rendering context
+ and drawable (if any) remain unchanged. ")
+ (heading "Errors")
+ (para (code "BadMatch")
+ " is generated if "
+ (var "draw")
+ " and "
+ (var "read")
+ " are not compatible. ")
+ (para (code "BadAccess")
+ " is generated if "
+ (var "ctx")
+ " is current to some other
+ thread. ")
+ (para (code "GLXContextState")
+ " is generated if there is a current rendering
+ context and its render mode is either "
+ (code "GLX_FEEDBACK")
+ " or "
+ (code "GLX_SELECT")
+ ". ")
+ (para (code "GLXBadContext")
+ " is generated if "
+ (var "ctx")
+ " is not a valid GLX
+ rendering context. ")
+ (para (code "GLXBadDrawable")
+ " is generated if "
+ (var "draw")
+ " or "
+ (var "read")
+ " is not a valid
+ GLX drawable. ")
+ (para (code "GLXBadWindow")
+ " is generated if the underlying X window for either "
+ (var "draw")
+ " or "
+ (var "read")
+ " is no longer valid. ")
+ (para (code "GLXBadCurrentDrawable")
+ " is generated if the previous context of
+ the calling thread has unflushed commands and the previous drawable is
+ no longer valid. ")
+ (para (code "BadAlloc")
+ " is generated if the X server does not have enough
+ resources to allocate the buffers. ")
+ (para (code "BadMatch") " is generated if: ")
+ (para (var "draw")
+ " and "
+ (var "read")
+ " cannot fit into frame buffer memory simultaneously. ")
+ (para (var "draw")
+ " or "
+ (var "read")
+ " is a GLXPixmap and "
+ (var "ctx")
+ " is a direct-rendering
+ context. ")
+ (para (var "draw")
+ " or "
+ (var "read")
+ " is a GLXPixmap and "
+ (var "ctx")
+ " was previously bound to a
+ GLXWindow or GLXPbuffer. ")
+ (para (var "draw")
+ " or "
+ (var "read")
+ " is a GLXWindow or GLXPbuffer and "
+ (var "ctx")
+ " was
+ previously bound to a GLXPixmap. ")))
+
+(define-gl-procedure
+ glXMakeCurrent
+ "glXMakeCurrent"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "Bool " (function "glXMakeCurrent"))
+ (paramdef "Display * " (parameter "dpy"))
+ (paramdef "GLXDrawable " (parameter "drawable"))
+ (paramdef "GLXContext " (parameter "ctx"))))
+ '(*fragment*
+ (heading
+ "attach a GLX context to a window or a GLX pixmap")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "dpy")))
+ (para "
+Specifies the connection to the X server. "))
+ (entry (% (heading (var "drawable")))
+ (para "
+Specifies a GLX drawable.
+ Must be either an X window ID or a GLX pixmap ID. "))
+ (entry (% (heading (var "ctx")))
+ (para "
+Specifies a GLX rendering context that is to be attached to "
+ (var "drawable")
+ ". ")))
+ (heading "Description")
+ (para (code "glXMakeCurrent")
+ " does two things:
+ It makes "
+ (var "ctx")
+ " the current GLX rendering context of the calling thread,
+ replacing the previously current context if there was one,
+ and it attaches "
+ (var "ctx")
+ " to a GLX drawable,
+ either a window or a GLX pixmap.
+ As a result of these two actions,
+ subsequent GL rendering calls
+ use rendering context "
+ (var "ctx")
+ " to modify GLX drawable "
+ (var "drawable")
+ " (for
+ reading and writing).
+ Because "
+ (code "glXMakeCurrent")
+ " always replaces the current rendering context with "
+ (var "ctx")
+ ",
+ there can be only one current context per thread. ")
+ (para "
+Pending commands to the
+ previous context, if any, are flushed before it is released. ")
+ (para "
+The first time "
+ (var "ctx")
+ " is made current to any thread,
+ its viewport is set to the full size of "
+ (var "drawable")
+ ".
+ Subsequent calls by any thread to "
+ (code "glXMakeCurrent")
+ " with "
+ (var "ctx")
+ "
+have no effect on its viewport. ")
+ (para "
+To release the current context without assigning a new one,
+ call "
+ (code "glXMakeCurrent")
+ " with "
+ (var "drawable")
+ " set to "
+ (code "None")
+ " and "
+ (var "ctx")
+ "
+set to "
+ (code "NULL")
+ ". ")
+ (para (code "glXMakeCurrent")
+ " returns "
+ (code "True")
+ " if it is successful, "
+ (code "False")
+ " otherwise.
+ If "
+ (code "False")
+ " is returned, the previously current rendering context
+ and drawable (if any) remain unchanged. ")
+ (heading "Errors")
+ (para (code "BadMatch")
+ " is generated if "
+ (var "drawable")
+ " was not
+ created with the same X screen and visual as "
+ (var "ctx")
+ ".
+ It is also generated if "
+ (var "drawable")
+ " is "
+ (code "None")
+ " and "
+ (var "ctx")
+ " is not "
+ (code "NULL")
+ ". ")
+ (para (code "BadAccess")
+ " is generated if "
+ (var "ctx")
+ " was current to another thread
+ at the time "
+ (code "glXMakeCurrent")
+ " was called. ")
+ (para (code "GLXBadDrawable")
+ " is generated if "
+ (var "drawable")
+ " is not a valid GLX drawable. ")
+ (para (code "GLXBadContext")
+ " is generated if "
+ (var "ctx")
+ " is not a valid GLX context. ")
+ (para (code "GLXBadContextState")
+ " is generated if "
+ (code "glXMakeCurrent")
+ " is executed between
+ the execution of "
+ (code "glBegin")
+ " and the corresponding execution of "
+ (code "glEnd")
+ ". ")
+ (para (code "GLXBadContextState")
+ " is also generated if the rendering context current
+ to the calling thread has GL renderer state "
+ (code "GLX_FEEDBACK")
+ " or "
+ (code "GLX_SELECT")
+ ". ")
+ (para (code "GLXBadCurrentWindow")
+ " is generated if there are pending GL
+ commands for the previous context and the current drawable is
+ a window that is no longer valid. ")
+ (para (code "BadAlloc")
+ " may be generated if the server has delayed allocation
+ of ancillary buffers until "
+ (code "glXMakeCurrent")
+ " is called, only to find that it has
+ insufficient resources to complete the allocation. ")))
+
+(define-gl-procedure
+ glXQueryContextInfoEXT
+ "glXQueryContextInfoEXT"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "int "
+ (function "glXQueryContextInfoEXT"))
+ (paramdef "Display * " (parameter "dpy"))
+ (paramdef "GLXContext " (parameter "ctx"))
+ (paramdef "int " (parameter "attribute"))
+ (paramdef "int * " (parameter "value"))))
+ '(*fragment*
+ (heading "query context information")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "dpy")))
+ (para "
+Specifies the connection to the X server. "))
+ (entry (% (heading (var "ctx")))
+ (para "
+Specifies a GLX rendering context. "))
+ (entry (% (heading (var "attribute")))
+ (para "
+Specifies that a context parameter should be retrieved. Must be one of "
+ (code "GLX_SHARED_CONTEXT_EXT")
+ ", "
+ (code "GLX_VISUAL_ID_EXT")
+ ", or "
+ (code "GLX_SCREEN_EXT")
+ ". "))
+ (entry (% (heading (var "value")))
+ (para "
+Contains the return value for "
+ (var "attribute")
+ ". ")))
+ (heading "Description")
+ (para (code "glXQueryContextInfoEXT")
+ " sets "
+ (var "value")
+ " to the value of "
+ (var "attribute")
+ " with respect to "
+ (var "ctx")
+ ". "
+ (code "glXQueryContextInfoEXT")
+ " returns an error code if it fails for any reason. Otherwise, "
+ (code "Success")
+ " is returned. ")
+ (para (var "attribute")
+ " may be one of the following: ")
+ (table (% (formatter (asis)))
+ (entry (% (heading (code "GLX_SHARED_CONTEXT_EXT")))
+ (para "
+Returns the XID of the share list context associated with "
+ (var "ctx")
+ " at its
+ creation. "))
+ (entry (% (heading (code "GLX_VISUAL_ID_EXT")))
+ (para "
+Returns the XID of the GLX Visual associated with "
+ (var "ctx")
+ ". "))
+ (entry (% (heading (code "GLX_SCREEN_EXT")))
+ (para "
+Returns the screen number associated with "
+ (var "ctx")
+ ". ")))
+ (para "
+This call may cause a round-trip to the server. ")
+ (para (code "glXQueryContextInfoEXT")
+ " is part of the "
+ (code "EXT_import_context")
+ " extension,
+ not part of the core GLX command set. If _glxextstring(EXT_import_context)
+ is included in the string returned by "
+ (code "glXQueryExtensionsString")
+ ",
+ when called with argument "
+ (code "GLX_EXTENSIONS")
+ ",
+ extension "
+ (code "EXT_import_context")
+ " is supported. ")
+ (heading "Errors")
+ (para (code "GLXBadContext")
+ " is generated if "
+ (var "ctx")
+ " does not
+ refer to a valid context. ")
+ (para (code "GLX_BAD_ATTRIBUTE")
+ " is returned if "
+ (var "attribute")
+ " is not a valid GLX
+ context attribute. ")
+ (para "
+fred "
+ (code "GLX_BAD_CONTEXT")
+ " is returned if "
+ (var "attribute")
+ " is not a valid context. ")))
+
+(define-gl-procedure
+ glXQueryContext
+ "glXQueryContext"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "int " (function "glXQueryContext"))
+ (paramdef "Display * " (parameter "dpy"))
+ (paramdef "GLXContext " (parameter "ctx"))
+ (paramdef "int " (parameter "attribute"))
+ (paramdef "int * " (parameter "value"))))
+ '(*fragment*
+ (heading "query context information")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "dpy")))
+ (para "
+Specifies the connection to the X server. "))
+ (entry (% (heading (var "ctx")))
+ (para "
+Specifies a GLX rendering context. "))
+ (entry (% (heading (var "attribute")))
+ (para "
+Specifies that a context parameter should be retrieved. Must be one of "
+ (code "GLX_FBCONFIG_ID")
+ ", "
+ (code "GLX_RENDER_TYPE")
+ ", or "
+ (code "GLX_SCREEN")
+ ". "))
+ (entry (% (heading (var "value")))
+ (para "
+Contains the return value for "
+ (var "attribute")
+ ". ")))
+ (heading "Description")
+ (para (code "glXQueryContext")
+ " sets "
+ (var "value")
+ " to the value of "
+ (var "attribute")
+ " with respect to "
+ (var "ctx")
+ ". "
+ (var "attribute")
+ " may be one of the following: ")
+ (table (% (formatter (asis)))
+ (entry (% (heading (code "GLX_FBCONFIG_ID")))
+ (para "
+Returns the XID of the GLXFBConfig associated with "
+ (var "ctx")
+ ". "))
+ (entry (% (heading (code "GLX_RENDER_TYPE")))
+ (para "
+Returns the rendering type supported by "
+ (var "ctx")
+ ". "))
+ (entry (% (heading (code "GLX_SCREEN")))
+ (para "
+Returns the screen number associated with "
+ (var "ctx")
+ ". ")))
+ (para (code "Success")
+ " is returned unless "
+ (var "attribute")
+ " is not a valid GLX
+ context attribute, in which case "
+ (code "GLX_BAD_ATTRIBUTE")
+ " is returned. ")
+ (para "
+This call may cause a round-trip to the server. ")
+ (heading "Errors")
+ (para (code "GLXBadContext")
+ " is generated if "
+ (var "ctx")
+ " does not
+ refer to a valid context. ")))
+
+(define-gl-procedure
+ glXQueryDrawable
+ "glXQueryDrawable"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "int " (function "glXQueryDrawable"))
+ (paramdef "Display * " (parameter "dpy"))
+ (paramdef "GLXDrawable " (parameter "draw"))
+ (paramdef "int " (parameter "attribute"))
+ (paramdef "unsigned int * " (parameter "value"))))
+ '(*fragment*
+ (heading
+ "returns an attribute assoicated with a GLX drawable")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "dpy")))
+ (para "
+Specifies the connection to the X server. "))
+ (entry (% (heading (var "draw")))
+ (para "
+Specifies the GLX drawable to be queried. "))
+ (entry (% (heading (var "attribute")))
+ (para "
+Specifies the attribute to be returned. Must be one of "
+ (code "GLX_WIDTH")
+ ",\t"
+ (code "GLX_HEIGHT")
+ ",\t"
+ (code "GLX_PRESERVED_CONTENTS")
+ ",\t"
+ (code "GLX_LARGEST_PBUFFER")
+ ", or\t"
+ (code "GLX_FBCONFIG_ID")
+ ". "))
+ (entry (% (heading (var "value")))
+ (para "
+Contains the return value for\t"
+ (var "attribute")
+ ". ")))
+ (heading "Description")
+ (para (code "glXQueryDrawable")
+ " sets\t"
+ (var "value")
+ " to the value of\t"
+ (var "attribute")
+ " with respect to the GLXDrawable\t"
+ (var "draw")
+ ".\t")
+ (para (var "attribute")
+ " may be one of the following: ")
+ (table (% (formatter (asis)))
+ (entry (% (heading (code "GLX_WIDTH")))
+ (para "
+Returns the width of " (var "ctx") ". "))
+ (entry (% (heading (code "GLX_HEIGHT")))
+ (para "
+Returns the height of " (var "ctx") ". "))
+ (entry (% (heading (code "GLX_PRESERVED_CONTENTS")))
+ (para "
+Returns "
+ (code "True")
+ " if the contents
+\t\t\t\t\t\tof a GLXPbuffer are preserved when a resource
+\t\t\t\t\t\tconflict occurs; "
+ (code "False")
+ " otherwise. "))
+ (entry (% (heading (code "GLX_LARGEST_PBUFFER")))
+ (para "
+Returns the value set when "
+ (code "glXCreatePbuffer")
+ " was called to
+ create the GLXPbuffer. If "
+ (code "False")
+ " is returned, then the
+ call to "
+ (code "glXCreatePbuffer")
+ " will
+ fail to create a GLXPbuffer if the requested size
+ is larger than the implementation maximum or
+ available resources. If "
+ (code "True")
+ "
+is returned, a GLXPbuffer of the maximum availble
+ size (if less than the requested width and height)
+ is created. "))
+ (entry (% (heading (code "GLX_FBCONFIG_ID")))
+ (para "
+Returns the XID for " (var "draw") ".\t")))
+ (para "
+If "
+ (var "draw")
+ " is a GLXWindow or GLXPixmap and "
+ (var "attribute")
+ " is set to "
+ (code "GLX_PRESERVED_CONTENTS")
+ " or "
+ (code "GLX_LARGETST_PBUFFER")
+ ", the contents of "
+ (var "value")
+ " are undefined. If "
+ (var "attribute")
+ " is not one of the attributes
+ listed above, the contents of "
+ (var "value")
+ " are
+ unedfined. ")
+ (heading "Errors")
+ (para "
+A "
+ (code "GLXBadDrawable")
+ " is generated if\t"
+ (var "draw")
+ " is not a valid GLXDrawable. ")))
+
+(define-gl-procedure
+ glXQueryExtensionsString
+ "glXQueryExtensionsString"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "const char * "
+ (function "glXQueryExtensionsString"))
+ (paramdef "Display * " (parameter "dpy"))
+ (paramdef "int " (parameter "screen"))))
+ '(*fragment*
+ (heading "return list of supported extensions")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "dpy")))
+ (para "
+Specifies the connection to the X server. "))
+ (entry (% (heading (var "screen")))
+ (para "
+Specifies the screen number. ")))
+ (heading "Description")
+ (para (code "glXQueryExtensionsString")
+ " returns a pointer to a string describing
+ which GLX extensions are supported on the connection. The string
+ is null-terminated and contains a space-separated list of
+ extension names. (The extension names themselves never contain
+ spaces.) If there are no extensions to GLX, then the empty string is
+ returned. ")))
+
+(define-gl-procedure
+ glXQueryExtension
+ "glXQueryExtension"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "Bool " (function "glXQueryExtension"))
+ (paramdef "Display * " (parameter "dpy"))
+ (paramdef "int * " (parameter "errorBase"))
+ (paramdef "int * " (parameter "eventBase"))))
+ '(*fragment*
+ (heading
+ "indicate whether the GLX extension is supported")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "dpy")))
+ (para "
+Specifies the connection to the X server. "))
+ (entry (% (heading (var "errorBase")))
+ (para "
+Returns the base error code of the GLX server extension. "))
+ (entry (% (heading (var "eventBase")))
+ (para "
+Returns the base event code of the GLX server extension. ")))
+ (heading "Description")
+ (para (code "glXQueryExtension")
+ " returns "
+ (code "True")
+ " if the X server of
+ connection "
+ (var "dpy")
+ " supports the GLX extension, "
+ (code "False")
+ " otherwise.
+ If "
+ (code "True")
+ " is returned,
+ then "
+ (var "errorBase")
+ " and "
+ (var "eventBase")
+ " return the error base and event base of
+ the GLX extension. These values should be added to the constant
+ error and event values to determine the actual event or error values.
+ Otherwise, "
+ (var "errorBase")
+ " and "
+ (var "eventBase")
+ " are unchanged. ")
+ (para (var "errorBase")
+ " and "
+ (var "eventBase")
+ " do not return values if they are specified
+ as "
+ (code "NULL")
+ ". ")))
+
+(define-gl-procedure
+ glXQueryServerString
+ "glXQueryServerString"
+ (funcsynopsis
+ (funcprototype
+ (funcdef
+ "const char * "
+ (function "glXQueryServerString"))
+ (paramdef "Display * " (parameter "dpy"))
+ (paramdef "int " (parameter "screen"))
+ (paramdef "int " (parameter "name"))))
+ '(*fragment*
+ (heading "return string describing the server")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "dpy")))
+ (para "
+Specifies the connection to the X server. "))
+ (entry (% (heading (var "screen")))
+ (para "
+Specifies the screen number. "))
+ (entry (% (heading (var "name")))
+ (para "
+Specifies which string is returned:
+ one of "
+ (code "GLX_VENDOR")
+ ", "
+ (code "GLX_VERSION")
+ ", or "
+ (code "GLX_EXTENSIONS")
+ ". ")))
+ (heading "Description")
+ (para (code "glXQueryServerString")
+ " returns a pointer to a static, null-terminated string
+ describing some aspect of the server's GLX extension. The possible values for "
+ (var "name")
+ " and the format of the strings is the same as for "
+ (code "glXGetClientString")
+ ". If "
+ (var "name")
+ " is not set to a recognized value, "
+ (code "NULL")
+ " is returned. ")))
+
+(define-gl-procedure
+ glXQueryVersion
+ "glXQueryVersion"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "Bool " (function "glXQueryVersion"))
+ (paramdef "Display * " (parameter "dpy"))
+ (paramdef "int * " (parameter "major"))
+ (paramdef "int * " (parameter "minor"))))
+ '(*fragment*
+ (heading
+ "return the version numbers of the GLX extension")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "dpy")))
+ (para "
+Specifies the connection to the X server. "))
+ (entry (% (heading (var "major")))
+ (para "
+Returns the major version number of the GLX server extension. "))
+ (entry (% (heading (var "minor")))
+ (para "
+Returns the minor version number of the GLX server extension. ")))
+ (heading "Description")
+ (para (code "glXQueryVersion")
+ " returns the major and minor version numbers of the GLX extension
+ implemented by the server associated with connection "
+ (var "dpy")
+ ".
+ Implementations with the same major version number are upward compatible,
+ meaning that the implementation with the higher minor number is a superset
+ of the version with the lower minor number. ")
+ (para (var "major")
+ " and "
+ (var "minor")
+ " do not return values if they are specified as "
+ (code "NULL")
+ ". ")
+ (heading "Errors")
+ (para (code "glXQueryVersion")
+ " returns "
+ (code "False")
+ " if it fails, "
+ (code "True")
+ " otherwise. ")
+ (para (var "major")
+ " and "
+ (var "minor")
+ " are not updated when "
+ (code "False")
+ " is returned. ")))
+
+(define-gl-procedure
+ glXSelectEvent
+ "glXSelectEvent"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glXSelectEvent"))
+ (paramdef "Display * " (parameter "dpy"))
+ (paramdef "GLXDrawable " (parameter "draw"))
+ (paramdef
+ "unsigned long "
+ (parameter "event_mask"))))
+ '(*fragment*
+ (heading
+ "select GLX events for a window or a GLX pixel buffer")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "dpy")))
+ (para "
+Specifies the connection to the X server. "))
+ (entry (% (heading (var "draw")))
+ (para "
+Specifies a GLX drawable. Must be a GLX pixel buffer or a window. "))
+ (entry (% (heading (var "event_mask")))
+ (para "
+Specifies the events to be returned for "
+ (var "draw")
+ ". ")))
+ (heading "Description")
+ (para (code "glXSelectEvent")
+ " sets the GLX event mask for a GLX pixel buffer or a window.
+ Calling "
+ (code "glXSelectEvent")
+ " overrides any previous event mask that was
+ set by the client for "
+ (var "draw")
+ ". Note that it does not affect the
+ event masks that other clients may have specified for "
+ (var "draw")
+ " since
+ each client rendering to "
+ (var "draw")
+ " has a separate event mask for it. ")
+ (para "
+Currently, only one GLX event, "
+ (code "GLX_PBUFFER_CLOBBER_MASK")
+ ",
+ can be selected. The following data is returned to the client when a "
+ (code "GLX_PBUFFER_CLOBBER_MASK")
+ " event occurs: ")
+ (para "
+typedef struct { ")
+ (table (% (formatter (asis)))
+ (entry (% (heading "
+int " (var "event_type") "; "))
+ (para "
+/* GLX_DAMAGED or GLX_SAVED */ "))
+ (entry (% (heading "
+int " (var "draw_type") "; "))
+ (para "
+/* GLX_WINDOW or GLX_PBUFFER */ "))
+ (entry (% (heading "
+unsigned long " (var "serial") "; "))
+ (para "
+/* # of last request processed by server */ "))
+ (entry (% (heading "
+Bool " (var "send_event") "; "))
+ (para "
+/* true if this came for SendEvent request */ "))
+ (entry (% (heading "
+Display " (var "*display") "; "))
+ (para "
+/* display the event was read from */ "))
+ (entry (% (heading "
+GLXDrawable " (var "drawable") "; "))
+ (para "
+/* i.d. of Drawable */ "))
+ (entry (% (heading
+ "
+unsigned int "
+ (var "buffer_mask")
+ "; "))
+ (para "
+/* mask indicating affected buffers */ "))
+ (entry (% (heading "
+int " (var "x, y") "; "))
+ (para))
+ (entry (% (heading "
+int " (var "width, height") "; "))
+ (para))
+ (entry (% (heading "
+int " (var "count") "; "))
+ (para "
+/* if nonzero, at least this many more */ ")))
+ (para "
+} GLXPbufferClobberEvent;
+ The valid bit masks used in "
+ (var "buffer_mask")
+ " are: ")
+ (para)
+ (table (% (formatter (asis)))
+ (entry (% (heading (strong "Bitmask")))
+ (para (strong "Corresponding Buffer")))
+ (entry (% (heading (code "GLX_FRONT_LEFT_BUFFER_BIT")))
+ (para "
+Front left color buffer "))
+ (entry (% (heading (code "GLX_FRONT_RIGHT_BUFFER_BIT")))
+ (para "
+Front right color buffer "))
+ (entry (% (heading (code "GLX_BACK_LEFT_BUFFER_BIT")))
+ (para "
+Back left color buffer "))
+ (entry (% (heading (code "GLX_BACK_RIGHT_BUFFER_BIT")))
+ (para "
+Back right color buffer "))
+ (entry (% (heading (code "GLX_AUX_BUFFERS_BIT")))
+ (para "
+Auxiliary buffer "))
+ (entry (% (heading (code "GLX_DEPTH_BUFFER_BIT")))
+ (para "
+Depth buffer "))
+ (entry (% (heading (code "GLX_STENCIL_BUFFER_BIT")))
+ (para "
+Stencil buffer "))
+ (entry (% (heading (code "GLX_ACCUM_BUFFER_BIT")))
+ (para "
+Accumulation buffer ")))
+ (para "
+A single X server operation can cause several buffer clobber events to be
+ sent. (e.g., a single GLX pixel buffer may be damaged and cause multiple
+ buffer clobber events to be generated). Each event specifies one
+ region of the GLX drawable that was affected by the X Server operation.
+ The "
+ (var "buffer_mask")
+ " field indicates which color buffers and
+ ancillary buffers were affected. All the buffer clobber events
+ generated by a single X server action are guaranteed to be
+ contiguous in the event queue. The conditions under which this event is
+ generated and the "
+ (var "event_type")
+ " varies, depending on the type of the
+ GLX drawable. ")
+ (para "
+When the "
+ (code "GLX_AUX_BUFFERS_BIT")
+ " is set in "
+ (var "buffer_mask")
+ ", then "
+ (var "aux_buffer")
+ " is set to indicate which buffer was affected. If more
+ than one aux buffer was affected, then additional events are
+ generated as part of the same contiguous event group. Each
+ additional event will have only the "
+ (code "GLX_AUX_BUFFERS_BIT")
+ " set in "
+ (var "buffer_mask")
+ ", and the "
+ (var "aux_buffer")
+ " field will be set
+ appropriately. For nonstereo drawables, "
+ (code "GLX_FRONT_LEFT_BUFFER_BIT")
+ " and "
+ (code "GLX_BACK_LEFT_BUFFER_BIT")
+ " are
+ used to specify the front and back color buffers. ")
+ (para "
+For preserved GLX pixel buffers, a buffer clobber event with
+ type "
+ (code "GLX_SAVED")
+ " is generated whenever the contents of the
+ GLX pixel buffer is moved out of offscreen memory. The event(s) describes which
+ portions of the GLX pixel buffer were affected. Clients who receive many
+ buffer clobber events, referring to different save actions,
+ should consider freeing the GLX pixel buffer resource in order to prevent
+ the system from thrashing due to insufficient resources. ")
+ (para "
+For an unpreserved GLXPbuffer, a buffer clobber event, with type "
+ (code "GLX_DAMAGED")
+ ", is generated whenever a portion of the GLX pixel buffer
+ becomes invalid. The client may wish to regenerate the invalid portions
+ of the GLX pixel buffer. ")
+ (para "
+For Windows, buffer clobber events, with type "
+ (code "GLX_SAVED")
+ ", occur
+ whenever an ancillary buffer, associated with the window, gets clobbered
+ or moved out of off-screen memory. The event contains information
+ indicating which color buffers and ancillary buffers\\(emand which portions
+ of those buffers\\(emwere affected. ")
+ (heading "Errors")
+ (para (code "GLXBadDrawable")
+ " is generated if "
+ (var "draw")
+ " is not a valid window
+ or a valid GLX pixel buffer. ")))
+
+(define-gl-procedure
+ glXSwapBuffers
+ "glXSwapBuffers"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glXSwapBuffers"))
+ (paramdef "Display * " (parameter "dpy"))
+ (paramdef "GLXDrawable " (parameter "drawable"))))
+ '(*fragment*
+ (heading "exchange front and back buffers")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "dpy")))
+ (para "
+Specifies the connection to the X server. "))
+ (entry (% (heading (var "drawable")))
+ (para "
+Specifies the drawable whose buffers are to be swapped. ")))
+ (heading "Description")
+ (para (code "glXSwapBuffers")
+ " promotes the contents of the back buffer of "
+ (var "drawable")
+ " to become
+ the contents of the front buffer of "
+ (var "drawable")
+ ".
+ The contents of the back buffer then become undefined.
+ The update typically takes place during the vertical retrace of
+ the monitor,
+ rather than immediately after "
+ (code "glXSwapBuffers")
+ " is called. ")
+ (para (code "glXSwapBuffers")
+ " performs an implicit "
+ (code "glFlush")
+ " before it returns.
+ Subsequent OpenGL commands may be issued immediately after calling "
+ (code "glXSwapBuffers")
+ ",
+ but are not executed until the buffer exchange is completed. ")
+ (para "
+If "
+ (var "drawable")
+ " was not created with respect to a double-buffered visual, "
+ (code "glXSwapBuffers")
+ " has no effect,
+ and no error is generated. ")
+ (heading "Errors")
+ (para (code "GLXBadDrawable")
+ " is generated if "
+ (var "drawable")
+ " is not a valid GLX drawable. ")
+ (para (code "GLXBadCurrentWindow")
+ " is generated if "
+ (var "dpy")
+ " and "
+ (var "drawable")
+ " are
+ respectively the display and drawable associated with the current
+ context of the calling thread, and "
+ (var "drawable")
+ " identifies a window that
+ is no longer valid. ")))
+
+(define-gl-procedure
+ glXUseXFont
+ "glXUseXFont"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glXUseXFont"))
+ (paramdef "Font " (parameter "font"))
+ (paramdef "int " (parameter "first"))
+ (paramdef "int " (parameter "count"))
+ (paramdef "int " (parameter "listBase"))))
+ '(*fragment*
+ (heading
+ "create bitmap display lists from an X font")
+ (heading "Parameters")
+ (table (% (formatter (asis)))
+ (entry (% (heading (var "font")))
+ (para "
+Specifies the font from which character glyphs are to be taken. "))
+ (entry (% (heading (var "first")))
+ (para "
+Specifies the index of the first glyph to be taken. "))
+ (entry (% (heading (var "count")))
+ (para "
+Specifies the number of glyphs to be taken. "))
+ (entry (% (heading (var "listBase")))
+ (para "
+Specifies the index of the first display list to be generated. ")))
+ (heading "Description")
+ (para (code "glXUseXFont")
+ " generates "
+ (var "count")
+ " display lists,
+ named "
+ (var "listBase")
+ " through "
+ (math (var "listBase") "+" (var "count") "-" "1")
+ ",
+ each containing a single "
+ (code "glBitmap")
+ " command.
+ The parameters of the "
+ (code "glBitmap")
+ " command of display list "
+ (math (var "listBase") "+" (var "i"))
+ "
+are derived from glyph "
+ (math (var "first") "+" (var "i"))
+ ".
+ Bitmap parameters "
+ (math (var "xorig"))
+ ", "
+ (math (var "yorig"))
+ ", "
+ (math (var "width"))
+ ",
+ and "
+ (math (var "height"))
+ "
+are computed from font metrics as "
+ (math (var "descent") "-" "1")
+ ", "
+ (math "-" (var "lbearing"))
+ ", "
+ (math (var "rbearing") "-" (var "lbearing"))
+ ",
+ and "
+ (math (var "ascent") "+" (var "descent"))
+ ",
+ respectively. "
+ (math (var "xmove"))
+ "
+is taken from the glyph's "
+ (math (var "width"))
+ "
+metric,
+ and "
+ (math (var "ymove"))
+ "
+is set to zero.
+ Finally,
+ the glyph's image is converted to the appropriate format for "
+ (code "glBitmap")
+ ". ")
+ (para "
+Using "
+ (code "glXUseXFont")
+ " may be more efficient than accessing the X font and generating
+ the display lists explicitly,
+ both because the display lists are created on the server without requiring
+ a round trip of the glyph data,
+ and because the server may choose to delay the creation of each
+ bitmap until it is accessed. ")
+ (para "
+Empty display lists are created for all glyphs that are requested and
+ are not defined in "
+ (var "font")
+ ". "
+ (code "glXUseXFont")
+ " is ignored if there is no current GLX context. ")
+ (heading "Errors")
+ (para (code "BadFont")
+ " is generated if "
+ (var "font")
+ " is not a valid font. ")
+ (para (code "GLXBadContextState")
+ " is generated if the current GLX context is
+ in display-list construction mode. ")
+ (para (code "GLXBadCurrentWindow")
+ " is generated if the drawable associated
+ with the current context of the calling thread is a window, and that
+ window is no longer valid. ")))
+
+(define-gl-procedure
+ glXWaitGL
+ "glXWaitGL"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glXWaitGL"))
+ (paramdef (parameter "void"))))
+ '(*fragment*
+ (heading
+ "complete GL execution prior to subsequent X calls")
+ (heading "Description")
+ (para "
+GL rendering calls made prior to "
+ (code "glXWaitGL")
+ " are guaranteed to be
+ executed before X rendering calls made after "
+ (code "glXWaitGL")
+ ".
+ Although this same result can be achieved using "
+ (code "glFinish")
+ ", "
+ (code "glXWaitGL")
+ " does not require a round trip to the server,
+ and it is therefore more efficient in cases where client and server
+ are on separate machines. ")
+ (para (code "glXWaitGL")
+ " is ignored if there is no current GLX context. ")
+ (heading "Errors")
+ (para (code "GLXBadCurrentWindow")
+ " is generated if the drawable associated
+ with the current context of the calling thread is a window, and that
+ window is no longer valid. ")))
+
+(define-gl-procedure
+ glXWaitX
+ "glXWaitX"
+ (funcsynopsis
+ (funcprototype
+ (funcdef "void " (function "glXWaitX"))
+ (paramdef (parameter "void"))))
+ '(*fragment*
+ (heading
+ "complete X execution prior to subsequent GL calls")
+ (heading "Description")
+ (para "
+X rendering calls made prior to "
+ (code "glXWaitX")
+ " are guaranteed to be
+ executed before GL rendering calls made after "
+ (code "glXWaitX")
+ ".
+ Although the same result can be achieved using "
+ (code "XSync")
+ ", "
+ (code "glXWaitX")
+ " does not require a round trip to the server,
+ and it is therefore more efficient in cases where client and server
+ are on separate machines. ")
+ (para (code "glXWaitX")
+ " is ignored if there is no current GLX context. ")
+ (heading "Errors")
+ (para (code "GLXBadCurrentWindow")
+ " is generated if the drawable associated
+ with the current context of the calling thread is a window, and that
+ window is no longer valid. ")))
+
--- /dev/null
+;;; figl
+;;; Copyright (C) 2013 Andy Wingo <wingo@pobox.com>
+;;;
+;;; Figl is free software: you can redistribute it and/or modify it
+;;; under the terms of the GNU Lesser General Public License as
+;;; published by the Free Software Foundation, either version 3 of the
+;;; License, or (at your option) any later version.
+;;;
+;;; Figl is distributed in the hope that it will be useful, but WITHOUT
+;;; ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+;;; or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
+;;; Public License for more details.
+;;;
+;;; You should have received a copy of the GNU Lesser General Public
+;;; License along with this program. If not, see
+;;; <http://www.gnu.org/licenses/>.
+
+;;; Commentary:
+;;
+;; figl is the Foreign Interface to GL.
+;;
+;;; Code:
+
+(define-module (figl low-level support)
+ #:export (define-gl-procedure))
+
+(define-syntax-rule (define-gl-procedure scheme-name c-name prototype
+ docstring)
+ (begin
+ (define (scheme-name)
+ docstring
+ (cons c-name 'prototype))
+ (export scheme-name)))
#:use-module (sxml simple)
#:use-module ((sxml xpath) #:hide (filter))
#:use-module (sxml transform)
- #:use-module ((srfi srfi-1) #:select (filter fold))
+ #:use-module (sxml fold)
+ #:use-module ((srfi srfi-1) #:select (filter fold append-map))
+ #:use-module (srfi srfi-9)
#:use-module (texinfo docbook)
- #:use-module (texinfo plain-text)
#:use-module (ice-9 ftw)
#:use-module (ice-9 match)
- #:export (fold-gl-definitions))
+ #:export (gl-definition?
+ make-gl-definition
+ gl-definition-name
+ gl-definition-prototype
+ gl-definition-documentation
+ gl-definition-copyright
+ parse-gl-definitions))
+
+(define-record-type gl-definition
+ (make-gl-definition name prototype documentation copyright)
+ gl-definition?
+ (name gl-definition-name)
+ (prototype gl-definition-prototype)
+ (documentation gl-definition-documentation)
+ (copyright gl-definition-copyright))
(define *namespaces*
'((mml . "http://www.w3.org/1998/Math/MathML")))
(define xml-errors
(take-first (sxpath '(refentry (refsect1 (@ id (equal? "errors")))))))
+(define xml-copyright
+ (take-first (sxpath '(refentry (refsect1 (@ id (equal? "Copyright")))))))
+
(define (parse-prototype xml)
xml)
(if (null? l) (reverse dest)
(loop (cdr l) (cons (car l) (cons elem dest)))))))
+(define (lift-tables sdocbook)
+ ;; Like sdocbook-flatten, but tweaked to lift tables from inside
+ ;; paras, but not paras from inside tables. Pretty hacky stuff.
+ (define *sdocbook-block-commands*
+ '(informaltable programlisting variablelist))
+
+ (define (inline-command? command)
+ (not (memq command *sdocbook-block-commands*)))
+
+ (define (fhere str accum block cont)
+ (values (cons str accum)
+ block
+ cont))
+ (define (fdown node accum block cont)
+ (match node
+ ((command (and attrs ('% . _)) body ...)
+ (values body '() '()
+ (lambda (accum block)
+ (values
+ `(,command ,attrs ,@(reverse accum))
+ block))))
+ ((command body ...)
+ (values body '() '()
+ (lambda (accum block)
+ (values
+ `(,command ,@(reverse accum))
+ block))))))
+ (define (fup node paccum pblock pcont kaccum kblock kcont)
+ (call-with-values (lambda () (kcont kaccum kblock))
+ (lambda (ret block)
+ (if (inline-command? (car ret))
+ (values (cons ret paccum) (append kblock pblock) pcont)
+ (values paccum (append kblock (cons ret pblock)) pcont)))))
+ (call-with-values
+ (lambda () (foldts*-values fdown fup fhere sdocbook '() '() #f))
+ (lambda (accum block cont)
+ (append (reverse accum)
+ (reverse block)
+ ))))
+
(define *rules*
`((refsect1
+ *preorder*
. ,(lambda (tag id . body)
- body))
+ (append-map (lambda (nodeset)
+ (map
+ (lambda (x)
+ (pre-post-order x *rules*))
+ nodeset))
+ (map lift-tables body))))
(title
. ,(lambda (tag body)
`(heading ,body)))
`((itemx ,@rest)))))
. ,(lambda (tag . body)
`(table (% (formatter (asis))) ,@body)))
+ (trademark
+ . ,(match-lambda*
+ ((_ ('@ ('class "copyright"))) '(copyright))))
(parameter
. ,(lambda (tag body)
`(var ,body)))
(emphasis
. ,(match-lambda*
((_) "")
+ ((_ ('@ ('role "bold")) (and body (? string?)))
+ `(strong ,(string-trim-both body)))
((_ ('@ ('role "bold")) . body) `(strong ,@body))
((_ body) `(var ,body))))
(citerefentry
rows))
(row
. ,(lambda (tag first . rest)
- `(entry (% (heading ,first))
- ,@(list-intersperse rest ", "))))
+ `(entry (% (heading ,@first))
+ (para ,@(apply
+ append
+ (list-intersperse rest '(", ")))))))
(entry
. ,(match-lambda*
- ((_) "")
- ((_ ('@ . _)) "")
- ((_ ('@ . _) x) x)
- ((_ ('@ . _) x ...) `(*fragment* ,@x))
- ((_ x) x)
- ((_ x ...) `(*fragment* ,@x)))))
+ ((_) '())
+ ((_ ('@ . _)) '())
+ ((_ ('@ . _) x ...) x)
+ ((_ x ...) x))))
. ,(lambda (tag attrs . contents)
`(table (% (formatter (asis)))
,@(apply append (filter identity contents)))))
;; Produces an stexinfo fragment.
(define (generate-documentation purpose parameters description errors)
- (string-trim-both
- (stexi->plain-text
- `(*fragment*
- (heading ,purpose)
- ,@(if parameters (sdocbook->stexi parameters) '())
- ,@(if description (sdocbook->stexi description) '())
- ,@(if errors (sdocbook->stexi errors) '())))))
+ `(*fragment*
+ (heading ,purpose)
+ ,@(if parameters (sdocbook->stexi parameters) '())
+ ,@(if description (sdocbook->stexi description) '())
+ ,@(if errors (sdocbook->stexi errors) '())))
(define (xml->definition xml)
- `((name . ,(xml-name xml))
- (prototype . ,(parse-prototype (xml-prototype xml)))
- (documentation . ,(generate-documentation (xml-purpose xml)
+ (make-gl-definition (xml-name xml)
+ (parse-prototype (xml-prototype xml))
+ (generate-documentation (xml-purpose xml)
(xml-parameters xml)
(xml-description xml)
- (xml-errors xml)))))
-
-(define (fold-gl-definitions proc version . seeds)
- (apply
- values
- (fold (lambda (file seeds)
- (let ((xml (parse-man-xml version file)))
- (call-with-values
- (lambda ()
- (apply proc
- (xml-name xml)
- (parse-prototype (xml-prototype xml))
- (generate-documentation (xml-purpose xml)
- (xml-parameters xml)
- (xml-description xml)
- (xml-errors xml))
- seeds))
- list)))
- seeds
- (xml-files version))))
+ (xml-errors xml))
+ (and=> (xml-copyright xml) sdocbook->stexi)))
+
+(define (parse-gl-definitions version)
+ (map (lambda (file)
+ (xml->definition (parse-man-xml version file)))
+ (xml-files version)))
+++ /dev/null
-#!/usr/bin/env guile
-!#
-
-(use-modules (figl parse)
- (ice-9 pretty-print))
-
-(setlocale LC_ALL "")
-
-(print-disable 'escape-newlines)
-
-(fold-gl-definitions
- (lambda (name prototype docstring)
- (pretty-print
- `(define-gl-procedure ,(string->symbol name) ,name ,prototype
- ,docstring))
- (newline)
- (values))
- 2)
--- /dev/null
+#!/usr/bin/env guile
+!#
+
+(use-modules (figl parse)
+ (figl config)
+ (sxml fold)
+ ((srfi srfi-1) #:select (append-map))
+ (texinfo serialize)
+ (texinfo plain-text)
+ (ice-9 pretty-print))
+
+(setlocale LC_ALL "")
+
+(print-disable 'escape-newlines)
+
+(define (module-name->scm-name mod-name)
+ (in-vicinity
+ (abs-top-srcdir)
+ (string-append (string-join (map symbol->string mod-name) "/")
+ ".scm")))
+
+(define (module-name->texi-name mod-name)
+ (in-vicinity
+ (in-vicinity (abs-top-srcdir) "doc")
+ (string-append (string-join (map symbol->string (cdr mod-name)) "-")
+ ".texi")))
+
+(define (unique-copyrights defs)
+ (let lp ((in defs) (out '()))
+ (if (null? in)
+ (reverse out)
+ (let ((copyright (gl-definition-copyright (car in))))
+ (lp (cdr in)
+ (if (member copyright out)
+ out
+ (cons copyright out)))))))
+
+(define (write-scm mod-name defs port)
+ (display "\
+;;; figl -*- mode: scheme; coding: utf-8 -*-
+;;; Copyright (C) 2013 Andy Wingo <wingo@pobox.com>
+;;;
+;;; Figl is free software: you can redistribute it and/or modify it
+;;; under the terms of the GNU Lesser General Public License as
+;;; published by the Free Software Foundation, either version 3 of the
+;;; License, or (at your option) any later version.
+;;;
+;;; Figl is distributed in the hope that it will be useful, but WITHOUT
+;;; ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+;;; or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
+;;; Public License for more details.
+;;;
+;;; You should have received a copy of the GNU Lesser General Public
+;;; License along with this program. If not, see
+;;; <http://www.gnu.org/licenses/>.
+;;;
+;;; Derived from upstream OpenGL documentation.
+" port)
+ (for-each
+ (lambda (copyright)
+ (display ";;; " port)
+ (newline port)
+ (for-each (lambda (line)
+ (display ";;; " port)
+ (display line port)
+ (newline port))
+ (string-split
+ (string-trim-both (stexi->plain-text copyright))
+ #\newline)))
+ (unique-copyrights defs))
+ (display "\
+;;;
+;;; Automatically generated; you probably don't want to edit this. To
+;;; update, run \"make update\" in the top-level build tree.
+;;;
+" port)
+ (newline port)
+ (pretty-print
+ `(define-module ,mod-name
+ #:use-module (figl low-level support)
+ #:export ,(map (lambda (def)
+ (string->symbol (gl-definition-name def)))
+ defs))
+ port)
+ (newline port)
+ (for-each
+ (lambda (def)
+ (pretty-print
+ `(define-gl-procedure ,(string->symbol (gl-definition-name def))
+ ,(gl-definition-name def)
+ ,(gl-definition-prototype def)
+ #;
+ ,(string-trim-both
+ (stexi->plain-text
+ (gl-definition-documentation def)))
+ ',(gl-definition-documentation def))
+ port)
+ (newline port))
+ defs))
+
+(define (write-texi mod-name defs port)
+ (display
+ (stexi->texi
+ `(*fragment*
+ (para "The functions from this section may be had by loading "
+ "the module:")
+ (example "(use-modules " ,(object->string mod-name) ")")
+ (copying
+ (para
+ "This section of the manual was derived from the upstream "
+ "OpenGL documentation. Each function's documentation has "
+ "its own copyright statement; for full details, see the "
+ "upstream documentation. The copyright notices and licenses "
+ "present in this section are as follows.")
+ ,@(append-map cdr (unique-copyrights defs)))
+ ,@(map
+ (lambda (def)
+ `(defun (% (name ,(gl-definition-name def))
+ ;; FIXME: proper prototype.
+ ;; (gl-definition-prototype def)
+ (arguments))
+ ,@(cdr (gl-definition-documentation def))))
+ defs)))
+ port))
+
+(define (write-bindings mod-name defs)
+ (call-with-output-file (module-name->scm-name mod-name)
+ (lambda (port)
+ (write-scm mod-name defs port)))
+ (call-with-output-file (module-name->texi-name mod-name)
+ (lambda (port)
+ (write-texi mod-name defs port))))
+
+(define (partition-definitions version)
+ (fold-values
+ (lambda (def gl glu glx)
+ (cond
+ ((string-prefix? "glu" (gl-definition-name def))
+ (values gl (cons def glu) glx))
+ ((string-prefix? "glX" (gl-definition-name def))
+ (values gl glu (cons def glx)))
+ (else
+ (values (cons def gl) glu glx))))
+ (parse-gl-definitions version)
+ '()
+ '()
+ '()))
+
+(define* (main arg0 #:optional (version "2"))
+ (call-with-values
+ (lambda () (partition-definitions version))
+ (lambda (gl glu glx)
+ (write-bindings '(figl low-level gl) (reverse gl))
+ (write-bindings '(figl low-level glu) (reverse glu))
+ (write-bindings '(figl low-level glx) (reverse glx)))))
+
+(when (batch-mode?)
+ (apply main (command-line)))
HCoop / clinton / guile-figl.git / commitdiff