| <!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: blit::Tween Struct 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">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('structblit_1_1Tween.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="#pub-types">Public Types</a> | |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pub-attribs">Public Attributes</a> | |
| <a href="structblit_1_1Tween-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">blit::Tween Struct Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a> |
| Public Types</h2></td></tr> |
| <tr class="memitem:a18f9051af55b8c8a532c79631413bf1d"><td class="memItemLeft" align="right" valign="top"><a id="a18f9051af55b8c8a532c79631413bf1d"></a>enum  </td><td class="memItemRight" valign="bottom"><b>state</b> { <br /> |
|   <b>UNINITIALISED</b> |
| , <b>STOPPED</b> |
| , <b>RUNNING</b> |
| , <b>PAUSED</b> |
| , <br /> |
|   <b>FINISHED</b> |
| <br /> |
| }</td></tr> |
| <tr class="separator:a18f9051af55b8c8a532c79631413bf1d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a56e9bbf97c93d2b69a280a22986bfc78"><td class="memItemLeft" align="right" valign="top"><a id="a56e9bbf97c93d2b69a280a22986bfc78"></a> |
| using </td><td class="memItemRight" valign="bottom"><b>TweenFunction</b> = std::function< float(uint32_t t, float b, float c, uint32_t d)></td></tr> |
| <tr class="separator:a56e9bbf97c93d2b69a280a22986bfc78"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> |
| Public Member Functions</h2></td></tr> |
| <tr class="memitem:a1b34ddbae57f5497e918668c2671a696"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structblit_1_1Tween.html#a1b34ddbae57f5497e918668c2671a696">init</a> (TweenFunction function, float <a class="el" href="structblit_1_1Tween.html#a2ec25aa7fc870afff57c8e55ba2e2647">start</a>, float end, uint32_t duration, int32_t loops=-1)</td></tr> |
| <tr class="separator:a1b34ddbae57f5497e918668c2671a696"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2ec25aa7fc870afff57c8e55ba2e2647"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structblit_1_1Tween.html#a2ec25aa7fc870afff57c8e55ba2e2647">start</a> ()</td></tr> |
| <tr class="separator:a2ec25aa7fc870afff57c8e55ba2e2647"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae3b69926552d4027190ce01583a86f6b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structblit_1_1Tween.html#ae3b69926552d4027190ce01583a86f6b">pause</a> ()</td></tr> |
| <tr class="separator:ae3b69926552d4027190ce01583a86f6b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a35b4a2faa41bbb5190998079b9cb5a8f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structblit_1_1Tween.html#a35b4a2faa41bbb5190998079b9cb5a8f">stop</a> ()</td></tr> |
| <tr class="separator:a35b4a2faa41bbb5190998079b9cb5a8f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a0739412fcfd1b2c8286669ec9a83f4e9"><td class="memItemLeft" align="right" valign="top"><a id="a0739412fcfd1b2c8286669ec9a83f4e9"></a> |
| bool </td><td class="memItemRight" valign="bottom"><b>is_running</b> ()</td></tr> |
| <tr class="separator:a0739412fcfd1b2c8286669ec9a83f4e9"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae5f437a5c4caf967d2e8cb11397903b1"><td class="memItemLeft" align="right" valign="top"><a id="ae5f437a5c4caf967d2e8cb11397903b1"></a> |
| bool </td><td class="memItemRight" valign="bottom"><b>is_paused</b> ()</td></tr> |
| <tr class="separator:ae5f437a5c4caf967d2e8cb11397903b1"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aeb7a83450a01f003e0ad31bcab274211"><td class="memItemLeft" align="right" valign="top"><a id="aeb7a83450a01f003e0ad31bcab274211"></a> |
| bool </td><td class="memItemRight" valign="bottom"><b>is_stopped</b> ()</td></tr> |
| <tr class="separator:aeb7a83450a01f003e0ad31bcab274211"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a69783fa34d2ff3d6a438b2628d0d1e34"><td class="memItemLeft" align="right" valign="top"><a id="a69783fa34d2ff3d6a438b2628d0d1e34"></a> |
| bool </td><td class="memItemRight" valign="bottom"><b>is_finished</b> ()</td></tr> |
| <tr class="separator:a69783fa34d2ff3d6a438b2628d0d1e34"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:adcd3cc8652d702e78a1608d54b141ba9"><td class="memItemLeft" align="right" valign="top"><a id="adcd3cc8652d702e78a1608d54b141ba9"></a> |
|  </td><td class="memItemRight" valign="bottom"><b>Tween</b> (TweenFunction function, float <a class="el" href="structblit_1_1Tween.html#a2ec25aa7fc870afff57c8e55ba2e2647">start</a>, float end, uint32_t duration, int32_t loops=-1)</td></tr> |
| <tr class="separator:adcd3cc8652d702e78a1608d54b141ba9"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a> |
| Public Attributes</h2></td></tr> |
| <tr class="memitem:a731b2a30ae5186e691771866d1db1084"><td class="memItemLeft" align="right" valign="top"><a id="a731b2a30ae5186e691771866d1db1084"></a> |
| TweenFunction </td><td class="memItemRight" valign="bottom"><b>function</b> = nullptr</td></tr> |
| <tr class="separator:a731b2a30ae5186e691771866d1db1084"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a26ad2e38eb8844b46bfd0e9cd826f586"><td class="memItemLeft" align="right" valign="top"><a id="a26ad2e38eb8844b46bfd0e9cd826f586"></a> |
| float </td><td class="memItemRight" valign="bottom"><b>from</b> = 0.0f</td></tr> |
| <tr class="separator:a26ad2e38eb8844b46bfd0e9cd826f586"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a81accd810cfce43e1ef3225ed09a5184"><td class="memItemLeft" align="right" valign="top"><a id="a81accd810cfce43e1ef3225ed09a5184"></a> |
| float </td><td class="memItemRight" valign="bottom"><b>to</b> = 1.0f</td></tr> |
| <tr class="separator:a81accd810cfce43e1ef3225ed09a5184"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a56a5b3514a63d8262275e3df8d3f7190"><td class="memItemLeft" align="right" valign="top"><a id="a56a5b3514a63d8262275e3df8d3f7190"></a> |
| float </td><td class="memItemRight" valign="bottom"><b>value</b> = 0.0f</td></tr> |
| <tr class="separator:a56a5b3514a63d8262275e3df8d3f7190"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad007ed8f9d239987f7a0c48309f97658"><td class="memItemLeft" align="right" valign="top"><a id="ad007ed8f9d239987f7a0c48309f97658"></a> |
| uint32_t </td><td class="memItemRight" valign="bottom"><b>duration</b> = 0</td></tr> |
| <tr class="separator:ad007ed8f9d239987f7a0c48309f97658"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a671df778075f0c0de4a1f759c64125ff"><td class="memItemLeft" align="right" valign="top"><a id="a671df778075f0c0de4a1f759c64125ff"></a> |
| int32_t </td><td class="memItemRight" valign="bottom"><b>loops</b> = -1</td></tr> |
| <tr class="separator:a671df778075f0c0de4a1f759c64125ff"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3c244e021cf3c56216aa1cdd6b36cd61"><td class="memItemLeft" align="right" valign="top"><a id="a3c244e021cf3c56216aa1cdd6b36cd61"></a> |
| int32_t </td><td class="memItemRight" valign="bottom"><b>loop_count</b> = 0</td></tr> |
| <tr class="separator:a3c244e021cf3c56216aa1cdd6b36cd61"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6df298bbe48ab4df6b60af00d2dc7abe"><td class="memItemLeft" align="right" valign="top"><a id="a6df298bbe48ab4df6b60af00d2dc7abe"></a> |
| uint32_t </td><td class="memItemRight" valign="bottom"><b>started</b> = 0</td></tr> |
| <tr class="separator:a6df298bbe48ab4df6b60af00d2dc7abe"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a0553e9ec4a382e9310cdccad605b1499"><td class="memItemLeft" align="right" valign="top"><a id="a0553e9ec4a382e9310cdccad605b1499"></a> |
| uint32_t </td><td class="memItemRight" valign="bottom"><b>paused</b> = 0</td></tr> |
| <tr class="separator:a0553e9ec4a382e9310cdccad605b1499"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:acbea29400c7018f831374101276ffbd2"><td class="memItemLeft" align="right" valign="top"><a id="acbea29400c7018f831374101276ffbd2"></a> |
| uint8_t </td><td class="memItemRight" valign="bottom"><b>state</b> = UNINITIALISED</td></tr> |
| <tr class="separator:acbea29400c7018f831374101276ffbd2"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a1b34ddbae57f5497e918668c2671a696"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a1b34ddbae57f5497e918668c2671a696">◆ </a></span>init()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void blit::Tween::init </td> |
| <td>(</td> |
| <td class="paramtype">TweenFunction </td> |
| <td class="paramname"><em>function</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">float </td> |
| <td class="paramname"><em>from</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">float </td> |
| <td class="paramname"><em>to</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">uint32_t </td> |
| <td class="paramname"><em>duration</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int32_t </td> |
| <td class="paramname"><em>loops</em> = <code>-1</code> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Initialize the tween.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">function</td><td>Callback function to provide tween value. </td></tr> |
| <tr><td class="paramname">value</td><td>to tween from </td></tr> |
| <tr><td class="paramname">value</td><td>to tween to </td></tr> |
| <tr><td class="paramname">duration</td><td>Duration of the tween in milliseconds. </td></tr> |
| <tr><td class="paramname">loops</td><td>Number of times the tween should repeat, -1 = forever. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="ae3b69926552d4027190ce01583a86f6b"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ae3b69926552d4027190ce01583a86f6b">◆ </a></span>pause()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void blit::Tween::pause </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Pause the tween. </p> |
| |
| </div> |
| </div> |
| <a id="a2ec25aa7fc870afff57c8e55ba2e2647"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a2ec25aa7fc870afff57c8e55ba2e2647">◆ </a></span>start()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void blit::Tween::start </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Start the tween. </p> |
| |
| </div> |
| </div> |
| <a id="a35b4a2faa41bbb5190998079b9cb5a8f"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a35b4a2faa41bbb5190998079b9cb5a8f">◆ </a></span>stop()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void blit::Tween::stop </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Stop the running tween. </p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this struct was generated from the following files:<ul> |
| <li>engine/<a class="el" href="tweening_8hpp_source.html">tweening.hpp</a></li> |
| <li>engine/tweening.cpp</li> |
| </ul> |
| </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="namespaceblit.html">blit</a></li><li class="navelem"><a class="el" href="structblit_1_1Tween.html">Tween</a></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> |
