Files
mazegame/engine/doc/html/files/vgm/vgm_player-h.html
T

87 lines
6.5 KiB
HTML

<!DOCTYPE html>
<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><meta http-equiv="X-UA-Compatible" content="IE=edge"><title>vgm_player.h</title><link rel="stylesheet" type="text/css" href="../../styles/main.css" /><script type="text/javascript" src="../../styles/main.js"></script><script type="text/javascript">NDLoader.LoadJS("Content", "../../styles/");</script></head>
<!-- Generated by Natural Docs, version 2.2 -->
<!-- saved from url=(0016)http://localhost -->
<body onload="NDLoader.OnLoad('Content');" class="NDPage NDContentPage">
<a name="Functions"></a><a name="Topic429"></a><div class="CTopic TGroup LC first">
<div class="CTitle">Functions</div>
</div>
<a name="VGM_Play"></a><a name="Topic430"></a><div class="CTopic TFunction LC">
<div class="CTitle">VGM_Play</div>
<div id="NDPrototype430" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">bool</span> VGM_Play(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PModifierQualifier first"><span class="SHKeyword">const</span>&nbsp;</td><td class="PType"><span class="SHKeyword">void</span>*&nbsp;</td><td class="PName last">addr,</td></tr><tr><td class="first"></td><td class="PType"><span class="SHKeyword">bool</span>&nbsp;</td><td class="PName last">loop</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
<div class="CBody"><p>Start music playback</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">addr<div class="CDLParameterType"><span class="SHKeyword">const</span> <span class="SHKeyword">void</span>*</div></td><td class="CDLDefinition"><p>Address of source data</p></td></tr><tr><td class="CDLEntry">loop<div class="CDLParameterType"><span class="SHKeyword">bool</span></div></td><td class="CDLDefinition"><p>If set to TRUE, playback restart when end is reached</p></td></tr></table><div class="CHeading">Return</div><p>TRUE if initialization succeed</p></div>
</div>
<a name="VGM_Stop"></a><a name="Topic431"></a><div class="CTopic TFunction LC">
<div class="CTitle">VGM_Stop</div>
<div id="NDPrototype431" class="NDPrototype"><div class="PSection PPlainSection"><span class="SHKeyword">void</span> VGM_Stop()</div></div>
<div class="CBody"><p>Stop music playback</p></div>
</div>
<a name="VGM_SetFrequency50Hz"></a><a name="Topic432"></a><div class="CTopic TFunction LC">
<div class="CTitle">VGM_SetFrequency50Hz</div>
<div id="NDPrototype432" class="NDPrototype"><div class="PSection PPlainSection"><span class="SHKeyword">inline</span> <span class="SHKeyword">void</span> VGM_SetFrequency50Hz()</div></div>
<div class="CBody"><p>Change frequency to 50 Hz</p></div>
</div>
<a name="VGM_SetFrequency60Hz"></a><a name="Topic433"></a><div class="CTopic TFunction LC">
<div class="CTitle">VGM_SetFrequency60Hz</div>
<div id="NDPrototype433" class="NDPrototype"><div class="PSection PPlainSection"><span class="SHKeyword">inline</span> <span class="SHKeyword">void</span> VGM_SetFrequency60Hz()</div></div>
<div class="CBody"><p>Change frequency to 60 Hz</p></div>
</div>
<a name="VGM_IsPlaying"></a><a name="Topic434"></a><div class="CTopic TFunction LC">
<div class="CTitle">VGM_IsPlaying</div>
<div id="NDPrototype434" class="NDPrototype"><div class="PSection PPlainSection"><span class="SHKeyword">inline</span> <span class="SHKeyword">bool</span> VGM_IsPlaying()</div></div>
<div class="CBody"><p>Check if music playing</p><div class="CHeading">Return</div><p>TRUE if music is playing</p></div>
</div>
<a name="VGM_Resume"></a><a name="Topic435"></a><div class="CTopic TFunction LC">
<div class="CTitle">VGM_Resume</div>
<div id="NDPrototype435" class="NDPrototype"><div class="PSection PPlainSection"><span class="SHKeyword">void</span> VGM_Resume()</div></div>
<div class="CBody"><p>Resume music playback</p></div>
</div>
<a name="VGM_Pause"></a><a name="Topic436"></a><div class="CTopic TFunction LC">
<div class="CTitle">VGM_Pause</div>
<div id="NDPrototype436" class="NDPrototype"><div class="PSection PPlainSection"><span class="SHKeyword">void</span> VGM_Pause()</div></div>
<div class="CBody"><p>Pause music playback</p></div>
</div>
<a name="VGM_Decode"></a><a name="Topic437"></a><div class="CTopic TFunction LC">
<div class="CTitle">VGM_Decode</div>
<div id="NDPrototype437" class="NDPrototype"><div class="PSection PPlainSection"><span class="SHKeyword">void</span> VGM_Decode()</div></div>
<div class="CBody"><p>Decode a frame of music</p></div>
</div>
<a name="VGM_ContainsPSG"></a><a name="Topic438"></a><div class="CTopic TFunction LC">
<div class="CTitle">VGM_ContainsPSG</div>
<div id="NDPrototype438" class="NDPrototype"><div class="PSection PPlainSection"><span class="SHKeyword">inline</span> <span class="SHKeyword">bool</span> VGM_ContainsPSG()</div></div>
<div class="CBody"><p>Check if initialized song contains PSG data</p><div class="CHeading">Return</div><p>FALSE if music dont contains PSG data</p></div>
</div>
<a name="VGM_ContainsMSXMusic"></a><a name="Topic439"></a><div class="CTopic TFunction LC">
<div class="CTitle">VGM_ContainsMSXMusic</div>
<div id="NDPrototype439" class="NDPrototype"><div class="PSection PPlainSection"><span class="SHKeyword">inline</span> <span class="SHKeyword">bool</span> VGM_ContainsMSXMusic()</div></div>
<div class="CBody"><p>Check if initialized song contains MSX-Music data</p><div class="CHeading">Return</div><p>FALSE if music dont contains MSX-Music data</p></div>
</div>
<a name="VGM_ContainsMSXAudio"></a><a name="Topic440"></a><div class="CTopic TFunction LC">
<div class="CTitle">VGM_ContainsMSXAudio</div>
<div id="NDPrototype440" class="NDPrototype"><div class="PSection PPlainSection"><span class="SHKeyword">inline</span> <span class="SHKeyword">bool</span> VGM_ContainsMSXAudio()</div></div>
<div class="CBody"><p>Check if initialized song contains MSX-Audio data</p><div class="CHeading">Return</div><p>FALSE if music dont contains MSX-Audio data</p></div>
</div>
<a name="VGM_ContainsSCC"></a><a name="Topic441"></a><div class="CTopic TFunction LC last">
<div class="CTitle">VGM_ContainsSCC</div>
<div id="NDPrototype441" class="NDPrototype"><div class="PSection PPlainSection"><span class="SHKeyword">inline</span> <span class="SHKeyword">bool</span> VGM_ContainsSCC()</div></div>
<div class="CBody"><p>Check if initialized song contains SCC data</p><div class="CHeading">Return</div><p>FALSE if music dont contains SCC data</p></div>
</div>
</body></html>