Struct GrayA

#[repr(C)]
pub struct GrayA<T, A = T> {
    pub v: T,
    pub a: A,
}

A Value (brightness) + Alpha pixel (rgb crate v0.9)

This pixel is commonly used for grayscale images.

Fields

v: T

Value - the brightness component. May be luma or luminance.

a: A

Alpha Component

Implementations

impl<T> GrayA<T>

where T: Copy,

pub fn value(self) -> T

Reads the .v field

This function isn’t necessary, but it is forwards-compatible with the next major version of the RGB crate.

pub fn value_mut(&mut self) -> &mut T

Exposes the .v field for writing

This function isn’t necessary, but it is forwards-compatible with the next major version of the RGB crate.

impl<T> GrayA<T>

where T: Copy,

pub const fn new(value: T, alpha: T) -> GrayA<T>

Creates a new GrayA pixel type from its components.

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

use rgb::GrayA;

let pixel = GrayA {v : value, a : alpha};

Trait Implementations

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

where T: Clone, A: Clone,

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T, A> Debug for GrayA<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 GrayA<T, A>

where T: Default, A: Default,

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

Returns the “default value” for a type.

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

where T: Ord, A: Ord,

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

where T: PartialEq, A: PartialEq,

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

where T: PartialOrd, A: PartialOrd,

fn partial_cmp(&self, other: &GrayA<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> Copy for GrayA<T, A>

where T: Copy, A: Copy,

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

where T: Eq, A: Eq,

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