VCV Rack API v2
Loading...
Searching...
No Matches
callbacks.hpp File Reference
#include <plugin/Plugin.hpp>
Include dependency graph for callbacks.hpp:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions

void init (rack::plugin::Plugin *plugin)
 Called immediately after loading your plugin.
 
void destroy ()
 Called before your plugin library is unloaded.
 
json_t * settingsToJson ()
 Called when saving user settings.
 
void settingsFromJson (json_t *rootJ)
 Called after initializing plugin if user plugin settings property is defined.
 

Function Documentation

◆ init()

void init ( rack::plugin::Plugin * plugin)

Called immediately after loading your plugin.

Use this to save plugin to a global variable and add Models to it. Required in plugins.

◆ destroy()

void destroy ( )

Called before your plugin library is unloaded.

Optional in plugins.

◆ settingsToJson()

json_t * settingsToJson ( )

Called when saving user settings.

Stored in settings["pluginSettings"][pluginSlug]. Useful for persisting plugin-wide settings.

Optional in plugins.

◆ settingsFromJson()

void settingsFromJson ( json_t * rootJ)

Called after initializing plugin if user plugin settings property is defined.

Optional in plugins.