#include "ofxCore.h"
#include "ofxAttribute.h"
#include "ofxParam.h"

Include dependency graph for ofxParamAPI.h:

Data Structures
struct	OfxParamNodeSuiteV1
	The OFX suite for param manipulation. More...
Defines
#define	kOfxParamPluginApi "OfxParamPluginAPI"
	String used to label OFX Param manipulation Plug-ins.
#define	kOfxParamPluginApiVersion 1
	The current version of the Param API.
#define	kOfxTypeParameterNodeHost "OfxTypeParameterNodeHost"
	Used as a value for kOfxPropType on param node host handles.
#define	kOfxTypeParameterNode "OfxTypeParameterNode"
	Used as a value for kOfxPropType on param node plugin handles.
#define	kOfxTypeParameterNodeInstance "OfxTypeParameterNodeInstance"
	Used as a value for kOfxPropType on image effect instance handles.
#define	kOfxParamNodeActionGetTimeDomain "OfxParamNodeActionGetTimeDomain"
#define	kOfxParamNodeActionGetTimeRangeNeeded "OfxParamNodeActionGetTimeRangeNeeded"
	GetTimeRangeNeeded is similar to the function GetFramesNeeded in ImageEffectNode.
#define	kOfxParamNodeActionProcess "OfxParamNodeActionProcess"
#define	kOfxParamNodeActionBeginSequenceProcess "OfxParamNodeActionBeginSequenceProcess"
#define	kOfxParamNodeActionEndSequenceProcess "OfxParamNodeActionEndSequenceProcess"
#define	kOfxParamNodeSuite "OfxParamNodeSuite"
	the string that names image effect suites, passed to OfxHost::fetchSuite
Typedefs
typedef struct OfxParamNodeStruct *	OfxParamNodeHandle
	Blind declaration of an OFX param node.
typedef struct OfxParamNodeSuiteV1	OfxParamNodeSuiteV1
	The OFX suite for param manipulation.

Define Documentation

#define kOfxParamNodeSuite "OfxParamNodeSuite"

the string that names image effect suites, passed to OfxHost::fetchSuite

Definition at line 56 of file ofxParamAPI.h.

#define kOfxParamPluginApi "OfxParamPluginAPI"

String used to label OFX Param manipulation Plug-ins.

Set the pluginApi member of the OfxPluginHeader inside any OfxParamNodePluginStruct to be this so that the host knows the plugin is an param node.

Definition at line 18 of file ofxParamAPI.h.

#define kOfxParamPluginApiVersion 1

The current version of the Param API.

Definition at line 23 of file ofxParamAPI.h.

#define kOfxTypeParameterNode "OfxTypeParameterNode"

Used as a value for kOfxPropType on param node plugin handles.

Definition at line 34 of file ofxParamAPI.h.

#define kOfxTypeParameterNodeHost "OfxTypeParameterNodeHost"

Used as a value for kOfxPropType on param node host handles.

Definition at line 31 of file ofxParamAPI.h.

#define kOfxTypeParameterNodeInstance "OfxTypeParameterNodeInstance"

Used as a value for kOfxPropType on image effect instance handles.

Definition at line 37 of file ofxParamAPI.h.

Typedef Documentation

typedef struct OfxParamNodeStruct* OfxParamNodeHandle

Blind declaration of an OFX param node.

Definition at line 27 of file ofxParamAPI.h.

The OFX suite for param manipulation.

This suite provides the functions needed by a plugin to defined and use a param manipulation plugin.