1
0
mirror of https://github.com/taigrr/arduinolibs synced 2025-01-18 04:33:12 -08:00
arduinolibs/classBitmap.html
Rhys Weatherley 448ca56a5a Update docs
2012-06-10 10:52:14 +10:00

1599 lines
106 KiB
HTML

<!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"/>
<title>ArduinoLibs: Bitmap Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body onload='searchBox.OnSelectItem(0);'>
<!-- Generated by Doxygen 1.7.4 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">ArduinoLibs</div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;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 id="searchli">
<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&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a> &#124;
<a href="#friends">Friends</a> </div>
<div class="headertitle">
<div class="title">Bitmap Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="Bitmap" -->
<p>Represents a monochrome bitmap within main memory.
<a href="classBitmap.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="Bitmap_8h_source.html">Bitmap.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for Bitmap:</div>
<div class="dyncontent">
<div class="center">
<img src="classBitmap.png" usemap="#Bitmap_map" alt=""/>
<map id="Bitmap_map" name="Bitmap_map">
<area href="classDMD.html" title="Handle large dot matrix displays composed of LED&#39;s." alt="DMD" shape="rect" coords="0,56,49,80"/>
</map>
</div></div>
<p><a href="classBitmap-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBitmap.html#a88d386944a7017aa776a177b10d8b2ba">Color</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Type that represents the color of a pixel in a bitmap. <a href="#a88d386944a7017aa776a177b10d8b2ba"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBitmap.html#a40526748415c8bbc58a8510d636c20f4">Bitmap</a> (int width, int height)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a new in-memory bitmap that is <em>width</em> x <em>height</em> pixels in size. <a href="#a40526748415c8bbc58a8510d636c20f4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a72d2a301ec1eb1c8d0f3d64823659a8e"></a><!-- doxytag: member="Bitmap::~Bitmap" ref="a72d2a301ec1eb1c8d0f3d64823659a8e" args="()" -->
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBitmap.html#a72d2a301ec1eb1c8d0f3d64823659a8e">~Bitmap</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroys this bitmap. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBitmap.html#a3846a240722e847d3cf11f701da1ce7b">isValid</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if the memory for this bitmap is valid; false otherwise. <a href="#a3846a240722e847d3cf11f701da1ce7b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBitmap.html#a76c3b49e535761f07c553e7336daf523">width</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the width of the bitmap in pixels. <a href="#a76c3b49e535761f07c553e7336daf523"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBitmap.html#adcd4e3dc7594421e647b0f52da9a41a3">height</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the height of the bitmap in pixels. <a href="#adcd4e3dc7594421e647b0f52da9a41a3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBitmap.html#af30df263729385ea2330effe3c80a1bc">stride</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the number of bytes in each line of the bitmap's <a class="el" href="classBitmap.html#a5eeed27c176eb6e4a2c39ea83444e27d" title="Returns a pointer to the start of the bitmap&#39;s data buffer.">data()</a> buffer. <a href="#af30df263729385ea2330effe3c80a1bc"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBitmap.html#ad18d3d5a1e77d541a95e93ad1f958411">bitsPerPixel</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the number of bits per pixel for the bitmap; always 1. <a href="#ad18d3d5a1e77d541a95e93ad1f958411"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint8_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBitmap.html#a5eeed27c176eb6e4a2c39ea83444e27d">data</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a pointer to the start of the bitmap's data buffer. <a href="#a5eeed27c176eb6e4a2c39ea83444e27d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a20fea2a946545aa3b5edd78245149e5f"></a><!-- doxytag: member="Bitmap::data" ref="a20fea2a946545aa3b5edd78245149e5f" args="() const " -->
const uint8_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBitmap.html#a20fea2a946545aa3b5edd78245149e5f">data</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a constant pointer to the start of the bitmap's data buffer.This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBitmap.html#a839dc8fab05a5ebf7a6b2e61436b2fa1">clear</a> (<a class="el" href="classBitmap.html#a88d386944a7017aa776a177b10d8b2ba">Color</a> color=<a class="el" href="classBitmap.html#a2c7faeeb89d3624b5bbca58871785adc">Black</a>)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Clears the entire bitmap to the specified <em>color</em>. <a href="#a839dc8fab05a5ebf7a6b2e61436b2fa1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classBitmap.html#a88d386944a7017aa776a177b10d8b2ba">Color</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBitmap.html#a35aa38b377d509d6c4f061a0b988d203">pixel</a> (int x, int y) const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the color of the pixel at (<em>x</em>, <em>y</em>); either <a class="el" href="classBitmap.html#a2c7faeeb89d3624b5bbca58871785adc">Black</a> or <a class="el" href="classBitmap.html#a39b6754cfe50a457bbfdb1980fd87eb7">White</a>. <a href="#a35aa38b377d509d6c4f061a0b988d203"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBitmap.html#aac994b75418e7d37ec66829437329114">setPixel</a> (int x, int y, <a class="el" href="classBitmap.html#a88d386944a7017aa776a177b10d8b2ba">Color</a> color)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the pixel at (<em>x</em>, <em>y</em>) to <em>color</em>. <a href="#aac994b75418e7d37ec66829437329114"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBitmap.html#aa0a84f3694e343d68e7021552c69f767">drawLine</a> (int x1, int y1, int x2, int y2, <a class="el" href="classBitmap.html#a88d386944a7017aa776a177b10d8b2ba">Color</a> color=<a class="el" href="classBitmap.html#a39b6754cfe50a457bbfdb1980fd87eb7">White</a>)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Draws a line from (<em>x1</em>, <em>y1</em>) to (<em>x2</em>, <em>y2</em>) in <em>color</em>. <a href="#aa0a84f3694e343d68e7021552c69f767"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBitmap.html#aac61e3f7f625db568e37d88b52b3b2fc">drawRect</a> (int x1, int y1, int x2, int y2, <a class="el" href="classBitmap.html#a88d386944a7017aa776a177b10d8b2ba">Color</a> borderColor=<a class="el" href="classBitmap.html#a39b6754cfe50a457bbfdb1980fd87eb7">White</a>, <a class="el" href="classBitmap.html#a88d386944a7017aa776a177b10d8b2ba">Color</a> fillColor=<a class="el" href="classBitmap.html#aa89170263dc1f51f6366c1907119715e">NoFill</a>)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Draws a rectangle from (<em>x1</em>, <em>y1</em>) to (<em>x2</em>, <em>y2</em>), with the outline in <em>borderColor</em> and the interior filled with <em>fillColor</em>. <a href="#aac61e3f7f625db568e37d88b52b3b2fc"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBitmap.html#a568acbca3818dd85dd62fff6d0b36ffb">drawFilledRect</a> (int x1, int y1, int x2, int y2, <a class="el" href="classBitmap.html#a88d386944a7017aa776a177b10d8b2ba">Color</a> color=<a class="el" href="classBitmap.html#a39b6754cfe50a457bbfdb1980fd87eb7">White</a>)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Draws a filled rectangle from (<em>x1</em>, <em>y1</em>) to (<em>x2</em>, <em>y2</em>) in <em>color</em>. <a href="#a568acbca3818dd85dd62fff6d0b36ffb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBitmap.html#a933763a4f3cba79fbcf97ae6d0a864aa">drawCircle</a> (int centerX, int centerY, int radius, <a class="el" href="classBitmap.html#a88d386944a7017aa776a177b10d8b2ba">Color</a> borderColor=<a class="el" href="classBitmap.html#a39b6754cfe50a457bbfdb1980fd87eb7">White</a>, <a class="el" href="classBitmap.html#a88d386944a7017aa776a177b10d8b2ba">Color</a> fillColor=<a class="el" href="classBitmap.html#aa89170263dc1f51f6366c1907119715e">NoFill</a>)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Draws a circle with a specific center (<em>centerX</em>, <em>centerY</em>) and <em>radius</em>, with the outline in <em>borderColor</em> and the interior filled with <em>fillColor</em>. <a href="#a933763a4f3cba79fbcf97ae6d0a864aa"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBitmap.html#a757291b9a39bcb0d64ac98d3a2fa061b">drawFilledCircle</a> (int centerX, int centerY, int radius, <a class="el" href="classBitmap.html#a88d386944a7017aa776a177b10d8b2ba">Color</a> color=<a class="el" href="classBitmap.html#a39b6754cfe50a457bbfdb1980fd87eb7">White</a>)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Draws a filled circle with a specific center (<em>centerX</em>, <em>centerY</em>) and <em>radius</em> in <em>color</em>. <a href="#a757291b9a39bcb0d64ac98d3a2fa061b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBitmap.html#a491e9c0bb20ddf5a5eb4933077c8ed72">drawBitmap</a> (int x, int y, const <a class="el" href="classBitmap.html">Bitmap</a> &amp;bitmap, <a class="el" href="classBitmap.html#a88d386944a7017aa776a177b10d8b2ba">Color</a> color=<a class="el" href="classBitmap.html#a39b6754cfe50a457bbfdb1980fd87eb7">White</a>)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Draws <em>bitmap</em> at (<em>x</em>, <em>y</em>) in <em>color</em>. <a href="#a491e9c0bb20ddf5a5eb4933077c8ed72"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBitmap.html#aa4089d785c59f16dcf0505ec04b4e658">drawBitmap</a> (int x, int y, const prog_uint8_t *bitmap, <a class="el" href="classBitmap.html#a88d386944a7017aa776a177b10d8b2ba">Color</a> color=<a class="el" href="classBitmap.html#a39b6754cfe50a457bbfdb1980fd87eb7">White</a>)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Draws <em>bitmap</em> at (<em>x</em>, <em>y</em>) in <em>color</em>. <a href="#aa4089d785c59f16dcf0505ec04b4e658"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBitmap.html#a4321640464bc08b60348c09bff01b86a">drawInvertedBitmap</a> (int x, int y, const <a class="el" href="classBitmap.html">Bitmap</a> &amp;bitmap)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Draws <em>bitmap</em> at (<em>x</em>, <em>y</em>) in inverted colors. <a href="#a4321640464bc08b60348c09bff01b86a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBitmap.html#ae41aa6bfa8d508d216e25d80bb93747e">drawInvertedBitmap</a> (int x, int y, const prog_uint8_t *bitmap)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Draws <em>bitmap</em> at (<em>x</em>, <em>y</em>) in inverted colors. <a href="#ae41aa6bfa8d508d216e25d80bb93747e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const prog_uint8_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBitmap.html#ab6bd47cb892b47b4c69b422ace182b87">font</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the currently selected font, or null if none selected. <a href="#ab6bd47cb892b47b4c69b422ace182b87"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBitmap.html#abf7adfceb267080aa9806388e96358c4">setFont</a> (const prog_uint8_t *font)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the <em>font</em> for use with <a class="el" href="classBitmap.html#a3e9bcbfb584d5020bd6f0a313ee275f0" title="Draws the len characters of str at (x, y).">drawText()</a> and <a class="el" href="classBitmap.html#a1a11f29863ee7f36a3b15c91963102bd" title="Draws a single character ch at (x, y).">drawChar()</a>. <a href="#abf7adfceb267080aa9806388e96358c4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classBitmap.html#a88d386944a7017aa776a177b10d8b2ba">Color</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBitmap.html#ab6e5f5744fd2f18478aac428b751d848">textColor</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the color that will be used for drawing text with <a class="el" href="classBitmap.html#a3e9bcbfb584d5020bd6f0a313ee275f0" title="Draws the len characters of str at (x, y).">drawText()</a> and <a class="el" href="classBitmap.html#a1a11f29863ee7f36a3b15c91963102bd" title="Draws a single character ch at (x, y).">drawChar()</a>. The default is <a class="el" href="classBitmap.html#a39b6754cfe50a457bbfdb1980fd87eb7">White</a>. <a href="#ab6e5f5744fd2f18478aac428b751d848"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBitmap.html#a8e225a4f188269bb18265ae4b49de0a3">setTextColor</a> (<a class="el" href="classBitmap.html#a88d386944a7017aa776a177b10d8b2ba">Color</a> color)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the <em>color</em> that will be used for drawing text with <a class="el" href="classBitmap.html#a3e9bcbfb584d5020bd6f0a313ee275f0" title="Draws the len characters of str at (x, y).">drawText()</a> and <a class="el" href="classBitmap.html#a1a11f29863ee7f36a3b15c91963102bd" title="Draws a single character ch at (x, y).">drawChar()</a>. <a href="#a8e225a4f188269bb18265ae4b49de0a3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBitmap.html#a3e9bcbfb584d5020bd6f0a313ee275f0">drawText</a> (int x, int y, const char *str, int len=-1)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Draws the <em>len</em> characters of <em>str</em> at (<em>x</em>, <em>y</em>). <a href="#a3e9bcbfb584d5020bd6f0a313ee275f0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBitmap.html#a802f5d6bd19a3727670e61e7a88a0cac">drawText</a> (int x, int y, const String &amp;str, int start=0, int len=-1)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Draws <em>len</em> characters starting at <em>start</em> from <em>str</em> to the screen at (<em>x</em>, <em>y</em>). <a href="#a802f5d6bd19a3727670e61e7a88a0cac"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBitmap.html#a1a11f29863ee7f36a3b15c91963102bd">drawChar</a> (int x, int y, char ch)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Draws a single character <em>ch</em> at (<em>x</em>, <em>y</em>). <a href="#a1a11f29863ee7f36a3b15c91963102bd"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBitmap.html#a9b79ac13077ca865e4515510297780bd">charWidth</a> (char ch) const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the width in pixels of <em>ch</em> in the current <a class="el" href="classBitmap.html#ab6bd47cb892b47b4c69b422ace182b87" title="Returns the currently selected font, or null if none selected.">font()</a>. <a href="#a9b79ac13077ca865e4515510297780bd"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBitmap.html#a0f7607b1c7867987f4500d490a666e8a">textWidth</a> (const char *str, int len=-1) const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the width in pixels of the <em>len</em> characters of <em>str</em> in the current <a class="el" href="classBitmap.html#ab6bd47cb892b47b4c69b422ace182b87" title="Returns the currently selected font, or null if none selected.">font()</a>, including inter-character spacing. <a href="#a0f7607b1c7867987f4500d490a666e8a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBitmap.html#a8ca70aa0f8f722a228358bffe794e925">textWidth</a> (const String &amp;str, int start=0, int len=-1) const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the width in pixels of the <em>len</em> characters of <em>str</em> in the current <a class="el" href="classBitmap.html#ab6bd47cb892b47b4c69b422ace182b87" title="Returns the currently selected font, or null if none selected.">font()</a>, starting at <em>start</em>, including inter-character spacing. <a href="#a8ca70aa0f8f722a228358bffe794e925"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBitmap.html#a628bb694fcfe6eab619a4f1e152d41c4">textHeight</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the height in pixels of the current text drawing <a class="el" href="classBitmap.html#ab6bd47cb892b47b4c69b422ace182b87" title="Returns the currently selected font, or null if none selected.">font()</a>; or zero if <a class="el" href="classBitmap.html#ab6bd47cb892b47b4c69b422ace182b87" title="Returns the currently selected font, or null if none selected.">font()</a> is not set. <a href="#a628bb694fcfe6eab619a4f1e152d41c4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBitmap.html#ab22fe1f3871934987a670b559f67c67c">copy</a> (int x, int y, int width, int height, <a class="el" href="classBitmap.html">Bitmap</a> *dest, int destX, int destY)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Copies the <em>width</em> x <em>height</em> pixels starting at top-left corner (<em>x</em>, <em>y</em>) to (<em>destX</em>, <em>destY</em>) in the bitmap <em>dest</em>. <a href="#ab22fe1f3871934987a670b559f67c67c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBitmap.html#a99da820f9280aace6b512801d5a5e2b2">fill</a> (int x, int y, int width, int height, <a class="el" href="classBitmap.html#a88d386944a7017aa776a177b10d8b2ba">Color</a> color)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Fills the <em>width</em> x <em>height</em> pixels starting at top-left corner (<em>x</em>, <em>y</em>) with <em>color</em>. <a href="#a99da820f9280aace6b512801d5a5e2b2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBitmap.html#aadcad6c9e1f10f0ddbb789401132aa6f">fill</a> (int x, int y, int width, int height, const prog_uint8_t *pattern, <a class="el" href="classBitmap.html#a88d386944a7017aa776a177b10d8b2ba">Color</a> color=<a class="el" href="classBitmap.html#a39b6754cfe50a457bbfdb1980fd87eb7">White</a>)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Fills the <em>width</em> x <em>height</em> pixels starting at top-left corner (<em>x</em>, <em>y</em>) with the contents of <em>pattern</em>. <a href="#aadcad6c9e1f10f0ddbb789401132aa6f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBitmap.html#ae08eb6f9086f9923d8dc83a469ae4c4a">scroll</a> (int dx, int dy, <a class="el" href="classBitmap.html#a88d386944a7017aa776a177b10d8b2ba">Color</a> fillColor=<a class="el" href="classBitmap.html#a2c7faeeb89d3624b5bbca58871785adc">Black</a>)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Scrolls the entire contents of the bitmap by <em>dx</em> and <em>dy</em>. <a href="#ae08eb6f9086f9923d8dc83a469ae4c4a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBitmap.html#af79ad4432297ff453fddc55625fec485">scroll</a> (int x, int y, int width, int height, int dx, int dy, <a class="el" href="classBitmap.html#a88d386944a7017aa776a177b10d8b2ba">Color</a> fillColor=<a class="el" href="classBitmap.html#a2c7faeeb89d3624b5bbca58871785adc">Black</a>)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Scrolls the <em>width</em> x <em>height</em> pixels starting at top-left corner (<em>x</em>, <em>y</em>) by <em>dx</em> and <em>dy</em>. <a href="#af79ad4432297ff453fddc55625fec485"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBitmap.html#a6d85556bcc9fac91d33f0f6f7a6430dd">invert</a> (int x, int y, int width, int height)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Inverts the <em>width</em> x <em>height</em> pixels starting at top-left corner (<em>x</em>, <em>y</em>). <a href="#a6d85556bcc9fac91d33f0f6f7a6430dd"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2c7faeeb89d3624b5bbca58871785adc"></a><!-- doxytag: member="Bitmap::Black" ref="a2c7faeeb89d3624b5bbca58871785adc" args="" -->
static const <a class="el" href="classBitmap.html#a88d386944a7017aa776a177b10d8b2ba">Color</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBitmap.html#a2c7faeeb89d3624b5bbca58871785adc">Black</a> = 0</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Color value corresponding to "black". <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static const <a class="el" href="classBitmap.html#a88d386944a7017aa776a177b10d8b2ba">Color</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBitmap.html#a39b6754cfe50a457bbfdb1980fd87eb7">White</a> = 1</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Color value corresponding to "white". If the bitmap is displayed on a LED array, then it may have a different physical color. <a href="#a39b6754cfe50a457bbfdb1980fd87eb7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa89170263dc1f51f6366c1907119715e"></a><!-- doxytag: member="Bitmap::NoFill" ref="aa89170263dc1f51f6366c1907119715e" args="" -->
static const <a class="el" href="classBitmap.html#a88d386944a7017aa776a177b10d8b2ba">Color</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBitmap.html#aa89170263dc1f51f6366c1907119715e">NoFill</a> = 2</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Special color value that is used with <a class="el" 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> and <a class="el" href="classBitmap.html#a933763a4f3cba79fbcf97ae6d0a864aa" title="Draws a circle with a specific center (centerX, centerY) and radius, with the outline in borderColor ...">drawCircle()</a> to indicate that the interior of the shape should not be filled. For all other uses, <a class="el" href="classBitmap.html#aa89170263dc1f51f6366c1907119715e">NoFill</a> is equivalent to <a class="el" href="classBitmap.html#a39b6754cfe50a457bbfdb1980fd87eb7">White</a>. <br/></td></tr>
<tr><td colspan="2"><h2><a name="friends"></a>
Friends</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a769b04b75cd09068f72f34025272c0db"></a><!-- doxytag: member="Bitmap::DMD" ref="a769b04b75cd09068f72f34025272c0db" args="" -->
class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBitmap.html#a769b04b75cd09068f72f34025272c0db">DMD</a></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Represents a monochrome bitmap within main memory. </p>
<p>Bitmaps are a rectangular arrangement of <a class="el" href="classBitmap.html#a76c3b49e535761f07c553e7336daf523" title="Returns the width of the bitmap in pixels.">width()</a> x <a class="el" href="classBitmap.html#adcd4e3dc7594421e647b0f52da9a41a3" title="Returns the height of the bitmap in pixels.">height()</a> pixels, with each pixel set to either <a class="el" href="classBitmap.html#a2c7faeeb89d3624b5bbca58871785adc">Black</a> or <a class="el" href="classBitmap.html#a39b6754cfe50a457bbfdb1980fd87eb7">White</a>. The co-ordinate system has origin (0, 0) at the top-left of the bitmap.</p>
<p>Functions within this class can be used to draw various shapes into the bitmap's <a class="el" href="classBitmap.html#a5eeed27c176eb6e4a2c39ea83444e27d" title="Returns a pointer to the start of the bitmap&#39;s data buffer.">data()</a> buffer; e.g. <a class="el" href="classBitmap.html#aa0a84f3694e343d68e7021552c69f767" title="Draws a line from (x1, y1) to (x2, y2) in color.">drawLine()</a>, <a class="el" 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>, <a class="el" href="classBitmap.html#a491e9c0bb20ddf5a5eb4933077c8ed72" title="Draws bitmap at (x, y) in color.">drawBitmap()</a>, <a class="el" href="classBitmap.html#a3e9bcbfb584d5020bd6f0a313ee275f0" title="Draws the len characters of str at (x, y).">drawText()</a>, <a class="el" href="classBitmap.html#a839dc8fab05a5ebf7a6b2e61436b2fa1" title="Clears the entire bitmap to the specified color.">clear()</a>, <a class="el" href="classBitmap.html#a99da820f9280aace6b512801d5a5e2b2" title="Fills the width x height pixels starting at top-left corner (x, y) with color.">fill()</a>, etc.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classDMD.html" title="Handle large dot matrix displays composed of LED&#39;s.">DMD</a> </dd></dl>
<p>Definition at line <a class="el" href="Bitmap_8h_source.html#l00032">32</a> of file <a class="el" href="Bitmap_8h_source.html">Bitmap.h</a>.</p>
</div><hr/><h2>Member Typedef Documentation</h2>
<a class="anchor" id="a88d386944a7017aa776a177b10d8b2ba"></a><!-- doxytag: member="Bitmap::Color" ref="a88d386944a7017aa776a177b10d8b2ba" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classBitmap.html#a88d386944a7017aa776a177b10d8b2ba">Bitmap::Color</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Type that represents the color of a pixel in a bitmap. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classBitmap.html#a2c7faeeb89d3624b5bbca58871785adc" title="Color value corresponding to &quot;black&quot;.">Black</a>, <a class="el" href="classBitmap.html#a39b6754cfe50a457bbfdb1980fd87eb7" title="Color value corresponding to &quot;white&quot;. If the bitmap is displayed on a LED array, then it may have a d...">White</a> </dd></dl>
<p>Definition at line <a class="el" href="Bitmap_8h_source.html#l00040">40</a> of file <a class="el" href="Bitmap_8h_source.html">Bitmap.h</a>.</p>
</div>
</div>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a40526748415c8bbc58a8510d636c20f4"></a><!-- doxytag: member="Bitmap::Bitmap" ref="a40526748415c8bbc58a8510d636c20f4" args="(int width, int height)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Bitmap::Bitmap </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>width</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>height</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructs a new in-memory bitmap that is <em>width</em> x <em>height</em> pixels in size. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classBitmap.html#a76c3b49e535761f07c553e7336daf523" title="Returns the width of the bitmap in pixels.">width()</a>, <a class="el" href="classBitmap.html#adcd4e3dc7594421e647b0f52da9a41a3" title="Returns the height of the bitmap in pixels.">height()</a>, <a class="el" href="classBitmap.html#a3846a240722e847d3cf11f701da1ce7b" title="Returns true if the memory for this bitmap is valid; false otherwise.">isValid()</a> </dd></dl>
<p>Definition at line <a class="el" href="Bitmap_8cpp_source.html#l00078">78</a> of file <a class="el" href="Bitmap_8cpp_source.html">Bitmap.cpp</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ad18d3d5a1e77d541a95e93ad1f958411"></a><!-- doxytag: member="Bitmap::bitsPerPixel" ref="ad18d3d5a1e77d541a95e93ad1f958411" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int Bitmap::bitsPerPixel </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the number of bits per pixel for the bitmap; always 1. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classBitmap.html#a76c3b49e535761f07c553e7336daf523" title="Returns the width of the bitmap in pixels.">width()</a>, <a class="el" href="classBitmap.html#adcd4e3dc7594421e647b0f52da9a41a3" title="Returns the height of the bitmap in pixels.">height()</a> </dd></dl>
<p>Definition at line <a class="el" href="Bitmap_8h_source.html#l00049">49</a> of file <a class="el" href="Bitmap_8h_source.html">Bitmap.h</a>.</p>
</div>
</div>
<a class="anchor" id="a9b79ac13077ca865e4515510297780bd"></a><!-- doxytag: member="Bitmap::charWidth" ref="a9b79ac13077ca865e4515510297780bd" args="(char ch) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int Bitmap::charWidth </td>
<td>(</td>
<td class="paramtype">char&#160;</td>
<td class="paramname"><em>ch</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the width in pixels of <em>ch</em> in the current <a class="el" href="classBitmap.html#ab6bd47cb892b47b4c69b422ace182b87" title="Returns the currently selected font, or null if none selected.">font()</a>. </p>
<p>Returns zero if <a class="el" href="classBitmap.html#ab6bd47cb892b47b4c69b422ace182b87" title="Returns the currently selected font, or null if none selected.">font()</a> is not set, or <em>ch</em> is not present in <a class="el" href="classBitmap.html#ab6bd47cb892b47b4c69b422ace182b87" title="Returns the currently selected font, or null if none selected.">font()</a>.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classBitmap.html#a1a11f29863ee7f36a3b15c91963102bd" title="Draws a single character ch at (x, y).">drawChar()</a>, <a class="el" href="classBitmap.html#ab6bd47cb892b47b4c69b422ace182b87" title="Returns the currently selected font, or null if none selected.">font()</a>, <a class="el" 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>, <a class="el" href="classBitmap.html#a628bb694fcfe6eab619a4f1e152d41c4" title="Returns the height in pixels of the current text drawing font(); or zero if font() is not set...">textHeight()</a> </dd></dl>
<p>Definition at line <a class="el" href="Bitmap_8cpp_source.html#l00640">640</a> of file <a class="el" href="Bitmap_8cpp_source.html">Bitmap.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a839dc8fab05a5ebf7a6b2e61436b2fa1"></a><!-- doxytag: member="Bitmap::clear" ref="a839dc8fab05a5ebf7a6b2e61436b2fa1" args="(Color color=Black)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Bitmap::clear </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classBitmap.html#a88d386944a7017aa776a177b10d8b2ba">Color</a>&#160;</td>
<td class="paramname"><em>color</em> = <code><a class="el" href="classBitmap.html#a2c7faeeb89d3624b5bbca58871785adc">Black</a></code></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Clears the entire bitmap to the specified <em>color</em>. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classBitmap.html#a99da820f9280aace6b512801d5a5e2b2" title="Fills the width x height pixels starting at top-left corner (x, y) with color.">fill()</a> </dd></dl>
<p>Definition at line <a class="el" href="Bitmap_8cpp_source.html#l00164">164</a> of file <a class="el" href="Bitmap_8cpp_source.html">Bitmap.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ab22fe1f3871934987a670b559f67c67c"></a><!-- doxytag: member="Bitmap::copy" ref="ab22fe1f3871934987a670b559f67c67c" args="(int x, int y, int width, int height, Bitmap *dest, int destX, int destY)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Bitmap::copy </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>width</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>height</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classBitmap.html">Bitmap</a> *&#160;</td>
<td class="paramname"><em>dest</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>destX</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>destY</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Copies the <em>width</em> x <em>height</em> pixels starting at top-left corner (<em>x</em>, <em>y</em>) to (<em>destX</em>, <em>destY</em>) in the bitmap <em>dest</em>. </p>
<p>The <em>dest</em> bitmap can be the same as this object, in which case the copy will be performed in a manner that correctly handles overlapping regions.</p>
<p>If some part of the source region is outside the bounds of this object, then the value <a class="el" href="classBitmap.html#a2c7faeeb89d3624b5bbca58871785adc">Black</a> will be copied to <em>dest</em> for those pixels. This can be used to produce a behaviour similar to <a class="el" href="classBitmap.html#ae08eb6f9086f9923d8dc83a469ae4c4a" title="Scrolls the entire contents of the bitmap by dx and dy.">scroll()</a> when <em>bitmap</em> is the same as this object.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classBitmap.html#a491e9c0bb20ddf5a5eb4933077c8ed72" title="Draws bitmap at (x, y) in color.">drawBitmap()</a>, <a class="el" href="classBitmap.html#a99da820f9280aace6b512801d5a5e2b2" title="Fills the width x height pixels starting at top-left corner (x, y) with color.">fill()</a>, <a class="el" href="classBitmap.html#ae08eb6f9086f9923d8dc83a469ae4c4a" title="Scrolls the entire contents of the bitmap by dx and dy.">scroll()</a> </dd></dl>
<p>Definition at line <a class="el" href="Bitmap_8cpp_source.html#l00728">728</a> of file <a class="el" href="Bitmap_8cpp_source.html">Bitmap.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a5eeed27c176eb6e4a2c39ea83444e27d"></a><!-- doxytag: member="Bitmap::data" ref="a5eeed27c176eb6e4a2c39ea83444e27d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t * Bitmap::data </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns a pointer to the start of the bitmap's data buffer. </p>
<p>The data is organized as <a class="el" href="classBitmap.html#adcd4e3dc7594421e647b0f52da9a41a3" title="Returns the height of the bitmap in pixels.">height()</a> lines of <a class="el" href="classBitmap.html#af30df263729385ea2330effe3c80a1bc" title="Returns the number of bytes in each line of the bitmap&#39;s data() buffer.">stride()</a> bytes, laid out horizontally across the extent of <a class="el" href="classBitmap.html#a76c3b49e535761f07c553e7336daf523" title="Returns the width of the bitmap in pixels.">width()</a> pixels. The most significant bit in each byte has the lowest x value.</p>
<p>Note: bits within the data are 1 for <a class="el" href="classBitmap.html#a2c7faeeb89d3624b5bbca58871785adc">Black</a> and 0 for <a class="el" href="classBitmap.html#a39b6754cfe50a457bbfdb1980fd87eb7">White</a>, which is the reverse of the constant values. This differs from <a class="el" href="classBitmap.html#a35aa38b377d509d6c4f061a0b988d203" title="Returns the color of the pixel at (x, y); either Black or White.">pixel()</a> which returns the correct constant.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classBitmap.html#a35aa38b377d509d6c4f061a0b988d203" title="Returns the color of the pixel at (x, y); either Black or White.">pixel()</a>, <a class="el" href="classBitmap.html#af30df263729385ea2330effe3c80a1bc" title="Returns the number of bytes in each line of the bitmap&#39;s data() buffer.">stride()</a> </dd></dl>
<p>Definition at line <a class="el" href="Bitmap_8h_source.html#l00051">51</a> of file <a class="el" href="Bitmap_8h_source.html">Bitmap.h</a>.</p>
</div>
</div>
<a class="anchor" id="a491e9c0bb20ddf5a5eb4933077c8ed72"></a><!-- doxytag: member="Bitmap::drawBitmap" ref="a491e9c0bb20ddf5a5eb4933077c8ed72" args="(int x, int y, const Bitmap &amp;bitmap, Color color=White)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Bitmap::drawBitmap </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classBitmap.html">Bitmap</a> &amp;&#160;</td>
<td class="paramname"><em>bitmap</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classBitmap.html#a88d386944a7017aa776a177b10d8b2ba">Color</a>&#160;</td>
<td class="paramname"><em>color</em> = <code><a class="el" href="classBitmap.html#a39b6754cfe50a457bbfdb1980fd87eb7">White</a></code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Draws <em>bitmap</em> at (<em>x</em>, <em>y</em>) in <em>color</em>. </p>
<p>Bits that are set to <a class="el" href="classBitmap.html#a39b6754cfe50a457bbfdb1980fd87eb7">White</a> in the <em>bitmap</em> are drawn with <em>color</em>. Bits that are set to <a class="el" href="classBitmap.html#a2c7faeeb89d3624b5bbca58871785adc">Black</a> in the <em>bitmap</em> are drawn with the inverse of <em>color</em>. The pixel at (<em>x</em>, <em>y</em>) will be the top-left corner of the drawn image.</p>
<p>Note: <em>bitmap</em> must not be the same as this object or the behaviour will be undefined. To copy a region of a bitmap to elsewhere within the same bitmap, use <a class="el" href="classBitmap.html#ab22fe1f3871934987a670b559f67c67c" title="Copies the width x height pixels starting at top-left corner (x, y) to (destX, destY) in the bitmap d...">copy()</a> instead.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classBitmap.html#a4321640464bc08b60348c09bff01b86a" title="Draws bitmap at (x, y) in inverted colors.">drawInvertedBitmap()</a>, <a class="el" href="classBitmap.html#ab22fe1f3871934987a670b559f67c67c" title="Copies the width x height pixels starting at top-left corner (x, y) to (destX, destY) in the bitmap d...">copy()</a> </dd></dl>
<p>Definition at line <a class="el" href="Bitmap_8cpp_source.html#l00378">378</a> of file <a class="el" href="Bitmap_8cpp_source.html">Bitmap.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="aa4089d785c59f16dcf0505ec04b4e658"></a><!-- doxytag: member="Bitmap::drawBitmap" ref="aa4089d785c59f16dcf0505ec04b4e658" args="(int x, int y, const prog_uint8_t *bitmap, Color color=White)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Bitmap::drawBitmap </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const prog_uint8_t *&#160;</td>
<td class="paramname"><em>bitmap</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classBitmap.html#a88d386944a7017aa776a177b10d8b2ba">Color</a>&#160;</td>
<td class="paramname"><em>color</em> = <code><a class="el" href="classBitmap.html#a39b6754cfe50a457bbfdb1980fd87eb7">White</a></code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Draws <em>bitmap</em> at (<em>x</em>, <em>y</em>) in <em>color</em>. </p>
<p>The <em>bitmap</em> must point to program memory. The first two bytes are the width and height of the bitmap in pixels. The rest of the data contains the pixels for the bitmap, with lines byte-aligned.</p>
<p>Bits that are 1 in the <em>bitmap</em> are drawn with <em>color</em>. Bits that are 0 in the <em>bitmap</em> are drawn with the inverse of <em>color</em>. The pixel at (<em>x</em>, <em>y</em>) will be the top-left corner of the drawn image.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classBitmap.html#a4321640464bc08b60348c09bff01b86a" title="Draws bitmap at (x, y) in inverted colors.">drawInvertedBitmap()</a>, <a class="el" href="classBitmap.html#a99da820f9280aace6b512801d5a5e2b2" title="Fills the width x height pixels starting at top-left corner (x, y) with color.">fill()</a> </dd></dl>
<p>Definition at line <a class="el" href="Bitmap_8cpp_source.html#l00415">415</a> of file <a class="el" href="Bitmap_8cpp_source.html">Bitmap.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a1a11f29863ee7f36a3b15c91963102bd"></a><!-- doxytag: member="Bitmap::drawChar" ref="a1a11f29863ee7f36a3b15c91963102bd" args="(int x, int y, char ch)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int Bitmap::drawChar </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char&#160;</td>
<td class="paramname"><em>ch</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Draws a single character <em>ch</em> at (<em>x</em>, <em>y</em>). </p>
<p>Returns the width of the character in pixels so that higher-order functions like <a class="el" href="classBitmap.html#a3e9bcbfb584d5020bd6f0a313ee275f0" title="Draws the len characters of str at (x, y).">drawText()</a> can advance <em>x</em> to the location of the next character to be drawn. The width does not include inter-character spacing.</p>
<p>The position (<em>x</em>, <em>y</em>) will be the upper-left pixel of the drawn character.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classBitmap.html#a3e9bcbfb584d5020bd6f0a313ee275f0" title="Draws the len characters of str at (x, y).">drawText()</a>, <a class="el" href="classBitmap.html#ab6e5f5744fd2f18478aac428b751d848" title="Returns the color that will be used for drawing text with drawText() and drawChar(). The default is White.">textColor()</a>, <a class="el" href="classBitmap.html#ab6bd47cb892b47b4c69b422ace182b87" title="Returns the currently selected font, or null if none selected.">font()</a>, <a class="el" href="classBitmap.html#a9b79ac13077ca865e4515510297780bd" title="Returns the width in pixels of ch in the current font().">charWidth()</a> </dd></dl>
<p>Definition at line <a class="el" href="Bitmap_8cpp_source.html#l00575">575</a> of file <a class="el" href="Bitmap_8cpp_source.html">Bitmap.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a933763a4f3cba79fbcf97ae6d0a864aa"></a><!-- doxytag: member="Bitmap::drawCircle" ref="a933763a4f3cba79fbcf97ae6d0a864aa" args="(int centerX, int centerY, int radius, Color borderColor=White, Color fillColor=NoFill)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Bitmap::drawCircle </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>centerX</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>centerY</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>radius</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classBitmap.html#a88d386944a7017aa776a177b10d8b2ba">Color</a>&#160;</td>
<td class="paramname"><em>borderColor</em> = <code><a class="el" href="classBitmap.html#a39b6754cfe50a457bbfdb1980fd87eb7">White</a></code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classBitmap.html#a88d386944a7017aa776a177b10d8b2ba">Color</a>&#160;</td>
<td class="paramname"><em>fillColor</em> = <code><a class="el" href="classBitmap.html#aa89170263dc1f51f6366c1907119715e">NoFill</a></code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Draws a circle with a specific center (<em>centerX</em>, <em>centerY</em>) and <em>radius</em>, with the outline in <em>borderColor</em> and the interior filled with <em>fillColor</em>. </p>
<p>If <em>fillColor</em> is <a class="el" href="classBitmap.html#aa89170263dc1f51f6366c1907119715e">NoFill</a>, then the interior is not filled.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classBitmap.html#a757291b9a39bcb0d64ac98d3a2fa061b" title="Draws a filled circle with a specific center (centerX, centerY) and radius in color.">drawFilledCircle()</a>, <a class="el" href="classBitmap.html#aa0a84f3694e343d68e7021552c69f767" title="Draws a line from (x1, y1) to (x2, y2) in color.">drawLine()</a>, <a class="el" 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> </dd></dl>
<p>Definition at line <a class="el" href="Bitmap_8cpp_source.html#l00324">324</a> of file <a class="el" href="Bitmap_8cpp_source.html">Bitmap.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a757291b9a39bcb0d64ac98d3a2fa061b"></a><!-- doxytag: member="Bitmap::drawFilledCircle" ref="a757291b9a39bcb0d64ac98d3a2fa061b" args="(int centerX, int centerY, int radius, Color color=White)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Bitmap::drawFilledCircle </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>centerX</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>centerY</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>radius</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classBitmap.html#a88d386944a7017aa776a177b10d8b2ba">Color</a>&#160;</td>
<td class="paramname"><em>color</em> = <code><a class="el" href="classBitmap.html#a39b6754cfe50a457bbfdb1980fd87eb7">White</a></code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Draws a filled circle with a specific center (<em>centerX</em>, <em>centerY</em>) and <em>radius</em> in <em>color</em>. </p>
<p>This is a convenience function that is equivalent to drawCircle(<em>centerX</em>, <em>centerY</em>, <em>radius</em>, <em>color</em>, <em>color</em>).</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classBitmap.html#a933763a4f3cba79fbcf97ae6d0a864aa" title="Draws a circle with a specific center (centerX, centerY) and radius, with the outline in borderColor ...">drawCircle()</a>, <a class="el" href="classBitmap.html#a568acbca3818dd85dd62fff6d0b36ffb" title="Draws a filled rectangle from (x1, y1) to (x2, y2) in color.">drawFilledRect()</a> </dd></dl>
<p>Definition at line <a class="el" href="Bitmap_8h_source.html#l00118">118</a> of file <a class="el" href="Bitmap_8h_source.html">Bitmap.h</a>.</p>
</div>
</div>
<a class="anchor" id="a568acbca3818dd85dd62fff6d0b36ffb"></a><!-- doxytag: member="Bitmap::drawFilledRect" ref="a568acbca3818dd85dd62fff6d0b36ffb" args="(int x1, int y1, int x2, int y2, Color color=White)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Bitmap::drawFilledRect </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>x1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>y1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>x2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>y2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classBitmap.html#a88d386944a7017aa776a177b10d8b2ba">Color</a>&#160;</td>
<td class="paramname"><em>color</em> = <code><a class="el" href="classBitmap.html#a39b6754cfe50a457bbfdb1980fd87eb7">White</a></code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Draws a filled rectangle from (<em>x1</em>, <em>y1</em>) to (<em>x2</em>, <em>y2</em>) in <em>color</em>. </p>
<p>This is a convenience function that is equivalent to drawRect(<em>x1</em>, <em>y1</em>, <em>x2</em>, <em>y2</em>, <em>color</em>, <em>color</em>).</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" 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>, <a class="el" href="classBitmap.html#a757291b9a39bcb0d64ac98d3a2fa061b" title="Draws a filled circle with a specific center (centerX, centerY) and radius in color.">drawFilledCircle()</a> </dd></dl>
<p>Definition at line <a class="el" href="Bitmap_8h_source.html#l00113">113</a> of file <a class="el" href="Bitmap_8h_source.html">Bitmap.h</a>.</p>
</div>
</div>
<a class="anchor" id="a4321640464bc08b60348c09bff01b86a"></a><!-- doxytag: member="Bitmap::drawInvertedBitmap" ref="a4321640464bc08b60348c09bff01b86a" args="(int x, int y, const Bitmap &amp;bitmap)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Bitmap::drawInvertedBitmap </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classBitmap.html">Bitmap</a> &amp;&#160;</td>
<td class="paramname"><em>bitmap</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Draws <em>bitmap</em> at (<em>x</em>, <em>y</em>) in inverted colors. </p>
<p>This is a convenience function that is equivalent to drawBitmap(<em>x</em>, <em>y</em>, <em>bitmap</em>, <a class="el" href="classBitmap.html#a2c7faeeb89d3624b5bbca58871785adc">Black</a>).</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classBitmap.html#a491e9c0bb20ddf5a5eb4933077c8ed72" title="Draws bitmap at (x, y) in color.">drawBitmap()</a> </dd></dl>
<p>Definition at line <a class="el" href="Bitmap_8h_source.html#l00123">123</a> of file <a class="el" href="Bitmap_8h_source.html">Bitmap.h</a>.</p>
</div>
</div>
<a class="anchor" id="ae41aa6bfa8d508d216e25d80bb93747e"></a><!-- doxytag: member="Bitmap::drawInvertedBitmap" ref="ae41aa6bfa8d508d216e25d80bb93747e" args="(int x, int y, const prog_uint8_t *bitmap)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Bitmap::drawInvertedBitmap </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const prog_uint8_t *&#160;</td>
<td class="paramname"><em>bitmap</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Draws <em>bitmap</em> at (<em>x</em>, <em>y</em>) in inverted colors. </p>
<p>This is a convenience function that is equivalent to drawBitmap(<em>x</em>, <em>y</em>, <em>bitmap</em>, <a class="el" href="classBitmap.html#a2c7faeeb89d3624b5bbca58871785adc">Black</a>).</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classBitmap.html#a491e9c0bb20ddf5a5eb4933077c8ed72" title="Draws bitmap at (x, y) in color.">drawBitmap()</a> </dd></dl>
<p>Definition at line <a class="el" href="Bitmap_8h_source.html#l00128">128</a> of file <a class="el" href="Bitmap_8h_source.html">Bitmap.h</a>.</p>
</div>
</div>
<a class="anchor" id="aa0a84f3694e343d68e7021552c69f767"></a><!-- doxytag: member="Bitmap::drawLine" ref="aa0a84f3694e343d68e7021552c69f767" args="(int x1, int y1, int x2, int y2, Color color=White)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Bitmap::drawLine </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>x1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>y1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>x2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>y2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classBitmap.html#a88d386944a7017aa776a177b10d8b2ba">Color</a>&#160;</td>
<td class="paramname"><em>color</em> = <code><a class="el" href="classBitmap.html#a39b6754cfe50a457bbfdb1980fd87eb7">White</a></code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Draws a line from (<em>x1</em>, <em>y1</em>) to (<em>x2</em>, <em>y2</em>) in <em>color</em>. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" 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>, <a class="el" href="classBitmap.html#a933763a4f3cba79fbcf97ae6d0a864aa" title="Draws a circle with a specific center (centerX, centerY) and radius, with the outline in borderColor ...">drawCircle()</a> </dd></dl>
<p>Definition at line <a class="el" href="Bitmap_8cpp_source.html#l00215">215</a> of file <a class="el" href="Bitmap_8cpp_source.html">Bitmap.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="aac61e3f7f625db568e37d88b52b3b2fc"></a><!-- doxytag: member="Bitmap::drawRect" ref="aac61e3f7f625db568e37d88b52b3b2fc" args="(int x1, int y1, int x2, int y2, Color borderColor=White, Color fillColor=NoFill)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Bitmap::drawRect </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>x1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>y1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>x2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>y2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classBitmap.html#a88d386944a7017aa776a177b10d8b2ba">Color</a>&#160;</td>
<td class="paramname"><em>borderColor</em> = <code><a class="el" href="classBitmap.html#a39b6754cfe50a457bbfdb1980fd87eb7">White</a></code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classBitmap.html#a88d386944a7017aa776a177b10d8b2ba">Color</a>&#160;</td>
<td class="paramname"><em>fillColor</em> = <code><a class="el" href="classBitmap.html#aa89170263dc1f51f6366c1907119715e">NoFill</a></code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Draws a rectangle from (<em>x1</em>, <em>y1</em>) to (<em>x2</em>, <em>y2</em>), with the outline in <em>borderColor</em> and the interior filled with <em>fillColor</em>. </p>
<p>If <em>fillColor</em> is <a class="el" href="classBitmap.html#aa89170263dc1f51f6366c1907119715e">NoFill</a>, then the interior is not filled.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classBitmap.html#a568acbca3818dd85dd62fff6d0b36ffb" title="Draws a filled rectangle from (x1, y1) to (x2, y2) in color.">drawFilledRect()</a>, <a class="el" href="classBitmap.html#aa0a84f3694e343d68e7021552c69f767" title="Draws a line from (x1, y1) to (x2, y2) in color.">drawLine()</a>, <a class="el" href="classBitmap.html#a933763a4f3cba79fbcf97ae6d0a864aa" title="Draws a circle with a specific center (centerX, centerY) and radius, with the outline in borderColor ...">drawCircle()</a>, <a class="el" href="classBitmap.html#a99da820f9280aace6b512801d5a5e2b2" title="Fills the width x height pixels starting at top-left corner (x, y) with color.">fill()</a> </dd></dl>
<p>Definition at line <a class="el" href="Bitmap_8cpp_source.html#l00276">276</a> of file <a class="el" href="Bitmap_8cpp_source.html">Bitmap.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a3e9bcbfb584d5020bd6f0a313ee275f0"></a><!-- doxytag: member="Bitmap::drawText" ref="a3e9bcbfb584d5020bd6f0a313ee275f0" args="(int x, int y, const char *str, int len=&#45;1)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Bitmap::drawText </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>str</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>len</em> = <code>-1</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Draws the <em>len</em> characters of <em>str</em> at (<em>x</em>, <em>y</em>). </p>
<p>If <em>len</em> is less than zero, then the actual length of <em>str</em> will be used.</p>
<p>The position (<em>x</em>, <em>y</em>) will be the upper-left pixel of the first character that is drawn.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classBitmap.html#a1a11f29863ee7f36a3b15c91963102bd" title="Draws a single character ch at (x, y).">drawChar()</a>, <a class="el" href="classBitmap.html#ab6e5f5744fd2f18478aac428b751d848" title="Returns the color that will be used for drawing text with drawText() and drawChar(). The default is White.">textColor()</a>, <a class="el" href="classBitmap.html#ab6bd47cb892b47b4c69b422ace182b87" title="Returns the currently selected font, or null if none selected.">font()</a> </dd></dl>
<p>Definition at line <a class="el" href="Bitmap_8cpp_source.html#l00516">516</a> of file <a class="el" href="Bitmap_8cpp_source.html">Bitmap.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a802f5d6bd19a3727670e61e7a88a0cac"></a><!-- doxytag: member="Bitmap::drawText" ref="a802f5d6bd19a3727670e61e7a88a0cac" args="(int x, int y, const String &amp;str, int start=0, int len=&#45;1)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Bitmap::drawText </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const String &amp;&#160;</td>
<td class="paramname"><em>str</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>start</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>len</em> = <code>-1</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Draws <em>len</em> characters starting at <em>start</em> from <em>str</em> to the screen at (<em>x</em>, <em>y</em>). </p>
<p>If <em>len</em> is less than zero, then the actual length of <em>str</em> will be used.</p>
<p>The position (<em>x</em>, <em>y</em>) will be the upper-left pixel of the first character that is drawn.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classBitmap.html#a1a11f29863ee7f36a3b15c91963102bd" title="Draws a single character ch at (x, y).">drawChar()</a>, <a class="el" href="classBitmap.html#ab6e5f5744fd2f18478aac428b751d848" title="Returns the color that will be used for drawing text with drawText() and drawChar(). The default is White.">textColor()</a>, <a class="el" href="classBitmap.html#ab6bd47cb892b47b4c69b422ace182b87" title="Returns the currently selected font, or null if none selected.">font()</a> </dd></dl>
<p>Definition at line <a class="el" href="Bitmap_8cpp_source.html#l00545">545</a> of file <a class="el" href="Bitmap_8cpp_source.html">Bitmap.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a99da820f9280aace6b512801d5a5e2b2"></a><!-- doxytag: member="Bitmap::fill" ref="a99da820f9280aace6b512801d5a5e2b2" args="(int x, int y, int width, int height, Color color)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Bitmap::fill </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>width</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>height</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classBitmap.html#a88d386944a7017aa776a177b10d8b2ba">Color</a>&#160;</td>
<td class="paramname"><em>color</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Fills the <em>width</em> x <em>height</em> pixels starting at top-left corner (<em>x</em>, <em>y</em>) with <em>color</em>. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classBitmap.html#ab22fe1f3871934987a670b559f67c67c" title="Copies the width x height pixels starting at top-left corner (x, y) to (destX, destY) in the bitmap d...">copy()</a>, <a class="el" href="classBitmap.html#a839dc8fab05a5ebf7a6b2e61436b2fa1" title="Clears the entire bitmap to the specified color.">clear()</a>, <a class="el" href="classBitmap.html#a6d85556bcc9fac91d33f0f6f7a6430dd" title="Inverts the width x height pixels starting at top-left corner (x, y).">invert()</a>, <a class="el" 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> </dd></dl>
<p>Definition at line <a class="el" href="Bitmap_8cpp_source.html#l00752">752</a> of file <a class="el" href="Bitmap_8cpp_source.html">Bitmap.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="aadcad6c9e1f10f0ddbb789401132aa6f"></a><!-- doxytag: member="Bitmap::fill" ref="aadcad6c9e1f10f0ddbb789401132aa6f" args="(int x, int y, int width, int height, const prog_uint8_t *pattern, Color color=White)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Bitmap::fill </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>width</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>height</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const prog_uint8_t *&#160;</td>
<td class="paramname"><em>pattern</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classBitmap.html#a88d386944a7017aa776a177b10d8b2ba">Color</a>&#160;</td>
<td class="paramname"><em>color</em> = <code><a class="el" href="classBitmap.html#a39b6754cfe50a457bbfdb1980fd87eb7">White</a></code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Fills the <em>width</em> x <em>height</em> pixels starting at top-left corner (<em>x</em>, <em>y</em>) with the contents of <em>pattern</em>. </p>
<p>The <em>pattern</em> must point to program memory. The first two bytes are the width and height of the pattern in pixels. The rest of the data contains the pixels for the pattern, with lines byte-aligned.</p>
<p>Bits that are 1 in the <em>pattern</em> are drawn with <em>color</em>. Bits that are 0 in the <em>pattern</em> are drawn with the inverse of <em>color</em>.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classBitmap.html#a491e9c0bb20ddf5a5eb4933077c8ed72" title="Draws bitmap at (x, y) in color.">drawBitmap()</a>, <a class="el" href="classBitmap.html#a839dc8fab05a5ebf7a6b2e61436b2fa1" title="Clears the entire bitmap to the specified color.">clear()</a>, <a class="el" href="classBitmap.html#a6d85556bcc9fac91d33f0f6f7a6430dd" title="Inverts the width x height pixels starting at top-left corner (x, y).">invert()</a> </dd></dl>
<p>Definition at line <a class="el" href="Bitmap_8cpp_source.html#l00775">775</a> of file <a class="el" href="Bitmap_8cpp_source.html">Bitmap.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ab6bd47cb892b47b4c69b422ace182b87"></a><!-- doxytag: member="Bitmap::font" ref="ab6bd47cb892b47b4c69b422ace182b87" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const prog_uint8_t * Bitmap::font </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the currently selected font, or null if none selected. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classBitmap.html#abf7adfceb267080aa9806388e96358c4" title="Sets the font for use with drawText() and drawChar().">setFont()</a>, <a class="el" href="classBitmap.html#a3e9bcbfb584d5020bd6f0a313ee275f0" title="Draws the len characters of str at (x, y).">drawText()</a>, <a class="el" href="classBitmap.html#a1a11f29863ee7f36a3b15c91963102bd" title="Draws a single character ch at (x, y).">drawChar()</a>, <a class="el" href="classBitmap.html#a9b79ac13077ca865e4515510297780bd" title="Returns the width in pixels of ch in the current font().">charWidth()</a> </dd></dl>
<p>Definition at line <a class="el" href="Bitmap_8h_source.html#l00070">70</a> of file <a class="el" href="Bitmap_8h_source.html">Bitmap.h</a>.</p>
</div>
</div>
<a class="anchor" id="adcd4e3dc7594421e647b0f52da9a41a3"></a><!-- doxytag: member="Bitmap::height" ref="adcd4e3dc7594421e647b0f52da9a41a3" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int Bitmap::height </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the height of the bitmap in pixels. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classBitmap.html#a76c3b49e535761f07c553e7336daf523" title="Returns the width of the bitmap in pixels.">width()</a>, <a class="el" href="classBitmap.html#ad18d3d5a1e77d541a95e93ad1f958411" title="Returns the number of bits per pixel for the bitmap; always 1.">bitsPerPixel()</a> </dd></dl>
<p>Definition at line <a class="el" href="Bitmap_8h_source.html#l00047">47</a> of file <a class="el" href="Bitmap_8h_source.html">Bitmap.h</a>.</p>
</div>
</div>
<a class="anchor" id="a6d85556bcc9fac91d33f0f6f7a6430dd"></a><!-- doxytag: member="Bitmap::invert" ref="a6d85556bcc9fac91d33f0f6f7a6430dd" args="(int x, int y, int width, int height)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Bitmap::invert </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>width</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>height</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Inverts the <em>width</em> x <em>height</em> pixels starting at top-left corner (<em>x</em>, <em>y</em>). </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classBitmap.html#a99da820f9280aace6b512801d5a5e2b2" title="Fills the width x height pixels starting at top-left corner (x, y) with color.">fill()</a> </dd></dl>
<p>Definition at line <a class="el" href="Bitmap_8cpp_source.html#l00892">892</a> of file <a class="el" href="Bitmap_8cpp_source.html">Bitmap.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a3846a240722e847d3cf11f701da1ce7b"></a><!-- doxytag: member="Bitmap::isValid" ref="a3846a240722e847d3cf11f701da1ce7b" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Bitmap::isValid </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns true if the memory for this bitmap is valid; false otherwise. </p>
<p>This function can be called just after the constructor to determine if the memory for the bitmap was allocated successfully. </p>
<p>Definition at line <a class="el" href="Bitmap_8h_source.html#l00038">38</a> of file <a class="el" href="Bitmap_8h_source.html">Bitmap.h</a>.</p>
</div>
</div>
<a class="anchor" id="a35aa38b377d509d6c4f061a0b988d203"></a><!-- doxytag: member="Bitmap::pixel" ref="a35aa38b377d509d6c4f061a0b988d203" args="(int x, int y) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classBitmap.html#a88d386944a7017aa776a177b10d8b2ba">Bitmap::Color</a> Bitmap::pixel </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>y</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the color of the pixel at (<em>x</em>, <em>y</em>); either <a class="el" href="classBitmap.html#a2c7faeeb89d3624b5bbca58871785adc">Black</a> or <a class="el" href="classBitmap.html#a39b6754cfe50a457bbfdb1980fd87eb7">White</a>. </p>
<p>Returns <em>Black</em> if <em>x</em> or <em>y</em> is out of range.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classBitmap.html#aac994b75418e7d37ec66829437329114" title="Sets the pixel at (x, y) to color.">setPixel()</a>, <a class="el" href="classBitmap.html#a5eeed27c176eb6e4a2c39ea83444e27d" title="Returns a pointer to the start of the bitmap&#39;s data buffer.">data()</a> </dd></dl>
<p>Definition at line <a class="el" href="Bitmap_8cpp_source.html#l00181">181</a> of file <a class="el" href="Bitmap_8cpp_source.html">Bitmap.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ae08eb6f9086f9923d8dc83a469ae4c4a"></a><!-- doxytag: member="Bitmap::scroll" ref="ae08eb6f9086f9923d8dc83a469ae4c4a" args="(int dx, int dy, Color fillColor=Black)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Bitmap::scroll </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>dx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>dy</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classBitmap.html#a88d386944a7017aa776a177b10d8b2ba">Color</a>&#160;</td>
<td class="paramname"><em>fillColor</em> = <code><a class="el" href="classBitmap.html#a2c7faeeb89d3624b5bbca58871785adc">Black</a></code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Scrolls the entire contents of the bitmap by <em>dx</em> and <em>dy</em>. </p>
<p>If <em>dx</em> is 2 and <em>dy</em> is -1, then the region will be scrolled two pixels to the right and one pixel up. Pixels that are uncovered by the scroll are filled with <em>fillColor</em>.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classBitmap.html#ab22fe1f3871934987a670b559f67c67c" title="Copies the width x height pixels starting at top-left corner (x, y) to (destX, destY) in the bitmap d...">copy()</a>, <a class="el" href="classBitmap.html#a99da820f9280aace6b512801d5a5e2b2" title="Fills the width x height pixels starting at top-left corner (x, y) with color.">fill()</a> </dd></dl>
<p>Definition at line <a class="el" href="Bitmap_8h_source.html#l00133">133</a> of file <a class="el" href="Bitmap_8h_source.html">Bitmap.h</a>.</p>
</div>
</div>
<a class="anchor" id="af79ad4432297ff453fddc55625fec485"></a><!-- doxytag: member="Bitmap::scroll" ref="af79ad4432297ff453fddc55625fec485" args="(int x, int y, int width, int height, int dx, int dy, Color fillColor=Black)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Bitmap::scroll </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>width</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>height</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>dx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>dy</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classBitmap.html#a88d386944a7017aa776a177b10d8b2ba">Color</a>&#160;</td>
<td class="paramname"><em>fillColor</em> = <code><a class="el" href="classBitmap.html#a2c7faeeb89d3624b5bbca58871785adc">Black</a></code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Scrolls the <em>width</em> x <em>height</em> pixels starting at top-left corner (<em>x</em>, <em>y</em>) by <em>dx</em> and <em>dy</em>. </p>
<p>If <em>dx</em> is 2 and <em>dy</em> is -1, then the region will be scrolled two pixels to the right and one pixel up. Pixels that are uncovered by the scroll are filled with <em>fillColor</em>.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classBitmap.html#ab22fe1f3871934987a670b559f67c67c" title="Copies the width x height pixels starting at top-left corner (x, y) to (destX, destY) in the bitmap d...">copy()</a>, <a class="el" href="classBitmap.html#a99da820f9280aace6b512801d5a5e2b2" title="Fills the width x height pixels starting at top-left corner (x, y) with color.">fill()</a> </dd></dl>
<p>Definition at line <a class="el" href="Bitmap_8cpp_source.html#l00831">831</a> of file <a class="el" href="Bitmap_8cpp_source.html">Bitmap.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="abf7adfceb267080aa9806388e96358c4"></a><!-- doxytag: member="Bitmap::setFont" ref="abf7adfceb267080aa9806388e96358c4" args="(const prog_uint8_t *font)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Bitmap::setFont </td>
<td>(</td>
<td class="paramtype">const prog_uint8_t *&#160;</td>
<td class="paramname"><em>font</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the <em>font</em> for use with <a class="el" href="classBitmap.html#a3e9bcbfb584d5020bd6f0a313ee275f0" title="Draws the len characters of str at (x, y).">drawText()</a> and <a class="el" href="classBitmap.html#a1a11f29863ee7f36a3b15c91963102bd" title="Draws a single character ch at (x, y).">drawChar()</a>. </p>
<div class="fragment"><pre class="fragment"><span class="preprocessor"> #include &lt;DejaVuSans9.h&gt;</span>
display.<a class="code" href="classBitmap.html#abf7adfceb267080aa9806388e96358c4" title="Sets the font for use with drawText() and drawChar().">setFont</a>(DejaVuSans9);
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>);
</pre></div><p>New fonts can be generated with <a href="https://code.google.com/p/glcd-arduino/downloads/detail?name=GLCDFontCreator2.zip&amp;can=2&amp;q=">GLCDFontCreator2</a>.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classBitmap.html#ab6bd47cb892b47b4c69b422ace182b87" title="Returns the currently selected font, or null if none selected.">font()</a>, <a class="el" href="classBitmap.html#a3e9bcbfb584d5020bd6f0a313ee275f0" title="Draws the len characters of str at (x, y).">drawText()</a>, <a class="el" href="classBitmap.html#a1a11f29863ee7f36a3b15c91963102bd" title="Draws a single character ch at (x, y).">drawChar()</a> </dd></dl>
<p>Definition at line <a class="el" href="Bitmap_8h_source.html#l00071">71</a> of file <a class="el" href="Bitmap_8h_source.html">Bitmap.h</a>.</p>
</div>
</div>
<a class="anchor" id="aac994b75418e7d37ec66829437329114"></a><!-- doxytag: member="Bitmap::setPixel" ref="aac994b75418e7d37ec66829437329114" args="(int x, int y, Color color)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Bitmap::setPixel </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classBitmap.html#a88d386944a7017aa776a177b10d8b2ba">Color</a>&#160;</td>
<td class="paramname"><em>color</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the pixel at (<em>x</em>, <em>y</em>) to <em>color</em>. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classBitmap.html#a35aa38b377d509d6c4f061a0b988d203" title="Returns the color of the pixel at (x, y); either Black or White.">pixel()</a> </dd></dl>
<p>Definition at line <a class="el" href="Bitmap_8cpp_source.html#l00198">198</a> of file <a class="el" href="Bitmap_8cpp_source.html">Bitmap.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a8e225a4f188269bb18265ae4b49de0a3"></a><!-- doxytag: member="Bitmap::setTextColor" ref="a8e225a4f188269bb18265ae4b49de0a3" args="(Color color)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Bitmap::setTextColor </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classBitmap.html#a88d386944a7017aa776a177b10d8b2ba">Color</a>&#160;</td>
<td class="paramname"><em>textColor</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the <em>color</em> that will be used for drawing text with <a class="el" href="classBitmap.html#a3e9bcbfb584d5020bd6f0a313ee275f0" title="Draws the len characters of str at (x, y).">drawText()</a> and <a class="el" href="classBitmap.html#a1a11f29863ee7f36a3b15c91963102bd" title="Draws a single character ch at (x, y).">drawChar()</a>. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classBitmap.html#ab6e5f5744fd2f18478aac428b751d848" title="Returns the color that will be used for drawing text with drawText() and drawChar(). The default is White.">textColor()</a>, <a class="el" href="classBitmap.html#a3e9bcbfb584d5020bd6f0a313ee275f0" title="Draws the len characters of str at (x, y).">drawText()</a>, <a class="el" href="classBitmap.html#a1a11f29863ee7f36a3b15c91963102bd" title="Draws a single character ch at (x, y).">drawChar()</a> </dd></dl>
<p>Definition at line <a class="el" href="Bitmap_8h_source.html#l00074">74</a> of file <a class="el" href="Bitmap_8h_source.html">Bitmap.h</a>.</p>
</div>
</div>
<a class="anchor" id="af30df263729385ea2330effe3c80a1bc"></a><!-- doxytag: member="Bitmap::stride" ref="af30df263729385ea2330effe3c80a1bc" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int Bitmap::stride </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the number of bytes in each line of the bitmap's <a class="el" href="classBitmap.html#a5eeed27c176eb6e4a2c39ea83444e27d" title="Returns a pointer to the start of the bitmap&#39;s data buffer.">data()</a> buffer. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classBitmap.html#a76c3b49e535761f07c553e7336daf523" title="Returns the width of the bitmap in pixels.">width()</a>, <a class="el" href="classBitmap.html#ad18d3d5a1e77d541a95e93ad1f958411" title="Returns the number of bits per pixel for the bitmap; always 1.">bitsPerPixel()</a>, <a class="el" href="classBitmap.html#a5eeed27c176eb6e4a2c39ea83444e27d" title="Returns a pointer to the start of the bitmap&#39;s data buffer.">data()</a> </dd></dl>
<p>Definition at line <a class="el" href="Bitmap_8h_source.html#l00048">48</a> of file <a class="el" href="Bitmap_8h_source.html">Bitmap.h</a>.</p>
</div>
</div>
<a class="anchor" id="ab6e5f5744fd2f18478aac428b751d848"></a><!-- doxytag: member="Bitmap::textColor" ref="ab6e5f5744fd2f18478aac428b751d848" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classBitmap.html#a88d386944a7017aa776a177b10d8b2ba">Color</a> Bitmap::textColor </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the color that will be used for drawing text with <a class="el" href="classBitmap.html#a3e9bcbfb584d5020bd6f0a313ee275f0" title="Draws the len characters of str at (x, y).">drawText()</a> and <a class="el" href="classBitmap.html#a1a11f29863ee7f36a3b15c91963102bd" title="Draws a single character ch at (x, y).">drawChar()</a>. The default is <a class="el" href="classBitmap.html#a39b6754cfe50a457bbfdb1980fd87eb7">White</a>. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classBitmap.html#a8e225a4f188269bb18265ae4b49de0a3" title="Sets the color that will be used for drawing text with drawText() and drawChar().">setTextColor()</a>, <a class="el" href="classBitmap.html#a3e9bcbfb584d5020bd6f0a313ee275f0" title="Draws the len characters of str at (x, y).">drawText()</a>, <a class="el" href="classBitmap.html#a1a11f29863ee7f36a3b15c91963102bd" title="Draws a single character ch at (x, y).">drawChar()</a> </dd></dl>
<p>Definition at line <a class="el" href="Bitmap_8h_source.html#l00073">73</a> of file <a class="el" href="Bitmap_8h_source.html">Bitmap.h</a>.</p>
</div>
</div>
<a class="anchor" id="a628bb694fcfe6eab619a4f1e152d41c4"></a><!-- doxytag: member="Bitmap::textHeight" ref="a628bb694fcfe6eab619a4f1e152d41c4" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int Bitmap::textHeight </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the height in pixels of the current text drawing <a class="el" href="classBitmap.html#ab6bd47cb892b47b4c69b422ace182b87" title="Returns the currently selected font, or null if none selected.">font()</a>; or zero if <a class="el" href="classBitmap.html#ab6bd47cb892b47b4c69b422ace182b87" title="Returns the currently selected font, or null if none selected.">font()</a> is not set. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classBitmap.html#ab6bd47cb892b47b4c69b422ace182b87" title="Returns the currently selected font, or null if none selected.">font()</a>, <a class="el" href="classBitmap.html#a9b79ac13077ca865e4515510297780bd" title="Returns the width in pixels of ch in the current font().">charWidth()</a>, <a class="el" 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> </dd></dl>
<p>Definition at line <a class="el" href="Bitmap_8cpp_source.html#l00706">706</a> of file <a class="el" href="Bitmap_8cpp_source.html">Bitmap.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a0f7607b1c7867987f4500d490a666e8a"></a><!-- doxytag: member="Bitmap::textWidth" ref="a0f7607b1c7867987f4500d490a666e8a" args="(const char *str, int len=&#45;1) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int Bitmap::textWidth </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>str</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>len</em> = <code>-1</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the width in pixels of the <em>len</em> characters of <em>str</em> in the current <a class="el" href="classBitmap.html#ab6bd47cb892b47b4c69b422ace182b87" title="Returns the currently selected font, or null if none selected.">font()</a>, including inter-character spacing. </p>
<p>If <em>len</em> is less than zero, then the actual length of <em>str</em> will be used.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classBitmap.html#a3e9bcbfb584d5020bd6f0a313ee275f0" title="Draws the len characters of str at (x, y).">drawText()</a>, <a class="el" href="classBitmap.html#a9b79ac13077ca865e4515510297780bd" title="Returns the width in pixels of ch in the current font().">charWidth()</a>, <a class="el" href="classBitmap.html#a628bb694fcfe6eab619a4f1e152d41c4" title="Returns the height in pixels of the current text drawing font(); or zero if font() is not set...">textHeight()</a> </dd></dl>
<p>Definition at line <a class="el" href="Bitmap_8cpp_source.html#l00665">665</a> of file <a class="el" href="Bitmap_8cpp_source.html">Bitmap.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a8ca70aa0f8f722a228358bffe794e925"></a><!-- doxytag: member="Bitmap::textWidth" ref="a8ca70aa0f8f722a228358bffe794e925" args="(const String &amp;str, int start=0, int len=&#45;1) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int Bitmap::textWidth </td>
<td>(</td>
<td class="paramtype">const String &amp;&#160;</td>
<td class="paramname"><em>str</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>start</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>len</em> = <code>-1</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the width in pixels of the <em>len</em> characters of <em>str</em> in the current <a class="el" href="classBitmap.html#ab6bd47cb892b47b4c69b422ace182b87" title="Returns the currently selected font, or null if none selected.">font()</a>, starting at <em>start</em>, including inter-character spacing. </p>
<p>If <em>len</em> is less than zero, then the actual length of <em>str</em> will be used.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classBitmap.html#a3e9bcbfb584d5020bd6f0a313ee275f0" title="Draws the len characters of str at (x, y).">drawText()</a>, <a class="el" href="classBitmap.html#a9b79ac13077ca865e4515510297780bd" title="Returns the width in pixels of ch in the current font().">charWidth()</a>, <a class="el" href="classBitmap.html#a628bb694fcfe6eab619a4f1e152d41c4" title="Returns the height in pixels of the current text drawing font(); or zero if font() is not set...">textHeight()</a> </dd></dl>
<p>Definition at line <a class="el" href="Bitmap_8cpp_source.html#l00687">687</a> of file <a class="el" href="Bitmap_8cpp_source.html">Bitmap.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a76c3b49e535761f07c553e7336daf523"></a><!-- doxytag: member="Bitmap::width" ref="a76c3b49e535761f07c553e7336daf523" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int Bitmap::width </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the width of the bitmap in pixels. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classBitmap.html#adcd4e3dc7594421e647b0f52da9a41a3" title="Returns the height of the bitmap in pixels.">height()</a>, <a class="el" href="classBitmap.html#af30df263729385ea2330effe3c80a1bc" title="Returns the number of bytes in each line of the bitmap&#39;s data() buffer.">stride()</a>, <a class="el" href="classBitmap.html#ad18d3d5a1e77d541a95e93ad1f958411" title="Returns the number of bits per pixel for the bitmap; always 1.">bitsPerPixel()</a> </dd></dl>
<p>Definition at line <a class="el" href="Bitmap_8h_source.html#l00046">46</a> of file <a class="el" href="Bitmap_8h_source.html">Bitmap.h</a>.</p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a39b6754cfe50a457bbfdb1980fd87eb7"></a><!-- doxytag: member="Bitmap::White" ref="a39b6754cfe50a457bbfdb1980fd87eb7" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classBitmap.html#a39b6754cfe50a457bbfdb1980fd87eb7">Bitmap::White</a> = 1<code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Color value corresponding to "white". If the bitmap is displayed on a LED array, then it may have a different physical color. </p>
<p>Note: while the value of this constant is 1, the bitmap itself stores white pixels as 0 and black as 1 because the <a class="el" href="classDMD.html" title="Handle large dot matrix displays composed of LED&#39;s.">DMD</a> display uses 1 to indicate a pixel being off. </p>
<p>Definition at line <a class="el" href="Bitmap_8h_source.html#l00043">43</a> of file <a class="el" href="Bitmap_8h_source.html">Bitmap.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="Bitmap_8h_source.html">Bitmap.h</a></li>
<li><a class="el" href="Bitmap_8cpp_source.html">Bitmap.cpp</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)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a></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>
<hr class="footer"/><address class="footer"><small>Generated on Sun Jun 10 2012 10:51:57 for ArduinoLibs by&#160;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</body>
</html>