GLAPI/glDrawRangeElementsBaseVertex: Difference between revisions
< GLAPI
m Renaming category: 'GL 4 API Vertex Rendering' to 'Core API Ref Vertex Rendering'. |
Better indices specification. |
||
| (5 intermediate revisions by 2 users not shown) | |||
| Line 9: | Line 9: | ||
== Function Definition == | == Function Definition == | ||
void '''glDrawRangeElementsBaseVertex'''(GLenum | void '''glDrawRangeElementsBaseVertex'''(GLenum {{param|mode}}, GLuint {{param|start}}, GLuint {{param|end}}, GLsizei {{param|count}}, GLenum {{param|type}}, GLvoid *{{param|indices}}, GLint {{param|basevertex}}); | ||
; mode | ; mode | ||
: Specifies what kind of primitives to render. Symbolic constants {{ | : 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. | ||
; start | ; start | ||
: Specifies the minimum array index contained in | : Specifies the minimum array index contained in {{param|indices}}. | ||
; end | ; end | ||
: Specifies the maximum array index contained in | : Specifies the maximum array index contained in {{param|indices}}. | ||
; 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 {{ | : 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 | : Specifies a byte offset (cast to a pointer type) into the buffer bound to {{enum|GL_ELEMENT_ARRAY_BUFFER}} to start reading indices from. | ||
; basevertex | ; basevertex | ||
: Specifies a constant that should be added to each element of | : Specifies a constant that should be added to each element of {{param|indices}} when chosing elements from the enabled vertex arrays. | ||
== Description == | == Description == | ||
'''glDrawRangeElementsBaseVertex''' is a restricted form of | '''glDrawRangeElementsBaseVertex''' is a restricted form of {{apifunc|glDrawElementsBaseVertex}}. {{param|mode}}, {{param|start}}, {{param|end}}, {{param|count}} and {{param|basevertex}} match the corresponding arguments to {{apifunc|glDrawElementsBaseVertex}}, with the additional constraint that all values in the array {{param|indices}} must lie between {{param|start}} and {{param|end}}, inclusive, prior to adding {{param|basevertex}}. Index values lying outside the range [{{param|start}}, {{param|end}}] are treated in the same way as {{apifunc|glDrawRangeElements}}. | ||
Each index fetched from {{enum|GL_ELEMENT_ARRAY_BUFFER}} (starting from the byte offset {{param|indices}} in bytesbytes) 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. | |||
== Errors == | == Errors == | ||
{{ | {{enum|GL_INVALID_ENUM}} is generated if {{param|mode}} is not an accepted value. | ||
{{ | {{enum|GL_INVALID_VALUE}} is generated if {{param|count}} is negative. | ||
{{ | {{enum|GL_INVALID_VALUE}} is generated if {{param|end}} < {{param|start}}. | ||
{{ | {{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. | ||
{{ | {{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 == | ||
{{apifunc|glBindVertexArray}}, {{apifunc|glDrawElements}}, {{apifunc|glDrawElementsBaseVertex}}, {{apifunc|glDrawElementsIndirect}}, {{apifunc|glDrawElementsInstanced}}, {{apifunc|glDrawElementsInstancedBaseInstance}}, {{apifunc|glDrawElementsInstancedBaseVertex}}, {{apifunc|glDrawElementsInstancedBaseVertexBaseInstance}}, {{apifunc|glDrawRangeElements}}, {{apifunc|glMultiDrawElements}}, {{apifunc|glMultiDrawElementsBaseVertex}}, {{apifunc|glMultiDrawElementsIndirect}} | |||
== Copyright == | == Copyright == | ||
| Line 50: | Line 52: | ||
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:Core API Ref Vertex Rendering|DrawRangeElementsBaseVertex]] | [[Category:Core API Ref Vertex Rendering|DrawRangeElementsBaseVertex]] | ||
[[Category:Core API Reference|DrawRangeElementsBaseVertex]] | |||
Latest revision as of 05:19, 31 July 2013
| Core in version | 4.6 | |
|---|---|---|
| Core since version | 3.2 | |
| Core ARB extension | ARB_draw_elements_base_vertex | |
glDrawRangeElementsBaseVertex: render primitives from array data with a per-element offset
Function Definition
void glDrawRangeElementsBaseVertex(GLenum mode, GLuint start, GLuint end, GLsizei count, GLenum type, GLvoid *indices, GLint basevertex);
- 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.
- start
- Specifies the minimum array index contained in indices.
- end
- Specifies the maximum array index contained in indices.
- 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.
- basevertex
- Specifies a constant that should be added to each element of indices when chosing elements from the enabled vertex arrays.
Description
glDrawRangeElementsBaseVertex is a restricted form of glDrawElementsBaseVertex. mode, start, end, count and basevertex match the corresponding arguments to glDrawElementsBaseVertex, with the additional constraint that all values in the array indices must lie between start and end, inclusive, prior to adding basevertex. Index values lying outside the range [start, end] are treated in the same way as glDrawRangeElements.
Each index fetched from GL_ELEMENT_ARRAY_BUFFER (starting from the byte offset indices in bytesbytes) 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.
Errors
GL_INVALID_ENUM is generated if mode is not an accepted value.
GL_INVALID_VALUE is generated if count is negative.
GL_INVALID_VALUE is generated if end < start.
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, glDrawElements, glDrawElementsBaseVertex, glDrawElementsIndirect, glDrawElementsInstanced, glDrawElementsInstancedBaseInstance, glDrawElementsInstancedBaseVertex, glDrawElementsInstancedBaseVertexBaseInstance, glDrawRangeElements, 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/.