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
|
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd">
<?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" pref:renderer="mathplayer-dl"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><link rel="stylesheet" type="text/css" href="opengl-man.css" /><title>glGetTexImage - OpenGL 4 Reference Pages</title><meta name="generator" content="DocBook XSL Stylesheets V1.78.1" /></head><body><div class="refentry"><a id="glGetTexImage"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glGetTexImage — return a texture image</p></div><div class="refsynopsisdiv"><h2>C Specification</h2><div class="funcsynopsis"><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">void <strong class="fsfunc">glGetTexImage</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">format</var>, </td></tr><tr><td> </td><td>GLenum <var class="pdparam">type</var>, </td></tr><tr><td> </td><td>GLvoid * <var class="pdparam">img</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div></div><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 which texture is to be obtained.
<code class="constant">GL_TEXTURE_1D</code>,
<code class="constant">GL_TEXTURE_2D</code>,
<code class="constant">GL_TEXTURE_3D</code>,
<code class="constant">GL_TEXTURE_1D_ARRAY</code>,
<code class="constant">GL_TEXTURE_2D_ARRAY</code>,
<code class="constant">GL_TEXTURE_RECTANGLE</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>, and
<code class="constant">GL_TEXTURE_CUBE_MAP_NEGATIVE_Z</code>
are accepted.
</p></dd><dt><span class="term"><em class="parameter"><code>level</code></em></span></dt><dd><p>
Specifies the level-of-detail number of the desired image.
Level 0 is the base image level.
Level
<mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll"><mml:mi mathvariant="italic">n</mml:mi></mml:math>
is the
<mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll"><mml:mi mathvariant="italic">n</mml:mi></mml:math>th
mipmap reduction image.
</p></dd><dt><span class="term"><em class="parameter"><code>format</code></em></span></dt><dd><p>
Specifies a pixel format for the returned data.
The supported formats are
<code class="constant">GL_STENCIL_INDEX</code>,
<code class="constant">GL_DEPTH_COMPONENT</code>,
<code class="constant">GL_DEPTH_STENCIL</code>,
<code class="constant">GL_RED</code>,
<code class="constant">GL_GREEN</code>,
<code class="constant">GL_BLUE</code>,
<code class="constant">GL_RG</code>,
<code class="constant">GL_RGB</code>,
<code class="constant">GL_RGBA</code>,
<code class="constant">GL_BGR</code>,
<code class="constant">GL_BGRA</code>,
<code class="constant">GL_RED_INTEGER</code>,
<code class="constant">GL_GREEN_INTEGER</code>,
<code class="constant">GL_BLUE_INTEGER</code>,
<code class="constant">GL_RG_INTEGER</code>,
<code class="constant">GL_RGB_INTEGER</code>,
<code class="constant">GL_RGBA_INTEGER</code>,
<code class="constant">GL_BGR_INTEGER</code>,
<code class="constant">GL_BGRA_INTEGER</code>.
</p></dd><dt><span class="term"><em class="parameter"><code>type</code></em></span></dt><dd><p>
Specifies a pixel type for the returned data.
The supported types are
<code class="constant">GL_UNSIGNED_BYTE</code>,
<code class="constant">GL_BYTE</code>,
<code class="constant">GL_UNSIGNED_SHORT</code>,
<code class="constant">GL_SHORT</code>,
<code class="constant">GL_UNSIGNED_INT</code>,
<code class="constant">GL_INT</code>,
<code class="constant">GL_HALF_FLOAT</code>,
<code class="constant">GL_FLOAT</code>,
<code class="constant">GL_UNSIGNED_BYTE_3_3_2</code>,
<code class="constant">GL_UNSIGNED_BYTE_2_3_3_REV</code>,
<code class="constant">GL_UNSIGNED_SHORT_5_6_5</code>,
<code class="constant">GL_UNSIGNED_SHORT_5_6_5_REV</code>,
<code class="constant">GL_UNSIGNED_SHORT_4_4_4_4</code>,
<code class="constant">GL_UNSIGNED_SHORT_4_4_4_4_REV</code>,
<code class="constant">GL_UNSIGNED_SHORT_5_5_5_1</code>,
<code class="constant">GL_UNSIGNED_SHORT_1_5_5_5_REV</code>,
<code class="constant">GL_UNSIGNED_INT_8_8_8_8</code>,
<code class="constant">GL_UNSIGNED_INT_8_8_8_8_REV</code>,
<code class="constant">GL_UNSIGNED_INT_10_10_10_2</code>,
<code class="constant">GL_UNSIGNED_INT_2_10_10_10_REV</code>,
<code class="constant">GL_UNSIGNED_INT_24_8</code>,
<code class="constant">GL_UNSIGNED_INT_10F_11F_11F_REV</code>,
<code class="constant">GL_UNSIGNED_INT_5_9_9_9_REV</code>, and
<code class="constant">GL_FLOAT_32_UNSIGNED_INT_24_8_REV</code>.
</p></dd><dt><span class="term"><em class="parameter"><code>img</code></em></span></dt><dd><p>
Returns the texture image.
Should be a pointer to an array of the type specified by <em class="parameter"><code>type</code></em>.
</p></dd></dl></div></div><div class="refsect1"><a id="description"></a><h2>Description</h2><p>
<code class="function">glGetTexImage</code> returns a texture image into <em class="parameter"><code>img</code></em>.
<em class="parameter"><code>target</code></em> specifies whether the desired texture image is one specified by
<a class="citerefentry" href="glTexImage1D.xml"><span class="citerefentry"><span class="refentrytitle">glTexImage1D</span></span></a> (<code class="constant">GL_TEXTURE_1D</code>),
<a class="citerefentry" href="glTexImage2D.xml"><span class="citerefentry"><span class="refentrytitle">glTexImage2D</span></span></a> (<code class="constant">GL_TEXTURE_1D_ARRAY</code>, <code class="constant">GL_TEXTURE_RECTANGLE</code>,
<code class="constant">GL_TEXTURE_2D</code> or any of
<code class="constant">GL_TEXTURE_CUBE_MAP_*</code>),
or
<a class="citerefentry" href="glTexImage3D.xml"><span class="citerefentry"><span class="refentrytitle">glTexImage3D</span></span></a> (<code class="constant">GL_TEXTURE_2D_ARRAY</code>,
<code class="constant">GL_TEXTURE_3D</code>).
<em class="parameter"><code>level</code></em> specifies the level-of-detail number of the desired image.
<em class="parameter"><code>format</code></em> and <em class="parameter"><code>type</code></em> specify the format and type of the desired image array.
See the reference page for <a class="citerefentry" href="glTexImage1D.xml"><span class="citerefentry"><span class="refentrytitle">glTexImage1D</span></span></a>
for a description of the acceptable values for the <em class="parameter"><code>format</code></em> and <em class="parameter"><code>type</code></em>
parameters, respectively.
</p><p>
If a non-zero named buffer object is bound to the <code class="constant">GL_PIXEL_PACK_BUFFER</code> target
(see <a class="citerefentry" href="glBindBuffer.xml"><span class="citerefentry"><span class="refentrytitle">glBindBuffer</span></span></a>) while a texture image is
requested, <em class="parameter"><code>img</code></em> is treated as a byte offset into the buffer object's data store.
</p><p>
To understand the operation of <code class="function">glGetTexImage</code>, consider the selected internal
four-component texture image to be an RGBA color buffer the size of the image.
The semantics of <code class="function">glGetTexImage</code> are then identical to those of <a class="citerefentry" href="glReadPixels.xml"><span class="citerefentry"><span class="refentrytitle">glReadPixels</span></span></a>,
with the exception that no pixel transfer operations are performed,
when called with the same <em class="parameter"><code>format</code></em> and <em class="parameter"><code>type</code></em>,
with <span class="emphasis"><em>x</em></span> and <span class="emphasis"><em>y</em></span> set to 0,
<span class="emphasis"><em>width</em></span> set to the width of the texture image
and <span class="emphasis"><em>height</em></span> set to 1 for 1D images,
or to the height of the texture image
for 2D images.
</p><p>
If the selected texture image does not contain four components,
the following mappings are applied.
Single-component textures are treated as RGBA buffers with red set
to the single-component value,
green set to 0, blue set to 0, and alpha set to 1.
Two-component textures are treated as RGBA buffers with red set to
the value of component zero,
alpha set to the value of component one,
and green and blue set to 0.
Finally,
three-component textures are treated as RGBA buffers with red set to
component zero,
green set to component one,
blue set to component two,
and alpha set to 1.
</p><p>
To determine the required size of <em class="parameter"><code>img</code></em>,
use <a class="citerefentry" href="glGetTexLevelParameter.xml"><span class="citerefentry"><span class="refentrytitle">glGetTexLevelParameter</span></span></a> to determine the dimensions of the
internal texture image,
then scale the required number of pixels by the storage required for
each pixel,
based on <em class="parameter"><code>format</code></em> and <em class="parameter"><code>type</code></em>.
Be sure to take the pixel storage parameters into account,
especially <code class="constant">GL_PACK_ALIGNMENT</code>.
</p></div><div class="refsect1"><a id="notes"></a><h2>Notes</h2><p>
If an error is generated,
no change is made to the contents of <em class="parameter"><code>img</code></em>.
</p><p>
<code class="function">glGetTexImage</code> returns the texture image for the active texture unit.
</p><p>
<code class="constant">GL_STENCIL_INDEX</code> is accepted for <em class="parameter"><code>format</code></em> only if the GL
version is 4.4 or greater.
</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>, <em class="parameter"><code>format</code></em>, or <em class="parameter"><code>type</code></em> is not
an accepted value.
</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 <em class="parameter"><code>level</code></em> is greater
than
<mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
<mml:mrow>
<mml:msub><mml:mi mathvariant="italic">log</mml:mi>
<mml:mn>2</mml:mn>
</mml:msub>
<mml:mo></mml:mo>
<mml:mfenced open="(" close=")">
<mml:mi mathvariant="italic">max</mml:mi>
</mml:mfenced>
</mml:mrow>
</mml:math>,
where
<mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll"><mml:mi mathvariant="italic">max</mml:mi></mml:math>
is the returned value of <code class="constant">GL_MAX_TEXTURE_SIZE</code>.
</p><p>
<code class="constant">GL_INVALID_OPERATION</code> is generated if <em class="parameter"><code>type</code></em> is one of
<code class="constant">GL_UNSIGNED_BYTE_3_3_2</code>,
<code class="constant">GL_UNSIGNED_BYTE_2_3_3_REV</code>,
<code class="constant">GL_UNSIGNED_SHORT_5_6_5</code>,
<code class="constant">GL_UNSIGNED_SHORT_5_6_5_REV</code>, or
<code class="constant">GL_UNSIGNED_INT_10F_11F_11F_REV</code> and <em class="parameter"><code>format</code></em> is not <code class="constant">GL_RGB</code>.
</p><p>
<code class="constant">GL_INVALID_OPERATION</code> is generated if <em class="parameter"><code>type</code></em> is one of
<code class="constant">GL_UNSIGNED_SHORT_4_4_4_4</code>,
<code class="constant">GL_UNSIGNED_SHORT_4_4_4_4_REV</code>,
<code class="constant">GL_UNSIGNED_SHORT_5_5_5_1</code>,
<code class="constant">GL_UNSIGNED_SHORT_1_5_5_5_REV</code>,
<code class="constant">GL_UNSIGNED_INT_8_8_8_8</code>,
<code class="constant">GL_UNSIGNED_INT_8_8_8_8_REV</code>,
<code class="constant">GL_UNSIGNED_INT_10_10_10_2</code>,
<code class="constant">GL_UNSIGNED_INT_2_10_10_10_REV</code>, or
<code class="constant">GL_UNSIGNED_INT_5_9_9_9_REV</code> and <em class="parameter"><code>format</code></em> is neither <code class="constant">GL_RGBA</code>
or <code class="constant">GL_BGRA</code>.
</p><p>
<code class="constant">GL_INVALID_OPERATION</code> is generated if <em class="parameter"><code>format</code></em> is
<code class="constant">GL_STENCIL_INDEX</code> and the base internal format is not <code class="constant">GL_STENCIL_INDEX</code>
or <code class="constant">GL_DEPTH_STENCIL</code>.
</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_PACK_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_PACK_BUFFER</code> target and the data would be packed to the buffer
object such that the memory writes required would exceed the data store size.
</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_PACK_BUFFER</code> target and <em class="parameter"><code>img</code></em> is not evenly divisible
into the number of bytes needed to store in memory a datum indicated by <em class="parameter"><code>type</code></em>.
</p></div><div class="refsect1"><a id="associatedgets"></a><h2>Associated Gets</h2><p>
<a class="citerefentry" href="glGetTexLevelParameter.xml"><span class="citerefentry"><span class="refentrytitle">glGetTexLevelParameter</span></span></a> with argument <code class="constant">GL_TEXTURE_WIDTH</code>
</p><p>
<a class="citerefentry" href="glGetTexLevelParameter.xml"><span class="citerefentry"><span class="refentrytitle">glGetTexLevelParameter</span></span></a> with argument <code class="constant">GL_TEXTURE_HEIGHT</code>
</p><p>
<a class="citerefentry" href="glGetTexLevelParameter.xml"><span class="citerefentry"><span class="refentrytitle">glGetTexLevelParameter</span></span></a> with argument <code class="constant">GL_TEXTURE_INTERNAL_FORMAT</code>
</p><p>
<a class="citerefentry" href="glGet.xml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with arguments <code class="constant">GL_PACK_ALIGNMENT</code> and others
</p><p>
<a class="citerefentry" href="glGet.xml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_PIXEL_PACK_BUFFER_BINDING</code>
</p></div><div class="refsect1"><a id="seealso"></a><h2>See Also</h2><p>
<a class="citerefentry" href="glActiveTexture.xml"><span class="citerefentry"><span class="refentrytitle">glActiveTexture</span></span></a>,
<a class="citerefentry" href="glReadPixels.xml"><span class="citerefentry"><span class="refentrytitle">glReadPixels</span></span></a>,
<a class="citerefentry" href="glTexImage1D.xml"><span class="citerefentry"><span class="refentrytitle">glTexImage1D</span></span></a>,
<a class="citerefentry" href="glTexImage2D.xml"><span class="citerefentry"><span class="refentrytitle">glTexImage2D</span></span></a>,
<a class="citerefentry" href="glTexImage3D.xml"><span class="citerefentry"><span class="refentrytitle">glTexImage3D</span></span></a>,
<a class="citerefentry" href="glTexSubImage1D.xml"><span class="citerefentry"><span class="refentrytitle">glTexSubImage1D</span></span></a>,
<a class="citerefentry" href="glTexSubImage2D.xml"><span class="citerefentry"><span class="refentrytitle">glTexSubImage2D</span></span></a>,
<a class="citerefentry" href="glTexSubImage3D.xml"><span class="citerefentry"><span class="refentrytitle">glTexSubImage3D</span></span></a>,
<a class="citerefentry" href="glTexParameter.xml"><span class="citerefentry"><span class="refentrytitle">glTexParameter</span></span></a>
</p></div><div class="refsect1"><a id="Copyright"></a><h2>Copyright</h2><p>
Copyright <span class="trademark"></span>© 1991-2006 Silicon Graphics, Inc.
Copyright <span class="trademark"></span>© 2010-2013 Khronos Group.
This document is licensed under the SGI
Free Software B License. For details, see
<a class="ulink" href="http://oss.sgi.com/projects/FreeB/" target="_top">http://oss.sgi.com/projects/FreeB/</a>.
</p></div></div></body></html>
|
