commit c3bf5ecada36bd49f599f20aba63182522ea04cf parent 780967a3c8865913e510d970e3922172de8b0075 Author: Patrick Desaulniers <desaulniers.patrick@carrefour.cegepvicto.ca> Date: Sat, 6 Apr 2019 10:29:45 -0400 Document DISTRHO_PLUGIN_WANT_FULL_STATE (#135) * Document DISTRHO_PLUGIN_WANT_FULL_STATE * Tweak DISTRHO_PLUGIN_WANT_FULL_STATE summary Diffstat:
| M | distrho/DistrhoInfo.hpp | | | 10 | ++++++++++ |
1 file changed, 10 insertions(+), 0 deletions(-)
diff --git a/distrho/DistrhoInfo.hpp b/distrho/DistrhoInfo.hpp @@ -544,6 +544,16 @@ START_NAMESPACE_DISTRHO #define DISTRHO_PLUGIN_WANT_STATE 1 /** + Wherever the plugin implements the full state API. + When this macro is enabled, the plugin must implement a new getState(const char* key) function, which the host calls when saving its session/project. + This is useful for plugins that have custom internal values not exposed to the host as key-value state pairs or parameters. + Most simple effects and synths will not need this. + @note this macro is automatically enabled if a plugin has programs and state, as the key-value state pairs need to be updated when the current program changes. + @see Plugin::getState(const char*) + */ +#define DISTRHO_PLUGIN_WANT_FULL_STATE 1 + +/** Wherever the plugin wants time position information from the host. @see Plugin::getTimePosition() */