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

The QSGRootNode is the toplevel root of any scene graph. More...

#include <qsgnode.h>

+ Inheritance diagram for QSGRootNode:
+ Collaboration diagram for QSGRootNode:

Public Member Functions

 QSGRootNode ()
 Creates a new root node.
 
 ~QSGRootNode () override
 Deletes the root node.
 
- 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.
 
virtual void preprocess ()
 Override this function to do processing on the node before it is rendered.
 

Friends

class QSGAbstractRenderer
 
class QSGNode
 
class QSGGeometryNode
 

Additional Inherited Members

- 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...
 
- 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 QSGNode
QScopedPointer< QSGNodePrivated_ptr
 

Detailed Description

The QSGRootNode is the toplevel root of any scene graph.

The root node is used to attach a scene graph to a renderer.

Definition at line 258 of file qsgnode.h.

Constructor & Destructor Documentation

◆ QSGRootNode()

QSGRootNode::QSGRootNode ( )

Creates a new root node.

Definition at line 1212 of file qsgnode.cpp.

◆ ~QSGRootNode()

QSGRootNode::~QSGRootNode ( )
override

Deletes the root node.

When a root node is deleted it removes itself from all of renderers that are referencing it.

Definition at line 1225 of file qsgnode.cpp.

References QList< T >::constLast(), QList< T >::isEmpty(), and QSGAbstractRenderer::setRootNode().

+ Here is the call graph for this function:

Friends And Related Symbol Documentation

◆ QSGAbstractRenderer

friend class QSGAbstractRenderer
friend

Definition at line 267 of file qsgnode.h.

◆ QSGGeometryNode

friend class QSGGeometryNode
friend

Definition at line 269 of file qsgnode.h.

◆ QSGNode

friend class QSGNode
friend

Definition at line 268 of file qsgnode.h.


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