TuttleOFX  1
Data Fields
OfxProgressSuiteV1 Struct Reference

A suite that provides progress feedback from a plugin to an application. More...

#include <ofxProgress.h>

Data Fields

OfxStatus(* progressStart )(void *effectInstance, const char *label)
 Initiate a progress bar display.
OfxStatus(* progressUpdate )(void *effectInstance, double progress)
 Indicate how much of the processing task has been completed and reports on any abort status.
OfxStatus(* progressEnd )(void *effectInstance)
 Signal that we are finished with the progress meter.

Detailed Description

A suite that provides progress feedback from a plugin to an application.

A plugin instance can initiate, update and close a progress indicator with this suite.

This is an optional suite in the Image Effect API.

Definition at line 45 of file ofxProgress.h.

Field Documentation

OfxStatus( * OfxProgressSuiteV1::progressEnd)(void *effectInstance)

Signal that we are finished with the progress meter.

Call this when you are done with the progress meter and no longer need it displayed.

  • effectInstance - the instance of the plugin this progress bar is associated with. It cannot be NULL.

- you can no longer call progressUpdate on the instance

Returns:

Definition at line 92 of file ofxProgress.h.

Referenced by OFX::ImageEffect::progressEnd().

OfxStatus( * OfxProgressSuiteV1::progressStart)(void *effectInstance, const char *label)

Initiate a progress bar display.

Call this to initiate the display of a progress bar.

  • effectInstance - the instance of the plugin this progress bar is associated with. It cannot be NULL.
  • label - a text label to display in any message portion of the progress object's user interface. A UTF8 string.
Returns:

Definition at line 62 of file ofxProgress.h.

Referenced by OFX::ImageEffect::progressStart().

OfxStatus( * OfxProgressSuiteV1::progressUpdate)(void *effectInstance, double progress)

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

  • 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.
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,

Definition at line 76 of file ofxProgress.h.

Referenced by OFX::ImageEffect::progressUpdate().

The documentation for this struct was generated from the following file: