Enum quicksilver::input::ButtonState

#[repr(u8)]
pub enum ButtonState {
    Pressed,
    Held,
    Released,
    NotPressed,
}

The current state of a button

Variants

Pressed

The button was activated this frame

Held

The button is active but was not activated this frame

Released

The button was released this frame

NotPressed

The button is not active but was not released this frame

Methods

impl ButtonState

pub fn is_down(&self) -> bool

Determine if the button is either Pressed or Held

#[must_use] pub fn clear_temporary(&self) -> ButtonState

Convert the button from a temporary state to a permanent state

Pressed states become Held, Released states become NotPressed

Trait Implementations

impl Clone for ButtonState

fn clone(&self) -> ButtonState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for ButtonState

impl Eq for ButtonState

impl PartialEq<ButtonState> for ButtonState

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Debug for ButtonState

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

Formats the value using the given formatter.

impl Hash for ButtonState

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].