clap

commit 02fa58b30d404c8f50badcf67c6d910a46bd7db8
parent 7a65a8f2ee1c4acd7ac6e03438761089c6fa9e47
Author: Alexandre Bique <bique.alexandre@gmail.com>
Date:   Fri, 17 Jun 2022 09:27:56 +0200

improve documentation for `clap_host_params->request_flush()`

Diffstat:
M
ChangeLog.md
 | 
1
+
M
include/clap/ext/params.h
 | 
11
++++-------

2 files changed, 5 insertions(+), 7 deletions(-)
diff --git a/ChangeLog.md b/ChangeLog.md
@@ -2,6 +2,7 @@
 
 * Fix an inconsistence in `clap_plugin->destroy()` documentation:
   it is now **required** to deactivate the plugin before destroying it.
+* Improve documentation for `clap_host_params->request_flush()`.
 
 # Changes in 1.0.2
 
diff --git a/include/clap/ext/params.h b/include/clap/ext/params.h
@@ -279,16 +279,13 @@ typedef struct clap_host_params {
    // [main-thread]
    void (*clear)(const clap_host_t *host, clap_id param_id, clap_param_clear_flags flags);
 
-   // Request the host to call clap_plugin_params->fush().
-   // This is useful if the plugin has parameters value changes to report to the host but the plugin
-   // is not processing.
+   // Request a parameter flush.
    //
-   // eg. the plugin has a USB socket to some hardware controllers and receives a parameter change
-   // while it is not processing.
+   // If the plugin is processing, then the parameters flush will happen during the process() call.
+   // If the plugin isn't processing, then the host will call to clap_plugin_params->fush().
    //
    // This must not be called on the [audio-thread].
-   //
-   // [thread-safe]
+   // [thread-safe,!audio-thread]
    void (*request_flush)(const clap_host_t *host);
 } clap_host_params_t;