PolyphasePluginAPI.h File Reference

Stable C ABI header for native addon plugins. More...

#include <stdint.h>

Go to the source code of this file.

Classes
struct	PolyphasePluginDesc
	Plugin descriptor returned by PolyphasePlugin_GetDesc. More...

Macros
#define	POLYPHASE_PLUGIN_API   __attribute__((visibility("default")))
#define	POLYPHASE_PLUGIN_API_VERSION   3
#define	POLYPHASE_PLUGIN_ENTRY()    extern "C" POLYPHASE_PLUGIN_API int PolyphasePlugin_GetDesc(PolyphasePluginDesc* outDesc)
#define	OCTAVE_PLUGIN_API   POLYPHASE_PLUGIN_API
#define	OCTAVE_PLUGIN_EXPORT   POLYPHASE_PLUGIN_EXPORT
#define	OCTAVE_PLUGIN_API_VERSION   POLYPHASE_PLUGIN_API_VERSION
#define	OCTAVE_PLUGIN_ENTRY   POLYPHASE_PLUGIN_ENTRY
#define	OctavePluginDesc   PolyphasePluginDesc
#define	OctavePlugin_GetDescFunc   PolyphasePlugin_GetDescFunc
#define	OctavePlugin_GetDesc   PolyphasePlugin_GetDesc
#define	OctaveEngineAPI   PolyphaseEngineAPI

Typedefs
typedef int(*	PolyphasePlugin_GetDescFunc) (PolyphasePluginDesc *outDesc)
	Plugin entry point function signature.

Detailed Description

Stable C ABI header for native addon plugins.

This header defines the interface that native addons must implement to be loaded by the Polyphase engine/editor.

Macro Definition Documentation

OCTAVE_PLUGIN_API

#define OCTAVE_PLUGIN_API   POLYPHASE_PLUGIN_API

OCTAVE_PLUGIN_API_VERSION

#define OCTAVE_PLUGIN_API_VERSION   POLYPHASE_PLUGIN_API_VERSION

OCTAVE_PLUGIN_ENTRY

#define OCTAVE_PLUGIN_ENTRY   POLYPHASE_PLUGIN_ENTRY

OCTAVE_PLUGIN_EXPORT

#define OCTAVE_PLUGIN_EXPORT   POLYPHASE_PLUGIN_EXPORT

OctaveEngineAPI

#define OctaveEngineAPI   PolyphaseEngineAPI

OctavePlugin_GetDesc

#define OctavePlugin_GetDesc   PolyphasePlugin_GetDesc

OctavePlugin_GetDescFunc

#define OctavePlugin_GetDescFunc   PolyphasePlugin_GetDescFunc

OctavePluginDesc

#define OctavePluginDesc   PolyphasePluginDesc

POLYPHASE_PLUGIN_API

#define POLYPHASE_PLUGIN_API   __attribute__((visibility("default")))

POLYPHASE_PLUGIN_API_VERSION

#define POLYPHASE_PLUGIN_API_VERSION   3

POLYPHASE_PLUGIN_ENTRY

#define POLYPHASE_PLUGIN_ENTRY

(

)

extern "C" POLYPHASE_PLUGIN_API int PolyphasePlugin_GetDesc(PolyphasePluginDesc* outDesc)

Typedef Documentation

PolyphasePlugin_GetDescFunc

typedef int(* PolyphasePlugin_GetDescFunc) (PolyphasePluginDesc *outDesc)

Plugin entry point function signature.

Every plugin must export a function named "PolyphasePlugin_GetDesc" with this signature.

Parameters

outDesc

Pointer to descriptor struct to fill in

Returns

0 on success, non-zero on failure