QStencilTestArguments Class

(Qt3DRender::QStencilTestArguments)

The QStencilTestArguments class specifies arguments for stencil test More...

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

Public Types

enum StencilFaceMode { Front, Back, FrontAndBack }
enum StencilFunction { Never, Always, Less, LessOrEqual, ..., NotEqual }

Properties

  • 1 property inherited from QObject

Public Functions

uint comparisonMask() const
StencilFaceMode faceMode() const
int referenceValue() const
StencilFunction stencilFunction() const
  • 32 public functions inherited from QObject

Public Slots

void setComparisonMask(uint comparisonMask)
void setReferenceValue(int referenceValue)
void setStencilFunction(StencilFunction stencilFunction)
  • 1 public slot inherited from QObject

Signals

void comparisonMaskChanged(uint comparisonMask)
void faceModeChanged(StencilFaceMode faceMode)
void referenceValueChanged(int referenceValue)
void stencilFunctionChanged(StencilFunction stencilFunction)

Additional Inherited Members

  • 11 static public members inherited from QObject
  • 9 protected functions inherited from QObject

Detailed Description

The QStencilTestArguments class specifies arguments for stencil test

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

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

enum QStencilTestArguments::StencilFunction

Enumeration for the stencil function values

ConstantValueDescription
Qt3DRender::QStencilTestArguments::Never0x0200Never pass stencil test
Qt3DRender::QStencilTestArguments::Always0x0207Always pass stencil test
Qt3DRender::QStencilTestArguments::Less0x0201Pass stencil test if fragment stencil is less than reference value
Qt3DRender::QStencilTestArguments::LessOrEqual0x0203Pass stencil test if fragment stencil is less than or equal to reference value
Qt3DRender::QStencilTestArguments::Equal0x0202Pass stencil test if fragment stencil is equal to reference value
Qt3DRender::QStencilTestArguments::GreaterOrEqual0x0206Pass stencil test if fragment stencil is greater than or equal to reference value
Qt3DRender::QStencilTestArguments::Greater0x0204Pass stencil test if fragment stencil is greater than reference value
Qt3DRender::QStencilTestArguments::NotEqual0x0205Pass 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.

© 2017 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.