messiah_module.h


Provides functions for registering modules.

Version:
1.1
Date:
6/07/03
Topics:
Module Type Macros ( FX_MODTYPE_* )
Functions ( fxModule* )


Module Type Macros

These macros define the types of modules that can be built with the messiahAPI. See Module for more information.


#define FX_MODTYPE_EFFECT
 Effect extension module.

#define FX_MODTYPE_SHADER
 Shader extension module (Render mode).

#define FX_MODTYPE_EDIT
 Edit extension module (Edit mode).

#define FX_MODTYPE_PLAY
 Play extension module (Play mode).

#define FX_MODTYPE_CUSTOMIZE
 Customize extension module (Customize mode).

#define FX_MODTYPE_SETUP
 Setup extension module (Setup mode).

#define FX_MODTYPE_ACTION
 Armature action module (Setup mode).


Functions



FXint fxModuleDescription (FXchar *desc, FXint flags)
 Sets a human-readable description of the module about to be registered.

FXint fxModuleAccess (FXint level, FXint64 entry, FXint clear)
 Requests Access Notification messages.

FXmodule fxModuleRegister (FXint type, FXchar *name, FXvoid *access_func, FXint flags)
 Registers a new module with messiah.


Function Documentation

FXint fxModuleAccess FXint    level,
FXint64    entry,
FXint    clear
 

Requests Access Notification messages.

Parameters:
level [in] Access Level requested
entry [in] Access Notifications requested
clear [in] FX_TRUE to clear a previously set AN request, FX_FALSE otherwise
Return values:
FX_TRUE on success
FX_FALSE on failure
Attention:
You must call fxModuleAccess() to request any AN messages you will need prior to registering the module
See also:
Access Notification

FXint fxModuleDescription FXchar   desc,
FXint    flags
 

Sets a human-readable description of the module about to be registered.

Parameters:
desc [in] Null terminated string representing the description
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
This function allows you to set a description of the module you are about to register so that users can get some idea about what it does from inside of messiah. You must call this function prior to fxModuleRegister().

FXmodule fxModuleRegister FXint    type,
FXchar   name,
FXvoid   access_func,
FXint    flags
 

Registers a new module with messiah.

Parameters:
type [in] the type of module being registered
name [in] name of the module as it will appear in messiah
access_func [in] access_func() that will handle all AN messages for this module
flags [in] Reserved for future use
Return values:
FXmodule that uniquely identifies this module
FX_NULLID on failure
The type of module you are registering, as indicated by the type argument, will be one of the FX_MODTYPE_*. The name will be what appears in messiah and should contain only alpha numeric characters (no white spaces or special characters). The argument access_func is your access_func() that you have designated to handle all AN messages directed to this module.
Attention:
You must call fxModuleAccess() to request any AN messages you will need prior to registering the module
See also:
Access Notification


© 2003 pmG WorldWide, LLC.


www.projectmessiah.com

groups.yahoo.com/pmGmessiah

Last Updated on Thu Jul 10 04:49:37 2003