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
|
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>glInvalidateTexSubImage - OpenGL 4 Reference Pages</title>
<link rel="stylesheet" type="text/css" href="opengl-man.css"/>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1"/>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
MathML: {
extensions: ["content-mathml.js"]
},
tex2jax: {
inlineMath: [['$','$'], ['\\(','\\)']]
}
});
</script>
<script type="text/javascript" src="https://c328740.ssl.cf1.rackcdn.com/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"/>
</head>
<body>
<header/>
<div class="refentry" id="glInvalidateTexSubImage">
<div class="titlepage"/>
<div class="refnamediv">
<h2>Name</h2>
<p>glInvalidateTexSubImage — invalidate a region of a texture image</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">glInvalidateTexSubImage</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">zoffset</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>, </td>
</tr>
<tr>
<td> </td>
<td>GLsizei <var class="pdparam">depth</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>texture</code>
</em>
</span>
</dt>
<dd>
<p>
The name of a texture object a subregion of which to invalidate.
</p>
</dd>
<dt>
<span class="term">
<em class="parameter">
<code>level</code>
</em>
</span>
</dt>
<dd>
<p>
The level of detail of the texture object within which the region resides.
</p>
</dd>
<dt>
<span class="term">
<em class="parameter">
<code>xoffset</code>
</em>
</span>
</dt>
<dd>
<p>
The X offset of the region to be invalidated.
</p>
</dd>
<dt>
<span class="term">
<em class="parameter">
<code>yoffset</code>
</em>
</span>
</dt>
<dd>
<p>
The Y offset of the region to be invalidated.
</p>
</dd>
<dt>
<span class="term">
<em class="parameter">
<code>zoffset</code>
</em>
</span>
</dt>
<dd>
<p>
The Z offset of the region to be invalidated.
</p>
</dd>
<dt>
<span class="term">
<em class="parameter">
<code>width</code>
</em>
</span>
</dt>
<dd>
<p>
The width of the region to be invalidated.
</p>
</dd>
<dt>
<span class="term">
<em class="parameter">
<code>height</code>
</em>
</span>
</dt>
<dd>
<p>
The height of the region to be invalidated.
</p>
</dd>
<dt>
<span class="term">
<em class="parameter">
<code>depth</code>
</em>
</span>
</dt>
<dd>
<p>
The depth of the region to be invalidated.
</p>
</dd>
</dl>
</div>
</div>
<div class="refsect1" id="description">
<h2>Description</h2>
<p>
<code class="function">glInvalidateTexSubImage</code> invalidates all or part of
a texture image. <em class="parameter"><code>texture</code></em> and <em class="parameter"><code>level</code></em> indicated
which texture image is being invalidated. After this command, data in that subregion have undefined
values. <em class="parameter"><code>xoffset</code></em>, <em class="parameter"><code>yoffset</code></em>, <em class="parameter"><code>zoffset</code></em>, <em class="parameter"><code>width</code></em>, <em class="parameter"><code>height</code></em>, and <em class="parameter"><code>depth</code></em>
are interpreted as they are in <a class="citerefentry" href="glTexSubImage3D.xhtml"><span class="citerefentry"><span class="refentrytitle">glTexSubImage3D</span></span></a>. For texture targets that
don't have certain dimensions, this command treats those dimensions as
having a size of 1. For example, to invalidate a portion of a two-
dimensional texture, the application would use <em class="parameter"><code>zoffset</code></em> equal to zero and
<em class="parameter"><code>depth</code></em> equal to one. Cube map textures are treated as an array of six
slices in the z-dimension, where a value of <em class="parameter"><code>zoffset</code></em> is interpreted as
specifying face <code class="constant">GL_TEXTURE_CUBE_MAP_POSITIVE_X</code> + <em class="parameter"><code>zoffset</code></em>.
</p>
<p>
<em class="parameter"><code>level</code></em> must be greater than or equal to zero and be
less than the base 2 logarithm of the maximum texture width, height, or depth.
<em class="parameter"><code>xoffset</code></em>, <em class="parameter"><code>yoffset</code></em> and <em class="parameter"><code>zoffset</code></em>
must be greater than or equal to zero and be less than the width, height or depth
of the image, respectively. Furthermore, <em class="parameter"><code>xoffset</code></em> + <em class="parameter"><code>width</code></em>,
<em class="parameter"><code>yoffset</code></em> + <em class="parameter"><code>height</code></em>, and
<em class="parameter"><code>zoffset</code></em> + <em class="parameter"><code>depth</code></em> must be less
than or equal to the width, height or depth of the image, respectively.
</p>
<p>
For textures of targets <code class="constant">GL_TEXTURE_RECTANGLE</code>, <code class="constant">GL_TEXTURE_BUFFER</code>, <code class="constant">GL_TEXTURE_2D_MULTISAMPLE</code>, or
<code class="constant">GL_TEXTURE_2D_MULTISAMPLE_ARRAY</code>, level must be zero.
</p>
</div>
<div class="refsect1" id="errors">
<h2>Errors</h2>
<p>
<code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>xoffset</code></em>,
<em class="parameter"><code>yoffset</code></em> or <em class="parameter"><code>zoffset</code></em> is less than zero,
or if any of them is greater than the size of the image in the corresponding dimension.
</p>
<p>
<code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>level</code></em> is
less than zero or if it is greater or equal to the base 2 logarithm of the maximum texture width, height, or depth.
</p>
<p>
<code class="constant">GL_INVALID_VALUE</code> is generated if the target of <em class="parameter"><code>texture</code></em>
is any of <code class="constant">GL_TEXTURE_RECTANGLE</code>, <code class="constant">GL_TEXTURE_BUFFER</code>, <code class="constant">GL_TEXTURE_2D_MULTISAMPLE</code>, or
<code class="constant">GL_TEXTURE_2D_MULTISAMPLE_ARRAY</code> and <em class="parameter"><code>level</code></em> is not zero.
</p>
<p>
<code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>texture</code></em> is not the
name of an existing texture object.
</p>
</div>
<div class="refsect1" id="associatedgets">
<h2>Associated Gets</h2>
<p>
<a class="citerefentry" href="glGet.xhtml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_MAX_TEXTURE_SIZE</code>
</p>
</div>
<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 ; ">
<code class="function">glInvalidateTexSubImage</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="glInvalidateTexImage.xhtml"><span class="citerefentry"><span class="refentrytitle">glInvalidateTexImage</span></span></a>,,
<a class="citerefentry" href="glInvalidateBufferSubData.xhtml"><span class="citerefentry"><span class="refentrytitle">glInvalidateBufferSubData</span></span></a>,
<a class="citerefentry" href="glInvalidateBufferData.xhtml"><span class="citerefentry"><span class="refentrytitle">glInvalidateBufferData</span></span></a>,
<a class="citerefentry" href="glInvalidateFramebuffer.xhtml"><span class="citerefentry"><span class="refentrytitle">glInvalidateFramebuffer</span></span></a>,
<a class="citerefentry" href="glInvalidateSubFramebuffer.xhtml"><span class="citerefentry"><span class="refentrytitle">glInvalidateSubFramebuffer</span></span></a>.
</p>
</div>
<div class="refsect1" id="Copyright">
<h2>Copyright</h2>
<p>
Copyright <span class="trademark"/>© 2013-2014 Khronos Group.
This material may be distributed subject to the terms and conditions set forth in
the Open Publication License, v 1.0, 8 June 1999.
<a class="link" href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
</p>
</div>
</div>
<footer/>
</body>
</html>
|
