src/timer/timer_window.h

   1 /*
   2  * This file is part of OpenTTD.
   3  * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
   4  * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
   5  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
   6  */
   7
   8 /** @file timer_window.h Definition of the Window system */
   9
  10 #ifndef TIMER_WINDOW_H
  11 #define TIMER_WINDOW_H
  12
  13 #include <chrono>
  14
  15 /**
  16  * Timer that represents the real time, usable for the Window system.
  17  *
  18  * This can be used to create intervals based on milliseconds, seconds, etc.
  19  * Mostly used for animation, scrolling, etc.
  20  *
  21  * Please be mindful that the order in which timers are called is not guaranteed.
  22  *
  23  * @note The lowest possible interval is 1ms.
  24  * @note These timers can only be used in the Window system.
  25  */
  26 class TimerWindow {
  27 public:
  28         using TPeriod = std::chrono::milliseconds;
  29         using TElapsed = std::chrono::milliseconds;
  30         struct TStorage {
  31                 std::chrono::milliseconds elapsed;
  32         };
  33 };
  34
  35 #endif /* TIMER_WINDOW_H */