mirror of
https://github.com/gbdk-2020/gbdk-2020.git
synced 2026-03-03 05:54:33 +01:00
639 lines
30 KiB
HTML
639 lines
30 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.2"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>GBDK 2020 Docs: gbdk-lib/include/gb/sgb.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
|
|
 <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&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&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&dn=expat.txt MIT */
|
|
$(document).ready(function(){initNavTree('sgb_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> |
|
|
<a href="#var-members">Variables</a> </div>
|
|
<div class="headertitle"><div class="title">sgb.h File Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="textblock"><code>#include <types.h></code><br />
|
|
<code>#include <<a class="el" href="stdint_8h_source.html">stdint.h</a>></code><br />
|
|
</div>
|
|
<p><a href="sgb_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:SGB_PAL_01"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="sgb_8h.html#SGB_PAL_01">SGB_PAL_01</a>   0x00U</td></tr>
|
|
<tr class="separator:SGB_PAL_01"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:SGB_PAL_23"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="sgb_8h.html#SGB_PAL_23">SGB_PAL_23</a>   0x01U</td></tr>
|
|
<tr class="separator:SGB_PAL_23"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:SGB_PAL_03"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="sgb_8h.html#SGB_PAL_03">SGB_PAL_03</a>   0x02U</td></tr>
|
|
<tr class="separator:SGB_PAL_03"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:SGB_PAL_12"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="sgb_8h.html#SGB_PAL_12">SGB_PAL_12</a>   0x03U</td></tr>
|
|
<tr class="separator:SGB_PAL_12"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:SGB_ATTR_BLK"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="sgb_8h.html#SGB_ATTR_BLK">SGB_ATTR_BLK</a>   0x04U</td></tr>
|
|
<tr class="separator:SGB_ATTR_BLK"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:SGB_ATTR_LIN"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="sgb_8h.html#SGB_ATTR_LIN">SGB_ATTR_LIN</a>   0x05U</td></tr>
|
|
<tr class="separator:SGB_ATTR_LIN"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:SGB_ATTR_DIV"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="sgb_8h.html#SGB_ATTR_DIV">SGB_ATTR_DIV</a>   0x06U</td></tr>
|
|
<tr class="separator:SGB_ATTR_DIV"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:SGB_ATTR_CHR"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="sgb_8h.html#SGB_ATTR_CHR">SGB_ATTR_CHR</a>   0x07U</td></tr>
|
|
<tr class="separator:SGB_ATTR_CHR"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:SGB_SOUND"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="sgb_8h.html#SGB_SOUND">SGB_SOUND</a>   0x08U</td></tr>
|
|
<tr class="separator:SGB_SOUND"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:SGB_SOU_TRN"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="sgb_8h.html#SGB_SOU_TRN">SGB_SOU_TRN</a>   0x09U</td></tr>
|
|
<tr class="separator:SGB_SOU_TRN"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:SGB_PAL_SET"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="sgb_8h.html#SGB_PAL_SET">SGB_PAL_SET</a>   0x0AU</td></tr>
|
|
<tr class="separator:SGB_PAL_SET"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:SGB_PAL_TRN"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="sgb_8h.html#SGB_PAL_TRN">SGB_PAL_TRN</a>   0x0BU</td></tr>
|
|
<tr class="separator:SGB_PAL_TRN"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:SGB_ATRC_EN"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="sgb_8h.html#SGB_ATRC_EN">SGB_ATRC_EN</a>   0x0CU</td></tr>
|
|
<tr class="separator:SGB_ATRC_EN"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:SGB_TEST_EN"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="sgb_8h.html#SGB_TEST_EN">SGB_TEST_EN</a>   0x0DU</td></tr>
|
|
<tr class="separator:SGB_TEST_EN"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:SGB_ICON_EN"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="sgb_8h.html#SGB_ICON_EN">SGB_ICON_EN</a>   0x0EU</td></tr>
|
|
<tr class="separator:SGB_ICON_EN"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:SGB_DATA_SND"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="sgb_8h.html#SGB_DATA_SND">SGB_DATA_SND</a>   0x0FU</td></tr>
|
|
<tr class="separator:SGB_DATA_SND"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:SGB_DATA_TRN"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="sgb_8h.html#SGB_DATA_TRN">SGB_DATA_TRN</a>   0x10U</td></tr>
|
|
<tr class="separator:SGB_DATA_TRN"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:SGB_MLT_REQ"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="sgb_8h.html#SGB_MLT_REQ">SGB_MLT_REQ</a>   0x11U</td></tr>
|
|
<tr class="separator:SGB_MLT_REQ"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:SGB_JUMP"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="sgb_8h.html#SGB_JUMP">SGB_JUMP</a>   0x12U</td></tr>
|
|
<tr class="separator:SGB_JUMP"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:SGB_CHR_TRN"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="sgb_8h.html#SGB_CHR_TRN">SGB_CHR_TRN</a>   0x13U</td></tr>
|
|
<tr class="separator:SGB_CHR_TRN"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:SGB_PCT_TRN"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="sgb_8h.html#SGB_PCT_TRN">SGB_PCT_TRN</a>   0x14U</td></tr>
|
|
<tr class="separator:SGB_PCT_TRN"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:SGB_ATTR_TRN"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="sgb_8h.html#SGB_ATTR_TRN">SGB_ATTR_TRN</a>   0x15U</td></tr>
|
|
<tr class="separator:SGB_ATTR_TRN"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:SGB_ATTR_SET"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="sgb_8h.html#SGB_ATTR_SET">SGB_ATTR_SET</a>   0x16U</td></tr>
|
|
<tr class="separator:SGB_ATTR_SET"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:SGB_MASK_EN"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="sgb_8h.html#SGB_MASK_EN">SGB_MASK_EN</a>   0x17U</td></tr>
|
|
<tr class="separator:SGB_MASK_EN"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:SGB_OBJ_TRN"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="sgb_8h.html#SGB_OBJ_TRN">SGB_OBJ_TRN</a>   0x18U</td></tr>
|
|
<tr class="separator:SGB_OBJ_TRN"><td class="memSeparator" colspan="2"> </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:sgb_check"><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="sgb_8h.html#sgb_check">sgb_check</a> (void) <a class="el" href="asm_2types_8h.html#OLDCALL">OLDCALL</a> <a class="el" href="asm_2types_8h.html#PRESERVES_REGS">PRESERVES_REGS</a>(<a class="el" href="sms_8h.html#b">b</a></td></tr>
|
|
<tr class="separator:sgb_check"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:sgb_transfer"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="sgb_8h.html#sgb_transfer">sgb_transfer</a> (<a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> *packet) <a class="el" href="asm_2types_8h.html#OLDCALL">OLDCALL</a> <a class="el" href="asm_2types_8h.html#PRESERVES_REGS">PRESERVES_REGS</a>(<a class="el" href="sms_8h.html#b">b</a></td></tr>
|
|
<tr class="separator:sgb_transfer"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="var-members" name="var-members"></a>
|
|
Variables</h2></td></tr>
|
|
<tr class="memitem:c"><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="sgb_8h.html#c">c</a></td></tr>
|
|
<tr class="separator:c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p >Super Gameboy definitions.</p>
|
|
<p >See the example SGB project for additional details. </p>
|
|
</div><h2 class="groupheader">Macro Definition Documentation</h2>
|
|
<a id="SGB_PAL_01" name="SGB_PAL_01"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#SGB_PAL_01">◆ </a></span>SGB_PAL_01</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define SGB_PAL_01   0x00U</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p >SGB Command: Set SGB Palettes 0 & 1 </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="SGB_PAL_23" name="SGB_PAL_23"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#SGB_PAL_23">◆ </a></span>SGB_PAL_23</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define SGB_PAL_23   0x01U</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p >SGB Command: Set SGB Palettes 2 & 3 </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="SGB_PAL_03" name="SGB_PAL_03"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#SGB_PAL_03">◆ </a></span>SGB_PAL_03</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define SGB_PAL_03   0x02U</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p >SGB Command: Set SGB Palettes 0 & 3 </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="SGB_PAL_12" name="SGB_PAL_12"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#SGB_PAL_12">◆ </a></span>SGB_PAL_12</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define SGB_PAL_12   0x03U</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p >SGB Command: Set SGB Palettes 1 & 2 </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="SGB_ATTR_BLK" name="SGB_ATTR_BLK"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#SGB_ATTR_BLK">◆ </a></span>SGB_ATTR_BLK</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define SGB_ATTR_BLK   0x04U</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p >SGB Command: Set color attributes for rectangular regions </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="SGB_ATTR_LIN" name="SGB_ATTR_LIN"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#SGB_ATTR_LIN">◆ </a></span>SGB_ATTR_LIN</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define SGB_ATTR_LIN   0x05U</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p >SGB Command: Set color attributes for horizontal or vertical character lines </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="SGB_ATTR_DIV" name="SGB_ATTR_DIV"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#SGB_ATTR_DIV">◆ </a></span>SGB_ATTR_DIV</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define SGB_ATTR_DIV   0x06U</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p >SGB Command: Split screen in half and assign separate color attribes to each side and the divider </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="SGB_ATTR_CHR" name="SGB_ATTR_CHR"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#SGB_ATTR_CHR">◆ </a></span>SGB_ATTR_CHR</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define SGB_ATTR_CHR   0x07U</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p >SGB Command: Set color attributes for separate charactersSet SGB Palette 0,1 Data </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="SGB_SOUND" name="SGB_SOUND"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#SGB_SOUND">◆ </a></span>SGB_SOUND</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define SGB_SOUND   0x08U</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p >SGB Command: Start and stop a internal sound effect, and sounds using internal tone data </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="SGB_SOU_TRN" name="SGB_SOU_TRN"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#SGB_SOU_TRN">◆ </a></span>SGB_SOU_TRN</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define SGB_SOU_TRN   0x09U</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p >SGB Command: Transfer sound code or data to the SNES APU RAM </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="SGB_PAL_SET" name="SGB_PAL_SET"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#SGB_PAL_SET">◆ </a></span>SGB_PAL_SET</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define SGB_PAL_SET   0x0AU</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p >SGB Command: Apply (previously transferred) SGB system color palettes to actual SNES palettes </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="SGB_PAL_TRN" name="SGB_PAL_TRN"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#SGB_PAL_TRN">◆ </a></span>SGB_PAL_TRN</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define SGB_PAL_TRN   0x0BU</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p >SGB Command: Transfer palette data into SGB system color palettes </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="SGB_ATRC_EN" name="SGB_ATRC_EN"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#SGB_ATRC_EN">◆ </a></span>SGB_ATRC_EN</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define SGB_ATRC_EN   0x0CU</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p >SGB Command: Enable/disable Attraction mode. It is enabled by default </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="SGB_TEST_EN" name="SGB_TEST_EN"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#SGB_TEST_EN">◆ </a></span>SGB_TEST_EN</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define SGB_TEST_EN   0x0DU</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p >SGB Command: Enable/disable test mode for "SGB-CPU variable clock speed function" </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="SGB_ICON_EN" name="SGB_ICON_EN"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#SGB_ICON_EN">◆ </a></span>SGB_ICON_EN</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define SGB_ICON_EN   0x0EU</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p >SGB Command: Enable/disable ICON functionality </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="SGB_DATA_SND" name="SGB_DATA_SND"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#SGB_DATA_SND">◆ </a></span>SGB_DATA_SND</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define SGB_DATA_SND   0x0FU</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p >SGB Command: Write one or more bytes into SNES Work RAM </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="SGB_DATA_TRN" name="SGB_DATA_TRN"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#SGB_DATA_TRN">◆ </a></span>SGB_DATA_TRN</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define SGB_DATA_TRN   0x10U</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p >SGB Command: Transfer code or data into SNES RAM </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="SGB_MLT_REQ" name="SGB_MLT_REQ"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#SGB_MLT_REQ">◆ </a></span>SGB_MLT_REQ</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define SGB_MLT_REQ   0x11U</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p >SGB Command: Request multiplayer mode (input from more than one joypad) </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="SGB_JUMP" name="SGB_JUMP"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#SGB_JUMP">◆ </a></span>SGB_JUMP</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define SGB_JUMP   0x12U</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p >SGB Command: Set the SNES program counter and NMI (vblank interrupt) handler to specific addresses </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="SGB_CHR_TRN" name="SGB_CHR_TRN"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#SGB_CHR_TRN">◆ </a></span>SGB_CHR_TRN</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define SGB_CHR_TRN   0x13U</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p >SGB Command: Transfer tile data (characters) to SNES Tile memory </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="SGB_PCT_TRN" name="SGB_PCT_TRN"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#SGB_PCT_TRN">◆ </a></span>SGB_PCT_TRN</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define SGB_PCT_TRN   0x14U</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p >SGB Command: Transfer tile map and palette data to SNES BG Map memory </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="SGB_ATTR_TRN" name="SGB_ATTR_TRN"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#SGB_ATTR_TRN">◆ </a></span>SGB_ATTR_TRN</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define SGB_ATTR_TRN   0x15U</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p >SGB Command: Transfer data to (color) Attribute Files (ATFs) in SNES RAM </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="SGB_ATTR_SET" name="SGB_ATTR_SET"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#SGB_ATTR_SET">◆ </a></span>SGB_ATTR_SET</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define SGB_ATTR_SET   0x16U</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p >SGB Command: Transfer attributes from (color) Attribute Files (ATF) to the Game Boy window </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="SGB_MASK_EN" name="SGB_MASK_EN"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#SGB_MASK_EN">◆ </a></span>SGB_MASK_EN</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define SGB_MASK_EN   0x17U</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p >SGB Command: Modify Game Boy window mask settings </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="SGB_OBJ_TRN" name="SGB_OBJ_TRN"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#SGB_OBJ_TRN">◆ </a></span>SGB_OBJ_TRN</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define SGB_OBJ_TRN   0x18U</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p >SGB Command: Transfer OBJ attributes to SNES OAM memory </p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a id="sgb_check" name="sgb_check"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#sgb_check">◆ </a></span>sgb_check()</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> sgb_check </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p >Returns a non-zero value if running on a Super GameBoy</p>
|
|
<p >Since <a class="el" href="sgb_8h.html#sgb_check">sgb_check()</a> uses <a class="el" href="sgb_8h.html#sgb_transfer">sgb_transfer()</a>, the same delay at startup requirement applies to ensure correct operation on PAL SNES. See <a class="el" href="sgb_8h.html#sgb_transfer">sgb_transfer()</a> for details. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="sgb_transfer" name="sgb_transfer"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#sgb_transfer">◆ </a></span>sgb_transfer()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void sgb_transfer </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> * </td>
|
|
<td class="paramname"><em>packet</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p >Transfer a SGB packet</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">packet</td><td>Pointer to buffer with SGB packet data.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>The first byte of <b>packet</b> should be a SGB command, then up to 15 bytes of command parameter data.</p>
|
|
<p >See the <code>sgb_border</code> GBDK example project for a demo of how to use these the sgb functions.</p>
|
|
<p >When using the SGB with a PAL SNES, a delay should be added just after program startup such as:</p>
|
|
<div class="fragment"><div class="line"><span class="comment">// Wait 4 frames</span></div>
|
|
<div class="line"><span class="comment">// For PAL SNES this delay is required on startup</span></div>
|
|
<div class="line"><span class="keywordflow">for</span> (<a class="code hl_typedef" href="stdint_8h.html#uint8_t">uint8_t</a> i = 4; i != 0; i--) <a class="code hl_function" href="gb_8h.html#wait_vbl_done">wait_vbl_done</a>();</div>
|
|
<div class="ttc" id="agb_8h_html_wait_vbl_done"><div class="ttname"><a href="gb_8h.html#wait_vbl_done">wait_vbl_done</a></div><div class="ttdeci">void wait_vbl_done(void) PRESERVES_REGS(b</div></div>
|
|
<div class="ttc" id="astdint_8h_html_uint8_t"><div class="ttname"><a href="stdint_8h.html#uint8_t">uint8_t</a></div><div class="ttdeci">unsigned char uint8_t</div><div class="ttdef"><b>Definition:</b> stdint.h:51</div></div>
|
|
</div><!-- fragment --><dl class="section see"><dt>See also</dt><dd><a class="el" href="sgb_8h.html#sgb_check">sgb_check()</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Variable Documentation</h2>
|
|
<a id="c" name="c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#c">◆ </a></span>c</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void c</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</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_bdfe001eb73b667f67d57fb851301eb1.html">gb</a></li><li class="navelem"><a class="el" href="sgb_8h.html">sgb.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>
|