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 QGLFRAMEBUFFEROBJECT_H
41 #define QGLFRAMEBUFFEROBJECT_H
42 
43 #include <QtOpenGL/qgl.h>
44 #include <QtGui/qpaintdevice.h>
45 
46 QT_BEGIN_NAMESPACE
47 
48 
49 class QGLFramebufferObjectPrivate;
50 class QGLFramebufferObjectFormat;
51 
52 class Q_OPENGL_EXPORT QGLFramebufferObject : public QPaintDevice
53 {
54     Q_DECLARE_PRIVATE(QGLFramebufferObject)
55 public:
56     enum Attachment {
57         NoAttachment,
58         CombinedDepthStencil,
59         Depth
60     };
61 
62     QGLFramebufferObject(const QSize &size, GLenum target = GL_TEXTURE_2D);
63     QGLFramebufferObject(int width, int height, GLenum target = GL_TEXTURE_2D);
64 
65     QGLFramebufferObject(const QSize &size, Attachment attachment,
66                          GLenum target = GL_TEXTURE_2D, GLenum internal_format = 0);
67     QGLFramebufferObject(int width, int height, Attachment attachment,
68                          GLenum target = GL_TEXTURE_2D, GLenum internal_format = 0);
69 
70     QGLFramebufferObject(const QSize &size, const QGLFramebufferObjectFormat &format);
71     QGLFramebufferObject(int width, int height, const QGLFramebufferObjectFormat &format);
72 
73     virtual ~QGLFramebufferObject();
74 
75     QGLFramebufferObjectFormat format() const;
76 
77     bool isValid() const;
78     bool isBound() const;
79     bool bind();
80     bool release();
81 
82     GLuint texture() const;
83     QSize size() const;
84     QImage toImage() const;
85     Attachment attachment() const;
86 
87     QPaintEngine *paintEngine() const override;
88     GLuint handle() const;
89 
90     static bool bindDefault();
91 
92     static bool hasOpenGLFramebufferObjects();
93 
94     void drawTexture(const QRectF &target, GLuint textureId, GLenum textureTarget = GL_TEXTURE_2D);
95     void drawTexture(const QPointF &point, GLuint textureId, GLenum textureTarget = GL_TEXTURE_2D);
96 
97     static bool hasOpenGLFramebufferBlit();
98     static void blitFramebuffer(QGLFramebufferObject *target, const QRect &targetRect,
99                                 QGLFramebufferObject *source, const QRect &sourceRect,
100                                 GLbitfield buffers = GL_COLOR_BUFFER_BIT,
101                                 GLenum filter = GL_NEAREST);
102 
103 protected:
104     int metric(PaintDeviceMetric metric) const override;
devType()105     int devType() const override { return QInternal::FramebufferObject; }
106 
107 private:
108     Q_DISABLE_COPY(QGLFramebufferObject)
109     QScopedPointer<QGLFramebufferObjectPrivate> d_ptr;
110     friend class QGLPaintDevice;
111     friend class QGLFBOGLPaintDevice;
112 };
113 
114 class QGLFramebufferObjectFormatPrivate;
115 class Q_OPENGL_EXPORT QGLFramebufferObjectFormat
116 {
117 public:
118     QGLFramebufferObjectFormat();
119     QGLFramebufferObjectFormat(const QGLFramebufferObjectFormat &other);
120     QGLFramebufferObjectFormat &operator=(const QGLFramebufferObjectFormat &other);
121     ~QGLFramebufferObjectFormat();
122 
123     void setSamples(int samples);
124     int samples() const;
125 
126     void setMipmap(bool enabled);
127     bool mipmap() const;
128 
129     void setAttachment(QGLFramebufferObject::Attachment attachment);
130     QGLFramebufferObject::Attachment attachment() const;
131 
132     void setTextureTarget(GLenum target);
133     GLenum textureTarget() const;
134 
135     void setInternalTextureFormat(GLenum internalTextureFormat);
136     GLenum internalTextureFormat() const;
137 
138     bool operator==(const QGLFramebufferObjectFormat& other) const;
139     bool operator!=(const QGLFramebufferObjectFormat& other) const;
140 
141 private:
142     QGLFramebufferObjectFormatPrivate *d;
143 
144     void detach();
145 };
146 
147 QT_END_NAMESPACE
148 
149 #endif // QGLFRAMEBUFFEROBJECT_H
150