alex/nih-plug
1
0
Fork 0
Code Activity

Clarify task scheduling doc comments

Browse source
This commit is contained in:
Robbert van der Helm 2022-10-23 16:29:30 +02:00
parent 0dd3bfe4e7
commit 3032300bcf
2 changed files with 9 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
src/context/gui.rs
View file

@ -106,9 +106,9 @@ pub struct ParamSetter<'a> {
} }
impl<P: Plugin> AsyncExecutor<P> { impl<P: Plugin> AsyncExecutor<P> {
/// Run a task from a background thread. This allows you to defer expensive tasks for later /// Execute a task on a background thread using `[Plugin::task_executor]`. This allows you to
/// without blocking either the process function or the GUI thread. As long as creating the /// defer expensive tasks for later without blocking either the process function or the GUI
/// `task` is realtime-safe, this operation is too. /// thread. As long as creating the `task` is realtime-safe, this operation is too.
/// ///
/// # Note /// # Note
/// ///
@ -119,7 +119,7 @@ impl<P: Plugin> AsyncExecutor<P> {
(self.execute_background)(task); (self.execute_background)(task);
} }
/// Run a task from the plugin's GUI thread. /// Execute a task on a background thread using `[Plugin::task_executor]`.
/// ///
/// # Note /// # Note
/// ///

10
src/context/process.rs
View file

@ -17,9 +17,9 @@ pub trait ProcessContext<P: Plugin> {
/// Get the current plugin API. /// Get the current plugin API.
fn plugin_api(&self) -> PluginApi; fn plugin_api(&self) -> PluginApi;
/// Run a task from a background thread. This allows you to defer expensive tasks for later /// Execute a task on a background thread using `[Plugin::task_executor]`. This allows you to
/// without blocking either the process function or the GUI thread. As long as creating the /// defer expensive tasks for later without blocking either the process function or the GUI
/// `task` is realtime-safe, this operation is too. /// thread. As long as creating the `task` is realtime-safe, this operation is too.
/// ///
/// # Note /// # Note
/// ///
@ -28,8 +28,8 @@ pub trait ProcessContext<P: Plugin> {
/// your task executor. /// your task executor.
fn execute_background(&self, task: P::BackgroundTask); fn execute_background(&self, task: P::BackgroundTask);
/// Run a task from the plugin's GUI thread. As long as creating the `task` is realtime-safe, /// Execute a task on a background thread using `[Plugin::task_executor]`. As long as creating
/// this operation is too. /// the `task` is realtime-safe, this operation is too.
/// ///
/// # Note /// # Note
/// ///