orx  1.5
Portable Game Engine
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
OrxPlugin

Data Structures

struct  orxPLUGIN_CORE_FUNCTION
 
struct  orxPLUGIN_USER_FUNCTION_INFO
 

Macros

#define _orxPLUGIN_USER_FUNCTION_ADD_LOW_LEVEL(FUNCTION, FUNCTION_ID, NAME, ARGS)
 
#define orxPLUGIN_ADD_CORE_FUNCTION_ARRAY(PLUGIN_SUFFIX, FUNCTION_SUFFIX, FUNCTION_NAME)   {(orxPLUGIN_FUNCTION_ID)orxPLUGIN_FUNCTION_BASE_ID_##PLUGIN_SUFFIX##_##FUNCTION_SUFFIX, (orxPLUGIN_FUNCTION *)&orxPLUGIN_CORE_FUNCTION_POINTER_NAME(FUNCTION_NAME), (orxPLUGIN_FUNCTION)&orxPLUGIN_DEFAULT_CORE_FUNCTION_NAME(FUNCTION_NAME)},
 
#define orxPLUGIN_BEGIN_CORE_FUNCTION_ARRAY(PLUGIN_SUFFIX)
 
#define orxPLUGIN_CORE_FUNCTION_POINTER_NAME(FUNCTION_NAME)   _orxCoreFunctionPointer_##FUNCTION_NAME
 
#define orxPLUGIN_CORE_REGISTER_FUNCTION_NAME(PLUGIN_SUFFIX)   _registerFunction_##PLUGIN_SUFFIX
 
#define orxPLUGIN_DECLARE_CORE_REGISTER_FUNCTION(PLUGIN_SUFFIX)   extern orxDLLAPI void orxPLUGIN_CORE_REGISTER_FUNCTION_NAME(PLUGIN_SUFFIX)()
 
#define orxPLUGIN_DECLARE_ENTRY_POINT(ENTRY_FUNCTION)
 
#define orxPLUGIN_DEFAULT_CORE_FUNCTION_DEFINE(FUNCTION_NAME)
 
#define orxPLUGIN_DEFAULT_CORE_FUNCTION_NAME(FUNCTION_NAME)   _orxDefaultCoreFunction_##FUNCTION_NAME
 
#define orxPLUGIN_DEFINE_CORE_FUNCTION(FUNCTION_NAME, RETURN,...)
 
#define orxPLUGIN_END_CORE_FUNCTION_ARRAY(PLUGIN_SUFFIX)
 
#define orxPLUGIN_K_CORE_INIT_FUNCTION_NAME(SUFFIX)   orxPlugin_MainInit
 
#define orxPLUGIN_K_INIT_FUNCTION_NAME   orxPlugin_MainInit
 
#define orxPLUGIN_KU32_FLAG_CORE_ID   0x10000000
 
#define orxPLUGIN_KU32_FUNCTION_ARG_SIZE   128
 
#define orxPLUGIN_KU32_MASK_FUNCTION_ID   0x000000FF
 
#define orxPLUGIN_KU32_MASK_PLUGIN_ID   0x0000FF00
 
#define orxPLUGIN_KU32_SHIFT_PLUGIN_ID   8
 
#define orxPLUGIN_MAKE_CORE_FUNCTION_ID(PLUGIN_CORE_ID, FUNCTION_BASE_ID)   (orxPLUGIN_FUNCTION_ID)(orxPLUGIN_KU32_FLAG_CORE_ID | orxPLUGIN_MAKE_FUNCTION_ID(PLUGIN_CORE_ID, FUNCTION_BASE_ID))
 
#define orxPLUGIN_MAKE_FUNCTION_ID(PLUGIN_ID, FUNCTION_BASE_ID)   (orxPLUGIN_FUNCTION_ID)(((PLUGIN_ID << orxPLUGIN_KU32_SHIFT_PLUGIN_ID) & orxPLUGIN_KU32_MASK_PLUGIN_ID) | (FUNCTION_BASE_ID & orxPLUGIN_KU32_MASK_FUNCTION_ID))
 
#define orxPLUGIN_REGISTER_CORE_INFO(PLUGIN_SUFFIX)   orxPlugin_AddCoreInfo(orxPLUGIN_CORE_ID_##PLUGIN_SUFFIX, orxMODULE_ID_##PLUGIN_SUFFIX, sastPluginFunctionInfo_##PLUGIN_SUFFIX, sizeof(sastPluginFunctionInfo_##PLUGIN_SUFFIX) / sizeof(orxPLUGIN_CORE_FUNCTION));
 
#define orxPLUGIN_USER_CORE_FUNCTION_ADD(FUNCTION, PLUGIN_SUFFIX, NAME_SUFFIX)
 
#define orxPLUGIN_USER_CORE_FUNCTION_END()
 
#define orxPLUGIN_USER_CORE_FUNCTION_START(PLUGIN_SUFFIX)
 
#define orxPLUGIN_USER_FUNCTION_ADD(FUNCTION, ARGS, PLUGIN_ID, FUNCTION_BASE_ID, NAME)
 
#define orxPLUGIN_USER_FUNCTION_END(NUMBER_ADDRESS, STRUCTURE_ADDRESS)
 
#define orxPLUGIN_USER_FUNCTION_START(STRUCTURE)
 

Typedefs

typedef orxSTATUS(orxFASTCALL * orxPLUGIN_FUNCTION )()
 
typedef orxSTATUS(* orxPLUGIN_INIT_FUNCTION )(orxU32 *_peUserFunctionNumber, orxPLUGIN_USER_FUNCTION_INFO **_pastUserFunctionInfo)
 

Enumerations

enum  orxPLUGIN_CORE_ID {
  orxPLUGIN_CORE_ID_DISPLAY = 0, orxPLUGIN_CORE_ID_JOYSTICK, orxPLUGIN_CORE_ID_KEYBOARD, orxPLUGIN_CORE_ID_MOUSE,
  orxPLUGIN_CORE_ID_PHYSICS, orxPLUGIN_CORE_ID_RENDER, orxPLUGIN_CORE_ID_SOUNDSYSTEM, orxPLUGIN_CORE_ID_NUMBER,
  orxPLUGIN_CORE_ID_NONE = orxENUM_NONE
}
 
enum  orxPLUGIN_FUNCTION_BASE_ID_DISPLAY {
  orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_INIT = 0, orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_EXIT, orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_SWAP, orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_GET_SCREEN_BITMAP,
  orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_GET_SCREEN_SIZE, orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_CREATE_BITMAP, orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_DELETE_BITMAP, orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_LOAD_BITMAP,
  orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_SAVE_BITMAP, orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_SET_DESTINATION_BITMAPS, orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_CLEAR_BITMAP, orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_SET_BLEND_MODE,
  orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_SET_BITMAP_CLIPPING, orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_SET_BITMAP_COLOR_KEY, orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_SET_BITMAP_DATA, orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_GET_BITMAP_DATA,
  orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_SET_BITMAP_COLOR, orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_GET_BITMAP_COLOR, orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_GET_BITMAP_SIZE, orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_GET_BITMAP_ID,
  orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_TRANSFORM_BITMAP, orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_TRANSFORM_TEXT, orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_DRAW_LINE, orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_DRAW_POLYLINE,
  orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_DRAW_POLYGON, orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_DRAW_CIRCLE, orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_DRAW_OBOX, orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_DRAW_MESH,
  orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_HAS_SHADER_SUPPORT, orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_CREATE_SHADER, orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_DELETE_SHADER, orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_START_SHADER,
  orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_STOP_SHADER, orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_GET_PARAMETER_ID, orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_SET_SHADER_BITMAP, orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_SET_SHADER_FLOAT,
  orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_SET_SHADER_VECTOR, orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_ENABLE_VSYNC, orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_IS_VSYNC_ENABLED, orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_SET_FULL_SCREEN,
  orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_IS_FULL_SCREEN, orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_GET_VIDEO_MODE_COUNTER, orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_GET_VIDEO_MODE, orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_SET_VIDEO_MODE,
  orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_IS_VIDEO_MODE_AVAILABLE, orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_NUMBER, orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_NONE = orxENUM_NONE
}
 
enum  orxPLUGIN_FUNCTION_BASE_ID_JOYSTICK {
  orxPLUGIN_FUNCTION_BASE_ID_JOYSTICK_INIT = 0, orxPLUGIN_FUNCTION_BASE_ID_JOYSTICK_EXIT, orxPLUGIN_FUNCTION_BASE_ID_JOYSTICK_GET_AXIS_VALUE, orxPLUGIN_FUNCTION_BASE_ID_JOYSTICK_IS_BUTTON_PRESSED,
  orxPLUGIN_FUNCTION_BASE_ID_JOYSTICK_NUMBER, orxPLUGIN_FUNCTION_BASE_ID_JOYSTICK_NONE = orxENUM_NONE
}
 
enum  orxPLUGIN_FUNCTION_BASE_ID_KEYBOARD {
  orxPLUGIN_FUNCTION_BASE_ID_KEYBOARD_INIT = 0, orxPLUGIN_FUNCTION_BASE_ID_KEYBOARD_EXIT, orxPLUGIN_FUNCTION_BASE_ID_KEYBOARD_IS_KEY_PRESSED, orxPLUGIN_FUNCTION_BASE_ID_KEYBOARD_READ_KEY,
  orxPLUGIN_FUNCTION_BASE_ID_KEYBOARD_READ_STRING, orxPLUGIN_FUNCTION_BASE_ID_KEYBOARD_CLEAR_BUFFER, orxPLUGIN_FUNCTION_BASE_ID_KEYBOARD_SHOW, orxPLUGIN_FUNCTION_BASE_ID_KEYBOARD_NUMBER,
  orxPLUGIN_FUNCTION_BASE_ID_KEYBOARD_NONE = orxENUM_NONE
}
 
enum  orxPLUGIN_FUNCTION_BASE_ID_MOUSE {
  orxPLUGIN_FUNCTION_BASE_ID_MOUSE_INIT = 0, orxPLUGIN_FUNCTION_BASE_ID_MOUSE_EXIT, orxPLUGIN_FUNCTION_BASE_ID_MOUSE_SET_POSITION, orxPLUGIN_FUNCTION_BASE_ID_MOUSE_GET_POSITION,
  orxPLUGIN_FUNCTION_BASE_ID_MOUSE_IS_BUTTON_PRESSED, orxPLUGIN_FUNCTION_BASE_ID_MOUSE_GET_MOVE_DELTA, orxPLUGIN_FUNCTION_BASE_ID_MOUSE_GET_WHEEL_DELTA, orxPLUGIN_FUNCTION_BASE_ID_MOUSE_SHOW_CURSOR,
  orxPLUGIN_FUNCTION_BASE_ID_MOUSE_NUMBER, orxPLUGIN_FUNCTION_BASE_ID_MOUSE_NONE = orxENUM_NONE
}
 
enum  orxPLUGIN_FUNCTION_BASE_ID_PHYSICS {
  orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_INIT = 0, orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_EXIT, orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_SET_GRAVITY, orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_GET_GRAVITY,
  orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_CREATE_BODY, orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_DELETE_BODY, orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_CREATE_PART, orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_DELETE_PART,
  orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_CREATE_JOINT, orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_DELETE_JOINT, orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_SET_POSITION, orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_SET_ROTATION,
  orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_SET_SPEED, orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_SET_ANGULAR_VELOCITY, orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_SET_CUSTOM_GRAVITY, orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_SET_FIXED_ROTATION,
  orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_GET_POSITION, orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_GET_ROTATION, orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_GET_SPEED, orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_GET_SPEED_AT_WORLD_POSITION,
  orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_GET_ANGULAR_VELOCITY, orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_GET_CUSTOM_GRAVITY, orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_IS_FIXED_ROTATION, orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_GET_MASS,
  orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_GET_MASS_CENTER, orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_SET_LINEAR_DAMPING, orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_SET_ANGULAR_DAMPING, orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_GET_LINEAR_DAMPING,
  orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_GET_ANGULAR_DAMPING, orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_APPLY_TORQUE, orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_APPLY_FORCE, orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_APPLY_IMPULSE,
  orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_SET_PART_SELF_FLAGS, orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_SET_PART_CHECK_MASK, orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_GET_PART_SELF_FLAGS, orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_GET_PART_CHECK_MASK,
  orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_IS_PART_SOLID, orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_SET_PART_SOLID, orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_ENABLE_MOTOR, orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_SET_JOINT_MOTOR_SPEED,
  orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_SET_JOINT_MAX_MOTOR_TORQUE, orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_GET_JOINT_REACTION_FORCE, orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_GET_JOINT_REACTION_TORQUE, orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_RAYCAST,
  orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_ENABLE_SIMULATION, orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_NUMBER, orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_NONE = orxENUM_NONE
}
 
enum  orxPLUGIN_FUNCTION_BASE_ID_RENDER {
  orxPLUGIN_FUNCTION_BASE_ID_RENDER_INIT = 0, orxPLUGIN_FUNCTION_BASE_ID_RENDER_EXIT, orxPLUGIN_FUNCTION_BASE_ID_RENDER_GET_WORLD_POSITION, orxPLUGIN_FUNCTION_BASE_ID_RENDER_GET_SCREEN_POSITION,
  orxPLUGIN_FUNCTION_BASE_ID_RENDER_NUMBER, orxPLUGIN_FUNCTION_BASE_ID_RENDER_NONE = orxENUM_NONE
}
 
enum  orxPLUGIN_FUNCTION_BASE_ID_SOUNDSYSTEM {
  orxPLUGIN_FUNCTION_BASE_ID_SOUNDSYSTEM_INIT = 0, orxPLUGIN_FUNCTION_BASE_ID_SOUNDSYSTEM_EXIT, orxPLUGIN_FUNCTION_BASE_ID_SOUNDSYSTEM_CREATE_SAMPLE, orxPLUGIN_FUNCTION_BASE_ID_SOUNDSYSTEM_LOAD_SAMPLE,
  orxPLUGIN_FUNCTION_BASE_ID_SOUNDSYSTEM_DELETE_SAMPLE, orxPLUGIN_FUNCTION_BASE_ID_SOUNDSYSTEM_GET_SAMPLE_INFO, orxPLUGIN_FUNCTION_BASE_ID_SOUNDSYSTEM_SET_SAMPLE_DATA, orxPLUGIN_FUNCTION_BASE_ID_SOUNDSYSTEM_CREATE_FROM_SAMPLE,
  orxPLUGIN_FUNCTION_BASE_ID_SOUNDSYSTEM_CREATE_STREAM, orxPLUGIN_FUNCTION_BASE_ID_SOUNDSYSTEM_CREATE_STREAM_FROM_FILE, orxPLUGIN_FUNCTION_BASE_ID_SOUNDSYSTEM_DELETE, orxPLUGIN_FUNCTION_BASE_ID_SOUNDSYSTEM_PLAY,
  orxPLUGIN_FUNCTION_BASE_ID_SOUNDSYSTEM_PAUSE, orxPLUGIN_FUNCTION_BASE_ID_SOUNDSYSTEM_STOP, orxPLUGIN_FUNCTION_BASE_ID_SOUNDSYSTEM_START_RECORDING, orxPLUGIN_FUNCTION_BASE_ID_SOUNDSYSTEM_STOP_RECORDING,
  orxPLUGIN_FUNCTION_BASE_ID_SOUNDSYSTEM_HAS_RECORDING_SUPPORT, orxPLUGIN_FUNCTION_BASE_ID_SOUNDSYSTEM_SET_VOLUME, orxPLUGIN_FUNCTION_BASE_ID_SOUNDSYSTEM_SET_PITCH, orxPLUGIN_FUNCTION_BASE_ID_SOUNDSYSTEM_SET_POSITION,
  orxPLUGIN_FUNCTION_BASE_ID_SOUNDSYSTEM_SET_ATTENUATION, orxPLUGIN_FUNCTION_BASE_ID_SOUNDSYSTEM_SET_REFERENCE_DISTANCE, orxPLUGIN_FUNCTION_BASE_ID_SOUNDSYSTEM_LOOP, orxPLUGIN_FUNCTION_BASE_ID_SOUNDSYSTEM_GET_VOLUME,
  orxPLUGIN_FUNCTION_BASE_ID_SOUNDSYSTEM_GET_PITCH, orxPLUGIN_FUNCTION_BASE_ID_SOUNDSYSTEM_GET_POSITION, orxPLUGIN_FUNCTION_BASE_ID_SOUNDSYSTEM_GET_ATTENUATION, orxPLUGIN_FUNCTION_BASE_ID_SOUNDSYSTEM_GET_REFERENCE_DISTANCE,
  orxPLUGIN_FUNCTION_BASE_ID_SOUNDSYSTEM_IS_LOOPING, orxPLUGIN_FUNCTION_BASE_ID_SOUNDSYSTEM_GET_DURATION, orxPLUGIN_FUNCTION_BASE_ID_SOUNDSYSTEM_GET_STATUS, orxPLUGIN_FUNCTION_BASE_ID_SOUNDSYSTEM_SET_GLOBAL_VOLUME,
  orxPLUGIN_FUNCTION_BASE_ID_SOUNDSYSTEM_GET_GLOBAL_VOLUME, orxPLUGIN_FUNCTION_BASE_ID_SOUNDSYSTEM_SET_LISTENER_POSITION, orxPLUGIN_FUNCTION_BASE_ID_SOUNDSYSTEM_GET_LISTENER_POSITION, orxPLUGIN_FUNCTION_BASE_ID_SOUNDSYSTEM_NUMBER,
  orxPLUGIN_FUNCTION_BASE_ID_SOUNDSYSTEM_NONE = orxENUM_NONE
}
 
enum  orxPLUGIN_FUNCTION_ID { orxPLUGIN_FUNCTION_ID_NONE = orxENUM_NONE }
 

Functions

orxDLLAPI void orxFASTCALL orxPlugin_AddCoreInfo (orxPLUGIN_CORE_ID _ePluginCoreID, orxMODULE_ID _eModuleID, const orxPLUGIN_CORE_FUNCTION *_astCoreFunction, orxU32 _u32CoreFunctionNumber)
 
 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)
 
orxDLLAPI void *orxFASTCALL orxPlugin_DefaultCoreFunction (const orxSTRING _zFunctionName, const orxSTRING _zFileName, orxU32 _u32Line)
 
orxDLLAPI void orxFASTCALL orxPlugin_Exit ()
 
orxDLLAPI orxPLUGIN_FUNCTION
orxFASTCALL 
orxPlugin_GetFunction (orxHANDLE _hPluginHandle, const orxSTRING _zFunctionName)
 
orxDLLAPI orxHANDLE orxFASTCALL orxPlugin_GetHandle (const orxSTRING _zPluginName)
 
orxDLLAPI const orxSTRING
orxFASTCALL 
orxPlugin_GetName (orxHANDLE _hPluginHandle)
 
orxDLLAPI orxSTATUS orxFASTCALL orxPlugin_Init ()
 
orxDLLAPI orxHANDLE orxFASTCALL orxPlugin_Load (const orxSTRING _zPluginFileName, const orxSTRING _zPluginName)
 
orxDLLAPI orxHANDLE orxFASTCALL orxPlugin_LoadUsingExt (const orxSTRING _zPluginFileName, const orxSTRING _zPluginName)
 
static orxINLINE void orxPlugin_RegisterCorePlugins ()
 
orxDLLAPI void orxFASTCALL orxPlugin_Setup ()
 
orxDLLAPI orxSTATUS orxFASTCALL orxPlugin_Unload (orxHANDLE _hPluginHandle)
 

Detailed Description

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.

Macro Definition Documentation

#define _orxPLUGIN_USER_FUNCTION_ADD_LOW_LEVEL (   FUNCTION,
  FUNCTION_ID,
  NAME,
  ARGS 
)
Value:
if(u32UserPluginFunctionCounter < u32UserPluginFunctionMaxNumber) \
{ \
pstUserPluginFunctionInfo[u32UserPluginFunctionCounter].pfnFunction = (orxPLUGIN_FUNCTION) FUNCTION; \
pstUserPluginFunctionInfo[u32UserPluginFunctionCounter].eFunctionID = FUNCTION_ID; \
pstUserPluginFunctionInfo[u32UserPluginFunctionCounter].zFunctionName = #NAME; \
orxString_NCopy(pstUserPluginFunctionInfo[u32UserPluginFunctionCounter].zFunctionArgs, ARGS, orxPLUGIN_KU32_FUNCTION_ARG_SIZE - 1); \
pstUserPluginFunctionInfo[u32UserPluginFunctionCounter].zFunctionArgs[orxPLUGIN_KU32_FUNCTION_ARG_SIZE - 1] = orxCHAR_NULL; \
u32UserPluginFunctionCounter++; \
} \
else \
{ \
/* Logs message */ \
orxDEBUG_PRINT(orxDEBUG_LEVEL_SYSTEM, "Maximum number of plugin functions reached."); \
}

Definition at line 83 of file orxPluginUser.h.

#define orxPLUGIN_ADD_CORE_FUNCTION_ARRAY (   PLUGIN_SUFFIX,
  FUNCTION_SUFFIX,
  FUNCTION_NAME 
)    {(orxPLUGIN_FUNCTION_ID)orxPLUGIN_FUNCTION_BASE_ID_##PLUGIN_SUFFIX##_##FUNCTION_SUFFIX, (orxPLUGIN_FUNCTION *)&orxPLUGIN_CORE_FUNCTION_POINTER_NAME(FUNCTION_NAME), (orxPLUGIN_FUNCTION)&orxPLUGIN_DEFAULT_CORE_FUNCTION_NAME(FUNCTION_NAME)},

Definition at line 167 of file orxPluginCore.h.

#define orxPLUGIN_BEGIN_CORE_FUNCTION_ARRAY (   PLUGIN_SUFFIX)
Value:
static const orxPLUGIN_CORE_FUNCTION sastPluginFunctionInfo_##PLUGIN_SUFFIX[orxPLUGIN_FUNCTION_BASE_ID_##PLUGIN_SUFFIX##_NUMBER] = \
{

Definition at line 162 of file orxPluginCore.h.

#define orxPLUGIN_CORE_FUNCTION_POINTER_NAME (   FUNCTION_NAME)    _orxCoreFunctionPointer_##FUNCTION_NAME

Definition at line 125 of file orxPluginCore.h.

#define orxPLUGIN_CORE_REGISTER_FUNCTION_NAME (   PLUGIN_SUFFIX)    _registerFunction_##PLUGIN_SUFFIX

Definition at line 48 of file orxPlugin_CoreDefine.h.

#define orxPLUGIN_DECLARE_CORE_REGISTER_FUNCTION (   PLUGIN_SUFFIX)    extern orxDLLAPI void orxPLUGIN_CORE_REGISTER_FUNCTION_NAME(PLUGIN_SUFFIX)()

Definition at line 50 of file orxPlugin_CoreDefine.h.

#define orxPLUGIN_DECLARE_ENTRY_POINT (   ENTRY_FUNCTION)
Value:
extern orxIMPORT orxDLLEXPORT orxSTATUS orxPLUGIN_K_INIT_FUNCTION_NAME(orxS32 *_ps32Number, orxPLUGIN_USER_FUNCTION_INFO **_ppstInfo) \
{ \
orxSTATUS eResult; \
\
/* Calls entry point function */ \
eResult = ENTRY_FUNCTION(); \
\
/* Updates parameters */ \
*_ps32Number = 0; \
*_ppstInfo = orxNULL; \
\
/* Done! */ \
return eResult; \
}

Definition at line 61 of file orxPluginUser.h.

#define orxPLUGIN_DEFAULT_CORE_FUNCTION_DEFINE (   FUNCTION_NAME)
Value:
extern orxDLLAPI void *orxFASTCALL orxPLUGIN_DEFAULT_CORE_FUNCTION_NAME(FUNCTION_NAME)() \
{ \
return(orxPlugin_DefaultCoreFunction(#FUNCTION_NAME, __FILE__, __LINE__)); \
}

Definition at line 131 of file orxPluginCore.h.

#define orxPLUGIN_DEFAULT_CORE_FUNCTION_NAME (   FUNCTION_NAME)    _orxDefaultCoreFunction_##FUNCTION_NAME

Definition at line 128 of file orxPluginCore.h.

#define orxPLUGIN_DEFINE_CORE_FUNCTION (   FUNCTION_NAME,
  RETURN,
  ... 
)
Value:
\
RETURN (orxFASTCALL *orxPLUGIN_CORE_FUNCTION_POINTER_NAME(FUNCTION_NAME))(__VA_ARGS__) = (RETURN(orxFASTCALL *)(__VA_ARGS__)) (&orxPLUGIN_DEFAULT_CORE_FUNCTION_NAME(FUNCTION_NAME))

Definition at line 149 of file orxPluginCore.h.

#define orxPLUGIN_END_CORE_FUNCTION_ARRAY (   PLUGIN_SUFFIX)
Value:
}; \
extern orxDLLAPI void orxPLUGIN_CORE_REGISTER_FUNCTION_NAME(PLUGIN_SUFFIX)() \
{ \
orxPLUGIN_REGISTER_CORE_INFO(PLUGIN_SUFFIX); \
return; \
}

Definition at line 171 of file orxPluginCore.h.

#define orxPLUGIN_K_CORE_INIT_FUNCTION_NAME (   SUFFIX)    orxPlugin_MainInit

Plugin core init function name

Definition at line 83 of file orxPluginType.h.

#define orxPLUGIN_K_INIT_FUNCTION_NAME   orxPlugin_MainInit

Plugin init function name

Definition at line 73 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_MAKE_CORE_FUNCTION_ID (   PLUGIN_CORE_ID,
  FUNCTION_BASE_ID 
)    (orxPLUGIN_FUNCTION_ID)(orxPLUGIN_KU32_FLAG_CORE_ID | orxPLUGIN_MAKE_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 
)    (orxPLUGIN_FUNCTION_ID)(((PLUGIN_ID << orxPLUGIN_KU32_SHIFT_PLUGIN_ID) & orxPLUGIN_KU32_MASK_PLUGIN_ID) | (FUNCTION_BASE_ID & orxPLUGIN_KU32_MASK_FUNCTION_ID))

Definition at line 65 of file orxPluginType.h.

#define orxPLUGIN_REGISTER_CORE_INFO (   PLUGIN_SUFFIX)    orxPlugin_AddCoreInfo(orxPLUGIN_CORE_ID_##PLUGIN_SUFFIX, orxMODULE_ID_##PLUGIN_SUFFIX, sastPluginFunctionInfo_##PLUGIN_SUFFIX, sizeof(sastPluginFunctionInfo_##PLUGIN_SUFFIX) / sizeof(orxPLUGIN_CORE_FUNCTION));

Definition at line 197 of file orxPluginCore.h.

#define orxPLUGIN_USER_CORE_FUNCTION_ADD (   FUNCTION,
  PLUGIN_SUFFIX,
  NAME_SUFFIX 
)
Value:
orxPLUGIN_MAKE_CORE_FUNCTION_ID(orxPLUGIN_CORE_ID_##PLUGIN_SUFFIX, orxPLUGIN_FUNCTION_BASE_ID_##PLUGIN_SUFFIX##_##NAME_SUFFIX), \
PLUGIN_SUFFIX##_##NAME_SUFFIX, \

Definition at line 124 of file orxPluginUser.h.

#define orxPLUGIN_USER_CORE_FUNCTION_END ( )
Value:
orxPLUGIN_USER_FUNCTION_END(_ps32Number, _ppstInfo); \
return eResult; \
}

Definition at line 130 of file orxPluginUser.h.

#define orxPLUGIN_USER_CORE_FUNCTION_START (   PLUGIN_SUFFIX)
Value:
static orxPLUGIN_USER_FUNCTION_INFO sau32##PLUGIN_SUFFIX##_Function[orxPLUGIN_FUNCTION_BASE_ID_##PLUGIN_SUFFIX##_NUMBER]; \
extern orxIMPORT orxDLLEXPORT orxSTATUS orxPLUGIN_K_CORE_INIT_FUNCTION_NAME(PLUGIN_SUFFIX)(orxS32 *_ps32Number, orxPLUGIN_USER_FUNCTION_INFO **_ppstInfo) \
{ \
orxPLUGIN_USER_FUNCTION_START(sau32##PLUGIN_SUFFIX##_Function);

Definition at line 117 of file orxPluginUser.h.

#define orxPLUGIN_USER_FUNCTION_ADD (   FUNCTION,
  ARGS,
  PLUGIN_ID,
  FUNCTION_BASE_ID,
  NAME 
)
Value:
orxPLUGIN_MAKE_FUNCTION_ID(PLUGIN_ID, FUNCTION_BASE_ID), \
NAME, \
ARGS)

Definition at line 106 of file orxPluginUser.h.

#define orxPLUGIN_USER_FUNCTION_END (   NUMBER_ADDRESS,
  STRUCTURE_ADDRESS 
)
Value:
*NUMBER_ADDRESS = u32UserPluginFunctionCounter; \
*STRUCTURE_ADDRESS = pstUserPluginFunctionInfo; \
}

Definition at line 112 of file orxPluginUser.h.

#define orxPLUGIN_USER_FUNCTION_START (   STRUCTURE)
Value:
{ \
orxU32 u32UserPluginFunctionCounter = 0; \
orxU32 u32UserPluginFunctionMaxNumber = sizeof(STRUCTURE) / sizeof(orxPLUGIN_USER_FUNCTION_INFO); \
orxPLUGIN_USER_FUNCTION_INFO *pstUserPluginFunctionInfo = STRUCTURE; \
orxMemory_Zero(pstUserPluginFunctionInfo, u32UserPluginFunctionMaxNumber * sizeof(orxPLUGIN_USER_FUNCTION_INFO));

Definition at line 99 of file orxPluginUser.h.

Typedef Documentation

typedef orxSTATUS(orxFASTCALL * orxPLUGIN_FUNCTION)()

Definition at line 98 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.

Enumeration Type Documentation

Enumerator:
orxPLUGIN_CORE_ID_DISPLAY 
orxPLUGIN_CORE_ID_JOYSTICK 
orxPLUGIN_CORE_ID_KEYBOARD 
orxPLUGIN_CORE_ID_MOUSE 
orxPLUGIN_CORE_ID_PHYSICS 
orxPLUGIN_CORE_ID_RENDER 
orxPLUGIN_CORE_ID_SOUNDSYSTEM 
orxPLUGIN_CORE_ID_NUMBER 
orxPLUGIN_CORE_ID_NONE 

Definition at line 47 of file orxPlugin_CoreID.h.

Enumerator:
orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_INIT 
orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_EXIT 
orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_SWAP 
orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_GET_SCREEN_BITMAP 
orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_GET_SCREEN_SIZE 
orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_CREATE_BITMAP 
orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_DELETE_BITMAP 
orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_LOAD_BITMAP 
orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_SAVE_BITMAP 
orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_SET_DESTINATION_BITMAPS 
orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_CLEAR_BITMAP 
orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_SET_BLEND_MODE 
orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_SET_BITMAP_CLIPPING 
orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_SET_BITMAP_COLOR_KEY 
orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_SET_BITMAP_DATA 
orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_GET_BITMAP_DATA 
orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_SET_BITMAP_COLOR 
orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_GET_BITMAP_COLOR 
orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_GET_BITMAP_SIZE 
orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_GET_BITMAP_ID 
orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_TRANSFORM_BITMAP 
orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_TRANSFORM_TEXT 
orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_DRAW_LINE 
orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_DRAW_POLYLINE 
orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_DRAW_POLYGON 
orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_DRAW_CIRCLE 
orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_DRAW_OBOX 
orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_DRAW_MESH 
orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_HAS_SHADER_SUPPORT 
orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_CREATE_SHADER 
orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_DELETE_SHADER 
orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_START_SHADER 
orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_STOP_SHADER 
orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_GET_PARAMETER_ID 
orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_SET_SHADER_BITMAP 
orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_SET_SHADER_FLOAT 
orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_SET_SHADER_VECTOR 
orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_ENABLE_VSYNC 
orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_IS_VSYNC_ENABLED 
orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_SET_FULL_SCREEN 
orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_IS_FULL_SCREEN 
orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_GET_VIDEO_MODE_COUNTER 
orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_GET_VIDEO_MODE 
orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_SET_VIDEO_MODE 
orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_IS_VIDEO_MODE_AVAILABLE 
orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_NUMBER 
orxPLUGIN_FUNCTION_BASE_ID_DISPLAY_NONE 

Definition at line 48 of file orxPlugin_Display.h.

Enumerator:
orxPLUGIN_FUNCTION_BASE_ID_JOYSTICK_INIT 
orxPLUGIN_FUNCTION_BASE_ID_JOYSTICK_EXIT 
orxPLUGIN_FUNCTION_BASE_ID_JOYSTICK_GET_AXIS_VALUE 
orxPLUGIN_FUNCTION_BASE_ID_JOYSTICK_IS_BUTTON_PRESSED 
orxPLUGIN_FUNCTION_BASE_ID_JOYSTICK_NUMBER 
orxPLUGIN_FUNCTION_BASE_ID_JOYSTICK_NONE 

Definition at line 48 of file orxPlugin_Joystick.h.

Enumerator:
orxPLUGIN_FUNCTION_BASE_ID_KEYBOARD_INIT 
orxPLUGIN_FUNCTION_BASE_ID_KEYBOARD_EXIT 
orxPLUGIN_FUNCTION_BASE_ID_KEYBOARD_IS_KEY_PRESSED 
orxPLUGIN_FUNCTION_BASE_ID_KEYBOARD_READ_KEY 
orxPLUGIN_FUNCTION_BASE_ID_KEYBOARD_READ_STRING 
orxPLUGIN_FUNCTION_BASE_ID_KEYBOARD_CLEAR_BUFFER 
orxPLUGIN_FUNCTION_BASE_ID_KEYBOARD_SHOW 
orxPLUGIN_FUNCTION_BASE_ID_KEYBOARD_NUMBER 
orxPLUGIN_FUNCTION_BASE_ID_KEYBOARD_NONE 

Definition at line 48 of file orxPlugin_Keyboard.h.

Enumerator:
orxPLUGIN_FUNCTION_BASE_ID_MOUSE_INIT 
orxPLUGIN_FUNCTION_BASE_ID_MOUSE_EXIT 
orxPLUGIN_FUNCTION_BASE_ID_MOUSE_SET_POSITION 
orxPLUGIN_FUNCTION_BASE_ID_MOUSE_GET_POSITION 
orxPLUGIN_FUNCTION_BASE_ID_MOUSE_IS_BUTTON_PRESSED 
orxPLUGIN_FUNCTION_BASE_ID_MOUSE_GET_MOVE_DELTA 
orxPLUGIN_FUNCTION_BASE_ID_MOUSE_GET_WHEEL_DELTA 
orxPLUGIN_FUNCTION_BASE_ID_MOUSE_SHOW_CURSOR 
orxPLUGIN_FUNCTION_BASE_ID_MOUSE_NUMBER 
orxPLUGIN_FUNCTION_BASE_ID_MOUSE_NONE 

Definition at line 48 of file orxPlugin_Mouse.h.

Enumerator:
orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_INIT 
orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_EXIT 
orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_SET_GRAVITY 
orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_GET_GRAVITY 
orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_CREATE_BODY 
orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_DELETE_BODY 
orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_CREATE_PART 
orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_DELETE_PART 
orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_CREATE_JOINT 
orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_DELETE_JOINT 
orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_SET_POSITION 
orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_SET_ROTATION 
orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_SET_SPEED 
orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_SET_ANGULAR_VELOCITY 
orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_SET_CUSTOM_GRAVITY 
orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_SET_FIXED_ROTATION 
orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_GET_POSITION 
orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_GET_ROTATION 
orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_GET_SPEED 
orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_GET_SPEED_AT_WORLD_POSITION 
orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_GET_ANGULAR_VELOCITY 
orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_GET_CUSTOM_GRAVITY 
orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_IS_FIXED_ROTATION 
orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_GET_MASS 
orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_GET_MASS_CENTER 
orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_SET_LINEAR_DAMPING 
orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_SET_ANGULAR_DAMPING 
orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_GET_LINEAR_DAMPING 
orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_GET_ANGULAR_DAMPING 
orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_APPLY_TORQUE 
orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_APPLY_FORCE 
orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_APPLY_IMPULSE 
orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_SET_PART_SELF_FLAGS 
orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_SET_PART_CHECK_MASK 
orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_GET_PART_SELF_FLAGS 
orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_GET_PART_CHECK_MASK 
orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_IS_PART_SOLID 
orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_SET_PART_SOLID 
orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_ENABLE_MOTOR 
orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_SET_JOINT_MOTOR_SPEED 
orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_SET_JOINT_MAX_MOTOR_TORQUE 
orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_GET_JOINT_REACTION_FORCE 
orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_GET_JOINT_REACTION_TORQUE 
orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_RAYCAST 
orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_ENABLE_SIMULATION 
orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_NUMBER 
orxPLUGIN_FUNCTION_BASE_ID_PHYSICS_NONE 

Definition at line 48 of file orxPlugin_Physics.h.

Enumerator:
orxPLUGIN_FUNCTION_BASE_ID_RENDER_INIT 
orxPLUGIN_FUNCTION_BASE_ID_RENDER_EXIT 
orxPLUGIN_FUNCTION_BASE_ID_RENDER_GET_WORLD_POSITION 
orxPLUGIN_FUNCTION_BASE_ID_RENDER_GET_SCREEN_POSITION 
orxPLUGIN_FUNCTION_BASE_ID_RENDER_NUMBER 
orxPLUGIN_FUNCTION_BASE_ID_RENDER_NONE 

Definition at line 48 of file orxPlugin_Render.h.

Enumerator:
orxPLUGIN_FUNCTION_BASE_ID_SOUNDSYSTEM_INIT 
orxPLUGIN_FUNCTION_BASE_ID_SOUNDSYSTEM_EXIT 
orxPLUGIN_FUNCTION_BASE_ID_SOUNDSYSTEM_CREATE_SAMPLE 
orxPLUGIN_FUNCTION_BASE_ID_SOUNDSYSTEM_LOAD_SAMPLE 
orxPLUGIN_FUNCTION_BASE_ID_SOUNDSYSTEM_DELETE_SAMPLE 
orxPLUGIN_FUNCTION_BASE_ID_SOUNDSYSTEM_GET_SAMPLE_INFO 
orxPLUGIN_FUNCTION_BASE_ID_SOUNDSYSTEM_SET_SAMPLE_DATA 
orxPLUGIN_FUNCTION_BASE_ID_SOUNDSYSTEM_CREATE_FROM_SAMPLE 
orxPLUGIN_FUNCTION_BASE_ID_SOUNDSYSTEM_CREATE_STREAM 
orxPLUGIN_FUNCTION_BASE_ID_SOUNDSYSTEM_CREATE_STREAM_FROM_FILE 
orxPLUGIN_FUNCTION_BASE_ID_SOUNDSYSTEM_DELETE 
orxPLUGIN_FUNCTION_BASE_ID_SOUNDSYSTEM_PLAY 
orxPLUGIN_FUNCTION_BASE_ID_SOUNDSYSTEM_PAUSE 
orxPLUGIN_FUNCTION_BASE_ID_SOUNDSYSTEM_STOP 
orxPLUGIN_FUNCTION_BASE_ID_SOUNDSYSTEM_START_RECORDING 
orxPLUGIN_FUNCTION_BASE_ID_SOUNDSYSTEM_STOP_RECORDING 
orxPLUGIN_FUNCTION_BASE_ID_SOUNDSYSTEM_HAS_RECORDING_SUPPORT 
orxPLUGIN_FUNCTION_BASE_ID_SOUNDSYSTEM_SET_VOLUME 
orxPLUGIN_FUNCTION_BASE_ID_SOUNDSYSTEM_SET_PITCH 
orxPLUGIN_FUNCTION_BASE_ID_SOUNDSYSTEM_SET_POSITION 
orxPLUGIN_FUNCTION_BASE_ID_SOUNDSYSTEM_SET_ATTENUATION 
orxPLUGIN_FUNCTION_BASE_ID_SOUNDSYSTEM_SET_REFERENCE_DISTANCE 
orxPLUGIN_FUNCTION_BASE_ID_SOUNDSYSTEM_LOOP 
orxPLUGIN_FUNCTION_BASE_ID_SOUNDSYSTEM_GET_VOLUME 
orxPLUGIN_FUNCTION_BASE_ID_SOUNDSYSTEM_GET_PITCH 
orxPLUGIN_FUNCTION_BASE_ID_SOUNDSYSTEM_GET_POSITION 
orxPLUGIN_FUNCTION_BASE_ID_SOUNDSYSTEM_GET_ATTENUATION 
orxPLUGIN_FUNCTION_BASE_ID_SOUNDSYSTEM_GET_REFERENCE_DISTANCE 
orxPLUGIN_FUNCTION_BASE_ID_SOUNDSYSTEM_IS_LOOPING 
orxPLUGIN_FUNCTION_BASE_ID_SOUNDSYSTEM_GET_DURATION 
orxPLUGIN_FUNCTION_BASE_ID_SOUNDSYSTEM_GET_STATUS 
orxPLUGIN_FUNCTION_BASE_ID_SOUNDSYSTEM_SET_GLOBAL_VOLUME 
orxPLUGIN_FUNCTION_BASE_ID_SOUNDSYSTEM_GET_GLOBAL_VOLUME 
orxPLUGIN_FUNCTION_BASE_ID_SOUNDSYSTEM_SET_LISTENER_POSITION 
orxPLUGIN_FUNCTION_BASE_ID_SOUNDSYSTEM_GET_LISTENER_POSITION 
orxPLUGIN_FUNCTION_BASE_ID_SOUNDSYSTEM_NUMBER 
orxPLUGIN_FUNCTION_BASE_ID_SOUNDSYSTEM_NONE 

Definition at line 49 of file orxPlugin_SoundSystem.h.

Enumerator:
orxPLUGIN_FUNCTION_ID_NONE 

Definition at line 92 of file orxPluginType.h.

Function Documentation

orxDLLAPI void orxFASTCALL orxPlugin_AddCoreInfo ( orxPLUGIN_CORE_ID  _ePluginCoreID,
orxMODULE_ID  _eModuleID,
const orxPLUGIN_CORE_FUNCTION _astCoreFunction,
orxU32  _u32CoreFunctionNumber 
)

Adds an info structure for the given core module Has to be called during a core module init

Parameters
[in]_ePluginCoreIDThe numeric id of the core plugin
[in]_eModuleIDCorresponding module ID
[in]_astCoreFunctionThe pointer on the core functions info array
[in]_u32CoreFunctionNumberNumber of functions in the array
Returns
nothing.
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  )
orxDLLAPI void* orxFASTCALL orxPlugin_DefaultCoreFunction ( const orxSTRING  _zFunctionName,
const orxSTRING  _zFileName,
orxU32  _u32Line 
)

Default core plugin function Needs to be referenced by all core functions at module init.

orxDLLAPI void orxFASTCALL orxPlugin_Exit ( )

Exits from the plugin module

orxDLLAPI orxPLUGIN_FUNCTION orxFASTCALL orxPlugin_GetFunction ( orxHANDLE  _hPluginHandle,
const orxSTRING  _zFunctionName 
)

Gets a function from a plugin

Parameters
[in]_hPluginHandleThe plugin handle
[in]_zFunctionNameThe name of the function to find
Returns
orxPLUGIN_FUNCTION / orxNULL
orxDLLAPI orxHANDLE orxFASTCALL orxPlugin_GetHandle ( const orxSTRING  _zPluginName)

Gets the handle of a plugin given its name

Parameters
[in]_zPluginNameThe plugin name
Returns
Its orxHANDLE / orxHANDLE_UNDEFINED
orxDLLAPI const orxSTRING orxFASTCALL orxPlugin_GetName ( orxHANDLE  _hPluginHandle)

Gets the name of a plugin given its handle

Parameters
[in]_hPluginHandleThe plugin handle
Returns
The plugin name / orxSTRING_EMPTY
orxDLLAPI orxSTATUS orxFASTCALL orxPlugin_Init ( )

Inits the plugin module

Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI orxHANDLE orxFASTCALL orxPlugin_Load ( const orxSTRING  _zPluginFileName,
const orxSTRING  _zPluginName 
)

Loads a plugin (using its exact complete)

Parameters
[in]_zPluginFileNameThe complete path of the plugin file, including its extension
[in]_zPluginNameThe name that the plugin will be given in the plugin list
Returns
The plugin handle on success, orxHANDLE_UNDEFINED on failure
orxDLLAPI orxHANDLE orxFASTCALL orxPlugin_LoadUsingExt ( const orxSTRING  _zPluginFileName,
const orxSTRING  _zPluginName 
)

Loads a plugin using OS common library extension + release/debug suffixes

Parameters
[in]_zPluginFileNameThe complete path of the plugin file, without its library extension
[in]_zPluginNameThe name that the plugin will be given in the plugin list
Returns
The plugin handle on success, orxHANDLE_UNDEFINED on failure
static orxINLINE void orxPlugin_RegisterCorePlugins ( )
static

Definition at line 79 of file orxPlugin_CoreDefine.h.

orxDLLAPI void orxFASTCALL orxPlugin_Setup ( )

Plugin module setup

orxDLLAPI orxSTATUS orxFASTCALL orxPlugin_Unload ( orxHANDLE  _hPluginHandle)

Unloads a plugin

Parameters
[in]_hPluginHandleThe handle of the plugin to unload
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE

Generated for orx by doxygen 1.5.6