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 QQUICKFRAMEBUFFEROBJECT_H
41#define QQUICKFRAMEBUFFEROBJECT_H
42
43#include <QtQuick/QQuickItem>
44
45QT_BEGIN_NAMESPACE
46
47class QOpenGLFramebufferObject;
48class QQuickFramebufferObjectPrivate;
49class QSGFramebufferObjectNode;
50
51// ### Qt 6: Consider what to do here. QQuickFbo supports both direct OpenGL and
52// OpenGL via QRhi, but it cannot function when running with another rhi backend.
53
54class Q_QUICK_EXPORT QQuickFramebufferObject : public QQuickItem
55{
56 Q_OBJECT
57 Q_DECLARE_PRIVATE(QQuickFramebufferObject)
58
59 Q_PROPERTY(bool textureFollowsItemSize READ textureFollowsItemSize WRITE setTextureFollowsItemSize NOTIFY textureFollowsItemSizeChanged)
60 Q_PROPERTY(bool mirrorVertically READ mirrorVertically WRITE setMirrorVertically NOTIFY mirrorVerticallyChanged)
61
62public:
63
64 class Q_QUICK_EXPORT Renderer {
65 protected:
66 Renderer();
67 virtual ~Renderer();
68 virtual void render() = 0;
69 virtual QOpenGLFramebufferObject *createFramebufferObject(const QSize &size);
70 virtual void synchronize(QQuickFramebufferObject *);
71 QOpenGLFramebufferObject *framebufferObject() const;
72 void update();
73 void invalidateFramebufferObject();
74 private:
75 friend class QSGFramebufferObjectNode;
76 friend class QQuickFramebufferObject;
77 void *data;
78 };
79
80 QQuickFramebufferObject(QQuickItem *parent = nullptr);
81
82 bool textureFollowsItemSize() const;
83 void setTextureFollowsItemSize(bool follows);
84
85 bool mirrorVertically() const;
86 void setMirrorVertically(bool enable);
87
88 virtual Renderer *createRenderer() const = 0;
89
90 bool isTextureProvider() const override;
91 QSGTextureProvider *textureProvider() const override;
92 void releaseResources() override;
93
94protected:
95 void geometryChanged(const QRectF &newGeometry, const QRectF &oldGeometry) override;
96
97protected:
98 QSGNode *updatePaintNode(QSGNode *, UpdatePaintNodeData *) override;
99
100Q_SIGNALS:
101 void textureFollowsItemSizeChanged(bool);
102 void mirrorVerticallyChanged(bool);
103
104private Q_SLOTS:
105 void invalidateSceneGraph();
106};
107
108QT_END_NAMESPACE
109
110#endif // QQUICKFRAMEBUFFEROBJECT_H
111

source code of qtdeclarative/src/quick/items/qquickframebufferobject.h