Skip to content
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

ofxImageEffect.h - Desired Premult #62

Closed
wants to merge 3 commits into from
Closed

ofxImageEffect.h - Desired Premult #62

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1e472a7
ofxImageEffect.h - Desired Premult
revisionfx Oct 20, 2019
9ff8b1e
Desired Premult
revisionfx May 5, 2020
f34a72e
Update ofxImageEffect.h
revisionfx May 5, 2020
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
14 changes: 9 additions & 5 deletions include/ofxImageEffect.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
/*
Software License :

Copyright (c) 2003-2019, The Open Effects Association Ltd. All rights reserved.
Copyright (c) 2003-2020, The Open Effects Association Ltd. All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
Expand Down Expand Up @@ -980,6 +980,7 @@ This is the actual value of the component depth, before any mapping by clip pref
- kOfxImageUnPreMultiplied - the image is unpremultiplied

See the documentation on clip preferences for more details on how this is used with the ::kOfxImageEffectActionGetClipPreferences action.
version 1.5 and over: See kOfxImageEffectHostDesiredPremult and how it interacts with this property.
*/
#define kOfxImageEffectPropPreMultiplication "OfxImageEffectPropPreMultiplication"

Expand All @@ -993,17 +994,20 @@ See the documentation on clip preferences for more details on how this is used w
#define kOfxImageUnPreMultiplied "OfxImageAlphaUnPremultiplied"

/** @brief Indicates whether an effect should premultiply or not on output.
This provides clarification for generators or effect where input is kOfxImageOpaque.
Added in version 1.5: This provides clarification for generators or effect where input is kOfxImageOpaque.

- Type - string X 1
- Property Set - a plugin instance (read only)
- Default - 0
- Property Set - a plugin instance (read only). Ideally this information should already be available at parameter creation stage.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we should add comments like "Ideally". Just "should" or "must". Who would be helped by this change?

Valid Values - This must be one of

- kOfxImagePreMultiplied - the image is premultiplied by its alpha
- kOfxImageUnPreMultiplied - the image is unpremultiplied

This Property defines an host level policy.
This Property defines an host level policy. It is for practical purposes considered global in the scope of a Project.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When you say "It is for practical purposes considered global" are you really saying that a host should (or must) not change its value? If so, do you mean it must be constant per plugin instance, constant for all instances of a given plugin, or what? And why? Why couldn't a host pass different values to different instances?


Recommended Interpretation: If an host adds support for OfxImageEffectHostDesiredPremult, the host should set on the output the same value on output clip kOfxImageEffectPropPreMultiplication preference
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This needs some grammar work.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:) - upping the standard now

Also should not say Recommended but Expected here I guess

::kOfxImageEffectActionGetClipPreference. A plugin that does not touch the alpha channel can reset output to kOfxImageOpaque when input was that or the effect fills completely the alpha channel.
This guarantees that the host knows that the kOfxImageOpaque property is reliable.
*/

#define kOfxImageEffectHostDesiredPremult "OfxImageEffectHostDesiredPremult"
Expand Down