Merge branch 'main' into typos-examples

Author: garyo

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"

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"]
 

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

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

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 {

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;

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.

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;

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 {

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) -