orx
1.11
Portable Game Engine
|
Data Structures | |
struct | orxCLOCK_INFO |
Macros | |
#define | orxCLOCK_KU32_CLOCK_BANK_SIZE 16 |
#define | orxCLOCK_KU32_FUNCTION_BANK_SIZE 16 |
#define | orxCLOCK_KU32_TIMER_BANK_SIZE 32 |
Typedefs | |
typedef struct __orxCLOCK_t | orxCLOCK |
typedef void(orxFASTCALL * | orxCLOCK_FUNCTION) (const orxCLOCK_INFO *_pstClockInfo, void *_pContext) |
Enumerations | |
enum | orxCLOCK_EVENT { orxCLOCK_EVENT_RESTART = 0, orxCLOCK_EVENT_RESYNC, orxCLOCK_EVENT_PAUSE, orxCLOCK_EVENT_UNPAUSE, orxCLOCK_EVENT_NUMBER, orxCLOCK_EVENT_NONE = orxENUM_NONE } |
enum | orxCLOCK_MOD_TYPE { orxCLOCK_MOD_TYPE_FIXED = 0, orxCLOCK_MOD_TYPE_MULTIPLY, orxCLOCK_MOD_TYPE_MAXED, orxCLOCK_MOD_TYPE_NUMBER, orxCLOCK_MOD_TYPE_NONE = orxENUM_NONE } |
enum | orxCLOCK_PRIORITY { orxCLOCK_PRIORITY_LOWEST = 0, orxCLOCK_PRIORITY_LOWER, orxCLOCK_PRIORITY_LOW, orxCLOCK_PRIORITY_NORMAL, orxCLOCK_PRIORITY_HIGH, orxCLOCK_PRIORITY_HIGHER, orxCLOCK_PRIORITY_HIGHEST, orxCLOCK_PRIORITY_NUMBER, orxCLOCK_PRIORITY_NONE = orxENUM_NONE } |
enum | orxCLOCK_TYPE { orxCLOCK_TYPE_CORE = 0, orxCLOCK_TYPE_USER, orxCLOCK_TYPE_SECOND, orxCLOCK_TYPE_NUMBER, orxCLOCK_TYPE_NONE = orxENUM_NONE } |
Clock module Module that handles clocks which is the low level kernel part of orx execution.
#define orxCLOCK_KU32_CLOCK_BANK_SIZE 16 |
Clock bank size
Definition at line 51 of file orxClock.h.
#define orxCLOCK_KU32_FUNCTION_BANK_SIZE 16 |
Function bank size
Definition at line 54 of file orxClock.h.
#define orxCLOCK_KU32_TIMER_BANK_SIZE 32 |
Timer bank size
Definition at line 52 of file orxClock.h.
typedef struct __orxCLOCK_t orxCLOCK |
Clock structure
Definition at line 138 of file orxClock.h.
typedef void(orxFASTCALL * orxCLOCK_FUNCTION) (const orxCLOCK_INFO *_pstClockInfo, void *_pContext) |
Clock callback function type to use with clock bindings
Definition at line 141 of file orxClock.h.
enum orxCLOCK_EVENT |
Event enum
Definition at line 123 of file orxClock.h.
enum orxCLOCK_MOD_TYPE |
Clock mod type enum
Definition at line 75 of file orxClock.h.
enum orxCLOCK_PRIORITY |
Clock priority
Definition at line 90 of file orxClock.h.
enum orxCLOCK_TYPE |
Clock type enum
Enumerator | |
---|---|
orxCLOCK_TYPE_CORE | |
orxCLOCK_TYPE_USER | |
orxCLOCK_TYPE_SECOND | |
orxCLOCK_TYPE_NUMBER | |
orxCLOCK_TYPE_NONE |
Definition at line 59 of file orxClock.h.
orxDLLAPI orxSTATUS orxFASTCALL orxClock_AddGlobalTimer | ( | const orxCLOCK_FUNCTION | _pfnCallback, |
orxFLOAT | _fDelay, | ||
orxS32 | _s32Repetition, | ||
void * | _pContext | ||
) |
Adds a global timer function (ie. using the main core clock)
[in] | _pfnCallback | Concerned timer callback |
[in] | _fDelay | Timer's delay between 2 calls, must be strictly positive |
[in] | _s32Repetition | Number of times this timer should be called before removed, -1 for infinite |
[in] | _pContext | Context that will be transmitted to the callback when called |
orxDLLAPI orxSTATUS orxFASTCALL orxClock_AddTimer | ( | orxCLOCK * | _pstClock, |
const orxCLOCK_FUNCTION | _pfnCallback, | ||
orxFLOAT | _fDelay, | ||
orxS32 | _s32Repetition, | ||
void * | _pContext | ||
) |
Adds a timer function to a clock
[in] | _pstClock | Concerned clock |
[in] | _pfnCallback | Concerned timer callback |
[in] | _fDelay | Timer's delay between 2 calls, must be strictly positive |
[in] | _s32Repetition | Number of times this timer should be called before removed, -1 for infinite |
[in] | _pContext | Context that will be transmitted to the callback when called |
orxDLLAPI orxCLOCK* orxFASTCALL orxClock_Create | ( | orxFLOAT | _fTickSize, |
orxCLOCK_TYPE | _eType | ||
) |
Creates a clock
[in] | _fTickSize | Tick size for the clock (in seconds) |
[in] | _eType | Type of the clock |
Creates a clock from config
[in] | _zConfigID | Config ID @ return orxCLOCK / orxNULL |
Deletes a clock
[in] | _pstClock | Concerned clock |
orxDLLAPI orxCLOCK* orxFASTCALL orxClock_FindFirst | ( | orxFLOAT | _fTickSize, |
orxCLOCK_TYPE | _eType | ||
) |
Finds a clock given its tick size and its type
[in] | _fTickSize | Tick size of the desired clock (in seconds) |
[in] | _eType | Type of the desired clock |
Finds next clock of same type/tick size
[in] | _pstClock | Concerned clock |
Gets clock given its name
[in] | _zName | Clock name |
orxDLLAPI void* orxFASTCALL orxClock_GetContext | ( | const orxCLOCK * | _pstClock, |
const orxCLOCK_FUNCTION | _pfnCallback | ||
) |
Gets a callback function context
[in] | _pstClock | Concerned clock |
[in] | _pfnCallback | Concerned callback |
orxDLLAPI orxCLOCK* orxFASTCALL orxClock_GetFromInfo | ( | const orxCLOCK_INFO * | _pstClockInfo | ) |
Gets clock from its info
[in] | _pstClockInfo | Concerned clock info |
orxDLLAPI const orxCLOCK_INFO* orxFASTCALL orxClock_GetInfo | ( | const orxCLOCK * | _pstClock | ) |
Gets clock config name
[in] | _pstClock | Concerned clock |
Gets next existing clock in list (can be used to parse all existing clocks)
[in] | _pstClock | Concerned clock |
Inits the clock module
Is a clock paused?
[in] | _pstClock | Concerned clock |
Pauses a clock
[in] | _pstClock | Concerned clock |
orxDLLAPI orxSTATUS orxFASTCALL orxClock_Register | ( | orxCLOCK * | _pstClock, |
const orxCLOCK_FUNCTION | _pfnCallback, | ||
void * | _pContext, | ||
orxMODULE_ID | _eModuleID, | ||
orxCLOCK_PRIORITY | _ePriority | ||
) |
Registers a callback function to a clock
[in] | _pstClock | Concerned clock |
[in] | _pfnCallback | Callback to register |
[in] | _pContext | Context that will be transmitted to the callback when called |
[in] | _eModuleID | ID of the module related to this callback |
[in] | _ePriority | Priority for the function |
orxDLLAPI orxSTATUS orxFASTCALL orxClock_RemoveGlobalTimer | ( | const orxCLOCK_FUNCTION | _pfnCallback, |
orxFLOAT | _fDelay, | ||
void * | _pContext | ||
) |
Removes a global timer function (ie. from the main core clock)
[in] | _pfnCallback | Concerned timer callback to remove, orxNULL to remove all occurrences regardless of their callback |
[in] | _fDelay | Delay between 2 calls of the timer to remove, -1.0f to remove all occurrences regardless of their respective delay |
[in] | _pContext | Context of the timer to remove, orxNULL to remove all occurrences regardless of their context |
orxDLLAPI orxSTATUS orxFASTCALL orxClock_RemoveTimer | ( | orxCLOCK * | _pstClock, |
const orxCLOCK_FUNCTION | _pfnCallback, | ||
orxFLOAT | _fDelay, | ||
void * | _pContext | ||
) |
Removes a timer function from a clock
[in] | _pstClock | Concerned clock |
[in] | _pfnCallback | Concerned timer callback to remove, orxNULL to remove all occurrences regardless of their callback |
[in] | _fDelay | Delay between 2 calls of the timer to remove, -1.0f to remove all occurrences regardless of their respective delay |
[in] | _pContext | Context of the timer to remove, orxNULL to remove all occurrences regardless of their context |
Restarts a clock
[in] | _pstClock | Concerned clock |
Resyncs a clock (accumulated DT => 0)
[in] | _pstClock | Concerned clock |
Resyncs all clocks (accumulated DT => 0)
orxDLLAPI orxSTATUS orxFASTCALL orxClock_SetContext | ( | orxCLOCK * | _pstClock, |
const orxCLOCK_FUNCTION | _pfnCallback, | ||
void * | _pContext | ||
) |
Sets a callback function context
[in] | _pstClock | Concerned clock |
[in] | _pfnCallback | Concerned callback |
[in] | _pContext | Context that will be transmitted to the callback when called |
orxDLLAPI orxSTATUS orxFASTCALL orxClock_SetModifier | ( | orxCLOCK * | _pstClock, |
orxCLOCK_MOD_TYPE | _eModType, | ||
orxFLOAT | _fModValue | ||
) |
Sets a clock modifier
[in] | _pstClock | Concerned clock |
[in] | _eModType | Modifier type |
[in] | _fModValue | Modifier value |
Sets a clock tick size
[in] | _pstClock | Concerned clock |
[in] | _fTickSize | Tick size |
Unpauses a clock
[in] | _pstClock | Concerned clock |
orxDLLAPI orxSTATUS orxFASTCALL orxClock_Unregister | ( | orxCLOCK * | _pstClock, |
const orxCLOCK_FUNCTION | _pfnCallback | ||
) |
Unregisters a callback function from a clock
[in] | _pstClock | Concerned clock |
[in] | _pfnCallback | Callback to remove |