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
|
<!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::RenderEffect 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_1RenderEffect.html">RenderEffect</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">CEGUI::RenderEffect Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="CEGUI::RenderEffect" -->
<p>Interface for objects that hook into <a class="el" href="classCEGUI_1_1RenderingWindow.html" title="RenderingWindow is a RenderingSurface that can be "drawn back" onto another RenderingSurface and is p...">RenderingWindow</a> to affect the rendering process, thus allowing various effects to be achieved.
<a href="classCEGUI_1_1RenderEffect.html#details">More...</a></p>
<p><a href="classCEGUI_1_1RenderEffect-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">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1RenderEffect.html#a127c032796a5f6f7b0111d2419ff44a6">getPassCount</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the number of passes required by this effect. <a href="#a127c032796a5f6f7b0111d2419ff44a6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1RenderEffect.html#a11ca61fa9222b42ba1b7e9bf17d4545a">performPreRenderFunctions</a> (const int pass)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Function called prior to <a class="el" href="classCEGUI_1_1RenderingWindow.html#ac1eaab08f25c84eb029e212212bc8fbe" title="Draw the GeometryBuffers for all rendering queues to the RenderTarget that this RenderingSurface is t...">RenderingWindow::draw</a> being called. This is intended to be used for any required setup / state initialisation and is called once for each pass in the effect. <a href="#a11ca61fa9222b42ba1b7e9bf17d4545a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1RenderEffect.html#aced60d0dea94f4d45a84a933701cea59">performPostRenderFunctions</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Function called after <a class="el" href="classCEGUI_1_1RenderingWindow.html#ac1eaab08f25c84eb029e212212bc8fbe" title="Draw the GeometryBuffers for all rendering queues to the RenderTarget that this RenderingSurface is t...">RenderingWindow::draw</a> is called. This is intended to be used for any required cleanup / state restoration. This function is called <em>once only</em>, unlike performPreRenderFunctions which may be called multiple times; once for each pass in the effect. <a href="#aced60d0dea94f4d45a84a933701cea59"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1RenderEffect.html#a7ec414a973302bcde846f5b9bdeb389d">realiseGeometry</a> (<a class="el" href="classCEGUI_1_1RenderingWindow.html">RenderingWindow</a> &window, <a class="el" href="classCEGUI_1_1GeometryBuffer.html">GeometryBuffer</a> &geometry)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Function called to generate geometry for the <a class="el" href="classCEGUI_1_1RenderingWindow.html" title="RenderingWindow is a RenderingSurface that can be "drawn back" onto another RenderingSurface and is p...">RenderingWindow</a>. <a href="#a7ec414a973302bcde846f5b9bdeb389d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1RenderEffect.html#a21f88ea99cc15ae22e2b1d0863e07a08">update</a> (const float elapsed, <a class="el" href="classCEGUI_1_1RenderingWindow.html">RenderingWindow</a> &window)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Function called to perform any time based updates on 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> state. <a href="#a21f88ea99cc15ae22e2b1d0863e07a08"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Interface for objects that hook into <a class="el" href="classCEGUI_1_1RenderingWindow.html" title="RenderingWindow is a RenderingSurface that can be "drawn back" onto another RenderingSurface and is p...">RenderingWindow</a> to affect the rendering process, thus allowing various effects to be achieved. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a127c032796a5f6f7b0111d2419ff44a6"></a><!-- doxytag: member="CEGUI::RenderEffect::getPassCount" ref="a127c032796a5f6f7b0111d2419ff44a6" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int CEGUI::RenderEffect::getPassCount </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the number of passes required by this effect. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>integer value indicating the number of rendering passes required to fully render this effect. </dd></dl>
</div>
</div>
<a class="anchor" id="aced60d0dea94f4d45a84a933701cea59"></a><!-- doxytag: member="CEGUI::RenderEffect::performPostRenderFunctions" ref="aced60d0dea94f4d45a84a933701cea59" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void CEGUI::RenderEffect::performPostRenderFunctions </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Function called after <a class="el" href="classCEGUI_1_1RenderingWindow.html#ac1eaab08f25c84eb029e212212bc8fbe" title="Draw the GeometryBuffers for all rendering queues to the RenderTarget that this RenderingSurface is t...">RenderingWindow::draw</a> is called. This is intended to be used for any required cleanup / state restoration. This function is called <em>once only</em>, unlike performPreRenderFunctions which may be called multiple times; once for each pass in the effect. </p>
<dl class="note"><dt><b>Note:</b></dt><dd>Note that this function is called <em>before</em> any standard state cleanup that might be peformed by the <a class="el" href="classCEGUI_1_1Renderer.html" title="Abstract class defining the basic required interface for Renderer objects.">Renderer</a> module. </dd></dl>
</div>
</div>
<a class="anchor" id="a11ca61fa9222b42ba1b7e9bf17d4545a"></a><!-- doxytag: member="CEGUI::RenderEffect::performPreRenderFunctions" ref="a11ca61fa9222b42ba1b7e9bf17d4545a" args="(const int pass)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void CEGUI::RenderEffect::performPreRenderFunctions </td>
<td>(</td>
<td class="paramtype">const int </td>
<td class="paramname"><em>pass</em></td><td>)</td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Function called prior to <a class="el" href="classCEGUI_1_1RenderingWindow.html#ac1eaab08f25c84eb029e212212bc8fbe" title="Draw the GeometryBuffers for all rendering queues to the RenderTarget that this RenderingSurface is t...">RenderingWindow::draw</a> being called. This is intended to be used for any required setup / state initialisation and is called once for each pass in the effect. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">pass</td><td>Indicates the pass number to be initialised (starting at pass 0).</td></tr>
</table>
</dd>
</dl>
<dl class="note"><dt><b>Note:</b></dt><dd>Note that this function is called <em>after</em> any standard state initialisation that might be peformed by the <a class="el" href="classCEGUI_1_1Renderer.html" title="Abstract class defining the basic required interface for Renderer objects.">Renderer</a> module. </dd></dl>
</div>
</div>
<a class="anchor" id="a7ec414a973302bcde846f5b9bdeb389d"></a><!-- doxytag: member="CEGUI::RenderEffect::realiseGeometry" ref="a7ec414a973302bcde846f5b9bdeb389d" args="(RenderingWindow &window, GeometryBuffer &geometry)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool CEGUI::RenderEffect::realiseGeometry </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCEGUI_1_1RenderingWindow.html">RenderingWindow</a> & </td>
<td class="paramname"><em>window</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classCEGUI_1_1GeometryBuffer.html">GeometryBuffer</a> & </td>
<td class="paramname"><em>geometry</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Function called to generate geometry for the <a class="el" href="classCEGUI_1_1RenderingWindow.html" title="RenderingWindow is a RenderingSurface that can be "drawn back" onto another RenderingSurface and is p...">RenderingWindow</a>. </p>
<p>The geometry generated should be fully unclipped and window local. The origin for the geometry is located at the top-left corner.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">window</td><td>The <a class="el" href="classCEGUI_1_1RenderingWindow.html" title="RenderingWindow is a RenderingSurface that can be "drawn back" onto another RenderingSurface and is p...">RenderingWindow</a> object that is being processed.</td></tr>
<tr><td class="paramname">geometry</td><td><a class="el" href="classCEGUI_1_1GeometryBuffer.html" title="Abstract class defining the interface for objects that buffer geometry for later rendering.">GeometryBuffer</a> object where the generated geometry should be added. This object will be cleared before this function is invoked.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>boolean value indicating whether the <a class="el" href="classCEGUI_1_1RenderingWindow.html" title="RenderingWindow is a RenderingSurface that can be "drawn back" onto another RenderingSurface and is p...">RenderingWindow</a> should generate it's own geometry.<ul>
<li>true if the <a class="el" href="classCEGUI_1_1RenderingWindow.html" title="RenderingWindow is a RenderingSurface that can be "drawn back" onto another RenderingSurface and is p...">RenderingWindow</a> should generate it's own geometry. You will usually only return true if you do not need to use custom geometry.</li>
<li>false if you have added any required geometry needed to represent the <a class="el" href="classCEGUI_1_1RenderingWindow.html" title="RenderingWindow is a RenderingSurface that can be "drawn back" onto another RenderingSurface and is p...">RenderingWindow</a>. </li>
</ul>
</dd></dl>
</div>
</div>
<a class="anchor" id="a21f88ea99cc15ae22e2b1d0863e07a08"></a><!-- doxytag: member="CEGUI::RenderEffect::update" ref="a21f88ea99cc15ae22e2b1d0863e07a08" args="(const float elapsed, RenderingWindow &window)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool CEGUI::RenderEffect::update </td>
<td>(</td>
<td class="paramtype">const float </td>
<td class="paramname"><em>elapsed</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classCEGUI_1_1RenderingWindow.html">RenderingWindow</a> & </td>
<td class="paramname"><em>window</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Function called to perform any time based updates on 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> state. </p>
<dl class="note"><dt><b>Note:</b></dt><dd>This function should only affect the internal state 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> object. This function should definitely <em>not</em> be used to directly affect any render states of the underlying rendering API or engine.</dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">elapsed</td><td>The number of seconds that have elapsed since the last time this function was called.</td></tr>
<tr><td class="paramname">window</td><td><a class="el" href="classCEGUI_1_1RenderingWindow.html" title="RenderingWindow is a RenderingSurface that can be "drawn back" onto another RenderingSurface and is p...">RenderingWindow</a> object that 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> is being applied to.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>boolean that indicates whether the window geometry will still be valid after the update. </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>
|
