Struct gilrs::ff::BaseEffect

pub struct BaseEffect {
    pub kind: BaseEffectType,
    pub scheduling: Replay,
    pub envelope: Envelope,
}

Basic building block used to create more complex force feedback effects.

For each base effect you can specify it’s type, for how long should it be played and it’s strength during playback.

Fields

kind: BaseEffectType

Type of base effect.

scheduling: Replay

Defines playback duration and delays between each repetition.

envelope: Envelope

Basic attenuation function.

Implementations

impl BaseEffect

pub(super) fn magnitude_at(&self, ticks: Ticks) -> BaseEffectType

Returns Weak or Strong after applying envelope.

Trait Implementations

impl Clone for BaseEffect

fn clone(&self) -> BaseEffect

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BaseEffect

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

Formats the value using the given formatter.

impl Default for BaseEffect

fn default() -> BaseEffect

Returns the “default value” for a type.

impl PartialEq for BaseEffect

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

impl StructuralPartialEq for BaseEffect