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
|
<!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::RenderEffectManager 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_1RenderEffectManager.html">RenderEffectManager</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">CEGUI::RenderEffectManager Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="CEGUI::RenderEffectManager" --><!-- doxytag: inherits="Singleton< RenderEffectManager >" -->
<p><a class="el" href="classCEGUI_1_1Singleton.html">Singleton</a> class that manages creation and destruction of <a class="el" href="classCEGUI_1_1RenderEffect.html" title="Interface for objects that hook into RenderingWindow to affect the rendering process, thus allowing various effects to be achieved.">RenderEffect</a> based objects.
<a href="classCEGUI_1_1RenderEffectManager.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::RenderEffectManager:</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_1RenderEffectManager__inherit__graph.gif" border="0" usemap="#CEGUI_1_1RenderEffectManager_inherit__map" alt="Inheritance graph"/></div>
<map name="CEGUI_1_1RenderEffectManager_inherit__map" id="CEGUI_1_1RenderEffectManager_inherit__map">
<area shape="rect" id="node2" href="classCEGUI_1_1Singleton.html" title="CEGUI::Singleton\< RenderEffectManager \>" alt="" coords="5,5,283,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::RenderEffectManager:</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_1RenderEffectManager__coll__graph.gif" border="0" usemap="#CEGUI_1_1RenderEffectManager_coll__map" alt="Collaboration graph"/></div>
<map name="CEGUI_1_1RenderEffectManager_coll__map" id="CEGUI_1_1RenderEffectManager_coll__map">
<area shape="rect" id="node2" href="classCEGUI_1_1Singleton.html" title="CEGUI::Singleton\< RenderEffectManager \>" alt="" coords="5,101,283,131"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classCEGUI_1_1RenderEffectManager-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1cbf503c6ebfaaff9fd2c87ba40dcf46"></a><!-- doxytag: member="CEGUI::RenderEffectManager::RenderEffectIterator" ref="a1cbf503c6ebfaaff9fd2c87ba40dcf46" args="" -->
typedef <a class="el" href="classCEGUI_1_1ConstBaseIterator.html">ConstBaseIterator</a><br class="typebreak"/>
< RenderEffectRegistry > </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1RenderEffectManager.html#a1cbf503c6ebfaaff9fd2c87ba40dcf46">RenderEffectIterator</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Iterator type that iterates over entries in the RenderEffectRegistry. <br/></td></tr>
<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="afcf7758ecd126d9c8d8dd035fcdf3271"></a><!-- doxytag: member="CEGUI::RenderEffectManager::RenderEffectManager" ref="afcf7758ecd126d9c8d8dd035fcdf3271" args="()" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1RenderEffectManager.html#afcf7758ecd126d9c8d8dd035fcdf3271">RenderEffectManager</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor for <a class="el" href="classCEGUI_1_1RenderEffectManager.html" title="Singleton class that manages creation and destruction of RenderEffect based objects.">RenderEffectManager</a> objects. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a69b3d5f9f4dba7a53f54402420f9921f"></a><!-- doxytag: member="CEGUI::RenderEffectManager::~RenderEffectManager" ref="a69b3d5f9f4dba7a53f54402420f9921f" args="()" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1RenderEffectManager.html#a69b3d5f9f4dba7a53f54402420f9921f">~RenderEffectManager</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor for <a class="el" href="classCEGUI_1_1RenderEffectManager.html" title="Singleton class that manages creation and destruction of RenderEffect based objects.">RenderEffectManager</a> objects. <br/></td></tr>
<tr><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1RenderEffectManager.html#aa51ef62bdd574e475c9390237601a7b1">addEffect</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Register a <a class="el" href="classCEGUI_1_1RenderEffect.html" title="Interface for objects that hook into RenderingWindow to affect the rendering process, thus allowing various effects to be achieved.">RenderEffect</a> type with the system and associate it with the identifier <em>name</em>. <a href="#aa51ef62bdd574e475c9390237601a7b1"></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_1RenderEffectManager.html#a844e9979262add958ec07f6e2c565206">removeEffect</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove / unregister any <a class="el" href="classCEGUI_1_1RenderEffect.html" title="Interface for objects that hook into RenderingWindow to affect the rendering process, thus allowing various effects to be achieved.">RenderEffect</a> using the specified identifier. <a href="#a844e9979262add958ec07f6e2c565206"></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_1RenderEffectManager.html#a23fc24bd446d89e38dd760f4e36be6ed">isEffectAvailable</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &name) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return whether a <a class="el" href="classCEGUI_1_1RenderEffect.html" title="Interface for objects that hook into RenderingWindow to affect the rendering process, thus allowing various effects to be achieved.">RenderEffect</a> has been registered under the specified name. <a href="#a23fc24bd446d89e38dd760f4e36be6ed"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCEGUI_1_1RenderEffect.html">RenderEffect</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1RenderEffectManager.html#a891b80a9eb6d5dcde8883f1ff4d4ec50">create</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create an instance of the <a class="el" href="classCEGUI_1_1RenderEffect.html" title="Interface for objects that hook into RenderingWindow to affect the rendering process, thus allowing various effects to be achieved.">RenderEffect</a> based class identified by the specified name. <a href="#a891b80a9eb6d5dcde8883f1ff4d4ec50"></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_1RenderEffectManager.html#a03c899d94dd73aaf057ef32ecdec5b91">destroy</a> (<a class="el" href="classCEGUI_1_1RenderEffect.html">RenderEffect</a> &effect)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroy the given <a class="el" href="classCEGUI_1_1RenderEffect.html" title="Interface for objects that hook into RenderingWindow to affect the rendering process, thus allowing various effects to be achieved.">RenderEffect</a> object. <a href="#a03c899d94dd73aaf057ef32ecdec5b91"></a><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_1Singleton.html">Singleton</a> class that manages creation and destruction of <a class="el" href="classCEGUI_1_1RenderEffect.html" title="Interface for objects that hook into RenderingWindow to affect the rendering process, thus allowing various effects to be achieved.">RenderEffect</a> based objects. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aa51ef62bdd574e475c9390237601a7b1"></a><!-- doxytag: member="CEGUI::RenderEffectManager::addEffect" ref="aa51ef62bdd574e475c9390237601a7b1" args="(const String &name)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T > </div>
<table class="memname">
<tr>
<td class="memname">void CEGUI::RenderEffectManager::addEffect </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>name</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Register a <a class="el" href="classCEGUI_1_1RenderEffect.html" title="Interface for objects that hook into RenderingWindow to affect the rendering process, thus allowing various effects to be achieved.">RenderEffect</a> type with the system and associate it with the identifier <em>name</em>. </p>
<p>This registers a <a class="el" href="classCEGUI_1_1RenderEffect.html" title="Interface for objects that hook into RenderingWindow to affect the rendering process, thus allowing various effects to be achieved.">RenderEffect</a> based class, such that instances of that class can subsequently be created by requesting an effect using the specified identifier.</p>
<dl><dt><b>Template Parameters:</b></dt><dd>
<table class="">
<tr><td class="paramname">T</td><td>The <a class="el" href="classCEGUI_1_1RenderEffect.html" title="Interface for objects that hook into RenderingWindow to affect the rendering process, thus allowing various effects to be achieved.">RenderEffect</a> based class to be instantiated when an effect is requested using the identifier <em>name</em>.</td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object describing the identifier that the <a class="el" href="classCEGUI_1_1RenderEffect.html" title="Interface for objects that hook into RenderingWindow to affect the rendering process, thus allowing various effects to be achieved.">RenderEffect</a> based class will be registered under.</td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Exceptions:</b></dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classCEGUI_1_1AlreadyExistsException.html" title="Exception class used when an attempt is made create a named object of a particular type when an objec...">AlreadyExistsException</a></td><td>thrown if a <a class="el" href="classCEGUI_1_1RenderEffect.html" title="Interface for objects that hook into RenderingWindow to affect the rendering process, thus allowing various effects to be achieved.">RenderEffect</a> is already registered using <em>name</em>. </td></tr>
</table>
</dd>
</dl>
<p>References <a class="el" href="classCEGUI_1_1RenderEffectManager.html#a23fc24bd446d89e38dd760f4e36be6ed">isEffectAvailable()</a>.</p>
</div>
</div>
<a class="anchor" id="a891b80a9eb6d5dcde8883f1ff4d4ec50"></a><!-- doxytag: member="CEGUI::RenderEffectManager::create" ref="a891b80a9eb6d5dcde8883f1ff4d4ec50" args="(const String &name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCEGUI_1_1RenderEffect.html">RenderEffect</a>& CEGUI::RenderEffectManager::create </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>name</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create an instance of the <a class="el" href="classCEGUI_1_1RenderEffect.html" title="Interface for objects that hook into RenderingWindow to affect the rendering process, thus allowing various effects to be achieved.">RenderEffect</a> based class identified by the specified name. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object describing the identifier of the <a class="el" href="classCEGUI_1_1RenderEffect.html" title="Interface for objects that hook into RenderingWindow to affect the rendering process, thus allowing various effects to be achieved.">RenderEffect</a> based class that is to be created.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Reference to the newly created <a class="el" href="classCEGUI_1_1RenderEffect.html" title="Interface for objects that hook into RenderingWindow to affect the rendering process, thus allowing various effects to be achieved.">RenderEffect</a>.</dd></dl>
<dl><dt><b>Exceptions:</b></dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classCEGUI_1_1UnknownObjectException.html" title="Exception class used when a request was made for an unknown object.">UnknownObjectException</a></td><td>thrown if no <a class="el" href="classCEGUI_1_1RenderEffect.html" title="Interface for objects that hook into RenderingWindow to affect the rendering process, thus allowing various effects to be achieved.">RenderEffect</a> class has been registered using the identifier <em>name</em>. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a03c899d94dd73aaf057ef32ecdec5b91"></a><!-- doxytag: member="CEGUI::RenderEffectManager::destroy" ref="a03c899d94dd73aaf057ef32ecdec5b91" args="(RenderEffect &effect)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::RenderEffectManager::destroy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCEGUI_1_1RenderEffect.html">RenderEffect</a> & </td>
<td class="paramname"><em>effect</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destroy the given <a class="el" href="classCEGUI_1_1RenderEffect.html" title="Interface for objects that hook into RenderingWindow to affect the rendering process, thus allowing various effects to be achieved.">RenderEffect</a> object. </p>
<dl class="note"><dt><b>Note:</b></dt><dd>This function will only destroy objects that were created via the <a class="el" href="classCEGUI_1_1RenderEffectManager.html" title="Singleton class that manages creation and destruction of RenderEffect based objects.">RenderEffectManager</a>. Attempts to destroy objects created by other means will result in an <a class="el" href="classCEGUI_1_1InvalidRequestException.html" title="Exception class used when some impossible request was made of the system.">InvalidRequestException</a>. This option was chosen over silently ignoring the request in order to aid application developers in thier debugging.</dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">effect</td><td>Reference to the <a class="el" href="classCEGUI_1_1RenderEffect.html" title="Interface for objects that hook into RenderingWindow to affect the rendering process, thus allowing various effects to be achieved.">RenderEffect</a> object that is to be destroyed.</td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Exceptions:</b></dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classCEGUI_1_1InvalidRequestException.html" title="Exception class used when some impossible request was made of the system.">InvalidRequestException</a></td><td>thrown if <em>effect</em> was not created by the <a class="el" href="classCEGUI_1_1RenderEffectManager.html" title="Singleton class that manages creation and destruction of RenderEffect based objects.">RenderEffectManager</a>. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a23fc24bd446d89e38dd760f4e36be6ed"></a><!-- doxytag: member="CEGUI::RenderEffectManager::isEffectAvailable" ref="a23fc24bd446d89e38dd760f4e36be6ed" args="(const String &name) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool CEGUI::RenderEffectManager::isEffectAvailable </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>name</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return whether a <a class="el" href="classCEGUI_1_1RenderEffect.html" title="Interface for objects that hook into RenderingWindow to affect the rendering process, thus allowing various effects to be achieved.">RenderEffect</a> has been registered under the specified name. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object describing the identifier of a <a class="el" href="classCEGUI_1_1RenderEffect.html" title="Interface for objects that hook into RenderingWindow to affect the rendering process, thus allowing various effects to be achieved.">RenderEffect</a> to test for.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><ul>
<li>true if a <a class="el" href="classCEGUI_1_1RenderEffect.html" title="Interface for objects that hook into RenderingWindow to affect the rendering process, thus allowing various effects to be achieved.">RenderEffect</a> with the specified name is registered.</li>
<li>false if no <a class="el" href="classCEGUI_1_1RenderEffect.html" title="Interface for objects that hook into RenderingWindow to affect the rendering process, thus allowing various effects to be achieved.">RenderEffect</a> with the specified name is registered. </li>
</ul>
</dd></dl>
<p>Referenced by <a class="el" href="classCEGUI_1_1RenderEffectManager.html#aa51ef62bdd574e475c9390237601a7b1">addEffect()</a>.</p>
</div>
</div>
<a class="anchor" id="a844e9979262add958ec07f6e2c565206"></a><!-- doxytag: member="CEGUI::RenderEffectManager::removeEffect" ref="a844e9979262add958ec07f6e2c565206" args="(const String &name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::RenderEffectManager::removeEffect </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1String.html">String</a> & </td>
<td class="paramname"><em>name</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Remove / unregister any <a class="el" href="classCEGUI_1_1RenderEffect.html" title="Interface for objects that hook into RenderingWindow to affect the rendering process, thus allowing various effects to be achieved.">RenderEffect</a> using the specified identifier. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td><a class="el" href="classCEGUI_1_1String.html" title="String class used within the GUI system.">String</a> object describing the identifier of the <a class="el" href="classCEGUI_1_1RenderEffect.html" title="Interface for objects that hook into RenderingWindow to affect the rendering process, thus allowing various effects to be achieved.">RenderEffect</a> that is to be removed / unregistered. If no such <a class="el" href="classCEGUI_1_1RenderEffect.html" title="Interface for objects that hook into RenderingWindow to affect the rendering process, thus allowing various effects to be achieved.">RenderEffect</a> is present, no action is taken.</td></tr>
</table>
</dd>
</dl>
<dl class="note"><dt><b>Note:</b></dt><dd>You should avoid removing <a class="el" href="classCEGUI_1_1RenderEffect.html" title="Interface for objects that hook into RenderingWindow to affect the rendering process, thus allowing various effects to be achieved.">RenderEffect</a> types that are still in use. Internally a factory system is employed for the creation and deletion of <a class="el" href="classCEGUI_1_1RenderEffect.html" title="Interface for objects that hook into RenderingWindow to affect the rendering process, thus allowing various effects to be achieved.">RenderEffect</a> objects; if an effect - and therefore it's factory - is removed while instances are still active, it will not be possible to safely delete those <a class="el" href="classCEGUI_1_1RenderEffect.html" title="Interface for objects that hook into RenderingWindow to affect the rendering process, thus allowing various effects to be achieved.">RenderEffect</a> object instances. </dd></dl>
</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>
|
