+++ /dev/null
-<?xml version="1.0" encoding="UTF-8"?>\r
-<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"\r
- "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">\r
-<refentry id="imageAtomicAnd">\r
- <refmeta>\r
- <refmetainfo>\r
- <copyright>\r
- <year>2011</year>\r
- <holder>Khronos Group</holder>\r
- </copyright>\r
- </refmetainfo>\r
- <refentrytitle>imageAtomicAnd</refentrytitle>\r
- <manvolnum>3G</manvolnum>\r
- </refmeta>\r
- <refnamediv>\r
- <refname>imageAtomicAnd</refname>\r
- <refpurpose>atomically compute the logical AND of a value with an existing value in memory, store that value and return the original value</refpurpose>\r
- </refnamediv>\r
- <refsynopsisdiv><title>Declaration</title>\r
- <funcsynopsis>\r
- <funcprototype>\r
- <funcdef>uint <function>imageAtomicAnd</function></funcdef>\r
- <paramdef>gimage1D <parameter>image</parameter></paramdef>\r
- <paramdef>int <parameter>P</parameter></paramdef>\r
- <paramdef>uint <parameter>data</parameter></paramdef>\r
- </funcprototype>\r
- <funcprototype>\r
- <funcdef>uint <function>imageAtomicAnd</function></funcdef>\r
- <paramdef>gimage2D <parameter>image</parameter></paramdef>\r
- <paramdef>ivec2 <parameter>P</parameter></paramdef>\r
- <paramdef>uint <parameter>data</parameter></paramdef>\r
- </funcprototype>\r
- <funcprototype>\r
- <funcdef>uint <function>imageAtomicAnd</function></funcdef>\r
- <paramdef>gimage3D <parameter>image</parameter></paramdef>\r
- <paramdef>ivec3 <parameter>P</parameter></paramdef>\r
- <paramdef>uint <parameter>data</parameter></paramdef>\r
- </funcprototype>\r
- <funcprototype>\r
- <funcdef>uint <function>imageAtomicAnd</function></funcdef>\r
- <paramdef>gimage2DRect <parameter>image</parameter></paramdef>\r
- <paramdef>ivec2 <parameter>P</parameter></paramdef>\r
- <paramdef>uint <parameter>data</parameter></paramdef>\r
- </funcprototype>\r
- <funcprototype>\r
- <funcdef>uint <function>imageAtomicAnd</function></funcdef>\r
- <paramdef>gimageCube <parameter>image</parameter></paramdef>\r
- <paramdef>ivec3 <parameter>P</parameter></paramdef>\r
- <paramdef>uint <parameter>data</parameter></paramdef>\r
- </funcprototype>\r
- <funcprototype>\r
- <funcdef>uint <function>imageAtomicAnd</function></funcdef>\r
- <paramdef>gbufferImage <parameter>image</parameter></paramdef>\r
- <paramdef>int <parameter>P</parameter></paramdef>\r
- <paramdef>uint <parameter>data</parameter></paramdef>\r
- </funcprototype>\r
- <funcprototype>\r
- <funcdef>uint <function>imageAtomicAnd</function></funcdef>\r
- <paramdef>gimage1DArray <parameter>image</parameter></paramdef>\r
- <paramdef>ivec2 <parameter>P</parameter></paramdef>\r
- <paramdef>uint <parameter>data</parameter></paramdef>\r
- </funcprototype>\r
- <funcprototype>\r
- <funcdef>uint <function>imageAtomicAnd</function></funcdef>\r
- <paramdef>gimage2DArray <parameter>image</parameter></paramdef>\r
- <paramdef>ivec3 <parameter>P</parameter></paramdef>\r
- <paramdef>uint <parameter>data</parameter></paramdef>\r
- </funcprototype>\r
- <funcprototype>\r
- <funcdef>uint <function>imageAtomicAnd</function></funcdef>\r
- <paramdef>gimageCubeArray <parameter>image</parameter></paramdef>\r
- <paramdef>ivec3 <parameter>P</parameter></paramdef>\r
- <paramdef>uint <parameter>data</parameter></paramdef>\r
- </funcprototype>\r
- <funcprototype>\r
- <funcdef>uint <function>imageAtomicAnd</function></funcdef>\r
- <paramdef>gimage2DMS <parameter>image</parameter></paramdef>\r
- <paramdef>ivec2 <parameter>P</parameter></paramdef>\r
- <paramdef>int <parameter>sample</parameter></paramdef>\r
- <paramdef>uint <parameter>data</parameter></paramdef>\r
- </funcprototype>\r
- <funcprototype>\r
- <funcdef>uint <function>imageAtomicAnd</function></funcdef>\r
- <paramdef>gimage2DMSArray <parameter>image</parameter></paramdef>\r
- <paramdef>ivec3 <parameter>P</parameter></paramdef>\r
- <paramdef>int <parameter>sample</parameter></paramdef>\r
- <paramdef>uint <parameter>data</parameter></paramdef>\r
- </funcprototype>\r
- <funcprototype>\r
- <funcdef>int <function>imageAtomicAnd</function></funcdef>\r
- <paramdef>gimage1D <parameter>image</parameter></paramdef>\r
- <paramdef>int <parameter>P</parameter></paramdef>\r
- <paramdef>int <parameter>data</parameter></paramdef>\r
- </funcprototype>\r
- <funcprototype>\r
- <funcdef>int <function>imageAtomicAnd</function></funcdef>\r
- <paramdef>gimage2D <parameter>image</parameter></paramdef>\r
- <paramdef>ivec2 <parameter>P</parameter></paramdef>\r
- <paramdef>int <parameter>data</parameter></paramdef>\r
- </funcprototype>\r
- <funcprototype>\r
- <funcdef>int <function>imageAtomicAnd</function></funcdef>\r
- <paramdef>gimage3D <parameter>image</parameter></paramdef>\r
- <paramdef>ivec3 <parameter>P</parameter></paramdef>\r
- <paramdef>int <parameter>data</parameter></paramdef>\r
- </funcprototype>\r
- <funcprototype>\r
- <funcdef>int <function>imageAtomicAnd</function></funcdef>\r
- <paramdef>gimage2DRect <parameter>image</parameter></paramdef>\r
- <paramdef>ivec2 <parameter>P</parameter></paramdef>\r
- <paramdef>int <parameter>data</parameter></paramdef>\r
- </funcprototype>\r
- <funcprototype>\r
- <funcdef>int <function>imageAtomicAnd</function></funcdef>\r
- <paramdef>gimageCube <parameter>image</parameter></paramdef>\r
- <paramdef>ivec3 <parameter>P</parameter></paramdef>\r
- <paramdef>int <parameter>data</parameter></paramdef>\r
- </funcprototype>\r
- <funcprototype>\r
- <funcdef>int <function>imageAtomicAnd</function></funcdef>\r
- <paramdef>gbufferImage <parameter>image</parameter></paramdef>\r
- <paramdef>int <parameter>P</parameter></paramdef>\r
- <paramdef>int <parameter>data</parameter></paramdef>\r
- </funcprototype>\r
- <funcprototype>\r
- <funcdef>int <function>imageAtomicAnd</function></funcdef>\r
- <paramdef>gimage1DArray <parameter>image</parameter></paramdef>\r
- <paramdef>ivec2 <parameter>P</parameter></paramdef>\r
- <paramdef>int <parameter>data</parameter></paramdef>\r
- </funcprototype>\r
- <funcprototype>\r
- <funcdef>int <function>imageAtomicAnd</function></funcdef>\r
- <paramdef>gimage2DArray <parameter>image</parameter></paramdef>\r
- <paramdef>ivec3 <parameter>P</parameter></paramdef>\r
- <paramdef>int <parameter>data</parameter></paramdef>\r
- </funcprototype>\r
- <funcprototype>\r
- <funcdef>int <function>imageAtomicAnd</function></funcdef>\r
- <paramdef>gimageCubeArray <parameter>image</parameter></paramdef>\r
- <paramdef>ivec3 <parameter>P</parameter></paramdef>\r
- <paramdef>int <parameter>data</parameter></paramdef>\r
- </funcprototype>\r
- <funcprototype>\r
- <funcdef>int <function>imageAtomicAnd</function></funcdef>\r
- <paramdef>gimage2DMS <parameter>image</parameter></paramdef>\r
- <paramdef>ivec2 <parameter>P</parameter></paramdef>\r
- <paramdef>int <parameter>sample</parameter></paramdef>\r
- <paramdef>int <parameter>data</parameter></paramdef>\r
- </funcprototype>\r
- <funcprototype>\r
- <funcdef>int <function>imageAtomicAnd</function></funcdef>\r
- <paramdef>gimage2DMSArray <parameter>image</parameter></paramdef>\r
- <paramdef>ivec3 <parameter>P</parameter></paramdef>\r
- <paramdef>int <parameter>sample</parameter></paramdef>\r
- <paramdef>int <parameter>data</parameter></paramdef>\r
- </funcprototype>\r
- </funcsynopsis>\r
- </refsynopsisdiv>\r
- <refsect1 id="parameters"><title>Parameters</title>\r
- <variablelist>\r
- <varlistentry>\r
- <term><parameter>image</parameter></term>\r
- <listitem>\r
- <para>\r
- Specify the image unit into which to store <parameter>data</parameter>.\r
- </para>\r
- </listitem>\r
- </varlistentry>\r
- <varlistentry>\r
- <term><parameter>P</parameter></term>\r
- <listitem>\r
- <para>\r
- Specify the coordinate at which to store the data.\r
- </para>\r
- </listitem>\r
- </varlistentry>\r
- <varlistentry>\r
- <term><parameter>sample</parameter></term>\r
- <listitem>\r
- <para>\r
- When present, specifies the sample within the image to store into.\r
- </para>\r
- </listitem>\r
- </varlistentry>\r
- <varlistentry>\r
- <term><parameter>data</parameter></term>\r
- <listitem>\r
- <para>\r
- Specifies the data to logically AND into the image.\r
- </para>\r
- </listitem>\r
- </varlistentry>\r
- </variablelist>\r
- </refsect1>\r
- <refsect1 id="description"><title>Description</title>\r
- <para>\r
- <function>imageAtomicAnd</function> atomically computes a new value by logically ANDing the value of <parameter>data</parameter>\r
- to the contents of the texel at coordinate <parameter>P</parameter> and <parameter>sample</parameter> in the\r
- image bound to uint <parameter>image</parameter>, stores that value into the image and returns the original value.\r
- </para>\r
- </refsect1>\r
- <refsect1 id="versions"><title>Version Support</title>\r
- <informaltable frame="topbot">\r
- #VARTABLECOLS#\r
- <thead>\r
- #FUNCTABLEHEADER#\r
- <row>\r
- <entry>imageAtomicAnd</entry>#newin42#\r
- </row>\r
- </thead>\r
- </tgroup>\r
- </informaltable>\r
- </refsect1>\r
- <refsect1 id="seealso"><title>See Also</title>\r
- <para>\r
- <citerefentry><refentrytitle>imageLoad</refentrytitle></citerefentry>,\r
- <citerefentry><refentrytitle>imageStore</refentrytitle></citerefentry>,\r
- <citerefentry><refentrytitle>imageAtomicAdd</refentrytitle></citerefentry>,\r
- <citerefentry><refentrytitle>imageAtomicMin</refentrytitle></citerefentry>,\r
- <citerefentry><refentrytitle>imageAtomicMax</refentrytitle></citerefentry>,\r
- <citerefentry><refentrytitle>imageAtomicOr</refentrytitle></citerefentry>,\r
- <citerefentry><refentrytitle>imageAtomicXor</refentrytitle></citerefentry>,\r
- <citerefentry><refentrytitle>imageAtomicExchange</refentrytitle></citerefentry>,\r
- <citerefentry><refentrytitle>imageAtomicCompSwap</refentrytitle></citerefentry>\r
- </para>\r
- </refsect1>\r
- <refsect1 id="Copyright"><title>Copyright</title>\r
- <para>\r
- Copyright <trademark class="copyright"></trademark> 2011 Khronos Group. \r
- This material may be distributed subject to the terms and conditions set forth in \r
- the Open Publication License, v 1.0, 8 June 1999.\r
- <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.\r
- </para>\r
- </refsect1>\r
-</refentry>\r