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

The Generic End Instance Edit Action 

	#include "ofxCore.h"
	#define kOfxActionEndInstanceEdit "OfxActionEndInstanceEdit"
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 the last user interface on an instance closed. It is there so that effects can destroy private user interface structures when necassary. Note that some hosts can have multiple editors open on the same effect instance simulateously, this will only be called when the last of those editors are closed.

Preconditions

  • kOfxActionBeginInstanceEdit has been called on the instance handle,

Postconditions

  • no user interface is open 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 Generic Begin Instance Edit Action  Home  The Describe In Context Action