upstream-man-pages/manglsl/xhtml/atomicMax.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>atomixMax - 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="atomixMax"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>atomixMax — perform an atomic max operation to a variable</p></div><div class="refsynopsisdiv"><h2>Declaration</h2><div class="funcsynopsis"><p><code class="funcdef">int <b class="fsfunc">atomixMax</b>(</code>inout int <var class="pdparam">mem</var>, int <var class="pdparam">data</var><code>)</code>;</p><p><code class="funcdef">uint <b class="fsfunc">atomixMax</b>(</code>inout uint <var class="pdparam">mem</var>, uint <var class="pdparam">data</var><code>)</code>;</p></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>mem</code></em></span></dt><dd><p>
   5                     The variable to use as the target of the operation.
   6                 </p></dd><dt><span class="term"><em class="parameter"><code>data</code></em></span></dt><dd><p>
   7                     The data to be compared to <em class="parameter"><code>mem</code></em>.
   8                 </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
   9             <code class="function">atomicMax</code> performs an atomic comparison of <em class="parameter"><code>data</code></em> to the contents of
  10             <em class="parameter"><code>mem</code></em>, writes the maximum value into <em class="parameter"><code>mem</code></em> and returns the original contents of <em class="parameter"><code>mem</code></em>
  11             from before the comparison occured. The contents of the memory being updated by the atomic operation are
  12             guaranteed not to be modified by any other assignment or atomic memory function in any shader
  13             invocation between the time the original value is read and the time the new value is written.
  14         </p><p>
  15             Atomic memory functions are supported only for a limited set of variables.  A shader will fail to compile
  16             if the value passed to the mem argument of  an atomic memory function does not correspond to a buffer or
  17             shared variable.  It is acceptable to pass an element of an array or a single component of a vector to the
  18             mem argument of an atomic memory function, as long as the underlying array or vector is a buffer or
  19             shared variable.
  20         </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>Function</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">atomixMax</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>
  21             <a href="atomicAdd.xml"><span class="citerefentry"><span class="refentrytitle">atomicAdd</span></span></a>,
  22             <a href="atomicAnd.xml"><span class="citerefentry"><span class="refentrytitle">atomicAnd</span></span></a>,
  23             <a href="atomicOr.xml"><span class="citerefentry"><span class="refentrytitle">atomicOr</span></span></a>,
  24             <a href="atomicXor.xml"><span class="citerefentry"><span class="refentrytitle">atomicXor</span></span></a>,
  25             <a href="atomicMin.xml"><span class="citerefentry"><span class="refentrytitle">atomicMin</span></span></a>,
  26             <a href="atomicExchange.xml"><span class="citerefentry"><span class="refentrytitle">atomicExchange</span></span></a>,
  27             <a href="atomicCompSwap.xml"><span class="citerefentry"><span class="refentrytitle">atomicCompSwap</span></span></a>
  28         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
  29             Copyright <span class="trademark"></span>© 2011-2012 Khronos Group.
  30             This material may be distributed subject to the terms and conditions set forth in
  31             the Open Publication License, v 1.0, 8 June 1999.
  32             <a href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
  33         </p></div></div></body></html>