Always use a hyphen in realtime-safe
This commit is contained in:
parent
b8593b03f4
commit
417a810936
|
@ -21,7 +21,7 @@ pub(crate) use self::windows::WindowsEventLoop as OsEventLoop;
|
|||
pub(crate) const TASK_QUEUE_CAPACITY: usize = 512;
|
||||
|
||||
/// A trait describing the functionality of the platform-specific event loop that can execute tasks
|
||||
/// of type `T` in executor `E`. Posting a task to the internal task queue should be realtime safe.
|
||||
/// of type `T` in executor `E`. Posting a task to the internal task queue should be realtime-safe.
|
||||
/// This event loop should be created during the wrapper's initial initialization on the main
|
||||
/// thread.
|
||||
///
|
||||
|
|
|
@ -48,7 +48,7 @@
|
|||
//! 4. The [`Plugin::reset()`][prelude::Plugin::reset()] function is always called immediately
|
||||
//! after `initialize()`. This is where you should clear out coefficients, envelopes, phases,
|
||||
//! and other runtime data. The reason for this split is that this function may be called at
|
||||
//! any time by the host from the audio thread, and it thus needs to be realtime safe.
|
||||
//! any time by the host from the audio thread, and it thus needs to be realtime-safe.
|
||||
//!
|
||||
//! Whenever a preset is loaded, both of these functions will be called again.
|
||||
//! 5. After that the [`Plugin::process()`][prelude::Plugin::process()] function will be called
|
||||
|
|
|
@ -264,7 +264,7 @@ pub struct Wrapper<P: ClapPlugin> {
|
|||
}
|
||||
|
||||
/// Tasks that can be sent from the plugin to be executed on the main thread in a non-blocking
|
||||
/// realtime safe way. Instead of using a random thread or the OS' event loop like in the Linux
|
||||
/// realtime-safe way. Instead of using a random thread or the OS' event loop like in the Linux
|
||||
/// implementation, this uses [`clap_host::request_callback()`] instead.
|
||||
#[derive(Debug)]
|
||||
pub enum Task {
|
||||
|
@ -2244,7 +2244,7 @@ impl<P: ClapPlugin> Wrapper<P> {
|
|||
let bus_config = wrapper.current_bus_config.load();
|
||||
let buffer_config = wrapper.current_buffer_config.load().unwrap();
|
||||
let mut plugin = wrapper.plugin.write();
|
||||
// FIXME: This is obviously not realtime safe, but loading presets without doing
|
||||
// FIXME: This is obviously not realtime-safe, but loading presets without doing
|
||||
// this could lead to inconsistencies. It's the plugin's responsibility to
|
||||
// not perform any realtime-unsafe work when the initialize function is
|
||||
// called a second time if it supports runtime preset loading.
|
||||
|
|
|
@ -456,7 +456,7 @@ impl<P: Plugin, B: Backend> Wrapper<P, B> {
|
|||
|
||||
self.notify_param_values_changed();
|
||||
|
||||
// FIXME: This is obviously not realtime safe, but loading presets without
|
||||
// FIXME: This is obviously not realtime-safe, but loading presets without
|
||||
// doing this could lead to inconsistencies. It's the plugin's
|
||||
// responsibility to not perform any realtime-unsafe work when the
|
||||
// initialize function is called a second time if it supports
|
||||
|
|
|
@ -145,7 +145,7 @@ pub(crate) struct WrapperInner<P: Vst3Plugin> {
|
|||
}
|
||||
|
||||
/// Tasks that can be sent from the plugin to be executed on the main thread in a non-blocking
|
||||
/// realtime safe way (either a random thread or `IRunLoop` on Linux, the OS' message loop on
|
||||
/// realtime-safe way (either a random thread or `IRunLoop` on Linux, the OS' message loop on
|
||||
/// Windows and macOS).
|
||||
#[derive(Debug, Clone)]
|
||||
pub enum Task {
|
||||
|
|
|
@ -1785,7 +1785,7 @@ impl<P: Vst3Plugin> IAudioProcessor for Wrapper<P> {
|
|||
let bus_config = self.inner.current_bus_config.load();
|
||||
let buffer_config = self.inner.current_buffer_config.load().unwrap();
|
||||
let mut plugin = self.inner.plugin.write();
|
||||
// FIXME: This is obviously not realtime safe, but loading presets without doing
|
||||
// FIXME: This is obviously not realtime-safe, but loading presets without doing
|
||||
// this could lead to inconsistencies. It's the plugin's responsibility to
|
||||
// not perform any realtime-unsafe work when the initialize function is
|
||||
// called a second time if it supports runtime preset loading.
|
||||
|
|
Loading…
Reference in a new issue