[][src]Struct palette::blend::PreAlpha

#[repr(C)]
pub struct PreAlpha<C, T: Float> {
    pub color: C,
    pub alpha: T,
}

Premultiplied alpha wrapper.

Premultiplied colors are commonly used in composition algorithms to simplify the calculations. It may also be preferred when interpolating between colors, which is one of the reasons why it's offered as a separate type. The other reason is to make it easier to avoid unnecessary computations in composition chains.

use palette::{Blend, LinSrgb, LinSrgba};
use palette::blend::PreAlpha;

let a = PreAlpha::from(LinSrgba::new(0.4, 0.5, 0.5, 0.3));
let b = PreAlpha::from(LinSrgba::new(0.3, 0.8, 0.4, 0.4));
let c = PreAlpha::from(LinSrgba::new(0.7, 0.1, 0.8, 0.8));

let res = LinSrgb::from_premultiplied(a.screen(b).overlay(c));

Note that converting to and from premultiplied alpha will cause the alpha component to be clamped to [0.0, 1.0].

Fields

color: C

The premultiplied color components (original.color * original.alpha).

alpha: T

The transparency component. 0.0 is fully transparent and 1.0 is fully opaque.

Trait Implementations

impl<C, T> Blend for PreAlpha<C, T> where
    C: Blend<Color = C> + ComponentWise<Scalar = T>,
    T: Float
[src]

type Color = C

The core color type. Typically Self for color types without alpha.

fn blend<F>(self, destination: Self, blend_function: F) -> Self where
    F: BlendFunction<Self::Color>, 
[src]

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[src]

Place self over other. This is the good old common alpha composition equation. Read more

fn inside(self, other: Self) -> Self[src]

Results in the parts of self that overlaps the visible parts of other. Read more

fn outside(self, other: Self) -> Self[src]

Results in the parts of self that lies outside the visible parts of other. Read more

fn atop(self, other: Self) -> Self[src]

Place self over only the visible parts of other.

fn xor(self, other: Self) -> Self[src]

Results in either self or other, where they do not overlap.

fn plus(self, other: Self) -> Self[src]

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[src]

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[src]

Make a color which is at least as light as self or other.

fn overlay(self, other: Self) -> Self[src]

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[src]

Return the darkest parts of self and other.

fn lighten(self, other: Self) -> Self[src]

Return the lightest parts of self and other.

fn dodge(self, other: Self) -> Self[src]

Lighten other to reflect self. Results in other if self is black. Read more

fn burn(self, other: Self) -> Self[src]

Darken other to reflect self. Results in other if self is white. Read more

fn hard_light(self, other: Self) -> Self[src]

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[src]

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[src]

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[src]

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<T: Float, C: Pixel<T>> Pixel<T> for PreAlpha<C, T>[src]

fn as_raw<P: RawPixel<T> + ?Sized>(&self) -> &P[src]

Cast as a reference to raw color components.

fn as_raw_mut<P: RawPixel<T> + ?Sized>(&mut self) -> &mut P[src]

Cast as a mutable reference to raw color components.

fn into_raw<P: RawPixelSized<T>>(self) -> P[src]

Convert from raw color components.

fn from_raw<P: RawPixel<T> + ?Sized>(pixel: &P) -> &Self[src]

Cast from a reference to raw color components.

fn from_raw_mut<P: RawPixel<T> + ?Sized>(pixel: &mut P) -> &mut Self[src]

Cast from a mutable reference to raw color components.

fn from_raw_slice(slice: &[T]) -> &[Self][src]

Cast a slice of raw color components to a slice of colors. Read more

fn from_raw_slice_mut(slice: &mut [T]) -> &mut [Self][src]

Cast a mutable slice of raw color components to a mutable slice of colors. Read more

fn into_raw_slice(slice: &[Self]) -> &[T][src]

Cast a slice of colors to a slice of raw color components. Read more

fn into_raw_slice_mut(slice: &mut [Self]) -> &mut [T][src]

Cast a mutable slice of colors to a mutable slice of raw color components. Read more

impl<C: Mix> Mix for PreAlpha<C, C::Scalar>[src]

type Scalar = C::Scalar

The type of the mixing factor.

impl<C: ComponentWise<Scalar = T>, T: Float> ComponentWise for PreAlpha<C, T>[src]

type Scalar = T

The scalar type for color components.

impl<C: Copy, T: Copy + Float> Copy for PreAlpha<C, T>[src]

impl<C, T, P: ?Sized> AsRef<P> for PreAlpha<C, T> where
    C: Pixel<T>,
    T: Float,
    P: RawPixel<T>, 
[src]

impl<C: Default, T: Float> Default for PreAlpha<C, T>[src]

impl<C: Clone, T: Clone + Float> Clone for PreAlpha<C, T>[src]

fn clone_from(&mut self, source: &Self)1.0.0[src]

Performs copy-assignment from source. Read more

impl<C: PartialEq, T: PartialEq + Float> PartialEq<PreAlpha<C, T>> for PreAlpha<C, T>[src]

impl<C, T> From<Alpha<C, T>> for PreAlpha<C, T> where
    C: ComponentWise<Scalar = T>,
    T: Float
[src]

impl<C, T> From<PreAlpha<C, T>> for Alpha<C, T> where
    C: ComponentWise<Scalar = T>,
    T: Float
[src]

impl<C, T, P: ?Sized> AsMut<P> for PreAlpha<C, T> where
    C: Pixel<T>,
    T: Float,
    P: RawPixel<T>, 
[src]

impl<C, T: Float> Deref for PreAlpha<C, T>[src]

type Target = C

The resulting type after dereferencing.

impl<C, T: Float> DerefMut for PreAlpha<C, T>[src]

impl<C: Debug, T: Debug + Float> Debug for PreAlpha<C, T>[src]

impl<C: Add, T: Float> Add<PreAlpha<C, T>> for PreAlpha<C, T>[src]

type Output = PreAlpha<C::Output, T>

The resulting type after applying the + operator.

impl<T: Float, C: Add<T>> Add<T> for PreAlpha<C, T>[src]

type Output = PreAlpha<C::Output, T>

The resulting type after applying the + operator.

impl<C: Sub, T: Float> Sub<PreAlpha<C, T>> for PreAlpha<C, T>[src]

type Output = PreAlpha<C::Output, T>

The resulting type after applying the - operator.

impl<T: Float, C: Sub<T>> Sub<T> for PreAlpha<C, T>[src]

type Output = PreAlpha<C::Output, T>

The resulting type after applying the - operator.

impl<C: Mul, T: Float> Mul<PreAlpha<C, T>> for PreAlpha<C, T>[src]

type Output = PreAlpha<C::Output, T>

The resulting type after applying the * operator.

impl<T: Float, C: Mul<T>> Mul<T> for PreAlpha<C, T>[src]

type Output = PreAlpha<C::Output, T>

The resulting type after applying the * operator.

impl<C: Div, T: Float> Div<PreAlpha<C, T>> for PreAlpha<C, T>[src]

type Output = PreAlpha<C::Output, T>

The resulting type after applying the / operator.

impl<T: Float, C: Div<T>> Div<T> for PreAlpha<C, T>[src]

type Output = PreAlpha<C::Output, T>

The resulting type after applying the / operator.

impl<C, T> ApproxEq for PreAlpha<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 relative_ne(
    &self,
    other: &Self,
    epsilon: Self::Epsilon,
    max_relative: Self::Epsilon
) -> bool
[src]

The inverse of ApproxEq::relative_eq.

fn ulps_ne(&self, other: &Self, epsilon: Self::Epsilon, max_ulps: u32) -> bool[src]

The inverse of ApproxEq::ulps_eq.

impl<C, T: Float> Serialize for PreAlpha<C, T> where
    C: Serialize,
    T: Serialize
[src]

impl<'de, C, T: Float> Deserialize<'de> for PreAlpha<C, T> where
    C: Deserialize<'de>,
    T: Deserialize<'de>, 
[src]

Auto Trait Implementations

impl<C, T> Unpin for PreAlpha<C, T> where
    C: Unpin,
    T: Unpin

impl<C, T> Sync for PreAlpha<C, T> where
    C: Sync,
    T: Sync

impl<C, T> Send for PreAlpha<C, T> where
    C: Send,
    T: Send

impl<C, T> UnwindSafe for PreAlpha<C, T> where
    C: UnwindSafe,
    T: UnwindSafe

impl<C, T> RefUnwindSafe for PreAlpha<C, T> where
    C: RefUnwindSafe,
    T: RefUnwindSafe

Blanket Implementations

impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for S where
    D: AdaptFrom<S, Swp, Dwp, T>,
    Dwp: WhitePoint,
    Swp: WhitePoint,
    T: Component + Float
[src]

fn adapt_into(self) -> D[src]

Convert the source color to the destination color using the bradford method by default Read more

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> DeserializeOwned for T where
    T: Deserialize<'de>, 
[src]