HCoop / clinton / guile-figl.git / blame
| Commit | Line | Data |
|---|---|---|
| 7faf1d71 AW |
1 | <?xml version="1.0" encoding="UTF-8"?> |
| 2 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd"> | |
| 3 | <!-- saved from url=(0013)about:internet --> | |
| 4 | <?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.69.1" /></head><body><div class="refentry" lang="en" xml:lang="en"><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" summary="Function synopsis" cellspacing="0" cellpadding="0"><tr><td><code class="funcdef">void <b class="fsfunc">glDispatchCompute</b>(</code></td><td>GLuint </td><td><var class="pdparam">num_groups_x</var>, </td></tr><tr><td> </td><td>GLuint </td><td><var class="pdparam">num_groups_y</var>, </td></tr><tr><td> </td><td>GLuint </td><td><var class="pdparam">num_groups_z</var><code>)</code>;</td></tr></table></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="parameters"></a><h2>Parameters</h2><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>num_groups_x</code></em></span></dt><dd><p> | |
| 5 | The number of work groups to be launched in the X dimension. | |
| 6 | </p></dd><dt><span class="term"><em class="parameter"><code>num_groups_y</code></em></span></dt><dd><p> | |
| 7 | The number of work groups to be launched in the Y dimension. | |
| 8 | </p></dd><dt><span class="term"><em class="parameter"><code>num_groups_z</code></em></span></dt><dd><p> | |
| 9 | The number of work groups to be launched in the Z dimension. | |
| 10 | </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p> | |
| 11 | <code class="function">glDispatchCompute</code> launches one or more compute | |
| 12 | work groups. Each work group is processed by the active program object for the compute | |
| 13 | shader stage. While the individual shader invocations within a work group are | |
| 14 | executed as a unit, work groups are executed completely independently and in | |
| 15 | unspecified order. <em class="parameter"><code>num_groups_x</code></em>, <em class="parameter"><code>num_groups_y</code></em> | |
| 16 | and <em class="parameter"><code>num_groups_z</code></em> specify the number of local | |
| 17 | work groups that will be dispatched in the X, Y and Z dimensions, respectively. | |
| 18 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p> | |
| 19 | <code class="constant">GL_INVALID_OPERATION</code> is generated if there is no active program | |
| 20 | for the compute shader stage. | |
| 21 | </p><p> | |
| 22 | <code class="constant">GL_INVALID_VALUE</code> is generated if any of <em class="parameter"><code>num_groups_x</code></em>, | |
| 23 | <em class="parameter"><code>num_groups_y</code></em>, or <em class="parameter"><code>num_groups_z</code></em> is greater than or | |
| 24 | equal to the maximum work-group count for the corresponding dimension. | |
| 25 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="associatedgets"></a><h2>Associated Gets</h2><p> | |
| 26 | <a 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> | |
| 27 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p> | |
| 28 | <a href="glDispatchComputeIndirect.xml"><span class="citerefentry"><span class="refentrytitle">glDispatchComputeIndirect</span></span></a>. | |
| 29 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p> | |
| 30 | Copyright <span class="trademark"></span>© 2012 Khronos Group. | |
| 31 | This material may be distributed subject to the terms and conditions set forth in | |
| 32 | the Open Publication License, v 1.0, 8 June 1999. | |
| 33 | <a href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>. | |
| 34 | </p></div></div></body></html> |