PySide6.Qt3DRender.Qt3DRender.QColorMask

class QColorMask

Allows specifying which color components should be written to the currently bound frame buffer. More…

Synopsis

Properties

• alphaMaskedᅟ

• blueMaskedᅟ

• greenMaskedᅟ

• redMaskedᅟ

Methods

• def __init__()

• def isAlphaMasked()

• def isBlueMasked()

• def isGreenMasked()

• def isRedMasked()

Slots

• def setAlphaMasked()

• def setBlueMasked()

• def setGreenMasked()

• def setRedMasked()

Signals

• def alphaMaskedChanged()

• def blueMaskedChanged()

• def greenMaskedChanged()

• def redMaskedChanged()

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

By default, the property for each color component (red, green, blue, alpha) is set to true which means they will be written to the frame buffer. Setting any of the color component to false will prevent it from being written into the frame buffer.

Note

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

property alphaMaskedᅟ: bool

Holds whether the alphaMasked component should be written to the frame buffer.

Access functions:

• isAlphaMasked()

• setAlphaMasked()

• Signal alphaMaskedChanged()

property blueMaskedᅟ: bool

Holds whether the blue color component should be written to the frame buffer.

Access functions:

• isBlueMasked()

• setBlueMasked()

• Signal blueMaskedChanged()

property greenMaskedᅟ: bool

Holds whether the green color component should be written to the frame buffer.

Access functions:

• isGreenMasked()

• setGreenMasked()

• Signal greenMaskedChanged()

property redMaskedᅟ: bool

Holds whether the red color component should be written to the frame buffer.

Access functions:

• isRedMasked()

• setRedMasked()

• Signal redMaskedChanged()

__init__([parent=None])

Parameters:

parent – QNode

Constructs a new Qt3DCore::QColorMask instance with parent as parent.

alphaMaskedChanged(alphaMasked)

Parameters:

alphaMasked – bool

Notification signal of property alphaMaskedᅟ .

blueMaskedChanged(blueMasked)

Parameters:

blueMasked – bool

Notification signal of property blueMaskedᅟ .

greenMaskedChanged(greenMasked)

Parameters:

greenMasked – bool

Notification signal of property greenMaskedᅟ .

isAlphaMasked()

Return type:

bool

Getter of property alphaMaskedᅟ .

isBlueMasked()

Return type:

bool

Getter of property blueMaskedᅟ .

isGreenMasked()

Return type:

bool

Getter of property greenMaskedᅟ .

isRedMasked()

Return type:

bool

Getter of property redMaskedᅟ .

redMaskedChanged(redMasked)

Parameters:

redMasked – bool

Notification signal of property redMaskedᅟ .

setAlphaMasked(alphaMasked)

Parameters:

alphaMasked – bool

See also

isAlphaMasked()

Setter of property alphaMaskedᅟ .

setBlueMasked(blueMasked)

Parameters:

blueMasked – bool

See also

isBlueMasked()

Setter of property blueMaskedᅟ .

setGreenMasked(greenMasked)

Parameters:

greenMasked – bool

See also

isGreenMasked()

Setter of property greenMaskedᅟ .

setRedMasked(redMasked)

Parameters:

redMasked – bool

See also

isRedMasked()

Setter of property redMaskedᅟ .