QStencilTestArguments

The QStencilTestArguments class specifies arguments for stencil test. More…

Synopsis

Functions

• def comparisonMask ()

• def faceMode ()

• def referenceValue ()

• def stencilFunction ()

Slots

• def setComparisonMask (comparisonMask)

• def setReferenceValue (referenceValue)

• def setStencilFunction (stencilFunction)

Signals

• def comparisonMaskChanged (comparisonMask)

• def faceModeChanged (faceMode)

• def referenceValueChanged (referenceValue)

• def stencilFunctionChanged (stencilFunction)

Detailed Description

The QStencilTestArguments class specifies the arguments for the stencil test.

class PySide2.Qt3DRender.Qt3DRender.QStencilTestArguments

PySide2.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.

PySide2.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

PySide2.Qt3DRender.Qt3DRender.QStencilTestArguments.comparisonMask()

Return type:

uint

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

PySide2.Qt3DRender.Qt3DRender.QStencilTestArguments.comparisonMaskChanged(comparisonMask)

Parameters:

comparisonMask – uint

PySide2.Qt3DRender.Qt3DRender.QStencilTestArguments.faceMode()

Return type:

StencilFaceMode

Holds the faces the arguments are applied to.

PySide2.Qt3DRender.Qt3DRender.QStencilTestArguments.faceModeChanged(faceMode)

Parameters:

faceMode – StencilFaceMode

PySide2.Qt3DRender.Qt3DRender.QStencilTestArguments.referenceValue()

Return type:

int

Holds the stencil test reference value. Default is zero.

PySide2.Qt3DRender.Qt3DRender.QStencilTestArguments.referenceValueChanged(referenceValue)

Parameters:

referenceValue – int

PySide2.Qt3DRender.Qt3DRender.QStencilTestArguments.setComparisonMask(comparisonMask)

Parameters:

comparisonMask – uint

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

PySide2.Qt3DRender.Qt3DRender.QStencilTestArguments.setReferenceValue(referenceValue)

Parameters:

referenceValue – int

Holds the stencil test reference value. Default is zero.

PySide2.Qt3DRender.Qt3DRender.QStencilTestArguments.setStencilFunction(stencilFunction)

Parameters:

stencilFunction – StencilFunction

Holds the stencil test function. Default is Never.

See also

StencilFunction

PySide2.Qt3DRender.Qt3DRender.QStencilTestArguments.stencilFunction()

Return type:

StencilFunction

Holds the stencil test function. Default is Never.

See also

StencilFunction

PySide2.Qt3DRender.Qt3DRender.QStencilTestArguments.stencilFunctionChanged(stencilFunction)

Parameters:

stencilFunction – StencilFunction