2021-07-24 21:59:50 +00:00
<!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 > Renderd7-nightly: sound 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 = "navtree.css" rel = "stylesheet" type = "text/css" />
< script type = "text/javascript" src = "resize.js" ></ script >
< script type = "text/javascript" src = "navtreedata.js" ></ script >
< script type = "text/javascript" src = "navtree.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" > Renderd7-nightly
  < span id = "projectnumber" > v0.7.0</ span >
</ div >
</ td >
</ tr >
</ tbody >
</ table >
</ div >
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
</ 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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$ ( document ). ready ( function (){ initNavTree ( 'classsound.html' , '' ); initResizable (); });
/* @license-end */
</ script >
< div id = "doc-content" >
< div class = "header" >
< div class = "summary" >
< a href = "#pub-methods" > Public Member Functions</ a > |
< a href = "classsound-members.html" > List of all members</ a > </ div >
< div class = "headertitle" >
< div class = "title" > sound Class Reference</ div > </ div >
</ div > <!--header-->
< div class = "contents" >
< p >< code > #include < sound.hpp> </ code ></ p >
< table class = "memberdecls" >
< tr class = "heading" >< td colspan = "2" >< h2 class = "groupheader" >< a name = "pub-methods" ></ a >
Public Member Functions</ h2 ></ td ></ tr >
2021-07-24 22:02:52 +00:00
< tr class = "memitem:a2f69382c0ac7e2aa90d8278cc5b6bd70" >< td class = "memItemLeft" align = "right" valign = "top" >   </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "classsound.html#a2f69382c0ac7e2aa90d8278cc5b6bd70" > sound</ a > (const std::string & path, int channel=1, bool toloop=false)</ td ></ tr >
2021-07-25 09:20:48 +00:00
< tr class = "memdesc:a2f69382c0ac7e2aa90d8278cc5b6bd70" >< td class = "mdescLeft" >   </ td >< td class = "mdescRight" > Construct new Soundeffect. < a href = "classsound.html#a2f69382c0ac7e2aa90d8278cc5b6bd70" > More...</ a >< br /></ td ></ tr >
2021-07-24 22:02:52 +00:00
< tr class = "separator:a2f69382c0ac7e2aa90d8278cc5b6bd70" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
2021-07-24 21:59:50 +00:00
< tr class = "memitem:a4a82f1972ceb6a2642bb2dcc067c3d72" >< td class = "memItemLeft" align = "right" valign = "top" >   </ 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" >   </ td ></ tr >
< tr class = "memitem:abb2c33709eb822528889e32722fc1153" >< td class = "memItemLeft" align = "right" valign = "top" > void  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "classsound.html#abb2c33709eb822528889e32722fc1153" > play</ a > ()</ td ></ tr >
< tr class = "separator:abb2c33709eb822528889e32722fc1153" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
< tr class = "memitem:adf45b194f1b8bcbaca3ee6eec0ecc71a" >< td class = "memItemLeft" align = "right" valign = "top" > void  </ td >< td class = "memItemRight" valign = "bottom" >< a class = "el" href = "classsound.html#adf45b194f1b8bcbaca3ee6eec0ecc71a" > stop</ a > ()</ td ></ tr >
< tr class = "separator:adf45b194f1b8bcbaca3ee6eec0ecc71a" >< td class = "memSeparator" colspan = "2" >   </ td ></ tr >
</ table >
< a name = "details" id = "details" ></ a >< h2 class = "groupheader" > Detailed Description</ h2 >
< div class = "textblock" >< p > Sound Class </ p >
</ div >< h2 class = "groupheader" > Constructor & Destructor Documentation</ h2 >
2021-07-24 22:02:52 +00:00
< a id = "a2f69382c0ac7e2aa90d8278cc5b6bd70" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#a2f69382c0ac7e2aa90d8278cc5b6bd70" > ◆ </ 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 &  </ td >
< td class = "paramname" >< em > path</ em > , </ td >
</ tr >
< tr >
< td class = "paramkey" ></ td >
< td ></ td >
< td class = "paramtype" > int  </ td >
< td class = "paramname" >< em > channel</ em > = < code > 1</ code > , </ td >
</ tr >
< tr >
< td class = "paramkey" ></ td >
< td ></ td >
< td class = "paramtype" > bool  </ td >
< td class = "paramname" >< em > toloop</ em > = < code > false</ code >   </ td >
</ tr >
< tr >
< td ></ td >
< td > )</ td >
< td ></ td >< td ></ td >
</ tr >
</ table >
</ div >< div class = "memdoc" >
2021-07-25 09:20:48 +00:00
< p > Construct new Soundeffect. </ p >
< dl class = "params" >< dt > Parameters</ dt >< dd >
< table class = "params" >
< tr >< td class = "paramname" > path</ td >< td > Path to the .wav file </ td ></ tr >
< tr >< td class = "paramname" > channel</ td >< td > the channel 1-23 </ td ></ tr >
< tr >< td class = "paramname" > toloop</ td >< td > true:loop the sound, false: don't loop </ td ></ tr >
</ table >
</ dd >
</ dl >
2021-07-24 22:02:52 +00:00
</ div >
</ div >
2021-07-24 21:59:50 +00:00
< a id = "a4a82f1972ceb6a2642bb2dcc067c3d72" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#a4a82f1972ceb6a2642bb2dcc067c3d72" > ◆ </ a ></ span > ~sound()</ h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > sound::~sound </ td >
< td > (</ td >
< td class = "paramname" ></ td >< td > )</ td >
< td ></ td >
</ tr >
</ table >
</ div >< div class = "memdoc" >
2021-07-24 22:02:52 +00:00
< p > deconstruct the sound </ p >
2021-07-24 21:59:50 +00:00
</ div >
</ div >
< h2 class = "groupheader" > Member Function Documentation</ h2 >
< a id = "abb2c33709eb822528889e32722fc1153" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#abb2c33709eb822528889e32722fc1153" > ◆ </ a ></ span > play()</ h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > void sound::play </ td >
< td > (</ td >
< td class = "paramname" ></ td >< td > )</ td >
< td ></ td >
</ tr >
</ table >
</ div >< div class = "memdoc" >
< p > play the sound </ p >
</ div >
</ div >
< a id = "adf45b194f1b8bcbaca3ee6eec0ecc71a" ></ a >
< h2 class = "memtitle" >< span class = "permalink" >< a href = "#adf45b194f1b8bcbaca3ee6eec0ecc71a" > ◆ </ a ></ span > stop()</ h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > void sound::stop </ td >
< td > (</ td >
< td class = "paramname" ></ td >< td > )</ td >
< td ></ td >
</ tr >
</ table >
</ div >< div class = "memdoc" >
< p > stop the sound </ p >
</ div >
</ div >
</ 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 = "classsound.html" > sound</ a ></ li >
< li class = "footer" > Generated by
< a href = "http://www.doxygen.org/index.html" >
< img class = "footer" src = "doxygen.png" alt = "doxygen" /></ a > 1.8.17 </ li >
</ ul >
</ div >
</ body >
</ html >
