189 lines
17 KiB
HTML
189 lines
17 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: PrintConsole Struct 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><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-attribs">Data Fields</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">PrintConsole Struct Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Console structure used to store the state of a console render context.
|
|
<a href="structPrintConsole.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="console_8h_source.html">console.h</a>></code></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
|
|
Data Fields</h2></td></tr>
|
|
<tr class="memitem:ad717d7741f526d595d3103d5a4e28358"><td class="memItemLeft" align="right" valign="top"><a id="ad717d7741f526d595d3103d5a4e28358"></a>
|
|
<a class="el" href="structConsoleFont.html">ConsoleFont</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structPrintConsole.html#ad717d7741f526d595d3103d5a4e28358">font</a></td></tr>
|
|
<tr class="memdesc:ad717d7741f526d595d3103d5a4e28358"><td class="mdescLeft"> </td><td class="mdescRight">Font of the console. <br /></td></tr>
|
|
<tr class="separator:ad717d7741f526d595d3103d5a4e28358"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9b70d87ea405c8761ebca625001c761e"><td class="memItemLeft" align="right" valign="top"><a id="a9b70d87ea405c8761ebca625001c761e"></a>
|
|
<a class="el" href="types_8h.html#ace9d960e74685e2cd84b36132dbbf8aa">u16</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structPrintConsole.html#a9b70d87ea405c8761ebca625001c761e">frameBuffer</a></td></tr>
|
|
<tr class="memdesc:a9b70d87ea405c8761ebca625001c761e"><td class="mdescLeft"> </td><td class="mdescRight">Framebuffer address. <br /></td></tr>
|
|
<tr class="separator:a9b70d87ea405c8761ebca625001c761e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0b3c99b23f2b228279c0b080d4bbf73f"><td class="memItemLeft" align="right" valign="top"><a id="a0b3c99b23f2b228279c0b080d4bbf73f"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><a class="el" href="structPrintConsole.html#a0b3c99b23f2b228279c0b080d4bbf73f">cursorX</a></td></tr>
|
|
<tr class="memdesc:a0b3c99b23f2b228279c0b080d4bbf73f"><td class="mdescLeft"> </td><td class="mdescRight">Current X location of the cursor (as a tile offset by default) <br /></td></tr>
|
|
<tr class="separator:a0b3c99b23f2b228279c0b080d4bbf73f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5170137741dc034414b516aebf6716d9"><td class="memItemLeft" align="right" valign="top"><a id="a5170137741dc034414b516aebf6716d9"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><a class="el" href="structPrintConsole.html#a5170137741dc034414b516aebf6716d9">cursorY</a></td></tr>
|
|
<tr class="memdesc:a5170137741dc034414b516aebf6716d9"><td class="mdescLeft"> </td><td class="mdescRight">Current Y location of the cursor (as a tile offset by default) <br /></td></tr>
|
|
<tr class="separator:a5170137741dc034414b516aebf6716d9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5597cf20da49284bcb2ccadfbd095c02"><td class="memItemLeft" align="right" valign="top"><a id="a5597cf20da49284bcb2ccadfbd095c02"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><a class="el" href="structPrintConsole.html#a5597cf20da49284bcb2ccadfbd095c02">prevCursorX</a></td></tr>
|
|
<tr class="memdesc:a5597cf20da49284bcb2ccadfbd095c02"><td class="mdescLeft"> </td><td class="mdescRight">Internal state. <br /></td></tr>
|
|
<tr class="separator:a5597cf20da49284bcb2ccadfbd095c02"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a643913cb7f20767b07ecf1652b788245"><td class="memItemLeft" align="right" valign="top"><a id="a643913cb7f20767b07ecf1652b788245"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><a class="el" href="structPrintConsole.html#a643913cb7f20767b07ecf1652b788245">prevCursorY</a></td></tr>
|
|
<tr class="memdesc:a643913cb7f20767b07ecf1652b788245"><td class="mdescLeft"> </td><td class="mdescRight">Internal state. <br /></td></tr>
|
|
<tr class="separator:a643913cb7f20767b07ecf1652b788245"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a12228047de6d55e25c7bed9427bfeda7"><td class="memItemLeft" align="right" valign="top"><a id="a12228047de6d55e25c7bed9427bfeda7"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><a class="el" href="structPrintConsole.html#a12228047de6d55e25c7bed9427bfeda7">consoleWidth</a></td></tr>
|
|
<tr class="memdesc:a12228047de6d55e25c7bed9427bfeda7"><td class="mdescLeft"> </td><td class="mdescRight">Width of the console hardware layer in characters. <br /></td></tr>
|
|
<tr class="separator:a12228047de6d55e25c7bed9427bfeda7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6caefb88745fe180a9d59096d40b052a"><td class="memItemLeft" align="right" valign="top"><a id="a6caefb88745fe180a9d59096d40b052a"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><a class="el" href="structPrintConsole.html#a6caefb88745fe180a9d59096d40b052a">consoleHeight</a></td></tr>
|
|
<tr class="memdesc:a6caefb88745fe180a9d59096d40b052a"><td class="mdescLeft"> </td><td class="mdescRight">Height of the console hardware layer in characters. <br /></td></tr>
|
|
<tr class="separator:a6caefb88745fe180a9d59096d40b052a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3238a0f3691fd3742db45df2bda726cd"><td class="memItemLeft" align="right" valign="top"><a id="a3238a0f3691fd3742db45df2bda726cd"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><a class="el" href="structPrintConsole.html#a3238a0f3691fd3742db45df2bda726cd">windowX</a></td></tr>
|
|
<tr class="memdesc:a3238a0f3691fd3742db45df2bda726cd"><td class="mdescLeft"> </td><td class="mdescRight">Window X location in characters (not implemented) <br /></td></tr>
|
|
<tr class="separator:a3238a0f3691fd3742db45df2bda726cd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af541d301e1ee4f1a8aaecca9f78d40de"><td class="memItemLeft" align="right" valign="top"><a id="af541d301e1ee4f1a8aaecca9f78d40de"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><a class="el" href="structPrintConsole.html#af541d301e1ee4f1a8aaecca9f78d40de">windowY</a></td></tr>
|
|
<tr class="memdesc:af541d301e1ee4f1a8aaecca9f78d40de"><td class="mdescLeft"> </td><td class="mdescRight">Window Y location in characters (not implemented) <br /></td></tr>
|
|
<tr class="separator:af541d301e1ee4f1a8aaecca9f78d40de"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7eaeb319aa6626250a18d52da7b57221"><td class="memItemLeft" align="right" valign="top"><a id="a7eaeb319aa6626250a18d52da7b57221"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><a class="el" href="structPrintConsole.html#a7eaeb319aa6626250a18d52da7b57221">windowWidth</a></td></tr>
|
|
<tr class="memdesc:a7eaeb319aa6626250a18d52da7b57221"><td class="mdescLeft"> </td><td class="mdescRight">Window width in characters (not implemented) <br /></td></tr>
|
|
<tr class="separator:a7eaeb319aa6626250a18d52da7b57221"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a97fa07262bd5a64ba5b5174e01e7128b"><td class="memItemLeft" align="right" valign="top"><a id="a97fa07262bd5a64ba5b5174e01e7128b"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><a class="el" href="structPrintConsole.html#a97fa07262bd5a64ba5b5174e01e7128b">windowHeight</a></td></tr>
|
|
<tr class="memdesc:a97fa07262bd5a64ba5b5174e01e7128b"><td class="mdescLeft"> </td><td class="mdescRight">Window height in characters (not implemented) <br /></td></tr>
|
|
<tr class="separator:a97fa07262bd5a64ba5b5174e01e7128b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4bd05d4de8d7869489891cbaee90c782"><td class="memItemLeft" align="right" valign="top"><a id="a4bd05d4de8d7869489891cbaee90c782"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><a class="el" href="structPrintConsole.html#a4bd05d4de8d7869489891cbaee90c782">tabSize</a></td></tr>
|
|
<tr class="memdesc:a4bd05d4de8d7869489891cbaee90c782"><td class="mdescLeft"> </td><td class="mdescRight">Size of a tab. <br /></td></tr>
|
|
<tr class="separator:a4bd05d4de8d7869489891cbaee90c782"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad329e4a7372f51e7b64cceca3be8d2df"><td class="memItemLeft" align="right" valign="top"><a id="ad329e4a7372f51e7b64cceca3be8d2df"></a>
|
|
<a class="el" href="types_8h.html#ace9d960e74685e2cd84b36132dbbf8aa">u16</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structPrintConsole.html#ad329e4a7372f51e7b64cceca3be8d2df">fg</a></td></tr>
|
|
<tr class="memdesc:ad329e4a7372f51e7b64cceca3be8d2df"><td class="mdescLeft"> </td><td class="mdescRight">Foreground color. <br /></td></tr>
|
|
<tr class="separator:ad329e4a7372f51e7b64cceca3be8d2df"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a403a10a66b1a1ff4a7c8ad78df66ac02"><td class="memItemLeft" align="right" valign="top"><a id="a403a10a66b1a1ff4a7c8ad78df66ac02"></a>
|
|
<a class="el" href="types_8h.html#ace9d960e74685e2cd84b36132dbbf8aa">u16</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structPrintConsole.html#a403a10a66b1a1ff4a7c8ad78df66ac02">bg</a></td></tr>
|
|
<tr class="memdesc:a403a10a66b1a1ff4a7c8ad78df66ac02"><td class="mdescLeft"> </td><td class="mdescRight">Background color. <br /></td></tr>
|
|
<tr class="separator:a403a10a66b1a1ff4a7c8ad78df66ac02"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a30ec62fecd8dd432fa16d17a25744538"><td class="memItemLeft" align="right" valign="top"><a id="a30ec62fecd8dd432fa16d17a25744538"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><a class="el" href="structPrintConsole.html#a30ec62fecd8dd432fa16d17a25744538">flags</a></td></tr>
|
|
<tr class="memdesc:a30ec62fecd8dd432fa16d17a25744538"><td class="mdescLeft"> </td><td class="mdescRight">Reverse/bright flags. <br /></td></tr>
|
|
<tr class="separator:a30ec62fecd8dd432fa16d17a25744538"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac2a6a9e9c3adda6c2e6ac11e4ebb7d14"><td class="memItemLeft" align="right" valign="top"><a id="ac2a6a9e9c3adda6c2e6ac11e4ebb7d14"></a>
|
|
<a class="el" href="console_8h.html#a26c9115f671528f3718cf4d9663e7631">ConsolePrint</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structPrintConsole.html#ac2a6a9e9c3adda6c2e6ac11e4ebb7d14">PrintChar</a></td></tr>
|
|
<tr class="memdesc:ac2a6a9e9c3adda6c2e6ac11e4ebb7d14"><td class="mdescLeft"> </td><td class="mdescRight">Callback for printing a character. Should return true if it has handled rendering the graphics (else the print engine will attempt to render via tiles). <br /></td></tr>
|
|
<tr class="separator:ac2a6a9e9c3adda6c2e6ac11e4ebb7d14"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abeb3c904af0e353bec10603044a4f705"><td class="memItemLeft" align="right" valign="top"><a id="abeb3c904af0e353bec10603044a4f705"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structPrintConsole.html#abeb3c904af0e353bec10603044a4f705">consoleInitialised</a></td></tr>
|
|
<tr class="memdesc:abeb3c904af0e353bec10603044a4f705"><td class="mdescLeft"> </td><td class="mdescRight">True if the console is initialized. <br /></td></tr>
|
|
<tr class="separator:abeb3c904af0e353bec10603044a4f705"><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 structure used to store the state of a console render context. </p>
|
|
<p>Default values from <a class="el" href="console_8h.html#a42372b48c57aeb95774e13254104def8" title="Gets a pointer to the console with the default values.">consoleGetDefault()</a>; </p><div class="fragment"><div class="line"><a class="code" href="structPrintConsole.html">PrintConsole</a> defaultConsole =</div>
|
|
<div class="line">{</div>
|
|
<div class="line"> <span class="comment">//Font:</span></div>
|
|
<div class="line"> {</div>
|
|
<div class="line"> (<a class="code" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a>*)default_font_bin, <span class="comment">//font gfx</span></div>
|
|
<div class="line"> 0, <span class="comment">//first ascii character in the set</span></div>
|
|
<div class="line"> 128, <span class="comment">//number of characters in the font set</span></div>
|
|
<div class="line"> },</div>
|
|
<div class="line"> 0,0, <span class="comment">//cursorX cursorY</span></div>
|
|
<div class="line"> 0,0, <span class="comment">//prevcursorX prevcursorY</span></div>
|
|
<div class="line"> 40, <span class="comment">//console width</span></div>
|
|
<div class="line"> 30, <span class="comment">//console height</span></div>
|
|
<div class="line"> 0, <span class="comment">//window x</span></div>
|
|
<div class="line"> 0, <span class="comment">//window y</span></div>
|
|
<div class="line"> 32, <span class="comment">//window width</span></div>
|
|
<div class="line"> 24, <span class="comment">//window height</span></div>
|
|
<div class="line"> 3, <span class="comment">//tab size</span></div>
|
|
<div class="line"> 0, <span class="comment">//font character offset</span></div>
|
|
<div class="line"> 0, <span class="comment">//print callback</span></div>
|
|
<div class="line"> <span class="keyword">false</span> <span class="comment">//console initialized</span></div>
|
|
<div class="line">};</div>
|
|
<div class="ttc" id="astructPrintConsole_html"><div class="ttname"><a href="structPrintConsole.html">PrintConsole</a></div><div class="ttdoc">Console structure used to store the state of a console render context.</div><div class="ttdef"><b>Definition:</b> console.h:77</div></div>
|
|
<div class="ttc" id="atypes_8h_html_a92c50087ca0e64fa93fc59402c55f8ca"><div class="ttname"><a href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a></div><div class="ttdeci">uint8_t u8</div><div class="ttdoc">would be nice if newlib had this already</div><div class="ttdef"><b>Definition:</b> types.h:21</div></div>
|
|
</div><!-- fragment --> <dl class="section examples"><dt>Examples</dt><dd><a class="el" href="audio_2filters_2source_2main_8c-example.html#_a2">audio/filters/source/main.c</a>, <a class="el" href="audio_2streaming_2source_2main_8c-example.html#_a1">audio/streaming/source/main.c</a>, <a class="el" href="graphics_2printing_2both-screen-text_2source_2main_8c-example.html#_a1">graphics/printing/both-screen-text/source/main.c</a>, and <a class="el" href="graphics_2printing_2multiple-windows-text_2source_2main_8c-example.html#_a1">graphics/printing/multiple-windows-text/source/main.c</a>.</dd>
|
|
</dl>
|
|
</div><hr/>The documentation for this struct was generated from the following file:<ul>
|
|
<li>include/3ds/<a class="el" href="console_8h_source.html">console.h</a></li>
|
|
</ul>
|
|
</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>
|