PySide6.QtQuick.QSGOpacityNode¶

class QSGOpacityNode¶

The QSGOpacityNode class is used to change opacity of nodes. More…

Synopsis¶

Methods¶

def __init__()
def combinedOpacity()
def opacity()
def setCombinedOpacity()
def setOpacity()

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¶

Opacity applies to its subtree and can be nested. Multiple opacity nodes will be accumulated by multiplying their opacity. The accumulation happens as part of the rendering.

When nested opacity gets below a certain threshold, the subtree might be marked as blocked, causing isSubtreeBlocked() to return true. This is done for performance reasons.

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__()¶

Constructs an opacity node with a default opacity of 1.

Opacity accumulates downwards in the scene graph so a node with two QSGOpacityNode instances above it, both with opacity of 0.5, will have effective opacity of 0.25.

The default opacity of nodes is 1.

combinedOpacity()¶

Return type:: float

opacity()¶

Return type:: float

Returns this opacity node’s opacity.

See also

setOpacity()

setCombinedOpacity(opacity)¶

Parameters:: opacity – float

setOpacity(opacity)¶

Parameters:: opacity – float

Sets the opacity of this node to opacity.

Before rendering the graph, the renderer will do an update pass over the subtree to propagate the opacity to its children.

The value will be bounded to the range 0 to 1.

See also

opacity()