1 /****************************************************************************
2 **
3 ** Copyright (C) 2017 Klaralvdalens Datakonsult AB (KDAB).
4 ** Contact: https://www.qt.io/licensing/
5 **
6 ** This file is part of the QtGui 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 QSHADERNODE_P_H
41 #define QSHADERNODE_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 purely as an
48 // implementation detail.  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 <QtGui/private/qtguiglobal_p.h>
55 
56 #include <QtGui/private/qshaderformat_p.h>
57 #include <QtGui/private/qshadernodeport_p.h>
58 
59 #include <QtCore/quuid.h>
60 
61 QT_BEGIN_NAMESPACE
62 
63 class QShaderNode
64 {
65 public:
66     enum Type : char {
67         Invalid,
68         Input,
69         Output,
70         Function
71     };
72 
73     class Rule
74     {
75     public:
76         Q_GUI_EXPORT Rule(const QByteArray &substitution = QByteArray(), const QByteArrayList &headerSnippets = QByteArrayList()) noexcept;
77 
78         QByteArray substitution;
79         QByteArrayList headerSnippets;
80     };
81 
82     Q_GUI_EXPORT Type type() const noexcept;
83 
84     Q_GUI_EXPORT QUuid uuid() const noexcept;
85     Q_GUI_EXPORT void setUuid(const QUuid &uuid) noexcept;
86 
87     Q_GUI_EXPORT QStringList layers() const noexcept;
88     Q_GUI_EXPORT void setLayers(const QStringList &layers) noexcept;
89 
90     Q_GUI_EXPORT QVector<QShaderNodePort> ports() const noexcept;
91     Q_GUI_EXPORT void addPort(const QShaderNodePort &port);
92     Q_GUI_EXPORT void removePort(const QShaderNodePort &port);
93 
94     Q_GUI_EXPORT QStringList parameterNames() const;
95     Q_GUI_EXPORT QVariant parameter(const QString &name) const;
96     Q_GUI_EXPORT void setParameter(const QString &name, const QVariant &value);
97     Q_GUI_EXPORT void clearParameter(const QString &name);
98 
99     Q_GUI_EXPORT void addRule(const QShaderFormat &format, const Rule &rule);
100     Q_GUI_EXPORT void removeRule(const QShaderFormat &format);
101 
102     Q_GUI_EXPORT QVector<QShaderFormat> availableFormats() const;
103     Q_GUI_EXPORT Rule rule(const QShaderFormat &format) const;
104 
105 private:
106     QUuid m_uuid;
107     QStringList m_layers;
108     QVector<QShaderNodePort> m_ports;
109     QHash<QString, QVariant> m_parameters;
110     QVector<QPair<QShaderFormat, QShaderNode::Rule>> m_rules;
111 };
112 
113 Q_GUI_EXPORT bool operator==(const QShaderNode::Rule &lhs, const QShaderNode::Rule &rhs) noexcept;
114 
115 inline bool operator!=(const QShaderNode::Rule &lhs, const QShaderNode::Rule &rhs) noexcept
116 {
117     return !(lhs == rhs);
118 }
119 
120 Q_DECLARE_TYPEINFO(QShaderNode, Q_MOVABLE_TYPE);
121 Q_DECLARE_TYPEINFO(QShaderNode::Rule, Q_MOVABLE_TYPE);
122 
123 QT_END_NAMESPACE
124 
125 Q_DECLARE_METATYPE(QShaderNode)
126 Q_DECLARE_METATYPE(QShaderNode::Rule)
127 
128 #endif // QSHADERNODE_P_H
129