SFML - Simple and Fast Multimedia Library

SFML 3.1.0
Loading...
Searching...
No Matches
TimeoutWithPredicate.hpp
Go to the documentation of this file.
1
2//
3// SFML - Simple and Fast Multimedia Library
4// Copyright (C) 2007-2026 Laurent Gomila (laurent@sfml-dev.org)
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//
24
25#pragma once
26
28// Headers
30#include <SFML/System/Export.hpp>
31
32#include <SFML/System/Time.hpp>
33
34#include <functional>
35
36namespace sf
37{
38
44 class SFML_SYSTEM_API TimeoutWithPredicate
45{
46public:
56 TimeoutWithPredicate(Time timeout);
57
73 TimeoutWithPredicate(std::function<bool()> predicate, Time period = milliseconds(1));
74
81 [[nodiscard]] const std::function<bool()>& getPredicate() const;
82
89 [[nodiscard]] const Time& getPeriod() const;
90
91private:
93 // Member data
95 std::function<bool()> m_predicate;
96 Time m_period;
97};
98
99} // namespace sf
100
101
Export.hpp
SFML_SYSTEM_API
#define SFML_SYSTEM_API
Definition System/Export.hpp:42
Time.hpp
sf::Time
Represents a time value.
Definition Time.hpp:42
sf::Time::milliseconds
constexpr Time milliseconds(std::int32_t amount)
Construct a time value from a number of milliseconds.
sf::TimeoutWithPredicate::getPredicate
const std::function< bool()> & getPredicate() const
Get the predicate.
sf::TimeoutWithPredicate::TimeoutWithPredicate
TimeoutWithPredicate(std::function< bool()> predicate, Time period=milliseconds(1))
Constructor.
sf::TimeoutWithPredicate::getPeriod
const Time & getPeriod() const
Get the period.
sf::TimeoutWithPredicate::TimeoutWithPredicate
TimeoutWithPredicate(Time timeout)
Constructor.
sf
Definition AudioResource.hpp:36