Difference between revisions of "GLAPI/glBeginTransformFeedback"

From OpenGL.org
Jump to: navigation, search
m (Bot: Adjusting API page category.)
m (Bot: Adding better formatting.)
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
{{infobox feature  
 
{{infobox feature  
| name = glBeginTransformFeedback  
+
| name = glBeginTransformFeedback, glEndTransformFeedback
 
| core = 3.0
 
| core = 3.0
 
}}
 
}}
  
'''glBeginTransformFeedback:''' start transform feedback operation
+
'''glBeginTransformFeedback:''' start transform feedback operation. '''glEndTransformFeedback:''' ends transform feedback operation.
  
 
== Function Definition ==
 
== Function Definition ==
  
   void '''glBeginTransformFeedback'''(GLenum ''primitiveMode'');
+
   void '''glBeginTransformFeedback'''(GLenum {{param|primitiveMode}});
 +
  void '''glEndTransformFeedback'''({{param|void}});
  
 
; primitiveMode
 
; primitiveMode
 
: Specify the output type of the primitives that will be recorded into the buffer objects that are bound for transform feedback.
 
: Specify the output type of the primitives that will be recorded into the buffer objects that are bound for transform feedback.
 
== Function Definition ==
 
 
  void '''glEndTransformFeedback'''(''void'');
 
  
 
== Description ==
 
== Description ==
  
Transform feedback mode captures the values of varying variables written by the vertex shader (or, if active, the geometry shader). Transform feedback is said to be active after a call to '''glBeginTransformFeedback''' until a subsequent call to [[GLAPI/glEndTransformFeedback|glEndTransformFeedback]]. Transform feedback commands must be paired.
+
Transform feedback mode captures the values of varying variables written by the vertex shader (or, if active, the geometry shader). Transform feedback is said to be active after a call to '''glBeginTransformFeedback''' until a subsequent call to {{apifunc|glEndTransformFeedback}}. Transform feedback commands must be paired.
  
If no geometry shader is present, while transform feedback is active the ''mode'' parameter to [[GLAPI/glDrawArrays|glDrawArrays]] must match those specified in the following table:
+
If no geometry shader is present, while transform feedback is active the {{param|mode}} parameter to {{apifunc|glDrawArrays}} must match those specified in the following table:
  
 
{|
 
{|
 
|+
 
|+
! '''Transform Feedback ''primitiveMode'''''
+
! '''Transform Feedback {{param|primitiveMode}}'''
! '''Allowed Render Primitive ''modes'''''
+
! '''Allowed Render Primitive {{param|modes}}'''
 
|+
 
|+
| {{code|GL_POINTS}}
+
| {{enum|GL_POINTS}}
| {{code|GL_POINTS}}
+
| {{enum|GL_POINTS}}
 
|+
 
|+
| {{code|GL_LINES}}
+
| {{enum|GL_LINES}}
| {{code|GL_LINES}}, {{code|GL_LINE_LOOP}}, {{code|GL_LINE_STRIP}}, {{code|GL_LINES_ADJACENCY}}, {{code|GL_LINE_STRIP_ADJACENCY}}
+
| {{enum|GL_LINES}}, {{enum|GL_LINE_LOOP}}, {{enum|GL_LINE_STRIP}}, {{enum|GL_LINES_ADJACENCY}}, {{enum|GL_LINE_STRIP_ADJACENCY}}
 
|+
 
|+
| {{code|GL_TRIANGLES}}
+
| {{enum|GL_TRIANGLES}}
| {{code|GL_TRIANGLES}}, {{code|GL_TRIANGLE_STRIP}}, {{code|GL_TRIANGLE_FAN}}, {{code|GL_TRIANGLES_ADJACENCY}}, {{code|GL_TRIANGLE_STRIP_ADJACENCY}}
+
| {{enum|GL_TRIANGLES}}, {{enum|GL_TRIANGLE_STRIP}}, {{enum|GL_TRIANGLE_FAN}}, {{enum|GL_TRIANGLES_ADJACENCY}}, {{enum|GL_TRIANGLE_STRIP_ADJACENCY}}
 
|}
 
|}
  
Line 42: Line 39:
 
{|
 
{|
 
|+
 
|+
! '''Transform Feedback ''primitiveMode'''''
+
! '''Transform Feedback {{param|primitiveMode}}'''
 
! '''Allowed Geometry Shader Output Primitive Type'''
 
! '''Allowed Geometry Shader Output Primitive Type'''
 
|+
 
|+
| {{code|GL_POINTS}}
+
| {{enum|GL_POINTS}}
 
| {{code|points}}
 
| {{code|points}}
 
|+
 
|+
| {{code|GL_LINES}}
+
| {{enum|GL_LINES}}
 
| {{code|line_strip}}
 
| {{code|line_strip}}
 
|+
 
|+
| {{code|GL_TRIANGLES}}
+
| {{enum|GL_TRIANGLES}}
 
| {{code|triangle_strip}}
 
| {{code|triangle_strip}}
 
|}
 
|}
  
 +
== Notes ==
  
 +
Geometry shaders, and the {{enum|GL_TRIANGLES_ADJACENCY}}, {{enum|GL_TRIANGLE_STRIP_ADJACENCY}}, {{enum|GL_LINES_ADJACENCY}} and {{enum|GL_LINE_STRIP_ADJACENCY}} primtive modes are available only if the GL version is 3.2 or greater.
  
== Notes ==
+
== Errors ==
  
Geometry shaders, and the {{code|GL_TRIANGLES_ADJACENCY}}, {{code|GL_TRIANGLE_STRIP_ADJACENCY}}, {{code|GL_LINES_ADJACENCY}} and {{code|GL_LINE_STRIP_ADJACENCY}} primtive modes are available only if the GL version is 3.2 or greater.
+
{{enum|GL_INVALID_OPERATION}} is generated if '''glBeginTransformFeedback''' is executed while transform feedback is active.
  
== Errors ==
+
{{enum|GL_INVALID_OPERATION}} is generated if '''glEndTransformFeedback''' is executed while transform feedback is not active.
  
{{code|GL_INVALID_OPERATION}} is generated if '''glBeginTransformFeedback''' is executed while transform feedback is active.
+
{{enum|GL_INVALID_OPERATION}} is generated by all rendering functions if no geometry shader is present, transform feedback is active and {{param|mode}} is not one of the allowed modes.
  
{{code|GL_INVALID_OPERATION}} is generated if '''glEndTransformFeedback''' is executed while transform feedback is not active.
+
{{enum|GL_INVALID_OPERATION}} is generated by all rendering functions if a geometry shader is present, transform feedback is active and the output primitive type of the geometry shader does not match the transform feedback {{param|primitiveMode}}.
  
{{code|GL_INVALID_OPERATION}} is generated by [[GLAPI/glDrawArrays|glDrawArrays]] if no geometry shader is present, transform feedback is active and ''mode'' is not one of the allowed modes.
+
{{enum|GL_INVALID_OPERATION}} is generated by '''glEndTransformFeedback''' if any binding point used in transform feedback mode does not have a buffer object bound.
  
{{code|GL_INVALID_OPERATION}} is generated by [[GLAPI/glDrawArrays|glDrawArrays]] if a geometry shader is present, transform feedback is active and the output primitive type of the geometry shader does not match the transform feedback ''primitiveMode''.
+
{{enum|GL_INVALID_OPERATION}} is generated by '''glEndTransformFeedback''' if no binding points would be used, either because no program object is active of because the active program object has specified no varying variables to record.
  
{{code|GL_INVALID_OPERATION}} is generated by '''glEndTransformFeedback''' if any binding point used in transform feedback mode does not have a buffer object bound.
+
== See Also ==
  
{{code|GL_INVALID_OPERATION}} is generated by '''glEndTransformFeedback''' if no binding points would be used, either because no program object is active of because the active program object has specified no varying variables to record.
+
{{apifunc|glBindTransformFeedback}}, {{apifunc|glPauseTransformFeedback}}, {{apifunc|glResumeTransformFeedback}}
  
 
== Copyright ==
 
== Copyright ==
Line 79: Line 78:
 
Copyright © 2010 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 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|BeginTransformFeedback]]
+
[[Category:Core API Ref Transform Feedback|BeginTransformFeedback]]
[[Category:GL 4 API Transform Feedback|BeginTransformFeedback]]
+
[[Category:Core API Reference|BeginTransformFeedback]]

Revision as of 15:29, 27 September 2012

glBeginTransformFeedback, glEndTransformFeedback
Core in version 4.5
Core since version 3.0

glBeginTransformFeedback: start transform feedback operation. glEndTransformFeedback: ends transform feedback operation.

Function Definition

 void glBeginTransformFeedback(GLenum primitiveMode​);
 void glEndTransformFeedback(void​);
primitiveMode
Specify the output type of the primitives that will be recorded into the buffer objects that are bound for transform feedback.

Description

Transform feedback mode captures the values of varying variables written by the vertex shader (or, if active, the geometry shader). Transform feedback is said to be active after a call to glBeginTransformFeedback until a subsequent call to glEndTransformFeedback. Transform feedback commands must be paired.

If no geometry shader is present, while transform feedback is active the mode​ parameter to glDrawArrays must match those specified in the following table:

Transform Feedback primitiveMode​ Allowed Render Primitive modes​
GL_POINTS GL_POINTS
GL_LINES GL_LINES, GL_LINE_LOOP, GL_LINE_STRIP, GL_LINES_ADJACENCY, GL_LINE_STRIP_ADJACENCY
GL_TRIANGLES GL_TRIANGLES, GL_TRIANGLE_STRIP, GL_TRIANGLE_FAN, GL_TRIANGLES_ADJACENCY, GL_TRIANGLE_STRIP_ADJACENCY

If a geometry shader is present, the output primitive type from the geometry shader must match those provided in the following table:

Transform Feedback primitiveMode​ Allowed Geometry Shader Output Primitive Type
GL_POINTS points​
GL_LINES line_strip​
GL_TRIANGLES triangle_strip​

Notes

Geometry shaders, and the GL_TRIANGLES_ADJACENCY, GL_TRIANGLE_STRIP_ADJACENCY, GL_LINES_ADJACENCY and GL_LINE_STRIP_ADJACENCY primtive modes are available only if the GL version is 3.2 or greater.

Errors

GL_INVALID_OPERATION is generated if glBeginTransformFeedback is executed while transform feedback is active.

GL_INVALID_OPERATION is generated if glEndTransformFeedback is executed while transform feedback is not active.

GL_INVALID_OPERATION is generated by all rendering functions if no geometry shader is present, transform feedback is active and mode​ is not one of the allowed modes.

GL_INVALID_OPERATION is generated by all rendering functions if a geometry shader is present, transform feedback is active and the output primitive type of the geometry shader does not match the transform feedback primitiveMode​.

GL_INVALID_OPERATION is generated by glEndTransformFeedback if any binding point used in transform feedback mode does not have a buffer object bound.

GL_INVALID_OPERATION is generated by glEndTransformFeedback if no binding points would be used, either because no program object is active of because the active program object has specified no varying variables to record.

See Also

glBindTransformFeedback, glPauseTransformFeedback, glResumeTransformFeedback

Copyright

Copyright © 2010 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/.