Commit | Line | Data |
---|---|---|
7faf1d71 AW |
1 | <?xml version="1.0" encoding="UTF-8"?> |
2 | <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN" | |
3 | "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd"> | |
4 | <refentry id="glDrawTransformFeedbackStreamInstanced"> | |
5 | <refmeta> | |
6 | <refmetainfo> | |
7 | <copyright> | |
8 | <year>2011</year> | |
9 | <holder>Khronos Group.</holder> | |
10 | </copyright> | |
11 | </refmetainfo> | |
12 | <refentrytitle>glDrawTransformFeedbackStreamInstanced</refentrytitle> | |
13 | <manvolnum>3G</manvolnum> | |
14 | </refmeta> | |
15 | <refnamediv> | |
16 | <refname>glDrawTransformFeedbackStreamInstanced</refname> | |
17 | <refpurpose>render multiple instances of primitives using a count derived from a specifed stream of a transform feedback object</refpurpose> | |
18 | </refnamediv> | |
19 | <refsynopsisdiv><title>C Specification</title> | |
20 | <funcsynopsis> | |
21 | <funcprototype> | |
22 | <funcdef>void <function>glDrawTransformFeedbackStreamInstanced</function></funcdef> | |
23 | <paramdef>GLenum <parameter>mode</parameter></paramdef> | |
24 | <paramdef>GLuint <parameter>id</parameter></paramdef> | |
25 | <paramdef>GLuint <parameter>stream</parameter></paramdef> | |
26 | <paramdef>GLsizei <parameter>primcount</parameter></paramdef> | |
27 | </funcprototype> | |
28 | </funcsynopsis> | |
29 | </refsynopsisdiv> | |
30 | <!-- eqn: ignoring delim $$ --> | |
31 | <refsect1 id="parameters"><title>Parameters</title> | |
32 | <variablelist> | |
33 | <varlistentry> | |
34 | <term><parameter>mode</parameter></term> | |
35 | <listitem> | |
36 | <para> | |
37 | Specifies what kind of primitives to render. | |
38 | Symbolic constants | |
39 | <constant>GL_POINTS</constant>, | |
40 | <constant>GL_LINE_STRIP</constant>, | |
41 | <constant>GL_LINE_LOOP</constant>, | |
42 | <constant>GL_LINES</constant>, | |
43 | <constant>GL_LINE_STRIP_ADJACENCY</constant>, | |
44 | <constant>GL_LINES_ADJACENCY</constant>, | |
45 | <constant>GL_TRIANGLE_STRIP</constant>, | |
46 | <constant>GL_TRIANGLE_FAN</constant>, | |
47 | <constant>GL_TRIANGLES</constant>, | |
48 | <constant>GL_TRIANGLE_STRIP_ADJACENCY</constant>, | |
49 | <constant>GL_TRIANGLES_ADJACENCY</constant>, and | |
50 | <constant>GL_PATCHES</constant> | |
51 | are accepted. | |
52 | </para> | |
53 | </listitem> | |
54 | </varlistentry> | |
55 | <varlistentry> | |
56 | <term><parameter>id</parameter></term> | |
57 | <listitem> | |
58 | <para> | |
59 | Specifies the name of a transform feedback object from which to retrieve a primitive count. | |
60 | </para> | |
61 | </listitem> | |
62 | </varlistentry> | |
63 | <varlistentry> | |
64 | <term><parameter>stream</parameter></term> | |
65 | <listitem> | |
66 | <para> | |
67 | Specifies the index of the transform feedback stream from which to retrieve a primitive count. | |
68 | </para> | |
69 | </listitem> | |
70 | </varlistentry> | |
71 | <varlistentry> | |
72 | <term><parameter>primcount</parameter></term> | |
73 | <listitem> | |
74 | <para> | |
75 | Specifies the number of instances of the geometry to render. | |
76 | </para> | |
77 | </listitem> | |
78 | </varlistentry> | |
79 | </variablelist> | |
80 | </refsect1> | |
81 | <refsect1 id="description"><title>Description</title> | |
82 | <para> | |
83 | <function>glDrawTransformFeedbackStreamInstanced</function> draws multiple copies of a range of primitives of a type specified by <parameter>mode</parameter> using | |
84 | a count retrieved from the transform feedback stream specified by <parameter>stream</parameter> of the transform feedback object | |
85 | specified by <parameter>id</parameter>. Calling <function>glDrawTransformFeedbackStreamInstanced</function> | |
86 | is equivalent to calling <citerefentry><refentrytitle>glDrawArraysInstanced</refentrytitle></citerefentry> with <parameter>mode</parameter> | |
87 | and <parameter>primcount</parameter> as specified, <parameter>first</parameter> set to zero, and <parameter>count</parameter> set to the number of vertices captured | |
88 | on vertex stream <parameter>stream</parameter> the last time transform feedback was active on the transform feedback object named | |
89 | by <parameter>id</parameter>. | |
90 | </para> | |
91 | <para> | |
92 | Calling <citerefentry><refentrytitle>glDrawTransformFeedbackInstanced</refentrytitle></citerefentry> is equivalent to calling <function>glDrawTransformFeedbackStreamInstanced</function> | |
93 | with <parameter>stream</parameter> set to zero. | |
94 | </para> | |
95 | </refsect1> | |
96 | <refsect1 id="errors"><title>Errors</title> | |
97 | <para> | |
98 | <constant>GL_INVALID_ENUM</constant> is generated if <parameter>mode</parameter> is not an accepted value. | |
99 | </para> | |
100 | <para> | |
101 | <constant>GL_INVALID_VALUE</constant> is generated if <parameter>id</parameter> is not the name of a transform feedback | |
102 | object. | |
103 | </para> | |
104 | <para> | |
105 | <constant>GL_INVALID_VALUE</constant> is generated if <parameter>stream</parameter> is greater than or equal to | |
106 | the value of <constant>GL_MAX_VERTEX_STREAMS</constant>. | |
107 | </para> | |
108 | <para> | |
109 | <constant>GL_INVALID_OPERATION</constant> is generated if a non-zero buffer object name is bound to an | |
110 | enabled array and the buffer object's data store is currently mapped. | |
111 | </para> | |
112 | <para> | |
113 | <constant>GL_INVALID_OPERATION</constant> is generated if a geometry shader is active and <parameter>mode</parameter> | |
114 | is incompatible with the input primitive type of the geometry shader in the currently installed program object. | |
115 | </para> | |
116 | <para> | |
117 | <constant>GL_INVALID_OPERATION</constant> is generated if <parameter>mode</parameter> is <constant>GL_PATCHES</constant> | |
118 | and no tessellation control shader is active. | |
119 | </para> | |
120 | <para> | |
121 | <constant>GL_INVALID_OPERATION</constant> is generated if <citerefentry><refentrytitle>glEndTransformFeedback</refentrytitle></citerefentry> | |
122 | has never been called while the transform feedback object named by <parameter>id</parameter> was bound. | |
123 | </para> | |
124 | </refsect1> | |
125 | <refsect1 id="seealso"><title>See Also</title> | |
126 | <para> | |
127 | <citerefentry><refentrytitle>glDrawArrays</refentrytitle></citerefentry>, | |
128 | <citerefentry><refentrytitle>glDrawArraysInstanced</refentrytitle></citerefentry>, | |
129 | <citerefentry><refentrytitle>glDrawElements</refentrytitle></citerefentry>, | |
130 | <citerefentry><refentrytitle>glDrawRangeElements</refentrytitle></citerefentry>, | |
131 | <citerefentry><refentrytitle>glDrawTransformFeedback</refentrytitle></citerefentry>, | |
132 | <citerefentry><refentrytitle>glDrawTransformFeedbackStream</refentrytitle></citerefentry>. | |
133 | </para> | |
134 | </refsect1> | |
135 | <refsect1 id="Copyright"><title>Copyright</title> | |
136 | <para> | |
137 | Copyright <trademark class="copyright"></trademark> 2010-2011 Khronos Group. | |
138 | This material may be distributed subject to the terms and conditions set forth in | |
139 | the Open Publication License, v 1.0, 8 June 1999. | |
140 | <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>. | |
141 | </para> | |
142 | </refsect1> | |
143 | </refentry> |