GLAPI/glDrawElementsInstancedBaseVertexBaseInstance: Difference between revisions

From OpenGL Wiki
Jump to navigation Jump to search
← Older edit
m Renaming category: 'API Reference 4' to 'Core API Reference'.
ARB_base_instance is core in 4.2, not 3.2
 
(7 intermediate revisions by 3 users not shown)
Line 9: Line 9:
== Function Definition ==
== Function Definition ==


   void '''glDrawElementsInstancedBaseVertexBaseInstance'''(GLenum ''mode'', GLsizei ''count'', GLenum ''type'', GLvoid *''indices'', GLsizei ''primcount'', GLint ''basevertex'', GLuint ''baseinstance'');
   void '''glDrawElementsInstancedBaseVertexBaseInstance'''(GLenum {{param|mode}}, GLsizei {{param|count}}, GLenum {{param|type}}, GLvoid *{{param|indices}}, GLsizei {{param|primcount}}, GLint {{param|basevertex}}, GLuint {{param|baseinstance}});


; 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_TRIANGLE_STRIP}}, {{code|GL_TRIANGLE_FAN}}, {{code|GL_TRIANGLES}}, {{code|GL_LINES_ADJACENCY}}, {{code|GL_LINE_STRIP_ADJACENCY}}, {{code|GL_TRIANGLES_ADJACENCY}}, {{code|GL_TRIANGLE_STRIP_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_TRIANGLE_STRIP}}, {{enum|GL_TRIANGLE_FAN}}, {{enum|GL_TRIANGLES}}, {{enum|GL_LINES_ADJACENCY}}, {{enum|GL_LINE_STRIP_ADJACENCY}}, {{enum|GL_TRIANGLES_ADJACENCY}}, {{enum|GL_TRIANGLE_STRIP_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 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 indexed geometry that should be drawn.
: Specifies the number of instances of the indexed geometry that should be drawn.
; basevertex
; basevertex
: Specifies a constant that should be added to each element of ''indices'' when chosing elements from the enabled vertex arrays.
: Specifies a constant that should be added to each element of {{param|indices}} when chosing elements from the enabled vertex arrays.
; baseinstance
; baseinstance
: Specifies the base instance for use in fetching instanced vertex attributes.
: Specifies the base instance for use in fetching instanced vertex attributes.
Line 28: Line 28:
== Description ==
== Description ==


'''glDrawElementsInstancedBaseVertexBaseInstance''' behaves identically to [[GLAPI/glDrawElementsInstanced|glDrawElementsInstanced]] except that the ''i''th element transferred by the corresponding draw call will be taken from element ''indices''[i] + ''basevertex'' of each enabled array. If the resulting value is larger than the maximum value representable by ''type'', it is as if the calculation were upconverted to 32-bit unsigned integers (with wrapping on overflow conditions). The operation is undefined if the sum would be negative. The ''basevertex'' has no effect on the shader-visible value of {{code|gl_VertexID}}.
'''glDrawElementsInstancedBaseVertexBaseInstance''' behaves identically to {{apifunc|glDrawElementsInstanced}} except that each index fetched from {{enum|GL_ELEMENT_ARRAY_BUFFER}} (starting from the byte offset {{param|indices}} in bytes) will have {{param|basevertex}} added to it before fetching that index from the vertex arrays. If the resulting value is larger than the maximum value representable by {{param|type}}, it is as if the calculation were upconverted to 32-bit unsigned integers (with wrapping on overflow conditions). The operation is undefined if the sum would be negative.


Specific vertex attributes may be classified as ''instanced'' through the use of [[GLAPI/glVertexAttribDivisor|glVertexAttribDivisor]]. Instanced vertex attributes supply per-instance vertex data to the vertex shader. The index of the vertex fetched from the enabled instanced vertex attribute arrays is calculated as <math>\left \lfloor \frac{gl\_InstanceID}{divisor} + baseInstance \right \rfloor</math>. Note that ''baseinstance'' does not affect the shader-visible value of {{code|gl_InstanceID}}.
Specific vertex attributes may be classified as ''instanced'' through the use of {{apifunc|glVertexAttribDivisor}}. Instanced vertex attributes supply per-instance vertex data to the vertex shader. The index of the vertex fetched from the enabled instanced vertex attribute arrays is calculated as <math>\left \lfloor \frac{gl\_InstanceID}{divisor} + baseInstance \right \rfloor</math>. Note that {{param|baseinstance}} does not affect the shader-visible value of {{code|gl_InstanceID}}.


== Notes ==
== Notes ==
Line 38: Line 38:
== 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 ''count'' or ''primcount'' is negative.
{{enum|GL_INVALID_VALUE}} is generated if {{param|count}} or {{param|primcount}} is 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 or the element 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 or the element array and the buffer object's data store is currently mapped.


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


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


== Copyright ==
== Copyright ==

Latest revision as of 08:25, 16 September 2014

glDrawElementsInstancedBaseVertexBaseInstance
Core in version 4.6
Core since version 4.2
Core ARB extension ARB_base_instance

glDrawElementsInstancedBaseVertexBaseInstance: render multiple instances of a set of primitives from array data with a per-element offset

Function Definition

 void glDrawElementsInstancedBaseVertexBaseInstance(GLenum mode​, GLsizei count​, GLenum type​, GLvoid *indices​, GLsizei primcount​, GLint basevertex​, GLuint baseinstance​);
mode
Specifies what kind of primitives to render. Symbolic constants GL_POINTS, GL_LINE_STRIP, GL_LINE_LOOP, GL_LINES, GL_TRIANGLE_STRIP, GL_TRIANGLE_FAN, GL_TRIANGLES, GL_LINES_ADJACENCY, GL_LINE_STRIP_ADJACENCY, GL_TRIANGLES_ADJACENCY, GL_TRIANGLE_STRIP_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 indexed geometry that should be drawn.
basevertex
Specifies a constant that should be added to each element of indices​ when chosing elements from the enabled vertex arrays.
baseinstance
Specifies the base instance for use in fetching instanced vertex attributes.

Description

glDrawElementsInstancedBaseVertexBaseInstance behaves identically to glDrawElementsInstanced except that each index fetched from GL_ELEMENT_ARRAY_BUFFER (starting from the byte offset indices​ in bytes) will have basevertex​ added to it before fetching that index from the vertex arrays. If the resulting value is larger than the maximum value representable by type​, it is as if the calculation were upconverted to 32-bit unsigned integers (with wrapping on overflow conditions). The operation is undefined if the sum would be negative.

Specific vertex attributes may be classified as instanced through the use of glVertexAttribDivisor. Instanced vertex attributes supply per-instance vertex data to the vertex shader. The index of the vertex fetched from the enabled instanced vertex attribute arrays is calculated as $ \left\lfloor {\frac {gl\_InstanceID}{divisor}}+baseInstance\right\rfloor $. Note that baseinstance​ does not affect the shader-visible value of gl_InstanceID.

Notes

glDrawElementsInstancedBaseVertexBaseInstance is available only if the GL version is 4.2 or greater.

Errors

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

GL_INVALID_VALUE is generated if count​ or primcount​ is 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 or the element array and the buffer object's data store is currently mapped.

See Also

glBindVertexArray, glDrawArraysInstancedBaseInstance, glDrawElements, glDrawElementsBaseVertex, glDrawElementsIndirect, glDrawElementsInstanced, glDrawElementsInstancedBaseInstance, glDrawElementsInstancedBaseVertex, glDrawRangeElements, glDrawRangeElementsBaseVertex, glMultiDrawElements, glMultiDrawElementsBaseVertex, glMultiDrawElementsIndirect

Copyright

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

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