Struct gilrs::GilrsBuilder

source ·
pub struct GilrsBuilder {
    mappings: MappingDb,
    default_filters: bool,
    axis_to_btn_pressed: f32,
    axis_to_btn_released: f32,
    update_state: bool,
    env_mappings: bool,
    included_mappings: bool,
}
Expand description

Allow to create Gilrs with customized behaviour.

Fields§

§mappings: MappingDb§default_filters: bool§axis_to_btn_pressed: f32§axis_to_btn_released: f32§update_state: bool§env_mappings: bool§included_mappings: bool

Implementations§

source§

impl GilrsBuilder

source

pub fn new() -> Self

Create builder with default settings. Use build() to create Gilrs.

source

pub fn with_default_filters(self, default_filters: bool) -> Self

If true, use axis_dpad_to_button, Jitter and deadzone filters with default parameters. Defaults to true.

source

pub fn add_mappings(self, mappings: &str) -> Self

Adds SDL mappings.

source

pub fn add_env_mappings(self, env_mappings: bool) -> Self

If true, will add SDL mappings from SDL_GAMECONTROLLERCONFIG environment variable. Defaults to true.

source

pub fn add_included_mappings(self, included_mappings: bool) -> Self

If true, will add SDL mappings included from https://github.com/gabomdq/SDL_GameControllerDB. Defaults to true.

source

pub fn set_axis_to_btn(self, pressed: f32, released: f32) -> Self

Sets values on which ButtonPressed and ButtonReleased events will be emitted. build() will return error if pressed ≤ released or if one of values is outside [0.0, 1.0].

Defaults to 0.75 for pressed and 0.65 for released.

source

pub fn set_update_state(self, enabled: bool) -> Self

Disable or enable automatic state updates. You should use this if you use custom filters; in this case you have to update state manually anyway.

source

pub fn build(self) -> Result<Gilrs, Error>

Creates Gilrs.

Trait Implementations§

source§

impl Default for GilrsBuilder

source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

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, 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.