path: root/src/base/time.hpp

/*
 * UltraStar Deluxe - Karaoke Game
 *
 * UltraStar Deluxe is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * This program 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; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program 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.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; see the file COPYING. If not, write to
 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA.
 *
 */

#ifndef TIME_HPP
#define TIME_HPP

namespace usdx
{
	/**
	 * Simple static-only wrapper class to get a time. This time does not need
	 * to correspond to the real clock. It should only be a changing number,
	 * that change at the same speed like the real clock. The current
	 * implementation uses SDL and returns the milliseconds since initialization
	 * of the library.
	 */
	class Time
	{
	protected:
		/**
		 * Protected constructor. This class currently contains only static
		   methods. So there should no need to create an instance of it.
		 */
		Time(void);

	public:
		/**
		 * Returns the current "time" as milliseconds.
		 */
		static float get_time();
	};
};

#endif