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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Crazy Eddies GUI System: CEGUI::RenderingSurface Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.4 -->
<script type="text/javascript">
function hasClass(ele,cls) {
return ele.className.match(new RegExp('(\\s|^)'+cls+'(\\s|$)'));
}
function addClass(ele,cls) {
if (!this.hasClass(ele,cls)) ele.className += " "+cls;
}
function removeClass(ele,cls) {
if (hasClass(ele,cls)) {
var reg = new RegExp('(\\s|^)'+cls+'(\\s|$)');
ele.className=ele.className.replace(reg,' ');
}
}
function toggleVisibility(linkObj) {
var base = linkObj.getAttribute('id');
var summary = document.getElementById(base + '-summary');
var content = document.getElementById(base + '-content');
var trigger = document.getElementById(base + '-trigger');
if ( hasClass(linkObj,'closed') ) {
summary.style.display = 'none';
content.style.display = 'block';
trigger.src = 'open.png';
removeClass(linkObj,'closed');
addClass(linkObj,'opened');
} else if ( hasClass(linkObj,'opened') ) {
summary.style.display = 'block';
content.style.display = 'none';
trigger.src = 'closed.png';
removeClass(linkObj,'opened');
addClass(linkObj,'closed');
}
return false;
}
</script>
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Crazy Eddies GUI System <span id="projectnumber">0.7.6</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceCEGUI.html">CEGUI</a> </li>
<li class="navelem"><a class="el" href="classCEGUI_1_1RenderingSurface.html">RenderingSurface</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-attribs">Static Public Attributes</a> |
<a href="#pro-types">Protected Types</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> </div>
<div class="headertitle">
<div class="title">CEGUI::RenderingSurface Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="CEGUI::RenderingSurface" --><!-- doxytag: inherits="CEGUI::EventSet" -->
<p>Class that represents a surface that can have geometry based imagery drawn to it.
<a href="classCEGUI_1_1RenderingSurface.html#details">More...</a></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png"/> Inheritance diagram for CEGUI::RenderingSurface:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classCEGUI_1_1RenderingSurface__inherit__graph.gif" border="0" usemap="#CEGUI_1_1RenderingSurface_inherit__map" alt="Inheritance graph"/></div>
<map name="CEGUI_1_1RenderingSurface_inherit__map" id="CEGUI_1_1RenderingSurface_inherit__map">
<area shape="rect" id="node5" href="classCEGUI_1_1RenderingRoot.html" title="CEGUI::RenderingRoot" alt="" coords="13,160,173,189"/><area shape="rect" id="node2" href="classCEGUI_1_1EventSet.html" title="Class that collects together a set of Event objects." alt="" coords="31,5,156,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div id="dynsection-1" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-1-trigger" src="closed.png"/> Collaboration diagram for CEGUI::RenderingSurface:</div>
<div id="dynsection-1-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-1-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classCEGUI_1_1RenderingSurface__coll__graph.gif" border="0" usemap="#CEGUI_1_1RenderingSurface_coll__map" alt="Collaboration graph"/></div>
<map name="CEGUI_1_1RenderingSurface_coll__map" id="CEGUI_1_1RenderingSurface_coll__map">
<area shape="rect" id="node2" href="classCEGUI_1_1EventSet.html" title="Class that collects together a set of Event objects." alt="" coords="5,5,131,35"/><area shape="rect" id="node4" href="classCEGUI_1_1RenderTarget.html" title="Defines interface to some surface that can be rendered to. Concrete instances of objects that impleme..." alt="" coords="155,5,307,35"/><area shape="rect" id="node6" href="classCEGUI_1_1String.html" title="String class used within the GUI system." alt="" coords="331,5,437,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classCEGUI_1_1RenderingSurface-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1RenderingSurface.html#a5590b660bf47408f09521a69489d55fb">RenderingSurface</a> (<a class="el" href="classCEGUI_1_1RenderTarget.html">RenderTarget</a> &target)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor for <a class="el" href="classCEGUI_1_1RenderingSurface.html" title="Class that represents a surface that can have geometry based imagery drawn to it.">RenderingSurface</a> objects. <a href="#a5590b660bf47408f09521a69489d55fb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a15b37f39179b735bf79eb33a41a28854"></a><!-- doxytag: member="CEGUI::RenderingSurface::~RenderingSurface" ref="a15b37f39179b735bf79eb33a41a28854" args="()" -->
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1RenderingSurface.html#a15b37f39179b735bf79eb33a41a28854">~RenderingSurface</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor for <a class="el" href="classCEGUI_1_1RenderingSurface.html" title="Class that represents a surface that can have geometry based imagery drawn to it.">RenderingSurface</a> objects. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1RenderingSurface.html#ab0d7a4d1ad2d8fe92347d75775615a34">addGeometryBuffer</a> (const <a class="el" href="namespaceCEGUI.html#a38d31cb120521aa412d1533891bda878">RenderQueueID</a> queue, const <a class="el" href="classCEGUI_1_1GeometryBuffer.html">GeometryBuffer</a> &buffer)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add the specified <a class="el" href="classCEGUI_1_1GeometryBuffer.html" title="Abstract class defining the interface for objects that buffer geometry for later rendering.">GeometryBuffer</a> to the specified queue for rendering when the <a class="el" href="classCEGUI_1_1RenderingSurface.html" title="Class that represents a surface that can have geometry based imagery drawn to it.">RenderingSurface</a> is drawn. <a href="#ab0d7a4d1ad2d8fe92347d75775615a34"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1RenderingSurface.html#aac4c2a1eb7384cba2bec410936a594de">removeGeometryBuffer</a> (const <a class="el" href="namespaceCEGUI.html#a38d31cb120521aa412d1533891bda878">RenderQueueID</a> queue, const <a class="el" href="classCEGUI_1_1GeometryBuffer.html">GeometryBuffer</a> &buffer)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove the specified <a class="el" href="classCEGUI_1_1GeometryBuffer.html" title="Abstract class defining the interface for objects that buffer geometry for later rendering.">GeometryBuffer</a> from the specified queue. <a href="#aac4c2a1eb7384cba2bec410936a594de"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1RenderingSurface.html#a28f3bf1fca25c88ee06c8ba75bb66e93">clearGeometry</a> (const <a class="el" href="namespaceCEGUI.html#a38d31cb120521aa412d1533891bda878">RenderQueueID</a> queue)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Clears all GeometryBuffers from the specified rendering queue. <a href="#a28f3bf1fca25c88ee06c8ba75bb66e93"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1RenderingSurface.html#ac91e88163069fd84e908ae1bd64586b6">clearGeometry</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Clears all GeometryBuffers from all rendering queues. <a href="#ac91e88163069fd84e908ae1bd64586b6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1RenderingSurface.html#ac5324bcc28a06a269f0465b99643537f">draw</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Draw the GeometryBuffers for all rendering queues to the <a class="el" href="classCEGUI_1_1RenderTarget.html" title="Defines interface to some surface that can be rendered to. Concrete instances of objects that impleme...">RenderTarget</a> that this <a class="el" href="classCEGUI_1_1RenderingSurface.html" title="Class that represents a surface that can have geometry based imagery drawn to it.">RenderingSurface</a> is targetting. <a href="#ac5324bcc28a06a269f0465b99643537f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1RenderingSurface.html#a6fd2ace1ea7f7213467edcc90d547cb7">invalidate</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Marks the <a class="el" href="classCEGUI_1_1RenderingSurface.html" title="Class that represents a surface that can have geometry based imagery drawn to it.">RenderingSurface</a> as invalid, causing the geometry to be rerendered to the <a class="el" href="classCEGUI_1_1RenderTarget.html" title="Defines interface to some surface that can be rendered to. Concrete instances of objects that impleme...">RenderTarget</a> next time draw is called. <a href="#a6fd2ace1ea7f7213467edcc90d547cb7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1RenderingSurface.html#a8d70faa337c4946f232b6feeb2996ba2">isInvalidated</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return whether this <a class="el" href="classCEGUI_1_1RenderingSurface.html" title="Class that represents a surface that can have geometry based imagery drawn to it.">RenderingSurface</a> is invalidated. <a href="#a8d70faa337c4946f232b6feeb2996ba2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1RenderingSurface.html#a56017aaebfc25ebb1ea0365cf4abed81">isRenderingWindow</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return whether this <a class="el" href="classCEGUI_1_1RenderingSurface.html" title="Class that represents a surface that can have geometry based imagery drawn to it.">RenderingSurface</a> is actually an instance of the <a class="el" href="classCEGUI_1_1RenderingWindow.html" title="RenderingWindow is a RenderingSurface that can be "drawn back" onto another RenderingSurface and is p...">RenderingWindow</a> subclass. <a href="#a56017aaebfc25ebb1ea0365cf4abed81"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classCEGUI_1_1RenderingWindow.html">RenderingWindow</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1RenderingSurface.html#a101b04377a5b450b6f514256e40547b5">createRenderingWindow</a> (<a class="el" href="classCEGUI_1_1TextureTarget.html">TextureTarget</a> &target)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create and return a reference to a child <a class="el" href="classCEGUI_1_1RenderingWindow.html" title="RenderingWindow is a RenderingSurface that can be "drawn back" onto another RenderingSurface and is p...">RenderingWindow</a> object that will render back onto this <a class="el" href="classCEGUI_1_1RenderingSurface.html" title="Class that represents a surface that can have geometry based imagery drawn to it.">RenderingSurface</a> when it's draw member function is called. <a href="#a101b04377a5b450b6f514256e40547b5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1RenderingSurface.html#a17a2d2b7776e2c9086594a89e2b7ed32">destroyRenderingWindow</a> (<a class="el" href="classCEGUI_1_1RenderingWindow.html">RenderingWindow</a> &window)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroy a <a class="el" href="classCEGUI_1_1RenderingWindow.html" title="RenderingWindow is a RenderingSurface that can be "drawn back" onto another RenderingSurface and is p...">RenderingWindow</a> we own. If we are not the present owner of the given <a class="el" href="classCEGUI_1_1RenderingWindow.html" title="RenderingWindow is a RenderingSurface that can be "drawn back" onto another RenderingSurface and is p...">RenderingWindow</a>, nothing happens. <a href="#a17a2d2b7776e2c9086594a89e2b7ed32"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1RenderingSurface.html#a6541e6e27178ab80400d9a8943dc7fd8">transferRenderingWindow</a> (<a class="el" href="classCEGUI_1_1RenderingWindow.html">RenderingWindow</a> &window)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">transfer ownership of the <a class="el" href="classCEGUI_1_1RenderingWindow.html" title="RenderingWindow is a RenderingSurface that can be "drawn back" onto another RenderingSurface and is p...">RenderingWindow</a> to this <a class="el" href="classCEGUI_1_1RenderingSurface.html" title="Class that represents a surface that can have geometry based imagery drawn to it.">RenderingSurface</a>. <a href="#a6541e6e27178ab80400d9a8943dc7fd8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classCEGUI_1_1RenderTarget.html">RenderTarget</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1RenderingSurface.html#a2c09efa138621edd331f345fcd872343">getRenderTarget</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the <a class="el" href="classCEGUI_1_1RenderTarget.html" title="Defines interface to some surface that can be rendered to. Concrete instances of objects that impleme...">RenderTarget</a> object that this <a class="el" href="classCEGUI_1_1RenderingSurface.html" title="Class that represents a surface that can have geometry based imagery drawn to it.">RenderingSurface</a> is drawing to. <a href="#a2c09efa138621edd331f345fcd872343"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a36138e91d1384514dbc76d8c22453a4e"></a><!-- doxytag: member="CEGUI::RenderingSurface::getRenderTarget" ref="a36138e91d1384514dbc76d8c22453a4e" args="()" -->
<a class="el" href="classCEGUI_1_1RenderTarget.html">RenderTarget</a> & </td><td class="memItemRight" valign="bottom"><b>getRenderTarget</b> ()</td></tr>
<tr><td colspan="2"><h2><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0e3e58eeb37b9722f52d6c8d3772ac15"></a><!-- doxytag: member="CEGUI::RenderingSurface::EventNamespace" ref="a0e3e58eeb37b9722f52d6c8d3772ac15" args="" -->
static const <a class="el" href="classCEGUI_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1RenderingSurface.html#a0e3e58eeb37b9722f52d6c8d3772ac15">EventNamespace</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Namespace for global events from <a class="el" href="classCEGUI_1_1RenderingSurface.html" title="Class that represents a surface that can have geometry based imagery drawn to it.">RenderingSurface</a> objects. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="classCEGUI_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1RenderingSurface.html#ac466162a8996d414db1c6bdcb1e704ff">EventRenderQueueStarted</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="classCEGUI_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1RenderingSurface.html#af5e0d1b7598237237bef6d94f2cb80f4">EventRenderQueueEnded</a></td></tr>
<tr><td colspan="2"><h2><a name="pro-types"></a>
Protected Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acbcf8648c1fb05a650231e5de165b82f"></a><!-- doxytag: member="CEGUI::RenderingSurface::RenderQueueList" ref="acbcf8648c1fb05a650231e5de165b82f" args="" -->
typedef std::map<br class="typebreak"/>
< <a class="el" href="namespaceCEGUI.html#a38d31cb120521aa412d1533891bda878">RenderQueueID</a>, <a class="el" href="classCEGUI_1_1RenderQueue.html">RenderQueue</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1RenderingSurface.html#acbcf8648c1fb05a650231e5de165b82f">RenderQueueList</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">collection type for the queues <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3df9f85a9c885582393e249c08148380"></a><!-- doxytag: member="CEGUI::RenderingSurface::RenderingWindowList" ref="a3df9f85a9c885582393e249c08148380" args="" -->
typedef std::vector<br class="typebreak"/>
< <a class="el" href="classCEGUI_1_1RenderingWindow.html">RenderingWindow</a> * > </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1RenderingSurface.html#a3df9f85a9c885582393e249c08148380">RenderingWindowList</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">collection type for created <a class="el" href="classCEGUI_1_1RenderingWindow.html" title="RenderingWindow is a RenderingSurface that can be "drawn back" onto another RenderingSurface and is p...">RenderingWindow</a> objects <br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4a54ff25efc1faab33918094eb5cd5a3"></a><!-- doxytag: member="CEGUI::RenderingSurface::draw" ref="a4a54ff25efc1faab33918094eb5cd5a3" args="(const RenderQueue &queue, RenderQueueEventArgs &args)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1RenderingSurface.html#a4a54ff25efc1faab33918094eb5cd5a3">draw</a> (const <a class="el" href="classCEGUI_1_1RenderQueue.html">RenderQueue</a> &queue, <a class="el" href="classCEGUI_1_1RenderQueueEventArgs.html">RenderQueueEventArgs</a> &args)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">draw a rendering queue, firing events before and after. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a76df46917787b0d4ea3d9054fd71b485"></a><!-- doxytag: member="CEGUI::RenderingSurface::detatchWindow" ref="a76df46917787b0d4ea3d9054fd71b485" args="(RenderingWindow &w)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1RenderingSurface.html#a76df46917787b0d4ea3d9054fd71b485">detatchWindow</a> (<a class="el" href="classCEGUI_1_1RenderingWindow.html">RenderingWindow</a> &w)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">detatch ReneringWindow from this <a class="el" href="classCEGUI_1_1RenderingSurface.html" title="Class that represents a surface that can have geometry based imagery drawn to it.">RenderingSurface</a> <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8c22e30be19c0900f45422ec94429e94"></a><!-- doxytag: member="CEGUI::RenderingSurface::attachWindow" ref="a8c22e30be19c0900f45422ec94429e94" args="(RenderingWindow &w)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1RenderingSurface.html#a8c22e30be19c0900f45422ec94429e94">attachWindow</a> (<a class="el" href="classCEGUI_1_1RenderingWindow.html">RenderingWindow</a> &w)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">attach ReneringWindow from this <a class="el" href="classCEGUI_1_1RenderingSurface.html" title="Class that represents a surface that can have geometry based imagery drawn to it.">RenderingSurface</a> <br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2c669f283de2b50d0152f228ae2afc9c"></a><!-- doxytag: member="CEGUI::RenderingSurface::d_queues" ref="a2c669f283de2b50d0152f228ae2afc9c" args="" -->
<a class="el" href="classCEGUI_1_1RenderingSurface.html#acbcf8648c1fb05a650231e5de165b82f">RenderQueueList</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1RenderingSurface.html#a2c669f283de2b50d0152f228ae2afc9c">d_queues</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">the collection of <a class="el" href="classCEGUI_1_1RenderQueue.html" title="Class that represents a queue of GeometryBuffer objects to be rendered.">RenderQueue</a> objects. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a733d3beadab826c36cae068d9b0fb519"></a><!-- doxytag: member="CEGUI::RenderingSurface::d_windows" ref="a733d3beadab826c36cae068d9b0fb519" args="" -->
<a class="el" href="classCEGUI_1_1RenderingSurface.html#a3df9f85a9c885582393e249c08148380">RenderingWindowList</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1RenderingSurface.html#a733d3beadab826c36cae068d9b0fb519">d_windows</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">collection of <a class="el" href="classCEGUI_1_1RenderingWindow.html" title="RenderingWindow is a RenderingSurface that can be "drawn back" onto another RenderingSurface and is p...">RenderingWindow</a> object we own <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a69d3d3132c7fa84c23e5fc2cf5911da5"></a><!-- doxytag: member="CEGUI::RenderingSurface::d_target" ref="a69d3d3132c7fa84c23e5fc2cf5911da5" args="" -->
<a class="el" href="classCEGUI_1_1RenderTarget.html">RenderTarget</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1RenderingSurface.html#a69d3d3132c7fa84c23e5fc2cf5911da5">d_target</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classCEGUI_1_1RenderTarget.html" title="Defines interface to some surface that can be rendered to. Concrete instances of objects that impleme...">RenderTarget</a> that this surface actually draws to. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac70df00e43ce79ed11c27e6344cee629"></a><!-- doxytag: member="CEGUI::RenderingSurface::d_invalidated" ref="ac70df00e43ce79ed11c27e6344cee629" args="" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1RenderingSurface.html#ac70df00e43ce79ed11c27e6344cee629">d_invalidated</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">holds invalidated state of target (as far as we are concerned) <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Class that represents a surface that can have geometry based imagery drawn to it. </p>
<p>A <a class="el" href="classCEGUI_1_1RenderingSurface.html" title="Class that represents a surface that can have geometry based imagery drawn to it.">RenderingSurface</a> has a number of queues that can be used for rendering; normal window rendering will typically be done on RQ_BASE queue, things that are overlaid everything else are rendered to RQ_OVERLAY. </p>
<dl class="user"><dt><b></b></dt><dd>The event EventRenderQueueStarted is fired before each queue is rendered and the event EventRenderQueueEnded is fired after each queue is rendered. </dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>For performance reasons, events are only fired for queues that are in use; these are queues that have had some interaction - such as clearing or adding geometry. </dd></dl>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a5590b660bf47408f09521a69489d55fb"></a><!-- doxytag: member="CEGUI::RenderingSurface::RenderingSurface" ref="a5590b660bf47408f09521a69489d55fb" args="(RenderTarget &target)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CEGUI::RenderingSurface::RenderingSurface </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCEGUI_1_1RenderTarget.html">RenderTarget</a> & </td>
<td class="paramname"><em>target</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor for <a class="el" href="classCEGUI_1_1RenderingSurface.html" title="Class that represents a surface that can have geometry based imagery drawn to it.">RenderingSurface</a> objects. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">target</td><td><a class="el" href="classCEGUI_1_1RenderTarget.html" title="Defines interface to some surface that can be rendered to. Concrete instances of objects that impleme...">RenderTarget</a> object that will receive rendered output from the <a class="el" href="classCEGUI_1_1RenderingSurface.html" title="Class that represents a surface that can have geometry based imagery drawn to it.">RenderingSurface</a> being created.</td></tr>
</table>
</dd>
</dl>
<dl class="note"><dt><b>Note:</b></dt><dd>The <a class="el" href="classCEGUI_1_1RenderingSurface.html" title="Class that represents a surface that can have geometry based imagery drawn to it.">RenderingSurface</a> does not take ownership of <em>target</em>. When the <a class="el" href="classCEGUI_1_1RenderingSurface.html" title="Class that represents a surface that can have geometry based imagery drawn to it.">RenderingSurface</a> is finally destroyed, the <a class="el" href="classCEGUI_1_1RenderTarget.html" title="Defines interface to some surface that can be rendered to. Concrete instances of objects that impleme...">RenderTarget</a> will not have been destroyed, and it should be destoyed by whover created it, if that is desired. One reason for this is that there is not an exclusive one to one mapping from <a class="el" href="classCEGUI_1_1RenderingSurface.html" title="Class that represents a surface that can have geometry based imagery drawn to it.">RenderingSurface</a> to <a class="el" href="classCEGUI_1_1RenderTarget.html" title="Defines interface to some surface that can be rendered to. Concrete instances of objects that impleme...">RenderTarget</a> objects; it's entirely feasable that multiple <a class="el" href="classCEGUI_1_1RenderingSurface.html" title="Class that represents a surface that can have geometry based imagery drawn to it.">RenderingSurface</a> objects could be targetting a shared <a class="el" href="classCEGUI_1_1RenderTarget.html" title="Defines interface to some surface that can be rendered to. Concrete instances of objects that impleme...">RenderTarget</a>). </dd></dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ab0d7a4d1ad2d8fe92347d75775615a34"></a><!-- doxytag: member="CEGUI::RenderingSurface::addGeometryBuffer" ref="ab0d7a4d1ad2d8fe92347d75775615a34" args="(const RenderQueueID queue, const GeometryBuffer &buffer)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::RenderingSurface::addGeometryBuffer </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespaceCEGUI.html#a38d31cb120521aa412d1533891bda878">RenderQueueID</a> </td>
<td class="paramname"><em>queue</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1GeometryBuffer.html">GeometryBuffer</a> & </td>
<td class="paramname"><em>buffer</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Add the specified <a class="el" href="classCEGUI_1_1GeometryBuffer.html" title="Abstract class defining the interface for objects that buffer geometry for later rendering.">GeometryBuffer</a> to the specified queue for rendering when the <a class="el" href="classCEGUI_1_1RenderingSurface.html" title="Class that represents a surface that can have geometry based imagery drawn to it.">RenderingSurface</a> is drawn. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">queue</td><td>One of the RenderQueueID enumerated values indicating which prioritised queue the <a class="el" href="classCEGUI_1_1GeometryBuffer.html" title="Abstract class defining the interface for objects that buffer geometry for later rendering.">GeometryBuffer</a> should be added to.</td></tr>
<tr><td class="paramname">buffer</td><td><a class="el" href="classCEGUI_1_1GeometryBuffer.html" title="Abstract class defining the interface for objects that buffer geometry for later rendering.">GeometryBuffer</a> object to be added to the specified rendering queue.</td></tr>
</table>
</dd>
</dl>
<dl class="note"><dt><b>Note:</b></dt><dd>The <a class="el" href="classCEGUI_1_1RenderingSurface.html" title="Class that represents a surface that can have geometry based imagery drawn to it.">RenderingSurface</a> does not take ownership of the <a class="el" href="classCEGUI_1_1GeometryBuffer.html" title="Abstract class defining the interface for objects that buffer geometry for later rendering.">GeometryBuffer</a>, and does not destroy it when the <a class="el" href="classCEGUI_1_1RenderingSurface.html" title="Class that represents a surface that can have geometry based imagery drawn to it.">RenderingSurface</a> geometry is cleared. Rather, the <a class="el" href="classCEGUI_1_1RenderingSurface.html" title="Class that represents a surface that can have geometry based imagery drawn to it.">RenderingSurface</a> is just maintaining a list of thigs to be drawn; the actual GeometryBuffers can be re-used by whichever object <em>does</em> own them, and even changed or updated while still "attached" to a <a class="el" href="classCEGUI_1_1RenderingSurface.html" title="Class that represents a surface that can have geometry based imagery drawn to it.">RenderingSurface</a>. </dd></dl>
</div>
</div>
<a class="anchor" id="ac91e88163069fd84e908ae1bd64586b6"></a><!-- doxytag: member="CEGUI::RenderingSurface::clearGeometry" ref="ac91e88163069fd84e908ae1bd64586b6" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::RenderingSurface::clearGeometry </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Clears all GeometryBuffers from all rendering queues. </p>
<dl class="note"><dt><b>Note:</b></dt><dd>Clearing the rendering queues does destory the attached GeometryBuffers, which remain under thier original ownership. </dd></dl>
</div>
</div>
<a class="anchor" id="a28f3bf1fca25c88ee06c8ba75bb66e93"></a><!-- doxytag: member="CEGUI::RenderingSurface::clearGeometry" ref="a28f3bf1fca25c88ee06c8ba75bb66e93" args="(const RenderQueueID queue)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::RenderingSurface::clearGeometry </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespaceCEGUI.html#a38d31cb120521aa412d1533891bda878">RenderQueueID</a> </td>
<td class="paramname"><em>queue</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Clears all GeometryBuffers from the specified rendering queue. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">queue</td><td>One of the RenderQueueID enumerated values indicating which prioritised queue is to to be cleared.</td></tr>
</table>
</dd>
</dl>
<dl class="note"><dt><b>Note:</b></dt><dd>Clearing a rendering queue does destory the attached GeometryBuffers, which remain under thier original ownership. </dd></dl>
</div>
</div>
<a class="anchor" id="a101b04377a5b450b6f514256e40547b5"></a><!-- doxytag: member="CEGUI::RenderingSurface::createRenderingWindow" ref="a101b04377a5b450b6f514256e40547b5" args="(TextureTarget &target)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classCEGUI_1_1RenderingWindow.html">RenderingWindow</a>& CEGUI::RenderingSurface::createRenderingWindow </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCEGUI_1_1TextureTarget.html">TextureTarget</a> & </td>
<td class="paramname"><em>target</em></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create and return a reference to a child <a class="el" href="classCEGUI_1_1RenderingWindow.html" title="RenderingWindow is a RenderingSurface that can be "drawn back" onto another RenderingSurface and is p...">RenderingWindow</a> object that will render back onto this <a class="el" href="classCEGUI_1_1RenderingSurface.html" title="Class that represents a surface that can have geometry based imagery drawn to it.">RenderingSurface</a> when it's draw member function is called. </p>
<p>The <a class="el" href="classCEGUI_1_1RenderingWindow.html" title="RenderingWindow is a RenderingSurface that can be "drawn back" onto another RenderingSurface and is p...">RenderingWindow</a> returned is initially owned by the <a class="el" href="classCEGUI_1_1RenderingSurface.html" title="Class that represents a surface that can have geometry based imagery drawn to it.">RenderingSurface</a> that created it.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">target</td><td><a class="el" href="classCEGUI_1_1TextureTarget.html" title="Specialisation of RenderTarget interface that should be used as the base class for RenderTargets that...">TextureTarget</a> object that will receive rendered output from the <a class="el" href="classCEGUI_1_1RenderingWindow.html" title="RenderingWindow is a RenderingSurface that can be "drawn back" onto another RenderingSurface and is p...">RenderingWindow</a> being creatd.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Reference to a <a class="el" href="classCEGUI_1_1RenderingWindow.html" title="RenderingWindow is a RenderingSurface that can be "drawn back" onto another RenderingSurface and is p...">RenderingWindow</a> object.</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>Since <a class="el" href="classCEGUI_1_1RenderingWindow.html" title="RenderingWindow is a RenderingSurface that can be "drawn back" onto another RenderingSurface and is p...">RenderingWindow</a> is a <a class="el" href="classCEGUI_1_1RenderingSurface.html" title="Class that represents a surface that can have geometry based imagery drawn to it.">RenderingSurface</a>, the same note from the constructor applies here, and that is the passed in <a class="el" href="classCEGUI_1_1TextureTarget.html" title="Specialisation of RenderTarget interface that should be used as the base class for RenderTargets that...">TextureTarget</a> remains under the ownership of whichever part of the system created it. </dd></dl>
</div>
</div>
<a class="anchor" id="a17a2d2b7776e2c9086594a89e2b7ed32"></a><!-- doxytag: member="CEGUI::RenderingSurface::destroyRenderingWindow" ref="a17a2d2b7776e2c9086594a89e2b7ed32" args="(RenderingWindow &window)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void CEGUI::RenderingSurface::destroyRenderingWindow </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCEGUI_1_1RenderingWindow.html">RenderingWindow</a> & </td>
<td class="paramname"><em>window</em></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destroy a <a class="el" href="classCEGUI_1_1RenderingWindow.html" title="RenderingWindow is a RenderingSurface that can be "drawn back" onto another RenderingSurface and is p...">RenderingWindow</a> we own. If we are not the present owner of the given <a class="el" href="classCEGUI_1_1RenderingWindow.html" title="RenderingWindow is a RenderingSurface that can be "drawn back" onto another RenderingSurface and is p...">RenderingWindow</a>, nothing happens. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">window</td><td><a class="el" href="classCEGUI_1_1RenderingWindow.html" title="RenderingWindow is a RenderingSurface that can be "drawn back" onto another RenderingSurface and is p...">RenderingWindow</a> object that is to be destroyed.</td></tr>
</table>
</dd>
</dl>
<dl class="note"><dt><b>Note:</b></dt><dd>Destroying a <a class="el" href="classCEGUI_1_1RenderingWindow.html" title="RenderingWindow is a RenderingSurface that can be "drawn back" onto another RenderingSurface and is p...">RenderingWindow</a> will not also destroy the <a class="el" href="classCEGUI_1_1TextureTarget.html" title="Specialisation of RenderTarget interface that should be used as the base class for RenderTargets that...">TextureTarget</a> that was given when the <a class="el" href="classCEGUI_1_1RenderingWindow.html" title="RenderingWindow is a RenderingSurface that can be "drawn back" onto another RenderingSurface and is p...">RenderingWindow</a> was created. The <a class="el" href="classCEGUI_1_1TextureTarget.html" title="Specialisation of RenderTarget interface that should be used as the base class for RenderTargets that...">TextureTarget</a> should be destoyed elsewhere. </dd></dl>
</div>
</div>
<a class="anchor" id="ac5324bcc28a06a269f0465b99643537f"></a><!-- doxytag: member="CEGUI::RenderingSurface::draw" ref="ac5324bcc28a06a269f0465b99643537f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void CEGUI::RenderingSurface::draw </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Draw the GeometryBuffers for all rendering queues to the <a class="el" href="classCEGUI_1_1RenderTarget.html" title="Defines interface to some surface that can be rendered to. Concrete instances of objects that impleme...">RenderTarget</a> that this <a class="el" href="classCEGUI_1_1RenderingSurface.html" title="Class that represents a surface that can have geometry based imagery drawn to it.">RenderingSurface</a> is targetting. </p>
<p>The GeometryBuffers remain in the rendering queues after the draw operation is complete. This allows the next draw operation to occur without needing to requeue all the GeometryBuffers (if for instance the sequence of buffers to be drawn remains unchanged). </p>
<p>Reimplemented in <a class="el" href="classCEGUI_1_1RenderingWindow.html#ac1eaab08f25c84eb029e212212bc8fbe">CEGUI::RenderingWindow</a>.</p>
</div>
</div>
<a class="anchor" id="a2c09efa138621edd331f345fcd872343"></a><!-- doxytag: member="CEGUI::RenderingSurface::getRenderTarget" ref="a2c09efa138621edd331f345fcd872343" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classCEGUI_1_1RenderTarget.html">RenderTarget</a>& CEGUI::RenderingSurface::getRenderTarget </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the <a class="el" href="classCEGUI_1_1RenderTarget.html" title="Defines interface to some surface that can be rendered to. Concrete instances of objects that impleme...">RenderTarget</a> object that this <a class="el" href="classCEGUI_1_1RenderingSurface.html" title="Class that represents a surface that can have geometry based imagery drawn to it.">RenderingSurface</a> is drawing to. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="classCEGUI_1_1RenderTarget.html" title="Defines interface to some surface that can be rendered to. Concrete instances of objects that impleme...">RenderTarget</a> object that the <a class="el" href="classCEGUI_1_1RenderingSurface.html" title="Class that represents a surface that can have geometry based imagery drawn to it.">RenderingSurface</a> is using to draw it's output. </dd></dl>
</div>
</div>
<a class="anchor" id="a6fd2ace1ea7f7213467edcc90d547cb7"></a><!-- doxytag: member="CEGUI::RenderingSurface::invalidate" ref="a6fd2ace1ea7f7213467edcc90d547cb7" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void CEGUI::RenderingSurface::invalidate </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Marks the <a class="el" href="classCEGUI_1_1RenderingSurface.html" title="Class that represents a surface that can have geometry based imagery drawn to it.">RenderingSurface</a> as invalid, causing the geometry to be rerendered to the <a class="el" href="classCEGUI_1_1RenderTarget.html" title="Defines interface to some surface that can be rendered to. Concrete instances of objects that impleme...">RenderTarget</a> next time draw is called. </p>
<p>Note that some surface types can never be in a 'valid' state and so rerendering occurs whenever draw is called. This function mainly exists as a means to hint to other surface types - those that physically cache the rendered output - that geometry content has changed and the cached imagery should be cleared and redrawn. </p>
<p>Reimplemented in <a class="el" href="classCEGUI_1_1RenderingWindow.html#ab671b91b32d421fc67d0c0cd09236b06">CEGUI::RenderingWindow</a>.</p>
</div>
</div>
<a class="anchor" id="a8d70faa337c4946f232b6feeb2996ba2"></a><!-- doxytag: member="CEGUI::RenderingSurface::isInvalidated" ref="a8d70faa337c4946f232b6feeb2996ba2" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool CEGUI::RenderingSurface::isInvalidated </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return whether this <a class="el" href="classCEGUI_1_1RenderingSurface.html" title="Class that represents a surface that can have geometry based imagery drawn to it.">RenderingSurface</a> is invalidated. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd><ul>
<li>true to indicate the <a class="el" href="classCEGUI_1_1RenderingSurface.html" title="Class that represents a surface that can have geometry based imagery drawn to it.">RenderingSurface</a> is invalidated and will be rerendered the next time the draw member function is called.</li>
<li>false to indicate the <a class="el" href="classCEGUI_1_1RenderingSurface.html" title="Class that represents a surface that can have geometry based imagery drawn to it.">RenderingSurface</a> is valid, and will not be rerendered the next time the draw member function is called, since it's cached imagery is up-to-date.</li>
</ul>
</dd></dl>
<p>Note that some surface types can never be in a 'valid' state and so will always return true. </p>
</div>
</div>
<a class="anchor" id="a56017aaebfc25ebb1ea0365cf4abed81"></a><!-- doxytag: member="CEGUI::RenderingSurface::isRenderingWindow" ref="a56017aaebfc25ebb1ea0365cf4abed81" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool CEGUI::RenderingSurface::isRenderingWindow </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return whether this <a class="el" href="classCEGUI_1_1RenderingSurface.html" title="Class that represents a surface that can have geometry based imagery drawn to it.">RenderingSurface</a> is actually an instance of the <a class="el" href="classCEGUI_1_1RenderingWindow.html" title="RenderingWindow is a RenderingSurface that can be "drawn back" onto another RenderingSurface and is p...">RenderingWindow</a> subclass. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd><ul>
<li>true to indicate the <a class="el" href="classCEGUI_1_1RenderingSurface.html" title="Class that represents a surface that can have geometry based imagery drawn to it.">RenderingSurface</a> is a <a class="el" href="classCEGUI_1_1RenderingWindow.html" title="RenderingWindow is a RenderingSurface that can be "drawn back" onto another RenderingSurface and is p...">RenderingWindow</a> instance.</li>
<li>false to indicate the <a class="el" href="classCEGUI_1_1RenderingSurface.html" title="Class that represents a surface that can have geometry based imagery drawn to it.">RenderingSurface</a> is not a <a class="el" href="classCEGUI_1_1RenderingWindow.html" title="RenderingWindow is a RenderingSurface that can be "drawn back" onto another RenderingSurface and is p...">RenderingWindow</a>. </li>
</ul>
</dd></dl>
<p>Reimplemented in <a class="el" href="classCEGUI_1_1RenderingWindow.html#a751deff547f1d2af888fa0a98f6c7716">CEGUI::RenderingWindow</a>.</p>
</div>
</div>
<a class="anchor" id="aac4c2a1eb7384cba2bec410936a594de"></a><!-- doxytag: member="CEGUI::RenderingSurface::removeGeometryBuffer" ref="aac4c2a1eb7384cba2bec410936a594de" args="(const RenderQueueID queue, const GeometryBuffer &buffer)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::RenderingSurface::removeGeometryBuffer </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespaceCEGUI.html#a38d31cb120521aa412d1533891bda878">RenderQueueID</a> </td>
<td class="paramname"><em>queue</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1GeometryBuffer.html">GeometryBuffer</a> & </td>
<td class="paramname"><em>buffer</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Remove the specified <a class="el" href="classCEGUI_1_1GeometryBuffer.html" title="Abstract class defining the interface for objects that buffer geometry for later rendering.">GeometryBuffer</a> from the specified queue. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">queue</td><td>One of the RenderQueueID enumerated values indicating which prioritised queue the <a class="el" href="classCEGUI_1_1GeometryBuffer.html" title="Abstract class defining the interface for objects that buffer geometry for later rendering.">GeometryBuffer</a> should be removed from.</td></tr>
<tr><td class="paramname">buffer</td><td><a class="el" href="classCEGUI_1_1GeometryBuffer.html" title="Abstract class defining the interface for objects that buffer geometry for later rendering.">GeometryBuffer</a> object to be removed from the specified rendering queue. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a6541e6e27178ab80400d9a8943dc7fd8"></a><!-- doxytag: member="CEGUI::RenderingSurface::transferRenderingWindow" ref="a6541e6e27178ab80400d9a8943dc7fd8" args="(RenderingWindow &window)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void CEGUI::RenderingSurface::transferRenderingWindow </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCEGUI_1_1RenderingWindow.html">RenderingWindow</a> & </td>
<td class="paramname"><em>window</em></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>transfer ownership of the <a class="el" href="classCEGUI_1_1RenderingWindow.html" title="RenderingWindow is a RenderingSurface that can be "drawn back" onto another RenderingSurface and is p...">RenderingWindow</a> to this <a class="el" href="classCEGUI_1_1RenderingSurface.html" title="Class that represents a surface that can have geometry based imagery drawn to it.">RenderingSurface</a>. </p>
<p>Transfer ownership of the given <a class="el" href="classCEGUI_1_1RenderingWindow.html" title="RenderingWindow is a RenderingSurface that can be "drawn back" onto another RenderingSurface and is p...">RenderingWindow</a> to this <a class="el" href="classCEGUI_1_1RenderingSurface.html" title="Class that represents a surface that can have geometry based imagery drawn to it.">RenderingSurface</a>. The result is <em>generally</em> the same as if this <a class="el" href="classCEGUI_1_1RenderingSurface.html" title="Class that represents a surface that can have geometry based imagery drawn to it.">RenderingSurface</a> had created the <a class="el" href="classCEGUI_1_1RenderingWindow.html" title="RenderingWindow is a RenderingSurface that can be "drawn back" onto another RenderingSurface and is p...">RenderingWindow</a> in the first place.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">window</td><td><a class="el" href="classCEGUI_1_1RenderingWindow.html" title="RenderingWindow is a RenderingSurface that can be "drawn back" onto another RenderingSurface and is p...">RenderingWindow</a> object that this <a class="el" href="classCEGUI_1_1RenderingSurface.html" title="Class that represents a surface that can have geometry based imagery drawn to it.">RenderingSurface</a> is to take ownership of. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="af5e0d1b7598237237bef6d94f2cb80f4"></a><!-- doxytag: member="CEGUI::RenderingSurface::EventRenderQueueEnded" ref="af5e0d1b7598237237bef6d94f2cb80f4" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classCEGUI_1_1String.html">String</a> <a class="el" href="classCEGUI_1_1RenderingSurface.html#af5e0d1b7598237237bef6d94f2cb80f4">CEGUI::RenderingSurface::EventRenderQueueEnded</a><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> fired when rendering of a <a class="el" href="classCEGUI_1_1RenderQueue.html" title="Class that represents a queue of GeometryBuffer objects to be rendered.">RenderQueue</a> completes for the <a class="el" href="classCEGUI_1_1RenderingSurface.html" title="Class that represents a surface that can have geometry based imagery drawn to it.">RenderingSurface</a>. Handlers are passed a const <a class="el" href="classCEGUI_1_1RenderQueueEventArgs.html" title="EventArgs based class that is passed to handlers subcribed to hear about begin/end events on renderin...">RenderQueueEventArgs</a> reference with <a class="el" href="classCEGUI_1_1RenderQueueEventArgs.html#a971f085ce2454f1411511583f98a4098" title="ID of the queue that this event has been fired for.">RenderQueueEventArgs::queueID</a> set to one of the <a class="el" href="namespaceCEGUI.html#a38d31cb120521aa412d1533891bda878" title="Enumerated type for valid render queue IDs.">RenderQueueID</a> enumerated values indicating the queue that has completed rendering. </p>
</div>
</div>
<a class="anchor" id="ac466162a8996d414db1c6bdcb1e704ff"></a><!-- doxytag: member="CEGUI::RenderingSurface::EventRenderQueueStarted" ref="ac466162a8996d414db1c6bdcb1e704ff" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classCEGUI_1_1String.html">String</a> <a class="el" href="classCEGUI_1_1RenderingSurface.html#ac466162a8996d414db1c6bdcb1e704ff">CEGUI::RenderingSurface::EventRenderQueueStarted</a><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="classCEGUI_1_1Event.html" title="Defines an 'event' which can be subscribed to by interested parties.">Event</a> fired when rendering of a <a class="el" href="classCEGUI_1_1RenderQueue.html" title="Class that represents a queue of GeometryBuffer objects to be rendered.">RenderQueue</a> begins for the <a class="el" href="classCEGUI_1_1RenderingSurface.html" title="Class that represents a surface that can have geometry based imagery drawn to it.">RenderingSurface</a>. Handlers are passed a const <a class="el" href="classCEGUI_1_1RenderQueueEventArgs.html" title="EventArgs based class that is passed to handlers subcribed to hear about begin/end events on renderin...">RenderQueueEventArgs</a> reference with <a class="el" href="classCEGUI_1_1RenderQueueEventArgs.html#a971f085ce2454f1411511583f98a4098" title="ID of the queue that this event has been fired for.">RenderQueueEventArgs::queueID</a> set to one of the <a class="el" href="namespaceCEGUI.html#a38d31cb120521aa412d1533891bda878" title="Enumerated type for valid render queue IDs.">RenderQueueID</a> enumerated values indicating the queue that is about to start rendering. </p>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Sun Jan 22 2012 16:07:41 for Crazy Eddies GUI System by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</body>
</html>
|
