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