diff options
Diffstat (limited to 'docs/3.1/class_c_pixel_l_e_d_controller.html')
| -rw-r--r-- | docs/3.1/class_c_pixel_l_e_d_controller.html | 411 |
1 files changed, 411 insertions, 0 deletions
diff --git a/docs/3.1/class_c_pixel_l_e_d_controller.html b/docs/3.1/class_c_pixel_l_e_d_controller.html new file mode 100644 index 00000000..30e19935 --- /dev/null +++ b/docs/3.1/class_c_pixel_l_e_d_controller.html @@ -0,0 +1,411 @@ +<!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="Content-Type" content="text/xhtml;charset=UTF-8"/> +<meta http-equiv="X-UA-Compatible" content="IE=9"/> +<meta name="generator" content="Doxygen 1.8.9.1"/> +<title>FastLED: CPixelLEDController< RGB_ORDER, LANES, MASK > Class Template 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> +<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> +<script type="text/javascript"> + $(document).ready(initResizable); + $(window).load(resizeHeight); +</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> +<script type="text/javascript"> + $(document).ready(function() { init_search(); }); +</script> +<link href="doxygen.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 style="padding-left: 0.5em;"> + <div id="projectname">FastLED +  <span id="projectnumber">3.1</span> + </div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.9.1 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> + <div id="navrow1" class="tabs"> + <ul class="tablist"> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="pages.html"><span>Related Pages</span></a></li> + <li><a href="modules.html"><span>Modules</span></a></li> + <li class="current"><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + <li> + <div id="MSearchBox" class="MSearchBoxInactive"> + <span class="left"> + <img id="MSearchSelect" src="search/mag_sel.png" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + alt=""/> + <input type="text" id="MSearchField" value="Search" accesskey="S" + onfocus="searchBox.OnSearchFieldFocus(true)" + onblur="searchBox.OnSearchFieldFocus(false)" + onkeyup="searchBox.OnSearchFieldChange(event)"/> + </span><span class="right"> + <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> + </span> + </div> + </li> + </ul> + </div> + <div id="navrow2" class="tabs2"> + <ul class="tablist"> + <li><a href="annotated.html"><span>Class List</span></a></li> + <li><a href="classes.html"><span>Class Index</span></a></li> + <li><a href="inherits.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Class Members</span></a></li> + </ul> + </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"> +$(document).ready(function(){initNavTree('class_c_pixel_l_e_d_controller.html','');}); +</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"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +<div class="header"> + <div class="summary"> +<a href="#pro-methods">Protected Member Functions</a> | +<a href="class_c_pixel_l_e_d_controller-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">CPixelLEDController< RGB_ORDER, LANES, MASK > Class Template Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div> +</div><!--header--> +<div class="contents"> +<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"> + <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for CPixelLEDController< RGB_ORDER, LANES, MASK >:</div> +<div id="dynsection-0-summary" class="dynsummary" style="display:block;"> +</div> +<div id="dynsection-0-content" class="dyncontent" style="display:none;"> +<div class="center"><img src="class_c_pixel_l_e_d_controller__inherit__graph.png" border="0" usemap="#_c_pixel_l_e_d_controller_3_01_r_g_b___o_r_d_e_r_00_01_l_a_n_e_s_00_01_m_a_s_k_01_4_inherit__map" alt="Inheritance graph"/></div> +<map name="_c_pixel_l_e_d_controller_3_01_r_g_b___o_r_d_e_r_00_01_l_a_n_e_s_00_01_m_a_s_k_01_4_inherit__map" id="_c_pixel_l_e_d_controller_3_01_r_g_b___o_r_d_e_r_00_01_l_a_n_e_s_00_01_m_a_s_k_01_4_inherit__map"> +<area shape="rect" id="node2" href="class_c_l_e_d_controller.html" title="Base definition for an LED controller. " alt="" coords="34,5,149,32"/></map> +<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div> +<div id="dynsection-1" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;"> + <img id="dynsection-1-trigger" src="closed.png" alt="+"/> Collaboration diagram for CPixelLEDController< RGB_ORDER, LANES, MASK >:</div> +<div id="dynsection-1-summary" class="dynsummary" style="display:block;"> +</div> +<div id="dynsection-1-content" class="dyncontent" style="display:none;"> +<div class="center"><img src="class_c_pixel_l_e_d_controller__coll__graph.png" border="0" usemap="#_c_pixel_l_e_d_controller_3_01_r_g_b___o_r_d_e_r_00_01_l_a_n_e_s_00_01_m_a_s_k_01_4_coll__map" alt="Collaboration graph"/></div> +<map name="_c_pixel_l_e_d_controller_3_01_r_g_b___o_r_d_e_r_00_01_l_a_n_e_s_00_01_m_a_s_k_01_4_coll__map" id="_c_pixel_l_e_d_controller_3_01_r_g_b___o_r_d_e_r_00_01_l_a_n_e_s_00_01_m_a_s_k_01_4_coll__map"> +<area shape="rect" id="node2" href="class_c_l_e_d_controller.html" title="Base definition for an LED controller. " alt="" coords="34,133,149,160"/><area shape="rect" id="node3" href="struct_c_r_g_b.html" title="Representation of an RGB pixel (Red, Green, Blue) " alt="" coords="62,5,121,32"/></map> +<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a> +Protected Member Functions</h2></td></tr> +<tr class="memitem:a1ab7248c894ba95c3a71665f5bed2a17"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1ab7248c894ba95c3a71665f5bed2a17"></a> +virtual void </td><td class="memItemRight" valign="bottom"><b>showPixels</b> (<a class="el" href="struct_pixel_controller.html">PixelController</a>< RGB_ORDER, LANES, MASK > &pixels)=0</td></tr> +<tr class="separator:a1ab7248c894ba95c3a71665f5bed2a17"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:af5569b9e92f75410e03c75bf5764e016"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_pixel_l_e_d_controller.html#af5569b9e92f75410e03c75bf5764e016">showColor</a> (const struct <a class="el" href="struct_c_r_g_b.html">CRGB</a> &data, int nLeds, <a class="el" href="struct_c_r_g_b.html">CRGB</a> scale)</td></tr> +<tr class="memdesc:af5569b9e92f75410e03c75bf5764e016"><td class="mdescLeft"> </td><td class="mdescRight">set all the leds on the controller to a given color <a href="#af5569b9e92f75410e03c75bf5764e016">More...</a><br /></td></tr> +<tr class="separator:af5569b9e92f75410e03c75bf5764e016"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a36cc2a15671bae0db53df1e26b4a813c"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_pixel_l_e_d_controller.html#a36cc2a15671bae0db53df1e26b4a813c">show</a> (const struct <a class="el" href="struct_c_r_g_b.html">CRGB</a> *data, int nLeds, <a class="el" href="struct_c_r_g_b.html">CRGB</a> scale)</td></tr> +<tr class="memdesc:a36cc2a15671bae0db53df1e26b4a813c"><td class="mdescLeft"> </td><td class="mdescRight">write the passed in rgb data out to the leds managed by this controller <a href="#a36cc2a15671bae0db53df1e26b4a813c">More...</a><br /></td></tr> +<tr class="separator:a36cc2a15671bae0db53df1e26b4a813c"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a> +Additional Inherited Members</h2></td></tr> +<tr class="inherit_header pub_methods_class_c_l_e_d_controller"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_c_l_e_d_controller')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_c_l_e_d_controller.html">CLEDController</a></td></tr> +<tr class="memitem:a8c560c6d171f117dfd19c0f2ec780a32 inherit pub_methods_class_c_l_e_d_controller"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8c560c6d171f117dfd19c0f2ec780a32"></a> + </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_l_e_d_controller.html#a8c560c6d171f117dfd19c0f2ec780a32">CLEDController</a> ()</td></tr> +<tr class="memdesc:a8c560c6d171f117dfd19c0f2ec780a32 inherit pub_methods_class_c_l_e_d_controller"><td class="mdescLeft"> </td><td class="mdescRight">create an led controller object, add it to the chain of controllers <br /></td></tr> +<tr class="separator:a8c560c6d171f117dfd19c0f2ec780a32 inherit pub_methods_class_c_l_e_d_controller"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:af877a15a5ec452780fbd1d359b8a9913 inherit pub_methods_class_c_l_e_d_controller"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af877a15a5ec452780fbd1d359b8a9913"></a> +virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_l_e_d_controller.html#af877a15a5ec452780fbd1d359b8a9913">init</a> ()=0</td></tr> +<tr class="memdesc:af877a15a5ec452780fbd1d359b8a9913 inherit pub_methods_class_c_l_e_d_controller"><td class="mdescLeft"> </td><td class="mdescRight">initialize the LED controller <br /></td></tr> +<tr class="separator:af877a15a5ec452780fbd1d359b8a9913 inherit pub_methods_class_c_l_e_d_controller"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:abd0f6ce4701e76ebc4b916e0a04134f2 inherit pub_methods_class_c_l_e_d_controller"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abd0f6ce4701e76ebc4b916e0a04134f2"></a> +virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_l_e_d_controller.html#abd0f6ce4701e76ebc4b916e0a04134f2">clearLeds</a> (int nLeds)</td></tr> +<tr class="memdesc:abd0f6ce4701e76ebc4b916e0a04134f2 inherit pub_methods_class_c_l_e_d_controller"><td class="mdescLeft"> </td><td class="mdescRight">clear out/zero out the given number of leds. <br /></td></tr> +<tr class="separator:abd0f6ce4701e76ebc4b916e0a04134f2 inherit pub_methods_class_c_l_e_d_controller"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:abe990b9a65f5bff1f391cc5c28752abb inherit pub_methods_class_c_l_e_d_controller"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abe990b9a65f5bff1f391cc5c28752abb"></a> +void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_l_e_d_controller.html#abe990b9a65f5bff1f391cc5c28752abb">show</a> (const struct <a class="el" href="struct_c_r_g_b.html">CRGB</a> *data, int nLeds, uint8_t brightness)</td></tr> +<tr class="memdesc:abe990b9a65f5bff1f391cc5c28752abb inherit pub_methods_class_c_l_e_d_controller"><td class="mdescLeft"> </td><td class="mdescRight">show function w/integer brightness, will scale for color correction and temperature <br /></td></tr> +<tr class="separator:abe990b9a65f5bff1f391cc5c28752abb inherit pub_methods_class_c_l_e_d_controller"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a253069a734075b298da65d59d6efbb3b inherit pub_methods_class_c_l_e_d_controller"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a253069a734075b298da65d59d6efbb3b"></a> +void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_l_e_d_controller.html#a253069a734075b298da65d59d6efbb3b">showColor</a> (const struct <a class="el" href="struct_c_r_g_b.html">CRGB</a> &data, int nLeds, uint8_t brightness)</td></tr> +<tr class="memdesc:a253069a734075b298da65d59d6efbb3b inherit pub_methods_class_c_l_e_d_controller"><td class="mdescLeft"> </td><td class="mdescRight">show function w/integer brightness, will scale for color correction and temperature <br /></td></tr> +<tr class="separator:a253069a734075b298da65d59d6efbb3b inherit pub_methods_class_c_l_e_d_controller"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aa4124b1cf5546ad028166e7884276076 inherit pub_methods_class_c_l_e_d_controller"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa4124b1cf5546ad028166e7884276076"></a> +void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_l_e_d_controller.html#aa4124b1cf5546ad028166e7884276076">showLeds</a> (uint8_t brightness=255)</td></tr> +<tr class="memdesc:aa4124b1cf5546ad028166e7884276076 inherit pub_methods_class_c_l_e_d_controller"><td class="mdescLeft"> </td><td class="mdescRight">show function using the "attached to this controller" led data <br /></td></tr> +<tr class="separator:aa4124b1cf5546ad028166e7884276076 inherit pub_methods_class_c_l_e_d_controller"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a4ccd149ab7282817041a1ae4e586a9d4 inherit pub_methods_class_c_l_e_d_controller"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4ccd149ab7282817041a1ae4e586a9d4"></a> +void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_l_e_d_controller.html#a4ccd149ab7282817041a1ae4e586a9d4">showColor</a> (const struct <a class="el" href="struct_c_r_g_b.html">CRGB</a> &data, uint8_t brightness=255)</td></tr> +<tr class="memdesc:a4ccd149ab7282817041a1ae4e586a9d4 inherit pub_methods_class_c_l_e_d_controller"><td class="mdescLeft"> </td><td class="mdescRight">show the given color on the led strip <br /></td></tr> +<tr class="separator:a4ccd149ab7282817041a1ae4e586a9d4 inherit pub_methods_class_c_l_e_d_controller"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a06cfb05ad6e0f7982328928051f3f565 inherit pub_methods_class_c_l_e_d_controller"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a06cfb05ad6e0f7982328928051f3f565"></a> +<a class="el" href="class_c_l_e_d_controller.html">CLEDController</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_l_e_d_controller.html#a06cfb05ad6e0f7982328928051f3f565">next</a> ()</td></tr> +<tr class="memdesc:a06cfb05ad6e0f7982328928051f3f565 inherit pub_methods_class_c_l_e_d_controller"><td class="mdescLeft"> </td><td class="mdescRight">get the next controller in the chain after this one. will return NULL at the end of the chain <br /></td></tr> +<tr class="separator:a06cfb05ad6e0f7982328928051f3f565 inherit pub_methods_class_c_l_e_d_controller"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a5b08378b29f92c5def65175ec5334037 inherit pub_methods_class_c_l_e_d_controller"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5b08378b29f92c5def65175ec5334037"></a> +<a class="el" href="class_c_l_e_d_controller.html">CLEDController</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_l_e_d_controller.html#a5b08378b29f92c5def65175ec5334037">setLeds</a> (<a class="el" href="struct_c_r_g_b.html">CRGB</a> *data, int nLeds)</td></tr> +<tr class="memdesc:a5b08378b29f92c5def65175ec5334037 inherit pub_methods_class_c_l_e_d_controller"><td class="mdescLeft"> </td><td class="mdescRight">set the default array of leds to be used by this controller <br /></td></tr> +<tr class="separator:a5b08378b29f92c5def65175ec5334037 inherit pub_methods_class_c_l_e_d_controller"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a7b61c81e004c96ff670a2742057a5a52 inherit pub_methods_class_c_l_e_d_controller"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7b61c81e004c96ff670a2742057a5a52"></a> +void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_l_e_d_controller.html#a7b61c81e004c96ff670a2742057a5a52">clearLedData</a> ()</td></tr> +<tr class="memdesc:a7b61c81e004c96ff670a2742057a5a52 inherit pub_methods_class_c_l_e_d_controller"><td class="mdescLeft"> </td><td class="mdescRight">zero out the led data managed by this controller <br /></td></tr> +<tr class="separator:a7b61c81e004c96ff670a2742057a5a52 inherit pub_methods_class_c_l_e_d_controller"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a63f75cf7e55cf8da46db5fd27110bb3e inherit pub_methods_class_c_l_e_d_controller"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a63f75cf7e55cf8da46db5fd27110bb3e"></a> +virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_l_e_d_controller.html#a63f75cf7e55cf8da46db5fd27110bb3e">size</a> ()</td></tr> +<tr class="memdesc:a63f75cf7e55cf8da46db5fd27110bb3e inherit pub_methods_class_c_l_e_d_controller"><td class="mdescLeft"> </td><td class="mdescRight">How many leds does this controller manage? <br /></td></tr> +<tr class="separator:a63f75cf7e55cf8da46db5fd27110bb3e inherit pub_methods_class_c_l_e_d_controller"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a5e86c45c89ebfb7b21f9045790302399 inherit pub_methods_class_c_l_e_d_controller"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5e86c45c89ebfb7b21f9045790302399"></a> +<a class="el" href="struct_c_r_g_b.html">CRGB</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_l_e_d_controller.html#a5e86c45c89ebfb7b21f9045790302399">leds</a> ()</td></tr> +<tr class="memdesc:a5e86c45c89ebfb7b21f9045790302399 inherit pub_methods_class_c_l_e_d_controller"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to the <a class="el" href="struct_c_r_g_b.html" title="Representation of an RGB pixel (Red, Green, Blue) ">CRGB</a> array for this controller. <br /></td></tr> +<tr class="separator:a5e86c45c89ebfb7b21f9045790302399 inherit pub_methods_class_c_l_e_d_controller"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a278a429964bec69b3c91486665e61c0a inherit pub_methods_class_c_l_e_d_controller"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a278a429964bec69b3c91486665e61c0a"></a> +<a class="el" href="struct_c_r_g_b.html">CRGB</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_l_e_d_controller.html#a278a429964bec69b3c91486665e61c0a">operator[]</a> (int x)</td></tr> +<tr class="memdesc:a278a429964bec69b3c91486665e61c0a inherit pub_methods_class_c_l_e_d_controller"><td class="mdescLeft"> </td><td class="mdescRight">Reference to the n'th item in the controller. <br /></td></tr> +<tr class="separator:a278a429964bec69b3c91486665e61c0a inherit pub_methods_class_c_l_e_d_controller"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a0703d15ea35deaf94eed59ae27bc3517 inherit pub_methods_class_c_l_e_d_controller"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0703d15ea35deaf94eed59ae27bc3517"></a> +<a class="el" href="class_c_l_e_d_controller.html">CLEDController</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_l_e_d_controller.html#a0703d15ea35deaf94eed59ae27bc3517">setDither</a> (uint8_t ditherMode=BINARY_DITHER)</td></tr> +<tr class="memdesc:a0703d15ea35deaf94eed59ae27bc3517 inherit pub_methods_class_c_l_e_d_controller"><td class="mdescLeft"> </td><td class="mdescRight">set the dithering mode for this controller to use <br /></td></tr> +<tr class="separator:a0703d15ea35deaf94eed59ae27bc3517 inherit pub_methods_class_c_l_e_d_controller"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a676f705adf93898739a405b85150a3e7 inherit pub_methods_class_c_l_e_d_controller"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a676f705adf93898739a405b85150a3e7"></a> +uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_l_e_d_controller.html#a676f705adf93898739a405b85150a3e7">getDither</a> ()</td></tr> +<tr class="memdesc:a676f705adf93898739a405b85150a3e7 inherit pub_methods_class_c_l_e_d_controller"><td class="mdescLeft"> </td><td class="mdescRight">get the dithering option currently set for this controller <br /></td></tr> +<tr class="separator:a676f705adf93898739a405b85150a3e7 inherit pub_methods_class_c_l_e_d_controller"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a9620d0a629a6a3294c71f5f8dbfe91b8 inherit pub_methods_class_c_l_e_d_controller"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9620d0a629a6a3294c71f5f8dbfe91b8"></a> +<a class="el" href="class_c_l_e_d_controller.html">CLEDController</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_l_e_d_controller.html#a9620d0a629a6a3294c71f5f8dbfe91b8">setCorrection</a> (<a class="el" href="struct_c_r_g_b.html">CRGB</a> correction)</td></tr> +<tr class="memdesc:a9620d0a629a6a3294c71f5f8dbfe91b8 inherit pub_methods_class_c_l_e_d_controller"><td class="mdescLeft"> </td><td class="mdescRight">the the color corrction to use for this controller, expressed as an rgb object <br /></td></tr> +<tr class="separator:a9620d0a629a6a3294c71f5f8dbfe91b8 inherit pub_methods_class_c_l_e_d_controller"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a74c43977660742e8185fd666e5d66bf9 inherit pub_methods_class_c_l_e_d_controller"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a74c43977660742e8185fd666e5d66bf9"></a> +<a class="el" href="class_c_l_e_d_controller.html">CLEDController</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_l_e_d_controller.html#a74c43977660742e8185fd666e5d66bf9">setCorrection</a> (<a class="el" href="group___color_enums.html#gadf6bcba67c9573665af20788c4431ae8">LEDColorCorrection</a> correction)</td></tr> +<tr class="memdesc:a74c43977660742e8185fd666e5d66bf9 inherit pub_methods_class_c_l_e_d_controller"><td class="mdescLeft"> </td><td class="mdescRight">set the color correction to use for this controller <br /></td></tr> +<tr class="separator:a74c43977660742e8185fd666e5d66bf9 inherit pub_methods_class_c_l_e_d_controller"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a168c661bb9b4a5dfc797b69d3900b26c inherit pub_methods_class_c_l_e_d_controller"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a168c661bb9b4a5dfc797b69d3900b26c"></a> +<a class="el" href="struct_c_r_g_b.html">CRGB</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_l_e_d_controller.html#a168c661bb9b4a5dfc797b69d3900b26c">getCorrection</a> ()</td></tr> +<tr class="memdesc:a168c661bb9b4a5dfc797b69d3900b26c inherit pub_methods_class_c_l_e_d_controller"><td class="mdescLeft"> </td><td class="mdescRight">get the correction value used by this controller <br /></td></tr> +<tr class="separator:a168c661bb9b4a5dfc797b69d3900b26c inherit pub_methods_class_c_l_e_d_controller"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a69ac4a882bdc4a813ae957ddedb5a883 inherit pub_methods_class_c_l_e_d_controller"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a69ac4a882bdc4a813ae957ddedb5a883"></a> +<a class="el" href="class_c_l_e_d_controller.html">CLEDController</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_l_e_d_controller.html#a69ac4a882bdc4a813ae957ddedb5a883">setTemperature</a> (<a class="el" href="struct_c_r_g_b.html">CRGB</a> temperature)</td></tr> +<tr class="memdesc:a69ac4a882bdc4a813ae957ddedb5a883 inherit pub_methods_class_c_l_e_d_controller"><td class="mdescLeft"> </td><td class="mdescRight">set the color temperature, aka white point, for this controller <br /></td></tr> +<tr class="separator:a69ac4a882bdc4a813ae957ddedb5a883 inherit pub_methods_class_c_l_e_d_controller"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a1e6d35be39f9f67aacdb4709ea914ab4 inherit pub_methods_class_c_l_e_d_controller"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1e6d35be39f9f67aacdb4709ea914ab4"></a> +<a class="el" href="class_c_l_e_d_controller.html">CLEDController</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_l_e_d_controller.html#a1e6d35be39f9f67aacdb4709ea914ab4">setTemperature</a> (<a class="el" href="group___color_enums.html#ga251e9e8dc2c7b981786b71706522b2a9">ColorTemperature</a> temperature)</td></tr> +<tr class="memdesc:a1e6d35be39f9f67aacdb4709ea914ab4 inherit pub_methods_class_c_l_e_d_controller"><td class="mdescLeft"> </td><td class="mdescRight">set the color temperature, aka white point, for this controller <br /></td></tr> +<tr class="separator:a1e6d35be39f9f67aacdb4709ea914ab4 inherit pub_methods_class_c_l_e_d_controller"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:afc94e9d029d7e59f56a4ab845f3de32d inherit pub_methods_class_c_l_e_d_controller"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afc94e9d029d7e59f56a4ab845f3de32d"></a> +<a class="el" href="struct_c_r_g_b.html">CRGB</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_l_e_d_controller.html#afc94e9d029d7e59f56a4ab845f3de32d">getTemperature</a> ()</td></tr> +<tr class="memdesc:afc94e9d029d7e59f56a4ab845f3de32d inherit pub_methods_class_c_l_e_d_controller"><td class="mdescLeft"> </td><td class="mdescRight">get the color temperature, aka whipe point, for this controller <br /></td></tr> +<tr class="separator:afc94e9d029d7e59f56a4ab845f3de32d inherit pub_methods_class_c_l_e_d_controller"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:af6173cca91ee446766cc15102990d7bb inherit pub_methods_class_c_l_e_d_controller"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af6173cca91ee446766cc15102990d7bb"></a> +<a class="el" href="struct_c_r_g_b.html">CRGB</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_l_e_d_controller.html#af6173cca91ee446766cc15102990d7bb">getAdjustment</a> (uint8_t scale)</td></tr> +<tr class="memdesc:af6173cca91ee446766cc15102990d7bb inherit pub_methods_class_c_l_e_d_controller"><td class="mdescLeft"> </td><td class="mdescRight">Get the combined brightness/color adjustment for this controller. <br /></td></tr> +<tr class="separator:af6173cca91ee446766cc15102990d7bb inherit pub_methods_class_c_l_e_d_controller"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a3beb4aff15617bc781c1e49178dd9975 inherit pub_methods_class_c_l_e_d_controller"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3beb4aff15617bc781c1e49178dd9975"></a> +virtual uint16_t </td><td class="memItemRight" valign="bottom"><b>getMaxRefreshRate</b> () const </td></tr> +<tr class="separator:a3beb4aff15617bc781c1e49178dd9975 inherit pub_methods_class_c_l_e_d_controller"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="inherit_header pub_static_methods_class_c_l_e_d_controller"><td colspan="2" onclick="javascript:toggleInherit('pub_static_methods_class_c_l_e_d_controller')"><img src="closed.png" alt="-"/> Static Public Member Functions inherited from <a class="el" href="class_c_l_e_d_controller.html">CLEDController</a></td></tr> +<tr class="memitem:a75a5a6ea50899409d875d72393323ca0 inherit pub_static_methods_class_c_l_e_d_controller"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a75a5a6ea50899409d875d72393323ca0"></a> +static <a class="el" href="class_c_l_e_d_controller.html">CLEDController</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_l_e_d_controller.html#a75a5a6ea50899409d875d72393323ca0">head</a> ()</td></tr> +<tr class="memdesc:a75a5a6ea50899409d875d72393323ca0 inherit pub_static_methods_class_c_l_e_d_controller"><td class="mdescLeft"> </td><td class="mdescRight">get the first led controller in the chain of controllers <br /></td></tr> +<tr class="separator:a75a5a6ea50899409d875d72393323ca0 inherit pub_static_methods_class_c_l_e_d_controller"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a3ad4ceb3bc9ae2efa11e50ffe4b140d4 inherit pub_static_methods_class_c_l_e_d_controller"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3ad4ceb3bc9ae2efa11e50ffe4b140d4"></a> +static <a class="el" href="struct_c_r_g_b.html">CRGB</a> </td><td class="memItemRight" valign="bottom"><b>computeAdjustment</b> (uint8_t scale, const <a class="el" href="struct_c_r_g_b.html">CRGB</a> &colorCorrection, const <a class="el" href="struct_c_r_g_b.html">CRGB</a> &colorTemperature)</td></tr> +<tr class="separator:a3ad4ceb3bc9ae2efa11e50ffe4b140d4 inherit pub_static_methods_class_c_l_e_d_controller"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="inherit_header pro_attribs_class_c_l_e_d_controller"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_class_c_l_e_d_controller')"><img src="closed.png" alt="-"/> Protected Attributes inherited from <a class="el" href="class_c_l_e_d_controller.html">CLEDController</a></td></tr> +<tr class="memitem:a4672f8f1e93d5df90685cb62c4ebbe0e inherit pro_attribs_class_c_l_e_d_controller"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4672f8f1e93d5df90685cb62c4ebbe0e"></a> +<a class="el" href="struct_c_r_g_b.html">CRGB</a> * </td><td class="memItemRight" valign="bottom"><b>m_Data</b></td></tr> +<tr class="separator:a4672f8f1e93d5df90685cb62c4ebbe0e inherit pro_attribs_class_c_l_e_d_controller"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aaad2e8eeedcb36298e0c45d11bcf14b5 inherit pro_attribs_class_c_l_e_d_controller"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaad2e8eeedcb36298e0c45d11bcf14b5"></a> +<a class="el" href="class_c_l_e_d_controller.html">CLEDController</a> * </td><td class="memItemRight" valign="bottom"><b>m_pNext</b></td></tr> +<tr class="separator:aaad2e8eeedcb36298e0c45d11bcf14b5 inherit pro_attribs_class_c_l_e_d_controller"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a4cd7290071572a9844b79b66239cc40b inherit pro_attribs_class_c_l_e_d_controller"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4cd7290071572a9844b79b66239cc40b"></a> +<a class="el" href="struct_c_r_g_b.html">CRGB</a> </td><td class="memItemRight" valign="bottom"><b>m_ColorCorrection</b></td></tr> +<tr class="separator:a4cd7290071572a9844b79b66239cc40b inherit pro_attribs_class_c_l_e_d_controller"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:adb7c56ce6c3f11f392613c3b9bf8c727 inherit pro_attribs_class_c_l_e_d_controller"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adb7c56ce6c3f11f392613c3b9bf8c727"></a> +<a class="el" href="struct_c_r_g_b.html">CRGB</a> </td><td class="memItemRight" valign="bottom"><b>m_ColorTemperature</b></td></tr> +<tr class="separator:adb7c56ce6c3f11f392613c3b9bf8c727 inherit pro_attribs_class_c_l_e_d_controller"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a9af9dd5c08991667e4062396eec5bd8a inherit pro_attribs_class_c_l_e_d_controller"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9af9dd5c08991667e4062396eec5bd8a"></a> +EDitherMode </td><td class="memItemRight" valign="bottom"><b>m_DitherMode</b></td></tr> +<tr class="separator:a9af9dd5c08991667e4062396eec5bd8a inherit pro_attribs_class_c_l_e_d_controller"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ab4d0f0ed5a214b675c9a03aecd7b0df8 inherit pro_attribs_class_c_l_e_d_controller"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab4d0f0ed5a214b675c9a03aecd7b0df8"></a> +int </td><td class="memItemRight" valign="bottom"><b>m_nLeds</b></td></tr> +<tr class="separator:ab4d0f0ed5a214b675c9a03aecd7b0df8 inherit pro_attribs_class_c_l_e_d_controller"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="inherit_header pro_static_attribs_class_c_l_e_d_controller"><td colspan="2" onclick="javascript:toggleInherit('pro_static_attribs_class_c_l_e_d_controller')"><img src="closed.png" alt="-"/> Static Protected Attributes inherited from <a class="el" href="class_c_l_e_d_controller.html">CLEDController</a></td></tr> +<tr class="memitem:afc138dfd8c32629cf4ecf0d430397e77 inherit pro_static_attribs_class_c_l_e_d_controller"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afc138dfd8c32629cf4ecf0d430397e77"></a> +static <a class="el" href="class_c_l_e_d_controller.html">CLEDController</a> * </td><td class="memItemRight" valign="bottom"><b>m_pHead</b> = NULL</td></tr> +<tr class="separator:afc138dfd8c32629cf4ecf0d430397e77 inherit pro_static_attribs_class_c_l_e_d_controller"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aba5aa24458cb37f0f5e6b18a74408a47 inherit pro_static_attribs_class_c_l_e_d_controller"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aba5aa24458cb37f0f5e6b18a74408a47"></a> +static <a class="el" href="class_c_l_e_d_controller.html">CLEDController</a> * </td><td class="memItemRight" valign="bottom"><b>m_pTail</b> = NULL</td></tr> +<tr class="separator:aba5aa24458cb37f0f5e6b18a74408a47 inherit pro_static_attribs_class_c_l_e_d_controller"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><h3>template<EOrder RGB_ORDER, int LANES = 1, uint32_t MASK = 0xFFFFFFFF><br /> +class CPixelLEDController< RGB_ORDER, LANES, MASK ></h3> + + +<p>Definition at line <a class="el" href="controller_8h_source.html#l00374">374</a> of file <a class="el" href="controller_8h_source.html">controller.h</a>.</p> +</div><h2 class="groupheader">Member Function Documentation</h2> +<a class="anchor" id="a36cc2a15671bae0db53df1e26b4a813c"></a> +<div class="memitem"> +<div class="memproto"> +<div class="memtemplate"> +template<EOrder RGB_ORDER, int LANES = 1, uint32_t MASK = 0xFFFFFFFF> </div> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual void <a class="el" href="class_c_pixel_l_e_d_controller.html">CPixelLEDController</a>< RGB_ORDER, LANES, MASK >::show </td> + <td>(</td> + <td class="paramtype">const struct <a class="el" href="struct_c_r_g_b.html">CRGB</a> * </td> + <td class="paramname"><em>data</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"><em>nLeds</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="struct_c_r_g_b.html">CRGB</a> </td> + <td class="paramname"><em>scale</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>write the passed in rgb data out to the leds managed by this controller </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">data</td><td>the rgb data to write out to the strip </td></tr> + <tr><td class="paramname">nLeds</td><td>the number of leds being written out </td></tr> + <tr><td class="paramname">scale</td><td>the rgb scaling to apply to each led before writing it out </td></tr> + </table> + </dd> +</dl> + +<p>Implements <a class="el" href="class_c_l_e_d_controller.html#add284627121ffab140e083e84fadc37f">CLEDController</a>.</p> + +<p>Definition at line <a class="el" href="controller_8h_source.html#l00391">391</a> of file <a class="el" href="controller_8h_source.html">controller.h</a>.</p> + +</div> +</div> +<a class="anchor" id="af5569b9e92f75410e03c75bf5764e016"></a> +<div class="memitem"> +<div class="memproto"> +<div class="memtemplate"> +template<EOrder RGB_ORDER, int LANES = 1, uint32_t MASK = 0xFFFFFFFF> </div> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual void <a class="el" href="class_c_pixel_l_e_d_controller.html">CPixelLEDController</a>< RGB_ORDER, LANES, MASK >::showColor </td> + <td>(</td> + <td class="paramtype">const struct <a class="el" href="struct_c_r_g_b.html">CRGB</a> & </td> + <td class="paramname"><em>data</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"><em>nLeds</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="struct_c_r_g_b.html">CRGB</a> </td> + <td class="paramname"><em>scale</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>set all the leds on the controller to a given color </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">data</td><td>the crgb color to set the leds to </td></tr> + <tr><td class="paramname">nLeds</td><td>the numner of leds to set to this color </td></tr> + <tr><td class="paramname">scale</td><td>the rgb scaling value for outputting color </td></tr> + </table> + </dd> +</dl> + +<p>Implements <a class="el" href="class_c_l_e_d_controller.html#a068fa50d8c7d31bd8537b731eea84c92">CLEDController</a>.</p> + +<p>Definition at line <a class="el" href="controller_8h_source.html#l00382">382</a> of file <a class="el" href="controller_8h_source.html">controller.h</a>.</p> + +</div> +</div> +<hr/>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="controller_8h_source.html">controller.h</a></li> +</ul> +</div><!-- contents --> +</div><!-- doc-content --> +<!-- start footer part --> +<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> + <ul> + <li class="navelem"><a class="el" href="class_c_pixel_l_e_d_controller.html">CPixelLEDController</a></li> + <li class="footer">Generated on Sat Feb 13 2016 13:28:35 for FastLED by + <a href="http://www.doxygen.org/index.html"> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.9.1 </li> + </ul> +</div> +</body> +</html> |