GLAPI/glGetQuery: Difference between revisions
< GLAPI
m Renaming category: 'API Reference 4' to 'Core API Reference'. |
m Bot: Adding better formatting. |
||
| (4 intermediate revisions by the same user not shown) | |||
| Line 8: | Line 8: | ||
== Function Definition == | == Function Definition == | ||
void '''glGetQueryiv'''(GLenum | void '''glGetQueryiv'''(GLenum {{param|target}}, GLenum {{param|pname}}, GLint * {{param|params}}); | ||
; 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_ANY_SAMPLES_PASSED_CONSERVATIVE}}{{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 19: | Line 19: | ||
== Description == | == Description == | ||
'''glGetQueryiv''' returns in | '''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 {{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 == | ||
If an error is generated, no change is made to the contents of | The target {{enum|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 {{param|params}}. | |||
== Errors == | == Errors == | ||
{{ | {{enum|GL_INVALID_ENUM}} is generated if {{param|target}} or {{param|pname}} is not an accepted value. | ||
== See Also == | == See Also == | ||
{{apifunc|glBeginQuery}}, {{apifunc|glEndQuery}}, {{apifunc|glGetQueryIndexed}} | |||
== Copyright == | == Copyright == | ||
| Line 41: | Line 43: | ||
[[Category:Core API Ref Queries and Timers|GetQuery]] | [[Category:Core API Ref Queries and Timers|GetQuery]] | ||
[[Category:Core API Reference|GetQuery]] | [[Category:Core API Reference|GetQuery]] | ||
[[Category:Query Object API State Functions|GetQuery]] | |||
Latest revision as of 10:00, 15 August 2013
| 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_ANY_SAMPLES_PASSED_CONSERVATIVEGL_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/.