PySide6.Qt3DRender.Qt3DRender.QStencilTestArguments

class QStencilTestArguments

The QStencilTestArguments class specifies arguments for stencil test. More…

Synopsis

Properties

• comparisonMaskᅟ

• faceModeᅟ

• referenceValueᅟ

• stencilFunctionᅟ

Methods

• def comparisonMask()

• def faceMode()

• def referenceValue()

• def stencilFunction()

Slots

• def setComparisonMask()

• def setReferenceValue()

• def setStencilFunction()

Signals

• def comparisonMaskChanged()

• def faceModeChanged()

• def referenceValueChanged()

• def stencilFunctionChanged()

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

The QStencilTestArguments class specifies the arguments for the stencil test.

class StencilFaceMode

This enumeration holds the values for stencil test arguments face modes

Constant	Description
Qt3DRender.QStencilTestArguments.Front	Arguments are applied to front-facing polygons.
Qt3DRender.QStencilTestArguments.Back	Arguments are applied to back-facing polygons.
Qt3DRender.QStencilTestArguments.FrontAndBack	Arguments are applied to both front- and back-facing polygons.

class StencilFunction

Enumeration for the stencil function values

Constant	Description
Qt3DRender.QStencilTestArguments.Never	Never pass stencil test
Qt3DRender.QStencilTestArguments.Always	Always pass stencil test
Qt3DRender.QStencilTestArguments.Less	Pass stencil test if fragment stencil is less than reference value
Qt3DRender.QStencilTestArguments.LessOrEqual	Pass stencil test if fragment stencil is less than or equal to reference value
Qt3DRender.QStencilTestArguments.Equal	Pass stencil test if fragment stencil is equal to reference value
Qt3DRender.QStencilTestArguments.GreaterOrEqual	Pass stencil test if fragment stencil is greater than or equal to reference value
Qt3DRender.QStencilTestArguments.Greater	Pass stencil test if fragment stencil is greater than reference value
Qt3DRender.QStencilTestArguments.NotEqual	Pass stencil test if fragment stencil is not equal to reference value

Note

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

property comparisonMaskᅟ: int

Holds the stencil test comparison mask. Default is all zeroes.

Access functions:

• comparisonMask()

• setComparisonMask()

• Signal comparisonMaskChanged()

property faceModeᅟ: Qt3DRender.QStencilTestArguments.StencilFaceMode

Holds the faces the arguments are applied to.

Access functions:

• faceMode()

• Signal faceModeChanged()

property referenceValueᅟ: int

Holds the stencil test reference value. Default is zero.

Access functions:

• referenceValue()

• setReferenceValue()

• Signal referenceValueChanged()

property stencilFunctionᅟ: Qt3DRender.QStencilTestArguments.StencilFunction

Holds the stencil test function. Default is Never.

See also

StencilFunction

Access functions:

• stencilFunction()

• setStencilFunction()

• Signal stencilFunctionChanged()

comparisonMask()

Return type:

int

See also

setComparisonMask()

Getter of property comparisonMaskᅟ .

comparisonMaskChanged(comparisonMask)

Parameters:

comparisonMask – int

Notification signal of property comparisonMaskᅟ .

faceMode()

Return type:

StencilFaceMode

Getter of property faceModeᅟ .

faceModeChanged(faceMode)

Parameters:

faceMode – StencilFaceMode

Notification signal of property faceModeᅟ .

referenceValue()

Return type:

int

See also

setReferenceValue()

Getter of property referenceValueᅟ .

referenceValueChanged(referenceValue)

Parameters:

referenceValue – int

Notification signal of property referenceValueᅟ .

setComparisonMask(comparisonMask)

Parameters:

comparisonMask – int

See also

comparisonMask()

Setter of property comparisonMaskᅟ .

setReferenceValue(referenceValue)

Parameters:

referenceValue – int

See also

referenceValue()

Setter of property referenceValueᅟ .

setStencilFunction(stencilFunction)

Parameters:

stencilFunction – StencilFunction

See also

stencilFunction()

Setter of property stencilFunctionᅟ .

stencilFunction()

Return type:

StencilFunction

See also

setStencilFunction()

Getter of property stencilFunctionᅟ .

stencilFunctionChanged(stencilFunction)

Parameters:

stencilFunction – StencilFunction

Notification signal of property stencilFunctionᅟ .