GLAPI/glGetQueryIndexed

From OpenGL.org
Jump to: navigation, search
glGetQueryIndexediv
Core in version 4.4
Core since version 4.0
Core ARB extension ARB_transform_feedback3

glGetQueryIndexediv: return parameters of an indexed query object target

Function Definition

 void glGetQueryIndexediv(GLenum target​, GLuint index​, GLenum pname​, GLint * params​);
target
Specifies a query object target. Must be GL_SAMPLES_PASSED​, GL_ANY_SAMPLES_PASSED​, GL_ANY_SAMPLES_PASSED_CONSERVATIVE​GL_PRIMITIVES_GENERATED​, GL_TRANSFORM_FEEDBACK_PRIMITIVES_WRITTEN​, GL_TIME_ELAPSED​, or GL_TIMESTAMP​.
index
Specifies the index of the query object target.
pname
Specifies the symbolic name of a query object target parameter. Accepted values are GL_CURRENT_QUERY​ or GL_QUERY_COUNTER_BITS​.
params
Returns the requested data.

Description

glGetQueryIndexediv returns in params​ a selected parameter of the indexed query object target specified by target​ and index​. index​ specifies the index of the query object target and must be between zero and a target-specific maxiumum.

pname​ names a specific query object target parameter. When pname​ is GL_CURRENT_QUERY​, the name of the currently active query for the specified index​ of target​, or zero if no query is active, will be placed in params​. If pname​ is GL_QUERY_COUNTER_BITS​, the implementation-dependent number of bits used to hold the result of queries for target​ is returned in params​.

Notes

The target GL_ANY_SAMPLES_PASSED_CONSERVATIVE​ is available only if the GL version is 4.3 or greater.

If an error is generated, no change is made to the contents of params​.

Calling glGetQueryiv is equivalent to calling glGetQueryIndexediv with index​ set to zero.

Errors

GL_INVALID_ENUM​ is generated if target​ or pname​ is not an accepted value.

GL_INVALID_VALUE​ is generated if index​ is greater than or equal to the target​-specific maximum.

See Also

glBeginQueryIndexed, glEndQueryIndexed, glGetQuery

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