localhorst
/
ESP32-WROVER-KIT-LCD-DRIVER
1
0
Fork 0
Code Issues 2 Pull Requests Releases Wiki Activity
ESP32-WROVER-KIT-LCD-DRIVER/Doxygen/html/_l_c_d_8h.html

393 lines
20 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.20"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>ESP32-WROVER-KIT-LCD-DRIVER: components/lcd/include/LCD.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>
<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="projectalign" style="padding-left: 0.5em;">
<div id="projectname">ESP32-WROVER-KIT-LCD-DRIVER
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.20 -->
<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('_l_c_d_8h.html',''); initResizable(); });
/* @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="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">LCD.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;stdio.h&gt;</code><br />
<code>#include &lt;stdlib.h&gt;</code><br />
<code>#include &quot;driver/spi_master.h&quot;</code><br />
<code>#include &quot;driver/gpio.h&quot;</code><br />
<code>#include &lt;string.h&gt;</code><br />
<code>#include &quot;esp_system.h&quot;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for LCD.h:</div>
<div class="dyncontent">
<div class="center"><img src="_l_c_d_8h__incl.png" border="0" usemap="#acomponents_2lcd_2include_2_l_c_d_8h" alt=""/></div>
<map name="components_2lcd_2include_2_l_c_d_8h" id="acomponents_2lcd_2include_2_l_c_d_8h">
<area shape="rect" title=" " alt="" coords="234,5,393,47"/>
<area shape="rect" title=" " alt="" coords="5,95,67,121"/>
<area shape="rect" title=" " alt="" coords="91,95,155,121"/>
<area shape="rect" title=" " alt="" coords="179,95,311,121"/>
<area shape="rect" title=" " alt="" coords="335,95,427,121"/>
<area shape="rect" title=" " alt="" coords="451,95,517,121"/>
<area shape="rect" title=" " alt="" coords="541,95,645,121"/>
</map>
</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="_l_c_d_8h__dep__incl.png" border="0" usemap="#acomponents_2lcd_2include_2_l_c_d_8hdep" alt=""/></div>
<map name="components_2lcd_2include_2_l_c_d_8hdep" id="acomponents_2lcd_2include_2_l_c_d_8hdep">
<area shape="rect" title=" " alt="" coords="5,5,164,47"/>
<area shape="rect" href="_l_c_d_8c.html" title="sets and writes framebuffer" alt="" coords="17,95,153,136"/>
</map>
</div>
</div>
<p><a href="_l_c_d_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ad86358bf19927183dd7b4ae215a29731"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_l_c_d_8h.html#ad86358bf19927183dd7b4ae215a29731">COLOR_RED</a>&#160;&#160;&#160;0xF800</td></tr>
<tr class="separator:ad86358bf19927183dd7b4ae215a29731"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afc9149f5de51bd9ac4f5ebbfa153f018"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_l_c_d_8h.html#afc9149f5de51bd9ac4f5ebbfa153f018">COLOR_GREEN</a>&#160;&#160;&#160;0x07E0</td></tr>
<tr class="separator:afc9149f5de51bd9ac4f5ebbfa153f018"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a23c70d699a5a775bc2e1ebeb8603f630"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_l_c_d_8h.html#a23c70d699a5a775bc2e1ebeb8603f630">COLOR_BLUE</a>&#160;&#160;&#160;0x001F</td></tr>
<tr class="separator:a23c70d699a5a775bc2e1ebeb8603f630"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9b44987ffdc2af19b635206b94334b69"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_l_c_d_8h.html#a9b44987ffdc2af19b635206b94334b69">COLOR_WHITE</a>&#160;&#160;&#160;0xFFFF</td></tr>
<tr class="separator:a9b44987ffdc2af19b635206b94334b69"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aba2a7fe77a7501e5844370eec0185207"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_l_c_d_8h.html#aba2a7fe77a7501e5844370eec0185207">COLOR_BLACK</a>&#160;&#160;&#160;0x0000</td></tr>
<tr class="separator:aba2a7fe77a7501e5844370eec0185207"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a4d0719889f64bf0c82dd5adc3a26adf3"><td class="memItemLeft" align="right" valign="top">esp_err_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_l_c_d_8h.html#a4d0719889f64bf0c82dd5adc3a26adf3">iLCD_init</a> (void)</td></tr>
<tr class="memdesc:a4d0719889f64bf0c82dd5adc3a26adf3"><td class="mdescLeft">&#160;</td><td class="mdescRight">init <a href="_l_c_d_8h.html#a4d0719889f64bf0c82dd5adc3a26adf3">More...</a><br /></td></tr>
<tr class="separator:a4d0719889f64bf0c82dd5adc3a26adf3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a95f7c4fb0d7de1cb623b52031aad3fe8"><td class="memItemLeft" align="right" valign="top">esp_err_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_l_c_d_8h.html#a95f7c4fb0d7de1cb623b52031aad3fe8">iLCD_clearFramebuffer</a> (uint16_t u16Color)</td></tr>
<tr class="memdesc:a95f7c4fb0d7de1cb623b52031aad3fe8"><td class="mdescLeft">&#160;</td><td class="mdescRight">clear complete framebuffer with a color <a href="_l_c_d_8h.html#a95f7c4fb0d7de1cb623b52031aad3fe8">More...</a><br /></td></tr>
<tr class="separator:a95f7c4fb0d7de1cb623b52031aad3fe8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a305dd37530a1617090bbc448e2e40d26"><td class="memItemLeft" align="right" valign="top">esp_err_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_l_c_d_8h.html#a305dd37530a1617090bbc448e2e40d26">iLCD_writeString</a> (uint16_t u16xPos, uint16_t u16yPos, char *pcText, uint16_t u16ColorFont, uint16_t u16ColorBackground)</td></tr>
<tr class="memdesc:a305dd37530a1617090bbc448e2e40d26"><td class="mdescLeft">&#160;</td><td class="mdescRight">write string/text into framebuffer <a href="_l_c_d_8h.html#a305dd37530a1617090bbc448e2e40d26">More...</a><br /></td></tr>
<tr class="separator:a305dd37530a1617090bbc448e2e40d26"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><dl class="section author"><dt>Author</dt><dd>Hendrik Schutter </dd></dl>
<dl class="section version"><dt>Version</dt><dd>V1.0 </dd></dl>
<dl class="section date"><dt>Date</dt><dd>03.11.2020 </dd></dl>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="aba2a7fe77a7501e5844370eec0185207"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aba2a7fe77a7501e5844370eec0185207">&#9670;&nbsp;</a></span>COLOR_BLACK</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define COLOR_BLACK&#160;&#160;&#160;0x0000</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a23c70d699a5a775bc2e1ebeb8603f630"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a23c70d699a5a775bc2e1ebeb8603f630">&#9670;&nbsp;</a></span>COLOR_BLUE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define COLOR_BLUE&#160;&#160;&#160;0x001F</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="afc9149f5de51bd9ac4f5ebbfa153f018"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afc9149f5de51bd9ac4f5ebbfa153f018">&#9670;&nbsp;</a></span>COLOR_GREEN</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define COLOR_GREEN&#160;&#160;&#160;0x07E0</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ad86358bf19927183dd7b4ae215a29731"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad86358bf19927183dd7b4ae215a29731">&#9670;&nbsp;</a></span>COLOR_RED</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define COLOR_RED&#160;&#160;&#160;0xF800</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a9b44987ffdc2af19b635206b94334b69"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9b44987ffdc2af19b635206b94334b69">&#9670;&nbsp;</a></span>COLOR_WHITE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define COLOR_WHITE&#160;&#160;&#160;0xFFFF</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a95f7c4fb0d7de1cb623b52031aad3fe8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a95f7c4fb0d7de1cb623b52031aad3fe8">&#9670;&nbsp;</a></span>iLCD_clearFramebuffer()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">esp_err_t iLCD_clearFramebuffer </td>
<td>(</td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>u16Color</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>clear complete framebuffer with a color </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">RGB586</td><td>color code </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>esp error code </dd></dl>
<dl class="section author"><dt>Author</dt><dd>Hendrik Schutter </dd></dl>
<dl class="section date"><dt>Date</dt><dd>3.11.2020 </dd></dl>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="_l_c_d_8h_a95f7c4fb0d7de1cb623b52031aad3fe8_cgraph.png" border="0" usemap="#a_l_c_d_8h_a95f7c4fb0d7de1cb623b52031aad3fe8_cgraph" alt=""/></div>
<map name="_l_c_d_8h_a95f7c4fb0d7de1cb623b52031aad3fe8_cgraph" id="a_l_c_d_8h_a95f7c4fb0d7de1cb623b52031aad3fe8_cgraph">
<area shape="rect" title="clear complete framebuffer with a color" alt="" coords="5,56,163,83"/>
<area shape="rect" href="_driver_8h.html#a62a79453d5cfaf0693a21714162f22d4" title="write framebuffer to LCD via SPI" alt="" coords="211,56,375,83"/>
<area shape="rect" href="_driver_8c.html#a3d6cd2f0685caf993fd7455dd100dd7c" title="send finish after line" alt="" coords="447,5,600,32"/>
<area shape="rect" href="_driver_8c.html#ab611c2d5911c284b757197882ea227be" title="send line to lcd chip" alt="" coords="461,56,586,83"/>
<area shape="rect" href="_driver_8c.html#a3ce1541687c13e00a1cc1d4d7ff564aa" title="Get the pixel data for a set of lines (with implied line size of 320)" alt="" coords="423,107,624,133"/>
</map>
</div>
</div>
</div>
<a id="a4d0719889f64bf0c82dd5adc3a26adf3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4d0719889f64bf0c82dd5adc3a26adf3">&#9670;&nbsp;</a></span>iLCD_init()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">esp_err_t iLCD_init </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>init </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">void</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>int </dd></dl>
<dl class="section author"><dt>Author</dt><dd>Hendrik Schutter </dd></dl>
<dl class="section date"><dt>Date</dt><dd>3.11.2020 </dd></dl>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="_l_c_d_8h_a4d0719889f64bf0c82dd5adc3a26adf3_cgraph.png" border="0" usemap="#a_l_c_d_8h_a4d0719889f64bf0c82dd5adc3a26adf3_cgraph" alt=""/></div>
<map name="_l_c_d_8h_a4d0719889f64bf0c82dd5adc3a26adf3_cgraph" id="a_l_c_d_8h_a4d0719889f64bf0c82dd5adc3a26adf3_cgraph">
<area shape="rect" title="init" alt="" coords="5,31,81,57"/>
<area shape="rect" href="_l_c_d_8c.html#a13ff792cd544fe043593ceb2a8150c3c" title="allocate framebuffer" alt="" coords="129,5,304,32"/>
<area shape="rect" href="_driver_8h.html#adb1369972e80eb05d5e831cbc7cf3d4f" title="Initialize the driver." alt="" coords="173,56,260,83"/>
<area shape="rect" href="_driver_8c.html#a3ce4cd1bae3e49f2d06a880446db54d4" title="Send a command to the LCD." alt="" coords="605,31,728,57"/>
<area shape="rect" href="_driver_8c.html#a066209485105862c60c5f9393caa48be" title="Send data to the LCD." alt="" coords="393,31,517,57"/>
<area shape="rect" href="_driver_8c.html#acfaa6e6c39d79e04fadf512cf9ca3944" title="get LCD driver chip id" alt="" coords="403,81,506,108"/>
<area shape="rect" href="_driver_8c.html#ae2d5a9bae2c3a62f89e2cc83cc36a61e" title="Pre Transfer Callback." alt="" coords="352,132,557,159"/>
</map>
</div>
</div>
</div>
<a id="a305dd37530a1617090bbc448e2e40d26"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a305dd37530a1617090bbc448e2e40d26">&#9670;&nbsp;</a></span>iLCD_writeString()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">esp_err_t iLCD_writeString </td>
<td>(</td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>u16xPos</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>u16yPos</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char *&#160;</td>
<td class="paramname"><em>pcText</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>u16ColorFont</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>u16ColorBackground</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>write string/text into framebuffer </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">uint16_t</td><td>u16xPos </td></tr>
<tr><td class="paramname">uint16_t</td><td>u16yPos </td></tr>
<tr><td class="paramname">char</td><td>*pcText </td></tr>
<tr><td class="paramname">RGB586</td><td>color code for font uint16_t u16ColorFont </td></tr>
<tr><td class="paramname">RGB586</td><td>color code for background uint16_t u16ColorBackground </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>esp error code </dd></dl>
<dl class="section author"><dt>Author</dt><dd>Hendrik Schutter </dd></dl>
<dl class="section date"><dt>Date</dt><dd>4.11.2020 </dd></dl>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="_l_c_d_8h_a305dd37530a1617090bbc448e2e40d26_cgraph.png" border="0" usemap="#a_l_c_d_8h_a305dd37530a1617090bbc448e2e40d26_cgraph" alt=""/></div>
<map name="_l_c_d_8h_a305dd37530a1617090bbc448e2e40d26_cgraph" id="a_l_c_d_8h_a305dd37530a1617090bbc448e2e40d26_cgraph">
<area shape="rect" title="write string/text into framebuffer" alt="" coords="5,81,127,108"/>
<area shape="rect" href="_driver_8h.html#a62a79453d5cfaf0693a21714162f22d4" title="write framebuffer to LCD via SPI" alt="" coords="175,56,339,83"/>
<area shape="rect" href="_l_c_d_8c.html#a3797f0f021c102d4f15fdbb57167a04c" title="write string/text into framebuffer" alt="" coords="197,107,316,133"/>
<area shape="rect" href="_driver_8c.html#a3d6cd2f0685caf993fd7455dd100dd7c" title="send finish after line" alt="" coords="411,5,564,32"/>
<area shape="rect" href="_driver_8c.html#ab611c2d5911c284b757197882ea227be" title="send line to lcd chip" alt="" coords="425,56,550,83"/>
<area shape="rect" href="_driver_8c.html#a3ce1541687c13e00a1cc1d4d7ff564aa" title="Get the pixel data for a set of lines (with implied line size of 320)" alt="" coords="387,107,588,133"/>
</map>
</div>
</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_409f97388efe006bc3438b95e9edef48.html">components</a></li><li class="navelem"><a class="el" href="dir_8c3047c3b01c62334c9cb3295fc1c68f.html">lcd</a></li><li class="navelem"><a class="el" href="dir_fa7a4d24b569216cf1b68f7e93657ef0.html">include</a></li><li class="navelem"><a class="el" href="_l_c_d_8h.html">LCD.h</a></li>
<li class="footer">Generated by <a href="http://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.8.20 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink