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
|
<!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::OpenGLFBOTextureTarget 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_1OpenGLFBOTextureTarget.html">OpenGLFBOTextureTarget</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> |
<a href="#pro-static-attribs">Static Protected Attributes</a> </div>
<div class="headertitle">
<div class="title">CEGUI::OpenGLFBOTextureTarget Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="CEGUI::OpenGLFBOTextureTarget" --><!-- doxytag: inherits="CEGUI::OpenGLTextureTarget" -->
<p><a class="el" href="classCEGUI_1_1OpenGLFBOTextureTarget.html" title="OpenGLFBOTextureTarget - allows rendering to an OpenGL texture via FBO.">OpenGLFBOTextureTarget</a> - allows rendering to an OpenGL texture via FBO.
<a href="classCEGUI_1_1OpenGLFBOTextureTarget.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::OpenGLFBOTextureTarget:</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_1OpenGLFBOTextureTarget__inherit__graph.gif" border="0" usemap="#CEGUI_1_1OpenGLFBOTextureTarget_inherit__map" alt="Inheritance graph"/></div>
<map name="CEGUI_1_1OpenGLFBOTextureTarget_inherit__map" id="CEGUI_1_1OpenGLFBOTextureTarget_inherit__map">
<area shape="rect" id="node2" href="classCEGUI_1_1OpenGLTextureTarget.html" title="OpenGLTextureTarget - Common base class for all OpenGL render targets based on some form of RTT suppo..." alt="" coords="19,83,221,112"/><area shape="rect" id="node4" href="classCEGUI_1_1OpenGLRenderTarget.html" title="Intermediate OpenGL implementation of a RenderTarget." alt="" coords="20,5,220,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::OpenGLFBOTextureTarget:</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_1OpenGLFBOTextureTarget__coll__graph.gif" border="0" usemap="#CEGUI_1_1OpenGLFBOTextureTarget_coll__map" alt="Collaboration graph"/></div>
<map name="CEGUI_1_1OpenGLFBOTextureTarget_coll__map" id="CEGUI_1_1OpenGLFBOTextureTarget_coll__map">
<area shape="rect" id="node2" href="classCEGUI_1_1OpenGLTextureTarget.html" title="OpenGLTextureTarget - Common base class for all OpenGL render targets based on some form of RTT suppo..." alt="" coords="104,83,307,112"/><area shape="rect" id="node4" href="classCEGUI_1_1OpenGLRenderTarget.html" title="Intermediate OpenGL implementation of a RenderTarget." alt="" coords="5,5,205,35"/><area shape="rect" id="node6" href="classCEGUI_1_1TextureTarget.html" title="Specialisation of RenderTarget interface that should be used as the base class for RenderTargets that..." alt="" coords="229,5,384,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classCEGUI_1_1OpenGLFBOTextureTarget-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="a871f1cb0301de1ebf5fbbc62c8a4c05c"></a><!-- doxytag: member="CEGUI::OpenGLFBOTextureTarget::OpenGLFBOTextureTarget" ref="a871f1cb0301de1ebf5fbbc62c8a4c05c" args="(OpenGLRenderer &owner)" -->
 </td><td class="memItemRight" valign="bottom"><b>OpenGLFBOTextureTarget</b> (<a class="el" href="classCEGUI_1_1OpenGLRenderer.html">OpenGLRenderer</a> &owner)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OpenGLFBOTextureTarget.html#ab8c5dd172f6dc805d9fd15b80db972b2">activate</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Activate the render target and put it in a state ready to be drawn to. <a href="#ab8c5dd172f6dc805d9fd15b80db972b2"></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_1OpenGLFBOTextureTarget.html#ab865a6ea2f5e83aebc2408e13020798c">deactivate</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Deactivate the render target after having completed rendering. <a href="#ab865a6ea2f5e83aebc2408e13020798c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae114b37f0cc3c3f63384b9b9a91bf9a7"></a><!-- doxytag: member="CEGUI::OpenGLFBOTextureTarget::clear" ref="ae114b37f0cc3c3f63384b9b9a91bf9a7" args="()" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OpenGLFBOTextureTarget.html#ae114b37f0cc3c3f63384b9b9a91bf9a7">clear</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Clear the surface of the underlying texture. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OpenGLFBOTextureTarget.html#a4ceb84c60c57662a3989abe739502f49">declareRenderSize</a> (const <a class="el" href="classCEGUI_1_1Size.html">Size</a> &sz)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Used to declare to the <a class="el" href="classCEGUI_1_1TextureTarget.html" title="Specialisation of RenderTarget interface that should be used as the base class for RenderTargets that...">TextureTarget</a> the largest size, in pixels, of the next set of incoming rendering operations. <a href="#a4ceb84c60c57662a3989abe739502f49"></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_1OpenGLFBOTextureTarget.html#ab37869c230b77310709bfbb0d1643145">grabTexture</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Grab the texture to a local buffer. <a href="#ab37869c230b77310709bfbb0d1643145"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae7810b45f32a902176e74ee46d5efcb1"></a><!-- doxytag: member="CEGUI::OpenGLFBOTextureTarget::restoreTexture" ref="ae7810b45f32a902176e74ee46d5efcb1" args="()" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OpenGLFBOTextureTarget.html#ae7810b45f32a902176e74ee46d5efcb1">restoreTexture</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Restore the texture from the locally buffered copy previously create by a call to grabTexture. <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="af838268ca7ef65c9f8a8b4f642bfc0a4"></a><!-- doxytag: member="CEGUI::OpenGLFBOTextureTarget::initialiseRenderTexture" ref="af838268ca7ef65c9f8a8b4f642bfc0a4" args="()" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OpenGLFBOTextureTarget.html#af838268ca7ef65c9f8a8b4f642bfc0a4">initialiseRenderTexture</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">allocate and set up the texture used with the FBO. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a381e9c637cfe88c8fb7cb3e598523e14"></a><!-- doxytag: member="CEGUI::OpenGLFBOTextureTarget::resizeRenderTexture" ref="a381e9c637cfe88c8fb7cb3e598523e14" args="()" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OpenGLFBOTextureTarget.html#a381e9c637cfe88c8fb7cb3e598523e14">resizeRenderTexture</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">resize the texture <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="a8016db32d12e80840bbd20d6cfab562d"></a><!-- doxytag: member="CEGUI::OpenGLFBOTextureTarget::d_frameBuffer" ref="a8016db32d12e80840bbd20d6cfab562d" args="" -->
GLuint </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OpenGLFBOTextureTarget.html#a8016db32d12e80840bbd20d6cfab562d">d_frameBuffer</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Frame buffer object. <br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-static-attribs"></a>
Static Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7b59c069bf8ad9a231eb9ecfd9957e8b"></a><!-- doxytag: member="CEGUI::OpenGLFBOTextureTarget::DEFAULT_SIZE" ref="a7b59c069bf8ad9a231eb9ecfd9957e8b" args="" -->
static const float </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1OpenGLFBOTextureTarget.html#a7b59c069bf8ad9a231eb9ecfd9957e8b">DEFAULT_SIZE</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">default size of created texture objects <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_1OpenGLFBOTextureTarget.html" title="OpenGLFBOTextureTarget - allows rendering to an OpenGL texture via FBO.">OpenGLFBOTextureTarget</a> - allows rendering to an OpenGL texture via FBO. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ab8c5dd172f6dc805d9fd15b80db972b2"></a><!-- doxytag: member="CEGUI::OpenGLFBOTextureTarget::activate" ref="ab8c5dd172f6dc805d9fd15b80db972b2" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::OpenGLFBOTextureTarget::activate </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Activate the render target and put it in a state ready to be drawn to. </p>
<dl class="note"><dt><b>Note:</b></dt><dd>You MUST call this before doing any rendering - if you do not call this, in the unlikely event that your application actually works, it will likely stop working in some future version. </dd></dl>
<p>Reimplemented from <a class="el" href="classCEGUI_1_1OpenGLRenderTarget.html#a22e2783ac4304193a358a37c8549a175">CEGUI::OpenGLRenderTarget</a>.</p>
</div>
</div>
<a class="anchor" id="ab865a6ea2f5e83aebc2408e13020798c"></a><!-- doxytag: member="CEGUI::OpenGLFBOTextureTarget::deactivate" ref="ab865a6ea2f5e83aebc2408e13020798c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::OpenGLFBOTextureTarget::deactivate </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Deactivate the render target after having completed rendering. </p>
<dl class="note"><dt><b>Note:</b></dt><dd>You MUST call this after you finish rendering to the target - if you do not call this, in the unlikely event that your application actually works, it will likely stop working in some future version. </dd></dl>
<p>Reimplemented from <a class="el" href="classCEGUI_1_1OpenGLRenderTarget.html#a8413b5323c907f65c732a1af29629579">CEGUI::OpenGLRenderTarget</a>.</p>
</div>
</div>
<a class="anchor" id="a4ceb84c60c57662a3989abe739502f49"></a><!-- doxytag: member="CEGUI::OpenGLFBOTextureTarget::declareRenderSize" ref="a4ceb84c60c57662a3989abe739502f49" args="(const Size &sz)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::OpenGLFBOTextureTarget::declareRenderSize </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classCEGUI_1_1Size.html">Size</a> & </td>
<td class="paramname"><em>sz</em></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Used to declare to the <a class="el" href="classCEGUI_1_1TextureTarget.html" title="Specialisation of RenderTarget interface that should be used as the base class for RenderTargets that...">TextureTarget</a> the largest size, in pixels, of the next set of incoming rendering operations. </p>
<dl class="note"><dt><b>Note:</b></dt><dd>The main purpose of this is to allow for the implemenatation to resize the underlying texture so that it can hold the imagery that will be drawn.</dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">sz</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 largest area that will be rendererd in the next batch of rendering operations.</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>May be thrown if the <a class="el" href="classCEGUI_1_1TextureTarget.html" title="Specialisation of RenderTarget interface that should be used as the base class for RenderTargets that...">TextureTarget</a> would not be able to handle the operations rendering content of the given size. </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classCEGUI_1_1TextureTarget.html#ab9cdb8912667867c5c3443475838583c">CEGUI::TextureTarget</a>.</p>
</div>
</div>
<a class="anchor" id="ab37869c230b77310709bfbb0d1643145"></a><!-- doxytag: member="CEGUI::OpenGLFBOTextureTarget::grabTexture" ref="ab37869c230b77310709bfbb0d1643145" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::OpenGLFBOTextureTarget::grabTexture </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Grab the texture to a local buffer. </p>
<p>This will destroy the OpenGL texture, and restoreTexture must be called before using it again. </p>
<p>Reimplemented from <a class="el" href="classCEGUI_1_1OpenGLTextureTarget.html#ac30068b3ef91d37702308495abc6680d">CEGUI::OpenGLTextureTarget</a>.</p>
</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>
|
