Struct rich_sdl2_rust::haptic::effect::Envelope

pub struct Envelope {
    pub attack_length: u16,
    pub attack_level: u16,
    pub fade_length: u16,
    pub fade_level: u16,
}

An envelope to fade in/out the effect. If both attack_length and fade_level are 0, the envelope is not used. An example of a constant effect evolution in time:

Strength
^
|
|      effect level --> _________________
|                      /                 \
|                     /                   \
|                    /                     \
|                   /                       \
| attack_level --> |                         \
|                  |                          | <--- fade_level
|
+--------------------------------------------------> Time

                   [--]                 [---]
               attack_length          fade_length

[------------------][-----------------------]
       delay                 length

Fields

attack_length: u16

The length of the level from attack_level to the effect level in milliseconds.

attack_level: u16

The initial force level on applying.

fade_length: u16

The length of the level from the effect level to attack_levelin milliseconds.

fade_level: u16

The end force level on applying.

Trait Implementations

impl Clone for Envelope

fn clone(&self) -> Envelope

Returns a copy 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 PartialEq<Envelope> for Envelope

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

impl StructuralEq for Envelope

impl StructuralPartialEq for Envelope