<!DOCTYPE refentry [ <!ENTITY % mathent SYSTEM "math.ent"> %mathent; ]>

<!-- Converted by db4-upgrade version 1.1 -->

<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="gl_NumWorkGroups">
    <info>
        <copyright>
            <year>2011-2014</year>
            <holder>Khronos Group</holder>
        </copyright>
    </info>
    <refmeta>
        <refentrytitle>gl_NumWorkGroups</refentrytitle>
        <manvolnum>3G</manvolnum>
    </refmeta>
    <refnamediv>
        <refname>gl_NumWorkGroups</refname>
        <refpurpose>contains the number of workgroups that have been dispatched to a compute shader</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Declaration</title>
        <fieldsynopsis>
            <modifier>in</modifier> 
            <type>uvec3</type> 
            <varname>gl_NumWorkGroups</varname>
        </fieldsynopsis>
    </refsynopsisdiv>
    <refsect1 xml:id="description"><title>Description</title>
        <para>
            In the compute language, <varname>gl_NumWorkGroups</varname>
            contains the total number of work groups that will execute the compute
            shader. The components of <varname>gl_NumWorkGroups</varname> are equal to the <parameter>num_groups_x</parameter>,
            <parameter>num_groups_y</parameter>, and <parameter>num_groups_z</parameter> parameters passed to the 
            <function>glDispatchCompute</function> command.
        </para>
    </refsect1>
    <refsect1 xml:id="versions">
        <title>Version Support</title>
        <informaltable>
            <tgroup cols="4" align="left">
                <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="funchead.xml" xpointer="xpointer(/*/*)"/>
                <tbody>
                    <row>
                        <entry><varname>gl_NumWorkGroups</varname></entry>
                        <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="version.xml" xpointer="xpointer(/*/*[@role='es31']/*)"/>
                    </row>
                </tbody>
            </tgroup>
        </informaltable>
    </refsect1>
    <refsect1 xml:id="seealso"><title>See Also</title>
        <para>
            <citerefentry><refentrytitle>gl_WorkGroupSize</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>gl_WorkGroupID</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>gl_LocalInvocationID</refentrytitle></citerefentry>
        </para>
    </refsect1>
    <refsect1 xml:id="Copyright"><title>Copyright</title>
        <para>
            Copyright <trademark class="copyright"/> 2011-2014 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.
            <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://opencontent.org/openpub/">http://opencontent.org/openpub/</link>.
        </para>
    </refsect1>
</refentry>
