GLAPI/glMultiDrawElements: Difference between revisions
m Renaming category: 'API Reference 4' to 'Core API Reference'. |
m Bot: Adding better formatting. |
||
| Line 8: | Line 8: | ||
== Function Definition == | == Function Definition == | ||
void '''glMultiDrawElements'''(GLenum | void '''glMultiDrawElements'''(GLenum {{param|mode}}, const GLsizei * {{param|count}}, GLenum {{param|type}}, const GLvoid ** {{param|indices}}, GLsizei {{param|primcount}}); | ||
; mode | ; mode | ||
| Line 15: | Line 15: | ||
: Points to an array of the elements counts. | : Points to an array of the elements counts. | ||
; type | ; type | ||
: Specifies the type of the values in | : Specifies the type of the values in {{param|indices}}. Must be one of {{code|GL_UNSIGNED_BYTE}}, {{code|GL_UNSIGNED_SHORT}}, or {{code|GL_UNSIGNED_INT}}. | ||
; indices | ; indices | ||
: Specifies a pointer to the location where the indices are stored. | : Specifies a pointer to the location where the indices are stored. | ||
; primcount | ; primcount | ||
: Specifies the size of the | : Specifies the size of the {{param|count}} array. | ||
== Description == | == Description == | ||
| Line 25: | Line 25: | ||
'''glMultiDrawElements''' specifies multiple sets of geometric primitives with very few subroutine calls. Instead of calling a GL function to pass each individual vertex, normal, texture coordinate, edge flag, or color, you can prespecify separate arrays of vertices, normals, and so on, and use them to construct a sequence of primitives with a single call to '''glMultiDrawElements'''. | '''glMultiDrawElements''' specifies multiple sets of geometric primitives with very few subroutine calls. Instead of calling a GL function to pass each individual vertex, normal, texture coordinate, edge flag, or color, you can prespecify separate arrays of vertices, normals, and so on, and use them to construct a sequence of primitives with a single call to '''glMultiDrawElements'''. | ||
'''glMultiDrawElements''' is identical in operation to | '''glMultiDrawElements''' is identical in operation to {{apifunc|glDrawElements}} except that {{param|primcount}} separate lists of elements are specified. | ||
Vertex attributes that are modified by '''glMultiDrawElements''' have an unspecified value after '''glMultiDrawElements''' returns. Attributes that aren't modified maintain their previous values. | Vertex attributes that are modified by '''glMultiDrawElements''' have an unspecified value after '''glMultiDrawElements''' returns. Attributes that aren't modified maintain their previous values. | ||
| Line 35: | Line 35: | ||
== Errors == | == Errors == | ||
{{code|GL_INVALID_ENUM}} is generated if | {{code|GL_INVALID_ENUM}} is generated if {{param|mode}} is not an accepted value. | ||
{{code|GL_INVALID_VALUE}} is generated if | {{code|GL_INVALID_VALUE}} is generated if {{param|primcount}} is negative. | ||
{{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. | {{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. | ||
| Line 43: | Line 43: | ||
== See Also == | == See Also == | ||
{{apifunc|glDrawArrays}}, {{apifunc|glDrawRangeElements}} | |||
== Copyright == | == Copyright == | ||
Revision as of 01:23, 29 April 2012
| Core in version | 4.6 | |
|---|---|---|
| Core since version | 1.4 | |
glMultiDrawElements: render multiple sets of primitives by specifying indices of array data elements
Function Definition
void glMultiDrawElements(GLenum mode, const GLsizei * count, GLenum type, const GLvoid ** 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
- 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
- Specifies a pointer to the location where the indices are stored.
- primcount
- Specifies the size of the count array.
Description
glMultiDrawElements specifies multiple sets of geometric primitives with very few subroutine calls. Instead of calling a GL function to pass each individual vertex, normal, texture coordinate, edge flag, or color, you can prespecify separate arrays of vertices, normals, and so on, and use them to construct a sequence of primitives with a single call to glMultiDrawElements.
glMultiDrawElements is identical in operation to glDrawElements except that primcount separate lists of elements are specified.
Vertex attributes that are modified by glMultiDrawElements have an unspecified value after glMultiDrawElements returns. Attributes that aren't modified maintain their previous values.
Notes
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 primcount 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
glDrawArrays, glDrawRangeElements
Copyright
Copyright © 1991-2006 Silicon Graphics, Inc. This document is licensed under the SGI Free Software B License. For details, see http://oss.sgi.com/projects/FreeB/.