[clinton/guile-figl.git] / upstream-doc / man3 / glCopyTexSubImage2D.xml

<?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="glCopyTexSubImage2D">
    <refmeta>
        <refmetainfo>
            <copyright>
                <year>1991-2006</year>
                <holder>Silicon Graphics, Inc.</holder>
            </copyright>
        </refmetainfo>
        <refentrytitle>glCopyTexSubImage2D</refentrytitle>
        <manvolnum>3G</manvolnum>
    </refmeta>
    <refnamediv>
        <refname>glCopyTexSubImage2D</refname>
        <refpurpose>copy a two-dimensional texture subimage</refpurpose>
    </refnamediv>
    <refsynopsisdiv><title>C Specification</title>
        <funcsynopsis>
            <funcprototype>
                <funcdef>void <function>glCopyTexSubImage2D</function></funcdef>
                <paramdef>GLenum <parameter>target</parameter></paramdef>
                <paramdef>GLint <parameter>level</parameter></paramdef>
                <paramdef>GLint <parameter>xoffset</parameter></paramdef>
                <paramdef>GLint <parameter>yoffset</parameter></paramdef>
                <paramdef>GLint <parameter>x</parameter></paramdef>
                <paramdef>GLint <parameter>y</parameter></paramdef>
                <paramdef>GLsizei <parameter>width</parameter></paramdef>
                <paramdef>GLsizei <parameter>height</parameter></paramdef>
            </funcprototype>
        </funcsynopsis>
    </refsynopsisdiv>
    <!-- eqn: ignoring delim $$ -->
    <para>
    </para>
    <refsect1 id="parameters"><title>Parameters</title>
        <variablelist>
        <varlistentry>
            <term><parameter>target</parameter></term>
            <listitem>
                <para>
                    Specifies the target texture.
                    Must be <constant>GL_TEXTURE_2D</constant>,
                    <constant>GL_TEXTURE_CUBE_MAP_POSITIVE_X</constant>,
                    <constant>GL_TEXTURE_CUBE_MAP_NEGATIVE_X</constant>,
                    <constant>GL_TEXTURE_CUBE_MAP_POSITIVE_Y</constant>,
                    <constant>GL_TEXTURE_CUBE_MAP_NEGATIVE_Y</constant>,
                    <constant>GL_TEXTURE_CUBE_MAP_POSITIVE_Z</constant>, or
                    <constant>GL_TEXTURE_CUBE_MAP_NEGATIVE_Z</constant>.
                </para>
            </listitem>
        </varlistentry>
        <varlistentry>
            <term><parameter>level</parameter></term>
            <listitem>
                <para>
                    Specifies the level-of-detail number.
                    Level 0 is the base image level.
                    Level <emphasis>n</emphasis> is the <emphasis>n</emphasis>th mipmap reduction image.
                </para>
            </listitem>
        </varlistentry>
        <varlistentry>
            <term><parameter>xoffset</parameter></term>
            <listitem>
                <para>
                    Specifies a texel offset in the x direction within the texture array.
                </para>
            </listitem>
        </varlistentry>
        <varlistentry>
            <term><parameter>yoffset</parameter></term>
            <listitem>
                <para>
                    Specifies a texel offset in the y direction within the texture array.
                </para>
            </listitem>
        </varlistentry>
        <varlistentry>
            <term><parameter>x</parameter></term>
            <term><parameter>y</parameter></term>
            <listitem>
                <para>
                    Specify the window coordinates of the lower left corner
                    of the rectangular region of pixels to be copied.
                </para>
            </listitem>
        </varlistentry>
        <varlistentry>
            <term><parameter>width</parameter></term>
            <listitem>
                <para>
                    Specifies the width of the texture subimage.
                </para>
            </listitem>
        </varlistentry>
        <varlistentry>
            <term><parameter>height</parameter></term>
            <listitem>
                <para>
                    Specifies the height of the texture subimage.
                </para>
            </listitem>
        </varlistentry>
        </variablelist>
    </refsect1>
    <refsect1 id="description"><title>Description</title>
        <para>
            <function>glCopyTexSubImage2D</function> replaces a rectangular portion of a two-dimensional texture image or
            cube-map texture image with pixels from the current <constant>GL_READ_BUFFER</constant>
            (rather than from main memory, as is the case for <citerefentry><refentrytitle>glTexSubImage2D</refentrytitle></citerefentry>).
        </para>
        <para>
            The screen-aligned pixel rectangle with lower left corner at
            <inlineequation><mml:math>
                <!-- eqn: (x, y): -->
                <mml:mfenced open="(" close=")">
                    <mml:mi mathvariant="italic">x</mml:mi>
                    <mml:mi mathvariant="italic">y</mml:mi>
                </mml:mfenced>
            </mml:math></inlineequation>
            and with
            width <parameter>width</parameter> and height <parameter>height</parameter> replaces the portion of the
            texture array with x indices <parameter>xoffset</parameter> through 
            <inlineequation><mml:math>
                <!-- eqn: xoffset  +  width  -  1: -->
                <mml:mrow>
                    <mml:mi mathvariant="italic">xoffset</mml:mi>
                    <mml:mo>+</mml:mo>
                    <mml:mi mathvariant="italic">width</mml:mi>
                    <mml:mo>-</mml:mo>
                    <mml:mn>1</mml:mn>
                </mml:mrow>
            </mml:math></inlineequation>,
            inclusive, and y indices <parameter>yoffset</parameter> through 
            <inlineequation><mml:math>
                <!-- eqn: yoffset  +  height  -  1: -->
                <mml:mrow>
                    <mml:mi mathvariant="italic">yoffset</mml:mi>
                    <mml:mo>+</mml:mo>
                    <mml:mi mathvariant="italic">height</mml:mi>
                    <mml:mo>-</mml:mo>
                    <mml:mn>1</mml:mn>
                </mml:mrow>
            </mml:math></inlineequation>,
            inclusive, at the mipmap level specified by <parameter>level</parameter>.
        </para>
        <para>
            The pixels in the rectangle are processed exactly as if
            <citerefentry><refentrytitle>glReadPixels</refentrytitle></citerefentry> had been called, but the process stops just before
            final conversion.
            At this point, all pixel component values are clamped to the range 
            <inlineequation><mml:math>
                <!-- eqn: [0,1]: -->
                <mml:mfenced open="[" close="]">
                    <mml:mn>0</mml:mn>
                    <mml:mn>1</mml:mn>
                </mml:mfenced>
            </mml:math></inlineequation>
            and then converted to the texture's internal format for storage in the texel
            array.
        </para>
        <para>
            The destination rectangle in the texture array may not include any texels
            outside the texture array as it was originally specified.
            It is not an error to specify a subtexture with zero width or height, but
            such a specification has no effect.
        </para>
        <para>
            If any of the pixels within the specified rectangle of the current
            <constant>GL_READ_BUFFER</constant> are outside the read window associated with the current
            rendering context, then the values obtained for those pixels are undefined.
        </para>
        <para>
            No change is made to the <emphasis>internalformat</emphasis>, <emphasis>width</emphasis>,
            <emphasis>height</emphasis>, or <emphasis>border</emphasis> parameters of the specified texture
            array or to texel values outside the specified subregion.
        </para>
    </refsect1>
    <refsect1 id="notes"><title>Notes</title>
        <para>
            <citerefentry><refentrytitle>glPixelStore</refentrytitle></citerefentry> modes affect texture images.
        </para>
    </refsect1>
    <refsect1 id="errors"><title>Errors</title>
        <para>
            <constant>GL_INVALID_ENUM</constant> is generated if <parameter>target</parameter> is not <constant>GL_TEXTURE_2D</constant>,
            <constant>GL_TEXTURE_CUBE_MAP_POSITIVE_X</constant>,
            <constant>GL_TEXTURE_CUBE_MAP_NEGATIVE_X</constant>,
            <constant>GL_TEXTURE_CUBE_MAP_POSITIVE_Y</constant>,
            <constant>GL_TEXTURE_CUBE_MAP_NEGATIVE_Y</constant>,
            <constant>GL_TEXTURE_CUBE_MAP_POSITIVE_Z</constant>, or
            <constant>GL_TEXTURE_CUBE_MAP_NEGATIVE_Z</constant>.
        </para>
        <para>
            <constant>GL_INVALID_OPERATION</constant> is generated if the texture array has not been
            defined by a previous <citerefentry><refentrytitle>glTexImage2D</refentrytitle></citerefentry> or <citerefentry><refentrytitle>glCopyTexImage2D</refentrytitle></citerefentry> operation.
        </para>
        <para>
            <constant>GL_INVALID_VALUE</constant> is generated if <parameter>level</parameter> is less than 0.
        </para>
        <para>
            <constant>GL_INVALID_VALUE</constant> may be generated if 
            <inlineequation><mml:math>
                <!-- eqn: level  >  log sub 2(max): -->
                <mml:mrow>
                    <mml:mi mathvariant="italic">level</mml:mi>
                    <mml:mo>&gt;</mml:mo>
                    <mml:mrow>
                        <mml:msub><mml:mi mathvariant="italic">log</mml:mi>
                        <mml:mn>2</mml:mn>
                        </mml:msub>
                        <mml:mo>&af;</mml:mo>
                        <mml:mfenced open="(" close=")">
                            <mml:mi mathvariant="italic">max</mml:mi>
                        </mml:mfenced>
                    </mml:mrow>
                </mml:mrow>
            </mml:math></inlineequation>,
            where 
            <inlineequation><mml:math><mml:mi mathvariant="italic">max</mml:mi></mml:math></inlineequation>
            is the returned value of <constant>GL_MAX_TEXTURE_SIZE</constant>.
        </para>
        <para>
            <constant>GL_INVALID_VALUE</constant> is generated if 
            <inlineequation><mml:math>
                <!-- eqn: xoffset  <  -b: -->
                <mml:mrow>
                    <mml:mi mathvariant="italic">xoffset</mml:mi>
                    <mml:mo>&lt;</mml:mo>
                    <mml:mrow>
                        <mml:mo>-</mml:mo>
                        <mml:mi mathvariant="italic">b</mml:mi>
                    </mml:mrow>
                </mml:mrow>
            </mml:math></inlineequation>,
            <inlineequation><mml:math>
                <!-- eqn: (xoffset  +  width)  >  (w  -  b): -->
                <mml:mrow>
                    <mml:mfenced open="(" close=")">
                        <mml:mrow>
                            <mml:mi mathvariant="italic">xoffset</mml:mi>
                            <mml:mo>+</mml:mo>
                            <mml:mi mathvariant="italic">width</mml:mi>
                        </mml:mrow>
                    </mml:mfenced>
                    <mml:mo>&gt;</mml:mo>
                    <mml:mfenced open="(" close=")">
                        <mml:mrow>
                            <mml:mi mathvariant="italic">w</mml:mi>
                            <mml:mo>-</mml:mo>
                            <mml:mi mathvariant="italic">b</mml:mi>
                        </mml:mrow>
                    </mml:mfenced>
                </mml:mrow>
            </mml:math></inlineequation>,
            <inlineequation><mml:math>
                <!-- eqn: yoffset  <   -b: -->
                <mml:mrow>
                    <mml:mi mathvariant="italic">yoffset</mml:mi>
                    <mml:mo>&lt;</mml:mo>
                    <mml:mrow>
                        <mml:mo>-</mml:mo>
                        <mml:mi mathvariant="italic">b</mml:mi>
                    </mml:mrow>
                </mml:mrow>
            </mml:math></inlineequation>,
            or
            <inlineequation><mml:math>
                <!-- eqn: (yoffset  +  height)  >  (h  - b): -->
                <mml:mrow>
                    <mml:mfenced open="(" close=")">
                        <mml:mrow>
                            <mml:mi mathvariant="italic">yoffset</mml:mi>
                            <mml:mo>+</mml:mo>
                            <mml:mi mathvariant="italic">height</mml:mi>
                        </mml:mrow>
                    </mml:mfenced>
                    <mml:mo>&gt;</mml:mo>
                    <mml:mfenced open="(" close=")">
                        <mml:mrow>
                            <mml:mi mathvariant="italic">h</mml:mi>
                            <mml:mo>-</mml:mo>
                            <mml:mi mathvariant="italic">b</mml:mi>
                        </mml:mrow>
                    </mml:mfenced>
                </mml:mrow>
            </mml:math></inlineequation>,
            where 
            <inlineequation><mml:math><mml:mi mathvariant="italic">w</mml:mi></mml:math></inlineequation>
            is the <constant>GL_TEXTURE_WIDTH</constant>,
            <inlineequation><mml:math><mml:mi mathvariant="italic">h</mml:mi></mml:math></inlineequation>
            is the <constant>GL_TEXTURE_HEIGHT</constant>,
            and 
            <inlineequation><mml:math><mml:mi mathvariant="italic">b</mml:mi></mml:math></inlineequation>
            is the <constant>GL_TEXTURE_BORDER</constant>
            of the texture image being modified.
            Note that 
            <inlineequation><mml:math><mml:mi mathvariant="italic">w</mml:mi></mml:math></inlineequation>
            and 
            <inlineequation><mml:math><mml:mi mathvariant="italic">h</mml:mi></mml:math></inlineequation>
            include twice the border width.
        </para>
    </refsect1>
    <refsect1 id="associatedgets"><title>Associated Gets</title>
        <para>
            <citerefentry><refentrytitle>glGetTexImage</refentrytitle></citerefentry>
        </para>
    </refsect1>
    <refsect1 id="seealso"><title>See Also</title>
        <para>
            <citerefentry><refentrytitle>glCopyTexImage1D</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>glCopyTexImage2D</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>glCopyTexSubImage1D</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>glCopyTexSubImage3D</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>glPixelStore</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>glReadBuffer</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>glTexImage1D</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>glTexImage2D</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>glTexImage3D</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>glTexParameter</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>glTexSubImage1D</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>glTexSubImage2D</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>glTexSubImage3D</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>
Commit	Line	Data
7faf1d71 AW	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="glCopyTexSubImage2D">
	5	<refmeta>
	6	<refmetainfo>
	7	<copyright>
	8	<year>1991-2006</year>
	9	<holder>Silicon Graphics, Inc.</holder>
	10	</copyright>
	11	</refmetainfo>
	12	<refentrytitle>glCopyTexSubImage2D</refentrytitle>
	13	<manvolnum>3G</manvolnum>
	14	</refmeta>
	15	<refnamediv>
	16	<refname>glCopyTexSubImage2D</refname>
	17	<refpurpose>copy a two-dimensional texture subimage</refpurpose>
	18	</refnamediv>
	19	<refsynopsisdiv><title>C Specification</title>
	20	<funcsynopsis>
	21	<funcprototype>
	22	<funcdef>void <function>glCopyTexSubImage2D</function></funcdef>
	23	<paramdef>GLenum <parameter>target</parameter></paramdef>
	24	<paramdef>GLint <parameter>level</parameter></paramdef>
	25	<paramdef>GLint <parameter>xoffset</parameter></paramdef>
	26	<paramdef>GLint <parameter>yoffset</parameter></paramdef>
	27	<paramdef>GLint <parameter>x</parameter></paramdef>
	28	<paramdef>GLint <parameter>y</parameter></paramdef>
	29	<paramdef>GLsizei <parameter>width</parameter></paramdef>
	30	<paramdef>GLsizei <parameter>height</parameter></paramdef>
	31	</funcprototype>
	32	</funcsynopsis>
	33	</refsynopsisdiv>
	34	<!-- eqn: ignoring delim $$ -->
	35	<para>
	36	</para>
	37	<refsect1 id="parameters"><title>Parameters</title>
	38	<variablelist>
	39	<varlistentry>
	40	<term><parameter>target</parameter></term>
	41	<listitem>
	42	<para>
	43	Specifies the target texture.
	44	Must be <constant>GL_TEXTURE_2D</constant>,
	45	<constant>GL_TEXTURE_CUBE_MAP_POSITIVE_X</constant>,
	46	<constant>GL_TEXTURE_CUBE_MAP_NEGATIVE_X</constant>,
	47	<constant>GL_TEXTURE_CUBE_MAP_POSITIVE_Y</constant>,
	48	<constant>GL_TEXTURE_CUBE_MAP_NEGATIVE_Y</constant>,
	49	<constant>GL_TEXTURE_CUBE_MAP_POSITIVE_Z</constant>, or
	50	<constant>GL_TEXTURE_CUBE_MAP_NEGATIVE_Z</constant>.
	51	</para>
	52	</listitem>
	53	</varlistentry>
	54	<varlistentry>
	55	<term><parameter>level</parameter></term>
	56	<listitem>
	57	<para>
	58	Specifies the level-of-detail number.
	59	Level 0 is the base image level.
	60	Level <emphasis>n</emphasis> is the <emphasis>n</emphasis>th mipmap reduction image.
	61	</para>
	62	</listitem>
	63	</varlistentry>
	64	<varlistentry>
65	<term><parameter>xoffset</parameter></term>
66	<listitem>
67	<para>
68	Specifies a texel offset in the x direction within the texture array.
69	</para>
70	</listitem>
71	</varlistentry>
72	<varlistentry>
73	<term><parameter>yoffset</parameter></term>
74	<listitem>
75	<para>
76	Specifies a texel offset in the y direction within the texture array.
77	</para>
78	</listitem>
79	</varlistentry>
80	<varlistentry>
81	<term><parameter>x</parameter></term>
82	<term><parameter>y</parameter></term>
83	<listitem>
84	<para>
85	Specify the window coordinates of the lower left corner
86	of the rectangular region of pixels to be copied.
87	</para>
88	</listitem>
89	</varlistentry>
90	<varlistentry>
91	<term><parameter>width</parameter></term>
92	<listitem>
93	<para>
94	Specifies the width of the texture subimage.
95	</para>
96	</listitem>
97	</varlistentry>
98	<varlistentry>
99	<term><parameter>height</parameter></term>
100	<listitem>
101	<para>
102	Specifies the height of the texture subimage.
103	</para>
104	</listitem>
105	</varlistentry>
106	</variablelist>
107	</refsect1>
108	<refsect1 id="description"><title>Description</title>
109	<para>
110	<function>glCopyTexSubImage2D</function> replaces a rectangular portion of a two-dimensional texture image or
111	cube-map texture image with pixels from the current <constant>GL_READ_BUFFER</constant>
112	(rather than from main memory, as is the case for <citerefentry><refentrytitle>glTexSubImage2D</refentrytitle></citerefentry>).
113	</para>
114	<para>
115	The screen-aligned pixel rectangle with lower left corner at
116	<inlineequation><mml:math>
117	<!-- eqn: (x, y): -->
118	<mml:mfenced open="(" close=")">
119	<mml:mi mathvariant="italic">x</mml:mi>
120	<mml:mi mathvariant="italic">y</mml:mi>
121	</mml:mfenced>
122	</mml:math></inlineequation>
123	and with
124	width <parameter>width</parameter> and height <parameter>height</parameter> replaces the portion of the
125	texture array with x indices <parameter>xoffset</parameter> through
126	<inlineequation><mml:math>
127	<!-- eqn: xoffset + width - 1: -->
128	<mml:mrow>
129	<mml:mi mathvariant="italic">xoffset</mml:mi>
130	<mml:mo>+</mml:mo>
131	<mml:mi mathvariant="italic">width</mml:mi>
132	<mml:mo>-</mml:mo>
133	<mml:mn>1</mml:mn>
134	</mml:mrow>
135	</mml:math></inlineequation>,
136	inclusive, and y indices <parameter>yoffset</parameter> through
137	<inlineequation><mml:math>
138	<!-- eqn: yoffset + height - 1: -->
139	<mml:mrow>
140	<mml:mi mathvariant="italic">yoffset</mml:mi>
141	<mml:mo>+</mml:mo>
142	<mml:mi mathvariant="italic">height</mml:mi>
143	<mml:mo>-</mml:mo>
144	<mml:mn>1</mml:mn>
145	</mml:mrow>
146	</mml:math></inlineequation>,
147	inclusive, at the mipmap level specified by <parameter>level</parameter>.
148	</para>
149	<para>
150	The pixels in the rectangle are processed exactly as if
151	<citerefentry><refentrytitle>glReadPixels</refentrytitle></citerefentry> had been called, but the process stops just before
152	final conversion.
153	At this point, all pixel component values are clamped to the range
154	<inlineequation><mml:math>
155	<!-- eqn: [0,1]: -->
156	<mml:mfenced open="[" close="]">
157	<mml:mn>0</mml:mn>
158	<mml:mn>1</mml:mn>
159	</mml:mfenced>
160	</mml:math></inlineequation>
161	and then converted to the texture's internal format for storage in the texel
162	array.
163	</para>
164	<para>
165	The destination rectangle in the texture array may not include any texels
166	outside the texture array as it was originally specified.
167	It is not an error to specify a subtexture with zero width or height, but
168	such a specification has no effect.
169	</para>
170	<para>
171	If any of the pixels within the specified rectangle of the current
172	<constant>GL_READ_BUFFER</constant> are outside the read window associated with the current
173	rendering context, then the values obtained for those pixels are undefined.
174	</para>
175	<para>
176	No change is made to the <emphasis>internalformat</emphasis>, <emphasis>width</emphasis>,
177	<emphasis>height</emphasis>, or <emphasis>border</emphasis> parameters of the specified texture
178	array or to texel values outside the specified subregion.
179	</para>
180	</refsect1>
181	<refsect1 id="notes"><title>Notes</title>
182	<para>
183	<citerefentry><refentrytitle>glPixelStore</refentrytitle></citerefentry> modes affect texture images.
184	</para>
185	</refsect1>
186	<refsect1 id="errors"><title>Errors</title>
187	<para>
188	<constant>GL_INVALID_ENUM</constant> is generated if <parameter>target</parameter> is not <constant>GL_TEXTURE_2D</constant>,
189	<constant>GL_TEXTURE_CUBE_MAP_POSITIVE_X</constant>,
190	<constant>GL_TEXTURE_CUBE_MAP_NEGATIVE_X</constant>,
191	<constant>GL_TEXTURE_CUBE_MAP_POSITIVE_Y</constant>,
192	<constant>GL_TEXTURE_CUBE_MAP_NEGATIVE_Y</constant>,
193	<constant>GL_TEXTURE_CUBE_MAP_POSITIVE_Z</constant>, or
194	<constant>GL_TEXTURE_CUBE_MAP_NEGATIVE_Z</constant>.
195	</para>
196	<para>
197	<constant>GL_INVALID_OPERATION</constant> is generated if the texture array has not been
198	defined by a previous <citerefentry><refentrytitle>glTexImage2D</refentrytitle></citerefentry> or <citerefentry><refentrytitle>glCopyTexImage2D</refentrytitle></citerefentry> operation.
199	</para>
200	<para>
201	<constant>GL_INVALID_VALUE</constant> is generated if <parameter>level</parameter> is less than 0.
202	</para>
203	<para>
204	<constant>GL_INVALID_VALUE</constant> may be generated if
205	<inlineequation><mml:math>
206	<!-- eqn: level > log sub 2(max): -->
207	<mml:mrow>
208	<mml:mi mathvariant="italic">level</mml:mi>
209	<mml:mo>></mml:mo>
210	<mml:mrow>
211	<mml:msub><mml:mi mathvariant="italic">log</mml:mi>
212	<mml:mn>2</mml:mn>
213	</mml:msub>
214	<mml:mo>⁡</mml:mo>
215	<mml:mfenced open="(" close=")">
216	<mml:mi mathvariant="italic">max</mml:mi>
217	</mml:mfenced>
218	</mml:mrow>
219	</mml:mrow>
220	</mml:math></inlineequation>,
221	where
222	<inlineequation><mml:math><mml:mi mathvariant="italic">max</mml:mi></mml:math></inlineequation>
223	is the returned value of <constant>GL_MAX_TEXTURE_SIZE</constant>.
224	</para>
225	<para>
226	<constant>GL_INVALID_VALUE</constant> is generated if
227	<inlineequation><mml:math>
228	<!-- eqn: xoffset < -b: -->
229	<mml:mrow>
230	<mml:mi mathvariant="italic">xoffset</mml:mi>
231	<mml:mo><</mml:mo>
232	<mml:mrow>
233	<mml:mo>-</mml:mo>
234	<mml:mi mathvariant="italic">b</mml:mi>
235	</mml:mrow>
236	</mml:mrow>
237	</mml:math></inlineequation>,
238	<inlineequation><mml:math>
239	<!-- eqn: (xoffset + width) > (w - b): -->
240	<mml:mrow>
241	<mml:mfenced open="(" close=")">
242	<mml:mrow>
243	<mml:mi mathvariant="italic">xoffset</mml:mi>
244	<mml:mo>+</mml:mo>
245	<mml:mi mathvariant="italic">width</mml:mi>
246	</mml:mrow>
247	</mml:mfenced>
248	<mml:mo>></mml:mo>
249	<mml:mfenced open="(" close=")">
250	<mml:mrow>
251	<mml:mi mathvariant="italic">w</mml:mi>
252	<mml:mo>-</mml:mo>
253	<mml:mi mathvariant="italic">b</mml:mi>
254	</mml:mrow>
255	</mml:mfenced>
256	</mml:mrow>
257	</mml:math></inlineequation>,
258	<inlineequation><mml:math>
259	<!-- eqn: yoffset < -b: -->
260	<mml:mrow>
261	<mml:mi mathvariant="italic">yoffset</mml:mi>
262	<mml:mo><</mml:mo>
263	<mml:mrow>
264	<mml:mo>-</mml:mo>
265	<mml:mi mathvariant="italic">b</mml:mi>
266	</mml:mrow>
267	</mml:mrow>
268	</mml:math></inlineequation>,
269	or
270	<inlineequation><mml:math>
271	<!-- eqn: (yoffset + height) > (h - b): -->
272	<mml:mrow>
273	<mml:mfenced open="(" close=")">
274	<mml:mrow>
275	<mml:mi mathvariant="italic">yoffset</mml:mi>
276	<mml:mo>+</mml:mo>
277	<mml:mi mathvariant="italic">height</mml:mi>
278	</mml:mrow>
279	</mml:mfenced>
280	<mml:mo>></mml:mo>
281	<mml:mfenced open="(" close=")">
282	<mml:mrow>
283	<mml:mi mathvariant="italic">h</mml:mi>
284	<mml:mo>-</mml:mo>
285	<mml:mi mathvariant="italic">b</mml:mi>
286	</mml:mrow>
287	</mml:mfenced>
288	</mml:mrow>
289	</mml:math></inlineequation>,
290	where
291	<inlineequation><mml:math><mml:mi mathvariant="italic">w</mml:mi></mml:math></inlineequation>
292	is the <constant>GL_TEXTURE_WIDTH</constant>,
293	<inlineequation><mml:math><mml:mi mathvariant="italic">h</mml:mi></mml:math></inlineequation>
294	is the <constant>GL_TEXTURE_HEIGHT</constant>,
295	and
296	<inlineequation><mml:math><mml:mi mathvariant="italic">b</mml:mi></mml:math></inlineequation>
297	is the <constant>GL_TEXTURE_BORDER</constant>
298	of the texture image being modified.
299	Note that
300	<inlineequation><mml:math><mml:mi mathvariant="italic">w</mml:mi></mml:math></inlineequation>
301	and
302	<inlineequation><mml:math><mml:mi mathvariant="italic">h</mml:mi></mml:math></inlineequation>
303	include twice the border width.
304	</para>
305	</refsect1>
306	<refsect1 id="associatedgets"><title>Associated Gets</title>
307	<para>
308	<citerefentry><refentrytitle>glGetTexImage</refentrytitle></citerefentry>
309	</para>
310	</refsect1>
311	<refsect1 id="seealso"><title>See Also</title>
312	<para>
313	<citerefentry><refentrytitle>glCopyTexImage1D</refentrytitle></citerefentry>,
314	<citerefentry><refentrytitle>glCopyTexImage2D</refentrytitle></citerefentry>,
315	<citerefentry><refentrytitle>glCopyTexSubImage1D</refentrytitle></citerefentry>,
316	<citerefentry><refentrytitle>glCopyTexSubImage3D</refentrytitle></citerefentry>,
317	<citerefentry><refentrytitle>glPixelStore</refentrytitle></citerefentry>,
318	<citerefentry><refentrytitle>glReadBuffer</refentrytitle></citerefentry>,
319	<citerefentry><refentrytitle>glTexImage1D</refentrytitle></citerefentry>,
320	<citerefentry><refentrytitle>glTexImage2D</refentrytitle></citerefentry>,
321	<citerefentry><refentrytitle>glTexImage3D</refentrytitle></citerefentry>,
322	<citerefentry><refentrytitle>glTexParameter</refentrytitle></citerefentry>,
323	<citerefentry><refentrytitle>glTexSubImage1D</refentrytitle></citerefentry>,
324	<citerefentry><refentrytitle>glTexSubImage2D</refentrytitle></citerefentry>,
325	<citerefentry><refentrytitle>glTexSubImage3D</refentrytitle></citerefentry>
326	</para>
327	</refsect1>
328	<refsect1 id="Copyright"><title>Copyright</title>
329	<para>
330	Copyright <trademark class="copyright"></trademark> 1991-2006
331	Silicon Graphics, Inc. This document is licensed under the SGI
332	Free Software B License. For details, see
333	<ulink url="http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/</ulink>.
334	</para>
335	</refsect1>
336	</refentry>