Difference between revisions of "GLAPI/glGetQuery"
m (Bot: Adding better formatting.) |
m (Bot: Adding better formatting.) |
||
| Line 11: | Line 11: | ||
; target | ; target | ||
| − | : Specifies a query object target. Must be {{ | + | : Specifies a query object target. Must be {{enum|GL_SAMPLES_PASSED}}, {{enum|GL_ANY_SAMPLES_PASSED}}, {{enum|GL_PRIMITIVES_GENERATED}}, {{enum|GL_TRANSFORM_FEEDBACK_PRIMITIVES_WRITTEN}}, {{enum|GL_TIME_ELAPSED}}, or {{enum|GL_TIMESTAMP}}. |
; pname | ; pname | ||
| − | : Specifies the symbolic name of a query object target parameter. Accepted values are {{ | + | : Specifies the symbolic name of a query object target parameter. Accepted values are {{enum|GL_CURRENT_QUERY}} or {{enum|GL_QUERY_COUNTER_BITS}}. |
; params | ; params | ||
: Returns the requested data. | : Returns the requested data. | ||
| Line 21: | Line 21: | ||
'''glGetQueryiv''' returns in {{param|params}} a selected parameter of the query object target specified by {{param|target}}. | '''glGetQueryiv''' returns in {{param|params}} a selected parameter of the query object target specified by {{param|target}}. | ||
| − | {{param|pname}} names a specific query object target parameter. When {{param|pname}} is {{ | + | {{param|pname}} names a specific query object target parameter. When {{param|pname}} is {{enum|GL_CURRENT_QUERY}}, the name of the currently active query for {{param|target}}, or zero if no query is active, will be placed in {{param|params}}. If {{param|pname}} is {{enum|GL_QUERY_COUNTER_BITS}}, the implementation-dependent number of bits used to hold the result of queries for {{param|target}} is returned in {{param|params}}. |
== Notes == | == Notes == | ||
| Line 29: | Line 29: | ||
== Errors == | == Errors == | ||
| − | {{ | + | {{enum|GL_INVALID_ENUM}} is generated if {{param|target}} or {{param|pname}} is not an accepted value. |
== See Also == | == See Also == | ||
Revision as of 17:24, 29 April 2012
| Core in version | 4.6 | |
|---|---|---|
| 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_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
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
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/.