forked from BSVino/docs.gl
-
Notifications
You must be signed in to change notification settings - Fork 0
/
glCopyTexSubImage2D.xhtml
529 lines (519 loc) · 25.6 KB
/
glCopyTexSubImage2D.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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
<div class="refentry" id="glCopyTexSubImage2D">
<div class="titlepage"></div>
<div class="refnamediv">
<h2>Name</h2>
<p>glCopyTexSubImage2D, glCopyTextureSubImage2D — copy a two-dimensional texture subimage</p>
</div>
<div class="refsynopsisdiv">
<h2>C Specification</h2>
<div class="funcsynopsis">
<table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table">
<tr>
<td>
<code class="funcdef">void <strong class="fsfunc">glCopyTexSubImage2D</strong>(</code>
</td>
<td>GLenum <var class="pdparam">target</var>, </td>
</tr>
<tr>
<td> </td>
<td>GLint <var class="pdparam">level</var>, </td>
</tr>
<tr>
<td> </td>
<td>GLint <var class="pdparam">xoffset</var>, </td>
</tr>
<tr>
<td> </td>
<td>GLint <var class="pdparam">yoffset</var>, </td>
</tr>
<tr>
<td> </td>
<td>GLint <var class="pdparam">x</var>, </td>
</tr>
<tr>
<td> </td>
<td>GLint <var class="pdparam">y</var>, </td>
</tr>
<tr>
<td> </td>
<td>GLsizei <var class="pdparam">width</var>, </td>
</tr>
<tr>
<td> </td>
<td>GLsizei <var class="pdparam">height</var><code>)</code>;</td>
</tr>
</table>
<div class="funcprototype-spacer"> </div>
<table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table">
<tr>
<td>
<code class="funcdef">void <strong class="fsfunc">glCopyTextureSubImage2D</strong>(</code>
</td>
<td>GLuint <var class="pdparam">texture</var>, </td>
</tr>
<tr>
<td> </td>
<td>GLint <var class="pdparam">level</var>, </td>
</tr>
<tr>
<td> </td>
<td>GLint <var class="pdparam">xoffset</var>, </td>
</tr>
<tr>
<td> </td>
<td>GLint <var class="pdparam">yoffset</var>, </td>
</tr>
<tr>
<td> </td>
<td>GLint <var class="pdparam">x</var>, </td>
</tr>
<tr>
<td> </td>
<td>GLint <var class="pdparam">y</var>, </td>
</tr>
<tr>
<td> </td>
<td>GLsizei <var class="pdparam">width</var>, </td>
</tr>
<tr>
<td> </td>
<td>GLsizei <var class="pdparam">height</var><code>)</code>;</td>
</tr>
</table>
<div class="funcprototype-spacer"> </div>
</div>
</div>
<div class="refsect1" id="parameters">
<h2>Parameters</h2>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<em class="parameter">
<code>target</code>
</em>
</span>
</dt>
<dd>
<p>Specifies the target to which the texture object is bound for
<code class="function">glCopyTexSubImage2D</code> function. Must be
<code class="constant">GL_TEXTURE_1D_ARRAY</code>,
<code class="constant">GL_TEXTURE_2D</code>,
<code class="constant">GL_TEXTURE_CUBE_MAP_POSITIVE_X</code>,
<code class="constant">GL_TEXTURE_CUBE_MAP_NEGATIVE_X</code>,
<code class="constant">GL_TEXTURE_CUBE_MAP_POSITIVE_Y</code>,
<code class="constant">GL_TEXTURE_CUBE_MAP_NEGATIVE_Y</code>,
<code class="constant">GL_TEXTURE_CUBE_MAP_POSITIVE_Z</code>,
<code class="constant">GL_TEXTURE_CUBE_MAP_NEGATIVE_Z</code>, or
<code class="constant">GL_TEXTURE_RECTANGLE</code>.</p>
</dd>
<dt>
<span class="term">
<em class="parameter">
<code>texture</code>
</em>
</span>
</dt>
<dd>
<p>Specifies the texture object name for
<code class="function">glCopyTextureSubImage2D</code> function.</p>
</dd>
<dt>
<span class="term">
<em class="parameter">
<code>level</code>
</em>
</span>
</dt>
<dd>
<p>Specifies the level-of-detail number. Level 0 is the base
image level. Level <span class="emphasis"><em>n</em></span> is the
<span class="emphasis"><em>n</em></span>th mipmap reduction image.</p>
</dd>
<dt>
<span class="term">
<em class="parameter">
<code>xoffset</code>
</em>
</span>
</dt>
<dd>
<p>Specifies a texel offset in the x direction within the texture
array.</p>
</dd>
<dt>
<span class="term">
<em class="parameter">
<code>yoffset</code>
</em>
</span>
</dt>
<dd>
<p>Specifies a texel offset in the y direction within the texture
array.</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>Specify the window coordinates of the lower left corner of the
rectangular region of pixels to be copied.</p>
</dd>
<dt>
<span class="term">
<em class="parameter">
<code>width</code>
</em>
</span>
</dt>
<dd>
<p>Specifies the width of the texture subimage.</p>
</dd>
<dt>
<span class="term">
<em class="parameter">
<code>height</code>
</em>
</span>
</dt>
<dd>
<p>Specifies the height of the texture subimage.</p>
</dd>
</dl>
</div>
</div>
<div class="refsect1" id="description">
<h2>Description</h2>
<p><code class="function">glCopyTexSubImage2D</code> and
<code class="function">glCopyTextureSubImage2D</code> replace a rectangular portion
of a two-dimensional texture image, cube-map texture image, rectangular
image, or a linear portion of a number of slices of a one-dimensional
array texture with pixels from the current
<code class="constant">GL_READ_BUFFER</code> (rather than from main memory, as is
the case for <a class="citerefentry" href="glTexSubImage2D"><span class="citerefentry"><span class="refentrytitle">glTexSubImage2D</span></span></a>).</p>
<p>The screen-aligned pixel rectangle with lower left corner at
<math overflow="scroll">
<mfenced open="(" close=")">
<mi mathvariant="italic">x</mi>
<mi mathvariant="italic">y</mi>
</mfenced>
</math> and with width <em class="parameter"><code>width</code></em> and height
<em class="parameter"><code>height</code></em> replaces the portion of the texture array
with x indices <em class="parameter"><code>xoffset</code></em> through <math overflow="scroll">
<mrow>
<mi mathvariant="italic">xoffset</mi>
<mo>+</mo>
<mi mathvariant="italic">width</mi>
<mo>-</mo>
<mn>1</mn>
</mrow>
</math>, inclusive, and y indices
<em class="parameter"><code>yoffset</code></em> through <math overflow="scroll">
<mrow>
<mi mathvariant="italic">yoffset</mi>
<mo>+</mo>
<mi mathvariant="italic">height</mi>
<mo>-</mo>
<mn>1</mn>
</mrow>
</math>, inclusive, at the mipmap level specified by
<em class="parameter"><code>level</code></em>.</p>
<p>The pixels in the rectangle are processed exactly as if
<a class="citerefentry" href="glReadPixels"><span class="citerefentry"><span class="refentrytitle">glReadPixels</span></span></a> had been called, but the process stops just before final
conversion. At this point, all pixel component values are clamped to the
range <math overflow="scroll">
<mfenced open="[" close="]">
<mn>0</mn>
<mn>1</mn>
</mfenced>
</math> and then converted to the texture's internal format
for storage in the texel array.</p>
<p>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.</p>
<p>When <em class="parameter"><code>target</code></em> is
<code class="constant">GL_TEXTURE_1D_ARRAY</code> then the y coordinate and height
are treated as the start slice and number of slices to modify.</p>
<p>If any of the pixels within the specified rectangle of the current
<code class="constant">GL_READ_BUFFER</code> are outside the read window associated
with the current rendering context, then the values obtained for those
pixels are undefined.</p>
<p>No change is made to the <span class="emphasis"><em>internalformat</em></span>,
<span class="emphasis"><em>width</em></span>, or <span class="emphasis"><em>height</em></span>, parameters of
the specified texture array or to texel values outside the specified
subregion.</p>
</div>
<div class="refsect1" id="notes">
<h2>Notes</h2>
<p>
<a class="citerefentry" href="glPixelStore"><span class="citerefentry"><span class="refentrytitle">glPixelStore</span></span></a> modes affect texture images.
</p>
</div>
<div class="refsect1" id="errors">
<h2>Errors</h2>
<p><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>,
<code class="constant">GL_TEXTURE_CUBE_MAP_POSITIVE_X</code>,
<code class="constant">GL_TEXTURE_CUBE_MAP_NEGATIVE_X</code>,
<code class="constant">GL_TEXTURE_CUBE_MAP_POSITIVE_Y</code>,
<code class="constant">GL_TEXTURE_CUBE_MAP_NEGATIVE_Y</code>,
<code class="constant">GL_TEXTURE_CUBE_MAP_POSITIVE_Z</code>,
<code class="constant">GL_TEXTURE_CUBE_MAP_NEGATIVE_Z</code>,
<code class="constant">GL_TEXTURE_1D_ARRAY</code>, or
<code class="constant">GL_RECTANGLE</code>.</p>
<p><code class="constant">GL_INVALID_FRAMEBUFFER_OPERATION</code> is generated
if the object bound to <code class="constant">GL_READ_FRAMEBUFFER_BINDING</code> is
not framebuffer complete.</p>
<p><code class="constant">GL_INVALID_OPERATION</code> is generated if the
texture array has not been defined by a previous <a class="citerefentry" href="glTexImage2D"><span class="citerefentry"><span class="refentrytitle">glTexImage2D</span></span></a>, <a class="citerefentry" href="glTexStorage2D"><span class="citerefentry"><span class="refentrytitle">glTexStorage2D</span></span></a> or <a class="citerefentry" href="glCopyTexImage2D"><span class="citerefentry"><span class="refentrytitle">glCopyTexImage2D</span></span></a> operation.</p>
<p><code class="constant">GL_INVALID_OPERATION</code> is generated by
<code class="function">glCopyTextureSubImage2D</code> if
<em class="parameter"><code>texture</code></em> is not the name of an existing texture
object.</p>
<p><code class="constant">GL_INVALID_OPERATION</code> is generated by
<code class="function">glCopyTextureSubImage2D</code> if the effective target of
texture does not correspond to one of the texture targets supported by the
function.</p>
<p><code class="constant">GL_INVALID_VALUE</code> is generated if
<em class="parameter"><code>level</code></em> is less than 0.</p>
<p><code class="constant">GL_INVALID_VALUE</code> is generated if the effective
target is <code class="constant">GL_TEXTURE_RECTANGLE</code> and
<em class="parameter"><code>level</code></em> is not zero.</p>
<p><code class="constant">GL_INVALID_VALUE</code> may be generated if
<math overflow="scroll">
<mrow>
<mi mathvariant="italic">level</mi>
<mo>></mo>
<mrow>
<msub><mi mathvariant="italic">log</mi>
<mn>2</mn>
</msub>
<mo></mo>
<mfenced open="(" close=")">
<mi mathvariant="italic">max</mi>
</mfenced>
</mrow>
</mrow>
</math>, where <math overflow="scroll"><mi mathvariant="italic">max</mi></math> is the returned value of
<code class="constant">GL_MAX_TEXTURE_SIZE</code>.</p>
<p><code class="constant">GL_INVALID_VALUE</code> is generated if
<math overflow="scroll">
<mrow>
<mi mathvariant="italic">xoffset</mi>
<mo><</mo>
<mn>0</mn>
</mrow>
</math>, <math overflow="scroll">
<mrow>
<mfenced open="(" close=")">
<mrow>
<mi mathvariant="italic">xoffset</mi>
<mo>+</mo>
<mi mathvariant="italic">width</mi>
</mrow>
</mfenced>
<mo>></mo>
<mi mathvariant="italic">w</mi>
</mrow>
</math>,
<math overflow="scroll">
<mrow>
<mi mathvariant="italic">yoffset</mi>
<mo><</mo>
<mn>0</mn>
</mrow>
</math>,
or
<math overflow="scroll">
<mrow>
<mfenced open="(" close=")">
<mrow>
<mi mathvariant="italic">yoffset</mi>
<mo>+</mo>
<mi mathvariant="italic">height</mi>
</mrow>
</mfenced>
<mo>></mo>
<mn>0</mn>
</mrow>
</math>,, where <math overflow="scroll"><mi mathvariant="italic">w</mi></math> is the <code class="constant">GL_TEXTURE_WIDTH</code>,
<math overflow="scroll"><mi mathvariant="italic">h</mi></math>
is the <code class="constant">GL_TEXTURE_HEIGHT</code> and
of the texture image being modified.
</p>
<p><code class="constant">GL_INVALID_OPERATION</code> is generated if:</p>
<div class="itemizedlist">
<ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem">
<p>the read buffer is <code class="constant">GL_NONE</code>, or</p>
</li>
<li class="listitem">
<p>the value of <code class="constant">GL_READ_FRAMEBUFFER_BINDING</code>
is non-zero, and:</p>
<div class="itemizedlist">
<ul class="itemizedlist" style="list-style-type: circle; ">
<li class="listitem">
<p>the read buffer selects an attachment that has no image
attached, or</p>
</li>
<li class="listitem">
<p>the effective value of
<code class="constant">GL_SAMPLE_BUFFERS</code> for the read
framebuffer is one.</p>
</li>
</ul>
</div>
</li>
</ul>
</div>
</div>
<div class="refsect1" id="associatedgets">
<h2>Associated Gets</h2>
<p>
<a class="citerefentry" href="glGetTexImage"><span class="citerefentry"><span class="refentrytitle">glGetTexImage</span></span></a>
</p>
</div>
{$pipelinestall}{$examples}
<div class="refsect1" id="versions">
<h2>Version Support</h2>
<div class="informaltable">
<table style="border-collapse: collapse; border-top: 2px solid ; border-bottom: 2px solid ; border-left: 2px solid ; border-right: 2px solid ; ">
<colgroup>
<col style="text-align: left; "/>
<col style="text-align: center; " class="firstvers"/>
<col style="text-align: center; "/>
<col style="text-align: center; "/>
<col style="text-align: center; "/>
<col style="text-align: center; "/>
<col style="text-align: center; "/>
<col style="text-align: center; "/>
<col style="text-align: center; "/>
<col style="text-align: center; "/>
<col style="text-align: center; "/>
<col style="text-align: center; "/>
<col style="text-align: center; " class="lastvers"/>
</colgroup>
<thead>
<tr>
<th style="text-align: left; border-right: 2px solid ; ">
</th>
<th style="text-align: center; border-bottom: 2px solid ; " colspan="12">
<span class="bold"><strong>OpenGL Version</strong></span>
</th>
</tr>
<tr>
<th style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>Function / Feature Name</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>2.0</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>2.1</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>3.0</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>3.1</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>3.2</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>3.3</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>4.0</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>4.1</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>4.2</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>4.3</strong></span>
</th>
<th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>4.4</strong></span>
</th>
<th style="text-align: center; border-bottom: 2px solid ; ">
<span class="bold"><strong>4.5</strong></span>
</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">
<code class="function">glCopyTexSubImage2D</code>
</td>
<td style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">✔</td>
<td style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">✔</td>
<td style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">✔</td>
<td style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">✔</td>
<td style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">✔</td>
<td style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">✔</td>
<td style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">✔</td>
<td style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">✔</td>
<td style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">✔</td>
<td style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">✔</td>
<td style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">✔</td>
<td style="text-align: center; border-bottom: 2px solid ; ">✔</td>
</tr>
<tr>
<td style="text-align: left; border-right: 2px solid ; ">
<code class="function">glCopyTextureSubImage2D</code>
</td>
<td style="text-align: center; border-right: 2px solid ; ">-</td>
<td style="text-align: center; border-right: 2px solid ; ">-</td>
<td style="text-align: center; border-right: 2px solid ; ">-</td>
<td style="text-align: center; border-right: 2px solid ; ">-</td>
<td style="text-align: center; border-right: 2px solid ; ">-</td>
<td style="text-align: center; border-right: 2px solid ; ">-</td>
<td style="text-align: center; border-right: 2px solid ; ">-</td>
<td style="text-align: center; border-right: 2px solid ; ">-</td>
<td style="text-align: center; border-right: 2px solid ; ">-</td>
<td style="text-align: center; border-right: 2px solid ; ">-</td>
<td style="text-align: center; border-right: 2px solid ; ">-</td>
<td style="text-align: center; ">✔</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="refsect1" id="seealso">
<h2>See Also</h2>
<p>
<a class="citerefentry" href="glCopyTexImage1D"><span class="citerefentry"><span class="refentrytitle">glCopyTexImage1D</span></span></a>,
<a class="citerefentry" href="glCopyTexImage2D"><span class="citerefentry"><span class="refentrytitle">glCopyTexImage2D</span></span></a>,
<a class="citerefentry" href="glCopyTexSubImage1D"><span class="citerefentry"><span class="refentrytitle">glCopyTexSubImage1D</span></span></a>,
<a class="citerefentry" href="glCopyTexSubImage3D"><span class="citerefentry"><span class="refentrytitle">glCopyTexSubImage3D</span></span></a>,
<a class="citerefentry" href="glPixelStore"><span class="citerefentry"><span class="refentrytitle">glPixelStore</span></span></a>,
<a class="citerefentry" href="glReadBuffer"><span class="citerefentry"><span class="refentrytitle">glReadBuffer</span></span></a>,
<a class="citerefentry" href="glTexImage1D"><span class="citerefentry"><span class="refentrytitle">glTexImage1D</span></span></a>,
<a class="citerefentry" href="glTexImage2D"><span class="citerefentry"><span class="refentrytitle">glTexImage2D</span></span></a>,
<a class="citerefentry" href="glTexImage3D"><span class="citerefentry"><span class="refentrytitle">glTexImage3D</span></span></a>,
<a class="citerefentry" href="glTexParameter"><span class="citerefentry"><span class="refentrytitle">glTexParameter</span></span></a>,
<a class="citerefentry" href="glTexSubImage1D"><span class="citerefentry"><span class="refentrytitle">glTexSubImage1D</span></span></a>,
<a class="citerefentry" href="glTexSubImage2D"><span class="citerefentry"><span class="refentrytitle">glTexSubImage2D</span></span></a>,
<a class="citerefentry" href="glTexSubImage3D"><span class="citerefentry"><span class="refentrytitle">glTexSubImage3D</span></span></a>
</p>
</div>
<div class="refsect1" id="Copyright">
<h2>Copyright</h2>
<p>
Copyright © 1991-2006
Silicon Graphics, Inc. Copyright © 2012-2014 Khronos Group.
This document is licensed under the SGI
Free Software B License. For details, see
<a class="link" 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>