Skip to content

Commit

Permalink
Expand a bit on the difference between init and create
Browse files Browse the repository at this point in the history
This documentation was by create, but it wasn't by init, so make it
clear in both locations.
  • Loading branch information
baconpaul committed Dec 21, 2023
1 parent f52dd86 commit 56fa019
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions include/clap/plugin.h
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,9 @@ typedef struct clap_plugin {
// Must be called after creating the plugin.
// If init returns false, the host must destroy the plugin instance.
// If init returns true, then the plugin is initialized and in the deactivated state.
// Unlike in `plugin-factory::create_plugin`, in init you have complete access to the host
// and host extensions, so clap related setup activities should be done here rather than in
// create_plugin.
// [main-thread]
bool(CLAP_ABI *init)(const struct clap_plugin *plugin);

Expand Down

0 comments on commit 56fa019

Please sign in to comment.