summaryrefslogtreecommitdiffstats
path: root/doc/html/qgl-h.html
blob: 86ba13ce5d587c4e4f779adf78aff0ff1e272a92 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<!-- /home/espenr/tmp/qt-3.3.8-espenr-2499/qt-x11-free-3.3.8/include/qgl.h:1 -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>qgl.h Include File</title>
<style type="text/css"><!--
fn { margin-left: 1cm; text-indent: -1cm; }
a:link { color: #004faf; text-decoration: none }
a:visited { color: #672967; text-decoration: none }
body { background: #ffffff; color: black; }
--></style>
</head>
<body>

<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr bgcolor="#E5E5E5">
<td valign=center>
 <a href="index.html">
<font color="#004faf">Home</font></a>
 | <a href="classes.html">
<font color="#004faf">All&nbsp;Classes</font></a>
 | <a href="mainclasses.html">
<font color="#004faf">Main&nbsp;Classes</font></a>
 | <a href="annotated.html">
<font color="#004faf">Annotated</font></a>
 | <a href="groups.html">
<font color="#004faf">Grouped&nbsp;Classes</font></a>
 | <a href="functions.html">
<font color="#004faf">Functions</font></a>
</td>
<td align="right" valign="center"><img src="logo32.png" align="right" width="64" height="32" border="0"></td></tr></table><h1 align=center>qgl.h</h1>

<p>This is the verbatim text of the qgl.h include file. It is provided only for illustration; the copyright remains with Trolltech.
<hr>
<pre>
/****************************************************************************
** $Id: qt/qgl.h   3.3.8   edited Jan 11 14:38 $
**
** Definition of OpenGL classes for TQt
**
** Created : 970112
**
** Copyright (C) 1992-2007 Trolltech ASA.  All rights reserved.
**
** This file is part of the opengl module of the TQt GUI Toolkit.
**
** This file may be used under the terms of the GNU General Public
** License versions 2.0 or 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file. Alternatively you may (at your option) use any
** later version of the GNU General Public License if such license has
** been publicly approved by Trolltech ASA (or its successors, if any)
** and the KDE Free TQt Foundation.
**
** Please review the following information to ensure GNU General
** Public Licensing requirements will be met:
** http://trolltech.com/products/qt/licenses/licensing/opensource/.
** If you are unsure which license is appropriate for your use, please
** review the following information:
** http://trolltech.com/products/qt/licenses/licensing/licensingoverview
** or contact the sales department at [email protected].
**
** This file may be used under the terms of the Q Public License as
** defined by Trolltech ASA and appearing in the file LICENSE.TQPL
** included in the packaging of this file.  Licensees holding valid TQt
** Commercial licenses may use this file in accordance with the TQt
** Commercial License Agreement provided with the Software.
**
** This file is provided "AS IS" with NO WARRANTY OF ANY KIND,
** INCLUDING THE WARRANTIES OF DESIGN, MERCHANTABILITY AND FITNESS FOR
** A PARTICULAR PURPOSE. Trolltech reserves all rights not granted
** herein.
**
**********************************************************************/

#ifndef TQGL_H
#define TQGL_H

#ifndef QT_H
#include "qwidget.h"
#include "qglcolormap.h"
#endif // QT_H

#if !defined( QT_MODULE_OPENGL ) || defined( QT_LICENSE_PROFESSIONAL )
#define TQM_EXPORT_OPENGL
#else
#define TQM_EXPORT_OPENGL Q_EXPORT
#endif

#ifndef QT_NO_COMPAT
#define TQGL_VERSION	450
#define TQGL_VERSION_STR	"4.5"
TQM_EXPORT_OPENGL inline const char *qGLVersion() {
    qObsolete( 0, "qGLVersion", "qVersion" );
    return TQGL_VERSION_STR;
}
#endif

#if defined(Q_WS_WIN)
# include "qt_windows.h"
#endif

#if defined(Q_WS_MAC)
#if !defined( TQMAC_OPENGL_DOUBLEBUFFER )
/* This macro is different now. If the macro is not defined TQGLWidget will
 * try to determine when you need double buffering.  If set to 0 it will
 * never double buffer and *can* be acclerated. If set to 1 (the default)
 * it will always double buffer. Unlike before the value of this macro does
 * not upset binary compatability either. */
#if QT_MACOSX_VERSION &gt;= 0x1020
# define TQMAC_OPENGL_DOUBLEBUFFER 0
#endif
#endif
# include &lt;OpenGL/gl.h&gt;
# include &lt;OpenGL/glu.h&gt;
#else
# include &lt;GL/gl.h&gt;
# include &lt;GL/glu.h&gt;
#endif

#if defined(Q_WS_WIN) || defined(Q_WS_MAC)
class TQGLCmap;
#endif

class TQPixmap;
#if defined(Q_WS_X11)
class TQGLOverlayWidget;
#endif

// Namespace class:
class TQM_EXPORT_OPENGL TQGL
{
public:
    enum FormatOption {
	DoubleBuffer		= 0x0001,
	DepthBuffer		= 0x0002,
	Rgba			= 0x0004,
	AlphaChannel		= 0x0008,
	AccumBuffer		= 0x0010,
	StencilBuffer		= 0x0020,
	StereoBuffers		= 0x0040,
	DirectRendering		= 0x0080,
	HasOverlay		= 0x0100,
	SingleBuffer            = DoubleBuffer  &lt;&lt; 16,
	NoDepthBuffer           = DepthBuffer   &lt;&lt; 16,
	ColorIndex              = Rgba          &lt;&lt; 16,
	NoAlphaChannel          = AlphaChannel  &lt;&lt; 16,
	NoAccumBuffer           = AccumBuffer   &lt;&lt; 16,
	NoStencilBuffer         = StencilBuffer &lt;&lt; 16,
	NoStereoBuffers         = StereoBuffers &lt;&lt; 16,
	IndirectRendering       = DirectRendering &lt;&lt; 16,
	NoOverlay		= HasOverlay &lt;&lt; 16
    };
};



class TQM_EXPORT_OPENGL TQGLFormat : public TQGL
{
public:
    TQGLFormat();
    TQGLFormat( int options, int plane = 0 );

    bool doubleBuffer() const;
    void setDoubleBuffer( bool enable );
    bool depth() const;
    void setDepth( bool enable );
    bool rgba() const;
    void setRgba( bool enable );
    bool alpha() const;
    void setAlpha( bool enable );
    bool accum() const;
    void setAccum( bool enable );
    bool stencil() const;
    void setStencil( bool enable );
    bool stereo() const;
    void setStereo( bool enable );
    bool directRendering() const;
    void setDirectRendering( bool enable );
    bool hasOverlay() const;
    void setOverlay( bool enable );

    int plane() const;
    void setPlane( int plane );

    void setOption( FormatOption opt );
    bool testOption( FormatOption opt ) const;

    static TQGLFormat defaultFormat();
    static void setDefaultFormat( const TQGLFormat&amp; f );

    static TQGLFormat defaultOverlayFormat();
    static void setDefaultOverlayFormat( const TQGLFormat&amp; f );

    static bool hasOpenGL();
    static bool hasOpenGLOverlays();

    friend TQM_EXPORT_OPENGL bool operator==( const TQGLFormat&amp;,
					     const TQGLFormat&amp; );
    friend TQM_EXPORT_OPENGL bool operator!=( const TQGLFormat&amp;,
					     const TQGLFormat&amp; );
private:
    uint opts;
    int pln;
};


TQM_EXPORT_OPENGL bool operator==( const TQGLFormat&amp;, const TQGLFormat&amp; );
TQM_EXPORT_OPENGL bool operator!=( const TQGLFormat&amp;, const TQGLFormat&amp; );

class TQM_EXPORT_OPENGL TQGLContext : public TQGL
{
public:
    TQGLContext( const TQGLFormat&amp; format, TQPaintDevice* device );
    TQGLContext( const TQGLFormat&amp; format );
    virtual ~TQGLContext();

    virtual bool create( const TQGLContext* shareContext = 0 );
    bool isValid() const;
    bool isSharing() const;
    virtual void reset();

    TQGLFormat format() const;
    TQGLFormat requestedFormat() const;
    virtual void setFormat( const TQGLFormat&amp; format );

    virtual void makeCurrent();
    virtual void swapBuffers() const;

    TQPaintDevice* device() const;

    TQColor overlayTransparentColor() const;

    static const TQGLContext* currentContext();

protected:
    virtual bool chooseContext( const TQGLContext* shareContext = 0 );
    virtual void doneCurrent(); // ### 4.0: make this public - needed for multithreading stuff

#if defined(Q_WS_WIN)
    virtual int choosePixelFormat( void* pfd, HDC pdc );
#endif
#if defined(Q_WS_X11)
    virtual void* tryVisual( const TQGLFormat&amp; f, int bufDepth = 1 );
    virtual void* chooseVisual();
#endif
#if defined(Q_WS_MAC)
    virtual void* chooseMacVisual(GDHandle);
#endif

    bool deviceIsPixmap() const;
    bool windowCreated() const;
    void setWindowCreated( bool on );
    bool initialized() const;
    void setInitialized( bool on );
    void generateFontDisplayLists( const TQFont &amp; fnt, int listBase );

    uint colorIndex( const TQColor&amp; c ) const;
    void setValid( bool valid );
    void setDevice( TQPaintDevice *pDev );

protected:
#if  defined(Q_WS_WIN)
    HGLRC rc;
    HDC dc;
    WId	win;
    int pixelFormatId;
    TQGLCmap* cmap;
#elif defined(Q_WS_X11) || defined(Q_WS_MAC)
    void* vi;
    void* cx;
#if defined(Q_WS_X11)
    Q_UINT32 gpm;
#endif
#endif
    TQGLFormat glFormat;
    TQGLFormat reqFormat;
    static TQGLContext*	currentCtx;

private:
    void init( TQPaintDevice *dev = 0 );
    class Private {
    public:
	bool valid;
	bool sharing;
	bool initDone;
	bool crWin;
	TQPaintDevice* paintDevice;
	TQColor transpColor;
#ifdef Q_WS_MAC
	TQRect oldR;
#endif
    };
    Private* d;

    friend class TQGLWidget;
#ifdef Q_WS_MAC
    void fixBufferRect();
#endif

private:	// Disabled copy constructor and operator=
    TQGLContext() {}
    TQGLContext( const TQGLContext&amp; ) {}
    TQGLContext&amp; operator=( const TQGLContext&amp; ) { return *this; }
};




class TQM_EXPORT_OPENGL TQGLWidget : public TQWidget, public TQGL
{
    Q_OBJECT
public:
    TQGLWidget( TQWidget* parent=0, const char* name=0,
	       const TQGLWidget* shareWidget = 0, WFlags f=0 );
    TQGLWidget( TQGLContext *context, TQWidget* parent, const char* name=0,
	       const TQGLWidget* shareWidget = 0, WFlags f=0 );
    TQGLWidget( const TQGLFormat&amp; format, TQWidget* parent=0, const char* name=0,
	       const TQGLWidget* shareWidget = 0, WFlags f=0 );
    ~TQGLWidget();

    void qglColor( const TQColor&amp; c ) const;
    void qglClearColor( const TQColor&amp; c ) const;

    bool isValid() const;
    bool isSharing() const;
    virtual void makeCurrent();
    void doneCurrent();
    
    bool doubleBuffer() const;
    virtual void swapBuffers();

    TQGLFormat format() const;
#ifndef Q_QDOC
    virtual void setFormat( const TQGLFormat&amp; format );
#endif

    const TQGLContext* context() const;
#ifndef Q_QDOC
    virtual void setContext( TQGLContext* context,
			     const TQGLContext* shareContext = 0,
			     bool deleteOldContext = TRUE );
#endif

    virtual TQPixmap renderPixmap( int w = 0, int h = 0,
				  bool useContext = FALSE );
    virtual TQImage grabFrameBuffer( bool withAlpha = FALSE );

    virtual void makeOverlayCurrent();
    const TQGLContext* overlayContext() const;

    static TQImage convertToGLFormat( const TQImage&amp; img );

    void setMouseTracking( bool enable );
    virtual void  reparent( TQWidget* parent, WFlags f, const TQPoint&amp; p,
			    bool showIt = FALSE );

    const TQGLColormap &amp; colormap() const;
    void  setColormap( const TQGLColormap &amp; map );

    void renderText( int x, int y, const TQString &amp; str,
		     const TQFont &amp; fnt = TQFont(), int listBase = 2000 );
    void renderText( double x, double y, double z, const TQString &amp; str,
		     const TQFont &amp; fnt = TQFont(), int listBase = 2000 );
public slots:
    virtual void updateGL();
    virtual void updateOverlayGL();

protected:
    virtual void initializeGL();
    virtual void resizeGL( int w, int h );
    virtual void paintGL();

    virtual void initializeOverlayGL();
    virtual void resizeOverlayGL( int w, int h );
    virtual void paintOverlayGL();

    void setAutoBufferSwap( bool on );
    bool autoBufferSwap() const;

    void paintEvent( TQPaintEvent* );
    void resizeEvent( TQResizeEvent* );

    virtual void glInit();
    virtual void glDraw();

private:
    int displayListBase( const TQFont &amp; fnt, int listBase );
    void cleanupColormaps();
    void init( TQGLContext *context, const TQGLWidget* shareWidget );
    bool renderCxPm( TQPixmap* pm );
    TQGLContext* glcx;
    bool autoSwap;

    TQGLColormap cmap;

#if defined(Q_WS_WIN) || defined(Q_WS_MAC)
    TQGLContext* olcx;
#elif defined(Q_WS_X11)
    TQGLOverlayWidget*	olw;
    friend class TQGLOverlayWidget;
#endif

private:	// Disabled copy constructor and operator=
#if defined(Q_DISABLE_COPY)
    TQGLWidget( const TQGLWidget&amp; );
    TQGLWidget&amp; operator=( const TQGLWidget&amp; );
#endif

#if defined(Q_WS_MAC)
private:
    const TQGLContext *slcx;
    uint pending_fix : 1,
	 glcx_dblbuf : 2,
	 dblbuf : 1,
	 clp_serial : 15;
    TQPixmap *gl_pix;
    TQGLFormat req_format;

    void macInternalRecreateContext( TQGLContext *ctx,
				     const TQGLContext* = NULL,
				     bool update = TRUE );
    bool macInternalDoubleBuffer( bool fix = TRUE );
    virtual void setRegionDirty( bool );
    virtual void macWidgetChangedWindow();
#endif
private slots:
    void macInternalFixBufferRect();
};


//
// TQGLFormat inline functions
//

inline bool TQGLFormat::doubleBuffer() const
{
    return testOption( DoubleBuffer );
}

inline bool TQGLFormat::depth() const
{
    return testOption( DepthBuffer );
}

inline bool TQGLFormat::rgba() const
{
    return testOption( Rgba );
}

inline bool TQGLFormat::alpha() const
{
    return testOption( AlphaChannel );
}

inline bool TQGLFormat::accum() const
{
    return testOption( AccumBuffer );
}

inline bool TQGLFormat::stencil() const
{
    return testOption( StencilBuffer );
}

inline bool TQGLFormat::stereo() const
{
    return testOption( StereoBuffers );
}

inline bool TQGLFormat::directRendering() const
{
    return testOption( DirectRendering );
}

inline bool TQGLFormat::hasOverlay() const
{
    return testOption( HasOverlay );
}

//
// TQGLContext inline functions
//

inline bool TQGLContext::isValid() const
{
    return d-&gt;valid;
}

inline void TQGLContext::setValid( bool valid )
{
    d-&gt;valid = valid;
}

inline bool TQGLContext::isSharing() const
{
    return d-&gt;sharing;
}

inline TQGLFormat TQGLContext::format() const
{
    return glFormat;
}

inline TQGLFormat TQGLContext::requestedFormat() const
{
    return reqFormat;
}

inline TQPaintDevice* TQGLContext::device() const
{
    return d-&gt;paintDevice;
}

inline bool TQGLContext::deviceIsPixmap() const
{
    return d-&gt;paintDevice-&gt;devType() == TQInternal::Pixmap;
}


inline bool TQGLContext::windowCreated() const
{
    return d-&gt;crWin;
}


inline void TQGLContext::setWindowCreated( bool on )
{
    d-&gt;crWin = on;
}

inline bool TQGLContext::initialized() const
{
    return d-&gt;initDone;
}

inline void TQGLContext::setInitialized( bool on )
{
    d-&gt;initDone = on;
}

inline const TQGLContext* TQGLContext::currentContext()
{
    return currentCtx;
}

//
// TQGLWidget inline functions
//

inline TQGLFormat TQGLWidget::format() const
{
    return glcx-&gt;format();
}

inline const TQGLContext *TQGLWidget::context() const
{
    return glcx;
}

inline bool TQGLWidget::doubleBuffer() const
{
    return glcx-&gt;format().doubleBuffer();
}

inline void TQGLWidget::setAutoBufferSwap( bool on )
{
    autoSwap = on;
}

inline bool TQGLWidget::autoBufferSwap() const
{
    return autoSwap;
}

#endif
</pre>
<!-- eof -->
<p><address><hr><div align=center>
<table width=100% cellspacing=0 border=0><tr>
<td>Copyright &copy; 2007
<a href="troll.html">Trolltech</a><td align=center><a href="trademarks.html">Trademarks</a>
<td align=right><div align=right>TQt 3.3.8</div>
</table></div></address></body>
</html>