QStencilOperationArguments Class

class Qt3DRender::QStencilOperationArguments

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

Header: #include <QStencilOperationArguments>
qmake: QT += 3drender
Since: Qt 5.7
Instantiated By: StencilOperationArguments
Inherits: QObject

This class was introduced in Qt 5.7.

Public Types

enum FaceMode { Front, Back, FrontAndBack }
enum Operation { Zero, Keep, Replace, Increment, Decrement, …, Invert }

Properties

Public Functions

Operation allTestsPassOperation() const
Operation depthTestFailureOperation() const
FaceMode faceMode() const
Operation stencilTestFailureOperation() const

Public Slots

void setAllTestsPassOperation(Operation operation)
void setDepthTestFailureOperation(Operation operation)
void setStencilTestFailureOperation(Operation operation)

Signals

void allTestsPassOperationChanged(Operation stencilDepthPass)
void depthTestFailureOperationChanged(Operation depthFail)
void faceModeChanged(FaceMode faceMode)
void stencilTestFailureOperationChanged(Operation stencilFail)

Detailed Description

The Qt3DRender::QStencilOperationArguments class specifies the arguments for the stencil operations.

See also Qt3DRender::QStencilOperation.

Member Type Documentation

enum QStencilOperationArguments::FaceMode

This enumeration holds the values for stencil operation argument face modes

ConstantValueDescription
Qt3DRender::QStencilOperationArguments::Front0x0404Arguments are applied to front-facing polygons.
Qt3DRender::QStencilOperationArguments::Back0x0405Arguments are applied to back-facing polygons.
Qt3DRender::QStencilOperationArguments::FrontAndBack0x0408Arguments are applied to both front- and back-facing polygons.

enum QStencilOperationArguments::Operation

This enumeration holds the values for stencil operation.

ConstantValueDescription
Qt3DRender::QStencilOperationArguments::Zero0Set stencil value to zero.
Qt3DRender::QStencilOperationArguments::Keep0x1E00Keep current stencil value.
Qt3DRender::QStencilOperationArguments::Replace0x1E01Replace with the masked fragment stencil value.
Qt3DRender::QStencilOperationArguments::Increment0x1E02Increment current value with saturation.
Qt3DRender::QStencilOperationArguments::Decrement0x1E03Decrement current value with saturation.
Qt3DRender::QStencilOperationArguments::IncrementWrap0x8507Increment current value with wrap.
Qt3DRender::QStencilOperationArguments::DecrementWrap0x8508Decrement current value with wrap.
Qt3DRender::QStencilOperationArguments::Invert0x150AInvert the current value.

Property Documentation

allTestsPassOperation : Operation

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

Access functions:

Operation allTestsPassOperation() const
void setAllTestsPassOperation(Operation operation)

Notifier signal:

void allTestsPassOperationChanged(Operation stencilDepthPass)

depthTestFailureOperation : Operation

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

Access functions:

Operation depthTestFailureOperation() const
void setDepthTestFailureOperation(Operation operation)

Notifier signal:

void depthTestFailureOperationChanged(Operation depthFail)

faceMode : const FaceMode

Holds the faces the arguments are applied to.

Access functions:

FaceMode faceMode() const

Notifier signal:

void faceModeChanged(FaceMode faceMode)

stencilTestFailureOperation : Operation

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

Access functions:

Operation stencilTestFailureOperation() const
void setStencilTestFailureOperation(Operation operation)

Notifier signal:

void stencilTestFailureOperationChanged(Operation stencilFail)