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 Sep 8, 2023
1 parent 78a4022 commit 4482ba8
Show file tree
Hide file tree
Showing 3,042 changed files with 49,143 additions and 47,800 deletions.
The diff you're trying to view is too large. We only load the first 3000 changed files.
4 changes: 2 additions & 2 deletions docs/core/BlendPattern_8cpp_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <span class="comment">// convert to hsv</span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; <a class="code" href="classHSVColor.html">HSVColor</a> hsvCol = <a class="code" href="classBlendPattern.html#a417e520657f10acd0357a5c9e185fdbf">m_cur</a>;</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <span class="comment">// shift the hue by a flip size</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; hsvCol.<a class="code" href="classHSVColor.html#a95d2e23681a08326316331dcb71a2d4c">hue</a> += (<a class="code" href="classBlendPattern.html#a8cc3472bc6a85c6dd162163e8b429a1b">m_flip</a> * (255 / <a class="code" href="classBlendPattern.html#ac064cc355072a04d18ef5b2e55013105">m_numFlips</a>));</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; hsvCol.<a class="code" href="classHSVColor.html#a95d2e23681a08326316331dcb71a2d4c">hue</a> += (<a class="code" href="classBlendPattern.html#a8cc3472bc6a85c6dd162163e8b429a1b">m_flip</a> * (127 / <a class="code" href="classBlendPattern.html#ac064cc355072a04d18ef5b2e55013105">m_numFlips</a>));</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; <span class="comment">// convert the hsv color back to RGB</span></div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; col = hsvCol;</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; }</div>
Expand All @@ -145,7 +145,7 @@
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; <a class="code" href="classBlendPattern.html#a8cc3472bc6a85c6dd162163e8b429a1b">m_flip</a>++;</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <span class="comment">// modulate the flip count DO NOT USE MODULO OPERATOR BECAUSE</span></div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; <span class="comment">// THE FLIP COUNT COULD BE 0 THAT WILL DIVIDE BY ZERO</span></div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <span class="keywordflow">if</span> (<a class="code" href="classBlendPattern.html#a8cc3472bc6a85c6dd162163e8b429a1b">m_flip</a> &gt;= <a class="code" href="classBlendPattern.html#ac064cc355072a04d18ef5b2e55013105">m_numFlips</a>) {</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <span class="keywordflow">if</span> (<a class="code" href="classBlendPattern.html#a8cc3472bc6a85c6dd162163e8b429a1b">m_flip</a> &gt; <a class="code" href="classBlendPattern.html#ac064cc355072a04d18ef5b2e55013105">m_numFlips</a>) {</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; <a class="code" href="classBlendPattern.html#a8cc3472bc6a85c6dd162163e8b429a1b">m_flip</a> = 0;</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; }</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;}</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/core/Buttons_8h_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160; </div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="Button_8h.html">Button.h</a>&quot;</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160; </div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment">// the number of buttons, this isn&#39;t an arduino config because</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment">// the number of buttons, this isn&#39;t in VortexConfig.h because</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment">// changing it won&#39;t really work without updating other things</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment">// like which pins the buttons are attached to. So this is more</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment">// of a hardcoded constant than a configuration setting</span></div>
Expand Down
4 changes: 2 additions & 2 deletions docs/core/ColorSelect_8cpp_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -211,7 +211,7 @@
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160; }</div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160; <span class="comment">// reuse these variables lots</span></div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160; uint8_t numColors = <a class="code" href="classColorSelect.html#a4d7461c1acff67f5497e1b43f3d71422">m_colorset</a>.<a class="code" href="classColorset.html#ae2a0882d7c34a3a2b5e228a3b517d54c">numColors</a>();</div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160; uint8_t holdDur = <a class="code" href="Button_8h.html#a0f2e1bfb2e10150496ad7fb75420713b">g_pButton</a>-&gt;<a class="code" href="classButton.html#a2e0dae337117cd85f69c8346d369504a">holdDuration</a>();</div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160; uint32_t holdDur = <a class="code" href="Button_8h.html#a0f2e1bfb2e10150496ad7fb75420713b">g_pButton</a>-&gt;<a class="code" href="classButton.html#a2e0dae337117cd85f69c8346d369504a">holdDuration</a>();</div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160; <span class="keywordflow">switch</span> (<a class="code" href="classColorSelect.html#a9c4e59f3a40a22ba28f235d4226f613e">m_state</a>) {</div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160; <span class="keywordflow">case</span> <a class="code" href="classColorSelect.html#a9eb6a8c26e649eff65af32a21c03cf2eae11874bf43ee9371ade67deee4946710">STATE_INIT</a>:</div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160; <span class="comment">// nothing</span></div>
Expand Down Expand Up @@ -424,7 +424,7 @@
<div class="ttc" id="aclassMode_html_aa719878c227361144835120787581d94"><div class="ttname"><a href="classMode.html#aa719878c227361144835120787581d94">Mode::init</a></div><div class="ttdeci">virtual void init()</div><div class="ttdef"><b>Definition:</b> <a href="Mode_8cpp_source.html#l00120">Mode.cpp:120</a></div></div>
<div class="ttc" id="aclassMode_html_aca4af72a0131337a51c782b43d402f0f"><div class="ttname"><a href="classMode.html#aca4af72a0131337a51c782b43d402f0f">Mode::isEmpty</a></div><div class="ttdeci">bool isEmpty() const</div><div class="ttdef"><b>Definition:</b> <a href="Mode_8cpp_source.html#l00735">Mode.cpp:735</a></div></div>
<div class="ttc" id="aclassMode_html_afac24695014a247ce0efb77eaad28107"><div class="ttname"><a href="classMode.html#afac24695014a247ce0efb77eaad28107">Mode::setColorsetMap</a></div><div class="ttdeci">bool setColorsetMap(LedMap map, const Colorset &amp;set)</div><div class="ttdef"><b>Definition:</b> <a href="Mode_8cpp_source.html#l00616">Mode.cpp:616</a></div></div>
<div class="ttc" id="aclassModes_html_a1e520dc2ee457bc93a795e9945249dbd"><div class="ttname"><a href="classModes.html#a1e520dc2ee457bc93a795e9945249dbd">Modes::curMode</a></div><div class="ttdeci">static Mode * curMode()</div><div class="ttdef"><b>Definition:</b> <a href="Modes_8cpp_source.html#l00474">Modes.cpp:474</a></div></div>
<div class="ttc" id="aclassModes_html_a1e520dc2ee457bc93a795e9945249dbd"><div class="ttname"><a href="classModes.html#a1e520dc2ee457bc93a795e9945249dbd">Modes::curMode</a></div><div class="ttdeci">static Mode * curMode()</div><div class="ttdef"><b>Definition:</b> <a href="Modes_8cpp_source.html#l00543">Modes.cpp:543</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 class="ttc" id="aclassRGBColor_html_a98fd4b2760d0f3a4e5100a4fd2fa666a"><div class="ttname"><a href="classRGBColor.html#a98fd4b2760d0f3a4e5100a4fd2fa666a">RGBColor::empty</a></div><div class="ttdeci">bool empty() const</div><div class="ttdef"><b>Definition:</b> <a href="ColorTypes_8cpp_source.html#l00181">ColorTypes.cpp:181</a></div></div>
<div class="ttc" id="aclassTime_html_a7c7a8e067bdbd5aaf119521539d30940"><div class="ttname"><a href="classTime.html#a7c7a8e067bdbd5aaf119521539d30940">Time::getCurtime</a></div><div class="ttdeci">static uint32_t getCurtime()</div><div class="ttdef"><b>Definition:</b> <a href="TimeControl_8h_source.html#l00040">TimeControl.h:40</a></div></div>
Expand Down
16 changes: 8 additions & 8 deletions docs/core/ColorSelect_8h_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -157,14 +157,14 @@
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;};</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; </div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="ttc" id="aVortexConfig_8h_html_a566d0264f75fa7175516e9c58eb7dd36"><div class="ttname"><a href="VortexConfig_8h.html#a566d0264f75fa7175516e9c58eb7dd36">VAL_OPTION_1</a></div><div class="ttdeci">#define VAL_OPTION_1</div><div class="ttdef"><b>Definition:</b> <a href="VortexConfig_8h_source.html#l00298">VortexConfig.h:298</a></div></div>
<div class="ttc" id="aVortexConfig_8h_html_a6d5daac30969ecfae3de38fb269c5f3f"><div class="ttname"><a href="VortexConfig_8h.html#a6d5daac30969ecfae3de38fb269c5f3f">VAL_OPTION_2</a></div><div class="ttdeci">#define VAL_OPTION_2</div><div class="ttdef"><b>Definition:</b> <a href="VortexConfig_8h_source.html#l00299">VortexConfig.h:299</a></div></div>
<div class="ttc" id="aVortexConfig_8h_html_a7148d6f9203141162240ae9b2b1f6e77"><div class="ttname"><a href="VortexConfig_8h.html#a7148d6f9203141162240ae9b2b1f6e77">SAT_OPTION_3</a></div><div class="ttdeci">#define SAT_OPTION_3</div><div class="ttdef"><b>Definition:</b> <a href="VortexConfig_8h_source.html#l00291">VortexConfig.h:291</a></div></div>
<div class="ttc" id="aVortexConfig_8h_html_aafe3dba4d9910272e4c67d22cc03f9aa"><div class="ttname"><a href="VortexConfig_8h.html#aafe3dba4d9910272e4c67d22cc03f9aa">VAL_OPTION_4</a></div><div class="ttdeci">#define VAL_OPTION_4</div><div class="ttdef"><b>Definition:</b> <a href="VortexConfig_8h_source.html#l00301">VortexConfig.h:301</a></div></div>
<div class="ttc" id="aVortexConfig_8h_html_ac7978edcaef1bd8a476d966b006a606a"><div class="ttname"><a href="VortexConfig_8h.html#ac7978edcaef1bd8a476d966b006a606a">SAT_OPTION_2</a></div><div class="ttdeci">#define SAT_OPTION_2</div><div class="ttdef"><b>Definition:</b> <a href="VortexConfig_8h_source.html#l00290">VortexConfig.h:290</a></div></div>
<div class="ttc" id="aVortexConfig_8h_html_ae20c02bd96b958902840a01cb18ce68c"><div class="ttname"><a href="VortexConfig_8h.html#ae20c02bd96b958902840a01cb18ce68c">SAT_OPTION_4</a></div><div class="ttdeci">#define SAT_OPTION_4</div><div class="ttdef"><b>Definition:</b> <a href="VortexConfig_8h_source.html#l00292">VortexConfig.h:292</a></div></div>
<div class="ttc" id="aVortexConfig_8h_html_aebc4e104bdde1297944f1c5f8be55e13"><div class="ttname"><a href="VortexConfig_8h.html#aebc4e104bdde1297944f1c5f8be55e13">VAL_OPTION_3</a></div><div class="ttdeci">#define VAL_OPTION_3</div><div class="ttdef"><b>Definition:</b> <a href="VortexConfig_8h_source.html#l00300">VortexConfig.h:300</a></div></div>
<div class="ttc" id="aVortexConfig_8h_html_af9016475e2f2c4d0558f4218348038d9"><div class="ttname"><a href="VortexConfig_8h.html#af9016475e2f2c4d0558f4218348038d9">SAT_OPTION_1</a></div><div class="ttdeci">#define SAT_OPTION_1</div><div class="ttdef"><b>Definition:</b> <a href="VortexConfig_8h_source.html#l00289">VortexConfig.h:289</a></div></div>
<div class="ttc" id="aVortexConfig_8h_html_a566d0264f75fa7175516e9c58eb7dd36"><div class="ttname"><a href="VortexConfig_8h.html#a566d0264f75fa7175516e9c58eb7dd36">VAL_OPTION_1</a></div><div class="ttdeci">#define VAL_OPTION_1</div><div class="ttdef"><b>Definition:</b> <a href="VortexConfig_8h_source.html#l00297">VortexConfig.h:297</a></div></div>
<div class="ttc" id="aVortexConfig_8h_html_a6d5daac30969ecfae3de38fb269c5f3f"><div class="ttname"><a href="VortexConfig_8h.html#a6d5daac30969ecfae3de38fb269c5f3f">VAL_OPTION_2</a></div><div class="ttdeci">#define VAL_OPTION_2</div><div class="ttdef"><b>Definition:</b> <a href="VortexConfig_8h_source.html#l00298">VortexConfig.h:298</a></div></div>
<div class="ttc" id="aVortexConfig_8h_html_a7148d6f9203141162240ae9b2b1f6e77"><div class="ttname"><a href="VortexConfig_8h.html#a7148d6f9203141162240ae9b2b1f6e77">SAT_OPTION_3</a></div><div class="ttdeci">#define SAT_OPTION_3</div><div class="ttdef"><b>Definition:</b> <a href="VortexConfig_8h_source.html#l00290">VortexConfig.h:290</a></div></div>
<div class="ttc" id="aVortexConfig_8h_html_aafe3dba4d9910272e4c67d22cc03f9aa"><div class="ttname"><a href="VortexConfig_8h.html#aafe3dba4d9910272e4c67d22cc03f9aa">VAL_OPTION_4</a></div><div class="ttdeci">#define VAL_OPTION_4</div><div class="ttdef"><b>Definition:</b> <a href="VortexConfig_8h_source.html#l00300">VortexConfig.h:300</a></div></div>
<div class="ttc" id="aVortexConfig_8h_html_ac7978edcaef1bd8a476d966b006a606a"><div class="ttname"><a href="VortexConfig_8h.html#ac7978edcaef1bd8a476d966b006a606a">SAT_OPTION_2</a></div><div class="ttdeci">#define SAT_OPTION_2</div><div class="ttdef"><b>Definition:</b> <a href="VortexConfig_8h_source.html#l00289">VortexConfig.h:289</a></div></div>
<div class="ttc" id="aVortexConfig_8h_html_ae20c02bd96b958902840a01cb18ce68c"><div class="ttname"><a href="VortexConfig_8h.html#ae20c02bd96b958902840a01cb18ce68c">SAT_OPTION_4</a></div><div class="ttdeci">#define SAT_OPTION_4</div><div class="ttdef"><b>Definition:</b> <a href="VortexConfig_8h_source.html#l00291">VortexConfig.h:291</a></div></div>
<div class="ttc" id="aVortexConfig_8h_html_aebc4e104bdde1297944f1c5f8be55e13"><div class="ttname"><a href="VortexConfig_8h.html#aebc4e104bdde1297944f1c5f8be55e13">VAL_OPTION_3</a></div><div class="ttdeci">#define VAL_OPTION_3</div><div class="ttdef"><b>Definition:</b> <a href="VortexConfig_8h_source.html#l00299">VortexConfig.h:299</a></div></div>
<div class="ttc" id="aVortexConfig_8h_html_af9016475e2f2c4d0558f4218348038d9"><div class="ttname"><a href="VortexConfig_8h.html#af9016475e2f2c4d0558f4218348038d9">SAT_OPTION_1</a></div><div class="ttdeci">#define SAT_OPTION_1</div><div class="ttdef"><b>Definition:</b> <a href="VortexConfig_8h_source.html#l00288">VortexConfig.h:288</a></div></div>
<div class="ttc" id="aclassColorSelect_html"><div class="ttname"><a href="classColorSelect.html">ColorSelect</a></div><div class="ttdef"><b>Definition:</b> <a href="ColorSelect_8h_source.html#l00008">ColorSelect.h:9</a></div></div>
<div class="ttc" id="aclassColorSelect_html_a156d875177e2b57b15388ba0f6aa9299"><div class="ttname"><a href="classColorSelect.html#a156d875177e2b57b15388ba0f6aa9299">ColorSelect::vals</a></div><div class="ttdeci">const uint8_t vals[4]</div><div class="ttdef"><b>Definition:</b> <a href="ColorSelect_8h_source.html#l00048">ColorSelect.h:48</a></div></div>
<div class="ttc" id="aclassColorSelect_html_a18b476ecc26286973828375444944844"><div class="ttname"><a href="classColorSelect.html#a18b476ecc26286973828375444944844">ColorSelect::init</a></div><div class="ttdeci">bool init() override</div><div class="ttdef"><b>Definition:</b> <a href="ColorSelect_8cpp_source.html#l00037">ColorSelect.cpp:37</a></div></div>
Expand Down
2 changes: 1 addition & 1 deletion docs/core/ColorTypes_8cpp.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -363,7 +363,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#af3ef0c7054bb571933dab90c
<div class="line"><a name="l00241"></a><span class="lineno"> 241</span>&#160; </div>
<div class="line"><a name="l00242"></a><span class="lineno"> 242</span>&#160; <span class="comment">// Gscale: what to scale green down by.</span></div>
<div class="line"><a name="l00243"></a><span class="lineno"> 243</span>&#160; <span class="comment">// Depends GREATLY on your particular LEDs</span></div>
<div class="line"><a name="l00244"></a><span class="lineno"> 244</span>&#160; <span class="keyword">const</span> uint8_t Gscale = 0;</div>
<div class="line"><a name="l00244"></a><span class="lineno"> 244</span>&#160; <span class="keyword">const</span> uint8_t Gscale = 185;</div>
<div class="line"><a name="l00245"></a><span class="lineno"> 245</span>&#160; </div>
<div class="line"><a name="l00246"></a><span class="lineno"> 246</span>&#160; </div>
<div class="line"><a name="l00247"></a><span class="lineno"> 247</span>&#160; uint8_t hue = rhs.<a class="code" href="classHSVColor.html#a95d2e23681a08326316331dcb71a2d4c">hue</a>;</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/core/ColorTypes_8cpp_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -330,7 +330,7 @@
<div class="line"><a name="l00241"></a><span class="lineno"> 241</span>&#160; </div>
<div class="line"><a name="l00242"></a><span class="lineno"> 242</span>&#160; <span class="comment">// Gscale: what to scale green down by.</span></div>
<div class="line"><a name="l00243"></a><span class="lineno"> 243</span>&#160; <span class="comment">// Depends GREATLY on your particular LEDs</span></div>
<div class="line"><a name="l00244"></a><span class="lineno"> 244</span>&#160; <span class="keyword">const</span> uint8_t Gscale = 0;</div>
<div class="line"><a name="l00244"></a><span class="lineno"> 244</span>&#160; <span class="keyword">const</span> uint8_t Gscale = 185;</div>
<div class="line"><a name="l00245"></a><span class="lineno"> 245</span>&#160; </div>
<div class="line"><a name="l00246"></a><span class="lineno"> 246</span>&#160; </div>
<div class="line"><a name="l00247"></a><span class="lineno"> 247</span>&#160; uint8_t hue = rhs.<a class="code" href="classHSVColor.html#a95d2e23681a08326316331dcb71a2d4c">hue</a>;</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/core/ColorTypes_8h.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -282,7 +282,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#af3ef0c7054bb571933dab90c
<div class="line"><a name="l00241"></a><span class="lineno"> 241</span>&#160; </div>
<div class="line"><a name="l00242"></a><span class="lineno"> 242</span>&#160; <span class="comment">// Gscale: what to scale green down by.</span></div>
<div class="line"><a name="l00243"></a><span class="lineno"> 243</span>&#160; <span class="comment">// Depends GREATLY on your particular LEDs</span></div>
<div class="line"><a name="l00244"></a><span class="lineno"> 244</span>&#160; <span class="keyword">const</span> uint8_t Gscale = 0;</div>
<div class="line"><a name="l00244"></a><span class="lineno"> 244</span>&#160; <span class="keyword">const</span> uint8_t Gscale = 185;</div>
<div class="line"><a name="l00245"></a><span class="lineno"> 245</span>&#160; </div>
<div class="line"><a name="l00246"></a><span class="lineno"> 246</span>&#160; </div>
<div class="line"><a name="l00247"></a><span class="lineno"> 247</span>&#160; uint8_t hue = rhs.<a class="code" href="classHSVColor.html#a95d2e23681a08326316331dcb71a2d4c">hue</a>;</div>
Expand Down
Loading

0 comments on commit 4482ba8

Please sign in to comment.