rename upstream-man-pages to upstream-doc

[clinton/guile-figl.git] / upstream-man-pages / manglsl / smoothstep.xml

diff --git a/upstream-man-pages/manglsl/smoothstep.xml b/upstream-man-pages/manglsl/smoothstep.xml
deleted file mode 100644 (file)
index d227d52..0000000
--- a/upstream-man-pages/manglsl/smoothstep.xml
+++ /dev/null
@@ -1,127 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>\r
-<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"\r
-              "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">\r
-<refentry id="smoothstep">\r
-    <refmeta>\r
-        <refmetainfo>\r
-            <copyright>\r
-                <year>2011</year>\r
-                <holder>Khronos Group</holder>\r
-            </copyright>\r
-        </refmetainfo>\r
-        <refentrytitle>smoothstep</refentrytitle>\r
-        <manvolnum>3G</manvolnum>\r
-    </refmeta>\r
-    <refnamediv>\r
-        <refname>smoothstep</refname>\r
-        <refpurpose>perform Hermite interpolation between two values</refpurpose>\r
-    </refnamediv>\r
-    <refsynopsisdiv><title>Declaration</title>\r
-        <funcsynopsis>\r
-            <funcprototype>\r
-                <funcdef>genType <function>smoothstep</function></funcdef>\r
-                <paramdef>genType <parameter>edge0</parameter></paramdef>\r
-                <paramdef>genType <parameter>edge1</parameter></paramdef>\r
-                <paramdef>genType <parameter>x</parameter></paramdef>\r
-            </funcprototype>\r
-        </funcsynopsis>\r
-        <funcsynopsis>\r
-            <funcprototype>\r
-                <funcdef>genType <function>smoothstep</function></funcdef>\r
-                <paramdef>float <parameter>edge0</parameter></paramdef>\r
-                <paramdef>float <parameter>edge1</parameter></paramdef>\r
-                <paramdef>genType <parameter>x</parameter></paramdef>\r
-            </funcprototype>\r
-        </funcsynopsis>\r
-        <funcsynopsis>\r
-            <funcprototype>\r
-                <funcdef>genDType <function>smoothstep</function></funcdef>\r
-                <paramdef>genDType <parameter>edge0</parameter></paramdef>\r
-                <paramdef>genDType <parameter>edge1</parameter></paramdef>\r
-                <paramdef>genDType <parameter>x</parameter></paramdef>\r
-            </funcprototype>\r
-        </funcsynopsis>\r
-        <funcsynopsis>\r
-            <funcprototype>\r
-                <funcdef>genDType <function>smoothstep</function></funcdef>\r
-                <paramdef>double <parameter>edge0</parameter></paramdef>\r
-                <paramdef>double <parameter>edge1</parameter></paramdef>\r
-                <paramdef>genDType <parameter>x</parameter></paramdef>\r
-            </funcprototype>\r
-        </funcsynopsis>\r
-    </refsynopsisdiv>\r
-    <refsect1 id="parameters"><title>Parameters</title>\r
-        <variablelist>\r
-        <varlistentry>\r
-            <term><parameter>edge0</parameter></term>\r
-            <listitem>\r
-                <para>\r
-                    Specifies the value of the lower edge of the Hermite function.\r
-                </para>\r
-            </listitem>\r
-        </varlistentry>\r
-        <varlistentry>\r
-            <term><parameter>edge1</parameter></term>\r
-            <listitem>\r
-                <para>\r
-                    Specifies the value of the upper edge of the Hermite function.\r
-                </para>\r
-            </listitem>\r
-        </varlistentry>\r
-        <varlistentry>\r
-            <term><parameter>x</parameter></term>\r
-            <listitem>\r
-                <para>\r
-                    Specifies the source value for interpolation.\r
-                </para>\r
-            </listitem>\r
-        </varlistentry>\r
-        </variablelist>\r
-    </refsect1>\r
-    <refsect1 id="description"><title>Description</title>\r
-        <para>\r
-            <function>smoothstep</function> performs smooth Hermite interpolation between 0 and\r
-            1 when <parameter>edge0</parameter> &lt; <parameter>x</parameter> &lt; <parameter>edge1</parameter>.\r
-            This is useful in cases where a threshold function with a smooth transition is desired.\r
-            <function>smoothstep</function> is equivalent to:\r
-        </para>\r
-        <para>\r
-<programlisting><![CDATA[    genType t;  /* Or genDType t; */\r
-    t = clamp((x - edge0) / (edge1 - edge0), 0.0, 1.0);\r
-    return t * t * (3.0 - 2.0 * t);\r
-]]></programlisting>\r
-        </para>\r
-        <para>\r
-            Results are undefined if <parameter>edge0</parameter> &ge; <parameter>edge1</parameter>.\r
-        </para>\r
-    </refsect1>\r
-    <refsect1 id="versions"><title>Version Support</title>\r
-        <informaltable frame="topbot">\r
-            #VARTABLECOLS#\r
-                <thead>\r
-                    #FUNCTABLEHEADER#\r
-                    <row>\r
-                        <entry>smoothstep (genType)</entry>#newin13#\r
-                    </row>\r
-                    <row>\r
-                        <entry>smoothstep (genDType)</entry>#newin40#\r
-                    </row>\r
-                </thead>\r
-            </tgroup>\r
-        </informaltable>\r
-    </refsect1>\r
-    <refsect1 id="seealso"><title>See Also</title>\r
-        <para>\r
-            <citerefentry><refentrytitle>mix</refentrytitle></citerefentry>,\r
-            <citerefentry><refentrytitle>step</refentrytitle></citerefentry>\r
-        </para>\r
-    </refsect1>\r
-    <refsect1 id="Copyright"><title>Copyright</title>\r
-        <para>\r
-            Copyright <trademark class="copyright"></trademark> 2011 Khronos Group. \r
-            This material may be distributed subject to the terms and conditions set forth in \r
-            the Open Publication License, v 1.0, 8 June 1999.\r
-            <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.\r
-        </para>\r
-    </refsect1>\r
-</refentry>\r