commit 8c2f4a0fb0541353d907bc12b366ecc2295d9212 parent a8dc93953692053846e285b08a0fd5e0f119b874 Author: Paul Walker <paul@pwjw.com> Date: Tue, 27 Sep 2022 21:07:05 -0400 Remove a section which we didn't need per micah's comment Diffstat:
| M | include/clap/ext/params.h | | | 22 | ++++++++++++++++------ |
1 file changed, 16 insertions(+), 6 deletions(-)
diff --git a/include/clap/ext/params.h b/include/clap/ext/params.h @@ -158,12 +158,18 @@ typedef struct clap_param_info { // This value is optional and set by the plugin. The host will // set it on all subsequent events regarding this param_id // or set the cookie to nullptr if the host chooses to - // not implement cookies. It is very strongly recommended - // that the host implement cookies and some plugins may ignore - // events which disregard their cookie. + // not implement cookies. // - // Its purpose is to provide a fast access to the plugin parameter - // objects. For instance: + // The plugin must gracefully handle the case of a cookie + // which is nullptr, but can safely assume any cookie + // which is not nullptr is the value it issued. + // + // It is very strongly recommended that the host implement + // cookies. Some plugins may have noticably reduced + // performance when addressing params in hosts without cookies. + // + // The cookie's purpose is to provide a fast access to the + // plugin parameter objects. For instance: // // in clap_plugin_params.get_info // Parameter *p = findParameter(param_id); @@ -178,7 +184,11 @@ typedef struct clap_param_info { // p = -- alternate mechanism -- // // where "alternate mechanism" is a mechanism the plugin implements - // to map parameter ids to internal objects. + // to map parameter ids to internal objects. + // + // The host should make no assumption about the + // value of the cookie other than passing it back to the plugin or + // replacing it with nullptr. // // Once set, the cookie is valid until invalidated by a call to // clap_host_params->rescan(CLAP_PARAM_RESCAN_ALL) or when the plugin is