Katana Plug-in APIs 0.1
Classes | Typedefs | Enumerations

Plug-in System

Classes

struct  FnPluginHost
 The basic host information that will be provided to a plug-in by setHost(). More...
struct  FnPlugin
 The basic plug-in information that must be returned from a call to getPlugins(). More...

Typedefs

typedef FnPluginStatus FnPlugStatus
 Alias of FnPluginStatus.
typedef FnPlugin *(* FnGetPluginsFunc )(unsigned int *numPlugins)
 Returns a list of plug-ins provided by a plug-in library.

Enumerations

enum  FnPluginStatus
 

The return status of some of the Plug-in System functions.



Detailed Description

This system provides the framework for retrieving plug-ins from custom built libraries.

To implement a plug-in:


Typedef Documentation

Returns a list of plug-ins provided by a plug-in library.

 FnPlugin *getPlugins(unsigned int *numPlugins); 

This is the only externally-visible function that must be implemented by every plug-in library.

Parameters:
numPluginsWrite the number of plug-ins provided by the library here. The pointer will not be NULL.
Returns:
A pointer to an array of plug-in structures, or NULL if none are supported
 All Classes Functions Variables Typedefs Enumerations Enumerator