Struct ofx_sys::OfxProgressSuiteV2

#[repr(C)]
pub struct OfxProgressSuiteV2 {
    pub progressStart: Option<unsafe extern "C" fn(effectInstance: *mut c_void, message: *const c_char, messageid: *const c_char) -> OfxStatus>,
    pub progressUpdate: Option<unsafe extern "C" fn(effectInstance: *mut c_void, progress: f64) -> OfxStatus>,
    pub progressEnd: Option<unsafe extern "C" fn(effectInstance: *mut c_void) -> OfxStatus>,
}

Fields

progressStart: Option<unsafe extern "C" fn(effectInstance: *mut c_void, message: *const c_char, messageid: *const c_char) -> OfxStatus>

@brief Initiate a progress bar display.

Call this to initiate the display of a progress bar.

\arg \e effectInstance - the instance of the plugin this progress bar is associated with. It cannot be NULL. \arg \e message - a text label to display in any message portion of the progress object's user interface. A UTF8 string. \arg \e 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.

\returns

• ::kOfxStatOK - the handle is now valid for use
• ::kOfxStatFailed - the progress object failed for some reason
• ::kOfxStatErrBadHandle - effectInstance was invalid

progressUpdate: Option<unsafe extern "C" fn(effectInstance: *mut c_void, progress: f64) -> OfxStatus>

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

\arg \e effectInstance - the instance of the plugin this progress bar is associated with. It cannot be NULL. \arg \e 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,

progressEnd: Option<unsafe extern "C" fn(effectInstance: *mut c_void) -> OfxStatus>

@brief 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.

\arg \e 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

\returns

• ::kOfxStatOK - the progress object was successfully closed
• ::kOfxStatErrBadHandle - the progress handle was invalid,

Trait Implementations

impl Clone for OfxProgressSuiteV2

fn clone(&self) -> OfxProgressSuiteV2

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for OfxProgressSuiteV2

impl Debug for OfxProgressSuiteV2

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.