/extlibs/SFML/include/SFML/System/Sleep.hpp

 1////////////////////////////////////////////////////////////
 2//
 3// SFML - Simple and Fast Multimedia Library
 4// Copyright (C) 2007-2009 Laurent Gomila (laurent.gom@gmail.com)
 5//
 6// This software is provided 'as-is', without any express or implied warranty.
 7// In no event will the authors be held liable for any damages arising from the use of this software.
 8//
 9// Permission is granted to anyone to use this software for any purpose,
10// including commercial applications, and to alter it and redistribute it freely,
11// subject to the following restrictions:
12//
13// 1. The origin of this software must not be misrepresented;
14//    you must not claim that you wrote the original software.
15//    If you use this software in a product, an acknowledgment
16//    in the product documentation would be appreciated but is not required.
17//
18// 2. Altered source versions must be plainly marked as such,
19//    and must not be misrepresented as being the original software.
20//
21// 3. This notice may not be removed or altered from any source distribution.
22//
23////////////////////////////////////////////////////////////
24
25#ifndef SFML_SLEEP_HPP
26#define SFML_SLEEP_HPP
27
28////////////////////////////////////////////////////////////
29// Headers
30////////////////////////////////////////////////////////////
31#include <SFML/Config.hpp>
32
33
34namespace sf
35{
36////////////////////////////////////////////////////////////
37/// \ingroup system
38/// \brief Make the current thread sleep for a given time
39///
40/// sf::Sleep is the best way to block a program or one of its
41/// threads, as it doesn't consume any CPU power.
42///
43/// \param duration Time to sleep, in seconds (must be positive)
44///
45////////////////////////////////////////////////////////////
46void SFML_API Sleep(float duration);
47
48} // namespace sf
49
50
51#endif // SFML_SLEEP_HPP