Struct ofx_sys::OfxHost

#[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>,
}

@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

impl Clone for OfxHost

fn clone(&self) -> OfxHost

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for OfxHost

impl Debug for OfxHost

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

Formats the value using the given formatter.