summaryrefslogtreecommitdiffstats
path: root/suil/suil.h
diff options
context:
space:
mode:
Diffstat (limited to 'suil/suil.h')
-rw-r--r--suil/suil.h6
1 files changed, 6 insertions, 0 deletions
diff --git a/suil/suil.h b/suil/suil.h
index 3c3ce19..1ffafcc 100644
--- a/suil/suil.h
+++ b/suil/suil.h
@@ -158,6 +158,12 @@ suil_ui_supported(const char* host_type_uri,
/**
Instantiate a UI for an LV2 plugin.
+
+ This funcion may load a suil module to adapt the UI to the desired toolkit.
+ Suil is configured at compile time to load modules from the appropriate
+ place, but this can be changed at run-time via the environment variable
+ SUIL_MODULE_DIR. This makes it possible to bundle suil with an application.
+
@param host Host descriptor.
@param controller Opaque host controller pointer.
@param container_type_uri URI of the desired host container widget type.