zoriya/Bomberman
1
0
Fork 0
mirror of https://github.com/zoriya/Bomberman.git synced 2026-06-04 02:36:31 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
Documentation
Bomberman/classRAY_1_1Audio_1_1IAudio.html
T
AnonymusRaccoon adc7dd8d5c Deploying the documentation
2021-06-26 11:31:13 +00:00

367 lines
18 KiB
HTML
Raw Permalink Blame History

<!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: RAY::Audio::IAudio Class Reference</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&amp;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&amp;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="namespaceRAY.html">RAY</a></li><li class="navelem"><a class="el" href="namespaceRAY_1_1Audio.html">Audio</a></li><li class="navelem"><a class="el" href="classRAY_1_1Audio_1_1IAudio.html">IAudio</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classRAY_1_1Audio_1_1IAudio-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">RAY::Audio::IAudio Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>Interface for <a class="el" href="namespaceRAY_1_1Audio.html">Audio</a> ressources.
<a href="classRAY_1_1Audio_1_1IAudio.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="IAudio_8hpp_source.html">IAudio.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for RAY::Audio::IAudio:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classRAY_1_1Audio_1_1IAudio__inherit__graph.svg" width="352" height="492"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
</div>
<div class="dynheader">
Collaboration diagram for RAY::Audio::IAudio:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classRAY_1_1Audio_1_1IAudio__coll__graph.svg" width="150" height="191"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a938bd87a19a3ab8ef0a5e1f02106f4d1"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRAY_1_1Audio_1_1IAudio.html#a938bd87a19a3ab8ef0a5e1f02106f4d1">~IAudio</a> ()=default</td></tr>
<tr class="separator:a938bd87a19a3ab8ef0a5e1f02106f4d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a646994b4477ca83939dbc2240ab9d2fe"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRAY_1_1Audio_1_1IAudio.html#a646994b4477ca83939dbc2240ab9d2fe">isPlaying</a> (void)=0</td></tr>
<tr class="memdesc:a646994b4477ca83939dbc2240ab9d2fe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if audio is playing. <a href="classRAY_1_1Audio_1_1IAudio.html#a646994b4477ca83939dbc2240ab9d2fe">More...</a><br /></td></tr>
<tr class="separator:a646994b4477ca83939dbc2240ab9d2fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa613d07f901d91944a626dfb3bfafdbd"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classRAY_1_1Audio_1_1IAudio.html">IAudio</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRAY_1_1Audio_1_1IAudio.html#aa613d07f901d91944a626dfb3bfafdbd">play</a> (void)=0</td></tr>
<tr class="memdesc:aa613d07f901d91944a626dfb3bfafdbd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start audio. <a href="classRAY_1_1Audio_1_1IAudio.html#aa613d07f901d91944a626dfb3bfafdbd">More...</a><br /></td></tr>
<tr class="separator:aa613d07f901d91944a626dfb3bfafdbd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad3a22a8539e33e68a241470b78cc3d96"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classRAY_1_1Audio_1_1IAudio.html">IAudio</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRAY_1_1Audio_1_1IAudio.html#ad3a22a8539e33e68a241470b78cc3d96">stop</a> (void)=0</td></tr>
<tr class="memdesc:ad3a22a8539e33e68a241470b78cc3d96"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stop audio playing. <a href="classRAY_1_1Audio_1_1IAudio.html#ad3a22a8539e33e68a241470b78cc3d96">More...</a><br /></td></tr>
<tr class="separator:ad3a22a8539e33e68a241470b78cc3d96"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a64eead3083d58c84f32d9f44030c5449"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classRAY_1_1Audio_1_1IAudio.html">IAudio</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRAY_1_1Audio_1_1IAudio.html#a64eead3083d58c84f32d9f44030c5449">pause</a> (void)=0</td></tr>
<tr class="memdesc:a64eead3083d58c84f32d9f44030c5449"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pause audio playing. <a href="classRAY_1_1Audio_1_1IAudio.html#a64eead3083d58c84f32d9f44030c5449">More...</a><br /></td></tr>
<tr class="separator:a64eead3083d58c84f32d9f44030c5449"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a763eaabbbc35b534e5cdabc0d52f21d8"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classRAY_1_1Audio_1_1IAudio.html">IAudio</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRAY_1_1Audio_1_1IAudio.html#a763eaabbbc35b534e5cdabc0d52f21d8">resume</a> (void)=0</td></tr>
<tr class="memdesc:a763eaabbbc35b534e5cdabc0d52f21d8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Resume playing paused audio. <a href="classRAY_1_1Audio_1_1IAudio.html#a763eaabbbc35b534e5cdabc0d52f21d8">More...</a><br /></td></tr>
<tr class="separator:a763eaabbbc35b534e5cdabc0d52f21d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a621c3e5a5fac70734350a605cba8922c"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classRAY_1_1Audio_1_1IAudio.html">IAudio</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRAY_1_1Audio_1_1IAudio.html#a621c3e5a5fac70734350a605cba8922c">setVolume</a> (float volume)=0</td></tr>
<tr class="memdesc:a621c3e5a5fac70734350a605cba8922c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set volume for audio (1.0 is max level) <a href="classRAY_1_1Audio_1_1IAudio.html#a621c3e5a5fac70734350a605cba8922c">More...</a><br /></td></tr>
<tr class="separator:a621c3e5a5fac70734350a605cba8922c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a39d97be467eb0a7ae8f9ec7561674bd5"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classRAY_1_1Audio_1_1IAudio.html">IAudio</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRAY_1_1Audio_1_1IAudio.html#a39d97be467eb0a7ae8f9ec7561674bd5">setPitch</a> (float pitch)=0</td></tr>
<tr class="separator:a39d97be467eb0a7ae8f9ec7561674bd5"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Interface for <a class="el" href="namespaceRAY_1_1Audio.html">Audio</a> ressources. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a938bd87a19a3ab8ef0a5e1f02106f4d1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a938bd87a19a3ab8ef0a5e1f02106f4d1">&#9670;&nbsp;</a></span>~IAudio()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual RAY::Audio::IAudio::~IAudio </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a646994b4477ca83939dbc2240ab9d2fe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a646994b4477ca83939dbc2240ab9d2fe">&#9670;&nbsp;</a></span>isPlaying()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool RAY::Audio::IAudio::isPlaying </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if audio is playing. </p>
<p>Implemented in <a class="el" href="classRAY_1_1Audio_1_1Sound.html#a06098cd167e6721d9912435c59491fa7">RAY::Audio::Sound</a>, and <a class="el" href="classRAY_1_1Audio_1_1Music.html#a5ccc3974eea22af6b63d153cefe13bf1">RAY::Audio::Music</a>.</p>
</div>
</div>
<a id="a64eead3083d58c84f32d9f44030c5449"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a64eead3083d58c84f32d9f44030c5449">&#9670;&nbsp;</a></span>pause()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classRAY_1_1Audio_1_1IAudio.html">IAudio</a>&amp; RAY::Audio::IAudio::pause </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Pause audio playing. </p>
<p>Implemented in <a class="el" href="classRAY_1_1Audio_1_1Sound.html#a59449efa660275cb2dcfb15b2343676f">RAY::Audio::Sound</a>, and <a class="el" href="classRAY_1_1Audio_1_1Music.html#a3c55da91f34e76b13e0b9a4328b3b710">RAY::Audio::Music</a>.</p>
</div>
</div>
<a id="aa613d07f901d91944a626dfb3bfafdbd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa613d07f901d91944a626dfb3bfafdbd">&#9670;&nbsp;</a></span>play()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classRAY_1_1Audio_1_1IAudio.html">IAudio</a>&amp; RAY::Audio::IAudio::play </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Start audio. </p>
<p>Implemented in <a class="el" href="classRAY_1_1Audio_1_1Sound.html#a6eb2d3e411e86796e3a17ab1a1b94392">RAY::Audio::Sound</a>, and <a class="el" href="classRAY_1_1Audio_1_1Music.html#a5d764101a1d2671b4f23f4e94053efcf">RAY::Audio::Music</a>.</p>
</div>
</div>
<a id="a763eaabbbc35b534e5cdabc0d52f21d8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a763eaabbbc35b534e5cdabc0d52f21d8">&#9670;&nbsp;</a></span>resume()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classRAY_1_1Audio_1_1IAudio.html">IAudio</a>&amp; RAY::Audio::IAudio::resume </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Resume playing paused audio. </p>
<p>Implemented in <a class="el" href="classRAY_1_1Audio_1_1Sound.html#a47aa97009ae131b51e2226be71478714">RAY::Audio::Sound</a>, and <a class="el" href="classRAY_1_1Audio_1_1Music.html#a9ea16dbecab774d6923d4383f7aa3549">RAY::Audio::Music</a>.</p>
</div>
</div>
<a id="a39d97be467eb0a7ae8f9ec7561674bd5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a39d97be467eb0a7ae8f9ec7561674bd5">&#9670;&nbsp;</a></span>setPitch()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classRAY_1_1Audio_1_1IAudio.html">IAudio</a>&amp; RAY::Audio::IAudio::setPitch </td>
<td>(</td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>pitch</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="classRAY_1_1Audio_1_1Sound.html#a6c707e5bd05936315eea10dccf8c1707">RAY::Audio::Sound</a>, and <a class="el" href="classRAY_1_1Audio_1_1Music.html#a46a855c4b1c384094751f0703ba29b58">RAY::Audio::Music</a>.</p>
</div>
</div>
<a id="a621c3e5a5fac70734350a605cba8922c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a621c3e5a5fac70734350a605cba8922c">&#9670;&nbsp;</a></span>setVolume()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classRAY_1_1Audio_1_1IAudio.html">IAudio</a>&amp; RAY::Audio::IAudio::setVolume </td>
<td>(</td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>volume</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Set volume for audio (1.0 is max level) </p>
<p>Implemented in <a class="el" href="classRAY_1_1Audio_1_1Sound.html#a5d432db0e3d9cefda0ba3b6f3b465f5c">RAY::Audio::Sound</a>, and <a class="el" href="classRAY_1_1Audio_1_1Music.html#aeb62dadcee0f9b180f612330ce6ce666">RAY::Audio::Music</a>.</p>
</div>
</div>
<a id="ad3a22a8539e33e68a241470b78cc3d96"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad3a22a8539e33e68a241470b78cc3d96">&#9670;&nbsp;</a></span>stop()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classRAY_1_1Audio_1_1IAudio.html">IAudio</a>&amp; RAY::Audio::IAudio::stop </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Stop audio playing. </p>
<p>Implemented in <a class="el" href="classRAY_1_1Audio_1_1Sound.html#a72120f19cb114573a15e85adb4b7aa16">RAY::Audio::Sound</a>, and <a class="el" href="classRAY_1_1Audio_1_1Music.html#a0347213bdcfd6d276a8b89aefc36b64b">RAY::Audio::Music</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>lib/Ray/sources/Audio/<a class="el" href="IAudio_8hpp_source.html">IAudio.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink