GLAPI/glGetQueryIndexed: Difference between revisions

From OpenGL Wiki
Jump to navigation Jump to search
← Older edit
m Renaming category: 'GL 4 API Queries and Timers' to 'Core API Ref Queries and Timers'.
m Bot: Adding better formatting.
 
(4 intermediate revisions by the same user not shown)
Line 9: Line 9:
== Function Definition ==
== Function Definition ==


   void '''glGetQueryIndexediv'''(GLenum ''target'', GLuint ''index'', GLenum ''pname'', GLint * ''params'');
   void '''glGetQueryIndexediv'''(GLenum {{param|target}}, GLuint {{param|index}}, 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}}.
; index
; index
: Specifies the index of the query object target.
: Specifies the index of the query object target.
; 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 22: Line 22:
== Description ==
== Description ==


'''glGetQueryIndexediv''' returns in ''params'' a selected parameter of the indexed query object target specified by ''target'' and ''index''. ''index'' specifies the index of the query object target and must be between zero and a target-specific maxiumum.
'''glGetQueryIndexediv''' returns in {{param|params}} a selected parameter of the indexed query object target specified by {{param|target}} and {{param|index}}. {{param|index}} specifies the index of the query object target and must be between zero and a target-specific maxiumum.


''pname'' names a specific query object target parameter. When ''pname'' is {{code|GL_CURRENT_QUERY}}, the name of the currently active query for the specified ''index'' of ''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 the specified {{param|index}} of {{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.


Calling [[GLAPI/glGetQueryiv|glGetQueryiv]] is equivalent to calling '''glGetQueryIndexediv''' with ''index'' set to zero.
If an error is generated, no change is made to the contents of {{param|params}}.
 
Calling {{apifunc|glGetQueryiv}} is equivalent to calling '''glGetQueryIndexediv''' with {{param|index}} set to zero.


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


{{code|GL_INVALID_VALUE}} is generated if ''index'' is greater than or equal to the ''target''-specific maximum.
{{enum|GL_INVALID_VALUE}} is generated if {{param|index}} is greater than or equal to the {{param|target}}-specific maximum.


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


[[GLAPI/glGetQueryObject|glGetQueryObject]], [[GLAPI/glIsQuery|glIsQuery]]
{{apifunc|glBeginQueryIndexed}}, {{apifunc|glEndQueryIndexed}}, {{apifunc|glGetQuery}}


== Copyright ==
== Copyright ==
Line 46: Line 48:
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|GetQueryIndexed]]
[[Category:Core API Ref Queries and Timers|GetQueryIndexed]]
[[Category:Core API Ref Queries and Timers|GetQueryIndexed]]
[[Category:Core API Reference|GetQueryIndexed]]

Latest revision as of 01:49, 27 September 2012

glGetQueryIndexediv
Core in version 4.6
Core since version 4.0
Core ARB extension ARB_transform_feedback3

glGetQueryIndexediv: return parameters of an indexed query object target

Function Definition

 void glGetQueryIndexediv(GLenum target​, GLuint index​, 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.
index
Specifies the index of the query object target.
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

glGetQueryIndexediv returns in params​ a selected parameter of the indexed query object target specified by target​ and index​. index​ specifies the index of the query object target and must be between zero and a target-specific maxiumum.

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

Calling glGetQueryiv is equivalent to calling glGetQueryIndexediv with index​ set to zero.

Errors

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

GL_INVALID_VALUE is generated if index​ is greater than or equal to the target​-specific maximum.

See Also

glBeginQueryIndexed, glEndQueryIndexed, glGetQuery

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/glGetQueryIndexed&oldid=7354"