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
64public:
65 explicit QShaderProgram(Qt3DCore::QNode *parent = nullptr);
66 ~QShaderProgram();
67
68 enum ShaderType {
69 Vertex = 0,
70 Fragment,
71 TessellationControl,
72 TessellationEvaluation,
73 Geometry,
74 Compute
75 };
76 Q_ENUM(ShaderType) // LCOV_EXCL_LINE
77
78 enum Status {
79 NotReady = 0,
80 Ready,
81 Error
82 };
83 Q_ENUM(Status) // LCOV_EXCL_LINE
84
85 // Source code in-line
86 QByteArray vertexShaderCode() const;
87 QByteArray tessellationControlShaderCode() const;
88 QByteArray tessellationEvaluationShaderCode() const;
89 QByteArray geometryShaderCode() const;
90 QByteArray fragmentShaderCode() const;
91 QByteArray computeShaderCode() const;
92
93 void setShaderCode(ShaderType type, const QByteArray &shaderCode);
94 QByteArray shaderCode(ShaderType type) const;
95
96 QString log() const;
97 Status status() const;
98
99 Q_INVOKABLE static QByteArray loadSource(const QUrl &sourceUrl);
100
101public Q_SLOTS:
102 void setVertexShaderCode(const QByteArray &vertexShaderCode);
103 void setTessellationControlShaderCode(const QByteArray &tessellationControlShaderCode);
104 void setTessellationEvaluationShaderCode(const QByteArray &tessellationEvaluationShaderCode);
105 void setGeometryShaderCode(const QByteArray &geometryShaderCode);
106 void setFragmentShaderCode(const QByteArray &fragmentShaderCode);
107 void setComputeShaderCode(const QByteArray &computeShaderCode);
108
109Q_SIGNALS:
110 void vertexShaderCodeChanged(const QByteArray &vertexShaderCode);
111 void tessellationControlShaderCodeChanged(const QByteArray &tessellationControlShaderCode);
112 void tessellationEvaluationShaderCodeChanged(const QByteArray &tessellationEvaluationShaderCode);
113 void geometryShaderCodeChanged(const QByteArray &geometryShaderCode);
114 void fragmentShaderCodeChanged(const QByteArray &fragmentShaderCode);
115 void computeShaderCodeChanged(const QByteArray &computeShaderCode);
116 void logChanged(const QString &log);
117 void statusChanged(Status status);
118
119protected:
120 explicit QShaderProgram(QShaderProgramPrivate &dd, Qt3DCore::QNode *parent = nullptr);
121 void sceneChangeEvent(const Qt3DCore::QSceneChangePtr &change) override;
122
123private:
124 Q_DECLARE_PRIVATE(QShaderProgram)
125 Qt3DCore::QNodeCreatedChangeBasePtr createNodeCreationChange() const override;
126};
127
128}
129
130QT_END_NAMESPACE
131
132#endif // QT3DRENDER_QSHADERPROGRAM_H
133