upstream-man-pages/manglsl/imageAtomicXor.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="imageAtomicXor">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>2011</year>
   9                 <holder>Khronos Group</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>imageAtomicXor</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>imageAtomicXor</refname>
  17         <refpurpose>atomically compute the logical exclusive OR of a value with an existing value in memory, store that value and return the original value</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>Declaration</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>uint <function>imageAtomicXor</function></funcdef>
  23                 <paramdef>gimage1D <parameter>image</parameter></paramdef>
  24                 <paramdef>int <parameter>P</parameter></paramdef>
  25                 <paramdef>uint <parameter>data</parameter></paramdef>
  26             </funcprototype>
  27             <funcprototype>
  28                 <funcdef>uint <function>imageAtomicXor</function></funcdef>
  29                 <paramdef>gimage2D <parameter>image</parameter></paramdef>
  30                 <paramdef>ivec2 <parameter>P</parameter></paramdef>
  31                 <paramdef>uint <parameter>data</parameter></paramdef>
  32             </funcprototype>
  33             <funcprototype>
  34                 <funcdef>uint <function>imageAtomicXor</function></funcdef>
  35                 <paramdef>gimage3D <parameter>image</parameter></paramdef>
  36                 <paramdef>ivec3 <parameter>P</parameter></paramdef>
  37                 <paramdef>uint <parameter>data</parameter></paramdef>
  38             </funcprototype>
  39             <funcprototype>
  40                 <funcdef>uint <function>imageAtomicXor</function></funcdef>
  41                 <paramdef>gimage2DRect <parameter>image</parameter></paramdef>
  42                 <paramdef>ivec2 <parameter>P</parameter></paramdef>
  43                 <paramdef>uint <parameter>data</parameter></paramdef>
  44             </funcprototype>
  45             <funcprototype>
  46                 <funcdef>uint <function>imageAtomicXor</function></funcdef>
  47                 <paramdef>gimageCube <parameter>image</parameter></paramdef>
  48                 <paramdef>ivec3 <parameter>P</parameter></paramdef>
  49                 <paramdef>uint <parameter>data</parameter></paramdef>
  50             </funcprototype>
  51             <funcprototype>
  52                 <funcdef>uint <function>imageAtomicXor</function></funcdef>
  53                 <paramdef>gbufferImage <parameter>image</parameter></paramdef>
  54                 <paramdef>int <parameter>P</parameter></paramdef>
  55                 <paramdef>uint <parameter>data</parameter></paramdef>
  56             </funcprototype>
  57             <funcprototype>
  58                 <funcdef>uint <function>imageAtomicXor</function></funcdef>
  59                 <paramdef>gimage1DArray <parameter>image</parameter></paramdef>
  60                 <paramdef>ivec2 <parameter>P</parameter></paramdef>
  61                 <paramdef>uint <parameter>data</parameter></paramdef>
  62             </funcprototype>
  63             <funcprototype>
  64                 <funcdef>uint <function>imageAtomicXor</function></funcdef>
  65                 <paramdef>gimage2DArray <parameter>image</parameter></paramdef>
  66                 <paramdef>ivec3 <parameter>P</parameter></paramdef>
  67                 <paramdef>uint <parameter>data</parameter></paramdef>
  68             </funcprototype>
  69             <funcprototype>
  70                 <funcdef>uint <function>imageAtomicXor</function></funcdef>
  71                 <paramdef>gimageCubeArray <parameter>image</parameter></paramdef>
  72                 <paramdef>ivec3 <parameter>P</parameter></paramdef>
  73                 <paramdef>uint <parameter>data</parameter></paramdef>
  74             </funcprototype>
  75             <funcprototype>
  76                 <funcdef>uint <function>imageAtomicXor</function></funcdef>
  77                 <paramdef>gimage2DMS <parameter>image</parameter></paramdef>
  78                 <paramdef>ivec2 <parameter>P</parameter></paramdef>
  79                 <paramdef>int <parameter>sample</parameter></paramdef>
  80                 <paramdef>uint <parameter>data</parameter></paramdef>
  81             </funcprototype>
  82             <funcprototype>
  83                 <funcdef>uint <function>imageAtomicXor</function></funcdef>
  84                 <paramdef>gimage2DMSArray <parameter>image</parameter></paramdef>
  85                 <paramdef>ivec3 <parameter>P</parameter></paramdef>
  86                 <paramdef>int <parameter>sample</parameter></paramdef>
  87                 <paramdef>uint <parameter>data</parameter></paramdef>
  88             </funcprototype>
  89             <funcprototype>
  90                 <funcdef>int <function>imageAtomicXor</function></funcdef>
  91                 <paramdef>gimage1D <parameter>image</parameter></paramdef>
  92                 <paramdef>int <parameter>P</parameter></paramdef>
  93                 <paramdef>int <parameter>data</parameter></paramdef>
  94             </funcprototype>
  95             <funcprototype>
  96                 <funcdef>int <function>imageAtomicXor</function></funcdef>
  97                 <paramdef>gimage2D <parameter>image</parameter></paramdef>
  98                 <paramdef>ivec2 <parameter>P</parameter></paramdef>
  99                 <paramdef>int <parameter>data</parameter></paramdef>
 100             </funcprototype>
 101             <funcprototype>
 102                 <funcdef>int <function>imageAtomicXor</function></funcdef>
 103                 <paramdef>gimage3D <parameter>image</parameter></paramdef>
 104                 <paramdef>ivec3 <parameter>P</parameter></paramdef>
 105                 <paramdef>int <parameter>data</parameter></paramdef>
 106             </funcprototype>
 107             <funcprototype>
 108                 <funcdef>int <function>imageAtomicXor</function></funcdef>
 109                 <paramdef>gimage2DRect <parameter>image</parameter></paramdef>
 110                 <paramdef>ivec2 <parameter>P</parameter></paramdef>
 111                 <paramdef>int <parameter>data</parameter></paramdef>
 112             </funcprototype>
 113             <funcprototype>
 114                 <funcdef>int <function>imageAtomicXor</function></funcdef>
 115                 <paramdef>gimageCube <parameter>image</parameter></paramdef>
 116                 <paramdef>ivec3 <parameter>P</parameter></paramdef>
 117                 <paramdef>int <parameter>data</parameter></paramdef>
 118             </funcprototype>
 119             <funcprototype>
 120                 <funcdef>int <function>imageAtomicXor</function></funcdef>
 121                 <paramdef>gbufferImage <parameter>image</parameter></paramdef>
 122                 <paramdef>int <parameter>P</parameter></paramdef>
 123                 <paramdef>int <parameter>data</parameter></paramdef>
 124             </funcprototype>
 125             <funcprototype>
 126                 <funcdef>int <function>imageAtomicXor</function></funcdef>
 127                 <paramdef>gimage1DArray <parameter>image</parameter></paramdef>
 128                 <paramdef>ivec2 <parameter>P</parameter></paramdef>
 129                 <paramdef>int <parameter>data</parameter></paramdef>
 130             </funcprototype>
 131             <funcprototype>
 132                 <funcdef>int <function>imageAtomicXor</function></funcdef>
 133                 <paramdef>gimage2DArray <parameter>image</parameter></paramdef>
 134                 <paramdef>ivec3 <parameter>P</parameter></paramdef>
 135                 <paramdef>int <parameter>data</parameter></paramdef>
 136             </funcprototype>
 137             <funcprototype>
 138                 <funcdef>int <function>imageAtomicXor</function></funcdef>
 139                 <paramdef>gimageCubeArray <parameter>image</parameter></paramdef>
 140                 <paramdef>ivec3 <parameter>P</parameter></paramdef>
 141                 <paramdef>int <parameter>data</parameter></paramdef>
 142             </funcprototype>
 143             <funcprototype>
 144                 <funcdef>int <function>imageAtomicXor</function></funcdef>
 145                 <paramdef>gimage2DMS <parameter>image</parameter></paramdef>
 146                 <paramdef>ivec2 <parameter>P</parameter></paramdef>
 147                 <paramdef>int <parameter>sample</parameter></paramdef>
 148                 <paramdef>int <parameter>data</parameter></paramdef>
 149             </funcprototype>
 150             <funcprototype>
 151                 <funcdef>int <function>imageAtomicXor</function></funcdef>
 152                 <paramdef>gimage2DMSArray <parameter>image</parameter></paramdef>
 153                 <paramdef>ivec3 <parameter>P</parameter></paramdef>
 154                 <paramdef>int <parameter>sample</parameter></paramdef>
 155                 <paramdef>int <parameter>data</parameter></paramdef>
 156             </funcprototype>
 157         </funcsynopsis>
 158     </refsynopsisdiv>
 159     <refsect1 id="parameters"><title>Parameters</title>
 160         <variablelist>
 161         <varlistentry>
 162             <term><parameter>image</parameter></term>
 163             <listitem>
 164                 <para>
 165                     Specify the image unit into which to store <parameter>data</parameter>.
 166                 </para>
 167             </listitem>
 168         </varlistentry>
 169         <varlistentry>
 170             <term><parameter>P</parameter></term>
 171             <listitem>
 172                 <para>
 173                     Specify the coordinate at which to store the data.
 174                 </para>
 175             </listitem>
 176         </varlistentry>
 177         <varlistentry>
 178             <term><parameter>sample</parameter></term>
 179             <listitem>
 180                 <para>
 181                     When present, specifies the sample within the image to store into.
 182                 </para>
 183             </listitem>
 184         </varlistentry>
 185         <varlistentry>
 186             <term><parameter>data</parameter></term>
 187             <listitem>
 188                 <para>
 189                     Specifies the data to logically XOR into the image.
 190                 </para>
 191             </listitem>
 192         </varlistentry>
 193         </variablelist>
 194     </refsect1>
 195     <refsect1 id="description"><title>Description</title>
 196         <para>
 197             <function>imageAtomicXor</function> atomically computes a new value by logically XORing the value of <parameter>data</parameter>
 198             to the contents of the texel at coordinate <parameter>P</parameter> and <parameter>sample</parameter> in the
 199             image bound to uint <parameter>image</parameter>, stores that value into the image and returns the original value.
 200         </para>
 201     </refsect1>
 202     <refsect1 id="versions"><title>Version Support</title>
 203         <informaltable frame="topbot">
 204             #VARTABLECOLS#
 205                 <thead>
 206                     #FUNCTABLEHEADER#
 207                     <row>
 208                         <entry>imageAtomicXor</entry>#newin42#
 209                     </row>
 210                 </thead>
 211             </tgroup>
 212         </informaltable>
 213     </refsect1>
 214     <refsect1 id="seealso"><title>See Also</title>
 215         <para>
 216             <citerefentry><refentrytitle>imageLoad</refentrytitle></citerefentry>,
 217             <citerefentry><refentrytitle>imageStore</refentrytitle></citerefentry>,
 218             <citerefentry><refentrytitle>imageAtomicAdd</refentrytitle></citerefentry>,
 219             <citerefentry><refentrytitle>imageAtomicMin</refentrytitle></citerefentry>,
 220             <citerefentry><refentrytitle>imageAtomicMax</refentrytitle></citerefentry>,
 221             <citerefentry><refentrytitle>imageAtomicOr</refentrytitle></citerefentry>,
 222             <citerefentry><refentrytitle>imageAtomicAnd</refentrytitle></citerefentry>,
 223             <citerefentry><refentrytitle>imageAtomicExchange</refentrytitle></citerefentry>,
 224             <citerefentry><refentrytitle>imageAtomicCompSwap</refentrytitle></citerefentry>
 225         </para>
 226     </refsect1>
 227     <refsect1 id="Copyright"><title>Copyright</title>
 228         <para>
 229             Copyright <trademark class="copyright"></trademark> 2011 Khronos Group.
 230             This material may be distributed subject to the terms and conditions set forth in
 231             the Open Publication License, v 1.0, 8 June 1999.
 232             <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
 233         </para>
 234     </refsect1>
 235 </refentry>