| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294 |
- <!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>Torque2D Reference: AudioBuffer 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" />
- <link href="t2d-stylesheet-extra.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">Torque2D Reference
- </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><!-- top -->
- <div class="header">
- <div class="summary">
- <a href="#pub-methods">Public Member Functions</a> |
- <a href="#pub-static-methods">Static Public Member Functions</a> |
- <a href="#friends">Friends</a> |
- <a href="class_audio_buffer-members.html">List of all members</a> </div>
- <div class="headertitle"><div class="title">AudioBuffer Class Reference</div></div>
- </div><!--header-->
- <div class="contents">
- <p><code>#include <audioBuffer.h></code></p>
- <div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
- <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for AudioBuffer:</div>
- <div id="dynsection-0-summary" class="dynsummary" style="display:block;">
- </div>
- <div id="dynsection-0-content" class="dyncontent" style="display:none;">
- <div class="center">
- <img src="class_audio_buffer.png" usemap="#AudioBuffer_map" alt=""/>
- <map id="AudioBuffer_map" name="AudioBuffer_map">
- <area href="class_resource_instance.html" alt="ResourceInstance" shape="rect" coords="0,0,113,24"/>
- </map>
- </div></div>
- <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:aa4ef74c7129ff48a8dd5aacf6096e893" id="r_aa4ef74c7129ff48a8dd5aacf6096e893"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_audio_buffer.html#aa4ef74c7129ff48a8dd5aacf6096e893">AudioBuffer</a> (StringTableEntry filename)</td></tr>
- <tr class="separator:aa4ef74c7129ff48a8dd5aacf6096e893"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a0e03bfdc08a81457a0089d1fd9bd26b7" id="r_a0e03bfdc08a81457a0089d1fd9bd26b7"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_audio_buffer.html#a0e03bfdc08a81457a0089d1fd9bd26b7">~AudioBuffer</a> ()</td></tr>
- <tr class="separator:a0e03bfdc08a81457a0089d1fd9bd26b7"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a56f12d5ae85a34db83728832d5fde3a3" id="r_a56f12d5ae85a34db83728832d5fde3a3"><td class="memItemLeft" align="right" valign="top">ALuint </td><td class="memItemRight" valign="bottom"><a class="el" href="class_audio_buffer.html#a56f12d5ae85a34db83728832d5fde3a3">getALBuffer</a> ()</td></tr>
- <tr class="separator:a56f12d5ae85a34db83728832d5fde3a3"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a6c67841b418c5af3ced748ca0f0647c8" id="r_a6c67841b418c5af3ced748ca0f0647c8"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_audio_buffer.html#a6c67841b418c5af3ced748ca0f0647c8">isLoading</a> ()</td></tr>
- <tr class="separator:a6c67841b418c5af3ced748ca0f0647c8"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="inherit_header pub_methods_class_resource_instance"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_resource_instance')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_resource_instance.html">ResourceInstance</a></td></tr>
- <tr class="memitem:a60f6680bb78492eb8b97d3e36514a139 inherit pub_methods_class_resource_instance" id="r_a60f6680bb78492eb8b97d3e36514a139"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_resource_instance.html#a60f6680bb78492eb8b97d3e36514a139">ResourceInstance</a> ()</td></tr>
- <tr class="separator:a60f6680bb78492eb8b97d3e36514a139 inherit pub_methods_class_resource_instance"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a6684f1419b225f2ccd7dfd495fd19bb3 inherit pub_methods_class_resource_instance" id="r_a6684f1419b225f2ccd7dfd495fd19bb3"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="class_resource_instance.html#a6684f1419b225f2ccd7dfd495fd19bb3">~ResourceInstance</a> ()</td></tr>
- <tr class="separator:a6684f1419b225f2ccd7dfd495fd19bb3 inherit pub_methods_class_resource_instance"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
- Static Public Member Functions</h2></td></tr>
- <tr class="memitem:a4431b425b3e2ba2176b32eff4eb80d7a" id="r_a4431b425b3e2ba2176b32eff4eb80d7a"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_resource.html">Resource</a>< <a class="el" href="class_audio_buffer.html">AudioBuffer</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_audio_buffer.html#a4431b425b3e2ba2176b32eff4eb80d7a">find</a> (const char *filename)</td></tr>
- <tr class="separator:a4431b425b3e2ba2176b32eff4eb80d7a"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a196ea1f266ff25626cfa4adf0c795016" id="r_a196ea1f266ff25626cfa4adf0c795016"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_resource_instance.html">ResourceInstance</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_audio_buffer.html#a196ea1f266ff25626cfa4adf0c795016">construct</a> (<a class="el" href="class_stream.html">Stream</a> &stream)</td></tr>
- <tr class="separator:a196ea1f266ff25626cfa4adf0c795016"><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:a894b7c943c91bb34f845aeb117786dff" id="r_a894b7c943c91bb34f845aeb117786dff"><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="class_audio_buffer.html#a894b7c943c91bb34f845aeb117786dff">AudioThread</a></td></tr>
- <tr class="separator:a894b7c943c91bb34f845aeb117786dff"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="inherited" name="inherited"></a>
- Additional Inherited Members</h2></td></tr>
- <tr class="inherit_header pub_attribs_class_resource_instance"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_class_resource_instance')"><img src="closed.png" alt="-"/> Public Attributes inherited from <a class="el" href="class_resource_instance.html">ResourceInstance</a></td></tr>
- <tr class="memitem:abdc28331c98eadf7e51f9ce3595ea557 inherit pub_attribs_class_resource_instance" id="r_abdc28331c98eadf7e51f9ce3595ea557"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_resource_object.html">ResourceObject</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_resource_instance.html#abdc28331c98eadf7e51f9ce3595ea557">mSourceResource</a></td></tr>
- <tr class="memdesc:abdc28331c98eadf7e51f9ce3595ea557 inherit pub_attribs_class_resource_instance"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to the <a class="el" href="class_resource_object.html">ResourceObject</a> that stores all our book-keeping data. <br /></td></tr>
- <tr class="separator:abdc28331c98eadf7e51f9ce3595ea557 inherit pub_attribs_class_resource_instance"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <h2 class="groupheader">Constructor & Destructor Documentation</h2>
- <a id="aa4ef74c7129ff48a8dd5aacf6096e893" name="aa4ef74c7129ff48a8dd5aacf6096e893"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#aa4ef74c7129ff48a8dd5aacf6096e893">◆ </a></span>AudioBuffer()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="class_audio_buffer.html">AudioBuffer</a> </td>
- <td>(</td>
- <td class="paramtype">StringTableEntry </td>
- <td class="paramname"><em>filename</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a0e03bfdc08a81457a0089d1fd9bd26b7" name="a0e03bfdc08a81457a0089d1fd9bd26b7"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a0e03bfdc08a81457a0089d1fd9bd26b7">◆ </a></span>~AudioBuffer()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">~<a class="el" href="class_audio_buffer.html">AudioBuffer</a> </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <h2 class="groupheader">Member Function Documentation</h2>
- <a id="a196ea1f266ff25626cfa4adf0c795016" name="a196ea1f266ff25626cfa4adf0c795016"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a196ea1f266ff25626cfa4adf0c795016">◆ </a></span>construct()</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="class_resource_instance.html">ResourceInstance</a> * construct </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="class_stream.html">Stream</a> & </td>
- <td class="paramname"><em>stream</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">static</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a4431b425b3e2ba2176b32eff4eb80d7a" name="a4431b425b3e2ba2176b32eff4eb80d7a"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a4431b425b3e2ba2176b32eff4eb80d7a">◆ </a></span>find()</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="class_resource.html">Resource</a>< <a class="el" href="class_audio_buffer.html">AudioBuffer</a> > find </td>
- <td>(</td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>filename</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">static</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a56f12d5ae85a34db83728832d5fde3a3" name="a56f12d5ae85a34db83728832d5fde3a3"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a56f12d5ae85a34db83728832d5fde3a3">◆ </a></span>getALBuffer()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">ALuint getALBuffer </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a6c67841b418c5af3ced748ca0f0647c8" name="a6c67841b418c5af3ced748ca0f0647c8"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a6c67841b418c5af3ced748ca0f0647c8">◆ </a></span>isLoading()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool isLoading </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <h2 class="groupheader">Friends And Related Symbol Documentation</h2>
- <a id="a894b7c943c91bb34f845aeb117786dff" name="a894b7c943c91bb34f845aeb117786dff"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a894b7c943c91bb34f845aeb117786dff">◆ </a></span>AudioThread</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">friend class AudioThread</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">friend</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <hr/>The documentation for this class was generated from the following files:<ul>
- <li>audio/<b>audioBuffer.h</b></li>
- <li>audio/<b>audioBuffer.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>
|