#include "ofxCorePlugin.h"

Include dependency graph for ofxCore.h:

Data Structures
struct	OfxRangeI
	Defines one dimensional integer bounds. More...
struct	OfxRangeD
	Defines one dimensional double bounds. More...
struct	OfxPointI
	Defines two dimensional integer point. More...
struct	OfxPointD
	Defines two dimensional double point. More...
struct	OfxRectI
	Defines two dimensional integer region. More...
struct	OfxRectD
	Defines two dimensional double region. More...
struct	Ofx3DPointI
	Defines an integer 3D point. More...
struct	Ofx3DPointD
	Defines a double precision 3D point. More...
Defines
#define	kOfxPropAPIVersion "OfxPropAPIVersion"
	Property on the host descriptor, saying what API version of the API is being implemented.
#define	kOfxPropTime "OfxPropTime"
	General property used to get/set the time of something.
#define	kOfxPropIsInteractive "OfxPropIsInteractive"
	Indicates if a host is actively editing the effect with some GUI.
#define	kOfxPluginPropFilePath "OfxPluginPropFilePath"
	The file path to the plugin.
#define	kOfxPropInstanceData "OfxPropInstanceData"
	A private data pointer that the plug-in can store its own data behind.
#define	kOfxPropType "OfxPropType"
	General property, used to identify the kind of an object behind a handle.
#define	kOfxPropName "OfxPropName"
	Unique name of an object.
#define	kOfxPropVersion "OfxPropVersion"
	Identifies a specific version of a host or plugin.
#define	kOfxPropVersionLabel "OfxPropVersionLabel"
	Unique user readable version string of a plugin or host.
#define	kOfxPropPluginDescription "OfxPropPluginDescription"
	Description of the plug-in to a user.
#define	kOfxPropLabel "OfxPropLabel"
	User visible name of an object.
#define	kOfxPropIcon "OfxPropIcon"
	If set this tells the host to use an icon instead of a label for some object in the interface.
#define	kOfxPropShortLabel "OfxPropShortLabel"
	Short user visible name of an object.
#define	kOfxPropLongLabel "OfxPropLongLabel"
	Long user visible name of an object.
#define	kOfxPropChangeReason "OfxPropChangeReason"
	Indicates why a plug-in changed.
#define	kOfxPropEffectInstance "OfxPropEffectInstance"
	A pointer to an effect instance.
#define	kOfxPropHostOSHandle "OfxPropHostOSHandle"
	A pointer to an operating system specific application handle.
#define	kOfxChangeUserEdited "OfxChangeUserEdited"
	String used as a value to kOfxPropChangeReason to indicate a user has changed something.
#define	kOfxChangePluginEdited "OfxChangePluginEdited"
	String used as a value to kOfxPropChangeReason to indicate the plug-in itself has changed something.
#define	kOfxChangeTime "OfxChangeTime"
	String used as a value to kOfxPropChangeReason to a time varying object has changed due to a time change.
#define	kOfxFlagInfiniteMax INT_MAX
	Used to flag infinite rects. Set minimums to this to indicate infinite.
#define	kOfxFlagInfiniteMin INT_MIN
	Used to flag infinite rects. Set minimums to this to indicate infinite.
#define	kOfxBitDepthNone "OfxBitDepthNone"
	String used to label unset bitdepths.
#define	kOfxBitDepthByte "OfxBitDepthByte"
	String used to label unsigned 8 bit integer samples.
#define	kOfxBitDepthShort "OfxBitDepthShort"
	String used to label unsigned 16 bit integer samples.
#define	kOfxBitDepthFloat "OfxBitDepthFloat"
	String used to label signed 32 bit floating point samples.

#define	kOfxActionPurgeCaches "OfxActionPurgeCaches"
	Action called to have a plug-in purge any temporary caches it may have allocated ArchitectureMainFunction and ActionsGeneralPurgeCaches.
#define	kOfxActionSyncPrivateData "OfxActionSyncPrivateData"
	Action called to have a plug-in sync any internal data structures into custom parameters.
#define	kOfxActionInstanceChanged "OfxActionInstanceChanged"
	Action indicating something in the instance has been changed, see ActionsGeneralInstanceChanged.
#define	kOfxActionBeginInstanceChanged "OfxActionBeginInstanceChanged"
	Action called before the start of a set of kOfxActionEndInstanceChanged actions, used with kOfxActionEndInstanceChanged to bracket a grouped set of changes, see ActionsGeneralInstanceChangedBeginEnd.
#define	kOfxActionEndInstanceChanged "OfxActionEndInstanceChanged"
	Action called after the end of a set of kOfxActionEndInstanceChanged actions, used with kOfxActionBeginInstanceChanged to bracket a grouped set of changes, see ActionsGeneralInstanceChangedBeginEnd.
#define	kOfxActionBeginInstanceEdit "OfxActionBeginInstanceEdit"
	Action called when an instance has the first editor opened for it.
#define	kOfxActionEndInstanceEdit "OfxActionEndInstanceEdit"
	Action called when an instance has the last editor closed.
Typedefs
typedef double	OfxTime
	How time is specified within the OFX API.
typedef struct OfxRangeI	OfxRangeI
	Defines one dimensional integer bounds.
typedef struct OfxRangeD	OfxRangeD
	Defines one dimensional double bounds.
typedef struct OfxPointI	OfxPointI
	Defines two dimensional integer point.
typedef struct OfxPointD	OfxPointD
	Defines two dimensional double point.
typedef struct OfxRectI	OfxRectI
	Defines two dimensional integer region.
typedef struct OfxRectD	OfxRectD
	Defines two dimensional double region.

Detailed Description

Contains the core OFX architectural struct and function definitions. For more details on the basic OFX architecture, see Architecture.

Definition in file ofxCore.h.

Define Documentation

#define kOfxActionBeginInstanceChanged "OfxActionBeginInstanceChanged"

Action called before the start of a set of kOfxActionEndInstanceChanged actions, used with kOfxActionEndInstanceChanged to bracket a grouped set of changes, see ActionsGeneralInstanceChangedBeginEnd.

Definition at line 53 of file ofxCore.h.

Referenced by tuttle::host::ofx::imageEffect::OfxhImageEffectNode::beginInstanceChangedAction(), OFX::Private::mainEntryStr(), and OFX::Validation::validateActionArgumentsProperties().

#define kOfxActionBeginInstanceEdit "OfxActionBeginInstanceEdit"

Action called when an instance has the first editor opened for it.

Definition at line 59 of file ofxCore.h.

Referenced by tuttle::host::ofx::imageEffect::OfxhImageEffectNode::beginInstanceEditAction(), and OFX::Private::mainEntryStr().

#define kOfxActionEndInstanceChanged "OfxActionEndInstanceChanged"

Action called after the end of a set of kOfxActionEndInstanceChanged actions, used with kOfxActionBeginInstanceChanged to bracket a grouped set of changes, see ActionsGeneralInstanceChangedBeginEnd.

Definition at line 56 of file ofxCore.h.

Referenced by tuttle::host::ofx::imageEffect::OfxhImageEffectNode::endInstanceChangedAction(), OFX::Private::mainEntryStr(), and OFX::Validation::validateActionArgumentsProperties().

#define kOfxActionEndInstanceEdit "OfxActionEndInstanceEdit"

Action called when an instance has the last editor closed.

Definition at line 62 of file ofxCore.h.

Referenced by tuttle::host::ofx::imageEffect::OfxhImageEffectNode::endInstanceEditAction(), and OFX::Private::mainEntryStr().

#define kOfxActionInstanceChanged "OfxActionInstanceChanged"

Action indicating something in the instance has been changed, see ActionsGeneralInstanceChanged.

Definition at line 50 of file ofxCore.h.

Referenced by tuttle::host::ofx::imageEffect::OfxhImageEffectNode::clipInstanceChangedAction(), OFX::Private::mainEntryStr(), tuttle::host::ofx::imageEffect::OfxhImageEffectNode::paramInstanceChangedAction(), and OFX::Validation::validateActionArgumentsProperties().

#define kOfxActionPurgeCaches "OfxActionPurgeCaches"

Action called to have a plug-in purge any temporary caches it may have allocated ArchitectureMainFunction and ActionsGeneralPurgeCaches.