orxClock.h File Reference

#include "orxInclude.h"
#include "core/orxSystem.h"
#include "utils/orxString.h"

Go to the source code of this file.

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   "orx:clock: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 orxFLOAT orxFASTCALL	orxClock_ComputeDT (const orxCLOCK *_pstClock, orxFLOAT _fDT)
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 orxSTATUS orxFASTCALL	orxClock_Init ()
orxDLLAPI orxBOOL orxFASTCALL	orxClock_IsPaused (const orxCLOCK *_pstClock)
orxDLLAPI void orxFASTCALL	orxClock_Pause (orxCLOCK *_pstClock, orxBOOL _bPause)
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_Unregister (orxCLOCK *_pstClock, const orxCLOCK_FUNCTION _pfnCallback)
orxDLLAPI orxSTATUS orxFASTCALL	orxClock_Update ()

Detailed Description

Date

28/01/2004

Author

iarwa.nosp@m.in@o.nosp@m.rx-pr.nosp@m.ojec.nosp@m.t.org

Todo

• Add freezing behaviour

Definition in file orxClock.h.