Skip to content

PythonQt.QtGui.QOpenGLTimerQuery · declarations 001

Back to PythonQt.QtGui.QOpenGLTimerQuery

begin

begin() -> None

X.begin()

Supplemental documentation: Qt 5 reference:

void QOpenGLTimerQuery::begin()

Marks the start point in the OpenGL command queue for a sequence of commands to be timed by this query object.

This is useful for simple use-cases. Usually it is better to use recordTimestamp().

See also end(), isResultAvailable(), waitForResult(), and recordTimestamp().

Upstream PySide2 reference signatures (binding differences may apply):

begin(self) -> None

Source: https://doc.qt.io/archives/qt-5.15/qopengltimerquery.html#begin

create

create() -> bool

X.create() -> bool

Supplemental documentation: Qt 5 reference:

bool QOpenGLTimerQuery::create()

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.

Upstream PySide2 reference signatures (binding differences may apply):

create(self) -> bool

Source: https://doc.qt.io/archives/qt-5.15/qopengltimerquery.html#create

destroy

destroy() -> None

X.destroy()

Supplemental documentation: Qt 5 reference:

void QOpenGLTimerQuery::destroy()

Destroys the underlying OpenGL timer query object. The context that was current when create() was called must be current when calling this function.

Upstream PySide2 reference signatures (binding differences may apply):

destroy(self) -> None

Source: https://doc.qt.io/archives/qt-5.15/qopengltimerquery.html#destroy

destroyed

destroyed(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QOpenGLTimerQuery.destroyed; argument details are not documented.

end

end() -> None

X.end()

Supplemental documentation: Qt 5 reference:

void QOpenGLTimerQuery::end()

Marks the end point in the OpenGL command queue for a sequence of commands to be timed by this query object.

This is useful for simple use-cases. Usually it is better to use recordTimestamp().

See also begin(), isResultAvailable(), waitForResult(), and recordTimestamp().

Upstream PySide2 reference signatures (binding differences may apply):

end(self) -> None

Source: https://doc.qt.io/archives/qt-5.15/qopengltimerquery.html#end

isCreated

isCreated() -> bool

X.isCreated() -> bool

Supplemental documentation: Qt 5 reference:

bool QOpenGLTimerQuery::isCreated() const

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 queries with this object.

Upstream PySide2 reference signatures (binding differences may apply):

isCreated(self) -> bool

Source: https://doc.qt.io/archives/qt-5.15/qopengltimerquery.html#isCreated

isResultAvailable

isResultAvailable() -> bool

X.isResultAvailable() -> bool

Supplemental documentation: Qt 5 reference:

bool QOpenGLTimerQuery::isResultAvailable() const

Returns 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().

See also waitForResult().

Upstream PySide2 reference signatures (binding differences may apply):

isResultAvailable(self) -> bool

Source: https://doc.qt.io/archives/qt-5.15/qopengltimerquery.html#isResultAvailable

objectId

objectId() -> int

X.objectId() -> int

Supplemental documentation: Qt 5 reference:

GLuint QOpenGLTimerQuery::objectId() const

Returns the id of the underlying OpenGL query object.

Upstream PySide2 reference signatures (binding differences may apply):

objectId(self) -> int

Source: https://doc.qt.io/archives/qt-5.15/qopengltimerquery.html#objectId

objectNameChanged

objectNameChanged(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QOpenGLTimerQuery.objectNameChanged; argument details are not documented.

recordTimestamp

recordTimestamp() -> None

X.recordTimestamp()

Supplemental documentation: Qt 5 reference:

void QOpenGLTimerQuery::recordTimestamp()

Places a marker in the OpenGL command queue for the GPU to record the timestamp when this marker is reached by the GPU. This function is non-blocking and the result will become available at some later time.

The availability of the result can be checked with isResultAvailable(). The result can be fetched with waitForResult() which will block if the result is not yet available.

See also waitForResult(), isResultAvailable(), begin(), and end().

Upstream PySide2 reference signatures (binding differences may apply):

recordTimestamp(self) -> None

Source: https://doc.qt.io/archives/qt-5.15/qopengltimerquery.html#recordTimestamp

waitForResult

waitForResult() -> int

X.waitForResult()

Supplemental documentation: Qt 5 reference:

GLuint64 QOpenGLTimerQuery::waitForResult() const

Returns the result of the OpenGL timer query.

This function will block until the result is made available by OpenGL. It is recommended to call isResultAvailable() to ensure that the result is available to avoid unnecessary blocking and stalling.

See also isResultAvailable().

Upstream PySide2 reference signatures (binding differences may apply):

waitForResult(self) -> int

Source: https://doc.qt.io/archives/qt-5.15/qopengltimerquery.html#waitForResult

waitForTimestamp

waitForTimestamp() -> int

X.waitForTimestamp()

Supplemental documentation: Qt 5 reference:

GLuint64 QOpenGLTimerQuery::waitForTimestamp() const

Returns the current timestamp of the GPU when all previously issued OpenGL commands have been received but not necessarily executed by the GPU.

This function blocks until the result is returned.

See also recordTimestamp().

Upstream PySide2 reference signatures (binding differences may apply):

waitForTimestamp(self) -> int

Source: https://doc.qt.io/archives/qt-5.15/qopengltimerquery.html#waitForTimestamp