gbdk-2020 | GameBoy Development Kit |
| download: https://git.y1.nz/archives/gbdk.tar.gz | |
| README | Files | Log | Refs | LICENSE |
docs/api/gb_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/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-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('gb_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> </div>
104 <div class="headertitle"><div class="title">gbdecompress.h File Reference</div></div>
105 </div><!--header-->
106 <div class="contents">
107 <div class="textblock"><code>#include <types.h></code><br />
108 <code>#include <<a class="el" href="stdint_8h_source.html">stdint.h</a>></code><br />
109 </div>
110 <p><a href="gb_2gbdecompress_8h_source.html">Go to the source code of this file.</a></p>
111 <table class="memberdecls">
112 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
113 Functions</h2></td></tr>
114 <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="gb_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)</td></tr>
115 <tr class="separator:gb_decompress"><td class="memSeparator" colspan="2"> </td></tr>
116 <tr class="memitem:gb_decompress_bkg_data"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="gb_2gbdecompress_8h.html#gb_decompress_bkg_data">gb_decompress_bkg_data</a> (<a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> first_tile, const <a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> *sour)</td></tr>
117 <tr class="separator:gb_decompress_bkg_data"><td class="memSeparator" colspan="2"> </td></tr>
118 <tr class="memitem:gb_decompress_win_data"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="gb_2gbdecompress_8h.html#gb_decompress_win_data">gb_decompress_win_data</a> (<a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> first_tile, const <a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> *sour)</td></tr>
119 <tr class="separator:gb_decompress_win_data"><td class="memSeparator" colspan="2"> </td></tr>
120 <tr class="memitem:gb_decompress_sprite_data"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="gb_2gbdecompress_8h.html#gb_decompress_sprite_data">gb_decompress_sprite_data</a> (<a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> first_tile, const <a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> *sour)</td></tr>
121 <tr class="separator:gb_decompress_sprite_data"><td class="memSeparator" colspan="2"> </td></tr>
122 </table>
123 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
124 <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>
125 <p>GB-Compress decompressor Compatible with the compression used in GBTD </p>
126 </div><h2 class="groupheader">Function Documentation</h2>
127 <a id="gb_decompress" name="gb_decompress"></a>
128 <h2 class="memtitle"><span class="permalink"><a href="#gb_decompress">◆ </a></span>gb_decompress()</h2>
129
130 <div class="memitem">
131 <div class="memproto">
132 <table class="memname">
133 <tr>
134 <td class="memname"><a class="el" href="stdint_8h.html#uint16_t">uint16_t</a> gb_decompress </td>
135 <td>(</td>
136 <td class="paramtype">const <a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> * </td>
137 <td class="paramname"><em>sour</em>, </td>
138 </tr>
139 <tr>
140 <td class="paramkey"></td>
141 <td></td>
142 <td class="paramtype"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> * </td>
143 <td class="paramname"><em>dest</em> </td>
144 </tr>
145 <tr>
146 <td></td>
147 <td>)</td>
148 <td></td><td></td>
149 </tr>
150 </table>
151 </div><div class="memdoc">
152 <p >gb-decompress data from sour into dest</p>
153 <dl class="params"><dt>Parameters</dt><dd>
154 <table class="params">
155 <tr><td class="paramname">sour</td><td>Pointer to source gb-compressed data </td></tr>
156 <tr><td class="paramname">dest</td><td>Pointer to destination buffer/address</td></tr>
157 </table>
158 </dd>
159 </dl>
160 <p>Will decompress <b>all</b> of it's data to destination without stopping until the end of compressed data is reached. It is not possible to set a limit, so ensure the destination buffer has sufficient space to avoid an overflow.</p>
161 <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>, <a class="el" href="rledecompress_8h.html#rle_decompress">rle_decompress</a></dd></dl>
162 <p>gb-decompress data from sour into dest</p>
163 <dl class="params"><dt>Parameters</dt><dd>
164 <table class="params">
165 <tr><td class="paramname">sour</td><td>Pointer to source gb-compressed data </td></tr>
166 <tr><td class="paramname">dest</td><td>Pointer to destination buffer/address</td></tr>
167 </table>
168 </dd>
169 </dl>
170 <dl class="section return"><dt>Returns</dt><dd>Return value is number of bytes decompressed</dd></dl>
171 <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>
172
173 </div>
174 </div>
175 <a id="gb_decompress_bkg_data" name="gb_decompress_bkg_data"></a>
176 <h2 class="memtitle"><span class="permalink"><a href="#gb_decompress_bkg_data">◆ </a></span>gb_decompress_bkg_data()</h2>
177
178 <div class="memitem">
179 <div class="memproto">
180 <table class="memname">
181 <tr>
182 <td class="memname">void gb_decompress_bkg_data </td>
183 <td>(</td>
184 <td class="paramtype"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> </td>
185 <td class="paramname"><em>first_tile</em>, </td>
186 </tr>
187 <tr>
188 <td class="paramkey"></td>
189 <td></td>
190 <td class="paramtype">const <a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> * </td>
191 <td class="paramname"><em>sour</em> </td>
192 </tr>
193 <tr>
194 <td></td>
195 <td>)</td>
196 <td></td><td></td>
197 </tr>
198 </table>
199 </div><div class="memdoc">
200 <p >gb-decompress background tiles into VRAM</p>
201 <dl class="params"><dt>Parameters</dt><dd>
202 <table class="params">
203 <tr><td class="paramname">first_tile</td><td>Index of the first tile to write </td></tr>
204 <tr><td class="paramname">sour</td><td>Pointer to (gb-compressed 2 bpp) source Tile Pattern data.</td></tr>
205 </table>
206 </dd>
207 </dl>
208 <p>Note: This function avoids writes during modes 2 & 3</p>
209 <p >Will decompress <b>all</b> of it's data to destination without stopping until the end of compressed data is reached. It is not possible to set a limit, so ensure the destination buffer has sufficient space to avoid an overflow.</p>
210 <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>
211
212 </div>
213 </div>
214 <a id="gb_decompress_win_data" name="gb_decompress_win_data"></a>
215 <h2 class="memtitle"><span class="permalink"><a href="#gb_decompress_win_data">◆ </a></span>gb_decompress_win_data()</h2>
216
217 <div class="memitem">
218 <div class="memproto">
219 <table class="memname">
220 <tr>
221 <td class="memname">void gb_decompress_win_data </td>
222 <td>(</td>
223 <td class="paramtype"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> </td>
224 <td class="paramname"><em>first_tile</em>, </td>
225 </tr>
226 <tr>
227 <td class="paramkey"></td>
228 <td></td>
229 <td class="paramtype">const <a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> * </td>
230 <td class="paramname"><em>sour</em> </td>
231 </tr>
232 <tr>
233 <td></td>
234 <td>)</td>
235 <td></td><td></td>
236 </tr>
237 </table>
238 </div><div class="memdoc">
239 <p >gb-decompress window tiles into VRAM</p>
240 <dl class="params"><dt>Parameters</dt><dd>
241 <table class="params">
242 <tr><td class="paramname">first_tile</td><td>Index of the first tile to write </td></tr>
243 <tr><td class="paramname">sour</td><td>Pointer to (gb-compressed 2 bpp) source Tile Pattern data.</td></tr>
244 </table>
245 </dd>
246 </dl>
247 <p>This is the same as <a class="el" href="gb_2gbdecompress_8h.html#gb_decompress_bkg_data">gb_decompress_bkg_data</a>, since the Window Layer and Background Layer share the same Tile pattern data.</p>
248 <p >Note: This function avoids writes during modes 2 & 3</p>
249 <p >Will decompress <b>all</b> of it's data to destination without stopping until the end of compressed data is reached. It is not possible to set a limit, so ensure the destination buffer has sufficient space to avoid an overflow.</p>
250 <dl class="section see"><dt>See also</dt><dd><a class="el" href="gb_2gbdecompress_8h.html#gb_decompress">gb_decompress</a>, <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_sprite_data">gb_decompress_sprite_data</a> </dd></dl>
251
252 </div>
253 </div>
254 <a id="gb_decompress_sprite_data" name="gb_decompress_sprite_data"></a>
255 <h2 class="memtitle"><span class="permalink"><a href="#gb_decompress_sprite_data">◆ </a></span>gb_decompress_sprite_data()</h2>
256
257 <div class="memitem">
258 <div class="memproto">
259 <table class="memname">
260 <tr>
261 <td class="memname">void gb_decompress_sprite_data </td>
262 <td>(</td>
263 <td class="paramtype"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> </td>
264 <td class="paramname"><em>first_tile</em>, </td>
265 </tr>
266 <tr>
267 <td class="paramkey"></td>
268 <td></td>
269 <td class="paramtype">const <a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> * </td>
270 <td class="paramname"><em>sour</em> </td>
271 </tr>
272 <tr>
273 <td></td>
274 <td>)</td>
275 <td></td><td></td>
276 </tr>
277 </table>
278 </div><div class="memdoc">
279 <p >gb-decompress sprite tiles into VRAM</p>
280 <dl class="params"><dt>Parameters</dt><dd>
281 <table class="params">
282 <tr><td class="paramname">first_tile</td><td>Index of the first tile to write </td></tr>
283 <tr><td class="paramname">sour</td><td>Pointer to source compressed data</td></tr>
284 </table>
285 </dd>
286 </dl>
287 <p>Note: This function avoids writes during modes 2 & 3</p>
288 <p >Will decompress <b>all</b> of it's data to destination without stopping until the end of compressed data is reached. It is not possible to set a limit, so ensure the destination buffer has sufficient space to avoid an overflow.</p>
289 <dl class="section see"><dt>See also</dt><dd><a class="el" href="gb_2gbdecompress_8h.html#gb_decompress">gb_decompress</a>, <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> </dd></dl>
290
291 </div>
292 </div>
293 </div><!-- contents -->
294 </div><!-- doc-content -->
295 <!-- start footer part -->
296 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
297 <ul>
298 <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="gb_2gbdecompress_8h.html">gbdecompress.h</a></li>
299 <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>
300 </ul>
301 </div>
302 </body>
303 </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.