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 QtWidgets 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 QWIDGETREPAINTMANAGER_P_H
41 #define QWIDGETREPAINTMANAGER_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 <QtWidgets/private/qtwidgetsglobal_p.h>
55 #include <QDebug>
56 #include <QtWidgets/qwidget.h>
57 #include <private/qwidget_p.h>
58 #include <QtGui/qbackingstore.h>
59 
60 QT_BEGIN_NAMESPACE
61 
62 class QPlatformTextureList;
63 class QPlatformTextureListWatcher;
64 class QWidgetRepaintManager;
65 
66 class Q_AUTOTEST_EXPORT QWidgetRepaintManager
67 {
68     Q_GADGET
69 public:
70     enum UpdateTime {
71         UpdateNow,
72         UpdateLater
73     };
74     Q_ENUM(UpdateTime)
75 
76     enum BufferState{
77         BufferValid,
78         BufferInvalid
79     };
80     Q_ENUM(BufferState)
81 
82     QWidgetRepaintManager(QWidget *t);
83     ~QWidgetRepaintManager();
84 
backingStore()85     QBackingStore *backingStore() const { return store; }
setBackingStore(QBackingStore * backingStore)86     void setBackingStore(QBackingStore *backingStore) { store = backingStore; }
87 
88     template <class T>
89     void markDirty(const T &r, QWidget *widget, UpdateTime updateTime = UpdateLater,
90                    BufferState bufferState = BufferValid);
91 
92     void removeDirtyWidget(QWidget *w);
93 
94     void sync(QWidget *exposedWidget, const QRegion &exposedRegion);
95     void sync();
96 
97     void markNeedsFlush(QWidget *widget, const QRegion &region, const QPoint &topLevelOffset);
98 
99     void addStaticWidget(QWidget *widget);
100     void moveStaticWidgets(QWidget *reparented);
101     void removeStaticWidget(QWidget *widget);
102     QRegion staticContents(QWidget *widget = nullptr, const QRect &withinClipRect = QRect()) const;
103 
104     bool bltRect(const QRect &rect, int dx, int dy, QWidget *widget);
105 
106 private:
107     void updateLists(QWidget *widget);
108 
109     void addDirtyWidget(QWidget *widget, const QRegion &rgn);
110     void resetWidget(QWidget *widget);
111 
112     void addDirtyRenderToTextureWidget(QWidget *widget);
113 
114     void sendUpdateRequest(QWidget *widget, UpdateTime updateTime);
115 
116     bool syncAllowed();
117     void paintAndFlush();
118 
119     void markNeedsFlush(QWidget *widget, const QRegion &region = QRegion());
120 
121     void flush();
122     void flush(QWidget *widget, const QRegion &region, QPlatformTextureList *widgetTextures);
123 
124     bool isDirty() const;
125 
126     bool hasStaticContents() const;
127     void updateStaticContentsSize();
128 
129     QWidget *tlw = nullptr;
130     QBackingStore *store = nullptr;
131 
132     QRegion dirty; // needsRepaint
133     QVector<QWidget *> dirtyWidgets;
134     QVector<QWidget *> dirtyRenderToTextureWidgets;
135 
136     QRegion topLevelNeedsFlush;
137     QVector<QWidget *> needsFlushWidgets;
138 
139     QList<QWidget *> staticWidgets;
140 
141     QPlatformTextureListWatcher *textureListWatcher = nullptr;
142 
143     bool updateRequestSent = false;
144 
145     QElapsedTimer perfTime;
146     int perfFrames = 0;
147 
148     Q_DISABLE_COPY_MOVE(QWidgetRepaintManager)
149 };
150 
151 QT_END_NAMESPACE
152 
153 #endif // QWIDGETREPAINTMANAGER_P_H
154