tuxmain/HexoDSP
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

document the 'mode' of SMap

Browse source
This commit is contained in:
Weird Constructor 2021-07-03 14:29:01 +02:00
parent 9913d3125f
commit 1f6aa8d18b
1 changed files with 8 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
src/dsp/node_smap.rs
View file

@ -49,6 +49,14 @@ impl SMap {
"SMap clip\nThe 'clip' mode allows you to limit the output \ "SMap clip\nThe 'clip' mode allows you to limit the output \
exactly to the 'min'/'max' range. If this is off, the output \ exactly to the 'min'/'max' range. If this is off, the output \
may be outside the output signal range."; 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 = pub const sig : &'static str =
"SMap sig\nMapped signal output\nRange: (-1..1)\n"; "SMap sig\nMapped signal output\nRange: (-1..1)\n";
pub const DESC : &'static str = pub const DESC : &'static str =