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