diff options
Diffstat (limited to 'docs/3.1/fastled__progmem_8h_source.html')
| -rw-r--r-- | docs/3.1/fastled__progmem_8h_source.html | 115 |
1 files changed, 59 insertions, 56 deletions
diff --git a/docs/3.1/fastled__progmem_8h_source.html b/docs/3.1/fastled__progmem_8h_source.html index 4ef91323..a0d23d31 100644 --- a/docs/3.1/fastled__progmem_8h_source.html +++ b/docs/3.1/fastled__progmem_8h_source.html @@ -112,72 +112,75 @@ $(document).ready(function(){initNavTree('fastled__progmem_8h_source.html','');} <a href="fastled__progmem_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="preprocessor">#ifndef __INC_FL_PROGMEM_H</span></div> <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define __INC_FL_PROGMEM_H</span></div> <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> </div> -<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> </div> -<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> FASTLED_NAMESPACE_BEGIN</div> +<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="preprocessor">#include "<a class="code" href="_fast_l_e_d_8h.html">FastLED.h</a>"</span></div> +<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> </div> <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> </div> -<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">// Compatibility layer for devices that do or don't</span></div> -<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">// have "PROGMEM" and the associated pgm_ accessors.</span></div> -<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">//</span></div> -<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">// If a platform supports PROGMEM, it should define</span></div> -<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">// "FASTLED_USE_PROGMEM" as 1, otherwise FastLED will</span></div> -<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">// fall back to NOT using PROGMEM.</span></div> -<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">//</span></div> -<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">// Whether or not pgmspace.h is #included is separately</span></div> -<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">// controllable by FASTLED_INCLUDE_PGMSPACE, if needed.</span></div> -<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> </div> -<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div> -<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment">// If FASTLED_USE_PROGMEM is 1, we'll map FL_PROGMEM</span></div> -<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment">// and the FL_PGM_* accessors to the Arduino equivalents.</span></div> -<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#if FASTLED_USE_PROGMEM == 1</span></div> -<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#ifndef FASTLED_INCLUDE_PGMSPACE</span></div> -<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#define FASTLED_INCLUDE_PGMSPACE 1</span></div> -<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#endif</span></div> -<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div> -<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#if FASTLED_INCLUDE_PGMSPACE == 1</span></div> -<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include <avr/pgmspace.h></span></div> -<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#endif</span></div> -<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div> -<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#define FL_PROGMEM PROGMEM</span></div> +<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> FASTLED_NAMESPACE_BEGIN</div> +<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> </div> +<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">// Compatibility layer for devices that do or don't</span></div> +<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">// have "PROGMEM" and the associated pgm_ accessors.</span></div> +<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">//</span></div> +<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">// If a platform supports PROGMEM, it should define</span></div> +<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">// "FASTLED_USE_PROGMEM" as 1, otherwise FastLED will</span></div> +<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">// fall back to NOT using PROGMEM.</span></div> +<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">//</span></div> +<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">// Whether or not pgmspace.h is #included is separately</span></div> +<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment">// controllable by FASTLED_INCLUDE_PGMSPACE, if needed.</span></div> +<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div> +<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div> +<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment">// If FASTLED_USE_PROGMEM is 1, we'll map FL_PROGMEM</span></div> +<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment">// and the FL_PGM_* accessors to the Arduino equivalents.</span></div> +<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#if FASTLED_USE_PROGMEM == 1</span></div> +<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#ifndef FASTLED_INCLUDE_PGMSPACE</span></div> +<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#define FASTLED_INCLUDE_PGMSPACE 1</span></div> +<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#endif</span></div> +<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div> +<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#if FASTLED_INCLUDE_PGMSPACE == 1</span></div> +<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#include <avr/pgmspace.h></span></div> +<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#endif</span></div> <div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div> -<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment">// Note: only the 'near' memory wrappers are provided.</span></div> -<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment">// If you're using 'far' memory, you already have</span></div> -<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment">// portability issues to work through, but you could</span></div> -<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment">// add more support here if needed.</span></div> -<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="preprocessor">#define FL_PGM_READ_BYTE_NEAR(x) (pgm_read_byte_near(x))</span></div> -<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="preprocessor">#define FL_PGM_READ_WORD_NEAR(x) (pgm_read_word_near(x))</span></div> -<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="preprocessor">#define FL_PGM_READ_DWORD_NEAR(x) (pgm_read_dword_near(x))</span></div> -<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div> -<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment">// Workaround for http://gcc.gnu.org/bugzilla/show_bug.cgi?id=34734</span></div> -<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="preprocessor">#ifdef FASTLED_AVR</span></div> -<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="preprocessor">#ifdef PROGMEM</span></div> -<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="preprocessor">#undef PROGMEM</span></div> -<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="preprocessor">#define PROGMEM __attribute__((section(".progmem.data")))</span></div> -<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="preprocessor">#endif</span></div> -<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="preprocessor">#endif</span></div> -<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div> -<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="preprocessor">#else</span></div> -<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment">// If FASTLED_USE_PROGMEM is 0 or undefined,</span></div> -<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment">// we'll use regular memory (RAM) access.</span></div> -<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> </div> -<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment">//empty PROGMEM simulation</span></div> -<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="preprocessor">#define FL_PROGMEM</span></div> -<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="preprocessor">#define FL_PGM_READ_BYTE_NEAR(x) (*((const uint8_t*)(x)))</span></div> -<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="preprocessor">#define FL_PGM_READ_WORD_NEAR(x) (*((const uint16_t*)(x)))</span></div> -<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="preprocessor">#define FL_PGM_READ_DWORD_NEAR(x) (*((const uint32_t*)(x)))</span></div> -<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> </div> -<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="preprocessor">#endif</span></div> +<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#define FL_PROGMEM PROGMEM</span></div> +<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div> +<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment">// Note: only the 'near' memory wrappers are provided.</span></div> +<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment">// If you're using 'far' memory, you already have</span></div> +<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment">// portability issues to work through, but you could</span></div> +<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment">// add more support here if needed.</span></div> +<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="preprocessor">#define FL_PGM_READ_BYTE_NEAR(x) (pgm_read_byte_near(x))</span></div> +<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="preprocessor">#define FL_PGM_READ_WORD_NEAR(x) (pgm_read_word_near(x))</span></div> +<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="preprocessor">#define FL_PGM_READ_DWORD_NEAR(x) (pgm_read_dword_near(x))</span></div> +<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div> +<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment">// Workaround for http://gcc.gnu.org/bugzilla/show_bug.cgi?id=34734</span></div> +<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="preprocessor">#ifdef FASTLED_AVR</span></div> +<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="preprocessor">#ifdef PROGMEM</span></div> +<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="preprocessor">#undef PROGMEM</span></div> +<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="preprocessor">#define PROGMEM __attribute__((section(".progmem.data")))</span></div> +<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="preprocessor">#endif</span></div> +<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="preprocessor">#endif</span></div> +<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> </div> +<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="preprocessor">#else</span></div> +<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment">// If FASTLED_USE_PROGMEM is 0 or undefined,</span></div> +<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment">// we'll use regular memory (RAM) access.</span></div> +<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div> +<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment">//empty PROGMEM simulation</span></div> +<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="preprocessor">#define FL_PROGMEM</span></div> +<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="preprocessor">#define FL_PGM_READ_BYTE_NEAR(x) (*((const uint8_t*)(x)))</span></div> +<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="preprocessor">#define FL_PGM_READ_WORD_NEAR(x) (*((const uint16_t*)(x)))</span></div> +<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="preprocessor">#define FL_PGM_READ_DWORD_NEAR(x) (*((const uint32_t*)(x)))</span></div> <div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div> -<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div> -<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> FASTLED_NAMESPACE_END</div> +<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="preprocessor">#endif</span></div> +<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> </div> <div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div> -<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="preprocessor">#endif</span></div> +<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> FASTLED_NAMESPACE_END</div> +<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> </div> +<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="preprocessor">#endif</span></div> +<div class="ttc" id="_fast_l_e_d_8h_html"><div class="ttname"><a href="_fast_l_e_d_8h.html">FastLED.h</a></div><div class="ttdoc">central include file for FastLED, defines the CFastLED class/object </div></div> </div><!-- fragment --></div><!-- contents --> </div><!-- doc-content --> <!-- start footer part --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> <li class="navelem"><a class="el" href="fastled__progmem_8h.html">fastled_progmem.h</a></li> - <li class="footer">Generated on Thu Dec 10 2015 14:02:36 for FastLED by + <li class="footer">Generated on Sat Feb 13 2016 13:28:34 for FastLED by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.9.1 </li> </ul> |