upstream-man-pages/manglsl/xhtml/length.xml

   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>length - 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="length"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>length — calculate the length of a vector</p></div><div class="refsynopsisdiv"><h2>Declaration</h2><div class="funcsynopsis"><p><code class="funcdef">float <b class="fsfunc">length</b>(</code>genType <var class="pdparam">x</var><code>)</code>;</p><p><code class="funcdef">double <b class="fsfunc">length</b>(</code>genDType <var class="pdparam">x</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 a vector of which to calculate the length.
   6                 </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
   7             <code class="function">length</code> returns the length of the vector. i.e.,
   8             <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
   9                 <mml:apply>
  10                     <mml:root definitionURL="" encoding=""></mml:root>
  11                     <mml:csymbol encoding="" definitionURL="">
  12                         <mml:msup>
  13                             <mml:mrow>
  14                                 <mml:mi>x</mml:mi><mml:mo stretchy="false">[</mml:mo><mml:mn>0</mml:mn><mml:mo stretchy="false">]</mml:mo>
  15                             </mml:mrow>
  16                             <mml:mn>2</mml:mn>
  17                         </mml:msup>
  18                         <mml:mo>+</mml:mo>
  19                         <mml:msup>
  20                             <mml:mrow>
  21                                 <mml:mi>x</mml:mi><mml:mo stretchy="false">[</mml:mo><mml:mn>1</mml:mn><mml:mo stretchy="false">]</mml:mo>
  22                             </mml:mrow>
  23                             <mml:mn>2</mml:mn>
  24                         </mml:msup>
  25                         <mml:mo>+</mml:mo>
  26                         <mml:mo lspace="0px" form="infix">...</mml:mo>
  27                     </mml:csymbol>
  28                 </mml:apply>
  29             </mml:math>
  30         </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">length (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">length (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>
  31             <a href="distance.xml"><span class="citerefentry"><span class="refentrytitle">distance</span></span></a>,
  32             <a href="normalize.xml"><span class="citerefentry"><span class="refentrytitle">normalize</span></span></a>
  33         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
  34             Copyright <span class="trademark"></span>© 2011 Khronos Group.
  35             This material may be distributed subject to the terms and conditions set forth in
  36             the Open Publication License, v 1.0, 8 June 1999.
  37             <a href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
  38         </p></div></div></body></html>