diff --git a/DistrhoPlugin_8hpp_source.html b/DistrhoPlugin_8hpp_source.html index 0acfc337..1bc46120 100644 --- a/DistrhoPlugin_8hpp_source.html +++ b/DistrhoPlugin_8hpp_source.html @@ -356,7 +356,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
267  float max;
268 
269  /**
-
270  Default constructor.
+
270  Default constructor, using 0.0 as minimum, 1.0 as maximum and 0.0 as default.
271  */
272  ParameterRanges() noexcept
273  : def(0.0f),
@@ -478,7 +478,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
389  /**
390  The unit of this parameter.
391  This means something like "dB", "kHz" and "ms".
-
392  Can be left blank if units do not apply to this parameter.
+
392  Can be left blank if a unit does not apply to this parameter.
393  */
394  d_string unit;
395 
@@ -662,85 +662,85 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
573  /**
574  Plugin class constructor.
575  You must set all parameter values to their defaults, matching ParameterRanges::def.
-
576  If you're using states you must also set them to their defaults by calling d_setState().
-
577  */
-
578  Plugin(const uint32_t parameterCount, const uint32_t programCount, const uint32_t stateCount);
-
579 
-
580  /**
-
581  Destructor.
-
582  */
-
583  virtual ~Plugin();
-
584 
-
585  /* --------------------------------------------------------------------------------------------------------
-
586  * Host state */
-
587 
-
588  /**
-
589  Get the current buffer size that will probably be used during processing, in frames.
-
590  This value will remain constant between activate and deactivate.
-
591  @note: This value is only a hint!
-
592  Hosts might call d_run() with a higher or lower number of frames.
-
593  @see d_bufferSizeChanged(uint32_t)
-
594  */
-
595  uint32_t d_getBufferSize() const noexcept;
-
596 
-
597  /**
-
598  Get the current sample rate that will be used during processing.
-
599  This value will remain constant between activate and deactivate.
-
600  @see d_sampleRateChanged(double)
-
601  */
-
602  double d_getSampleRate() const noexcept;
-
603 
-
604 #if DISTRHO_PLUGIN_WANT_TIMEPOS
-
605  /**
-
606  Get the current host transport time position.
-
607  This function should only be called during d_run().
-
608  You can call this during other times, but the returned position is not guaranteed to be in sync.
-
609  @note: TimePos is not supported in LADSPA and DSSI plugin formats.
-
610  */
-
611  const TimePosition& d_getTimePosition() const noexcept;
-
612 #endif
-
613 
-
614 #if DISTRHO_PLUGIN_WANT_LATENCY
-
615  /**
-
616  Change the plugin audio output latency to @a frames.
-
617  This function should only be called in the constructor, d_activate() and d_run().
-
618  @note This function is only available if DISTRHO_PLUGIN_WANT_LATENCY is enabled.
-
619  */
-
620  void d_setLatency(uint32_t frames) noexcept;
-
621 #endif
-
622 
-
623 #if DISTRHO_PLUGIN_WANT_MIDI_OUTPUT
-
624  /**
-
625  Write a MIDI output event.
-
626  This function must only be called during d_run().
-
627  Returns false when the host buffer is full, in which case do not call this again until the next d_run().
-
628  */
-
629  bool d_writeMidiEvent(const MidiEvent& midiEvent) noexcept;
-
630 #endif
-
631 
-
632 protected:
-
633  /* --------------------------------------------------------------------------------------------------------
-
634  * Information */
-
635 
-
636  /**
-
637  Get the plugin name.
-
638  Returns DISTRHO_PLUGIN_NAME by default.
-
639  */
-
640  virtual const char* d_getName() const { return DISTRHO_PLUGIN_NAME; }
-
641 
-
642  /**
-
643  Get the plugin label.
-
644  A plugin label follows the same rules as Parameter::symbol, with the exception that it can start with numbers.
-
645  */
-
646  virtual const char* d_getLabel() const = 0;
-
647 
-
648  /**
-
649  Get the plugin author/maker.
-
650  */
-
651  virtual const char* d_getMaker() const = 0;
-
652 
-
653  /**
-
654  Get the plugin license name (a single line of text).
+
576  */
+
577  Plugin(const uint32_t parameterCount, const uint32_t programCount, const uint32_t stateCount);
+
578 
+
579  /**
+
580  Destructor.
+
581  */
+
582  virtual ~Plugin();
+
583 
+
584  /* --------------------------------------------------------------------------------------------------------
+
585  * Host state */
+
586 
+
587  /**
+
588  Get the current buffer size that will probably be used during processing, in frames.
+
589  This value will remain constant between activate and deactivate.
+
590  @note: This value is only a hint!
+
591  Hosts might call d_run() with a higher or lower number of frames.
+
592  @see d_bufferSizeChanged(uint32_t)
+
593  */
+
594  uint32_t d_getBufferSize() const noexcept;
+
595 
+
596  /**
+
597  Get the current sample rate that will be used during processing.
+
598  This value will remain constant between activate and deactivate.
+
599  @see d_sampleRateChanged(double)
+
600  */
+
601  double d_getSampleRate() const noexcept;
+
602 
+
603 #if DISTRHO_PLUGIN_WANT_TIMEPOS
+
604  /**
+
605  Get the current host transport time position.
+
606  This function should only be called during d_run().
+
607  You can call this during other times, but the returned position is not guaranteed to be in sync.
+
608  @note: TimePosition is not supported in LADSPA and DSSI plugin formats.
+
609  */
+
610  const TimePosition& d_getTimePosition() const noexcept;
+
611 #endif
+
612 
+
613 #if DISTRHO_PLUGIN_WANT_LATENCY
+
614  /**
+
615  Change the plugin audio output latency to @a frames.
+
616  This function should only be called in the constructor, d_activate() and d_run().
+
617  @note This function is only available if DISTRHO_PLUGIN_WANT_LATENCY is enabled.
+
618  */
+
619  void d_setLatency(uint32_t frames) noexcept;
+
620 #endif
+
621 
+
622 #if DISTRHO_PLUGIN_WANT_MIDI_OUTPUT
+
623  /**
+
624  Write a MIDI output event.
+
625  This function must only be called during d_run().
+
626  Returns false when the host buffer is full, in which case do not call this again until the next d_run().
+
627  */
+
628  bool d_writeMidiEvent(const MidiEvent& midiEvent) noexcept;
+
629 #endif
+
630 
+
631 protected:
+
632  /* --------------------------------------------------------------------------------------------------------
+
633  * Information */
+
634 
+
635  /**
+
636  Get the plugin name.
+
637  Returns DISTRHO_PLUGIN_NAME by default.
+
638  */
+
639  virtual const char* d_getName() const { return DISTRHO_PLUGIN_NAME; }
+
640 
+
641  /**
+
642  Get the plugin label.
+
643  A plugin label follows the same rules as Parameter::symbol, with the exception that it can start with numbers.
+
644  */
+
645  virtual const char* d_getLabel() const = 0;
+
646 
+
647  /**
+
648  Get the plugin author/maker.
+
649  */
+
650  virtual const char* d_getMaker() const = 0;
+
651 
+
652  /**
+
653  Get the plugin license name (a single line of text).@n
+
654  For commercial plugins this should return some copyright information.
655  */
656  virtual const char* d_getLicense() const = 0;
657 
@@ -795,7 +795,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
706  /**
707  Change a parameter value.
708  The host may call this function from any context, including realtime processing.
-
709  When a parameter is marked as automable, you must ensure no non-realtime operations are called.
+
709  When a parameter is marked as automable, you must ensure no non-realtime operations are performed.
710  @note This function will only be called for parameter inputs.
711  */
712  virtual void d_setParameterValue(uint32_t index, float value) = 0;
@@ -906,7 +906,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
ParameterRanges::fixValue
void fixValue(float &value) const noexcept
Definition: DistrhoPlugin.hpp:296
Plugin::d_sampleRateChanged
virtual void d_sampleRateChanged(double newSampleRate)
TimePosition::BarBeatTick::ticksPerBeat
double ticksPerBeat
Definition: DistrhoPlugin.hpp:508
-
Plugin::d_getName
virtual const char * d_getName() const
Definition: DistrhoPlugin.hpp:640
+
Plugin::d_getName
virtual const char * d_getName() const
Definition: DistrhoPlugin.hpp:639
MidiEvent
Definition: DistrhoPlugin.hpp:416
TimePosition::BarBeatTick::bar
int32_t bar
Definition: DistrhoPlugin.hpp:473
Plugin::d_run
virtual void d_run(const float **inputs, float **outputs, uint32_t frames, const MidiEvent *midiEvents, uint32_t midiEventCount)=0
@@ -962,7 +962,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); diff --git a/DistrhoUI_8hpp_source.html b/DistrhoUI_8hpp_source.html index 641449ee..136f8cef 100644 --- a/DistrhoUI_8hpp_source.html +++ b/DistrhoUI_8hpp_source.html @@ -303,7 +303,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); diff --git a/DistrhoUtils_8hpp_source.html b/DistrhoUtils_8hpp_source.html index 8db41485..88f5da50 100644 --- a/DistrhoUtils_8hpp_source.html +++ b/DistrhoUtils_8hpp_source.html @@ -292,7 +292,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); diff --git a/annotated.html b/annotated.html index dc265673..32fecff0 100644 --- a/annotated.html +++ b/annotated.html @@ -100,7 +100,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); diff --git a/classPlugin-members.html b/classPlugin-members.html index 0600cf39..92b4c1d1 100644 --- a/classPlugin-members.html +++ b/classPlugin-members.html @@ -118,7 +118,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); diff --git a/classPlugin.html b/classPlugin.html index 1c6fdfa4..249cb196 100644 --- a/classPlugin.html +++ b/classPlugin.html @@ -195,7 +195,7 @@ class PluginExporter
-

Plugin class constructor. You must set all parameter values to their defaults, matching ParameterRanges::def. If you're using states you must also set them to their defaults by calling d_setState().

+

Plugin class constructor. You must set all parameter values to their defaults, matching ParameterRanges::def.

@@ -293,7 +293,7 @@ class PluginExporter
-

Get the current host transport time position. This function should only be called during d_run(). You can call this during other times, but the returned position is not guaranteed to be in sync.

Note
: TimePos is not supported in LADSPA and DSSI plugin formats.
+

Get the current host transport time position. This function should only be called during d_run(). You can call this during other times, but the returned position is not guaranteed to be in sync.

Note
: TimePosition is not supported in LADSPA and DSSI plugin formats.
@@ -439,7 +439,8 @@ class PluginExporter
-

Get the plugin license name (a single line of text).

+

Get the plugin license name (a single line of text).
+For commercial plugins this should return some copyright information.

@@ -658,7 +659,7 @@ class PluginExporter
-

Change a parameter value. The host may call this function from any context, including realtime processing. When a parameter is marked as automable, you must ensure no non-realtime operations are called.

Note
This function will only be called for parameter inputs.
+

Change a parameter value. The host may call this function from any context, including realtime processing. When a parameter is marked as automable, you must ensure no non-realtime operations are performed.

Note
This function will only be called for parameter inputs.
@@ -880,7 +881,7 @@ class PluginExporter diff --git a/classUI-members.html b/classUI-members.html index e8a387ca..4b861a5b 100644 --- a/classUI-members.html +++ b/classUI-members.html @@ -110,7 +110,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); diff --git a/classUI.html b/classUI.html index 38df7505..b7c6534c 100644 --- a/classUI.html +++ b/classUI.html @@ -603,7 +603,7 @@ class UIExporterWindow diff --git a/classes.html b/classes.html index c6d1f234..7f346076 100644 --- a/classes.html +++ b/classes.html @@ -105,7 +105,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); diff --git a/dir_37257469cca17bab24b582e18a78eb75.html b/dir_37257469cca17bab24b582e18a78eb75.html index 9815dd13..ffdd7fd0 100644 --- a/dir_37257469cca17bab24b582e18a78eb75.html +++ b/dir_37257469cca17bab24b582e18a78eb75.html @@ -99,7 +99,7 @@ Files diff --git a/doxygen_sqlite3.db b/doxygen_sqlite3.db index 4c95977b..0dc15961 100644 Binary files a/doxygen_sqlite3.db and b/doxygen_sqlite3.db differ diff --git a/files.html b/files.html index 63b4a7de..11a3be8e 100644 --- a/files.html +++ b/files.html @@ -94,7 +94,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); diff --git a/functions.html b/functions.html index 6f95944e..fe47d5b8 100644 --- a/functions.html +++ b/functions.html @@ -388,7 +388,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); diff --git a/functions_func.html b/functions_func.html index 7257d4ab..deb8d482 100644 --- a/functions_func.html +++ b/functions_func.html @@ -286,7 +286,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); diff --git a/functions_vars.html b/functions_vars.html index 917b56a7..fc436007 100644 --- a/functions_vars.html +++ b/functions_vars.html @@ -161,7 +161,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); diff --git a/group__BaseStructs.html b/group__BaseStructs.html index 42cd5e59..f7206983 100644 --- a/group__BaseStructs.html +++ b/group__BaseStructs.html @@ -98,7 +98,7 @@ Classes diff --git a/group__ParameterHints.html b/group__ParameterHints.html index 301fe7a6..e22a2e93 100644 --- a/group__ParameterHints.html +++ b/group__ParameterHints.html @@ -229,7 +229,7 @@ Variables diff --git a/group__PluginMacros.html b/group__PluginMacros.html index b8de176d..8a75ca66 100644 --- a/group__PluginMacros.html +++ b/group__PluginMacros.html @@ -355,7 +355,7 @@ By default this is set to diff --git a/hierarchy.html b/hierarchy.html index a70ab487..748b0fcd 100644 --- a/hierarchy.html +++ b/hierarchy.html @@ -101,7 +101,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); diff --git a/index.html b/index.html index ad263ea4..95bf5280 100644 --- a/index.html +++ b/index.html @@ -92,7 +92,7 @@ Parameters diff --git a/modules.html b/modules.html index c83e8cb9..54ccb616 100644 --- a/modules.html +++ b/modules.html @@ -88,7 +88,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); diff --git a/structMidiEvent-members.html b/structMidiEvent-members.html index 1841c519..cac3d0a1 100644 --- a/structMidiEvent-members.html +++ b/structMidiEvent-members.html @@ -97,7 +97,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); diff --git a/structMidiEvent.html b/structMidiEvent.html index ac551497..7a3abb4b 100644 --- a/structMidiEvent.html +++ b/structMidiEvent.html @@ -179,7 +179,7 @@ Static Public Attributes diff --git a/structParameter-members.html b/structParameter-members.html index fde08b3a..37f07ab9 100644 --- a/structParameter-members.html +++ b/structParameter-members.html @@ -98,7 +98,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); diff --git a/structParameter.html b/structParameter.html index ce7c7d68..14a81cf5 100644 --- a/structParameter.html +++ b/structParameter.html @@ -187,7 +187,7 @@ Public Attributes
-

The unit of this parameter. This means something like "dB", "kHz" and "ms". Can be left blank if units do not apply to this parameter.

+

The unit of this parameter. This means something like "dB", "kHz" and "ms". Can be left blank if a unit does not apply to this parameter.

@@ -210,7 +210,7 @@ Public Attributes diff --git a/structParameterRanges-members.html b/structParameterRanges-members.html index d6014e77..23e59933 100644 --- a/structParameterRanges-members.html +++ b/structParameterRanges-members.html @@ -103,7 +103,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); diff --git a/structParameterRanges.html b/structParameterRanges.html index 6c23dff4..6dd8d57e 100644 --- a/structParameterRanges.html +++ b/structParameterRanges.html @@ -145,7 +145,7 @@ Public Attributes
-

Default constructor.

+

Default constructor, using 0.0 as minimum, 1.0 as maximum and 0.0 as default.

@@ -386,7 +386,7 @@ Public Attributes diff --git a/structTimePosition-members.html b/structTimePosition-members.html index b13b26c7..3a2725c0 100644 --- a/structTimePosition-members.html +++ b/structTimePosition-members.html @@ -96,7 +96,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); diff --git a/structTimePosition.html b/structTimePosition.html index 50eb6f12..24f71230 100644 --- a/structTimePosition.html +++ b/structTimePosition.html @@ -175,7 +175,7 @@ struct TimePosition: diff --git a/structTimePosition_1_1BarBeatTick-members.html b/structTimePosition_1_1BarBeatTick-members.html index 226edf03..cca76887 100644 --- a/structTimePosition_1_1BarBeatTick-members.html +++ b/structTimePosition_1_1BarBeatTick-members.html @@ -106,7 +106,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); diff --git a/structTimePosition_1_1BarBeatTick.html b/structTimePosition_1_1BarBeatTick.html index e0183949..30ee4d7d 100644 --- a/structTimePosition_1_1BarBeatTick.html +++ b/structTimePosition_1_1BarBeatTick.html @@ -274,7 +274,7 @@ Public Attributes