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 QSURFACE_H
41 #define QSURFACE_H
42 
43 #include <QtGui/qtguiglobal.h>
44 #include <QtCore/qnamespace.h>
45 #include <QtGui/qsurfaceformat.h>
46 #include <QtCore/qmetatype.h>
47 #include <QtCore/qsize.h>
48 
49 QT_BEGIN_NAMESPACE
50 
51 
52 class QPlatformSurface;
53 
54 class QSurfacePrivate;
55 
56 class Q_GUI_EXPORT QSurface
57 {
58     Q_GADGET
59 public:
60     enum SurfaceClass {
61         Window,
62         Offscreen
63     };
64     Q_ENUM(SurfaceClass)
65 
66     enum SurfaceType {
67         RasterSurface,
68         OpenGLSurface,
69         RasterGLSurface,
70         OpenVGSurface,
71         VulkanSurface,
72         MetalSurface
73     };
74     Q_ENUM(SurfaceType)
75 
76     virtual ~QSurface();
77 
78     SurfaceClass surfaceClass() const;
79 
80     virtual QSurfaceFormat format() const = 0;
81     virtual QPlatformSurface *surfaceHandle() const = 0;
82 
83     virtual SurfaceType surfaceType() const = 0;
84     bool supportsOpenGL() const;
85 
86     virtual QSize size() const = 0;
87 
88 protected:
89     explicit QSurface(SurfaceClass type);
90 
91     SurfaceClass m_type;
92 
93     QSurfacePrivate *m_reserved;
94 };
95 
96 QT_END_NAMESPACE
97 
98 Q_DECLARE_METATYPE(QSurface*)
99 
100 #endif //QSURFACE_H
101