upstream-doc/man4/xhtml/glDrawTransformFeedbackStreamInstanced.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>glDrawTransformFeedbackStreamInstanced - 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="glDrawTransformFeedbackStreamInstanced"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glDrawTransformFeedbackStreamInstanced — render multiple instances of primitives using a count derived from a specifed stream of a transform feedback object</p></div><div class="refsynopsisdiv"><h2>C Specification</h2><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"><tr><td><code class="funcdef">void <b class="fsfunc">glDrawTransformFeedbackStreamInstanced</b>(</code></td><td>GLenum  </td><td><var class="pdparam">mode</var>, </td></tr><tr><td> </td><td>GLuint  </td><td><var class="pdparam">id</var>, </td></tr><tr><td> </td><td>GLuint  </td><td><var class="pdparam">stream</var>, </td></tr><tr><td> </td><td>GLsizei  </td><td><var class="pdparam">primcount</var><code>)</code>;</td></tr></table></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>mode</code></em></span></dt><dd><p>
   5                     Specifies what kind of primitives to render.
   6                     Symbolic constants
   7                     <code class="constant">GL_POINTS</code>,
   8                     <code class="constant">GL_LINE_STRIP</code>,
   9                     <code class="constant">GL_LINE_LOOP</code>,
  10                     <code class="constant">GL_LINES</code>,
  11                     <code class="constant">GL_LINE_STRIP_ADJACENCY</code>,
  12                     <code class="constant">GL_LINES_ADJACENCY</code>,
  13                     <code class="constant">GL_TRIANGLE_STRIP</code>,
  14                     <code class="constant">GL_TRIANGLE_FAN</code>,
  15                     <code class="constant">GL_TRIANGLES</code>,
  16                     <code class="constant">GL_TRIANGLE_STRIP_ADJACENCY</code>,
  17                     <code class="constant">GL_TRIANGLES_ADJACENCY</code>, and
  18                     <code class="constant">GL_PATCHES</code>
  19                     are accepted.
  20                 </p></dd><dt><span class="term"><em class="parameter"><code>id</code></em></span></dt><dd><p>
  21                     Specifies the name of a transform feedback object from which to retrieve a primitive count.
  22                 </p></dd><dt><span class="term"><em class="parameter"><code>stream</code></em></span></dt><dd><p>
  23                     Specifies the index of the transform feedback stream from which to retrieve a primitive count.
  24                 </p></dd><dt><span class="term"><em class="parameter"><code>primcount</code></em></span></dt><dd><p>
  25                     Specifies the number of instances of the geometry to render.
  26                 </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
  27             <code class="function">glDrawTransformFeedbackStreamInstanced</code> draws multiple copies of a range of primitives of a type specified by <em class="parameter"><code>mode</code></em> using
  28             a count retrieved from the transform feedback stream specified by <em class="parameter"><code>stream</code></em> of the transform feedback object
  29             specified by <em class="parameter"><code>id</code></em>. Calling <code class="function">glDrawTransformFeedbackStreamInstanced</code>
  30             is equivalent to calling <a href="glDrawArraysInstanced.xml"><span class="citerefentry"><span class="refentrytitle">glDrawArraysInstanced</span></span></a> with <em class="parameter"><code>mode</code></em>
  31             and <em class="parameter"><code>primcount</code></em> as specified, <em class="parameter"><code>first</code></em> set to zero, and <em class="parameter"><code>count</code></em> set to the number of vertices captured
  32             on vertex stream <em class="parameter"><code>stream</code></em> the last time transform feedback was active on the transform feedback object named
  33             by <em class="parameter"><code>id</code></em>.
  34         </p><p>
  35             Calling <a href="glDrawTransformFeedbackInstanced.xml"><span class="citerefentry"><span class="refentrytitle">glDrawTransformFeedbackInstanced</span></span></a> is equivalent to calling <code class="function">glDrawTransformFeedbackStreamInstanced</code>
  36             with <em class="parameter"><code>stream</code></em> set to zero.
  37         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p>
  38             <code class="constant">GL_INVALID_ENUM</code> is generated if <em class="parameter"><code>mode</code></em> is not an accepted value.
  39         </p><p>
  40             <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>id</code></em> is not the name of a transform feedback
  41             object.
  42         </p><p>
  43             <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>stream</code></em> is greater than or equal to
  44             the value of <code class="constant">GL_MAX_VERTEX_STREAMS</code>.
  45         </p><p>
  46             <code class="constant">GL_INVALID_OPERATION</code> is generated if a non-zero buffer object name is bound to an
  47             enabled array and the buffer object's data store is currently mapped.
  48         </p><p>
  49             <code class="constant">GL_INVALID_OPERATION</code> is generated if a geometry shader is active and <em class="parameter"><code>mode</code></em>
  50             is incompatible with the input primitive type of the geometry shader in the currently installed program object.
  51         </p><p>
  52             <code class="constant">GL_INVALID_OPERATION</code> is generated if <em class="parameter"><code>mode</code></em> is <code class="constant">GL_PATCHES</code>
  53             and no tessellation control shader is active.
  54         </p><p>
  55             <code class="constant">GL_INVALID_OPERATION</code> is generated if <a href="glEndTransformFeedback.xml"><span class="citerefentry"><span class="refentrytitle">glEndTransformFeedback</span></span></a>
  56             has never been called while the transform feedback object named by <em class="parameter"><code>id</code></em> was bound.
  57         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
  58             <a href="glDrawArrays.xml"><span class="citerefentry"><span class="refentrytitle">glDrawArrays</span></span></a>,
  59             <a href="glDrawArraysInstanced.xml"><span class="citerefentry"><span class="refentrytitle">glDrawArraysInstanced</span></span></a>,
  60             <a href="glDrawElements.xml"><span class="citerefentry"><span class="refentrytitle">glDrawElements</span></span></a>,
  61             <a href="glDrawRangeElements.xml"><span class="citerefentry"><span class="refentrytitle">glDrawRangeElements</span></span></a>,
  62             <a href="glDrawTransformFeedback.xml"><span class="citerefentry"><span class="refentrytitle">glDrawTransformFeedback</span></span></a>,
  63             <a href="glDrawTransformFeedbackStream.xml"><span class="citerefentry"><span class="refentrytitle">glDrawTransformFeedbackStream</span></span></a>.
  64         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
  65             Copyright <span class="trademark"></span>© 2010-2011 Khronos Group.
  66             This material may be distributed subject to the terms and conditions set forth in
  67             the Open Publication License, v 1.0, 8 June 1999.
  68             <a href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
  69         </p></div></div></body></html>