GLAPI/glGetQueryIndexed: Difference between revisions
m Bot: Adding better formatting. |
m Bot: Adding better formatting. |
||
| Line 12: | Line 12: | ||
; 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}}. | ||
; 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 {{ | : 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 24: | Line 24: | ||
'''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. | '''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. | ||
{{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 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 == | ||
| Line 34: | Line 34: | ||
== Errors == | == Errors == | ||
{{ | {{enum|GL_INVALID_ENUM}} is generated if {{param|target}} or {{param|pname}} is not an accepted value. | ||
{{ | {{enum|GL_INVALID_VALUE}} is generated if {{param|index}} is greater than or equal to the {{param|target}}-specific maximum. | ||
== See Also == | == See Also == | ||
Revision as of 17:24, 29 April 2012
| 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_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
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
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/.