The Generic Begin Instance Edit Action
Prev   Chapter 13. Actions Passed to An Image Effect   Next

The Generic Begin Instance Edit Action 

	#include "ofxCore.h"
	#define kOfxActionBeginInstanceEdit "OfxActionBeginInstanceEdit"
Arguments

  • handle handle to the plug-in instance, cast to an OfxImageEffectHandle
  • inArgs is redundant and is set to NULL,
  • outArgs is redundant and is set to NULL.

Description

This is called when an instance is first actively edited by a user, ie: and interface is open and parameter values and input clips can be modified. It is there so that effects can create private user interface structures when necassary. Note that some hosts can have multiple editors open on the same effect instance simulateously.

Preconditions

  • kOfxActionCreateInstance has been called on the instance handle,

Postconditions

  • kOfxActionEndInstanceEdit will be called when the last editor is closed on the instance

Return Values

  • kOfxStatOK, the action was trapped and all was well
  • kOfxStatReplyDefault, the action was ignored
  • kOfxStatErrFatal,
  • kOfxStatFailed, something went wrong, but no error code appropriate, the plugin should to post a message

Prev   Up   Next
The Sync Private Data Action  Home  The Generic End Instance Edit Action