mika/libnx
1
0
Fork 0
mirror of https://github.com/switchbrew/libnx.git synced 2025-06-21 12:32:40 +02:00
Code Issues Packages Projects Releases Wiki Activity
gh-pages
libnx/console_8h.html
WinterMute bf00061749 Deploying to gh-pages from @ 29f6f4fa7a 🚀
2025-05-08 06:59:12 +00:00

516 lines
37 KiB
HTML
Raw Permalink Blame History

<!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" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libnx: include/switch/runtime/devices/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 id="projectrow">
<td id="projectalign">
<div id="projectname">libnx<span id="projectnumber">&#160;v4.9.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</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_42bea3d40f1f1694e41a8f3166c98108.html">switch</a></li><li class="navelem"><a class="el" href="dir_afd0453aeaaca58db0f3a26ffe540381.html">runtime</a></li><li class="navelem"><a class="el" href="dir_8e84a2b4adc47392539d92413dc3768e.html">devices</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<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><a class="el" href="structFramebuffer.html" title="Framebuffer structure.">Framebuffer</a> text console.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &quot;<a class="el" href="types_8h_source.html">../../types.h</a>&quot;</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 id="nested-classes" name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structConsoleRenderer.html">ConsoleRenderer</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Renderer interface for the console. <a href="structConsoleRenderer.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structConsoleFont.html">ConsoleFont</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</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">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structPrintConsole.html">PrintConsole</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</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">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ada69da275073503a6b0edfdd19d8db8d" id="r_ada69da275073503a6b0edfdd19d8db8d"><td class="memItemLeft" align="right" valign="top"><a id="ada69da275073503a6b0edfdd19d8db8d" name="ada69da275073503a6b0edfdd19d8db8d"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>CONSOLE_ESC</b>(x)&#160;&#160;&#160;&quot;\x1b[&quot; #x</td></tr>
<tr class="separator:ada69da275073503a6b0edfdd19d8db8d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5bf9ac7b2fa0c4e790ed0750a2d548ac" id="r_a5bf9ac7b2fa0c4e790ed0750a2d548ac"><td class="memItemLeft" align="right" valign="top"><a id="a5bf9ac7b2fa0c4e790ed0750a2d548ac" name="a5bf9ac7b2fa0c4e790ed0750a2d548ac"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>CONSOLE_RESET</b>&#160;&#160;&#160;CONSOLE_ESC(0m)</td></tr>
<tr class="separator:a5bf9ac7b2fa0c4e790ed0750a2d548ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a32c5df90973a92f0673d1c71922a4690" id="r_a32c5df90973a92f0673d1c71922a4690"><td class="memItemLeft" align="right" valign="top"><a id="a32c5df90973a92f0673d1c71922a4690" name="a32c5df90973a92f0673d1c71922a4690"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>CONSOLE_BLACK</b>&#160;&#160;&#160;CONSOLE_ESC(30m)</td></tr>
<tr class="separator:a32c5df90973a92f0673d1c71922a4690"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6972d3d624d2aeed390817b1d1b77ce8" id="r_a6972d3d624d2aeed390817b1d1b77ce8"><td class="memItemLeft" align="right" valign="top"><a id="a6972d3d624d2aeed390817b1d1b77ce8" name="a6972d3d624d2aeed390817b1d1b77ce8"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>CONSOLE_RED</b>&#160;&#160;&#160;CONSOLE_ESC(31;1m)</td></tr>
<tr class="separator:a6972d3d624d2aeed390817b1d1b77ce8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6031939572473bdc067eeb645d6b080e" id="r_a6031939572473bdc067eeb645d6b080e"><td class="memItemLeft" align="right" valign="top"><a id="a6031939572473bdc067eeb645d6b080e" name="a6031939572473bdc067eeb645d6b080e"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>CONSOLE_GREEN</b>&#160;&#160;&#160;CONSOLE_ESC(32;1m)</td></tr>
<tr class="separator:a6031939572473bdc067eeb645d6b080e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8e904b4ee6efda3d7017d4862766695e" id="r_a8e904b4ee6efda3d7017d4862766695e"><td class="memItemLeft" align="right" valign="top"><a id="a8e904b4ee6efda3d7017d4862766695e" name="a8e904b4ee6efda3d7017d4862766695e"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>CONSOLE_YELLOW</b>&#160;&#160;&#160;CONSOLE_ESC(33;1m)</td></tr>
<tr class="separator:a8e904b4ee6efda3d7017d4862766695e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab1ea557c39ed061ef17bd2496cc57262" id="r_ab1ea557c39ed061ef17bd2496cc57262"><td class="memItemLeft" align="right" valign="top"><a id="ab1ea557c39ed061ef17bd2496cc57262" name="ab1ea557c39ed061ef17bd2496cc57262"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>CONSOLE_BLUE</b>&#160;&#160;&#160;CONSOLE_ESC(34;1m)</td></tr>
<tr class="separator:ab1ea557c39ed061ef17bd2496cc57262"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acda5dd499ef491a51be79c1da5c077ff" id="r_acda5dd499ef491a51be79c1da5c077ff"><td class="memItemLeft" align="right" valign="top"><a id="acda5dd499ef491a51be79c1da5c077ff" name="acda5dd499ef491a51be79c1da5c077ff"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>CONSOLE_MAGENTA</b>&#160;&#160;&#160;CONSOLE_ESC(35;1m)</td></tr>
<tr class="separator:acda5dd499ef491a51be79c1da5c077ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa2750ca2a5e52125aae9021551b7b346" id="r_aa2750ca2a5e52125aae9021551b7b346"><td class="memItemLeft" align="right" valign="top"><a id="aa2750ca2a5e52125aae9021551b7b346" name="aa2750ca2a5e52125aae9021551b7b346"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>CONSOLE_CYAN</b>&#160;&#160;&#160;CONSOLE_ESC(36;1m)</td></tr>
<tr class="separator:aa2750ca2a5e52125aae9021551b7b346"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aab00c62b2da3e8468c2f6d89587f1aa9" id="r_aab00c62b2da3e8468c2f6d89587f1aa9"><td class="memItemLeft" align="right" valign="top"><a id="aab00c62b2da3e8468c2f6d89587f1aa9" name="aab00c62b2da3e8468c2f6d89587f1aa9"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>CONSOLE_WHITE</b>&#160;&#160;&#160;CONSOLE_ESC(37;1m)</td></tr>
<tr class="separator:aab00c62b2da3e8468c2f6d89587f1aa9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a41fe600f48a6367d8807559efec50c23" id="r_a41fe600f48a6367d8807559efec50c23"><td class="memItemLeft" align="right" valign="top"><a id="a41fe600f48a6367d8807559efec50c23" name="a41fe600f48a6367d8807559efec50c23"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>CONSOLE_COLOR_BOLD</b>&#160;&#160;&#160;(1&lt;&lt;0)</td></tr>
<tr class="memdesc:a41fe600f48a6367d8807559efec50c23"><td class="mdescLeft">&#160;</td><td class="mdescRight">Bold text. <br /></td></tr>
<tr class="separator:a41fe600f48a6367d8807559efec50c23"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2b150f5112f253251b71c0e20691b8f6" id="r_a2b150f5112f253251b71c0e20691b8f6"><td class="memItemLeft" align="right" valign="top"><a id="a2b150f5112f253251b71c0e20691b8f6" name="a2b150f5112f253251b71c0e20691b8f6"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>CONSOLE_COLOR_FAINT</b>&#160;&#160;&#160;(1&lt;&lt;1)</td></tr>
<tr class="memdesc:a2b150f5112f253251b71c0e20691b8f6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Faint text. <br /></td></tr>
<tr class="separator:a2b150f5112f253251b71c0e20691b8f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab42f3fc96a41cf751ec6971091495d77" id="r_ab42f3fc96a41cf751ec6971091495d77"><td class="memItemLeft" align="right" valign="top"><a id="ab42f3fc96a41cf751ec6971091495d77" name="ab42f3fc96a41cf751ec6971091495d77"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>CONSOLE_ITALIC</b>&#160;&#160;&#160;(1&lt;&lt;2)</td></tr>
<tr class="memdesc:ab42f3fc96a41cf751ec6971091495d77"><td class="mdescLeft">&#160;</td><td class="mdescRight">Italic text. <br /></td></tr>
<tr class="separator:ab42f3fc96a41cf751ec6971091495d77"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3d8177cdd85a63ef7836efe4e00871e0" id="r_a3d8177cdd85a63ef7836efe4e00871e0"><td class="memItemLeft" align="right" valign="top"><a id="a3d8177cdd85a63ef7836efe4e00871e0" name="a3d8177cdd85a63ef7836efe4e00871e0"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>CONSOLE_UNDERLINE</b>&#160;&#160;&#160;(1&lt;&lt;3)</td></tr>
<tr class="memdesc:a3d8177cdd85a63ef7836efe4e00871e0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Underlined text. <br /></td></tr>
<tr class="separator:a3d8177cdd85a63ef7836efe4e00871e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adb7259b545cc753eca543d28074c4389" id="r_adb7259b545cc753eca543d28074c4389"><td class="memItemLeft" align="right" valign="top"><a id="adb7259b545cc753eca543d28074c4389" name="adb7259b545cc753eca543d28074c4389"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>CONSOLE_BLINK_SLOW</b>&#160;&#160;&#160;(1&lt;&lt;4)</td></tr>
<tr class="memdesc:adb7259b545cc753eca543d28074c4389"><td class="mdescLeft">&#160;</td><td class="mdescRight">Slow blinking text. <br /></td></tr>
<tr class="separator:adb7259b545cc753eca543d28074c4389"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7afdfddea655f10c609d05b686ce36f9" id="r_a7afdfddea655f10c609d05b686ce36f9"><td class="memItemLeft" align="right" valign="top"><a id="a7afdfddea655f10c609d05b686ce36f9" name="a7afdfddea655f10c609d05b686ce36f9"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>CONSOLE_BLINK_FAST</b>&#160;&#160;&#160;(1&lt;&lt;5)</td></tr>
<tr class="memdesc:a7afdfddea655f10c609d05b686ce36f9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fast blinking text. <br /></td></tr>
<tr class="separator:a7afdfddea655f10c609d05b686ce36f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0c2c4bcacad671310f6a2e19a9dd920e" id="r_a0c2c4bcacad671310f6a2e19a9dd920e"><td class="memItemLeft" align="right" valign="top"><a id="a0c2c4bcacad671310f6a2e19a9dd920e" name="a0c2c4bcacad671310f6a2e19a9dd920e"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>CONSOLE_COLOR_REVERSE</b>&#160;&#160;&#160;(1&lt;&lt;6)</td></tr>
<tr class="memdesc:a0c2c4bcacad671310f6a2e19a9dd920e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reversed color text. <br /></td></tr>
<tr class="separator:a0c2c4bcacad671310f6a2e19a9dd920e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5f2b14ddb935b78bd666e5ec560d39c1" id="r_a5f2b14ddb935b78bd666e5ec560d39c1"><td class="memItemLeft" align="right" valign="top"><a id="a5f2b14ddb935b78bd666e5ec560d39c1" name="a5f2b14ddb935b78bd666e5ec560d39c1"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>CONSOLE_CONCEAL</b>&#160;&#160;&#160;(1&lt;&lt;7)</td></tr>
<tr class="memdesc:a5f2b14ddb935b78bd666e5ec560d39c1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Concealed text. <br /></td></tr>
<tr class="separator:a5f2b14ddb935b78bd666e5ec560d39c1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5ff7f67fc2b49604335c850701a49404" id="r_a5ff7f67fc2b49604335c850701a49404"><td class="memItemLeft" align="right" valign="top"><a id="a5ff7f67fc2b49604335c850701a49404" name="a5ff7f67fc2b49604335c850701a49404"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>CONSOLE_CROSSED_OUT</b>&#160;&#160;&#160;(1&lt;&lt;8)</td></tr>
<tr class="memdesc:a5ff7f67fc2b49604335c850701a49404"><td class="mdescLeft">&#160;</td><td class="mdescRight">Crossed out text. <br /></td></tr>
<tr class="separator:a5ff7f67fc2b49604335c850701a49404"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aae0fa7e2d9d00e9a9032cb27b3ea2b89" id="r_aae0fa7e2d9d00e9a9032cb27b3ea2b89"><td class="memItemLeft" align="right" valign="top"><a id="aae0fa7e2d9d00e9a9032cb27b3ea2b89" name="aae0fa7e2d9d00e9a9032cb27b3ea2b89"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>CONSOLE_FG_CUSTOM</b>&#160;&#160;&#160;(1&lt;&lt;9)</td></tr>
<tr class="memdesc:aae0fa7e2d9d00e9a9032cb27b3ea2b89"><td class="mdescLeft">&#160;</td><td class="mdescRight">Foreground custom color. <br /></td></tr>
<tr class="separator:aae0fa7e2d9d00e9a9032cb27b3ea2b89"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2bc490632f54b282103853fa573a1d0a" id="r_a2bc490632f54b282103853fa573a1d0a"><td class="memItemLeft" align="right" valign="top"><a id="a2bc490632f54b282103853fa573a1d0a" name="a2bc490632f54b282103853fa573a1d0a"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>CONSOLE_BG_CUSTOM</b>&#160;&#160;&#160;(1&lt;&lt;10)</td></tr>
<tr class="memdesc:a2bc490632f54b282103853fa573a1d0a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Background custom color. <br /></td></tr>
<tr class="separator:a2bc490632f54b282103853fa573a1d0a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ab80a9da3fec1fbf425035eeaa9b51c28" id="r_ab80a9da3fec1fbf425035eeaa9b51c28"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="console_8h.html#ab80a9da3fec1fbf425035eeaa9b51c28">debugDevice</a> { <br />
&#160;&#160;<a class="el" href="console_8h.html#ab80a9da3fec1fbf425035eeaa9b51c28af3ea53eb5c0a68a80dbeb1c0c31b6849">debugDevice_NULL</a>
, <br />
&#160;&#160;<a class="el" href="console_8h.html#ab80a9da3fec1fbf425035eeaa9b51c28a795dfb32f1905816a543c95e5ed17b52">debugDevice_SVC</a>
, <br />
&#160;&#160;<a class="el" href="console_8h.html#ab80a9da3fec1fbf425035eeaa9b51c28ae5f4a5fe20d1b01a2e211cfe394325d7">debugDevice_CONSOLE</a>
<br />
}</td></tr>
<tr class="memdesc:ab80a9da3fec1fbf425035eeaa9b51c28"><td class="mdescLeft">&#160;</td><td class="mdescRight">Console debug devices supported by libnx. <a href="console_8h.html#ab80a9da3fec1fbf425035eeaa9b51c28">More...</a><br /></td></tr>
<tr class="separator:ab80a9da3fec1fbf425035eeaa9b51c28"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a4e271d69c07c67efe877502fe17c44e5" id="r_a4e271d69c07c67efe877502fe17c44e5"><td class="memItemLeft" align="right" valign="top">void&#160;</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">&#160;</td><td class="mdescRight">Loads the font into the console. <br /></td></tr>
<tr class="separator:a4e271d69c07c67efe877502fe17c44e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4a65cfe4467b2059c6b70e15d861b563" id="r_a4a65cfe4467b2059c6b70e15d861b563"><td class="memItemLeft" align="right" valign="top">void&#160;</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">&#160;</td><td class="mdescRight">Sets the print window. <br /></td></tr>
<tr class="separator:a4a65cfe4467b2059c6b70e15d861b563"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a75750f9ddbb62e857309d791e6fcf749" id="r_a75750f9ddbb62e857309d791e6fcf749"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structPrintConsole.html">PrintConsole</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="console_8h.html#a75750f9ddbb62e857309d791e6fcf749">consoleGetDefault</a> (void)</td></tr>
<tr class="memdesc:a75750f9ddbb62e857309d791e6fcf749"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets a pointer to the console with the default values. <br /></td></tr>
<tr class="separator:a75750f9ddbb62e857309d791e6fcf749"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8ca43733c23082493ee102331db6f875" id="r_a8ca43733c23082493ee102331db6f875"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structPrintConsole.html">PrintConsole</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="console_8h.html#a8ca43733c23082493ee102331db6f875">consoleSelect</a> (<a class="el" href="structPrintConsole.html">PrintConsole</a> *console)</td></tr>
<tr class="memdesc:a8ca43733c23082493ee102331db6f875"><td class="mdescLeft">&#160;</td><td class="mdescRight">Make the specified console the render target. <br /></td></tr>
<tr class="separator:a8ca43733c23082493ee102331db6f875"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5a752134c293188a41bed497d35b5486" id="r_a5a752134c293188a41bed497d35b5486"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structPrintConsole.html">PrintConsole</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="console_8h.html#a5a752134c293188a41bed497d35b5486">consoleInit</a> (<a class="el" href="structPrintConsole.html">PrintConsole</a> *console)</td></tr>
<tr class="memdesc:a5a752134c293188a41bed497d35b5486"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialise the console. <br /></td></tr>
<tr class="separator:a5a752134c293188a41bed497d35b5486"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a19f5241173feabf57680aedb05bbfdbf" id="r_a19f5241173feabf57680aedb05bbfdbf"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="console_8h.html#a19f5241173feabf57680aedb05bbfdbf">consoleExit</a> (<a class="el" href="structPrintConsole.html">PrintConsole</a> *console)</td></tr>
<tr class="memdesc:a19f5241173feabf57680aedb05bbfdbf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Deinitialise the console. <br /></td></tr>
<tr class="separator:a19f5241173feabf57680aedb05bbfdbf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a794ce951e8494348596902cf2d7df0bf" id="r_a794ce951e8494348596902cf2d7df0bf"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="console_8h.html#a794ce951e8494348596902cf2d7df0bf">consoleUpdate</a> (<a class="el" href="structPrintConsole.html">PrintConsole</a> *console)</td></tr>
<tr class="memdesc:a794ce951e8494348596902cf2d7df0bf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Updates the console, submitting a new frame to the display. <br /></td></tr>
<tr class="separator:a794ce951e8494348596902cf2d7df0bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac4fe073b8a8251a5216b66eef8788da2" id="r_ac4fe073b8a8251a5216b66eef8788da2"><td class="memItemLeft" align="right" valign="top">void&#160;</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">&#160;</td><td class="mdescRight">Initializes debug console output on stderr to the specified device. <br /></td></tr>
<tr class="separator:ac4fe073b8a8251a5216b66eef8788da2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac62c34a3fa2a6403c690dd80022b3e34" id="r_ac62c34a3fa2a6403c690dd80022b3e34"><td class="memItemLeft" align="right" valign="top"><a id="ac62c34a3fa2a6403c690dd80022b3e34" name="ac62c34a3fa2a6403c690dd80022b3e34"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>consoleClear</b> (void)</td></tr>
<tr class="memdesc:ac62c34a3fa2a6403c690dd80022b3e34"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clears the screan by using printf("\x1b[2J");. <br /></td></tr>
<tr class="separator:ac62c34a3fa2a6403c690dd80022b3e34"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="structFramebuffer.html" title="Framebuffer structure.">Framebuffer</a> text console. </p>
<dl class="section author"><dt>Author</dt><dd>yellows8 </dd>
<dd>
WinterMute </dd></dl>
<dl class="section copyright"><dt>Copyright</dt><dd>libnx Authors</dd></dl>
<p>Provides stdio integration for printing to the Switch 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"><a class="code hl_function" href="console_8h.html#a5a752134c293188a41bed497d35b5486">consoleInit</a>(NULL)</div>
<div class="ttc" id="aconsole_8h_html_a5a752134c293188a41bed497d35b5486"><div class="ttname"><a href="console_8h.html#a5a752134c293188a41bed497d35b5486">consoleInit</a></div><div class="ttdeci">PrintConsole * consoleInit(PrintConsole *console)</div><div class="ttdoc">Initialise the console.</div></div>
</div><!-- fragment --><p> optionally customizing the console usage by passing a pointer to a custom <a class="el" href="structPrintConsole.html" title="Console structure used to store the state of a console render context.">PrintConsole</a> struct. </p>
</div><h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="ab80a9da3fec1fbf425035eeaa9b51c28" name="ab80a9da3fec1fbf425035eeaa9b51c28"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab80a9da3fec1fbf425035eeaa9b51c28">&#9670;&#160;</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 libnx. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ab80a9da3fec1fbf425035eeaa9b51c28af3ea53eb5c0a68a80dbeb1c0c31b6849" name="ab80a9da3fec1fbf425035eeaa9b51c28af3ea53eb5c0a68a80dbeb1c0c31b6849"></a>debugDevice_NULL&#160;</td><td class="fielddoc"><p>Swallows prints to stderr. </p>
</td></tr>
<tr><td class="fieldname"><a id="ab80a9da3fec1fbf425035eeaa9b51c28a795dfb32f1905816a543c95e5ed17b52" name="ab80a9da3fec1fbf425035eeaa9b51c28a795dfb32f1905816a543c95e5ed17b52"></a>debugDevice_SVC&#160;</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" name="ab80a9da3fec1fbf425035eeaa9b51c28ae5f4a5fe20d1b01a2e211cfe394325d7"></a>debugDevice_CONSOLE&#160;</td><td class="fielddoc"><p>Directs stderr debug statements to Switch console window. </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ac4fe073b8a8251a5216b66eef8788da2" name="ac4fe073b8a8251a5216b66eef8788da2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac4fe073b8a8251a5216b66eef8788da2">&#9670;&#160;</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>&#160;</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="a19f5241173feabf57680aedb05bbfdbf" name="a19f5241173feabf57680aedb05bbfdbf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a19f5241173feabf57680aedb05bbfdbf">&#9670;&#160;</a></span>consoleExit()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void consoleExit </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structPrintConsole.html">PrintConsole</a> *&#160;</td>
<td class="paramname"><em>console</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Deinitialise the console. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<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>
</div>
</div>
<a id="a75750f9ddbb62e857309d791e6fcf749" name="a75750f9ddbb62e857309d791e6fcf749"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a75750f9ddbb62e857309d791e6fcf749">&#9670;&#160;</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&#160;</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#a5a752134c293188a41bed497d35b5486" 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="a5a752134c293188a41bed497d35b5486" name="a5a752134c293188a41bed497d35b5486"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5a752134c293188a41bed497d35b5486">&#9670;&#160;</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="structPrintConsole.html">PrintConsole</a> *&#160;</td>
<td class="paramname"><em>console</em></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">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>
</div>
</div>
<a id="a8ca43733c23082493ee102331db6f875" name="a8ca43733c23082493ee102331db6f875"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8ca43733c23082493ee102331db6f875">&#9670;&#160;</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> *&#160;</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 <a class="el" href="console_8h.html#a5a752134c293188a41bed497d35b5486" title="Initialise the console.">consoleInit(PrintConsole* console)</a>). </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A pointer to the previous console. </dd></dl>
</div>
</div>
<a id="a4e271d69c07c67efe877502fe17c44e5" name="a4e271d69c07c67efe877502fe17c44e5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4e271d69c07c67efe877502fe17c44e5">&#9670;&#160;</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> *&#160;</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> *&#160;</td>
<td class="paramname"><em>font</em>&#160;</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" name="a4a65cfe4467b2059c6b70e15d861b563"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4a65cfe4467b2059c6b70e15d861b563">&#9670;&#160;</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> *&#160;</td>
<td class="paramname"><em>console</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>width</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>height</em>&#160;</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>
</div>
</div>
<a id="a794ce951e8494348596902cf2d7df0bf" name="a794ce951e8494348596902cf2d7df0bf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a794ce951e8494348596902cf2d7df0bf">&#9670;&#160;</a></span>consoleUpdate()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void consoleUpdate </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structPrintConsole.html">PrintConsole</a> *&#160;</td>
<td class="paramname"><em>console</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Updates the console, submitting a new frame to the display. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<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 remark"><dt>Remarks</dt><dd>This function should be called periodically. Failure to call this function will result in lack of screen updating. </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink