GLGETQUERYOBJECTUIV(3G)

    .SH "NAME" glGetQueryObjectuiv - return parameters of a query object
    .SH "C SPECIFICATION"

            .HP u void glGetQueryObjectuiv(GLuint id, GLenum pname, GLuint * params);

    .SH "PARAMETERS"

        .PP id

                    Specifies the name of a query object.

            .RE
            .PP pname

                        Specifies the symbolic name of a query object parameter. Accepted values are GL_QUERY_RESULT or GL_QUERY_RESULT_AVAILABLE.

                .RE
                .PP params

                            Returns the requested data.

                    .RE

                .SH "DESCRIPTION"
                    .PP glGetQueryObjectuiv returns in params a selected parameter of the query object specified by id.
                    .PP pname names a specific query object parameter. pname can be as follows:

                        .PP GL_QUERY_RESULT

                                    params returns the value of the query object's passed samples counter. The initial value is 0.

                            .RE
                            .PP GL_QUERY_RESULT_AVAILABLE

                                        params returns whether the passed samples counter is immediately available. If a delay would occur waiting for the query result, GL_FALSE is returned. Otherwise, GL_TRUE is returned, which also indicates that the results of all previous queries of the same type are available as well.

                                .RE

                        .SH "NOTES"
                            .PP If an error is generated, no change is made to the contents of params.
                            .PP When pname is GL_QUERY_RESULT, glGetQueryObjectuiv implicitly flushes the GL pipeline so that any incomplete rendering delimited by the occlusion query completes in finite time.
                            .PP Repeatedly querying the GL_QUERY_RESULT_AVAILABLE state for any given query object is guaranteed to return true eventually. Note that multiple queries to the same occlusion object may result in a significant performance loss. For better performance it is recommended to wait N frames before querying this state. N is implementation-dependent but is generally between one and three.
                                    .PP If multiple queries are issued using the same query object id before calling glGetQueryObjectuiv, 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.

                        .SH "ERRORS"
                            .PP GL_INVALID_ENUM is generated if pname is not an accepted value.
                            .PP GL_INVALID_OPERATION is generated if id is not the name of a query object.
                            .PP GL_INVALID_OPERATION is generated if id is the name of a currently active query object.

                        .SH "API VERSION SUPPORT"

                            .TS allbox tab(:); l l l l l. T{ glGetQueryObjectuiv T}:T{ T}:T{ T}:T{ T}:T{ T}

                        .SH "SEE ALSO"
                            .PP glBeginQuery(), glEndQuery(), glGetQueryiv(), glIsQuery(),

                        .SH "COPYRIGHT"
                            .PP Copyright © 2005 Addison-Wesley. Copyright © 2010-2015 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/.

COPYRIGHT
Copyright © 2005 Sams Publishing
Copyright © 2010-2015 Khronos Group