Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
QSGRenderThread Class Reference
Inheritance diagram for QSGRenderThread:
Collaboration diagram for QSGRenderThread:

Public Types

enum  {
  SyncRequest = 0x01 , RepaintRequest = 0x02 , ExposeRequest = 0x04 | RepaintRequest | SyncRequest , SyncRequest = 0x01 ,
  RepaintRequest = 0x02 , ExposeRequest = 0x04 | RepaintRequest | SyncRequest
}
enum  {
  SyncRequest = 0x01 , RepaintRequest = 0x02 , ExposeRequest = 0x04 | RepaintRequest | SyncRequest , SyncRequest = 0x01 ,
  RepaintRequest = 0x02 , ExposeRequest = 0x04 | RepaintRequest | SyncRequest
}
Public Types inherited from QThread
enum  Priority {
  IdlePriority , LowestPriority , LowPriority , NormalPriority ,
  HighPriority , HighestPriority , TimeCriticalPriority , InheritPriority
}
enum class  QualityOfService { Auto , High , Eco }

Public Member Functions

 QSGRenderThread (QSGThreadedRenderLoop *w, QSGRenderContext *renderContext)
 ~QSGRenderThread ()
void invalidateGraphics (QQuickWindow *window, bool inDestructor)
bool event (QEvent *) override
 This virtual function receives events to an object and should return true if the event e was recognized and processed.
void run () override
void syncAndRender ()
void sync (bool inExpose)
void requestRepaint ()
void processEventsAndWaitForMore ()
void processEvents ()
void postEvent (QEvent *e)
void ensureRhi ()
void teardownGraphics ()
void handleDeviceLoss ()
 QSGRenderThread (QSGThreadedRenderLoop *w, QSGRenderContext *renderContext)
 ~QSGRenderThread ()
void invalidateGraphics (QQuickWindow *window, bool inDestructor)
bool event (QEvent *) override
 This virtual function receives events to an object and should return true if the event e was recognized and processed.
void run () override
void syncAndRender ()
void sync (bool inExpose)
void requestRepaint ()
void processEventsAndWaitForMore ()
void processEvents ()
void postEvent (QEvent *e)
void ensureRhi ()
void teardownGraphics ()
void handleDeviceLoss ()
Public Member Functions inherited from QThread
 QThread (QObject *parent=nullptr)
 ~QThread ()
void setPriority (Priority priority)
Priority priority () const
bool isFinished () const
bool isRunning () const
void requestInterruption ()
bool isInterruptionRequested () const
void setStackSize (uint stackSize)
uint stackSize () const
QAbstractEventDispatchereventDispatcher () const
void setEventDispatcher (QAbstractEventDispatcher *eventDispatcher)
bool event (QEvent *event) override
 This virtual function receives events to an object and should return true if the event e was recognized and processed.
int loopLevel () const
bool isCurrentThread () const noexcept
void setServiceLevel (QualityOfService serviceLevel)
QualityOfService serviceLevel () const
bool wait (QDeadlineTimer deadline=QDeadlineTimer(QDeadlineTimer::Forever))
bool wait (unsigned long time)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. time is the time to wait in milliseconds.
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 eventFilter (QObject *watched, QEvent *event)
 Filters events if this object has been installed as an event filter for the watched object.
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< QStringbindableObjectName ()
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 isQmlObjectType () const
 Returns whether the object has been created by the QML engine or ownership has been explicitly set via QJSEngine::setObjectOwnership().
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).
QThreadthread () 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>
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>
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 QObjectListchildren () 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< QByteArraydynamicPropertyNames () const
QBindingStoragebindingStorage ()
const QBindingStoragebindingStorage () const
QObjectparent () 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

QSGThreadedRenderLoopwm
QRhirhi
bool ownRhi
QSGDefaultRenderContextsgrc
QOffscreenSurfaceoffscreenSurface
QAnimationDriveranimatorDriver
uint pendingUpdate
bool sleeping
volatile bool active
QMutex mutex
QWaitCondition waitCondition
QElapsedTimer m_threadTimeBetweenRenders
QQuickWindowwindow
QSize windowSize
float dpr = 1
QRhiSwapChainProxyData scProxyData
int rhiSampleCount = 1
bool rhiDeviceLost = false
bool rhiDoomed = false
bool guiNotifiedAboutRhiFailure = false
bool swRastFallbackDueToSwapchainFailure = false
bool stopEventProcessing
QSGRenderThreadEventQueue eventQueue

Additional Inherited Members

Public Slots inherited from QThread
void start (Priority=InheritPriority)
void terminate ()
void exit (int retcode=0)
void quit ()
Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
Signals inherited from QThread
void started (QPrivateSignal)
void finished (QPrivateSignal)
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 QThread
static Q_DECL_PURE_FUNCTION Qt::HANDLE currentThreadId () noexcept
static QThreadcurrentThread ()
static bool isMainThread () noexcept
static int idealThreadCount () noexcept
static void yieldCurrentThread ()
template<typename Function, typename... Args>
static QThreadcreate (Function &&f, Args &&... args)
static void sleep (unsigned long)
static void msleep (unsigned long)
static void usleep (unsigned long)
static void sleep (std::chrono::nanoseconds nsec)
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 QThread
int exec ()
 QThread (QThreadPrivate &dd, QObject *parent=nullptr)
Protected Member Functions inherited from QObject
QObjectsender () 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)
Static Protected Member Functions inherited from QThread
static void setTerminationEnabled (bool enabled=true)
Protected Attributes inherited from QObject
QScopedPointer< QObjectDatad_ptr
Properties inherited from QObject
QString objectName
 the name of this object

Detailed Description

Definition at line 220 of file qsgthreadedrenderloop.cpp.

Member Enumeration Documentation

◆ anonymous enum [1/2]

anonymous enum
Enumerator
SyncRequest 
RepaintRequest 
ExposeRequest 
SyncRequest 
RepaintRequest 
ExposeRequest 

Definition at line 270 of file qsgthreadedrenderloop.cpp.

◆ anonymous enum [2/2]

anonymous enum
Enumerator
SyncRequest 
RepaintRequest 
ExposeRequest 
SyncRequest 
RepaintRequest 
ExposeRequest 

Definition at line 270 of file qsgthreadedrenderloop.cpp.

Constructor & Destructor Documentation

◆ QSGRenderThread() [1/2]

QSGRenderThread::QSGRenderThread ( QSGThreadedRenderLoop * w,
QSGRenderContext * renderContext )
inline

Definition at line 224 of file qsgthreadedrenderloop.cpp.

◆ ~QSGRenderThread() [1/2]

QSGRenderThread::~QSGRenderThread ( )
inline

Definition at line 243 of file qsgthreadedrenderloop.cpp.

◆ QSGRenderThread() [2/2]

QSGRenderThread::QSGRenderThread ( QSGThreadedRenderLoop * w,
QSGRenderContext * renderContext )
inline

Definition at line 224 of file qsgthreadedrenderloop.cpp.

◆ ~QSGRenderThread() [2/2]

QSGRenderThread::~QSGRenderThread ( )
inline

Definition at line 243 of file qsgthreadedrenderloop.cpp.

Member Function Documentation

◆ ensureRhi() [1/2]

void QSGRenderThread::ensureRhi ( )

Definition at line 877 of file qsgthreadedrenderloop.cpp.

References ownRhi, rhi, rhiDeviceLost, rhiDoomed, rhiSampleCount, scProxyData, sgrc, swRastFallbackDueToSwapchainFailure, and window.

Referenced by run().

Here is the caller graph for this function:

◆ ensureRhi() [2/2]

void QSGRenderThread::ensureRhi ( )

◆ event() [1/2]

bool QSGRenderThread::event ( QEvent * e)
overridevirtual

This virtual function receives events to an object and should return true if the event e was recognized and processed.

The event() function can be reimplemented to customize the behavior of an object.

Make sure you call the parent event class implementation for all the events you did not handle.

Example:

class MyClass : public QWidget
{
public:
MyClass(QWidget *parent = nullptr);
~MyClass();
bool event(QEvent* ev) override
{
if (ev->type() == QEvent::PolishRequest) {
// overwrite handling of PolishRequest if any
return true;
} else if (ev->type() == QEvent::Show) {
// complement handling of Show if any
return true;
}
// Make sure the rest of events are handled
return QWidget::event(ev);
}
};
See also
installEventFilter(), timerEvent(), QCoreApplication::sendEvent(), QCoreApplication::postEvent()

Reimplemented from QObject.

Definition at line 313 of file qsgthreadedrenderloop.cpp.

References active, dpr, WMSyncEvent::dpr, WMSyncEvent::forceRenderPass, WMTryReleaseEvent::inDestructor, WMJobEvent::job, rhi, scProxyData, WMSyncEvent::scProxyData, sgrc, sleeping, stopEventProcessing, WMSyncEvent::syncInExpose, window, WMWindowEvent::window, wm, WM_Exposed, WM_Grab, WM_Obscure, WM_PostJob, WM_ReleaseSwapchain, WM_RequestSync, and WM_TryRelease.

◆ event() [2/2]

bool QSGRenderThread::event ( QEvent * e)
overridevirtual

This virtual function receives events to an object and should return true if the event e was recognized and processed.

The event() function can be reimplemented to customize the behavior of an object.

Make sure you call the parent event class implementation for all the events you did not handle.

Example:

class MyClass : public QWidget
{
public:
MyClass(QWidget *parent = nullptr);
~MyClass();
bool event(QEvent* ev) override
{
if (ev->type() == QEvent::PolishRequest) {
// overwrite handling of PolishRequest if any
return true;
} else if (ev->type() == QEvent::Show) {
// complement handling of Show if any
return true;
}
// Make sure the rest of events are handled
return QWidget::event(ev);
}
};
See also
installEventFilter(), timerEvent(), QCoreApplication::sendEvent(), QCoreApplication::postEvent()

Reimplemented from QObject.

◆ handleDeviceLoss() [1/2]

void QSGRenderThread::handleDeviceLoss ( )

Definition at line 589 of file qsgthreadedrenderloop.cpp.

References rhi, rhiDeviceLost, and teardownGraphics().

Referenced by syncAndRender().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ handleDeviceLoss() [2/2]

void QSGRenderThread::handleDeviceLoss ( )

◆ invalidateGraphics() [1/2]

void QSGRenderThread::invalidateGraphics ( QQuickWindow * window,
bool inDestructor )

Definition at line 462 of file qsgthreadedrenderloop.cpp.

References rhi, sgrc, and wm.

◆ invalidateGraphics() [2/2]

void QSGRenderThread::invalidateGraphics ( QQuickWindow * window,
bool inDestructor )

◆ postEvent() [1/2]

void QSGRenderThread::postEvent ( QEvent * e)

Definition at line 847 of file qsgthreadedrenderloop.cpp.

◆ postEvent() [2/2]

void QSGRenderThread::postEvent ( QEvent * e)

◆ processEvents() [1/2]

void QSGRenderThread::processEvents ( )

Definition at line 854 of file qsgthreadedrenderloop.cpp.

Referenced by run().

Here is the caller graph for this function:

◆ processEvents() [2/2]

void QSGRenderThread::processEvents ( )

◆ processEventsAndWaitForMore() [1/2]

void QSGRenderThread::processEventsAndWaitForMore ( )

Definition at line 865 of file qsgthreadedrenderloop.cpp.

References stopEventProcessing.

Referenced by run().

Here is the caller graph for this function:

◆ processEventsAndWaitForMore() [2/2]

void QSGRenderThread::processEventsAndWaitForMore ( )

◆ requestRepaint() [1/2]

void QSGRenderThread::requestRepaint ( )
inline

Definition at line 257 of file qsgthreadedrenderloop.cpp.

References sleeping, and stopEventProcessing.

Referenced by QSGThreadedRenderLoop::update().

Here is the caller graph for this function:

◆ requestRepaint() [2/2]

void QSGRenderThread::requestRepaint ( )
inline

Definition at line 257 of file qsgthreadedrenderloop.cpp.

◆ run() [1/2]

void QSGRenderThread::run ( void )
overridevirtual

Reimplemented from QThread.

Definition at line 953 of file qsgthreadedrenderloop.cpp.

References active, animatorDriver, ensureRhi(), guiNotifiedAboutRhiFailure, processEvents(), processEventsAndWaitForMore(), rhi, rhiDoomed, sgrc, sleeping, syncAndRender(), window, and wm.

Here is the call graph for this function:

◆ run() [2/2]

void QSGRenderThread::run ( )
overridevirtual

Reimplemented from QThread.

◆ sync() [1/2]

void QSGRenderThread::sync ( bool inExpose)

Definition at line 525 of file qsgthreadedrenderloop.cpp.

References rhi, sgrc, and wm.

Referenced by syncAndRender().

Here is the caller graph for this function:

◆ sync() [2/2]

void QSGRenderThread::sync ( bool inExpose)

◆ syncAndRender() [1/2]

void QSGRenderThread::syncAndRender ( )

Definition at line 599 of file qsgthreadedrenderloop.cpp.

References animatorDriver, handleDeviceLoss(), rhi, scProxyData, swRastFallbackDueToSwapchainFailure, sync(), teardownGraphics(), and window.

Referenced by run().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ syncAndRender() [2/2]

void QSGRenderThread::syncAndRender ( )

◆ teardownGraphics() [1/2]

void QSGRenderThread::teardownGraphics ( )

Definition at line 578 of file qsgthreadedrenderloop.cpp.

References rhi, sgrc, window, and wm.

Referenced by handleDeviceLoss(), and syncAndRender().

Here is the caller graph for this function:

◆ teardownGraphics() [2/2]

void QSGRenderThread::teardownGraphics ( )

Member Data Documentation

◆ active

volatile bool QSGRenderThread::active

Definition at line 291 of file qsgthreadedrenderloop.cpp.

Referenced by event(), and run().

◆ animatorDriver

QAnimationDriver * QSGRenderThread::animatorDriver

Definition at line 286 of file qsgthreadedrenderloop.cpp.

Referenced by run(), and syncAndRender().

◆ dpr

float QSGRenderThread::dpr = 1

Definition at line 300 of file qsgthreadedrenderloop.cpp.

Referenced by event().

◆ eventQueue

QSGRenderThreadEventQueue QSGRenderThread::eventQueue

Definition at line 310 of file qsgthreadedrenderloop.cpp.

◆ guiNotifiedAboutRhiFailure

bool QSGRenderThread::guiNotifiedAboutRhiFailure = false

Definition at line 305 of file qsgthreadedrenderloop.cpp.

Referenced by run().

◆ m_threadTimeBetweenRenders

QElapsedTimer QSGRenderThread::m_threadTimeBetweenRenders

Definition at line 296 of file qsgthreadedrenderloop.cpp.

◆ mutex

QMutex QSGRenderThread::mutex

Definition at line 293 of file qsgthreadedrenderloop.cpp.

◆ offscreenSurface

QOffscreenSurface * QSGRenderThread::offscreenSurface

Definition at line 284 of file qsgthreadedrenderloop.cpp.

◆ ownRhi

bool QSGRenderThread::ownRhi

Definition at line 282 of file qsgthreadedrenderloop.cpp.

Referenced by ensureRhi().

◆ pendingUpdate

uint QSGRenderThread::pendingUpdate

Definition at line 288 of file qsgthreadedrenderloop.cpp.

◆ rhi

QRhi * QSGRenderThread::rhi

◆ rhiDeviceLost

bool QSGRenderThread::rhiDeviceLost = false

Definition at line 303 of file qsgthreadedrenderloop.cpp.

Referenced by ensureRhi(), and handleDeviceLoss().

◆ rhiDoomed

bool QSGRenderThread::rhiDoomed = false

Definition at line 304 of file qsgthreadedrenderloop.cpp.

Referenced by ensureRhi(), and run().

◆ rhiSampleCount

int QSGRenderThread::rhiSampleCount = 1

Definition at line 302 of file qsgthreadedrenderloop.cpp.

Referenced by ensureRhi().

◆ scProxyData

QRhiSwapChainProxyData QSGRenderThread::scProxyData

Definition at line 301 of file qsgthreadedrenderloop.cpp.

Referenced by ensureRhi(), event(), and syncAndRender().

◆ sgrc

QSGDefaultRenderContext * QSGRenderThread::sgrc

◆ sleeping

bool QSGRenderThread::sleeping

Definition at line 289 of file qsgthreadedrenderloop.cpp.

Referenced by event(), requestRepaint(), and run().

◆ stopEventProcessing

bool QSGRenderThread::stopEventProcessing

Definition at line 309 of file qsgthreadedrenderloop.cpp.

Referenced by event(), processEventsAndWaitForMore(), and requestRepaint().

◆ swRastFallbackDueToSwapchainFailure

bool QSGRenderThread::swRastFallbackDueToSwapchainFailure = false

Definition at line 306 of file qsgthreadedrenderloop.cpp.

Referenced by ensureRhi(), and syncAndRender().

◆ waitCondition

QWaitCondition QSGRenderThread::waitCondition

Definition at line 294 of file qsgthreadedrenderloop.cpp.

◆ window

QQuickWindow * QSGRenderThread::window

◆ windowSize

QSize QSGRenderThread::windowSize

Definition at line 299 of file qsgthreadedrenderloop.cpp.

◆ wm

QSGThreadedRenderLoop * QSGRenderThread::wm

Definition at line 280 of file qsgthreadedrenderloop.cpp.

Referenced by event(), invalidateGraphics(), run(), sync(), and teardownGraphics().


The documentation for this class was generated from the following file: