upstream-man-pages/manglsl/xhtml/gl_WorkGroupSize.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd">
   3 <!-- saved from url=(0013)about:internet -->
   4 <?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" pref:renderer="mathplayer-dl"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><link rel="stylesheet" type="text/css" href="opengl-man.css" /><title>gl_WorkGroupSize - OpenGL Shading Language (GLSL)</title><meta name="generator" content="DocBook XSL Stylesheets V1.69.1" /></head><body><div class="refentry" lang="en" xml:lang="en"><a id="gl_WorkGroupSize"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>gl_WorkGroupSize — contains the size of the workgroup operated on by a compute shader</p></div><div class="refsynopsisdiv"><h2>Declaration</h2><div class="funcsynopsis"><code class="function">const uvec3 gl_WorkGroupSize</code></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
   5             In the compute language, <code class="function">gl_WorkGroupSize</code>
   6             contains the size of a workgroup declared by a compute
   7             shader. The size of the work group in the X, Y, and Z dimensions is stored in the x, y, and z components of <code class="function">gl_WorkGroupSize</code>.
   8             The values stored in <code class="function">gl_WorkGroupSize</code> match those specified in the
   9             required <code class="function">local_size_x</code>, <code class="function">local_size_y</code>, and <code class="function">local_size_z</code> layout
  10             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
  11             the local work group.
  12         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="versions"></a><h2>Version Support</h2><div class="informaltable"><table border="1"><colgroup><col align="left" /><col align="center" /><col align="center" /><col align="center" /><col align="center" /><col align="center" /><col align="center" /><col align="center" /><col align="center" /><col align="center" /><col align="center" /></colgroup><thead><tr><th align="left"><span class="bold"><strong>Variable</strong></span></th><th align="left"><span class="bold"><strong>Version 1.10</strong></span></th><th align="left"><span class="bold"><strong>Version 1.20</strong></span></th><th align="left"><span class="bold"><strong>Version 1.30</strong></span></th><th align="left"><span class="bold"><strong>Version 1.40</strong></span></th><th align="left"><span class="bold"><strong>Version 1.50</strong></span></th><th align="left"><span class="bold"><strong>Version 3.30</strong></span></th><th align="left"><span class="bold"><strong>Version 4.00</strong></span></th><th align="left"><span class="bold"><strong>Version 4.10</strong></span></th><th align="left"><span class="bold"><strong>Version 4.20</strong></span></th><th align="center"><span class="bold"><strong>Version 4.30</strong></span></th></tr><tr><th align="left">gl_WorkGroupSize</th><th align="center"><span class="emphasis"><em>-</em></span></th><th align="center"><span class="emphasis"><em>-</em></span></th><th align="center"><span class="emphasis"><em>-</em></span></th><th align="center"><span class="emphasis"><em>-</em></span></th><th align="center"><span class="emphasis"><em>-</em></span></th><th align="center"><span class="emphasis"><em>-</em></span></th><th align="center"><span class="emphasis"><em>-</em></span></th><th align="center"><span class="emphasis"><em>-</em></span></th><th align="center"><span class="emphasis"><em>-</em></span></th><th align="center"><span class="emphasis"><em>Y</em></span></th></tr></thead></table></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
  13             <a href="gl_NumWorkGroups.xml"><span class="citerefentry"><span class="refentrytitle">gl_NumWorkGroups</span></span></a>,
  14             <a href="gl_WorkGroupID.xml"><span class="citerefentry"><span class="refentrytitle">gl_WorkGroupID</span></span></a>,
  15             <a href="gl_LocalInvocationID.xml"><span class="citerefentry"><span class="refentrytitle">gl_LocalInvocationID</span></span></a>
  16         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
  17             Copyright <span class="trademark"></span>© 2011-2012 Khronos Group.
  18             This material may be distributed subject to the terms and conditions set forth in
  19             the Open Publication License, v 1.0, 8 June 1999.
  20             <a href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
  21         </p></div></div></body></html>