gbdk-2020 | GameBoy Development Kit |
| download: https://git.y1.nz/archives/gbdk.tar.gz | |
| README | Files | Log | Refs | LICENSE |
docs/api/rledecompress_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/gbdk/rledecompress.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('rledecompress_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> </div>
105 <div class="headertitle"><div class="title">rledecompress.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="rledecompress_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="define-members" name="define-members"></a>
114 Macros</h2></td></tr>
115 <tr class="memitem:RLE_STOP"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="rledecompress_8h.html#RLE_STOP">RLE_STOP</a>   0</td></tr>
116 <tr class="separator:RLE_STOP"><td class="memSeparator" colspan="2"> </td></tr>
117 </table><table class="memberdecls">
118 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
119 Functions</h2></td></tr>
120 <tr class="memitem:rle_init"><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="rledecompress_8h.html#rle_init">rle_init</a> (void *data)</td></tr>
121 <tr class="separator:rle_init"><td class="memSeparator" colspan="2"> </td></tr>
122 <tr class="memitem:rle_decompress"><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="rledecompress_8h.html#rle_decompress">rle_decompress</a> (void *dest, <a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> len)</td></tr>
123 <tr class="separator:rle_decompress"><td class="memSeparator" colspan="2"> </td></tr>
124 </table>
125 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
126 <div class="textblock"><p >Decompressor for RLE encoded data</p>
127 <p >Decompresses data which has been compressed with <a class="el" href="docs_toolchain.html#utility_gbcompress">gbcompress</a> using the <code>--alg=rle</code> argument. </p>
128 </div><h2 class="groupheader">Macro Definition Documentation</h2>
129 <a id="RLE_STOP" name="RLE_STOP"></a>
130 <h2 class="memtitle"><span class="permalink"><a href="#RLE_STOP">◆ </a></span>RLE_STOP</h2>
131
132 <div class="memitem">
133 <div class="memproto">
134 <table class="memname">
135 <tr>
136 <td class="memname">#define RLE_STOP   0</td>
137 </tr>
138 </table>
139 </div><div class="memdoc">
140
141 </div>
142 </div>
143 <h2 class="groupheader">Function Documentation</h2>
144 <a id="rle_init" name="rle_init"></a>
145 <h2 class="memtitle"><span class="permalink"><a href="#rle_init">◆ </a></span>rle_init()</h2>
146
147 <div class="memitem">
148 <div class="memproto">
149 <table class="memname">
150 <tr>
151 <td class="memname"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> rle_init </td>
152 <td>(</td>
153 <td class="paramtype">void * </td>
154 <td class="paramname"><em>data</em></td><td>)</td>
155 <td></td>
156 </tr>
157 </table>
158 </div><div class="memdoc">
159 <p >Initialize the RLE decompressor with RLE data at address <b>data</b></p>
160 <dl class="params"><dt>Parameters</dt><dd>
161 <table class="params">
162 <tr><td class="paramname">data</td><td>Pointer to start of RLE compressed data</td></tr>
163 </table>
164 </dd>
165 </dl>
166 <dl class="section see"><dt>See also</dt><dd><a class="el" href="rledecompress_8h.html#rle_decompress">rle_decompress</a> </dd></dl>
167
168 </div>
169 </div>
170 <a id="rle_decompress" name="rle_decompress"></a>
171 <h2 class="memtitle"><span class="permalink"><a href="#rle_decompress">◆ </a></span>rle_decompress()</h2>
172
173 <div class="memitem">
174 <div class="memproto">
175 <table class="memname">
176 <tr>
177 <td class="memname"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> rle_decompress </td>
178 <td>(</td>
179 <td class="paramtype">void * </td>
180 <td class="paramname"><em>dest</em>, </td>
181 </tr>
182 <tr>
183 <td class="paramkey"></td>
184 <td></td>
185 <td class="paramtype"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> </td>
186 <td class="paramname"><em>len</em> </td>
187 </tr>
188 <tr>
189 <td></td>
190 <td>)</td>
191 <td></td><td></td>
192 </tr>
193 </table>
194 </div><div class="memdoc">
195 <p >Decompress RLE compressed data into <b>dest</b> for length <b>len</b> bytes</p>
196 <dl class="params"><dt>Parameters</dt><dd>
197 <table class="params">
198 <tr><td class="paramname">dest</td><td>Pointer to destination buffer/address </td></tr>
199 <tr><td class="paramname">len</td><td>Number of bytes to decompress </td></tr>
200 </table>
201 </dd>
202 </dl>
203 <dl class="section return"><dt>Returns</dt><dd>Returns <code>0</code> if compression is complete, <code>1</code> if there is more data to decompress</dd></dl>
204 <p>Before calling this function <a class="el" href="rledecompress_8h.html#rle_init">rle_init</a> must be called one time to initialize the RLE decompressor.</p>
205 <p >Decompresses data which has been compressed with <a class="el" href="docs_toolchain.html#utility_gbcompress">gbcompress</a> using the <code>--alg=rle</code> argument.</p>
206 <dl class="section see"><dt>See also</dt><dd><a class="el" href="rledecompress_8h.html#rle_init">rle_init</a> </dd></dl>
207
208 </div>
209 </div>
210 </div><!-- contents -->
211 </div><!-- doc-content -->
212 <!-- start footer part -->
213 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
214 <ul>
215 <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_aedcfcf321a7f13aa34b51e3093299b2.html">gbdk</a></li><li class="navelem"><a class="el" href="rledecompress_8h.html">rledecompress.h</a></li>
216 <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>
217 </ul>
218 </div>
219 </body>
220 </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.