alex/nih-plug
1
0
Fork 0
Code Activity

Document how values work in the Param trait

Browse source
This commit is contained in:
Robbert van der Helm 2022-05-01 16:40:18 +02:00
parent 48d0f87e4c
commit 40b555bfbd
1 changed files with 5 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
src/param.rs
View file

@ -41,7 +41,11 @@ bitflags::bitflags! {
} }
} }
/// Describes a single parameter of any type. /// Describes a single parameter of any type. Most parameter implementations also have a field
/// called `value` that and a field called `smoothed`. The former stores the latest unsmoothed
/// value, and the latter can be used to access the smoother. These two fields should be used in DSP
/// code to either get the parameter's current (smoothed) value. In UI code the getters from this
/// trait should be used instead.
pub trait Param: Display { pub trait Param: Display {
/// The plain parameter type. /// The plain parameter type.
type Plain: PartialEq; type Plain: PartialEq;