HCoop / clinton / guile-figl.git / blame
| 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_WorkGroupSize">\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_WorkGroupSize</refentrytitle>\r | |
| 13 | <manvolnum>3G</manvolnum>\r | |
| 14 | </refmeta>\r | |
| 15 | <refnamediv>\r | |
| 16 | <refname>gl_WorkGroupSize</refname>\r | |
| 17 | <refpurpose>contains the size of the workgroup operated on by a compute shader</refpurpose>\r | |
| 18 | </refnamediv>\r | |
| 19 | <refsynopsisdiv><title>Declaration</title>\r | |
| 20 | <funcsynopsis>\r | |
| 21 | <function>const uvec3 gl_WorkGroupSize</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_WorkGroupSize</function>\r | |
| 27 | contains the size of a workgroup declared by a compute\r | |
| 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>.\r | |
| 29 | The values stored in <function>gl_WorkGroupSize</function> match those specified in the \r | |
| 30 | required <function>local_size_x</function>, <function>local_size_y</function>, and <function>local_size_z</function> layout\r | |
| 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\r | |
| 32 | the local work group.\r | |
| 33 | </para>\r | |
| 34 | </refsect1>\r | |
| 35 | <refsect1 id="versions"><title>Version Support</title>\r | |
| 36 | <informaltable frame="topbot">\r | |
| 37 | #VARTABLECOLS#\r | |
| 38 | <thead>\r | |
| 39 | #VARTABLEHEADER#\r | |
| 40 | <row>\r | |
| 41 | <entry>gl_WorkGroupSize</entry>#newin43#\r | |
| 42 | </row>\r | |
| 43 | </thead>\r | |
| 44 | </tgroup>\r | |
| 45 | </informaltable>\r | |
| 46 | </refsect1>\r | |
| 47 | <refsect1 id="seealso"><title>See Also</title>\r | |
| 48 | <para>\r | |
| 49 | <citerefentry><refentrytitle>gl_NumWorkGroups</refentrytitle></citerefentry>,\r | |
| 50 | <citerefentry><refentrytitle>gl_WorkGroupID</refentrytitle></citerefentry>,\r | |
| 51 | <citerefentry><refentrytitle>gl_LocalInvocationID</refentrytitle></citerefentry>\r | |
| 52 | </para>\r | |
| 53 | </refsect1>\r | |
| 54 | <refsect1 id="Copyright"><title>Copyright</title>\r | |
| 55 | <para>\r | |
| 56 | Copyright <trademark class="copyright"></trademark> 2011-2012 Khronos Group. \r | |
| 57 | This material may be distributed subject to the terms and conditions set forth in \r | |
| 58 | the Open Publication License, v 1.0, 8 June 1999.\r | |
| 59 | <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.\r | |
| 60 | </para>\r | |
| 61 | </refsect1>\r | |
| 62 | </refentry>\r |