mirror of
https://github.com/Ryujinx/Opentk.git
synced 2024-12-27 11:55:42 +00:00
98 lines
4.2 KiB
XML
98 lines
4.2 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
|
|
"http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">
|
|
<refentry id="glDispatchCompute">
|
|
<refmeta>
|
|
<refmetainfo>
|
|
<copyright>
|
|
<year>2012</year>
|
|
<holder>Khronos Group</holder>
|
|
</copyright>
|
|
</refmetainfo>
|
|
<refentrytitle>glDispatchCompute</refentrytitle>
|
|
<manvolnum>3G</manvolnum>
|
|
</refmeta>
|
|
<refnamediv>
|
|
<refname>glDispatchCompute</refname>
|
|
<refpurpose>launch one or more compute work groups</refpurpose>
|
|
</refnamediv>
|
|
<refsynopsisdiv><title>C Specification</title>
|
|
<funcsynopsis>
|
|
<funcprototype>
|
|
<funcdef>void <function>glDispatchCompute</function></funcdef>
|
|
<paramdef>GLuint <parameter>num_groups_x</parameter></paramdef>
|
|
<paramdef>GLuint <parameter>num_groups_y</parameter></paramdef>
|
|
<paramdef>GLuint <parameter>num_groups_z</parameter></paramdef>
|
|
</funcprototype>
|
|
</funcsynopsis>
|
|
</refsynopsisdiv>
|
|
<refsect1 id="parameters"><title>Parameters</title>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>num_groups_x</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The number of work groups to be launched in the X dimension.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>num_groups_y</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The number of work groups to be launched in the Y dimension.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>num_groups_z</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The number of work groups to be launched in the Z dimension.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
<refsect1 id="description"><title>Description</title>
|
|
<para>
|
|
<function>glDispatchCompute</function> 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. <parameter>num_groups_x</parameter>, <parameter>num_groups_y</parameter>
|
|
and <parameter>num_groups_z</parameter> specify the number of local
|
|
work groups that will be dispatched in the X, Y and Z dimensions, respectively.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 id="errors"><title>Errors</title>
|
|
<para>
|
|
<constant>GL_INVALID_OPERATION</constant> is generated if there is no active program
|
|
for the compute shader stage.
|
|
</para>
|
|
<para>
|
|
<constant>GL_INVALID_VALUE</constant> is generated if any of <parameter>num_groups_x</parameter>,
|
|
<parameter>num_groups_y</parameter>, or <parameter>num_groups_z</parameter> is greater than or
|
|
equal to the maximum work-group count for the corresponding dimension.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 id="associatedgets"><title>Associated Gets</title>
|
|
<para>
|
|
<citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_MAX_COMPUTE_WORK_GROUP_COUNT</constant>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 id="seealso"><title>See Also</title>
|
|
<para>
|
|
<citerefentry><refentrytitle>glDispatchComputeIndirect</refentrytitle></citerefentry>.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 id="Copyright"><title>Copyright</title>
|
|
<para>
|
|
Copyright <trademark class="copyright"></trademark> 2012 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.
|
|
<ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|