mirror of
https://github.com/ArthurSonzogni/FTXUI.git
synced 2025-12-16 01:48:56 +08:00
182 lines
20 KiB
HTML
182 lines
20 KiB
HTML
<!-- HTML header for doxygen 1.8.14-->
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="cache-control" content="max-age=86400"/>
|
|
<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.8"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>FTXUI: include/ftxui/dom/linear_gradient.hpp Source File</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="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.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_extra.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">FTXUI
|
|
 <span id="projectnumber">6.1.1</span>
|
|
</div>
|
|
<div id="projectbrief">C++ functional terminal UI.</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&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&dn=expat.txt MIT */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(document).ready(function() { init_codefold(0); });
|
|
/* @license-end */
|
|
</script>
|
|
</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 */
|
|
$(document).ready(function(){initNavTree('linear__gradient_8hpp_source.html',''); initResizable(); });
|
|
/* @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 class="header">
|
|
<div class="headertitle"><div class="title">linear_gradient.hpp</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="linear__gradient_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">// Copyright 2023 Arthur Sonzogni. All rights reserved.</span></div>
|
|
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment">// Use of this source code is governed by the MIT license that can be found in</span></div>
|
|
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment">// the LICENSE file.</span></div>
|
|
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#ifndef FTXUI_DOM_LINEAR_GRADIENT_HPP</span></div>
|
|
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#define FTXUI_DOM_LINEAR_GRADIENT_HPP</span></div>
|
|
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span> </div>
|
|
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#include <optional></span></div>
|
|
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#include <vector></span></div>
|
|
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span> </div>
|
|
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="preprocessor">#include "<a class="code" href="color_8hpp.html">ftxui/screen/color.hpp</a>"</span> <span class="comment">// for Colors</span></div>
|
|
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span> </div>
|
|
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceftxui.html">ftxui</a> {</div>
|
|
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment">/// @brief A class representing the settings for linear-gradient color effect.</span></div>
|
|
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment">///</span></div>
|
|
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment">/// Example:</span></div>
|
|
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment">/// ```cpp</span></div>
|
|
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment">/// LinearGradient()</span></div>
|
|
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="comment">/// .Angle(45)</span></div>
|
|
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="comment">/// .Stop(Color::Red, 0.0)</span></div>
|
|
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="comment">/// .Stop(Color::Green, 0.5)</span></div>
|
|
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="comment">/// .Stop(Color::Blue, 1.0);</span></div>
|
|
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="comment">/// ```</span></div>
|
|
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="comment">///</span></div>
|
|
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="comment">/// There are also shorthand constructors:</span></div>
|
|
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="comment">/// ```cpp</span></div>
|
|
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="comment">/// LinearGradient(Color::Red, Color::Blue);</span></div>
|
|
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="comment">/// LinearGradient(45, Color::Red, Color::Blue);</span></div>
|
|
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="comment">/// ```</span></div>
|
|
<div class="foldopen" id="foldopen00030" data-start="{" data-end="};">
|
|
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"><a class="line" href="structftxui_1_1LinearGradient.html"> 30</a></span><span class="comment"></span><span class="keyword">struct </span><a class="code hl_struct" href="structftxui_1_1LinearGradient.html">LinearGradient</a> {</div>
|
|
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"><a class="line" href="structftxui_1_1LinearGradient.html#ab8ef1bf8a70cc07c6d55823c390a7e76"> 31</a></span> <span class="keywordtype">float</span> <a class="code hl_variable" href="structftxui_1_1LinearGradient.html#ab8ef1bf8a70cc07c6d55823c390a7e76">angle</a> = 0.f;</div>
|
|
<div class="foldopen" id="foldopen00032" data-start="{" data-end="};">
|
|
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"><a class="line" href="structftxui_1_1LinearGradient.html"> 32</a></span> <span class="keyword">struct </span><a class="code hl_struct" href="structftxui_1_1LinearGradient.html#structftxui_1_1LinearGradient_1_1Stop">Stop</a> {</div>
|
|
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"><a class="line" href="structftxui_1_1LinearGradient.html#aa5f4d1eda21c196bd8401ff73f105073"> 33</a></span> <a class="code hl_class" href="classftxui_1_1Color.html">Color</a> <a class="code hl_variable" href="structftxui_1_1LinearGradient.html#aa5f4d1eda21c196bd8401ff73f105073">color</a> = <a class="code hl_enumvalue" href="classftxui_1_1Color.html#aa4be56f94fc180d7b070df23c235b0c7a79935518a3889663d8688b6b01fff051">Color::Default</a>;</div>
|
|
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"><a class="line" href="structftxui_1_1LinearGradient.html#a2f3c9e83b473a71f2882ee1ec4fb88de"> 34</a></span> std::optional<float> <a class="code hl_variable" href="structftxui_1_1LinearGradient.html#a2f3c9e83b473a71f2882ee1ec4fb88de">position</a>;</div>
|
|
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> };</div>
|
|
</div>
|
|
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"><a class="line" href="structftxui_1_1LinearGradient.html#a9c56e5fb8075d8a48b1b0c3b4ea31831"> 36</a></span> std::vector<Stop> <a class="code hl_variable" href="structftxui_1_1LinearGradient.html#a9c56e5fb8075d8a48b1b0c3b4ea31831">stops</a>;</div>
|
|
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> </div>
|
|
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> <span class="comment">// Simple constructor</span></div>
|
|
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"><a class="line" href="structftxui_1_1LinearGradient.html#a5e989e4841fbba91e1714f977c5c58b9"> 39</a></span> <a class="code hl_function" href="structftxui_1_1LinearGradient.html#a5e989e4841fbba91e1714f977c5c58b9">LinearGradient</a>();</div>
|
|
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> <a class="code hl_function" href="structftxui_1_1LinearGradient.html#a5e989e4841fbba91e1714f977c5c58b9">LinearGradient</a>(<a class="code hl_class" href="classftxui_1_1Color.html">Color</a> <a class="code hl_function" href="namespaceftxui.html#a2b8973dc71334f1d98e2e6f55de8b5ae">begin</a>, <a class="code hl_class" href="classftxui_1_1Color.html">Color</a> <a class="code hl_function" href="namespaceftxui.html#a2b8973dc71334f1d98e2e6f55de8b5ae">end</a>);</div>
|
|
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> <a class="code hl_function" href="structftxui_1_1LinearGradient.html#a5e989e4841fbba91e1714f977c5c58b9">LinearGradient</a>(<span class="keywordtype">float</span> <a class="code hl_variable" href="structftxui_1_1LinearGradient.html#ab8ef1bf8a70cc07c6d55823c390a7e76">angle</a>, <a class="code hl_class" href="classftxui_1_1Color.html">Color</a> <a class="code hl_function" href="namespaceftxui.html#a2b8973dc71334f1d98e2e6f55de8b5ae">begin</a>, <a class="code hl_class" href="classftxui_1_1Color.html">Color</a> <a class="code hl_function" href="namespaceftxui.html#a2b8973dc71334f1d98e2e6f55de8b5ae">end</a>);</div>
|
|
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> </div>
|
|
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> <span class="comment">// Modifier using the builder pattern.</span></div>
|
|
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> <a class="code hl_struct" href="structftxui_1_1LinearGradient.html">LinearGradient</a>& <a class="code hl_function" href="structftxui_1_1LinearGradient.html#a251d447c54f49914a2cbf5dc16fc8b5b">Angle</a>(<span class="keywordtype">float</span> <a class="code hl_variable" href="structftxui_1_1LinearGradient.html#ab8ef1bf8a70cc07c6d55823c390a7e76">angle</a>);</div>
|
|
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> <a class="code hl_struct" href="structftxui_1_1LinearGradient.html">LinearGradient</a>& <a class="code hl_struct" href="structftxui_1_1LinearGradient.html#structftxui_1_1LinearGradient_1_1Stop">Stop</a>(<a class="code hl_class" href="classftxui_1_1Color.html">Color</a> <a class="code hl_function" href="namespaceftxui.html#af61b489da39ca5e24b68e6e1a2b09c0d">color</a>, <span class="keywordtype">float</span> position);</div>
|
|
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> <a class="code hl_struct" href="structftxui_1_1LinearGradient.html">LinearGradient</a>& <a class="code hl_struct" href="structftxui_1_1LinearGradient.html#structftxui_1_1LinearGradient_1_1Stop">Stop</a>(<a class="code hl_class" href="classftxui_1_1Color.html">Color</a> <a class="code hl_function" href="namespaceftxui.html#af61b489da39ca5e24b68e6e1a2b09c0d">color</a>);</div>
|
|
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span>};</div>
|
|
</div>
|
|
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> </div>
|
|
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span>} <span class="comment">// namespace ftxui</span></div>
|
|
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> </div>
|
|
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span><span class="preprocessor">#endif </span><span class="comment">// FTXUI_DOM_LINEAR_GRADIENT_HPP</span></div>
|
|
<div class="ttc" id="aclassftxui_1_1Color_html"><div class="ttname"><a href="classftxui_1_1Color.html">ftxui::Color</a></div><div class="ttdoc">A class representing terminal colors.</div><div class="ttdef"><b>Definition</b> <a href="color_8hpp_source.html#l00020">color.hpp:20</a></div></div>
|
|
<div class="ttc" id="aclassftxui_1_1Color_html_aa4be56f94fc180d7b070df23c235b0c7a79935518a3889663d8688b6b01fff051"><div class="ttname"><a href="classftxui_1_1Color.html#aa4be56f94fc180d7b070df23c235b0c7a79935518a3889663d8688b6b01fff051">ftxui::Color::Default</a></div><div class="ttdeci">@ Default</div><div class="ttdef"><b>Definition</b> <a href="color_8hpp_source.html#l00048">color.hpp:48</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="anamespaceftxui_html"><div class="ttname"><a href="namespaceftxui.html">ftxui</a></div><div class="ttdef"><b>Definition</b> <a href="animation_8hpp_source.html#l00010">animation.hpp:10</a></div></div>
|
|
<div class="ttc" id="anamespaceftxui_html_a2b8973dc71334f1d98e2e6f55de8b5ae"><div class="ttname"><a href="namespaceftxui.html#a2b8973dc71334f1d98e2e6f55de8b5ae">ftxui::Make</a></div><div class="ttdeci">std::shared_ptr< T > Make(Args &&... args)</div><div class="ttdef"><b>Definition</b> <a href="component_8hpp_source.html#l00026">component.hpp:26</a></div></div>
|
|
<div class="ttc" id="anamespaceftxui_html_af61b489da39ca5e24b68e6e1a2b09c0d"><div class="ttname"><a href="namespaceftxui.html#af61b489da39ca5e24b68e6e1a2b09c0d">ftxui::color</a></div><div class="ttdeci">Decorator color(Color)</div><div class="ttdoc">Decorate using a foreground color.</div><div class="ttdef"><b>Definition</b> <a href="dom_2color_8cpp_source.html#l00110">color.cpp:110</a></div></div>
|
|
<div class="ttc" id="astructftxui_1_1LinearGradient_html"><div class="ttname"><a href="structftxui_1_1LinearGradient.html">ftxui::LinearGradient</a></div><div class="ttdoc">A class representing the settings for linear-gradient color effect.</div><div class="ttdef"><b>Definition</b> <a href="linear__gradient_8hpp_source.html#l00030">linear_gradient.hpp:30</a></div></div>
|
|
<div class="ttc" id="astructftxui_1_1LinearGradient_html_a251d447c54f49914a2cbf5dc16fc8b5b"><div class="ttname"><a href="structftxui_1_1LinearGradient.html#a251d447c54f49914a2cbf5dc16fc8b5b">ftxui::LinearGradient::Angle</a></div><div class="ttdeci">LinearGradient & Angle(float angle)</div><div class="ttdoc">Set the angle of the gradient.</div><div class="ttdef"><b>Definition</b> <a href="linear__gradient_8cpp_source.html#l00216">linear_gradient.cpp:216</a></div></div>
|
|
<div class="ttc" id="astructftxui_1_1LinearGradient_html_a2f3c9e83b473a71f2882ee1ec4fb88de"><div class="ttname"><a href="structftxui_1_1LinearGradient.html#a2f3c9e83b473a71f2882ee1ec4fb88de">ftxui::LinearGradient::Stop::position</a></div><div class="ttdeci">std::optional< float > position</div><div class="ttdef"><b>Definition</b> <a href="linear__gradient_8hpp_source.html#l00034">linear_gradient.hpp:34</a></div></div>
|
|
<div class="ttc" id="astructftxui_1_1LinearGradient_html_a5e989e4841fbba91e1714f977c5c58b9"><div class="ttname"><a href="structftxui_1_1LinearGradient.html#a5e989e4841fbba91e1714f977c5c58b9">ftxui::LinearGradient::LinearGradient</a></div><div class="ttdeci">LinearGradient()</div><div class="ttdoc">Build the "empty" gradient. This is often followed by calls to LinearGradient::Angle() and LinearGrad...</div></div>
|
|
<div class="ttc" id="astructftxui_1_1LinearGradient_html_a9c56e5fb8075d8a48b1b0c3b4ea31831"><div class="ttname"><a href="structftxui_1_1LinearGradient.html#a9c56e5fb8075d8a48b1b0c3b4ea31831">ftxui::LinearGradient::stops</a></div><div class="ttdeci">std::vector< Stop > stops</div><div class="ttdef"><b>Definition</b> <a href="linear__gradient_8hpp_source.html#l00036">linear_gradient.hpp:36</a></div></div>
|
|
<div class="ttc" id="astructftxui_1_1LinearGradient_html_aa5f4d1eda21c196bd8401ff73f105073"><div class="ttname"><a href="structftxui_1_1LinearGradient.html#aa5f4d1eda21c196bd8401ff73f105073">ftxui::LinearGradient::Stop::color</a></div><div class="ttdeci">Color color</div><div class="ttdef"><b>Definition</b> <a href="linear__gradient_8hpp_source.html#l00033">linear_gradient.hpp:33</a></div></div>
|
|
<div class="ttc" id="astructftxui_1_1LinearGradient_html_ab8ef1bf8a70cc07c6d55823c390a7e76"><div class="ttname"><a href="structftxui_1_1LinearGradient.html#ab8ef1bf8a70cc07c6d55823c390a7e76">ftxui::LinearGradient::angle</a></div><div class="ttdeci">float angle</div><div class="ttdef"><b>Definition</b> <a href="linear__gradient_8hpp_source.html#l00031">linear_gradient.hpp:31</a></div></div>
|
|
<div class="ttc" id="astructftxui_1_1LinearGradient_html_structftxui_1_1LinearGradient_1_1Stop"><div class="ttname"><a href="structftxui_1_1LinearGradient.html#structftxui_1_1LinearGradient_1_1Stop">ftxui::LinearGradient::Stop</a></div><div class="ttdef"><b>Definition</b> <a href="linear__gradient_8hpp_source.html#l00032">linear_gradient.hpp:32</a></div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- HTML footer for doxygen 1.8.14-->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
</div>
|
|
</body>
|
|
</html>
|