gbdk-2020 | GameBoy Development Kit |
| download: https://git.y1.nz/archives/gbdk.tar.gz | |
| README | Files | Log | Refs | LICENSE |
docs/api/model_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/duck/model.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('model_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> </div>
105 <div class="headertitle"><div class="title">model.h File Reference</div></div>
106 </div><!--header-->
107 <div class="contents">
108 <div class="textblock"><code>#include <<a class="el" href="platform_8h_source.html">gbdk/platform.h</a>></code><br />
109 <code>#include <<a class="el" href="stdint_8h_source.html">stdint.h</a>></code><br />
110 </div>
111 <p><a href="model_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:MEGADUCK_HANDHELD_STANDARD"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="model_8h.html#MEGADUCK_HANDHELD_STANDARD">MEGADUCK_HANDHELD_STANDARD</a>   0u</td></tr>
116 <tr class="separator:MEGADUCK_HANDHELD_STANDARD"><td class="memSeparator" colspan="2"> </td></tr>
117 <tr class="memitem:MEGADUCK_LAPTOP_SPANISH"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="model_8h.html#MEGADUCK_LAPTOP_SPANISH">MEGADUCK_LAPTOP_SPANISH</a>   1u</td></tr>
118 <tr class="separator:MEGADUCK_LAPTOP_SPANISH"><td class="memSeparator" colspan="2"> </td></tr>
119 <tr class="memitem:MEGADUCK_LAPTOP_GERMAN"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="model_8h.html#MEGADUCK_LAPTOP_GERMAN">MEGADUCK_LAPTOP_GERMAN</a>   2u</td></tr>
120 <tr class="separator:MEGADUCK_LAPTOP_GERMAN"><td class="memSeparator" colspan="2"> </td></tr>
121 </table><table class="memberdecls">
122 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
123 Functions</h2></td></tr>
124 <tr class="memitem:duck_check_model"><td class="memItemLeft" align="right" valign="top"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="model_8h.html#duck_check_model">duck_check_model</a> (void)</td></tr>
125 <tr class="separator:duck_check_model"><td class="memSeparator" colspan="2"> </td></tr>
126 </table>
127 <h2 class="groupheader">Macro Definition Documentation</h2>
128 <a id="MEGADUCK_HANDHELD_STANDARD" name="MEGADUCK_HANDHELD_STANDARD"></a>
129 <h2 class="memtitle"><span class="permalink"><a href="#MEGADUCK_HANDHELD_STANDARD">◆ </a></span>MEGADUCK_HANDHELD_STANDARD</h2>
130
131 <div class="memitem">
132 <div class="memproto">
133 <table class="memname">
134 <tr>
135 <td class="memname">#define MEGADUCK_HANDHELD_STANDARD   0u</td>
136 </tr>
137 </table>
138 </div><div class="memdoc">
139
140 </div>
141 </div>
142 <a id="MEGADUCK_LAPTOP_SPANISH" name="MEGADUCK_LAPTOP_SPANISH"></a>
143 <h2 class="memtitle"><span class="permalink"><a href="#MEGADUCK_LAPTOP_SPANISH">◆ </a></span>MEGADUCK_LAPTOP_SPANISH</h2>
144
145 <div class="memitem">
146 <div class="memproto">
147 <table class="memname">
148 <tr>
149 <td class="memname">#define MEGADUCK_LAPTOP_SPANISH   1u</td>
150 </tr>
151 </table>
152 </div><div class="memdoc">
153
154 </div>
155 </div>
156 <a id="MEGADUCK_LAPTOP_GERMAN" name="MEGADUCK_LAPTOP_GERMAN"></a>
157 <h2 class="memtitle"><span class="permalink"><a href="#MEGADUCK_LAPTOP_GERMAN">◆ </a></span>MEGADUCK_LAPTOP_GERMAN</h2>
158
159 <div class="memitem">
160 <div class="memproto">
161 <table class="memname">
162 <tr>
163 <td class="memname">#define MEGADUCK_LAPTOP_GERMAN   2u</td>
164 </tr>
165 </table>
166 </div><div class="memdoc">
167
168 </div>
169 </div>
170 <h2 class="groupheader">Function Documentation</h2>
171 <a id="duck_check_model" name="duck_check_model"></a>
172 <h2 class="memtitle"><span class="permalink"><a href="#duck_check_model">◆ </a></span>duck_check_model()</h2>
173
174 <div class="memitem">
175 <div class="memproto">
176 <table class="memname">
177 <tr>
178 <td class="memname"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> duck_check_model </td>
179 <td>(</td>
180 <td class="paramtype">void </td>
181 <td class="paramname"></td><td>)</td>
182 <td></td>
183 </tr>
184 </table>
185 </div><div class="memdoc">
186 <p >Returns which MegaDuck Model the program is being run on</p>
187 <p >Possible models are:</p><ul>
188 <li>Handheld: <a class="el" href="model_8h.html#MEGADUCK_HANDHELD_STANDARD">MEGADUCK_HANDHELD_STANDARD</a></li>
189 <li>Spanish Laptop "Super QuiQue": <a class="el" href="model_8h.html#MEGADUCK_LAPTOP_SPANISH">MEGADUCK_LAPTOP_SPANISH</a></li>
190 <li>German Laptop "Super Junior Computer": <a class="el" href="model_8h.html#MEGADUCK_LAPTOP_GERMAN">MEGADUCK_LAPTOP_GERMAN</a></li>
191 </ul>
192 <p >This detection should be called immediately at the start of the program for most reliable results, since it relies on inspecting uncleared VRAM contents.</p>
193 <p >It works by checking for distinct font VRAM Tile Patterns (which aren't cleared before cart program launch) between the Spanish and German Laptop models which have slightly different character sets.</p>
194 <p >So VRAM <em>must not</em> be cleared or modified at program startup until after this function is called (not by the crt0.s, not by the program itself).</p>
195 <dl class="section note"><dt>Note</dt><dd>This detection may not work in emulators which don't simulate the preloaded Laptop System ROM font tiles in VRAM. </dd></dl>
196
197 </div>
198 </div>
199 </div><!-- contents -->
200 </div><!-- doc-content -->
201 <!-- start footer part -->
202 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
203 <ul>
204 <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_0a499b1b991479a5f341a18a1dd374d9.html">duck</a></li><li class="navelem"><a class="el" href="model_8h.html">model.h</a></li>
205 <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>
206 </ul>
207 </div>
208 </body>
209 </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.