Tightened the source code and README documentations in the library.

2026-09-18 12:45:39 +02:00
parent c9f887bacb
commit 9ae10590cc
97 changed files with 854 additions and 1142 deletions
@@ -1,8 +1,7 @@
 extension Sound.Effect {
-    /// Processes up to `AUDIO_FRAMES_PER_CYCLE` sample frames in signed
-    /// Q8.24 format. `right` is empty when the channel is mono.
-    /// `bufferActive` is `false` when the input buffer is silent. Returns
-    /// `true` if the effect produced output.
+    /// Processes up to 512 (`AUDIO_FRAMES_PER_CYCLE`) signed Q8.24 frames in place.
+    /// `right` is empty on mono channels; `bufferActive` is `false` if nothing was
+    /// written. Returns `true` if it changed the samples.
    public typealias Processor = (_ left: inout MutableSpan<Int32>,
                                  _ right: inout MutableSpan<Int32>,
                                  _ bufferActive: Bool) -> Bool