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

#define	orxCLOCK_KZ_CONFIG_FREQUENCY "Frequency"

#define	orxCLOCK_KZ_CONFIG_MODIFIER_LIST "ModifierList"

#define	orxCLOCK_KZ_CORE "core"

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_MODIFIER { orxCLOCK_MODIFIER_FIXED = 0, orxCLOCK_MODIFIER_MULTIPLY, orxCLOCK_MODIFIER_MAXED, orxCLOCK_MODIFIER_AVERAGE, orxCLOCK_MODIFIER_NUMBER, orxCLOCK_MODIFIER_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 }

Functions
orxDLLAPI orxSTATUS orxFASTCALL	orxClock_AddGlobalTimer (const orxCLOCK_FUNCTION _pfnCallback, orxFLOAT _fDelay, orxS32 _s32Repetition, void *_pContext)

orxDLLAPI orxSTATUS orxFASTCALL	orxClock_AddTimer (orxCLOCK _pstClock, const orxCLOCK_FUNCTION _pfnCallback, orxFLOAT _fDelay, orxS32 _s32Repetition, void _pContext)

orxDLLAPI orxCLOCK *orxFASTCALL	orxClock_Create (orxFLOAT _fTickSize)

orxDLLAPI orxCLOCK *orxFASTCALL	orxClock_CreateFromConfig (const orxSTRING _zConfigID)

orxDLLAPI orxSTATUS orxFASTCALL	orxClock_Delete (orxCLOCK *_pstClock)

orxDLLAPI void orxFASTCALL	orxClock_Exit ()

orxDLLAPI orxCLOCK *orxFASTCALL	orxClock_Get (const orxSTRING _zName)

orxDLLAPI void *orxFASTCALL	orxClock_GetContext (const orxCLOCK *_pstClock, const orxCLOCK_FUNCTION _pfnCallback)

orxDLLAPI orxCLOCK *orxFASTCALL	orxClock_GetFromInfo (const orxCLOCK_INFO *_pstClockInfo)

orxDLLAPI const orxCLOCK_INFO *orxFASTCALL	orxClock_GetInfo (const orxCLOCK *_pstClock)

orxDLLAPI orxFLOAT orxFASTCALL	orxClock_GetModifier (orxCLOCK *_pstClock, orxCLOCK_MODIFIER _eModifier)

orxDLLAPI const orxSTRING orxFASTCALL	orxClock_GetName (const orxCLOCK *_pstClock)

orxDLLAPI orxCLOCK *orxFASTCALL	orxClock_GetNext (const orxCLOCK *_pstClock)

orxDLLAPI orxSTATUS orxFASTCALL	orxClock_Init ()

orxDLLAPI orxBOOL orxFASTCALL	orxClock_IsPaused (const orxCLOCK *_pstClock)

orxDLLAPI orxSTATUS orxFASTCALL	orxClock_Pause (orxCLOCK *_pstClock)

orxDLLAPI orxSTATUS orxFASTCALL	orxClock_Register (orxCLOCK _pstClock, const orxCLOCK_FUNCTION _pfnCallback, void _pContext, orxMODULE_ID _eModuleID, orxCLOCK_PRIORITY _ePriority)

orxDLLAPI orxSTATUS orxFASTCALL	orxClock_RemoveGlobalTimer (const orxCLOCK_FUNCTION _pfnCallback, orxFLOAT _fDelay, void *_pContext)

orxDLLAPI orxSTATUS orxFASTCALL	orxClock_RemoveTimer (orxCLOCK _pstClock, const orxCLOCK_FUNCTION _pfnCallback, orxFLOAT _fDelay, void _pContext)

orxDLLAPI orxSTATUS orxFASTCALL	orxClock_Restart (orxCLOCK *_pstClock)

orxDLLAPI orxSTATUS orxFASTCALL	orxClock_Resync (orxCLOCK *_pstClock)

orxDLLAPI orxSTATUS orxFASTCALL	orxClock_ResyncAll ()

orxDLLAPI orxSTATUS orxFASTCALL	orxClock_SetContext (orxCLOCK _pstClock, const orxCLOCK_FUNCTION _pfnCallback, void _pContext)

orxDLLAPI orxSTATUS orxFASTCALL	orxClock_SetModifier (orxCLOCK *_pstClock, orxCLOCK_MODIFIER _eModifier, orxFLOAT _fValue)

orxDLLAPI orxSTATUS orxFASTCALL	orxClock_SetTickSize (orxCLOCK *_pstClock, orxFLOAT _fTickSize)

orxDLLAPI void orxFASTCALL	orxClock_Setup ()

orxDLLAPI orxSTATUS orxFASTCALL	orxClock_Unpause (orxCLOCK *_pstClock)

orxDLLAPI orxSTATUS orxFASTCALL	orxClock_Unregister (orxCLOCK *_pstClock, const orxCLOCK_FUNCTION _pfnCallback)

orxDLLAPI orxSTATUS orxFASTCALL	orxClock_Update ()

Detailed Description

Clock module Module that handles clocks which is the low level kernel part of orx execution.

Macro Definition Documentation

#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.

#define orxCLOCK_KZ_CONFIG_FREQUENCY "Frequency"

Definition at line 56 of file orxClock.h.

#define orxCLOCK_KZ_CONFIG_MODIFIER_LIST "ModifierList"

Definition at line 57 of file orxClock.h.

#define orxCLOCK_KZ_CORE "core"

Definition at line 59 of file orxClock.h.

Typedef Documentation

typedef struct __orxCLOCK_t orxCLOCK

Clock structure

Definition at line 126 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 129 of file orxClock.h.

Enumeration Type Documentation

enum orxCLOCK_EVENT

Event enum

Enumerator
orxCLOCK_EVENT_RESTART	Event sent when a clock restarts
orxCLOCK_EVENT_RESYNC	Event sent when a clock resyncs
orxCLOCK_EVENT_PAUSE	Event sent when a clock is paused
orxCLOCK_EVENT_UNPAUSE	Event sent when a clock is unpaused
orxCLOCK_EVENT_NUMBER
orxCLOCK_EVENT_NONE

Definition at line 111 of file orxClock.h.

enum orxCLOCK_MODIFIER

Clock modifier enum

Enumerator
orxCLOCK_MODIFIER_FIXED	The given DT will be constant, set to this modifier value
orxCLOCK_MODIFIER_MULTIPLY	The given DT will be multiplied by this modifier value
orxCLOCK_MODIFIER_MAXED	The given DT will be maxed by this modifier value
orxCLOCK_MODIFIER_AVERAGE	The given DT will be averaged over a number of past updates defined by this modifier value
orxCLOCK_MODIFIER_NUMBER
orxCLOCK_MODIFIER_NONE

Definition at line 64 of file orxClock.h.

enum orxCLOCK_PRIORITY

Clock priority

Enumerator
orxCLOCK_PRIORITY_LOWEST
orxCLOCK_PRIORITY_LOWER
orxCLOCK_PRIORITY_LOW
orxCLOCK_PRIORITY_NORMAL
orxCLOCK_PRIORITY_HIGH
orxCLOCK_PRIORITY_HIGHER
orxCLOCK_PRIORITY_HIGHEST
orxCLOCK_PRIORITY_NUMBER
orxCLOCK_PRIORITY_NONE

Definition at line 80 of file orxClock.h.

Function Documentation

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)

Parameters

[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

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxClock_AddTimer	(	orxCLOCK *	_pstClock,
		const orxCLOCK_FUNCTION	_pfnCallback,
		orxFLOAT	_fDelay,
		orxS32	_s32Repetition,
		void *	_pContext
	)

Adds a timer function to a clock

Parameters

[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

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxCLOCK* orxFASTCALL orxClock_Create ( orxFLOAT _fTickSize )

Creates a clock

Parameters

[in] _fTickSize Tick size for the clock (in seconds)

Returns: orxCLOCK / orxNULL

orxDLLAPI orxCLOCK* orxFASTCALL orxClock_CreateFromConfig ( const orxSTRING _zConfigID )

Creates a clock from config

Parameters

[in] _zConfigID Config ID @ return orxCLOCK / orxNULL

orxDLLAPI orxSTATUS orxFASTCALL orxClock_Delete ( orxCLOCK * _pstClock )

Deletes a clock

Parameters

[in] _pstClock Concerned clock

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI void orxFASTCALL orxClock_Exit ( )

Exits from the clock module

orxDLLAPI orxCLOCK* orxFASTCALL orxClock_Get ( const orxSTRING _zName )

Gets clock given its name

Parameters

[in] _zName Clock name

Returns: orxCLOCK / orxNULL

orxDLLAPI void* orxFASTCALL orxClock_GetContext	(	const orxCLOCK *	_pstClock,
		const orxCLOCK_FUNCTION	_pfnCallback
	)

Gets a callback function context

Parameters

[in]	_pstClock	Concerned clock
[in]	_pfnCallback	Concerned callback

Returns: Registered context

orxDLLAPI orxCLOCK* orxFASTCALL orxClock_GetFromInfo ( const orxCLOCK_INFO * _pstClockInfo )

Gets clock from its info

Parameters

[in] _pstClockInfo Concerned clock info

Returns: orxCLOCK / orxNULL

orxDLLAPI const orxCLOCK_INFO* orxFASTCALL orxClock_GetInfo ( const orxCLOCK * _pstClock )

Gets clock info

Parameters

[in] _pstClock Concerned clock

Returns: orxCLOCK_INFO / orxNULL

orxDLLAPI orxFLOAT orxFASTCALL orxClock_GetModifier	(	orxCLOCK *	_pstClock,
		orxCLOCK_MODIFIER	_eModifier
	)

Gets a clock's modifier

Parameters

[in]	_pstClock	Concerned clock
[in]	_eModifier	Concerned modifier

Returns: Modifier value / orxFLOAT_0 if deactivated

orxDLLAPI const orxSTRING orxFASTCALL orxClock_GetName ( const orxCLOCK * _pstClock )

Gets clock config name

Parameters

[in] _pstClock Concerned clock

Returns: orxSTRING / orxSTRING_EMPTY

orxDLLAPI orxCLOCK* orxFASTCALL orxClock_GetNext ( const orxCLOCK * _pstClock )

Gets next existing clock in list (can be used to parse all existing clocks)

Parameters

[in] _pstClock Concerned clock

Returns: orxCLOCK / orxNULL

orxDLLAPI orxSTATUS orxFASTCALL orxClock_Init ( )

Inits the clock module

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxBOOL orxFASTCALL orxClock_IsPaused ( const orxCLOCK * _pstClock )

Is a clock paused?

Parameters

[in] _pstClock Concerned clock

Returns: orxTRUE if paused, orxFALSE otherwise

orxDLLAPI orxSTATUS orxFASTCALL orxClock_Pause ( orxCLOCK * _pstClock )

Pauses a clock

Parameters

[in] _pstClock Concerned clock

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

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

Parameters

[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

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxClock_RemoveGlobalTimer	(	const orxCLOCK_FUNCTION	_pfnCallback,
		orxFLOAT	_fDelay,
		void *	_pContext
	)

Removes a global timer function (ie. from the main core clock)

Parameters

[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

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxClock_RemoveTimer	(	orxCLOCK *	_pstClock,
		const orxCLOCK_FUNCTION	_pfnCallback,
		orxFLOAT	_fDelay,
		void *	_pContext
	)

Removes a timer function from a clock

Parameters

[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

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxClock_Restart ( orxCLOCK * _pstClock )

Restarts a clock

Parameters

[in] _pstClock Concerned clock

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxClock_Resync ( orxCLOCK * _pstClock )

Resyncs a clock (accumulated DT => 0)

Parameters

[in] _pstClock Concerned clock

orxDLLAPI orxSTATUS orxFASTCALL orxClock_ResyncAll ( )

Resyncs all clocks (accumulated DT => 0)

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxClock_SetContext	(	orxCLOCK *	_pstClock,
		const orxCLOCK_FUNCTION	_pfnCallback,
		void *	_pContext
	)

Sets a callback function context

Parameters

[in]	_pstClock	Concerned clock
[in]	_pfnCallback	Concerned callback
[in]	_pContext	Context that will be transmitted to the callback when called

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxClock_SetModifier	(	orxCLOCK *	_pstClock,
		orxCLOCK_MODIFIER	_eModifier,
		orxFLOAT	_fValue
	)

Sets a clock's modifier

Parameters

[in]	_pstClock	Concerned clock
[in]	_eModifier	Concerned modifier
[in]	_fValue	Modifier value, orxFLOAT_0 to deactivate the modifier

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxClock_SetTickSize	(	orxCLOCK *	_pstClock,
		orxFLOAT	_fTickSize
	)

Sets a clock tick size

Parameters

[in]	_pstClock	Concerned clock
[in]	_fTickSize	Tick size, -1 for 'display'

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI void orxFASTCALL orxClock_Setup ( )

Clock module setup

orxDLLAPI orxSTATUS orxFASTCALL orxClock_Unpause ( orxCLOCK * _pstClock )

Unpauses a clock

Parameters

[in] _pstClock Concerned clock

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxClock_Unregister	(	orxCLOCK *	_pstClock,
		const orxCLOCK_FUNCTION	_pfnCallback
	)

Unregisters a callback function from a clock

Parameters

[in]	_pstClock	Concerned clock
[in]	_pfnCallback	Callback to remove

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxClock_Update ( )

Updates the clock system

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

Data Structures

Macros

Typedefs

Enumerations

Functions

Detailed Description

Macro Definition Documentation

Typedef Documentation

Enumeration Type Documentation

Function Documentation