git.y1.nz

gbdk-2020

GameBoy Development Kit
download: https://git.y1.nz/archives/gbdk.tar.gz
README | Files | Log | Refs | LICENSE

docs/api/stdlib_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/stdlib.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    &#160;<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&amp;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&amp;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&amp;dn=expat.txt MIT */
     83 $(document).ready(function(){initNavTree('stdlib_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">stdlib.h File Reference</div></div>
    105 </div><!--header-->
    106 <div class="contents">
    107 <div class="textblock"><code>#include &lt;<a class="el" href="types_8h_source.html">types.h</a>&gt;</code><br />
    108 </div>
    109 <p><a href="stdlib_8h_source.html">Go to the source code of this file.</a></p>
    110 <table class="memberdecls">
    111 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
    112 Functions</h2></td></tr>
    113 <tr class="memitem:exit"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="stdlib_8h.html#exit">exit</a> (int status) <a class="el" href="asm_2types_8h.html#OLDCALL">OLDCALL</a></td></tr>
    114 <tr class="separator:exit"><td class="memSeparator" colspan="2">&#160;</td></tr>
    115 <tr class="memitem:abs"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="stdlib_8h.html#abs">abs</a> (int i)</td></tr>
    116 <tr class="separator:abs"><td class="memSeparator" colspan="2">&#160;</td></tr>
    117 <tr class="memitem:labs"><td class="memItemLeft" align="right" valign="top">long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="stdlib_8h.html#labs">labs</a> (long num) <a class="el" href="asm_2types_8h.html#OLDCALL">OLDCALL</a></td></tr>
    118 <tr class="separator:labs"><td class="memSeparator" colspan="2">&#160;</td></tr>
    119 <tr class="memitem:atoi"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="stdlib_8h.html#atoi">atoi</a> (const char *s)</td></tr>
    120 <tr class="separator:atoi"><td class="memSeparator" colspan="2">&#160;</td></tr>
    121 <tr class="memitem:atol"><td class="memItemLeft" align="right" valign="top">long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="stdlib_8h.html#atol">atol</a> (const char *s)</td></tr>
    122 <tr class="separator:atol"><td class="memSeparator" colspan="2">&#160;</td></tr>
    123 <tr class="memitem:itoa"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="stdlib_8h.html#itoa">itoa</a> (int n, char *s, unsigned char radix) <a class="el" href="asm_2types_8h.html#OLDCALL">OLDCALL</a></td></tr>
    124 <tr class="separator:itoa"><td class="memSeparator" colspan="2">&#160;</td></tr>
    125 <tr class="memitem:uitoa"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="stdlib_8h.html#uitoa">uitoa</a> (unsigned int n, char *s, unsigned char radix) <a class="el" href="asm_2types_8h.html#OLDCALL">OLDCALL</a></td></tr>
    126 <tr class="separator:uitoa"><td class="memSeparator" colspan="2">&#160;</td></tr>
    127 <tr class="memitem:ltoa"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="stdlib_8h.html#ltoa">ltoa</a> (long n, char *s, unsigned char radix) <a class="el" href="asm_2types_8h.html#OLDCALL">OLDCALL</a></td></tr>
    128 <tr class="separator:ltoa"><td class="memSeparator" colspan="2">&#160;</td></tr>
    129 <tr class="memitem:ultoa"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="stdlib_8h.html#ultoa">ultoa</a> (unsigned long n, char *s, unsigned char radix) <a class="el" href="asm_2types_8h.html#OLDCALL">OLDCALL</a></td></tr>
    130 <tr class="separator:ultoa"><td class="memSeparator" colspan="2">&#160;</td></tr>
    131 <tr class="memitem:calloc"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="stdlib_8h.html#calloc">calloc</a> (<a class="el" href="asm_2mos6502_2types_8h.html#size_t">size_t</a> nmemb, <a class="el" href="asm_2mos6502_2types_8h.html#size_t">size_t</a> size)</td></tr>
    132 <tr class="separator:calloc"><td class="memSeparator" colspan="2">&#160;</td></tr>
    133 <tr class="memitem:malloc"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="stdlib_8h.html#malloc">malloc</a> (<a class="el" href="asm_2mos6502_2types_8h.html#size_t">size_t</a> size)</td></tr>
    134 <tr class="separator:malloc"><td class="memSeparator" colspan="2">&#160;</td></tr>
    135 <tr class="memitem:realloc"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="stdlib_8h.html#realloc">realloc</a> (void *ptr, <a class="el" href="asm_2mos6502_2types_8h.html#size_t">size_t</a> size)</td></tr>
    136 <tr class="separator:realloc"><td class="memSeparator" colspan="2">&#160;</td></tr>
    137 <tr class="memitem:free"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="stdlib_8h.html#free">free</a> (void *ptr)</td></tr>
    138 <tr class="separator:free"><td class="memSeparator" colspan="2">&#160;</td></tr>
    139 <tr class="memitem:bsearch"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="stdlib_8h.html#bsearch">bsearch</a> (const void *key, const void *base, <a class="el" href="asm_2mos6502_2types_8h.html#size_t">size_t</a> nmemb, <a class="el" href="asm_2mos6502_2types_8h.html#size_t">size_t</a> size, int(*compar)(const void *, const void *) REENTRANT)</td></tr>
    140 <tr class="separator:bsearch"><td class="memSeparator" colspan="2">&#160;</td></tr>
    141 <tr class="memitem:qsort"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="stdlib_8h.html#qsort">qsort</a> (void *base, <a class="el" href="asm_2mos6502_2types_8h.html#size_t">size_t</a> nmemb, <a class="el" href="asm_2mos6502_2types_8h.html#size_t">size_t</a> size, int(*compar)(const void *, const void *) REENTRANT)</td></tr>
    142 <tr class="separator:qsort"><td class="memSeparator" colspan="2">&#160;</td></tr>
    143 </table>
    144 <h2 class="groupheader">Function Documentation</h2>
    145 <a id="exit" name="exit"></a>
    146 <h2 class="memtitle"><span class="permalink"><a href="#exit">&#9670;&nbsp;</a></span>exit()</h2>
    147 
    148 <div class="memitem">
    149 <div class="memproto">
    150       <table class="memname">
    151         <tr>
    152           <td class="memname">void exit </td>
    153           <td>(</td>
    154           <td class="paramtype">int&#160;</td>
    155           <td class="paramname"><em>status</em></td><td>)</td>
    156           <td></td>
    157         </tr>
    158       </table>
    159 </div><div class="memdoc">
    160 <p >file stdlib.h 'Standard library' functions, for whatever that means. Causes normal program termination and the value of status is returned to the parent. All open streams are flushed and closed. </p>
    161 
    162 </div>
    163 </div>
    164 <a id="abs" name="abs"></a>
    165 <h2 class="memtitle"><span class="permalink"><a href="#abs">&#9670;&nbsp;</a></span>abs()</h2>
    166 
    167 <div class="memitem">
    168 <div class="memproto">
    169       <table class="memname">
    170         <tr>
    171           <td class="memname">int abs </td>
    172           <td>(</td>
    173           <td class="paramtype">int&#160;</td>
    174           <td class="paramname"><em>i</em></td><td>)</td>
    175           <td></td>
    176         </tr>
    177       </table>
    178 </div><div class="memdoc">
    179 <p >Returns the absolute value of int <b>i</b> </p><dl class="params"><dt>Parameters</dt><dd>
    180   <table class="params">
    181     <tr><td class="paramname">i</td><td>Int to obtain absolute value of</td></tr>
    182   </table>
    183   </dd>
    184 </dl>
    185 <p>If i is negative, returns -i; else returns i. </p>
    186 
    187 </div>
    188 </div>
    189 <a id="labs" name="labs"></a>
    190 <h2 class="memtitle"><span class="permalink"><a href="#labs">&#9670;&nbsp;</a></span>labs()</h2>
    191 
    192 <div class="memitem">
    193 <div class="memproto">
    194       <table class="memname">
    195         <tr>
    196           <td class="memname">long labs </td>
    197           <td>(</td>
    198           <td class="paramtype">long&#160;</td>
    199           <td class="paramname"><em>num</em></td><td>)</td>
    200           <td></td>
    201         </tr>
    202       </table>
    203 </div><div class="memdoc">
    204 <p >Returns the absolute value of long int <b>num</b></p>
    205 <dl class="params"><dt>Parameters</dt><dd>
    206   <table class="params">
    207     <tr><td class="paramname">num</td><td>Long integer to obtain absolute value of </td></tr>
    208   </table>
    209   </dd>
    210 </dl>
    211 
    212 </div>
    213 </div>
    214 <a id="atoi" name="atoi"></a>
    215 <h2 class="memtitle"><span class="permalink"><a href="#atoi">&#9670;&nbsp;</a></span>atoi()</h2>
    216 
    217 <div class="memitem">
    218 <div class="memproto">
    219       <table class="memname">
    220         <tr>
    221           <td class="memname">int atoi </td>
    222           <td>(</td>
    223           <td class="paramtype">const char *&#160;</td>
    224           <td class="paramname"><em>s</em></td><td>)</td>
    225           <td></td>
    226         </tr>
    227       </table>
    228 </div><div class="memdoc">
    229 <p >Converts an ASCII string to an int</p>
    230 <dl class="params"><dt>Parameters</dt><dd>
    231   <table class="params">
    232     <tr><td class="paramname">s</td><td>String to convert to an int</td></tr>
    233   </table>
    234   </dd>
    235 </dl>
    236 <p>The string may be of the format </p><div class="fragment"><div class="line">[\s]*[+-][<a class="code hl_variable" href="gb_8h.html#d">\d</a>]+[\D]*</div>
    237 <div class="ttc" id="agb_8h_html_d"><div class="ttname"><a href="gb_8h.html#d">d</a></div><div class="ttdeci">uint8_t d</div><div class="ttdef"><b>Definition:</b> gb.h:419</div></div>
    238 </div><!-- fragment --><p> i.e. any number of spaces, an optional + or -, then an arbitrary number of digits.</p>
    239 <p >The result is undefined if the number doesnt fit in an int.</p>
    240 <p >Returns: Int value of string </p>
    241 
    242 </div>
    243 </div>
    244 <a id="atol" name="atol"></a>
    245 <h2 class="memtitle"><span class="permalink"><a href="#atol">&#9670;&nbsp;</a></span>atol()</h2>
    246 
    247 <div class="memitem">
    248 <div class="memproto">
    249       <table class="memname">
    250         <tr>
    251           <td class="memname">long atol </td>
    252           <td>(</td>
    253           <td class="paramtype">const char *&#160;</td>
    254           <td class="paramname"><em>s</em></td><td>)</td>
    255           <td></td>
    256         </tr>
    257       </table>
    258 </div><div class="memdoc">
    259 <p >Converts an ASCII string to a long. </p><dl class="params"><dt>Parameters</dt><dd>
    260   <table class="params">
    261     <tr><td class="paramname">s</td><td>String to convert to an long int </td></tr>
    262   </table>
    263   </dd>
    264 </dl>
    265 <dl class="section see"><dt>See also</dt><dd><a class="el" href="stdlib_8h.html#atoi">atoi()</a></dd></dl>
    266 <p>Returns: Long int value of string </p>
    267 
    268 </div>
    269 </div>
    270 <a id="itoa" name="itoa"></a>
    271 <h2 class="memtitle"><span class="permalink"><a href="#itoa">&#9670;&nbsp;</a></span>itoa()</h2>
    272 
    273 <div class="memitem">
    274 <div class="memproto">
    275       <table class="memname">
    276         <tr>
    277           <td class="memname">char * itoa </td>
    278           <td>(</td>
    279           <td class="paramtype">int&#160;</td>
    280           <td class="paramname"><em>n</em>, </td>
    281         </tr>
    282         <tr>
    283           <td class="paramkey"></td>
    284           <td></td>
    285           <td class="paramtype">char *&#160;</td>
    286           <td class="paramname"><em>s</em>, </td>
    287         </tr>
    288         <tr>
    289           <td class="paramkey"></td>
    290           <td></td>
    291           <td class="paramtype">unsigned char&#160;</td>
    292           <td class="paramname"><em>radix</em>&#160;</td>
    293         </tr>
    294         <tr>
    295           <td></td>
    296           <td>)</td>
    297           <td></td><td></td>
    298         </tr>
    299       </table>
    300 </div><div class="memdoc">
    301 <p >Converts an int into a base 10 ASCII string. </p><dl class="params"><dt>Parameters</dt><dd>
    302   <table class="params">
    303     <tr><td class="paramname">n</td><td>Int to convert to a string </td></tr>
    304     <tr><td class="paramname">s</td><td>String to store the converted number </td></tr>
    305     <tr><td class="paramname">radix</td><td>Numerical base for converted number, ex: 10 is decimal base (parameter is required but not utilized on Game Boy and Analogue Pocket)</td></tr>
    306   </table>
    307   </dd>
    308 </dl>
    309 <p>Can be used with <a class="el" href="gb_8h.html#set_bkg_based_tiles">set_bkg_based_tiles()</a> for printing if the digit character tiles are not ascii-mapped.</p>
    310 <p >Returns: Pointer to converted string </p>
    311 
    312 </div>
    313 </div>
    314 <a id="uitoa" name="uitoa"></a>
    315 <h2 class="memtitle"><span class="permalink"><a href="#uitoa">&#9670;&nbsp;</a></span>uitoa()</h2>
    316 
    317 <div class="memitem">
    318 <div class="memproto">
    319       <table class="memname">
    320         <tr>
    321           <td class="memname">char * uitoa </td>
    322           <td>(</td>
    323           <td class="paramtype">unsigned int&#160;</td>
    324           <td class="paramname"><em>n</em>, </td>
    325         </tr>
    326         <tr>
    327           <td class="paramkey"></td>
    328           <td></td>
    329           <td class="paramtype">char *&#160;</td>
    330           <td class="paramname"><em>s</em>, </td>
    331         </tr>
    332         <tr>
    333           <td class="paramkey"></td>
    334           <td></td>
    335           <td class="paramtype">unsigned char&#160;</td>
    336           <td class="paramname"><em>radix</em>&#160;</td>
    337         </tr>
    338         <tr>
    339           <td></td>
    340           <td>)</td>
    341           <td></td><td></td>
    342         </tr>
    343       </table>
    344 </div><div class="memdoc">
    345 <p >Converts an unsigned int into a base 10 ASCII string. </p><dl class="params"><dt>Parameters</dt><dd>
    346   <table class="params">
    347     <tr><td class="paramname">n</td><td>Unsigned Int to convert to a string </td></tr>
    348     <tr><td class="paramname">s</td><td>String to store the converted number </td></tr>
    349     <tr><td class="paramname">radix</td><td>Numerical base for converted number, ex: 10 is decimal base (parameter is required but not utilized on Game Boy and Analogue Pocket)</td></tr>
    350   </table>
    351   </dd>
    352 </dl>
    353 <p>Can be used with <a class="el" href="gb_8h.html#set_bkg_based_tiles">set_bkg_based_tiles()</a> for printing if the digit character tiles are not ascii-mapped.</p>
    354 <p >Returns: Pointer to converted string </p>
    355 
    356 </div>
    357 </div>
    358 <a id="ltoa" name="ltoa"></a>
    359 <h2 class="memtitle"><span class="permalink"><a href="#ltoa">&#9670;&nbsp;</a></span>ltoa()</h2>
    360 
    361 <div class="memitem">
    362 <div class="memproto">
    363       <table class="memname">
    364         <tr>
    365           <td class="memname">char * ltoa </td>
    366           <td>(</td>
    367           <td class="paramtype">long&#160;</td>
    368           <td class="paramname"><em>n</em>, </td>
    369         </tr>
    370         <tr>
    371           <td class="paramkey"></td>
    372           <td></td>
    373           <td class="paramtype">char *&#160;</td>
    374           <td class="paramname"><em>s</em>, </td>
    375         </tr>
    376         <tr>
    377           <td class="paramkey"></td>
    378           <td></td>
    379           <td class="paramtype">unsigned char&#160;</td>
    380           <td class="paramname"><em>radix</em>&#160;</td>
    381         </tr>
    382         <tr>
    383           <td></td>
    384           <td>)</td>
    385           <td></td><td></td>
    386         </tr>
    387       </table>
    388 </div><div class="memdoc">
    389 <p >Converts a long into a base 10 ASCII string. </p><dl class="params"><dt>Parameters</dt><dd>
    390   <table class="params">
    391     <tr><td class="paramname">n</td><td>Long int to convert to a string </td></tr>
    392     <tr><td class="paramname">s</td><td>String to store the converted number </td></tr>
    393     <tr><td class="paramname">radix</td><td>Numerical base for converted number, ex: 10 is decimal base (parameter is required but not utilized on Game Boy and Analogue Pocket)</td></tr>
    394   </table>
    395   </dd>
    396 </dl>
    397 <p>Can be used with <a class="el" href="gb_8h.html#set_bkg_based_tiles">set_bkg_based_tiles()</a> for printing if the digit character tiles are not ascii-mapped.</p>
    398 <p >Returns: Pointer to converted string </p>
    399 
    400 </div>
    401 </div>
    402 <a id="ultoa" name="ultoa"></a>
    403 <h2 class="memtitle"><span class="permalink"><a href="#ultoa">&#9670;&nbsp;</a></span>ultoa()</h2>
    404 
    405 <div class="memitem">
    406 <div class="memproto">
    407       <table class="memname">
    408         <tr>
    409           <td class="memname">char * ultoa </td>
    410           <td>(</td>
    411           <td class="paramtype">unsigned long&#160;</td>
    412           <td class="paramname"><em>n</em>, </td>
    413         </tr>
    414         <tr>
    415           <td class="paramkey"></td>
    416           <td></td>
    417           <td class="paramtype">char *&#160;</td>
    418           <td class="paramname"><em>s</em>, </td>
    419         </tr>
    420         <tr>
    421           <td class="paramkey"></td>
    422           <td></td>
    423           <td class="paramtype">unsigned char&#160;</td>
    424           <td class="paramname"><em>radix</em>&#160;</td>
    425         </tr>
    426         <tr>
    427           <td></td>
    428           <td>)</td>
    429           <td></td><td></td>
    430         </tr>
    431       </table>
    432 </div><div class="memdoc">
    433 <p >Converts an unsigned long into a base 10 ASCII string. </p><dl class="params"><dt>Parameters</dt><dd>
    434   <table class="params">
    435     <tr><td class="paramname">n</td><td>Unsigned Long Int to convert to a string </td></tr>
    436     <tr><td class="paramname">s</td><td>String to store the converted number </td></tr>
    437     <tr><td class="paramname">radix</td><td>Numerical base for converted number, ex: 10 is decimal base (parameter is required but not utilized on Game Boy and Analogue Pocket)</td></tr>
    438   </table>
    439   </dd>
    440 </dl>
    441 <p>Can be used with <a class="el" href="gb_8h.html#set_bkg_based_tiles">set_bkg_based_tiles()</a> for printing if the digit character tiles are not ascii-mapped.</p>
    442 <p >Returns: Pointer to converted string </p>
    443 
    444 </div>
    445 </div>
    446 <a id="calloc" name="calloc"></a>
    447 <h2 class="memtitle"><span class="permalink"><a href="#calloc">&#9670;&nbsp;</a></span>calloc()</h2>
    448 
    449 <div class="memitem">
    450 <div class="memproto">
    451       <table class="memname">
    452         <tr>
    453           <td class="memname">void * calloc </td>
    454           <td>(</td>
    455           <td class="paramtype"><a class="el" href="asm_2mos6502_2types_8h.html#size_t">size_t</a>&#160;</td>
    456           <td class="paramname"><em>nmemb</em>, </td>
    457         </tr>
    458         <tr>
    459           <td class="paramkey"></td>
    460           <td></td>
    461           <td class="paramtype"><a class="el" href="asm_2mos6502_2types_8h.html#size_t">size_t</a>&#160;</td>
    462           <td class="paramname"><em>size</em>&#160;</td>
    463         </tr>
    464         <tr>
    465           <td></td>
    466           <td>)</td>
    467           <td></td><td></td>
    468         </tr>
    469       </table>
    470 </div><div class="memdoc">
    471 <p >Memory allocation functions </p>
    472 
    473 </div>
    474 </div>
    475 <a id="malloc" name="malloc"></a>
    476 <h2 class="memtitle"><span class="permalink"><a href="#malloc">&#9670;&nbsp;</a></span>malloc()</h2>
    477 
    478 <div class="memitem">
    479 <div class="memproto">
    480       <table class="memname">
    481         <tr>
    482           <td class="memname">void * malloc </td>
    483           <td>(</td>
    484           <td class="paramtype"><a class="el" href="asm_2mos6502_2types_8h.html#size_t">size_t</a>&#160;</td>
    485           <td class="paramname"><em>size</em></td><td>)</td>
    486           <td></td>
    487         </tr>
    488       </table>
    489 </div><div class="memdoc">
    490 
    491 </div>
    492 </div>
    493 <a id="realloc" name="realloc"></a>
    494 <h2 class="memtitle"><span class="permalink"><a href="#realloc">&#9670;&nbsp;</a></span>realloc()</h2>
    495 
    496 <div class="memitem">
    497 <div class="memproto">
    498       <table class="memname">
    499         <tr>
    500           <td class="memname">void * realloc </td>
    501           <td>(</td>
    502           <td class="paramtype">void *&#160;</td>
    503           <td class="paramname"><em>ptr</em>, </td>
    504         </tr>
    505         <tr>
    506           <td class="paramkey"></td>
    507           <td></td>
    508           <td class="paramtype"><a class="el" href="asm_2mos6502_2types_8h.html#size_t">size_t</a>&#160;</td>
    509           <td class="paramname"><em>size</em>&#160;</td>
    510         </tr>
    511         <tr>
    512           <td></td>
    513           <td>)</td>
    514           <td></td><td></td>
    515         </tr>
    516       </table>
    517 </div><div class="memdoc">
    518 
    519 </div>
    520 </div>
    521 <a id="free" name="free"></a>
    522 <h2 class="memtitle"><span class="permalink"><a href="#free">&#9670;&nbsp;</a></span>free()</h2>
    523 
    524 <div class="memitem">
    525 <div class="memproto">
    526       <table class="memname">
    527         <tr>
    528           <td class="memname">void free </td>
    529           <td>(</td>
    530           <td class="paramtype">void *&#160;</td>
    531           <td class="paramname"><em>ptr</em></td><td>)</td>
    532           <td></td>
    533         </tr>
    534       </table>
    535 </div><div class="memdoc">
    536 
    537 </div>
    538 </div>
    539 <a id="bsearch" name="bsearch"></a>
    540 <h2 class="memtitle"><span class="permalink"><a href="#bsearch">&#9670;&nbsp;</a></span>bsearch()</h2>
    541 
    542 <div class="memitem">
    543 <div class="memproto">
    544       <table class="memname">
    545         <tr>
    546           <td class="memname">void * bsearch </td>
    547           <td>(</td>
    548           <td class="paramtype">const void *&#160;</td>
    549           <td class="paramname"><em>key</em>, </td>
    550         </tr>
    551         <tr>
    552           <td class="paramkey"></td>
    553           <td></td>
    554           <td class="paramtype">const void *&#160;</td>
    555           <td class="paramname"><em>base</em>, </td>
    556         </tr>
    557         <tr>
    558           <td class="paramkey"></td>
    559           <td></td>
    560           <td class="paramtype"><a class="el" href="asm_2mos6502_2types_8h.html#size_t">size_t</a>&#160;</td>
    561           <td class="paramname"><em>nmemb</em>, </td>
    562         </tr>
    563         <tr>
    564           <td class="paramkey"></td>
    565           <td></td>
    566           <td class="paramtype"><a class="el" href="asm_2mos6502_2types_8h.html#size_t">size_t</a>&#160;</td>
    567           <td class="paramname"><em>size</em>, </td>
    568         </tr>
    569         <tr>
    570           <td class="paramkey"></td>
    571           <td></td>
    572           <td class="paramtype">int(*)(const void *, const void *) REENTRANT&#160;</td>
    573           <td class="paramname"><em>compar</em>&#160;</td>
    574         </tr>
    575         <tr>
    576           <td></td>
    577           <td>)</td>
    578           <td></td><td></td>
    579         </tr>
    580       </table>
    581 </div><div class="memdoc">
    582 <p >search a sorted array of <b>nmemb</b> items </p><dl class="params"><dt>Parameters</dt><dd>
    583   <table class="params">
    584     <tr><td class="paramname">key</td><td>Pointer to object that is the key for the search </td></tr>
    585     <tr><td class="paramname">base</td><td>Pointer to first object in the array to search </td></tr>
    586     <tr><td class="paramname">nmemb</td><td>Number of elements in the array </td></tr>
    587     <tr><td class="paramname">size</td><td>Size in bytes of each element in the array </td></tr>
    588     <tr><td class="paramname">compar</td><td>Function used to compare two elements of the array</td></tr>
    589   </table>
    590   </dd>
    591 </dl>
    592 <p>Returns: Pointer to array entry that matches the search key. If key is not found, NULL is returned. </p>
    593 
    594 </div>
    595 </div>
    596 <a id="qsort" name="qsort"></a>
    597 <h2 class="memtitle"><span class="permalink"><a href="#qsort">&#9670;&nbsp;</a></span>qsort()</h2>
    598 
    599 <div class="memitem">
    600 <div class="memproto">
    601       <table class="memname">
    602         <tr>
    603           <td class="memname">void qsort </td>
    604           <td>(</td>
    605           <td class="paramtype">void *&#160;</td>
    606           <td class="paramname"><em>base</em>, </td>
    607         </tr>
    608         <tr>
    609           <td class="paramkey"></td>
    610           <td></td>
    611           <td class="paramtype"><a class="el" href="asm_2mos6502_2types_8h.html#size_t">size_t</a>&#160;</td>
    612           <td class="paramname"><em>nmemb</em>, </td>
    613         </tr>
    614         <tr>
    615           <td class="paramkey"></td>
    616           <td></td>
    617           <td class="paramtype"><a class="el" href="asm_2mos6502_2types_8h.html#size_t">size_t</a>&#160;</td>
    618           <td class="paramname"><em>size</em>, </td>
    619         </tr>
    620         <tr>
    621           <td class="paramkey"></td>
    622           <td></td>
    623           <td class="paramtype">int(*)(const void *, const void *) REENTRANT&#160;</td>
    624           <td class="paramname"><em>compar</em>&#160;</td>
    625         </tr>
    626         <tr>
    627           <td></td>
    628           <td>)</td>
    629           <td></td><td></td>
    630         </tr>
    631       </table>
    632 </div><div class="memdoc">
    633 <p >Sort an array of <b>nmemb</b> items </p><dl class="params"><dt>Parameters</dt><dd>
    634   <table class="params">
    635     <tr><td class="paramname">base</td><td>Pointer to first object in the array to sort </td></tr>
    636     <tr><td class="paramname">nmemb</td><td>Number of elements in the array </td></tr>
    637     <tr><td class="paramname">size</td><td>Size in bytes of each element in the array </td></tr>
    638     <tr><td class="paramname">compar</td><td>Function used to compare and sort two elements of the array </td></tr>
    639   </table>
    640   </dd>
    641 </dl>
    642 
    643 </div>
    644 </div>
    645 </div><!-- contents -->
    646 </div><!-- doc-content -->
    647 <!-- start footer part -->
    648 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
    649   <ul>
    650     <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="stdlib_8h.html">stdlib.h</a></li>
    651     <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>
    652   </ul>
    653 </div>
    654 </body>
    655 </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.