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 QSGRENDERLOOP_P_H
41#define QSGRENDERLOOP_P_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 <QtGui/QImage>
55#include <QtGui/QSurface>
56#include <private/qtquickglobal_p.h>
57#include <QtCore/QSet>
58
59QT_BEGIN_NAMESPACE
60
61class QQuickWindow;
62class QSGContext;
63class QSGRenderContext;
64class QAnimationDriver;
65class QRunnable;
66
67class Q_QUICK_PRIVATE_EXPORT QSGRenderLoop : public QObject
68{
69 Q_OBJECT
70
71public:
72 enum RenderLoopFlags {
73 SupportsGrabWithoutExpose = 0x01
74 };
75
76 virtual ~QSGRenderLoop();
77
78 virtual void show(QQuickWindow *window) = 0;
79 virtual void hide(QQuickWindow *window) = 0;
80 virtual void resize(QQuickWindow *) {};
81
82 virtual void windowDestroyed(QQuickWindow *window) = 0;
83
84 virtual void exposureChanged(QQuickWindow *window) = 0;
85 virtual QImage grab(QQuickWindow *window) = 0;
86
87 virtual void update(QQuickWindow *window) = 0;
88 virtual void maybeUpdate(QQuickWindow *window) = 0;
89 virtual void handleUpdateRequest(QQuickWindow *) { }
90
91 virtual QAnimationDriver *animationDriver() const = 0;
92
93 virtual QSGContext *sceneGraphContext() const = 0;
94 virtual QSGRenderContext *createRenderContext(QSGContext *) const = 0;
95
96 virtual void releaseResources(QQuickWindow *window) = 0;
97 virtual void postJob(QQuickWindow *window, QRunnable *job);
98
99 void addWindow(QQuickWindow *win) { m_windows.insert(win); }
100 void removeWindow(QQuickWindow *win) { m_windows.remove(win); }
101 QSet<QQuickWindow *> windows() const { return m_windows; }
102
103 virtual QSurface::SurfaceType windowSurfaceType() const;
104
105 // ### make this less of a singleton
106 static QSGRenderLoop *instance();
107 static void setInstance(QSGRenderLoop *instance);
108
109 virtual bool interleaveIncubation() const { return false; }
110
111 virtual int flags() const { return 0; }
112
113 static void cleanup();
114
115Q_SIGNALS:
116 void timeToIncubate();
117
118protected:
119 void handleContextCreationFailure(QQuickWindow *window, bool isEs);
120
121private:
122 static QSGRenderLoop *s_instance;
123
124 QSet<QQuickWindow *> m_windows;
125};
126
127enum QSGRenderLoopType
128{
129 BasicRenderLoop,
130 ThreadedRenderLoop,
131 WindowsRenderLoop
132};
133
134QT_END_NAMESPACE
135
136#endif // QSGRENDERLOOP_P_H
137