rename upstream-man-pages to upstream-doc

[clinton/guile-figl.git] / upstream-doc / man4 / glDispatchCompute.xml

diff --git a/upstream-doc/man4/glDispatchCompute.xml b/upstream-doc/man4/glDispatchCompute.xml
new file mode 100644 (file)
index 0000000..06f7a59
--- /dev/null
+++ b/upstream-doc/man4/glDispatchCompute.xml
@@ -0,0 +1,97 @@
+<?xml version="1.0" encoding="UTF-8"?>\r
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"\r
+              "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">\r
+<refentry id="glDispatchCompute">\r
+    <refmeta>\r
+        <refmetainfo>\r
+            <copyright>\r
+                <year>2012</year>\r
+                <holder>Khronos Group</holder>\r
+            </copyright>\r
+        </refmetainfo>\r
+        <refentrytitle>glDispatchCompute</refentrytitle>\r
+        <manvolnum>3G</manvolnum>\r
+    </refmeta>\r
+    <refnamediv>\r
+        <refname>glDispatchCompute</refname>\r
+        <refpurpose>launch one or more compute work groups</refpurpose>\r
+    </refnamediv>\r
+    <refsynopsisdiv><title>C Specification</title>\r
+        <funcsynopsis>\r
+            <funcprototype>\r
+                <funcdef>void <function>glDispatchCompute</function></funcdef>\r
+                <paramdef>GLuint <parameter>num_groups_x</parameter></paramdef>\r
+                <paramdef>GLuint <parameter>num_groups_y</parameter></paramdef>\r
+                <paramdef>GLuint <parameter>num_groups_z</parameter></paramdef>\r
+            </funcprototype>\r
+        </funcsynopsis>\r
+    </refsynopsisdiv>\r
+    <refsect1 id="parameters"><title>Parameters</title>\r
+        <variablelist>\r
+        <varlistentry>\r
+            <term><parameter>num_groups_x</parameter></term>\r
+            <listitem>\r
+                <para>\r
+                    The number of work groups to be launched in the X dimension.\r
+                </para>\r
+            </listitem>\r
+        </varlistentry>\r
+        <varlistentry>\r
+            <term><parameter>num_groups_y</parameter></term>\r
+            <listitem>\r
+                <para>\r
+                    The number of work groups to be launched in the Y dimension.\r
+                </para>\r
+            </listitem>\r
+        </varlistentry>\r
+        <varlistentry>\r
+            <term><parameter>num_groups_z</parameter></term>\r
+            <listitem>\r
+                <para>\r
+                    The number of work groups to be launched in the Z dimension.\r
+                </para>\r
+            </listitem>\r
+        </varlistentry>\r
+        </variablelist>\r
+    </refsect1>\r
+    <refsect1 id="description"><title>Description</title>\r
+        <para>\r
+            <function>glDispatchCompute</function> launches one or more compute\r
+            work groups. Each work group is processed by the active program object for the compute\r
+            shader stage. While the individual shader invocations within a work group are\r
+            executed as a unit, work groups are executed completely independently and in\r
+            unspecified order. <parameter>num_groups_x</parameter>, <parameter>num_groups_y</parameter>\r
+            and <parameter>num_groups_z</parameter> specify the number of local\r
+            work groups that will be dispatched in the X, Y and Z dimensions, respectively.\r
+        </para>\r
+    </refsect1>\r
+    <refsect1 id="errors"><title>Errors</title>\r
+        <para>\r
+            <constant>GL_INVALID_OPERATION</constant> is generated if there is no active program\r
+            for the compute shader stage.\r
+        </para>\r
+        <para>\r
+            <constant>GL_INVALID_VALUE</constant> is generated if any of <parameter>num_groups_x</parameter>,\r
+            <parameter>num_groups_y</parameter>, or <parameter>num_groups_z</parameter> is greater than or\r
+            equal to the maximum work-group count for the corresponding dimension.\r
+        </para>\r
+    </refsect1>\r
+    <refsect1 id="associatedgets"><title>Associated Gets</title>\r
+        <para>\r
+            <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_MAX_COMPUTE_WORK_GROUP_COUNT</constant>\r
+        </para>\r
+    </refsect1>\r
+    <refsect1 id="seealso"><title>See Also</title>\r
+        <para>\r
+            <citerefentry><refentrytitle>glDispatchComputeIndirect</refentrytitle></citerefentry>.\r
+        </para>\r
+    </refsect1>\r
+    <refsect1 id="Copyright"><title>Copyright</title>\r
+        <para>\r
+            Copyright <trademark class="copyright"></trademark> 2012 Khronos Group. \r
+            This material may be distributed subject to the terms and conditions set forth in \r
+            the Open Publication License, v 1.0, 8 June 1999.\r
+            <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.\r
+        </para>\r
+    </refsect1>\r
+</refentry>\r