Files
FTXUI/structftxui_1_1LinearGradient.html
2025-05-30 18:32:48 +00:00

436 lines
28 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: LinearGradient 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>
<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">&#160;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&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;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&amp;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&amp;dn=expat.txt MIT */
$(function(){initNavTree('structftxui_1_1LinearGradient.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 class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle"><div class="title">LinearGradient Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p>A class representing the settings for linear-gradient color effect.
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="linear__gradient_8hpp_source.html">linear_gradient.hpp</a>&gt;</code></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="structftxui_1_1LinearGradient_1_1Stop.html">Stop</a></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="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a5e989e4841fbba91e1714f977c5c58b9" id="r_a5e989e4841fbba91e1714f977c5c58b9"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5e989e4841fbba91e1714f977c5c58b9">LinearGradient</a> ()</td></tr>
<tr class="memdesc:a5e989e4841fbba91e1714f977c5c58b9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Build the "empty" gradient. This is often followed by calls to <a class="el" href="#a251d447c54f49914a2cbf5dc16fc8b5b" title="Set the angle of the gradient.">LinearGradient::Angle()</a> and <a class="el" href="#a03b10012f78e1c731616ce760d28df40" title="Add a color stop to the gradient.">LinearGradient::Stop()</a>. Example: <br /></td></tr>
<tr class="separator:a5e989e4841fbba91e1714f977c5c58b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac57e39e64c79b5389f234eeaebfbb2fd" id="r_ac57e39e64c79b5389f234eeaebfbb2fd"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac57e39e64c79b5389f234eeaebfbb2fd">LinearGradient</a> (<a class="el" href="classftxui_1_1Color.html">Color</a> begin, <a class="el" href="classftxui_1_1Color.html">Color</a> end)</td></tr>
<tr class="memdesc:ac57e39e64c79b5389f234eeaebfbb2fd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Build a gradient with two colors. <br /></td></tr>
<tr class="separator:ac57e39e64c79b5389f234eeaebfbb2fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adbf0567cfc8e05051a4236d6541f63b8" id="r_adbf0567cfc8e05051a4236d6541f63b8"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#adbf0567cfc8e05051a4236d6541f63b8">LinearGradient</a> (float <a class="el" href="#ab8ef1bf8a70cc07c6d55823c390a7e76">angle</a>, <a class="el" href="classftxui_1_1Color.html">Color</a> begin, <a class="el" href="classftxui_1_1Color.html">Color</a> end)</td></tr>
<tr class="memdesc:adbf0567cfc8e05051a4236d6541f63b8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Build a gradient with two colors and an angle. <br /></td></tr>
<tr class="separator:adbf0567cfc8e05051a4236d6541f63b8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a251d447c54f49914a2cbf5dc16fc8b5b" id="r_a251d447c54f49914a2cbf5dc16fc8b5b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structftxui_1_1LinearGradient.html">LinearGradient</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a251d447c54f49914a2cbf5dc16fc8b5b">Angle</a> (float <a class="el" href="#ab8ef1bf8a70cc07c6d55823c390a7e76">angle</a>)</td></tr>
<tr class="memdesc:a251d447c54f49914a2cbf5dc16fc8b5b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the angle of the gradient. <br /></td></tr>
<tr class="separator:a251d447c54f49914a2cbf5dc16fc8b5b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a03b10012f78e1c731616ce760d28df40" id="r_a03b10012f78e1c731616ce760d28df40"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structftxui_1_1LinearGradient.html">LinearGradient</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a03b10012f78e1c731616ce760d28df40">Stop</a> (<a class="el" href="classftxui_1_1Color.html">Color</a> <a class="el" href="namespaceftxui.html#af61b489da39ca5e24b68e6e1a2b09c0d">color</a>, float position)</td></tr>
<tr class="memdesc:a03b10012f78e1c731616ce760d28df40"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add a color stop to the gradient. <br /></td></tr>
<tr class="separator:a03b10012f78e1c731616ce760d28df40"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab85b009cd214d3bd1b3bb7f704af0da6" id="r_ab85b009cd214d3bd1b3bb7f704af0da6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structftxui_1_1LinearGradient.html">LinearGradient</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab85b009cd214d3bd1b3bb7f704af0da6">Stop</a> (<a class="el" href="classftxui_1_1Color.html">Color</a> <a class="el" href="namespaceftxui.html#af61b489da39ca5e24b68e6e1a2b09c0d">color</a>)</td></tr>
<tr class="memdesc:ab85b009cd214d3bd1b3bb7f704af0da6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add a color stop to the gradient. <br /></td></tr>
<tr class="separator:ab85b009cd214d3bd1b3bb7f704af0da6"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:ab8ef1bf8a70cc07c6d55823c390a7e76" id="r_ab8ef1bf8a70cc07c6d55823c390a7e76"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab8ef1bf8a70cc07c6d55823c390a7e76">angle</a> = 0.f</td></tr>
<tr class="separator:ab8ef1bf8a70cc07c6d55823c390a7e76"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9c56e5fb8075d8a48b1b0c3b4ea31831" id="r_a9c56e5fb8075d8a48b1b0c3b4ea31831"><td class="memItemLeft" align="right" valign="top">std::vector&lt; <a class="el" href="structftxui_1_1LinearGradient_1_1Stop.html">Stop</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a9c56e5fb8075d8a48b1b0c3b4ea31831">stops</a></td></tr>
<tr class="separator:a9c56e5fb8075d8a48b1b0c3b4ea31831"><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 representing the settings for linear-gradient color effect. </p>
<p>Example: </p><div class="fragment"><div class="line"><a class="code hl_function" href="#a5e989e4841fbba91e1714f977c5c58b9">LinearGradient</a>()</div>
<div class="line"> .Angle(45)</div>
<div class="line"> .Stop(<a class="code hl_enumvalue" href="classftxui_1_1Color.html#ae2b6d9670960e89c66d7b76167a0802fad3163c1fcda01965b692ec2c3122b743">Color::Red</a>, 0.0)</div>
<div class="line"> .Stop(<a class="code hl_enumvalue" href="classftxui_1_1Color.html#ae2b6d9670960e89c66d7b76167a0802fad0784a3f969fe736e8b271a5a161d106">Color::Green</a>, 0.5)</div>
<div class="line"> .Stop(<a class="code hl_enumvalue" href="classftxui_1_1Color.html#ae2b6d9670960e89c66d7b76167a0802faf5e09dd1da4088464f264b7a3118bff8">Color::Blue</a>, 1.0);</div>
<div class="ttc" id="aclassftxui_1_1Color_html_ae2b6d9670960e89c66d7b76167a0802fad0784a3f969fe736e8b271a5a161d106"><div class="ttname"><a href="classftxui_1_1Color.html#ae2b6d9670960e89c66d7b76167a0802fad0784a3f969fe736e8b271a5a161d106">ftxui::Color::Green</a></div><div class="ttdeci">@ Green</div><div class="ttdef"><b>Definition</b> <a href="color_8hpp_source.html#l00054">color.hpp:54</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_1Color_html_ae2b6d9670960e89c66d7b76167a0802faf5e09dd1da4088464f264b7a3118bff8"><div class="ttname"><a href="classftxui_1_1Color.html#ae2b6d9670960e89c66d7b76167a0802faf5e09dd1da4088464f264b7a3118bff8">ftxui::Color::Blue</a></div><div class="ttdeci">@ Blue</div><div class="ttdef"><b>Definition</b> <a href="color_8hpp_source.html#l00056">color.hpp:56</a></div></div>
<div class="ttc" id="astructftxui_1_1LinearGradient_html_a5e989e4841fbba91e1714f977c5c58b9"><div class="ttname"><a href="#a5e989e4841fbba91e1714f977c5c58b9">ftxui::LinearGradient::LinearGradient</a></div><div class="ttdeci">LinearGradient()</div><div class="ttdoc">Build the &quot;empty&quot; gradient. This is often followed by calls to LinearGradient::Angle() and LinearGrad...</div></div>
</div><!-- fragment --><p>There are also shorthand constructors: </p><div class="fragment"><div class="line"><a class="code hl_function" href="#a5e989e4841fbba91e1714f977c5c58b9">LinearGradient</a>(<a class="code hl_enumvalue" href="classftxui_1_1Color.html#ae2b6d9670960e89c66d7b76167a0802fad3163c1fcda01965b692ec2c3122b743">Color::Red</a>, <a class="code hl_enumvalue" href="classftxui_1_1Color.html#ae2b6d9670960e89c66d7b76167a0802faf5e09dd1da4088464f264b7a3118bff8">Color::Blue</a>);</div>
<div class="line"><a class="code hl_function" href="#a5e989e4841fbba91e1714f977c5c58b9">LinearGradient</a>(45, <a class="code hl_enumvalue" href="classftxui_1_1Color.html#ae2b6d9670960e89c66d7b76167a0802fad3163c1fcda01965b692ec2c3122b743">Color::Red</a>, <a class="code hl_enumvalue" href="classftxui_1_1Color.html#ae2b6d9670960e89c66d7b76167a0802faf5e09dd1da4088464f264b7a3118bff8">Color::Blue</a>);</div>
</div><!-- fragment --> <dl class="section examples"><dt>Examples</dt><dd><a class="el" href="examples_2component_2input_in_frame_8cpp-example.html#_a4">examples/component/input_in_frame.cpp</a>, <a class="el" href="examples_2component_2input_style_8cpp-example.html#_a2">examples/component/input_style.cpp</a>, <a class="el" href="examples_2component_2linear_gradient_gallery_8cpp-example.html#_a2">examples/component/linear_gradient_gallery.cpp</a>, <a class="el" href="examples_2dom_2html_like_8cpp-example.html#_a1">examples/dom/html_like.cpp</a>, <a class="el" href="examples_2dom_2linear_gradient_8cpp-example.html#_a1">examples/dom/linear_gradient.cpp</a>, <a class="el" href="examples_2dom_2style_bold_8cpp-example.html#_a1">examples/dom/style_bold.cpp</a>, and <a class="el" href="examples_2dom_2style_color_8cpp-example.html#_a1">examples/dom/style_color.cpp</a>.</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="linear__gradient_8hpp_source.html#l00030">30</a> of file <a class="el" href="linear__gradient_8hpp_source.html">linear_gradient.hpp</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a5e989e4841fbba91e1714f977c5c58b9" name="a5e989e4841fbba91e1714f977c5c58b9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5e989e4841fbba91e1714f977c5c58b9">&#9670;&#160;</a></span>LinearGradient() <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structftxui_1_1LinearGradient.html">LinearGradient</a> </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Build the "empty" gradient. This is often followed by calls to <a class="el" href="#a251d447c54f49914a2cbf5dc16fc8b5b" title="Set the angle of the gradient.">LinearGradient::Angle()</a> and <a class="el" href="#a03b10012f78e1c731616ce760d28df40" title="Add a color stop to the gradient.">LinearGradient::Stop()</a>. Example: </p>
<div class="fragment"><div class="line"><span class="keyword">auto</span> gradient =</div>
<div class="line"> <a class="code hl_function" href="#a5e989e4841fbba91e1714f977c5c58b9">LinearGradient</a>()</div>
<div class="line"> .Angle(45)</div>
<div class="line"> .Stop(<a class="code hl_enumvalue" href="classftxui_1_1Color.html#ae2b6d9670960e89c66d7b76167a0802fad3163c1fcda01965b692ec2c3122b743">Color::Red</a>, 0.0)</div>
<div class="line"> .Stop(<a class="code hl_enumvalue" href="classftxui_1_1Color.html#ae2b6d9670960e89c66d7b76167a0802fad0784a3f969fe736e8b271a5a161d106">Color::Green</a>, 0.5)</div>
<div class="line"> .Stop(<a class="code hl_enumvalue" href="classftxui_1_1Color.html#ae2b6d9670960e89c66d7b76167a0802faf5e09dd1da4088464f264b7a3118bff8">Color::Blue</a>, 1.0);;</div>
</div><!-- fragment -->
</div>
</div>
<a id="ac57e39e64c79b5389f234eeaebfbb2fd" name="ac57e39e64c79b5389f234eeaebfbb2fd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac57e39e64c79b5389f234eeaebfbb2fd">&#9670;&#160;</a></span>LinearGradient() <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structftxui_1_1LinearGradient.html">LinearGradient</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classftxui_1_1Color.html">Color</a></td> <td class="paramname"><span class="paramname"><em>begin</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classftxui_1_1Color.html">Color</a></td> <td class="paramname"><span class="paramname"><em>end</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Build a gradient with two colors. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">begin</td><td>The color at the beginning of the gradient. </td></tr>
<tr><td class="paramname">end</td><td>The color at the end of the gradient. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="src_2ftxui_2dom_2linear__gradient_8cpp_source.html#l00199">199</a> of file <a class="el" href="src_2ftxui_2dom_2linear__gradient_8cpp_source.html">src/ftxui/dom/linear_gradient.cpp</a>.</p>
</div>
</div>
<a id="adbf0567cfc8e05051a4236d6541f63b8" name="adbf0567cfc8e05051a4236d6541f63b8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adbf0567cfc8e05051a4236d6541f63b8">&#9670;&#160;</a></span>LinearGradient() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structftxui_1_1LinearGradient.html">LinearGradient</a> </td>
<td>(</td>
<td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>a</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classftxui_1_1Color.html">Color</a></td> <td class="paramname"><span class="paramname"><em>begin</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classftxui_1_1Color.html">Color</a></td> <td class="paramname"><span class="paramname"><em>end</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Build a gradient with two colors and an angle. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">a</td><td>The angle of the gradient. </td></tr>
<tr><td class="paramname">begin</td><td>The color at the beginning of the gradient. </td></tr>
<tr><td class="paramname">end</td><td>The color at the end of the gradient. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="src_2ftxui_2dom_2linear__gradient_8cpp_source.html#l00207">207</a> of file <a class="el" href="src_2ftxui_2dom_2linear__gradient_8cpp_source.html">src/ftxui/dom/linear_gradient.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a251d447c54f49914a2cbf5dc16fc8b5b" name="a251d447c54f49914a2cbf5dc16fc8b5b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a251d447c54f49914a2cbf5dc16fc8b5b">&#9670;&#160;</a></span>Angle()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structftxui_1_1LinearGradient.html">LinearGradient</a> &amp; Angle </td>
<td>(</td>
<td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>a</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the angle of the gradient. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">a</td><td>The angle of the gradient. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The gradient. </dd></dl>
<p class="definition">Definition at line <a class="el" href="src_2ftxui_2dom_2linear__gradient_8cpp_source.html#l00216">216</a> of file <a class="el" href="src_2ftxui_2dom_2linear__gradient_8cpp_source.html">src/ftxui/dom/linear_gradient.cpp</a>.</p>
</div>
</div>
<a id="a03b10012f78e1c731616ce760d28df40" name="a03b10012f78e1c731616ce760d28df40"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a03b10012f78e1c731616ce760d28df40">&#9670;&#160;</a></span>Stop() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structftxui_1_1LinearGradient.html">LinearGradient</a> &amp; Stop </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classftxui_1_1Color.html">Color</a></td> <td class="paramname"><span class="paramname"><em>c</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>p</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Add a color stop to the gradient. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">c</td><td>The color of the stop. </td></tr>
<tr><td class="paramname">p</td><td>The position of the stop. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The gradient. </dd></dl>
<p class="definition">Definition at line <a class="el" href="src_2ftxui_2dom_2linear__gradient_8cpp_source.html#l00225">225</a> of file <a class="el" href="src_2ftxui_2dom_2linear__gradient_8cpp_source.html">src/ftxui/dom/linear_gradient.cpp</a>.</p>
</div>
</div>
<a id="ab85b009cd214d3bd1b3bb7f704af0da6" name="ab85b009cd214d3bd1b3bb7f704af0da6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab85b009cd214d3bd1b3bb7f704af0da6">&#9670;&#160;</a></span>Stop() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structftxui_1_1LinearGradient.html">LinearGradient</a> &amp; Stop </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classftxui_1_1Color.html">Color</a></td> <td class="paramname"><span class="paramname"><em>c</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Add a color stop to the gradient. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">c</td><td>The color of the stop. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The gradient.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>The position of the stop is interpolated from nearby stops. </dd></dl>
<p class="definition">Definition at line <a class="el" href="src_2ftxui_2dom_2linear__gradient_8cpp_source.html#l00235">235</a> of file <a class="el" href="src_2ftxui_2dom_2linear__gradient_8cpp_source.html">src/ftxui/dom/linear_gradient.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Field Documentation</h2>
<a id="ab8ef1bf8a70cc07c6d55823c390a7e76" name="ab8ef1bf8a70cc07c6d55823c390a7e76"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab8ef1bf8a70cc07c6d55823c390a7e76">&#9670;&#160;</a></span>angle</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float angle = 0.f</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="linear__gradient_8hpp_source.html#l00031">31</a> of file <a class="el" href="linear__gradient_8hpp_source.html">linear_gradient.hpp</a>.</p>
</div>
</div>
<a id="a9c56e5fb8075d8a48b1b0c3b4ea31831" name="a9c56e5fb8075d8a48b1b0c3b4ea31831"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9c56e5fb8075d8a48b1b0c3b4ea31831">&#9670;&#160;</a></span>stops</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::vector&lt;<a class="el" href="structftxui_1_1LinearGradient_1_1Stop.html">Stop</a>&gt; stops</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="linear__gradient_8hpp_source.html#l00036">36</a> of file <a class="el" href="linear__gradient_8hpp_source.html">linear_gradient.hpp</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following files:<ul>
<li><a class="el" href="linear__gradient_8hpp_source.html">linear_gradient.hpp</a></li>
<li><a class="el" href="src_2ftxui_2dom_2linear__gradient_8cpp_source.html">src/ftxui/dom/linear_gradient.cpp</a></li>
</ul>
</div><!-- contents -->
</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="namespaceftxui.html">ftxui</a></li><li class="navelem"><a class="el" href="structftxui_1_1LinearGradient.html">LinearGradient</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>