sms_2gbdecompress_8h.html (8322B)
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: sms/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('sms_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="sms_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:a9cd1564f78842562c450becf22002db2"><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="sms_2gbdecompress_8h.html#a9cd1564f78842562c450becf22002db2">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_2z80_2types_8h.html#aa19670cfef9fe1cc31f28fafb0e1000a">Z88DK_CALLEE</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:a9cd1564f78842562c450becf22002db2"><td class="memSeparator" colspan="2"> </td></tr> 105</table><table class="memberdecls"> 106<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a> 107Variables</h2></td></tr> 108<tr class="memitem:add06ad5d8520e7cff4ff84b2811c0982"><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="sms_2gbdecompress_8h.html#add06ad5d8520e7cff4ff84b2811c0982">c</a></td></tr> 109<tr class="separator:add06ad5d8520e7cff4ff84b2811c0982"><td class="memSeparator" colspan="2"> </td></tr> 110</table> 111<h2 class="groupheader">Function Documentation</h2> 112<a id="a9cd1564f78842562c450becf22002db2"></a> 113<h2 class="memtitle"><span class="permalink"><a href="#a9cd1564f78842562c450becf22002db2">◆ </a></span>gb_decompress()</h2> 114 115<div class="memitem"> 116<div class="memproto"> 117 <table class="memname"> 118 <tr> 119 <td class="memname"><a class="el" href="stdint_8h.html#adf4d876453337156dde61095e1f20223">uint16_t</a> gb_decompress </td> 120 <td>(</td> 121 <td class="paramtype">const <a class="el" href="stdint_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> * </td> 122 <td class="paramname"><em>sour</em>, </td> 123 </tr> 124 <tr> 125 <td class="paramkey"></td> 126 <td></td> 127 <td class="paramtype"><a class="el" href="stdint_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> * </td> 128 <td class="paramname"><em>dest</em> </td> 129 </tr> 130 <tr> 131 <td></td> 132 <td>)</td> 133 <td></td><td></td> 134 </tr> 135 </table> 136</div><div class="memdoc"> 137<p>gb-decompress data from sour into dest</p> 138<dl class="params"><dt>Parameters</dt><dd> 139 <table class="params"> 140 <tr><td class="paramname">sour</td><td>Pointer to source gb-compressed data </td></tr> 141 <tr><td class="paramname">dest</td><td>Pointer to destination buffer/address</td></tr> 142 </table> 143 </dd> 144</dl> 145<dl class="section return"><dt>Returns</dt><dd>Return value is number of bytes decompressed</dd></dl> 146<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> 147 148</div> 149</div> 150<h2 class="groupheader">Variable Documentation</h2> 151<a id="add06ad5d8520e7cff4ff84b2811c0982"></a> 152<h2 class="memtitle"><span class="permalink"><a href="#add06ad5d8520e7cff4ff84b2811c0982">◆ </a></span>c</h2> 153 154<div class="memitem"> 155<div class="memproto"> 156 <table class="memname"> 157 <tr> 158 <td class="memname"><a class="el" href="stdint_8h.html#adf4d876453337156dde61095e1f20223">uint16_t</a> c</td> 159 </tr> 160 </table> 161</div><div class="memdoc"> 162 163</div> 164</div> 165</div><!-- contents --> 166</div><!-- doc-content --> 167<!-- HTML footer for doxygen 1.8.14--> 168<!-- start footer part --> 169<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> 170</div> 171</body> 172</html>