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
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
|
<!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: CFastLED 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="class_c_fast_l_e_d-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">CFastLED Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>High level controller interface for FastLED.
<a href="class_c_fast_l_e_d.html#details">More...</a></p>
<p><code>#include <<a class="el" href="_fast_l_e_d_8h_source.html">FastLED.h</a>></code></p>
<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:a730ba7d967e882b4b893689cf333b2eb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_fast_l_e_d.html#a730ba7d967e882b4b893689cf333b2eb">setBrightness</a> (uint8_t scale)</td></tr>
<tr class="memdesc:a730ba7d967e882b4b893689cf333b2eb"><td class="mdescLeft"> </td><td class="mdescRight">Set the global brightness scaling. <a href="#a730ba7d967e882b4b893689cf333b2eb">More...</a><br /></td></tr>
<tr class="separator:a730ba7d967e882b4b893689cf333b2eb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac2615781ec12e025fb17cc0e66281716"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_fast_l_e_d.html#ac2615781ec12e025fb17cc0e66281716">getBrightness</a> ()</td></tr>
<tr class="memdesc:ac2615781ec12e025fb17cc0e66281716"><td class="mdescLeft"> </td><td class="mdescRight">Get the current global brightness setting. <a href="#ac2615781ec12e025fb17cc0e66281716">More...</a><br /></td></tr>
<tr class="separator:ac2615781ec12e025fb17cc0e66281716"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a83afdd1e2a21f33ac4f8d2610d6e331b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_fast_l_e_d.html#a83afdd1e2a21f33ac4f8d2610d6e331b">show</a> (uint8_t scale)</td></tr>
<tr class="memdesc:a83afdd1e2a21f33ac4f8d2610d6e331b"><td class="mdescLeft"> </td><td class="mdescRight">Update all our controllers with the current led colors, using the passed in brightness. <a href="#a83afdd1e2a21f33ac4f8d2610d6e331b">More...</a><br /></td></tr>
<tr class="separator:a83afdd1e2a21f33ac4f8d2610d6e331b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3adb23ec5f919524928d576002cb45de"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3adb23ec5f919524928d576002cb45de"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_fast_l_e_d.html#a3adb23ec5f919524928d576002cb45de">show</a> ()</td></tr>
<tr class="memdesc:a3adb23ec5f919524928d576002cb45de"><td class="mdescLeft"> </td><td class="mdescRight">Update all our controllers with the current led colors. <br /></td></tr>
<tr class="separator:a3adb23ec5f919524928d576002cb45de"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a042989511cbc42390620bedc196ea956"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_fast_l_e_d.html#a042989511cbc42390620bedc196ea956">clear</a> (boolean writeData=false)</td></tr>
<tr class="memdesc:a042989511cbc42390620bedc196ea956"><td class="mdescLeft"> </td><td class="mdescRight">clear the leds, optionally wiping the local array of data as well <a href="#a042989511cbc42390620bedc196ea956">More...</a><br /></td></tr>
<tr class="separator:a042989511cbc42390620bedc196ea956"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac4f613f1b3e618528dca3189df88ce80"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac4f613f1b3e618528dca3189df88ce80"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_fast_l_e_d.html#ac4f613f1b3e618528dca3189df88ce80">clearData</a> ()</td></tr>
<tr class="memdesc:ac4f613f1b3e618528dca3189df88ce80"><td class="mdescLeft"> </td><td class="mdescRight">clear out the local data array <br /></td></tr>
<tr class="separator:ac4f613f1b3e618528dca3189df88ce80"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7315b060d295bad5fbd32e50eaaf02b0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_fast_l_e_d.html#a7315b060d295bad5fbd32e50eaaf02b0">showColor</a> (const struct <a class="el" href="struct_c_r_g_b.html">CRGB</a> &color, uint8_t scale)</td></tr>
<tr class="memdesc:a7315b060d295bad5fbd32e50eaaf02b0"><td class="mdescLeft"> </td><td class="mdescRight">Set all leds on all controllers to the given color/scale. <a href="#a7315b060d295bad5fbd32e50eaaf02b0">More...</a><br /></td></tr>
<tr class="separator:a7315b060d295bad5fbd32e50eaaf02b0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a570df74cf09e6215c3647333d2b479a9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_fast_l_e_d.html#a570df74cf09e6215c3647333d2b479a9">showColor</a> (const struct <a class="el" href="struct_c_r_g_b.html">CRGB</a> &color)</td></tr>
<tr class="memdesc:a570df74cf09e6215c3647333d2b479a9"><td class="mdescLeft"> </td><td class="mdescRight">Set all leds on all controllers to the given color. <a href="#a570df74cf09e6215c3647333d2b479a9">More...</a><br /></td></tr>
<tr class="separator:a570df74cf09e6215c3647333d2b479a9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6819ff831058a710d4582dfc09817202"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_fast_l_e_d.html#a6819ff831058a710d4582dfc09817202">delay</a> (unsigned long ms)</td></tr>
<tr class="memdesc:a6819ff831058a710d4582dfc09817202"><td class="mdescLeft"> </td><td class="mdescRight">Delay for the given number of milliseconds. <a href="#a6819ff831058a710d4582dfc09817202">More...</a><br /></td></tr>
<tr class="separator:a6819ff831058a710d4582dfc09817202"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a28c2dfb0ec592db03f3063ade135f19f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_fast_l_e_d.html#a28c2dfb0ec592db03f3063ade135f19f">setTemperature</a> (const struct <a class="el" href="struct_c_r_g_b.html">CRGB</a> &temp)</td></tr>
<tr class="memdesc:a28c2dfb0ec592db03f3063ade135f19f"><td class="mdescLeft"> </td><td class="mdescRight">Set a global color temperature. <a href="#a28c2dfb0ec592db03f3063ade135f19f">More...</a><br /></td></tr>
<tr class="separator:a28c2dfb0ec592db03f3063ade135f19f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad266c3e649cc12a6dc49a1e229acc282"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_fast_l_e_d.html#ad266c3e649cc12a6dc49a1e229acc282">setCorrection</a> (const struct <a class="el" href="struct_c_r_g_b.html">CRGB</a> &correction)</td></tr>
<tr class="memdesc:ad266c3e649cc12a6dc49a1e229acc282"><td class="mdescLeft"> </td><td class="mdescRight">Set a global color correction. <a href="#ad266c3e649cc12a6dc49a1e229acc282">More...</a><br /></td></tr>
<tr class="separator:ad266c3e649cc12a6dc49a1e229acc282"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7ae5d3864df01101d82d242c123ffb36"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_fast_l_e_d.html#a7ae5d3864df01101d82d242c123ffb36">setDither</a> (uint8_t ditherMode=BINARY_DITHER)</td></tr>
<tr class="memdesc:a7ae5d3864df01101d82d242c123ffb36"><td class="mdescLeft"> </td><td class="mdescRight">Set the dithering mode. <a href="#a7ae5d3864df01101d82d242c123ffb36">More...</a><br /></td></tr>
<tr class="separator:a7ae5d3864df01101d82d242c123ffb36"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1f39e8404db214bbd6a776f52a77d8b1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_fast_l_e_d.html#a1f39e8404db214bbd6a776f52a77d8b1">setMaxRefreshRate</a> (uint16_t refresh, bool constrain=false)</td></tr>
<tr class="memdesc:a1f39e8404db214bbd6a776f52a77d8b1"><td class="mdescLeft"> </td><td class="mdescRight">Set the maximum refresh rate. <a href="#a1f39e8404db214bbd6a776f52a77d8b1">More...</a><br /></td></tr>
<tr class="separator:a1f39e8404db214bbd6a776f52a77d8b1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a61d27e179c9b68bde89d220aebc0de32"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_fast_l_e_d.html#a61d27e179c9b68bde89d220aebc0de32">countFPS</a> (int nFrames=25)</td></tr>
<tr class="memdesc:a61d27e179c9b68bde89d220aebc0de32"><td class="mdescLeft"> </td><td class="mdescRight">for debugging, will keep track of time between calls to countFPS, and every nFrames calls, it will update an internal counter for the current FPS. <a href="#a61d27e179c9b68bde89d220aebc0de32">More...</a><br /></td></tr>
<tr class="separator:a61d27e179c9b68bde89d220aebc0de32"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa8c3ae3381e524ce30b181ffa23b83cd"><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_fast_l_e_d.html#aa8c3ae3381e524ce30b181ffa23b83cd">getFPS</a> ()</td></tr>
<tr class="memdesc:aa8c3ae3381e524ce30b181ffa23b83cd"><td class="mdescLeft"> </td><td class="mdescRight">Get the number of frames/second being written out. <a href="#aa8c3ae3381e524ce30b181ffa23b83cd">More...</a><br /></td></tr>
<tr class="separator:aa8c3ae3381e524ce30b181ffa23b83cd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae5730545ea18b1f5228172f9d246beb6"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_fast_l_e_d.html#ae5730545ea18b1f5228172f9d246beb6">count</a> ()</td></tr>
<tr class="memdesc:ae5730545ea18b1f5228172f9d246beb6"><td class="mdescLeft"> </td><td class="mdescRight">Get how many controllers have been registered. <a href="#ae5730545ea18b1f5228172f9d246beb6">More...</a><br /></td></tr>
<tr class="separator:ae5730545ea18b1f5228172f9d246beb6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a646128b7d8c14b5020b285dbc8bc713b"><td class="memItemLeft" align="right" valign="top"><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_fast_l_e_d.html#a646128b7d8c14b5020b285dbc8bc713b">operator[]</a> (int x)</td></tr>
<tr class="memdesc:a646128b7d8c14b5020b285dbc8bc713b"><td class="mdescLeft"> </td><td class="mdescRight">Get a reference to a registered controller. <a href="#a646128b7d8c14b5020b285dbc8bc713b">More...</a><br /></td></tr>
<tr class="separator:a646128b7d8c14b5020b285dbc8bc713b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a18fba22754d2a1a206fc5db8d24a92d0"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_fast_l_e_d.html#a18fba22754d2a1a206fc5db8d24a92d0">size</a> ()</td></tr>
<tr class="memdesc:a18fba22754d2a1a206fc5db8d24a92d0"><td class="mdescLeft"> </td><td class="mdescRight">Get the number of leds in the first controller. <a href="#a18fba22754d2a1a206fc5db8d24a92d0">More...</a><br /></td></tr>
<tr class="separator:a18fba22754d2a1a206fc5db8d24a92d0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae3c0a81b88fb64a65725cb2fed67f766"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_c_r_g_b.html">CRGB</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_fast_l_e_d.html#ae3c0a81b88fb64a65725cb2fed67f766">leds</a> ()</td></tr>
<tr class="memdesc:ae3c0a81b88fb64a65725cb2fed67f766"><td class="mdescLeft"> </td><td class="mdescRight">Get a pointer to led data for the first controller. <a href="#ae3c0a81b88fb64a65725cb2fed67f766">More...</a><br /></td></tr>
<tr class="separator:ae3c0a81b88fb64a65725cb2fed67f766"><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:afd7928d822589740af6e23b2d510cf3f"><td class="memItemLeft" align="right" valign="top">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_fast_l_e_d.html#afd7928d822589740af6e23b2d510cf3f">addLeds</a> (<a class="el" href="class_c_l_e_d_controller.html">CLEDController</a> *pLed, struct <a class="el" href="struct_c_r_g_b.html">CRGB</a> *data, int nLedsOrOffset, int nLedsIfOffset=0)</td></tr>
<tr class="memdesc:afd7928d822589740af6e23b2d510cf3f"><td class="mdescLeft"> </td><td class="mdescRight">Add a <a class="el" href="class_c_l_e_d_controller.html" title="Base definition for an LED controller. ">CLEDController</a> instance to the world. <a href="#afd7928d822589740af6e23b2d510cf3f">More...</a><br /></td></tr>
<tr class="separator:afd7928d822589740af6e23b2d510cf3f"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
Adding SPI based controllers</h2></td></tr>
<tr class="memitem:a79df28eb68fc2062b995f9000aed274c"><td class="memTemplParams" colspan="2">template<ESPIChipsets CHIPSET, uint8_t DATA_PIN, uint8_t CLOCK_PIN, EOrder RGB_ORDER, uint8_t SPI_DATA_RATE> </td></tr>
<tr class="memitem:a79df28eb68fc2062b995f9000aed274c"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="class_c_l_e_d_controller.html">CLEDController</a> & </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_c_fast_l_e_d.html#a79df28eb68fc2062b995f9000aed274c">addLeds</a> (struct <a class="el" href="struct_c_r_g_b.html">CRGB</a> *data, int nLedsOrOffset, int nLedsIfOffset=0)</td></tr>
<tr class="memdesc:a79df28eb68fc2062b995f9000aed274c"><td class="mdescLeft"> </td><td class="mdescRight">Add an SPI based <a class="el" href="class_c_l_e_d_controller.html" title="Base definition for an LED controller. ">CLEDController</a> instance to the world. <a href="#a79df28eb68fc2062b995f9000aed274c">More...</a><br /></td></tr>
<tr class="separator:a79df28eb68fc2062b995f9000aed274c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa8ec7c8ab7c8aed4d85b9c3d6d5feaa9"><td class="memTemplParams" colspan="2"><a class="anchor" id="aa8ec7c8ab7c8aed4d85b9c3d6d5feaa9"></a>
template<ESPIChipsets CHIPSET, uint8_t DATA_PIN, uint8_t CLOCK_PIN> </td></tr>
<tr class="memitem:aa8ec7c8ab7c8aed4d85b9c3d6d5feaa9"><td class="memTemplItemLeft" align="right" valign="top">static <a class="el" href="class_c_l_e_d_controller.html">CLEDController</a> & </td><td class="memTemplItemRight" valign="bottom"><b>addLeds</b> (struct <a class="el" href="struct_c_r_g_b.html">CRGB</a> *data, int nLedsOrOffset, int nLedsIfOffset=0)</td></tr>
<tr class="separator:aa8ec7c8ab7c8aed4d85b9c3d6d5feaa9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5a7a603a5f0f503fe453dde049f315a8"><td class="memTemplParams" colspan="2"><a class="anchor" id="a5a7a603a5f0f503fe453dde049f315a8"></a>
template<ESPIChipsets CHIPSET, uint8_t DATA_PIN, uint8_t CLOCK_PIN, EOrder RGB_ORDER> </td></tr>
<tr class="memitem:a5a7a603a5f0f503fe453dde049f315a8"><td class="memTemplItemLeft" align="right" valign="top">static <a class="el" href="class_c_l_e_d_controller.html">CLEDController</a> & </td><td class="memTemplItemRight" valign="bottom"><b>addLeds</b> (struct <a class="el" href="struct_c_r_g_b.html">CRGB</a> *data, int nLedsOrOffset, int nLedsIfOffset=0)</td></tr>
<tr class="separator:a5a7a603a5f0f503fe453dde049f315a8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4912fec504ea01e8f867c4819240cba9"><td class="memTemplParams" colspan="2"><a class="anchor" id="a4912fec504ea01e8f867c4819240cba9"></a>
template<ESPIChipsets CHIPSET> </td></tr>
<tr class="memitem:a4912fec504ea01e8f867c4819240cba9"><td class="memTemplItemLeft" align="right" valign="top">static <a class="el" href="class_c_l_e_d_controller.html">CLEDController</a> & </td><td class="memTemplItemRight" valign="bottom"><b>addLeds</b> (struct <a class="el" href="struct_c_r_g_b.html">CRGB</a> *data, int nLedsOrOffset, int nLedsIfOffset=0)</td></tr>
<tr class="separator:a4912fec504ea01e8f867c4819240cba9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac4dff92f45048399edb0812a02ab9d96"><td class="memTemplParams" colspan="2"><a class="anchor" id="ac4dff92f45048399edb0812a02ab9d96"></a>
template<ESPIChipsets CHIPSET, EOrder RGB_ORDER> </td></tr>
<tr class="memitem:ac4dff92f45048399edb0812a02ab9d96"><td class="memTemplItemLeft" align="right" valign="top">static <a class="el" href="class_c_l_e_d_controller.html">CLEDController</a> & </td><td class="memTemplItemRight" valign="bottom"><b>addLeds</b> (struct <a class="el" href="struct_c_r_g_b.html">CRGB</a> *data, int nLedsOrOffset, int nLedsIfOffset=0)</td></tr>
<tr class="separator:ac4dff92f45048399edb0812a02ab9d96"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa8ec7c8ab7c8aed4d85b9c3d6d5feaa9"><td class="memTemplParams" colspan="2"><a class="anchor" id="aa8ec7c8ab7c8aed4d85b9c3d6d5feaa9"></a>
template<ESPIChipsets CHIPSET, EOrder RGB_ORDER, uint8_t SPI_DATA_RATE> </td></tr>
<tr class="memitem:aa8ec7c8ab7c8aed4d85b9c3d6d5feaa9"><td class="memTemplItemLeft" align="right" valign="top">static <a class="el" href="class_c_l_e_d_controller.html">CLEDController</a> & </td><td class="memTemplItemRight" valign="bottom"><b>addLeds</b> (struct <a class="el" href="struct_c_r_g_b.html">CRGB</a> *data, int nLedsOrOffset, int nLedsIfOffset=0)</td></tr>
<tr class="separator:aa8ec7c8ab7c8aed4d85b9c3d6d5feaa9"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
Adding 3-wire led controllers</h2></td></tr>
<tr class="memitem:aa8ec7c8ab7c8aed4d85b9c3d6d5feaa9"><td class="memTemplParams" colspan="2">template<template< uint8_t DATA_PIN, EOrder RGB_ORDER > class CHIPSET, uint8_t DATA_PIN, EOrder RGB_ORDER> </td></tr>
<tr class="memitem:aa8ec7c8ab7c8aed4d85b9c3d6d5feaa9"><td class="memTemplItemLeft" align="right" valign="top">static <a class="el" href="class_c_l_e_d_controller.html">CLEDController</a> & </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_c_fast_l_e_d.html#aa8ec7c8ab7c8aed4d85b9c3d6d5feaa9">addLeds</a> (struct <a class="el" href="struct_c_r_g_b.html">CRGB</a> *data, int nLedsOrOffset, int nLedsIfOffset=0)</td></tr>
<tr class="memdesc:aa8ec7c8ab7c8aed4d85b9c3d6d5feaa9"><td class="mdescLeft"> </td><td class="mdescRight">Add a clockless (aka 3wire, also DMX) based <a class="el" href="class_c_l_e_d_controller.html" title="Base definition for an LED controller. ">CLEDController</a> instance to the world. <a href="#aa8ec7c8ab7c8aed4d85b9c3d6d5feaa9">More...</a><br /></td></tr>
<tr class="separator:aa8ec7c8ab7c8aed4d85b9c3d6d5feaa9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac4dff92f45048399edb0812a02ab9d96"><td class="memTemplParams" colspan="2"><a class="anchor" id="ac4dff92f45048399edb0812a02ab9d96"></a>
template<template< uint8_t DATA_PIN, EOrder RGB_ORDER > class CHIPSET, uint8_t DATA_PIN> </td></tr>
<tr class="memitem:ac4dff92f45048399edb0812a02ab9d96"><td class="memTemplItemLeft" align="right" valign="top">static <a class="el" href="class_c_l_e_d_controller.html">CLEDController</a> & </td><td class="memTemplItemRight" valign="bottom"><b>addLeds</b> (struct <a class="el" href="struct_c_r_g_b.html">CRGB</a> *data, int nLedsOrOffset, int nLedsIfOffset=0)</td></tr>
<tr class="separator:ac4dff92f45048399edb0812a02ab9d96"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac4dff92f45048399edb0812a02ab9d96"><td class="memTemplParams" colspan="2"><a class="anchor" id="ac4dff92f45048399edb0812a02ab9d96"></a>
template<template< uint8_t DATA_PIN > class CHIPSET, uint8_t DATA_PIN> </td></tr>
<tr class="memitem:ac4dff92f45048399edb0812a02ab9d96"><td class="memTemplItemLeft" align="right" valign="top">static <a class="el" href="class_c_l_e_d_controller.html">CLEDController</a> & </td><td class="memTemplItemRight" valign="bottom"><b>addLeds</b> (struct <a class="el" href="struct_c_r_g_b.html">CRGB</a> *data, int nLedsOrOffset, int nLedsIfOffset=0)</td></tr>
<tr class="separator:ac4dff92f45048399edb0812a02ab9d96"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa8ec7c8ab7c8aed4d85b9c3d6d5feaa9"><td class="memTemplParams" colspan="2"><a class="anchor" id="aa8ec7c8ab7c8aed4d85b9c3d6d5feaa9"></a>
template<EClocklessChipsets CHIPSET, uint8_t DATA_PIN, EOrder RGB_ORDER = RGB> </td></tr>
<tr class="memitem:aa8ec7c8ab7c8aed4d85b9c3d6d5feaa9"><td class="memTemplItemLeft" align="right" valign="top">static <a class="el" href="class_c_l_e_d_controller.html">CLEDController</a> & </td><td class="memTemplItemRight" valign="bottom"><b>addLeds</b> (struct <a class="el" href="struct_c_r_g_b.html">CRGB</a> *data, int nLedsOrOffset, int nLedsIfOffset=0)</td></tr>
<tr class="separator:aa8ec7c8ab7c8aed4d85b9c3d6d5feaa9"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
Adding 3rd party library controllers</h2></td></tr>
<tr class="memitem:ac4dff92f45048399edb0812a02ab9d96"><td class="memTemplParams" colspan="2">template<template< EOrder RGB_ORDER > class CHIPSET, EOrder RGB_ORDER> </td></tr>
<tr class="memitem:ac4dff92f45048399edb0812a02ab9d96"><td class="memTemplItemLeft" align="right" valign="top">static <a class="el" href="class_c_l_e_d_controller.html">CLEDController</a> & </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_c_fast_l_e_d.html#ac4dff92f45048399edb0812a02ab9d96">addLeds</a> (struct <a class="el" href="struct_c_r_g_b.html">CRGB</a> *data, int nLedsOrOffset, int nLedsIfOffset=0)</td></tr>
<tr class="memdesc:ac4dff92f45048399edb0812a02ab9d96"><td class="mdescLeft"> </td><td class="mdescRight">Add a 3rd party library based <a class="el" href="class_c_l_e_d_controller.html" title="Base definition for an LED controller. ">CLEDController</a> instance to the world. <a href="#ac4dff92f45048399edb0812a02ab9d96">More...</a><br /></td></tr>
<tr class="separator:ac4dff92f45048399edb0812a02ab9d96"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4912fec504ea01e8f867c4819240cba9"><td class="memTemplParams" colspan="2"><a class="anchor" id="a4912fec504ea01e8f867c4819240cba9"></a>
template<template< EOrder RGB_ORDER > class CHIPSET> </td></tr>
<tr class="memitem:a4912fec504ea01e8f867c4819240cba9"><td class="memTemplItemLeft" align="right" valign="top">static <a class="el" href="class_c_l_e_d_controller.html">CLEDController</a> & </td><td class="memTemplItemRight" valign="bottom"><b>addLeds</b> (struct <a class="el" href="struct_c_r_g_b.html">CRGB</a> *data, int nLedsOrOffset, int nLedsIfOffset=0)</td></tr>
<tr class="separator:a4912fec504ea01e8f867c4819240cba9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac4dff92f45048399edb0812a02ab9d96"><td class="memTemplParams" colspan="2"><a class="anchor" id="ac4dff92f45048399edb0812a02ab9d96"></a>
template<OWS2811 CHIPSET, EOrder RGB_ORDER> </td></tr>
<tr class="memitem:ac4dff92f45048399edb0812a02ab9d96"><td class="memTemplItemLeft" align="right" valign="top">static <a class="el" href="class_c_l_e_d_controller.html">CLEDController</a> & </td><td class="memTemplItemRight" valign="bottom"><b>addLeds</b> (struct <a class="el" href="struct_c_r_g_b.html">CRGB</a> *data, int nLedsOrOffset, int nLedsIfOffset=0)</td></tr>
<tr class="separator:ac4dff92f45048399edb0812a02ab9d96"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4912fec504ea01e8f867c4819240cba9"><td class="memTemplParams" colspan="2"><a class="anchor" id="a4912fec504ea01e8f867c4819240cba9"></a>
template<OWS2811 CHIPSET> </td></tr>
<tr class="memitem:a4912fec504ea01e8f867c4819240cba9"><td class="memTemplItemLeft" align="right" valign="top">static <a class="el" href="class_c_l_e_d_controller.html">CLEDController</a> & </td><td class="memTemplItemRight" valign="bottom"><b>addLeds</b> (struct <a class="el" href="struct_c_r_g_b.html">CRGB</a> *data, int nLedsOrOffset, int nLedsIfOffset=0)</td></tr>
<tr class="separator:a4912fec504ea01e8f867c4819240cba9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4912fec504ea01e8f867c4819240cba9"><td class="memTemplParams" colspan="2"><a class="anchor" id="a4912fec504ea01e8f867c4819240cba9"></a>
template<ESM CHIPSET> </td></tr>
<tr class="memitem:a4912fec504ea01e8f867c4819240cba9"><td class="memTemplItemLeft" align="right" valign="top">static <a class="el" href="class_c_l_e_d_controller.html">CLEDController</a> & </td><td class="memTemplItemRight" valign="bottom"><b>addLeds</b> (struct <a class="el" href="struct_c_r_g_b.html">CRGB</a> *data, int nLedsOrOffset, int nLedsIfOffset=0)</td></tr>
<tr class="separator:a4912fec504ea01e8f867c4819240cba9"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
adding parallel output controllers</h2></td></tr>
<tr class="memitem:aa8ec7c8ab7c8aed4d85b9c3d6d5feaa9"><td class="memTemplParams" colspan="2">template<EBlockChipsets CHIPSET, int NUM_LANES, EOrder RGB_ORDER> </td></tr>
<tr class="memitem:aa8ec7c8ab7c8aed4d85b9c3d6d5feaa9"><td class="memTemplItemLeft" align="right" valign="top">static <a class="el" href="class_c_l_e_d_controller.html">CLEDController</a> & </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_c_fast_l_e_d.html#aa8ec7c8ab7c8aed4d85b9c3d6d5feaa9">addLeds</a> (struct <a class="el" href="struct_c_r_g_b.html">CRGB</a> *data, int nLedsOrOffset, int nLedsIfOffset=0)</td></tr>
<tr class="memdesc:aa8ec7c8ab7c8aed4d85b9c3d6d5feaa9"><td class="mdescLeft"> </td><td class="mdescRight">Add a block based <a class="el" href="class_c_l_e_d_controller.html" title="Base definition for an LED controller. ">CLEDController</a> instance to the world. <a href="#aa8ec7c8ab7c8aed4d85b9c3d6d5feaa9">More...</a><br /></td></tr>
<tr class="separator:aa8ec7c8ab7c8aed4d85b9c3d6d5feaa9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac4dff92f45048399edb0812a02ab9d96"><td class="memTemplParams" colspan="2"><a class="anchor" id="ac4dff92f45048399edb0812a02ab9d96"></a>
template<EBlockChipsets CHIPSET, int NUM_LANES> </td></tr>
<tr class="memitem:ac4dff92f45048399edb0812a02ab9d96"><td class="memTemplItemLeft" align="right" valign="top">static <a class="el" href="class_c_l_e_d_controller.html">CLEDController</a> & </td><td class="memTemplItemRight" valign="bottom"><b>addLeds</b> (struct <a class="el" href="struct_c_r_g_b.html">CRGB</a> *data, int nLedsOrOffset, int nLedsIfOffset=0)</td></tr>
<tr class="separator:ac4dff92f45048399edb0812a02ab9d96"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>High level controller interface for FastLED. </p>
<p>This class manages controllers, global settings and trackings such as brightness, and refresh rates, and provides access functions for driving led data to controllers via the show/showColor/clear methods. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="afd7928d822589740af6e23b2d510cf3f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_c_l_e_d_controller.html">CLEDController</a> & CFastLED::addLeds </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_c_l_e_d_controller.html">CLEDController</a> * </td>
<td class="paramname"><em>pLed</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">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>nLedsOrOffset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>nLedsIfOffset</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Add a <a class="el" href="class_c_l_e_d_controller.html" title="Base definition for an LED controller. ">CLEDController</a> instance to the world. </p>
<p>Exposed to the public to allow people to implement their own <a class="el" href="class_c_l_e_d_controller.html" title="Base definition for an LED controller. ">CLEDController</a> objects or instances. There are two ways to call this method (as well as the other addLeds) variations. The first is with 3 arguments, in which case the arguments are the controller, a pointer to led data, and the number of leds used by this controller. The seocond is with 4 arguments, in which case the first two arguments are the same, the third argument is an offset into the <a class="el" href="struct_c_r_g_b.html">CRGB</a> data where this controller's <a class="el" href="struct_c_r_g_b.html">CRGB</a> data begins, and the fourth argument is the number of leds for this controller object. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pLed</td><td>- the led controller being added </td></tr>
<tr><td class="paramname">data</td><td>- base point to an array of <a class="el" href="struct_c_r_g_b.html">CRGB</a> data structures </td></tr>
<tr><td class="paramname">nLedsOrOffset</td><td>- number of leds (3 argument version) or offset into the data array </td></tr>
<tr><td class="paramname">nLedsIfOffset</td><td>- number of leds (4 argument version) </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a reference to the added controller </dd></dl>
</div>
</div>
<a class="anchor" id="a79df28eb68fc2062b995f9000aed274c"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<ESPIChipsets CHIPSET, uint8_t DATA_PIN, uint8_t CLOCK_PIN, EOrder RGB_ORDER, uint8_t SPI_DATA_RATE> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_c_l_e_d_controller.html">CLEDController</a>& CFastLED::addLeds </td>
<td>(</td>
<td class="paramtype">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>nLedsOrOffset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>nLedsIfOffset</em> = <code>0</code> </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> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Add an SPI based <a class="el" href="class_c_l_e_d_controller.html" title="Base definition for an LED controller. ">CLEDController</a> instance to the world. </p>
<p>There are two ways to call this method (as well as the other addLeds) variations. The first is with 2 arguments, in which case the arguments are a pointer to led data, and the number of leds used by this controller. The seocond is with 3 arguments, in which case the first argument is the same, the second argument is an offset into the <a class="el" href="struct_c_r_g_b.html">CRGB</a> data where this controller's <a class="el" href="struct_c_r_g_b.html">CRGB</a> data begins, and the third argument is the number of leds for this controller object.</p>
<p>This method also takes a 1 to 5 template parameters for identifying the specific chipset, data and clock pins, RGB ordering, and SPI data rate </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>- base point to an array of <a class="el" href="struct_c_r_g_b.html">CRGB</a> data structures </td></tr>
<tr><td class="paramname">nLedsOrOffset</td><td>- number of leds (3 argument version) or offset into the data array </td></tr>
<tr><td class="paramname">nLedsIfOffset</td><td>- number of leds (4 argument version) </td></tr>
</table>
</dd>
</dl>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">CHIPSET</td><td>- the chipset type </td></tr>
<tr><td class="paramname">DATA_PIN</td><td>- the optional data pin for the leds (if omitted, will default to the first hardware SPI MOSI pin) </td></tr>
<tr><td class="paramname">CLOCK_PIN</td><td>- the optional clock pin for the leds (if omitted, will default to the first hardware SPI clock pin) </td></tr>
<tr><td class="paramname">RGB_ORDER</td><td>- the rgb ordering for the leds (e.g. what order red, green, and blue data is written out in) </td></tr>
<tr><td class="paramname">SPI_DATA_RATE</td><td>- the data rate to drive the SPI clock at, defined using DATA_RATE_MHZ or DATA_RATE_KHZ macros </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a reference to the added controller </dd></dl>
</div>
</div>
<a class="anchor" id="aa8ec7c8ab7c8aed4d85b9c3d6d5feaa9"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<template< uint8_t DATA_PIN, EOrder RGB_ORDER > class CHIPSET, uint8_t DATA_PIN, EOrder RGB_ORDER> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="class_c_l_e_d_controller.html">CLEDController</a>& CFastLED::addLeds </td>
<td>(</td>
<td class="paramtype">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>nLedsOrOffset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>nLedsIfOffset</em> = <code>0</code> </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">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Add a clockless (aka 3wire, also DMX) based <a class="el" href="class_c_l_e_d_controller.html" title="Base definition for an LED controller. ">CLEDController</a> instance to the world. </p>
<p>There are two ways to call this method (as well as the other addLeds) variations. The first is with 2 arguments, in which case the arguments are a pointer to led data, and the number of leds used by this controller. The seocond is with 3 arguments, in which case the first argument is the same, the second argument is an offset into the <a class="el" href="struct_c_r_g_b.html">CRGB</a> data where this controller's <a class="el" href="struct_c_r_g_b.html">CRGB</a> data begins, and the third argument is the number of leds for this controller object.</p>
<p>This method also takes a 2 to 3 template parameters for identifying the specific chipset, data pin, and rgb ordering RGB ordering, and SPI data rate </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>- base point to an array of <a class="el" href="struct_c_r_g_b.html">CRGB</a> data structures </td></tr>
<tr><td class="paramname">nLedsOrOffset</td><td>- number of leds (3 argument version) or offset into the data array </td></tr>
<tr><td class="paramname">nLedsIfOffset</td><td>- number of leds (4 argument version) </td></tr>
</table>
</dd>
</dl>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">CHIPSET</td><td>- the chipset type (required) </td></tr>
<tr><td class="paramname">DATA_PIN</td><td>- the optional data pin for the leds (required) </td></tr>
<tr><td class="paramname">RGB_ORDER</td><td>- the rgb ordering for the leds (e.g. what order red, green, and blue data is written out in) </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a reference to the added controller </dd></dl>
</div>
</div>
<a class="anchor" id="ac4dff92f45048399edb0812a02ab9d96"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<template< EOrder RGB_ORDER > class CHIPSET, EOrder RGB_ORDER> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="class_c_l_e_d_controller.html">CLEDController</a>& CFastLED::addLeds </td>
<td>(</td>
<td class="paramtype">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>nLedsOrOffset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>nLedsIfOffset</em> = <code>0</code> </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">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Add a 3rd party library based <a class="el" href="class_c_l_e_d_controller.html" title="Base definition for an LED controller. ">CLEDController</a> instance to the world. </p>
<p>There are two ways to call this method (as well as the other addLeds) variations. The first is with 2 arguments, in which case the arguments are a pointer to led data, and the number of leds used by this controller. The seocond is with 3 arguments, in which case the first argument is the same, the second argument is an offset into the <a class="el" href="struct_c_r_g_b.html">CRGB</a> data where this controller's <a class="el" href="struct_c_r_g_b.html">CRGB</a> data begins, and the third argument is the number of leds for this controller object. This class includes the SmartMatrix and OctoWS2811 based controllers</p>
<p>This method also takes a 1 to 2 template parameters for identifying the specific chipset and rgb ordering RGB ordering, and SPI data rate </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>- base point to an array of <a class="el" href="struct_c_r_g_b.html">CRGB</a> data structures </td></tr>
<tr><td class="paramname">nLedsOrOffset</td><td>- number of leds (3 argument version) or offset into the data array </td></tr>
<tr><td class="paramname">nLedsIfOffset</td><td>- number of leds (4 argument version) </td></tr>
</table>
</dd>
</dl>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">CHIPSET</td><td>- the chipset type (required) </td></tr>
<tr><td class="paramname">RGB_ORDER</td><td>- the rgb ordering for the leds (e.g. what order red, green, and blue data is written out in) </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a reference to the added controller </dd></dl>
</div>
</div>
<a class="anchor" id="aa8ec7c8ab7c8aed4d85b9c3d6d5feaa9"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<EBlockChipsets CHIPSET, int NUM_LANES, EOrder RGB_ORDER> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="class_c_l_e_d_controller.html">CLEDController</a>& CFastLED::addLeds </td>
<td>(</td>
<td class="paramtype">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>nLedsOrOffset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>nLedsIfOffset</em> = <code>0</code> </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">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Add a block based <a class="el" href="class_c_l_e_d_controller.html" title="Base definition for an LED controller. ">CLEDController</a> instance to the world. </p>
<p>There are two ways to call this method (as well as the other addLeds) variations. The first is with 2 arguments, in which case the arguments are a pointer to led data, and the number of leds used by this controller. The seocond is with 3 arguments, in which case the first argument is the same, the second argument is an offset into the <a class="el" href="struct_c_r_g_b.html">CRGB</a> data where this controller's <a class="el" href="struct_c_r_g_b.html">CRGB</a> data begins, and the third argument is the number of leds for this controller object.</p>
<p>This method also takes a 2 to 3 template parameters for identifying the specific chipset and rgb ordering RGB ordering, and SPI data rate </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>- base point to an array of <a class="el" href="struct_c_r_g_b.html">CRGB</a> data structures </td></tr>
<tr><td class="paramname">nLedsOrOffset</td><td>- number of leds (3 argument version) or offset into the data array </td></tr>
<tr><td class="paramname">nLedsIfOffset</td><td>- number of leds (4 argument version) </td></tr>
</table>
</dd>
</dl>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">CHIPSET</td><td>- the chipset/port type (required) </td></tr>
<tr><td class="paramname">NUM_LANES</td><td>- how many parallel lanes of output to write </td></tr>
<tr><td class="paramname">RGB_ORDER</td><td>- the rgb ordering for the leds (e.g. what order red, green, and blue data is written out in) </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a reference to the added controller </dd></dl>
</div>
</div>
<a class="anchor" id="a042989511cbc42390620bedc196ea956"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CFastLED::clear </td>
<td>(</td>
<td class="paramtype">boolean </td>
<td class="paramname"><em>writeData</em> = <code>false</code></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>clear the leds, optionally wiping the local array of data as well </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">writeData</td><td>whether or not to write into the local data array as well </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ae5730545ea18b1f5228172f9d246beb6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int CFastLED::count </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get how many controllers have been registered. </p>
<dl class="section return"><dt>Returns</dt><dd>the number of controllers (strips) that have been added with addLeds </dd></dl>
</div>
</div>
<a class="anchor" id="a61d27e179c9b68bde89d220aebc0de32"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CFastLED::countFPS </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>nFrames</em> = <code>25</code></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>for debugging, will keep track of time between calls to countFPS, and every nFrames calls, it will update an internal counter for the current FPS. </p>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000001">Todo:</a></b></dt><dd>make this a rolling counter <dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">nFrames</td><td>- how many frames to time for determining FPS </td></tr>
</table>
</dd>
</dl>
</dd></dl>
</div>
</div>
<a class="anchor" id="a6819ff831058a710d4582dfc09817202"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CFastLED::delay </td>
<td>(</td>
<td class="paramtype">unsigned long </td>
<td class="paramname"><em>ms</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Delay for the given number of milliseconds. </p>
<p>Provided to allow the library to be used on platforms that don't have a delay function (to allow code to be more portable) </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ms</td><td>the number of milliseconds to pause for </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ac2615781ec12e025fb17cc0e66281716"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint8_t CFastLED::getBrightness </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the current global brightness setting. </p>
<dl class="section return"><dt>Returns</dt><dd>the current global brightness value </dd></dl>
</div>
</div>
<a class="anchor" id="aa8c3ae3381e524ce30b181ffa23b83cd"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint16_t CFastLED::getFPS </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the number of frames/second being written out. </p>
<dl class="section return"><dt>Returns</dt><dd>the most recently computed FPS value </dd></dl>
</div>
</div>
<a class="anchor" id="ae3c0a81b88fb64a65725cb2fed67f766"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="struct_c_r_g_b.html">CRGB</a>* CFastLED::leds </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a pointer to led data for the first controller. </p>
<dl class="section return"><dt>Returns</dt><dd>pointer to the <a class="el" href="struct_c_r_g_b.html">CRGB</a> buffer for the first controller </dd></dl>
</div>
</div>
<a class="anchor" id="a646128b7d8c14b5020b285dbc8bc713b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_c_l_e_d_controller.html">CLEDController</a> & CFastLED::operator[] </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>x</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a reference to a registered controller. </p>
<dl class="section return"><dt>Returns</dt><dd>a reference to the Nth controller </dd></dl>
</div>
</div>
<a class="anchor" id="a730ba7d967e882b4b893689cf333b2eb"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void CFastLED::setBrightness </td>
<td>(</td>
<td class="paramtype">uint8_t </td>
<td class="paramname"><em>scale</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the global brightness scaling. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">scale</td><td>a 0-255 value for how much to scale all leds before writing them out </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ad266c3e649cc12a6dc49a1e229acc282"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CFastLED::setCorrection </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>correction</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set a global color correction. </p>
<p>Sets the color correction for all added led strips, overriding whatever previous color correction those controllers may have had. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">correction</td><td>A <a class="el" href="struct_c_r_g_b.html">CRGB</a> structure describin the color correction. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a7ae5d3864df01101d82d242c123ffb36"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CFastLED::setDither </td>
<td>(</td>
<td class="paramtype">uint8_t </td>
<td class="paramname"><em>ditherMode</em> = <code>BINARY_DITHER</code></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the dithering mode. </p>
<p>Sets the dithering mode for all added led strips, overriding whatever previous dithering option those controllers may have had. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ditherMode</td><td>- what type of dithering to use, either BINARY_DITHER or DISABLE_DITHER </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a1f39e8404db214bbd6a776f52a77d8b1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CFastLED::setMaxRefreshRate </td>
<td>(</td>
<td class="paramtype">uint16_t </td>
<td class="paramname"><em>refresh</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>constrain</em> = <code>false</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the maximum refresh rate. </p>
<p>This is global for all leds. Attempts to call show faster than this rate will simply wait. Note that the refresh rate defaults to the slowest refresh rate of all the leds added through addLeds. If you wish to set/override this rate, be sure to call setMaxRefreshRate <em>after</em> adding all of your leds. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">refresh</td><td>- maximum refresh rate in hz </td></tr>
<tr><td class="paramname">constrain</td><td>- constrain refresh rate to the slowest speed yet set </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a28c2dfb0ec592db03f3063ade135f19f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CFastLED::setTemperature </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>temp</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set a global color temperature. </p>
<p>Sets the color temperature for all added led strips, overriding whatever previous color temperature those controllers may have had </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">temp</td><td>A <a class="el" href="struct_c_r_g_b.html">CRGB</a> structure describing the color temperature </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a83afdd1e2a21f33ac4f8d2610d6e331b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CFastLED::show </td>
<td>(</td>
<td class="paramtype">uint8_t </td>
<td class="paramname"><em>scale</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Update all our controllers with the current led colors, using the passed in brightness. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">scale</td><td>temporarily override the scale </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a7315b060d295bad5fbd32e50eaaf02b0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CFastLED::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>color</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t </td>
<td class="paramname"><em>scale</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set all leds on all controllers to the given color/scale. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">color</td><td>what color to set the leds to </td></tr>
<tr><td class="paramname">scale</td><td>what brightness scale to show at </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a570df74cf09e6215c3647333d2b479a9"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void CFastLED::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>color</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Set all leds on all controllers to the given color. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">color</td><td>what color to set the leds to </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a18fba22754d2a1a206fc5db8d24a92d0"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int CFastLED::size </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the number of leds in the first controller. </p>
<dl class="section return"><dt>Returns</dt><dd>the number of LEDs in the first controller </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="_fast_l_e_d_8h_source.html">FastLED.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 21:53:28 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>
|
