openfx icon indicating copy to clipboard operation
openfx copied to clipboard

kOfxTypeImageEffectHost is defined to the wrong string value

Open scritturamista opened this issue 8 months ago • 4 comments

Problem

On this page:

https://openfx.readthedocs.io/en/latest/Reference/ofxPropertiesByObject.html

It mentions, for Image Effect Host:

kOfxPropType - (read only) set to “host”

But if you look inside ofxImageEffect.h, you’ll see something else:

/** @brief Used as a value for ::kOfxPropType on image effect host handles */
#define kOfxTypeImageEffectHost “OfxTypeImageEffectHost"

…and of course, if you query kOfxPropType on the property set of OfxHost->host, when running in an app (e.g. Resolve 19) you actually get “Host”.

Since it seems that the value likely used by all apps that load OpenFX plugins is "Host", both the documentation and headers should reflect this.

scritturamista avatar May 01 '25 21:05 scritturamista

char *hostName, *hostLabel; mPropHost->propGetString(mHost->host, kOfxPropName, 0, &hostName); WORKS FINE HERE - does report "DaVinciResolve" here This seems to be defect of the C++ wrapper

revisionfx avatar May 02 '25 15:05 revisionfx

@revisionfx -- I believe he is asking about kOfxPropType, not Name.

garyo avatar May 03 '25 13:05 garyo

char *hostName, *hostLabel; mPropHost->propGetString(mHost->host, kOfxPropName, 0, &hostName); WORKS FINE HERE - does report "DaVinciResolve" here This seems to be defect of the C++ wrapper

Gary’s spot on... The small discrepancy I noticed is about the value associated with the kOfxPropType key, when querying the host handle.

scritturamista avatar May 05 '25 12:05 scritturamista

Recommendation: fix support suite & doc to use kOfxTypeImageEffectHost as value for this property on the host. (Silhouette & Filmlight & Scratch are already doing this, but Resolve & others may use the host support lib).

garyo avatar May 06 '25 15:05 garyo