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 QSGDEFAULTRENDERCONTEXT_H
41#define QSGDEFAULTRENDERCONTEXT_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 <QtQuick/private/qsgcontext_p.h>
55#include <QtGui/private/qshader_p.h>
56
57#if QT_CONFIG(opengl)
58#include <QtQuick/private/qsgdepthstencilbuffer_p.h>
59#endif
60
61QT_BEGIN_NAMESPACE
62
63class QRhi;
64class QRhiCommandBuffer;
65class QRhiRenderPassDescriptor;
66class QOpenGLContext;
67class QSGMaterialShader;
68class QSGMaterialRhiShader;
69class QOpenGLFramebufferObject;
70class QSGDepthStencilBufferManager;
71class QSGDepthStencilBuffer;
72
73namespace QSGOpenGLAtlasTexture {
74 class Manager;
75}
76
77namespace QSGRhiAtlasTexture {
78 class Manager;
79}
80
81class Q_QUICK_PRIVATE_EXPORT QSGDefaultRenderContext : public QSGRenderContext
82{
83 Q_OBJECT
84public:
85 QSGDefaultRenderContext(QSGContext *context);
86
87 QRhi *rhi() const override { return m_rhi; }
88 QOpenGLContext *openglContext() const { return m_gl; }
89 bool isValid() const override { return m_gl || m_rhi; }
90
91 static const int INIT_PARAMS_MAGIC = 0x50E;
92 struct InitParams : public QSGRenderContext::InitParams {
93 int sType = INIT_PARAMS_MAGIC; // help discovering broken code passing something else as 'context'
94 QRhi *rhi = nullptr;
95 int sampleCount = 1; // 1, 4, 8, ...
96 QOpenGLContext *openGLContext = nullptr; // ### Qt 6: remove
97 // only used as a hint f.ex. in the texture atlas init
98 QSize initialSurfacePixelSize;
99 // The first window that will be used with this rc, if available.
100 // Only a hint, to help picking better values for atlases.
101 QSurface *maybeSurface = nullptr;
102 };
103
104 void initialize(const QSGRenderContext::InitParams *params) override;
105 void invalidate() override;
106
107 void prepareSync(qreal devicePixelRatio, QRhiCommandBuffer *cb) override;
108 void beginNextFrame(QSGRenderer *renderer,
109 RenderPassCallback mainPassRecordingStart,
110 RenderPassCallback mainPassRecordingEnd,
111 void *callbackUserData) override;
112 void renderNextFrame(QSGRenderer *renderer, uint fboId) override;
113 void endNextFrame(QSGRenderer *renderer) override;
114
115 void beginNextRhiFrame(QSGRenderer *renderer,
116 QRhiRenderTarget *rt, QRhiRenderPassDescriptor *rp, QRhiCommandBuffer *cb,
117 RenderPassCallback mainPassRecordingStart,
118 RenderPassCallback mainPassRecordingEnd,
119 void *callbackUserData) override;
120 void renderNextRhiFrame(QSGRenderer *renderer) override;
121 void endNextRhiFrame(QSGRenderer *renderer) override;
122
123 void preprocess() override;
124 QSGDistanceFieldGlyphCache *distanceFieldGlyphCache(const QRawFont &font) override;
125
126 virtual QSharedPointer<QSGDepthStencilBuffer> depthStencilBufferForFbo(QOpenGLFramebufferObject *fbo);
127 QSGDepthStencilBufferManager *depthStencilBufferManager();
128
129 QSGTexture *createTexture(const QImage &image, uint flags) const override;
130 QSGRenderer *createRenderer() override;
131 QSGTexture *compressedTextureForFactory(const QSGCompressedTextureFactory *factory) const override;
132
133 virtual void compileShader(QSGMaterialShader *shader, QSGMaterial *material, const char *vertexCode = nullptr, const char *fragmentCode = nullptr);
134 virtual void initializeShader(QSGMaterialShader *shader);
135 virtual void initializeRhiShader(QSGMaterialRhiShader *shader, QShader::Variant shaderVariant);
136
137 void setAttachToGraphicsContext(bool attach) override;
138
139 static QSGDefaultRenderContext *from(QOpenGLContext *context);
140
141 bool hasBrokenIndexBufferObjects() const { return m_brokenIBOs; }
142 int maxTextureSize() const override { return m_maxTextureSize; }
143 bool separateIndexBuffer() const;
144
145 int msaaSampleCount() const { return m_initParams.sampleCount; }
146
147 QRhiCommandBuffer *currentFrameCommandBuffer() const {
148 // may be null if not in an active frame, but returning null is valid then
149 return m_currentFrameCommandBuffer;
150 }
151 QRhiRenderPassDescriptor *currentFrameRenderPass() const {
152 // may be null if not in an active frame, but returning null is valid then
153 return m_currentFrameRenderPass;
154 }
155
156 qreal currentDevicePixelRatio() const
157 {
158 // Valid starting from QQuickWindow::syncSceneGraph(). This takes the
159 // redirections, e.g. QQuickWindow::setRenderTarget(), into account.
160 // This calculation logic matches what the renderer does, so this is
161 // the same value that gets exposed in RenderState::devicePixelRatio()
162 // to material shaders. This getter is useful to perform dpr-related
163 // operations in the sync phase (in updatePaintNode()).
164 return m_currentDevicePixelRatio;
165 }
166
167protected:
168 static QString fontKey(const QRawFont &font);
169
170 InitParams m_initParams;
171 QRhi *m_rhi;
172 QOpenGLContext *m_gl;
173 QSGDepthStencilBufferManager *m_depthStencilManager;
174 int m_maxTextureSize;
175 bool m_brokenIBOs;
176 bool m_serializedRender;
177 bool m_attachToGLContext;
178 QSGOpenGLAtlasTexture::Manager *m_glAtlasManager;
179 QSGRhiAtlasTexture::Manager *m_rhiAtlasManager;
180 QRhiCommandBuffer *m_currentFrameCommandBuffer;
181 QRhiRenderPassDescriptor *m_currentFrameRenderPass;
182 qreal m_currentDevicePixelRatio;
183};
184
185QT_END_NAMESPACE
186
187#endif // QSGDEFAULTRENDERCONTEXT_H
188

source code of qtdeclarative/src/quick/scenegraph/qsgdefaultrendercontext_p.h