Struct Envelope 

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

An effect envelope.

Effect intensity can be faded in and out by configuring the envelope.

There is no guarantee that any given driver or device will respect these settings.

Fade and attack levels are relative to the magnitude of the modulated effect. Their maximum value is 0x7fff (higher values are treated the same as 0x7fff), representing 100% of the effect’s intensity.

atk. len.               fade len.
|------|               |---------|
       +---------------+  -  -  -  -  -  -  - effect magnitude/intensity
      /                 \
     /                   \
    /                     \
   /                       \
  /                         \
 /                           \
/     _                       \
|     |                        \
|     | atk.                 _  \
|     | lvl.            fade |  |
|     |                 lvl. |  |

Implementations

impl Envelope

pub fn new() -> Self

Returns a zeroed-out default Envelope structure.

This envelope configures no fading: the effect will start at its configured intensity immediately, and end abruptly.

pub fn with_attack_length(self, ms: u16) -> Self

Effect will be faded in for ms milliseconds before reaching its full intensity.

pub fn with_attack_level(self, level: u16) -> Self

Effect fade-in will start with intensity level.

pub fn with_fade_length(self, ms: u16) -> Self

Effect will fade out for ms milliseconds before stopping.

pub fn with_fade_level(self, level: u16) -> Self

Effect fade-out will stop at intensity level.

pub fn attack_length(&self) -> u16

pub fn attack_level(&self) -> u16

pub fn fade_length(&self) -> u16

pub fn fade_level(&self) -> u16

Trait Implementations

impl Clone for Envelope

fn clone(&self) -> Envelope

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Envelope

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

Formats the value using the given formatter.

impl Default for Envelope

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for Envelope

fn eq(&self, other: &Envelope) -> 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 Copy for Envelope

impl Eq for Envelope

impl StructuralPartialEq for Envelope