Skip to content

Commit

Permalink
Documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
Guillaume Piolat committed Nov 20, 2024
1 parent 32b5415 commit 7525692
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 8 deletions.
10 changes: 6 additions & 4 deletions examples/README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
### Examples
* `examples/distort`: mandatory distortion plugin, with a PBR UI. Fork this for your own plug-in.
* `example/template`: Template to make a new plug-in.
* `examples/clipit`: Another distortion plugin, with a flat UI.
This one explains how to build an UI using `dplug:flat-widgets`.
* `examples/distort`: A distortion plugin, with a PBR UI.
This one explains how to use `TimedFIFO` for UI feedback, `Canvas`, `ImageKnob`, Wren scripting, custom widgets that draw to both Raw and PBR layer.
* `examples/clipit`: mandatory distortion plugin, with a flat UI. Fork this for your own plug-in.
This one explains how to use flag-widgets.




### Alt. Examples

**Beware!** Those examples are less authoritative/maintained than `examples/clipit` and `examples/distort`:
**Beware!** Those examples are less authoritative/maintained than `clipit`, `distort`, and `template`:
* `examples/ms-encode`: simplest plugin for tutorial purpose, without UI.
* `examples/simple-mono-synth`: very basic sine-wave generator, without UI.
* `examples/poly-alias-synth`: simple polyphonic wave generator, without UI.
Expand Down
8 changes: 4 additions & 4 deletions examples/clipit/gui.d
Original file line number Diff line number Diff line change
Expand Up @@ -56,13 +56,13 @@ nothrow:

_inputGainKnob = mallocNew!UIFilmstripKnob(context(), cast(FloatParameter) _client.param(paramInputGain), knobImage, numFrames);
addChild(_inputGainKnob);

_clipKnob = mallocNew!UIFilmstripKnob(context(), cast(FloatParameter) _client.param(paramClip), knobImage, numFrames);
addChild(_clipKnob);

_outputGainKnob = mallocNew!UIFilmstripKnob(context(), cast(FloatParameter) _client.param(paramOutputGain), knobImage, numFrames);
addChild(_outputGainKnob);

_mixKnob = mallocNew!UIFilmstripKnob(context(), cast(FloatParameter) _client.param(paramMix), knobImage, numFrames);
addChild(_mixKnob);

Expand All @@ -72,7 +72,7 @@ nothrow:

addChild(_modeSwitch = mallocNew!UIImageSwitch(context(), cast(BoolParameter) _client.param(paramMode), switchOnImage, switchOffImage));

addChild(_resizerHint = mallocNew!UIWindowResizer(context()));
addChild(_resizerHint = mallocNew!UIWindowResizer(context()));
}

override void reflow()
Expand Down

0 comments on commit 7525692

Please sign in to comment.