SFML/System/Sleep.hpp

0001 ////////////////////////////////////////////////////////////
0002 //
0003 // SFML - Simple and Fast Multimedia Library
0004 // Copyright (C) 2007-2023 Laurent Gomila (laurent@sfml-dev.org)
0005 //
0006 // This software is provided 'as-is', without any express or implied warranty.
0007 // In no event will the authors be held liable for any damages arising from the use of this software.
0008 //
0009 // Permission is granted to anyone to use this software for any purpose,
0010 // including commercial applications, and to alter it and redistribute it freely,
0011 // subject to the following restrictions:
0012 //
0013 // 1. The origin of this software must not be misrepresented;
0014 //    you must not claim that you wrote the original software.
0015 //    If you use this software in a product, an acknowledgment
0016 //    in the product documentation would be appreciated but is not required.
0017 //
0018 // 2. Altered source versions must be plainly marked as such,
0019 //    and must not be misrepresented as being the original software.
0020 //
0021 // 3. This notice may not be removed or altered from any source distribution.
0022 //
0023 ////////////////////////////////////////////////////////////
0024
0025 #ifndef SFML_SLEEP_HPP
0026 #define SFML_SLEEP_HPP
0027
0028 ////////////////////////////////////////////////////////////
0029 // Headers
0030 ////////////////////////////////////////////////////////////
0031 #include <SFML/System/Export.hpp>
0032 #include <SFML/System/Time.hpp>
0033
0034
0035 namespace sf
0036 {
0037 ////////////////////////////////////////////////////////////
0038 /// \ingroup system
0039 /// \brief Make the current thread sleep for a given duration
0040 ///
0041 /// sf::sleep is the best way to block a program or one of its
0042 /// threads, as it doesn't consume any CPU power.
0043 ///
0044 /// \param duration Time to sleep
0045 ///
0046 ////////////////////////////////////////////////////////////
0047 void SFML_SYSTEM_API sleep(Time duration);
0048
0049 } // namespace sf
0050
0051
0052 #endif // SFML_SLEEP_HPP