Struct Orientation

pub struct Orientation {
    pub rotation: Rotation,
    pub mirrored: bool,
}

Display orientation.

A display orientation describes how the display content is oriented relative to the default orientation of the display.

Examples

use lcd_async::options::{Orientation, Rotation};

// Rotate display content by 90 degree clockwise.
let rotated = Orientation::new().rotate(Rotation::Deg90);

// Flip display content horizontally.
let flipped = Orientation::new().flip_horizontal();

Multiple transformations can be combined to build more complex orientations:

use lcd_async::options::{Orientation, Rotation};

let orientation = Orientation::new().rotate(Rotation::Deg270).flip_vertical();

// Note that the order of operations is important:
assert_ne!(orientation, Orientation::new().flip_vertical().rotate(Rotation::Deg270));
assert_eq!(orientation, Orientation::new().flip_vertical().rotate(Rotation::Deg90));

Fields

rotation: Rotation

Rotation.

mirrored: bool

Mirrored.

Implementations

impl Orientation

pub const fn new() -> Self

Creates a default orientation.

pub const fn rotate(self, rotation: Rotation) -> Self

Rotates the orientation.

pub const fn flip_horizontal(self) -> Self

Flips the orientation across the horizontal axis.

pub const fn flip_vertical(self) -> Self

Flips the orientation across the vertical axis.

Trait Implementations

impl Clone for Orientation

fn clone(&self) -> Orientation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Orientation

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

Formats the value using the given formatter.

impl Default for Orientation

fn default() -> Self

Returns the “default value” for a type.

impl Hash for Orientation

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 Orientation

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

Restrict a value to a certain interval.

impl PartialEq for Orientation

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for Orientation

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Copy for Orientation

impl Eq for Orientation

impl StructuralPartialEq for Orientation