mirror of
https://github.com/zoriya/Bomberman.git
synced 2026-06-03 18:31:17 +00:00
AnonymusRaccoon
129 lines
12 KiB
HTML
129 lines
12 KiB
HTML
<!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">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.17"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>Bomberman: lib/Ray/sources/Audio/IAudio.hpp 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="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" />
|
|
</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 id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">Bomberman
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.17 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
/* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */</script>
|
|
<div id="main-nav"></div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_97aefd0d527b934f1d99a682da8fe6a9.html">lib</a></li><li class="navelem"><a class="el" href="dir_97e082ce3407cc227854e8f48930bd75.html">Ray</a></li><li class="navelem"><a class="el" href="dir_6a062873ed3e64cc8025242d19396498.html">sources</a></li><li class="navelem"><a class="el" href="dir_0919e1857922d4bbd9d3c7584667ce32.html">Audio</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">IAudio.hpp</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="IAudio_8hpp.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">/*</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">** EPITECH PROJECT, 2021</span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">** Bomberman</span></div>
|
|
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">** File description:</span></div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">** Audio</span></div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>  </div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#ifndef AUDIO_HPP_</span></div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#define AUDIO_HPP_</span></div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#include <string></span></div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>  </div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"><a class="line" href="namespaceRAY_1_1Audio.html"> 12</a></span> <span class="keyword">namespace </span><a class="code" href="namespaceRAY_1_1Audio.html">RAY::Audio</a></div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> {</div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"><a class="line" href="classRAY_1_1Audio_1_1IAudio.html"> 15</a></span>  <span class="keyword">class </span><a class="code" href="classRAY_1_1Audio_1_1IAudio.html">IAudio</a> {</div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>  <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>  <span class="keyword">virtual</span> <a class="code" href="classRAY_1_1Audio_1_1IAudio.html#a938bd87a19a3ab8ef0a5e1f02106f4d1">~IAudio</a>() = <span class="keywordflow">default</span>;</div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  </div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classRAY_1_1Audio_1_1IAudio.html#a646994b4477ca83939dbc2240ab9d2fe">isPlaying</a>(<span class="keywordtype">void</span>) = 0;</div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  </div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  <span class="keyword">virtual</span> <a class="code" href="classRAY_1_1Audio_1_1IAudio.html">IAudio</a> &<a class="code" href="classRAY_1_1Audio_1_1IAudio.html#aa613d07f901d91944a626dfb3bfafdbd">play</a>(<span class="keywordtype">void</span>) = 0;</div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  </div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  <span class="keyword">virtual</span> <a class="code" href="classRAY_1_1Audio_1_1IAudio.html">IAudio</a> &<a class="code" href="classRAY_1_1Audio_1_1IAudio.html#ad3a22a8539e33e68a241470b78cc3d96">stop</a>(<span class="keywordtype">void</span>) = 0;</div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  </div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  <span class="keyword">virtual</span> <a class="code" href="classRAY_1_1Audio_1_1IAudio.html">IAudio</a> &<a class="code" href="classRAY_1_1Audio_1_1IAudio.html#a64eead3083d58c84f32d9f44030c5449">pause</a>(<span class="keywordtype">void</span>) = 0;</div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  </div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  <span class="keyword">virtual</span> <a class="code" href="classRAY_1_1Audio_1_1IAudio.html">IAudio</a> &<a class="code" href="classRAY_1_1Audio_1_1IAudio.html#a763eaabbbc35b534e5cdabc0d52f21d8">resume</a>(<span class="keywordtype">void</span>) = 0;</div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  </div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="keyword">virtual</span> <a class="code" href="classRAY_1_1Audio_1_1IAudio.html">IAudio</a> &<a class="code" href="classRAY_1_1Audio_1_1IAudio.html#a621c3e5a5fac70734350a605cba8922c">setVolume</a>(<span class="keywordtype">float</span> volume) = 0;</div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  </div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="comment">// Set pitch for a audio (1.0 is base level)</span></div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keyword">virtual</span> <a class="code" href="classRAY_1_1Audio_1_1IAudio.html">IAudio</a> &<a class="code" href="classRAY_1_1Audio_1_1IAudio.html#a39d97be467eb0a7ae8f9ec7561674bd5">setPitch</a>(<span class="keywordtype">float</span> pitch) = 0;</div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  </div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keyword">protected</span>:</div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keyword">private</span>:</div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  };</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>  </div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="preprocessor">#endif </span><span class="comment">/* !AUDIO_HPP_ */</span><span class="preprocessor"></span></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<div class="ttc" id="aclassRAY_1_1Audio_1_1IAudio_html_a621c3e5a5fac70734350a605cba8922c"><div class="ttname"><a href="classRAY_1_1Audio_1_1IAudio.html#a621c3e5a5fac70734350a605cba8922c">RAY::Audio::IAudio::setVolume</a></div><div class="ttdeci">virtual IAudio & setVolume(float volume)=0</div><div class="ttdoc">Set volume for audio (1.0 is max level)</div></div>
|
|
<div class="ttc" id="aclassRAY_1_1Audio_1_1IAudio_html"><div class="ttname"><a href="classRAY_1_1Audio_1_1IAudio.html">RAY::Audio::IAudio</a></div><div class="ttdoc">Interface for Audio ressources.</div><div class="ttdef"><b>Definition:</b> IAudio.hpp:15</div></div>
|
|
<div class="ttc" id="aclassRAY_1_1Audio_1_1IAudio_html_a39d97be467eb0a7ae8f9ec7561674bd5"><div class="ttname"><a href="classRAY_1_1Audio_1_1IAudio.html#a39d97be467eb0a7ae8f9ec7561674bd5">RAY::Audio::IAudio::setPitch</a></div><div class="ttdeci">virtual IAudio & setPitch(float pitch)=0</div></div>
|
|
<div class="ttc" id="aclassRAY_1_1Audio_1_1IAudio_html_a646994b4477ca83939dbc2240ab9d2fe"><div class="ttname"><a href="classRAY_1_1Audio_1_1IAudio.html#a646994b4477ca83939dbc2240ab9d2fe">RAY::Audio::IAudio::isPlaying</a></div><div class="ttdeci">virtual bool isPlaying(void)=0</div><div class="ttdoc">Check if audio is playing.</div></div>
|
|
<div class="ttc" id="aclassRAY_1_1Audio_1_1IAudio_html_aa613d07f901d91944a626dfb3bfafdbd"><div class="ttname"><a href="classRAY_1_1Audio_1_1IAudio.html#aa613d07f901d91944a626dfb3bfafdbd">RAY::Audio::IAudio::play</a></div><div class="ttdeci">virtual IAudio & play(void)=0</div><div class="ttdoc">Start audio.</div></div>
|
|
<div class="ttc" id="aclassRAY_1_1Audio_1_1IAudio_html_ad3a22a8539e33e68a241470b78cc3d96"><div class="ttname"><a href="classRAY_1_1Audio_1_1IAudio.html#ad3a22a8539e33e68a241470b78cc3d96">RAY::Audio::IAudio::stop</a></div><div class="ttdeci">virtual IAudio & stop(void)=0</div><div class="ttdoc">Stop audio playing.</div></div>
|
|
<div class="ttc" id="aclassRAY_1_1Audio_1_1IAudio_html_a938bd87a19a3ab8ef0a5e1f02106f4d1"><div class="ttname"><a href="classRAY_1_1Audio_1_1IAudio.html#a938bd87a19a3ab8ef0a5e1f02106f4d1">RAY::Audio::IAudio::~IAudio</a></div><div class="ttdeci">virtual ~IAudio()=default</div></div>
|
|
<div class="ttc" id="anamespaceRAY_1_1Audio_html"><div class="ttname"><a href="namespaceRAY_1_1Audio.html">RAY::Audio</a></div><div class="ttdef"><b>Definition:</b> IAudio.hpp:12</div></div>
|
|
<div class="ttc" id="aclassRAY_1_1Audio_1_1IAudio_html_a64eead3083d58c84f32d9f44030c5449"><div class="ttname"><a href="classRAY_1_1Audio_1_1IAudio.html#a64eead3083d58c84f32d9f44030c5449">RAY::Audio::IAudio::pause</a></div><div class="ttdeci">virtual IAudio & pause(void)=0</div><div class="ttdoc">Pause audio playing.</div></div>
|
|
<div class="ttc" id="aclassRAY_1_1Audio_1_1IAudio_html_a763eaabbbc35b534e5cdabc0d52f21d8"><div class="ttname"><a href="classRAY_1_1Audio_1_1IAudio.html#a763eaabbbc35b534e5cdabc0d52f21d8">RAY::Audio::IAudio::resume</a></div><div class="ttdeci">virtual IAudio & resume(void)=0</div><div class="ttdoc">Resume playing paused audio.</div></div>
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.17
|
|
</small></address>
|
|
</body>
|
|
</html>
|