-
Notifications
You must be signed in to change notification settings - Fork 94
/
glCopyColorSubTable.xhtml
74 lines (72 loc) · 6.6 KB
/
glCopyColorSubTable.xhtml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
<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><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>
Must be one of
<code class="constant">GL_COLOR_TABLE</code>,
<code class="constant">GL_POST_CONVOLUTION_COLOR_TABLE</code>, or
<code class="constant">GL_POST_COLOR_MATRIX_COLOR_TABLE</code>.
</p></dd><dt><span class="term"><em class="parameter"><code>start</code></em></span></dt><dd><p>
The starting index of the portion of the color table to be replaced.
</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>
The window coordinates of the left corner of the row of pixels to be
copied.
</p></dd><dt><span class="term"><em class="parameter"><code>width</code></em></span></dt><dd><p>
The number of table entries to replace.
</p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
<code class="function">glCopyColorSubTable</code> is used to respecify a contiguous portion of a color table previously
defined using <a class="citerefentry" href="glColorTable"><span class="citerefentry"><span class="refentrytitle">glColorTable</span></span></a>. The pixels copied from the framebuffer
replace the portion of the existing table from indices <em class="parameter"><code>start</code></em> to
<math overflow="scroll">
<mrow>
<mi mathvariant="italic">start</mi>
<mo>+</mo>
<mi mathvariant="italic">x</mi>
<mo>-</mo>
<mn>1</mn>
</mrow>
</math>,
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.
</p></div><div class="refsect1" lang="en" xml:lang="en"><a id="notes"></a><h2>Notes</h2><p>
<code class="function">glCopyColorSubTable</code> is present only if <code class="code">ARB_imaging</code> is returned when <a class="citerefentry" href="glGetString"><span class="citerefentry"><span class="refentrytitle">glGetString</span></span></a>
is called with an argument of <code class="constant">GL_EXTENSIONS</code>.
</p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p>
<code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>target</code></em> is not a previously defined
color table.
</p><p>
<code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>target</code></em> is not one of the allowable
values.
</p><p>
<code class="constant">GL_INVALID_VALUE</code> is generated if
<math overflow="scroll">
<mrow>
<mrow>
<mi mathvariant="italic">start</mi>
<mo>+</mo>
<mi mathvariant="italic">x</mi>
</mrow>
<mo>></mo>
<mi mathvariant="italic">width</mi>
</mrow>
</math>.
</p><p>
<code class="constant">GL_INVALID_OPERATION</code> is generated if <code class="function">glCopyColorSubTable</code> is executed
between the execution of <a class="citerefentry" href="glBegin"><span class="citerefentry"><span class="refentrytitle">glBegin</span></span></a> and the corresponding
execution of <a class="citerefentry" href="glEnd"><span class="citerefentry"><span class="refentrytitle">glEnd</span></span></a>.
</p></div><div class="refsect1" lang="en" xml:lang="en"><a id="associatedgets"></a><h2>Associated Gets</h2><p>
<a class="citerefentry" href="glGetColorTable"><span class="citerefentry"><span class="refentrytitle">glGetColorTable</span></span></a>,
<a class="citerefentry" href="glGetColorTableParameter"><span class="citerefentry"><span class="refentrytitle">glGetColorTableParameter</span></span></a>
</p></div>
{$pipelinestall}{$examples}
<div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
<a class="citerefentry" href="glColorSubTable"><span class="citerefentry"><span class="refentrytitle">glColorSubTable</span></span></a>,
<a class="citerefentry" href="glColorTableParameter"><span class="citerefentry"><span class="refentrytitle">glColorTableParameter</span></span></a>,
<a class="citerefentry" href="glCopyColorTable"><span class="citerefentry"><span class="refentrytitle">glCopyColorTable</span></span></a>,
<code class="function">glCopyColorSubTable</code>,
<a class="citerefentry" href="glGetColorTable"><span class="citerefentry"><span class="refentrytitle">glGetColorTable</span></span></a>
</p></div><div class="refsect1" lang="en" xml:lang="en"><div id="Copyright"><h2>Copyright</h2><p>
Copyright © 1991-2006
Silicon Graphics, Inc. This document is licensed under the SGI
Free Software B License. For details, see
<a class="ulink" href="https://web.archive.org/web/20171022161616/http://oss.sgi.com/projects/FreeB/" target="_top">https://web.archive.org/web/20171022161616/http://oss.sgi.com/projects/FreeB/</a>.
</p></div></div></div>