Struct palette::cam16::Parameters

source ·
#[non_exhaustive]
pub struct Parameters<WpParam, T> { pub white_point: WpParam, pub adapting_luminance: T, pub background_luminance: T, pub surround: Surround<T>, pub discounting: Discounting<T>, }
Expand description

Parameters for CAM16 that describe the viewing conditions.

These parameters describe the viewing conditions for a more accurate color appearance metric. The CAM16 attributes and derived values are only really comparable if they were calculated with the same parameters. The parameters are, however, too dynamic to all be part of the type parameters of Cam16.

The default values are mostly a “blank slate”, with a couple of educated guesses. Be sure to at least customize the luminances according to the expected environment:

use palette::{Srgb, Xyz, IntoColor, cam16::{Parameters, Surround, Cam16}};

// 40 nits, 50% background luminance and a dim surrounding:
let mut example_parameters = Parameters::default_static_wp(40.0);
example_parameters.background_luminance = 0.5;
example_parameters.surround = Surround::Dim;

let example_color_xyz = Srgb::from(0x5588cc).into_linear().into_color();
let cam16: Cam16<f64> = Cam16::from_xyz(example_color_xyz, example_parameters);

See also Moroney (2000) Usage Guidelines for CIECAM97s for more information and advice on how to customize these parameters.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§white_point: WpParam

White point of the test illuminant, Xw Yw Zw. Yw should be normalized to 1.0.

Defaults to Wp when it implements WhitePoint. It can also be set to a custom value if Wp results in the wrong white point.

§adapting_luminance: T

The average luminance of the environment (test adapting field) (LA) in cd/m2 (nits).

Under a “gray world” assumption this is 20% of the luminance of the reference white.

§background_luminance: T

The luminance factor of the background (Yb), on a scale from 0.0 to 1.0 (relative to Yw = 1.0).

Defaults to 0.2, medium grey.

§surround: Surround<T>

A description of the peripheral area, with a value from 0% to 20%. Any value outside that range will be clamped to 0% or 20%. It has presets for “dark”, “dim” and “average”.

Defaults to “average” (20%).

§discounting: Discounting<T>

The degree of discounting of (or adaptation to) the reference illuminant. Defaults to Auto, making the degree of discounting depend on the other parameters, but can be customized if necessary.

Implementations§

source§

impl<Wp, T> Parameters<StaticWp<Wp>, T>

source

pub fn default_static_wp(adapting_luminance: T) -> Self
where T: Real,

Creates a new set of parameters with a static white point and their default values set.

These parameters may need to be further customized according to the viewing conditions.

source§

impl<T> Parameters<Xyz<Any, T>, T>

source

pub fn default_dynamic_wp( white_point: Xyz<Any, T>, adapting_luminance: T, ) -> Self
where T: Real,

Creates a new set of parameters with a dynamic white point and their default values set.

These parameters may need to be further customized according to the viewing conditions.

source§

impl<WpParam, T> Parameters<WpParam, T>

source

pub fn bake(self) -> BakedParameters<WpParam, T>
where BakedParameters<WpParam, T>: From<Self>,

Pre-bakes the parameters to avoid repeating parts of the calculaitons when converting to and from CAM16.

Trait Implementations§

source§

impl<WpParam: Clone, T: Clone> Clone for Parameters<WpParam, T>

source§

fn clone(&self) -> Parameters<WpParam, 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
source§

impl<WpParam, T> From<Parameters<WpParam, T>> for BakedParameters<WpParam, T>
where WpParam: WhitePointParameter<T>, T: Real + FromScalar<Scalar = T> + One + Zero + Clamp + PartialCmp + Arithmetics + Powf + Sqrt + Exp + Abs + Signum + Clone, T::Mask: LazySelect<T>,

source§

fn from(value: Parameters<WpParam, T>) -> Self

Converts to this type from the input type.
source§

impl<WpParam: Copy, T: Copy> Copy for Parameters<WpParam, T>

Auto Trait Implementations§

§

impl<WpParam, T> Freeze for Parameters<WpParam, T>
where WpParam: Freeze, T: Freeze,

§

impl<WpParam, T> RefUnwindSafe for Parameters<WpParam, T>
where WpParam: RefUnwindSafe, T: RefUnwindSafe,

§

impl<WpParam, T> Send for Parameters<WpParam, T>
where WpParam: Send, T: Send,

§

impl<WpParam, T> Sync for Parameters<WpParam, T>
where WpParam: Sync, T: Sync,

§

impl<WpParam, T> Unpin for Parameters<WpParam, T>
where WpParam: Unpin, T: Unpin,

§

impl<WpParam, T> UnwindSafe for Parameters<WpParam, T>
where WpParam: UnwindSafe, T: UnwindSafe,

Blanket Implementations§

source§

impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for S
where T: Real + Zero + Arithmetics + Clone, Swp: WhitePoint<T>, Dwp: WhitePoint<T>, D: AdaptFrom<S, Swp, Dwp, T>,

source§

fn adapt_into_using<M>(self, method: M) -> D
where M: TransformMatrix<T>,

Convert the source color to the destination color using the specified method.
source§

fn adapt_into(self) -> D

Convert the source color to the destination color using the bradford method by default.
source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T, C> ArraysFrom<C> for T
where C: IntoArrays<T>,

source§

fn arrays_from(colors: C) -> T

Cast a collection of colors into a collection of arrays.
source§

impl<T, C> ArraysInto<C> for T
where C: FromArrays<T>,

source§

fn arrays_into(self) -> C

Cast this collection of arrays into a collection of colors.
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<WpParam, T, U> Cam16IntoUnclamped<WpParam, T> for U
where T: FromCam16Unclamped<WpParam, U>,

source§

type Scalar = <T as FromCam16Unclamped<WpParam, U>>::Scalar

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

fn cam16_into_unclamped( self, parameters: BakedParameters<WpParam, <U as Cam16IntoUnclamped<WpParam, T>>::Scalar>, ) -> T

Converts self into C, using the provided parameters.
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T, C> ComponentsFrom<C> for T
where C: IntoComponents<T>,

source§

fn components_from(colors: C) -> T

Cast a collection of colors into a collection of color components.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> FromAngle<T> for T

source§

fn from_angle(angle: T) -> T

Performs a conversion from angle.
source§

impl<T, U> FromStimulus<U> for T
where U: IntoStimulus<T>,

source§

fn from_stimulus(other: U) -> T

Converts other into Self, while performing the appropriate scaling, rounding and clamping.
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> IntoAngle<U> for T
where U: FromAngle<T>,

source§

fn into_angle(self) -> U

Performs a conversion into T.
source§

impl<WpParam, T, U> IntoCam16Unclamped<WpParam, T> for U
where T: Cam16FromUnclamped<WpParam, U>,

source§

type Scalar = <T as Cam16FromUnclamped<WpParam, U>>::Scalar

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

fn into_cam16_unclamped( self, parameters: BakedParameters<WpParam, <U as IntoCam16Unclamped<WpParam, T>>::Scalar>, ) -> T

Converts self into C, using the provided parameters.
source§

impl<T, U> IntoColor<U> for T
where U: FromColor<T>,

source§

fn into_color(self) -> U

Convert into T with values clamped to the color defined bounds Read more
source§

impl<T, U> IntoColorUnclamped<U> for T
where U: FromColorUnclamped<T>,

source§

fn into_color_unclamped(self) -> U

Convert into T. The resulting color might be invalid in its color space Read more
source§

impl<T> IntoStimulus<T> for T

source§

fn into_stimulus(self) -> T

Converts self into T, while performing the appropriate scaling, rounding and clamping.
source§

impl<T> ToOwned for T
where T: Clone,

source§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, C> TryComponentsInto<C> for T
where C: TryFromComponents<T>,

source§

type Error = <C as TryFromComponents<T>>::Error

The error for when try_into_colors fails to cast.
source§

fn try_components_into(self) -> Result<C, <T as TryComponentsInto<C>>::Error>

Try to cast this collection of color components into a collection of colors. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

source§

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

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T, U> TryIntoColor<U> for T
where U: TryFromColor<T>,

source§

fn try_into_color(self) -> Result<U, OutOfBounds<U>>

Convert into T, returning ok if the color is inside of its defined range, otherwise an OutOfBounds error is returned which contains the unclamped color. Read more
source§

impl<C, U> UintsFrom<C> for U
where C: IntoUints<U>,

source§

fn uints_from(colors: C) -> U

Cast a collection of colors into a collection of unsigned integers.
source§

impl<C, U> UintsInto<C> for U
where C: FromUints<U>,

source§

fn uints_into(self) -> C

Cast this collection of unsigned integers into a collection of colors.