GLAPI/glMultiDrawElementsBaseVertex

From OpenGL.org
Jump to: navigation, search
glMultiDrawElementsBaseVertex
Core in version 4.4
Core since version 3.2
Core ARB extension ARB_draw_elements_base_vertex

glMultiDrawElementsBaseVertex: render multiple sets of primitives by specifying indices of array data elements and an index to apply to each index

Function Definition

 void glMultiDrawElementsBaseVertex(GLenum mode​, const GLsizei *count​, GLenum type​, const GLvoid * const *indices​, GLsizei drawcount​, const GLint *basevertex​);
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
Points to an array of the elements counts.
type
Specifies the type of the values in indices​. Must be one of GL_UNSIGNED_BYTE​, GL_UNSIGNED_SHORT​, or GL_UNSIGNED_INT​.
indices
Points to an array of drawcount​ values, where each value is a byte offset (cast to a pointer type) into the buffer bound to GL_ELEMENT_ARRAY_BUFFER​ to start reading indices from.
drawcount
Specifies the size of the count​, indices​ and basevertex​ arrays.
basevertex
Points to an array of base vertex values.

Description

glMultiDrawElementsBaseVertex behaves identically to glDrawElementsBaseVertex, except that drawcount​ separate lists of elements are specified instead.

It has the same effect as:

    for (int i = 0; i < drawcount; i++) {
            glDrawElementsBaseVertex(mode,
                                     count[i],
                                     type,
                                     (GLvoid *)indices[i],
                                     basevertex[i]);
    }

Notes

glMultiDrawElementsBaseVertex 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 an accepted value.

GL_INVALID_VALUE​ is generated if drawcount​ is negative.

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, glDrawElements, glDrawElementsBaseVertex, glDrawElementsIndirect, glDrawElementsInstanced, glDrawElementsInstancedBaseInstance, glDrawElementsInstancedBaseVertex, glDrawElementsInstancedBaseVertexBaseInstance, glDrawRangeElements, glDrawRangeElementsBaseVertex, glMultiDrawArrays, glMultiDrawElements, 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/.