diff options
| author | FWoltermann@gmail.com <FWoltermann@gmail.com@076cb2c4-205e-83fd-5cf3-1be9aa105544> | 2012-05-31 14:46:27 +0000 |
|---|---|---|
| committer | FWoltermann@gmail.com <FWoltermann@gmail.com@076cb2c4-205e-83fd-5cf3-1be9aa105544> | 2012-05-31 14:46:27 +0000 |
| commit | 8898ad9b25fca6afe2374d293a981db02a83d7e9 (patch) | |
| tree | 8041e6eb069b6da70b83e82efdb998662140e716 /Doc/doxygen/html/_sound_8h_source.html | |
| parent | 985b945e4b49b5d5a1394e93fc3a95289c05e449 (diff) | |
| download | starshatter-8898ad9b25fca6afe2374d293a981db02a83d7e9.zip starshatter-8898ad9b25fca6afe2374d293a981db02a83d7e9.tar.gz starshatter-8898ad9b25fca6afe2374d293a981db02a83d7e9.tar.bz2 | |
Committing the documentation to svn to have it accessible online
Diffstat (limited to 'Doc/doxygen/html/_sound_8h_source.html')
| -rw-r--r-- | Doc/doxygen/html/_sound_8h_source.html | 267 |
1 files changed, 267 insertions, 0 deletions
diff --git a/Doc/doxygen/html/_sound_8h_source.html b/Doc/doxygen/html/_sound_8h_source.html new file mode 100644 index 0000000..db016b5 --- /dev/null +++ b/Doc/doxygen/html/_sound_8h_source.html @@ -0,0 +1,267 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> +<head> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<meta http-equiv="X-UA-Compatible" content="IE=9"/> +<title>Starshatter_Open: D:/SRC/StarshatterSVN/nGenEx/Sound.h Source File</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="navtree.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="resize.js"></script> +<script type="text/javascript" src="navtree.js"></script> +<script type="text/javascript"> + $(document).ready(initResizable); +</script> +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/search.js"></script> +<script type="text/javascript"> + $(document).ready(function() { searchBox.OnSelectItem(0); }); +</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 style="height: 56px;"> + <td style="padding-left: 0.5em;"> + <div id="projectname">Starshatter_Open + </div> + <div id="projectbrief">Open source Starshatter engine</div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.1 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> + <div id="navrow1" class="tabs"> + <ul class="tablist"> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="annotated.html"><span>Classes</span></a></li> + <li class="current"><a href="files.html"><span>Files</span></a></li> + <li> + <div id="MSearchBox" class="MSearchBoxInactive"> + <span class="left"> + <img id="MSearchSelect" src="search/mag_sel.png" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + alt=""/> + <input type="text" id="MSearchField" value="Search" accesskey="S" + onfocus="searchBox.OnSearchFieldFocus(true)" + onblur="searchBox.OnSearchFieldFocus(false)" + onkeyup="searchBox.OnSearchFieldChange(event)"/> + </span><span class="right"> + <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> + </span> + </div> + </li> + </ul> + </div> + <div id="navrow2" class="tabs2"> + <ul class="tablist"> + <li><a href="files.html"><span>File List</span></a></li> + <li><a href="globals.html"><span>File Members</span></a></li> + </ul> + </div> +</div><!-- top --> +<div id="side-nav" class="ui-resizable side-nav-resizable"> + <div id="nav-tree"> + <div id="nav-tree-contents"> + </div> + </div> + <div id="splitbar" style="-moz-user-select:none;" + class="ui-resizable-handle"> + </div> +</div> +<script type="text/javascript"> +$(document).ready(function(){initNavTree('_sound_8h.html','');}); +</script> +<div id="doc-content"> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Macros</a></div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +<div class="header"> + <div class="headertitle"> +<div class="title">Sound.h</div> </div> +</div><!--header--> +<div class="contents"> +<a href="_sound_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/* Project nGenEx</span></div> +<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> Destroyer Studios LLC</span></div> +<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> Copyright © 1997-2004. All Rights Reserved.</span></div> +<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"></span></div> +<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> SUBSYSTEM: nGenEx.lib</span></div> +<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> FILE: Sound.h</span></div> +<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> AUTHOR: John DiCamillo</span></div> +<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"></span></div> +<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"></span></div> +<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> OVERVIEW</span></div> +<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> ========</span></div> +<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> Abstract Sound Object</span></div> +<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">*/</span></div> +<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> </div> +<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#ifndef Sound_h</span></div> +<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor"></span><span class="preprocessor">#define Sound_h</span></div> +<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor"></span></div> +<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#include "<a class="code" href="_types_8h.html">Types.h</a>"</span></div> +<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#include "<a class="code" href="_geometry_8h.html">Geometry.h</a>"</span></div> +<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div> +<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment">// +--------------------------------------------------------------------+</span></div> +<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div> +<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="keyword">class </span><a class="code" href="class_sound_card.html">SoundCard</a>;</div> +<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="keyword">class </span><a class="code" href="class_sound_check.html">SoundCheck</a>;</div> +<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="keyword">class </span><a class="code" href="class_camera.html">Camera</a>;</div> +<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div> +<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment">// +--------------------------------------------------------------------+</span></div> +<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div> +<div class="line"><a name="l00029"></a><span class="lineno"><a class="code" href="class_sound.html"> 29</a></span> <span class="keyword">class </span><a class="code" href="class_sound.html">Sound</a></div> +<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> {</div> +<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">public</span>:</div> +<div class="line"><a name="l00032"></a><span class="lineno"><a class="code" href="class_sound.html#a5bc5da34b77ca258ed485d69a1b99bd0"> 32</a></span>  <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="class_sound.html#a5bc5da34b77ca258ed485d69a1b99bd0">TYPENAME</a>() { <span class="keywordflow">return</span> <span class="stringliteral">"Sound"</span>; }</div> +<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div> +<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <span class="keyword">static</span> <a class="code" href="class_sound.html">Sound</a>* <a class="code" href="class_sound.html#a09ad1363689e323f6195321b88e8cfba">CreateStream</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="class_sound.html#a4448663c1a7a3a6ad879de5f1b440679">filename</a>);</div> +<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="keyword">static</span> <a class="code" href="class_sound.html">Sound</a>* <a class="code" href="class_sound.html#ae44b3132e3cc45885788f18783785802">CreateOggStream</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="class_sound.html#a4448663c1a7a3a6ad879de5f1b440679">filename</a>);</div> +<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="keyword">static</span> <a class="code" href="class_sound.html">Sound</a>* <a class="code" href="class_sound.html#a2f13c928494132b3e5b5c166375629fb">Create</a>(DWORD <a class="code" href="class_sound.html#a45283b596dd7ebd8387af0fe45e391f8">flags</a>, LPWAVEFORMATEX format);</div> +<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="keyword">static</span> <a class="code" href="class_sound.html">Sound</a>* <a class="code" href="class_sound.html#a2f13c928494132b3e5b5c166375629fb">Create</a>(DWORD <a class="code" href="class_sound.html#a45283b596dd7ebd8387af0fe45e391f8">flags</a>, LPWAVEFORMATEX format, DWORD len, LPBYTE data);</div> +<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="class_sound.html#ab6ce5f3a1df10551848bfab0f5181e66">SetListener</a>(<span class="keyword">const</span> <a class="code" href="class_camera.html">Camera</a>& cam, <span class="keyword">const</span> <a class="code" href="struct_vec3.html">Vec3</a>& vel);</div> +<div class="line"><a name="l00039"></a><span class="lineno"><a class="code" href="class_sound.html#a902ee3e5c763d5173908dc3e00bb6557"> 39</a></span>  <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="class_sound.html#a902ee3e5c763d5173908dc3e00bb6557">UseSoundCard</a>(<a class="code" href="class_sound_card.html">SoundCard</a>* s) { <a class="code" href="class_sound.html#adcbf76117ed07cd12e7ba04dbf28b35c">creator</a> = s; }</div> +<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div> +<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="keyword">public</span>:</div> +<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <a class="code" href="class_sound.html#a539c205cdf06fe2c621fd77c37bcfac9">Sound</a>();</div> +<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keyword">virtual</span> <a class="code" href="class_sound.html#a0907389078bf740be2a5763366ad3376">~Sound</a>();</div> +<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> </div> +<div class="line"><a name="l00045"></a><span class="lineno"><a class="code" href="class_sound.html#a8be6484b42f267c9fa8b3a3fc0058120"> 45</a></span>  <span class="keywordtype">int</span> <a class="code" href="class_sound.html#a8be6484b42f267c9fa8b3a3fc0058120">operator==</a>(<span class="keyword">const</span> <a class="code" href="class_sound.html">Sound</a>& rhs)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <span class="keyword">this</span> == &rhs; }</div> +<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> </div> +<div class="line"><a name="l00047"></a><span class="lineno"><a class="code" href="class_sound.html#a21341d999dda81a7e8e121d16759e827"> 47</a></span>  <span class="keyword">enum</span> <a class="code" href="class_sound.html#a21341d999dda81a7e8e121d16759e827">FlagEnum</a> { <a class="code" href="class_sound.html#a21341d999dda81a7e8e121d16759e827ad684f956d92cbb32ca64f379f146a0d0">AMBIENT</a> = 0x0000,</div> +<div class="line"><a name="l00048"></a><span class="lineno"><a class="code" href="class_sound.html#a21341d999dda81a7e8e121d16759e827a3b2736342fd21a6fce744a414b9be691"> 48</a></span>  <a class="code" href="class_sound.html#a21341d999dda81a7e8e121d16759e827a3b2736342fd21a6fce744a414b9be691">LOCALIZED</a> = 0x0001,</div> +<div class="line"><a name="l00049"></a><span class="lineno"><a class="code" href="class_sound.html#a21341d999dda81a7e8e121d16759e827ab2e734b41be1344ca9d8060f8348c645"> 49</a></span>  <a class="code" href="class_sound.html#a21341d999dda81a7e8e121d16759e827ab2e734b41be1344ca9d8060f8348c645">LOC_3D</a> = 0x0002,</div> +<div class="line"><a name="l00050"></a><span class="lineno"><a class="code" href="class_sound.html#a21341d999dda81a7e8e121d16759e827a1a879233c8d670177d25a0b23b7cae93"> 50</a></span>  <a class="code" href="class_sound.html#a21341d999dda81a7e8e121d16759e827a1a879233c8d670177d25a0b23b7cae93">MEMORY</a> = 0x0000,</div> +<div class="line"><a name="l00051"></a><span class="lineno"><a class="code" href="class_sound.html#a21341d999dda81a7e8e121d16759e827af2ee7f9ff2d78b5802ff756a2e0e6ef2"> 51</a></span>  <a class="code" href="class_sound.html#a21341d999dda81a7e8e121d16759e827af2ee7f9ff2d78b5802ff756a2e0e6ef2">STREAMED</a> = 0x0004,</div> +<div class="line"><a name="l00052"></a><span class="lineno"><a class="code" href="class_sound.html#a21341d999dda81a7e8e121d16759e827a2126784e328d82be188b45ea6bb287fd"> 52</a></span>  <a class="code" href="class_sound.html#a21341d999dda81a7e8e121d16759e827a2126784e328d82be188b45ea6bb287fd">ONCE</a> = 0x0000,</div> +<div class="line"><a name="l00053"></a><span class="lineno"><a class="code" href="class_sound.html#a21341d999dda81a7e8e121d16759e827ad6c280f77ae9f0d4ac810e90d58fda96"> 53</a></span>  <a class="code" href="class_sound.html#a21341d999dda81a7e8e121d16759e827ad6c280f77ae9f0d4ac810e90d58fda96">LOOP</a> = 0x0008,</div> +<div class="line"><a name="l00054"></a><span class="lineno"><a class="code" href="class_sound.html#a21341d999dda81a7e8e121d16759e827a28eaca2a95143581b23241e8c43d5017"> 54</a></span>  <a class="code" href="class_sound.html#a21341d999dda81a7e8e121d16759e827a28eaca2a95143581b23241e8c43d5017">FREE</a> = 0x0000,</div> +<div class="line"><a name="l00055"></a><span class="lineno"><a class="code" href="class_sound.html#a21341d999dda81a7e8e121d16759e827acd711d8f3b29618af50e0c1fda30d52e"> 55</a></span>  <a class="code" href="class_sound.html#a21341d999dda81a7e8e121d16759e827acd711d8f3b29618af50e0c1fda30d52e">LOCKED</a> = 0x0010,</div> +<div class="line"><a name="l00056"></a><span class="lineno"><a class="code" href="class_sound.html#a21341d999dda81a7e8e121d16759e827ad34945a16eed7a09be033c2f3e571371"> 56</a></span>  <a class="code" href="class_sound.html#a21341d999dda81a7e8e121d16759e827ad34945a16eed7a09be033c2f3e571371">DOPPLER</a> = 0x0020,</div> +<div class="line"><a name="l00057"></a><span class="lineno"><a class="code" href="class_sound.html#a21341d999dda81a7e8e121d16759e827a6b0807b0d603810715656ebeb7a845f2"> 57</a></span>  <a class="code" href="class_sound.html#a21341d999dda81a7e8e121d16759e827a6b0807b0d603810715656ebeb7a845f2">INTERFACE</a> = 0x0040,</div> +<div class="line"><a name="l00058"></a><span class="lineno"><a class="code" href="class_sound.html#a21341d999dda81a7e8e121d16759e827aa2508b17e8fb5e7a60aaff5331d6e313"> 58</a></span>  <a class="code" href="class_sound.html#a21341d999dda81a7e8e121d16759e827aa2508b17e8fb5e7a60aaff5331d6e313">OGGVORBIS</a> = 0x4000,</div> +<div class="line"><a name="l00059"></a><span class="lineno"><a class="code" href="class_sound.html#a21341d999dda81a7e8e121d16759e827a5e1f8b7001985c5b493852e74005cb2e"> 59</a></span>  <a class="code" href="class_sound.html#a21341d999dda81a7e8e121d16759e827a5e1f8b7001985c5b493852e74005cb2e">RESOURCE</a> = 0x8000 <span class="comment">// not playable, only used to store data</span></div> +<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  };</div> +<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div> +<div class="line"><a name="l00062"></a><span class="lineno"><a class="code" href="class_sound.html#a13131d3f79c8fcc39b40792e2e7a6f9cae4b7a1fa90b6c732333f904dcbb06f49"> 62</a></span>  <span class="keyword">enum</span> <a class="code" href="class_sound.html#a13131d3f79c8fcc39b40792e2e7a6f9c">StatusEnum</a> { <a class="code" href="class_sound.html#a13131d3f79c8fcc39b40792e2e7a6f9cae4b7a1fa90b6c732333f904dcbb06f49">UNINITIALIZED</a>,</div> +<div class="line"><a name="l00063"></a><span class="lineno"><a class="code" href="class_sound.html#a13131d3f79c8fcc39b40792e2e7a6f9ca13d076fbc49d4d1b38ef7c4876b23be1"> 63</a></span>  <a class="code" href="class_sound.html#a13131d3f79c8fcc39b40792e2e7a6f9ca13d076fbc49d4d1b38ef7c4876b23be1">INITIALIZING</a>,</div> +<div class="line"><a name="l00064"></a><span class="lineno"><a class="code" href="class_sound.html#a13131d3f79c8fcc39b40792e2e7a6f9cabb86223b74f15901f48929155b456cd6"> 64</a></span>  <a class="code" href="class_sound.html#a13131d3f79c8fcc39b40792e2e7a6f9cabb86223b74f15901f48929155b456cd6">READY</a>,</div> +<div class="line"><a name="l00065"></a><span class="lineno"><a class="code" href="class_sound.html#a13131d3f79c8fcc39b40792e2e7a6f9caad04eb42407b6383072c808f9f0e2465"> 65</a></span>  <a class="code" href="class_sound.html#a13131d3f79c8fcc39b40792e2e7a6f9caad04eb42407b6383072c808f9f0e2465">PLAYING</a>,</div> +<div class="line"><a name="l00066"></a><span class="lineno"><a class="code" href="class_sound.html#a13131d3f79c8fcc39b40792e2e7a6f9caaa0a51588fdd0d62f508ce217ddff71b"> 66</a></span>  <a class="code" href="class_sound.html#a13131d3f79c8fcc39b40792e2e7a6f9caaa0a51588fdd0d62f508ce217ddff71b">DONE</a> };</div> +<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> </div> +<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="comment">// once per frame:</span></div> +<div class="line"><a name="l00069"></a><span class="lineno"><a class="code" href="class_sound.html#ad1202bb1599dc1c7cb1b3267e7f8c7ff"> 69</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_sound.html#ad1202bb1599dc1c7cb1b3267e7f8c7ff">Update</a>() { }</div> +<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> </div> +<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="comment">// mark for collection:</span></div> +<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_sound.html#a3894275768425881b9d7d7af33651702">Release</a>();</div> +<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> </div> +<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="comment">// data loading:</span></div> +<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="comment">// this method is for streamed sounds:</span></div> +<div class="line"><a name="l00076"></a><span class="lineno"><a class="code" href="class_sound.html#a9938c9cfb251a25a07b2c50680e4c9de"> 76</a></span>  <span class="keyword">virtual</span> HRESULT <a class="code" href="class_sound.html#a9938c9cfb251a25a07b2c50680e4c9de">StreamFile</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* name, DWORD offset) { <span class="keywordflow">return</span> E_NOINTERFACE; }</div> +<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> </div> +<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="comment">// this method is for memory sounds:</span></div> +<div class="line"><a name="l00079"></a><span class="lineno"><a class="code" href="class_sound.html#a9222f5958426874c04a5260306f5d97f"> 79</a></span>  <span class="keyword">virtual</span> HRESULT <a class="code" href="class_sound.html#a9222f5958426874c04a5260306f5d97f">Load</a>(DWORD bytes, BYTE* data) { <span class="keywordflow">return</span> E_NOINTERFACE; } <span class="comment">// => Ready</span></div> +<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> </div> +<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="comment">// this method is for sound resources:</span></div> +<div class="line"><a name="l00082"></a><span class="lineno"><a class="code" href="class_sound.html#a0c637966828cf1c533e2e81777e3db28"> 82</a></span>  <span class="keyword">virtual</span> <a class="code" href="class_sound.html">Sound</a>* <a class="code" href="class_sound.html#a0c637966828cf1c533e2e81777e3db28">Duplicate</a>() { <span class="keywordflow">return</span> 0; } <span class="comment">// => Ready</span></div> +<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> </div> +<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="comment">// transport operations:</span></div> +<div class="line"><a name="l00085"></a><span class="lineno"><a class="code" href="class_sound.html#ae24d17b1583f2080589eb91d350106fc"> 85</a></span>  <span class="keyword">virtual</span> HRESULT <a class="code" href="class_sound.html#ae24d17b1583f2080589eb91d350106fc">Play</a>() { <span class="keywordflow">return</span> E_NOINTERFACE; } <span class="comment">// => Playing</span></div> +<div class="line"><a name="l00086"></a><span class="lineno"><a class="code" href="class_sound.html#a09d38ddf63ad5635b387b9dc5ccfea70"> 86</a></span>  <span class="keyword">virtual</span> HRESULT <a class="code" href="class_sound.html#a09d38ddf63ad5635b387b9dc5ccfea70">Rewind</a>() { <span class="keywordflow">return</span> E_NOINTERFACE; } <span class="comment">// => Ready</span></div> +<div class="line"><a name="l00087"></a><span class="lineno"><a class="code" href="class_sound.html#a8d944689f1dd7e604c27138f7b1a263d"> 87</a></span>  <span class="keyword">virtual</span> HRESULT <a class="code" href="class_sound.html#a8d944689f1dd7e604c27138f7b1a263d">Pause</a>() { <span class="keywordflow">return</span> E_NOINTERFACE; } <span class="comment">// => Ready</span></div> +<div class="line"><a name="l00088"></a><span class="lineno"><a class="code" href="class_sound.html#a552465dbf8072a7afaa70ac3eeafba91"> 88</a></span>  <span class="keyword">virtual</span> HRESULT <a class="code" href="class_sound.html#a552465dbf8072a7afaa70ac3eeafba91">Stop</a>() { <span class="keywordflow">return</span> E_NOINTERFACE; } <span class="comment">// => Done</span></div> +<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> </div> +<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <span class="comment">// accessors / mutators</span></div> +<div class="line"><a name="l00091"></a><span class="lineno"><a class="code" href="class_sound.html#a3c8a9307de7096783dc1beca450912e9"> 91</a></span>  <span class="keywordtype">int</span> <a class="code" href="class_sound.html#a3c8a9307de7096783dc1beca450912e9">IsReady</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="class_sound.html#afb7436d2b75ddedf22edae072906ad39">status</a> == <a class="code" href="class_sound.html#a13131d3f79c8fcc39b40792e2e7a6f9cabb86223b74f15901f48929155b456cd6">READY</a>; }</div> +<div class="line"><a name="l00092"></a><span class="lineno"><a class="code" href="class_sound.html#a6ff92464b345595dcaa3c50ce5c3e067"> 92</a></span>  <span class="keywordtype">int</span> <a class="code" href="class_sound.html#a6ff92464b345595dcaa3c50ce5c3e067">IsPlaying</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="class_sound.html#afb7436d2b75ddedf22edae072906ad39">status</a> == <a class="code" href="class_sound.html#a13131d3f79c8fcc39b40792e2e7a6f9caad04eb42407b6383072c808f9f0e2465">PLAYING</a>; }</div> +<div class="line"><a name="l00093"></a><span class="lineno"><a class="code" href="class_sound.html#a8a566cc51c19398d48f08eb5abeeff3b"> 93</a></span>  <span class="keywordtype">int</span> <a class="code" href="class_sound.html#a8a566cc51c19398d48f08eb5abeeff3b">IsDone</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="class_sound.html#afb7436d2b75ddedf22edae072906ad39">status</a> == <a class="code" href="class_sound.html#a13131d3f79c8fcc39b40792e2e7a6f9caaa0a51588fdd0d62f508ce217ddff71b">DONE</a>; }</div> +<div class="line"><a name="l00094"></a><span class="lineno"><a class="code" href="class_sound.html#aa403e6fe6462b6b4a7341785a875004a"> 94</a></span>  <span class="keywordtype">int</span> <a class="code" href="class_sound.html#aa403e6fe6462b6b4a7341785a875004a">LoopCount</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="class_sound.html#a8e49414860fb70c27a90c03d0b74f4eb">looped</a>; }</div> +<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> </div> +<div class="line"><a name="l00096"></a><span class="lineno"><a class="code" href="class_sound.html#a95c2b7fc367220e3ec70548f75ecb053"> 96</a></span>  <span class="keyword">virtual</span> DWORD <a class="code" href="class_sound.html#a95c2b7fc367220e3ec70548f75ecb053">GetFlags</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="class_sound.html#a45283b596dd7ebd8387af0fe45e391f8">flags</a>; }</div> +<div class="line"><a name="l00097"></a><span class="lineno"><a class="code" href="class_sound.html#ae2796672915118e7ad6df08d5c6d4f9f"> 97</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_sound.html#ae2796672915118e7ad6df08d5c6d4f9f">SetFlags</a>(DWORD f) { <a class="code" href="class_sound.html#a45283b596dd7ebd8387af0fe45e391f8">flags</a> = f; }</div> +<div class="line"><a name="l00098"></a><span class="lineno"><a class="code" href="class_sound.html#a820534ecc3e5e2ae5d8fd664f07ce1b6"> 98</a></span>  <span class="keyword">virtual</span> DWORD <a class="code" href="class_sound.html#a820534ecc3e5e2ae5d8fd664f07ce1b6">GetStatus</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="class_sound.html#afb7436d2b75ddedf22edae072906ad39">status</a>; }</div> +<div class="line"><a name="l00099"></a><span class="lineno"> 99</span> </div> +<div class="line"><a name="l00100"></a><span class="lineno"><a class="code" href="class_sound.html#a4c8f7b73b7bf5b3678dec8c920ec5925"> 100</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">long</span> <a class="code" href="class_sound.html#a4c8f7b73b7bf5b3678dec8c920ec5925">GetVolume</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="class_sound.html#af65aaa1f8ff75aaebbc06a5b0e289955">volume</a>; }</div> +<div class="line"><a name="l00101"></a><span class="lineno"><a class="code" href="class_sound.html#a2efe8c781dd8e065d5cd1cd70e361b7e"> 101</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_sound.html#a2efe8c781dd8e065d5cd1cd70e361b7e">SetVolume</a>(<span class="keywordtype">long</span> v) { <a class="code" href="class_sound.html#af65aaa1f8ff75aaebbc06a5b0e289955">volume</a> = v; }</div> +<div class="line"><a name="l00102"></a><span class="lineno"><a class="code" href="class_sound.html#a2acf83623c2ecf035fec0ffb7551b67d"> 102</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">long</span> <a class="code" href="class_sound.html#a2acf83623c2ecf035fec0ffb7551b67d">GetPan</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> 0; }</div> +<div class="line"><a name="l00103"></a><span class="lineno"><a class="code" href="class_sound.html#aa6119f6ea4286cfca8667850133f984d"> 103</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_sound.html#aa6119f6ea4286cfca8667850133f984d">SetPan</a>(<span class="keywordtype">long</span> p) { }</div> +<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> </div> +<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <span class="comment">// (only for streamed sounds)</span></div> +<div class="line"><a name="l00106"></a><span class="lineno"><a class="code" href="class_sound.html#aeb4fb27b68f2e765880e7073e0abc2f3"> 106</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">double</span> <a class="code" href="class_sound.html#aeb4fb27b68f2e765880e7073e0abc2f3">GetTotalTime</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> 0; }</div> +<div class="line"><a name="l00107"></a><span class="lineno"><a class="code" href="class_sound.html#ae6764849a2eaf5c8d9ea7d7ec22a0059"> 107</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">double</span> <a class="code" href="class_sound.html#ae6764849a2eaf5c8d9ea7d7ec22a0059">GetTimeRemaining</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> 0; }</div> +<div class="line"><a name="l00108"></a><span class="lineno"><a class="code" href="class_sound.html#a50e57e2916fb3e50bc12d0cf651af8e4"> 108</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">double</span> <a class="code" href="class_sound.html#a50e57e2916fb3e50bc12d0cf651af8e4">GetTimeElapsed</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> 0; }</div> +<div class="line"><a name="l00109"></a><span class="lineno"> 109</span> </div> +<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  <span class="comment">// These should be relative to the listener:</span></div> +<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  <span class="comment">// (only used for localized sounds)</span></div> +<div class="line"><a name="l00112"></a><span class="lineno"><a class="code" href="class_sound.html#aa6584f668371ea70ad4f64acf4c3ccae"> 112</a></span>  <span class="keyword">virtual</span> <span class="keyword">const</span> <a class="code" href="struct_vec3.html">Vec3</a>& <a class="code" href="class_sound.html#aa6584f668371ea70ad4f64acf4c3ccae">GetLocation</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="class_sound.html#a9b2fd7dac5c7aa3029a214539c5ef29c">location</a>; }</div> +<div class="line"><a name="l00113"></a><span class="lineno"><a class="code" href="class_sound.html#af785bc3312cea95e18a526189afadb3e"> 113</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_sound.html#af785bc3312cea95e18a526189afadb3e">SetLocation</a>(<span class="keyword">const</span> <a class="code" href="struct_vec3.html">Vec3</a>& l) { <a class="code" href="class_sound.html#a9b2fd7dac5c7aa3029a214539c5ef29c">location</a> = l; }</div> +<div class="line"><a name="l00114"></a><span class="lineno"><a class="code" href="class_sound.html#a3c72bf1780bd32cd572d5a17d7983376"> 114</a></span>  <span class="keyword">virtual</span> <span class="keyword">const</span> <a class="code" href="struct_vec3.html">Vec3</a>& <a class="code" href="class_sound.html#a3c72bf1780bd32cd572d5a17d7983376">GetVelocity</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="class_sound.html#a8b88afd2abaf3bc58e5777721d2157e5">velocity</a>; }</div> +<div class="line"><a name="l00115"></a><span class="lineno"><a class="code" href="class_sound.html#ad15b91100b04a88121011dbc27f2cfff"> 115</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_sound.html#ad15b91100b04a88121011dbc27f2cfff">SetVelocity</a>(<span class="keyword">const</span> <a class="code" href="struct_vec3.html">Vec3</a>& v) { <a class="code" href="class_sound.html#a8b88afd2abaf3bc58e5777721d2157e5">velocity</a> = v; }</div> +<div class="line"><a name="l00116"></a><span class="lineno"> 116</span> </div> +<div class="line"><a name="l00117"></a><span class="lineno"><a class="code" href="class_sound.html#a230d728d7967990f3c267610a768096a"> 117</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">float</span> <a class="code" href="class_sound.html#a230d728d7967990f3c267610a768096a">GetMinDistance</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> 0; }</div> +<div class="line"><a name="l00118"></a><span class="lineno"><a class="code" href="class_sound.html#af68ed04a101ecfff5175eb2eddfc3c62"> 118</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_sound.html#af68ed04a101ecfff5175eb2eddfc3c62">SetMinDistance</a>(<span class="keywordtype">float</span> f) { }</div> +<div class="line"><a name="l00119"></a><span class="lineno"><a class="code" href="class_sound.html#a5fed9a91454a206779b289d0f59f5a59"> 119</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">float</span> <a class="code" href="class_sound.html#a5fed9a91454a206779b289d0f59f5a59">GetMaxDistance</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> 0; }</div> +<div class="line"><a name="l00120"></a><span class="lineno"><a class="code" href="class_sound.html#a9101224d7dd7f9fc4c3c5fca53d62b60"> 120</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_sound.html#a9101224d7dd7f9fc4c3c5fca53d62b60">SetMaxDistance</a>(<span class="keywordtype">float</span> f) { }</div> +<div class="line"><a name="l00121"></a><span class="lineno"> 121</span> </div> +<div class="line"><a name="l00122"></a><span class="lineno"><a class="code" href="class_sound.html#a659ba942e98aeeb2711c67aaac5534e8"> 122</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_sound.html#a659ba942e98aeeb2711c67aaac5534e8">SetSoundCheck</a>(<a class="code" href="class_sound_check.html">SoundCheck</a>* s) { <a class="code" href="class_sound.html#a2e96e762a3a2496713087994d2ca1cc0">sound_check</a> = s; }</div> +<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_sound.html#a2022fd0b6a80c80b941b9183298ac526">AddToSoundCard</a>();</div> +<div class="line"><a name="l00124"></a><span class="lineno"> 124</span> </div> +<div class="line"><a name="l00125"></a><span class="lineno"><a class="code" href="class_sound.html#a87f4cc9d6850571322dbe332d43ee4c3"> 125</a></span>  <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="class_sound.html#a87f4cc9d6850571322dbe332d43ee4c3">GetFilename</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="class_sound.html#a4448663c1a7a3a6ad879de5f1b440679">filename</a>; }</div> +<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  <span class="keywordtype">void</span> <a class="code" href="class_sound.html#adcbb2c640b02ee8e6a12fdd0203f552d">SetFilename</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* s);</div> +<div class="line"><a name="l00127"></a><span class="lineno"> 127</span> </div> +<div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="keyword">protected</span>:</div> +<div class="line"><a name="l00129"></a><span class="lineno"><a class="code" href="class_sound.html#a45283b596dd7ebd8387af0fe45e391f8"> 129</a></span>  DWORD <a class="code" href="class_sound.html#a45283b596dd7ebd8387af0fe45e391f8">flags</a>;</div> +<div class="line"><a name="l00130"></a><span class="lineno"><a class="code" href="class_sound.html#afb7436d2b75ddedf22edae072906ad39"> 130</a></span>  DWORD <a class="code" href="class_sound.html#afb7436d2b75ddedf22edae072906ad39">status</a>;</div> +<div class="line"><a name="l00131"></a><span class="lineno"><a class="code" href="class_sound.html#af65aaa1f8ff75aaebbc06a5b0e289955"> 131</a></span>  <span class="keywordtype">long</span> <a class="code" href="class_sound.html#af65aaa1f8ff75aaebbc06a5b0e289955">volume</a>; <span class="comment">// centibels, (0 .. -10000)</span></div> +<div class="line"><a name="l00132"></a><span class="lineno"><a class="code" href="class_sound.html#a8e49414860fb70c27a90c03d0b74f4eb"> 132</a></span>  <span class="keywordtype">int</span> <a class="code" href="class_sound.html#a8e49414860fb70c27a90c03d0b74f4eb">looped</a>;</div> +<div class="line"><a name="l00133"></a><span class="lineno"><a class="code" href="class_sound.html#a9b2fd7dac5c7aa3029a214539c5ef29c"> 133</a></span>  <a class="code" href="struct_vec3.html">Vec3</a> <a class="code" href="class_sound.html#a9b2fd7dac5c7aa3029a214539c5ef29c">location</a>;</div> +<div class="line"><a name="l00134"></a><span class="lineno"><a class="code" href="class_sound.html#a8b88afd2abaf3bc58e5777721d2157e5"> 134</a></span>  <a class="code" href="struct_vec3.html">Vec3</a> <a class="code" href="class_sound.html#a8b88afd2abaf3bc58e5777721d2157e5">velocity</a>;</div> +<div class="line"><a name="l00135"></a><span class="lineno"><a class="code" href="class_sound.html#a2e96e762a3a2496713087994d2ca1cc0"> 135</a></span>  <a class="code" href="class_sound_check.html">SoundCheck</a>* <a class="code" href="class_sound.html#a2e96e762a3a2496713087994d2ca1cc0">sound_check</a>;</div> +<div class="line"><a name="l00136"></a><span class="lineno"><a class="code" href="class_sound.html#a4448663c1a7a3a6ad879de5f1b440679"> 136</a></span>  <span class="keywordtype">char</span> <a class="code" href="class_sound.html#a4448663c1a7a3a6ad879de5f1b440679">filename</a>[64];</div> +<div class="line"><a name="l00137"></a><span class="lineno"> 137</span> </div> +<div class="line"><a name="l00138"></a><span class="lineno"><a class="code" href="class_sound.html#adcbf76117ed07cd12e7ba04dbf28b35c"> 138</a></span>  <span class="keyword">static</span> <a class="code" href="class_sound_card.html">SoundCard</a>* <a class="code" href="class_sound.html#adcbf76117ed07cd12e7ba04dbf28b35c">creator</a>;</div> +<div class="line"><a name="l00139"></a><span class="lineno"> 139</span> };</div> +<div class="line"><a name="l00140"></a><span class="lineno"> 140</span> </div> +<div class="line"><a name="l00141"></a><span class="lineno"> 141</span> <span class="comment">// +--------------------------------------------------------------------+</span></div> +<div class="line"><a name="l00142"></a><span class="lineno"> 142</span> </div> +<div class="line"><a name="l00143"></a><span class="lineno"><a class="code" href="class_sound_check.html"> 143</a></span> <span class="keyword">class </span><a class="code" href="class_sound_check.html">SoundCheck</a></div> +<div class="line"><a name="l00144"></a><span class="lineno"> 144</span> {</div> +<div class="line"><a name="l00145"></a><span class="lineno"> 145</span> <span class="keyword">public</span>:</div> +<div class="line"><a name="l00146"></a><span class="lineno"><a class="code" href="class_sound_check.html#aad6d2c4cceaf5e9d697f877a8de27615"> 146</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_sound_check.html#aad6d2c4cceaf5e9d697f877a8de27615">Update</a>(<a class="code" href="class_sound.html">Sound</a>* s) { }</div> +<div class="line"><a name="l00147"></a><span class="lineno"> 147</span> };</div> +<div class="line"><a name="l00148"></a><span class="lineno"> 148</span> </div> +<div class="line"><a name="l00149"></a><span class="lineno"> 149</span> <span class="preprocessor">#endif Sound_h</span></div> +<div class="line"><a name="l00150"></a><span class="lineno"> 150</span> <span class="preprocessor"></span></div> +</div><!-- fragment --></div><!-- contents --> +</div><!-- doc-content --> +<!-- start footer part --> +<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> + <ul> + <li class="navelem"><a class="el" href="dir_d6625d0f3efd9eb70ff961583505095b.html">nGenEx</a></li><li class="navelem"><a class="el" href="_sound_8h.html">Sound.h</a></li> + <li class="footer">Generated on Thu May 31 2012 16:30:58 for Starshatter_Open by + <a href="http://www.doxygen.org/index.html"> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.1 </li> + </ul> +</div> +</body> +</html> |