Struct gilrs::ff::Effect

pub struct Effect { /* fields omitted */ }

Handle to force feedback effect.

Effect represents force feedback effect that can be played on one or more gamepads. It uses a form of reference counting, so it can be cheaply cloned. To create new Effect use EffectBuilder.

All methods on can return Error::SendFailed although it shouldn’t normally happen.

Implementations

impl Effect

pub fn play(&self) -> Result<(), Error>

Plays effect on all associated gamepads.

pub fn stop(&self) -> Result<(), Error>

pub fn set_gamepads(
    &self,
    ids: &[GamepadId],
    gilrs: &Gilrs
) -> Result<(), Error>

Changes gamepads that are associated with effect. Effect will be only played on gamepads from last call to this function.

Errors

Returns Error::Disconnected(id) or Error::FfNotSupported(id) on first gamepad in ids that is disconnected or doesn’t support force feedback.

pub fn add_gamepad(&self, gamepad: &Gamepad<'_>) -> Result<(), Error>

Adds gamepad to the list of gamepads associated with effect.

Errors

Returns Error::Disconnected(id) or Error::FfNotSupported(id) if gamepad is not connected or does not support force feedback.

pub fn set_repeat(&self, repeat: Repeat) -> Result<(), Error>

Changes what should happen to effect when it ends.

pub fn set_distance_model(&self, model: DistanceModel) -> Result<(), Error>

Changes distance model associated with effect.

Errors

Returns Error::InvalidDistanceModel if model is not valid. See DistanceModel for details.

pub fn set_position<Vec3f: Into<[f32; 3]>>(
    &self,
    position: Vec3f
) -> Result<(), Error>

Changes position of the source of effect.

pub fn set_gain(&self, gain: f32) -> Result<(), Error>

Changes gain of the effect. gain will be clamped to [0.0, f32::MAX].

Trait Implementations

impl Clone for Effect

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Drop for Effect

fn drop(&mut self)

Executes the destructor for this type.

impl Hash for Effect

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<Effect> for Effect

fn eq(&self, other: &Effect) -> 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 !=.

impl Eq for Effect