index.html (7573B)
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.8.20"/> 9<meta name="viewport" content="width=device-width, initial-scale=1"/> 10<title>GBDK 2020 Docs: General Documentation</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_extra.css" rel="stylesheet" type="text/css"/> 23</head> 24<body> 25<div id="top"><!-- do not remove this div, it is closed by doxygen! --> 26<div id="titlearea"> 27<table cellspacing="0" cellpadding="0"> 28 <tbody> 29 <tr style="height: 56px;"> 30 <td id="projectalign" style="padding-left: 0.5em;"> 31 <div id="projectname">GBDK 2020 Docs 32  <span id="projectnumber">4.0.6</span> 33 </div> 34 <div id="projectbrief">API Documentation for GBDK 2020</div> 35 </td> 36 </tr> 37 </tbody> 38</table> 39</div> 40<!-- end header part --> 41<!-- Generated by Doxygen 1.8.20 --> 42<script type="text/javascript"> 43/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ 44var searchBox = new SearchBox("searchBox", "search",false,'Search'); 45/* @license-end */ 46</script> 47<script type="text/javascript" src="menudata.js"></script> 48<script type="text/javascript" src="menu.js"></script> 49<script type="text/javascript"> 50/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ 51$(function() { 52 initMenu('',true,false,'search.php','Search'); 53 $(document).ready(function() { init_search(); }); 54}); 55/* @license-end */</script> 56<div id="main-nav"></div> 57</div><!-- top --> 58<div id="side-nav" class="ui-resizable side-nav-resizable"> 59 <div id="nav-tree"> 60 <div id="nav-tree-contents"> 61 <div id="nav-sync" class="sync"></div> 62 </div> 63 </div> 64 <div id="splitbar" style="-moz-user-select:none;" 65 class="ui-resizable-handle"> 66 </div> 67</div> 68<script type="text/javascript"> 69/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ 70$(document).ready(function(){initNavTree('index.html',''); initResizable(); }); 71/* @license-end */ 72</script> 73<div id="doc-content"> 74<!-- window showing the filter options --> 75<div id="MSearchSelectWindow" 76 onmouseover="return searchBox.OnSearchSelectShow()" 77 onmouseout="return searchBox.OnSearchSelectHide()" 78 onkeydown="return searchBox.OnSearchSelectKey(event)"> 79</div> 80 81<!-- iframe showing the search results (closed by default) --> 82<div id="MSearchResultsWindow"> 83<iframe src="javascript:void(0)" frameborder="0" 84 name="MSearchResults" id="MSearchResults"> 85</iframe> 86</div> 87 88<div class="PageDoc"><div class="header"> 89 <div class="headertitle"> 90<div class="title">General Documentation </div> </div> 91</div><!--header--> 92<div class="contents"> 93<div class="textblock"><p><a class="anchor" id="docs_index"></a></p><ul> 94<li><a class="el" href="docs_getting_started.html">Getting Started</a></li> 95<li><a class="el" href="docs_links_and_tools.html">Links and Third-Party Tools</a></li> 96<li><a class="el" href="docs_using_gbdk.html">Using GBDK</a></li> 97<li><a class="el" href="docs_coding_guidelines.html">Coding Guidelines</a></li> 98<li><a class="el" href="docs_rombanking_mbcs.html">ROM/RAM Banking and MBCs</a></li> 99<li><a class="el" href="docs_supported_consoles.html">Supported Consoles & Cross Compiling</a></li> 100<li><a class="el" href="docs_toolchain.html">GBDK Toolchain</a></li> 101<li><a class="el" href="docs_example_programs.html">Example Programs</a></li> 102<li><a class="el" href="docs_faq.html">Frequently Asked Questions (FAQ)</a></li> 103<li><a class="el" href="docs_migrating_versions.html">Migrating to new GBDK Versions</a></li> 104<li><a class="el" href="docs_releases.html">GBDK Releases</a></li> 105<li><a class="el" href="docs_toolchain_settings.html">Toolchain settings</a></li> 106</ul> 107<h1><a class="anchor" id="autotoc_md217"></a> 108Introduction</h1> 109<p>Welcome to GBDK-2020! The best thing to do is head over to the <a class="el" href="docs_getting_started.html">Getting Started</a> section to get up and running.</p> 110<h1><a class="anchor" id="autotoc_md218"></a> 111About the Documentation</h1> 112<p>This documentation is partially based on material written by the original GBDK authors in 1999 and updated for GBDK-2020. The API docs are automatically generated from the C header files using Doxygen.</p> 113<p>GBDK-2020 is an updated version of the original GBDK with a modernized SDCC toolchain and many API improvements and fixes. It can be found at: <a href="https://github.com/gbdk-2020/gbdk-2020/">https://github.com/gbdk-2020/gbdk-2020/</a>.</p> 114<p>The original GBDK sources, documentation and website are at: <a href="http://gbdk.sourceforge.net/">http://gbdk.sourceforge.net/</a></p> 115<h1><a class="anchor" id="autotoc_md219"></a> 116About GBDK</h1> 117<p>The GameBoy Developer's Kit (GBDK, GBDK-2020) is used to develop games and programs for the Nintendo Game Boy (and some other consoles) in C and assembly. GBDK includes a set of libraries for the most common requirements and generates image files for use with a real GameBoy or emulators.</p> 118<p>GBDK features:</p><ul> 119<li>C and ASM toolchain based on SDCC with some support utilities</li> 120<li>A set of libraries with source code</li> 121<li>Example programs in ASM and in C</li> 122<li>Support for multiple ROM bank images and auto-banking</li> 123<li>Support for multiple consoles: Game Boy, Analogue Pocket, Mega Duck, Master System and Game Gear</li> 124</ul> 125<p>GBDK is freeware. Most of the tooling code is under the GPL. The runtime libraries should be under the LGPL. Please consider mentioning GBDK in the credits of projects made with it.</p> 126<hr /> 127<h1><a class="anchor" id="autotoc_md220"></a> 128Historical Info and Links</h1> 129<p>Work on the original GBDK (pre-2020) was by:</p> 130<p>Pascal Felber, Lars Malmborg, Michael Hope, David Galloway (djmips), and others.</p> 131<p>The following is from the original GBDK documentation:</p> 132<p>Thanks to quang for many of the comments to the gb functions. Some of the comments are ripped directly from the Linux Programmers manual, and some directly from the pan/k00Pa document.</p> 133<p><a href="http://quangdx.com/">quangDX.com</a></p> 134<p><a href="http://gbdk.sourceforge.net/">The (original) gbdk homepage</a></p> 135<p><a href="http://www.devrs.com/gb/">Jeff Frohwein's GB development page.</a> A extensive source of Game Boy related information, including GeeBee's GB faq and the pan/k00Pa document. </p> 136</div></div><!-- PageDoc --> 137</div><!-- contents --> 138</div><!-- doc-content --> 139<!-- HTML footer for doxygen 1.8.14--> 140<!-- start footer part --> 141<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> 142</div> 143</body> 144</html>