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 QOPENGLFRAMEBUFFEROBJECT_P_H
41#define QOPENGLFRAMEBUFFEROBJECT_P_H
42
43//
44// W A R N I N G
45// -------------
46//
47// This file is not part of the Qt API. It exists purely as an
48// implementation detail. This header file may change from version to
49// version without notice, or even be removed.
50//
51// We mean it.
52//
53
54#include <qopenglframebufferobject.h>
55#include <private/qopenglcontext_p.h>
56#include <private/qopenglextensions_p.h>
57
58QT_BEGIN_NAMESPACE
59
60class QOpenGLFramebufferObjectFormatPrivate
61{
62public:
63 QOpenGLFramebufferObjectFormatPrivate()
64 : ref(1),
65 samples(0),
66 attachment(QOpenGLFramebufferObject::NoAttachment),
67 target(GL_TEXTURE_2D),
68 mipmap(false)
69 {
70#if !QT_CONFIG(opengles2)
71 // There is nothing that says QOpenGLFramebufferObjectFormat needs a current
72 // context, so we need a fallback just to be safe, even though in pratice there
73 // will usually be a context current.
74 QOpenGLContext *ctx = QOpenGLContext::currentContext();
75 const bool isES = ctx ? ctx->isOpenGLES() : QOpenGLContext::openGLModuleType() != QOpenGLContext::LibGL;
76 internal_format = isES ? GL_RGBA : GL_RGBA8;
77#else
78 internal_format = GL_RGBA;
79#endif
80 }
81 QOpenGLFramebufferObjectFormatPrivate
82 (const QOpenGLFramebufferObjectFormatPrivate *other)
83 : ref(1),
84 samples(other->samples),
85 attachment(other->attachment),
86 target(other->target),
87 internal_format(other->internal_format),
88 mipmap(other->mipmap)
89 {
90 }
91 bool equals(const QOpenGLFramebufferObjectFormatPrivate *other)
92 {
93 return samples == other->samples &&
94 attachment == other->attachment &&
95 target == other->target &&
96 internal_format == other->internal_format &&
97 mipmap == other->mipmap;
98 }
99
100 QAtomicInt ref;
101 int samples;
102 QOpenGLFramebufferObject::Attachment attachment;
103 GLenum target;
104 GLenum internal_format;
105 uint mipmap : 1;
106};
107
108class QOpenGLFramebufferObjectPrivate
109{
110public:
111 QOpenGLFramebufferObjectPrivate() : fbo_guard(nullptr), depth_buffer_guard(nullptr)
112 , stencil_buffer_guard(nullptr)
113 , valid(false) {}
114 ~QOpenGLFramebufferObjectPrivate() {}
115
116 void init(QOpenGLFramebufferObject *q, const QSize &size,
117 QOpenGLFramebufferObject::Attachment attachment,
118 GLenum texture_target, GLenum internal_format,
119 GLint samples = 0, bool mipmap = false);
120 void initTexture(int idx);
121 void initColorBuffer(int idx, GLint *samples);
122 void initDepthStencilAttachments(QOpenGLContext *ctx, QOpenGLFramebufferObject::Attachment attachment);
123
124 bool checkFramebufferStatus(QOpenGLContext *ctx) const;
125 QOpenGLSharedResourceGuard *fbo_guard;
126 QOpenGLSharedResourceGuard *depth_buffer_guard;
127 QOpenGLSharedResourceGuard *stencil_buffer_guard;
128 GLenum target;
129 QSize dsSize;
130 QOpenGLFramebufferObjectFormat format;
131 int requestedSamples;
132 uint valid : 1;
133 QOpenGLFramebufferObject::Attachment fbo_attachment;
134 QOpenGLExtensions funcs;
135
136 struct ColorAttachment {
137 ColorAttachment() : internalFormat(0), guard(nullptr) { }
138 ColorAttachment(const QSize &size, GLenum internalFormat)
139 : size(size), internalFormat(internalFormat), guard(nullptr) { }
140 QSize size;
141 GLenum internalFormat;
142 QOpenGLSharedResourceGuard *guard;
143 };
144 QVarLengthArray<ColorAttachment, 8> colorAttachments;
145
146 inline GLuint fbo() const { return fbo_guard ? fbo_guard->id() : 0; }
147};
148
149Q_OPENGL_EXPORT QImage qt_gl_read_framebuffer(const QSize &size, bool alpha_format, bool include_alpha);
150
151QT_END_NAMESPACE
152
153#endif // QOPENGLFRAMEBUFFEROBJECT_P_H
154