Drag[en]gine Game Engine  1.0
deOS Class Referenceabstract

Interface for Operating System classes. More...

#include <deOS.h>

Inheritance diagram for deOS:
deOSConsole deOSUnix

Public Member Functions

Constructors and Destructors
 deOS ()
 Create a new operating system object. More...
 
virtual ~deOS ()
 Clean up the operating system object. More...
 
Management
deEngineGetEngine () 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...
 
Display information.
virtual int GetDisplayCount ()=0
 Number of displays. More...
 
virtual decPoint GetDisplayCurrentResolution (int display)=0
 Current resolution 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...
 
Casting
virtual deOSUnixCastToOSUnix ()
 Cast to deOSUnix. More...
 
virtual deOSConsoleCastToOSConsole ()
 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...
 

Detailed Description

Interface for Operating System classes.

Author
Pl├╝ss Roland
Version
1.0
Date
2015

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
deeInvalidParamNot an instance of deOSAndroid.

Referenced by GetAppActive().

◆ CastToOSBeOS()

virtual deOSBeOS* deOS::CastToOSBeOS ( )
virtual

Cast to deOSBeOS.

Exceptions
deeInvalidParamNot an instance of deOSBeOS.

Referenced by GetAppActive().

◆ CastToOSConsole()

virtual deOSConsole* deOS::CastToOSConsole ( )
virtual

Cast to deOSConsole.

Exceptions
deeInvalidParamNot an instance of deOSConsole.

Reimplemented in deOSConsole.

Referenced by GetAppActive().

◆ CastToOSUnix()

virtual deOSUnix* deOS::CastToOSUnix ( )
virtual

Cast to deOSUnix.

Exceptions
deeInvalidParamNot an instance of deOSUnix.

Reimplemented in deOSUnix.

Referenced by GetAppActive().

◆ CastToOSWindows()

virtual deOSWindows* deOS::CastToOSWindows ( )
virtual

Cast to deOSWindows.

Exceptions
deeInvalidParamNot an instance of deOSWindows.

Referenced by GetAppActive().

◆ GetAppActive()

◆ GetDisplayCount()

virtual int deOS::GetDisplayCount ( )
pure virtual

Number of displays.

Implemented in deOSUnix, and deOSConsole.

Referenced by GetAppActive().

◆ GetDisplayCurrentResolution()

virtual decPoint deOS::GetDisplayCurrentResolution ( int  display)
pure virtual

Current resolution of display.

Parameters
displayIndex of display to get current resolution for.
Exceptions
deeInvalidParamdisplay is less than 0 or equal to or greater than GetDisplayCount().

Implemented in deOSUnix, and deOSConsole.

Referenced by GetAppActive().

◆ GetDisplayResolution()

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

Resolution by index for display.

Parameters
displayIndex of display to get current resolution for.
resolutionIndex of resolution on display.
Exceptions
deeInvalidParamdisplay is less than 0 or equal to or greater than GetDisplayCount().
deeInvalidParamresolution is less than 0 or equal to or greater than GetDisplayResolutionCount(display).

Implemented in deOSUnix, and deOSConsole.

Referenced by GetAppActive().

◆ GetDisplayResolutionCount()

virtual int deOS::GetDisplayResolutionCount ( int  display)
pure virtual

Number of resolutions supported on display.

Parameters
displayIndex of display to get current resolution for.
Exceptions
deeInvalidParamdisplay is less than 0 or equal to or greater than GetDisplayCount().

Implemented in deOSUnix, and deOSConsole.

Referenced by GetAppActive().

◆ GetEngine()

deEngine* deOS::GetEngine ( ) const
inline

◆ GetPathEngine()

virtual decString deOS::GetPathEngine ( )
pure virtual

Engine path.

Implemented in deOSUnix, and deOSConsole.

Referenced by GetEngine().

◆ GetPathShare()

virtual decString deOS::GetPathShare ( )
pure virtual

Share path.

Implemented in deOSUnix, and deOSConsole.

Referenced by GetEngine().

◆ GetPathSystemConfig()

virtual decString deOS::GetPathSystemConfig ( )
pure virtual

System configuration path.

Implemented in deOSUnix, and deOSConsole.

Referenced by GetEngine().

◆ GetPathUserCache()

virtual decString deOS::GetPathUserCache ( )
pure virtual

User cache path.

Implemented in deOSUnix, and deOSConsole.

Referenced by GetEngine().

◆ GetPathUserCapture()

virtual decString deOS::GetPathUserCapture ( )
pure virtual

User capture path.

Implemented in deOSUnix, and deOSConsole.

Referenced by GetEngine().

◆ GetPathUserConfig()

virtual decString deOS::GetPathUserConfig ( )
pure virtual

User configuration path.

Implemented in deOSUnix, and deOSConsole.

Referenced by GetEngine().

◆ 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 deOSUnix, and deOSConsole.

Referenced by GetEngine().

◆ SetAppActive()

virtual void deOS::SetAppActive ( bool  active)
virtual

Set if application is active.

Sends notifications to affected engine modules if required.

Referenced by GetAppActive().

◆ SetEngine()

void deOS::SetEngine ( deEngine engine)

Set engine object or NULL if not existing.

Referenced by GetEngine().


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