alex/nih-plug
1
0
Fork 0
Code Activity

Merge pull request #15 from AmaiKinono/typo

Browse source 
Fix typos in the gain example
This commit is contained in:
Robbert van der Helm 2022-07-18 23:38:03 +02:00 committed by GitHub
parent ba7b5a3b32 00fa9e9703
commit 8e2650e43a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
plugins/examples/gain/src/lib.rs
View file

@ -6,19 +6,19 @@ struct Gain {
params: Arc<GainParams>, params: Arc<GainParams>,
} }
/// The [`Params`] derive macro gathers all of the information needed for the wrapepr to know about /// The [`Params`] derive macro gathers all of the information needed for the wrapper to know about
/// the plugin's parameters, persistent serializable fields, and nested parameter groups. You can /// the plugin's parameters, persistent serializable fields, and nested parameter groups. You can
/// aslo easily implement [`Params`] by hand if you want to, for instance, have multiple instances /// also easily implement [`Params`] by hand if you want to, for instance, have multiple instances
/// of a parameters struct for multiple identical oscillators/filters/envelopes. /// of a parameters struct for multiple identical oscillators/filters/envelopes.
#[derive(Params)] #[derive(Params)]
struct GainParams { struct GainParams {
/// The parameter's ID is used to identify the parameter in the wrappred plugin API. As long as /// The parameter's ID is used to identify the parameter in the wrappred plugin API. As long as
/// these IDs remain constant, you can rename and reorder these fields as you wish. The /// these IDs remain constant, you can rename and reorder these fields as you wish. The
/// parameters are exposed to the host in the same order thye were defined in. /// parameters are exposed to the host in the same order they were defined.
#[id = "gain"] #[id = "gain"]
pub gain: FloatParam, pub gain: FloatParam,
/// This field isn't used in this exampleq, but anything written to the vector would be restored /// This field isn't used in this example, but anything written to the vector would be restored
/// together with a preset/state file saved for this plugin. This can be useful for storing /// together with a preset/state file saved for this plugin. This can be useful for storing
/// things like sample data. /// things like sample data.
#[persist = "industry_secrets"] #[persist = "industry_secrets"]
@ -70,8 +70,8 @@ impl Default for GainParams {
// This is actually redundant, because a step size of two decimal places already // This is actually redundant, because a step size of two decimal places already
// causes the parameter to shown rounded // causes the parameter to shown rounded
.with_value_to_string(formatters::v2s_f32_rounded(2)), .with_value_to_string(formatters::v2s_f32_rounded(2)),
// Persisted fields can be intialized like any other fields, and they'll keep their when // Persisted fields can be intialized like any other fields, and they'll keep their
// restoring the plugin's state. // values when restoring the plugin's state.
random_data: RwLock::new(Vec::new()), random_data: RwLock::new(Vec::new()),
sub_params: SubParams { sub_params: SubParams {
nested_parameter: FloatParam::new( nested_parameter: FloatParam::new(
@ -124,8 +124,8 @@ impl Plugin for Gain {
} }
// This plugin doesn't need any special initialization, but if you need to do anything expensive // This plugin doesn't need any special initialization, but if you need to do anything expensive
// then this would be the place. State is kept around while when the host reconfigures the // then this would be the place. State is kept around when the host reconfigures the
// plugin. If we did need special initialization, we could implement the `initialize()` and/or // plugin. If we do need special initialization, we could implement the `initialize()` and/or
// `reset()` methods // `reset()` methods
fn process( fn process(