GLAPI/glPrimitiveRestartIndex

From OpenGL.org
Jump to: navigation, search
glPrimitiveRestartIndex
Core in version 4.4
Core since version 3.1

glPrimitiveRestartIndex: specify the primitive restart index

Function Definition

 void glPrimitiveRestartIndex(GLuint index​);
index
Specifies the value to be interpreted as the primitive restart index.

Description

glPrimitiveRestartIndex specifies a vertex array element that is treated specially when primitive restarting is enabled. This is known as the primitive restart index.

When one of the Draw* commands transfers a set of generic attribute array elements to the GL, if the index within the vertex arrays corresponding to that set is equal to the primitive restart index, then the GL does not process those elements as a vertex. Instead, it is as if the drawing command ended with the immediately preceding transfer, and another drawing command is immediately started with the same parameters, but only transferring the immediately following element through the end of the originally specified elements.

When one of the BaseVertex​ functions is used, the primitive restart comparison occurs before the basevertex​ offset is added to the array index.

Notes

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

See Also

Category:Core API Ref Vertex Rendering‎

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