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
|
<?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>glDispatchCompute - OpenGL 4 Reference Pages</title><meta name="generator" content="DocBook XSL Stylesheets V1.78.1" /></head><body><div class="refentry"><a id="glDispatchCompute"></a><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 border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><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"><a id="parameters"></a><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"><a id="description"></a><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"><a id="errors"></a><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"><a id="associatedgets"></a><h2>Associated Gets</h2><p>
<a class="citerefentry" href="glGet.xml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_MAX_COMPUTE_WORK_GROUP_COUNT</code>
</p></div><div class="refsect1"><a id="seealso"></a><h2>See Also</h2><p>
<a class="citerefentry" href="glDispatchComputeIndirect.xml"><span class="citerefentry"><span class="refentrytitle">glDispatchComputeIndirect</span></span></a>.
</p></div><div class="refsect1"><a id="Copyright"></a><h2>Copyright</h2><p>
Copyright <span class="trademark"></span>© 2013 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="ulink" href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
</p></div></div></body></html>
|
