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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/1999/REC-html401-19991224/loose.dtd">
<html>
<head>
<title>Castle Game Engine: CastleSoundAllocator: Class TSound</title>
<meta name="generator" content="PasDoc 0.13.0">
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<link rel="StyleSheet" type="text/css" href="pasdoc.css">
</head>
<body>
<table class="container"><tr><td class="navigation">
<h2>Castle Game Engine</h2><p><a href="introduction.html" class="navigation">Introduction</a></p><p><a href="AllUnits.html" class="navigation">Units</a></p><p><a href="ClassHierarchy.html" class="navigation">Class Hierarchy</a></p><p><a href="AllClasses.html" class="navigation">Classes, Interfaces, Objects and Records</a></p><p><a href="AllTypes.html" class="navigation">Types</a></p><p><a href="AllVariables.html" class="navigation">Variables</a></p><p><a href="AllConstants.html" class="navigation">Constants</a></p><p><a href="AllFunctions.html" class="navigation">Functions and Procedures</a></p><p><a href="AllIdentifiers.html" class="navigation">Identifiers</a></p></td><td class="content">
<a name="TSound"></a><h1 class="cio">Class TSound</h1>
<table class="sections wide_list">
<tr>
<td><a class="section" href="#PasDoc-Description">Description</a></td><td><a class="section" href="#PasDoc-Hierarchy">Hierarchy</a></td><td>Fields</td><td><a class="section" href="#PasDoc-Methods">Methods</a></td><td><a class="section" href="#PasDoc-Properties">Properties</a></td></tr></table>
<a name="PasDoc-Description"></a><h2 class="unit">Unit</h2>
<p class="unitlink">
<a href="CastleSoundAllocator.html">CastleSoundAllocator</a></p>
<h2 class="declaration">Declaration</h2>
<p class="declaration">
<code>type TSound = class(TObject)</code></p>
<h2 class="description">Description</h2>
<p>
Sound (an allocated OpenAL sound source).</p>
<a name="PasDoc-Hierarchy"></a><h2 class="hierarchy">Hierarchy</h2>
<ul class="hierarchy"><li class="ancestor">TObject</li>
<li class="thisitem">TSound</li></ul><h2 class="overview">Overview</h2>
<a name="PasDoc-Methods"></a><h3 class="summary">Methods</h3>
<table class="summary wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>constructor <b><a href="CastleSoundAllocator.TSound.html#Create">Create</a></b>;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>destructor <b><a href="CastleSoundAllocator.TSound.html#Destroy">Destroy</a></b>; override;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>procedure <b><a href="CastleSoundAllocator.TSound.html#Release">Release</a></b>; virtual;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>function <b><a href="CastleSoundAllocator.TSound.html#PlayingOrPaused">PlayingOrPaused</a></b>: boolean;</code></td>
</tr>
</table>
<a name="PasDoc-Properties"></a><h3 class="summary">Properties</h3>
<table class="summary wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <b><a href="CastleSoundAllocator.TSound.html#ALSource">ALSource</a></b>: TALuint read FALSource;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <b><a href="CastleSoundAllocator.TSound.html#Used">Used</a></b>: boolean read FUsed default false;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <b><a href="CastleSoundAllocator.TSound.html#Importance">Importance</a></b>: Integer read FImportance default 0;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <b><a href="CastleSoundAllocator.TSound.html#UserData">UserData</a></b>: TObject read FUserData write FUserData;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <b><a href="CastleSoundAllocator.TSound.html#OnRelease">OnRelease</a></b>: <a href="CastleSoundAllocator.html#TSoundEvent">TSoundEvent</a> read FOnRelease write FOnRelease;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <b><a href="CastleSoundAllocator.TSound.html#Position">Position</a></b>: <a href="CastleVectors.html#TVector3Single">TVector3Single</a> read FPosition write SetPosition;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <b><a href="CastleSoundAllocator.TSound.html#Velocity">Velocity</a></b>: <a href="CastleVectors.html#TVector3Single">TVector3Single</a> read FVelocity write SetVelocity;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <b><a href="CastleSoundAllocator.TSound.html#Looping">Looping</a></b>: boolean read FLooping write SetLooping;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <b><a href="CastleSoundAllocator.TSound.html#Relative">Relative</a></b>: boolean read FRelative write SetRelative;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <b><a href="CastleSoundAllocator.TSound.html#Gain">Gain</a></b>: Single read FGain write SetGain;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <b><a href="CastleSoundAllocator.TSound.html#MinGain">MinGain</a></b>: Single read FMinGain write SetMinGain;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <b><a href="CastleSoundAllocator.TSound.html#MaxGain">MaxGain</a></b>: Single read FMaxGain write SetMaxGain;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <b><a href="CastleSoundAllocator.TSound.html#Buffer">Buffer</a></b>: <a href="CastleSoundAllocator.html#TSoundBuffer">TSoundBuffer</a> read FBuffer write SetBuffer;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <b><a href="CastleSoundAllocator.TSound.html#Pitch">Pitch</a></b>: Single read FPitch write SetPitch;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <b><a href="CastleSoundAllocator.TSound.html#RolloffFactor">RolloffFactor</a></b>: Single read FRolloffFactor write SetRolloffFactor;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <b><a href="CastleSoundAllocator.TSound.html#ReferenceDistance">ReferenceDistance</a></b>: Single read FReferenceDistance write SetReferenceDistance;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <b><a href="CastleSoundAllocator.TSound.html#MaxDistance">MaxDistance</a></b>: Single read FMaxDistance write SetMaxDistance;</code></td>
</tr>
</table>
<h2 class="description">Description</h2>
<h3 class="detail">Methods</h3>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="Create"></a><code>constructor <b>Create</b>;</code></td>
</tr>
<tr><td colspan="2">
<p>
Create sound. This allocates actual OpenAL source. </p>
<h6 class="description_section">Exceptions raised</h6>
<dl class="exceptions_raised">
<dt><a class="normal" href="CastleSoundAllocator.ENoMoreOpenALSources.html">ENoMoreOpenALSources</a></dt>
<dd>If no more sources available. It should be caught and silenced by <a class="normal" href="CastleSoundAllocator.TSoundAllocator.html#AllocateSound">TSoundAllocator.AllocateSound</a>.</dd>
</dl>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="Destroy"></a><code>destructor <b>Destroy</b>; override;</code></td>
</tr>
<tr><td colspan="2">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="Release"></a><code>procedure <b>Release</b>; virtual;</code></td>
</tr>
<tr><td colspan="2">
<p>
Stops playing the source, sets Used to <code>False</code>, and calls <a class="normal" href="CastleSoundAllocator.TSound.html#OnRelease">OnRelease</a> (if assigned).
<p>You can call this yourself if you want to stop playing the sound. It's preferable to call this (instead of manually calling alSourceStop), because this will immediately mark Used property as <code>False</code> and will call <a class="normal" href="CastleSoundAllocator.TSound.html#OnRelease">OnRelease</a>. Otherwise we would have to get source state at some time (they are checked in AllocateSound) and check it, then see that it's no longer playing.
<p>You can call this only when Used = <code>True</code>.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="PlayingOrPaused"></a><code>function <b>PlayingOrPaused</b>: boolean;</code></td>
</tr>
<tr><td colspan="2">
<p>
Is the sound playing or paused. This is almost always <code>True</code> for sounds returned by <a class="normal" href="CastleSoundAllocator.TSoundAllocator.html#AllocateSound">TSoundAllocator.AllocateSound</a>, when it stops being <code>True</code> — the sound engine will realize it (soon), which will cause <a class="normal" href="CastleSoundAllocator.TSound.html#Release">Release</a> and <a class="normal" href="CastleSoundAllocator.TSound.html#OnRelease">OnRelease</a> being automatically called, and this <a class="normal" href="CastleSoundAllocator.TSound.html">TSound</a> may then be reused for playing other sounds.</p>
</td></tr>
</table>
<h3 class="detail">Properties</h3>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="ALSource"></a><code>property <b>ALSource</b>: TALuint read FALSource;</code></td>
</tr>
<tr><td colspan="2">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="Used"></a><code>property <b>Used</b>: boolean read FUsed default false;</code></td>
</tr>
<tr><td colspan="2">
<p>
Do we play something. Sources that are not Used are simply OpenAL allocated sources that are not used right now, and will be used when we will need them.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="Importance"></a><code>property <b>Importance</b>: Integer read FImportance default 0;</code></td>
</tr>
<tr><td colspan="2">
<p>
The priority of keeping this source, relevant only when <a class="normal" href="CastleSoundAllocator.TSound.html#Used">Used</a>.
<p>Higher <code>Importance</code> means that it's more important to keep it. (I didn't name this property "Priority" so that it's obvious that higher <code>Importance</code> means more important sound).</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="UserData"></a><code>property <b>UserData</b>: TObject read FUserData write FUserData;</code></td>
</tr>
<tr><td colspan="2">
<p>
Any data comfortable to keep here by the caller of <a class="normal" href="CastleSoundAllocator.TSoundAllocator.html#AllocateSound">TSoundAllocator.AllocateSound</a>. It should be initialized after calling <a class="normal" href="CastleSoundAllocator.TSoundAllocator.html#AllocateSound">TSoundAllocator.AllocateSound</a>, and should be finalized in <a class="normal" href="CastleSoundAllocator.TSound.html#OnRelease">OnRelease</a>.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="OnRelease"></a><code>property <b>OnRelease</b>: <a href="CastleSoundAllocator.html#TSoundEvent">TSoundEvent</a> read FOnRelease write FOnRelease;</code></td>
</tr>
<tr><td colspan="2">
<p>
Called when this OpenAL allocated sound will no longer be used. It may stop be used because there are more demanding sources (see <a class="normal" href="CastleSoundAllocator.TSound.html#Importance">Importance</a> and to keep MaxAllocatedSources) and we must assign this OpenAL sound slot to something else, or it may stop be used because it simply stopped playing.
<p>But note that we do not make any guarantees that sources that stopped playing will be immediately reported to <code>OnRelease</code>. In fact, a source may be considered in Used = <code>True</code> state for a long time until it stopped playing. That's not a problem for this unit — <a class="normal" href="CastleSoundAllocator.TSoundAllocator.html#AllocateSound">TSoundAllocator.AllocateSound</a> is smart, and it may actually check (and eventually mark with <a class="normal" href="CastleSoundAllocator.TSound.html#Release">Release</a>) whether some sources are in playing state, to avoid allocating unnecessary sources. However, if this is a problem for you (because e.g. you do some expensive operations to update all used sources every time) and you really desire <code>OnRelease</code> to be called quickly after sound stoppped playing, you may call <a class="normal" href="CastleSoundAllocator.TSoundAllocator.html#Refresh">TSoundAllocator.Refresh</a> from time to time.
<p>In this event you should make sure to delete all references to this sound, because the <a class="normal" href="CastleSoundAllocator.TSound.html">TSound</a> instance may be freed (or reused for other means) after calling <code>OnRelease</code>. For the same reason, after calling this, we always clear it (set <code>OnRelease</code> to <code>Nil</code>).
<p>It's guaranteed that when this will be called, <a class="normal" href="CastleSoundAllocator.TSound.html#Used">Used</a> will be <code>False</code> and <a class="normal" href="CastleSoundAllocator.TSound.html#PlayingOrPaused">PlayingOrPaused</a> will be <code>False</code>.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="Position"></a><code>property <b>Position</b>: <a href="CastleVectors.html#TVector3Single">TVector3Single</a> read FPosition write SetPosition;</code></td>
</tr>
<tr><td colspan="2">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="Velocity"></a><code>property <b>Velocity</b>: <a href="CastleVectors.html#TVector3Single">TVector3Single</a> read FVelocity write SetVelocity;</code></td>
</tr>
<tr><td colspan="2">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="Looping"></a><code>property <b>Looping</b>: boolean read FLooping write SetLooping;</code></td>
</tr>
<tr><td colspan="2">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="Relative"></a><code>property <b>Relative</b>: boolean read FRelative write SetRelative;</code></td>
</tr>
<tr><td colspan="2">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="Gain"></a><code>property <b>Gain</b>: Single read FGain write SetGain;</code></td>
</tr>
<tr><td colspan="2">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="MinGain"></a><code>property <b>MinGain</b>: Single read FMinGain write SetMinGain;</code></td>
</tr>
<tr><td colspan="2">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="MaxGain"></a><code>property <b>MaxGain</b>: Single read FMaxGain write SetMaxGain;</code></td>
</tr>
<tr><td colspan="2">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="Buffer"></a><code>property <b>Buffer</b>: <a href="CastleSoundAllocator.html#TSoundBuffer">TSoundBuffer</a> read FBuffer write SetBuffer;</code></td>
</tr>
<tr><td colspan="2">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="Pitch"></a><code>property <b>Pitch</b>: Single read FPitch write SetPitch;</code></td>
</tr>
<tr><td colspan="2">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="RolloffFactor"></a><code>property <b>RolloffFactor</b>: Single read FRolloffFactor write SetRolloffFactor;</code></td>
</tr>
<tr><td colspan="2">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="ReferenceDistance"></a><code>property <b>ReferenceDistance</b>: Single read FReferenceDistance write SetReferenceDistance;</code></td>
</tr>
<tr><td colspan="2">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="MaxDistance"></a><code>property <b>MaxDistance</b>: Single read FMaxDistance write SetMaxDistance;</code></td>
</tr>
<tr><td colspan="2">
</td></tr>
</table>
<!-- Piwik -->
<script type="text/javascript">
var _paq = _paq || [];
_paq.push(["trackPageView"]);
_paq.push(["enableLinkTracking"]);
(function() {
var u=(("https:" == document.location.protocol) ? "https" : "http") + "://michalis.ii.uni.wroc.pl/piwik-castle-engine/";
_paq.push(["setTrackerUrl", u+"piwik.php"]);
_paq.push(["setSiteId", "1"]);
var d=document, g=d.createElement("script"), s=d.getElementsByTagName("script")[0]; g.type="text/javascript";
g.defer=true; g.async=true; g.src=u+"piwik.js"; s.parentNode.insertBefore(g,s);
})();
</script>
<!-- End Piwik Code -->
<noscript>
<!-- Piwik Image Tracker -->
<img src="http://michalis.ii.uni.wroc.pl/piwik-castle-engine/piwik.php?idsite=1&rec=1" style="border:0" alt="" />
<!-- End Piwik -->
</noscript>
<hr noshade size="1"><span class="appinfo"><em>Generated by <a href="http://pasdoc.sourceforge.net/">PasDoc 0.13.0</a> on 2015-06-15 04:43:12</em>
</span>
</td></tr></table></body></html>
|
