GLAPI/glGetQuery

From OpenGL.org
< GLAPI(Redirected from GLAPI/glGetQueryiv)
Jump to: navigation, search
glGetQueryiv
Core in version 4.4
Core since version 1.5

glGetQueryiv: return parameters of a query object target

Function Definition

 void glGetQueryiv(GLenum target​, 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​.
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

glGetQueryiv returns in params​ a selected parameter of the query object target specified by target​.

pname​ names a specific query object target parameter. When pname​ is GL_CURRENT_QUERY​, the name of the currently active query for 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​.

Errors

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

See Also

glBeginQuery, glEndQuery, glGetQueryIndexed

Copyright

Copyright © 2005 Addison-Wesley. 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/.