upstream-doc/man2/xhtml/glCopyColorSubTable.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>glCopyColorSubTable</title><meta name="generator" content="DocBook XSL Stylesheets V1.73.2" /></head><body><div class="refentry" lang="en" xml:lang="en"><a id="glCopyColorSubTable"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glCopyColorSubTable — respecify a portion of a color table</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">glCopyColorSubTable</b>(</code></td><td>GLenum  </td><td><var class="pdparam">target</var>, </td></tr><tr><td> </td><td>GLsizei  </td><td><var class="pdparam">start</var>, </td></tr><tr><td> </td><td>GLint  </td><td><var class="pdparam">x</var>, </td></tr><tr><td> </td><td>GLint  </td><td><var class="pdparam">y</var>, </td></tr><tr><td> </td><td>GLsizei  </td><td><var class="pdparam">width</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                     Must be one of
   5                     <code class="constant">GL_COLOR_TABLE</code>,
   6                     <code class="constant">GL_POST_CONVOLUTION_COLOR_TABLE</code>, or
   7                     <code class="constant">GL_POST_COLOR_MATRIX_COLOR_TABLE</code>.
   8                 </p></dd><dt><span class="term"><em class="parameter"><code>start</code></em></span></dt><dd><p>
   9                     The starting index of the portion of the color table to be replaced.
  10                 </p></dd><dt><span class="term"><em class="parameter"><code>x</code></em>, </span><span class="term"><em class="parameter"><code>y</code></em></span></dt><dd><p>
  11                     The window coordinates of the left corner of the row of pixels to be
  12                     copied.
  13                 </p></dd><dt><span class="term"><em class="parameter"><code>width</code></em></span></dt><dd><p>
  14                     The number of table entries to replace.
  15                 </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
  16             <code class="function">glCopyColorSubTable</code> is used to respecify a contiguous portion of a color table previously
  17             defined using <a class="citerefentry" href="glColorTable.xml"><span class="citerefentry"><span class="refentrytitle">glColorTable</span></span></a>.  The pixels copied from the framebuffer
  18             replace the portion of the existing table from indices <em class="parameter"><code>start</code></em> to
  19             <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
  20
  21                 <mml:mrow>
  22                     <mml:mi mathvariant="italic">start</mml:mi>
  23                     <mml:mo>+</mml:mo>
  24                     <mml:mi mathvariant="italic">x</mml:mi>
  25                     <mml:mo>-</mml:mo>
  26                     <mml:mn>1</mml:mn>
  27                 </mml:mrow>
  28             </mml:math>,
  29             inclusive.  This region may not include any
  30             entries outside the range of the color table, as was originally specified.
  31             It is not an error to specify a subtexture with width of 0, but such a
  32             specification has no effect.
  33         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="notes"></a><h2>Notes</h2><p>
  34             <code class="function">glCopyColorSubTable</code> is present only if <code class="code">ARB_imaging</code> is returned when <a class="citerefentry" href="glGetString.xml"><span class="citerefentry"><span class="refentrytitle">glGetString</span></span></a>
  35             is called with an argument of <code class="constant">GL_EXTENSIONS</code>.
  36         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p>
  37             <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>target</code></em> is not a previously defined
  38             color table.
  39         </p><p>
  40             <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>target</code></em> is not one of the allowable
  41             values.
  42         </p><p>
  43             <code class="constant">GL_INVALID_VALUE</code> is generated if
  44             <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
  45
  46                 <mml:mrow>
  47                     <mml:mrow>
  48                         <mml:mi mathvariant="italic">start</mml:mi>
  49                         <mml:mo>+</mml:mo>
  50                         <mml:mi mathvariant="italic">x</mml:mi>
  51                     </mml:mrow>
  52                     <mml:mo>&gt;</mml:mo>
  53                     <mml:mi mathvariant="italic">width</mml:mi>
  54                 </mml:mrow>
  55             </mml:math>.
  56         </p><p>
  57             <code class="constant">GL_INVALID_OPERATION</code> is generated if <code class="function">glCopyColorSubTable</code> is executed
  58             between the execution of <a class="citerefentry" href="glBegin.xml"><span class="citerefentry"><span class="refentrytitle">glBegin</span></span></a> and the corresponding
  59             execution of <a class="citerefentry" href="glEnd.xml"><span class="citerefentry"><span class="refentrytitle">glEnd</span></span></a>.
  60         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="associatedgets"></a><h2>Associated Gets</h2><p>
  61             <a class="citerefentry" href="glGetColorTable.xml"><span class="citerefentry"><span class="refentrytitle">glGetColorTable</span></span></a>,
  62             <a class="citerefentry" href="glGetColorTableParameter.xml"><span class="citerefentry"><span class="refentrytitle">glGetColorTableParameter</span></span></a>
  63         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
  64             <a class="citerefentry" href="glColorSubTable.xml"><span class="citerefentry"><span class="refentrytitle">glColorSubTable</span></span></a>,
  65             <a class="citerefentry" href="glColorTableParameter.xml"><span class="citerefentry"><span class="refentrytitle">glColorTableParameter</span></span></a>,
  66             <a class="citerefentry" href="glCopyColorTable.xml"><span class="citerefentry"><span class="refentrytitle">glCopyColorTable</span></span></a>,
  67             <code class="function">glCopyColorSubTable</code>,
  68             <a class="citerefentry" href="glGetColorTable.xml"><span class="citerefentry"><span class="refentrytitle">glGetColorTable</span></span></a>
  69         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
  70             Copyright <span class="trademark"></span>© 1991-2006
  71             Silicon Graphics, Inc. This document is licensed under the SGI
  72             Free Software B License. For details, see
  73             <a class="ulink" href="http://oss.sgi.com/projects/FreeB/" target="_top">http://oss.sgi.com/projects/FreeB/</a>.
  74         </p></div></div></body></html>