Struct GreyAlpha 

pub struct GreyAlpha<T: Float + Send + Sync> { /* private fields */ }

Grey with alpha channel.

Implementations

impl<T: Float + Send + Sync> GreyAlpha<T>

pub fn new(grey: T, alpha: T) -> Result<Self, ChromaticError>

Create a new GreyAlpha instance.

Arguments

• grey - The grey component, must be in range [0, 1]
• alpha - The alpha (transparency) component, must be in range [0, 1]

Errors

Returns an error if any component is outside the range [0, 1].

pub const fn grey(&self) -> T

Get the grey component.

pub const fn alpha(&self) -> T

Get the alpha component.

pub fn set_grey(&mut self, grey: T) -> Result<(), ChromaticError>

Set the grey component.

Arguments

• grey - The new grey value, must be in range [0, 1]

Errors

Returns an error if the value is outside the range [0, 1].

pub fn set_alpha(&mut self, alpha: T) -> Result<(), ChromaticError>

Set the alpha component.

Arguments

• alpha - The new alpha value, must be in range [0, 1]

Errors

Returns an error if the value is outside the range [0, 1].

pub fn set_components( &mut self, grey: T, alpha: T, ) -> Result<(), ChromaticError>

Set both components at once with validation.

Arguments

• grey - The grey component, must be in range [0, 1]
• alpha - The alpha component, must be in range [0, 1]

Errors

Returns an error if any component is outside the range [0, 1].

Trait Implementations

impl<T: Clone + Float + Send + Sync> Clone for GreyAlpha<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Float + Send + Sync> Colour<T, { $base_components + 1 }> for GreyAlpha<T>

fn from_hex(hex: &str) -> Result<Self, ChromaticError>

Create a new colour from a hex string.

fn to_hex(&self) -> Result<String, ChromaticError>

Convert the colour to a hex string.

fn from_bytes(bytes: [u8; 2]) -> Result<Self, ChromaticError>

Create a new colour from a byte array.

fn to_bytes(self) -> Result<[u8; 2], ChromaticError>

Convert the colour to a byte array.

fn lerp(lhs: &Self, rhs: &Self, t: T) -> Result<Self, ChromaticError>

Linear interpolate between two colours of the same type.

const NUM_COMPONENTS: usize = N

Number of components in the colour.

fn mix(colours: &[Self], weights: &[T]) -> Result<Self, ChromaticError>

where Self: Clone, T: AddAssign,

Mix multiple colours using weighted interpolation.

fn mix_two( colour1: &Self, weight1: T, colour2: &Self, weight2: T, ) -> Result<Self, ChromaticError>

where Self: Clone, T: AddAssign,

Mix two colours with specified weights.

fn gradient( start: &Self, end: &Self, steps: usize, ) -> Result<Vec<Self>, ChromaticError>

where Self: Clone,

Create a gradient between two colours with a specified number of steps.

impl<T: Float + Send + Sync> Convert<T> for GreyAlpha<T>

fn to_grey(&self) -> Result<Grey<T>, ChromaticError>

Convert a colour to the Grey colour space.

fn to_grey_alpha(&self) -> Result<GreyAlpha<T>, ChromaticError>

Convert a colour to the GreyAlpha colour space.

fn to_hsl(&self) -> Result<Hsl<T>, ChromaticError>

Convert a colour to the Hsl colour space.

fn to_hsl_alpha(&self) -> Result<HslAlpha<T>, ChromaticError>

Convert a colour to the HslAlpha colour space.

fn to_hsv(&self) -> Result<Hsv<T>, ChromaticError>

Convert a colour to the Hsv colour space.

fn to_hsv_alpha(&self) -> Result<HsvAlpha<T>, ChromaticError>

Convert a colour to the HsvAlpha colour space.

fn to_lab(&self) -> Result<Lab<T>, ChromaticError>

Convert a colour to the Lab colour space.

fn to_lab_alpha(&self) -> Result<LabAlpha<T>, ChromaticError>

Convert a colour to the LabAlpha colour space.

fn to_rgb(&self) -> Result<Rgb<T>, ChromaticError>

Convert a colour to the Rgb colour space.

fn to_rgb_alpha(&self) -> Result<RgbAlpha<T>, ChromaticError>

Convert a colour to the RgbAlpha colour space.

fn to_srgb(&self) -> Result<Srgb<T>, ChromaticError>

Convert a colour to the Srgb colour space.

fn to_srgb_alpha(&self) -> Result<SrgbAlpha<T>, ChromaticError>

Convert a colour to the SrgbAlpha colour space.

fn to_xyz(&self) -> Result<Xyz<T>, ChromaticError>

Convert a colour to the Xyz colour space.

fn to_xyz_alpha(&self) -> Result<XyzAlpha<T>, ChromaticError>

Convert a colour to the XyzAlpha colour space.

impl<T: Debug + Float + Send + Sync> Debug for GreyAlpha<T>

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

Formats the value using the given formatter.

impl<T: Float + Send + Sync> Display for GreyAlpha<T>

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

Formats the value using the given formatter.

impl<T: Copy + Float + Send + Sync> Copy for GreyAlpha<T>