From 1f6aa8d18bb1f31711c6553ce31fc5e90db7b815 Mon Sep 17 00:00:00 2001 From: Weird Constructor Date: Sat, 3 Jul 2021 14:29:01 +0200 Subject: [PATCH] document the 'mode' of SMap --- src/dsp/node_smap.rs | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/src/dsp/node_smap.rs b/src/dsp/node_smap.rs index b5d9bbd..e3e5c0b 100644 --- a/src/dsp/node_smap.rs +++ b/src/dsp/node_smap.rs @@ -49,6 +49,14 @@ impl SMap { "SMap clip\nThe 'clip' mode allows you to limit the output \ exactly to the 'min'/'max' range. If this is off, the output \ may be outside the output signal range."; + pub const mode : &'static str = + "SMap mode\nThis mode defines what kind of input signal is expected \ + and how it will be mapped to the output 'min'/'max' range.\n\ + These modes are available:\ + \n * Unipolar (0..1)\ + \n * Bipolar (-1..1)\ + \n * UniInv (1..0)\ + \n * BiInv (1..-1)"; pub const sig : &'static str = "SMap sig\nMapped signal output\nRange: (-1..1)\n"; pub const DESC : &'static str =