1/****************************************************************************
2**
3** Copyright (C) 2016 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the QtGui 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 QOPENGLPROGRAMBINARYCACHE_P_H
41#define QOPENGLPROGRAMBINARYCACHE_P_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 purely as an
48// implementation detail. 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 <QtGui/qtguiglobal.h>
55#include <QtCore/qcache.h>
56#include <QtCore/qmutex.h>
57#include <QtGui/private/qopenglcontext_p.h>
58#include <QtGui/private/qshader_p.h>
59
60QT_BEGIN_NAMESPACE
61
62// These classes are also used by the OpenGL backend of QRhi. They must
63// therefore stay independent from QOpenGLShader(Program). Must rely only on
64// QOpenGLContext/Functions.
65
66class QOpenGLProgramBinaryCache
67{
68public:
69 struct ShaderDesc {
70 ShaderDesc() { }
71 ShaderDesc(QShader::Stage stage, const QByteArray &source = QByteArray())
72 : stage(stage), source(source)
73 { }
74 QShader::Stage stage;
75 QByteArray source;
76 };
77 struct ProgramDesc {
78 QVector<ShaderDesc> shaders;
79 QByteArray cacheKey() const;
80 };
81
82 QOpenGLProgramBinaryCache();
83
84 bool load(const QByteArray &cacheKey, uint programId);
85 void save(const QByteArray &cacheKey, uint programId);
86
87private:
88 QString cacheFileName(const QByteArray &cacheKey) const;
89 bool verifyHeader(const QByteArray &buf) const;
90 bool setProgramBinary(uint programId, uint blobFormat, const void *p, uint blobSize);
91
92 QString m_globalCacheDir;
93 QString m_localCacheDir;
94 QString m_currentCacheDir;
95 bool m_cacheWritable;
96 struct MemCacheEntry {
97 MemCacheEntry(const void *p, int size, uint format)
98 : blob(reinterpret_cast<const char *>(p), size),
99 format(format)
100 { }
101 QByteArray blob;
102 uint format;
103 };
104 QCache<QByteArray, MemCacheEntry> m_memCache;
105#if defined(QT_OPENGL_ES_2)
106 void (QOPENGLF_APIENTRYP programBinaryOES)(GLuint program, GLenum binaryFormat, const GLvoid *binary, GLsizei length);
107 void (QOPENGLF_APIENTRYP getProgramBinaryOES)(GLuint program, GLsizei bufSize, GLsizei *length, GLenum *binaryFormat, GLvoid *binary);
108 void initializeProgramBinaryOES(QOpenGLContext *context);
109 bool m_programBinaryOESInitialized = false;
110#endif
111 QMutex m_mutex;
112};
113
114// While unlikely, one application can in theory use contexts with different versions
115// or profiles. Therefore any version- or extension-specific checks must be done on a
116// per-context basis, not just once per process. QOpenGLSharedResource enables this,
117// although it's once-per-sharing-context-group, not per-context. Still, this should
118// be good enough in practice.
119class QOpenGLProgramBinarySupportCheck : public QOpenGLSharedResource
120{
121public:
122 QOpenGLProgramBinarySupportCheck(QOpenGLContext *context);
123 void invalidateResource() override { }
124 void freeResource(QOpenGLContext *) override { }
125
126 bool isSupported() const { return m_supported; }
127
128private:
129 bool m_supported;
130};
131
132class QOpenGLProgramBinarySupportCheckWrapper
133{
134public:
135 QOpenGLProgramBinarySupportCheck *get(QOpenGLContext *context)
136 {
137 return m_resource.value<QOpenGLProgramBinarySupportCheck>(context);
138 }
139
140private:
141 QOpenGLMultiGroupSharedResource m_resource;
142};
143
144QT_END_NAMESPACE
145
146#endif
147

source code of qtbase/src/gui/opengl/qopenglprogrambinarycache_p.h