472 lines
37 KiB
HTML
472 lines
37 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<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.9.1"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>libctru: include/3ds/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="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" />
|
|
</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">libctru
|
|
 <span id="projectnumber">v2.4.1</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.1 -->
|
|
<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','.html');
|
|
/* @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>
|
|
<!-- 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 id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_d475325f6a9fe3bfc3a495c72a9e475e.html">3ds</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#nested-classes">Data Structures</a> |
|
|
<a href="#define-members">Macros</a> |
|
|
<a href="#typedef-members">Typedefs</a> |
|
|
<a href="#enum-members">Enumerations</a> |
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">console.h File Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>3ds stdio support.
|
|
<a href="#details">More...</a></p>
|
|
<div class="textblock"><code>#include <<a class="el" href="types_8h_source.html">3ds/types.h</a>></code><br />
|
|
<code>#include <<a class="el" href="gfx_8h_source.html">3ds/gfx.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="nested-classes"></a>
|
|
Data Structures</h2></td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structConsoleFont.html">ConsoleFont</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A font struct for the console. <a href="structConsoleFont.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structPrintConsole.html">PrintConsole</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Console structure used to store the state of a console render context. <a href="structPrintConsole.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
|
|
Macros</h2></td></tr>
|
|
<tr class="memitem:ada69da275073503a6b0edfdd19d8db8d"><td class="memItemLeft" align="right" valign="top"><a id="ada69da275073503a6b0edfdd19d8db8d"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><b>CONSOLE_ESC</b>(x)   "\x1b[" #x</td></tr>
|
|
<tr class="separator:ada69da275073503a6b0edfdd19d8db8d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5bf9ac7b2fa0c4e790ed0750a2d548ac"><td class="memItemLeft" align="right" valign="top"><a id="a5bf9ac7b2fa0c4e790ed0750a2d548ac"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><b>CONSOLE_RESET</b>   CONSOLE_ESC(0m)</td></tr>
|
|
<tr class="separator:a5bf9ac7b2fa0c4e790ed0750a2d548ac"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a32c5df90973a92f0673d1c71922a4690"><td class="memItemLeft" align="right" valign="top"><a id="a32c5df90973a92f0673d1c71922a4690"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><b>CONSOLE_BLACK</b>   CONSOLE_ESC(30m)</td></tr>
|
|
<tr class="separator:a32c5df90973a92f0673d1c71922a4690"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6972d3d624d2aeed390817b1d1b77ce8"><td class="memItemLeft" align="right" valign="top"><a id="a6972d3d624d2aeed390817b1d1b77ce8"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><b>CONSOLE_RED</b>   CONSOLE_ESC(31;1m)</td></tr>
|
|
<tr class="separator:a6972d3d624d2aeed390817b1d1b77ce8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6031939572473bdc067eeb645d6b080e"><td class="memItemLeft" align="right" valign="top"><a id="a6031939572473bdc067eeb645d6b080e"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><b>CONSOLE_GREEN</b>   CONSOLE_ESC(32;1m)</td></tr>
|
|
<tr class="separator:a6031939572473bdc067eeb645d6b080e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8e904b4ee6efda3d7017d4862766695e"><td class="memItemLeft" align="right" valign="top"><a id="a8e904b4ee6efda3d7017d4862766695e"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><b>CONSOLE_YELLOW</b>   CONSOLE_ESC(33;1m)</td></tr>
|
|
<tr class="separator:a8e904b4ee6efda3d7017d4862766695e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab1ea557c39ed061ef17bd2496cc57262"><td class="memItemLeft" align="right" valign="top"><a id="ab1ea557c39ed061ef17bd2496cc57262"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><b>CONSOLE_BLUE</b>   CONSOLE_ESC(34;1m)</td></tr>
|
|
<tr class="separator:ab1ea557c39ed061ef17bd2496cc57262"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acda5dd499ef491a51be79c1da5c077ff"><td class="memItemLeft" align="right" valign="top"><a id="acda5dd499ef491a51be79c1da5c077ff"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><b>CONSOLE_MAGENTA</b>   CONSOLE_ESC(35;1m)</td></tr>
|
|
<tr class="separator:acda5dd499ef491a51be79c1da5c077ff"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa2750ca2a5e52125aae9021551b7b346"><td class="memItemLeft" align="right" valign="top"><a id="aa2750ca2a5e52125aae9021551b7b346"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><b>CONSOLE_CYAN</b>   CONSOLE_ESC(36;1m)</td></tr>
|
|
<tr class="separator:aa2750ca2a5e52125aae9021551b7b346"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aab00c62b2da3e8468c2f6d89587f1aa9"><td class="memItemLeft" align="right" valign="top"><a id="aab00c62b2da3e8468c2f6d89587f1aa9"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><b>CONSOLE_WHITE</b>   CONSOLE_ESC(37;1m)</td></tr>
|
|
<tr class="separator:aab00c62b2da3e8468c2f6d89587f1aa9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a41fe600f48a6367d8807559efec50c23"><td class="memItemLeft" align="right" valign="top"><a id="a41fe600f48a6367d8807559efec50c23"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="console_8h.html#a41fe600f48a6367d8807559efec50c23">CONSOLE_COLOR_BOLD</a>   (1<<0)</td></tr>
|
|
<tr class="memdesc:a41fe600f48a6367d8807559efec50c23"><td class="mdescLeft"> </td><td class="mdescRight">Bold text. <br /></td></tr>
|
|
<tr class="separator:a41fe600f48a6367d8807559efec50c23"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2b150f5112f253251b71c0e20691b8f6"><td class="memItemLeft" align="right" valign="top"><a id="a2b150f5112f253251b71c0e20691b8f6"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="console_8h.html#a2b150f5112f253251b71c0e20691b8f6">CONSOLE_COLOR_FAINT</a>   (1<<1)</td></tr>
|
|
<tr class="memdesc:a2b150f5112f253251b71c0e20691b8f6"><td class="mdescLeft"> </td><td class="mdescRight">Faint text. <br /></td></tr>
|
|
<tr class="separator:a2b150f5112f253251b71c0e20691b8f6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab42f3fc96a41cf751ec6971091495d77"><td class="memItemLeft" align="right" valign="top"><a id="ab42f3fc96a41cf751ec6971091495d77"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="console_8h.html#ab42f3fc96a41cf751ec6971091495d77">CONSOLE_ITALIC</a>   (1<<2)</td></tr>
|
|
<tr class="memdesc:ab42f3fc96a41cf751ec6971091495d77"><td class="mdescLeft"> </td><td class="mdescRight">Italic text. <br /></td></tr>
|
|
<tr class="separator:ab42f3fc96a41cf751ec6971091495d77"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3d8177cdd85a63ef7836efe4e00871e0"><td class="memItemLeft" align="right" valign="top"><a id="a3d8177cdd85a63ef7836efe4e00871e0"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="console_8h.html#a3d8177cdd85a63ef7836efe4e00871e0">CONSOLE_UNDERLINE</a>   (1<<3)</td></tr>
|
|
<tr class="memdesc:a3d8177cdd85a63ef7836efe4e00871e0"><td class="mdescLeft"> </td><td class="mdescRight">Underlined text. <br /></td></tr>
|
|
<tr class="separator:a3d8177cdd85a63ef7836efe4e00871e0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adb7259b545cc753eca543d28074c4389"><td class="memItemLeft" align="right" valign="top"><a id="adb7259b545cc753eca543d28074c4389"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="console_8h.html#adb7259b545cc753eca543d28074c4389">CONSOLE_BLINK_SLOW</a>   (1<<4)</td></tr>
|
|
<tr class="memdesc:adb7259b545cc753eca543d28074c4389"><td class="mdescLeft"> </td><td class="mdescRight">Slow blinking text. <br /></td></tr>
|
|
<tr class="separator:adb7259b545cc753eca543d28074c4389"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7afdfddea655f10c609d05b686ce36f9"><td class="memItemLeft" align="right" valign="top"><a id="a7afdfddea655f10c609d05b686ce36f9"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="console_8h.html#a7afdfddea655f10c609d05b686ce36f9">CONSOLE_BLINK_FAST</a>   (1<<5)</td></tr>
|
|
<tr class="memdesc:a7afdfddea655f10c609d05b686ce36f9"><td class="mdescLeft"> </td><td class="mdescRight">Fast blinking text. <br /></td></tr>
|
|
<tr class="separator:a7afdfddea655f10c609d05b686ce36f9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0c2c4bcacad671310f6a2e19a9dd920e"><td class="memItemLeft" align="right" valign="top"><a id="a0c2c4bcacad671310f6a2e19a9dd920e"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="console_8h.html#a0c2c4bcacad671310f6a2e19a9dd920e">CONSOLE_COLOR_REVERSE</a>   (1<<6)</td></tr>
|
|
<tr class="memdesc:a0c2c4bcacad671310f6a2e19a9dd920e"><td class="mdescLeft"> </td><td class="mdescRight">Reversed color text. <br /></td></tr>
|
|
<tr class="separator:a0c2c4bcacad671310f6a2e19a9dd920e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5f2b14ddb935b78bd666e5ec560d39c1"><td class="memItemLeft" align="right" valign="top"><a id="a5f2b14ddb935b78bd666e5ec560d39c1"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="console_8h.html#a5f2b14ddb935b78bd666e5ec560d39c1">CONSOLE_CONCEAL</a>   (1<<7)</td></tr>
|
|
<tr class="memdesc:a5f2b14ddb935b78bd666e5ec560d39c1"><td class="mdescLeft"> </td><td class="mdescRight">Concealed text. <br /></td></tr>
|
|
<tr class="separator:a5f2b14ddb935b78bd666e5ec560d39c1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5ff7f67fc2b49604335c850701a49404"><td class="memItemLeft" align="right" valign="top"><a id="a5ff7f67fc2b49604335c850701a49404"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="console_8h.html#a5ff7f67fc2b49604335c850701a49404">CONSOLE_CROSSED_OUT</a>   (1<<8)</td></tr>
|
|
<tr class="memdesc:a5ff7f67fc2b49604335c850701a49404"><td class="mdescLeft"> </td><td class="mdescRight">Crossed out text. <br /></td></tr>
|
|
<tr class="separator:a5ff7f67fc2b49604335c850701a49404"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aae0fa7e2d9d00e9a9032cb27b3ea2b89"><td class="memItemLeft" align="right" valign="top"><a id="aae0fa7e2d9d00e9a9032cb27b3ea2b89"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="console_8h.html#aae0fa7e2d9d00e9a9032cb27b3ea2b89">CONSOLE_FG_CUSTOM</a>   (1<<9)</td></tr>
|
|
<tr class="memdesc:aae0fa7e2d9d00e9a9032cb27b3ea2b89"><td class="mdescLeft"> </td><td class="mdescRight">Foreground custom color. <br /></td></tr>
|
|
<tr class="separator:aae0fa7e2d9d00e9a9032cb27b3ea2b89"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2bc490632f54b282103853fa573a1d0a"><td class="memItemLeft" align="right" valign="top"><a id="a2bc490632f54b282103853fa573a1d0a"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="console_8h.html#a2bc490632f54b282103853fa573a1d0a">CONSOLE_BG_CUSTOM</a>   (1<<10)</td></tr>
|
|
<tr class="memdesc:a2bc490632f54b282103853fa573a1d0a"><td class="mdescLeft"> </td><td class="mdescRight">Background custom color. <br /></td></tr>
|
|
<tr class="separator:a2bc490632f54b282103853fa573a1d0a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
|
|
Typedefs</h2></td></tr>
|
|
<tr class="memitem:a26c9115f671528f3718cf4d9663e7631"><td class="memItemLeft" align="right" valign="top"><a id="a26c9115f671528f3718cf4d9663e7631"></a>
|
|
typedef bool(* </td><td class="memItemRight" valign="bottom"><a class="el" href="console_8h.html#a26c9115f671528f3718cf4d9663e7631">ConsolePrint</a>) (void *con, int c)</td></tr>
|
|
<tr class="memdesc:a26c9115f671528f3718cf4d9663e7631"><td class="mdescLeft"> </td><td class="mdescRight">A callback for printing a character. <br /></td></tr>
|
|
<tr class="separator:a26c9115f671528f3718cf4d9663e7631"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
|
|
Enumerations</h2></td></tr>
|
|
<tr class="memitem:ab80a9da3fec1fbf425035eeaa9b51c28"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="console_8h.html#ab80a9da3fec1fbf425035eeaa9b51c28">debugDevice</a> { <br />
|
|
  <a class="el" href="console_8h.html#ab80a9da3fec1fbf425035eeaa9b51c28af3ea53eb5c0a68a80dbeb1c0c31b6849">debugDevice_NULL</a>
|
|
, <br />
|
|
  <a class="el" href="console_8h.html#ab80a9da3fec1fbf425035eeaa9b51c28a795dfb32f1905816a543c95e5ed17b52">debugDevice_SVC</a>
|
|
, <br />
|
|
  <a class="el" href="console_8h.html#ab80a9da3fec1fbf425035eeaa9b51c28ae5f4a5fe20d1b01a2e211cfe394325d7">debugDevice_CONSOLE</a>
|
|
, <br />
|
|
  <b>debugDevice_3DMOO</b> = debugDevice_SVC
|
|
<br />
|
|
}</td></tr>
|
|
<tr class="memdesc:ab80a9da3fec1fbf425035eeaa9b51c28"><td class="mdescLeft"> </td><td class="mdescRight">Console debug devices supported by libnds. <a href="console_8h.html#ab80a9da3fec1fbf425035eeaa9b51c28">More...</a><br /></td></tr>
|
|
<tr class="separator:ab80a9da3fec1fbf425035eeaa9b51c28"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr class="memitem:a4e271d69c07c67efe877502fe17c44e5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="console_8h.html#a4e271d69c07c67efe877502fe17c44e5">consoleSetFont</a> (<a class="el" href="structPrintConsole.html">PrintConsole</a> *console, <a class="el" href="structConsoleFont.html">ConsoleFont</a> *font)</td></tr>
|
|
<tr class="memdesc:a4e271d69c07c67efe877502fe17c44e5"><td class="mdescLeft"> </td><td class="mdescRight">Loads the font into the console. <a href="console_8h.html#a4e271d69c07c67efe877502fe17c44e5">More...</a><br /></td></tr>
|
|
<tr class="separator:a4e271d69c07c67efe877502fe17c44e5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4a65cfe4467b2059c6b70e15d861b563"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="console_8h.html#a4a65cfe4467b2059c6b70e15d861b563">consoleSetWindow</a> (<a class="el" href="structPrintConsole.html">PrintConsole</a> *console, int x, int y, int width, int height)</td></tr>
|
|
<tr class="memdesc:a4a65cfe4467b2059c6b70e15d861b563"><td class="mdescLeft"> </td><td class="mdescRight">Sets the print window. <a href="console_8h.html#a4a65cfe4467b2059c6b70e15d861b563">More...</a><br /></td></tr>
|
|
<tr class="separator:a4a65cfe4467b2059c6b70e15d861b563"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a42372b48c57aeb95774e13254104def8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structPrintConsole.html">PrintConsole</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="console_8h.html#a42372b48c57aeb95774e13254104def8">consoleGetDefault</a> (void)</td></tr>
|
|
<tr class="memdesc:a42372b48c57aeb95774e13254104def8"><td class="mdescLeft"> </td><td class="mdescRight">Gets a pointer to the console with the default values. <a href="console_8h.html#a42372b48c57aeb95774e13254104def8">More...</a><br /></td></tr>
|
|
<tr class="separator:a42372b48c57aeb95774e13254104def8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac2f9e3b09fe2b65e02598ed556d9e10f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structPrintConsole.html">PrintConsole</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="console_8h.html#ac2f9e3b09fe2b65e02598ed556d9e10f">consoleSelect</a> (<a class="el" href="structPrintConsole.html">PrintConsole</a> *console)</td></tr>
|
|
<tr class="memdesc:ac2f9e3b09fe2b65e02598ed556d9e10f"><td class="mdescLeft"> </td><td class="mdescRight">Make the specified console the render target. <a href="console_8h.html#ac2f9e3b09fe2b65e02598ed556d9e10f">More...</a><br /></td></tr>
|
|
<tr class="separator:ac2f9e3b09fe2b65e02598ed556d9e10f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8e014e84f81ff901ca62d7669a8c8de8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structPrintConsole.html">PrintConsole</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="console_8h.html#a8e014e84f81ff901ca62d7669a8c8de8">consoleInit</a> (<a class="el" href="gfx_8h.html#a356112d87f5cf6bbba3ea3b6b010e09c">gfxScreen_t</a> screen, <a class="el" href="structPrintConsole.html">PrintConsole</a> *console)</td></tr>
|
|
<tr class="memdesc:a8e014e84f81ff901ca62d7669a8c8de8"><td class="mdescLeft"> </td><td class="mdescRight">Initialise the console. <a href="console_8h.html#a8e014e84f81ff901ca62d7669a8c8de8">More...</a><br /></td></tr>
|
|
<tr class="separator:a8e014e84f81ff901ca62d7669a8c8de8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac4fe073b8a8251a5216b66eef8788da2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="console_8h.html#ac4fe073b8a8251a5216b66eef8788da2">consoleDebugInit</a> (<a class="el" href="console_8h.html#ab80a9da3fec1fbf425035eeaa9b51c28">debugDevice</a> device)</td></tr>
|
|
<tr class="memdesc:ac4fe073b8a8251a5216b66eef8788da2"><td class="mdescLeft"> </td><td class="mdescRight">Initializes debug console output on stderr to the specified device. <a href="console_8h.html#ac4fe073b8a8251a5216b66eef8788da2">More...</a><br /></td></tr>
|
|
<tr class="separator:ac4fe073b8a8251a5216b66eef8788da2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac62c34a3fa2a6403c690dd80022b3e34"><td class="memItemLeft" align="right" valign="top"><a id="ac62c34a3fa2a6403c690dd80022b3e34"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="console_8h.html#ac62c34a3fa2a6403c690dd80022b3e34">consoleClear</a> (void)</td></tr>
|
|
<tr class="memdesc:ac62c34a3fa2a6403c690dd80022b3e34"><td class="mdescLeft"> </td><td class="mdescRight">Clears the screen by using iprintf("\x1b[2J");. <br /></td></tr>
|
|
<tr class="separator:ac62c34a3fa2a6403c690dd80022b3e34"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>3ds stdio support. </p>
|
|
<p>Provides stdio integration for printing to the 3DS screen as well as debug print functionality provided by stderr.</p>
|
|
<p>General usage is to initialize the console by: </p><div class="fragment"><div class="line">consoleDemoInit()</div>
|
|
</div><!-- fragment --><p> or to customize the console usage by: </p><div class="fragment"><div class="line"><a class="code" href="console_8h.html#a8e014e84f81ff901ca62d7669a8c8de8">consoleInit</a>()</div>
|
|
<div class="ttc" id="aconsole_8h_html_a8e014e84f81ff901ca62d7669a8c8de8"><div class="ttname"><a href="console_8h.html#a8e014e84f81ff901ca62d7669a8c8de8">consoleInit</a></div><div class="ttdeci">PrintConsole * consoleInit(gfxScreen_t screen, PrintConsole *console)</div><div class="ttdoc">Initialise the console.</div></div>
|
|
</div><!-- fragment --> </div><h2 class="groupheader">Enumeration Type Documentation</h2>
|
|
<a id="ab80a9da3fec1fbf425035eeaa9b51c28"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab80a9da3fec1fbf425035eeaa9b51c28">◆ </a></span>debugDevice</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="console_8h.html#ab80a9da3fec1fbf425035eeaa9b51c28">debugDevice</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Console debug devices supported by libnds. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ab80a9da3fec1fbf425035eeaa9b51c28af3ea53eb5c0a68a80dbeb1c0c31b6849"></a>debugDevice_NULL </td><td class="fielddoc"><p>Swallows prints to stderr. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="ab80a9da3fec1fbf425035eeaa9b51c28a795dfb32f1905816a543c95e5ed17b52"></a>debugDevice_SVC </td><td class="fielddoc"><p>Outputs stderr debug statements using svcOutputDebugString, which can then be captured by interactive debuggers. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="ab80a9da3fec1fbf425035eeaa9b51c28ae5f4a5fe20d1b01a2e211cfe394325d7"></a>debugDevice_CONSOLE </td><td class="fielddoc"><p>Directs stderr debug statements to 3DS console window. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a id="ac4fe073b8a8251a5216b66eef8788da2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac4fe073b8a8251a5216b66eef8788da2">◆ </a></span>consoleDebugInit()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void consoleDebugInit </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="console_8h.html#ab80a9da3fec1fbf425035eeaa9b51c28">debugDevice</a> </td>
|
|
<td class="paramname"><em>device</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Initializes debug console output on stderr to the specified device. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">device</td><td>The debug device (or devices) to output debug print statements to. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a42372b48c57aeb95774e13254104def8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a42372b48c57aeb95774e13254104def8">◆ </a></span>consoleGetDefault()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="structPrintConsole.html">PrintConsole</a>* consoleGetDefault </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets a pointer to the console with the default values. </p>
|
|
<p>This should only be used when using a single console or without changing the console that is returned, otherwise use <a class="el" href="console_8h.html#a8e014e84f81ff901ca62d7669a8c8de8" title="Initialise the console.">consoleInit()</a>. </p><dl class="section return"><dt>Returns</dt><dd>A pointer to the console with the default values. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8e014e84f81ff901ca62d7669a8c8de8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8e014e84f81ff901ca62d7669a8c8de8">◆ </a></span>consoleInit()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="structPrintConsole.html">PrintConsole</a>* consoleInit </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="gfx_8h.html#a356112d87f5cf6bbba3ea3b6b010e09c">gfxScreen_t</a> </td>
|
|
<td class="paramname"><em>screen</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="structPrintConsole.html">PrintConsole</a> * </td>
|
|
<td class="paramname"><em>console</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Initialise the console. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">screen</td><td>The screen to use for the console. </td></tr>
|
|
<tr><td class="paramname">console</td><td>A pointer to the console data to initialize (if it's NULL, the default console will be used). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A pointer to the current console. </dd></dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="app_launch_2source_2main_8c-example.html#a1">app_launch/source/main.c</a>, <a class="el" href="audio_2filters_2source_2main_8c-example.html#a3">audio/filters/source/main.c</a>, <a class="el" href="audio_2mic_2source_2main_8c-example.html#a1">audio/mic/source/main.c</a>, <a class="el" href="audio_2streaming_2source_2main_8c-example.html#a3">audio/streaming/source/main.c</a>, <a class="el" href="camera_2image_2source_2main_8c-example.html#a31">camera/image/source/main.c</a>, <a class="el" href="camera_2video_2source_2main_8c-example.html#a31">camera/video/source/main.c</a>, <a class="el" href="get_system_language_2source_2main_8c-example.html#a2">get_system_language/source/main.c</a>, <a class="el" href="graphics_2bitmap_224bit-color_2source_2main_8c-example.html#a1">graphics/bitmap/24bit-color/source/main.c</a>, <a class="el" href="graphics_2gpu_2gpusprites_2source_2main_8c-example.html#a2">graphics/gpu/gpusprites/source/main.c</a>, <a class="el" href="graphics_2gpu_2lenny_2source_2main_8c-example.html#a22">graphics/gpu/lenny/source/main.c</a>, <a class="el" href="graphics_2gpu_2mipmap_fog_2source_2main_8c-example.html#a23">graphics/gpu/mipmap_fog/source/main.c</a>, <a class="el" href="graphics_2gpu_2particles_2source_2main_8c-example.html#a35">graphics/gpu/particles/source/main.c</a>, <a class="el" href="graphics_2gpu_2proctex_2source_2main_8c-example.html#a21">graphics/gpu/proctex/source/main.c</a>, <a class="el" href="graphics_2gpu_2toon_shading_2source_2main_8c-example.html#a26">graphics/gpu/toon_shading/source/main.c</a>, <a class="el" href="graphics_2printing_2both-screen-text_2source_2main_8c-example.html#a2">graphics/printing/both-screen-text/source/main.c</a>, <a class="el" href="graphics_2printing_2colored-text_2source_2main_8c-example.html#a1">graphics/printing/colored-text/source/main.c</a>, <a class="el" href="graphics_2printing_2hello-world_2source_2main_8c-example.html#a1">graphics/printing/hello-world/source/main.c</a>, <a class="el" href="graphics_2printing_2multiple-windows-text_2source_2main_8c-example.html#a2">graphics/printing/multiple-windows-text/source/main.c</a>, <a class="el" href="input_2read-controls_2source_2main_8c-example.html#a1">input/read-controls/source/main.c</a>, <a class="el" href="input_2software-keyboard_2source_2main_8c-example.html#a4">input/software-keyboard/source/main.c</a>, <a class="el" href="input_2touch-screen_2source_2main_8c-example.html#a1">input/touch-screen/source/main.c</a>, <a class="el" href="libapplet_launch_2source_2main_8c-example.html#a1">libapplet_launch/source/main.c</a>, <a class="el" href="mvd_2source_2main_8c-example.html#a35">mvd/source/main.c</a>, <a class="el" href="network_2boss_2source_2main_8c-example.html#a19">network/boss/source/main.c</a>, <a class="el" href="network_2http_2source_2main_8c-example.html#a20">network/http/source/main.c</a>, <a class="el" href="network_2http_post_2source_2main_8c-example.html#a17">network/http_post/source/main.c</a>, <a class="el" href="network_2sockets_2source_2sockets_8c-example.html#a5">network/sockets/source/sockets.c</a>, <a class="el" href="network_2sslc_2source_2ssl_8c-example.html#a11">network/sslc/source/ssl.c</a>, <a class="el" href="network_2uds_2source_2uds_8c-example.html#a58">network/uds/source/uds.c</a>, <a class="el" href="nfc_2source_2main_8c-example.html#a37">nfc/source/main.c</a>, <a class="el" href="romfs_2source_2main_8c-example.html#a1">romfs/source/main.c</a>, <a class="el" href="threads_2event_2source_2main_8c-example.html#a4">threads/event/source/main.c</a>, <a class="el" href="threads_2thread-basic_2source_2main_8c-example.html#a3">threads/thread-basic/source/main.c</a>, and <a class="el" href="time_2rtc_2source_2main_8c-example.html#a1">time/rtc/source/main.c</a>.</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac2f9e3b09fe2b65e02598ed556d9e10f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac2f9e3b09fe2b65e02598ed556d9e10f">◆ </a></span>consoleSelect()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="structPrintConsole.html">PrintConsole</a>* consoleSelect </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structPrintConsole.html">PrintConsole</a> * </td>
|
|
<td class="paramname"><em>console</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Make the specified console the render target. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">console</td><td>A pointer to the console struct (must have been initialized with consoleInit(PrintConsole* console)). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A pointer to the previous console. </dd></dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="audio_2filters_2source_2main_8c-example.html#a5">audio/filters/source/main.c</a>, <a class="el" href="audio_2streaming_2source_2main_8c-example.html#a5">audio/streaming/source/main.c</a>, <a class="el" href="graphics_2printing_2both-screen-text_2source_2main_8c-example.html#a5">graphics/printing/both-screen-text/source/main.c</a>, and <a class="el" href="graphics_2printing_2multiple-windows-text_2source_2main_8c-example.html#a5">graphics/printing/multiple-windows-text/source/main.c</a>.</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4e271d69c07c67efe877502fe17c44e5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4e271d69c07c67efe877502fe17c44e5">◆ </a></span>consoleSetFont()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void consoleSetFont </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structPrintConsole.html">PrintConsole</a> * </td>
|
|
<td class="paramname"><em>console</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="structConsoleFont.html">ConsoleFont</a> * </td>
|
|
<td class="paramname"><em>font</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Loads the font into the console. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">console</td><td>Pointer to the console to update, if NULL it will update the current console. </td></tr>
|
|
<tr><td class="paramname">font</td><td>The font to load. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4a65cfe4467b2059c6b70e15d861b563"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4a65cfe4467b2059c6b70e15d861b563">◆ </a></span>consoleSetWindow()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void consoleSetWindow </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structPrintConsole.html">PrintConsole</a> * </td>
|
|
<td class="paramname"><em>console</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>x</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>y</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>width</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>height</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets the print window. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">console</td><td>Console to set, if NULL it will set the current console window. </td></tr>
|
|
<tr><td class="paramname">x</td><td>X location of the window. </td></tr>
|
|
<tr><td class="paramname">y</td><td>Y location of the window. </td></tr>
|
|
<tr><td class="paramname">width</td><td>Width of the window. </td></tr>
|
|
<tr><td class="paramname">height</td><td>Height of the window. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="graphics_2printing_2multiple-windows-text_2source_2main_8c-example.html#a4">graphics/printing/multiple-windows-text/source/main.c</a>.</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
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.1
|
|
</small></address>
|
|
</body>
|
|
</html>
|