Document peak graph example

exa04 · Apr 20, 2024 · dbccac1 · dbccac1
1 parent a3326ce
commit dbccac1
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/examples/peak_graph/README.md b/examples/peak_graph/README.md
@@ -0,0 +1,15 @@
+# Peak Graph
+
+> [!NOTE]
+> This code is taken from the *Composing a Peak Graph* chapter of the Cyma Book.
+
+![A peak graph visualizer with a grid backdrop and a unit ruler to the side.](doc/peak_graph.png)
+
+A peak analyzer plugin.
+
+This example plug-in uses a peak buffer that stores incoming audio as peaks that
+decay in amplitude. The buffer is behind an `Arc<Mutex>`. By cloning the Arc, a
+reference is sent to the editor. The editor uses the buffer to draw a `PeakGraph`.
+
+Behind it is a grid, and to the side of it is a unit ruler. These views are composed
+using VIZIA's *Stack* views.
diff --git a/examples/peak_graph/doc/peak_graph.png b/examples/peak_graph/doc/peak_graph.png