taigrr/arduinolibs
1
0
Fork 0
mirror of https://github.com/taigrr/arduinolibs synced 2025-01-18 04:33:12 -08:00
Code Issues Projects Releases Wiki Activity

Update docs

Browse Source
This commit is contained in:
Rhys Weatherley
2015-03-12 19:03:15 +10:00
parent 083448f195
commit c6206e4216
493 changed files with 35310 additions and 3018 deletions
Download Patch File Download Diff File Expand all files Collapse all files

55
DMD_8h_source.html
View File

@@ -3,6 +3,7 @@
<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.6"/>
<title>ArduinoLibs: DMD.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
@@ -29,7 +30,7 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.2 -->
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
@@ -114,32 +115,32 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="preprocessor">#include &quot;Bitmap.h&quot;</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;</div>
<div class="line"><a name="l00028"></a><span class="lineno"><a class="code" href="classDMD.html"> 28</a></span>&#160;<span class="keyword">class </span><a class="code" href="classDMD.html" title="Handle large dot matrix displays composed of LED&#39;s.">DMD</a> : <span class="keyword">public</span> <a class="code" href="classBitmap.html" title="Represents a monochrome bitmap within main memory.">Bitmap</a></div>
<div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="classDMD.html"> 28</a></span>&#160;<span class="keyword">class </span><a class="code" href="classDMD.html">DMD</a> : <span class="keyword">public</span> <a class="code" href="classBitmap.html">Bitmap</a></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;{</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; <span class="keyword">explicit</span> <a class="code" href="classDMD.html#affd37accffe951c8878434dfa1245809" title="Constructs a new dot matrix display handler for a display that is widthPanels x heightPanels in size...">DMD</a>(<span class="keywordtype">int</span> widthPanels = 1, <span class="keywordtype">int</span> heightPanels = 1);</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <a class="code" href="classDMD.html#a7b37e05584d3e0308163700920df99b2" title="Destroys this dot matrix display handler.">~DMD</a>();</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; <span class="keyword">explicit</span> <a class="code" href="classDMD.html#affd37accffe951c8878434dfa1245809">DMD</a>(<span class="keywordtype">int</span> widthPanels = 1, <span class="keywordtype">int</span> heightPanels = 1);</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <a class="code" href="classDMD.html#a7b37e05584d3e0308163700920df99b2">~DMD</a>();</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;</div>
<div class="line"><a name="l00034"></a><span class="lineno"><a class="code" href="classDMD.html#aab1f3ba29c053d630ae12865d22166ec"> 34</a></span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classDMD.html#aab1f3ba29c053d630ae12865d22166ec" title="Returns true if the display is double-buffered; false if single-buffered. The default is false...">doubleBuffer</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _doubleBuffer; }</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classDMD.html#a6fbdcf8832f91d02500cb7a9b84d2723" title="Enables or disables double-buffering according to doubleBuffer.">setDoubleBuffer</a>(<span class="keywordtype">bool</span> <a class="code" href="classDMD.html#aab1f3ba29c053d630ae12865d22166ec" title="Returns true if the display is double-buffered; false if single-buffered. The default is false...">doubleBuffer</a>);</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classDMD.html#a80269ccd44b3ef9ee15f0a1009b7a60a" title="Swaps the buffers that are used for rendering to the display.">swapBuffers</a>();</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classDMD.html#a0b1771cf790b2b62eea55e56b02e3736" title="Swaps the buffers that are used for rendering to the display and copies the former back buffer conten...">swapBuffersAndCopy</a>();</div>
<div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="classDMD.html#aab1f3ba29c053d630ae12865d22166ec"> 34</a></span>&#160; <span class="keywordtype">bool</span> <a class="code" href="classDMD.html#aab1f3ba29c053d630ae12865d22166ec">doubleBuffer</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _doubleBuffer; }</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classDMD.html#a6fbdcf8832f91d02500cb7a9b84d2723">setDoubleBuffer</a>(<span class="keywordtype">bool</span> <a class="code" href="classDMD.html#aab1f3ba29c053d630ae12865d22166ec">doubleBuffer</a>);</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classDMD.html#a80269ccd44b3ef9ee15f0a1009b7a60a">swapBuffers</a>();</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classDMD.html#a0b1771cf790b2b62eea55e56b02e3736">swapBuffersAndCopy</a>();</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classDMD.html#a2c74a0845ef6080056b972d490648114" title="Performs regular display refresh activities from the application&#39;s main loop.">loop</a>();</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classDMD.html#a9e4bf2a9d247312d35c1401ff61261c8" title="Refresh the display.">refresh</a>();</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classDMD.html#a2c74a0845ef6080056b972d490648114">loop</a>();</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classDMD.html#a9e4bf2a9d247312d35c1401ff61261c8">refresh</a>();</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classDMD.html#a4c3b04b384f3d656a9b59690836775e2" title="Enables Timer1 overflow interrupts for updating this display.">enableTimer1</a>();</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classDMD.html#a39af27e216f654ecc7e60b0614cb6b33" title="Disables Timer1 overflow interrupts.">disableTimer1</a>();</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classDMD.html#a4c3b04b384f3d656a9b59690836775e2">enableTimer1</a>();</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classDMD.html#a39af27e216f654ecc7e60b0614cb6b33">disableTimer1</a>();</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classDMD.html#a5469775db7fafebca2cdbc6a6372fb97" title="Enables Timer2 overflow interrupts for updating this display.">enableTimer2</a>();</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classDMD.html#a52fe885bfb380b74df54c96221811cff" title="Disables Timer2 overflow interrupts.">disableTimer2</a>();</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classDMD.html#a5469775db7fafebca2cdbc6a6372fb97">enableTimer2</a>();</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classDMD.html#a52fe885bfb380b74df54c96221811cff">disableTimer2</a>();</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <span class="keyword">static</span> <a class="code" href="classBitmap.html#a88d386944a7017aa776a177b10d8b2ba" title="Type that represents the color of a pixel in a bitmap.">Color</a> <a class="code" href="classDMD.html#a557412f734fc4596e1102bf71e110ea0" title="Converts an RGB value into a pixel color value.">fromRGB</a>(uint8_t r, uint8_t g, uint8_t b);</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <span class="keyword">static</span> <a class="code" href="classBitmap.html#a88d386944a7017aa776a177b10d8b2ba">Color</a> <a class="code" href="classDMD.html#a557412f734fc4596e1102bf71e110ea0">fromRGB</a>(uint8_t r, uint8_t g, uint8_t b);</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;<span class="keyword">private</span>:</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <span class="comment">// Disable copy constructor and operator=().</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <a class="code" href="classDMD.html#affd37accffe951c8878434dfa1245809" title="Constructs a new dot matrix display handler for a display that is widthPanels x heightPanels in size...">DMD</a>(<span class="keyword">const</span> <a class="code" href="classDMD.html" title="Handle large dot matrix displays composed of LED&#39;s.">DMD</a> &amp;other) : <a class="code" href="classBitmap.html" title="Represents a monochrome bitmap within main memory.">Bitmap</a>(other) {}</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; <a class="code" href="classDMD.html" title="Handle large dot matrix displays composed of LED&#39;s.">DMD</a> &amp;operator=(<span class="keyword">const</span> <a class="code" href="classDMD.html" title="Handle large dot matrix displays composed of LED&#39;s.">DMD</a> &amp;) { <span class="keywordflow">return</span> *<span class="keyword">this</span>; }</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <a class="code" href="classDMD.html#affd37accffe951c8878434dfa1245809">DMD</a>(<span class="keyword">const</span> <a class="code" href="classDMD.html">DMD</a> &amp;other) : <a class="code" href="classBitmap.html">Bitmap</a>(other) {}</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; <a class="code" href="classDMD.html">DMD</a> &amp;operator=(<span class="keyword">const</span> <a class="code" href="classDMD.html">DMD</a> &amp;) { <span class="keywordflow">return</span> *<span class="keyword">this</span>; }</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; <span class="keywordtype">bool</span> _doubleBuffer;</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; uint8_t phase;</div>
@@ -150,12 +151,28 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;};</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="ttc" id="classDMD_html"><div class="ttname"><a href="classDMD.html">DMD</a></div><div class="ttdoc">Handle large dot matrix displays composed of LED&#39;s. </div><div class="ttdef"><b>Definition:</b> <a href="DMD_8h_source.html#l00028">DMD.h:28</a></div></div>
<div class="ttc" id="classDMD_html_a39af27e216f654ecc7e60b0614cb6b33"><div class="ttname"><a href="classDMD.html#a39af27e216f654ecc7e60b0614cb6b33">DMD::disableTimer1</a></div><div class="ttdeci">void disableTimer1()</div><div class="ttdoc">Disables Timer1 overflow interrupts. </div><div class="ttdef"><b>Definition:</b> <a href="DMD_8cpp_source.html#l00614">DMD.cpp:614</a></div></div>
<div class="ttc" id="classDMD_html_a2c74a0845ef6080056b972d490648114"><div class="ttname"><a href="classDMD.html#a2c74a0845ef6080056b972d490648114">DMD::loop</a></div><div class="ttdeci">void loop()</div><div class="ttdoc">Performs regular display refresh activities from the application&#39;s main loop. </div><div class="ttdef"><b>Definition:</b> <a href="DMD_8cpp_source.html#l00420">DMD.cpp:420</a></div></div>
<div class="ttc" id="classDMD_html_a52fe885bfb380b74df54c96221811cff"><div class="ttname"><a href="classDMD.html#a52fe885bfb380b74df54c96221811cff">DMD::disableTimer2</a></div><div class="ttdeci">void disableTimer2()</div><div class="ttdoc">Disables Timer2 overflow interrupts. </div><div class="ttdef"><b>Definition:</b> <a href="DMD_8cpp_source.html#l00674">DMD.cpp:674</a></div></div>
<div class="ttc" id="classBitmap_html"><div class="ttname"><a href="classBitmap.html">Bitmap</a></div><div class="ttdoc">Represents a monochrome bitmap within main memory. </div><div class="ttdef"><b>Definition:</b> <a href="Bitmap_8h_source.html#l00032">Bitmap.h:32</a></div></div>
<div class="ttc" id="classDMD_html_aab1f3ba29c053d630ae12865d22166ec"><div class="ttname"><a href="classDMD.html#aab1f3ba29c053d630ae12865d22166ec">DMD::doubleBuffer</a></div><div class="ttdeci">bool doubleBuffer() const </div><div class="ttdoc">Returns true if the display is double-buffered; false if single-buffered. The default is false...</div><div class="ttdef"><b>Definition:</b> <a href="DMD_8h_source.html#l00034">DMD.h:34</a></div></div>
<div class="ttc" id="classDMD_html_a80269ccd44b3ef9ee15f0a1009b7a60a"><div class="ttname"><a href="classDMD.html#a80269ccd44b3ef9ee15f0a1009b7a60a">DMD::swapBuffers</a></div><div class="ttdeci">void swapBuffers()</div><div class="ttdoc">Swaps the buffers that are used for rendering to the display. </div><div class="ttdef"><b>Definition:</b> <a href="DMD_8cpp_source.html#l00363">DMD.cpp:363</a></div></div>
<div class="ttc" id="classDMD_html_a4c3b04b384f3d656a9b59690836775e2"><div class="ttname"><a href="classDMD.html#a4c3b04b384f3d656a9b59690836775e2">DMD::enableTimer1</a></div><div class="ttdeci">void enableTimer1()</div><div class="ttdoc">Enables Timer1 overflow interrupts for updating this display. </div><div class="ttdef"><b>Definition:</b> <a href="DMD_8cpp_source.html#l00563">DMD.cpp:563</a></div></div>
<div class="ttc" id="classDMD_html_a7b37e05584d3e0308163700920df99b2"><div class="ttname"><a href="classDMD.html#a7b37e05584d3e0308163700920df99b2">DMD::~DMD</a></div><div class="ttdeci">~DMD()</div><div class="ttdoc">Destroys this dot matrix display handler. </div><div class="ttdef"><b>Definition:</b> <a href="DMD_8cpp_source.html#l00278">DMD.cpp:278</a></div></div>
<div class="ttc" id="classBitmap_html_a88d386944a7017aa776a177b10d8b2ba"><div class="ttname"><a href="classBitmap.html#a88d386944a7017aa776a177b10d8b2ba">Bitmap::Color</a></div><div class="ttdeci">uint8_t Color</div><div class="ttdoc">Type that represents the color of a pixel in a bitmap. </div><div class="ttdef"><b>Definition:</b> <a href="Bitmap_8h_source.html#l00040">Bitmap.h:40</a></div></div>
<div class="ttc" id="classDMD_html_a0b1771cf790b2b62eea55e56b02e3736"><div class="ttname"><a href="classDMD.html#a0b1771cf790b2b62eea55e56b02e3736">DMD::swapBuffersAndCopy</a></div><div class="ttdeci">void swapBuffersAndCopy()</div><div class="ttdoc">Swaps the buffers that are used for rendering to the display and copies the former back buffer conten...</div><div class="ttdef"><b>Definition:</b> <a href="DMD_8cpp_source.html#l00396">DMD.cpp:396</a></div></div>
<div class="ttc" id="classDMD_html_affd37accffe951c8878434dfa1245809"><div class="ttname"><a href="classDMD.html#affd37accffe951c8878434dfa1245809">DMD::DMD</a></div><div class="ttdeci">DMD(int widthPanels=1, int heightPanels=1)</div><div class="ttdoc">Constructs a new dot matrix display handler for a display that is widthPanels x heightPanels in size...</div><div class="ttdef"><b>Definition:</b> <a href="DMD_8cpp_source.html#l00237">DMD.cpp:237</a></div></div>
<div class="ttc" id="classDMD_html_a5469775db7fafebca2cdbc6a6372fb97"><div class="ttname"><a href="classDMD.html#a5469775db7fafebca2cdbc6a6372fb97">DMD::enableTimer2</a></div><div class="ttdeci">void enableTimer2()</div><div class="ttdoc">Enables Timer2 overflow interrupts for updating this display. </div><div class="ttdef"><b>Definition:</b> <a href="DMD_8cpp_source.html#l00646">DMD.cpp:646</a></div></div>
<div class="ttc" id="classDMD_html_a557412f734fc4596e1102bf71e110ea0"><div class="ttname"><a href="classDMD.html#a557412f734fc4596e1102bf71e110ea0">DMD::fromRGB</a></div><div class="ttdeci">static Color fromRGB(uint8_t r, uint8_t g, uint8_t b)</div><div class="ttdoc">Converts an RGB value into a pixel color value. </div><div class="ttdef"><b>Definition:</b> <a href="DMD_8cpp_source.html#l00690">DMD.cpp:690</a></div></div>
<div class="ttc" id="classDMD_html_a9e4bf2a9d247312d35c1401ff61261c8"><div class="ttname"><a href="classDMD.html#a9e4bf2a9d247312d35c1401ff61261c8">DMD::refresh</a></div><div class="ttdeci">void refresh()</div><div class="ttdoc">Refresh the display. </div><div class="ttdef"><b>Definition:</b> <a href="DMD_8cpp_source.html#l00478">DMD.cpp:478</a></div></div>
<div class="ttc" id="classDMD_html_a6fbdcf8832f91d02500cb7a9b84d2723"><div class="ttname"><a href="classDMD.html#a6fbdcf8832f91d02500cb7a9b84d2723">DMD::setDoubleBuffer</a></div><div class="ttdeci">void setDoubleBuffer(bool doubleBuffer)</div><div class="ttdoc">Enables or disables double-buffering according to doubleBuffer. </div><div class="ttdef"><b>Definition:</b> <a href="DMD_8cpp_source.html#l00314">DMD.cpp:314</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Sep 29 2013 09:30:46 for ArduinoLibs by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Thu Mar 12 2015 19:02:05 for ArduinoLibs by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1.2
</a> 1.8.6
</small></address>
</body>
</html>