QSGAbstractRenderer gives access to the scene graph nodes and rendering. More...

#include <qsgabstractrenderer_p.h>

Inheritance diagram for QSGAbstractRenderer:

Collaboration diagram for QSGAbstractRenderer:

Public Types
enum	ClearModeBit { ClearColorBuffer = 0x0001 , ClearDepthBuffer = 0x0002 , ClearStencilBuffer = 0x0004 }
	Used with setClearMode() to indicate which buffer should be cleared before the scene render. More...

enum	MatrixTransformFlag { MatrixTransformFlipY = 0x01 }
	Used with setProjectionMatrixToRect() to indicate the expectations towards the generated projection matrix. More...

Signals
void	sceneGraphChanged ()
	This signal is emitted on the first modification of a node in the tree after the last scene render.

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
	~QSGAbstractRenderer () override

void	setRootNode (QSGRootNode *node)
	Sets the node as the root of the QSGNode scene that you want to render.

QSGRootNode *	rootNode () const
	Returns the root of the QSGNode scene.

void	setDeviceRect (const QRect &rect)
	Sets rect as the geometry of the surface being rendered to.

void	setDeviceRect (const QSize &size)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Sets the size of the surface being rendered to.

QRect	deviceRect () const
	Returns the device rect of the surface being rendered to.

void	setViewportRect (const QRect &rect)
	Sets rect as the geometry of the viewport to render on the surface.

void	setViewportRect (const QSize &size)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Sets the size of the viewport to render on the surface.

QRect	viewportRect () const
	Returns the rect of the viewport to render.

void	setProjectionMatrixToRect (const QRectF &rect)
	Convenience method that calls setProjectionMatrix() with an orthographic matrix generated from rect.

void	setProjectionMatrixToRect (const QRectF &rect, MatrixTransformFlags flags)
	Convenience method that calls setProjectionMatrix() with an orthographic matrix generated from rect.

void	setProjectionMatrix (const QMatrix4x4 &matrix)
	Use matrix to project the QSGNode coordinates onto surface pixels.

void	setProjectionMatrixWithNativeNDC (const QMatrix4x4 &matrix)

QMatrix4x4	projectionMatrix () const
	Returns the projection matrix.

QMatrix4x4	projectionMatrixWithNativeNDC () const

void	setClearColor (const QColor &color)
	Use color to clear the framebuffer when clearMode() is set to QSGAbstractRenderer::ClearColorBuffer.

QColor	clearColor () const
	Returns the color that clears the framebuffer at the beginning of the rendering.

void	setClearMode (ClearMode mode)
	Defines which attachment of the framebuffer should be cleared before each scene render with the mode flag.

ClearMode	clearMode () const
	Flags defining which attachment of the framebuffer will be cleared before each scene render.

virtual void	renderScene ()=0
	Renders the scene.

virtual void	prepareSceneInline ()

virtual void	renderSceneInline ()

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 Member Functions
	QSGAbstractRenderer (QObject *parent=nullptr)

virtual void	nodeChanged (QSGNode *node, QSGNode::DirtyState state)=0

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)

Friends
class	QSGRootNode

Additional Inherited Members
Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe

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

QSGAbstractRenderer gives access to the scene graph nodes and rendering.

\inmodule QtQuick

Since: 5.4

Definition at line 30 of file qsgabstractrenderer_p.h.

Member Enumeration Documentation

◆ ClearModeBit

enum QSGAbstractRenderer::ClearModeBit

Used with setClearMode() to indicate which buffer should be cleared before the scene render.

\value ClearColorBuffer Clear the color buffer using clearColor(). \value ClearDepthBuffer Clear the depth buffer. \value ClearStencilBuffer Clear the stencil buffer.

See also: setClearMode(), setClearColor()

Enumerator
ClearColorBuffer
ClearDepthBuffer
ClearStencilBuffer

Definition at line 34 of file qsgabstractrenderer_p.h.

◆ MatrixTransformFlag

enum QSGAbstractRenderer::MatrixTransformFlag

Used with setProjectionMatrixToRect() to indicate the expectations towards the generated projection matrix.

\value MatrixTransformFlipY The traditional assumption in Qt Quick is that Y points up in the normalized device coordinate system. There is at least one modern graphics API where this is not the case (Vulkan). This flag can then be used to get a projection that is appropriate for such an API.

See also: setProjectionMatrixToRect()

Since: 5.14

Enumerator
MatrixTransformFlipY

Definition at line 43 of file qsgabstractrenderer_p.h.

Constructor & Destructor Documentation

◆ ~QSGAbstractRenderer()

QSGAbstractRenderer::~QSGAbstractRenderer ( )

override

Definition at line 79 of file qsgabstractrenderer.cpp.

◆ QSGAbstractRenderer()

QSGAbstractRenderer::QSGAbstractRenderer ( QObject * parent = nullptr )

explicitprotected

Definition at line 71 of file qsgabstractrenderer.cpp.

Member Function Documentation

◆ clearColor()

QColor QSGAbstractRenderer::clearColor ( ) const

Returns the color that clears the framebuffer at the beginning of the rendering.

See also: setClearColor(), clearMode()

Definition at line 300 of file qsgabstractrenderer.cpp.

References d.

Referenced by QSGBatchRenderer::Renderer::prepareRenderPass(), QSGOpenVGRenderer::render(), QSGSoftwareRenderer::render(), and QSGSoftwarePixmapRenderer::render().

Here is the caller graph for this function:

◆ clearMode()

QSGAbstractRenderer::ClearMode QSGAbstractRenderer::clearMode ( ) const

Flags defining which attachment of the framebuffer will be cleared before each scene render.

See also: setClearMode(), clearColor()

Definition at line 324 of file qsgabstractrenderer.cpp.

References d.

◆ deviceRect()

QRect QSGAbstractRenderer::deviceRect ( ) const

Returns the device rect of the surface being rendered to.

See also: setDeviceRect()

Definition at line 146 of file qsgabstractrenderer.cpp.

References d.

Referenced by QSGBatchRenderer::Renderer::prepareRenderPass().

Here is the caller graph for this function:

◆ nodeChanged()

void QSGAbstractRenderer::nodeChanged	(	QSGNode *	node,
		QSGNode::DirtyState	state
	)

protectedpure virtual

Implemented in QSGOpenVGRenderer, QSGAbstractSoftwareRenderer, QSGBatchRenderer::Renderer, and QSGRenderer.

Referenced by setRootNode().

Here is the caller graph for this function:

◆ prepareSceneInline()

void QSGAbstractRenderer::prepareSceneInline ( )

virtual

Reimplemented in QSGRenderer.

Definition at line 335 of file qsgabstractrenderer.cpp.

◆ projectionMatrix()

QMatrix4x4 QSGAbstractRenderer::projectionMatrix ( ) const

Returns the projection matrix.

See also: setProjectionMatrix(), setProjectionMatrixToRect()

Definition at line 267 of file qsgabstractrenderer.cpp.

References d.

Referenced by QSGRenderer::isMirrored().

Here is the caller graph for this function:

◆ projectionMatrixWithNativeNDC()

QMatrix4x4 QSGAbstractRenderer::projectionMatrixWithNativeNDC ( ) const

Definition at line 276 of file qsgabstractrenderer.cpp.

References d.

◆ renderScene()

void QSGAbstractRenderer::renderScene ( )

pure virtual

Renders the scene.

Implemented in QSGSoftwarePixmapRenderer, QSGSoftwareRenderer, and QSGRenderer.

◆ renderSceneInline()

void QSGAbstractRenderer::renderSceneInline ( )

virtual

Reimplemented in QSGRenderer.

Definition at line 339 of file qsgabstractrenderer.cpp.

◆ rootNode()

QSGRootNode * QSGAbstractRenderer::rootNode ( ) const

Returns the root of the QSGNode scene.

See also: setRootNode()

Definition at line 114 of file qsgabstractrenderer.cpp.

References d.

Referenced by QSGAbstractSoftwareRenderer::buildRenderList(), QSGBatchRenderer::Renderer::nodeChanged(), QSGBatchRenderer::Renderer::prepareRenderPass(), QSGRenderer::prepareSceneInline(), QSGBatchRenderer::RhiVisualizer::prepareVisualize(), QSGRenderer::preprocess(), QSGOpenVGRenderer::render(), and QSGRenderer::renderScene().

Here is the caller graph for this function:

◆ sceneGraphChanged

void QSGAbstractRenderer::sceneGraphChanged ( )

signal

This signal is emitted on the first modification of a node in the tree after the last scene render.

Referenced by QSGRenderer::nodeChanged(), QSGSoftwareRenderThread::sync(), and QQuick3DItem2D::updateSpatialNode().

Here is the caller graph for this function:

◆ setClearColor()

void QSGAbstractRenderer::setClearColor ( const QColor & color )

Use color to clear the framebuffer when clearMode() is set to QSGAbstractRenderer::ClearColorBuffer.

See also: clearColor(), setClearMode()

Definition at line 288 of file qsgabstractrenderer.cpp.

References d.

Referenced by QQuickWindowPrivate::syncSceneGraph().

Here is the caller graph for this function:

◆ setClearMode()

void QSGAbstractRenderer::setClearMode ( ClearMode mode )

Defines which attachment of the framebuffer should be cleared before each scene render with the mode flag.

See also: clearMode(), setClearColor()

Definition at line 312 of file qsgabstractrenderer.cpp.

References d.

Referenced by QQuickWindowPrivate::syncSceneGraph().

Here is the caller graph for this function:

◆ setDeviceRect() [1/2]

void QSGAbstractRenderer::setDeviceRect ( const QRect & rect )

Sets rect as the geometry of the surface being rendered to.

See also: deviceRect()

Definition at line 135 of file qsgabstractrenderer.cpp.

References d, and rect.

Referenced by QQuickWindowPrivate::renderSceneGraph().

Here is the caller graph for this function:

◆ setDeviceRect() [2/2]

void QSGAbstractRenderer::setDeviceRect ( const QSize & size )

inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Sets the size of the surface being rendered to.

See also: deviceRect()

Definition at line 55 of file qsgabstractrenderer_p.h.

References setDeviceRect().

Referenced by setDeviceRect().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setProjectionMatrix()

void QSGAbstractRenderer::setProjectionMatrix ( const QMatrix4x4 & matrix )

Use matrix to project the QSGNode coordinates onto surface pixels.

See also: projectionMatrix(), setProjectionMatrixToRect()

Definition at line 247 of file qsgabstractrenderer.cpp.

References d.

Referenced by setProjectionMatrixToRect(), and setProjectionMatrixToRect().

Here is the caller graph for this function:

◆ setProjectionMatrixToRect() [1/2]

void QSGAbstractRenderer::setProjectionMatrixToRect ( const QRectF & rect )

Convenience method that calls setProjectionMatrix() with an orthographic matrix generated from rect.

Note: This function assumes that the graphics API uses Y up in its normalized device coordinate system.

See also: setProjectionMatrix(), projectionMatrix()

Definition at line 194 of file qsgabstractrenderer.cpp.

References rect, setProjectionMatrix(), and setProjectionMatrixWithNativeNDC().

Referenced by QQuickWindowPrivate::renderSceneGraph().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setProjectionMatrixToRect() [2/2]

void QSGAbstractRenderer::setProjectionMatrixToRect	(	const QRectF &	rect,
		MatrixTransformFlags	flags
	)

Convenience method that calls setProjectionMatrix() with an orthographic matrix generated from rect.

Set MatrixTransformFlipY in flags when the graphics API uses Y down in its normalized device coordinate system (for example, Vulkan).

See also: setProjectionMatrix(), projectionMatrix()

Since: 5.14

Definition at line 218 of file qsgabstractrenderer.cpp.

References MatrixTransformFlipY, rect, setProjectionMatrix(), and setProjectionMatrixWithNativeNDC().

Here is the call graph for this function:

◆ setProjectionMatrixWithNativeNDC()

void QSGAbstractRenderer::setProjectionMatrixWithNativeNDC ( const QMatrix4x4 & matrix )

Definition at line 256 of file qsgabstractrenderer.cpp.

References d.

Referenced by setProjectionMatrixToRect(), and setProjectionMatrixToRect().

Here is the caller graph for this function:

◆ setRootNode()

void QSGAbstractRenderer::setRootNode ( QSGRootNode * node )

Sets the node as the root of the QSGNode scene that you want to render.

You need to provide a node before trying to render the scene.

Note: This doesn't take ownership of node.

See also: rootNode()

Definition at line 92 of file qsgabstractrenderer.cpp.

References d, QSGNode::DirtyNodeAdded, QSGNode::DirtyNodeRemoved, nodeChanged(), and Q_ASSERT.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setViewportRect() [1/2]

void QSGAbstractRenderer::setViewportRect ( const QRect & rect )

Sets rect as the geometry of the viewport to render on the surface.

See also: viewportRect()

Definition at line 168 of file qsgabstractrenderer.cpp.

References d, and rect.

Referenced by QQuickWindowPrivate::renderSceneGraph().

Here is the caller graph for this function:

◆ setViewportRect() [2/2]

void QSGAbstractRenderer::setViewportRect ( const QSize & size )

inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Sets the size of the viewport to render on the surface.

See also: viewportRect()

Definition at line 59 of file qsgabstractrenderer_p.h.

References setViewportRect().

Referenced by setViewportRect().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ viewportRect()

QRect QSGAbstractRenderer::viewportRect ( ) const

Returns the rect of the viewport to render.

See also: setViewportRect()

Definition at line 179 of file qsgabstractrenderer.cpp.

References d.

Referenced by QSGBatchRenderer::Renderer::prepareRenderPass().

Here is the caller graph for this function:

Friends And Related Symbol Documentation

◆ QSGRootNode

friend class QSGRootNode

friend

Definition at line 89 of file qsgabstractrenderer_p.h.

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

qtdeclarative/src/quick/scenegraph/coreapi/qsgabstractrenderer_p.h
qtdeclarative/src/quick/scenegraph/coreapi/qsgabstractrenderer.cpp

Public Types

Signals

Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ ClearModeBit

◆ MatrixTransformFlag

Constructor & Destructor Documentation

◆ ~QSGAbstractRenderer()

◆ QSGAbstractRenderer()

Member Function Documentation

◆ clearColor()

◆ clearMode()

◆ deviceRect()

◆ nodeChanged()

◆ prepareSceneInline()

◆ projectionMatrix()

◆ projectionMatrixWithNativeNDC()

◆ renderScene()

◆ renderSceneInline()

◆ rootNode()

◆ sceneGraphChanged

◆ setClearColor()

◆ setClearMode()

◆ setDeviceRect() [1/2]

◆ setDeviceRect() [2/2]

◆ setProjectionMatrix()

◆ setProjectionMatrixToRect() [1/2]

◆ setProjectionMatrixToRect() [2/2]

◆ setProjectionMatrixWithNativeNDC()

◆ setRootNode()

◆ setViewportRect() [1/2]

◆ setViewportRect() [2/2]

◆ viewportRect()

Friends And Related Symbol Documentation

◆ QSGRootNode