1
0
mirror of https://github.com/taigrr/arduinolibs synced 2025-01-18 04:33:12 -08:00

Update docs

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

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: Dot Matrix Display Demo</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>
@@ -78,7 +79,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="title">Dot Matrix Display Demo </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>This demo shows off various features of drawing with the <a class="el" href="classBitmap.html" title="Represents a monochrome bitmap within main memory.">Bitmap</a> class to a <a class="el" href="classDMD.html" title="Handle large dot matrix displays composed of LED&#39;s.">DMD</a> display:</p>
<div class="textblock"><p>This demo shows off various features of drawing with the <a class="el" href="classBitmap.html" title="Represents a monochrome bitmap within main memory. ">Bitmap</a> class to a <a class="el" href="classDMD.html" title="Handle large dot matrix displays composed of LED&#39;s. ">DMD</a> display:</p>
<ul>
<li>Drawing circles, lines, and rectangles. </li>
<li>Filling the screen with a bitmap-based brick pattern. </li>
@@ -101,15 +102,15 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="line"><span class="preprocessor">#include &lt;DejaVuSansItalic9.h&gt;</span></div>
<div class="line"><span class="preprocessor">#include &lt;Mono5x7.h&gt;</span></div>
<div class="line"></div>
<div class="line"><a class="code" href="classDMD.html" title="Handle large dot matrix displays composed of LED&#39;s.">DMD</a> display;</div>
<div class="line"><a class="code" href="classDMD.html">DMD</a> display;</div>
<div class="line"></div>
<div class="line">ISR(TIMER1_OVF_vect)</div>
<div class="line">{</div>
<div class="line"> display.<a class="code" href="classDMD.html#a9e4bf2a9d247312d35c1401ff61261c8" title="Refresh the display.">refresh</a>();</div>
<div class="line"> display.<a class="code" href="classDMD.html#a9e4bf2a9d247312d35c1401ff61261c8">refresh</a>();</div>
<div class="line">}</div>
<div class="line"></div>
<div class="line"><span class="keywordtype">void</span> setup() {</div>
<div class="line"> display.<a class="code" href="classDMD.html#a4c3b04b384f3d656a9b59690836775e2" title="Enables Timer1 overflow interrupts for updating this display.">enableTimer1</a>();</div>
<div class="line"> display.<a class="code" href="classDMD.html#a4c3b04b384f3d656a9b59690836775e2">enableTimer1</a>();</div>
<div class="line">}</div>
<div class="line"></div>
<div class="line"><span class="keywordtype">void</span> loop() {</div>
@@ -140,12 +141,12 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="line"></div>
<div class="line"><span class="keywordtype">void</span> drawShapes()</div>
<div class="line">{</div>
<div class="line"> display.<a class="code" href="classBitmap.html#a839dc8fab05a5ebf7a6b2e61436b2fa1" title="Clears the entire bitmap to the specified color.">clear</a>();</div>
<div class="line"> display.<a class="code" href="classBitmap.html#a933763a4f3cba79fbcf97ae6d0a864aa" title="Draws a circle with a specific center (centerX, centerY) and radius, with the outline in borderColor ...">drawCircle</a>(6, 8, 3);</div>
<div class="line"> display.<a class="code" href="classBitmap.html#a757291b9a39bcb0d64ac98d3a2fa061b" title="Draws a filled circle with a specific center (centerX, centerY) and radius in color.">drawFilledCircle</a>(16, 8, 3);</div>
<div class="line"> display.<a class="code" href="classBitmap.html#aa0a84f3694e343d68e7021552c69f767" title="Draws a line from (x1, y1) to (x2, y2) in color.">drawLine</a>(22, 5, 28, 11);</div>
<div class="line"> display.<a class="code" href="classBitmap.html#aa0a84f3694e343d68e7021552c69f767" title="Draws a line from (x1, y1) to (x2, y2) in color.">drawLine</a>(28, 5, 22, 11);</div>
<div class="line"> display.<a class="code" href="classBitmap.html#aac61e3f7f625db568e37d88b52b3b2fc" title="Draws a rectangle from (x1, y1) to (x2, y2), with the outline in borderColor and the interior filled ...">drawRect</a>(0, 0, display.<a class="code" href="classBitmap.html#a76c3b49e535761f07c553e7336daf523" title="Returns the width of the bitmap in pixels.">width</a>() - 1, display.<a class="code" href="classBitmap.html#adcd4e3dc7594421e647b0f52da9a41a3" title="Returns the height of the bitmap in pixels.">height</a>() - 1);</div>
<div class="line"> display.<a class="code" href="classBitmap.html#a839dc8fab05a5ebf7a6b2e61436b2fa1">clear</a>();</div>
<div class="line"> display.<a class="code" href="classBitmap.html#a933763a4f3cba79fbcf97ae6d0a864aa">drawCircle</a>(6, 8, 3);</div>
<div class="line"> display.<a class="code" href="classBitmap.html#a757291b9a39bcb0d64ac98d3a2fa061b">drawFilledCircle</a>(16, 8, 3);</div>
<div class="line"> display.<a class="code" href="classBitmap.html#aa0a84f3694e343d68e7021552c69f767">drawLine</a>(22, 5, 28, 11);</div>
<div class="line"> display.<a class="code" href="classBitmap.html#aa0a84f3694e343d68e7021552c69f767">drawLine</a>(28, 5, 22, 11);</div>
<div class="line"> display.<a class="code" href="classBitmap.html#aac61e3f7f625db568e37d88b52b3b2fc">drawRect</a>(0, 0, display.<a class="code" href="classBitmap.html#a76c3b49e535761f07c553e7336daf523">width</a>() - 1, display.<a class="code" href="classBitmap.html#adcd4e3dc7594421e647b0f52da9a41a3">height</a>() - 1);</div>
<div class="line">}</div>
<div class="line"></div>
<div class="line"><span class="keywordtype">void</span> drawBricks()</div>
@@ -159,7 +160,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="line"> B00001000, B00001000,</div>
<div class="line"> B00001000, B00001000</div>
<div class="line"> };</div>
<div class="line"> display.<a class="code" href="classBitmap.html#a99da820f9280aace6b512801d5a5e2b2" title="Fills the width x height pixels starting at top-left corner (x, y) with color.">fill</a>(0, 0, display.<a class="code" href="classBitmap.html#a76c3b49e535761f07c553e7336daf523" title="Returns the width of the bitmap in pixels.">width</a>(), display.<a class="code" href="classBitmap.html#adcd4e3dc7594421e647b0f52da9a41a3" title="Returns the height of the bitmap in pixels.">height</a>(), bricks);</div>
<div class="line"> display.<a class="code" href="classBitmap.html#a99da820f9280aace6b512801d5a5e2b2">fill</a>(0, 0, display.<a class="code" href="classBitmap.html#a76c3b49e535761f07c553e7336daf523">width</a>(), display.<a class="code" href="classBitmap.html#adcd4e3dc7594421e647b0f52da9a41a3">height</a>(), bricks);</div>
<div class="line">}</div>
<div class="line"></div>
<div class="line"><span class="keywordtype">void</span> drawStickFigures()</div>
@@ -180,64 +181,64 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<div class="line"> B01000001, B00000000,</div>
<div class="line"> B10000000, B10000000</div>
<div class="line"> };</div>
<div class="line"> display.<a class="code" href="classBitmap.html#a839dc8fab05a5ebf7a6b2e61436b2fa1" title="Clears the entire bitmap to the specified color.">clear</a>();</div>
<div class="line"> display.<a class="code" href="classBitmap.html#a491e9c0bb20ddf5a5eb4933077c8ed72" title="Draws bitmap at (x, y) in color.">drawBitmap</a>(2, 1, stickFigure);</div>
<div class="line"> display.<a class="code" href="classBitmap.html#a4321640464bc08b60348c09bff01b86a" title="Draws bitmap at (x, y) in inverted colors.">drawInvertedBitmap</a>(12, 1, stickFigure);</div>
<div class="line"> display.<a class="code" href="classBitmap.html#a491e9c0bb20ddf5a5eb4933077c8ed72" title="Draws bitmap at (x, y) in color.">drawBitmap</a>(22, 1, stickFigure);</div>
<div class="line"> display.<a class="code" href="classBitmap.html#a839dc8fab05a5ebf7a6b2e61436b2fa1">clear</a>();</div>
<div class="line"> display.<a class="code" href="classBitmap.html#a491e9c0bb20ddf5a5eb4933077c8ed72">drawBitmap</a>(2, 1, stickFigure);</div>
<div class="line"> display.<a class="code" href="classBitmap.html#a4321640464bc08b60348c09bff01b86a">drawInvertedBitmap</a>(12, 1, stickFigure);</div>
<div class="line"> display.<a class="code" href="classBitmap.html#a491e9c0bb20ddf5a5eb4933077c8ed72">drawBitmap</a>(22, 1, stickFigure);</div>
<div class="line">}</div>
<div class="line"></div>
<div class="line"><span class="keywordtype">void</span> drawText()</div>
<div class="line">{</div>
<div class="line"> display.<a class="code" href="classBitmap.html#a839dc8fab05a5ebf7a6b2e61436b2fa1" title="Clears the entire bitmap to the specified color.">clear</a>();</div>
<div class="line"> display.<a class="code" href="classBitmap.html#a64d7a9651d5c385a044cc910a3b82837" title="Sets the font for use with drawText() and drawChar().">setFont</a>(DejaVuSans9);</div>
<div class="line"> display.<a class="code" href="classBitmap.html#a3e9bcbfb584d5020bd6f0a313ee275f0" title="Draws the len characters of str at (x, y).">drawText</a>(0, 0, <span class="stringliteral">&quot;Hello&quot;</span>);</div>
<div class="line"> display.<a class="code" href="classBitmap.html#a3e9bcbfb584d5020bd6f0a313ee275f0" title="Draws the len characters of str at (x, y).">drawText</a>(9, 8, <span class="stringliteral">&quot;World&quot;</span>);</div>
<div class="line"> display.<a class="code" href="classBitmap.html#a839dc8fab05a5ebf7a6b2e61436b2fa1">clear</a>();</div>
<div class="line"> display.<a class="code" href="classBitmap.html#a64d7a9651d5c385a044cc910a3b82837">setFont</a>(DejaVuSans9);</div>
<div class="line"> display.<a class="code" href="classBitmap.html#a3e9bcbfb584d5020bd6f0a313ee275f0">drawText</a>(0, 0, <span class="stringliteral">&quot;Hello&quot;</span>);</div>
<div class="line"> display.<a class="code" href="classBitmap.html#a3e9bcbfb584d5020bd6f0a313ee275f0">drawText</a>(9, 8, <span class="stringliteral">&quot;World&quot;</span>);</div>
<div class="line">}</div>
<div class="line"></div>
<div class="line"><span class="keywordtype">void</span> drawBoldText()</div>
<div class="line">{</div>
<div class="line"> display.<a class="code" href="classBitmap.html#a839dc8fab05a5ebf7a6b2e61436b2fa1" title="Clears the entire bitmap to the specified color.">clear</a>();</div>
<div class="line"> display.<a class="code" href="classBitmap.html#a64d7a9651d5c385a044cc910a3b82837" title="Sets the font for use with drawText() and drawChar().">setFont</a>(DejaVuSansBold9);</div>
<div class="line"> display.<a class="code" href="classBitmap.html#a3e9bcbfb584d5020bd6f0a313ee275f0" title="Draws the len characters of str at (x, y).">drawText</a>(0, 0, <span class="stringliteral">&quot;Hello&quot;</span>);</div>
<div class="line"> display.<a class="code" href="classBitmap.html#a3e9bcbfb584d5020bd6f0a313ee275f0" title="Draws the len characters of str at (x, y).">drawText</a>(4, 8, <span class="stringliteral">&quot;World&quot;</span>);</div>
<div class="line"> display.<a class="code" href="classBitmap.html#a839dc8fab05a5ebf7a6b2e61436b2fa1">clear</a>();</div>
<div class="line"> display.<a class="code" href="classBitmap.html#a64d7a9651d5c385a044cc910a3b82837">setFont</a>(DejaVuSansBold9);</div>
<div class="line"> display.<a class="code" href="classBitmap.html#a3e9bcbfb584d5020bd6f0a313ee275f0">drawText</a>(0, 0, <span class="stringliteral">&quot;Hello&quot;</span>);</div>
<div class="line"> display.<a class="code" href="classBitmap.html#a3e9bcbfb584d5020bd6f0a313ee275f0">drawText</a>(4, 8, <span class="stringliteral">&quot;World&quot;</span>);</div>
<div class="line">}</div>
<div class="line"></div>
<div class="line"><span class="keywordtype">void</span> drawItalicText()</div>
<div class="line">{</div>
<div class="line"> display.<a class="code" href="classBitmap.html#a839dc8fab05a5ebf7a6b2e61436b2fa1" title="Clears the entire bitmap to the specified color.">clear</a>();</div>
<div class="line"> display.<a class="code" href="classBitmap.html#a64d7a9651d5c385a044cc910a3b82837" title="Sets the font for use with drawText() and drawChar().">setFont</a>(DejaVuSansItalic9);</div>
<div class="line"> display.<a class="code" href="classBitmap.html#a3e9bcbfb584d5020bd6f0a313ee275f0" title="Draws the len characters of str at (x, y).">drawText</a>(0, 0, <span class="stringliteral">&quot;Hello&quot;</span>);</div>
<div class="line"> display.<a class="code" href="classBitmap.html#a3e9bcbfb584d5020bd6f0a313ee275f0" title="Draws the len characters of str at (x, y).">drawText</a>(2, 8, <span class="stringliteral">&quot;World&quot;</span>);</div>
<div class="line"> display.<a class="code" href="classBitmap.html#a839dc8fab05a5ebf7a6b2e61436b2fa1">clear</a>();</div>
<div class="line"> display.<a class="code" href="classBitmap.html#a64d7a9651d5c385a044cc910a3b82837">setFont</a>(DejaVuSansItalic9);</div>
<div class="line"> display.<a class="code" href="classBitmap.html#a3e9bcbfb584d5020bd6f0a313ee275f0">drawText</a>(0, 0, <span class="stringliteral">&quot;Hello&quot;</span>);</div>
<div class="line"> display.<a class="code" href="classBitmap.html#a3e9bcbfb584d5020bd6f0a313ee275f0">drawText</a>(2, 8, <span class="stringliteral">&quot;World&quot;</span>);</div>
<div class="line">}</div>
<div class="line"></div>
<div class="line"><span class="keywordtype">void</span> drawMonoText()</div>
<div class="line">{</div>
<div class="line"> display.<a class="code" href="classBitmap.html#a839dc8fab05a5ebf7a6b2e61436b2fa1" title="Clears the entire bitmap to the specified color.">clear</a>();</div>
<div class="line"> display.<a class="code" href="classBitmap.html#a64d7a9651d5c385a044cc910a3b82837" title="Sets the font for use with drawText() and drawChar().">setFont</a>(Mono5x7);</div>
<div class="line"> display.<a class="code" href="classBitmap.html#a3e9bcbfb584d5020bd6f0a313ee275f0" title="Draws the len characters of str at (x, y).">drawText</a>(0, 0, <span class="stringliteral">&quot;Hello&quot;</span>);</div>
<div class="line"> display.<a class="code" href="classBitmap.html#a3e9bcbfb584d5020bd6f0a313ee275f0" title="Draws the len characters of str at (x, y).">drawText</a>(3, 8, <span class="stringliteral">&quot;World&quot;</span>);</div>
<div class="line"> display.<a class="code" href="classBitmap.html#a839dc8fab05a5ebf7a6b2e61436b2fa1">clear</a>();</div>
<div class="line"> display.<a class="code" href="classBitmap.html#a64d7a9651d5c385a044cc910a3b82837">setFont</a>(Mono5x7);</div>
<div class="line"> display.<a class="code" href="classBitmap.html#a3e9bcbfb584d5020bd6f0a313ee275f0">drawText</a>(0, 0, <span class="stringliteral">&quot;Hello&quot;</span>);</div>
<div class="line"> display.<a class="code" href="classBitmap.html#a3e9bcbfb584d5020bd6f0a313ee275f0">drawText</a>(3, 8, <span class="stringliteral">&quot;World&quot;</span>);</div>
<div class="line">}</div>
<div class="line"></div>
<div class="line"><span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span> message[] = <span class="stringliteral">&quot;Eat at Joes!&quot;</span>;</div>
<div class="line"></div>
<div class="line"><span class="keywordtype">void</span> drawMarquee()</div>
<div class="line">{</div>
<div class="line"> <span class="keywordtype">int</span> width = display.<a class="code" href="classBitmap.html#a76c3b49e535761f07c553e7336daf523" title="Returns the width of the bitmap in pixels.">width</a>();</div>
<div class="line"> display.<a class="code" href="classBitmap.html#a64d7a9651d5c385a044cc910a3b82837" title="Sets the font for use with drawText() and drawChar().">setFont</a>(DejaVuSans9);</div>
<div class="line"> <span class="keywordtype">int</span> msgWidth = display.<a class="code" href="classBitmap.html#a0f7607b1c7867987f4500d490a666e8a" title="Returns the width in pixels of the len characters of str in the current font(), including inter-chara...">textWidth</a>(message);</div>
<div class="line"> <span class="keywordtype">int</span> width = display.<a class="code" href="classBitmap.html#a76c3b49e535761f07c553e7336daf523">width</a>();</div>
<div class="line"> display.<a class="code" href="classBitmap.html#a64d7a9651d5c385a044cc910a3b82837">setFont</a>(DejaVuSans9);</div>
<div class="line"> <span class="keywordtype">int</span> msgWidth = display.<a class="code" href="classBitmap.html#a0f7607b1c7867987f4500d490a666e8a">textWidth</a>(message);</div>
<div class="line"> <span class="keywordtype">int</span> fullScroll = msgWidth + width + 1;</div>
<div class="line"> <span class="keywordflow">for</span> (<span class="keywordtype">int</span> x = 0; x &lt; fullScroll; ++x) {</div>
<div class="line"> display.<a class="code" href="classBitmap.html#a839dc8fab05a5ebf7a6b2e61436b2fa1" title="Clears the entire bitmap to the specified color.">clear</a>();</div>
<div class="line"> display.<a class="code" href="classBitmap.html#a3e9bcbfb584d5020bd6f0a313ee275f0" title="Draws the len characters of str at (x, y).">drawText</a>(width - x, 3, message);</div>
<div class="line"> display.<a class="code" href="classBitmap.html#a839dc8fab05a5ebf7a6b2e61436b2fa1">clear</a>();</div>
<div class="line"> display.<a class="code" href="classBitmap.html#a3e9bcbfb584d5020bd6f0a313ee275f0">drawText</a>(width - x, 3, message);</div>
<div class="line"> delay(50);</div>
<div class="line"> }</div>
<div class="line">}</div>
</div><!-- fragment --> </div></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>