dirk
/
Wemos8266RelaysLedDisplay
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
Wemos8266RelaysLedDisplay/lib/MD_Parola/docs/_m_d___parola_8h.html

384 lines
32 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Parola for Arduino: src/MD_Parola.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(initResizable);
/* @license-end */</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="MajicDesigns_Logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Parola for Arduino
&#160;<span id="projectnumber">3.0</span>
</div>
<div id="projectbrief">Text effects for LED Matrix modular hardware</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('_m_d___parola_8h.html','');});
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#enum-members">Enumerations</a> </div>
<div class="headertitle">
<div class="title">MD_Parola.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Main header file for the <a class="el" href="class_m_d___parola.html">MD_Parola</a> library.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;Arduino.h&gt;</code><br />
<code>#include &lt;MD_MAX72xx.h&gt;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for MD_Parola.h:</div>
<div class="dyncontent">
<div class="center"><img src="_m_d___parola_8h__incl.png" border="0" usemap="#src_2_m_d___parola_8h" alt=""/></div>
</div>
</div><div class="textblock"><div class="dynheader">
This graph shows which files directly or indirectly include this file:</div>
<div class="dyncontent">
<div class="center"><img src="_m_d___parola_8h__dep__incl.png" border="0" usemap="#src_2_m_d___parola_8hdep" alt=""/></div>
<map name="src_2_m_d___parola_8hdep" id="src_2_m_d___parola_8hdep">
<area shape="rect" id="node3" href="_m_d___parola_8cpp.html" title="Implements core MD_Parola class methods. " alt="" coords="5,80,139,107"/>
<area shape="rect" id="node5" href="_m_d___parola___blinds_8cpp.html" title="Implements blinds effect. " alt="" coords="163,80,339,107"/>
<area shape="rect" id="node7" href="_m_d___parola___close_8cpp.html" title="Implements closing effect. " alt="" coords="363,80,536,107"/>
<area shape="rect" id="node9" href="_m_d___parola___diag_8cpp.html" title="Implements diagonal scroll effect. " alt="" coords="561,80,727,107"/>
<area shape="rect" id="node11" href="_m_d___parola___dissolve_8cpp.html" title="Implements dissolve effect. " alt="" coords="751,80,939,107"/>
<area shape="rect" id="node13" href="_m_d___parola___fade_8cpp.html" title="Implements FADE effect. " alt="" coords="963,80,1132,107"/>
<area shape="rect" id="node15" href="_m_d___parola___grow_8cpp.html" title="Implements grow effects. " alt="" coords="1157,80,1328,107"/>
<area shape="rect" id="node17" href="_m_d___parola___h_scroll_8cpp.html" title="Implements horizontal scrolling effect. " alt="" coords="1353,80,1535,107"/>
<area shape="rect" id="node19" href="_m_d___parola___mesh_8cpp.html" title="Implements mesh effect. " alt="" coords="1559,80,1731,107"/>
<area shape="rect" id="node21" href="_m_d___parola___open_8cpp.html" title="Implements opening effect. " alt="" coords="1756,80,1927,107"/>
<area shape="rect" id="node23" href="_m_d___parola___print_8cpp.html" title="Implements static print effect. " alt="" coords="1951,80,2117,107"/>
<area shape="rect" id="node25" href="_m_d___parola___random_8cpp.html" title="Implements random effect. " alt="" coords="2142,80,2329,107"/>
<area shape="rect" id="node27" href="_m_d___parola___scan_8cpp.html" title="Implements scan effect. " alt="" coords="2355,80,2525,107"/>
<area shape="rect" id="node29" href="_m_d___parola___slice_8cpp.html" title="Implements slice effect. " alt="" coords="2550,80,2719,107"/>
<area shape="rect" id="node31" href="_m_d___parola___sprite_8cpp.html" title="Implements various sprite effects. " alt="" coords="2743,80,2917,107"/>
<area shape="rect" id="node33" href="_m_d___parola___v_scroll_8cpp.html" title="Implements vertical scroll effect. " alt="" coords="2942,80,3124,107"/>
<area shape="rect" id="node35" href="_m_d___parola___wipe_8cpp.html" title="Implements wipe effect. " alt="" coords="3149,80,3320,107"/>
<area shape="rect" id="node37" href="_m_d___p_zone_8cpp.html" title="Implements MD_PZone class methods. " alt="" coords="3344,80,3477,107"/>
</map>
</div>
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_d___p_zone.html">MD_PZone</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_d___parola.html">MD_Parola</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a64d0ca22d6919196de0c6f60a1fb3365"><td class="memItemLeft" align="right" valign="top"><a id="a64d0ca22d6919196de0c6f60a1fb3365"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_m_d___parola_8h.html#a64d0ca22d6919196de0c6f60a1fb3365">ENA_MISC</a>&#160;&#160;&#160;1</td></tr>
<tr class="memdesc:a64d0ca22d6919196de0c6f60a1fb3365"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enable miscellaneous animations. <br /></td></tr>
<tr class="separator:a64d0ca22d6919196de0c6f60a1fb3365"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1d721485b7473612e95d43c282ffee13"><td class="memItemLeft" align="right" valign="top"><a id="a1d721485b7473612e95d43c282ffee13"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_m_d___parola_8h.html#a1d721485b7473612e95d43c282ffee13">ENA_WIPE</a>&#160;&#160;&#160;1</td></tr>
<tr class="memdesc:a1d721485b7473612e95d43c282ffee13"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enable wipe type animations. <br /></td></tr>
<tr class="separator:a1d721485b7473612e95d43c282ffee13"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a331cda3fcb98cd028c9324fb0900389f"><td class="memItemLeft" align="right" valign="top"><a id="a331cda3fcb98cd028c9324fb0900389f"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_m_d___parola_8h.html#a331cda3fcb98cd028c9324fb0900389f">ENA_SCAN</a>&#160;&#160;&#160;1</td></tr>
<tr class="memdesc:a331cda3fcb98cd028c9324fb0900389f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enable scanning animations. <br /></td></tr>
<tr class="separator:a331cda3fcb98cd028c9324fb0900389f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8524e42d3a55958631b48350a5285fb3"><td class="memItemLeft" align="right" valign="top"><a id="a8524e42d3a55958631b48350a5285fb3"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_m_d___parola_8h.html#a8524e42d3a55958631b48350a5285fb3">ENA_SCR_DIA</a>&#160;&#160;&#160;1</td></tr>
<tr class="memdesc:a8524e42d3a55958631b48350a5285fb3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enable diagonal scrolling animation. <br /></td></tr>
<tr class="separator:a8524e42d3a55958631b48350a5285fb3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a08ff33871af40a26c1a131f532b2f8c2"><td class="memItemLeft" align="right" valign="top"><a id="a08ff33871af40a26c1a131f532b2f8c2"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_m_d___parola_8h.html#a08ff33871af40a26c1a131f532b2f8c2">ENA_OPNCLS</a>&#160;&#160;&#160;1</td></tr>
<tr class="memdesc:a08ff33871af40a26c1a131f532b2f8c2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enable open and close scan effects. <br /></td></tr>
<tr class="separator:a08ff33871af40a26c1a131f532b2f8c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1fa46a28ec391f265379a65154570e2e"><td class="memItemLeft" align="right" valign="top"><a id="a1fa46a28ec391f265379a65154570e2e"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_m_d___parola_8h.html#a1fa46a28ec391f265379a65154570e2e">ENA_GROW</a>&#160;&#160;&#160;1</td></tr>
<tr class="memdesc:a1fa46a28ec391f265379a65154570e2e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enable grow effects. <br /></td></tr>
<tr class="separator:a1fa46a28ec391f265379a65154570e2e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae702d25425ab4c647a93b0f8df8aaab1"><td class="memItemLeft" align="right" valign="top"><a id="ae702d25425ab4c647a93b0f8df8aaab1"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_m_d___parola_8h.html#ae702d25425ab4c647a93b0f8df8aaab1">ENA_SPRITE</a>&#160;&#160;&#160;1</td></tr>
<tr class="memdesc:ae702d25425ab4c647a93b0f8df8aaab1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enable sprite effects. <br /></td></tr>
<tr class="separator:ae702d25425ab4c647a93b0f8df8aaab1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a30c6640ce269fb349beac0df6b428f37"><td class="memItemLeft" align="right" valign="top"><a id="a30c6640ce269fb349beac0df6b428f37"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_m_d___parola_8h.html#a30c6640ce269fb349beac0df6b428f37">ENA_GRAPHICS</a>&#160;&#160;&#160;1</td></tr>
<tr class="memdesc:a30c6640ce269fb349beac0df6b428f37"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enable graphics functionality. <br /></td></tr>
<tr class="separator:a30c6640ce269fb349beac0df6b428f37"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6242a25f9d996f0cc4f4cdb911218b75"><td class="memItemLeft" align="right" valign="top"><a id="a6242a25f9d996f0cc4f4cdb911218b75"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_m_d___parola_8h.html#a6242a25f9d996f0cc4f4cdb911218b75">ARRAY_SIZE</a>(x)&#160;&#160;&#160;(sizeof(x)/sizeof(x[0]))</td></tr>
<tr class="memdesc:a6242a25f9d996f0cc4f4cdb911218b75"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generic macro for obtaining number of elements of an array. <br /></td></tr>
<tr class="separator:a6242a25f9d996f0cc4f4cdb911218b75"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3c8ce1beff274980c5636aa8a3811cdc"><td class="memItemLeft" align="right" valign="top"><a id="a3c8ce1beff274980c5636aa8a3811cdc"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_m_d___parola_8h.html#a3c8ce1beff274980c5636aa8a3811cdc">MAX_ZONES</a>&#160;&#160;&#160;4</td></tr>
<tr class="memdesc:a3c8ce1beff274980c5636aa8a3811cdc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Maximum number of zones allowed. Change to allow more or less zones but uses RAM even if not used. <br /></td></tr>
<tr class="separator:a3c8ce1beff274980c5636aa8a3811cdc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a96eea7631a186d5b36365c90ed697d16"><td class="memItemLeft" align="right" valign="top"><a id="a96eea7631a186d5b36365c90ed697d16"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_m_d___parola_8h.html#a96eea7631a186d5b36365c90ed697d16">ZONE_START_COL</a>(m)&#160;&#160;&#160;(m*COL_SIZE)</td></tr>
<tr class="memdesc:a96eea7631a186d5b36365c90ed697d16"><td class="mdescLeft">&#160;</td><td class="mdescRight">The first column of the first zone module. <br /></td></tr>
<tr class="separator:a96eea7631a186d5b36365c90ed697d16"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1470b74a1b8edbbe0427304c909eb116"><td class="memItemLeft" align="right" valign="top"><a id="a1470b74a1b8edbbe0427304c909eb116"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_m_d___parola_8h.html#a1470b74a1b8edbbe0427304c909eb116">ZONE_END_COL</a>(m)&#160;&#160;&#160;(((m+1)*COL_SIZE)-1)</td></tr>
<tr class="memdesc:a1470b74a1b8edbbe0427304c909eb116"><td class="mdescLeft">&#160;</td><td class="mdescRight">The last column of the last zone module. <br /></td></tr>
<tr class="separator:a1470b74a1b8edbbe0427304c909eb116"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:abab52de9e46b83d0aa94f0e3439e224d"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_m_d___parola_8h.html#abab52de9e46b83d0aa94f0e3439e224d">textPosition_t</a> { <a class="el" href="_m_d___parola_8h.html#abab52de9e46b83d0aa94f0e3439e224da9a3405b11cd2d02b7bede55b8bcf4372">PA_LEFT</a>,
<a class="el" href="_m_d___parola_8h.html#abab52de9e46b83d0aa94f0e3439e224dac82282c0c93b36650cbc112cc786ba1f">PA_CENTER</a>,
<a class="el" href="_m_d___parola_8h.html#abab52de9e46b83d0aa94f0e3439e224da735ddff6e6acfbd3035a817d96c6f471">PA_RIGHT</a>
}</td></tr>
<tr class="separator:abab52de9e46b83d0aa94f0e3439e224d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acf3b849a996dbbe48ca173d2b0b82eda"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_m_d___parola_8h.html#acf3b849a996dbbe48ca173d2b0b82eda">textEffect_t</a> { <br />
&#160;&#160;<a class="el" href="_m_d___parola_8h.html#acf3b849a996dbbe48ca173d2b0b82edaa65db4b21517eaca3a0011552dda00a86">PA_NO_EFFECT</a>,
<a class="el" href="_m_d___parola_8h.html#acf3b849a996dbbe48ca173d2b0b82edaa5a65e70e91a3a123cc678178a780667d">PA_PRINT</a>,
<a class="el" href="_m_d___parola_8h.html#acf3b849a996dbbe48ca173d2b0b82edaa7455ebe66471e6159811bbe0a2110d38">PA_SCROLL_UP</a>,
<a class="el" href="_m_d___parola_8h.html#acf3b849a996dbbe48ca173d2b0b82edaa99d43e17954efdfab65adbb9ec4478a8">PA_SCROLL_DOWN</a>,
<br />
&#160;&#160;<a class="el" href="_m_d___parola_8h.html#acf3b849a996dbbe48ca173d2b0b82edaa80ce296b12960be2f9a0cffb51ef0d7c">PA_SCROLL_LEFT</a>,
<a class="el" href="_m_d___parola_8h.html#acf3b849a996dbbe48ca173d2b0b82edaaca390db312bfa67fbd90bb65428a6c78">PA_SCROLL_RIGHT</a>,
<a class="el" href="_m_d___parola_8h.html#acf3b849a996dbbe48ca173d2b0b82edaa4f395cf278c4d934ac8d2b662675f669">PA_SPRITE</a>,
<a class="el" href="_m_d___parola_8h.html#acf3b849a996dbbe48ca173d2b0b82edaa08e32ea749f514046ba58f8da3cdfd72">PA_SLICE</a>,
<br />
&#160;&#160;<a class="el" href="_m_d___parola_8h.html#acf3b849a996dbbe48ca173d2b0b82edaa709894e18b54d3465d3136f73a708b0d">PA_MESH</a>,
<a class="el" href="_m_d___parola_8h.html#acf3b849a996dbbe48ca173d2b0b82edaae5e485df24f7a4e3120aa2876806d958">PA_FADE</a>,
<a class="el" href="_m_d___parola_8h.html#acf3b849a996dbbe48ca173d2b0b82edaa2da3a4230287c733a19102a73341e94f">PA_DISSOLVE</a>,
<a class="el" href="_m_d___parola_8h.html#acf3b849a996dbbe48ca173d2b0b82edaab81ef7a0c3fe92b98386bd2decda8534">PA_BLINDS</a>,
<br />
&#160;&#160;<a class="el" href="_m_d___parola_8h.html#acf3b849a996dbbe48ca173d2b0b82edaa98aec2f1905ed10ec1f3751cb7101dca">PA_RANDOM</a>,
<a class="el" href="_m_d___parola_8h.html#acf3b849a996dbbe48ca173d2b0b82edaae7744273c94ba436a27b4359e2e6089e">PA_WIPE</a>,
<a class="el" href="_m_d___parola_8h.html#acf3b849a996dbbe48ca173d2b0b82edaa0fd7f078a92b7c8ba1932d9d4ad2544d">PA_WIPE_CURSOR</a>,
<a class="el" href="_m_d___parola_8h.html#acf3b849a996dbbe48ca173d2b0b82edaadf43a4fcab04c2a431e8bab32846604e">PA_SCAN_HORIZ</a>,
<br />
&#160;&#160;<a class="el" href="_m_d___parola_8h.html#acf3b849a996dbbe48ca173d2b0b82edaabd9180021766e98a2ad60cc300966dae">PA_SCAN_HORIZX</a>,
<a class="el" href="_m_d___parola_8h.html#acf3b849a996dbbe48ca173d2b0b82edaaf6713d23a47d9f32cd66f66fe83d8a83">PA_SCAN_VERT</a>,
<a class="el" href="_m_d___parola_8h.html#acf3b849a996dbbe48ca173d2b0b82edaaab3547aef11cf5b5fec653b193c4fcfd">PA_SCAN_VERTX</a>,
<a class="el" href="_m_d___parola_8h.html#acf3b849a996dbbe48ca173d2b0b82edaa3bba17d858630b5dbd1d3842096d0c92">PA_OPENING</a>,
<br />
&#160;&#160;<a class="el" href="_m_d___parola_8h.html#acf3b849a996dbbe48ca173d2b0b82edaa781b03148fc439ca816cb0bf4e47ef45">PA_OPENING_CURSOR</a>,
<a class="el" href="_m_d___parola_8h.html#acf3b849a996dbbe48ca173d2b0b82edaaa310b2fc9164c2c2afc461f9725d168a">PA_CLOSING</a>,
<a class="el" href="_m_d___parola_8h.html#acf3b849a996dbbe48ca173d2b0b82edaae286d4dae4a95ce030296f6444accf7c">PA_CLOSING_CURSOR</a>,
<a class="el" href="_m_d___parola_8h.html#acf3b849a996dbbe48ca173d2b0b82edaa612412629877864ba4842755d73f53f3">PA_SCROLL_UP_LEFT</a>,
<br />
&#160;&#160;<a class="el" href="_m_d___parola_8h.html#acf3b849a996dbbe48ca173d2b0b82edaaea3a88a7345feeec48a2318e51dfd789">PA_SCROLL_UP_RIGHT</a>,
<a class="el" href="_m_d___parola_8h.html#acf3b849a996dbbe48ca173d2b0b82edaa458ea3e72f6db4ecfdff8a31716751fe">PA_SCROLL_DOWN_LEFT</a>,
<a class="el" href="_m_d___parola_8h.html#acf3b849a996dbbe48ca173d2b0b82edaa9d4b6eaa770ca96372b299acf8a203ab">PA_SCROLL_DOWN_RIGHT</a>,
<a class="el" href="_m_d___parola_8h.html#acf3b849a996dbbe48ca173d2b0b82edaa86a5ff70349dd4ffcbc074fdad35305f">PA_GROW_UP</a>,
<br />
&#160;&#160;<a class="el" href="_m_d___parola_8h.html#acf3b849a996dbbe48ca173d2b0b82edaac36e08217d8be0c00e050aa308ef9ae7">PA_GROW_DOWN</a>
<br />
}</td></tr>
<tr class="separator:acf3b849a996dbbe48ca173d2b0b82eda"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8b150a33856e93a2596b6622117f08f5"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_m_d___parola_8h.html#a8b150a33856e93a2596b6622117f08f5">zoneEffect_t</a> { <a class="el" href="_m_d___parola_8h.html#a8b150a33856e93a2596b6622117f08f5af4cfb7e758daa237304a954d4f8750b8">PA_FLIP_UD</a>,
<a class="el" href="_m_d___parola_8h.html#a8b150a33856e93a2596b6622117f08f5aba2b6cdea083af8165ef30b3adab3f09">PA_FLIP_LR</a>
}</td></tr>
<tr class="separator:a8b150a33856e93a2596b6622117f08f5"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Main header file for the <a class="el" href="class_m_d___parola.html">MD_Parola</a> library. </p>
</div><h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="acf3b849a996dbbe48ca173d2b0b82eda"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acf3b849a996dbbe48ca173d2b0b82eda">&#9670;&nbsp;</a></span>textEffect_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="_m_d___parola_8h.html#acf3b849a996dbbe48ca173d2b0b82eda">textEffect_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Text effects enumerated type specification.</p>
<p>Used to define the effects to be used for the entry and exit of text in the display area. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="acf3b849a996dbbe48ca173d2b0b82edaa65db4b21517eaca3a0011552dda00a86"></a>PA_NO_EFFECT&#160;</td><td class="fielddoc"><p>Used as a place filler, executes no operation. </p>
</td></tr>
<tr><td class="fieldname"><a id="acf3b849a996dbbe48ca173d2b0b82edaa5a65e70e91a3a123cc678178a780667d"></a>PA_PRINT&#160;</td><td class="fielddoc"><p>Text just appears (printed) </p>
</td></tr>
<tr><td class="fieldname"><a id="acf3b849a996dbbe48ca173d2b0b82edaa7455ebe66471e6159811bbe0a2110d38"></a>PA_SCROLL_UP&#160;</td><td class="fielddoc"><p>Text scrolls up through the display. </p>
</td></tr>
<tr><td class="fieldname"><a id="acf3b849a996dbbe48ca173d2b0b82edaa99d43e17954efdfab65adbb9ec4478a8"></a>PA_SCROLL_DOWN&#160;</td><td class="fielddoc"><p>Text scrolls down through the display. </p>
</td></tr>
<tr><td class="fieldname"><a id="acf3b849a996dbbe48ca173d2b0b82edaa80ce296b12960be2f9a0cffb51ef0d7c"></a>PA_SCROLL_LEFT&#160;</td><td class="fielddoc"><p>Text scrolls right to left on the display. </p>
</td></tr>
<tr><td class="fieldname"><a id="acf3b849a996dbbe48ca173d2b0b82edaaca390db312bfa67fbd90bb65428a6c78"></a>PA_SCROLL_RIGHT&#160;</td><td class="fielddoc"><p>Text scrolls left to right on the display. </p>
</td></tr>
<tr><td class="fieldname"><a id="acf3b849a996dbbe48ca173d2b0b82edaa4f395cf278c4d934ac8d2b662675f669"></a>PA_SPRITE&#160;</td><td class="fielddoc"><p>Text enters and exits using user defined sprite. </p>
</td></tr>
<tr><td class="fieldname"><a id="acf3b849a996dbbe48ca173d2b0b82edaa08e32ea749f514046ba58f8da3cdfd72"></a>PA_SLICE&#160;</td><td class="fielddoc"><p>Text enters and exits a slice (column) at a time from the right. </p>
</td></tr>
<tr><td class="fieldname"><a id="acf3b849a996dbbe48ca173d2b0b82edaa709894e18b54d3465d3136f73a708b0d"></a>PA_MESH&#160;</td><td class="fielddoc"><p>Text enters and exits in columns moving in alternate direction (U/D) </p>
</td></tr>
<tr><td class="fieldname"><a id="acf3b849a996dbbe48ca173d2b0b82edaae5e485df24f7a4e3120aa2876806d958"></a>PA_FADE&#160;</td><td class="fielddoc"><p>Text enters and exits by fading from/to 0 and intensity setting. </p>
</td></tr>
<tr><td class="fieldname"><a id="acf3b849a996dbbe48ca173d2b0b82edaa2da3a4230287c733a19102a73341e94f"></a>PA_DISSOLVE&#160;</td><td class="fielddoc"><p>Text dissolves from one display to another. </p>
</td></tr>
<tr><td class="fieldname"><a id="acf3b849a996dbbe48ca173d2b0b82edaab81ef7a0c3fe92b98386bd2decda8534"></a>PA_BLINDS&#160;</td><td class="fielddoc"><p>Text is replaced behind vertical blinds. </p>
</td></tr>
<tr><td class="fieldname"><a id="acf3b849a996dbbe48ca173d2b0b82edaa98aec2f1905ed10ec1f3751cb7101dca"></a>PA_RANDOM&#160;</td><td class="fielddoc"><p>Text enters and exits as random dots. </p>
</td></tr>
<tr><td class="fieldname"><a id="acf3b849a996dbbe48ca173d2b0b82edaae7744273c94ba436a27b4359e2e6089e"></a>PA_WIPE&#160;</td><td class="fielddoc"><p>Text appears/disappears one column at a time, looks like it is wiped on and off. </p>
</td></tr>
<tr><td class="fieldname"><a id="acf3b849a996dbbe48ca173d2b0b82edaa0fd7f078a92b7c8ba1932d9d4ad2544d"></a>PA_WIPE_CURSOR&#160;</td><td class="fielddoc"><p>WIPE with a light bar ahead of the change. </p>
</td></tr>
<tr><td class="fieldname"><a id="acf3b849a996dbbe48ca173d2b0b82edaadf43a4fcab04c2a431e8bab32846604e"></a>PA_SCAN_HORIZ&#160;</td><td class="fielddoc"><p>Scan the LED column one at a time then appears/disappear at end. </p>
</td></tr>
<tr><td class="fieldname"><a id="acf3b849a996dbbe48ca173d2b0b82edaabd9180021766e98a2ad60cc300966dae"></a>PA_SCAN_HORIZX&#160;</td><td class="fielddoc"><p>Scan a blank column through the text one column at a time then appears/disappear at end. </p>
</td></tr>
<tr><td class="fieldname"><a id="acf3b849a996dbbe48ca173d2b0b82edaaf6713d23a47d9f32cd66f66fe83d8a83"></a>PA_SCAN_VERT&#160;</td><td class="fielddoc"><p>Scan the LED row one at a time then appears/disappear at end. </p>
</td></tr>
<tr><td class="fieldname"><a id="acf3b849a996dbbe48ca173d2b0b82edaaab3547aef11cf5b5fec653b193c4fcfd"></a>PA_SCAN_VERTX&#160;</td><td class="fielddoc"><p>Scan a blank row through the text one row at a time then appears/disappear at end. </p>
</td></tr>
<tr><td class="fieldname"><a id="acf3b849a996dbbe48ca173d2b0b82edaa3bba17d858630b5dbd1d3842096d0c92"></a>PA_OPENING&#160;</td><td class="fielddoc"><p>Appear and disappear from the center of the display, towards the ends. </p>
</td></tr>
<tr><td class="fieldname"><a id="acf3b849a996dbbe48ca173d2b0b82edaa781b03148fc439ca816cb0bf4e47ef45"></a>PA_OPENING_CURSOR&#160;</td><td class="fielddoc"><p>OPENING with light bars ahead of the change. </p>
</td></tr>
<tr><td class="fieldname"><a id="acf3b849a996dbbe48ca173d2b0b82edaaa310b2fc9164c2c2afc461f9725d168a"></a>PA_CLOSING&#160;</td><td class="fielddoc"><p>Appear and disappear from the ends of the display, towards the middle. </p>
</td></tr>
<tr><td class="fieldname"><a id="acf3b849a996dbbe48ca173d2b0b82edaae286d4dae4a95ce030296f6444accf7c"></a>PA_CLOSING_CURSOR&#160;</td><td class="fielddoc"><p>CLOSING with light bars ahead of the change. </p>
</td></tr>
<tr><td class="fieldname"><a id="acf3b849a996dbbe48ca173d2b0b82edaa612412629877864ba4842755d73f53f3"></a>PA_SCROLL_UP_LEFT&#160;</td><td class="fielddoc"><p>Text moves in/out in a diagonal path up and left (North East) </p>
</td></tr>
<tr><td class="fieldname"><a id="acf3b849a996dbbe48ca173d2b0b82edaaea3a88a7345feeec48a2318e51dfd789"></a>PA_SCROLL_UP_RIGHT&#160;</td><td class="fielddoc"><p>Text moves in/out in a diagonal path up and right (North West) </p>
</td></tr>
<tr><td class="fieldname"><a id="acf3b849a996dbbe48ca173d2b0b82edaa458ea3e72f6db4ecfdff8a31716751fe"></a>PA_SCROLL_DOWN_LEFT&#160;</td><td class="fielddoc"><p>Text moves in/out in a diagonal path down and left (South East) </p>
</td></tr>
<tr><td class="fieldname"><a id="acf3b849a996dbbe48ca173d2b0b82edaa9d4b6eaa770ca96372b299acf8a203ab"></a>PA_SCROLL_DOWN_RIGHT&#160;</td><td class="fielddoc"><p>Text moves in/out in a diagonal path down and right (North West) </p>
</td></tr>
<tr><td class="fieldname"><a id="acf3b849a996dbbe48ca173d2b0b82edaa86a5ff70349dd4ffcbc074fdad35305f"></a>PA_GROW_UP&#160;</td><td class="fielddoc"><p>Text grows from the bottom up and shrinks from the top down. </p>
</td></tr>
<tr><td class="fieldname"><a id="acf3b849a996dbbe48ca173d2b0b82edaac36e08217d8be0c00e050aa308ef9ae7"></a>PA_GROW_DOWN&#160;</td><td class="fielddoc"><p>Text grows from the top down and and shrinks from the bottom up. </p>
</td></tr>
</table>
</div>
</div>
<a id="abab52de9e46b83d0aa94f0e3439e224d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abab52de9e46b83d0aa94f0e3439e224d">&#9670;&nbsp;</a></span>textPosition_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="_m_d___parola_8h.html#abab52de9e46b83d0aa94f0e3439e224d">textPosition_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Text alignment enumerated type specification.</p>
<p>Used to define the display text alignment and to specify direction for scrolling and animations. In the situation where LEFT AND RIGHT are the only sensible options (eg, text scrolling direction), CENTER will behave the same as LEFT. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="abab52de9e46b83d0aa94f0e3439e224da9a3405b11cd2d02b7bede55b8bcf4372"></a>PA_LEFT&#160;</td><td class="fielddoc"><p>The leftmost column for the first character will be on the left side of the display. </p>
</td></tr>
<tr><td class="fieldname"><a id="abab52de9e46b83d0aa94f0e3439e224dac82282c0c93b36650cbc112cc786ba1f"></a>PA_CENTER&#160;</td><td class="fielddoc"><p>The text will be placed with equal number of blank display columns either side. </p>
</td></tr>
<tr><td class="fieldname"><a id="abab52de9e46b83d0aa94f0e3439e224da735ddff6e6acfbd3035a817d96c6f471"></a>PA_RIGHT&#160;</td><td class="fielddoc"><p>The rightmost column of the last character will be on the right side of the display. </p>
</td></tr>
</table>
</div>
</div>
<a id="a8b150a33856e93a2596b6622117f08f5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8b150a33856e93a2596b6622117f08f5">&#9670;&nbsp;</a></span>zoneEffect_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="_m_d___parola_8h.html#a8b150a33856e93a2596b6622117f08f5">zoneEffect_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Zone effect enumerated type specification.</p>
<p>Used to define the effects to be used for text in the zone.</p>
<p>The FLIP_UD and FLIP_LR effects are specifically designed to allow rectangular shaped display modules (like Parola or Generic types) to be placed in an inverted position to allow all matrices to be tightly packed into a 2 line display. One of the lines must be flipped horizontally and vertically to remain legible in this configuration. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a8b150a33856e93a2596b6622117f08f5af4cfb7e758daa237304a954d4f8750b8"></a>PA_FLIP_UD&#160;</td><td class="fielddoc"><p>Flip the zone Up to Down (effectively upside down). Works with all textEffect_t values. </p>
</td></tr>
<tr><td class="fieldname"><a id="a8b150a33856e93a2596b6622117f08f5aba2b6cdea083af8165ef30b3adab3f09"></a>PA_FLIP_LR&#160;</td><td class="fielddoc"><p>Flip the zone Left to Right (effectively mirrored). Does not work with textEffect_t types SLICE, SCROLL_LEFT, SCROLL_RIGHT. </p>
</td></tr>
</table>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="_m_d___parola_8h.html">MD_Parola.h</a></li>
<li class="footer">Generated on Tue Jul 10 2018 20:02:31 for Parola for Arduino by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink