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 | |
61 | QT_BEGIN_NAMESPACE |
62 | |
63 | class QRhi; |
64 | class QRhiCommandBuffer; |
65 | class QOpenGLContext; |
66 | class QSGMaterialShader; |
67 | class QSGMaterialRhiShader; |
68 | class QOpenGLFramebufferObject; |
69 | class QSGDepthStencilBufferManager; |
70 | class QSGDepthStencilBuffer; |
71 | |
72 | namespace QSGOpenGLAtlasTexture { |
73 | class Manager; |
74 | } |
75 | |
76 | namespace QSGRhiAtlasTexture { |
77 | class Manager; |
78 | } |
79 | |
80 | class Q_QUICK_PRIVATE_EXPORT QSGDefaultRenderContext : public QSGRenderContext |
81 | { |
82 | Q_OBJECT |
83 | public: |
84 | QSGDefaultRenderContext(QSGContext *context); |
85 | |
86 | QRhi *rhi() const override { return m_rhi; } |
87 | QOpenGLContext *openglContext() const { return m_gl; } |
88 | bool isValid() const override { return m_gl || m_rhi; } |
89 | |
90 | static const int INIT_PARAMS_MAGIC = 0x50E; |
91 | struct InitParams : public QSGRenderContext::InitParams { |
92 | int sType = INIT_PARAMS_MAGIC; // help discovering broken code passing something else as 'context' |
93 | QRhi *rhi = nullptr; |
94 | int sampleCount = 1; // 1, 4, 8, ... |
95 | QOpenGLContext *openGLContext = nullptr; // ### Qt 6: remove |
96 | // only used as a hint f.ex. in the texture atlas init |
97 | QSize initialSurfacePixelSize; |
98 | // The first window that will be used with this rc, if available. |
99 | // Only a hint, to help picking better values for atlases. |
100 | QSurface *maybeSurface = nullptr; |
101 | }; |
102 | |
103 | void initialize(const QSGRenderContext::InitParams *params) override; |
104 | void invalidate() override; |
105 | |
106 | void beginNextFrame(QSGRenderer *renderer, |
107 | RenderPassCallback mainPassRecordingStart, |
108 | RenderPassCallback mainPassRecordingEnd, |
109 | void *callbackUserData) override; |
110 | void renderNextFrame(QSGRenderer *renderer, uint fboId) override; |
111 | void endNextFrame(QSGRenderer *renderer) override; |
112 | |
113 | void beginNextRhiFrame(QSGRenderer *renderer, |
114 | QRhiRenderTarget *rt, QRhiRenderPassDescriptor *rp, QRhiCommandBuffer *cb, |
115 | RenderPassCallback mainPassRecordingStart, |
116 | RenderPassCallback mainPassRecordingEnd, |
117 | void *callbackUserData) override; |
118 | void renderNextRhiFrame(QSGRenderer *renderer) override; |
119 | void endNextRhiFrame(QSGRenderer *renderer) override; |
120 | |
121 | QSGDistanceFieldGlyphCache *distanceFieldGlyphCache(const QRawFont &font) override; |
122 | |
123 | virtual QSharedPointer<QSGDepthStencilBuffer> depthStencilBufferForFbo(QOpenGLFramebufferObject *fbo); |
124 | QSGDepthStencilBufferManager *depthStencilBufferManager(); |
125 | |
126 | QSGTexture *createTexture(const QImage &image, uint flags) const override; |
127 | QSGRenderer *createRenderer() override; |
128 | QSGTexture *compressedTextureForFactory(const QSGCompressedTextureFactory *factory) const override; |
129 | |
130 | virtual void compileShader(QSGMaterialShader *shader, QSGMaterial *material, const char *vertexCode = nullptr, const char *fragmentCode = nullptr); |
131 | virtual void initializeShader(QSGMaterialShader *shader); |
132 | virtual void initializeRhiShader(QSGMaterialRhiShader *shader, QShader::Variant shaderVariant); |
133 | |
134 | void setAttachToGraphicsContext(bool attach) override; |
135 | |
136 | static QSGDefaultRenderContext *from(QOpenGLContext *context); |
137 | |
138 | bool hasBrokenIndexBufferObjects() const { return m_brokenIBOs; } |
139 | int maxTextureSize() const override { return m_maxTextureSize; } |
140 | bool separateIndexBuffer() const; |
141 | |
142 | int msaaSampleCount() const { return m_initParams.sampleCount; } |
143 | |
144 | QRhiCommandBuffer *currentFrameCommandBuffer() const { |
145 | // may be null if not in an active frame, but returning null is valid then |
146 | return m_currentFrameCommandBuffer; |
147 | } |
148 | |
149 | protected: |
150 | static QString fontKey(const QRawFont &font); |
151 | |
152 | InitParams m_initParams; |
153 | QRhi *m_rhi; |
154 | QOpenGLContext *m_gl; |
155 | QSGDepthStencilBufferManager *m_depthStencilManager; |
156 | int m_maxTextureSize; |
157 | bool m_brokenIBOs; |
158 | bool m_serializedRender; |
159 | bool m_attachToGLContext; |
160 | QSGOpenGLAtlasTexture::Manager *m_glAtlasManager; |
161 | QSGRhiAtlasTexture::Manager *m_rhiAtlasManager; |
162 | QRhiCommandBuffer *m_currentFrameCommandBuffer; |
163 | }; |
164 | |
165 | QT_END_NAMESPACE |
166 | |
167 | #endif // QSGDEFAULTRENDERCONTEXT_H |
168 | |