Struct iced_audio::Normal

pub struct Normal { /* fields omitted */ }

An f32 value that is gauranteed to be constrained to the range of

0.0 >= value >= 1.0

Example

use iced_audio::Normal;

let mut normal = Normal::new(-1.0);
assert_eq!(normal.value(), 0.0);

normal.set(3.0);
assert_eq!(normal.value(), 1.0);

normal.set(0.5);
assert_eq!(normal.value(), 0.5);

Methods

impl Normal

pub fn new(value: f32) -> Self

Creates a new Normal.

Arguments

• value - the value to initialize the Normal with

if value < 0.0, then normal.value is set to 0.0

else if value > 1.0, then normal.value is set to 1.0

else normal.value is set to value

pub fn set(&mut self, value: f32)

Set a value for the Normal.

Arguments

• value - the value to set the Normal with

if value < 0.0, then normal.value is set to 0.0

else if value > 1.0, then normal.value is set to 1.0

else normal.value is set to value

pub fn value(&self) -> f32

Returns the value of the Normal

Trait Implementations

impl Clone for Normal

fn clone(&self) -> Normal

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Normal

impl Debug for Normal

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

Formats the value using the given formatter.

impl Default for Normal

fn default() -> Self

Returns the "default value" for a type.

impl From<Normal> for f32

fn from(normal: Normal) -> f32

Performs the conversion.

impl From<f32> for Normal

fn from(value: f32) -> Self

Performs the conversion.

impl PartialEq<Normal> for Normal

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

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

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

This method tests for !=.

impl PartialOrd<Normal> for Normal

fn partial_cmp(&self, other: &Normal) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Normal) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Normal) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Normal) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Normal) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for Normal