Struct batbox_color::Rgba

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

RGBA Color

Fields

r: T

Red component

g: T

Green component

b: T

Blue component

a: T

Alpha (opacity) component

Implementations

impl<T: ColorComponent> Rgba<T>

pub const WHITE: Self = _

#FFF

pub const BLACK: Self = _

#000

pub const GRAY: Self = _

#7F7F7F

pub const TRANSPARENT_WHITE: Self = _

rgba(255, 255, 255, 0)

pub const TRANSPARENT_BLACK: Self = _

rgba(0, 0, 0, 0)

pub const RED: Self = _

#F00

pub const GREEN: Self = _

#0F0

pub const BLUE: Self = _

#00F

pub const CYAN: Self = _

#0FF

pub const MAGENTA: Self = _

#F0F

pub const YELLOW: Self = _

#FF0

impl<T: ColorComponent> Rgba<T>

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

Construct Rgba from red, green, and blue components, fully opaque (max alpha).

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

Construct Rgba from red, green, blue, and alpha components.

pub fn to_vec4(self) -> vec4<T>

Convert color into vec4(r, g, b, a)

pub fn from_vec4(vec4: vec4<T>) -> Self

Convert vec4(r, g, b, a) into color

pub fn map_rgb<F: Fn(T) -> U, U: ColorComponent>(self, f: F) -> Rgba<U>

Convert Rgba<T> to Rgba<U> by applying a function to every color component excluding alpha. The resulting alpha is calculated by applying ColorComponent::convert() method.

Examples

let initial = Rgba::new(0.7, 0.4, 1.0, 1.0);
let f = |component: f32| component / 2.0;
assert_eq!(initial.map_rgb(f), Rgba::new(0.35, 0.2, 0.5, 1.0));

pub fn map<F: Fn(T) -> U, U: ColorComponent>(self, f: F) -> Rgba<U>

Convert Rgba<T> to Rgba<U> by applying a function to every color component.

Examples

let initial = Rgba::new(0.7, 0.4, 1.0, 1.0);
let f = |component: f32| component / 2.0;
assert_eq!(initial.map(f), Rgba::new(0.35, 0.2, 0.5, 0.5));

pub fn zip_map<F: Fn(T, U) -> V, U: ColorComponent, V: ColorComponent>( self, other: Rgba<U>, f: F ) -> Rgba<V>

Applies a function to every component of two colors and produces a new color.

Examples

let a = Rgba::new(0.2, 0.1, 0.3, 0.6);
let b = Rgba::new(0.5, 0.3, 0.2, 0.2);
let f = |a: f32, b: f32| a + b;
assert_eq!(a.zip_map(b, f), Rgba::new(0.7, 0.4, 0.5, 0.8));

pub fn convert<U: ColorComponent>(self) -> Rgba<U>

Convert Rgba<T> to Rgba<U> by applying ColorComponent::convert() method.

Examples

assert_eq!(Rgba::opaque(0, 255, 0).convert(), Rgba::opaque(0.0, 1.0, 0.0));

pub fn lerp(start: Self, end: Self, t: f32) -> Self

Linearly interpolate between start and end values.

Examples

let start = Rgba::opaque(0.0, 0.0, 0.0);
let end = Rgba::opaque(1.0, 1.0, 1.0);
let interpolated = Rgba::lerp(start, end, 0.3);
assert!(interpolated.r - 0.3 < 1e-5);
assert!(interpolated.g - 0.3 < 1e-5);
assert!(interpolated.b - 0.3 < 1e-5);
assert_eq!(interpolated.a, 1.0);

Methods from Deref<Target = [T; 4]>

pub fn as_ascii(&self) -> Option<&[AsciiChar; N]>

🔬This is a nightly-only experimental API. (ascii_char)

Converts this array of bytes into a array of ASCII characters, or returns None if any of the characters is non-ASCII.

Examples

#![feature(ascii_char)]
#![feature(const_option)]

const HEX_DIGITS: [std::ascii::Char; 16] =
    *b"0123456789abcdef".as_ascii().unwrap();

assert_eq!(HEX_DIGITS[1].as_str(), "1");
assert_eq!(HEX_DIGITS[10].as_str(), "a");

pub unsafe fn as_ascii_unchecked(&self) -> &[AsciiChar; N]

🔬This is a nightly-only experimental API. (ascii_char)

Converts this array of bytes into a array of ASCII characters, without checking whether they’re valid.

Safety

Every byte in the array must be in 0..=127, or else this is UB.

pub fn as_slice(&self) -> &[T]

Returns a slice containing the entire array. Equivalent to &s[..].

pub fn as_mut_slice(&mut self) -> &mut [T]

Returns a mutable slice containing the entire array. Equivalent to &mut s[..].

pub fn each_ref(&self) -> [&T; N]

🔬This is a nightly-only experimental API. (array_methods)

Borrows each element and returns an array of references with the same size as self.

Example

#![feature(array_methods)]

let floats = [3.1, 2.7, -1.0];
let float_refs: [&f64; 3] = floats.each_ref();
assert_eq!(float_refs, [&3.1, &2.7, &-1.0]);

This method is particularly useful if combined with other methods, like map. This way, you can avoid moving the original array if its elements are not Copy.

#![feature(array_methods)]

let strings = ["Ferris".to_string(), "♥".to_string(), "Rust".to_string()];
let is_ascii = strings.each_ref().map(|s| s.is_ascii());
assert_eq!(is_ascii, [true, false, true]);

// We can still access the original array: it has not been moved.
assert_eq!(strings.len(), 3);

pub fn each_mut(&mut self) -> [&mut T; N]

🔬This is a nightly-only experimental API. (array_methods)

Borrows each element mutably and returns an array of mutable references with the same size as self.

Example

#![feature(array_methods)]

let mut floats = [3.1, 2.7, -1.0];
let float_refs: [&mut f64; 3] = floats.each_mut();
*float_refs[0] = 0.0;
assert_eq!(float_refs, [&mut 0.0, &mut 2.7, &mut -1.0]);
assert_eq!(floats, [0.0, 2.7, -1.0]);

pub fn split_array_ref<const M: usize>(&self) -> (&[T; M], &[T])

🔬This is a nightly-only experimental API. (split_array)

Divides one array reference into two at an index.

The first will contain all indices from [0, M) (excluding the index M itself) and the second will contain all indices from [M, N) (excluding the index N itself).

Panics

Panics if M > N.

Examples

#![feature(split_array)]

let v = [1, 2, 3, 4, 5, 6];

{
   let (left, right) = v.split_array_ref::<0>();
   assert_eq!(left, &[]);
   assert_eq!(right, &[1, 2, 3, 4, 5, 6]);
}

{
    let (left, right) = v.split_array_ref::<2>();
    assert_eq!(left, &[1, 2]);
    assert_eq!(right, &[3, 4, 5, 6]);
}

{
    let (left, right) = v.split_array_ref::<6>();
    assert_eq!(left, &[1, 2, 3, 4, 5, 6]);
    assert_eq!(right, &[]);
}

pub fn split_array_mut<const M: usize>(&mut self) -> (&mut [T; M], &mut [T])

🔬This is a nightly-only experimental API. (split_array)

Divides one mutable array reference into two at an index.

The first will contain all indices from [0, M) (excluding the index M itself) and the second will contain all indices from [M, N) (excluding the index N itself).

Panics

Panics if M > N.

Examples

#![feature(split_array)]

let mut v = [1, 0, 3, 0, 5, 6];
let (left, right) = v.split_array_mut::<2>();
assert_eq!(left, &mut [1, 0][..]);
assert_eq!(right, &mut [3, 0, 5, 6]);
left[1] = 2;
right[1] = 4;
assert_eq!(v, [1, 2, 3, 4, 5, 6]);

pub fn rsplit_array_ref<const M: usize>(&self) -> (&[T], &[T; M])

🔬This is a nightly-only experimental API. (split_array)

Divides one array reference into two at an index from the end.

The first will contain all indices from [0, N - M) (excluding the index N - M itself) and the second will contain all indices from [N - M, N) (excluding the index N itself).

Panics

Panics if M > N.

Examples

#![feature(split_array)]

let v = [1, 2, 3, 4, 5, 6];

{
   let (left, right) = v.rsplit_array_ref::<0>();
   assert_eq!(left, &[1, 2, 3, 4, 5, 6]);
   assert_eq!(right, &[]);
}

{
    let (left, right) = v.rsplit_array_ref::<2>();
    assert_eq!(left, &[1, 2, 3, 4]);
    assert_eq!(right, &[5, 6]);
}

{
    let (left, right) = v.rsplit_array_ref::<6>();
    assert_eq!(left, &[]);
    assert_eq!(right, &[1, 2, 3, 4, 5, 6]);
}

pub fn rsplit_array_mut<const M: usize>(&mut self) -> (&mut [T], &mut [T; M])

🔬This is a nightly-only experimental API. (split_array)

Divides one mutable array reference into two at an index from the end.

The first will contain all indices from [0, N - M) (excluding the index N - M itself) and the second will contain all indices from [N - M, N) (excluding the index N itself).

Panics

Panics if M > N.

Examples

#![feature(split_array)]

let mut v = [1, 0, 3, 0, 5, 6];
let (left, right) = v.rsplit_array_mut::<4>();
assert_eq!(left, &mut [1, 0]);
assert_eq!(right, &mut [3, 0, 5, 6][..]);
left[1] = 2;
right[1] = 4;
assert_eq!(v, [1, 2, 3, 4, 5, 6]);

Trait Implementations

impl<T: ColorComponent + Approx> Approx for Rgba<T>

fn approx_distance_to(&self, other: &Self) -> f32

Get an approximated distance between two values

fn approx_eq(&self, other: &Self) -> bool

Check if values are approximately equal using DEFAULT_EPS

fn approx_eq_eps(&self, other: &Self, eps: f32) -> bool

Check if values are approximately equal using supplied eps value

impl<T: Clone + ColorComponent> Clone for Rgba<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug + ColorComponent> Debug for Rgba<T>

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

Formats the value using the given formatter.

impl<T: ColorComponent> Deref for Rgba<T>

type Target = [T; 4]

The resulting type after dereferencing.

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

Dereferences the value.

impl<T: ColorComponent> DerefMut for Rgba<T>

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

Mutably dereferences the value.

impl<'de, T> Deserialize<'de> for Rgba<T>

where T: Deserialize<'de> + ColorComponent,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: ColorComponent> Display for Rgba<T>

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

Formats the value using the given formatter.

impl<C1: ColorComponent, C2: ColorComponent> From<Hsla<C1>> for Rgba<C2>

fn from(hsl: Hsla<C1>) -> Self

Converts to this type from the input type.

impl<C1: ColorComponent, C2: ColorComponent> From<Hsva<C1>> for Rgba<C2>

fn from(hsv: Hsva<C1>) -> Self

Converts to this type from the input type.

impl<C1: ColorComponent, C2: ColorComponent> From<Rgba<C1>> for Hsla<C2>

fn from(rgb: Rgba<C1>) -> Self

Converts to this type from the input type.

impl<C1: ColorComponent, C2: ColorComponent> From<Rgba<C1>> for Hsva<C2>

fn from(rgb: Rgba<C1>) -> Self

Converts to this type from the input type.

impl<T: ColorComponent> From<Rgba<T>> for String

fn from(color: Rgba<T>) -> String

Converts to this type from the input type.

impl<T: Hash + ColorComponent> Hash for Rgba<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: ColorComponent> Mul for Rgba<T>

type Output = Rgba<T>

The resulting type after applying the * operator.

fn mul(self, rhs: Self) -> Self

Performs the * operation.

impl<T: PartialEq + ColorComponent> PartialEq for Rgba<T>

fn eq(&self, other: &Rgba<T>) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> Serialize for Rgba<T>

where T: Serialize + ColorComponent,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: ColorComponent> TryFrom<&str> for Rgba<T>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl<T: ColorComponent> TryFrom<String> for Rgba<T>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: String) -> Result<Self, Self::Error>

Performs the conversion.

impl<T: Copy + ColorComponent> Copy for Rgba<T>

impl<T: Eq + ColorComponent> Eq for Rgba<T>

impl<T: ColorComponent> StructuralEq for Rgba<T>

impl<T: ColorComponent> StructuralPartialEq for Rgba<T>