Difference between revisions of "GLAPI/glDrawTransformFeedbackInstanced"

From OpenGL Wiki
Jump to navigation Jump to search
m (Renaming category: 'GL 4 API Vertex Rendering' to 'Core API Ref Vertex Rendering'.)
m (Bot: Adding better formatting.)
 
(5 intermediate revisions by 2 users not shown)
Line 9: Line 9:
 
== Function Definition ==
 
== Function Definition ==
  
   void '''glDrawTransformFeedbackInstanced'''(GLenum ''mode'', GLuint ''id'', GLsizei ''primcount'');
+
   void '''glDrawTransformFeedbackInstanced'''(GLenum {{param|mode}}, GLuint {{param|id}}, GLsizei {{param|instancecount}});
  
 
; mode
 
; mode
: Specifies what kind of primitives to render. Symbolic constants {{code|GL_POINTS}}, {{code|GL_LINE_STRIP}}, {{code|GL_LINE_LOOP}}, {{code|GL_LINES}}, {{code|GL_LINE_STRIP_ADJACENCY}}, {{code|GL_LINES_ADJACENCY}}, {{code|GL_TRIANGLE_STRIP}}, {{code|GL_TRIANGLE_FAN}}, {{code|GL_TRIANGLES}}, {{code|GL_TRIANGLE_STRIP_ADJACENCY}}, {{code|GL_TRIANGLES_ADJACENCY}}, and {{code|GL_PATCHES}} are accepted.
+
: Specifies what kind of primitives to render. Symbolic constants {{enum|GL_POINTS}}, {{enum|GL_LINE_STRIP}}, {{enum|GL_LINE_LOOP}}, {{enum|GL_LINES}}, {{enum|GL_LINE_STRIP_ADJACENCY}}, {{enum|GL_LINES_ADJACENCY}}, {{enum|GL_TRIANGLE_STRIP}}, {{enum|GL_TRIANGLE_FAN}}, {{enum|GL_TRIANGLES}}, {{enum|GL_TRIANGLE_STRIP_ADJACENCY}}, {{enum|GL_TRIANGLES_ADJACENCY}}, and {{enum|GL_PATCHES}} are accepted.
 
; id
 
; id
 
: Specifies the name of a transform feedback object from which to retrieve a primitive count.
 
: Specifies the name of a transform feedback object from which to retrieve a primitive count.
; primcount
+
; instancecount
 
: Specifies the number of instances of the geometry to render.
 
: Specifies the number of instances of the geometry to render.
  
 
== Description ==
 
== Description ==
  
'''glDrawTransformFeedbackInstanced''' draws multiple copies of a range of primitives of a type specified by ''mode'' using a count retrieved from the transform feedback stream specified by ''stream'' of the transform feedback object specified by ''id''. Calling '''glDrawTransformFeedbackInstanced''' is equivalent to calling [[GLAPI/glDrawArraysInstanced|glDrawArraysInstanced]] with ''mode'' and ''primcount'' as specified, ''first'' set to zero, and ''count'' set to the number of vertices captured on vertex stream zero the last time transform feedback was active on the transform feedback object named by ''id''.
+
'''glDrawTransformFeedbackInstanced''' draws multiple copies of a range of primitives of a type specified by {{param|mode}} using a count retrieved from the transform feedback stream specified by {{param|stream}} of the transform feedback object specified by {{param|id}}. Calling '''glDrawTransformFeedbackInstanced''' is equivalent to calling {{apifunc|glDrawArraysInstanced}} with {{param|mode}} and {{param|primcount}} as specified, {{param|first}} set to zero, and {{param|count}} set to the number of vertices captured on vertex stream zero the last time transform feedback was active on the transform feedback object named by {{param|id}}.
  
Calling [[GLAPI/glDrawTransformFeedbackInstanced|glDrawTransformFeedbackInstanced]] is equivalent to calling '''glDrawTransformFeedbackStreamInstanced''' with ''stream'' set to zero.
+
Calling {{apifunc|glDrawTransformFeedbackInstanced}} is equivalent to calling '''glDrawTransformFeedbackStreamInstanced''' with {{param|stream}} set to zero.
  
 
== Errors ==
 
== Errors ==
  
{{code|GL_INVALID_ENUM}} is generated if ''mode'' is not an accepted value.
+
{{enum|GL_INVALID_ENUM}} is generated if {{param|mode}} is not an accepted value.
  
{{code|GL_INVALID_VALUE}} is generated if ''id'' is not the name of a transform feedback object.
+
{{enum|GL_INVALID_VALUE}} is generated if {{param|id}} is not the name of a transform feedback object.
  
{{code|GL_INVALID_VALUE}} is generated if ''stream'' is greater than or equal to the value of {{code|GL_MAX_VERTEX_STREAMS}}.
+
{{enum|GL_INVALID_VALUE}} is generated if {{param|stream}} is greater than or equal to the value of {{enum|GL_MAX_VERTEX_STREAMS}}.
  
{{code|GL_INVALID_OPERATION}} is generated if a non-zero buffer object name is bound to an enabled array and the buffer object's data store is currently mapped.
+
{{enum|GL_INVALID_OPERATION}} is generated if a non-zero buffer object name is bound to an enabled array and the buffer object's data store is currently mapped.
  
{{code|GL_INVALID_OPERATION}} is generated if a geometry shader is active and ''mode'' is incompatible with the input primitive type of the geometry shader in the currently installed program object.
+
{{enum|GL_INVALID_OPERATION}} is generated if a geometry shader is active and {{param|mode}} is incompatible with the input primitive type of the geometry shader in the currently installed program object.
  
{{code|GL_INVALID_OPERATION}} is generated if ''mode'' is {{code|GL_PATCHES}} and no tessellation control shader is active.
+
{{enum|GL_INVALID_OPERATION}} is generated if {{param|mode}} is {{enum|GL_PATCHES}} and no tessellation control shader is active.
  
{{code|GL_INVALID_OPERATION}} is generated if [[GLAPI/glEndTransformFeedback|glEndTransformFeedback]] has never been called while the transform feedback object named by ''id'' was bound.
+
{{enum|GL_INVALID_OPERATION}} is generated if {{apifunc|glEndTransformFeedback}} has never been called while the transform feedback object named by {{param|id}} was bound.
  
 
== See Also ==
 
== See Also ==
  
[[GLAPI/glDrawArrays|glDrawArrays]], [[GLAPI/glDrawArraysInstanced|glDrawArraysInstanced]], [[GLAPI/glDrawElements|glDrawElements]], [[GLAPI/glDrawRangeElements|glDrawRangeElements]], [[GLAPI/glDrawTransformFeedback|glDrawTransformFeedback]], [[GLAPI/glDrawTransformFeedbackStreamInstanced|glDrawTransformFeedbackStreamInstanced]].
+
{{apifunc|glBindVertexArray}}, {{apifunc|glDrawArrays}}, {{apifunc|glDrawTransformFeedback}}, {{apifunc|glDrawTransformFeedbackStream}}, {{apifunc|glDrawTransformFeedbackStreamInstanced}}
  
 
== Copyright ==
 
== Copyright ==
Line 48: Line 48:
 
Copyright © 2010-2011 Khronos Group. This material may be distributed subject to the terms and conditions set forth in the Open Publication License, v 1.0, 8 June 1999. [http://opencontent.org/openpub/ http://opencontent.org/openpub/].
 
Copyright © 2010-2011 Khronos Group. This material may be distributed subject to the terms and conditions set forth in the Open Publication License, v 1.0, 8 June 1999. [http://opencontent.org/openpub/ http://opencontent.org/openpub/].
  
[[Category:API Reference 4|DrawTransformFeedbackInstanced]]
 
 
[[Category:Core API Ref Vertex Rendering|DrawTransformFeedbackInstanced]]
 
[[Category:Core API Ref Vertex Rendering|DrawTransformFeedbackInstanced]]
 +
[[Category:Core API Reference|DrawTransformFeedbackInstanced]]

Latest revision as of 01:44, 27 September 2012

glDrawTransformFeedbackInstanced
Core in version 4.6
Core since version 4.2
Core ARB extension ARB_transform_feedback_instanced

glDrawTransformFeedbackInstanced: render multiple instances of primitives using a count derived from a transform feedback object

Function Definition

 void glDrawTransformFeedbackInstanced(GLenum mode​, GLuint id​, GLsizei instancecount​);
mode
Specifies what kind of primitives to render. Symbolic constants GL_POINTS, GL_LINE_STRIP, GL_LINE_LOOP, GL_LINES, GL_LINE_STRIP_ADJACENCY, GL_LINES_ADJACENCY, GL_TRIANGLE_STRIP, GL_TRIANGLE_FAN, GL_TRIANGLES, GL_TRIANGLE_STRIP_ADJACENCY, GL_TRIANGLES_ADJACENCY, and GL_PATCHES are accepted.
id
Specifies the name of a transform feedback object from which to retrieve a primitive count.
instancecount
Specifies the number of instances of the geometry to render.

Description

glDrawTransformFeedbackInstanced draws multiple copies of a range of primitives of a type specified by mode​ using a count retrieved from the transform feedback stream specified by stream​ of the transform feedback object specified by id​. Calling glDrawTransformFeedbackInstanced is equivalent to calling glDrawArraysInstanced with mode​ and primcount​ as specified, first​ set to zero, and count​ set to the number of vertices captured on vertex stream zero the last time transform feedback was active on the transform feedback object named by id​.

Calling glDrawTransformFeedbackInstanced is equivalent to calling glDrawTransformFeedbackStreamInstanced with stream​ set to zero.

Errors

GL_INVALID_ENUM is generated if mode​ is not an accepted value.

GL_INVALID_VALUE is generated if id​ is not the name of a transform feedback object.

GL_INVALID_VALUE is generated if stream​ is greater than or equal to the value of GL_MAX_VERTEX_STREAMS.

GL_INVALID_OPERATION is generated if a non-zero buffer object name is bound to an enabled array and the buffer object's data store is currently mapped.

GL_INVALID_OPERATION is generated if a geometry shader is active and mode​ is incompatible with the input primitive type of the geometry shader in the currently installed program object.

GL_INVALID_OPERATION is generated if mode​ is GL_PATCHES and no tessellation control shader is active.

GL_INVALID_OPERATION is generated if glEndTransformFeedback has never been called while the transform feedback object named by id​ was bound.

See Also

glBindVertexArray, glDrawArrays, glDrawTransformFeedback, glDrawTransformFeedbackStream, glDrawTransformFeedbackStreamInstanced

Copyright

Copyright © 2010-2011 Khronos Group. This material may be distributed subject to the terms and conditions set forth in the Open Publication License, v 1.0, 8 June 1999. http://opencontent.org/openpub/.