GLAPI/glQueryCounter: Difference between revisions

From OpenGL Wiki
Jump to navigation Jump to search
← Older edit
m Bot: Adjusting API page category.
m Bot: Adding better formatting.
 
(6 intermediate revisions by 2 users not shown)
Line 9: Line 9:
== Function Definition ==
== Function Definition ==


   void '''glQueryCounter'''(GLuint ''id'', GLenum ''target'');
   void '''glQueryCounter'''(GLuint {{param|id}}, GLenum {{param|target}});


; id
; id
: Specify the name of a query object into which to record the GL time.
: Specify the name of a query object into which to record the GL time.
; target
; target
: Specify the counter to query. ''target'' must be {{code|GL_TIMESTAMP}}.
: Specify the counter to query. {{param|target}} must be {{enum|GL_TIMESTAMP}}.


== Description ==
== Description ==


'''glQueryCounter''' causes the GL to record the current time into the query object named ''id''. ''target'' must be {{code|GL_TIMESTAMP}}. The time is recorded after all previous commands on the GL client and server state and the framebuffer have been fully realized. When the time is recorded, the query result for that object is marked available. '''glQueryCounter''' timer queries can be used within a [[GLAPI/glBeginQuery|glBeginQuery]] / [[GLAPI/glEndQuery|glEndQuery]] block where the target is {{code|GL_TIME_ELAPSED}} and it does not affect the result of that query object.
'''glQueryCounter''' causes the GL to record the current time into the query object named {{param|id}}. {{param|target}} must be {{enum|GL_TIMESTAMP}}. The time is recorded after all previous commands on the GL client and server state and the framebuffer have been fully realized. When the time is recorded, the query result for that object is marked available. '''glQueryCounter''' timer queries can be used within a {{apifunc|glBeginQuery}} / {{apifunc|glEndQuery}} block where the target is {{enum|GL_TIME_ELAPSED}} and it does not affect the result of that query object.


== Notes ==
== Notes ==
Line 26: Line 26:
== Errors ==
== Errors ==


{{code|GL_INVALID_OPERATION}} is generated if ''id'' is the name of a query object that is already in use within a [[GLAPI/glBeginQuery|glBeginQuery]] / [[GLAPI/glEndQuery|glEndQuery]] block.
{{enum|GL_INVALID_OPERATION}} is generated if {{param|id}} is the name of a query object that is already in use within a {{apifunc|glBeginQuery}} / {{apifunc|glEndQuery}} block.


{{code|GL_INVALID_VALUE}} is generated if ''id'' is not the name of a query object returned from a previous call to [[GLAPI/glGenQueries|glGenQueries]].
{{enum|GL_INVALID_VALUE}} is generated if {{param|id}} is not the name of a query object returned from a previous call to {{apifunc|glGenQueries}}.


{{code|GL_INVALID_ENUM}} is generated if ''target'' is not {{code|GL_TIMESTAMP}}.
{{enum|GL_INVALID_ENUM}} is generated if {{param|target}} is not {{enum|GL_TIMESTAMP}}.


== See Also ==
== See Also ==


[[GLAPI/glGenQueries|glGenQueries]], [[GLAPI/glBeginQuery|glBeginQuery]], [[GLAPI/glEndQuery|glEndQuery]], [[GLAPI/glDeleteQueries|glDeleteQueries]], [[GLAPI/glGetQueryObject|glGetQueryObject]], [[GLAPI/glGetQueryiv|glGetQueryiv]], [[GLAPI/glGet|glGet]]
{{apifunc|glGenQueries}}, {{apifunc|glGetQueryObject}}


== Copyright ==
== Copyright ==
Line 40: Line 40:
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/ http://opencontent.org/openpub/].
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/ http://opencontent.org/openpub/].


[[Category:API Reference 4|QueryCounter]]
[[Category:Core API Ref Queries and Timers|QueryCounter]]
[[Category:GL 4 API Special Functions|QueryCounter]]
[[Category:Core API Reference|QueryCounter]]
[[Category:Query Object API State Functions|QueryCounter]]

Latest revision as of 10:03, 15 August 2013

glQueryCounter
Core in version 4.6
Core since version 3.3
Core ARB extension ARB_timer_query

glQueryCounter: record the GL time into a query object after all previous commands have reached the GL server but have not yet necessarily executed.

Function Definition

 void glQueryCounter(GLuint id​, GLenum target​);
id
Specify the name of a query object into which to record the GL time.
target
Specify the counter to query. target​ must be GL_TIMESTAMP.

Description

glQueryCounter causes the GL to record the current time into the query object named id​. target​ must be GL_TIMESTAMP. The time is recorded after all previous commands on the GL client and server state and the framebuffer have been fully realized. When the time is recorded, the query result for that object is marked available. glQueryCounter timer queries can be used within a glBeginQuery / glEndQuery block where the target is GL_TIME_ELAPSED and it does not affect the result of that query object.

Notes

glQueryCounter is available only if the GL version is 3.3 or higher.

Errors

GL_INVALID_OPERATION is generated if id​ is the name of a query object that is already in use within a glBeginQuery / glEndQuery block.

GL_INVALID_VALUE is generated if id​ is not the name of a query object returned from a previous call to glGenQueries.

GL_INVALID_ENUM is generated if target​ is not GL_TIMESTAMP.

See Also

glGenQueries, glGetQueryObject

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

Retrieved from "https://wikis.khronos.org/opengl/index.php?title=GLAPI/glQueryCounter&oldid=11071"