summaryrefslogtreecommitdiffstats
path: root/doc/html/qglformat.html
blob: 0b970f458e6d24a1153ec2caf395980628f330c1 (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
<!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/src/opengl/qgl.cpp:95 -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>TQGLFormat Class</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>TQGLFormat Class Reference<br><small>[<a href="opengl.html">OpenGL module</a>]</small></h1>

<p>The TQGLFormat class specifies the display format of an OpenGL
rendering context.
<a href="#details">More...</a>
<p><tt>#include &lt;<a href="qgl-h.html">ntqgl.h</a>&gt;</tt>
<p>Inherits <a href="ntqgl.html">TQGL</a>.
<p><a href="qglformat-members.html">List of all member functions.</a>
<h2>Public Members</h2>
<ul>
<li class=fn><a href="#TQGLFormat"><b>TQGLFormat</b></a> ()</li>
<li class=fn><a href="#TQGLFormat-2"><b>TQGLFormat</b></a> ( int&nbsp;options, int&nbsp;plane = 0 )</li>
<li class=fn>bool <a href="#doubleBuffer"><b>doubleBuffer</b></a> () const</li>
<li class=fn>void <a href="#setDoubleBuffer"><b>setDoubleBuffer</b></a> ( bool&nbsp;enable )</li>
<li class=fn>bool <a href="#depth"><b>depth</b></a> () const</li>
<li class=fn>void <a href="#setDepth"><b>setDepth</b></a> ( bool&nbsp;enable )</li>
<li class=fn>bool <a href="#rgba"><b>rgba</b></a> () const</li>
<li class=fn>void <a href="#setRgba"><b>setRgba</b></a> ( bool&nbsp;enable )</li>
<li class=fn>bool <a href="#alpha"><b>alpha</b></a> () const</li>
<li class=fn>void <a href="#setAlpha"><b>setAlpha</b></a> ( bool&nbsp;enable )</li>
<li class=fn>bool <a href="#accum"><b>accum</b></a> () const</li>
<li class=fn>void <a href="#setAccum"><b>setAccum</b></a> ( bool&nbsp;enable )</li>
<li class=fn>bool <a href="#stencil"><b>stencil</b></a> () const</li>
<li class=fn>void <a href="#setStencil"><b>setStencil</b></a> ( bool&nbsp;enable )</li>
<li class=fn>bool <a href="#stereo"><b>stereo</b></a> () const</li>
<li class=fn>void <a href="#setStereo"><b>setStereo</b></a> ( bool&nbsp;enable )</li>
<li class=fn>bool <a href="#directRendering"><b>directRendering</b></a> () const</li>
<li class=fn>void <a href="#setDirectRendering"><b>setDirectRendering</b></a> ( bool&nbsp;enable )</li>
<li class=fn>bool <a href="#hasOverlay"><b>hasOverlay</b></a> () const</li>
<li class=fn>void <a href="#setOverlay"><b>setOverlay</b></a> ( bool&nbsp;enable )</li>
<li class=fn>int <a href="#plane"><b>plane</b></a> () const</li>
<li class=fn>void <a href="#setPlane"><b>setPlane</b></a> ( int&nbsp;plane )</li>
<li class=fn>void <a href="#setOption"><b>setOption</b></a> ( FormatOption&nbsp;opt )</li>
<li class=fn>bool <a href="#testOption"><b>testOption</b></a> ( FormatOption&nbsp;opt ) const</li>
</ul>
<h2>Static Public Members</h2>
<ul>
<li class=fn>TQGLFormat <a href="#defaultFormat"><b>defaultFormat</b></a> ()</li>
<li class=fn>void <a href="#setDefaultFormat"><b>setDefaultFormat</b></a> ( const&nbsp;TQGLFormat&nbsp;&amp;&nbsp;f )</li>
<li class=fn>TQGLFormat <a href="#defaultOverlayFormat"><b>defaultOverlayFormat</b></a> ()</li>
<li class=fn>void <a href="#setDefaultOverlayFormat"><b>setDefaultOverlayFormat</b></a> ( const&nbsp;TQGLFormat&nbsp;&amp;&nbsp;f )</li>
<li class=fn>bool <a href="#hasOpenGL"><b>hasOpenGL</b></a> ()</li>
<li class=fn>bool <a href="#hasOpenGLOverlays"><b>hasOpenGLOverlays</b></a> ()</li>
</ul>
<hr><a name="details"></a><h2>Detailed Description</h2>


The TQGLFormat class specifies the display format of an OpenGL
rendering context.

<p> 


<p> A display format has several characteristics:
<ul>
<li> <a href="#setDoubleBuffer">Double or single buffering.</a>
<li> <a href="#setDepth">Depth buffer.</a>
<li> <a href="#setRgba">RGBA or color index mode.</a>
<li> <a href="#setAlpha">Alpha channel.</a>
<li> <a href="#setAccum">Accumulation buffer.</a>
<li> <a href="#setStencil">Stencil buffer.</a>
<li> <a href="#setStereo">Stereo buffers.</a>
<li> <a href="#setDirectRendering">Direct rendering.</a>
<li> <a href="#setOverlay">Presence of an overlay.</a>
<li> <a href="#setPlane">The plane of an overlay format.</a>
</ul>
<p> You create and tell a TQGLFormat object what rendering options you
want from an OpenGL<sup>*</sup> rendering context.
<p> OpenGL drivers or accelerated hardware may or may not support
advanced features such as alpha channel or stereographic viewing.
If you request some features that the driver/hardware does not
provide when you create a <a href="qglwidget.html">TQGLWidget</a>, you will get a rendering
context with the nearest subset of features.
<p> There are different ways to define the display characteristics of
a rendering context. One is to create a TQGLFormat and make it the
default for the entire application:
<pre>
    TQGLFormat f;
    f.<a href="#setAlpha">setAlpha</a>( TRUE );
    f.<a href="#setStereo">setStereo</a>( TRUE );
    TQGLFormat::<a href="#setDefaultFormat">setDefaultFormat</a>( f );
    </pre>
 
<p> Or you can specify the desired format when creating an object of
your TQGLWidget subclass:
<pre>
    TQGLFormat f;
    f.<a href="#setDoubleBuffer">setDoubleBuffer</a>( FALSE );                 // single buffer
    f.<a href="#setDirectRendering">setDirectRendering</a>( FALSE );              // software rendering
    MyGLWidget* myWidget = new MyGLWidget( f, ... );
    </pre>
 
<p> After the widget has been created, you can find out which of the
requested features the system was able to provide:
<pre>
    TQGLFormat f;
    f.<a href="#setOverlay">setOverlay</a>( TRUE );
    f.<a href="#setStereo">setStereo</a>( TRUE );
    MyGLWidget* myWidget = new MyGLWidget( f, ... );
    if ( !w-&gt;format().stereo() ) {
        // ok, goggles off
        if ( !w-&gt;format().hasOverlay() ) {
            <a href="ntqapplication.html#qFatal">qFatal</a>( "Cool hardware required" );
        }
    }
    </pre>
 
<p> <sup>*</sup> OpenGL is a trademark of Silicon Graphics, Inc. in the
United States and other countries.
<p> <p>See also <a href="qglcontext.html">TQGLContext</a>, <a href="qglwidget.html">TQGLWidget</a>, <a href="graphics.html">Graphics Classes</a>, and <a href="images.html">Image Processing Classes</a>.

<hr><h2>Member Function Documentation</h2>
<h3 class=fn><a name="TQGLFormat"></a>TQGLFormat::TQGLFormat ()
</h3>
Constructs a TQGLFormat object with the factory default settings:
<ul>
<li> <a href="#setDoubleBuffer">Double buffer:</a> Enabled.
<li> <a href="#setDepth">Depth buffer:</a> Enabled.
<li> <a href="#setRgba">RGBA:</a> Enabled (i.e., color index disabled).
<li> <a href="#setAlpha">Alpha channel:</a> Disabled.
<li> <a href="#setAccum">Accumulator buffer:</a> Disabled.
<li> <a href="#setStencil">Stencil buffer:</a> Disabled.
<li> <a href="#setStereo">Stereo:</a> Disabled.
<li> <a href="#setDirectRendering">Direct rendering:</a> Enabled.
<li> <a href="#setOverlay">Overlay:</a> Disabled.
<li> <a href="#setPlane">Plane:</a> 0 (i.e., normal plane).
</ul>

<h3 class=fn><a name="TQGLFormat-2"></a>TQGLFormat::TQGLFormat ( int&nbsp;options, int&nbsp;plane = 0 )
</h3>
Creates a TQGLFormat object that is a copy of the current <a href="#defaultFormat">application default format</a>.
<p> If <em>options</em> is not 0, this copy is modified by these format
options. The <em>options</em> parameter should be <a href="ntqgl.html#FormatOption-enum">FormatOption</a> values
OR'ed together.
<p> This constructor makes it easy to specify a certain desired format
in classes derived from <a href="qglwidget.html">TQGLWidget</a>, for example:
<pre>
    // The rendering in MyGLWidget depends on using
    // stencil buffer and alpha channel
    MyGLWidget::MyGLWidget( <a href="ntqwidget.html">TQWidget</a>* parent, const char* name )
        : <a href="qglwidget.html">TQGLWidget</a>( <a href="#TQGLFormat">TQGLFormat</a>( StencilBuffer | AlphaChannel ), parent, name )
    {
        if ( !format().stencil() )
            <a href="ntqapplication.html#qWarning">qWarning</a>( "Could not get stencil buffer; results will be suboptimal" );
        if ( !format().alphaChannel() )
            <a href="ntqapplication.html#qWarning">qWarning</a>( "Could not get alpha channel; results will be suboptimal" );
        ...
    }
    </pre>
 
<p> Note that there are <a href="ntqgl.html#FormatOption-enum">FormatOption</a> values to turn format settings
both on and off, e.g. <a href="ntqgl.html#FormatOption-enum">DepthBuffer</a> and <a href="ntqgl.html#FormatOption-enum">NoDepthBuffer</a>,
<a href="ntqgl.html#FormatOption-enum">DirectRendering</a> and <a href="ntqgl.html#FormatOption-enum">IndirectRendering</a>, etc.
<p> The <em>plane</em> parameter defaults to 0 and is the plane which this
format should be associated with. Not all OpenGL implmentations
supports overlay/underlay rendering planes.
<p> <p>See also <a href="#defaultFormat">defaultFormat</a>() and <a href="#setOption">setOption</a>().

<h3 class=fn>bool <a name="accum"></a>TQGLFormat::accum () const
</h3>

<p> Returns TRUE if the accumulation buffer is enabled; otherwise
returns FALSE. The accumulation buffer is disabled by default.
<p> <p>See also <a href="#setAccum">setAccum</a>().

<h3 class=fn>bool <a name="alpha"></a>TQGLFormat::alpha () const
</h3>

<p> Returns TRUE if the alpha channel of the framebuffer is enabled;
otherwise returns FALSE. The alpha channel is disabled by default.
<p> <p>See also <a href="#setAlpha">setAlpha</a>().

<h3 class=fn><a href="qglformat.html">TQGLFormat</a> <a name="defaultFormat"></a>TQGLFormat::defaultFormat ()<tt> [static]</tt>
</h3>
Returns the default TQGLFormat for the application. All TQGLWidgets
that are created use this format unless another format is
specified, e.g. when they are constructed.
<p> If no special default format has been set using
<a href="#setDefaultFormat">setDefaultFormat</a>(), the default format is the same as that created
with TQGLFormat().
<p> <p>See also <a href="#setDefaultFormat">setDefaultFormat</a>().

<h3 class=fn><a href="qglformat.html">TQGLFormat</a> <a name="defaultOverlayFormat"></a>TQGLFormat::defaultOverlayFormat ()<tt> [static]</tt>
</h3>
Returns the default TQGLFormat for overlay contexts.
<p> The factory default overlay format is:
<ul>
<li> <a href="#setDoubleBuffer">Double buffer:</a> Disabled.
<li> <a href="#setDepth">Depth buffer:</a> Disabled.
<li> <a href="#setRgba">RGBA:</a> Disabled (i.e., color index enabled).
<li> <a href="#setAlpha">Alpha channel:</a> Disabled.
<li> <a href="#setAccum">Accumulator buffer:</a> Disabled.
<li> <a href="#setStencil">Stencil buffer:</a> Disabled.
<li> <a href="#setStereo">Stereo:</a> Disabled.
<li> <a href="#setDirectRendering">Direct rendering:</a> Enabled.
<li> <a href="#setOverlay">Overlay:</a> Disabled.
<li> <a href="#setPlane">Plane:</a> 1 (i.e., first overlay plane).
</ul>
<p> <p>See also <a href="#setDefaultFormat">setDefaultFormat</a>().

<h3 class=fn>bool <a name="depth"></a>TQGLFormat::depth () const
</h3>

<p> Returns TRUE if the depth buffer is enabled; otherwise returns
FALSE. The depth buffer is enabled by default.
<p> <p>See also <a href="#setDepth">setDepth</a>().

<h3 class=fn>bool <a name="directRendering"></a>TQGLFormat::directRendering () const
</h3>

<p> Returns TRUE if direct rendering is enabled; otherwise returns
FALSE.
<p> Direct rendering is enabled by default.
<p> <p>See also <a href="#setDirectRendering">setDirectRendering</a>().

<h3 class=fn>bool <a name="doubleBuffer"></a>TQGLFormat::doubleBuffer () const
</h3>

<p> Returns TRUE if double buffering is enabled; otherwise returns
FALSE. Double buffering is enabled by default.
<p> <p>See also <a href="#setDoubleBuffer">setDoubleBuffer</a>().

<h3 class=fn>bool <a name="hasOpenGL"></a>TQGLFormat::hasOpenGL ()<tt> [static]</tt>
</h3>

<p> Returns TRUE if the window system has any OpenGL support;
otherwise returns FALSE.
<p> <b>Warning:</b> This function must not be called until the <a href="ntqapplication.html">TQApplication</a>
object has been created.

<h3 class=fn>bool <a name="hasOpenGLOverlays"></a>TQGLFormat::hasOpenGLOverlays ()<tt> [static]</tt>
</h3>

<p> Returns TRUE if the window system supports OpenGL overlays;
otherwise returns FALSE.
<p> <b>Warning:</b> This function must not be called until the <a href="ntqapplication.html">TQApplication</a>
object has been created.

<h3 class=fn>bool <a name="hasOverlay"></a>TQGLFormat::hasOverlay () const
</h3>

<p> Returns TRUE if overlay plane is enabled; otherwise returns FALSE.
<p> Overlay is disabled by default.
<p> <p>See also <a href="#setOverlay">setOverlay</a>().

<h3 class=fn>int <a name="plane"></a>TQGLFormat::plane () const
</h3>
Returns the plane of this format. The default for normal formats
is 0, which means the normal plane. The default for overlay
formats is 1, which is the first overlay plane.
<p> <p>See also <a href="#setPlane">setPlane</a>().

<h3 class=fn>bool <a name="rgba"></a>TQGLFormat::rgba () const
</h3>

<p> Returns TRUE if RGBA color mode is set. Returns FALSE if color
index mode is set. The default color mode is RGBA.
<p> <p>See also <a href="#setRgba">setRgba</a>().

<h3 class=fn>void <a name="setAccum"></a>TQGLFormat::setAccum ( bool&nbsp;enable )
</h3>
If <em>enable</em> is TRUE enables the accumulation buffer; otherwise
disables the accumulation buffer.
<p> The accumulation buffer is disabled by default.
<p> The accumulation buffer is used to create blur effects and
multiple exposures.
<p> <p>See also <a href="#accum">accum</a>().

<h3 class=fn>void <a name="setAlpha"></a>TQGLFormat::setAlpha ( bool&nbsp;enable )
</h3>
If <em>enable</em> is TRUE enables the alpha channel; otherwise disables
the alpha channel.
<p> The alpha buffer is disabled by default.
<p> The alpha channel is typically used for implementing transparency
or translucency. The A in RGBA specifies the transparency of a
pixel.
<p> <p>See also <a href="#alpha">alpha</a>().

<h3 class=fn>void <a name="setDefaultFormat"></a>TQGLFormat::setDefaultFormat ( const&nbsp;<a href="qglformat.html">TQGLFormat</a>&nbsp;&amp;&nbsp;f )<tt> [static]</tt>
</h3>
Sets a new default TQGLFormat for the application to <em>f</em>. For
example, to set single buffering as the default instead of double
buffering, your main() might contain code like this:
<pre>
    <a href="ntqapplication.html">TQApplication</a> a(argc, argv);
    TQGLFormat f;
    f.<a href="#setDoubleBuffer">setDoubleBuffer</a>( FALSE );
    TQGLFormat::<a href="#setDefaultFormat">setDefaultFormat</a>( f );
    </pre>
 
<p> <p>See also <a href="#defaultFormat">defaultFormat</a>().

<h3 class=fn>void <a name="setDefaultOverlayFormat"></a>TQGLFormat::setDefaultOverlayFormat ( const&nbsp;<a href="qglformat.html">TQGLFormat</a>&nbsp;&amp;&nbsp;f )<tt> [static]</tt>
</h3>
Sets a new default TQGLFormat for overlay contexts to <em>f</em>. This
format is used whenever a <a href="qglwidget.html">TQGLWidget</a> is created with a format that
<a href="#hasOverlay">hasOverlay</a>() enabled.
<p> For example, to get a double buffered overlay context (if
available), use code like this:
<p> <pre>
    TQGLFormat f = TQGLFormat::<a href="#defaultOverlayFormat">defaultOverlayFormat</a>();
    f.<a href="#setDoubleBuffer">setDoubleBuffer</a>( TRUE );
    TQGLFormat::<a href="#setDefaultOverlayFormat">setDefaultOverlayFormat</a>( f );
    </pre>
 
<p> As usual, you can find out after widget creation whether the
underlying OpenGL system was able to provide the requested
specification:
<p> <pre>
    // ...continued from above
    MyGLWidget* myWidget = new MyGLWidget( <a href="#TQGLFormat">TQGLFormat</a>( TQGL::<a href="ntqgl.html#FormatOption-enum">HasOverlay</a> ), ... );
    if ( myWidget-&gt;format().hasOverlay() ) {
        // Yes, we got an overlay, let's check _its_ format:
        <a href="qglcontext.html">TQGLContext</a>* olContext = myWidget-&gt;overlayContext();
        if ( olContext-&gt;<a href="qglcontext.html#format">format</a>().doubleBuffer() )
            ; // yes, we got a double buffered overlay
        else
            ; // no, only single buffered overlays are available
    }
    </pre>
 
<p> <p>See also <a href="#defaultOverlayFormat">defaultOverlayFormat</a>().

<h3 class=fn>void <a name="setDepth"></a>TQGLFormat::setDepth ( bool&nbsp;enable )
</h3>
If <em>enable</em> is TRUE enables the depth buffer; otherwise disables
the depth buffer.
<p> The depth buffer is enabled by default.
<p> The purpose of a depth buffer (or Z-buffering) is to remove hidden
surfaces. Pixels are assigned Z values based on the distance to
the viewer. A pixel with a high Z value is closer to the viewer
than a pixel with a low Z value. This information is used to
decide whether to draw a pixel or not.
<p> <p>See also <a href="#depth">depth</a>().

<h3 class=fn>void <a name="setDirectRendering"></a>TQGLFormat::setDirectRendering ( bool&nbsp;enable )
</h3>
If <em>enable</em> is TRUE enables direct rendering; otherwise disables
direct rendering.
<p> Direct rendering is enabled by default.
<p> Enabling this option will make OpenGL bypass the underlying window
system and render directly from hardware to the screen, if this is
supported by the system.
<p> <p>See also <a href="#directRendering">directRendering</a>().

<h3 class=fn>void <a name="setDoubleBuffer"></a>TQGLFormat::setDoubleBuffer ( bool&nbsp;enable )
</h3>
If <em>enable</em> is TRUE sets double buffering; otherwise sets single
buffering.
<p> Double buffering is enabled by default.
<p> Double buffering is a technique where graphics are rendered on an
off-screen buffer and not directly to the screen. When the drawing
has been completed, the program calls a swapBuffers() function to
exchange the screen contents with the buffer. The result is
flicker-free drawing and often better performance.
<p> <p>See also <a href="#doubleBuffer">doubleBuffer</a>(), <a href="qglcontext.html#swapBuffers">TQGLContext::swapBuffers</a>(), and <a href="qglwidget.html#swapBuffers">TQGLWidget::swapBuffers</a>().

<h3 class=fn>void <a name="setOption"></a>TQGLFormat::setOption ( <a href="ntqgl.html#FormatOption-enum">FormatOption</a>&nbsp;opt )
</h3>
Sets the format option to <em>opt</em>.
<p> <p>See also <a href="#testOption">testOption</a>().

<h3 class=fn>void <a name="setOverlay"></a>TQGLFormat::setOverlay ( bool&nbsp;enable )
</h3>
If <em>enable</em> is TRUE enables an overlay plane; otherwise disables
the overlay plane.
<p> Enabling the overlay plane will cause <a href="qglwidget.html">TQGLWidget</a> to create an
additional context in an overlay plane. See the TQGLWidget
documentation for further information.
<p> <p>See also <a href="#hasOverlay">hasOverlay</a>().

<h3 class=fn>void <a name="setPlane"></a>TQGLFormat::setPlane ( int&nbsp;plane )
</h3>
Sets the requested plane to <em>plane</em>. 0 is the normal plane, 1 is
the first overlay plane, 2 is the second overlay plane, etc.; -1,
-2, etc. are underlay planes.
<p> Note that in contrast to other format specifications, the plane
specifications will be matched exactly. This means that if you
specify a plane that the underlying OpenGL system cannot provide,
an <a href="qglwidget.html#isValid">invalid</a> <a href="qglwidget.html">TQGLWidget</a> will be
created.
<p> <p>See also <a href="#plane">plane</a>().

<h3 class=fn>void <a name="setRgba"></a>TQGLFormat::setRgba ( bool&nbsp;enable )
</h3>
If <em>enable</em> is TRUE sets RGBA mode. If <em>enable</em> is FALSE sets
color index mode.
<p> The default color mode is RGBA.
<p> RGBA is the preferred mode for most OpenGL applications. In RGBA
color mode you specify colors as red + green + blue + alpha
quadruplets.
<p> In color index mode you specify an index into a color lookup
table.
<p> <p>See also <a href="#rgba">rgba</a>().

<h3 class=fn>void <a name="setStencil"></a>TQGLFormat::setStencil ( bool&nbsp;enable )
</h3>
If <em>enable</em> is TRUE enables the stencil buffer; otherwise
disables the stencil buffer.
<p> The stencil buffer is disabled by default.
<p> The stencil buffer masks certain parts of the drawing area so that
masked parts are not drawn on.
<p> <p>See also <a href="#stencil">stencil</a>().

<h3 class=fn>void <a name="setStereo"></a>TQGLFormat::setStereo ( bool&nbsp;enable )
</h3>
If <em>enable</em> is TRUE enables stereo buffering; otherwise disables
stereo buffering.
<p> Stereo buffering is disabled by default.
<p> Stereo buffering provides extra color buffers to generate left-eye
and right-eye images.
<p> <p>See also <a href="#stereo">stereo</a>().

<h3 class=fn>bool <a name="stencil"></a>TQGLFormat::stencil () const
</h3>

<p> Returns TRUE if the stencil buffer is enabled; otherwise returns
FALSE. The stencil buffer is disabled by default.
<p> <p>See also <a href="#setStencil">setStencil</a>().

<h3 class=fn>bool <a name="stereo"></a>TQGLFormat::stereo () const
</h3>

<p> Returns TRUE if stereo buffering is enabled; otherwise returns
FALSE. Stereo buffering is disabled by default.
<p> <p>See also <a href="#setStereo">setStereo</a>().

<h3 class=fn>bool <a name="testOption"></a>TQGLFormat::testOption ( <a href="ntqgl.html#FormatOption-enum">FormatOption</a>&nbsp;opt ) const
</h3>
Returns TRUE if format option <em>opt</em> is set; otherwise returns FALSE.
<p> <p>See also <a href="#setOption">setOption</a>().

<!-- eof -->
<hr><p>
This file is part of the <a href="index.html">TQt toolkit</a>.
Copyright &copy; 1995-2007
<a href="http://www.trolltech.com/">Trolltech</a>. All Rights Reserved.<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>