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>.
|
The renderer class is the abstract baseclass used for rendering the QML scene graph. More...
#include <qsgrenderer_p.h>
Public Member Functions | |
QSGRenderer (QSGRenderContext *context) | |
virtual | ~QSGRenderer () |
QMatrix4x4 | currentProjectionMatrix (int index) const |
QMatrix4x4 | currentModelViewMatrix () const |
QMatrix4x4 | currentCombinedMatrix (int index) const |
qreal | currentOpacity () const |
qreal | determinant () const |
void | setDevicePixelRatio (qreal ratio) |
qreal | devicePixelRatio () const |
QSGRenderContext * | context () const |
bool | isMirrored () const |
void | renderScene () override |
Renders the scene. | |
void | prepareSceneInline () override |
void | renderSceneInline () override |
void | nodeChanged (QSGNode *node, QSGNode::DirtyState state) override |
Updates internal data structures and emits the sceneGraphChanged() signal. | |
QSGNodeUpdater * | nodeUpdater () const |
Returns the node updater that this renderer uses to update states in the scene graph. | |
void | setNodeUpdater (QSGNodeUpdater *updater) |
Sets the node updater that this renderer uses to update states in the scene graph. | |
QSGMaterialShader::RenderState | state (QSGMaterialShader::RenderState::DirtyStates dirty) const |
virtual void | setVisualizationMode (const QByteArray &) |
virtual bool | hasVisualizationModeWithContinuousUpdate () const |
virtual void | releaseCachedResources () |
void | clearChangedFlag () |
QByteArray * | currentUniformData () const |
QRhiResourceUpdateBatch * | currentResourceUpdateBatch () const |
QRhi * | currentRhi () const |
void | setRenderTarget (const QSGRenderTarget &rt) |
const QSGRenderTarget & | renderTarget () const |
void | setRenderPassRecordingCallbacks (QSGRenderContext::RenderPassCallback start, QSGRenderContext::RenderPassCallback end, void *userData) |
Public Member Functions inherited from QSGAbstractRenderer | |
~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 | setProjectionMatrixToRect (const QRectF &rect, MatrixTransformFlags flags, bool nativeNDCFlipY) |
Convenience method that calls setProjectionMatrix() with an orthographic matrix generated from rect. | |
void | setProjectionMatrix (const QMatrix4x4 &matrix, int index=0) |
Use matrix to project the QSGNode coordinates onto surface pixels. | |
void | setProjectionMatrixWithNativeNDC (const QMatrix4x4 &matrix, int index=0) |
QMatrix4x4 | projectionMatrix (int index) const |
Returns the projection matrix. | |
QMatrix4x4 | projectionMatrixWithNativeNDC (int index) const |
int | projectionMatrixCount () const |
int | projectionMatrixWithNativeNDCCount () const |
void | setClearColor (const QColor &color) |
Sets the color to clear the framebuffer. | |
QColor | clearColor () const |
Returns the color that clears the framebuffer at the beginning of the rendering. | |
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. | |
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 . | |
Protected Member Functions | |
virtual void | render ()=0 |
virtual void | prepareInline () |
virtual void | renderInline () |
virtual void | preprocess () |
void | addNodesToPreprocess (QSGNode *node) |
void | removeNodesToPreprocess (QSGNode *node) |
Protected Member Functions inherited from QSGAbstractRenderer | |
QSGAbstractRenderer (QObject *parent=nullptr) | |
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 | ||
QVarLengthArray< QMatrix4x4, 1 > | m_current_projection_matrix | |
QVarLengthArray< QMatrix4x4, 1 > | m_current_projection_matrix_native_ndc | |
QMatrix4x4 | m_current_model_view_matrix | |
qreal | m_current_opacity | |
qreal | m_current_determinant | |
qreal | m_device_pixel_ratio | |
QSGRenderContext * | m_context | |
QByteArray * | m_current_uniform_data | |
QRhiResourceUpdateBatch * | m_current_resource_update_batch | |
QRhi * | m_rhi | |
QSGRenderTarget | m_rt | |
struct { | ||
QSGRenderContext::RenderPassCallback start = nullptr | ||
QSGRenderContext::RenderPassCallback end = nullptr | ||
void * userData = nullptr | ||
} | m_renderPassRecordingCallbacks | |
Protected Attributes inherited from QObject | ||
QScopedPointer< QObjectData > | d_ptr | |
Additional Inherited Members | |
Public Types inherited from QSGAbstractRenderer | |
enum | MatrixTransformFlag { MatrixTransformFlipY = 0x01 } |
Used with setProjectionMatrixToRect() to indicate the expectations towards the generated projection matrix. More... | |
Public Slots inherited from QObject | |
void | deleteLater () |
\threadsafe | |
Signals inherited from QSGAbstractRenderer | |
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. | |
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) |
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) | |
The renderer class is the abstract baseclass used for rendering the QML scene graph.
The renderer is not tied to any particular surface. It expects a context to be current and will render into that surface according to how the device rect, viewport rect and projection transformation are set up.
Rendering is a sequence of steps initiated by calling renderScene(). This will effectively draw the scene graph starting at the root node. The QSGNode::preprocess() function will be called for all the nodes in the graph, followed by an update pass which updates all matrices, opacity, clip states and similar in the graph. Because the update pass is called after preprocess, it is safe to modify the graph during preprocess. To run a custom update pass over the graph, install a custom QSGNodeUpdater using setNodeUpdater(). Once all the graphs dirty states are updated, the virtual render() function is called.
The render() function is implemented by QSGRenderer subclasses to render the graph in the most optimal way for a given hardware.
The renderer can make use of stencil, depth and color buffers in addition to the scissor rect.
Definition at line 60 of file qsgrenderer_p.h.
QSGRenderer::QSGRenderer | ( | QSGRenderContext * | context | ) |
Definition at line 61 of file qsgrenderer.cpp.
References m_current_projection_matrix, m_current_projection_matrix_native_ndc, and QVarLengthArray< T, Prealloc >::resize().
|
virtual |
Definition at line 79 of file qsgrenderer.cpp.
References QSGAbstractRenderer::setRootNode().
Definition at line 265 of file qsgrenderer.cpp.
References addNodesToPreprocess(), QSGNode::firstChild(), QSGNode::flags(), QSet< T >::insert(), and QSGNode::UsePreprocess.
Referenced by addNodesToPreprocess(), and nodeChanged().
|
inline |
Definition at line 90 of file qsgrenderer_p.h.
Referenced by QSGSoftwareRenderThread::sync().
|
inline |
Definition at line 75 of file qsgrenderer_p.h.
Referenced by QSGSoftwareRenderer::render(), and QSGSoftwarePixmapRenderer::render().
|
inline |
Definition at line 69 of file qsgrenderer_p.h.
|
inline |
Definition at line 68 of file qsgrenderer_p.h.
|
inline |
Definition at line 70 of file qsgrenderer_p.h.
|
inline |
Definition at line 67 of file qsgrenderer_p.h.
|
inline |
Definition at line 94 of file qsgrenderer_p.h.
|
inline |
Definition at line 95 of file qsgrenderer_p.h.
|
inline |
Definition at line 93 of file qsgrenderer_p.h.
|
inline |
Definition at line 71 of file qsgrenderer_p.h.
|
inline |
Definition at line 74 of file qsgrenderer_p.h.
Referenced by QSGAbstractSoftwareRenderer::setBackgroundRect().
|
inlinevirtual |
Reimplemented in QSGBatchRenderer::Renderer.
Definition at line 87 of file qsgrenderer_p.h.
bool QSGRenderer::isMirrored | ( | ) | const |
Definition at line 113 of file qsgrenderer.cpp.
References QSGAbstractRenderer::projectionMatrix().
Updates internal data structures and emits the sceneGraphChanged() signal.
If flags contains the QSGNode::DirtyNodeRemoved flag, the node might be in the process of being destroyed. It is then not safe to downcast the node pointer.
Implements QSGAbstractRenderer.
Reimplemented in QSGBatchRenderer::Renderer.
Definition at line 194 of file qsgrenderer.cpp.
References addNodesToPreprocess(), QSGNode::DirtyNodeAdded, QSGNode::DirtyNodeRemoved, QSGNode::DirtyUsePreprocess, emit, QSGNode::flags(), QSet< T >::insert(), QSet< T >::remove(), removeNodesToPreprocess(), QSGAbstractRenderer::sceneGraphChanged(), state, and QSGNode::UsePreprocess.
Referenced by QSGOpenVGRenderer::nodeChanged(), QSGAbstractSoftwareRenderer::nodeChanged(), QSGBatchRenderer::Renderer::nodeChanged(), and QQuick3DItem2D::updateSpatialNode().
QSGNodeUpdater * QSGRenderer::nodeUpdater | ( | ) | const |
Returns the node updater that this renderer uses to update states in the scene graph.
If no updater is specified a default one is constructed.
Definition at line 92 of file qsgrenderer.cpp.
Referenced by QSGBatchRenderer::Renderer::nodeChanged(), and preprocess().
|
protectedvirtual |
Reimplemented in QSGBatchRenderer::Renderer.
Definition at line 286 of file qsgrenderer.cpp.
Referenced by prepareSceneInline().
|
overridevirtual |
Reimplemented from QSGAbstractRenderer.
Definition at line 163 of file qsgrenderer.cpp.
References prepareInline(), preprocess(), Q_ASSERT, and QSGAbstractRenderer::rootNode().
|
protectedvirtual |
Definition at line 214 of file qsgrenderer.cpp.
References QSet< T >::clear(), QList< T >::constBegin(), QList< T >::constEnd(), QSet< T >::contains(), frameTimer, QSGNodeUpdater::isNodeBlocked(), it, items, m_context, nodeUpdater(), QSGRenderContext::preprocess(), preprocessTime, Q_ASSERT, Q_QUICK_SG_PROFILE_RECORD, Q_TRACE, QSGAbstractRenderer::rootNode(), updatePassTime, and QSGNodeUpdater::updateStates().
Referenced by prepareSceneInline(), and renderScene().
|
inlinevirtual |
Reimplemented in QSGBatchRenderer::Renderer.
Definition at line 88 of file qsgrenderer_p.h.
Definition at line 273 of file qsgrenderer.cpp.
References QSGNode::firstChild(), QSGNode::flags(), QSet< T >::insert(), QSet< T >::remove(), removeNodesToPreprocess(), and QSGNode::UsePreprocess.
Referenced by nodeChanged(), and removeNodesToPreprocess().
|
protectedpure virtual |
Implemented in QSGOpenVGRenderer, QSGSoftwarePixmapRenderer, QSGSoftwareRenderer, and QSGBatchRenderer::Renderer.
Referenced by renderScene().
|
protectedvirtual |
Reimplemented in QSGBatchRenderer::Renderer.
Definition at line 290 of file qsgrenderer.cpp.
Referenced by renderSceneInline().
|
overridevirtual |
Renders the scene.
Implements QSGAbstractRenderer.
Reimplemented in QSGSoftwarePixmapRenderer, and QSGSoftwareRenderer.
Definition at line 120 of file qsgrenderer.cpp.
References frameTimer, preprocess(), preprocessTime, Q_QUICK_SG_PROFILE_END, Q_QUICK_SG_PROFILE_RECORD, Q_QUICK_SG_PROFILE_START, Q_TRACE, Q_TRACE_SCOPE, qCDebug, render(), QSGAbstractRenderer::rootNode(), and updatePassTime.
Referenced by QSGSoftwarePixmapRenderer::renderScene(), and QSGSoftwareRenderer::renderScene().
|
overridevirtual |
Reimplemented from QSGAbstractRenderer.
Definition at line 176 of file qsgrenderer.cpp.
References Q_ASSERT, and renderInline().
Referenced by Item2DPass::renderPass().
|
inline |
Definition at line 98 of file qsgrenderer_p.h.
Referenced by QSGBatchRenderer::Renderer::beginRenderPass(), QSGBatchRenderer::Renderer::endRenderPass(), QSGBatchRenderer::Renderer::prepareRenderPass(), QSGBatchRenderer::RhiVisualizer::prepareVisualize(), QSGBatchRenderer::Renderer::recordRenderPass(), QSGBatchRenderer::Renderer::render(), and QSGBatchRenderer::RhiVisualizer::visualize().
Definition at line 73 of file qsgrenderer_p.h.
void QSGRenderer::setNodeUpdater | ( | QSGNodeUpdater * | updater | ) |
Sets the node updater that this renderer uses to update states in the scene graph.
This will delete and override any existing node updater
Definition at line 106 of file qsgrenderer.cpp.
Referenced by QSGBatchRenderer::Renderer::Renderer().
|
inline |
Definition at line 100 of file qsgrenderer_p.h.
|
inline |
Definition at line 97 of file qsgrenderer_p.h.
|
inlinevirtual |
Reimplemented in QSGBatchRenderer::Renderer.
Definition at line 86 of file qsgrenderer_p.h.
|
inline |
Definition at line 150 of file qsgrenderer_p.h.
QSGRenderContext::RenderPassCallback QSGRenderer::end = nullptr |
Definition at line 135 of file qsgrenderer_p.h.
|
protected |
Definition at line 127 of file qsgrenderer_p.h.
Referenced by preprocess().
|
protected |
Definition at line 124 of file qsgrenderer_p.h.
|
protected |
Definition at line 122 of file qsgrenderer_p.h.
|
protected |
Definition at line 123 of file qsgrenderer_p.h.
Referenced by QSGBatchRenderer::Renderer::prepareRenderPass().
|
protected |
Definition at line 120 of file qsgrenderer_p.h.
Referenced by QSGRenderer().
|
protected |
Definition at line 121 of file qsgrenderer_p.h.
Referenced by QSGRenderer().
|
protected |
Definition at line 130 of file qsgrenderer_p.h.
|
protected |
Definition at line 129 of file qsgrenderer_p.h.
|
protected |
Definition at line 125 of file qsgrenderer_p.h.
struct { ... } QSGRenderer::m_renderPassRecordingCallbacks |
|
protected |
Definition at line 131 of file qsgrenderer_p.h.
Referenced by QSGBatchRenderer::Renderer::Renderer(), QSGBatchRenderer::Renderer::~Renderer(), QSGBatchRenderer::Renderer::prepareRenderPass(), QSGBatchRenderer::RhiVisualizer::prepareVisualize(), and QSGBatchRenderer::Renderer::releaseCachedResources().
|
protected |
Definition at line 132 of file qsgrenderer_p.h.
Referenced by QSGSoftwareRenderer::render().
QSGRenderContext::RenderPassCallback QSGRenderer::start = nullptr |
Definition at line 134 of file qsgrenderer_p.h.
Definition at line 136 of file qsgrenderer_p.h.