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/classtimer__class.html

305 lines
18 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: timer_class 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('classtimer__class.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="classtimer__class-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">timer_class 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:ab1807973c6bb4cca8ef3895e0a9b0e67" id="r_ab1807973c6bb4cca8ef3895e0a9b0e67"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab1807973c6bb4cca8ef3895e0a9b0e67">timer_class</a> (const <a class="el" href="classtimer__class.html">timer_class</a> &amp;)</td></tr>
<tr class="separator:ab1807973c6bb4cca8ef3895e0a9b0e67"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9d07e0dd33e2a627fc08de471d197674" id="r_a9d07e0dd33e2a627fc08de471d197674"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a9d07e0dd33e2a627fc08de471d197674">Initialize</a> ()</td></tr>
<tr class="separator:a9d07e0dd33e2a627fc08de471d197674"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a63abde3cfea4dd98cbd1e31fb9da257c" id="r_a63abde3cfea4dd98cbd1e31fb9da257c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a63abde3cfea4dd98cbd1e31fb9da257c">Frame</a> ()</td></tr>
<tr class="separator:a63abde3cfea4dd98cbd1e31fb9da257c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0de1405fe7ecb7d3b159e16fb848b5f3" id="r_a0de1405fe7ecb7d3b159e16fb848b5f3"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0de1405fe7ecb7d3b159e16fb848b5f3">GetTime</a> ()</td></tr>
<tr class="separator:a0de1405fe7ecb7d3b159e16fb848b5f3"><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="timer__class_8h_source.html#l00015">15</a> of file <a class="el" href="timer__class_8h_source.html">timer_class.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ac59280ee96e1f02628e55acd979cb24e" name="ac59280ee96e1f02628e55acd979cb24e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac59280ee96e1f02628e55acd979cb24e">&#9670;&#160;</a></span>timer_class() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">timer_class::timer_class </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="timer__class_8cpp_source.html#l00004">4</a> of file <a class="el" href="timer__class_8cpp_source.html">timer_class.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 5</span>{</div>
<div class="line"><span class="lineno"> 6</span>}</div>
</div><!-- fragment -->
</div>
</div>
<a id="ab1807973c6bb4cca8ef3895e0a9b0e67" name="ab1807973c6bb4cca8ef3895e0a9b0e67"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab1807973c6bb4cca8ef3895e0a9b0e67">&#9670;&#160;</a></span>timer_class() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">timer_class::timer_class </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classtimer__class.html">timer_class</a> &amp;</td> <td class="paramname"><span class="paramname"><em>other</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="timer__class_8cpp_source.html#l00009">9</a> of file <a class="el" href="timer__class_8cpp_source.html">timer_class.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 10</span>{</div>
<div class="line"><span class="lineno"> 11</span>}</div>
</div><!-- fragment -->
</div>
</div>
<a id="a1ca3cda567b3ead1d36e6ab1e7f609bd" name="a1ca3cda567b3ead1d36e6ab1e7f609bd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1ca3cda567b3ead1d36e6ab1e7f609bd">&#9670;&#160;</a></span>~timer_class()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">timer_class::~timer_class </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="timer__class_8cpp_source.html#l00014">14</a> of file <a class="el" href="timer__class_8cpp_source.html">timer_class.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 15</span>{</div>
<div class="line"><span class="lineno"> 16</span>}</div>
</div><!-- fragment -->
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a63abde3cfea4dd98cbd1e31fb9da257c" name="a63abde3cfea4dd98cbd1e31fb9da257c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a63abde3cfea4dd98cbd1e31fb9da257c">&#9670;&#160;</a></span>Frame()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void timer_class::Frame </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="timer__class_8cpp_source.html#l00044">44</a> of file <a class="el" href="timer__class_8cpp_source.html">timer_class.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 45</span>{</div>
<div class="line"><span class="lineno"> 46</span> INT64 currentTime;</div>
<div class="line"><span class="lineno"> 47</span> INT64 elapsedTicks;</div>
<div class="line"><span class="lineno"> 48</span> </div>
<div class="line"><span class="lineno"> 49</span> </div>
<div class="line"><span class="lineno"> 50</span> <span class="comment">// Query the current time.</span></div>
<div class="line"><span class="lineno"> 51</span> QueryPerformanceCounter((LARGE_INTEGER*)&amp;currentTime);</div>
<div class="line"><span class="lineno"> 52</span> </div>
<div class="line"><span class="lineno"> 53</span> <span class="comment">// Calculate the difference in time since the last time we queried for the current time.</span></div>
<div class="line"><span class="lineno"> 54</span> elapsedTicks = currentTime - m_startTime;</div>
<div class="line"><span class="lineno"> 55</span> </div>
<div class="line"><span class="lineno"> 56</span> <span class="comment">// Calculate the frame time.</span></div>
<div class="line"><span class="lineno"> 57</span> m_frameTime = (float)elapsedTicks / m_frequency;</div>
<div class="line"><span class="lineno"> 58</span> </div>
<div class="line"><span class="lineno"> 59</span> <span class="comment">// Restart the timer.</span></div>
<div class="line"><span class="lineno"> 60</span> m_startTime = currentTime;</div>
<div class="line"><span class="lineno"> 61</span> </div>
<div class="line"><span class="lineno"> 62</span> <span class="keywordflow">return</span>;</div>
<div class="line"><span class="lineno"> 63</span>}</div>
</div><!-- fragment -->
</div>
</div>
<a id="a0de1405fe7ecb7d3b159e16fb848b5f3" name="a0de1405fe7ecb7d3b159e16fb848b5f3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0de1405fe7ecb7d3b159e16fb848b5f3">&#9670;&#160;</a></span>GetTime()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float timer_class::GetTime </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="timer__class_8cpp_source.html#l00065">65</a> of file <a class="el" href="timer__class_8cpp_source.html">timer_class.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 66</span>{</div>
<div class="line"><span class="lineno"> 67</span> <span class="keywordflow">return</span> m_frameTime;</div>
<div class="line"><span class="lineno"> 68</span>}</div>
</div><!-- fragment -->
</div>
</div>
<a id="a9d07e0dd33e2a627fc08de471d197674" name="a9d07e0dd33e2a627fc08de471d197674"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9d07e0dd33e2a627fc08de471d197674">&#9670;&#160;</a></span>Initialize()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool timer_class::Initialize </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="timer__class_8cpp_source.html#l00018">18</a> of file <a class="el" href="timer__class_8cpp_source.html">timer_class.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 19</span>{</div>
<div class="line"><span class="lineno"> 20</span> <a class="code hl_function" href="class_logger.html#a08e3e1b899767a6d833136c9fb4f15c2">Logger::Get</a>().<a class="code hl_function" href="class_logger.html#a94f47ba0ef38ea7bcf1056f64d2645e4">Log</a>(<span class="stringliteral">&quot;Initilazing timer class&quot;</span>, __FILE__, __LINE__, Logger::LogLevel::Initialize);</div>
<div class="line"><span class="lineno"> 21</span> </div>
<div class="line"><span class="lineno"> 22</span> INT64 frequency;</div>
<div class="line"><span class="lineno"> 23</span> </div>
<div class="line"><span class="lineno"> 24</span> </div>
<div class="line"><span class="lineno"> 25</span> <span class="comment">// Get the cycles per second speed for this system.</span></div>
<div class="line"><span class="lineno"> 26</span> QueryPerformanceFrequency((LARGE_INTEGER*)&amp;frequency);</div>
<div class="line"><span class="lineno"> 27</span> <span class="keywordflow">if</span> (frequency == 0)</div>
<div class="line"><span class="lineno"> 28</span> {</div>
<div class="line"><span class="lineno"> 29</span> <a class="code hl_function" href="class_logger.html#a08e3e1b899767a6d833136c9fb4f15c2">Logger::Get</a>().<a class="code hl_function" href="class_logger.html#a94f47ba0ef38ea7bcf1056f64d2645e4">Log</a>(<span class="stringliteral">&quot;QueryPerformanceFrequency failed&quot;</span>, __FILE__, __LINE__, Logger::LogLevel::Error);</div>
<div class="line"><span class="lineno"> 30</span> <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><span class="lineno"> 31</span> }</div>
<div class="line"><span class="lineno"> 32</span> </div>
<div class="line"><span class="lineno"> 33</span> <span class="comment">// Store it in floating point.</span></div>
<div class="line"><span class="lineno"> 34</span> m_frequency = (float)frequency;</div>
<div class="line"><span class="lineno"> 35</span> </div>
<div class="line"><span class="lineno"> 36</span> <span class="comment">// Get the initial start time.</span></div>
<div class="line"><span class="lineno"> 37</span> QueryPerformanceCounter((LARGE_INTEGER*)&amp;m_startTime);</div>
<div class="line"><span class="lineno"> 38</span> </div>
<div class="line"><span class="lineno"> 39</span> <a class="code hl_function" href="class_logger.html#a08e3e1b899767a6d833136c9fb4f15c2">Logger::Get</a>().<a class="code hl_function" href="class_logger.html#a94f47ba0ef38ea7bcf1056f64d2645e4">Log</a>(<span class="stringliteral">&quot;Timer class initialized&quot;</span>, __FILE__, __LINE__, Logger::LogLevel::Initialize);</div>
<div class="line"><span class="lineno"> 40</span> </div>
<div class="line"><span class="lineno"> 41</span> <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
<div class="line"><span class="lineno"> 42</span>}</div>
<div class="ttc" id="aclass_logger_html_a08e3e1b899767a6d833136c9fb4f15c2"><div class="ttname"><a href="class_logger.html#a08e3e1b899767a6d833136c9fb4f15c2">Logger::Get</a></div><div class="ttdeci">static Logger &amp; Get()</div><div class="ttdef"><b>Definition</b> <a href="_logger_8h_source.html#l00020">Logger.h:20</a></div></div>
<div class="ttc" id="aclass_logger_html_a94f47ba0ef38ea7bcf1056f64d2645e4"><div class="ttname"><a href="class_logger.html#a94f47ba0ef38ea7bcf1056f64d2645e4">Logger::Log</a></div><div class="ttdeci">void Log(const std::string &amp;message, const std::string &amp;fileName, int lineNumber, LogLevel level=LogLevel::Info)</div><div class="ttdef"><b>Definition</b> <a href="_logger_8h_source.html#l00158">Logger.h:158</a></div></div>
</div><!-- fragment -->
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>enginecustom/src/inc/system/<a class="el" href="timer__class_8h_source.html">timer_class.h</a></li>
<li>enginecustom/src/src/system/<a class="el" href="timer__class_8cpp_source.html">timer_class.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="classtimer__class.html">timer_class</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