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 QtGui 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 QOFFSCREENSURFACE_H
41 #define QOFFSCREENSURFACE_H
42 
43 #include <QtGui/qtguiglobal.h>
44 #include <QtCore/QObject>
45 #include <QtGui/qsurface.h>
46 
47 QT_BEGIN_NAMESPACE
48 
49 class QOffscreenSurfacePrivate;
50 
51 class QScreen;
52 class QPlatformOffscreenSurface;
53 
54 class Q_GUI_EXPORT QOffscreenSurface : public QObject, public QSurface
55 {
56     Q_OBJECT
57     Q_DECLARE_PRIVATE(QOffscreenSurface)
58 
59 public:
60     // ### Qt 6: merge overloads
61     explicit QOffscreenSurface(QScreen *screen, QObject *parent);
62     explicit QOffscreenSurface(QScreen *screen = nullptr);
63     ~QOffscreenSurface();
64 
65     SurfaceType surfaceType() const override;
66 
67     void create();
68     void destroy();
69 
70     bool isValid() const;
71 
72     void setFormat(const QSurfaceFormat &format);
73     QSurfaceFormat format() const override;
74     QSurfaceFormat requestedFormat() const;
75 
76     QSize size() const override;
77 
78     QScreen *screen() const;
79     void setScreen(QScreen *screen);
80 
81     QPlatformOffscreenSurface *handle() const;
82 
83     void *nativeHandle() const;
84     void setNativeHandle(void *handle);
85 
86 Q_SIGNALS:
87     void screenChanged(QScreen *screen);
88 
89 private Q_SLOTS:
90     void screenDestroyed(QObject *screen);
91 
92 private:
93 
94     QPlatformSurface *surfaceHandle() const override;
95 
96     Q_DISABLE_COPY(QOffscreenSurface)
97 };
98 
99 QT_END_NAMESPACE
100 
101 #endif // QOFFSCREENSURFACE_H
102