From 50933423a50878962144baa36d8589559ab31a21 Mon Sep 17 00:00:00 2001 From: luzpaz Date: Sun, 24 Aug 2025 13:46:16 +0000 Subject: [PATCH] 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 67baa1e6c..21872abad 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 ecd8464c4..d1180b03a 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 8e4e0d194..50f290860 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 45fada146..4d3c48602 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 ed46b2a47..ccf1e6b00 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 7daf7bdb7..5479ddb20 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 2ae787c21..fd139fcc9 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 9d8b0da32..83ce9d066 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 b92cc7d93..c0a1fafd4 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 9474db150..59f113dd5 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 9ede6917f..1cf901dc2 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 3f9ed452d..5ccb30aa7 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 31c8a766b..751c7fbb1 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 61fd23a10..96c39f77e 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 8a1b3dba0..c43e42719 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 463083b72..f2a13bed9 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 0b5315221..b669395a4 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 ad238a310..648ba69b6 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 0e0f80301..cdc73fc0c 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 92a8fcccd..e690637dc 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 5aad5f2b5..e5ac6e1f2 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 e287fc990..0cdc5f57f 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 772826efa..0fff10bd9 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 0080af126..7dd644d29 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 3acc6d338..b9f9de1a9 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 01397f6a3..9ef59dbbb 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 efc30f801..88e3ae8ac 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 67232162a..ff61a6223 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 baed346f8..e58fcc41a 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 c1f5968b9..38fc2d1ce 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 af834e0fa..6e0afb8d5 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 2d52fdd0f..f0dfd0ec6 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 086adb54b..bc5c55fd7 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 654eae6e2..2920e0db4 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 16eb831ac..94ac67ecf 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