Opentk/Source/Bind/Specifications/Docs/glBindVertexBuffer.xml
Stefanos A 60f971ffed Updated to the latest gl4 specs and docs
Large code-drop from Khronos upstream.
2013-11-03 12:43:50 +01:00

117 lines
5.3 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="glBindVertexBuffer">
<refentryinfo>
<copyright>
<year>2013</year>
<holder>Khronos Group</holder>
</copyright>
</refentryinfo>
<refmeta>
<refentrytitle>glBindVertexBuffer</refentrytitle>
<manvolnum>3G</manvolnum>
</refmeta>
<refnamediv>
<refname>glBindVertexBuffer</refname>
<refpurpose>bind a buffer to a vertex buffer bind point</refpurpose>
</refnamediv>
<refsynopsisdiv><title>C Specification</title>
<funcsynopsis>
<funcprototype>
<funcdef>void <function>glBindVertexBuffer</function></funcdef>
<paramdef>GLuint <parameter>bindingindex</parameter></paramdef>
<paramdef>GLuint <parameter>buffer</parameter></paramdef>
<paramdef>GLintptr <parameter>offset</parameter></paramdef>
<paramdef>GLintptr <parameter>stride</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="parameters"><title>Parameters</title>
<variablelist>
<varlistentry>
<term><parameter>bindingindex</parameter></term>
<listitem>
<para>
The index of the vertex buffer binding point to which to bind the buffer.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>buffer</parameter></term>
<listitem>
<para>
The name of an existing buffer to bind to the vertex buffer binding point.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>offset</parameter></term>
<listitem>
<para>
The offset of the first element of the buffer.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>stride</parameter></term>
<listitem>
<para>
The distance between elements within the buffer.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 id="description"><title>Description</title>
<para>
<function>glBindVertexBuffer</function> binds the buffer named <parameter>buffer</parameter>
to the vertex buffer binding point whose index is given by <parameter>bindingindex</parameter>.
<parameter>offset</parameter> and <parameter>stride</parameter> specify the offset of the first
element within the buffer and the distance between elements within the buffer, respectively, and
are both measured in basic machine units. <parameter>bindingindex</parameter> must be less than
the value of <constant>GL_MAX_VERTEX_ATTRIB_BINDINGS</constant>. <parameter>offset</parameter>
and <parameter>stride</parameter> must be greater than or equal to zero. If <parameter>buffer</parameter>
is zero, then any buffer currently bound to the specified binding point is unbound.
</para>
</refsect1>
<refsect1 id="errors"><title>Errors</title>
<para>
<constant>GL_INVAILD_VALUE</constant> is generated if <parameter>bindingindex</parameter> is greater than
or equal to the value of <constant>GL_MAX_VERTEX_ATTRIB_BINDINGS</constant>.
</para>
<para>
<constant>GL_INVALID_VALUE</constant> is generated if <parameter>offset</parameter> or <parameter>stride</parameter>
is less than zero.
</para>
<para>
<constant>GL_INVALID_VALUE</constant> is generated if <parameter>buffer</parameter> is not the name of an
existing buffer object.
</para>
<para>
<constant>GL_INVALID_OPERATION</constant> is generated if no vertex array object is bound.
</para>
</refsect1>
<refsect1 id="associatedgets"><title>Associated Gets</title>
<para>
<citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_MAX_VERTEX_ATTRIB_BINDINGS</constant>.
</para>
</refsect1>
<refsect1 id="seealso"><title>See Also</title>
<para>
<citerefentry><refentrytitle>glVertexAttribBinding</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glVertexAttribFormat</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glVertexAttribPointer</refentrytitle></citerefentry>,
<citerefentry><refentrytitle>glVertexBindingDivisor</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>