-
Notifications
You must be signed in to change notification settings - Fork 95
/
glDispatchCompute.xhtml
165 lines (164 loc) · 6.83 KB
/
glDispatchCompute.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
<div class="refentry" id="glDispatchCompute">
<div class="titlepage"></div>
<div class="refnamediv">
<h2>Name</h2>
<p>glDispatchCompute — launch one or more compute work groups</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">glDispatchCompute</strong>(</code>
</td>
<td>GLuint <var class="pdparam">num_groups_x</var>, </td>
</tr>
<tr>
<td> </td>
<td>GLuint <var class="pdparam">num_groups_y</var>, </td>
</tr>
<tr>
<td> </td>
<td>GLuint <var class="pdparam">num_groups_z</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>num_groups_x</code>
</em>
</span>
</dt>
<dd>
<p>
The number of work groups to be launched in the X dimension.
</p>
</dd>
<dt>
<span class="term">
<em class="parameter">
<code>num_groups_y</code>
</em>
</span>
</dt>
<dd>
<p>
The number of work groups to be launched in the Y dimension.
</p>
</dd>
<dt>
<span class="term">
<em class="parameter">
<code>num_groups_z</code>
</em>
</span>
</dt>
<dd>
<p>
The number of work groups to be launched in the Z dimension.
</p>
</dd>
</dl>
</div>
</div>
<div class="refsect1" id="description">
<h2>Description</h2>
<p>
<code class="function">glDispatchCompute</code> launches one or more compute
work groups. Each work group is processed by the active program object for the compute
shader stage. While the individual shader invocations within a work group are
executed as a unit, work groups are executed completely independently and in
unspecified order. <em class="parameter"><code>num_groups_x</code></em>, <em class="parameter"><code>num_groups_y</code></em>
and <em class="parameter"><code>num_groups_z</code></em> specify the number of local
work groups that will be dispatched in the X, Y and Z dimensions, respectively.
</p>
</div>
<div class="refsect1" id="errors">
<h2>Errors</h2>
<p>
<code class="constant">GL_INVALID_OPERATION</code> is generated if there is no active program
for the compute shader stage.
</p>
<p>
<code class="constant">GL_INVALID_VALUE</code> is generated if any of <em class="parameter"><code>num_groups_x</code></em>,
<em class="parameter"><code>num_groups_y</code></em>, or <em class="parameter"><code>num_groups_z</code></em> is greater than or
equal to the maximum work-group count for the corresponding dimension.
</p>
</div>
<div class="refsect1" id="associatedgets">
<h2>Associated Gets</h2>
<p>
<a class="citerefentry" href="glGet"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_MAX_COMPUTE_WORK_GROUP_COUNT</code>
</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 ; ">
<code class="function">glDispatchCompute</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; ">✔</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="refsect1" id="seealso">
<h2>See Also</h2>
<p>
<a class="citerefentry" href="glDispatchComputeIndirect"><span class="citerefentry"><span class="refentrytitle">glDispatchComputeIndirect</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="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
</p>
</div>
</div>