PySide6.Qt3DRender.Qt3DRender.QGeometryRenderer

class QGeometryRenderer

Encapsulates geometry rendering. More…

Inherited by: QMesh, QTorusMesh, QSphereMesh, QPlaneMesh, QExtrudedTextMesh, QCylinderMesh, QCuboidMesh, QConeMesh

Synopsis

Properties

• firstInstanceᅟ

• firstVertexᅟ

• geometryᅟ

• indexBufferByteOffsetᅟ

• indexOffsetᅟ

• instanceCountᅟ

• primitiveRestartEnabledᅟ

• primitiveTypeᅟ

• restartIndexValueᅟ

• sortIndexᅟ

• vertexCountᅟ

• verticesPerPatchᅟ

Methods

• def __init__()

• def firstInstance()

• def firstVertex()

• def geometry()

• def indexBufferByteOffset()

• def indexOffset()

• def instanceCount()

• def primitiveRestartEnabled()

• def primitiveType()

• def restartIndexValue()

• def sortIndex()

• def vertexCount()

• def verticesPerPatch()

Slots

• def setFirstInstance()

• def setFirstVertex()

• def setGeometry()

• def setIndexBufferByteOffset()

• def setIndexOffset()

• def setInstanceCount()

• def setPrimitiveRestartEnabled()

• def setPrimitiveType()

• def setRestartIndexValue()

• def setSortIndex()

• def setVertexCount()

• def setVerticesPerPatch()

Signals

• def firstInstanceChanged()

• def firstVertexChanged()

• def geometryChanged()

• def indexBufferByteOffsetChanged()

• def indexOffsetChanged()

• def instanceCountChanged()

• def primitiveRestartEnabledChanged()

• def primitiveTypeChanged()

• def restartIndexValueChanged()

• def sortIndexChanged()

• def vertexCountChanged()

• def verticesPerPatchChanged()

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

Detailed Description

A QGeometryRenderer holds all the information necessary to draw a QGeometry . A QGeometry holds the coordinates of the geometry data - QGeometryRenderer specifies how to interpret that data.

class PrimitiveType

The type of the primitive.

Constant	Description
Qt3DRender.QGeometryRenderer.Points	List of points
Qt3DRender.QGeometryRenderer.Lines	List of lines
Qt3DRender.QGeometryRenderer.LineLoop	Connected group of lines connected at ends forming a loop
Qt3DRender.QGeometryRenderer.LineStrip	Connected group of lines
Qt3DRender.QGeometryRenderer.Triangles	List of triangles
Qt3DRender.QGeometryRenderer.TriangleStrip	List of connected triangles
Qt3DRender.QGeometryRenderer.TriangleFan	List of connected triagles where all triangles share the first vertex
Qt3DRender.QGeometryRenderer.LinesAdjacency	Allows geometry shader to access adjacent lines in a line list
Qt3DRender.QGeometryRenderer.TrianglesAdjacency	Allows geometry shader to access adjacent triangles in a triangle list
Qt3DRender.QGeometryRenderer.LineStripAdjacency	Allows geometry shader to access adjacent lines in a line strip
Qt3DRender.QGeometryRenderer.TriangleStripAdjacency	Allows geometry shader to access adjacent triangles in a triangle strip
Qt3DRender.QGeometryRenderer.Patches	Only primitive type accepted by tesselation shader where a patch consists of arbitrary number of vertices

Note

Properties can be used directly when from __feature__ import true_property is used or via accessor functions otherwise.

property firstInstanceᅟ: int

Holds the base instance.

Access functions:

• firstInstance()

• setFirstInstance()

• Signal firstInstanceChanged()

property firstVertexᅟ: int

Holds the base vertex.

Access functions:

• firstVertex()

• setFirstVertex()

• Signal firstVertexChanged()

property geometryᅟ: QGeometry

Holds the geometry.

Access functions:

• geometry()

• setGeometry()

• Signal geometryChanged()

property indexBufferByteOffsetᅟ: int

Holds the byte offset into the index buffer.

Access functions:

• indexBufferByteOffset()

• setIndexBufferByteOffset()

• Signal indexBufferByteOffsetChanged()

property indexOffsetᅟ: int

Holds the base vertex.

Access functions:

• indexOffset()

• setIndexOffset()

• Signal indexOffsetChanged()

property instanceCountᅟ: int

Holds the instance count.

Access functions:

• instanceCount()

• setInstanceCount()

• Signal instanceCountChanged()

property primitiveRestartEnabledᅟ: bool

Holds the primitive restart flag.

Access functions:

• primitiveRestartEnabled()

• setPrimitiveRestartEnabled()

• Signal primitiveRestartEnabledChanged()

property primitiveTypeᅟ: Qt3DRender.QGeometryRenderer.PrimitiveType

Holds the primitive type.

Access functions:

• primitiveType()

• setPrimitiveType()

• Signal primitiveTypeChanged()

property restartIndexValueᅟ: int

Holds the restart index.

Access functions:

• restartIndexValue()

• setRestartIndexValue()

• Signal restartIndexValueChanged()

property sortIndexᅟ: float

Overrides the sorting index when depth sorting is enabled.

If depth sorting is enabled on the frame graph, the renderer will sort objects based on how far the center of the bounding volume is from the camera and render objects from the furthest to the closest.

This property can be used to override the depth index and precisely control the order in which objects are rendered. This is useful when all objects are at the same physical distance from the camera.

The actual values are not significant, only that they define an order to sort the objects. These are sorted such as the object with the smallest value is drawn first, then the second smallest, and so on.

Note

Setting this to -1.f will disable the explicit sorting for this entity and revert to using the distance from the center of the bounding volume.

See also

QSortPolicy

Access functions:

• sortIndex()

• setSortIndex()

• Signal sortIndexChanged()

property vertexCountᅟ: int

Holds the primitive count.

Access functions:

• vertexCount()

• setVertexCount()

• Signal vertexCountChanged()

property verticesPerPatchᅟ: int

Holds vertices per patch.

Access functions:

• verticesPerPatch()

• setVerticesPerPatch()

• Signal verticesPerPatchChanged()

__init__([parent=None])

Parameters:

parent – QNode

Constructs a new QGeometryRenderer with parent.

firstInstance()

Return type:

int

See also

setFirstInstance()

Getter of property firstInstanceᅟ .

firstInstanceChanged(firstInstance)

Parameters:

firstInstance – int

Notification signal of property firstInstanceᅟ .

firstVertex()

Return type:

int

See also

setFirstVertex()

Getter of property firstVertexᅟ .

firstVertexChanged(firstVertex)

Parameters:

firstVertex – int

Notification signal of property firstVertexᅟ .

geometry()

Return type:

QGeometry

See also

setGeometry()

Getter of property geometryᅟ .

geometryChanged(geometry)

Parameters:

geometry – QGeometry

Notification signal of property geometryᅟ .

indexBufferByteOffset()

Return type:

int

See also

setIndexBufferByteOffset()

Getter of property indexBufferByteOffsetᅟ .

indexBufferByteOffsetChanged(offset)

Parameters:

offset – int

Notification signal of property indexBufferByteOffsetᅟ .

indexOffset()

Return type:

int

See also

setIndexOffset()

Getter of property indexOffsetᅟ .

indexOffsetChanged(indexOffset)

Parameters:

indexOffset – int

Notification signal of property indexOffsetᅟ .

instanceCount()

Return type:

int

See also

setInstanceCount()

Getter of property instanceCountᅟ .

instanceCountChanged(instanceCount)

Parameters:

instanceCount – int

Notification signal of property instanceCountᅟ .

primitiveRestartEnabled()

Return type:

bool

See also

setPrimitiveRestartEnabled()

Getter of property primitiveRestartEnabledᅟ .

primitiveRestartEnabledChanged(primitiveRestartEnabled)

Parameters:

primitiveRestartEnabled – bool

Notification signal of property primitiveRestartEnabledᅟ .

primitiveType()

Return type:

PrimitiveType

See also

setPrimitiveType()

Getter of property primitiveTypeᅟ .

primitiveTypeChanged(primitiveType)

Parameters:

primitiveType – PrimitiveType

Notification signal of property primitiveTypeᅟ .

restartIndexValue()

Return type:

int

See also

setRestartIndexValue()

Getter of property restartIndexValueᅟ .

restartIndexValueChanged(restartIndexValue)

Parameters:

restartIndexValue – int

Notification signal of property restartIndexValueᅟ .

setFirstInstance(firstInstance)

Parameters:

firstInstance – int

See also

firstInstance()

Setter of property firstInstanceᅟ .

setFirstVertex(firstVertex)

Parameters:

firstVertex – int

See also

firstVertex()

Setter of property firstVertexᅟ .

setGeometry(geometry)

Parameters:

geometry – QGeometry

See also

geometry()

Setter of property geometryᅟ .

setIndexBufferByteOffset(offset)

Parameters:

offset – int

See also

indexBufferByteOffset()

Setter of property indexBufferByteOffsetᅟ .

setIndexOffset(indexOffset)

Parameters:

indexOffset – int

See also

indexOffset()

Setter of property indexOffsetᅟ .

setInstanceCount(instanceCount)

Parameters:

instanceCount – int

See also

instanceCount()

Setter of property instanceCountᅟ .

setPrimitiveRestartEnabled(enabled)

Parameters:

enabled – bool

See also

primitiveRestartEnabled()

Setter of property primitiveRestartEnabledᅟ .

setPrimitiveType(primitiveType)

Parameters:

primitiveType – PrimitiveType

See also

primitiveType()

Setter of property primitiveTypeᅟ .

setRestartIndexValue(index)

Parameters:

index – int

See also

restartIndexValue()

Setter of property restartIndexValueᅟ .

setSortIndex(sortIndex)

Parameters:

sortIndex – float

See also

sortIndex()

Setter of property sortIndexᅟ .

setVertexCount(vertexCount)

Parameters:

vertexCount – int

See also

vertexCount()

Setter of property vertexCountᅟ .

setVerticesPerPatch(verticesPerPatch)

Parameters:

verticesPerPatch – int

See also

verticesPerPatch()

Setter of property verticesPerPatchᅟ .

sortIndex()

Return type:

float

See also

setSortIndex()

Getter of property sortIndexᅟ .

sortIndexChanged(sortIndex)

Parameters:

sortIndex – float

Notification signal of property sortIndexᅟ .

vertexCount()

Return type:

int

See also

setVertexCount()

Getter of property vertexCountᅟ .

vertexCountChanged(vertexCount)

Parameters:

vertexCount – int

Notification signal of property vertexCountᅟ .

verticesPerPatch()

Return type:

int

See also

setVerticesPerPatch()

Getter of property verticesPerPatchᅟ .

verticesPerPatchChanged(verticesPerPatch)

Parameters:

verticesPerPatch – int

Notification signal of property verticesPerPatchᅟ .