mirror of
https://github.com/ArthurSonzogni/FTXUI.git
synced 2025-12-16 01:48:56 +08:00
317 lines
22 KiB
HTML
317 lines
22 KiB
HTML
|
<!-- HTML header for doxygen 1.9.8-->
|
||
|
|
<!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.12.0"/>
|
||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
||
|
|
<title>FTXUI: Module screen</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>
|
||
|
|
<script type="text/javascript" src="doxygen-awesome-fragment-copy-button.js"></script>
|
||
|
|
<script type="text/javascript" src="doxygen-awesome-paragraph-link.js"></script>
|
||
|
|
<script type="text/javascript" src="doxygen-awesome-interactive-toc.js"></script>
|
||
|
|
<script type="text/javascript" src="doxygen-awesome-tabs.js"></script>
|
||
|
|
<script type="text/javascript">
|
||
|
|
DoxygenAwesomeFragmentCopyButton.init()
|
||
|
|
DoxygenAwesomeParagraphLink.init()
|
||
|
|
DoxygenAwesomeInteractiveToc.init()
|
||
|
|
DoxygenAwesomeTabs.init()
|
||
|
|
window.addEventListener('DOMContentLoaded', function () {
|
||
|
|
document.querySelectorAll(".headertitle").forEach(div => {
|
||
|
|
// Hide progressively the title.
|
||
|
|
if (div.textContent != "Getting Started" &&
|
||
|
|
div.textContent != "Installation" &&
|
||
|
|
div.textContent != "Modules" &&
|
||
|
|
true) {
|
||
|
|
return;
|
||
|
|
}
|
||
|
|
div.style.display = "none";
|
||
|
|
// Show progressively the image.
|
||
|
|
const img = document.querySelector("img.inline");
|
||
|
|
img.style.maxHeight = "40vh";
|
||
|
|
img.style.maxWidth = "100%";
|
||
|
|
img.style.objectFit = "contain";
|
||
|
|
});
|
||
|
|
});
|
||
|
|
</script>
|
||
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
||
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
||
|
|
<script type="text/javascript" src="navtree.js"></script>
|
||
|
|
<script type="text/javascript" src="resize.js"></script>
|
||
|
|
<script type="text/javascript" src="cookie.js"></script>
|
||
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
||
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
||
|
|
<script type="text/javascript" src="search/search.js"></script>
|
||
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
||
|
|
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
|
||
|
|
<link href="stylesheet.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">FTXUI<span id="projectnumber"> 6.1.9</span>
|
||
|
|
</div>
|
||
|
|
<div id="projectbrief">C++ functional terminal UI.</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<!-- end header part -->
|
||
|
|
<!-- Generated by Doxygen 1.12.0 -->
|
||
|
|
<script type="text/javascript">
|
||
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
||
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
||
|
|
/* @license-end */
|
||
|
|
</script>
|
||
|
|
<script type="text/javascript">
|
||
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
||
|
|
$(function() { codefold.init(0); });
|
||
|
|
/* @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&dn=expat.txt MIT */
|
||
|
|
$(function() {
|
||
|
|
initMenu('',true,false,'search.php','Search',true);
|
||
|
|
$(function() { init_search(); });
|
||
|
|
});
|
||
|
|
/* @license-end */
|
||
|
|
</script>
|
||
|
|
<div id="main-nav"></div>
|
||
|
|
</div><!-- top -->
|
||
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
||
|
|
<div id="nav-tree">
|
||
|
|
<div id="nav-tree-contents">
|
||
|
|
<div id="nav-sync" class="sync"></div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
||
|
|
class="ui-resizable-handle">
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<script type="text/javascript">
|
||
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
||
|
|
$(function(){initNavTree('module-screen.html',''); initResizable(true); });
|
||
|
|
/* @license-end */
|
||
|
|
</script>
|
||
|
|
<div id="doc-content">
|
||
|
|
<!-- window showing the filter options -->
|
||
|
|
<div id="MSearchSelectWindow"
|
||
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
||
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
||
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<!-- iframe showing the search results (closed by default) -->
|
||
|
|
<div id="MSearchResultsWindow">
|
||
|
|
<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><div class="header">
|
||
|
|
<div class="headertitle"><div class="title">Module screen</div></div>
|
||
|
|
</div><!--header-->
|
||
|
|
<div class="contents">
|
||
|
|
<div class="toc"><h3>Table of Contents</h3>
|
||
|
|
<ul>
|
||
|
|
<li class="level1">
|
||
|
|
<a href="#autotoc_md26">ftxui::Screen</a>
|
||
|
|
</li>
|
||
|
|
<li class="level1">
|
||
|
|
<a href="#autotoc_md28">ftxui::Dimension</a>
|
||
|
|
</li>
|
||
|
|
<li class="level1">
|
||
|
|
<a href="#autotoc_md30">ftxui::Pixel</a>
|
||
|
|
</li>
|
||
|
|
<li class="level1">
|
||
|
|
<a href="#autotoc_md32">ftxui::Color</a>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
<div class="textblock"><p>The <code>ftxui::screen</code> module is the low-level foundation. It can be used standalone, but it is primarily designed to be used together by <a href="module-dom.html">ftxui::dom</a> and <a href="module-component.html">ftxui::component</a> modules.</p>
|
||
|
|
<p>It provides a <a class="el" href="classftxui_1_1Screen.html">ftxui::Screen</a>.</p>
|
||
|
|
<hr />
|
||
|
|
<h1><a class="anchor" id="autotoc_md26"></a>
|
||
|
|
ftxui::Screen</h1>
|
||
|
|
<p>The <a class="el" href="classftxui_1_1Screen.html">ftxui::Screen</a> class represents a 2D grid of styled characters that can be rendered to a terminal. <br />
|
||
|
|
It provides methods to create a screen, access pixels, and render elements.</p>
|
||
|
|
<p>You can access the individual cells (<a class="el" href="structftxui_1_1Pixel.html">ftxui::Pixel</a>) of the screen using the <a class="el" href="classftxui_1_1Image.html#a483f8ee1967e200cfc9e277b3ce00174">ftxui::Screen::PixelAt</a> method, which returns a reference to the pixel at the specified coordinates.</p>
|
||
|
|
<p><b>Example</b> </p><div class="fragment"><div class="line"><span class="preprocessor">#include <<a class="code" href="screen_8hpp.html">ftxui/screen/screen.hpp</a>></span></div>
|
||
|
|
<div class="line"><span class="preprocessor">#include <<a class="code" href="color_8hpp.html">ftxui/screen/color.hpp</a>></span></div>
|
||
|
|
<div class="line"> </div>
|
||
|
|
<div class="line"><span class="keywordtype">void</span> <a class="code hl_function" href="examples_2component_2button_8cpp.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main</a>() {</div>
|
||
|
|
<div class="line"> <span class="keyword">auto</span> screen = <a class="code hl_function" href="classftxui_1_1Screen.html#a32b98be0603ace46d6dc9d05b330a9fd">ftxui::Screen::Create</a>(</div>
|
||
|
|
<div class="line"> <a class="code hl_function" href="namespaceftxui_1_1Dimension.html#af795790b995132f62de607ddfd07f9fa">ftxui::Dimension::Full</a>(), <span class="comment">// Use full terminal width</span></div>
|
||
|
|
<div class="line"> <a class="code hl_function" href="namespaceftxui_1_1Dimension.html#a36e539ed36f88d7f01233974da485937">ftxui::Dimension::Fixed</a>(10) <span class="comment">// Fixed height of 10 rows</span></div>
|
||
|
|
<div class="line"> );</div>
|
||
|
|
<div class="line"> </div>
|
||
|
|
<div class="line"> <span class="comment">// Access a specific pixel at (10, 5)</span></div>
|
||
|
|
<div class="line"> <span class="keyword">auto</span>& pixel = screen.PixelAt(10, 5);</div>
|
||
|
|
<div class="line"> </div>
|
||
|
|
<div class="line"> <span class="comment">// Set properties of the pixel.</span></div>
|
||
|
|
<div class="line"> pixel.character = U<span class="charliteral">'X'</span>;</div>
|
||
|
|
<div class="line"> pixel.foreground_color = <a class="code hl_enumvalue" href="classftxui_1_1Color.html#ae2b6d9670960e89c66d7b76167a0802fad3163c1fcda01965b692ec2c3122b743">ftxui::Color::Red</a>;</div>
|
||
|
|
<div class="line"> pixel.background_color = <a class="code hl_function" href="classftxui_1_1Color.html#aacec69e0aa1063fbec2cc305e7b076dd">ftxui::Color::RGB</a>(0, 255, 0);</div>
|
||
|
|
<div class="line"> pixel.bold = <span class="keyword">true</span>; <span class="comment">// Set bold style</span></div>
|
||
|
|
<div class="line"> screen.Print(); <span class="comment">// Print the screen to the terminal</span></div>
|
||
|
|
<div class="line">}</div>
|
||
|
|
<div class="ttc" id="aclassftxui_1_1Color_html_aacec69e0aa1063fbec2cc305e7b076dd"><div class="ttname"><a href="classftxui_1_1Color.html#aacec69e0aa1063fbec2cc305e7b076dd">ftxui::Color::RGB</a></div><div class="ttdeci">static Color RGB(uint8_t red, uint8_t green, uint8_t blue)</div><div class="ttdoc">Build a Color from its RGB representation. https://en.wikipedia.org/wiki/RGB_color_model.</div><div class="ttdef"><b>Definition</b> <a href="screen_2color_8cpp_source.html#l00153">screen/color.cpp:153</a></div></div>
|
||
|
|
<div class="ttc" id="aclassftxui_1_1Color_html_ae2b6d9670960e89c66d7b76167a0802fad3163c1fcda01965b692ec2c3122b743"><div class="ttname"><a href="classftxui_1_1Color.html#ae2b6d9670960e89c66d7b76167a0802fad3163c1fcda01965b692ec2c3122b743">ftxui::Color::Red</a></div><div class="ttdeci">@ Red</div><div class="ttdef"><b>Definition</b> <a href="color_8hpp_source.html#l00053">color.hpp:53</a></div></div>
|
||
|
|
<div class="ttc" id="aclassftxui_1_1Screen_html_a32b98be0603ace46d6dc9d05b330a9fd"><div class="ttname"><a href="classftxui_1_1Screen.html#a32b98be0603ace46d6dc9d05b330a9fd">ftxui::Screen::Create</a></div><div class="ttdeci">static Screen Create(Dimensions dimension)</div><div class="ttdoc">Create a screen with the given dimension.</div><div class="ttdef"><b>Definition</b> <a href="screen_8cpp_source.html#l00394">screen.cpp:394</a></div></div>
|
||
|
|
<div class="ttc" id="acolor_8hpp_html"><div class="ttname"><a href="color_8hpp.html">color.hpp</a></div></div>
|
||
|
|
<div class="ttc" id="aexamples_2component_2button_8cpp_html_ae66f6b31b5ad750f1fe042a706a4e3d4"><div class="ttname"><a href="examples_2component_2button_8cpp.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main</a></div><div class="ttdeci">int main()</div><div class="ttdef"><b>Definition</b> <a href="examples_2component_2button_8cpp_source.html#l00004">examples/component/button.cpp:4</a></div></div>
|
||
|
|
<div class="ttc" id="anamespaceftxui_1_1Dimension_html_a36e539ed36f88d7f01233974da485937"><div class="ttname"><a href="namespaceftxui_1_1Dimension.html#a36e539ed36f88d7f01233974da485937">ftxui::Dimension::Fixed</a></div><div class="ttdeci">Dimensions Fixed(int)</div></div>
|
||
|
|
<div class="ttc" id="anamespaceftxui_1_1Dimension_html_af795790b995132f62de607ddfd07f9fa"><div class="ttname"><a href="namespaceftxui_1_1Dimension.html#af795790b995132f62de607ddfd07f9fa">ftxui::Dimension::Full</a></div><div class="ttdeci">Dimensions Full()</div></div>
|
||
|
|
<div class="ttc" id="ascreen_8hpp_html"><div class="ttname"><a href="screen_8hpp.html">screen.hpp</a></div></div>
|
||
|
|
</div><!-- fragment --><dl class="section note"><dt>Note</dt><dd>If the coordinates are out of bounds, a dummy pixel is returned.</dd></dl>
|
||
|
|
<p>The screen can be printed to the terminal using <a class="el" href="classftxui_1_1Screen.html#ad93edbe885499a712129356f1ffd506b">ftxui::Screen::Print()</a> or converted to a std::string with <a class="el" href="classftxui_1_1Screen.html#a19c380b03cea21d7ac7325136a131ff0">ftxui::Screen::ToString()</a>.</p>
|
||
|
|
<div class="tabbed"></div><div class="tabbed"><ul>
|
||
|
|
<li><b class="tab-title">Print()</b> <div class="fragment"><div class="line"><span class="keyword">auto</span> screen = ...;</div>
|
||
|
|
<div class="line">screen.Print();</div>
|
||
|
|
</div><!-- fragment --></li>
|
||
|
|
<li><b class="tab-title">ToString()</b> <div class="fragment"><div class="line"><span class="keyword">auto</span> screen = ...;</div>
|
||
|
|
<div class="line">std::cout << screen.ToString();</div>
|
||
|
|
</div><!-- fragment --></li>
|
||
|
|
</ul>
|
||
|
|
</div><div class="tabbed"></div><p>Note that you can reset the cursor position to the top-left corner of the screen after printing by calling ftxui::Screen::ResetCursorPosition().</p>
|
||
|
|
<p><b>Example</b> </p><div class="fragment"><div class="line"><span class="keyword">auto</span> screen = ...;</div>
|
||
|
|
<div class="line"><span class="keywordflow">while</span>(<span class="keyword">true</span>) {</div>
|
||
|
|
<div class="line"> <span class="comment">// Drawing operations:</span></div>
|
||
|
|
<div class="line"> ...</div>
|
||
|
|
<div class="line"> </div>
|
||
|
|
<div class="line"> <span class="comment">// Print the screen to the terminal. Then reset the cursor position and the</span></div>
|
||
|
|
<div class="line"> <span class="comment">// screen content.</span></div>
|
||
|
|
<div class="line"> std::cout << screen.ToString();</div>
|
||
|
|
<div class="line"> std::cout << screen.ResetCursorPosition(<span class="comment">/*clear=*/</span><span class="keyword">true</span>);</div>
|
||
|
|
<div class="line"> std::cout << std::flush;</div>
|
||
|
|
<div class="line"> </div>
|
||
|
|
<div class="line"> <span class="comment">// Sleep for a short duration to control the refresh rate.</span></div>
|
||
|
|
<div class="line"> std::this_thread::sleep_for(std::chrono::milliseconds(100));</div>
|
||
|
|
<div class="line">}</div>
|
||
|
|
</div><!-- fragment --><hr />
|
||
|
|
<h1><a class="anchor" id="autotoc_md28"></a>
|
||
|
|
ftxui::Dimension</h1>
|
||
|
|
<p>The <a class="el" href="namespaceftxui_1_1Dimension.html">ftxui::Dimension</a> utility controls screen sizing:</p>
|
||
|
|
<ul>
|
||
|
|
<li><code>Dimension::Full()</code> — use full terminal width or height</li>
|
||
|
|
<li><code>Dimension::Fit(element)</code> — size to fit the rendered <a class="el" href="namespaceftxui.html#a2bc31f2d685189e5c61d2293a1f51b4f">ftxui::Element</a></li>
|
||
|
|
<li><code>Dimension::Fixed(n)</code> — use exactly <code>n</code> columns or rows</li>
|
||
|
|
</ul>
|
||
|
|
<p>These values are to be passed to <code><a class="el" href="classftxui_1_1Screen.html#a32b98be0603ace46d6dc9d05b330a9fd" title="Create a screen with the given dimension.">ftxui::Screen::Create()</a></code>.</p>
|
||
|
|
<p><a class="el" href="classftxui_1_1Screen.html#a32b98be0603ace46d6dc9d05b330a9fd">ftxui::Screen::Create()</a> provides two overloads:</p>
|
||
|
|
<ul>
|
||
|
|
<li><code>Screen::Create(Dimension)</code> sets both width and height to the same kind of dimension</li>
|
||
|
|
<li><code>Screen::Create(Dimension width, Dimension height)</code> allows distinct control per axis</li>
|
||
|
|
</ul>
|
||
|
|
<div class="fragment"><div class="line"><span class="keyword">auto</span> screen = <a class="code hl_function" href="classftxui_1_1Screen.html#a32b98be0603ace46d6dc9d05b330a9fd">ftxui::Screen::Create</a>(</div>
|
||
|
|
<div class="line"> <a class="code hl_function" href="namespaceftxui_1_1Dimension.html#af795790b995132f62de607ddfd07f9fa">ftxui::Dimension::Full</a>(), <span class="comment">// width</span></div>
|
||
|
|
<div class="line"> <a class="code hl_function" href="namespaceftxui_1_1Dimension.html#a36e539ed36f88d7f01233974da485937">ftxui::Dimension::Fixed</a>(10) <span class="comment">// height</span></div>
|
||
|
|
<div class="line">);</div>
|
||
|
|
</div><!-- fragment --><p>Once created, render an element and display the result:</p>
|
||
|
|
<div class="fragment"><div class="line"><a class="code hl_function" href="namespaceftxui.html#ad4b8aa9392f56ba41e2b421e046a7d83">ftxui::Render</a>(screen, element);</div>
|
||
|
|
<div class="line">screen.Print();</div>
|
||
|
|
<div class="ttc" id="anamespaceftxui_html_ad4b8aa9392f56ba41e2b421e046a7d83"><div class="ttname"><a href="namespaceftxui.html#ad4b8aa9392f56ba41e2b421e046a7d83">ftxui::Render</a></div><div class="ttdeci">void Render(Screen &screen, const Element &element)</div><div class="ttdoc">Display an element on a ftxui::Screen.</div><div class="ttdef"><b>Definition</b> <a href="node_8cpp_source.html#l00088">node.cpp:88</a></div></div>
|
||
|
|
</div><!-- fragment --><hr />
|
||
|
|
<h1><a class="anchor" id="autotoc_md30"></a>
|
||
|
|
ftxui::Pixel</h1>
|
||
|
|
<p>Each cell in the screen grid is a <a class="el" href="structftxui_1_1Pixel.html">ftxui::Pixel</a>, which holds:</p>
|
||
|
|
<ul>
|
||
|
|
<li>Unicode codepoint.<ul>
|
||
|
|
<li><code>character</code></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li>ftxui::Color:<ul>
|
||
|
|
<li><code>foreground_color</code></li>
|
||
|
|
<li><code>background_color</code></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li>Booleans:<ul>
|
||
|
|
<li><code>blink</code></li>
|
||
|
|
<li><code>bold</code></li>
|
||
|
|
<li><code>dim</code></li>
|
||
|
|
<li><code>italic</code></li>
|
||
|
|
<li><code>inverted</code> (swap foreground and background colors)</li>
|
||
|
|
<li><code>underlined</code></li>
|
||
|
|
<li><code>underlined_double</code></li>
|
||
|
|
<li><code>strikethrough</code></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<div class="fragment"><div class="line"><span class="keyword">auto</span> screen = <a class="code hl_function" href="classftxui_1_1Screen.html#a32b98be0603ace46d6dc9d05b330a9fd">ftxui::Screen::Create</a>(</div>
|
||
|
|
<div class="line"> <a class="code hl_function" href="namespaceftxui_1_1Dimension.html#a36e539ed36f88d7f01233974da485937">ftxui::Dimension::Fixed</a>(5),</div>
|
||
|
|
<div class="line"> <a class="code hl_function" href="namespaceftxui_1_1Dimension.html#a36e539ed36f88d7f01233974da485937">ftxui::Dimension::Fixed</a>(5),</div>
|
||
|
|
<div class="line">);</div>
|
||
|
|
<div class="line"> </div>
|
||
|
|
<div class="line"><span class="keyword">auto</span>& pixel = screen.PixelAt(3, 3);</div>
|
||
|
|
<div class="line">pixel.character = U<span class="charliteral">'X'</span>;</div>
|
||
|
|
<div class="line">pixel.bold = <span class="keyword">true</span>;</div>
|
||
|
|
<div class="line">pixel.foreground_color = <a class="code hl_enumvalue" href="classftxui_1_1Color.html#ae2b6d9670960e89c66d7b76167a0802fad3163c1fcda01965b692ec2c3122b743">ftxui::Color::Red</a>;</div>
|
||
|
|
<div class="line">pixel.background_color = <a class="code hl_function" href="classftxui_1_1Color.html#aacec69e0aa1063fbec2cc305e7b076dd">ftxui::Color::RGB</a>(0, 255, 0);</div>
|
||
|
|
<div class="line"> </div>
|
||
|
|
<div class="line">screen.Print();</div>
|
||
|
|
</div><!-- fragment --><dl class="section note"><dt>Note</dt><dd><code>PixelAt(x, y)</code> performs bounds checking and returns a reference to the pixel at the specified coordinate. If out-of-bounds, a dummy pixel reference is returned.</dd></dl>
|
||
|
|
<p>Each cell in the screen is a <a class="el" href="structftxui_1_1Pixel.html">ftxui::Pixel</a>. You can modify them using:</p>
|
||
|
|
<div class="fragment"><div class="line"><span class="keyword">auto</span>& pixel = screen.PixelAt(x, y);</div>
|
||
|
|
<div class="line">pixel.character = U<span class="charliteral">'X'</span>;</div>
|
||
|
|
<div class="line">pixel.bold = <span class="keyword">true</span>;</div>
|
||
|
|
<div class="line">pixel.foreground_color = Color::Red;</div>
|
||
|
|
</div><!-- fragment --><hr />
|
||
|
|
<h1><a class="anchor" id="autotoc_md32"></a>
|
||
|
|
ftxui::Color</h1>
|
||
|
|
<p>The <a class="el" href="classftxui_1_1Color.html">ftxui::Color</a> class is used to define foreground and background colors for each <a class="el" href="structftxui_1_1Pixel.html">ftxui::Pixel</a>.</p>
|
||
|
|
<p>It supports various color spaces and predefined palettes. FTXUI will dynamically fallback to the closest available color in the terminal if the requested color is not supported by the terminal.</p>
|
||
|
|
<p><b>Color Spaces</b></p>
|
||
|
|
<ul>
|
||
|
|
<li><b>Default</b>: <code><a class="el" href="classftxui_1_1Color.html#aa4be56f94fc180d7b070df23c235b0c7a79935518a3889663d8688b6b01fff051">ftxui::Color::Default</a></code> (terminal's default color)</li>
|
||
|
|
<li><b>16-color palette</b> <a href="https://arthursonzogni.github.io/FTXUI/examples/?file=dom/color_gallery">Demo</a>:<ul>
|
||
|
|
<li><code><a class="el" href="classftxui_1_1Color.html#ae2b6d9670960e89c66d7b76167a0802fac1e9bce8242f443c54c7405223d616cd">ftxui::Color::Black</a></code>,</li>
|
||
|
|
<li><code><a class="el" href="classftxui_1_1Color.html#ae2b6d9670960e89c66d7b76167a0802fad3163c1fcda01965b692ec2c3122b743">ftxui::Color::Red</a></code>,</li>
|
||
|
|
<li>...</li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li><b>256-color palette</b> <a href="https://arthursonzogni.github.io/FTXUI/examples/?file=dom/color_palette256">Demo</a>:<ul>
|
||
|
|
<li><code><a class="el" href="classftxui_1_1Color.html#abd07c48f62cc507fafa2486a43130fcfa7d2d4cc3af6756a4eac7d12fbe4775d4">ftxui::Color::Chartreuse1</a></code>,</li>
|
||
|
|
<li><code><a class="el" href="classftxui_1_1Color.html#abd07c48f62cc507fafa2486a43130fcfa0c92c7e17edeca09b7c63c8a783a562f">ftxui::Color::DarkViolet</a></code>,</li>
|
||
|
|
<li>...</li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li><b>True color</b> (24bit) [Demo](<a href="https://arthursonzogni.github.io/FTXUI/examples/?file=dom/color_truecolor_HSV:">https://arthursonzogni.github.io/FTXUI/examples/?file=dom/color_truecolor_HSV:</a><ul>
|
||
|
|
<li><code><a class="el" href="classftxui_1_1Color.html#aacec69e0aa1063fbec2cc305e7b076dd" title="Build a Color from its RGB representation. https://en.wikipedia.org/wiki/RGB_color_model.">ftxui::Color::RGB(uint8_t red, uint8_t green, uint8_t blue)</a></code></li>
|
||
|
|
<li><code><a class="el" href="classftxui_1_1Color.html#a1a119fd00beafc7d2aa5f94518e38fc5" title="Build a Color from its HSV representation. https://en.wikipedia.org/wiki/HSL_and_HSV.">ftxui::Color::HSV(uint8_t h, uint8_t s, uint8_t v)</a></code>.</li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<dl class="section note"><dt>Note</dt><dd>You can query the terminal capability using <a class="el" href="namespaceftxui_1_1Terminal.html#ae6e034f37aa66cfe4458a8cb6e8fc526">ftxui::Terminal::ColorSupport()</a>; <br />
|
||
|
|
<br />
|
||
|
|
This can manually be set using <a class="el" href="namespaceftxui_1_1Terminal.html#a65945a706131f407a47a1b9960dc1a4a">ftxui::Terminal::SetColorSupport()</a>. </dd></dl>
|
||
|
|
</div></div><!-- contents -->
|
||
|
|
</div><!-- PageDoc -->
|
||
|
|
</div><!-- doc-content -->
|
||
|
|
<!-- HTML footer for doxygen 1.9.8-->
|
||
|
|
<!-- start footer part -->
|
||
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||
|
|
<ul>
|
||
|
|
<li class="navelem"><a class="el" href="modules.html">Modules</a></li>
|
||
|
|
<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.12.0 </li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|