upstream-man-pages/man4/xhtml/glVertexBindingDivisor.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>glVertexBindingDivisor - 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="glVertexBindingDivisor"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glVertexBindingDivisor — modify the rate at which generic vertex attributes advance</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">glVertexBindingDivisor</b>(</code></td><td>GLuint  </td><td><var class="pdparam">bindingindex</var>, </td></tr><tr><td> </td><td>GLuint  </td><td><var class="pdparam">divisor</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 binding whose divisor to modify.
   6                 </p></dd><dt><span class="term"><em class="parameter"><code>divisor</code></em></span></dt><dd><p>
   7                     The new value for the instance step rate to apply.
   8                 </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
   9             <code class="function">glVertexBindingDivisor</code>, modifies the rate at which generic vertex attributes advance when
  10             rendering multiple instances of primitives in a single draw command. If
  11             <em class="parameter"><code>divisor</code></em> is zero, the attributes using the buffer bound to <em class="parameter"><code>bindingindex</code></em>
  12             advance once per vertex. If <em class="parameter"><code>divisor</code></em> is non-zero, the attributes advance
  13             once per <em class="parameter"><code>divisor</code></em> instances of the set(s) of vertices being rendered. An
  14             attribute is referred to as <span class="emphasis"><em>instanced</em></span> if the corresponding <em class="parameter"><code>divisor</code></em>
  15             value is non-zero.
  16         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p>
  17             <code class="constant">GL_INVAILD_VALUE</code> is generated if <em class="parameter"><code>bindingindex</code></em> is greater than
  18             or equal to the value of <code class="constant">GL_MAX_VERTEX_ATTRIB_BINDINGS</code>.
  19         </p><p>
  20             <code class="constant">GL_INVALID_OPERATION</code> is generated if no vertex array object is bound.
  21         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="associatedgets"></a><h2>Associated Gets</h2><p>
  22             <a href="glGet.xml"><span class="citerefentry"><span class="refentrytitle">glGet</span></span></a> with arguments <code class="constant">GL_MAX_VERTEX_ATTRIB_BINDINGS</code>,
  23             <code class="constant">GL_VERTEX_BINDING_DIVISOR</code>.
  24         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
  25             <a href="glBindVertexBuffer.xml"><span class="citerefentry"><span class="refentrytitle">glBindVertexBuffer</span></span></a>,
  26             <a href="glVertexAttribBinding.xml"><span class="citerefentry"><span class="refentrytitle">glVertexAttribBinding</span></span></a>,
  27             <a href="glVertexAttribPointer.xml"><span class="citerefentry"><span class="refentrytitle">glVertexAttribPointer</span></span></a>,
  28             <a href="glVertexBindingDivisor.xml"><span class="citerefentry"><span class="refentrytitle">glVertexBindingDivisor</span></span></a>,
  29             <a href="glVertexAttribPointer.xml"><span class="citerefentry"><span class="refentrytitle">glVertexAttribPointer</span></span></a>.
  30         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
  31             Copyright <span class="trademark"></span>© 2012 Khronos Group.
  32             This material may be distributed subject to the terms and conditions set forth in
  33             the Open Publication License, v 1.0, 8 June 1999.
  34             <a href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
  35         </p></div></div></body></html>