gb_2gbdecompress_8h.html (16487B)
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: gb/gbdecompress.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_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('gb_2gbdecompress_8h.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="header"> 89 <div class="summary"> 90<a href="#func-members">Functions</a> | 91<a href="#var-members">Variables</a> </div> 92 <div class="headertitle"> 93<div class="title">gbdecompress.h File Reference</div> </div> 94</div><!--header--> 95<div class="contents"> 96<div class="textblock"><code>#include <types.h></code><br /> 97<code>#include <<a class="el" href="stdint_8h_source.html">stdint.h</a>></code><br /> 98</div> 99<p><a href="gb_2gbdecompress_8h_source.html">Go to the source code of this file.</a></p> 100<table class="memberdecls"> 101<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> 102Functions</h2></td></tr> 103<tr class="memitem:a3370eefd9a88fdefed71eeb92e6861f2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="stdint_8h.html#adf4d876453337156dde61095e1f20223">uint16_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="gb_2gbdecompress_8h.html#a3370eefd9a88fdefed71eeb92e6861f2">gb_decompress</a> (const <a class="el" href="stdint_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> *sour, <a class="el" href="stdint_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> *dest) <a class="el" href="asm_2types_8h.html#a0971918860055db2e50dacea4da8f3bc">OLDCALL</a> <a class="el" href="asm_2types_8h.html#acb825e83a33fcc06482c59b4ab2cf961">PRESERVES_REGS</a>(<a class="el" href="gb_8h.html#a4c2e4adef74067fdbb49005bc73de937">b</a></td></tr> 104<tr class="separator:a3370eefd9a88fdefed71eeb92e6861f2"><td class="memSeparator" colspan="2"> </td></tr> 105<tr class="memitem:aed0cb0f1604a80ca5e7fb771b04114d8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="gb_2gbdecompress_8h.html#aed0cb0f1604a80ca5e7fb771b04114d8">gb_decompress_bkg_data</a> (<a class="el" href="stdint_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> first_tile, const <a class="el" href="stdint_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> *sour) <a class="el" href="asm_2types_8h.html#a0971918860055db2e50dacea4da8f3bc">OLDCALL</a> <a class="el" href="asm_2types_8h.html#acb825e83a33fcc06482c59b4ab2cf961">PRESERVES_REGS</a>(<a class="el" href="gb_8h.html#a4c2e4adef74067fdbb49005bc73de937">b</a></td></tr> 106<tr class="separator:aed0cb0f1604a80ca5e7fb771b04114d8"><td class="memSeparator" colspan="2"> </td></tr> 107<tr class="memitem:a85d2eaf4a7c268fe1496fa2b9c626284"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="gb_2gbdecompress_8h.html#a85d2eaf4a7c268fe1496fa2b9c626284">gb_decompress_win_data</a> (<a class="el" href="stdint_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> first_tile, const <a class="el" href="stdint_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> *sour) <a class="el" href="asm_2types_8h.html#a0971918860055db2e50dacea4da8f3bc">OLDCALL</a> <a class="el" href="asm_2types_8h.html#acb825e83a33fcc06482c59b4ab2cf961">PRESERVES_REGS</a>(<a class="el" href="gb_8h.html#a4c2e4adef74067fdbb49005bc73de937">b</a></td></tr> 108<tr class="separator:a85d2eaf4a7c268fe1496fa2b9c626284"><td class="memSeparator" colspan="2"> </td></tr> 109<tr class="memitem:aa4ac6ffb1dc949051e0e72e2aba8e6ff"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="gb_2gbdecompress_8h.html#aa4ac6ffb1dc949051e0e72e2aba8e6ff">gb_decompress_sprite_data</a> (<a class="el" href="stdint_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> first_tile, const <a class="el" href="stdint_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> *sour) <a class="el" href="asm_2types_8h.html#a0971918860055db2e50dacea4da8f3bc">OLDCALL</a> <a class="el" href="asm_2types_8h.html#acb825e83a33fcc06482c59b4ab2cf961">PRESERVES_REGS</a>(<a class="el" href="gb_8h.html#a4c2e4adef74067fdbb49005bc73de937">b</a></td></tr> 110<tr class="separator:aa4ac6ffb1dc949051e0e72e2aba8e6ff"><td class="memSeparator" colspan="2"> </td></tr> 111</table><table class="memberdecls"> 112<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a> 113Variables</h2></td></tr> 114<tr class="memitem:a0b3366755f3276b0243c1e0497471b7a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="stdint_8h.html#adf4d876453337156dde61095e1f20223">uint16_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="gb_2gbdecompress_8h.html#a0b3366755f3276b0243c1e0497471b7a">c</a></td></tr> 115<tr class="separator:a0b3366755f3276b0243c1e0497471b7a"><td class="memSeparator" colspan="2"> </td></tr> 116</table> 117<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> 118<div class="textblock"><p>GB-Compress decompressor Compatible with the compression used in GBTD </p><dl class="section see"><dt>See also</dt><dd>utility_gbcompress "gbcompress"</dd></dl> 119<p>GB-Compress decompressor Compatible with the compression used in GBTD </p> 120</div><h2 class="groupheader">Function Documentation</h2> 121<a id="a3370eefd9a88fdefed71eeb92e6861f2"></a> 122<h2 class="memtitle"><span class="permalink"><a href="#a3370eefd9a88fdefed71eeb92e6861f2">◆ </a></span>gb_decompress()</h2> 123 124<div class="memitem"> 125<div class="memproto"> 126 <table class="memname"> 127 <tr> 128 <td class="memname"><a class="el" href="stdint_8h.html#adf4d876453337156dde61095e1f20223">uint16_t</a> gb_decompress </td> 129 <td>(</td> 130 <td class="paramtype">const <a class="el" href="stdint_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> * </td> 131 <td class="paramname"><em>sour</em>, </td> 132 </tr> 133 <tr> 134 <td class="paramkey"></td> 135 <td></td> 136 <td class="paramtype"><a class="el" href="stdint_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> * </td> 137 <td class="paramname"><em>dest</em> </td> 138 </tr> 139 <tr> 140 <td></td> 141 <td>)</td> 142 <td></td><td></td> 143 </tr> 144 </table> 145</div><div class="memdoc"> 146<p>gb-decompress data from sour into dest</p> 147<dl class="params"><dt>Parameters</dt><dd> 148 <table class="params"> 149 <tr><td class="paramname">sour</td><td>Pointer to source gb-compressed data </td></tr> 150 <tr><td class="paramname">dest</td><td>Pointer to destination buffer/address</td></tr> 151 </table> 152 </dd> 153</dl> 154<dl class="section see"><dt>See also</dt><dd><a class="el" href="gb_2gbdecompress_8h.html#aed0cb0f1604a80ca5e7fb771b04114d8">gb_decompress_bkg_data</a>, <a class="el" href="gb_2gbdecompress_8h.html#a85d2eaf4a7c268fe1496fa2b9c626284">gb_decompress_win_data</a>, <a class="el" href="gb_2gbdecompress_8h.html#aa4ac6ffb1dc949051e0e72e2aba8e6ff">gb_decompress_sprite_data</a> </dd></dl> 155 156</div> 157</div> 158<a id="aed0cb0f1604a80ca5e7fb771b04114d8"></a> 159<h2 class="memtitle"><span class="permalink"><a href="#aed0cb0f1604a80ca5e7fb771b04114d8">◆ </a></span>gb_decompress_bkg_data()</h2> 160 161<div class="memitem"> 162<div class="memproto"> 163 <table class="memname"> 164 <tr> 165 <td class="memname">void gb_decompress_bkg_data </td> 166 <td>(</td> 167 <td class="paramtype"><a class="el" href="stdint_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> </td> 168 <td class="paramname"><em>first_tile</em>, </td> 169 </tr> 170 <tr> 171 <td class="paramkey"></td> 172 <td></td> 173 <td class="paramtype">const <a class="el" href="stdint_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> * </td> 174 <td class="paramname"><em>sour</em> </td> 175 </tr> 176 <tr> 177 <td></td> 178 <td>)</td> 179 <td></td><td></td> 180 </tr> 181 </table> 182</div><div class="memdoc"> 183<p>gb-decompress background tiles into VRAM</p> 184<dl class="params"><dt>Parameters</dt><dd> 185 <table class="params"> 186 <tr><td class="paramname">first_tile</td><td>Index of the first tile to write </td></tr> 187 <tr><td class="paramname">sour</td><td>Pointer to (gb-compressed 2 bpp) source Tile Pattern data.</td></tr> 188 </table> 189 </dd> 190</dl> 191<p>Note: This function avoids writes during modes 2 & 3</p> 192<dl class="section see"><dt>See also</dt><dd><a class="el" href="gb_2gbdecompress_8h.html#aed0cb0f1604a80ca5e7fb771b04114d8">gb_decompress_bkg_data</a>, <a class="el" href="gb_2gbdecompress_8h.html#a85d2eaf4a7c268fe1496fa2b9c626284">gb_decompress_win_data</a>, <a class="el" href="gb_2gbdecompress_8h.html#aa4ac6ffb1dc949051e0e72e2aba8e6ff">gb_decompress_sprite_data</a> </dd></dl> 193 194</div> 195</div> 196<a id="a85d2eaf4a7c268fe1496fa2b9c626284"></a> 197<h2 class="memtitle"><span class="permalink"><a href="#a85d2eaf4a7c268fe1496fa2b9c626284">◆ </a></span>gb_decompress_win_data()</h2> 198 199<div class="memitem"> 200<div class="memproto"> 201 <table class="memname"> 202 <tr> 203 <td class="memname">void gb_decompress_win_data </td> 204 <td>(</td> 205 <td class="paramtype"><a class="el" href="stdint_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> </td> 206 <td class="paramname"><em>first_tile</em>, </td> 207 </tr> 208 <tr> 209 <td class="paramkey"></td> 210 <td></td> 211 <td class="paramtype">const <a class="el" href="stdint_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> * </td> 212 <td class="paramname"><em>sour</em> </td> 213 </tr> 214 <tr> 215 <td></td> 216 <td>)</td> 217 <td></td><td></td> 218 </tr> 219 </table> 220</div><div class="memdoc"> 221<p>gb-decompress window tiles into VRAM</p> 222<dl class="params"><dt>Parameters</dt><dd> 223 <table class="params"> 224 <tr><td class="paramname">first_tile</td><td>Index of the first tile to write </td></tr> 225 <tr><td class="paramname">sour</td><td>Pointer to (gb-compressed 2 bpp) source Tile Pattern data.</td></tr> 226 </table> 227 </dd> 228</dl> 229<p>This is the same as <a class="el" href="gb_2gbdecompress_8h.html#aed0cb0f1604a80ca5e7fb771b04114d8">gb_decompress_bkg_data</a>, since the Window Layer and Background Layer share the same Tile pattern data.</p> 230<p>Note: This function avoids writes during modes 2 & 3</p> 231<dl class="section see"><dt>See also</dt><dd><a class="el" href="gb_2gbdecompress_8h.html#a3370eefd9a88fdefed71eeb92e6861f2">gb_decompress</a>, <a class="el" href="gb_2gbdecompress_8h.html#aed0cb0f1604a80ca5e7fb771b04114d8">gb_decompress_bkg_data</a>, <a class="el" href="gb_2gbdecompress_8h.html#aa4ac6ffb1dc949051e0e72e2aba8e6ff">gb_decompress_sprite_data</a> </dd></dl> 232 233</div> 234</div> 235<a id="aa4ac6ffb1dc949051e0e72e2aba8e6ff"></a> 236<h2 class="memtitle"><span class="permalink"><a href="#aa4ac6ffb1dc949051e0e72e2aba8e6ff">◆ </a></span>gb_decompress_sprite_data()</h2> 237 238<div class="memitem"> 239<div class="memproto"> 240 <table class="memname"> 241 <tr> 242 <td class="memname">void gb_decompress_sprite_data </td> 243 <td>(</td> 244 <td class="paramtype"><a class="el" href="stdint_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> </td> 245 <td class="paramname"><em>first_tile</em>, </td> 246 </tr> 247 <tr> 248 <td class="paramkey"></td> 249 <td></td> 250 <td class="paramtype">const <a class="el" href="stdint_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> * </td> 251 <td class="paramname"><em>sour</em> </td> 252 </tr> 253 <tr> 254 <td></td> 255 <td>)</td> 256 <td></td><td></td> 257 </tr> 258 </table> 259</div><div class="memdoc"> 260<p>gb-decompress sprite tiles into VRAM</p> 261<dl class="params"><dt>Parameters</dt><dd> 262 <table class="params"> 263 <tr><td class="paramname">first_tile</td><td>Index of the first tile to write </td></tr> 264 <tr><td class="paramname">sour</td><td>Pointer to source compressed data</td></tr> 265 </table> 266 </dd> 267</dl> 268<p>Note: This function avoids writes during modes 2 & 3</p> 269<dl class="section see"><dt>See also</dt><dd><a class="el" href="gb_2gbdecompress_8h.html#a3370eefd9a88fdefed71eeb92e6861f2">gb_decompress</a>, <a class="el" href="gb_2gbdecompress_8h.html#aed0cb0f1604a80ca5e7fb771b04114d8">gb_decompress_bkg_data</a>, <a class="el" href="gb_2gbdecompress_8h.html#a85d2eaf4a7c268fe1496fa2b9c626284">gb_decompress_win_data</a> </dd></dl> 270 271</div> 272</div> 273<h2 class="groupheader">Variable Documentation</h2> 274<a id="a0b3366755f3276b0243c1e0497471b7a"></a> 275<h2 class="memtitle"><span class="permalink"><a href="#a0b3366755f3276b0243c1e0497471b7a">◆ </a></span>c</h2> 276 277<div class="memitem"> 278<div class="memproto"> 279 <table class="memname"> 280 <tr> 281 <td class="memname">void c</td> 282 </tr> 283 </table> 284</div><div class="memdoc"> 285 286</div> 287</div> 288</div><!-- contents --> 289</div><!-- doc-content --> 290<!-- HTML footer for doxygen 1.8.14--> 291<!-- start footer part --> 292<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> 293</div> 294</body> 295</html>