Struct gilrs_core::Gilrs

source ·
pub struct Gilrs {
    pub(crate) inner: Gilrs,
}
Expand description

Struct used to manage gamepads and retrieve events.

Fields§

§inner: Gilrs

Implementations§

source§

impl Gilrs

source

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

source

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

Returns oldest event or None if all events were processed.

source

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

Returns oldest event, waiting for new event if necessary.

source

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

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

source

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§

source§

impl Debug for Gilrs

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for Gilrs

§

impl RefUnwindSafe for Gilrs

§

impl Send for Gilrs

§

impl !Sync for Gilrs

§

impl Unpin for Gilrs

§

impl UnwindSafe for Gilrs

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.