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
QSGRhiShaderEffectNode Class Reference

#include <qsgrhishadereffectnode_p.h>

+ Inheritance diagram for QSGRhiShaderEffectNode:
+ Collaboration diagram for QSGRhiShaderEffectNode:

Public Member Functions

 QSGRhiShaderEffectNode (QSGDefaultRenderContext *rc)
 
QRectF updateNormalizedTextureSubRect (bool supportsAtlasTextures) override
 
void syncMaterial (SyncData *syncData) override
 
void preprocess () override
 Override this function to do processing on the node before it is rendered.
 
- Public Member Functions inherited from QSGShaderEffectNode
 ~QSGShaderEffectNode () override
 
void accept (QSGNodeVisitorEx *visitor) override
 
- 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.
 
- Public Member Functions inherited from QSGVisitableNode
 QSGVisitableNode ()
 
 ~QSGVisitableNode () override
 
- Public Member Functions inherited from QSGGeometryNode
 QSGGeometryNode ()
 Creates a new geometry node without geometry and material.
 
 ~QSGGeometryNode () override
 Deletes this geometry node.
 
void setMaterial (QSGMaterial *material)
 Sets the material of this geometry node to material.
 
QSGMaterialmaterial () const
 Returns the material of the QSGGeometryNode.
 
void setOpaqueMaterial (QSGMaterial *material)
 Sets the opaque material of this geometry to material.
 
QSGMaterialopaqueMaterial () const
 Returns the opaque material of the QSGGeometryNode.
 
QSGMaterialactiveMaterial () const
 Returns the material which should currently be used for geometry node.
 
void setRenderOrder (int order)
 Sets the render order of this node to be order.
 
int renderOrder () const
 Returns the render order of this geometry node.
 
void setInheritedOpacity (qreal opacity)
 Sets the inherited opacity of this geometry to opacity.
 
qreal inheritedOpacity () const
 Set during rendering to specify the inherited opacity for that rendering pass.
 
- Public Member Functions inherited from QSGBasicGeometryNode
 ~QSGBasicGeometryNode () override
 Deletes this QSGBasicGeometryNode.
 
void setGeometry (QSGGeometry *geometry)
 Sets the geometry of this node to geometry.
 
const QSGGeometrygeometry () const
 Returns this node's geometry.
 
QSGGeometrygeometry ()
 Returns this node's geometry.
 
const QMatrix4x4matrix () const
 Will be set during rendering to contain transformation of the geometry for that rendering pass.
 
const QSGClipNodeclipList () const
 Will be set during rendering to contain the clip of the geometry for that rendering pass.
 
void setRendererMatrix (const QMatrix4x4 *m)
 
void setRendererClipList (const QSGClipNode *c)
 
- Public Member Functions inherited from QSGNode
 QSGNode ()
 Constructs a new node.
 
virtual ~QSGNode ()
 Destroys the node.
 
QSGNodeparent () const
 Returns the parent node of this node.
 
void removeChildNode (QSGNode *node)
 Removes node from this node's list of children.
 
void removeAllChildNodes ()
 Removes all child nodes from this node's list of children.
 
void prependChildNode (QSGNode *node)
 Prepends node to this node's the list of children.
 
void appendChildNode (QSGNode *node)
 Appends node to this node's list of children.
 
void insertChildNodeBefore (QSGNode *node, QSGNode *before)
 Inserts node to this node's list of children before the node specified with before.
 
void insertChildNodeAfter (QSGNode *node, QSGNode *after)
 Inserts node to this node's list of children after the node specified with after.
 
void reparentChildNodesTo (QSGNode *newParent)
 
int childCount () const
 Returns the number of child nodes.
 
QSGNodechildAtIndex (int i) const
 Returns the child at index i.
 
QSGNodefirstChild () const
 Returns the first child of this node.
 
QSGNodelastChild () const
 Returns the last child of this node.
 
QSGNodenextSibling () const
 Returns the node after this in the parent's list of children.
 
QSGNodepreviousSibling () const
 Returns the node before this in the parent's list of children.
 
NodeType type () const
 Returns the type of this node.
 
QT_DEPRECATED void clearDirty ()
 
void markDirty (DirtyState bits)
 Notifies all connected renderers that the node has dirty bits.
 
QT_DEPRECATED DirtyState dirtyState () const
 
virtual bool isSubtreeBlocked () const
 Returns whether this node and its subtree is available for use.
 
Flags flags () const
 Returns the set of flags for this node.
 
void setFlag (Flag, bool=true)
 Sets the flag f on this node if enabled is true; otherwise clears the flag.
 
void setFlags (Flags, bool=true)
 Sets the flags f on this node if enabled is true; otherwise clears the flags.
 

Static Public Member Functions

static void resetMaterialTypeCache (void *materialTypeCacheKey)
 
static void garbageCollectMaterialTypeCache (void *materialTypeCacheKey)
 
- 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)
 

Additional Inherited Members

- Public Types inherited from QSGShaderEffectNode
enum  DirtyShaderFlag {
  DirtyShaders = 0x01 , DirtyShaderConstant = 0x02 , DirtyShaderTexture = 0x04 , DirtyShaderGeometry = 0x08 ,
  DirtyShaderMesh = 0x10 , DirtyShaderAll = 0xFF
}
 
enum  CullMode { NoCulling , BackFaceCulling , FrontFaceCulling }
 
- Public Types inherited from QSGNode
enum  NodeType {
  BasicNodeType , GeometryNodeType , TransformNodeType , ClipNodeType ,
  OpacityNodeType , RootNodeType , RenderNodeType
}
 Can be used to figure out the type of node. More...
 
enum  Flag {
  OwnedByParent = 0x0001 , UsePreprocess = 0x0002 , OwnsGeometry = 0x00010000 , OwnsMaterial = 0x00020000 ,
  OwnsOpaqueMaterial = 0x00040000 , IsVisitableNode = 0x01000000
}
 The QSGNode::Flag enum describes flags on the QSGNode. More...
 
enum  DirtyStateBit {
  DirtySubtreeBlocked = 0x0080 , DirtyMatrix = 0x0100 , DirtyNodeAdded = 0x0400 , DirtyNodeRemoved = 0x0800 ,
  DirtyGeometry = 0x1000 , DirtyMaterial = 0x2000 , DirtyOpacity = 0x4000 , DirtyForceUpdate = 0x8000 ,
  DirtyUsePreprocess = UsePreprocess , DirtyPropagationMask
}
 Used in QSGNode::markDirty() to indicate how the scene graph has changed. More...
 
- Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
 
- Signals inherited from QSGShaderEffectNode
void textureChanged ()
 
- 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.
 
- 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)
 
- Protected Member Functions inherited from QSGGeometryNode
 QSGGeometryNode (QSGGeometryNodePrivate &dd)
 
- Protected Member Functions inherited from QSGBasicGeometryNode
 QSGBasicGeometryNode (NodeType type)
 Creates a new basic geometry node of type type.
 
 QSGBasicGeometryNode (QSGBasicGeometryNodePrivate &dd, NodeType type)
 
- Protected Member Functions inherited from QSGNode
 QSGNode (NodeType type)
 Constructs a new node with the given node type.
 
 QSGNode (QSGNodePrivate &dd, NodeType type)
 Constructs a new node with the given node type.
 
- Protected Attributes inherited from QObject
QScopedPointer< QObjectDatad_ptr
 
- Protected Attributes inherited from QSGNode
QScopedPointer< QSGNodePrivated_ptr
 
- Properties inherited from QObject
QString objectName
 the name of this object
 

Detailed Description

Definition at line 91 of file qsgrhishadereffectnode_p.h.

Constructor & Destructor Documentation

◆ QSGRhiShaderEffectNode()

QSGRhiShaderEffectNode::QSGRhiShaderEffectNode ( QSGDefaultRenderContext * rc)

Definition at line 644 of file qsgrhishadereffectnode.cpp.

References Q_UNUSED, QSGNode::setFlag(), QSGGeometryNode::setMaterial(), and QSGNode::UsePreprocess.

+ Here is the call graph for this function:

Member Function Documentation

◆ garbageCollectMaterialTypeCache()

void QSGRhiShaderEffectNode::garbageCollectMaterialTypeCache ( void * materialTypeCacheKey)
static

Definition at line 244 of file qsgrhishadereffectnode.cpp.

References lock, shaderMaterialTypeCache, and shaderMaterialTypeCacheMutex.

Referenced by QSGRenderThread::event(), and QSGGuiThreadRenderLoop::releaseResources().

+ Here is the caller graph for this function:

◆ preprocess()

void QSGRhiShaderEffectNode::preprocess ( )
overridevirtual

Override this function to do processing on the node before it is rendered.

Preprocessing needs to be explicitly enabled by setting the flag QSGNode::UsePreprocess. The flag needs to be set before the node is added to the scene graph and will cause the preprocess() function to be called for every frame the node is rendered.

Warning
Beware of deleting nodes while they are being preprocessed. It is possible, with a small performance hit, to delete a single node during its own preprocess call. Deleting a subtree which has nodes that also use preprocessing may result in a segmentation fault. This is done for performance reasons.

Reimplemented from QSGNode.

Definition at line 895 of file qsgrhishadereffectnode.cpp.

References QSGRhiShaderEffectMaterial::m_textureProviders.

◆ resetMaterialTypeCache()

void QSGRhiShaderEffectNode::resetMaterialTypeCache ( void * materialTypeCacheKey)
static

Definition at line 238 of file qsgrhishadereffectnode.cpp.

References lock, shaderMaterialTypeCache, and shaderMaterialTypeCacheMutex.

Referenced by QSGRenderThread::invalidateGraphics(), QQuickRenderControlPrivate::windowDestroyed(), and QSGGuiThreadRenderLoop::windowDestroyed().

+ Here is the caller graph for this function:

◆ syncMaterial()

void QSGRhiShaderEffectNode::syncMaterial ( SyncData * syncData)
overridevirtual

Implements QSGShaderEffectNode.

Definition at line 716 of file qsgrhishadereffectnode.cpp.

References QSGMaterial::Blending, QSGRhiShaderEffectDefaultShader::create(), QSGNode::DirtyMaterial, QSGShaderEffectNode::DirtyShaderConstant, QSGShaderEffectNode::DirtyShaders, QSGShaderEffectNode::DirtyShaderTexture, QSGRhiShaderLinker::feedConstants(), QSGRhiShaderLinker::feedSamplers(), QSGMaterial::flags(), i, QSGRhiShaderLinker::linkTextureSubRects(), QSGRhiShaderEffectMaterial::m_cullMode, QSGRhiShaderEffectMaterial::m_fragmentShader, QSGRhiShaderEffectMaterial::m_hasCustomFragmentShader, QSGRhiShaderEffectMaterial::m_hasCustomVertexShader, QSGRhiShaderEffectMaterial::m_linker, QSGRhiShaderEffectMaterial::m_materialType, QSGRhiShaderEffectMaterial::m_materialTypeCacheKey, QSGRhiShaderEffectMaterial::m_vertexShader, QSGNode::markDirty(), QSGShaderEffectNode::VariableData::Matrix, QSGGuiThreadShaderEffectManager::ShaderInfo::Variable::name, QSGGuiThreadShaderEffectManager::ShaderInfo::name, QSGShaderEffectNode::VariableData::Opacity, QByteArrayLiteral, QStringLiteral, qWarning, QSGMaterial::RequiresFullMatrix, QSGRhiShaderLinker::reset(), QSGGuiThreadShaderEffectManager::ShaderInfo::Sampler, QSGMaterial::setFlag(), QShader::shader(), QSGShaderEffectNode::ShaderData::shaderInfo, shaderMaterialTypeCache, QSGShaderEffectNode::VariableData::Source, QSGShaderEffectNode::VariableData::specialType, QSGGuiThreadShaderEffectManager::ShaderInfo::TypeFragment, QSGGuiThreadShaderEffectManager::ShaderInfo::TypeVertex, and QSGRhiShaderEffectMaterial::updateTextureProviders().

+ Here is the call graph for this function:

◆ updateNormalizedTextureSubRect()

QRectF QSGRhiShaderEffectNode::updateNormalizedTextureSubRect ( bool supportsAtlasTextures)
overridevirtual

Implements QSGShaderEffectNode.

Definition at line 652 of file qsgrhishadereffectnode.cpp.

References QSGNode::DirtyMaterial, QSGRhiShaderEffectMaterial::m_geometryUsesTextureSubRect, QSGRhiShaderEffectMaterial::m_textureProviders, QSGNode::markDirty(), and QSGTextureProvider::texture().

+ Here is the call graph for this function:

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