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=
"glCopyColorSubTable">
9 <holder>Silicon Graphics, Inc.
</holder>
12 <refentrytitle>glCopyColorSubTable
</refentrytitle>
13 <manvolnum>3G
</manvolnum>
16 <refname>glCopyColorSubTable
</refname>
17 <refpurpose>respecify a portion of a color table
</refpurpose>
19 <refsynopsisdiv><title>C Specification
</title>
22 <funcdef>void
<function>glCopyColorSubTable
</function></funcdef>
23 <paramdef>GLenum
<parameter>target
</parameter></paramdef>
24 <paramdef>GLsizei
<parameter>start
</parameter></paramdef>
25 <paramdef>GLint
<parameter>x
</parameter></paramdef>
26 <paramdef>GLint
<parameter>y
</parameter></paramdef>
27 <paramdef>GLsizei
<parameter>width
</parameter></paramdef>
31 <refsect1 id=
"parameters"><title>Parameters
</title>
34 <term><parameter>target
</parameter></term>
38 <constant>GL_COLOR_TABLE
</constant>,
39 <constant>GL_POST_CONVOLUTION_COLOR_TABLE
</constant>, or
40 <constant>GL_POST_COLOR_MATRIX_COLOR_TABLE
</constant>.
45 <term><parameter>start
</parameter></term>
48 The starting index of the portion of the color table to be replaced.
53 <term><parameter>x
</parameter></term>
54 <term><parameter>y
</parameter></term>
57 The window coordinates of the left corner of the row of pixels to be
63 <term><parameter>width
</parameter></term>
66 The number of table entries to replace.
72 <refsect1 id=
"description"><title>Description
</title>
74 <function>glCopyColorSubTable
</function> is used to respecify a contiguous portion of a color table previously
75 defined using
<citerefentry><refentrytitle>glColorTable
</refentrytitle></citerefentry>. The pixels copied from the framebuffer
76 replace the portion of the existing table from indices
<parameter>start
</parameter> to
77 <inlineequation><mml:math>
78 <!-- eqn: start + x - 1:-->
80 <mml:mi mathvariant=
"italic">start
</mml:mi>
82 <mml:mi mathvariant=
"italic">x
</mml:mi>
86 </mml:math></inlineequation>,
87 inclusive. This region may not include any
88 entries outside the range of the color table, as was originally specified.
89 It is not an error to specify a subtexture with width of
0, but such a
90 specification has no effect.
93 <refsect1 id=
"notes"><title>Notes
</title>
95 <function>glCopyColorSubTable
</function> is present only if
<code>ARB_imaging
</code> is returned when
<citerefentry><refentrytitle>glGetString
</refentrytitle></citerefentry>
96 is called with an argument of
<constant>GL_EXTENSIONS
</constant>.
99 <refsect1 id=
"errors"><title>Errors
</title>
101 <constant>GL_INVALID_VALUE
</constant> is generated if
<parameter>target
</parameter> is not a previously defined
105 <constant>GL_INVALID_VALUE
</constant> is generated if
<parameter>target
</parameter> is not one of the allowable
109 <constant>GL_INVALID_VALUE
</constant> is generated if
110 <inlineequation><mml:math>
111 <!-- eqn: start + x > width:-->
114 <mml:mi mathvariant=
"italic">start
</mml:mi>
116 <mml:mi mathvariant=
"italic">x
</mml:mi>
118 <mml:mo>></mml:mo>
119 <mml:mi mathvariant=
"italic">width
</mml:mi>
121 </mml:math></inlineequation>.
124 <constant>GL_INVALID_OPERATION
</constant> is generated if
<function>glCopyColorSubTable
</function> is executed
125 between the execution of
<citerefentry><refentrytitle>glBegin
</refentrytitle></citerefentry> and the corresponding
126 execution of
<citerefentry><refentrytitle>glEnd
</refentrytitle></citerefentry>.
129 <refsect1 id=
"associatedgets"><title>Associated Gets
</title>
131 <citerefentry><refentrytitle>glGetColorTable
</refentrytitle></citerefentry>,
132 <citerefentry><refentrytitle>glGetColorTableParameter
</refentrytitle></citerefentry>
135 <refsect1 id=
"seealso"><title>See Also
</title>
137 <citerefentry><refentrytitle>glColorSubTable
</refentrytitle></citerefentry>,
138 <citerefentry><refentrytitle>glColorTableParameter
</refentrytitle></citerefentry>,
139 <citerefentry><refentrytitle>glCopyColorTable
</refentrytitle></citerefentry>,
140 <function>glCopyColorSubTable
</function>,
141 <citerefentry><refentrytitle>glGetColorTable
</refentrytitle></citerefentry>
144 <refsect1 id=
"Copyright"><title>Copyright
</title>
146 Copyright
<trademark class=
"copyright"></trademark> 1991-
2006
147 Silicon Graphics, Inc. This document is licensed under the SGI
148 Free Software B License. For details, see
149 <ulink url=
"http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/
</ulink>.