Opentk/Source/Bind/Specifications/Docs/glBindBuffersBase.xml

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
              "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">
<refentry id="glBindBuffersBase">
    <refentryinfo>
        <copyright>
            <year>2013</year>
            <holder>Khronos Group</holder>
        </copyright>
    </refentryinfo>
    <refmeta>
        <refentrytitle>glBindBuffersBase</refentrytitle>
        <manvolnum>3G</manvolnum>
    </refmeta>
    <refnamediv>
        <refname>glBindBuffersBase</refname>
        <refpurpose>bind one or more buffer objects to a sequence of indexed buffer targets</refpurpose>
    </refnamediv>
    <refsynopsisdiv><title>C Specification</title>
        <funcsynopsis>
            <funcprototype>
                <funcdef>void <function>glBindBufferBase</function></funcdef>
                <paramdef>GLenum <parameter>target</parameter></paramdef>
                <paramdef>GLuint <parameter>first</parameter></paramdef>
                <paramdef>GLsizei <parameter>count</parameter></paramdef>
                <paramdef>const GLuint *<parameter>buffers</parameter></paramdef>
            </funcprototype>
        </funcsynopsis>
    </refsynopsisdiv>
    <refsect1 id="parameters"><title>Parameters</title>
        <variablelist>
        <varlistentry>
            <term><parameter>target</parameter></term>
            <listitem>
                <para>
                    Specify the target of the bind operation. <parameter>target</parameter> must be
                    one of <constant>GL_ATOMIC_COUNTER_BUFFER</constant>,
                    <constant>GL_TRANSFORM_FEEDBACK_BUFFER</constant>, <constant>GL_UNIFORM_BUFFER</constant> or
                    <constant>GL_SHADER_STORAGE_BUFFER</constant>.
                </para>
            </listitem>
        </varlistentry>
        <varlistentry>
            <term><parameter>index</parameter></term>
            <listitem>
                <para>
                    Specify the index of the first binding point within the array specified by <parameter>target</parameter>.
                </para>
            </listitem>
        </varlistentry>
        <varlistentry>
            <term><parameter>count</parameter></term>
            <listitem>
                <para>
                    Specify the number of contiguous binding points to which to bind buffers.
                </para>
            </listitem>
        </varlistentry>
        <varlistentry>
            <term><parameter>buffers</parameter></term>
            <listitem>
                <para>
                    A pointer to an array of names of buffer objects to bind to the targets on the specified binding point, or <constant>NULL</constant>.
                </para>
            </listitem>
        </varlistentry>
        </variablelist>
    </refsect1>
    <refsect1 id="description"><title>Description</title>
        <para>
            <function>glBindBuffersBase</function> binds a set of <parameter>count</parameter> buffer objects whose names
            are given in the array <parameter>buffers</parameter> to the <parameter>count</parameter> consecutive binding
            points starting from index <parameter>index</parameter> of the array of targets specified
            by <parameter>target</parameter>. If <parameter>buffers</parameter> is <constant>NULL</constant> then
            <function>glBindBuffersBase</function> unbinds any buffers that are currently bound to the referenced binding points.
            Assuming no errors are generated, it is equivalent to the following
            pseudo-code, which calls <citerefentry><refentrytitle>glBindBufferBase</refentrytitle></citerefentry>:
        </para>
<programlisting><![CDATA[    for (i = 0; i < count; i++)
    {
        if (buffers != NULL)
        {
            glBindBufferBase(target, first + i, buffers[i]);
        }
        else
        {
            glBindBufferBase(target, first + i, 0);
        }
    }]]></programlisting>
    </refsect1>
    <refsect1 id="notes"><title>Notes</title>
        <para>
            <function>glBindBuffersBase</function> is available only if the GL version is 4.4 or higher.
        </para>
    </refsect1>
    <refsect1 id="errors"><title>Errors</title>
        <para>
            <constant>GL_INVALID_ENUM</constant> is generated if <parameter>target</parameter> is not
            <constant>GL_ATOMIC_COUNTER_BUFFER</constant>,
            <constant>GL_TRANSFORM_FEEDBACK_BUFFER</constant>, <constant>GL_UNIFORM_BUFFER</constant> or
            <constant>GL_SHADER_STORAGE_BUFFER</constant>.
        </para>
        <para>
            <constant>GL_INVALID_OPERATION</constant> is generated if <parameter>first</parameter> + <parameter>count</parameter> is greater
            than the number of target-specific indexed binding points.
        </para>
        <para>
            <constant>GL_INVALID_OPERATION</constant> is generated if any value in <parameter>buffers</parameter> is not
            zero or the name of an existing buffer object.
        </para>
    </refsect1>
    <refsect1 id="seealso"><title>See Also</title>
        <para>
            <citerefentry><refentrytitle>glGenBuffers</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>glDeleteBuffers</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>glBindBuffer</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>glBindBufferBase</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>glBindBufferRange</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>glBindBuffersRange</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>glMapBuffer</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>glUnmapBuffer</refentrytitle></citerefentry>
        </para>
    </refsect1>    <refsect1 id="Copyright"><title>Copyright</title>
        <para>
            Copyright <trademark class="copyright"></trademark> 2013 Khronos Group.
            This material may be distributed subject to the terms and conditions set forth in
            the Open Publication License, v 1.0, 8 June 1999.
            <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
        </para>
    </refsect1>
</refentry>