| <!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.9.1"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>32blit API: engine/timer.hpp Source File</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">32blit API |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.9.1 --> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| var searchBox = new SearchBox("searchBox", "search",false,'Search','.html'); |
| /* @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&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&dn=gpl-2.0.txt GPL-v2 */ |
| $(document).ready(function(){initNavTree('timer_8hpp_source.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="headertitle"> |
| <div class="title">timer.hpp</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="preprocessor">#pragma once</span></div> |
| <div class="line"><a name="l00002"></a><span class="lineno"> 2</span>  </div> |
| <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="preprocessor">#include <cstdint></span></div> |
| <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="preprocessor">#include <vector></span></div> |
| <div class="line"><a name="l00005"></a><span class="lineno"> 5</span>  </div> |
| <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="keyword">namespace </span><a class="code" href="namespaceblit.html">blit</a> {</div> |
| <div class="line"><a name="l00007"></a><span class="lineno"> 7</span>  </div> |
| <div class="line"><a name="l00008"></a><span class="lineno"><a class="line" href="structblit_1_1Timer.html"> 8</a></span>  <span class="keyword">struct </span><a class="code" href="structblit_1_1Timer.html">Timer</a> {</div> |
| <div class="line"><a name="l00009"></a><span class="lineno"> 9</span>  <span class="keyword">using</span> TimerCallback = std::function<void (<a class="code" href="structblit_1_1Timer.html">Timer</a> &timer)>;</div> |
| <div class="line"><a name="l00010"></a><span class="lineno"> 10</span>  </div> |
| <div class="line"><a name="l00011"></a><span class="lineno"> 11</span>  TimerCallback callback = <span class="keyword">nullptr</span>;</div> |
| <div class="line"><a name="l00012"></a><span class="lineno"> 12</span>  </div> |
| <div class="line"><a name="l00013"></a><span class="lineno"> 13</span>  uint32_t duration = 0; <span class="comment">// how many milliseconds between callbacks</span></div> |
| <div class="line"><a name="l00014"></a><span class="lineno"> 14</span>  uint32_t started = 0; <span class="comment">// system time when timer started in milliseconds</span></div> |
| <div class="line"><a name="l00015"></a><span class="lineno"> 15</span>  uint32_t paused = 0; <span class="comment">// time when timer was paused</span></div> |
| <div class="line"><a name="l00016"></a><span class="lineno"> 16</span>  int32_t loops = -1, loop_count = 0; <span class="comment">// number of times to repeat timer (-1 == forever)</span></div> |
| <div class="line"><a name="l00017"></a><span class="lineno"> 17</span>  <span class="keyword">enum</span> state { <span class="comment">// state of the timer</span></div> |
| <div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  UNINITIALISED,</div> |
| <div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  STOPPED,</div> |
| <div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  RUNNING,</div> |
| <div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  PAUSED,</div> |
| <div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  FINISHED</div> |
| <div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  };</div> |
| <div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  uint8_t state = UNINITIALISED;</div> |
| <div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  </div> |
| <div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  <span class="keywordtype">void</span> <a class="code" href="structblit_1_1Timer.html#afef8e53a4aaa0be11e6acd9286ac0856">init</a>(TimerCallback callback, uint32_t duration, int32_t loops = -1);</div> |
| <div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  <span class="keywordtype">void</span> <a class="code" href="structblit_1_1Timer.html#a2f86dbc0263ba0281a4fe19588169749">start</a>();</div> |
| <div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  <span class="keywordtype">void</span> <a class="code" href="structblit_1_1Timer.html#aff99d19fafabe9afe98ed4694e39a9d3">pause</a>();</div> |
| <div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  <span class="keywordtype">void</span> <a class="code" href="structblit_1_1Timer.html#a581d2e2926103c2a0594b2ed07a73e58">stop</a>();</div> |
| <div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  </div> |
| <div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <span class="keywordtype">bool</span> is_running() { <span class="keywordflow">return</span> this->state == RUNNING; }</div> |
| <div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  <span class="keywordtype">bool</span> is_paused() { <span class="keywordflow">return</span> this->state == PAUSED; }</div> |
| <div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <span class="keywordtype">bool</span> is_stopped() { <span class="keywordflow">return</span> this->state == STOPPED; }</div> |
| <div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <span class="keywordtype">bool</span> is_finished() { <span class="keywordflow">return</span> this->state == FINISHED; }</div> |
| <div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  </div> |
| <div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <a class="code" href="structblit_1_1Timer.html">Timer</a>();</div> |
| <div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <a class="code" href="structblit_1_1Timer.html">Timer</a>(TimerCallback callback, uint32_t duration, int32_t loops = -1);</div> |
| <div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  ~<a class="code" href="structblit_1_1Timer.html">Timer</a>();</div> |
| <div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  };</div> |
| <div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  </div> |
| <div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keyword">extern</span> <span class="keywordtype">void</span> <a class="code" href="namespaceblit.html#a2c89464c1a9d3da26f00ec93e77eaef1">update_timers</a>(uint32_t time);</div> |
| <div class="line"><a name="l00042"></a><span class="lineno"> 42</span> }</div> |
| <div class="ttc" id="anamespaceblit_html"><div class="ttname"><a href="namespaceblit.html">blit</a></div><div class="ttdef"><b>Definition:</b> audio.cpp:10</div></div> |
| <div class="ttc" id="anamespaceblit_html_a2c89464c1a9d3da26f00ec93e77eaef1"><div class="ttname"><a href="namespaceblit.html#a2c89464c1a9d3da26f00ec93e77eaef1">blit::update_timers</a></div><div class="ttdeci">void update_timers(uint32_t time)</div><div class="ttdef"><b>Definition:</b> timer.cpp:78</div></div> |
| <div class="ttc" id="astructblit_1_1Timer_html"><div class="ttname"><a href="structblit_1_1Timer.html">blit::Timer</a></div><div class="ttdef"><b>Definition:</b> timer.hpp:8</div></div> |
| <div class="ttc" id="astructblit_1_1Timer_html_a2f86dbc0263ba0281a4fe19588169749"><div class="ttname"><a href="structblit_1_1Timer.html#a2f86dbc0263ba0281a4fe19588169749">blit::Timer::start</a></div><div class="ttdeci">void start()</div><div class="ttdef"><b>Definition:</b> timer.cpp:40</div></div> |
| <div class="ttc" id="astructblit_1_1Timer_html_a581d2e2926103c2a0594b2ed07a73e58"><div class="ttname"><a href="structblit_1_1Timer.html#a581d2e2926103c2a0594b2ed07a73e58">blit::Timer::stop</a></div><div class="ttdeci">void stop()</div><div class="ttdef"><b>Definition:</b> timer.cpp:67</div></div> |
| <div class="ttc" id="astructblit_1_1Timer_html_afef8e53a4aaa0be11e6acd9286ac0856"><div class="ttname"><a href="structblit_1_1Timer.html#afef8e53a4aaa0be11e6acd9286ac0856">blit::Timer::init</a></div><div class="ttdeci">void init(TimerCallback callback, uint32_t duration, int32_t loops=-1)</div><div class="ttdef"><b>Definition:</b> timer.cpp:31</div></div> |
| <div class="ttc" id="astructblit_1_1Timer_html_aff99d19fafabe9afe98ed4694e39a9d3"><div class="ttname"><a href="structblit_1_1Timer.html#aff99d19fafabe9afe98ed4694e39a9d3">blit::Timer::pause</a></div><div class="ttdeci">void pause()</div><div class="ttdef"><b>Definition:</b> timer.cpp:57</div></div> |
| </div><!-- fragment --></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_996f45160da62e1a3d7f6046fad68f51.html">engine</a></li><li class="navelem"><b>timer.hpp</b></li> |
| <li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li> |
| </ul> |
| </div> |
| </body> |
| </html> |
