commit 5ab3e115ab7aa981794c8710053be4fdd249730c
parent dcbb317103ca9b5cb77238123523f920d40d8559
Author: Alexandre BIQUE <bique.alexandre@gmail.com>
Date: Tue, 30 Nov 2021 15:08:54 +0100
Add a comment to insist on using value_to_text()
Diffstat:
1 file changed, 2 insertions(+), 0 deletions(-)
diff --git a/include/clap/ext/params.h b/include/clap/ext/params.h
@@ -166,6 +166,8 @@ typedef struct clap_plugin_params {
bool (*get_value)(const clap_plugin *plugin, clap_id param_id, double *value);
// Formats the display text for the given parameter value.
+ // The host should always format the parameter value to text using this function
+ // before displaying it to the user.
// [main-thread]
bool (*value_to_text)(
const clap_plugin *plugin, clap_id param_id, double value, char *display, uint32_t size);