Struct firefly_rust::DPad

pub struct DPad {
    pub left: bool,
    pub right: bool,
    pub up: bool,
    pub down: bool,
}

DPad-like representation of the Pad.

Constructed with Pad::as_dpad. Useful for simple games and ports. The middle of the pad is a “dead zone” pressing which will not activate any direction.

Invariant: it’s not possible for opposite directions (left and right, or down and up) to be active at the same time. However, it’s possible for heighboring directions (like up and right) to be active at the same time if the player presses a diagonal.

Fields

left: bool

right: bool

up: bool

down: bool

Implementations

impl DPad

pub fn just_pressed(&self, old: &Self) -> Self

Given the old state, get directions that were not pressed but are pressed now.

pub fn just_released(&self, old: &Self) -> Self

Given the old state, get directions that were pressed but aren’t pressed now.

pub fn held(&self, old: &Self) -> Self

Given the old state, get directions that were pressed and are still pressed now.

Trait Implementations

impl Clone for DPad

fn clone(&self) -> DPad

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DPad

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

Formats the value using the given formatter.

impl Default for DPad

fn default() -> DPad

Returns the “default value” for a type.

impl From<Pad> for DPad

fn from(value: Pad) -> Self

Converts to this type from the input type.

impl Hash for DPad

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for DPad

fn cmp(&self, other: &DPad) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for DPad

fn eq(&self, other: &DPad) -> 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 PartialOrd for DPad

fn partial_cmp(&self, other: &DPad) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for DPad

impl Eq for DPad

impl StructuralPartialEq for DPad