ofxsSupportPrivate.h File Reference

#include "ofxsInteract.h"
#include "ofxsImageEffect.h"
#include "ofxsLog.h"
#include "ofxsMultiThread.h"

Include dependency graph for ofxsSupportPrivate.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	OFX::Validation::ValueHolder
	This is uses to hold a property value, used by the property checking classes. More...
class	OFX::Validation::PropertyDescription
	class to describe properties, check their default and set their values More...
class	OFX::Validation::PropertySetDescription
	Describes a set of properties. More...
Namespaces
namespace	OFX
	The core 'OFX Support' namespace, used by plugin implementations. All code for these are defined in the common support libraries.
namespace	OFX::Private
	OFX::Private namespace, for things private to the support library code here generally calls image effect class members.
namespace	OFX::Validation
	The validation code has its own namespace.
Typedefs
typedef std::map< EContext, ImageEffectDescriptor * >	OFX::Private::EffectContextMap
	the set of descriptors, one per context used by kOfxActionDescribeInContext, 'eContextNone' is the one used by the kOfxActionDescribe
typedef std::map< std::string, EffectContextMap >	OFX::Private::EffectDescriptorMap
Enumerations
enum	OFX::Validation::DescriptionTag { OFX::Validation::eDescDefault, OFX::Validation::eDescFinished }
	Enum used in the varargs list of the PropertyDescription constructor. More...
Functions
EField	OFX::mapFieldStringToEnum (const std::string &str)
	turns a field string into and enum
EContext	OFX::mapContextStringToEnum (const std::string &s)
	map a std::string to a context
void	OFX::Private::loadAction (void)
	Library side load action, this fetches all the suite pointers.
void	OFX::Private::unloadAction (void)
	Support lib function called on an ofx unload action.
void	OFX::Private::setHost (OfxHost *host)
	The plugin function that gets passed the host structure.
ImageEffect *	OFX::Private::retrieveImageEffectPointer (OfxImageEffectHandle handle)
	fetches our pointer out of the props on the handle
OFX::PropertySet	OFX::Private::fetchEffectProps (OfxImageEffectHandle handle)
	fetch the effect property set from the ImageEffectHandle
void	OFX::Validation::validateHostProperties (OfxHost *host)
	Validates the host structure and property handle.
void	OFX::Validation::validatePluginDescriptorProperties (PropertySet props)
	Validates the effect descriptor properties.
void	OFX::Validation::validatePluginInstanceProperties (PropertySet props)
	Validates the effect instance properties.
void	OFX::Validation::validateClipDescriptorProperties (PropertySet props)
	validates a clip descriptor
void	OFX::Validation::validateClipInstanceProperties (PropertySet props)
	validates a clip instance
void	OFX::Validation::validateImageProperties (PropertySet props)
	validates a clip descriptor
void	OFX::Validation::validateActionArgumentsProperties (const std::string &action, PropertySet inArgs, PropertySet outArgs)
	Validates action in/out arguments.
void	OFX::Validation::validateParameterProperties (ParamTypeEnum paramType, OFX::PropertySet &paramProps, bool checkDefaults)
	Validates parameter properties.
void	OFX::Validation::initialise (void)
	Initialises validation stuff that needs to be done once we know how the host behaves, called during the onload action.