Fix incorrect metadata in documentation comments - #263
Conversation
| - OfxImageEffectPropThumbnailRender | ||
| outArgs: | ||
| - OfxImageEffectPropFrameRange | ||
| # - OfxImageEffectPropFrameRange_ # with clip name |
There was a problem hiding this comment.
In the same way as for OfxImageEffectClipPropRoI_ in kOfxImageEffectActionGetRegionsOfInterest:
https://github.com/umajho/openfx/blob/e82be712c7f7bed3ba3581b42902647ce1c6fe90/include/ofxImageEffect.h#L204
| - OfxParamPropInterpolationAmount | ||
| outArgs: | ||
| - OfxParamPropCustomValue | ||
| - OfxParamPropInterpolationTime |
There was a problem hiding this comment.
IsOfxParamPropInterpolationTime here actually one of the outArgs for OfxCustomParamInterpFuncV1? The documentation doesn't list it as an outArg, and I can't figure out what it would mean as an outArg. (I'm new to OpenFX, so this might just be a gap in my understanding.)
…props.py Signed-off-by: umajho <umajho@proton.me>
Signed-off-by: umajho <umajho@proton.me>
Signed-off-by: umajho <umajho@proton.me>
…lude/*.h
missing entries:
- OfxImageEffectActionRender:
- inArg OfxImageEffectPropFieldToRender
- inArg OfxImageEffectPropRenderWindow
- InArg OfxImageEffectPropRenderScale
- OfxCustomParamInterpFuncV1:
- inArg OfxPropName
- inArg OfxPropTime
wrong representations:
- OfxImageEffectActionGetFramesNeeded:
- OfxImageEffectPropFrameRange_ is currently unrepresentable. It is
commented out in the same way as for OfxImageEffectClipPropRoI_.
duplications:
- OfxImageEffectActionBeginSequenceRender:
- OfxImageEffectPropInteractiveRenderStatus
- OfxImageEffectActionEndSequenceRender:
- OfxImageEffectPropInteractiveRenderStatus
styles:
- OfxActionBeginInstanceChanged:
- `outArgs: []` -> `outArgs:`
Assisted-by: GitHub Copilot / Kimi K3 Max
Signed-off-by: umajho <umajho@proton.me>
|
Should I also add The documentation page Actions Passed to An Image Effect doesn't mention |
umajho
changed the title
| - OfxImageEffectPropRegionOfInterest | ||
| - OfxImageEffectPropThumbnailRender | ||
| outArgs: | ||
| # - OfxImageEffectClipPropRoI_ # with clip name |
There was a problem hiding this comment.
I think the correct name for this might be OfxImageClipPropRoI_ (12 results in the repo) instead of OfxImageEffectClipPropRoI_ (only used here).
1 participant
Hello. While working on a project where I generate code from the C++ bindings (
openfx-cpp/), I found thatOfxImageEffectActionIsIdentity.outArgswas missing inofxPropsBySet.h. This turned out to be because the@actiondefforkOfxImageEffectActionIsIdentitywas missing theoutArgsmetadata (OfxPropNameandOfxPropTime), even though they are listed in the action's documentation.In this PR:
OfxImageEffectPropBehaviourWhenUnlicensedis missing from main, which causesgen-props.pyandgen-props-docto fail. I added the missing metadata in the 1st commit.outArgsentries forOfxImageEffectActionIsIdentitymentioned above in the 2nd commit.include/, and I fixed some issues it identified. These changes are included in the 4th commit.I ran
uv run scripts/gen-props.pyanduv run scripts/gen-props-doc.pybefore submitting this PR, I think these should be enough for the changes I made in this PR…?