Interface for Operating System classes. More...

#include <deOS.h>

Inheritance diagram for deOS:

Public Member Functions
Constructors and Destructors
	deOS ()
	Create a new operating system object. More...

virtual	~deOS ()
	Clean up the operating system object. More...

Management
deEngine *	GetEngine () const
	Engine object or NULL if not existing. More...

void	SetEngine (deEngine *engine)
	Set engine object or NULL if not existing. More...

virtual decString	GetPathEngine ()=0
	Engine path. More...

virtual decString	GetPathShare ()=0
	Share path. More...

virtual decString	GetPathSystemConfig ()=0
	System configuration path. More...

virtual decString	GetPathUserConfig ()=0
	User configuration path. More...

virtual decString	GetPathUserCache ()=0
	User cache path. More...

virtual decString	GetPathUserCapture ()=0
	User capture path. More...

virtual void	ProcessEventLoop (bool sendToInputModule)=0
	Process all events in the application event queue. More...

bool	GetAppActive () const
	Application is active. More...

virtual void	SetAppActive (bool active)
	Set if application is active. More...

virtual decString	GetUserLocaleLanguage ()=0
	Current user locale language (ISO 639 language code) in lower case. More...

virtual decString	GetUserLocaleTerritory ()=0
	Current user locale territory (ISO 3166 country code) in lower case or empty string. More...

Display information.
virtual int	GetDisplayCount ()=0
	Number of displays. More...

virtual decPoint	GetDisplayCurrentResolution (int display)=0
	Current resolution of display. More...

virtual int	GetDisplayCurrentRefreshRate (int display)=0
	Current refresh rate of display. More...

virtual int	GetDisplayResolutionCount (int display)=0
	Number of resolutions supported on display. More...

virtual decPoint	GetDisplayResolution (int display, int resolution)=0
	Resolution by index for display. More...

virtual int	GetDisplayCurrentScaleFactor (int display)=0
	Current global scaling factor for display. More...

Casting
virtual deOSUnix *	CastToOSUnix ()
	Cast to deOSUnix. More...

virtual deOSConsole *	CastToOSConsole ()
	Cast to deOSConsole. More...

virtual deOSWindows *	CastToOSWindows ()
	Cast to deOSWindows. More...

virtual deOSBeOS *	CastToOSBeOS ()
	Cast to deOSBeOS. More...

virtual deOSAndroid *	CastToOSAndroid ()
	Cast to deOSAndroid. More...

virtual deOSMacOS *	CastToOSMacOS ()
	Cast to deOSMacOS. More...

Detailed Description

Interface for Operating System classes.

Constructor & Destructor Documentation

◆ deOS()

deOS::deOS ( )

Create a new operating system object.

◆ ~deOS()

virtual deOS::~deOS ( )

virtual

Clean up the operating system object.

Member Function Documentation

◆ CastToOSAndroid()

virtual deOSAndroid* deOS::CastToOSAndroid ( )

virtual

Cast to deOSAndroid.

Exceptions

deeInvalidParam Not an instance of deOSAndroid.

◆ CastToOSBeOS()

virtual deOSBeOS* deOS::CastToOSBeOS ( )

virtual

Cast to deOSBeOS.

Exceptions

deeInvalidParam Not an instance of deOSBeOS.

◆ CastToOSConsole()

virtual deOSConsole* deOS::CastToOSConsole ( )

virtual

Cast to deOSConsole.

Exceptions

deeInvalidParam Not an instance of deOSConsole.

Reimplemented in deOSConsole.

◆ CastToOSMacOS()

virtual deOSMacOS* deOS::CastToOSMacOS ( )

virtual

Cast to deOSMacOS.

Exceptions

deeInvalidParam Not an instance of deOSMacOS.

◆ CastToOSUnix()

virtual deOSUnix* deOS::CastToOSUnix ( )

virtual

Cast to deOSUnix.

Exceptions

deeInvalidParam Not an instance of deOSUnix.

◆ CastToOSWindows()

virtual deOSWindows* deOS::CastToOSWindows ( )

virtual

Cast to deOSWindows.

Exceptions

deeInvalidParam Not an instance of deOSWindows.

◆ GetAppActive()

bool deOS::GetAppActive ( ) const

inline

Application is active.

◆ GetDisplayCount()

virtual int deOS::GetDisplayCount ( )

pure virtual

Number of displays.

Implemented in deOSConsole.

◆ GetDisplayCurrentRefreshRate()

virtual int deOS::GetDisplayCurrentRefreshRate ( int display )

pure virtual

Current refresh rate of display.

Parameters

display Index of display to get current refresh rate for.

Exceptions

deeInvalidParam display is less than 0 or equal to or greater than GetDisplayCount().

Implemented in deOSConsole.

◆ GetDisplayCurrentResolution()

virtual decPoint deOS::GetDisplayCurrentResolution ( int display )

pure virtual

Current resolution of display.

Parameters

display Index of display to get current resolution for.

Exceptions

deeInvalidParam display is less than 0 or equal to or greater than GetDisplayCount().

Implemented in deOSConsole.

◆ GetDisplayCurrentScaleFactor()

virtual int deOS::GetDisplayCurrentScaleFactor ( int display )

pure virtual

Current global scaling factor for display.

Version: 1.20.

Parameters

display Index of display to get scaling factor for.

Exceptions

deeInvalidParam display is less than 0 or equal to or greater than GetDisplayCount().

Value of 100 represents scaling of 100%. Value step size is 25.

Implemented in deOSConsole.

◆ GetDisplayResolution()

virtual decPoint deOS::GetDisplayResolution	(	int	display,
		int	resolution
	)

pure virtual

Resolution by index for display.

Parameters

display	Index of display to get current resolution for.
resolution	Index of resolution on display.

Exceptions

deeInvalidParam	display is less than 0 or equal to or greater than GetDisplayCount().
deeInvalidParam	resolution is less than 0 or equal to or greater than GetDisplayResolutionCount(display).

Implemented in deOSConsole.

◆ GetDisplayResolutionCount()

virtual int deOS::GetDisplayResolutionCount ( int display )

pure virtual

Number of resolutions supported on display.

Parameters

display Index of display to get current resolution for.

Exceptions

deeInvalidParam display is less than 0 or equal to or greater than GetDisplayCount().

Implemented in deOSConsole.

◆ GetEngine()

deEngine* deOS::GetEngine ( ) const

inline

Engine object or NULL if not existing.

◆ GetPathEngine()

virtual decString deOS::GetPathEngine ( )

pure virtual

Engine path.

Implemented in deOSConsole.

◆ GetPathShare()

virtual decString deOS::GetPathShare ( )

pure virtual

Share path.

Implemented in deOSConsole.

◆ GetPathSystemConfig()

virtual decString deOS::GetPathSystemConfig ( )

pure virtual

System configuration path.

Implemented in deOSConsole.

◆ GetPathUserCache()

virtual decString deOS::GetPathUserCache ( )

pure virtual

User cache path.

Implemented in deOSConsole.

◆ GetPathUserCapture()

virtual decString deOS::GetPathUserCapture ( )

pure virtual

User capture path.

Implemented in deOSConsole.

◆ GetPathUserConfig()

virtual decString deOS::GetPathUserConfig ( )

pure virtual

User configuration path.

Implemented in deOSConsole.

◆ GetUserLocaleLanguage()

virtual decString deOS::GetUserLocaleLanguage ( )

pure virtual

Current user locale language (ISO 639 language code) in lower case.

Version: 1.16

Implemented in deOSConsole.

◆ GetUserLocaleTerritory()

virtual decString deOS::GetUserLocaleTerritory ( )

pure virtual

Current user locale territory (ISO 3166 country code) in lower case or empty string.

Version: 1.16

Implemented in deOSConsole.

◆ ProcessEventLoop()

virtual void deOS::ProcessEventLoop ( bool sendToInputModule )

pure virtual

Process all events in the application event queue.

Certain events are directly processed. If sendToInputModule is true all events are also send to the active input module. Set sendToInputModule to false if you want to clear the event queue after a lengthy operation to avoid an event flood resulting in strange initial inputs.

Implemented in deOSConsole.

◆ SetAppActive()

virtual void deOS::SetAppActive ( bool active )

virtual

Set if application is active.

Sends notifications to affected engine modules if required.

◆ SetEngine()

void deOS::SetEngine ( deEngine * engine )

Set engine object or NULL if not existing.

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

deOS.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ deOS()

◆ ~deOS()

Member Function Documentation

◆ CastToOSAndroid()

◆ CastToOSBeOS()

◆ CastToOSConsole()

◆ CastToOSMacOS()

◆ CastToOSUnix()

◆ CastToOSWindows()

◆ GetAppActive()

◆ GetDisplayCount()

◆ GetDisplayCurrentRefreshRate()

◆ GetDisplayCurrentResolution()

◆ GetDisplayCurrentScaleFactor()

◆ GetDisplayResolution()

◆ GetDisplayResolutionCount()

◆ GetEngine()

◆ GetPathEngine()

◆ GetPathShare()

◆ GetPathSystemConfig()

◆ GetPathUserCache()

◆ GetPathUserCapture()

◆ GetPathUserConfig()

◆ GetUserLocaleLanguage()

◆ GetUserLocaleTerritory()

◆ ProcessEventLoop()

◆ SetAppActive()

◆ SetEngine()