OFX Namespace Reference

---

Detailed Description

The core 'OFX Support' namespace, used by plugin implementations. All code for these are defined in the common support libraries.

Classes
class	OFX::PropertySet
	This class wraps up an OFX property set. More...
class	OFX::PluginFactory
class	OFX::FactoryMainEntryHelper< FACTORY >
class	OFX::PluginFactoryHelper< FACTORY >
struct	OFX::ImageEffectHostDescription
	A class that lists all the properties of a host. More...
class	OFX::ClipDescriptor
	Wraps up a clip. More...
class	OFX::ImageEffectDescriptor
	Wraps up an effect descriptor, used in the describe actions. More...
class	OFX::Image
	Wraps up an image. More...
class	OFX::Clip
	Wraps up a clip instance. More...
class	OFX::ImageMemory
	Class that skins image memory allocation. More...
struct	OFX::RenderArguments
	POD struct to pass rendering arguments into ImageEffect::render and OFX::ImageEffect::isIdentity. More...
struct	OFX::BeginSequenceRenderArguments
	POD struct to pass arguments into OFX::ImageEffect::render. More...
struct	OFX::EndSequenceRenderArguments
	POD struct to pass arguments into OFX::ImageEffect::beginSequenceRender. More...
struct	OFX::RegionOfDefinitionArguments
	POD struct to pass arguments into OFX::ImageEffect::getRegionOfDefinition. More...
struct	OFX::RegionsOfInterestArguments
	POD struct to pass arguments into OFX::ImageEffect::getRegionsOfInterest. More...
class	OFX::RegionOfInterestSetter
	Class used to set regions of interest on a clip in OFX::ImageEffect::getRegionsOfInterest. More...
struct	OFX::FramesNeededArguments
	POD struct to pass arguments into OFX::ImageEffect::getFramesNeeded. More...
class	OFX::FramesNeededSetter
	Class used to set the frames needed to render a single frame of a clip in OFX::ImageEffect::getFramesNeeded. More...
class	OFX::ClipPreferencesSetter
	Class used to set the clip preferences of the effect. More...
struct	OFX::InstanceChangedArgs
	POD data structure passing in the instance changed args. More...
class	OFX::ImageEffect
	Wraps up an effect instance, plugin implementations need to inherit from this. More...
struct	OFX::InteractArgs
	all image effect interacts have these argumens More...
struct	OFX::DrawArgs
	struct to pass arguments into OFX::Interact::draw More...
struct	OFX::PenArgs
	POD to pass arguments into OFX::Interact pen actions. More...
struct	OFX::KeyArgs
	struct to pass arguments into OFX::Interact key actions More...
struct	OFX::FocusArgs
	struct to pass arguments into OFX::Interact focus actions More...
class	OFX::Interact
	Wraps up an OFX interact object for an Image Effect. It won't work for any other plug-in type at present (it would need to be broken into a hierarchy of classes). More...
class	OFX::OverlayInteract
	an interact for an image effect overlay More...
class	OFX::InteractDescriptor
class	OFX::ParamInteractDescriptor
class	OFX::ParamInteract
class	OFX::InteractMainEntry< DESC >
class	OFX::DefaultEffectOverlayDescriptor< DESC, INSTANCE >
class	OFX::DefaultParamInteractDescriptor< DESC, INSTANCE >
class	OFX::ParamDescriptor
	Base class for all param descriptors. More...
class	OFX::DummyParamDescriptor
	Used to implement dummy parameters for page positioning commands. More...
class	OFX::ValueParamDescriptor
	Wraps up a value holding param. More...
class	OFX::StringParamDescriptor
	Wraps up a string param. More...
class	OFX::IntParamDescriptor
	Wraps up an integer param. More...
class	OFX::Int2DParamDescriptor
	Wraps up an 2d integer param. More...
class	OFX::Int3DParamDescriptor
	Wraps up an 3d integer param. More...
class	OFX::BaseDoubleParamDescriptor
	Common base to all double param types. More...
class	OFX::DoubleParamDescriptor
	Wraps up a double param. More...
class	OFX::Double2DParamDescriptor
	Wraps up a 2D double param. More...
class	OFX::Double3DParamDescriptor
	Wraps up a 3D double param. More...
class	OFX::RGBParamDescriptor
	Wraps up an RGB colour param. More...
class	OFX::RGBAParamDescriptor
	Wraps up an RGBA colour param. More...
class	OFX::BooleanParamDescriptor
	Wraps up a boolean param. More...
class	OFX::ChoiceParamDescriptor
	Wraps up a choice param. More...
class	OFX::GroupParamDescriptor
	Wraps up a group param, not much to it really. More...
class	OFX::PageParamDescriptor
	Wraps up a page param, not much to it really. More...
class	OFX::PushButtonParamDescriptor
	Wraps up a push button param, not much to it at all. More...
class	OFX::CustomParamDescriptor
	Wraps up a custom param, haven't added animation support yet. More...
class	OFX::ParamSetDescriptor
	Describes a set of properties. More...
class	OFX::Param
	Base class for all param instances. More...
class	OFX::ValueParam
	Wraps up a value holding param. More...
class	OFX::IntParam
	Wraps up an integer param. More...
class	OFX::Int2DParam
	Wraps up an integer param. More...
class	OFX::Int3DParam
	Wraps up an integer param. More...
class	OFX::BaseDoubleParam
	Common base to all double param types. More...
class	OFX::DoubleParam
	Wraps up an doubleeger param. More...
class	OFX::Double2DParam
	Wraps up an doubleeger param. More...
class	OFX::Double3DParam
	Wraps up an doubleeger param. More...
class	OFX::RGBParam
	Wraps up an RGB param. More...
class	OFX::RGBAParam
	Wraps up an RGB param. More...
class	OFX::StringParam
	Wraps up a string param. More...
class	OFX::ChoiceParam
	Wraps up a choice param. More...
class	OFX::BooleanParam
	Wraps up a boolean param. More...
class	OFX::GroupParam
	Wraps up a group param. More...
class	OFX::PageParam
	Wraps up a group param. More...
class	OFX::CustomParam
	Wraps up a custom param, not animation support yet. More...
class	OFX::PushButtonParam
	Wraps up a push button param, not much to it at all. More...
class	OFX::ParamSet
	A set of parameters in a plugin instance. More...
struct	OFX::OfxPlugInfo
Typedefs
typedef std::vector< PluginFactory * >	PluginFactoryArray
typedef InteractDescriptor	EffectOverlayDescriptor
typedef std::map< std::string, OfxPlugInfo >	OfxPlugInfoMap
typedef std::vector< OfxPlugin * >	OfxPluginArray
Enumerations
enum	PropertyTypeEnum { ePointer, eInt, eString, eDouble }
	Enumerates the different types a property can be. More...
enum	InstanceChangeReason { eChangeUserEdit, eChangePluginEdit, eChangeTime }
	Enumerates the reasons a plug-in instance may have had one of its values changed. More...
enum	ContextEnum {   eContextNone, eContextGenerator, eContextFilter, eContextTransition,   eContextPaint, eContextGeneral, eContextRetimer }
	Enumerates the contexts a plugin can be used in. More...
enum	BitDepthEnum {   eBitDepthNone, eBitDepthUByte, eBitDepthUShort, eBitDepthFloat,   eBitDepthCustom }
	Enumerates the pixel depths supported. More...
enum	PixelComponentEnum { ePixelComponentNone, ePixelComponentRGBA, ePixelComponentAlpha, ePixelComponentCustom }
	Enumerates the component types supported. More...
enum	FieldExtractionEnum { eFieldExtractBoth, eFieldExtractSingle, eFieldExtractDoubled }
	Enumerates the ways a fielded image can be extracted from a clip. More...
enum	RenderSafetyEnum { eRenderUnsafe, eRenderInstanceSafe, eRenderFullySafe }
	Enumerates the kind of render thread safety a plugin has. More...
enum	FieldEnum { eFieldNone, eFieldBoth, eFieldLower, eFieldUpper }
	Enumerates the fields present in an image. More...
enum	PreMultiplicationEnum { eImageOpaque, eImagePreMultiplied, eImageUnPreMultiplied }
enum	ParamTypeEnum {   eDummyParam, eStringParam, eIntParam, eInt2DParam,   eInt3DParam, eDoubleParam, eDouble2DParam, eDouble3DParam,   eRGBParam, eRGBAParam, eBooleanParam, eChoiceParam,   eCustomParam, eGroupParam, ePageParam, ePushButtonParam }
	Enumerates the different types of parameter. More...
enum	CacheInvalidationEnum { eCacheInvalidateValueChange, eCacheInvalidateValueChangeToEnd, eCacheInvalidateValueAll }
	Enumerates the different types of cache invalidation. More...
enum	KeySearchEnum { eKeySearchBackwards, eKeySearchNear, eKeySearchForwards }
	Enumerates how we search for keys in an animating parameter. More...
enum	StringTypeEnum {   eStringTypeSingleLine, eStringTypeMultiLine, eStringTypeFilePath, eStringTypeDirectoryPath,   eStringTypeLabel }
	Enumerates the differing types of string params. More...
enum	DoubleTypeEnum {   eDoubleTypePlain, eDoubleTypeAngle, eDoubleTypeScale, eDoubleTypeTime,   eDoubleTypeAbsoluteTime, eDoubleTypeNormalisedX, eDoubleTypeNormalisedY, eDoubleTypeNormalisedXAbsolute,   eDoubleTypeNormalisedYAbsolute, eDoubleTypeNormalisedXY, eDoubleTypeNormalisedXYAbsolute }
	Enumerates the differing types of double params. More...
Functions
char *	mapStatusToString (OfxStatus stat)
	maps status to a string
void	throwSuiteStatusException (OfxStatus stat) throw (OFX::Exception::Suite, std::bad_alloc)
	Throws an OFX::Exception depending on the status flag passed in.
void	throwHostMissingSuiteException (std::string name) throw (OFX::Exception::Suite)
void *	fetchSuite (char *suiteName, int suiteVersion, bool optional=false)
	Fetch's a suite from the host and logs errors.
ImageEffectHostDescription *	getImageEffectHostDescription ()
	retrieve the host description
const char *	mapParamTypeEnumToString (ParamTypeEnum v)
	turns a ParamTypeEnum into the char * that raw OFX uses
ContextEnum	mapToContextEnum (const std::string &s) throw (std::invalid_argument)
	map a std::string to a context enum
const char *	mapToMessageTypeEnum (OFX::Message::MessageTypeEnum type)
OFX::Message::MessageReplyEnum	mapToMessageReplyEnum (OfxStatus stat)
InstanceChangeReason	mapToInstanceChangedReason (const std::string &s) throw (std::invalid_argument)
	map a std::string to a context
BitDepthEnum	mapStrToBitDepthEnum (const std::string &str) throw (std::invalid_argument)
	turns a bit depth string into and enum
PixelComponentEnum	mapStrToPixelComponentEnum (const std::string &str) throw (std::invalid_argument)
	turns a pixel component string into and enum
PreMultiplicationEnum	mapStrToPreMultiplicationEnum (const std::string &str) throw (std::invalid_argument)
	turns a premultiplication string into and enum
FieldEnum	mapStrToFieldEnum (const std::string &str) throw (std::invalid_argument)
	turns a field string into and enum
OfxPointD	getPixelScale (const PropertySet &props)
	fetch a pixel scale out of the property set
OfxPointD	getRenderScale (const PropertySet &props)
	fetch a render scale out of the property set
OfxRGBColourD	getBackgroundColour (const PropertySet &props)
	fetch a background colour out of the property set
ImageEffect *	retrieveEffectFromInteractHandle (OfxInteractHandle handle)
	retrieves the image effect pointer from the interact handle
bool	isEqual (const char *t1, const char *t2)
ParamTypeEnum	mapParamTypeStringToEnum (const char *v)
void	throwPropertyException (OfxStatus stat, const std::string &propName) throw (std::bad_alloc, OFX::Exception::PropertyUnknownToHost, OFX::Exception::PropertyValueIllegalToHost, OFX::Exception::Suite)
Variables
OFX::PluginFactoryArray	plugIDs
OfxPlugInfoMap	plugInfoMap
OfxPluginArray	ofxPlugs
ImageEffectHostDescription	gHostDescription
	the global host description
bool	gHostDescriptionHasInit = false

---

Typedef Documentation

typedef InteractDescriptor OFX::EffectOverlayDescriptor

typedef std::vector<OfxPlugin*> OFX::OfxPluginArray

typedef std::map<std::string, OfxPlugInfo> OFX::OfxPlugInfoMap

typedef std::vector<PluginFactory*> OFX::PluginFactoryArray

---

Enumeration Type Documentation

enum BitDepthEnum

Enumerates the pixel depths supported. Enumeration values: eBitDepthNone  bit depth that indicates no data is present eBitDepthUByte  eBitDepthUShort  eBitDepthFloat  eBitDepthCustom  some non standard bit depth

enum CacheInvalidationEnum

Enumerates the different types of cache invalidation. Enumeration values: eCacheInvalidateValueChange  eCacheInvalidateValueChangeToEnd  eCacheInvalidateValueAll

enum ContextEnum

Enumerates the contexts a plugin can be used in. Enumeration values: eContextNone  eContextGenerator  eContextFilter  eContextTransition  eContextPaint  eContextGeneral  eContextRetimer

enum DoubleTypeEnum

Enumerates the differing types of double params. Enumeration values: eDoubleTypePlain  eDoubleTypeAngle  eDoubleTypeScale  eDoubleTypeTime  eDoubleTypeAbsoluteTime  eDoubleTypeNormalisedX  eDoubleTypeNormalisedY  eDoubleTypeNormalisedXAbsolute  eDoubleTypeNormalisedYAbsolute  eDoubleTypeNormalisedXY  eDoubleTypeNormalisedXYAbsolute

enum FieldEnum

Enumerates the fields present in an image. Enumeration values: eFieldNone  unfielded image eFieldBoth  fielded image with both fields present eFieldLower  only the spatially lower field is present eFieldUpper  only the spatially upper field is present

enum FieldExtractionEnum

Enumerates the ways a fielded image can be extracted from a clip. Enumeration values: eFieldExtractBoth  extract both fields eFieldExtractSingle  extracts a single field, so you have a half height image eFieldExtractDoubled  extracts a single field, but doubles up the field, so you have a full height image

enum InstanceChangeReason

Enumerates the reasons a plug-in instance may have had one of its values changed. Enumeration values: eChangeUserEdit  A user actively editted something in the plugin, eg: changed the value of an integer param on an interface. eChangePluginEdit  The plugin's own code changed something in the instance, eg: a callback on on param settting the value of another. eChangeTime  The current value of a parameter has changed because the param animates and the current time has changed.

enum KeySearchEnum

Enumerates how we search for keys in an animating parameter. Enumeration values: eKeySearchBackwards  eKeySearchNear  eKeySearchForwards

enum ParamTypeEnum

Enumerates the different types of parameter. Enumeration values: eDummyParam  eStringParam  eIntParam  eInt2DParam  eInt3DParam  eDoubleParam  eDouble2DParam  eDouble3DParam  eRGBParam  eRGBAParam  eBooleanParam  eChoiceParam  eCustomParam  eGroupParam  ePageParam  ePushButtonParam

enum PixelComponentEnum

Enumerates the component types supported. Enumeration values: ePixelComponentNone  ePixelComponentRGBA  ePixelComponentAlpha  ePixelComponentCustom  some non standard pixel type

enum PreMultiplicationEnum

Enumeration values: eImageOpaque  the image is opaque and so has no premultiplication state eImagePreMultiplied  the image is premultiplied by it's alpha eImageUnPreMultiplied  the image is unpremultiplied

enum PropertyTypeEnum

Enumerates the different types a property can be. Enumeration values: ePointer  eInt  eString  eDouble

enum RenderSafetyEnum

Enumerates the kind of render thread safety a plugin has. Enumeration values: eRenderUnsafe  can only render a single instance at any one time eRenderInstanceSafe  can call a single render on an instance, but can render multiple instances simultaneously eRenderFullySafe  can call render any number of times on an instance, and render multiple instances simultaneously

enum StringTypeEnum

Enumerates the differing types of string params. Enumeration values: eStringTypeSingleLine  eStringTypeMultiLine  eStringTypeFilePath  eStringTypeDirectoryPath  eStringTypeLabel

---

Function Documentation

void * OFX::fetchSuite (  char *  suiteName, int  suiteVersion, bool  optional = false )

Fetch's a suite from the host and logs errors. All the standard suites are fetched by the support code, you should use this to fetch any extra non-standard suites.

OfxRGBColourD getBackgroundColour (  const PropertySet &  props  )  [static]

fetch a background colour out of the property set

ImageEffectHostDescription * OFX::getImageEffectHostDescription (   )

retrieve the host description

OfxPointD getPixelScale (  const PropertySet &  props  )  [static]

fetch a pixel scale out of the property set

OfxPointD getRenderScale (  const PropertySet &  props  )  [static]

fetch a render scale out of the property set

bool isEqual (  const char *  t1, const char *  t2 )

const char * OFX::mapParamTypeEnumToString (  ParamTypeEnum  v  )

turns a ParamTypeEnum into the char * that raw OFX uses

ParamTypeEnum mapParamTypeStringToEnum (  const char *  v  )

char * OFX::mapStatusToString (  OfxStatus  stat  )

maps status to a string

BitDepthEnum mapStrToBitDepthEnum (  const std::string &  str  )  throw (std::invalid_argument) [static]

turns a bit depth string into and enum

FieldEnum OFX::mapStrToFieldEnum (  const std::string &  str  )  throw (std::invalid_argument)

turns a field string into and enum

PixelComponentEnum mapStrToPixelComponentEnum (  const std::string &  str  )  throw (std::invalid_argument) [static]

turns a pixel component string into and enum

PreMultiplicationEnum mapStrToPreMultiplicationEnum (  const std::string &  str  )  throw (std::invalid_argument) [static]

turns a premultiplication string into and enum

ContextEnum OFX::mapToContextEnum (  const std::string &  s  )  throw (std::invalid_argument)

map a std::string to a context enum

InstanceChangeReason mapToInstanceChangedReason (  const std::string &  s  )  throw (std::invalid_argument)

map a std::string to a context

OFX::Message::MessageReplyEnum mapToMessageReplyEnum (  OfxStatus  stat  )

const char* mapToMessageTypeEnum (  OFX::Message::MessageTypeEnum  type  )

ImageEffect* retrieveEffectFromInteractHandle (  OfxInteractHandle  handle  )  [static]

retrieves the image effect pointer from the interact handle

void OFX::throwHostMissingSuiteException (  std::string  name  )  throw (OFX::Exception::Suite)

void throwPropertyException (  OfxStatus  stat, const std::string &  propName )  throw (std::bad_alloc, OFX::Exception::PropertyUnknownToHost, OFX::Exception::PropertyValueIllegalToHost, OFX::Exception::Suite)

void OFX::throwSuiteStatusException (  OfxStatus  stat  )  throw (OFX::Exception::Suite, std::bad_alloc)

Throws an OFX::Exception depending on the status flag passed in.

---

Variable Documentation

ImageEffectHostDescription OFX::gHostDescription

the global host description

bool OFX::gHostDescriptionHasInit = false

OfxPluginArray OFX::ofxPlugs

OFX::PluginFactoryArray OFX::plugIDs

OfxPlugInfoMap OFX::plugInfoMap

---