rename upstream-man-pages to upstream-doc

[clinton/guile-figl.git] / upstream-doc / manglsl / intBitsToFloat.xml

diff --git a/upstream-doc/manglsl/intBitsToFloat.xml b/upstream-doc/manglsl/intBitsToFloat.xml
new file mode 100644 (file)
index 0000000..06ede18
--- /dev/null
+++ b/upstream-doc/manglsl/intBitsToFloat.xml
@@ -0,0 +1,81 @@
+<?xml version="1.0" encoding="UTF-8"?>\r
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"\r
+              "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">\r
+<refentry id="intBitsToFloat">\r
+    <refmeta>\r
+        <refmetainfo>\r
+            <copyright>\r
+                <year>2011</year>\r
+                <holder>Khronos Group</holder>\r
+            </copyright>\r
+        </refmetainfo>\r
+        <refentrytitle>intBitsToFloat</refentrytitle>\r
+        <manvolnum>3G</manvolnum>\r
+    </refmeta>\r
+    <refnamediv>\r
+        <refname>intBitsToFloat, uintBitsToFloat</refname>\r
+        <refpurpose>produce a floating point using an encoding supplied as an integer</refpurpose>\r
+    </refnamediv>\r
+    <refsynopsisdiv><title>Declaration</title>\r
+        <funcsynopsis>\r
+            <funcprototype>\r
+                <funcdef>genType <function>intBitsToFloat</function></funcdef>\r
+                <paramdef>genIType <parameter>x</parameter></paramdef>\r
+            </funcprototype>\r
+            <funcprototype>\r
+                <funcdef>genType <function>uintBitsToFloat</function></funcdef>\r
+                <paramdef>genUType <parameter>x</parameter></paramdef>\r
+            </funcprototype>\r
+        </funcsynopsis>\r
+    </refsynopsisdiv>\r
+    <refsect1 id="parameters"><title>Parameters</title>\r
+        <variablelist>\r
+        <varlistentry>\r
+            <term><parameter>x</parameter></term>\r
+            <listitem>\r
+                <para>\r
+                    Specifies the bit encoding to return as a floating point value.\r
+                </para>\r
+            </listitem>\r
+        </varlistentry>\r
+        </variablelist>\r
+    </refsect1>\r
+    <refsect1 id="description"><title>Description</title>\r
+        <para>\r
+            <function>intBitsToFloat</function> and <function>uintBitsToFloat</function> return the encoding\r
+            passed in parameter <parameter>x</parameter> as a floating-point value. If the encoding of\r
+            a NaN is passed in <parameter>x</parameter>, it will not signal and the resulting value will\r
+            be undefined. If the encoding of a floating point infinity is passed in parameter <parameter>x</parameter>,\r
+            the resulting floating-point value is the corresponding (positive or negative) floating\r
+            point infinity.\r
+        </para>\r
+    </refsect1>\r
+    <refsect1 id="versions"><title>Version Support</title>\r
+        <informaltable frame="topbot">\r
+            #VARTABLECOLS#\r
+                <thead>\r
+                    #FUNCTABLEHEADER#\r
+                    <row>\r
+                        <entry>intBitsToFloat</entry>#newin33#\r
+                    </row>\r
+                </thead>\r
+            </tgroup>\r
+        </informaltable>\r
+    </refsect1>\r
+    <refsect1 id="seealso"><title>See Also</title>\r
+        <para>\r
+            <citerefentry><refentrytitle>floatBitsToInt</refentrytitle></citerefentry>,\r
+            <citerefentry><refentrytitle>floatBitsToUint</refentrytitle></citerefentry>,\r
+            <citerefentry><refentrytitle>isnan</refentrytitle></citerefentry>,\r
+            <citerefentry><refentrytitle>isinf</refentrytitle></citerefentry>\r
+        </para>\r
+    </refsect1>\r
+    <refsect1 id="Copyright"><title>Copyright</title>\r
+        <para>\r
+            Copyright <trademark class="copyright"></trademark> 2011 Khronos Group. \r
+            This material may be distributed subject to the terms and conditions set forth in \r
+            the Open Publication License, v 1.0, 8 June 1999.\r
+            <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.\r
+        </para>\r
+    </refsect1>\r
+</refentry>\r