143 lines
7.1 KiB
XML
143 lines
7.1 KiB
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="glBindBufferRange">
|
|
<refentryinfo>
|
|
<copyright>
|
|
<year>2010-2013</year>
|
|
<holder>Khronos Group</holder>
|
|
</copyright>
|
|
</refentryinfo>
|
|
<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 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 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 id="description"><title>Description</title>
|
|
<para>
|
|
<function>glBindBufferRange</function> binds a range 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>glMapBuffer</refentrytitle></citerefentry>. In addition to binding
|
|
a range of <parameter>buffer</parameter> to the indexed buffer binding target, <function>glBindBufferRange</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 id="notes"><title>Notes</title>
|
|
<para>
|
|
The <constant>GL_ATOMIC_COUNTER_BUFFER</constant> target is available only if the GL version is 4.2 or greater.
|
|
</para>
|
|
<para>
|
|
The <constant>GL_SHADER_STORAGE_BUFFER</constant> target is available only if the GL version is 4.3 or greater.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 id="errors"><title>Errors</title>
|
|
<para>
|
|
<constant>GL_INVALID_ENUM</constant> is generated if <parameter>target</parameter> is not
|
|
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>
|
|
<para>
|
|
<constant>GL_INVALID_VALUE</constant> is generated if <parameter>index</parameter> is greater
|
|
than or equal to the number of <parameter>target</parameter>-specific indexed binding points.
|
|
</para>
|
|
<para>
|
|
<constant>GL_INVALID_VALUE</constant> is generated if <parameter>size</parameter> is less than
|
|
or equal to zero, or if <parameter>offset</parameter> + <parameter>size</parameter> is greater
|
|
than the value of <constant>GL_BUFFER_SIZE</constant>.
|
|
</para>
|
|
<para>
|
|
Additional errors may be generated if <parameter>offset</parameter> violates any
|
|
<parameter>target</parameter>-specific alignmemt restrictions.
|
|
</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>glMapBuffer</refentrytitle></citerefentry>,
|
|
<citerefentry><refentrytitle>glUnmapBuffer</refentrytitle></citerefentry>,
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 id="Copyright"><title>Copyright</title>
|
|
<para>
|
|
Copyright <trademark class="copyright"></trademark> 2010-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>
|