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
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
|
<!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::OgreRenderer 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_1OgreRenderer.html">OgreRenderer</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> </div>
<div class="headertitle">
<div class="title">CEGUI::OgreRenderer Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="CEGUI::OgreRenderer" --><!-- doxytag: inherits="CEGUI::Renderer" -->
<p><a class="el" href="classCEGUI_1_1Renderer.html" title="Abstract class defining the basic required interface for Renderer objects.">CEGUI::Renderer</a> implementation for the Ogre engine.
<a href="classCEGUI_1_1OgreRenderer.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::OgreRenderer:</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_1OgreRenderer__inherit__graph.gif" border="0" usemap="#CEGUI_1_1OgreRenderer_inherit__map" alt="Inheritance graph"/></div>
<map name="CEGUI_1_1OgreRenderer_inherit__map" id="CEGUI_1_1OgreRenderer_inherit__map">
<area shape="rect" id="node2" href="classCEGUI_1_1Renderer.html" title="Abstract class defining the basic required interface for Renderer objects." alt="" coords="20,5,145,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::OgreRenderer:</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_1OgreRenderer__coll__graph.gif" border="0" usemap="#CEGUI_1_1OgreRenderer_coll__map" alt="Collaboration graph"/></div>
<map name="CEGUI_1_1OgreRenderer_coll__map" id="CEGUI_1_1OgreRenderer_coll__map">
<area shape="rect" id="node2" href="classCEGUI_1_1Renderer.html" title="Abstract class defining the basic required interface for Renderer objects." alt="" coords="20,5,145,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classCEGUI_1_1OgreRenderer-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"><a class="anchor" id="adb503d26741dd0fe99950c29d5003823"></a><!-- doxytag: member="CEGUI::OgreRenderer::setRenderingEnabled" ref="adb503d26741dd0fe99950c29d5003823" args="(const bool enabled)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OgreRenderer.html#adb503d26741dd0fe99950c29d5003823">setRenderingEnabled</a> (const bool enabled)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">set whether <a class="el" href="namespaceCEGUI.html" title="Main namespace for Crazy Eddie's GUI Library.">CEGUI</a> rendering will occur <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad1eabc22232da9ad2ff05295e17ce159"></a><!-- doxytag: member="CEGUI::OgreRenderer::isRenderingEnabled" ref="ad1eabc22232da9ad2ff05295e17ce159" args="() const " -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OgreRenderer.html#ad1eabc22232da9ad2ff05295e17ce159">isRenderingEnabled</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return whether <a class="el" href="namespaceCEGUI.html" title="Main namespace for Crazy Eddie's GUI Library.">CEGUI</a> rendering is enabled. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCEGUI_1_1Texture.html">Texture</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OgreRenderer.html#a9fdf17c106cbb378d77515bbbf1fa842">createTexture</a> (Ogre::TexturePtr &tex, bool take_ownership=false)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a <a class="el" href="classCEGUI_1_1Texture.html" title="Abstract base class specifying the required interface for Texture objects.">CEGUI::Texture</a> that wraps an existing Ogre texture. <a href="#a9fdf17c106cbb378d77515bbbf1fa842"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a289ba9cbec76b09230502e66433ec52a"></a><!-- doxytag: member="CEGUI::OgreRenderer::setupRenderingBlendMode" ref="a289ba9cbec76b09230502e66433ec52a" args="(const BlendMode mode, const bool force=false)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OgreRenderer.html#a289ba9cbec76b09230502e66433ec52a">setupRenderingBlendMode</a> (const <a class="el" href="namespaceCEGUI.html#a83f2d6a0102fd8798109705714ff8f47">BlendMode</a> mode, const bool force=false)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">set the render states for the specified BlendMode. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OgreRenderer.html#a8b1122012be309680f0164ea6008e638">setFrameControlExecutionEnabled</a> (const bool enabled)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Controls whether rendering done by <a class="el" href="namespaceCEGUI.html" title="Main namespace for Crazy Eddie's GUI Library.">CEGUI</a> will be wrapped with calls to Ogre::RenderSystem::_beginFrame and Ogre::RenderSystem::_endFrame. <a href="#a8b1122012be309680f0164ea6008e638"></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_1OgreRenderer.html#ac554cee0d0140366389a989ad4f358d2">isFrameControlExecutionEnabled</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns whether rendering done by <a class="el" href="namespaceCEGUI.html" title="Main namespace for Crazy Eddie's GUI Library.">CEGUI</a> will be wrapped with calls to Ogre::RenderSystem::_beginFrame and Ogre::RenderSystem::_endFrame. <a href="#ac554cee0d0140366389a989ad4f358d2"></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_1OgreRenderer.html#a928986ab5fa19b5b9d09b3803d2f6835">initialiseRenderStateSettings</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets all the required render states needed for <a class="el" href="namespaceCEGUI.html" title="Main namespace for Crazy Eddie's GUI Library.">CEGUI</a> rendering. <a href="#a928986ab5fa19b5b9d09b3803d2f6835"></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_1OgreRenderer.html#acdd6c0aee13be57aa2fdcafdeecf1f25">setDefaultRootRenderTarget</a> (Ogre::RenderTarget &target)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the Ogre::RenderTarget that should be targetted by the default <a class="el" href="classCEGUI_1_1RenderingRoot.html">RenderingRoot</a>. <a href="#acdd6c0aee13be57aa2fdcafdeecf1f25"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCEGUI_1_1RenderingRoot.html">RenderingRoot</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OgreRenderer.html#aaa71b6f6c5040e27881bd8b3638c8e79">getDefaultRenderingRoot</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the default rendering root for the renderer. The default rendering root is typically a <a class="el" href="classCEGUI_1_1RenderingRoot.html">RenderingRoot</a> that targets the entire screen (or rendering window). <a href="#aaa71b6f6c5040e27881bd8b3638c8e79"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCEGUI_1_1GeometryBuffer.html">GeometryBuffer</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OgreRenderer.html#a59b9513bf71e14f4fc9af3111ee7b82e">createGeometryBuffer</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a new <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 return a reference to it. You should remove 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> from any RenderQueues and call destroyGeometryBuffer when you want to destroy 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>. <a href="#a59b9513bf71e14f4fc9af3111ee7b82e"></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_1OgreRenderer.html#a7a62b0c3d16ff031a53f9f392039c433">destroyGeometryBuffer</a> (const <a class="el" href="classCEGUI_1_1GeometryBuffer.html">GeometryBuffer</a> &buffer)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroy a <a class="el" href="classCEGUI_1_1GeometryBuffer.html" title="Abstract class defining the interface for objects that buffer geometry for later rendering.">GeometryBuffer</a> that was returned when calling the createGeometryBuffer function. Before destroying any <a class="el" href="classCEGUI_1_1GeometryBuffer.html" title="Abstract class defining the interface for objects that buffer geometry for later rendering.">GeometryBuffer</a> you should ensure that it has been removed from any <a class="el" href="classCEGUI_1_1RenderQueue.html" title="Class that represents a queue of GeometryBuffer objects to be rendered.">RenderQueue</a> that was using it. <a href="#a7a62b0c3d16ff031a53f9f392039c433"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab7fcd70dd5cd42adf9a6e4add3d3aa86"></a><!-- doxytag: member="CEGUI::OgreRenderer::destroyAllGeometryBuffers" ref="ab7fcd70dd5cd42adf9a6e4add3d3aa86" args="()" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OgreRenderer.html#ab7fcd70dd5cd42adf9a6e4add3d3aa86">destroyAllGeometryBuffers</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroy all <a class="el" href="classCEGUI_1_1GeometryBuffer.html" title="Abstract class defining the interface for objects that buffer geometry for later rendering.">GeometryBuffer</a> objects created by this <a class="el" href="classCEGUI_1_1Renderer.html" title="Abstract class defining the basic required interface for Renderer objects.">Renderer</a>. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCEGUI_1_1TextureTarget.html">TextureTarget</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OgreRenderer.html#a005f8809b95105401c9d8e91dcf92c29">createTextureTarget</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a <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 can be used to cache imagery; this is a <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 does not lose it's content from one frame to another. <a href="#a005f8809b95105401c9d8e91dcf92c29"></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_1OgreRenderer.html#a212951977bcd6874ded260459042fadb">destroyTextureTarget</a> (<a class="el" href="classCEGUI_1_1TextureTarget.html">TextureTarget</a> *target)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Function that cleans up <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> objects created with the createTextureTarget function. <a href="#a212951977bcd6874ded260459042fadb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa0e170120b12720ce2f7dbdf3f485e66"></a><!-- doxytag: member="CEGUI::OgreRenderer::destroyAllTextureTargets" ref="aa0e170120b12720ce2f7dbdf3f485e66" args="()" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OgreRenderer.html#aa0e170120b12720ce2f7dbdf3f485e66">destroyAllTextureTargets</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destory all <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> objects created by this <a class="el" href="classCEGUI_1_1Renderer.html" title="Abstract class defining the basic required interface for Renderer objects.">Renderer</a>. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCEGUI_1_1Texture.html">Texture</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OgreRenderer.html#a49ae23f26f87b0ae2efef0dae9234b31">createTexture</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a 'null' <a class="el" href="classCEGUI_1_1Texture.html" title="Abstract base class specifying the required interface for Texture objects.">Texture</a> object. <a href="#a49ae23f26f87b0ae2efef0dae9234b31"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCEGUI_1_1Texture.html">Texture</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OgreRenderer.html#aeb0b75d7c86c0a8ea7657be5e5ce5030">createTexture</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &filename, const <a class="el" href="classCEGUI_1_1String.html">String</a> &resourceGroup)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a <a class="el" href="classCEGUI_1_1Texture.html" title="Abstract base class specifying the required interface for Texture objects.">Texture</a> object using the given image file. <a href="#aeb0b75d7c86c0a8ea7657be5e5ce5030"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCEGUI_1_1Texture.html">Texture</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OgreRenderer.html#a3b5f9df580d7550c0adeebfee9bc1b49">createTexture</a> (const <a class="el" href="classCEGUI_1_1Size.html">Size</a> &size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a <a class="el" href="classCEGUI_1_1Texture.html" title="Abstract base class specifying the required interface for Texture objects.">Texture</a> object with the given pixel dimensions as specified by <em>size</em>. <a href="#a3b5f9df580d7550c0adeebfee9bc1b49"></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_1OgreRenderer.html#ac89e4df3259b92531c40315165c93016">destroyTexture</a> (<a class="el" href="classCEGUI_1_1Texture.html">Texture</a> &texture)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroy a <a class="el" href="classCEGUI_1_1Texture.html" title="Abstract base class specifying the required interface for Texture objects.">Texture</a> object that was previously created by calling the createTexture functions. <a href="#ac89e4df3259b92531c40315165c93016"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a40cf6ca901427f6eba1ac72a65e4aea4"></a><!-- doxytag: member="CEGUI::OgreRenderer::destroyAllTextures" ref="a40cf6ca901427f6eba1ac72a65e4aea4" args="()" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OgreRenderer.html#a40cf6ca901427f6eba1ac72a65e4aea4">destroyAllTextures</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroy all <a class="el" href="classCEGUI_1_1Texture.html" title="Abstract base class specifying the required interface for Texture objects.">Texture</a> objects created by this <a class="el" href="classCEGUI_1_1Renderer.html" title="Abstract class defining the basic required interface for Renderer objects.">Renderer</a>. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0209f5e72c69f26ac0245883ac949691"></a><!-- doxytag: member="CEGUI::OgreRenderer::beginRendering" ref="a0209f5e72c69f26ac0245883ac949691" args="()" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OgreRenderer.html#a0209f5e72c69f26ac0245883ac949691">beginRendering</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Perform any operations required to put the system into a state ready for rendering operations to begin. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6d5d74cec2ee4cefcfbe67a87e33a915"></a><!-- doxytag: member="CEGUI::OgreRenderer::endRendering" ref="a6d5d74cec2ee4cefcfbe67a87e33a915" args="()" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OgreRenderer.html#a6d5d74cec2ee4cefcfbe67a87e33a915">endRendering</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Perform any operations required to finalise rendering. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OgreRenderer.html#a14de135260b3327dec82dad94a7b38ba">setDisplaySize</a> (const <a class="el" href="classCEGUI_1_1Size.html">Size</a> &sz)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the size of the display or host window in pixels for this <a class="el" href="classCEGUI_1_1Renderer.html" title="Abstract class defining the basic required interface for Renderer objects.">Renderer</a> object. <a href="#a14de135260b3327dec82dad94a7b38ba"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classCEGUI_1_1Size.html">Size</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OgreRenderer.html#adead408b3b88545c5ae00984f80d960e">getDisplaySize</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the size of the display or host window in pixels. <a href="#adead408b3b88545c5ae00984f80d960e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classCEGUI_1_1Vector2.html">Vector2</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OgreRenderer.html#a450a3dd8edb94d4074fdfd17d46faa90">getDisplayDPI</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the resolution of the display or host window in dots per inch. <a href="#a450a3dd8edb94d4074fdfd17d46faa90"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OgreRenderer.html#a586ac30b2032c64ed56331a312c0567d">getMaxTextureSize</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the pixel size of the maximum supported texture. <a href="#a586ac30b2032c64ed56331a312c0567d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OgreRenderer.html#af99391fb11749e77c44216134a97d29c">getIdentifierString</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return identification string for the renderer module. <a href="#af99391fb11749e77c44216134a97d29c"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classCEGUI_1_1OgreRenderer.html">OgreRenderer</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OgreRenderer.html#a3e4a385e76adf91973fb17c767b30177">bootstrapSystem</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Convenience function that creates all the Ogre specific objects and then initialises the <a class="el" href="namespaceCEGUI.html" title="Main namespace for Crazy Eddie's GUI Library.">CEGUI</a> system with them. <a href="#a3e4a385e76adf91973fb17c767b30177"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classCEGUI_1_1OgreRenderer.html">OgreRenderer</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OgreRenderer.html#a2d0007592026896451f244148d7673d1">bootstrapSystem</a> (Ogre::RenderTarget &target)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Convenience function that creates all the Ogre specific objects and then initialises the <a class="el" href="namespaceCEGUI.html" title="Main namespace for Crazy Eddie's GUI Library.">CEGUI</a> system with them. <a href="#a2d0007592026896451f244148d7673d1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OgreRenderer.html#a221ed99cd3c6ddcacf7451471d55294e">destroySystem</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Convenience function to cleanup the <a class="el" href="namespaceCEGUI.html" title="Main namespace for Crazy Eddie's GUI Library.">CEGUI</a> system and related objects that were created by calling the bootstrapSystem function. <a href="#a221ed99cd3c6ddcacf7451471d55294e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classCEGUI_1_1OgreRenderer.html">OgreRenderer</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OgreRenderer.html#a8ca3cb7094d62e47aa0db20429a82484">create</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create an <a class="el" href="classCEGUI_1_1OgreRenderer.html" title="CEGUI::Renderer implementation for the Ogre engine.">OgreRenderer</a> object that uses the default Ogre rendering window as the default output surface. <a href="#a8ca3cb7094d62e47aa0db20429a82484"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9d10964174d769db55d225a32d827e39"></a><!-- doxytag: member="CEGUI::OgreRenderer::create" ref="a9d10964174d769db55d225a32d827e39" args="(Ogre::RenderTarget &target)" -->
static <a class="el" href="classCEGUI_1_1OgreRenderer.html">OgreRenderer</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OgreRenderer.html#a9d10964174d769db55d225a32d827e39">create</a> (Ogre::RenderTarget &target)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create an <a class="el" href="classCEGUI_1_1OgreRenderer.html" title="CEGUI::Renderer implementation for the Ogre engine.">OgreRenderer</a> object that uses the specified Ogre::RenderTarget as the default output surface. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a503a17f66899cc44ccac40ba23979f7e"></a><!-- doxytag: member="CEGUI::OgreRenderer::destroy" ref="a503a17f66899cc44ccac40ba23979f7e" args="(OgreRenderer &renderer)" -->
static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OgreRenderer.html#a503a17f66899cc44ccac40ba23979f7e">destroy</a> (<a class="el" href="classCEGUI_1_1OgreRenderer.html">OgreRenderer</a> &renderer)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">destory an <a class="el" href="classCEGUI_1_1OgreRenderer.html" title="CEGUI::Renderer implementation for the Ogre engine.">OgreRenderer</a> object. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1a27edb36148e3917ca2c50768b9f026"></a><!-- doxytag: member="CEGUI::OgreRenderer::createOgreResourceProvider" ref="a1a27edb36148e3917ca2c50768b9f026" args="()" -->
static <a class="el" href="classCEGUI_1_1OgreResourceProvider.html">OgreResourceProvider</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OgreRenderer.html#a1a27edb36148e3917ca2c50768b9f026">createOgreResourceProvider</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">function to create a <a class="el" href="classCEGUI_1_1OgreResourceProvider.html">CEGUI::OgreResourceProvider</a> object <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab4feb817d6b2f37d87755890d00cd783"></a><!-- doxytag: member="CEGUI::OgreRenderer::destroyOgreResourceProvider" ref="ab4feb817d6b2f37d87755890d00cd783" args="(OgreResourceProvider &rp)" -->
static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OgreRenderer.html#ab4feb817d6b2f37d87755890d00cd783">destroyOgreResourceProvider</a> (<a class="el" href="classCEGUI_1_1OgreResourceProvider.html">OgreResourceProvider</a> &rp)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">function to destroy a <a class="el" href="classCEGUI_1_1OgreResourceProvider.html">CEGUI::OgreResourceProvider</a> object <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a908649a9a1a04c7cb2c2363bea89ed28"></a><!-- doxytag: member="CEGUI::OgreRenderer::createOgreImageCodec" ref="a908649a9a1a04c7cb2c2363bea89ed28" args="()" -->
static <a class="el" href="classCEGUI_1_1OgreImageCodec.html">OgreImageCodec</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OgreRenderer.html#a908649a9a1a04c7cb2c2363bea89ed28">createOgreImageCodec</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">function to create a <a class="el" href="classCEGUI_1_1OgreImageCodec.html" title="ImageCodec object that loads data via image loading facilities in Ogre.">CEGUI::OgreImageCodec</a> object. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a96f40c6e61b8e7e524a3eb0c29979bfc"></a><!-- doxytag: member="CEGUI::OgreRenderer::destroyOgreImageCodec" ref="a96f40c6e61b8e7e524a3eb0c29979bfc" args="(OgreImageCodec &ic)" -->
static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OgreRenderer.html#a96f40c6e61b8e7e524a3eb0c29979bfc">destroyOgreImageCodec</a> (<a class="el" href="classCEGUI_1_1OgreImageCodec.html">OgreImageCodec</a> &ic)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">function to destroy a <a class="el" href="classCEGUI_1_1OgreImageCodec.html" title="ImageCodec object that loads data via image loading facilities in Ogre.">CEGUI::OgreImageCodec</a> object. <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="a87a8bfc101cb940be095b3ffbb61bbd8"></a><!-- doxytag: member="CEGUI::OgreRenderer::OgreRenderer" ref="a87a8bfc101cb940be095b3ffbb61bbd8" args="()" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OgreRenderer.html#a87a8bfc101cb940be095b3ffbb61bbd8">OgreRenderer</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">default constructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a29a4968693fa7f3b065dcaf8bff0746f"></a><!-- doxytag: member="CEGUI::OgreRenderer::OgreRenderer" ref="a29a4968693fa7f3b065dcaf8bff0746f" args="(Ogre::RenderTarget &target)" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OgreRenderer.html#a29a4968693fa7f3b065dcaf8bff0746f">OgreRenderer</a> (Ogre::RenderTarget &target)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">constructor takin the Ogre::RenderTarget to use as the default root. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ada7992ab7a345ee51de7201c34258e30"></a><!-- doxytag: member="CEGUI::OgreRenderer::~OgreRenderer" ref="ada7992ab7a345ee51de7201c34258e30" args="()" -->
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OgreRenderer.html#ada7992ab7a345ee51de7201c34258e30">~OgreRenderer</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">destructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab2518e6d7063af32e607fa1d8146d534"></a><!-- doxytag: member="CEGUI::OgreRenderer::checkOgreInitialised" ref="ab2518e6d7063af32e607fa1d8146d534" args="()" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OgreRenderer.html#ab2518e6d7063af32e607fa1d8146d534">checkOgreInitialised</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">checks Ogre initialisation. throws exceptions if an issue is detected. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a98f905c0c9dbdebb5f839575bc19aaca"></a><!-- doxytag: member="CEGUI::OgreRenderer::constructor_impl" ref="a98f905c0c9dbdebb5f839575bc19aaca" args="(Ogre::RenderTarget &target)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OgreRenderer.html#a98f905c0c9dbdebb5f839575bc19aaca">constructor_impl</a> (Ogre::RenderTarget &target)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">common parts of constructor <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="aba8481b1f661828895a42791d5eb1f44"></a><!-- doxytag: member="CEGUI::OgreRenderer::d_pimpl" ref="aba8481b1f661828895a42791d5eb1f44" args="" -->
OgreRenderer_impl * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OgreRenderer.html#aba8481b1f661828895a42791d5eb1f44">d_pimpl</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Pointer to the hidden implementation data. <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classCEGUI_1_1Renderer.html" title="Abstract class defining the basic required interface for Renderer objects.">CEGUI::Renderer</a> implementation for the Ogre engine. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a2d0007592026896451f244148d7673d1"></a><!-- doxytag: member="CEGUI::OgreRenderer::bootstrapSystem" ref="a2d0007592026896451f244148d7673d1" args="(Ogre::RenderTarget &target)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classCEGUI_1_1OgreRenderer.html">OgreRenderer</a>& CEGUI::OgreRenderer::bootstrapSystem </td>
<td>(</td>
<td class="paramtype">Ogre::RenderTarget & </td>
<td class="paramname"><em>target</em></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Convenience function that creates all the Ogre specific objects and then initialises the <a class="el" href="namespaceCEGUI.html" title="Main namespace for Crazy Eddie's GUI Library.">CEGUI</a> system with them. </p>
<p>The create <a class="el" href="classCEGUI_1_1Renderer.html" title="Abstract class defining the basic required interface for Renderer objects.">Renderer</a> will use the specified Ogre::RenderTarget as the default output surface.</p>
<p>This will create and initialise the following objects for you:</p>
<ul>
<li><a class="el" href="classCEGUI_1_1OgreRenderer.html" title="CEGUI::Renderer implementation for the Ogre engine.">CEGUI::OgreRenderer</a></li>
<li><a class="el" href="classCEGUI_1_1OgreResourceProvider.html">CEGUI::OgreResourceProvider</a></li>
<li><a class="el" href="classCEGUI_1_1OgreImageCodec.html" title="ImageCodec object that loads data via image loading facilities in Ogre.">CEGUI::OgreImageCodec</a></li>
<li><a class="el" href="classCEGUI_1_1System.html" title="The System class is the CEGUI class that provides access to all other elements in this system...">CEGUI::System</a></li>
</ul>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">target</td><td>Reference to the Ogre::RenderTarget object that the created <a class="el" href="classCEGUI_1_1OgreRenderer.html" title="CEGUI::Renderer implementation for the Ogre engine.">OgreRenderer</a> will use as the default rendering root.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Reference to the <a class="el" href="classCEGUI_1_1OgreRenderer.html" title="CEGUI::Renderer implementation for the Ogre engine.">CEGUI::OgreRenderer</a> object that was created. </dd></dl>
</div>
</div>
<a class="anchor" id="a3e4a385e76adf91973fb17c767b30177"></a><!-- doxytag: member="CEGUI::OgreRenderer::bootstrapSystem" ref="a3e4a385e76adf91973fb17c767b30177" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classCEGUI_1_1OgreRenderer.html">OgreRenderer</a>& CEGUI::OgreRenderer::bootstrapSystem </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Convenience function that creates all the Ogre specific objects and then initialises the <a class="el" href="namespaceCEGUI.html" title="Main namespace for Crazy Eddie's GUI Library.">CEGUI</a> system with them. </p>
<p>The created <a class="el" href="classCEGUI_1_1Renderer.html" title="Abstract class defining the basic required interface for Renderer objects.">Renderer</a> will use the default Ogre rendering window as the default output surface.</p>
<p>This will create and initialise the following objects for you:</p>
<ul>
<li><a class="el" href="classCEGUI_1_1OgreRenderer.html" title="CEGUI::Renderer implementation for the Ogre engine.">CEGUI::OgreRenderer</a></li>
<li><a class="el" href="classCEGUI_1_1OgreResourceProvider.html">CEGUI::OgreResourceProvider</a></li>
<li><a class="el" href="classCEGUI_1_1OgreImageCodec.html" title="ImageCodec object that loads data via image loading facilities in Ogre.">CEGUI::OgreImageCodec</a></li>
<li><a class="el" href="classCEGUI_1_1System.html" title="The System class is the CEGUI class that provides access to all other elements in this system...">CEGUI::System</a></li>
</ul>
<dl class="return"><dt><b>Returns:</b></dt><dd>Reference to the <a class="el" href="classCEGUI_1_1OgreRenderer.html" title="CEGUI::Renderer implementation for the Ogre engine.">CEGUI::OgreRenderer</a> object that was created.</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>For this to succeed you must have initialised Ogre to auto create the rendering window. If you have not done this, then you'll be wanting to use the overload that takes an Ogre::RenderTarget as input. </dd></dl>
</div>
</div>
<a class="anchor" id="a8ca3cb7094d62e47aa0db20429a82484"></a><!-- doxytag: member="CEGUI::OgreRenderer::create" ref="a8ca3cb7094d62e47aa0db20429a82484" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classCEGUI_1_1OgreRenderer.html">OgreRenderer</a>& CEGUI::OgreRenderer::create </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create an <a class="el" href="classCEGUI_1_1OgreRenderer.html" title="CEGUI::Renderer implementation for the Ogre engine.">OgreRenderer</a> object that uses the default Ogre rendering window as the default output surface. </p>
<dl class="note"><dt><b>Note:</b></dt><dd>For this to succeed you must have initialised Ogre to auto create the rendering window. If you have not done this, then you'll be wanting to use the overload that takes an Ogre::RenderTarget as input. </dd></dl>
</div>
</div>
<a class="anchor" id="a59b9513bf71e14f4fc9af3111ee7b82e"></a><!-- doxytag: member="CEGUI::OgreRenderer::createGeometryBuffer" ref="a59b9513bf71e14f4fc9af3111ee7b82e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCEGUI_1_1GeometryBuffer.html">GeometryBuffer</a>& CEGUI::OgreRenderer::createGeometryBuffer </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a new <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 return a reference to it. You should remove 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> from any RenderQueues and call destroyGeometryBuffer when you want to destroy 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>. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd><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. </dd></dl>
<p>Implements <a class="el" href="classCEGUI_1_1Renderer.html#a681976af0bc86c5f18d471324837fa89">CEGUI::Renderer</a>.</p>
</div>
</div>
<a class="anchor" id="a9fdf17c106cbb378d77515bbbf1fa842"></a><!-- doxytag: member="CEGUI::OgreRenderer::createTexture" ref="a9fdf17c106cbb378d77515bbbf1fa842" args="(Ogre::TexturePtr &tex, bool take_ownership=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCEGUI_1_1Texture.html">Texture</a>& CEGUI::OgreRenderer::createTexture </td>
<td>(</td>
<td class="paramtype">Ogre::TexturePtr & </td>
<td class="paramname"><em>tex</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>take_ownership</em> = <code>false</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a <a class="el" href="classCEGUI_1_1Texture.html" title="Abstract base class specifying the required interface for Texture objects.">CEGUI::Texture</a> that wraps an existing Ogre texture. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">tex</td><td>Ogre::TexturePtr for the texture that will be used by the created <a class="el" href="classCEGUI_1_1Texture.html" title="Abstract base class specifying the required interface for Texture objects.">CEGUI::Texture</a>.</td></tr>
<tr><td class="paramname">take_ownership</td><td><ul>
<li>true if the created <a class="el" href="classCEGUI_1_1Texture.html" title="Abstract base class specifying the required interface for Texture objects.">Texture</a> will assume ownership of <em>tex</em> and thus destroy <em>tex</em> when the <a class="el" href="classCEGUI_1_1Texture.html" title="Abstract base class specifying the required interface for Texture objects.">Texture</a> is destroyed.</li>
<li>false if ownership of <em>tex</em> remains with the client app, and so no attempt will be made to destroy <em>tex</em> when the <a class="el" href="classCEGUI_1_1Texture.html" title="Abstract base class specifying the required interface for Texture objects.">Texture</a> is destroyed. </li>
</ul>
</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a49ae23f26f87b0ae2efef0dae9234b31"></a><!-- doxytag: member="CEGUI::OgreRenderer::createTexture" ref="a49ae23f26f87b0ae2efef0dae9234b31" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCEGUI_1_1Texture.html">Texture</a>& CEGUI::OgreRenderer::createTexture </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a 'null' <a class="el" href="classCEGUI_1_1Texture.html" title="Abstract base class specifying the required interface for Texture objects.">Texture</a> object. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A newly created <a class="el" href="classCEGUI_1_1Texture.html" title="Abstract base class specifying the required interface for Texture objects.">Texture</a> object. The returned <a class="el" href="classCEGUI_1_1Texture.html" title="Abstract base class specifying the required interface for Texture objects.">Texture</a> object has no size or imagery associated with it. </dd></dl>
<p>Implements <a class="el" href="classCEGUI_1_1Renderer.html#a70a7afa2b1a47cee8a3239883044e42c">CEGUI::Renderer</a>.</p>
</div>
</div>
<a class="anchor" id="aeb0b75d7c86c0a8ea7657be5e5ce5030"></a><!-- doxytag: member="CEGUI::OgreRenderer::createTexture" ref="aeb0b75d7c86c0a8ea7657be5e5ce5030" args="(const String &filename, const String &resourceGroup)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCEGUI_1_1Texture.html">Texture</a>& CEGUI::OgreRenderer::createTexture </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>filename</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>resourceGroup</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a <a class="el" href="classCEGUI_1_1Texture.html" title="Abstract base class specifying the required interface for Texture objects.">Texture</a> object using the given image file. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">filename</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object that specifies the path and filename of the image file to use when creating the texture.</td></tr>
<tr><td class="paramname">resourceGroup</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> objet that specifies the resource group identifier to be passed to the resource provider when loading the texture file <em>filename</em>.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A newly created <a class="el" href="classCEGUI_1_1Texture.html" title="Abstract base class specifying the required interface for Texture objects.">Texture</a> object. The initial content of the texture memory is the requested image file.</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>Due to possible limitations of the underlying hardware, API or engine, the final size of the texture may not match the size of the loaded file. You can check the ultimate sizes by querying the <a class="el" href="classCEGUI_1_1Texture.html" title="Abstract base class specifying the required interface for Texture objects.">Texture</a> object after creation. </dd></dl>
<p>Implements <a class="el" href="classCEGUI_1_1Renderer.html#a3ff8322cddfcdfba8d26a109772979cb">CEGUI::Renderer</a>.</p>
</div>
</div>
<a class="anchor" id="a3b5f9df580d7550c0adeebfee9bc1b49"></a><!-- doxytag: member="CEGUI::OgreRenderer::createTexture" ref="a3b5f9df580d7550c0adeebfee9bc1b49" args="(const Size &size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCEGUI_1_1Texture.html">Texture</a>& CEGUI::OgreRenderer::createTexture </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1Size.html">Size</a> & </td>
<td class="paramname"><em>size</em></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a <a class="el" href="classCEGUI_1_1Texture.html" title="Abstract base class specifying the required interface for Texture objects.">Texture</a> object with the given pixel dimensions as specified by <em>size</em>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">size</td><td><a class="el" href="classCEGUI_1_1Size.html" title="Class that holds the size (width & height) of something.">Size</a> object that describes the desired texture size.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A newly created <a class="el" href="classCEGUI_1_1Texture.html" title="Abstract base class specifying the required interface for Texture objects.">Texture</a> object. The initial contents of the texture memory is undefined.</dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>Due to possible limitations of the underlying hardware, API or engine, the final size of the texture may not match the requested size. You can check the ultimate sizes by querying the <a class="el" href="classCEGUI_1_1Texture.html" title="Abstract base class specifying the required interface for Texture objects.">Texture</a> object after creation. </dd></dl>
<p>Implements <a class="el" href="classCEGUI_1_1Renderer.html#a2125c8ac401f9ae7c87a85ccd3807222">CEGUI::Renderer</a>.</p>
</div>
</div>
<a class="anchor" id="a005f8809b95105401c9d8e91dcf92c29"></a><!-- doxytag: member="CEGUI::OgreRenderer::createTextureTarget" ref="a005f8809b95105401c9d8e91dcf92c29" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCEGUI_1_1TextureTarget.html">TextureTarget</a>* CEGUI::OgreRenderer::createTextureTarget </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a <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 can be used to cache imagery; this is a <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 does not lose it's content from one frame to another. </p>
<p>If the renderer is unable to offer such a thing, 0 should be returned.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Pointer to a <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 is suitable for caching imagery, or 0 if the renderer is unable to offer such a thing. </dd></dl>
<p>Implements <a class="el" href="classCEGUI_1_1Renderer.html#a19ae724f3d4c2da8bdbcaba4cb8b22e1">CEGUI::Renderer</a>.</p>
</div>
</div>
<a class="anchor" id="a7a62b0c3d16ff031a53f9f392039c433"></a><!-- doxytag: member="CEGUI::OgreRenderer::destroyGeometryBuffer" ref="a7a62b0c3d16ff031a53f9f392039c433" args="(const GeometryBuffer &buffer)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::OgreRenderer::destroyGeometryBuffer </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><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destroy a <a class="el" href="classCEGUI_1_1GeometryBuffer.html" title="Abstract class defining the interface for objects that buffer geometry for later rendering.">GeometryBuffer</a> that was returned when calling the createGeometryBuffer function. Before destroying any <a class="el" href="classCEGUI_1_1GeometryBuffer.html" title="Abstract class defining the interface for objects that buffer geometry for later rendering.">GeometryBuffer</a> you should ensure that it has been removed from any <a class="el" href="classCEGUI_1_1RenderQueue.html" title="Class that represents a queue of GeometryBuffer objects to be rendered.">RenderQueue</a> that was using it. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">buffer</td><td>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> object to be destroyed. </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classCEGUI_1_1Renderer.html#a5f450c0981829896b211501af95f8ecf">CEGUI::Renderer</a>.</p>
</div>
</div>
<a class="anchor" id="a221ed99cd3c6ddcacf7451471d55294e"></a><!-- doxytag: member="CEGUI::OgreRenderer::destroySystem" ref="a221ed99cd3c6ddcacf7451471d55294e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void CEGUI::OgreRenderer::destroySystem </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Convenience function to cleanup the <a class="el" href="namespaceCEGUI.html" title="Main namespace for Crazy Eddie's GUI Library.">CEGUI</a> system and related objects that were created by calling the bootstrapSystem function. </p>
<p>This function will destroy the following objects for you:</p>
<ul>
<li><a class="el" href="classCEGUI_1_1System.html" title="The System class is the CEGUI class that provides access to all other elements in this system...">CEGUI::System</a></li>
<li><a class="el" href="classCEGUI_1_1OgreImageCodec.html" title="ImageCodec object that loads data via image loading facilities in Ogre.">CEGUI::OgreImageCodec</a></li>
<li><a class="el" href="classCEGUI_1_1OgreResourceProvider.html">CEGUI::OgreResourceProvider</a></li>
<li><a class="el" href="classCEGUI_1_1OgreRenderer.html" title="CEGUI::Renderer implementation for the Ogre engine.">CEGUI::OgreRenderer</a></li>
</ul>
<dl class="note"><dt><b>Note:</b></dt><dd>If you did not initialise <a class="el" href="namespaceCEGUI.html" title="Main namespace for Crazy Eddie's GUI Library.">CEGUI</a> by calling the bootstrapSystem function, you should <em>not</em> call this, but rather delete any objects you created manually. </dd></dl>
</div>
</div>
<a class="anchor" id="ac89e4df3259b92531c40315165c93016"></a><!-- doxytag: member="CEGUI::OgreRenderer::destroyTexture" ref="ac89e4df3259b92531c40315165c93016" args="(Texture &texture)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::OgreRenderer::destroyTexture </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCEGUI_1_1Texture.html">Texture</a> & </td>
<td class="paramname"><em>texture</em></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destroy a <a class="el" href="classCEGUI_1_1Texture.html" title="Abstract base class specifying the required interface for Texture objects.">Texture</a> object that was previously created by calling the createTexture functions. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">texture</td><td><a class="el" href="classCEGUI_1_1Texture.html" title="Abstract base class specifying the required interface for Texture objects.">Texture</a> object to be destroyed. </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classCEGUI_1_1Renderer.html#a7c204e7aba8bbf01b247e9c9b6b5ffb5">CEGUI::Renderer</a>.</p>
</div>
</div>
<a class="anchor" id="a212951977bcd6874ded260459042fadb"></a><!-- doxytag: member="CEGUI::OgreRenderer::destroyTextureTarget" ref="a212951977bcd6874ded260459042fadb" args="(TextureTarget *target)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::OgreRenderer::destroyTextureTarget </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>Function that cleans up <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> objects created with the createTextureTarget function. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">target</td><td>A pointer to a <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 was previously returned from a call to createTextureTarget. </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classCEGUI_1_1Renderer.html#afda7da404865481200da3611b0289f46">CEGUI::Renderer</a>.</p>
</div>
</div>
<a class="anchor" id="aaa71b6f6c5040e27881bd8b3638c8e79"></a><!-- doxytag: member="CEGUI::OgreRenderer::getDefaultRenderingRoot" ref="aaa71b6f6c5040e27881bd8b3638c8e79" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCEGUI_1_1RenderingRoot.html">RenderingRoot</a>& CEGUI::OgreRenderer::getDefaultRenderingRoot </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the default rendering root for the renderer. The default rendering root is typically a <a class="el" href="classCEGUI_1_1RenderingRoot.html">RenderingRoot</a> that targets the entire screen (or rendering window). </p>
<dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="classCEGUI_1_1RenderingRoot.html">RenderingRoot</a> object that is the default <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> provided by the <a class="el" href="classCEGUI_1_1Renderer.html" title="Abstract class defining the basic required interface for Renderer objects.">Renderer</a>. </dd></dl>
<p>Implements <a class="el" href="classCEGUI_1_1Renderer.html#a5a0ad73b6f37ddca022598ec27fe96c1">CEGUI::Renderer</a>.</p>
</div>
</div>
<a class="anchor" id="a450a3dd8edb94d4074fdfd17d46faa90"></a><!-- doxytag: member="CEGUI::OgreRenderer::getDisplayDPI" ref="a450a3dd8edb94d4074fdfd17d46faa90" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classCEGUI_1_1Vector2.html">Vector2</a>& CEGUI::OgreRenderer::getDisplayDPI </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the resolution of the display or host window in dots per inch. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="classCEGUI_1_1Vector2.html" title="Class used as a two dimensional vector (aka a Point)">Vector2</a> object that describes the resolution of the display or host window in DPI. </dd></dl>
<p>Implements <a class="el" href="classCEGUI_1_1Renderer.html#abafbc484a8ef468970d801acc4094175">CEGUI::Renderer</a>.</p>
</div>
</div>
<a class="anchor" id="adead408b3b88545c5ae00984f80d960e"></a><!-- doxytag: member="CEGUI::OgreRenderer::getDisplaySize" ref="adead408b3b88545c5ae00984f80d960e" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classCEGUI_1_1Size.html">Size</a>& CEGUI::OgreRenderer::getDisplaySize </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the size of the display or host window in pixels. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="classCEGUI_1_1Size.html" title="Class that holds the size (width & height) of something.">Size</a> object describing the pixel dimesntions of the current display or host window. </dd></dl>
<p>Implements <a class="el" href="classCEGUI_1_1Renderer.html#ad4e9a3ef4088b0bada3a5e2e19f7d4a7">CEGUI::Renderer</a>.</p>
</div>
</div>
<a class="anchor" id="af99391fb11749e77c44216134a97d29c"></a><!-- doxytag: member="CEGUI::OgreRenderer::getIdentifierString" ref="af99391fb11749e77c44216134a97d29c" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classCEGUI_1_1String.html">String</a>& CEGUI::OgreRenderer::getIdentifierString </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return identification string for the renderer module. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object holding text that identifies the <a class="el" href="classCEGUI_1_1Renderer.html" title="Abstract class defining the basic required interface for Renderer objects.">Renderer</a> in use. </dd></dl>
<p>Implements <a class="el" href="classCEGUI_1_1Renderer.html#af3d5e2caa01be3117c220a591e10d72d">CEGUI::Renderer</a>.</p>
</div>
</div>
<a class="anchor" id="a586ac30b2032c64ed56331a312c0567d"></a><!-- doxytag: member="CEGUI::OgreRenderer::getMaxTextureSize" ref="a586ac30b2032c64ed56331a312c0567d" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint CEGUI::OgreRenderer::getMaxTextureSize </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the pixel size of the maximum supported texture. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="classCEGUI_1_1Size.html" title="Class that holds the size (width & height) of something.">Size</a> of the maximum supported texture in pixels. </dd></dl>
<p>Implements <a class="el" href="classCEGUI_1_1Renderer.html#af978f8a138518f613d4ea76db33c7101">CEGUI::Renderer</a>.</p>
</div>
</div>
<a class="anchor" id="a928986ab5fa19b5b9d09b3803d2f6835"></a><!-- doxytag: member="CEGUI::OgreRenderer::initialiseRenderStateSettings" ref="a928986ab5fa19b5b9d09b3803d2f6835" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::OgreRenderer::initialiseRenderStateSettings </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets all the required render states needed for <a class="el" href="namespaceCEGUI.html" title="Main namespace for Crazy Eddie's GUI Library.">CEGUI</a> rendering. </p>
<p>This is a low-level function intended for certain advanced concepts; in general it will not be required to call this function directly, since it is called automatically by the system when rendering is done. </p>
</div>
</div>
<a class="anchor" id="ac554cee0d0140366389a989ad4f358d2"></a><!-- doxytag: member="CEGUI::OgreRenderer::isFrameControlExecutionEnabled" ref="ac554cee0d0140366389a989ad4f358d2" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool CEGUI::OgreRenderer::isFrameControlExecutionEnabled </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns whether rendering done by <a class="el" href="namespaceCEGUI.html" title="Main namespace for Crazy Eddie's GUI Library.">CEGUI</a> will be wrapped with calls to Ogre::RenderSystem::_beginFrame and Ogre::RenderSystem::_endFrame. </p>
<p>This defaults to enabled and is required when using the default hook that automatically calls <a class="el" href="classCEGUI_1_1System.html#a27924df52d352bba7d18a20d9f4639a1" title="Render the GUI.">CEGUI::System::renderGUI</a> via a frame listener. If you disable this setting, the automated rendering will also be disabled, which is useful when you wish to perform your own calls to the <a class="el" href="classCEGUI_1_1System.html#a27924df52d352bba7d18a20d9f4639a1" title="Render the GUI.">CEGUI::System::renderGUI</a> function (and is the sole purpose for this setting).</p>
<dl class="return"><dt><b>Returns:</b></dt><dd><ul>
<li>true if _beginFrame and _endFrame will be called.</li>
<li>false if _beginFrame and _endFrame will not be called (also means default renderGUI call will not be made). </li>
</ul>
</dd></dl>
</div>
</div>
<a class="anchor" id="acdd6c0aee13be57aa2fdcafdeecf1f25"></a><!-- doxytag: member="CEGUI::OgreRenderer::setDefaultRootRenderTarget" ref="acdd6c0aee13be57aa2fdcafdeecf1f25" args="(Ogre::RenderTarget &target)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::OgreRenderer::setDefaultRootRenderTarget </td>
<td>(</td>
<td class="paramtype">Ogre::RenderTarget & </td>
<td class="paramname"><em>target</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the Ogre::RenderTarget that should be targetted by the default <a class="el" href="classCEGUI_1_1RenderingRoot.html">RenderingRoot</a>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">target</td><td>Reference to the Ogre::RenderTarget object that is to be used as the target for output from the default <a class="el" href="classCEGUI_1_1RenderingRoot.html">RenderingRoot</a>. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a14de135260b3327dec82dad94a7b38ba"></a><!-- doxytag: member="CEGUI::OgreRenderer::setDisplaySize" ref="a14de135260b3327dec82dad94a7b38ba" args="(const Size &sz)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::OgreRenderer::setDisplaySize </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1Size.html">Size</a> & </td>
<td class="paramname"><em>size</em></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the size of the display or host window in pixels for this <a class="el" href="classCEGUI_1_1Renderer.html" title="Abstract class defining the basic required interface for Renderer objects.">Renderer</a> object. </p>
<p>This is intended to be called by the <a class="el" href="classCEGUI_1_1System.html" title="The System class is the CEGUI class that provides access to all other elements in this system...">System</a> as part of the notification process when display size changes are notified to it via the <a class="el" href="classCEGUI_1_1System.html#a259ef239fb65e93bafd6c777a93dbfb1" title="Notification function to be called when the main display changes size. Client code should call this f...">System::notifyDisplaySizeChanged</a> function.</p>
<dl class="note"><dt><b>Note:</b></dt><dd>The <a class="el" href="classCEGUI_1_1Renderer.html" title="Abstract class defining the basic required interface for Renderer objects.">Renderer</a> implementation should not use this function other than to perform internal state updates on the <a class="el" href="classCEGUI_1_1Renderer.html" title="Abstract class defining the basic required interface for Renderer objects.">Renderer</a> and related objects.</dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">size</td><td><a class="el" href="classCEGUI_1_1Size.html" title="Class that holds the size (width & height) of something.">Size</a> object describing the dimesions of the current or host window in pixels. </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classCEGUI_1_1Renderer.html#a7f359f7c73091bed8e8b35b90779929c">CEGUI::Renderer</a>.</p>
</div>
</div>
<a class="anchor" id="a8b1122012be309680f0164ea6008e638"></a><!-- doxytag: member="CEGUI::OgreRenderer::setFrameControlExecutionEnabled" ref="a8b1122012be309680f0164ea6008e638" args="(const bool enabled)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::OgreRenderer::setFrameControlExecutionEnabled </td>
<td>(</td>
<td class="paramtype">const bool </td>
<td class="paramname"><em>enabled</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Controls whether rendering done by <a class="el" href="namespaceCEGUI.html" title="Main namespace for Crazy Eddie's GUI Library.">CEGUI</a> will be wrapped with calls to Ogre::RenderSystem::_beginFrame and Ogre::RenderSystem::_endFrame. </p>
<p>This defaults to enabled and is required when using the default hook that automatically calls <a class="el" href="classCEGUI_1_1System.html#a27924df52d352bba7d18a20d9f4639a1" title="Render the GUI.">CEGUI::System::renderGUI</a> via a frame listener. If you disable this setting, the automated rendering will also be disabled, which is useful when you wish to perform your own calls to the <a class="el" href="classCEGUI_1_1System.html#a27924df52d352bba7d18a20d9f4639a1" title="Render the GUI.">CEGUI::System::renderGUI</a> function (and is the sole purpose for this setting).</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">enabled</td><td><ul>
<li>true if _beginFrame and _endFrame should be called.</li>
<li>false if _beginFrame and _endFrame should not be called (also disables default renderGUI call). </li>
</ul>
</td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Sun Jan 22 2012 16:07:42 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>
|
