Struct smart_leds::RGB

#[repr(C)]
pub struct RGB<ComponentType> {
    pub r: ComponentType,
    pub g: ComponentType,
    pub b: ComponentType,
}

The RGB pixel

The component type can be u8 (aliased as RGB8), u16 (aliased as RGB16), or any other type (but simple copyable types are recommended.)

Fields

r: ComponentType

Red

g: ComponentType

Green

b: ComponentType

Blue

Methods

impl<T> RGB<T>

pub const fn new(r: T, g: T, b: T) -> RGB<T>

Convenience function for creating a new pixel

impl<T> RGB<T> where
    T: Clone, 

pub fn iter(&self) -> Cloned<Iter<T>>

Iterate over color components (R, G, and B)

pub fn alpha(&self, a: T) -> RGBA<T, T>

pub fn new_alpha<A>(&self, a: A) -> RGBA<T, A>

Trait Implementations

impl<T, B> ComponentMap<RGB<B>, T, B> for RGB<T> where
    T: Copy, 

fn map<F>(&self, f: F) -> RGB<B> where
    F: FnMut(T) -> B, 

Convenience function (equivalent of self.iter().map().collect()) for applying the same formula to every component.

impl<ComponentType> PartialEq<RGB<ComponentType>> for RGB<ComponentType> where
    ComponentType: PartialEq<ComponentType>, 

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

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

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

This method tests for !=.

impl<ComponentType> Debug for RGB<ComponentType> where
    ComponentType: Debug, 

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

Formats the value using the given formatter.

impl<T> AsMut<[T]> for RGB<T>

fn as_mut(&mut self) -> &mut [T]

Performs the conversion.

impl From<RGB<i16>> for RGB<f64>

fn from(other: RGB<i16>) -> RGB<f64>

Performs the conversion.

impl From<RGB<f32>> for RGB<f64>

fn from(other: RGB<f32>) -> RGB<f64>

Performs the conversion.

impl From<RGB<u16>> for RGB<f64>

fn from(other: RGB<u16>) -> RGB<f64>

Performs the conversion.

impl From<RGB<u16>> for RGB<i32>

fn from(other: RGB<u16>) -> RGB<i32>

Performs the conversion.

impl<T> From<[T; 3]> for RGB<T> where
    T: Copy, 

fn from(other: [T; 3]) -> RGB<T>

Performs the conversion.

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

fn from(other: RGB<u8>) -> RGB<f64>

Performs the conversion.

impl From<RGB<u16>> for RGB<f32>

fn from(other: RGB<u16>) -> RGB<f32>

Performs the conversion.

impl<T> From<BGR<T>> for RGB<T>

fn from(other: BGR<T>) -> RGB<T>

Performs the conversion.

impl From<RGB<i16>> for RGB<f32>

fn from(other: RGB<i16>) -> RGB<f32>

Performs the conversion.

impl<T> From<RGB<T>> for RGBA<T, u8> where
    T: Copy, 

Assumes 255 is opaque

fn from(other: RGB<T>) -> RGBA<T, u8>

Performs the conversion.

impl From<RGB<u8>> for RGB<f32>

fn from(other: RGB<u8>) -> RGB<f32>

Performs the conversion.

impl From<RGB<u8>> for RGB<i16>

fn from(other: RGB<u8>) -> RGB<i16>

Performs the conversion.

impl From<RGB<i32>> for RGB<f64>

fn from(other: RGB<i32>) -> RGB<f64>

Performs the conversion.

impl<T> From<Gray<T>> for RGB<T> where
    T: Clone, 

fn from(other: Gray<T>) -> RGB<T>

Performs the conversion.

impl<T> From<RGB<T>> for RGBA<T, u16> where
    T: Copy, 

Assumes 65535 is opaque

fn from(other: RGB<T>) -> RGBA<T, u16>

Performs the conversion.

impl<T> From<(T, T, T)> for RGB<T>

fn from(other: (T, T, T)) -> RGB<T>

Performs the conversion.

impl<T> Add<RGB<T>> for RGB<T> where
    T: Add<T>, 

px + px

type Output = RGB<<T as Add<T>>::Output>

The resulting type after applying the + operator.

fn add(self, other: RGB<T>) -> <RGB<T> as Add<RGB<T>>>::Output

Performs the + operation.

impl<T> Add<T> for RGB<T> where
    T: Copy + Add<T, Output = T> + Clone + Add<T>, 

px + 1

type Output = RGB<T>

The resulting type after applying the + operator.

fn add(self, r: T) -> <RGB<T> as Add<T>>::Output

Performs the + operation.

impl<ComponentType> Clone for RGB<ComponentType> where
    ComponentType: Clone, 

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<ComponentType> PartialOrd<RGB<ComponentType>> for RGB<ComponentType> where
    ComponentType: PartialOrd<ComponentType>, 

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

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

fn lt(&self, other: &RGB<ComponentType>) -> bool

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

fn le(&self, other: &RGB<ComponentType>) -> bool

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

fn gt(&self, other: &RGB<ComponentType>) -> bool

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

fn ge(&self, other: &RGB<ComponentType>) -> bool

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

impl<ComponentType> Eq for RGB<ComponentType> where
    ComponentType: Eq, 

impl<T> Display for RGB<T> where
    T: Display, 

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

Formats the value using the given formatter.

impl<T> Into<(T, T, T)> for RGB<T>

fn into(self) -> (T, T, T)

Performs the conversion.

impl<T> Into<[T; 3]> for RGB<T>

fn into(self) -> [T; 3]

Performs the conversion.

impl<T> Sub<RGB<T>> for RGB<T> where
    T: Sub<T>, 

px - px

type Output = RGB<<T as Sub<T>>::Output>

The resulting type after applying the - operator.

fn sub(self, other: RGB<T>) -> <RGB<T> as Sub<RGB<T>>>::Output

Performs the - operation.

impl<T> AsRef<[T]> for RGB<T>

fn as_ref(&self) -> &[T]

Performs the conversion.

impl<ComponentType> Hash for RGB<ComponentType> where
    ComponentType: Hash, 

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

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<T> ComponentSlice<T> for RGB<T>

fn as_slice(&self) -> &[T]

The components interpreted as an array, e.g. one RGB expands to 3 elements.

fn as_mut_slice(&mut self) -> &mut [T]

impl<ComponentType> Ord for RGB<ComponentType> where
    ComponentType: Ord, 

fn cmp(&self, other: &RGB<ComponentType>) -> Ordering

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl<T> FromIterator<T> for RGB<T>

fn from_iter<I>(into_iter: I) -> RGB<T> where
    I: IntoIterator<Item = T>, 

Takes exactly 3 elements from the iterator and creates a new instance. Panics if there are fewer elements in the iterator.

impl<T> Mul<T> for RGB<T> where
    T: Copy + Mul<T, Output = T> + Clone + Mul<T>, 

px * 1

type Output = RGB<T>

The resulting type after applying the * operator.

fn mul(self, r: T) -> <RGB<T> as Mul<T>>::Output

Performs the * operation.

impl<ComponentType> Copy for RGB<ComponentType> where
    ComponentType: Copy, 

impl<ComponentType> Default for RGB<ComponentType> where
    ComponentType: Default, 

fn default() -> RGB<ComponentType>

Returns the "default value" for a type.