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_QSHADERPROGRAM_H
41#define QT3DRENDER_QSHADERPROGRAM_H
42
43#include <Qt3DCore/qnode.h>
44#include <Qt3DRender/qt3drender_global.h>
45
46QT_BEGIN_NAMESPACE
47
48namespace Qt3DRender {
49
50class QShaderProgramPrivate;
51
52class Q_3DRENDERSHARED_EXPORT QShaderProgram : public Qt3DCore::QNode
53{
54 Q_OBJECT
55 Q_PROPERTY(QByteArray vertexShaderCode READ vertexShaderCode WRITE setVertexShaderCode NOTIFY vertexShaderCodeChanged)
56 Q_PROPERTY(QByteArray tessellationControlShaderCode READ tessellationControlShaderCode WRITE setTessellationControlShaderCode NOTIFY tessellationControlShaderCodeChanged)
57 Q_PROPERTY(QByteArray tessellationEvaluationShaderCode READ tessellationEvaluationShaderCode WRITE setTessellationEvaluationShaderCode NOTIFY tessellationEvaluationShaderCodeChanged)
58 Q_PROPERTY(QByteArray geometryShaderCode READ geometryShaderCode WRITE setGeometryShaderCode NOTIFY geometryShaderCodeChanged)
59 Q_PROPERTY(QByteArray fragmentShaderCode READ fragmentShaderCode WRITE setFragmentShaderCode NOTIFY fragmentShaderCodeChanged)
60 Q_PROPERTY(QByteArray computeShaderCode READ computeShaderCode WRITE setComputeShaderCode NOTIFY computeShaderCodeChanged)
61 Q_PROPERTY(QString log READ log NOTIFY logChanged REVISION 9)
62 Q_PROPERTY(Status status READ status NOTIFY statusChanged REVISION 9)
63 Q_PROPERTY(Format format READ format WRITE setFormat NOTIFY formatChanged REVISION 15)
64
65public:
66 explicit QShaderProgram(Qt3DCore::QNode *parent = nullptr);
67 ~QShaderProgram();
68
69 enum ShaderType {
70 Vertex = 0,
71 Fragment,
72 TessellationControl,
73 TessellationEvaluation,
74 Geometry,
75 Compute
76 };
77 Q_ENUM(ShaderType) // LCOV_EXCL_LINE
78
79 enum Status {
80 NotReady = 0,
81 Ready,
82 Error
83 };
84 Q_ENUM(Status) // LCOV_EXCL_LINE
85
86 enum Format {
87 GLSL = 0,
88 SPIRV
89 };
90 Q_ENUM(Format) // LCOV_EXCL_LINE
91
92 // Source code in-line
93 QByteArray vertexShaderCode() const;
94 QByteArray tessellationControlShaderCode() const;
95 QByteArray tessellationEvaluationShaderCode() const;
96 QByteArray geometryShaderCode() const;
97 QByteArray fragmentShaderCode() const;
98 QByteArray computeShaderCode() const;
99
100 void setShaderCode(ShaderType type, const QByteArray &shaderCode);
101 QByteArray shaderCode(ShaderType type) const;
102
103 QString log() const;
104 Status status() const;
105
106 void setFormat(Format format);
107 Format format() const;
108
109 Q_INVOKABLE static QByteArray loadSource(const QUrl &sourceUrl);
110
111public Q_SLOTS:
112 void setVertexShaderCode(const QByteArray &vertexShaderCode);
113 void setTessellationControlShaderCode(const QByteArray &tessellationControlShaderCode);
114 void setTessellationEvaluationShaderCode(const QByteArray &tessellationEvaluationShaderCode);
115 void setGeometryShaderCode(const QByteArray &geometryShaderCode);
116 void setFragmentShaderCode(const QByteArray &fragmentShaderCode);
117 void setComputeShaderCode(const QByteArray &computeShaderCode);
118
119Q_SIGNALS:
120 void vertexShaderCodeChanged(const QByteArray &vertexShaderCode);
121 void tessellationControlShaderCodeChanged(const QByteArray &tessellationControlShaderCode);
122 void tessellationEvaluationShaderCodeChanged(const QByteArray &tessellationEvaluationShaderCode);
123 void geometryShaderCodeChanged(const QByteArray &geometryShaderCode);
124 void fragmentShaderCodeChanged(const QByteArray &fragmentShaderCode);
125 void computeShaderCodeChanged(const QByteArray &computeShaderCode);
126 void logChanged(const QString &log);
127 void statusChanged(Status status);
128 void formatChanged(Format format);
129
130protected:
131 explicit QShaderProgram(QShaderProgramPrivate &dd, Qt3DCore::QNode *parent = nullptr);
132 void sceneChangeEvent(const Qt3DCore::QSceneChangePtr &change) override;
133
134private:
135 Q_DECLARE_PRIVATE(QShaderProgram)
136 Qt3DCore::QNodeCreatedChangeBasePtr createNodeCreationChange() const override;
137};
138
139}
140
141QT_END_NAMESPACE
142
143#endif // QT3DRENDER_QSHADERPROGRAM_H
144

source code of qt3d/src/render/materialsystem/qshaderprogram.h