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

79 lines
10 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>debug.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="Debug"></a><a name="Topic1406"></a><div class="CTopic TGroup LC first">
<div class="CTitle">Debug</div>
</div>
<a name="DEBUG_INIT"></a><a name="Topic1407"></a><div class="CTopic TFunction LC">
<div class="CTitle">DEBUG_INIT</div>
<div id="NDPrototype1407" class="NDPrototype"><div class="PSection PPlainSection"><span class="SHKeyword">void</span> DEBUG_INIT()</div></div>
<div class="CBody"><p>Initialize Debug module.</p><div class="CHeading">Notes</div><ul><li><p>[Emulicious] This allow to mark area reserved by BIOS to help detection of unset memory access</p></li></ul></div>
</div>
<a name="DEBUG_BREAK"></a><a name="Topic1408"></a><div class="CTopic TFunction LC">
<div class="CTitle">DEBUG_BREAK</div>
<div id="NDPrototype1408" class="NDPrototype"><div class="PSection PPlainSection"><span class="SHKeyword">void</span> DEBUG_BREAK()</div></div>
<div class="CBody"><p>Force a break point.</p><div class="CHeading">Notes</div><ul><li><p>[Emulicious] You need the &quot;Break on ld b, b instruction&quot; exception to be activated.</p></li><li><p>[openMSX] You need the &quot;tools/script/openMSX/debugger_pvm.tcl&quot; script to be loaded to use this function.</p></li></ul></div>
</div>
<a name="DEBUG_ASSERT"></a><a name="Topic937"></a><div class="CTopic TFunction LC">
<div class="CTitle">DEBUG_ASSERT</div>
<div id="NDPrototype937" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">void</span> DEBUG_ASSERT(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first"><span class="SHKeyword">bool</span>&nbsp;</td><td class="PName last">a</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
<div class="CBody"><p>Conditional break.</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">a<div class="CDLParameterType"><span class="SHKeyword">bool</span></div></td><td class="CDLDefinition"><p>Instructions to evaluate. A 'false' result will trigger a break.</p></td></tr></table><div class="CHeading">Notes</div><ul><li><p>[Emulicious] You need the &quot;Break on ld b, b instruction&quot; exception to be activated.</p></li><li><p>[openMSX] You need the &quot;tools/script/openMSX/debugger_pvm.tcl&quot; script to be loaded to use this function.</p></li></ul></div>
</div>
<a name="DEBUG_LOG"></a><a name="Topic1451"></a><div class="CTopic TFunction LC">
<div class="CTitle">DEBUG_LOG</div>
<div id="NDPrototype1451" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">void</span> DEBUG_LOG(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PModifierQualifier first"><span class="SHKeyword">const</span>&nbsp;</td><td class="PType">c8*&nbsp;</td><td class="PName last">msg</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
<div class="CBody"><p>Display debug message (and return to next line).</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">msg<div class="CDLParameterType"><span class="SHKeyword">const</span> c8*</div></td><td class="CDLDefinition"><p>Nul-terminated string with message to display</p></td></tr></table></div>
</div>
<a name="DEBUG_LOGNUM"></a><a name="Topic1459"></a><div class="CTopic TFunction LC">
<div class="CTitle">DEBUG_LOGNUM</div>
<div id="NDPrototype1459" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">void</span> DEBUG_LOGNUM(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PModifierQualifier first"><span class="SHKeyword">const</span>&nbsp;</td><td class="PType">c8*&nbsp;</td><td class="PName last">msg,</td></tr><tr><td class="first"></td><td class="PType">u8&nbsp;</td><td class="PName last">num</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
<div class="CBody"><p>Display debug message and a 8-bits value (and return to next line).</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">msg<div class="CDLParameterType"><span class="SHKeyword">const</span> c8*</div></td><td class="CDLDefinition"><p>Nul-terminated string with numer name</p></td></tr><tr><td class="CDLEntry">num<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>8-bit number value</p></td></tr></table></div>
</div>
<a name="DEBUG_PRINT"></a><a name="Topic1460"></a><div class="CTopic TFunction LC">
<div class="CTitle">DEBUG_PRINT</div>
<div id="NDPrototype1460" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">void</span> DEBUG_PRINT(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PModifierQualifier first"><span class="SHKeyword">const</span>&nbsp;</td><td class="PType">c8*&nbsp;</td><td></td><td class="PName last">format,</td></tr><tr><td class="first"></td><td></td><td class="PSymbols">...</td><td class="last"></td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
<div class="CBody"><p>Display debug formatted message.&nbsp; No new line is added at the end of the message.</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">format<div class="CDLParameterType"><span class="SHKeyword">const</span> c8*</div></td><td class="CDLDefinition"><p>Nul-terminated string with format specifiers</p></td></tr></table><div class="CHeading">Notes</div><ul><li><p>[Emulicious] Supported format specifiers: <a href="https://www.tutorialspoint.com/format-specifiers-in-c" target="_top">https://&#8203;www&#8203;.tutorialspoint&#8203;.com&#8203;/format-specifiers-in-c</a></p></li><li><p>[openMSX] You need the &quot;tools/script/openMSX/debugger_pvm.tcl&quot; script to be loaded to use this function.</p></li></ul></div>
</div>
<a name="Profile"></a><a name="Topic1413"></a><div class="CTopic TGroup LC">
<div class="CTitle">Profile</div>
</div>
<a name="PROFILE_FRAME_START"></a><a name="Topic1414"></a><div class="CTopic TFunction LC">
<div class="CTitle">PROFILE_FRAME_START</div>
<div id="NDPrototype1414" class="NDPrototype"><div class="PSection PPlainSection"><span class="SHKeyword">inline</span> <span class="SHKeyword">void</span> PROFILE_FRAME_START()</div></div>
<div class="CBody"><p>Signal the start of a frame to be measured.</p></div>
</div>
<a name="PROFILE_FRAME_END"></a><a name="Topic1415"></a><div class="CTopic TFunction LC">
<div class="CTitle">PROFILE_FRAME_END</div>
<div id="NDPrototype1415" class="NDPrototype"><div class="PSection PPlainSection"><span class="SHKeyword">inline</span> <span class="SHKeyword">void</span> PROFILE_FRAME_END()</div></div>
<div class="CBody"><p>Signal the end of a frame to be measured.</p></div>
</div>
<a name="PROFILE_SECTION_START"></a><a name="Topic1461"></a><div class="CTopic TFunction LC">
<div class="CTitle">PROFILE_SECTION_START</div>
<div id="NDPrototype1461" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">inline</span> <span class="SHKeyword">void</span> PROFILE_SECTION_START(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="first"></td><td class="PType">u8&nbsp;</td><td class="PName last">level,</td></tr><tr><td class="first"></td><td class="PType">u8&nbsp;</td><td class="PName last">section,</td></tr><tr><td class="PModifierQualifier first"><span class="SHKeyword">const</span>&nbsp;</td><td class="PType">c8*&nbsp;</td><td class="PName last">msg</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
<div class="CBody"><p>Signal the start of a section to be measured.</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">level<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Minimal level to display the section</p></td></tr><tr><td class="CDLEntry">section<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Section identifier</p></td></tr><tr><td class="CDLEntry">msg<div class="CDLParameterType"><span class="SHKeyword">const</span> c8*</div></td><td class="CDLDefinition"><p>Nul-terminated string with section name</p></td></tr></table></div>
</div>
<a name="PROFILE_SECTION_END"></a><a name="Topic1462"></a><div class="CTopic TFunction LC last">
<div class="CTitle">PROFILE_SECTION_END</div>
<div id="NDPrototype1462" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">inline</span> <span class="SHKeyword">void</span> PROFILE_SECTION_END(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="first"></td><td class="PType">u8&nbsp;</td><td class="PName last">level,</td></tr><tr><td class="first"></td><td class="PType">u8&nbsp;</td><td class="PName last">section,</td></tr><tr><td class="PModifierQualifier first"><span class="SHKeyword">const</span>&nbsp;</td><td class="PType">c8*&nbsp;</td><td class="PName last">msg</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
<div class="CBody"><p>Signal the end of a section to be measured.</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">level<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Minimal level to display the section</p></td></tr><tr><td class="CDLEntry">section<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Section identifier</p></td></tr><tr><td class="CDLEntry">msg<div class="CDLParameterType"><span class="SHKeyword">const</span> c8*</div></td><td class="CDLDefinition"><p>Nul-terminated string with section name</p></td></tr></table></div>
</div>
</body></html>
Reference in New Issue View Git Blame Copy Permalink