clap

commit c6a7fa8d5d8308a3eb2c4d0d557053cdc37a0e56
parent af1e05ce6487151c6b36003fdb47566dbb50194e
Author: Paul Walker <paul@pwjw.com>
Date:   Wed, 10 Aug 2022 07:44:22 -0400

Clarify the gui::get_preferred_api const char** argument use

The const char** should be explicitly assigned from one of the
global choices.

Diffstat:
M
include/clap/ext/gui.h
 | 
2
++

1 file changed, 2 insertions(+), 0 deletions(-)
diff --git a/include/clap/ext/gui.h b/include/clap/ext/gui.h
@@ -100,6 +100,8 @@ typedef struct clap_plugin_gui {
 
    // Returns true if the plugin has a preferred api.
    // The host has no obligation to honor the plugin preferrence, this is just a hint.
+   // The const char **api variable should be explicitly assigned as a pointer to
+   // one of the CLAP_WINDOW_API_ constants defined above, not strcopied.
    // [main-thread]
    bool (*get_preferred_api)(const clap_plugin_t *plugin, const char **api, bool *is_floating);