Struct rgb::RGBA

#[repr(C)]
pub struct RGBA<ComponentType, AlphaComponentType = ComponentType> {
    pub r: ComponentType,
    pub g: ComponentType,
    pub b: ComponentType,
    pub a: AlphaComponentType,
}

The RGBA pixel

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

You can specify a different type for alpha, but it's only for special cases (e.g. if you use a newtype like RGBA<LinearLight<u16>, u16>).

Fields

r: ComponentType

Red

g: ComponentType

Green

b: ComponentType

Blue

a: AlphaComponentType

Alpha

Methods

impl<T> RGBA<T>

pub const fn new(r: T, g: T, b: T, a: T) -> Self

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

impl<T, A> RGBA<T, A>

pub const fn new_alpha(r: T, g: T, b: T, a: A) -> Self

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

impl<T: Clone> RGBA<T>

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

Iterate over all components (length=4)

impl<T: Clone, A> RGBA<T, A>

pub fn rgb(&self) -> RGB<T>

Copy RGB components out of the RGBA struct

Note: you can use .into() to convert between other types

impl<T, A> RGBA<T, A>

pub fn rgb_mut(&mut self) -> &mut RGB<T>

Provide a mutable view of only RGB components (leaving out alpha). Useful to change color without changing opacity.

impl<T: Copy, A: Clone> RGBA<T, A>

pub fn map_rgb<F, U, B>(&self, f: F) -> RGBA<U, B> where
    F: FnMut(T) -> U,
    U: Clone,
    B: From<A> + Clone, 

Create new RGBA with the same alpha value, but different RGB values

pub fn alpha(&self, a: A) -> Self

Create a new RGBA with the new alpha value, but same RGB values

pub fn map_alpha<F, B>(&self, f: F) -> RGBA<T, B> where
    F: FnOnce(A) -> B, 

Create a new RGBA with a new alpha value created by the callback. Allows changing of the type used for the alpha channel.

Trait Implementations

impl<T> AsPixels<RGBA<T, T>> for [T]

fn as_pixels(&self) -> &[RGBA<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 [RGBA<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> ComponentSlice<T> for RGBA<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<T: Copy, B> ComponentMap<RGBA<B, B>, T, B> for RGBA<T>

fn map<F>(&self, f: F) -> RGBA<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, AlphaComponentType: PartialEq> PartialEq<RGBA<ComponentType, AlphaComponentType>> for RGBA<ComponentType, AlphaComponentType>

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

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

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

This method tests for !=.

impl<ComponentType: Eq, AlphaComponentType: Eq> Eq for RGBA<ComponentType, AlphaComponentType>

impl<ComponentType: Ord, AlphaComponentType: Ord> Ord for RGBA<ComponentType, AlphaComponentType>

fn cmp(&self, other: &RGBA<ComponentType, AlphaComponentType>) -> 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<ComponentType: PartialOrd, AlphaComponentType: PartialOrd> PartialOrd<RGBA<ComponentType, AlphaComponentType>> for RGBA<ComponentType, AlphaComponentType>

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

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

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

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

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

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

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

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

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

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

impl<ComponentType: Hash, AlphaComponentType: Hash> Hash for RGBA<ComponentType, AlphaComponentType>

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

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: Display, A: Display> Display for RGBA<T, A>

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

Formats the value using the given formatter.

impl<ComponentType: Debug, AlphaComponentType: Debug> Debug for RGBA<ComponentType, AlphaComponentType>

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

Formats the value using the given formatter.

impl<T: Add, A: Add> Add<RGBA<T, A>> for RGBA<T, A>

px + px

type Output = RGBA<<T as Add>::Output, <A as Add>::Output>

The resulting type after applying the + operator.

fn add(self, other: RGBA<T, A>) -> Self::Output

Performs the + operation.

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

px + 1

type Output = RGBA<T>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<T: Sub, A: Sub> Sub<RGBA<T, A>> for RGBA<T, A>

px - px

type Output = RGBA<<T as Sub>::Output, <A as Sub>::Output>

The resulting type after applying the - operator.

fn sub(self, other: RGBA<T, A>) -> Self::Output

Performs the - operation.

impl<T> Sub<T> for RGBA<T> where
    T: Copy + Sub, 

px - 1 Works only if alpha channel has same depth as RGB channels

type Output = RGBA<<T as Sub>::Output, <T as Sub>::Output>

The resulting type after applying the - operator.

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

Performs the - operation.

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

px * 1

type Output = RGBA<T>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<T, A> AddAssign<RGBA<T, A>> for RGBA<T, A> where
    T: Copy + Add<Output = T>,
    A: Copy + Add<Output = A>, 

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

Performs the += operation.

impl<T> AddAssign<T> for RGBA<T> where
    T: Copy + Add<Output = T>, 

px + 1

fn add_assign(&mut self, r: T)

Performs the += operation.

impl<T, A> SubAssign<RGBA<T, A>> for RGBA<T, A> where
    T: Copy + Sub<Output = T>,
    A: Copy + Sub<Output = A>, 

px - px

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

Performs the -= operation.

impl<T> SubAssign<T> for RGBA<T> where
    T: Copy + Sub<Output = T>, 

px - 1 Works only if alpha channel has same depth as RGB channels

fn sub_assign(&mut self, r: T)

Performs the -= operation.

impl<T> MulAssign<T> for RGBA<T> where
    T: Copy + Mul<Output = T>, 

px * 1

fn mul_assign(&mut self, r: T)

Performs the *= operation.

impl<ComponentType: Copy, AlphaComponentType: Copy> Copy for RGBA<ComponentType, AlphaComponentType>

impl<T> FromIterator<T> for RGBA<T>

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

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

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

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

Performs the conversion.

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

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

Performs the conversion.

impl<T> Into<[T; 4]> for RGBA<T>

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

Performs the conversion.

impl<T, A> Into<(T, T, T, A)> for RGBA<T, A>

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

Performs the conversion.

impl<T: Copy> From<[T; 4]> for RGBA<T>

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

Performs the conversion.

impl<T, A> From<(T, T, T, A)> for RGBA<T, A>

fn from(other: (T, T, T, A)) -> Self

Performs the conversion.

impl From<RGBA<u16, u16>> for RGBA<i32>

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

Performs the conversion.

impl From<RGBA<u8, u8>> for RGBA<f32>

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

Performs the conversion.

impl From<RGBA<u8, u8>> for RGBA<f64>

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

Performs the conversion.

impl From<RGBA<u16, u16>> for RGBA<f32>

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

Performs the conversion.

impl From<RGBA<u16, u16>> for RGBA<f64>

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

Performs the conversion.

impl From<RGBA<i16, i16>> for RGBA<f32>

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

Performs the conversion.

impl From<RGBA<i16, i16>> for RGBA<f64>

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

Performs the conversion.

impl From<RGBA<i32, i32>> for RGBA<f64>

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

Performs the conversion.

impl From<RGBA<f32, f32>> for RGBA<f64>

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

Performs the conversion.

impl<T: Clone, A> From<GrayAlpha<T, A>> for RGBA<T, A>

fn from(other: GrayAlpha<T, A>) -> Self

Performs the conversion.

impl<T> From<RGBA<T, T>> for BGRA<T>

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

Performs the conversion.

impl<T> From<BGRA<T, T>> for RGBA<T>

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

Performs the conversion.

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

Assumes 255 is opaque

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

Performs the conversion.

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

Assumes 65535 is opaque

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

Performs the conversion.

impl<T: Copy> From<BGR<T>> for RGBA<T, u8>

Assumes 255 is opaque

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

Performs the conversion.

impl<T: Copy> From<BGR<T>> for RGBA<T, u16>

Assumes 255 is opaque

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

Performs the conversion.

impl<ComponentType: Clone, AlphaComponentType: Clone> Clone for RGBA<ComponentType, AlphaComponentType>

fn clone(&self) -> RGBA<ComponentType, AlphaComponentType>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<ComponentType: Default, AlphaComponentType: Default> Default for RGBA<ComponentType, AlphaComponentType>

fn default() -> RGBA<ComponentType, AlphaComponentType>

Returns the "default value" for a type.