source: trunk/src/opengl/qgl.h@ 606

Last change on this file since 606 was 561, checked in by Dmitry A. Kuminov, 16 years ago

trunk: Merged in qt 4.6.1 sources.
File size: 19.4 KB
Line 
1/****************************************************************************
2**
3** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
4** All rights reserved.
5** Contact: Nokia Corporation ([email protected])
6**
7** This file is part of the QtOpenGL module of the Qt Toolkit.
8**
9** $QT_BEGIN_LICENSE:LGPL$
10** Commercial Usage
11** Licensees holding valid Qt Commercial licenses may use this file in
12** accordance with the Qt Commercial License Agreement provided with the
13** Software or, alternatively, in accordance with the terms contained in
14** a written agreement between you and Nokia.
15**
16** GNU Lesser General Public License Usage
17** Alternatively, this file may be used under the terms of the GNU Lesser
18** General Public License version 2.1 as published by the Free Software
19** Foundation and appearing in the file LICENSE.LGPL included in the
20** packaging of this file. Please review the following information to
21** ensure the GNU Lesser General Public License version 2.1 requirements
22** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
23**
24** In addition, as a special exception, Nokia gives you certain additional
25** rights. These rights are described in the Nokia Qt LGPL Exception
26** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
27**
28** GNU General Public License Usage
29** Alternatively, this file may be used under the terms of the GNU
30** General Public License version 3.0 as published by the Free Software
31** Foundation and appearing in the file LICENSE.GPL included in the
32** packaging of this file. Please review the following information to
33** ensure the GNU General Public License version 3.0 requirements will be
34** met: http://www.gnu.org/copyleft/gpl.html.
35**
36** If you have questions regarding the use of this file, please contact
37** Nokia at [email protected].
38** $QT_END_LICENSE$
39**
40****************************************************************************/
41
42#ifndef QGL_H
43#define QGL_H
44
45#include <QtGui/qwidget.h>
46#include <QtGui/qpaintengine.h>
47#include <QtOpenGL/qglcolormap.h>
48#include <QtCore/qmap.h>
49#include <QtCore/qscopedpointer.h>
50
51QT_BEGIN_HEADER
52
53#if defined(Q_WS_WIN)
54# include <QtCore/qt_windows.h>
55#endif
56
57#if defined(Q_WS_MAC)
58# include <OpenGL/gl.h>
59# include <OpenGL/glu.h>
60#elif defined(QT_OPENGL_ES_1) || defined(QT_OPENGL_ES_1_CL)
61# include <GLES/gl.h>
62#ifndef GL_DOUBLE
63# define GL_DOUBLE GL_FLOAT
64#endif
65#ifndef GLdouble
66typedef GLfloat GLdouble;
67#endif
68#elif defined(QT_OPENGL_ES_2)
69# include <GLES2/gl2.h>
70#ifndef GL_DOUBLE
71# define GL_DOUBLE GL_FLOAT
72#endif
73#ifndef GLdouble
74typedef GLfloat GLdouble;
75#endif
76#else
77# include <GL/gl.h>
78# ifndef QT_LINUXBASE
79# include <GL/glu.h>
80# endif
81#endif
82
83QT_BEGIN_NAMESPACE
84
85QT_MODULE(OpenGL)
86
87#if defined(Q_WS_MAC) && defined (QT_BUILD_OPENGL_LIB) && !defined(QT_MAC_USE_COCOA) && !defined(QDOC)
88#define Q_MAC_COMPAT_GL_FUNCTIONS
89
90template <typename T>
91struct QMacGLCompatTypes
92{
93 typedef long CompatGLint;
94 typedef unsigned long CompatGLuint;
95 typedef unsigned long CompatGLenum;
96};
97
98template <>
99struct QMacGLCompatTypes<long>
100{
101 typedef int CompatGLint;
102 typedef unsigned int CompatGLuint;
103 typedef unsigned int CompatGLenum;
104};
105
106typedef QMacGLCompatTypes<GLint>::CompatGLint QMacCompatGLint;
107typedef QMacGLCompatTypes<GLint>::CompatGLuint QMacCompatGLuint;
108typedef QMacGLCompatTypes<GLint>::CompatGLenum QMacCompatGLenum;
109
110#endif
111
112#ifdef QT3_SUPPORT
113#define QGL_VERSION 460
114#define QGL_VERSION_STR "4.6"
115inline QT3_SUPPORT const char *qGLVersion() {
116 return QGL_VERSION_STR;
117}
118#endif
119
120#if defined(Q_WS_WIN) || defined(Q_WS_MAC)
121class QGLCmap;
122#endif
123
124class QPixmap;
125#if defined(Q_WS_X11) && !defined(QT_OPENGL_ES)
126class QGLOverlayWidget;
127#endif
128class QGLWidgetPrivate;
129class QGLContextPrivate;
130
131// Namespace class:
132namespace QGL
133{
134 Q_OPENGL_EXPORT void setPreferredPaintEngine(QPaintEngine::Type engineType);
135
136 enum FormatOption {
137 DoubleBuffer = 0x0001,
138 DepthBuffer = 0x0002,
139 Rgba = 0x0004,
140 AlphaChannel = 0x0008,
141 AccumBuffer = 0x0010,
142 StencilBuffer = 0x0020,
143 StereoBuffers = 0x0040,
144 DirectRendering = 0x0080,
145 HasOverlay = 0x0100,
146 SampleBuffers = 0x0200,
147 SingleBuffer = DoubleBuffer << 16,
148 NoDepthBuffer = DepthBuffer << 16,
149 ColorIndex = Rgba << 16,
150 NoAlphaChannel = AlphaChannel << 16,
151 NoAccumBuffer = AccumBuffer << 16,
152 NoStencilBuffer = StencilBuffer << 16,
153 NoStereoBuffers = StereoBuffers << 16,
154 IndirectRendering = DirectRendering << 16,
155 NoOverlay = HasOverlay << 16,
156 NoSampleBuffers = SampleBuffers << 16
157 };
158 Q_DECLARE_FLAGS(FormatOptions, FormatOption)
159}
160
161Q_DECLARE_OPERATORS_FOR_FLAGS(QGL::FormatOptions)
162
163class QGLFormatPrivate;
164
165class Q_OPENGL_EXPORT QGLFormat
166{
167public:
168 QGLFormat();
169 QGLFormat(QGL::FormatOptions options, int plane = 0);
170 QGLFormat(const QGLFormat &other);
171 QGLFormat &operator=(const QGLFormat &other);
172 ~QGLFormat();
173
174 void setDepthBufferSize(int size);
175 int depthBufferSize() const;
176
177 void setAccumBufferSize(int size);
178 int accumBufferSize() const;
179
180 void setRedBufferSize(int size);
181 int redBufferSize() const;
182
183 void setGreenBufferSize(int size);
184 int greenBufferSize() const;
185
186 void setBlueBufferSize(int size);
187 int blueBufferSize() const;
188
189 void setAlphaBufferSize(int size);
190 int alphaBufferSize() const;
191
192 void setStencilBufferSize(int size);
193 int stencilBufferSize() const;
194
195 void setSampleBuffers(bool enable);
196 bool sampleBuffers() const;
197
198 void setSamples(int numSamples);
199 int samples() const;
200
201 void setSwapInterval(int interval);
202 int swapInterval() const;
203
204 bool doubleBuffer() const;
205 void setDoubleBuffer(bool enable);
206 bool depth() const;
207 void setDepth(bool enable);
208 bool rgba() const;
209 void setRgba(bool enable);
210 bool alpha() const;
211 void setAlpha(bool enable);
212 bool accum() const;
213 void setAccum(bool enable);
214 bool stencil() const;
215 void setStencil(bool enable);
216 bool stereo() const;
217 void setStereo(bool enable);
218 bool directRendering() const;
219 void setDirectRendering(bool enable);
220 bool hasOverlay() const;
221 void setOverlay(bool enable);
222
223 int plane() const;
224 void setPlane(int plane);
225
226 void setOption(QGL::FormatOptions opt);
227 bool testOption(QGL::FormatOptions opt) const;
228
229 static QGLFormat defaultFormat();
230 static void setDefaultFormat(const QGLFormat& f);
231
232 static QGLFormat defaultOverlayFormat();
233 static void setDefaultOverlayFormat(const QGLFormat& f);
234
235 static bool hasOpenGL();
236 static bool hasOpenGLOverlays();
237
238 enum OpenGLVersionFlag {
239 OpenGL_Version_None = 0x00000000,
240 OpenGL_Version_1_1 = 0x00000001,
241 OpenGL_Version_1_2 = 0x00000002,
242 OpenGL_Version_1_3 = 0x00000004,
243 OpenGL_Version_1_4 = 0x00000008,
244 OpenGL_Version_1_5 = 0x00000010,
245 OpenGL_Version_2_0 = 0x00000020,
246 OpenGL_Version_2_1 = 0x00000040,
247 OpenGL_ES_Common_Version_1_0 = 0x00000080,
248 OpenGL_ES_CommonLite_Version_1_0 = 0x00000100,
249 OpenGL_ES_Common_Version_1_1 = 0x00000200,
250 OpenGL_ES_CommonLite_Version_1_1 = 0x00000400,
251 OpenGL_ES_Version_2_0 = 0x00000800,
252 OpenGL_Version_3_0 = 0x00001000
253 };
254 Q_DECLARE_FLAGS(OpenGLVersionFlags, OpenGLVersionFlag)
255
256 static OpenGLVersionFlags openGLVersionFlags();
257
258private:
259 QGLFormatPrivate *d;
260
261 void detach();
262
263 friend Q_OPENGL_EXPORT bool operator==(const QGLFormat&, const QGLFormat&);
264 friend Q_OPENGL_EXPORT bool operator!=(const QGLFormat&, const QGLFormat&);
265};
266
267Q_DECLARE_OPERATORS_FOR_FLAGS(QGLFormat::OpenGLVersionFlags)
268
269Q_OPENGL_EXPORT bool operator==(const QGLFormat&, const QGLFormat&);
270Q_OPENGL_EXPORT bool operator!=(const QGLFormat&, const QGLFormat&);
271
272class Q_OPENGL_EXPORT QGLContext
273{
274 Q_DECLARE_PRIVATE(QGLContext)
275public:
276 QGLContext(const QGLFormat& format, QPaintDevice* device);
277 QGLContext(const QGLFormat& format);
278 virtual ~QGLContext();
279
280 virtual bool create(const QGLContext* shareContext = 0);
281 bool isValid() const;
282 bool isSharing() const;
283 void reset();
284
285 static bool areSharing(const QGLContext *context1, const QGLContext *context2);
286
287 QGLFormat format() const;
288 QGLFormat requestedFormat() const;
289 void setFormat(const QGLFormat& format);
290
291 // ### Qt 5: return bools + maybe remove virtuals
292 virtual void makeCurrent();
293 virtual void doneCurrent();
294
295 virtual void swapBuffers() const;
296
297 enum BindOption {
298 NoBindOption = 0x0000,