namespace_audio.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=11"/>
  6. <meta name="generator" content="Doxygen 1.9.8"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>Torque2D Reference: Audio Namespace Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. <link href="t2d-stylesheet-extra.css" rel="stylesheet" type="text/css"/>
  17. </head>
  18. <body>
  19. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  20. <div id="titlearea">
  21. <table cellspacing="0" cellpadding="0">
  22. <tbody>
  23. <tr id="projectrow">
  24. <td id="projectalign">
  25. <div id="projectname">Torque2D Reference
  26. </div>
  27. </td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. </div>
  32. <!-- end header part -->
  33. <!-- Generated by Doxygen 1.9.8 -->
  34. <script type="text/javascript">
  35. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  36. var searchBox = new SearchBox("searchBox", "search/",'.html');
  37. /* @license-end */
  38. </script>
  39. <script type="text/javascript" src="menudata.js"></script>
  40. <script type="text/javascript" src="menu.js"></script>
  41. <script type="text/javascript">
  42. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  43. $(function() {
  44. initMenu('',true,false,'search.php','Search');
  45. $(document).ready(function() { init_search(); });
  46. });
  47. /* @license-end */
  48. </script>
  49. <div id="main-nav"></div>
  50. <!-- window showing the filter options -->
  51. <div id="MSearchSelectWindow"
  52. onmouseover="return searchBox.OnSearchSelectShow()"
  53. onmouseout="return searchBox.OnSearchSelectHide()"
  54. onkeydown="return searchBox.OnSearchSelectKey(event)">
  55. </div>
  56. <!-- iframe showing the search results (closed by default) -->
  57. <div id="MSearchResultsWindow">
  58. <div id="MSearchResults">
  59. <div class="SRPage">
  60. <div id="SRIndex">
  61. <div id="SRResults"></div>
  62. <div class="SRStatus" id="Loading">Loading...</div>
  63. <div class="SRStatus" id="Searching">Searching...</div>
  64. <div class="SRStatus" id="NoMatches">No Matches</div>
  65. </div>
  66. </div>
  67. </div>
  68. </div>
  69. </div><!-- top -->
  70. <div class="header">
  71. <div class="summary">
  72. <a href="#nested-classes">Classes</a> &#124;
  73. <a href="#enum-members">Enumerations</a> &#124;
  74. <a href="#func-members">Functions</a> &#124;
  75. <a href="#var-members">Variables</a> </div>
  76. <div class="headertitle"><div class="title">Audio Namespace Reference</div></div>
  77. </div><!--header-->
  78. <div class="contents">
  79. <table class="memberdecls">
  80. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
  81. Classes</h2></td></tr>
  82. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_audio_1_1_description.html">Description</a></td></tr>
  83. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. </table><table class="memberdecls">
  85. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
  86. Enumerations</h2></td></tr>
  87. <tr class="memitem:a198b8c2c77ea9f9815a181ddeda1c320" id="r_a198b8c2c77ea9f9815a181ddeda1c320"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_audio.html#a198b8c2c77ea9f9815a181ddeda1c320">Constants</a> { <a class="el" href="namespace_audio.html#a198b8c2c77ea9f9815a181ddeda1c320a96d3f502c04a9ed84045c9f0b14aee02">AudioVolumeChannels</a> = 32
  88. }</td></tr>
  89. <tr class="separator:a198b8c2c77ea9f9815a181ddeda1c320"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. </table><table class="memberdecls">
  91. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
  92. Functions</h2></td></tr>
  93. <tr class="memitem:a6c213cdd553c140645ed810242469fa7" id="r_a6c213cdd553c140645ed810242469fa7"><td class="memItemLeft" align="right" valign="top">F32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_audio.html#a6c213cdd553c140645ed810242469fa7">DBToLinear</a> (F32 value)</td></tr>
  94. <tr class="separator:a6c213cdd553c140645ed810242469fa7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  95. <tr class="memitem:a1b2ab3cb2d82d3c26ecc4ee5cb149d33" id="r_a1b2ab3cb2d82d3c26ecc4ee5cb149d33"><td class="memItemLeft" align="right" valign="top">F32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_audio.html#a1b2ab3cb2d82d3c26ecc4ee5cb149d33">linearToDB</a> (F32 value)</td></tr>
  96. <tr class="separator:a1b2ab3cb2d82d3c26ecc4ee5cb149d33"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97. <tr class="memitem:a00e4189eb514109bf422c81ebeac44d8" id="r_a00e4189eb514109bf422c81ebeac44d8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_audio.html#a00e4189eb514109bf422c81ebeac44d8">shutdownContext</a> ()</td></tr>
  98. <tr class="separator:a00e4189eb514109bf422c81ebeac44d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. <tr class="memitem:abe640ab92547c08914ed9f608ab23b7f" id="r_abe640ab92547c08914ed9f608ab23b7f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_audio.html#abe640ab92547c08914ed9f608ab23b7f">OpenALInit</a> ()</td></tr>
  100. <tr class="separator:abe640ab92547c08914ed9f608ab23b7f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  101. <tr class="memitem:a0770aa78c545ed11c1de63b9b48daa69" id="r_a0770aa78c545ed11c1de63b9b48daa69"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_audio.html#a0770aa78c545ed11c1de63b9b48daa69">OpenALShutdown</a> ()</td></tr>
  102. <tr class="separator:a0770aa78c545ed11c1de63b9b48daa69"><td class="memSeparator" colspan="2">&#160;</td></tr>
  103. <tr class="memitem:a7804f4027f1b52cd38519de9a59e8d9e" id="r_a7804f4027f1b52cd38519de9a59e8d9e"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_audio.html#a7804f4027f1b52cd38519de9a59e8d9e">OpenALDLLInit</a> ()</td></tr>
  104. <tr class="separator:a7804f4027f1b52cd38519de9a59e8d9e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. <tr class="memitem:aa156002b2c849d4267b10bad68c2e489" id="r_aa156002b2c849d4267b10bad68c2e489"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_audio.html#aa156002b2c849d4267b10bad68c2e489">OpenALDLLShutdown</a> ()</td></tr>
  106. <tr class="separator:aa156002b2c849d4267b10bad68c2e489"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <tr class="memitem:affcfaa4cda8a9047a9854df91b7b6bbe" id="r_affcfaa4cda8a9047a9854df91b7b6bbe"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_audio.html#affcfaa4cda8a9047a9854df91b7b6bbe">initOpenAL</a> ()</td></tr>
  108. <tr class="separator:affcfaa4cda8a9047a9854df91b7b6bbe"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. <tr class="memitem:a330302d1f4cd9f8ff28643e6325cbcd9" id="r_a330302d1f4cd9f8ff28643e6325cbcd9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_audio.html#a330302d1f4cd9f8ff28643e6325cbcd9">shutdownOpenAL</a> ()</td></tr>
  110. <tr class="separator:a330302d1f4cd9f8ff28643e6325cbcd9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. <tr class="memitem:a3a80b6032f86a56bec74609034b3246f" id="r_a3a80b6032f86a56bec74609034b3246f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_audio.html#a3a80b6032f86a56bec74609034b3246f">destroy</a> ()</td></tr>
  112. <tr class="separator:a3a80b6032f86a56bec74609034b3246f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  113. </table><table class="memberdecls">
  114. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="var-members" name="var-members"></a>
  115. Variables</h2></td></tr>
  116. <tr class="memitem:a6524a673f26022894d5d4f14f691602e" id="r_a6524a673f26022894d5d4f14f691602e"><td class="memItemLeft" align="right" valign="top">const int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_audio.html#a6524a673f26022894d5d4f14f691602e">logmax</a> = sizeof logtab / sizeof *logtab</td></tr>
  117. <tr class="separator:a6524a673f26022894d5d4f14f691602e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  118. </table>
  119. <h2 class="groupheader">Enumeration Type Documentation</h2>
  120. <a id="a198b8c2c77ea9f9815a181ddeda1c320" name="a198b8c2c77ea9f9815a181ddeda1c320"></a>
  121. <h2 class="memtitle"><span class="permalink"><a href="#a198b8c2c77ea9f9815a181ddeda1c320">&#9670;&#160;</a></span>Constants</h2>
  122. <div class="memitem">
  123. <div class="memproto">
  124. <table class="memname">
  125. <tr>
  126. <td class="memname">enum <a class="el" href="namespace_audio.html#a198b8c2c77ea9f9815a181ddeda1c320">Constants</a></td>
  127. </tr>
  128. </table>
  129. </div><div class="memdoc">
  130. <table class="fieldtable">
  131. <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a198b8c2c77ea9f9815a181ddeda1c320a96d3f502c04a9ed84045c9f0b14aee02" name="a198b8c2c77ea9f9815a181ddeda1c320a96d3f502c04a9ed84045c9f0b14aee02"></a>AudioVolumeChannels&#160;</td><td class="fielddoc"></td></tr>
  132. </table>
  133. </div>
  134. </div>
  135. <h2 class="groupheader">Function Documentation</h2>
  136. <a id="a6c213cdd553c140645ed810242469fa7" name="a6c213cdd553c140645ed810242469fa7"></a>
  137. <h2 class="memtitle"><span class="permalink"><a href="#a6c213cdd553c140645ed810242469fa7">&#9670;&#160;</a></span>DBToLinear()</h2>
  138. <div class="memitem">
  139. <div class="memproto">
  140. <table class="memname">
  141. <tr>
  142. <td class="memname">F32 DBToLinear </td>
  143. <td>(</td>
  144. <td class="paramtype">F32&#160;</td>
  145. <td class="paramname"><em>value</em></td><td>)</td>
  146. <td></td>
  147. </tr>
  148. </table>
  149. </div><div class="memdoc">
  150. </div>
  151. </div>
  152. <a id="a3a80b6032f86a56bec74609034b3246f" name="a3a80b6032f86a56bec74609034b3246f"></a>
  153. <h2 class="memtitle"><span class="permalink"><a href="#a3a80b6032f86a56bec74609034b3246f">&#9670;&#160;</a></span>destroy()</h2>
  154. <div class="memitem">
  155. <div class="memproto">
  156. <table class="memname">
  157. <tr>
  158. <td class="memname">void destroy </td>
  159. <td>(</td>
  160. <td class="paramname"></td><td>)</td>
  161. <td></td>
  162. </tr>
  163. </table>
  164. </div><div class="memdoc">
  165. </div>
  166. </div>
  167. <a id="affcfaa4cda8a9047a9854df91b7b6bbe" name="affcfaa4cda8a9047a9854df91b7b6bbe"></a>
  168. <h2 class="memtitle"><span class="permalink"><a href="#affcfaa4cda8a9047a9854df91b7b6bbe">&#9670;&#160;</a></span>initOpenAL()</h2>
  169. <div class="memitem">
  170. <div class="memproto">
  171. <table class="memname">
  172. <tr>
  173. <td class="memname">void initOpenAL </td>
  174. <td>(</td>
  175. <td class="paramname"></td><td>)</td>
  176. <td></td>
  177. </tr>
  178. </table>
  179. </div><div class="memdoc">
  180. </div>
  181. </div>
  182. <a id="a1b2ab3cb2d82d3c26ecc4ee5cb149d33" name="a1b2ab3cb2d82d3c26ecc4ee5cb149d33"></a>
  183. <h2 class="memtitle"><span class="permalink"><a href="#a1b2ab3cb2d82d3c26ecc4ee5cb149d33">&#9670;&#160;</a></span>linearToDB()</h2>
  184. <div class="memitem">
  185. <div class="memproto">
  186. <table class="memname">
  187. <tr>
  188. <td class="memname">F32 linearToDB </td>
  189. <td>(</td>
  190. <td class="paramtype">F32&#160;</td>
  191. <td class="paramname"><em>value</em></td><td>)</td>
  192. <td></td>
  193. </tr>
  194. </table>
  195. </div><div class="memdoc">
  196. </div>
  197. </div>
  198. <a id="a7804f4027f1b52cd38519de9a59e8d9e" name="a7804f4027f1b52cd38519de9a59e8d9e"></a>
  199. <h2 class="memtitle"><span class="permalink"><a href="#a7804f4027f1b52cd38519de9a59e8d9e">&#9670;&#160;</a></span>OpenALDLLInit()</h2>
  200. <div class="memitem">
  201. <div class="memproto">
  202. <table class="memname">
  203. <tr>
  204. <td class="memname">bool OpenALDLLInit </td>
  205. <td>(</td>
  206. <td class="paramname"></td><td>)</td>
  207. <td></td>
  208. </tr>
  209. </table>
  210. </div><div class="memdoc">
  211. <p>The MacOS X build links against the OpenAL framework. It can be built to use either an internal framework, or the system framework. Since OpenAL is weak-linked in at compile time, we don't need to init anything. Stub it out... </p>
  212. </div>
  213. </div>
  214. <a id="aa156002b2c849d4267b10bad68c2e489" name="aa156002b2c849d4267b10bad68c2e489"></a>
  215. <h2 class="memtitle"><span class="permalink"><a href="#aa156002b2c849d4267b10bad68c2e489">&#9670;&#160;</a></span>OpenALDLLShutdown()</h2>
  216. <div class="memitem">
  217. <div class="memproto">
  218. <table class="memname">
  219. <tr>
  220. <td class="memname">void OpenALDLLShutdown </td>
  221. <td>(</td>
  222. <td class="paramname"></td><td>)</td>
  223. <td></td>
  224. </tr>
  225. </table>
  226. </div><div class="memdoc">
  227. <p>Stubbed out, see the note on <a class="el" href="namespace_audio.html#a7804f4027f1b52cd38519de9a59e8d9e">OpenALDLLInit()</a>. <br />
  228. </p>
  229. </div>
  230. </div>
  231. <a id="abe640ab92547c08914ed9f608ab23b7f" name="abe640ab92547c08914ed9f608ab23b7f"></a>
  232. <h2 class="memtitle"><span class="permalink"><a href="#abe640ab92547c08914ed9f608ab23b7f">&#9670;&#160;</a></span>OpenALInit()</h2>
  233. <div class="memitem">
  234. <div class="memproto">
  235. <table class="memname">
  236. <tr>
  237. <td class="memname">bool OpenALInit </td>
  238. <td>(</td>
  239. <td class="paramname"></td><td>)</td>
  240. <td></td>
  241. </tr>
  242. </table>
  243. </div><div class="memdoc">
  244. </div>
  245. </div>
  246. <a id="a0770aa78c545ed11c1de63b9b48daa69" name="a0770aa78c545ed11c1de63b9b48daa69"></a>
  247. <h2 class="memtitle"><span class="permalink"><a href="#a0770aa78c545ed11c1de63b9b48daa69">&#9670;&#160;</a></span>OpenALShutdown()</h2>
  248. <div class="memitem">
  249. <div class="memproto">
  250. <table class="memname">
  251. <tr>
  252. <td class="memname">void OpenALShutdown </td>
  253. <td>(</td>
  254. <td class="paramname"></td><td>)</td>
  255. <td></td>
  256. </tr>
  257. </table>
  258. </div><div class="memdoc">
  259. </div>
  260. </div>
  261. <a id="a00e4189eb514109bf422c81ebeac44d8" name="a00e4189eb514109bf422c81ebeac44d8"></a>
  262. <h2 class="memtitle"><span class="permalink"><a href="#a00e4189eb514109bf422c81ebeac44d8">&#9670;&#160;</a></span>shutdownContext()</h2>
  263. <div class="memitem">
  264. <div class="memproto">
  265. <table class="memname">
  266. <tr>
  267. <td class="memname">void shutdownContext </td>
  268. <td>(</td>
  269. <td class="paramname"></td><td>)</td>
  270. <td></td>
  271. </tr>
  272. </table>
  273. </div><div class="memdoc">
  274. </div>
  275. </div>
  276. <a id="a330302d1f4cd9f8ff28643e6325cbcd9" name="a330302d1f4cd9f8ff28643e6325cbcd9"></a>
  277. <h2 class="memtitle"><span class="permalink"><a href="#a330302d1f4cd9f8ff28643e6325cbcd9">&#9670;&#160;</a></span>shutdownOpenAL()</h2>
  278. <div class="memitem">
  279. <div class="memproto">
  280. <table class="memname">
  281. <tr>
  282. <td class="memname">void shutdownOpenAL </td>
  283. <td>(</td>
  284. <td class="paramname"></td><td>)</td>
  285. <td></td>
  286. </tr>
  287. </table>
  288. </div><div class="memdoc">
  289. </div>
  290. </div>
  291. <h2 class="groupheader">Variable Documentation</h2>
  292. <a id="a6524a673f26022894d5d4f14f691602e" name="a6524a673f26022894d5d4f14f691602e"></a>
  293. <h2 class="memtitle"><span class="permalink"><a href="#a6524a673f26022894d5d4f14f691602e">&#9670;&#160;</a></span>logmax</h2>
  294. <div class="memitem">
  295. <div class="memproto">
  296. <table class="memname">
  297. <tr>
  298. <td class="memname">const int logmax = sizeof logtab / sizeof *logtab</td>
  299. </tr>
  300. </table>
  301. </div><div class="memdoc">
  302. </div>
  303. </div>
  304. </div><!-- contents -->
  305. <!-- start footer part -->
  306. <hr class="footer"/><address class="footer"><small>
  307. Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
  308. </small></address>
  309. </body>
  310. </html>