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 -->
7
<title>Qt 4.5: QGLContext Class Reference</title>
7
<title>Qt 4.6: QGLContext Class Reference</title>
8
8
<link href="classic.css" rel="stylesheet" type="text/css" />
11
<a name="//apple_ref/cpp/cl//QGLContext" />
11
12
<table border="0" cellpadding="0" cellspacing="0" width="100%">
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"> </td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a> · <a href="namespaces.html"><font color="#004faf">All Namespaces</font></a> · <a href="classes.html"><font color="#004faf">All Classes</font></a> · <a href="mainclasses.html"><font color="#004faf">Main Classes</font></a> · <a href="groups.html"><font color="#004faf">Grouped Classes</font></a> · <a href="modules.html"><font color="#004faf">Modules</font></a> · <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">QGLContext 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"> </td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a> · <a href="classes.html"><font color="#004faf">All Classes</font></a> · <a href="functions.html"><font color="#004faf">All Functions</font></a> · <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">QGLContext Class Reference<br /><span class="small-subtitle">[<a href="qtopengl.html">QtOpenGL</a> module]</span>
17
18
<p>The QGLContext class encapsulates an OpenGL rendering context. <a href="#details">More...</a></p>
18
<pre> #include <QGLContext></pre><ul>
19
<pre> #include <QGLContext></pre><p><b>This class is not part of the Qt GUI Framework Edition.</b></p>
19
21
<li><a href="qglcontext-members.html">List of all members, including inherited members</a></li>
20
22
<li><a href="qglcontext-obsolete.html">Obsolete members</a></li>
25
<a name="public-types"></a>
27
<table class="alignedsummary" border="0" cellpadding="0" cellspacing="0" width="100%">
28
<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><b><a href="qglcontext.html#BindOption-enum">BindOption</a></b> { NoBindOption, InvertedYBindOption, MipmapBindOption, PremultipliedAlphaBindOption, LinearFilteringBindOption, DefaultBindOption }</td></tr>
29
<tr><td class="memItemLeft" align="right" valign="top">flags </td><td class="memItemRight" valign="bottom"><b><a href="qglcontext.html#BindOption-enum">BindOptions</a></b></td></tr>
22
32
<a name="public-functions"></a>
23
<h3>Public Functions</h3>
25
<li><div class="fn"></div><b><a href="qglcontext.html#QGLContext">QGLContext</a></b> ( const QGLFormat & <i>format</i> )</li>
26
<li><div class="fn"></div>virtual <b><a href="qglcontext.html#dtor.QGLContext">~QGLContext</a></b> ()</li>
27
<li><div class="fn"></div>GLuint <b><a href="qglcontext.html#bindTexture">bindTexture</a></b> ( const QImage & <i>image</i>, GLenum <i>target</i> = GL_TEXTURE_2D, GLint <i>format</i> = GL_RGBA )</li>
28
<li><div class="fn"></div>GLuint <b><a href="qglcontext.html#bindTexture-2">bindTexture</a></b> ( const QString & <i>fileName</i> )</li>
29
<li><div class="fn"></div>GLuint <b><a href="qglcontext.html#bindTexture-3">bindTexture</a></b> ( const QPixmap & <i>pixmap</i>, GLenum <i>target</i> = GL_TEXTURE_2D, GLint <i>format</i> = GL_RGBA )</li>
30
<li><div class="fn"></div>virtual bool <b><a href="qglcontext.html#create">create</a></b> ( const QGLContext * <i>shareContext</i> = 0 )</li>
31
<li><div class="fn"></div>void <b><a href="qglcontext.html#deleteTexture">deleteTexture</a></b> ( GLuint <i>id</i> )</li>
32
<li><div class="fn"></div>QPaintDevice * <b><a href="qglcontext.html#device">device</a></b> () const</li>
33
<li><div class="fn"></div>virtual void <b><a href="qglcontext.html#doneCurrent">doneCurrent</a></b> ()</li>
34
<li><div class="fn"></div>void <b><a href="qglcontext.html#drawTexture">drawTexture</a></b> ( const QRectF & <i>target</i>, GLuint <i>textureId</i>, GLenum <i>textureTarget</i> = GL_TEXTURE_2D )</li>
35
<li><div class="fn"></div>void <b><a href="qglcontext.html#drawTexture-2">drawTexture</a></b> ( const QPointF & <i>point</i>, GLuint <i>textureId</i>, GLenum <i>textureTarget</i> = GL_TEXTURE_2D )</li>
36
<li><div class="fn"></div>QGLFormat <b><a href="qglcontext.html#format">format</a></b> () const</li>
37
<li><div class="fn"></div>void * <b><a href="qglcontext.html#getProcAddress">getProcAddress</a></b> ( const QString & <i>proc</i> ) const</li>
38
<li><div class="fn"></div>bool <b><a href="qglcontext.html#isSharing">isSharing</a></b> () const</li>
39
<li><div class="fn"></div>bool <b><a href="qglcontext.html#isValid">isValid</a></b> () const</li>
40
<li><div class="fn"></div>virtual void <b><a href="qglcontext.html#makeCurrent">makeCurrent</a></b> ()</li>
41
<li><div class="fn"></div>QColor <b><a href="qglcontext.html#overlayTransparentColor">overlayTransparentColor</a></b> () const</li>
42
<li><div class="fn"></div>QGLFormat <b><a href="qglcontext.html#requestedFormat">requestedFormat</a></b> () const</li>
43
<li><div class="fn"></div>void <b><a href="qglcontext.html#reset">reset</a></b> ()</li>
44
<li><div class="fn"></div>void <b><a href="qglcontext.html#setFormat">setFormat</a></b> ( const QGLFormat & <i>format</i> )</li>
45
<li><div class="fn"></div>virtual void <b><a href="qglcontext.html#swapBuffers">swapBuffers</a></b> () const</li>
46
<li><div class="fn"></div>void <b><a href="qglcontext.html#updatePaintDevice">updatePaintDevice</a></b> ()</li>
33
<h2>Public Functions</h2>
34
<table class="alignedsummary" border="0" cellpadding="0" cellspacing="0" width="100%">
35
<tr><td class="memItemLeft" align="right" valign="top"></td><td class="memItemRight" valign="bottom"><b><a href="qglcontext.html#QGLContext">QGLContext</a></b> ( const QGLFormat & <i>format</i> )</td></tr>
36
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><b><a href="qglcontext.html#dtor.QGLContext">~QGLContext</a></b> ()</td></tr>
37
<tr><td class="memItemLeft" align="right" valign="top">GLuint </td><td class="memItemRight" valign="bottom"><b><a href="qglcontext.html#bindTexture">bindTexture</a></b> ( const QImage & <i>image</i>, GLenum <i>target</i>, GLint <i>format</i>, BindOptions <i>options</i> )</td></tr>
38
<tr><td class="memItemLeft" align="right" valign="top">GLuint </td><td class="memItemRight" valign="bottom"><b><a href="qglcontext.html#bindTexture-2">bindTexture</a></b> ( const QString & <i>fileName</i> )</td></tr>
39
<tr><td class="memItemLeft" align="right" valign="top">GLuint </td><td class="memItemRight" valign="bottom"><b><a href="qglcontext.html#bindTexture-3">bindTexture</a></b> ( const QImage & <i>image</i>, GLenum <i>target</i> = GL_TEXTURE_2D, GLint <i>format</i> = GL_RGBA )</td></tr>
40
<tr><td class="memItemLeft" align="right" valign="top">GLuint </td><td class="memItemRight" valign="bottom"><b><a href="qglcontext.html#bindTexture-4">bindTexture</a></b> ( const QPixmap & <i>pixmap</i>, GLenum <i>target</i> = GL_TEXTURE_2D, GLint <i>format</i> = GL_RGBA )</td></tr>
41
<tr><td class="memItemLeft" align="right" valign="top">GLuint </td><td class="memItemRight" valign="bottom"><b><a href="qglcontext.html#bindTexture-5">bindTexture</a></b> ( const QPixmap & <i>pixmap</i>, GLenum <i>target</i>, GLint <i>format</i>, BindOptions <i>options</i> )</td></tr>
42
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><b><a href="qglcontext.html#create">create</a></b> ( const QGLContext * <i>shareContext</i> = 0 )</td></tr>
43
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qglcontext.html#deleteTexture">deleteTexture</a></b> ( GLuint <i>id</i> )</td></tr>
44
<tr><td class="memItemLeft" align="right" valign="top">QPaintDevice * </td><td class="memItemRight" valign="bottom"><b><a href="qglcontext.html#device">device</a></b> () const</td></tr>
45
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><b><a href="qglcontext.html#doneCurrent">doneCurrent</a></b> ()</td></tr>
46
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qglcontext.html#drawTexture">drawTexture</a></b> ( const QRectF & <i>target</i>, GLuint <i>textureId</i>, GLenum <i>textureTarget</i> = GL_TEXTURE_2D )</td></tr>
47
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qglcontext.html#drawTexture-2">drawTexture</a></b> ( const QPointF & <i>point</i>, GLuint <i>textureId</i>, GLenum <i>textureTarget</i> = GL_TEXTURE_2D )</td></tr>
48
<tr><td class="memItemLeft" align="right" valign="top">QGLFormat </td><td class="memItemRight" valign="bottom"><b><a href="qglcontext.html#format">format</a></b> () const</td></tr>
49
<tr><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><b><a href="qglcontext.html#getProcAddress">getProcAddress</a></b> ( const QString & <i>proc</i> ) const</td></tr>
50
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><b><a href="qglcontext.html#isSharing">isSharing</a></b> () const</td></tr>
51
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><b><a href="qglcontext.html#isValid">isValid</a></b> () const</td></tr>
52
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><b><a href="qglcontext.html#makeCurrent">makeCurrent</a></b> ()</td></tr>
53
<tr><td class="memItemLeft" align="right" valign="top">QColor </td><td class="memItemRight" valign="bottom"><b><a href="qglcontext.html#overlayTransparentColor">overlayTransparentColor</a></b> () const</td></tr>
54
<tr><td class="memItemLeft" align="right" valign="top">QGLFormat </td><td class="memItemRight" valign="bottom"><b><a href="qglcontext.html#requestedFormat">requestedFormat</a></b> () const</td></tr>
55
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qglcontext.html#reset">reset</a></b> ()</td></tr>
56
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qglcontext.html#setFormat">setFormat</a></b> ( const QGLFormat & <i>format</i> )</td></tr>
57
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><b><a href="qglcontext.html#swapBuffers">swapBuffers</a></b> () const</td></tr>
48
60
<a name="static-public-members"></a>
49
<h3>Static Public Members</h3>
51
<li><div class="fn"></div>const QGLContext * <b><a href="qglcontext.html#currentContext">currentContext</a></b> ()</li>
52
<li><div class="fn"></div>void <b><a href="qglcontext.html#setTextureCacheLimit">setTextureCacheLimit</a></b> ( int <i>size</i> )</li>
53
<li><div class="fn"></div>int <b><a href="qglcontext.html#textureCacheLimit">textureCacheLimit</a></b> ()</li>
61
<h2>Static Public Members</h2>
62
<table class="alignedsummary" border="0" cellpadding="0" cellspacing="0" width="100%">
63
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><b><a href="qglcontext.html#areSharing">areSharing</a></b> ( const QGLContext * <i>context1</i>, const QGLContext * <i>context2</i> )</td></tr>
64
<tr><td class="memItemLeft" align="right" valign="top">const QGLContext * </td><td class="memItemRight" valign="bottom"><b><a href="qglcontext.html#currentContext">currentContext</a></b> ()</td></tr>
65
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qglcontext.html#setTextureCacheLimit">setTextureCacheLimit</a></b> ( int <i>size</i> )</td></tr>
66
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><b><a href="qglcontext.html#textureCacheLimit">textureCacheLimit</a></b> ()</td></tr>
55
69
<a name="protected-functions"></a>
56
<h3>Protected Functions</h3>
58
<li><div class="fn"></div>virtual bool <b><a href="qglcontext.html#chooseContext">chooseContext</a></b> ( const QGLContext * <i>shareContext</i> = 0 )</li>
59
<li><div class="fn"></div>virtual void * <b><a href="qglcontext.html#chooseMacVisual">chooseMacVisual</a></b> ( GDHandle )</li>
60
<li><div class="fn"></div>virtual int <b><a href="qglcontext.html#choosePixelFormat">choosePixelFormat</a></b> ( void * <i>dummyPfd</i>, HDC <i>pdc</i> )</li>
61
<li><div class="fn"></div>virtual void * <b><a href="qglcontext.html#chooseVisual">chooseVisual</a></b> ()</li>
62
<li><div class="fn"></div>bool <b><a href="qglcontext.html#deviceIsPixmap">deviceIsPixmap</a></b> () const</li>
63
<li><div class="fn"></div>bool <b><a href="qglcontext.html#initialized">initialized</a></b> () const</li>
64
<li><div class="fn"></div>void <b><a href="qglcontext.html#setInitialized">setInitialized</a></b> ( bool <i>on</i> )</li>
65
<li><div class="fn"></div>void <b><a href="qglcontext.html#setWindowCreated">setWindowCreated</a></b> ( bool <i>on</i> )</li>
66
<li><div class="fn"></div>bool <b><a href="qglcontext.html#windowCreated">windowCreated</a></b> () const</li>
70
<h2>Protected Functions</h2>
71
<table class="alignedsummary" border="0" cellpadding="0" cellspacing="0" width="100%">
72
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><b><a href="qglcontext.html#chooseContext">chooseContext</a></b> ( const QGLContext * <i>shareContext</i> = 0 )</td></tr>
73
<tr><td class="memItemLeft" align="right" valign="top">virtual void * </td><td class="memItemRight" valign="bottom"><b><a href="qglcontext.html#chooseMacVisual">chooseMacVisual</a></b> ( GDHandle <i>handle</i> )</td></tr>
74
<tr><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><b><a href="qglcontext.html#choosePixelFormat">choosePixelFormat</a></b> ( void * <i>dummyPfd</i>, HDC <i>pdc</i> )</td></tr>
75
<tr><td class="memItemLeft" align="right" valign="top">virtual void * </td><td class="memItemRight" valign="bottom"><b><a href="qglcontext.html#chooseVisual">chooseVisual</a></b> ()</td></tr>
76
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><b><a href="qglcontext.html#deviceIsPixmap">deviceIsPixmap</a></b> () const</td></tr>
77
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><b><a href="qglcontext.html#initialized">initialized</a></b> () const</td></tr>
78
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qglcontext.html#setInitialized">setInitialized</a></b> ( bool <i>on</i> )</td></tr>
79
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qglcontext.html#setWindowCreated">setWindowCreated</a></b> ( bool <i>on</i> )</td></tr>
80
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><b><a href="qglcontext.html#windowCreated">windowCreated</a></b> () const</td></tr>
68
82
<a name="details"></a>
70
84
<h2>Detailed Description</h2>
74
88
<p>If you're using double buffering you can swap the screen contents with the off-screen buffer using <a href="qglcontext.html#swapBuffers">swapBuffers</a>().</p>
75
89
<p>Please note that QGLContext is not thread safe.</p>
91
<h2>Member Type Documentation</h2>
92
<a name="//apple_ref/cpp/tag/QGLContext/BindOption" />
93
<a name="//apple_ref/cpp/econst/QGLContext/NoBindOption" />
94
<a name="//apple_ref/cpp/econst/QGLContext/InvertedYBindOption" />
95
<a name="//apple_ref/cpp/econst/QGLContext/MipmapBindOption" />
96
<a name="//apple_ref/cpp/econst/QGLContext/PremultipliedAlphaBindOption" />
97
<a name="//apple_ref/cpp/econst/QGLContext/LinearFilteringBindOption" />
98
<a name="//apple_ref/cpp/econst/QGLContext/DefaultBindOption" />
99
<a name="//apple_ref/cpp/econst/QGLContext/CanFlipNativePixmapBindOption" />
100
<a name="//apple_ref/cpp/econst/QGLContext/MemoryManagedBindOption" />
101
<a name="//apple_ref/cpp/econst/QGLContext/InternalBindOption" />
102
<a name="//apple_ref/cpp/tdef/QGLContext/BindOptions" />
103
<h3 class="flags"><a name="BindOption-enum"></a>enum QGLContext::BindOption<br />flags QGLContext::BindOptions</h3>
104
<p>A set of options to decide how to bind a texture using <a href="qglcontext.html#bindTexture">bindTexture</a>().</p>
105
<p><table class="valuelist" border="1" cellpadding="2" cellspacing="1" width="100%">
106
<tr><th width="25%">Constant</th><th width="15%">Value</th><th width="60%">Description</th></tr>
107
<tr><td valign="top"><tt>QGLContext::NoBindOption</tt></td><td align="center" valign="top"><tt>0x0000</tt></td><td valign="top">Don't do anything, pass the texture straight thru.</td></tr>
108
<tr><td valign="top"><tt>QGLContext::InvertedYBindOption</tt></td><td align="center" valign="top"><tt>0x0001</tt></td><td valign="top">Specifies that the texture should be flipped over the X axis so that the texture coordinate 0,0 corresponds to the top left corner. Inverting the texture implies a deep copy prior to upload.</td></tr>
109
<tr><td valign="top"><tt>QGLContext::MipmapBindOption</tt></td><td align="center" valign="top"><tt>0x0002</tt></td><td valign="top">Specifies that <a href="qglcontext.html#bindTexture">bindTexture</a>() should try to generate mipmaps. If the GL implementation supports the <tt>GL_SGIS_generate_mipmap</tt> extension, mipmaps will be automatically generated for the texture. Mipmap generation is only supported for the <tt>GL_TEXTURE_2D</tt> target.</td></tr>
110
<tr><td valign="top"><tt>QGLContext::PremultipliedAlphaBindOption</tt></td><td align="center" valign="top"><tt>0x0004</tt></td><td valign="top">Specifies that the image should be uploaded with premultiplied alpha and does a conversion accordingly.</td></tr>
111
<tr><td valign="top"><tt>QGLContext::LinearFilteringBindOption</tt></td><td align="center" valign="top"><tt>0x0008</tt></td><td valign="top">Specifies that the texture filtering should be set to GL_LINEAR. Default is GL_NEAREST. If mipmap is also enabled, filtering will be set to GL_LINEAR_MIPMAP_LINEAR.</td></tr>
112
<tr><td valign="top"><tt>QGLContext::DefaultBindOption</tt></td><td align="center" valign="top"><tt>LinearFilteringBindOption | InvertedYBindOption | MipmapBindOption</tt></td><td valign="top">In Qt 4.5 and earlier, <a href="qglcontext.html#bindTexture">bindTexture</a>() would mirror the image and automatically generate mipmaps. This option helps preserve this default behavior.</td></tr>
114
<p>Used by x11 from pixmap to choose wether or not it can bind the pixmap upside down or not.</p>
115
<p>Used by paint engines to indicate that the pixmap should be memory managed along side with the pixmap/image that it stems from, e.g. installing destruction hooks in them.</p>
116
<p>The BindOptions type is a typedef for <a href="qflags.html">QFlags</a><BindOption>. It stores an OR combination of BindOption values.</p>
77
118
<h2>Member Function Documentation</h2>
119
<a name="//apple_ref/cpp/instm/QGLContext/QGLContext" />
78
120
<h3 class="fn"><a name="QGLContext"></a>QGLContext::QGLContext ( const <a href="qglformat.html">QGLFormat</a> & <i>format</i> )</h3>
79
121
<p>Constructs an OpenGL context with the given <i>format</i> which specifies several display options for the context.</p>
80
122
<p>If the underlying OpenGL/Window system cannot satisfy all the features requested in <i>format</i>, the nearest subset of features will be used. After creation, the <a href="qglcontext.html#format">format</a>() method will return the actual format obtained.</p>
81
123
<p>Note that after a <a href="qglcontext.html">QGLContext</a> object has been constructed, <a href="qglcontext.html#create">create</a>() must be called explicitly to create the actual OpenGL context. The context will be <a href="qglcontext.html#isValid">invalid</a> if it was not possible to obtain a GL context at all.</p>
82
124
<p>See also <a href="qglcontext.html#format">format</a>() and <a href="qglcontext.html#isValid">isValid</a>().</p>
125
<a name="//apple_ref/cpp/instm/QGLContext/~QGLContext" />
83
126
<h3 class="fn"><a name="dtor.QGLContext"></a>QGLContext::~QGLContext () <tt> [virtual]</tt></h3>
84
127
<p>Destroys the OpenGL context and frees its resources.</p>
85
<h3 class="fn"><a name="bindTexture"></a>GLuint QGLContext::bindTexture ( const <a href="qimage.html">QImage</a> & <i>image</i>, GLenum <i>target</i> = GL_TEXTURE_2D, GLint <i>format</i> = GL_RGBA )</h3>
128
<a name="//apple_ref/cpp/clm/QGLContext/areSharing" />
129
<h3 class="fn"><a name="areSharing"></a>bool QGLContext::areSharing ( const QGLContext * <i>context1</i>, const QGLContext * <i>context2</i> ) <tt> [static]</tt></h3>
130
<p>Returns true if <i>context1</i> and <i>context2</i> are sharing their GL resources such as textures, shader programs, etc; otherwise returns false.</p>
131
<p>This function was introduced in Qt 4.6.</p>
132
<a name="//apple_ref/cpp/instm/QGLContext/bindTexture" />
133
<h3 class="fn"><a name="bindTexture"></a>GLuint QGLContext::bindTexture ( const <a href="qimage.html">QImage</a> & <i>image</i>, GLenum <i>target</i>, GLint <i>format</i>, <a href="qglcontext.html#BindOption-enum">BindOptions</a> <i>options</i> )</h3>
86
134
<p>Generates and binds a 2D GL texture to the current context, based on <i>image</i>. The generated texture id is returned and can be used in later <tt>glBindTexture()</tt> calls.</p>
87
135
<p>The <i>target</i> parameter specifies the texture target. The default target is <tt>GL_TEXTURE_2D</tt>.</p>
88
<p>The <i>format</i> parameter sets the internal format for the texture. The default format is <tt>GL_RGBA8</tt>.</p>
89
<p>If the GL implementation supports the <tt>GL_SGIS_generate_mipmap</tt> extension, mipmaps will be automatically generated for the texture. Mipmap generation is only supported for the <tt>GL_TEXTURE_2D</tt> target.</p>
136
<p>The <i>format</i> parameter sets the internal format for the texture. The default format is <tt>GL_RGBA</tt>.</p>
137
<p>The binding <i>options</i> are a set of options used to decide how to bind the texture to the context.</p>
90
138
<p>The texture that is generated is cached, so multiple calls to bindTexture() with the same <a href="qimage.html">QImage</a> will return the same texture id.</p>
91
139
<p>Note that we assume default values for the glPixelStore() and glPixelTransfer() parameters.</p>
140
<p>This function was introduced in Qt 4.6.</p>
92
141
<p>See also <a href="qglcontext.html#deleteTexture">deleteTexture</a>().</p>
93
142
<h3 class="fn"><a name="bindTexture-2"></a>GLuint QGLContext::bindTexture ( const <a href="qstring.html">QString</a> & <i>fileName</i> )</h3>
94
143
<p>This is an overloaded function.</p>
96
145
<p>Only the DXT1, DXT3 and DXT5 DDS formats are supported.</p>
97
146
<p>Note that this will only work if the implementation supports the <tt>GL_ARB_texture_compression</tt> and <tt>GL_EXT_texture_compression_s3tc</tt> extensions.</p>
98
147
<p>See also <a href="qglcontext.html#deleteTexture">deleteTexture</a>().</p>
99
<h3 class="fn"><a name="bindTexture-3"></a>GLuint QGLContext::bindTexture ( const <a href="qpixmap.html">QPixmap</a> & <i>pixmap</i>, GLenum <i>target</i> = GL_TEXTURE_2D, GLint <i>format</i> = GL_RGBA )</h3>
148
<h3 class="fn"><a name="bindTexture-3"></a>GLuint QGLContext::bindTexture ( const <a href="qimage.html">QImage</a> & <i>image</i>, GLenum <i>target</i> = GL_TEXTURE_2D, GLint <i>format</i> = GL_RGBA )</h3>
149
<p>Generates and binds a 2D GL texture to the current context, based on <i>image</i>. The generated texture id is returned and can be used in later <tt>glBindTexture()</tt> calls.</p>
150
<p>This is an overloaded function.</p>
151
<h3 class="fn"><a name="bindTexture-4"></a>GLuint QGLContext::bindTexture ( const <a href="qpixmap.html">QPixmap</a> & <i>pixmap</i>, GLenum <i>target</i> = GL_TEXTURE_2D, GLint <i>format</i> = GL_RGBA )</h3>
100
152
<p>This is an overloaded function.</p>
101
153
<p>Generates and binds a 2D GL texture based on <i>pixmap</i>.</p>
154
<h3 class="fn"><a name="bindTexture-5"></a>GLuint QGLContext::bindTexture ( const <a href="qpixmap.html">QPixmap</a> & <i>pixmap</i>, GLenum <i>target</i>, GLint <i>format</i>, <a href="qglcontext.html#BindOption-enum">BindOptions</a> <i>options</i> )</h3>
155
<p>This is an overloaded function.</p>
156
<p>Generates and binds a 2D GL texture to the current context, based on <i>pixmap</i>.</p>
157
<p>This function was introduced in Qt 4.6.</p>
158
<a name="//apple_ref/cpp/instm/QGLContext/chooseContext" />
102
159
<h3 class="fn"><a name="chooseContext"></a>bool QGLContext::chooseContext ( const QGLContext * <i>shareContext</i> = 0 ) <tt> [virtual protected]</tt></h3>
103
160
<p>This semi-internal function is called by <a href="qglcontext.html#create">create</a>(). It creates a system-dependent OpenGL handle that matches the <a href="qglcontext.html#format">format</a>() of <i>shareContext</i> as closely as possible, returning true if successful or false if a suitable handle could not be found.</p>
104
161
<p>On Windows, it calls the virtual function <a href="qglcontext.html#choosePixelFormat">choosePixelFormat</a>(), which finds a matching pixel format identifier. On X11, it calls the virtual function <a href="qglcontext.html#chooseVisual">chooseVisual</a>() which finds an appropriate X visual. On other platforms it may work differently.</p>
105
<h3 class="fn"><a name="chooseMacVisual"></a>void * QGLContext::chooseMacVisual ( GDHandle ) <tt> [virtual protected]</tt></h3>
162
<a name="//apple_ref/cpp/instm/QGLContext/chooseMacVisual" />
163
<h3 class="fn"><a name="chooseMacVisual"></a>void * QGLContext::chooseMacVisual ( GDHandle <i>handle</i> ) <tt> [virtual protected]</tt></h3>
164
<p><b>Mac OS X only:</b> This virtual function tries to find a visual that matches the format, reducing the demands if the original request cannot be met.</p>
165
<p>The algorithm for reducing the demands of the format is quite simple-minded, so override this method in your subclass if your application has spcific requirements on visual selection.</p>
166
<p>The <i>handle</i> argument is always zero and is not used</p>
167
<p>See also <a href="qglcontext.html#chooseContext">chooseContext</a>().</p>
168
<a name="//apple_ref/cpp/instm/QGLContext/choosePixelFormat" />
106
169
<h3 class="fn"><a name="choosePixelFormat"></a>int QGLContext::choosePixelFormat ( void * <i>dummyPfd</i>, HDC <i>pdc</i> ) <tt> [virtual protected]</tt></h3>
107
170
<p><b>Win32 only:</b> This virtual function chooses a pixel format that matches the OpenGL <a href="qglcontext.html#setFormat">format</a>. Reimplement this function in a subclass if you need a custom context.</p>
108
171
<p><b>Warning:</b> The <i>dummyPfd</i> pointer and <i>pdc</i> are used as a <tt>PIXELFORMATDESCRIPTOR*</tt>. We use <tt>void</tt> to avoid using Windows-specific types in our header files.</p>
109
172
<p>See also <a href="qglcontext.html#chooseContext">chooseContext</a>().</p>
173
<a name="//apple_ref/cpp/instm/QGLContext/chooseVisual" />
110
174
<h3 class="fn"><a name="chooseVisual"></a>void * QGLContext::chooseVisual () <tt> [virtual protected]</tt></h3>
111
175
<p><b>X11 only:</b> This virtual function tries to find a visual that matches the format, reducing the demands if the original request cannot be met.</p>
112
176
<p>The algorithm for reducing the demands of the format is quite simple-minded, so override this method in your subclass if your application has spcific requirements on visual selection.</p>
113
177
<p>See also <a href="qglcontext.html#chooseContext">chooseContext</a>().</p>
178
<a name="//apple_ref/cpp/instm/QGLContext/create" />
114
179
<h3 class="fn"><a name="create"></a>bool QGLContext::create ( const QGLContext * <i>shareContext</i> = 0 ) <tt> [virtual]</tt></h3>
115
180
<p>Creates the GL context. Returns true if it was successful in creating a valid GL rendering context on the paint device specified in the constructor; otherwise returns false (i.e. the context is invalid).</p>
116
181
<p>After successful creation, <a href="qglcontext.html#format">format</a>() returns the set of features of the created GL rendering context.</p>
117
182
<p>If <i>shareContext</i> points to a valid <a href="qglcontext.html">QGLContext</a>, this method will try to establish OpenGL display list and texture object sharing between this context and the <i>shareContext</i>. Note that this may fail if the two contexts have different <a href="qglcontext.html#format">formats</a>. Use <a href="qglcontext.html#isSharing">isSharing</a>() to see if sharing is in effect.</p>
118
183
<p><b>Warning:</b> Implementation note: initialization of C++ class members usually takes place in the class constructor. <a href="qglcontext.html">QGLContext</a> is an exception because it must be simple to customize. The virtual functions <a href="qglcontext.html#chooseContext">chooseContext</a>() (and <a href="qglcontext.html#chooseVisual">chooseVisual</a>() for X11) can be reimplemented in a subclass to select a particular context. The problem is that virtual functions are not properly called during construction (even though this is correct C++) because C++ constructs class hierarchies from the bottom up. For this reason we need a create() function.</p>
119
184
<p>See also <a href="qglcontext.html#chooseContext">chooseContext</a>(), <a href="qglcontext.html#format">format</a>(), and <a href="qglcontext.html#isValid">isValid</a>().</p>
185
<a name="//apple_ref/cpp/clm/QGLContext/currentContext" />
120
186
<h3 class="fn"><a name="currentContext"></a>const QGLContext * QGLContext::currentContext () <tt> [static]</tt></h3>
121
187
<p>Returns the current context, i.e. the context to which any OpenGL commands will currently be directed. Returns 0 if no context is current.</p>
122
188
<p>See also <a href="qglcontext.html#makeCurrent">makeCurrent</a>().</p>
189
<a name="//apple_ref/cpp/instm/QGLContext/deleteTexture" />
123
190
<h3 class="fn"><a name="deleteTexture"></a>void QGLContext::deleteTexture ( GLuint <i>id</i> )</h3>
124
191
<p>Removes the texture identified by <i>id</i> from the texture cache, and calls glDeleteTextures() to delete the texture from the context.</p>
125
192
<p>See also <a href="qglcontext.html#bindTexture">bindTexture</a>().</p>
193
<a name="//apple_ref/cpp/instm/QGLContext/device" />
126
194
<h3 class="fn"><a name="device"></a><a href="qpaintdevice.html">QPaintDevice</a> * QGLContext::device () const</h3>
127
195
<p>Returns the paint device set for this context.</p>
128
196
<p>See also <a href="qglcontext.html#QGLContext">QGLContext::QGLContext</a>().</p>
197
<a name="//apple_ref/cpp/instm/QGLContext/deviceIsPixmap" />
129
198
<h3 class="fn"><a name="deviceIsPixmap"></a>bool QGLContext::deviceIsPixmap () const <tt> [protected]</tt></h3>
130
199
<p>Returns true if the paint device of this context is a pixmap; otherwise returns false.</p>
200
<a name="//apple_ref/cpp/instm/QGLContext/doneCurrent" />
131
201
<h3 class="fn"><a name="doneCurrent"></a>void QGLContext::doneCurrent () <tt> [virtual]</tt></h3>
132
202
<p>Makes no GL context the current context. Normally, you do not need to call this function; <a href="qglcontext.html">QGLContext</a> calls it as necessary.</p>
203
<a name="//apple_ref/cpp/instm/QGLContext/drawTexture" />
133
204
<h3 class="fn"><a name="drawTexture"></a>void QGLContext::drawTexture ( const <a href="qrectf.html">QRectF</a> & <i>target</i>, GLuint <i>textureId</i>, GLenum <i>textureTarget</i> = GL_TEXTURE_2D )</h3>
134
205
<p>Draws the given texture, <i>textureId</i>, to the given target rectangle, <i>target</i>, in OpenGL model space. The <i>textureTarget</i> should be a 2D texture target.</p>
135
<p>Equivalent to the corresponding QGLContext::drawTexture().</p>
206
<p><b>Note:</b> This function is not supported under OpenGL/ES 2.0.</p>
136
207
<p>This function was introduced in Qt 4.4.</p>
137
208
<h3 class="fn"><a name="drawTexture-2"></a>void QGLContext::drawTexture ( const <a href="qpointf.html">QPointF</a> & <i>point</i>, GLuint <i>textureId</i>, GLenum <i>textureTarget</i> = GL_TEXTURE_2D )</h3>
138
209
<p>Draws the given texture at the given <i>point</i> in OpenGL model space. The <i>textureTarget</i> should be a 2D texture target.</p>
139
<p>Equivalent to the corresponding <a href="qglcontext.html#drawTexture">QGLContext::drawTexture</a>().</p>
210
<p><b>Note:</b> This function is not supported under OpenGL/ES.</p>
140
211
<p>This function was introduced in Qt 4.4.</p>
212
<a name="//apple_ref/cpp/instm/QGLContext/format" />
141
213
<h3 class="fn"><a name="format"></a><a href="qglformat.html">QGLFormat</a> QGLContext::format () const</h3>
142
214
<p>Returns the frame buffer format that was obtained (this may be a subset of what was requested).</p>
143
215
<p>See also <a href="qglcontext.html#setFormat">setFormat</a>() and <a href="qglcontext.html#requestedFormat">requestedFormat</a>().</p>
216
<a name="//apple_ref/cpp/instm/QGLContext/getProcAddress" />
144
217
<h3 class="fn"><a name="getProcAddress"></a>void * QGLContext::getProcAddress ( const <a href="qstring.html">QString</a> & <i>proc</i> ) const</h3>
145
218
<p>Returns a function pointer to the GL extension function passed in <i>proc</i>. 0 is returned if a pointer to the function could not be obtained.</p>
219
<a name="//apple_ref/cpp/instm/QGLContext/initialized" />
146
220
<h3 class="fn"><a name="initialized"></a>bool QGLContext::initialized () const <tt> [protected]</tt></h3>
147
221
<p>Returns true if this context has been initialized, i.e. if <a href="qglwidget.html#initializeGL">QGLWidget::initializeGL</a>() has been performed on it; otherwise returns false.</p>
148
222
<p>See also <a href="qglcontext.html#setInitialized">setInitialized</a>().</p>
223
<a name="//apple_ref/cpp/instm/QGLContext/isSharing" />
149
224
<h3 class="fn"><a name="isSharing"></a>bool QGLContext::isSharing () const</h3>
150
225
<p>Returns true if this context is sharing its GL context with another <a href="qglcontext.html">QGLContext</a>, otherwise false is returned. Note that context sharing might not be supported between contexts with different formats.</p>
226
<a name="//apple_ref/cpp/instm/QGLContext/isValid" />
151
227
<h3 class="fn"><a name="isValid"></a>bool QGLContext::isValid () const</h3>
152
228
<p>Returns true if a GL rendering context has been successfully created; otherwise returns false.</p>
229
<a name="//apple_ref/cpp/instm/QGLContext/makeCurrent" />
153
230
<h3 class="fn"><a name="makeCurrent"></a>void QGLContext::makeCurrent () <tt> [virtual]</tt></h3>
154
231
<p>Makes this context the current OpenGL rendering context. All GL functions you call operate on this context until another context is made current.</p>
155
232
<p>In some very rare cases the underlying call may fail. If this occurs an error message is output to stderr.</p>
233
<a name="//apple_ref/cpp/instm/QGLContext/overlayTransparentColor" />
156
234
<h3 class="fn"><a name="overlayTransparentColor"></a><a href="qcolor.html">QColor</a> QGLContext::overlayTransparentColor () const</h3>
157
235
<p>If this context is a valid context in an overlay plane, returns the plane's transparent color. Otherwise returns an <a href="qcolor.html#isValid">invalid</a> color.</p>
158
<p>The returned color's <a href="qcolor-qt3.html#pixel">pixel</a> value is the index of the transparent color in the colormap of the overlay plane. (Naturally, the color's RGB values are meaningless.)</p>
236
<p>The returned color's <a href="qcolor-qt3.html#pixel" class="compat">pixel</a> value is the index of the transparent color in the colormap of the overlay plane. (Naturally, the color's RGB values are meaningless.)</p>
159
237
<p>The returned <a href="qcolor.html">QColor</a> object will generally work as expected only when passed as the argument to <a href="qglwidget.html#qglColor">QGLWidget::qglColor</a>() or <a href="qglwidget.html#qglClearColor">QGLWidget::qglClearColor</a>(). Under certain circumstances it can also be used to draw transparent graphics with a <a href="qpainter.html">QPainter</a>. See the examples/opengl/overlay_x11 example for details.</p>
238
<a name="//apple_ref/cpp/instm/QGLContext/requestedFormat" />
160
239
<h3 class="fn"><a name="requestedFormat"></a><a href="qglformat.html">QGLFormat</a> QGLContext::requestedFormat () const</h3>
161
240
<p>Returns the frame buffer format that was originally requested in the constructor or <a href="qglcontext.html#setFormat">setFormat</a>().</p>
162
241
<p>See also <a href="qglcontext.html#format">format</a>().</p>
242
<a name="//apple_ref/cpp/instm/QGLContext/reset" />
163
243
<h3 class="fn"><a name="reset"></a>void QGLContext::reset ()</h3>
164
244
<p>Resets the context and makes it invalid.</p>
165
245
<p>See also <a href="qglcontext.html#create">create</a>() and <a href="qglcontext.html#isValid">isValid</a>().</p>
246
<a name="//apple_ref/cpp/instm/QGLContext/setFormat" />
166
247
<h3 class="fn"><a name="setFormat"></a>void QGLContext::setFormat ( const <a href="qglformat.html">QGLFormat</a> & <i>format</i> )</h3>
167
248
<p>Sets a <i>format</i> for this context. The context is <a href="qglcontext.html#reset">reset</a>.</p>
168
249
<p>Call <a href="qglcontext.html#create">create</a>() to create a new GL context that tries to match the new format.</p>
176
257
if (!cx->format().stereo())
177
258
exit(); <span class="comment">// could not create stereo context</span></pre>
178
259
<p>See also <a href="qglcontext.html#format">format</a>(), <a href="qglcontext.html#reset">reset</a>(), and <a href="qglcontext.html#create">create</a>().</p>
260
<a name="//apple_ref/cpp/instm/QGLContext/setInitialized" />
179
261
<h3 class="fn"><a name="setInitialized"></a>void QGLContext::setInitialized ( bool <i>on</i> ) <tt> [protected]</tt></h3>
180
262
<p>If <i>on</i> is true the context has been initialized, i.e. QGLContext::setInitialized() has been called on it. If <i>on</i> is false the context has not been initialized.</p>
181
263
<p>See also <a href="qglcontext.html#initialized">initialized</a>().</p>
264
<a name="//apple_ref/cpp/clm/QGLContext/setTextureCacheLimit" />
182
265
<h3 class="fn"><a name="setTextureCacheLimit"></a>void QGLContext::setTextureCacheLimit ( int <i>size</i> ) <tt> [static]</tt></h3>
183
266
<p>This function sets the limit for the texture cache to <i>size</i>, expressed in kilobytes.</p>
184
267
<p>By default, the cache limit is approximately 64 MB.</p>
185
268
<p>See also <a href="qglcontext.html#textureCacheLimit">textureCacheLimit</a>().</p>
269
<a name="//apple_ref/cpp/instm/QGLContext/setWindowCreated" />
186
270
<h3 class="fn"><a name="setWindowCreated"></a>void QGLContext::setWindowCreated ( bool <i>on</i> ) <tt> [protected]</tt></h3>
187
271
<p>If <i>on</i> is true the context has had a window created for it. If <i>on</i> is false no window has been created for the context.</p>
188
272
<p>See also <a href="qglcontext.html#windowCreated">windowCreated</a>().</p>
273
<a name="//apple_ref/cpp/instm/QGLContext/swapBuffers" />
189
274
<h3 class="fn"><a name="swapBuffers"></a>void QGLContext::swapBuffers () const <tt> [virtual]</tt></h3>
190
275
<p>Swaps the screen contents with an off-screen buffer. Only works if the context is in double buffer mode.</p>
191
276
<p>See also <a href="qglformat.html#setDoubleBuffer">QGLFormat::setDoubleBuffer</a>().</p>
277
<a name="//apple_ref/cpp/clm/QGLContext/textureCacheLimit" />
192
278
<h3 class="fn"><a name="textureCacheLimit"></a>int QGLContext::textureCacheLimit () <tt> [static]</tt></h3>
193
279
<p>Returns the current texture cache limit in kilobytes.</p>
194
280
<p>See also <a href="qglcontext.html#setTextureCacheLimit">setTextureCacheLimit</a>().</p>
195
<h3 class="fn"><a name="updatePaintDevice"></a>void QGLContext::updatePaintDevice ()</h3>
281
<a name="//apple_ref/cpp/instm/QGLContext/windowCreated" />
196
282
<h3 class="fn"><a name="windowCreated"></a>bool QGLContext::windowCreated () const <tt> [protected]</tt></h3>
197
283
<p>Returns true if a window has been created for this context; otherwise returns false.</p>
198
284
<p>See also <a href="qglcontext.html#setWindowCreated">setWindowCreated</a>().</p>
199
285
<p /><address><hr /><div align="center">
200
286
<table width="100%" cellspacing="0" border="0"><tr class="address">
201
<td width="30%" align="left">Copyright © 2009 Nokia Corporation and/or its subsidiary(-ies)</td>
202
<td width="40%" align="center"><a href="trademarks.html">Trademarks</a></td>
203
<td width="30%" align="right"><div align="right">Qt 4.5.2</div></td>
204
</tr></table></div></address></body>
287
<td width="40%" align="left">Copyright © 2009 Nokia Corporation and/or its subsidiary(-ies)</td>
288
<td width="20%" align="center"><a href="trademarks.html">Trademarks</a></td>
289
<td width="40%" align="right"><div align="right">Qt 4.6.0</div></td>
290
<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>
added
removed
doc/html/qglcontext.html
