Opentk/Source/Bind/Specifications/Docs/ES31/gl_LocalInvocationID.xml
2014-03-28 20:06:55 +01:00

69 lines
3.1 KiB
XML

<!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_LocalInvocationID">
<info>
<copyright>
<year>2011-2014</year>
<holder>Khronos Group</holder>
</copyright>
</info>
<refmeta>
<refentrytitle>gl_LocalInvocationID</refentrytitle>
<manvolnum>3G</manvolnum>
</refmeta>
<refnamediv>
<refname>gl_LocalInvocationID</refname>
<refpurpose>contains the index of work item currently being operated on by a compute shader</refpurpose>
</refnamediv>
<refsynopsisdiv>
<title>Declaration</title>
<fieldsynopsis>
<modifier>in</modifier>
<type>uvec3</type>
<varname>gl_LocalInvocationID</varname>
</fieldsynopsis>
</refsynopsisdiv>
<refsect1 xml:id="description"><title>Description</title>
<para>
In the compute language, <varname>gl_LocalInvocationID</varname>
is an input variable containing the n-dimensional index of the local
work invocation within the work group that the current shader is
executing in. The possible values for this variable range across
the local work group size, i.e., (0,0,0) to (<varname>gl_WorkGroupSize.x</varname> - 1,
<varname>gl_WorkGroupSize.y</varname> - 1, <varname>gl_WorkGroupSize.z</varname> - 1).
</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_LocalInvocationID</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_NumWorkGroups</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>gl_WorkGroupID</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>gl_WorkGroupSize</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>gl_GlobalInvocationID</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>