source: OGRE/trunk/ogrenew/Docs/api/html/classOgre_1_1GLContext.html @ 657

Revision 657, 11.9 KB checked in by mattausch, 18 years ago (diff)

added ogre dependencies and patched ogre sources
Line 
1<html>
2<head>
3<title>Ogre::GLContext class Reference - OGRE Documentation</title> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
4<link type="text/css" rel="stylesheet" href="style.css">
5</head>
6
7<body>
8<!-- Generated by Doxygen 1.3.6 -->
9<div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="namespacemembers.html">Namespace&nbsp;Members</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a> | <a class="qindex" href="pages.html">Related&nbsp;Pages</a></div>
10<h1>Ogre::GLContext Class Reference</h1>Class that encapsulates an GL context. 
11<a href="#_details">More...</a>
12<p>
13<code>#include &lt;<a class="el" href="OgreGLContext_8h-source.html">OgreGLContext.h</a>&gt;</code>
14<p>
15<p>Inheritance diagram for Ogre::GLContext:
16<p><center><img src="classOgre_1_1GLContext.png" usemap="#Ogre::GLContext_map" border="0" alt=""></center>
17<map name="Ogre::GLContext_map">
18<area href="classOgre_1_1GLXContext.html" alt="Ogre::GLXContext" shape="rect" coords="0,56,124,80">
19<area href="classOgre_1_1Win32Context.html" alt="Ogre::Win32Context" shape="rect" coords="134,56,258,80">
20</map>
21<a href="classOgre_1_1GLContext-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
22<tr><td></td></tr>
23<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
24<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1GLContext.html#Ogre_1_1GLContexta0">GLContext</a> ()</td></tr>
25
26<tr><td class="memItemLeft" nowrap align=right valign=top>virtual&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1GLContext.html#Ogre_1_1GLContexta1">~GLContext</a> ()</td></tr>
27
28<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1GLContext.html#Ogre_1_1GLContexta2">setCurrent</a> ()=0</td></tr>
29
30<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Enable the context.  <a href="#Ogre_1_1GLContexta2"></a><br><br></td></tr>
31<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1GLContext.html#Ogre_1_1Win32Contexta3">endCurrent</a> ()</td></tr>
32
33<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This is called before another context is made current.  <a href="#Ogre_1_1Win32Contexta3"></a><br><br></td></tr>
34<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1GLContext.html#Ogre_1_1Win32Contexta4">getInitialized</a> ()</td></tr>
35
36<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1GLContext.html#Ogre_1_1Win32Contexta5">setInitialized</a> ()</td></tr>
37
38<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
39<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1GLContext.html#Ogre_1_1Win32Contextp0">initialized</a></td></tr>
40
41</table>
42<hr><a name="_details"></a><h2>Detailed Description</h2>
43Class that encapsulates an GL context.
44<p>
45(IE a window/pbuffer). This is a virtual base class which should be implemented in a <a class="el" href="classOgre_1_1GLSupport.html">GLSupport</a>. This object can also be used to cache renderstate if we decide to do so in the future.
46<p>
47
48<p>
49Definition at line <a class="el" href="OgreGLContext_8h-source.html#l00038">38</a> of file <a class="el" href="OgreGLContext_8h-source.html">OgreGLContext.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
50<a class="anchor" name="Ogre_1_1GLContexta0" doxytag="Ogre::GLContext::GLContext" ></a><p>
51<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
52  <tr>
53    <td class="mdRow">
54      <table cellpadding="0" cellspacing="0" border="0">
55        <tr>
56          <td class="md" nowrap valign="top"> Ogre::GLContext::GLContext </td>
57          <td class="md" valign="top">(&nbsp;</td>
58          <td class="mdname1" valign="top" nowrap>          </td>
59          <td class="md" valign="top">&nbsp;)&nbsp;</td>
60          <td class="md" nowrap></td>
61        </tr>
62
63      </table>
64    </td>
65  </tr>
66</table>
67<table cellspacing=5 cellpadding=0 border=0>
68  <tr>
69    <td>
70      &nbsp;
71    </td>
72    <td>
73
74<p>
75    </td>
76  </tr>
77</table>
78<a class="anchor" name="Ogre_1_1GLContexta1" doxytag="Ogre::GLContext::~GLContext" ></a><p>
79<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
80  <tr>
81    <td class="mdRow">
82      <table cellpadding="0" cellspacing="0" border="0">
83        <tr>
84          <td class="md" nowrap valign="top"> virtual Ogre::GLContext::~<a class="el" href="classOgre_1_1GLContext.html">GLContext</a> </td>
85          <td class="md" valign="top">(&nbsp;</td>
86          <td class="mdname1" valign="top" nowrap>          </td>
87          <td class="md" valign="top">&nbsp;)&nbsp;</td>
88          <td class="md" nowrap><code> [virtual]</code></td>
89        </tr>
90
91      </table>
92    </td>
93  </tr>
94</table>
95<table cellspacing=5 cellpadding=0 border=0>
96  <tr>
97    <td>
98      &nbsp;
99    </td>
100    <td>
101
102<p>
103    </td>
104  </tr>
105</table>
106<hr><h2>Member Function Documentation</h2>
107<a class="anchor" name="Ogre_1_1Win32Contexta3" doxytag="Ogre::GLContext::endCurrent" ></a><p>
108<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
109  <tr>
110    <td class="mdRow">
111      <table cellpadding="0" cellspacing="0" border="0">
112        <tr>
113          <td class="md" nowrap valign="top"> virtual void Ogre::GLContext::endCurrent </td>
114          <td class="md" valign="top">(&nbsp;</td>
115          <td class="mdname1" valign="top" nowrap>          </td>
116          <td class="md" valign="top">&nbsp;)&nbsp;</td>
117          <td class="md" nowrap><code> [virtual]</code></td>
118        </tr>
119
120      </table>
121    </td>
122  </tr>
123</table>
124<table cellspacing=5 cellpadding=0 border=0>
125  <tr>
126    <td>
127      &nbsp;
128    </td>
129    <td>
130
131<p>
132This is called before another context is made current.
133<p>
134By default, nothing is done here.     </td>
135  </tr>
136</table>
137<a class="anchor" name="Ogre_1_1Win32Contexta4" doxytag="Ogre::GLContext::getInitialized" ></a><p>
138<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
139  <tr>
140    <td class="mdRow">
141      <table cellpadding="0" cellspacing="0" border="0">
142        <tr>
143          <td class="md" nowrap valign="top"> bool Ogre::GLContext::getInitialized </td>
144          <td class="md" valign="top">(&nbsp;</td>
145          <td class="mdname1" valign="top" nowrap>          </td>
146          <td class="md" valign="top">&nbsp;)&nbsp;</td>
147          <td class="md" nowrap></td>
148        </tr>
149
150      </table>
151    </td>
152  </tr>
153</table>
154<table cellspacing=5 cellpadding=0 border=0>
155  <tr>
156    <td>
157      &nbsp;
158    </td>
159    <td>
160
161<p>
162
163<p>
164Definition at line <a class="el" href="OgreGLContext_8h-source.html#l00054">54</a> of file <a class="el" href="OgreGLContext_8h-source.html">OgreGLContext.h</a>.
165<p>
166References <a class="el" href="OgreGLContext_8h-source.html#l00057">initialized</a>.    </td>
167  </tr>
168</table>
169<a class="anchor" name="Ogre_1_1GLContexta2" doxytag="Ogre::GLContext::setCurrent" ></a><p>
170<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
171  <tr>
172    <td class="mdRow">
173      <table cellpadding="0" cellspacing="0" border="0">
174        <tr>
175          <td class="md" nowrap valign="top"> virtual void Ogre::GLContext::setCurrent </td>
176          <td class="md" valign="top">(&nbsp;</td>
177          <td class="mdname1" valign="top" nowrap>          </td>
178          <td class="md" valign="top">&nbsp;)&nbsp;</td>
179          <td class="md" nowrap><code> [pure virtual]</code></td>
180        </tr>
181
182      </table>
183    </td>
184  </tr>
185</table>
186<table cellspacing=5 cellpadding=0 border=0>
187  <tr>
188    <td>
189      &nbsp;
190    </td>
191    <td>
192
193<p>
194Enable the context.
195<p>
196All subsequent rendering commands will go here.
197<p>
198Implemented in <a class="el" href="classOgre_1_1GLXContext.html#Ogre_1_1GLXContexta2">Ogre::GLXContext</a>, and <a class="el" href="classOgre_1_1Win32Context.html#Ogre_1_1Win32Contexta2">Ogre::Win32Context</a>.    </td>
199  </tr>
200</table>
201<a class="anchor" name="Ogre_1_1Win32Contexta5" doxytag="Ogre::GLContext::setInitialized" ></a><p>
202<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
203  <tr>
204    <td class="mdRow">
205      <table cellpadding="0" cellspacing="0" border="0">
206        <tr>
207          <td class="md" nowrap valign="top"> void Ogre::GLContext::setInitialized </td>
208          <td class="md" valign="top">(&nbsp;</td>
209          <td class="mdname1" valign="top" nowrap>          </td>
210          <td class="md" valign="top">&nbsp;)&nbsp;</td>
211          <td class="md" nowrap></td>
212        </tr>
213
214      </table>
215    </td>
216  </tr>
217</table>
218<table cellspacing=5 cellpadding=0 border=0>
219  <tr>
220    <td>
221      &nbsp;
222    </td>
223    <td>
224
225<p>
226
227<p>
228Definition at line <a class="el" href="OgreGLContext_8h-source.html#l00055">55</a> of file <a class="el" href="OgreGLContext_8h-source.html">OgreGLContext.h</a>.
229<p>
230References <a class="el" href="OgreGLContext_8h-source.html#l00057">initialized</a>.    </td>
231  </tr>
232</table>
233<hr><h2>Member Data Documentation</h2>
234<a class="anchor" name="Ogre_1_1Win32Contextp0" doxytag="Ogre::GLContext::initialized" ></a><p>
235<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
236  <tr>
237    <td class="mdRow">
238      <table cellpadding="0" cellspacing="0" border="0">
239        <tr>
240          <td class="md" nowrap valign="top"> bool <a class="el" href="classOgre_1_1GLContext.html#Ogre_1_1Win32Contextp0">Ogre::GLContext::initialized</a><code> [protected]</code>
241      </table>
242    </td>
243  </tr>
244</table>
245<table cellspacing=5 cellpadding=0 border=0>
246  <tr>
247    <td>
248      &nbsp;
249    </td>
250    <td>
251
252<p>
253
254<p>
255Definition at line <a class="el" href="OgreGLContext_8h-source.html#l00057">57</a> of file <a class="el" href="OgreGLContext_8h-source.html">OgreGLContext.h</a>.
256<p>
257Referenced by <a class="el" href="OgreGLContext_8h-source.html#l00054">getInitialized()</a>, and <a class="el" href="OgreGLContext_8h-source.html#l00055">setInitialized()</a>.    </td>
258  </tr>
259</table>
260<hr>The documentation for this class was generated from the following file:<ul>
261<li><a class="el" href="OgreGLContext_8h-source.html">OgreGLContext.h</a></ul>
262<hr>
263<p>
264Copyright &copy; 2000-2005 by The OGRE Team<br />
265<!--Creative Commons License--><a rel="license" href="http://creativecommons.org/licenses/by-sa/2.5/"><img alt="Creative Commons License" border="0" src="http://creativecommons.org/images/public/somerights20.png"/></a><br/>
266This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-sa/2.5/">Creative Commons Attribution-ShareAlike 2.5 License</a>.<br/>
267                <!--/Creative Commons License--><!-- <rdf:RDF xmlns="http://web.resource.org/cc/" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#">
268                <Work rdf:about="">
269                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
270        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
271                </Work>
272                <License rdf:about="http://creativecommons.org/licenses/by-sa/2.5/"><permits rdf:resource="http://web.resource.org/cc/Reproduction"/><permits rdf:resource="http://web.resource.org/cc/Distribution"/><requires rdf:resource="http://web.resource.org/cc/Notice"/><requires rdf:resource="http://web.resource.org/cc/Attribution"/><permits rdf:resource="http://web.resource.org/cc/DerivativeWorks"/><requires rdf:resource="http://web.resource.org/cc/ShareAlike"/></License></rdf:RDF> -->
273
274Last modified Sun Feb 12 13:09:44 2006
275</p>
276</body>
277</html>
Note: See TracBrowser for help on using the repository browser.