Struct Bgr

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

A Blue + Green + Red pixel.

Examples

use rgb::Bgr;

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

Fields

b: T

Blue Component

g: T

Green Component

r: T

Red Component

Implementations

impl<T: Copy> Bgr<T>

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

Creates a new Bgr pixel type from its components.

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

use rgb::Bgr;

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

impl<T> Bgr<T>

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

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

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

impl<T: Clone> Bgr<T>

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

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

impl<T: Clone> Bgr<T>

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

Convenience function for converting to RGBA

pub fn new_alpha<A>(&self, a: A) -> BGRA<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> AsPixels<Bgr<T>> for [T]

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

Use [::bytemuck::cast_slice()] instead.

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

Use [::bytemuck::cast_slice_mut()] instead.

impl<T: Clone> Clone for Bgr<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

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

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

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

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

Formats the value using the given formatter.

impl<T: Default> Default for Bgr<T>

fn default() -> Bgr<T>

Returns the “default value” for a type.

impl<T: Display> Display for Bgr<T>

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

Formats the value using the given formatter.

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

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

Converts to this type from the input type.

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

where R: Into<S>,

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

Converts to this type from the input type.

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

where R: Into<S>,

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

Assumes 65535 is opaque

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

Converts to this type from the input type.

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

Assumes 255 is opaque

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

Converts to this type from the input type.

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

Assumes 65535 is opaque

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

Converts to this type from the input type.

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

Assumes 255 is opaque

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

Converts to this type from the input type.

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

Assumes 65535 is opaque

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

Converts to this type from the input type.

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

Assumes 255 is opaque

fn from(other: BGR<T>) -> 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: Copy> From<Bgr<T>> for Rgba<T, u16>

Assumes 65535 is opaque

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

Converts to this type from the input type.

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

Assumes 255 is opaque

fn from(other: BGR<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: Hash> Hash for Bgr<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 Bgr<T>

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

Formats the value using the given formatter.

impl<T: Ord> Ord for Bgr<T>

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

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

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

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

Formats the value using the given formatter.

impl<T: Copy> Copy for Bgr<T>

impl<T: Eq> Eq for Bgr<T>

impl<T> StructuralPartialEq for Bgr<T>