/
glGenerateMipmap.xhtml
220 lines (212 loc) · 8.88 KB
/
glGenerateMipmap.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
<div class="refentry" id="glGenerateMipmap">
<div class="titlepage"></div>
<div class="refnamediv">
<h2>Name</h2>
<p>glGenerateMipmap — generate mipmaps for a specified texture target</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">glGenerateMipmap</strong>(</code>
</td>
<td>GLenum <var class="pdparam">target</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 to which the texture whose mimaps to generate is bound. <em class="parameter"><code>target</code></em> must
be <code class="constant">GL_TEXTURE_2D</code>, <code class="constant">GL_TEXTURE_3D</code>,
<code class="constant">GL_TEXTURE_2D_ARRAY</code> or <code class="constant">GL_TEXTURE_CUBE_MAP</code>.
</p>
</dd>
</dl>
</div>
</div>
<div class="refsect1" id="description">
<h2>Description</h2>
<p>
<code class="function">glGenerateMipmap</code> generates mipmaps for the texture attached
to <em class="parameter"><code>target</code></em> of the active texture unit. For cube map textures,
a <code class="constant">GL_INVALID_OPERATION</code> error is generated if the texture
attached to <em class="parameter"><code>target</code></em> is not cube complete.
</p>
<p>
Mipmap generation replaces texel array levels
<math overflow="scroll">
<mrow>
<msub>
<mi mathvariant="italic">level</mi>
<mi>base</mi>
</msub>
<mo>+</mo>
<mn>1</mn>
</mrow>
</math>
through
<math overflow="scroll">
<mrow>
<mi mathvariant="italic">q</mi>
</mrow>
</math>
with arrays derived from the
<math overflow="scroll">
<mrow>
<msub>
<mi mathvariant="italic">level</mi>
<mi>base</mi>
</msub>
</mrow>
</math>
array, regardless of their previous contents. All other mimap arrays,
including the
<math overflow="scroll">
<mrow>
<msub>
<mi mathvariant="italic">level</mi>
<mi>base</mi>
</msub>
</mrow>
</math>
array, are left unchanged by this computation.
</p>
<p>
The internal formats of the derived mipmap arrays all match those of the
<math overflow="scroll">
<mrow>
<msub>
<mi mathvariant="italic">level</mi>
<mi>base</mi>
</msub>
</mrow>
</math>
array. The contents of the derived arrays are computed by repeated, filtered
reduction of the
<math overflow="scroll">
<mrow>
<msub>
<mi mathvariant="italic">level</mi>
<mi>base</mi>
</msub>
</mrow>
</math>
array. For two-dimensional texture arrays, each layer is filtered
independently.
</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>target</code></em> is not
one of the accepted texture targets.
</p>
<p>
<code class="constant">GL_INVALID_OPERATION</code> is generated if <em class="parameter"><code>target</code></em> is
<code class="constant">GL_TEXTURE_CUBE_MAP</code> and the texture bound to the <code class="constant">GL_TEXTURE_CUBE_MAP</code>
target of the active texture unit is not cube complete.
</p>
<p>
<code class="constant">GL_INVALID_OPERATION</code> is generated if the
<math overflow="scroll">
<mrow>
<msub>
<mi mathvariant="italic">level</mi>
<mi>base</mi>
</msub>
</mrow>
</math>
array is stored in a compressed internal format.
</p>
<p>
<code class="constant">GL_INVALID_OPERATION</code> is generated if the
<math overflow="scroll">
<mrow>
<msub>
<mi mathvariant="italic">level</mi>
<mi>base</mi>
</msub>
</mrow>
</math>
array was not specified with an unsized internal format or a sized internal format that is both
color-renderable and texture-filterable.
</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 ; ">glGenerateMipmap</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="glTexImage2D"><span class="citerefentry"><span class="refentrytitle">glTexImage2D</span></span></a>,
<a class="citerefentry" href="glBindTexture"><span class="citerefentry"><span class="refentrytitle">glBindTexture</span></span></a>,
<a class="citerefentry" href="glGenTextures"><span class="citerefentry"><span class="refentrytitle">glGenTextures</span></span></a>
</p>
</div>
<div class="refsect1" id="Copyright">
<h2>Copyright</h2>
<p>
Copyright © 2010-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="https://opencontent.org/openpub/" target="_top">https://opencontent.org/openpub/</a>.
</p>
</div>
</div>