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 QSGRENDERNODE_H
41#define QSGRENDERNODE_H
42
43#include <QtQuick/qsgnode.h>
44
45QT_BEGIN_NAMESPACE
46
47class QSGRenderNodePrivate;
48
49class Q_QUICK_EXPORT QSGRenderNode : public QSGNode
50{
51public:
52 enum StateFlag {
53 DepthState = 0x01,
54 StencilState = 0x02,
55 ScissorState = 0x04,
56 ColorState = 0x08,
57 BlendState = 0x10,
58 CullState = 0x20,
59 ViewportState = 0x40,
60 RenderTargetState = 0x80
61 };
62 Q_DECLARE_FLAGS(StateFlags, StateFlag)
63
64 enum RenderingFlag {
65 BoundedRectRendering = 0x01,
66 DepthAwareRendering = 0x02,
67 OpaqueRendering = 0x04
68 };
69 Q_DECLARE_FLAGS(RenderingFlags, RenderingFlag)
70
71 struct Q_QUICK_EXPORT RenderState {
72 virtual ~RenderState();
73 virtual const QMatrix4x4 *projectionMatrix() const = 0;
74 virtual QRect scissorRect() const = 0;
75 virtual bool scissorEnabled() const = 0;
76 virtual int stencilValue() const = 0;
77 virtual bool stencilEnabled() const = 0;
78 virtual const QRegion *clipRegion() const = 0;
79 virtual void *get(const char *state) const;
80 };
81
82 QSGRenderNode();
83 ~QSGRenderNode() override;
84
85 virtual StateFlags changedStates() const;
86 virtual void render(const RenderState *state) = 0;
87 virtual void releaseResources();
88 virtual RenderingFlags flags() const;
89 virtual QRectF rect() const;
90
91 const QMatrix4x4 *matrix() const;
92 const QSGClipNode *clipList() const;
93 qreal inheritedOpacity() const;
94
95private:
96 QSGRenderNodePrivate *d;
97 friend class QSGRenderNodePrivate;
98};
99
100Q_DECLARE_OPERATORS_FOR_FLAGS(QSGRenderNode::StateFlags)
101Q_DECLARE_OPERATORS_FOR_FLAGS(QSGRenderNode::RenderingFlags)
102
103QT_END_NAMESPACE
104
105#endif
106