Struct gba_hal::data::KeyInput

#[repr(transparent)]
pub struct KeyInput(pub u16);

This is the GBA's native key reading value.

The term "native" here means "low-active". In other words, false == "pressed", and true is "released".

You probably actually want to have "normal" style key data, where false == "released" and true == "pressed". To get this you must XOR the lower 10 bits of the inner value:

let high_active_keys_value = key_input.0 ^ 0b11_1111_1111;

That's not provided by this crate because this crate sticks to minimal declarations. You can of course use the gba crate for this and other helpful higher level abstractions.

The bits are as follows:

• 0: a
• 1: b
• 2: select
• 3: start
• 4: right
• 5: left
• 6: up
• 7: down
• 8: r
• 9: l

Methods

impl KeyInput

pub const fn new() -> Self

A const "zero value" constructor

impl KeyInput

pub const A_RELEASED_BIT: u16

pub const fn a_released(self) -> bool

pub const fn with_a_released(self, bit: bool) -> Self

pub const B_RELEASED_BIT: u16

pub const fn b_released(self) -> bool

pub const fn with_b_released(self, bit: bool) -> Self

pub const SELECT_RELEASED_BIT: u16

pub const fn select_released(self) -> bool

pub const fn with_select_released(self, bit: bool) -> Self

pub const START_RELEASED_BIT: u16

pub const fn start_released(self) -> bool

pub const fn with_start_released(self, bit: bool) -> Self

pub const RIGHT_RELEASED_BIT: u16

pub const fn right_released(self) -> bool

pub const fn with_right_released(self, bit: bool) -> Self

pub const LEFT_RELEASED_BIT: u16

pub const fn left_released(self) -> bool

pub const fn with_left_released(self, bit: bool) -> Self

pub const UP_RELEASED_BIT: u16

pub const fn up_released(self) -> bool

pub const fn with_up_released(self, bit: bool) -> Self

pub const DOWN_RELEASED_BIT: u16

pub const fn down_released(self) -> bool

pub const fn with_down_released(self, bit: bool) -> Self

pub const R_RELEASED_BIT: u16

pub const fn r_released(self) -> bool

pub const fn with_r_released(self, bit: bool) -> Self

pub const L_RELEASED_BIT: u16

pub const fn l_released(self) -> bool

pub const fn with_l_released(self, bit: bool) -> Self

Trait Implementations

impl PartialEq<KeyInput> for KeyInput

fn eq(&self, other: &KeyInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &KeyInput) -> bool

This method tests for !=.

impl Eq for KeyInput

impl Copy for KeyInput

impl Debug for KeyInput

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

Formats the value using the given formatter.

impl Clone for KeyInput

fn clone(&self) -> KeyInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for KeyInput

fn default() -> KeyInput

Returns the "default value" for a type.