Struct colstodian::DynamicColor

pub struct DynamicColor {
    pub raw: Vec3,
    pub space: DynamicColorSpace,
    pub state: DynamicState,
}

A dynamic color, with its Space and State defined as data. This is mostly useful for (de)serialization.

See Color, ColorSpace and State for more.

Fields

raw: Vec3

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

state: DynamicState

Implementations

impl DynamicColor

pub fn new(raw: Vec3, space: DynamicColorSpace, state: DynamicState) -> Self

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

pub fn convert(self, dest_space: DynamicColorSpace) -> ColorResult<Self>

Convert self to the given color space. Must not attempt to convert to or from a nonlinear color space while in scene-referred state.

pub fn convert_state<F>(
    self,
    dest_state: DynamicState,
    conversion: F
) -> ColorResult<Self> where
    F: FnOnce(Vec3) -> Vec3, 

Convert self’s state to the given state using the given conversion function.

self.space must be linear. See docs for Color::<Space, State>::convert_state

pub fn downcast_convert<DstSpace, DstState>(
    self
) -> ColorResult<Color<DstSpace, DstState>> where
    DstSpace: ColorSpace,
    DstState: State, 

Convert self to the specified space and downcast it to a typed Color with the space and state specified. self must already be in the correct DynamicState

pub fn linearize(self) -> Self

Convert self into the closest linear color space, if it is not linear already

pub fn with_alpha(
    &self,
    alpha: f32,
    alpha_state: DynamicAlphaState
) -> DynamicColorAlpha

Converts self to a DynamicColorAlpha with specified DynamicAlphaState by adding an alpha component.

pub fn from_kolor(color: Color, state: DynamicState) -> Self

Trait Implementations

impl AnyColor for DynamicColor

fn space(&self) -> DynamicColorSpace

fn state(&self) -> DynamicState

fn raw(&self) -> Vec3

fn dynamic(&self) -> DynamicColor

Upcasts self into a DynamicColor

impl Clone for DynamicColor

fn clone(&self) -> DynamicColor

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DynamicColor

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DynamicColor

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 AnyColor + 'a)> for DynamicColor

fn from(color: &'a dyn AnyColor) -> DynamicColor

Performs the conversion.

impl<Spc: ColorSpace, St: State> From<Color<Spc, St>> for DynamicColor

fn from(color: Color<Spc, St>) -> DynamicColor

Performs the conversion.

impl From<DynamicColor> for Color

fn from(color: DynamicColor) -> Color

Performs the conversion.

impl PartialEq<DynamicColor> for DynamicColor

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

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

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

This method tests for !=.

impl Serialize for DynamicColor

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 DynamicColor

impl StructuralPartialEq for DynamicColor