upstream-man-pages/man4/xhtml/glBindVertexBuffer.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd">
   3 <!-- saved from url=(0013)about:internet -->
   4 <?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" pref:renderer="mathplayer-dl"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><link rel="stylesheet" type="text/css" href="opengl-man.css" /><title>glBindVertexBuffer - OpenGL 4 Reference Pages</title><meta name="generator" content="DocBook XSL Stylesheets V1.69.1" /></head><body><div class="refentry" lang="en" xml:lang="en"><a id="glBindVertexBuffer"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glBindVertexBuffer — bind a buffer to a vertex buffer bind point</p></div><div class="refsynopsisdiv"><h2>C Specification</h2><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"><tr><td><code class="funcdef">void <b class="fsfunc">glBindVertexBuffer</b>(</code></td><td>GLuint  </td><td><var class="pdparam">bindingindex</var>, </td></tr><tr><td> </td><td>GLuint  </td><td><var class="pdparam">buffer</var>, </td></tr><tr><td> </td><td>GLintptr  </td><td><var class="pdparam">offset</var>, </td></tr><tr><td> </td><td>GLintptr  </td><td><var class="pdparam">stride</var><code>)</code>;</td></tr></table></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="parameters"></a><h2>Parameters</h2><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>bindingindex</code></em></span></dt><dd><p>
   5                     The index of the vertex buffer binding point to which to bind the buffer.
   6                 </p></dd><dt><span class="term"><em class="parameter"><code>buffer</code></em></span></dt><dd><p>
   7                     The name of an existing buffer to bind to the vertex buffer binding point.
   8                 </p></dd><dt><span class="term"><em class="parameter"><code>offset</code></em></span></dt><dd><p>
   9                     The offset of the first element of the buffer.
  10                 </p></dd><dt><span class="term"><em class="parameter"><code>stride</code></em></span></dt><dd><p>
  11                     The distance between elements within the buffer.
  12                 </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
  13             <code class="function">glBindVertexBuffer</code> binds the buffer named <em class="parameter"><code>buffer</code></em>
  14             to the vertex buffer binding point whose index is given by <em class="parameter"><code>bindingindex</code></em>.
  15             <em class="parameter"><code>offset</code></em> and <em class="parameter"><code>stride</code></em> specify the offset of the first
  16             element within the buffer and the distance between elements within the buffer, respectively, and
  17             are both measured in basic machine units. <em class="parameter"><code>bindingindex</code></em> must be less than
  18             the value of <code class="constant">GL_MAX_VERTEX_ATTRIB_BINDINGS</code>. <em class="parameter"><code>offset</code></em>
  19             and <em class="parameter"><code>stride</code></em> must be greater than or equal to zero. If <em class="parameter"><code>buffer</code></em>
  20             is zero, then any buffer currently bound to the specified binding point is unbound.
  21         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p>
  22             <code class="constant">GL_INVAILD_VALUE</code> is generated if <em class="parameter"><code>bindingindex</code></em> is greater than
  23             or equal to the value of <code class="constant">GL_MAX_VERTEX_ATTRIB_BINDINGS</code>.
  24         </p><p>
  25             <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>offset</code></em> or <em class="parameter"><code>stride</code></em>
  26             is less than zero.
  27         </p><p>
  28             <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>buffer</code></em> is not the name of an
  29             existing buffer object.
  30         </p><p>
  31             <code class="constant">GL_INVALID_OPERATION</code> is generated if no vertex array object is bound.
  32         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="associatedgets"></a><h2>Associated Gets</h2><p>
  33             <a href="glGet.xml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with argument <code class="constant">GL_MAX_VERTEX_ATTRIB_BINDINGS</code>.
  34         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
  35             <a href="glVertexAttribBinding.xml"><span class="citerefentry"><span class="refentrytitle">glVertexAttribBinding</span></span></a>,
  36             <a href="glVertexAttribFormat.xml"><span class="citerefentry"><span class="refentrytitle">glVertexAttribFormat</span></span></a>,
  37             <a href="glVertexAttribPointer.xml"><span class="citerefentry"><span class="refentrytitle">glVertexAttribPointer</span></span></a>,
  38             <a href="glVertexBindingDivisor.xml"><span class="citerefentry"><span class="refentrytitle">glVertexBindingDivisor</span></span></a>.
  39         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
  40             Copyright <span class="trademark"></span>© 2012 Khronos Group.
  41             This material may be distributed subject to the terms and conditions set forth in
  42             the Open Publication License, v 1.0, 8 June 1999.
  43             <a href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
  44         </p></div></div></body></html>