upstream-man-pages/manglsl/dot.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="dot">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>2011</year>
   9                 <holder>Khronos Group</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>dot</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>dot</refname>
  17         <refpurpose>calculate the dot product of two vectors</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>Declaration</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>float <function>dot</function></funcdef>
  23                 <paramdef>genType <parameter>x</parameter></paramdef>
  24                 <paramdef>genType <parameter>y</parameter></paramdef>
  25             </funcprototype>
  26             <funcprototype>
  27                 <funcdef>double <function>dot</function></funcdef>
  28                 <paramdef>genDType <parameter>x</parameter></paramdef>
  29                 <paramdef>genDType <parameter>y</parameter></paramdef>
  30             </funcprototype>
  31         </funcsynopsis>
  32     </refsynopsisdiv>
  33     <refsect1 id="parameters"><title>Parameters</title>
  34         <variablelist>
  35         <varlistentry>
  36             <term><parameter>x</parameter></term>
  37             <listitem>
  38                 <para>
  39                     Specifies the first of two vectors
  40                 </para>
  41             </listitem>
  42         </varlistentry>
  43         <varlistentry>
  44             <term><parameter>y</parameter></term>
  45             <listitem>
  46                 <para>
  47                     Specifies the second of two vectors
  48                 </para>
  49             </listitem>
  50         </varlistentry>
  51         </variablelist>
  52     </refsect1>
  53     <refsect1 id="description"><title>Description</title>
  54         <para>
  55             <function>dot</function> returns the dot product of two vectors, <parameter>x</parameter> and <parameter>y</parameter>. i.e.,
  56             <inlineequation><mml:math>
  57                 <mml:mi>x</mml:mi>
  58                 <mml:mo stretchy='false'>[</mml:mo>
  59                 <mml:mn>0</mml:mn>
  60                 <mml:mo stretchy='false'>]</mml:mo>
  61                 <mml:mo lspace='2px' rspace='2px'>&sdot;</mml:mo>
  62                 <mml:mi>y</mml:mi>
  63                 <mml:mo stretchy='false'>[</mml:mo>
  64                 <mml:mn>0</mml:mn>
  65                 <mml:mo stretchy='false'>]</mml:mo>
  66                 <mml:mo>+</mml:mo>
  67                 <mml:mi>x</mml:mi>
  68                 <mml:mo stretchy='false'>[</mml:mo>
  69                 <mml:mn>1</mml:mn>
  70                 <mml:mo stretchy='false'>]</mml:mo>
  71                 <mml:mo lspace='2px' rspace='2px'>&sdot;</mml:mo>
  72                 <mml:mi>y</mml:mi>
  73                 <mml:mo stretchy='false'>[</mml:mo>
  74                 <mml:mn>1</mml:mn>
  75                 <mml:mo stretchy='false'>]</mml:mo>
  76                 <mml:mo>+</mml:mo>
  77                 <mml:mo lspace='0px' form='infix'>...</mml:mo>
  78             </mml:math></inlineequation>
  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>dot (genType)</entry>#newin11#
  88                     </row>
  89                     <row>
  90                         <entry>dot (genDType)</entry>#newin40#
  91                     </row>
  92                 </thead>
  93             </tgroup>
  94         </informaltable>
  95     </refsect1>
  96     <refsect1 id="seealso"><title>See Also</title>
  97         <para>
  98             <citerefentry><refentrytitle>cross</refentrytitle></citerefentry>
  99         </para>
 100     </refsect1>
 101     <refsect1 id="Copyright"><title>Copyright</title>
 102         <para>
 103             Copyright <trademark class="copyright"></trademark> 2011 Khronos Group.
 104             This material may be distributed subject to the terms and conditions set forth in
 105             the Open Publication License, v 1.0, 8 June 1999.
 106             <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
 107         </para>
 108     </refsect1>
 109 </refentry>