upstream-man-pages/manglsl/distance.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="distance">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>2011</year>
   9                 <holder>Khronos Group</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>distance</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>distance</refname>
  17         <refpurpose>calculate the distance between two points</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>Declaration</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>float <function>distance</function></funcdef>
  23                 <paramdef>genType <parameter>p0</parameter></paramdef>
  24                 <paramdef>genType <parameter>p1</parameter></paramdef>
  25             </funcprototype>
  26             <funcprototype>
  27                 <funcdef>double <function>distance</function></funcdef>
  28                 <paramdef>genDType <parameter>p0</parameter></paramdef>
  29                 <paramdef>genDType <parameter>p1</parameter></paramdef>
  30             </funcprototype>
  31         </funcsynopsis>
  32     </refsynopsisdiv>
  33     <refsect1 id="parameters"><title>Parameters</title>
  34         <variablelist>
  35         <varlistentry>
  36             <term><parameter>p0</parameter></term>
  37             <listitem>
  38                 <para>
  39                     Specifies the first of two points
  40                 </para>
  41             </listitem>
  42         </varlistentry>
  43         <varlistentry>
  44             <term><parameter>p1</parameter></term>
  45             <listitem>
  46                 <para>
  47                     Specifies the second of two points
  48                 </para>
  49             </listitem>
  50         </varlistentry>
  51         </variablelist>
  52     </refsect1>
  53     <refsect1 id="description"><title>Description</title>
  54         <para>
  55             <function>distance</function> returns the distance between the two points <parameter>p0</parameter> and <parameter>p1</parameter>. i.e.,
  56             <code><citerefentry><refentrytitle>length</refentrytitle></citerefentry>(<parameter>p0</parameter>, <parameter>p1</parameter>);</code>
  57         </para>
  58     </refsect1>
  59     <refsect1 id="versions"><title>Version Support</title>
  60         <informaltable frame="topbot">
  61             #VARTABLECOLS#
  62                 <thead>
  63                     #FUNCTABLEHEADER#
  64                     <row>
  65                         <entry>distance (genType)</entry>#newin11#
  66                     </row>
  67                     <row>
  68                         <entry>distance (genDType)</entry>#newin40#
  69                     </row>
  70                 </thead>
  71             </tgroup>
  72         </informaltable>
  73     </refsect1>
  74     <refsect1 id="seealso"><title>See Also</title>
  75         <para>
  76             <citerefentry><refentrytitle>length</refentrytitle></citerefentry>,
  77             <citerefentry><refentrytitle>normalize</refentrytitle></citerefentry>
  78         </para>
  79     </refsect1>
  80     <refsect1 id="Copyright"><title>Copyright</title>
  81         <para>
  82             Copyright <trademark class="copyright"></trademark> 2011 Khronos Group.
  83             This material may be distributed subject to the terms and conditions set forth in
  84             the Open Publication License, v 1.0, 8 June 1999.
  85             <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
  86         </para>
  87     </refsect1>
  88 </refentry>