orx 1.16
Portable Game Engine
|
Data Structures | |
struct | orxPLUGIN_CORE_FUNCTION |
struct | orxPLUGIN_USER_FUNCTION_INFO |
Typedefs | |
typedef orxSTATUS(orxFASTCALL * | orxPLUGIN_ENTRY_POINT) (orxPLUGIN_ENTRY_MODE _eMode) |
typedef orxSTATUS(* | orxPLUGIN_EXIT_FUNCTION) (orxPLUGIN_ENTRY_MODE _eMode) |
typedef orxSTATUS(orxFASTCALL * | orxPLUGIN_FUNCTION) () |
typedef orxSTATUS(* | orxPLUGIN_INIT_FUNCTION) (orxU32 *_peUserFunctionNumber, orxPLUGIN_USER_FUNCTION_INFO **_pastUserFunctionInfo) |
typedef orxSTATUS(* | orxPLUGIN_SWAP_FUNCTION) (orxPLUGIN_ENTRY_MODE _eMode) |
Header that regroups all core plugin defines.
Header that defines all the plugin IDs
Header that defines all IDs of the display plugin
Header that defines all IDs of the joystick plugin
Header that defines all IDs of the keyboard plugin
Header that defines all IDs of the mouse plugin
Header that defines all IDs of the physics plugin
Header that defines all IDs of the render plugin
Header that defines all IDs of the sound system plugin
Plugin module This module provides functions for loading dynamic code into the core engine and finding symbols within the dynamic modules
Plugin core header This header is used to define structures & functions for core plugins info.
Plugin type header This header is used to define types for plugin module.
Plugin user header This header is used to define structures & functions for plugin registration.
#define _orxPLUGIN_USER_FUNCTION_ADD_LOW_LEVEL | ( | FUNCTION, | |
FUNCTION_ID, | |||
NAME, | |||
ARGS ) |
Definition at line 109 of file orxPluginUser.h.
#define orxPLUGIN_ADD_CORE_FUNCTION_ARRAY | ( | PLUGIN_SUFFIX, | |
FUNCTION_SUFFIX, | |||
FUNCTION_NAME ) |
Definition at line 168 of file orxPluginCore.h.
#define orxPLUGIN_BEGIN_CORE_FUNCTION_ARRAY | ( | PLUGIN_SUFFIX | ) |
Definition at line 163 of file orxPluginCore.h.
#define orxPLUGIN_CORE_FUNCTION_POINTER_NAME | ( | FUNCTION_NAME | ) |
Definition at line 125 of file orxPluginCore.h.
#define orxPLUGIN_CORE_REGISTER_FUNCTION_NAME | ( | PLUGIN_SUFFIX | ) |
Definition at line 48 of file orxPlugin_CoreDefine.h.
#define orxPLUGIN_DECLARE_CORE_REGISTER_FUNCTION | ( | PLUGIN_SUFFIX | ) |
Definition at line 50 of file orxPlugin_CoreDefine.h.
#define orxPLUGIN_DECLARE_ENTRY_POINT | ( | ENTRY_FUNCTION | ) |
Definition at line 98 of file orxPluginUser.h.
#define orxPLUGIN_DECLARE_EXIT_ENTRY_POINT | ( | ENTRY_FUNCTION | ) |
Definition at line 82 of file orxPluginUser.h.
#define orxPLUGIN_DECLARE_INIT_ENTRY_POINT | ( | ENTRY_FUNCTION | ) |
Definition at line 65 of file orxPluginUser.h.
#define orxPLUGIN_DECLARE_SWAP_ENTRY_POINT | ( | ENTRY_FUNCTION | ) |
Definition at line 90 of file orxPluginUser.h.
#define orxPLUGIN_DEFAULT_CORE_FUNCTION_DEFINE | ( | FUNCTION_NAME | ) |
Definition at line 131 of file orxPluginCore.h.
#define orxPLUGIN_DEFAULT_CORE_FUNCTION_NAME | ( | FUNCTION_NAME | ) |
Definition at line 128 of file orxPluginCore.h.
#define orxPLUGIN_DEFINE_CORE_FUNCTION | ( | FUNCTION_NAME, | |
RETURN, | |||
... ) |
Definition at line 150 of file orxPluginCore.h.
#define orxPLUGIN_END_CORE_FUNCTION_ARRAY | ( | PLUGIN_SUFFIX | ) |
Definition at line 172 of file orxPluginCore.h.
#define orxPLUGIN_K_CORE_INIT_FUNCTION_NAME | ( | SUFFIX | ) |
Plugin core init function name
Definition at line 85 of file orxPluginType.h.
#define orxPLUGIN_K_EXIT_FUNCTION_NAME orxPlugin_Entry_Exit |
Plugin exit function name
Definition at line 74 of file orxPluginType.h.
#define orxPLUGIN_K_INIT_FUNCTION_NAME orxPlugin_Entry_Init |
Plugin init function name
Definition at line 73 of file orxPluginType.h.
#define orxPLUGIN_K_SWAP_FUNCTION_NAME orxPlugin_Entry_Swap |
Plugin swap function name
Definition at line 75 of file orxPluginType.h.
#define orxPLUGIN_KU32_FLAG_CORE_ID 0x10000000 |
Plugin core ID flag
Definition at line 53 of file orxPluginType.h.
#define orxPLUGIN_KU32_FUNCTION_ARG_SIZE 128 |
Definition at line 61 of file orxPluginType.h.
#define orxPLUGIN_KU32_MASK_FUNCTION_ID 0x000000FF |
Plugin function mask
Definition at line 58 of file orxPluginType.h.
#define orxPLUGIN_KU32_MASK_PLUGIN_ID 0x0000FF00 |
Plugin ID mask
Definition at line 55 of file orxPluginType.h.
#define orxPLUGIN_KU32_SHIFT_PLUGIN_ID 8 |
Plugin ID bits shift
Definition at line 56 of file orxPluginType.h.
#define orxPLUGIN_KZ_RESOURCE_GROUP "Plugin" |
Misc
Definition at line 56 of file orxPlugin.h.
#define orxPLUGIN_MAKE_CORE_FUNCTION_ID | ( | PLUGIN_CORE_ID, | |
FUNCTION_BASE_ID ) |
Definition at line 69 of file orxPluginType.h.
#define orxPLUGIN_MAKE_FUNCTION_ID | ( | PLUGIN_ID, | |
FUNCTION_BASE_ID ) |
Definition at line 65 of file orxPluginType.h.
#define orxPLUGIN_REGISTER_CORE_INFO | ( | PLUGIN_SUFFIX | ) |
Definition at line 198 of file orxPluginCore.h.
#define orxPLUGIN_USER_CORE_FUNCTION_ADD | ( | FUNCTION, | |
PLUGIN_SUFFIX, | |||
NAME_SUFFIX ) |
Definition at line 150 of file orxPluginUser.h.
#define orxPLUGIN_USER_CORE_FUNCTION_END | ( | ) |
Definition at line 156 of file orxPluginUser.h.
#define orxPLUGIN_USER_CORE_FUNCTION_START | ( | PLUGIN_SUFFIX | ) |
Definition at line 143 of file orxPluginUser.h.
#define orxPLUGIN_USER_FUNCTION_ADD | ( | FUNCTION, | |
ARGS, | |||
PLUGIN_ID, | |||
FUNCTION_BASE_ID, | |||
NAME ) |
Definition at line 132 of file orxPluginUser.h.
#define orxPLUGIN_USER_FUNCTION_END | ( | NUMBER_ADDRESS, | |
STRUCTURE_ADDRESS ) |
Definition at line 138 of file orxPluginUser.h.
#define orxPLUGIN_USER_FUNCTION_START | ( | STRUCTURE | ) |
Definition at line 125 of file orxPluginUser.h.
typedef orxSTATUS(orxFASTCALL * orxPLUGIN_ENTRY_POINT) (orxPLUGIN_ENTRY_MODE _eMode) |
Plugin entry point function
Definition at line 61 of file orxPluginUser.h.
typedef orxSTATUS(* orxPLUGIN_EXIT_FUNCTION) (orxPLUGIN_ENTRY_MODE _eMode) |
Definition at line 85 of file orxPluginCore.h.
typedef orxSTATUS(orxFASTCALL * orxPLUGIN_FUNCTION) () |
Definition at line 115 of file orxPluginType.h.
typedef orxSTATUS(* orxPLUGIN_INIT_FUNCTION) (orxU32 *_peUserFunctionNumber, orxPLUGIN_USER_FUNCTION_INFO **_pastUserFunctionInfo) |
Plugin init function prototype
Definition at line 83 of file orxPluginCore.h.
typedef orxSTATUS(* orxPLUGIN_SWAP_FUNCTION) (orxPLUGIN_ENTRY_MODE _eMode) |
Definition at line 84 of file orxPluginCore.h.
enum orxPLUGIN_CORE_ID |
Definition at line 47 of file orxPlugin_CoreID.h.
enum orxPLUGIN_ENTRY_MODE |
Plugin entry mode enum
Enumerator | |
---|---|
orxPLUGIN_ENTRY_MODE_INIT | |
orxPLUGIN_ENTRY_MODE_EXIT | |
orxPLUGIN_ENTRY_MODE_SWAP_IN | |
orxPLUGIN_ENTRY_MODE_SWAP_OUT | |
orxPLUGIN_ENTRY_MODE_NUMBER | |
orxPLUGIN_ENTRY_MODE_NONE |
Definition at line 96 of file orxPluginType.h.
Definition at line 48 of file orxPlugin_Display.h.
Definition at line 48 of file orxPlugin_Joystick.h.
Definition at line 48 of file orxPlugin_Keyboard.h.
Definition at line 48 of file orxPlugin_Mouse.h.
Definition at line 48 of file orxPlugin_Physics.h.
Definition at line 48 of file orxPlugin_Render.h.
Definition at line 49 of file orxPlugin_SoundSystem.h.
Enumerator | |
---|---|
orxPLUGIN_FUNCTION_ID_NONE |
Definition at line 109 of file orxPluginType.h.
|
extern |
Adds an info structure for the given core module Has to be called during a core module init
[in] | _ePluginCoreID | The numeric id of the core plugin |
[in] | _eModuleID | Corresponding module ID |
[in] | _astCoreFunction | The pointer to the core functions info array |
[in] | _u32CoreFunctionNumber | Number of functions in the array |
orxPLUGIN_DECLARE_CORE_REGISTER_FUNCTION | ( | DISPLAY | ) |
orxPLUGIN_DECLARE_CORE_REGISTER_FUNCTION | ( | JOYSTICK | ) |
orxPLUGIN_DECLARE_CORE_REGISTER_FUNCTION | ( | KEYBOARD | ) |
orxPLUGIN_DECLARE_CORE_REGISTER_FUNCTION | ( | MOUSE | ) |
orxPLUGIN_DECLARE_CORE_REGISTER_FUNCTION | ( | PHYSICS | ) |
orxPLUGIN_DECLARE_CORE_REGISTER_FUNCTION | ( | RENDER | ) |
orxPLUGIN_DECLARE_CORE_REGISTER_FUNCTION | ( | SOUNDSYSTEM | ) |
|
extern |
Default core plugin function Needs to be referenced by all core functions at module init.
|
extern |
Exits from the plugin module
|
extern |
Gets a function from a plugin
[in] | _hPluginHandle | The plugin handle |
[in] | _zFunctionName | The name of the function to find |
Gets the handle of a plugin given its name
[in] | _zPluginName | The plugin name |
Gets the name of a plugin given its handle
[in] | _hPluginHandle | The plugin handle |
Inits the plugin module
Loads a plugin, doing a shadow copy and watching for any change on-disk to trigger an auto-swap
[in] | _zPluginName | The name of the plugin, with or without its library extension |
|
static |
Definition at line 79 of file orxPlugin_CoreDefine.h.
|
extern |
Plugin module setup