Struct gilrs::GilrsBuilder

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

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

impl GilrsBuilder

pub fn new() -> Self

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

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.

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

Adds SDL mappings.

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

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

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.

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.

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.

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

Creates Gilrs.

Trait Implementations

impl Default for GilrsBuilder

fn default() -> Self

Returns the “default value” for a type.