diff options
Diffstat (limited to 'gbdk/docs/api/console_8h.html')
| -rw-r--r-- | gbdk/docs/api/console_8h.html | 231 |
1 files changed, 231 insertions, 0 deletions
diff --git a/gbdk/docs/api/console_8h.html b/gbdk/docs/api/console_8h.html new file mode 100644 index 00000000..173241d8 --- /dev/null +++ b/gbdk/docs/api/console_8h.html @@ -0,0 +1,231 @@ +<!-- HTML header for doxygen 1.8.14--> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> +<head> +<meta http-equiv="cache-control" content="max-age=86400"/> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<meta http-equiv="X-UA-Compatible" content="IE=9"/> +<meta name="generator" content="Doxygen 1.8.20"/> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>GBDK 2020 Docs: gbdk/console.h File Reference</title> +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="jquery.js"></script> +<script type="text/javascript" src="dynsections.js"></script> +<link href="navtree.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="resize.js"></script> +<script type="text/javascript" src="navtreedata.js"></script> +<script type="text/javascript" src="navtree.js"></script> +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/searchdata.js"></script> +<script type="text/javascript" src="search/search.js"></script> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> +<link href="doxygen_extra.css" rel="stylesheet" type="text/css"/> +</head> +<body> +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr style="height: 56px;"> + <td id="projectalign" style="padding-left: 0.5em;"> + <div id="projectname">GBDK 2020 Docs +  <span id="projectnumber">4.0.6</span> + </div> + <div id="projectbrief">API Documentation for GBDK 2020</div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.20 --> +<script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +/* @license-end */ +</script> +<script type="text/javascript" src="menudata.js"></script> +<script type="text/javascript" src="menu.js"></script> +<script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +$(function() { + initMenu('',true,false,'search.php','Search'); + $(document).ready(function() { init_search(); }); +}); +/* @license-end */</script> +<div id="main-nav"></div> +</div><!-- top --> +<div id="side-nav" class="ui-resizable side-nav-resizable"> + <div id="nav-tree"> + <div id="nav-tree-contents"> + <div id="nav-sync" class="sync"></div> + </div> + </div> + <div id="splitbar" style="-moz-user-select:none;" + class="ui-resizable-handle"> + </div> +</div> +<script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +$(document).ready(function(){initNavTree('console_8h.html',''); initResizable(); }); +/* @license-end */ +</script> +<div id="doc-content"> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +</div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +<div class="header"> + <div class="summary"> +<a href="#func-members">Functions</a> </div> + <div class="headertitle"> +<div class="title">console.h File Reference</div> </div> +</div><!--header--> +<div class="contents"> +<div class="textblock"><code>#include <types.h></code><br /> +<code>#include <<a class="el" href="stdint_8h_source.html">stdint.h</a>></code><br /> +</div> +<p><a href="console_8h_source.html">Go to the source code of this file.</a></p> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> +Functions</h2></td></tr> +<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> +<tr class="separator:a8b4f3b427a9c6d87a09e1983df077e58"><td class="memSeparator" colspan="2"> </td></tr> +<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> +<tr class="separator:a03528dec6542c497a3645dec3e8f0770"><td class="memSeparator" colspan="2"> </td></tr> +<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> +<tr class="separator:a1e39e68fcb61161e1855b06ad5782be9"><td class="memSeparator" colspan="2"> </td></tr> +<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> +<tr class="separator:a6ce1d0ff40a295e36bcb6d495947c8dc"><td class="memSeparator" colspan="2"> </td></tr> +<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> +<tr class="separator:a4826277cc150ddc0f4de4bd464a34909"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p>Console functions that work like Turbo C's.</p> +<p>The font is 8x8, making the screen 20x18 characters. </p> +</div><h2 class="groupheader">Function Documentation</h2> +<a id="a8b4f3b427a9c6d87a09e1983df077e58"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a8b4f3b427a9c6d87a09e1983df077e58">◆ </a></span>gotoxy()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void gotoxy </td> + <td>(</td> + <td class="paramtype"><a class="el" href="stdint_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> </td> + <td class="paramname"><em>x</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="stdint_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> </td> + <td class="paramname"><em>y</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Move the cursor to an absolute position at <b>x, y</b>.</p> +<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> + +</div> +</div> +<a id="a03528dec6542c497a3645dec3e8f0770"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a03528dec6542c497a3645dec3e8f0770">◆ </a></span>posx()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="stdint_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> posx </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Returns the current X position of the cursor.</p> +<dl class="section see"><dt>See also</dt><dd><a class="el" href="console_8h.html#a8b4f3b427a9c6d87a09e1983df077e58">gotoxy()</a> </dd></dl> + +</div> +</div> +<a id="a1e39e68fcb61161e1855b06ad5782be9"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a1e39e68fcb61161e1855b06ad5782be9">◆ </a></span>posy()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="stdint_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> posy </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Returns the current Y position of the cursor.</p> +<dl class="section see"><dt>See also</dt><dd><a class="el" href="console_8h.html#a8b4f3b427a9c6d87a09e1983df077e58">gotoxy()</a> </dd></dl> + +</div> +</div> +<a id="a6ce1d0ff40a295e36bcb6d495947c8dc"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a6ce1d0ff40a295e36bcb6d495947c8dc">◆ </a></span>setchar()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void setchar </td> + <td>(</td> + <td class="paramtype">char </td> + <td class="paramname"><em>c</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Writes out a single character at the current cursor position.</p> +<p>Does not update the cursor or interpret the character.</p> +<dl class="section see"><dt>See also</dt><dd><a class="el" href="console_8h.html#a8b4f3b427a9c6d87a09e1983df077e58">gotoxy()</a> </dd></dl> + +</div> +</div> +<a id="a4826277cc150ddc0f4de4bd464a34909"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a4826277cc150ddc0f4de4bd464a34909">◆ </a></span>cls()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void cls </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Clears the screen </p> + +</div> +</div> +</div><!-- contents --> +</div><!-- doc-content --> +<!-- HTML footer for doxygen 1.8.14--> +<!-- start footer part --> +<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> +</div> +</body> +</html> |