Skip to content

Commit

Permalink
updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@Unreal-Dan
Unreal-Dan committed Aug 21, 2023
1 parent 62fdf1e commit 78a4022
Show file tree
Hide file tree
Showing 2,859 changed files with 36,923 additions and 35,802 deletions.
2 changes: 1 addition & 1 deletion docs/core/BackStrobePattern_8cpp_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@
<div class="ttc" id="aPattern_8h_html_ab1306cccbe6b359324139bc35edbbbb4"><div class="ttname"><a href="Pattern_8h.html#ab1306cccbe6b359324139bc35edbbbb4">REGISTER_ARG</a></div><div class="ttdeci">#define REGISTER_ARG(arg)</div><div class="ttdef"><b>Definition:</b> <a href="Pattern_8h_source.html#l00034">Pattern.h:34</a></div></div>
<div class="ttc" id="aPatterns_8h_html_a40b65bd8b307c1134edfc6b99c16cd8c"><div class="ttname"><a href="Patterns_8h.html#a40b65bd8b307c1134edfc6b99c16cd8c">PatternID</a></div><div class="ttdeci">PatternID</div><div class="ttdef"><b>Definition:</b> <a href="Patterns_8h_source.html#l00011">Patterns.h:12</a></div></div>
<div class="ttc" id="aPatterns_8h_html_a40b65bd8b307c1134edfc6b99c16cd8ca320755b96ff07514ffbbea92471d9028"><div class="ttname"><a href="Patterns_8h.html#a40b65bd8b307c1134edfc6b99c16cd8ca320755b96ff07514ffbbea92471d9028">PATTERN_STROBE</a></div><div class="ttdeci">@ PATTERN_STROBE</div><div class="ttdef"><b>Definition:</b> <a href="Patterns_8h_source.html#l00025">Patterns.h:25</a></div></div>
<div class="ttc" id="aPatterns_8h_html_a40b65bd8b307c1134edfc6b99c16cd8ca4e822cef21b6083fdffcec08c596a96c"><div class="ttname"><a href="Patterns_8h.html#a40b65bd8b307c1134edfc6b99c16cd8ca4e822cef21b6083fdffcec08c596a96c">PATTERN_DOPS</a></div><div class="ttdeci">@ PATTERN_DOPS</div><div class="ttdef"><b>Definition:</b> <a href="Patterns_8h_source.html#l00027">Patterns.h:27</a></div></div>
<div class="ttc" id="aPatterns_8h_html_a40b65bd8b307c1134edfc6b99c16cd8ca4e822cef21b6083fdffcec08c596a96c"><div class="ttname"><a href="Patterns_8h.html#a40b65bd8b307c1134edfc6b99c16cd8ca4e822cef21b6083fdffcec08c596a96c">PATTERN_DOPS</a></div><div class="ttdeci">@ PATTERN_DOPS</div><div class="ttdef"><b>Definition:</b> <a href="Patterns_8h_source.html#l00029">Patterns.h:29</a></div></div>
<div class="ttc" id="aPatterns_8h_html_a40b65bd8b307c1134edfc6b99c16cd8caaa6e2e9a992e6f1af14a71b4f8420569"><div class="ttname"><a href="Patterns_8h.html#a40b65bd8b307c1134edfc6b99c16cd8caaa6e2e9a992e6f1af14a71b4f8420569">PATTERN_BACKSTROBE</a></div><div class="ttdeci">@ PATTERN_BACKSTROBE</div><div class="ttdef"><b>Definition:</b> <a href="Patterns_8h_source.html#l00091">Patterns.h:91</a></div></div>
<div class="ttc" id="aclassBackStrobePattern_html_a2629d2ef81926a6af73907204e679a46"><div class="ttname"><a href="classBackStrobePattern.html#a2629d2ef81926a6af73907204e679a46">BackStrobePattern::m_firstPat</a></div><div class="ttdeci">uint8_t m_firstPat</div><div class="ttdef"><b>Definition:</b> <a href="BackStrobePattern_8h_source.html#l00030">BackStrobePattern.h:30</a></div></div>
<div class="ttc" id="aclassBackStrobePattern_html_a2caf5f37910e1f6024cf255c9e5bbaf0"><div class="ttname"><a href="classBackStrobePattern.html#a2caf5f37910e1f6024cf255c9e5bbaf0">BackStrobePattern::m_stepSpeed</a></div><div class="ttdeci">uint8_t m_stepSpeed</div><div class="ttdef"><b>Definition:</b> <a href="BackStrobePattern_8h_source.html#l00022">BackStrobePattern.h:22</a></div></div>
Expand Down
129 changes: 48 additions & 81 deletions docs/core/BlendPattern_8cpp_source.html
View file

Large diffs are not rendered by default.

48 changes: 22 additions & 26 deletions docs/core/BlendPattern_8h_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -105,41 +105,37 @@
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="keyword">protected</span>:</div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160; <span class="comment">// only override the onBlinkOn so we can control the color it blinks</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classBlendPattern.html#a89e50f88624d3df91d988d7fb87c588e">onBlinkOn</a>() <span class="keyword">override</span>;</div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classBlendPattern.html#aa4ea7b854109b6d16fb18241ec31ad56">transitionValue</a>(uint8_t &amp;current, <span class="keyword">const</span> uint8_t next, <span class="keywordtype">bool</span> hue);</div>
<div class="line"><a name="l00020"></a><span class="lineno"><a class="line" href="classBlendPattern.html#a31fb8daa34213a09aef2261da46f2e2c"> 20</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="classBlendPattern.html#a31fb8daa34213a09aef2261da46f2e2c">doBlink</a>();</div>
<div class="line"><a name="l00021"></a><span class="lineno"><a class="line" href="classBlendPattern.html#adf92aff7f86d474a61d78d08de0706e1"> 21</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="classBlendPattern.html#adf92aff7f86d474a61d78d08de0706e1">doFlip</a>();</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; </div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; <span class="comment">// offset of starting hue and number of flips</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"><a class="line" href="classBlendPattern.html#ad5bf093865849e1a8fed07de519344f7"> 24</a></span>&#160; uint8_t <a class="code" href="classBlendPattern.html#ad5bf093865849e1a8fed07de519344f7">m_blendSpeed</a>;</div>
<div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="classBlendPattern.html#ac064cc355072a04d18ef5b2e55013105"> 25</a></span>&#160; uint8_t <a class="code" href="classBlendPattern.html#ac064cc355072a04d18ef5b2e55013105">m_numFlips</a>;</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; </div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; <span class="comment">// current color and target blend color</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="classBlendPattern.html#abf794bbbc4b16d87a33f665ecfd22fdb"> 28</a></span>&#160; <a class="code" href="classHSVColor.html">HSVColor</a> <a class="code" href="classBlendPattern.html#abf794bbbc4b16d87a33f665ecfd22fdb">m_cur</a>;</div>
<div class="line"><a name="l00029"></a><span class="lineno"><a class="line" href="classBlendPattern.html#abeafe1f14b3cc59ab15e25dd534558e3"> 29</a></span>&#160; <a class="code" href="classHSVColor.html">HSVColor</a> <a class="code" href="classBlendPattern.html#abeafe1f14b3cc59ab15e25dd534558e3">m_next</a>;</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; </div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; <span class="comment">// the current flip counter</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="classBlendPattern.html#a8cc3472bc6a85c6dd162163e8b429a1b"> 32</a></span>&#160; uint8_t <a class="code" href="classBlendPattern.html#a8cc3472bc6a85c6dd162163e8b429a1b">m_flip</a>;</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;};</div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classBlendPattern.html#a623ac046723f4f5cb23cd12f29074fa9">interpolate</a>(uint8_t &amp;current, <span class="keyword">const</span> uint8_t next);</div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; </div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; <span class="comment">// offset of starting hue and number of flips</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"><a class="line" href="classBlendPattern.html#ad5bf093865849e1a8fed07de519344f7"> 22</a></span>&#160; uint8_t <a class="code" href="classBlendPattern.html#ad5bf093865849e1a8fed07de519344f7">m_blendSpeed</a>;</div>
<div class="line"><a name="l00023"></a><span class="lineno"><a class="line" href="classBlendPattern.html#ac064cc355072a04d18ef5b2e55013105"> 23</a></span>&#160; uint8_t <a class="code" href="classBlendPattern.html#ac064cc355072a04d18ef5b2e55013105">m_numFlips</a>;</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; </div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; <span class="comment">// current color and target blend color</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="classBlendPattern.html#a417e520657f10acd0357a5c9e185fdbf"> 26</a></span>&#160; <a class="code" href="classRGBColor.html">RGBColor</a> <a class="code" href="classBlendPattern.html#a417e520657f10acd0357a5c9e185fdbf">m_cur</a>;</div>
<div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="classBlendPattern.html#a8987bd114ee92e07f97d4289a8eed86f"> 27</a></span>&#160; <a class="code" href="classRGBColor.html">RGBColor</a> <a class="code" href="classBlendPattern.html#a8987bd114ee92e07f97d4289a8eed86f">m_next</a>;</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; </div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; <span class="comment">// the current flip counter</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"><a class="line" href="classBlendPattern.html#a8cc3472bc6a85c6dd162163e8b429a1b"> 30</a></span>&#160; uint8_t <a class="code" href="classBlendPattern.html#a8cc3472bc6a85c6dd162163e8b429a1b">m_flip</a>;</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;};</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; </div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; </div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; </div>
<div class="ttc" id="aBasicPattern_8h_html"><div class="ttname"><a href="BasicPattern_8h.html">BasicPattern.h</a></div></div>
<div class="ttc" id="aclassBasicPattern_html"><div class="ttname"><a href="classBasicPattern.html">BasicPattern</a></div><div class="ttdef"><b>Definition:</b> <a href="BasicPattern_8h_source.html#l00007">BasicPattern.h:8</a></div></div>
<div class="ttc" id="aclassBlendPattern_html"><div class="ttname"><a href="classBlendPattern.html">BlendPattern</a></div><div class="ttdef"><b>Definition:</b> <a href="BlendPattern_8h_source.html#l00008">BlendPattern.h:9</a></div></div>
<div class="ttc" id="aclassBlendPattern_html_a31fb8daa34213a09aef2261da46f2e2c"><div class="ttname"><a href="classBlendPattern.html#a31fb8daa34213a09aef2261da46f2e2c">BlendPattern::doBlink</a></div><div class="ttdeci">void doBlink()</div></div>
<div class="ttc" id="aclassBlendPattern_html_a417e520657f10acd0357a5c9e185fdbf"><div class="ttname"><a href="classBlendPattern.html#a417e520657f10acd0357a5c9e185fdbf">BlendPattern::m_cur</a></div><div class="ttdeci">RGBColor m_cur</div><div class="ttdef"><b>Definition:</b> <a href="BlendPattern_8h_source.html#l00026">BlendPattern.h:26</a></div></div>
<div class="ttc" id="aclassBlendPattern_html_a623ac046723f4f5cb23cd12f29074fa9"><div class="ttname"><a href="classBlendPattern.html#a623ac046723f4f5cb23cd12f29074fa9">BlendPattern::interpolate</a></div><div class="ttdeci">void interpolate(uint8_t &amp;current, const uint8_t next)</div><div class="ttdef"><b>Definition:</b> <a href="BlendPattern_8cpp_source.html#l00064">BlendPattern.cpp:64</a></div></div>
<div class="ttc" id="aclassBlendPattern_html_a6cf64630d97a5ede7af5923ed4413e63"><div class="ttname"><a href="classBlendPattern.html#a6cf64630d97a5ede7af5923ed4413e63">BlendPattern::init</a></div><div class="ttdeci">virtual void init() override</div><div class="ttdef"><b>Definition:</b> <a href="BlendPattern_8cpp_source.html#l00025">BlendPattern.cpp:25</a></div></div>
<div class="ttc" id="aclassBlendPattern_html_a783477b4fdc8ec9f06cb0a24ba299ba2"><div class="ttname"><a href="classBlendPattern.html#a783477b4fdc8ec9f06cb0a24ba299ba2">BlendPattern::BlendPattern</a></div><div class="ttdeci">BlendPattern(const PatternArgs &amp;args)</div><div class="ttdef"><b>Definition:</b> <a href="BlendPattern_8cpp_source.html#l00007">BlendPattern.cpp:7</a></div></div>
<div class="ttc" id="aclassBlendPattern_html_a8418ad0548669c40bbef0cff4bdb6b48"><div class="ttname"><a href="classBlendPattern.html#a8418ad0548669c40bbef0cff4bdb6b48">BlendPattern::~BlendPattern</a></div><div class="ttdeci">virtual ~BlendPattern()</div><div class="ttdef"><b>Definition:</b> <a href="BlendPattern_8cpp_source.html#l00021">BlendPattern.cpp:21</a></div></div>
<div class="ttc" id="aclassBlendPattern_html_a8987bd114ee92e07f97d4289a8eed86f"><div class="ttname"><a href="classBlendPattern.html#a8987bd114ee92e07f97d4289a8eed86f">BlendPattern::m_next</a></div><div class="ttdeci">RGBColor m_next</div><div class="ttdef"><b>Definition:</b> <a href="BlendPattern_8h_source.html#l00027">BlendPattern.h:27</a></div></div>
<div class="ttc" id="aclassBlendPattern_html_a89e50f88624d3df91d988d7fb87c588e"><div class="ttname"><a href="classBlendPattern.html#a89e50f88624d3df91d988d7fb87c588e">BlendPattern::onBlinkOn</a></div><div class="ttdeci">virtual void onBlinkOn() override</div><div class="ttdef"><b>Definition:</b> <a href="BlendPattern_8cpp_source.html#l00036">BlendPattern.cpp:36</a></div></div>
<div class="ttc" id="aclassBlendPattern_html_a8cc3472bc6a85c6dd162163e8b429a1b"><div class="ttname"><a href="classBlendPattern.html#a8cc3472bc6a85c6dd162163e8b429a1b">BlendPattern::m_flip</a></div><div class="ttdeci">uint8_t m_flip</div><div class="ttdef"><b>Definition:</b> <a href="BlendPattern_8h_source.html#l00032">BlendPattern.h:32</a></div></div>
<div class="ttc" id="aclassBlendPattern_html_aa4ea7b854109b6d16fb18241ec31ad56"><div class="ttname"><a href="classBlendPattern.html#aa4ea7b854109b6d16fb18241ec31ad56">BlendPattern::transitionValue</a></div><div class="ttdeci">void transitionValue(uint8_t &amp;current, const uint8_t next, bool hue)</div><div class="ttdef"><b>Definition:</b> <a href="BlendPattern_8cpp_source.html#l00072">BlendPattern.cpp:72</a></div></div>
<div class="ttc" id="aclassBlendPattern_html_abeafe1f14b3cc59ab15e25dd534558e3"><div class="ttname"><a href="classBlendPattern.html#abeafe1f14b3cc59ab15e25dd534558e3">BlendPattern::m_next</a></div><div class="ttdeci">HSVColor m_next</div><div class="ttdef"><b>Definition:</b> <a href="BlendPattern_8h_source.html#l00029">BlendPattern.h:29</a></div></div>
<div class="ttc" id="aclassBlendPattern_html_abf794bbbc4b16d87a33f665ecfd22fdb"><div class="ttname"><a href="classBlendPattern.html#abf794bbbc4b16d87a33f665ecfd22fdb">BlendPattern::m_cur</a></div><div class="ttdeci">HSVColor m_cur</div><div class="ttdef"><b>Definition:</b> <a href="BlendPattern_8h_source.html#l00028">BlendPattern.h:28</a></div></div>
<div class="ttc" id="aclassBlendPattern_html_ac064cc355072a04d18ef5b2e55013105"><div class="ttname"><a href="classBlendPattern.html#ac064cc355072a04d18ef5b2e55013105">BlendPattern::m_numFlips</a></div><div class="ttdeci">uint8_t m_numFlips</div><div class="ttdef"><b>Definition:</b> <a href="BlendPattern_8h_source.html#l00025">BlendPattern.h:25</a></div></div>
<div class="ttc" id="aclassBlendPattern_html_ad5bf093865849e1a8fed07de519344f7"><div class="ttname"><a href="classBlendPattern.html#ad5bf093865849e1a8fed07de519344f7">BlendPattern::m_blendSpeed</a></div><div class="ttdeci">uint8_t m_blendSpeed</div><div class="ttdef"><b>Definition:</b> <a href="BlendPattern_8h_source.html#l00024">BlendPattern.h:24</a></div></div>
<div class="ttc" id="aclassBlendPattern_html_adf92aff7f86d474a61d78d08de0706e1"><div class="ttname"><a href="classBlendPattern.html#adf92aff7f86d474a61d78d08de0706e1">BlendPattern::doFlip</a></div><div class="ttdeci">void doFlip()</div></div>
<div class="ttc" id="aclassHSVColor_html"><div class="ttname"><a href="classHSVColor.html">HSVColor</a></div><div class="ttdef"><b>Definition:</b> <a href="ColorTypes_8h_source.html#l00023">ColorTypes.h:24</a></div></div>
<div class="ttc" id="aclassBlendPattern_html_a8cc3472bc6a85c6dd162163e8b429a1b"><div class="ttname"><a href="classBlendPattern.html#a8cc3472bc6a85c6dd162163e8b429a1b">BlendPattern::m_flip</a></div><div class="ttdeci">uint8_t m_flip</div><div class="ttdef"><b>Definition:</b> <a href="BlendPattern_8h_source.html#l00030">BlendPattern.h:30</a></div></div>
<div class="ttc" id="aclassBlendPattern_html_ac064cc355072a04d18ef5b2e55013105"><div class="ttname"><a href="classBlendPattern.html#ac064cc355072a04d18ef5b2e55013105">BlendPattern::m_numFlips</a></div><div class="ttdeci">uint8_t m_numFlips</div><div class="ttdef"><b>Definition:</b> <a href="BlendPattern_8h_source.html#l00023">BlendPattern.h:23</a></div></div>
<div class="ttc" id="aclassBlendPattern_html_ad5bf093865849e1a8fed07de519344f7"><div class="ttname"><a href="classBlendPattern.html#ad5bf093865849e1a8fed07de519344f7">BlendPattern::m_blendSpeed</a></div><div class="ttdeci">uint8_t m_blendSpeed</div><div class="ttdef"><b>Definition:</b> <a href="BlendPattern_8h_source.html#l00022">BlendPattern.h:22</a></div></div>
<div class="ttc" id="aclassPatternArgs_html"><div class="ttname"><a href="classPatternArgs.html">PatternArgs</a></div><div class="ttdef"><b>Definition:</b> <a href="PatternArgs_8h_source.html#l00036">PatternArgs.h:37</a></div></div>
<div class="ttc" id="aclassRGBColor_html"><div class="ttname"><a href="classRGBColor.html">RGBColor</a></div><div class="ttdef"><b>Definition:</b> <a href="ColorTypes_8h_source.html#l00056">ColorTypes.h:57</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
Expand Down
Loading

0 comments on commit 78a4022

Please sign in to comment.