joseph-aquino
/
2d-platformer
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
2d-platformer/vendor/SFML-3.0.0/doc/html/classsf_1_1Clock.html

313 lines
18 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>SFML - Simple and Fast Multimedia Library</title>
<meta http-equiv="Content-Type" content="text/html;charset=UTF-8" />
<link rel="stylesheet" type="text/css" href="doxygen.css" title="default" media="screen,print" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link rel="stylesheet" type="text/css" href="search/search.css" />
<link rel="stylesheet" type="text/css" href="searchOverrides.css" />
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_search(); });
/* @license-end */
</script>
</head>
<body>
<div id="banner-container">
<div id="banner">
<span id="sfml">SFML 3.0.0</span>
</div>
</div>
<div id="content">
<div>
<!-- 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>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="topics.html"><span>Topics</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
<input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){ initResizable(false); });
/* @license-end */
</script>
<!-- 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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacesf.html">sf</a></li><li class="navelem"><a class="el" href="classsf_1_1Clock.html">Clock</a></li> </ul>
</div>
</div><!-- top -->
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classsf_1_1Clock-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">sf::Clock Class Reference<div class="ingroups"><a class="el" href="group__system.html">System module</a></div></div></div>
</div><!--header-->
<div class="contents">
<p>Utility class that measures the elapsed time.
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="Clock_8hpp_source.html">SFML/System/Clock.hpp</a>&gt;</code></p>
<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:abe889b42a65bcd8eefc16419645d08a7" id="r_abe889b42a65bcd8eefc16419645d08a7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsf_1_1Time.html">Time</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#abe889b42a65bcd8eefc16419645d08a7">getElapsedTime</a> () const</td></tr>
<tr class="memdesc:abe889b42a65bcd8eefc16419645d08a7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the elapsed time. <br /></td></tr>
<tr class="separator:abe889b42a65bcd8eefc16419645d08a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5ddfada924bece9f59f35a61eca15525" id="r_a5ddfada924bece9f59f35a61eca15525"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5ddfada924bece9f59f35a61eca15525">isRunning</a> () const</td></tr>
<tr class="memdesc:a5ddfada924bece9f59f35a61eca15525"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check whether the clock is running. <br /></td></tr>
<tr class="separator:a5ddfada924bece9f59f35a61eca15525"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a85ba4e3474ac4bb279ba7b9c9e396cea" id="r_a85ba4e3474ac4bb279ba7b9c9e396cea"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a85ba4e3474ac4bb279ba7b9c9e396cea">start</a> ()</td></tr>
<tr class="memdesc:a85ba4e3474ac4bb279ba7b9c9e396cea"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start the clock. <br /></td></tr>
<tr class="separator:a85ba4e3474ac4bb279ba7b9c9e396cea"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad2ce991ea1ccb35de32d33bf18d2a1b9" id="r_ad2ce991ea1ccb35de32d33bf18d2a1b9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad2ce991ea1ccb35de32d33bf18d2a1b9">stop</a> ()</td></tr>
<tr class="memdesc:ad2ce991ea1ccb35de32d33bf18d2a1b9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stop the clock. <br /></td></tr>
<tr class="separator:ad2ce991ea1ccb35de32d33bf18d2a1b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a123e2627f2943e5ecaa1db0c7df3231b" id="r_a123e2627f2943e5ecaa1db0c7df3231b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsf_1_1Time.html">Time</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a123e2627f2943e5ecaa1db0c7df3231b">restart</a> ()</td></tr>
<tr class="memdesc:a123e2627f2943e5ecaa1db0c7df3231b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Restart the clock. <br /></td></tr>
<tr class="separator:a123e2627f2943e5ecaa1db0c7df3231b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a564522bc9caf98b412aa0c6f39a81d75" id="r_a564522bc9caf98b412aa0c6f39a81d75"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsf_1_1Time.html">Time</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a564522bc9caf98b412aa0c6f39a81d75">reset</a> ()</td></tr>
<tr class="memdesc:a564522bc9caf98b412aa0c6f39a81d75"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reset the clock. <br /></td></tr>
<tr class="separator:a564522bc9caf98b412aa0c6f39a81d75"><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>Utility class that measures the elapsed time. </p>
<p><code><a class="el" href="classsf_1_1Clock.html" title="Utility class that measures the elapsed time.">sf::Clock</a></code> is a lightweight class for measuring time.</p>
<p>The clock starts automatically after being constructed.</p>
<p>It provides the most precise time that the underlying OS can achieve (generally microseconds or nanoseconds). It also ensures monotonicity, which means that the returned time can never go backward, even if the system time is changed.</p>
<p>Usage example: </p><div class="fragment"><div class="line"><a class="code hl_class" href="classsf_1_1Clock.html">sf::Clock</a> clock;</div>
<div class="line">...</div>
<div class="line">Time time1 = clock.<a class="code hl_function" href="#abe889b42a65bcd8eefc16419645d08a7">getElapsedTime</a>();</div>
<div class="line">...</div>
<div class="line"><a class="code hl_function" href="classsf_1_1Time.html#ac71085f83ee2bd74e005fc63d7a47a41">Time</a> time2 = clock.<a class="code hl_function" href="#a123e2627f2943e5ecaa1db0c7df3231b">restart</a>();</div>
<div class="line">...</div>
<div class="line"><a class="code hl_function" href="classsf_1_1Time.html#ac71085f83ee2bd74e005fc63d7a47a41">Time</a> time3 = clock.<a class="code hl_function" href="#a564522bc9caf98b412aa0c6f39a81d75">reset</a>();</div>
<div class="ttc" id="aclasssf_1_1Clock_html"><div class="ttname"><a href="classsf_1_1Clock.html">sf::Clock</a></div><div class="ttdoc">Utility class that measures the elapsed time.</div><div class="ttdef"><b>Definition</b> <a href="Clock_8hpp_source.html#l00091">Clock.hpp:92</a></div></div>
<div class="ttc" id="aclasssf_1_1Clock_html_a123e2627f2943e5ecaa1db0c7df3231b"><div class="ttname"><a href="#a123e2627f2943e5ecaa1db0c7df3231b">sf::Clock::restart</a></div><div class="ttdeci">Time restart()</div><div class="ttdoc">Restart the clock.</div></div>
<div class="ttc" id="aclasssf_1_1Clock_html_a564522bc9caf98b412aa0c6f39a81d75"><div class="ttname"><a href="#a564522bc9caf98b412aa0c6f39a81d75">sf::Clock::reset</a></div><div class="ttdeci">Time reset()</div><div class="ttdoc">Reset the clock.</div></div>
<div class="ttc" id="aclasssf_1_1Clock_html_abe889b42a65bcd8eefc16419645d08a7"><div class="ttname"><a href="#abe889b42a65bcd8eefc16419645d08a7">sf::Clock::getElapsedTime</a></div><div class="ttdeci">Time getElapsedTime() const</div><div class="ttdoc">Get the elapsed time.</div></div>
<div class="ttc" id="aclasssf_1_1Time_html_ac71085f83ee2bd74e005fc63d7a47a41"><div class="ttname"><a href="classsf_1_1Time.html#ac71085f83ee2bd74e005fc63d7a47a41">sf::Time::Time</a></div><div class="ttdeci">constexpr Time()=default</div><div class="ttdoc">Default constructor.</div></div>
</div><!-- fragment --><p>The <code><a class="el" href="classsf_1_1Time.html" title="Represents a time value.">sf::Time</a></code> value returned by the clock can then be converted to a number of seconds, milliseconds or even microseconds.</p>
<dl class="section see"><dt>See also</dt><dd><code><a class="el" href="classsf_1_1Time.html" title="Represents a time value.">sf::Time</a></code> </dd></dl>
<p class="definition">Definition at line <a class="el" href="Clock_8hpp_source.html#l00091">91</a> of file <a class="el" href="Clock_8hpp_source.html">Clock.hpp</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="abe889b42a65bcd8eefc16419645d08a7" name="abe889b42a65bcd8eefc16419645d08a7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abe889b42a65bcd8eefc16419645d08a7">&#9670;&#160;</a></span>getElapsedTime()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classsf_1_1Time.html">Time</a> sf::Clock::getElapsedTime </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">nodiscard</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the elapsed time. </p>
<p>This function returns the time elapsed since the last call to <code><a class="el" href="#a123e2627f2943e5ecaa1db0c7df3231b" title="Restart the clock.">restart()</a></code> (or the construction of the instance if <code><a class="el" href="#a123e2627f2943e5ecaa1db0c7df3231b" title="Restart the clock.">restart()</a></code> has not been called).</p>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classsf_1_1Time.html" title="Represents a time value.">Time</a> elapsed </dd></dl>
</div>
</div>
<a id="a5ddfada924bece9f59f35a61eca15525" name="a5ddfada924bece9f59f35a61eca15525"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5ddfada924bece9f59f35a61eca15525">&#9670;&#160;</a></span>isRunning()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool sf::Clock::isRunning </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">nodiscard</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Check whether the clock is running. </p>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if the clock is running, <code>false</code> otherwise </dd></dl>
</div>
</div>
<a id="a564522bc9caf98b412aa0c6f39a81d75" name="a564522bc9caf98b412aa0c6f39a81d75"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a564522bc9caf98b412aa0c6f39a81d75">&#9670;&#160;</a></span>reset()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classsf_1_1Time.html">Time</a> sf::Clock::reset </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Reset the clock. </p>
<p>This function puts the time counter back to zero, returns the elapsed time, and leaves the clock in a paused state.</p>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classsf_1_1Time.html" title="Represents a time value.">Time</a> elapsed</dd></dl>
<dl class="section see"><dt>See also</dt><dd><code><a class="el" href="#a123e2627f2943e5ecaa1db0c7df3231b" title="Restart the clock.">restart</a></code> </dd></dl>
</div>
</div>
<a id="a123e2627f2943e5ecaa1db0c7df3231b" name="a123e2627f2943e5ecaa1db0c7df3231b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a123e2627f2943e5ecaa1db0c7df3231b">&#9670;&#160;</a></span>restart()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classsf_1_1Time.html">Time</a> sf::Clock::restart </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Restart the clock. </p>
<p>This function puts the time counter back to zero, returns the elapsed time, and leaves the clock in a running state.</p>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classsf_1_1Time.html" title="Represents a time value.">Time</a> elapsed</dd></dl>
<dl class="section see"><dt>See also</dt><dd><code><a class="el" href="#a564522bc9caf98b412aa0c6f39a81d75" title="Reset the clock.">reset</a></code> </dd></dl>
</div>
</div>
<a id="a85ba4e3474ac4bb279ba7b9c9e396cea" name="a85ba4e3474ac4bb279ba7b9c9e396cea"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a85ba4e3474ac4bb279ba7b9c9e396cea">&#9670;&#160;</a></span>start()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void sf::Clock::start </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Start the clock. </p>
<dl class="section see"><dt>See also</dt><dd><code><a class="el" href="#ad2ce991ea1ccb35de32d33bf18d2a1b9" title="Stop the clock.">stop</a></code> </dd></dl>
</div>
</div>
<a id="ad2ce991ea1ccb35de32d33bf18d2a1b9" name="ad2ce991ea1ccb35de32d33bf18d2a1b9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad2ce991ea1ccb35de32d33bf18d2a1b9">&#9670;&#160;</a></span>stop()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void sf::Clock::stop </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Stop the clock. </p>
<dl class="section see"><dt>See also</dt><dd><code><a class="el" href="#a85ba4e3474ac4bb279ba7b9c9e396cea" title="Start the clock.">start</a></code> </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="Clock_8hpp_source.html">Clock.hpp</a></li>
</ul>
</div><!-- contents -->
</div>
<div id="footer-container">
<div id="footer">
SFML is licensed under the terms and conditions of the <a href="https://www.sfml-dev.org/license.php">zlib/png license</a>.<br />
Copyright &copy; Laurent Gomila &nbsp;::&nbsp;
Documentation generated by <a href="http://www.doxygen.org/" title="doxygen website">doxygen</a> &nbsp;::&nbsp;
</div>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink