rename upstream-man-pages to upstream-doc
[clinton/guile-figl.git] / upstream-doc / manglsl / xhtml / dot.xml
CommitLineData
7faf1d71
AW
1<?xml version="1.0" encoding="UTF-8"?>
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd">
3<!-- saved from url=(0013)about:internet -->
4<?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" pref:renderer="mathplayer-dl"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><link rel="stylesheet" type="text/css" href="opengl-man.css" /><title>dot - OpenGL Shading Language (GLSL)</title><meta name="generator" content="DocBook XSL Stylesheets V1.69.1" /></head><body><div class="refentry" lang="en" xml:lang="en"><a id="dot"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>dot — calculate the dot product of two vectors</p></div><div class="refsynopsisdiv"><h2>Declaration</h2><div class="funcsynopsis"><p><code class="funcdef">float <b class="fsfunc">dot</b>(</code>genType <var class="pdparam">x</var>, genType <var class="pdparam">y</var><code>)</code>;</p><p><code class="funcdef">double <b class="fsfunc">dot</b>(</code>genDType <var class="pdparam">x</var>, genDType <var class="pdparam">y</var><code>)</code>;</p></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="parameters"></a><h2>Parameters</h2><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>x</code></em></span></dt><dd><p>
5 Specifies the first of two vectors
6 </p></dd><dt><span class="term"><em class="parameter"><code>y</code></em></span></dt><dd><p>
7 Specifies the second of two vectors
8 </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
9 <code class="function">dot</code> returns the dot product of two vectors, <em class="parameter"><code>x</code></em> and <em class="parameter"><code>y</code></em>. i.e.,
10 <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
11 <mml:mi>x</mml:mi>
12 <mml:mo stretchy="false">[</mml:mo>
13 <mml:mn>0</mml:mn>
14 <mml:mo stretchy="false">]</mml:mo>
15 <mml:mo lspace="2px" rspace="2px">⋅</mml:mo>
16 <mml:mi>y</mml:mi>
17 <mml:mo stretchy="false">[</mml:mo>
18 <mml:mn>0</mml:mn>
19 <mml:mo stretchy="false">]</mml:mo>
20 <mml:mo>+</mml:mo>
21 <mml:mi>x</mml:mi>
22 <mml:mo stretchy="false">[</mml:mo>
23 <mml:mn>1</mml:mn>
24 <mml:mo stretchy="false">]</mml:mo>
25 <mml:mo lspace="2px" rspace="2px">⋅</mml:mo>
26 <mml:mi>y</mml:mi>
27 <mml:mo stretchy="false">[</mml:mo>
28 <mml:mn>1</mml:mn>
29 <mml:mo stretchy="false">]</mml:mo>
30 <mml:mo>+</mml:mo>
31 <mml:mo lspace="0px" form="infix">...</mml:mo>
32 </mml:math>
33 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="versions"></a><h2>Version Support</h2><div class="informaltable"><table border="1"><colgroup><col align="left" /><col align="center" /><col align="center" /><col align="center" /><col align="center" /><col align="center" /><col align="center" /><col align="center" /><col align="center" /><col align="center" /><col align="center" /></colgroup><thead><tr><th align="left"><span class="bold"><strong>Function</strong></span></th><th align="left"><span class="bold"><strong>Version 1.10</strong></span></th><th align="left"><span class="bold"><strong>Version 1.20</strong></span></th><th align="left"><span class="bold"><strong>Version 1.30</strong></span></th><th align="left"><span class="bold"><strong>Version 1.40</strong></span></th><th align="left"><span class="bold"><strong>Version 1.50</strong></span></th><th align="left"><span class="bold"><strong>Version 3.30</strong></span></th><th align="left"><span class="bold"><strong>Version 4.00</strong></span></th><th align="left"><span class="bold"><strong>Version 4.10</strong></span></th><th align="left"><span class="bold"><strong>Version 4.20</strong></span></th><th align="center"><span class="bold"><strong>Version 4.30</strong></span></th></tr><tr><th align="left">dot (genType)</th><th align="center"><span class="emphasis"><em>Y</em></span></th><th align="center"><span class="emphasis"><em>Y</em></span></th><th align="center"><span class="emphasis"><em>Y</em></span></th><th align="center"><span class="emphasis"><em>Y</em></span></th><th align="center"><span class="emphasis"><em>Y</em></span></th><th align="center"><span class="emphasis"><em>Y</em></span></th><th align="center"><span class="emphasis"><em>Y</em></span></th><th align="center"><span class="emphasis"><em>Y</em></span></th><th align="center"><span class="emphasis"><em>Y</em></span></th><th align="center"><span class="emphasis"><em>Y</em></span></th></tr><tr><th align="left">dot (genDType)</th><th align="center"><span class="emphasis"><em>-</em></span></th><th align="center"><span class="emphasis"><em>-</em></span></th><th align="center"><span class="emphasis"><em>-</em></span></th><th align="center"><span class="emphasis"><em>-</em></span></th><th align="center"><span class="emphasis"><em>-</em></span></th><th align="center"><span class="emphasis"><em>-</em></span></th><th align="center"><span class="emphasis"><em>Y</em></span></th><th align="center"><span class="emphasis"><em>Y</em></span></th><th align="center"><span class="emphasis"><em>Y</em></span></th><th align="center"><span class="emphasis"><em>Y</em></span></th></tr></thead></table></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
34 <a href="cross.xml"><span class="citerefentry"><span class="refentrytitle">cross</span></span></a>
35 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
36 Copyright <span class="trademark"></span>© 2011 Khronos Group.
37 This material may be distributed subject to the terms and conditions set forth in
38 the Open Publication License, v 1.0, 8 June 1999.
39 <a href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
40 </p></div></div></body></html>