Name

OfxProgressSuiteV1::progressUpdate — Indicate how much of the processing task has been completed and reports on any abort status.

Synopsis

#include "ofxProgress.h" 
OfxStatus(*progressUpdate)(void *effectInstance,
 doubleprogress);
 

Arguments

  • effectInstance - the instance of the plugin this progress bar is associated with. It cannot be NULL.
  • progress - a number between 0.0 and 1.0 indicating what proportion of the current task has been processed.

Description

\returns

  • kOfxStatOK - the progress object was successfully updated and the task should continue
  • kOfxStatReplyNo - the progress object was successfully updated and the task should abort
  • kOfxStatErrBadHandle - the progress handle was invalid,