-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathclassSDL2pp_1_1AudioDevice_1_1LockHandle.html
315 lines (293 loc) · 18.6 KB
/
classSDL2pp_1_1AudioDevice_1_1LockHandle.html
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
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libSDL2pp: SDL2pp::AudioDevice::LockHandle Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">libSDL2pp
</div>
<div id="projectbrief">C++ bindings/wrapper for SDL2</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>SDL2pp</b></li><li class="navelem"><a class="el" href="classSDL2pp_1_1AudioDevice.html">AudioDevice</a></li><li class="navelem"><a class="el" href="classSDL2pp_1_1AudioDevice_1_1LockHandle.html">LockHandle</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#friends">Friends</a> |
<a href="classSDL2pp_1_1AudioDevice_1_1LockHandle-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">SDL2pp::AudioDevice::LockHandle Class Reference<div class="ingroups"><a class="el" href="group__audio.html">Audio</a></div></div></div>
</div><!--header-->
<div class="contents">
<p><a class="el" href="classSDL2pp_1_1AudioDevice.html" title="Audio device.">SDL2pp::AudioDevice</a> lock.
<a href="classSDL2pp_1_1AudioDevice_1_1LockHandle.html#details">More...</a></p>
<p><code>#include <<a class="el" href="AudioDevice_8hh_source.html">SDL2pp/AudioDevice.hh</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ada3ef0e944bc13a175fd2d88ec175c0e" id="r_ada3ef0e944bc13a175fd2d88ec175c0e"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSDL2pp_1_1AudioDevice_1_1LockHandle.html#ada3ef0e944bc13a175fd2d88ec175c0e">LockHandle</a> ()</td></tr>
<tr class="memdesc:ada3ef0e944bc13a175fd2d88ec175c0e"><td class="mdescLeft"> </td><td class="mdescRight">Create no-op lock. <br /></td></tr>
<tr class="separator:ada3ef0e944bc13a175fd2d88ec175c0e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a18a8f0b38caa12d10423fbcd206b36e4" id="r_a18a8f0b38caa12d10423fbcd206b36e4"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSDL2pp_1_1AudioDevice_1_1LockHandle.html#a18a8f0b38caa12d10423fbcd206b36e4">~LockHandle</a> ()</td></tr>
<tr class="memdesc:a18a8f0b38caa12d10423fbcd206b36e4"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br /></td></tr>
<tr class="separator:a18a8f0b38caa12d10423fbcd206b36e4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aacb21aadcdd2d48406761227a79c9337" id="r_aacb21aadcdd2d48406761227a79c9337"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSDL2pp_1_1AudioDevice_1_1LockHandle.html#aacb21aadcdd2d48406761227a79c9337">LockHandle</a> (<a class="el" href="classSDL2pp_1_1AudioDevice_1_1LockHandle.html">LockHandle</a> &&other) noexcept</td></tr>
<tr class="memdesc:aacb21aadcdd2d48406761227a79c9337"><td class="mdescLeft"> </td><td class="mdescRight">Move constructor. <br /></td></tr>
<tr class="separator:aacb21aadcdd2d48406761227a79c9337"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aae6805e8ca4c5f8c1ac96a195fa3c39c" id="r_aae6805e8ca4c5f8c1ac96a195fa3c39c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classSDL2pp_1_1AudioDevice_1_1LockHandle.html">LockHandle</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classSDL2pp_1_1AudioDevice_1_1LockHandle.html#aae6805e8ca4c5f8c1ac96a195fa3c39c">operator=</a> (<a class="el" href="classSDL2pp_1_1AudioDevice_1_1LockHandle.html">LockHandle</a> &&other) noexcept</td></tr>
<tr class="memdesc:aae6805e8ca4c5f8c1ac96a195fa3c39c"><td class="mdescLeft"> </td><td class="mdescRight">Move assignment operator. <br /></td></tr>
<tr class="separator:aae6805e8ca4c5f8c1ac96a195fa3c39c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad5fd929053b7643b53bbb6ed82e38099" id="r_ad5fd929053b7643b53bbb6ed82e38099"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSDL2pp_1_1AudioDevice_1_1LockHandle.html#ad5fd929053b7643b53bbb6ed82e38099">LockHandle</a> (const <a class="el" href="classSDL2pp_1_1AudioDevice_1_1LockHandle.html">LockHandle</a> &other)</td></tr>
<tr class="memdesc:ad5fd929053b7643b53bbb6ed82e38099"><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <br /></td></tr>
<tr class="separator:ad5fd929053b7643b53bbb6ed82e38099"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afd024f79c3b1111ccdca7f7e096d5bbd" id="r_afd024f79c3b1111ccdca7f7e096d5bbd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classSDL2pp_1_1AudioDevice_1_1LockHandle.html">LockHandle</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classSDL2pp_1_1AudioDevice_1_1LockHandle.html#afd024f79c3b1111ccdca7f7e096d5bbd">operator=</a> (const <a class="el" href="classSDL2pp_1_1AudioDevice_1_1LockHandle.html">LockHandle</a> &other)</td></tr>
<tr class="memdesc:afd024f79c3b1111ccdca7f7e096d5bbd"><td class="mdescLeft"> </td><td class="mdescRight">Assignment operator. <br /></td></tr>
<tr class="separator:afd024f79c3b1111ccdca7f7e096d5bbd"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="friends" name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:a8fbf9b3017983991713e2cbb819dfd5a" id="r_a8fbf9b3017983991713e2cbb819dfd5a"><td class="memItemLeft" align="right" valign="top"><a id="a8fbf9b3017983991713e2cbb819dfd5a" name="a8fbf9b3017983991713e2cbb819dfd5a"></a>
class </td><td class="memItemRight" valign="bottom"><b>AudioDevice</b></td></tr>
<tr class="separator:a8fbf9b3017983991713e2cbb819dfd5a"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classSDL2pp_1_1AudioDevice.html" title="Audio device.">SDL2pp::AudioDevice</a> lock. </p>
<p>Audio devices may be locked, which means that audio callback will not be called in a locked state, allowing to change data it accesses in a thread-safe way.</p>
<p>This class represents the lock and controls its lifetime as the lock is released as soon as <a class="el" href="classSDL2pp_1_1AudioDevice_1_1LockHandle.html" title="SDL2pp::AudioDevice lock.">LockHandle</a> is destroyed.</p>
<p>Usage example: </p><div class="fragment"><div class="line">{</div>
<div class="line"> <span class="comment">// Some audio data is loaded</span></div>
<div class="line"> <a class="code hl_class" href="classSDL2pp_1_1Wav.html">SDL2pp::Wav</a> audiodata;</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// Audio device is created, its callback accesses our audio data</span></div>
<div class="line"> <a class="code hl_class" href="classSDL2pp_1_1AudioDevice.html">SDL2pp::AudioDevice</a> dev(..., [&audiodata](){...});</div>
<div class="line"> </div>
<div class="line"> dev.<a class="code hl_function" href="classSDL2pp_1_1AudioDevice.html#aa6c8f8b0ad76d9d0a323be20dab763c9">Pause</a>(<span class="keyword">false</span>); <span class="comment">// playback starts, the callback is called periodically</span></div>
<div class="line"> </div>
<div class="line"> {</div>
<div class="line"> <a class="code hl_class" href="classSDL2pp_1_1AudioDevice_1_1LockHandle.html">SDL2pp::AudioDevice::LockHandle</a> lock = dev.Lock();</div>
<div class="line"> <span class="comment">// Now audiodata may be safely modified, no callback will be called to access it</span></div>
<div class="line"> }</div>
<div class="line"> <span class="comment">// At this point lock is released, playback continues</span></div>
<div class="line">}</div>
<div class="ttc" id="aclassSDL2pp_1_1AudioDevice_1_1LockHandle_html"><div class="ttname"><a href="classSDL2pp_1_1AudioDevice_1_1LockHandle.html">SDL2pp::AudioDevice::LockHandle</a></div><div class="ttdoc">SDL2pp::AudioDevice lock.</div><div class="ttdef"><b>Definition</b> AudioDevice.hh:86</div></div>
<div class="ttc" id="aclassSDL2pp_1_1AudioDevice_html"><div class="ttname"><a href="classSDL2pp_1_1AudioDevice.html">SDL2pp::AudioDevice</a></div><div class="ttdoc">Audio device.</div><div class="ttdef"><b>Definition</b> AudioDevice.hh:50</div></div>
<div class="ttc" id="aclassSDL2pp_1_1AudioDevice_html_aa6c8f8b0ad76d9d0a323be20dab763c9"><div class="ttname"><a href="classSDL2pp_1_1AudioDevice.html#aa6c8f8b0ad76d9d0a323be20dab763c9">SDL2pp::AudioDevice::Pause</a></div><div class="ttdeci">AudioDevice & Pause(bool pause_on)</div><div class="ttdoc">Pause or unpause audio playback.</div><div class="ttdef"><b>Definition</b> AudioDevice.cc:91</div></div>
<div class="ttc" id="aclassSDL2pp_1_1Wav_html"><div class="ttname"><a href="classSDL2pp_1_1Wav.html">SDL2pp::Wav</a></div><div class="ttdoc">Chunk of audio data read from a .WAV file</div><div class="ttdef"><b>Definition</b> Wav.hh:52</div></div>
</div><!-- fragment --> </div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="ada3ef0e944bc13a175fd2d88ec175c0e" name="ada3ef0e944bc13a175fd2d88ec175c0e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ada3ef0e944bc13a175fd2d88ec175c0e">◆ </a></span>LockHandle() <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SDL2pp::AudioDevice::LockHandle::LockHandle </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create no-op lock. </p>
<p>This may be initialized with real lock later via move assignment </p>
</div>
</div>
<a id="a18a8f0b38caa12d10423fbcd206b36e4" name="a18a8f0b38caa12d10423fbcd206b36e4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a18a8f0b38caa12d10423fbcd206b36e4">◆ </a></span>~LockHandle()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SDL2pp::AudioDevice::LockHandle::~LockHandle </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor. </p>
<p>Releases the lock</p>
<dl class="section see"><dt>See also</dt><dd><a href="http://wiki.libsdl.org/SDL_UnlockAudioDevice">http://wiki.libsdl.org/SDL_UnlockAudioDevice</a> </dd></dl>
</div>
</div>
<a id="aacb21aadcdd2d48406761227a79c9337" name="aacb21aadcdd2d48406761227a79c9337"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aacb21aadcdd2d48406761227a79c9337">◆ </a></span>LockHandle() <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">SDL2pp::AudioDevice::LockHandle::LockHandle </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classSDL2pp_1_1AudioDevice_1_1LockHandle.html">AudioDevice::LockHandle</a> && </td>
<td class="paramname"><em>other</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Move constructor. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">other</td><td><a class="el" href="classSDL2pp_1_1AudioDevice_1_1LockHandle.html" title="SDL2pp::AudioDevice lock.">SDL2pp::AudioDevice::LockHandle</a> to move data from </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ad5fd929053b7643b53bbb6ed82e38099" name="ad5fd929053b7643b53bbb6ed82e38099"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad5fd929053b7643b53bbb6ed82e38099">◆ </a></span>LockHandle() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SDL2pp::AudioDevice::LockHandle::LockHandle </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classSDL2pp_1_1AudioDevice_1_1LockHandle.html">LockHandle</a> & </td>
<td class="paramname"><em>other</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Copy constructor. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">other</td><td><a class="el" href="classSDL2pp_1_1AudioDevice_1_1LockHandle.html" title="SDL2pp::AudioDevice lock.">SDL2pp::AudioDevice::LockHandle</a> to copy data from </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="afd024f79c3b1111ccdca7f7e096d5bbd" name="afd024f79c3b1111ccdca7f7e096d5bbd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afd024f79c3b1111ccdca7f7e096d5bbd">◆ </a></span>operator=() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classSDL2pp_1_1AudioDevice_1_1LockHandle.html">AudioDevice::LockHandle</a> & SDL2pp::AudioDevice::LockHandle::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classSDL2pp_1_1AudioDevice_1_1LockHandle.html">LockHandle</a> & </td>
<td class="paramname"><em>other</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Assignment operator. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">other</td><td><a class="el" href="classSDL2pp_1_1AudioDevice_1_1LockHandle.html" title="SDL2pp::AudioDevice lock.">SDL2pp::AudioDevice::LockHandle</a> to copy data from</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Reference to self </dd></dl>
</div>
</div>
<a id="aae6805e8ca4c5f8c1ac96a195fa3c39c" name="aae6805e8ca4c5f8c1ac96a195fa3c39c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aae6805e8ca4c5f8c1ac96a195fa3c39c">◆ </a></span>operator=() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classSDL2pp_1_1AudioDevice_1_1LockHandle.html">AudioDevice::LockHandle</a> & SDL2pp::AudioDevice::LockHandle::operator= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classSDL2pp_1_1AudioDevice_1_1LockHandle.html">AudioDevice::LockHandle</a> && </td>
<td class="paramname"><em>other</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Move assignment operator. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">other</td><td><a class="el" href="classSDL2pp_1_1AudioDevice_1_1LockHandle.html" title="SDL2pp::AudioDevice lock.">SDL2pp::AudioDevice::LockHandle</a> to move data from</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Reference to self </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>SDL2pp/<a class="el" href="AudioDevice_8hh_source.html">AudioDevice.hh</a></li>
<li>SDL2pp/<b>AudioLock.cc</b></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>