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