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

Documentation change

Browse source
This commit is contained in:
Weird Constructor 2021-07-11 11:59:13 +02:00
parent 0bd97bf904
commit 5a3eb18f5c
1 changed files with 14 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
src/dsp/node_sfilter.rs
View file

@ -45,17 +45,29 @@ impl SFilter {
pub const freq : &'static str =
"SFilter freq\nFilter cutoff frequency.\nRange: (-1..1)\n";
pub const ftype : &'static str =
"SFilter ftype\nFilter type.";
"SFilter ftype\nThe filter type, there are varying types of \
filters available. Please consult the node documentation for \
a complete list.";
pub const sig : &'static str =
"SFilter sig\nFiltered signal output.\nRange: (-1..1)\n";
pub const DESC : &'static str =
r#"Simple Audio Filter
This is a very simple collection of filters.
This is a collection of more or less simple filters.
There are only two parameters: Filter cutoff 'freq' and the 'res'onance.
"#;
pub const HELP : &'static str =
r#"SFilter - Simple Audio Filter
This is a collection of a few more or less simple filters
of varying types. There are only few parameters for you to change: 'freq'
and 'res'onance. You can switch between the types with the 'ftype'.
There are currently following filters available:
HP(1p) - One pole low-pass filter (6db)
HP(1pt) - One pole low-pass filter (6db) (TPT form)
LP(1p) - One pole high-pass filter (6db)
LP(1pt) - One pole high-pass filter (6db) (TPT form)
"#;
}