Browse Source

Improve comment/doc around getPluginFormatName

Signed-off-by: falkTX <falktx@falktx.com>
pull/452/head
falkTX 1 year ago
parent
commit
ba985c6578
Signed by: falkTX <falktx@falktx.com> GPG Key ID: CDBAA37ABC74FBA0
1 changed files with 5 additions and 3 deletions
  1. +5
    -3
      distrho/DistrhoPluginUtils.hpp

+ 5
- 3
distrho/DistrhoPluginUtils.hpp View File

@@ -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;


Loading…
Cancel
Save