mirror of
https://github.com/Nimac0/SDL_Minigame
synced 2026-01-12 13:43:41 +00:00
201 lines
20 KiB
HTML
201 lines
20 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.12.0" />
|
|
<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"> 0.1</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.12.0 -->
|
|
<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">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&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&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&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 <SDL_mixer.h></span></div>
|
|
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#include <map></span></div>
|
|
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#include <vector></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 "ECS.h"</span></div>
|
|
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#include "TextureManager.h"</span></div>
|
|
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span> </div>
|
|
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="keyword">class </span><a class="code hl_class" href="classGameInternal.html">GameInternal</a>;</div>
|
|
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span> </div>
|
|
<div class="foldopen" id="foldopen00018" data-start="{" data-end="};">
|
|
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"><a class="line" href="classSoundManager.html"> 18</a></span><span class="keyword">class </span><a class="code hl_class" href="classSoundManager.html">SoundManager</a></div>
|
|
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span>{</div>
|
|
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> <span class="keyword">public</span>:</div>
|
|
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> <a class="code hl_class" href="classSoundManager.html">SoundManager</a>() {}</div>
|
|
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> <a class="code hl_class" href="classSoundManager.html">~SoundManager</a>() {</div>
|
|
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> <span class="keywordflow">for</span> (<span class="keyword">auto</span>& it : this->sound_cache) {</div>
|
|
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> Mix_FreeChunk(it.second);</div>
|
|
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> }</div>
|
|
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> </div>
|
|
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> <span class="keywordflow">for</span> (<span class="keyword">auto</span>& it : this->music_cache) {</div>
|
|
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> Mix_FreeMusic(it.second);</div>
|
|
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> }</div>
|
|
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</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> <a class="code hl_class" href="classSoundManager.html">SoundManager</a>(<a class="code hl_class" href="classSoundManager.html">SoundManager</a> <span class="keyword">const</span>&) = <span class="keyword">delete</span>;</div>
|
|
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> <span class="keywordtype">void</span> operator=(<a class="code hl_class" href="classSoundManager.html">SoundManager</a> <span class="keyword">const</span>&) = <span class="keyword">delete</span>;</div>
|
|
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> </div>
|
|
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> std::map<const char*, Mix_Music*> music_cache;</div>
|
|
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> std::map<const char*, Mix_Chunk*> sound_cache;</div>
|
|
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> </div>
|
|
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> Mix_Music* <a class="code hl_function" href="classSoundManager.html#ab7400b9492a9abbff59600d3466463f7">loadMusic</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* fileName); </div>
|
|
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> Mix_Chunk* <a class="code hl_function" href="classSoundManager.html#a1709ad13be7aa35945288fe7881ef886">loadSound</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* fileName);</div>
|
|
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> </div>
|
|
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classSoundManager.html#a868041e81dbc012629f78063201acc02">playSound</a>(<a class="code hl_class" href="classGameInternal.html">GameInternal</a>* game, std::string 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="l00063" name="l00063"></a><span class="lineno"> 63</span> <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classSoundManager.html#ad6e691964b526b134495b7bcc60e3745">playMusic</a>(<a class="code hl_class" href="classGameInternal.html">GameInternal</a>* game, std::string sound, <span class="keywordtype">int</span> loops, <span class="keywordtype">int</span> volume, <span class="keywordtype">int</span> ms);</div>
|
|
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</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#af99aee751f8300ba4041af004a97d319">setSoundVolume</a>(<span class="keywordtype">int</span> volume, <span class="keywordtype">int</span> channel); </div>
|
|
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</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="l00067" name="l00067"></a><span class="lineno"> 67</span> </div>
|
|
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</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="l00069" name="l00069"></a><span class="lineno"> 69</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="l00070" name="l00070"></a><span class="lineno"> 70</span> </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#ac24dc06983603020f6556273d3c78df3">restartSound</a>(<span class="keywordtype">int</span> channel); </div>
|
|
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</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="l00073" name="l00073"></a><span class="lineno"> 73</span> </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#aea6a94c8b5456812c49115baa7534bf7">fadeOutMusic</a>(<span class="keywordtype">int</span> ms); </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">private</span>:</div>
|
|
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span>};</div>
|
|
</div>
|
|
<div class="ttc" id="aclassGameInternal_html"><div class="ttname"><a href="classGameInternal.html">GameInternal</a></div><div class="ttdef"><b>Definition</b> GameInternal.h:24</div></div>
|
|
<div class="ttc" id="aclassSoundManager_html"><div class="ttname"><a href="classSoundManager.html">SoundManager</a></div><div class="ttdoc">Handles music and sound.</div><div class="ttdef"><b>Definition</b> SoundManager.h:19</div></div>
|
|
<div class="ttc" id="aclassSoundManager_html_a1709ad13be7aa35945288fe7881ef886"><div class="ttname"><a href="classSoundManager.html#a1709ad13be7aa35945288fe7881ef886">SoundManager::loadSound</a></div><div class="ttdeci">Mix_Chunk * loadSound(const char *fileName)</div><div class="ttdoc">Loads sound effects from a file (wav)</div><div class="ttdef"><b>Definition</b> SoundManager.cpp:30</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:114</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:109</div></div>
|
|
<div class="ttc" id="aclassSoundManager_html_a868041e81dbc012629f78063201acc02"><div class="ttname"><a href="classSoundManager.html#a868041e81dbc012629f78063201acc02">SoundManager::playSound</a></div><div class="ttdeci">static void playSound(GameInternal *game, std::string 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:50</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:124</div></div>
|
|
<div class="ttc" id="aclassSoundManager_html_ab7400b9492a9abbff59600d3466463f7"><div class="ttname"><a href="classSoundManager.html#ab7400b9492a9abbff59600d3466463f7">SoundManager::loadMusic</a></div><div class="ttdeci">Mix_Music * loadMusic(const char *fileName)</div><div class="ttdoc">Loads music from a file (mp3)</div><div class="ttdef"><b>Definition</b> SoundManager.cpp:10</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:119</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:104</div></div>
|
|
<div class="ttc" id="aclassSoundManager_html_ad6e691964b526b134495b7bcc60e3745"><div class="ttname"><a href="classSoundManager.html#ad6e691964b526b134495b7bcc60e3745">SoundManager::playMusic</a></div><div class="ttdeci">static void playMusic(GameInternal *game, std::string sound, int loops, int volume, int ms)</div><div class="ttdoc">Handles playing of music.</div><div class="ttdef"><b>Definition</b> SoundManager.cpp:77</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:129</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:99</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.12.0 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|