QStencilMask Class

(Qt3DRender::QStencilMask)

The QStencilMask class controls the front and back writing of individual bits in the stencil planes. More...

Header: #include <QStencilMask>
qmake: QT += 3drender
Since: Qt 5.7
Instantiated By: StencilMask
Inherits: Qt3DRender::QRenderState

Properties

Public Functions

QStencilMask(Qt3DCore::QNode *parent = nullptr)
uint backOutputMask() const
uint frontOutputMask() const

Public Slots

void setBackOutputMask(uint backOutputMask)
void setFrontOutputMask(uint frontOutputMask)

Signals

void backOutputMaskChanged(uint backOutputMask)
void frontOutputMaskChanged(uint frontOutputMask)

Additional Inherited Members

  • 1 public variable inherited from QObject
  • 10 static public members inherited from QObject
  • 2 protected functions inherited from Qt3DCore::QNode
  • 9 protected functions inherited from QObject
  • 2 protected variables inherited from QObject

Detailed Description

The QStencilMask class controls the front and back writing of individual bits in the stencil planes.

A Qt3DRender::QStencilMask class specifies a write mask for the stencil values after the stencil test. Mask can be specified separately for the front-facing and back-facing polygons. The fragment stencil value is and'd with the mask before it is written to the stencil buffer.

See also Qt3DRender::QStencilTest.

Property Documentation

backOutputMask : uint

Holds the write mask for the fragment stencil values for back-facing polygons.

Access functions:

uint backOutputMask() const
void setBackOutputMask(uint backOutputMask)

Notifier signal:

void backOutputMaskChanged(uint backOutputMask)

frontOutputMask : uint

Holds the write mask for the fragment stencil values for front-facing polygons.

Access functions:

uint frontOutputMask() const
void setFrontOutputMask(uint frontOutputMask)

Notifier signal:

void frontOutputMaskChanged(uint frontOutputMask)

Member Function Documentation

QStencilMask::QStencilMask(Qt3DCore::QNode *parent = nullptr)

The constructor creates a new QStencilMask::QStencilMask instance with the specified parent.

© 2019 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.