'\" t
.\"     Title: glGetQueryObject
.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\"      Date: 05/21/2015
.\"    Manual: [FIXME: manual]
.\"    Source: [FIXME: source]
.\"  Language: English
.\"
.TH "GLGETQUERYOBJECT" "3G" "05/21/2015" "[FIXME: source]" "[FIXME: manual]"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
glGetQueryObject \- return parameters of a query object
.SH "C SPECIFICATION"
.HP \w'void\ glGetQueryObjectiv('u
.BI "void glGetQueryObjectiv(GLuint\ " "id" ", GLenum\ " "pname" ", GLint\ *\ " "params" ");"
.HP \w'void\ glGetQueryObjectuiv('u
.BI "void glGetQueryObjectuiv(GLuint\ " "id" ", GLenum\ " "pname" ", GLuint\ *\ " "params" ");"
.HP \w'void\ glGetQueryObjecti64v('u
.BI "void glGetQueryObjecti64v(GLuint\ " "id" ", GLenum\ " "pname" ", GLint64\ *\ " "params" ");"
.HP \w'void\ glGetQueryObjectui64v('u
.BI "void glGetQueryObjectui64v(GLuint\ " "id" ", GLenum\ " "pname" ", GLuint64\ *\ " "params" ");"
.SH "PARAMETERS"
.PP
\fIid\fR
.RS 4
Specifies the name of a query object\&.
.RE
.PP
\fIpname\fR
.RS 4
Specifies the symbolic name of a query object parameter\&. Accepted values are
\fBGL_QUERY_RESULT\fR
or
\fBGL_QUERY_RESULT_AVAILABLE\fR\&.
.RE
.PP
\fIparams\fR
.RS 4
If a buffer is bound to the
\fBGL_QUERY_RESULT_BUFFER\fR
target, then
\fIparams\fR
is treated as an offset to a location within that buffer\*(Aqs data store to receive the result of the query\&. If no buffer is bound to
\fBGL_QUERY_RESULT_BUFFER\fR, then
\fIparams\fR
is treated as an address in client memory of a variable to receive the resulting data\&.
.RE
.SH "DESCRIPTION"
.PP
\fBglGetQueryObject\fR
returns in
\fIparams\fR
a selected parameter of the query object specified by
\fIid\fR\&.
.PP
\fIpname\fR
names a specific query object parameter\&.
\fIpname\fR
can be as follows:
.PP
\fBGL_QUERY_RESULT\fR
.RS 4
\fIparams\fR
returns the value of the query object\*(Aqs passed samples counter\&. The initial value is 0\&.
.RE
.PP
\fBGL_QUERY_RESULT_NO_WAIT\fR
.RS 4
If the result of the query is available (that is, a query of
\fBGL_QUERY_RESULT_AVAILABLE\fR
would return non\-zero), then
\fIparams\fR
returns the value of the query object\*(Aqs passed samples counter, otherwise, the data referred to by
\fIparams\fR
is not modified\&. The initial value is 0\&.
.RE
.PP
\fBGL_QUERY_RESULT_AVAILABLE\fR
.RS 4
\fIparams\fR
returns whether the passed samples counter is immediately available\&. If a delay would occur waiting for the query result,
\fBGL_FALSE\fR
is returned\&. Otherwise,
\fBGL_TRUE\fR
is returned, which also indicates that the results of all previous queries are available as well\&.
.RE
.SH "NOTES"
.PP
If an error is generated, no change is made to the contents of
\fIparams\fR\&.
.PP
\fBglGetQueryObject\fR
implicitly flushes the GL pipeline so that any incomplete rendering delimited by the occlusion query completes in finite time\&.
.PP
If multiple queries are issued using the same query object
\fIid\fR
before calling
\fBglGetQueryObject\fR, the results of the most recent query will be returned\&. In this case, when issuing a new query, the results of the previous query are discarded\&.
.PP
\fBglGetQueryObjecti64v\fR
and
\fBglGetQueryObjectui64v\fR
are available only if the GL version is 3\&.3 or greater\&.
.PP
\fBGL_QUERY_RESULT_NO_WAIT\fR
is accepted for
\fIpname\fR
only if the GL version is 4\&.4 or greater\&.
.PP
The
\fBGL_QUERY_RESULT_BUFFER\fR
target is available only if the GL version is 4\&.4 or higher\&. On earlier versions of the GL,
\fIparams\fR
is always an address in client memory\&.
.SH "ERRORS"
.PP
\fBGL_INVALID_ENUM\fR
is generated if
\fIpname\fR
is not an accepted value\&.
.PP
\fBGL_INVALID_OPERATION\fR
is generated if
\fIid\fR
is not the name of a query object\&.
.PP
\fBGL_INVALID_OPERATION\fR
is generated if
\fIid\fR
is the name of a currently active query object\&.
.PP
\fBGL_INVALID_OPERATION\fR
is generated if a buffer is currently bound to the
\fBGL_QUERY_RESULT_BUFFER\fR
target and the command would cause data to be written beyond the bounds of that buffer\*(Aqs data store\&.
.SH "VERSION SUPPORT"
.TS
allbox tab(:);
lB cB s s s s s s s s s s s
lB cB cB cB cB cB cB cB cB cB cB cB cB.
T{

T}:T{
\fBOpenGL Version\fR
T}
T{
\fBFunction / Feature Name\fR
T}:T{
\fB2\&.0\fR
T}:T{
\fB2\&.1\fR
T}:T{
\fB3\&.0\fR
T}:T{
\fB3\&.1\fR
T}:T{
\fB3\&.2\fR
T}:T{
\fB3\&.3\fR
T}:T{
\fB4\&.0\fR
T}:T{
\fB4\&.1\fR
T}:T{
\fB4\&.2\fR
T}:T{
\fB4\&.3\fR
T}:T{
\fB4\&.4\fR
T}:T{
\fB4\&.5\fR
T}
.T&
l c c c c c c c c c c c c
l c c c c c c c c c c c c
l c c c c c c c c c c c c
l c c c c c c c c c c c c.
T{
\fBglGetQueryObjecti64v\fR
T}:T{
\-
T}:T{
\-
T}:T{
\-
T}:T{
\-
T}:T{
✔
T}:T{
✔
T}:T{
✔
T}:T{
✔
T}:T{
✔
T}:T{
✔
T}:T{
✔
T}:T{
✔
T}
T{
\fBglGetQueryObjectiv\fR
T}:T{
✔
T}:T{
✔
T}:T{
✔
T}:T{
✔
T}:T{
✔
T}:T{
✔
T}:T{
✔
T}:T{
✔
T}:T{
✔
T}:T{
✔
T}:T{
✔
T}:T{
✔
T}
T{
\fBglGetQueryObjectui64v\fR
T}:T{
\-
T}:T{
\-
T}:T{
\-
T}:T{
\-
T}:T{
✔
T}:T{
✔
T}:T{
✔
T}:T{
✔
T}:T{
✔
T}:T{
✔
T}:T{
✔
T}:T{
✔
T}
T{
\fBglGetQueryObjectuiv\fR
T}:T{
✔
T}:T{
✔
T}:T{
✔
T}:T{
✔
T}:T{
✔
T}:T{
✔
T}:T{
✔
T}:T{
✔
T}:T{
✔
T}:T{
✔
T}:T{
✔
T}:T{
✔
T}
.TE
.sp
.SH "SEE ALSO"
.PP
\fBglBeginQuery\fR(),
\fBglEndQuery\fR(),
\fBglGetQueryiv\fR(),
\fBglIsQuery\fR(),
\fBglQueryCounter\fR()
.SH "COPYRIGHT"
.PP
Copyright
\(co
2005 Addison\-Wesley\&. Copyright
\(co
2010\-2014 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\&.
\m[blue]\fBhttp://opencontent\&.org/openpub/\fR\m[]\&.
.SH "COPYRIGHT"
.br
Copyright \(co 2005 Sams Publishing
.br
Copyright \(co 2010-2014 Khronos Group
.br