Struct colstodian::DynamicColorAlpha

pub struct DynamicColorAlpha {
    pub raw: Vec4,
    pub space: DynamicColorSpace,
    pub alpha_state: DynamicAlphaState,
}

A dynamic color with an alpha channel, with its space and alpha defined as data. This is mostly useful for (de)serialization.

See ColorAlpha, ColorSpace and AlphaState for more.

Fields

raw: Vec4

The raw tristimulus value of the color. Be careful when modifying this directly, i.e. don’t multiply two Colors’ raw values unless they are in the same color space and state.

space: DynamicColorSpace

alpha_state: DynamicAlphaState

Implementations

impl DynamicColorAlpha

pub fn new(
    raw: Vec4,
    space: DynamicColorSpace,
    alpha_state: DynamicAlphaState
) -> Self

Create a new DynamicColorAlpha with specified raw color components, color space, and alpha state.

pub fn into_color(self) -> DynamicColor

Converts self to a DynamicColor by first premultiplying self if it is not already and then stripping off the alpha component.

pub fn into_color_no_premultiply(self) -> DynamicColor

Converts self to a DynamicColor by stripping off the alpha component, without checking whether it is premultiplied or not.

pub fn convert(
    self,
    dst_space: DynamicColorSpace,
    dst_alpha: DynamicAlphaState
) -> Self

Converts from one color space and state to another.

• If converting from Premultiplied to Separate, if self’s alpha is 0.0, the resulting color values will not be changed.

pub fn downcast_convert<DstSpace, DstAlpha>(
    self
) -> ColorAlpha<DstSpace, DstAlpha> where
    DstSpace: ColorSpace,
    DstAlpha: AlphaState, 

Convert self to the specified space and downcast it to a typed ColorAlpha with the space and state specified.

pub fn convert_alpha_state(
    self,
    dst_alpha: DynamicAlphaState
) -> DynamicColorAlpha

Converts self to the provided dst_alpha DynamicAlphaState.

• If converting to the same state, this is a no-op.
• If converting from Premultiplied to Separate, if self’s alpha is 0.0, the resulting color values will not be changed.

Trait Implementations

impl Clone for DynamicColorAlpha

fn clone(&self) -> DynamicColorAlpha

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DynamicColorAlpha

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DynamicColorAlpha

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<'a> From<&'a (dyn AnyColorAlpha + 'a)> for DynamicColorAlpha

fn from(color: &'a dyn AnyColorAlpha) -> DynamicColorAlpha

Performs the conversion.

impl PartialEq<DynamicColorAlpha> for DynamicColorAlpha

fn eq(&self, other: &DynamicColorAlpha) -> bool

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

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

This method tests for !=.

impl Serialize for DynamicColorAlpha

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

Serialize this value into the given Serde serializer.

impl Copy for DynamicColorAlpha

impl StructuralPartialEq for DynamicColorAlpha