clap

commit 2bb057abe3a7e4ce8a8145b7a83317a5649fa7f8
parent 5ee1cea69f251b2bc254ffb3a37f8bb03c8f0bce
Author: Tim Janik <timj@gnu.org>
Date:   Thu, 22 Dec 2022 11:30:18 +0100

INCLUDE: clap/ext/draft/audio-ports-activation.h: disambiguate docs

Clarify that is_active=true *and* is_active=false can be set on the
audio-thread if can_activate_while_processing.

Signed-off-by: Tim Janik <timj@gnu.org>

Diffstat:
M
include/clap/ext/draft/audio-ports-activation.h
 | 
10
+++++-----

1 file changed, 5 insertions(+), 5 deletions(-)
diff --git a/include/clap/ext/draft/audio-ports-activation.h b/include/clap/ext/draft/audio-ports-activation.h
@@ -7,9 +7,9 @@
 /// This extension provides a way for the host to activate and de-activate audio ports.
 /// Deactivating a port provides the following benefits:
 /// - the plugin knows ahead of time that a given input is not present and can choose
-///   an optimized computation path
+///   an optimized computation path,
 /// - the plugin knows that an output is not consumed by the host, and doesn't need to
-///   compute it
+///   compute it.
 ///
 /// Audio ports can only be activated or deactivated when the plugin is deactivated, unless
 /// can_activate_while_processing() returns true.
@@ -39,10 +39,10 @@ typedef struct clap_plugin_audio_ports_activation {
 
    // Activate the given port.
    //
-   // It is only possible to activate on the audio-thread if can_activate_while_processing() returns
-   // true.
+   // It is only possible to activate and de-activate on the audio-thread if
+   // can_activate_while_processing() returns true.
    //
-   // [active ? audio-thread : main-thread]
+   // [can_activate_while_processing ? audio-thread : main-thread]
    void(CLAP_ABI *set_active)(const clap_plugin_t *plugin,
                               bool                 is_input,
                               uint32_t             port_index,