1/****************************************************************************
2**
3** Copyright (C) 2015 Paul Lemire
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the Qt3D module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/contact-us.
16**
17** GNU Lesser General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU Lesser
19** General Public License version 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40#ifndef QT3DRENDER_QSTENCILTESTARGUMENTS_H
41#define QT3DRENDER_QSTENCILTESTARGUMENTS_H
42
43#include <QtCore/QObject>
44#include <Qt3DRender/qt3drender_global.h>
45
46QT_BEGIN_NAMESPACE
47
48namespace Qt3DRender {
49
50class QStencilTestPrivate;
51class QStencilTestArgumentsPrivate;
52
53class Q_3DRENDERSHARED_EXPORT QStencilTestArguments : public QObject
54{
55 Q_OBJECT
56 Q_PROPERTY(StencilFaceMode faceMode READ faceMode NOTIFY faceModeChanged)
57 Q_PROPERTY(uint comparisonMask READ comparisonMask WRITE setComparisonMask NOTIFY comparisonMaskChanged)
58 Q_PROPERTY(int referenceValue READ referenceValue WRITE setReferenceValue NOTIFY referenceValueChanged)
59 Q_PROPERTY(StencilFunction stencilFunction READ stencilFunction WRITE setStencilFunction NOTIFY stencilFunctionChanged)
60
61public:
62 enum StencilFaceMode
63 {
64 Front = 0x0404,
65 Back = 0x0405,
66 FrontAndBack = 0x0408
67 };
68 Q_ENUM(StencilFaceMode) // LCOV_EXCL_LINE
69
70 enum StencilFunction
71 {
72 Never = 0x0200,
73 Always = 0x0207,
74 Less = 0x0201,
75 LessOrEqual = 0x0203,
76 Equal = 0x0202,
77 GreaterOrEqual = 0x0206,
78 Greater = 0x0204,
79 NotEqual = 0x0205
80 };
81 Q_ENUM(StencilFunction) // LCOV_EXCL_LINE
82
83 ~QStencilTestArguments();
84
85 uint comparisonMask() const;
86 int referenceValue() const;
87 StencilFunction stencilFunction() const;
88
89 StencilFaceMode faceMode() const;
90
91public Q_SLOTS:
92 void setComparisonMask(uint comparisonMask);
93 void setReferenceValue(int referenceValue);
94 void setStencilFunction(StencilFunction stencilFunction);
95
96Q_SIGNALS:
97 void comparisonMaskChanged(uint comparisonMask);
98 void stencilFunctionChanged(StencilFunction stencilFunction);
99 void referenceValueChanged(int referenceValue);
100 void faceModeChanged(StencilFaceMode faceMode);
101
102private:
103 explicit QStencilTestArguments(StencilFaceMode face, QObject *parent = nullptr);
104
105 friend class QStencilTestPrivate;
106
107 Q_DECLARE_PRIVATE(QStencilTestArguments)
108};
109
110} // namespace Qt3DRender
111
112QT_END_NAMESPACE
113
114#endif // QT3DRENDER_QSTENCILTESTARGUMENTS_H
115

source code of qt3d/src/render/renderstates/qstenciltestarguments.h