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

258 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 class="current"><a href="topics.html"><span>Topics</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><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><!-- top -->
<div id="doc-content">
<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 class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">System module</div></div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Angle.html">sf::Angle</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Represents an angle value. <a href="classsf_1_1Angle.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Clock.html">sf::Clock</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Utility class that measures the elapsed time. <a href="classsf_1_1Clock.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1FileInputStream.html">sf::FileInputStream</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Implementation of input stream based on a file. <a href="classsf_1_1FileInputStream.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1InputStream.html">sf::InputStream</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Abstract class for custom file input streams. <a href="classsf_1_1InputStream.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1MemoryInputStream.html">sf::MemoryInputStream</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Implementation of input stream based on a memory chunk. <a href="classsf_1_1MemoryInputStream.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1String.html">sf::String</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Utility string class that automatically handles conversions between types and encodings. <a href="classsf_1_1String.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Time.html">sf::Time</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Represents a time value. <a href="classsf_1_1Time.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Utf.html">sf::Utf&lt; N &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Utility class providing generic functions for UTF conversions. <a href="classsf_1_1Utf.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Vector2.html">sf::Vector2&lt; T &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Class template for manipulating 2-dimensional vectors. <a href="classsf_1_1Vector2.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Vector3.html">sf::Vector3&lt; T &gt;</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Utility template class for manipulating 3-dimensional vectors. <a href="classsf_1_1Vector3.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga666414341ce8396227f5a125ee5b7053" id="r_ga666414341ce8396227f5a125ee5b7053"><td class="memItemLeft" align="right" valign="top">ANativeActivity *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga666414341ce8396227f5a125ee5b7053">sf::getNativeActivity</a> ()</td></tr>
<tr class="memdesc:ga666414341ce8396227f5a125ee5b7053"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a pointer to the Android native activity. <br /></td></tr>
<tr class="separator:ga666414341ce8396227f5a125ee5b7053"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab8c0d1f966b4e5110fd370b662d8c11b" id="r_gab8c0d1f966b4e5110fd370b662d8c11b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#gab8c0d1f966b4e5110fd370b662d8c11b">sf::sleep</a> (<a class="el" href="classsf_1_1Time.html">Time</a> duration)</td></tr>
<tr class="memdesc:gab8c0d1f966b4e5110fd370b662d8c11b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Make the current thread sleep for a given duration. <br /></td></tr>
<tr class="separator:gab8c0d1f966b4e5110fd370b662d8c11b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga885486205a724571d140a7c8a0e3626b" id="r_ga885486205a724571d140a7c8a0e3626b"><td class="memItemLeft" align="right" valign="top">std::ostream &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga885486205a724571d140a7c8a0e3626b">sf::err</a> ()</td></tr>
<tr class="memdesc:ga885486205a724571d140a7c8a0e3626b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Standard stream used by SFML to output warnings and errors. <br /></td></tr>
<tr class="separator:ga885486205a724571d140a7c8a0e3626b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Base module of SFML, defining various utilities. It provides vector classes, Unicode strings and conversion functions, threads and mutexes, timing classes. </p>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga885486205a724571d140a7c8a0e3626b" name="ga885486205a724571d140a7c8a0e3626b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga885486205a724571d140a7c8a0e3626b">&#9670;&#160;</a></span>err()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::ostream &amp; sf::err </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">nodiscard</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Standard stream used by SFML to output warnings and errors. </p>
<p>By default, <code><a class="el" href="#ga885486205a724571d140a7c8a0e3626b" title="Standard stream used by SFML to output warnings and errors.">sf::err()</a></code> outputs to the same location as <code>std::cerr</code>, (-&gt; the stderr descriptor) which is the console if there's one available.</p>
<p>It is a standard <code>std::ostream</code> instance, so it supports all the insertion operations defined by the STL (<code>operator&lt;&lt;</code>, manipulators, etc.).</p>
<p><code><a class="el" href="#ga885486205a724571d140a7c8a0e3626b" title="Standard stream used by SFML to output warnings and errors.">sf::err()</a></code> can be redirected to write to another output, independently of <code>std::cerr</code>, by using the <code>rdbuf()</code> function provided by the <code>std::ostream</code> class.</p>
<p>Example: </p><div class="fragment"><div class="line"><span class="comment">// Redirect to a file</span></div>
<div class="line">std::ofstream file(<span class="stringliteral">&quot;sfml-log.txt&quot;</span>);</div>
<div class="line">std::streambuf* previous = <a class="code hl_function" href="#ga885486205a724571d140a7c8a0e3626b">sf::err</a>().rdbuf(file.rdbuf());</div>
<div class="line"> </div>
<div class="line"><span class="comment">// Redirect to nothing</span></div>
<div class="line"><a class="code hl_function" href="#ga885486205a724571d140a7c8a0e3626b">sf::err</a>().rdbuf(<span class="keyword">nullptr</span>);</div>
<div class="line"> </div>
<div class="line"><span class="comment">// Restore the original output</span></div>
<div class="line"><a class="code hl_function" href="#ga885486205a724571d140a7c8a0e3626b">sf::err</a>().rdbuf(previous);</div>
<div class="ttc" id="agroup__system_html_ga885486205a724571d140a7c8a0e3626b"><div class="ttname"><a href="#ga885486205a724571d140a7c8a0e3626b">sf::err</a></div><div class="ttdeci">std::ostream &amp; err()</div><div class="ttdoc">Standard stream used by SFML to output warnings and errors.</div></div>
</div><!-- fragment --><dl class="section return"><dt>Returns</dt><dd>Reference to <code>std::ostream</code> representing the SFML error stream </dd></dl>
</div>
</div>
<a id="ga666414341ce8396227f5a125ee5b7053" name="ga666414341ce8396227f5a125ee5b7053"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga666414341ce8396227f5a125ee5b7053">&#9670;&#160;</a></span>getNativeActivity()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ANativeActivity * sf::getNativeActivity </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">nodiscard</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return a pointer to the Android native activity. </p>
<p>You shouldn't have to use this function, unless you want to implement very specific details, that SFML doesn't support, or to use a workaround for a known issue.</p>
<dl class="section return"><dt>Returns</dt><dd>Pointer to Android native activity structure</dd></dl>
<dl class="attention">
<dt>Platform Limitation</dt>
<dd><b>This is only available on Android</b> and to use it, you'll have to specifically include <a class="el" href="NativeActivity_8hpp.html">SFML/System/NativeActivity.hpp</a> in your code.</dd>
</dl>
</div>
</div>
<a id="gab8c0d1f966b4e5110fd370b662d8c11b" name="gab8c0d1f966b4e5110fd370b662d8c11b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab8c0d1f966b4e5110fd370b662d8c11b">&#9670;&#160;</a></span>sleep()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void sf::sleep </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classsf_1_1Time.html">Time</a></td> <td class="paramname"><span class="paramname"><em>duration</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Make the current thread sleep for a given duration. </p>
<p><code><a class="el" href="#gab8c0d1f966b4e5110fd370b662d8c11b" title="Make the current thread sleep for a given duration.">sf::sleep</a></code> is the best way to block a program or one of its threads, as it doesn't consume any CPU power. Compared to the standard <code>std::this_thread::sleep_for</code> function, this one provides more accurate sleeping time thanks to some platform-specific tweaks.</p>
<p><code><a class="el" href="#gab8c0d1f966b4e5110fd370b662d8c11b" title="Make the current thread sleep for a given duration.">sf::sleep</a></code> only guarantees millisecond precision. Sleeping for a duration less than 1 millisecond is prone to result in the actual sleep duration being less than what is requested.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">duration</td><td><a class="el" href="classsf_1_1Time.html" title="Represents a time value.">Time</a> to sleep </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</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