Struct iced_audio::IntParam

pub struct IntParam { /* fields omitted */ }

A parameter that defines a discrete linear range of i32 values

Methods

impl IntParam

pub fn new(id: u32, min: i32, max: i32, value: i32, default_value: i32) -> Self

Creates a new IntParam

Arguments

• id - an identifier for the parameter (must be unique!)
• min - the minimum of the range (inclusive)
• max - the maximum of the range (inclusive)
• value - the initial value of the parameter (if value falls outside the range given by min and max, then min or max will be used instead)
• value - the default value of the parameter (if default_value falls outside the range given by min and max, then min or max will be used instead)

Panics

This will panic if max <= min

pub fn set_from_value(&mut self, value: i32)

Sets the parameter's value to value

If value falls outside the range given by min and max from IntParam::new(), then min or max will be used instead.

Value to Normal calculactions will not be recalculated if the value has not changed.

pub fn set_from_normal(&mut self, normal: Normal)

Sets the parameter's value from a Normal

The parameter's resulting Normal will be calculated from the resulting parameter's value rounded to the nearest integer.

Example

use iced_audio::{Param, IntParam, Normal};

// id: 0, min: 0, max: 2, value: 1, default_value: 1
let mut param = IntParam::new(0, 0, 2, 1, 1);
param.set_from_normal((0.8).into());

assert_eq!(param.value(), 2);
assert_eq!(param.normal().value(), 1.0);

pub fn value(&self) -> i32

Returns the parameter's value

pub fn default_value(&self) -> i32

Returns the parameter's default value

Trait Implementations

impl Clone for IntParam

fn clone(&self) -> IntParam

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for IntParam

impl Debug for IntParam

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Param for IntParam

fn id(&self) -> u32

returns the unique identifier of the parameter

fn normal(&self) -> Normal

returns the value of the parameter represented as a [Normal]

fn default_normal(&self) -> Normal

returns the default value of the parameter represented as a [Normal]

impl PartialEq<IntParam> for IntParam

fn eq(&self, other: &IntParam) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &IntParam) -> bool

This method tests for !=.

impl StructuralPartialEq for IntParam