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 QOPENGLWIDGET_H
41 #define QOPENGLWIDGET_H
42 
43 #include <QtWidgets/qtwidgetsglobal.h>
44 
45 #ifndef QT_NO_OPENGL
46 
47 #include <QtWidgets/QWidget>
48 #include <QtGui/QSurfaceFormat>
49 #include <QtGui/qopengl.h>
50 
51 QT_BEGIN_NAMESPACE
52 
53 class QOpenGLWidgetPrivate;
54 
55 class Q_WIDGETS_EXPORT QOpenGLWidget : public QWidget
56 {
57     Q_OBJECT
58     Q_DECLARE_PRIVATE(QOpenGLWidget)
59 
60 public:
61     enum UpdateBehavior {
62         NoPartialUpdate,
63         PartialUpdate
64     };
65 
66     explicit QOpenGLWidget(QWidget* parent = nullptr, Qt::WindowFlags f = Qt::WindowFlags());
67     ~QOpenGLWidget();
68 
69     void setUpdateBehavior(UpdateBehavior updateBehavior);
70     UpdateBehavior updateBehavior() const;
71 
72     void setFormat(const QSurfaceFormat &format);
73     QSurfaceFormat format() const;
74 
75     GLenum textureFormat() const;
76     void setTextureFormat(GLenum texFormat);
77 
78     bool isValid() const;
79 
80     void makeCurrent();
81     void doneCurrent();
82 
83     QOpenGLContext *context() const;
84     GLuint defaultFramebufferObject() const;
85 
86     QImage grabFramebuffer();
87 
88 Q_SIGNALS:
89     void aboutToCompose();
90     void frameSwapped();
91     void aboutToResize();
92     void resized();
93 
94 protected:
95     virtual void initializeGL();
96     virtual void resizeGL(int w, int h);
97     virtual void paintGL();
98 
99     void paintEvent(QPaintEvent *e) override;
100     void resizeEvent(QResizeEvent *e) override;
101     bool event(QEvent *e) override;
102 
103     int metric(QPaintDevice::PaintDeviceMetric metric) const override;
104     QPaintDevice *redirected(QPoint *p) const override;
105     QPaintEngine *paintEngine() const override;
106 
107 private:
108     Q_DISABLE_COPY(QOpenGLWidget)
109 };
110 
111 QT_END_NAMESPACE
112 
113 #endif // QT_NO_OPENGL
114 
115 #endif // QOPENGLWIDGET_H
116