blob: 8f8471307e90f5e40012a2e905d666e80e5edf70 (
plain)
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
|
<!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.8 -->
<div class="navigation" id="top">
<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="annotated.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="annotated.htm"><span>Class List</span></a></li>
<li><a href="classes.htm"><span>Class Index</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="navpath"><b>sf</b>::<a class="el" href="classsf_1_1ResourcePtr.htm">ResourcePtr</a>
</div>
</div>
<div class="contents">
<h1>sf::ResourcePtr< T > Class Template Reference</h1><!-- doxytag: class="sf::ResourcePtr" -->Safe pointer to a T resource (inheriting from sf::Resource<T>), its pointer is automatically reseted when the resource is destroyed.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="Resource_8hpp-source.htm">Resource.hpp</a>></code>
<p>
<p>
<a href="classsf_1_1ResourcePtr-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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1ResourcePtr.htm#48ddcd15ed75e9ee3ea88e4d29402140">ResourcePtr</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#48ddcd15ed75e9ee3ea88e4d29402140"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1ResourcePtr.htm#86ce8beb23f6c4d32e79192a39207c1e">ResourcePtr</a> (const T *<a class="el" href="classsf_1_1Resource.htm">Resource</a>)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct from a raw resource. <a href="#86ce8beb23f6c4d32e79192a39207c1e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1ResourcePtr.htm#d773b258e867b27f654673fa2147728b">ResourcePtr</a> (const <a class="el" href="classsf_1_1ResourcePtr.htm">ResourcePtr</a>< T > &Copy)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <a href="#d773b258e867b27f654673fa2147728b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1ResourcePtr.htm#0ec69fdecccd1240030b24385f6884dd">~ResourcePtr</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#0ec69fdecccd1240030b24385f6884dd"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classsf_1_1ResourcePtr.htm">ResourcePtr</a>< T > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1ResourcePtr.htm#efd17640cfe8d96934435fb8f2b40574">operator=</a> (const <a class="el" href="classsf_1_1ResourcePtr.htm">ResourcePtr</a>< T > &Other)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Assignment operator from another <a class="el" href="classsf_1_1ResourcePtr.htm" title="Safe pointer to a T resource (inheriting from sf::Resource<T>), its pointer...">ResourcePtr</a>. <a href="#efd17640cfe8d96934435fb8f2b40574"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classsf_1_1ResourcePtr.htm">ResourcePtr</a>< T > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1ResourcePtr.htm#23a9350a7565a26f0cc1bbadb917248d">operator=</a> (const T *<a class="el" href="classsf_1_1Resource.htm">Resource</a>)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Assignment operator from a raw resource. <a href="#23a9350a7565a26f0cc1bbadb917248d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1ResourcePtr.htm#7af0f407f121bff6e4dcf71c7c7955de">operator const T *</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Cast operator to implicitely convert the resource pointer to its raw pointer type. <a href="#7af0f407f121bff6e4dcf71c7c7955de"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const T & </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1ResourcePtr.htm#4e5401c5a07347a35cc3b9192e11b071">operator*</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Operator * overload to return a reference to the actual resource. <a href="#4e5401c5a07347a35cc3b9192e11b071"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const T * </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1ResourcePtr.htm#e58ea517eee0a97a778c3c59e4c3fe3a">operator-></a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Operator -> overload to return a pointer to the actual resource. <a href="#e58ea517eee0a97a778c3c59e4c3fe3a"></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_1ResourcePtr.htm#e7e9d9ed819db0f541a7c22f5a28abf9">OnResourceDestroyed</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Function called when the observed resource is about to be destroyed. <a href="#e7e9d9ed819db0f541a7c22f5a28abf9"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template<typename T><br>
class sf::ResourcePtr< T ></h3>
Safe pointer to a T resource (inheriting from sf::Resource<T>), its pointer is automatically reseted when the resource is destroyed.
<p>Definition at line <a class="el" href="Resource_8hpp-source.htm#l00116">116</a> of file <a class="el" href="Resource_8hpp-source.htm">Resource.hpp</a>.</p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="48ddcd15ed75e9ee3ea88e4d29402140"></a><!-- doxytag: member="sf::ResourcePtr::ResourcePtr" ref="48ddcd15ed75e9ee3ea88e4d29402140" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classsf_1_1ResourcePtr.htm">sf::ResourcePtr</a>< T >::<a class="el" href="classsf_1_1ResourcePtr.htm">ResourcePtr</a> </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Default constructor.
<p>
</div>
</div><p>
<a class="anchor" name="86ce8beb23f6c4d32e79192a39207c1e"></a><!-- doxytag: member="sf::ResourcePtr::ResourcePtr" ref="86ce8beb23f6c4d32e79192a39207c1e" args="(const T *Resource)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classsf_1_1ResourcePtr.htm">sf::ResourcePtr</a>< T >::<a class="el" href="classsf_1_1ResourcePtr.htm">ResourcePtr</a> </td>
<td>(</td>
<td class="paramtype">const T * </td>
<td class="paramname"> <em>Resource</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Construct from a raw resource.
<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><a class="el" href="classsf_1_1Resource.htm" title="Base class for every resource that needs to notify dependent classes about its destruction...">Resource</a></em> </td><td>: Internal resource </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="d773b258e867b27f654673fa2147728b"></a><!-- doxytag: member="sf::ResourcePtr::ResourcePtr" ref="d773b258e867b27f654673fa2147728b" args="(const ResourcePtr< T > &Copy)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classsf_1_1ResourcePtr.htm">sf::ResourcePtr</a>< T >::<a class="el" href="classsf_1_1ResourcePtr.htm">ResourcePtr</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classsf_1_1ResourcePtr.htm">ResourcePtr</a>< T > & </td>
<td class="paramname"> <em>Copy</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Copy constructor.
<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>Copy</em> </td><td>: Instance to copy </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="0ec69fdecccd1240030b24385f6884dd"></a><!-- doxytag: member="sf::ResourcePtr::~ResourcePtr" ref="0ec69fdecccd1240030b24385f6884dd" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classsf_1_1ResourcePtr.htm">sf::ResourcePtr</a>< T >::~<a class="el" href="classsf_1_1ResourcePtr.htm">ResourcePtr</a> </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destructor.
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="e7e9d9ed819db0f541a7c22f5a28abf9"></a><!-- doxytag: member="sf::ResourcePtr::OnResourceDestroyed" ref="e7e9d9ed819db0f541a7c22f5a28abf9" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T> </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classsf_1_1ResourcePtr.htm">sf::ResourcePtr</a>< T >::OnResourceDestroyed </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Function called when the observed resource is about to be destroyed.
<p>
</div>
</div><p>
<a class="anchor" name="7af0f407f121bff6e4dcf71c7c7955de"></a><!-- doxytag: member="sf::ResourcePtr::operator const T *" ref="7af0f407f121bff6e4dcf71c7c7955de" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classsf_1_1ResourcePtr.htm">sf::ResourcePtr</a>< T >::operator const T * </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Cast operator to implicitely convert the resource pointer to its raw pointer type.
<p>
This might be dangerous in the general case, but in this context it is safe enough to define this operator<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Pointer to the actual resource </dd></dl>
</div>
</div><p>
<a class="anchor" name="4e5401c5a07347a35cc3b9192e11b071"></a><!-- doxytag: member="sf::ResourcePtr::operator*" ref="4e5401c5a07347a35cc3b9192e11b071" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T> </div>
<table class="memname">
<tr>
<td class="memname">const T& <a class="el" href="classsf_1_1ResourcePtr.htm">sf::ResourcePtr</a>< T >::operator* </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Operator * overload to return a reference to the actual resource.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Reference to the internal resource </dd></dl>
</div>
</div><p>
<a class="anchor" name="e58ea517eee0a97a778c3c59e4c3fe3a"></a><!-- doxytag: member="sf::ResourcePtr::operator->" ref="e58ea517eee0a97a778c3c59e4c3fe3a" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T> </div>
<table class="memname">
<tr>
<td class="memname">const T* <a class="el" href="classsf_1_1ResourcePtr.htm">sf::ResourcePtr</a>< T >::operator-> </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Operator -> overload to return a pointer to the actual resource.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Pointer to the internal resource </dd></dl>
</div>
</div><p>
<a class="anchor" name="23a9350a7565a26f0cc1bbadb917248d"></a><!-- doxytag: member="sf::ResourcePtr::operator=" ref="23a9350a7565a26f0cc1bbadb917248d" args="(const T *Resource)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classsf_1_1ResourcePtr.htm">ResourcePtr</a><T>& <a class="el" href="classsf_1_1ResourcePtr.htm">sf::ResourcePtr</a>< T >::operator= </td>
<td>(</td>
<td class="paramtype">const T * </td>
<td class="paramname"> <em>Resource</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Assignment operator from a raw resource.
<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><a class="el" href="classsf_1_1Resource.htm" title="Base class for every resource that needs to notify dependent classes about its destruction...">Resource</a></em> </td><td>: <a class="el" href="classsf_1_1Resource.htm" title="Base class for every resource that needs to notify dependent classes about its destruction...">Resource</a> to assign</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Reference to this </dd></dl>
</div>
</div><p>
<a class="anchor" name="efd17640cfe8d96934435fb8f2b40574"></a><!-- doxytag: member="sf::ResourcePtr::operator=" ref="efd17640cfe8d96934435fb8f2b40574" args="(const ResourcePtr< T > &Other)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classsf_1_1ResourcePtr.htm">ResourcePtr</a><T>& <a class="el" href="classsf_1_1ResourcePtr.htm">sf::ResourcePtr</a>< T >::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classsf_1_1ResourcePtr.htm">ResourcePtr</a>< T > & </td>
<td class="paramname"> <em>Other</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Assignment operator from another <a class="el" href="classsf_1_1ResourcePtr.htm" title="Safe pointer to a T resource (inheriting from sf::Resource<T>), its pointer...">ResourcePtr</a>.
<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>Other</em> </td><td>: <a class="el" href="classsf_1_1Resource.htm" title="Base class for every resource that needs to notify dependent classes about its destruction...">Resource</a> pointer to assign</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Reference to this </dd></dl>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="Resource_8hpp-source.htm">Resource.hpp</a></ul>
</div>
<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>
|
