DPF

DISTRHO Plugin Framework
Log | Files | Refs | Submodules | README | LICENSE

commit ba985c6578e55291671685edb7485f04dd0ac9fe
parent 4383c8e4bd1e4df8ff54a5f86c2d071871f08d03
Author: falkTX <falktx@falktx.com>
Date:   Thu, 14 Mar 2024 00:57:56 +0100

Improve comment/doc around getPluginFormatName

Signed-off-by: falkTX <falktx@falktx.com>

Diffstat:
Mdistrho/DistrhoPluginUtils.hpp | 8+++++---
1 file changed, 5 insertions(+), 3 deletions(-)

diff --git a/distrho/DistrhoPluginUtils.hpp b/distrho/DistrhoPluginUtils.hpp @@ -53,13 +53,15 @@ const char* getPluginFormatName() noexcept; Returns a path inside the bundle where the plugin is meant to store its resources in.@n This path varies between systems and plugin formats, like so: + - AU: <bundle>/Contents/Resources + - CLAP+VST2 macOS: <bundle>/Contents/Resources + - CLAP+VST2 non-macOS: <bundle>/resources (see note) - LV2: <bundle>/resources (can be stored anywhere inside the bundle really, DPF just uses this one) - - VST2 macOS: <bundle>/Contents/Resources - - VST2 non-macOS: <bundle>/resources (see note) + - VST3: <bundle>/Contents/Resources The other non-mentioned formats do not support bundles.@n - @note For VST2 on non-macOS systems, this assumes you have your plugin inside a dedicated directory + @note For CLAP and VST2 on non-macOS systems, this assumes you have your plugin inside a dedicated directory rather than only shipping with the binary (e.g. <myplugin.vst>/myplugin.dll) */ const char* getResourcePath(const char* bundlePath) noexcept;