upstream-man-pages/manglsl/floatBitsToInt.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="floatBitsToInt">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>2011</year>
   9                 <holder>Khronos Group</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>floatBitsToInt</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>floatBitsToInt</refname>
  17         <refpurpose>produce the encoding of a floating point value as an integer</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>Declaration</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>genIType <function>floatBitsToInt</function></funcdef>
  23                 <paramdef>genType <parameter>x</parameter></paramdef>
  24             </funcprototype>
  25             <funcprototype>
  26                 <funcdef>genUType <function>floatBitsToUint</function></funcdef>
  27                 <paramdef>genType <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 value whose floating point encoding to return.
  38                 </para>
  39             </listitem>
  40         </varlistentry>
  41         </variablelist>
  42     </refsect1>
  43     <refsect1 id="description"><title>Description</title>
  44         <para>
  45             <function>floatBitsToInt</function> and <function>floatBitsToUint</function> return the encoding
  46             of their floating-point parameters as <code>int</code> or <code>uint</code>, respectively. The
  47             floating-point bit-level representation is preserved.
  48         </para>
  49     </refsect1>
  50     <refsect1 id="versions"><title>Version Support</title>
  51         <informaltable frame="topbot">
  52             #VARTABLECOLS#
  53                 <thead>
  54                     #FUNCTABLEHEADER#
  55                     <row>
  56                         <entry>floatBitsToInt</entry>#newin33#
  57                     </row>
  58                     <row>
  59                         <entry>floatBitsToUInt</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>intBitsToFloat</refentrytitle></citerefentry>,
  68             <citerefentry><refentrytitle>uintBitsToFloat</refentrytitle></citerefentry>
  69         </para>
  70     </refsect1>
  71     <refsect1 id="Copyright"><title>Copyright</title>
  72         <para>
  73             Copyright <trademark class="copyright"></trademark> 2011 Khronos Group.
  74             This material may be distributed subject to the terms and conditions set forth in
  75             the Open Publication License, v 1.0, 8 June 1999.
  76             <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
  77         </para>
  78     </refsect1>
  79 </refentry>