Skip to content

Add release notes for upcoming 1.5.1 release #225

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 19, 2025
Merged

Add release notes for upcoming 1.5.1 release #225

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1f2278a
Add release notes for upcoming 1.5.1 release
garyo Nov 14, 2025
00bcd20
Address review comments
garyo Nov 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 36 additions & 2 deletions release-notes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,48 @@ This is version 1.6 of the OpenFX API.

## Fixes in OpenFX Version 1.6:

## Deprecations

## Detailed List of Changes

# Release Notes - 1.5.1

This is version 1.5.1 of the OpenFX API, a minor release with bug fixes and improvements.

## Key Features of OpenFX Version 1.5.1:

- **CPU Render Support**: Added `kOfxImageEffectPropCPURenderSupported` property to allow plugins to declare CPU rendering capability.
- **Thumbnail Rendering**: Added `kOfxImageEffectPropThumbnailRender` property to support efficient thumbnail generation.
- **Spatial Awareness**: Added `kOfxImageEffectPropNoSpatialAwareness`. Allows the host and plugin to coordinate a render that ensures no spatial changes to the image.


## Fixes in OpenFX Version 1.5.1:

- Fix LICENSE.md to conform to Github template for BSD 3-Clause (issue #194).
- Use predefined `_WIN32` macro everywhere instead of defining `WINDOWS`, improving Windows portability.
- Fix CI build problems with conan version, expat dependency, and compiler compatibility.
- Restore older CentOS 7 builds for vfx-2021 & 2022 compatibility.
- Clarify that Image Effect Hosts property `kOfxPropType` must have the value
`kOfxTypeImageEffectHost`, and fix host support lib to implement that.

## Documentation Improvements

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

## Deprecations

None

## Detailed List of Changes

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

# Release Notes - 1.5

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

ofxPixels.h:

Expand Down
Loading