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