upstream-man-pages/manglsl/gl_NumWorkGroups.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
   3               "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">
   4 <refentry id="gl_NumWorkGroups">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>2012</year>
   9                 <holder>Khronos Group</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>gl_NumWorkGroups</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>gl_NumWorkGroups</refname>
  17         <refpurpose>contains the number of workgroups that have been dispatched to a compute shader</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>Declaration</title>
  20         <funcsynopsis>
  21             <function>in uvec3 gl_NumWorkGroups</function>
  22         </funcsynopsis>
  23     </refsynopsisdiv>
  24     <refsect1 id="description"><title>Description</title>
  25         <para>
  26             In the compute language, <function>gl_NumWorkGroups</function>
  27             contains the total number of work groups that will execute the compute
  28             shader. The components of <function>gl_NumWorkGroups</function> are equal to the <parameter>num_groups_x</parameter>,
  29             <parameter>num_groups_y</parameter>, and <parameter>num_groups_z</parameter> parameters passed to the
  30             <function>glDispatchCompute</function> command.
  31         </para>
  32     </refsect1>
  33     <refsect1 id="versions"><title>Version Support</title>
  34         <informaltable frame="topbot">
  35             #VARTABLECOLS#
  36                 <thead>
  37                     #VARTABLEHEADER#
  38                     <row>
  39                         <entry>gl_NumWorkGroups</entry>#newin43#
  40                     </row>
  41                 </thead>
  42             </tgroup>
  43         </informaltable>
  44     </refsect1>
  45     <refsect1 id="seealso"><title>See Also</title>
  46         <para>
  47             <citerefentry><refentrytitle>gl_WorkGroupSize</refentrytitle></citerefentry>,
  48             <citerefentry><refentrytitle>gl_WorkGroupID</refentrytitle></citerefentry>,
  49             <citerefentry><refentrytitle>gl_LocalInvocationID</refentrytitle></citerefentry>
  50         </para>
  51     </refsect1>
  52     <refsect1 id="Copyright"><title>Copyright</title>
  53         <para>
  54             Copyright <trademark class="copyright"></trademark> 2011-2012 Khronos Group.
  55             This material may be distributed subject to the terms and conditions set forth in
  56             the Open Publication License, v 1.0, 8 June 1999.
  57             <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
  58         </para>
  59     </refsect1>
  60 </refentry>