clap

commit 14251f8f99445e956344c9dbe420582b5bee3b08
parent 650ad6a6b0215b3f964c49a004667ad876689dfd
Author: Russell McClellan <russell.mcclellan@gmail.com>
Date:   Mon,  2 Jan 2023 12:52:53 -0500

Clarify threading rules about `main-thread`

Diffstat:
M
include/clap/ext/thread-check.h
 | 
4
+++-

1 file changed, 3 insertions(+), 1 deletion(-)
diff --git a/include/clap/ext/thread-check.h b/include/clap/ext/thread-check.h
@@ -14,7 +14,9 @@ extern "C" {
 ///
 /// main-thread:
 ///    This is the thread in which most of the interaction between the plugin and host happens.
-///    It is usually the thread on which the GUI receives its events.
+///    This will be the same OS thread throughout the lifetime of the plug-in.
+///    On macOS and Windows, this must be the thread on which gui and timer events are received
+///    (i.e., the main thread of the program).
 ///    It isn't a realtime thread, yet this thread needs to respond fast enough to user interaction,
 ///    so it is recommended to run long and expensive tasks such as preset indexing or asset loading
 ///    in dedicated background threads.