← Back to branch summary

~oif-team/ubuntu/natty/qt4-x11/xi2.1

« back to all changes in this revision

Viewing changes to doc/html/qglformat.html

  • Committer: Bazaar Package Importer
  • Author(s): Alessandro Ghersi
  • Date: 2009-11-02 18:30:08 UTC
  • mfrom: (1.2.2 upstream)
  • mto: (15.2.5 experimental)
  • mto: This revision was merged to the branch mainline in revision 88.
  • Revision ID: james.westby@ubuntu.com-20091102183008-b6a4gcs128mvfb3m
Tags: upstream-4.6.0~beta1
Import upstream version 4.6.0~beta1

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/html/qglformat.html
2
2
<!DOCTYPE html
3
3
    PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
4
4
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5
 
<!-- /fasttmp/mkdist-qt-4.5.2-1245473805/qt-x11-opensource-src-4.5.2/src/opengl/qgl.cpp -->
 
5
<!-- qgl.cpp -->
6
6
<head>
7
 
  <title>Qt 4.5: QGLFormat Class Reference</title>
 
7
  <title>Qt 4.6: QGLFormat Class Reference</title>
8
8
  <link href="classic.css" rel="stylesheet" type="text/css" />
9
9
</head>
10
10
<body>
 
11
<a name="//apple_ref/cpp/cl//QGLFormat" />
11
12
<table border="0" cellpadding="0" cellspacing="0" width="100%">
12
13
<tr>
13
 
<td align="left" valign="top" width="32"><a href="http://qtsoftware.com/products/qt"><img src="images/qt-logo.png" align="left" border="0" /></a></td>
14
 
<td width="1">&nbsp;&nbsp;</td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a>&nbsp;&middot; <a href="namespaces.html"><font color="#004faf">All&nbsp;Namespaces</font></a>&nbsp;&middot; <a href="classes.html"><font color="#004faf">All&nbsp;Classes</font></a>&nbsp;&middot; <a href="mainclasses.html"><font color="#004faf">Main&nbsp;Classes</font></a>&nbsp;&middot; <a href="groups.html"><font color="#004faf">Grouped&nbsp;Classes</font></a>&nbsp;&middot; <a href="modules.html"><font color="#004faf">Modules</font></a>&nbsp;&middot; <a href="functions.html"><font color="#004faf">Functions</font></a></td>
15
 
<td align="right" valign="top" width="230"></td></tr></table><h1 class="title">QGLFormat Class Reference<br /><span class="small-subtitle">[<a href="qtopengl.html">QtOpenGL</a> module]</span>
 
14
<td align="left" valign="top" width="32"><a href="http://qt.nokia.com/"><img src="images/qt-logo.png" align="left" border="0" /></a></td>
 
15
<td width="1">&nbsp;&nbsp;</td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a>&nbsp;&middot; <a href="classes.html"><font color="#004faf">All&nbsp;Classes</font></a>&nbsp;&middot; <a href="functions.html"><font color="#004faf">All&nbsp;Functions</font></a>&nbsp;&middot; <a href="overviews.html"><font color="#004faf">Overviews</font></a></td><td class="searchBar" align="right" valign="center"><form action="http://www.google.com/cse" id="cse-search-box"><div><input type="hidden" name="cx" value="000136343326384750312:dhbxnqlakyu" /><input type="hidden" name="ie" value="UTF-8" /><input type="text" name="q" size="31" /><input type="submit" name="sa" value="Search" /></div></form></td>
 
16
</tr></table><h1 class="title">QGLFormat Class Reference<br /><span class="small-subtitle">[<a href="qtopengl.html">QtOpenGL</a> module]</span>
16
17
</h1>
17
18
<p>The QGLFormat class specifies the display format of an OpenGL rendering context. <a href="#details">More...</a></p>
18
 
<pre> #include &lt;QGLFormat&gt;</pre><ul>
 
19
<pre> #include &lt;QGLFormat&gt;</pre><p><b>This class is not part of the Qt GUI Framework Edition.</b></p>
 
20
<ul>
19
21
<li><a href="qglformat-members.html">List of all members, including inherited members</a></li>
20
22
</ul>
 
23
<hr />
21
24
<a name="public-types"></a>
22
 
<h3>Public Types</h3>
23
 
<ul>
24
 
<li><div class="fn"></div>enum <b><a href="qglformat.html#OpenGLVersionFlag-enum">OpenGLVersionFlag</a></b> { OpenGL_Version_None, OpenGL_Version_1_1, OpenGL_Version_1_2, OpenGL_Version_1_3, ..., OpenGL_ES_Version_2_0 }</li>
25
 
<li><div class="fn"></div>flags <b><a href="qglformat.html#OpenGLVersionFlag-enum">OpenGLVersionFlags</a></b></li>
26
 
</ul>
 
25
<h2>Public Types</h2>
 
26
<table class="alignedsummary" border="0" cellpadding="0" cellspacing="0" width="100%">
 
27
<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><b><a href="qglformat.html#OpenGLVersionFlag-enum">OpenGLVersionFlag</a></b> { OpenGL_Version_None, OpenGL_Version_1_1, OpenGL_Version_1_2, OpenGL_Version_1_3, ..., OpenGL_ES_Version_2_0 }</td></tr>
 
28
<tr><td class="memItemLeft" align="right" valign="top">flags </td><td class="memItemRight" valign="bottom"><b><a href="qglformat.html#OpenGLVersionFlag-enum">OpenGLVersionFlags</a></b></td></tr>
 
29
</table>
 
30
<hr />
27
31
<a name="public-functions"></a>
28
 
<h3>Public Functions</h3>
29
 
<ul>
30
 
<li><div class="fn"></div><b><a href="qglformat.html#QGLFormat">QGLFormat</a></b> ()</li>
31
 
<li><div class="fn"></div><b><a href="qglformat.html#QGLFormat-2">QGLFormat</a></b> ( QGL::FormatOptions <i>options</i>, int <i>plane</i> = 0 )</li>
32
 
<li><div class="fn"></div><b><a href="qglformat.html#QGLFormat-3">QGLFormat</a></b> ( const QGLFormat &amp; <i>other</i> )</li>
33
 
<li><div class="fn"></div><b><a href="qglformat.html#dtor.QGLFormat">~QGLFormat</a></b> ()</li>
34
 
<li><div class="fn"></div>bool <b><a href="qglformat.html#accum">accum</a></b> () const</li>
35
 
<li><div class="fn"></div>int <b><a href="qglformat.html#accumBufferSize">accumBufferSize</a></b> () const</li>
36
 
<li><div class="fn"></div>bool <b><a href="qglformat.html#alpha">alpha</a></b> () const</li>
37
 
<li><div class="fn"></div>int <b><a href="qglformat.html#alphaBufferSize">alphaBufferSize</a></b> () const</li>
38
 
<li><div class="fn"></div>int <b><a href="qglformat.html#blueBufferSize">blueBufferSize</a></b> () const</li>
39
 
<li><div class="fn"></div>bool <b><a href="qglformat.html#depth">depth</a></b> () const</li>
40
 
<li><div class="fn"></div>int <b><a href="qglformat.html#depthBufferSize">depthBufferSize</a></b> () const</li>
41
 
<li><div class="fn"></div>bool <b><a href="qglformat.html#directRendering">directRendering</a></b> () const</li>
42
 
<li><div class="fn"></div>bool <b><a href="qglformat.html#doubleBuffer">doubleBuffer</a></b> () const</li>
43
 
<li><div class="fn"></div>int <b><a href="qglformat.html#greenBufferSize">greenBufferSize</a></b> () const</li>
44
 
<li><div class="fn"></div>bool <b><a href="qglformat.html#hasOverlay">hasOverlay</a></b> () const</li>
45
 
<li><div class="fn"></div>int <b><a href="qglformat.html#plane">plane</a></b> () const</li>
46
 
<li><div class="fn"></div>int <b><a href="qglformat.html#redBufferSize">redBufferSize</a></b> () const</li>
47
 
<li><div class="fn"></div>bool <b><a href="qglformat.html#rgba">rgba</a></b> () const</li>
48
 
<li><div class="fn"></div>bool <b><a href="qglformat.html#sampleBuffers">sampleBuffers</a></b> () const</li>
49
 
<li><div class="fn"></div>int <b><a href="qglformat.html#samples">samples</a></b> () const</li>
50
 
<li><div class="fn"></div>void <b><a href="qglformat.html#setAccum">setAccum</a></b> ( bool <i>enable</i> )</li>
51
 
<li><div class="fn"></div>void <b><a href="qglformat.html#setAccumBufferSize">setAccumBufferSize</a></b> ( int <i>size</i> )</li>
52
 
<li><div class="fn"></div>void <b><a href="qglformat.html#setAlpha">setAlpha</a></b> ( bool <i>enable</i> )</li>
53
 
<li><div class="fn"></div>void <b><a href="qglformat.html#setAlphaBufferSize">setAlphaBufferSize</a></b> ( int <i>size</i> )</li>
54
 
<li><div class="fn"></div>void <b><a href="qglformat.html#setBlueBufferSize">setBlueBufferSize</a></b> ( int <i>size</i> )</li>
55
 
<li><div class="fn"></div>void <b><a href="qglformat.html#setDepth">setDepth</a></b> ( bool <i>enable</i> )</li>
56
 
<li><div class="fn"></div>void <b><a href="qglformat.html#setDepthBufferSize">setDepthBufferSize</a></b> ( int <i>size</i> )</li>
57
 
<li><div class="fn"></div>void <b><a href="qglformat.html#setDirectRendering">setDirectRendering</a></b> ( bool <i>enable</i> )</li>
58
 
<li><div class="fn"></div>void <b><a href="qglformat.html#setDoubleBuffer">setDoubleBuffer</a></b> ( bool <i>enable</i> )</li>
59
 
<li><div class="fn"></div>void <b><a href="qglformat.html#setGreenBufferSize">setGreenBufferSize</a></b> ( int <i>size</i> )</li>
60
 
<li><div class="fn"></div>void <b><a href="qglformat.html#setOption">setOption</a></b> ( QGL::FormatOptions <i>opt</i> )</li>
61
 
<li><div class="fn"></div>void <b><a href="qglformat.html#setOverlay">setOverlay</a></b> ( bool <i>enable</i> )</li>
62
 
<li><div class="fn"></div>void <b><a href="qglformat.html#setPlane">setPlane</a></b> ( int <i>plane</i> )</li>
63
 
<li><div class="fn"></div>void <b><a href="qglformat.html#setRedBufferSize">setRedBufferSize</a></b> ( int <i>size</i> )</li>
64
 
<li><div class="fn"></div>void <b><a href="qglformat.html#setRgba">setRgba</a></b> ( bool <i>enable</i> )</li>
65
 
<li><div class="fn"></div>void <b><a href="qglformat.html#setSampleBuffers">setSampleBuffers</a></b> ( bool <i>enable</i> )</li>
66
 
<li><div class="fn"></div>void <b><a href="qglformat.html#setSamples">setSamples</a></b> ( int <i>numSamples</i> )</li>
67
 
<li><div class="fn"></div>void <b><a href="qglformat.html#setStencil">setStencil</a></b> ( bool <i>enable</i> )</li>
68
 
<li><div class="fn"></div>void <b><a href="qglformat.html#setStencilBufferSize">setStencilBufferSize</a></b> ( int <i>size</i> )</li>
69
 
<li><div class="fn"></div>void <b><a href="qglformat.html#setStereo">setStereo</a></b> ( bool <i>enable</i> )</li>
70
 
<li><div class="fn"></div>void <b><a href="qglformat.html#setSwapInterval">setSwapInterval</a></b> ( int <i>interval</i> )</li>
71
 
<li><div class="fn"></div>bool <b><a href="qglformat.html#stencil">stencil</a></b> () const</li>
72
 
<li><div class="fn"></div>int <b><a href="qglformat.html#stencilBufferSize">stencilBufferSize</a></b> () const</li>
73
 
<li><div class="fn"></div>bool <b><a href="qglformat.html#stereo">stereo</a></b> () const</li>
74
 
<li><div class="fn"></div>int <b><a href="qglformat.html#swapInterval">swapInterval</a></b> () const</li>
75
 
<li><div class="fn"></div>bool <b><a href="qglformat.html#testOption">testOption</a></b> ( QGL::FormatOptions <i>opt</i> ) const</li>
76
 
<li><div class="fn"></div>QGLFormat &amp; <b><a href="qglformat.html#operator-eq">operator=</a></b> ( const QGLFormat &amp; <i>other</i> )</li>
77
 
</ul>
 
32
<h2>Public Functions</h2>
 
33
<table class="alignedsummary" border="0" cellpadding="0" cellspacing="0" width="100%">
 
34
<tr><td class="memItemLeft" align="right" valign="top"></td><td class="memItemRight" valign="bottom"><b><a href="qglformat.html#QGLFormat">QGLFormat</a></b> ()</td></tr>
 
35
<tr><td class="memItemLeft" align="right" valign="top"></td><td class="memItemRight" valign="bottom"><b><a href="qglformat.html#QGLFormat-2">QGLFormat</a></b> ( QGL::FormatOptions <i>options</i>, int <i>plane</i> = 0 )</td></tr>
 
36
<tr><td class="memItemLeft" align="right" valign="top"></td><td class="memItemRight" valign="bottom"><b><a href="qglformat.html#QGLFormat-3">QGLFormat</a></b> ( const QGLFormat &amp; <i>other</i> )</td></tr>
 
37
<tr><td class="memItemLeft" align="right" valign="top"></td><td class="memItemRight" valign="bottom"><b><a href="qglformat.html#dtor.QGLFormat">~QGLFormat</a></b> ()</td></tr>
 
38
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><b><a href="qglformat.html#accum">accum</a></b> () const</td></tr>
 
39
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><b><a href="qglformat.html#accumBufferSize">accumBufferSize</a></b> () const</td></tr>
 
40
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><b><a href="qglformat.html#alpha">alpha</a></b> () const</td></tr>
 
41
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><b><a href="qglformat.html#alphaBufferSize">alphaBufferSize</a></b> () const</td></tr>
 
42
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><b><a href="qglformat.html#blueBufferSize">blueBufferSize</a></b> () const</td></tr>
 
43
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><b><a href="qglformat.html#depth">depth</a></b> () const</td></tr>
 
44
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><b><a href="qglformat.html#depthBufferSize">depthBufferSize</a></b> () const</td></tr>
 
45
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><b><a href="qglformat.html#directRendering">directRendering</a></b> () const</td></tr>
 
46
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><b><a href="qglformat.html#doubleBuffer">doubleBuffer</a></b> () const</td></tr>
 
47
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><b><a href="qglformat.html#greenBufferSize">greenBufferSize</a></b> () const</td></tr>
 
48
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><b><a href="qglformat.html#hasOverlay">hasOverlay</a></b> () const</td></tr>
 
49
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><b><a href="qglformat.html#plane">plane</a></b> () const</td></tr>
 
50
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><b><a href="qglformat.html#redBufferSize">redBufferSize</a></b> () const</td></tr>
 
51
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><b><a href="qglformat.html#rgba">rgba</a></b> () const</td></tr>
 
52
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><b><a href="qglformat.html#sampleBuffers">sampleBuffers</a></b> () const</td></tr>
 
53
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><b><a href="qglformat.html#samples">samples</a></b> () const</td></tr>
 
54
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qglformat.html#setAccum">setAccum</a></b> ( bool <i>enable</i> )</td></tr>
 
55
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qglformat.html#setAccumBufferSize">setAccumBufferSize</a></b> ( int <i>size</i> )</td></tr>
 
56
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qglformat.html#setAlpha">setAlpha</a></b> ( bool <i>enable</i> )</td></tr>
 
57
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qglformat.html#setAlphaBufferSize">setAlphaBufferSize</a></b> ( int <i>size</i> )</td></tr>
 
58
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qglformat.html#setBlueBufferSize">setBlueBufferSize</a></b> ( int <i>size</i> )</td></tr>
 
59
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qglformat.html#setDepth">setDepth</a></b> ( bool <i>enable</i> )</td></tr>
 
60
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qglformat.html#setDepthBufferSize">setDepthBufferSize</a></b> ( int <i>size</i> )</td></tr>
 
61
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qglformat.html#setDirectRendering">setDirectRendering</a></b> ( bool <i>enable</i> )</td></tr>
 
62
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qglformat.html#setDoubleBuffer">setDoubleBuffer</a></b> ( bool <i>enable</i> )</td></tr>
 
63
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qglformat.html#setGreenBufferSize">setGreenBufferSize</a></b> ( int <i>size</i> )</td></tr>
 
64
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qglformat.html#setOption">setOption</a></b> ( QGL::FormatOptions <i>opt</i> )</td></tr>
 
65
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qglformat.html#setOverlay">setOverlay</a></b> ( bool <i>enable</i> )</td></tr>
 
66
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qglformat.html#setPlane">setPlane</a></b> ( int <i>plane</i> )</td></tr>
 
67
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qglformat.html#setRedBufferSize">setRedBufferSize</a></b> ( int <i>size</i> )</td></tr>
 
68
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qglformat.html#setRgba">setRgba</a></b> ( bool <i>enable</i> )</td></tr>
 
69
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qglformat.html#setSampleBuffers">setSampleBuffers</a></b> ( bool <i>enable</i> )</td></tr>
 
70
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qglformat.html#setSamples">setSamples</a></b> ( int <i>numSamples</i> )</td></tr>
 
71
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qglformat.html#setStencil">setStencil</a></b> ( bool <i>enable</i> )</td></tr>
 
72
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qglformat.html#setStencilBufferSize">setStencilBufferSize</a></b> ( int <i>size</i> )</td></tr>
 
73
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qglformat.html#setStereo">setStereo</a></b> ( bool <i>enable</i> )</td></tr>
 
74
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qglformat.html#setSwapInterval">setSwapInterval</a></b> ( int <i>interval</i> )</td></tr>
 
75
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><b><a href="qglformat.html#stencil">stencil</a></b> () const</td></tr>
 
76
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><b><a href="qglformat.html#stencilBufferSize">stencilBufferSize</a></b> () const</td></tr>
 
77
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><b><a href="qglformat.html#stereo">stereo</a></b> () const</td></tr>
 
78
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><b><a href="qglformat.html#swapInterval">swapInterval</a></b> () const</td></tr>
 
79
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><b><a href="qglformat.html#testOption">testOption</a></b> ( QGL::FormatOptions <i>opt</i> ) const</td></tr>
 
80
<tr><td class="memItemLeft" align="right" valign="top">QGLFormat &amp; </td><td class="memItemRight" valign="bottom"><b><a href="qglformat.html#operator-eq">operator=</a></b> ( const QGLFormat &amp; <i>other</i> )</td></tr>
 
81
</table>
 
82
<hr />
78
83
<a name="static-public-members"></a>
79
 
<h3>Static Public Members</h3>
80
 
<ul>
81
 
<li><div class="fn"></div>QGLFormat <b><a href="qglformat.html#defaultFormat">defaultFormat</a></b> ()</li>
82
 
<li><div class="fn"></div>QGLFormat <b><a href="qglformat.html#defaultOverlayFormat">defaultOverlayFormat</a></b> ()</li>
83
 
<li><div class="fn"></div>bool <b><a href="qglformat.html#hasOpenGL">hasOpenGL</a></b> ()</li>
84
 
<li><div class="fn"></div>bool <b><a href="qglformat.html#hasOpenGLOverlays">hasOpenGLOverlays</a></b> ()</li>
85
 
<li><div class="fn"></div>OpenGLVersionFlags <b><a href="qglformat.html#openGLVersionFlags">openGLVersionFlags</a></b> ()</li>
86
 
<li><div class="fn"></div>void <b><a href="qglformat.html#setDefaultFormat">setDefaultFormat</a></b> ( const QGLFormat &amp; <i>f</i> )</li>
87
 
<li><div class="fn"></div>void <b><a href="qglformat.html#setDefaultOverlayFormat">setDefaultOverlayFormat</a></b> ( const QGLFormat &amp; <i>f</i> )</li>
88
 
</ul>
 
84
<h2>Static Public Members</h2>
 
85
<table class="alignedsummary" border="0" cellpadding="0" cellspacing="0" width="100%">
 
86
<tr><td class="memItemLeft" align="right" valign="top">QGLFormat </td><td class="memItemRight" valign="bottom"><b><a href="qglformat.html#defaultFormat">defaultFormat</a></b> ()</td></tr>
 
87
<tr><td class="memItemLeft" align="right" valign="top">QGLFormat </td><td class="memItemRight" valign="bottom"><b><a href="qglformat.html#defaultOverlayFormat">defaultOverlayFormat</a></b> ()</td></tr>
 
88
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><b><a href="qglformat.html#hasOpenGL">hasOpenGL</a></b> ()</td></tr>
 
89
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><b><a href="qglformat.html#hasOpenGLOverlays">hasOpenGLOverlays</a></b> ()</td></tr>
 
90
<tr><td class="memItemLeft" align="right" valign="top">OpenGLVersionFlags </td><td class="memItemRight" valign="bottom"><b><a href="qglformat.html#openGLVersionFlags">openGLVersionFlags</a></b> ()</td></tr>
 
91
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qglformat.html#setDefaultFormat">setDefaultFormat</a></b> ( const QGLFormat &amp; <i>f</i> )</td></tr>
 
92
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qglformat.html#setDefaultOverlayFormat">setDefaultOverlayFormat</a></b> ( const QGLFormat &amp; <i>f</i> )</td></tr>
 
93
</table>
 
94
<hr />
 
95
<a name="related-non-members"></a>
 
96
<h2>Related Non-Members</h2>
 
97
<table class="alignedsummary" border="0" cellpadding="0" cellspacing="0" width="100%">
 
98
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><b><a href="qglformat.html#operator-not-eq-32">operator!=</a></b> ( const QGLFormat &amp; <i>a</i>, const QGLFormat &amp; <i>b</i> )</td></tr>
 
99
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><b><a href="qglformat.html#operator-eq-eq-41">operator==</a></b> ( const QGLFormat &amp; <i>a</i>, const QGLFormat &amp; <i>b</i> )</td></tr>
 
100
</table>
89
101
<a name="details"></a>
90
102
<hr />
91
103
<h2>Detailed Description</h2>
101
113
<li><a href="qglformat.html#setStereo">Stereo buffers.</a></li>
102
114
<li><a href="qglformat.html#setDirectRendering">Direct rendering.</a></li>
103
115
<li><a href="qglformat.html#setOverlay">Presence of an overlay.</a></li>
104
 
<li><a href="qglformat.html#setPlane">The plane of an overlay format.</a></li>
 
116
<li><a href="qglformat.html#setPlane">Plane of an overlay.</a></li>
105
117
<li><a href="qglformat.html#setSampleBuffers">Multisample buffers.</a></li>
106
118
</ul>
107
 
<p>You can also specify preferred bit depths for the depth buffer, alpha buffer, accumulation buffer and the stencil buffer with the functions: <a href="qglformat.html#setDepthBufferSize">setDepthBufferSize</a>(), <a href="qglformat.html#setAlphaBufferSize">setAlphaBufferSize</a>(), <a href="qglformat.html#setAccumBufferSize">setAccumBufferSize</a>() and <a href="qglformat.html#setStencilBufferSize">setStencilBufferSize</a>().</p>
 
119
<p>You can also specify preferred bit depths for the color buffer, depth buffer, alpha buffer, accumulation buffer and the stencil buffer with the functions: <a href="qglformat.html#setRedBufferSize">setRedBufferSize</a>(), <a href="qglformat.html#setGreenBufferSize">setGreenBufferSize</a>(), <a href="qglformat.html#setBlueBufferSize">setBlueBufferSize</a>(), <a href="qglformat.html#setDepthBufferSize">setDepthBufferSize</a>(), <a href="qglformat.html#setAlphaBufferSize">setAlphaBufferSize</a>(), <a href="qglformat.html#setAccumBufferSize">setAccumBufferSize</a>() and <a href="qglformat.html#setStencilBufferSize">setStencilBufferSize</a>().</p>
108
120
<p>Note that even if you specify that you prefer a 32 bit depth buffer (e.g&#x2e; with setDepthBufferSize(32)), the format that is chosen may not have a 32 bit depth buffer, even if there is a format available with a 32 bit depth buffer. The main reason for this is how the system dependant picking algorithms work on the different platforms, and some format options may have higher precedence than others.</p>
109
121
<p>You create and tell a QGLFormat object what rendering options you want from an OpenGL rendering context.</p>
110
122
<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">QGLWidget</a>, you will get a rendering context with the nearest subset of features.</p>
133
145
</div><p>See also <a href="qglcontext.html">QGLContext</a> and <a href="qglwidget.html">QGLWidget</a>.</p>
134
146
<hr />
135
147
<h2>Member Type Documentation</h2>
 
148
<a name="//apple_ref/cpp/tag/QGLFormat/OpenGLVersionFlag" />
 
149
<a name="//apple_ref/cpp/econst/QGLFormat/OpenGL_Version_None" />
 
150
<a name="//apple_ref/cpp/econst/QGLFormat/OpenGL_Version_1_1" />
 
151
<a name="//apple_ref/cpp/econst/QGLFormat/OpenGL_Version_1_2" />
 
152
<a name="//apple_ref/cpp/econst/QGLFormat/OpenGL_Version_1_3" />
 
153
<a name="//apple_ref/cpp/econst/QGLFormat/OpenGL_Version_1_4" />
 
154
<a name="//apple_ref/cpp/econst/QGLFormat/OpenGL_Version_1_5" />
 
155
<a name="//apple_ref/cpp/econst/QGLFormat/OpenGL_Version_2_0" />
 
156
<a name="//apple_ref/cpp/econst/QGLFormat/OpenGL_Version_2_1" />
 
157
<a name="//apple_ref/cpp/econst/QGLFormat/OpenGL_Version_3_0" />
 
158
<a name="//apple_ref/cpp/econst/QGLFormat/OpenGL_ES_CommonLite_Version_1_0" />
 
159
<a name="//apple_ref/cpp/econst/QGLFormat/OpenGL_ES_Common_Version_1_0" />
 
160
<a name="//apple_ref/cpp/econst/QGLFormat/OpenGL_ES_CommonLite_Version_1_1" />
 
161
<a name="//apple_ref/cpp/econst/QGLFormat/OpenGL_ES_Common_Version_1_1" />
 
162
<a name="//apple_ref/cpp/econst/QGLFormat/OpenGL_ES_Version_2_0" />
 
163
<a name="//apple_ref/cpp/tdef/QGLFormat/OpenGLVersionFlags" />
136
164
<h3 class="flags"><a name="OpenGLVersionFlag-enum"></a>enum QGLFormat::OpenGLVersionFlag<br />flags QGLFormat::OpenGLVersionFlags</h3>
137
165
<p>This enum describes the various OpenGL versions that are recognized by Qt. Use the <a href="qglformat.html#openGLVersionFlags">QGLFormat::openGLVersionFlags</a>() function to identify which versions that are supported at runtime.</p>
138
 
<p><table border="1" cellpadding="2" cellspacing="1" width="100%">
 
166
<p><table class="valuelist" border="1" cellpadding="2" cellspacing="1" width="100%">
139
167
<tr><th width="25%">Constant</th><th width="15%">Value</th><th width="60%">Description</th></tr>
140
168
<tr><td valign="top"><tt>QGLFormat::OpenGL_Version_None</tt></td><td align="center" valign="top"><tt>0x00000000</tt></td><td valign="top">If no OpenGL is present or if no OpenGL context is current.</td></tr>
141
169
<tr><td valign="top"><tt>QGLFormat::OpenGL_Version_1_1</tt></td><td align="center" valign="top"><tt>0x00000001</tt></td><td valign="top">OpenGL version 1.1 or higher is present.</td></tr>
158
186
<p>See also <a href="qglformat.html#openGLVersionFlags">openGLVersionFlags</a>().</p>
159
187
<hr />
160
188
<h2>Member Function Documentation</h2>
 
189
<a name="//apple_ref/cpp/instm/QGLFormat/QGLFormat" />
161
190
<h3 class="fn"><a name="QGLFormat"></a>QGLFormat::QGLFormat ()</h3>
162
 
<p>Constructs a <a href="qglformat.html">QGLFormat</a> object with the factory default settings:</p>
 
191
<p>Constructs a <a href="qglformat.html">QGLFormat</a> object with the following default settings:</p>
163
192
<ul>
164
193
<li><a href="qglformat.html#setDoubleBuffer">Double buffer:</a> Enabled.</li>
165
194
<li><a href="qglformat.html#setDepth">Depth buffer:</a> Enabled.</li>
166
195
<li><a href="qglformat.html#setRgba">RGBA:</a> Enabled (i.e&#x2e;, color index disabled).</li>
167
196
<li><a href="qglformat.html#setAlpha">Alpha channel:</a> Disabled.</li>
168
197
<li><a href="qglformat.html#setAccum">Accumulator buffer:</a> Disabled.</li>
169
 
<li><a href="qglformat.html#setStencil">Stencil buffer:</a> Disabled.</li>
 
198
<li><a href="qglformat.html#setStencil">Stencil buffer:</a> Enabled.</li>
170
199
<li><a href="qglformat.html#setStereo">Stereo:</a> Disabled.</li>
171
200
<li><a href="qglformat.html#setDirectRendering">Direct rendering:</a> Enabled.</li>
172
201
<li><a href="qglformat.html#setOverlay">Overlay:</a> Disabled.</li>
173
202
<li><a href="qglformat.html#setPlane">Plane:</a> 0 (i.e&#x2e;, normal plane).</li>
174
 
<li><a href="qglformat.html#setSampleBuffers">Multisample buffers:</a> Disabled.</li>
 
203
<li><a href="qglformat.html#setSampleBuffers">Multisample buffers:</a> Enabled on OpenGL/ES 2.0, disabled on other platforms.</li>
175
204
</ul>
176
205
<h3 class="fn"><a name="QGLFormat-2"></a>QGLFormat::QGLFormat ( <a href="qgl.html#FormatOption-enum">QGL::FormatOptions</a> <i>options</i>, int <i>plane</i> = 0 )</h3>
177
 
<p>Creates a <a href="qglformat.html">QGLFormat</a> object that is a copy of the current <a href="qglformat.html#defaultFormat">application default format</a>.</p>
178
 
<p>If <i>options</i> is not 0, this copy is modified by these format options. The <i>options</i> parameter should be <tt>FormatOption</tt> values OR'ed together.</p>
 
206
<p>Creates a <a href="qglformat.html">QGLFormat</a> object that is a copy of the current <a href="qglformat.html#defaultFormat">defaultFormat</a>().</p>
 
207
<p>If <i>options</i> is not 0, the default format is modified by the specified format options. The <i>options</i> parameter should be <a href="qgl.html#FormatOption-enum">QGL::FormatOption</a> values OR'ed together.</p>
179
208
<p>This constructor makes it easy to specify a certain desired format in classes derived from <a href="qglwidget.html">QGLWidget</a>, for example:</p>
180
209
<pre><span class="comment"> // The rendering in MyGLWidget depends on using</span>
181
210
<span class="comment"> // stencil buffer and alpha channel</span>
188
217
         qWarning(&quot;Could not get alpha channel; results will be suboptimal&quot;);
189
218
     ...
190
219
 }</pre>
191
 
<p>Note that there are <tt>FormatOption</tt> values to turn format settings both on and off, e.g&#x2e; <tt>DepthBuffer</tt> and <tt>NoDepthBuffer</tt>, <tt>DirectRendering</tt> and <tt>IndirectRendering</tt>, etc.</p>
 
220
<p>Note that there are <a href="qgl.html#FormatOption-enum">QGL::FormatOption</a> values to turn format settings both on and off, e.g&#x2e; <a href="qgl.html#FormatOption-enum">QGL::DepthBuffer</a> and <a href="qgl.html#FormatOption-enum">QGL::NoDepthBuffer</a>, <a href="qgl.html#FormatOption-enum">QGL::DirectRendering</a> and <a href="qgl.html#FormatOption-enum">QGL::IndirectRendering</a>, etc.</p>
192
221
<p>The <i>plane</i> parameter defaults to 0 and is the plane which this format should be associated with. Not all OpenGL implementations supports overlay/underlay rendering planes.</p>
193
 
<p>See also <a href="qglformat.html#defaultFormat">defaultFormat</a>() and <a href="qglformat.html#setOption">setOption</a>().</p>
 
222
<p>See also <a href="qglformat.html#defaultFormat">defaultFormat</a>(), <a href="qglformat.html#setOption">setOption</a>(), and <a href="qglformat.html#setPlane">setPlane</a>().</p>
194
223
<h3 class="fn"><a name="QGLFormat-3"></a>QGLFormat::QGLFormat ( const QGLFormat &amp; <i>other</i> )</h3>
195
224
<p>Constructs a copy of <i>other</i>.</p>
 
225
<a name="//apple_ref/cpp/instm/QGLFormat/~QGLFormat" />
196
226
<h3 class="fn"><a name="dtor.QGLFormat"></a>QGLFormat::~QGLFormat ()</h3>
197
227
<p>Destroys the <a href="qglformat.html">QGLFormat</a>.</p>
 
228
<a name="//apple_ref/cpp/instm/QGLFormat/accum" />
198
229
<h3 class="fn"><a name="accum"></a>bool QGLFormat::accum () const</h3>
199
230
<p>Returns true if the accumulation buffer is enabled; otherwise returns false. The accumulation buffer is disabled by default.</p>
200
231
<p>See also <a href="qglformat.html#setAccum">setAccum</a>() and <a href="qglformat.html#setAccumBufferSize">setAccumBufferSize</a>().</p>
 
232
<a name="//apple_ref/cpp/instm/QGLFormat/accumBufferSize" />
201
233
<h3 class="fn"><a name="accumBufferSize"></a>int QGLFormat::accumBufferSize () const</h3>
202
234
<p>Returns the accumulation buffer size.</p>
203
235
<p>See also <a href="qglformat.html#setAccumBufferSize">setAccumBufferSize</a>(), <a href="qglformat.html#accum">accum</a>(), and <a href="qglformat.html#setAccum">setAccum</a>().</p>
 
236
<a name="//apple_ref/cpp/instm/QGLFormat/alpha" />
204
237
<h3 class="fn"><a name="alpha"></a>bool QGLFormat::alpha () const</h3>
205
238
<p>Returns true if the alpha buffer in the framebuffer is enabled; otherwise returns false. The alpha buffer is disabled by default.</p>
206
239
<p>See also <a href="qglformat.html#setAlpha">setAlpha</a>() and <a href="qglformat.html#setAlphaBufferSize">setAlphaBufferSize</a>().</p>
 
240
<a name="//apple_ref/cpp/instm/QGLFormat/alphaBufferSize" />
207
241
<h3 class="fn"><a name="alphaBufferSize"></a>int QGLFormat::alphaBufferSize () const</h3>
208
242
<p>Returns the alpha buffer size.</p>
209
243
<p>See also <a href="qglformat.html#alpha">alpha</a>(), <a href="qglformat.html#setAlpha">setAlpha</a>(), and <a href="qglformat.html#setAlphaBufferSize">setAlphaBufferSize</a>().</p>
 
244
<a name="//apple_ref/cpp/instm/QGLFormat/blueBufferSize" />
210
245
<h3 class="fn"><a name="blueBufferSize"></a>int QGLFormat::blueBufferSize () const</h3>
211
246
<p>Returns the blue buffer size.</p>
212
247
<p>This function was introduced in Qt 4.2.</p>
213
248
<p>See also <a href="qglformat.html#setBlueBufferSize">setBlueBufferSize</a>().</p>
 
249
<a name="//apple_ref/cpp/clm/QGLFormat/defaultFormat" />
214
250
<h3 class="fn"><a name="defaultFormat"></a>QGLFormat QGLFormat::defaultFormat ()&nbsp;&nbsp;<tt> [static]</tt></h3>
215
 
<p>Returns the default <a href="qglformat.html">QGLFormat</a> for the application. All QGLWidgets that are created use this format unless another format is specified, e.g&#x2e; when they are constructed.</p>
 
251
<p>Returns the default <a href="qglformat.html">QGLFormat</a> for the application. All <a href="qglwidget.html">QGLWidget</a> objects that are created use this format unless another format is specified, e.g&#x2e; when they are constructed.</p>
216
252
<p>If no special default format has been set using <a href="qglformat.html#setDefaultFormat">setDefaultFormat</a>(), the default format is the same as that created with <a href="qglformat.html#QGLFormat">QGLFormat</a>().</p>
217
253
<p>See also <a href="qglformat.html#setDefaultFormat">setDefaultFormat</a>().</p>
 
254
<a name="//apple_ref/cpp/clm/QGLFormat/defaultOverlayFormat" />
218
255
<h3 class="fn"><a name="defaultOverlayFormat"></a>QGLFormat QGLFormat::defaultOverlayFormat ()&nbsp;&nbsp;<tt> [static]</tt></h3>
219
256
<p>Returns the default <a href="qglformat.html">QGLFormat</a> for overlay contexts.</p>
220
 
<p>The factory default overlay format is:</p>
 
257
<p>The default overlay format is:</p>
221
258
<ul>
222
259
<li><a href="qglformat.html#setDoubleBuffer">Double buffer:</a> Disabled.</li>
223
260
<li><a href="qglformat.html#setDepth">Depth buffer:</a> Disabled.</li>
228
265
<li><a href="qglformat.html#setStereo">Stereo:</a> Disabled.</li>
229
266
<li><a href="qglformat.html#setDirectRendering">Direct rendering:</a> Enabled.</li>
230
267
<li><a href="qglformat.html#setOverlay">Overlay:</a> Disabled.</li>
 
268
<li><a href="qglformat.html#setSampleBuffers">Multisample buffers:</a> Disabled.</li>
231
269
<li><a href="qglformat.html#setPlane">Plane:</a> 1 (i.e&#x2e;, first overlay plane).</li>
232
270
</ul>
233
271
<p>See also <a href="qglformat.html#setDefaultOverlayFormat">setDefaultOverlayFormat</a>() and <a href="qglformat.html#setDefaultFormat">setDefaultFormat</a>().</p>
 
272
<a name="//apple_ref/cpp/instm/QGLFormat/depth" />
234
273
<h3 class="fn"><a name="depth"></a>bool QGLFormat::depth () const</h3>
235
274
<p>Returns true if the depth buffer is enabled; otherwise returns false. The depth buffer is enabled by default.</p>
236
275
<p>See also <a href="qglformat.html#setDepth">setDepth</a>() and <a href="qglformat.html#setDepthBufferSize">setDepthBufferSize</a>().</p>
 
276
<a name="//apple_ref/cpp/instm/QGLFormat/depthBufferSize" />
237
277
<h3 class="fn"><a name="depthBufferSize"></a>int QGLFormat::depthBufferSize () const</h3>
238
278
<p>Returns the depth buffer size.</p>
239
279
<p>See also <a href="qglformat.html#depth">depth</a>(), <a href="qglformat.html#setDepth">setDepth</a>(), and <a href="qglformat.html#setDepthBufferSize">setDepthBufferSize</a>().</p>
 
280
<a name="//apple_ref/cpp/instm/QGLFormat/directRendering" />
240
281
<h3 class="fn"><a name="directRendering"></a>bool QGLFormat::directRendering () const</h3>
241
282
<p>Returns true if direct rendering is enabled; otherwise returns false.</p>
242
283
<p>Direct rendering is enabled by default.</p>
243
284
<p>See also <a href="qglformat.html#setDirectRendering">setDirectRendering</a>().</p>
 
285
<a name="//apple_ref/cpp/instm/QGLFormat/doubleBuffer" />
244
286
<h3 class="fn"><a name="doubleBuffer"></a>bool QGLFormat::doubleBuffer () const</h3>
245
287
<p>Returns true if double buffering is enabled; otherwise returns false. Double buffering is enabled by default.</p>
246
288
<p>See also <a href="qglformat.html#setDoubleBuffer">setDoubleBuffer</a>().</p>
 
289
<a name="//apple_ref/cpp/instm/QGLFormat/greenBufferSize" />
247
290
<h3 class="fn"><a name="greenBufferSize"></a>int QGLFormat::greenBufferSize () const</h3>
248
291
<p>Returns the green buffer size.</p>
249
292
<p>This function was introduced in Qt 4.2.</p>
250
293
<p>See also <a href="qglformat.html#setGreenBufferSize">setGreenBufferSize</a>().</p>
 
294
<a name="//apple_ref/cpp/clm/QGLFormat/hasOpenGL" />
251
295
<h3 class="fn"><a name="hasOpenGL"></a>bool QGLFormat::hasOpenGL ()&nbsp;&nbsp;<tt> [static]</tt></h3>
252
296
<p>Returns true if the window system has any OpenGL support; otherwise returns false.</p>
253
297
<p><b>Warning:</b> This function must not be called until the <a href="qapplication.html">QApplication</a> object has been created.</p>
 
298
<a name="//apple_ref/cpp/clm/QGLFormat/hasOpenGLOverlays" />
254
299
<h3 class="fn"><a name="hasOpenGLOverlays"></a>bool QGLFormat::hasOpenGLOverlays ()&nbsp;&nbsp;<tt> [static]</tt></h3>
255
300
<p>Returns true if the window system supports OpenGL overlays; otherwise returns false.</p>
256
301
<p><b>Warning:</b> This function must not be called until the <a href="qapplication.html">QApplication</a> object has been created.</p>
 
302
<a name="//apple_ref/cpp/instm/QGLFormat/hasOverlay" />
257
303
<h3 class="fn"><a name="hasOverlay"></a>bool QGLFormat::hasOverlay () const</h3>
258
304
<p>Returns true if overlay plane is enabled; otherwise returns false.</p>
259
305
<p>Overlay is disabled by default.</p>
260
306
<p>See also <a href="qglformat.html#setOverlay">setOverlay</a>().</p>
 
307
<a name="//apple_ref/cpp/clm/QGLFormat/openGLVersionFlags" />
261
308
<h3 class="fn"><a name="openGLVersionFlags"></a><a href="qglformat.html#OpenGLVersionFlag-enum">OpenGLVersionFlags</a> QGLFormat::openGLVersionFlags ()&nbsp;&nbsp;<tt> [static]</tt></h3>
262
309
<p>Identifies, at runtime, which OpenGL versions that are supported by the current platform.</p>
263
310
<p>Note that if OpenGL version 1.5 is supported, its predecessors (i.e&#x2e;, version 1.4 and lower) are also supported. To identify the support of a particular feature, like multi texturing, test for the version in which the feature was first introduced (i.e&#x2e;, version 1.3 in the case of multi texturing) to adapt to the largest possible group of runtime platforms.</p>
264
311
<p>This function needs a valid current OpenGL context to work; otherwise it will return <a href="qglformat.html#OpenGLVersionFlag-enum">OpenGL_Version_None</a>.</p>
265
312
<p>This function was introduced in Qt 4.2.</p>
266
313
<p>See also <a href="qglformat.html#hasOpenGL">hasOpenGL</a>() and <a href="qglformat.html#hasOpenGLOverlays">hasOpenGLOverlays</a>().</p>
 
314
<a name="//apple_ref/cpp/instm/QGLFormat/plane" />
267
315
<h3 class="fn"><a name="plane"></a>int QGLFormat::plane () const</h3>
268
316
<p>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>
269
 
<p>See also <a href="qglformat.html#setPlane">setPlane</a>().</p>
 
317
<p>See also <a href="qglformat.html#setPlane">setPlane</a>() and <a href="qglformat.html#defaultOverlayFormat">defaultOverlayFormat</a>().</p>
 
318
<a name="//apple_ref/cpp/instm/QGLFormat/redBufferSize" />
270
319
<h3 class="fn"><a name="redBufferSize"></a>int QGLFormat::redBufferSize () const</h3>
271
320
<p>Returns the red buffer size.</p>
272
321
<p>This function was introduced in Qt 4.2.</p>
273
322
<p>See also <a href="qglformat.html#setRedBufferSize">setRedBufferSize</a>().</p>
 
323
<a name="//apple_ref/cpp/instm/QGLFormat/rgba" />
274
324
<h3 class="fn"><a name="rgba"></a>bool QGLFormat::rgba () const</h3>
275
325
<p>Returns true if RGBA color mode is set. Returns false if color index mode is set. The default color mode is RGBA.</p>
276
326
<p>See also <a href="qglformat.html#setRgba">setRgba</a>().</p>
 
327
<a name="//apple_ref/cpp/instm/QGLFormat/sampleBuffers" />
277
328
<h3 class="fn"><a name="sampleBuffers"></a>bool QGLFormat::sampleBuffers () const</h3>
278
329
<p>Returns true if multisample buffer support is enabled; otherwise returns false.</p>
279
330
<p>The multisample buffer is disabled by default.</p>
280
331
<p>See also <a href="qglformat.html#setSampleBuffers">setSampleBuffers</a>().</p>
 
332
<a name="//apple_ref/cpp/instm/QGLFormat/samples" />
281
333
<h3 class="fn"><a name="samples"></a>int QGLFormat::samples () const</h3>
282
334
<p>Returns the number of samples per pixel when multisampling is enabled. By default, the highest number of samples that is available is used.</p>
283
335
<p>See also <a href="qglformat.html#setSampleBuffers">setSampleBuffers</a>(), <a href="qglformat.html#sampleBuffers">sampleBuffers</a>(), and <a href="qglformat.html#setSamples">setSamples</a>().</p>
 
336
<a name="//apple_ref/cpp/instm/QGLFormat/setAccum" />
284
337
<h3 class="fn"><a name="setAccum"></a>void QGLFormat::setAccum ( bool <i>enable</i> )</h3>
285
338
<p>If <i>enable</i> is true enables the accumulation buffer; otherwise disables the accumulation buffer.</p>
286
339
<p>The accumulation buffer is disabled by default.</p>
287
340
<p>The accumulation buffer is used to create blur effects and multiple exposures.</p>
288
341
<p>See also <a href="qglformat.html#accum">accum</a>() and <a href="qglformat.html#setAccumBufferSize">setAccumBufferSize</a>().</p>
 
342
<a name="//apple_ref/cpp/instm/QGLFormat/setAccumBufferSize" />
289
343
<h3 class="fn"><a name="setAccumBufferSize"></a>void QGLFormat::setAccumBufferSize ( int <i>size</i> )</h3>
290
344
<p>Set the preferred accumulation buffer size, where <i>size</i> is the bit depth for each RGBA component.</p>
291
345
<p>See also <a href="qglformat.html#accum">accum</a>(), <a href="qglformat.html#setAccum">setAccum</a>(), and <a href="qglformat.html#accumBufferSize">accumBufferSize</a>().</p>
 
346
<a name="//apple_ref/cpp/instm/QGLFormat/setAlpha" />
292
347
<h3 class="fn"><a name="setAlpha"></a>void QGLFormat::setAlpha ( bool <i>enable</i> )</h3>
293
348
<p>If <i>enable</i> is true enables the alpha buffer; otherwise disables the alpha buffer.</p>
294
349
<p>The alpha buffer is disabled by default.</p>
295
350
<p>The alpha buffer is typically used for implementing transparency or translucency. The A in RGBA specifies the transparency of a pixel.</p>
296
351
<p>See also <a href="qglformat.html#alpha">alpha</a>() and <a href="qglformat.html#setAlphaBufferSize">setAlphaBufferSize</a>().</p>
 
352
<a name="//apple_ref/cpp/instm/QGLFormat/setAlphaBufferSize" />
297
353
<h3 class="fn"><a name="setAlphaBufferSize"></a>void QGLFormat::setAlphaBufferSize ( int <i>size</i> )</h3>
298
354
<p>Set the preferred alpha buffer size to <i>size</i>. This function implicitly enables the alpha channel.</p>
299
355
<p>See also <a href="qglformat.html#setRedBufferSize">setRedBufferSize</a>(), <a href="qglformat.html#setGreenBufferSize">setGreenBufferSize</a>(), and <a href="qglformat.html#alphaBufferSize">alphaBufferSize</a>().</p>
 
356
<a name="//apple_ref/cpp/instm/QGLFormat/setBlueBufferSize" />
300
357
<h3 class="fn"><a name="setBlueBufferSize"></a>void QGLFormat::setBlueBufferSize ( int <i>size</i> )</h3>
301
358
<p>Set the preferred blue buffer size to <i>size</i>.</p>
302
359
<p>This function was introduced in Qt 4.2.</p>
303
360
<p>See also <a href="qglformat.html#blueBufferSize">blueBufferSize</a>(), <a href="qglformat.html#setRedBufferSize">setRedBufferSize</a>(), <a href="qglformat.html#setGreenBufferSize">setGreenBufferSize</a>(), and <a href="qglformat.html#setAlphaBufferSize">setAlphaBufferSize</a>().</p>
 
361
<a name="//apple_ref/cpp/clm/QGLFormat/setDefaultFormat" />
304
362
<h3 class="fn"><a name="setDefaultFormat"></a>void QGLFormat::setDefaultFormat ( const QGLFormat &amp; <i>f</i> )&nbsp;&nbsp;<tt> [static]</tt></h3>
305
363
<p>Sets a new default <a href="qglformat.html">QGLFormat</a> for the application to <i>f</i>. For example, to set single buffering as the default instead of double buffering, your main() might contain code like this:</p>
306
364
<pre> QApplication a(argc, argv);
308
366
 f.setDoubleBuffer(false);
309
367
 QGLFormat::setDefaultFormat(f);</pre>
310
368
<p>See also <a href="qglformat.html#defaultFormat">defaultFormat</a>().</p>
 
369
<a name="//apple_ref/cpp/clm/QGLFormat/setDefaultOverlayFormat" />
311
370
<h3 class="fn"><a name="setDefaultOverlayFormat"></a>void QGLFormat::setDefaultOverlayFormat ( const QGLFormat &amp; <i>f</i> )&nbsp;&nbsp;<tt> [static]</tt></h3>
312
371
<p>Sets a new default <a href="qglformat.html">QGLFormat</a> for overlay contexts to <i>f</i>. This format is used whenever a <a href="qglwidget.html">QGLWidget</a> is created with a format that <a href="qglformat.html#hasOverlay">hasOverlay</a>() enabled.</p>
313
372
<p>For example, to get a double buffered overlay context (if available), use code like this:</p>
326
385
         ; <span class="comment">// no, only single buffered overlays are available</span>
327
386
 }</pre>
328
387
<p>See also <a href="qglformat.html#defaultOverlayFormat">defaultOverlayFormat</a>().</p>
 
388
<a name="//apple_ref/cpp/instm/QGLFormat/setDepth" />
329
389
<h3 class="fn"><a name="setDepth"></a>void QGLFormat::setDepth ( bool <i>enable</i> )</h3>
330
390
<p>If <i>enable</i> is true enables the depth buffer; otherwise disables the depth buffer.</p>
331
391
<p>The depth buffer is enabled by default.</p>
332
392
<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>
333
393
<p>See also <a href="qglformat.html#depth">depth</a>() and <a href="qglformat.html#setDepthBufferSize">setDepthBufferSize</a>().</p>
 
394
<a name="//apple_ref/cpp/instm/QGLFormat/setDepthBufferSize" />
334
395
<h3 class="fn"><a name="setDepthBufferSize"></a>void QGLFormat::setDepthBufferSize ( int <i>size</i> )</h3>
335
396
<p>Set the minimum depth buffer size to <i>size</i>.</p>
336
397
<p>See also <a href="qglformat.html#depthBufferSize">depthBufferSize</a>(), <a href="qglformat.html#setDepth">setDepth</a>(), and <a href="qglformat.html#depth">depth</a>().</p>
 
398
<a name="//apple_ref/cpp/instm/QGLFormat/setDirectRendering" />
337
399
<h3 class="fn"><a name="setDirectRendering"></a>void QGLFormat::setDirectRendering ( bool <i>enable</i> )</h3>
338
400
<p>If <i>enable</i> is true enables direct rendering; otherwise disables direct rendering.</p>
339
401
<p>Direct rendering is enabled by default.</p>
340
402
<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>
341
403
<p>See also <a href="qglformat.html#directRendering">directRendering</a>().</p>
 
404
<a name="//apple_ref/cpp/instm/QGLFormat/setDoubleBuffer" />
342
405
<h3 class="fn"><a name="setDoubleBuffer"></a>void QGLFormat::setDoubleBuffer ( bool <i>enable</i> )</h3>
343
406
<p>If <i>enable</i> is true sets double buffering; otherwise sets single buffering.</p>
344
407
<p>Double buffering is enabled by default.</p>
345
408
<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>
346
409
<p>See also <a href="qglformat.html#doubleBuffer">doubleBuffer</a>(), <a href="qglcontext.html#swapBuffers">QGLContext::swapBuffers</a>(), and <a href="qglwidget.html#swapBuffers">QGLWidget::swapBuffers</a>().</p>
 
410
<a name="//apple_ref/cpp/instm/QGLFormat/setGreenBufferSize" />
347
411
<h3 class="fn"><a name="setGreenBufferSize"></a>void QGLFormat::setGreenBufferSize ( int <i>size</i> )</h3>
348
412
<p>Set the preferred green buffer size to <i>size</i>.</p>
349
413
<p>This function was introduced in Qt 4.2.</p>
350
414
<p>See also <a href="qglformat.html#greenBufferSize">greenBufferSize</a>(), <a href="qglformat.html#setRedBufferSize">setRedBufferSize</a>(), <a href="qglformat.html#setBlueBufferSize">setBlueBufferSize</a>(), and <a href="qglformat.html#setAlphaBufferSize">setAlphaBufferSize</a>().</p>
 
415
<a name="//apple_ref/cpp/instm/QGLFormat/setOption" />
351
416
<h3 class="fn"><a name="setOption"></a>void QGLFormat::setOption ( <a href="qgl.html#FormatOption-enum">QGL::FormatOptions</a> <i>opt</i> )</h3>
352
417
<p>Sets the format option to <i>opt</i>.</p>
353
418
<p>See also <a href="qglformat.html#testOption">testOption</a>().</p>
 
419
<a name="//apple_ref/cpp/instm/QGLFormat/setOverlay" />
354
420
<h3 class="fn"><a name="setOverlay"></a>void QGLFormat::setOverlay ( bool <i>enable</i> )</h3>
355
421
<p>If <i>enable</i> is true enables an overlay plane; otherwise disables the overlay plane.</p>
356
422
<p>Enabling the overlay plane will cause <a href="qglwidget.html">QGLWidget</a> to create an additional context in an overlay plane. See the <a href="qglwidget.html">QGLWidget</a> documentation for further information.</p>
357
423
<p>See also <a href="qglformat.html#hasOverlay">hasOverlay</a>().</p>
 
424
<a name="//apple_ref/cpp/instm/QGLFormat/setPlane" />
358
425
<h3 class="fn"><a name="setPlane"></a>void QGLFormat::setPlane ( int <i>plane</i> )</h3>
359
426
<p>Sets the requested plane to <i>plane</i>. 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>
360
427
<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">QGLWidget</a> will be created.</p>
361
428
<p>See also <a href="qglformat.html#plane">plane</a>().</p>
 
429
<a name="//apple_ref/cpp/instm/QGLFormat/setRedBufferSize" />
362
430
<h3 class="fn"><a name="setRedBufferSize"></a>void QGLFormat::setRedBufferSize ( int <i>size</i> )</h3>
363
431
<p>Set the preferred red buffer size to <i>size</i>.</p>
364
432
<p>This function was introduced in Qt 4.2.</p>
365
433
<p>See also <a href="qglformat.html#redBufferSize">redBufferSize</a>(), <a href="qglformat.html#setGreenBufferSize">setGreenBufferSize</a>(), <a href="qglformat.html#setBlueBufferSize">setBlueBufferSize</a>(), and <a href="qglformat.html#setAlphaBufferSize">setAlphaBufferSize</a>().</p>
 
434
<a name="//apple_ref/cpp/instm/QGLFormat/setRgba" />
366
435
<h3 class="fn"><a name="setRgba"></a>void QGLFormat::setRgba ( bool <i>enable</i> )</h3>
367
436
<p>If <i>enable</i> is true sets RGBA mode. If <i>enable</i> is false sets color index mode.</p>
368
437
<p>The default color mode is RGBA.</p>
369
438
<p>RGBA is the preferred mode for most OpenGL applications. In RGBA color mode you specify colors as red + green + blue + alpha quadruplets.</p>
370
439
<p>In color index mode you specify an index into a color lookup table.</p>
371
440
<p>See also <a href="qglformat.html#rgba">rgba</a>().</p>
 
441
<a name="//apple_ref/cpp/instm/QGLFormat/setSampleBuffers" />
372
442
<h3 class="fn"><a name="setSampleBuffers"></a>void QGLFormat::setSampleBuffers ( bool <i>enable</i> )</h3>
373
443
<p>If <i>enable</i> is true, a GL context with multisample buffer support is picked; otherwise ignored.</p>
374
444
<p>See also <a href="qglformat.html#sampleBuffers">sampleBuffers</a>(), <a href="qglformat.html#setSamples">setSamples</a>(), and <a href="qglformat.html#samples">samples</a>().</p>
 
445
<a name="//apple_ref/cpp/instm/QGLFormat/setSamples" />
375
446
<h3 class="fn"><a name="setSamples"></a>void QGLFormat::setSamples ( int <i>numSamples</i> )</h3>
376
447
<p>Set the preferred number of samples per pixel when multisampling is enabled to <i>numSamples</i>. By default, the highest number of samples available is used.</p>
377
448
<p>See also <a href="qglformat.html#setSampleBuffers">setSampleBuffers</a>(), <a href="qglformat.html#sampleBuffers">sampleBuffers</a>(), and <a href="qglformat.html#samples">samples</a>().</p>
 
449
<a name="//apple_ref/cpp/instm/QGLFormat/setStencil" />
378
450
<h3 class="fn"><a name="setStencil"></a>void QGLFormat::setStencil ( bool <i>enable</i> )</h3>
379
451
<p>If <i>enable</i> is true enables the stencil buffer; otherwise disables the stencil buffer.</p>
380
 
<p>The stencil buffer is disabled by default.</p>
 
452
<p>The stencil buffer is enabled by default.</p>
381
453
<p>The stencil buffer masks certain parts of the drawing area so that masked parts are not drawn on.</p>
382
454
<p>See also <a href="qglformat.html#stencil">stencil</a>() and <a href="qglformat.html#setStencilBufferSize">setStencilBufferSize</a>().</p>
 
455
<a name="//apple_ref/cpp/instm/QGLFormat/setStencilBufferSize" />
383
456
<h3 class="fn"><a name="setStencilBufferSize"></a>void QGLFormat::setStencilBufferSize ( int <i>size</i> )</h3>
384
457
<p>Set the preferred stencil buffer size to <i>size</i>.</p>
385
458
<p>See also <a href="qglformat.html#stencilBufferSize">stencilBufferSize</a>(), <a href="qglformat.html#setStencil">setStencil</a>(), and <a href="qglformat.html#stencil">stencil</a>().</p>
 
459
<a name="//apple_ref/cpp/instm/QGLFormat/setStereo" />
386
460
<h3 class="fn"><a name="setStereo"></a>void QGLFormat::setStereo ( bool <i>enable</i> )</h3>
387
461
<p>If <i>enable</i> is true enables stereo buffering; otherwise disables stereo buffering.</p>
388
462
<p>Stereo buffering is disabled by default.</p>
389
463
<p>Stereo buffering provides extra color buffers to generate left-eye and right-eye images.</p>
390
464
<p>See also <a href="qglformat.html#stereo">stereo</a>().</p>
 
465
<a name="//apple_ref/cpp/instm/QGLFormat/setSwapInterval" />
391
466
<h3 class="fn"><a name="setSwapInterval"></a>void QGLFormat::setSwapInterval ( int <i>interval</i> )</h3>
392
467
<p>Set the preferred swap interval. This can be used to sync the GL drawing into a system window to the vertical refresh of the screen. Setting an <i>interval</i> value of 0 will turn the vertical refresh syncing off, any value higher than 0 will turn the vertical syncing on.</p>
393
468
<p>Under Windows and under X11, where the <tt>WGL_EXT_swap_control</tt> and <tt>GLX_SGI_video_sync</tt> extensions are used, the <i>interval</i> parameter can be used to set the minimum number of video frames that are displayed before a buffer swap will occur. In effect, setting the <i>interval</i> to 10, means there will be 10 vertical retraces between every buffer swap.</p>
394
469
<p>Under Windows the <tt>WGL_EXT_swap_control</tt> extension has to be present, and under X11 the <tt>GLX_SGI_video_sync</tt> extension has to be present.</p>
395
470
<p>This function was introduced in Qt 4.2.</p>
396
471
<p>See also <a href="qglformat.html#swapInterval">swapInterval</a>().</p>
 
472
<a name="//apple_ref/cpp/instm/QGLFormat/stencil" />
397
473
<h3 class="fn"><a name="stencil"></a>bool QGLFormat::stencil () const</h3>
398
 
<p>Returns true if the stencil buffer is enabled; otherwise returns false. The stencil buffer is disabled by default.</p>
 
474
<p>Returns true if the stencil buffer is enabled; otherwise returns false. The stencil buffer is enabled by default.</p>
399
475
<p>See also <a href="qglformat.html#setStencil">setStencil</a>() and <a href="qglformat.html#setStencilBufferSize">setStencilBufferSize</a>().</p>
 
476
<a name="//apple_ref/cpp/instm/QGLFormat/stencilBufferSize" />
400
477
<h3 class="fn"><a name="stencilBufferSize"></a>int QGLFormat::stencilBufferSize () const</h3>
401
478
<p>Returns the stencil buffer size.</p>
402
479
<p>See also <a href="qglformat.html#stencil">stencil</a>(), <a href="qglformat.html#setStencil">setStencil</a>(), and <a href="qglformat.html#setStencilBufferSize">setStencilBufferSize</a>().</p>
 
480
<a name="//apple_ref/cpp/instm/QGLFormat/stereo" />
403
481
<h3 class="fn"><a name="stereo"></a>bool QGLFormat::stereo () const</h3>
404
482
<p>Returns true if stereo buffering is enabled; otherwise returns false. Stereo buffering is disabled by default.</p>
405
483
<p>See also <a href="qglformat.html#setStereo">setStereo</a>().</p>
 
484
<a name="//apple_ref/cpp/instm/QGLFormat/swapInterval" />
406
485
<h3 class="fn"><a name="swapInterval"></a>int QGLFormat::swapInterval () const</h3>
407
486
<p>Returns the currently set swap interval. -1 is returned if setting the swap interval isn't supported in the system GL implementation.</p>
408
487
<p>This function was introduced in Qt 4.2.</p>
409
488
<p>See also <a href="qglformat.html#setSwapInterval">setSwapInterval</a>().</p>
 
489
<a name="//apple_ref/cpp/instm/QGLFormat/testOption" />
410
490
<h3 class="fn"><a name="testOption"></a>bool QGLFormat::testOption ( <a href="qgl.html#FormatOption-enum">QGL::FormatOptions</a> <i>opt</i> ) const</h3>
411
491
<p>Returns true if format option <i>opt</i> is set; otherwise returns false.</p>
412
492
<p>See also <a href="qglformat.html#setOption">setOption</a>().</p>
 
493
<a name="//apple_ref/cpp/instm/QGLFormat/operator=" />
413
494
<h3 class="fn"><a name="operator-eq"></a>QGLFormat &amp; QGLFormat::operator= ( const QGLFormat &amp; <i>other</i> )</h3>
414
495
<p>Assigns <i>other</i> to this object.</p>
 
496
<hr />
 
497
<h2>Related Non-Members</h2>
 
498
<h3 class="fn"><a name="operator-not-eq-32"></a>bool operator!= ( const QGLFormat &amp; <i>a</i>, const QGLFormat &amp; <i>b</i> )</h3>
 
499
<p>Returns false if all the options of the two <a href="qglformat.html">QGLFormat</a> objects <i>a</i> and <i>b</i> are equal; otherwise returns true.</p>
 
500
<h3 class="fn"><a name="operator-eq-eq-41"></a>bool operator== ( const QGLFormat &amp; <i>a</i>, const QGLFormat &amp; <i>b</i> )</h3>
 
501
<p>Returns true if all the options of the two <a href="qglformat.html">QGLFormat</a> objects <i>a</i> and <i>b</i> are equal; otherwise returns false.</p>
415
502
<p /><address><hr /><div align="center">
416
503
<table width="100%" cellspacing="0" border="0"><tr class="address">
417
 
<td width="30%" align="left">Copyright &copy; 2009 Nokia Corporation and/or its subsidiary(-ies)</td>
418
 
<td width="40%" align="center"><a href="trademarks.html">Trademarks</a></td>
419
 
<td width="30%" align="right"><div align="right">Qt 4.5.2</div></td>
420
 
</tr></table></div></address></body>
 
504
<td width="40%" align="left">Copyright &copy; 2009 Nokia Corporation and/or its subsidiary(-ies)</td>
 
505
<td width="20%" align="center"><a href="trademarks.html">Trademarks</a></td>
 
506
<td width="40%" align="right"><div align="right">Qt 4.6.0</div></td>
 
507
<script type="text/javascript" src="http://www.google.com/jsapi"></script><script type="text/javascript">google.load("elements", "1", {packages: "transliteration"});</script><script type="text/javascript" src="http://www.google.com/coop/cse/t13n?form=cse-search-box&t13n_langs=en"></script><script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=cse-search-box&lang=en"></script></tr></table></div></address></body>
421
508
</html>