_AWEPlugin
Module: AudioWeaver Plugins
A struct encapsulating the functionality which can be provided by a plugin library. More...
#include <AWEPluginTypes.h>
Public Attributes
| Name | |
|---|---|
| const char * | apiVersion API version that this plugin was built with. |
| const char * | pluginVersion Optional plugin version. |
| const char * | name Optional plugin name. |
| AWEPluginModuleArray | modules List of module classes provided by the plugin. |
| void()(const struct _AWEPlugin ) | cleanup Optional destructor. |
Detailed Description
struct _AWEPlugin;
A struct encapsulating the functionality which can be provided by a plugin library.
This struct is to be returned by the plugin's AWEPlugin_initialize entrypoint. Optional fields can be set to NULL.
Public Attributes Documentation
variable apiVersion
const char * apiVersion;
API version that this plugin was built with.
Should always be set to AWE_PLUGIN_API_VERSION
variable pluginVersion
const char * pluginVersion;
Optional plugin version.
If the plugin has its own versioning scheme, use this to present that information to the loader. This is currently unused.
variable name
const char * name;
Optional plugin name.
Currently unused, but should be globally unique.
variable modules
AWEPluginModuleArray modules;
List of module classes provided by the plugin.
variable cleanup
void(*)(const struct _AWEPlugin *) cleanup;
Optional destructor.
If set, the loader will call this function before it is freed. Use it to deallocate dynamic memory or any other cleanup task required by the plugin.
Updated on 2026-02-10 at 15:44:29 -0500