clap

commit 3c6c94d35f199e1b8986181ba024d8ac3fd5d7ff
parent 3d2897302b5d9a57b31034e0b11d2fce208f8deb
Author: Alexandre BIQUE <bique.alexandre@gmail.com>
Date:   Fri, 11 Jun 2021 16:04:14 +0200

Improve comments

Diffstat:
M
include/clap/ext/event-loop.h
 | 
3
+++
M
include/clap/ext/render.h
 | 
3
+++

2 files changed, 6 insertions(+), 0 deletions(-)
diff --git a/include/clap/ext/event-loop.h b/include/clap/ext/event-loop.h
@@ -30,6 +30,9 @@ typedef struct clap_plugin_event_loop {
 } clap_plugin_event_loop;
 
 typedef struct clap_host_event_loop {
+   // Registers a periodic timer.
+   // The host may adjust the period if it is under a certain threshold.
+   // 30 Hz should be allowed.
    // [main-thread]
    bool (*register_timer)(const clap_host *host, uint32_t period_ms, clap_id *timer_id);
 
diff --git a/include/clap/ext/render.h b/include/clap/ext/render.h
@@ -19,6 +19,9 @@ typedef int32_t clap_plugin_render_mode;
 
 // The render extension is used to let the plugin know if it has "realtime"
 // pressure to process.
+//
+// If this information does not influence your rendering code, then don't
+// implement this extension.
 typedef struct clap_plugin_render {
    // [main-thread]
    void (*set_mode)(const clap_plugin *plugin, clap_plugin_render_mode mode);