rename upstream-man-pages to upstream-doc

[clinton/guile-figl.git] / upstream-doc / manglsl / bitfieldInsert.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="bitfieldInsert">\r
    <refmeta>\r
        <refmetainfo>\r
            <copyright>\r
                <year>2011</year>\r
                <holder>Khronos Group</holder>\r
            </copyright>\r
        </refmetainfo>\r
        <refentrytitle>bitfieldInsert</refentrytitle>\r
        <manvolnum>3G</manvolnum>\r
    </refmeta>\r
    <refnamediv>\r
        <refname>bitfieldInsert</refname>\r
        <refpurpose>insert a range of bits into an integer</refpurpose>\r
    </refnamediv>\r
    <refsynopsisdiv><title>Declaration</title>\r
        <funcsynopsis>\r
            <funcprototype>\r
                <funcdef>genIType <function>bitfieldInsert</function></funcdef>\r
                <paramdef>genIType <parameter>base</parameter></paramdef>\r
                <paramdef>genIType <parameter>insert</parameter></paramdef>\r
                <paramdef>int <parameter>offset</parameter></paramdef>\r
                <paramdef>int <parameter>bits</parameter></paramdef>\r
            </funcprototype>            <funcprototype>\r
                <funcdef>genUType <function>bitfieldInsert</function></funcdef>\r
                <paramdef>genUType <parameter>base</parameter></paramdef>\r
                <paramdef>genUType <parameter>insert</parameter></paramdef>\r
                <paramdef>int <parameter>offset</parameter></paramdef>\r
                <paramdef>int <parameter>bits</parameter></paramdef>\r
            </funcprototype>\r
        </funcsynopsis>\r
    </refsynopsisdiv>\r
    <refsect1 id="parameters"><title>Parameters</title>\r
        <variablelist>\r
        <varlistentry>\r
            <term><parameter>base</parameter></term>\r
            <listitem>\r
                <para>\r
                    Specifies the integer into which to insert <parameter>insert</parameter>.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        <varlistentry>\r
            <term><parameter>insert</parameter></term>\r
            <listitem>\r
                <para>\r
                    Specifies the the value of the bits to insert.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        <varlistentry>\r
            <term><parameter>offset</parameter></term>\r
            <listitem>\r
                <para>\r
                    Specifies the index of the first bit to insert.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        <varlistentry>\r
            <term><parameter>bits</parameter></term>\r
            <listitem>\r
                <para>\r
                    Specifies the number of bits to insert.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        </variablelist>\r
    </refsect1>\r
    <refsect1 id="description"><title>Description</title>\r
        <para>\r
            <function>bitfieldInsert</function> inserts the <parameter>bits</parameter> least significant bits of <parameter>insert</parameter>\r
            into <parameter>base</parameter> at offset <parameter>offset</parameter>. The returned value will have bits\r
            [<parameter>offset</parameter>, <parameter>offset</parameter> + <parameter>bits</parameter> + 1] taken from [0, <parameter>bits</parameter> - 1]\r
            of <parameter>insert</parameter> and all other bits taken directly from the corresponding bits of <parameter>base</parameter>. If\r
            <parameter>bits</parameter> is zero, the result will simply be the original value of <parameter>base</parameter>. The result will\r
            be undefined if <parameter>offset</parameter> or <parameter>bits</parameter> is negative, or if the sum of <parameter>offset</parameter>\r
            and <parameter>bits</parameter> is greater than the number of bits used to store the operand.\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>bitfieldInsert</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>bitfieldExtract</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