Struct Color

Source
pub struct Color {
    pub r: u8,
    pub g: u8,
    pub b: u8,
    pub a: Option<u8>,
}
Expand description

RGB color type with optional alpha channel

Fields§

§r: u8§g: u8§b: u8§a: Option<u8>

Implementations§

Source§

impl Color

Source

pub const fn rgb(r: u8, g: u8, b: u8) -> Color

Constructs a new Color without using an alpha channel.

§Examples

Basic usage:

use pixelflut::Color;
Color::rgb(255, 255, 255);
Source

pub const fn rgba(r: u8, g: u8, b: u8, a: u8) -> Color

Constructs a new Color using an alpha channel.

§Examples

Basic usage:

use pixelflut::Color;
Color::rgba(255, 255, 255, 255);
Source

pub const fn alpha(self) -> u8

Returns the alpha channel of the Color.

If the color does not have an alpha channel, 255 will be returned.

§Example
use pixelflut::Color;

let without_alpha = Color::rgb(123, 123, 123);
assert_eq!(without_alpha.alpha(), 255);

let with_alpha = Color::rgba(123, 123, 123, 123);
assert_eq!(with_alpha.alpha(), 123)
Source

pub const fn packed(r: u8, g: u8, b: u8, a: u8) -> Color

Constructs a new Color using the alpha channel only, if a != 255.

§Examples

Basic usage:

use pixelflut::Color;
assert_eq!(Color::packed(123, 23, 42, 255), Color::rgb(123, 23, 42));
assert_eq!(Color::packed(123, 23, 42, 64), Color::rgba(123, 23, 42, 64));
Source

pub const fn pack(&self) -> Color

Strips the alpha channel if not existent or value is 255.Color

§Examples

Basic usage:

use pixelflut::Color;
assert_eq!(Color::rgba(12, 34, 56, 255).pack(), Color::rgb(12, 34, 56));
assert_eq!(Color::rgb(12, 34, 56).pack(), Color::rgb(12, 34, 56));
assert_eq!(Color::rgba(12, 34, 56, 78).pack(), Color::rgba(12, 34, 56, 78));
Source

pub const fn normalized(self) -> (u8, u8, u8, u8)

Returns a 4-Tuple with the components red, green, blue and alpha

If no alpha channel is present, 255 is returned as the alpha channel.

§Examples
use pixelflut::Color;
assert_eq!((255, 0, 0, 255), Color::rgb(255, 0, 0).normalized())

Trait Implementations§

Source§

impl Clone for Color

Source§

fn clone(&self) -> Color

Returns a duplicate 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 Debug for Color

Source§

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

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

impl Default for Color

Source§

fn default() -> Color

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

impl Display for Color

Source§

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

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

impl From<(u8, u8, u8)> for Color

Source§

fn from(color: (u8, u8, u8)) -> Color

Returns a RGB Color

Source§

impl From<(u8, u8, u8, u8)> for Color

Source§

fn from(color: (u8, u8, u8, u8)) -> Color

Returns a RGBA Color

Source§

impl From<Color> for (u8, u8, u8)

Source§

fn from(color: Color) -> (u8, u8, u8)

Converts to this type from the input type.
Source§

impl From<Color> for (u8, u8, u8, u8)

Source§

fn from(color: Color) -> (u8, u8, u8, u8)

Converts to this type from the input type.
Source§

impl From<Rgb<u8>> for Color

Source§

fn from(color: Rgb<u8>) -> Color

Returns a Rgb Color

Source§

impl From<Rgba<u8>> for Color

Source§

fn from(color: Rgba<u8>) -> Color

Returns a Rgba Color

Source§

impl FromStr for Color

Source§

fn from_str(s: &str) -> PixelflutResult<Color>

Converts a string to a color

§Examples
use pixelflut::Color;
assert_eq!(Color::rgb(0x11, 0x22, 0x33), "112233".parse().unwrap());
assert_eq!(Color::rgba(0x11, 0x22, 0x33, 0xee), "112233ee".parse().unwrap());
assert!("".parse::<Color>().is_err());
assert!("123".parse::<Color>().is_err());
assert!("12345".parse::<Color>().is_err());
assert!(" 1 2 3".parse::<Color>().is_err());
assert!("112g33".parse::<Color>().is_err());
Source§

type Err = PixelflutError

The associated error which can be returned from parsing.
Source§

impl Hash for Color

Source§

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

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 Into<Rgb<u8>> for Color

Source§

fn into(self) -> Rgb<u8>

Converts this type into the (usually inferred) input type.
Source§

impl Into<Rgba<u8>> for Color

Source§

fn into(self) -> Rgba<u8>

Converts this type into the (usually inferred) input type.
Source§

impl PartialEq for Color

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Copy for Color

Source§

impl StructuralPartialEq for Color

Auto Trait Implementations§

§

impl Freeze for Color

§

impl RefUnwindSafe for Color

§

impl Send for Color

§

impl Sync for Color

§

impl Unpin for Color

§

impl UnwindSafe for Color

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where 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<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

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

Source§

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 T
where U: TryFrom<T>,

Source§

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.