The QSGSimpleTextureNode class is provided for convenience to easily draw textured content using the QML scene graph. More...

#include <qsgsimpletexturenode.h>

Inheritance diagram for QSGSimpleTextureNode:

Collaboration diagram for QSGSimpleTextureNode:

Public Types
enum	TextureCoordinatesTransformFlag { NoTransform = 0x00 , MirrorHorizontally = 0x01 , MirrorVertically = 0x02 }
	The TextureCoordinatesTransformFlag enum is used to specify the mode used to generate texture coordinates for a textured quad. More...

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 Member Functions
	QSGSimpleTextureNode ()
	Constructs a new simple texture node.

	~QSGSimpleTextureNode () override
	Destroys the texture node.

void	setRect (const QRectF &rect)
	Sets the target rect of this texture node to r.

void	setRect (qreal x, qreal y, qreal w, qreal h)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Sets the rectangle of this texture node to begin at (x, y) and have width w and height h.

QRectF	rect () const
	Returns the target rect of this texture node.

void	setSourceRect (const QRectF &r)
	Sets the source rect of this texture node to r.

void	setSourceRect (qreal x, qreal y, qreal w, qreal h)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

QRectF	sourceRect () const
	Returns the source rect of this texture node.

void	setTexture (QSGTexture *texture)
	Sets the texture of this texture node to texture.

QSGTexture *	texture () const
	Returns the texture for this texture node.

void	setFiltering (QSGTexture::Filtering filtering)
	Sets the filtering to be used for this texture node to filtering.

QSGTexture::Filtering	filtering () const
	Returns the filtering currently set on this texture node.

void	setTextureCoordinatesTransform (TextureCoordinatesTransformMode mode)
	Sets the method used to generate texture coordinates to mode.

TextureCoordinatesTransformMode	textureCoordinatesTransform () const
	Returns the mode used to generate texture coordinates for this node.

void	setOwnsTexture (bool owns)
	Sets whether the node takes ownership of the texture to owns.

bool	ownsTexture () const
	Returns `true` if the node takes ownership of the texture; otherwise returns `false`.

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.

QSGMaterial *	material () const
	Returns the material of the QSGGeometryNode.

void	setOpaqueMaterial (QSGMaterial *material)
	Sets the opaque material of this geometry to material.

QSGMaterial *	opaqueMaterial () const
	Returns the opaque material of the QSGGeometryNode.

QSGMaterial *	activeMaterial () 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 QSGGeometry *	geometry () const
	Returns this node's geometry.

QSGGeometry *	geometry ()
	Returns this node's geometry.

const QMatrix4x4 *	matrix () const
	Will be set during rendering to contain transformation of the geometry for that rendering pass.

const QSGClipNode *	clipList () 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.

QSGNode *	parent () 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.

QSGNode *	childAtIndex (int i) const
	Returns the child at index i.

QSGNode *	firstChild () const
	Returns the first child of this node.

QSGNode *	lastChild () const
	Returns the last child of this node.

QSGNode *	nextSibling () const
	Returns the node after this in the parent's list of children.

QSGNode *	previousSibling () 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.

Additional Inherited Members
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 QSGNode
QScopedPointer< QSGNodePrivate >	d_ptr

Detailed Description

The QSGSimpleTextureNode class is provided for convenience to easily draw textured content using the QML scene graph.

\inmodule QtQuick

Warning: The simple texture node class must have a texture before being added to the scene graph to be rendered.; This utility class is only functional when running with the default or software backends of the Qt Quick scenegraph. As an alternative, prefer using QSGImageNode via QQuickWindow::createImageNode(). However, this standalone class is still useful when used via subclassing and the application knows that no special scenegraph backends will be involved.

Definition at line 15 of file qsgsimpletexturenode.h.

Member Enumeration Documentation

◆ TextureCoordinatesTransformFlag

enum QSGSimpleTextureNode::TextureCoordinatesTransformFlag

The TextureCoordinatesTransformFlag enum is used to specify the mode used to generate texture coordinates for a textured quad.

\value NoTransform Texture coordinates are oriented with window coordinates i.e. with origin at top-left.

\value MirrorHorizontally Texture coordinates are inverted in the horizontal axis with respect to window coordinates

\value MirrorVertically Texture coordinates are inverted in the vertical axis with respect to window coordinates

Enumerator
NoTransform
MirrorHorizontally
MirrorVertically

Definition at line 35 of file qsgsimpletexturenode.h.

Constructor & Destructor Documentation

◆ QSGSimpleTextureNode()

QSGSimpleTextureNode::QSGSimpleTextureNode ( )

Constructs a new simple texture node.

Definition at line 74 of file qsgsimpletexturenode.cpp.

References QSGTexture::None, qsgnode_set_description(), QSGBasicGeometryNode::setGeometry(), QSGGeometryNode::setMaterial(), QSGOpaqueTextureMaterial::setMipmapFiltering(), and QSGGeometryNode::setOpaqueMaterial().

Here is the call graph for this function:

◆ ~QSGSimpleTextureNode()

QSGSimpleTextureNode::~QSGSimpleTextureNode ( )

override

Destroys the texture node.

Definition at line 91 of file qsgsimpletexturenode.cpp.

References d, and QSGOpaqueTextureMaterial::texture().

Here is the call graph for this function:

Member Function Documentation

◆ filtering()

QSGTexture::Filtering QSGSimpleTextureNode::filtering ( ) const

Returns the filtering currently set on this texture node.

Definition at line 118 of file qsgsimpletexturenode.cpp.

References QSGOpaqueTextureMaterial::filtering().

Referenced by setFiltering().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ownsTexture()

bool QSGSimpleTextureNode::ownsTexture ( ) const

Returns true if the node takes ownership of the texture; otherwise returns false.

Since: 5.4

Definition at line 293 of file qsgsimpletexturenode.cpp.

References d.

◆ rect()

QRectF QSGSimpleTextureNode::rect ( ) const

Returns the target rect of this texture node.

Definition at line 148 of file qsgsimpletexturenode.cpp.

Referenced by QSGSoftwareRenderableNode::renderNode(), and QSGSoftwareRenderableNode::update().

Here is the caller graph for this function:

◆ setFiltering()

void QSGSimpleTextureNode::setFiltering ( QSGTexture::Filtering filtering )

Sets the filtering to be used for this texture node to filtering.

For smooth scaling, use QSGTexture::Linear; for normal scaling, use QSGTexture::Nearest.

Definition at line 104 of file qsgsimpletexturenode.cpp.

References QSGNode::DirtyMaterial, filtering(), QSGOpaqueTextureMaterial::filtering(), QSGNode::markDirty(), and QSGOpaqueTextureMaterial::setFiltering().

Referenced by QSGMapboxGLTextureNode::QSGMapboxGLTextureNode(), and QWaylandQuickItem::updatePaintNode().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setOwnsTexture()

void QSGSimpleTextureNode::setOwnsTexture ( bool owns )

Sets whether the node takes ownership of the texture to owns.

By default, the node does not take ownership of the texture.

See also: setTexture()

Since: 5.4

Definition at line 282 of file qsgsimpletexturenode.cpp.

References d.

Referenced by QSGMapboxGLTextureNode::resize().

Here is the caller graph for this function:

◆ setRect() [1/2]

void QSGSimpleTextureNode::setRect ( const QRectF & rect )

Sets the target rect of this texture node to r.

Definition at line 127 of file qsgsimpletexturenode.cpp.

References d, QSGNode::DirtyGeometry, QSGNode::markDirty(), qsgsimpletexturenode_update(), and texture().

Referenced by QSGMapboxGLTextureNode::resize(), and QWaylandQuickItem::updatePaintNode().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setRect() [2/2]

void QSGSimpleTextureNode::setRect	(	qreal	x,
		qreal	y,
		qreal	w,
		qreal	h )

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 rectangle of this texture node to begin at (x, y) and have width w and height h.

Definition at line 22 of file qsgsimpletexturenode.h.

References setRect().

Referenced by setRect().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setSourceRect() [1/2]

void QSGSimpleTextureNode::setSourceRect ( const QRectF & r )

Sets the source rect of this texture node to r.

Since: 5.5

Definition at line 158 of file qsgsimpletexturenode.cpp.

References d, QSGNode::DirtyGeometry, QSGNode::markDirty(), qsgsimpletexturenode_update(), and texture().

Referenced by QWaylandQuickItem::updatePaintNode().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setSourceRect() [2/2]

void QSGSimpleTextureNode::setSourceRect	(	qreal	x,
		qreal	y,
		qreal	w,
		qreal	h )

inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Since: 5.5

Sets the rectangle of this texture node to show its texture from (x, y) and have width w and height h relatively to the QSGTexture::textureSize.

Definition at line 26 of file qsgsimpletexturenode.h.

References setSourceRect().

Referenced by setSourceRect().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setTexture()

void QSGSimpleTextureNode::setTexture ( QSGTexture * texture )

Sets the texture of this texture node to texture.

Use setOwnsTexture() to set whether the node should take ownership of the texture. By default, the node does not take ownership.

Warning: A texture node must have a texture before being added to the scenegraph to be rendered.

Definition at line 198 of file qsgsimpletexturenode.cpp.

References d, QSGNode::DirtyGeometry, QSGNode::DirtyMaterial, QSGNode::markDirty(), Q_ASSERT, qsgsimpletexturenode_update(), QSGOpaqueTextureMaterial::setTexture(), and QSGOpaqueTextureMaterial::texture().

Referenced by SGFramebufferObjectNode::render(), QSGMapboxGLTextureNode::resize(), QQuickRhiItemNode::sync(), and QWaylandQuickItem::updatePaintNode().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setTextureCoordinatesTransform()

void QSGSimpleTextureNode::setTextureCoordinatesTransform ( TextureCoordinatesTransformMode mode )

Sets the method used to generate texture coordinates to mode.

This can be used to obtain correct orientation of the texture. This is commonly needed when using a third party OpenGL library to render to texture as OpenGL has an inverted y-axis relative to Qt Quick.

See also: textureCoordinatesTransform()

Definition at line 252 of file qsgsimpletexturenode.cpp.

References d, QSGNode::DirtyGeometry, QSGNode::DirtyMaterial, QSGNode::markDirty(), qsgsimpletexturenode_update(), and texture().

Referenced by QSGMapboxGLTextureNode::QSGMapboxGLTextureNode().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sourceRect()

QRectF QSGSimpleTextureNode::sourceRect ( ) const

Returns the source rect of this texture node.

Since: 5.5

Definition at line 182 of file qsgsimpletexturenode.cpp.

References d.

Referenced by QSGSoftwareRenderableNode::renderNode().

Here is the caller graph for this function:

◆ texture()

QSGTexture * QSGSimpleTextureNode::texture ( ) const

Returns the texture for this texture node.

Definition at line 224 of file qsgsimpletexturenode.cpp.

References QSGOpaqueTextureMaterial::texture().

Referenced by QSGSoftwareRenderableNode::renderNode(), QSGMapboxGLTextureNode::resize(), setRect(), setSourceRect(), setTextureCoordinatesTransform(), QSGFramebufferObjectNode::texture(), SGFramebufferObjectNode::texture(), and QSGSoftwareRenderableNode::update().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ textureCoordinatesTransform()

QSGSimpleTextureNode::TextureCoordinatesTransformMode QSGSimpleTextureNode::textureCoordinatesTransform ( ) const

Returns the mode used to generate texture coordinates for this node.

See also: setTextureCoordinatesTransform()

Definition at line 267 of file qsgsimpletexturenode.cpp.

References d.

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

qtdeclarative/src/quick/scenegraph/util/qsgsimpletexturenode.h (0dc4fd240a2897c5c443a0ef6d84c416843e4938)
qtdeclarative/src/quick/scenegraph/util/qsgsimpletexturenode.cpp (45baa640b934977737300876e80e36012a08c5b2)

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ TextureCoordinatesTransformFlag

Constructor & Destructor Documentation

◆ QSGSimpleTextureNode()

◆ ~QSGSimpleTextureNode()

Member Function Documentation

◆ filtering()

◆ ownsTexture()

◆ rect()

◆ setFiltering()

◆ setOwnsTexture()

◆ setRect() [1/2]

◆ setRect() [2/2]

◆ setSourceRect() [1/2]

◆ setSourceRect() [2/2]

◆ setTexture()

◆ setTextureCoordinatesTransform()

◆ sourceRect()

◆ texture()

◆ textureCoordinatesTransform()