DISTRHO Plugin Framework
Macros
Extra Plugin Macros

Macros

#define DPF_RUNTIME_TESTING
 
#define DPF_VST_SHOW_PARAMETER_OUTPUTS
 
#define DPF_VST3_DONT_USE_BRAND_ID
 
#define DGL_FILE_BROWSER_DISABLED
 
#define DGL_NO_SHARED_RESOURCES
 
#define DGL_USE_OPENGL3
 

Detailed Description

C Macros to customize DPF behaviour.

These are macros that do not set plugin features or information, but instead change DPF internals. They are all optional.

Unless stated otherwise, values are assumed to be a simple/empty define.

Macro Definition Documentation

◆ DPF_RUNTIME_TESTING

#define DPF_RUNTIME_TESTING

Whether to enable runtime plugin tests.
This will check, during initialization of the plugin, if parameters, programs and states are setup properly.
Useful to enable as part of CI, can safely be skipped.
Under DPF makefiles this can be enabled by using make DPF_RUNTIME_TESTING=true.

Note
Some checks are only available with the GCC compiler, for detecting if a virtual function has been reimplemented.

◆ DPF_VST_SHOW_PARAMETER_OUTPUTS

#define DPF_VST_SHOW_PARAMETER_OUTPUTS

Whether to show parameter outputs in the VST2 plugins.
This is disabled (unset) by default, as the VST2 format has no notion of read-only parameters.

◆ DPF_VST3_DONT_USE_BRAND_ID

#define DPF_VST3_DONT_USE_BRAND_ID

Forcibly ignore DISTRHO_PLUGIN_BRAND_ID for VST3 plugins.
This is required for DPF-based VST3 plugins that got released without setting DISTRHO_PLUGIN_BRAND_ID first.

◆ DGL_FILE_BROWSER_DISABLED

#define DGL_FILE_BROWSER_DISABLED

Disable all file browser related code.
Must be set as compiler macro when building DGL. (e.g. CXXFLAGS="-DDGL_FILE_BROWSER_DISABLED")

◆ DGL_NO_SHARED_RESOURCES

#define DGL_NO_SHARED_RESOURCES

Disable resource files, like internally used fonts.
Must be set as compiler macro when building DGL. (e.g. CXXFLAGS="-DDGL_NO_SHARED_RESOURCES")

◆ DGL_USE_OPENGL3

#define DGL_USE_OPENGL3

Whether to use OpenGL3 instead of the default OpenGL2 compatility profile. Under DPF makefiles this can be enabled by using make USE_OPENGL3=true on the dgl build step.

Note
This is experimental and incomplete, contributions are welcome and appreciated.