PySide6.QtQuick.QSGClipNode

class QSGClipNode

The QSGClipNode class implements the clipping functionality in the scene graph. More…

Inheritance diagram of PySide6.QtQuick.QSGClipNode

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

Detailed Description

Clipping applies to the node’s subtree and can be nested. Multiple clip nodes will be accumulated by intersecting all their geometries. The accumulation happens as part of the rendering.

Clip nodes must have a geometry before they can be added to the scene graph.

Clipping is usually implemented by using the stencil buffer.

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.

__init__()

Creates a new QSGClipNode without a geometry.

The clip node must have a geometry before it can be added to the scene graph.

clipRect()
Return type:

QRectF

Returns the clip rect of this node.

See also

setClipRect()

isRectangular()
Return type:

bool

Returns if this clip node has a rectangular clip.

setClipRect(rect)
Parameters:

rect – QRectF

Sets the clip rect of this clip node to rect.

When a rectangular clip is set in combination with setIsRectangular the renderer may in some cases use a more optimal clip method.

See also

clipRect()

setIsRectangular(rectHint)
Parameters:

rectHint – bool

Sets whether this clip node has a rectangular clip to rectHint.

This is an optimization hint which means that the renderer can use scissoring instead of stencil, which is significantly faster.

When this hint is set and it is applicable, the clip region will be generated from clipRect() rather than geometry() .

By default this property is false.

See also

isRectangular()