Skip to content

Commit 1f2278a

Browse files
committed
Add release notes for upcoming 1.5.1 release
Signed-off-by: Gary Oberbrunner <[email protected]>
1 parent 2c1390d commit 1f2278a

File tree

1 file changed

+36
-2
lines changed

1 file changed

+36
-2
lines changed

release-notes.md

Lines changed: 36 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,48 @@ This is version 1.6 of the OpenFX API.
1919

2020
## Fixes in OpenFX Version 1.6:
2121

22+
## Deprecations
23+
24+
## Detailed List of Changes
25+
26+
# Release Notes - 1.5.1
27+
28+
This is version 1.5.1 of the OpenFX API, a minor release with bug fixes and improvements.
29+
30+
## Key Features of OpenFX Version 1.5.1:
31+
32+
- **CPU Render Support**: Added `kOfxImageEffectPropCPURenderSupported` property to allow plugins to declare CPU rendering capability.
33+
- **Thumbnail Rendering**: Added `kOfxImageEffectPropThumbnailRender` property to support efficient thumbnail generation.
34+
- **Spatial Awareness**: Added `kOfxImageEffectPropNoSpatialAwareness`. Allows the host and plugin to coordinate a render that ensures no spatial changes to the image.
35+
36+
37+
## Fixes in OpenFX Version 1.5.1:
38+
39+
- Fix LICENSE.md to conform to Github template for BSD 3-Clause (issue #194).
40+
- Use predefined `_WIN32` macro everywhere instead of defining `WINDOWS`, improving Windows portability.
41+
- Fix CI build problems with conan version, expat dependency, and compiler compatibility.
42+
- Restore older CentOS 7 builds for vfx-2021 & 2022 compatibility.
2243
- Clarify that Image Effect Hosts property `kOfxPropType` must have the value
2344
`kOfxTypeImageEffectHost`, and fix host support lib to implement that.
2445

46+
## Documentation Improvements
47+
48+
- Significantly cleaned up documentation for Interacts, including DrawSuite and Overlay Interacts interaction.
49+
- Fixed documentation for `clipGetRegionOfDefinition`.
50+
- Updated colourspace example for more complete coverage.
51+
- Fixed numerous typos throughout Documentation, include/, Support/, and HostSupport directories (via codespell).
52+
- Corrected copyright notice with explanation in CONTRIBUTING.md (addresses issues #110, #206).
53+
- Updated documentation footer and build script to support `uv` package manager.
54+
- Removed stray references to old OFX Association.
55+
2556
## Deprecations
2657

58+
None
59+
2760
## Detailed List of Changes
2861

29-
- Add `kOfxImageEffectPropNoSpatialAwareness`. Allows the host and plugin to coordinate a render that ensures no spatial changes to the image.
62+
- Add `kOfxImageEffectPropCPURenderSupported` (issue #212) - Property to indicate CPU rendering support.
63+
- Add `kOfxImageEffectPropThumbnailRender` (issue #193) - Property for thumbnail rendering mode.
3064

3165
# Release Notes - 1.5
3266

@@ -104,7 +138,7 @@ ofxParam.h:
104138
* removed - kOfxParamDoubleTypeNormalisedXYAbsolute
105139
* modified - kOfxParamPropInteractMinimumSize is now a double (matches kOfxParamPropInteractSize)
106140
* modified - changed comments with regards to OfxParameterSuiteV1 (i.e. no Analysis action anymore)
107-
* refined - paramGetValue, paramSetValue: precision about when it's safe to use - i.e. Instance Changed domain only)
141+
* refined - paramGetValue, paramSetValue: precision about when it's safe to use - i.e. Instance Changed domain only
108142

109143
ofxPixels.h:
110144

0 commit comments

Comments
 (0)