OS.h File Reference

contains operating system functionality. More...

Include dependency graph for OS.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	Info
	This structure represents the version of the operating system. More...

Namespaces
	Gorgon
	Root namespace for Gorgon Game Engine.
	Gorgon::OS
	This namespace contains operating system related functionality.
	Gorgon::OS::User
	Contains user related information and services.

Functions
void	DisplayMessage (const std::string &message)
	This function shows a OS message box to display errors, for other messages its better to use in-game dialogs. More...
std::string	GetAppDataPath ()
	Returns the directory where the system wide application data is stored. More...
std::string	GetAppSettingPath ()
	Returns the directory where the system wide application settings is stored. More...
std::string	GetDataPath ()
	Returns the path where applications can save data related to this user. More...
std::string	GetDocumentsPath ()
	Returns the path where documents of the user should be saved. More...
std::string	GetEnvVar (const std::string &var)
	Returns the value of an environment variable. More...
std::string	GetHomePath ()
	Returns the home directory of the user. More...
Info	GetInfo ()
	Returns information related with the operating system, including version, name, and architecture. More...
std::string	GetName ()
	Returns the name of the current user. More...
std::string	GetName ()
	Returns the name of the current operating system in human readable form. More...
std::string	GetUsername ()
	Returns the current username. More...
void	Initialize ()
	Initializes operating system module. More...
bool	IsAdmin ()
	Check if the currently logged in user is an administrator. More...
bool	Open (const std::string &file)
	Opens the given file with the related application. More...
void	OpenTerminal ()
	Opens a terminal window to display output from the stdout. More...
void	processmessages ()
	This method will notify the system should process any messages that coming from the operating system. More...
bool	Start (const std::string &name, const std::vector< std::string > &args=std::vector< std::string >())
	Starts the given application. More...

Detailed Description

contains operating system functionality.

This file does not include any operating system headers