dad207b730cf9827a1f1cd4a56e8d5f9e430fb8f
[clinton/guile-figl.git] / upstream-man-pages / manglsl / xhtml / atomicCompSwap.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>atomicCompSwap - 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="atomicCompSwap"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>atomicCompSwap — perform an atomic compare-exchange operation to a variable</p></div><div class="refsynopsisdiv"><h2>Declaration</h2><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" style="padding-bottom: 1em"><tr><td><code class="funcdef">int <b class="fsfunc">atomicCompSwap</b>(</code></td><td>inout int  </td><td><var class="pdparam">mem</var>, </td></tr><tr><td> </td><td>uint  </td><td><var class="pdparam">compare</var>, </td></tr><tr><td> </td><td>uint  </td><td><var class="pdparam">data</var><code>)</code>;</td></tr></table><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"><tr><td><code class="funcdef">uint <b class="fsfunc">atomicCompSwap</b>(</code></td><td>inout uint  </td><td><var class="pdparam">mem</var>, </td></tr><tr><td> </td><td>uint  </td><td><var class="pdparam">compare</var>, </td></tr><tr><td> </td><td>uint  </td><td><var class="pdparam">data</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>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 and potentially exchanged with <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">atomicCompSwap</code> performs an atomic comparison of <em class="parameter"><code>compare</code></em> with the contents of
10 <em class="parameter"><code>mem</code></em>. If the content of <em class="parameter"><code>mem</code></em> is equal to <em class="parameter"><code>compare</code></em>,
11 then the content of <em class="parameter"><code>data</code></em> is written into <em class="parameter"><code>mem</code></em> and is returned from
12 the function. Otherwise, the original contents of <em class="parameter"><code>mem</code></em>
13 are returned. The contents of the memory being updated by the atomic operation are
14 guaranteed not to be modified by any other assignment or atomic memory function in any shader
15 invocation between the time the original value is read and the time the new value is written.
16 </p><p>
17 Atomic memory functions are supported only for a limited set of variables. A shader will fail to compile
18 if the value passed to the mem argument of an atomic memory function does not correspond to a buffer or
19 shared variable. It is acceptable to pass an element of an array or a single component of a vector to the
20 mem argument of an atomic memory function, as long as the underlying array or vector is a buffer or
21 shared variable.
22 </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">atomicCompSwap</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>
23 <a href="atomicAdd.xml"><span class="citerefentry"><span class="refentrytitle">atomicAdd</span></span></a>,
24 <a href="atomicAnd.xml"><span class="citerefentry"><span class="refentrytitle">atomicAnd</span></span></a>,
25 <a href="atomicOr.xml"><span class="citerefentry"><span class="refentrytitle">atomicOr</span></span></a>,
26 <a href="atomicXor.xml"><span class="citerefentry"><span class="refentrytitle">atomicXor</span></span></a>,
27 <a href="atomicMin.xml"><span class="citerefentry"><span class="refentrytitle">atomicMin</span></span></a>,
28 <a href="atomicMax.xml"><span class="citerefentry"><span class="refentrytitle">atomicMax</span></span></a>,
29 <a href="atomicExchange.xml"><span class="citerefentry"><span class="refentrytitle">atomicExchange</span></span></a>
30 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
31 Copyright <span class="trademark"></span>© 2011-2012 Khronos Group.
32 This material may be distributed subject to the terms and conditions set forth in
33 the Open Publication License, v 1.0, 8 June 1999.
34 <a href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
35 </p></div></div></body></html>