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
QSGBatchRenderer::Renderer Class Reference

#include <qsgbatchrenderer_p.h>

+ Inheritance diagram for QSGBatchRenderer::Renderer:
+ Collaboration diagram for QSGBatchRenderer::Renderer:

Classes

struct  PreparedRenderBatch
 
struct  RenderPassContext
 

Public Member Functions

 Renderer (QSGDefaultRenderContext *ctx, QSGRendererInterface::RenderMode renderMode=QSGRendererInterface::RenderMode2D)
 
 ~Renderer ()
 
- Public Member Functions inherited from QSGRenderer
 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
 
QSGRenderContextcontext () const
 
bool isMirrored () const
 
void renderScene () override
 Renders the scene.
 
void prepareSceneInline () override
 
void renderSceneInline () override
 
QSGNodeUpdaternodeUpdater () 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
 
void clearChangedFlag ()
 
QByteArraycurrentUniformData () const
 
QRhiResourceUpdateBatchcurrentResourceUpdateBatch () const
 
QRhicurrentRhi () const
 
void setRenderTarget (const QSGRenderTarget &rt)
 
const QSGRenderTargetrenderTarget () 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.
 
QSGRootNoderootNode () 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< 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.
 

Protected Member Functions

void nodeChanged (QSGNode *node, QSGNode::DirtyState state) override
 Updates internal data structures and emits the sceneGraphChanged() signal.
 
void render () override
 
void prepareInline () override
 
void renderInline () override
 
void releaseCachedResources () override
 
void prepareRenderPass (RenderPassContext *ctx)
 
void beginRenderPass (RenderPassContext *ctx)
 
void recordRenderPass (RenderPassContext *ctx)
 
void endRenderPass (RenderPassContext *ctx)
 
- Protected Member Functions inherited from QSGRenderer
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
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)
 

Private Member Functions

void setVisualizationMode (const QByteArray &mode) override
 
bool hasVisualizationModeWithContinuousUpdate () const override
 

Friends

class Updater
 
class RhiVisualizer
 

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)
 
- Protected Attributes inherited from QSGRenderer
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
 
QSGRenderContextm_context
 
QByteArraym_current_uniform_data
 
QRhiResourceUpdateBatchm_current_resource_update_batch
 
QRhim_rhi
 
QSGRenderTarget m_rt
 
struct { 
 
   QSGRenderContext::RenderPassCallback   start = nullptr 
 
   QSGRenderContext::RenderPassCallback   end = nullptr 
 
   void *   userData = nullptr 
 
m_renderPassRecordingCallbacks 
 
- Protected Attributes inherited from QObject
QScopedPointer< QObjectDatad_ptr
 
- Properties inherited from QObject
QString objectName
 the name of this object
 

Detailed Description

Definition at line 743 of file qsgbatchrenderer_p.h.

Constructor & Destructor Documentation

◆ Renderer()

◆ ~Renderer()

QSGBatchRenderer::Renderer::~Renderer ( )

Definition at line 921 of file qsgbatchrenderer.cpp.

References QDataBuffer< Type >::at(), QSGNode::GeometryNodeType, i, QSGRenderer::m_rhi, QSGBatchRenderer::qsg_wipeBatch(), QSGBatchRenderer::Element::removed, and QDataBuffer< Type >::size().

+ Here is the call graph for this function:

Member Function Documentation

◆ beginRenderPass()

void QSGBatchRenderer::Renderer::beginRenderPass ( RenderPassContext * ctx)
protected

Definition at line 3877 of file qsgbatchrenderer.cpp.

References QRhiCommandBuffer::beginPass(), QSGRenderTarget::cb, QSGBatchRenderer::RenderPassState::clearColor, QSGBatchRenderer::RenderPassState::dsClear, QRhiCommandBuffer::ExternalContent, QSGRenderer::m_renderPassRecordingCallbacks, QSGRenderer::renderTarget(), and QSGRenderTarget::rt.

Referenced by render().

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

◆ endRenderPass()

void QSGBatchRenderer::Renderer::endRenderPass ( RenderPassContext * ctx)
protected

Definition at line 3970 of file qsgbatchrenderer.cpp.

References QSGRenderTarget::cb, QRhiCommandBuffer::endPass(), QSGRenderer::m_renderPassRecordingCallbacks, QSGBatchRenderer::Visualizer::mode(), QSGRenderer::renderTarget(), QSGBatchRenderer::Visualizer::visualize(), and QSGBatchRenderer::Visualizer::VisualizeNothing.

Referenced by render().

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

◆ hasVisualizationModeWithContinuousUpdate()

bool QSGBatchRenderer::Renderer::hasVisualizationModeWithContinuousUpdate ( ) const
overrideprivatevirtual

Reimplemented from QSGRenderer.

Definition at line 4129 of file qsgbatchrenderer.cpp.

References QSGBatchRenderer::Visualizer::mode(), and QSGBatchRenderer::Visualizer::VisualizeOverdraw.

+ Here is the call graph for this function:

◆ nodeChanged()

void QSGBatchRenderer::Renderer::nodeChanged ( QSGNode * node,
QSGNode::DirtyState state )
overrideprotectedvirtual

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.

Reimplemented from QSGRenderer.

Definition at line 1318 of file qsgbatchrenderer.cpp.

References QSGBatchRenderer::Element::batch, QSGBatchRenderer::BatchBreaksOnCompare, QSGBatchRenderer::Element::boundsComputed, debug, QSGNode::DirtyForceUpdate, QSGNode::DirtyGeometry, QSGNode::DirtyMaterial, QSGNode::DirtyMatrix, QSGNode::DirtyNodeAdded, QSGNode::DirtyNodeRemoved, QSGNode::DirtyOpacity, QSGBatchRenderer::Node::dirtyState, QSGNode::DirtySubtreeBlocked, QSGNode::GeometryNodeType, QSGBatchRenderer::Batch::geometryWasChanged(), QSGBatchRenderer::hasMaterialWithBlending(), QSGBatchRenderer::Element::isMaterialBlended, QSGBatchRenderer::Batch::isMaterialCompatible(), QSGBatchRenderer::Batch::isOpaque, QSGNode::isSubtreeBlocked(), nodeChanged(), QSGRenderer::nodeChanged(), QSGRenderer::nodeUpdater(), QObject::parent(), QSGBatchRenderer::Node::parent(), QSGNode::parent(), Q_ASSERT, Q_UNLIKELY, qDebug, QSGAbstractRenderer::rootNode(), state, QSGNode::TransformNodeType, and QSGNode::type().

Referenced by nodeChanged().

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

◆ prepareInline()

void QSGBatchRenderer::Renderer::prepareInline ( )
overrideprotectedvirtual

Reimplemented from QSGRenderer.

Definition at line 3625 of file qsgbatchrenderer.cpp.

References prepareRenderPass().

+ Here is the call graph for this function:

◆ prepareRenderPass()

void QSGBatchRenderer::Renderer::prepareRenderPass ( RenderPassContext * ctx)
protected

Definition at line 3635 of file qsgbatchrenderer.cpp.

References QRhiGraphicsPipeline::A, QRhiGraphicsPipeline::B, QSGBatchRenderer::Element::batch, QSGBatchRenderer::GraphicsState::blending, QRect::bottom(), QSGRenderTarget::cb, QSGAbstractRenderer::clearColor(), QSGBatchRenderer::RenderPassState::clearColor, QSGBatchRenderer::GraphicsState::colorWrite, QSGBatchRenderer::GraphicsState::cullMode, QSGBatchRenderer::GraphicsState::depthFunc, QSGBatchRenderer::GraphicsState::depthTest, QSGBatchRenderer::GraphicsState::depthWrite, QSGAbstractRenderer::deviceRect(), QSGBatchRenderer::RenderPassState::dsClear, QSGNodeDumper::dump(), Qt::endl(), QRhiGraphicsPipeline::Fill, QRhiGraphicsPipeline::G, i, QRhiGraphicsPipeline::Less, QSGRenderer::m_current_opacity, QSGRenderer::m_rhi, QSGBatchRenderer::Visualizer::mode(), QSGBatchRenderer::GraphicsState::multiViewCount, QSGRenderTarget::multiViewCount, QRhi::nextResourceUpdateBatch(), QSGBatchRenderer::Element::node, QRhiGraphicsPipeline::None, ok, QSGBatchRenderer::Element::order, QSGBatchRenderer::GraphicsState::polygonMode, QSGBatchRenderer::Visualizer::prepareVisualize(), Q_ASSERT, Q_LIKELY, Q_UNLIKELY, qDebug, QSGBatchRenderer::qsg_countNodesInBatches(), QSGBatchRenderer::qsg_sort_batch_decreasing_order(), QSGBatchRenderer::qsg_sort_batch_increasing_order(), qWarning, QRhiGraphicsPipeline::R, QSGRendererInterface::RenderMode3D, QSGRenderer::renderTarget(), QDataBuffer< Type >::reset(), QSGBatchRenderer::ClipState::reset(), QRhiCommandBuffer::resourceUpdate(), QSGAbstractRenderer::rootNode(), QSGRenderTarget::rt, QRhiRenderTarget::sampleCount(), QSGBatchRenderer::GraphicsState::sampleCount, QSGBatchRenderer::RenderPassState::scissorSet, QSGBatchRenderer::GraphicsState::stencilTest, QSGBatchRenderer::GraphicsState::usesScissor, viewport(), QSGBatchRenderer::RenderPassState::viewport, QSGBatchRenderer::VIEWPORT_MAX_DEPTH, QSGBatchRenderer::VIEWPORT_MIN_DEPTH, QSGAbstractRenderer::viewportRect(), QSGBatchRenderer::RenderPassState::viewportSet, and QSGBatchRenderer::Visualizer::VisualizeNothing.

Referenced by prepareInline(), and render().

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

◆ recordRenderPass()

void QSGBatchRenderer::Renderer::recordRenderPass ( RenderPassContext * ctx)
protected

Definition at line 3893 of file qsgbatchrenderer.cpp.

References cb, QSGRenderTarget::cb, i, Q_UNLIKELY, QByteArrayLiteral, qDebug, qWarning, QSGRendererInterface::RenderMode3D, and QSGRenderer::renderTarget().

Referenced by render(), and renderInline().

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

◆ releaseCachedResources()

void QSGBatchRenderer::Renderer::releaseCachedResources ( )
overrideprotectedvirtual

Reimplemented from QSGRenderer.

Definition at line 969 of file qsgbatchrenderer.cpp.

References QDataBuffer< Type >::at(), QHash< Key, T >::clear(), i, QSGBatchRenderer::ShaderManager::invalidated(), QSGRenderer::m_rhi, QRhi::releaseCachedResources(), QDataBuffer< Type >::reset(), QDataBuffer< Type >::shrink(), and QDataBuffer< Type >::size().

+ Here is the call graph for this function:

◆ render()

void QSGBatchRenderer::Renderer::render ( )
overrideprotectedvirtual

Implements QSGRenderer.

Definition at line 3606 of file qsgbatchrenderer.cpp.

References beginRenderPass(), endRenderPass(), prepareRenderPass(), recordRenderPass(), and QSGRenderer::renderTarget().

+ Here is the call graph for this function:

◆ renderInline()

void QSGBatchRenderer::Renderer::renderInline ( )
overrideprotectedvirtual

Reimplemented from QSGRenderer.

Definition at line 3630 of file qsgbatchrenderer.cpp.

References recordRenderPass().

+ Here is the call graph for this function:

◆ setVisualizationMode()

void QSGBatchRenderer::Renderer::setVisualizationMode ( const QByteArray & mode)
overrideprivatevirtual

Reimplemented from QSGRenderer.

Definition at line 4115 of file qsgbatchrenderer.cpp.

References QSGBatchRenderer::Visualizer::setMode(), QSGBatchRenderer::Visualizer::VisualizeBatches, QSGBatchRenderer::Visualizer::VisualizeChanges, QSGBatchRenderer::Visualizer::VisualizeClipping, QSGBatchRenderer::Visualizer::VisualizeNothing, and QSGBatchRenderer::Visualizer::VisualizeOverdraw.

+ Here is the call graph for this function:

Friends And Related Symbol Documentation

◆ RhiVisualizer

friend class RhiVisualizer
friend

Definition at line 794 of file qsgbatchrenderer_p.h.

Referenced by Renderer().

◆ Updater

friend class Updater
friend

Definition at line 793 of file qsgbatchrenderer_p.h.

Referenced by Renderer().


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