Struct Effect 

pub struct Effect<'a> { /* private fields */ }

A force-feedback effect description.

Primarily created from the more specific force-feedback types in this module using From.

The 'a lifetime is only used for Periodic effects with Waveform::CUSTOM (created via Periodic::custom). It can be 'static for all other effects.

Implementations

impl Effect<'_>

pub fn with_id(self, id: EffectId) -> Self

Changes the EffectId stored in this Effect.

By default, effects use ID -1, which is appropriate when uploading a new effect to a device (the input subsystem will allocate an ID for the effect).

The ID can be set to a existing EffectId in order to reconfigure an already uploaded effect.

pub fn with_direction(self, dir: u16) -> Self

pub fn with_trigger(self, trigger: Trigger) -> Self

pub fn effect_type(&self) -> EffectType

pub fn with_replay(self, replay: Replay) -> Self

pub fn id(&self) -> EffectId

pub fn direction(&self) -> u16

pub fn trigger(&self) -> Trigger

pub fn replay(&self) -> Replay

pub fn kind(&self) -> Option<EffectKind<'_>>

Trait Implementations

impl<'a> Clone for Effect<'a>

fn clone(&self) -> Effect<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Effect<'_>

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

Formats the value using the given formatter.

impl From<[Damper; 2]> for Effect<'_>

fn from([a, b]: [Damper; 2]) -> Self

Converts to this type from the input type.

impl From<[Friction; 2]> for Effect<'_>

fn from([a, b]: [Friction; 2]) -> Self

Converts to this type from the input type.

impl From<[Inertia; 2]> for Effect<'_>

fn from([a, b]: [Inertia; 2]) -> Self

Converts to this type from the input type.

impl From<[Spring; 2]> for Effect<'_>

fn from([a, b]: [Spring; 2]) -> Self

Converts to this type from the input type.

impl From<Constant> for Effect<'_>

fn from(value: Constant) -> Self

Converts to this type from the input type.

impl From<Damper> for Effect<'_>

fn from(value: Damper) -> Self

Converts to this type from the input type.

impl<'a> From<EffectKind<'a>> for Effect<'a>

fn from(value: EffectKind<'a>) -> Self

Converts to this type from the input type.

impl From<Friction> for Effect<'_>

fn from(value: Friction) -> Self

Converts to this type from the input type.

impl From<Inertia> for Effect<'_>

fn from(value: Inertia) -> Self

Converts to this type from the input type.

impl<'a> From<Periodic<'a>> for Effect<'a>

fn from(value: Periodic<'a>) -> Self

Converts to this type from the input type.

impl From<Ramp> for Effect<'_>

fn from(value: Ramp) -> Self

Converts to this type from the input type.

impl From<Rumble> for Effect<'_>

fn from(value: Rumble) -> Self

Converts to this type from the input type.

impl From<Spring> for Effect<'_>

fn from(value: Spring) -> Self

Converts to this type from the input type.

impl<'a> Copy for Effect<'a>