orx  stable
Portable Game Engine
OrxModule

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_COMMAND,
  orxMODULE_ID_CONFIG, orxMODULE_ID_CONSOLE, 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_RESOURCE, orxMODULE_ID_SCREENSHOT, orxMODULE_ID_SHADER, orxMODULE_ID_SHADERPOINTER,
  orxMODULE_ID_SOUND, orxMODULE_ID_SOUNDPOINTER, orxMODULE_ID_SOUNDSYSTEM, orxMODULE_ID_SPAWNER,
  orxMODULE_ID_STRING, orxMODULE_ID_STRUCTURE, orxMODULE_ID_SYSTEM, orxMODULE_ID_TEXT,
  orxMODULE_ID_TEXTURE, orxMODULE_ID_THREAD, orxMODULE_ID_TIMELINE, orxMODULE_ID_VIEWPORT,
  orxMODULE_ID_CORE_NUMBER, orxMODULE_ID_USER_DEFINED = orxMODULE_ID_CORE_NUMBER, orxMODULE_ID_TOTAL_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 const orxSTRING orxFASTCALL orxModule_GetName (orxMODULE_ID _eModuleID)
 
orxDLLAPI orxSTATUS orxFASTCALL orxModule_Init (orxMODULE_ID _eModuleID)
 
orxDLLAPI orxBOOL orxFASTCALL orxModule_IsInitialized (orxMODULE_ID _eModuleID)
 
orxDLLAPI void orxFASTCALL orxModule_Register (orxMODULE_ID _eModuleID, const orxSTRING _zModuleName, const orxMODULE_SETUP_FUNCTION _pfnSetup, const orxMODULE_INIT_FUNCTION _pfnInit, const orxMODULE_EXIT_FUNCTION _pfnExit)
 
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_COMMAND 
orxMODULE_ID_CONFIG 
orxMODULE_ID_CONSOLE 
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_RESOURCE 
orxMODULE_ID_SCREENSHOT 
orxMODULE_ID_SHADER 
orxMODULE_ID_SHADERPOINTER 
orxMODULE_ID_SOUND 
orxMODULE_ID_SOUNDPOINTER 
orxMODULE_ID_SOUNDSYSTEM 
orxMODULE_ID_SPAWNER 
orxMODULE_ID_STRING 
orxMODULE_ID_STRUCTURE 
orxMODULE_ID_SYSTEM 
orxMODULE_ID_TEXT 
orxMODULE_ID_TEXTURE 
orxMODULE_ID_THREAD 
orxMODULE_ID_TIMELINE 
orxMODULE_ID_VIEWPORT 
orxMODULE_ID_CORE_NUMBER 
orxMODULE_ID_USER_DEFINED 
orxMODULE_ID_TOTAL_NUMBER 
orxMODULE_ID_NONE 

Definition at line 53 of file orxModule.h.

Function Documentation

orxDLLAPI void orxFASTCALL orxModule_AddDependency ( orxMODULE_ID  _eModuleID,
orxMODULE_ID  _eDependID 
)

Adds dependencies between 2 modules

Parameters
[in]_eModuleIDConcerned module ID
[in]_eDependIDModule ID of the needed module
orxDLLAPI void orxFASTCALL orxModule_AddOptionalDependency ( orxMODULE_ID  _eModuleID,
orxMODULE_ID  _eDependID 
)

Adds optional dependencies between 2 modules

Parameters
[in]_eModuleIDConcerned module ID
[in]_eDependIDModule ID of the optionally needed module
orxDLLAPI void orxFASTCALL orxModule_Exit ( orxMODULE_ID  _eModuleID)

Exits from a module

Parameters
[in]_eModuleIDConcerned module ID
orxDLLAPI const orxSTRING orxFASTCALL orxModule_GetName ( orxMODULE_ID  _eModuleID)

Gets module name

Parameters
[in]_eModuleIDConcerned module ID
Returns
Module name / orxSTRING_EMPTY
orxDLLAPI orxSTATUS orxFASTCALL orxModule_Init ( orxMODULE_ID  _eModuleID)

Inits a module

Parameters
[in]_eModuleIDConcerned module ID
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI orxBOOL orxFASTCALL orxModule_IsInitialized ( orxMODULE_ID  _eModuleID)

Is module initialized?

Parameters
[in]_eModuleIDConcerned module ID
Returns
orxTRUE / orxFALSE
orxDLLAPI void orxFASTCALL orxModule_Register ( orxMODULE_ID  _eModuleID,
const orxSTRING  _zModuleName,
const orxMODULE_SETUP_FUNCTION  _pfnSetup,
const orxMODULE_INIT_FUNCTION  _pfnInit,
const orxMODULE_EXIT_FUNCTION  _pfnExit 
)

Registers a module

Parameters
[in]_eModuleIDConcerned module ID
[in]_zModuleNameModule name
[in]_pfnSetupModule setup callback
[in]_pfnInitModule init callback
[in]_pfnExitModule exit callback
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
typedef orxSTATUS ( orxFASTCALL *  orxMODULE_INIT_FUNCTION)
typedef void ( orxFASTCALL *  orxMODULE_EXIT_FUNCTION)

Generated for orx by doxygen 1.5.6