Struct gilrs::ff::EffectBuilder

pub struct EffectBuilder {
    base_effects: Vec<BaseEffect>,
    devices: VecMap<()>,
    repeat: Repeat,
    dist_model: DistanceModel,
    position: [f32; 3],
    gain: f32,
}

Creates new Effect.

Fields

base_effects: Vec<BaseEffect>

devices: VecMap<()>

repeat: Repeat

dist_model: DistanceModel

position: [f32; 3]

gain: f32

Implementations

impl EffectBuilder

pub fn new() -> Self

Creates new builder with following defaults: no gamepads, no base effects, repeat set to infinitely, no distance model, position in (0.0, 0.0, 0.0) and gain 1.0. Use finish() to create new effect.

pub fn add_effect(&mut self, effect: BaseEffect) -> &mut Self

Adds new BaseEffect.

pub fn gamepads(&mut self, ids: &[GamepadId]) -> &mut Self

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

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

Adds gamepad to the list of gamepads associated with effect.

pub fn repeat(&mut self, repeat: Repeat) -> &mut Self

Changes what should happen to effect when it ends.

pub fn distance_model(&mut self, model: DistanceModel) -> &mut Self

Changes distance model associated with effect.

pub fn position<Vec3f: Into<[f32; 3]>>(&mut self, position: Vec3f) -> &mut Self

Changes position of the source of effect.

pub fn gain(&mut self, gain: f32) -> &mut Self

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

pub fn finish(&mut self, gilrs: &mut Gilrs) -> Result<Effect, Error>

Validates all parameters and creates new effect.

Errors

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

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

Trait Implementations

impl Clone for EffectBuilder

fn clone(&self) -> EffectBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EffectBuilder

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

Formats the value using the given formatter.

impl Default for EffectBuilder

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for EffectBuilder

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