Enum agb::input::Tri

pub enum Tri {
    Positive = 1,
    Zero = 0,
    Negative = -1,
}

Tri-state enum. Allows for -1, 0 and +1. Useful if checking if the D-Pad is pointing left, right, or unpressed.

Note that Tri can be converted directly to a signed integer, so can easily be used to update positions of things in games

Examples

use agb::input::Tri;

let x = 5;
let tri = Tri::Positive; // e.g. from button_controller.x_tri()

assert_eq!(x + tri as i32, 6);

Variants

Positive = 1

Right or down

Zero = 0

Unpressed

Negative = -1

Left or up

Trait Implementations

impl Clone for Tri

fn clone(&self) -> Tri

Returns a copy of the value.

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

Performs copy-assignment from source.

impl From<(bool, bool)> for Tri

fn from(a: (bool, bool)) -> Tri

Converts to this type from the input type.

impl Ord for Tri

fn cmp(&self, other: &Tri) -> 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 Tri

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

fn partial_cmp(&self, other: &Tri) -> 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 Tri

impl Eq for Tri

impl StructuralPartialEq for Tri