1/****************************************************************************
2**
3** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
4** Contact: http://www.qt-project.org/legal
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 Digia. For licensing terms and
14** conditions see http://qt.digia.com/licensing. For further information
15** use the contact form at http://qt.digia.com/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 2.1 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 2.1 requirements
23** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
24**
25** In addition, as a special exception, Digia gives you certain additional
26** rights. These rights are described in the Digia Qt LGPL Exception
27** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
28**
29** GNU General Public License Usage
30** Alternatively, this file may be used under the terms of the GNU
31** General Public License version 3.0 as published by the Free Software
32** Foundation and appearing in the file LICENSE.GPL included in the
33** packaging of this file. Please review the following information to
34** ensure the GNU General Public License version 3.0 requirements will be
35** met: http://www.gnu.org/copyleft/gpl.html.
36**
37**
38** $QT_END_LICENSE$
39**
40****************************************************************************/
41
42#ifndef QGLFRAMEBUFFEROBJECT_H
43#define QGLFRAMEBUFFEROBJECT_H
44
45#include <QtOpenGL/qgl.h>
46#include <QtGui/qpaintdevice.h>
47
48QT_BEGIN_HEADER
49
50QT_BEGIN_NAMESPACE
51
52QT_MODULE(OpenGL)
53
54class QGLFramebufferObjectPrivate;
55class QGLFramebufferObjectFormat;
56
57class Q_OPENGL_EXPORT QGLFramebufferObject : public QPaintDevice
58{
59 Q_DECLARE_PRIVATE(QGLFramebufferObject)
60public:
61 enum Attachment {
62 NoAttachment,
63 CombinedDepthStencil,
64 Depth
65 };
66
67 QGLFramebufferObject(const QSize &size, GLenum target = GL_TEXTURE_2D);
68 QGLFramebufferObject(int width, int height, GLenum target = GL_TEXTURE_2D);
69#if !defined(QT_OPENGL_ES) || defined(Q_QDOC)
70 QGLFramebufferObject(const QSize &size, Attachment attachment,
71 GLenum target = GL_TEXTURE_2D, GLenum internal_format = GL_RGBA8);
72 QGLFramebufferObject(int width, int height, Attachment attachment,
73 GLenum target = GL_TEXTURE_2D, GLenum internal_format = GL_RGBA8);
74#else
75 QGLFramebufferObject(const QSize &size, Attachment attachment,
76 GLenum target = GL_TEXTURE_2D, GLenum internal_format = GL_RGBA);
77 QGLFramebufferObject(int width, int height, Attachment attachment,
78 GLenum target = GL_TEXTURE_2D, GLenum internal_format = GL_RGBA);
79#endif
80
81 QGLFramebufferObject(const QSize &size, const QGLFramebufferObjectFormat &format);
82 QGLFramebufferObject(int width, int height, const QGLFramebufferObjectFormat &format);
83
84#ifdef Q_MAC_COMPAT_GL_FUNCTIONS
85 QGLFramebufferObject(const QSize &size, QMacCompatGLenum target = GL_TEXTURE_2D);
86 QGLFramebufferObject(int width, int height, QMacCompatGLenum target = GL_TEXTURE_2D);
87
88 QGLFramebufferObject(const QSize &size, Attachment attachment,
89 QMacCompatGLenum target = GL_TEXTURE_2D, QMacCompatGLenum internal_format = GL_RGBA8);
90 QGLFramebufferObject(int width, int height, Attachment attachment,
91 QMacCompatGLenum target = GL_TEXTURE_2D, QMacCompatGLenum internal_format = GL_RGBA8);
92#endif
93
94 virtual ~QGLFramebufferObject();
95
96 QGLFramebufferObjectFormat format() const;
97
98 bool isValid() const;
99 bool isBound() const;
100 bool bind();
101 bool release();
102
103 GLuint texture() const;
104 QSize size() const;
105 QImage toImage() const;
106 Attachment attachment() const;
107
108 QPaintEngine *paintEngine() const;
109 GLuint handle() const;
110
111 static bool bindDefault();
112
113 static bool hasOpenGLFramebufferObjects();
114
115 void drawTexture(const QRectF &target, GLuint textureId, GLenum textureTarget = GL_TEXTURE_2D);
116 void drawTexture(const QPointF &point, GLuint textureId, GLenum textureTarget = GL_TEXTURE_2D);
117#ifdef Q_MAC_COMPAT_GL_FUNCTIONS
118 void drawTexture(const QRectF &target, QMacCompatGLuint textureId, QMacCompatGLenum textureTarget = GL_TEXTURE_2D);
119 void drawTexture(const QPointF &point, QMacCompatGLuint textureId, QMacCompatGLenum textureTarget = GL_TEXTURE_2D);
120#endif
121
122 static bool hasOpenGLFramebufferBlit();
123 static void blitFramebuffer(QGLFramebufferObject *target, const QRect &targetRect,
124 QGLFramebufferObject *source, const QRect &sourceRect,
125 GLbitfield buffers = GL_COLOR_BUFFER_BIT,
126 GLenum filter = GL_NEAREST);
127
128protected:
129 int metric(PaintDeviceMetric metric) const;
130 int devType() const { return QInternal::FramebufferObject; }
131
132private:
133 Q_DISABLE_COPY(QGLFramebufferObject)
134 QScopedPointer<QGLFramebufferObjectPrivate> d_ptr;
135 friend class QGLPaintDevice;
136 friend class QGLFBOGLPaintDevice;
137};
138
139class QGLFramebufferObjectFormatPrivate;
140class Q_OPENGL_EXPORT QGLFramebufferObjectFormat
141{
142public:
143 QGLFramebufferObjectFormat();
144 QGLFramebufferObjectFormat(const QGLFramebufferObjectFormat &other);
145 QGLFramebufferObjectFormat &operator=(const QGLFramebufferObjectFormat &other);
146 ~QGLFramebufferObjectFormat();
147
148 void setSamples(int samples);
149 int samples() const;
150
151 void setMipmap(bool enabled);
152 bool mipmap() const;
153
154 void setAttachment(QGLFramebufferObject::Attachment attachment);
155 QGLFramebufferObject::Attachment attachment() const;
156
157 void setTextureTarget(GLenum target);
158 GLenum textureTarget() const;
159
160 void setInternalTextureFormat(GLenum internalTextureFormat);
161 GLenum internalTextureFormat() const;
162
163#ifdef Q_MAC_COMPAT_GL_FUNCTIONS
164 void setTextureTarget(QMacCompatGLenum target);
165 void setInternalTextureFormat(QMacCompatGLenum internalTextureFormat);
166#endif
167
168 bool operator==(const QGLFramebufferObjectFormat& other) const;
169 bool operator!=(const QGLFramebufferObjectFormat& other) const;
170
171private:
172 QGLFramebufferObjectFormatPrivate *d;
173
174 void detach();
175};
176
177QT_END_NAMESPACE
178
179QT_END_HEADER
180#endif // QGLFRAMEBUFFEROBJECT_H
181