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_RENDER_CLEARBUFFERS_P_H
41#define QT3DRENDER_RENDER_CLEARBUFFERS_P_H
42
43//
44// W A R N I N G
45// -------------
46//
47// This file is not part of the Qt API. It exists for the convenience
48// of other Qt classes. This header file may change from version to
49// version without notice, or even be removed.
50//
51// We mean it.
52//
53
54#include <Qt3DRender/private/framegraphnode_p.h>
55#include <Qt3DRender/qclearbuffers.h>
56
57QT_BEGIN_NAMESPACE
58
59namespace Qt3DRender {
60
61namespace Render {
62
63class FrameGraphManager;
64
65class ClearBuffers : public FrameGraphNode
66{
67public:
68 ClearBuffers();
69
70 void sceneChangeEvent(const Qt3DCore::QSceneChangePtr &e) override;
71
72 QClearBuffers::BufferType type() const;
73 float clearDepthValue() const;
74 int clearStencilValue() const;
75 Qt3DCore::QNodeId bufferId() const;
76
77 // in the backend we store this as a QVector4D, as the clearBuffer
78 // functions do support all float values (also those not clamped to [0,1])
79 // (for non-clamped float or int buffer types)
80 // we don't support this in the frontend yet, but let's keep our options for now
81 // and avoid QColor->QVector4D conversion every frame.
82 QVector4D clearColor() const;
83
84 // some clear operations only accept clamped values
85 QColor clearColorAsColor() const;
86
87 bool clearsAllColorBuffers() const;
88
89private:
90 void initializeFromPeer(const Qt3DCore::QNodeCreatedChangeBasePtr &change) final;
91
92 QClearBuffers::BufferType m_type;
93 QVector4D m_clearColor;
94 QColor m_clearColorAsColor;
95 float m_clearDepthValue;
96 int m_clearStencilValue;
97 Qt3DCore::QNodeId m_colorBufferId;
98};
99
100} // namespace Render
101
102} // namespace Qt3DRender
103
104QT_END_NAMESPACE
105
106#endif // QT3DRENDER_RENDER_CLEARBUFFERS_P_H
107