From fa21c65d0c764705cfc377bf0d0de08fac26874e Mon Sep 17 00:00:00 2001 From: James Cowgill Date: Tue, 9 Dec 2014 20:21:40 +0000 Subject: Imported Upstream version 2.2.0+dfsg --- include/SFML/System/Clock.hpp | 234 +++++++++++++++++++++--------------------- 1 file changed, 117 insertions(+), 117 deletions(-) (limited to 'include/SFML/System/Clock.hpp') diff --git a/include/SFML/System/Clock.hpp b/include/SFML/System/Clock.hpp index 4ae0f2d..1ff63cb 100644 --- a/include/SFML/System/Clock.hpp +++ b/include/SFML/System/Clock.hpp @@ -1,117 +1,117 @@ -//////////////////////////////////////////////////////////// -// -// SFML - Simple and Fast Multimedia Library -// Copyright (C) 2007-2013 Laurent Gomila (laurent.gom@gmail.com) -// -// This software is provided 'as-is', without any express or implied warranty. -// In no event will the authors be held liable for any damages arising from the use of this software. -// -// Permission is granted to anyone to use this software for any purpose, -// including commercial applications, and to alter it and redistribute it freely, -// subject to the following restrictions: -// -// 1. The origin of this software must not be misrepresented; -// you must not claim that you wrote the original software. -// If you use this software in a product, an acknowledgment -// in the product documentation would be appreciated but is not required. -// -// 2. Altered source versions must be plainly marked as such, -// and must not be misrepresented as being the original software. -// -// 3. This notice may not be removed or altered from any source distribution. -// -//////////////////////////////////////////////////////////// - -#ifndef SFML_CLOCK_HPP -#define SFML_CLOCK_HPP - -//////////////////////////////////////////////////////////// -// Headers -//////////////////////////////////////////////////////////// -#include -#include - - -namespace sf -{ -//////////////////////////////////////////////////////////// -/// \brief Utility class that measures the elapsed time -/// -//////////////////////////////////////////////////////////// -class SFML_SYSTEM_API Clock -{ -public : - - //////////////////////////////////////////////////////////// - /// \brief Default constructor - /// - /// The clock starts automatically after being constructed. - /// - //////////////////////////////////////////////////////////// - Clock(); - - //////////////////////////////////////////////////////////// - /// \brief Get the elapsed time - /// - /// This function returns the time elapsed since the last call - /// to restart() (or the construction of the instance if restart() - /// has not been called). - /// - /// \return Time elapsed - /// - //////////////////////////////////////////////////////////// - Time getElapsedTime() const; - - //////////////////////////////////////////////////////////// - /// \brief Restart the clock - /// - /// This function puts the time counter back to zero. - /// It also returns the time elapsed since the clock was started. - /// - /// \return Time elapsed - /// - //////////////////////////////////////////////////////////// - Time restart(); - -private : - - //////////////////////////////////////////////////////////// - // Member data - //////////////////////////////////////////////////////////// - Time m_startTime; ///< Time of last reset, in microseconds -}; - -} // namespace sf - - -#endif // SFML_CLOCK_HPP - - -//////////////////////////////////////////////////////////// -/// \class sf::Clock -/// \ingroup system -/// -/// sf::Clock is a lightweight class for measuring time. -/// -/// Its provides the most precise time that the underlying -/// OS can achieve (generally microseconds or nanoseconds). -/// It also ensures monotonicity, which means that the returned -/// time can never go backward, even if the system time is -/// changed. -/// -/// Usage example: -/// \code -/// sf::Clock clock; -/// ... -/// Time time1 = clock.getElapsedTime(); -/// ... -/// Time time2 = clock.restart(); -/// \endcode -/// -/// The sf::Time value returned by the clock can then be -/// converted to a number of seconds, milliseconds or even -/// microseconds. -/// -/// \see sf::Time -/// -//////////////////////////////////////////////////////////// +//////////////////////////////////////////////////////////// +// +// SFML - Simple and Fast Multimedia Library +// Copyright (C) 2007-2014 Laurent Gomila (laurent.gom@gmail.com) +// +// This software is provided 'as-is', without any express or implied warranty. +// In no event will the authors be held liable for any damages arising from the use of this software. +// +// Permission is granted to anyone to use this software for any purpose, +// including commercial applications, and to alter it and redistribute it freely, +// subject to the following restrictions: +// +// 1. The origin of this software must not be misrepresented; +// you must not claim that you wrote the original software. +// If you use this software in a product, an acknowledgment +// in the product documentation would be appreciated but is not required. +// +// 2. Altered source versions must be plainly marked as such, +// and must not be misrepresented as being the original software. +// +// 3. This notice may not be removed or altered from any source distribution. +// +//////////////////////////////////////////////////////////// + +#ifndef SFML_CLOCK_HPP +#define SFML_CLOCK_HPP + +//////////////////////////////////////////////////////////// +// Headers +//////////////////////////////////////////////////////////// +#include +#include + + +namespace sf +{ +//////////////////////////////////////////////////////////// +/// \brief Utility class that measures the elapsed time +/// +//////////////////////////////////////////////////////////// +class SFML_SYSTEM_API Clock +{ +public: + + //////////////////////////////////////////////////////////// + /// \brief Default constructor + /// + /// The clock starts automatically after being constructed. + /// + //////////////////////////////////////////////////////////// + Clock(); + + //////////////////////////////////////////////////////////// + /// \brief Get the elapsed time + /// + /// This function returns the time elapsed since the last call + /// to restart() (or the construction of the instance if restart() + /// has not been called). + /// + /// \return Time elapsed + /// + //////////////////////////////////////////////////////////// + Time getElapsedTime() const; + + //////////////////////////////////////////////////////////// + /// \brief Restart the clock + /// + /// This function puts the time counter back to zero. + /// It also returns the time elapsed since the clock was started. + /// + /// \return Time elapsed + /// + //////////////////////////////////////////////////////////// + Time restart(); + +private: + + //////////////////////////////////////////////////////////// + // Member data + //////////////////////////////////////////////////////////// + Time m_startTime; ///< Time of last reset, in microseconds +}; + +} // namespace sf + + +#endif // SFML_CLOCK_HPP + + +//////////////////////////////////////////////////////////// +/// \class sf::Clock +/// \ingroup system +/// +/// sf::Clock is a lightweight class for measuring time. +/// +/// Its provides the most precise time that the underlying +/// OS can achieve (generally microseconds or nanoseconds). +/// It also ensures monotonicity, which means that the returned +/// time can never go backward, even if the system time is +/// changed. +/// +/// Usage example: +/// \code +/// sf::Clock clock; +/// ... +/// Time time1 = clock.getElapsedTime(); +/// ... +/// Time time2 = clock.restart(); +/// \endcode +/// +/// The sf::Time value returned by the clock can then be +/// converted to a number of seconds, milliseconds or even +/// microseconds. +/// +/// \see sf::Time +/// +//////////////////////////////////////////////////////////// -- cgit v1.2.3