Light | Dark

glGetVertexArrayIndexed

Name

glGetVertexArrayIndexed — retrieve parameters of an attribute of a vertex array object

C Specification

void glGetVertexArrayIndexed64iv( GLuint vaobj,
  GLuint index,
  GLenum pname,
  GLint64 *param);
 
void glGetVertexArrayIndexediv( GLuint vaobj,
  GLuint index,
  GLenum pname,
  GLint *param);
 

Parameters

vaobj

Specifies the name of a vertex array object.

index

Specifies the index of the vertex array object attribute. Must be a number between 0 and (GL_MAX_VERTEX_ATTRIBS - 1).

pname

Specifies the property to be used for the query. For glGetVertexArrayIndexediv, it must be one of the following values: GL_VERTEX_ATTRIB_ARRAY_ENABLED, GL_VERTEX_ATTRIB_ARRAY_SIZE, GL_VERTEX_ATTRIB_ARRAY_STRIDE, GL_VERTEX_ATTRIB_ARRAY_TYPE, GL_VERTEX_ATTRIB_ARRAY_NORMALIZED, GL_VERTEX_ATTRIB_ARRAY_INTEGER, GL_VERTEX_ATTRIB_ARRAY_LONG, GL_VERTEX_ATTRIB_ARRAY_DIVISOR, or GL_VERTEX_ATTRIB_RELATIVE_OFFSET. For glGetVertexArrayIndexed64v, it must be equal to GL_VERTEX_BINDING_OFFSET.

param

Returns the requested value.

Description

glGetVertexArrayIndexediv and glGetVertexArrayIndexed64iv provide a way of querying parameters of an attribute at an user-specified index of a vertex array object. The vertex array object does not have to be bound to the rendering context at the time of the call, but must have been bound at least once prior to this call.

The following parameter values can be retrieved with glGetVertexArrayIndexediv for each of the attributes defined for a vertex array object:

  • GL_VERTEX_ATTRIB_ARRAY_ENABLED: param returns a value that is non-zero (true) if the vertex attribute array for index is enabled and 0 (false) if it is disabled. The initial value is GL_FALSE.

  • GL_VERTEX_ATTRIB_ARRAY_SIZE: param returns a single value, the size of the vertex attribute array for index. The size is the number of values for each element of the vertex attribute array, and it will be 1, 2, 3 or 4. The initial value is 4.

  • GL_VERTEX_ATTRIB_ARRAY_STRIDE: param returns a single value, the array stride for (number of bytes between successive elements in) the vertex attribute array for index. A value of 0 indicates the array elements are stored sequentially in memory. The initial value is 0.

  • GL_VERTEX_ATTRIB_ARRAY_TYPE: param returns a single value, a symbolic constant indicating the array type for the vertex attribute array for index. Possible values are GL_BYTE, GL_DOUBLE, GL_FIXED, GL_FLOAT, GL_HALF_FLOAT, GL_INT, GL_INT_2_10_10_10_REV, GL_SHORT, GL_UNSIGNED_BYTE, GL_UNSIGNED_SHORT, GL_UNSIGNED_INT, GL_UNSIGNED_INT_2_10_10_10_REV, and GL_UNSIGNED_INT_10F_11F_11F_REV . The initial value is GL_FLOAT.

  • GL_VERTEX_ATTRIB_ARRAY_NORMALIZED: param returns a single value that is non-zero (true) if fixed-point data types for the vertex attribute array indicated by index are normalized when they are converted to floating-point, and 0 (false) otherwise. The initial value is GL_FALSE.

  • GL_VERTEX_ATTRIB_ARRAY_INTEGER: param returns a single value that is non-zero (true) if fixed-point data types for the vertex attribute array indicated by index have integer data type, and 0 (false) otherwise. The initial value is 0 (GL_FALSE).

  • GL_VERTEX_ATTRIB_ARRAY_LONG: param returns a single value that is non-zero (true) if a vertex attribute is stored as an unconverted double, and 0 (false) otherwise. The initial value is 0 (GL_FALSE).

  • GL_VERTEX_ATTRIB_ARRAY_DIVISOR: param returns a single value that is the frequency divisor used for instanced rendering. See glVertexAttribDivisor. The initial value is 0.

  • GL_VERTEX_ATTRIB_RELATIVE_OFFSET: param returns a single value that is the byte offset of the first element relative to the start of the vertex buffer binding specified attribute fetches from. The initial value is 0.

glGetVertexArrayIndexed64iv can be used to retrieve GL_VERTEX_BINDING_OFFSET parameter value for any of the attributes defined for a vertex array object. When pname is set to GL_VERTEX_BINDING_OFFSET, param returns a single value that is the byte offset of the first element in the bound buffer's data store. The initial value for this parameter is 0.

Errors

GL_INVALID_OPERATION error is generated if vaobj is not the name of an existing vertex array object.

GL_INVALID_VALUE error is generated if index is greater than or equal to the value of GL_MAX_VERTEX_ATTRIBS.

GL_INVALID_ENUM error is generated if pname is not one of the valid values. For more details, please see above.

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
glGetVertexArrayIndexed64iv - - - - - - - - - - -
glGetVertexArrayIndexediv - - - - - - - - - - -
Think you can improve this page? Edit this page on GitHub.