rename upstream-man-pages to upstream-doc

[clinton/guile-figl.git] / upstream-doc / manglsl / clamp.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="clamp">\r
    <refmeta>\r
        <refmetainfo>\r
            <copyright>\r
                <year>2011</year>\r
                <holder>Khronos Group</holder>\r
            </copyright>\r
        </refmetainfo>\r
        <refentrytitle>clamp</refentrytitle>\r
        <manvolnum>3G</manvolnum>\r
    </refmeta>\r
    <refnamediv>\r
        <refname>clamp</refname>\r
        <refpurpose>constrain a value to lie between two further values</refpurpose>\r
    </refnamediv>\r
    <refsynopsisdiv><title>Declaration</title>\r
        <funcsynopsis>\r
            <funcprototype>\r
                <funcdef>genType <function>clamp</function></funcdef>\r
                <paramdef>genType <parameter>x</parameter></paramdef>\r
                <paramdef>genType <parameter>minVal</parameter></paramdef>\r
                <paramdef>genType <parameter>maxVal</parameter></paramdef>\r
            </funcprototype>\r
        </funcsynopsis>\r
        <funcsynopsis>\r
            <funcprototype>\r
                <funcdef>genType <function>clamp</function></funcdef>\r
                <paramdef>genType <parameter>x</parameter></paramdef>\r
                <paramdef>float <parameter>minVal</parameter></paramdef>\r
                <paramdef>float <parameter>maxVal</parameter></paramdef>\r
            </funcprototype>\r
        </funcsynopsis>\r
        <funcsynopsis>\r
            <funcprototype>\r
                <funcdef>genDType <function>clamp</function></funcdef>\r
                <paramdef>genDType <parameter>x</parameter></paramdef>\r
                <paramdef>genDType <parameter>minVal</parameter></paramdef>\r
                <paramdef>genDType <parameter>maxVal</parameter></paramdef>\r
            </funcprototype>\r
        </funcsynopsis>\r
        <funcsynopsis>\r
            <funcprototype>\r
                <funcdef>genDType <function>clamp</function></funcdef>\r
                <paramdef>genDType <parameter>x</parameter></paramdef>\r
                <paramdef>double <parameter>minVal</parameter></paramdef>\r
                <paramdef>double <parameter>maxVal</parameter></paramdef>\r
            </funcprototype>\r
        </funcsynopsis>\r
        <funcsynopsis>\r
            <funcprototype>\r
                <funcdef>genIType <function>clamp</function></funcdef>\r
                <paramdef>genIType <parameter>x</parameter></paramdef>\r
                <paramdef>genIType <parameter>minVal</parameter></paramdef>\r
                <paramdef>genIType <parameter>maxVal</parameter></paramdef>\r
            </funcprototype>\r
        </funcsynopsis>\r
        <funcsynopsis>\r
            <funcprototype>\r
                <funcdef>genIType <function>clamp</function></funcdef>\r
                <paramdef>genIType <parameter>x</parameter></paramdef>\r
                <paramdef>int <parameter>minVal</parameter></paramdef>\r
                <paramdef>int <parameter>maxVal</parameter></paramdef>\r
            </funcprototype>\r
        </funcsynopsis>\r
        <funcsynopsis>\r
            <funcprototype>\r
                <funcdef>genUType <function>clamp</function></funcdef>\r
                <paramdef>genUType <parameter>x</parameter></paramdef>\r
                <paramdef>genUType <parameter>minVal</parameter></paramdef>\r
                <paramdef>genUType <parameter>maxVal</parameter></paramdef>\r
            </funcprototype>\r
        </funcsynopsis>\r
        <funcsynopsis>\r
            <funcprototype>\r
                <funcdef>genUType <function>clamp</function></funcdef>\r
                <paramdef>genUType <parameter>x</parameter></paramdef>\r
                <paramdef>uint <parameter>minVal</parameter></paramdef>\r
                <paramdef>uint <parameter>maxVal</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
                    Specify the value to constrain.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        <varlistentry>\r
            <term><parameter>minVal</parameter></term>\r
            <listitem>\r
                <para>\r
                    Specify the lower end of the range into which to constrain <parameter>x</parameter>.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        <varlistentry>\r
            <term><parameter>maxVal</parameter></term>\r
            <listitem>\r
                <para>\r
                    Specify the upper end of the range into which to constrain <parameter>x</parameter>.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        </variablelist>\r
    </refsect1>\r
    <refsect1 id="description"><title>Description</title>\r
        <para>\r
            <function>clamp</function> returns the value of <parameter>x</parameter> constrained to the\r
            range <parameter>minVal</parameter> to <parameter>maxVal</parameter>. The returned value is\r
            computed as\r
            <citerefentry><refentrytitle>min</refentrytitle></citerefentry>(<citerefentry><refentrytitle>max</refentrytitle></citerefentry>(<parameter>x</parameter>,\r
            <parameter>minVal</parameter>), <parameter>maxVal</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>clamp (genType)</entry>#newin11#\r
                    </row>\r
                    <row>\r
                        <entry>clamp (genIType)</entry>#newin13#\r
                    </row>\r
                    <row>\r
                        <entry>clamp (genUType)</entry>#newin13#\r
                    </row>\r
                    <row>\r
                        <entry>clamp (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>min</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>max</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