QStencilTestArguments#

The QStencilTestArguments class specifies arguments for stencil test. More

Inheritance diagram of PySide6.Qt3DRender.Qt3DRender.QStencilTestArguments

Synopsis#

Properties#

Functions#

Slots#

Signals#

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 PySide6.Qt3DRender.Qt3DRender.QStencilTestArguments#

Note

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

property PᅟySide6.Qt3DRender.Qt3DRender.QStencilTestArguments.comparisonMask: uint#

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

Access functions:
property PᅟySide6.Qt3DRender.Qt3DRender.QStencilTestArguments.faceMode: StencilFaceMode#

Holds the faces the arguments are applied to.

Access functions:
property PᅟySide6.Qt3DRender.Qt3DRender.QStencilTestArguments.referenceValue: int#

Holds the stencil test reference value. Default is zero.

Access functions:
property PᅟySide6.Qt3DRender.Qt3DRender.QStencilTestArguments.stencilFunction: StencilFunction#

Holds the stencil test function. Default is Never.

See also

StencilFunction

Access functions:
PySide6.Qt3DRender.Qt3DRender.QStencilTestArguments.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.

PySide6.Qt3DRender.Qt3DRender.QStencilTestArguments.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

PySide6.Qt3DRender.Qt3DRender.QStencilTestArguments.comparisonMask()#
Return type:

uint

Getter of property comparisonMask .

PySide6.Qt3DRender.Qt3DRender.QStencilTestArguments.comparisonMaskChanged(comparisonMask)#
Parameters:

comparisonMaskuint

Notification signal of property comparisonMask .

PySide6.Qt3DRender.Qt3DRender.QStencilTestArguments.faceMode()#
Return type:

StencilFaceMode

Getter of property faceMode .

PySide6.Qt3DRender.Qt3DRender.QStencilTestArguments.faceModeChanged(faceMode)#
Parameters:

faceModeStencilFaceMode

Notification signal of property faceMode .

PySide6.Qt3DRender.Qt3DRender.QStencilTestArguments.referenceValue()#
Return type:

int

Getter of property referenceValue .

PySide6.Qt3DRender.Qt3DRender.QStencilTestArguments.referenceValueChanged(referenceValue)#
Parameters:

referenceValue – int

Notification signal of property referenceValue .

PySide6.Qt3DRender.Qt3DRender.QStencilTestArguments.setComparisonMask(comparisonMask)#
Parameters:

comparisonMaskuint

See also

comparisonMask()

Setter of property comparisonMask .

PySide6.Qt3DRender.Qt3DRender.QStencilTestArguments.setReferenceValue(referenceValue)#
Parameters:

referenceValue – int

See also

referenceValue()

Setter of property referenceValue .

PySide6.Qt3DRender.Qt3DRender.QStencilTestArguments.setStencilFunction(stencilFunction)#
Parameters:

stencilFunctionStencilFunction

Setter of property stencilFunction .

PySide6.Qt3DRender.Qt3DRender.QStencilTestArguments.stencilFunction()#
Return type:

StencilFunction

Getter of property stencilFunction .

PySide6.Qt3DRender.Qt3DRender.QStencilTestArguments.stencilFunctionChanged(stencilFunction)#
Parameters:

stencilFunctionStencilFunction

Notification signal of property stencilFunction .