Skip to content

Commit 8372ab9

Browse files
Conform action
This new action allows plug-ins to conform their parameters to match a project imported from a non-OpenFX host. Signed-off-by: John-Paul Smith <[email protected]>
1 parent fa4a59d commit 8372ab9

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

include/ofxCore.h

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -548,6 +548,33 @@ These are the actions passed to a plug-in's 'main' function
548548
*/
549549
#define kOfxActionEndInstanceEdit "OfxActionEndInstanceEdit"
550550

551+
/** @brief
552+
553+
This is called when the effect has been imported from another host. It
554+
is there so that effects can conform their parameters, accounting for
555+
differences in parameter semantics between hosts. Plug-ins should use
556+
\ref kOfxPropAka to inform hosts if their parameters have different names
557+
in other APIs.
558+
559+
@param handle handle to the plug-in instance, cast to an \ref OfxImageEffectHandle
560+
@param inArgs is redundant and is set to NULL
561+
@param outArgs is redundant and is set to NULL
562+
563+
\pre
564+
- \ref kOfxActionCreateInstance has been called on the instance handle.
565+
566+
\post
567+
- the instance will match the source host as closely as possible.
568+
569+
@returns
570+
- \ref kOfxStatOK, the action was trapped and all was well
571+
- \ref kOfxStatReplyDefault, the action was ignored
572+
- \ref kOfxStatErrFatal,
573+
- \ref kOfxStatFailed, something went wrong, but no error code appropriate,
574+
the plugin should to post a message
575+
*/
576+
#define kOfxActionConform "OfxActionConform"
577+
551578
/*@}*/
552579

553580
/** @brief Returns the 'nth' plug-in implemented inside a binary

0 commit comments

Comments
 (0)