add upstream documentation

[clinton/guile-figl.git] / upstream-man-pages / man3 / glPrimitiveRestartIndex.xml

diff --git a/upstream-man-pages/man3/glPrimitiveRestartIndex.xml b/upstream-man-pages/man3/glPrimitiveRestartIndex.xml
new file mode 100644 (file)
index 0000000..1dd820f
--- /dev/null
+++ b/upstream-man-pages/man3/glPrimitiveRestartIndex.xml
@@ -0,0 +1,80 @@
+<?xml version="1.0" encoding="UTF-8"?>\r
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"\r
+              "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">\r
+<refentry id="glPrimitiveRestartIndex">\r
+    <refmeta>\r
+        <refmetainfo>\r
+            <copyright>\r
+                <year>2010</year>\r
+                <holder>Khronos Group</holder>\r
+            </copyright>\r
+        </refmetainfo>\r
+        <refentrytitle>glPrimitiveRestartIndex</refentrytitle>\r
+        <manvolnum>3G</manvolnum>\r
+    </refmeta>\r
+    <refnamediv>\r
+        <refname>glPrimitiveRestartIndex</refname>\r
+        <refpurpose>specify the primitive restart index</refpurpose>\r
+    </refnamediv>\r
+    <refsynopsisdiv><title>C Specification</title>\r
+        <funcsynopsis>\r
+            <funcprototype>\r
+                <funcdef>void <function>glPrimitiveRestartIndex</function></funcdef>\r
+                <paramdef>GLuint <parameter>index</parameter></paramdef>\r
+            </funcprototype>\r
+        </funcsynopsis>\r
+    </refsynopsisdiv>\r
+    <refsect1 id="parameters"><title>Parameters</title>\r
+        <variablelist>\r
+        <varlistentry>\r
+            <term><parameter>index</parameter></term>\r
+            <listitem>\r
+                <para>\r
+                    Specifies the value to be interpreted as the primitive restart index.\r
+                </para>\r
+            </listitem>\r
+        </varlistentry>\r
+        </variablelist>\r
+    </refsect1>\r
+    <refsect1 id="description"><title>Description</title>\r
+        <para>\r
+            <function>glPrimitiveRestartIndex</function> specifies a vertex array element that is treated specially when\r
+            primitive restarting is enabled. This is known as the primitive restart index.\r
+        </para>\r
+        <para>\r
+            When one of the <function>Draw*</function> commands transfers a set of generic attribute array elements to\r
+            the GL, if the index within the vertex arrays corresponding to that set is equal to the primitive restart\r
+            index, then the GL does not process those elements as a vertex. Instead, it is as if the drawing command\r
+            ended with the immediately preceding transfer, and another drawing command is immediately started with\r
+            the same parameters, but only transferring the immediately following element through the end of the\r
+            originally specified elements.\r
+        </para>\r
+        <para>\r
+            When either <citerefentry><refentrytitle>glDrawElementsBaseVertex</refentrytitle></citerefentry>,\r
+            <citerefentry><refentrytitle>glDrawElementsInstancedBaseVertex</refentrytitle></citerefentry> or\r
+            <citerefentry><refentrytitle>glMultiDrawElementsBaseVertex</refentrytitle></citerefentry> is used, the primitive restart\r
+            comparison occurs before the basevertex offset is added to the array index.\r
+        </para>\r
+    </refsect1>\r
+    <refsect1 id="notes"><title>Notes</title>\r
+        <para>\r
+            <function>glPrimitiveRestartIndex</function> is available only if the GL version is 3.1 or greater.\r
+        </para>\r
+    </refsect1>\r
+    <refsect1 id="seealso"><title>See Also</title>\r
+        <para>\r
+            <citerefentry><refentrytitle>glDrawArrays</refentrytitle></citerefentry>,\r
+            <citerefentry><refentrytitle>glDrawElements</refentrytitle></citerefentry>,\r
+            <citerefentry><refentrytitle>glDrawElementsBaseVertex</refentrytitle></citerefentry>,\r
+            <citerefentry><refentrytitle>glDrawElementsInstancedBaseVertex</refentrytitle></citerefentry>\r
+        </para>\r
+    </refsect1>\r
+    <refsect1 id="Copyright"><title>Copyright</title>\r
+        <para>\r
+            Copyright <trademark class="copyright"></trademark> 2010 Khronos Group. \r
+            This material may be distributed subject to the terms and conditions set forth in \r
+            the Open Publication License, v 1.0, 8 June 1999.\r
+            <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.\r
+        </para>\r
+    </refsect1>\r
+</refentry>\r