OfxImageEffectSuiteV1::abort
Prev   Image Effect Suite   Next

Name

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

Synopsis

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

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. Generally this is done in interactive threads in response to users tweaking some parameter.

This function indicates whether a plugin should stop whatever processing it is doing.

Returns

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

Prev   Up   Next
OfxImageEffectSuiteV1::clipGetRegionOfDefinition   Home   OfxImageEffectSuiteV1::imageMemoryAlloc