Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
|
Classes | |
struct | WindowData |
Public Member Functions | |
QSGGuiThreadRenderLoop () | |
~QSGGuiThreadRenderLoop () | |
void | show (QQuickWindow *window) override |
void | hide (QQuickWindow *window) override |
void | windowDestroyed (QQuickWindow *window) override |
void | renderWindow (QQuickWindow *window) |
void | exposureChanged (QQuickWindow *window) override |
QImage | grab (QQuickWindow *window) override |
void | maybeUpdate (QQuickWindow *window) override |
void | update (QQuickWindow *window) override |
void | handleUpdateRequest (QQuickWindow *) override |
void | releaseResources (QQuickWindow *) override |
QAnimationDriver * | animationDriver () const override |
QSGContext * | sceneGraphContext () const override |
QSGRenderContext * | createRenderContext (QSGContext *) const override |
void | releaseSwapchain (QQuickWindow *window) |
void | handleDeviceLoss () |
void | teardownGraphics () |
bool | eventFilter (QObject *watched, QEvent *event) override |
Filters events if this object has been installed as an event filter for the watched object. | |
bool | ensureRhi (QQuickWindow *window, WindowData &data) |
QSGGuiThreadRenderLoop () | |
~QSGGuiThreadRenderLoop () | |
void | show (QQuickWindow *window) override |
void | hide (QQuickWindow *window) override |
void | windowDestroyed (QQuickWindow *window) override |
void | renderWindow (QQuickWindow *window) |
void | exposureChanged (QQuickWindow *window) override |
QImage | grab (QQuickWindow *window) override |
void | maybeUpdate (QQuickWindow *window) override |
void | update (QQuickWindow *window) override |
void | handleUpdateRequest (QQuickWindow *) override |
void | releaseResources (QQuickWindow *) override |
QAnimationDriver * | animationDriver () const override |
QSGContext * | sceneGraphContext () const override |
QSGRenderContext * | createRenderContext (QSGContext *) const override |
void | releaseSwapchain (QQuickWindow *window) |
void | handleDeviceLoss () |
void | teardownGraphics () |
bool | eventFilter (QObject *watched, QEvent *event) override |
Filters events if this object has been installed as an event filter for the watched object. | |
bool | ensureRhi (QQuickWindow *window, WindowData &data) |
Public Member Functions inherited from QSGRenderLoop | |
virtual | ~QSGRenderLoop () |
virtual void | resize (QQuickWindow *) |
virtual void | postJob (QQuickWindow *window, QRunnable *job) |
void | addWindow (QQuickWindow *win) |
void | removeWindow (QQuickWindow *win) |
QSet< QQuickWindow * > | windows () const |
virtual QSurface::SurfaceType | windowSurfaceType () const |
virtual bool | interleaveIncubation () const |
virtual int | flags () const |
void | handleContextCreationFailure (QQuickWindow *window) |
Public Member Functions inherited from QObject | |
Q_INVOKABLE | QObject (QObject *parent=nullptr) |
Constructs an object with parent object parent. | |
virtual | ~QObject () |
Destroys the object, deleting all its child objects. | |
virtual bool | event (QEvent *event) |
This virtual function receives events to an object and should return true if the event e was recognized and processed. | |
QString | objectName () const |
Q_WEAK_OVERLOAD void | setObjectName (const QString &name) |
Sets the object's name to name. | |
void | setObjectName (QAnyStringView name) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
QBindable< QString > | bindableObjectName () |
bool | isWidgetType () const |
Returns true if the object is a widget; otherwise returns false . | |
bool | isWindowType () const |
Returns true if the object is a window; otherwise returns false . | |
bool | isQuickItemType () const |
Returns true if the object is a QQuickItem; otherwise returns false . | |
bool | signalsBlocked () const noexcept |
Returns true if signals are blocked; otherwise returns false . | |
bool | blockSignals (bool b) noexcept |
If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it). | |
QThread * | thread () const |
Returns the thread in which the object lives. | |
bool | moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL) |
Changes the thread affinity for this object and its children and returns true on success. | |
int | startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer) |
This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds. | |
int | startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer) |
void | killTimer (int id) |
Kills the timer with timer identifier, id. | |
void | killTimer (Qt::TimerId id) |
template<typename T > | |
T | findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const |
Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object. | |
template<typename T > | |
QList< T > | findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const |
Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects. | |
template<typename T > | |
T | findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
template<typename T > | |
QList< T > | findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
const QObjectList & | children () const |
Returns a list of child objects. | |
void | setParent (QObject *parent) |
Makes the object a child of parent. | |
void | installEventFilter (QObject *filterObj) |
Installs an event filter filterObj on this object. | |
void | removeEventFilter (QObject *obj) |
Removes an event filter object obj from this object. | |
QMetaObject::Connection | connect (const QObject *sender, const char *signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const |
bool | disconnect (const char *signal=nullptr, const QObject *receiver=nullptr, const char *member=nullptr) const |
bool | disconnect (const QObject *receiver, const char *member=nullptr) const |
void | dumpObjectTree () const |
Dumps a tree of children to the debug output. | |
void | dumpObjectInfo () const |
Dumps information about signal connections, etc. | |
bool | setProperty (const char *name, const QVariant &value) |
Sets the value of the object's name property to value. | |
bool | setProperty (const char *name, QVariant &&value) |
QVariant | property (const char *name) const |
Returns the value of the object's name property. | |
QList< QByteArray > | dynamicPropertyNames () const |
QBindingStorage * | bindingStorage () |
const QBindingStorage * | bindingStorage () const |
QObject * | parent () const |
Returns a pointer to the parent object. | |
bool | inherits (const char *classname) const |
Returns true if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns false . | |
Public Attributes | |
QHash< QQuickWindow *, WindowData > | m_windows |
QOffscreenSurface * | offscreenSurface = nullptr |
QSGContext * | sg |
QSet< QSGRenderContext * > | pendingRenderContexts |
bool | m_inPolish = false |
bool | swRastFallbackDueToSwapchainFailure = false |
Additional Inherited Members | |
Public Types inherited from QSGRenderLoop | |
enum | RenderLoopFlags { SupportsGrabWithoutExpose = 0x01 } |
Public Slots inherited from QObject | |
void | deleteLater () |
\threadsafe | |
Signals inherited from QSGRenderLoop | |
void | timeToIncubate () |
Signals inherited from QObject | |
void | destroyed (QObject *=nullptr) |
This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked. | |
void | objectNameChanged (const QString &objectName, QPrivateSignal) |
This signal is emitted after the object's name has been changed. | |
Static Public Member Functions inherited from QSGRenderLoop | |
static QSGRenderLoop * | instance () |
static void | setInstance (QSGRenderLoop *instance) |
static void | cleanup () |
Static Public Member Functions inherited from QObject | |
static QMetaObject::Connection | connect (const QObject *sender, const char *signal, const QObject *receiver, const char *member, Qt::ConnectionType=Qt::AutoConnection) |
\threadsafe | |
static QMetaObject::Connection | connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection) |
template<typename Func1 , typename Func2 > | |
static QMetaObject::Connection | connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType *context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection) |
template<typename Func1 , typename Func2 > | |
static QMetaObject::Connection | connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot) |
static bool | disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member) |
\threadsafe | |
static bool | disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &member) |
static bool | disconnect (const QMetaObject::Connection &) |
Disconnect a connection. | |
template<typename Func1 , typename Func2 > | |
static bool | disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object *receiver, Func2 slot) |
template<typename Func1 > | |
static bool | disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const QObject *receiver, void **zero) |
Protected Member Functions inherited from QObject | |
QObject * | sender () const |
Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr. | |
int | senderSignalIndex () const |
int | receivers (const char *signal) const |
Returns the number of receivers connected to the signal. | |
bool | isSignalConnected (const QMetaMethod &signal) const |
virtual void | timerEvent (QTimerEvent *event) |
This event handler can be reimplemented in a subclass to receive timer events for the object. | |
virtual void | childEvent (QChildEvent *event) |
This event handler can be reimplemented in a subclass to receive child events. | |
virtual void | customEvent (QEvent *event) |
This event handler can be reimplemented in a subclass to receive custom events. | |
virtual void | connectNotify (const QMetaMethod &signal) |
virtual void | disconnectNotify (const QMetaMethod &signal) |
QObject (QObjectPrivate &dd, QObject *parent=nullptr) | |
Protected Attributes inherited from QObject | |
QScopedPointer< QObjectData > | d_ptr |
Properties inherited from QObject | |
QString | objectName |
the name of this object | |
Related Symbols inherited from QObject | |
template< class T > T | qobject_cast (const QObject *object) |
Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr. | |
template< typename T > T | qFindChildqFindChildren (const QObject *obj, const QString &name)() |
template< typename T > QList< T > | qFindChildrenqFindChildren (const QObject *obj, const QString &name)() |
QObjectList | |
\macro Q_CLASSINFO(Name, Value) | |
Definition at line 112 of file qsgrenderloop.cpp.
QSGGuiThreadRenderLoop::QSGGuiThreadRenderLoop | ( | ) |
Definition at line 298 of file qsgrenderloop.cpp.
References qsg_useConsistentTiming().
QSGGuiThreadRenderLoop::~QSGGuiThreadRenderLoop | ( | ) |
Definition at line 308 of file qsgrenderloop.cpp.
References sg.
QSGGuiThreadRenderLoop::QSGGuiThreadRenderLoop | ( | ) |
QSGGuiThreadRenderLoop::~QSGGuiThreadRenderLoop | ( | ) |
|
inlineoverridevirtual |
Implements QSGRenderLoop.
Definition at line 134 of file qsgrenderloop.cpp.
|
inlineoverridevirtual |
Implements QSGRenderLoop.
Definition at line 134 of file qsgrenderloop.cpp.
|
overridevirtual |
Implements QSGRenderLoop.
Definition at line 852 of file qsgrenderloop.cpp.
|
overridevirtual |
Implements QSGRenderLoop.
bool QSGGuiThreadRenderLoop::ensureRhi | ( | QQuickWindow * | window, |
WindowData & | data ) |
Definition at line 451 of file qsgrenderloop.cpp.
References QSGGuiThreadRenderLoop::WindowData::ownRhi, QSGGuiThreadRenderLoop::WindowData::rc, QSGGuiThreadRenderLoop::WindowData::rhi, QSGGuiThreadRenderLoop::WindowData::rhiDeviceLost, QSGGuiThreadRenderLoop::WindowData::rhiDoomed, QSGGuiThreadRenderLoop::WindowData::sampleCount, and swRastFallbackDueToSwapchainFailure.
Referenced by grab(), and renderWindow().
bool QSGGuiThreadRenderLoop::ensureRhi | ( | QQuickWindow * | window, |
WindowData & | data ) |
Filters events if this object has been installed as an event filter for the watched object.
In your reimplementation of this function, if you want to filter the event out, i.e. stop it being handled further, return true; otherwise return false.
Example:
Notice in the example above that unhandled events are passed to the base class's eventFilter() function, since the base class might have reimplemented eventFilter() for its own internal purposes.
Some events, such as \l QEvent::ShortcutOverride must be explicitly accepted (by calling \l {QEvent::}{accept()} on them) in order to prevent propagation.
Reimplemented from QObject.
Definition at line 432 of file qsgrenderloop.cpp.
References releaseSwapchain().
Filters events if this object has been installed as an event filter for the watched object.
In your reimplementation of this function, if you want to filter the event out, i.e. stop it being handled further, return true; otherwise return false.
Example:
Notice in the example above that unhandled events are passed to the base class's eventFilter() function, since the base class might have reimplemented eventFilter() for its own internal purposes.
Some events, such as \l QEvent::ShortcutOverride must be explicitly accepted (by calling \l {QEvent::}{accept()} on them) in order to prevent propagation.
Reimplemented from QObject.
|
overridevirtual |
Implements QSGRenderLoop.
Definition at line 763 of file qsgrenderloop.cpp.
References renderWindow().
|
overridevirtual |
Implements QSGRenderLoop.
|
overridevirtual |
Implements QSGRenderLoop.
Definition at line 793 of file qsgrenderloop.cpp.
References ensureRhi(), and m_inPolish.
|
overridevirtual |
Implements QSGRenderLoop.
void QSGGuiThreadRenderLoop::handleDeviceLoss | ( | ) |
Definition at line 398 of file qsgrenderloop.cpp.
References releaseSwapchain().
Referenced by renderWindow().
void QSGGuiThreadRenderLoop::handleDeviceLoss | ( | ) |
|
overridevirtual |
Reimplemented from QSGRenderLoop.
Definition at line 871 of file qsgrenderloop.cpp.
References renderWindow().
|
overridevirtual |
Reimplemented from QSGRenderLoop.
|
overridevirtual |
Implements QSGRenderLoop.
Definition at line 323 of file qsgrenderloop.cpp.
Referenced by windowDestroyed().
|
overridevirtual |
Implements QSGRenderLoop.
|
overridevirtual |
Implements QSGRenderLoop.
Definition at line 821 of file qsgrenderloop.cpp.
References m_inPolish.
Referenced by renderWindow(), show(), and update().
|
overridevirtual |
Implements QSGRenderLoop.
|
overridevirtual |
Implements QSGRenderLoop.
Definition at line 859 of file qsgrenderloop.cpp.
|
overridevirtual |
Implements QSGRenderLoop.
void QSGGuiThreadRenderLoop::releaseSwapchain | ( | QQuickWindow * | window | ) |
Definition at line 420 of file qsgrenderloop.cpp.
Referenced by eventFilter(), handleDeviceLoss(), teardownGraphics(), and windowDestroyed().
void QSGGuiThreadRenderLoop::releaseSwapchain | ( | QQuickWindow * | window | ) |
void QSGGuiThreadRenderLoop::renderWindow | ( | QQuickWindow * | window | ) |
Definition at line 563 of file qsgrenderloop.cpp.
References ensureRhi(), handleDeviceLoss(), m_inPolish, maybeUpdate(), QSGGuiThreadRenderLoop::WindowData::rc, QSGGuiThreadRenderLoop::WindowData::rhi, swRastFallbackDueToSwapchainFailure, teardownGraphics(), and QSGGuiThreadRenderLoop::WindowData::updatePending.
Referenced by exposureChanged(), and handleUpdateRequest().
void QSGGuiThreadRenderLoop::renderWindow | ( | QQuickWindow * | window | ) |
|
overridevirtual |
|
overridevirtual |
Implements QSGRenderLoop.
|
overridevirtual |
Implements QSGRenderLoop.
Definition at line 314 of file qsgrenderloop.cpp.
References maybeUpdate().
|
overridevirtual |
Implements QSGRenderLoop.
void QSGGuiThreadRenderLoop::teardownGraphics | ( | ) |
Definition at line 383 of file qsgrenderloop.cpp.
References releaseSwapchain().
Referenced by renderWindow().
void QSGGuiThreadRenderLoop::teardownGraphics | ( | ) |
|
inlineoverridevirtual |
Implements QSGRenderLoop.
Definition at line 129 of file qsgrenderloop.cpp.
References maybeUpdate().
|
inlineoverridevirtual |
Implements QSGRenderLoop.
Definition at line 129 of file qsgrenderloop.cpp.
|
overridevirtual |
Implements QSGRenderLoop.
Definition at line 332 of file qsgrenderloop.cpp.
References hide(), offscreenSurface, QSGGuiThreadRenderLoop::WindowData::rc, releaseSwapchain(), and QSGGuiThreadRenderLoop::WindowData::rhi.
|
overridevirtual |
Implements QSGRenderLoop.
bool QSGGuiThreadRenderLoop::m_inPolish = false |
Definition at line 169 of file qsgrenderloop.cpp.
Referenced by grab(), maybeUpdate(), and renderWindow().
QHash< QQuickWindow *, WindowData > QSGGuiThreadRenderLoop::m_windows |
Definition at line 163 of file qsgrenderloop.cpp.
QOffscreenSurface * QSGGuiThreadRenderLoop::offscreenSurface = nullptr |
Definition at line 165 of file qsgrenderloop.cpp.
Referenced by windowDestroyed().
|
mutable |
Definition at line 167 of file qsgrenderloop.cpp.
QSGContext * QSGGuiThreadRenderLoop::sg |
Definition at line 166 of file qsgrenderloop.cpp.
Referenced by ~QSGGuiThreadRenderLoop(), and sceneGraphContext().
bool QSGGuiThreadRenderLoop::swRastFallbackDueToSwapchainFailure = false |
Definition at line 171 of file qsgrenderloop.cpp.
Referenced by ensureRhi(), and renderWindow().