HCoop / clinton / guile-figl.git / blame
| Commit | Line | Data |
|---|---|---|
| 7faf1d71 AW |
1 | <?xml version="1.0" encoding="UTF-8"?>\r |
| 2 | <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"\r | |
| 3 | "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">\r | |
| 4 | <refentry id="glPrimitiveRestartIndex">\r | |
| 5 | <refmeta>\r | |
| 6 | <refmetainfo>\r | |
| 7 | <copyright>\r | |
| 8 | <year>2010</year>\r | |
| 9 | <holder>Khronos Group</holder>\r | |
| 10 | </copyright>\r | |
| 11 | </refmetainfo>\r | |
| 12 | <refentrytitle>glPrimitiveRestartIndex</refentrytitle>\r | |
| 13 | <manvolnum>3G</manvolnum>\r | |
| 14 | </refmeta>\r | |
| 15 | <refnamediv>\r | |
| 16 | <refname>glPrimitiveRestartIndex</refname>\r | |
| 17 | <refpurpose>specify the primitive restart index</refpurpose>\r | |
| 18 | </refnamediv>\r | |
| 19 | <refsynopsisdiv><title>C Specification</title>\r | |
| 20 | <funcsynopsis>\r | |
| 21 | <funcprototype>\r | |
| 22 | <funcdef>void <function>glPrimitiveRestartIndex</function></funcdef>\r | |
| 23 | <paramdef>GLuint <parameter>index</parameter></paramdef>\r | |
| 24 | </funcprototype>\r | |
| 25 | </funcsynopsis>\r | |
| 26 | </refsynopsisdiv>\r | |
| 27 | <refsect1 id="parameters"><title>Parameters</title>\r | |
| 28 | <variablelist>\r | |
| 29 | <varlistentry>\r | |
| 30 | <term><parameter>index</parameter></term>\r | |
| 31 | <listitem>\r | |
| 32 | <para>\r | |
| 33 | Specifies the value to be interpreted as the primitive restart index.\r | |
| 34 | </para>\r | |
| 35 | </listitem>\r | |
| 36 | </varlistentry>\r | |
| 37 | </variablelist>\r | |
| 38 | </refsect1>\r | |
| 39 | <refsect1 id="description"><title>Description</title>\r | |
| 40 | <para>\r | |
| 41 | <function>glPrimitiveRestartIndex</function> specifies a vertex array element that is treated specially when\r | |
| 42 | primitive restarting is enabled. This is known as the primitive restart index.\r | |
| 43 | </para>\r | |
| 44 | <para>\r | |
| 45 | When one of the <function>Draw*</function> commands transfers a set of generic attribute array elements to\r | |
| 46 | the GL, if the index within the vertex arrays corresponding to that set is equal to the primitive restart\r | |
| 47 | index, then the GL does not process those elements as a vertex. Instead, it is as if the drawing command\r | |
| 48 | ended with the immediately preceding transfer, and another drawing command is immediately started with\r | |
| 49 | the same parameters, but only transferring the immediately following element through the end of the\r | |
| 50 | originally specified elements.\r | |
| 51 | </para>\r | |
| 52 | <para>\r | |
| 53 | When either <citerefentry><refentrytitle>glDrawElementsBaseVertex</refentrytitle></citerefentry>,\r | |
| 54 | <citerefentry><refentrytitle>glDrawElementsInstancedBaseVertex</refentrytitle></citerefentry> or\r | |
| 55 | <citerefentry><refentrytitle>glMultiDrawElementsBaseVertex</refentrytitle></citerefentry> is used, the primitive restart\r | |
| 56 | comparison occurs before the basevertex offset is added to the array index.\r | |
| 57 | </para>\r | |
| 58 | </refsect1>\r | |
| 59 | <refsect1 id="notes"><title>Notes</title>\r | |
| 60 | <para>\r | |
| 61 | <function>glPrimitiveRestartIndex</function> is available only if the GL version is 3.1 or greater.\r | |
| 62 | </para>\r | |
| 63 | </refsect1>\r | |
| 64 | <refsect1 id="seealso"><title>See Also</title>\r | |
| 65 | <para>\r | |
| 66 | <citerefentry><refentrytitle>glDrawArrays</refentrytitle></citerefentry>,\r | |
| 67 | <citerefentry><refentrytitle>glDrawElements</refentrytitle></citerefentry>,\r | |
| 68 | <citerefentry><refentrytitle>glDrawElementsBaseVertex</refentrytitle></citerefentry>,\r | |
| 69 | <citerefentry><refentrytitle>glDrawElementsInstancedBaseVertex</refentrytitle></citerefentry>\r | |
| 70 | </para>\r | |
| 71 | </refsect1>\r | |
| 72 | <refsect1 id="Copyright"><title>Copyright</title>\r | |
| 73 | <para>\r | |
| 74 | Copyright <trademark class="copyright"></trademark> 2010 Khronos Group. \r | |
| 75 | This material may be distributed subject to the terms and conditions set forth in \r | |
| 76 | the Open Publication License, v 1.0, 8 June 1999.\r | |
| 77 | <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.\r | |
| 78 | </para>\r | |
| 79 | </refsect1>\r | |
| 80 | </refentry>\r |