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=
"imageAtomicMax">
9 <holder>Khronos Group
</holder>
12 <refentrytitle>imageAtomicMax
</refentrytitle>
13 <manvolnum>3G
</manvolnum>
16 <refname>imageAtomicMax
</refname>
17 <refpurpose>atomically compute the minimum of a value with an existing value in memory, store that value and return the original value
</refpurpose>
19 <refsynopsisdiv><title>Declaration
</title>
22 <funcdef>uint
<function>imageAtomicMax
</function></funcdef>
23 <paramdef>gimage1D
<parameter>image
</parameter></paramdef>
24 <paramdef>int
<parameter>P
</parameter></paramdef>
25 <paramdef>uint
<parameter>data
</parameter></paramdef>
28 <funcdef>uint
<function>imageAtomicMax
</function></funcdef>
29 <paramdef>gimage2D
<parameter>image
</parameter></paramdef>
30 <paramdef>ivec2
<parameter>P
</parameter></paramdef>
31 <paramdef>uint
<parameter>data
</parameter></paramdef>
34 <funcdef>uint
<function>imageAtomicMax
</function></funcdef>
35 <paramdef>gimage3D
<parameter>image
</parameter></paramdef>
36 <paramdef>ivec3
<parameter>P
</parameter></paramdef>
37 <paramdef>uint
<parameter>data
</parameter></paramdef>
40 <funcdef>uint
<function>imageAtomicMax
</function></funcdef>
41 <paramdef>gimage2DRect
<parameter>image
</parameter></paramdef>
42 <paramdef>ivec2
<parameter>P
</parameter></paramdef>
43 <paramdef>uint
<parameter>data
</parameter></paramdef>
46 <funcdef>uint
<function>imageAtomicMax
</function></funcdef>
47 <paramdef>gimageCube
<parameter>image
</parameter></paramdef>
48 <paramdef>ivec3
<parameter>P
</parameter></paramdef>
49 <paramdef>uint
<parameter>data
</parameter></paramdef>
52 <funcdef>uint
<function>imageAtomicMax
</function></funcdef>
53 <paramdef>gbufferImage
<parameter>image
</parameter></paramdef>
54 <paramdef>int
<parameter>P
</parameter></paramdef>
55 <paramdef>uint
<parameter>data
</parameter></paramdef>
58 <funcdef>uint
<function>imageAtomicMax
</function></funcdef>
59 <paramdef>gimage1DArray
<parameter>image
</parameter></paramdef>
60 <paramdef>ivec2
<parameter>P
</parameter></paramdef>
61 <paramdef>uint
<parameter>data
</parameter></paramdef>
64 <funcdef>uint
<function>imageAtomicMax
</function></funcdef>
65 <paramdef>gimage2DArray
<parameter>image
</parameter></paramdef>
66 <paramdef>ivec3
<parameter>P
</parameter></paramdef>
67 <paramdef>uint
<parameter>data
</parameter></paramdef>
70 <funcdef>uint
<function>imageAtomicMax
</function></funcdef>
71 <paramdef>gimageCubeArray
<parameter>image
</parameter></paramdef>
72 <paramdef>ivec3
<parameter>P
</parameter></paramdef>
73 <paramdef>uint
<parameter>data
</parameter></paramdef>
76 <funcdef>uint
<function>imageAtomicMax
</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>
83 <funcdef>uint
<function>imageAtomicMax
</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>
90 <funcdef>int
<function>imageAtomicMax
</function></funcdef>
91 <paramdef>gimage1D
<parameter>image
</parameter></paramdef>
92 <paramdef>int
<parameter>P
</parameter></paramdef>
93 <paramdef>int
<parameter>data
</parameter></paramdef>
96 <funcdef>int
<function>imageAtomicMax
</function></funcdef>
97 <paramdef>gimage2D
<parameter>image
</parameter></paramdef>
98 <paramdef>ivec2
<parameter>P
</parameter></paramdef>
99 <paramdef>int
<parameter>data
</parameter></paramdef>
102 <funcdef>int
<function>imageAtomicMax
</function></funcdef>
103 <paramdef>gimage3D
<parameter>image
</parameter></paramdef>
104 <paramdef>ivec3
<parameter>P
</parameter></paramdef>
105 <paramdef>int
<parameter>data
</parameter></paramdef>
108 <funcdef>int
<function>imageAtomicMax
</function></funcdef>
109 <paramdef>gimage2DRect
<parameter>image
</parameter></paramdef>
110 <paramdef>ivec2
<parameter>P
</parameter></paramdef>
111 <paramdef>int
<parameter>data
</parameter></paramdef>
114 <funcdef>int
<function>imageAtomicMax
</function></funcdef>
115 <paramdef>gimageCube
<parameter>image
</parameter></paramdef>
116 <paramdef>ivec3
<parameter>P
</parameter></paramdef>
117 <paramdef>int
<parameter>data
</parameter></paramdef>
120 <funcdef>int
<function>imageAtomicMax
</function></funcdef>
121 <paramdef>gbufferImage
<parameter>image
</parameter></paramdef>
122 <paramdef>int
<parameter>P
</parameter></paramdef>
123 <paramdef>int
<parameter>data
</parameter></paramdef>
126 <funcdef>int
<function>imageAtomicMax
</function></funcdef>
127 <paramdef>gimage1DArray
<parameter>image
</parameter></paramdef>
128 <paramdef>ivec2
<parameter>P
</parameter></paramdef>
129 <paramdef>int
<parameter>data
</parameter></paramdef>
132 <funcdef>int
<function>imageAtomicMax
</function></funcdef>
133 <paramdef>gimage2DArray
<parameter>image
</parameter></paramdef>
134 <paramdef>ivec3
<parameter>P
</parameter></paramdef>
135 <paramdef>int
<parameter>data
</parameter></paramdef>
138 <funcdef>int
<function>imageAtomicMax
</function></funcdef>
139 <paramdef>gimageCubeArray
<parameter>image
</parameter></paramdef>
140 <paramdef>ivec3
<parameter>P
</parameter></paramdef>
141 <paramdef>int
<parameter>data
</parameter></paramdef>
144 <funcdef>int
<function>imageAtomicMax
</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>
151 <funcdef>int
<function>imageAtomicMax
</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>
159 <refsect1 id=
"parameters"><title>Parameters
</title>
162 <term><parameter>image
</parameter></term>
165 Specify the image unit into which to store
<parameter>data
</parameter>.
170 <term><parameter>P
</parameter></term>
173 Specify the coordinate at which to store the data.
178 <term><parameter>sample
</parameter></term>
181 When present, specifies the sample within the image to store into.
186 <term><parameter>data
</parameter></term>
189 Specifies the data of which to take the minimum with that stored in the image.
195 <refsect1 id=
"description"><title>Description
</title>
197 <function>imageAtomicMax
</function> atomically computes a new value by finding the maximum of the value of
<parameter>data
</parameter>
198 and 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.
202 <refsect1 id=
"versions"><title>Version Support
</title>
203 <informaltable frame=
"topbot">
208 <entry>imageAtomicMax
</entry>#newin42#
214 <refsect1 id=
"seealso"><title>See Also
</title>
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>imageAtomicXor
</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>
227 <refsect1 id=
"Copyright"><title>Copyright
</title>
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>.