Skip to content

PythonQt.QtGui.QOpenGLTimeMonitor · declarations 001

Back to PythonQt.QtGui.QOpenGLTimeMonitor

create

create() -> bool

X.create() -> bool

Supplemental documentation: Qt 5 reference:

bool QOpenGLTimeMonitor::create()

Instantiate sampleCount() OpenGL timer query objects that will be used 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.

See also destroy(), setSampleCount(), and recordSample().

Upstream PySide2 reference signatures (binding differences may apply):

create(self) -> bool

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

destroy

destroy() -> None

X.destroy()

Supplemental documentation: Qt 5 reference:

void QOpenGLTimeMonitor::destroy()

Destroys any OpenGL timer query objects used within this instance.

See also create().

Upstream PySide2 reference signatures (binding differences may apply):

destroy(self) -> None

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

destroyed

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

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

isCreated

isCreated() -> bool

X.isCreated() -> bool

Supplemental documentation: Qt 5 reference:

bool QOpenGLTimeMonitor::isCreated() const

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

Upstream PySide2 reference signatures (binding differences may apply):

isCreated(self) -> bool

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

isResultAvailable

isResultAvailable() -> bool

X.isResultAvailable() -> bool

Supplemental documentation: Qt 5 reference:

bool QOpenGLTimeMonitor::isResultAvailable() const

Returns true if the OpenGL timer query results are available.

See also waitForSamples() and waitForIntervals().

Upstream PySide2 reference signatures (binding differences may apply):

isResultAvailable(self) -> bool

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

objectIds

objectIds() -> tuple

X.objectIds() -> tuple

Supplemental documentation: Qt 5 reference:

QVector\<GLuint> QOpenGLTimeMonitor::objectIds() const

Returns a QVector containing the object Ids of the OpenGL timer query objects.

Upstream PySide2 reference signatures (binding differences may apply):

objectIds(self) -> typing.List[int]

Source: https://doc.qt.io/archives/qt-5.15/qopengltimemonitor.html#objectIds

objectNameChanged

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

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

recordSample

recordSample() -> int

X.recordSample() -> int

Supplemental documentation: Qt 5 reference:

int QOpenGLTimeMonitor::recordSample()

Issues an OpenGL timer query at this point in the OpenGL command queue. Calling this function in a sequence in your application's rendering function, will build up details of the GPU time taken to execute the OpenGL commands between successive calls to this function.

See also setSampleCount(), isResultAvailable(), waitForSamples(), and waitForIntervals().

Upstream PySide2 reference signatures (binding differences may apply):

recordSample(self) -> int

Source: https://doc.qt.io/archives/qt-5.15/qopengltimemonitor.html#recordSample

reset

reset() -> None

X.reset()

Supplemental documentation: Qt 5 reference:

void QOpenGLTimeMonitor::reset()

Resets the time monitor ready for use in another frame of rendering. Call this once you have obtained the previous results and before calling recordSample() for the first time on the next frame.

See also recordSample().

Upstream PySide2 reference signatures (binding differences may apply):

reset(self) -> None

Source: https://doc.qt.io/archives/qt-5.15/qopengltimemonitor.html#reset

sampleCount

sampleCount() -> int

X.sampleCount() -> int

Supplemental documentation: Qt 5 reference:

int QOpenGLTimeMonitor::sampleCount() const

Returns the number of sample points that have been requested with setSampleCount(). If create was successfully called following setSampleCount(), then the value returned will be the actual number of sample points that can be used.

The default value for sample count is 2, leading to the measurement of a single interval.

See also setSampleCount().

Upstream PySide2 reference signatures (binding differences may apply):

sampleCount(self) -> int

Source: https://doc.qt.io/archives/qt-5.15/qopengltimemonitor.html#sampleCount

setSampleCount

setSampleCount(sampleCount: int) -> None

X.setSampleCount(sampleCount)

Supplemental documentation: Qt 5 reference:

void QOpenGLTimeMonitor::setSampleCount(int sampleCount)

Sets the number of sample points to sampleCount. After setting the number of samples with this function, you must call create() to instantiate the underlying OpenGL timer query objects.

The new sampleCount must be at least 2.

See also sampleCount(), create(), and recordSample().

Upstream PySide2 reference signatures (binding differences may apply):

setSampleCount(self, sampleCount: int) -> None

Source: https://doc.qt.io/archives/qt-5.15/qopengltimemonitor.html#setSampleCount

waitForIntervals

waitForIntervals() -> tuple

X.waitForIntervals() -> tuple

Supplemental documentation: Qt 5 reference:

QVector\<GLuint64> QOpenGLTimeMonitor::waitForIntervals() const

Returns a QVector containing the time intervals delimited by the calls to recordSample(). The resulting vector will contain one fewer element as this represents the intervening intervals rather than the actual timestamp samples.

This function will block until OpenGL indicates the results are available. It is recommended to check the availability of the result prior to calling this function with isResultAvailable().

See also waitForSamples() and isResultAvailable().

Upstream PySide2 reference signatures (binding differences may apply):

waitForIntervals(self) -> typing.List[int]

Source: https://doc.qt.io/archives/qt-5.15/qopengltimemonitor.html#waitForIntervals

waitForSamples

waitForSamples() -> tuple

X.waitForSamples() -> tuple

Supplemental documentation: Qt 5 reference:

QVector\<GLuint64> QOpenGLTimeMonitor::waitForSamples() const

Returns a QVector containing the GPU timestamps taken with recordSample().

This function will block until OpenGL indicates the results are available. It is recommended to check the availability of the result prior to calling this function with isResultAvailable().

Note: This function only works on systems that have OpenGL >\=3.3 or the ARB_timer_query extension. See QOpenGLTimerQuery for more details.

See also waitForIntervals() and isResultAvailable().

Upstream PySide2 reference signatures (binding differences may apply):

waitForSamples(self) -> typing.List[int]

Source: https://doc.qt.io/archives/qt-5.15/qopengltimemonitor.html#waitForSamples