1/****************************************************************************
2**
3** Copyright (C) 2016 Klaralvdalens Datakonsult AB (KDAB).
4** Contact: http://www.qt-project.org/legal
5**
6** This file is part of the Qt3D module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL3$
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 http://www.qt.io/terms-conditions. For further
15** information use the contact form at http://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.LGPLv3 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.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 later as published by the Free
28** Software Foundation and appearing in the file LICENSE.GPL included in
29** the packaging of this file. Please review the following information to
30** ensure the GNU General Public License version 2.0 requirements will be
31** met: http://www.gnu.org/licenses/gpl-2.0.html.
32**
33** $QT_END_LICENSE$
34**
35****************************************************************************/
36
37#ifndef QT3DRENDER_RENDER_SHADERCACHE_H
38#define QT3DRENDER_RENDER_SHADERCACHE_H
39
40//
41// W A R N I N G
42// -------------
43//
44// This file is not part of the Qt API. It exists for the convenience
45// of other Qt classes. This header file may change from version to
46// version without notice, or even be removed.
47//
48// We mean it.
49//
50
51#include <Qt3DRender/private/qt3drender_global_p.h>
52#include <Qt3DRender/private/shader_p.h>
53
54#include <QtCore/qhash.h>
55#include <QtCore/qmutex.h>
56#include <QtCore/qvector.h>
57
58QT_BEGIN_NAMESPACE
59
60class QOpenGLShaderProgram;
61
62namespace Qt3DRender {
63namespace Render {
64
65#if defined(QT_BUILD_INTERNAL)
66class tst_ShaderCache;
67#endif
68
69class Q_3DRENDERSHARED_PRIVATE_EXPORT ShaderCache
70{
71public:
72 ~ShaderCache();
73
74 QOpenGLShaderProgram *getShaderProgramAndAddRef(ProgramDNA dna, Qt3DCore::QNodeId shaderPeerId, bool *wasPresent = nullptr);
75 void insert(ProgramDNA dna, Qt3DCore::QNodeId shaderPeerId, QOpenGLShaderProgram *program);
76 void removeRef(ProgramDNA dna, Qt3DCore::QNodeId shaderPeerId);
77 void purge();
78 void clear();
79
80 // Only ever used from the OpenGL submission thread
81 QOpenGLShaderProgram *getShaderProgramForDNA(ProgramDNA dna) const;
82 QVector<Qt3DCore::QNodeId> shaderIdsForProgram(ProgramDNA dna) const;
83
84private:
85 // Only ever used from the OpenGL submission thread
86 QHash<ProgramDNA, QOpenGLShaderProgram *> m_programHash;
87
88 // Accessed from both the OpenGL submission thread and the aspect thread
89 QHash<ProgramDNA, QVector<Qt3DCore::QNodeId>> m_programRefs;
90 QVector<ProgramDNA> m_pendingRemoval;
91 QMutex m_refsMutex;
92
93#if defined(QT_BUILD_INTERNAL)
94 friend class tst_ShaderCache;
95#endif
96};
97
98} // namespace Render
99} // namespace Qt3DRender
100
101QT_END_NAMESPACE
102
103#endif // QT3DRENDER_RENDER_SHADERCACHE_H
104