Enumerations |
| enum | orxMODULE_ID {
orxMODULE_ID_ANIM = 0,
orxMODULE_ID_ANIMPOINTER,
orxMODULE_ID_ANIMSET,
orxMODULE_ID_BANK,
orxMODULE_ID_BODY,
orxMODULE_ID_CAMERA,
orxMODULE_ID_CLOCK,
orxMODULE_ID_CONFIG,
orxMODULE_ID_DISPLAY,
orxMODULE_ID_EVENT,
orxMODULE_ID_FILE,
orxMODULE_ID_FONT,
orxMODULE_ID_FPS,
orxMODULE_ID_FRAME,
orxMODULE_ID_FX,
orxMODULE_ID_FXPOINTER,
orxMODULE_ID_GRAPHIC,
orxMODULE_ID_INPUT,
orxMODULE_ID_JOYSTICK,
orxMODULE_ID_KEYBOARD,
orxMODULE_ID_LOCALE,
orxMODULE_ID_MAIN,
orxMODULE_ID_MEMORY,
orxMODULE_ID_MOUSE,
orxMODULE_ID_OBJECT,
orxMODULE_ID_PARAM,
orxMODULE_ID_PHYSICS,
orxMODULE_ID_PLUGIN,
orxMODULE_ID_PROFILER,
orxMODULE_ID_RENDER,
orxMODULE_ID_SCREENSHOT,
orxMODULE_ID_SHADER,
orxMODULE_ID_SHADERPOINTER,
orxMODULE_ID_SOUND,
orxMODULE_ID_SOUNDPOINTER,
orxMODULE_ID_SOUNDSYSTEM,
orxMODULE_ID_SPAWNER,
orxMODULE_ID_STRUCTURE,
orxMODULE_ID_SYSTEM,
orxMODULE_ID_TEXT,
orxMODULE_ID_TEXTURE,
orxMODULE_ID_VIEWPORT,
orxMODULE_ID_NUMBER,
orxMODULE_ID_MAX_NUMBER = 64,
orxMODULE_ID_NONE = orxENUM_NONE
} |
Functions |
| orxDLLAPI void orxFASTCALL | orxModule_AddDependency (orxMODULE_ID _eModuleID, orxMODULE_ID _eDependID) |
| orxDLLAPI void orxFASTCALL | orxModule_AddOptionalDependency (orxMODULE_ID _eModuleID, orxMODULE_ID _eDependID) |
| orxDLLAPI void orxFASTCALL | orxModule_Exit (orxMODULE_ID _eModuleID) |
| orxDLLAPI void orxFASTCALL | orxModule_ExitAll () |
| orxDLLAPI orxSTATUS orxFASTCALL | orxModule_Init (orxMODULE_ID _eModuleID) |
| orxDLLAPI orxSTATUS orxFASTCALL | orxModule_InitAll () |
| orxDLLAPI orxBOOL orxFASTCALL | orxModule_IsInitialized (orxMODULE_ID _eModuleID) |
| orxDLLAPI void orxFASTCALL | orxModule_Register (orxMODULE_ID _eModuleID, const orxMODULE_SETUP_FUNCTION _pfnSetup, const orxMODULE_INIT_FUNCTION _pfnInit, const orxMODULE_EXIT_FUNCTION _pfnExit) |
| orxDLLAPI void orxFASTCALL | orxModule_RegisterAll () |
| orxDLLAPI void orxFASTCALL | orxModule_Setup (orxMODULE_ID _eModuleID) |
| orxDLLAPI void orxFASTCALL | orxModule_SetupAll () |
| orxDLLAPI void orxFASTCALL | orxModule_UpdateDependencies () |
| typedef | orxSTATUS (orxFASTCALL *orxMODULE_INIT_FUNCTION)() |
| typedef | void (orxFASTCALL *orxMODULE_EXIT_FUNCTION)() |
Detailed Description
Module file Code that handles modules and their dependencies
Enumeration Type Documentation
Module enum
- Enumerator:
| orxMODULE_ID_ANIM |
|
| orxMODULE_ID_ANIMPOINTER |
|
| orxMODULE_ID_ANIMSET |
|
| orxMODULE_ID_BANK |
|
| orxMODULE_ID_BODY |
|
| orxMODULE_ID_CAMERA |
|
| orxMODULE_ID_CLOCK |
|
| orxMODULE_ID_CONFIG |
|
| orxMODULE_ID_DISPLAY |
|
| orxMODULE_ID_EVENT |
|
| orxMODULE_ID_FILE |
|
| orxMODULE_ID_FONT |
|
| orxMODULE_ID_FPS |
|
| orxMODULE_ID_FRAME |
|
| orxMODULE_ID_FX |
|
| orxMODULE_ID_FXPOINTER |
|
| orxMODULE_ID_GRAPHIC |
|
| orxMODULE_ID_INPUT |
|
| orxMODULE_ID_JOYSTICK |
|
| orxMODULE_ID_KEYBOARD |
|
| orxMODULE_ID_LOCALE |
|
| orxMODULE_ID_MAIN |
|
| orxMODULE_ID_MEMORY |
|
| orxMODULE_ID_MOUSE |
|
| orxMODULE_ID_OBJECT |
|
| orxMODULE_ID_PARAM |
|
| orxMODULE_ID_PHYSICS |
|
| orxMODULE_ID_PLUGIN |
|
| orxMODULE_ID_PROFILER |
|
| orxMODULE_ID_RENDER |
|
| orxMODULE_ID_SCREENSHOT |
|
| orxMODULE_ID_SHADER |
|
| orxMODULE_ID_SHADERPOINTER |
|
| orxMODULE_ID_SOUND |
|
| orxMODULE_ID_SOUNDPOINTER |
|
| orxMODULE_ID_SOUNDSYSTEM |
|
| orxMODULE_ID_SPAWNER |
|
| orxMODULE_ID_STRUCTURE |
|
| orxMODULE_ID_SYSTEM |
|
| orxMODULE_ID_TEXT |
|
| orxMODULE_ID_TEXTURE |
|
| orxMODULE_ID_VIEWPORT |
|
| orxMODULE_ID_NUMBER |
|
| orxMODULE_ID_MAX_NUMBER |
|
| orxMODULE_ID_NONE |
|
Definition at line 53 of file orxModule.h.
Function Documentation
Adds dependencies between 2 modules
- Parameters:
-
| [in] | _eModuleID | Concerned module ID |
| [in] | _eDependID | Module ID of the needed module |
Adds optional dependencies between 2 modules
- Parameters:
-
| [in] | _eModuleID | Concerned module ID |
| [in] | _eDependID | Module ID of the optionally needed module |
| orxDLLAPI void orxFASTCALL orxModule_Exit |
( |
orxMODULE_ID |
_eModuleID ) |
|
Exits from a module
- Parameters:
-
| [in] | _eModuleID | Concerned module ID |
| orxDLLAPI void orxFASTCALL orxModule_ExitAll |
( |
) |
|
Inits a module
- Parameters:
-
| [in] | _eModuleID | Concerned module ID |
- Returns:
- orxSTATUS_SUCCESS / orxSTATUS_FAILURE
| orxDLLAPI orxSTATUS orxFASTCALL orxModule_InitAll |
( |
) |
|
Inits all modules
- Returns:
- orxSTATUS_SUCCESS / orxSTATUS_FAILURE
| orxDLLAPI orxBOOL orxFASTCALL orxModule_IsInitialized |
( |
orxMODULE_ID |
_eModuleID ) |
|
Is module initialized?
- Parameters:
-
| [in] | _eModuleID | Concerned module ID |
- Returns:
- orxTRUE / orxFALSE
| orxDLLAPI void orxFASTCALL orxModule_Register |
( |
orxMODULE_ID |
_eModuleID, |
|
|
const orxMODULE_SETUP_FUNCTION |
_pfnSetup, |
|
|
const orxMODULE_INIT_FUNCTION |
_pfnInit, |
|
|
const orxMODULE_EXIT_FUNCTION |
_pfnExit |
|
) |
| |
Registers a module
- Parameters:
-
| [in] | _eModuleID | Concerned module ID |
| [in] | _pfnSetup | Module setup callback |
| [in] | _pfnInit | Module init callback |
| [in] | _pfnExit | Module exit callback |
- Returns:
- orxSTATUS_SUCCESS / orxSTATUS_FAILURE
| orxDLLAPI void orxFASTCALL orxModule_RegisterAll |
( |
) |
|
Registers all modules. ! Needs to be updated for all new modules !
| orxDLLAPI void orxFASTCALL orxModule_Setup |
( |
orxMODULE_ID |
_eModuleID ) |
|
Calls a module setup callback
- Parameters:
-
| [in] | _eModuleID | Concerned module ID |
| orxDLLAPI void orxFASTCALL orxModule_SetupAll |
( |
) |
|
| orxDLLAPI void orxFASTCALL orxModule_UpdateDependencies |
( |
) |
|
Updates dependencies for all modules
| typedef orxSTATUS |
( |
orxFASTCALL * |
orxMODULE_INIT_FUNCTION ) |
|
| typedef void |
( |
orxFASTCALL * |
orxMODULE_EXIT_FUNCTION ) |
|
