upstream-man-pages/man4/xhtml/glPrimitiveRestartIndex.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>glPrimitiveRestartIndex - 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="glPrimitiveRestartIndex"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glPrimitiveRestartIndex — specify the primitive restart index</p></div><div class="refsynopsisdiv"><h2>C Specification</h2><div class="funcsynopsis"><p><code class="funcdef">void <b class="fsfunc">glPrimitiveRestartIndex</b>(</code>GLuint <var class="pdparam">index</var><code>)</code>;</p></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>index</code></em></span></dt><dd><p>
   5                     Specifies the value to be interpreted as the primitive restart index.
   6                 </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
   7             <code class="function">glPrimitiveRestartIndex</code> specifies a vertex array element that is treated specially when
   8             primitive restarting is enabled. This is known as the primitive restart index.
   9         </p><p>
  10             When one of the <code class="function">Draw*</code> commands transfers a set of generic attribute array elements to
  11             the GL, if the index within the vertex arrays corresponding to that set is equal to the primitive restart
  12             index, then the GL does not process those elements as a vertex. Instead, it is as if the drawing command
  13             ended with the immediately preceding transfer, and another drawing command is immediately started with
  14             the same parameters, but only transferring the immediately following element through the end of the
  15             originally specified elements.
  16         </p><p>
  17             When either <a href="glDrawElementsBaseVertex.xml"><span class="citerefentry"><span class="refentrytitle">glDrawElementsBaseVertex</span></span></a>,
  18             <a href="glDrawElementsInstancedBaseVertex.xml"><span class="citerefentry"><span class="refentrytitle">glDrawElementsInstancedBaseVertex</span></span></a> or
  19             <a href="glMultiDrawElementsBaseVertex.xml"><span class="citerefentry"><span class="refentrytitle">glMultiDrawElementsBaseVertex</span></span></a> is used, the primitive restart
  20             comparison occurs before the basevertex offset is added to the array index.
  21         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="notes"></a><h2>Notes</h2><p>
  22             <code class="function">glPrimitiveRestartIndex</code> is available only if the GL version is 3.1 or greater.
  23         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
  24             <a href="glDrawArrays.xml"><span class="citerefentry"><span class="refentrytitle">glDrawArrays</span></span></a>,
  25             <a href="glDrawElements.xml"><span class="citerefentry"><span class="refentrytitle">glDrawElements</span></span></a>,
  26             <a href="glDrawElementsBaseVertex.xml"><span class="citerefentry"><span class="refentrytitle">glDrawElementsBaseVertex</span></span></a>,
  27             <a href="glDrawElementsInstancedBaseVertex.xml"><span class="citerefentry"><span class="refentrytitle">glDrawElementsInstancedBaseVertex</span></span></a>
  28         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
  29             Copyright <span class="trademark"></span>© 2010 Khronos Group.
  30             This material may be distributed subject to the terms and conditions set forth in
  31             the Open Publication License, v 1.0, 8 June 1999.
  32             <a href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
  33         </p></div></div></body></html>