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="faceforward">\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>faceforward</refentrytitle>\r | |
| 13 | <manvolnum>3G</manvolnum>\r | |
| 14 | </refmeta>\r | |
| 15 | <refnamediv>\r | |
| 16 | <refname>faceforward</refname>\r | |
| 17 | <refpurpose>return a vector pointing in the same direction as another</refpurpose>\r | |
| 18 | </refnamediv>\r | |
| 19 | <refsynopsisdiv><title>Declaration</title>\r | |
| 20 | <funcsynopsis>\r | |
| 21 | <funcprototype>\r | |
| 22 | <funcdef>genType <function>faceforward</function></funcdef>\r | |
| 23 | <paramdef>genType <parameter>N</parameter></paramdef>\r | |
| 24 | <paramdef>genType <parameter>I</parameter></paramdef>\r | |
| 25 | <paramdef>genType <parameter>Nref</parameter></paramdef>\r | |
| 26 | </funcprototype>\r | |
| 27 | <funcprototype>\r | |
| 28 | <funcdef>genDType <function>faceforward</function></funcdef>\r | |
| 29 | <paramdef>genDType <parameter>N</parameter></paramdef>\r | |
| 30 | <paramdef>genDType <parameter>I</parameter></paramdef>\r | |
| 31 | <paramdef>genDType <parameter>Nref</parameter></paramdef>\r | |
| 32 | </funcprototype>\r | |
| 33 | </funcsynopsis>\r | |
| 34 | </refsynopsisdiv>\r | |
| 35 | <refsect1 id="parameters"><title>Parameters</title>\r | |
| 36 | <variablelist>\r | |
| 37 | <varlistentry>\r | |
| 38 | <term><parameter>N</parameter></term>\r | |
| 39 | <listitem>\r | |
| 40 | <para>\r | |
| 41 | Specifies the vector to orient.\r | |
| 42 | </para>\r | |
| 43 | </listitem>\r | |
| 44 | </varlistentry>\r | |
| 45 | <varlistentry>\r | |
| 46 | <term><parameter>I</parameter></term>\r | |
| 47 | <listitem>\r | |
| 48 | <para>\r | |
| 49 | Specifies the incident vector.\r | |
| 50 | </para>\r | |
| 51 | </listitem>\r | |
| 52 | </varlistentry>\r | |
| 53 | <varlistentry>\r | |
| 54 | <term><parameter>Nref</parameter></term>\r | |
| 55 | <listitem>\r | |
| 56 | <para>\r | |
| 57 | Specifies the reference vector.\r | |
| 58 | </para>\r | |
| 59 | </listitem>\r | |
| 60 | </varlistentry>\r | |
| 61 | </variablelist>\r | |
| 62 | </refsect1>\r | |
| 63 | <refsect1 id="description"><title>Description</title>\r | |
| 64 | <para>\r | |
| 65 | <function>faceforward</function> orients a vector to point away from a surface as defined by its normal.\r | |
| 66 | If <citerefentry><refentrytitle>dot</refentrytitle></citerefentry><code>(<parameter>Nref</parameter>, <parameter>I</parameter>) < 0</code>\r | |
| 67 | <function>faceforward</function> returns <parameter>N</parameter>, otherwise it returns <code>-<parameter>N</parameter></code>.\r | |
| 68 | </para>\r | |
| 69 | </refsect1>\r | |
| 70 | <refsect1 id="versions"><title>Version Support</title>\r | |
| 71 | <informaltable frame="topbot">\r | |
| 72 | #VARTABLECOLS#\r | |
| 73 | <thead>\r | |
| 74 | #FUNCTABLEHEADER#\r | |
| 75 | <row>\r | |
| 76 | <entry>faceforward (genType)</entry>#newin11#\r | |
| 77 | </row>\r | |
| 78 | <row>\r | |
| 79 | <entry>faceforward (genDType)</entry>#newin40#\r | |
| 80 | </row>\r | |
| 81 | </thead>\r | |
| 82 | </tgroup>\r | |
| 83 | </informaltable>\r | |
| 84 | </refsect1>\r | |
| 85 | <refsect1 id="seealso"><title>See Also</title>\r | |
| 86 | <para>\r | |
| 87 | <citerefentry><refentrytitle>reflect</refentrytitle></citerefentry>,\r | |
| 88 | <citerefentry><refentrytitle>refract</refentrytitle></citerefentry>\r | |
| 89 | </para>\r | |
| 90 | </refsect1>\r | |
| 91 | <refsect1 id="Copyright"><title>Copyright</title>\r | |
| 92 | <para>\r | |
| 93 | Copyright <trademark class="copyright"></trademark> 2011 Khronos Group. \r | |
| 94 | This material may be distributed subject to the terms and conditions set forth in \r | |
| 95 | the Open Publication License, v 1.0, 8 June 1999.\r | |
| 96 | <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.\r | |
| 97 | </para>\r | |
| 98 | </refsect1>\r | |
| 99 | </refentry>\r |