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

https://bitbucket.org/hugoruscitti/pilascpp · C++ Header · 51 lines · 8 code · 7 blank · 36 comment · 0 complexity · fdcdd0656f5d2ec6522e80c50d685435 MD5 · raw file

  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. #ifndef SFML_SLEEP_HPP
  25. #define SFML_SLEEP_HPP
  26. ////////////////////////////////////////////////////////////
  27. // Headers
  28. ////////////////////////////////////////////////////////////
  29. #include <SFML/Config.hpp>
  30. namespace sf
  31. {
  32. ////////////////////////////////////////////////////////////
  33. /// \ingroup system
  34. /// \brief Make the current thread sleep for a given time
  35. ///
  36. /// sf::Sleep is the best way to block a program or one of its
  37. /// threads, as it doesn't consume any CPU power.
  38. ///
  39. /// \param duration Time to sleep, in seconds (must be positive)
  40. ///
  41. ////////////////////////////////////////////////////////////
  42. void SFML_API Sleep(float duration);
  43. } // namespace sf
  44. #endif // SFML_SLEEP_HPP