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 QtQuick 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 QSGCONTEXT_H
41#define QSGCONTEXT_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 <QtCore/QObject>
55#include <QtCore/qabstractanimation.h>
56#include <QtCore/QMutex>
57
58#include <QtGui/QImage>
59#include <QtGui/QSurfaceFormat>
60
61#include <private/qtquickglobal_p.h>
62#include <private/qrawfont_p.h>
63
64#include <QtQuick/qsgnode.h>
65
66QT_BEGIN_NAMESPACE
67
68class QSGContextPrivate;
69class QSGInternalRectangleNode;
70class QSGInternalImageNode;
71class QSGPainterNode;
72class QSGGlyphNode;
73class QSGRenderer;
74class QSGDistanceFieldGlyphCache;
75class QQuickWindow;
76class QSGTexture;
77class QSGMaterial;
78class QSGRenderLoop;
79class QSGLayer;
80class QQuickTextureFactory;
81class QSGCompressedTextureFactory;
82class QSGContext;
83class QQuickPaintedItem;
84class QSGRendererInterface;
85class QSGShaderEffectNode;
86class QSGGuiThreadShaderEffectManager;
87class QSGRectangleNode;
88class QSGImageNode;
89class QSGNinePatchNode;
90class QSGSpriteNode;
91class QSGRenderContext;
92class QRhi;
93class QRhiRenderTarget;
94class QRhiRenderPassDescriptor;
95class QRhiCommandBuffer;
96
97Q_DECLARE_LOGGING_CATEGORY(QSG_LOG_TIME_RENDERLOOP)
98Q_DECLARE_LOGGING_CATEGORY(QSG_LOG_TIME_COMPILATION)
99Q_DECLARE_LOGGING_CATEGORY(QSG_LOG_TIME_TEXTURE)
100Q_DECLARE_LOGGING_CATEGORY(QSG_LOG_TIME_GLYPH)
101Q_DECLARE_LOGGING_CATEGORY(QSG_LOG_TIME_RENDERER)
102
103Q_DECLARE_LOGGING_CATEGORY(QSG_LOG_INFO)
104Q_DECLARE_LOGGING_CATEGORY(QSG_LOG_RENDERLOOP)
105
106class Q_QUICK_PRIVATE_EXPORT QSGContext : public QObject
107{
108 Q_OBJECT
109
110public:
111 enum AntialiasingMethod {
112 UndecidedAntialiasing,
113 VertexAntialiasing,
114 MsaaAntialiasing
115 };
116
117 explicit QSGContext(QObject *parent = nullptr);
118 ~QSGContext() override;
119
120 virtual void renderContextInitialized(QSGRenderContext *renderContext);
121 virtual void renderContextInvalidated(QSGRenderContext *renderContext);
122 virtual QSGRenderContext *createRenderContext() = 0;
123
124 QSGInternalRectangleNode *createInternalRectangleNode(const QRectF &rect, const QColor &c);
125 virtual QSGInternalRectangleNode *createInternalRectangleNode() = 0;
126 virtual QSGInternalImageNode *createInternalImageNode(QSGRenderContext *renderContext) = 0;
127 virtual QSGPainterNode *createPainterNode(QQuickPaintedItem *item) = 0;
128 virtual QSGGlyphNode *createGlyphNode(QSGRenderContext *rc, bool preferNativeGlyphNode) = 0;
129 virtual QSGLayer *createLayer(QSGRenderContext *renderContext) = 0;
130 virtual QSGGuiThreadShaderEffectManager *createGuiThreadShaderEffectManager();
131 virtual QSGShaderEffectNode *createShaderEffectNode(QSGRenderContext *renderContext,
132 QSGGuiThreadShaderEffectManager *mgr);
133#if QT_CONFIG(quick_sprite)
134 virtual QSGSpriteNode *createSpriteNode() = 0;
135#endif
136 virtual QAnimationDriver *createAnimationDriver(QObject *parent);
137
138 virtual QSize minimumFBOSize() const;
139 virtual QSurfaceFormat defaultSurfaceFormat() const = 0;
140
141 virtual QSGRendererInterface *rendererInterface(QSGRenderContext *renderContext);
142
143 virtual QSGRectangleNode *createRectangleNode() = 0;
144 virtual QSGImageNode *createImageNode() = 0;
145 virtual QSGNinePatchNode *createNinePatchNode() = 0;
146
147 static QSGContext *createDefaultContext();
148 static QQuickTextureFactory *createTextureFactoryFromImage(const QImage &image);
149 static QSGRenderLoop *createWindowManager();
150
151 static void setBackend(const QString &backend);
152 static QString backend();
153};
154
155class Q_QUICK_PRIVATE_EXPORT QSGRenderContext : public QObject
156{
157 Q_OBJECT
158public:
159 enum CreateTextureFlags {
160 CreateTexture_Alpha = 0x1,
161 CreateTexture_Atlas = 0x2,
162 CreateTexture_Mipmap = 0x4
163 };
164
165 QSGRenderContext(QSGContext *context);
166 ~QSGRenderContext() override;
167
168 QSGContext *sceneGraphContext() const { return m_sg; }
169 virtual bool isValid() const { return true; }
170
171 struct InitParams { };
172 virtual void initialize(const InitParams *params);
173 virtual void invalidate();
174
175 using RenderPassCallback = void (*)(void *);
176
177 virtual void beginNextFrame(QSGRenderer *renderer,
178 RenderPassCallback mainPassRecordingStart,
179 RenderPassCallback mainPassRecordingEnd,
180 void *callbackUserData);
181 virtual void renderNextFrame(QSGRenderer *renderer, uint fboId) = 0;
182 virtual void endNextFrame(QSGRenderer *renderer);
183
184 virtual void beginNextRhiFrame(QSGRenderer *renderer,
185 QRhiRenderTarget *rt, QRhiRenderPassDescriptor *rp, QRhiCommandBuffer *cb,
186 RenderPassCallback mainPassRecordingStart,
187 RenderPassCallback mainPassRecordingEnd,
188 void *callbackUserData);
189 virtual void renderNextRhiFrame(QSGRenderer *renderer);
190 virtual void endNextRhiFrame(QSGRenderer *renderer);
191
192 virtual void endSync();
193
194 virtual QSGDistanceFieldGlyphCache *distanceFieldGlyphCache(const QRawFont &font);
195 QSGTexture *textureForFactory(QQuickTextureFactory *factory, QQuickWindow *window);
196
197 virtual QSGTexture *createTexture(const QImage &image, uint flags = CreateTexture_Alpha) const = 0;
198 virtual QSGRenderer *createRenderer() = 0;
199 virtual QSGTexture *compressedTextureForFactory(const QSGCompressedTextureFactory *) const;
200
201 virtual void setAttachToGraphicsContext(bool attach) { Q_UNUSED(attach); }
202
203 virtual int maxTextureSize() const = 0;
204
205 void registerFontengineForCleanup(QFontEngine *engine);
206
207 virtual QRhi *rhi() const;
208
209Q_SIGNALS:
210 void initialized();
211 void invalidated();
212
213public Q_SLOTS:
214 void textureFactoryDestroyed(QObject *o);
215
216protected:
217 // Hold m_sg with QPointer in the rare case it gets deleted before us.
218 QPointer<QSGContext> m_sg;
219
220 QMutex m_mutex;
221 QHash<QObject *, QSGTexture *> m_textures;
222 QSet<QSGTexture *> m_texturesToDelete;
223 QHash<QString, QSGDistanceFieldGlyphCache *> m_glyphCaches;
224
225 QSet<QFontEngine *> m_fontEnginesToClean;
226};
227
228QT_END_NAMESPACE
229
230#endif // QSGCONTEXT_H
231