Enum embedded_graphics::pixelcolor::BinaryColor

pub enum BinaryColor {
    Off,
    On,
}

Binary color.

BinaryColor is used for displays and images with two possible color states.

The interpretation of active and inactive states can be different for different types of displays. A BinaryColor::On might represent a black pixel on an LCD and a white pixel on an OLED display.

To simplify the conversion from BinaryColor to RGB and grayscale color types the default conversions assume that BinaryColor::Off is black and BinaryColor::On is white.

Conversion between BinaryColor and bool

use embedded_graphics::pixelcolor::BinaryColor;

// A BinaryColor can be converted to a bool by using the is_on and is_off methods.
let color = BinaryColor::On;
assert!(color.is_on());
assert!(color.invert().is_off());

// BinaryColor implements From<bool>.
let bool_value = true;
let color: BinaryColor = bool_value.into();
assert_eq!(color, BinaryColor::On);

// this is equivalent to:
let bool_value = true;
let color = if bool_value {
    BinaryColor::On
} else {
    BinaryColor::Off
};
assert_eq!(color, BinaryColor::On);

Variants

Off

Inactive pixel.

On

Active pixel.

Methods

impl BinaryColor

pub fn invert(self) -> Self

Inverts the color.

Examples

use embedded_graphics::pixelcolor::BinaryColor;

assert_eq!(BinaryColor::Off.invert(), BinaryColor::On);
assert_eq!(BinaryColor::On.invert(), BinaryColor::Off);

pub fn is_on(self) -> bool

Returns true if this color is On.

Examples

use embedded_graphics::pixelcolor::BinaryColor;

assert!(BinaryColor::On.is_on());

pub fn is_off(self) -> bool

Returns true if this color is Off.

Examples

use embedded_graphics::pixelcolor::BinaryColor;

assert!(BinaryColor::Off.is_off());

Trait Implementations

impl Clone for BinaryColor

fn clone(&self) -> BinaryColor

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ColorMapping<BinaryColor> for BinaryColor

fn char_to_color(c: char) -> Self

Converts a char into a color of type C.

fn color_to_char(color: BinaryColor) -> char

Converts a color of type C into a char.

impl Copy for BinaryColor

impl Debug for BinaryColor

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

Formats the value using the given formatter.

impl Default for BinaryColor

fn default() -> Self

Returns the "default value" for a type.

impl Eq for BinaryColor

impl From<BinaryColor> for RawU1

fn from(color: BinaryColor) -> Self

Performs the conversion.

impl From<BinaryColor> for Rgb555

fn from(color: BinaryColor) -> Self

Performs the conversion.

impl From<BinaryColor> for Bgr555

fn from(color: BinaryColor) -> Self

Performs the conversion.

impl From<BinaryColor> for Rgb565

fn from(color: BinaryColor) -> Self

Performs the conversion.

impl From<BinaryColor> for Bgr565

fn from(color: BinaryColor) -> Self

Performs the conversion.

impl From<BinaryColor> for Rgb888

fn from(color: BinaryColor) -> Self

Performs the conversion.

impl From<BinaryColor> for Bgr888

fn from(color: BinaryColor) -> Self

Performs the conversion.

impl From<BinaryColor> for Gray2

fn from(color: BinaryColor) -> Self

Performs the conversion.

impl From<BinaryColor> for Gray4

fn from(color: BinaryColor) -> Self

Performs the conversion.

impl From<BinaryColor> for Gray8

fn from(color: BinaryColor) -> Self

Performs the conversion.

impl From<RawU1> for BinaryColor

fn from(data: RawU1) -> Self

Performs the conversion.

impl From<bool> for BinaryColor

fn from(value: bool) -> Self

Performs the conversion.

impl Hash for BinaryColor

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].

impl Ord for BinaryColor

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

This method returns an [Ordering] between self and other.

#[must_use] fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use] fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use] fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<BinaryColor> for BinaryColor

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

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

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

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

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

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

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

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

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

#[must_use] 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 PixelColor for BinaryColor

type Raw = RawU1

Raw data type.

impl StructuralEq for BinaryColor

impl StructuralPartialEq for BinaryColor