jurjen.ladeniusandClaude Opus 4.8
f3340e86c6
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
250 lines
28 KiB
HTML
250 lines
28 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>system.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="Peek_poke"></a><a name="Topic638"></a><div class="CTopic TGroup LC first">
|
|
<div class="CTitle">Peek & poke</div>
|
|
<div class="CBody"><p>Functions to read and write memory</p></div>
|
|
</div>
|
|
|
|
<a name="Poke"></a><a name="Topic639"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Poke</div>
|
|
<div id="NDPrototype639" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">inline</span> <span class="SHKeyword">void</span> Poke(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">u16 </td><td class="PName last">addr,</td></tr><tr><td class="PType first">u8 </td><td class="PName last">val</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Set a 8-bit value at the given address</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">addr<div class="CDLParameterType">u16</div></td><td class="CDLDefinition"><p>Address to set</p></td></tr><tr><td class="CDLEntry">val<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>8-bit value to set</p></td></tr></table></div>
|
|
</div>
|
|
|
|
<a name="Poke16"></a><a name="Topic640"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Poke16</div>
|
|
<div id="NDPrototype640" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">inline</span> <span class="SHKeyword">void</span> Poke16(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">u16 </td><td class="PName last">addr,</td></tr><tr><td class="PType first">u16 </td><td class="PName last">val</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Set a 16-bit value at the given address</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">addr<div class="CDLParameterType">u16</div></td><td class="CDLDefinition"><p>Address to set</p></td></tr><tr><td class="CDLEntry">val<div class="CDLParameterType">u16</div></td><td class="CDLDefinition"><p>16-bit value to set</p></td></tr></table></div>
|
|
</div>
|
|
|
|
<a name="Peek"></a><a name="Topic641"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Peek</div>
|
|
<div id="NDPrototype641" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">inline</span> u8 Peek(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">u16 </td><td class="PName last">addr</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Get the 8-bit value at the given address</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">addr<div class="CDLParameterType">u16</div></td><td class="CDLDefinition"><p>Address to get</p></td></tr></table><div class="CHeading">Return</div><p>8-bit value stored at the given address</p></div>
|
|
</div>
|
|
|
|
<a name="Peek16"></a><a name="Topic642"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Peek16</div>
|
|
<div id="NDPrototype642" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">inline</span> u16 Peek16(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">u16 </td><td class="PName last">addr</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Get the 16-bit value at the given address</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">addr<div class="CDLParameterType">u16</div></td><td class="CDLDefinition"><p>Address to get</p></td></tr></table><div class="CHeading">Return</div><p>16-bit value stored at the given address</p></div>
|
|
</div>
|
|
|
|
<a name="Low_level"></a><a name="Topic643"></a><div class="CTopic TGroup LC">
|
|
<div class="CTitle">Low level</div>
|
|
<div class="CBody"><p>Functions to access low level functions</p></div>
|
|
</div>
|
|
|
|
<a name="EnableInterrupt"></a><a name="Topic644"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">EnableInterrupt</div>
|
|
<div id="NDPrototype644" class="NDPrototype"><div class="PSection PPlainSection"><span class="SHKeyword">inline</span> <span class="SHKeyword">void</span> EnableInterrupt()</div></div>
|
|
<div class="CBody"><p>Enable interruption</p></div>
|
|
</div>
|
|
|
|
<a name="DisableInterrupt"></a><a name="Topic645"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">DisableInterrupt</div>
|
|
<div id="NDPrototype645" class="NDPrototype"><div class="PSection PPlainSection"><span class="SHKeyword">inline</span> <span class="SHKeyword">void</span> DisableInterrupt()</div></div>
|
|
<div class="CBody"><p>Disable interruption</p></div>
|
|
</div>
|
|
|
|
<a name="Halt"></a><a name="Topic646"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Halt</div>
|
|
<div id="NDPrototype646" class="NDPrototype"><div class="PSection PPlainSection"><span class="SHKeyword">inline</span> <span class="SHKeyword">void</span> Halt()</div></div>
|
|
<div class="CBody"><p>Pause the CPU until a new interruption occured</p></div>
|
|
</div>
|
|
|
|
<a name="Information"></a><a name="Topic647"></a><div class="CTopic TGroup LC">
|
|
<div class="CTitle">Information</div>
|
|
<div class="CBody"><p>Functions to get information from the system</p></div>
|
|
</div>
|
|
|
|
<a name="Sys_GetBIOSInfo"></a><a name="Topic648"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Sys_GetBIOSInfo</div>
|
|
<div id="NDPrototype648" class="NDPrototype"><div class="PSection PPlainSection"><span class="SHKeyword">inline</span> u8 Sys_GetBIOSInfo()</div></div>
|
|
<div class="CBody"><p>Get BIOS information (frequency, keyboard type, etc.)</p><div class="CHeading">Return</div><p>The BIOS information</p></div>
|
|
</div>
|
|
|
|
<a name="Sys_GetMSXVersion"></a><a name="Topic649"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Sys_GetMSXVersion</div>
|
|
<div id="NDPrototype649" class="NDPrototype"><div class="PSection PPlainSection"><span class="SHKeyword">inline</span> u8 Sys_GetMSXVersion()</div></div>
|
|
<div class="CBody"><p>Get the MSX version</p><div class="CHeading">Return</div><p>The MSX version (0: MSX1, 1: MSX2, 2: MSX2+, 3: MSX turbo R)</p></div>
|
|
</div>
|
|
|
|
<a name="Sys_GetFrequency"></a><a name="Topic650"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Sys_GetFrequency</div>
|
|
<div id="NDPrototype650" class="NDPrototype"><div class="PSection PPlainSection"><span class="SHKeyword">inline</span> u8 Sys_GetFrequency()</div></div>
|
|
<div class="CBody"><p>Get the system frequency (from BIOS)</p><div class="CHeading">Return</div><p>SYS_FERQ_50HZ or SYS_FERQ_60HZ</p></div>
|
|
</div>
|
|
|
|
<a name="Sys_Is60Hz"></a><a name="Topic651"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Sys_Is60Hz</div>
|
|
<div id="NDPrototype651" class="NDPrototype"><div class="PSection PPlainSection"><span class="SHKeyword">inline</span> <span class="SHKeyword">bool</span> Sys_Is60Hz()</div></div>
|
|
<div class="CBody"><p>Get the system frequency (from BIOS)</p><div class="CHeading">Return</div><p>TRUE if the BIOS is 60 Hz</p></div>
|
|
</div>
|
|
|
|
<a name="Sys_Is50Hz"></a><a name="Topic652"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Sys_Is50Hz</div>
|
|
<div id="NDPrototype652" class="NDPrototype"><div class="PSection PPlainSection"><span class="SHKeyword">inline</span> <span class="SHKeyword">bool</span> Sys_Is50Hz()</div></div>
|
|
<div class="CBody"><p>Get the system frequency (from BIOS)</p><div class="CHeading">Return</div><p>TRUE if the BIOS is 50 Hz</p></div>
|
|
</div>
|
|
|
|
<a name="Call"></a><a name="Topic653"></a><div class="CTopic TGroup LC">
|
|
<div class="CTitle">Call</div>
|
|
<div class="CBody"><p>Functions to call routines</p></div>
|
|
</div>
|
|
|
|
<a name="Call(2)"></a><a name="Topic1425"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Call</div>
|
|
<div id="NDPrototype1425" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">inline</span> <span class="SHKeyword">void</span> Call(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">u16 </td><td class="PName last">addr</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Direct call a routine at a given address (generate ASM code: "call XXXX") No extra cost due to calling a C function.</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">addr<div class="CDLParameterType">u16</div></td><td class="CDLDefinition"><p>Address to call</p></td></tr></table></div>
|
|
</div>
|
|
|
|
<a name="CallToA"></a><a name="Topic1426"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">CallToA</div>
|
|
<div id="NDPrototype1426" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">inline</span> u8 CallToA(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">u16 </td><td class="PName last">addr</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Direct call a routine at a given address (generate ASM code: "call XXXX") No extra cost due to calling a C function.</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">addr<div class="CDLParameterType">u16</div></td><td class="CDLDefinition"><p>Address to call</p></td></tr></table><div class="CHeading">Return</div><p>Value stored in register A</p></div>
|
|
</div>
|
|
|
|
<a name="CallA"></a><a name="Topic655"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">CallA</div>
|
|
<div id="NDPrototype655" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">inline</span> <span class="SHKeyword">void</span> CallA(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">u16 </td><td class="PName last">addr,</td></tr><tr><td class="PType first">u8 </td><td class="PName last">a</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Direct call a routine at a given address with a 8-bits parameter in register A (generate ASM code: "call XXXX") No extra cost due to calling a C function.</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">addr<div class="CDLParameterType">u16</div></td><td class="CDLDefinition"><p>Address to call</p></td></tr><tr><td class="CDLEntry">a<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Function parameter to put in register A</p></td></tr></table></div>
|
|
</div>
|
|
|
|
<a name="CallAToA"></a><a name="Topic1427"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">CallAToA</div>
|
|
<div id="NDPrototype1427" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">inline</span> u8 CallAToA(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">u16 </td><td class="PName last">addr,</td></tr><tr><td class="PType first">u8 </td><td class="PName last">a</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Direct call a routine at a given address with a 8-bits parameter in register A (generate ASM code: "call XXXX") No extra cost due to calling a C function.</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">addr<div class="CDLParameterType">u16</div></td><td class="CDLDefinition"><p>Address to call</p></td></tr><tr><td class="CDLEntry">a<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Function parameter to put in register A</p></td></tr></table><div class="CHeading">Return</div><p>Value stored in register A</p></div>
|
|
</div>
|
|
|
|
<a name="CallL"></a><a name="Topic656"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">CallL</div>
|
|
<div id="NDPrototype656" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">inline</span> <span class="SHKeyword">void</span> CallL(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">u16 </td><td class="PName last">addr,</td></tr><tr><td class="PType first">u8 </td><td class="PName last">l</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Direct call a routine at a given address with a 8-bits parameter in register L (generate ASM code: "call XXXX") No extra cost due to calling a C function.</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">addr<div class="CDLParameterType">u16</div></td><td class="CDLDefinition"><p>Address to call</p></td></tr><tr><td class="CDLEntry">l<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Function parameter to put in register L</p></td></tr></table></div>
|
|
</div>
|
|
|
|
<a name="CallLToA"></a><a name="Topic1428"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">CallLToA</div>
|
|
<div id="NDPrototype1428" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">inline</span> u8 CallLToA(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">u16 </td><td class="PName last">addr,</td></tr><tr><td class="PType first">u8 </td><td class="PName last">l</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Direct call a routine at a given address with a 8-bits parameter in register L (generate ASM code: "call XXXX") No extra cost due to calling a C function.</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">addr<div class="CDLParameterType">u16</div></td><td class="CDLDefinition"><p>Address to call</p></td></tr><tr><td class="CDLEntry">l<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Function parameter to put in register L</p></td></tr></table><div class="CHeading">Return</div><p>Value stored in register A</p></div>
|
|
</div>
|
|
|
|
<a name="CallHL"></a><a name="Topic657"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">CallHL</div>
|
|
<div id="NDPrototype657" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">inline</span> <span class="SHKeyword">void</span> CallHL(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">u16 </td><td class="PName last">addr,</td></tr><tr><td class="PType first">u16 </td><td class="PName last">hl</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Direct call a routine at a given address with a 16-bits parameter in register HL (generate ASM code: "call XXXX") No extra cost due to calling a C function.</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">addr<div class="CDLParameterType">u16</div></td><td class="CDLDefinition"><p>Address to call</p></td></tr><tr><td class="CDLEntry">val</td><td class="CDLDefinition"><p>Function parameter to put in register HL</p></td></tr></table></div>
|
|
</div>
|
|
|
|
<a name="CallHLToA"></a><a name="Topic1429"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">CallHLToA</div>
|
|
<div id="NDPrototype1429" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">inline</span> u8 CallHLToA(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">u16 </td><td class="PName last">addr,</td></tr><tr><td class="PType first">u16 </td><td class="PName last">hl</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Direct call a routine at a given address with a 16-bits parameter in register HL (generate ASM code: "call XXXX") No extra cost due to calling a C function.</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">addr<div class="CDLParameterType">u16</div></td><td class="CDLDefinition"><p>Address to call</p></td></tr><tr><td class="CDLEntry">val</td><td class="CDLDefinition"><p>Function parameter to put in register HL</p></td></tr></table><div class="CHeading">Return</div><p>Value stored in register A</p></div>
|
|
</div>
|
|
|
|
<a name="CallDriver"></a><a name="Topic658"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">CallDriver</div>
|
|
<div id="NDPrototype658" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">inline</span> u8 CallDriver(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">u16 </td><td class="PName last">addr,</td></tr><tr><td class="PType first">u8 </td><td class="PName last">val</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Direct call a routine at a given address with a 8-bits parameter in register A (generate ASM code: "call XXXX") No extra cost due to calling a C function.</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">addr<div class="CDLParameterType">u16</div></td><td class="CDLDefinition"><p>Address of the driver</p></td></tr><tr><td class="CDLEntry">val<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>8-bit value to transfer to driver's main function</p></td></tr></table><div class="CHeading">Return</div><p>Value returned by the driver</p></div>
|
|
</div>
|
|
|
|
<a name="Slot"></a><a name="Topic659"></a><div class="CTopic TGroup LC">
|
|
<div class="CTitle">Slot</div>
|
|
<div class="CBody"><p>Slot handling functions</p></div>
|
|
</div>
|
|
|
|
<a name="Sys_GetPageSlot"></a><a name="Topic660"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Sys_GetPageSlot</div>
|
|
<div id="NDPrototype660" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters">u8 Sys_GetPageSlot(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">u8 </td><td class="PName last">page</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Get the slot ID of a given page</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">page<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>The page to ckeck</p></td></tr></table><div class="CHeading">Return</div><p>The slot ID</p></div>
|
|
</div>
|
|
|
|
<a name="Sys_SetPageSlot"></a><a name="Topic661"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Sys_SetPageSlot</div>
|
|
<div id="NDPrototype661" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">void</span> Sys_SetPageSlot(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">u8 </td><td class="PName last">page,</td></tr><tr><td class="PType first">u8 </td><td class="PName last">slotId</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Select a slot in a given page</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">page<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>The page to change</p></td></tr><tr><td class="CDLEntry">slotId<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>The slot ID to select</p></td></tr></table></div>
|
|
</div>
|
|
|
|
<a name="Sys_IsSlotExpanded"></a><a name="Topic662"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Sys_IsSlotExpanded</div>
|
|
<div id="NDPrototype662" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">inline</span> <span class="SHKeyword">bool</span> Sys_IsSlotExpanded(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">u8 </td><td class="PName last">slot</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Check if slot is expanded</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">slot<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>The slot to check</p></td></tr></table><div class="CHeading">Return</div><p>FALSE if the slot is not expanded</p></div>
|
|
</div>
|
|
|
|
<a name="Sys_SetPage0Slot"></a><a name="Topic663"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Sys_SetPage0Slot</div>
|
|
<div id="NDPrototype663" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">void</span> Sys_SetPage0Slot(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">u8 </td><td class="PName last">slotId</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Select a given slot in page 0</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">slotId<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>The slot to select</p></td></tr></table></div>
|
|
</div>
|
|
|
|
<a name="Sys_SlotIsExpended"></a><a name="Topic664"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Sys_SlotIsExpended</div>
|
|
<div id="NDPrototype664" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">inline</span> <span class="SHKeyword">bool</span> Sys_SlotIsExpended(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">u8 </td><td class="PName last">slotId</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Check expended flag from slot ID</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">slotId<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>The slot ID</p></td></tr></table><div class="CHeading">Return</div><p>FALSE if the slot is not expended</p></div>
|
|
</div>
|
|
|
|
<a name="Sys_SlotGetPrimary"></a><a name="Topic665"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Sys_SlotGetPrimary</div>
|
|
<div id="NDPrototype665" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">inline</span> u8 Sys_SlotGetPrimary(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">u8 </td><td class="PName last">slotId</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Get primary slot from slot ID</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">slotId<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>The slot ID</p></td></tr></table><div class="CHeading">Return</div><p>The primary slot of the slot ID</p></div>
|
|
</div>
|
|
|
|
<a name="Sys_SlotGetSecondary"></a><a name="Topic666"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Sys_SlotGetSecondary</div>
|
|
<div id="NDPrototype666" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">inline</span> u8 Sys_SlotGetSecondary(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">u8 </td><td class="PName last">slotId</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Get secondary slot from slot ID</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">slotId<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>The slot ID</p></td></tr></table><div class="CHeading">Return</div><p>The secondary slot of the slot ID</p></div>
|
|
</div>
|
|
|
|
<a name="Sys_CheckSlot"></a><a name="Topic667"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Sys_CheckSlot</div>
|
|
<div id="NDPrototype667" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters">u8 Sys_CheckSlot(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">CheckSlotCallback </td><td class="PName last">cb</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Check all slots with a given callback function</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">cb<div class="CDLParameterType">CheckSlotCallback</div></td><td class="CDLDefinition"><p>Callback function to call for each slot</p></td></tr></table><div class="CHeading">Return</div><p>The slot ID that match the callback function</p></div>
|
|
</div>
|
|
|
|
<a name="Address"></a><a name="Topic668"></a><div class="CTopic TGroup LC">
|
|
<div class="CTitle">Address</div>
|
|
<div class="CBody"><p>Binary address functions</p></div>
|
|
</div>
|
|
|
|
<a name="Sys_GetFirstAddr"></a><a name="Topic669"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Sys_GetFirstAddr</div>
|
|
<div id="NDPrototype669" class="NDPrototype"><div class="PSection PPlainSection"><span class="SHKeyword">inline</span> u16 Sys_GetFirstAddr()</div></div>
|
|
<div class="CBody"><p>Get first address of program binary</p><div class="CHeading">Return</div><p>The first address of the program binary</p></div>
|
|
</div>
|
|
|
|
<a name="Sys_GetHeaderAddr"></a><a name="Topic670"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Sys_GetHeaderAddr</div>
|
|
<div id="NDPrototype670" class="NDPrototype"><div class="PSection PPlainSection"><span class="SHKeyword">inline</span> u16 Sys_GetHeaderAddr()</div></div>
|
|
<div class="CBody"><p>Get address of program header (if any)</p><div class="CHeading">Return</div><p>The address of the program header</p></div>
|
|
</div>
|
|
|
|
<a name="Sys_GetLastAddr"></a><a name="Topic671"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Sys_GetLastAddr</div>
|
|
<div id="NDPrototype671" class="NDPrototype"><div class="PSection PPlainSection"><span class="SHKeyword">inline</span> u16 Sys_GetLastAddr()</div></div>
|
|
<div class="CBody"><p>Get last address of program binary</p><div class="CHeading">Return</div><p>The last address of the program binary</p></div>
|
|
</div>
|
|
|
|
<a name="Misc"></a><a name="Topic672"></a><div class="CTopic TGroup LC">
|
|
<div class="CTitle">Misc</div>
|
|
<div class="CBody"><p>Miscellaneous helper functions</p></div>
|
|
</div>
|
|
|
|
<a name="Sys_PlayClickSound"></a><a name="Topic673"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Sys_PlayClickSound</div>
|
|
<div id="NDPrototype673" class="NDPrototype"><div class="PSection PPlainSection"><span class="SHKeyword">inline</span> <span class="SHKeyword">void</span> Sys_PlayClickSound()</div></div>
|
|
<div class="CBody"><p>Play the click sound</p></div>
|
|
</div>
|
|
|
|
<a name="Sys_StopClickSound"></a><a name="Topic674"></a><div class="CTopic TFunction LC last">
|
|
<div class="CTitle">Sys_StopClickSound</div>
|
|
<div id="NDPrototype674" class="NDPrototype"><div class="PSection PPlainSection"><span class="SHKeyword">inline</span> <span class="SHKeyword">void</span> Sys_StopClickSound()</div></div>
|
|
<div class="CBody"><p>Stop the click sound</p></div>
|
|
</div>
|
|
|
|
</body></html> |