QSGGeometryNode Class

The QSGGeometryNode class is used for all rendered content in the scene graph. More...

Header: #include <QSGGeometryNode>
qmake: QT += quick
Inherits: QSGBasicGeometryNode
Inherited By:

QSGImageNode, QSGRectangleNode, QSGSimpleRectNode, and QSGSimpleTextureNode

Public Functions

QSGMaterial *material() const
QSGMaterial *opaqueMaterial() const
void setMaterial(QSGMaterial *material)
void setOpaqueMaterial(QSGMaterial *material)

Detailed Description

The QSGGeometryNode class is used for all rendered content in the scene graph.

The QSGGeometryNode consists of geometry and material. The geometry defines the mesh, the vertices and their structure, to be drawn. The Material defines how the shape is filled.

The following is a code snippet illustrating how to create a red line using a QSGGeometryNode:

QSGGeometry *geometry = new QSGGeometry(QSGGeometry::defaultAttributes_Point2D(), 2);
geometry->vertexDataAsPoint2D()[0].set(0, 0);
geometry->vertexDataAsPoint2D()[1].set(width(), height());

QSGFlatColorMaterial *material = new QSGFlatColorMaterial;
material->setColor(QColor(255, 0, 0));

QSGGeometryNode *node = new QSGGeometryNode;

A geometry node must have both geometry and a normal material before it is added to the scene graph. When the geometry and materials are changed after the node has been added to the scene graph, the user should also mark them as dirty using QSGNode::markDirty().

The geometry node supports two types of materials, the opaqueMaterial and the normal material. The opaqueMaterial is used when the accumulated scene graph opacity at the time of rendering is 1. The primary use case is to special case opaque rendering to avoid an extra operation in the fragment shader can have significant performance impact on embedded graphics chips. The opaque material is optional.

Note: All classes with QSG prefix should be used solely on the scene graph's rendering thread. See Scene Graph and Rendering for more information.

See also QSGGeometry, QSGMaterial, and QSGSimpleMaterial.

Member Function Documentation


Creates a new geometry node without geometry and material.


Deletes this geometry node.

The flags QSGNode::OwnsMaterial, QSGNode::OwnsOpaqueMaterial and QSGNode::OwnsGeometry decides whether the geometry node should also delete the materials and geometry. By default, these flags are disabled.

QSGMaterial *QSGGeometryNode::material() const

Returns the material of the QSGGeometryNode.

See also setMaterial().

QSGMaterial *QSGGeometryNode::opaqueMaterial() const

Returns the opaque material of the QSGGeometryNode.

See also setOpaqueMaterial().

void QSGGeometryNode::setMaterial(QSGMaterial *material)

Sets the material of this geometry node to material.

Geometry nodes must have a material before they can be added to the scene graph.

If the material is changed without calling setMaterial() again, the user must also mark the material as dirty using QSGNode::markDirty().

See also material().

void QSGGeometryNode::setOpaqueMaterial(QSGMaterial *material)

Sets the opaque material of this geometry to material.

The opaque material will be preferred by the renderer over the default material, as returned by the material() function, if it is not null and the geometry item has an inherited opacity of 1.

The opaqueness refers to scene graph opacity, the material is still allowed to set QSGMaterial::Blending to true and draw transparent pixels.

If the material is changed without calling setOpaqueMaterial() again, the user must also mark the opaque material as dirty using QSGNode::markDirty().

See also opaqueMaterial().

© 2017 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.