upstream-man-pages/manglsl/cross.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="cross">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>2011</year>
   9                 <holder>Khronos Group</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>cross</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>cross</refname>
  17         <refpurpose>calculate the cross product of two vectors</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>Declaration</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>vec3 <function>cross</function></funcdef>
  23                 <paramdef>vec3 <parameter>x</parameter></paramdef>
  24                 <paramdef>vec3 <parameter>y</parameter></paramdef>
  25             </funcprototype>
  26             <funcprototype>
  27                 <funcdef>dvec3 <function>cross</function></funcdef>
  28                 <paramdef>dvec3 <parameter>x</parameter></paramdef>
  29                 <paramdef>dvec3 <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>cross</function> returns the cross product of two vectors, <parameter>x</parameter> and <parameter>y</parameter>. i.e.,
  56         </para>
  57         <para>
  58             <inlineequation><mml:math>
  59                 <mml:vector>
  60                     <mml:csymbol>
  61                       <mml:mi>x</mml:mi>
  62                       <mml:mo stretchy='false'>[</mml:mo>
  63                       <mml:mn>1</mml:mn>
  64                       <mml:mo stretchy='false'>]</mml:mo>
  65                       <mml:mo lspace='2px' rspace='2px'>&sdot;</mml:mo>
  66                       <mml:mi>y</mml:mi>
  67                       <mml:mo stretchy='false'>[</mml:mo>
  68                       <mml:mn>2</mml:mn>
  69                       <mml:mo stretchy='false'>]</mml:mo>
  70                       <mml:mo>&minus;</mml:mo>
  71                       <mml:mi>y</mml:mi>
  72                       <mml:mo stretchy='false'>[</mml:mo>
  73                       <mml:mn>1</mml:mn>
  74                       <mml:mo stretchy='false'>]</mml:mo>
  75                       <mml:mo lspace='2px' rspace='2px'>&sdot;</mml:mo>
  76                       <mml:mi>x</mml:mi>
  77                       <mml:mo stretchy='false'>[</mml:mo>
  78                       <mml:mn>2</mml:mn>
  79                       <mml:mo stretchy='false'>]</mml:mo>
  80                     </mml:csymbol>
  81                     <mml:csymbol>
  82                       <mml:mi>x</mml:mi>
  83                       <mml:mo stretchy='false'>[</mml:mo>
  84                       <mml:mn>2</mml:mn>
  85                       <mml:mo stretchy='false'>]</mml:mo>
  86                       <mml:mo lspace='2px' rspace='2px'>&sdot;</mml:mo>
  87                       <mml:mi>y</mml:mi>
  88                       <mml:mo stretchy='false'>[</mml:mo>
  89                       <mml:mn>0</mml:mn>
  90                       <mml:mo stretchy='false'>]</mml:mo>
  91                       <mml:mo>&minus;</mml:mo>
  92                       <mml:mi>y</mml:mi>
  93                       <mml:mo stretchy='false'>[</mml:mo>
  94                       <mml:mn>2</mml:mn>
  95                       <mml:mo stretchy='false'>]</mml:mo>
  96                       <mml:mo lspace='2px' rspace='2px'>&sdot;</mml:mo>
  97                       <mml:mi>x</mml:mi>
  98                       <mml:mo stretchy='false'>[</mml:mo>
  99                       <mml:mn>0</mml:mn>
 100                       <mml:mo stretchy='false'>]</mml:mo>
 101                     </mml:csymbol>
 102                     <mml:csymbol>
 103                       <mml:mi>x</mml:mi>
 104                       <mml:mo stretchy='false'>[</mml:mo>
 105                       <mml:mn>0</mml:mn>
 106                       <mml:mo stretchy='false'>]</mml:mo>
 107                       <mml:mo lspace='2px' rspace='2px'>&sdot;</mml:mo>
 108                       <mml:mi>y</mml:mi>
 109                       <mml:mo stretchy='false'>[</mml:mo>
 110                       <mml:mn>1</mml:mn>
 111                       <mml:mo stretchy='false'>]</mml:mo>
 112                       <mml:mo>&minus;</mml:mo>
 113                       <mml:mi>y</mml:mi>
 114                       <mml:mo stretchy='false'>[</mml:mo>
 115                       <mml:mn>0</mml:mn>
 116                       <mml:mo stretchy='false'>]</mml:mo>
 117                       <mml:mo lspace='2px' rspace='2px'>&sdot;</mml:mo>
 118                       <mml:mi>x</mml:mi>
 119                       <mml:mo stretchy='false'>[</mml:mo>
 120                       <mml:mn>1</mml:mn>
 121                       <mml:mo stretchy='false'>]</mml:mo>
 122                     </mml:csymbol>
 123                   </mml:vector>
 124             </mml:math></inlineequation>
 125         </para>
 126     </refsect1>
 127     <refsect1 id="versions"><title>Version Support</title>
 128         <informaltable frame="topbot">
 129             #VARTABLECOLS#
 130                 <thead>
 131                     #FUNCTABLEHEADER#
 132                     <row>
 133                         <entry>cross (vec3)</entry>#newin11#
 134                     </row>
 135                     <row>
 136                         <entry>cross (dvec3)</entry>#newin40#
 137                     </row>
 138                 </thead>
 139             </tgroup>
 140         </informaltable>
 141     </refsect1>
 142     <refsect1 id="seealso"><title>See Also</title>
 143         <para>
 144             <citerefentry><refentrytitle>dot</refentrytitle></citerefentry>
 145         </para>
 146     </refsect1>
 147     <refsect1 id="Copyright"><title>Copyright</title>
 148         <para>
 149             Copyright <trademark class="copyright"></trademark> 2011 Khronos Group.
 150             This material may be distributed subject to the terms and conditions set forth in
 151             the Open Publication License, v 1.0, 8 June 1999.
 152             <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
 153         </para>
 154     </refsect1>
 155 </refentry>