jurjenwerk/mazegame
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
1c0d2d9a88e3a6b8145e2897a47f7af7c8f5ae07
mazegame/engine/doc/html/files/wyz/wyz_player-h.html
T

69 lines
6.7 KiB
HTML
Raw Blame History

<!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>wyz_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="Topic628"></a><div class="CTopic TGroup LC first">
<div class="CTitle">Functions</div>
</div>
<a name="WYZ_Initialize"></a><a name="Topic629"></a><div class="CTopic TFunction LC">
<div class="CTitle">WYZ_Initialize</div>
<div id="NDPrototype629" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">void</span> WYZ_Initialize(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">u16&nbsp;</td><td class="PName last">song,</td></tr><tr><td class="PType first">u16&nbsp;</td><td class="PName last">inst,</td></tr><tr><td class="PType first">u16&nbsp;</td><td class="PName last">fx,</td></tr><tr><td class="PType first">u16&nbsp;</td><td class="PName last">freq</td></tr></table></td><td class="PAfterParameters">) __SDCCCALL0</td></tr></table></div></div>
<div class="CBody"><p>Initialize the Player</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">song<div class="CDLParameterType">u16</div></td><td class="CDLDefinition"><p>Songs data index memory address</p></td></tr><tr><td class="CDLEntry">inst<div class="CDLParameterType">u16</div></td><td class="CDLDefinition"><p>Instruments data index memory address</p></td></tr><tr><td class="CDLEntry">fx<div class="CDLParameterType">u16</div></td><td class="CDLDefinition"><p>FXs data index memory address</p></td></tr><tr><td class="CDLEntry">freq<div class="CDLParameterType">u16</div></td><td class="CDLDefinition"><p>Notes Table memory address</p></td></tr></table></div>
</div>
<a name="WYZ_Pause"></a><a name="Topic630"></a><div class="CTopic TFunction LC">
<div class="CTitle">WYZ_Pause</div>
<div id="NDPrototype630" class="NDPrototype"><div class="PSection PPlainSection"><span class="SHKeyword">void</span> WYZ_Pause() __NAKED</div></div>
<div class="CBody"><p>Pause song playback</p></div>
</div>
<a name="WYZ_Resume"></a><a name="Topic631"></a><div class="CTopic TFunction LC">
<div class="CTitle">WYZ_Resume</div>
<div id="NDPrototype631" class="NDPrototype"><div class="PSection PPlainSection"><span class="SHKeyword">void</span> WYZ_Resume()</div></div>
<div class="CBody"><p>Resume song playback</p></div>
</div>
<a name="WYZ_SetLoop"></a><a name="Topic632"></a><div class="CTopic TFunction LC">
<div class="CTitle">WYZ_SetLoop</div>
<div id="NDPrototype632" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">void</span> WYZ_SetLoop(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">u8&nbsp;</td><td class="PName last">loop</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
<div class="CBody"><p>Change loop mode</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">loop<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>FALSE = 0, TRUE = 1</p></td></tr></table></div>
</div>
<a name="WYZ_IsFinished"></a><a name="Topic633"></a><div class="CTopic TFunction LC">
<div class="CTitle">WYZ_IsFinished</div>
<div id="NDPrototype633" class="NDPrototype"><div class="PSection PPlainSection"><span class="SHKeyword">bool</span> WYZ_IsFinished()</div></div>
<div class="CBody"><p>Indicates whether the song has finished playing</p><div class="CHeading">Returns</div><p>TRUE if finished</p></div>
</div>
<a name="WYZ_PlayFX"></a><a name="Topic634"></a><div class="CTopic TFunction LC">
<div class="CTitle">WYZ_PlayFX</div>
<div id="NDPrototype634" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">void</span> WYZ_PlayFX(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">u8&nbsp;</td><td class="PName last">numSound</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
<div class="CBody"><p>Play Sound Effect</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">numSound<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>FX number</p></td></tr></table></div>
</div>
<a name="WYZ_PlayAY"></a><a name="Topic635"></a><div class="CTopic TFunction LC">
<div class="CTitle">WYZ_PlayAY</div>
<div id="NDPrototype635" class="NDPrototype"><div class="PSection PPlainSection"><span class="SHKeyword">void</span> WYZ_PlayAY()</div></div>
<div class="CBody"><p>Send data from AYREGS buffer to AY registers.&nbsp; Execute on each interruption of VBLANK</p></div>
</div>
<a name="WYZ_PlaySong"></a><a name="Topic636"></a><div class="CTopic TFunction LC">
<div class="CTitle">WYZ_PlaySong</div>
<div id="NDPrototype636" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">void</span> WYZ_PlaySong(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">u8&nbsp;</td><td class="PName last">numSong,</td></tr><tr><td class="PType first"><span class="SHKeyword">bool</span>&nbsp;</td><td class="PName last">loop</td></tr></table></td><td class="PAfterParameters">) __SDCCCALL0</td></tr></table></div></div>
<div class="CBody"><p>Start song playback</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">numSong<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Song number</p></td></tr><tr><td class="CDLEntry">loop<div class="CDLParameterType"><span class="SHKeyword">bool</span></div></td><td class="CDLDefinition"><p>Loop status</p></td></tr></table></div>
</div>
<a name="WYZ_Decode"></a><a name="Topic637"></a><div class="CTopic TFunction LC last">
<div class="CTitle">WYZ_Decode</div>
<div id="NDPrototype637" class="NDPrototype"><div class="PSection PPlainSection"><span class="SHKeyword">void</span> WYZ_Decode()</div></div>
<div class="CBody"><p>Process the next step in the song sequence</p></div>
</div>
</body></html>
Reference in New Issue View Git Blame Copy Permalink