upstream-man-pages/manglsl/max.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="max">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>2011</year>
   9                 <holder>Khronos Group</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>max</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>max</refname>
  17         <refpurpose>return the greater of two values</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>Declaration</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>genType <function>max</function></funcdef>
  23                 <paramdef>genType <parameter>x</parameter></paramdef>
  24                 <paramdef>genType <parameter>y</parameter></paramdef>
  25             </funcprototype>
  26         </funcsynopsis>
  27         <funcsynopsis>
  28             <funcprototype>
  29                 <funcdef>genType <function>max</function></funcdef>
  30                 <paramdef>genType <parameter>x</parameter></paramdef>
  31                 <paramdef>float <parameter>y</parameter></paramdef>
  32             </funcprototype>
  33         </funcsynopsis>
  34         <funcsynopsis>
  35             <funcprototype>
  36                 <funcdef>genDType <function>max</function></funcdef>
  37                 <paramdef>genDType <parameter>x</parameter></paramdef>
  38                 <paramdef>genDType <parameter>y</parameter></paramdef>
  39             </funcprototype>
  40         </funcsynopsis>
  41         <funcsynopsis>
  42             <funcprototype>
  43                 <funcdef>genDType <function>max</function></funcdef>
  44                 <paramdef>genDType <parameter>x</parameter></paramdef>
  45                 <paramdef>double <parameter>y</parameter></paramdef>
  46             </funcprototype>
  47         </funcsynopsis>
  48         <funcsynopsis>
  49             <funcprototype>
  50                 <funcdef>genIType <function>max</function></funcdef>
  51                 <paramdef>genIType <parameter>x</parameter></paramdef>
  52                 <paramdef>genIType <parameter>y</parameter></paramdef>
  53             </funcprototype>
  54         </funcsynopsis>
  55         <funcsynopsis>
  56             <funcprototype>
  57                 <funcdef>genIType <function>max</function></funcdef>
  58                 <paramdef>genIType <parameter>x</parameter></paramdef>
  59                 <paramdef>int <parameter>y</parameter></paramdef>
  60             </funcprototype>
  61         </funcsynopsis>
  62         <funcsynopsis>
  63             <funcprototype>
  64                 <funcdef>genUType <function>max</function></funcdef>
  65                 <paramdef>genUType <parameter>x</parameter></paramdef>
  66                 <paramdef>genUType <parameter>y</parameter></paramdef>
  67             </funcprototype>
  68         </funcsynopsis>
  69         <funcsynopsis>
  70             <funcprototype>
  71                 <funcdef>genUType <function>max</function></funcdef>
  72                 <paramdef>genUType <parameter>x</parameter></paramdef>
  73                 <paramdef>uint <parameter>y</parameter></paramdef>
  74             </funcprototype>
  75         </funcsynopsis>
  76     </refsynopsisdiv>
  77     <refsect1 id="parameters"><title>Parameters</title>
  78         <variablelist>
  79         <varlistentry>
  80             <term><parameter>x</parameter></term>
  81             <listitem>
  82                 <para>
  83                     Specify the first value to compare.
  84                 </para>
  85             </listitem>
  86         </varlistentry>
  87         <varlistentry>
  88             <term><parameter>y</parameter></term>
  89             <listitem>
  90                 <para>
  91                     Specify the second value to compare.
  92                 </para>
  93             </listitem>
  94         </varlistentry>
  95         </variablelist>
  96     </refsect1>
  97     <refsect1 id="description"><title>Description</title>
  98         <para>
  99             <function>max</function> returns the maximum of the two parameters. It
 100             returns <parameter>y</parameter> if <parameter>y</parameter> is greater than
 101             <parameter>x</parameter>, otherwise it returns <parameter>x</parameter>.
 102         </para>
 103     </refsect1>
 104     <refsect1 id="versions"><title>Version Support</title>
 105         <informaltable frame="topbot">
 106             #VARTABLECOLS#
 107                 <thead>
 108                     #FUNCTABLEHEADER#
 109                     <row>
 110                         <entry>max (genType)</entry>#newin11#
 111                     </row>
 112                     <row>
 113                         <entry>max (genIType)</entry>#newin13#
 114                     </row>
 115                     <row>
 116                         <entry>max (genUType)</entry>#newin13#
 117                     </row>
 118                     <row>
 119                         <entry>max (genDType)</entry>#newin40#
 120                     </row>
 121                 </thead>
 122             </tgroup>
 123         </informaltable>
 124     </refsect1>
 125     <refsect1 id="seealso"><title>See Also</title>
 126         <para>
 127             <citerefentry><refentrytitle>min</refentrytitle></citerefentry>,
 128             <citerefentry><refentrytitle>abs</refentrytitle></citerefentry>
 129         </para>
 130     </refsect1>
 131     <refsect1 id="Copyright"><title>Copyright</title>
 132         <para>
 133             Copyright <trademark class="copyright"></trademark> 2011 Khronos Group.
 134             This material may be distributed subject to the terms and conditions set forth in
 135             the Open Publication License, v 1.0, 8 June 1999.
 136             <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
 137         </para>
 138     </refsect1>
 139 </refentry>