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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>SFML - Simple and Fast Multimedia Library</title>
<meta http-equiv="Content-Type" content="text/html;charset=UTF-8" />
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="tabs.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="logo">
<img src="./logo.jpg" width="770" height="200" title="SFML home" alt="SFML logo" />
</div>
<!-- Generated by Doxygen 1.5.2 -->
<div class="tabs">
<ul>
<li><a href="index.htm"><span>Main Page</span></a></li>
<li><a href="namespaces.htm"><span>Namespaces</span></a></li>
<li class="current"><a href="classes.htm"><span>Classes</span></a></li>
<li><a href="files.htm"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="classes.htm"><span>Alphabetical List</span></a></li>
<li><a href="annotated.htm"><span>Class List</span></a></li>
<li><a href="hierarchy.htm"><span>Class Hierarchy</span></a></li>
<li><a href="functions.htm"><span>Class Members</span></a></li>
</ul>
</div>
<div class="nav">
<a class="el" href="namespacesf.htm">sf</a>::<a class="el" href="classsf_1_1RenderTarget.htm">RenderTarget</a></div>
<h1>sf::RenderTarget Class Reference</h1><!-- doxytag: class="sf::RenderTarget" -->Base class for all render targets (window, image, .
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="RenderTarget_8hpp-source.htm">RenderTarget.hpp</a>></code>
<p>
<p>Inheritance diagram for sf::RenderTarget:
<p><center><img src="classsf_1_1RenderTarget.png" usemap="#sf::RenderTarget_map" border="0" alt=""></center>
<map name="sf::RenderTarget_map">
<area href="classsf_1_1RenderWindow.htm" alt="sf::RenderWindow" shape="rect" coords="0,56,113,80">
</map>
<a href="classsf_1_1RenderTarget-members.htm">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1RenderTarget.htm#9abd1654a99fba46f6887b9c625b9b06">~RenderTarget</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#9abd1654a99fba46f6887b9c625b9b06"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1RenderTarget.htm#125645088d7b2df07599ea36fbb8b87e">Clear</a> (const <a class="el" href="classsf_1_1Color.htm">Color</a> &FillColor=<a class="el" href="classsf_1_1Color.htm">Color</a>(0, 0, 0))</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Clear the entire target with a single color. <a href="#125645088d7b2df07599ea36fbb8b87e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1RenderTarget.htm#c7c8b8d0ed6d9a0e2f0815283e5976d2">Draw</a> (const <a class="el" href="classsf_1_1Drawable.htm">Drawable</a> &Object)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Draw something into the target. <a href="#c7c8b8d0ed6d9a0e2f0815283e5976d2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1RenderTarget.htm#13d20cb17fb85bb02deefff539159ed5">GetWidth</a> () const=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the width of the rendering region of the target. <a href="#13d20cb17fb85bb02deefff539159ed5"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1RenderTarget.htm#55dd177b958fbf64098efee80ea4bd03">GetHeight</a> () const=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the height of the rendering region of the target. <a href="#55dd177b958fbf64098efee80ea4bd03"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1RenderTarget.htm#7060ca19e685d8d5b7c6f5dd9b5906e1">SetView</a> (const <a class="el" href="classsf_1_1View.htm">View</a> &NewView)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Change the current active view. <a href="#7060ca19e685d8d5b7c6f5dd9b5906e1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classsf_1_1View.htm">View</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1RenderTarget.htm#bbf7a5dfeaa414a861a2e6016e81fbd3">GetView</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the current view. <a href="#bbf7a5dfeaa414a861a2e6016e81fbd3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classsf_1_1View.htm">View</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1RenderTarget.htm#66d7c2b04d33d3a22f585a3fc39e7fa0">GetDefaultView</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the default view of the window for read / write. <a href="#66d7c2b04d33d3a22f585a3fc39e7fa0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1RenderTarget.htm#b763d16f00166b516fead600d8824c71">PreserveOpenGLStates</a> (bool Preserve)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Tell SFML to preserve external OpenGL states, at the expense of more CPU charge. <a href="#b763d16f00166b516fead600d8824c71"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1RenderTarget.htm#2997c96cbd93cb8ce0aba2ddae35b86f">RenderTarget</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#2997c96cbd93cb8ce0aba2ddae35b86f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1RenderTarget.htm#3d9265548b6903ab7f645d12177bba24">Initialize</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Called by the derived class when it's ready to be initialized. <a href="#3d9265548b6903ab7f645d12177bba24"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Base class for all render targets (window, image, .
<p>
..)
<p>
<p>
Definition at line <a class="el" href="RenderTarget_8hpp-source.htm#l00043">43</a> of file <a class="el" href="RenderTarget_8hpp-source.htm">RenderTarget.hpp</a>.<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="9abd1654a99fba46f6887b9c625b9b06"></a><!-- doxytag: member="sf::RenderTarget::~RenderTarget" ref="9abd1654a99fba46f6887b9c625b9b06" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual sf::RenderTarget::~RenderTarget </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destructor.
<p>
</div>
</div><p>
<a class="anchor" name="2997c96cbd93cb8ce0aba2ddae35b86f"></a><!-- doxytag: member="sf::RenderTarget::RenderTarget" ref="2997c96cbd93cb8ce0aba2ddae35b86f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">sf::RenderTarget::RenderTarget </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Default constructor.
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="125645088d7b2df07599ea36fbb8b87e"></a><!-- doxytag: member="sf::RenderTarget::Clear" ref="125645088d7b2df07599ea36fbb8b87e" args="(const Color &FillColor=Color(0, 0, 0))" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void sf::RenderTarget::Clear </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classsf_1_1Color.htm">Color</a> & </td>
<td class="paramname"> <em>FillColor</em> = <code><a class="el" href="classsf_1_1Color.htm">Color</a>(0, 0, 0)</code> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Clear the entire target with a single color.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>FillColor</em> </td><td>: <a class="el" href="classsf_1_1Color.htm" title="Color is an utility class for manipulating 32-bits RGBA colors.">Color</a> to use to clear the render target </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="c7c8b8d0ed6d9a0e2f0815283e5976d2"></a><!-- doxytag: member="sf::RenderTarget::Draw" ref="c7c8b8d0ed6d9a0e2f0815283e5976d2" args="(const Drawable &Object)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void sf::RenderTarget::Draw </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classsf_1_1Drawable.htm">Drawable</a> & </td>
<td class="paramname"> <em>Object</em> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Draw something into the target.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>Object</em> </td><td>: Object to draw </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="13d20cb17fb85bb02deefff539159ed5"></a><!-- doxytag: member="sf::RenderTarget::GetWidth" ref="13d20cb17fb85bb02deefff539159ed5" args="() const=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual unsigned int sf::RenderTarget::GetWidth </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the width of the rendering region of the target.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Width in pixels </dd></dl>
<p>
Implemented in <a class="el" href="classsf_1_1RenderWindow.htm#563dc5548136c568b9c13de4100ee6fa">sf::RenderWindow</a>.
</div>
</div><p>
<a class="anchor" name="55dd177b958fbf64098efee80ea4bd03"></a><!-- doxytag: member="sf::RenderTarget::GetHeight" ref="55dd177b958fbf64098efee80ea4bd03" args="() const=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual unsigned int sf::RenderTarget::GetHeight </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the height of the rendering region of the target.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Height in pixels </dd></dl>
<p>
Implemented in <a class="el" href="classsf_1_1RenderWindow.htm#e7d6a805bd1be3c941a632a9c921d5fc">sf::RenderWindow</a>.
</div>
</div><p>
<a class="anchor" name="7060ca19e685d8d5b7c6f5dd9b5906e1"></a><!-- doxytag: member="sf::RenderTarget::SetView" ref="7060ca19e685d8d5b7c6f5dd9b5906e1" args="(const View &NewView)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void sf::RenderTarget::SetView </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classsf_1_1View.htm">View</a> & </td>
<td class="paramname"> <em>NewView</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Change the current active view.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>NewView</em> </td><td>: New view to use (pass <a class="el" href="classsf_1_1RenderTarget.htm#66d7c2b04d33d3a22f585a3fc39e7fa0" title="Get the default view of the window for read / write.">GetDefaultView()</a> to set the default view) </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="bbf7a5dfeaa414a861a2e6016e81fbd3"></a><!-- doxytag: member="sf::RenderTarget::GetView" ref="bbf7a5dfeaa414a861a2e6016e81fbd3" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classsf_1_1View.htm">View</a>& sf::RenderTarget::GetView </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the current view.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Current view active in the window </dd></dl>
</div>
</div><p>
<a class="anchor" name="66d7c2b04d33d3a22f585a3fc39e7fa0"></a><!-- doxytag: member="sf::RenderTarget::GetDefaultView" ref="66d7c2b04d33d3a22f585a3fc39e7fa0" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classsf_1_1View.htm">View</a>& sf::RenderTarget::GetDefaultView </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the default view of the window for read / write.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Default view </dd></dl>
</div>
</div><p>
<a class="anchor" name="b763d16f00166b516fead600d8824c71"></a><!-- doxytag: member="sf::RenderTarget::PreserveOpenGLStates" ref="b763d16f00166b516fead600d8824c71" args="(bool Preserve)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void sf::RenderTarget::PreserveOpenGLStates </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>Preserve</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Tell SFML to preserve external OpenGL states, at the expense of more CPU charge.
<p>
Use this function if you don't want SFML to mess up your own OpenGL states (if any). Don't enable state preservation if not needed, as it will allow SFML to do internal optimizations and improve performances. This parameter is false by default<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>Preserve</em> </td><td>: True to preserve OpenGL states, false to let SFML optimize </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="3d9265548b6903ab7f645d12177bba24"></a><!-- doxytag: member="sf::RenderTarget::Initialize" ref="3d9265548b6903ab7f645d12177bba24" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void sf::RenderTarget::Initialize </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Called by the derived class when it's ready to be initialized.
<p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="RenderTarget_8hpp-source.htm">RenderTarget.hpp</a></ul>
<p id="footer">
:: Copyright © 2007-2008 Laurent Gomila, all rights reserved ::
Documentation generated by <a href="http://www.doxygen.org/" title="doxygen website">doxygen 1.5.2</a> ::
</p>
</body>
</html>
|
