Struct Okhsla 

pub struct Okhsla {
    pub hue: f32,
    pub saturation: f32,
    pub lightness: f32,
    pub alpha: f32,
}

Color in Okhsl color space with alpha. Further information on this color model can be found on https://bottosson.github.io/posts/colorpicker.

Okhsl is defined relative to the sRGB (Rec. 709) gamut. Converting a wide-gamut or HDR color clamps the lightness to 1.0 but can push saturation outside [0.0, 1.0].

Conversion

Conversion between the various color spaces is achieved using Rust’s native From trait. Because certain color spaces are defined by their transformation to and from another space, these From implementations reflect that set of definitions.

let color = Srgba::rgb(0.5, 0.5, 0.5);

// Using From explicitly
let linear_color = LinearRgba::from(color);

// Using Into
let linear_color: LinearRgba = color.into();

For example, the sRGB space is defined by its relationship with Linear RGB, and HWB by its with sRGB. As such, it is the responsibility of sRGB to provide From implementations for Linear RGB, and HWB for sRGB. To then provide conversion between Linear RGB and HWB directly, HWB is responsible for implementing these conversions, delegating to sRGB as an intermediatory. This ensures that all conversions take the shortest path between any two spaces, and limit the proliferation of domain specific knowledge for each color space to their respective definitions.

Fields

hue: f32

The hue channel. [0.0, 360.0]

saturation: f32

The saturation channel. [0.0, 1.0]

lightness: f32

The lightness channel. [0.0, 1.0]

alpha: f32

The alpha channel. [0.0, 1.0]

Implementations

impl Okhsla

pub const fn new( hue: f32, saturation: f32, lightness: f32, alpha: f32, ) -> Okhsla

Construct a new Okhsla color from components.

Arguments

• hue - Hue channel. [0.0, 360.0]
• saturation - Saturation channel. [0.0, 1.0]
• lightness - Lightness channel. [0.0, 1.0]
• alpha - Alpha channel. [0.0, 1.0]

pub const fn hsl(hue: f32, saturation: f32, lightness: f32) -> Okhsla

Construct a new Okhsla color from (h, s, l) components, with the default alpha (1.0).

Arguments

• hue - Hue channel. [0.0, 360.0]
• saturation - Saturation channel. [0.0, 1.0]
• lightness - Lightness channel. [0.0, 1.0]

pub const fn with_saturation(self, saturation: f32) -> Okhsla

Return a copy of this color with the saturation channel set to the given value.

pub const fn with_lightness(self, lightness: f32) -> Okhsla

Return a copy of this color with the lightness channel set to the given value.

pub const fn sequential_dispersed(index: u32) -> Okhsla

Generate a deterministic but quasi-randomly distributed color from a provided index.

This can be helpful for generating debug colors.

Examples

// Unique color for an entity
// let entity_index = entity.index();
let color = Okhsla::sequential_dispersed(entity_index);

// Palette with 5 distinct hues
let palette = (0..5).map(Okhsla::sequential_dispersed).collect::<Vec<_>>();

Trait Implementations

impl Add for Okhsla

type Output = Okhsla

The resulting type after applying the + operator.

fn add(self, rhs: Okhsla) -> <Okhsla as Add>::Output

Performs the + operation.

impl AddAssign for Okhsla

fn add_assign(&mut self, rhs: Okhsla)

Performs the += operation.

impl Alpha for Okhsla

fn with_alpha(&self, alpha: f32) -> Okhsla

Return a new version of this color with the given alpha value.

fn alpha(&self) -> f32

Return the alpha component of this color.

fn set_alpha(&mut self, alpha: f32)

Sets the alpha component of this color.

fn is_fully_transparent(&self) -> bool

Is the alpha component of this color less than or equal to 0.0?

fn is_fully_opaque(&self) -> bool

Is the alpha component of this color greater than or equal to 1.0?

impl Clone for Okhsla

fn clone(&self) -> Okhsla

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ColorToComponents for Okhsla

fn to_f32_array(self) -> [f32; 4]

Convert to an f32 array

fn to_f32_array_no_alpha(self) -> [f32; 3]

Convert to an f32 array without the alpha value

fn to_vec4(self) -> Vec4

Convert to a Vec4

fn to_vec3(self) -> Vec3

Convert to a Vec3

fn from_f32_array(color: [f32; 4]) -> Okhsla

Convert from an f32 array

fn from_f32_array_no_alpha(color: [f32; 3]) -> Okhsla

Convert from an f32 array without the alpha value

fn from_vec4(color: Vec4) -> Okhsla

Convert from a Vec4

fn from_vec3(color: Vec3) -> Okhsla

Convert from a Vec3

impl Copy for Okhsla

impl Debug for Okhsla

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

Formats the value using the given formatter.

impl Default for Okhsla

fn default() -> Okhsla

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Okhsla

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Div<f32> for Okhsla

type Output = Okhsla

The resulting type after applying the / operator.

fn div(self, rhs: f32) -> <Okhsla as Div<f32>>::Output

Performs the / operation.

impl DivAssign<f32> for Okhsla

fn div_assign(&mut self, rhs: f32)

Performs the /= operation.

impl From<Color> for Okhsla

fn from(value: Color) -> Okhsla

Converts to this type from the input type.

impl From<Hsla> for Okhsla

fn from(value: Hsla) -> Okhsla

Converts to this type from the input type.

impl From<Hsva> for Okhsla

fn from(value: Hsva) -> Okhsla

Converts to this type from the input type.

impl From<Hwba> for Okhsla

fn from(value: Hwba) -> Okhsla

Converts to this type from the input type.

impl From<Laba> for Okhsla

fn from(value: Laba) -> Okhsla

Converts to this type from the input type.

impl From<Lcha> for Okhsla

fn from(value: Lcha) -> Okhsla

Converts to this type from the input type.

impl From<LinearRgba> for Okhsla

fn from(value: LinearRgba) -> Okhsla

Converts to this type from the input type.

impl From<Okhsla> for Color

fn from(value: Okhsla) -> Color

Converts to this type from the input type.

impl From<Okhsla> for Oklaba

fn from(value: Okhsla) -> Oklaba

Converts to this type from the input type.

impl From<Okhsla> for LinearRgba

fn from(value: Okhsla) -> LinearRgba

Converts to this type from the input type.

impl From<Okhsla> for Hsla

fn from(value: Okhsla) -> Hsla

Converts to this type from the input type.

impl From<Okhsla> for Hsva

fn from(value: Okhsla) -> Hsva

Converts to this type from the input type.

impl From<Okhsla> for Hwba

fn from(value: Okhsla) -> Hwba

Converts to this type from the input type.

impl From<Okhsla> for Lcha

fn from(value: Okhsla) -> Lcha

Converts to this type from the input type.

impl From<Okhsla> for Srgba

fn from(value: Okhsla) -> Srgba

Converts to this type from the input type.

impl From<Okhsla> for Xyza

fn from(value: Okhsla) -> Xyza

Converts to this type from the input type.

impl From<Okhsla> for Laba

fn from(value: Okhsla) -> Laba

Converts to this type from the input type.

impl From<Okhsla> for Oklcha

fn from(value: Okhsla) -> Oklcha

Converts to this type from the input type.

impl From<Okhsla> for Okhsva

fn from(value: Okhsla) -> Okhsva

Converts to this type from the input type.

impl From<Okhsla> for Okhwba

fn from(value: Okhsla) -> Okhwba

Converts to this type from the input type.

impl From<Okhsva> for Okhsla

fn from(value: Okhsva) -> Okhsla

Converts to this type from the input type.

impl From<Okhwba> for Okhsla

fn from(value: Okhwba) -> Okhsla

Converts to this type from the input type.

impl From<Oklaba> for Okhsla

fn from(value: Oklaba) -> Okhsla

Converts to this type from the input type.

impl From<Oklcha> for Okhsla

fn from(value: Oklcha) -> Okhsla

Converts to this type from the input type.

impl From<Srgba> for Okhsla

fn from(value: Srgba) -> Okhsla

Converts to this type from the input type.

impl From<Xyza> for Okhsla

fn from(value: Xyza) -> Okhsla

Converts to this type from the input type.

impl FromReflect for Okhsla

fn from_reflect(reflect: &(dyn PartialReflect + 'static)) -> Option<Okhsla>

Constructs a concrete instance of Self from a reflected value.

fn take_from_reflect( reflect: Box<dyn PartialReflect>, ) -> Result<Self, Box<dyn PartialReflect>>

Attempts to downcast the given value to Self using, constructing the value using from_reflect if that fails.

impl GetTypeRegistration for Okhsla

fn get_type_registration() -> TypeRegistration

Returns the default TypeRegistration for this type.

fn register_type_dependencies(registry: &mut TypeRegistry)

Registers other types needed by this type.

impl Gray for Okhsla

const BLACK: Okhsla

A pure black color.

const WHITE: Okhsla

A pure white color.

fn gray(lightness: f32) -> Self

Returns a grey color with the provided lightness from (0.0 - 1.0). 0 is black, 1 is white.

impl Hue for Okhsla

fn with_hue(&self, hue: f32) -> Okhsla

Return a new version of this color with the hue channel set to the given value.

fn hue(&self) -> f32

Return the hue of this color [0.0, 360.0].

fn set_hue(&mut self, hue: f32)

Sets the hue of this color.

fn rotate_hue(&self, degrees: f32) -> Self

Return a new version of this color with the hue channel rotated by the given degrees.

impl Luminance for Okhsla

fn with_luminance(&self, lightness: f32) -> Okhsla

Return a new version of this color with the given luminance. The result is not clamped, so an out-of-range target is stored as-is.

fn luminance(&self) -> f32

Return the luminance of this color. SDR colors are in [0.0, 1.0]. An HDR color’s luminance can be above or below 1.0.

fn darker(&self, amount: f32) -> Okhsla

Return a darker version of this color. The amount should be between 0.0 and 1.0. The amount represents an absolute decrease in luminance, and is distributive: color.darker(a).darker(b) == color.darker(a + b). Colors are clamped to black if the amount would cause them to go below black.

fn lighter(&self, amount: f32) -> Okhsla

Return a lighter version of this color. The amount should be between 0.0 and 1.0. The amount represents an absolute increase in luminance, and is distributive: color.lighter(a).lighter(b) == color.lighter(a + b). Colors are clamped to white if the amount would cause them to go above white, so this operation is not suitable for HDR colors. To scale an HDR color, use with_luminance.

impl Mix for Okhsla

fn mix(&self, other: &Okhsla, factor: f32) -> Okhsla

Linearly interpolate between this and another color, by factor. Factor should be between 0.0 and 1.0.

fn mix_assign(&mut self, other: Self, factor: f32)

Linearly interpolate between this and another color, by factor, storing the result in this color. Factor should be between 0.0 and 1.0.

impl Mul<f32> for Okhsla

type Output = Okhsla

The resulting type after applying the * operator.

fn mul(self, rhs: f32) -> <Okhsla as Mul<f32>>::Output

Performs the * operation.

impl MulAssign<f32> for Okhsla

fn mul_assign(&mut self, rhs: f32)

Performs the *= operation.

impl Neg for Okhsla

type Output = Okhsla

The resulting type after applying the - operator.

fn neg(self) -> <Okhsla as Neg>::Output

Performs the unary - operation.

impl PartialEq for Okhsla

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

Equality operator ==.

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

Inequality operator !=.

impl PartialReflect for Okhsla

fn get_represented_type_info(&self) -> Option<&'static TypeInfo>

Returns the TypeInfo of the type represented by this value.

fn try_apply( &mut self, value: &(dyn PartialReflect + 'static), ) -> Result<(), ApplyError>

Tries to apply a reflected value to this value.

fn reflect_kind(&self) -> ReflectKind

Returns a zero-sized enumeration of “kinds” of type.

fn reflect_ref(&self) -> ReflectRef<'_>

Returns an immutable enumeration of “kinds” of type.

fn reflect_mut(&mut self) -> ReflectMut<'_>

Returns a mutable enumeration of “kinds” of type.

fn reflect_owned(self: Box<Okhsla>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn try_into_reflect( self: Box<Okhsla>, ) -> Result<Box<dyn Reflect>, Box<dyn PartialReflect>>

Attempts to cast this type to a boxed, fully-reflected value.

fn try_as_reflect(&self) -> Option<&(dyn Reflect + 'static)>

Attempts to cast this type to a fully-reflected value.

fn try_as_reflect_mut(&mut self) -> Option<&mut (dyn Reflect + 'static)>

Attempts to cast this type to a mutable, fully-reflected value.

fn into_partial_reflect(self: Box<Okhsla>) -> Box<dyn PartialReflect>

Casts this type to a boxed, reflected value.

fn as_partial_reflect(&self) -> &(dyn PartialReflect + 'static)

Casts this type to a reflected value.

fn as_partial_reflect_mut(&mut self) -> &mut (dyn PartialReflect + 'static)

Casts this type to a mutable, reflected value.

fn reflect_partial_eq( &self, value: &(dyn PartialReflect + 'static), ) -> Option<bool>

Returns a “partial equality” comparison result.

fn reflect_partial_cmp( &self, value: &(dyn PartialReflect + 'static), ) -> Option<Ordering>

Returns a “partial comparison” result.

fn reflect_clone(&self) -> Result<Box<dyn Reflect>, ReflectCloneError>

Attempts to clone Self using reflection.

fn apply(&mut self, value: &(dyn PartialReflect + 'static))

Applies a reflected value to this value.

fn to_dynamic(&self) -> Result<Box<dyn PartialReflect>, ReflectCloneError>

Converts this reflected value into its dynamic representation based on its kind.

fn reflect_clone_and_take<T>(&self) -> Result<T, ReflectCloneError>

where T: 'static, Self: Sized + TypePath,

For a type implementing PartialReflect, combines reflect_clone and take in a useful fashion, automatically constructing an appropriate ReflectCloneError if the downcast fails.

fn reflect_hash(&self) -> Option<u64>

Returns a hash of the value (which includes the type).

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

Debug formatter for the value.

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl Reflect for Okhsla

fn into_any(self: Box<Okhsla>) -> Box<dyn Any>

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &(dyn Any + 'static)

Returns the value as a &dyn Any.

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Returns the value as a &mut dyn Any.

fn into_reflect(self: Box<Okhsla>) -> Box<dyn Reflect>

Casts this type to a boxed, fully-reflected value.

fn as_reflect(&self) -> &(dyn Reflect + 'static)

Casts this type to a fully-reflected value.

fn as_reflect_mut(&mut self) -> &mut (dyn Reflect + 'static)

Casts this type to a mutable, fully-reflected value.

fn set(&mut self, value: Box<dyn Reflect>) -> Result<(), Box<dyn Reflect>>

Performs a type-checked assignment of a reflected value to this value.

impl Saturation for Okhsla

fn with_saturation(&self, saturation: f32) -> Okhsla

Return a new version of this color with the saturation channel set to the given value.

fn saturation(&self) -> f32

Return the saturation of this color [0.0, 1.0].

fn set_saturation(&mut self, saturation: f32)

Sets the saturation of this color.

impl Serialize for Okhsla

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StableInterpolate for Okhsla

fn interpolate_stable(&self, other: &Okhsla, t: f32) -> Okhsla

Interpolate between this value and the other given value using the parameter t. At t = 0.0, a value equivalent to self is recovered, while t = 1.0 recovers a value equivalent to other, with intermediate values interpolating between the two. See the trait-level documentation for details.

fn interpolate_stable_assign(&mut self, other: &Self, t: f32)

A version of interpolate_stable that assigns the result to self for convenience.

fn smooth_nudge(&mut self, target: &Self, decay_rate: f32, delta: f32)

Smoothly nudge this value towards the target at a given decay rate. The decay_rate parameter controls how fast the distance between self and target decays relative to the units of delta; the intended usage is for decay_rate to generally remain fixed, while delta is something like delta_time from an updating system. This produces a smooth following of the target that is independent of framerate.

impl Struct for Okhsla

fn field(&self, name: &str) -> Option<&(dyn PartialReflect + 'static)>

Gets a reference to the value of the field named name as a &dyn PartialReflect.

fn field_mut( &mut self, name: &str, ) -> Option<&mut (dyn PartialReflect + 'static)>

Gets a mutable reference to the value of the field named name as a &mut dyn PartialReflect.

fn field_at(&self, index: usize) -> Option<&(dyn PartialReflect + 'static)>

Gets a reference to the value of the field with index index as a &dyn PartialReflect.

fn field_at_mut( &mut self, index: usize, ) -> Option<&mut (dyn PartialReflect + 'static)>

Gets a mutable reference to the value of the field with index index as a &mut dyn PartialReflect.

fn name_at(&self, index: usize) -> Option<&str>

Gets the name of the field with index index.

fn index_of_name(&self, name: &str) -> Option<usize>

Gets the index of the field with the given name.

fn field_len(&self) -> usize

Returns the number of fields in the struct.

fn iter_fields(&self) -> FieldIter<'_>

Returns an iterator over the values of the reflectable fields for this struct.

fn to_dynamic_struct(&self) -> Result<DynamicStruct, ReflectCloneError>

Creates a new DynamicStruct from this struct.

fn get_represented_struct_info(&self) -> Option<&'static StructInfo>

Will return None if TypeInfo is not available.

impl StructuralPartialEq for Okhsla

impl Sub for Okhsla

type Output = Okhsla

The resulting type after applying the - operator.

fn sub(self, rhs: Okhsla) -> <Okhsla as Sub>::Output

Performs the - operation.

impl SubAssign for Okhsla

fn sub_assign(&mut self, rhs: Okhsla)

Performs the -= operation.

impl TypePath for Okhsla

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type.

fn short_type_path() -> &'static str

Returns a short, pretty-print enabled path to the type.

fn type_ident() -> Option<&'static str>

Returns the name of the type, or None if it is anonymous.

fn crate_name() -> Option<&'static str>

Returns the name of the crate the type is in, or None if it is anonymous.

fn module_path() -> Option<&'static str>

Returns the path to the module the type is in, or None if it is anonymous.

impl Typed for Okhsla

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl VectorSpace for Okhsla

const ZERO: Okhsla

The zero vector, which is the identity of addition for the vector space type.

type Scalar = f32

The scalar type of this vector space.

fn lerp(self, rhs: Self, t: Self::Scalar) -> Self

Perform vector space linear interpolation between this element and another, based on the parameter t. When t is 0, self is recovered. When t is 1, rhs is recovered.