upstream-man-pages/manglsl/mod.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="mod">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>2011</year>
   9                 <holder>Khronos Group</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>mod</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>mod</refname>
  17         <refpurpose>compute value of one parameter modulo another</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>Declaration</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>genType <function>mod</function></funcdef>
  23                 <paramdef>genType <parameter>x</parameter></paramdef>
  24                 <paramdef>float <parameter>y</parameter></paramdef>
  25             </funcprototype>
  26         </funcsynopsis>
  27         <funcsynopsis>
  28             <funcprototype>
  29                 <funcdef>genType <function>mod</function></funcdef>
  30                 <paramdef>genType <parameter>x</parameter></paramdef>
  31                 <paramdef>genType <parameter>y</parameter></paramdef>
  32             </funcprototype>
  33         </funcsynopsis>
  34         <funcsynopsis>
  35             <funcprototype>
  36                 <funcdef>genDType <function>mod</function></funcdef>
  37                 <paramdef>genDType <parameter>x</parameter></paramdef>
  38                 <paramdef>double <parameter>y</parameter></paramdef>
  39             </funcprototype>
  40         </funcsynopsis>
  41         <funcsynopsis>
  42             <funcprototype>
  43                 <funcdef>genDType <function>mod</function></funcdef>
  44                 <paramdef>genDType <parameter>x</parameter></paramdef>
  45                 <paramdef>genDType <parameter>y</parameter></paramdef>
  46             </funcprototype>
  47         </funcsynopsis>
  48     </refsynopsisdiv>
  49     <refsect1 id="parameters"><title>Parameters</title>
  50         <variablelist>
  51         <varlistentry>
  52             <term><parameter>x</parameter></term>
  53             <listitem>
  54                 <para>
  55                     Specify the value to evaluate.
  56                 </para>
  57             </listitem>
  58         </varlistentry>
  59         </variablelist>
  60     </refsect1>
  61     <refsect1 id="description"><title>Description</title>
  62         <para>
  63             <function>mod</function> returns the value of <parameter>x</parameter> modulo
  64             <parameter>y</parameter>. This is computed as <parameter>x</parameter> - <parameter>y</parameter> *
  65             <citerefentry><refentrytitle>floor</refentrytitle></citerefentry>(<parameter>x</parameter>/<parameter>y</parameter>).
  66         </para>
  67     </refsect1>
  68     <refsect1 id="versions"><title>Version Support</title>
  69         <informaltable frame="topbot">
  70             #VARTABLECOLS#
  71                 <thead>
  72                     #FUNCTABLEHEADER#
  73                     <row>
  74                         <entry>mod (genType)</entry>#newin11#
  75                     </row>
  76                     <row>
  77                         <entry>mod (genDType)</entry>#newin40#
  78                     </row>
  79                 </thead>
  80             </tgroup>
  81         </informaltable>
  82     </refsect1>
  83     <refsect1 id="seealso"><title>See Also</title>
  84         <para>
  85             <citerefentry><refentrytitle>modf</refentrytitle></citerefentry>,
  86             <citerefentry><refentrytitle>floor</refentrytitle></citerefentry>
  87         </para>
  88     </refsect1>
  89     <refsect1 id="Copyright"><title>Copyright</title>
  90         <para>
  91             Copyright <trademark class="copyright"></trademark> 2011 Khronos Group.
  92             This material may be distributed subject to the terms and conditions set forth in
  93             the Open Publication License, v 1.0, 8 June 1999.
  94             <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
  95         </para>
  96     </refsect1>
  97 </refentry>