Struct Bgra

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

A Blue + Green + Red + Alpha pixel.

Examples

use rgb::Bgra;

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

Fields

b: T

Blue Component

g: T

Green Component

r: T

Red Component

a: A

Alpha Component

Implementations

impl<T> Bgra<T>

where T: Copy,

pub const fn new_bgra(blue: T, green: T, red: T, alpha: T) -> Bgra<T>

Creates a new Bgra pixel type from its components.

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

use rgb::Bgra;

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

impl<T> Bgra<T>

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

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

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

impl<T, A> Bgra<T, A>

let r = rgb::BGRA::<u8,u16>::zeroed();

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

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

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

impl<T, A> Bgra<T, A>

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

👎Deprecated: This function will change. Use bgr_mut()

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

pub fn bgr_mut(&mut self) -> &mut Bgr<T>

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

impl<T, A> Bgra<T, A>

where T: Clone,

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

👎Deprecated: This function will change. Use bgr()

Copy RGB components out of the RGBA struct

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

impl<T> Bgra<T>

where T: Clone,

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

Iterate over all components (length=4)

impl<T, A> Bgra<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> Bgra<T, A>

where T: Copy, A: Clone,

pub fn map_rgb<F, U, B>(&self, f: F) -> Bgra<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) -> Bgra<T, A>

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

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

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

Use ::bytemuck::cast_slice() instead.

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

Use ::bytemuck::cast_slice_mut() instead.

impl<T> AsRef<[T; 4]> for Bgra<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 Bgra<T, A>

where T: Clone, A: Clone,

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

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

where T: Copy, A: Copy,

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

where T: Copy,

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

where T: Default, A: Default,

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

Returns the “default value” for a type.

impl<T, A> Display for Bgra<T, A>

where T: Display, A: Display,

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

Formats the value using the given formatter.

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

where T: Copy,

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

Converts to this type from the input type.

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

where R: Into<S>,

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

Converts to this type from the input type.

impl<T> From<Abgr<T>> for Bgra<T>

where T: Clone,

fn from(other: Abgr<T>) -> Bgra<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<Bgr<T>> for Bgra<T, u16>

where T: Copy,

Assumes 65535 is opaque

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

Converts to this type from the input type.

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

where T: Copy,

Assumes 255 is opaque

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

Converts to this type from the input type.

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

where R: Into<S>,

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

Converts to this type from the input type.

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

fn from(value: Bgra<T>) -> [T; 4]

Converts to this type from the input type.

impl<T> From<Bgra<T>> for Abgr<T>

where T: Clone,

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

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<Bgra<T>> for Rgba<T>

where T: Clone,

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

Converts to this type from the input type.

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

where T: Copy,

Assumes 65535 is opaque

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

Converts to this type from the input type.

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

where T: Copy,

Assumes 255 is opaque

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

Converts to this type from the input type.

impl<T> From<Rgba<T>> for Bgra<T>

where T: Clone,

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

Converts to this type from the input type.

impl<T, A> Hash for Bgra<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, A> Ord for Bgra<T, A>

where T: Ord, A: Ord,

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

where T: PartialEq, A: PartialEq,

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

where T: PartialOrd, A: PartialOrd,

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

Calls zeroed.

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

where T: Copy, A: Copy,

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

where T: Eq, A: Eq,

impl<T, A> Pod for Bgra<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 Bgra<T, A>