Platform-specific utils. More...

#include <system.h>

Inheritance diagram for CSystemUtils:

Public Member Functions
virtual void	Init ()=0
	Performs platform-specific initialization.

virtual SystemDialogResult	SystemDialog (SystemDialogType, const std::string &title, const std::string &message)=0
	Displays a system dialog.

TEST_VIRTUAL SystemDialogResult	ConsoleSystemDialog (SystemDialogType type, const std::string &title, const std::string &message)
	Displays a fallback system dialog using console.

TEST_VIRTUAL SystemTimeStamp *	CreateTimeStamp ()
	Creates a new time stamp object.

TEST_VIRTUAL void	DestroyTimeStamp (SystemTimeStamp *stamp)
	Destroys a time stamp object.

TEST_VIRTUAL void	CopyTimeStamp (SystemTimeStamp dst, SystemTimeStamp src)
	Copies the time stamp from src to dst.

virtual void	GetCurrentTimeStamp (SystemTimeStamp *stamp)=0
	Returns a time stamp associated with current time.

TEST_VIRTUAL float	TimeStampDiff (SystemTimeStamp before, SystemTimeStamp after, SystemTimeUnit unit=STU_SEC)
	Returns a difference between two timestamps in given time unit. More...

virtual long long	TimeStampExactDiff (SystemTimeStamp before, SystemTimeStamp after)=0
	Returns the exact (in nanosecond units) difference between two timestamps. More...

virtual std::string	GetDataPath ()
	Returns the data path (containing textures, levels, helpfiles, etc)

virtual std::string	GetLangPath ()
	Returns the translations path.

virtual std::string	GetSaveDir ()
	Returns the save dir location.

virtual void	Usleep (int usecs)=0
	Sleep for given amount of microseconds.

Static Public Member Functions
static std::unique_ptr< CSystemUtils >	Create ()
	Creates system utils for specific platform.

Detailed Description

Platform-specific utils.

This class provides system-specific utilities like displaying user dialogs and querying system timers for exact timestamps.

Member Function Documentation

float CSystemUtils::TimeStampDiff	(	SystemTimeStamp *	before,
		SystemTimeStamp *	after,
		SystemTimeUnit	unit = `STU_SEC`
	)

Returns a difference between two timestamps in given time unit.

The difference is after - before.

virtual long long CSystemUtils::TimeStampExactDiff	(	SystemTimeStamp *	before,
		SystemTimeStamp *	after
	)

pure virtual

Returns the exact (in nanosecond units) difference between two timestamps.

The difference is after - before.

The documentation for this class was generated from the following files: