gbdk-2020 | GameBoy Development Kit |
| download: https://git.y1.nz/archives/gbdk.tar.gz | |
| README | Files | Log | Refs | LICENSE |
docs/api/sgb_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/gb/sgb.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('sgb_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> |
105 <a href="#var-members">Variables</a> </div>
106 <div class="headertitle"><div class="title">sgb.h File Reference</div></div>
107 </div><!--header-->
108 <div class="contents">
109 <div class="textblock"><code>#include <types.h></code><br />
110 <code>#include <<a class="el" href="stdint_8h_source.html">stdint.h</a>></code><br />
111 </div>
112 <p><a href="sgb_8h_source.html">Go to the source code of this file.</a></p>
113 <table class="memberdecls">
114 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
115 Macros</h2></td></tr>
116 <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>
117 <tr class="separator:SGB_PAL_01"><td class="memSeparator" colspan="2"> </td></tr>
118 <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>
119 <tr class="separator:SGB_PAL_23"><td class="memSeparator" colspan="2"> </td></tr>
120 <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>
121 <tr class="separator:SGB_PAL_03"><td class="memSeparator" colspan="2"> </td></tr>
122 <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>
123 <tr class="separator:SGB_PAL_12"><td class="memSeparator" colspan="2"> </td></tr>
124 <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>
125 <tr class="separator:SGB_ATTR_BLK"><td class="memSeparator" colspan="2"> </td></tr>
126 <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>
127 <tr class="separator:SGB_ATTR_LIN"><td class="memSeparator" colspan="2"> </td></tr>
128 <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>
129 <tr class="separator:SGB_ATTR_DIV"><td class="memSeparator" colspan="2"> </td></tr>
130 <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>
131 <tr class="separator:SGB_ATTR_CHR"><td class="memSeparator" colspan="2"> </td></tr>
132 <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>
133 <tr class="separator:SGB_SOUND"><td class="memSeparator" colspan="2"> </td></tr>
134 <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>
135 <tr class="separator:SGB_SOU_TRN"><td class="memSeparator" colspan="2"> </td></tr>
136 <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>
137 <tr class="separator:SGB_PAL_SET"><td class="memSeparator" colspan="2"> </td></tr>
138 <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>
139 <tr class="separator:SGB_PAL_TRN"><td class="memSeparator" colspan="2"> </td></tr>
140 <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>
141 <tr class="separator:SGB_ATRC_EN"><td class="memSeparator" colspan="2"> </td></tr>
142 <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>
143 <tr class="separator:SGB_TEST_EN"><td class="memSeparator" colspan="2"> </td></tr>
144 <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>
145 <tr class="separator:SGB_ICON_EN"><td class="memSeparator" colspan="2"> </td></tr>
146 <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>
147 <tr class="separator:SGB_DATA_SND"><td class="memSeparator" colspan="2"> </td></tr>
148 <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>
149 <tr class="separator:SGB_DATA_TRN"><td class="memSeparator" colspan="2"> </td></tr>
150 <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>
151 <tr class="separator:SGB_MLT_REQ"><td class="memSeparator" colspan="2"> </td></tr>
152 <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>
153 <tr class="separator:SGB_JUMP"><td class="memSeparator" colspan="2"> </td></tr>
154 <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>
155 <tr class="separator:SGB_CHR_TRN"><td class="memSeparator" colspan="2"> </td></tr>
156 <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>
157 <tr class="separator:SGB_PCT_TRN"><td class="memSeparator" colspan="2"> </td></tr>
158 <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>
159 <tr class="separator:SGB_ATTR_TRN"><td class="memSeparator" colspan="2"> </td></tr>
160 <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>
161 <tr class="separator:SGB_ATTR_SET"><td class="memSeparator" colspan="2"> </td></tr>
162 <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>
163 <tr class="separator:SGB_MASK_EN"><td class="memSeparator" colspan="2"> </td></tr>
164 <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>
165 <tr class="separator:SGB_OBJ_TRN"><td class="memSeparator" colspan="2"> </td></tr>
166 </table><table class="memberdecls">
167 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
168 Functions</h2></td></tr>
169 <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>
170 <tr class="separator:sgb_check"><td class="memSeparator" colspan="2"> </td></tr>
171 <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>
172 <tr class="separator:sgb_transfer"><td class="memSeparator" colspan="2"> </td></tr>
173 </table><table class="memberdecls">
174 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="var-members" name="var-members"></a>
175 Variables</h2></td></tr>
176 <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>
177 <tr class="separator:c"><td class="memSeparator" colspan="2"> </td></tr>
178 </table>
179 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
180 <div class="textblock"><p >Super Gameboy definitions.</p>
181 <p >See the example SGB project for additional details. </p>
182 </div><h2 class="groupheader">Macro Definition Documentation</h2>
183 <a id="SGB_PAL_01" name="SGB_PAL_01"></a>
184 <h2 class="memtitle"><span class="permalink"><a href="#SGB_PAL_01">◆ </a></span>SGB_PAL_01</h2>
185
186 <div class="memitem">
187 <div class="memproto">
188 <table class="memname">
189 <tr>
190 <td class="memname">#define SGB_PAL_01   0x00U</td>
191 </tr>
192 </table>
193 </div><div class="memdoc">
194 <p >SGB Command: Set SGB Palettes 0 & 1 </p>
195
196 </div>
197 </div>
198 <a id="SGB_PAL_23" name="SGB_PAL_23"></a>
199 <h2 class="memtitle"><span class="permalink"><a href="#SGB_PAL_23">◆ </a></span>SGB_PAL_23</h2>
200
201 <div class="memitem">
202 <div class="memproto">
203 <table class="memname">
204 <tr>
205 <td class="memname">#define SGB_PAL_23   0x01U</td>
206 </tr>
207 </table>
208 </div><div class="memdoc">
209 <p >SGB Command: Set SGB Palettes 2 & 3 </p>
210
211 </div>
212 </div>
213 <a id="SGB_PAL_03" name="SGB_PAL_03"></a>
214 <h2 class="memtitle"><span class="permalink"><a href="#SGB_PAL_03">◆ </a></span>SGB_PAL_03</h2>
215
216 <div class="memitem">
217 <div class="memproto">
218 <table class="memname">
219 <tr>
220 <td class="memname">#define SGB_PAL_03   0x02U</td>
221 </tr>
222 </table>
223 </div><div class="memdoc">
224 <p >SGB Command: Set SGB Palettes 0 & 3 </p>
225
226 </div>
227 </div>
228 <a id="SGB_PAL_12" name="SGB_PAL_12"></a>
229 <h2 class="memtitle"><span class="permalink"><a href="#SGB_PAL_12">◆ </a></span>SGB_PAL_12</h2>
230
231 <div class="memitem">
232 <div class="memproto">
233 <table class="memname">
234 <tr>
235 <td class="memname">#define SGB_PAL_12   0x03U</td>
236 </tr>
237 </table>
238 </div><div class="memdoc">
239 <p >SGB Command: Set SGB Palettes 1 & 2 </p>
240
241 </div>
242 </div>
243 <a id="SGB_ATTR_BLK" name="SGB_ATTR_BLK"></a>
244 <h2 class="memtitle"><span class="permalink"><a href="#SGB_ATTR_BLK">◆ </a></span>SGB_ATTR_BLK</h2>
245
246 <div class="memitem">
247 <div class="memproto">
248 <table class="memname">
249 <tr>
250 <td class="memname">#define SGB_ATTR_BLK   0x04U</td>
251 </tr>
252 </table>
253 </div><div class="memdoc">
254 <p >SGB Command: Set color attributes for rectangular regions </p>
255
256 </div>
257 </div>
258 <a id="SGB_ATTR_LIN" name="SGB_ATTR_LIN"></a>
259 <h2 class="memtitle"><span class="permalink"><a href="#SGB_ATTR_LIN">◆ </a></span>SGB_ATTR_LIN</h2>
260
261 <div class="memitem">
262 <div class="memproto">
263 <table class="memname">
264 <tr>
265 <td class="memname">#define SGB_ATTR_LIN   0x05U</td>
266 </tr>
267 </table>
268 </div><div class="memdoc">
269 <p >SGB Command: Set color attributes for horizontal or vertical character lines </p>
270
271 </div>
272 </div>
273 <a id="SGB_ATTR_DIV" name="SGB_ATTR_DIV"></a>
274 <h2 class="memtitle"><span class="permalink"><a href="#SGB_ATTR_DIV">◆ </a></span>SGB_ATTR_DIV</h2>
275
276 <div class="memitem">
277 <div class="memproto">
278 <table class="memname">
279 <tr>
280 <td class="memname">#define SGB_ATTR_DIV   0x06U</td>
281 </tr>
282 </table>
283 </div><div class="memdoc">
284 <p >SGB Command: Split screen in half and assign separate color attribes to each side and the divider </p>
285
286 </div>
287 </div>
288 <a id="SGB_ATTR_CHR" name="SGB_ATTR_CHR"></a>
289 <h2 class="memtitle"><span class="permalink"><a href="#SGB_ATTR_CHR">◆ </a></span>SGB_ATTR_CHR</h2>
290
291 <div class="memitem">
292 <div class="memproto">
293 <table class="memname">
294 <tr>
295 <td class="memname">#define SGB_ATTR_CHR   0x07U</td>
296 </tr>
297 </table>
298 </div><div class="memdoc">
299 <p >SGB Command: Set color attributes for separate charactersSet SGB Palette 0,1 Data </p>
300
301 </div>
302 </div>
303 <a id="SGB_SOUND" name="SGB_SOUND"></a>
304 <h2 class="memtitle"><span class="permalink"><a href="#SGB_SOUND">◆ </a></span>SGB_SOUND</h2>
305
306 <div class="memitem">
307 <div class="memproto">
308 <table class="memname">
309 <tr>
310 <td class="memname">#define SGB_SOUND   0x08U</td>
311 </tr>
312 </table>
313 </div><div class="memdoc">
314 <p >SGB Command: Start and stop a internal sound effect, and sounds using internal tone data </p>
315
316 </div>
317 </div>
318 <a id="SGB_SOU_TRN" name="SGB_SOU_TRN"></a>
319 <h2 class="memtitle"><span class="permalink"><a href="#SGB_SOU_TRN">◆ </a></span>SGB_SOU_TRN</h2>
320
321 <div class="memitem">
322 <div class="memproto">
323 <table class="memname">
324 <tr>
325 <td class="memname">#define SGB_SOU_TRN   0x09U</td>
326 </tr>
327 </table>
328 </div><div class="memdoc">
329 <p >SGB Command: Transfer sound code or data to the SNES APU RAM </p>
330
331 </div>
332 </div>
333 <a id="SGB_PAL_SET" name="SGB_PAL_SET"></a>
334 <h2 class="memtitle"><span class="permalink"><a href="#SGB_PAL_SET">◆ </a></span>SGB_PAL_SET</h2>
335
336 <div class="memitem">
337 <div class="memproto">
338 <table class="memname">
339 <tr>
340 <td class="memname">#define SGB_PAL_SET   0x0AU</td>
341 </tr>
342 </table>
343 </div><div class="memdoc">
344 <p >SGB Command: Apply (previously transferred) SGB system color palettes to actual SNES palettes </p>
345
346 </div>
347 </div>
348 <a id="SGB_PAL_TRN" name="SGB_PAL_TRN"></a>
349 <h2 class="memtitle"><span class="permalink"><a href="#SGB_PAL_TRN">◆ </a></span>SGB_PAL_TRN</h2>
350
351 <div class="memitem">
352 <div class="memproto">
353 <table class="memname">
354 <tr>
355 <td class="memname">#define SGB_PAL_TRN   0x0BU</td>
356 </tr>
357 </table>
358 </div><div class="memdoc">
359 <p >SGB Command: Transfer palette data into SGB system color palettes </p>
360
361 </div>
362 </div>
363 <a id="SGB_ATRC_EN" name="SGB_ATRC_EN"></a>
364 <h2 class="memtitle"><span class="permalink"><a href="#SGB_ATRC_EN">◆ </a></span>SGB_ATRC_EN</h2>
365
366 <div class="memitem">
367 <div class="memproto">
368 <table class="memname">
369 <tr>
370 <td class="memname">#define SGB_ATRC_EN   0x0CU</td>
371 </tr>
372 </table>
373 </div><div class="memdoc">
374 <p >SGB Command: Enable/disable Attraction mode. It is enabled by default </p>
375
376 </div>
377 </div>
378 <a id="SGB_TEST_EN" name="SGB_TEST_EN"></a>
379 <h2 class="memtitle"><span class="permalink"><a href="#SGB_TEST_EN">◆ </a></span>SGB_TEST_EN</h2>
380
381 <div class="memitem">
382 <div class="memproto">
383 <table class="memname">
384 <tr>
385 <td class="memname">#define SGB_TEST_EN   0x0DU</td>
386 </tr>
387 </table>
388 </div><div class="memdoc">
389 <p >SGB Command: Enable/disable test mode for "SGB-CPU variable clock speed function" </p>
390
391 </div>
392 </div>
393 <a id="SGB_ICON_EN" name="SGB_ICON_EN"></a>
394 <h2 class="memtitle"><span class="permalink"><a href="#SGB_ICON_EN">◆ </a></span>SGB_ICON_EN</h2>
395
396 <div class="memitem">
397 <div class="memproto">
398 <table class="memname">
399 <tr>
400 <td class="memname">#define SGB_ICON_EN   0x0EU</td>
401 </tr>
402 </table>
403 </div><div class="memdoc">
404 <p >SGB Command: Enable/disable ICON functionality </p>
405
406 </div>
407 </div>
408 <a id="SGB_DATA_SND" name="SGB_DATA_SND"></a>
409 <h2 class="memtitle"><span class="permalink"><a href="#SGB_DATA_SND">◆ </a></span>SGB_DATA_SND</h2>
410
411 <div class="memitem">
412 <div class="memproto">
413 <table class="memname">
414 <tr>
415 <td class="memname">#define SGB_DATA_SND   0x0FU</td>
416 </tr>
417 </table>
418 </div><div class="memdoc">
419 <p >SGB Command: Write one or more bytes into SNES Work RAM </p>
420
421 </div>
422 </div>
423 <a id="SGB_DATA_TRN" name="SGB_DATA_TRN"></a>
424 <h2 class="memtitle"><span class="permalink"><a href="#SGB_DATA_TRN">◆ </a></span>SGB_DATA_TRN</h2>
425
426 <div class="memitem">
427 <div class="memproto">
428 <table class="memname">
429 <tr>
430 <td class="memname">#define SGB_DATA_TRN   0x10U</td>
431 </tr>
432 </table>
433 </div><div class="memdoc">
434 <p >SGB Command: Transfer code or data into SNES RAM </p>
435
436 </div>
437 </div>
438 <a id="SGB_MLT_REQ" name="SGB_MLT_REQ"></a>
439 <h2 class="memtitle"><span class="permalink"><a href="#SGB_MLT_REQ">◆ </a></span>SGB_MLT_REQ</h2>
440
441 <div class="memitem">
442 <div class="memproto">
443 <table class="memname">
444 <tr>
445 <td class="memname">#define SGB_MLT_REQ   0x11U</td>
446 </tr>
447 </table>
448 </div><div class="memdoc">
449 <p >SGB Command: Request multiplayer mode (input from more than one joypad) </p>
450
451 </div>
452 </div>
453 <a id="SGB_JUMP" name="SGB_JUMP"></a>
454 <h2 class="memtitle"><span class="permalink"><a href="#SGB_JUMP">◆ </a></span>SGB_JUMP</h2>
455
456 <div class="memitem">
457 <div class="memproto">
458 <table class="memname">
459 <tr>
460 <td class="memname">#define SGB_JUMP   0x12U</td>
461 </tr>
462 </table>
463 </div><div class="memdoc">
464 <p >SGB Command: Set the SNES program counter and NMI (vblank interrupt) handler to specific addresses </p>
465
466 </div>
467 </div>
468 <a id="SGB_CHR_TRN" name="SGB_CHR_TRN"></a>
469 <h2 class="memtitle"><span class="permalink"><a href="#SGB_CHR_TRN">◆ </a></span>SGB_CHR_TRN</h2>
470
471 <div class="memitem">
472 <div class="memproto">
473 <table class="memname">
474 <tr>
475 <td class="memname">#define SGB_CHR_TRN   0x13U</td>
476 </tr>
477 </table>
478 </div><div class="memdoc">
479 <p >SGB Command: Transfer tile data (characters) to SNES Tile memory </p>
480
481 </div>
482 </div>
483 <a id="SGB_PCT_TRN" name="SGB_PCT_TRN"></a>
484 <h2 class="memtitle"><span class="permalink"><a href="#SGB_PCT_TRN">◆ </a></span>SGB_PCT_TRN</h2>
485
486 <div class="memitem">
487 <div class="memproto">
488 <table class="memname">
489 <tr>
490 <td class="memname">#define SGB_PCT_TRN   0x14U</td>
491 </tr>
492 </table>
493 </div><div class="memdoc">
494 <p >SGB Command: Transfer tile map and palette data to SNES BG Map memory </p>
495
496 </div>
497 </div>
498 <a id="SGB_ATTR_TRN" name="SGB_ATTR_TRN"></a>
499 <h2 class="memtitle"><span class="permalink"><a href="#SGB_ATTR_TRN">◆ </a></span>SGB_ATTR_TRN</h2>
500
501 <div class="memitem">
502 <div class="memproto">
503 <table class="memname">
504 <tr>
505 <td class="memname">#define SGB_ATTR_TRN   0x15U</td>
506 </tr>
507 </table>
508 </div><div class="memdoc">
509 <p >SGB Command: Transfer data to (color) Attribute Files (ATFs) in SNES RAM </p>
510
511 </div>
512 </div>
513 <a id="SGB_ATTR_SET" name="SGB_ATTR_SET"></a>
514 <h2 class="memtitle"><span class="permalink"><a href="#SGB_ATTR_SET">◆ </a></span>SGB_ATTR_SET</h2>
515
516 <div class="memitem">
517 <div class="memproto">
518 <table class="memname">
519 <tr>
520 <td class="memname">#define SGB_ATTR_SET   0x16U</td>
521 </tr>
522 </table>
523 </div><div class="memdoc">
524 <p >SGB Command: Transfer attributes from (color) Attribute Files (ATF) to the Game Boy window </p>
525
526 </div>
527 </div>
528 <a id="SGB_MASK_EN" name="SGB_MASK_EN"></a>
529 <h2 class="memtitle"><span class="permalink"><a href="#SGB_MASK_EN">◆ </a></span>SGB_MASK_EN</h2>
530
531 <div class="memitem">
532 <div class="memproto">
533 <table class="memname">
534 <tr>
535 <td class="memname">#define SGB_MASK_EN   0x17U</td>
536 </tr>
537 </table>
538 </div><div class="memdoc">
539 <p >SGB Command: Modify Game Boy window mask settings </p>
540
541 </div>
542 </div>
543 <a id="SGB_OBJ_TRN" name="SGB_OBJ_TRN"></a>
544 <h2 class="memtitle"><span class="permalink"><a href="#SGB_OBJ_TRN">◆ </a></span>SGB_OBJ_TRN</h2>
545
546 <div class="memitem">
547 <div class="memproto">
548 <table class="memname">
549 <tr>
550 <td class="memname">#define SGB_OBJ_TRN   0x18U</td>
551 </tr>
552 </table>
553 </div><div class="memdoc">
554 <p >SGB Command: Transfer OBJ attributes to SNES OAM memory </p>
555
556 </div>
557 </div>
558 <h2 class="groupheader">Function Documentation</h2>
559 <a id="sgb_check" name="sgb_check"></a>
560 <h2 class="memtitle"><span class="permalink"><a href="#sgb_check">◆ </a></span>sgb_check()</h2>
561
562 <div class="memitem">
563 <div class="memproto">
564 <table class="memname">
565 <tr>
566 <td class="memname"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> sgb_check </td>
567 <td>(</td>
568 <td class="paramtype">void </td>
569 <td class="paramname"></td><td>)</td>
570 <td></td>
571 </tr>
572 </table>
573 </div><div class="memdoc">
574 <p >Returns a non-zero value if running on a Super GameBoy</p>
575 <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>
576
577 </div>
578 </div>
579 <a id="sgb_transfer" name="sgb_transfer"></a>
580 <h2 class="memtitle"><span class="permalink"><a href="#sgb_transfer">◆ </a></span>sgb_transfer()</h2>
581
582 <div class="memitem">
583 <div class="memproto">
584 <table class="memname">
585 <tr>
586 <td class="memname">void sgb_transfer </td>
587 <td>(</td>
588 <td class="paramtype"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> * </td>
589 <td class="paramname"><em>packet</em></td><td>)</td>
590 <td></td>
591 </tr>
592 </table>
593 </div><div class="memdoc">
594 <p >Transfer a SGB packet</p>
595 <dl class="params"><dt>Parameters</dt><dd>
596 <table class="params">
597 <tr><td class="paramname">packet</td><td>Pointer to buffer with SGB packet data.</td></tr>
598 </table>
599 </dd>
600 </dl>
601 <p>The first byte of <b>packet</b> should be a SGB command, then up to 15 bytes of command parameter data.</p>
602 <p >See the <code>sgb_border</code> GBDK example project for a demo of how to use these the sgb functions.</p>
603 <p >When using the SGB with a PAL SNES, a delay should be added just after program startup such as:</p>
604 <div class="fragment"><div class="line"><span class="comment">// Wait 4 frames</span></div>
605 <div class="line"><span class="comment">// For PAL SNES this delay is required on startup</span></div>
606 <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>
607 <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>
608 <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>
609 </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>
610
611 </div>
612 </div>
613 <h2 class="groupheader">Variable Documentation</h2>
614 <a id="c" name="c"></a>
615 <h2 class="memtitle"><span class="permalink"><a href="#c">◆ </a></span>c</h2>
616
617 <div class="memitem">
618 <div class="memproto">
619 <table class="memname">
620 <tr>
621 <td class="memname">void c</td>
622 </tr>
623 </table>
624 </div><div class="memdoc">
625
626 </div>
627 </div>
628 </div><!-- contents -->
629 </div><!-- doc-content -->
630 <!-- start footer part -->
631 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
632 <ul>
633 <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>
634 <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>
635 </ul>
636 </div>
637 </body>
638 </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.