imageAtomicMax.xhtml

    <div class="refentry" id="imageAtomicMax">
      <div class="titlepage"></div>
      <div class="refnamediv">
        <h2>Name</h2>
        <p>imageAtomicMax — atomically compute the minimum of a value with an existing value in memory, store that value and return the original value</p>
      </div>
      <div class="refsynopsisdiv">
        <h2>Declaration</h2>
        <div class="funcsynopsis">
          <table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table">
            <tr>
              <td>
                <code class="funcdef">uint <strong class="fsfunc">imageAtomicMax</strong>(</code>
              </td>
              <td>gimage1D <var class="pdparam">image</var>, </td>
            </tr>
            <tr>
              <td> </td>
              <td>int <var class="pdparam">P</var>, </td>
            </tr>
            <tr>
              <td> </td>
              <td>uint <var class="pdparam">data</var><code>)</code>;</td>
            </tr>
          </table>
          <div class="funcprototype-spacer"> </div>
          <table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table">
            <tr>
              <td>
                <code class="funcdef">uint <strong class="fsfunc">imageAtomicMax</strong>(</code>
              </td>
              <td>gimage2D <var class="pdparam">image</var>, </td>
            </tr>
            <tr>
              <td> </td>
              <td>ivec2 <var class="pdparam">P</var>, </td>
            </tr>
            <tr>
              <td> </td>
              <td>uint <var class="pdparam">data</var><code>)</code>;</td>
            </tr>
          </table>
          <div class="funcprototype-spacer"> </div>
          <table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table">
            <tr>
              <td>
                <code class="funcdef">uint <strong class="fsfunc">imageAtomicMax</strong>(</code>
              </td>
              <td>gimage3D <var class="pdparam">image</var>, </td>
            </tr>
            <tr>
              <td> </td>
              <td>ivec3 <var class="pdparam">P</var>, </td>
            </tr>
            <tr>
              <td> </td>
              <td>uint <var class="pdparam">data</var><code>)</code>;</td>
            </tr>
          </table>
          <div class="funcprototype-spacer"> </div>
          <table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table">
            <tr>
              <td>
                <code class="funcdef">uint <strong class="fsfunc">imageAtomicMax</strong>(</code>
              </td>
              <td>gimage2DRect <var class="pdparam">image</var>, </td>
            </tr>
            <tr>
              <td> </td>
              <td>ivec2 <var class="pdparam">P</var>, </td>
            </tr>
            <tr>
              <td> </td>
              <td>uint <var class="pdparam">data</var><code>)</code>;</td>
            </tr>
          </table>
          <div class="funcprototype-spacer"> </div>
          <table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table">
            <tr>
              <td>
                <code class="funcdef">uint <strong class="fsfunc">imageAtomicMax</strong>(</code>
              </td>
              <td>gimageCube <var class="pdparam">image</var>, </td>
            </tr>
            <tr>
              <td> </td>
              <td>ivec3 <var class="pdparam">P</var>, </td>
            </tr>
            <tr>
              <td> </td>
              <td>uint <var class="pdparam">data</var><code>)</code>;</td>
            </tr>
          </table>
          <div class="funcprototype-spacer"> </div>
          <table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table">
            <tr>
              <td>
                <code class="funcdef">uint <strong class="fsfunc">imageAtomicMax</strong>(</code>
              </td>
              <td>gbufferImage <var class="pdparam">image</var>, </td>
            </tr>
            <tr>
              <td> </td>
              <td>int <var class="pdparam">P</var>, </td>
            </tr>
            <tr>
              <td> </td>
              <td>uint <var class="pdparam">data</var><code>)</code>;</td>
            </tr>
          </table>
          <div class="funcprototype-spacer"> </div>
          <table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table">
            <tr>
              <td>
                <code class="funcdef">uint <strong class="fsfunc">imageAtomicMax</strong>(</code>
              </td>
              <td>gimage1DArray <var class="pdparam">image</var>, </td>
            </tr>
            <tr>
              <td> </td>
              <td>ivec2 <var class="pdparam">P</var>, </td>
            </tr>
            <tr>
              <td> </td>
              <td>uint <var class="pdparam">data</var><code>)</code>;</td>
            </tr>
          </table>
          <div class="funcprototype-spacer"> </div>
          <table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table">
            <tr>
              <td>
                <code class="funcdef">uint <strong class="fsfunc">imageAtomicMax</strong>(</code>
              </td>
              <td>gimage2DArray <var class="pdparam">image</var>, </td>
            </tr>
            <tr>
              <td> </td>
              <td>ivec3 <var class="pdparam">P</var>, </td>
            </tr>
            <tr>
              <td> </td>
              <td>uint <var class="pdparam">data</var><code>)</code>;</td>
            </tr>
          </table>
          <div class="funcprototype-spacer"> </div>
          <table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table">
            <tr>
              <td>
                <code class="funcdef">uint <strong class="fsfunc">imageAtomicMax</strong>(</code>
              </td>
              <td>gimageCubeArray <var class="pdparam">image</var>, </td>
            </tr>
            <tr>
              <td> </td>
              <td>ivec3 <var class="pdparam">P</var>, </td>
            </tr>
            <tr>
              <td> </td>
              <td>uint <var class="pdparam">data</var><code>)</code>;</td>
            </tr>
          </table>
          <div class="funcprototype-spacer"> </div>
          <table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table">
            <tr>
              <td>
                <code class="funcdef">uint <strong class="fsfunc">imageAtomicMax</strong>(</code>
              </td>
              <td>gimage2DMS <var class="pdparam">image</var>, </td>
            </tr>
            <tr>
              <td> </td>
              <td>ivec2 <var class="pdparam">P</var>, </td>
            </tr>
            <tr>
              <td> </td>
              <td>int <var class="pdparam">sample</var>, </td>
            </tr>
            <tr>
              <td> </td>
              <td>uint <var class="pdparam">data</var><code>)</code>;</td>
            </tr>
          </table>
          <div class="funcprototype-spacer"> </div>
          <table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table">
            <tr>
              <td>
                <code class="funcdef">uint <strong class="fsfunc">imageAtomicMax</strong>(</code>
              </td>
              <td>gimage2DMSArray <var class="pdparam">image</var>, </td>
            </tr>
            <tr>
              <td> </td>
              <td>ivec3 <var class="pdparam">P</var>, </td>
            </tr>
            <tr>
              <td> </td>
              <td>int <var class="pdparam">sample</var>, </td>
            </tr>
            <tr>
              <td> </td>
              <td>uint <var class="pdparam">data</var><code>)</code>;</td>
            </tr>
          </table>
          <div class="funcprototype-spacer"> </div>
          <table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table">
            <tr>
              <td>
                <code class="funcdef">int <strong class="fsfunc">imageAtomicMax</strong>(</code>
              </td>
              <td>gimage1D <var class="pdparam">image</var>, </td>
            </tr>
            <tr>
              <td> </td>
              <td>int <var class="pdparam">P</var>, </td>
            </tr>
            <tr>
              <td> </td>
              <td>int <var class="pdparam">data</var><code>)</code>;</td>
            </tr>
          </table>
          <div class="funcprototype-spacer"> </div>
          <table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table">
            <tr>
              <td>
                <code class="funcdef">int <strong class="fsfunc">imageAtomicMax</strong>(</code>
              </td>
              <td>gimage2D <var class="pdparam">image</var>, </td>
            </tr>
            <tr>
              <td> </td>
              <td>ivec2 <var class="pdparam">P</var>, </td>
            </tr>
            <tr>
              <td> </td>
              <td>int <var class="pdparam">data</var><code>)</code>;</td>
            </tr>
          </table>
          <div class="funcprototype-spacer"> </div>
          <table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table">
            <tr>
              <td>
                <code class="funcdef">int <strong class="fsfunc">imageAtomicMax</strong>(</code>
              </td>
              <td>gimage3D <var class="pdparam">image</var>, </td>
            </tr>
            <tr>
              <td> </td>
              <td>ivec3 <var class="pdparam">P</var>, </td>
            </tr>
            <tr>
              <td> </td>
              <td>int <var class="pdparam">data</var><code>)</code>;</td>
            </tr>
          </table>
          <div class="funcprototype-spacer"> </div>
          <table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table">
            <tr>
              <td>
                <code class="funcdef">int <strong class="fsfunc">imageAtomicMax</strong>(</code>
              </td>
              <td>gimage2DRect <var class="pdparam">image</var>, </td>
            </tr>
            <tr>
              <td> </td>
              <td>ivec2 <var class="pdparam">P</var>, </td>
            </tr>
            <tr>
              <td> </td>
              <td>int <var class="pdparam">data</var><code>)</code>;</td>
            </tr>
          </table>
          <div class="funcprototype-spacer"> </div>
          <table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table">
            <tr>
              <td>
                <code class="funcdef">int <strong class="fsfunc">imageAtomicMax</strong>(</code>
              </td>
              <td>gimageCube <var class="pdparam">image</var>, </td>
            </tr>
            <tr>
              <td> </td>
              <td>ivec3 <var class="pdparam">P</var>, </td>
            </tr>
            <tr>
              <td> </td>
              <td>int <var class="pdparam">data</var><code>)</code>;</td>
            </tr>
          </table>
          <div class="funcprototype-spacer"> </div>
          <table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table">
            <tr>
              <td>
                <code class="funcdef">int <strong class="fsfunc">imageAtomicMax</strong>(</code>
              </td>
              <td>gbufferImage <var class="pdparam">image</var>, </td>
            </tr>
            <tr>
              <td> </td>
              <td>int <var class="pdparam">P</var>, </td>
            </tr>
            <tr>
              <td> </td>
              <td>int <var class="pdparam">data</var><code>)</code>;</td>
            </tr>
          </table>
          <div class="funcprototype-spacer"> </div>
          <table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table">
            <tr>
              <td>
                <code class="funcdef">int <strong class="fsfunc">imageAtomicMax</strong>(</code>
              </td>
              <td>gimage1DArray <var class="pdparam">image</var>, </td>
            </tr>
            <tr>
              <td> </td>
              <td>ivec2 <var class="pdparam">P</var>, </td>
            </tr>
            <tr>
              <td> </td>
              <td>int <var class="pdparam">data</var><code>)</code>;</td>
            </tr>
          </table>
          <div class="funcprototype-spacer"> </div>
          <table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table">
            <tr>
              <td>
                <code class="funcdef">int <strong class="fsfunc">imageAtomicMax</strong>(</code>
              </td>
              <td>gimage2DArray <var class="pdparam">image</var>, </td>
            </tr>
            <tr>
              <td> </td>
              <td>ivec3 <var class="pdparam">P</var>, </td>
            </tr>
            <tr>
              <td> </td>
              <td>int <var class="pdparam">data</var><code>)</code>;</td>
            </tr>
          </table>
          <div class="funcprototype-spacer"> </div>
          <table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table">
            <tr>
              <td>
                <code class="funcdef">int <strong class="fsfunc">imageAtomicMax</strong>(</code>
              </td>
              <td>gimageCubeArray <var class="pdparam">image</var>, </td>
            </tr>
            <tr>
              <td> </td>
              <td>ivec3 <var class="pdparam">P</var>, </td>
            </tr>
            <tr>
              <td> </td>
              <td>int <var class="pdparam">data</var><code>)</code>;</td>
            </tr>
          </table>
          <div class="funcprototype-spacer"> </div>
          <table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table">
            <tr>
              <td>
                <code class="funcdef">int <strong class="fsfunc">imageAtomicMax</strong>(</code>
              </td>
              <td>gimage2DMS <var class="pdparam">image</var>, </td>
            </tr>
            <tr>
              <td> </td>
              <td>ivec2 <var class="pdparam">P</var>, </td>
            </tr>
            <tr>
              <td> </td>
              <td>int <var class="pdparam">sample</var>, </td>
            </tr>
            <tr>
              <td> </td>
              <td>int <var class="pdparam">data</var><code>)</code>;</td>
            </tr>
          </table>
          <div class="funcprototype-spacer"> </div>
          <table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table">
            <tr>
              <td>
                <code class="funcdef">int <strong class="fsfunc">imageAtomicMax</strong>(</code>
              </td>
              <td>gimage2DMSArray <var class="pdparam">image</var>, </td>
            </tr>
            <tr>
              <td> </td>
              <td>ivec3 <var class="pdparam">P</var>, </td>
            </tr>
            <tr>
              <td> </td>
              <td>int <var class="pdparam">sample</var>, </td>
            </tr>
            <tr>
              <td> </td>
              <td>int <var class="pdparam">data</var><code>)</code>;</td>
            </tr>
          </table>
          <div class="funcprototype-spacer"> </div>
        </div>
      </div>
      <div class="refsect1" id="parameters">
        <h2>Parameters</h2>
        <div class="variablelist">
          <dl class="variablelist">
            <dt>
              <span class="term">
                <em class="parameter">
                  <code>image</code>
                </em>
              </span>
            </dt>
            <dd>
              <p>
                    Specify the image unit into which to store <em class="parameter"><code>data</code></em>.
                </p>
            </dd>
            <dt>
              <span class="term">
                <em class="parameter">
                  <code>P</code>
                </em>
              </span>
            </dt>
            <dd>
              <p>
                    Specify the coordinate at which to store the data.
                </p>
            </dd>
            <dt>
              <span class="term">
                <em class="parameter">
                  <code>sample</code>
                </em>
              </span>
            </dt>
            <dd>
              <p>
                    When present, specifies the sample within the image to store into.
                </p>
            </dd>
            <dt>
              <span class="term">
                <em class="parameter">
                  <code>data</code>
                </em>
              </span>
            </dt>
            <dd>
              <p>
                    Specifies the data of which to take the minimum with that stored in the image.
                </p>
            </dd>
          </dl>
        </div>
      </div>
      <div class="refsect1" id="description">
        <h2>Description</h2>
        <p>
            <code class="function">imageAtomicMax</code> atomically computes a new value by finding the maximum of the value of <em class="parameter"><code>data</code></em>
            and the contents of the texel at coordinate <em class="parameter"><code>P</code></em> and <em class="parameter"><code>sample</code></em> in the
            image bound to uint <em class="parameter"><code>image</code></em>, stores that value into the image and returns the original value.
        </p>
      </div>
      {$pipelinestall}{$examples}
      <div class="refsect1" id="versions">
        <h2>Version Support</h2>
        <div class="informaltable">
          <table style="border-collapse: collapse; border-top: 2px solid ; border-bottom: 2px solid ; border-left: 2px solid ; border-right: 2px solid ; ">
            <colgroup>
              <col style="text-align: left; "/>
              <col style="text-align: center; " class="firstvers"/>
              <col style="text-align: center; "/>
              <col style="text-align: center; "/>
              <col style="text-align: center; "/>
              <col style="text-align: center; "/>
              <col style="text-align: center; "/>
              <col style="text-align: center; "/>
              <col style="text-align: center; "/>
              <col style="text-align: center; "/>
              <col style="text-align: center; "/>
              <col style="text-align: center; "/>
              <col style="text-align: center; " class="lastvers"/>
            </colgroup>
            <thead>
              <tr>
                <th style="text-align: left; border-right: 2px solid ; ">

            </th>
                <th style="text-align: center; border-bottom: 2px solid ; " colspan="12">
                <span class="bold"><strong>OpenGL Shading Language Version</strong></span>
            </th>
              </tr>
              <tr>
                <th style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">
                <span class="bold"><strong>Function Name</strong></span>
            </th>
                <th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
                <span class="bold"><strong>1.10</strong></span>
            </th>
                <th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
                <span class="bold"><strong>1.20</strong></span>
            </th>
                <th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
                <span class="bold"><strong>1.30</strong></span>
            </th>
                <th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
                <span class="bold"><strong>1.40</strong></span>
            </th>
                <th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
                <span class="bold"><strong>1.50</strong></span>
            </th>
                <th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
                <span class="bold"><strong>3.30</strong></span>
            </th>
                <th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
                <span class="bold"><strong>4.00</strong></span>
            </th>
                <th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
                <span class="bold"><strong>4.10</strong></span>
            </th>
                <th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
                <span class="bold"><strong>4.20</strong></span>
            </th>
                <th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
                <span class="bold"><strong>4.30</strong></span>
            </th>
                <th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
                <span class="bold"><strong>4.40</strong></span>
            </th>
                <th style="text-align: center; border-bottom: 2px solid ; ">
                <span class="bold"><strong>4.50</strong></span>
            </th>
              </tr>
            </thead>
            <tbody>
              <tr>
                <td style="text-align: left; border-right: 2px solid ; ">imageAtomicMax</td>
                <td style="text-align: center; border-right: 2px solid ; ">-</td>
                <td style="text-align: center; border-right: 2px solid ; ">-</td>
                <td style="text-align: center; border-right: 2px solid ; ">-</td>
                <td style="text-align: center; border-right: 2px solid ; ">-</td>
                <td style="text-align: center; border-right: 2px solid ; ">-</td>
                <td style="text-align: center; border-right: 2px solid ; ">-</td>
                <td style="text-align: center; border-right: 2px solid ; ">-</td>
                <td style="text-align: center; border-right: 2px solid ; ">-</td>
                <td style="text-align: center; border-right: 2px solid ; ">✔</td>
                <td style="text-align: center; border-right: 2px solid ; ">✔</td>
                <td style="text-align: center; border-right: 2px solid ; ">✔</td>
                <td style="text-align: center; ">✔</td>
              </tr>
            </tbody>
          </table>
        </div>
      </div>
      <div class="refsect1" id="seealso">
        <h2>See Also</h2>
        <p>
            <a class="citerefentry" href="imageLoad"><span class="citerefentry"><span class="refentrytitle">imageLoad</span></span></a>,
            <a class="citerefentry" href="imageStore"><span class="citerefentry"><span class="refentrytitle">imageStore</span></span></a>,
            <a class="citerefentry" href="imageAtomicAdd"><span class="citerefentry"><span class="refentrytitle">imageAtomicAdd</span></span></a>,
            <a class="citerefentry" href="imageAtomicMin"><span class="citerefentry"><span class="refentrytitle">imageAtomicMin</span></span></a>,
            <a class="citerefentry" href="imageAtomicXor"><span class="citerefentry"><span class="refentrytitle">imageAtomicXor</span></span></a>,
            <a class="citerefentry" href="imageAtomicOr"><span class="citerefentry"><span class="refentrytitle">imageAtomicOr</span></span></a>,
            <a class="citerefentry" href="imageAtomicAnd"><span class="citerefentry"><span class="refentrytitle">imageAtomicAnd</span></span></a>,
            <a class="citerefentry" href="imageAtomicExchange"><span class="citerefentry"><span class="refentrytitle">imageAtomicExchange</span></span></a>,
            <a class="citerefentry" href="imageAtomicCompSwap"><span class="citerefentry"><span class="refentrytitle">imageAtomicCompSwap</span></span></a>
        </p>
      </div>
      <div class="refsect1" id="Copyright">
        <h2>Copyright</h2>
        <p>
            Copyright © 2011-2014 Khronos Group.
            This material may be distributed subject to the terms and conditions set forth in
            the Open Publication License, v 1.0, 8 June 1999.
            <a class="link" href="https://opencontent.org/openpub/" target="_top">https://opencontent.org/openpub/</a>.
        </p>
      </div>
    </div>