The Sync Private Data Action
Prev   Chapter 13. Actions Passed to An Image Effect   Next

The Sync Private Data Action 

	#include "ofxCore.h"
	#define kOfxActionSyncPrivateData                 "OfxActionSyncPrivateData"
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 action is called when a plugin should synchronise any private data structures to its parameter set. This generally occurs when an effect is about to be saved or copied, but it could occur in other situations as well.

Preconditions

  • kOfxActionCreateInstance has been called on the instance handle,

Postconditions

  • any private state data can be reconstructed from the parameter set,

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 Purge Caches Action  Home  The Generic Begin Instance Edit Action