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 QtOpenGL 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 QOPENGLWINDOW_H
41#define QOPENGLWINDOW_H
42
43#include <QtOpenGL/qtopenglglobal.h>
44
45#ifndef QT_NO_OPENGL
46
47#include <QtGui/QPaintDeviceWindow>
48#include <QtGui/QOpenGLContext>
49#include <QtGui/QImage>
50
51QT_BEGIN_NAMESPACE
52
53class QOpenGLWindowPrivate;
54
55class Q_OPENGL_EXPORT QOpenGLWindow : public QPaintDeviceWindow
56{
57 Q_OBJECT
58 Q_DECLARE_PRIVATE(QOpenGLWindow)
59
60public:
61 enum UpdateBehavior {
62 NoPartialUpdate,
63 PartialUpdateBlit,
64 PartialUpdateBlend
65 };
66
67 explicit QOpenGLWindow(UpdateBehavior updateBehavior = NoPartialUpdate, QWindow *parent = nullptr);
68 explicit QOpenGLWindow(QOpenGLContext *shareContext, UpdateBehavior updateBehavior = NoPartialUpdate, QWindow *parent = nullptr);
69 ~QOpenGLWindow();
70
71 UpdateBehavior updateBehavior() const;
72 bool isValid() const;
73
74 void makeCurrent();
75 void doneCurrent();
76
77 QOpenGLContext *context() const;
78 QOpenGLContext *shareContext() const;
79
80 GLuint defaultFramebufferObject() const;
81
82 QImage grabFramebuffer();
83
84Q_SIGNALS:
85 void frameSwapped();
86
87protected:
88 virtual void initializeGL();
89 virtual void resizeGL(int w, int h);
90 virtual void paintGL();
91 virtual void paintUnderGL();
92 virtual void paintOverGL();
93
94 void paintEvent(QPaintEvent *event) override;
95 void resizeEvent(QResizeEvent *event) override;
96 int metric(PaintDeviceMetric metric) const override;
97 QPaintDevice *redirected(QPoint *) const override;
98
99private:
100 Q_DISABLE_COPY(QOpenGLWindow)
101};
102
103QT_END_NAMESPACE
104
105#endif // QT_NO_OPENGL
106
107#endif
108