Mirrors/gbdk-2020
2
0
Fork 0
mirror of https://github.com/gbdk-2020/gbdk-2020.git synced 2026-02-20 08:42:16 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
develop
gbdk-2020/docs/api/model_8h.html
bbbbbr a5bff5a9e8 Docs: 4.5.0: Regenerate content
2025-12-27 17:53:11 -08:00

210 lines
10 KiB
HTML
Raw Permalink Blame History

<!-- 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.2"/>
<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-awesome.css" rel="stylesheet" type="text/css"/>
<link href="doxygen-awesome-sidebar-only.css" rel="stylesheet" type="text/css"/>
<link href="doxygen-awesome-sidebar-only-darkmode-toggle.css" rel="stylesheet" type="text/css"/>
<!-- BEGIN: doxygen-awesome-css -->
<script type="text/javascript" src="doxygen-awesome-darkmode-toggle.js"></script>
<script type="text/javascript">
DoxygenAwesomeDarkModeToggle.init()
</script>
<script type="text/javascript" src="doxygen-awesome-paragraph-link.js"></script>
<script type="text/javascript">
DoxygenAwesomeParagraphLink.init()
</script>
<!-- END: doxygen-awesome-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
&#160;<span id="projectnumber">4.5.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.2 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(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> &#124;
<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 &lt;<a class="el" href="platform_8h_source.html">gbdk/platform.h</a>&gt;</code><br />
<code>#include &lt;<a class="el" href="stdint_8h_source.html">stdint.h</a>&gt;</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 id="define-members" name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:MEGADUCK_HANDHELD_STANDARD"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="model_8h.html#MEGADUCK_HANDHELD_STANDARD">MEGADUCK_HANDHELD_STANDARD</a>&#160;&#160;&#160;0u</td></tr>
<tr class="separator:MEGADUCK_HANDHELD_STANDARD"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:MEGADUCK_LAPTOP_SPANISH"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="model_8h.html#MEGADUCK_LAPTOP_SPANISH">MEGADUCK_LAPTOP_SPANISH</a>&#160;&#160;&#160;1u</td></tr>
<tr class="separator:MEGADUCK_LAPTOP_SPANISH"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:MEGADUCK_LAPTOP_GERMAN"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="model_8h.html#MEGADUCK_LAPTOP_GERMAN">MEGADUCK_LAPTOP_GERMAN</a>&#160;&#160;&#160;2u</td></tr>
<tr class="separator:MEGADUCK_LAPTOP_GERMAN"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<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>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="model_8h.html#duck_check_model">duck_check_model</a> (void)</td></tr>
<tr class="separator:duck_check_model"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="MEGADUCK_HANDHELD_STANDARD" name="MEGADUCK_HANDHELD_STANDARD"></a>
<h2 class="memtitle"><span class="permalink"><a href="#MEGADUCK_HANDHELD_STANDARD">&#9670;&nbsp;</a></span>MEGADUCK_HANDHELD_STANDARD</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MEGADUCK_HANDHELD_STANDARD&#160;&#160;&#160;0u</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="MEGADUCK_LAPTOP_SPANISH" name="MEGADUCK_LAPTOP_SPANISH"></a>
<h2 class="memtitle"><span class="permalink"><a href="#MEGADUCK_LAPTOP_SPANISH">&#9670;&nbsp;</a></span>MEGADUCK_LAPTOP_SPANISH</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MEGADUCK_LAPTOP_SPANISH&#160;&#160;&#160;1u</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="MEGADUCK_LAPTOP_GERMAN" name="MEGADUCK_LAPTOP_GERMAN"></a>
<h2 class="memtitle"><span class="permalink"><a href="#MEGADUCK_LAPTOP_GERMAN">&#9670;&nbsp;</a></span>MEGADUCK_LAPTOP_GERMAN</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MEGADUCK_LAPTOP_GERMAN&#160;&#160;&#160;2u</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="duck_check_model" name="duck_check_model"></a>
<h2 class="memtitle"><span class="permalink"><a href="#duck_check_model">&#9670;&nbsp;</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#uint8_t">uint8_t</a> duck_check_model </td>
<td>(</td>
<td class="paramtype">void&#160;</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#MEGADUCK_HANDHELD_STANDARD">MEGADUCK_HANDHELD_STANDARD</a></li>
<li>Spanish Laptop "Super QuiQue": <a class="el" href="model_8h.html#MEGADUCK_LAPTOP_SPANISH">MEGADUCK_LAPTOP_SPANISH</a></li>
<li>German Laptop "Super Junior Computer": <a class="el" href="model_8h.html#MEGADUCK_LAPTOP_GERMAN">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 -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<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>
<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>
</ul>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink