console_8h.html (11175B)
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/console.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('console_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="#func-members">Functions</a> </div> 91 <div class="headertitle"> 92<div class="title">console.h File Reference</div> </div> 93</div><!--header--> 94<div class="contents"> 95<div class="textblock"><code>#include <types.h></code><br /> 96<code>#include <<a class="el" href="stdint_8h_source.html">stdint.h</a>></code><br /> 97</div> 98<p><a href="console_8h_source.html">Go to the source code of this file.</a></p> 99<table class="memberdecls"> 100<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> 101Functions</h2></td></tr> 102<tr class="memitem:a8b4f3b427a9c6d87a09e1983df077e58"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="console_8h.html#a8b4f3b427a9c6d87a09e1983df077e58">gotoxy</a> (<a class="el" href="stdint_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> x, <a class="el" href="stdint_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> y) <a class="el" href="asm_2types_8h.html#a0971918860055db2e50dacea4da8f3bc">OLDCALL</a></td></tr> 103<tr class="separator:a8b4f3b427a9c6d87a09e1983df077e58"><td class="memSeparator" colspan="2"> </td></tr> 104<tr class="memitem:a03528dec6542c497a3645dec3e8f0770"><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="console_8h.html#a03528dec6542c497a3645dec3e8f0770">posx</a> () <a class="el" href="asm_2types_8h.html#a0971918860055db2e50dacea4da8f3bc">OLDCALL</a></td></tr> 105<tr class="separator:a03528dec6542c497a3645dec3e8f0770"><td class="memSeparator" colspan="2"> </td></tr> 106<tr class="memitem:a1e39e68fcb61161e1855b06ad5782be9"><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="console_8h.html#a1e39e68fcb61161e1855b06ad5782be9">posy</a> () <a class="el" href="asm_2types_8h.html#a0971918860055db2e50dacea4da8f3bc">OLDCALL</a></td></tr> 107<tr class="separator:a1e39e68fcb61161e1855b06ad5782be9"><td class="memSeparator" colspan="2"> </td></tr> 108<tr class="memitem:a6ce1d0ff40a295e36bcb6d495947c8dc"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="console_8h.html#a6ce1d0ff40a295e36bcb6d495947c8dc">setchar</a> (char <a class="el" href="sms_8h.html#a0b3366755f3276b0243c1e0497471b7a">c</a>) <a class="el" href="asm_2types_8h.html#a0971918860055db2e50dacea4da8f3bc">OLDCALL</a></td></tr> 109<tr class="separator:a6ce1d0ff40a295e36bcb6d495947c8dc"><td class="memSeparator" colspan="2"> </td></tr> 110<tr class="memitem:a4826277cc150ddc0f4de4bd464a34909"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="console_8h.html#a4826277cc150ddc0f4de4bd464a34909">cls</a> ()</td></tr> 111<tr class="separator:a4826277cc150ddc0f4de4bd464a34909"><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>Console functions that work like Turbo C's.</p> 115<p>The font is 8x8, making the screen 20x18 characters. </p> 116</div><h2 class="groupheader">Function Documentation</h2> 117<a id="a8b4f3b427a9c6d87a09e1983df077e58"></a> 118<h2 class="memtitle"><span class="permalink"><a href="#a8b4f3b427a9c6d87a09e1983df077e58">◆ </a></span>gotoxy()</h2> 119 120<div class="memitem"> 121<div class="memproto"> 122 <table class="memname"> 123 <tr> 124 <td class="memname">void gotoxy </td> 125 <td>(</td> 126 <td class="paramtype"><a class="el" href="stdint_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> </td> 127 <td class="paramname"><em>x</em>, </td> 128 </tr> 129 <tr> 130 <td class="paramkey"></td> 131 <td></td> 132 <td class="paramtype"><a class="el" href="stdint_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> </td> 133 <td class="paramname"><em>y</em> </td> 134 </tr> 135 <tr> 136 <td></td> 137 <td>)</td> 138 <td></td><td></td> 139 </tr> 140 </table> 141</div><div class="memdoc"> 142<p>Move the cursor to an absolute position at <b>x, y</b>.</p> 143<p><b>x</b> and <b>y</b> have units of tiles (8 pixels per unit) </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="console_8h.html#a6ce1d0ff40a295e36bcb6d495947c8dc">setchar()</a> </dd></dl> 144 145</div> 146</div> 147<a id="a03528dec6542c497a3645dec3e8f0770"></a> 148<h2 class="memtitle"><span class="permalink"><a href="#a03528dec6542c497a3645dec3e8f0770">◆ </a></span>posx()</h2> 149 150<div class="memitem"> 151<div class="memproto"> 152 <table class="memname"> 153 <tr> 154 <td class="memname"><a class="el" href="stdint_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> posx </td> 155 <td>(</td> 156 <td class="paramname"></td><td>)</td> 157 <td></td> 158 </tr> 159 </table> 160</div><div class="memdoc"> 161<p>Returns the current X position of the cursor.</p> 162<dl class="section see"><dt>See also</dt><dd><a class="el" href="console_8h.html#a8b4f3b427a9c6d87a09e1983df077e58">gotoxy()</a> </dd></dl> 163 164</div> 165</div> 166<a id="a1e39e68fcb61161e1855b06ad5782be9"></a> 167<h2 class="memtitle"><span class="permalink"><a href="#a1e39e68fcb61161e1855b06ad5782be9">◆ </a></span>posy()</h2> 168 169<div class="memitem"> 170<div class="memproto"> 171 <table class="memname"> 172 <tr> 173 <td class="memname"><a class="el" href="stdint_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> posy </td> 174 <td>(</td> 175 <td class="paramname"></td><td>)</td> 176 <td></td> 177 </tr> 178 </table> 179</div><div class="memdoc"> 180<p>Returns the current Y position of the cursor.</p> 181<dl class="section see"><dt>See also</dt><dd><a class="el" href="console_8h.html#a8b4f3b427a9c6d87a09e1983df077e58">gotoxy()</a> </dd></dl> 182 183</div> 184</div> 185<a id="a6ce1d0ff40a295e36bcb6d495947c8dc"></a> 186<h2 class="memtitle"><span class="permalink"><a href="#a6ce1d0ff40a295e36bcb6d495947c8dc">◆ </a></span>setchar()</h2> 187 188<div class="memitem"> 189<div class="memproto"> 190 <table class="memname"> 191 <tr> 192 <td class="memname">void setchar </td> 193 <td>(</td> 194 <td class="paramtype">char </td> 195 <td class="paramname"><em>c</em></td><td>)</td> 196 <td></td> 197 </tr> 198 </table> 199</div><div class="memdoc"> 200<p>Writes out a single character at the current cursor position.</p> 201<p>Does not update the cursor or interpret the character.</p> 202<dl class="section see"><dt>See also</dt><dd><a class="el" href="console_8h.html#a8b4f3b427a9c6d87a09e1983df077e58">gotoxy()</a> </dd></dl> 203 204</div> 205</div> 206<a id="a4826277cc150ddc0f4de4bd464a34909"></a> 207<h2 class="memtitle"><span class="permalink"><a href="#a4826277cc150ddc0f4de4bd464a34909">◆ </a></span>cls()</h2> 208 209<div class="memitem"> 210<div class="memproto"> 211 <table class="memname"> 212 <tr> 213 <td class="memname">void cls </td> 214 <td>(</td> 215 <td class="paramname"></td><td>)</td> 216 <td></td> 217 </tr> 218 </table> 219</div><div class="memdoc"> 220<p>Clears the screen </p> 221 222</div> 223</div> 224</div><!-- contents --> 225</div><!-- doc-content --> 226<!-- HTML footer for doxygen 1.8.14--> 227<!-- start footer part --> 228<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> 229</div> 230</body> 231</html>