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
|
<!DOCTYPE refentry [ <!ENTITY % mathent SYSTEM "math.ent"> %mathent; ]>
<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="glGetCompressedTexImage">
<info>
<copyright>
<year>1991-2006</year>
<holder>Silicon Graphics, Inc.</holder>
</copyright>
<copyright>
<year>2010-2014</year>
<holder>Khronos Group</holder>
</copyright>
</info>
<refmeta>
<refentrytitle>glGetCompressedTexImage</refentrytitle>
<manvolnum>3G</manvolnum>
</refmeta>
<refnamediv>
<refdescriptor>glGetCompressedTexImage</refdescriptor>
<refname>glGetCompressedTexImage</refname>
<refname>glGetnCompressedTexImage</refname>
<refname>glGetCompressedTextureImage</refname>
<refpurpose>return a compressed texture image</refpurpose>
</refnamediv>
<refsynopsisdiv>
<title>C Specification</title>
<funcsynopsis>
<funcprototype>
<funcdef>void <function>glGetCompressedTexImage</function></funcdef>
<paramdef>GLenum <parameter>target</parameter></paramdef>
<paramdef>GLint <parameter>level</parameter></paramdef>
<paramdef>GLvoid * <parameter>pixels</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>void <function>glGetnCompressedTexImage</function></funcdef>
<paramdef>GLenum <parameter>target</parameter></paramdef>
<paramdef>GLint <parameter>level</parameter></paramdef>
<paramdef>GLsizei <parameter>bufSize</parameter></paramdef>
<paramdef>void *<parameter>pixels</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>void <function>glGetCompressedTextureImage</function></funcdef>
<paramdef>GLuint <parameter>texture</parameter></paramdef>
<paramdef>GLint <parameter>level</parameter></paramdef>
<paramdef>GLsizei <parameter>bufSize</parameter></paramdef>
<paramdef>void *<parameter>pixels</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 xml:id="parameters">
<title>Parameters</title>
<variablelist>
<varlistentry>
<term><parameter>target</parameter></term>
<listitem>
<para>Specifies the target to which the texture is bound for
<function>glGetCompressedTexImage</function> and
<function>glGetnCompressedTexImage</function> functions.
<constant>GL_TEXTURE_1D</constant>,
<constant>GL_TEXTURE_1D_ARRAY</constant>,
<constant>GL_TEXTURE_2D</constant>,
<constant>GL_TEXTURE_2D_ARRAY</constant>,
<constant>GL_TEXTURE_3D</constant>,
<constant>GL_TEXTURE_CUBE_MAP_ARRAY</constant>,
<constant>GL_TEXTURE_CUBE_MAP_POSITIVE_X</constant>,
<constant>GL_TEXTURE_CUBE_MAP_NEGATIVE_X</constant>,
<constant>GL_TEXTURE_CUBE_MAP_POSITIVE_Y</constant>,
<constant>GL_TEXTURE_CUBE_MAP_NEGATIVE_Y</constant>,
<constant>GL_TEXTURE_CUBE_MAP_POSITIVE_Z</constant>, and
<constant>GL_TEXTURE_CUBE_MAP_NEGATIVE_Z</constant>,
<constant>GL_TEXTURE_RECTANGLE</constant> are accepted.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>texture</parameter></term>
<listitem>
<para>Specifies the texture object name for
<function>glGetCompressedTextureImage</function> function.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>level</parameter></term>
<listitem>
<para>Specifies the level-of-detail number of the desired image.
Level 0 is the base image level. Level $n$ is the $n$-th mipmap reduction image.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>bufSize</parameter></term>
<listitem>
<para>Specifies the size of the buffer <parameter>pixels</parameter>
for <function>glGetCompressedTextureImage</function> and
<function>glGetnCompressedTexImage</function> functions.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>pixels</parameter></term>
<listitem>
<para>Returns the compressed texture image.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 xml:id="description">
<title>Description</title>
<para><function>glGetCompressedTexImage</function> and
<function>glGetnCompressedTexImage</function> return the compressed
texture image associated with <parameter>target</parameter> and
<parameter>lod</parameter> into <parameter>pixels</parameter>.
<function>glGetCompressedTextureImage</function> serves the same purpose,
but instead of taking a texture target, it takes the ID of the texture
object. <parameter>pixels</parameter> should be an array of
<parameter>bufSize</parameter> bytes for
<function>glGetnCompresedTexImage</function> and
<function>glGetCompressedTextureImage</function> functions, and of
<constant>GL_TEXTURE_COMPRESSED_IMAGE_SIZE</constant> bytes in case of
<function>glGetCompressedTexImage</function>. If the actual data takes
less space than <parameter>bufSize</parameter>, the remaining bytes will
not be touched. <parameter>target</parameter> specifies the texture
target, to which the texture the data the function should extract the data
from is bound to. <parameter>lod</parameter> specifies the level-of-detail
number of the desired image.</para>
<para>If a non-zero named buffer object is bound to the
<constant>GL_PIXEL_PACK_BUFFER</constant> target (see
<citerefentry><refentrytitle>glBindBuffer</refentrytitle></citerefentry>) while a texture image is requested,
<parameter>pixels</parameter> is treated as a byte offset into the buffer
object's data store.</para>
<para>To minimize errors, first verify that the texture is compressed by
calling <citerefentry><refentrytitle>glGetTexLevelParameter</refentrytitle></citerefentry> with argument
<constant>GL_TEXTURE_COMPRESSED</constant>. If the texture is compressed,
you can determine the amount of memory required to store the compressed
texture by calling <citerefentry><refentrytitle>glGetTexLevelParameter</refentrytitle></citerefentry> with argument
<constant>GL_TEXTURE_COMPRESSED_IMAGE_SIZE</constant>. Finally, retrieve
the internal format of the texture by calling <citerefentry><refentrytitle>glGetTexLevelParameter</refentrytitle></citerefentry> with argument
<constant>GL_TEXTURE_INTERNAL_FORMAT</constant>. To store the texture for
later use, associate the internal format and size with the retrieved
texture image. These data can be used by the respective texture or
subtexture loading routine used for loading <parameter>target</parameter>
textures.</para>
</refsect1>
<refsect1 xml:id="errors">
<title>Errors</title>
<para><constant>GL_INVALID_OPERATION</constant> is generated by
<function>glGetCompressedTextureImage</function> if
<parameter>texture</parameter> is not the name of an existing texture
object.</para>
<para><constant>GL_INVALID_VALUE</constant> is generated if
<parameter>level</parameter> is less than zero or greater than the maximum
number of LODs permitted by the implementation.</para>
<para><constant>GL_INVALID_OPERATION</constant> is generated if
<function>glGetCompressedTexImage</function>,
<function>glGetnCompressedTexImage</function>, and
<function>glGetCompressedTextureImage</function> is used to retrieve a
texture that is in an uncompressed internal format.</para>
<para><constant>GL_INVALID_OPERATION</constant> is generated if a non-zero
buffer object name is bound to the
<constant>GL_PIXEL_PACK_BUFFER</constant> target, the buffer storage was
not initialized with <function>glBufferStorage</function> using
<constant>GL_MAP_PERSISTENT_BIT</constant> flag, and the buffer object's
data store is currently mapped.</para>
<para><constant>GL_INVALID_OPERATION</constant> is generated if a non-zero
buffer object name is bound to the
<constant>GL_PIXEL_PACK_BUFFER</constant> target and the data would be
packed to the buffer object such that the memory writes required would
exceed the data store size.</para>
</refsect1>
<refsect1 xml:id="associatedgets">
<title>Associated Gets</title>
<para><citerefentry><refentrytitle>glGetTexLevelParameter</refentrytitle></citerefentry> with argument
<constant>GL_TEXTURE_COMPRESSED</constant></para>
<para><citerefentry><refentrytitle>glGetTexLevelParameter</refentrytitle></citerefentry> with argument
<constant>GL_TEXTURE_COMPRESSED_IMAGE_SIZE</constant></para>
<para><citerefentry><refentrytitle>glGetTexLevelParameter</refentrytitle></citerefentry> with argument
<constant>GL_TEXTURE_INTERNAL_FORMAT</constant></para>
<para><citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument
<constant>GL_PIXEL_PACK_BUFFER_BINDING</constant></para>
</refsect1>
<refsect1 xml:id="versions"><title>Version Support</title>
<informaltable>
<tgroup cols="13" align="left">
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="apifunchead.xml" xpointer="xpointer(/*/*)"/>
<tbody>
<row>
<entry><function>glGetCompressedTexImage</function></entry>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
href="apiversion.xml"
xpointer="xpointer(/*/*[@role='20']/*)"/>
</row>
<row>
<entry><function>glGetCompressedTextureImage</function></entry>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
href="apiversion.xml"
xpointer="xpointer(/*/*[@role='45']/*)"/>
</row>
<row>
<entry><function>glGetnCompressedTexImage</function></entry>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
href="apiversion.xml"
xpointer="xpointer(/*/*[@role='45']/*)"/>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 xml:id="seealso">
<title>See Also</title>
<para>
<citerefentry><refentrytitle>glActiveTexture</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glCompressedTexImage1D</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glCompressedTexImage2D</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glCompressedTexImage3D</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glCompressedTexSubImage1D</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glCompressedTexSubImage2D</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glCompressedTexSubImage3D</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glReadPixels</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glTexImage1D</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glTexImage2D</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glTexImage3D</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glTexParameter</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glTexSubImage1D</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glTexSubImage2D</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glTexSubImage3D</refentrytitle></citerefentry>
</para>
</refsect1>
<refsect1 xml:id="Copyright">
<title>Copyright</title>
<para>Copyright <trademark class="copyright"/> 1991-2006 Silicon Graphics,
Inc. Copyright <trademark class="copyright"/> 2010-2014 Khronos Group.
This document is licensed under the SGI Free Software B License. For
details, see
<link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://opencontent.org/openpub/">http://opencontent.org/openpub/</link>.
</para>
</refsect1>
</refentry>
|
