upstream-doc/man4/xhtml/glGetActiveAtomicCounterBufferiv.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>glGetActiveAtomicCounterBufferiv - OpenGL 4 Reference Pages</title><meta name="generator" content="DocBook XSL Stylesheets V1.69.1" /></head><body><div class="refentry" lang="en" xml:lang="en"><a id="glGetActiveAtomicCounterBufferiv"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glGetActiveAtomicCounterBufferiv — retrieve information about the set of active atomic counter buffers for a program</p></div><div class="refsynopsisdiv"><h2>C Specification</h2><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"><tr><td><code class="funcdef">void <b class="fsfunc">glGetActiveAtomicCounterBufferiv</b>(</code></td><td>Gluint  </td><td><var class="pdparam">program</var>, </td></tr><tr><td> </td><td>GLuint  </td><td><var class="pdparam">bufferIndex</var>, </td></tr><tr><td> </td><td>GLenum  </td><td><var class="pdparam">pname</var>, </td></tr><tr><td> </td><td>GLint * </td><td><var class="pdparam">params</var><code>)</code>;</td></tr></table></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="parameters"></a><h2>Parameters</h2><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>program</code></em></span></dt><dd><p>
   5                     The name of a program object from which to retrieve information.
   6                 </p></dd><dt><span class="term"><em class="parameter"><code>bufferIndex</code></em></span></dt><dd><p>
   7                     Specifies index of an active atomic counter buffer.
   8                 </p></dd><dt><span class="term"><em class="parameter"><code>pname</code></em></span></dt><dd><p>
   9                     Specifies which parameter of the atomic counter buffer to retrieve.
  10                 </p></dd><dt><span class="term"><em class="parameter"><code>params</code></em></span></dt><dd><p>
  11                     Specifies the address of a variable into which to write the retrieved information.
  12                 </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
  13             <code class="function">glGetActiveAtomicCounterBufferiv</code> retrieves information about the set of active
  14             atomic counter buffers for a program object. <em class="parameter"><code>program</code></em> is the name of a program
  15             object for which the command <a href="glLinkProgram.xml"><span class="citerefentry"><span class="refentrytitle">glLinkProgram</span></span></a>
  16             has been issued in the past. It is not necessary for <em class="parameter"><code>program</code></em> to have been linked
  17             successfully. The link may have failed because the number of active atomic counters exceeded the limits.
  18         </p><p>
  19             <em class="parameter"><code>bufferIndex</code></em> specifies the index of an active atomic counter buffer and must be in
  20             the range zero to the value of <code class="constant">GL_ACTIVE_ATOMIC_COUNTER_BUFFERS</code> minus one. The value
  21             of <code class="constant">GL_ACTIVE_ATOMIC_COUNTER_BUFFERS</code> for <em class="parameter"><code>program</code></em> indicates the
  22             number of active atomic counter buffer and can be queried with
  23             <a href="glGetProgram.xml"><span class="citerefentry"><span class="refentrytitle">glGetProgram</span></span></a>.
  24         </p><p>
  25             If no error occurs, the parameter(s) specified by <em class="parameter"><code>pname</code></em> are returned in <em class="parameter"><code>params</code></em>.
  26             If an error is generated, the contents of <em class="parameter"><code>params</code></em> are not modified.
  27         </p><p>
  28             If <em class="parameter"><code>pname</code></em> is <code class="constant">GL_ATOMIC_COUNTER_BUFFER_BINDING</code>, then the index of the
  29             counter buffer binding point associated with the active atomic counter buffer <em class="parameter"><code>bufferIndex</code></em>
  30             for <em class="parameter"><code>program</code></em> is returned.
  31         </p><p>
  32             If <em class="parameter"><code>pname</code></em> is <code class="constant">GL_ATOMIC_COUNTER_BUFFER_DATA_SIZE</code>, then the implementation-dependent
  33             minimum total buffer object size, in baseic machine units, required to hold all active atomic counters in the
  34             atomic counter binding point identified by <em class="parameter"><code>bufferIndex</code></em> is returned.
  35         </p><p>
  36             If <em class="parameter"><code>pname</code></em> is <code class="constant">GL_ATOMIC_COUNTER_BUFFER_ACTIVE_ATOMIC_COUNTERS</code>, then the number of active
  37             atomic counters for the atomic counter buffer identified by <em class="parameter"><code>bufferIndex</code></em> is returned.
  38         </p><p>
  39             If <em class="parameter"><code>pname</code></em> is <code class="constant">GL_ATOMIC_COUNTER_BUFFER_ACTIVE_ATOMIC_COUNTER_INDICES</code>,
  40             then a list of the active atomic counter indices for the atomic counter buffer identified by <em class="parameter"><code>bufferIndex</code></em>
  41             is returned. The number of elements that will be written into <em class="parameter"><code>params</code></em> is the value of
  42             <code class="constant">GL_ATOMIC_COUNTER_BUFFER_ACTIVE_ATOMIC_COUNTERS</code> for <em class="parameter"><code>bufferIndex</code></em>.
  43         </p><p>
  44             If <em class="parameter"><code>pname</code></em> is <code class="constant">GL_ATOMIC_COUNTER_BUFFER_REFERENCED_BY_VERTEX_SHADER</code>,
  45             <code class="constant">GL_ATOMIC_COUNTER_BUFFER_REFERENCED_BY_TESS_CONTROL_SHADER</code>,
  46             <code class="constant">GL_ATOMIC_COUNTER_BUFFER_REFERENCED_BY_TESS_EVALUATION_SHADER</code>,
  47             <code class="constant">GL_ATOMIC_COUNTER_BUFFER_REFERENCED_BY_GEOMETRY_SHADER</code>,
  48             <code class="constant">GL_ATOMIC_COUNTER_BUFFER_REFERENCED_BY_FRAGMENT_SHADER</code>,
  49             <code class="constant">GL_ATOMIC_COUNTER_BUFFER_REFERENCED_BY_COMPUTE_SHADER</code> then a boolean value indicating
  50             whether the atomic counter buffer identified by <em class="parameter"><code>bufferIndex</code></em> is referenced by the vertex,
  51             tessellation control, tessellation evaluation, geometry, fragment or compute processing stages of <em class="parameter"><code>program</code></em>,
  52             respectively, is returned.
  53         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="notes"></a><h2>Notes</h2><p>
  54             <code class="function">glGetActiveAtomicCounterBufferiv</code> is available only if the
  55             GL version is 4.2 or higher.
  56         </p><p>
  57             <code class="constant">GL_ATOMIC_COUNTER_BUFFER_REFERENCED_BY_COMPUTE_SHADER</code> is available
  58             only of the GL version is 4.3 or higher.
  59         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p>
  60             <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>program</code></em> is not the name of a program
  61             object for which <a href="glLinkProgram.xml"><span class="citerefentry"><span class="refentrytitle">glLinkProgram</span></span></a> has been called in the past.
  62         </p><p>
  63             <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>bufferIndex</code></em> is greater than or equal to
  64             the value of <code class="constant">GL_ACTIVE_ATOMIC_COUNTER_BUFFERS</code> for <em class="parameter"><code>program</code></em>.
  65         </p><p>
  66             <code class="constant">GL_INVALID_ENUM</code> is generated if <em class="parameter"><code>pname</code></em> is not one of the accepted tokens.
  67         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
  68             <a href="glGetProgram.xml"><span class="citerefentry"><span class="refentrytitle">glGetProgram</span></span></a>,
  69             <a href="glGetActiveSubroutineUniform.xml"><span class="citerefentry"><span class="refentrytitle">glGetActiveSubroutineUniform</span></span></a>,
  70             <a href="glGetActiveSubroutineUniformName.xml"><span class="citerefentry"><span class="refentrytitle">glGetActiveSubroutineUniformName</span></span></a>,
  71             <a href="glGetUniformLocation.xml"><span class="citerefentry"><span class="refentrytitle">glGetUniformLocation</span></span></a>
  72         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
  73             Copyright <span class="trademark"></span>© 2011 Khronos Group.
  74             This material may be distributed subject to the terms and conditions set forth in
  75             the Open Publication License, v 1.0, 8 June 1999.
  76             <a href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
  77         </p></div></div></body></html>