mirror of
https://github.com/gbdk-2020/gbdk-2020.git
synced 2026-03-19 13:48:30 +01:00
195 lines
9.3 KiB
HTML
195 lines
9.3 KiB
HTML
<!-- HTML header for doxygen 1.8.14-->
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="cache-control" content="max-age=86400"/>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.9.1"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>GBDK 2020 Docs: gbdk-lib/include/duck/model.h File Reference</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
<link href="doxygen_extra.css" rel="stylesheet" type="text/css"/>
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">GBDK 2020 Docs
|
|
 <span id="projectnumber">4.4.0</span>
|
|
</div>
|
|
<div id="projectbrief">API Documentation for GBDK 2020</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.1 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */</script>
|
|
<div id="main-nav"></div>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(document).ready(function(){initNavTree('model_8h.html',''); initResizable(); });
|
|
/* @license-end */
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#define-members">Macros</a> |
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">model.h File Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="textblock"><code>#include <<a class="el" href="platform_8h_source.html">gbdk/platform.h</a>></code><br />
|
|
<code>#include <<a class="el" href="stdint_8h_source.html">stdint.h</a>></code><br />
|
|
</div>
|
|
<p><a href="model_8h_source.html">Go to the source code of this file.</a></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
|
|
Macros</h2></td></tr>
|
|
<tr class="memitem:a17aa6072b0ed07910a20367a0d580c3e"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="model_8h.html#a17aa6072b0ed07910a20367a0d580c3e">MEGADUCK_HANDHELD_STANDARD</a>   0u</td></tr>
|
|
<tr class="separator:a17aa6072b0ed07910a20367a0d580c3e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9c465633619c6444f66009fe87c79cde"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="model_8h.html#a9c465633619c6444f66009fe87c79cde">MEGADUCK_LAPTOP_SPANISH</a>   1u</td></tr>
|
|
<tr class="separator:a9c465633619c6444f66009fe87c79cde"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a956efa12b214b62a07f96b09d592d750"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="model_8h.html#a956efa12b214b62a07f96b09d592d750">MEGADUCK_LAPTOP_GERMAN</a>   2u</td></tr>
|
|
<tr class="separator:a956efa12b214b62a07f96b09d592d750"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr class="memitem:a18484d0d97a721a079ad06fc5de9b16b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="stdint_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="model_8h.html#a18484d0d97a721a079ad06fc5de9b16b">duck_check_model</a> (void)</td></tr>
|
|
<tr class="separator:a18484d0d97a721a079ad06fc5de9b16b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h2 class="groupheader">Macro Definition Documentation</h2>
|
|
<a id="a17aa6072b0ed07910a20367a0d580c3e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a17aa6072b0ed07910a20367a0d580c3e">◆ </a></span>MEGADUCK_HANDHELD_STANDARD</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define MEGADUCK_HANDHELD_STANDARD   0u</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9c465633619c6444f66009fe87c79cde"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9c465633619c6444f66009fe87c79cde">◆ </a></span>MEGADUCK_LAPTOP_SPANISH</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define MEGADUCK_LAPTOP_SPANISH   1u</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a956efa12b214b62a07f96b09d592d750"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a956efa12b214b62a07f96b09d592d750">◆ </a></span>MEGADUCK_LAPTOP_GERMAN</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define MEGADUCK_LAPTOP_GERMAN   2u</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a id="a18484d0d97a721a079ad06fc5de9b16b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a18484d0d97a721a079ad06fc5de9b16b">◆ </a></span>duck_check_model()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="stdint_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> duck_check_model </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Returns which MegaDuck Model the program is being run on</p>
|
|
<p>Possible models are:</p><ul>
|
|
<li>Handheld: <a class="el" href="model_8h.html#a17aa6072b0ed07910a20367a0d580c3e">MEGADUCK_HANDHELD_STANDARD</a></li>
|
|
<li>Spanish Laptop "Super QuiQue": <a class="el" href="model_8h.html#a9c465633619c6444f66009fe87c79cde">MEGADUCK_LAPTOP_SPANISH</a></li>
|
|
<li>German Laptop "Super Junior Computer": <a class="el" href="model_8h.html#a956efa12b214b62a07f96b09d592d750">MEGADUCK_LAPTOP_GERMAN</a></li>
|
|
</ul>
|
|
<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>
|
|
<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>
|
|
<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>
|
|
<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>
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- HTML footer for doxygen 1.8.14-->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
</div>
|
|
</body>
|
|
</html>
|