summaryrefslogtreecommitdiffstats
path: root/src/quick3d/imports/scene3d/scene3drenderer_p.h
blob: f42167981f85a7fb3c82daf4390348fed3f34870 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
/****************************************************************************
**
** Copyright (C) 2016 Klaralvdalens Datakonsult AB (KDAB).
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt3D module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/

#ifndef QT3DRENDER_SCENE3DRENDERER_P_H
#define QT3DRENDER_SCENE3DRENDERER_P_H

//
//  W A R N I N G
//  -------------
//
// This file is not part of the Qt API.  It exists purely as an
// implementation detail.  This header file may change from version to
// version without notice, or even be removed.
//
// We mean it.
//

#include <QtCore/QObject>
#include <QtCore/qsize.h>
#include <QtCore/QMutex>
#include <QtCore/QSemaphore>
#include <scene3ditem_p.h>

QT_BEGIN_NAMESPACE

class QRhi;
class QRhiTextureRenderTarget;
class QRhiRenderBuffer;
class QRhiTexture;
class QRhiRenderPassDescriptor;
class QQuickWindow;
class QSGTexture;
class QOpenGLFramebufferObject;

namespace Qt3DCore {
class QAspectEngine;
}

namespace Qt3DRender {

class QRenderAspect;
class Scene3DCleaner;
class Scene3DSGNode;
class Scene3DViews;

namespace Render {
class AbstractRenderer;
}

class Scene3DRenderer : public QObject
{
    Q_OBJECT
public:
    Scene3DRenderer();
    ~Scene3DRenderer();

    Scene3DSGNode *sgNode() const;
    void setCleanerHelper(Scene3DCleaner *cleaner);
    void allowRender();
    void setCompositingMode(Scene3DItem::CompositingMode mode);
    void setSkipFrame(bool skip);
    void init(Scene3DItem *item, Qt3DCore::QAspectEngine *aspectEngine, QRenderAspect *renderAspect);

    void setMultisample(bool multisample);
    void setBoundingSize(const QSize &size);

    bool multisample() const { return m_multisample; }
    QSize boundingSize() const { return m_boundingRectSize; }

    void setScene3DViews(const QList<Scene3DView *> &views);
    void init(Qt3DCore::QAspectEngine *aspectEngine, QRenderAspect *renderAspect);

    void beforeSynchronize();
    void setWindow(QQuickWindow *window);

    bool hasShutdown() const { return !m_needsShutdown; }

    QRenderAspect *renderAspect() const { return m_renderAspect; }
public Q_SLOTS:
    void shutdown();

private:

    class QuickRenderer
    {
    public:
        // ctor/dtor cannot be inlined because of QScopedPointer with forward
        // declared class
        QuickRenderer();
        virtual ~QuickRenderer();
        virtual void initialize(Scene3DRenderer *scene3DRenderer,
                                Qt3DRender::Render::AbstractRenderer *renderer) = 0;
        virtual void beforeSynchronize(Scene3DRenderer *scene3DRenderer) = 0;
        virtual void beforeRendering(Scene3DRenderer *scene3DRenderer) = 0;
        virtual void beforeRenderPassRecording(Scene3DRenderer *scene3DRenderer) = 0;
        virtual void shutdown(Scene3DRenderer *sceneRenderer) = 0;

    protected:
        bool m_lastMultisample = false;
        QSize m_lastSize;
        QScopedPointer<QSGTexture> m_texture;
        Qt3DRender::Render::AbstractRenderer *m_renderer = nullptr;
    };

    class GLRenderer : public QuickRenderer
    {
    public:
        QOpenGLFramebufferObject *createMultisampledFramebufferObject(const QSize &size);
        QOpenGLFramebufferObject *createFramebufferObject(const QSize &size);

        void initialize(Scene3DRenderer *scene3DRenderer,
                        Qt3DRender::Render::AbstractRenderer *renderer) override;
        void beforeSynchronize(Scene3DRenderer *scene3DRenderer) override;
        void beforeRendering(Scene3DRenderer *scene3DRenderer) override;
        void beforeRenderPassRecording(Scene3DRenderer *scene3DRenderer) override;
        void shutdown(Scene3DRenderer *sceneRenderer) override;

    private:
        QScopedPointer<QOpenGLFramebufferObject> m_multisampledFBO;
        QScopedPointer<QOpenGLFramebufferObject> m_finalFBO;
        bool m_multisample = false;
        quint32 m_textureId = 0;
    };

    class RHIRenderer : public QuickRenderer
    {
    public:
        void initialize(Scene3DRenderer *scene3DRenderer,
                        Qt3DRender::Render::AbstractRenderer *renderer) override;
        void beforeSynchronize(Scene3DRenderer *scene3DRenderer) override;
        void beforeRendering(Scene3DRenderer *scene3DRenderer) override;
        void beforeRenderPassRecording(Scene3DRenderer *scene3DRenderer) override;
        void shutdown(Scene3DRenderer *sceneRenderer) override;

    private:
        void releaseRHIResources();

        QRhiTexture *m_rhiTexture = nullptr;
        QRhiRenderBuffer *m_rhiColorRenderBuffer = nullptr;
        QRhiRenderBuffer *m_rhiMSAARenderBuffer = nullptr;
        QRhiRenderBuffer *m_rhiDepthRenderBuffer = nullptr;
        QRhiTextureRenderTarget *m_rhiRenderTarget = nullptr;
        QRhiRenderPassDescriptor *m_rhiRenderTargetPassDescriptor = nullptr;
        QRhi *m_rhi = nullptr;
    };

    Qt3DCore::QAspectEngine *m_aspectEngine; // Will be released by the Scene3DItem
    QRenderAspect *m_renderAspect; // Will be released by the aspectEngine
    Scene3DSGNode *m_node; // Will be released by the QtQuick SceneGraph
    QQuickWindow *m_window;
    QMutex m_windowMutex;

    QSize m_lastSize;
    QSize m_boundingRectSize;
    bool m_multisample;
    bool m_lastMultisample;

    bool m_needsShutdown;
    bool m_shouldRender;
    bool m_dirtyViews;
    bool m_skipFrame;
    QSemaphore m_allowRendering;
    Scene3DItem::CompositingMode m_compositingMode;
    QList<Scene3DView *> m_views;
    bool m_resetRequested = false;
    QuickRenderer *m_quickRenderer = nullptr;

    friend class Scene3DItem;
};

} // namespace Qt3DRender

QT_END_NAMESPACE

#endif // QT3DRENDER_SCENE3DRENDERER_P_H