Struct Grb

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

A Green + Red + Blue pixel.

Examples

use rgb::Grb;

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

Fields

g: T

Green Component

r: T

Red Component

b: T

Blue Component

Implementations

impl<T> Grb<T>

where T: Copy,

pub const fn new_grb(green: T, red: T, blue: T) -> Grb<T>

Creates a new Grb pixel type from its components.

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

use rgb::Grb;

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

impl<T> Grb<T>

where T: Clone,

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

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

Trait Implementations

impl<T> Add<T> for Grb<T>

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

px + 1

type Output = Grb<T>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<T> Add for Grb<T>

where T: Add,

px + px

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

The resulting type after applying the + operator.

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

Performs the + operation.

impl<T> AddAssign<T> for Grb<T>

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

px + 1

fn add_assign(&mut self, r: T)

Performs the += operation.

impl<T> AddAssign for Grb<T>

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

px + px

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

Performs the += operation.

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

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

Use ::bytemuck::cast_slice() instead.

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

Use ::bytemuck::cast_slice_mut() instead.

impl<T> Clone for Grb<T>

where T: Clone,

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T, B> ColorComponentMap<Grb<B>, T, B> for Grb<T>

where T: Copy,

fn map_colors<F>(&self, f: F) -> Grb<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, B> ComponentMap<Grb<B>, T, B> for Grb<T>

where T: Copy,

fn map<F>(&self, f: F) -> Grb<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 Grb<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 for Grb<T>

where T: Debug,

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

Formats the value using the given formatter.

impl<T> Default for Grb<T>

where T: Default,

fn default() -> Grb<T>

Returns the “default value” for a type.

impl<T> Div<T> for Grb<T>

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

px / 1

type Output = Grb<T>

The resulting type after applying the / operator.

fn div(self, r: T) -> <Grb<T> as Div<T>>::Output

Performs the / operation.

impl<T> DivAssign<T> for Grb<T>

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

px * 1

fn div_assign(&mut self, r: T)

Performs the /= operation.

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

where R: Into<S>,

fn from(value: (R, R, R)) -> Grb<S>

Converts to this type from the input type.

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

where R: Into<S>,

fn from(value: Grb<R>) -> (S, S, S)

Converts to this type from the input type.

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

where T: Clone,

fn from(other: Grb<T>) -> Rgb<T>

Converts to this type from the input type.

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

where T: Clone,

fn from(other: Rgb<T>) -> Grb<T>

Converts to this type from the input type.

impl<T> Hash for Grb<T>

where T: Hash,

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

where __H: Hasher,

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> Mul<T> for Grb<T>

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

px * 1

type Output = Grb<T>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<T> Mul for Grb<T>

where T: Mul,

px * px

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

The resulting type after applying the * operator.

fn mul(self, other: Grb<T>) -> <Grb<T> as Mul>::Output

Performs the * operation.

impl<T> MulAssign<T> for Grb<T>

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

px * 1

fn mul_assign(&mut self, r: T)

Performs the *= operation.

impl<T> MulAssign for Grb<T>

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

px * px

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

Performs the *= operation.

impl<T> Ord for Grb<T>

where T: Ord,

fn cmp(&self, other: &Grb<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 for Grb<T>

where T: PartialEq,

fn eq(&self, other: &Grb<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 for Grb<T>

where T: PartialOrd,

fn partial_cmp(&self, other: &Grb<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 Grb<T>

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

px - 1

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

The resulting type after applying the - operator.

fn sub(self, r: T) -> <Grb<T> as Sub<T>>::Output

Performs the - operation.

impl<T> Sub for Grb<T>

where T: Sub,

px - px

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

The resulting type after applying the - operator.

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

Performs the - operation.

impl<T> SubAssign<T> for Grb<T>

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

px - 1

fn sub_assign(&mut self, r: T)

Performs the -= operation.

impl<T> SubAssign for Grb<T>

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

px - px

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

Performs the -= operation.

impl<T> Sum for Grb<T>

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

fn sum<I>(iter: I) -> Grb<T>

where I: Iterator<Item = Grb<T>>,

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

impl<T> Copy for Grb<T>

where T: Copy,

impl<T> Eq for Grb<T>

where T: Eq,

impl<T> StructuralPartialEq for Grb<T>