Documentation1

This commit is contained in:
tobid7 2021-07-24 22:02:52 +00:00
parent 560ee65932
commit 3af5da9d3e
8 changed files with 61 additions and 20 deletions

View File

@ -58,8 +58,9 @@ $(document).ready(function(){initNavTree('classsound.html',''); initResizable();
<p>This is the complete list of members for <a class="el" href="classsound.html">sound</a>, including all inherited members.</p> <p>This is the complete list of members for <a class="el" href="classsound.html">sound</a>, including all inherited members.</p>
<table class="directory"> <table class="directory">
<tr class="even"><td class="entry"><a class="el" href="classsound.html#abb2c33709eb822528889e32722fc1153">play</a>()</td><td class="entry"><a class="el" href="classsound.html">sound</a></td><td class="entry"></td></tr> <tr class="even"><td class="entry"><a class="el" href="classsound.html#abb2c33709eb822528889e32722fc1153">play</a>()</td><td class="entry"><a class="el" href="classsound.html">sound</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classsound.html#adf45b194f1b8bcbaca3ee6eec0ecc71a">stop</a>()</td><td class="entry"><a class="el" href="classsound.html">sound</a></td><td class="entry"></td></tr> <tr><td class="entry"><a class="el" href="classsound.html#a2f69382c0ac7e2aa90d8278cc5b6bd70">sound</a>(const std::string &amp;path, int channel=1, bool toloop=false)</td><td class="entry"><a class="el" href="classsound.html">sound</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classsound.html#a4a82f1972ceb6a2642bb2dcc067c3d72">~sound</a>()</td><td class="entry"><a class="el" href="classsound.html">sound</a></td><td class="entry"></td></tr> <tr class="even"><td class="entry"><a class="el" href="classsound.html#adf45b194f1b8bcbaca3ee6eec0ecc71a">stop</a>()</td><td class="entry"><a class="el" href="classsound.html">sound</a></td><td class="entry"></td></tr>
<tr><td class="entry"><a class="el" href="classsound.html#a4a82f1972ceb6a2642bb2dcc067c3d72">~sound</a>()</td><td class="entry"><a class="el" href="classsound.html">sound</a></td><td class="entry"></td></tr>
</table></div><!-- contents --> </table></div><!-- contents -->
</div><!-- doc-content --> </div><!-- doc-content -->
<!-- start footer part --> <!-- start footer part -->

View File

@ -62,6 +62,8 @@ $(document).ready(function(){initNavTree('classsound.html',''); initResizable();
<table class="memberdecls"> <table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr> Public Member Functions</h2></td></tr>
<tr class="memitem:a2f69382c0ac7e2aa90d8278cc5b6bd70"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsound.html#a2f69382c0ac7e2aa90d8278cc5b6bd70">sound</a> (const std::string &amp;path, int channel=1, bool toloop=false)</td></tr>
<tr class="separator:a2f69382c0ac7e2aa90d8278cc5b6bd70"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4a82f1972ceb6a2642bb2dcc067c3d72"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsound.html#a4a82f1972ceb6a2642bb2dcc067c3d72">~sound</a> ()</td></tr> <tr class="memitem:a4a82f1972ceb6a2642bb2dcc067c3d72"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsound.html#a4a82f1972ceb6a2642bb2dcc067c3d72">~sound</a> ()</td></tr>
<tr class="separator:a4a82f1972ceb6a2642bb2dcc067c3d72"><td class="memSeparator" colspan="2">&#160;</td></tr> <tr class="separator:a4a82f1972ceb6a2642bb2dcc067c3d72"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abb2c33709eb822528889e32722fc1153"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsound.html#abb2c33709eb822528889e32722fc1153">play</a> ()</td></tr> <tr class="memitem:abb2c33709eb822528889e32722fc1153"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsound.html#abb2c33709eb822528889e32722fc1153">play</a> ()</td></tr>
@ -72,6 +74,41 @@ Public Member Functions</h2></td></tr>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Sound Class </p> <div class="textblock"><p>Sound Class </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2> </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a2f69382c0ac7e2aa90d8278cc5b6bd70"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2f69382c0ac7e2aa90d8278cc5b6bd70">&#9670;&nbsp;</a></span>sound()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">sound::sound </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>path</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>channel</em> = <code>1</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>toloop</em> = <code>false</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct new Soundeffect path: Path to the .wav file channel: the channel 1-23 toloop: true:loop the sound, false: don't loop </p>
</div>
</div>
<a id="a4a82f1972ceb6a2642bb2dcc067c3d72"></a> <a id="a4a82f1972ceb6a2642bb2dcc067c3d72"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4a82f1972ceb6a2642bb2dcc067c3d72">&#9670;&nbsp;</a></span>~sound()</h2> <h2 class="memtitle"><span class="permalink"><a href="#a4a82f1972ceb6a2642bb2dcc067c3d72">&#9670;&nbsp;</a></span>~sound()</h2>
@ -86,12 +123,7 @@ Public Member Functions</h2></td></tr>
</tr> </tr>
</table> </table>
</div><div class="memdoc"> </div><div class="memdoc">
<pre class="fragment"> Construct new Soundeffect <p>deconstruct the sound </p>
path: Path to the .wav file
channel: the channel 1-23
toloop: true:loop the sound, false: don't loop
"/
</pre><p> sound(const std::string&amp; path, int channel = 1, bool toloop = false); /** deconstruct the sound </p>
</div> </div>
</div> </div>

View File

@ -1,5 +1,6 @@
var classsound = var classsound =
[ [
[ "sound", "classsound.html#a2f69382c0ac7e2aa90d8278cc5b6bd70", null ],
[ "~sound", "classsound.html#a4a82f1972ceb6a2642bb2dcc067c3d72", null ], [ "~sound", "classsound.html#a4a82f1972ceb6a2642bb2dcc067c3d72", null ],
[ "play", "classsound.html#abb2c33709eb822528889e32722fc1153", null ], [ "play", "classsound.html#abb2c33709eb822528889e32722fc1153", null ],
[ "stop", "classsound.html#adf45b194f1b8bcbaca3ee6eec0ecc71a", null ] [ "stop", "classsound.html#adf45b194f1b8bcbaca3ee6eec0ecc71a", null ]

View File

@ -84,6 +84,9 @@ $(document).ready(function(){initNavTree('functions_func_s.html',''); initResiza
<li>skip_bom() <li>skip_bom()
: <a class="el" href="classnlohmann_1_1detail_1_1lexer.html#a7cd7d55de2cd398660bc243c7229caf9">nlohmann::detail::lexer&lt; BasicJsonType, InputAdapterType &gt;</a> : <a class="el" href="classnlohmann_1_1detail_1_1lexer.html#a7cd7d55de2cd398660bc243c7229caf9">nlohmann::detail::lexer&lt; BasicJsonType, InputAdapterType &gt;</a>
</li> </li>
<li>sound()
: <a class="el" href="classsound.html#a2f69382c0ac7e2aa90d8278cc5b6bd70">sound</a>
</li>
<li>split() <li>split()
: <a class="el" href="classnlohmann_1_1json__pointer.html#ae01c32c6a071c2e5198d5dfcce290e50">nlohmann::json_pointer&lt; BasicJsonType &gt;</a> : <a class="el" href="classnlohmann_1_1json__pointer.html#ae01c32c6a071c2e5198d5dfcce290e50">nlohmann::json_pointer&lt; BasicJsonType &gt;</a>
</li> </li>
@ -103,7 +106,7 @@ $(document).ready(function(){initNavTree('functions_func_s.html',''); initResiza
: <a class="el" href="classnlohmann_1_1byte__container__with__subtype.html#ac3ca9d09e55342f9588404e1dc2222f0">nlohmann::byte_container_with_subtype&lt; BinaryType &gt;</a> : <a class="el" href="classnlohmann_1_1byte__container__with__subtype.html#ac3ca9d09e55342f9588404e1dc2222f0">nlohmann::byte_container_with_subtype&lt; BinaryType &gt;</a>
</li> </li>
<li>swap() <li>swap()
: <a class="el" href="classnlohmann_1_1basic__json.html#abe5adbae0da85a23ad7e812bdb85672f">nlohmann::basic_json</a> : <a class="el" href="classnlohmann_1_1basic__json.html#ade6945272c7b703520f435ad580d3c7f">nlohmann::basic_json</a>
</li> </li>
</ul> </ul>
</div><!-- contents --> </div><!-- contents -->

View File

@ -90,6 +90,9 @@ $(document).ready(function(){initNavTree('functions_s.html',''); initResizable()
<li>skip_bom() <li>skip_bom()
: <a class="el" href="classnlohmann_1_1detail_1_1lexer.html#a7cd7d55de2cd398660bc243c7229caf9">nlohmann::detail::lexer&lt; BasicJsonType, InputAdapterType &gt;</a> : <a class="el" href="classnlohmann_1_1detail_1_1lexer.html#a7cd7d55de2cd398660bc243c7229caf9">nlohmann::detail::lexer&lt; BasicJsonType, InputAdapterType &gt;</a>
</li> </li>
<li>sound()
: <a class="el" href="classsound.html#a2f69382c0ac7e2aa90d8278cc5b6bd70">sound</a>
</li>
<li>split() <li>split()
: <a class="el" href="classnlohmann_1_1json__pointer.html#ae01c32c6a071c2e5198d5dfcce290e50">nlohmann::json_pointer&lt; BasicJsonType &gt;</a> : <a class="el" href="classnlohmann_1_1json__pointer.html#ae01c32c6a071c2e5198d5dfcce290e50">nlohmann::json_pointer&lt; BasicJsonType &gt;</a>
</li> </li>
@ -112,8 +115,8 @@ $(document).ready(function(){initNavTree('functions_s.html',''); initResizable()
<li>subtype() <li>subtype()
: <a class="el" href="classnlohmann_1_1byte__container__with__subtype.html#ac3ca9d09e55342f9588404e1dc2222f0">nlohmann::byte_container_with_subtype&lt; BinaryType &gt;</a> : <a class="el" href="classnlohmann_1_1byte__container__with__subtype.html#ac3ca9d09e55342f9588404e1dc2222f0">nlohmann::byte_container_with_subtype&lt; BinaryType &gt;</a>
</li> </li>
<li>swap <li>swap()
: <a class="el" href="classnlohmann_1_1basic__json.html#aee0ae36cbfb0336832ebc0374c3c7679">nlohmann::basic_json</a> : <a class="el" href="classnlohmann_1_1basic__json.html#a1c597d3cfa8aeec2ab4492306201851e">nlohmann::basic_json</a>
</li> </li>
</ul> </ul>
</div><!-- contents --> </div><!-- contents -->

View File

@ -52,7 +52,7 @@ var NAVTREEINDEX =
[ [
".html", ".html",
"classnlohmann_1_1detail_1_1binary__writer.html#a048887c907afe39759b777e8c888414c", "classnlohmann_1_1detail_1_1binary__writer.html#a048887c907afe39759b777e8c888414c",
"structnlohmann_1_1json__sax.html#a5c53878cf08d463eb4e7ca0270532572" "structnlohmann_1_1json__sax.html#a38c2dbde07138cc436ea7fbf22c1e92d"
]; ];
var SYNCONMSG = 'click to disable panel synchronisation'; var SYNCONMSG = 'click to disable panel synchronisation';

View File

@ -164,12 +164,13 @@ var NAVTREEINDEX1 =
"classnlohmann_1_1json__pointer.html#af5a4bc4f82113c271c9a0cd4d3b5f31c":[2,0,0,4,20], "classnlohmann_1_1json__pointer.html#af5a4bc4f82113c271c9a0cd4d3b5f31c":[2,0,0,4,20],
"classnlohmann_1_1json__pointer.html#afdaacce1edb7145e0434e014f0e8685a":[2,0,0,4,6], "classnlohmann_1_1json__pointer.html#afdaacce1edb7145e0434e014f0e8685a":[2,0,0,4,6],
"classsound.html":[2,0,3], "classsound.html":[2,0,3],
"classsound.html#a4a82f1972ceb6a2642bb2dcc067c3d72":[2,0,3,0], "classsound.html#a2f69382c0ac7e2aa90d8278cc5b6bd70":[2,0,3,0],
"classsound.html#abb2c33709eb822528889e32722fc1153":[2,0,3,1], "classsound.html#a4a82f1972ceb6a2642bb2dcc067c3d72":[2,0,3,1],
"classsound.html#adf45b194f1b8bcbaca3ee6eec0ecc71a":[2,0,3,2], "classsound.html#abb2c33709eb822528889e32722fc1153":[2,0,3,2],
"classsound.html#adf45b194f1b8bcbaca3ee6eec0ecc71a":[2,0,3,3],
"deprecated.html":[0], "deprecated.html":[0],
"functions.html":[2,3,0,0],
"functions.html":[2,3,0], "functions.html":[2,3,0],
"functions.html":[2,3,0,0],
"functions_b.html":[2,3,0,1], "functions_b.html":[2,3,0,1],
"functions_c.html":[2,3,0,2], "functions_c.html":[2,3,0,2],
"functions_d.html":[2,3,0,3], "functions_d.html":[2,3,0,3],
@ -225,10 +226,10 @@ var NAVTREEINDEX1 =
"namespacemembers_enum.html":[1,1,3], "namespacemembers_enum.html":[1,1,3],
"namespacemembers_func.html":[1,1,1], "namespacemembers_func.html":[1,1,1],
"namespacemembers_type.html":[1,1,2], "namespacemembers_type.html":[1,1,2],
"namespacenlohmann.html":[1,0,0],
"namespacenlohmann.html":[2,0,0], "namespacenlohmann.html":[2,0,0],
"namespacenlohmann_1_1detail.html":[2,0,0,0], "namespacenlohmann.html":[1,0,0],
"namespacenlohmann_1_1detail.html":[1,0,0,0], "namespacenlohmann_1_1detail.html":[1,0,0,0],
"namespacenlohmann_1_1detail.html":[2,0,0,0],
"namespacenlohmann_1_1detail_1_1dtoa__impl.html":[1,0,0,0,0], "namespacenlohmann_1_1detail_1_1dtoa__impl.html":[1,0,0,0,0],
"namespaces.html":[1,0], "namespaces.html":[1,0],
"pages.html":[], "pages.html":[],
@ -248,6 +249,5 @@ var NAVTREEINDEX1 =
"structnlohmann_1_1json__sax.html#a07eab82f6c82d606787eee9ad73d2bda":[2,0,0,5,5], "structnlohmann_1_1json__sax.html#a07eab82f6c82d606787eee9ad73d2bda":[2,0,0,5,5],
"structnlohmann_1_1json__sax.html#a0ad26edef3f8d530dcec3192bba82df6":[2,0,0,5,0], "structnlohmann_1_1json__sax.html#a0ad26edef3f8d530dcec3192bba82df6":[2,0,0,5,0],
"structnlohmann_1_1json__sax.html#a235ee975617f28e6a996d1e36a282312":[2,0,0,5,11], "structnlohmann_1_1json__sax.html#a235ee975617f28e6a996d1e36a282312":[2,0,0,5,11],
"structnlohmann_1_1json__sax.html#a2e0c7ecd80b18d18a8cc76f71cfc2028":[2,0,0,5,8], "structnlohmann_1_1json__sax.html#a2e0c7ecd80b18d18a8cc76f71cfc2028":[2,0,0,5,8]
"structnlohmann_1_1json__sax.html#a38c2dbde07138cc436ea7fbf22c1e92d":[2,0,0,5,6]
}; };

View File

@ -1,5 +1,6 @@
var NAVTREEINDEX2 = var NAVTREEINDEX2 =
{ {
"structnlohmann_1_1json__sax.html#a38c2dbde07138cc436ea7fbf22c1e92d":[2,0,0,5,6],
"structnlohmann_1_1json__sax.html#a5c53878cf08d463eb4e7ca0270532572":[2,0,0,5,10], "structnlohmann_1_1json__sax.html#a5c53878cf08d463eb4e7ca0270532572":[2,0,0,5,10],
"structnlohmann_1_1json__sax.html#a60287e3bd85f489e04c83f7e3b76e613":[2,0,0,5,12], "structnlohmann_1_1json__sax.html#a60287e3bd85f489e04c83f7e3b76e613":[2,0,0,5,12],
"structnlohmann_1_1json__sax.html#a82ed080814fa656191a537284bb0c575":[2,0,0,5,1], "structnlohmann_1_1json__sax.html#a82ed080814fa656191a537284bb0c575":[2,0,0,5,1],