rename upstream-man-pages to upstream-doc

[clinton/guile-figl.git] / upstream-doc / man3 / glBindBufferBase.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="glBindBufferBase">\r
    <refmeta>\r
        <refmetainfo>\r
            <copyright>\r
                <year>2010</year>\r
                <holder>Khronos Group</holder>\r
            </copyright>\r
        </refmetainfo>\r
        <refentrytitle>glBindBufferBase</refentrytitle>\r
        <manvolnum>3G</manvolnum>\r
    </refmeta>\r
    <refnamediv>\r
        <refname>glBindBufferBase</refname>\r
        <refpurpose>bind a buffer object to an indexed buffer target</refpurpose>\r
    </refnamediv>\r
    <refsynopsisdiv><title>C Specification</title>\r
        <funcsynopsis>\r
            <funcprototype>\r
                <funcdef>void <function>glBindBufferBase</function></funcdef>\r
                <paramdef>GLenum <parameter>target</parameter></paramdef>\r
                <paramdef>GLuint <parameter>index</parameter></paramdef>\r
                <paramdef>GLuint <parameter>buffer</parameter></paramdef>\r
            </funcprototype>\r
        </funcsynopsis>\r
    </refsynopsisdiv>\r
    <refsect1 id="parameters"><title>Parameters</title>\r
        <variablelist>\r
        <varlistentry>\r
            <term><parameter>target</parameter></term>\r
            <listitem>\r
                <para>\r
                    Specify the target of the bind operation. <parameter>target</parameter> must be\r
                    either <constant>GL_TRANSFORM_FEEDBACK_BUFFER</constant> or <constant>GL_UNIFORM_BUFFER</constant>.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        <varlistentry>\r
            <term><parameter>index</parameter></term>\r
            <listitem>\r
                <para>\r
                    Specify the index of the binding point within the array specified by <parameter>target</parameter>.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        <varlistentry>\r
            <term><parameter>buffer</parameter></term>\r
            <listitem>\r
                <para>\r
                    The name of a buffer object to bind to the specified binding point.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        </variablelist>\r
    </refsect1>\r
    <refsect1 id="description"><title>Description</title>\r
        <para>\r
            <function>glBindBufferBase</function> binds the buffer object <parameter>buffer</parameter>\r
            to the binding point at index <parameter>index</parameter> of the array of targets specified\r
            by <parameter>target</parameter>. Each <parameter>target</parameter> represents an indexed\r
            array of buffer binding points, as well as a single general binding point that can be used by\r
            other buffer manipulation functions such as <citerefentry><refentrytitle>glBindBuffer</refentrytitle></citerefentry>\r
            or <citerefentry><refentrytitle>glMapBuffer</refentrytitle></citerefentry>. In addition to binding\r
            <parameter>buffer</parameter> to the indexed buffer binding target, <function>glBindBufferBase</function>\r
            also binds <parameter>buffer</parameter> to the generic buffer binding point specified by <parameter>target</parameter>.\r
        </para>\r
    </refsect1>\r
    <refsect1 id="notes"><title>Notes</title>\r
        <para>\r
            Calling <function>glBindBufferBase</function> is equivalent to calling\r
            <citerefentry><refentrytitle>glBindBufferRange</refentrytitle></citerefentry> with <parameter>offset</parameter>\r
            zero and <parameter>size</parameter> equal to the size of the buffer.\r
        </para>\r
    </refsect1>\r
    <refsect1 id="errors"><title>Errors</title>\r
        <para>\r
            <constant>GL_INVALID_ENUM</constant> is generated if <parameter>target</parameter> is not\r
            <constant>GL_TRANSFORM_FEEDBACK_BUFFER</constant> or <constant>GL_UNIFORM_BUFFER</constant>.\r
        </para>\r
        <para>\r
            <constant>GL_INVALID_VALUE</constant> is generated if <parameter>index</parameter> is greater\r
            than or equal to the number of <parameter>target</parameter>-specific indexed binding points.\r
        </para>\r
        <para>\r
            <constant>GL_INVALID_VALUE</constant> is generated if <parameter>buffer</parameter> does\r
            not have an associated data store, or if the size of that store is zero.\r
        </para>\r
    </refsect1>\r
    <refsect1 id="seealso"><title>See Also</title>\r
        <para>\r
            <citerefentry><refentrytitle>glGenBuffers</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>glDeleteBuffers</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>glBindBuffer</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>glBindBufferRange</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>glMapBuffer</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>glUnmapBuffer</refentrytitle></citerefentry>,\r
        </para>\r
    </refsect1>    <refsect1 id="Copyright"><title>Copyright</title>\r
        <para>\r
            Copyright <trademark class="copyright"></trademark> 2010 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