rename upstream-man-pages to upstream-doc

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

diff --git a/upstream-doc/manglsl/umulExtended.xml b/upstream-doc/manglsl/umulExtended.xml
new file mode 100644 (file)
index 0000000..dd699ec
--- /dev/null
+++ b/upstream-doc/manglsl/umulExtended.xml
@@ -0,0 +1,106 @@
+<?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="umulExtended">\r
+    <refmeta>\r
+        <refmetainfo>\r
+            <copyright>\r
+                <year>2011</year>\r
+                <holder>Khronos Group</holder>\r
+            </copyright>\r
+        </refmetainfo>\r
+        <refentrytitle>umulExtended</refentrytitle>\r
+        <manvolnum>3G</manvolnum>\r
+    </refmeta>\r
+    <refnamediv>\r
+        <refname>umulExtended</refname>\r
+        <refpurpose>perform a 32- by 32-bit multiply to produce a 64-bit result</refpurpose>\r
+    </refnamediv>\r
+    <refsynopsisdiv><title>Declaration</title>\r
+        <funcsynopsis>\r
+            <funcprototype>\r
+                <funcdef>void <function>umulExtended</function></funcdef>\r
+                <paramdef>genUType <parameter>x</parameter></paramdef>\r
+                <paramdef>genUType <parameter>y</parameter></paramdef>\r
+                <paramdef>out genUType <parameter>msb</parameter></paramdef>\r
+                <paramdef>out genUType <parameter>lsb</parameter></paramdef>\r
+            </funcprototype>            <funcprototype>\r
+                <funcdef>void <function>imulExtended</function></funcdef>\r
+                <paramdef>genIType <parameter>x</parameter></paramdef>\r
+                <paramdef>genIType <parameter>y</parameter></paramdef>\r
+                <paramdef>out genIType <parameter>msb</parameter></paramdef>\r
+                <paramdef>out genIType <parameter>lsb</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 first multiplicand.\r
+                </para>\r
+            </listitem>\r
+        </varlistentry>\r
+        <varlistentry>\r
+            <term><parameter>y</parameter></term>\r
+            <listitem>\r
+                <para>\r
+                    Specifies the second multiplicand..\r
+                </para>\r
+            </listitem>\r
+        </varlistentry>\r
+        <varlistentry>\r
+            <term><parameter>msb</parameter></term>\r
+            <listitem>\r
+                <para>\r
+                    Specifies the variable to receive the most significant word of the product.\r
+                </para>\r
+            </listitem>\r
+        </varlistentry>\r
+        <varlistentry>\r
+            <term><parameter>lsb</parameter></term>\r
+            <listitem>\r
+                <para>\r
+                    Specifies the variable to receive the least significant word of the product.\r
+                </para>\r
+            </listitem>\r
+        </varlistentry>\r
+        </variablelist>\r
+    </refsect1>\r
+    <refsect1 id="description"><title>Description</title>\r
+        <para>\r
+            <function>umulExtended</function> and <function>imulExtended</function> perform multiplication of the two 32-bit integer\r
+            quantities <parameter>x</parameter> and <parameter>y</parameter>, producing a 64-bit integer result. The 32 least\r
+            significant bits of this product are returned in <parameter>lsb</parameter> and the 32 most significant bits are returned\r
+            in <parameter>msb</parameter>. <function>umulExtended</function> and <function>imulExtended</function> perform\r
+            unsigned and signed multiplication, respectively.\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>umulExtended</entry>#newin40#\r
+                    </row>\r
+                </thead>\r
+            </tgroup>\r
+        </informaltable>\r
+    </refsect1>\r
+    <refsect1 id="seealso"><title>See Also</title>\r
+        <para>\r
+            <citerefentry><refentrytitle>uaddCarry</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