Struct dither::color::RGB

pub struct RGB<N>(pub N, pub N, pub N);

RGB represents a triplet of pixels (r, g, b). RGB<u8>, RGB<i8>, RGB<i16>, and RGB<u16> are all one-word COPY types.

Methods

impl<P> RGB<P>

pub fn convert_with<Q>(self, convert: impl FnMut(P) -> Q) -> RGB<Q>

map a function across all channels of the RGB.

assert_eq!(RGB(2_u8, 5, 8).convert_with(|channel| channel+10), RGB(12_u8, 15, 18));

pub fn map_across(
    quantize: impl FnMut(P) -> (P, P)
) -> impl FnMut(RGB<P>) -> (RGB<P>, RGB<P>)

this higher-order function takes a function from function from P to (P, P) and creates the equivalent function that maps it across RGB

.

impl RGB<f64>

pub fn to_chroma_corrected_black_and_white(&self) -> f64

impl RGB<u8>

pub const unsafe fn from_hex(hex: u32) -> Self

convert a hexidecimal code to the appropriate RGB value, silently discarding the highest 8 bits, if they exist. Proper use should ensure that the input is less than or equal to 0xFFFFFF

assert_eq!(unsafe{RGB::from_hex(0xff_aa_bb)}, RGB(0xff, 0xaa, 0xbb));

pub fn from_chroma_corrected_black_and_white(p: f64) -> Self

pub fn to_hex(self) -> u32

convert to the equivalent 24-bit hexidecimal integer.

assert_eq!(RGB(0xff, 0, 0).to_hex(), 0xff_00_00)

Trait Implementations

impl Copy for RGB<u8>

impl Copy for RGB<i8>

impl Copy for RGB<i16>

impl Copy for RGB<u16>

impl<N: PartialEq> PartialEq<RGB<N>> for RGB<N>

fn eq(&self, other: &RGB<N>) -> bool

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

fn ne(&self, other: &RGB<N>) -> bool

This method tests for !=.

impl<N: Default> Default for RGB<N>

fn default() -> RGB<N>

Returns the "default value" for a type.

impl From<RGB<u8>> for RGB<f64>

fn from(rgb: RGB<u8>) -> Self

Performs the conversion.

impl<N: Copy, M: From<N>> From<[N; 3]> for RGB<M>

fn from(a: [N; 3]) -> Self

Performs the conversion.

impl<N, M: From<N>> From<(N, N, N)> for RGB<M>

fn from((r, g, b): (N, N, N)) -> Self

Performs the conversion.

impl<N: Clone> Clone for RGB<N>

fn clone(&self) -> RGB<N>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<N: Eq> Eq for RGB<N>

impl<N: Debug> Debug for RGB<N>

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

Formats the value using the given formatter.

impl<N: Sub<Output = N>> Sub<RGB<N>> for RGB<N>

type Output = Self

The resulting type after applying the - operator.

fn sub(self, other: Self) -> Self

Performs the - operation.

impl<N: Hash> Hash for RGB<N>

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

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<N: Add<Output = N>> Add<RGB<N>> for RGB<N>

type Output = Self

The resulting type after applying the + operator.

fn add(self, other: Self) -> Self

Performs the + operation.

impl<S: Mul<Output = S> + Copy> Mul<S> for RGB<S>

type Output = Self

The resulting type after applying the * operator.

fn mul(self, s: S) -> Self

Performs the * operation.

impl<S: Div<Output = S> + Copy> Div<S> for RGB<S>

type Output = Self

The resulting type after applying the / operator.

fn div(self, s: S) -> Self

Performs the / operation.

impl<S: Rem<Output = S> + Copy> Rem<S> for RGB<S>

type Output = Self

The resulting type after applying the % operator.

fn rem(self, s: S) -> Self

Performs the % operation.

impl<N: Neg<Output = N>> Neg for RGB<N>

type Output = Self

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl<T: From<u8>> FromStr for RGB<T>

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl LowerHex for RGB<u8>

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

Formats the value using the given formatter.

impl UpperHex for RGB<u8>

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

Formats the value using the given formatter.