File: qgl.html

package info (click to toggle)
qt4-x11 4%3A4.8.2%2Bdfsg-11
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 701,696 kB
  • sloc: cpp: 2,686,179; ansic: 375,485; python: 25,859; sh: 19,349; xml: 17,091; perl: 14,765; yacc: 5,383; asm: 5,038; makefile: 1,259; lex: 555; ruby: 526; objc: 347; cs: 112; pascal: 112; php: 54; sed: 34
file content (126 lines) | stat: -rw-r--r-- 10,217 bytes parent folder | download
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
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qgl.cpp -->
  <title>Qt 4.8: QGL Namespace</title>
  <link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<div class="header" id="qtdocheader">
  <div class="content"> 
    <a href="index.html" class="qtref"><span>Qt Reference Documentation</span></a>
  </div>
  <div class="breadcrumb toolblock">
    <ul>
      <li class="first"><a href="index.html">Home</a></li>
      <!--  Breadcrumbs go here -->
<li><a href="namespaces.html">Namespaces</a></li>
<li>QGL Namespace</li>
    </ul>
  </div>
</div>
<div class="content mainContent">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#types">Types</a></li>
<li class="level1"><a href="#functions">Functions</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QGL Namespace</h1>
<!-- $$$QGL-brief -->
<p>The QGL namespace specifies miscellaneous identifiers used in the Qt OpenGL module. <a href="#details">More...</a></p>
<!-- @@@QGL -->
<pre class="cpp"> <span class="preprocessor">#include &lt;QGL&gt;</span></pre><ul>
</ul>
<a name="types"></a>
<h2>Types</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qgl.html#FormatOption-enum">FormatOption</a></b> { DoubleBuffer, DepthBuffer, Rgba, AlphaChannel, ..., NoDeprecatedFunctions }</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> flags </td><td class="memItemRight bottomAlign"><b><a href="qgl.html#FormatOption-enum">FormatOptions</a></b></td></tr>
</table>
<a name="functions"></a>
<h2>Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qgl.html#setPreferredPaintEngine">setPreferredPaintEngine</a></b> ( QPaintEngine::Type <i>engineType</i> )</td></tr>
</table>
<a name="details"></a>
<!-- $$$QGL-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QGL namespace specifies miscellaneous identifiers used in the Qt OpenGL module.</p>
</div>
<!-- @@@QGL -->
<div class="types">
<h2>Type Documentation</h2>
<!-- $$$FormatOption$$$DoubleBuffer$$$DepthBuffer$$$Rgba$$$AlphaChannel$$$AccumBuffer$$$StencilBuffer$$$StereoBuffers$$$DirectRendering$$$HasOverlay$$$SampleBuffers$$$DeprecatedFunctions$$$SingleBuffer$$$NoDepthBuffer$$$ColorIndex$$$NoAlphaChannel$$$NoAccumBuffer$$$NoStencilBuffer$$$NoStereoBuffers$$$IndirectRendering$$$NoOverlay$$$NoSampleBuffers$$$NoDeprecatedFunctions -->
<h3 class="flags"><a name="FormatOption-enum"></a>enum QGL::<span class="name">FormatOption</span><br/>flags QGL::<span class="name">FormatOptions</span></h3>
<p>This enum specifies the format options that can be used to configure an OpenGL context. These are set using <a href="qglformat.html#setOption">QGLFormat::setOption</a>().</p>
<table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><tt>QGL::DoubleBuffer</tt></td><td class="topAlign"><tt>0x0001</tt></td><td class="topAlign">Specifies the use of double buffering.</td></tr>
<tr><td class="topAlign"><tt>QGL::DepthBuffer</tt></td><td class="topAlign"><tt>0x0002</tt></td><td class="topAlign">Enables the use of a depth buffer.</td></tr>
<tr><td class="topAlign"><tt>QGL::Rgba</tt></td><td class="topAlign"><tt>0x0004</tt></td><td class="topAlign">Specifies that the context should use RGBA as its pixel format.</td></tr>
<tr><td class="topAlign"><tt>QGL::AlphaChannel</tt></td><td class="topAlign"><tt>0x0008</tt></td><td class="topAlign">Enables the use of an alpha channel.</td></tr>
<tr><td class="topAlign"><tt>QGL::AccumBuffer</tt></td><td class="topAlign"><tt>0x0010</tt></td><td class="topAlign">Enables the use of an accumulation buffer.</td></tr>
<tr><td class="topAlign"><tt>QGL::StencilBuffer</tt></td><td class="topAlign"><tt>0x0020</tt></td><td class="topAlign">Enables the use of a stencil buffer.</td></tr>
<tr><td class="topAlign"><tt>QGL::StereoBuffers</tt></td><td class="topAlign"><tt>0x0040</tt></td><td class="topAlign">Enables the use of a stereo buffers for use with visualization hardware.</td></tr>
<tr><td class="topAlign"><tt>QGL::DirectRendering</tt></td><td class="topAlign"><tt>0x0080</tt></td><td class="topAlign">Specifies that the context is used for direct rendering to a display.</td></tr>
<tr><td class="topAlign"><tt>QGL::HasOverlay</tt></td><td class="topAlign"><tt>0x0100</tt></td><td class="topAlign">Enables the use of an overlay.</td></tr>
<tr><td class="topAlign"><tt>QGL::SampleBuffers</tt></td><td class="topAlign"><tt>0x0200</tt></td><td class="topAlign">Enables the use of sample buffers.</td></tr>
<tr><td class="topAlign"><tt>QGL::DeprecatedFunctions</tt></td><td class="topAlign"><tt>0x0400</tt></td><td class="topAlign">Enables the use of deprecated functionality for OpenGL 3.x contexts. A context with deprecated functionality enabled is called a full context in the OpenGL specification.</td></tr>
<tr><td class="topAlign"><tt>QGL::SingleBuffer</tt></td><td class="topAlign"><tt>DoubleBuffer&lt;&lt;16</tt></td><td class="topAlign">Specifies the use of a single buffer, as opposed to double buffers.</td></tr>
<tr><td class="topAlign"><tt>QGL::NoDepthBuffer</tt></td><td class="topAlign"><tt>DepthBuffer&lt;&lt;16</tt></td><td class="topAlign">Disables the use of a depth buffer.</td></tr>
<tr><td class="topAlign"><tt>QGL::ColorIndex</tt></td><td class="topAlign"><tt>Rgba&lt;&lt;16</tt></td><td class="topAlign">Specifies that the context should use a color index as its pixel format.</td></tr>
<tr><td class="topAlign"><tt>QGL::NoAlphaChannel</tt></td><td class="topAlign"><tt>AlphaChannel&lt;&lt;16</tt></td><td class="topAlign">Disables the use of an alpha channel.</td></tr>
<tr><td class="topAlign"><tt>QGL::NoAccumBuffer</tt></td><td class="topAlign"><tt>AccumBuffer&lt;&lt;16</tt></td><td class="topAlign">Disables the use of an accumulation buffer.</td></tr>
<tr><td class="topAlign"><tt>QGL::NoStencilBuffer</tt></td><td class="topAlign"><tt>StencilBuffer&lt;&lt;16</tt></td><td class="topAlign">Disables the use of a stencil buffer.</td></tr>
<tr><td class="topAlign"><tt>QGL::NoStereoBuffers</tt></td><td class="topAlign"><tt>StereoBuffers&lt;&lt;16</tt></td><td class="topAlign">Disables the use of stereo buffers.</td></tr>
<tr><td class="topAlign"><tt>QGL::IndirectRendering</tt></td><td class="topAlign"><tt>DirectRendering&lt;&lt;16</tt></td><td class="topAlign">Specifies that the context is used for indirect rendering to a buffer.</td></tr>
<tr><td class="topAlign"><tt>QGL::NoOverlay</tt></td><td class="topAlign"><tt>HasOverlay&lt;&lt;16</tt></td><td class="topAlign">Disables the use of an overlay.</td></tr>
<tr><td class="topAlign"><tt>QGL::NoSampleBuffers</tt></td><td class="topAlign"><tt>SampleBuffers&lt;&lt;16</tt></td><td class="topAlign">Disables the use of sample buffers.</td></tr>
<tr><td class="topAlign"><tt>QGL::NoDeprecatedFunctions</tt></td><td class="topAlign"><tt>DeprecatedFunctions&lt;&lt;16</tt></td><td class="topAlign">Disables the use of deprecated functionality for OpenGL 3.x contexts. A context with deprecated functionality disabled is called a forward compatible context in the OpenGL specification.</td></tr>
</table>
<p>The FormatOptions type is a typedef for <a href="qflags.html">QFlags</a>&lt;FormatOption&gt;. It stores an OR combination of FormatOption values.</p>
<p><b>See also </b><a href="opengl-samplebuffers.html">Sample Buffers Example</a>.</p>
<!-- @@@FormatOption -->
</div>
<div class="func">
<h2>Function Documentation</h2>
<!-- $$$setPreferredPaintEngine[overload1]$$$setPreferredPaintEngineQPaintEngine::Type -->
<h3 class="fn"><a name="setPreferredPaintEngine"></a><span class="type">void</span> QGL::<span class="name">setPreferredPaintEngine</span> ( <span class="type"><a href="qpaintengine.html#Type-enum">QPaintEngine::Type</a></span> <i>engineType</i> )</h3>
<p>Sets the preferred OpenGL paint engine that is used to draw onto <a href="qglwidget.html">QGLWidget</a>, <a href="qglpixelbuffer.html">QGLPixelBuffer</a> and <a href="qglframebufferobject.html">QGLFramebufferObject</a> targets with <a href="qpainter.html">QPainter</a> in Qt.</p>
<p>The <i>engineType</i> parameter specifies which of the GL engines to use. Only <tt>QPaintEngine::OpenGL</tt> and <tt>QPaintEngine::OpenGL2</tt> are valid parameters to this function. All other values are ignored.</p>
<p>By default, the <tt>QPaintEngine::OpenGL2</tt> engine is used if GL/GLES version 2.0 is available, otherwise <tt>QPaintEngine::OpenGL</tt> is used.</p>
<p><b>Warning:</b> This function must be called before the <a href="qapplication.html">QApplication</a> constructor is called.</p>
<p>This function was introduced in Qt 4.6.</p>
<!-- @@@setPreferredPaintEngine -->
</div>
  <div class="ft">
    <span></span>
  </div>
</div> 
<div class="footer">
    <p>
      <acronym title="Copyright">&copy;</acronym> 2012 Nokia Corporation and/or its
      subsidiaries. Documentation contributions included herein are the copyrights of
      their respective owners.</p>
    <br />
    <p>
      The documentation provided herein is licensed under the terms of the
      <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation
      License version 1.3</a> as published by the Free Software Foundation.</p>
    <p>
      Documentation sources may be obtained from <a href="http://www.qt-project.org">
      www.qt-project.org</a>.</p>
    <br />
    <p>
      Nokia, Qt and their respective logos are trademarks of Nokia Corporation 
      in Finland and/or other countries worldwide. All other trademarks are property
      of their respective owners. <a title="Privacy Policy"
      href="http://en.gitorious.org/privacy_policy/">Privacy Policy</a></p>
</div>
</body>
</html>