orx  stable
Portable Game Engine
OrxSystem

Data Structures

struct  orxSYSTEM_EVENT_PAYLOAD
 

Enumerations

enum  orxSYSTEM_EVENT {
  orxSYSTEM_EVENT_CLOSE = 0, orxSYSTEM_EVENT_FOCUS_GAINED, orxSYSTEM_EVENT_FOCUS_LOST, orxSYSTEM_EVENT_BACKGROUND,
  orxSYSTEM_EVENT_FOREGROUND, orxSYSTEM_EVENT_GAME_LOOP_START, orxSYSTEM_EVENT_GAME_LOOP_STOP, orxSYSTEM_EVENT_TOUCH_BEGIN,
  orxSYSTEM_EVENT_TOUCH_MOVE, orxSYSTEM_EVENT_TOUCH_END, orxSYSTEM_EVENT_ACCELERATE, orxSYSTEM_EVENT_MOTION_SHAKE,
  orxSYSTEM_EVENT_NUMBER, orxSYSTEM_EVENT_NONE = orxENUM_NONE
}
 

Functions

orxDLLAPI void orxFASTCALL orxSystem_Delay (orxFLOAT _fSeconds)
 
orxDLLAPI void orxFASTCALL orxSystem_Exit ()
 
orxDLLAPI orxU64 orxFASTCALL orxSystem_GetRealTime ()
 
orxDLLAPI orxDOUBLE orxFASTCALL orxSystem_GetSystemTime ()
 
orxDLLAPI orxDOUBLE orxFASTCALL orxSystem_GetTime ()
 
orxDLLAPI orxVERSION *orxFASTCALL orxSystem_GetVersion (orxVERSION *_pstVersion)
 
orxDLLAPI const orxSTRING orxFASTCALL orxSystem_GetVersionFullString ()
 
orxDLLAPI orxU32 orxFASTCALL orxSystem_GetVersionNumeric ()
 
orxDLLAPI const orxSTRING orxFASTCALL orxSystem_GetVersionString ()
 
orxDLLAPI orxSTATUS orxFASTCALL orxSystem_Init ()
 
orxDLLAPI void orxFASTCALL orxSystem_Setup ()
 

Detailed Description

System file Code that handles system events and timers

Enumeration Type Documentation

Event enum

Enumerator
orxSYSTEM_EVENT_CLOSE 
orxSYSTEM_EVENT_FOCUS_GAINED 
orxSYSTEM_EVENT_FOCUS_LOST 
orxSYSTEM_EVENT_BACKGROUND 
orxSYSTEM_EVENT_FOREGROUND 
orxSYSTEM_EVENT_GAME_LOOP_START 
orxSYSTEM_EVENT_GAME_LOOP_STOP 
orxSYSTEM_EVENT_TOUCH_BEGIN 
orxSYSTEM_EVENT_TOUCH_MOVE 
orxSYSTEM_EVENT_TOUCH_END 
orxSYSTEM_EVENT_ACCELERATE 
orxSYSTEM_EVENT_MOTION_SHAKE 
orxSYSTEM_EVENT_NUMBER 
orxSYSTEM_EVENT_NONE 

Definition at line 51 of file orxSystem.h.

Function Documentation

orxDLLAPI void orxFASTCALL orxSystem_Delay ( orxFLOAT  _fSeconds)

Delay the program for given number of seconds

Parameters
[in]_fSecondsNumber of seconds to wait
orxDLLAPI void orxFASTCALL orxSystem_Exit ( )

Exits from the system module

orxDLLAPI orxU64 orxFASTCALL orxSystem_GetRealTime ( )

Gets real time (in seconds)

Returns
Returns the amount of seconds elapsed since reference time (epoch)
orxDLLAPI orxDOUBLE orxFASTCALL orxSystem_GetSystemTime ( )

Gets current internal system time (in seconds)

Returns
Current internal system time
orxDLLAPI orxDOUBLE orxFASTCALL orxSystem_GetTime ( )

Gets current time (elapsed from the beginning of the application, in seconds)

Returns
Current time
orxDLLAPI orxVERSION* orxFASTCALL orxSystem_GetVersion ( orxVERSION _pstVersion)

Gets orx version (compiled)

Parameters
[out]_pstVersionStructure to fill with current version
Returns
Compiled version
orxDLLAPI const orxSTRING orxFASTCALL orxSystem_GetVersionFullString ( )

Gets orx version literal (compiled), including build number

Returns
Compiled version literal
orxDLLAPI orxU32 orxFASTCALL orxSystem_GetVersionNumeric ( )

Gets orx version absolute numeric value (compiled)

Returns
Absolute numeric value of compiled version
orxDLLAPI const orxSTRING orxFASTCALL orxSystem_GetVersionString ( )

Gets orx version literal (compiled), excluding build number

Returns
Compiled version literal
orxDLLAPI orxSTATUS orxFASTCALL orxSystem_Init ( )

Inits the system module

Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI void orxFASTCALL orxSystem_Setup ( )

System module setup


Generated for orx by doxygen 1.5.6