PySide6.QtQuick.QSGGeometry

class QSGGeometry

The QSGGeometry class provides low-level storage for graphics primitives in the Qt Quick Scene Graph .

Details

The QSGGeometry class stores the geometry of the primitives rendered with the scene graph. It contains vertex data and optionally index data. The mode used to draw the geometry, also called primitive topology, is specified with setDrawingMode() .

Vertices can be as simple as points defined by x and y values or can be more complex where each vertex contains a normal, texture coordinates and a 3D position. The AttributeSet is used to describe how the vertex data is built up. The attribute set can only be specified on construction. The QSGGeometry class provides a few convenience attributes and attribute sets by default. The defaultAttributes_Point2D() function returns an attribute set to be used in normal solid color rectangles, while the defaultAttributes_TexturedPoint2D function returns attributes to be used for textured 2D geometry. The vertex data is internally stored as a void * and is accessible with the vertexData() function. Convenience accessors for the common attribute sets are available with vertexDataAsPoint2D() and vertexDataAsTexturedPoint2D() . Vertex data is allocated by passing a vertex count to the constructor or by calling allocate() later.

The number of vertices and indices can be changed after construction by using the allocate() method to resize the data buffer. However, allocate() requires updating all vertex and index data each time called. Since Qt 6.10, setVertexCount() and setIndexCount() allow adjusting the number of vertices or indices without reallocating the data buffer and only require updating new vertices or indices. In either case, the caller must mark the geometry node as dirty, by calling node->markDirty(QSGNode::DirtyGeometry), to ensure that the renderer has a chance to update internal buffers.

The QSGGeometry can optionally contain indices of either unsigned 32-bit, unsigned 16-bit, or unsigned 8-bit integers. The index type must be specified during construction and cannot be changed.

Below is a snippet illustrating how a geometry composed of position and color vertices can be built.

struct MyPoint2D {
    float x;
    float y;
    float r;
    float g;
    float b;
    float a;

    void set(float x_, float y_, float r_, float g_, float b_, float a_) {
        x = x_;
        y = y_;
        r = r_;
        g = g_;
        b = b_;
        a = a_;
    }
};

QSGGeometry::Attribute MyPoint2D_Attributes[] = {
    QSGGeometry::Attribute::create(0, 2, FloatType, true),
    QSGGeometry::Attribute::create(1, 4, FloatType, false)
};

QSGGeometry::AttributeSet MyPoint2D_AttributeSet = {
    2,
    sizeof(MyPoint2D),
    MyPoint2D_Attributes
};

...

geometry = new QSGGeometry(MyPoint2D_AttributeSet, 2);
geometry->setDrawingMode(DrawLines);

MyPoint2D *vertices = static_cast<MyPoint2D *>(geometry->vertexData());
vertices[0].set(0, 0, 1, 0, 0, 1);
vertices[1].set(width(), height(), 0, 0, 1, 1);

The QSGGeometry is a software buffer and client-side in terms of accelerated rendering, as the buffers used in 2D graphics typically consist of many small buffers that change every frame and do not benefit from being uploaded to graphics memory. However, the QSGGeometry supports hinting to the renderer that a buffer should be uploaded using the setVertexDataPattern() and setIndexDataPattern() functions. Whether this hint is respected or not is implementation specific.

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

QSGGeometryNode Scene Graph - Custom Geometry

Synopsis

Methods

Static functions

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

class AttributeType

This enum identifies several attribute types.

Constant

Description

QSGGeometry.UnknownAttribute

Don’t care

QSGGeometry.PositionAttribute

Position

QSGGeometry.ColorAttribute

Color

QSGGeometry.TexCoordAttribute

Texture coordinate

QSGGeometry.TexCoord1Attribute

Texture coordinate 1

QSGGeometry.TexCoord2Attribute

Texture coordinate 2
class DataPattern

The DataPattern enum is used to specify the use pattern for the vertex and index data in a geometry object.

Constant

Description

QSGGeometry.AlwaysUploadPattern

The data is always uploaded. This means that the user does not need to explicitly mark index and vertex data as dirty after changing it. This is the default.

QSGGeometry.DynamicPattern

The data is modified repeatedly and drawn many times. This is a hint that may provide better performance. When set the user must make sure to mark the data as dirty after changing it.

QSGGeometry.StaticPattern

The data is modified once and drawn many times. This is a hint that may provide better performance. When set the user must make sure to mark the data as dirty after changing it.

QSGGeometry.StreamPattern

The data is modified for almost every time it is drawn. This is a hint that may provide better performance. When set, the user must make sure to mark the data as dirty after changing it.
class DrawingMode

(inherits enum.IntEnum) Specifies the drawing mode, also called primitive topology.

Note

Starting with Qt 6 the scene graph only exposes topologies that are supported across all the supported 3D graphics APIs. As a result, the values DrawLineLoop and DrawTriangleFan are no longer supported at run time in Qt 6, even though the enum values themselves are still present.

Constant

Description

QSGGeometry.DrawPoints

QSGGeometry.DrawLines

QSGGeometry.DrawLineStrip

QSGGeometry.DrawTriangles

QSGGeometry.DrawTriangleStrip
class Type

Specifies the component type in the vertex data.

Constant

Description

QSGGeometry.ByteType

QSGGeometry.UnsignedByteType

QSGGeometry.ShortType

QSGGeometry.UnsignedShortType

QSGGeometry.IntType

QSGGeometry.UnsignedIntType

QSGGeometry.FloatType

QSGGeometry.Bytes2Type

Added in Qt 5.14.

QSGGeometry.Bytes3Type

Added in Qt 5.14.

QSGGeometry.Bytes4Type

Added in Qt 5.14.

QSGGeometry.DoubleType

Added in Qt 5.14.
__init__(attribs, vertexCount[, indexCount=0[, indexType=QSGGeometry.Type.UnsignedShortType]])
Parameters:

  • attribs – AttributeSet

  • vertexCount – int

  • indexCount – int

  • indexType – int

Constructs a geometry object based on attributes.

The object allocate space for vertexCount vertices based on the accumulated size in attributes and for indexCount.

The indexType can be UnsignedShortType or UnsignedIntType. Support for the latter depends on the graphics API implementation used at run time, and may not always be available.

Geometry objects are constructed by default with DrawTriangleStrip as the drawing mode.

Note

attributes and the Attribute objects referenced by it must stay valid for the entire lifetime of the QSGGeometry . QSGGeometry stores a reference to attributes and does not delete the Attribute objects.

allocate(vertexCount[, indexCount=0])
Parameters:

  • vertexCount – int

  • indexCount – int

Resizes the vertex and index data of this geometry object to fit vertexCount vertices and indexCount indices and sets the number of vertices and indices accordingly.

Use setVertexCount() or setIndexCount() to change the number of vertices or indices without calling allocate() again.

Vertex and index data will be invalidated after this call and the caller must mark the associated geometry node as dirty, by calling node->markDirty(QSGNode::DirtyGeometry), to ensure that the renderer has a chance to update internal buffers.

attributeCount()
Return type:

int

Returns the number of attributes in the attrbute set used by this geometry.

attributes()
Return type:

Attribute

Returns an array with the attributes of this geometry. The size of the array is given with attributeCount() .

static defaultAttributes_ColoredPoint2D()
Return type:

AttributeSet

Convenience function which returns attributes to be used for per vertex colored 2D drawing.

static defaultAttributes_Point2D()
Return type:

AttributeSet

Convenience function which returns attributes to be used for 2D solid color drawing.

static defaultAttributes_TexturedPoint2D()
Return type:

AttributeSet

Convenience function which returns attributes to be used for textured 2D drawing.

drawingMode()
Return type:

int

Returns the drawing mode of this geometry.

The default value is DrawTriangleStrip .

See also

setDrawingMode()

indexCount()
Return type:

int

Returns the number of indices that are processed when the geometry object is rendered.

See also

setIndexCount()

indexData()
Return type:

void

Returns a pointer to the raw index data of this geometry object.

indexDataAsUInt()
Return type:

uint

Convenience function to access the index data as an immutable array of 32-bit unsigned integers.

indexDataAsUShort()
Return type:

quint16

Convenience function to access the index data as an immutable array of 16-bit unsigned integers.

indexDataPattern()
Return type:

DataPattern

Returns the usage pattern for indices in this geometry. The default pattern is AlwaysUploadPattern .

indexType()
Return type:

int

Returns the primitive type used for indices in this geometry object.

lineWidth()
Return type:

float

Gets the current line or point width or to be used for this geometry. This property only applies to line width when the drawingMode is DrawLines or DrawLineStrip . When supported, it also applies to point size when the drawingMode is DrawPoints .

The default value is 1.0

Note

Support for point and line drawing may be limited at run time, depending on the platform and graphics API. For example, some APIs do not support point sprites and so setting a size other than 1 is not possible.

Note

The width of 1.0 is always supported.

See also

setLineWidth() drawingMode()

markIndexDataDirty()

Mark that the vertices in this geometry has changed and must be uploaded again.

This function only has an effect when the usage pattern for vertices is StaticData and the renderer that renders this geometry uploads the geometry into Vertex Buffer Objects (VBOs).

markVertexDataDirty()

Mark that the vertices in this geometry has changed and must be uploaded again.

This function only has an effect when the usage pattern for vertices is StaticData and the renderer that renders this geometry uploads the geometry into Vertex Buffer Objects (VBOs).

setDrawingMode(mode)
Parameters:

mode – int

Sets the mode to be used for drawing this geometry.

The default value is DrawTriangleStrip .

setIndexCount(count)
Parameters:

count – int

Sets the number of indices to be processed each time the geometry object is rendered.

The count is not validated and it is the users responsibility to ensure that only values between zero and the number of allocated indices are specified.

Vertex and index data is not invalidated after this call, but the caller must mark the geometry node as dirty, by calling node->markDirty(QSGNode::DirtyGeometry), to ensure that the renderer has a chance to update internal buffers.

See also

indexCount()

setIndexDataPattern(p)
Parameters:

p – DataPattern

Sets the usage pattern for indices to p.

The default is AlwaysUploadPattern . When set to anything other than the default, the user must call markIndexDataDirty() after changing the index data, in addition to calling markDirty() with DirtyGeometry .

setLineWidth(w)
Parameters:

w – float

Sets the line or point width to be used for this geometry to width. This property only applies to line width when the drawingMode is DrawLines or DrawLineStrip . When supported, it also applies to point size when the drawingMode is DrawPoints .

Note

Support for point and line drawing may be limited at run time, depending on the platform and graphics API. For example, some APIs do not support point sprites and so setting a size other than 1 is not possible.

Note

The width of 1.0 is always supported.

See also

lineWidth() drawingMode()

setVertexCount(count)
Parameters:

count – int

Sets the number of vertices to be rendered.

The count is not validated and it is the users responsibility to ensure that only values between zero and the number of allocated vertices are specified.

Vertex data is not invalidated after this call, but the caller must mark the geometry node as dirty, by calling node->markDirty(QSGNode::DirtyGeometry), to ensure that the renderer has a chance to update internal buffers.

See also

vertexCount()

setVertexDataAsPoint2D(points)
Parameters:

points – .list of QSGGeometry.Point2D

Sets the vertex data from a list of QSGGeometry.Point2D. The list size must match the allocated number of vertexes as returned by QSGGeometry.vertexCount().

setVertexDataPattern(p)
Parameters:

p – DataPattern

Sets the usage pattern for vertices to p.

The default is AlwaysUploadPattern . When set to anything other than the default, the user must call markVertexDataDirty() after changing the vertex data, in addition to calling markDirty() with DirtyGeometry .

sizeOfIndex()
Return type:

int

Returns the byte size of the index type.

This value is either 2 when the index type is UnsignedShortType , or 4 when the index type is UnsignedIntType .

sizeOfVertex()
Return type:

int

Returns the size in bytes of one vertex.

This value comes from the attributes.

static updateColoredRectGeometry(g, rect)
Parameters:

Updates the geometry g with the coordinates in rect.

The function assumes the geometry object contains a single triangle strip of ColoredPoint2D vertices

static updateRectGeometry(g, rect)
Parameters:

Updates the geometry g with the coordinates in rect.

The function assumes the geometry object contains a single triangle strip of Point2D vertices

static updateTexturedRectGeometry(g, rect, sourceRect)
Parameters:

Updates the geometry g with the coordinates in rect and texture coordinates from textureRect.

textureRect should be in normalized coordinates.

g is assumed to be a triangle strip of four vertices of type TexturedPoint2D .

vertexCount()
Return type:

int

Returns the number of vertices that can be rendered, or if indices are used, it returns the number of vertices that can be accessed through indices.

See also

setVertexCount()

vertexData()
Return type:

void

Returns a pointer to the raw vertex data of this geometry object.

vertexDataAsColoredPoint2D()
Return type:

ColoredPoint2D

Convenience function to access the vertex data as an immutable array of ColoredPoint2D .

vertexDataAsPoint2D()
Return type:

PyObject*

Convenience function to access the vertex data as an immutable array of Point2D .

vertexDataAsTexturedPoint2D()
Return type:

TexturedPoint2D

Convenience function to access the vertex data as an immutable array of TexturedPoint2D .

vertexDataPattern()
Return type:

DataPattern

Returns the usage pattern for vertices in this geometry. The default pattern is AlwaysUploadPattern .

class TexturedPoint2D

The TexturedPoint2D struct is a convenience struct for accessing 2D Points with texture coordinates.

Synopsis

Methods

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

PySide6.QtQuick.QSGGeometry.TexturedPoint2D.x
PySide6.QtQuick.QSGGeometry.TexturedPoint2D.y
PySide6.QtQuick.QSGGeometry.TexturedPoint2D.tx
PySide6.QtQuick.QSGGeometry.TexturedPoint2D.ty
set(nx, ny, ntx, nty)
Parameters:

  • nx – float

  • ny – float

  • ntx – float

  • nty – float

Sets the position of the vertex to x and y and the texture coordinate to tx and ty.

class Point2D

The Point2D struct is a convenience struct for accessing 2D Points.

Synopsis

Methods

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

PySide6.QtQuick.QSGGeometry.Point2D.x
PySide6.QtQuick.QSGGeometry.Point2D.y
set(nx, ny)
Parameters:

  • nx – float

  • ny – float

Sets the x and y values of this point to x and y.

class ColoredPoint2D

The ColoredPoint2D struct is a convenience struct for accessing 2D Points with a color.

Synopsis

Methods

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

PySide6.QtQuick.QSGGeometry.ColoredPoint2D.x
PySide6.QtQuick.QSGGeometry.ColoredPoint2D.y
PySide6.QtQuick.QSGGeometry.ColoredPoint2D.r
PySide6.QtQuick.QSGGeometry.ColoredPoint2D.g
PySide6.QtQuick.QSGGeometry.ColoredPoint2D.b
PySide6.QtQuick.QSGGeometry.ColoredPoint2D.a
set(nx, ny, nr, ng, nb, na)
Parameters:

  • nx – float

  • ny – float

  • nr – int

  • ng – int

  • nb – int

  • na – int

Sets the position of the vertex to x and y and the color to red, green, blue, and alpha.

class Attribute

The Attribute describes a single vertex attribute in a QSGGeometry .

Details

The Attribute struct describes the attribute register position, the size of the attribute tuple and the attribute type.

It also contains a hint to the renderer if this attribute is the attribute describing the position. The scene graph renderer may use this information to perform optimizations.

It contains a number of bits which are reserved for future use.

See also

QSGGeometry

Synopsis

Static functions

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

PySide6.QtQuick.QSGGeometry.Attribute.position
PySide6.QtQuick.QSGGeometry.Attribute.tupleSize
PySide6.QtQuick.QSGGeometry.Attribute.type
PySide6.QtQuick.QSGGeometry.Attribute.isVertexCoordinate
PySide6.QtQuick.QSGGeometry.Attribute.attributeType
PySide6.QtQuick.QSGGeometry.Attribute.reserved
static create(pos, tupleSize, primitiveType[, isPosition=false])
Parameters:

  • pos – int

  • tupleSize – int

  • primitiveType – int

  • isPosition – bool

Return type:

Attribute

Creates a new Attribute for attribute register pos with tupleSize. The primitiveType can be any of the supported types from Type , such as FloatType or UnsignedByteType .

If the attribute describes the position for the vertex, the isPosition hint should be set to true. The scene graph renderer may use this information to perform optimizations.

Use the create function to construct the attribute, rather than an initialization list, to ensure that all fields are initialized.

static createWithAttributeType(pos, tupleSize, primitiveType, attributeType)
Parameters:

  • pos – int

  • tupleSize – int

  • primitiveType – int

  • attributeType – AttributeType

Return type:

Attribute

Creates a new Attribute for attribute register pos with tupleSize. The primitiveType can be any of the supported types from Type , such as FloatType or UnsignedByteType .

attributeType describes the intended use of the attribute.

Use the create function to construct the attribute, rather than an initialization list, to ensure that all fields are initialized.

class AttributeSet

The AttributeSet describes how the vertices in a QSGGeometry are built up.

Details

See also

QSGGeometry

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

PySide6.QtQuick.QSGGeometry.AttributeSet.count
PySide6.QtQuick.QSGGeometry.AttributeSet.stride
PySide6.QtQuick.QSGGeometry.AttributeSet.attributes