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

The Generic Create Instance Action 

	#include "ofxCore.h"
	#define kOfxActionCreateInstance        "OfxActionCreateInstance"
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

The kOfxActionCreateInstance is the first action passed to a plug-in's instance after its creation. It is there to allow a plugin to create any per-instance data structures it may need.

Preconditions

  • kOfxActionDescribe has been called
  • the instance is fully constructed, with all objects requested in the describe actions (eg, parameters and clips) have been constructed and have had their initial values set. This means that if the values are being loaded from an old setup, that load should have taken place before the create instance action is called.

Postconditions

Return Values

  • kOfxStatOK, the action was trapped and all was well
  • kOfxStatReplyDefault, the action was ignored, but all was well anyway
  • kOfxStatErrFatal
  • kOfxStatErrMemory, in which case this may be called again after a memory purge
  • kOfxStatFailed, something went wrong, but no error code appropriate, the plugin should to post a message if possible and the host should destroy the instanace handle and not attempt to proceed further

Prev   Up   Next
The Generic Describe Action  Home  The Generic Destroy Instance Action