forked from BSVino/docs.gl
-
Notifications
You must be signed in to change notification settings - Fork 0
/
glCompressedTexImage2D.xhtml
438 lines (437 loc) · 22.3 KB
/
glCompressedTexImage2D.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
<div class="refentry" id="glCompressedTexImage2D">
<div class="titlepage"></div>
<div class="refnamediv">
<h2>Name</h2>
<p>glCompressedTexImage2D — specify a two-dimensional texture image in a compressed format</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">glCompressedTexImage2D</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>GLenum <var class="pdparam">internalformat</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>GLint <var class="pdparam">border</var>, </td>
</tr>
<tr>
<td> </td>
<td>GLsizei <var class="pdparam">imageSize</var>, </td>
</tr>
<tr>
<td> </td>
<td>const GLvoid * <var class="pdparam">data</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 texture.
Must be <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>, or
<code class="constant">GL_TEXTURE_CUBE_MAP_NEGATIVE_Z</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>internalformat</code>
</em>
</span>
</dt>
<dd>
<p>
Specifies the format of the compressed image data stored at address <em class="parameter"><code>data</code></em>.
</p>
</dd>
<dt>
<span class="term">
<em class="parameter">
<code>width</code>
</em>
</span>
</dt>
<dd>
<p>
Specifies the width of the texture image.
All implementations support 2D and cube-mapped texture images that are at least 2048 texels
wide.
</p>
</dd>
<dt>
<span class="term">
<em class="parameter">
<code>height</code>
</em>
</span>
</dt>
<dd>
<p>
Specifies the height of the texture image.
All implementations support 2D and cube-mapped texture images that are at least 2048 texels
high.
</p>
</dd>
<dt>
<span class="term">
<em class="parameter">
<code>border</code>
</em>
</span>
</dt>
<dd>
<p>
This value must be 0.
</p>
</dd>
<dt>
<span class="term">
<em class="parameter">
<code>imageSize</code>
</em>
</span>
</dt>
<dd>
<p>
Specifies the number of unsigned bytes of image data starting at the
address specified by <em class="parameter"><code>data</code></em>.
</p>
</dd>
<dt>
<span class="term">
<em class="parameter">
<code>data</code>
</em>
</span>
</dt>
<dd>
<p>
Specifies a pointer to the compressed image data in memory.
</p>
</dd>
</dl>
</div>
</div>
<div class="refsect1" id="description">
<h2>Description</h2>
<p>
Texturing allows elements of an image array to be read by shaders.
</p>
<p>
<code class="function">glCompressedTexImage2D</code> loads a previously defined, and retrieved, compressed two-dimensional
texture image if <em class="parameter"><code>target</code></em> is <code class="constant">GL_TEXTURE_2D</code>, or one of the
cube map faces such as <code class="constant">GL_TEXTURE_CUBE_MAP_POSITIVE_X</code>.
(see <a class="citerefentry" href="glTexImage2D"><span class="citerefentry"><span class="refentrytitle">glTexImage2D</span></span></a>).
</p>
<p>
<em class="parameter"><code>internalformat</code></em> must be a compressed image format from Table 1 below,
or an extension-specified compressed-texture format.
</p>
<p>
<em class="parameter"><code>imageSize</code></em> must be appropriate for the <em class="parameter"><code>width</code></em>, <em class="parameter"><code>height</code></em> and
<em class="parameter"><code>depth</code></em> of the <em class="parameter"><code>internalformat</code></em> specified. The size for an ETC/EAC image
is given in Table 1 below.
</p>
<p>
If a non-zero named buffer object is bound to the <code class="constant">GL_PIXEL_UNPACK_BUFFER</code> target
(see <a class="citerefentry" href="glBindBuffer"><span class="citerefentry"><span class="refentrytitle">glBindBuffer</span></span></a>) while a texture image is
specified, <em class="parameter"><code>data</code></em> is treated as a byte offset into the buffer object's data store.
</p>
<p>
</p>
<div class="table" id="idm28377072">
<div class="table-title">Table 1. Compressed Internal Formats</div>
<div class="table-contents">
<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: left; "/>
<col style="text-align: left; "/>
</colgroup>
<thead>
<tr>
<th style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>Compressed Internal Format</strong></span>
</th>
<th style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>Base Internal Format</strong></span>
</th>
<th style="text-align: left; border-bottom: 2px solid ; ">
<span class="bold"><strong>Image Size</strong></span>
</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">
<code class="constant">GL_COMPRESSED_R11_EAC</code>
</td>
<td style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">
<code class="constant">GL_RED</code>
</td>
<td style="text-align: left; border-bottom: 2px solid ; ">ceil(<em class="parameter"><code>width</code></em>/4) * ceil(<em class="parameter"><code>height</code></em>/4) * 8</td>
</tr>
<tr>
<td style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">
<code class="constant">GL_COMPRESSED_SIGNED_R11_EAC</code>
</td>
<td style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">
<code class="constant">GL_RED</code>
</td>
<td style="text-align: left; border-bottom: 2px solid ; ">ceil(<em class="parameter"><code>width</code></em>/4) * ceil(<em class="parameter"><code>height</code></em>/4) * 8</td>
</tr>
<tr>
<td style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">
<code class="constant">GL_COMPRESSED_RG11_EAC</code>
</td>
<td style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">
<code class="constant">GL_RG</code>
</td>
<td style="text-align: left; border-bottom: 2px solid ; ">ceil(<em class="parameter"><code>width</code></em>/4) * ceil(<em class="parameter"><code>height</code></em>/4) * 16</td>
</tr>
<tr>
<td style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">
<code class="constant">GL_COMPRESSED_SIGNED_RG11_EAC</code>
</td>
<td style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">
<code class="constant">GL_RG</code>
</td>
<td style="text-align: left; border-bottom: 2px solid ; ">ceil(<em class="parameter"><code>width</code></em>/4) * ceil(<em class="parameter"><code>height</code></em>/4) * 16</td>
</tr>
<tr>
<td style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">
<code class="constant">GL_COMPRESSED_RGB8_ETC2</code>
</td>
<td style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">
<code class="constant">GL_RGB</code>
</td>
<td style="text-align: left; border-bottom: 2px solid ; ">ceil(<em class="parameter"><code>width</code></em>/4) * ceil(<em class="parameter"><code>height</code></em>/4) * 8</td>
</tr>
<tr>
<td style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">
<code class="constant">GL_COMPRESSED_SRGB8_ETC2</code>
</td>
<td style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">
<code class="constant">GL_RGB</code>
</td>
<td style="text-align: left; border-bottom: 2px solid ; ">ceil(<em class="parameter"><code>width</code></em>/4) * ceil(<em class="parameter"><code>height</code></em>/4) * 8</td>
</tr>
<tr>
<td style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">
<code class="constant">GL_COMPRESSED_RGB8_PUNCHTHROUGH_ALPHA1_ETC2</code>
</td>
<td style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">
<code class="constant">GL_RGBA</code>
</td>
<td style="text-align: left; border-bottom: 2px solid ; ">ceil(<em class="parameter"><code>width</code></em>/4) * ceil(<em class="parameter"><code>height</code></em>/4) * 8</td>
</tr>
<tr>
<td style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">
<code class="constant">GL_COMPRESSED_SRGB8_PUNCHTHROUGH_ALPHA1_ETC2</code>
</td>
<td style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">
<code class="constant">GL_RGBA</code>
</td>
<td style="text-align: left; border-bottom: 2px solid ; ">ceil(<em class="parameter"><code>width</code></em>/4) * ceil(<em class="parameter"><code>height</code></em>/4) * 8</td>
</tr>
<tr>
<td style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">
<code class="constant">GL_COMPRESSED_RGBA8_ETC2_EAC</code>
</td>
<td style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">
<code class="constant">GL_RGBA</code>
</td>
<td style="text-align: left; border-bottom: 2px solid ; ">ceil(<em class="parameter"><code>width</code></em>/4) * ceil(<em class="parameter"><code>height</code></em>/4) * 16</td>
</tr>
<tr>
<td style="text-align: left; border-right: 2px solid ; ">
<code class="constant">GL_COMPRESSED_SRGB8_ALPHA8_ETC2_EAC</code>
</td>
<td style="text-align: left; border-right: 2px solid ; ">
<code class="constant">GL_RGBA</code>
</td>
<td style="text-align: left; ">ceil(<em class="parameter"><code>width</code></em>/4) * ceil(<em class="parameter"><code>height</code></em>/4) * 16</td>
</tr>
</tbody>
</table>
</div>
</div>
<p><br class="table-break"/>
</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>internalformat</code></em> is not one of the specific
compressed internal formats:
<code class="constant">GL_COMPRESSED_R11_EAC</code>,
<code class="constant">GL_COMPRESSED_SIGNED_R11_EAC</code>,
<code class="constant">GL_COMPRESSED_RG11_EAC</code>,
<code class="constant">GL_COMPRESSED_SIGNED_RG11_EAC</code>,
<code class="constant">GL_COMPRESSED_RGB8_ETC2</code>,
<code class="constant">GL_COMPRESSED_SRGB8_ETC2</code>,
<code class="constant">GL_COMPRESSED_RGB8_PUNCHTHROUGH_ALPHA1_ETC2</code>,
<code class="constant">GL_COMPRESSED_SRGB8_PUNCHTHROUGH_ALPHA1_ETC2</code>,
<code class="constant">GL_COMPRESSED_RGBA8_ETC2_EAC</code>, or
<code class="constant">GL_COMPRESSED_SRGB8_ALPHA8_ETC2_EAC</code>.
</p>
<p>
<code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>imageSize</code></em> is not consistent with
the format, dimensions, and contents of the specified compressed image
data.
</p>
<p>
<code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>border</code></em> is not 0.
</p>
<p>
<code class="constant">GL_INVALID_OPERATION</code> is generated if parameter combinations are not
supported by the specific compressed internal format as specified in the
specific texture compression extension.
</p>
<p>
<code class="constant">GL_INVALID_OPERATION</code> is generated if a non-zero buffer object name is bound to the
<code class="constant">GL_PIXEL_UNPACK_BUFFER</code> target and the buffer object's data store is currently mapped.
</p>
<p>
<code class="constant">GL_INVALID_OPERATION</code> is generated if a non-zero buffer object name is bound to the
<code class="constant">GL_PIXEL_UNPACK_BUFFER</code> target and the data would be unpacked from the buffer
object such that the memory reads required would exceed the data store size.
</p>
<p>
Undefined results, including abnormal program termination, are generated if
<em class="parameter"><code>data</code></em> is not encoded in a manner consistent with the extension
specification defining the internal compression format.
</p>
</div>
<div class="refsect1" id="associatedgets">
<h2>Associated Gets</h2>
<p>
<a class="citerefentry" href="glGet"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_PIXEL_UNPACK_BUFFER_BINDING</code>
</p>
</div>
{$pipelinestall}{$examples}
<div class="refsect1" id="versions">
<h2>API 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; " 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="3">
<span class="bold"><strong>OpenGL ES API Version</strong></span>
</th>
</tr>
<tr>
<th style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">
<span class="bold"><strong>Function 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>3.0</strong></span>
</th>
<th style="text-align: center; border-bottom: 2px solid ; ">
<span class="bold"><strong>3.1</strong></span>
</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left; border-right: 2px solid ; ">
<code class="function">glCompressedTexImage2D</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; ">✔</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="refsect1" id="seealso">
<h2>See Also</h2>
<p>
<a class="citerefentry" href="glActiveTexture"><span class="citerefentry"><span class="refentrytitle">glActiveTexture</span></span></a>,
<a class="citerefentry" href="glCompressedTexImage3D"><span class="citerefentry"><span class="refentrytitle">glCompressedTexImage3D</span></span></a>,
<a class="citerefentry" href="glCompressedTexSubImage2D"><span class="citerefentry"><span class="refentrytitle">glCompressedTexSubImage2D</span></span></a>,
<a class="citerefentry" href="glCompressedTexSubImage3D"><span class="citerefentry"><span class="refentrytitle">glCompressedTexSubImage3D</span></span></a>,
<a class="citerefentry" href="glCopyTexSubImage2D"><span class="citerefentry"><span class="refentrytitle">glCopyTexSubImage2D</span></span></a>,
<a class="citerefentry" href="glCopyTexSubImage3D"><span class="citerefentry"><span class="refentrytitle">glCopyTexSubImage3D</span></span></a>,
<a class="citerefentry" href="glPixelStorei"><span class="citerefentry"><span class="refentrytitle">glPixelStorei</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="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>,
<a class="citerefentry" href="glTexParameter"><span class="citerefentry"><span class="refentrytitle">glTexParameter</span></span></a>
</p>
</div>
<div class="refsect1" id="Copyright">
<h2>Copyright</h2>
<p>
Copyright © 1991-2006 Silicon Graphics, Inc.
Copyright © 2010-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>