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_card_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_card_8h_source.html')
| -rw-r--r-- | Doc/doxygen/html/_sound_card_8h_source.html | 193 |
1 files changed, 193 insertions, 0 deletions
diff --git a/Doc/doxygen/html/_sound_card_8h_source.html b/Doc/doxygen/html/_sound_card_8h_source.html new file mode 100644 index 0000000..a09c5cd --- /dev/null +++ b/Doc/doxygen/html/_sound_card_8h_source.html @@ -0,0 +1,193 @@ +<!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/SoundCard.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_card_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">SoundCard.h</div> </div> +</div><!--header--> +<div class="contents"> +<a href="_sound_card_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: SoundCard.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 Audio Output class (hides details of DirectSound)</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 SoundCard_h</span></div> +<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor"></span><span class="preprocessor">#define SoundCard_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="_list_8h.html">List.h</a>"</span></div> +<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#include "<a class="code" href="_thread_sync_8h.html">ThreadSync.h</a>"</span></div> +<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div> +<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment">// +--------------------------------------------------------------------+</span></div> +<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> </div> +<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="keyword">class </span><a class="code" href="class_sound.html">Sound</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> <span class="keyword">struct </span><a class="code" href="struct_vec3.html">Vec3</a>;</div> +<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div> +<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment">// +--------------------------------------------------------------------+</span></div> +<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div> +<div class="line"><a name="l00030"></a><span class="lineno"><a class="code" href="class_sound_card.html"> 30</a></span> <span class="keyword">class </span><a class="code" href="class_sound_card.html">SoundCard</a></div> +<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> {</div> +<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="keyword">public</span>:</div> +<div class="line"><a name="l00033"></a><span class="lineno"><a class="code" href="class_sound_card.html#ac29f36ab613a1e24bbb58103e62d8030"> 33</a></span>  <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="class_sound_card.html#ac29f36ab613a1e24bbb58103e62d8030">TYPENAME</a>() { <span class="keywordflow">return</span> <span class="stringliteral">"SoundCard"</span>; }</div> +<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div> +<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <a class="code" href="class_sound_card.html#a8f4bc07cab4ce48af805f44ff6fc3b0f">SoundCard</a>();</div> +<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="keyword">virtual</span> <a class="code" href="class_sound_card.html#aa1beb2fa225c05017009d860b812bf3b">~SoundCard</a>();</div> +<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div> +<div class="line"><a name="l00038"></a><span class="lineno"><a class="code" href="class_sound_card.html#adb6e4f8ab3dd8ab1b437f0fcf6526104"> 38</a></span>  <span class="keyword">enum</span> <a class="code" href="class_sound_card.html#adb6e4f8ab3dd8ab1b437f0fcf6526104">SoundStatus</a> { <a class="code" href="class_sound_card.html#adb6e4f8ab3dd8ab1b437f0fcf6526104afe5353d550b9d617e2a6c22960c5c203">SC_UNINITIALIZED</a>,</div> +<div class="line"><a name="l00039"></a><span class="lineno"><a class="code" href="class_sound_card.html#adb6e4f8ab3dd8ab1b437f0fcf6526104af3dc954d02ee305b2dce743d44e7c019"> 39</a></span>  <a class="code" href="class_sound_card.html#adb6e4f8ab3dd8ab1b437f0fcf6526104af3dc954d02ee305b2dce743d44e7c019">SC_OK</a>,</div> +<div class="line"><a name="l00040"></a><span class="lineno"><a class="code" href="class_sound_card.html#adb6e4f8ab3dd8ab1b437f0fcf6526104a459daa0dea7bff04887cd18be686be01"> 40</a></span>  <a class="code" href="class_sound_card.html#adb6e4f8ab3dd8ab1b437f0fcf6526104a459daa0dea7bff04887cd18be686be01">SC_ERROR</a>,</div> +<div class="line"><a name="l00041"></a><span class="lineno"><a class="code" href="class_sound_card.html#adb6e4f8ab3dd8ab1b437f0fcf6526104a4ec3491fbb247d050e4db7b19ecbce6d"> 41</a></span>  <a class="code" href="class_sound_card.html#adb6e4f8ab3dd8ab1b437f0fcf6526104a4ec3491fbb247d050e4db7b19ecbce6d">SC_BAD_PARAM</a> };</div> +<div class="line"><a name="l00042"></a><span class="lineno"><a class="code" href="class_sound_card.html#a87c4c9952749fa6fa1b562312d990d8a"> 42</a></span>  <a class="code" href="class_sound_card.html#adb6e4f8ab3dd8ab1b437f0fcf6526104">SoundStatus</a> <a class="code" href="class_sound_card.html#a87c4c9952749fa6fa1b562312d990d8a">Status</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="class_sound_card.html#a0a16da2376864efe6010244139b55940">status</a>; }</div> +<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div> +<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="comment">// Format of the sound card's primary buffer:</span></div> +<div class="line"><a name="l00045"></a><span class="lineno"><a class="code" href="class_sound_card.html#aaae88bb2313464475af721f89051fb89"> 45</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="class_sound_card.html#aaae88bb2313464475af721f89051fb89">GetFormat</a>(LPWAVEFORMATEX format) { <span class="keywordflow">return</span> <span class="keyword">false</span>; }</div> +<div class="line"><a name="l00046"></a><span class="lineno"><a class="code" href="class_sound_card.html#a33f4b7ffd836c83ec91d1c6092a8cb03"> 46</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="class_sound_card.html#a33f4b7ffd836c83ec91d1c6092a8cb03">SetFormat</a>(LPWAVEFORMATEX format) { <span class="keywordflow">return</span> <span class="keyword">false</span>; }</div> +<div class="line"><a name="l00047"></a><span class="lineno"><a class="code" href="class_sound_card.html#a4d9aefeb7b146297b750847a1dc65306"> 47</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="class_sound_card.html#a4d9aefeb7b146297b750847a1dc65306">SetFormat</a>(<span class="keywordtype">int</span> bits, <span class="keywordtype">int</span> channels, <span class="keywordtype">int</span> hertz) { <span class="keywordflow">return</span> <span class="keyword">false</span>; }</div> +<div class="line"><a name="l00048"></a><span class="lineno"><a class="code" href="class_sound_card.html#af43919386a97c5b1b76cc39c87dfedc0"> 48</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="class_sound_card.html#af43919386a97c5b1b76cc39c87dfedc0">Pause</a>() { <span class="keywordflow">return</span> <span class="keyword">false</span>; }</div> +<div class="line"><a name="l00049"></a><span class="lineno"><a class="code" href="class_sound_card.html#ad4332165da531274b012d38e44598fe3"> 49</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="class_sound_card.html#ad4332165da531274b012d38e44598fe3">Resume</a>() { <span class="keywordflow">return</span> <span class="keyword">false</span>; }</div> +<div class="line"><a name="l00050"></a><span class="lineno"><a class="code" href="class_sound_card.html#a22a00327f5307cdf3336b17596f08a86"> 50</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="class_sound_card.html#a22a00327f5307cdf3336b17596f08a86">StopSoundEffects</a>() { <span class="keywordflow">return</span> <span class="keyword">false</span>; }</div> +<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div> +<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="comment">// Get a blank, writable sound buffer:</span></div> +<div class="line"><a name="l00053"></a><span class="lineno"><a class="code" href="class_sound_card.html#a2257c3481189f1437aa87fc242a5ac9e"> 53</a></span>  <span class="keyword">virtual</span> <a class="code" href="class_sound.html">Sound</a>* <a class="code" href="class_sound_card.html#a2257c3481189f1437aa87fc242a5ac9e">CreateSound</a>(DWORD flags, LPWAVEFORMATEX format) { <span class="keywordflow">return</span> 0; }</div> +<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div> +<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="comment">// Create a sound resource:</span></div> +<div class="line"><a name="l00056"></a><span class="lineno"><a class="code" href="class_sound_card.html#a297a9bbd87ff7021aede93cda57e11ab"> 56</a></span>  <span class="keyword">virtual</span> <a class="code" href="class_sound.html">Sound</a>* <a class="code" href="class_sound_card.html#a2257c3481189f1437aa87fc242a5ac9e">CreateSound</a>(DWORD flags, LPWAVEFORMATEX format,</div> +<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  DWORD len, LPBYTE data) { <span class="keywordflow">return</span> 0; }</div> +<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> </div> +<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="comment">// once per frame:</span></div> +<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_sound_card.html#ae4a79af5386397eb9074836407e92a4e">Update</a>();</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_card.html#a7b5260d09de5daac0363d48e2781f8f3"> 62</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_sound_card.html#a7b5260d09de5daac0363d48e2781f8f3">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="l00063"></a><span class="lineno"> 63</span>  <span class="keyword">virtual</span> DWORD <a class="code" href="class_sound_card.html#a7854a5ac9eefd3a34993dca6ad4dbe98">UpdateThread</a>();</div> +<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_sound_card.html#af7a97defed7604a5cc2fa7c3b8ce6646">AddSound</a>(<a class="code" href="class_sound.html">Sound</a>* s);</div> +<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> </div> +<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="keyword">protected</span>:</div> +<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> </div> +<div class="line"><a name="l00068"></a><span class="lineno"><a class="code" href="class_sound_card.html#a4a115438febf63499b95a27db41ae768"> 68</a></span>  <span class="keywordtype">bool</span> <a class="code" href="class_sound_card.html#a4a115438febf63499b95a27db41ae768">shutdown</a>;</div> +<div class="line"><a name="l00069"></a><span class="lineno"><a class="code" href="class_sound_card.html#a395932f35224d853597adf61e7b5a0de"> 69</a></span>  HANDLE <a class="code" href="class_sound_card.html#a395932f35224d853597adf61e7b5a0de">hthread</a>;</div> +<div class="line"><a name="l00070"></a><span class="lineno"><a class="code" href="class_sound_card.html#a0a16da2376864efe6010244139b55940"> 70</a></span>  <a class="code" href="class_sound_card.html#adb6e4f8ab3dd8ab1b437f0fcf6526104">SoundStatus</a> <a class="code" href="class_sound_card.html#a0a16da2376864efe6010244139b55940">status</a>;</div> +<div class="line"><a name="l00071"></a><span class="lineno"><a class="code" href="class_sound_card.html#afc5d179c251de262e186cc1e21034edb"> 71</a></span>  <a class="code" href="class_list.html">List<Sound></a> <a class="code" href="class_sound_card.html#afc5d179c251de262e186cc1e21034edb">sounds</a>;</div> +<div class="line"><a name="l00072"></a><span class="lineno"><a class="code" href="class_sound_card.html#a88f612a0fd4d70d54f23d10d7c55eb9d"> 72</a></span>  <a class="code" href="class_thread_sync.html">ThreadSync</a> <a class="code" href="class_sound_card.html#a88f612a0fd4d70d54f23d10d7c55eb9d">sync</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> </div> +<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="preprocessor">#endif SoundCard_h</span></div> +<div class="line"><a name="l00076"></a><span class="lineno"> 76</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_card_8h.html">SoundCard.h</a></li> + <li class="footer">Generated on Thu May 31 2012 16:30:59 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> |