rledecompress_8h.html (9839B)
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: 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_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('rledecompress_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="#define-members">Macros</a> | 91<a href="#func-members">Functions</a> </div> 92 <div class="headertitle"> 93<div class="title">rledecompress.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="rledecompress_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="define-members"></a> 102Macros</h2></td></tr> 103<tr class="memitem:a2b4967f6970ecd99478db3807c68d955"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="rledecompress_8h.html#a2b4967f6970ecd99478db3807c68d955">RLE_STOP</a>   0</td></tr> 104<tr class="separator:a2b4967f6970ecd99478db3807c68d955"><td class="memSeparator" colspan="2"> </td></tr> 105</table><table class="memberdecls"> 106<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> 107Functions</h2></td></tr> 108<tr class="memitem:a95560a74a89bab26cb6265dcc2bf54f6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="stdint_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="rledecompress_8h.html#a95560a74a89bab26cb6265dcc2bf54f6">rle_init</a> (void *data) <a class="el" href="asm_2types_8h.html#a0971918860055db2e50dacea4da8f3bc">OLDCALL</a></td></tr> 109<tr class="separator:a95560a74a89bab26cb6265dcc2bf54f6"><td class="memSeparator" colspan="2"> </td></tr> 110<tr class="memitem:ad60bf95ddad142d8d81e5e1f0a0bb6e0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="stdint_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="rledecompress_8h.html#ad60bf95ddad142d8d81e5e1f0a0bb6e0">rle_decompress</a> (void *dest, <a class="el" href="stdint_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> len) <a class="el" href="asm_2types_8h.html#a0971918860055db2e50dacea4da8f3bc">OLDCALL</a></td></tr> 111<tr class="separator:ad60bf95ddad142d8d81e5e1f0a0bb6e0"><td class="memSeparator" colspan="2"> </td></tr> 112</table> 113<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> 114<div class="textblock"><p>Decompressor for RLE encoded data</p> 115<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> 116</div><h2 class="groupheader">Macro Definition Documentation</h2> 117<a id="a2b4967f6970ecd99478db3807c68d955"></a> 118<h2 class="memtitle"><span class="permalink"><a href="#a2b4967f6970ecd99478db3807c68d955">◆ </a></span>RLE_STOP</h2> 119 120<div class="memitem"> 121<div class="memproto"> 122 <table class="memname"> 123 <tr> 124 <td class="memname">#define RLE_STOP   0</td> 125 </tr> 126 </table> 127</div><div class="memdoc"> 128 129</div> 130</div> 131<h2 class="groupheader">Function Documentation</h2> 132<a id="a95560a74a89bab26cb6265dcc2bf54f6"></a> 133<h2 class="memtitle"><span class="permalink"><a href="#a95560a74a89bab26cb6265dcc2bf54f6">◆ </a></span>rle_init()</h2> 134 135<div class="memitem"> 136<div class="memproto"> 137 <table class="memname"> 138 <tr> 139 <td class="memname"><a class="el" href="stdint_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> rle_init </td> 140 <td>(</td> 141 <td class="paramtype">void * </td> 142 <td class="paramname"><em>data</em></td><td>)</td> 143 <td></td> 144 </tr> 145 </table> 146</div><div class="memdoc"> 147<p>Initialize the RLE decompressor with RLE data at address <b>data</b></p> 148<dl class="params"><dt>Parameters</dt><dd> 149 <table class="params"> 150 <tr><td class="paramname">data</td><td>Pointer to start of RLE compressed data</td></tr> 151 </table> 152 </dd> 153</dl> 154<dl class="section see"><dt>See also</dt><dd><a class="el" href="rledecompress_8h.html#ad60bf95ddad142d8d81e5e1f0a0bb6e0">rle_decompress</a> </dd></dl> 155 156</div> 157</div> 158<a id="ad60bf95ddad142d8d81e5e1f0a0bb6e0"></a> 159<h2 class="memtitle"><span class="permalink"><a href="#ad60bf95ddad142d8d81e5e1f0a0bb6e0">◆ </a></span>rle_decompress()</h2> 160 161<div class="memitem"> 162<div class="memproto"> 163 <table class="memname"> 164 <tr> 165 <td class="memname"><a class="el" href="stdint_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> rle_decompress </td> 166 <td>(</td> 167 <td class="paramtype">void * </td> 168 <td class="paramname"><em>dest</em>, </td> 169 </tr> 170 <tr> 171 <td class="paramkey"></td> 172 <td></td> 173 <td class="paramtype"><a class="el" href="stdint_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> </td> 174 <td class="paramname"><em>len</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>Decompress RLE compressed data into <b>dest</b> for length <b>len</b> bytes</p> 184<dl class="params"><dt>Parameters</dt><dd> 185 <table class="params"> 186 <tr><td class="paramname">dest</td><td>Pointer to destination buffer/address </td></tr> 187 <tr><td class="paramname">len</td><td>number of bytes to decompress</td></tr> 188 </table> 189 </dd> 190</dl> 191<p>Before calling this function <a class="el" href="rledecompress_8h.html#a95560a74a89bab26cb6265dcc2bf54f6">rle_init</a> must be called one time to initialize the RLE decompressor.</p> 192<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> 193<dl class="section see"><dt>See also</dt><dd><a class="el" href="rledecompress_8h.html#a95560a74a89bab26cb6265dcc2bf54f6">rle_init</a> </dd></dl> 194 195</div> 196</div> 197</div><!-- contents --> 198</div><!-- doc-content --> 199<!-- HTML footer for doxygen 1.8.14--> 200<!-- start footer part --> 201<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> 202</div> 203</body> 204</html>