ShibaGit/khaotic-engine-Reborn
ShibaGit/khaotic-engine-Reborn
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 11 Wiki Activity
khaotic-engine-Reborn/doxygen_docs/html/classfps__limiter.html

202 lines
9.8 KiB
HTML
Raw 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" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.12.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Khaotic Engine Reborn: fps_limiter Class 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>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.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 id="projectrow">
<td id="projectalign">
<div id="projectname">Khaotic Engine Reborn
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.12.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search',true);
$(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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('classfps__limiter.html',''); initResizable(true); });
/* @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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classfps__limiter-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">fps_limiter Class Reference</div></div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:af20845a17030a3c44b0f7e7fc08c016f" id="r_af20845a17030a3c44b0f7e7fc08c016f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af20845a17030a3c44b0f7e7fc08c016f">fps_limiter</a> (const float target_fps=60.0f)</td></tr>
<tr class="separator:af20845a17030a3c44b0f7e7fc08c016f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad0ce9120462473ec9ee26df5f5fb13cf" id="r_ad0ce9120462473ec9ee26df5f5fb13cf"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad0ce9120462473ec9ee26df5f5fb13cf">should_run</a> ()</td></tr>
<tr class="separator:ad0ce9120462473ec9ee26df5f5fb13cf"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock">
<p class="definition">Definition at line <a class="el" href="fps__limiter_8h_source.html#l00004">4</a> of file <a class="el" href="fps__limiter_8h_source.html">fps_limiter.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="af20845a17030a3c44b0f7e7fc08c016f" name="af20845a17030a3c44b0f7e7fc08c016f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af20845a17030a3c44b0f7e7fc08c016f">&#9670;&#160;</a></span>fps_limiter()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">fps_limiter::fps_limiter </td>
<td>(</td>
<td class="paramtype">const float</td> <td class="paramname"><span class="paramname"><em>target_fps</em></span><span class="paramdefsep"> = </span><span class="paramdefval">60.0f</span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Builder for <a class="el" href="classfps__limiter.html">fps_limiter</a> class This class is used to limit the execution rate of a loop based on a target frames per second (FPS). </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">target_fps</td><td>Target frames per second for the limiter. The default is 60.0f FPS. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="fps__limiter_8h_source.html#l00012">12</a> of file <a class="el" href="fps__limiter_8h_source.html">fps_limiter.h</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 13</span> : min_delta_(1.0f / target_fps), last_time_(std::chrono::high_resolution_clock::now()) {}</div>
</div><!-- fragment -->
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ad0ce9120462473ec9ee26df5f5fb13cf" name="ad0ce9120462473ec9ee26df5f5fb13cf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad0ce9120462473ec9ee26df5f5fb13cf">&#9670;&#160;</a></span>should_run()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool fps_limiter::should_run </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Function to check if enough time has passed since the last execution. </p><dl class="section return"><dt>Returns</dt><dd>True if the time since the last call is greater than or equal to the minimum delta time, otherwise false. </dd></dl>
<p class="definition">Definition at line <a class="el" href="fps__limiter_8h_source.html#l00019">19</a> of file <a class="el" href="fps__limiter_8h_source.html">fps_limiter.h</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 19</span> {</div>
<div class="line"><span class="lineno"> 20</span> <span class="keyword">const</span> <span class="keyword">auto</span> now = std::chrono::high_resolution_clock::now();</div>
<div class="line"><span class="lineno"> 21</span> <span class="keywordflow">if</span> (<span class="keyword">const</span> <span class="keywordtype">float</span> elapsed = std::chrono::duration&lt;float&gt;(now - last_time_).count(); elapsed &gt;= min_delta_) {</div>
<div class="line"><span class="lineno"> 22</span> last_time_ = now;</div>
<div class="line"><span class="lineno"> 23</span> <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
<div class="line"><span class="lineno"> 24</span> }</div>
<div class="line"><span class="lineno"> 25</span> <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><span class="lineno"> 26</span> }</div>
</div><!-- fragment -->
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>enginecustom/src/inc/system/<a class="el" href="fps__limiter_8h_source.html">fps_limiter.h</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="classfps__limiter.html">fps_limiter</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.12.0 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink