Blame |
Last modification |
View Log
| RSS feed
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
"http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">
<refentry id="glCopyColorSubTable">
<refmeta>
<refmetainfo>
<copyright>
<year>1991-2006</year>
<holder>Silicon Graphics, Inc.</holder>
</copyright>
</refmetainfo>
<refentrytitle>glCopyColorSubTable</refentrytitle>
<manvolnum>3G</manvolnum>
</refmeta>
<refnamediv>
<refname>glCopyColorSubTable</refname>
<refpurpose>respecify a portion of a color table</refpurpose>
</refnamediv>
<refsynopsisdiv><title>C Specification</title>
<funcsynopsis>
<funcprototype>
<funcdef>void <function>glCopyColorSubTable</function></funcdef>
<paramdef>GLenum <parameter>target</parameter></paramdef>
<paramdef>GLsizei <parameter>start</parameter></paramdef>
<paramdef>GLint <parameter>x</parameter></paramdef>
<paramdef>GLint <parameter>y</parameter></paramdef>
<paramdef>GLsizei <parameter>width</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="parameters"><title>Parameters</title>
<variablelist>
<varlistentry>
<term><parameter>target</parameter></term>
<listitem>
<para>
Must be one of
<constant>GL_COLOR_TABLE</constant>,
<constant>GL_POST_CONVOLUTION_COLOR_TABLE</constant>, or
<constant>GL_POST_COLOR_MATRIX_COLOR_TABLE</constant>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>start</parameter></term>
<listitem>
<para>
The starting index of the portion of the color table to be replaced.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>x</parameter></term>
<term><parameter>y</parameter></term>
<listitem>
<para>
The window coordinates of the left corner of the row of pixels to be
copied.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>width</parameter></term>
<listitem>
<para>
The number of table entries to replace.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 id="description"><title>Description</title>
<para>
<function>glCopyColorSubTable</function> is used to respecify a contiguous portion of a color table previously
defined using <citerefentry><refentrytitle>glColorTable</refentrytitle></citerefentry>. The pixels copied from the framebuffer
replace the portion of the existing table from indices <parameter>start</parameter> to
<inlineequation><mml:math>
<!-- eqn: start + x - 1:-->
<mml:mrow>
<mml:mi mathvariant="italic">start</mml:mi>
<mml:mo>+</mml:mo>
<mml:mi mathvariant="italic">x</mml:mi>
<mml:mo>-</mml:mo>
<mml:mn>1</mml:mn>
</mml:mrow>
</mml:math></inlineequation>,
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.
</para>
</refsect1>
<refsect1 id="notes"><title>Notes</title>
<para>
<function>glCopyColorSubTable</function> is present only if <code>ARB_imaging</code> is returned when <citerefentry><refentrytitle>glGetString</refentrytitle></citerefentry>
is called with an argument of <constant>GL_EXTENSIONS</constant>.
</para>
</refsect1>
<refsect1 id="errors"><title>Errors</title>
<para>
<constant>GL_INVALID_VALUE</constant> is generated if <parameter>target</parameter> is not a previously defined
color table.
</para>
<para>
<constant>GL_INVALID_VALUE</constant> is generated if <parameter>target</parameter> is not one of the allowable
values.
</para>
<para>
<constant>GL_INVALID_VALUE</constant> is generated if
<inlineequation><mml:math>
<!-- eqn: start + x > width:-->
<mml:mrow>
<mml:mrow>
<mml:mi mathvariant="italic">start</mml:mi>
<mml:mo>+</mml:mo>
<mml:mi mathvariant="italic">x</mml:mi>
</mml:mrow>
<mml:mo>></mml:mo>
<mml:mi mathvariant="italic">width</mml:mi>
</mml:mrow>
</mml:math></inlineequation>.
</para>
<para>
<constant>GL_INVALID_OPERATION</constant> is generated if <function>glCopyColorSubTable</function> is executed
between the execution of <citerefentry><refentrytitle>glBegin</refentrytitle></citerefentry> and the corresponding
execution of <citerefentry><refentrytitle>glEnd</refentrytitle></citerefentry>.
</para>
</refsect1>
<refsect1 id="associatedgets"><title>Associated Gets</title>
<para>
<citerefentry><refentrytitle>glGetColorTable</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glGetColorTableParameter</refentrytitle></citerefentry>
</para>
</refsect1>
<refsect1 id="seealso"><title>See Also</title>
<para>
<citerefentry><refentrytitle>glColorSubTable</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glColorTableParameter</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glCopyColorTable</refentrytitle></citerefentry>,
<function>glCopyColorSubTable</function>,
<citerefentry><refentrytitle>glGetColorTable</refentrytitle></citerefentry>
</para>
</refsect1>
<refsect1 id="Copyright"><title>Copyright</title>
<para>
Copyright <trademark class="copyright"></trademark> 1991-2006
Silicon Graphics, Inc. This document is licensed under the SGI
Free Software B License. For details, see
<ulink url="http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/</ulink>.
</para>
</refsect1>
</refentry>