Opentk/Source/Bind/Specifications/Docs/ES30/glBindBufferRange.xml

<!DOCTYPE refentry [ <!ENTITY % mathent SYSTEM "math.ent"> %mathent; ]>

<!-- Converted by db4-upgrade version 1.1 -->

<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="glBindBufferRange">
    <info>
        <copyright>
            <year>2010-2014</year>
            <holder>Khronos Group</holder>
        </copyright>
    </info>
    <refmeta>
        <refentrytitle>glBindBufferRange</refentrytitle>
        <manvolnum>3G</manvolnum>
    </refmeta>
    <refnamediv>
        <refname>glBindBufferRange</refname>
        <refpurpose>bind a range within a buffer object to an indexed buffer target</refpurpose>
    </refnamediv>
    <refsynopsisdiv><title>C Specification</title>
        <funcsynopsis>
            <funcprototype>
                <funcdef>void <function>glBindBufferRange</function></funcdef>
                <paramdef>GLenum<parameter>target</parameter></paramdef>
                <paramdef>GLuint<parameter>index</parameter></paramdef>
                <paramdef>GLuint<parameter>buffer</parameter></paramdef>
                <paramdef>GLintptr<parameter>offset</parameter></paramdef>
                <paramdef>GLsizeiptr<parameter>size</parameter></paramdef>
            </funcprototype>
        </funcsynopsis>
    </refsynopsisdiv>
    <refsect1 xml: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
                    either <constant>GL_TRANSFORM_FEEDBACK_BUFFER</constant> or <constant>GL_UNIFORM_BUFFER</constant>.
                </para>
            </listitem>
        </varlistentry>
        <varlistentry>
            <term><parameter>index</parameter></term>
            <listitem>
                <para>
                    Specify the index of the binding point within the array specified by <parameter>target</parameter>.
                </para>
            </listitem>
        </varlistentry>
        <varlistentry>
            <term><parameter>buffer</parameter></term>
            <listitem>
                <para>
                    The name of a buffer object to bind to the specified binding point.
                </para>
            </listitem>
        </varlistentry>
        <varlistentry>
            <term><parameter>offset</parameter></term>
            <listitem>
                <para>
                    The starting offset in basic machine units into the buffer object <parameter>buffer</parameter>.
                </para>
            </listitem>
        </varlistentry>
        <varlistentry>
            <term><parameter>size</parameter></term>
            <listitem>
                <para>
                    The amount of data in machine units that can be read from the buffet object while used as an indexed target.
                </para>
            </listitem>
        </varlistentry>
        </variablelist>
    </refsect1>
    <refsect1 xml:id="description"><title>Description</title>
        <para>
            <function>glBindBufferRange</function> binds a range of the buffer object <parameter>buffer</parameter>
            represented by <parameter>offset</parameter> and <parameter>size</parameter> to the
            binding point at index <parameter>index</parameter> of the array of targets specified by <parameter>target</parameter>.
            Each <parameter>target</parameter> represents an indexed array of buffer binding points, as well
            as a single general binding point that can be used by other buffer manipulation functions such as
            <citerefentry><refentrytitle>glBindBuffer</refentrytitle></citerefentry> or
            <citerefentry><refentrytitle>glMapBufferRange</refentrytitle></citerefentry>. In addition to binding
            a range of <parameter>buffer</parameter> to the indexed buffer binding target, <function>glBindBufferBase</function>
            also binds the range to the generic buffer binding point specified by <parameter>target</parameter>.
        </para>
        <para>
            <parameter>offset</parameter> specifies the offset in basic machine units into the buffer object
            <parameter>buffer</parameter> and <parameter>size</parameter> specifies the amount of data that
            can be read from the buffer object while used as an indexed target.
        </para>
    </refsect1>
    <refsect1 xml:id="errors"><title>Errors</title>
        <para>
            <constant>GL_INVALID_ENUM</constant> is generated if <parameter>target</parameter> is not
            <constant>GL_TRANSFORM_FEEDBACK_BUFFER</constant> or <constant>GL_UNIFORM_BUFFER</constant>.
        </para>
        <para>
            <constant>GL_INVALID_VALUE</constant> is generated if <parameter>target</parameter> is
                        <constant>GL_TRANSFORM_FEEDBACK_BUFFER</constant> and<parameter>index</parameter> is greater
            than or equal to  <constant>GL_MAX_TRANSFORM_FEEDBACK_SEPARATE_ATTRIBS</constant>.
        </para>
        <para>
            <constant>GL_INVALID_VALUE</constant> is generated if <parameter>target</parameter> is
                        <constant>GL_UNIFORM_BUFFER</constant> and<parameter>index</parameter> is greater
            than or equal to  <constant>GL_MAX_UNIFORM_BUFFER_BINDINGS</constant>.
        </para>
        <para>
            <constant>GL_INVALID_VALUE</constant> is generated if <parameter>buffer</parameter> is not
            zero and <parameter>size</parameter> is less than or equal to zero.
        </para>
        <para>
            <constant>GL_INVALID_VALUE</constant> is generated if <parameter>target</parameter> is
                        <constant>GL_TRANSFORM_FEEDBACK_BUFFER</constant> and <parameter>size</parameter> or
                        <parameter>offset</parameter> are not multiples of 4.
        </para>
        <para>
            <constant>GL_INVALID_VALUE</constant> is generated if <parameter>target</parameter> is
                        <constant>GL_UNIFORM_BUFFER</constant> and <parameter>offset</parameter> is not a multiple of
                        <constant>GL_UNIFORM_BUFFER_OFFSET_ALIGNMENT</constant>.
        </para>
    </refsect1>
    <refsect1 xml:id="associatedgets"><title>Associated Gets</title>
        <para>
            <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_MAX_UNIFORM_BUFFER_BINDINGS</constant>,
                        <constant>GL_MAX_TRANSFORM_FEEDBACK_SEPARATE_ATTRIBS</constant>, or <constant>GL_UNIFORM_BUFFER_OFFSET_ALIGNMENT</constant>.
        </para>
    </refsect1>
    <refsect1 xml:id="versions">
        <title>API Version Support</title>
        <informaltable>
            <tgroup cols="3" align="left">
                <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="apifunchead.xml" xpointer="xpointer(/*/*)"/>
                <tbody>
                    <row>
                        <entry>glBindBufferRange</entry>
                        <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="apiversion.xml" xpointer="xpointer(/*/*[@role='es30']/*)"/>
                    </row>
                </tbody>
            </tgroup>
        </informaltable>
    </refsect1>
    <refsect1 xml: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>glMapBufferRange</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>glUnmapBuffer</refentrytitle></citerefentry>,
        </para>
    </refsect1>
    <refsect1 xml:id="Copyright"><title>Copyright</title>
        <para>
            Copyright <trademark class="copyright"/> 2010-2014 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.
            <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://opencontent.org/openpub/">http://opencontent.org/openpub/</link>.
        </para>
    </refsect1>
</refentry>