gbdk-2020 | GameBoy Development Kit |
| download: https://git.y1.nz/archives/gbdk.tar.gz | |
| README | Files | Log | Refs | LICENSE |
docs/api/gbdk_2emu__debug_8h.html
1 <!-- HTML header for doxygen 1.8.14-->
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml">
4 <head>
5 <meta http-equiv="cache-control" content="max-age=86400"/>
6 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
7 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
8 <meta name="generator" content="Doxygen 1.9.2"/>
9 <meta name="viewport" content="width=device-width, initial-scale=1"/>
10 <title>GBDK 2020 Docs: gbdk-lib/include/gbdk/emu_debug.h File Reference</title>
11 <link href="tabs.css" rel="stylesheet" type="text/css"/>
12 <script type="text/javascript" src="jquery.js"></script>
13 <script type="text/javascript" src="dynsections.js"></script>
14 <link href="navtree.css" rel="stylesheet" type="text/css"/>
15 <script type="text/javascript" src="resize.js"></script>
16 <script type="text/javascript" src="navtreedata.js"></script>
17 <script type="text/javascript" src="navtree.js"></script>
18 <link href="search/search.css" rel="stylesheet" type="text/css"/>
19 <script type="text/javascript" src="search/searchdata.js"></script>
20 <script type="text/javascript" src="search/search.js"></script>
21 <link href="doxygen.css" rel="stylesheet" type="text/css" />
22 <link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
23 <link href="doxygen-awesome-sidebar-only.css" rel="stylesheet" type="text/css"/>
24 <link href="doxygen-awesome-sidebar-only-darkmode-toggle.css" rel="stylesheet" type="text/css"/>
25 <!-- BEGIN: doxygen-awesome-css -->
26 <script type="text/javascript" src="doxygen-awesome-darkmode-toggle.js"></script>
27 <script type="text/javascript">
28 DoxygenAwesomeDarkModeToggle.init()
29 </script>
30 <script type="text/javascript" src="doxygen-awesome-paragraph-link.js"></script>
31 <script type="text/javascript">
32 DoxygenAwesomeParagraphLink.init()
33 </script>
34 <!-- END: doxygen-awesome-css -->
35 </head>
36 <body>
37 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
38 <div id="titlearea">
39 <table cellspacing="0" cellpadding="0">
40 <tbody>
41 <tr style="height: 56px;">
42 <td id="projectalign" style="padding-left: 0.5em;">
43 <div id="projectname">GBDK 2020 Docs
44  <span id="projectnumber">4.5.0</span>
45 </div>
46 <div id="projectbrief">API Documentation for GBDK 2020</div>
47 </td>
48 </tr>
49 </tbody>
50 </table>
51 </div>
52 <!-- end header part -->
53 <!-- Generated by Doxygen 1.9.2 -->
54 <script type="text/javascript">
55 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
56 var searchBox = new SearchBox("searchBox", "search",'Search','.html');
57 /* @license-end */
58 </script>
59 <script type="text/javascript" src="menudata.js"></script>
60 <script type="text/javascript" src="menu.js"></script>
61 <script type="text/javascript">
62 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
63 $(function() {
64 initMenu('',true,false,'search.php','Search');
65 $(document).ready(function() { init_search(); });
66 });
67 /* @license-end */
68 </script>
69 <div id="main-nav"></div>
70 </div><!-- top -->
71 <div id="side-nav" class="ui-resizable side-nav-resizable">
72 <div id="nav-tree">
73 <div id="nav-tree-contents">
74 <div id="nav-sync" class="sync"></div>
75 </div>
76 </div>
77 <div id="splitbar" style="-moz-user-select:none;"
78 class="ui-resizable-handle">
79 </div>
80 </div>
81 <script type="text/javascript">
82 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
83 $(document).ready(function(){initNavTree('gbdk_2emu__debug_8h.html',''); initResizable(); });
84 /* @license-end */
85 </script>
86 <div id="doc-content">
87 <!-- window showing the filter options -->
88 <div id="MSearchSelectWindow"
89 onmouseover="return searchBox.OnSearchSelectShow()"
90 onmouseout="return searchBox.OnSearchSelectHide()"
91 onkeydown="return searchBox.OnSearchSelectKey(event)">
92 </div>
93
94 <!-- iframe showing the search results (closed by default) -->
95 <div id="MSearchResultsWindow">
96 <iframe src="javascript:void(0)" frameborder="0"
97 name="MSearchResults" id="MSearchResults">
98 </iframe>
99 </div>
100
101 <div class="header">
102 <div class="summary">
103 <a href="#define-members">Macros</a> |
104 <a href="#func-members">Functions</a> |
105 <a href="#var-members">Variables</a> </div>
106 <div class="headertitle"><div class="title">emu_debug.h File Reference</div></div>
107 </div><!--header-->
108 <div class="contents">
109 <div class="textblock"><code>#include <types.h></code><br />
110 </div>
111 <p><a href="gbdk_2emu__debug_8h_source.html">Go to the source code of this file.</a></p>
112 <table class="memberdecls">
113 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
114 Macros</h2></td></tr>
115 <tr class="memitem:EMU_MESSAGE"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="gbdk_2emu__debug_8h.html#EMU_MESSAGE">EMU_MESSAGE</a>(message_text)   EMU_MESSAGE1(EMU_MACRONAME(__LINE__), message_text)</td></tr>
116 <tr class="separator:EMU_MESSAGE"><td class="memSeparator" colspan="2"> </td></tr>
117 <tr class="memitem:BGB_MESSAGE"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="gbdk_2emu__debug_8h.html#BGB_MESSAGE">BGB_MESSAGE</a>(message_text)   <a class="el" href="gbdk_2emu__debug_8h.html#EMU_MESSAGE">EMU_MESSAGE</a>(message_text)</td></tr>
118 <tr class="separator:BGB_MESSAGE"><td class="memSeparator" colspan="2"> </td></tr>
119 <tr class="memitem:EMU_PROFILE_BEGIN"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="gbdk_2emu__debug_8h.html#EMU_PROFILE_BEGIN">EMU_PROFILE_BEGIN</a>(MSG)   EMU_MESSAGE_SUFFIX(MSG, "%ZEROCLKS%");</td></tr>
120 <tr class="separator:EMU_PROFILE_BEGIN"><td class="memSeparator" colspan="2"> </td></tr>
121 <tr class="memitem:BGB_PROFILE_BEGIN"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="gbdk_2emu__debug_8h.html#BGB_PROFILE_BEGIN">BGB_PROFILE_BEGIN</a>(MSG)   <a class="el" href="gbdk_2emu__debug_8h.html#EMU_PROFILE_BEGIN">EMU_PROFILE_BEGIN</a>(MSG)</td></tr>
122 <tr class="separator:BGB_PROFILE_BEGIN"><td class="memSeparator" colspan="2"> </td></tr>
123 <tr class="memitem:EMU_PROFILE_END"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="gbdk_2emu__debug_8h.html#EMU_PROFILE_END">EMU_PROFILE_END</a>(MSG)   EMU_MESSAGE_SUFFIX(MSG,"%-8+LASTCLKS%");</td></tr>
124 <tr class="separator:EMU_PROFILE_END"><td class="memSeparator" colspan="2"> </td></tr>
125 <tr class="memitem:BGB_PROFILE_END"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="gbdk_2emu__debug_8h.html#BGB_PROFILE_END">BGB_PROFILE_END</a>(MSG)   <a class="el" href="gbdk_2emu__debug_8h.html#EMU_PROFILE_END">EMU_PROFILE_END</a>(MSG)</td></tr>
126 <tr class="separator:BGB_PROFILE_END"><td class="memSeparator" colspan="2"> </td></tr>
127 <tr class="memitem:EMU_TEXT"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="gbdk_2emu__debug_8h.html#EMU_TEXT">EMU_TEXT</a>(MSG)   <a class="el" href="gbdk_2emu__debug_8h.html#EMU_MESSAGE">EMU_MESSAGE</a>(MSG)</td></tr>
128 <tr class="separator:EMU_TEXT"><td class="memSeparator" colspan="2"> </td></tr>
129 <tr class="memitem:BGB_TEXT"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="gbdk_2emu__debug_8h.html#BGB_TEXT">BGB_TEXT</a>(MSG)   <a class="el" href="gbdk_2emu__debug_8h.html#EMU_TEXT">EMU_TEXT</a>(MSG)</td></tr>
130 <tr class="separator:BGB_TEXT"><td class="memSeparator" colspan="2"> </td></tr>
131 <tr class="memitem:BGB_profiler_message"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="gbdk_2emu__debug_8h.html#BGB_profiler_message">BGB_profiler_message</a>   <a class="el" href="gbdk_2emu__debug_8h.html#EMU_profiler_message">EMU_profiler_message</a>()</td></tr>
132 <tr class="separator:BGB_profiler_message"><td class="memSeparator" colspan="2"> </td></tr>
133 <tr class="memitem:BGB_printf"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="gbdk_2emu__debug_8h.html#BGB_printf">BGB_printf</a>(...)   <a class="el" href="gbdk_2emu__debug_8h.html#EMU_printf">EMU_printf</a>(__VA_ARGS__)</td></tr>
134 <tr class="separator:BGB_printf"><td class="memSeparator" colspan="2"> </td></tr>
135 <tr class="memitem:EMU_BREAKPOINT"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="gbdk_2emu__debug_8h.html#EMU_BREAKPOINT">EMU_BREAKPOINT</a>   __asm__("ld <a class="el" href="sms_8h.html#b">b</a>, <a class="el" href="sms_8h.html#b">b</a>");</td></tr>
136 <tr class="separator:EMU_BREAKPOINT"><td class="memSeparator" colspan="2"> </td></tr>
137 <tr class="memitem:BGB_BREAKPOINT"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="gbdk_2emu__debug_8h.html#BGB_BREAKPOINT">BGB_BREAKPOINT</a>   <a class="el" href="gbdk_2emu__debug_8h.html#EMU_BREAKPOINT">EMU_BREAKPOINT</a></td></tr>
138 <tr class="separator:BGB_BREAKPOINT"><td class="memSeparator" colspan="2"> </td></tr>
139 </table><table class="memberdecls">
140 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
141 Functions</h2></td></tr>
142 <tr class="memitem:EMU_profiler_message"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="gbdk_2emu__debug_8h.html#EMU_profiler_message">EMU_profiler_message</a> (void)</td></tr>
143 <tr class="separator:EMU_profiler_message"><td class="memSeparator" colspan="2"> </td></tr>
144 <tr class="memitem:EMU_printf"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="gbdk_2emu__debug_8h.html#EMU_printf">EMU_printf</a> (const char *format,...) <a class="el" href="asm_2types_8h.html#PRESERVES_REGS">PRESERVES_REGS</a>(a</td></tr>
145 <tr class="separator:EMU_printf"><td class="memSeparator" colspan="2"> </td></tr>
146 <tr class="memitem:EMU_fmtbuf"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="gbdk_2emu__debug_8h.html#EMU_fmtbuf">EMU_fmtbuf</a> (const unsigned char *format, void *data) <a class="el" href="asm_2types_8h.html#PRESERVES_REGS">PRESERVES_REGS</a>(a</td></tr>
147 <tr class="separator:EMU_fmtbuf"><td class="memSeparator" colspan="2"> </td></tr>
148 </table><table class="memberdecls">
149 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="var-members" name="var-members"></a>
150 Variables</h2></td></tr>
151 <tr class="memitem:b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="gbdk_2emu__debug_8h.html#b">b</a></td></tr>
152 <tr class="separator:b"><td class="memSeparator" colspan="2"> </td></tr>
153 <tr class="memitem:c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="gbdk_2emu__debug_8h.html#c">c</a></td></tr>
154 <tr class="separator:c"><td class="memSeparator" colspan="2"> </td></tr>
155 </table>
156 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
157 <div class="textblock"><p >Debug window logging and profiling support for emulators (BGB, Emulicious, etc).</p>
158 <p >Also see the <code>emu_debug</code> example project included with gbdk.</p>
159 <p >See the BGB Manual for more information ("expressions, breakpoint conditions, and debug messages") <a href="http://bgb.bircd.org/manual.html#expressions">http://bgb.bircd.org/manual.html#expressions</a> </p>
160 </div><h2 class="groupheader">Macro Definition Documentation</h2>
161 <a id="EMU_MESSAGE" name="EMU_MESSAGE"></a>
162 <h2 class="memtitle"><span class="permalink"><a href="#EMU_MESSAGE">◆ </a></span>EMU_MESSAGE</h2>
163
164 <div class="memitem">
165 <div class="memproto">
166 <table class="memname">
167 <tr>
168 <td class="memname">#define EMU_MESSAGE</td>
169 <td>(</td>
170 <td class="paramtype"> </td>
171 <td class="paramname">message_text</td><td>)</td>
172 <td>   EMU_MESSAGE1(EMU_MACRONAME(__LINE__), message_text)</td>
173 </tr>
174 </table>
175 </div><div class="memdoc">
176 <p >Macro to display a message in the emulator debug message window</p>
177 <dl class="params"><dt>Parameters</dt><dd>
178 <table class="params">
179 <tr><td class="paramname">message_text</td><td>Quoted text string to display in the debug message window</td></tr>
180 </table>
181 </dd>
182 </dl>
183 <p>The following special parameters can be used when bracketed with "%" characters. </p><ul>
184 <li>CPU registers: AF, BC, DE, HL, SP, PC, B, C, D, E, H, L, A, ZERO, ZF, Z, CARRY, CY, IME, ALLREGS </li>
185 <li>Other state values: ROMBANK, XRAMBANK, SRAMBANK, WRAMBANK, VRAMBANK, TOTALCLKS, LASTCLKS, CLKS2VBLANK</li>
186 </ul>
187 <p>Example: print a message along with the currently active ROM bank. </p><div class="fragment"><div class="line"><a class="code hl_define" href="gbdk_2emu__debug_8h.html#EMU_MESSAGE">EMU_MESSAGE</a>(<span class="stringliteral">"Current ROM Bank is: %ROMBANK%"</span>);</div>
188 <div class="ttc" id="agbdk_2emu__debug_8h_html_EMU_MESSAGE"><div class="ttname"><a href="gbdk_2emu__debug_8h.html#EMU_MESSAGE">EMU_MESSAGE</a></div><div class="ttdeci">#define EMU_MESSAGE(message_text)</div><div class="ttdef"><b>Definition:</b> emu_debug.h:46</div></div>
189 </div><!-- fragment --><p >See the BGB Manual for more information ("expressions, breakpoint conditions, and debug messages") <a href="http://bgb.bircd.org/manual.html#expressions">http://bgb.bircd.org/manual.html#expressions</a></p>
190 <dl class="section see"><dt>See also</dt><dd><a class="el" href="gbdk_2emu__debug_8h.html#EMU_PROFILE_BEGIN">EMU_PROFILE_BEGIN()</a>, <a class="el" href="gbdk_2emu__debug_8h.html#EMU_PROFILE_END">EMU_PROFILE_END()</a> </dd></dl>
191
192 </div>
193 </div>
194 <a id="BGB_MESSAGE" name="BGB_MESSAGE"></a>
195 <h2 class="memtitle"><span class="permalink"><a href="#BGB_MESSAGE">◆ </a></span>BGB_MESSAGE</h2>
196
197 <div class="memitem">
198 <div class="memproto">
199 <table class="memname">
200 <tr>
201 <td class="memname">#define BGB_MESSAGE</td>
202 <td>(</td>
203 <td class="paramtype"> </td>
204 <td class="paramname">message_text</td><td>)</td>
205 <td>   <a class="el" href="gbdk_2emu__debug_8h.html#EMU_MESSAGE">EMU_MESSAGE</a>(message_text)</td>
206 </tr>
207 </table>
208 </div><div class="memdoc">
209
210 </div>
211 </div>
212 <a id="EMU_PROFILE_BEGIN" name="EMU_PROFILE_BEGIN"></a>
213 <h2 class="memtitle"><span class="permalink"><a href="#EMU_PROFILE_BEGIN">◆ </a></span>EMU_PROFILE_BEGIN</h2>
214
215 <div class="memitem">
216 <div class="memproto">
217 <table class="memname">
218 <tr>
219 <td class="memname">#define EMU_PROFILE_BEGIN</td>
220 <td>(</td>
221 <td class="paramtype"> </td>
222 <td class="paramname">MSG</td><td>)</td>
223 <td>   EMU_MESSAGE_SUFFIX(MSG, "%ZEROCLKS%");</td>
224 </tr>
225 </table>
226 </div><div class="memdoc">
227 <p >Macro to <b>Start</b> a profiling block for the emulator (BGB, Emulicious, etc)</p>
228 <dl class="params"><dt>Parameters</dt><dd>
229 <table class="params">
230 <tr><td class="paramname">MSG</td><td>Quoted text string to display in the debug message window along with the result</td></tr>
231 </table>
232 </dd>
233 </dl>
234 <p>To complete the profiling block and print the result call <a class="el" href="gbdk_2emu__debug_8h.html#EMU_PROFILE_END">EMU_PROFILE_END</a>.</p>
235 <dl class="section see"><dt>See also</dt><dd><a class="el" href="gbdk_2emu__debug_8h.html#EMU_PROFILE_END">EMU_PROFILE_END()</a>, <a class="el" href="gbdk_2emu__debug_8h.html#EMU_MESSAGE">EMU_MESSAGE()</a> </dd></dl>
236
237 </div>
238 </div>
239 <a id="BGB_PROFILE_BEGIN" name="BGB_PROFILE_BEGIN"></a>
240 <h2 class="memtitle"><span class="permalink"><a href="#BGB_PROFILE_BEGIN">◆ </a></span>BGB_PROFILE_BEGIN</h2>
241
242 <div class="memitem">
243 <div class="memproto">
244 <table class="memname">
245 <tr>
246 <td class="memname">#define BGB_PROFILE_BEGIN</td>
247 <td>(</td>
248 <td class="paramtype"> </td>
249 <td class="paramname">MSG</td><td>)</td>
250 <td>   <a class="el" href="gbdk_2emu__debug_8h.html#EMU_PROFILE_BEGIN">EMU_PROFILE_BEGIN</a>(MSG)</td>
251 </tr>
252 </table>
253 </div><div class="memdoc">
254
255 </div>
256 </div>
257 <a id="EMU_PROFILE_END" name="EMU_PROFILE_END"></a>
258 <h2 class="memtitle"><span class="permalink"><a href="#EMU_PROFILE_END">◆ </a></span>EMU_PROFILE_END</h2>
259
260 <div class="memitem">
261 <div class="memproto">
262 <table class="memname">
263 <tr>
264 <td class="memname">#define EMU_PROFILE_END</td>
265 <td>(</td>
266 <td class="paramtype"> </td>
267 <td class="paramname">MSG</td><td>)</td>
268 <td>   EMU_MESSAGE_SUFFIX(MSG,"%-8+LASTCLKS%");</td>
269 </tr>
270 </table>
271 </div><div class="memdoc">
272 <p >Macro to <b>End</b> a profiling block and print the results in the emulator debug message window</p>
273 <dl class="params"><dt>Parameters</dt><dd>
274 <table class="params">
275 <tr><td class="paramname">MSG</td><td>Quoted text string to display in the debug message window along with the result</td></tr>
276 </table>
277 </dd>
278 </dl>
279 <p>This should only be called after a previous call to <a class="el" href="gbdk_2emu__debug_8h.html#EMU_PROFILE_BEGIN">EMU_PROFILE_BEGIN()</a></p>
280 <p >The results are in Emulator clock units, which are "1 nop in [CGB] doublespeed mode".</p>
281 <p >So when running in Normal Speed mode (i.e. non-CGB doublespeed) the printed result should be <b>divided by 2</b> to get the actual ellapsed cycle count.</p>
282 <p >If running in CB Double Speed mode use the below call instead, it correctly compensates for the speed difference. In this scenario, the result does <b>not need to be divided by 2</b> to get the ellapsed cycle count. </p><div class="fragment"><div class="line"><a class="code hl_define" href="gbdk_2emu__debug_8h.html#EMU_MESSAGE">EMU_MESSAGE</a>(<span class="stringliteral">"NOP TIME: %-4+LASTCLKS%"</span>);</div>
283 </div><!-- fragment --><dl class="section see"><dt>See also</dt><dd><a class="el" href="gbdk_2emu__debug_8h.html#EMU_PROFILE_BEGIN">EMU_PROFILE_BEGIN()</a>, <a class="el" href="gbdk_2emu__debug_8h.html#EMU_MESSAGE">EMU_MESSAGE()</a> </dd></dl>
284
285 </div>
286 </div>
287 <a id="BGB_PROFILE_END" name="BGB_PROFILE_END"></a>
288 <h2 class="memtitle"><span class="permalink"><a href="#BGB_PROFILE_END">◆ </a></span>BGB_PROFILE_END</h2>
289
290 <div class="memitem">
291 <div class="memproto">
292 <table class="memname">
293 <tr>
294 <td class="memname">#define BGB_PROFILE_END</td>
295 <td>(</td>
296 <td class="paramtype"> </td>
297 <td class="paramname">MSG</td><td>)</td>
298 <td>   <a class="el" href="gbdk_2emu__debug_8h.html#EMU_PROFILE_END">EMU_PROFILE_END</a>(MSG)</td>
299 </tr>
300 </table>
301 </div><div class="memdoc">
302
303 </div>
304 </div>
305 <a id="EMU_TEXT" name="EMU_TEXT"></a>
306 <h2 class="memtitle"><span class="permalink"><a href="#EMU_TEXT">◆ </a></span>EMU_TEXT</h2>
307
308 <div class="memitem">
309 <div class="memproto">
310 <table class="memname">
311 <tr>
312 <td class="memname">#define EMU_TEXT</td>
313 <td>(</td>
314 <td class="paramtype"> </td>
315 <td class="paramname">MSG</td><td>)</td>
316 <td>   <a class="el" href="gbdk_2emu__debug_8h.html#EMU_MESSAGE">EMU_MESSAGE</a>(MSG)</td>
317 </tr>
318 </table>
319 </div><div class="memdoc">
320
321 </div>
322 </div>
323 <a id="BGB_TEXT" name="BGB_TEXT"></a>
324 <h2 class="memtitle"><span class="permalink"><a href="#BGB_TEXT">◆ </a></span>BGB_TEXT</h2>
325
326 <div class="memitem">
327 <div class="memproto">
328 <table class="memname">
329 <tr>
330 <td class="memname">#define BGB_TEXT</td>
331 <td>(</td>
332 <td class="paramtype"> </td>
333 <td class="paramname">MSG</td><td>)</td>
334 <td>   <a class="el" href="gbdk_2emu__debug_8h.html#EMU_TEXT">EMU_TEXT</a>(MSG)</td>
335 </tr>
336 </table>
337 </div><div class="memdoc">
338
339 </div>
340 </div>
341 <a id="BGB_profiler_message" name="BGB_profiler_message"></a>
342 <h2 class="memtitle"><span class="permalink"><a href="#BGB_profiler_message">◆ </a></span>BGB_profiler_message</h2>
343
344 <div class="memitem">
345 <div class="memproto">
346 <table class="memname">
347 <tr>
348 <td class="memname">#define BGB_profiler_message   <a class="el" href="gbdk_2emu__debug_8h.html#EMU_profiler_message">EMU_profiler_message</a>()</td>
349 </tr>
350 </table>
351 </div><div class="memdoc">
352
353 </div>
354 </div>
355 <a id="BGB_printf" name="BGB_printf"></a>
356 <h2 class="memtitle"><span class="permalink"><a href="#BGB_printf">◆ </a></span>BGB_printf</h2>
357
358 <div class="memitem">
359 <div class="memproto">
360 <table class="memname">
361 <tr>
362 <td class="memname">#define BGB_printf</td>
363 <td>(</td>
364 <td class="paramtype"> </td>
365 <td class="paramname"><em>...</em></td><td>)</td>
366 <td>   <a class="el" href="gbdk_2emu__debug_8h.html#EMU_printf">EMU_printf</a>(__VA_ARGS__)</td>
367 </tr>
368 </table>
369 </div><div class="memdoc">
370
371 </div>
372 </div>
373 <a id="EMU_BREAKPOINT" name="EMU_BREAKPOINT"></a>
374 <h2 class="memtitle"><span class="permalink"><a href="#EMU_BREAKPOINT">◆ </a></span>EMU_BREAKPOINT</h2>
375
376 <div class="memitem">
377 <div class="memproto">
378 <table class="memname">
379 <tr>
380 <td class="memname">#define EMU_BREAKPOINT   __asm__("ld <a class="el" href="sms_8h.html#b">b</a>, <a class="el" href="sms_8h.html#b">b</a>");</td>
381 </tr>
382 </table>
383 </div><div class="memdoc">
384 <p >The Emulator will break into debugger when encounters this line </p>
385
386 </div>
387 </div>
388 <a id="BGB_BREAKPOINT" name="BGB_BREAKPOINT"></a>
389 <h2 class="memtitle"><span class="permalink"><a href="#BGB_BREAKPOINT">◆ </a></span>BGB_BREAKPOINT</h2>
390
391 <div class="memitem">
392 <div class="memproto">
393 <table class="memname">
394 <tr>
395 <td class="memname">#define BGB_BREAKPOINT   <a class="el" href="gbdk_2emu__debug_8h.html#EMU_BREAKPOINT">EMU_BREAKPOINT</a></td>
396 </tr>
397 </table>
398 </div><div class="memdoc">
399
400 </div>
401 </div>
402 <h2 class="groupheader">Function Documentation</h2>
403 <a id="EMU_profiler_message" name="EMU_profiler_message"></a>
404 <h2 class="memtitle"><span class="permalink"><a href="#EMU_profiler_message">◆ </a></span>EMU_profiler_message()</h2>
405
406 <div class="memitem">
407 <div class="memproto">
408 <table class="memname">
409 <tr>
410 <td class="memname">void EMU_profiler_message </td>
411 <td>(</td>
412 <td class="paramtype">void </td>
413 <td class="paramname"></td><td>)</td>
414 <td></td>
415 </tr>
416 </table>
417 </div><div class="memdoc">
418 <p >Display preset debug information in the Emulator debug messages window.</p>
419 <p >This function is equivalent to: </p><div class="fragment"><div class="line"><a class="code hl_define" href="gbdk_2emu__debug_8h.html#EMU_MESSAGE">EMU_MESSAGE</a>(<span class="stringliteral">"PROFILE,%(SP+$0)%,%(SP+$1)%,%A%,%TOTALCLKS%,%ROMBANK%,%WRAMBANK%"</span>);</div>
420 </div><!-- fragment -->
421 </div>
422 </div>
423 <a id="EMU_printf" name="EMU_printf"></a>
424 <h2 class="memtitle"><span class="permalink"><a href="#EMU_printf">◆ </a></span>EMU_printf()</h2>
425
426 <div class="memitem">
427 <div class="memproto">
428 <table class="memname">
429 <tr>
430 <td class="memname">void EMU_printf </td>
431 <td>(</td>
432 <td class="paramtype">const char * </td>
433 <td class="paramname"><em>format</em>, </td>
434 </tr>
435 <tr>
436 <td class="paramkey"></td>
437 <td></td>
438 <td class="paramtype"> </td>
439 <td class="paramname"><em>...</em> </td>
440 </tr>
441 <tr>
442 <td></td>
443 <td>)</td>
444 <td></td><td></td>
445 </tr>
446 </table>
447 </div><div class="memdoc">
448 <p >Print the string and arguments given by format to the emulator debug message window</p>
449 <dl class="params"><dt>Parameters</dt><dd>
450 <table class="params">
451 <tr><td class="paramname">format</td><td>The format string as per printf</td></tr>
452 </table>
453 </dd>
454 </dl>
455 <p>Does not return the number of characters printed. Currently supported: </p><ul>
456 <li>%hx (char as hex) </li>
457 <li>%hu (unsigned char) </li>
458 <li>%hd (signed char) </li>
459 <li>%c (character) <br />
460 </li>
461 <li>%u (unsigned int) </li>
462 <li>%d (signed int) </li>
463 <li>%x (unsigned int as hex) </li>
464 <li>%s (string)</li>
465 </ul>
466 <dl class="section note"><dt>Note</dt><dd>Variables for the following 8-bit formats <b>MUST</b> be cast to their type when passed to <a class="el" href="gbdk_2emu__debug_8h.html#EMU_printf">EMU_printf()</a> <ul>
467 <li>%hx (char) </li>
468 <li>%hu (unsigned char) </li>
469 <li>%hd (signed char)</li>
470 </ul>
471 However variables for the following 8-bit format <b>MUST NOT</b> be cast to their type when passed to <a class="el" href="gbdk_2emu__debug_8h.html#EMU_printf">EMU_printf()</a> <ul>
472 <li>%c (char)</li>
473 </ul>
474 This behavior is <b>different</b> than for <a class="el" href="stdio_8h.html#sprintf">sprintf()</a>, which does require %c format char variables to be explicitly cast.</dd></dl>
475 <p>Currently supported in the Emulicious emulator, may be supported by bgb </p>
476
477 </div>
478 </div>
479 <a id="EMU_fmtbuf" name="EMU_fmtbuf"></a>
480 <h2 class="memtitle"><span class="permalink"><a href="#EMU_fmtbuf">◆ </a></span>EMU_fmtbuf()</h2>
481
482 <div class="memitem">
483 <div class="memproto">
484 <table class="memname">
485 <tr>
486 <td class="memname">void EMU_fmtbuf </td>
487 <td>(</td>
488 <td class="paramtype">const unsigned char * </td>
489 <td class="paramname"><em>format</em>, </td>
490 </tr>
491 <tr>
492 <td class="paramkey"></td>
493 <td></td>
494 <td class="paramtype">void * </td>
495 <td class="paramname"><em>data</em> </td>
496 </tr>
497 <tr>
498 <td></td>
499 <td>)</td>
500 <td></td><td></td>
501 </tr>
502 </table>
503 </div><div class="memdoc">
504 <p >Print the string and arguments in the buffer buffer by the pointer given by format to the emulator debug message window</p>
505 <dl class="params"><dt>Parameters</dt><dd>
506 <table class="params">
507 <tr><td class="paramname">format</td><td>The format string as per printf </td></tr>
508 <tr><td class="paramname">data</td><td>Buffer containing arguments, for example some struct</td></tr>
509 </table>
510 </dd>
511 </dl>
512 <dl class="section see"><dt>See also</dt><dd><a class="el" href="gbdk_2emu__debug_8h.html#EMU_printf">EMU_printf</a> for the format string description</dd></dl>
513 <p>Currently supported in the Emulicious emulator </p>
514
515 </div>
516 </div>
517 <h2 class="groupheader">Variable Documentation</h2>
518 <a id="b" name="b"></a>
519 <h2 class="memtitle"><span class="permalink"><a href="#b">◆ </a></span>b</h2>
520
521 <div class="memitem">
522 <div class="memproto">
523 <table class="memname">
524 <tr>
525 <td class="memname">void b</td>
526 </tr>
527 </table>
528 </div><div class="memdoc">
529
530 </div>
531 </div>
532 <a id="c" name="c"></a>
533 <h2 class="memtitle"><span class="permalink"><a href="#c">◆ </a></span>c</h2>
534
535 <div class="memitem">
536 <div class="memproto">
537 <table class="memname">
538 <tr>
539 <td class="memname">void c</td>
540 </tr>
541 </table>
542 </div><div class="memdoc">
543
544 </div>
545 </div>
546 </div><!-- contents -->
547 </div><!-- doc-content -->
548 <!-- start footer part -->
549 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
550 <ul>
551 <li class="navelem"><a class="el" href="dir_8bd3092e915ccc8a773a74e0a10d4d15.html">gbdk-lib</a></li><li class="navelem"><a class="el" href="dir_a9f896cff747ba031115e41245385c17.html">include</a></li><li class="navelem"><a class="el" href="dir_aedcfcf321a7f13aa34b51e3093299b2.html">gbdk</a></li><li class="navelem"><a class="el" href="gbdk_2emu__debug_8h.html">emu_debug.h</a></li>
552 <li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.2 </li>
553 </ul>
554 </div>
555 </body>
556 </html>
This webpage is intended to be an accessible preview of this repository. To get a fuller picture, clone it and use the git CLI.