1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
|
<!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: CLEDController Class 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="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>
<!-- 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><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> |
<a href="#pro-static-attribs">Static Protected Attributes</a> |
<a href="#friends">Friends</a> |
<a href="class_c_l_e_d_controller-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">CLEDController Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>Base definition for an LED controller.
<a href="class_c_l_e_d_controller.html#details">More...</a></p>
<p><code>#include <<a class="el" href="controller_8h_source.html">controller.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for CLEDController:</div>
<div class="dyncontent">
<div class="center"><img src="class_c_l_e_d_controller__inherit__graph.png" border="0" usemap="#_c_l_e_d_controller_inherit__map" alt="Inheritance graph"/></div>
<map name="_c_l_e_d_controller_inherit__map" id="_c_l_e_d_controller_inherit__map">
<area shape="rect" id="node2" href="class_a_p_a102_controller.html" title="APA102 controller class. " alt="" coords="171,5,402,61"/><area shape="rect" id="node3" href="class_d_m_x_serial_controller.html" title="DMXSerialController\l\< RGB_ORDER \>" alt="" coords="215,86,359,127"/><area shape="rect" id="node5" href="class_d_m_x_simple_controller.html" title="DMXSimpleController\l\< DATA_PIN, RGB_ORDER \>" alt="" coords="185,151,388,193"/><area shape="rect" id="node7" href="class_l_p_d8806_controller.html" title="LPD8806 controller class. " alt="" coords="185,217,388,273"/><area shape="rect" id="node8" href="class_p9813_controller.html" title="P9813 controller class. " alt="" coords="201,297,372,353"/><area shape="rect" id="node9" href="class_s_m16716_controller.html" title="SM16716 controller class. " alt="" coords="185,377,388,433"/><area shape="rect" id="node10" href="class_w_s2801_controller.html" title="WS2801 controller class. " alt="" coords="171,457,402,513"/><area shape="rect" id="node4" href="class_d_m_x_s_e_r_i_a_l.html" title="DMXSERIAL\< RGB_ORDER \>" alt="" coords="463,93,670,120"/><area shape="rect" id="node6" href="class_d_m_x_s_i_m_p_l_e.html" title="DMXSIMPLE\< DATA_PIN,\l RGB_ORDER \>" alt="" coords="476,151,657,193"/><area shape="rect" id="node11" href="class_w_s2803_controller.html" title="WS2803Controller\< DATA\l_PIN, CLOCK_PIN, RGB_ORDER,\l SPI_SPEED \>" alt="" coords="451,457,682,513"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for CLEDController:</div>
<div class="dyncontent">
<div class="center"><img src="class_c_l_e_d_controller__coll__graph.png" border="0" usemap="#_c_l_e_d_controller_coll__map" alt="Collaboration graph"/></div>
<map name="_c_l_e_d_controller_coll__map" id="_c_l_e_d_controller_coll__map">
<area shape="rect" id="node2" href="struct_c_r_g_b.html" title="CRGB" alt="" coords="33,5,92,32"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a8c560c6d171f117dfd19c0f2ec780a32"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af877a15a5ec452780fbd1d359b8a9913"><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"><td class="mdescLeft"> </td><td class="mdescRight">initialize the LED controller <br /></td></tr>
<tr class="separator:af877a15a5ec452780fbd1d359b8a9913"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adfa6601c84fefd733904b32ac98b6dae"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adfa6601c84fefd733904b32ac98b6dae"></a>
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_l_e_d_controller.html#adfa6601c84fefd733904b32ac98b6dae">clearLeds</a> (int nLeds)=0</td></tr>
<tr class="memdesc:adfa6601c84fefd733904b32ac98b6dae"><td class="mdescLeft"> </td><td class="mdescRight">clear out/zero out the given number of leds. <br /></td></tr>
<tr class="separator:adfa6601c84fefd733904b32ac98b6dae"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abe990b9a65f5bff1f391cc5c28752abb"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a253069a734075b298da65d59d6efbb3b"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa4124b1cf5546ad028166e7884276076"><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"><td class="mdescLeft"> </td><td class="mdescRight">show function using the "attached to this controller" led data <br /></td></tr>
<tr class="separator:aa4124b1cf5546ad028166e7884276076"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4ccd149ab7282817041a1ae4e586a9d4"><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"><td class="mdescLeft"> </td><td class="mdescRight">show the given color on the led strip <br /></td></tr>
<tr class="separator:a4ccd149ab7282817041a1ae4e586a9d4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a06cfb05ad6e0f7982328928051f3f565"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4a55f6d5b215dc14f9473faea938b4c8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4a55f6d5b215dc14f9473faea938b4c8"></a>
void </td><td class="memItemRight" valign="bottom"><b>show</b> (const struct CARGB *data, int nLeds, uint8_t brightness)</td></tr>
<tr class="separator:a4a55f6d5b215dc14f9473faea938b4c8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5b08378b29f92c5def65175ec5334037"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7b61c81e004c96ff670a2742057a5a52"><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"><td class="mdescLeft"> </td><td class="mdescRight">zero out the led data managed by this controller <br /></td></tr>
<tr class="separator:a7b61c81e004c96ff670a2742057a5a52"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8840496d231f1fe0fa640970dc14db08"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8840496d231f1fe0fa640970dc14db08"></a>
int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_l_e_d_controller.html#a8840496d231f1fe0fa640970dc14db08">size</a> ()</td></tr>
<tr class="memdesc:a8840496d231f1fe0fa640970dc14db08"><td class="mdescLeft"> </td><td class="mdescRight">How many leds does this controller manage? <br /></td></tr>
<tr class="separator:a8840496d231f1fe0fa640970dc14db08"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5e86c45c89ebfb7b21f9045790302399"><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"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to the <a class="el" href="struct_c_r_g_b.html">CRGB</a> array for this controller. <br /></td></tr>
<tr class="separator:a5e86c45c89ebfb7b21f9045790302399"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a278a429964bec69b3c91486665e61c0a"><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"><td class="mdescLeft"> </td><td class="mdescRight">Reference to the n'th item in the controller. <br /></td></tr>
<tr class="separator:a278a429964bec69b3c91486665e61c0a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0703d15ea35deaf94eed59ae27bc3517"><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"><td class="mdescLeft"> </td><td class="mdescRight">set the dithering mode for this controller to use <br /></td></tr>
<tr class="separator:a0703d15ea35deaf94eed59ae27bc3517"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a676f705adf93898739a405b85150a3e7"><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"><td class="mdescLeft"> </td><td class="mdescRight">get the dithering option currently set for this controller <br /></td></tr>
<tr class="separator:a676f705adf93898739a405b85150a3e7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9620d0a629a6a3294c71f5f8dbfe91b8"><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"><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"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a74c43977660742e8185fd666e5d66bf9"><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"><td class="mdescLeft"> </td><td class="mdescRight">set the color correction to use for this controller <br /></td></tr>
<tr class="separator:a74c43977660742e8185fd666e5d66bf9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a168c661bb9b4a5dfc797b69d3900b26c"><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"><td class="mdescLeft"> </td><td class="mdescRight">get the correction value used by this controller <br /></td></tr>
<tr class="separator:a168c661bb9b4a5dfc797b69d3900b26c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a69ac4a882bdc4a813ae957ddedb5a883"><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"><td class="mdescLeft"> </td><td class="mdescRight">set the color temperature, aka white point, for this controller <br /></td></tr>
<tr class="separator:a69ac4a882bdc4a813ae957ddedb5a883"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1e6d35be39f9f67aacdb4709ea914ab4"><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"><td class="mdescLeft"> </td><td class="mdescRight">set the color temperature, aka white point, for this controller <br /></td></tr>
<tr class="separator:a1e6d35be39f9f67aacdb4709ea914ab4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afc94e9d029d7e59f56a4ab845f3de32d"><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"><td class="mdescLeft"> </td><td class="mdescRight">get the color temperature, aka whipe point, for this controller <br /></td></tr>
<tr class="separator:afc94e9d029d7e59f56a4ab845f3de32d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af6173cca91ee446766cc15102990d7bb"><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"><td class="mdescLeft"> </td><td class="mdescRight">Get the combined brightness/color adjustment for this controller. <br /></td></tr>
<tr class="separator:af6173cca91ee446766cc15102990d7bb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3beb4aff15617bc781c1e49178dd9975"><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"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a75a5a6ea50899409d875d72393323ca0"><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"><td class="mdescLeft"> </td><td class="mdescRight">get the first led controller in the chain of controllers <br /></td></tr>
<tr class="separator:a75a5a6ea50899409d875d72393323ca0"><td class="memSeparator" colspan="2"> </td></tr>
</table><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:a068fa50d8c7d31bd8537b731eea84c92"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_l_e_d_controller.html#a068fa50d8c7d31bd8537b731eea84c92">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)=0</td></tr>
<tr class="memdesc:a068fa50d8c7d31bd8537b731eea84c92"><td class="mdescLeft"> </td><td class="mdescRight">set all the leds on the controller to a given color <a href="#a068fa50d8c7d31bd8537b731eea84c92">More...</a><br /></td></tr>
<tr class="separator:a068fa50d8c7d31bd8537b731eea84c92"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:add284627121ffab140e083e84fadc37f"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_l_e_d_controller.html#add284627121ffab140e083e84fadc37f">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)=0</td></tr>
<tr class="memdesc:add284627121ffab140e083e84fadc37f"><td class="mdescLeft"> </td><td class="mdescRight">write the passed in rgb data out to the leds managed by this controller <a href="#add284627121ffab140e083e84fadc37f">More...</a><br /></td></tr>
<tr class="separator:add284627121ffab140e083e84fadc37f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3ae4f61fc85ef4609d65c14ca51434c4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3ae4f61fc85ef4609d65c14ca51434c4"></a>
virtual void </td><td class="memItemRight" valign="bottom"><b>show</b> (const struct CARGB *data, int nLeds, <a class="el" href="struct_c_r_g_b.html">CRGB</a> scale)=0</td></tr>
<tr class="separator:a3ae4f61fc85ef4609d65c14ca51434c4"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a4672f8f1e93d5df90685cb62c4ebbe0e"><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"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaad2e8eeedcb36298e0c45d11bcf14b5"><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"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4cd7290071572a9844b79b66239cc40b"><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"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adb7c56ce6c3f11f392613c3b9bf8c727"><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"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9af9dd5c08991667e4062396eec5bd8a"><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"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab4d0f0ed5a214b675c9a03aecd7b0df8"><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"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-static-attribs"></a>
Static Protected Attributes</h2></td></tr>
<tr class="memitem:afc138dfd8c32629cf4ecf0d430397e77"><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"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aba5aa24458cb37f0f5e6b18a74408a47"><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"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:accc1d3beec363be81b003f84f4838d62"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="accc1d3beec363be81b003f84f4838d62"></a>
class </td><td class="memItemRight" valign="bottom"><b>CFastLED</b></td></tr>
<tr class="separator:accc1d3beec363be81b003f84f4838d62"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Base definition for an LED controller. </p>
<p>Pretty much the methods that every LED controller object will make available. Note that the showARGB method is not impelemented for all controllers yet. Note also the methods for eventual checking of background writing of data (I'm looking at you, teensy 3.0 DMA controller!). If you want to pass LED controllers around to methods, make them references to this type, keeps your code saner. However, most people won't be seeing/using these objects directly at all </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="add284627121ffab140e083e84fadc37f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void CLEDController::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">protected</span><span class="mlabel">pure 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>Implemented in <a class="el" href="class_s_m16716_controller.html#a3d720053186fd61d6ad90d48cac3d57d">SM16716Controller< DATA_PIN, CLOCK_PIN, RGB_ORDER, SPI_SPEED ></a>, <a class="el" href="class_p9813_controller.html#aac4f48b0da93055c0da7285839c4ce81">P9813Controller< DATA_PIN, CLOCK_PIN, RGB_ORDER, SPI_SPEED ></a>, <a class="el" href="class_p9813_controller.html#aac4f48b0da93055c0da7285839c4ce81">P9813Controller< DATA_PIN, CLOCK_PIN, RGB_ORDER, SPI_SPEED ></a>, <a class="el" href="class_a_p_a102_controller.html#a245148d2621eb73999ab673852c49332">APA102Controller< DATA_PIN, CLOCK_PIN, RGB_ORDER, SPI_SPEED ></a>, <a class="el" href="class_a_p_a102_controller.html#a245148d2621eb73999ab673852c49332">APA102Controller< DATA_PIN, CLOCK_PIN, RGB_ORDER, SPI_SPEED ></a>, <a class="el" href="class_w_s2801_controller.html#a69fca4db95f5f60f27d7d1a8c7fa16a0">WS2801Controller< DATA_PIN, CLOCK_PIN, RGB_ORDER, SPI_SPEED ></a>, <a class="el" href="class_w_s2801_controller.html#a69fca4db95f5f60f27d7d1a8c7fa16a0">WS2801Controller< DATA_PIN, CLOCK_PIN, RGB_ORDER, SPI_SPEED ></a>, <a class="el" href="class_d_m_x_serial_controller.html#a3f3f3e606e495fd1bdcfd25c6bed7fe1">DMXSerialController< RGB_ORDER ></a>, <a class="el" href="class_l_p_d8806_controller.html#a31d4e01a823682556e26748193f722e5">LPD8806Controller< DATA_PIN, CLOCK_PIN, RGB_ORDER, SPI_SPEED ></a>, and <a class="el" href="class_d_m_x_simple_controller.html#a29df92ccb41090893fa3c49f22b47186">DMXSimpleController< DATA_PIN, RGB_ORDER ></a>.</p>
</div>
</div>
<a class="anchor" id="a068fa50d8c7d31bd8537b731eea84c92"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void CLEDController::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">protected</span><span class="mlabel">pure 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>Implemented in <a class="el" href="class_s_m16716_controller.html#a7df8b8a34e0dc067c69aa056deca9677">SM16716Controller< DATA_PIN, CLOCK_PIN, RGB_ORDER, SPI_SPEED ></a>, <a class="el" href="class_p9813_controller.html#ae60dbfc4d27c62448032c61e7730ec8a">P9813Controller< DATA_PIN, CLOCK_PIN, RGB_ORDER, SPI_SPEED ></a>, <a class="el" href="class_a_p_a102_controller.html#a0aa9f2896fe8b23554623fd3de0d5428">APA102Controller< DATA_PIN, CLOCK_PIN, RGB_ORDER, SPI_SPEED ></a>, <a class="el" href="class_w_s2801_controller.html#a615609bf16dd4c8fcc9ccf286ca52501">WS2801Controller< DATA_PIN, CLOCK_PIN, RGB_ORDER, SPI_SPEED ></a>, <a class="el" href="class_d_m_x_serial_controller.html#a3d6285e65af8862eb4b0d36d6d3df22b">DMXSerialController< RGB_ORDER ></a>, <a class="el" href="class_l_p_d8806_controller.html#a4f6471eddcfe5445502b02f1f3179259">LPD8806Controller< DATA_PIN, CLOCK_PIN, RGB_ORDER, SPI_SPEED ></a>, and <a class="el" href="class_d_m_x_simple_controller.html#a3fb3a0501aae1d7a6aefb89f77168bd1">DMXSimpleController< DATA_PIN, RGB_ORDER ></a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="controller_8h_source.html">controller.h</a></li>
<li>FastLED.cpp</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Aug 10 2015 22:46:45 for FastLED by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.9.1
</small></address>
</body>
</html>
|
