[−][src]Struct ofx_sys::OfxTimeLineSuiteV1

#[repr(C)]

pub struct OfxTimeLineSuiteV1 {
    pub getTime: Option<unsafe extern "C" fn(instance: *mut c_void, time: *mut f64) -> OfxStatus>,
    pub gotoTime: Option<unsafe extern "C" fn(instance: *mut c_void, time: f64) -> OfxStatus>,
    pub getTimeBounds: Option<unsafe extern "C" fn(instance: *mut c_void, firstTime: *mut f64, lastTime: *mut f64) -> OfxStatus>,
}

@brief Suite to control timelines

This suite is used to enquire and control a timeline associated with a plug-in instance.

This is an optional suite in the Image Effect API.

Fields

getTime: Option<unsafe extern "C" fn(instance: *mut c_void, time: *mut f64) -> OfxStatus>

@brief Get the time value of the timeline that is controlling to the indicated effect.

\arg instance - is the instance of the effect changing the timeline, cast to a void * \arg time - a pointer through which the timeline value should be returned

This function returns the current time value of the timeline associated with the effect instance.

@returns

  • ::kOfxStatOK - the time enquiry was sucessful
  • ::kOfxStatFailed - the enquiry failed for some host specific reason
  • ::kOfxStatErrBadHandle - the effect handle was invalid
gotoTime: Option<unsafe extern "C" fn(instance: *mut c_void, time: f64) -> OfxStatus>

@brief Move the timeline control to the indicated time.

\arg instance - is the instance of the effect changing the timeline, cast to a void * \arg time - is the time to change the timeline to. This is in the temporal coordinate system of the effect.

This function moves the timeline to the indicated frame and returns. Any side effects of the timeline change are also triggered and completed before this returns (for example instance changed actions and renders if the output of the effect is being viewed).

@returns

  • ::kOfxStatOK - the time was changed sucessfully, will all side effects if the change completed
  • ::kOfxStatFailed - the change failed for some host specific reason
  • ::kOfxStatErrBadHandle - the effect handle was invalid
  • ::kOfxStatErrValue - the time was an illegal value
getTimeBounds: Option<unsafe extern "C" fn(instance: *mut c_void, firstTime: *mut f64, lastTime: *mut f64) -> OfxStatus>

@brief Get the current bounds on a timeline

\arg instance - is the instance of the effect changing the timeline, cast to a void * \arg firstTime - is the first time on the timeline. This is in the temporal coordinate system of the effect. \arg lastTime - is last time on the timeline. This is in the temporal coordinate system of the effect.

This function

@returns

  • ::kOfxStatOK - the time enquiry was sucessful
  • ::kOfxStatFailed - the enquiry failed for some host specific reason
  • ::kOfxStatErrBadHandle - the effect handle was invalid

Trait Implementations

impl Clone for OfxTimeLineSuiteV1[src]

fn clone_from(&mut self, source: &Self)
1.0.0
[src]

Performs copy-assignment from source. Read more

impl Copy for OfxTimeLineSuiteV1[src]

impl Debug for OfxTimeLineSuiteV1[src]

Auto Trait Implementations

Blanket Implementations

impl<T, U> Into for T where
    U: From<T>, [src]

impl<T> ToOwned for T where
    T: Clone, [src]

type Owned = T

impl<T> From for T[src]

impl<T, U> TryFrom for T where
    U: Into<T>, [src]

type Error = !

🔬 This is a nightly-only experimental API. (try_from)

The type returned in the event of a conversion error.

impl<T> Borrow for T where
    T: ?Sized, [src]

impl<T, U> TryInto for T where
    U: TryFrom<T>, [src]

type Error = <U as TryFrom<T>>::Error

🔬 This is a nightly-only experimental API. (try_from)

The type returned in the event of a conversion error.

impl<T> Any for T where
    T: 'static + ?Sized, [src]

impl<T> BorrowMut for T where
    T: ?Sized, [src]