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/structsf_1_1SuspendAwareClo...

279 lines
16 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="structsf_1_1SuspendAwareClock.html">SuspendAwareClock</a></li> </ul>
</div>
</div><!-- top -->
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a> &#124;
<a href="structsf_1_1SuspendAwareClock-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">sf::SuspendAwareClock Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Android, chrono-compatible, suspend-aware clock.
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="SuspendAwareClock_8hpp_source.html">SFML/System/SuspendAwareClock.hpp</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a88fd661b62a98c615ac674dac4a70ea3" id="r_a88fd661b62a98c615ac674dac4a70ea3"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a88fd661b62a98c615ac674dac4a70ea3">duration</a> = std::chrono::nanoseconds</td></tr>
<tr class="memdesc:a88fd661b62a98c615ac674dac4a70ea3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Type traits and static members. <br /></td></tr>
<tr class="separator:a88fd661b62a98c615ac674dac4a70ea3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6bc755988f5e0b9e64fc8c29e9805c37" id="r_a6bc755988f5e0b9e64fc8c29e9805c37"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a6bc755988f5e0b9e64fc8c29e9805c37">rep</a> = duration::rep</td></tr>
<tr class="separator:a6bc755988f5e0b9e64fc8c29e9805c37"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2e9f23faea43462470afc6263315a496" id="r_a2e9f23faea43462470afc6263315a496"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a2e9f23faea43462470afc6263315a496">period</a> = duration::period</td></tr>
<tr class="separator:a2e9f23faea43462470afc6263315a496"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4a86b0b99e92f831f29a50f8e6caaf0f" id="r_a4a86b0b99e92f831f29a50f8e6caaf0f"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a4a86b0b99e92f831f29a50f8e6caaf0f">time_point</a> = std::chrono::time_point&lt;<a class="el" href="structsf_1_1SuspendAwareClock.html">SuspendAwareClock</a>, <a class="el" href="#a88fd661b62a98c615ac674dac4a70ea3">duration</a>&gt;</td></tr>
<tr class="separator:a4a86b0b99e92f831f29a50f8e6caaf0f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a3d2fa25134213a987e63d6e049ad654e" id="r_a3d2fa25134213a987e63d6e049ad654e"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="#a4a86b0b99e92f831f29a50f8e6caaf0f">time_point</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a3d2fa25134213a987e63d6e049ad654e">now</a> () noexcept</td></tr>
<tr class="separator:a3d2fa25134213a987e63d6e049ad654e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-attribs" name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:a73791665d7fdce46d724f63890f815ed" id="r_a73791665d7fdce46d724f63890f815ed"><td class="memItemLeft" align="right" valign="top">static constexpr bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a73791665d7fdce46d724f63890f815ed">is_steady</a> = true</td></tr>
<tr class="separator:a73791665d7fdce46d724f63890f815ed"><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>Android, chrono-compatible, suspend-aware clock. </p>
<p>Linux steady clock is represented by <code>CLOCK_MONOTONIC</code>. However, this implementation does not work properly for long-running clocks that work in the background when the system is suspended.</p>
<p><code><a class="el" href="structsf_1_1SuspendAwareClock.html" title="Android, chrono-compatible, suspend-aware clock.">SuspendAwareClock</a></code> uses <code>CLOCK_BOOTTIME</code> which is identical to <code>CLOCK_MONOTONIC</code>, except that it also includes any time that the system is suspended.</p>
<p>Note: In most cases, <code>CLOCK_MONOTONIC</code> is a better choice. Make sure this implementation is required for your use case. </p>
<p class="definition">Definition at line <a class="el" href="SuspendAwareClock_8hpp_source.html#l00054">54</a> of file <a class="el" href="SuspendAwareClock_8hpp_source.html">SuspendAwareClock.hpp</a>.</p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="a88fd661b62a98c615ac674dac4a70ea3" name="a88fd661b62a98c615ac674dac4a70ea3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a88fd661b62a98c615ac674dac4a70ea3">&#9670;&#160;</a></span>duration</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="#a88fd661b62a98c615ac674dac4a70ea3">sf::SuspendAwareClock::duration</a> = std::chrono::nanoseconds</td>
</tr>
</table>
</div><div class="memdoc">
<p>Type traits and static members. </p>
<p>These type traits and static members meet the requirements of a <a class="el" href="classsf_1_1Clock.html" title="Utility class that measures the elapsed time.">Clock</a> concept in the C++ Standard. More specifically, TrivialClock requirements are met. Thus, naming convention has been kept consistent to allow for extended use e.g. <a href="https://en.cppreference.com/w/cpp/chrono/is_clock">https://en.cppreference.com/w/cpp/chrono/is_clock</a> </p>
<p class="definition">Definition at line <a class="el" href="SuspendAwareClock_8hpp_source.html#l00066">66</a> of file <a class="el" href="SuspendAwareClock_8hpp_source.html">SuspendAwareClock.hpp</a>.</p>
</div>
</div>
<a id="a2e9f23faea43462470afc6263315a496" name="a2e9f23faea43462470afc6263315a496"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2e9f23faea43462470afc6263315a496">&#9670;&#160;</a></span>period</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="#a2e9f23faea43462470afc6263315a496">sf::SuspendAwareClock::period</a> = duration::period</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="SuspendAwareClock_8hpp_source.html#l00068">68</a> of file <a class="el" href="SuspendAwareClock_8hpp_source.html">SuspendAwareClock.hpp</a>.</p>
</div>
</div>
<a id="a6bc755988f5e0b9e64fc8c29e9805c37" name="a6bc755988f5e0b9e64fc8c29e9805c37"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6bc755988f5e0b9e64fc8c29e9805c37">&#9670;&#160;</a></span>rep</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="#a6bc755988f5e0b9e64fc8c29e9805c37">sf::SuspendAwareClock::rep</a> = duration::rep</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="SuspendAwareClock_8hpp_source.html#l00067">67</a> of file <a class="el" href="SuspendAwareClock_8hpp_source.html">SuspendAwareClock.hpp</a>.</p>
</div>
</div>
<a id="a4a86b0b99e92f831f29a50f8e6caaf0f" name="a4a86b0b99e92f831f29a50f8e6caaf0f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4a86b0b99e92f831f29a50f8e6caaf0f">&#9670;&#160;</a></span>time_point</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="#a4a86b0b99e92f831f29a50f8e6caaf0f">sf::SuspendAwareClock::time_point</a> = std::chrono::time_point&lt;<a class="el" href="structsf_1_1SuspendAwareClock.html">SuspendAwareClock</a>, <a class="el" href="#a88fd661b62a98c615ac674dac4a70ea3">duration</a>&gt;</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="SuspendAwareClock_8hpp_source.html#l00069">69</a> of file <a class="el" href="SuspendAwareClock_8hpp_source.html">SuspendAwareClock.hpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a3d2fa25134213a987e63d6e049ad654e" name="a3d2fa25134213a987e63d6e049ad654e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3d2fa25134213a987e63d6e049ad654e">&#9670;&#160;</a></span>now()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="#a4a86b0b99e92f831f29a50f8e6caaf0f">time_point</a> sf::SuspendAwareClock::now </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">static</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a73791665d7fdce46d724f63890f815ed" name="a73791665d7fdce46d724f63890f815ed"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a73791665d7fdce46d724f63890f815ed">&#9670;&#160;</a></span>is_steady</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool sf::SuspendAwareClock::is_steady = true</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">constexpr</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="SuspendAwareClock_8hpp_source.html#l00071">71</a> of file <a class="el" href="SuspendAwareClock_8hpp_source.html">SuspendAwareClock.hpp</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="SuspendAwareClock_8hpp_source.html">SuspendAwareClock.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