gbdk-2020 | GameBoy Development Kit |
| download: https://git.y1.nz/archives/gbdk.tar.gz | |
| README | Files | Log | Refs | LICENSE |
docs/api/sms_2gbdecompress_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/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-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('sms_2gbdecompress_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="#func-members">Functions</a> |
104 <a href="#var-members">Variables</a> </div>
105 <div class="headertitle"><div class="title">gbdecompress.h File Reference</div></div>
106 </div><!--header-->
107 <div class="contents">
108 <div class="textblock"><code>#include <types.h></code><br />
109 <code>#include <<a class="el" href="stdint_8h_source.html">stdint.h</a>></code><br />
110 </div>
111 <p><a href="sms_2gbdecompress_8h_source.html">Go to the source code of this file.</a></p>
112 <table class="memberdecls">
113 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
114 Functions</h2></td></tr>
115 <tr class="memitem:gb_decompress"><td class="memItemLeft" align="right" valign="top"><a class="el" href="stdint_8h.html#uint16_t">uint16_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sms_2gbdecompress_8h.html#gb_decompress">gb_decompress</a> (const <a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> *sour, <a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> *dest) <a class="el" href="asm_2z80_2types_8h.html#Z88DK_CALLEE">Z88DK_CALLEE</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>
116 <tr class="separator:gb_decompress"><td class="memSeparator" colspan="2"> </td></tr>
117 </table><table class="memberdecls">
118 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="var-members" name="var-members"></a>
119 Variables</h2></td></tr>
120 <tr class="memitem:c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="stdint_8h.html#uint16_t">uint16_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sms_2gbdecompress_8h.html#c">c</a></td></tr>
121 <tr class="separator:c"><td class="memSeparator" colspan="2"> </td></tr>
122 </table>
123 <h2 class="groupheader">Function Documentation</h2>
124 <a id="gb_decompress" name="gb_decompress"></a>
125 <h2 class="memtitle"><span class="permalink"><a href="#gb_decompress">◆ </a></span>gb_decompress()</h2>
126
127 <div class="memitem">
128 <div class="memproto">
129 <table class="memname">
130 <tr>
131 <td class="memname"><a class="el" href="stdint_8h.html#uint16_t">uint16_t</a> gb_decompress </td>
132 <td>(</td>
133 <td class="paramtype">const <a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> * </td>
134 <td class="paramname"><em>sour</em>, </td>
135 </tr>
136 <tr>
137 <td class="paramkey"></td>
138 <td></td>
139 <td class="paramtype"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> * </td>
140 <td class="paramname"><em>dest</em> </td>
141 </tr>
142 <tr>
143 <td></td>
144 <td>)</td>
145 <td></td><td></td>
146 </tr>
147 </table>
148 </div><div class="memdoc">
149 <p >gb-decompress data from sour into dest</p>
150 <dl class="params"><dt>Parameters</dt><dd>
151 <table class="params">
152 <tr><td class="paramname">sour</td><td>Pointer to source gb-compressed data </td></tr>
153 <tr><td class="paramname">dest</td><td>Pointer to destination buffer/address</td></tr>
154 </table>
155 </dd>
156 </dl>
157 <dl class="section return"><dt>Returns</dt><dd>Return value is number of bytes decompressed</dd></dl>
158 <dl class="section see"><dt>See also</dt><dd><a class="el" href="gb_2gbdecompress_8h.html#gb_decompress_bkg_data">gb_decompress_bkg_data</a>, <a class="el" href="gb_2gbdecompress_8h.html#gb_decompress_win_data">gb_decompress_win_data</a>, <a class="el" href="gb_2gbdecompress_8h.html#gb_decompress_sprite_data">gb_decompress_sprite_data</a> </dd></dl>
159
160 </div>
161 </div>
162 <h2 class="groupheader">Variable Documentation</h2>
163 <a id="c" name="c"></a>
164 <h2 class="memtitle"><span class="permalink"><a href="#c">◆ </a></span>c</h2>
165
166 <div class="memitem">
167 <div class="memproto">
168 <table class="memname">
169 <tr>
170 <td class="memname"><a class="el" href="stdint_8h.html#uint16_t">uint16_t</a> c</td>
171 </tr>
172 </table>
173 </div><div class="memdoc">
174
175 </div>
176 </div>
177 </div><!-- contents -->
178 </div><!-- doc-content -->
179 <!-- start footer part -->
180 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
181 <ul>
182 <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_7a84f275fead463a4aefdc90fba00235.html">sms</a></li><li class="navelem"><a class="el" href="sms_2gbdecompress_8h.html">gbdecompress.h</a></li>
183 <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>
184 </ul>
185 </div>
186 </body>
187 </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.