forked from BSVino/docs.gl
-
Notifications
You must be signed in to change notification settings - Fork 0
/
glCopyTexSubImage3D.xhtml
211 lines (201 loc) · 14 KB
/
glCopyTexSubImage3D.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
<div class="refentry"><a id="glCopyTexSubImage3D"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glCopyTexSubImage3D — copy a three-dimensional texture subimage</p></div><div class="refsynopsisdiv"><h2>C Specification</h2><div class="funcsynopsis"><table class="funcprototype-table" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">void <strong class="fsfunc">glCopyTexSubImage3D</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">zoffset</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><p>
</p><div class="refsect1"><a id="parameters"></a><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 texture.
Must be <code class="constant">GL_TEXTURE_3D</code> or <code class="constant">GL_TEXTURE_2D_ARRAY</code>.
</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>zoffset</code></em></span></dt><dd><p>
Specifies a texel offset in the z 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"><a id="description"></a><h2>Description</h2><p>
<code class="function">glCopyTexSubImage3D</code> replaces a rectangular portion of a three-dimensional
or two-dimensional array texture image 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="glTexSubImage3D"><span class="citerefentry"><span class="refentrytitle">glTexSubImage3D</span></span></a>).
</p><p>
The screen-aligned pixel rectangle with lower left corner at
(<em class="parameter"><code>x</code></em>, <em class="parameter"><code>y</code></em>) 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 z index <em class="parameter"><code>zoffset</code></em> and 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>
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>,
<span class="emphasis"><em>height</em></span>, or <span class="emphasis"><em>depth</em></span> parameters of the specified texture
array or to texel values outside the specified subregion.
</p></div><div class="refsect1"><a id="notes"></a><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"><a id="errors"></a><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_3D</code> or <code class="constant">GL_TEXTURE_2D_ARRAY</code>.
</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="glTexImage3D"><span class="citerefentry"><span class="refentrytitle">glTexImage3D</span></span></a> operation.
</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> 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
is the returned value of <code class="constant">GL_MAX_3D_TEXTURE_SIZE</code> if <em class="parameter"><code>target</code></em>
is <code class="constant">GL_TEXTURE_3D</code> or the returned value of <code class="constant">GL_MAX_ARRAY_TEXTURE_LAYERS</code>
if <em class="parameter"><code>target</code></em> is <code class="constant">GL_TEXTURE_2D_ARRAY</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>,
<math overflow="scroll">
<mrow>
<mfenced open="(" close=")">
<mrow>
<mi mathvariant="italic">yoffset</mi>
<mo>+</mo>
<mi mathvariant="italic">height</mi>
</mrow>
</mfenced>
<mo>></mo>
<mi mathvariant="italic">h</mi>
</mrow>
</math>,
<math overflow="scroll">
<mrow>
<mi mathvariant="italic">zoffset</mi>
<mo><</mo>
<mn>0</mn>
</mrow>
</math>,
or
<math overflow="scroll">
<mrow>
<mfenced open="(" close=")">
<mrow>
<mi mathvariant="italic">zoffset</mi>
<mo>+</mo>
<mn>1</mn>
</mrow>
</mfenced>
<mo>></mo>
<mi mathvariant="italic">d</mi>
</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
<math overflow="scroll"><mi mathvariant="italic">d</mi></math>
is the <code class="constant">GL_TEXTURE_DEPTH</code>
of the texture image being modified.
</p></div><div class="refsect1"><a id="associatedgets"></a><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"><a id="seealso"></a><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="glCopyTexSubImage2D"><span class="citerefentry"><span class="refentrytitle">glCopyTexSubImage2D</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"><div id="Copyright"><h2>Copyright</h2><p>
Copyright © 1991-2006
Silicon Graphics, Inc. This document is licensed under the SGI
Free Software B License. For details, see
<a class="ulink" 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></div>