Struct Normal 

pub struct Normal(/* private fields */);

An f32 value that is guaranteed 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.as_f32(), 0.0);

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

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

Implementations

impl Normal

pub const MIN: Self

A Normal with the value 0.0.

pub const CENTER: Self

A Normal with the value 0.5.

pub const MAX: Self

A Normal with the value 1.0.

pub const fn new(value: f32) -> Self

Creates a new Normal, clamping the provided value to the valid range of [0.0..=1.0].

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 try_from(value: f32) -> Result<Self, NormalOutOfRange>

Tries to create a Normal from the given value, erroring if the value is out of the range [0.0..=1.0].

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

Sets a value for the Normal, clamping it to the valid range of [0.0..=1.0].

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 try_set(&mut self, value: f32) -> Result<(), NormalOutOfRange>

Tries to set a value for the Normal, erroring if the value is out of the range [0.0..=1.0].

pub fn as_f32(&self) -> f32

Returns the value of the Normal as an f32

pub fn as_f32_inv(&self) -> f32

Returns the inverse value (1.0 - value) of the Normal as an f32

pub fn scale(&self, scalar: f32) -> f32

Returns the value of the Normal times the scalar

pub fn scale_inv(&self, scalar: f32) -> f32

Returns the inverse value (1.0 - value) of the Normal times the scalar

Trait Implementations

impl Clone for Normal

fn clone(&self) -> Normal

Returns a duplicate 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() -> Normal

Returns the “default value” for a type.

impl Display for Normal

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

Formats the value using the given formatter.

impl From<Normal> for f32

fn from(normal: Normal) -> f32

Converts to this type from the input type.

impl From<Normal> for f64

fn from(normal: Normal) -> f64

Converts to this type from the input type.

impl From<Normal> for NormalParam

fn from(normal: Normal) -> Self

Converts to this type from the input type.

impl From<f32> for Normal

fn from(value: f32) -> Self

Converts to this type from the input type.

impl From<f64> for Normal

fn from(value: f64) -> Self

Converts to this type from the input type.

impl PartialEq for Normal

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd 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: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl StructuralPartialEq for Normal