upstream-man-pages/manglsl/gl_LocalInvocationID.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_LocalInvocationID">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>2012</year>
   9                 <holder>Khronos Group</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>gl_LocalInvocationID</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>gl_LocalInvocationID</refname>
  17         <refpurpose>contains the index of work item currently being operated on by a compute shader</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>Declaration</title>
  20         <funcsynopsis>
  21             <function>in uvec3 gl_LocalInvocationID</function>
  22         </funcsynopsis>
  23     </refsynopsisdiv>
  24     <refsect1 id="description"><title>Description</title>
  25         <para>
  26             In the compute language, <function>gl_LocalInvocationID</function>
  27             is an input variable containing the n-dimensional index of the local
  28             work invocation within the work group that the current shader is
  29             executing in. The possible values for this variable range across
  30             the local work group size, i.e., (0,0,0) to (<function>gl_WorkGroupSize.x</function> - 1,
  31             <function>gl_WorkGroupSize.y</function> - 1, <function>gl_WorkGroupSize.z</function> - 1).
  32         </para>
  33     </refsect1>
  34     <refsect1 id="versions"><title>Version Support</title>
  35         <informaltable frame="topbot">
  36             #VARTABLECOLS#
  37                 <thead>
  38                     #VARTABLEHEADER#
  39                     <row>
  40                         <entry>gl_LocalInvocationID</entry>#newin43#
  41                     </row>
  42                 </thead>
  43             </tgroup>
  44         </informaltable>
  45     </refsect1>
  46     <refsect1 id="seealso"><title>See Also</title>
  47         <para>
  48             <citerefentry><refentrytitle>gl_NumWorkGroups</refentrytitle></citerefentry>,
  49             <citerefentry><refentrytitle>gl_WorkGroupID</refentrytitle></citerefentry>,
  50             <citerefentry><refentrytitle>gl_WorkGroupSize</refentrytitle></citerefentry>,
  51             <citerefentry><refentrytitle>gl_GlobalInvocationID</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>