rename upstream-man-pages to upstream-doc

[clinton/guile-figl.git] / upstream-doc / manglsl / noise.xml

<?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="noise">\r
    <refmeta>\r
        <refmetainfo>\r
            <copyright>\r
                <year>2011</year>\r
                <holder>Khronos Group</holder>\r
            </copyright>\r
        </refmetainfo>\r
        <refentrytitle>noise</refentrytitle>\r
        <manvolnum>3G</manvolnum>\r
    </refmeta>\r
    <refnamediv>\r
        <refname>noise</refname>\r
        <refpurpose>generate values with a pseudo-random noise function</refpurpose>\r
    </refnamediv>\r
    <refsynopsisdiv><title>Declaration</title>\r
        <funcsynopsis>\r
            <funcprototype>\r
                <funcdef>float <function>noise1</function></funcdef>\r
                <paramdef>genType <parameter>x</parameter></paramdef>\r
            </funcprototype>\r
            <funcprototype>\r
                <funcdef>vec2 <function>noise2</function></funcdef>\r
                <paramdef>genType <parameter>x</parameter></paramdef>\r
            </funcprototype>\r
            <funcprototype>\r
                <funcdef>vec3 <function>noise3</function></funcdef>\r
                <paramdef>genType <parameter>x</parameter></paramdef>\r
            </funcprototype>\r
            <funcprototype>\r
                <funcdef>vec4 <function>noise4</function></funcdef>\r
                <paramdef>genType <parameter>x</parameter></paramdef>\r
            </funcprototype>\r
        </funcsynopsis>\r
    </refsynopsisdiv>\r
    <refsect1 id="parameters"><title>Parameters</title>\r
        <variablelist>\r
        <varlistentry>\r
            <term><parameter>x</parameter></term>\r
            <listitem>\r
                <para>\r
                    Specifies the value to be used to seed the noise function.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        </variablelist>\r
    </refsect1>\r
    <refsect1 id="description"><title>Description</title>\r
        <para>\r
            <function>noise1</function>,  <function>noise2</function>, <function>noise3</function> and <function>noise4</function> return\r
            noise values (vector or scalar) based on the input value <parameter>x</parameter>. The noise function is a stochastic function\r
            that can be used to increase visual complexity. Values returned by the noise functions give the appearance of randomness,\r
            but are not truly random. They are defined to have the following characteristics:\r
        </para>\r
        <para>\r
            <itemizedlist>\r
                <listitem>The return value(s) are always in the range [-1.0,1.0], and cover at least the range [-0.6, 0.6], with a Gaussian-like distribution.</listitem>\r
                <listitem>The return value(s) have an overall average of 0.0.</listitem>\r
                <listitem>They are repeatable, in that a particular input value will always produce the same return value.</listitem>\r
                <listitem>They are statistically invariant under rotation (i.e., no matter how the domain is rotated, it has the same statistical character).</listitem>\r
                <listitem>They have a statistical invariance under translation (i.e., no matter how the domain is translated, it has the same statistical character).</listitem>\r
                <listitem>They typically give different results under translation.</listitem>\r
                <listitem>The spatial frequency is narrowly concentrated, centered somewhere between 0.5 to 1.0.</listitem>\r
                <listitem>They are C1 continuous everywhere (i.e., the first derivative is continuous).</listitem>\r
            </itemizedlist>\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>noise1</entry>#newin11#\r
                    </row>\r
                    <row>\r
                        <entry>noise2</entry>#newin11#\r
                    </row>\r
                    <row>\r
                        <entry>noise3</entry>#newin11#\r
                    </row>\r
                    <row>\r
                        <entry>noise4</entry>#newin11#\r
                    </row>\r
                </thead>\r
            </tgroup>\r
        </informaltable>\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