upstream-man-pages/manglsl/umulExtended.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="umulExtended">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>2011</year>
   9                 <holder>Khronos Group</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>umulExtended</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>umulExtended</refname>
  17         <refpurpose>perform a 32- by 32-bit multiply to produce a 64-bit result</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>Declaration</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>void <function>umulExtended</function></funcdef>
  23                 <paramdef>genUType <parameter>x</parameter></paramdef>
  24                 <paramdef>genUType <parameter>y</parameter></paramdef>
  25                 <paramdef>out genUType <parameter>msb</parameter></paramdef>
  26                 <paramdef>out genUType <parameter>lsb</parameter></paramdef>
  27             </funcprototype>            <funcprototype>
  28                 <funcdef>void <function>imulExtended</function></funcdef>
  29                 <paramdef>genIType <parameter>x</parameter></paramdef>
  30                 <paramdef>genIType <parameter>y</parameter></paramdef>
  31                 <paramdef>out genIType <parameter>msb</parameter></paramdef>
  32                 <paramdef>out genIType <parameter>lsb</parameter></paramdef>
  33             </funcprototype>
  34         </funcsynopsis>
  35     </refsynopsisdiv>
  36     <refsect1 id="parameters"><title>Parameters</title>
  37         <variablelist>
  38         <varlistentry>
  39             <term><parameter>x</parameter></term>
  40             <listitem>
  41                 <para>
  42                     Specifies the first multiplicand.
  43                 </para>
  44             </listitem>
  45         </varlistentry>
  46         <varlistentry>
  47             <term><parameter>y</parameter></term>
  48             <listitem>
  49                 <para>
  50                     Specifies the second multiplicand..
  51                 </para>
  52             </listitem>
  53         </varlistentry>
  54         <varlistentry>
  55             <term><parameter>msb</parameter></term>
  56             <listitem>
  57                 <para>
  58                     Specifies the variable to receive the most significant word of the product.
  59                 </para>
  60             </listitem>
  61         </varlistentry>
  62         <varlistentry>
  63             <term><parameter>lsb</parameter></term>
  64             <listitem>
  65                 <para>
  66                     Specifies the variable to receive the least significant word of the product.
  67                 </para>
  68             </listitem>
  69         </varlistentry>
  70         </variablelist>
  71     </refsect1>
  72     <refsect1 id="description"><title>Description</title>
  73         <para>
  74             <function>umulExtended</function> and <function>imulExtended</function> perform multiplication of the two 32-bit integer
  75             quantities <parameter>x</parameter> and <parameter>y</parameter>, producing a 64-bit integer result. The 32 least
  76             significant bits of this product are returned in <parameter>lsb</parameter> and the 32 most significant bits are returned
  77             in <parameter>msb</parameter>. <function>umulExtended</function> and <function>imulExtended</function> perform
  78             unsigned and signed multiplication, respectively.
  79         </para>
  80     </refsect1>
  81     <refsect1 id="versions"><title>Version Support</title>
  82         <informaltable frame="topbot">
  83             #VARTABLECOLS#
  84                 <thead>
  85                     #FUNCTABLEHEADER#
  86                     <row>
  87                         <entry>umulExtended</entry>#newin40#
  88                     </row>
  89                 </thead>
  90             </tgroup>
  91         </informaltable>
  92     </refsect1>
  93     <refsect1 id="seealso"><title>See Also</title>
  94         <para>
  95             <citerefentry><refentrytitle>uaddCarry</refentrytitle></citerefentry>
  96         </para>
  97     </refsect1>
  98     <refsect1 id="Copyright"><title>Copyright</title>
  99         <para>
 100             Copyright <trademark class="copyright"></trademark> 2011 Khronos Group.
 101             This material may be distributed subject to the terms and conditions set forth in
 102             the Open Publication License, v 1.0, 8 June 1999.
 103             <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
 104         </para>
 105     </refsect1>
 106 </refentry>