Struct palette::Alpha
[−]
[src]
pub struct Alpha<C, T: Float> {
pub color: C,
pub alpha: T,
}An alpha component wrapper for colors.
Fields
color: C
The color.
alpha: T
The transparency component. 0.0 is fully transparent and 1.0 is fully opaque.
Methods
impl<T: Float> Alpha<Rgb<T>, T>[src]
Rgba implementations.
fn new(red: T, green: T, blue: T, alpha: T) -> Rgba<T>
Linear RGB with transparency.
fn new_u8(red: u8, green: u8, blue: u8, alpha: u8) -> Rgba<T>
Linear RGB with transparency from 8 bit values.
fn from_pixel<P: RgbPixel<T>>(pixel: &P) -> Rgba<T>
Linear RGB from a linear pixel value.
fn to_pixel<P: RgbPixel<T>>(&self) -> P
Convert to a linear RGB pixel. Rgb is already assumed to be linear,
so the components will just be clamped to [0.0, 1.0] before conversion.
use palette::Rgba; let c = Rgba::new(0.5, 0.3, 0.1, 0.5); assert_eq!((c.red, c.green, c.blue, c.alpha), c.to_pixel()); assert_eq!((0.5, 0.3, 0.1, 0.5), c.to_pixel());
impl<T: Float> Alpha<Luma<T>, T>[src]
Lumaa implementations.
fn new(luma: T, alpha: T) -> Lumaa<T>
Linear luminance with transparency.
fn new_u8(luma: u8, alpha: u8) -> Lumaa<T>
Linear luminance and transparency from 8 bit values.
impl<T: Float> Alpha<Yxy<T>, T>[src]
Yxya implementations.
impl<T: Float> Alpha<Xyz<T>, T>[src]
Xyza implementations.
impl<T: Float> Alpha<Lab<T>, T>[src]
Laba implementations.
impl<T: Float> Alpha<Lch<T>, T>[src]
Lcha implementations.
impl<T: Float> Alpha<Hsv<T>, T>[src]
Hsva implementations.
impl<T: Float> Alpha<Hsl<T>, T>[src]
Hsla implementations.
fn new(hue: RgbHue<T>, saturation: T, lightness: T, alpha: T) -> Hsla<T>
Linear HSL and transparency.
impl<T: Float> Alpha<Hwb<T>, T>[src]
Hwba implementations.
fn new(hue: RgbHue<T>, whiteness: T, blackness: T, alpha: T) -> Hwba<T>
Linear HSV and transparency.
impl<T: Float> Alpha<Color<T>, T>[src]
Colora implementations.
fn y(luma: T, alpha: T) -> Colora<T>
Linear luminance.
fn y_u8(luma: u8, alpha: u8) -> Colora<T>
Linear luminance from an 8 bit value.
fn rgb(red: T, green: T, blue: T, alpha: T) -> Colora<T>
Linear RGB.
fn rgb_u8(red: u8, green: u8, blue: u8, alpha: u8) -> Colora<T>
Linear RGB from 8 bit values.
fn xyz(x: T, y: T, z: T, alpha: T) -> Colora<T>
CIE XYZ.
fn yxy(x: T, y: T, luma: T, alpha: T) -> Colora<T>
CIE Yxy.
fn lab(l: T, a: T, b: T, alpha: T) -> Colora<T>
CIE L*a*b*.
fn lch(l: T, chroma: T, hue: LabHue<T>, alpha: T) -> Colora<T>
CIE L*C*h°.
fn hsv(hue: RgbHue<T>, saturation: T, value: T, alpha: T) -> Colora<T>
Linear HSV.
fn hsl(hue: RgbHue<T>, saturation: T, lightness: T, alpha: T) -> Colora<T>
Linear HSL.
fn hwb(hue: RgbHue<T>, whiteness: T, balckness: T, alpha: T) -> Colora<T>
Linear HWB.
Trait Implementations
impl<C, T> From<PreAlpha<C, T>> for Alpha<C, T> where C: ComponentWise<Scalar=T>, T: Float[src]
impl<C: PartialEq, T: PartialEq + Float> PartialEq for Alpha<C, T>[src]
fn eq(&self, __arg_0: &Alpha<C, T>) -> bool
This method tests for self and other values to be equal, and is used by ==. Read more
fn ne(&self, __arg_0: &Alpha<C, T>) -> bool
This method tests for !=.
impl<C: Debug, T: Debug + Float> Debug for Alpha<C, T>[src]
impl<C: Copy, T: Copy + Float> Copy for Alpha<C, T>[src]
impl<C: Clone, T: Clone + Float> Clone for Alpha<C, T>[src]
fn clone(&self) -> Alpha<C, T>
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)1.0.0
Performs copy-assignment from source. Read more
impl<C, T: Float> Deref for Alpha<C, T>[src]
type Target = C
The resulting type after dereferencing
fn deref(&self) -> &C
The method called to dereference a value
impl<C, T: Float> DerefMut for Alpha<C, T>[src]
fn deref_mut(&mut self) -> &mut C
The method called to mutably dereference a value
impl<C: Mix> Mix for Alpha<C, C::Scalar>[src]
type Scalar = C::Scalar
The type of the mixing factor.
fn mix(&self, other: &Alpha<C, C::Scalar>, factor: C::Scalar) -> Alpha<C, C::Scalar>
Mix the color with an other color, by factor. Read more
impl<C: Shade> Shade for Alpha<C, C::Scalar>[src]
type Scalar = C::Scalar
The type of the lighten/darken amount.
fn lighten(&self, amount: C::Scalar) -> Alpha<C, C::Scalar>
Lighten the color by amount.
fn darken(&self, amount: Self::Scalar) -> Self
Darken the color by amount.
impl<C: GetHue, T: Float> GetHue for Alpha<C, T>[src]
type Hue = C::Hue
The kind of hue unit this color space uses. Read more
fn get_hue(&self) -> Option<C::Hue>
Calculate a hue if possible. Read more
impl<C: Hue, T: Float> Hue for Alpha<C, T>[src]
fn with_hue(&self, hue: C::Hue) -> Alpha<C, T>
Return a new copy of self, but with a specific hue.
fn shift_hue(&self, amount: C::Hue) -> Alpha<C, T>
Return a new copy of self, but with the hue shifted by amount.
impl<C: Saturate> Saturate for Alpha<C, C::Scalar>[src]
type Scalar = C::Scalar
The type of the (de)saturation factor.
fn saturate(&self, factor: C::Scalar) -> Alpha<C, C::Scalar>
Increase the saturation by factor.
fn desaturate(&self, factor: Self::Scalar) -> Self
Decrease the saturation by factor.
impl<C: Limited, T: Float> Limited for Alpha<C, T>[src]
fn is_valid(&self) -> bool
Check if the color's components are within the expected ranges.
fn clamp(&self) -> Alpha<C, T>
Return a new color where the components has been clamped to the nearest valid values. Read more
fn clamp_self(&mut self)
Clamp the color's components to the nearest valid values.
impl<C: Blend, T: Float> Blend for Alpha<C, T> where C::Color: ComponentWise<Scalar=T>, Alpha<C, T>: Into<Alpha<C::Color, T>> + From<Alpha<C::Color, T>>[src]
type Color = C::Color
The core color type. Typically Self for color types without alpha.
fn into_premultiplied(self) -> PreAlpha<C::Color, T>
Convert the color to premultiplied alpha.
fn from_premultiplied(color: PreAlpha<C::Color, T>) -> Alpha<C, T>
Convert the color from premultiplied alpha.
fn blend<F>(self, destination: Self, blend_function: F) -> Self where F: BlendFunction<Self::Color>
Blend self, as the source color, with destination, using blend_function. Anything that implements BlendFunction is acceptable, including functions and closures. Read more
fn over(self, other: Self) -> Self
Place self over other. This is the good old common alpha composition equation. Read more
fn inside(self, other: Self) -> Self
Results in the parts of self that overlaps the visible parts of other. Read more
fn outside(self, other: Self) -> Self
Results in the parts of self that lies outside the visible parts of other. Read more
fn atop(self, other: Self) -> Self
Place self over only the visible parts of other.
fn xor(self, other: Self) -> Self
Results in either self or other, where they do not overlap.
fn plus(self, other: Self) -> Self
Add self and other. This uses the alpha component to regulate the effect, so it's not just plain component wise addition. Read more
fn multiply(self, other: Self) -> Self
Multiply self with other. This uses the alpha component to regulate the effect, so it's not just plain component wise multiplication. Read more
fn screen(self, other: Self) -> Self
Make a color which is at least as light as self or other.
fn overlay(self, other: Self) -> Self
Multiply self or other if other is dark, or screen them if other is light. This results in an S curve. Read more
fn darken(self, other: Self) -> Self
Return the darkest parts of self and other.
fn lighten(self, other: Self) -> Self
Return the lightest parts of self and other.
fn dodge(self, other: Self) -> Self
Lighten other to reflect self. Results in other if self is black. Read more
fn burn(self, other: Self) -> Self
Darken other to reflect self. Results in other if self is white. Read more
fn hard_light(self, other: Self) -> Self
Multiply self or other if other is dark, or screen them if self is light. This is similar to overlay, but depends on self instead of other. Read more
fn soft_light(self, other: Self) -> Self
Lighten other if self is light, or darken other as if it's burned if self is dark. The effect is increased if the components of self is further from 0.5. Read more
fn difference(self, other: Self) -> Self
Return the absolute difference between self and other. It's basically abs(self - other), but regulated by the alpha component. Read more
fn exclusion(self, other: Self) -> Self
Similar to difference, but appears to result in a lower contrast. other is inverted if self is white, and preserved if self is black. Read more
impl<C: ComponentWise<Scalar=T>, T: Float> ComponentWise for Alpha<C, T>[src]
type Scalar = T
The scalar type for color components.
fn component_wise<F: FnMut(T, T) -> T>(&self, other: &Alpha<C, T>, f: F) -> Alpha<C, T>
Perform a binary operation on this and an other color.
fn component_wise_self<F: FnMut(T) -> T>(&self, f: F) -> Alpha<C, T>
Perform a unary operation on this color.
impl<C: Default, T: Float> Default for Alpha<C, T>[src]
impl<C, T> ApproxEq for Alpha<C, T> where C: ApproxEq<Epsilon=T::Epsilon>, T: ApproxEq + Float, T::Epsilon: Copy[src]
type Epsilon = T::Epsilon
Used for specifying relative comparisons.
fn default_epsilon() -> Self::Epsilon
The default tolerance to use when testing values that are close together. Read more
fn default_max_relative() -> Self::Epsilon
The default relative tolerance for testing values that are far-apart. Read more
fn default_max_ulps() -> u32
The default ULPs to tolerate when testing values that are far-apart. Read more
fn relative_eq(&self, other: &Alpha<C, T>, epsilon: Self::Epsilon, max_relative: Self::Epsilon) -> bool
A test for equality that uses a relative comparison if the values are far apart.
fn ulps_eq(&self, other: &Alpha<C, T>, epsilon: Self::Epsilon, max_ulps: u32) -> bool
A test for equality that uses units in the last place (ULP) if the values are far apart.
fn relative_ne(&self, other: &Self, epsilon: Self::Epsilon, max_relative: Self::Epsilon) -> bool
The inverse of ApproxEq::relative_eq.
fn ulps_ne(&self, other: &Self, epsilon: Self::Epsilon, max_ulps: u32) -> bool
The inverse of ApproxEq::ulps_eq.
impl<C: Add, T: Float> Add for Alpha<C, T>[src]
type Output = Alpha<C::Output, T>
The resulting type after applying the + operator
fn add(self, other: Alpha<C, T>) -> Alpha<C::Output, T>
The method for the + operator
impl<T: Float + Clone, C: Add<T>> Add<T> for Alpha<C, T>[src]
type Output = Alpha<C::Output, T>
The resulting type after applying the + operator
fn add(self, c: T) -> Alpha<C::Output, T>
The method for the + operator
impl<C: Sub, T: Float> Sub for Alpha<C, T>[src]
type Output = Alpha<C::Output, T>
The resulting type after applying the - operator
fn sub(self, other: Alpha<C, T>) -> Alpha<C::Output, T>
The method for the - operator
impl<T: Float + Clone, C: Sub<T>> Sub<T> for Alpha<C, T>[src]
type Output = Alpha<C::Output, T>
The resulting type after applying the - operator
fn sub(self, c: T) -> Alpha<C::Output, T>
The method for the - operator
impl<C: Mul, T: Float> Mul for Alpha<C, T>[src]
type Output = Alpha<C::Output, T>
The resulting type after applying the * operator
fn mul(self, other: Alpha<C, T>) -> Alpha<C::Output, T>
The method for the * operator
impl<T: Float + Clone, C: Mul<T>> Mul<T> for Alpha<C, T>[src]
type Output = Alpha<C::Output, T>
The resulting type after applying the * operator
fn mul(self, c: T) -> Alpha<C::Output, T>
The method for the * operator
impl<C: Div, T: Float> Div for Alpha<C, T>[src]
type Output = Alpha<C::Output, T>
The resulting type after applying the / operator
fn div(self, other: Alpha<C, T>) -> Alpha<C::Output, T>
The method for the / operator
impl<T: Float + Clone, C: Div<T>> Div<T> for Alpha<C, T>[src]
type Output = Alpha<C::Output, T>
The resulting type after applying the / operator
fn div(self, c: T) -> Alpha<C::Output, T>
The method for the / operator