Struct gilrs::ff::Effect [−][src]
pub struct Effect { /* fields omitted */ }
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.
Implementations
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.
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.
Changes what should happen to effect when it ends.
Changes distance model associated with effect.
Errors
Returns Error::InvalidDistanceModel
if model
is not valid. See
DistanceModel
for details.
Changes position of the source of effect.
Trait Implementations
Auto Trait Implementations
impl !RefUnwindSafe for Effect
impl !UnwindSafe for Effect
Blanket Implementations
Mutably borrows from an owned value. Read more