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 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_SHADERBUILDER_H
41 #define QT3DRENDER_RENDER_SHADERBUILDER_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/qshaderprogram.h>
55 #include <Qt3DRender/private/backendnode_p.h>
56 #include <Qt3DRender/private/qgraphicsapifilter_p.h>
57 
58 QT_BEGIN_NAMESPACE
59 
60 namespace Qt3DRender {
61 
62 namespace Render {
63 
64 struct ShaderBuilderUpdate
65 {
66     Qt3DCore::QNodeId builderId;
67     Qt3DRender::QShaderProgram::ShaderType shaderType;
68     QByteArray shaderCode;
69 };
70 
71 class Q_3DRENDERSHARED_PRIVATE_EXPORT ShaderBuilder : public BackendNode
72 {
73 public:
74     static QString getPrototypesFile();
75     static void setPrototypesFile(const QString &file);
76     static QStringList getPrototypeNames();
77 
78     ShaderBuilder();
79     ~ShaderBuilder();
80     void cleanup();
81 
82     Qt3DCore::QNodeId shaderProgramId() const;
83     QStringList enabledLayers() const;
84 
85     GraphicsApiFilterData graphicsApi() const;
86     void setGraphicsApi(const GraphicsApiFilterData &graphicsApi);
87 
88     QUrl shaderGraph(QShaderProgram::ShaderType type) const;
89     void setShaderGraph(QShaderProgram::ShaderType type, const QUrl &url);
90 
91     QByteArray shaderCode(QShaderProgram::ShaderType type) const;
92     bool isShaderCodeDirty(QShaderProgram::ShaderType type) const;
93 
94     void generateCode(QShaderProgram::ShaderType type);
95 
96     void syncFromFrontEnd(const Qt3DCore::QNode *frontEnd, bool firstTime) override;
97 
takePendingUpdates()98     QVector<ShaderBuilderUpdate> takePendingUpdates() { return std::move(m_pendingUpdates); }
99 
100     QByteArray hashKeyForShaderGraph(QShaderProgram::ShaderType type) const;
101 
102 private:
103     void setEnabledLayers(const QStringList &layers);
104 
105     GraphicsApiFilterData m_graphicsApi;
106     Qt3DCore::QNodeId m_shaderProgramId;
107     QStringList m_enabledLayers;
108     QHash<QShaderProgram::ShaderType, QUrl> m_graphs;
109     QHash<QShaderProgram::ShaderType, QByteArray> m_codes;
110     QSet<QShaderProgram::ShaderType> m_dirtyTypes;
111     QVector<ShaderBuilderUpdate> m_pendingUpdates;
112 };
113 
114 } // namespace Render
115 } // namespace Qt3DRender
116 
117 QT_END_NAMESPACE
118 
119 #endif // QT3DRENDER_RENDER_SHADERBUILDER_H
120