Struct gilrs::ff::Effect

source ·
pub struct Effect {
    id: usize,
    tx: Sender<Message>,
}
Expand description

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.

Fields§

§id: usize§tx: Sender<Message>

Implementations§

source§

impl Effect

source

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

Plays effect on all associated gamepads.

source

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

source

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.

source

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.

source

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

Changes what should happen to effect when it ends.

source

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.

source

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

Changes position of the source of effect.

source

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§

source§

impl Clone for Effect

source§

fn clone(&self) -> Self

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Drop for Effect

source§

fn drop(&mut self)

Executes the destructor for this type. Read more
source§

impl Hash for Effect

source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

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

Feeds a slice of this type into the given Hasher. Read more
source§

impl PartialEq for Effect

source§

fn eq(&self, other: &Effect) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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.
source§

impl Eq for Effect

Auto Trait Implementations§

§

impl Freeze for Effect

§

impl RefUnwindSafe for Effect

§

impl Send for Effect

§

impl Sync for Effect

§

impl Unpin for Effect

§

impl UnwindSafe for Effect

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.