pub struct PluginContext { /* private fields */ }
Expand description

This represents the context which is needed to access REAPER functions from plug-ins.

Once obtained, it is supposed to be passed to Reaper::load().

Implementations

Creates a plug-in context from an extension entry point plug-in info.

It requires a module handle and the pointer to a reaper_plugin_info_t struct. REAPER provides both when calling the ReaperPluginEntry function (the main entry point for any extension plug-in).

It’s recommended to use the reaper_extension_plugin macro in the reaper-macros crate instead of calling this function directly.

Errors

Returns an error if the given plug-in info is not suitable for loading REAPER functions.

Safety

REAPER can crash if you pass an invalid pointer.

Creates a plug-in context from a VST host callback.

It requires the host callback which vst-rs passes to the plugin’s new() function.

Errors

Returns an error if the given host callback is not suitable for loading REAPER functions.

Returns a generic API function by its name.

Safety

REAPER can crash if you pass an invalid pointer.

On Windows, this returns the HINSTANCE passed to DllMain (VST plug-ins) or ReaperPluginEntry (extension plug-ins).

The returned HINSTANCE represents the handle of the module (DLL) containing the plug-in.

On Linux, this returns null.

On Linux, this returns a pointer to a function for getting a generic SWELL API function by its name.

On Windows, this returns None.

Returns the type-specific plug-in context.

Returns whether we are currently in the main thread.

Trait Implementations

Returns a copy of the value. Read more
Performs copy-assignment from source. Read more
Formats the value using the given formatter. Read more
This method tests for self and other values to be equal, and is used by ==. Read more
This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason. Read more

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more
Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait. Read more
Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait. Read more
Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s. Read more
Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s. Read more
Compare self to key and return true if they are equal.

Returns the argument unchanged.

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Calls U::from(self).

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

The resulting type after obtaining ownership.
Creates owned data from borrowed data, usually by cloning. Read more
Uses borrowed data to replace owned data, usually by cloning. Read more
The type returned in the event of a conversion error.
Performs the conversion.
The type returned in the event of a conversion error.
Performs the conversion.
Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more