commit 47f1b44f5a3357b07fff2a63155b0393a6c886de
parent 8b7a4521407218b67d50cecff73c49eaeb43a4d4
Author: Dalton Messmer <33463986+messmerd@users.noreply.github.com>
Date: Fri, 3 Nov 2023 00:14:09 -0400
Clarify return values in timer-support.h
Diffstat:
1 file changed, 2 insertions(+), 1 deletion(-)
diff --git a/include/clap/ext/timer-support.h b/include/clap/ext/timer-support.h
@@ -16,10 +16,11 @@ typedef struct clap_plugin_timer_support {
typedef struct clap_host_timer_support {
// Registers a periodic timer.
// The host may adjust the period if it is under a certain threshold.
- // 30 Hz should be allowed.
+ // 30 Hz should be allowed. Returns true on success.
// [main-thread]
bool(CLAP_ABI *register_timer)(const clap_host_t *host, uint32_t period_ms, clap_id *timer_id);
+ // Returns true on success.
// [main-thread]
bool(CLAP_ABI *unregister_timer)(const clap_host_t *host, clap_id timer_id);
} clap_host_timer_support_t;