Name

OfxImageEffectSuiteV1::abort — Returns whether to abort processing or not.

Synopsis

#include "ofxImageEffect.h" 
int(*abort)(OfxImageEffectHandleimageEffect);
 

Arguments

  • imageEffect - instance of the image effect

Description

A host may want to signal to a plugin that it should stop whatever rendering it is doing and start again.

Returns

  • 0 if the effect should continue whatever processing it is doing
  • 1 if the effect should abort whatever processing it is doing