blob: 675efa72ae3de9b3472cd0173d425a9ca99e3006 [file]
<!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::ParticleGenerator 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&amp;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&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('structblit_1_1ParticleGenerator.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-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structblit_1_1ParticleGenerator-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">blit::ParticleGenerator Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Collaboration diagram for blit::ParticleGenerator:</div>
<div class="dyncontent">
<div class="center"><img src="structblit_1_1ParticleGenerator__coll__graph.png" border="0" usemap="#ablit_1_1ParticleGenerator_coll__map" alt="Collaboration graph"/></div>
<map name="ablit_1_1ParticleGenerator_coll__map" id="ablit_1_1ParticleGenerator_coll__map">
<area shape="rect" title=" " alt="" coords="5,95,169,121"/>
<area shape="rect" href="structblit_1_1Vec2.html" title=" " alt="" coords="46,5,129,32"/>
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<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:ad7213c46eb5d960d816ea5b9b8d0e700"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structblit_1_1ParticleGenerator.html#ad7213c46eb5d960d816ea5b9b8d0e700">ParticleGenerator</a> (uint32_t count, uint32_t lifetime_ms, std::function&lt; <a class="el" href="structblit_1_1Particle.html">Particle</a> *(void)&gt; generate)</td></tr>
<tr class="separator:ad7213c46eb5d960d816ea5b9b8d0e700"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a54c0cb581845eecdf7bdd65e5afbe560"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structblit_1_1ParticleGenerator.html#a54c0cb581845eecdf7bdd65e5afbe560">update</a> (uint32_t time_ms)</td></tr>
<tr class="separator:a54c0cb581845eecdf7bdd65e5afbe560"><td class="memSeparator" colspan="2">&#160;</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:a1235aa8e00e5d5828008780960f648bd"><td class="memItemLeft" align="right" valign="top"><a id="a1235aa8e00e5d5828008780960f648bd"></a>
uint32_t&#160;</td><td class="memItemRight" valign="bottom"><b>count</b></td></tr>
<tr class="separator:a1235aa8e00e5d5828008780960f648bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa0efdd3ab470708f9ff3c7a6d3172fbc"><td class="memItemLeft" align="right" valign="top"><a id="aa0efdd3ab470708f9ff3c7a6d3172fbc"></a>
uint32_t&#160;</td><td class="memItemRight" valign="bottom"><b>lifetime_ms</b></td></tr>
<tr class="separator:aa0efdd3ab470708f9ff3c7a6d3172fbc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acdb37d4af9d1ac893cc39345a92611e8"><td class="memItemLeft" align="right" valign="top"><a id="acdb37d4af9d1ac893cc39345a92611e8"></a>
uint32_t&#160;</td><td class="memItemRight" valign="bottom"><b>generate_per_ms</b></td></tr>
<tr class="separator:acdb37d4af9d1ac893cc39345a92611e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2ba1565de2aed079bfb3fabef10d3c16"><td class="memItemLeft" align="right" valign="top"><a id="a2ba1565de2aed079bfb3fabef10d3c16"></a>
uint32_t&#160;</td><td class="memItemRight" valign="bottom"><b>remaining_ms</b></td></tr>
<tr class="separator:a2ba1565de2aed079bfb3fabef10d3c16"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0b378ca0c2ad20c9422bbb746d7fdb0f"><td class="memItemLeft" align="right" valign="top"><a id="a0b378ca0c2ad20c9422bbb746d7fdb0f"></a>
<a class="el" href="structblit_1_1Vec2.html">blit::Vec2</a>&#160;</td><td class="memItemRight" valign="bottom"><b>force</b></td></tr>
<tr class="separator:a0b378ca0c2ad20c9422bbb746d7fdb0f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1af46d06640f891ab9536579ef17dac1"><td class="memItemLeft" align="right" valign="top"><a id="a1af46d06640f891ab9536579ef17dac1"></a>
std::function&lt; <a class="el" href="structblit_1_1Particle.html">Particle</a> *(void)&gt;&#160;</td><td class="memItemRight" valign="bottom"><b>generate</b></td></tr>
<tr class="separator:a1af46d06640f891ab9536579ef17dac1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8b0bbcfaa3288562f7abe7b6c675b969"><td class="memItemLeft" align="right" valign="top"><a id="a8b0bbcfaa3288562f7abe7b6c675b969"></a>
std::deque&lt; <a class="el" href="structblit_1_1Particle.html">Particle</a> * &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>particles</b></td></tr>
<tr class="separator:a8b0bbcfaa3288562f7abe7b6c675b969"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ad7213c46eb5d960d816ea5b9b8d0e700"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad7213c46eb5d960d816ea5b9b8d0e700">&#9670;&nbsp;</a></span>ParticleGenerator()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">blit::ParticleGenerator::ParticleGenerator </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>count</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>lifetime_ms</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::function&lt; <a class="el" href="structblit_1_1Particle.html">Particle</a> *(void)&gt;&#160;</td>
<td class="paramname"><em>generate</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a new particle generator.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">count</td><td>Number of particles in system. </td></tr>
<tr><td class="paramname">lifetime_ms</td><td><a class="el" href="structblit_1_1Particle.html">Particle</a> lifetime in milliseconds. </td></tr>
<tr><td class="paramname">generate</td><td>callback function for generating particles. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a54c0cb581845eecdf7bdd65e5afbe560"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a54c0cb581845eecdf7bdd65e5afbe560">&#9670;&nbsp;</a></span>update()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void blit::ParticleGenerator::update </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>time_ms</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Update state of the particle system.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">time_ms</td><td><a class="el" href="structblit_1_1Particle.html">Particle</a> system age, in milliseconds. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this struct was generated from the following files:<ul>
<li>engine/<a class="el" href="particle_8hpp_source.html">particle.hpp</a></li>
<li>engine/<a class="el" href="particle_8cpp.html">particle.cpp</a></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_1ParticleGenerator.html">ParticleGenerator</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>