Enum Direction 

pub enum Direction {
    Up,
    Down,
    Left,
    Right,
}

One of four cardinal scroll directions.

Combined with a crate::motion::MotionRate, a Direction fully specifies how the visible window slides over a jumbo background buffer: the rate supplies the speed, the direction supplies the axis and sign.

Variants

Up

Content scrolls upward (Star Wars crawl default).

Down

Content scrolls downward.

Left

Content scrolls to the left (news ticker default).

Right

Content scrolls to the right.

Implementations

impl Direction

pub const fn is_vertical(self) -> bool

Returns true if this direction is vertical (Up or Down).

pub const fn is_horizontal(self) -> bool

Returns true if this direction is horizontal (Left or Right).

pub const fn sign(self) -> i32

Sign of the scroll offset along the scroll axis.

+1 when the scroll accumulator should grow per frame (Direction::Down / Direction::Right) and -1 when it should shrink (Direction::Up / Direction::Left).

Trait Implementations

impl Clone for Direction

fn clone(&self) -> Direction

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Direction

impl Debug for Direction

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

Formats the value using the given formatter.

impl Eq for Direction

impl PartialEq for Direction

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Direction