PySide6.Qt3DRender.Qt3DRender.QStencilOperationArguments

class QStencilOperationArguments

The QStencilOperationArguments class sets the actions to be taken when stencil and depth tests fail. More…

Inheritance diagram of PySide6.Qt3DRender.Qt3DRender.QStencilOperationArguments

Synopsis

Properties

Methods

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 QStencilOperationArguments class specifies the arguments for the stencil operations.

See also

QStencilOperation

class FaceMode

This enumeration holds the values for stencil operation argument face modes

Constant

Description

Qt3DRender.QStencilOperationArguments.Front

Arguments are applied to front-facing polygons.

Qt3DRender.QStencilOperationArguments.Back

Arguments are applied to back-facing polygons.

Qt3DRender.QStencilOperationArguments.FrontAndBack

Arguments are applied to both front- and back-facing polygons.

class Operation

This enumeration holds the values for stencil operation.

Constant

Description

Qt3DRender.QStencilOperationArguments.Zero

Set stencil value to zero.

Qt3DRender.QStencilOperationArguments.Keep

Keep current stencil value.

Qt3DRender.QStencilOperationArguments.Replace

Replace with the masked fragment stencil value.

Qt3DRender.QStencilOperationArguments.Increment

Increment current value with saturation.

Qt3DRender.QStencilOperationArguments.Decrement

Decrement current value with saturation.

Qt3DRender.QStencilOperationArguments.IncrementWrap

Increment current value with wrap.

Qt3DRender.QStencilOperationArguments.DecrementWrap

Decrement current value with wrap.

Qt3DRender.QStencilOperationArguments.Invert

Invert the current value.

Note

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

property allTestsPassOperationᅟ: Qt3DRender.QStencilOperationArguments.Operation

Holds the stencil test operation for when depth and stencil test pass. Default is StencilOperationArguments .Keep.

Access functions:
property depthTestFailureOperationᅟ: Qt3DRender.QStencilOperationArguments.Operation

Holds the stencil test operation for when the stencil test passes, but depth test fails. Default is StencilOperationArguments .Keep.

Access functions:
property faceModeᅟ: Qt3DRender.QStencilOperationArguments.FaceMode

Holds the faces the arguments are applied to.

Access functions:
property stencilTestFailureOperationᅟ: Qt3DRender.QStencilOperationArguments.Operation

Holds the stencil test operation for when the stencil test fails. Default is StencilOperationArguments .Keep.

Access functions:
allTestsPassOperation()
Return type:

Operation

See also

setAllTestsPassOperation()

Getter of property allTestsPassOperationᅟ .

allTestsPassOperationChanged(stencilDepthPass)
Parameters:

stencilDepthPass – Operation

Notification signal of property allTestsPassOperationᅟ .

depthTestFailureOperation()
Return type:

Operation

See also

setDepthTestFailureOperation()

Getter of property depthTestFailureOperationᅟ .

depthTestFailureOperationChanged(depthFail)
Parameters:

depthFail – Operation

Notification signal of property depthTestFailureOperationᅟ .

faceMode()
Return type:

FaceMode

Getter of property faceModeᅟ .

faceModeChanged(faceMode)
Parameters:

faceMode – FaceMode

Notification signal of property faceModeᅟ .

setAllTestsPassOperation(operation)
Parameters:

operation – Operation

See also

allTestsPassOperation()

Setter of property allTestsPassOperationᅟ .

setDepthTestFailureOperation(operation)
Parameters:

operation – Operation

See also

depthTestFailureOperation()

Setter of property depthTestFailureOperationᅟ .

setStencilTestFailureOperation(operation)
Parameters:

operation – Operation

See also

stencilTestFailureOperation()

Setter of property stencilTestFailureOperationᅟ .

stencilTestFailureOperation()
Return type:

Operation

See also

setStencilTestFailureOperation()

Getter of property stencilTestFailureOperationᅟ .

stencilTestFailureOperationChanged(stencilFail)
Parameters:

stencilFail – Operation

Notification signal of property stencilTestFailureOperationᅟ .