diff options
Diffstat (limited to 'src/gui/opengl/qopengltimerquery.cpp')
| -rw-r--r-- | src/gui/opengl/qopengltimerquery.cpp | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/src/gui/opengl/qopengltimerquery.cpp b/src/gui/opengl/qopengltimerquery.cpp index 38e988c4df..c5c3d42e5d 100644 --- a/src/gui/opengl/qopengltimerquery.cpp +++ b/src/gui/opengl/qopengltimerquery.cpp @@ -330,7 +330,7 @@ QOpenGLTimerQuery::~QOpenGLTimerQuery() Creates the underlying OpenGL timer query object. There must be a valid OpenGL context that supports query objects current for this function to succeed. - Returns true if the OpenGL timer query object was successfully created. + Returns \c true if the OpenGL timer query object was successfully created. */ bool QOpenGLTimerQuery::create() { @@ -349,8 +349,8 @@ void QOpenGLTimerQuery::destroy() } /*! - Returns true if the underlying OpenGL query object has been created. If this - returns true and the associated OpenGL context is current, then you are able to issue + Returns \c true if the underlying OpenGL query object has been created. If this + returns \c true and the associated OpenGL context is current, then you are able to issue queries with this object. */ bool QOpenGLTimerQuery::isCreated() const @@ -428,7 +428,7 @@ GLuint64 QOpenGLTimerQuery::waitForTimestamp() const } /*! - Returns true if the OpenGL timer query result is available. + Returns \c true if the OpenGL timer query result is available. This function is non-blocking and ideally should be used to check for the availability of the query result before calling waitForResult(). @@ -757,7 +757,7 @@ int QOpenGLTimeMonitor::sampleCount() const to track the amount of time taken to execute OpenGL commands between successive calls to recordSample(). - Returns true if the OpenGL timer query objects could be created. + Returns \c true if the OpenGL timer query objects could be created. \sa destroy(), setSampleCount(), recordSample() */ @@ -779,8 +779,8 @@ void QOpenGLTimeMonitor::destroy() } /*! - Returns true if the underlying OpenGL query objects have been created. If this - returns true and the associated OpenGL context is current, then you are able to record + Returns \c true if the underlying OpenGL query objects have been created. If this + returns \c true and the associated OpenGL context is current, then you are able to record time samples with this object. */ bool QOpenGLTimeMonitor::isCreated() const @@ -814,7 +814,7 @@ int QOpenGLTimeMonitor::recordSample() } /*! - Returns true if the OpenGL timer query results are available. + Returns \c true if the OpenGL timer query results are available. \sa waitForSamples(), waitForIntervals() */ |