gbdk-2020 | GameBoy Development Kit |
| download: https://git.y1.nz/archives/gbdk.tar.gz | |
| README | Files | Log | Refs | LICENSE |
docs/api/console_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/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-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('console_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">console.h File Reference</div></div>
105 </div><!--header-->
106 <div class="contents">
107 <div class="textblock"><code>#include <types.h></code><br />
108 <code>#include <<a class="el" href="stdint_8h_source.html">stdint.h</a>></code><br />
109 </div>
110 <p><a href="console_8h_source.html">Go to the source code of this file.</a></p>
111 <table class="memberdecls">
112 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
113 Functions</h2></td></tr>
114 <tr class="memitem:gotoxy"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="console_8h.html#gotoxy">gotoxy</a> (<a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> x, <a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> y) <a class="el" href="asm_2types_8h.html#OLDCALL">OLDCALL</a></td></tr>
115 <tr class="separator:gotoxy"><td class="memSeparator" colspan="2"> </td></tr>
116 <tr class="memitem:posx"><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="console_8h.html#posx">posx</a> (void) <a class="el" href="asm_2types_8h.html#OLDCALL">OLDCALL</a></td></tr>
117 <tr class="separator:posx"><td class="memSeparator" colspan="2"> </td></tr>
118 <tr class="memitem:posy"><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="console_8h.html#posy">posy</a> (void) <a class="el" href="asm_2types_8h.html#OLDCALL">OLDCALL</a></td></tr>
119 <tr class="separator:posy"><td class="memSeparator" colspan="2"> </td></tr>
120 <tr class="memitem:setchar"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="console_8h.html#setchar">setchar</a> (char <a class="el" href="sms_8h.html#c">c</a>) <a class="el" href="asm_2types_8h.html#OLDCALL">OLDCALL</a></td></tr>
121 <tr class="separator:setchar"><td class="memSeparator" colspan="2"> </td></tr>
122 <tr class="memitem:cls"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="console_8h.html#cls">cls</a> (void)</td></tr>
123 <tr class="separator:cls"><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 >Console functions that work like Turbo C's.</p>
127 <p >The font is 8x8, making the screen 20x18 characters. </p>
128 </div><h2 class="groupheader">Function Documentation</h2>
129 <a id="gotoxy" name="gotoxy"></a>
130 <h2 class="memtitle"><span class="permalink"><a href="#gotoxy">◆ </a></span>gotoxy()</h2>
131
132 <div class="memitem">
133 <div class="memproto">
134 <table class="memname">
135 <tr>
136 <td class="memname">void gotoxy </td>
137 <td>(</td>
138 <td class="paramtype"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> </td>
139 <td class="paramname"><em>x</em>, </td>
140 </tr>
141 <tr>
142 <td class="paramkey"></td>
143 <td></td>
144 <td class="paramtype"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> </td>
145 <td class="paramname"><em>y</em> </td>
146 </tr>
147 <tr>
148 <td></td>
149 <td>)</td>
150 <td></td><td></td>
151 </tr>
152 </table>
153 </div><div class="memdoc">
154 <p >Move the cursor to an absolute position at <b>x, y</b>.</p>
155 <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#setchar">setchar()</a> </dd></dl>
156
157 </div>
158 </div>
159 <a id="posx" name="posx"></a>
160 <h2 class="memtitle"><span class="permalink"><a href="#posx">◆ </a></span>posx()</h2>
161
162 <div class="memitem">
163 <div class="memproto">
164 <table class="memname">
165 <tr>
166 <td class="memname"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> posx </td>
167 <td>(</td>
168 <td class="paramtype">void </td>
169 <td class="paramname"></td><td>)</td>
170 <td></td>
171 </tr>
172 </table>
173 </div><div class="memdoc">
174 <p >Returns the current X position of the cursor.</p>
175 <dl class="section see"><dt>See also</dt><dd><a class="el" href="console_8h.html#gotoxy">gotoxy()</a> </dd></dl>
176
177 </div>
178 </div>
179 <a id="posy" name="posy"></a>
180 <h2 class="memtitle"><span class="permalink"><a href="#posy">◆ </a></span>posy()</h2>
181
182 <div class="memitem">
183 <div class="memproto">
184 <table class="memname">
185 <tr>
186 <td class="memname"><a class="el" href="stdint_8h.html#uint8_t">uint8_t</a> posy </td>
187 <td>(</td>
188 <td class="paramtype">void </td>
189 <td class="paramname"></td><td>)</td>
190 <td></td>
191 </tr>
192 </table>
193 </div><div class="memdoc">
194 <p >Returns the current Y position of the cursor.</p>
195 <dl class="section see"><dt>See also</dt><dd><a class="el" href="console_8h.html#gotoxy">gotoxy()</a> </dd></dl>
196
197 </div>
198 </div>
199 <a id="setchar" name="setchar"></a>
200 <h2 class="memtitle"><span class="permalink"><a href="#setchar">◆ </a></span>setchar()</h2>
201
202 <div class="memitem">
203 <div class="memproto">
204 <table class="memname">
205 <tr>
206 <td class="memname">void setchar </td>
207 <td>(</td>
208 <td class="paramtype">char </td>
209 <td class="paramname"><em>c</em></td><td>)</td>
210 <td></td>
211 </tr>
212 </table>
213 </div><div class="memdoc">
214 <p >Writes out a single character at the current cursor position.</p>
215 <p >Does not update the cursor or interpret the character.</p>
216 <dl class="section see"><dt>See also</dt><dd><a class="el" href="console_8h.html#gotoxy">gotoxy()</a> </dd></dl>
217
218 </div>
219 </div>
220 <a id="cls" name="cls"></a>
221 <h2 class="memtitle"><span class="permalink"><a href="#cls">◆ </a></span>cls()</h2>
222
223 <div class="memitem">
224 <div class="memproto">
225 <table class="memname">
226 <tr>
227 <td class="memname">void cls </td>
228 <td>(</td>
229 <td class="paramtype">void </td>
230 <td class="paramname"></td><td>)</td>
231 <td></td>
232 </tr>
233 </table>
234 </div><div class="memdoc">
235 <p >Clears the screen </p>
236
237 </div>
238 </div>
239 </div><!-- contents -->
240 </div><!-- doc-content -->
241 <!-- start footer part -->
242 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
243 <ul>
244 <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="console_8h.html">console.h</a></li>
245 <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>
246 </ul>
247 </div>
248 </body>
249 </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.