[][src]Type Definition ofx_sys::OfxPluginEntryPoint

type OfxPluginEntryPoint = Option<unsafe extern "C" fn(action: *const c_char, handle: *const c_void, inArgs: OfxPropertySetHandle, outArgs: OfxPropertySetHandle) -> OfxStatus>;

@brief Entry point for plug-ins

\arg \e action - ASCII c string indicating which action to take \arg \e instance - object to which action should be applied, this will need to be cast to the appropriate blind data type depending on the \e action \arg \e inData - handle that contains action specific properties \arg \e outData - handle where the plug-in should set various action specific properties

This is how the host generally communicates with a plug-in. Entry points are used to pass messages to various objects used within OFX. The main use is within the OfxPlugin struct.

The exact set of actions is determined by the plug-in API that is being implemented, however all plug-ins can perform several actions. For the list of actions consult \ref ActionsAll.