documentation/3.0.1/Clock_8hpp_source.html

//

// SFML - Simple and Fast Multimedia Library

// Copyright (C) 2007-2025 Laurent Gomila (laurent@sfml-dev.org)

//

// 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.

//


#pragma once


// Headers

#include <SFML/System/Export.hpp>


#include <chrono>

#include <ratio>

#include <type_traits>


#ifdef SFML_SYSTEM_ANDROID

#include <SFML/System/SuspendAwareClock.hpp>

#endif


namespace sf

{

namespace priv

{


#if defined(SFML_SYSTEM_ANDROID) && defined(SFML_ANDROID_USE_SUSPEND_AWARE_CLOCK)

using ClockImpl = SuspendAwareClock;

#else

using ClockImpl = std::conditional_t<std::chrono::high_resolution_clock::is_steady, std::chrono::high_resolution_clock, std::chrono::steady_clock>;

#endif


static_assert(ClockImpl::is_steady, "Provided implementation is not a monotonic clock");

static_assert(std::ratio_less_equal_v<ClockImpl::period, std::micro>,

              "Clock resolution is too low. Expecting at least a microsecond precision");


} // namespace priv


class Time;


class SFML_SYSTEM_API Clock

{

public:

    [[nodiscard]] Time getElapsedTime() const;


    [[nodiscard]] bool isRunning() const;


    void start();


    void stop();


    Time restart();


    Time reset();


private:

    // Member data

    priv::ClockImpl::time_point m_refPoint{priv::ClockImpl::now()};

    priv::ClockImpl::time_point m_stopPoint;

};


} // namespace sf


SuspendAwareClock.hpp

Export.hpp

SFML_SYSTEM_API
#define SFML_SYSTEM_API
Definition System/Export.hpp:42

sf::Clock
Utility class that measures the elapsed time.
Definition Clock.hpp:92

sf::Clock::restart
Time restart()
Restart the clock.

sf::Clock::reset
Time reset()
Reset the clock.

sf::Clock::isRunning
bool isRunning() const
Check whether the clock is running.

sf::Clock::start
void start()
Start the clock.

sf::Clock::getElapsedTime
Time getElapsedTime() const
Get the elapsed time.

sf::Clock::stop
void stop()
Stop the clock.

sf::Time
Represents a time value.
Definition Time.hpp:42

sf
Definition AudioResource.hpp:36