Struct Argb

#[repr(C)]
pub struct Argb<T, A = T> {
    pub a: A,
    pub r: T,
    pub g: T,
    pub b: T,
}

An Alpha + Red + Green + Blue pixel.

Examples

use rgb::Argb;

let pixel: Argb<u8> = Argb { a: 255, r: 0, g: 0, b: 0 };

Fields

a: A

Alpha Component

r: T

Red Component

g: T

Green Component

b: T

Blue Component

Implementations

impl<T> Argb<T>

where T: Copy,

pub const fn new_argb(alpha: T, red: T, green: T, blue: T) -> Argb<T>

Creates a new Argb pixel type from its components.

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

use rgb::Argb;

let pixel = Argb {a : alpha, r : red, g : green, b : blue};

impl<T> Argb<T>

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

👎Deprecated: This function has a misleading order of arguments. Use ARGB{} literal instead

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

impl<T, A> Argb<T, A>

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

👎Deprecated: This function has a misleading order of arguments. Use ARGB{} literal instead

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

impl<T, A> Argb<T, A>

where T: Clone,

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

Copy RGB components out of the ARGB struct

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

impl<T> Argb<T>

where T: Clone,

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

Iterate over all components (length=4)

impl<T, A> Argb<T, A>

where T: Clone,

pub fn bgr(&self) -> Bgr<T>

Copy RGB components out of the RGBA struct

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

impl<T, A> Argb<T, A>

where T: Copy, A: Clone,

pub fn map_rgb<F, U, B>(&self, f: F) -> Argb<U, B>

where F: FnMut(T) -> U, U: Clone, B: From<A> + Clone,

👎Deprecated: Renamed to map_colors()

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

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

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

pub fn map_alpha<F, B>(&self, f: F) -> Argb<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> Add<T> for Argb<T>

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

px + 1

type Output = Argb<T>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<T, A> Add for Argb<T, A>

where T: Add, A: Add,

px + px

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

The resulting type after applying the + operator.

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

Performs the + operation.

impl<T> AddAssign<T> for Argb<T>

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

px + 1

fn add_assign(&mut self, r: T)

Performs the += operation.

impl<T, A> AddAssign for Argb<T, A>

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

px + px

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

Performs the += operation.

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

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

Use ::bytemuck::cast_slice() instead.

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

Use ::bytemuck::cast_slice_mut() instead.

impl<T> AsRef<[T; 4]> for Argb<T>

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

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

impl<T, A> Clone for Argb<T, A>

where T: Clone, A: Clone,

fn clone(&self) -> Argb<T, A>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T, A, B> ColorComponentMap<Argb<B, A>, T, B> for Argb<T, A>

where T: Copy, A: Copy,

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

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<Argb<B>, T, B> for Argb<T>

where T: Copy,

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

where T: Debug, A: Debug,

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

Formats the value using the given formatter.

impl<T, A> Default for Argb<T, A>

where T: Default, A: Default,

fn default() -> Argb<T, A>

Returns the “default value” for a type.

impl<T> Div<T> for Argb<T>

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

px / 1

type Output = Argb<T>

The resulting type after applying the / operator.

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

Performs the / operation.

impl<T> DivAssign<T> for Argb<T>

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

px * 1

fn div_assign(&mut self, r: T)

Performs the /= operation.

impl<T> From<[T; 4]> for Argb<T>

where T: Copy,

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

Converts to this type from the input type.

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

where R: Into<S>,

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

Converts to this type from the input type.

impl<T> From<Abgr<T>> for Argb<T>

where T: Clone,

fn from(other: Abgr<T>) -> Argb<T>

Converts to this type from the input type.

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

where R: Into<S>,

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

Converts to this type from the input type.

impl<T> From<Argb<T>> for Abgr<T>

where T: Clone,

fn from(other: Argb<T>) -> Abgr<T>

Converts to this type from the input type.

impl<T> From<Argb<T>> for Bgra<T>

where T: Clone,

fn from(other: Argb<T>) -> Bgra<T>

Converts to this type from the input type.

impl<T> From<Argb<T>> for Rgba<T>

where T: Clone,

fn from(other: Argb<T>) -> Rgba<T>

Converts to this type from the input type.

impl<T> From<Bgr<T>> for Argb<T, u16>

where T: Copy,

Assumes 65535 is opaque

fn from(other: Bgr<T>) -> Argb<T, u16>

Converts to this type from the input type.

impl<T> From<Bgr<T>> for Argb<T, u8>

where T: Copy,

Assumes 255 is opaque

fn from(other: Bgr<T>) -> Argb<T, u8>

Converts to this type from the input type.

impl<T> From<Bgra<T>> for Argb<T>

where T: Clone,

fn from(other: Bgra<T>) -> Argb<T>

Converts to this type from the input type.

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

where T: Copy,

Assumes 65535 is opaque

fn from(other: Rgb<T>) -> Argb<T, u16>

Converts to this type from the input type.

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

where T: Copy,

Assumes 255 is opaque

fn from(other: Rgb<T>) -> Argb<T, u8>

Converts to this type from the input type.

impl<T> From<Rgba<T>> for Argb<T>

where T: Clone,

fn from(other: Rgba<T>) -> Argb<T>

Converts to this type from the input type.

impl<T, A> Hash for Argb<T, A>

where T: Hash, A: 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> Into<[T; 4]> for Argb<T>

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

Converts this type into the (usually inferred) input type.

impl<T> Mul<T> for Argb<T>

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

px * 1

type Output = Argb<T>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<T> MulAssign<T> for Argb<T>

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

px * 1

fn mul_assign(&mut self, r: T)

Performs the *= operation.

impl<T, A> Ord for Argb<T, A>

where T: Ord, A: Ord,

fn cmp(&self, other: &Argb<T, A>) -> 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, A> PartialEq for Argb<T, A>

where T: PartialEq, A: PartialEq,

fn eq(&self, other: &Argb<T, A>) -> 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, A> PartialOrd for Argb<T, A>

where T: PartialOrd, A: PartialOrd,

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

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

px - 1

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

The resulting type after applying the - operator.

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

Performs the - operation.

impl<T, A> Sub for Argb<T, A>

where T: Sub, A: Sub,

px - px

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

The resulting type after applying the - operator.

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

Performs the - operation.

impl<T> SubAssign<T> for Argb<T>

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

px - 1

fn sub_assign(&mut self, r: T)

Performs the -= operation.

impl<T, A> SubAssign for Argb<T, A>

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

px - px

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

Performs the -= operation.

impl<T, A> Sum for Argb<T, A>

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

fn sum<I>(iter: I) -> Argb<T, A>

where I: Iterator<Item = Argb<T, A>>,

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

impl<T, A> Zeroable for Argb<T, A>

where T: Zeroable, A: Zeroable,

This is unsound. You can disable as-bytes feature, enable bytemuck, and use bytemuck::cast_slice() instead.

fn zeroed() -> Argb<T, A>

Calls zeroed.

impl<T, A> Copy for Argb<T, A>

where T: Copy, A: Copy,

impl<T, A> Eq for Argb<T, A>

where T: Eq, A: Eq,

impl<T, A> Pod for Argb<T, A>

where T: Pod, A: Pod,

This is unsound. You can disable as-bytes feature, enable bytemuck, and use bytemuck::cast_slice() instead.

impl<T, A> StructuralPartialEq for Argb<T, A>