upstream-man-pages/manglsl/gl_WorkGroupSize.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_WorkGroupSize">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>2012</year>
   9                 <holder>Khronos Group</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>gl_WorkGroupSize</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>gl_WorkGroupSize</refname>
  17         <refpurpose>contains the size of the workgroup operated on by a compute shader</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>Declaration</title>
  20         <funcsynopsis>
  21             <function>const uvec3 gl_WorkGroupSize</function>
  22         </funcsynopsis>
  23     </refsynopsisdiv>
  24     <refsect1 id="description"><title>Description</title>
  25         <para>
  26             In the compute language, <function>gl_WorkGroupSize</function>
  27             contains the size of a workgroup declared by a compute
  28             shader. The size of the work group in the X, Y, and Z dimensions is stored in the x, y, and z components of <function>gl_WorkGroupSize</function>.
  29             The values stored in <function>gl_WorkGroupSize</function> match those specified in the
  30             required <function>local_size_x</function>, <function>local_size_y</function>, and <function>local_size_z</function> layout
  31             qualifiers for the current shader. This value is constant so that it can be used to size arrays of memory that can be shared within
  32             the local work group.
  33         </para>
  34     </refsect1>
  35     <refsect1 id="versions"><title>Version Support</title>
  36         <informaltable frame="topbot">
  37             #VARTABLECOLS#
  38                 <thead>
  39                     #VARTABLEHEADER#
  40                     <row>
  41                         <entry>gl_WorkGroupSize</entry>#newin43#
  42                     </row>
  43                 </thead>
  44             </tgroup>
  45         </informaltable>
  46     </refsect1>
  47     <refsect1 id="seealso"><title>See Also</title>
  48         <para>
  49             <citerefentry><refentrytitle>gl_NumWorkGroups</refentrytitle></citerefentry>,
  50             <citerefentry><refentrytitle>gl_WorkGroupID</refentrytitle></citerefentry>,
  51             <citerefentry><refentrytitle>gl_LocalInvocationID</refentrytitle></citerefentry>
  52         </para>
  53     </refsect1>
  54     <refsect1 id="Copyright"><title>Copyright</title>
  55         <para>
  56             Copyright <trademark class="copyright"></trademark> 2011-2012 Khronos Group.
  57             This material may be distributed subject to the terms and conditions set forth in
  58             the Open Publication License, v 1.0, 8 June 1999.
  59             <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
  60         </para>
  61     </refsect1>
  62 </refentry>