<!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;"/>
<meta charset="utf-8"/>
<!--<link rel='stylesheet' type='text/css' href="https://fonts.googleapis.com/css?family=Ubuntu:400,700,400italic"/>-->
<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>
</head>
<body>
<div id="banner-container">
<div id="banner">
<span id="sfml">SFML 2.5.1</span>
</div>
</div>
<div id="content">
<!-- Generated by Doxygen 1.8.14 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li class="current"><a href="modules.html"><span>Modules</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>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">System module</div> </div>
</div><!--header-->
<div class="contents">
<p>Base module of SFML, defining various utilities.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </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"> </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"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </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"> </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"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </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"> </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"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Lock.html">sf::Lock</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Automatic wrapper for locking and unlocking mutexes. <a href="classsf_1_1Lock.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </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"> </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"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Mutex.html">sf::Mutex</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Blocks concurrent access to shared resources from multiple threads. <a href="classsf_1_1Mutex.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1NonCopyable.html">sf::NonCopyable</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Utility class that makes any derived class non-copyable. <a href="classsf_1_1NonCopyable.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </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"> </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"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Thread.html">sf::Thread</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Utility class to manipulate threads. <a href="classsf_1_1Thread.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1ThreadLocal.html">sf::ThreadLocal</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Defines variables with thread-local storage. <a href="classsf_1_1ThreadLocal.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1ThreadLocalPtr.html">sf::ThreadLocalPtr< T ></a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to a thread-local variable. <a href="classsf_1_1ThreadLocalPtr.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </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"> </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"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Utf.html">sf::Utf< N ></a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </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"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Vector2.html">sf::Vector2< T ></a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Utility template class 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"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Vector3.html">sf::Vector3< T ></a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </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"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga235cf5cded738208fc8f28a5b67b371a"><td class="memItemLeft" align="right" valign="top">ANativeActivity * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__system.html#ga235cf5cded738208fc8f28a5b67b371a">sf::getNativeActivity</a> ()</td></tr>
<tr class="memdesc:ga235cf5cded738208fc8f28a5b67b371a"><td class="mdescLeft"> </td><td class="mdescRight">Return a pointer to the Android native activity. <a href="group__system.html#ga235cf5cded738208fc8f28a5b67b371a">More...</a><br /></td></tr>
<tr class="separator:ga235cf5cded738208fc8f28a5b67b371a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab8c0d1f966b4e5110fd370b662d8c11b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__system.html#gab8c0d1f966b4e5110fd370b662d8c11b">sf::sleep</a> (<a class="el" href="classsf_1_1Time.html">Time</a> duration)</td></tr>
<tr class="memdesc:gab8c0d1f966b4e5110fd370b662d8c11b"><td class="mdescLeft"> </td><td class="mdescRight">Make the current thread sleep for a given duration. <a href="group__system.html#gab8c0d1f966b4e5110fd370b662d8c11b">More...</a><br /></td></tr>
<tr class="separator:gab8c0d1f966b4e5110fd370b662d8c11b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7fe7f475639e26334606b5142c29551f"><td class="memItemLeft" align="right" valign="top">std::ostream & </td><td class="memItemRight" valign="bottom"><a class="el" href="group__system.html#ga7fe7f475639e26334606b5142c29551f">sf::err</a> ()</td></tr>
<tr class="memdesc:ga7fe7f475639e26334606b5142c29551f"><td class="mdescLeft"> </td><td class="mdescRight">Standard stream used by SFML to output warnings and errors. <a href="group__system.html#ga7fe7f475639e26334606b5142c29551f">More...</a><br /></td></tr>
<tr class="separator:ga7fe7f475639e26334606b5142c29551f"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Base module of SFML, defining various utilities. </p>
<p>It provides vector classes, Unicode strings and conversion functions, threads and mutexes, timing classes. </p>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga7fe7f475639e26334606b5142c29551f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga7fe7f475639e26334606b5142c29551f">◆ </a></span>err()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">sf::err </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Standard stream used by SFML to output warnings and errors. </p>
<p>By default, <a class="el" href="group__system.html#ga7fe7f475639e26334606b5142c29551f" title="Standard stream used by SFML to output warnings and errors. ">sf::err()</a> outputs to the same location as std::cerr, (-> the stderr descriptor) which is the console if there's one available.</p>
<p>It is a standard std::ostream instance, so it supports all the insertion operations defined by the STL (operator <<, manipulators, etc.).</p>
<p><a class="el" href="group__system.html#ga7fe7f475639e26334606b5142c29551f" title="Standard stream used by SFML to output warnings and errors. ">sf::err()</a> can be redirected to write to another output, independently of std::cerr, by using the rdbuf() function provided by the std::ostream 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">"sfml-log.txt"</span>);</div><div class="line">std::streambuf* previous = <a class="code" href="group__system.html#ga7fe7f475639e26334606b5142c29551f">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" href="group__system.html#ga7fe7f475639e26334606b5142c29551f">sf::err</a>().rdbuf(NULL);</div><div class="line"></div><div class="line"><span class="comment">// Restore the original output</span></div><div class="line"><a class="code" href="group__system.html#ga7fe7f475639e26334606b5142c29551f">sf::err</a>().rdbuf(previous);</div></div><!-- fragment --><dl class="section return"><dt>Returns</dt><dd>Reference to std::ostream representing the SFML error stream </dd></dl>
</div>
</div>
<a id="ga235cf5cded738208fc8f28a5b67b371a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga235cf5cded738208fc8f28a5b67b371a">◆ </a></span>getNativeActivity()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ANativeActivity* sf::getNativeActivity </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></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_source.html">SFML/System/NativeActivity.hpp</a> in your code.</dd>
</dl>
</div>
</div>
<a id="gab8c0d1f966b4e5110fd370b662d8c11b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab8c0d1f966b4e5110fd370b662d8c11b">◆ </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"><em>duration</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Make the current thread sleep for a given duration. </p>
<p>sf::sleep is the best way to block a program or one of its threads, as it doesn't consume any CPU power.</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 © Laurent Gomila ::
Documentation generated by <a href="http://www.doxygen.org/" title="doxygen website">doxygen</a> ::
</div>
</div>
</body>
</html>