Struct gilrs_core::Gilrs

pub struct Gilrs {
    pub(crate) inner: Gilrs,
}

Struct used to manage gamepads and retrieve events.

Fields

inner: Gilrs

Implementations

impl Gilrs

pub fn new() -> Result<Self, Error>

pub fn next_event(&mut self) -> Option<Event>

Returns oldest event or None if all events were processed.

pub fn next_event_blocking( &mut self, timeout: Option<Duration>, ) -> Option<Event>

Returns oldest event, waiting for new event if necessary.

pub fn gamepad(&self, id: usize) -> Option<&Gamepad>

Borrows Gamepad or return None if index is invalid. Returned gamepad may be disconnected.

pub fn last_gamepad_hint(&self) -> usize

Returns id greater than id of last connected gamepad. The returned value is only hint and may be much larger than number of observed gamepads. For example, it may return maximum number of connected gamepads on platforms when this limit is small.

gamepad(id) should return Some if using id that is smaller than value returned from this function.

Trait Implementations

impl Debug for Gilrs

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

Formats the value using the given formatter.