upstream-doc/man2/xhtml/glColorTableParameter.xml

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd">
   2 <!-- saved from url=(0013)about:internet -->
   3 <?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" pref:renderer="mathplayer-dl"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>glColorTableParameter</title><meta name="generator" content="DocBook XSL Stylesheets V1.73.2" /></head><body><div class="refentry" lang="en" xml:lang="en"><a id="glColorTableParameter"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glColorTableParameter — set color lookup table parameters</p></div><div class="refsynopsisdiv"><h2>C Specification</h2><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"><tr><td><code class="funcdef">void <b class="fsfunc">glColorTableParameterfv</b>(</code></td><td>GLenum  </td><td><var class="pdparam">target</var>, </td></tr><tr><td> </td><td>GLenum  </td><td><var class="pdparam">pname</var>, </td></tr><tr><td> </td><td>const GLfloat *  </td><td><var class="pdparam">params</var><code>)</code>;</td></tr></table></div><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"><tr><td><code class="funcdef">void <b class="fsfunc">glColorTableParameteriv</b>(</code></td><td>GLenum  </td><td><var class="pdparam">target</var>, </td></tr><tr><td> </td><td>GLenum  </td><td><var class="pdparam">pname</var>, </td></tr><tr><td> </td><td>const GLint *  </td><td><var class="pdparam">params</var><code>)</code>;</td></tr></table></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="parameters"></a><h2>Parameters</h2><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>target</code></em></span></dt><dd><p>
   4                     The target color table.
   5                     Must be
   6                     <code class="constant">GL_COLOR_TABLE</code>,
   7                     <code class="constant">GL_POST_CONVOLUTION_COLOR_TABLE</code>, or
   8                     <code class="constant">GL_POST_COLOR_MATRIX_COLOR_TABLE</code>.
   9                 </p></dd><dt><span class="term"><em class="parameter"><code>pname</code></em></span></dt><dd><p>
  10                     The symbolic name of a texture color lookup table parameter.
  11                     Must be one of
  12                     <code class="constant">GL_COLOR_TABLE_SCALE</code> or
  13                     <code class="constant">GL_COLOR_TABLE_BIAS</code>.
  14                 </p></dd><dt><span class="term"><em class="parameter"><code>params</code></em></span></dt><dd><p>
  15                     A pointer to an array where the values of the parameters are stored.
  16                 </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
  17             <code class="function">glColorTableParameter</code> is used to specify the scale factors and bias terms applied to
  18             color components when they are loaded into a color table. <em class="parameter"><code>target</code></em>
  19             indicates which color table the scale and bias terms apply to; it
  20             must be set to
  21             <code class="constant">GL_COLOR_TABLE</code>,
  22             <code class="constant">GL_POST_CONVOLUTION_COLOR_TABLE</code>, or
  23             <code class="constant">GL_POST_COLOR_MATRIX_COLOR_TABLE</code>.
  24         </p><p>
  25             <em class="parameter"><code>pname</code></em> must be <code class="constant">GL_COLOR_TABLE_SCALE</code> to set the
  26             scale factors.
  27             In this case, <em class="parameter"><code>params</code></em> points to an array of four values, which are
  28             the scale factors for red, green, blue, and alpha, in that order.
  29         </p><p>
  30             <em class="parameter"><code>pname</code></em> must be <code class="constant">GL_COLOR_TABLE_BIAS</code> to set the
  31             bias terms. In this case,
  32             <em class="parameter"><code>params</code></em> points to an array of four values, which are the bias
  33             terms for red, green, blue, and alpha, in that order.
  34         </p><p>
  35             The color tables themselves are specified by
  36             calling <a class="citerefentry" href="glColorTable.xml"><span class="citerefentry"><span class="refentrytitle">glColorTable</span></span></a>.
  37         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="notes"></a><h2>Notes</h2><p>
  38             <code class="function">glColorTableParameter</code> is available only if <code class="code">ARB_imaging</code> is returned from calling
  39             <a class="citerefentry" href="glGetString.xml"><span class="citerefentry"><span class="refentrytitle">glGetString</span></span></a> with an argument of <code class="constant">GL_EXTENSIONS</code>.
  40         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p>
  41             <code class="constant">GL_INVALID_ENUM</code> is generated if <em class="parameter"><code>target</code></em> or <em class="parameter"><code>pname</code></em> is not
  42             an acceptable value.
  43         </p><p>
  44             <code class="constant">GL_INVALID_OPERATION</code> is generated if <code class="function">glColorTableParameter</code> is executed
  45             between the execution of <a class="citerefentry" href="glBegin.xml"><span class="citerefentry"><span class="refentrytitle">glBegin</span></span></a> and the corresponding
  46             execution of <a class="citerefentry" href="glEnd.xml"><span class="citerefentry"><span class="refentrytitle">glEnd</span></span></a>.
  47         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="associatedgets"></a><h2>Associated Gets</h2><p>
  48             <a class="citerefentry" href="glGetColorTableParameter.xml"><span class="citerefentry"><span class="refentrytitle">glGetColorTableParameter</span></span></a>
  49         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
  50             <a class="citerefentry" href="glColorTable.xml"><span class="citerefentry"><span class="refentrytitle">glColorTable</span></span></a>,
  51             <a class="citerefentry" href="glPixelTransfer.xml"><span class="citerefentry"><span class="refentrytitle">glPixelTransfer</span></span></a>
  52         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
  53             Copyright <span class="trademark"></span>© 1991-2006
  54             Silicon Graphics, Inc. This document is licensed under the SGI
  55             Free Software B License. For details, see
  56             <a class="ulink" href="http://oss.sgi.com/projects/FreeB/" target="_top">http://oss.sgi.com/projects/FreeB/</a>.
  57         </p></div></div></body></html>