diff --git a/DistrhoPluginLV2_8hpp_source.html b/DistrhoPluginLV2_8hpp_source.html new file mode 100644 index 00000000..5e4ad7ee --- /dev/null +++ b/DistrhoPluginLV2_8hpp_source.html @@ -0,0 +1,530 @@ + + + + + + + +DISTRHO Plugin Framework: distrho/DistrhoPluginLV2.hpp Source File + + + + + + + + + +
+
+ + + + + + +
+
DISTRHO Plugin Framework +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
DistrhoPluginLV2.hpp
+
+
+
1 /*
+
2  * DISTRHO Plugin Framework (DPF)
+
3  * Copyright (C) 2012-2019 Filipe Coelho <falktx@falktx.com>
+
4  *
+
5  * Permission to use, copy, modify, and/or distribute this software for any purpose with
+
6  * or without fee is hereby granted, provided that the above copyright notice and this
+
7  * permission notice appear in all copies.
+
8  *
+
9  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD
+
10  * TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN
+
11  * NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
+
12  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER
+
13  * IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
+
14  * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
15  */
+
16 
+
17 #ifndef DISTRHO_PLUGIN_LV2_HPP_INCLUDED
+
18 #define DISTRHO_PLUGIN_LV2_HPP_INCLUDED
+
19 
+
20 #include "DistrhoPlugin.hpp"
+
21 
+
22 START_NAMESPACE_DISTRHO
+
23 
+
24 /* ------------------------------------------------------------------------------------------------------------
+
25  * LV2 Audio Port Hints */
+
26 
+
27 /**
+
28  @defgroup LV2AudioPortHints Audio Port Hints
+
29 
+
30  Various audio port hints.
+
31  @see AudioPortHints
+
32  @see AudioPort::hints
+
33  @{
+
34  */
+
35 
+
36 /**
+
37  Audio port can be used as control voltage (LV2 only).
+
38  */
+
39 static const uint32_t kAudioPortIsCV = 0x1;
+
40 
+
41 /**
+
42  Audio port should be used as sidechan (LV2 only).
+
43  */
+
44 static const uint32_t kAudioPortIsSidechain = 0x2;
+
45 
+
46 /** @} */
+
47 
+
48 /* ------------------------------------------------------------------------------------------------------------
+
49  * Parameter Hints */
+
50 
+
51 /**
+
52  @defgroup LV2ParameterHints Parameter Hints
+
53 
+
54  Various parameter hints.
+
55  @see ParameterHints
+
56  @see Parameter::hints
+
57  @{
+
58  */
+
59 
+
60 /**
+
61  Parameter value is a trigger.@n
+
62  This means the value resets back to its default after each process/run call.@n
+
63  Cannot be used for output parameters.
+
64 
+
65  @note Only officially supported under LV2. For other formats DPF simulates the behaviour.
+
66 */
+
67 static const uint32_t kParameterIsTrigger = 0x20 | kParameterIsBoolean;
+
68 
+
69 /** @} */
+
70 
+
71 /* ------------------------------------------------------------------------------------------------------------
+
72  * Base Plugin structs */
+
73 
+
74 /**
+
75  @defgroup BasePluginStructs Base Plugin Structs
+
76  @{
+
77  */
+
78 
+
79 /**
+
80  Parameter designation.@n
+
81  Allows a parameter to be specially designated for a task, like bypass.
+
82 
+
83  Each designation is unique, there must be only one parameter that uses it.@n
+
84  The use of designated parameters is completely optional.
+
85 
+
86  @note Designated parameters have strict ranges.
+
87  @see ParameterRanges::adjustForDesignation()
+
88  */
+ +
90  /**
+
91  Null or unset designation.
+
92  */
+ +
94 
+
95  /**
+
96  Bypass designation.@n
+
97  When on (> 0.5f), it means the plugin must run in a bypassed state.
+
98  */
+ +
100 };
+
101 
+
102 /** @} */
+
103 
+
104 /* ------------------------------------------------------------------------------------------------------------
+
105  * DPF Plugin */
+
106 
+
107 /**
+
108  @defgroup MainClasses Main Classes
+
109  @{
+
110  */
+
111 
+
112 /**
+
113  DPF Plugin class from where plugin instances are created.
+
114 
+
115  The public methods (Host state) are called from the plugin to get or set host information.@n
+
116  They can be called from a plugin instance at anytime unless stated otherwise.@n
+
117  All other methods are to be implemented by the plugin and will be called by the host.
+
118 
+
119  Shortly after a plugin instance is created, the various init* functions will be called by the host.@n
+
120  Host will call activate() before run(), and deactivate() before the plugin instance is destroyed.@n
+
121  The host may call deactivate right after activate and vice-versa, but never activate/deactivate consecutively.@n
+
122  There is no limit on how many times run() is called, only that activate/deactivate will be called in between.
+
123 
+
124  The buffer size and sample rate values will remain constant between activate and deactivate.@n
+
125  Buffer size is only a hint though, the host might call run() with a higher or lower number of frames.
+
126 
+
127  Some of this class functions are only available according to some macros.
+
128 
+
129  DISTRHO_PLUGIN_WANT_PROGRAMS activates program related features.@n
+
130  When enabled you need to implement initProgramName() and loadProgram().
+
131 
+
132  DISTRHO_PLUGIN_WANT_STATE activates internal state features.@n
+
133  When enabled you need to implement initStateKey() and setState().
+
134 
+
135  The process function run() changes wherever DISTRHO_PLUGIN_WANT_MIDI_INPUT is enabled or not.@n
+
136  When enabled it provides midi input events.
+
137  */
+
138 class Plugin
+
139 {
+
140 public:
+
141  /**
+
142  Plugin class constructor.@n
+
143  You must set all parameter values to their defaults, matching ParameterRanges::def.
+
144  */
+
145  Plugin(uint32_t parameterCount, uint32_t programCount, uint32_t stateCount);
+
146 
+
147  /**
+
148  Destructor.
+
149  */
+
150  virtual ~Plugin();
+
151 
+
152  /* --------------------------------------------------------------------------------------------------------
+
153  * Host state */
+
154 
+
155  /**
+
156  Get the current buffer size that will probably be used during processing, in frames.@n
+
157  This value will remain constant between activate and deactivate.
+
158  @note This value is only a hint!@n
+
159  Hosts might call run() with a higher or lower number of frames.
+
160  @see bufferSizeChanged(uint32_t)
+
161  */
+
162  uint32_t getBufferSize() const noexcept;
+
163 
+
164  /**
+
165  Get the current sample rate that will be used during processing.@n
+
166  This value will remain constant between activate and deactivate.
+
167  @see sampleRateChanged(double)
+
168  */
+
169  double getSampleRate() const noexcept;
+
170 
+
171 #if DISTRHO_PLUGIN_WANT_TIMEPOS
+
172  /**
+
173  Get the current host transport time position.@n
+
174  This function should only be called during run().@n
+
175  You can call this during other times, but the returned position is not guaranteed to be in sync.
+
176  @note TimePosition is not supported in LADSPA and DSSI plugin formats.
+
177  */
+
178  const TimePosition& getTimePosition() const noexcept;
+
179 #endif
+
180 
+
181 #if DISTRHO_PLUGIN_WANT_LATENCY
+
182  /**
+
183  Change the plugin audio output latency to @a frames.@n
+
184  This function should only be called in the constructor, activate() and run().
+
185  @note This function is only available if DISTRHO_PLUGIN_WANT_LATENCY is enabled.
+
186  */
+
187  void setLatency(uint32_t frames) noexcept;
+
188 #endif
+
189 
+
190 #if DISTRHO_PLUGIN_WANT_MIDI_OUTPUT
+
191  /**
+
192  Write a MIDI output event.@n
+
193  This function must only be called during run().@n
+
194  Returns false when the host buffer is full, in which case do not call this again until the next run().
+
195  */
+
196  bool writeMidiEvent(const MidiEvent& midiEvent) noexcept;
+
197 #endif
+
198 
+
199 protected:
+
200  /* --------------------------------------------------------------------------------------------------------
+
201  * Information */
+
202 
+
203  /**
+
204  Get the plugin name.@n
+
205  Returns DISTRHO_PLUGIN_NAME by default.
+
206  */
+
207  virtual const char* getName() const { return DISTRHO_PLUGIN_NAME; }
+
208 
+
209  /**
+
210  Get the plugin label.@n
+
211  This label is a short restricted name consisting of only _, a-z, A-Z and 0-9 characters.
+
212  */
+
213  virtual const char* getLabel() const = 0;
+
214 
+
215  /**
+
216  Get an extensive comment/description about the plugin.@n
+
217  Optional, returns nothing by default.
+
218  */
+
219  virtual const char* getDescription() const { return ""; }
+
220 
+
221  /**
+
222  Get the plugin author/maker.
+
223  */
+
224  virtual const char* getMaker() const = 0;
+
225 
+
226  /**
+
227  Get the plugin homepage.@n
+
228  Optional, returns nothing by default.
+
229  */
+
230  virtual const char* getHomePage() const { return ""; }
+
231 
+
232  /**
+
233  Get the plugin license (a single line of text or a URL).@n
+
234  For commercial plugins this should return some short copyright information.
+
235  */
+
236  virtual const char* getLicense() const = 0;
+
237 
+
238  /**
+
239  Get the plugin version, in hexadecimal.
+
240  @see d_version()
+
241  */
+
242  virtual uint32_t getVersion() const = 0;
+
243 
+
244  /**
+
245  Get the plugin unique Id.@n
+
246  This value is used by LADSPA, DSSI and VST plugin formats.
+
247  @see d_cconst()
+
248  */
+
249  virtual int64_t getUniqueId() const = 0;
+
250 
+
251  /* --------------------------------------------------------------------------------------------------------
+
252  * Init */
+
253 
+
254  /**
+
255  Initialize the audio port @a index.@n
+
256  This function will be called once, shortly after the plugin is created.
+
257  */
+
258  virtual void initAudioPort(bool input, uint32_t index, AudioPort& port);
+
259 
+
260  /**
+
261  Initialize the parameter @a index.@n
+
262  This function will be called once, shortly after the plugin is created.
+
263  */
+
264  virtual void initParameter(uint32_t index, Parameter& parameter) = 0;
+
265 
+
266 #if DISTRHO_PLUGIN_WANT_PROGRAMS
+
267  /**
+
268  Set the name of the program @a index.@n
+
269  This function will be called once, shortly after the plugin is created.@n
+
270  Must be implemented by your plugin class only if DISTRHO_PLUGIN_WANT_PROGRAMS is enabled.
+
271  */
+
272  virtual void initProgramName(uint32_t index, String& programName) = 0;
+
273 #endif
+
274 
+
275 #if DISTRHO_PLUGIN_WANT_STATE
+
276  /**
+
277  Set the state key and default value of @a index.@n
+
278  This function will be called once, shortly after the plugin is created.@n
+
279  Must be implemented by your plugin class only if DISTRHO_PLUGIN_WANT_STATE is enabled.
+
280  */
+
281  virtual void initState(uint32_t index, String& stateKey, String& defaultStateValue) = 0;
+
282 #endif
+
283 
+
284  /* --------------------------------------------------------------------------------------------------------
+
285  * Internal data */
+
286 
+
287  /**
+
288  Get the current value of a parameter.@n
+
289  The host may call this function from any context, including realtime processing.
+
290  */
+
291  virtual float getParameterValue(uint32_t index) const = 0;
+
292 
+
293  /**
+
294  Change a parameter value.@n
+
295  The host may call this function from any context, including realtime processing.@n
+
296  When a parameter is marked as automable, you must ensure no non-realtime operations are performed.
+
297  @note This function will only be called for parameter inputs.
+
298  */
+
299  virtual void setParameterValue(uint32_t index, float value) = 0;
+
300 
+
301 #if DISTRHO_PLUGIN_WANT_PROGRAMS
+
302  /**
+
303  Load a program.@n
+
304  The host may call this function from any context, including realtime processing.@n
+
305  Must be implemented by your plugin class only if DISTRHO_PLUGIN_WANT_PROGRAMS is enabled.
+
306  */
+
307  virtual void loadProgram(uint32_t index) = 0;
+
308 #endif
+
309 
+
310 #if DISTRHO_PLUGIN_WANT_FULL_STATE
+
311  /**
+
312  Get the value of an internal state.@n
+
313  The host may call this function from any non-realtime context.@n
+
314  Must be implemented by your plugin class if DISTRHO_PLUGIN_WANT_FULL_STATE is enabled.
+
315  @note The use of this function breaks compatibility with the DSSI format.
+
316  */
+
317  virtual String getState(const char* key) const = 0;
+
318 #endif
+
319 
+
320 #if DISTRHO_PLUGIN_WANT_STATE
+
321  /**
+
322  Change an internal state @a key to @a value.@n
+
323  Must be implemented by your plugin class only if DISTRHO_PLUGIN_WANT_STATE is enabled.
+
324  */
+
325  virtual void setState(const char* key, const char* value) = 0;
+
326 #endif
+
327 
+
328  /* --------------------------------------------------------------------------------------------------------
+
329  * Audio/MIDI Processing */
+
330 
+
331  /**
+
332  Activate this plugin.
+
333  */
+
334  virtual void activate() {}
+
335 
+
336  /**
+
337  Deactivate this plugin.
+
338  */
+
339  virtual void deactivate() {}
+
340 
+
341 #if DISTRHO_PLUGIN_WANT_MIDI_INPUT
+
342  /**
+
343  Run/process function for plugins with MIDI input.
+
344  @note Some parameters might be null if there are no audio inputs/outputs or MIDI events.
+
345  */
+
346  virtual void run(const float** inputs, float** outputs, uint32_t frames,
+
347  const MidiEvent* midiEvents, uint32_t midiEventCount) = 0;
+
348 #else
+
349  /**
+
350  Run/process function for plugins without MIDI input.
+
351  @note Some parameters might be null if there are no audio inputs or outputs.
+
352  */
+
353  virtual void run(const float** inputs, float** outputs, uint32_t frames) = 0;
+
354 #endif
+
355 
+
356  /* --------------------------------------------------------------------------------------------------------
+
357  * Callbacks (optional) */
+
358 
+
359  /**
+
360  Optional callback to inform the plugin about a buffer size change.@n
+
361  This function will only be called when the plugin is deactivated.
+
362  @note This value is only a hint!@n
+
363  Hosts might call run() with a higher or lower number of frames.
+
364  @see getBufferSize()
+
365  */
+
366  virtual void bufferSizeChanged(uint32_t newBufferSize);
+
367 
+
368  /**
+
369  Optional callback to inform the plugin about a sample rate change.@n
+
370  This function will only be called when the plugin is deactivated.
+
371  @see getSampleRate()
+
372  */
+
373  virtual void sampleRateChanged(double newSampleRate);
+
374 
+
375  // -------------------------------------------------------------------------------------------------------
+
376 
+
377 private:
+
378  struct PrivateData;
+
379  PrivateData* const pData;
+
380  friend class PluginExporter;
+
381 
+
382  DISTRHO_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR(Plugin)
+
383 };
+
384 
+
385 /** @} */
+
386 
+
387 /* ------------------------------------------------------------------------------------------------------------
+
388  * Create plugin, entry point */
+
389 
+
390 /**
+
391  @defgroup EntryPoints Entry Points
+
392  @{
+
393  */
+
394 
+
395 /**
+
396  TODO.
+
397  */
+
398 extern Plugin* createPlugin();
+
399 
+
400 /** @} */
+
401 
+
402 // -----------------------------------------------------------------------------------------------------------
+
403 
+
404 END_NAMESPACE_DISTRHO
+
405 
+
406 #endif // DISTRHO_PLUGIN_HPP_INCLUDED
+
+
Plugin::sampleRateChanged
virtual void sampleRateChanged(double newSampleRate)
+
Plugin::getTimePosition
const TimePosition & getTimePosition() const noexcept
+
Plugin::deactivate
virtual void deactivate()
Definition: DistrhoPluginLV2.hpp:339
+
Plugin::getVersion
virtual uint32_t getVersion() const =0
+
MidiEvent
Definition: DistrhoPlugin.hpp:502
+
Plugin::setLatency
void setLatency(uint32_t frames) noexcept
+
String
Definition: String.hpp:29
+
Plugin::writeMidiEvent
bool writeMidiEvent(const MidiEvent &midiEvent) noexcept
+
Plugin::getState
virtual String getState(const char *key) const =0
+
Plugin::getParameterValue
virtual float getParameterValue(uint32_t index) const =0
+
createPlugin
Plugin * createPlugin()
+
Plugin::Plugin
Plugin(uint32_t parameterCount, uint32_t programCount, uint32_t stateCount)
+
kParameterDesignationNull
@ kParameterDesignationNull
Definition: DistrhoPluginLV2.hpp:93
+
Plugin::~Plugin
virtual ~Plugin()
+
Parameter
Definition: DistrhoPlugin.hpp:378
+
Plugin::getBufferSize
uint32_t getBufferSize() const noexcept
+
Plugin::getMaker
virtual const char * getMaker() const =0
+
Plugin::loadProgram
virtual void loadProgram(uint32_t index)=0
+
DISTRHO_PLUGIN_NAME
#define DISTRHO_PLUGIN_NAME
Definition: DistrhoInfo.hpp:470
+
Plugin::initProgramName
virtual void initProgramName(uint32_t index, String &programName)=0
+
kAudioPortIsCV
static const uint32_t kAudioPortIsCV
Definition: DistrhoPluginLV2.hpp:39
+
Plugin::getLabel
virtual const char * getLabel() const =0
+
Plugin::bufferSizeChanged
virtual void bufferSizeChanged(uint32_t newBufferSize)
+
Plugin::initParameter
virtual void initParameter(uint32_t index, Parameter &parameter)=0
+
kParameterDesignationBypass
@ kParameterDesignationBypass
Definition: DistrhoPluginLV2.hpp:99
+
Plugin::getDescription
virtual const char * getDescription() const
Definition: DistrhoPluginLV2.hpp:219
+
Plugin::getName
virtual const char * getName() const
Definition: DistrhoPluginLV2.hpp:207
+
Plugin::getLicense
virtual const char * getLicense() const =0
+
kAudioPortIsSidechain
static const uint32_t kAudioPortIsSidechain
Definition: DistrhoPluginLV2.hpp:44
+
ParameterDesignation
ParameterDesignation
Definition: DistrhoPlugin.hpp:158
+
kParameterIsTrigger
static const uint32_t kParameterIsTrigger
Definition: DistrhoPluginLV2.hpp:67
+
Plugin::initAudioPort
virtual void initAudioPort(bool input, uint32_t index, AudioPort &port)
+
Plugin::getUniqueId
virtual int64_t getUniqueId() const =0
+
Plugin
Definition: DistrhoPlugin.hpp:687
+
Plugin::run
virtual void run(const float **inputs, float **outputs, uint32_t frames, const MidiEvent *midiEvents, uint32_t midiEventCount)=0
+
Plugin::setParameterValue
virtual void setParameterValue(uint32_t index, float value)=0
+
TimePosition
Definition: DistrhoPlugin.hpp:533
+
Plugin::getHomePage
virtual const char * getHomePage() const
Definition: DistrhoPluginLV2.hpp:230
+
kParameterIsBoolean
static const uint32_t kParameterIsBoolean
Definition: DistrhoPlugin.hpp:70
+
AudioPort
Definition: DistrhoPlugin.hpp:117
+
Plugin::getSampleRate
double getSampleRate() const noexcept
+
Plugin::activate
virtual void activate()
Definition: DistrhoPluginLV2.hpp:334
+
Plugin::initState
virtual void initState(uint32_t index, String &stateKey, String &defaultStateValue)=0
+
Plugin::setState
virtual void setState(const char *key, const char *value)=0
+ + + + diff --git a/DistrhoPluginUtils_8hpp_source.html b/DistrhoPluginUtils_8hpp_source.html new file mode 100644 index 00000000..84f36cc4 --- /dev/null +++ b/DistrhoPluginUtils_8hpp_source.html @@ -0,0 +1,246 @@ + + + + + + + +DISTRHO Plugin Framework: distrho/DistrhoPluginUtils.hpp Source File + + + + + + + + + +
+
+ + + + + + +
+
DISTRHO Plugin Framework +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
DistrhoPluginUtils.hpp
+
+
+
1 /*
+
2  * DISTRHO Plugin Framework (DPF)
+
3  * Copyright (C) 2012-2019 Filipe Coelho <falktx@falktx.com>
+
4  *
+
5  * Permission to use, copy, modify, and/or distribute this software for any purpose with
+
6  * or without fee is hereby granted, provided that the above copyright notice and this
+
7  * permission notice appear in all copies.
+
8  *
+
9  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD
+
10  * TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN
+
11  * NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
+
12  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER
+
13  * IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
+
14  * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
15  */
+
16 
+
17 #ifndef DISTRHO_PLUGIN_UTILS_HPP_INCLUDED
+
18 #define DISTRHO_PLUGIN_UTILS_HPP_INCLUDED
+
19 
+
20 #include "DistrhoPlugin.hpp"
+
21 
+
22 START_NAMESPACE_DISTRHO
+
23 
+
24 // -----------------------------------------------------------------------------------------------------------
+
25 
+
26 /**
+
27  Handy class to help keep audio buffer in sync with incoming MIDI events.
+
28  To use it, create a local variable (on the stack) and call nextEvent() until it returns false.
+
29  @code
+
30  for (AudioMidiSyncHelper amsh(outputs, frames, midiEvents, midiEventCount); amsh.nextEvent();)
+
31  {
+
32  float* const outL = amsh.outputs[0];
+
33  float* const outR = amsh.outputs[1];
+
34 
+
35  for (uint32_t i=0; i<amsh.midiEventCount; ++i)
+
36  {
+
37  const MidiEvent& ev(amsh.midiEvents[i]);
+
38  // ... do something with the midi event
+
39  }
+
40 
+
41  renderSynth(outL, outR, amsh.frames);
+
42  }
+
43  @endcode
+
44 
+
45  Some important notes when using this class:
+
46  1. MidiEvent::frame retains its original value, but it is useless, do not use it.
+
47  2. The class variables names are be the same as the default ones in the run function.
+
48  Keep that in mind and try to avoid typos. :)
+
49  */
+ +
51 public:
+
52  /** Parameters from the run function, adjusted for event sync */
+ +
54  uint32_t frames;
+
55  const MidiEvent* midiEvents;
+
56  uint32_t midiEventCount;
+
57 
+
58  /**
+
59  Constructor, using values from the run function.
+
60  */
+
61  AudioMidiSyncHelper(float** const o, uint32_t f, const MidiEvent* m, uint32_t mc)
+
62  : outputs(),
+
63  frames(0),
+
64  midiEvents(m),
+
65  midiEventCount(0),
+
66  remainingFrames(f),
+
67  remainingMidiEventCount(mc),
+
68  totalFramesUsed(0)
+
69  {
+
70  for (uint i=0; i<DISTRHO_PLUGIN_NUM_OUTPUTS; ++i)
+
71  outputs[i] = o[i];
+
72  }
+
73 
+
74  /**
+
75  Process a batch of events untill no more are available.
+
76  You must not read any more values from this class after this function returns false.
+
77  */
+
78  bool nextEvent()
+
79  {
+
80  // nothing else to do
+
81  if (remainingFrames == 0)
+
82  return false;
+
83 
+
84  // initial setup, need to find first MIDI event
+
85  if (totalFramesUsed == 0)
+
86  {
+
87  // no MIDI events at all in this process cycle
+
88  if (remainingMidiEventCount == 0)
+
89  {
+
90  frames = remainingFrames;
+
91  remainingFrames = 0;
+
92  totalFramesUsed += frames;
+
93  return true;
+
94  }
+
95 
+
96  // render audio until first midi event, if needed
+
97  if (const uint32_t firstEventFrame = midiEvents[0].frame)
+
98  {
+
99  DISTRHO_SAFE_ASSERT_UINT2_RETURN(firstEventFrame < remainingFrames,
+
100  firstEventFrame, remainingFrames, false);
+
101  frames = firstEventFrame;
+
102  remainingFrames -= firstEventFrame;
+
103  totalFramesUsed += firstEventFrame;
+
104  return true;
+
105  }
+
106  }
+
107  else
+
108  {
+
109  for (uint32_t i=0; i<DISTRHO_PLUGIN_NUM_OUTPUTS; ++i)
+
110  outputs[i] += frames;
+
111  }
+
112 
+
113  // no more MIDI events available
+
114  if (remainingMidiEventCount == 0)
+
115  {
+
116  frames = remainingFrames;
+
117  midiEvents = nullptr;
+
118  midiEventCount = 0;
+
119  remainingFrames = 0;
+
120  totalFramesUsed += frames;
+
121  return true;
+
122  }
+
123 
+
124  // if there were midi events before, increment pointer
+
125  if (midiEventCount != 0)
+
126  midiEvents += midiEventCount;
+
127 
+
128  const uint32_t firstEventFrame = midiEvents[0].frame;
+
129  DISTRHO_SAFE_ASSERT_UINT2_RETURN(firstEventFrame >= totalFramesUsed,
+
130  firstEventFrame, totalFramesUsed, false);
+
131 
+
132  midiEventCount = 1;
+
133  while (midiEventCount < remainingMidiEventCount)
+
134  {
+
135  if (midiEvents[midiEventCount].frame == firstEventFrame)
+
136  ++midiEventCount;
+
137  else
+
138  break;
+
139  }
+
140 
+
141  frames = firstEventFrame - totalFramesUsed;
+
142  remainingFrames -= frames;
+
143  remainingMidiEventCount -= midiEventCount;
+
144  totalFramesUsed += frames;
+
145  return true;
+
146  }
+
147 
+
148 private:
+
149  /** @internal */
+
150  uint32_t remainingFrames;
+
151  uint32_t remainingMidiEventCount;
+
152  uint32_t totalFramesUsed;
+
153 };
+
154 
+
155 // -----------------------------------------------------------------------------------------------------------
+
156 
+
157 END_NAMESPACE_DISTRHO
+
158 
+
159 #endif // DISTRHO_PLUGIN_UTILS_HPP_INCLUDED
+
+
MidiEvent
Definition: DistrhoPlugin.hpp:502
+
MidiEvent::frame
uint32_t frame
Definition: DistrhoPlugin.hpp:511
+
AudioMidiSyncHelper::outputs
float * outputs[2]
Definition: DistrhoPluginUtils.hpp:53
+
AudioMidiSyncHelper::nextEvent
bool nextEvent()
Definition: DistrhoPluginUtils.hpp:78
+
AudioMidiSyncHelper::AudioMidiSyncHelper
AudioMidiSyncHelper(float **const o, uint32_t f, const MidiEvent *m, uint32_t mc)
Definition: DistrhoPluginUtils.hpp:61
+
DISTRHO_PLUGIN_NUM_OUTPUTS
#define DISTRHO_PLUGIN_NUM_OUTPUTS
Definition: DistrhoInfo.hpp:482
+
AudioMidiSyncHelper
Definition: DistrhoPluginUtils.hpp:50
+ + + + diff --git a/ImageBaseWidgets_8hpp_source.html b/ImageBaseWidgets_8hpp_source.html new file mode 100644 index 00000000..e12eab35 --- /dev/null +++ b/ImageBaseWidgets_8hpp_source.html @@ -0,0 +1,185 @@ + + + + + + + +DISTRHO Plugin Framework: dgl/ImageBaseWidgets.hpp Source File + + + + + + + + + +
+
+ + + + + + +
+
DISTRHO Plugin Framework +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
ImageBaseWidgets.hpp
+
+
+
1 /*
+
2  * DISTRHO Plugin Framework (DPF)
+
3  * Copyright (C) 2012-2021 Filipe Coelho <falktx@falktx.com>
+
4  *
+
5  * Permission to use, copy, modify, and/or distribute this software for any purpose with
+
6  * or without fee is hereby granted, provided that the above copyright notice and this
+
7  * permission notice appear in all copies.
+
8  *
+
9  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD
+
10  * TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN
+
11  * NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
+
12  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER
+
13  * IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
+
14  * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
15  */
+
16 
+
17 #ifndef DGL_IMAGE_BASE_WIDGETS_HPP_INCLUDED
+
18 #define DGL_IMAGE_BASE_WIDGETS_HPP_INCLUDED
+
19 
+
20 #include "StandaloneWindow.hpp"
+
21 #include "SubWidget.hpp"
+
22 
+
23 START_NAMESPACE_DGL
+
24 
+
25 // --------------------------------------------------------------------------------------------------------------------
+
26 
+
27 template <class ImageType>
+ +
29 {
+
30 public:
+
31  explicit ImageBaseAboutWindow(Window& parentWindow, const ImageType& image = ImageType());
+
32  explicit ImageBaseAboutWindow(TopLevelWidget* parentTopLevelWidget, const ImageType& image = ImageType());
+
33 
+
34  void setImage(const ImageType& image);
+
35 
+
36 protected:
+
37  void onDisplay() override;
+
38  bool onKeyboard(const KeyboardEvent&) override;
+
39  bool onMouse(const MouseEvent&) override;
+
40 
+
41  // FIXME needed?
+
42  void onReshape(uint width, uint height) override;
+
43 
+
44 private:
+
45  ImageType img;
+
46 
+
47  DISTRHO_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR(ImageBaseAboutWindow)
+
48 };
+
49 
+
50 // --------------------------------------------------------------------------------------------------------------------
+
51 
+
52 template <class ImageType>
+
53 class ImageBaseButton : public SubWidget
+
54 {
+
55 public:
+
56  class Callback
+
57  {
+
58  public:
+
59  virtual ~Callback() {}
+
60  virtual void imageButtonClicked(ImageBaseButton* imageButton, int button) = 0;
+
61  };
+
62 
+
63  explicit ImageBaseButton(Widget* parentWidget, const ImageType& image);
+
64  explicit ImageBaseButton(Widget* parentWidget, const ImageType& imageNormal, const ImageType& imageDown);
+
65  explicit ImageBaseButton(Widget* parentWidget, const ImageType& imageNormal, const ImageType& imageHover, const ImageType& imageDown);
+
66 
+
67  ~ImageBaseButton() override;
+
68 
+
69  void setCallback(Callback* callback) noexcept;
+
70 
+
71 protected:
+
72  void onDisplay() override;
+
73  bool onMouse(const MouseEvent&) override;
+
74  bool onMotion(const MotionEvent&) override;
+
75 
+
76 private:
+
77  struct PrivateData;
+
78  PrivateData* const pData;
+
79 
+
80  DISTRHO_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR(ImageBaseButton)
+
81 };
+
82 
+
83 // --------------------------------------------------------------------------------------------------------------------
+
84 
+
85 END_NAMESPACE_DGL
+
86 
+
87 #endif // DGL_IMAGE_BASE_WIDGETS_HPP_INCLUDED
+
+
ImageBaseAboutWindow::onDisplay
void onDisplay() override
+
ImageBaseButton
Definition: ImageBaseWidgets.hpp:53
+
ImageBaseAboutWindow::onReshape
void onReshape(uint width, uint height) override
+
Widget::KeyboardEvent
Definition: Widget.hpp:94
+
Window
Definition: Window.hpp:50
+
ImageBaseButton::onDisplay
void onDisplay() override
+
ImageBaseAboutWindow::onMouse
bool onMouse(const MouseEvent &) override
+
Widget::MotionEvent
Definition: Widget.hpp:183
+
ImageBaseAboutWindow::onKeyboard
bool onKeyboard(const KeyboardEvent &) override
+
ImageBaseAboutWindow
Definition: ImageBaseWidgets.hpp:28
+
ImageBaseButton::onMouse
bool onMouse(const MouseEvent &) override
+
StandaloneWindow
Definition: StandaloneWindow.hpp:27
+
ImageBaseButton::Callback
Definition: ImageBaseWidgets.hpp:56
+
SubWidget
Definition: SubWidget.hpp:39
+
Widget::MouseEvent
Definition: Widget.hpp:164
+
ImageBaseButton::onMotion
bool onMotion(const MotionEvent &) override
+
TopLevelWidget
Definition: TopLevelWidget.hpp:46
+
Widget
Definition: Widget.hpp:53
+ + + + diff --git a/SubWidget_8hpp_source.html b/SubWidget_8hpp_source.html new file mode 100644 index 00000000..6f989021 --- /dev/null +++ b/SubWidget_8hpp_source.html @@ -0,0 +1,248 @@ + + + + + + + +DISTRHO Plugin Framework: dgl/SubWidget.hpp Source File + + + + + + + + + +
+
+ + + + + + +
+
DISTRHO Plugin Framework +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
SubWidget.hpp
+
+
+
1 /*
+
2  * DISTRHO Plugin Framework (DPF)
+
3  * Copyright (C) 2012-2021 Filipe Coelho <falktx@falktx.com>
+
4  *
+
5  * Permission to use, copy, modify, and/or distribute this software for any purpose with
+
6  * or without fee is hereby granted, provided that the above copyright notice and this
+
7  * permission notice appear in all copies.
+
8  *
+
9  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD
+
10  * TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN
+
11  * NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
+
12  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER
+
13  * IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
+
14  * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
15  */
+
16 
+
17 #ifndef DGL_SUBWIDGET_HPP_INCLUDED
+
18 #define DGL_SUBWIDGET_HPP_INCLUDED
+
19 
+
20 #include "Widget.hpp"
+
21 
+
22 START_NAMESPACE_DGL
+
23 
+
24 // --------------------------------------------------------------------------------------------------------------------
+
25 
+
26 /**
+
27  Sub-Widget class.
+
28 
+
29  This class is the main entry point for creating any reusable widgets from within DGL.
+
30  It can be freely positioned from within a parent widget, thus being named subwidget.
+
31 
+
32  Many subwidgets can share the same parent, and subwidgets themselves can also have its own subwidgets.
+
33  It is subwidgets all the way down.
+
34 
+
35  TODO check absolute vs relative position and see what makes more sense.
+
36 
+
37  @see CairoSubWidget
+
38  */
+
39 class SubWidget : public Widget
+
40 {
+
41 public:
+
42  /**
+
43  Constructor.
+
44  */
+
45  explicit SubWidget(Widget* parentWidget);
+
46 
+
47  /**
+
48  Destructor.
+
49  */
+
50  virtual ~SubWidget();
+
51 
+
52  /**
+
53  Check if this widget contains the point defined by @a x and @a y.
+
54  */
+
55  // TODO rename as containsRelativePos
+
56  template<typename T>
+
57  bool contains(T x, T y) const noexcept;
+
58 
+
59  /**
+
60  Check if this widget contains the point @a pos.
+
61  */
+
62  // TODO rename as containsRelativePos
+
63  template<typename T>
+
64  bool contains(const Point<T>& pos) const noexcept;
+
65 
+
66  /**
+
67  Get absolute X.
+
68  */
+
69  int getAbsoluteX() const noexcept;
+
70 
+
71  /**
+
72  Get absolute Y.
+
73  */
+
74  int getAbsoluteY() const noexcept;
+
75 
+
76  /**
+
77  Get absolute position.
+
78  */
+
79  Point<int> getAbsolutePos() const noexcept;
+
80 
+
81  /**
+
82  Get absolute area of this subwidget.
+
83  This is the same as `Rectangle<int>(getAbsolutePos(), getSize());`
+
84  @see getConstrainedAbsoluteArea()
+
85  */
+
86  Rectangle<int> getAbsoluteArea() const noexcept;
+
87 
+
88  /**
+
89  Get absolute area of this subwidget, with special consideration for not allowing negative values.
+
90  @see getAbsoluteArea()
+
91  */
+ +
93 
+
94  /**
+
95  Set absolute X.
+
96  */
+
97  void setAbsoluteX(int x) noexcept;
+
98 
+
99  /**
+
100  Set absolute Y.
+
101  */
+
102  void setAbsoluteY(int y) noexcept;
+
103 
+
104  /**
+
105  Set absolute position using @a x and @a y values.
+
106  */
+
107  void setAbsolutePos(int x, int y) noexcept;
+
108 
+
109  /**
+
110  Set absolute position.
+
111  */
+
112  void setAbsolutePos(const Point<int>& pos) noexcept;
+
113 
+
114  /**
+
115  Get parent Widget, as passed in the constructor.
+
116  */
+
117  Widget* getParentWidget() const noexcept;
+
118 
+
119  /**
+
120  Request repaint of this subwidget's area to the window this widget belongs to.
+
121  */
+
122  void repaint() noexcept override;
+
123 
+
124  /**
+
125  Indicate that this subwidget will draw out of bounds, and thus needs the entire viewport available for drawing.
+
126  */
+
127  void setNeedsFullViewportDrawing(bool needsFullViewportForDrawing = true);
+
128 
+
129 protected:
+
130  /**
+
131  A function called when the subwidget's absolute position is changed.
+
132  */
+
133  virtual void onPositionChanged(const PositionChangedEvent&);
+
134 
+
135 private:
+
136  struct PrivateData;
+
137  PrivateData* const pData;
+
138  friend class Widget;
+
139  template <class BaseWidget> friend class NanoBaseWidget;
+
140  DISTRHO_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR(SubWidget)
+
141 };
+
142 
+
143 // --------------------------------------------------------------------------------------------------------------------
+
144 
+
145 END_NAMESPACE_DGL
+
146 
+
147 #endif // DGL_SUBWIDGET_HPP_INCLUDED
+
148 
+
+
SubWidget::getAbsoluteArea
Rectangle< int > getAbsoluteArea() const noexcept
+
NanoBaseWidget
Definition: NanoVG.hpp:881
+
SubWidget::getAbsoluteX
int getAbsoluteX() const noexcept
+
SubWidget::setAbsolutePos
void setAbsolutePos(int x, int y) noexcept
+
SubWidget::setAbsoluteY
void setAbsoluteY(int y) noexcept
+
Rectangle
Definition: Geometry.hpp:30
+
SubWidget::setAbsoluteX
void setAbsoluteX(int x) noexcept
+
SubWidget::setNeedsFullViewportDrawing
void setNeedsFullViewportDrawing(bool needsFullViewportForDrawing=true)
+
SubWidget::getAbsoluteY
int getAbsoluteY() const noexcept
+
Widget::PositionChangedEvent
Definition: Widget.hpp:241
+
SubWidget::getConstrainedAbsoluteArea
Rectangle< uint > getConstrainedAbsoluteArea() const noexcept
+
SubWidget::repaint
void repaint() noexcept override
+
SubWidget::contains
bool contains(T x, T y) const noexcept
+
SubWidget::onPositionChanged
virtual void onPositionChanged(const PositionChangedEvent &)
+
SubWidget::getParentWidget
Widget * getParentWidget() const noexcept
+
Point
Definition: Geometry.hpp:40
+
SubWidget
Definition: SubWidget.hpp:39
+
SubWidget::getAbsolutePos
Point< int > getAbsolutePos() const noexcept
+
Widget
Definition: Widget.hpp:53
+
SubWidget::~SubWidget
virtual ~SubWidget()
+ + + + diff --git a/TopLevelWidget_8hpp_source.html b/TopLevelWidget_8hpp_source.html new file mode 100644 index 00000000..565c3dd2 --- /dev/null +++ b/TopLevelWidget_8hpp_source.html @@ -0,0 +1,192 @@ + + + + + + + +DISTRHO Plugin Framework: dgl/TopLevelWidget.hpp Source File + + + + + + + + + +
+
+ + + + + + +
+
DISTRHO Plugin Framework +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
TopLevelWidget.hpp
+
+
+
1 /*
+
2  * DISTRHO Plugin Framework (DPF)
+
3  * Copyright (C) 2012-2021 Filipe Coelho <falktx@falktx.com>
+
4  *
+
5  * Permission to use, copy, modify, and/or distribute this software for any purpose with
+
6  * or without fee is hereby granted, provided that the above copyright notice and this
+
7  * permission notice appear in all copies.
+
8  *
+
9  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD
+
10  * TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN
+
11  * NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
+
12  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER
+
13  * IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
+
14  * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
15  */
+
16 
+
17 #ifndef DGL_TOP_LEVEL_WIDGET_HPP_INCLUDED
+
18 #define DGL_TOP_LEVEL_WIDGET_HPP_INCLUDED
+
19 
+
20 #include "Widget.hpp"
+
21 
+
22 #ifdef DISTRHO_DEFINES_H_INCLUDED
+
23 START_NAMESPACE_DISTRHO
+
24 class UI;
+
25 END_NAMESPACE_DISTRHO
+
26 #endif
+
27 
+
28 START_NAMESPACE_DGL
+
29 
+
30 class Window;
+
31 
+
32 // -----------------------------------------------------------------------
+
33 
+
34 /**
+
35  Top-Level Widget class.
+
36 
+
37  This is the only Widget class that is allowed to be used directly on a Window.
+
38 
+
39  This widget takes the full size of the Window it is mapped to.
+
40  Sub-widgets can be added on top of this top-level widget, by creating them with this class as parent.
+
41  Doing so allows for custom position and sizes.
+
42 
+
43  This class is used as the type for DPF Plugin UIs.
+
44  So anything that a plugin UI might need that does not belong in a simple Widget will go here.
+
45  */
+
46 class TopLevelWidget : public Widget
+
47 {
+
48 public:
+
49  /**
+
50  Constructor.
+
51  */
+
52  explicit TopLevelWidget(Window& windowToMapTo);
+
53 
+
54  /**
+
55  Destructor.
+
56  */
+
57  virtual ~TopLevelWidget();
+
58 
+
59  /**
+
60  Get the application associated with this top-level widget's window.
+
61  */
+
62  Application& getApp() const noexcept;
+
63 
+
64  /**
+
65  Get the window associated with this top-level widget.
+
66  */
+
67  Window& getWindow() const noexcept;
+
68 
+
69  // TODO group stuff after here, convenience functions present in Window class
+
70  bool addIdleCallback(IdleCallback* callback, uint timerFrequencyInMs = 0);
+
71  bool removeIdleCallback(IdleCallback* callback);
+
72  double getScaleFactor() const noexcept;
+
73  void repaint() noexcept;
+
74  void repaint(const Rectangle<uint>& rect) noexcept;
+
75  void setGeometryConstraints(uint minimumWidth,
+
76  uint minimumHeight,
+
77  bool keepAspectRatio = false,
+
78  bool automaticallyScale = false);
+
79 
+
80  DISTRHO_DEPRECATED_BY("getApp()")
+
81  Application& getParentApp() const noexcept { return getApp(); }
+
82 
+
83  DISTRHO_DEPRECATED_BY("getWindow()")
+
84  Window& getParentWindow() const noexcept { return getWindow(); }
+
85 
+
86 private:
+
87  struct PrivateData;
+
88  PrivateData* const pData;
+
89  friend class Window;
+
90 #ifdef DISTRHO_DEFINES_H_INCLUDED
+
91  friend class DISTRHO_NAMESPACE::UI;
+
92 #endif
+
93 
+
94  DISTRHO_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR(TopLevelWidget)
+
95 };
+
96 
+
97 // -----------------------------------------------------------------------
+
98 
+
99 END_NAMESPACE_DGL
+
100 
+
101 #endif // DGL_TOP_LEVEL_WIDGET_HPP_INCLUDED
+
+
TopLevelWidget::repaint
void repaint() noexcept
+
TopLevelWidget::getApp
Application & getApp() const noexcept
+
Window
Definition: Window.hpp:50
+
Rectangle
Definition: Geometry.hpp:30
+
Application
Definition: Application.hpp:34
+
TopLevelWidget::getWindow
Window & getWindow() const noexcept
+
UI
Definition: DistrhoUI.hpp:67
+
TopLevelWidget::~TopLevelWidget
virtual ~TopLevelWidget()
+
IdleCallback
Definition: Base.hpp:159
+
TopLevelWidget
Definition: TopLevelWidget.hpp:46
+
Widget
Definition: Widget.hpp:53
+ + + + diff --git a/Vulkan_8hpp_source.html b/Vulkan_8hpp_source.html new file mode 100644 index 00000000..1bbbdae3 --- /dev/null +++ b/Vulkan_8hpp_source.html @@ -0,0 +1,194 @@ + + + + + + + +DISTRHO Plugin Framework: dgl/Vulkan.hpp Source File + + + + + + + + + +
+
+ + + + + + +
+
DISTRHO Plugin Framework +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
Vulkan.hpp
+
+
+
1 /*
+
2  * DISTRHO Plugin Framework (DPF)
+
3  * Copyright (C) 2012-2021 Filipe Coelho <falktx@falktx.com>
+
4  *
+
5  * Permission to use, copy, modify, and/or distribute this software for any purpose with
+
6  * or without fee is hereby granted, provided that the above copyright notice and this
+
7  * permission notice appear in all copies.
+
8  *
+
9  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD
+
10  * TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN
+
11  * NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
+
12  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER
+
13  * IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
+
14  * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
15  */
+
16 
+
17 #ifndef DGL_VULKAN_HPP_INCLUDED
+
18 #define DGL_VULKAN_HPP_INCLUDED
+
19 
+
20 #include "ImageBase.hpp"
+
21 
+
22 #include <vulkan/vulkan_core.h>
+
23 
+
24 START_NAMESPACE_DGL
+
25 
+
26 // --------------------------------------------------------------------------------------------------------------------
+
27 
+
28 /**
+
29  Vulkan Graphics context.
+
30  */
+ +
32 {
+
33 };
+
34 
+
35 // --------------------------------------------------------------------------------------------------------------------
+
36 
+
37 /**
+
38  Vulkan Image class.
+
39 
+
40  TODO ...
+
41  */
+
42 class VulkanImage : public ImageBase
+
43 {
+
44 public:
+
45  /**
+
46  Constructor for a null Image.
+
47  */
+
48  VulkanImage();
+
49 
+
50  /**
+
51  Constructor using raw image data.
+
52  @note @a rawData must remain valid for the lifetime of this Image.
+
53  */
+
54  VulkanImage(const char* rawData, uint width, uint height, ImageFormat format);
+
55 
+
56  /**
+
57  Constructor using raw image data.
+
58  @note @a rawData must remain valid for the lifetime of this Image.
+
59  */
+
60  VulkanImage(const char* rawData, const Size<uint>& size, ImageFormat format);
+
61 
+
62  /**
+
63  Constructor using another image data.
+
64  */
+
65  VulkanImage(const VulkanImage& image);
+
66 
+
67  /**
+
68  Destructor.
+
69  */
+
70  ~VulkanImage() override;
+
71 
+
72  /**
+
73  Load image data from memory.
+
74  @note @a rawData must remain valid for the lifetime of this Image.
+
75  */
+
76  void loadFromMemory(const char* rawData,
+
77  const Size<uint>& size,
+
78  ImageFormat format = kImageFormatBGRA) noexcept override;
+
79 
+
80  /**
+
81  Draw this image at position @a pos using the graphics context @a context.
+
82  */
+
83  void drawAt(const GraphicsContext& context, const Point<int>& pos) override;
+
84 
+
85  /**
+
86  TODO document this.
+
87  */
+
88  VulkanImage& operator=(const VulkanImage& image) noexcept;
+
89 
+
90  // FIXME this should not be needed
+
91  inline void loadFromMemory(const char* rawData, uint w, uint h, ImageFormat format = kImageFormatBGRA)
+
92  { loadFromMemory(rawData, Size<uint>(w, h), format); };
+
93  inline void draw(const GraphicsContext& context)
+
94  { drawAt(context, Point<int>(0, 0)); };
+
95  inline void drawAt(const GraphicsContext& context, int x, int y)
+
96  { drawAt(context, Point<int>(x, y)); };
+
97 };
+
98 
+
99 // --------------------------------------------------------------------------------------------------------------------
+
100 
+
101 END_NAMESPACE_DGL
+
102 
+
103 #endif
+
+
VulkanImage
Definition: Vulkan.hpp:42
+
GraphicsContext
Definition: Base.hpp:154
+
Size< uint >
+
VulkanImage::drawAt
void drawAt(const GraphicsContext &context, const Point< int > &pos) override
+
VulkanImage::~VulkanImage
~VulkanImage() override
+
VulkanImage::loadFromMemory
void loadFromMemory(const char *rawData, const Size< uint > &size, ImageFormat format=kImageFormatBGRA) noexcept override
+
ImageBase
Definition: ImageBase.hpp:44
+
VulkanImage::operator=
VulkanImage & operator=(const VulkanImage &image) noexcept
+
VulkanGraphicsContext
Definition: Vulkan.hpp:31
+
Point< int >
+
VulkanImage::VulkanImage
VulkanImage()
+ + + + diff --git a/classAudioMidiSyncHelper-members.html b/classAudioMidiSyncHelper-members.html new file mode 100644 index 00000000..ee17065d --- /dev/null +++ b/classAudioMidiSyncHelper-members.html @@ -0,0 +1,85 @@ + + + + + + + +DISTRHO Plugin Framework: Member List + + + + + + + + + +
+
+ + + + + + +
+
DISTRHO Plugin Framework +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ +
+
+
+
AudioMidiSyncHelper Member List
+
+
+ +

This is the complete list of members for AudioMidiSyncHelper, including all inherited members.

+ + + + + + + +
AudioMidiSyncHelper(float **const o, uint32_t f, const MidiEvent *m, uint32_t mc)AudioMidiSyncHelperinline
frames (defined in AudioMidiSyncHelper)AudioMidiSyncHelper
midiEventCount (defined in AudioMidiSyncHelper)AudioMidiSyncHelper
midiEvents (defined in AudioMidiSyncHelper)AudioMidiSyncHelper
nextEvent()AudioMidiSyncHelperinline
outputsAudioMidiSyncHelper
+ + + + diff --git a/classAudioMidiSyncHelper.html b/classAudioMidiSyncHelper.html new file mode 100644 index 00000000..f764bc81 --- /dev/null +++ b/classAudioMidiSyncHelper.html @@ -0,0 +1,222 @@ + + + + + + + +DISTRHO Plugin Framework: AudioMidiSyncHelper Class Reference + + + + + + + + + +
+
+ + + + + + +
+
DISTRHO Plugin Framework +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ +
+
+
+Public Member Functions | +Public Attributes | +List of all members
+
+
AudioMidiSyncHelper Class Reference
+
+
+ +

#include <DistrhoPluginUtils.hpp>

+ + + + + + +

+Public Member Functions

 AudioMidiSyncHelper (float **const o, uint32_t f, const MidiEvent *m, uint32_t mc)
 
bool nextEvent ()
 
+ + + + + + + + + +

+Public Attributes

float * outputs [2]
 
+uint32_t frames
 
+const MidiEventmidiEvents
 
+uint32_t midiEventCount
 
+

Detailed Description

+

Handy class to help keep audio buffer in sync with incoming MIDI events. To use it, create a local variable (on the stack) and call nextEvent() until it returns false.

for (AudioMidiSyncHelper amsh(outputs, frames, midiEvents, midiEventCount); amsh.nextEvent();)
+
{
+
float* const outL = amsh.outputs[0];
+
float* const outR = amsh.outputs[1];
+
+
for (uint32_t i=0; i<amsh.midiEventCount; ++i)
+
{
+
const MidiEvent& ev(amsh.midiEvents[i]);
+
// ... do something with the midi event
+
}
+
+
renderSynth(outL, outR, amsh.frames);
+
}
+

Some important notes when using this class:

    +
  1. MidiEvent::frame retains its original value, but it is useless, do not use it.
  2. +
  3. The class variables names are be the same as the default ones in the run function. Keep that in mind and try to avoid typos. :)
  4. +
+

Constructor & Destructor Documentation

+ +

◆ AudioMidiSyncHelper()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
AudioMidiSyncHelper::AudioMidiSyncHelper (float **const o,
uint32_t f,
const MidiEventm,
uint32_t mc 
)
+
+inline
+
+

Constructor, using values from the run function.

+ +
+
+

Member Function Documentation

+ +

◆ nextEvent()

+ +
+
+ + + + + +
+ + + + + + + +
bool AudioMidiSyncHelper::nextEvent ()
+
+inline
+
+

Process a batch of events untill no more are available. You must not read any more values from this class after this function returns false.

+ +
+
+

Member Data Documentation

+ +

◆ outputs

+ +
+
+ + + + +
float* AudioMidiSyncHelper::outputs[2]
+
+

Parameters from the run function, adjusted for event sync

+ +
+
+
The documentation for this class was generated from the following file: +
+
MidiEvent
Definition: DistrhoPlugin.hpp:502
+
AudioMidiSyncHelper::outputs
float * outputs[2]
Definition: DistrhoPluginUtils.hpp:53
+
AudioMidiSyncHelper::nextEvent
bool nextEvent()
Definition: DistrhoPluginUtils.hpp:78
+
AudioMidiSyncHelper
Definition: DistrhoPluginUtils.hpp:50
+ + + + diff --git a/classCairoBaseWidget-members.html b/classCairoBaseWidget-members.html new file mode 100644 index 00000000..d8e65029 --- /dev/null +++ b/classCairoBaseWidget-members.html @@ -0,0 +1,85 @@ + + + + + + + +DISTRHO Plugin Framework: Member List + + + + + + + + + +
+
+ + + + + + +
+
DISTRHO Plugin Framework +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ +
+
+
+
CairoBaseWidget< BaseWidget > Member List
+
+
+ +

This is the complete list of members for CairoBaseWidget< BaseWidget >, including all inherited members.

+ + + + + + + +
CairoBaseWidget(Widget *const parentGroupWidget)CairoBaseWidget< BaseWidget >explicit
CairoBaseWidget(Window &windowToMapTo)CairoBaseWidget< BaseWidget >explicit
CairoBaseWidget(Application &app)CairoBaseWidget< BaseWidget >explicit
CairoBaseWidget(Application &app, Window &parentWindow)CairoBaseWidget< BaseWidget >explicit
onCairoDisplay(const CairoGraphicsContext &context)=0CairoBaseWidget< BaseWidget >protectedpure virtual
~CairoBaseWidget()CairoBaseWidget< BaseWidget >inlinevirtual
+ + + + diff --git a/classCairoBaseWidget.html b/classCairoBaseWidget.html new file mode 100644 index 00000000..b75acefa --- /dev/null +++ b/classCairoBaseWidget.html @@ -0,0 +1,300 @@ + + + + + + + +DISTRHO Plugin Framework: CairoBaseWidget< BaseWidget > Class Template Reference + + + + + + + + + +
+
+ + + + + + +
+
DISTRHO Plugin Framework +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ +
+
+
+Public Member Functions | +Protected Member Functions | +List of all members
+
+
CairoBaseWidget< BaseWidget > Class Template Referenceabstract
+
+
+ +

#include <Cairo.hpp>

+
+Inheritance diagram for CairoBaseWidget< BaseWidget >:
+
+
+ +
+ + + + + + + + + + + + +

+Public Member Functions

 CairoBaseWidget (Widget *const parentGroupWidget)
 
 CairoBaseWidget (Window &windowToMapTo)
 
 CairoBaseWidget (Application &app)
 
 CairoBaseWidget (Application &app, Window &parentWindow)
 
virtual ~CairoBaseWidget ()
 
+ + + +

+Protected Member Functions

virtual void onCairoDisplay (const CairoGraphicsContext &context)=0
 
+

Detailed Description

+

template<class BaseWidget>
+class CairoBaseWidget< BaseWidget >

+ +

CairoWidget, handy class that takes graphics context during onDisplay and passes it in a new function.

+

Constructor & Destructor Documentation

+ +

◆ CairoBaseWidget() [1/4]

+ +
+
+
+template<class BaseWidget >
+ + + + + +
+ + + + + + + + +
CairoBaseWidget< BaseWidget >::CairoBaseWidget (Widget *const parentGroupWidget)
+
+explicit
+
+

Constructor for a CairoSubWidget.

See also
CreateFlags
+ +
+
+ +

◆ CairoBaseWidget() [2/4]

+ +
+
+
+template<class BaseWidget >
+ + + + + +
+ + + + + + + + +
CairoBaseWidget< BaseWidget >::CairoBaseWidget (WindowwindowToMapTo)
+
+explicit
+
+

Constructor for a CairoTopLevelWidget.

See also
CreateFlags
+ +
+
+ +

◆ CairoBaseWidget() [3/4]

+ +
+
+
+template<class BaseWidget >
+ + + + + +
+ + + + + + + + +
CairoBaseWidget< BaseWidget >::CairoBaseWidget (Applicationapp)
+
+explicit
+
+

Constructor for a CairoStandaloneWindow without parent window.

See also
CreateFlags
+ +
+
+ +

◆ CairoBaseWidget() [4/4]

+ +
+
+
+template<class BaseWidget >
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
CairoBaseWidget< BaseWidget >::CairoBaseWidget (Applicationapp,
WindowparentWindow 
)
+
+explicit
+
+

Constructor for a CairoStandaloneWindow with parent window.

See also
CreateFlags
+ +
+
+ +

◆ ~CairoBaseWidget()

+ +
+
+
+template<class BaseWidget >
+ + + + + +
+ + + + + + + +
virtual CairoBaseWidget< BaseWidget >::~CairoBaseWidget ()
+
+inlinevirtual
+
+

Destructor.

+ +
+
+

Member Function Documentation

+ +

◆ onCairoDisplay()

+ +
+
+
+template<class BaseWidget >
+ + + + + +
+ + + + + + + + +
virtual void CairoBaseWidget< BaseWidget >::onCairoDisplay (const CairoGraphicsContextcontext)
+
+protectedpure virtual
+
+

New virtual onDisplay function.

See also
onDisplay
+ +
+
+
The documentation for this class was generated from the following file: +
+ + + + diff --git a/classCairoBaseWidget.png b/classCairoBaseWidget.png new file mode 100644 index 00000000..71cfd414 Binary files /dev/null and b/classCairoBaseWidget.png differ diff --git a/classCairoImage-members.html b/classCairoImage-members.html new file mode 100644 index 00000000..15b6775f --- /dev/null +++ b/classCairoImage-members.html @@ -0,0 +1,108 @@ + + + + + + + +DISTRHO Plugin Framework: Member List + + + + + + + + + +
+
+ + + + + + +
+
DISTRHO Plugin Framework +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ +
+
+
+
CairoImage Member List
+
+
+ +

This is the complete list of members for CairoImage, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
CairoImage()CairoImage
CairoImage(const char *rawData, uint width, uint height, ImageFormat format)CairoImage
CairoImage(const char *rawData, const Size< uint > &size, ImageFormat format)CairoImage
CairoImage(const CairoImage &image)CairoImage
draw(const GraphicsContext &context) (defined in CairoImage)CairoImageinline
drawAt(const GraphicsContext &context, const Point< int > &pos) overrideCairoImagevirtual
drawAt(const GraphicsContext &context, int x, int y) (defined in CairoImage)CairoImageinline
format (defined in ImageBase)ImageBaseprotected
getFormat() const noexceptImageBase
getHeight() const noexceptImageBase
getRawData() const noexceptImageBase
getSize() const noexceptImageBase
getWidth() const noexceptImageBase
ImageBase()ImageBaseprotected
ImageBase(const char *rawData, uint width, uint height, ImageFormat format)ImageBaseprotected
ImageBase(const char *rawData, const Size< uint > &size, ImageFormat format)ImageBaseprotected
ImageBase(const ImageBase &image)ImageBaseprotected
isInvalid() const noexceptImageBase
isValid() const noexceptImageBase
loadFromMemory(const char *rawData, const Size< uint > &size, ImageFormat format=kImageFormatBGRA) noexcept overrideCairoImagevirtual
loadFromMemory(const char *rawData, uint w, uint h, ImageFormat format=kImageFormatBGRA) (defined in CairoImage)CairoImageinline
operator!=(const ImageBase &image) const noexcept (defined in ImageBase)ImageBase
operator=(const CairoImage &image) noexceptCairoImage
ImageBase::operator=(const ImageBase &image) noexceptImageBase
operator==(const ImageBase &image) const noexcept (defined in ImageBase)ImageBase
rawData (defined in ImageBase)ImageBaseprotected
size (defined in ImageBase)ImageBaseprotected
~CairoImage() overrideCairoImage
~ImageBase()ImageBasevirtual
+ + + + diff --git a/classCairoImage.html b/classCairoImage.html new file mode 100644 index 00000000..8f3c7833 --- /dev/null +++ b/classCairoImage.html @@ -0,0 +1,430 @@ + + + + + + + +DISTRHO Plugin Framework: CairoImage Class Reference + + + + + + + + + +
+
+ + + + + + +
+
DISTRHO Plugin Framework +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ +
+
+
+Public Member Functions | +List of all members
+
+
CairoImage Class Reference
+
+
+ +

#include <Cairo.hpp>

+
+Inheritance diagram for CairoImage:
+
+
+ + +ImageBase + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 CairoImage ()
 
 CairoImage (const char *rawData, uint width, uint height, ImageFormat format)
 
 CairoImage (const char *rawData, const Size< uint > &size, ImageFormat format)
 
 CairoImage (const CairoImage &image)
 
 ~CairoImage () override
 
void loadFromMemory (const char *rawData, const Size< uint > &size, ImageFormat format=kImageFormatBGRA) noexcept override
 
void drawAt (const GraphicsContext &context, const Point< int > &pos) override
 
CairoImageoperator= (const CairoImage &image) noexcept
 
+void loadFromMemory (const char *rawData, uint w, uint h, ImageFormat format=kImageFormatBGRA)
 
+void draw (const GraphicsContext &context)
 
+void drawAt (const GraphicsContext &context, int x, int y)
 
- Public Member Functions inherited from ImageBase
virtual ~ImageBase ()
 
bool isValid () const noexcept
 
bool isInvalid () const noexcept
 
uint getWidth () const noexcept
 
uint getHeight () const noexcept
 
const Size< uint > & getSize () const noexcept
 
const char * getRawData () const noexcept
 
ImageFormat getFormat () const noexcept
 
void loadFromMemory (const char *rawData, uint width, uint height, ImageFormat format=kImageFormatBGRA) noexcept
 
void draw (const GraphicsContext &context)
 
void drawAt (const GraphicsContext &context, int x, int y)
 
ImageBaseoperator= (const ImageBase &image) noexcept
 
+bool operator== (const ImageBase &image) const noexcept
 
+bool operator!= (const ImageBase &image) const noexcept
 
+ + + + + + + + + + + + + + + + + +

+Additional Inherited Members

- Protected Member Functions inherited from ImageBase
 ImageBase ()
 
 ImageBase (const char *rawData, uint width, uint height, ImageFormat format)
 
 ImageBase (const char *rawData, const Size< uint > &size, ImageFormat format)
 
 ImageBase (const ImageBase &image)
 
- Protected Attributes inherited from ImageBase
+const char * rawData
 
+Size< uint > size
 
+ImageFormat format
 
+

Detailed Description

+

Cairo Image class.

+

TODO ...

+

Constructor & Destructor Documentation

+ +

◆ CairoImage() [1/4]

+ +
+
+ + + + + + + +
CairoImage::CairoImage ()
+
+

Constructor for a null Image.

+ +
+
+ +

◆ CairoImage() [2/4]

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
CairoImage::CairoImage (const char * rawData,
uint width,
uint height,
ImageFormat format 
)
+
+

Constructor using raw image data.

Note
rawData must remain valid for the lifetime of this Image.
+ +
+
+ +

◆ CairoImage() [3/4]

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
CairoImage::CairoImage (const char * rawData,
const Size< uint > & size,
ImageFormat format 
)
+
+

Constructor using raw image data.

Note
rawData must remain valid for the lifetime of this Image.
+ +
+
+ +

◆ CairoImage() [4/4]

+ +
+
+ + + + + + + + +
CairoImage::CairoImage (const CairoImageimage)
+
+

Constructor using another image data.

+ +
+
+ +

◆ ~CairoImage()

+ +
+
+ + + + + +
+ + + + + + + +
CairoImage::~CairoImage ()
+
+override
+
+

Destructor.

+ +
+
+

Member Function Documentation

+ +

◆ loadFromMemory()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
void CairoImage::loadFromMemory (const char * rawData,
const Size< uint > & size,
ImageFormat format = kImageFormatBGRA 
)
+
+overridevirtualnoexcept
+
+

Load image data from memory.

Note
rawData must remain valid for the lifetime of this Image.
+ +

Reimplemented from ImageBase.

+ +
+
+ +

◆ drawAt()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
void CairoImage::drawAt (const GraphicsContextcontext,
const Point< int > & pos 
)
+
+overridevirtual
+
+

Draw this image at position pos using the graphics context context.

+ +

Implements ImageBase.

+ +
+
+ +

◆ operator=()

+ +
+
+ + + + + +
+ + + + + + + + +
CairoImage& CairoImage::operator= (const CairoImageimage)
+
+noexcept
+
+

TODO document this.

+ +
+
+
The documentation for this class was generated from the following file: +
+ + + + diff --git a/classCairoImage.png b/classCairoImage.png new file mode 100644 index 00000000..39e1d3a3 Binary files /dev/null and b/classCairoImage.png differ diff --git a/classImageBaseAboutWindow-members.html b/classImageBaseAboutWindow-members.html new file mode 100644 index 00000000..e313ece1 --- /dev/null +++ b/classImageBaseAboutWindow-members.html @@ -0,0 +1,145 @@ + + + + + + + +DISTRHO Plugin Framework: Member List + + + + + + + + + +
+
+ + + + + + +
+
DISTRHO Plugin Framework +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ +
+
+
+
ImageBaseAboutWindow< ImageType > Member List
+
+
+ +

This is the complete list of members for ImageBaseAboutWindow< ImageType >, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
addIdleCallback(IdleCallback *callback, uint timerFrequencyInMs=0) (defined in StandaloneWindow)StandaloneWindowinline
close()Window
exec(bool blockWait=false) (defined in Window)Windowinline
focus()Window
Window::getApp() const noexceptWindow
TopLevelWidget::getApp() const noexceptTopLevelWidget
getGraphicsContext() const noexcept (defined in StandaloneWindow)StandaloneWindowinline
getHeight() const noexcept (defined in StandaloneWindow)StandaloneWindowinline
getId() const noexceptWidget
getIgnoringKeyRepeat() const noexcept (defined in Window)Windowinline
getNativeWindowHandle() const noexceptWindow
getParentApp() const noexcept (defined in TopLevelWidget)TopLevelWidgetinline
getParentWindow() const noexcept (defined in TopLevelWidget)TopLevelWidgetinline
Window::getScaleFactor() const noexceptWindow
getScaleFactor() const noexcept (defined in TopLevelWidget)TopLevelWidget
getScaling() const noexcept (defined in Window)Windowinline
getSize() const noexcept (defined in StandaloneWindow)StandaloneWindowinline
getTitle() const noexceptWindow
getTopLevelWidget() const noexceptWidget
getWidth() const noexcept (defined in StandaloneWindow)StandaloneWindowinline
getWindow() const noexceptTopLevelWidget
hide() (defined in StandaloneWindow)StandaloneWindowinline
ImageBaseAboutWindow(Window &parentWindow, const ImageType &image=ImageType()) (defined in ImageBaseAboutWindow< ImageType >)ImageBaseAboutWindow< ImageType >explicit
ImageBaseAboutWindow(TopLevelWidget *parentTopLevelWidget, const ImageType &image=ImageType()) (defined in ImageBaseAboutWindow< ImageType >)ImageBaseAboutWindow< ImageType >explicit
isEmbed() const noexceptWindow
isIgnoringKeyRepeat() const noexceptWindow
isResizable() const noexcept (defined in Window)Window
isVisible() const noexceptStandaloneWindowinline
onCharacterInput(const CharacterInputEvent &)Widgetprotectedvirtual
onClose()Windowprotectedvirtual
onDisplay() overrideImageBaseAboutWindow< ImageType >protectedvirtual
onFocus(bool focus, CrossingMode mode)Windowprotectedvirtual
onKeyboard(const KeyboardEvent &) overrideImageBaseAboutWindow< ImageType >protectedvirtual
onMotion(const MotionEvent &)Widgetprotectedvirtual
onMouse(const MouseEvent &) overrideImageBaseAboutWindow< ImageType >protectedvirtual
onReshape(uint width, uint height) overrideImageBaseAboutWindow< ImageType >protectedvirtual
onResize(const ResizeEvent &)Widgetprotectedvirtual
onScroll(const ScrollEvent &)Widgetprotectedvirtual
onSpecial(const SpecialEvent &)Widgetprotectedvirtual
removeIdleCallback(IdleCallback *callback) (defined in StandaloneWindow)StandaloneWindowinline
repaint() noexceptStandaloneWindowinlinevirtual
Window::repaint(const Rectangle< uint > &rect) noexceptWindow
repaint(const Rectangle< uint > &rect) noexcept (defined in TopLevelWidget)TopLevelWidget
runAsModal(bool blockWait=false)Window
setGeometryConstraints(uint minimumWidth, uint minimumHeight, bool keepAspectRatio=false, bool automaticallyScale=false) (defined in StandaloneWindow)StandaloneWindowinline
setHeight(uint height) (defined in StandaloneWindow)StandaloneWindowinline
setId(uint id) noexceptWidget
setIgnoringKeyRepeat(bool ignore) noexceptWindow
setImage(const ImageType &image) (defined in ImageBaseAboutWindow< ImageType >)ImageBaseAboutWindow< ImageType >
setResizable(bool resizable) (defined in Window)Window
setSize(uint width, uint height) (defined in StandaloneWindow)StandaloneWindowinline
setSize(const Size< uint > &size) (defined in StandaloneWindow)StandaloneWindowinline
setTitle(const char *title)Window
setVisible(bool yesNo) (defined in StandaloneWindow)StandaloneWindowinline
setWidth(uint width) (defined in StandaloneWindow)StandaloneWindowinline
show() (defined in StandaloneWindow)StandaloneWindowinline
StandaloneWindow(Application &app)StandaloneWindowinline
StandaloneWindow(Application &app, Window &parentWindow)StandaloneWindowinline
TopLevelWidget(Window &windowToMapTo)TopLevelWidgetexplicit
Window::Window(Application &app)Windowexplicit
Window::Window(Application &app, Window &parent)Windowexplicit
Window::Window(Application &app, uintptr_t parentWindowHandle, double scaleFactor, bool resizable)Windowexplicit
Window::Window(Application &app, uintptr_t parentWindowHandle, uint width, uint height, double scaleFactor, bool resizable)Windowexplicit
~TopLevelWidget()TopLevelWidgetvirtual
~Widget()Widgetvirtual
~Window()Windowvirtual
+ + + + diff --git a/classImageBaseAboutWindow.html b/classImageBaseAboutWindow.html new file mode 100644 index 00000000..f0e5cf6c --- /dev/null +++ b/classImageBaseAboutWindow.html @@ -0,0 +1,477 @@ + + + + + + + +DISTRHO Plugin Framework: ImageBaseAboutWindow< ImageType > Class Template Reference + + + + + + + + + +
+
+ + + + + + +
+
DISTRHO Plugin Framework +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ +
+
+
+Public Member Functions | +Protected Member Functions | +List of all members
+
+
ImageBaseAboutWindow< ImageType > Class Template Reference
+
+
+
+Inheritance diagram for ImageBaseAboutWindow< ImageType >:
+
+
+ + +StandaloneWindow +Window +TopLevelWidget +Widget + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

ImageBaseAboutWindow (Window &parentWindow, const ImageType &image=ImageType())
 
ImageBaseAboutWindow (TopLevelWidget *parentTopLevelWidget, const ImageType &image=ImageType())
 
+void setImage (const ImageType &image)
 
- Public Member Functions inherited from StandaloneWindow
 StandaloneWindow (Application &app)
 
 StandaloneWindow (Application &app, Window &parentWindow)
 
bool isVisible () const noexcept
 
+void setVisible (bool yesNo)
 
+void hide ()
 
+void show ()
 
+uint getWidth () const noexcept
 
+uint getHeight () const noexcept
 
+const Size< uint > getSize () const noexcept
 
void repaint () noexcept
 
+void setWidth (uint width)
 
+void setHeight (uint height)
 
+void setSize (uint width, uint height)
 
+void setSize (const Size< uint > &size)
 
+bool addIdleCallback (IdleCallback *callback, uint timerFrequencyInMs=0)
 
+bool removeIdleCallback (IdleCallback *callback)
 
+const GraphicsContextgetGraphicsContext () const noexcept
 
+void setGeometryConstraints (uint minimumWidth, uint minimumHeight, bool keepAspectRatio=false, bool automaticallyScale=false)
 
- Public Member Functions inherited from Window
 Window (Application &app)
 
 Window (Application &app, Window &parent)
 
 Window (Application &app, uintptr_t parentWindowHandle, double scaleFactor, bool resizable)
 
 Window (Application &app, uintptr_t parentWindowHandle, uint width, uint height, double scaleFactor, bool resizable)
 
virtual ~Window ()
 
bool isEmbed () const noexcept
 
bool isVisible () const noexcept
 
void setVisible (bool visible)
 
void show ()
 
void hide ()
 
void close ()
 
+bool isResizable () const noexcept
 
+void setResizable (bool resizable)
 
uint getWidth () const noexcept
 
uint getHeight () const noexcept
 
Size< uint > getSize () const noexcept
 
void setWidth (uint width)
 
void setHeight (uint height)
 
void setSize (uint width, uint height)
 
void setSize (const Size< uint > &size)
 
const char * getTitle () const noexcept
 
void setTitle (const char *title)
 
bool isIgnoringKeyRepeat () const noexcept
 
void setIgnoringKeyRepeat (bool ignore) noexcept
 
bool addIdleCallback (IdleCallback *callback, uint timerFrequencyInMs=0)
 
bool removeIdleCallback (IdleCallback *callback)
 
ApplicationgetApp () const noexcept
 
const GraphicsContextgetGraphicsContext () const noexcept
 
uintptr_t getNativeWindowHandle () const noexcept
 
double getScaleFactor () const noexcept
 
void focus ()
 
void repaint () noexcept
 
void repaint (const Rectangle< uint > &rect) noexcept
 
void runAsModal (bool blockWait=false)
 
void setGeometryConstraints (uint minimumWidth, uint minimumHeight, bool keepAspectRatio=false, bool automaticallyScale=false)
 
+bool getIgnoringKeyRepeat () const noexcept
 
+double getScaling () const noexcept
 
+void exec (bool blockWait=false)
 
- Public Member Functions inherited from TopLevelWidget
 TopLevelWidget (Window &windowToMapTo)
 
virtual ~TopLevelWidget ()
 
ApplicationgetApp () const noexcept
 
WindowgetWindow () const noexcept
 
+bool addIdleCallback (IdleCallback *callback, uint timerFrequencyInMs=0)
 
+bool removeIdleCallback (IdleCallback *callback)
 
+double getScaleFactor () const noexcept
 
void repaint () noexcept
 
+void repaint (const Rectangle< uint > &rect) noexcept
 
+void setGeometryConstraints (uint minimumWidth, uint minimumHeight, bool keepAspectRatio=false, bool automaticallyScale=false)
 
+ApplicationgetParentApp () const noexcept
 
+WindowgetParentWindow () const noexcept
 
- Public Member Functions inherited from Widget
virtual ~Widget ()
 
bool isVisible () const noexcept
 
void setVisible (bool visible)
 
void show ()
 
void hide ()
 
uint getWidth () const noexcept
 
uint getHeight () const noexcept
 
const Size< uint > getSize () const noexcept
 
void setWidth (uint width) noexcept
 
void setHeight (uint height) noexcept
 
void setSize (uint width, uint height) noexcept
 
void setSize (const Size< uint > &size) noexcept
 
uint getId () const noexcept
 
void setId (uint id) noexcept
 
ApplicationgetApp () const noexcept
 
WindowgetWindow () const noexcept
 
const GraphicsContextgetGraphicsContext () const noexcept
 
TopLevelWidgetgetTopLevelWidget () const noexcept
 
+ApplicationgetParentApp () const noexcept
 
+WindowgetParentWindow () const noexcept
 
+ + + + + + + + + + + + + + + + + + + + + + + + + +

+Protected Member Functions

void onDisplay () override
 
bool onKeyboard (const KeyboardEvent &) override
 
bool onMouse (const MouseEvent &) override
 
void onReshape (uint width, uint height) override
 
- Protected Member Functions inherited from Window
virtual bool onClose ()
 
virtual void onFocus (bool focus, CrossingMode mode)
 
- Protected Member Functions inherited from Widget
virtual bool onSpecial (const SpecialEvent &)
 
virtual bool onCharacterInput (const CharacterInputEvent &)
 
virtual bool onMotion (const MotionEvent &)
 
virtual bool onScroll (const ScrollEvent &)
 
virtual void onResize (const ResizeEvent &)
 
+

Member Function Documentation

+ +

◆ onDisplay()

+ +
+
+
+template<class ImageType >
+ + + + + +
+ + + + + + + +
void ImageBaseAboutWindow< ImageType >::onDisplay ()
+
+overrideprotectedvirtual
+
+

A function called to draw the widget contents.

+ +

Implements Widget.

+ +
+
+ +

◆ onKeyboard()

+ +
+
+
+template<class ImageType >
+ + + + + +
+ + + + + + + + +
bool ImageBaseAboutWindow< ImageType >::onKeyboard (const KeyboardEvent)
+
+overrideprotectedvirtual
+
+

A function called when a key is pressed or released.

Returns
True to stop event propagation, false otherwise.
+ +

Reimplemented from Widget.

+ +
+
+ +

◆ onMouse()

+ +
+
+
+template<class ImageType >
+ + + + + +
+ + + + + + + + +
bool ImageBaseAboutWindow< ImageType >::onMouse (const MouseEvent)
+
+overrideprotectedvirtual
+
+

A function called when a mouse button is pressed or released.

Returns
True to stop event propagation, false otherwise.
+ +

Reimplemented from Widget.

+ +
+
+ +

◆ onReshape()

+ +
+
+
+template<class ImageType >
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
void ImageBaseAboutWindow< ImageType >::onReshape (uint width,
uint height 
)
+
+overrideprotectedvirtual
+
+

A function called when the window is resized. If there is a top-level widget associated with this window, its size will be set right after this function.

+ +

Reimplemented from Window.

+ +
+
+
The documentation for this class was generated from the following file: +
+ + + + diff --git a/classImageBaseAboutWindow.png b/classImageBaseAboutWindow.png new file mode 100644 index 00000000..99d36f65 Binary files /dev/null and b/classImageBaseAboutWindow.png differ diff --git a/classImageBaseButton-members.html b/classImageBaseButton-members.html new file mode 100644 index 00000000..54ce808c --- /dev/null +++ b/classImageBaseButton-members.html @@ -0,0 +1,129 @@ + + + + + + + +DISTRHO Plugin Framework: Member List + + + + + + + + + +
+
+ + + + + + +
+
DISTRHO Plugin Framework +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ +
+
+
+
ImageBaseButton< ImageType > Member List
+
+
+ +

This is the complete list of members for ImageBaseButton< ImageType >, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
contains(T x, T y) const noexceptSubWidget
contains(const Point< T > &pos) const noexceptSubWidget
getAbsoluteArea() const noexceptSubWidget
getAbsolutePos() const noexceptSubWidget
getAbsoluteX() const noexceptSubWidget
getAbsoluteY() const noexceptSubWidget
getApp() const noexceptWidget
getConstrainedAbsoluteArea() const noexceptSubWidget
getGraphicsContext() const noexceptWidget
getHeight() const noexceptWidget
getId() const noexceptWidget
getParentApp() const noexcept (defined in Widget)Widgetinline
getParentWidget() const noexceptSubWidget
getParentWindow() const noexcept (defined in Widget)Widgetinline
getSize() const noexceptWidget
getTopLevelWidget() const noexceptWidget
getWidth() const noexceptWidget
getWindow() const noexceptWidget
hide()Widget
ImageBaseButton(Widget *parentWidget, const ImageType &image) (defined in ImageBaseButton< ImageType >)ImageBaseButton< ImageType >explicit
ImageBaseButton(Widget *parentWidget, const ImageType &imageNormal, const ImageType &imageDown) (defined in ImageBaseButton< ImageType >)ImageBaseButton< ImageType >explicit
ImageBaseButton(Widget *parentWidget, const ImageType &imageNormal, const ImageType &imageHover, const ImageType &imageDown) (defined in ImageBaseButton< ImageType >)ImageBaseButton< ImageType >explicit
isVisible() const noexceptWidget
onCharacterInput(const CharacterInputEvent &)Widgetprotectedvirtual
onDisplay() overrideImageBaseButton< ImageType >protectedvirtual
onKeyboard(const KeyboardEvent &)Widgetprotectedvirtual
onMotion(const MotionEvent &) overrideImageBaseButton< ImageType >protectedvirtual
onMouse(const MouseEvent &) overrideImageBaseButton< ImageType >protectedvirtual
onPositionChanged(const PositionChangedEvent &)SubWidgetprotectedvirtual
onResize(const ResizeEvent &)Widgetprotectedvirtual
onScroll(const ScrollEvent &)Widgetprotectedvirtual
onSpecial(const SpecialEvent &)Widgetprotectedvirtual
repaint() noexcept overrideSubWidgetvirtual
setAbsolutePos(int x, int y) noexceptSubWidget
setAbsolutePos(const Point< int > &pos) noexceptSubWidget
setAbsoluteX(int x) noexceptSubWidget
setAbsoluteY(int y) noexceptSubWidget
setCallback(Callback *callback) noexcept (defined in ImageBaseButton< ImageType >)ImageBaseButton< ImageType >
setHeight(uint height) noexceptWidget
setId(uint id) noexceptWidget
setNeedsFullViewportDrawing(bool needsFullViewportForDrawing=true)SubWidget
setSize(uint width, uint height) noexceptWidget
setSize(const Size< uint > &size) noexceptWidget
setVisible(bool visible)Widget
setWidth(uint width) noexceptWidget
show()Widget
SubWidget(Widget *parentWidget)SubWidgetexplicit
~ImageBaseButton() override (defined in ImageBaseButton< ImageType >)ImageBaseButton< ImageType >
~SubWidget()SubWidgetvirtual
~Widget()Widgetvirtual
+ + + + diff --git a/classImageBaseButton.html b/classImageBaseButton.html new file mode 100644 index 00000000..3abea68f --- /dev/null +++ b/classImageBaseButton.html @@ -0,0 +1,309 @@ + + + + + + + +DISTRHO Plugin Framework: ImageBaseButton< ImageType > Class Template Reference + + + + + + + + + +
+
+ + + + + + +
+
DISTRHO Plugin Framework +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ +
+
+
+Classes | +Public Member Functions | +Protected Member Functions | +List of all members
+
+
ImageBaseButton< ImageType > Class Template Reference
+
+
+
+Inheritance diagram for ImageBaseButton< ImageType >:
+
+
+ + +SubWidget +Widget + +
+ + + + +

+Classes

class  Callback
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

ImageBaseButton (Widget *parentWidget, const ImageType &image)
 
ImageBaseButton (Widget *parentWidget, const ImageType &imageNormal, const ImageType &imageDown)
 
ImageBaseButton (Widget *parentWidget, const ImageType &imageNormal, const ImageType &imageHover, const ImageType &imageDown)
 
+void setCallback (Callback *callback) noexcept
 
- Public Member Functions inherited from SubWidget
 SubWidget (Widget *parentWidget)
 
virtual ~SubWidget ()
 
template<typename T >
bool contains (T x, T y) const noexcept
 
template<typename T >
bool contains (const Point< T > &pos) const noexcept
 
int getAbsoluteX () const noexcept
 
int getAbsoluteY () const noexcept
 
Point< int > getAbsolutePos () const noexcept
 
Rectangle< int > getAbsoluteArea () const noexcept
 
Rectangle< uint > getConstrainedAbsoluteArea () const noexcept
 
void setAbsoluteX (int x) noexcept
 
void setAbsoluteY (int y) noexcept
 
void setAbsolutePos (int x, int y) noexcept
 
void setAbsolutePos (const Point< int > &pos) noexcept
 
WidgetgetParentWidget () const noexcept
 
void repaint () noexcept override
 
void setNeedsFullViewportDrawing (bool needsFullViewportForDrawing=true)
 
- Public Member Functions inherited from Widget
virtual ~Widget ()
 
bool isVisible () const noexcept
 
void setVisible (bool visible)
 
void show ()
 
void hide ()
 
uint getWidth () const noexcept
 
uint getHeight () const noexcept
 
const Size< uint > getSize () const noexcept
 
void setWidth (uint width) noexcept
 
void setHeight (uint height) noexcept
 
void setSize (uint width, uint height) noexcept
 
void setSize (const Size< uint > &size) noexcept
 
uint getId () const noexcept
 
void setId (uint id) noexcept
 
ApplicationgetApp () const noexcept
 
WindowgetWindow () const noexcept
 
const GraphicsContextgetGraphicsContext () const noexcept
 
TopLevelWidgetgetTopLevelWidget () const noexcept
 
+ApplicationgetParentApp () const noexcept
 
+WindowgetParentWindow () const noexcept
 
+ + + + + + + + + + + + + + + + + + + + + +

+Protected Member Functions

void onDisplay () override
 
bool onMouse (const MouseEvent &) override
 
bool onMotion (const MotionEvent &) override
 
- Protected Member Functions inherited from SubWidget
virtual void onPositionChanged (const PositionChangedEvent &)
 
- Protected Member Functions inherited from Widget
virtual bool onKeyboard (const KeyboardEvent &)
 
virtual bool onSpecial (const SpecialEvent &)
 
virtual bool onCharacterInput (const CharacterInputEvent &)
 
virtual bool onScroll (const ScrollEvent &)
 
virtual void onResize (const ResizeEvent &)
 
+

Member Function Documentation

+ +

◆ onDisplay()

+ +
+
+
+template<class ImageType >
+ + + + + +
+ + + + + + + +
void ImageBaseButton< ImageType >::onDisplay ()
+
+overrideprotectedvirtual
+
+

A function called to draw the widget contents.

+ +

Implements Widget.

+ +
+
+ +

◆ onMouse()

+ +
+
+
+template<class ImageType >
+ + + + + +
+ + + + + + + + +
bool ImageBaseButton< ImageType >::onMouse (const MouseEvent)
+
+overrideprotectedvirtual
+
+

A function called when a mouse button is pressed or released.

Returns
True to stop event propagation, false otherwise.
+ +

Reimplemented from Widget.

+ +
+
+ +

◆ onMotion()

+ +
+
+
+template<class ImageType >
+ + + + + +
+ + + + + + + + +
bool ImageBaseButton< ImageType >::onMotion (const MotionEvent)
+
+overrideprotectedvirtual
+
+

A function called when the pointer moves.

Returns
True to stop event propagation, false otherwise.
+ +

Reimplemented from Widget.

+ +
+
+
The documentation for this class was generated from the following file: +
+ + + + diff --git a/classImageBaseButton.png b/classImageBaseButton.png new file mode 100644 index 00000000..a743f757 Binary files /dev/null and b/classImageBaseButton.png differ diff --git a/classImageBaseButton_1_1Callback-members.html b/classImageBaseButton_1_1Callback-members.html new file mode 100644 index 00000000..6109ad12 --- /dev/null +++ b/classImageBaseButton_1_1Callback-members.html @@ -0,0 +1,85 @@ + + + + + + + +DISTRHO Plugin Framework: Member List + + + + + + + + + +
+
+ + + + + + +
+
DISTRHO Plugin Framework +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
ImageBaseButton< ImageType >::Callback Member List
+
+
+ +

This is the complete list of members for ImageBaseButton< ImageType >::Callback, including all inherited members.

+ + + +
imageButtonClicked(ImageBaseButton *imageButton, int button)=0 (defined in ImageBaseButton< ImageType >::Callback)ImageBaseButton< ImageType >::Callbackpure virtual
~Callback() (defined in ImageBaseButton< ImageType >::Callback)ImageBaseButton< ImageType >::Callbackinlinevirtual
+ + + + diff --git a/classImageBaseButton_1_1Callback.html b/classImageBaseButton_1_1Callback.html new file mode 100644 index 00000000..fcede0d5 --- /dev/null +++ b/classImageBaseButton_1_1Callback.html @@ -0,0 +1,93 @@ + + + + + + + +DISTRHO Plugin Framework: ImageBaseButton< ImageType >::Callback Class Reference + + + + + + + + + +
+
+ + + + + + +
+
DISTRHO Plugin Framework +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+Public Member Functions | +List of all members
+
+
ImageBaseButton< ImageType >::Callback Class Referenceabstract
+
+
+ + + + +

+Public Member Functions

+virtual void imageButtonClicked (ImageBaseButton *imageButton, int button)=0
 
+
The documentation for this class was generated from the following file: +
+ + + + diff --git a/classNanoBaseWidget-members.html b/classNanoBaseWidget-members.html new file mode 100644 index 00000000..d7a15bea --- /dev/null +++ b/classNanoBaseWidget-members.html @@ -0,0 +1,204 @@ + + + + + + + +DISTRHO Plugin Framework: Member List + + + + + + + + + +
+
+ + + + + + +
+
DISTRHO Plugin Framework +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ +
+
+
+
NanoBaseWidget< BaseWidget > Member List
+
+
+ +

This is the complete list of members for NanoBaseWidget< BaseWidget >, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Align enum name (defined in NanoVG)NanoVG
ALIGN_BASELINE enum value (defined in NanoVG)NanoVG
ALIGN_BOTTOM enum value (defined in NanoVG)NanoVG
ALIGN_CENTER enum value (defined in NanoVG)NanoVG
ALIGN_LEFT enum value (defined in NanoVG)NanoVG
ALIGN_MIDDLE enum value (defined in NanoVG)NanoVG
ALIGN_RIGHT enum value (defined in NanoVG)NanoVG
ALIGN_TOP enum value (defined in NanoVG)NanoVG
arc(float cx, float cy, float r, float a0, float a1, Winding dir)NanoVG
arcTo(float x1, float y1, float x2, float y2, float radius)NanoVG
beginPath()NanoVG
BEVEL enum value (defined in NanoVG)NanoVG
bezierTo(float c1x, float c1y, float c2x, float c2y, float x, float y)NanoVG
boxGradient(float x, float y, float w, float h, float r, float f, const Color &icol, const Color &ocol)NanoVG
BUTT enum value (defined in NanoVG)NanoVG
CCW enum value (defined in NanoVG)NanoVG
circle(float cx, float cy, float r)NanoVG
closePath()NanoVG
CREATE_ANTIALIAS enum valueNanoVG
CREATE_DEBUG enum valueNanoVG
CREATE_STENCIL_STROKES enum valueNanoVG
CreateFlags enum nameNanoVG
createFontFromFile(const char *name, const char *filename)NanoVG
createFontFromMemory(const char *name, const uchar *data, uint dataSize, bool freeData)NanoVG
createImageFromFile(const char *filename, ImageFlags imageFlags)NanoVG
createImageFromFile(const char *filename, int imageFlags)NanoVG
createImageFromMemory(uchar *data, uint dataSize, ImageFlags imageFlags)NanoVG
createImageFromMemory(uchar *data, uint dataSize, int imageFlags)NanoVG
createImageFromRGBA(uint w, uint h, const uchar *data, ImageFlags imageFlags)NanoVG
createImageFromRGBA(uint w, uint h, const uchar *data, int imageFlags)NanoVG
createImageFromTextureHandle(GLuint textureId, uint w, uint h, ImageFlags imageFlags, bool deleteTexture=false)NanoVG
createImageFromTextureHandle(GLuint textureId, uint w, uint h, int imageFlags, bool deleteTexture=false)NanoVG
currentTransform(float xform[6])NanoVG
CW enum value (defined in NanoVG)NanoVG
degToRad(float deg)NanoVGstatic
ellipse(float cx, float cy, float rx, float ry)NanoVG
fill()NanoVG
fillColor(const Color &color)NanoVG
fillColor(const int red, const int green, const int blue, const int alpha=255)NanoVG
fillColor(const float red, const float green, const float blue, const float alpha=1.0f)NanoVG
fillPaint(const Paint &paint)NanoVG
findFont(const char *name)NanoVG
fontBlur(float blur)NanoVG
fontFace(const char *font)NanoVG
fontFaceId(FontId font)NanoVG
FontId typedef (defined in NanoVG)NanoVG
fontSize(float size)NanoVG
getContext() const noexceptNanoVGinline
globalAlpha(float alpha)NanoVG
HOLE enum value (defined in NanoVG)NanoVG
IMAGE_FLIP_Y enum value (defined in NanoVG)NanoVG
IMAGE_GENERATE_MIPMAPS enum value (defined in NanoVG)NanoVG
IMAGE_PREMULTIPLIED enum value (defined in NanoVG)NanoVG
IMAGE_REPEAT_X enum value (defined in NanoVG)NanoVG
IMAGE_REPEAT_Y enum value (defined in NanoVG)NanoVG
ImageFlags enum name (defined in NanoVG)NanoVG
imagePattern(float ox, float oy, float ex, float ey, float angle, const NanoImage &image, float alpha)NanoVG
intersectScissor(float x, float y, float w, float h)NanoVG
linearGradient(float sx, float sy, float ex, float ey, const Color &icol, const Color &ocol)NanoVG
LineCap enum name (defined in NanoVG)NanoVG
lineCap(LineCap cap=BUTT)NanoVG
lineJoin(LineCap join=MITER)NanoVG
lineTo(float x, float y)NanoVG
loadSharedResources()NanoVGvirtual
MITER enum value (defined in NanoVG)NanoVG
miterLimit(float limit)NanoVG
moveTo(float x, float y)NanoVG
NanoBaseWidget(Widget *const parentGroupWidget, int flags=CREATE_ANTIALIAS)NanoBaseWidget< BaseWidget >explicit
NanoBaseWidget(Window &windowToMapTo, int flags=CREATE_ANTIALIAS)NanoBaseWidget< BaseWidget >explicit
NanoBaseWidget(Application &app, int flags=CREATE_ANTIALIAS)NanoBaseWidget< BaseWidget >explicit
NanoBaseWidget(Application &app, Window &parentWindow, int flags=CREATE_ANTIALIAS)NanoBaseWidget< BaseWidget >explicit
NanoVG(int flags=CREATE_ANTIALIAS)NanoVG
onNanoDisplay()=0NanoBaseWidget< BaseWidget >protectedpure virtual
pathWinding(Winding dir)NanoVG
quadTo(float cx, float cy, float x, float y)NanoVG
radialGradient(float cx, float cy, float inr, float outr, const Color &icol, const Color &ocol)NanoVG
radToDeg(float rad)NanoVGstatic
rect(float x, float y, float w, float h)NanoVG
reset()NanoVG
resetScissor()NanoVG
resetTransform()NanoVG
restore()NanoVG
rotate(float angle)NanoVG
ROUND enum value (defined in NanoVG)NanoVG
roundedRect(float x, float y, float w, float h, float r)NanoVG
save()NanoVG
scale(float x, float y)NanoVG
scissor(float x, float y, float w, float h)NanoVG
skewX(float angle)NanoVG
skewY(float angle)NanoVG
SOLID enum value (defined in NanoVG)NanoVG
Solidity enum name (defined in NanoVG)NanoVG
SQUARE enum value (defined in NanoVG)NanoVG
stroke()NanoVG
strokeColor(const Color &color)NanoVG
strokeColor(const int red, const int green, const int blue, const int alpha=255)NanoVG
strokeColor(const float red, const float green, const float blue, const float alpha=1.0f)NanoVG
strokePaint(const Paint &paint)NanoVG
strokeWidth(float size)NanoVG
text(float x, float y, const char *string, const char *end)NanoVG
textAlign(Align align)NanoVG
textAlign(int align)NanoVG
textBounds(float x, float y, const char *string, const char *end, Rectangle< float > &bounds)NanoVG
textBox(float x, float y, float breakRowWidth, const char *string, const char *end=nullptr)NanoVG
textBoxBounds(float x, float y, float breakRowWidth, const char *string, const char *end, float bounds[4])NanoVG
textBreakLines(const char *string, const char *end, float breakRowWidth, TextRow &rows, int maxRows)NanoVG
textGlyphPositions(float x, float y, const char *string, const char *end, GlyphPosition &positions, int maxPositions)NanoVG
textLetterSpacing(float spacing)NanoVG
textLineHeight(float lineHeight)NanoVG
textMetrics(float *ascender, float *descender, float *lineh)NanoVG
transform(float a, float b, float c, float d, float e, float f)NanoVG
transformIdentity(float dst[6])NanoVGstatic
transformInverse(float dst[6], const float src[6])NanoVGstatic
transformMultiply(float dst[6], const float src[6])NanoVGstatic
transformPoint(float &dstx, float &dsty, const float xform[6], float srcx, float srcy)NanoVGstatic
transformPremultiply(float dst[6], const float src[6])NanoVGstatic
transformRotate(float dst[6], float a)NanoVGstatic
transformScale(float dst[6], float sx, float sy)NanoVGstatic
transformSkewX(float dst[6], float a)NanoVGstatic
transformSkewY(float dst[6], float a)NanoVGstatic
transformTranslate(float dst[6], float tx, float ty)NanoVGstatic
translate(float x, float y)NanoVG
Winding enum name (defined in NanoVG)NanoVG
~NanoBaseWidget()NanoBaseWidget< BaseWidget >inlinevirtual
~NanoVG()NanoVGvirtual
+ + + + diff --git a/classNanoBaseWidget.html b/classNanoBaseWidget.html new file mode 100644 index 00000000..58d407bc --- /dev/null +++ b/classNanoBaseWidget.html @@ -0,0 +1,577 @@ + + + + + + + +DISTRHO Plugin Framework: NanoBaseWidget< BaseWidget > Class Template Reference + + + + + + + + + +
+
+ + + + + + +
+
DISTRHO Plugin Framework +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ +
+
+
+Public Member Functions | +Protected Member Functions | +List of all members
+
+
NanoBaseWidget< BaseWidget > Class Template Referenceabstract
+
+
+ +

#include <NanoVG.hpp>

+
+Inheritance diagram for NanoBaseWidget< BaseWidget >:
+
+
+ + +NanoVG + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 NanoBaseWidget (Widget *const parentGroupWidget, int flags=CREATE_ANTIALIAS)
 
 NanoBaseWidget (Window &windowToMapTo, int flags=CREATE_ANTIALIAS)
 
 NanoBaseWidget (Application &app, int flags=CREATE_ANTIALIAS)
 
 NanoBaseWidget (Application &app, Window &parentWindow, int flags=CREATE_ANTIALIAS)
 
virtual ~NanoBaseWidget ()
 
- Public Member Functions inherited from NanoVG
 NanoVG (int flags=CREATE_ANTIALIAS)
 
virtual ~NanoVG ()
 
NVGcontext * getContext () const noexcept
 
void beginFrame (const uint width, const uint height, const float scaleFactor=1.0f)
 
void beginFrame (Widget *const widget)
 
void cancelFrame ()
 
void endFrame ()
 
void save ()
 
void restore ()
 
void reset ()
 
void strokeColor (const Color &color)
 
void strokeColor (const int red, const int green, const int blue, const int alpha=255)
 
void strokeColor (const float red, const float green, const float blue, const float alpha=1.0f)
 
void strokePaint (const Paint &paint)
 
void fillColor (const Color &color)
 
void fillColor (const int red, const int green, const int blue, const int alpha=255)
 
void fillColor (const float red, const float green, const float blue, const float alpha=1.0f)
 
void fillPaint (const Paint &paint)
 
void miterLimit (float limit)
 
void strokeWidth (float size)
 
void lineCap (LineCap cap=BUTT)
 
void lineJoin (LineCap join=MITER)
 
void globalAlpha (float alpha)
 
void resetTransform ()
 
void transform (float a, float b, float c, float d, float e, float f)
 
void translate (float x, float y)
 
void rotate (float angle)
 
void skewX (float angle)
 
void skewY (float angle)
 
void scale (float x, float y)
 
void currentTransform (float xform[6])
 
NanoImage::Handle createImageFromFile (const char *filename, ImageFlags imageFlags)
 
NanoImage::Handle createImageFromFile (const char *filename, int imageFlags)
 
NanoImage::Handle createImageFromMemory (uchar *data, uint dataSize, ImageFlags imageFlags)
 
NanoImage::Handle createImageFromMemory (uchar *data, uint dataSize, int imageFlags)
 
NanoImage::Handle createImageFromRGBA (uint w, uint h, const uchar *data, ImageFlags imageFlags)
 
NanoImage::Handle createImageFromRGBA (uint w, uint h, const uchar *data, int imageFlags)
 
NanoImage::Handle createImageFromTextureHandle (GLuint textureId, uint w, uint h, ImageFlags imageFlags, bool deleteTexture=false)
 
NanoImage::Handle createImageFromTextureHandle (GLuint textureId, uint w, uint h, int imageFlags, bool deleteTexture=false)
 
Paint linearGradient (float sx, float sy, float ex, float ey, const Color &icol, const Color &ocol)
 
Paint boxGradient (float x, float y, float w, float h, float r, float f, const Color &icol, const Color &ocol)
 
Paint radialGradient (float cx, float cy, float inr, float outr, const Color &icol, const Color &ocol)
 
Paint imagePattern (float ox, float oy, float ex, float ey, float angle, const NanoImage &image, float alpha)
 
void scissor (float x, float y, float w, float h)
 
void intersectScissor (float x, float y, float w, float h)
 
void resetScissor ()
 
void beginPath ()
 
void moveTo (float x, float y)
 
void lineTo (float x, float y)
 
void bezierTo (float c1x, float c1y, float c2x, float c2y, float x, float y)
 
void quadTo (float cx, float cy, float x, float y)
 
void arcTo (float x1, float y1, float x2, float y2, float radius)
 
void closePath ()
 
void pathWinding (Winding dir)
 
void arc (float cx, float cy, float r, float a0, float a1, Winding dir)
 
void rect (float x, float y, float w, float h)
 
void roundedRect (float x, float y, float w, float h, float r)
 
void ellipse (float cx, float cy, float rx, float ry)
 
void circle (float cx, float cy, float r)
 
void fill ()
 
void stroke ()
 
FontId createFontFromFile (const char *name, const char *filename)
 
FontId createFontFromMemory (const char *name, const uchar *data, uint dataSize, bool freeData)
 
FontId findFont (const char *name)
 
void fontSize (float size)
 
void fontBlur (float blur)
 
void textLetterSpacing (float spacing)
 
void textLineHeight (float lineHeight)
 
void textAlign (Align align)
 
void textAlign (int align)
 
void fontFaceId (FontId font)
 
void fontFace (const char *font)
 
float text (float x, float y, const char *string, const char *end)
 
void textBox (float x, float y, float breakRowWidth, const char *string, const char *end=nullptr)
 
float textBounds (float x, float y, const char *string, const char *end, Rectangle< float > &bounds)
 
void textBoxBounds (float x, float y, float breakRowWidth, const char *string, const char *end, float bounds[4])
 
int textGlyphPositions (float x, float y, const char *string, const char *end, GlyphPosition &positions, int maxPositions)
 
void textMetrics (float *ascender, float *descender, float *lineh)
 
int textBreakLines (const char *string, const char *end, float breakRowWidth, TextRow &rows, int maxRows)
 
virtual bool loadSharedResources ()
 
+ + + +

+Protected Member Functions

virtual void onNanoDisplay ()=0
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Additional Inherited Members

- Public Types inherited from NanoVG
enum  CreateFlags { CREATE_ANTIALIAS = 1 << 0, +CREATE_STENCIL_STROKES = 1 << 1, +CREATE_DEBUG = 1 << 2 + }
 
enum  ImageFlags {
+  IMAGE_GENERATE_MIPMAPS = 1 << 0, +IMAGE_REPEAT_X = 1 << 1, +IMAGE_REPEAT_Y = 1 << 2, +IMAGE_FLIP_Y = 1 << 3, +
+  IMAGE_PREMULTIPLIED = 1 << 4 +
+ }
 
enum  Align {
+  ALIGN_LEFT = 1 << 0, +ALIGN_CENTER = 1 << 1, +ALIGN_RIGHT = 1 << 2, +ALIGN_TOP = 1 << 3, +
+  ALIGN_MIDDLE = 1 << 4, +ALIGN_BOTTOM = 1 << 5, +ALIGN_BASELINE = 1 << 6 +
+ }
 
enum  LineCap {
+  BUTT, +ROUND, +SQUARE, +BEVEL, +
+  MITER +
+ }
 
enum  Solidity { SOLID = 1, +HOLE = 2 + }
 
enum  Winding { CCW = 1, +CW = 2 + }
 
+typedef int FontId
 
- Static Public Member Functions inherited from NanoVG
static void transformIdentity (float dst[6])
 
static void transformTranslate (float dst[6], float tx, float ty)
 
static void transformScale (float dst[6], float sx, float sy)
 
static void transformRotate (float dst[6], float a)
 
static void transformSkewX (float dst[6], float a)
 
static void transformSkewY (float dst[6], float a)
 
static void transformMultiply (float dst[6], const float src[6])
 
static void transformPremultiply (float dst[6], const float src[6])
 
static int transformInverse (float dst[6], const float src[6])
 
static void transformPoint (float &dstx, float &dsty, const float xform[6], float srcx, float srcy)
 
static float degToRad (float deg)
 
static float radToDeg (float rad)
 
+

Detailed Description

+

template<class BaseWidget>
+class NanoBaseWidget< BaseWidget >

+ +

NanoVG Widget class.

+

This class implements the NanoVG drawing API inside a DGL Widget. The drawing function onDisplay() is implemented internally but a new onNanoDisplay() needs to be overridden instead.

+

Constructor & Destructor Documentation

+ +

◆ NanoBaseWidget() [1/4]

+ +
+
+
+template<class BaseWidget >
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
NanoBaseWidget< BaseWidget >::NanoBaseWidget (Widget *const parentGroupWidget,
int flags = CREATE_ANTIALIAS 
)
+
+explicit
+
+

Constructor for a NanoSubWidget.

See also
CreateFlags
+ +
+
+ +

◆ NanoBaseWidget() [2/4]

+ +
+
+
+template<class BaseWidget >
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
NanoBaseWidget< BaseWidget >::NanoBaseWidget (WindowwindowToMapTo,
int flags = CREATE_ANTIALIAS 
)
+
+explicit
+
+

Constructor for a NanoTopLevelWidget.

See also
CreateFlags
+ +
+
+ +

◆ NanoBaseWidget() [3/4]

+ +
+
+
+template<class BaseWidget >
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
NanoBaseWidget< BaseWidget >::NanoBaseWidget (Applicationapp,
int flags = CREATE_ANTIALIAS 
)
+
+explicit
+
+

Constructor for a NanoStandaloneWindow without parent window.

See also
CreateFlags
+ +
+
+ +

◆ NanoBaseWidget() [4/4]

+ +
+
+
+template<class BaseWidget >
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
NanoBaseWidget< BaseWidget >::NanoBaseWidget (Applicationapp,
WindowparentWindow,
int flags = CREATE_ANTIALIAS 
)
+
+explicit
+
+

Constructor for a NanoStandaloneWindow with parent window.

See also
CreateFlags
+ +
+
+ +

◆ ~NanoBaseWidget()

+ +
+
+
+template<class BaseWidget >
+ + + + + +
+ + + + + + + +
virtual NanoBaseWidget< BaseWidget >::~NanoBaseWidget ()
+
+inlinevirtual
+
+

Destructor.

+ +
+
+

Member Function Documentation

+ +

◆ onNanoDisplay()

+ +
+
+
+template<class BaseWidget >
+ + + + + +
+ + + + + + + +
virtual void NanoBaseWidget< BaseWidget >::onNanoDisplay ()
+
+protectedpure virtual
+
+

New virtual onDisplay function.

See also
onDisplay
+ +
+
+
The documentation for this class was generated from the following file: +
+ + + + diff --git a/classNanoBaseWidget.png b/classNanoBaseWidget.png new file mode 100644 index 00000000..5556c134 Binary files /dev/null and b/classNanoBaseWidget.png differ diff --git a/classOpenGLImage-members.html b/classOpenGLImage-members.html new file mode 100644 index 00000000..1cfbd84d --- /dev/null +++ b/classOpenGLImage-members.html @@ -0,0 +1,114 @@ + + + + + + + +DISTRHO Plugin Framework: Member List + + + + + + + + + +
+
+ + + + + + +
+
DISTRHO Plugin Framework +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ +
+
+
+
OpenGLImage Member List
+
+
+ +

This is the complete list of members for OpenGLImage, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
draw(const GraphicsContext &context) (defined in OpenGLImage)OpenGLImageinline
draw()OpenGLImage
drawAt(const GraphicsContext &context, const Point< int > &pos) overrideOpenGLImagevirtual
drawAt(const GraphicsContext &context, int x, int y) (defined in OpenGLImage)OpenGLImageinline
drawAt(const int x, const int y)OpenGLImage
drawAt(const Point< int > &pos)OpenGLImage
format (defined in ImageBase)ImageBaseprotected
getFormat() const noexceptImageBase
getHeight() const noexceptImageBase
getRawData() const noexceptImageBase
getSize() const noexceptImageBase
getType() const noexceptOpenGLImageinline
getWidth() const noexceptImageBase
ImageBase()ImageBaseprotected
ImageBase(const char *rawData, uint width, uint height, ImageFormat format)ImageBaseprotected
ImageBase(const char *rawData, const Size< uint > &size, ImageFormat format)ImageBaseprotected
ImageBase(const ImageBase &image)ImageBaseprotected
isInvalid() const noexceptImageBase
isValid() const noexceptImageBase
loadFromMemory(const char *rawData, const Size< uint > &size, ImageFormat format=kImageFormatBGRA) noexcept overrideOpenGLImagevirtual
loadFromMemory(const char *rawData, uint w, uint h, ImageFormat format=kImageFormatBGRA) (defined in OpenGLImage)OpenGLImageinline
OpenGLImage()OpenGLImage
OpenGLImage(const char *rawData, uint width, uint height, ImageFormat format=kImageFormatBGRA)OpenGLImage
OpenGLImage(const char *rawData, const Size< uint > &size, ImageFormat format=kImageFormatBGRA)OpenGLImage
OpenGLImage(const OpenGLImage &image)OpenGLImage
OpenGLImage(const char *rawData, uint width, uint height, GLenum format)OpenGLImageexplicit
OpenGLImage(const char *rawData, const Size< uint > &size, GLenum format)OpenGLImageexplicit
operator!=(const ImageBase &image) const noexcept (defined in ImageBase)ImageBase
operator=(const OpenGLImage &image) noexceptOpenGLImage
ImageBase::operator=(const ImageBase &image) noexceptImageBase
operator==(const ImageBase &image) const noexcept (defined in ImageBase)ImageBase
rawData (defined in ImageBase)ImageBaseprotected
size (defined in ImageBase)ImageBaseprotected
~ImageBase()ImageBasevirtual
~OpenGLImage() overrideOpenGLImage
+ + + + diff --git a/classOpenGLImage.html b/classOpenGLImage.html new file mode 100644 index 00000000..559ddaf7 --- /dev/null +++ b/classOpenGLImage.html @@ -0,0 +1,628 @@ + + + + + + + +DISTRHO Plugin Framework: OpenGLImage Class Reference + + + + + + + + + +
+
+ + + + + + +
+
DISTRHO Plugin Framework +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ +
+
+
+Public Member Functions | +List of all members
+
+
OpenGLImage Class Reference
+
+
+ +

#include <OpenGL.hpp>

+
+Inheritance diagram for OpenGLImage:
+
+
+ + +ImageBase + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 OpenGLImage ()
 
 OpenGLImage (const char *rawData, uint width, uint height, ImageFormat format=kImageFormatBGRA)
 
 OpenGLImage (const char *rawData, const Size< uint > &size, ImageFormat format=kImageFormatBGRA)
 
 OpenGLImage (const OpenGLImage &image)
 
 ~OpenGLImage () override
 
void loadFromMemory (const char *rawData, const Size< uint > &size, ImageFormat format=kImageFormatBGRA) noexcept override
 
void drawAt (const GraphicsContext &context, const Point< int > &pos) override
 
OpenGLImageoperator= (const OpenGLImage &image) noexcept
 
+void loadFromMemory (const char *rawData, uint w, uint h, ImageFormat format=kImageFormatBGRA)
 
+void draw (const GraphicsContext &context)
 
+void drawAt (const GraphicsContext &context, int x, int y)
 
 OpenGLImage (const char *rawData, uint width, uint height, GLenum format)
 
 OpenGLImage (const char *rawData, const Size< uint > &size, GLenum format)
 
void draw ()
 
void drawAt (const int x, const int y)
 
void drawAt (const Point< int > &pos)
 
DISTRHO_DEPRECATED GLenum getType () const noexcept
 
- Public Member Functions inherited from ImageBase
virtual ~ImageBase ()
 
bool isValid () const noexcept
 
bool isInvalid () const noexcept
 
uint getWidth () const noexcept
 
uint getHeight () const noexcept
 
const Size< uint > & getSize () const noexcept
 
const char * getRawData () const noexcept
 
ImageFormat getFormat () const noexcept
 
void loadFromMemory (const char *rawData, uint width, uint height, ImageFormat format=kImageFormatBGRA) noexcept
 
void draw (const GraphicsContext &context)
 
void drawAt (const GraphicsContext &context, int x, int y)
 
ImageBaseoperator= (const ImageBase &image) noexcept
 
+bool operator== (const ImageBase &image) const noexcept
 
+bool operator!= (const ImageBase &image) const noexcept
 
+ + + + + + + + + + + + + + + + + +

+Additional Inherited Members

- Protected Member Functions inherited from ImageBase
 ImageBase ()
 
 ImageBase (const char *rawData, uint width, uint height, ImageFormat format)
 
 ImageBase (const char *rawData, const Size< uint > &size, ImageFormat format)
 
 ImageBase (const ImageBase &image)
 
- Protected Attributes inherited from ImageBase
+const char * rawData
 
+Size< uint > size
 
+ImageFormat format
 
+

Detailed Description

+

OpenGL Image class.

+

This is an Image class that handles raw image data in pixels. You can init the image data on the contructor or later on by calling loadFromMemory().

+

To generate raw data useful for this class see the utils/png2rgba.py script. Be careful when using a PNG without alpha channel, for those the format is 'GL_BGR' instead of the default 'GL_BGRA'.

+

Images are drawn on screen via 2D textures.

+

Constructor & Destructor Documentation

+ +

◆ OpenGLImage() [1/6]

+ +
+
+ + + + + + + +
OpenGLImage::OpenGLImage ()
+
+

Constructor for a null Image.

+ +
+
+ +

◆ OpenGLImage() [2/6]

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
OpenGLImage::OpenGLImage (const char * rawData,
uint width,
uint height,
ImageFormat format = kImageFormatBGRA 
)
+
+

Constructor using raw image data.

Note
rawData must remain valid for the lifetime of this Image.
+ +
+
+ +

◆ OpenGLImage() [3/6]

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
OpenGLImage::OpenGLImage (const char * rawData,
const Size< uint > & size,
ImageFormat format = kImageFormatBGRA 
)
+
+

Constructor using raw image data.

Note
rawData must remain valid for the lifetime of this Image.
+ +
+
+ +

◆ OpenGLImage() [4/6]

+ +
+
+ + + + + + + + +
OpenGLImage::OpenGLImage (const OpenGLImageimage)
+
+

Constructor using another image data.

+ +
+
+ +

◆ ~OpenGLImage()

+ +
+
+ + + + + +
+ + + + + + + +
OpenGLImage::~OpenGLImage ()
+
+override
+
+

Destructor.

+ +
+
+ +

◆ OpenGLImage() [5/6]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
OpenGLImage::OpenGLImage (const char * rawData,
uint width,
uint height,
GLenum format 
)
+
+explicit
+
+

Constructor using raw image data, specifying an OpenGL image format.

Note
rawData must remain valid for the lifetime of this Image. DEPRECATED This constructor uses OpenGL image format instead of DISTRHO one.
+ +
+
+ +

◆ OpenGLImage() [6/6]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
OpenGLImage::OpenGLImage (const char * rawData,
const Size< uint > & size,
GLenum format 
)
+
+explicit
+
+

Constructor using raw image data, specifying an OpenGL image format.

Note
rawData must remain valid for the lifetime of this Image. DEPRECATED This constructor uses OpenGL image format instead of DISTRHO one.
+ +
+
+

Member Function Documentation

+ +

◆ loadFromMemory()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
void OpenGLImage::loadFromMemory (const char * rawData,
const Size< uint > & size,
ImageFormat format = kImageFormatBGRA 
)
+
+overridevirtualnoexcept
+
+

Load image data from memory.

Note
rawData must remain valid for the lifetime of this Image.
+ +

Reimplemented from ImageBase.

+ +
+
+ +

◆ drawAt() [1/3]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
void OpenGLImage::drawAt (const GraphicsContextcontext,
const Point< int > & pos 
)
+
+overridevirtual
+
+

Draw this image at position pos using the graphics context context.

+ +

Implements ImageBase.

+ +
+
+ +

◆ operator=()

+ +
+
+ + + + + +
+ + + + + + + + +
OpenGLImage& OpenGLImage::operator= (const OpenGLImageimage)
+
+noexcept
+
+

TODO document this.

+ +
+
+ +

◆ draw()

+ +
+
+ + + + + + + +
void OpenGLImage::draw ()
+
+

Draw this image at (0, 0) point using the current OpenGL context. DEPRECATED This function does not take into consideration the current graphics context and only works in OpenGL.

+ +
+
+ +

◆ drawAt() [2/3]

+ +
+
+ + + + + + + + + + + + + + + + + + +
void OpenGLImage::drawAt (const int x,
const int y 
)
+
+

Draw this image at (x, y) point using the current OpenGL context. DEPRECATED This function does not take into consideration the current graphics context and only works in OpenGL.

+ +
+
+ +

◆ drawAt() [3/3]

+ +
+
+ + + + + + + + +
void OpenGLImage::drawAt (const Point< int > & pos)
+
+

Draw this image at position pos using the current OpenGL context. DEPRECATED This function does not take into consideration the current graphics context and only works in OpenGL.

+ +
+
+ +

◆ getType()

+ +
+
+ + + + + +
+ + + + + + + +
DISTRHO_DEPRECATED GLenum OpenGLImage::getType () const
+
+inlinenoexcept
+
+

Get the image type. DEPRECATED Type is always assumed to be GL_UNSIGNED_BYTE.

+ +
+
+
The documentation for this class was generated from the following file: +
+ + + + diff --git a/classOpenGLImage.png b/classOpenGLImage.png new file mode 100644 index 00000000..2a0b134c Binary files /dev/null and b/classOpenGLImage.png differ diff --git a/classSubWidget-members.html b/classSubWidget-members.html new file mode 100644 index 00000000..5e9413dd --- /dev/null +++ b/classSubWidget-members.html @@ -0,0 +1,126 @@ + + + + + + + +DISTRHO Plugin Framework: Member List + + + + + + + + + +
+
+ + + + + + +
+
DISTRHO Plugin Framework +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ +
+
+
+
SubWidget Member List
+
+
+ +

This is the complete list of members for SubWidget, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
contains(T x, T y) const noexceptSubWidget
contains(const Point< T > &pos) const noexceptSubWidget
getAbsoluteArea() const noexceptSubWidget
getAbsolutePos() const noexceptSubWidget
getAbsoluteX() const noexceptSubWidget
getAbsoluteY() const noexceptSubWidget
getApp() const noexceptWidget
getConstrainedAbsoluteArea() const noexceptSubWidget
getGraphicsContext() const noexceptWidget
getHeight() const noexceptWidget
getId() const noexceptWidget
getParentApp() const noexcept (defined in Widget)Widgetinline
getParentWidget() const noexceptSubWidget
getParentWindow() const noexcept (defined in Widget)Widgetinline
getSize() const noexceptWidget
getTopLevelWidget() const noexceptWidget
getWidth() const noexceptWidget
getWindow() const noexceptWidget
hide()Widget
isVisible() const noexceptWidget
NanoBaseWidget (defined in SubWidget)SubWidgetfriend
onCharacterInput(const CharacterInputEvent &)Widgetprotectedvirtual
onDisplay()=0Widgetprotectedpure virtual
onKeyboard(const KeyboardEvent &)Widgetprotectedvirtual
onMotion(const MotionEvent &)Widgetprotectedvirtual
onMouse(const MouseEvent &)Widgetprotectedvirtual
onPositionChanged(const PositionChangedEvent &)SubWidgetprotectedvirtual
onResize(const ResizeEvent &)Widgetprotectedvirtual
onScroll(const ScrollEvent &)Widgetprotectedvirtual
onSpecial(const SpecialEvent &)Widgetprotectedvirtual
repaint() noexcept overrideSubWidgetvirtual
setAbsolutePos(int x, int y) noexceptSubWidget
setAbsolutePos(const Point< int > &pos) noexceptSubWidget
setAbsoluteX(int x) noexceptSubWidget
setAbsoluteY(int y) noexceptSubWidget
setHeight(uint height) noexceptWidget
setId(uint id) noexceptWidget
setNeedsFullViewportDrawing(bool needsFullViewportForDrawing=true)SubWidget
setSize(uint width, uint height) noexceptWidget
setSize(const Size< uint > &size) noexceptWidget
setVisible(bool visible)Widget
setWidth(uint width) noexceptWidget
show()Widget
SubWidget(Widget *parentWidget)SubWidgetexplicit
Widget (defined in SubWidget)SubWidgetfriend
~SubWidget()SubWidgetvirtual
~Widget()Widgetvirtual
+ + + + diff --git a/classSubWidget.html b/classSubWidget.html new file mode 100644 index 00000000..17ca01e4 --- /dev/null +++ b/classSubWidget.html @@ -0,0 +1,689 @@ + + + + + + + +DISTRHO Plugin Framework: SubWidget Class Reference + + + + + + + + + +
+
+ + + + + + +
+
DISTRHO Plugin Framework +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ +
+
+
+Public Member Functions | +Protected Member Functions | +Friends | +List of all members
+
+
SubWidget Class Reference
+
+
+ +

#include <SubWidget.hpp>

+
+Inheritance diagram for SubWidget:
+
+
+ + +Widget +ImageBaseButton< ImageType > +ImageKnob +ImageSlider +ImageSwitch + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 SubWidget (Widget *parentWidget)
 
virtual ~SubWidget ()
 
template<typename T >
bool contains (T x, T y) const noexcept
 
template<typename T >
bool contains (const Point< T > &pos) const noexcept
 
int getAbsoluteX () const noexcept
 
int getAbsoluteY () const noexcept
 
Point< int > getAbsolutePos () const noexcept
 
Rectangle< int > getAbsoluteArea () const noexcept
 
Rectangle< uint > getConstrainedAbsoluteArea () const noexcept
 
void setAbsoluteX (int x) noexcept
 
void setAbsoluteY (int y) noexcept
 
void setAbsolutePos (int x, int y) noexcept
 
void setAbsolutePos (const Point< int > &pos) noexcept
 
WidgetgetParentWidget () const noexcept
 
void repaint () noexcept override
 
void setNeedsFullViewportDrawing (bool needsFullViewportForDrawing=true)
 
- Public Member Functions inherited from Widget
virtual ~Widget ()
 
bool isVisible () const noexcept
 
void setVisible (bool visible)
 
void show ()
 
void hide ()
 
uint getWidth () const noexcept
 
uint getHeight () const noexcept
 
const Size< uint > getSize () const noexcept
 
void setWidth (uint width) noexcept
 
void setHeight (uint height) noexcept
 
void setSize (uint width, uint height) noexcept
 
void setSize (const Size< uint > &size) noexcept
 
uint getId () const noexcept
 
void setId (uint id) noexcept
 
ApplicationgetApp () const noexcept
 
WindowgetWindow () const noexcept
 
const GraphicsContextgetGraphicsContext () const noexcept
 
TopLevelWidgetgetTopLevelWidget () const noexcept
 
+ApplicationgetParentApp () const noexcept
 
+WindowgetParentWindow () const noexcept
 
+ + + + + + + + + + + + + + + + + + + + +

+Protected Member Functions

virtual void onPositionChanged (const PositionChangedEvent &)
 
- Protected Member Functions inherited from Widget
virtual void onDisplay ()=0
 
virtual bool onKeyboard (const KeyboardEvent &)
 
virtual bool onSpecial (const SpecialEvent &)
 
virtual bool onCharacterInput (const CharacterInputEvent &)
 
virtual bool onMouse (const MouseEvent &)
 
virtual bool onMotion (const MotionEvent &)
 
virtual bool onScroll (const ScrollEvent &)
 
virtual void onResize (const ResizeEvent &)
 
+ + + + + + +

+Friends

+class Widget
 
+template<class BaseWidget >
class NanoBaseWidget
 
+

Detailed Description

+

Sub-Widget class.

+

This class is the main entry point for creating any reusable widgets from within DGL. It can be freely positioned from within a parent widget, thus being named subwidget.

+

Many subwidgets can share the same parent, and subwidgets themselves can also have its own subwidgets. It is subwidgets all the way down.

+

TODO check absolute vs relative position and see what makes more sense.

+
See also
CairoSubWidget
+

Constructor & Destructor Documentation

+ +

◆ SubWidget()

+ +
+
+ + + + + +
+ + + + + + + + +
SubWidget::SubWidget (WidgetparentWidget)
+
+explicit
+
+

Constructor.

+ +
+
+ +

◆ ~SubWidget()

+ +
+
+ + + + + +
+ + + + + + + +
virtual SubWidget::~SubWidget ()
+
+virtual
+
+

Destructor.

+ +
+
+

Member Function Documentation

+ +

◆ contains() [1/2]

+ +
+
+
+template<typename T >
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
bool SubWidget::contains (x,
y 
) const
+
+noexcept
+
+

Check if this widget contains the point defined by x and y.

+ +
+
+ +

◆ contains() [2/2]

+ +
+
+
+template<typename T >
+ + + + + +
+ + + + + + + + +
bool SubWidget::contains (const Point< T > & pos) const
+
+noexcept
+
+

Check if this widget contains the point pos.

+ +
+
+ +

◆ getAbsoluteX()

+ +
+
+ + + + + +
+ + + + + + + +
int SubWidget::getAbsoluteX () const
+
+noexcept
+
+

Get absolute X.

+ +
+
+ +

◆ getAbsoluteY()

+ +
+
+ + + + + +
+ + + + + + + +
int SubWidget::getAbsoluteY () const
+
+noexcept
+
+

Get absolute Y.

+ +
+
+ +

◆ getAbsolutePos()

+ +
+
+ + + + + +
+ + + + + + + +
Point<int> SubWidget::getAbsolutePos () const
+
+noexcept
+
+

Get absolute position.

+ +
+
+ +

◆ getAbsoluteArea()

+ +
+
+ + + + + +
+ + + + + + + +
Rectangle<int> SubWidget::getAbsoluteArea () const
+
+noexcept
+
+

Get absolute area of this subwidget. This is the same as Rectangle<int>(getAbsolutePos(), getSize());

See also
getConstrainedAbsoluteArea()
+ +
+
+ +

◆ getConstrainedAbsoluteArea()

+ +
+
+ + + + + +
+ + + + + + + +
Rectangle<uint> SubWidget::getConstrainedAbsoluteArea () const
+
+noexcept
+
+

Get absolute area of this subwidget, with special consideration for not allowing negative values.

See also
getAbsoluteArea()
+ +
+
+ +

◆ setAbsoluteX()

+ +
+
+ + + + + +
+ + + + + + + + +
void SubWidget::setAbsoluteX (int x)
+
+noexcept
+
+

Set absolute X.

+ +
+
+ +

◆ setAbsoluteY()

+ +
+
+ + + + + +
+ + + + + + + + +
void SubWidget::setAbsoluteY (int y)
+
+noexcept
+
+

Set absolute Y.

+ +
+
+ +

◆ setAbsolutePos() [1/2]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
void SubWidget::setAbsolutePos (int x,
int y 
)
+
+noexcept
+
+

Set absolute position using x and y values.

+ +
+
+ +

◆ setAbsolutePos() [2/2]

+ +
+
+ + + + + +
+ + + + + + + + +
void SubWidget::setAbsolutePos (const Point< int > & pos)
+
+noexcept
+
+

Set absolute position.

+ +
+
+ +

◆ getParentWidget()

+ +
+
+ + + + + +
+ + + + + + + +
Widget* SubWidget::getParentWidget () const
+
+noexcept
+
+

Get parent Widget, as passed in the constructor.

+ +
+
+ +

◆ repaint()

+ +
+
+ + + + + +
+ + + + + + + +
void SubWidget::repaint ()
+
+overridevirtualnoexcept
+
+

Request repaint of this subwidget's area to the window this widget belongs to.

+ +

Reimplemented from Widget.

+ +
+
+ +

◆ setNeedsFullViewportDrawing()

+ +
+
+ + + + + + + + +
void SubWidget::setNeedsFullViewportDrawing (bool needsFullViewportForDrawing = true)
+
+

Indicate that this subwidget will draw out of bounds, and thus needs the entire viewport available for drawing.

+ +
+
+ +

◆ onPositionChanged()

+ +
+
+ + + + + +
+ + + + + + + + +
virtual void SubWidget::onPositionChanged (const PositionChangedEvent)
+
+protectedvirtual
+
+

A function called when the subwidget's absolute position is changed.

+ +
+
+
The documentation for this class was generated from the following file: +
+ + + + diff --git a/classSubWidget.png b/classSubWidget.png new file mode 100644 index 00000000..08d01959 Binary files /dev/null and b/classSubWidget.png differ diff --git a/classTopLevelWidget-members.html b/classTopLevelWidget-members.html new file mode 100644 index 00000000..ff067b2c --- /dev/null +++ b/classTopLevelWidget-members.html @@ -0,0 +1,116 @@ + + + + + + + +DISTRHO Plugin Framework: Member List + + + + + + + + + +
+
+ + + + + + +
+
DISTRHO Plugin Framework +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ +
+
+
+
TopLevelWidget Member List
+
+
+ +

This is the complete list of members for TopLevelWidget, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
addIdleCallback(IdleCallback *callback, uint timerFrequencyInMs=0) (defined in TopLevelWidget)TopLevelWidget
getApp() const noexceptTopLevelWidget
getGraphicsContext() const noexceptWidget
getHeight() const noexceptWidget
getId() const noexceptWidget
getParentApp() const noexcept (defined in TopLevelWidget)TopLevelWidgetinline
getParentWindow() const noexcept (defined in TopLevelWidget)TopLevelWidgetinline
getScaleFactor() const noexcept (defined in TopLevelWidget)TopLevelWidget
getSize() const noexceptWidget
getTopLevelWidget() const noexceptWidget
getWidth() const noexceptWidget
getWindow() const noexceptTopLevelWidget
hide()Widget
isVisible() const noexceptWidget
onCharacterInput(const CharacterInputEvent &)Widgetprotectedvirtual
onDisplay()=0Widgetprotectedpure virtual
onKeyboard(const KeyboardEvent &)Widgetprotectedvirtual
onMotion(const MotionEvent &)Widgetprotectedvirtual
onMouse(const MouseEvent &)Widgetprotectedvirtual
onResize(const ResizeEvent &)Widgetprotectedvirtual
onScroll(const ScrollEvent &)Widgetprotectedvirtual
onSpecial(const SpecialEvent &)Widgetprotectedvirtual
removeIdleCallback(IdleCallback *callback) (defined in TopLevelWidget)TopLevelWidget
repaint() noexceptTopLevelWidgetvirtual
repaint(const Rectangle< uint > &rect) noexcept (defined in TopLevelWidget)TopLevelWidget
setGeometryConstraints(uint minimumWidth, uint minimumHeight, bool keepAspectRatio=false, bool automaticallyScale=false) (defined in TopLevelWidget)TopLevelWidget
setHeight(uint height) noexceptWidget
setId(uint id) noexceptWidget
setSize(uint width, uint height) noexceptWidget
setSize(const Size< uint > &size) noexceptWidget
setVisible(bool visible)Widget
setWidth(uint width) noexceptWidget
show()Widget
TopLevelWidget(Window &windowToMapTo)TopLevelWidgetexplicit
Window (defined in TopLevelWidget)TopLevelWidgetfriend
~TopLevelWidget()TopLevelWidgetvirtual
~Widget()Widgetvirtual
+ + + + diff --git a/classTopLevelWidget.html b/classTopLevelWidget.html new file mode 100644 index 00000000..4610e0c6 --- /dev/null +++ b/classTopLevelWidget.html @@ -0,0 +1,340 @@ + + + + + + + +DISTRHO Plugin Framework: TopLevelWidget Class Reference + + + + + + + + + +
+
+ + + + + + +
+
DISTRHO Plugin Framework +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ +
+
+
+Public Member Functions | +Friends | +List of all members
+
+
TopLevelWidget Class Reference
+
+
+ +

#include <TopLevelWidget.hpp>

+
+Inheritance diagram for TopLevelWidget:
+
+
+ + +Widget +StandaloneWindow +ImageBaseAboutWindow< ImageType > + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 TopLevelWidget (Window &windowToMapTo)
 
virtual ~TopLevelWidget ()
 
ApplicationgetApp () const noexcept
 
WindowgetWindow () const noexcept
 
+bool addIdleCallback (IdleCallback *callback, uint timerFrequencyInMs=0)
 
+bool removeIdleCallback (IdleCallback *callback)
 
+double getScaleFactor () const noexcept
 
void repaint () noexcept
 
+void repaint (const Rectangle< uint > &rect) noexcept
 
+void setGeometryConstraints (uint minimumWidth, uint minimumHeight, bool keepAspectRatio=false, bool automaticallyScale=false)
 
+ApplicationgetParentApp () const noexcept
 
+WindowgetParentWindow () const noexcept
 
- Public Member Functions inherited from Widget
virtual ~Widget ()
 
bool isVisible () const noexcept
 
void setVisible (bool visible)
 
void show ()
 
void hide ()
 
uint getWidth () const noexcept
 
uint getHeight () const noexcept
 
const Size< uint > getSize () const noexcept
 
void setWidth (uint width) noexcept
 
void setHeight (uint height) noexcept
 
void setSize (uint width, uint height) noexcept
 
void setSize (const Size< uint > &size) noexcept
 
uint getId () const noexcept
 
void setId (uint id) noexcept
 
ApplicationgetApp () const noexcept
 
WindowgetWindow () const noexcept
 
const GraphicsContextgetGraphicsContext () const noexcept
 
TopLevelWidgetgetTopLevelWidget () const noexcept
 
+ApplicationgetParentApp () const noexcept
 
+WindowgetParentWindow () const noexcept
 
+ + + +

+Friends

+class Window
 
+ + + + + + + + + + + + + + + + + + +

+Additional Inherited Members

- Protected Member Functions inherited from Widget
virtual void onDisplay ()=0
 
virtual bool onKeyboard (const KeyboardEvent &)
 
virtual bool onSpecial (const SpecialEvent &)
 
virtual bool onCharacterInput (const CharacterInputEvent &)
 
virtual bool onMouse (const MouseEvent &)
 
virtual bool onMotion (const MotionEvent &)
 
virtual bool onScroll (const ScrollEvent &)
 
virtual void onResize (const ResizeEvent &)
 
+

Detailed Description

+

Top-Level Widget class.

+

This is the only Widget class that is allowed to be used directly on a Window.

+

This widget takes the full size of the Window it is mapped to. Sub-widgets can be added on top of this top-level widget, by creating them with this class as parent. Doing so allows for custom position and sizes.

+

This class is used as the type for DPF Plugin UIs. So anything that a plugin UI might need that does not belong in a simple Widget will go here.

+

Constructor & Destructor Documentation

+ +

◆ TopLevelWidget()

+ +
+
+ + + + + +
+ + + + + + + + +
TopLevelWidget::TopLevelWidget (WindowwindowToMapTo)
+
+explicit
+
+

Constructor.

+ +
+
+ +

◆ ~TopLevelWidget()

+ +
+
+ + + + + +
+ + + + + + + +
virtual TopLevelWidget::~TopLevelWidget ()
+
+virtual
+
+

Destructor.

+ +
+
+

Member Function Documentation

+ +

◆ getApp()

+ +
+
+ + + + + +
+ + + + + + + +
Application& TopLevelWidget::getApp () const
+
+noexcept
+
+

Get the application associated with this top-level widget's window.

+ +
+
+ +

◆ getWindow()

+ +
+
+ + + + + +
+ + + + + + + +
Window& TopLevelWidget::getWindow () const
+
+noexcept
+
+

Get the window associated with this top-level widget.

+ +
+
+ +

◆ repaint()

+ +
+
+ + + + + +
+ + + + + + + +
void TopLevelWidget::repaint ()
+
+virtualnoexcept
+
+

Request repaint of this widget's area to the window this widget belongs to. On the raw Widget class this function does nothing.

+ +

Reimplemented from Widget.

+ +
+
+
The documentation for this class was generated from the following file: +
+ + + + diff --git a/classTopLevelWidget.png b/classTopLevelWidget.png new file mode 100644 index 00000000..0c68958d Binary files /dev/null and b/classTopLevelWidget.png differ diff --git a/classVstGuiStandaloneWindow-members.html b/classVstGuiStandaloneWindow-members.html new file mode 100644 index 00000000..f34efac6 --- /dev/null +++ b/classVstGuiStandaloneWindow-members.html @@ -0,0 +1,92 @@ + + + + + + + +DISTRHO Plugin Framework: Member List + + + + + + + + + +
+
+ + + + + + +
+
DISTRHO Plugin Framework +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ +
+
+
+
VstGuiStandaloneWindow Member List
+
+
+ +

This is the complete list of members for VstGuiStandaloneWindow, including all inherited members.

+ + + + + + + + + + + + + + +
getHeight() const noexcept (defined in VstGuiStandaloneWindow)VstGuiStandaloneWindowinline
getTitle() const noexcept (defined in VstGuiStandaloneWindow)VstGuiStandaloneWindowinline
getTransientWinId() const noexcept (defined in VstGuiStandaloneWindow)VstGuiStandaloneWindowinline
getWidth() const noexcept (defined in VstGuiStandaloneWindow)VstGuiStandaloneWindowinline
idle() (defined in VstGuiStandaloneWindow)VstGuiStandaloneWindowinlinevirtual
isRunning() noexcept (defined in VstGuiStandaloneWindow)VstGuiStandaloneWindowinline
isVisible() const noexcept (defined in VstGuiStandaloneWindow)VstGuiStandaloneWindowinline
setSize(uint w, uint h) (defined in VstGuiStandaloneWindow)VstGuiStandaloneWindowinlinevirtual
setTitle(const char *const t) (defined in VstGuiStandaloneWindow)VstGuiStandaloneWindowinlinevirtual
setTransientWinId(const uintptr_t winId) (defined in VstGuiStandaloneWindow)VstGuiStandaloneWindowinlinevirtual
setVisible(const bool yesNo) (defined in VstGuiStandaloneWindow)VstGuiStandaloneWindowinlinevirtual
VstGuiStandaloneWindow(const uint w=1, const uint h=1, const char *const t="")VstGuiStandaloneWindowinline
~VstGuiStandaloneWindow() (defined in VstGuiStandaloneWindow)VstGuiStandaloneWindowinlinevirtual
+ + + + diff --git a/classVstGuiStandaloneWindow.html b/classVstGuiStandaloneWindow.html new file mode 100644 index 00000000..bc607fa3 --- /dev/null +++ b/classVstGuiStandaloneWindow.html @@ -0,0 +1,171 @@ + + + + + + + +DISTRHO Plugin Framework: VstGuiStandaloneWindow Class Reference + + + + + + + + + +
+
+ + + + + + +
+
DISTRHO Plugin Framework +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ +
+
+
+Public Member Functions | +List of all members
+
+
VstGuiStandaloneWindow Class Reference
+
+
+ +

#include <VstGuiWidget.hpp>

+ + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 VstGuiStandaloneWindow (const uint w=1, const uint h=1, const char *const t="")
 
+uint getWidth () const noexcept
 
+uint getHeight () const noexcept
 
+const char * getTitle () const noexcept
 
+uintptr_t getTransientWinId () const noexcept
 
+bool isVisible () const noexcept
 
+bool isRunning () noexcept
 
+virtual void idle ()
 
+virtual void setSize (uint w, uint h)
 
+virtual void setTitle (const char *const t)
 
+virtual void setTransientWinId (const uintptr_t winId)
 
+virtual void setVisible (const bool yesNo)
 
+

Detailed Description

+

VstGui VstGuiStandaloneWindow class.

+

This is a vstgui on top of DGL/DPF, with similar semantics as a VstGuiStandaloneWindow (Window + TopLevelWidget). The intention is to make it usable as a plugin UI target.

+

Work-in-progress.

+

Constructor & Destructor Documentation

+ +

◆ VstGuiStandaloneWindow()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
VstGuiStandaloneWindow::VstGuiStandaloneWindow (const uint w = 1,
const uint h = 1,
const char *const t = "" 
)
+
+inline
+
+

Constructor.

+ +
+
+
The documentation for this class was generated from the following file: +
+ + + + diff --git a/classVulkanImage-members.html b/classVulkanImage-members.html new file mode 100644 index 00000000..5ff7a355 --- /dev/null +++ b/classVulkanImage-members.html @@ -0,0 +1,108 @@ + + + + + + + +DISTRHO Plugin Framework: Member List + + + + + + + + + +
+
+ + + + + + +
+
DISTRHO Plugin Framework +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ +
+
+
+
VulkanImage Member List
+
+
+ +

This is the complete list of members for VulkanImage, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
draw(const GraphicsContext &context) (defined in VulkanImage)VulkanImageinline
drawAt(const GraphicsContext &context, const Point< int > &pos) overrideVulkanImagevirtual
drawAt(const GraphicsContext &context, int x, int y) (defined in VulkanImage)VulkanImageinline
format (defined in ImageBase)ImageBaseprotected
getFormat() const noexceptImageBase
getHeight() const noexceptImageBase
getRawData() const noexceptImageBase
getSize() const noexceptImageBase
getWidth() const noexceptImageBase
ImageBase()ImageBaseprotected
ImageBase(const char *rawData, uint width, uint height, ImageFormat format)ImageBaseprotected
ImageBase(const char *rawData, const Size< uint > &size, ImageFormat format)ImageBaseprotected
ImageBase(const ImageBase &image)ImageBaseprotected
isInvalid() const noexceptImageBase
isValid() const noexceptImageBase
loadFromMemory(const char *rawData, const Size< uint > &size, ImageFormat format=kImageFormatBGRA) noexcept overrideVulkanImagevirtual
loadFromMemory(const char *rawData, uint w, uint h, ImageFormat format=kImageFormatBGRA) (defined in VulkanImage)VulkanImageinline
operator!=(const ImageBase &image) const noexcept (defined in ImageBase)ImageBase
operator=(const VulkanImage &image) noexceptVulkanImage
ImageBase::operator=(const ImageBase &image) noexceptImageBase
operator==(const ImageBase &image) const noexcept (defined in ImageBase)ImageBase
rawData (defined in ImageBase)ImageBaseprotected
size (defined in ImageBase)ImageBaseprotected
VulkanImage()VulkanImage
VulkanImage(const char *rawData, uint width, uint height, ImageFormat format)VulkanImage
VulkanImage(const char *rawData, const Size< uint > &size, ImageFormat format)VulkanImage
VulkanImage(const VulkanImage &image)VulkanImage
~ImageBase()ImageBasevirtual
~VulkanImage() overrideVulkanImage
+ + + + diff --git a/classVulkanImage.html b/classVulkanImage.html new file mode 100644 index 00000000..de0e482e --- /dev/null +++ b/classVulkanImage.html @@ -0,0 +1,430 @@ + + + + + + + +DISTRHO Plugin Framework: VulkanImage Class Reference + + + + + + + + + +
+
+ + + + + + +
+
DISTRHO Plugin Framework +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ +
+
+
+Public Member Functions | +List of all members
+
+
VulkanImage Class Reference
+
+
+ +

#include <Vulkan.hpp>

+
+Inheritance diagram for VulkanImage:
+
+
+ + +ImageBase + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 VulkanImage ()
 
 VulkanImage (const char *rawData, uint width, uint height, ImageFormat format)
 
 VulkanImage (const char *rawData, const Size< uint > &size, ImageFormat format)
 
 VulkanImage (const VulkanImage &image)
 
 ~VulkanImage () override
 
void loadFromMemory (const char *rawData, const Size< uint > &size, ImageFormat format=kImageFormatBGRA) noexcept override
 
void drawAt (const GraphicsContext &context, const Point< int > &pos) override
 
VulkanImageoperator= (const VulkanImage &image) noexcept
 
+void loadFromMemory (const char *rawData, uint w, uint h, ImageFormat format=kImageFormatBGRA)
 
+void draw (const GraphicsContext &context)
 
+void drawAt (const GraphicsContext &context, int x, int y)
 
- Public Member Functions inherited from ImageBase
virtual ~ImageBase ()
 
bool isValid () const noexcept
 
bool isInvalid () const noexcept
 
uint getWidth () const noexcept
 
uint getHeight () const noexcept
 
const Size< uint > & getSize () const noexcept
 
const char * getRawData () const noexcept
 
ImageFormat getFormat () const noexcept
 
void loadFromMemory (const char *rawData, uint width, uint height, ImageFormat format=kImageFormatBGRA) noexcept
 
void draw (const GraphicsContext &context)
 
void drawAt (const GraphicsContext &context, int x, int y)
 
ImageBaseoperator= (const ImageBase &image) noexcept
 
+bool operator== (const ImageBase &image) const noexcept
 
+bool operator!= (const ImageBase &image) const noexcept
 
+ + + + + + + + + + + + + + + + + +

+Additional Inherited Members

- Protected Member Functions inherited from ImageBase
 ImageBase ()
 
 ImageBase (const char *rawData, uint width, uint height, ImageFormat format)
 
 ImageBase (const char *rawData, const Size< uint > &size, ImageFormat format)
 
 ImageBase (const ImageBase &image)
 
- Protected Attributes inherited from ImageBase
+const char * rawData
 
+Size< uint > size
 
+ImageFormat format
 
+

Detailed Description

+

Vulkan Image class.

+

TODO ...

+

Constructor & Destructor Documentation

+ +

◆ VulkanImage() [1/4]

+ +
+
+ + + + + + + +
VulkanImage::VulkanImage ()
+
+

Constructor for a null Image.

+ +
+
+ +

◆ VulkanImage() [2/4]

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
VulkanImage::VulkanImage (const char * rawData,
uint width,
uint height,
ImageFormat format 
)
+
+

Constructor using raw image data.

Note
rawData must remain valid for the lifetime of this Image.
+ +
+
+ +

◆ VulkanImage() [3/4]

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
VulkanImage::VulkanImage (const char * rawData,
const Size< uint > & size,
ImageFormat format 
)
+
+

Constructor using raw image data.

Note
rawData must remain valid for the lifetime of this Image.
+ +
+
+ +

◆ VulkanImage() [4/4]

+ +
+
+ + + + + + + + +
VulkanImage::VulkanImage (const VulkanImageimage)
+
+

Constructor using another image data.

+ +
+
+ +

◆ ~VulkanImage()

+ +
+
+ + + + + +
+ + + + + + + +
VulkanImage::~VulkanImage ()
+
+override
+
+

Destructor.

+ +
+
+

Member Function Documentation

+ +

◆ loadFromMemory()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
void VulkanImage::loadFromMemory (const char * rawData,
const Size< uint > & size,
ImageFormat format = kImageFormatBGRA 
)
+
+overridevirtualnoexcept
+
+

Load image data from memory.

Note
rawData must remain valid for the lifetime of this Image.
+ +

Reimplemented from ImageBase.

+ +
+
+ +

◆ drawAt()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
void VulkanImage::drawAt (const GraphicsContextcontext,
const Point< int > & pos 
)
+
+overridevirtual
+
+

Draw this image at position pos using the graphics context context.

+ +

Implements ImageBase.

+ +
+
+ +

◆ operator=()

+ +
+
+ + + + + +
+ + + + + + + + +
VulkanImage& VulkanImage::operator= (const VulkanImageimage)
+
+noexcept
+
+

TODO document this.

+ +
+
+
The documentation for this class was generated from the following file: +
+ + + + diff --git a/classVulkanImage.png b/classVulkanImage.png new file mode 100644 index 00000000..f0f4dbd7 Binary files /dev/null and b/classVulkanImage.png differ diff --git a/functions_func_v.html b/functions_func_v.html new file mode 100644 index 00000000..f108b8cd --- /dev/null +++ b/functions_func_v.html @@ -0,0 +1,82 @@ + + + + + + + +DISTRHO Plugin Framework: Class Members - Functions + + + + + + + + + +
+
+ + + + + + +
+
DISTRHO Plugin Framework +
+
+
+ + + + + + + +
+ +
+
+ + +
+ +
+ +
+  + +

- v -

+
+ + + + diff --git a/group__LV2AudioPortHints.html b/group__LV2AudioPortHints.html new file mode 100644 index 00000000..09ec9909 --- /dev/null +++ b/group__LV2AudioPortHints.html @@ -0,0 +1,141 @@ + + + + + + + +DISTRHO Plugin Framework: Audio Port Hints + + + + + + + + + +
+
+ + + + + + +
+
DISTRHO Plugin Framework +
+
+
+ + + + + + + +
+ +
+
+ + +
+ +
+ +
+
+Variables
+
+
Audio Port Hints
+
+
+ +

Various audio port hints. +More...

+ + + + + + +

+Variables

static const uint32_t kAudioPortIsCV = 0x1
 
static const uint32_t kAudioPortIsSidechain = 0x2
 
+

Detailed Description

+

Various audio port hints.

+
See also
Audio Port Hints
+
+AudioPort::hints
+

Variable Documentation

+ +

◆ kAudioPortIsCV

+ +
+
+ + + + + +
+ + + + +
const uint32_t kAudioPortIsCV = 0x1
+
+static
+
+

Audio port can be used as control voltage (LV2 only).

+ +
+
+ +

◆ kAudioPortIsSidechain

+ +
+
+ + + + + +
+ + + + +
const uint32_t kAudioPortIsSidechain = 0x2
+
+static
+
+

Audio port should be used as sidechan (LV2 only).

+ +
+
+
+ + + + diff --git a/group__LV2ParameterHints.html b/group__LV2ParameterHints.html new file mode 100644 index 00000000..9be5f042 --- /dev/null +++ b/group__LV2ParameterHints.html @@ -0,0 +1,119 @@ + + + + + + + +DISTRHO Plugin Framework: Parameter Hints + + + + + + + + + +
+
+ + + + + + +
+
DISTRHO Plugin Framework +
+
+
+ + + + + + + +
+ +
+
+ + +
+ +
+ +
+
+Variables
+
+
Parameter Hints
+
+
+ +

Various parameter hints. +More...

+ + + + +

+Variables

static const uint32_t kParameterIsTrigger = 0x20 | kParameterIsBoolean
 
+

Detailed Description

+

Various parameter hints.

+
See also
Parameter Hints
+
+Parameter::hints
+

Variable Documentation

+ +

◆ kParameterIsTrigger

+ +
+
+ + + + + +
+ + + + +
const uint32_t kParameterIsTrigger = 0x20 | kParameterIsBoolean
+
+static
+
+

Parameter value is a trigger.
+This means the value resets back to its default after each process/run call.
+Cannot be used for output parameters.

+
Note
Only officially supported under LV2. For other formats DPF simulates the behaviour.
+ +
+
+
+ + + + diff --git a/search/functions_16.html b/search/functions_16.html new file mode 100644 index 00000000..9182391d --- /dev/null +++ b/search/functions_16.html @@ -0,0 +1,30 @@ + + + + + + + + + +
+
Loading...
+
+ +
Searching...
+
No Matches
+ +
+ + diff --git a/search/functions_16.js b/search/functions_16.js new file mode 100644 index 00000000..26e06b52 --- /dev/null +++ b/search/functions_16.js @@ -0,0 +1,21 @@ +var searchData= +[ + ['_7eapplication_760',['~Application',['../classApplication.html#a20573928a0d53fb96d929513bc5acde6',1,'Application']]], + ['_7ebaseevent_761',['~BaseEvent',['../structWidget_1_1BaseEvent.html#a58da172316b49f6d79b879b74ce5792a',1,'Widget::BaseEvent']]], + ['_7ecairobasewidget_762',['~CairoBaseWidget',['../classCairoBaseWidget.html#ab76ae3b54d624b194e6392ba48799ce4',1,'CairoBaseWidget']]], + ['_7ecairoimage_763',['~CairoImage',['../classCairoImage.html#a36abbee6a47fc3447f00270aa16a82b7',1,'CairoImage']]], + ['_7eimagebase_764',['~ImageBase',['../classImageBase.html#a247e1c3259d5943a5766c99f61da9309',1,'ImageBase']]], + ['_7eleakedobjectdetector_765',['~LeakedObjectDetector',['../classLeakedObjectDetector.html#af4fd575fa5361ce5b01f65a635b1d6b3',1,'LeakedObjectDetector']]], + ['_7enanobasewidget_766',['~NanoBaseWidget',['../classNanoBaseWidget.html#a902dabbadc38052f23a0a1820ddf8003',1,'NanoBaseWidget']]], + ['_7enanoimage_767',['~NanoImage',['../classNanoImage.html#a8915fb5eae1a0180edd3f5babf6a0091',1,'NanoImage']]], + ['_7enanovg_768',['~NanoVG',['../classNanoVG.html#a3e05169f4e66e811537adaea17e4bb3f',1,'NanoVG']]], + ['_7eopenglimage_769',['~OpenGLImage',['../classOpenGLImage.html#a97461921a4eba66af7cfeaf84595f3ad',1,'OpenGLImage']]], + ['_7eplugin_770',['~Plugin',['../classPlugin.html#a89814b8f0b1c91e49140d42eb8331383',1,'Plugin::~Plugin()'],['../classPlugin.html#a89814b8f0b1c91e49140d42eb8331383',1,'Plugin::~Plugin()']]], + ['_7escopedpointer_771',['~ScopedPointer',['../classScopedPointer.html#a3c540f0121065aafa5f9607362fc1450',1,'ScopedPointer']]], + ['_7esubwidget_772',['~SubWidget',['../classSubWidget.html#a0f6225f53db69cd682910939edc9fd96',1,'SubWidget']]], + ['_7etoplevelwidget_773',['~TopLevelWidget',['../classTopLevelWidget.html#a73c0ee0ce1e84c9e18d0f6dcdcb9104a',1,'TopLevelWidget']]], + ['_7eui_774',['~UI',['../classUI.html#a47e7b6111faba049dfee4738d067cc42',1,'UI']]], + ['_7evulkanimage_775',['~VulkanImage',['../classVulkanImage.html#a45ab89d12d9a6a08f4986ac241a025dc',1,'VulkanImage']]], + ['_7ewidget_776',['~Widget',['../classWidget.html#a714cf798aadb4d615f6f60a355382c02',1,'Widget']]], + ['_7ewindow_777',['~Window',['../classWindow.html#a62b4a97b3c2e492f1d9a46092011e2d9',1,'Window']]] +]; diff --git a/search/variables_10.html b/search/variables_10.html new file mode 100644 index 00000000..92982ac5 --- /dev/null +++ b/search/variables_10.html @@ -0,0 +1,30 @@ + + + + + + + + + +
+
Loading...
+
+ +
Searching...
+
No Matches
+ +
+ + diff --git a/search/variables_10.js b/search/variables_10.js new file mode 100644 index 00000000..3d607c37 --- /dev/null +++ b/search/variables_10.js @@ -0,0 +1,6 @@ +var searchData= +[ + ['valid_816',['valid',['../structTimePosition_1_1BarBeatTick.html#a45a05047e923285af0fbeacb371e3f4e',1,'TimePosition::BarBeatTick']]], + ['value_817',['value',['../structParameterEnumerationValue.html#a292f282837daa791205027d998907ae9',1,'ParameterEnumerationValue']]], + ['values_818',['values',['../structParameterEnumerationValues.html#ae51423cab5df1353194e4835a9a1f31d',1,'ParameterEnumerationValues']]] +]; diff --git a/structCairoGraphicsContext-members.html b/structCairoGraphicsContext-members.html new file mode 100644 index 00000000..3a7ac647 --- /dev/null +++ b/structCairoGraphicsContext-members.html @@ -0,0 +1,80 @@ + + + + + + + +DISTRHO Plugin Framework: Member List + + + + + + + + + +
+
+ + + + + + +
+
DISTRHO Plugin Framework +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ +
+
+
+
CairoGraphicsContext Member List
+
+
+ +

This is the complete list of members for CairoGraphicsContext, including all inherited members.

+ + +
handle (defined in CairoGraphicsContext)CairoGraphicsContext
+ + + + diff --git a/structCairoGraphicsContext.html b/structCairoGraphicsContext.html new file mode 100644 index 00000000..16841319 --- /dev/null +++ b/structCairoGraphicsContext.html @@ -0,0 +1,102 @@ + + + + + + + +DISTRHO Plugin Framework: CairoGraphicsContext Struct Reference + + + + + + + + + +
+
+ + + + + + +
+
DISTRHO Plugin Framework +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ +
+
+
+Public Attributes | +List of all members
+
+
CairoGraphicsContext Struct Reference
+
+
+ +

#include <Cairo.hpp>

+
+Inheritance diagram for CairoGraphicsContext:
+
+
+ + +GraphicsContext + +
+ + + + +

+Public Attributes

+cairo_t * handle
 
+

Detailed Description

+

Cairo Graphics context.

+

The documentation for this struct was generated from the following file: +
+ + + + diff --git a/structCairoGraphicsContext.png b/structCairoGraphicsContext.png new file mode 100644 index 00000000..72aa4aca Binary files /dev/null and b/structCairoGraphicsContext.png differ diff --git a/structGraphicsContext.png b/structGraphicsContext.png new file mode 100644 index 00000000..8f21799c Binary files /dev/null and b/structGraphicsContext.png differ diff --git a/structIdleCallback-members.html b/structIdleCallback-members.html new file mode 100644 index 00000000..844d313a --- /dev/null +++ b/structIdleCallback-members.html @@ -0,0 +1,81 @@ + + + + + + + +DISTRHO Plugin Framework: Member List + + + + + + + + + +
+
+ + + + + + +
+
DISTRHO Plugin Framework +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ +
+
+
+
IdleCallback Member List
+
+
+ +

This is the complete list of members for IdleCallback, including all inherited members.

+ + + +
idleCallback()=0 (defined in IdleCallback)IdleCallbackpure virtual
~IdleCallback() (defined in IdleCallback)IdleCallbackinlinevirtual
+ + + + diff --git a/structIdleCallback.html b/structIdleCallback.html new file mode 100644 index 00000000..ea80b0c3 --- /dev/null +++ b/structIdleCallback.html @@ -0,0 +1,93 @@ + + + + + + + +DISTRHO Plugin Framework: IdleCallback Struct Reference + + + + + + + + + +
+
+ + + + + + +
+
DISTRHO Plugin Framework +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ +
+
+
+Public Member Functions | +List of all members
+
+
IdleCallback Struct Referenceabstract
+
+
+ +

#include <Base.hpp>

+ + + + +

+Public Member Functions

+virtual void idleCallback ()=0
 
+

Detailed Description

+

Idle callback.

+

The documentation for this struct was generated from the following file: +
+ + + + diff --git a/structOpenGLGraphicsContext.html b/structOpenGLGraphicsContext.html new file mode 100644 index 00000000..584cdc2a --- /dev/null +++ b/structOpenGLGraphicsContext.html @@ -0,0 +1,92 @@ + + + + + + + +DISTRHO Plugin Framework: OpenGLGraphicsContext Struct Reference + + + + + + + + + +
+
+ + + + + + +
+
DISTRHO Plugin Framework +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ +
+
+
+
OpenGLGraphicsContext Struct Reference
+
+
+ +

#include <OpenGL.hpp>

+
+Inheritance diagram for OpenGLGraphicsContext:
+
+
+ + +GraphicsContext + +
+

Detailed Description

+

OpenGL Graphics context.

+

The documentation for this struct was generated from the following file: +
+ + + + diff --git a/structOpenGLGraphicsContext.png b/structOpenGLGraphicsContext.png new file mode 100644 index 00000000..da38234f Binary files /dev/null and b/structOpenGLGraphicsContext.png differ diff --git a/structVulkanGraphicsContext.html b/structVulkanGraphicsContext.html new file mode 100644 index 00000000..9180b821 --- /dev/null +++ b/structVulkanGraphicsContext.html @@ -0,0 +1,92 @@ + + + + + + + +DISTRHO Plugin Framework: VulkanGraphicsContext Struct Reference + + + + + + + + + +
+
+ + + + + + +
+
DISTRHO Plugin Framework +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ +
+
+
+
VulkanGraphicsContext Struct Reference
+
+
+ +

#include <Vulkan.hpp>

+
+Inheritance diagram for VulkanGraphicsContext:
+
+
+ + +GraphicsContext + +
+

Detailed Description

+

Vulkan Graphics context.

+

The documentation for this struct was generated from the following file: +
+ + + + diff --git a/structVulkanGraphicsContext.png b/structVulkanGraphicsContext.png new file mode 100644 index 00000000..78336d66 Binary files /dev/null and b/structVulkanGraphicsContext.png differ diff --git a/structWidget_1_1CharacterInputEvent-members.html b/structWidget_1_1CharacterInputEvent-members.html new file mode 100644 index 00000000..16befcc5 --- /dev/null +++ b/structWidget_1_1CharacterInputEvent-members.html @@ -0,0 +1,92 @@ + + + + + + + +DISTRHO Plugin Framework: Member List + + + + + + + + + +
+
+ + + + + + +
+
DISTRHO Plugin Framework +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
Widget::CharacterInputEvent Member List
+
+
+ +

This is the complete list of members for Widget::CharacterInputEvent, including all inherited members.

+ + + + + + + + + + +
BaseEvent() noexceptWidget::BaseEventinline
character (defined in Widget::CharacterInputEvent)Widget::CharacterInputEvent
CharacterInputEvent() noexceptWidget::CharacterInputEventinline
flags (defined in Widget::BaseEvent)Widget::BaseEvent
keycode (defined in Widget::CharacterInputEvent)Widget::CharacterInputEvent
mod (defined in Widget::BaseEvent)Widget::BaseEvent
string (defined in Widget::CharacterInputEvent)Widget::CharacterInputEvent
time (defined in Widget::BaseEvent)Widget::BaseEvent
~BaseEvent() noexceptWidget::BaseEventinlinevirtual
+ + + + diff --git a/structWidget_1_1CharacterInputEvent.html b/structWidget_1_1CharacterInputEvent.html new file mode 100644 index 00000000..fef9eeba --- /dev/null +++ b/structWidget_1_1CharacterInputEvent.html @@ -0,0 +1,163 @@ + + + + + + + +DISTRHO Plugin Framework: Widget::CharacterInputEvent Struct Reference + + + + + + + + + +
+
+ + + + + + +
+
DISTRHO Plugin Framework +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+Public Member Functions | +Public Attributes | +List of all members
+
+
Widget::CharacterInputEvent Struct Reference
+
+
+ +

#include <Widget.hpp>

+
+Inheritance diagram for Widget::CharacterInputEvent:
+
+
+ + +Widget::BaseEvent + +
+ + + + + + + + + +

+Public Member Functions

 CharacterInputEvent () noexcept
 
- Public Member Functions inherited from Widget::BaseEvent
 BaseEvent () noexcept
 
virtual ~BaseEvent () noexcept
 
+ + + + + + + + + + + + + + +

+Public Attributes

+uint keycode
 
+uint character
 
+char string [8]
 
- Public Attributes inherited from Widget::BaseEvent
+uint mod
 
+uint flags
 
+uint time
 
+

Detailed Description

+

Character input event.

+

This event represents text input, usually as the result of a key press. The text is given both as a Unicode character code and a UTF-8 string.

+

Note that this event is generated by the platform's input system, so there is not necessarily a direct correspondence between text events and physical key presses. For example, with some input methods a sequence of several key presses will generate a single character.

+

keycode Raw key code. character Unicode character code. string UTF-8 string.

See also
onCharacterInput
+

Constructor & Destructor Documentation

+ +

◆ CharacterInputEvent()

+ +
+
+ + + + + +
+ + + + + + + +
Widget::CharacterInputEvent::CharacterInputEvent ()
+
+inlinenoexcept
+
+

Constuctor

+ +
+
+
The documentation for this struct was generated from the following file: +
+ + + + diff --git a/structWidget_1_1CharacterInputEvent.png b/structWidget_1_1CharacterInputEvent.png new file mode 100644 index 00000000..db453afd Binary files /dev/null and b/structWidget_1_1CharacterInputEvent.png differ