/
glMultiDrawArraysIndirect.xhtml
309 lines (307 loc) · 15.5 KB
/
glMultiDrawArraysIndirect.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
<div class="refentry" id="glMultiDrawArraysIndirect">
<div class="titlepage"></div>
<div class="refnamediv">
<h2>Name</h2>
<p>glMultiDrawArraysIndirect — render multiple sets of primitives from array data, taking parameters from memory</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">glMultiDrawArraysIndirect</strong>(</code>
</td>
<td>GLenum <var class="pdparam">mode</var>, </td>
</tr>
<tr>
<td> </td>
<td>const void *<var class="pdparam">indirect</var>, </td>
</tr>
<tr>
<td> </td>
<td>GLsizei <var class="pdparam">drawcount</var>, </td>
</tr>
<tr>
<td> </td>
<td>GLsizei <var class="pdparam">stride</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>indirect</code>
</em>
</span>
</dt>
<dd>
<p>
Specifies the address of an array of structures containing the draw parameters.
</p>
</dd>
<dt>
<span class="term">
<em class="parameter">
<code>drawcount</code>
</em>
</span>
</dt>
<dd>
<p>
Specifies the the number of elements in the array of draw parameter structures.
</p>
</dd>
<dt>
<span class="term">
<em class="parameter">
<code>stride</code>
</em>
</span>
</dt>
<dd>
<p>
Specifies the distance in basic machine units between elements of the draw parameter array.
</p>
</dd>
</dl>
</div>
</div>
<div class="refsect1" id="description">
<h2>Description</h2>
<p>
<code class="function">glMultiDrawArraysIndirect</code> specifies multiple geometric primitives
with very few subroutine calls. <code class="function">glMultiDrawArraysIndirect</code> behaves
similarly to a multitude of calls to <a class="citerefentry" href="glDrawArraysInstancedBaseInstance"><span class="citerefentry"><span class="refentrytitle">glDrawArraysInstancedBaseInstance</span></span></a>,
execept that the parameters to each call to <a class="citerefentry" href="glDrawArraysInstancedBaseInstance"><span class="citerefentry"><span class="refentrytitle">glDrawArraysInstancedBaseInstance</span></span></a>
are stored in an array in memory at the address given by <em class="parameter"><code>indirect</code></em>, separated
by the stride, in basic machine units, specified by <em class="parameter"><code>stride</code></em>. If <em class="parameter"><code>stride</code></em>
is zero, then the array is assumed to be tightly packed in memory.
</p>
<p>
The parameters addressed by <em class="parameter"><code>indirect</code></em> are packed into an array of structures,
each element of which takes the form (in C):
</p>
<pre class="programlisting"> typedef struct {
uint count;
uint instanceCount;
uint first;
uint baseInstance;
} DrawArraysIndirectCommand;</pre>
<p>
</p>
<p>
A single call to <code class="function">glMultiDrawArraysIndirect</code> is equivalent, assuming no errors
are generated to:
</p>
<pre class="programlisting"> GLsizei n;
for (n = 0; n < drawcount; n++) {
const DrawArraysIndirectCommand *cmd;
if (stride != 0) {
cmd = (const DrawArraysIndirectCommand *)((uintptr)indirect + n * stride);
} else {
cmd = (const DrawArraysIndirectCommand *)indirect + n;
}
glDrawArraysInstancedBaseInstance(mode, cmd->first, cmd->count, cmd->instanceCount, cmd->baseInstance);
}</pre>
<p>
</p>
<p>
If a buffer is bound to the <code class="constant">GL_DRAW_INDIRECT_BUFFER</code> binding at the time
of a call to <code class="function">glMultiDrawArraysIndirect</code>, <em class="parameter"><code>indirect</code></em>
is interpreted as an offset, in basic machine units, into that buffer and the parameter
data is read from the buffer rather than from client memory.
</p>
<p>
In contrast to <a class="citerefentry" href="glDrawArraysInstancedBaseInstance"><span class="citerefentry"><span class="refentrytitle">glDrawArraysInstancedBaseInstance</span></span></a>,
the <code class="code">first</code> member of the parameter structure is unsigned, and out-of-range indices
do not generate an error.
</p>
<p>
Vertex attributes that are modified by <code class="function">glMultiDrawArraysIndirect</code> have an
unspecified value after <code class="function">glMultiDrawArraysIndirect</code> returns. Attributes that aren't
modified remain well defined.
</p>
</div>
<div class="refsect1" id="notes">
<h2>Notes</h2>
<p>
The <em class="parameter"><code>baseInstance</code></em> member of the <em class="parameter"><code>DrawArraysIndirectCommand</code></em>
structure is defined only if the GL version is 4.2 or greater. For versions of the GL less than 4.2,
this parameter is present but is reserved and should be set to zero. On earlier versions of the GL,
behavior is undefined if it is non-zero.
</p>
<p>
<code class="function">glMultiDrawArraysIndirect</code> is available only if the GL version is 4.3 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>stride</code></em> is not a multiple
of four.
</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 to the <code class="constant">GL_DRAW_INDIRECT_BUFFER</code> binding and the buffer object's data store is currently mapped.
</p>
<p>
<code class="constant">GL_INVALID_OPERATION</code> is generated if a geometry shader is active and <em class="parameter"><code>mode</code></em>
is incompatible with the input primitive type of the geometry shader in the currently installed program object.
</p>
<p>
<code class="constant">GL_INVALID_OPERATION</code> is generated if <em class="parameter"><code>mode</code></em> is <code class="constant">GL_PATCHES</code>
and no tessellation control shader is active.
</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">glMultiDrawArraysIndirect</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="glDrawArrays"><span class="citerefentry"><span class="refentrytitle">glDrawArrays</span></span></a>,
<a class="citerefentry" href="glDrawArraysInstanced"><span class="citerefentry"><span class="refentrytitle">glDrawArraysInstanced</span></span></a>,
<a class="citerefentry" href="glDrawElements"><span class="citerefentry"><span class="refentrytitle">glDrawElements</span></span></a>,
<a class="citerefentry" href="glDrawRangeElements"><span class="citerefentry"><span class="refentrytitle">glDrawRangeElements</span></span></a>,
<a class="citerefentry" href="glDrawArraysIndirect"><span class="citerefentry"><span class="refentrytitle">glDrawArraysIndirect</span></span></a>,
<a class="citerefentry" href="glMultiDrawElementsIndirect"><span class="citerefentry"><span class="refentrytitle">glMultiDrawElementsIndirect</span></span></a>
</p>
</div>
<div class="refsect1" id="Copyright">
<h2>Copyright</h2>
<p>
Copyright © 2012-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>