Struct gilrs::Mapping

pub struct Mapping { /* fields omitted */ }

Stores data used to map gamepad buttons and axes.

To add new element, you should use IndexMut operator using Axis or Button as index (see example). After you add all mappings, use Gamepad::set_mapping(…) to change mapping of existing gamepad.

Example

use gilrs::{Mapping, Button, Axis};

let mut data = Mapping::new();
// map native event code 3 to Axis::LeftStickX
data[Axis::LeftStickX] = 3;
// map native event code 3 to Button::South (although both are 3,
// they refer to different things)
data[Button::South] = 3;

assert_eq!(data.axis(Axis::LeftStickX), Some(3));
assert_eq!(data.button(Button::South), Some(3));

See examples/mapping.rs for more detailed example.

Methods

impl MappingData

fn new() -> Self

Creates new Mapping.

fn button(&self, idx: Button) -> Option<NativeEvCode>

Returns NativeEvCode associated with button index.

fn axis(&self, idx: Axis) -> Option<NativeEvCode>

Returns NativeEvCode associated with axis index.

fn remove_button(&mut self, idx: Button) -> Option<NativeEvCode>

Removes button and returns associated NativEvCode.

fn remove_axis(&mut self, idx: Axis) -> Option<NativeEvCode>

Removes axis and returns associated NativEvCode.

Trait Implementations

impl Debug for MappingData

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Clone for MappingData

fn clone(&self) -> MappingData

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Index<Button> for MappingData

type Output = NativeEvCode

The returned type after indexing.

fn index(&self, index: Button) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Index<Axis> for MappingData

type Output = NativeEvCode

The returned type after indexing.

fn index(&self, index: Axis) -> &Self::Output

Performs the indexing (container[index]) operation.

impl IndexMut<Button> for MappingData

fn index_mut(&mut self, index: Button) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl IndexMut<Axis> for MappingData

fn index_mut(&mut self, index: Axis) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.