Inheritance diagram for QSGGuiThreadRenderLoop:

Collaboration diagram for QSGGuiThreadRenderLoop:

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)

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)

Detailed Description

Definition at line 112 of file qsgrenderloop.cpp.

Constructor & Destructor Documentation

◆ QSGGuiThreadRenderLoop()

QSGGuiThreadRenderLoop::QSGGuiThreadRenderLoop ( )

Definition at line 298 of file qsgrenderloop.cpp.

References QSGContext::createDefaultContext(), QUnifiedTimer::instance(), qCDebug, qsg_useConsistentTiming(), and sg.

Here is the call graph for this function:

◆ ~QSGGuiThreadRenderLoop()

QSGGuiThreadRenderLoop::~QSGGuiThreadRenderLoop ( )

Definition at line 308 of file qsgrenderloop.cpp.

References pendingRenderContexts, qDeleteAll(), and sg.

Here is the call graph for this function:

Member Function Documentation

◆ animationDriver()

QAnimationDriver * QSGGuiThreadRenderLoop::animationDriver ( ) const

inlineoverridevirtual

Implements QSGRenderLoop.

Definition at line 134 of file qsgrenderloop.cpp.

◆ createRenderContext()

QSGRenderContext * QSGGuiThreadRenderLoop::createRenderContext ( QSGContext * sg ) const

overridevirtual

Implements QSGRenderLoop.

Definition at line 852 of file qsgrenderloop.cpp.

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

Here is the call graph for this function:

◆ ensureRhi()

bool QSGGuiThreadRenderLoop::ensureRhi	(	QQuickWindow *	window,
		WindowData &	data )

Definition at line 451 of file qsgrenderloop.cpp.

References QSurfaceFormat::alphaBufferSize(), QSGRhiSupport::applySwapChainFormat(), QSGRhiSupport::chooseSampleCountForWindowWithRhi(), QQuickWindowPrivate::context, QSGRhiSupport::createRhi(), QRhiRenderBuffer::DepthStencil, QQuickWindowPrivate::depthStencilForSwapchain, QQuickWindowPrivate::get(), QSGRenderLoop::handleContextCreationFailure(), QSGRenderContext::initialize(), QSGRhiSupport::instance(), QRhi::makeThreadLocalNativeContextCurrent(), QSGRhiSupport::maybeCreateOffscreenSurface(), QRhiSwapChain::newCompatibleRenderPassDescriptor(), QRhi::newRenderBuffer(), QRhi::newSwapChain(), QRhiSwapChain::NoVSync, offscreenSurface, ok, pendingRenderContexts, QSGRhiSupport::prepareWindowForRhi(), qCDebug, qEnvironmentVariableIsEmpty(), qWarning, QSet< T >::remove(), QRhiResource::rhi(), QQuickWindowPrivate::rhi, QSGDefaultRenderContext::InitParams::rhi, QSGRhiSupport::RhiCreateResult::rhi, QQuickWindowPrivate::rpDescForSwapchain, QRhiSwapChain::setDepthStencil(), QRhiSwapChain::setFlags(), QRhiSwapChain::setRenderPassDescriptor(), QRhiSwapChain::setSampleCount(), QRhiSwapChain::setWindow(), QRhiSwapChain::SurfaceHasPreMulAlpha, QQuickWindowPrivate::swapchain, QSurfaceFormat::swapInterval(), swRastFallbackDueToSwapchainFailure, QRhiSwapChain::UsedAsTransferSource, QRhiRenderBuffer::UsedWithSwapChainOnly, and window().

Referenced by grab(), and renderWindow().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ eventFilter()

bool QSGGuiThreadRenderLoop::eventFilter	(	QObject *	watched,
		QEvent *	event )

overridevirtual

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:
    MainWindow();
 
protected:
    bool eventFilter(QObject *obj, QEvent *ev) override;
 
private:
    QTextEdit *textEdit;
};
 
MainWindow::MainWindow()
{
    textEdit = new QTextEdit;
    setCentralWidget(textEdit);
 
    textEdit->installEventFilter(this);
}
 
bool MainWindow::eventFilter(QObject *obj, QEvent *event)
{
    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
        return QMainWindow::eventFilter(obj, event);
    }
}

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.