orx 1.16
Portable Game Engine
Loading...
Searching...
No Matches
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_DROP , orxSYSTEM_EVENT_CLIPBOARD , orxSYSTEM_EVENT_PARAM_READY , orxSYSTEM_EVENT_PARAM_DISPLAY ,
  orxSYSTEM_EVENT_NUMBER , orxSYSTEM_EVENT_NONE = orxENUM_NONE
}

Functions

orxDLLAPI void orxFASTCALL orxSystem_Delay (orxFLOAT _fSeconds)
orxDLLAPI void orxFASTCALL orxSystem_Exit ()
orxDLLAPI const orxSTRING orxFASTCALL orxSystem_GetClipboard ()
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 orxSTATUS orxFASTCALL orxSystem_SetClipboard (const orxSTRING _zValue)
orxDLLAPI void orxFASTCALL orxSystem_Setup ()

Detailed Description

System file Code that handles system events and timers

Enumeration Type Documentation

◆ orxSYSTEM_EVENT

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_DROP 
orxSYSTEM_EVENT_CLIPBOARD 
orxSYSTEM_EVENT_PARAM_READY 
orxSYSTEM_EVENT_PARAM_DISPLAY 
orxSYSTEM_EVENT_NUMBER 
orxSYSTEM_EVENT_NONE 

Definition at line 51 of file orxSystem.h.

Function Documentation

◆ orxSystem_Delay()

orxDLLAPI void orxFASTCALL orxSystem_Delay ( orxFLOAT _fSeconds)
extern

Delay the program for given number of seconds

Parameters
[in]_fSecondsNumber of seconds to wait

◆ orxSystem_Exit()

orxDLLAPI void orxFASTCALL orxSystem_Exit ( )
extern

Exits from the system module

◆ orxSystem_GetClipboard()

orxDLLAPI const orxSTRING orxFASTCALL orxSystem_GetClipboard ( )
extern

Gets clipboard's content

Returns
Clipboard's content / orxNULL, valid until next call to orxSystem_GetClipboard/orxSystem_SetClipboard

◆ orxSystem_GetRealTime()

orxDLLAPI orxU64 orxFASTCALL orxSystem_GetRealTime ( )
extern

Gets real time (in seconds)

Returns
Returns the amount of seconds elapsed since reference time (epoch)

◆ orxSystem_GetSystemTime()

orxDLLAPI orxDOUBLE orxFASTCALL orxSystem_GetSystemTime ( )
extern

Gets current internal system time (in seconds)

Returns
Current internal system time

◆ orxSystem_GetTime()

orxDLLAPI orxDOUBLE orxFASTCALL orxSystem_GetTime ( )
extern

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

Returns
Current time

◆ orxSystem_GetVersion()

orxDLLAPI orxVERSION *orxFASTCALL orxSystem_GetVersion ( orxVERSION * _pstVersion)
extern

Gets orx version (compiled)

Parameters
[out]_pstVersionStructure to fill with current version
Returns
Compiled version

◆ orxSystem_GetVersionFullString()

orxDLLAPI const orxSTRING orxFASTCALL orxSystem_GetVersionFullString ( )
extern

Gets orx version literal (compiled), including build number

Returns
Compiled version literal

◆ orxSystem_GetVersionNumeric()

orxDLLAPI orxU32 orxFASTCALL orxSystem_GetVersionNumeric ( )
extern

Gets orx version absolute numeric value (compiled)

Returns
Absolute numeric value of compiled version

◆ orxSystem_GetVersionString()

orxDLLAPI const orxSTRING orxFASTCALL orxSystem_GetVersionString ( )
extern

Gets orx version literal (compiled), excluding build number

Returns
Compiled version literal

◆ orxSystem_Init()

orxDLLAPI orxSTATUS orxFASTCALL orxSystem_Init ( )
extern

Inits the system module

Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxSystem_SetClipboard()

orxDLLAPI orxSTATUS orxFASTCALL orxSystem_SetClipboard ( const orxSTRING _zValue)
extern

Sets clipboard's content

Parameters
[in]_zValueValue to set in the clipboard, orxNULL to clear
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxSystem_Setup()

orxDLLAPI void orxFASTCALL orxSystem_Setup ( )
extern

System module setup


Generated for orx by doxygen 1.8.11