OfxHost

Struct OfxHost 

Source
#[repr(C)]
pub struct OfxHost { pub host: OfxPropertySetHandle, pub fetchSuite: Option<unsafe extern "C" fn(host: OfxPropertySetHandle, suiteName: *const c_char, suiteVersion: c_int) -> *const c_void>, }
Expand description

@brief Generic host structure passed to OfxPlugin::setHost function

This structure contains what is needed by a plug-in to bootstrap its connection to the host.

Fields§

§host: OfxPropertySetHandle

@brief Global handle to the host. Extract relevant host properties from this. This pointer will be valid while the binary containing the plug-in is loaded.

§fetchSuite: Option<unsafe extern "C" fn(host: OfxPropertySetHandle, suiteName: *const c_char, suiteVersion: c_int) -> *const c_void>

@brief The function which the plug-in uses to fetch suites from the host.

\arg \e host - the host the suite is being fetched from this \em must be the \e host member of the OfxHost struct containing fetchSuite. \arg \e suiteName - ASCII string labelling the host supplied API \arg \e suiteVersion - version of that suite to fetch

Any API fetched will be valid while the binary containing the plug-in is loaded.

Repeated calls to fetchSuite with the same parameters will return the same pointer.

returns

  • NULL if the API is unknown (either the api or the version requested),
  • pointer to the relevant API if it was found

Trait Implementations§

Source§

impl Clone for OfxHost

Source§

fn clone(&self) -> OfxHost

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for OfxHost

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Copy for OfxHost

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

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

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.