QStencilTestArguments Class
class Qt3DRender::QStencilTestArgumentsThe QStencilTestArguments class specifies arguments for stencil test. More...
| Header: | #include <QStencilTestArguments> |
| qmake: | QT += 3drender |
| Since: | Qt 5.7 |
| Instantiated By: | StencilTestArguments |
| Inherits: | QObject |
This class was introduced in Qt 5.7.
Public Types
| enum | StencilFaceMode { Front, Back, FrontAndBack } |
| enum | StencilFunction { Never, Always, Less, LessOrEqual, Equal, …, NotEqual } |
Properties
- comparisonMask : uint
- faceMode : const StencilFaceMode
- referenceValue : int
- stencilFunction : StencilFunction
Public Functions
| uint | comparisonMask() const |
| StencilFaceMode | faceMode() const |
| int | referenceValue() const |
| StencilFunction | stencilFunction() const |
Public Slots
| void | setComparisonMask(uint comparisonMask) |
| void | setReferenceValue(int referenceValue) |
| void | setStencilFunction(StencilFunction stencilFunction) |
Signals
| void | comparisonMaskChanged(uint comparisonMask) |
| void | faceModeChanged(StencilFaceMode faceMode) |
| void | referenceValueChanged(int referenceValue) |
| void | stencilFunctionChanged(StencilFunction stencilFunction) |
Detailed Description
The Qt3DRender::QStencilTestArguments class specifies the arguments for the stencil test.
Member Type Documentation
enum QStencilTestArguments::StencilFaceMode
This enumeration holds the values for stencil test arguments face modes
| Constant | Value | Description |
|---|---|---|
Qt3DRender::QStencilTestArguments::Front | 0x0404 | Arguments are applied to front-facing polygons. |
Qt3DRender::QStencilTestArguments::Back | 0x0405 | Arguments are applied to back-facing polygons. |
Qt3DRender::QStencilTestArguments::FrontAndBack | 0x0408 | Arguments are applied to both front- and back-facing polygons. |
enum QStencilTestArguments::StencilFunction
Enumeration for the stencil function values
| Constant | Value | Description |
|---|---|---|
Qt3DRender::QStencilTestArguments::Never | 0x0200 | Never pass stencil test |
Qt3DRender::QStencilTestArguments::Always | 0x0207 | Always pass stencil test |
Qt3DRender::QStencilTestArguments::Less | 0x0201 | Pass stencil test if fragment stencil is less than reference value |
Qt3DRender::QStencilTestArguments::LessOrEqual | 0x0203 | Pass stencil test if fragment stencil is less than or equal to reference value |
Qt3DRender::QStencilTestArguments::Equal | 0x0202 | Pass stencil test if fragment stencil is equal to reference value |
Qt3DRender::QStencilTestArguments::GreaterOrEqual | 0x0206 | Pass stencil test if fragment stencil is greater than or equal to reference value |
Qt3DRender::QStencilTestArguments::Greater | 0x0204 | Pass stencil test if fragment stencil is greater than reference value |
Qt3DRender::QStencilTestArguments::NotEqual | 0x0205 | Pass stencil test if fragment stencil is not equal to reference value |
Property Documentation
comparisonMask : uint
Holds the stencil test comparison mask. Default is all zeroes.
Access functions:
| uint | comparisonMask() const |
| void | setComparisonMask(uint comparisonMask) |
Notifier signal:
| void | comparisonMaskChanged(uint comparisonMask) |
faceMode : const StencilFaceMode
Holds the faces the arguments are applied to.
Access functions:
| StencilFaceMode | faceMode() const |
Notifier signal:
| void | faceModeChanged(StencilFaceMode faceMode) |
referenceValue : int
Holds the stencil test reference value. Default is zero.
Access functions:
| int | referenceValue() const |
| void | setReferenceValue(int referenceValue) |
Notifier signal:
| void | referenceValueChanged(int referenceValue) |
stencilFunction : StencilFunction
Holds the stencil test function. Default is Never.
Access functions:
| StencilFunction | stencilFunction() const |
| void | setStencilFunction(StencilFunction stencilFunction) |
Notifier signal:
| void | stencilFunctionChanged(StencilFunction stencilFunction) |
See also Qt3DRender::QStencilTestArguments::StencilFunction.