1/****************************************************************************
2**
3** Copyright (C) 2016 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the QtQuick 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 QSGABSTRACTRENDERER_H
41#define QSGABSTRACTRENDERER_H
42
43#include <QtQuick/qsgnode.h>
44
45#ifndef GLuint
46#define GLuint uint
47#endif
48
49QT_BEGIN_NAMESPACE
50
51class QSGAbstractRendererPrivate;
52
53class Q_QUICK_EXPORT QSGAbstractRenderer : public QObject
54{
55 Q_OBJECT
56public:
57 enum ClearModeBit
58 {
59 ClearColorBuffer = 0x0001,
60 ClearDepthBuffer = 0x0002,
61 ClearStencilBuffer = 0x0004
62 };
63 Q_DECLARE_FLAGS(ClearMode, ClearModeBit)
64 Q_FLAG(ClearMode)
65
66 ~QSGAbstractRenderer() override;
67
68 void setRootNode(QSGRootNode *node);
69 QSGRootNode *rootNode() const;
70 void setDeviceRect(const QRect &rect);
71 inline void setDeviceRect(const QSize &size) { setDeviceRect(QRect(QPoint(), size)); }
72 QRect deviceRect() const;
73
74 void setViewportRect(const QRect &rect);
75 inline void setViewportRect(const QSize &size) { setViewportRect(QRect(QPoint(), size)); }
76 QRect viewportRect() const;
77
78 void setProjectionMatrixToRect(const QRectF &rect, bool flipY = false);
79 void setProjectionMatrix(const QMatrix4x4 &matrix);
80 void setProjectionMatrixWithNativeNDC(const QMatrix4x4 &matrix);
81 QMatrix4x4 projectionMatrix() const;
82 QMatrix4x4 projectionMatrixWithNativeNDC() const;
83
84 void setClearColor(const QColor &color);
85 QColor clearColor() const;
86
87 void setClearMode(ClearMode mode);
88 ClearMode clearMode() const;
89
90 virtual void renderScene(GLuint fboId = 0) = 0;
91
92Q_SIGNALS:
93 void sceneGraphChanged();
94
95protected:
96 explicit QSGAbstractRenderer(QObject *parent = nullptr);
97 virtual void nodeChanged(QSGNode *node, QSGNode::DirtyState state) = 0;
98
99private:
100 Q_DECLARE_PRIVATE(QSGAbstractRenderer)
101 friend class QSGRootNode;
102};
103
104Q_DECLARE_OPERATORS_FOR_FLAGS(QSGAbstractRenderer::ClearMode)
105
106QT_END_NAMESPACE
107
108#endif
109