Files
discoverpixy/group__app.html
2015-06-08 11:04:50 +02:00

197 lines
15 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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.9.1"/>
<title>discoverpixy: Application</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="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>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</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 style="padding-left: 0.5em;">
<div id="projectname">discoverpixy
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.9.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<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><!-- top -->
<!-- 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="#groups">Modules</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Application</div> </div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Collaboration diagram for Application:</div>
<div class="dyncontent">
<center><table><tr><td><img src="group__app.png" border="0" alt="" usemap="#group____app"/>
<map name="group____app" id="group____app">
<area shape="rect" id="node1" href="group__pixy__control.html" title="Pixy Control Helper" alt="" coords="140,5,275,32"/><area shape="rect" id="node3" href="group__screens.html" title="Screens" alt="" coords="172,56,243,83"/><area shape="rect" id="node4" href="group__pixy__helper.html" title="Pixy Frame Helper" alt="" coords="142,107,273,133"/></map>
</td></tr></table></center>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a>
Modules</h2></td></tr>
<tr class="memitem:group__pixy__control"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pixy__control.html">Pixy Control Helper</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__pixy__helper"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pixy__helper.html">Pixy Frame Helper</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:group__screens"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__screens.html">Screens</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="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga8c6e58bb7e2a0dcf8537fc940ebfa385"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__app.html#ga8c6e58bb7e2a0dcf8537fc940ebfa385">app_init</a> ()</td></tr>
<tr class="separator:ga8c6e58bb7e2a0dcf8537fc940ebfa385"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga071d403b77a003f23a0d2ab1fbb67a36"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__app.html#ga071d403b77a003f23a0d2ab1fbb67a36">app_process</a> ()</td></tr>
<tr class="separator:ga071d403b77a003f23a0d2ab1fbb67a36"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>The App Module contains the effective, platform independent application. </p>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga8c6e58bb7e2a0dcf8537fc940ebfa385"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void app_init </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Starts/Initializes the app This function should be called at the top of the main function of your platform </p>
<p>Definition at line <a class="el" href="app_8c_source.html#l00037">37</a> of file <a class="el" href="app_8c_source.html">app.c</a>.</p>
<div class="fragment"><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;{</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <a class="code" href="group__system.html#ga3bc3f0cc729bc8f6bf8c0702c4d058dd">system_init</a>();</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <a class="code" href="group__tft.html#gaaaed6a011ff4ec08c6a1a264e8396215">tft_init</a>();</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <a class="code" href="group__touch.html#ga0ff491e3e07321fef794d4f07b103c0f">touch_init</a>();</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <a class="code" href="group__filesystem.html#ga367ec5e73c77ddf5047d05021cf97a8f">filesystem_init</a>();</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <a class="code" href="group__screen.html#gad4473a16eaf48dab405d23f5f63af3aa">gui_screen_navigate</a>(<a class="code" href="group__main.html#ga6310b719fc2b06860024d0992d08acd1">get_screen_main</a>());</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;}</div>
<div class="ttc" id="group__main_html_ga6310b719fc2b06860024d0992d08acd1"><div class="ttname"><a href="group__main.html#ga6310b719fc2b06860024d0992d08acd1">get_screen_main</a></div><div class="ttdeci">SCREEN_STRUCT * get_screen_main()</div><div class="ttdef"><b>Definition:</b> <a href="screen__main_8c_source.html#l00196">screen_main.c:196</a></div></div>
<div class="ttc" id="group__screen_html_gad4473a16eaf48dab405d23f5f63af3aa"><div class="ttname"><a href="group__screen.html#gad4473a16eaf48dab405d23f5f63af3aa">gui_screen_navigate</a></div><div class="ttdeci">bool gui_screen_navigate(SCREEN_STRUCT *screen)</div><div class="ttdef"><b>Definition:</b> <a href="screen_8c_source.html#l00074">screen.c:74</a></div></div>
<div class="ttc" id="group__system_html_ga3bc3f0cc729bc8f6bf8c0702c4d058dd"><div class="ttname"><a href="group__system.html#ga3bc3f0cc729bc8f6bf8c0702c4d058dd">system_init</a></div><div class="ttdeci">bool system_init()</div><div class="ttdef"><b>Definition:</b> <a href="system_8c_source.html#l00021">system.c:21</a></div></div>
<div class="ttc" id="group__filesystem_html_ga367ec5e73c77ddf5047d05021cf97a8f"><div class="ttname"><a href="group__filesystem.html#ga367ec5e73c77ddf5047d05021cf97a8f">filesystem_init</a></div><div class="ttdeci">bool filesystem_init()</div><div class="ttdef"><b>Definition:</b> <a href="filesystem_8c_source.html#l00018">filesystem.c:18</a></div></div>
<div class="ttc" id="group__tft_html_gaaaed6a011ff4ec08c6a1a264e8396215"><div class="ttname"><a href="group__tft.html#gaaaed6a011ff4ec08c6a1a264e8396215">tft_init</a></div><div class="ttdeci">bool tft_init()</div><div class="ttdef"><b>Definition:</b> <a href="tft_8c_source.html#l00039">tft.c:39</a></div></div>
<div class="ttc" id="group__touch_html_ga0ff491e3e07321fef794d4f07b103c0f"><div class="ttname"><a href="group__touch.html#ga0ff491e3e07321fef794d4f07b103c0f">touch_init</a></div><div class="ttdeci">bool touch_init()</div><div class="ttdef"><b>Definition:</b> <a href="touch_8c_source.html#l00061">touch.c:61</a></div></div>
</div><!-- fragment -->
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="group__app_ga8c6e58bb7e2a0dcf8537fc940ebfa385_cgraph.png" border="0" usemap="#group__app_ga8c6e58bb7e2a0dcf8537fc940ebfa385_cgraph" alt=""/></div>
<map name="group__app_ga8c6e58bb7e2a0dcf8537fc940ebfa385_cgraph" id="group__app_ga8c6e58bb7e2a0dcf8537fc940ebfa385_cgraph">
<area shape="rect" id="node2" href="group__system.html#ga3bc3f0cc729bc8f6bf8c0702c4d058dd" title="system_init" alt="" coords="145,5,234,32"/><area shape="rect" id="node4" href="group__tft.html#gaaaed6a011ff4ec08c6a1a264e8396215" title="tft_init" alt="" coords="161,56,218,83"/><area shape="rect" id="node6" href="group__touch.html#ga0ff491e3e07321fef794d4f07b103c0f" title="touch_init" alt="" coords="150,107,229,133"/><area shape="rect" id="node8" href="group__filesystem.html#ga367ec5e73c77ddf5047d05021cf97a8f" title="filesystem_init" alt="" coords="137,157,242,184"/><area shape="rect" id="node10" href="group__screen.html#gad4473a16eaf48dab405d23f5f63af3aa" title="gui_screen_navigate" alt="" coords="120,208,259,235"/><area shape="rect" id="node11" href="group__main.html#ga6310b719fc2b06860024d0992d08acd1" title="get_screen_main" alt="" coords="129,259,250,285"/><area shape="rect" id="node3" href="group__ll__system.html#gad6c3b701d60604cc59b68e1af81c8f85" title="ll_system_init" alt="" coords="315,5,417,32"/><area shape="rect" id="node5" href="group__ll__tft.html#gac974fbb4327f3b0abaac5c33c07337c7" title="ll_tft_init" alt="" coords="331,56,401,83"/><area shape="rect" id="node7" href="group__ll__touch.html#ga91ec460ea9b170c352be4173da2eaf48" title="ll_touch_init" alt="" coords="321,107,411,133"/><area shape="rect" id="node9" href="group__ll__filesystem.html#ga5e9b54813d51bd15dff031285911a95e" title="ll_filesystem_init" alt="" coords="307,157,425,184"/></map>
</div>
</p>
</div>
</div>
<a class="anchor" id="ga071d403b77a003f23a0d2ab1fbb67a36"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void app_process </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Executes one cycle of the app Call this function repeatedly from a loop inside the main function </p>
<p>Definition at line <a class="el" href="app_8c_source.html#l00048">48</a> of file <a class="el" href="app_8c_source.html">app.c</a>.</p>
<div class="fragment"><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;{</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <a class="code" href="group__system.html#ga222cd9a0957fe56d9bb3e745acfb7f1f">system_process</a>(); <span class="comment">//Let the system handle it&#39;s pending events</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <a class="code" href="group__screen.html#gab7394734ee1d57093721cbd22b901323">gui_screen_update</a>(); <span class="comment">//update the currently active screen</span></div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;}</div>
<div class="ttc" id="group__screen_html_gab7394734ee1d57093721cbd22b901323"><div class="ttname"><a href="group__screen.html#gab7394734ee1d57093721cbd22b901323">gui_screen_update</a></div><div class="ttdeci">void gui_screen_update()</div><div class="ttdef"><b>Definition:</b> <a href="screen_8c_source.html#l00041">screen.c:41</a></div></div>
<div class="ttc" id="group__system_html_ga222cd9a0957fe56d9bb3e745acfb7f1f"><div class="ttname"><a href="group__system.html#ga222cd9a0957fe56d9bb3e745acfb7f1f">system_process</a></div><div class="ttdeci">void system_process()</div><div class="ttdef"><b>Definition:</b> <a href="system_8c_source.html#l00031">system.c:31</a></div></div>
</div><!-- fragment -->
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="group__app_ga071d403b77a003f23a0d2ab1fbb67a36_cgraph.png" border="0" usemap="#group__app_ga071d403b77a003f23a0d2ab1fbb67a36_cgraph" alt=""/></div>
<map name="group__app_ga071d403b77a003f23a0d2ab1fbb67a36_cgraph" id="group__app_ga071d403b77a003f23a0d2ab1fbb67a36_cgraph">
<area shape="rect" id="node2" href="group__system.html#ga222cd9a0957fe56d9bb3e745acfb7f1f" title="system_process" alt="" coords="155,5,274,32"/><area shape="rect" id="node4" href="group__screen.html#gab7394734ee1d57093721cbd22b901323" title="gui_screen_update" alt="" coords="149,56,280,83"/><area shape="rect" id="node3" href="group__ll__system.html#ga1314af5893cdde97e48bf135b6996b1c" title="ll_system_process" alt="" coords="328,5,459,32"/></map>
</div>
</p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Jun 8 2015 11:01:19 for discoverpixy by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.9.1
</small></address>
</body>
</html>