#include <qsgcontext_p.h>

Inheritance diagram for QSGRenderContext:

Collaboration diagram for QSGRenderContext:

Classes
struct	InitParams

Public Types
enum	CreateTextureFlags { CreateTexture_Alpha = 0x1 , CreateTexture_Atlas = 0x2 , CreateTexture_Mipmap = 0x4 }

using	RenderPassCallback = void()(void )

Public Slots
void	textureFactoryDestroyed (QObject *o)

Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe

Signals
void	initialized ()

void	invalidated ()

void	releaseCachedResourcesRequested ()

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.

Public Member Functions
	QSGRenderContext (QSGContext *context)

	~QSGRenderContext () override

QSGContext *	sceneGraphContext () const

virtual bool	isValid () const

virtual void	initialize (const InitParams *params)

virtual void	invalidate ()

virtual void	prepareSync (qreal devicePixelRatio, QRhiCommandBuffer *cb, const QQuickGraphicsConfiguration &config)

virtual void	beginNextFrame (QSGRenderer renderer, const QSGRenderTarget &renderTarget, RenderPassCallback mainPassRecordingStart, RenderPassCallback mainPassRecordingEnd, void callbackUserData)

virtual void	renderNextFrame (QSGRenderer *renderer)=0

virtual void	endNextFrame (QSGRenderer *renderer)

virtual void	endSync ()

virtual void	preprocess ()
	Do necessary preprocessing before the frame.

virtual void	invalidateGlyphCaches ()

virtual QSGDistanceFieldGlyphCache *	distanceFieldGlyphCache (const QRawFont &font, int renderTypeQuality)
	Factory function for scene graph backends of the distance-field glyph cache.

QSGTexture *	textureForFactory (QQuickTextureFactory factory, QQuickWindow window)
	Factory function for the scene graph renderers.

virtual QSGTexture *	createTexture (const QImage &image, uint flags=CreateTexture_Alpha) const =0

virtual QSGRenderer *	createRenderer (QSGRendererInterface::RenderMode renderMode=QSGRendererInterface::RenderMode2D)=0

virtual QSGTexture *	compressedTextureForFactory (const QSGCompressedTextureFactory *) const
	Return the texture corresponding to a texture factory.

virtual int	maxTextureSize () const =0

void	unregisterFontengineForCleanup (QFontEngine *engine)

void	registerFontengineForCleanup (QFontEngine *engine)

virtual QRhi *	rhi () const

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.

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< 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.

void	moveToThread (QThread *thread)
	Changes the thread affinity for this object and its children.

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::milliseconds time, Qt::TimerType timerType=Qt::CoarseTimer)

void	killTimer (int id)
	Kills the timer with timer identifier, id.

template<typename T >
T	findChild (const QString &aName=QString(), 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 (const QString &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 >
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`.

Protected Attributes
QPointer< QSGContext >	m_sg

QMutex	m_mutex

QHash< QObject , QSGTexture >	m_textures

QSet< QSGTexture * >	m_texturesToDelete

QHash< QString, QSGDistanceFieldGlyphCache * >	m_glyphCaches

QHash< QFontEngine *, int >	m_fontEnginesToClean

Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr

Additional Inherited Members
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)

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 123 of file qsgcontext_p.h.

Member Typedef Documentation

◆ RenderPassCallback

using QSGRenderContext::RenderPassCallback = void (*)(void *)

Definition at line 143 of file qsgcontext_p.h.

Member Enumeration Documentation

◆ CreateTextureFlags

enum QSGRenderContext::CreateTextureFlags

Enumerator
CreateTexture_Alpha
CreateTexture_Atlas
CreateTexture_Mipmap

Definition at line 127 of file qsgcontext_p.h.

Constructor & Destructor Documentation

◆ QSGRenderContext()

QSGRenderContext::QSGRenderContext ( QSGContext * context )

Definition at line 406 of file qsgcontext.cpp.

◆ ~QSGRenderContext()

QSGRenderContext::~QSGRenderContext ( )

override

Definition at line 411 of file qsgcontext.cpp.

Member Function Documentation

◆ beginNextFrame()

void QSGRenderContext::beginNextFrame	(	QSGRenderer *	renderer,
		const QSGRenderTarget &	renderTarget,
		RenderPassCallback	mainPassRecordingStart,
		RenderPassCallback	mainPassRecordingEnd,
		void *	callbackUserData
	)

virtual

Reimplemented in QSGDefaultRenderContext.

Definition at line 433 of file qsgcontext.cpp.

References Q_UNUSED, and renderer.

Referenced by QQuickWindowPrivate::renderSceneGraph().

Here is the caller graph for this function:

◆ compressedTextureForFactory()

QSGTexture * QSGRenderContext::compressedTextureForFactory ( const QSGCompressedTextureFactory * ) const

virtual

Return the texture corresponding to a texture factory.

This may optionally manipulate the texture in some way; for example by returning an atlased texture.

This function is not a replacement for textureForFactory; both should be used for a single texture (this might atlas, while the other might cache).

Reimplemented in QSGDefaultRenderContext.

Definition at line 536 of file qsgcontext.cpp.

◆ createRenderer()

virtual QSGRenderer * QSGRenderContext::createRenderer ( QSGRendererInterface::RenderMode renderMode = QSGRendererInterface::RenderMode2D )

pure virtual

Implemented in QSGOpenVGRenderContext, QSGDefaultRenderContext, and QSGSoftwareRenderContext.

Referenced by QQuickWindowPrivate::syncSceneGraph(), and QQuick3DItem2D::updateSpatialNode().

Here is the caller graph for this function:

◆ createTexture()

virtual QSGTexture * QSGRenderContext::createTexture	(	const QImage &	image,
		uint	flags = `CreateTexture_Alpha`
	)		const

pure virtual

Implemented in QSGOpenVGRenderContext, QSGDefaultRenderContext, and QSGSoftwareRenderContext.

Referenced by QQuickTextNode::addImage().

Here is the caller graph for this function:

◆ distanceFieldGlyphCache()

QSGDistanceFieldGlyphCache * QSGRenderContext::distanceFieldGlyphCache	(	const QRawFont &	font,
		int	renderTypeQuality
	)

virtual

Factory function for scene graph backends of the distance-field glyph cache.

Reimplemented in QSGDefaultRenderContext.

Definition at line 465 of file qsgcontext.cpp.

Referenced by QSGDistanceFieldGlyphNode::setGlyphs().

Here is the caller graph for this function:

◆ endNextFrame()

void QSGRenderContext::endNextFrame ( QSGRenderer * renderer )

virtual

Reimplemented in QSGDefaultRenderContext.

Definition at line 444 of file qsgcontext.cpp.

References Q_UNUSED, and renderer.

Referenced by QQuickWindowPrivate::renderSceneGraph().

Here is the caller graph for this function:

◆ endSync()

void QSGRenderContext::endSync ( )

virtual

Definition at line 449 of file qsgcontext.cpp.

References QSet< T >::clear(), m_texturesToDelete, and qDeleteAll().

Referenced by QSGRenderThread::event(), QSGSoftwareRenderThread::event(), QQuickRenderControlPrivate::grab(), QSGOpenVGRenderLoop::renderWindow(), QSGSoftwareRenderLoop::renderWindow(), QSGSoftwareRenderThread::sync(), and QSGRenderThread::sync().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initialize()

void QSGRenderContext::initialize ( const InitParams * params )

virtual

Reimplemented in QSGOpenVGRenderContext, and QSGDefaultRenderContext.

Definition at line 415 of file qsgcontext.cpp.

References Q_UNUSED.

Referenced by QSGGuiThreadRenderLoop::ensureRhi(), QSGSoftwareRenderThread::event(), QSGRhiSupport::grabOffscreen(), QSGOpenVGRenderContext::initialize(), QSGOpenVGRenderLoop::renderWindow(), and QSGSoftwareRenderThread::sync().

Here is the caller graph for this function:

◆ initialized

void QSGRenderContext::initialized ( )

signal

Referenced by QQuickWindowPrivate::init(), QSGOpenVGRenderContext::initialize(), QSGDefaultRenderContext::initialize(), and QSGSoftwareRenderContext::initializeIfNeeded().

Here is the caller graph for this function:

◆ invalidate()

void QSGRenderContext::invalidate ( )

virtual

Reimplemented in QSGOpenVGRenderContext, QSGSoftwareRenderContext, and QSGDefaultRenderContext.

Definition at line 420 of file qsgcontext.cpp.

Referenced by QSGRhiSupport::grabOffscreen(), QSGOpenVGRenderContext::invalidate(), QQuickRenderControlPrivate::windowDestroyed(), QSGOpenVGRenderLoop::windowDestroyed(), and QSGSoftwareRenderLoop::windowDestroyed().

Here is the caller graph for this function:

◆ invalidated

void QSGRenderContext::invalidated ( )

signal

Referenced by QQuick3DWindowAttachment::QQuick3DWindowAttachment(), QQuickWindowPrivate::init(), QSGOpenVGRenderContext::invalidate(), QSGSoftwareRenderContext::invalidate(), and QSGDefaultRenderContext::invalidate().

Here is the caller graph for this function:

◆ invalidateGlyphCaches()

void QSGRenderContext::invalidateGlyphCaches ( )

virtual

Reimplemented in QSGDefaultRenderContext.

Definition at line 470 of file qsgcontext.cpp.

Referenced by QQuickWindowPrivate::syncSceneGraph().

Here is the caller graph for this function:

◆ isValid()

virtual bool QSGRenderContext::isValid ( ) const

inlinevirtual

Reimplemented in QSGDefaultRenderContext.

Definition at line 137 of file qsgcontext_p.h.

Referenced by QQuickWindowPrivate::openglContext().

Here is the caller graph for this function:

◆ maxTextureSize()

virtual int QSGRenderContext::maxTextureSize ( ) const

pure virtual

Implemented in QSGOpenVGRenderContext, QSGSoftwareRenderContext, and QSGDefaultRenderContext.

◆ prepareSync()

void QSGRenderContext::prepareSync	(	qreal	devicePixelRatio,
		QRhiCommandBuffer *	cb,
		const QQuickGraphicsConfiguration &	config
	)

virtual

Reimplemented in QSGDefaultRenderContext.

Definition at line 424 of file qsgcontext.cpp.

References cb, and Q_UNUSED.

Referenced by QQuickWindowPrivate::syncSceneGraph().

Here is the caller graph for this function:

◆ preprocess()

void QSGRenderContext::preprocess ( )

virtual

Do necessary preprocessing before the frame.

Reimplemented in QSGDefaultRenderContext.

Definition at line 458 of file qsgcontext.cpp.

Referenced by QSGRenderer::preprocess().

Here is the caller graph for this function:

◆ registerFontengineForCleanup()

void QSGRenderContext::registerFontengineForCleanup ( QFontEngine * engine )

Definition at line 475 of file qsgcontext.cpp.

References engine, and m_fontEnginesToClean.

◆ releaseCachedResourcesRequested

void QSGRenderContext::releaseCachedResourcesRequested ( )

signal

Referenced by QQuick3DWindowAttachment::QQuick3DWindowAttachment().

Here is the caller graph for this function:

◆ renderNextFrame()

virtual void QSGRenderContext::renderNextFrame ( QSGRenderer * renderer )

pure virtual

Implemented in QSGOpenVGRenderContext, QSGSoftwareRenderContext, and QSGDefaultRenderContext.

Referenced by QQuickWindowPrivate::renderSceneGraph().

Here is the caller graph for this function:

◆ rhi()

QRhi * QSGRenderContext::rhi ( ) const

virtual

Reimplemented in QSGDefaultRenderContext.

Definition at line 487 of file qsgcontext.cpp.

◆ sceneGraphContext()

QSGContext * QSGRenderContext::sceneGraphContext ( ) const

inline

Definition at line 136 of file qsgcontext_p.h.

Referenced by QQuickTextNode::addGlyphs(), QQuickTextNode::addImage(), QQuickTextNode::addRectangleNode(), QQuickShaderEffectPrivate::handleUpdatePaintNode(), isOpenGL(), QQuickWindowPrivate::openglContext(), QQuickDesignerSupport::refFromEffectItem(), QSGSoftwareRenderThread::run(), QSGRenderThread::run(), QQuickTextNode::setCursor(), QQuickImageParticle::updatePaintNode(), QQuickCanvasItem::updatePaintNode(), and QQuick3DTexture::updateSpatialNode().

Here is the caller graph for this function:

◆ textureFactoryDestroyed

void QSGRenderContext::textureFactoryDestroyed ( QObject * o )

slot

Definition at line 520 of file qsgcontext.cpp.

References QMutex::lock(), m_mutex, m_textures, m_texturesToDelete, o, QHash< Key, T >::take(), and QMutex::unlock().

Referenced by textureForFactory().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ textureForFactory()

QSGTexture * QSGRenderContext::textureForFactory	(	QQuickTextureFactory *	factory,
		QQuickWindow *	window
	)

Factory function for the scene graph renderers.

The renderers are used for the toplevel renderer and once for every QQuickShaderEffectSource used in the QML scene.

Definition at line 499 of file qsgcontext.cpp.

References QObject::connect(), QObject::destroyed(), Qt::DirectConnection, factory, QHash< Key, T >::insert(), QMutex::lock(), m_mutex, m_textures, SIGNAL, SLOT, textureFactoryDestroyed(), QMutex::unlock(), QHash< Key, T >::value(), and window().

Here is the call graph for this function:

◆ unregisterFontengineForCleanup()

void QSGRenderContext::unregisterFontengineForCleanup ( QFontEngine * engine )

Definition at line 481 of file qsgcontext.cpp.

References engine, m_fontEnginesToClean, Q_ASSERT, and QHash< Key, T >::value().

Referenced by QSGTextMaskMaterial::~QSGTextMaskMaterial().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ m_fontEnginesToClean

QHash<QFontEngine *, int> QSGRenderContext::m_fontEnginesToClean

protected

Definition at line 193 of file qsgcontext_p.h.

Referenced by QSGSoftwareRenderContext::invalidate(), QSGDefaultRenderContext::invalidate(), QSGDefaultRenderContext::invalidateGlyphCaches(), registerFontengineForCleanup(), and unregisterFontengineForCleanup().

◆ m_glyphCaches

QHash<QString, QSGDistanceFieldGlyphCache *> QSGRenderContext::m_glyphCaches

protected

Definition at line 189 of file qsgcontext_p.h.

Referenced by QSGDefaultRenderContext::distanceFieldGlyphCache(), QSGSoftwareRenderContext::invalidate(), QSGDefaultRenderContext::invalidate(), QSGDefaultRenderContext::invalidateGlyphCaches(), and QSGDefaultRenderContext::preprocess().

◆ m_mutex

QMutex QSGRenderContext::m_mutex

protected

Definition at line 186 of file qsgcontext_p.h.

Referenced by textureFactoryDestroyed(), and textureForFactory().

◆ m_sg

QPointer<QSGContext> QSGRenderContext::m_sg

protected

Definition at line 184 of file qsgcontext_p.h.

Referenced by QSGDefaultRenderContext::initialize(), QSGSoftwareRenderContext::invalidate(), and QSGDefaultRenderContext::invalidate().

◆ m_textures

QHash<QObject *, QSGTexture *> QSGRenderContext::m_textures

protected

Definition at line 187 of file qsgcontext_p.h.

Referenced by QSGSoftwareRenderContext::invalidate(), QSGDefaultRenderContext::invalidate(), textureFactoryDestroyed(), and textureForFactory().

◆ m_texturesToDelete

QSet<QSGTexture *> QSGRenderContext::m_texturesToDelete

protected

Definition at line 188 of file qsgcontext_p.h.

Referenced by endSync(), QSGSoftwareRenderContext::invalidate(), QSGDefaultRenderContext::invalidate(), and textureFactoryDestroyed().

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

qtdeclarative/src/quick/scenegraph/qsgcontext_p.h
qtdeclarative/src/quick/scenegraph/qsgcontext.cpp

Classes

Public Types

Public Slots

Signals

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ RenderPassCallback

Member Enumeration Documentation

◆ CreateTextureFlags

Constructor & Destructor Documentation

◆ QSGRenderContext()

◆ ~QSGRenderContext()

Member Function Documentation

◆ beginNextFrame()

◆ compressedTextureForFactory()

◆ createRenderer()

◆ createTexture()

◆ distanceFieldGlyphCache()

◆ endNextFrame()

◆ endSync()

◆ initialize()

◆ initialized

◆ invalidate()

◆ invalidated

◆ invalidateGlyphCaches()

◆ isValid()

◆ maxTextureSize()

◆ prepareSync()

◆ preprocess()

◆ registerFontengineForCleanup()

◆ releaseCachedResourcesRequested

◆ renderNextFrame()

◆ rhi()

◆ sceneGraphContext()

◆ textureFactoryDestroyed

◆ textureForFactory()

◆ unregisterFontengineForCleanup()

Member Data Documentation

◆ m_fontEnginesToClean

◆ m_glyphCaches

◆ m_mutex

◆ m_sg

◆ m_textures

◆ m_texturesToDelete