1 /****************************************************************************
2 **
3 ** Copyright (C) 2016 BlackBerry Ltd.
4 ** Copyright (C) 2016 The Qt Company Ltd.
5 ** Contact: https://www.qt.io/licensing/
6 **
7 ** This file is part of the QtQuick module of the Qt Toolkit.
8 **
9 ** $QT_BEGIN_LICENSE:LGPL$
10 ** Commercial License Usage
11 ** Licensees holding valid commercial Qt licenses may use this file in
12 ** accordance with the commercial license agreement provided with the
13 ** Software or, alternatively, in accordance with the terms contained in
14 ** a written agreement between you and The Qt Company. For licensing terms
15 ** and conditions see https://www.qt.io/terms-conditions. For further
16 ** information use the contact form at https://www.qt.io/contact-us.
17 **
18 ** GNU Lesser General Public License Usage
19 ** Alternatively, this file may be used under the terms of the GNU Lesser
20 ** General Public License version 3 as published by the Free Software
21 ** Foundation and appearing in the file LICENSE.LGPL3 included in the
22 ** packaging of this file. Please review the following information to
23 ** ensure the GNU Lesser General Public License version 3 requirements
24 ** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
25 **
26 ** GNU General Public License Usage
27 ** Alternatively, this file may be used under the terms of the GNU
28 ** General Public License version 2.0 or (at your option) the GNU General
29 ** Public license version 3 or any later version approved by the KDE Free
30 ** Qt Foundation. The licenses are as published by the Free Software
31 ** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
32 ** included in the packaging of this file. Please review the following
33 ** information to ensure the GNU General Public License requirements will
34 ** be met: https://www.gnu.org/licenses/gpl-2.0.html and
35 ** https://www.gnu.org/licenses/gpl-3.0.html.
36 **
37 ** $QT_END_LICENSE$
38 **
39 ****************************************************************************/
40 
41 #ifndef QQUICKOPENGLINFO_P_H
42 #define QQUICKOPENGLINFO_P_H
43 
44 //
45 //  W A R N I N G
46 //  -------------
47 //
48 // This file is not part of the Qt API.  It exists purely as an
49 // implementation detail.  This header file may change from version to
50 // version without notice, or even be removed.
51 //
52 // We mean it.
53 //
54 
55 #include <QtCore/qobject.h>
56 #include <QtCore/qpointer.h>
57 #include <QtGui/qsurfaceformat.h>
58 #include <QtQml/qqml.h>
59 
60 QT_BEGIN_NAMESPACE
61 
62 class QQuickItem;
63 class QQuickWindow;
64 
65 class QQuickOpenGLInfo : public QObject
66 {
67     Q_OBJECT
68     Q_PROPERTY(int majorVersion READ majorVersion NOTIFY majorVersionChanged FINAL)
69     Q_PROPERTY(int minorVersion READ minorVersion NOTIFY minorVersionChanged FINAL)
70     Q_PROPERTY(ContextProfile profile READ profile NOTIFY profileChanged FINAL)
71     Q_PROPERTY(RenderableType renderableType READ renderableType NOTIFY renderableTypeChanged FINAL)
72 
73     QML_NAMED_ELEMENT(OpenGLInfo)
74     QML_UNCREATABLE("OpenGLInfo is only available via attached properties.")
75     QML_ADDED_IN_MINOR_VERSION(4)
76     QML_ATTACHED(QQuickOpenGLInfo)
77 
78 public:
79     QQuickOpenGLInfo(QQuickItem *item = 0);
80 
81     int majorVersion() const;
82     int minorVersion() const;
83 
84     // keep in sync with QSurfaceFormat::OpenGLContextProfile
85     enum ContextProfile {
86         NoProfile = QSurfaceFormat::NoProfile,
87         CoreProfile = QSurfaceFormat::CoreProfile,
88         CompatibilityProfile = QSurfaceFormat::CompatibilityProfile
89     };
90     Q_ENUM(ContextProfile)
91     ContextProfile profile() const;
92 
93     // keep in sync with QSurfaceFormat::RenderableType
94     enum RenderableType {
95         Unspecified = QSurfaceFormat::DefaultRenderableType,
96         OpenGL = QSurfaceFormat::OpenGL,
97         OpenGLES = QSurfaceFormat::OpenGLES
98     };
99     Q_ENUM(RenderableType)
100     RenderableType renderableType() const;
101 
102     static QQuickOpenGLInfo *qmlAttachedProperties(QObject *object);
103 
104 Q_SIGNALS:
105     void majorVersionChanged();
106     void minorVersionChanged();
107     void profileChanged();
108     void renderableTypeChanged();
109 
110 private Q_SLOTS:
111     void updateFormat();
112     void setWindow(QQuickWindow *window);
113 
114 private:
115     QPointer<QQuickWindow> m_window;
116     int m_majorVersion;
117     int m_minorVersion;
118     ContextProfile m_profile;
119     RenderableType m_renderableType;
120 };
121 
122 QT_END_NAMESPACE
123 
124 #endif // QQUICKOPENGLINFO_P_H
125