Difference between revisions of "GLAPI/glGetQuery"

From OpenGL.org
Jump to: navigation, search
m (Bot: Adjusting API page category.)
m (Bot: Adding better formatting.)
(5 intermediate revisions by the same user not shown)
Line 8: Line 8:
 
== Function Definition ==
 
== Function Definition ==
  
   void '''glGetQueryiv'''(GLenum ''target'', GLenum ''pname'', GLint * ''params'');
+
   void '''glGetQueryiv'''(GLenum {{param|target}}, GLenum {{param|pname}}, GLint * {{param|params}});
  
 
; target
 
; target
: Specifies a query object target. Must be {{code|GL_SAMPLES_PASSED}}, {{code|GL_ANY_SAMPLES_PASSED}}, {{code|GL_PRIMITIVES_GENERATED}}, {{code|GL_TRANSFORM_FEEDBACK_PRIMITIVES_WRITTEN}}, {{code|GL_TIME_ELAPSED}}, or {{code|GL_TIMESTAMP}}.
+
: 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 {{code|GL_CURRENT_QUERY}} or {{code|GL_QUERY_COUNTER_BITS}}.
+
: 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 ''params'' a selected parameter of the query object target specified by ''target''.
+
'''glGetQueryiv''' returns in {{param|params}} a selected parameter of the query object target specified by {{param|target}}.
  
''pname'' names a specific query object target parameter. When ''pname'' is {{code|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 {{code|GL_QUERY_COUNTER_BITS}}, the implementation-dependent number of bits used to hold the result of queries for ''target'' is returned in ''params''.
+
{{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 ''params''.
+
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 ==
  
{{code|GL_INVALID_ENUM}} is generated if ''target'' or ''pname'' is not an accepted value.
+
{{enum|GL_INVALID_ENUM}} is generated if {{param|target}} or {{param|pname}} is not an accepted value.
  
 
== See Also ==
 
== See Also ==
  
[[GLAPI/glGetQueryObject|glGetQueryObject]], [[GLAPI/glIsQuery|glIsQuery]]
+
{{apifunc|glBeginQuery}}, {{apifunc|glEndQuery}}, {{apifunc|glGetQueryIndexed}}
  
 
== Copyright ==
 
== Copyright ==
Line 39: Line 41:
 
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/ http://opencontent.org/openpub/].
 
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/ http://opencontent.org/openpub/].
  
[[Category:API Reference 4|GetQueryiv]]
+
[[Category:Core API Ref Queries and Timers|GetQuery]]
[[Category:GL 4 API Queries and Timers|GetQuery]]
+
[[Category:Core API Reference|GetQuery]]

Revision as of 21:49, 26 September 2012

glGetQueryiv
Core in version 4.5
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/.