Drag[en]gine Game Engine  1.0
deOSUnix Class Reference

Unix operating system. More...

#include <deOSUnix.h>

Inheritance diagram for deOSUnix:
deOS

Public Member Functions

Constructors and Destructors
 deOSUnix ()
 Create a new unix operating system object. More...
 
virtual ~deOSUnix ()
 Clean up the unix 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 deOSUnixCastToOSUnix ()
 Cast to deOSUnix. More...
 
Unix related
Display * GetDisplay () const
 Display used during creation. More...
 
int GetScreen () const
 Screen used during creation. More...
 
Window GetWindow () const
 Current game window. More...
 
void SetWindow (Window wnd)
 Set current game window. More...
 
long GetEventMask () const
 Window event mask. More...
 
void SetEventMask (long mask)
 Set event mask to set for all windows. More...
 
Window GetHostingMainWindow () const
 Hosting main window or 0 if not set. More...
 
void SetHostingMainWindow (Window window)
 Set hosting main window or 0 if not set. More...
 
Window GetHostingRenderWindow () const
 Hosting render window or 0 if not set. More...
 
void SetHostingRenderWindow (Window window)
 Set hosting render window or 0 if not set. More...
 
bool HasHostingMainWindow () const
 Determine if a hosting main window is set. More...
 
bool HasHostingRenderWindow () const
 Determine if a hosting render window is set. 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 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

Unix operating system.

Author
Pl├╝ss Roland
Version
1.0
Date
2015

Constructor & Destructor Documentation

◆ deOSUnix()

deOSUnix::deOSUnix ( )

Create a new unix operating system object.

◆ ~deOSUnix()

virtual deOSUnix::~deOSUnix ( )
virtual

Clean up the unix operating system object.

Member Function Documentation

◆ CastToOSUnix()

virtual deOSUnix* deOSUnix::CastToOSUnix ( )
virtual

Cast to deOSUnix.

Exceptions
deeInvalidParamNot an instance of deOSUnix.

Reimplemented from deOS.

◆ GetDisplay()

Display* deOSUnix::GetDisplay ( ) const
inline

Display used during creation.

◆ GetDisplayCount()

virtual int deOSUnix::GetDisplayCount ( )
virtual

Number of displays.

Implements deOS.

◆ GetDisplayCurrentResolution()

virtual decPoint deOSUnix::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 deOSUnix::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 deOSUnix::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.

◆ GetEventMask()

long deOSUnix::GetEventMask ( ) const
inline

Window event mask.

Set by the input module to receive the events it is interested in.

References SetEventMask().

◆ GetHostingMainWindow()

Window deOSUnix::GetHostingMainWindow ( ) const
inline

Hosting main window or 0 if not set.

References SetHostingMainWindow().

◆ GetHostingRenderWindow()

Window deOSUnix::GetHostingRenderWindow ( ) const
inline

Hosting render window or 0 if not set.

References HasHostingMainWindow(), HasHostingRenderWindow(), and SetHostingRenderWindow().

◆ GetPathEngine()

virtual decString deOSUnix::GetPathEngine ( )
virtual

Engine path.

Implements deOS.

◆ GetPathShare()

virtual decString deOSUnix::GetPathShare ( )
virtual

Share path.

Implements deOS.

◆ GetPathSystemConfig()

virtual decString deOSUnix::GetPathSystemConfig ( )
virtual

System configuration path.

Implements deOS.

◆ GetPathUserCache()

virtual decString deOSUnix::GetPathUserCache ( )
virtual

User cache path.

Implements deOS.

◆ GetPathUserCapture()

virtual decString deOSUnix::GetPathUserCapture ( )
virtual

User capture path.

Implements deOS.

◆ GetPathUserConfig()

virtual decString deOSUnix::GetPathUserConfig ( )
virtual

User configuration path.

Implements deOS.

◆ GetScreen()

int deOSUnix::GetScreen ( ) const
inline

Screen used during creation.

◆ GetWindow()

Window deOSUnix::GetWindow ( ) const
inline

Current game window.

This is usually the window created by the graphic module but can also be some other window. Only one window can be the application window. If you need more windows than one parent it to the window you set.

References SetWindow().

◆ HasHostingMainWindow()

bool deOSUnix::HasHostingMainWindow ( ) const

Determine if a hosting main window is set.

Referenced by GetHostingRenderWindow().

◆ HasHostingRenderWindow()

bool deOSUnix::HasHostingRenderWindow ( ) const

Determine if a hosting render window is set.

Referenced by GetHostingRenderWindow().

◆ ProcessEventLoop()

virtual void deOSUnix::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.

◆ SetEventMask()

void deOSUnix::SetEventMask ( long  mask)

Set event mask to set for all windows.

The input module sets this value to receive the required events.

Referenced by GetEventMask().

◆ SetHostingMainWindow()

void deOSUnix::SetHostingMainWindow ( Window  window)

Set hosting main window or 0 if not set.

Hosting windows are useful to render into a specific application window instead of the default game window. The hosting main window is the main window of the hosting application that can be used to obtain visuals from. It is not necessary the one rendered into later on.

Referenced by GetHostingMainWindow().

◆ SetHostingRenderWindow()

void deOSUnix::SetHostingRenderWindow ( Window  window)

Set hosting render window or 0 if not set.

Hosting windows are useful to render into a specific application window instead of the default game window. The hosting render window is the window on which the graphic module has to render from now on. This window can be the same as the hosting main window but can also be different from it.

Referenced by GetHostingRenderWindow().

◆ SetWindow()

void deOSUnix::SetWindow ( Window  wnd)

Set current game window.

This is usually the window created by the graphic module but can also be some other window. Only one window can be the application window. If you need more windows than one parent it to the window you set. To remove the window specify NULL as window handler. Always set your window as otherwise input modules relying on message or event queues will not get them.

Referenced by GetWindow().


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