Struct stick::Port

pub struct Port { /* fields omitted */ }

An interface to all joystick, gamepad and controller devices.

Methods

impl Port

pub fn new() -> Port

Create a new interface to all joystick, gamepad and controller devices currently plugged in to this computer.

pub fn poll(&mut self) -> Option<u8>

Block thread until input is available.

pub fn get(&self, stick: u8) -> Option<&Device>

Get the state of a device

pub fn swap(&mut self, a: u8, b: u8)

Swap two devices in the interface by their indexes.

Panics

If either a or b are out of bounds.

Note

This is useful for if in a game, you want P1 and P2 to swap which controller they are assigned to. You can do this with:

// Assuming P1 is at index 0, and P2 is at index 1,
devices.swap(0, 1);

pub fn name(&self, a: u8) -> String

Get the name of a device by index.

pub fn count(&self) -> u8

Get the number of plugged in controllers.

Trait Implementations

impl Default for Port

fn default() -> Self

Returns the "default value" for a type.