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