From 7d92144fab60736beeb948aa4cba9a7f81988f75 Mon Sep 17 00:00:00 2001 From: luzpaz Date: Sat, 27 Sep 2025 21:29:17 +0000 Subject: [PATCH 1/6] Fix typos in Examples subdirectory Found via codespell Signed-off-by: luzpaz --- Examples/ColourSpace/colourspace.cpp | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Examples/ColourSpace/colourspace.cpp b/Examples/ColourSpace/colourspace.cpp index aa2aa4cb..37cb70cc 100644 --- a/Examples/ColourSpace/colourspace.cpp +++ b/Examples/ColourSpace/colourspace.cpp @@ -543,7 +543,7 @@ getClipPreferences( OfxImageEffectHandle effect, OfxPropertySetHandle /*inArgs*/ OfxPropertySetHandle effectProps; gEffectHost->getPropertySet(effect, &effectProps); - // retieve the colour management style that the host has decided we shall use + // reteive the colour management style that the host has decided we shall use ColourManagementStyle active_style = ColourManagementStyle::None; char * style; if(gPropHost->propGetString(effectProps, kOfxImageEffectPropColourManagementStyle, 0, &style) == kOfxStatOK) { @@ -606,7 +606,7 @@ getOutputColourspace( OfxImageEffectHandle effect, OfxPropertySetHandle /*inAr OfxPropertySetHandle effectProps; gEffectHost->getPropertySet(effect, &effectProps); - // retieve the colour management style that the host has decided we shall use + // reteive the colour management style that the host has decided we shall use ColourManagementStyle active_style = ColourManagementStyle::None; char * style; if(gPropHost->propGetString(effectProps, kOfxImageEffectPropColourManagementStyle, 0, &style) == kOfxStatOK) { From 380b93f97495e42edc3e85bfe0357a301fea7633 Mon Sep 17 00:00:00 2001 From: luzpaz Date: Thu, 9 Oct 2025 21:03:51 -0400 Subject: [PATCH 2/6] Fixed previous commit Signed-off-by: luzpaz --- Examples/ColourSpace/colourspace.cpp | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Examples/ColourSpace/colourspace.cpp b/Examples/ColourSpace/colourspace.cpp index 37cb70cc..b99f1f04 100644 --- a/Examples/ColourSpace/colourspace.cpp +++ b/Examples/ColourSpace/colourspace.cpp @@ -543,7 +543,7 @@ getClipPreferences( OfxImageEffectHandle effect, OfxPropertySetHandle /*inArgs*/ OfxPropertySetHandle effectProps; gEffectHost->getPropertySet(effect, &effectProps); - // reteive the colour management style that the host has decided we shall use + // retrieve the colour management style that the host has decided we shall use ColourManagementStyle active_style = ColourManagementStyle::None; char * style; if(gPropHost->propGetString(effectProps, kOfxImageEffectPropColourManagementStyle, 0, &style) == kOfxStatOK) { @@ -606,7 +606,7 @@ getOutputColourspace( OfxImageEffectHandle effect, OfxPropertySetHandle /*inAr OfxPropertySetHandle effectProps; gEffectHost->getPropertySet(effect, &effectProps); - // reteive the colour management style that the host has decided we shall use + // retrieve the colour management style that the host has decided we shall use ColourManagementStyle active_style = ColourManagementStyle::None; char * style; if(gPropHost->propGetString(effectProps, kOfxImageEffectPropColourManagementStyle, 0, &style) == kOfxStatOK) { From d0b7746741c29f0831ff35b77bc117a809ab3a2f Mon Sep 17 00:00:00 2001 From: luzpaz Date: Tue, 16 Sep 2025 12:19:10 +0000 Subject: [PATCH 3/6] Fix typos in HostSupport subdirectory Found via codespell Signed-off-by: luzpaz --- HostSupport/examples/cacheDemo.cpp | 2 +- HostSupport/examples/hostDemoClipInstance.cpp | 8 +++--- HostSupport/examples/hostDemoClipInstance.h | 10 +++---- HostSupport/examples/hostDemoEffectInstance.h | 2 +- .../examples/hostDemoHostDescriptor.cpp | 2 +- HostSupport/include/ofxhClip.h | 22 +++++++-------- HostSupport/include/ofxhImageEffect.h | 20 ++++++------- HostSupport/include/ofxhInteract.h | 28 +++++++++---------- HostSupport/include/ofxhParam.h | 22 +++++++-------- HostSupport/include/ofxhPluginCache.h | 6 ++-- HostSupport/include/ofxhPropertySuite.h | 4 +-- HostSupport/include/ofxhUtilities.h | 6 ++-- HostSupport/src/ofxhClip.cpp | 14 +++++----- HostSupport/src/ofxhHost.cpp | 2 +- HostSupport/src/ofxhImageEffect.cpp | 22 +++++++-------- HostSupport/src/ofxhInteract.cpp | 2 +- HostSupport/src/ofxhPropertySuite.cpp | 20 ++++++------- include/ofxImageEffect.h | 4 +-- 18 files changed, 98 insertions(+), 98 deletions(-) diff --git a/HostSupport/examples/cacheDemo.cpp b/HostSupport/examples/cacheDemo.cpp index 1dc0cc00..cf425047 100644 --- a/HostSupport/examples/cacheDemo.cpp +++ b/HostSupport/examples/cacheDemo.cpp @@ -85,7 +85,7 @@ public : printf("\n"); if(isQuestion) { - /// cant do this properly inour example, as we need to raise a dialogue to ask a question, so just return yes + /// can't do this properly in our example, as we need to raise a dialogue to ask a question, so just return yes return kOfxStatReplyYes; } else { diff --git a/HostSupport/examples/hostDemoClipInstance.cpp b/HostSupport/examples/hostDemoClipInstance.cpp index b8fa4cc0..c067816b 100644 --- a/HostSupport/examples/hostDemoClipInstance.cpp +++ b/HostSupport/examples/hostDemoClipInstance.cpp @@ -261,8 +261,8 @@ namespace MyHost { /// Field Order - Which spatial field occurs temporally first in a frame. /// \returns /// - kOfxImageFieldNone - the clip material is unfielded - /// - kOfxImageFieldLower - the clip material is fielded, with image rows 0,2,4.... occuring first in a frame - /// - kOfxImageFieldUpper - the clip material is fielded, with image rows line 1,3,5.... occuring first in a frame + /// - kOfxImageFieldLower - the clip material is fielded, with image rows 0,2,4.... occurring first in a frame + /// - kOfxImageFieldUpper - the clip material is fielded, with image rows line 1,3,5.... occurring first in a frame const std::string &MyClipInstance::getFieldOrder() const { /// our clip is pretending to be progressive PAL SD, so return kOfxImageFieldNone @@ -300,8 +300,8 @@ namespace MyHost { // Continuous Samples - // - // 0 if the images can only be sampled at discreet times (eg: the clip is a sequence of frames), - // 1 if the images can only be sampled continuously (eg: the clip is infact an animating roto spline and can be rendered anywhen). + // 0 if the images can only be sampled at discrete times (eg: the clip is a sequence of frames), + // 1 if the images can only be sampled continuously (eg: the clip is in fact an animating roto spline and can be rendered anywhen). bool MyClipInstance::getContinuousSamples() const { return false; diff --git a/HostSupport/examples/hostDemoClipInstance.h b/HostSupport/examples/hostDemoClipInstance.h index ba046818..4fa244e3 100755 --- a/HostSupport/examples/hostDemoClipInstance.h +++ b/HostSupport/examples/hostDemoClipInstance.h @@ -8,7 +8,7 @@ namespace MyHost { - // foward + // forward class MyClipInstance; /// make an image up @@ -77,8 +77,8 @@ namespace MyHost { /// Field Order - Which spatial field occurs temporally first in a frame. /// \returns /// - kOfxImageFieldNone - the clip material is unfielded - /// - kOfxImageFieldLower - the clip material is fielded, with image rows 0,2,4.... occuring first in a frame - /// - kOfxImageFieldUpper - the clip material is fielded, with image rows line 1,3,5.... occuring first in a frame + /// - kOfxImageFieldLower - the clip material is fielded, with image rows 0,2,4.... occurring first in a frame + /// - kOfxImageFieldUpper - the clip material is fielded, with image rows line 1,3,5.... occurring first in a frame virtual const std::string &getFieldOrder() const; // Connected - @@ -98,8 +98,8 @@ namespace MyHost { // Continuous Samples - // - // 0 if the images can only be sampled at discreet times (eg: the clip is a sequence of frames), - // 1 if the images can only be sampled continuously (eg: the clip is infact an animating roto spline and can be rendered anywhen). + // 0 if the images can only be sampled at discrete times (eg: the clip is a sequence of frames), + // 1 if the images can only be sampled continuously (eg: the clip is in fact an animating roto spline and can be rendered anywhen). virtual bool getContinuousSamples() const; /// override this to fill in the image at the given time. diff --git a/HostSupport/examples/hostDemoEffectInstance.h b/HostSupport/examples/hostDemoEffectInstance.h index ba833333..c231bdb8 100755 --- a/HostSupport/examples/hostDemoEffectInstance.h +++ b/HostSupport/examples/hostDemoEffectInstance.h @@ -58,7 +58,7 @@ namespace MyHost { // The extent of the current project in canonical coordinates. // The extent is the size of the 'output' for the current project. See ProjectCoordinateSystems - // for more infomation on the project extent. The extent is in canonical coordinates and only + // for more information on the project extent. The extent is in canonical coordinates and only // returns the top right position, as the extent is always rooted at 0,0. For example a PAL SD // project would have an extent of 768, 576. virtual void getProjectExtent(double& xSize, double& ySize) const; diff --git a/HostSupport/examples/hostDemoHostDescriptor.cpp b/HostSupport/examples/hostDemoHostDescriptor.cpp index b9945a57..7b5cbe8a 100755 --- a/HostSupport/examples/hostDemoHostDescriptor.cpp +++ b/HostSupport/examples/hostDemoHostDescriptor.cpp @@ -122,7 +122,7 @@ namespace MyHost printf("\n"); if(isQuestion) { - /// cant do this properly inour example, as we need to raise a dialogue to ask a question, so just return yes + /// can't do this properly in our example, as we need to raise a dialogue to ask a question, so just return yes return kOfxStatReplyYes; } else { diff --git a/HostSupport/include/ofxhClip.h b/HostSupport/include/ofxhClip.h index da437e09..fdc63cee 100755 --- a/HostSupport/include/ofxhClip.h +++ b/HostSupport/include/ofxhClip.h @@ -33,7 +33,7 @@ namespace OFX { virtual ~ClipBase() { } - /// ctor, when copy constructing an instance from a descripto + /// ctor, when copy constructing an instance from a descriptor explicit ClipBase(const ClipBase &other); /// name of the clip @@ -106,8 +106,8 @@ namespace OFX { protected: ImageEffect::Instance* _effectInstance; ///< image effect instance bool _isOutput; ///< are we the output clip - std::string _pixelDepth; ///< what is the bit depth we is at. Set during the clip prefernces action. - std::string _components; ///< what components do we have. Set during the clip prefernces action. + std::string _pixelDepth; ///< what is the bit depth we is at. Set during the clip preferences action. + std::string _components; ///< what components do we have. Set during the clip preferences action. public: ClipInstance(ImageEffect::Instance* effectInstance, ClipDescriptor& desc); @@ -224,8 +224,8 @@ namespace OFX { /// Field Order - Which spatial field occurs temporally first in a frame. /// \returns /// - kOfxImageFieldNone - the clip material is unfielded - /// - kOfxImageFieldLower - the clip material is fielded, with image rows 0,2,4.... occuring first in a frame - /// - kOfxImageFieldUpper - the clip material is fielded, with image rows line 1,3,5.... occuring first in a frame + /// - kOfxImageFieldLower - the clip material is fielded, with image rows 0,2,4.... occurring first in a frame + /// - kOfxImageFieldUpper - the clip material is fielded, with image rows line 1,3,5.... occurring first in a frame virtual const std::string &getFieldOrder() const = 0; // Connected - @@ -245,8 +245,8 @@ namespace OFX { // Continuous Samples - // - // 0 if the images can only be sampled at discreet times (eg: the clip is a sequence of frames), - // 1 if the images can only be sampled continuously (eg: the clip is infact an animating roto spline and can be rendered anywhen). + // 0 if the images can only be sampled at discrete times (eg: the clip is a sequence of frames), + // 1 if the images can only be sampled continuously (eg: the clip is in fact an animating roto spline and can be rendered anywhen). virtual bool getContinuousSamples() const = 0; /// override this to fill in the image at the given time. @@ -271,7 +271,7 @@ namespace OFX { virtual OfxRectD getRegionOfDefinition(OfxTime time) const = 0; /// given the colour component, find the nearest set of supported colour components - /// override this for extra wierd custom component depths + /// override this for extra weird custom component depths virtual const std::string &findSupportedComp(const std::string &s) const; }; @@ -291,7 +291,7 @@ namespace OFX { ImageBase(); /// construct from a clip instance, but leave the - /// filling it to the calling code via the propery set + /// filling it to the calling code via the property set explicit ImageBase(ClipInstance& instance); // Render Scale (renderScaleX,renderScaleY) - @@ -365,7 +365,7 @@ namespace OFX { Image(); /// construct from a clip instance, but leave the - /// filling it to the calling code via the propery set + /// filling it to the calling code via the property set explicit Image(ClipInstance& instance); // Render Scale (renderScaleX,renderScaleY) - @@ -430,7 +430,7 @@ namespace OFX { Texture(); /// construct from a clip instance, but leave the - /// filling it to the calling code via the propery set + /// filling it to the calling code via the property set explicit Texture(ClipInstance& instance); // Render Scale (renderScaleX,renderScaleY) - diff --git a/HostSupport/include/ofxhImageEffect.h b/HostSupport/include/ofxhImageEffect.h index f0d4e754..fdd9241e 100755 --- a/HostSupport/include/ofxhImageEffect.h +++ b/HostSupport/include/ofxhImageEffect.h @@ -124,10 +124,10 @@ namespace OFX { virtual OfxStatus flushOpenGLResources() const = 0; # endif - /// override this to use your own memory instance - must inherrit from memory::instance + /// override this to use your own memory instance - must inherit from memory::instance virtual Memory::Instance* newMemoryInstance(size_t nBytes); - // return an memory::instance calls makeMemoryInstance that can be overriden + // return an memory::instance calls makeMemoryInstance that can be overridden Memory::Instance* imageMemoryAlloc(size_t nBytes); }; @@ -335,7 +335,7 @@ namespace OFX { /// get output fielding as set in the clip preferences action. const std::string &getOutputPreMultiplication() const {return _outputPreMultiplication; } - /// get the output frame rate, as set in the clip prefences action. + /// get the output frame rate, as set in the clip preferences action. double getOutputFrameRate() const {return _outputFrameRate;} @@ -368,16 +368,16 @@ namespace OFX { /// params and input images are exactly the same. eg: random noise generator bool isFrameVarying() const {return _frameVarying;} - /// pure virtuals that must be overriden + /// pure virtuals that must be overridden virtual ClipInstance* getClip(const std::string& name) const; /// override this to make processing abort, return 1 to abort processing virtual int abort(); - /// override this to use your own memory instance - must inherrit from memory::instance + /// override this to use your own memory instance - must inherit from memory::instance virtual Memory::Instance* newMemoryInstance(size_t nBytes); - // return an memory::instance calls makeMemoryInstance that can be overriden + // return an memory::instance calls makeMemoryInstance that can be overridden Memory::Instance* imageMemoryAlloc(size_t nBytes); /// make a clip @@ -410,10 +410,10 @@ namespace OFX { /// overridden from Property::Notify virtual void notify(const std::string &name, bool singleValue, int indexOrN); - /// overridden from gethook, get the virutals for viewport size, pixel scale, background colour + /// overridden from gethook, get the virtuals for viewport size, pixel scale, background colour virtual double getDoubleProperty(const std::string &name, int index) const; - /// overridden from gethook, get the virutals for viewport size, pixel scale, background colour + /// overridden from gethook, get the virtuals for viewport size, pixel scale, background colour virtual void getDoublePropertyN(const std::string &name, double *values, int count) const; /// overridden from gethook, don't know what to do @@ -441,7 +441,7 @@ namespace OFX { // The extent of the current project in canonical coordinates. // The extent is the size of the 'output' for the current project. See ProjectCoordinateSystems - // for more infomation on the project extent. The extent is in canonical coordinates and only + // for more information on the project extent. The extent is in canonical coordinates and only // returns the top right position, as the extent is always rooted at 0,0. For example a PAL SD // project would have an extent of 768, 576. virtual void getProjectExtent(double& xSize, double& ySize) const = 0; @@ -611,7 +611,7 @@ namespace OFX { virtual void setDefaultClipPreferences(); /// Initialise the clip preferences arguments, override this to do - /// stuff with wierd components etc... Calls setDefaultClipPreferences + /// stuff with weird components etc... Calls setDefaultClipPreferences virtual void setupClipPreferencesArgs(Property::Set &args); /// Run the clip preferences action from the effect. diff --git a/HostSupport/include/ofxhInteract.h b/HostSupport/include/ofxhInteract.h index b4846353..661d3981 100755 --- a/HostSupport/include/ofxhInteract.h +++ b/HostSupport/include/ofxhInteract.h @@ -76,7 +76,7 @@ namespace OFX { }; /// a generic interact, it doesn't belong to anything in particular - /// we need to generify this slighty more and remove the renderscale args + /// we need to generify this further and remove the renderscale args /// into a derived class, as they only belong to image effect plugins class Instance : public Base, protected Property::GetHook { protected: @@ -148,7 +148,7 @@ namespace OFX { // don't know what to do virtual void reset(const std::string &name); - /// the gethook virutals for pixel scale, background colour + /// the gethook virtuals for pixel scale, background colour virtual double getDoubleProperty(const std::string &name, int index) const; /// for pixel scale and background colour @@ -161,7 +161,7 @@ namespace OFX { // // Params - // - // time - the effect time at which changed occured + // time - the effect time at which changed occurred // renderScale - the render scale virtual OfxStatus drawAction(OfxTime time, const OfxPointD &renderScale); @@ -169,11 +169,11 @@ namespace OFX { // // Params - // - // time - the effect time at which changed occured + // time - the effect time at which changed occurred // renderScale - the render scale // penX - the X position // penY - the Y position - // pressure - the pen pressue 0 to 1 + // pressure - the pen pressure 0 to 1 virtual OfxStatus penMotionAction(OfxTime time, const OfxPointD &renderScale, const OfxPointD &penPos, @@ -184,11 +184,11 @@ namespace OFX { // // Params - // - // time - the effect time at which changed occured + // time - the effect time at which changed occurred // renderScale - the render scale // penX - the X position // penY - the Y position - // pressure - the pen pressue 0 to 1 + // pressure - the pen pressure 0 to 1 virtual OfxStatus penUpAction(OfxTime time, const OfxPointD &renderScale, const OfxPointD &penPos, @@ -199,11 +199,11 @@ namespace OFX { // // Params - // - // time - the effect time at which changed occured + // time - the effect time at which changed occurred // renderScale - the render scale // penX - the X position // penY - the Y position - // pressure - the pen pressue 0 to 1 + // pressure - the pen pressure 0 to 1 virtual OfxStatus penDownAction(OfxTime time, const OfxPointD &renderScale, const OfxPointD &penPos, @@ -214,7 +214,7 @@ namespace OFX { // // Params - // - // time - the effect time at which changed occured + // time - the effect time at which changed occurred // renderScale - the render scale // key - the pressed key // keyString - the pressed key string @@ -227,7 +227,7 @@ namespace OFX { // // Params - // - // time - the effect time at which changed occured + // time - the effect time at which changed occurred // renderScale - the render scale // key - the pressed key // keyString - the pressed key string @@ -240,7 +240,7 @@ namespace OFX { // // Params - // - // time - the effect time at which changed occured + // time - the effect time at which changed occurred // renderScale - the render scale // key - the pressed key // keyString - the pressed key string @@ -253,7 +253,7 @@ namespace OFX { // // Params - // - // time - the effect time at which changed occured + // time - the effect time at which changed occurred // renderScale - the render scale virtual OfxStatus gainFocusAction(OfxTime time, const OfxPointD &renderScale); @@ -262,7 +262,7 @@ namespace OFX { // // Params - // - // time - the effect time at which changed occured + // time - the effect time at which changed occurred // renderScale - the render scale virtual OfxStatus loseFocusAction(OfxTime time, const OfxPointD &renderScale); diff --git a/HostSupport/include/ofxhParam.h b/HostSupport/include/ofxhParam.h index d5b51dc3..714abbb5 100755 --- a/HostSupport/include/ofxhParam.h +++ b/HostSupport/include/ofxhParam.h @@ -208,7 +208,7 @@ namespace OFX { // va list calls below turn the var args (oh what a mistake) // suite functions into virtual function calls on instances - // they are not to be overridden by host implementors by + // they are not to be overridden by host implementers by // by the various typeed param instances so that they can // deconstruct the var args lists @@ -268,7 +268,7 @@ namespace OFX { public: IntegerInstance(Descriptor& descriptor, Param::SetInstance* instance = 0) : Instance(descriptor,instance) {} - // Deriving implementatation needs to overide these + // Deriving implementation needs to override these virtual OfxStatus get(int&) = 0; virtual OfxStatus get(OfxTime time, int&) = 0; virtual OfxStatus set(int) = 0; @@ -304,7 +304,7 @@ namespace OFX { // callback which should set option as appropriate virtual void setOption(int num); - // Deriving implementatation needs to overide these + // Deriving implementation needs to override these virtual OfxStatus get(int&) = 0; virtual OfxStatus get(OfxTime time, int&) = 0; virtual OfxStatus set(int) = 0; @@ -330,7 +330,7 @@ namespace OFX { public: DoubleInstance(Descriptor& descriptor, Param::SetInstance* instance = 0) : Instance(descriptor,instance) {} - // Deriving implementatation needs to overide these + // Deriving implementation needs to override these virtual OfxStatus get(double&) = 0; virtual OfxStatus get(OfxTime time, double&) = 0; virtual OfxStatus set(double) = 0; @@ -361,7 +361,7 @@ namespace OFX { public: BooleanInstance(Descriptor& descriptor, Param::SetInstance* instance = 0) : Instance(descriptor,instance) {} - // Deriving implementatation needs to overide these + // Deriving implementation needs to override these virtual OfxStatus get(bool&) = 0; virtual OfxStatus get(OfxTime time, bool&) = 0; virtual OfxStatus set(bool) = 0; @@ -384,7 +384,7 @@ namespace OFX { public: RGBAInstance(Descriptor& descriptor, Param::SetInstance* instance = 0) : Instance(descriptor,instance) {} - // Deriving implementatation needs to overide these + // Deriving implementation needs to override these virtual OfxStatus get(double&,double&,double&,double&) = 0; virtual OfxStatus get(OfxTime time, double&,double&,double&,double&) = 0; virtual OfxStatus set(double,double,double,double) = 0; @@ -417,7 +417,7 @@ namespace OFX { public: RGBInstance(Descriptor& descriptor, Param::SetInstance* instance = 0) : Instance(descriptor,instance) {} - // Deriving implementatation needs to overide these + // Deriving implementation needs to override these virtual OfxStatus get(double&,double&,double&) = 0; virtual OfxStatus get(OfxTime time, double&,double&,double&) = 0; virtual OfxStatus set(double,double,double) = 0; @@ -450,7 +450,7 @@ namespace OFX { public: Double2DInstance(Descriptor& descriptor, Param::SetInstance* instance = 0) : Instance(descriptor,instance) {} - // Deriving implementatation needs to overide these + // Deriving implementation needs to override these virtual OfxStatus get(double&,double&) = 0; virtual OfxStatus get(OfxTime time, double&,double&) = 0; virtual OfxStatus set(double,double) = 0; @@ -483,7 +483,7 @@ namespace OFX { public: Integer2DInstance(Descriptor& descriptor, Param::SetInstance* instance = 0) : Instance(descriptor,instance) {} - // Deriving implementatation needs to overide these + // Deriving implementation needs to override these virtual OfxStatus get(int&,int&) = 0; virtual OfxStatus get(OfxTime time, int&,int&) = 0; virtual OfxStatus set(int,int) = 0; @@ -516,7 +516,7 @@ namespace OFX { public: Double3DInstance(Descriptor& descriptor, Param::SetInstance* instance = 0) : Instance(descriptor,instance) {} - // Deriving implementatation needs to overide these + // Deriving implementation needs to override these virtual OfxStatus get(double&,double&,double&) = 0; virtual OfxStatus get(OfxTime time, double&,double&,double&) = 0; virtual OfxStatus set(double,double,double) = 0; @@ -627,7 +627,7 @@ namespace OFX { public : /// ctor /// - /// The propery set being passed in belongs to the owning + /// The property set being passed in belongs to the owning /// plugin instance. explicit SetInstance(); diff --git a/HostSupport/include/ofxhPluginCache.h b/HostSupport/include/ofxhPluginCache.h index dda1bd53..086993ec 100644 --- a/HostSupport/include/ofxhPluginCache.h +++ b/HostSupport/include/ofxhPluginCache.h @@ -25,7 +25,7 @@ namespace OFX { class Host; - // forward delcarations + // forward declarations class PluginDesc; class Plugin; class PluginBinary; @@ -186,7 +186,7 @@ namespace OFX { friend class PluginHandle; protected : - Binary _binary; ///< our binary object, abstracted layer ontop of OS calls, defined in ofxhBinary.h + Binary _binary; ///< our binary object, abstracted layer on top of OS calls, defined in ofxhBinary.h std::string _filePath; ///< full path to the file std::string _bundlePath; ///< path to the .bundle directory std::vector _plugins; ///< my plugins @@ -379,7 +379,7 @@ namespace OFX { } } - /// specify which subdirectory of /usr/OFX or equivilant + /// specify which subdirectory of /usr/OFX or equivalent /// (as well as 'Plugins') to look in for plugins. void setPluginHostPath(const std::string &hostId); diff --git a/HostSupport/include/ofxhPropertySuite.h b/HostSupport/include/ofxhPropertySuite.h index 1a1031e2..6c53ba12 100644 --- a/HostSupport/include/ofxhPropertySuite.h +++ b/HostSupport/include/ofxhPropertySuite.h @@ -70,7 +70,7 @@ namespace OFX { struct IntValue { typedef int APIType; ///< C type of the property that is passed across the raw API typedef int APITypeConstless; ///< C type of the property that is passed across the raw API, without any const it - typedef int Type; ///< Type we actually hold and deal with the propery in everything by the raw API + typedef int Type; ///< Type we actually hold and deal with the property in everything by the raw API typedef int ReturnType; ///< type to return from a function call static const TypeEnum typeCode = eInt; static int kEmpty; @@ -438,7 +438,7 @@ namespace OFX { /// specialised versions of this. void addNotifyHook(const std::string &name, NotifyHook *hook) const; - /// Fetchs a pointer to a property of the given name, following the property chain if the + /// Fetches a pointer to a property of the given name, following the property chain if the /// 'followChain' arg is not false. Property *fetchProperty(const std::string &name, bool followChain = false) const; diff --git a/HostSupport/include/ofxhUtilities.h b/HostSupport/include/ofxhUtilities.h index 5720a06b..7c0cb6d6 100644 --- a/HostSupport/include/ofxhUtilities.h +++ b/HostSupport/include/ofxhUtilities.h @@ -16,7 +16,7 @@ if (host) { \ try { \ (host)->message(kOfxMessageError, "", \ - "%s: Memory allocation error occured in plugin %s (%s)", \ + "%s: Memory allocation error occurred in plugin %s (%s)", \ (msg), (plugin)->pluginIdentifier, ba.what()); \ } catch (...) { \ } \ @@ -26,7 +26,7 @@ if (host) { \ try { \ (host)->message(kOfxMessageError, "", \ - "%s: Exception occured in plugin %s (%s)", \ + "%s: Exception occurred in plugin %s (%s)", \ (msg), (plugin)->pluginIdentifier, e.what()); \ } catch (...) { \ } \ @@ -36,7 +36,7 @@ if (host) { \ try { \ (host)->message(kOfxMessageError, "", \ - "%s:Exception occured in plugin %s", \ + "%s:Exception occurred in plugin %s", \ (msg), (plugin)->pluginIdentifier); \ } catch (...) { \ } \ diff --git a/HostSupport/src/ofxhClip.cpp b/HostSupport/src/ofxhClip.cpp index 0dcce327..a51111ae 100755 --- a/HostSupport/src/ofxhClip.cpp +++ b/HostSupport/src/ofxhClip.cpp @@ -21,7 +21,7 @@ namespace OFX { namespace ImageEffect { - /// properties common to the desciptor and instance + /// properties common to the descriptor and instance /// the desc and set them, the instance cannot static const Property::PropSpec clipDescriptorStuffs[] = { { kOfxPropType, Property::eString, 1, true, kOfxTypeClip }, @@ -239,7 +239,7 @@ namespace OFX { _components = s; } - // get the virutals for viewport size, pixel scale, background colour + // get the virtuals for viewport size, pixel scale, background colour void ClipInstance::getDoublePropertyN(const std::string &name, double *values, int n) const { if(name==kOfxImagePropPixelAspectRatio){ @@ -266,7 +266,7 @@ namespace OFX { throw Property::Exception(kOfxStatErrValue); } - // get the virutals for viewport size, pixel scale, background colour + // get the virtuals for viewport size, pixel scale, background colour double ClipInstance::getDoubleProperty(const std::string &name, int n) const { if(name==kOfxImagePropPixelAspectRatio){ @@ -297,7 +297,7 @@ namespace OFX { throw Property::Exception(kOfxStatErrValue); } - // get the virutals for viewport size, pixel scale, background colour + // get the virtuals for viewport size, pixel scale, background colour int ClipInstance::getIntProperty(const std::string &name, int n) const { if(n!=0) throw Property::Exception(kOfxStatErrValue); @@ -311,14 +311,14 @@ namespace OFX { throw Property::Exception(kOfxStatErrValue); } - // get the virutals for viewport size, pixel scale, background colour + // get the virtuals for viewport size, pixel scale, background colour void ClipInstance::getIntPropertyN(const std::string &name, int *values, int n) const { if(n!=0) throw Property::Exception(kOfxStatErrValue); *values = getIntProperty(name, 0); } - // get the virutals for viewport size, pixel scale, background colour + // get the virtuals for viewport size, pixel scale, background colour const std::string &ClipInstance::getStringProperty(const std::string &name, int n) const { if(n!=0) throw Property::Exception(kOfxStatErrValue); @@ -442,7 +442,7 @@ namespace OFX { return rgb; } - /// wierd, must be some custom bit , if only one, choose that, otherwise no idea + /// weird, must be some custom bit , if only one, choose that, otherwise no idea /// how to map, you need to derive to do so. const std::vector &supportedComps = getSupportedComponents(); if(supportedComps.size() == 1) diff --git a/HostSupport/src/ofxhHost.cpp b/HostSupport/src/ofxhHost.cpp index 96f602b9..e5c85062 100644 --- a/HostSupport/src/ofxhHost.cpp +++ b/HostSupport/src/ofxhHost.cpp @@ -83,7 +83,7 @@ namespace OFX { _host.host = _properties.getHandle(); _host.fetchSuite = OFX::Host::fetchSuite; - // record the host descriptor in the propert set + // record the host descriptor in the property set _properties.setPointerProperty(kOfxHostSupportHostPointer,this); } diff --git a/HostSupport/src/ofxhImageEffect.cpp b/HostSupport/src/ofxhImageEffect.cpp index 042e4449..a3eb2279 100644 --- a/HostSupport/src/ofxhImageEffect.cpp +++ b/HostSupport/src/ofxhImageEffect.cpp @@ -476,7 +476,7 @@ namespace OFX { throw Property::Exception(kOfxStatErrMissingHostFeature); } - // get the virutals for viewport size, pixel scale, background colour + // get the virtuals for viewport size, pixel scale, background colour double Instance::getDoubleProperty(const std::string &name, int index) const { if(name==kOfxImageEffectPropProjectSize){ @@ -544,7 +544,7 @@ namespace OFX { } Instance::~Instance(){ - // destroy the instance, only if succesfully created + // destroy the instance, only if successfully created if (_created) { # ifdef OFX_DEBUG_ACTIONS std::cout << "OFX: "<<(void*)this<<"->"<; template class PropertyTemplate; template class PropertyTemplate; diff --git a/include/ofxImageEffect.h b/include/ofxImageEffect.h index 8d1c678a..0080af12 100644 --- a/include/ofxImageEffect.h +++ b/include/ofxImageEffect.h @@ -1252,8 +1252,8 @@ This contains the duration of the plug-in effect, in frames. - Property Set - a clip instance (read only) - Valid Values - This must be one of - ::kOfxImageFieldNone - the material is unfielded - - ::kOfxImageFieldLower - the material is fielded, with image rows 0,2,4.... occuring first in a frame - - ::kOfxImageFieldUpper - the material is fielded, with image rows line 1,3,5.... occuring first in a frame + - ::kOfxImageFieldLower - the material is fielded, with image rows 0,2,4.... occurring first in a frame + - ::kOfxImageFieldUpper - the material is fielded, with image rows line 1,3,5.... occurring first in a frame */ #define kOfxImageClipPropFieldOrder "OfxImageClipPropFieldOrder" From 3b9b527d1dc3955ab36580dbeafe297a5ef74067 Mon Sep 17 00:00:00 2001 From: luzpaz Date: Sun, 24 Aug 2025 13:46:16 +0000 Subject: [PATCH 4/6] Fix typos in include/ and Support/ Found via codespell Signed-off-by: luzpaz --- Support/Library/ofxsImageEffect.cpp | 14 +++--- Support/Library/ofxsInteract.cpp | 6 +-- Support/Library/ofxsLog.cpp | 2 +- Support/Library/ofxsParams.cpp | 14 +++--- Support/Library/ofxsProperty.cpp | 4 +- Support/Library/ofxsPropertyValidation.cpp | 2 +- Support/OSXStaticLoader/pluginLoader.cpp | 2 +- Support/Plugins/Basic/basic.cpp | 10 ++-- Support/Plugins/ChoiceParams/choiceparams.cpp | 6 +-- Support/Plugins/Retimer/retimer.cpp | 4 +- Support/Plugins/Tester/Tester.cpp | 4 +- Support/Plugins/Transition/crossFade.cpp | 2 +- Support/README | 4 +- Support/include/ofxsCore.h | 4 +- Support/include/ofxsImageEffect.h | 22 ++++----- Support/include/ofxsInteract.h | 6 +-- Support/include/ofxsLog.h | 2 +- Support/include/ofxsMemory.h | 2 +- Support/include/ofxsParam.h | 14 +++--- Support/include/osxDeploy.sh | 2 +- Support/support.doxy | 10 ++-- include/ofx.dtd | 4 +- include/ofxCore.h | 12 ++--- include/ofxImageEffect.h | 46 +++++++++---------- include/ofxInteract.h | 38 +++++++-------- include/ofxKeySyms.h | 8 ++-- include/ofxMemory.h | 10 ++-- include/ofxMessage.h | 10 ++-- include/ofxMultiThread.h | 16 +++---- include/ofxOld.h | 2 +- include/ofxParam.h | 26 +++++------ include/ofxParametricParam.h | 12 ++--- include/ofxProperty.h | 16 +++---- include/ofxTimeLine.h | 6 +-- scripts/genOCIOConfig | 2 +- 35 files changed, 172 insertions(+), 172 deletions(-) diff --git a/Support/Library/ofxsImageEffect.cpp b/Support/Library/ofxsImageEffect.cpp index 67baa1e6..21872aba 100644 --- a/Support/Library/ofxsImageEffect.cpp +++ b/Support/Library/ofxsImageEffect.cpp @@ -1152,7 +1152,7 @@ namespace OFX { return v; } - /** @brief get the RoD for this clip in the cannonical coordinate system */ + /** @brief get the RoD for this clip in the canonical coordinate system */ OfxRectD Clip::getRegionOfDefinition(double t) { OfxRectD bounds; @@ -1178,7 +1178,7 @@ namespace OFX { return new Image(imageHandle); } - /** @brief fetch an image, with a specific region in cannonical coordinates */ + /** @brief fetch an image, with a specific region in canonical coordinates */ Image *Clip::fetchImage(double t, const OfxRectD &bounds) { OfxPropertySetHandle imageHandle; @@ -1310,13 +1310,13 @@ namespace OFX { return _effectProps.propGetInt(kOfxPropIsInteractive) != 0; } - /** @brief set the instance to be sequentially renderred, this should have been part of clip preferences! */ + /** @brief set the instance to be sequentially rendered, this should have been part of clip preferences! */ void ImageEffect::setSequentialRender(bool v) { _effectProps.propSetInt(kOfxImageEffectInstancePropSequentialRender, int(v)); } - /** @brief Have we informed the host we want to be seqentially renderred ? */ + /** @brief Have we informed the host we want to be seqentially rendered ? */ bool ImageEffect::getSequentialRender(void) const { return _effectProps.propGetInt(kOfxImageEffectInstancePropSequentialRender) != 0; @@ -1351,7 +1351,7 @@ namespace OFX { } #endif - /** @brief notify host that the internal data structures need syncing back to parameters for persistance and so on. This is reset by the host after calling SyncPrivateData. */ + /** @brief notify host that the internal data structures need syncing back to parameters for persistence and so on. This is reset by the host after calling SyncPrivateData. */ void ImageEffect::setParamSetNeedsSyncing() { _effectProps.propSetInt(kOfxPropParamSetNeedsSyncing, 1, false); // introduced in OFX 1.2 @@ -1506,7 +1506,7 @@ namespace OFX { // fa niente } - /** @brief The sync private data action, called when the effect needs to sync any private data to persistant parameters */ + /** @brief The sync private data action, called when the effect needs to sync any private data to persistent parameters */ void ImageEffect::syncPrivateData(void) { // fa niente @@ -1747,7 +1747,7 @@ namespace OFX { } } - /** @brief Set whether the effect can be continously sampled. */ + /** @brief Set whether the effect can be continuously sampled. */ void ClipPreferencesSetter::setOutputHasContinousSamples(bool v) { doneSomething_ = true; diff --git a/Support/Library/ofxsInteract.cpp b/Support/Library/ofxsInteract.cpp index ecd8464c..d1180b03 100644 --- a/Support/Library/ofxsInteract.cpp +++ b/Support/Library/ofxsInteract.cpp @@ -66,7 +66,7 @@ namespace OFX { throwSuiteStatusException(stat); _interactProperties.propSetHandle(propHandle); - // set othe instance data on the property handle to point to this interact + // set other instance data on the property handle to point to this interact _interactProperties.propSetPointer(kOfxPropInstanceData, (void *)this); // get the effect handle from this handle @@ -92,7 +92,7 @@ namespace OFX { return _interactProperties.propGetInt(kOfxInteractPropHasAlpha) != 0; } - /** @brief Returns the size of a real screen pixel under the interact's cannonical projection */ + /** @brief Returns the size of a real screen pixel under the interact's canonical projection */ OfxPointD Interact::getPixelScale(void) const { @@ -130,7 +130,7 @@ namespace OFX { throwSuiteStatusException(stat); } - /** @brief Swap a buffer in the case of a double bufferred interact, this is possibly a silly one */ + /** @brief Swap a buffer in the case of a double buffered interact, this is possibly a silly one */ void Interact::swapBuffers(void) const { diff --git a/Support/Library/ofxsLog.cpp b/Support/Library/ofxsLog.cpp index 8e4e0d19..50f29086 100644 --- a/Support/Library/ofxsLog.cpp +++ b/Support/Library/ofxsLog.cpp @@ -36,7 +36,7 @@ namespace OFX { gLogFileName = value; } - /** @brief Opens the log file, returns whether this was sucessful or not. */ + /** @brief Opens the log file, returns whether this was successful or not. */ bool open(void) { #ifdef DEBUG diff --git a/Support/Library/ofxsParams.cpp b/Support/Library/ofxsParams.cpp index 45fada14..4d3c4860 100644 --- a/Support/Library/ofxsParams.cpp +++ b/Support/Library/ofxsParams.cpp @@ -101,7 +101,7 @@ namespace OFX { , _paramType(type) , _paramProps(props) { - // validate the properities on this descriptor + // validate the properties on this descriptor if(type != eDummyParam) OFX::Validation::validateParameterProperties(type, props, true); } @@ -201,7 +201,7 @@ namespace OFX { _paramProps.propSetInt(kOfxParamPropAnimates, v); } - /** @brief set whether the param is persistant, defaults to true */ + /** @brief set whether the param is persistent, defaults to true */ void ValueParamDescriptor::setIsPersistant(bool v) { _paramProps.propSetInt(kOfxParamPropPersistant, v); @@ -1050,7 +1050,7 @@ namespace OFX { } } - /** @brief estabilishes the order of page params. Do it by calling it in turn for each page */ + /** @brief establishes the order of page params. Do it by calling it in turn for each page */ void ParamSetDescriptor::setPageParamOrder(PageParamDescriptor &p) { @@ -1391,21 +1391,21 @@ namespace OFX { return _paramProps.propGetInt(kOfxParamPropIsAutoKeying) != 0; } - /** @brief is the param persistant */ + /** @brief is the param persistent */ bool ValueParam::getIsPersistant(void) const { return _paramProps.propGetInt(kOfxParamPropPersistant) != 0; } - /** @brief Get's whether the value of the param is significant (ie: affects the rendered image) */ + /** @brief Gets whether the value of the param is significant (ie: affects the rendered image) */ bool ValueParam::getEvaluateOnChange(void) const { return _paramProps.propGetInt(kOfxParamPropEvaluateOnChange) != 0; } - /** @brief Get's whether the value of the param is significant (ie: affects the rendered image) */ + /** @brief Gets whether the value of the param is significant (ie: affects the rendered image) */ CacheInvalidationEnum ValueParam::getCacheInvalidation(void) const { @@ -2775,7 +2775,7 @@ namespace OFX { @returns - ::kOfxStatOK - all was fine - - ::kOfxStatErrBadHandle - if the paramter handle was invalid + - ::kOfxStatErrBadHandle - if the parameter handle was invalid - ::kOfxStatErrUnknown - if the type is unknown This modifies an existing control point. Note that by changing key, the order of the diff --git a/Support/Library/ofxsProperty.cpp b/Support/Library/ofxsProperty.cpp index ed46b2a4..ccf1e6b0 100644 --- a/Support/Library/ofxsProperty.cpp +++ b/Support/Library/ofxsProperty.cpp @@ -21,7 +21,7 @@ namespace OFX { break; case kOfxStatErrUnknown : - case kOfxStatErrUnsupported : // unsupported implies unknow here + case kOfxStatErrUnsupported : // unsupported implies unknown here if(OFX::PropertySet::getThrowOnUnsupportedProperties()) // are we suppressing this? throw OFX::Exception::PropertyUnknownToHost(propName.c_str()); break; @@ -72,7 +72,7 @@ namespace OFX { { assert(_propHandle != 0); OfxStatus stat = gPropSuite->propReset(_propHandle, property); - Log::error(stat != kOfxStatOK, "Failed on reseting property %s to its defaults, host returned status %s.", property, mapStatusToString(stat)); + Log::error(stat != kOfxStatOK, "Failed on resetting property %s to its defaults, host returned status %s.", property, mapStatusToString(stat)); throwPropertyException(stat, property); if(_gPropLogging > 0) Log::print("Reset property %s.", property); diff --git a/Support/Library/ofxsPropertyValidation.cpp b/Support/Library/ofxsPropertyValidation.cpp index 7daf7bdb..5479ddb2 100644 --- a/Support/Library/ofxsPropertyValidation.cpp +++ b/Support/Library/ofxsPropertyValidation.cpp @@ -294,7 +294,7 @@ namespace OFX { PropertyDescription(kOfxImageEffectPropSupportedComponents, OFX::eString, -1, eDescFinished), PropertyDescription(kOfxImageEffectPropSupportedContexts, OFX::eString, -1, eDescFinished), - // multi dimensional int properities + // multi dimensional int properties PropertyDescription(kOfxParamHostPropPageRowColumnCount, OFX::eInt, 2, eDescFinished), }; diff --git a/Support/OSXStaticLoader/pluginLoader.cpp b/Support/OSXStaticLoader/pluginLoader.cpp index 2ae787c2..fd139fcc 100644 --- a/Support/OSXStaticLoader/pluginLoader.cpp +++ b/Support/OSXStaticLoader/pluginLoader.cpp @@ -43,7 +43,7 @@ main(int argc, char *argv[]) int nP = nPluginsFunc(); - printf("Sucessfully loaded '%s', containing %d %s\n", argv[1], nP, (nP == 1 ? "plugin" : "plugins")); + printf("Successfully loaded '%s', containing %d %s\n", argv[1], nP, (nP == 1 ? "plugin" : "plugins")); for(int i = 0; i < nP; i++) { // get a plugin diff --git a/Support/Plugins/Basic/basic.cpp b/Support/Plugins/Basic/basic.cpp index 9d8b0da3..83ce9d06 100644 --- a/Support/Plugins/Basic/basic.cpp +++ b/Support/Plugins/Basic/basic.cpp @@ -419,7 +419,7 @@ BasicPlugin:: isIdentity(const OFX::IsIdentityArguments &args, OFX::Clip * &iden return true; } - // nope, idenity we is + // nope, identity we is return false; } @@ -427,7 +427,7 @@ BasicPlugin:: isIdentity(const OFX::IsIdentityArguments &args, OFX::Clip * &iden void BasicPlugin::setEnabledness(void) { - // the componet enabledness depends on the clip being RGBA and the param being true + // the component enabledness depends on the clip being RGBA and the param being true bool v = componentScalesEnabled_->getValue() && srcClip_->getPixelComponents() == OFX::ePixelComponentRGBA; // enable them @@ -502,11 +502,11 @@ bool BasicInteract::draw(const OFX::DrawArgs &args) bool BasicInteract::penMotion(const OFX::PenArgs &args) { - // figure the size of the box in cannonical coords + // figure the size of the box in canonical coords float dx = (float)(kBoxSize.x * args.pixelScale.x); float dy = (float)(kBoxSize.y * args.pixelScale.y); - // pen position is in cannonical coords + // pen position is in canonical coords OfxPointD penPos = args.penPosition; switch(_state) { @@ -564,7 +564,7 @@ BasicInteract::penDown(const OFX::PenArgs &args) // move our position _position = args.penPosition; - // and request a redraw just incase + // and request a redraw just in case _effect->redrawOverlays(); } diff --git a/Support/Plugins/ChoiceParams/choiceparams.cpp b/Support/Plugins/ChoiceParams/choiceparams.cpp index b92cc7d9..c0a1fafd 100644 --- a/Support/Plugins/ChoiceParams/choiceparams.cpp +++ b/Support/Plugins/ChoiceParams/choiceparams.cpp @@ -481,11 +481,11 @@ bool ChoiceParamsInteract::draw(const OFX::DrawArgs &args) bool ChoiceParamsInteract::penMotion(const OFX::PenArgs &args) { - // figure the size of the box in cannonical coords + // figure the size of the box in canonical coords float dx = (float)(kBoxSize.x * args.pixelScale.x); float dy = (float)(kBoxSize.y * args.pixelScale.y); - // pen position is in cannonical coords + // pen position is in canonical coords OfxPointD penPos = args.penPosition; switch(_state) { @@ -543,7 +543,7 @@ ChoiceParamsInteract::penDown(const OFX::PenArgs &args) // move our position _position = args.penPosition; - // and request a redraw just incase + // and request a redraw just in case _effect->redrawOverlays(); } diff --git a/Support/Plugins/Retimer/retimer.cpp b/Support/Plugins/Retimer/retimer.cpp index 9474db15..59f113dd 100644 --- a/Support/Plugins/Retimer/retimer.cpp +++ b/Support/Plugins/Retimer/retimer.cpp @@ -280,7 +280,7 @@ namespace OFX void RetimerExamplePluginFactory::load() { - // we can't be used on hosts that don't perfrom temporal clip access + // we can't be used on hosts that don't perform temporal clip access if(!gHostDescription.temporalClipAccess) { throw OFX::Exception::HostInadequate("Need random temporal image access to work"); } @@ -331,7 +331,7 @@ void RetimerExamplePluginFactory::describeInContext(OFX::ImageEffectDescriptor & dstClip->setFieldExtraction(eFieldExtractDoubled); // which is the default anyway dstClip->setSupportsTiles(true); - // what param we have is dependant on the host + // what param we have is dependent on the host if(context == OFX::eContextRetimer) { // Define the mandated kOfxImageEffectRetimerParamName param, note that we don't do anything with this other than. // describe it. It is not a true param but how the host indicates to the plug-in which frame diff --git a/Support/Plugins/Tester/Tester.cpp b/Support/Plugins/Tester/Tester.cpp index 9ede6917..1cf901dc 100644 --- a/Support/Plugins/Tester/Tester.cpp +++ b/Support/Plugins/Tester/Tester.cpp @@ -109,13 +109,13 @@ bool PositionInteract::draw(const OFX::DrawArgs &args) // overridden functions from OFX::Interact to do things bool PositionInteract::penMotion(const OFX::PenArgs &args) { - // figure the size of the box in cannonical coords + // figure the size of the box in canonical coords float dx = (float)(kBoxSize.x / args.pixelScale.x); float dy = (float)(kBoxSize.y / args.pixelScale.y); OfxPointD pos = getCanonicalPosition(args.time); - // pen position is in cannonical coords + // pen position is in canonical coords OfxPointD penPos = args.penPosition; switch(_state) diff --git a/Support/Plugins/Transition/crossFade.cpp b/Support/Plugins/Transition/crossFade.cpp index 3f9ed452..5ccb30aa 100644 --- a/Support/Plugins/Transition/crossFade.cpp +++ b/Support/Plugins/Transition/crossFade.cpp @@ -181,7 +181,7 @@ CrossFadePlugin::isIdentity(const OFX::IsIdentityArguments &args, OFX::Clip * &i return true; } - // nope, identity we isnt + // nope, identity we isn't return false; } diff --git a/Support/README b/Support/README index 31c8a766..751c7fbb 100644 --- a/Support/README +++ b/Support/README @@ -56,7 +56,7 @@ Release Notes Still to be done, decent set of exceptions and exception specifiers on each function, skin the parameter custom interact, - parameter integration and differentiation functions needed on 2D and 3D doubles and the colour classses, + parameter integration and differentiation functions needed on 2D and 3D doubles and the colour classes, parameters should return their values in a struct, as well as by a reference arg (some do already), write examples showing custom param and param animation, write an example showing use of external resource files, @@ -66,7 +66,7 @@ Release Notes Implemented most of the basic classes, need to do more work on clip instances and image effect instances. Library builds fine on OSX 10.3, not fully tested yet. - No where near finsihed yet, + No where near finished yet, Need to finish off the actions. Need to do a cleaner set of exception classes. Need to test somewhat more (hey they do compile though!). diff --git a/Support/include/ofxsCore.h b/Support/include/ofxsCore.h index 61fd23a1..96c39f77 100755 --- a/Support/include/ofxsCore.h +++ b/Support/include/ofxsCore.h @@ -114,8 +114,8 @@ namespace OFX { /** @brief Enumerates the reasons a plug-in instance may have had one of its values changed */ enum InstanceChangeReason { - eChangeUserEdit, /**< @brief A user actively editted something in the plugin, eg: changed the value of an integer param on an interface */ - eChangePluginEdit, /**< @brief The plugin's own code changed something in the instance, eg: a callback on on param settting the value of another */ + eChangeUserEdit, /**< @brief A user actively edited something in the plugin, eg: changed the value of an integer param on an interface */ + eChangePluginEdit, /**< @brief The plugin's own code changed something in the instance, eg: a callback on on param setting the value of another */ eChangeTime /**< @brief The current value of a parameter has changed because the param animates and the current time has changed */ }; diff --git a/Support/include/ofxsImageEffect.h b/Support/include/ofxsImageEffect.h index 8a1b3dba..c43e4271 100644 --- a/Support/include/ofxsImageEffect.h +++ b/Support/include/ofxsImageEffect.h @@ -707,7 +707,7 @@ namespace OFX { /** @brief return the range of frames over which this clip has images, before any clip preferences have been applied */ OfxRangeD getUnmappedFrameRange(void) const; - /** @brief get the RoD for this clip in the cannonical coordinate system */ + /** @brief get the RoD for this clip in the canonical coordinate system */ OfxRectD getRegionOfDefinition(double t); /** @brief fetch an image @@ -718,7 +718,7 @@ namespace OFX { */ Image *fetchImage(double t); - /** @brief fetch an image, with a specific region in cannonical coordinates + /** @brief fetch an image, with a specific region in canonical coordinates When finished with, the client code must delete the image. @@ -726,7 +726,7 @@ namespace OFX { */ Image *fetchImage(double t, const OfxRectD &bounds); - /** @brief fetch an image, with a specific region in cannonical coordinates + /** @brief fetch an image, with a specific region in canonical coordinates When finished with, the client code must delete the image. @@ -932,7 +932,7 @@ namespace OFX { */ void setOutputPremultiplication(PreMultiplicationEnum v); - /** @brief Set whether the effect can be continously sampled. + /** @brief Set whether the effect can be continuously sampled. Defaults to false. */ @@ -1039,10 +1039,10 @@ namespace OFX { /** @brief is the instance currently being interacted with */ bool isInteractive(void) const; - /** @brief set the instance to be sequentially renderred, this should have been part of clip preferences! */ + /** @brief set the instance to be sequentially rendered, this should have been part of clip preferences! */ void setSequentialRender(bool v); - /** @brief Have we informed the host we want to be seqentially renderred ? */ + /** @brief Have we informed the host we want to be seqentially rendered ? */ bool getSequentialRender(void) const; /** @brief Does the plugin support image tiling ? Can only be called from changedParam or changedClip. */ @@ -1059,7 +1059,7 @@ namespace OFX { void setNeedsOpenGLRender(bool v); #endif - /** @brief notify host that the internal data structures need syncing back to parameters for persistance and so on. This is reset by the host after calling SyncPrivateData. */ + /** @brief notify host that the internal data structures need syncing back to parameters for persistence and so on. This is reset by the host after calling SyncPrivateData. */ void setParamSetNeedsSyncing(); OFX::Message::MessageReplyEnum sendMessage(OFX::Message::MessageTypeEnum type, const std::string& id, const std::string& msg); @@ -1095,7 +1095,7 @@ namespace OFX { /** @brief The purge caches action, a request for an instance to free up as much memory as possible in low memory situations */ virtual void purgeCaches(void); - /** @brief The sync private data action, called when the effect needs to sync any private data to persistant parameters */ + /** @brief The sync private data action, called when the effect needs to sync any private data to persistent parameters */ virtual void syncPrivateData(void); /** @brief client render function, this is one of the few that must be overridden */ @@ -1120,7 +1120,7 @@ namespace OFX { If the effect wants change the rod from the default value (which is the union of RoD's of all input clips) it should set the \em rod argument and return true. - This is all in cannonical coordinates. + This is all in canonical coordinates. */ virtual bool getRegionOfDefinition(const RegionOfDefinitionArguments &args, OfxRectD &rod); @@ -1129,13 +1129,13 @@ namespace OFX { If the effect wants change its region of interest on any input clip from the default values (which is the same as the RoI in the arguments) it should do so by calling the OFX::RegionOfInterestSetter::setRegionOfInterest function on the \em rois argument. - Note, everything is in \em cannonical \em coordinates. + Note, everything is in \em canonical \em coordinates. */ virtual void getRegionsOfInterest(const RegionsOfInterestArguments &args, RegionOfInterestSetter &rois); /** @brief the get frames needed action - If the effect wants change the frames needed on an input clip from the default values (which is the same as the frame to be renderred) + If the effect wants change the frames needed on an input clip from the default values (which is the same as the frame to be rendered) it should do so by calling the OFX::FramesNeededSetter::setFramesNeeded function on the \em frames argument. */ virtual void getFramesNeeded(const FramesNeededArguments &args, FramesNeededSetter &frames); diff --git a/Support/include/ofxsInteract.h b/Support/include/ofxsInteract.h index 463083b7..f2a13bed 100644 --- a/Support/include/ofxsInteract.h +++ b/Support/include/ofxsInteract.h @@ -24,7 +24,7 @@ namespace OFX { /** @brief forward declaration */ class ImageEffect; - /// all image effect interacts have these argumens + /// all image effect interacts have these arguments struct InteractArgs { /// ctor InteractArgs(const PropertySet &props); @@ -104,7 +104,7 @@ namespace OFX { /** @brief Does the openGL frame buffer have an alpha */ bool hasAlpha(void) const; - /** @brief Returns the size of a real screen pixel under the interact's cannonical projection */ + /** @brief Returns the size of a real screen pixel under the interact's canonical projection */ OfxPointD getPixelScale(void) const; /** @brief The suggested colour to draw a widget in an interact. Returns false if there is no suggestion. */ @@ -122,7 +122,7 @@ namespace OFX { /** @brief Request a redraw */ void requestRedraw(void) const; - /** @brief Swap a buffer in the case of a double bufferred interact, this is possibly a silly one */ + /** @brief Swap a buffer in the case of a double buffered interact, this is possibly a silly one */ void swapBuffers(void) const; //////////////////////////////////////////////////////////////////////////////// diff --git a/Support/include/ofxsLog.h b/Support/include/ofxsLog.h index 0b531522..b669395a 100644 --- a/Support/include/ofxsLog.h +++ b/Support/include/ofxsLog.h @@ -21,7 +21,7 @@ namespace OFX { /** @brief Sets the name of the log file. */ void setFileName(const std::string &value); - /** @brief Opens the log file, returns whether this was sucessful or not. */ + /** @brief Opens the log file, returns whether this was successful or not. */ bool open(void); /** @brief Closes the log file. */ diff --git a/Support/include/ofxsMemory.h b/Support/include/ofxsMemory.h index ad238a31..648ba69b 100644 --- a/Support/include/ofxsMemory.h +++ b/Support/include/ofxsMemory.h @@ -21,7 +21,7 @@ namespace OFX { /** @brief Allocate memory. \arg \e nBytes - the number of bytes to allocate - \arg \e handle - effect instance to assosciate with this memory allocation, or NULL + \arg \e handle - effect instance to associate with this memory allocation, or NULL This function has the host allocate memory using it's own memory resources and returns that to the plugin. This memory is distinct to any image memory allocation. diff --git a/Support/include/ofxsParam.h b/Support/include/ofxsParam.h index 0e0f8030..cdc73fc0 100644 --- a/Support/include/ofxsParam.h +++ b/Support/include/ofxsParam.h @@ -120,8 +120,8 @@ namespace OFX { /** @brief Enumerates the differing types of double params */ enum DoubleTypeEnum { eDoubleTypePlain, //!< parameter has no special interpretation - eDoubleTypeAngle, //!< parameter is to be interpretted as an angle - eDoubleTypeScale, //!< parameter is to be interpretted as a scale factor + eDoubleTypeAngle, //!< parameter is to be interpreted as an angle + eDoubleTypeScale, //!< parameter is to be interpreted as a scale factor eDoubleTypeTime, //!< parameter represents a time value (1D only) eDoubleTypeAbsoluteTime, //!< parameter represents an absolute time value (1D only), eDoubleTypeX, //!< a size in the X dimension dimension (1D only), new for 1.2 @@ -241,7 +241,7 @@ namespace OFX { /** @brief set whether the param can animate, defaults to true in most cases */ void setAnimates(bool v); - /** @brief set whether the param is persistant, defaults to true */ + /** @brief set whether the param is persistent, defaults to true */ void setIsPersistant(bool v); /** @brief Set's whether the value of the param is significant (ie: affects the rendered image), defaults to true */ @@ -276,7 +276,7 @@ namespace OFX { /** @brief sets the kind of the string param, defaults to eStringSingleLine */ void setStringType(StringTypeEnum v); - /** @brief if the string param is a file path, say that we are picking an existing file, rather than posibly specifying a new one, defaults to true */ + /** @brief if the string param is a file path, say that we are picking an existing file, rather than possibly specifying a new one, defaults to true */ void setFilePathExists(bool v); }; @@ -804,7 +804,7 @@ namespace OFX { /** @brief tries to fetch a ParamDescriptor, returns 0 if it isn't there*/ ParamDescriptor* getParamDescriptor(const std::string& name) const; - /** @brief estabilishes the order of page params. Do it by calling it in turn for each page */ + /** @brief establishes the order of page params. Do it by calling it in turn for each page */ void setPageParamOrder(PageParamDescriptor &p); /** @brief Define an integer param */ @@ -965,10 +965,10 @@ namespace OFX { /** @brief is the param animating */ bool getIsPersistant(void) const; - /** @brief Get's whether the value of the param is significant (ie: affects the rendered image) */ + /** @brief Gets whether the value of the param is significant (ie: affects the rendered image) */ bool getEvaluateOnChange(void) const; - /** @brief Get's whether the value of the param is significant (ie: affects the rendered image) */ + /** @brief Gets whether the value of the param is significant (ie: affects the rendered image) */ CacheInvalidationEnum getCacheInvalidation(void) const; /** @brief if the param is animating, the number of keys in it, otherwise 0 */ diff --git a/Support/include/osxDeploy.sh b/Support/include/osxDeploy.sh index 92a8fccc..e690637d 100755 --- a/Support/include/osxDeploy.sh +++ b/Support/include/osxDeploy.sh @@ -79,7 +79,7 @@ if otool -L "$binary" | fgrep libMagick > /dev/null; then IMAGEMAGICKMAJ=${IMAGEMAGICKVER%.*.*} IMAGEMAGICKLIB=`pkg-config --variable=libdir ImageMagick` IMAGEMAGICKSHARE=`pkg-config --variable=prefix ImageMagick`/share - # if I get this right, sed substitutes in the exe the occurences of IMAGEMAGICKVER + # if I get this right, sed substitutes in the exe the occurrences of IMAGEMAGICKVER # into the actual value retrieved from the package. # We don't need this because we use MAGICKCORE_PACKAGE_VERSION declared in the # sed -e "s,IMAGEMAGICKVER,$IMAGEMAGICKVER,g" -i "" $pkgbin/DisparityKillerM diff --git a/Support/support.doxy b/Support/support.doxy index 5aad5f2b..e5ac6e1f 100644 --- a/Support/support.doxy +++ b/Support/support.doxy @@ -182,7 +182,7 @@ SHOW_INCLUDE_FILES = YES # will interpret the first line (until the first dot) of a JavaDoc-style # comment as the brief description. If set to NO, the JavaDoc # comments will behave just like the Qt-style comments (thus requiring an -# explict @brief command for a brief description. +# explicit @brief command for a brief description. JAVADOC_AUTOBRIEF = NO @@ -711,7 +711,7 @@ COMPACT_RTF = NO RTF_HYPERLINKS = NO # Load stylesheet definitions from file. Syntax is similar to doxygen's -# config file, i.e. a series of assigments. You only have to provide +# config file, i.e. a series of assignments. You only have to provide # replacements, missing definitions are set to their default value. RTF_STYLESHEET_FILE = @@ -889,7 +889,7 @@ EXPAND_AS_DEFINED = SKIP_FUNCTION_MACROS = YES #--------------------------------------------------------------------------- -# Configuration::addtions related to external references +# Configuration::additions related to external references #--------------------------------------------------------------------------- # The TAGFILES option can be used to specify one or more tagfiles. @@ -971,7 +971,7 @@ CLASS_GRAPH = YES COLLABORATION_GRAPH = YES # If the UML_LOOK tag is set to YES doxygen will generate inheritance and -# collaboration diagrams in a style similiar to the OMG's Unified Modeling +# collaboration diagrams in a style similar to the OMG's Unified Modeling # Language. UML_LOOK = NO @@ -1065,7 +1065,7 @@ GENERATE_LEGEND = YES DOT_CLEANUP = YES #--------------------------------------------------------------------------- -# Configuration::addtions related to the search engine +# Configuration::additions related to the search engine #--------------------------------------------------------------------------- # The SEARCHENGINE tag specifies whether or not a search engine should be diff --git a/include/ofx.dtd b/include/ofx.dtd index e287fc99..0cdc5f57 100644 --- a/include/ofx.dtd +++ b/include/ofx.dtd @@ -10,7 +10,7 @@ Author Bruno Nicoletti Each ofx binary may have a single xml file associated with it that is contains resource overrides for various properties of the plugin. This file is the DTD for those resource files. Typically, the properties being changed are to do with user interface labels and layouts, as well as a few other things such as default values for parameters and so on. -If an element in the DTD has an equivilant property in OFX, the element will be the named with the same string that labels the property in the binary. For example the default property is labelled with "OfxParamPropDefault" in both cases. +If an element in the DTD has an equivalent property in OFX, the element will be the named with the same string that labels the property in the binary. For example the default property is labelled with "OfxParamPropDefault" in both cases. The only attributes used on any element are there to identify the element, typically to associate it with a named object in the binary. This is the 'name' attribute. The only other attributes are to associate a host and a locale with the resource set. @@ -26,7 +26,7 @@ A message redefinition is associated with the 'messageId' passed into the OfxMes A resource set is made up of parameter redefinitions, clip redefinitions, parameter hierarchy redefinitions and parameter page set redefinitions. -Any parameter (except page and hierachy params) in the binary may have certain properties overridden. Each parameter type has a corresponding element, for example the 2D integer parameter is specified via the 'OfxParamTypeInteger2D', the choice parameter by the 'OfxParamTypeChoice' element. There are many different elements, each of which corresponds to an OFX parameter type. The 'name' attribute of a parameter element is used to associate it with a specific parameter in the binary. +Any parameter (except page and hierarchy params) in the binary may have certain properties overridden. Each parameter type has a corresponding element, for example the 2D integer parameter is specified via the 'OfxParamTypeInteger2D', the choice parameter by the 'OfxParamTypeChoice' element. There are many different elements, each of which corresponds to an OFX parameter type. The 'name' attribute of a parameter element is used to associate it with a specific parameter in the binary. Each parameter element has its own specific set of sub elements, as not all parameters support all properties. diff --git a/include/ofxCore.h b/include/ofxCore.h index 772826ef..0fff10bd 100644 --- a/include/ofxCore.h +++ b/include/ofxCore.h @@ -213,7 +213,7 @@ These are the actions passed to a plug-in's 'main' function returns one of the error codes where the host is allowed to attempt the action again - the handle argument, being the global plug-in description handle, is - a valid handle from the end of a sucessful describe action until the + a valid handle from the end of a successful describe action until the end of the \ref kOfxActionUnload action (ie: the plug-in can cache it away without worrying about it changing between actions). - \ref kOfxImageEffectActionDescribeInContext @@ -261,7 +261,7 @@ These are the actions passed to a plug-in's 'main' function /** @brief This action is an action that may be passed to a plug-in - instance from time to time in low memory situations. Instances recieving + instance from time to time in low memory situations. Instances receiving this action should destroy any data structures they may have and release the associated memory, they can later reconstruct this from the effect's parameter set and associated information. @@ -421,7 +421,7 @@ These are the actions passed to a plug-in's 'main' function value of the object because it varies over time - \ref kOfxPropTime - - the effect time at which the chang occured (for Image Effect Plugins only) + - the effect time at which the chang occurred (for Image Effect Plugins only) - \ref kOfxImageEffectPropRenderScale - the render scale currently being applied to any image fetched from a clip (for Image Effect Plugins only) @@ -618,7 +618,7 @@ If this is not present, it is safe to assume that the version of the API is "1.0 If false the effect currently has no interface, however this may be because the effect is loaded in a background render host, or it may be loaded on an interactive host that has not yet opened an editor for the effect. -The output of an effect should only ever depend on the state of its parameters, not on the interactive flag. The interactive flag is more a courtesy flag to let a plugin know that it has an interace. If a plugin want's to have its behaviour dependant on the interactive flag, it can always make a secret parameter which shadows the state if the flag. +The output of an effect should only ever depend on the state of its parameters, not on the interactive flag. The interactive flag is more a courtesy flag to let a plugin know that it has an interface. If a plugin wants to have its behaviour dependent on the interactive flag, it can always make a secret parameter which shadows the state if the flag. */ #define kOfxPropIsInteractive "OfxPropIsInteractive" @@ -665,7 +665,7 @@ This data pointer is unique to each plug-in instance, so two instances of the sa - Type - ASCII C string X 1 - Property Set - on many objects (descriptors and instances), see \ref PropertiesByObject (read only) -This property is used to label objects uniquely amoung objects of that type. It is typically set when a plugin creates a new object with a function that takes a name. +This property is used to label objects uniquely among objects of that type. It is typically set when a plugin creates a new object with a function that takes a name. */ #define kOfxPropName "OfxPropName" @@ -736,7 +736,7 @@ The first dimension, if set, will the name of and SVG file, the second a PNG fil - Property Set - on many objects (descriptors and instances), see \ref PropertiesByObject. Typically readable and writable in most cases. - Default - initially ::kOfxPropName, but will be reset if ::kOfxPropLabel is changed. -This is a shorter version of the label, typically 13 character glyphs or less. Hosts should use this if they have limitted display space for their object labels. +This is a shorter version of the label, typically 13 character glyphs or less. Hosts should use this if they have limited display space for their object labels. */ #define kOfxPropShortLabel "OfxPropShortLabel" diff --git a/include/ofxImageEffect.h b/include/ofxImageEffect.h index 0080af12..7dd644d2 100644 --- a/include/ofxImageEffect.h +++ b/include/ofxImageEffect.h @@ -268,7 +268,7 @@ These are the list of actions passed to an image effect plugin's main function. For example ``OfxImageClipPropFrameRange_Source``. All these properties are multi-dimensional doubles, with the dimension is a multiple of two. Each pair of values indicates a continuous range of frames that - is needed on the given input. They are all initalised to the default value. + is needed on the given input. They are all initialised to the default value. @returns @@ -361,7 +361,7 @@ These are the list of actions passed to an image effect plugin's main function. - \ref kOfxPropTime the time at which to test for identity - \ref kOfxImageEffectPropFieldToRender the field to test for identity - \ref kOfxImageEffectPropRenderWindow the window (in \\ref PixelCoordinates) to test for identity under - - \ref kOfxImageEffectPropRenderScale the scale factor being applied to the images being renderred + - \ref kOfxImageEffectPropRenderScale the scale factor being applied to the images being rendered @param outArgs has the following properties which the plugin can set - \ref kOfxPropName @@ -403,7 +403,7 @@ These are the list of actions passed to an image effect plugin's main function. - \ref kOfxPropTime the time at which to render - \ref kOfxImageEffectPropFieldToRender the field to render - \ref kOfxImageEffectPropRenderWindow the window (in \\ref PixelCoordinates) to render - - \ref kOfxImageEffectPropRenderScale the scale factor being applied to the images being renderred + - \ref kOfxImageEffectPropRenderScale the scale factor being applied to the images being rendered - \ref kOfxImageEffectPropSequentialRenderStatus whether the effect is currently being rendered in strict frame order on a single instance - \ref kOfxImageEffectPropInteractiveRenderStatus if the render is in response to a user modifying the effect in an interactive session - \ref kOfxImageEffectPropRenderQualityDraft if the render should be done in draft mode (e.g. for faster scrubbing) @@ -441,7 +441,7 @@ These are the list of actions passed to an image effect plugin's main function. @param handle handle to the instance, cast to an \ref OfxImageEffectHandle @param inArgs has the following properties - - \ref kOfxImageEffectPropFrameRange the range of frames (inclusive) that will be renderred + - \ref kOfxImageEffectPropFrameRange the range of frames (inclusive) that will be rendered - \ref kOfxImageEffectPropFrameStep what is the step between frames, generally set to 1 (for full frame renders) or 0.5 (for fielded renders) - \ref kOfxPropIsInteractive is this a single frame render due to user interaction in a GUI, or a proper full sequence render. - \ref kOfxImageEffectPropRenderScale the scale factor to apply to images for this call @@ -608,7 +608,7 @@ This value will be the same for all instances of a plugin. - 0 - which means multiple instances can exist simultaneously, - 1 - which means only one instance can exist at any one time. -Some plugins, for whatever reason, may only be able to have a single instance in existance at any one time. This plugin property is used to indicate that. +Some plugins, for whatever reason, may only be able to have a single instance in existence at any one time. This plugin property is used to indicate that. */ #define kOfxImageEffectPluginPropSingleInstance "OfxImageEffectPluginPropSingleInstance" @@ -618,7 +618,7 @@ Some plugins, for whatever reason, may only be able to have a single instance in - Property Set - plugin descriptor (read/write) - Default - ::kOfxImageEffectRenderInstanceSafe - Valid Values - This must be one of - - ::kOfxImageEffectRenderUnsafe - indicating that only a single 'render' call can be made at any time amoung all instances, + - ::kOfxImageEffectRenderUnsafe - indicating that only a single 'render' call can be made at any time among all instances, - ::kOfxImageEffectRenderInstanceSafe - indicating that any instance can have a single 'render' call at any one time, - ::kOfxImageEffectRenderFullySafe - indicating that any instance of a plugin can have multiple renders running simultaneously */ @@ -694,7 +694,7 @@ The plugin can be slaved to multiple parameters (setting index 0, then index 1 e See \ref ImageEffectClipPreferences. -If a clip can be continously sampled, the frame rate will be set to 0. +If a clip can be continuously sampled, the frame rate will be set to 0. */ #define kOfxImageEffectPropSetableFrameRate "OfxImageEffectPropSetableFrameRate" @@ -720,7 +720,7 @@ See \ref ImageEffectClipPreferences. - 1 - for a plugin, indicates that it needs to be sequentially rendered to be correct, for a host, indicates that it can always support sequential rendering of plugins that are sequentially rendered, - 2 - for a plugin, indicates that it is best to render sequentially, but will still produce correct results if not, for a host, indicates that it can sometimes render sequentially, and will have set ::kOfxImageEffectPropSequentialRenderStatus on the relevant actions -Some effects have temporal dependancies, some information from from the rendering of frame N-1 is needed to render frame N correctly. This property is set by an effect to indicate such a situation. Also, some effects are more efficient if they run sequentially, but can still render correct images even if they do not, eg: a complex particle system. +Some effects have temporal dependencies, some information from from the rendering of frame N-1 is needed to render frame N correctly. This property is set by an effect to indicate such a situation. Also, some effects are more efficient if they run sequentially, but can still render correct images even if they do not, eg: a complex particle system. During an interactive session a host may attempt to render a frame out of sequence (for example when the user scrubs the current time), and the effect needs to deal with such a situation as best it can to provide feedback to the user. @@ -924,14 +924,14 @@ then the plugin can detect this via an identifier change and re-evaluate the cac */ #define kOfxImagePropUniqueIdentifier "OfxImagePropUniqueIdentifier" -/** @brief Clip and action argument property which indicates that the clip can be sampled continously +/** @brief Clip and action argument property which indicates that the clip can be sampled continuously - Type - int X 1 - Property Set - clip instance (read only), as an out argument to ::kOfxImageEffectActionGetClipPreferences action (read/write) - Default - 0 as an out argument to the ::kOfxImageEffectActionGetClipPreferences action - Valid Values - This must be one of... - - 0 if the images can only be sampled at discreet times (eg: the clip is a sequence of frames), - - 1 if the images can only be sampled continuously (eg: the clip is infact an animating roto spline and can be rendered anywhen). + - 0 if the images can only be sampled at discrete times (eg: the clip is a sequence of frames), + - 1 if the images can only be sampled continuously (eg: the clip is in fact an animating roto spline and can be rendered anywhen). If this is set to true, then the frame rate of a clip is effectively infinite, so to stop arithmetic errors the frame rate should then be set to 0. @@ -1062,7 +1062,7 @@ For an output clip, the frame rate mapped via pixel preferences. For an instance, this is the frame rate of the project the effect is in. -For the outargs property in the ::kOfxImageEffectActionGetClipPreferences action, it is used to change the frame rate of the ouput clip. +For the outargs property in the ::kOfxImageEffectActionGetClipPreferences action, it is used to change the frame rate of the output clip. */ #define kOfxImageEffectPropFrameRate "OfxImageEffectPropFrameRate" @@ -1131,7 +1131,7 @@ Any clip that is not optional will \em always be connected during a render actio - Valid Values - This must be one of 0 or 1 This property indicates whether a plugin will generate a different image from frame to frame, even if no parameters -or input image changes. For example a generater that creates random noise pixel at each frame. +or input image changes. For example a generator that creates random noise pixel at each frame. */ #define kOfxImageEffectFrameVarying "OfxImageEffectFrameVarying" @@ -1168,7 +1168,7 @@ This should be applied to any spatial parameters to position them correctly. Not - Valid Values - This must be one of 0 or 1 This property indicates that the host provides the plug-in the option to render in Draft/Preview mode. This is useful for applications that must support fast scrubbing. These allow a plug-in to take short-cuts for improved performance when the situation allows and it makes sense, for example to generate thumbnails with effects applied. -For example switch to a cheaper interpolation type or rendering mode. A plugin should expect frames rendered in this manner that will not be stucked in host cache unless the cache is only used in the same draft situations. +For example switch to a cheaper interpolation type or rendering mode. A plugin should expect frames rendered in this manner that will not be stuck in host cache unless the cache is only used in the same draft situations. If an host does not support that property a value of 0 is assumed. Also note that some hosts do implement kOfxImageEffectPropRenderScale - these two properties can be used independently. */ @@ -1193,7 +1193,7 @@ If the plugin descriptor has this property set to "true", the plugin is expected - Type - double X 2 - Property Set - a plugin instance (read only) -The extent is the size of the 'output' for the current project. See \ref NormalisedCoordinateSystem for more infomation on the project extent. +The extent is the size of the 'output' for the current project. See \ref NormalisedCoordinateSystem for more information on the project extent. The extent is in canonical coordinates and only returns the top right position, as the extent is always rooted at 0,0. @@ -1210,7 +1210,7 @@ The size of a project is a sub set of the ::kOfxImageEffectPropProjectExtent. Fo The project size is in canonical coordinates. -See \ref NormalisedCoordinateSystem for more infomation on the project extent. +See \ref NormalisedCoordinateSystem for more information on the project extent. */ #define kOfxImageEffectPropProjectSize "OfxImageEffectPropProjectSize" @@ -1225,7 +1225,7 @@ For example for a PAL SD project that is in letterbox form, the project offset i The project offset is in canonical coordinates. -See \ref NormalisedCoordinateSystem for more infomation on the project extent. +See \ref NormalisedCoordinateSystem for more information on the project extent. */ #define kOfxImageEffectPropProjectOffset "OfxImageEffectPropProjectOffset" @@ -1300,7 +1300,7 @@ The order of the values is x1, y1, x2, y2. X values are x1 <= X < x2 Y values are y1 <= Y < y2 -The ::kOfxImagePropBounds property contains the actuall addressable pixels in an image, which may be less than its full region of definition. +The ::kOfxImagePropBounds property contains the actual addressable pixels in an image, which may be less than its full region of definition. */ #define kOfxImagePropRegionOfDefinition "OfxImagePropRegionOfDefinition" @@ -1366,7 +1366,7 @@ Note that if it fetches kOfxImageFieldSingle and the host stores images natively - Property Set - a read only in argument property to ::kOfxImageEffectActionRender and ::kOfxImageEffectActionIsIdentity - Valid Values - this must be one of - kOfxImageFieldNone - there are no fields to deal with, all images are full frame - - kOfxImageFieldBoth - the imagery is fielded and both scan lines should be renderred + - kOfxImageFieldBoth - the imagery is fielded and both scan lines should be rendered - kOfxImageFieldLower - the lower field is being rendered (lines 0,2,4...) - kOfxImageFieldUpper - the upper field is being rendered (lines 1,3,5...) */ @@ -1464,7 +1464,7 @@ typedef struct OfxImageEffectSuiteV1 { @returns - ::kOfxStatOK - the property set was found and returned - - ::kOfxStatErrBadHandle - if the paramter handle was invalid + - ::kOfxStatErrBadHandle - if the parameter handle was invalid - ::kOfxStatErrUnknown - if the type is unknown */ OfxStatus (*getPropertySet)(OfxImageEffectHandle imageEffect, @@ -1479,7 +1479,7 @@ typedef struct OfxImageEffectSuiteV1 { @returns - ::kOfxStatOK - the property set was found and returned - - ::kOfxStatErrBadHandle - if the paramter handle was invalid + - ::kOfxStatErrBadHandle - if the parameter handle was invalid - ::kOfxStatErrUnknown - if the type is unknown */ OfxStatus (*getParamSet)(OfxImageEffectHandle imageEffect, @@ -1504,7 +1504,7 @@ typedef struct OfxImageEffectSuiteV1 { const char *name, OfxPropertySetHandle *propertySet); - /** @brief Get the propery handle of the named input clip in the given instance + /** @brief Get the property handle of the named input clip in the given instance \arg \c imageEffect an instance handle to the plugin \arg \c name name of the clip, previously used in a clip define call @@ -1542,7 +1542,7 @@ typedef struct OfxImageEffectSuiteV1 { @returns - ::kOfxStatOK - the property set was found and returned - - ::kOfxStatErrBadHandle - if the paramter handle was invalid + - ::kOfxStatErrBadHandle - if the parameter handle was invalid - ::kOfxStatErrUnknown - if the type is unknown */ OfxStatus (*clipGetPropertySet)(OfxImageClipHandle clip, diff --git a/include/ofxInteract.h b/include/ofxInteract.h index 3acc6d33..b9f9de1a 100644 --- a/include/ofxInteract.h +++ b/include/ofxInteract.h @@ -88,7 +88,7 @@ If a host does not support such a colour, it should return kOfxStatReplyDefault - Type - double X 2 - Property Set - read only in argument to the ::kOfxInteractActionPenMotion, ::kOfxInteractActionPenDown and ::kOfxInteractActionPenUp actions -This value passes the postion of the pen into an interact. This is in the interact's canonical coordinates. +This value passes the position of the pen into an interact. This is in the interact's canonical coordinates. */ #define kOfxInteractPropPenPosition "OfxInteractPropPenPosition" @@ -97,7 +97,7 @@ This value passes the postion of the pen into an interact. This is in the intera - Type - int X 2 - Property Set - read only in argument to the ::kOfxInteractActionPenMotion, ::kOfxInteractActionPenDown and ::kOfxInteractActionPenUp actions -This value passes the postion of the pen into an interact. This is in the interact's openGL viewport coordinates, with 0,0 being at the bottom left. +This value passes the position of the pen into an interact. This is in the interact's openGL viewport coordinates, with 0,0 being at the bottom left. */ #define kOfxInteractPropPenViewportPosition "OfxInteractPropPenViewportPosition" @@ -242,9 +242,9 @@ These are the list of actions passed to an interact's entry point function. For @param handle handle to an interact instance, cast to an \ref OfxInteractHandle @param inArgs has the following properties on an image effect plugin - \ref kOfxPropEffectInstance a handle to the effect for which the interact has been, - - \ref kOfxInteractPropPixelScale the scale factor to convert cannonical pixels to screen pixels + - \ref kOfxInteractPropPixelScale the scale factor to convert canonical pixels to screen pixels - \ref kOfxInteractPropBackgroundColour the background colour of the application behind the current view - - \ref kOfxPropTime the effect time at which changed occured + - \ref kOfxPropTime the effect time at which changed occurred - \ref kOfxImageEffectPropRenderScale the render scale applied to any image fetched @param outArgs is redundant and is set to NULL @@ -252,7 +252,7 @@ These are the list of actions passed to an interact's entry point function. For \pre - \ref kOfxActionCreateInstance has been called on the instance handle - the openGL context for this interact has been set - - the projection matrix will correspond to the interact's cannonical view + - the projection matrix will correspond to the interact's canonical view @returns - \ref kOfxStatOK the action was trapped and all was well @@ -272,11 +272,11 @@ These are the list of actions passed to an interact's entry point function. For @param handle handle to an interact instance, cast to an \ref OfxInteractHandle @param inArgs has the following properties on an image effect plugin - \ref kOfxPropEffectInstance a handle to the effect for which the interact has been, - - \ref kOfxInteractPropPixelScale the scale factor to convert cannonical pixels to screen pixels + - \ref kOfxInteractPropPixelScale the scale factor to convert canonical pixels to screen pixels - \ref kOfxInteractPropBackgroundColour the background colour of the application behind the current view - - \ref kOfxPropTime the effect time at which changed occured + - \ref kOfxPropTime the effect time at which changed occurred - \ref kOfxImageEffectPropRenderScale the render scale applied to any image fetched - - \ref kOfxInteractPropPenPosition postion of the pen in, + - \ref kOfxInteractPropPenPosition position of the pen in, - \ref kOfxInteractPropPenViewportPosition position of the pen in, - \ref kOfxInteractPropPenPressure the pressure of the pen, @@ -309,9 +309,9 @@ These are the list of actions passed to an interact's entry point function. For @param handle handle to an interact instance, cast to an \ref OfxInteractHandle @param inArgs has the following properties on an image effect plugin, - \ref kOfxPropEffectInstance a handle to the effect for which the interact has been, - - \ref kOfxInteractPropPixelScale the scale factor to convert cannonical pixels to screen pixels + - \ref kOfxInteractPropPixelScale the scale factor to convert canonical pixels to screen pixels - \ref kOfxInteractPropBackgroundColour the background colour of the application behind the current view - - \ref kOfxPropTime the effect time at which changed occured + - \ref kOfxPropTime the effect time at which changed occurred - \ref kOfxImageEffectPropRenderScale the render scale applied to any image fetched - \ref kOfxInteractPropPenPosition position of the pen in - \ref kOfxInteractPropPenViewportPosition position of the pen in @@ -346,9 +346,9 @@ These are the list of actions passed to an interact's entry point function. For @param handle handle to an interact instance, cast to an \ref OfxInteractHandle @param inArgs has the following properties on an image effect plugin, - \ref kOfxPropEffectInstance a handle to the effect for which the interact has been, - - \ref kOfxInteractPropPixelScale the scale factor to convert cannonical pixels to screen pixels + - \ref kOfxInteractPropPixelScale the scale factor to convert canonical pixels to screen pixels - \ref kOfxInteractPropBackgroundColour the background colour of the application behind the current view - - \ref kOfxPropTime the effect time at which changed occured + - \ref kOfxPropTime the effect time at which changed occurred - \ref kOfxImageEffectPropRenderScale the render scale applied to any image fetched - \ref kOfxInteractPropPenPosition position of the pen in - \ref kOfxInteractPropPenViewportPosition position of the pen in @@ -385,7 +385,7 @@ These are the list of actions passed to an interact's entry point function. For this may not have a UTF8 representation (eg: a return key) - \ref kOfxPropKeyString UTF8 string representing a character key that was pressed, some keys have no UTF8 encoding, in which case this is "" - - \ref kOfxPropTime the effect time at which changed occured + - \ref kOfxPropTime the effect time at which changed occurred - \ref kOfxImageEffectPropRenderScale the render scale applied to any image fetched @param outArgs is redundant and is set to NULL @@ -418,7 +418,7 @@ These are the list of actions passed to an interact's entry point function. For this may not have a UTF8 representation (eg: a return key) - \ref kOfxPropKeyString UTF8 string representing a character key that was pressed, some keys have no UTF8 encoding, in which case this is "" - - \ref kOfxPropTime the effect time at which changed occured + - \ref kOfxPropTime the effect time at which changed occurred - \ref kOfxImageEffectPropRenderScale the render scale applied to any image fetched @param outArgs is redundant and is set to NULL @@ -451,7 +451,7 @@ These are the list of actions passed to an interact's entry point function. For this may not have a UTF8 representation (eg: a return key) - \ref kOfxPropKeyString UTF8 string representing a character key that was pressed, some keys have no UTF8 encoding, in which case this is "" - - \ref kOfxPropTime the effect time at which changed occured + - \ref kOfxPropTime the effect time at which changed occurred - \ref kOfxImageEffectPropRenderScale the render scale applied to any image fetched @param outArgs is redundant and is set to NULL @@ -480,9 +480,9 @@ These are the list of actions passed to an interact's entry point function. For @param handle handle to an interact instance, cast to an \ref OfxInteractHandle @param inArgs has the following properties on an image effect plugin - \ref kOfxPropEffectInstance a handle to the effect for which the interact is being used on, - - \ref kOfxInteractPropPixelScale the scale factor to convert cannonical pixels to screen pixels, + - \ref kOfxInteractPropPixelScale the scale factor to convert canonical pixels to screen pixels, - \ref kOfxInteractPropBackgroundColour the background colour of the application behind the current view - - \ref kOfxPropTime the effect time at which changed occured + - \ref kOfxPropTime the effect time at which changed occurred - \ref kOfxImageEffectPropRenderScale the render scale applied to any image fetched @param outArgs is redundant and is set to NULL @@ -505,9 +505,9 @@ These are the list of actions passed to an interact's entry point function. For @param handle handle to an interact instance, cast to an \ref OfxInteractHandle @param inArgs has the following properties on an image effect plugin - \ref kOfxPropEffectInstance a handle to the effect for which the interact is being used on, - - \ref kOfxInteractPropPixelScale the scale factor to convert cannonical pixels to screen pixels, + - \ref kOfxInteractPropPixelScale the scale factor to convert canonical pixels to screen pixels, - \ref kOfxInteractPropBackgroundColour the background colour of the application behind the current view - - \ref kOfxPropTime the effect time at which changed occured + - \ref kOfxPropTime the effect time at which changed occurred - \ref kOfxImageEffectPropRenderScale the render scale applied to any image fetched @param outArgs is redundant and is set to NULL diff --git a/include/ofxKeySyms.h b/include/ofxKeySyms.h index 01397f6a..9ef59dbb 100644 --- a/include/ofxKeySyms.h +++ b/include/ofxKeySyms.h @@ -19,7 +19,7 @@ This property represents a raw key press, it does not represent the 'character value' of the key. This property is associated with a ::kOfxPropKeyString property, which encodes the UTF8 -value for the keypress/button press. Some keys (for example arrow keys) have no UTF8 equivalant. +value for the keypress/button press. Some keys (for example arrow keys) have no UTF8 equivalent. Some keys, especially on non-english language systems, may have a UTF8 value, but \em not a keysym values, in these cases, the keysym will have a value of kOfxKey_Unknown, but the ::kOfxPropKeyString property will still be set with @@ -36,8 +36,8 @@ the UTF8 value. This property represents the UTF8 encode value of a single key press by a user in an OFX interact. -This property is associated with a ::kOfxPropKeySym which represents an integer value for the key press. Some keys (for example arrow keys) have no UTF8 equivalant, -in which case this is set to the empty string "", and the associate ::kOfxPropKeySym is set to the equivilant raw key press. +This property is associated with a ::kOfxPropKeySym which represents an integer value for the key press. Some keys (for example arrow keys) have no UTF8 equivalent, +in which case this is set to the empty string "", and the associate ::kOfxPropKeySym is set to the equivalent raw key press. Some keys, especially on non-english language systems, may have a UTF8 value, but \em not a keysym values, in these cases, the keysym will have a value of kOfxKey_Unknown, but the ::kOfxPropKeyString property will still be set with @@ -240,7 +240,7 @@ where the key has a UTF8 value which is not supported by the symbols below. /* - * Auxilliary Functions; note the duplicate definitions for left and right + * Auxiliary Functions; note the duplicate definitions for left and right * function keys; Sun keyboards and a few other manufactures have such * function key groups on the left and/or right sides of the keyboard. * We've not found a keyboard with more than 35 function keys total. diff --git a/include/ofxMemory.h b/include/ofxMemory.h index efc30f80..88e3ae8a 100644 --- a/include/ofxMemory.h +++ b/include/ofxMemory.h @@ -17,20 +17,20 @@ Use this suite for ordinary memory management functions, where you would normall For images, you should use the memory allocation functions in the image effect suite, as many hosts have specific image memory pools. -\note C++ plugin developers will need to redefine new and delete as skins ontop of this suite. +\note C++ plugin developers will need to redefine new and delete as skins on top of this suite. */ typedef struct OfxMemorySuiteV1 { /** @brief Allocate memory. - \arg \c handle - effect instance to assosciate with this memory allocation, or NULL. + \arg \c handle - effect instance to associate with this memory allocation, or NULL. \arg \c nBytes number of bytes to allocate - \arg \c allocatedData pointer to the return value. Allocated memory will be alligned for any use. + \arg \c allocatedData pointer to the return value. Allocated memory will be aligned for any use. This function has the host allocate memory using its own memory resources and returns that to the plugin. @returns - - ::kOfxStatOK the memory was sucessfully allocated + - ::kOfxStatOK the memory was successfully allocated - ::kOfxStatErrMemory the request could not be met and no memory was allocated */ @@ -45,7 +45,7 @@ typedef struct OfxMemorySuiteV1 { This function frees any memory that was previously allocated via OfxMemorySuiteV1::memoryAlloc. @returns - - ::kOfxStatOK the memory was sucessfully freed + - ::kOfxStatOK the memory was successfully freed - ::kOfxStatErrBadHandle \e allocatedData was not a valid pointer returned by OfxMemorySuiteV1::memoryAlloc */ diff --git a/include/ofxMessage.h b/include/ofxMessage.h index 67232162..ff61a622 100644 --- a/include/ofxMessage.h +++ b/include/ofxMessage.h @@ -72,7 +72,7 @@ typedef struct OfxMessageSuiteV1 { \arg \c ... printf style varargs list to print \returns - - ::kOfxStatOK - if the message was sucessfully posted + - ::kOfxStatOK - if the message was successfully posted - ::kOfxStatReplyYes - if the message was of type kOfxMessageQuestion and the user reply yes - ::kOfxStatReplyNo - if the message was of type kOfxMessageQuestion and the user reply no - ::kOfxStatFailed - if the message could not be posted for some reason @@ -104,7 +104,7 @@ typedef struct OfxMessageSuiteV2 { \arg \c ... printf style varargs list to print \returns - - ::kOfxStatOK - if the message was sucessfully posted + - ::kOfxStatOK - if the message was successfully posted - ::kOfxStatReplyYes - if the message was of type kOfxMessageQuestion and the user reply yes - ::kOfxStatReplyNo - if the message was of type kOfxMessageQuestion and the user reply no - ::kOfxStatFailed - if the message could not be posted for some reason @@ -127,13 +127,13 @@ typedef struct OfxMessageSuiteV2 { \arg \c ... printf style varargs list to print \returns - - ::kOfxStatOK - if the message was sucessfully posted + - ::kOfxStatOK - if the message was successfully posted - ::kOfxStatErrBadHandle - the handle was rubbish - ::kOfxStatFailed - if the message could not be posted for some reason Persistent messages are associated with an effect handle until explicitly cleared by an effect. So if an error message is posted the error state, and associated message will persist and be displayed on the effect appropriately. (eg: draw a node in red on a node based compostor and display the message when clicked on). - If \e messageType is error or warning, associated error states should be flagged on host applications. Posting an error message implies that the host cannot proceeed, a warning allows the host to proceed, whilst a simple message should have no stop anything. + If \e messageType is error or warning, associated error states should be flagged on host applications. Posting an error message implies that the host cannot proceed, a warning allows the host to proceed, whilst a simple message should have no stop anything. */ OfxStatus (*setPersistentMessage)(void *handle, const char *messageType, @@ -148,7 +148,7 @@ typedef struct OfxMessageSuiteV2 { \arg \c handle effect handle (descriptor or instance) \returns - - ::kOfxStatOK - if the message was sucessfully cleared + - ::kOfxStatOK - if the message was successfully cleared - ::kOfxStatErrBadHandle - the handle was rubbish - ::kOfxStatFailed - if the message could not be cleared for some reason diff --git a/include/ofxMultiThread.h b/include/ofxMultiThread.h index baed346f..e58fcc41 100644 --- a/include/ofxMultiThread.h +++ b/include/ofxMultiThread.h @@ -41,7 +41,7 @@ typedef struct OfxMultiThreadSuiteV1 { \arg \c func function to call in each thread. \arg \c nThreads number of threads to launch - \arg \c customArg paramter to pass to customArg of func in each thread. + \arg \c customArg parameter to pass to customArg of func in each thread. This function will spawn nThreads separate threads of computation (typically one per CPU) to allow something to perform symmetric multi processing. Each thread will call 'func' passing @@ -51,12 +51,12 @@ typedef struct OfxMultiThreadSuiteV1 { how it waits for all the threads to return (busy wait, blocking, whatever). \e nThreads can be more than the value returned by multiThreadNumCPUs, however the threads will - be limitted to the number of CPUs returned by multiThreadNumCPUs. + be limited to the number of CPUs returned by multiThreadNumCPUs. This function cannot be called recursively. @returns - - ::kOfxStatOK, the function func has executed and returned sucessfully + - ::kOfxStatOK, the function func has executed and returned successfully - ::kOfxStatFailed, the threading function failed to launch - ::kOfxStatErrExists, failed in an attempt to call multiThread recursively, @@ -104,7 +104,7 @@ typedef struct OfxMultiThreadSuiteV1 { \arg \c mutex where the new handle is returned \arg \c count initial lock count on the mutex. This can be negative. - Creates a new mutex with lockCount locks on the mutex intially set. + Creates a new mutex with lockCount locks on the mutex initially set. @returns - kOfxStatOK - mutex is now valid and ready to go @@ -113,7 +113,7 @@ typedef struct OfxMultiThreadSuiteV1 { /** @brief Destroy a mutex - Destroys a mutex intially created by mutexCreate. + Destroys a mutex initially created by mutexCreate. @returns - kOfxStatOK - if it destroyed the mutex @@ -123,9 +123,9 @@ typedef struct OfxMultiThreadSuiteV1 { /** @brief Blocking lock on the mutex - This trys to lock a mutex and blocks the thread it is in until the lock suceeds. + This tries to lock a mutex and blocks the thread it is in until the lock succeeds. - A sucessful lock causes the mutex's lock count to be increased by one and to block any other calls to lock the mutex until it is unlocked. + A successful lock causes the mutex's lock count to be increased by one and to block any other calls to lock the mutex until it is unlocked. @returns - kOfxStatOK - if it got the lock @@ -147,7 +147,7 @@ typedef struct OfxMultiThreadSuiteV1 { This attempts to lock a mutex, if it cannot, it returns and says so, rather than blocking. - A sucessful lock causes the mutex's lock count to be increased by one, if the lock did not suceed, the call returns immediately and the lock count remains unchanged. + A successful lock causes the mutex's lock count to be increased by one, if the lock did not succeed, the call returns immediately and the lock count remains unchanged. @returns - kOfxStatOK - if it got the lock diff --git a/include/ofxOld.h b/include/ofxOld.h index c1f5968b..38fc2d1c 100644 --- a/include/ofxOld.h +++ b/include/ofxOld.h @@ -98,7 +98,7 @@ V1.4: Removed */ #define kOfxParamDoubleTypeNormalisedXY "OfxParamDoubleTypeNormalisedXY" -/** @brief value for the ::kOfxParamPropDoubleType property, indicating normalisation to the X and Y dimension for a 2D param that can be interpretted as an absolute spatial position. See \ref ::kOfxParamPropDoubleType. +/** @brief value for the ::kOfxParamPropDoubleType property, indicating normalisation to the X and Y dimension for a 2D param that can be interpreted as an absolute spatial position. See \ref ::kOfxParamPropDoubleType. -- ofxParam.h @deprecated - V1.3: Deprecated in favour of ::kOfxParamDoubleTypeXYAbsolute V1.4: Removed diff --git a/include/ofxParam.h b/include/ofxParam.h index af834e0f..6e0afb8d 100644 --- a/include/ofxParam.h +++ b/include/ofxParam.h @@ -158,7 +158,7 @@ Hosts that do not support paged parameter layout should set this to zero. */ #define kOfxParamHostPropMaxPages "OfxParamHostPropMaxPages" -/** @brief This indicates the number of parameter rows and coloumns on a page. +/** @brief This indicates the number of parameter rows and columns on a page. - Type - int X 2 - Property Set - host descriptor (read only) @@ -331,7 +331,7 @@ This is used to tell the host whether the value of the parameter is important an */ #define kOfxParamPropPersistant "OfxParamPropPersistant" -/** @brief Flags whether changing a parameter's value forces an evalution (ie: render), +/** @brief Flags whether changing a parameter's value forces an evaluation (ie: render), - Type - int x 1 - Property Set - plugin parameter descriptor (read/write) and instance (read/write only) @@ -403,11 +403,11 @@ rendered output. Think of the what happens when you add a new key frame. /** @brief The default value of a parameter. - - Type - The type is dependant on the parameter type as is the dimension. + - Type - The type is dependent on the parameter type as is the dimension. - Property Set - plugin parameter descriptor (read/write) and instance (read/write only), - Default - 0 cast to the relevant type (or "" for strings and custom parameters) -The exact type and dimension is dependant on the type of the parameter. These are.... +The exact type and dimension is dependent on the type of the parameter. These are.... - ::kOfxParamTypeInteger - integer property of one dimension - ::kOfxParamTypeDouble - double property of one dimension - ::kOfxParamTypeBoolean - integer property of one dimension @@ -435,8 +435,8 @@ The exact type and dimension is dependant on the type of the parameter. These ar - Property Set - 1D, 2D and 3D float plugin parameter descriptor (read/write) and instance (read only), - Valid Values -This must be one of - ::kOfxParamDoubleTypePlain - parameter has no special interpretation, - - ::kOfxParamDoubleTypeAngle - parameter is to be interpretted as an angle, - - ::kOfxParamDoubleTypeScale - parameter is to be interpretted as a scale factor, + - ::kOfxParamDoubleTypeAngle - parameter is to be interpreted as an angle, + - ::kOfxParamDoubleTypeScale - parameter is to be interpreted as a scale factor, - ::kOfxParamDoubleTypeTime - parameter represents a time value (1D only), - ::kOfxParamDoubleTypeAbsoluteTime - parameter represents an absolute time value (1D only), @@ -452,7 +452,7 @@ as to the interface of the parameter. */ #define kOfxParamPropDoubleType "OfxParamPropDoubleType" -/** @brief value for the ::kOfxParamPropDoubleType property, indicating the parameter has no special interpretation and should be interpretted as a raw numeric value. */ +/** @brief value for the ::kOfxParamPropDoubleType property, indicating the parameter has no special interpretation and should be interpreted as a raw numeric value. */ #define kOfxParamDoubleTypePlain "OfxParamDoubleTypePlain" /** @brief value for the ::kOfxParamPropDoubleType property, indicating the parameter is to be interpreted as a scale factor. See \ref ::kOfxParamPropDoubleType. */ @@ -727,7 +727,7 @@ Setting this will also reset :;kOfxParamPropDisplayMax. - Property Set - plugin parameter descriptor (read/write) and instance (read/write), - Default - the smallest possible value corresponding to the parameter type (eg: INT_MIN for an integer, -DBL_MAX for a double parameter) -If a user interface represents a parameter with a slider or similar, this should be the minumum bound on that slider. +If a user interface represents a parameter with a slider or similar, this should be the minimum bound on that slider. */ #define kOfxParamPropDisplayMin "OfxParamPropDisplayMin" @@ -881,7 +881,7 @@ This property indicates how far between the two ::kOfxParamPropCustomValue keys \arg \c instance the plugin instance that this parameter occurs in \arg \c inArgs handle holding the following properties... - kOfxPropName - the name of the custom parameter to interpolate - - kOfxPropTime - absolute time the interpolation is ocurring at + - kOfxPropTime - absolute time the interpolation is occurring at - kOfxParamPropCustomValue - string property that gives the value of the two keyframes to interpolate, in this case 2D - kOfxParamPropInterpolationTime - 2D double property that gives the time of the two keyframes we are interpolating - kOfxParamPropInterpolationAmount - 1D double property indicating how much to interpolate between the two keyframes @@ -938,7 +938,7 @@ typedef struct OfxParameterSuiteV1 { \arg \c param pointer to a param handle, the value is returned here \arg \c propertySet if not null, a pointer to the parameter's property set will be placed here. - Parameter handles retrieved from an instance are always distinct in each instance. The paramter handle is valid for the life-time of the instance. Parameter handles in instances are distinct from paramter handles in plugins. You cannot call this in a plugin's describe function, as it needs an instance to work on. + Parameter handles retrieved from an instance are always distinct in each instance. The parameter handle is valid for the life-time of the instance. Parameter handles in instances are distinct from parameter handles in plugins. You cannot call this in a plugin's describe function, as it needs an instance to work on. @returns - ::kOfxStatOK - the parameter was found and returned @@ -959,7 +959,7 @@ typedef struct OfxParameterSuiteV1 { @returns - ::kOfxStatOK - the property set was found and returned - - ::kOfxStatErrBadHandle - if the paramter handle was invalid + - ::kOfxStatErrBadHandle - if the parameter handle was invalid - ::kOfxStatErrUnknown - if the type is unknown */ OfxStatus (*paramSetGetPropertySet)(OfxParamSetHandle paramSet, @@ -974,7 +974,7 @@ typedef struct OfxParameterSuiteV1 { @returns - ::kOfxStatOK - the property set was found and returned - - ::kOfxStatErrBadHandle - if the paramter handle was invalid + - ::kOfxStatErrBadHandle - if the parameter handle was invalid - ::kOfxStatErrUnknown - if the type is unknown */ OfxStatus (*paramGetPropertySet)(OfxParamHandle param, @@ -1200,7 +1200,7 @@ changes a keyframe. The keyframe indices will not change within a single action /** @brief Deletes all keyframes from a parameter. \arg \c paramHandle parameter handle to delete the keys from - \arg \c name parameter to delete the keyframes frome is + \arg \c name parameter to delete the keyframes from is V1.3: This function can be called the ::kOfxActionInstanceChanged action and during image effect analysis render passes. V1.4: This function can be called the ::kOfxActionInstanceChanged action diff --git a/include/ofxParametricParam.h b/include/ofxParametricParam.h index 2d52fdd0..f0dfd0ec 100644 --- a/include/ofxParametricParam.h +++ b/include/ofxParametricParam.h @@ -61,7 +61,7 @@ This indicates the dimension of the parametric param. - Property Set - parametric param descriptor (read/write) and instance (read only) - default - unset, - Value Values - three values for each dimension (see ::kOfxParamPropParametricDimension) - being interpretted as R, G and B of the colour for each curve drawn in the UI. + being interpreted as R, G and B of the colour for each curve drawn in the UI. This sets the colour of a parametric param curve drawn a host user interface. A colour triple is needed for each dimension of the oparametric param. @@ -150,7 +150,7 @@ typedef struct OfxParametricParameterSuiteV1 { @returns - ::kOfxStatOK - all was fine - - ::kOfxStatErrBadHandle - if the paramter handle was invalid + - ::kOfxStatErrBadHandle - if the parameter handle was invalid - ::kOfxStatErrBadIndex - the curve index was invalid */ OfxStatus (*parametricParamGetValue)(OfxParamHandle param, @@ -169,7 +169,7 @@ typedef struct OfxParametricParameterSuiteV1 { @returns - ::kOfxStatOK - all was fine - - ::kOfxStatErrBadHandle - if the paramter handle was invalid + - ::kOfxStatErrBadHandle - if the parameter handle was invalid - ::kOfxStatErrBadIndex - the curve index was invalid */ OfxStatus (*parametricParamGetNControlPoints)(OfxParamHandle param, @@ -188,7 +188,7 @@ typedef struct OfxParametricParameterSuiteV1 { @returns - ::kOfxStatOK - all was fine - - ::kOfxStatErrBadHandle - if the paramter handle was invalid + - ::kOfxStatErrBadHandle - if the parameter handle was invalid - ::kOfxStatErrUnknown - if the type is unknown */ OfxStatus (*parametricParamGetNthControlPoint)(OfxParamHandle param, @@ -213,7 +213,7 @@ typedef struct OfxParametricParameterSuiteV1 { @returns - ::kOfxStatOK - all was fine - - ::kOfxStatErrBadHandle - if the paramter handle was invalid + - ::kOfxStatErrBadHandle - if the parameter handle was invalid - ::kOfxStatErrUnknown - if the type is unknown This modifies an existing control point. Note that by changing key, the order of the @@ -242,7 +242,7 @@ typedef struct OfxParametricParameterSuiteV1 { @returns - ::kOfxStatOK - all was fine - - ::kOfxStatErrBadHandle - if the paramter handle was invalid + - ::kOfxStatErrBadHandle - if the parameter handle was invalid - ::kOfxStatErrUnknown - if the type is unknown This will add a new control point to the given dimension of a parametric parameter. If a key exists diff --git a/include/ofxProperty.h b/include/ofxProperty.h index 086adb54..bc5c55fd 100644 --- a/include/ofxProperty.h +++ b/include/ofxProperty.h @@ -89,7 +89,7 @@ typedef struct OfxPropertySuiteV1 { \arg \c properties handle of the thing holding the property \arg \c property string labelling the property - \arg \c count number of values we are setting in that property (ie: indicies 0..count-1) + \arg \c count number of values we are setting in that property (ie: indices 0..count-1) \arg \c value pointer to an array of property values @returns @@ -105,7 +105,7 @@ typedef struct OfxPropertySuiteV1 { \arg \c properties handle of the thing holding the property \arg \c property string labelling the property - \arg \c count number of values we are setting in that property (ie: indicies 0..count-1) + \arg \c count number of values we are setting in that property (ie: indices 0..count-1) \arg \c value pointer to an array of property values @returns @@ -121,7 +121,7 @@ typedef struct OfxPropertySuiteV1 { \arg \c properties handle of the thing holding the property \arg \c property string labelling the property - \arg \c count number of values we are setting in that property (ie: indicies 0..count-1) + \arg \c count number of values we are setting in that property (ie: indices 0..count-1) \arg \c value pointer to an array of property values @returns @@ -138,7 +138,7 @@ typedef struct OfxPropertySuiteV1 { \arg \c properties handle of the thing holding the property \arg \c property string labelling the property - \arg \c count number of values we are setting in that property (ie: indicies 0..count-1) + \arg \c count number of values we are setting in that property (ie: indices 0..count-1) \arg \c value pointer to an array of property values @returns @@ -217,7 +217,7 @@ typedef struct OfxPropertySuiteV1 { \arg \c properties handle of the thing holding the property \arg \c property string labelling the property - \arg \c count number of values we are getting of that property (ie: indicies 0..count-1) + \arg \c count number of values we are getting of that property (ie: indices 0..count-1) \arg \c value pointer to an array of where we will return the property values @returns @@ -232,7 +232,7 @@ typedef struct OfxPropertySuiteV1 { \arg \c properties handle of the thing holding the property \arg \c property string labelling the property - \arg \c count number of values we are getting of that property (ie: indicies 0..count-1) + \arg \c count number of values we are getting of that property (ie: indices 0..count-1) \arg \c value pointer to an array of where we will return the property values See the note \ref ArchitectureStrings for how to deal with strings. @@ -249,7 +249,7 @@ typedef struct OfxPropertySuiteV1 { \arg \c properties handle of the thing holding the property \arg \c property string labelling the property - \arg \c count number of values we are getting of that property (ie: indicies 0..count-1) + \arg \c count number of values we are getting of that property (ie: indices 0..count-1) \arg \c value pointer to an array of where we will return the property values @returns @@ -264,7 +264,7 @@ typedef struct OfxPropertySuiteV1 { \arg \c properties handle of the thing holding the property \arg \c property string labelling the property - \arg \c count number of values we are getting of that property (ie: indicies 0..count-1) + \arg \c count number of values we are getting of that property (ie: indices 0..count-1) \arg \c value pointer to an array of where we will return the property values @returns diff --git a/include/ofxTimeLine.h b/include/ofxTimeLine.h index 654eae6e..2920e0db 100644 --- a/include/ofxTimeLine.h +++ b/include/ofxTimeLine.h @@ -23,7 +23,7 @@ typedef struct OfxTimeLineSuiteV1 { This function returns the current time value of the timeline associated with the effect instance. @returns - - ::kOfxStatOK - the time enquiry was sucessful + - ::kOfxStatOK - the time enquiry was successful - ::kOfxStatFailed - the enquiry failed for some host specific reason - ::kOfxStatErrBadHandle - the effect handle was invalid */ @@ -39,7 +39,7 @@ typedef struct OfxTimeLineSuiteV1 { if the output of the effect is being viewed). @returns - - ::kOfxStatOK - the time was changed sucessfully, will all side effects if the change completed + - ::kOfxStatOK - the time was changed successfully, will all side effects if the change completed - ::kOfxStatFailed - the change failed for some host specific reason - ::kOfxStatErrBadHandle - the effect handle was invalid - ::kOfxStatErrValue - the time was an illegal value @@ -55,7 +55,7 @@ typedef struct OfxTimeLineSuiteV1 { This function @returns - - ::kOfxStatOK - the time enquiry was sucessful + - ::kOfxStatOK - the time enquiry was successful - ::kOfxStatFailed - the enquiry failed for some host specific reason - ::kOfxStatErrBadHandle - the effect handle was invalid */ diff --git a/scripts/genOCIOConfig b/scripts/genOCIOConfig index 16eb831a..94ac67ec 100755 --- a/scripts/genOCIOConfig +++ b/scripts/genOCIOConfig @@ -3,7 +3,7 @@ # Copyright OpenFX and contributors to the OpenFX project. # SPDX-License-Identifier: BSD-3-Clause -# Create an OCIO config equivalant to OpenFX Native colour management +# Create an OCIO config equivalent to OpenFX Native colour management # Example invocation: # scripts/genOCIOConfig > include/openfx-native-1.5.ocio From df9c6c82de1af6196f32c6162953691108468a3d Mon Sep 17 00:00:00 2001 From: Gary Oberbrunner Date: Wed, 23 Jul 2025 09:25:13 -0400 Subject: [PATCH 5/6] Remove stray references to old OFX Association AKA the Open Effects Association. Signed-off-by: Gary Oberbrunner --- Support/include/ofxsProcessing.h | 32 ++------------------------------ include/DocSrc/footer.html | 4 ---- release-notes.md | 2 +- 3 files changed, 3 insertions(+), 35 deletions(-) diff --git a/Support/include/ofxsProcessing.h b/Support/include/ofxsProcessing.h index 1e56f9f8..68b400a6 100644 --- a/Support/include/ofxsProcessing.h +++ b/Support/include/ofxsProcessing.h @@ -3,37 +3,9 @@ /* OFX Support Library, a library that skins the OFX plug-in API with C++ classes. - Copyright (C) 2005 The Open Effects Association Ltd + Copyright OpenFX and contributors to the OpenFX project. + SPDX-License-Identifier: BSD-3-Clause Author Bruno Nicoletti bruno@thefoundry.co.uk - -Redistribution and use in source and binary forms, with or without -modification, are permitted provided that the following conditions are met: - - * Redistributions of source code must retain the above copyright notice, - this list of conditions and the following disclaimer. - * Redistributions in binary form must reproduce the above copyright notice, - this list of conditions and the following disclaimer in the documentation - and/or other materials provided with the distribution. - * Neither the name The Open Effects Association Ltd, nor the names of its - contributors may be used to endorse or promote products derived from this - software without specific prior written permission. - -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND -ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED -WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE -DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR -ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES -(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; -LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON -ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT -(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS -SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - -The Open Effects Association Ltd -1 Wardour St -London W1D 6PA -England - */ #include diff --git a/include/DocSrc/footer.html b/include/DocSrc/footer.html index 06385dfc..9fecd63b 100644 --- a/include/DocSrc/footer.html +++ b/include/DocSrc/footer.html @@ -8,10 +8,6 @@
  1. Redistributions of the document must retain the above copyright notice and this list of conditions.
    2. -
  2. Neither the name of The Open Effects Association Ltd nor names of its - contributors may be used to - endorse or promote products derived from this software without specific - prior written permission.
Automatic documentation generated by Doxygen.
diff --git a/release-notes.md b/release-notes.md index c9f59243..d6a2de84 100644 --- a/release-notes.md +++ b/release-notes.md @@ -4,7 +4,7 @@ This is the latest release of OFX, the Open Effects image-processing plug-in sta Documentation and more info can be found at: -* [The OFX Association website](http://openeffects.org) +* [The OpenFX website](http://openeffects.org) * [OFX Programming Guide By Example](https://github.com/ofxa/openfx/tree/master/Guide) * [OFX API v. 1.4 Reference](http://openeffects.org/documentation/api_doc) * [OFX API Programming Guide](http://openeffects.org/documentation/guide) From a67a271f738ed5829ad5bd3571bcd63517220643 Mon Sep 17 00:00:00 2001 From: Gary Oberbrunner Date: Fri, 25 Jul 2025 15:33:46 -0400 Subject: [PATCH 6/6] Update doc footer per #205 Also update the doc build script to use `uv` if present. That's nicer because you don't have to manually create a python venv or install depencies. Removed old unused footer, and marked ofx-header and ofx-footer as unused. Signed-off-by: Gary Oberbrunner --- Documentation/build.sh | 29 ++++++++++++------- Documentation/genPropertiesReference.py | 2 +- .../Reference/ofxPropertiesReference.rst | 14 ++------- Documentation/sources/conf.py | 5 ++-- include/DocSrc/footer.html | 13 --------- include/DocSrc/ofx_footer.html | 1 + include/DocSrc/ofx_header.html | 1 + include/ofx.doxy | 4 +-- 8 files changed, 29 insertions(+), 40 deletions(-) delete mode 100644 include/DocSrc/footer.html diff --git a/Documentation/build.sh b/Documentation/build.sh index 9c05d371..08740692 100755 --- a/Documentation/build.sh +++ b/Documentation/build.sh @@ -22,37 +22,44 @@ if [ ! -f genPropertiesReference.py ] ; then exit 1 fi -if ! command -v sphinx-build > /dev/null 2>&1 ; then - echo "Python can't import required modules; did you set up the prereqs?" - echo "Check the README.md." - exit 1 +if command -v uvx > /dev/null 2>&1; then + USE_UV=1 + SPHINX_BUILD="uv run --with-requirements pipreq.txt sphinx-build" + UV_RUN="uv run" +else + USE_UV= + SPHINX_BUILD="sphinx-build" + UV_RUN="" fi rm -rf build # Generate references EXPECTED_ERRS="unable to resolve reference|explicit link request|found in multiple" -python genPropertiesReference.py \ +$UV_RUN python genPropertiesReference.py \ -i ../include -o sources/Reference/ofxPropertiesReference.rst -r \ > /tmp/ofx-doc-build.out 2>&1 -egrep -v "$EXPECTED_ERRS" /tmp/ofx-doc-build.out || true +grep -v -E "$EXPECTED_ERRS" /tmp/ofx-doc-build.out || true # Build the Doxygen docs EXPECTED_ERRS="malformed hyperlink target|Duplicate explicit|Definition list ends|unable to resolve|could not be resolved" cd ../include doxygen ofx.doxy > /tmp/ofx-doc-build.out 2>&1 -egrep -v "$EXPECTED_ERRS" /tmp/ofx-doc-build.out || true +grep -v -E "$EXPECTED_ERRS" /tmp/ofx-doc-build.out || true cd - # Use breathe.apidoc to collect the Doxygen API docs rm -rf sources/Reference/api -python -m breathe.apidoc -p 'ofx_reference' -m --force -g class,interface,struct,union,file,namespace,group -o sources/Reference/api doxygen_build/xml - +if [[ $USE_UV ]]; then + $UV_RUN --with breathe python -m breathe.apidoc -p 'ofx_reference' -m --force -g class,interface,struct,union,file,namespace,group -o sources/Reference/api doxygen_build/xml +else + python -m breathe.apidoc -p 'ofx_reference' -m --force -g class,interface,struct,union,file,namespace,group -o sources/Reference/api doxygen_build/xml +fi # Build the Sphinx docs EXPECTED_ERRS='Explicit markup ends without|Duplicate C.*declaration|Declaration is|cpp:func targets a member|undefined label' -sphinx-build -b html sources build > /tmp/ofx-doc-build.out 2>&1 -egrep -v "$EXPECTED_ERRS" /tmp/ofx-doc-build.out || true +$SPHINX_BUILD -b html sources build > /tmp/ofx-doc-build.out 2>&1 +grep -v -E "$EXPECTED_ERRS" /tmp/ofx-doc-build.out || true echo "Documentation build complete." echo "Open file:///$PWD/build/index.html in your browser" diff --git a/Documentation/genPropertiesReference.py b/Documentation/genPropertiesReference.py index 01075e10..7c1dce05 100755 --- a/Documentation/genPropertiesReference.py +++ b/Documentation/genPropertiesReference.py @@ -1,6 +1,6 @@ # SPDX-License-Identifier: BSD-3-Clause -import os,sys, getopt,re +import os,sys,getopt badlyNamedProperties = ["kOfxImageEffectFrameVarying", "kOfxImageEffectPluginRenderThreadSafety"] diff --git a/Documentation/sources/Reference/ofxPropertiesReference.rst b/Documentation/sources/Reference/ofxPropertiesReference.rst index c3ce86cd..cbd93af1 100644 --- a/Documentation/sources/Reference/ofxPropertiesReference.rst +++ b/Documentation/sources/Reference/ofxPropertiesReference.rst @@ -47,17 +47,7 @@ Properties Reference .. doxygendefine:: kOfxImageEffectPropColourManagementAvailableConfigs -.. doxygendefine:: kOfxImageEffectColourManagementBasic - -.. doxygendefine:: kOfxImageEffectColourManagementConfig - -.. doxygendefine:: kOfxImageEffectColourManagementCore - -.. doxygendefine:: kOfxImageEffectColourManagementFull - -.. doxygendefine:: kOfxImageEffectColourManagementNone - -.. doxygendefine:: kOfxImageEffectColourManagementOCIO +.. doxygendefine:: kOfxImageEffectPropColourManagementConfig .. doxygendefine:: kOfxImageEffectPropColourManagementStyle @@ -93,6 +83,8 @@ Properties Reference .. doxygendefine:: kOfxImageEffectPropMetalRenderSupported +.. doxygendefine:: kOfxImageEffectPropNoSpatialAwareness + .. doxygendefine:: kOfxImageEffectPropOCIOConfig .. doxygendefine:: kOfxImageEffectPropOCIODisplay diff --git a/Documentation/sources/conf.py b/Documentation/sources/conf.py index d37a4004..93cce72c 100755 --- a/Documentation/sources/conf.py +++ b/Documentation/sources/conf.py @@ -11,9 +11,10 @@ import subprocess, os, shutil project = 'OpenFX' -copyright = '2024, Contributors to the OpenFX Project' +copyright = '''2025, OpenFX a Series of LF Projects, LLC. +For web site terms of use, trademark policy and other project policies please see https://lfprojects.org/''' author = 'Contributors to the OpenFX Project' -release = '1.4' +release = '1.5' read_the_docs_build = os.environ.get('READTHEDOCS', None) == 'True' # -- General configuration --------------------------------------------------- diff --git a/include/DocSrc/footer.html b/include/DocSrc/footer.html deleted file mode 100644 index 9fecd63b..00000000 --- a/include/DocSrc/footer.html +++ /dev/null @@ -1,13 +0,0 @@ -
- -Copyright OpenFX and contributors to the OpenFX project. -SPDX-License-Identifier: BSD-3-Clause - -Copying and redistribution with or without -modification, is permitted provided that the following conditions are met: -
    -
  1. Redistributions of the document must retain the above copyright notice - and this list of conditions.
    2. -
-Automatic documentation generated by Doxygen.
- diff --git a/include/DocSrc/ofx_footer.html b/include/DocSrc/ofx_footer.html index f86524fa..b1ef766f 100644 --- a/include/DocSrc/ofx_footer.html +++ b/include/DocSrc/ofx_footer.html @@ -1,4 +1,5 @@ +