Drag[en]gine Game Engine  1.0
deOSConsole Class Reference

Console operating system. More...

#include <deOSConsole.h>

Inheritance diagram for deOSConsole:
deOS

Public Member Functions

Constructors and Destructors
 deOSConsole ()
 Create a new console operating system object. More...
 
virtual ~deOSConsole ()
 Clean up the console operating system object. More...
 
Management
virtual decString GetPathEngine ()
 Engine path. More...
 
virtual decString GetPathShare ()
 Share path. More...
 
virtual decString GetPathSystemConfig ()
 System configuration path. More...
 
virtual decString GetPathUserConfig ()
 User configuration path. More...
 
virtual decString GetPathUserCache ()
 User cache path. More...
 
virtual decString GetPathUserCapture ()
 User capture path. More...
 
virtual void ProcessEventLoop (bool sendToInputModule)
 Process all events in the application event queue. More...
 
Display information.
virtual int GetDisplayCount ()
 Number of displays. More...
 
virtual decPoint GetDisplayCurrentResolution (int display)
 Current resolution of display. More...
 
virtual int GetDisplayResolutionCount (int display)
 Number of resolutions supported on display. More...
 
virtual decPoint GetDisplayResolution (int display, int resolution)
 Resolution by index for display. More...
 
Casting
virtual deOSConsoleCastToOSConsole ()
 Cast to deOSConsole. More...
 
- Public Member Functions inherited from deOS
 deOS ()
 Create a new operating system object. More...
 
virtual ~deOS ()
 Clean up the operating system object. More...
 
deEngineGetEngine () const
 Engine object or NULL if not existing. More...
 
void SetEngine (deEngine *engine)
 Set engine object or NULL if not existing. More...
 
bool GetAppActive () const
 Application is active. More...
 
virtual void SetAppActive (bool active)
 Set if application is active. More...
 
virtual deOSUnixCastToOSUnix ()
 Cast to deOSUnix. More...
 
virtual deOSWindows * CastToOSWindows ()
 Cast to deOSWindows. More...
 
virtual deOSBeOS * CastToOSBeOS ()
 Cast to deOSBeOS. More...
 
virtual deOSAndroid * CastToOSAndroid ()
 Cast to deOSAndroid. More...
 

Detailed Description

Console operating system.

Supports operating systems or configurations only exposing a text console without any graphics support.

Author
Pl├╝ss Roland
Version
1.0
Date
2015

Constructor & Destructor Documentation

◆ deOSConsole()

deOSConsole::deOSConsole ( )

Create a new console operating system object.

◆ ~deOSConsole()

virtual deOSConsole::~deOSConsole ( )
virtual

Clean up the console operating system object.

Member Function Documentation

◆ CastToOSConsole()

virtual deOSConsole* deOSConsole::CastToOSConsole ( )
virtual

Cast to deOSConsole.

Exceptions
deeInvalidParamNot an instance of deOSConsole.

Reimplemented from deOS.

◆ GetDisplayCount()

virtual int deOSConsole::GetDisplayCount ( )
virtual

Number of displays.

Implements deOS.

◆ GetDisplayCurrentResolution()

virtual decPoint deOSConsole::GetDisplayCurrentResolution ( int  display)
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().

Implements deOS.

◆ GetDisplayResolution()

virtual decPoint deOSConsole::GetDisplayResolution ( int  display,
int  resolution 
)
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).

Implements deOS.

◆ GetDisplayResolutionCount()

virtual int deOSConsole::GetDisplayResolutionCount ( int  display)
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().

Implements deOS.

◆ GetPathEngine()

virtual decString deOSConsole::GetPathEngine ( )
virtual

Engine path.

Implements deOS.

◆ GetPathShare()

virtual decString deOSConsole::GetPathShare ( )
virtual

Share path.

Implements deOS.

◆ GetPathSystemConfig()

virtual decString deOSConsole::GetPathSystemConfig ( )
virtual

System configuration path.

Implements deOS.

◆ GetPathUserCache()

virtual decString deOSConsole::GetPathUserCache ( )
virtual

User cache path.

Implements deOS.

◆ GetPathUserCapture()

virtual decString deOSConsole::GetPathUserCapture ( )
virtual

User capture path.

Implements deOS.

◆ GetPathUserConfig()

virtual decString deOSConsole::GetPathUserConfig ( )
virtual

User configuration path.

Implements deOS.

◆ ProcessEventLoop()

virtual void deOSConsole::ProcessEventLoop ( bool  sendToInputModule)
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.

Implements deOS.


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