TuttleOFX  1
OFX Namespace Reference

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

Namespaces

namespace  Exception
 

namespace for OFX support lib exceptions, all derive from std::exception, calling it


namespace  Log
 

this namespace wraps up logging functionality


namespace  memory
 

Namespace for general purpose memory allocation.


namespace  Message
namespace  MultiThread
 

Multi thread namespace.


namespace  Plugin
 

The OFX::Plugin namespace. All the functions in here needs to be defined by each plugin that uses the support libs.


namespace  Private
 

OFX::Private namespace, for things private to the support library code here generally calls image effect class members.


namespace  Validation
 

The validation code has its own namespace.


Data Structures

class  PropertySet
 This class wraps up an OFX property set. More...
class  PluginFactory
class  FactoryMainEntryHelper
class  PluginFactoryHelper
struct  ImageEffectHostDescription
 A class that lists all the properties of a host. More...
class  ClipDescriptor
 Wraps up a clip. More...
class  ImageEffectDescriptor
 Wraps up an effect descriptor, used in the describe actions. More...
class  Image
 Wraps up an image. More...
class  Clip
 Wraps up a clip instance. More...
class  ImageMemory
 Class that skins image memory allocation. More...
struct  RenderArguments
 POD struct to pass rendering arguments into ImageEffect::render and OFX::ImageEffect::isIdentity. More...
struct  BeginSequenceRenderArguments
 POD struct to pass arguments into OFX::ImageEffect::render. More...
struct  EndSequenceRenderArguments
 POD struct to pass arguments into OFX::ImageEffect::beginSequenceRender. More...
struct  RegionOfDefinitionArguments
 POD struct to pass arguments into OFX::ImageEffect::getRegionOfDefinition. More...
struct  RegionsOfInterestArguments
 POD struct to pass arguments into OFX::ImageEffect::getRegionsOfInterest. More...
class  RegionOfInterestSetter
 Class used to set regions of interest on a clip in OFX::ImageEffect::getRegionsOfInterest. More...
struct  FramesNeededArguments
 POD struct to pass arguments into OFX::ImageEffect::getFramesNeeded. More...
class  FramesNeededSetter
 Class used to set the frames needed to render a single frame of a clip in OFX::ImageEffect::getFramesNeeded. More...
class  ClipPreferencesSetter
 Class used to set the clip preferences of the effect. More...
struct  InstanceChangedArgs
 POD data structure passing in the instance changed args. More...
class  ImageEffect
 Wraps up an effect instance, plugin implementations need to inherit from this. More...
struct  InteractArgs
 all image effect interacts have these argumens More...
struct  DrawArgs
 struct to pass arguments into OFX::Interact::draw More...
struct  PenArgs
 POD to pass arguments into OFX::Interact pen actions. More...
struct  KeyArgs
 struct to pass arguments into OFX::Interact key actions More...
struct  FocusArgs
 struct to pass arguments into OFX::Interact focus actions More...
class  InteractI
class  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  OverlayInteract
 an interact for an image effect overlay More...
class  InteractDescriptor
class  NoOverlayDescriptor
class  ParamInteractDescriptor
class  ParamInteract
class  EffectInteractWrap
class  ParamInteractWrap
class  InteractMainEntry
class  DefaultEffectOverlayWrap
class  DefaultParamInteractWrap
class  ParamDescriptor
 Base class for all param descriptors. More...
class  DummyParamDescriptor
 Used to implement dummy parameters for page positioning commands. More...
class  ValueParamDescriptor
 Wraps up a value holding param. More...
class  StringParamDescriptor
 Wraps up a string param. More...
class  IntParamDescriptor
 Wraps up an integer param. More...
class  Int2DParamDescriptor
 Wraps up an 2d integer param. More...
class  Int3DParamDescriptor
 Wraps up an 3d integer param. More...
class  BaseDoubleParamDescriptor
 Common base to all double param types. More...
class  DoubleParamDescriptor
 Wraps up a double param. More...
class  Double2DParamDescriptor
 Wraps up a 2D double param. More...
class  Double3DParamDescriptor
 Wraps up a 3D double param. More...
class  RGBParamDescriptor
 Wraps up an RGB colour param. More...
class  RGBAParamDescriptor
 Wraps up an RGBA colour param. More...
class  BooleanParamDescriptor
 Wraps up a boolean param. More...
class  ChoiceParamDescriptor
 Wraps up a choice param. More...
class  GroupParamDescriptor
 Wraps up a group param, not much to it really. More...
class  PageParamDescriptor
 Wraps up a page param, not much to it really. More...
class  PushButtonParamDescriptor
 Wraps up a push button param, not much to it at all. More...
class  ParametricParamDescriptor
 Wraps up a push button param, not much to it at all. More...
class  CustomParamDescriptor
 Wraps up a custom param, haven't added animation support yet. More...
class  ParamSetDescriptor
 Describes a set of properties. More...
class  Attribute
class  Param
 Base class for all param instances. More...
class  ValueParam
 Wraps up a value holding param. More...
class  IntParam
 Wraps up an integer param. More...
class  Int2DParam
 Wraps up an integer param. More...
class  Int3DParam
 Wraps up an integer param. More...
class  BaseDoubleParam
 Common base to all double param types. More...
class  DoubleParam
 Wraps up an doubleeger param. More...
class  Double2DParam
 Wraps up an doubleeger param. More...
class  Double3DParam
 Wraps up an doubleeger param. More...
class  RGBParam
 Wraps up an RGB param. More...
class  RGBAParam
 Wraps up an RGB param. More...
class  StringParam
 Wraps up a string param. More...
class  ChoiceParam
 Wraps up a choice param. More...
class  BooleanParam
 Wraps up a boolean param. More...
class  GroupParam
 Wraps up a group param. More...
class  PageParam
 Wraps up a group param. More...
class  CustomParam
 Wraps up a custom param, not animation support yet. More...
class  PushButtonParam
 Wraps up a push button param, not much to it at all. More...
class  ParametricParam
 Wraps up a parametric param. More...
class  CameraParam
 Wraps up a camera param. More...
class  ParamSet
 A set of parameters in a plugin instance. More...
struct  OfxPlugInfo

Typedefs

typedef std::vector
< PluginFactory * > 
PluginFactoryArray
typedef InteractDescriptor EffectOverlayDescriptor
typedef std::map< std::string,
OfxPlugInfo
OfxPlugInfoMap
typedef std::vector< OfxPlugin * > OfxPluginArray
typedef ::boost::error_info
< struct tag_ofxStatus,::OfxStatus
ofxStatus

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  EContext {
  eContextNone, eContextGenerator, eContextFilter, eContextTransition,
  eContextPaint, eContextGeneral, eContextRetimer, eContextReader,
  eContextWriter
}
 Enumerates the contexts a plugin can be used in. More...
enum  EBitDepth {
  eBitDepthCustom = -1, eBitDepthNone = 0, eBitDepthUByte = 1, eBitDepthUShort = 2,
  eBitDepthFloat = 3
}
 Enumerates the pixel depths supported. More...
enum  EPixelComponent {
  ePixelComponentNone, ePixelComponentRGBA, ePixelComponentRGB, ePixelComponentAlpha,
  ePixelComponentCustom
}
 Enumerates the component types supported. More...
enum  EFieldExtraction { eFieldExtractBoth, eFieldExtractSingle, eFieldExtractDoubled }
 Enumerates the ways a fielded image can be extracted from a clip. More...
enum  ERenderSafety { eRenderUnsafe, eRenderInstanceSafe, eRenderFullySafe }
 Enumerates the kind of render thread safety a plugin has. More...
enum  EField { eFieldNone, eFieldBoth, eFieldLower, eFieldUpper }
 Enumerates the fields present in an image. More...
enum  EPreMultiplication { eImageOpaque, eImagePreMultiplied, eImageUnPreMultiplied }
enum  ParamTypeEnum {
  eDummyParam, eStringParam, eIntParam, eInt2DParam,
  eInt3DParam, eDoubleParam, eDouble2DParam, eDouble3DParam,
  eRGBParam, eRGBAParam, eBooleanParam, eChoiceParam,
  eCustomParam, eGroupParam, ePageParam, ePushButtonParam,
  eParametricParam, eCameraParam
}
 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...
enum  ELayoutHint { eLayoutHintNormal = kOfxParamPropLayoutHintNormal, eLayoutHintDivider = kOfxParamPropLayoutHintDivider, eLayoutHintNoNewLine = kOfxParamPropLayoutHintNoNewLine }

Functions

std::string mapStatusToString (const OfxStatus stat)
 maps a status to a string for debugging purposes, note a c-str for printf
void throwSuiteStatusException (OfxStatus stat)
 Throws an OFX::Exception::Suite depending on the status flag passed in.
void throwHostMissingSuiteException (const std::string &name)
const std::string mapContextEnumToString (const EContext s)
 map a std::string to a context
const std::string mapBitDepthEnumToString (const EBitDepth e)
std::string mapPixelComponentEnumToString (const EPixelComponent e)
std::string mapFieldEnumToString (const EField e)
std::string mapPreMultiplicationEnumToString (const EPreMultiplication e)
void * fetchSuite (const char *suiteName, int suiteVersion, bool optional=false)
 Fetch's a suite from the host and logs errors.
ImageEffectHostDescriptiongetImageEffectHostDescription ()
 retrieve the host description
const char * mapParamTypeEnumToString (ParamTypeEnum v)
 turns a ParamTypeEnum into the char * that raw OFX uses
template<class ParamType >
ParamTypeEnum mapParamTypeToEnum ()
template<>
ParamTypeEnum mapParamTypeToEnum< StringParam > ()
template<>
ParamTypeEnum mapParamTypeToEnum< IntParam > ()
template<>
ParamTypeEnum mapParamTypeToEnum< Int2DParam > ()
template<>
ParamTypeEnum mapParamTypeToEnum< Int3DParam > ()
template<>
ParamTypeEnum mapParamTypeToEnum< DoubleParam > ()
template<>
ParamTypeEnum mapParamTypeToEnum< Double2DParam > ()
template<>
ParamTypeEnum mapParamTypeToEnum< Double3DParam > ()
template<>
ParamTypeEnum mapParamTypeToEnum< RGBParam > ()
template<>
ParamTypeEnum mapParamTypeToEnum< RGBAParam > ()
template<>
ParamTypeEnum mapParamTypeToEnum< BooleanParam > ()
template<>
ParamTypeEnum mapParamTypeToEnum< ChoiceParam > ()
template<>
ParamTypeEnum mapParamTypeToEnum< CustomParam > ()
template<>
ParamTypeEnum mapParamTypeToEnum< GroupParam > ()
template<>
ParamTypeEnum mapParamTypeToEnum< PageParam > ()
template<>
ParamTypeEnum mapParamTypeToEnum< PushButtonParam > ()
template<>
ParamTypeEnum mapParamTypeToEnum< ParametricParam > ()
template<>
ParamTypeEnum mapParamTypeToEnum< CameraParam > ()
template<class ParamType >
ParamTypeEnum mapParamTypeToEnumFrom (const ParamType &)
template<class ParamType >
ParamTypeEnum mapParamTypeToEnumFrom (const ParamType *)
EContext mapContextStringToEnum (const std::string &s)
 map a std::string to a context
const std::string mapMessageTypeEnumToString (const OFX::Message::EMessageType type)
OFX::Message::EMessageReply mapMessageReplyStatusToEnum (const OfxStatus stat)
OfxStatus mapMessageReplyEnumToStatus (const OFX::Message::EMessageReply stat)
InstanceChangeReason mapInstanceChangedReasonStringToEnum (const std::string &s)
 map a std::string to a context
EBitDepth mapBitDepthStringToEnum (const std::string &str)
 turns a bit depth string into and enum
EPixelComponent mapPixelComponentStringToEnum (const std::string &str)
 turns a pixel component string into and enum
EPreMultiplication mapPreMultiplicationStringToEnum (const std::string &str)
 turns a premultiplication string into and enum
EField mapFieldStringToEnum (const std::string &str)
 turns a field string into and enum
static OfxPointD getPixelScale (const PropertySet &props)
 fetch a pixel scale out of the property set
static OfxPointD getRenderScale (const PropertySet &props)
 fetch a render scale out of the property set
static OfxRGBColourD getBackgroundColour (const PropertySet &props)
 fetch a background colour out of the property set
static ImageEffectretrieveEffectFromInteractHandle (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)
std::string to_string (const ofxStatus &e)

Variables

static const OfxPointD kNoRenderScale = { 1.0, 1.0 }
OFX::PluginFactoryArray plugIDs

Detailed Description

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

Namespace private to the ofx support library.

OFX namespace.

This file contains code that skins the ofx param suite.

This file contains code that skins the ofx interact suite (for image effects)

This file contains code that skins the ofx effect suite.


Typedef Documentation

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

Definition at line 80 of file ofxsImageEffect.cpp.

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

Definition at line 79 of file ofxsImageEffect.cpp.

typedef ::boost::error_info<struct tag_ofxStatus, ::OfxStatus> OFX::ofxStatus

Definition at line 55 of file exceptions.hpp.

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

Definition at line 245 of file ofxsImageEffect.h.


Enumeration Type Documentation

Enumerates the different types of cache invalidation.

Enumerator:
eCacheInvalidateValueChange 
eCacheInvalidateValueChangeToEnd 
eCacheInvalidateValueAll 

Definition at line 139 of file ofxsParam.h.

Enumerates the differing types of double params.

Enumerator:
eDoubleTypePlain 
eDoubleTypeAngle 
eDoubleTypeScale 
eDoubleTypeTime 
eDoubleTypeAbsoluteTime 
eDoubleTypeNormalisedX 
eDoubleTypeNormalisedY 
eDoubleTypeNormalisedXAbsolute 
eDoubleTypeNormalisedYAbsolute 
eDoubleTypeNormalisedXY 
eDoubleTypeNormalisedXYAbsolute 

Definition at line 165 of file ofxsParam.h.

Enumerates the pixel depths supported.

Enumerator:
eBitDepthCustom 

some non standard bit depth

eBitDepthNone 

bit depth that indicates no data is present

eBitDepthUByte 
eBitDepthUShort 
eBitDepthFloat 

Definition at line 108 of file ofxsImageEffect.h.

Enumerates the contexts a plugin can be used in.

Enumerator:
eContextNone 
eContextGenerator 
eContextFilter 
eContextTransition 
eContextPaint 
eContextGeneral 
eContextRetimer 
eContextReader 
eContextWriter 

Definition at line 92 of file ofxsImageEffect.h.

Enumerates the fields present in an image.

Enumerator:
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

Definition at line 148 of file ofxsImageEffect.h.

Enumerates the ways a fielded image can be extracted from a clip.

Enumerator:
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

Definition at line 132 of file ofxsImageEffect.h.

Enumerator:
eLayoutHintNormal 
eLayoutHintDivider 
eLayoutHintNoNewLine 

Definition at line 180 of file ofxsParam.h.

Enumerates the component types supported.

Enumerator:
ePixelComponentNone 
ePixelComponentRGBA 
ePixelComponentRGB 
ePixelComponentAlpha 
ePixelComponentCustom 

some non standard pixel type

Definition at line 120 of file ofxsImageEffect.h.

Enumerator:
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

Definition at line 158 of file ofxsImageEffect.h.

Enumerates the kind of render thread safety a plugin has.

Enumerator:
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

Definition at line 140 of file ofxsImageEffect.h.

Enumerates the reasons a plug-in instance may have had one of its values changed.

Enumerator:
eChangeUserEdit 

A user actively edited 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 setting the value of another.

eChangeTime 

The current value of a parameter has changed because the param animates and the current time has changed.

Definition at line 219 of file ofxsCore.h.

Enumerates how we search for keys in an animating parameter.

Enumerator:
eKeySearchBackwards 
eKeySearchNear 
eKeySearchForwards 

Definition at line 147 of file ofxsParam.h.

Enumerates the different types of parameter.

Enumerator:
eDummyParam 
eStringParam 
eIntParam 
eInt2DParam 
eInt3DParam 
eDoubleParam 
eDouble2DParam 
eDouble3DParam 
eRGBParam 
eRGBAParam 
eBooleanParam 
eChoiceParam 
eCustomParam 
eGroupParam 
ePageParam 
ePushButtonParam 
eParametricParam 
eCameraParam 

Definition at line 116 of file ofxsParam.h.

Enumerates the different types a property can be.

Enumerator:
ePointer 
eInt 
eString 
eDouble 

Definition at line 210 of file ofxsCore.h.

Enumerates the differing types of string params.

Enumerator:
eStringTypeSingleLine 
eStringTypeMultiLine 
eStringTypeFilePath 
eStringTypeDirectoryPath 
eStringTypeLabel 

Definition at line 155 of file ofxsParam.h.


Function Documentation

void * OFX::fetchSuite ( const 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.

Definition at line 2770 of file ofxsImageEffect.cpp.

References OFX::Log::error(), OfxHost::fetchSuite, OFX::Private::gHost, and OFX::Log::warning().

Referenced by OFX::Private::loadAction().

Here is the call graph for this function:

static OfxRGBColourD OFX::getBackgroundColour ( const PropertySet &  props) [static]

fetch a background colour out of the property set

Definition at line 75 of file ofxsInteract.cpp.

References OfxRGBColourD::b, OfxRGBColourD::g, kOfxInteractPropBackgroundColour, OFX::PropertySet::propGetDouble(), and OfxRGBColourD::r.

Referenced by OFX::DrawArgs::DrawArgs(), and OFX::FocusArgs::FocusArgs().

Here is the call graph for this function:

ImageEffectHostDescription * OFX::getImageEffectHostDescription ( )

retrieve the host description

Definition at line 115 of file ofxsImageEffect.cpp.

References OFX::Private::gHostDescription, and OFX::Private::gHostDescriptionHasInit.

Referenced by tuttle::plugin::debugImageEffectApi::DebugImageEffectApiPlugin::changedParam(), OFX::ClipPreferencesSetter::ClipPreferencesSetter(), tuttle::plugin::describeGeneratorParamsInContext(), tuttle::plugin::describeReaderParamsInContext(), tuttle::plugin::ReaderPlugin::getClipPreferences(), tuttle::plugin::openImageIO::reader::OpenImageIOReaderPlugin::getClipPreferences(), tuttle::plugin::jpeg::reader::JpegReaderPlugin::getClipPreferences(), tuttle::plugin::imagemagick::reader::ImageMagickReaderPlugin::getClipPreferences(), tuttle::plugin::png::reader::PngReaderPlugin::getClipPreferences(), tuttle::plugin::turboJpeg::reader::TurboJpegReaderPlugin::getClipPreferences(), tuttle::plugin::exr::reader::EXRReaderPlugin::getClipPreferences(), OFX::Validation::initialise(), tuttle::plugin::WriterPlugin::isIdentity(), tuttle::plugin::swscale::SwscalePlugin::render(), tuttle::plugin::inputBuffer::InputBufferPlugin::render(), tuttle::plugin::colorSpaceKeyer::ColorSpaceKeyerPlugin::render(), tuttle::plugin::colorCubeViewer::ColorCubeViewerPlugin::render(), tuttle::plugin::histogramKeyer::HistogramKeyerPlugin::render(), tuttle::plugin::histogram::HistogramPlugin::render(), OFX::GroupParamDescriptor::setAsTab(), tuttle::plugin::ImageGilFilterProcessor< SView, DView >::setup(), tuttle::plugin::bitDepth::BitDepthProcess< SView, DView >::setup(), tuttle::plugin::ImageFilterProcessor::setup(), tuttle::plugin::quality::DiffProcess< View >::setup(), tuttle::plugin::fade::FadeProcess< View >::setup(), tuttle::plugin::merge::MergeProcess< View, Functor >::setup(), tuttle::plugin::pushPixel::PushPixelProcess< View >::setup(), tuttle::plugin::colorTransfer::ColorTransferProcess< View >::setup(), tuttle::plugin::text::TextProcess< View, Functor >::setup(), and tuttle::plugin::ImageProcessor::setup().

static OfxPointD OFX::getPixelScale ( const PropertySet &  props) [static]

fetch a pixel scale out of the property set

Definition at line 55 of file ofxsInteract.cpp.

References kOfxInteractPropPixelScale, OFX::PropertySet::propGetDouble(), OfxPointD::x, and OfxPointD::y.

Referenced by OFX::DrawArgs::DrawArgs(), OFX::FocusArgs::FocusArgs(), and OFX::PenArgs::PenArgs().

Here is the call graph for this function:

static OfxPointD OFX::getRenderScale ( const PropertySet &  props) [static]

fetch a render scale out of the property set

Definition at line 65 of file ofxsInteract.cpp.

References kOfxImageEffectPropRenderScale, OFX::PropertySet::propGetDouble(), OfxPointD::x, and OfxPointD::y.

Referenced by OFX::InteractArgs::InteractArgs(), and OFX::KeyArgs::KeyArgs().

Here is the call graph for this function:

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

Definition at line 82 of file ofxsParams.cpp.

Referenced by mapParamTypeStringToEnum().

std::string OFX::mapFieldEnumToString ( const EField  e)
EField OFX::mapFieldStringToEnum ( const std::string &  str)
InstanceChangeReason OFX::mapInstanceChangedReasonStringToEnum ( const std::string &  s)
template<class ParamType >
ParamTypeEnum OFX::mapParamTypeToEnum ( ) [inline]

Definition at line 1788 of file ofxsParam.h.

References eDummyParam.

template<>
ParamTypeEnum OFX::mapParamTypeToEnum< BooleanParam > ( ) [inline]

Definition at line 1838 of file ofxsParam.h.

References eBooleanParam.

template<>
ParamTypeEnum OFX::mapParamTypeToEnum< CameraParam > ( ) [inline]

Definition at line 1873 of file ofxsParam.h.

References eCameraParam.

template<>
ParamTypeEnum OFX::mapParamTypeToEnum< ChoiceParam > ( ) [inline]

Definition at line 1843 of file ofxsParam.h.

References eChoiceParam.

template<>
ParamTypeEnum OFX::mapParamTypeToEnum< CustomParam > ( ) [inline]

Definition at line 1848 of file ofxsParam.h.

References eCustomParam.

template<>
ParamTypeEnum OFX::mapParamTypeToEnum< Double2DParam > ( ) [inline]

Definition at line 1818 of file ofxsParam.h.

References eDouble2DParam.

template<>
ParamTypeEnum OFX::mapParamTypeToEnum< Double3DParam > ( ) [inline]

Definition at line 1823 of file ofxsParam.h.

References eDouble3DParam.

template<>
ParamTypeEnum OFX::mapParamTypeToEnum< DoubleParam > ( ) [inline]

Definition at line 1813 of file ofxsParam.h.

References eDoubleParam.

template<>
ParamTypeEnum OFX::mapParamTypeToEnum< GroupParam > ( ) [inline]

Definition at line 1853 of file ofxsParam.h.

References eGroupParam.

template<>
ParamTypeEnum OFX::mapParamTypeToEnum< Int2DParam > ( ) [inline]

Definition at line 1803 of file ofxsParam.h.

References eInt2DParam.

template<>
ParamTypeEnum OFX::mapParamTypeToEnum< Int3DParam > ( ) [inline]

Definition at line 1808 of file ofxsParam.h.

References eInt3DParam.

template<>
ParamTypeEnum OFX::mapParamTypeToEnum< IntParam > ( ) [inline]

Definition at line 1798 of file ofxsParam.h.

References eIntParam.

template<>
ParamTypeEnum OFX::mapParamTypeToEnum< PageParam > ( ) [inline]

Definition at line 1858 of file ofxsParam.h.

References ePageParam.

template<>
ParamTypeEnum OFX::mapParamTypeToEnum< ParametricParam > ( ) [inline]

Definition at line 1868 of file ofxsParam.h.

References eParametricParam.

template<>
ParamTypeEnum OFX::mapParamTypeToEnum< PushButtonParam > ( ) [inline]

Definition at line 1863 of file ofxsParam.h.

References ePushButtonParam.

template<>
ParamTypeEnum OFX::mapParamTypeToEnum< RGBAParam > ( ) [inline]

Definition at line 1833 of file ofxsParam.h.

References eRGBAParam.

template<>
ParamTypeEnum OFX::mapParamTypeToEnum< RGBParam > ( ) [inline]

Definition at line 1828 of file ofxsParam.h.

References eRGBParam.

template<>
ParamTypeEnum OFX::mapParamTypeToEnum< StringParam > ( ) [inline]

Definition at line 1793 of file ofxsParam.h.

References eStringParam.

template<class ParamType >
ParamTypeEnum OFX::mapParamTypeToEnumFrom ( const ParamType &  ) [inline]

Definition at line 1879 of file ofxsParam.h.

template<class ParamType >
ParamTypeEnum OFX::mapParamTypeToEnumFrom ( const ParamType *  ) [inline]

Definition at line 1884 of file ofxsParam.h.

std::string OFX::mapPixelComponentEnumToString ( const EPixelComponent  e)

Definition at line 306 of file ofxsImageEffect.cpp.

References ePixelComponentAlpha, ePixelComponentCustom, ePixelComponentNone, ePixelComponentRGB, ePixelComponentRGBA, kOfxImageComponentAlpha, kOfxImageComponentNone, kOfxImageComponentRGB, and kOfxImageComponentRGBA.

Referenced by tuttle::plugin::debugImageEffectApi::DebugImageEffectApiPlugin::changedParam(), tuttle::plugin::doGilRender(), tuttle::plugin::doGilRender2(), main(), tuttle::plugin::bitDepth::BitDepthPlugin::render(), tuttle::plugin::imageStatistics::ImageStatisticsPlugin::render(), tuttle::plugin::imagemagick::reader::ImageMagickReaderPlugin::render(), tuttle::plugin::imagemagick::writer::ImageMagickWriterPlugin::render(), tuttle::plugin::idKeyer::IdKeyerPlugin::render(), tuttle::plugin::dpx::reader::DPXReaderPlugin::render(), tuttle::plugin::nlmDenoiser::NLMDenoiserPlugin::render(), tuttle::plugin::invert::InvertPlugin::render(), tuttle::plugin::ocio::lut::OCIOLutPlugin::render(), tuttle::plugin::basicKeyer::BasicKeyerPlugin::render(), tuttle::plugin::ocio::colorspace::OCIOColorSpacePlugin::render(), tuttle::plugin::colorTransfer::ColorTransferPlugin::render(), tuttle::plugin::ctl::CTLPlugin::render(), tuttle::plugin::text::TextPlugin::render(), tuttle::plugin::merge::MergePlugin::render(), tuttle::plugin::normalize::NormalizePlugin::render(), tuttle::plugin::warp::WarpPlugin::render(), tuttle::plugin::colorGradient::ColorGradientPlugin::renderFunctor(), tuttle::host::ofx::attribute::OfxhClipImage::setComponents(), and tuttle::plugin::bitDepth::BitDepthPlugin::setupDestView().

std::string OFX::mapPreMultiplicationEnumToString ( const EPreMultiplication  e)
EPreMultiplication OFX::mapPreMultiplicationStringToEnum ( const std::string &  str)

turns a premultiplication string into and enum

Definition at line 325 of file ofxsImageEffect.cpp.

References eImageOpaque, eImagePreMultiplied, eImageUnPreMultiplied, kOfxImageOpaque, kOfxImagePreMultiplied, and kOfxImageUnPreMultiplied.

Referenced by OFX::Clip::getPreMultiplication(), and OFX::Image::Image().

static ImageEffect* OFX::retrieveEffectFromInteractHandle ( OfxInteractHandle  handle) [static]

retrieves the image effect pointer from the interact handle

Definition at line 86 of file ofxsInteract.cpp.

References OFX::Private::gInteractSuite, OfxInteractSuiteV1::interactGetPropertySet, kOfxPropEffectInstance, OFX::PropertySet::propGetPointer(), OFX::Private::retrieveImageEffectPointer(), and throwSuiteStatusException().

Referenced by OFX::Interact::Interact(), and OFX::Private::interactMainEntry().

Here is the call graph for this function:

void OFX::throwSuiteStatusException ( OfxStatus  stat)

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

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

Definition at line 46 of file ofxsCore.cpp.

References kOfxStatErrMemory, kOfxStatOK, kOfxStatReplyDefault, kOfxStatReplyNo, and kOfxStatReplyYes.

Referenced by OFX::ParametricParam::addControlPoint(), OFX::ImageMemory::alloc(), OFX::ParamSet::beginEditBlock(), OFX::Private::checkMainHandles(), OFX::ParamSetDescriptor::defineRawParam(), OFX::ValueParam::deleteAllKeys(), OFX::ParametricParam::deleteControlPoint(), OFX::ValueParam::deleteKeyAtTime(), OFX::DoubleParam::differentiate(), OFX::Double2DParam::differentiate(), OFX::Double3DParam::differentiate(), OFX::ParamSet::endEditBlock(), OFX::ImageEffect::fetchClip(), OFX::Private::fetchEffectProps(), OFX::Clip::fetchImage(), OFX::ParamSet::fetchRawCameraParam(), OFX::ParamSet::fetchRawParam(), OFX::Clip::getCanonicalRod(), OFX::ValueParam::getKeyIndex(), OFX::ValueParam::getKeyTime(), OFX::ParametricParam::getNControlPoints(), OFX::ParametricParam::getNthControlPoints(), OFX::ValueParam::getNumKeys(), OFX::ParamSet::getParam(), OFX::ParamSet::getParamType(), OFX::StringParam::getPointerValue(), OFX::StringParam::getPointerValueAtTime(), OFX::IntParam::getValue(), OFX::Int2DParam::getValue(), OFX::Int3DParam::getValue(), OFX::DoubleParam::getValue(), OFX::Double2DParam::getValue(), OFX::Double3DParam::getValue(), OFX::RGBParam::getValue(), OFX::RGBAParam::getValue(), OFX::ChoiceParam::getValue(), OFX::BooleanParam::getValue(), OFX::CustomParam::getValue(), OFX::ParametricParam::getValue(), OFX::IntParam::getValueAtTime(), OFX::Int2DParam::getValueAtTime(), OFX::Int3DParam::getValueAtTime(), OFX::DoubleParam::getValueAtTime(), OFX::Double2DParam::getValueAtTime(), OFX::Double3DParam::getValueAtTime(), OFX::RGBParam::getValueAtTime(), OFX::RGBAParam::getValueAtTime(), OFX::ChoiceParam::getValueAtTime(), OFX::BooleanParam::getValueAtTime(), OFX::CustomParam::getValueAtTime(), OFX::ImageEffect::ImageEffect(), OFX::ImageEffectDescriptor::ImageEffectDescriptor(), OFX::DoubleParam::integrate(), OFX::Double2DParam::integrate(), OFX::Double3DParam::integrate(), OFX::Interact::Interact(), OFX::Private::interactMainEntry(), OFX::MultiThread::Mutex::lock(), OFX::ImageMemory::lock(), OFX::MultiThread::Processor::multiThread(), OFX::MultiThread::Mutex::Mutex(), OFX::Param::Param(), OFX::Interact::requestRedraw(), retrieveEffectFromInteractHandle(), OFX::Private::retrieveImageEffectPointer(), OFX::Private::retrieveInteractPointer(), OFX::ParametricParam::setNthControlPoints(), OFX::ParamSetDescriptor::setOfxParamSetHandle(), OFX::ParamSet::setParamSetHandle(), OFX::IntParam::setValue(), OFX::Int2DParam::setValue(), OFX::Int3DParam::setValue(), OFX::DoubleParam::setValue(), OFX::Double2DParam::setValue(), OFX::Double3DParam::setValue(), OFX::RGBParam::setValue(), OFX::RGBAParam::setValue(), OFX::StringParam::setValue(), OFX::ChoiceParam::setValue(), OFX::BooleanParam::setValue(), OFX::CustomParam::setValue(), OFX::IntParam::setValueAtTime(), OFX::Int2DParam::setValueAtTime(), OFX::Int3DParam::setValueAtTime(), OFX::DoubleParam::setValueAtTime(), OFX::Double2DParam::setValueAtTime(), OFX::Double3DParam::setValueAtTime(), OFX::RGBParam::setValueAtTime(), OFX::RGBAParam::setValueAtTime(), OFX::StringParam::setValueAtTime(), OFX::ChoiceParam::setValueAtTime(), OFX::BooleanParam::setValueAtTime(), OFX::CustomParam::setValueAtTime(), OFX::Interact::swapBuffers(), throwPropertyException(), and OFX::MultiThread::Mutex::unlock().

std::string OFX::to_string ( const ofxStatus &  e) [inline]

Definition at line 56 of file exceptions.hpp.

References mapStatusToString().

Referenced by tuttle::host::Core::preload().

Here is the call graph for this function:


Variable Documentation

const OfxPointD OFX::kNoRenderScale = { 1.0, 1.0 } [static]

Definition at line 916 of file ofxsImageEffect.h.