HCoop / clinton / guile-figl.git / blame
| Commit | Line | Data |
|---|---|---|
| 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="cross">\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>cross</refentrytitle>\r | |
| 13 | <manvolnum>3G</manvolnum>\r | |
| 14 | </refmeta>\r | |
| 15 | <refnamediv>\r | |
| 16 | <refname>cross</refname>\r | |
| 17 | <refpurpose>calculate the cross product of two vectors</refpurpose>\r | |
| 18 | </refnamediv>\r | |
| 19 | <refsynopsisdiv><title>Declaration</title>\r | |
| 20 | <funcsynopsis>\r | |
| 21 | <funcprototype>\r | |
| 22 | <funcdef>vec3 <function>cross</function></funcdef>\r | |
| 23 | <paramdef>vec3 <parameter>x</parameter></paramdef>\r | |
| 24 | <paramdef>vec3 <parameter>y</parameter></paramdef>\r | |
| 25 | </funcprototype>\r | |
| 26 | <funcprototype>\r | |
| 27 | <funcdef>dvec3 <function>cross</function></funcdef>\r | |
| 28 | <paramdef>dvec3 <parameter>x</parameter></paramdef>\r | |
| 29 | <paramdef>dvec3 <parameter>y</parameter></paramdef>\r | |
| 30 | </funcprototype>\r | |
| 31 | </funcsynopsis>\r | |
| 32 | </refsynopsisdiv>\r | |
| 33 | <refsect1 id="parameters"><title>Parameters</title>\r | |
| 34 | <variablelist>\r | |
| 35 | <varlistentry>\r | |
| 36 | <term><parameter>x</parameter></term>\r | |
| 37 | <listitem>\r | |
| 38 | <para>\r | |
| 39 | Specifies the first of two vectors\r | |
| 40 | </para>\r | |
| 41 | </listitem>\r | |
| 42 | </varlistentry>\r | |
| 43 | <varlistentry>\r | |
| 44 | <term><parameter>y</parameter></term>\r | |
| 45 | <listitem>\r | |
| 46 | <para>\r | |
| 47 | Specifies the second of two vectors\r | |
| 48 | </para>\r | |
| 49 | </listitem>\r | |
| 50 | </varlistentry>\r | |
| 51 | </variablelist>\r | |
| 52 | </refsect1>\r | |
| 53 | <refsect1 id="description"><title>Description</title>\r | |
| 54 | <para>\r | |
| 55 | <function>cross</function> returns the cross product of two vectors, <parameter>x</parameter> and <parameter>y</parameter>. i.e.,\r | |
| 56 | </para>\r | |
| 57 | <para>\r | |
| 58 | <inlineequation><mml:math>\r | |
| 59 | <mml:vector>\r | |
| 60 | <mml:csymbol>\r | |
| 61 | <mml:mi>x</mml:mi>\r | |
| 62 | <mml:mo stretchy='false'>[</mml:mo>\r | |
| 63 | <mml:mn>1</mml:mn>\r | |
| 64 | <mml:mo stretchy='false'>]</mml:mo>\r | |
| 65 | <mml:mo lspace='2px' rspace='2px'>⋅</mml:mo>\r | |
| 66 | <mml:mi>y</mml:mi>\r | |
| 67 | <mml:mo stretchy='false'>[</mml:mo>\r | |
| 68 | <mml:mn>2</mml:mn>\r | |
| 69 | <mml:mo stretchy='false'>]</mml:mo>\r | |
| 70 | <mml:mo>−</mml:mo>\r | |
| 71 | <mml:mi>y</mml:mi>\r | |
| 72 | <mml:mo stretchy='false'>[</mml:mo>\r | |
| 73 | <mml:mn>1</mml:mn>\r | |
| 74 | <mml:mo stretchy='false'>]</mml:mo>\r | |
| 75 | <mml:mo lspace='2px' rspace='2px'>⋅</mml:mo>\r | |
| 76 | <mml:mi>x</mml:mi>\r | |
| 77 | <mml:mo stretchy='false'>[</mml:mo>\r | |
| 78 | <mml:mn>2</mml:mn>\r | |
| 79 | <mml:mo stretchy='false'>]</mml:mo>\r | |
| 80 | </mml:csymbol>\r | |
| 81 | <mml:csymbol>\r | |
| 82 | <mml:mi>x</mml:mi>\r | |
| 83 | <mml:mo stretchy='false'>[</mml:mo>\r | |
| 84 | <mml:mn>2</mml:mn>\r | |
| 85 | <mml:mo stretchy='false'>]</mml:mo>\r | |
| 86 | <mml:mo lspace='2px' rspace='2px'>⋅</mml:mo>\r | |
| 87 | <mml:mi>y</mml:mi>\r | |
| 88 | <mml:mo stretchy='false'>[</mml:mo>\r | |
| 89 | <mml:mn>0</mml:mn>\r | |
| 90 | <mml:mo stretchy='false'>]</mml:mo>\r | |
| 91 | <mml:mo>−</mml:mo>\r | |
| 92 | <mml:mi>y</mml:mi>\r | |
| 93 | <mml:mo stretchy='false'>[</mml:mo>\r | |
| 94 | <mml:mn>2</mml:mn>\r | |
| 95 | <mml:mo stretchy='false'>]</mml:mo>\r | |
| 96 | <mml:mo lspace='2px' rspace='2px'>⋅</mml:mo>\r | |
| 97 | <mml:mi>x</mml:mi>\r | |
| 98 | <mml:mo stretchy='false'>[</mml:mo>\r | |
| 99 | <mml:mn>0</mml:mn>\r | |
| 100 | <mml:mo stretchy='false'>]</mml:mo>\r | |
| 101 | </mml:csymbol>\r | |
| 102 | <mml:csymbol>\r | |
| 103 | <mml:mi>x</mml:mi>\r | |
| 104 | <mml:mo stretchy='false'>[</mml:mo>\r | |
| 105 | <mml:mn>0</mml:mn>\r | |
| 106 | <mml:mo stretchy='false'>]</mml:mo>\r | |
| 107 | <mml:mo lspace='2px' rspace='2px'>⋅</mml:mo>\r | |
| 108 | <mml:mi>y</mml:mi>\r | |
| 109 | <mml:mo stretchy='false'>[</mml:mo>\r | |
| 110 | <mml:mn>1</mml:mn>\r | |
| 111 | <mml:mo stretchy='false'>]</mml:mo>\r | |
| 112 | <mml:mo>−</mml:mo>\r | |
| 113 | <mml:mi>y</mml:mi>\r | |
| 114 | <mml:mo stretchy='false'>[</mml:mo>\r | |
| 115 | <mml:mn>0</mml:mn>\r | |
| 116 | <mml:mo stretchy='false'>]</mml:mo>\r | |
| 117 | <mml:mo lspace='2px' rspace='2px'>⋅</mml:mo>\r | |
| 118 | <mml:mi>x</mml:mi>\r | |
| 119 | <mml:mo stretchy='false'>[</mml:mo>\r | |
| 120 | <mml:mn>1</mml:mn>\r | |
| 121 | <mml:mo stretchy='false'>]</mml:mo>\r | |
| 122 | </mml:csymbol>\r | |
| 123 | </mml:vector>\r | |
| 124 | </mml:math></inlineequation>\r | |
| 125 | </para>\r | |
| 126 | </refsect1>\r | |
| 127 | <refsect1 id="versions"><title>Version Support</title>\r | |
| 128 | <informaltable frame="topbot">\r | |
| 129 | #VARTABLECOLS#\r | |
| 130 | <thead>\r | |
| 131 | #FUNCTABLEHEADER#\r | |
| 132 | <row>\r | |
| 133 | <entry>cross (vec3)</entry>#newin11#\r | |
| 134 | </row>\r | |
| 135 | <row>\r | |
| 136 | <entry>cross (dvec3)</entry>#newin40#\r | |
| 137 | </row>\r | |
| 138 | </thead>\r | |
| 139 | </tgroup>\r | |
| 140 | </informaltable>\r | |
| 141 | </refsect1>\r | |
| 142 | <refsect1 id="seealso"><title>See Also</title>\r | |
| 143 | <para>\r | |
| 144 | <citerefentry><refentrytitle>dot</refentrytitle></citerefentry>\r | |
| 145 | </para>\r | |
| 146 | </refsect1>\r | |
| 147 | <refsect1 id="Copyright"><title>Copyright</title>\r | |
| 148 | <para>\r | |
| 149 | Copyright <trademark class="copyright"></trademark> 2011 Khronos Group. \r | |
| 150 | This material may be distributed subject to the terms and conditions set forth in \r | |
| 151 | the Open Publication License, v 1.0, 8 June 1999.\r | |
| 152 | <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.\r | |
| 153 | </para>\r | |
| 154 | </refsect1>\r | |
| 155 | </refentry>\r |