xenial (3) glPrimitiveRestartIndex.3G.gz

Provided by: opengl-4-man-doc_1.0~svn31251-1build1_all bug

NAME
       glPrimitiveRestartIndex - 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                │ 2.0 │ 2.1 │ 3.0 │ 3.1 │ 3.2 │ 3.3 │ 4.0 │ 4.1 │ 4.2 │ 4.3 │ 4.4 │ 4.5 │
       │/                       │     │     │     │     │     │     │     │     │     │     │     │     │
       │Feature                 │     │     │     │     │     │     │     │     │     │     │     │     │
       │Name                    │     │     │     │     │     │     │     │     │     │     │     │     │
       ├────────────────────────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┼─────┤
       │glPrimitiveRestartIndex │  -  │  -  │  -  │  ✔  │  ✔  │  ✔  │  ✔  │  ✔  │  ✔  │  ✔  │  ✔  │  ✔  │
       └────────────────────────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┘


SEE ALSO
       glDrawArrays(), glDrawElements(), glDrawElementsBaseVertex(), glDrawElementsInstancedBaseVertex()


       Copyright © 2010-2014 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/.


       Copyright © 2010-2014 Khronos Group

[FIXME: source]                                    07/22/2015                           GLPRIMITIVERESTARTIN(3G)