source: OGRE/trunk/ogrenew/Docs/api/html/classOgre_1_1GLPBuffer.html @ 692

Revision 692, 16.1 KB checked in by mattausch, 19 years ago (diff)

adding ogre 1.2 and dependencies
Line 
1<html>
2<head>
3<title>Ogre::GLPBuffer 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::GLPBuffer Class Reference</h1>An off-screen rendering context. 
11<a href="#_details">More...</a>
12<p>
13<code>#include &lt;<a class="el" href="OgreGLPBuffer_8h-source.html">OgreGLPBuffer.h</a>&gt;</code>
14<p>
15<p>Inheritance diagram for Ogre::GLPBuffer:
16<p><center><img src="classOgre_1_1GLPBuffer.png" usemap="#Ogre::GLPBuffer_map" border="0" alt=""></center>
17<map name="Ogre::GLPBuffer_map">
18<area href="classOgre_1_1GLXPBuffer.html" alt="Ogre::GLXPBuffer" shape="rect" coords="0,56,125,80">
19<area href="classOgre_1_1Win32PBuffer.html" alt="Ogre::Win32PBuffer" shape="rect" coords="135,56,260,80">
20</map>
21<a href="classOgre_1_1GLPBuffer-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_1GLPBuffer.html#Ogre_1_1GLPBuffera0">GLPBuffer</a> (<a class="el" href="namespaceOgre.html#a673">PixelComponentType</a> format, size_t width, size_t height)</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_1GLPBuffer.html#Ogre_1_1GLPBuffera1">~GLPBuffer</a> ()</td></tr>
27
28<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="classOgre_1_1GLContext.html">GLContext</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1GLPBuffer.html#Ogre_1_1GLPBuffera2">getContext</a> ()=0</td></tr>
29
30<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the GL context that needs to be active to render to this PBuffer.  <a href="#Ogre_1_1GLPBuffera2"></a><br><br></td></tr>
31<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a673">PixelComponentType</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1GLPBuffer.html#Ogre_1_1Win32PBuffera3">getFormat</a> ()</td></tr>
32
33<tr><td class="memItemLeft" nowrap align=right valign=top>size_t&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1GLPBuffer.html#Ogre_1_1Win32PBuffera4">getWidth</a> ()</td></tr>
34
35<tr><td class="memItemLeft" nowrap align=right valign=top>size_t&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1GLPBuffer.html#Ogre_1_1Win32PBuffera5">getHeight</a> ()</td></tr>
36
37<tr><td colspan=2><br><h2>Static Public Member Functions</h2></td></tr>
38<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a673">PixelComponentType</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1GLPBuffer.html#Ogre_1_1Win32PBuffere0">getPixelComponentType</a> (<a class="el" href="namespaceOgre.html#a671">PixelFormat</a> fmt)</td></tr>
39
40<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get PBuffer component format for an OGRE pixel format.  <a href="#Ogre_1_1Win32PBuffere0"></a><br><br></td></tr>
41<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
42<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a673">PixelComponentType</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1GLPBuffer.html#Ogre_1_1Win32PBufferp4">mFormat</a></td></tr>
43
44<tr><td class="memItemLeft" nowrap align=right valign=top>size_t&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1GLPBuffer.html#Ogre_1_1Win32PBufferp5">mWidth</a></td></tr>
45
46<tr><td class="memItemLeft" nowrap align=right valign=top>size_t&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1GLPBuffer.html#Ogre_1_1Win32PBufferp6">mHeight</a></td></tr>
47
48</table>
49<hr><a name="_details"></a><h2>Detailed Description</h2>
50An off-screen rendering context.
51<p>
52These contexts are always RGBA for simplicity, speed and convience, but the component format is configurable.
53<p>
54
55<p>
56Definition at line <a class="el" href="OgreGLPBuffer_8h-source.html#l00035">35</a> of file <a class="el" href="OgreGLPBuffer_8h-source.html">OgreGLPBuffer.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
57<a class="anchor" name="Ogre_1_1GLPBuffera0" doxytag="Ogre::GLPBuffer::GLPBuffer" ></a><p>
58<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
59  <tr>
60    <td class="mdRow">
61      <table cellpadding="0" cellspacing="0" border="0">
62        <tr>
63          <td class="md" nowrap valign="top"> Ogre::GLPBuffer::GLPBuffer </td>
64          <td class="md" valign="top">(&nbsp;</td>
65          <td class="md" nowrap valign="top"><a class="el" href="namespaceOgre.html#a673">PixelComponentType</a>&nbsp;</td>
66          <td class="mdname" nowrap> <em>format</em>, </td>
67        </tr>
68        <tr>
69          <td class="md" nowrap align="right"></td>
70          <td></td>
71          <td class="md" nowrap>size_t&nbsp;</td>
72          <td class="mdname" nowrap> <em>width</em>, </td>
73        </tr>
74        <tr>
75          <td class="md" nowrap align="right"></td>
76          <td></td>
77          <td class="md" nowrap>size_t&nbsp;</td>
78          <td class="mdname" nowrap> <em>height</em></td>
79        </tr>
80        <tr>
81          <td></td>
82          <td class="md">)&nbsp;</td>
83          <td class="md" colspan="2"></td>
84        </tr>
85
86      </table>
87    </td>
88  </tr>
89</table>
90<table cellspacing=5 cellpadding=0 border=0>
91  <tr>
92    <td>
93      &nbsp;
94    </td>
95    <td>
96
97<p>
98    </td>
99  </tr>
100</table>
101<a class="anchor" name="Ogre_1_1GLPBuffera1" doxytag="Ogre::GLPBuffer::~GLPBuffer" ></a><p>
102<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
103  <tr>
104    <td class="mdRow">
105      <table cellpadding="0" cellspacing="0" border="0">
106        <tr>
107          <td class="md" nowrap valign="top"> virtual Ogre::GLPBuffer::~<a class="el" href="classOgre_1_1GLPBuffer.html">GLPBuffer</a> </td>
108          <td class="md" valign="top">(&nbsp;</td>
109          <td class="mdname1" valign="top" nowrap>          </td>
110          <td class="md" valign="top">&nbsp;)&nbsp;</td>
111          <td class="md" nowrap><code> [virtual]</code></td>
112        </tr>
113
114      </table>
115    </td>
116  </tr>
117</table>
118<table cellspacing=5 cellpadding=0 border=0>
119  <tr>
120    <td>
121      &nbsp;
122    </td>
123    <td>
124
125<p>
126    </td>
127  </tr>
128</table>
129<hr><h2>Member Function Documentation</h2>
130<a class="anchor" name="Ogre_1_1GLPBuffera2" doxytag="Ogre::GLPBuffer::getContext" ></a><p>
131<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
132  <tr>
133    <td class="mdRow">
134      <table cellpadding="0" cellspacing="0" border="0">
135        <tr>
136          <td class="md" nowrap valign="top"> virtual <a class="el" href="classOgre_1_1GLContext.html">GLContext</a>* Ogre::GLPBuffer::getContext </td>
137          <td class="md" valign="top">(&nbsp;</td>
138          <td class="mdname1" valign="top" nowrap>          </td>
139          <td class="md" valign="top">&nbsp;)&nbsp;</td>
140          <td class="md" nowrap><code> [pure virtual]</code></td>
141        </tr>
142
143      </table>
144    </td>
145  </tr>
146</table>
147<table cellspacing=5 cellpadding=0 border=0>
148  <tr>
149    <td>
150      &nbsp;
151    </td>
152    <td>
153
154<p>
155Get the GL context that needs to be active to render to this PBuffer.
156<p>
157
158<p>
159Implemented in <a class="el" href="classOgre_1_1GLXPBuffer.html#Ogre_1_1GLXPBuffera2">Ogre::GLXPBuffer</a>, and <a class="el" href="classOgre_1_1Win32PBuffer.html#Ogre_1_1Win32PBuffera2">Ogre::Win32PBuffer</a>.    </td>
160  </tr>
161</table>
162<a class="anchor" name="Ogre_1_1Win32PBuffera3" doxytag="Ogre::GLPBuffer::getFormat" ></a><p>
163<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
164  <tr>
165    <td class="mdRow">
166      <table cellpadding="0" cellspacing="0" border="0">
167        <tr>
168          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a673">PixelComponentType</a> Ogre::GLPBuffer::getFormat </td>
169          <td class="md" valign="top">(&nbsp;</td>
170          <td class="mdname1" valign="top" nowrap>          </td>
171          <td class="md" valign="top">&nbsp;)&nbsp;</td>
172          <td class="md" nowrap></td>
173        </tr>
174
175      </table>
176    </td>
177  </tr>
178</table>
179<table cellspacing=5 cellpadding=0 border=0>
180  <tr>
181    <td>
182      &nbsp;
183    </td>
184    <td>
185
186<p>
187
188<p>
189Definition at line <a class="el" href="OgreGLPBuffer_8h-source.html#l00045">45</a> of file <a class="el" href="OgreGLPBuffer_8h-source.html">OgreGLPBuffer.h</a>.
190<p>
191References <a class="el" href="OgrePixelFormat_8h-source.html#l00153">Ogre::PixelComponentType</a>.    </td>
192  </tr>
193</table>
194<a class="anchor" name="Ogre_1_1Win32PBuffera5" doxytag="Ogre::GLPBuffer::getHeight" ></a><p>
195<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
196  <tr>
197    <td class="mdRow">
198      <table cellpadding="0" cellspacing="0" border="0">
199        <tr>
200          <td class="md" nowrap valign="top"> size_t Ogre::GLPBuffer::getHeight </td>
201          <td class="md" valign="top">(&nbsp;</td>
202          <td class="md" nowrap valign="top">void&nbsp;</td>
203          <td class="mdname1" valign="top" nowrap>          </td>
204          <td class="md" valign="top">&nbsp;)&nbsp;</td>
205          <td class="md" nowrap></td>
206        </tr>
207
208      </table>
209    </td>
210  </tr>
211</table>
212<table cellspacing=5 cellpadding=0 border=0>
213  <tr>
214    <td>
215      &nbsp;
216    </td>
217    <td>
218
219<p>
220
221<p>
222Definition at line <a class="el" href="OgreGLPBuffer_8h-source.html#l00047">47</a> of file <a class="el" href="OgreGLPBuffer_8h-source.html">OgreGLPBuffer.h</a>.    </td>
223  </tr>
224</table>
225<a class="anchor" name="Ogre_1_1Win32PBuffere0" doxytag="Ogre::GLPBuffer::getPixelComponentType" ></a><p>
226<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
227  <tr>
228    <td class="mdRow">
229      <table cellpadding="0" cellspacing="0" border="0">
230        <tr>
231          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a673">PixelComponentType</a> Ogre::GLPBuffer::getPixelComponentType </td>
232          <td class="md" valign="top">(&nbsp;</td>
233          <td class="md" nowrap valign="top"><a class="el" href="namespaceOgre.html#a671">PixelFormat</a>&nbsp;</td>
234          <td class="mdname1" valign="top" nowrap> <em>fmt</em>          </td>
235          <td class="md" valign="top">&nbsp;)&nbsp;</td>
236          <td class="md" nowrap><code> [static]</code></td>
237        </tr>
238
239      </table>
240    </td>
241  </tr>
242</table>
243<table cellspacing=5 cellpadding=0 border=0>
244  <tr>
245    <td>
246      &nbsp;
247    </td>
248    <td>
249
250<p>
251Get PBuffer component format for an OGRE pixel format.
252<p>
253    </td>
254  </tr>
255</table>
256<a class="anchor" name="Ogre_1_1Win32PBuffera4" doxytag="Ogre::GLPBuffer::getWidth" ></a><p>
257<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
258  <tr>
259    <td class="mdRow">
260      <table cellpadding="0" cellspacing="0" border="0">
261        <tr>
262          <td class="md" nowrap valign="top"> size_t Ogre::GLPBuffer::getWidth </td>
263          <td class="md" valign="top">(&nbsp;</td>
264          <td class="md" nowrap valign="top">void&nbsp;</td>
265          <td class="mdname1" valign="top" nowrap>          </td>
266          <td class="md" valign="top">&nbsp;)&nbsp;</td>
267          <td class="md" nowrap></td>
268        </tr>
269
270      </table>
271    </td>
272  </tr>
273</table>
274<table cellspacing=5 cellpadding=0 border=0>
275  <tr>
276    <td>
277      &nbsp;
278    </td>
279    <td>
280
281<p>
282
283<p>
284Definition at line <a class="el" href="OgreGLPBuffer_8h-source.html#l00046">46</a> of file <a class="el" href="OgreGLPBuffer_8h-source.html">OgreGLPBuffer.h</a>.    </td>
285  </tr>
286</table>
287<hr><h2>Member Data Documentation</h2>
288<a class="anchor" name="Ogre_1_1Win32PBufferp4" doxytag="Ogre::GLPBuffer::mFormat" ></a><p>
289<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
290  <tr>
291    <td class="mdRow">
292      <table cellpadding="0" cellspacing="0" border="0">
293        <tr>
294          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a673">PixelComponentType</a> <a class="el" href="classOgre_1_1GLPBuffer.html#Ogre_1_1Win32PBufferp4">Ogre::GLPBuffer::mFormat</a><code> [protected]</code>
295      </table>
296    </td>
297  </tr>
298</table>
299<table cellspacing=5 cellpadding=0 border=0>
300  <tr>
301    <td>
302      &nbsp;
303    </td>
304    <td>
305
306<p>
307
308<p>
309Definition at line <a class="el" href="OgreGLPBuffer_8h-source.html#l00053">53</a> of file <a class="el" href="OgreGLPBuffer_8h-source.html">OgreGLPBuffer.h</a>.    </td>
310  </tr>
311</table>
312<a class="anchor" name="Ogre_1_1Win32PBufferp6" doxytag="Ogre::GLPBuffer::mHeight" ></a><p>
313<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
314  <tr>
315    <td class="mdRow">
316      <table cellpadding="0" cellspacing="0" border="0">
317        <tr>
318          <td class="md" nowrap valign="top"> size_t <a class="el" href="classOgre_1_1GLPBuffer.html#Ogre_1_1Win32PBufferp6">Ogre::GLPBuffer::mHeight</a><code> [protected]</code>
319      </table>
320    </td>
321  </tr>
322</table>
323<table cellspacing=5 cellpadding=0 border=0>
324  <tr>
325    <td>
326      &nbsp;
327    </td>
328    <td>
329
330<p>
331
332<p>
333Definition at line <a class="el" href="OgreGLPBuffer_8h-source.html#l00054">54</a> of file <a class="el" href="OgreGLPBuffer_8h-source.html">OgreGLPBuffer.h</a>.    </td>
334  </tr>
335</table>
336<a class="anchor" name="Ogre_1_1Win32PBufferp5" doxytag="Ogre::GLPBuffer::mWidth" ></a><p>
337<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
338  <tr>
339    <td class="mdRow">
340      <table cellpadding="0" cellspacing="0" border="0">
341        <tr>
342          <td class="md" nowrap valign="top"> size_t <a class="el" href="classOgre_1_1GLPBuffer.html#Ogre_1_1Win32PBufferp5">Ogre::GLPBuffer::mWidth</a><code> [protected]</code>
343      </table>
344    </td>
345  </tr>
346</table>
347<table cellspacing=5 cellpadding=0 border=0>
348  <tr>
349    <td>
350      &nbsp;
351    </td>
352    <td>
353
354<p>
355
356<p>
357Definition at line <a class="el" href="OgreGLPBuffer_8h-source.html#l00054">54</a> of file <a class="el" href="OgreGLPBuffer_8h-source.html">OgreGLPBuffer.h</a>.    </td>
358  </tr>
359</table>
360<hr>The documentation for this class was generated from the following file:<ul>
361<li><a class="el" href="OgreGLPBuffer_8h-source.html">OgreGLPBuffer.h</a></ul>
362<hr>
363<p>
364Copyright &copy; 2000-2005 by The OGRE Team<br />
365<!--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/>
366This 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/>
367                <!--/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#">
368                <Work rdf:about="">
369                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
370        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
371                </Work>
372                <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> -->
373
374Last modified Sun Mar 12 14:53:04 2006
375</p>
376</body>
377</html>
Note: See TracBrowser for help on using the repository browser.