Qt
Internal/Contributor docs for the Qt SDK. <b>Note:</b> These are NOT official API docs; those are found <a href='https://doc.qt.io/'>here</a>.
Loading...
Searching...
No Matches
QSGThreadedRenderLoop Class Reference

#include <qsgthreadedrenderloop_p.h>

+ Inheritance diagram for QSGThreadedRenderLoop:
+ Collaboration diagram for QSGThreadedRenderLoop:

Public Slots

void animationStarted ()
 
void animationStopped ()
 
- Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
 

Public Member Functions

 QSGThreadedRenderLoop ()
 
 ~QSGThreadedRenderLoop ()
 
void show (QQuickWindow *) override
 
void hide (QQuickWindow *) override
 
void resize (QQuickWindow *window) override
 
void windowDestroyed (QQuickWindow *window) override
 
void exposureChanged (QQuickWindow *window) override
 
QImage grab (QQuickWindow *) override
 
void update (QQuickWindow *window) override
 
void maybeUpdate (QQuickWindow *window) override
 
void handleUpdateRequest (QQuickWindow *window) override
 
QSGContextsceneGraphContext () const override
 
QSGRenderContextcreateRenderContext (QSGContext *) const override
 
QAnimationDriveranimationDriver () const override
 
void releaseResources (QQuickWindow *window) override
 
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 postJob (QQuickWindow *window, QRunnable *job) override
 
bool interleaveIncubation () const override
 
- Public Member Functions inherited from QSGRenderLoop
virtual ~QSGRenderLoop ()
 
void addWindow (QQuickWindow *win)
 
void removeWindow (QQuickWindow *win)
 
QSet< QQuickWindow * > windows () const
 
virtual QSurface::SurfaceType windowSurfaceType () 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.
 
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 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.
 

Private Member Functions

bool eventFilter (QObject *watched, QEvent *event) override
 Filters events if this object has been installed as an event filter for the watched object.
 

Friends

class QSGRenderThread
 

Additional Inherited Members

- Public Types inherited from QSGRenderLoop
enum  RenderLoopFlags { SupportsGrabWithoutExpose = 0x01 }
 
- 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 QSGRenderLoopinstance ()
 
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
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)
 
- Protected Attributes inherited from QObject
QScopedPointer< QObjectDatad_ptr
 
- Properties inherited from QObject
QString objectName
 the name of this object
 

Detailed Description

Definition at line 28 of file qsgthreadedrenderloop_p.h.

Constructor & Destructor Documentation

◆ QSGThreadedRenderLoop()

QSGThreadedRenderLoop::QSGThreadedRenderLoop ( )

Definition at line 1007 of file qsgthreadedrenderloop.cpp.

References animationStarted(), animationStopped(), QObject::connect(), QSGContext::createAnimationDriver(), QAnimationDriver::install(), SIGNAL, and SLOT.

+ Here is the call graph for this function:

◆ ~QSGThreadedRenderLoop()

QSGThreadedRenderLoop::~QSGThreadedRenderLoop ( )

Definition at line 1019 of file qsgthreadedrenderloop.cpp.

References qDeleteAll().

+ Here is the call graph for this function:

Member Function Documentation

◆ animationDriver()

QAnimationDriver * QSGThreadedRenderLoop::animationDriver ( ) const
overridevirtual

Implements QSGRenderLoop.

Definition at line 1037 of file qsgthreadedrenderloop.cpp.

◆ animationStarted

void QSGThreadedRenderLoop::animationStarted ( )
slot

Definition at line 1062 of file qsgthreadedrenderloop.cpp.

References QList< T >::at(), i, qCDebug, and QList< T >::size().

Referenced by QSGThreadedRenderLoop().

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

◆ animationStopped

void QSGThreadedRenderLoop::animationStopped ( )
slot

Definition at line 1071 of file qsgthreadedrenderloop.cpp.

References qCDebug.

Referenced by QSGThreadedRenderLoop().

+ Here is the caller graph for this function:

◆ createRenderContext()

QSGRenderContext * QSGThreadedRenderLoop::createRenderContext ( QSGContext * sg) const
overridevirtual

Implements QSGRenderLoop.

Definition at line 1025 of file qsgthreadedrenderloop.cpp.

References context, QSGContext::createRenderContext(), and QSet< T >::insert().

+ Here is the call graph for this function:

◆ event()

bool QSGThreadedRenderLoop::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);
bool event(QEvent* ev) override
{
if (ev->type() == QEvent::PolishRequest) {
// overwrite handling of PolishRequest if any
doThings();
return true;
} else if (ev->type() == QEvent::Show) {
// complement handling of Show if any
doThings2();
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 1704 of file qsgthreadedrenderloop.cpp.

References QAnimationDriver::advance(), emit, QObject::event(), QSGContext::isVSyncDependent(), Q_ASSERT, qCDebug, QEvent::Timer, QSGRenderLoop::timeToIncubate(), and QEvent::type().

+ Here is the call graph for this function:

◆ eventFilter()

bool QSGThreadedRenderLoop::eventFilter ( QObject * watched,
QEvent * event )
overrideprivatevirtual

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:

class MainWindow : public QMainWindow
{
public:
protected:
bool eventFilter(QObject *obj, QEvent *ev) override;
private:
QTextEdit *textEdit;
};
{
textEdit = new QTextEdit;
setCentralWidget(textEdit);
textEdit->installEventFilter(this);
}
{
if (obj == textEdit) {
if (event->type() == QEvent::KeyPress) {
QKeyEvent *keyEvent = static_cast<QKeyEvent*>(event);
qDebug() << "Ate key press" << keyEvent->key();
return true;
} else {
return false;
}
} else {
// pass the event on to the parent class
}
}

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.

Warning
If you delete the receiver object in this function, be sure to return true. Otherwise, Qt will forward the event to the deleted object and the program might crash.
See also
installEventFilter()

Reimplemented from QObject.

Definition at line 1368 of file qsgthreadedrenderloop.cpp.

References QObject::eventFilter(), QEvent::PlatformSurface, QPlatformSurfaceEvent::SurfaceAboutToBeDestroyed, and window().

+ Here is the call graph for this function:

◆ exposureChanged()

void QSGThreadedRenderLoop::exposureChanged ( QQuickWindow * window)
overridevirtual

Implements QSGRenderLoop.

Definition at line 1218 of file qsgthreadedrenderloop.cpp.

References QQuickWindowPrivate::get(), QQuickWindowPrivate::hasActiveSwapchain, QQuickWindowPrivate::hasRenderableSwapchain, qCDebug, QRhiSwapChain::surfacePixelSize(), QQuickWindowPrivate::swapchain, QQuickWindowPrivate::swapchainJustBecameRenderable, and window().

+ Here is the call graph for this function:

◆ grab()

QImage QSGThreadedRenderLoop::grab ( QQuickWindow * window)
overridevirtual

Implements QSGRenderLoop.

Definition at line 1739 of file qsgthreadedrenderloop.cpp.

References d, QQuickWindowPrivate::get(), Q_ASSERT, qCDebug, and window().

+ Here is the call graph for this function:

◆ handleUpdateRequest()

void QSGThreadedRenderLoop::handleUpdateRequest ( QQuickWindow * window)
overridevirtual

Reimplemented from QSGRenderLoop.

Definition at line 1394 of file qsgthreadedrenderloop.cpp.

References QQuickWindowPrivate::get(), qCDebug, and window().

+ Here is the call graph for this function:

◆ hide()

void QSGThreadedRenderLoop::hide ( QQuickWindow * window)
overridevirtual

Implements QSGRenderLoop.

Definition at line 1147 of file qsgthreadedrenderloop.cpp.

References qCDebug, releaseResources(), and window().

+ Here is the call graph for this function:

◆ interleaveIncubation()

bool QSGThreadedRenderLoop::interleaveIncubation ( ) const
overridevirtual

Reimplemented from QSGRenderLoop.

Definition at line 1057 of file qsgthreadedrenderloop.cpp.

References QAnimationDriver::isRunning().

+ Here is the call graph for this function:

◆ maybeUpdate()

void QSGThreadedRenderLoop::maybeUpdate ( QQuickWindow * window)
overridevirtual

Implements QSGRenderLoop.

Definition at line 1406 of file qsgthreadedrenderloop.cpp.

References maybeUpdate(), and window().

Referenced by maybeUpdate(), and update().

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

◆ postJob()

void QSGThreadedRenderLoop::postJob ( QQuickWindow * window,
QRunnable * job )
overridevirtual

Reimplemented from QSGRenderLoop.

Definition at line 1776 of file qsgthreadedrenderloop.cpp.

References window().

+ Here is the call graph for this function:

◆ releaseResources()

void QSGThreadedRenderLoop::releaseResources ( QQuickWindow * window)
overridevirtual

Implements QSGRenderLoop.

Definition at line 1478 of file qsgthreadedrenderloop.cpp.

References releaseResources(), and window().

Referenced by hide(), releaseResources(), and windowDestroyed().

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

◆ resize()

void QSGThreadedRenderLoop::resize ( QQuickWindow * window)
overridevirtual

Reimplemented from QSGRenderLoop.

Definition at line 1157 of file qsgthreadedrenderloop.cpp.

References qCDebug, and window().

+ Here is the call graph for this function:

◆ sceneGraphContext()

QSGContext * QSGThreadedRenderLoop::sceneGraphContext ( ) const
overridevirtual

Implements QSGRenderLoop.

Definition at line 1042 of file qsgthreadedrenderloop.cpp.

◆ show()

void QSGThreadedRenderLoop::show ( QQuickWindow * )
inlineoverridevirtual

Implements QSGRenderLoop.

Definition at line 35 of file qsgthreadedrenderloop_p.h.

◆ update()

void QSGThreadedRenderLoop::update ( QQuickWindow * window)
overridevirtual

Implements QSGRenderLoop.

Definition at line 1458 of file qsgthreadedrenderloop.cpp.

References QThread::currentThread(), maybeUpdate(), qCDebug, and window().

+ Here is the call graph for this function:

◆ windowDestroyed()

void QSGThreadedRenderLoop::windowDestroyed ( QQuickWindow * window)
overridevirtual

Implements QSGRenderLoop.

Definition at line 1174 of file qsgthreadedrenderloop.cpp.

References QList< T >::at(), QThread::currentThread(), i, QThread::isRunning(), Q_ASSERT, qCDebug, releaseResources(), QList< T >::removeAt(), QList< T >::size(), QObject::thread(), window(), QWidget::window(), and QThread::yieldCurrentThread().

+ Here is the call graph for this function:

Friends And Related Symbol Documentation

◆ QSGRenderThread

friend class QSGRenderThread
friend

Definition at line 77 of file qsgthreadedrenderloop_p.h.


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