Struct rgb::RGB

[+] Show declaration

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

[−] Expand description

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

[−] Expand description

Red

g: ComponentType

[−] Expand description

Green

b: ComponentType

[−] Expand description

Blue

Implementations

impl<T> RGB<T>[−]

pub const fn new(r: T, g: T, b: T) -> Self[−]

Convenience function for creating a new pixel The order of arguments is R,G,B

impl<T: Clone> RGB<T>[−]

pub fn iter(&self) -> Cloned<Iter<'_, T>>[−]

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

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

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

Trait Implementations

impl<T: Add> Add<RGB<T>> for RGB<T>[+]

px + px

[+] Show hidden undocumented items

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

The resulting type after applying the + operator.

fn add(self, other: RGB<T>) -> Self::Output[−]

Performs the + operation.

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

px + 1

[+] Show hidden undocumented items

type Output = RGB<T>

The resulting type after applying the + operator.

fn add(self, r: T) -> Self::Output[−]

Performs the + operation.

impl<T> AddAssign<RGB<T>> for RGB<T> where
    T: Add<Output = T> + Copy, [+]

px + px

[+] Show hidden undocumented items

fn add_assign(&mut self, other: RGB<T>)[−]

Performs the += operation.

impl<T> AddAssign<T> for RGB<T> where
    T: Copy + Add<Output = T>, [+]

px + 1

[+] Show hidden undocumented items

fn add_assign(&mut self, r: T)[−]

Performs the += operation.

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

[+] Show hidden undocumented items

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

Performs the conversion.

impl<T> AsPixels<RGB<T>> for [T][+]

[+] Show hidden undocumented items

fn as_pixels(&self) -> &[RGB<T>][−]

Reinterpret the slice as a read-only/shared slice of pixels. Multiple consecutive elements in the slice are intepreted as a single pixel (depending on format, e.g. 3 for RGB, 4 for RGBA).

fn as_pixels_mut(&mut self) -> &mut [RGB<T>][−]

Reinterpret the slice as a mutable/exclusive slice of pixels. Multiple consecutive elements in the slice are intepreted as a single pixel (depending on format, e.g. 3 for RGB, 4 for RGBA).

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

[+] Show hidden undocumented items

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

Performs the conversion.

impl<ComponentType: Clone> Clone for RGB<ComponentType>[+]

[+] Show hidden undocumented items

fn clone(&self) -> RGB<ComponentType>[−]

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl<T: Copy, B> ComponentMap<RGB<B>, T, B> for RGB<T>[+]

[+] Show hidden undocumented items

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

[+] Show hidden undocumented items

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: Copy> Copy for RGB<ComponentType>

impl<ComponentType: Debug> Debug for RGB<ComponentType>[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl<ComponentType: Default> Default for RGB<ComponentType>[+]

[+] Show hidden undocumented items

fn default() -> RGB<ComponentType>[−]

Returns the “default value” for a type.

impl<T: Display> Display for RGB<T>[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

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

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

[+] Show hidden undocumented items

fn from(other: [T; 3]) -> Self[−]

Performs the conversion.

impl<T> From<(T, T, T)> for RGB<T>[+]

[+] Show hidden undocumented items

fn from(other: (T, T, T)) -> Self[−]

Performs the conversion.

impl<T> From<BGR<T>> for RGB<T>[+]

[+] Show hidden undocumented items

fn from(other: BGR<T>) -> Self[−]

Performs the conversion.

impl<T: Clone> From<Gray<T>> for RGB<T>[+]

[+] Show hidden undocumented items

fn from(other: Gray<T>) -> Self[−]

Performs the conversion.

impl<T> From<RGB<T>> for BGR<T>[+]

[+] Show hidden undocumented items

fn from(other: RGB<T>) -> Self[−]

Performs the conversion.

impl<T: Copy> From<RGB<T>> for RGBA<T, u8>[+]

Assumes 255 is opaque

[+] Show hidden undocumented items

fn from(other: RGB<T>) -> Self[−]

Performs the conversion.

impl<T: Copy> From<RGB<T>> for BGRA<T, u8>[+]

Assumes 255 is opaque

[+] Show hidden undocumented items

fn from(other: RGB<T>) -> Self[−]

Performs the conversion.

impl<T: Copy> From<RGB<T>> for RGBA<T, u16>[+]

Assumes 65535 is opaque

[+] Show hidden undocumented items

fn from(other: RGB<T>) -> Self[−]

Performs the conversion.

impl<T: Copy> From<RGB<T>> for BGRA<T, u16>[+]

Assumes 255 is opaque

[+] Show hidden undocumented items

fn from(other: RGB<T>) -> Self[−]

Performs the conversion.

impl From<RGB<f32>> for RGB<f64>[+]

[+] Show hidden undocumented items

fn from(other: RGB<f32>) -> Self[−]

Performs the conversion.

impl From<RGB<i16>> for RGB<f32>[+]

[+] Show hidden undocumented items

fn from(other: RGB<i16>) -> Self[−]

Performs the conversion.

impl From<RGB<i16>> for RGB<f64>[+]

[+] Show hidden undocumented items

fn from(other: RGB<i16>) -> Self[−]

Performs the conversion.

impl From<RGB<i32>> for RGB<f64>[+]

[+] Show hidden undocumented items

fn from(other: RGB<i32>) -> Self[−]

Performs the conversion.

impl From<RGB<u16>> for RGB<i32>[+]

[+] Show hidden undocumented items

fn from(other: RGB<u16>) -> Self[−]

Performs the conversion.

impl From<RGB<u16>> for RGB<f32>[+]

[+] Show hidden undocumented items

fn from(other: RGB<u16>) -> Self[−]

Performs the conversion.

impl From<RGB<u16>> for RGB<f64>[+]

[+] Show hidden undocumented items

fn from(other: RGB<u16>) -> Self[−]

Performs the conversion.

impl From<RGB<u8>> for RGB<i16>[+]

[+] Show hidden undocumented items

fn from(other: RGB<u8>) -> Self[−]

Performs the conversion.

impl From<RGB<u8>> for RGB<f32>[+]

[+] Show hidden undocumented items

fn from(other: RGB<u8>) -> Self[−]

Performs the conversion.

impl From<RGB<u8>> for RGB<f64>[+]

[+] Show hidden undocumented items

fn from(other: RGB<u8>) -> Self[−]

Performs the conversion.

impl<T> FromIterator<T> for RGB<T>[+]

fn from_iter<I: IntoIterator<Item = T>>(into_iter: I) -> Self[−]

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

impl<ComponentType: Hash> Hash for RGB<ComponentType>[+]

[+] Show hidden undocumented items

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

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

[+] Show hidden undocumented items

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

Performs the conversion.

impl<T> Into<(T, T, T)> for RGB<T>[+]

[+] Show hidden undocumented items

fn into(self) -> (T, T, T)[−]

Performs the conversion.

impl<T: LowerHex> LowerHex for RGB<T>[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

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

px * 1

[+] Show hidden undocumented items

type Output = RGB<T>

The resulting type after applying the * operator.

fn mul(self, r: T) -> Self::Output[−]

Performs the * operation.

impl<T> MulAssign<T> for RGB<T> where
    T: Copy + Mul<Output = T>, [+]

px * 1

[+] Show hidden undocumented items

fn mul_assign(&mut self, r: T)[−]

Performs the *= operation.

impl<ComponentType: Ord> Ord for RGB<ComponentType>[+]

[+] Show hidden undocumented items

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

This method returns an Ordering between self and other.

[+] Expand attributes

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

Compares and returns the maximum of two values.

[+] Expand attributes

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

Compares and returns the minimum of two values.

[+] Expand attributes

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

Restrict a value to a certain interval.

impl<ComponentType: PartialEq> PartialEq<RGB<ComponentType>> for RGB<ComponentType>[+]

[+] Show hidden undocumented items

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: PartialOrd> PartialOrd<RGB<ComponentType>> for RGB<ComponentType>[+]

[+] Show hidden undocumented items

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

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

[+] Expand attributes

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

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

[+] Expand attributes

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

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

[+] Expand attributes

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

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

[+] Expand attributes

#[must_use]pub 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<ComponentType> StructuralEq for RGB<ComponentType>

impl<ComponentType> StructuralPartialEq for RGB<ComponentType>

impl<T: Sub> Sub<RGB<T>> for RGB<T>[+]

px - px

[+] Show hidden undocumented items

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

The resulting type after applying the - operator.

fn sub(self, other: RGB<T>) -> Self::Output[−]

Performs the - operation.

impl<T> Sub<T> for RGB<T> where
    T: Copy + Sub<Output = T>, [+]

px - 1

[+] Show hidden undocumented items

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

The resulting type after applying the - operator.

fn sub(self, r: T) -> Self::Output[−]

Performs the - operation.

impl<T> SubAssign<RGB<T>> for RGB<T> where
    T: Sub<Output = T> + Copy, [+]

px - px

[+] Show hidden undocumented items

fn sub_assign(&mut self, other: RGB<T>)[−]

Performs the -= operation.

impl<T> SubAssign<T> for RGB<T> where
    T: Copy + Sub<Output = T>, [+]

px - 1

[+] Show hidden undocumented items

fn sub_assign(&mut self, r: T)[−]

Performs the -= operation.

impl<T: UpperHex> UpperHex for RGB<T>[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.