-
Notifications
You must be signed in to change notification settings - Fork 95
/
glMultiDrawElementsBaseVertex.xhtml
291 lines (290 loc) · 13.4 KB
/
glMultiDrawElementsBaseVertex.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
<div class="refentry" id="glMultiDrawElementsBaseVertex">
<div class="titlepage"></div>
<div class="refnamediv">
<h2>Name</h2>
<p>glMultiDrawElementsBaseVertex — render multiple sets of primitives by specifying indices of array data elements and an index to apply to each index</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">glMultiDrawElementsBaseVertex</strong>(</code>
</td>
<td>GLenum <var class="pdparam">mode</var>, </td>
</tr>
<tr>
<td> </td>
<td>const GLsizei *<var class="pdparam">count</var>, </td>
</tr>
<tr>
<td> </td>
<td>GLenum <var class="pdparam">type</var>, </td>
</tr>
<tr>
<td> </td>
<td>const GLvoid * const *<var class="pdparam">indices</var>, </td>
</tr>
<tr>
<td> </td>
<td>GLsizei <var class="pdparam">drawcount</var>, </td>
</tr>
<tr>
<td> </td>
<td>const GLint *<var class="pdparam">basevertex</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>mode</code>
</em>
</span>
</dt>
<dd>
<p>
Specifies what kind of primitives to render.
Symbolic constants
<code class="constant">GL_POINTS</code>,
<code class="constant">GL_LINE_STRIP</code>,
<code class="constant">GL_LINE_LOOP</code>,
<code class="constant">GL_LINES</code>,
<code class="constant">GL_LINE_STRIP_ADJACENCY</code>,
<code class="constant">GL_LINES_ADJACENCY</code>,
<code class="constant">GL_TRIANGLE_STRIP</code>,
<code class="constant">GL_TRIANGLE_FAN</code>,
<code class="constant">GL_TRIANGLES</code>,
<code class="constant">GL_TRIANGLE_STRIP_ADJACENCY</code>,
<code class="constant">GL_TRIANGLES_ADJACENCY</code> and <code class="constant">GL_PATCHES</code>
are accepted.
</p>
</dd>
<dt>
<span class="term">
<em class="parameter">
<code>count</code>
</em>
</span>
</dt>
<dd>
<p>
Points to an array of the elements counts.
</p>
</dd>
<dt>
<span class="term">
<em class="parameter">
<code>type</code>
</em>
</span>
</dt>
<dd>
<p>
Specifies the type of the values in <em class="parameter"><code>indices</code></em>. Must be one of
<code class="constant">GL_UNSIGNED_BYTE</code>, <code class="constant">GL_UNSIGNED_SHORT</code>, or
<code class="constant">GL_UNSIGNED_INT</code>.
</p>
</dd>
<dt>
<span class="term">
<em class="parameter">
<code>indices</code>
</em>
</span>
</dt>
<dd>
<p>
Specifies a pointer to the location where the indices are stored.
</p>
</dd>
<dt>
<span class="term">
<em class="parameter">
<code>drawcount</code>
</em>
</span>
</dt>
<dd>
<p>
Specifies the size of the <em class="parameter"><code>count</code></em>, <em class="parameter"><code>indices</code></em> and <em class="parameter"><code>basevertex</code></em> arrays.
</p>
</dd>
<dt>
<span class="term">
<em class="parameter">
<code>basevertex</code>
</em>
</span>
</dt>
<dd>
<p>
Specifies a pointer to the location where the base vertices are stored.
</p>
</dd>
</dl>
</div>
</div>
<div class="refsect1" id="description">
<h2>Description</h2>
<p>
<code class="function">glMultiDrawElementsBaseVertex</code> behaves identically to <a class="citerefentry" href="glDrawElementsBaseVertex"><span class="citerefentry"><span class="refentrytitle">glDrawElementsBaseVertex</span></span></a>,
except that <em class="parameter"><code>drawcount</code></em> separate lists of elements are specifried instead.
</p>
<p>
It has the same effect as:
</p>
<pre class="programlisting"> for (int i = 0; i < <em class="parameter"><code>drawcount</code></em>; i++)
if (<em class="parameter"><code>count</code></em>[i] > 0)
glDrawElementsBaseVertex(<em class="parameter"><code>mode</code></em>,
<em class="parameter"><code>count</code></em>[i],
<em class="parameter"><code>type</code></em>,
<em class="parameter"><code>indices[i]</code></em>,
<em class="parameter"><code>basevertex[i]</code></em>);</pre>
<p>
</p>
</div>
<div class="refsect1" id="notes">
<h2>Notes</h2>
<p>
<code class="function">glMultiDrawElementsBaseVertex</code> is available only if the GL version is 3.1 or greater.
</p>
<p>
<code class="constant">GL_LINE_STRIP_ADJACENCY</code>,
<code class="constant">GL_LINES_ADJACENCY</code>,
<code class="constant">GL_TRIANGLE_STRIP_ADJACENCY</code> and
<code class="constant">GL_TRIANGLES_ADJACENCY</code>
are available only if the GL version is 3.2 or greater.
</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>mode</code></em> is not an accepted value.
</p>
<p>
<code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>drawcount</code></em> is negative.
</p>
<p>
<code class="constant">GL_INVALID_OPERATION</code> is generated if a non-zero buffer object name is bound to an
enabled array or the element array and the buffer object's data store is currently mapped.
</p>
</div>
{$pipelinestall}{$examples}
<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">glMultiDrawElementsBaseVertex</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="glMultiDrawElements"><span class="citerefentry"><span class="refentrytitle">glMultiDrawElements</span></span></a>,
<a class="citerefentry" href="glDrawElementsBaseVertex"><span class="citerefentry"><span class="refentrytitle">glDrawElementsBaseVertex</span></span></a>,
<a class="citerefentry" href="glDrawArrays"><span class="citerefentry"><span class="refentrytitle">glDrawArrays</span></span></a>,
<a class="citerefentry" href="glVertexAttribPointer"><span class="citerefentry"><span class="refentrytitle">glVertexAttribPointer</span></span></a>
</p>
</div>
<div class="refsect1" id="Copyright">
<h2>Copyright</h2>
<p>
Copyright © 2010 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>