Struct palette :: cam16 :: cam16_jsh :: Cam16Jsh Copy item path

impl<T> Cam16Jsh<T>

pub fn new<H>(lightness: T, saturation: T, hue: H) -> Self
where H: Into<Cam16Hue<T>>,

Create a partial CIE CAM16 color.

pub const fn new_const(lightness: T, saturation: T, hue: Cam16Hue<T>) -> Self

Create a partial CIE CAM16 color. This is the same as Cam16Jsh::new without the generic hue type. It’s temporary until const fn supports traits.

pub fn into_components(self) -> (T, T, Cam16Hue<T>)

Convert to a (lightness, saturation, hue) tuple.

pub fn from_components<H>((lightness, saturation, hue): (T, T, H)) -> Self
where H: Into<Cam16Hue<T>>,

Convert from a (lightness, saturation, hue) tuple.

pub fn from_xyz<WpParam>( color: Xyz<WpParam::StaticWp, T>, parameters: impl Into<BakedParameters<WpParam, T::Scalar>> ) -> Self
where Xyz<WpParam::StaticWp, T>: IntoCam16Unclamped<WpParam, Self, Scalar = T::Scalar>, T: FromScalar, WpParam: WhitePointParameter<T::Scalar>,

Derive partial CIE CAM16 attributes for the provided color, under the provided viewing conditions.

use palette::{Srgb, IntoColor, cam16::{Cam16Jsh, Parameters}};

// Customize these according to the viewing conditions:
let mut example_parameters = Parameters::default_static_wp(40.0);

let rgb = Srgb::new(0.3f32, 0.8, 0.1);
let partial = Cam16Jsh::from_xyz(rgb.into_color(), example_parameters);

It’s also possible to “pre-bake” the parameters, to avoid recalculate some of the derived values when converting multiple color value.

use palette::{Srgb, IntoColor, cam16::{Cam16Jsh, Parameters}};

// Customize these according to the viewing conditions:
let mut example_parameters = Parameters::default_static_wp(40.0);

let baked_parameters = example_parameters.bake();

let rgb = Srgb::new(0.3f32, 0.8, 0.1);
let partial = Cam16Jsh::from_xyz(rgb.into_color(), baked_parameters);

pub fn into_xyz<WpParam>( self, parameters: impl Into<BakedParameters<WpParam, T::Scalar>> ) -> Xyz<WpParam::StaticWp, T>
where Self: Cam16IntoUnclamped<WpParam, Xyz<WpParam::StaticWp, T>, Scalar = T::Scalar>, WpParam: WhitePointParameter<T>, T: FromScalar,

Construct an XYZ color from these CIE CAM16 attributes, under the provided viewing conditions.

use palette::{Srgb, FromColor, cam16::{Cam16Jsh, Parameters}};

// Customize these according to the viewing conditions:
let mut example_parameters = Parameters::default_static_wp(40.0);

let partial = Cam16Jsh::new(50.0f32, 80.0, 120.0);
let rgb = Srgb::from_color(partial.into_xyz(example_parameters));

It’s also possible to “pre-bake” the parameters, to avoid recalculate some of the derived values when converting multiple color value.

use palette::{Srgb, FromColor, cam16::{Cam16Jsh, Parameters}};

// Customize these according to the viewing conditions:
let mut example_parameters = Parameters::default_static_wp(40.0);

let baked_parameters = example_parameters.bake();

let partial = Cam16Jsh::new(50.0f32, 80.0, 120.0);
let rgb = Srgb::from_color(partial.into_xyz(baked_parameters));

pub fn from_full(full: Cam16<T>) -> Self

Create a partial set of CIE CAM16 attributes.

It’s also possible to use Cam16Jsh::from or Cam16::into.

pub fn into_full<WpParam>( self, parameters: impl Into<BakedParameters<WpParam, T::Scalar>> ) -> Cam16<T>
where Self: IntoCam16Unclamped<WpParam, Cam16<T>, Scalar = T::Scalar>, T: FromScalar,

Reconstruct a full set of CIE CAM16 attributes, using the original viewing conditions.

use palette::{Srgb, IntoColor, cam16::{Cam16, Cam16Jsh, Parameters}};
use approx::assert_relative_eq;

// Customize these according to the viewing conditions:
let mut example_parameters = Parameters::default_static_wp(40.0);

// Optional, but saves some work:
let baked_parameters = example_parameters.bake();

let rgb = Srgb::new(0.3f64, 0.8, 0.1);
let cam16 = Cam16::from_xyz(rgb.into_color(), baked_parameters);
let partial = Cam16Jsh::from(cam16);
let reconstructed = partial.into_full(baked_parameters);

assert_relative_eq!(cam16, reconstructed, epsilon = 0.0000000000001);

impl<T> Cam16Jsh<&T>

pub fn copied(&self) -> Cam16Jsh<T>
where T: Copy,

Get an owned, copied version of this color.

pub fn cloned(&self) -> Cam16Jsh<T>
where T: Clone,

Get an owned, cloned version of this color.

impl<T> Cam16Jsh<&mut T>

pub fn set(&mut self, value: Cam16Jsh<T>)

Update this color with new values.

pub fn as_refs(&self) -> Cam16Jsh<&T>

Borrow this color’s components as shared references.

pub fn copied(&self) -> Cam16Jsh<T>
where T: Copy,

Get an owned, copied version of this color.

pub fn cloned(&self) -> Cam16Jsh<T>
where T: Clone,

Get an owned, cloned version of this color.

impl<C> Cam16Jsh<C>

pub fn iter<'a>(&'a self) -> <&'a Self as IntoIterator>::IntoIter
where &'a Self: IntoIterator,

Return an iterator over the colors in the wrapped collections.

pub fn iter_mut<'a>(&'a mut self) -> <&'a mut Self as IntoIterator>::IntoIter
where &'a mut Self: IntoIterator,

Return an iterator that allows modifying the colors in the wrapped collections.

pub fn get<'a, I, T>( &'a self, index: I ) -> Option<Cam16Jsh<&>::Output>>
where T: 'a, C: AsRef<[T]>, I: SliceIndex<[T]> + Clone,

Get a color, or slice of colors, with references to the components at index. See slice::get for details.

pub fn get_mut<'a, I, T>( &'a mut self, index: I ) -> Option<Cam16Jsh<&mut >::Output>>
where T: 'a, C: AsMut<[T]>, I: SliceIndex<[T]> + Clone,

Get a color, or slice of colors, that allows modifying the components at index. See slice::get_mut for details.

impl<T> Cam16Jsh<Vec<T>>

pub fn with_capacity(capacity: usize) -> Self

Create a struct of vectors with a minimum capacity. See Vec::with_capacity for details.

pub fn push(&mut self, value: Cam16Jsh<T>)

Push an additional color’s components onto the component vectors. See Vec::push for details.

pub fn pop(&mut self) -> Option<Cam16Jsh<T>>

Pop a color’s components from the component vectors. See Vec::pop for details.

pub fn clear(&mut self)

Clear the component vectors. See Vec::clear for details.

pub fn drain<R>(&mut self, range: R) -> Iter<Drain<'_, T>> ⓘ
where R: RangeBounds<usize> + Clone,

Return an iterator that moves colors out of the specified range.

Trait Implementations§

impl<T> AbsDiffEq for Cam16Jsh<T>
where T: AbsDiffEq, T::Epsilon: Clone, Cam16Hue<T>: AbsDiffEq<Epsilon = T::Epsilon>,

type Epsilon = <T as AbsDiffEq>::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 abs_diff_eq(&self, other: &Self, epsilon: T::Epsilon) -> bool

A test for equality that uses the absolute difference to compute the approximate equality of two numbers.

fn abs_diff_ne(&self, other: &Self, epsilon: T::Epsilon) -> bool

The inverse of AbsDiffEq::abs_diff_eq.

impl<T> Add<T> for Cam16Jsh<T>
where T: Add<Output = T> + Clone,

type Output = Cam16Jsh<T>

The resulting type after applying the + operator.

fn add(self, c: T) -> Self::Output

Performs the + operation. Read more

impl<T> Add for Cam16Jsh<T>
where T: Add<Output = T>,

type Output = Cam16Jsh<T>

The resulting type after applying the + operator.

fn add(self, other: Self) -> Self::Output

Performs the + operation. Read more

impl<T> AddAssign<T> for Cam16Jsh<T>
where T: AddAssign + Clone,

fn add_assign(&mut self, c: T)

Performs the += operation. Read more

impl<T> AddAssign for Cam16Jsh<T>
where T: AddAssign,

fn add_assign(&mut self, other: Self)

Performs the += operation. Read more

impl<T> ArrayCast for Cam16Jsh<T>

type Array = [T; 3]

The output type of a cast to an array.

impl<T> AsMut<[T]> for Cam16Jsh<T>

fn as_mut(&mut self) -> &mut [T]

Converts this type into a mutable reference of the (usually inferred) input type.

impl<T> AsMut<[T; 3]> for Cam16Jsh<T>

fn as_mut(&mut self) -> &mut [T; 3]

Converts this type into a mutable reference of the (usually inferred) input type.

impl<T> AsMut<Cam16Jsh<T>> for [T; 3]

fn as_mut(&mut self) -> &mut Cam16Jsh<T>

Converts this type into a mutable reference of the (usually inferred) input type.

impl<T> AsRef<[T]> for Cam16Jsh<T>

fn as_ref(&self) -> &[T]

Converts this type into a shared reference of the (usually inferred) input type.

impl<T> AsRef<[T; 3]> for Cam16Jsh<T>

fn as_ref(&self) -> &[T; 3]

Converts this type into a shared reference of the (usually inferred) input type.

impl<T> AsRef<Cam16Jsh<T>> for [T; 3]

fn as_ref(&self) -> &Cam16Jsh<T>

Converts this type into a shared reference of the (usually inferred) input type.

impl<WpParam, T> Cam16FromUnclamped<WpParam, Cam16Jsh<T>> for Cam16<T>
where WpParam: WhitePointParameter<T>, T: Real + FromScalar + Zero + Arithmetics + Sqrt + PartialCmp + Clone, T::Mask: LazySelect<T> + Clone, T::Scalar: Clone,

type Scalar = <T as FromScalar>::Scalar

The number type that’s used in parameters when converting.

fn cam16_from_unclamped( cam16: Cam16Jsh<T>, parameters: BakedParameters<WpParam, Self::Scalar> ) -> Self

Converts color into Self, using the provided parameters.

impl<WpParam, T> Cam16FromUnclamped<WpParam, Xyz<<WpParam as WhitePointParameter<T>>::StaticWp, T>> for Cam16Jsh<T>
where Xyz<WpParam::StaticWp, T>: IntoCam16Unclamped<WpParam, Cam16<T>>, WpParam: WhitePointParameter<T>,

type Scalar = <Xyz<<WpParam as WhitePointParameter<T>>::StaticWp, T> as IntoCam16Unclamped<WpParam, Cam16<T>>>::Scalar

The number type that’s used in parameters when converting.

fn cam16_from_unclamped( color: Xyz<WpParam::StaticWp, T>, parameters: BakedParameters<WpParam, Self::Scalar> ) -> Self

Converts color into Self, using the provided parameters.

impl<T> Clamp for Cam16Jsh<T>
where T: Clamp + Zero,

fn clamp(self) -> Self

Return a new color where out-of-bounds components have been changed to the nearest valid values. Read more

impl<T> ClampAssign for Cam16Jsh<T>
where T: ClampAssign + Zero,

fn clamp_assign(&mut self)

Changes out-of-bounds components to the nearest valid values. Read more

impl<T: Clone> Clone for Cam16Jsh<T>

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

Returns a copy of the value. Read more

1.0.0 · source§

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

Performs copy-assignment from source. Read more

impl<T: Debug> Debug for Cam16Jsh<T>

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

Formats the value using the given formatter. Read more

impl<T: Default> Default for Cam16Jsh<T>

fn default() -> Cam16Jsh<T>

Returns the “default value” for a type. Read more

impl<T, C> Extend<Cam16Jsh<T>> for Cam16Jsh<C>
where C: Extend<T>,

fn extend<I: IntoIterator<Item = Cam16Jsh<T>>>(&mut self, iter: I)

Extends a collection with the contents of an iterator. Read more

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements. Read more