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_RENDER_SHADER_H
41#define QT3DRENDER_RENDER_SHADER_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/private/backendnode_p.h>
55#include <Qt3DRender/qshaderprogram.h>
56#include <QVector>
57
58QT_BEGIN_NAMESPACE
59
60class QOpenGLShaderProgram;
61
62namespace Qt3DRender {
63
64namespace Render {
65
66class ShaderManager;
67class AttachmentPack;
68
69class Q_3DRENDERSHARED_PRIVATE_EXPORT Shader : public BackendNode
70{
71public:
72 static const int modelMatrixNameId;
73 static const int viewMatrixNameId;
74 static const int projectionMatrixNameId;
75 static const int modelViewMatrixNameId;
76 static const int viewProjectionMatrixNameId;
77 static const int modelViewProjectionNameId;
78 static const int mvpNameId;
79 static const int inverseModelMatrixNameId;
80 static const int inverseViewMatrixNameId;
81 static const int inverseProjectionMatrixNameId;
82 static const int inverseModelViewNameId;
83 static const int inverseViewProjectionMatrixNameId;
84 static const int inverseModelViewProjectionNameId;
85 static const int modelNormalMatrixNameId;
86 static const int modelViewNormalNameId;
87 static const int viewportMatrixNameId;
88 static const int inverseViewportMatrixNameId;
89 static const int textureTransformMatrixNameId;
90 static const int aspectRatioNameId;
91 static const int exposureNameId;
92 static const int gammaNameId;
93 static const int timeNameId;
94 static const int eyePositionNameId;
95 static const int skinningPaletteNameId;
96
97 Shader();
98 ~Shader();
99
100 void cleanup();
101
102 QVector<QByteArray> shaderCode() const;
103 void setShaderCode(QShaderProgram::ShaderType type, const QByteArray &code);
104
105 void syncFromFrontEnd(const Qt3DCore::QNode *frontEnd, bool firstTime) override;
106
107 inline QString log() const { return m_log; }
108 inline QShaderProgram::Status status() const { return m_status; }
109
110 void setFormat(QShaderProgram::Format format);
111 QShaderProgram::Format format() const { return m_format; }
112 bool isDirty() const { return m_dirty; }
113 void unsetDirty() { m_dirty = false; }
114
115 inline bool requiresFrontendSync() const { return m_requiresFrontendSync; }
116 inline void unsetRequiresFrontendSync() { m_requiresFrontendSync = false; }
117
118 // Set by Renderer plugin
119 void setLog(const QString &log);
120 void setStatus(QShaderProgram::Status status);
121 void initializeFromReference(const Shader &other);
122
123 void requestCacheRebuild();
124
125private:
126 QVector<QByteArray> m_shaderCode;
127
128 QString m_log;
129 bool m_requiresFrontendSync;
130 QShaderProgram::Status m_status;
131 QShaderProgram::Format m_format;
132 bool m_dirty;
133
134};
135
136#ifndef QT_NO_DEBUG_STREAM
137inline QDebug operator<<(QDebug dbg, const Shader &shader)
138{
139 QDebugStateSaver saver(dbg);
140 dbg << "QNodeId =" << shader.peerId() << Qt::endl;
141 return dbg;
142}
143#endif
144
145class Q_AUTOTEST_EXPORT ShaderFunctor : public Qt3DCore::QBackendNodeMapper
146{
147public:
148 explicit ShaderFunctor(AbstractRenderer *renderer,
149 ShaderManager *manager);
150 Qt3DCore::QBackendNode *create(const Qt3DCore::QNodeCreatedChangeBasePtr &change) const final;
151 Qt3DCore::QBackendNode *get(Qt3DCore::QNodeId id) const final;
152 void destroy(Qt3DCore::QNodeId id) const final;
153
154private:
155 AbstractRenderer *m_renderer;
156 ShaderManager *m_shaderManager;
157};
158
159} // namespace Render
160} // namespace Qt3DRender
161
162QT_END_NAMESPACE
163
164#endif // QT3DRENDER_RENDER_SHADER_H
165

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