upstream-man-pages/man2/glColorTableParameter.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
   3               "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">
   4 <refentry id="glColorTableParameter">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>1991-2006</year>
   9                 <holder>Silicon Graphics, Inc.</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>glColorTableParameter</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>glColorTableParameter</refname>
  17         <refpurpose>set color lookup table parameters</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>C Specification</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>void <function>glColorTableParameterfv</function></funcdef>
  23                 <paramdef>GLenum <parameter>target</parameter></paramdef>
  24                 <paramdef>GLenum <parameter>pname</parameter></paramdef>
  25                 <paramdef>const GLfloat * <parameter>params</parameter></paramdef>
  26             </funcprototype>
  27         </funcsynopsis>
  28         <funcsynopsis>
  29             <funcprototype>
  30                 <funcdef>void <function>glColorTableParameteriv</function></funcdef>
  31                 <paramdef>GLenum <parameter>target</parameter></paramdef>
  32                 <paramdef>GLenum <parameter>pname</parameter></paramdef>
  33                 <paramdef>const GLint * <parameter>params</parameter></paramdef>
  34             </funcprototype>
  35         </funcsynopsis>
  36     </refsynopsisdiv>
  37     <!-- eqn: ignoring delim $$ -->
  38     <refsect1 id="parameters"><title>Parameters</title>
  39         <variablelist>
  40         <varlistentry>
  41             <term><parameter>target</parameter></term>
  42             <listitem>
  43                 <para>
  44                     The target color table.
  45                     Must be
  46                     <constant>GL_COLOR_TABLE</constant>,
  47                     <constant>GL_POST_CONVOLUTION_COLOR_TABLE</constant>, or
  48                     <constant>GL_POST_COLOR_MATRIX_COLOR_TABLE</constant>.
  49                 </para>
  50             </listitem>
  51         </varlistentry>
  52         <varlistentry>
  53             <term><parameter>pname</parameter></term>
  54             <listitem>
  55                 <para>
  56                     The symbolic name of a texture color lookup table parameter.
  57                     Must be one of
  58                     <constant>GL_COLOR_TABLE_SCALE</constant> or
  59                     <constant>GL_COLOR_TABLE_BIAS</constant>.
  60                 </para>
  61             </listitem>
  62         </varlistentry>
  63         <varlistentry>
  64             <term><parameter>params</parameter></term>
  65             <listitem>
  66                 <para>
  67                     A pointer to an array where the values of the parameters are stored.
  68                 </para>
  69             </listitem>
  70         </varlistentry>
  71         </variablelist>
  72     </refsect1>
  73     <refsect1 id="description"><title>Description</title>
  74         <para>
  75             <function>glColorTableParameter</function> is used to specify the scale factors and bias terms applied to
  76             color components when they are loaded into a color table. <parameter>target</parameter>
  77             indicates which color table the scale and bias terms apply to; it
  78             must be set to
  79             <constant>GL_COLOR_TABLE</constant>,
  80             <constant>GL_POST_CONVOLUTION_COLOR_TABLE</constant>, or
  81             <constant>GL_POST_COLOR_MATRIX_COLOR_TABLE</constant>.
  82         </para>
  83         <para>
  84             <parameter>pname</parameter> must be <constant>GL_COLOR_TABLE_SCALE</constant> to set the
  85             scale factors.
  86             In this case, <parameter>params</parameter> points to an array of four values, which are
  87             the scale factors for red, green, blue, and alpha, in that order.
  88         </para>
  89         <para>
  90             <parameter>pname</parameter> must be <constant>GL_COLOR_TABLE_BIAS</constant> to set the
  91             bias terms. In this case,
  92             <parameter>params</parameter> points to an array of four values, which are the bias
  93             terms for red, green, blue, and alpha, in that order.
  94         </para>
  95         <para>
  96             The color tables themselves are specified by
  97             calling <citerefentry><refentrytitle>glColorTable</refentrytitle></citerefentry>.
  98         </para>
  99     </refsect1>
 100     <refsect1 id="notes"><title>Notes</title>
 101         <para>
 102             <function>glColorTableParameter</function> is available only if <code>ARB_imaging</code> is returned from calling
 103             <citerefentry><refentrytitle>glGetString</refentrytitle></citerefentry> with an argument of <constant>GL_EXTENSIONS</constant>.
 104         </para>
 105     </refsect1>
 106     <refsect1 id="errors"><title>Errors</title>
 107         <para>
 108             <constant>GL_INVALID_ENUM</constant> is generated if <parameter>target</parameter> or <parameter>pname</parameter> is not
 109             an acceptable value.
 110         </para>
 111         <para>
 112             <constant>GL_INVALID_OPERATION</constant> is generated if <function>glColorTableParameter</function> is executed
 113             between the execution of <citerefentry><refentrytitle>glBegin</refentrytitle></citerefentry> and the corresponding
 114             execution of <citerefentry><refentrytitle>glEnd</refentrytitle></citerefentry>.
 115         </para>
 116     </refsect1>
 117     <refsect1 id="associatedgets"><title>Associated Gets</title>
 118         <para>
 119             <citerefentry><refentrytitle>glGetColorTableParameter</refentrytitle></citerefentry>
 120         </para>
 121     </refsect1>
 122     <refsect1 id="seealso"><title>See Also</title>
 123         <para>
 124             <citerefentry><refentrytitle>glColorTable</refentrytitle></citerefentry>,
 125             <citerefentry><refentrytitle>glPixelTransfer</refentrytitle></citerefentry>
 126         </para>
 127     </refsect1>
 128     <refsect1 id="Copyright"><title>Copyright</title>
 129         <para>
 130             Copyright <trademark class="copyright"></trademark> 1991-2006
 131             Silicon Graphics, Inc. This document is licensed under the SGI
 132             Free Software B License. For details, see
 133             <ulink url="http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/</ulink>.
 134         </para>
 135     </refsect1>
 136 </refentry>