0
0
mirror of https://github.com/Nimac0/SDL_Minigame synced 2026-01-12 12:33:43 +00:00
SDL_Minigame/SoundManager_8h_source.html

226 lines
23 KiB
HTML

<!-- HTML header for doxygen 1.10.0-->
<!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.13.2" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>VEGO-Engine: include/SoundManager.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>
<script type="text/javascript" src="clipboard.js"></script>
<script type="text/javascript" src="doxygen-awesome-darkmode-toggle.js"></script>
<script type="text/javascript">
DoxygenAwesomeDarkModeToggle.init()
</script>
<script type="text/javascript" src="doxygen-awesome-fragment-copy-button.js"></script>
<script type="text/javascript">
DoxygenAwesomeFragmentCopyButton.init()
</script>
<script type="text/javascript" src="doxygen-awesome-paragraph-link.js"></script>
<script type="text/javascript">
DoxygenAwesomeParagraphLink.init()
</script>
<script type="text/javascript" src="doxygen-awesome-interactive-toc.js"></script>
<script type="text/javascript">
DoxygenAwesomeInteractiveToc.init()
</script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.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="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
<link href="doxygen-awesome-sidebar-only.css" rel="stylesheet" type="text/css"/>
<link href="doxygen-awesome-sidebar-only-darkmode-toggle.css" rel="stylesheet" type="text/css"/>
<link href="custom.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">VEGO-Engine
<span id="projectnumber">&#160;0.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.13.2 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @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&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search',true);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('SoundManager_8h_source.html',''); initResizable(true); });
/* @license-end */
</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)">
</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 class="header">
<div class="headertitle"><div class="title">SoundManager.h</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span> </div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="preprocessor">#include &lt;SDL3_mixer/SDL_mixer.h&gt;</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#include &lt;map&gt;</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#include &lt;vector&gt;</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span> </div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#include &quot;ECS.h&quot;</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#include &quot;TextureManager.h&quot;</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include &quot;BackgroundMusic.h&quot;</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="preprocessor">#include &quot;SoundEffects.h&quot;</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span> </div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="keyword">class </span>GameInternal;</div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span></div>
<div class="foldopen" id="foldopen00020" data-start="{" data-end="};">
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"><a class="line" href="classSoundManager.html"> 20</a></span><span class="keyword">class </span>SoundManager</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span>{</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> </div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> <span class="keyword">public</span>:</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> </div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> SoundManager() {</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> <span class="keywordflow">if</span> (this_instance == <span class="keyword">nullptr</span>) {</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> this_instance = <span class="keyword">this</span>;</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> }</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> <span class="keywordflow">else</span> {</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> <span class="keywordflow">throw</span> std::runtime_error(<span class="stringliteral">&quot;SoundManager instance already exists!&quot;</span>);</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> }</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> }</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> ~SoundManager() {</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> <span class="keywordflow">for</span> (<span class="keyword">auto</span>&amp; it : this-&gt;sound_cache) {</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> Mix_FreeChunk(it.second);</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> }</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> </div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> <span class="keywordflow">for</span> (<span class="keyword">auto</span>&amp; it : this-&gt;music_cache) {</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> Mix_FreeMusic(it.second);</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> }</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> }</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> </div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> SoundManager(SoundManager <span class="keyword">const</span>&amp;) = <span class="keyword">delete</span>;</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> <span class="keywordtype">void</span> operator=(SoundManager <span class="keyword">const</span>&amp;) = <span class="keyword">delete</span>;</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> </div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> <span class="comment">/*</span></div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span><span class="comment"> * \brief Loads music from a file (mp3)</span></div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span><span class="comment"> * \returns a pointer to Mix_Music</span></div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span><span class="comment"> * \sa AssetManager::AddMusic(std::string id, const char* path)</span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span><span class="comment"></span> </div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span><span class="comment"> Mix_Music* loadMusic(const char* fileName); </span></div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classSoundManager.html#a1065dec9d90a6fc8a363329a6e09ea42">playSound</a>(SoundEffects sound, <span class="keywordtype">bool</span> canOverlap, <span class="keywordtype">int</span> loops, <span class="keywordtype">int</span> volume, <span class="keywordtype">int</span> channel);</div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classSoundManager.html#a6f38946a458843cfc08ebd9e26c648a5">playMusic</a>(BackgroundMusic sound, <span class="keywordtype">int</span> loops, <span class="keywordtype">int</span> volume, <span class="keywordtype">int</span> milliseconds);</div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> </div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classSoundManager.html#af99aee751f8300ba4041af004a97d319">setSoundVolume</a>(<span class="keywordtype">int</span> volume, <span class="keywordtype">int</span> channel); </div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classSoundManager.html#ac5ad38c2322c75ba5481c60c4c26e0e8">setMusicVolume</a>(<span class="keywordtype">int</span> volume); </div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> </div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classSoundManager.html#a8031476c2ccd2dd1c40a39a102bc5844">pauseSound</a>(<span class="keywordtype">int</span> channel); </div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classSoundManager.html#a5071bf5e87394afdb1e4148227ffc3ea">pauseMusic</a>(); </div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> </div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classSoundManager.html#ac24dc06983603020f6556273d3c78df3">restartSound</a>(<span class="keywordtype">int</span> channel); </div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classSoundManager.html#aaca970232ead83c6c107331f3d9ee0db">restartMusic</a>(); </div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> </div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classSoundManager.html#aea6a94c8b5456812c49115baa7534bf7">fadeOutMusic</a>(<span class="keywordtype">int</span> ms); </div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span></div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classSoundManager.html#a552795938033c602a28162fec202d20c">addSoundEffects</a>(<span class="keyword">const</span> std::map&lt;SoundEffects, const char*&gt; &amp;effects);</div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span></div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span> <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classSoundManager.html#a8717fc6cbf4cc3e863eda97deacad007">addBackgroundMusic</a>(<span class="keyword">const</span> std::map&lt;BackgroundMusic, const char*&gt; &amp;backgroundMusic);</div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span> </div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> <span class="keyword">static</span> SoundManager* getInstance() {</div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span> <span class="keywordflow">return</span> this_instance;</div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span> }</div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span> </div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span> </div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span> <span class="keyword">private</span>:</div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span> </div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span> std::map&lt;BackgroundMusic, Mix_Music*&gt; music_cache;</div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span> std::map&lt;SoundEffects, Mix_Chunk*&gt; sound_cache;</div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span> <span class="keyword">static</span> SoundManager* this_instance;</div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span> </div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span> <span class="keyword">static</span> <span class="keywordtype">void</span> addSingleBackgroundMusic(BackgroundMusic backgroundMusic, <span class="keyword">const</span> <span class="keywordtype">char</span>* path);</div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span> <span class="keyword">static</span> <span class="keywordtype">void</span> addSingleSoundEffect(SoundEffects soundEffect, <span class="keyword">const</span> <span class="keywordtype">char</span>* path);</div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span>};</div>
</div>
<div class="ttc" id="aclassSoundManager_html_a1065dec9d90a6fc8a363329a6e09ea42"><div class="ttname"><a href="classSoundManager.html#a1065dec9d90a6fc8a363329a6e09ea42">SoundManager::playSound</a></div><div class="ttdeci">static void playSound(SoundEffects sound, bool canOverlap, int loops, int volume, int channel)</div><div class="ttdoc">Handles playing of sound effects.</div><div class="ttdef"><b>Definition</b> SoundManager.cpp:53</div></div>
<div class="ttc" id="aclassSoundManager_html_a5071bf5e87394afdb1e4148227ffc3ea"><div class="ttname"><a href="classSoundManager.html#a5071bf5e87394afdb1e4148227ffc3ea">SoundManager::pauseMusic</a></div><div class="ttdeci">static void pauseMusic()</div><div class="ttdoc">Handles pausing music track.</div><div class="ttdef"><b>Definition</b> SoundManager.cpp:122</div></div>
<div class="ttc" id="aclassSoundManager_html_a552795938033c602a28162fec202d20c"><div class="ttname"><a href="classSoundManager.html#a552795938033c602a28162fec202d20c">SoundManager::addSoundEffects</a></div><div class="ttdeci">static void addSoundEffects(const std::map&lt; SoundEffects, const char * &gt; &amp;effects)</div><div class="ttdoc">Initializes sound-effects and adds them to a cache.</div><div class="ttdef"><b>Definition</b> SoundManager.cpp:177</div></div>
<div class="ttc" id="aclassSoundManager_html_a6f38946a458843cfc08ebd9e26c648a5"><div class="ttname"><a href="classSoundManager.html#a6f38946a458843cfc08ebd9e26c648a5">SoundManager::playMusic</a></div><div class="ttdeci">static void playMusic(BackgroundMusic sound, int loops, int volume, int milliseconds)</div><div class="ttdoc">Handles playing of music.</div><div class="ttdef"><b>Definition</b> SoundManager.cpp:85</div></div>
<div class="ttc" id="aclassSoundManager_html_a8031476c2ccd2dd1c40a39a102bc5844"><div class="ttname"><a href="classSoundManager.html#a8031476c2ccd2dd1c40a39a102bc5844">SoundManager::pauseSound</a></div><div class="ttdeci">static void pauseSound(int channel)</div><div class="ttdoc">Handles pausing sound effects (either all or on a specific channel)</div><div class="ttdef"><b>Definition</b> SoundManager.cpp:117</div></div>
<div class="ttc" id="aclassSoundManager_html_a8717fc6cbf4cc3e863eda97deacad007"><div class="ttname"><a href="classSoundManager.html#a8717fc6cbf4cc3e863eda97deacad007">SoundManager::addBackgroundMusic</a></div><div class="ttdeci">static void addBackgroundMusic(const std::map&lt; BackgroundMusic, const char * &gt; &amp;backgroundMusic)</div><div class="ttdoc">Initializes background-music and adds them to a cache.</div><div class="ttdef"><b>Definition</b> SoundManager.cpp:182</div></div>
<div class="ttc" id="aclassSoundManager_html_aaca970232ead83c6c107331f3d9ee0db"><div class="ttname"><a href="classSoundManager.html#aaca970232ead83c6c107331f3d9ee0db">SoundManager::restartMusic</a></div><div class="ttdeci">static void restartMusic()</div><div class="ttdoc">Handles resuming music track.</div><div class="ttdef"><b>Definition</b> SoundManager.cpp:132</div></div>
<div class="ttc" id="aclassSoundManager_html_ac24dc06983603020f6556273d3c78df3"><div class="ttname"><a href="classSoundManager.html#ac24dc06983603020f6556273d3c78df3">SoundManager::restartSound</a></div><div class="ttdeci">static void restartSound(int channel)</div><div class="ttdoc">Handles resuming sound effects (either all or on a specific channel)</div><div class="ttdef"><b>Definition</b> SoundManager.cpp:127</div></div>
<div class="ttc" id="aclassSoundManager_html_ac5ad38c2322c75ba5481c60c4c26e0e8"><div class="ttname"><a href="classSoundManager.html#ac5ad38c2322c75ba5481c60c4c26e0e8">SoundManager::setMusicVolume</a></div><div class="ttdeci">static void setMusicVolume(int volume)</div><div class="ttdoc">Volume handling for music track.</div><div class="ttdef"><b>Definition</b> SoundManager.cpp:112</div></div>
<div class="ttc" id="aclassSoundManager_html_aea6a94c8b5456812c49115baa7534bf7"><div class="ttname"><a href="classSoundManager.html#aea6a94c8b5456812c49115baa7534bf7">SoundManager::fadeOutMusic</a></div><div class="ttdeci">static void fadeOutMusic(int ms)</div><div class="ttdoc">Handles fading out a music track.</div><div class="ttdef"><b>Definition</b> SoundManager.cpp:137</div></div>
<div class="ttc" id="aclassSoundManager_html_af99aee751f8300ba4041af004a97d319"><div class="ttname"><a href="classSoundManager.html#af99aee751f8300ba4041af004a97d319">SoundManager::setSoundVolume</a></div><div class="ttdeci">static void setSoundVolume(int volume, int channel)</div><div class="ttdoc">Volume handling for sound effects (either all or on a specific channel)</div><div class="ttdef"><b>Definition</b> SoundManager.cpp:107</div></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_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><b>SoundManager.h</b></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.13.2 </li>
</ul>
</div>
</body>
</html>