Struct iced_audio::core::normal::Normal

pub struct Normal { /* private fields */ }

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::from_clipped(-1.0);
assert_eq!(normal.as_f32(), 0.0);

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

normal.set_clipped(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 fn from_clipped(value: f32) -> Self

Creates a new Normal, clipping the provided value.

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

Sets a value for the Normal, clipping the provided value.

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 copy of the value.

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

Performs copy-assignment from source.

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

Converts to this type from the input type.

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

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

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

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

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

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

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

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

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

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

impl TryFrom<f32> for Normal

type Error = NormalOutOfRange

The type returned in the event of a conversion error.

fn try_from(value: f32) -> Result<Self, NormalOutOfRange>

Performs the conversion.

impl Copy for Normal

impl StructuralPartialEq for Normal