HCoop / clinton / guile-figl.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
rename upstream-man-pages to upstream-doc
[clinton/guile-figl.git] / upstream-doc / man2 / xhtml / glCopyTexSubImage2D.xml
CommitLineData
7faf1d71
AW		 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>glCopyTexSubImage2D</title><meta name="generator" content="DocBook XSL Stylesheets V1.73.2" /></head><body><div class="refentry" lang="en" xml:lang="en"><a id="glCopyTexSubImage2D"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glCopyTexSubImage2D — copy a two-dimensional texture subimage</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">glCopyTexSubImage2D</b>(</code></td><td>GLenum  </td><td><var class="pdparam">target</var>, </td></tr><tr><td> </td><td>GLint  </td><td><var class="pdparam">level</var>, </td></tr><tr><td> </td><td>GLint  </td><td><var class="pdparam">xoffset</var>, </td></tr><tr><td> </td><td>GLint  </td><td><var class="pdparam">yoffset</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>, </td></tr><tr><td> </td><td>GLsizei  </td><td><var class="pdparam">height</var><code>)</code>;</td></tr></table></div></div><p>
4 </p><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>
5 Specifies the target texture.
6 Must be <code class="constant">GL_TEXTURE_2D</code>,
7 <code class="constant">GL_TEXTURE_CUBE_MAP_POSITIVE_X</code>,
8 <code class="constant">GL_TEXTURE_CUBE_MAP_NEGATIVE_X</code>,
9 <code class="constant">GL_TEXTURE_CUBE_MAP_POSITIVE_Y</code>,
10 <code class="constant">GL_TEXTURE_CUBE_MAP_NEGATIVE_Y</code>,
11 <code class="constant">GL_TEXTURE_CUBE_MAP_POSITIVE_Z</code>, or
12 <code class="constant">GL_TEXTURE_CUBE_MAP_NEGATIVE_Z</code>.
13 </p></dd><dt><span class="term"><em class="parameter"><code>level</code></em></span></dt><dd><p>
14 Specifies the level-of-detail number.
15 Level 0 is the base image level.
16 Level <span class="emphasis"><em>n</em></span> is the <span class="emphasis"><em>n</em></span>th mipmap reduction image.
17 </p></dd><dt><span class="term"><em class="parameter"><code>xoffset</code></em></span></dt><dd><p>
18 Specifies a texel offset in the x direction within the texture array.
19 </p></dd><dt><span class="term"><em class="parameter"><code>yoffset</code></em></span></dt><dd><p>
20 Specifies a texel offset in the y direction within the texture array.
21 </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>
22 Specify the window coordinates of the lower left corner
23 of the rectangular region of pixels to be copied.
24 </p></dd><dt><span class="term"><em class="parameter"><code>width</code></em></span></dt><dd><p>
25 Specifies the width of the texture subimage.
26 </p></dd><dt><span class="term"><em class="parameter"><code>height</code></em></span></dt><dd><p>
27 Specifies the height of the texture subimage.
28 </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
29 <code class="function">glCopyTexSubImage2D</code> replaces a rectangular portion of a two-dimensional texture image or
30 cube-map texture image with pixels from the current <code class="constant">GL_READ_BUFFER</code>
31 (rather than from main memory, as is the case for <a class="citerefentry" href="glTexSubImage2D.xml"><span class="citerefentry"><span class="refentrytitle">glTexSubImage2D</span></span></a>).
32 </p><p>
33 The screen-aligned pixel rectangle with lower left corner at
34 <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
35
36 <mml:mfenced open="(" close=")">
37 <mml:mi mathvariant="italic">x</mml:mi>
38 <mml:mi mathvariant="italic">y</mml:mi>
39 </mml:mfenced>
40 </mml:math>
41 and with
42 width <em class="parameter"><code>width</code></em> and height <em class="parameter"><code>height</code></em> replaces the portion of the
43 texture array with x indices <em class="parameter"><code>xoffset</code></em> through
44 <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
45
46 <mml:mrow>
47 <mml:mi mathvariant="italic">xoffset</mml:mi>
48 <mml:mo>+</mml:mo>
49 <mml:mi mathvariant="italic">width</mml:mi>
50 <mml:mo>-</mml:mo>
51 <mml:mn>1</mml:mn>
52 </mml:mrow>
53 </mml:math>,
54 inclusive, and y indices <em class="parameter"><code>yoffset</code></em> through
55 <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
56
57 <mml:mrow>
58 <mml:mi mathvariant="italic">yoffset</mml:mi>
59 <mml:mo>+</mml:mo>
60 <mml:mi mathvariant="italic">height</mml:mi>
61 <mml:mo>-</mml:mo>
62 <mml:mn>1</mml:mn>
63 </mml:mrow>
64 </mml:math>,
65 inclusive, at the mipmap level specified by <em class="parameter"><code>level</code></em>.
66 </p><p>
67 The pixels in the rectangle are processed exactly as if
68 <a class="citerefentry" href="glCopyPixels.xml"><span class="citerefentry"><span class="refentrytitle">glCopyPixels</span></span></a> had been called, but the process stops just before
69 final conversion.
70 At this point, all pixel component values are clamped to the range
71 <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
72
73 <mml:mfenced open="[" close="]">
74 <mml:mn>0</mml:mn>
75 <mml:mn>1</mml:mn>
76 </mml:mfenced>
77 </mml:math>
78 and then converted to the texture's internal format for storage in the texel
79 array.
80 </p><p>
81 The destination rectangle in the texture array may not include any texels
82 outside the texture array as it was originally specified.
83 It is not an error to specify a subtexture with zero width or height, but
84 such a specification has no effect.
85 </p><p>
86 If any of the pixels within the specified rectangle of the current
87 <code class="constant">GL_READ_BUFFER</code> are outside the read window associated with the current
88 rendering context, then the values obtained for those pixels are undefined.
89 </p><p>
90 No change is made to the <span class="emphasis"><em>internalformat</em></span>, <span class="emphasis"><em>width</em></span>,
91 <span class="emphasis"><em>height</em></span>, or <span class="emphasis"><em>border</em></span> parameters of the specified texture
92 array or to texel values outside the specified subregion.
93 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="notes"></a><h2>Notes</h2><p>
94 <code class="function">glCopyTexSubImage2D</code> is available only if the GL version is 1.1 or greater.
95 </p><p>
96 <code class="constant">GL_TEXTURE_CUBE_MAP_POSITIVE_X</code>,
97 <code class="constant">GL_TEXTURE_CUBE_MAP_NEGATIVE_X</code>,
98 <code class="constant">GL_TEXTURE_CUBE_MAP_POSITIVE_Y</code>,
99 <code class="constant">GL_TEXTURE_CUBE_MAP_NEGATIVE_Y</code>,
100 <code class="constant">GL_TEXTURE_CUBE_MAP_POSITIVE_Z</code>,
101 <code class="constant">GL_TEXTURE_CUBE_MAP_NEGATIVE_Z</code>, or
102 <code class="constant">GL_PROXY_TEXTURE_CUBE_MAP</code> are available only if the GL version is 1.3
103 or greater.
104 </p><p>
105 Texturing has no effect in color index mode.
106 </p><p>
107 <a class="citerefentry" href="glPixelStore.xml"><span class="citerefentry"><span class="refentrytitle">glPixelStore</span></span></a> and <a class="citerefentry" href="glPixelTransfer.xml"><span class="citerefentry"><span class="refentrytitle">glPixelTransfer</span></span></a> modes affect texture images
108 in exactly the way they affect <a class="citerefentry" href="glDrawPixels.xml"><span class="citerefentry"><span class="refentrytitle">glDrawPixels</span></span></a>.
109 </p><p>
110 When the <code class="code">ARB_imaging</code> extension is supported, the RGBA components
111 read from the framebuffer may be processed by the imaging pipeline. See
112 <a class="citerefentry" href="glTexImage1D.xml"><span class="citerefentry"><span class="refentrytitle">glTexImage1D</span></span></a> for specific details.
113 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p>
114 <code class="constant">GL_INVALID_ENUM</code> is generated if <em class="parameter"><code>target</code></em> is not <code class="constant">GL_TEXTURE_2D</code>,
115 <code class="constant">GL_TEXTURE_CUBE_MAP_POSITIVE_X</code>,
116 <code class="constant">GL_TEXTURE_CUBE_MAP_NEGATIVE_X</code>,
117 <code class="constant">GL_TEXTURE_CUBE_MAP_POSITIVE_Y</code>,
118 <code class="constant">GL_TEXTURE_CUBE_MAP_NEGATIVE_Y</code>,
119 <code class="constant">GL_TEXTURE_CUBE_MAP_POSITIVE_Z</code>, or
120 <code class="constant">GL_TEXTURE_CUBE_MAP_NEGATIVE_Z</code>.
121 </p><p>
122 <code class="constant">GL_INVALID_OPERATION</code> is generated if the texture array has not been
123 defined by a previous <a class="citerefentry" href="glTexImage2D.xml"><span class="citerefentry"><span class="refentrytitle">glTexImage2D</span></span></a> or <a class="citerefentry" href="glCopyTexImage2D.xml"><span class="citerefentry"><span class="refentrytitle">glCopyTexImage2D</span></span></a> operation.
124 </p><p>
125 <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>level</code></em> is less than 0.
126 </p><p>
127 <code class="constant">GL_INVALID_VALUE</code> may be generated if
128 <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
129
130 <mml:mrow>
131 <mml:mi mathvariant="italic">level</mml:mi>
132 <mml:mo>&gt;</mml:mo>
133 <mml:mrow>
134 <mml:msub><mml:mi mathvariant="italic">log</mml:mi>
135 <mml:mn>2</mml:mn>
136 </mml:msub>
137 <mml:mo>⁡</mml:mo>
138 <mml:mfenced open="(" close=")">
139 <mml:mi mathvariant="italic">max</mml:mi>
140 </mml:mfenced>
141 </mml:mrow>
142 </mml:mrow>
143 </mml:math>,
144 where
145 <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll"><mml:mi mathvariant="italic">max</mml:mi></mml:math>
146 is the returned value of <code class="constant">GL_MAX_TEXTURE_SIZE</code>.
147 </p><p>
148 <code class="constant">GL_INVALID_VALUE</code> is generated if
149 <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
150
151 <mml:mrow>
152 <mml:mi mathvariant="italic">xoffset</mml:mi>
153 <mml:mo>&lt;</mml:mo>
154 <mml:mrow>
155 <mml:mo>-</mml:mo>
156 <mml:mi mathvariant="italic">b</mml:mi>
157 </mml:mrow>
158 </mml:mrow>
159 </mml:math>,
160 <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
161
162 <mml:mrow>
163 <mml:mfenced open="(" close=")">
164 <mml:mrow>
165 <mml:mi mathvariant="italic">xoffset</mml:mi>
166 <mml:mo>+</mml:mo>
167 <mml:mi mathvariant="italic">width</mml:mi>
168 </mml:mrow>
169 </mml:mfenced>
170 <mml:mo>&gt;</mml:mo>
171 <mml:mfenced open="(" close=")">
172 <mml:mrow>
173 <mml:mi mathvariant="italic">w</mml:mi>
174 <mml:mo>-</mml:mo>
175 <mml:mi mathvariant="italic">b</mml:mi>
176 </mml:mrow>
177 </mml:mfenced>
178 </mml:mrow>
179 </mml:math>,
180 <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
181
182 <mml:mrow>
183 <mml:mi mathvariant="italic">yoffset</mml:mi>
184 <mml:mo>&lt;</mml:mo>
185 <mml:mrow>
186 <mml:mo>-</mml:mo>
187 <mml:mi mathvariant="italic">b</mml:mi>
188 </mml:mrow>
189 </mml:mrow>
190 </mml:math>,
191 or
192 <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
193
194 <mml:mrow>
195 <mml:mfenced open="(" close=")">
196 <mml:mrow>
197 <mml:mi mathvariant="italic">yoffset</mml:mi>
198 <mml:mo>+</mml:mo>
199 <mml:mi mathvariant="italic">height</mml:mi>
200 </mml:mrow>
201 </mml:mfenced>
202 <mml:mo>&gt;</mml:mo>
203 <mml:mfenced open="(" close=")">
204 <mml:mrow>
205 <mml:mi mathvariant="italic">h</mml:mi>
206 <mml:mo>-</mml:mo>
207 <mml:mi mathvariant="italic">b</mml:mi>
208 </mml:mrow>
209 </mml:mfenced>
210 </mml:mrow>
211 </mml:math>,
212 where
213 <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll"><mml:mi mathvariant="italic">w</mml:mi></mml:math>
214 is the <code class="constant">GL_TEXTURE_WIDTH</code>,
215 <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll"><mml:mi mathvariant="italic">h</mml:mi></mml:math>
216 is the <code class="constant">GL_TEXTURE_HEIGHT</code>,
217 and
218 <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll"><mml:mi mathvariant="italic">b</mml:mi></mml:math>
219 is the <code class="constant">GL_TEXTURE_BORDER</code>
220 of the texture image being modified.
221 Note that
222 <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll"><mml:mi mathvariant="italic">w</mml:mi></mml:math>
223 and
224 <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll"><mml:mi mathvariant="italic">h</mml:mi></mml:math>
225 include twice the border width.
226 </p><p>
227 <code class="constant">GL_INVALID_OPERATION</code> is generated if <code class="function">glCopyTexSubImage2D</code> is executed
228 between the execution of <a class="citerefentry" href="glBegin.xml"><span class="citerefentry"><span class="refentrytitle">glBegin</span></span></a> and the corresponding
229 execution of <a class="citerefentry" href="glEnd.xml"><span class="citerefentry"><span class="refentrytitle">glEnd</span></span></a>.
230 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="associatedgets"></a><h2>Associated Gets</h2><p>
231 <a class="citerefentry" href="glGetTexImage.xml"><span class="citerefentry"><span class="refentrytitle">glGetTexImage</span></span></a>
232 </p><p>
233 <a class="citerefentry" href="glIsEnabled.xml"><span class="citerefentry"><span class="refentrytitle">glIsEnabled</span></span></a> with argument <code class="constant">GL_TEXTURE_2D</code>
234 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
235 <a class="citerefentry" href="glCopyPixels.xml"><span class="citerefentry"><span class="refentrytitle">glCopyPixels</span></span></a>,
236 <a class="citerefentry" href="glCopyTexImage1D.xml"><span class="citerefentry"><span class="refentrytitle">glCopyTexImage1D</span></span></a>,
237 <a class="citerefentry" href="glCopyTexImage2D.xml"><span class="citerefentry"><span class="refentrytitle">glCopyTexImage2D</span></span></a>,
238 <a class="citerefentry" href="glCopyTexSubImage1D.xml"><span class="citerefentry"><span class="refentrytitle">glCopyTexSubImage1D</span></span></a>,
239 <a class="citerefentry" href="glCopyTexSubImage3D.xml"><span class="citerefentry"><span class="refentrytitle">glCopyTexSubImage3D</span></span></a>,
240 <a class="citerefentry" href="glPixelStore.xml"><span class="citerefentry"><span class="refentrytitle">glPixelStore</span></span></a>,
241 <a class="citerefentry" href="glPixelTransfer.xml"><span class="citerefentry"><span class="refentrytitle">glPixelTransfer</span></span></a>,
242 <a class="citerefentry" href="glReadBuffer.xml"><span class="citerefentry"><span class="refentrytitle">glReadBuffer</span></span></a>,
243 <a class="citerefentry" href="glTexEnv.xml"><span class="citerefentry"><span class="refentrytitle">glTexEnv</span></span></a>,
244 <a class="citerefentry" href="glTexGen.xml"><span class="citerefentry"><span class="refentrytitle">glTexGen</span></span></a>,
245 <a class="citerefentry" href="glTexImage1D.xml"><span class="citerefentry"><span class="refentrytitle">glTexImage1D</span></span></a>,
246 <a class="citerefentry" href="glTexImage2D.xml"><span class="citerefentry"><span class="refentrytitle">glTexImage2D</span></span></a>,
247 <a class="citerefentry" href="glTexImage3D.xml"><span class="citerefentry"><span class="refentrytitle">glTexImage3D</span></span></a>,
248 <a class="citerefentry" href="glTexParameter.xml"><span class="citerefentry"><span class="refentrytitle">glTexParameter</span></span></a>,
249 <a class="citerefentry" href="glTexSubImage1D.xml"><span class="citerefentry"><span class="refentrytitle">glTexSubImage1D</span></span></a>,
250 <a class="citerefentry" href="glTexSubImage2D.xml"><span class="citerefentry"><span class="refentrytitle">glTexSubImage2D</span></span></a>,
251 <a class="citerefentry" href="glTexSubImage3D.xml"><span class="citerefentry"><span class="refentrytitle">glTexSubImage3D</span></span></a>
252 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
253 Copyright <span class="trademark"></span>© 1991-2006
254 Silicon Graphics, Inc. This document is licensed under the SGI
255 Free Software B License. For details, see
256 <a class="ulink" href="http://oss.sgi.com/projects/FreeB/" target="_top">http://oss.sgi.com/projects/FreeB/</a>.
257 </p></div></div></body></html>
Unnamed repository; edit this file 'description' to name the repository.