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="glVertexAttribDivisor">\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>glVertexAttribDivisor</refentrytitle>\r | |
| 13 | <manvolnum>3G</manvolnum>\r | |
| 14 | </refmeta>\r | |
| 15 | <refnamediv>\r | |
| 16 | <refname>glVertexAttribDivisor</refname>\r | |
| 17 | <refpurpose>modify the rate at which generic vertex attributes advance during instanced rendering</refpurpose>\r | |
| 18 | </refnamediv>\r | |
| 19 | <refsynopsisdiv><title>C Specification</title>\r | |
| 20 | <funcsynopsis>\r | |
| 21 | <funcprototype>\r | |
| 22 | <funcdef>void <function>glVertexAttribDivisor</function></funcdef>\r | |
| 23 | <paramdef>GLuint <parameter>index</parameter></paramdef>\r | |
| 24 | <paramdef>GLuint <parameter>divisor</parameter></paramdef>\r | |
| 25 | </funcprototype>\r | |
| 26 | </funcsynopsis>\r | |
| 27 | </refsynopsisdiv>\r | |
| 28 | <refsect1 id="parameters"><title>Parameters</title>\r | |
| 29 | <variablelist>\r | |
| 30 | <varlistentry>\r | |
| 31 | <term><parameter>index</parameter></term>\r | |
| 32 | <listitem>\r | |
| 33 | <para>\r | |
| 34 | Specify the index of the generic vertex attribute.\r | |
| 35 | </para>\r | |
| 36 | </listitem>\r | |
| 37 | </varlistentry>\r | |
| 38 | <varlistentry>\r | |
| 39 | <term><parameter>divisor</parameter></term>\r | |
| 40 | <listitem>\r | |
| 41 | <para>\r | |
| 42 | Specify the number of instances that will pass between updates of the generic attribute at slot <parameter>index</parameter>.\r | |
| 43 | </para>\r | |
| 44 | </listitem>\r | |
| 45 | </varlistentry>\r | |
| 46 | </variablelist>\r | |
| 47 | </refsect1>\r | |
| 48 | <refsect1 id="description"><title>Description</title>\r | |
| 49 | <para>\r | |
| 50 | <function>glVertexAttribDivisor</function> modifies the rate at which generic vertex attributes advance when rendering\r | |
| 51 | multiple instances of primitives in a single draw call. If <parameter>divisor</parameter> is zero, the attribute at slot\r | |
| 52 | <parameter>index</parameter> advances once per vertex. If <parameter>divisor</parameter> is non-zero, the attribute advances\r | |
| 53 | once per <parameter>divisor</parameter> instances of the set(s) of vertices being rendered. An attribute\r | |
| 54 | is referred to as instanced if its <constant>GL_VERTEX_ATTRIB_ARRAY_DIVISOR</constant> value is non-zero.\r | |
| 55 | </para>\r | |
| 56 | <para>\r | |
| 57 | <parameter>index</parameter> must be less than the value of <constant>GL_MAX_VERTEX_ATTRIBUTES</constant>.\r | |
| 58 | </para>\r | |
| 59 | </refsect1>\r | |
| 60 | <refsect1 id="notes"><title>Notes</title>\r | |
| 61 | <para>\r | |
| 62 | <function>glVertexAttribDivisor</function> is available only if the GL version is 3.3 or higher.\r | |
| 63 | </para>\r | |
| 64 | </refsect1>\r | |
| 65 | <refsect1 id="errors"><title>Errors</title>\r | |
| 66 | <para>\r | |
| 67 | <constant>GL_INVALID_VALUE</constant> is generated if <parameter>index</parameter> is greater\r | |
| 68 | than or equal to the value of <constant>GL_MAX_VERTEX_ATTRIBUTES</constant>.\r | |
| 69 | </para>\r | |
| 70 | </refsect1>\r | |
| 71 | <refsect1 id="seealso"><title>See Also</title>\r | |
| 72 | <para>\r | |
| 73 | <citerefentry><refentrytitle>glVertexAttribPointer</refentrytitle></citerefentry>,\r | |
| 74 | <citerefentry><refentrytitle>glEnableVertexAttribArray</refentrytitle></citerefentry>,\r | |
| 75 | <citerefentry><refentrytitle>glDisableVertexAttribArray</refentrytitle></citerefentry>\r | |
| 76 | </para>\r | |
| 77 | </refsect1>\r | |
| 78 | <refsect1 id="Copyright"><title>Copyright</title>\r | |
| 79 | <para>\r | |
| 80 | Copyright <trademark class="copyright"></trademark> 2010 Khronos Group. \r | |
| 81 | This material may be distributed subject to the terms and conditions set forth in \r | |
| 82 | the Open Publication License, v 1.0, 8 June 1999.\r | |
| 83 | <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.\r | |
| 84 | </para>\r | |
| 85 | </refsect1>\r | |
| 86 | </refentry>\r |