upstream-man-pages/manglsl/intBitsToFloat.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="intBitsToFloat">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>2011</year>
   9                 <holder>Khronos Group</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>intBitsToFloat</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>intBitsToFloat, uintBitsToFloat</refname>
  17         <refpurpose>produce a floating point using an encoding supplied as an integer</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>Declaration</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>genType <function>intBitsToFloat</function></funcdef>
  23                 <paramdef>genIType <parameter>x</parameter></paramdef>
  24             </funcprototype>
  25             <funcprototype>
  26                 <funcdef>genType <function>uintBitsToFloat</function></funcdef>
  27                 <paramdef>genUType <parameter>x</parameter></paramdef>
  28             </funcprototype>
  29         </funcsynopsis>
  30     </refsynopsisdiv>
  31     <refsect1 id="parameters"><title>Parameters</title>
  32         <variablelist>
  33         <varlistentry>
  34             <term><parameter>x</parameter></term>
  35             <listitem>
  36                 <para>
  37                     Specifies the bit encoding to return as a floating point value.
  38                 </para>
  39             </listitem>
  40         </varlistentry>
  41         </variablelist>
  42     </refsect1>
  43     <refsect1 id="description"><title>Description</title>
  44         <para>
  45             <function>intBitsToFloat</function> and <function>uintBitsToFloat</function> return the encoding
  46             passed in parameter <parameter>x</parameter> as a floating-point value. If the encoding of
  47             a NaN is passed in <parameter>x</parameter>, it will not signal and the resulting value will
  48             be undefined. If the encoding of a floating point infinity is passed in parameter <parameter>x</parameter>,
  49             the resulting floating-point value is the corresponding (positive or negative) floating
  50             point infinity.
  51         </para>
  52     </refsect1>
  53     <refsect1 id="versions"><title>Version Support</title>
  54         <informaltable frame="topbot">
  55             #VARTABLECOLS#
  56                 <thead>
  57                     #FUNCTABLEHEADER#
  58                     <row>
  59                         <entry>intBitsToFloat</entry>#newin33#
  60                     </row>
  61                 </thead>
  62             </tgroup>
  63         </informaltable>
  64     </refsect1>
  65     <refsect1 id="seealso"><title>See Also</title>
  66         <para>
  67             <citerefentry><refentrytitle>floatBitsToInt</refentrytitle></citerefentry>,
  68             <citerefentry><refentrytitle>floatBitsToUint</refentrytitle></citerefentry>,
  69             <citerefentry><refentrytitle>isnan</refentrytitle></citerefentry>,
  70             <citerefentry><refentrytitle>isinf</refentrytitle></citerefentry>
  71         </para>
  72     </refsect1>
  73     <refsect1 id="Copyright"><title>Copyright</title>
  74         <para>
  75             Copyright <trademark class="copyright"></trademark> 2011 Khronos Group.
  76             This material may be distributed subject to the terms and conditions set forth in
  77             the Open Publication License, v 1.0, 8 June 1999.
  78             <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
  79         </para>
  80     </refsect1>
  81 </refentry>