Time.hpp

Go to the documentation of this file.

//
// SFML - Simple and Fast Multimedia Library
// Copyright (C) 2007-2024 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 <chrono>
 
#include <cstdint>
 
 
namespace sf
{
class Time
{
public:
    constexpr Time() = default;

    template <typename Rep, typename Period>
    constexpr Time(const std::chrono::duration<Rep, Period>& duration);

    [[nodiscard]] constexpr float asSeconds() const;

    [[nodiscard]] constexpr std::int32_t asMilliseconds() const;

    [[nodiscard]] constexpr std::int64_t asMicroseconds() const;

    [[nodiscard]] constexpr std::chrono::microseconds toDuration() const;

    template <typename Rep, typename Period>
    constexpr operator std::chrono::duration<Rep, Period>() const;

    // Static member data
    // NOLINTNEXTLINE(readability-identifier-naming)
    static const Time Zero; 
 
private:
    friend constexpr Time seconds(float);
    friend constexpr Time milliseconds(std::int32_t);
    friend constexpr Time microseconds(std::int64_t);

    // Member data
    std::chrono::microseconds m_microseconds{}; 
};

[[nodiscard]] constexpr Time seconds(float amount);

[[nodiscard]] constexpr Time milliseconds(std::int32_t amount);

[[nodiscard]] constexpr Time microseconds(std::int64_t amount);

[[nodiscard]] constexpr bool operator==(Time left, Time right);

[[nodiscard]] constexpr bool operator!=(Time left, Time right);

[[nodiscard]] constexpr bool operator<(Time left, Time right);

[[nodiscard]] constexpr bool operator>(Time left, Time right);

[[nodiscard]] constexpr bool operator<=(Time left, Time right);

[[nodiscard]] constexpr bool operator>=(Time left, Time right);

[[nodiscard]] constexpr Time operator-(Time right);

[[nodiscard]] constexpr Time operator+(Time left, Time right);

constexpr Time& operator+=(Time& left, Time right);

[[nodiscard]] constexpr Time operator-(Time left, Time right);

constexpr Time& operator-=(Time& left, Time right);

[[nodiscard]] constexpr Time operator*(Time left, float right);

[[nodiscard]] constexpr Time operator*(Time left, std::int64_t right);

[[nodiscard]] constexpr Time operator*(float left, Time right);

[[nodiscard]] constexpr Time operator*(std::int64_t left, Time right);

constexpr Time& operator*=(Time& left, float right);

constexpr Time& operator*=(Time& left, std::int64_t right);

[[nodiscard]] constexpr Time operator/(Time left, float right);

[[nodiscard]] constexpr Time operator/(Time left, std::int64_t right);

constexpr Time& operator/=(Time& left, float right);

constexpr Time& operator/=(Time& left, std::int64_t right);

[[nodiscard]] constexpr float operator/(Time left, Time right);

[[nodiscard]] constexpr Time operator%(Time left, Time right);

constexpr Time& operator%=(Time& left, Time right);
 
} // namespace sf
 
#include <SFML/System/Time.inl>