Struct Rgb

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

A Red + Green + Blue pixel.

Examples

use rgb::Rgb;

let pixel: Rgb<u8> = Rgb { r: 0, g: 0, b: 0 };

Fields

r: T

Red Component

g: T

Green Component

b: T

Blue Component

Implementations

impl<T: Copy> Rgb<T>

pub const fn new(red: T, green: T, blue: T) -> Self

Creates a new Rgb pixel type from its components.

Alternatively, you can use struct literal syntax to create the new pixel type:

use rgb::Rgb;

let pixel = Rgb {r : red, g : green, b : blue};

impl<T: Clone> Rgb<T>

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

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

impl<T: Clone> Rgb<T>

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

Convenience function for converting to RGBA

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

👎Deprecated: use .with_alpha(a) instead

Convenience function for converting to RGBA with alpha channel of a different type than type of the pixels

Trait Implementations

impl<T> Add<T> for Rgb<T>

where T: Copy + Add<Output = T>,

px + 1

type Output = Rgb<T>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<T: Add> Add for Rgb<T>

px + px

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> AddAssign<T> for Rgb<T>

where T: Copy + Add<Output = T>,

px + 1

fn add_assign(&mut self, r: T)

Performs the += operation.

impl<T> AddAssign for Rgb<T>

where T: Add<Output = T> + Copy,

px + px

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

Performs the += operation.

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

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

Converts this type into a mutable reference of the (usually inferred) input type.

impl<T> AsPixels<Rgb<T>> for [T]

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

Use ::bytemuck::cast_slice() instead.

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

Use ::bytemuck::cast_slice_mut() instead.

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

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

Converts this type into a shared reference of the (usually inferred) input type.

impl<T: Clone> Clone for Rgb<T>

fn clone(&self) -> Rgb<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Copy, B> ColorComponentMap<Rgb<B>, T, B> for Rgb<T>

fn map_colors<F>(&self, f: F) -> RGB<B>

where F: FnMut(T) -> B,

Convenience function for applying the same formula to every rgb/gray component, but skipping the alpha component.

fn map_c<Callback>(&self, f: Callback) -> DestPixel

where Callback: FnMut(SrcComponent) -> DestComponent,

👎Deprecated: renamed to map_colors

Alias of map_colors

impl<T: Copy, B> ComponentMap<Rgb<B>, T, B> for Rgb<T>

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>

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]

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

impl<T: Debug> Debug for Rgb<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for Rgb<T>

fn default() -> Rgb<T>

Returns the “default value” for a type.

impl<T: Display> Display for Rgb<T>

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

Formats the value using the given formatter.

impl<T> Div<T> for Rgb<T>

where T: Copy + Div<Output = T>,

px / 1

type Output = Rgb<T>

The resulting type after applying the / operator.

fn div(self, r: T) -> Self::Output

Performs the / operation.

impl<T> DivAssign<T> for Rgb<T>

where T: Copy + Div<Output = T>,

px * 1

fn div_assign(&mut self, r: T)

Performs the /= operation.

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

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

Converts to this type from the input type.

impl<R, S> From<(R, R, R)> for Rgb<S>

where R: Into<S>,

fn from(value: (R, R, R)) -> Self

Converts to this type from the input type.

impl<T> From<Bgr<T>> for Rgb<T>

where T: Clone,

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

Converts to this type from the input type.

impl<T: Clone> From<Gray_v08<T>> for Rgb<T>

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

Converts to this type from the input type.

impl<T> From<Grb<T>> for Rgb<T>

where T: Clone,

fn from(other: GRB<T>) -> Self

Converts to this type from the input type.

impl<R, S> From<Rgb<R>> for (S, S, S)

where R: Into<S>,

fn from(value: Rgb<R>) -> Self

Converts to this type from the input type.

impl<T> From<Rgb<T>> for [T; 3]

fn from(value: RGB<T>) -> Self

Converts to this type from the input type.

impl<T: Copy> From<Rgb<T>> for Abgr<T, u16>

Assumes 65535 is opaque

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

Converts to this type from the input type.

impl<T: Copy> From<Rgb<T>> for Abgr<T, u8>

Assumes 255 is opaque

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

Converts to this type from the input type.

impl<T: Copy> From<Rgb<T>> for Argb<T, u16>

Assumes 65535 is opaque

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

Converts to this type from the input type.

impl<T: Copy> From<Rgb<T>> for Argb<T, u8>

Assumes 255 is opaque

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

Converts to this type from the input type.

impl<T> From<Rgb<T>> for Bgr<T>

where T: Clone,

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

Converts to this type from the input type.

impl<T: Copy> From<Rgb<T>> for Bgra<T, u16>

Assumes 65535 is opaque

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

Converts to this type from the input type.

impl<T: Copy> From<Rgb<T>> for Bgra<T, u8>

Assumes 255 is opaque

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

Converts to this type from the input type.

impl<T> From<Rgb<T>> for Grb<T>

where T: Clone,

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

Converts to this type from the input type.

impl<T: Copy> From<Rgb<T>> for Rgba<T, u16>

Assumes 65535 is opaque

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

Converts to this type from the input type.

impl<T: Copy> From<Rgb<T>> for Rgba<T, u8>

Assumes 255 is opaque

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

Converts to this type from the input type.

impl From<Rgb<f32>> for Rgb<f64>

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

Converts to this type from the input type.

impl From<Rgb<i16>> for Rgb<f32>

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

Converts to this type from the input type.

impl From<Rgb<i16>> for Rgb<f64>

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

Converts to this type from the input type.

impl From<Rgb<i32>> for Rgb<f64>

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

Converts to this type from the input type.

impl From<Rgb<u16>> for Rgb<f32>

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

Converts to this type from the input type.

impl From<Rgb<u16>> for Rgb<f64>

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

Converts to this type from the input type.

impl From<Rgb<u16>> for Rgb<i32>

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

Converts to this type from the input type.

impl From<Rgb<u16>> for Rgb<u32>

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

Converts to this type from the input type.

impl From<Rgb<u16>> for Rgb<u64>

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

Converts to this type from the input type.

impl From<Rgb<u8>> for Rgb<f32>

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

Converts to this type from the input type.

impl From<Rgb<u8>> for Rgb<f64>

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

Converts to this type from the input type.

impl From<Rgb<u8>> for Rgb<i16>

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

Converts to this type from the input type.

impl From<Rgb<u8>> for Rgb<i32>

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

Converts to this type from the input type.

impl From<Rgb<u8>> for Rgb<u16>

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

Converts to this type from the input type.

impl From<Rgb<u8>> for Rgb<u32>

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

Converts to this type from the input type.

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<T: Hash> Hash for Rgb<T>

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: LowerHex> LowerHex for Rgb<T>

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

type Output = Rgb<T>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<T: Mul> Mul for Rgb<T>

px * px

type Output = Rgb<<T as Mul>::Output>

The resulting type after applying the * operator.

fn mul(self, other: RGB<T>) -> Self::Output

Performs the * operation.

impl<T> MulAssign<T> for Rgb<T>

where T: Copy + Mul<Output = T>,

px * 1

fn mul_assign(&mut self, r: T)

Performs the *= operation.

impl<T> MulAssign for Rgb<T>

where T: Mul<Output = T> + Copy,

px * px

fn mul_assign(&mut self, other: RGB<T>)

Performs the *= operation.

impl<T: Ord> Ord for Rgb<T>

fn cmp(&self, other: &Rgb<T>) -> Ordering

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl<T: PartialEq> PartialEq for Rgb<T>

fn eq(&self, other: &Rgb<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<T: PartialOrd> PartialOrd for Rgb<T>

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl<T> Sub<T> for Rgb<T>

where T: Copy + Sub<Output = T>,

px - 1

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: Sub> Sub for Rgb<T>

px - px

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> SubAssign<T> for Rgb<T>

where T: Copy + Sub<Output = T>,

px - 1

fn sub_assign(&mut self, r: T)

Performs the -= operation.

impl<T> SubAssign for Rgb<T>

where T: Sub<Output = T> + Copy,

px - px

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

Performs the -= operation.

impl<T> Sum for Rgb<T>

where T: Default + Add<Output = T>,

fn sum<I: Iterator<Item = Self>>(iter: I) -> Self

Takes an iterator and generates Self from the elements by “summing up” the items.

impl<T: UpperHex> UpperHex for Rgb<T>

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

Formats the value using the given formatter.

impl<T> Zeroable for Rgb<T>

where T: Zeroable,

fn zeroed() -> Self

Calls zeroed.

impl<T: Copy> Copy for Rgb<T>

impl<T: Eq> Eq for Rgb<T>

impl<T> Pod for Rgb<T>

where T: Pod,

impl<T> StructuralPartialEq for Rgb<T>