upstream-doc/manglsl/atomicCounterIncrement.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="atomicCounterIncrement">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>2011</year>
   9                 <holder>Khronos Group</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>atomicCounterIncrement</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>atomicCounterIncrement</refname>
  17         <refpurpose>atomically increment a counter and return the prior value</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>Declaration</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>uint <function>atomicCounterIncrement</function></funcdef>
  23                 <paramdef>atomic_uint <parameter>c</parameter></paramdef>
  24             </funcprototype>
  25         </funcsynopsis>
  26     </refsynopsisdiv>
  27     <refsect1 id="parameters"><title>Parameters</title>
  28         <variablelist>
  29         <varlistentry>
  30             <term><parameter>c</parameter></term>
  31             <listitem>
  32                 <para>
  33                     Specify the handle to the atomic counter to increment.
  34                 </para>
  35             </listitem>
  36         </varlistentry>
  37         </variablelist>
  38     </refsect1>
  39     <refsect1 id="description"><title>Description</title>
  40         <para>
  41             <function>atomicCounterIncrement</function> atomically increments the value
  42             of the atomic counter <parameter>c</parameter> and returns its prior value.
  43         </para>
  44     </refsect1>
  45     <refsect1 id="versions"><title>Version Support</title>
  46         <informaltable frame="topbot">
  47             #VARTABLECOLS#
  48                 <thead>
  49                     #FUNCTABLEHEADER#
  50                     <row>
  51                         <entry>atomicCounterIncrement</entry>#newin42#
  52                     </row>
  53                 </thead>
  54             </tgroup>
  55         </informaltable>
  56     </refsect1>
  57     <refsect1 id="seealso"><title>See Also</title>
  58         <para>
  59             <citerefentry><refentrytitle>atomicCounterDecrement</refentrytitle></citerefentry>,
  60             <citerefentry><refentrytitle>atomicCounter</refentrytitle></citerefentry>
  61         </para>
  62     </refsect1>
  63     <refsect1 id="Copyright"><title>Copyright</title>
  64         <para>
  65             Copyright <trademark class="copyright"></trademark> 2011 Khronos Group.
  66             This material may be distributed subject to the terms and conditions set forth in
  67             the Open Publication License, v 1.0, 8 June 1999.
  68             <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
  69         </para>
  70     </refsect1>
  71 </refentry>