1/****************************************************************************
2**
3** Copyright (C) 2014 Klaralvdalens Datakonsult AB (KDAB).
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_QCLEARBUFFERS_H
41#define QT3DRENDER_QCLEARBUFFERS_H
42
43#include <Qt3DRender/qframegraphnode.h>
44#include <Qt3DRender/qrendertargetoutput.h>
45#include <QtGui/QColor>
46#include <QtCore/QFlags>
47
48QT_BEGIN_NAMESPACE
49
50namespace Qt3DRender {
51
52class QClearBuffersPrivate;
53
54class Q_3DRENDERSHARED_EXPORT QClearBuffers : public QFrameGraphNode
55{
56 Q_OBJECT
57 Q_PROPERTY(BufferType buffers READ buffers WRITE setBuffers NOTIFY buffersChanged)
58 Q_PROPERTY(QColor clearColor READ clearColor WRITE setClearColor NOTIFY clearColorChanged)
59 Q_PROPERTY(float clearDepthValue READ clearDepthValue WRITE setClearDepthValue NOTIFY clearDepthValueChanged)
60 Q_PROPERTY(int clearStencilValue READ clearStencilValue WRITE setClearStencilValue NOTIFY clearStencilValueChanged)
61 Q_PROPERTY(Qt3DRender::QRenderTargetOutput* colorBuffer READ colorBuffer WRITE setColorBuffer NOTIFY colorBufferChanged)
62
63public:
64 explicit QClearBuffers(Qt3DCore::QNode *parent = nullptr);
65 ~QClearBuffers();
66
67 enum BufferType {
68 None = 0,
69 ColorBuffer = (1 << 0),
70 DepthBuffer = (1 << 1),
71 StencilBuffer = (1 << 2),
72 DepthStencilBuffer = DepthBuffer | StencilBuffer,
73 ColorDepthBuffer = ColorBuffer | DepthBuffer,
74 ColorDepthStencilBuffer = ColorBuffer | DepthStencilBuffer,
75 AllBuffers = 0xFFFFFFFF
76 };
77 Q_ENUM(BufferType) // LCOV_EXCL_LINE
78 Q_DECLARE_FLAGS(BufferTypeFlags, BufferType)
79
80 BufferType buffers() const;
81 QColor clearColor() const;
82 float clearDepthValue() const;
83 int clearStencilValue() const;
84 QRenderTargetOutput *colorBuffer() const;
85
86public Q_SLOTS:
87 void setBuffers(BufferType buffers);
88 void setClearColor(const QColor& color);
89 void setClearDepthValue(float clearDepthValue);
90 void setClearStencilValue(int clearStencilValue);
91 void setColorBuffer(QRenderTargetOutput *buffer);
92
93Q_SIGNALS:
94 void buffersChanged(BufferType buffers);
95 void clearColorChanged(const QColor& color);
96 void clearDepthValueChanged(float clearDepthValue);
97 void clearStencilValueChanged(int clearStencilValue);
98 void colorBufferChanged(QRenderTargetOutput *buffer);
99
100protected:
101 explicit QClearBuffers(QClearBuffersPrivate &dd, Qt3DCore::QNode *parent = nullptr);
102
103private:
104 Q_DECLARE_PRIVATE(QClearBuffers)
105 Qt3DCore::QNodeCreatedChangeBasePtr createNodeCreationChange() const override;
106};
107
108} // namespace Qt3DRender
109
110QT_END_NAMESPACE
111
112#endif // QT3DRENDER_QCLEARBUFFERS_H
113