GLAPI/glDrawElementsInstanced: Difference between revisions

From OpenGL Wiki
Jump to navigation Jump to search
← Older edit
m Bot: Adjusting API page category.
Better indices specification.
 
(6 intermediate revisions by one other user not shown)
Line 8: Line 8:
== Function Definition ==
== Function Definition ==


   void '''glDrawElementsInstanced'''(GLenum ''mode'', GLsizei ''count'', GLenum ''type'', const void * ''indices'', GLsizei ''primcount'');
   void '''glDrawElementsInstanced'''(GLenum {{param|mode}}, GLsizei {{param|count}}, GLenum {{param|type}}, const void * {{param|indices}}, GLsizei {{param|primcount}});


; 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.
; count
; count
: Specifies the number of elements to be rendered.
: Specifies the number of elements to be rendered.
; type
; type
: Specifies the type of the values in ''indices''. Must be one of {{code|GL_UNSIGNED_BYTE}}, {{code|GL_UNSIGNED_SHORT}}, or {{code|GL_UNSIGNED_INT}}.
: Specifies the type of the values in {{param|indices}}. Must be one of {{enum|GL_UNSIGNED_BYTE}}, {{enum|GL_UNSIGNED_SHORT}}, or {{enum|GL_UNSIGNED_INT}}.
; indices
; indices
: Specifies a pointer to the location where the indices are stored.
: Specifies a byte offset (cast to a pointer type) into the buffer bound to {{enum|GL_ELEMENT_ARRAY_BUFFER}} to start reading indices from.
; primcount
; primcount
: Specifies the number of instances of the specified range of indices to be rendered.
: Specifies the number of instances of the specified range of indices to be rendered.
Line 23: Line 23:
== Description ==
== Description ==


'''glDrawElementsInstanced''' behaves identically to [[GLAPI/glDrawElements|glDrawElements]] except that ''primcount'' instances of the set of elements are executed and the value of the internal counter ''instanceID'' advances for each iteration. ''instanceID'' is an internal 32-bit integer counter that may be read by a vertex shader as {{code|gl_InstanceID}}.
'''glDrawElementsInstanced''' behaves identically to {{apifunc|glDrawElements}} except that {{param|primcount}} instances of the set of elements are executed and the value of the internal counter {{param|instanceID}} advances for each iteration. {{param|instanceID}} is an internal 32-bit integer counter that may be read by a vertex shader as {{enum|gl_InstanceID}}.


'''glDrawElementsInstanced''' has the same effect as:  
'''glDrawElementsInstanced''' has the same effect as:  
Line 43: Line 43:
'''glDrawElementsInstanced''' is available only if the GL version is 3.1 or greater.
'''glDrawElementsInstanced''' is available only if the GL version is 3.1 or greater.


{{code|GL_LINE_STRIP_ADJACENCY}}, {{code|GL_LINES_ADJACENCY}}, {{code|GL_TRIANGLE_STRIP_ADJACENCY}} and {{code|GL_TRIANGLES_ADJACENCY}} are available only if the GL version is 3.2 or greater.
{{enum|GL_LINE_STRIP_ADJACENCY}}, {{enum|GL_LINES_ADJACENCY}}, {{enum|GL_TRIANGLE_STRIP_ADJACENCY}} and {{enum|GL_TRIANGLES_ADJACENCY}} are available only if the GL version is 3.2 or greater.


== Errors ==
== Errors ==


{{code|GL_INVALID_ENUM}} is generated if ''mode'' is not one of {{code|GL_POINTS}}, {{code|GL_LINE_STRIP}}, {{code|GL_LINE_LOOP}}, {{code|GL_LINES}}, {{code|GL_TRIANGLE_STRIP}}, {{code|GL_TRIANGLE_FAN}}, or {{code|GL_TRIANGLES}}.
{{enum|GL_INVALID_ENUM}} is generated if {{param|mode}} is not one of {{enum|GL_POINTS}}, {{enum|GL_LINE_STRIP}}, {{enum|GL_LINE_LOOP}}, {{enum|GL_LINES}}, {{enum|GL_TRIANGLE_STRIP}}, {{enum|GL_TRIANGLE_FAN}}, or {{enum|GL_TRIANGLES}}.


{{code|GL_INVALID_VALUE}} is generated if ''count'' or ''primcount'' are negative.
{{enum|GL_INVALID_VALUE}} is generated if {{param|count}} or {{param|primcount}} are negative.


{{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 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.


== See Also ==
== See Also ==


[[GLAPI/glDrawElements|glDrawElements]], [[GLAPI/glDrawArraysInstanced|glDrawArraysInstanced]]
{{apifunc|glBindVertexArray}}, {{apifunc|glDrawArraysInstanced}}, {{apifunc|glDrawElements}}, {{apifunc|glDrawElementsBaseVertex}}, {{apifunc|glDrawElementsIndirect}}, {{apifunc|glDrawElementsInstancedBaseInstance}}, {{apifunc|glDrawElementsInstancedBaseVertex}}, {{apifunc|glDrawElementsInstancedBaseVertexBaseInstance}}, {{apifunc|glDrawRangeElements}}, {{apifunc|glDrawRangeElementsBaseVertex}}, {{apifunc|glMultiDrawElements}}, {{apifunc|glMultiDrawElementsBaseVertex}}, {{apifunc|glMultiDrawElementsIndirect}}


== Copyright ==
== Copyright ==
Line 63: Line 63:
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|DrawElementsInstanced]]
[[Category:Core API Ref Vertex Rendering|DrawElementsInstanced]]
[[Category:GL 4 API Vertex Rendering|DrawElementsInstanced]]
[[Category:Core API Reference|DrawElementsInstanced]]

Latest revision as of 04:31, 31 July 2013

glDrawElementsInstanced
Core in version 4.6
Core since version 3.1

glDrawElementsInstanced: draw multiple instances of a set of elements

Function Definition

 void glDrawElementsInstanced(GLenum mode​, GLsizei count​, GLenum type​, const void * indices​, GLsizei primcount​);
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.
count
Specifies the number of elements to be rendered.
type
Specifies the type of the values in indices​. Must be one of GL_UNSIGNED_BYTE, GL_UNSIGNED_SHORT, or GL_UNSIGNED_INT.
indices
Specifies a byte offset (cast to a pointer type) into the buffer bound to GL_ELEMENT_ARRAY_BUFFER to start reading indices from.
primcount
Specifies the number of instances of the specified range of indices to be rendered.

Description

glDrawElementsInstanced behaves identically to glDrawElements except that primcount​ instances of the set of elements are executed and the value of the internal counter instanceID​ advances for each iteration. instanceID​ is an internal 32-bit integer counter that may be read by a vertex shader as gl_InstanceID.

glDrawElementsInstanced has the same effect as: 

    if (mode, count, or type is invalid )
        generate appropriate error
    else {
        for (int i = 0; i < primcount ; i++) {
            instanceID = i;
            glDrawElements(mode, count, type, indices);
        }
        instanceID = 0;
    }

Notes

glDrawElementsInstanced is available only if the GL version is 3.1 or greater.

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

Errors

GL_INVALID_ENUM is generated if mode​ is not one of GL_POINTS, GL_LINE_STRIP, GL_LINE_LOOP, GL_LINES, GL_TRIANGLE_STRIP, GL_TRIANGLE_FAN, or GL_TRIANGLES.

GL_INVALID_VALUE is generated if count​ or primcount​ are negative.

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 a non-zero buffer object name is bound to an enabled array and the buffer object's data store is currently mapped.

See Also

glBindVertexArray, glDrawArraysInstanced, glDrawElements, glDrawElementsBaseVertex, glDrawElementsIndirect, glDrawElementsInstancedBaseInstance, glDrawElementsInstancedBaseVertex, glDrawElementsInstancedBaseVertexBaseInstance, glDrawRangeElements, glDrawRangeElementsBaseVertex, glMultiDrawElements, glMultiDrawElementsBaseVertex, glMultiDrawElementsIndirect

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/.

Retrieved from "https://wikis.khronos.org/opengl/index.php?title=GLAPI/glDrawElementsInstanced&oldid=10805"