Struct crankit_input::ButtonsState

#[non_exhaustive]
pub struct ButtonsState {
    pub current: Set,
    pub pushed: Set,
    pub released: Set,
}

State of the playdate buttons

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

current: Set

Buttons currently being pressed

pushed: Set

Buttons that have just started to be pressed

Meaning they were not pressed last frame, and are now currently pressed

released: Set

Buttons that have just been released

Meaning they were pressed last frame, and are no longer pressed

Implementations

impl State

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

Returns true if the given button is currently pressed

pub fn is_just_pressed(self, button: Button) -> bool

Returns true if the given button is has just started to be pressed

Meaning it was not pressed last frame, and is now currently pressed

pub fn is_just_released(self, button: Button) -> bool

Returns true if the given button is has just started to be pressed

Meaning it was pressed last frame, and is no longer pressed

pub fn is_any_pressed(&self, buttons: Set) -> bool

Returns true if any of the given button is currently pressed

pub fn is_any_just_pressed(&self, buttons: Set) -> bool

Returns true if any of the given button was just pressed

pub fn is_any_just_released(&self, buttons: Set) -> bool

Returns true if any of the given button was just released

pub fn d_pad<T: From<i8>>(self) -> [T; 2]

Returns the currently pressed state of the d-pad as a 2d vector

See Self::d_pad for more details

pub fn d_pad_just_pressed<T: From<i8>>(self) -> [T; 2]

Returns the buttons of the d-pad that have just started to be pressed as a 2d vector

See Self::d_pad for more details

pub fn d_pad_just_released<T: From<i8>>(self) -> [T; 2]

Returns the buttons of the d-pad that have just been released as a 2d vector

See Self::d_pad for more details

Trait Implementations

impl Clone for State

fn clone(&self) -> State

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for State

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

Formats the value using the given formatter.

impl PartialEq for State

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for State

impl Eq for State

impl StructuralEq for State

impl StructuralPartialEq for State