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