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