Skip to content

Add a Unique Identifier property to ImageEffect instances #204

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add a Unique Identifier property to ImageEffect instances #204

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
271cd8a
add kOfxImageEffectPropUniqueIdentifier
gregcotten Jun 18, 2025
abc6a01
Add kOfxImageEffectPropUniqueIdentifier to release notes
gregcotten Jun 18, 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
13 changes: 13 additions & 0 deletions include/ofxImageEffect.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -589,6 +589,19 @@ This value will be the same for all instances of a plugin.
*/
#define kOfxImageEffectPropPluginHandle "OfxImageEffectPropPluginHandle"

/** @brief Uniquely identifies a plugin instance.
- Type - ASCII string X 1
- Property Set - plugin instance (read only)
This is host set and allows a plugin to differentiate between instances of itself just as a host's end user would.
This can be useful for seeding a random number generator without requiring end user intervention.
The host should make sure that this value is peristent across sessions and that the value is truly unique.
*/
#define kOfxImageEffectPropUniqueIdentifier "OfxImageEffectPropUniqueIdentifier"

/** @brief Indicates if a host is a background render.
- Type - int X 1
Expand Down
1 change: 1 addition & 0 deletions release-notes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ This is version 1.6 of the OpenFX API.
## Detailed List of Changes

- Add `kOfxImageEffectPropNoSpatialAwareness`. Allows the host and plugin to coordinate a render that ensures no spatial changes to the image.
- Add `kOfxImageEffectPropUniqueIdentifier`. Allows the plugin to differentiate its instances (e.g. for stably seeding a random number generator per-instance).

# Release Notes - 1.5

Expand Down
Loading