rename upstream-man-pages to upstream-doc

[clinton/guile-figl.git] / upstream-doc / man2 / glColorTableParameter.xml

diff --git a/upstream-doc/man2/glColorTableParameter.xml b/upstream-doc/man2/glColorTableParameter.xml
new file mode 100644 (file)
index 0000000..4a60ab8
--- /dev/null
+++ b/upstream-doc/man2/glColorTableParameter.xml
@@ -0,0 +1,136 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
+              "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">
+<refentry id="glColorTableParameter">
+    <refmeta>
+        <refmetainfo>
+            <copyright>
+                <year>1991-2006</year>
+                <holder>Silicon Graphics, Inc.</holder>
+            </copyright>
+        </refmetainfo>
+        <refentrytitle>glColorTableParameter</refentrytitle>
+        <manvolnum>3G</manvolnum>
+    </refmeta>
+    <refnamediv>
+        <refname>glColorTableParameter</refname>
+        <refpurpose>set color lookup table parameters</refpurpose>
+    </refnamediv>
+    <refsynopsisdiv><title>C Specification</title>
+        <funcsynopsis>
+            <funcprototype>
+                <funcdef>void <function>glColorTableParameterfv</function></funcdef>
+                <paramdef>GLenum <parameter>target</parameter></paramdef>
+                <paramdef>GLenum <parameter>pname</parameter></paramdef>
+                <paramdef>const GLfloat * <parameter>params</parameter></paramdef>
+            </funcprototype>
+        </funcsynopsis>
+        <funcsynopsis>
+            <funcprototype>
+                <funcdef>void <function>glColorTableParameteriv</function></funcdef>
+                <paramdef>GLenum <parameter>target</parameter></paramdef>
+                <paramdef>GLenum <parameter>pname</parameter></paramdef>
+                <paramdef>const GLint * <parameter>params</parameter></paramdef>
+            </funcprototype>
+        </funcsynopsis>
+    </refsynopsisdiv>
+    <!-- eqn: ignoring delim $$ -->
+    <refsect1 id="parameters"><title>Parameters</title>
+        <variablelist>
+        <varlistentry>
+            <term><parameter>target</parameter></term>
+            <listitem>
+                <para>
+                    The target color table.
+                    Must be
+                    <constant>GL_COLOR_TABLE</constant>,
+                    <constant>GL_POST_CONVOLUTION_COLOR_TABLE</constant>, or
+                    <constant>GL_POST_COLOR_MATRIX_COLOR_TABLE</constant>.
+                </para>
+            </listitem>
+        </varlistentry>
+        <varlistentry>
+            <term><parameter>pname</parameter></term>
+            <listitem>
+                <para>
+                    The symbolic name of a texture color lookup table parameter.
+                    Must be one of
+                    <constant>GL_COLOR_TABLE_SCALE</constant> or
+                    <constant>GL_COLOR_TABLE_BIAS</constant>.
+                </para>
+            </listitem>
+        </varlistentry>
+        <varlistentry>
+            <term><parameter>params</parameter></term>
+            <listitem>
+                <para>
+                    A pointer to an array where the values of the parameters are stored.
+                </para>
+            </listitem>
+        </varlistentry>
+        </variablelist>
+    </refsect1>
+    <refsect1 id="description"><title>Description</title>
+        <para>
+            <function>glColorTableParameter</function> is used to specify the scale factors and bias terms applied to
+            color components when they are loaded into a color table. <parameter>target</parameter>
+            indicates which color table the scale and bias terms apply to; it
+            must be set to
+            <constant>GL_COLOR_TABLE</constant>,
+            <constant>GL_POST_CONVOLUTION_COLOR_TABLE</constant>, or
+            <constant>GL_POST_COLOR_MATRIX_COLOR_TABLE</constant>.
+        </para>
+        <para>
+            <parameter>pname</parameter> must be <constant>GL_COLOR_TABLE_SCALE</constant> to set the
+            scale factors.
+            In this case, <parameter>params</parameter> points to an array of four values, which are
+            the scale factors for red, green, blue, and alpha, in that order.
+        </para>
+        <para>
+            <parameter>pname</parameter> must be <constant>GL_COLOR_TABLE_BIAS</constant> to set the
+            bias terms. In this case,
+            <parameter>params</parameter> points to an array of four values, which are the bias
+            terms for red, green, blue, and alpha, in that order.
+        </para>
+        <para>
+            The color tables themselves are specified by
+            calling <citerefentry><refentrytitle>glColorTable</refentrytitle></citerefentry>.
+        </para>
+    </refsect1>
+    <refsect1 id="notes"><title>Notes</title>
+        <para>
+            <function>glColorTableParameter</function> is available only if <code>ARB_imaging</code> is returned from calling
+            <citerefentry><refentrytitle>glGetString</refentrytitle></citerefentry> with an argument of <constant>GL_EXTENSIONS</constant>.
+        </para>
+    </refsect1>
+    <refsect1 id="errors"><title>Errors</title>
+        <para>
+            <constant>GL_INVALID_ENUM</constant> is generated if <parameter>target</parameter> or <parameter>pname</parameter> is not
+            an acceptable value.
+        </para>
+        <para>
+            <constant>GL_INVALID_OPERATION</constant> is generated if <function>glColorTableParameter</function> is executed
+            between the execution of <citerefentry><refentrytitle>glBegin</refentrytitle></citerefentry> and the corresponding
+            execution of <citerefentry><refentrytitle>glEnd</refentrytitle></citerefentry>.
+        </para>
+    </refsect1>
+    <refsect1 id="associatedgets"><title>Associated Gets</title>
+        <para>
+            <citerefentry><refentrytitle>glGetColorTableParameter</refentrytitle></citerefentry>
+        </para>
+    </refsect1>
+    <refsect1 id="seealso"><title>See Also</title>
+        <para>
+            <citerefentry><refentrytitle>glColorTable</refentrytitle></citerefentry>,
+            <citerefentry><refentrytitle>glPixelTransfer</refentrytitle></citerefentry>
+        </para>
+    </refsect1>
+    <refsect1 id="Copyright"><title>Copyright</title>
+        <para>
+            Copyright <trademark class="copyright"></trademark> 1991-2006
+            Silicon Graphics, Inc. This document is licensed under the SGI
+            Free Software B License. For details, see
+            <ulink url="http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/</ulink>.
+        </para>
+    </refsect1>
+</refentry>