Struct OfxProgressSuiteV2

struct OfxProgressSuiteV2

Public Members

OfxStatus (*progressStart)(void *effectInstance, const char *message, const char *messageid)

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.

  • message a text label to display in any message portion of the progress object’s user interface. A UTF8 string.

  • messageId plugin-specified id to associate with this message. If overriding the message in an XML resource, the message is identified with this, this may be NULL, or “”, in which case no override will occur. New in V2 of this suite.

Pre:

- There is no currently ongoing progress display for this instance.

Return:

OfxStatus (*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.

Return:

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

OfxStatus (*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.

Post:

- you can no longer call progressUpdate on the instance

Return: