upstream-man-pages/manglsl/gl_LocalInvocationIndex.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_LocalInvocationIndex">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>2012</year>
   9                 <holder>Khronos Group</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>gl_LocalInvocationIndex</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>gl_LocalInvocationIndex</refname>
  17         <refpurpose>contains the local linear 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 uint gl_LocalInvocationIndex</function>
  22         </funcsynopsis>
  23     </refsynopsisdiv>
  24     <refsect1 id="description"><title>Description</title>
  25         <para>
  26             In the compute language, <function>gl_LocalInvocationIndex</function>
  27             is a derived input variable containing the 1-dimensional linearized index of the
  28             work invocation within the work group that the current shader is
  29             executing on. The value of <function>gl_LocalInvocationIndex</function> is equal to
  30             <function>gl_LocalInvocationID.z</function> * <function>gl_WorkGroupSize.x</function> * <function>gl_WorkGroupSize.y</function> +
  31             <function>gl_LocalInvocationID.y</function> * <function>gl_WorkGroupSize.x</function> +
  32             <function>gl_LocalInvocationID.x</function>.
  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_LocalInvocationIndex</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_WorkGroupSize</refentrytitle></citerefentry>,
  52             <citerefentry><refentrytitle>gl_LocalInvocationID</refentrytitle></citerefentry>
  53         </para>
  54     </refsect1>
  55     <refsect1 id="Copyright"><title>Copyright</title>
  56         <para>
  57             Copyright <trademark class="copyright"></trademark> 2011-2012 Khronos Group.
  58             This material may be distributed subject to the terms and conditions set forth in
  59             the Open Publication License, v 1.0, 8 June 1999.
  60             <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
  61         </para>
  62     </refsect1>
  63 </refentry>