glPrimitiveRestartIndex.3G - Man Page

specify the primitive restart index

C Specification

void glPrimitiveRestartIndex(GLuint index);

Parameters

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 either glDrawElementsBaseVertex(), glDrawElementsInstancedBaseVertex() or glMultiDrawElementsBaseVertex() 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.

Version Support

	OpenGL Version
Function / Feature Name	2.0	2.1	3.0	3.1	3.2	3.3	4.0	4.1	4.2	4.3	4.4	4.5
glPrimitiveRestartIndex	-	-	-	✔	✔	✔	✔	✔	✔	✔	✔	✔