Controller

Struct Controller 

Source
pub struct Controller {}
Expand description

An interface for handling game controller inputs.

Implementations§

Source§

impl Controller

Source

pub fn is_button_down(controller_id: i32, button: ButtonName) -> bool

Checks whether a button is pressed down in the current frame.

§Arguments
  • controller_id - The controller id, incrementing from 0 when multiple controllers are connected.
  • name - The name of the button to check.
§Returns
  • bool - true if the button is pressed down, false otherwise.
Source

pub fn is_button_up(controller_id: i32, button: ButtonName) -> bool

Checks whether a button is released in the current frame.

§Arguments
  • controller_id - The controller id, incrementing from 0 when multiple controllers are connected.
  • name - The name of the button to check.
§Returns
  • bool - true if the button is released, false otherwise.
Source

pub fn is_button_pressed(controller_id: i32, button: ButtonName) -> bool

Checks whether a button is in pressed state.

§Arguments
  • controller_id - The controller id, incrementing from 0 when multiple controllers are connected.
  • name - The name of the button to check.
§Returns
  • bool - true if the button is in pressed state, false otherwise.
Source

pub fn get_axis(controller_id: i32, axis: AxisName) -> f32

Gets the axis value from a given controller.

§Arguments
  • controller_id - The controller id, incrementing from 0 when multiple controllers are connected.
  • name - The name of the controller axis to check.
§Returns
  • f32 - The axis value ranging from -1.0 to 1.0.

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

Source§

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

Source§

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.