path: root/plugins/eg05-scope.lv2/README.txt
diff options
authorDavid Robillard <d@drobilla.net>2013-12-25 17:59:16 +0000
committerDavid Robillard <d@drobilla.net>2013-12-25 17:59:16 +0000
commit8b1275387c758c1ee894647517e5fb30adaa3ea4 (patch)
tree8f498ea7f856c3acf20c30caeea89ba37036ceec /plugins/eg05-scope.lv2/README.txt
parent74c991974146ab389d66052de904a84b44adf3ad (diff)
Bookify examploscope documentation.
Fix book generator to include single-star C comments in code blocks.
Diffstat (limited to 'plugins/eg05-scope.lv2/README.txt')
1 files changed, 6 insertions, 4 deletions
diff --git a/plugins/eg05-scope.lv2/README.txt b/plugins/eg05-scope.lv2/README.txt
index ec3578b..122794c 100644
--- a/plugins/eg05-scope.lv2/README.txt
+++ b/plugins/eg05-scope.lv2/README.txt
@@ -1,17 +1,19 @@
== Simple Oscilloscope ==
-This plugin displays the wave-form of an incoming audio-signal using a simple
+This plugin displays the waveform of an incoming audio signal using a simple
GTK+Cairo GUI.
This plugin illustrates:
-- UI <==> Plugin communication via LV2 atom events
-- LV2 Atom vector usage and resize-port extension
+- UI <==> Plugin communication via http://lv2plug.in/ns/ext/atom/[LV2 Atom] events
+- Atom vector usage and resize-port extension
- Save/Restore UI state by communicating state to backend
+- Saving simple key/value state via the http://lv2plug.in/ns/ext/state/[LV2 State] extension
- Cairo drawing and partial exposure
This plugin intends to outline the basics for building visualization plugins
-that rely on Atom communication. The UI looks likean oscilloscope, but is not a real oscilloscope implementation:
+that rely on atom communication. The UI looks like an oscilloscope, but is not
+a real oscilloscope implementation:
- There is no display synchronisation, results will depend on LV2 host.
- It displays raw audio samples, which a proper scope must not do.