pub enum BinaryColor {
    Off,
    On,
}
Expand description

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.

Implementations§

source§

impl BinaryColor

source

pub const fn invert(self) -> BinaryColor

Inverts the color.

Examples
use embedded_graphics::pixelcolor::BinaryColor;

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

pub const fn is_on(self) -> bool

Returns true if this color is On.

Examples
use embedded_graphics::pixelcolor::BinaryColor;

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

pub const 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§

source§

impl Clone for BinaryColor

source§

fn clone(&self) -> BinaryColor

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl ColorMapping for BinaryColor

source§

fn char_to_color(c: char) -> Self

Converts a char into a color of type C.
source§

fn color_to_char(color: Self) -> char

Converts a color of type C into a char.
source§

const NONE_COLOR: Rgb888 = _

Color used to display None values when EG_FANCY_PANIC is enabled. Read more
source§

impl Debug for BinaryColor

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for BinaryColor

source§

fn default() -> BinaryColor

Returns the “default value” for a type. Read more
source§

impl Format for BinaryColor

source§

fn format(&self, f: Formatter<'_>)

Writes the defmt representation of self to fmt.
source§

impl From<Bgr555> for BinaryColor

source§

fn from(color: Bgr555) -> BinaryColor

Converts to this type from the input type.
source§

impl From<Bgr565> for BinaryColor

source§

fn from(color: Bgr565) -> BinaryColor

Converts to this type from the input type.
source§

impl From<Bgr666> for BinaryColor

source§

fn from(color: Bgr666) -> BinaryColor

Converts to this type from the input type.
source§

impl From<Bgr888> for BinaryColor

source§

fn from(color: Bgr888) -> BinaryColor

Converts to this type from the input type.
source§

impl From<BinaryColor> for Bgr555

source§

fn from(color: BinaryColor) -> Bgr555

Converts to this type from the input type.
source§

impl From<BinaryColor> for Bgr565

source§

fn from(color: BinaryColor) -> Bgr565

Converts to this type from the input type.
source§

impl From<BinaryColor> for Bgr666

source§

fn from(color: BinaryColor) -> Bgr666

Converts to this type from the input type.
source§

impl From<BinaryColor> for Bgr888

source§

fn from(color: BinaryColor) -> Bgr888

Converts to this type from the input type.
source§

impl From<BinaryColor> for Gray2

source§

fn from(color: BinaryColor) -> Gray2

Converts to this type from the input type.
source§

impl From<BinaryColor> for Gray4

source§

fn from(color: BinaryColor) -> Gray4

Converts to this type from the input type.
source§

impl From<BinaryColor> for Gray8

source§

fn from(color: BinaryColor) -> Gray8

Converts to this type from the input type.
source§

impl From<BinaryColor> for RawU1

source§

fn from(color: BinaryColor) -> RawU1

Converts to this type from the input type.
source§

impl From<BinaryColor> for Rgb555

source§

fn from(color: BinaryColor) -> Rgb555

Converts to this type from the input type.
source§

impl From<BinaryColor> for Rgb565

source§

fn from(color: BinaryColor) -> Rgb565

Converts to this type from the input type.
source§

impl From<BinaryColor> for Rgb666

source§

fn from(color: BinaryColor) -> Rgb666

Converts to this type from the input type.
source§

impl From<BinaryColor> for Rgb888

source§

fn from(color: BinaryColor) -> Rgb888

Converts to this type from the input type.
source§

impl From<Gray2> for BinaryColor

source§

fn from(color: Gray2) -> BinaryColor

Converts to this type from the input type.
source§

impl From<Gray4> for BinaryColor

source§

fn from(color: Gray4) -> BinaryColor

Converts to this type from the input type.
source§

impl From<Gray8> for BinaryColor

source§

fn from(color: Gray8) -> BinaryColor

Converts to this type from the input type.
source§

impl From<RawU1> for BinaryColor

source§

fn from(data: RawU1) -> BinaryColor

Converts to this type from the input type.
source§

impl From<Rgb555> for BinaryColor

source§

fn from(color: Rgb555) -> BinaryColor

Converts to this type from the input type.
source§

impl From<Rgb565> for BinaryColor

source§

fn from(color: Rgb565) -> BinaryColor

Converts to this type from the input type.
source§

impl From<Rgb666> for BinaryColor

source§

fn from(color: Rgb666) -> BinaryColor

Converts to this type from the input type.
source§

impl From<Rgb888> for BinaryColor

source§

fn from(color: Rgb888) -> BinaryColor

Converts to this type from the input type.
source§

impl From<bool> for BinaryColor

source§

fn from(value: bool) -> BinaryColor

Converts to this type from the input type.
source§

impl Hash for BinaryColor

source§

fn hash<__H>(&self, state: &mut __H)where __H: Hasher,

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

impl Ord for BinaryColor

source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval. Read more
source§

impl PartialEq<BinaryColor> for BinaryColor

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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.
source§

impl PartialOrd<BinaryColor> for BinaryColor

source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

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

impl PixelColor for BinaryColor

§

type Raw = RawU1

Raw data type. Read more
source§

impl Copy for BinaryColor

source§

impl Eq for BinaryColor

source§

impl StructuralEq for BinaryColor

source§

impl StructuralPartialEq for BinaryColor

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Az for T

source§

fn az<Dst>(self) -> Dstwhere T: Cast<Dst>,

Casts the value.
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<Src, Dst> CastFrom<Src> for Dstwhere Src: Cast<Dst>,

source§

fn cast_from(src: Src) -> Dst

Casts the value.
source§

impl<T> CheckedAs for T

source§

fn checked_as<Dst>(self) -> Option<Dst>where T: CheckedCast<Dst>,

Casts the value.
source§

impl<Src, Dst> CheckedCastFrom<Src> for Dstwhere Src: CheckedCast<Dst>,

source§

fn checked_cast_from(src: Src) -> Option<Dst>

Casts the value.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<C> IntoStorage for Cwhere C: PixelColor, <C as PixelColor>::Raw: From<C>,

§

type Storage = <<C as PixelColor>::Raw as RawData>::Storage

The underlying storage type for the pixel color
source§

fn into_storage(self) -> <C as IntoStorage>::Storage

Convert the PixelColor into its raw storage form
source§

impl<Src, Dst> LosslessTryInto<Dst> for Srcwhere Dst: LosslessTryFrom<Src>,

source§

fn lossless_try_into(self) -> Option<Dst>

Performs the conversion.
source§

impl<Src, Dst> LossyInto<Dst> for Srcwhere Dst: LossyFrom<Src>,

source§

fn lossy_into(self) -> Dst

Performs the conversion.
source§

impl<T> OverflowingAs for T

source§

fn overflowing_as<Dst>(self) -> (Dst, bool)where T: OverflowingCast<Dst>,

Casts the value.
source§

impl<Src, Dst> OverflowingCastFrom<Src> for Dstwhere Src: OverflowingCast<Dst>,

source§

fn overflowing_cast_from(src: Src) -> (Dst, bool)

Casts the value.
source§

impl<T> Same<T> for T

§

type Output = T

Should always be Self
source§

impl<T> SaturatingAs for T

source§

fn saturating_as<Dst>(self) -> Dstwhere T: SaturatingCast<Dst>,

Casts the value.
source§

impl<Src, Dst> SaturatingCastFrom<Src> for Dstwhere Src: SaturatingCast<Dst>,

source§

fn saturating_cast_from(src: Src) -> Dst

Casts the value.
§

impl<SS, SP> SupersetOf<SS> for SPwhere SS: SubsetOf<SP>,

§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
source§

impl<C> ToBytes for Cwhere C: PixelColor + Into<<C as PixelColor>::Raw>,

§

type Bytes = <<C as PixelColor>::Raw as ToBytes>::Bytes

Return type of methods in this trait.
source§

fn to_le_bytes(self) -> <C as ToBytes>::Bytes

Converts a color into a byte array with little endian byte order.
source§

fn to_be_bytes(self) -> <C as ToBytes>::Bytes

Converts a color into a byte array with big endian byte order.
source§

fn to_ne_bytes(self) -> <C as ToBytes>::Bytes

Converts a color into a byte array with native byte order.
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> UnwrappedAs for T

source§

fn unwrapped_as<Dst>(self) -> Dstwhere T: UnwrappedCast<Dst>,

Casts the value.
source§

impl<Src, Dst> UnwrappedCastFrom<Src> for Dstwhere Src: UnwrappedCast<Dst>,

source§

fn unwrapped_cast_from(src: Src) -> Dst

Casts the value.
source§

impl<T> WrappingAs for T

source§

fn wrapping_as<Dst>(self) -> Dstwhere T: WrappingCast<Dst>,

Casts the value.
source§

impl<Src, Dst> WrappingCastFrom<Src> for Dstwhere Src: WrappingCast<Dst>,

source§

fn wrapping_cast_from(src: Src) -> Dst

Casts the value.
source§

impl<T> Scalar for Twhere T: 'static + Clone + PartialEq<T> + Debug,