Struct gilrs::gamepad::Gamepad

pub struct Gamepad<'a> {
    data: &'a GamepadData,
    inner: &'a Gamepad,
}

Represents handle to game controller.

Using this struct you can access cached gamepad state, information about gamepad such as name or UUID and manage force feedback effects.

Fields

data: &'a GamepadData

inner: &'a Gamepad

Implementations

impl<'a> Gamepad<'a>

pub fn name(&self) -> &str

Returns the mapping name if it exists otherwise returns the os provided name.

pub fn map_name(&self) -> Option<&str>

if mapping_source() is SdlMappings returns the name of the mapping used by the gamepad. Otherwise returns None.

pub fn os_name(&self) -> &str

Returns the name of the gamepad supplied by the OS.

pub fn uuid(&self) -> [u8; 16]

Returns gamepad’s UUID.

It is recommended to process with the UUID crate. Use Uuid::from_bytes method to create a Uuid from the returned bytes.

pub fn vendor_id(&self) -> Option<u16>

Returns the vendor ID, as assigned by the USB-IF, when available.

pub fn product_id(&self) -> Option<u16>

Returns the product ID, as assigned by the vendor, when available.

pub fn state(&self) -> &GamepadState

Returns cached gamepad state.

pub fn is_connected(&self) -> bool

Returns true if gamepad is connected.

pub fn is_pressed(&self, btn: Button) -> bool

Examines cached gamepad state to check if given button is pressed. Panics if btn is Unknown.

If you know Code of the element that you want to examine, it’s recommended to use methods directly on State, because this version have to check which Code is mapped to element of gamepad.

pub fn value(&self, axis: Axis) -> f32

Examines cached gamepad state to check axis’s value. Panics if axis is Unknown.

If you know Code of the element that you want to examine, it’s recommended to use methods directly on State, because this version have to check which Code is mapped to element of gamepad.

pub fn button_data(&self, btn: Button) -> Option<&ButtonData>

Returns button state and when it changed.

If you know Code of the element that you want to examine, it’s recommended to use methods directly on State, because this version have to check which Code is mapped to element of gamepad.

pub fn axis_data(&self, axis: Axis) -> Option<&AxisData>

Returns axis state and when it changed.

If you know Code of the element that you want to examine, it’s recommended to use methods directly on State, because this version have to check which Code is mapped to element of gamepad.

pub fn power_info(&self) -> PowerInfo

Returns device’s power supply state. See PowerInfo for details.

pub fn mapping_source(&self) -> MappingSource

Returns source of gamepad mapping. Can be used to filter gamepads which do not provide unified controller layout.

use gilrs::MappingSource;

for (_, gamepad) in gilrs.gamepads().filter(
    |gp| gp.1.mapping_source() != MappingSource::None)
{
    println!("{} is ready to use!", gamepad.name());
}

pub fn is_ff_supported(&self) -> bool

Returns true if force feedback is supported by device.

pub fn set_listener_position<Vec3: Into<[f32; 3]>>( &self, position: Vec3, ) -> Result<(), FfError>

Change gamepad position used by force feedback effects.

pub fn axis_or_btn_name(&self, ec: Code) -> Option<AxisOrBtn>

Returns AxisOrBtn mapped to Code.

pub fn button_code(&self, btn: Button) -> Option<Code>

Returns Code associated with btn.

pub fn axis_code(&self, axis: Axis) -> Option<Code>

Returns Code associated with axis.

pub fn deadzone(&self, axis: Code) -> Option<f32>

Returns area in which axis events should be ignored.

pub fn id(&self) -> GamepadId

Returns ID of gamepad.

pub(crate) fn mapping(&self) -> &Mapping

Trait Implementations

impl<'a> Clone for Gamepad<'a>

fn clone(&self) -> Gamepad<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Gamepad<'a>

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

Formats the value using the given formatter.

impl<'a> Copy for Gamepad<'a>