Struct bevy_color::Hsla

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

Color in Hue-Saturation-Lightness (HSL) color space with alpha. Further information on this color model can be found on Wikipedia.

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 Hsla

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

Construct a new Hsla 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) -> Self

Construct a new Hsla 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) -> Self

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

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

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

pub fn sequential_dispersed(index: u32) -> Self

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 = Hsla::sequential_dispersed(entity_index);

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

Trait Implementations

impl Alpha for Hsla

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

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

fn alpha(&self) -> f32

Return a 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 Hsla

fn clone(&self) -> Hsla

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ColorToComponents for Hsla

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]) -> Self

Convert from an f32 array

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

Convert from an f32 array without the alpha value

fn from_vec4(color: Vec4) -> Self

Convert from a Vec4

fn from_vec3(color: Vec3) -> Self

Convert from a Vec3

impl Debug for Hsla

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

Formats the value using the given formatter.

impl Default for Hsla

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Hsla

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Color> for Hsla

fn from(value: Color) -> Self

Converts to this type from the input type.

impl From<Hsla> for Color

fn from(value: Hsla) -> Self

Converts to this type from the input type.

impl From<Hsla> for Hsva

fn from(_: Hsla) -> Self

Converts to this type from the input type.

impl From<Hsla> for Hwba

fn from(value: Hsla) -> Self

Converts to this type from the input type.

impl From<Hsla> for Laba

fn from(value: Hsla) -> Self

Converts to this type from the input type.

impl From<Hsla> for Lcha

fn from(value: Hsla) -> Self

Converts to this type from the input type.

impl From<Hsla> for LinearRgba

fn from(value: Hsla) -> Self

Converts to this type from the input type.

impl From<Hsla> for Oklaba

fn from(value: Hsla) -> Self

Converts to this type from the input type.

impl From<Hsla> for Oklcha

fn from(value: Hsla) -> Self

Converts to this type from the input type.

impl From<Hsla> for Srgba

fn from(value: Hsla) -> Self

Converts to this type from the input type.

impl From<Hsla> for Xyza

fn from(value: Hsla) -> Self

Converts to this type from the input type.

impl From<Hsva> for Hsla

fn from(_: Hsva) -> Self

Converts to this type from the input type.

impl From<Hwba> for Hsla

fn from(value: Hwba) -> Self

Converts to this type from the input type.

impl From<Laba> for Hsla

fn from(value: Laba) -> Self

Converts to this type from the input type.

impl From<Lcha> for Hsla

fn from(value: Lcha) -> Self

Converts to this type from the input type.

impl From<LinearRgba> for Hsla

fn from(value: LinearRgba) -> Self

Converts to this type from the input type.

impl From<Oklaba> for Hsla

fn from(value: Oklaba) -> Self

Converts to this type from the input type.

impl From<Oklcha> for Hsla

fn from(value: Oklcha) -> Self

Converts to this type from the input type.

impl From<Srgba> for Hsla

fn from(value: Srgba) -> Self

Converts to this type from the input type.

impl From<Xyza> for Hsla

fn from(value: Xyza) -> Self

Converts to this type from the input type.

impl FromReflect for Hsla

where Self: Any + Send + Sync, f32: FromReflect + TypePath + RegisterForReflection,

fn from_reflect(reflect: &dyn Reflect) -> Option<Self>

Constructs a concrete instance of Self from a reflected value.

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

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

impl GetTypeRegistration for Hsla

where Self: Any + Send + Sync, f32: FromReflect + TypePath + RegisterForReflection,

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 Hsla

const BLACK: Self = _

A pure black color.

const WHITE: Self = _

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 Hsla

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

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 Hsla

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

Return a new version of this color with the given luminance. The resulting color will be clamped to the valid range for the color space; for some color spaces, clamping may cause the hue or chroma to change.

fn luminance(&self) -> f32

Return the luminance of this color (0.0 - 1.0).

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

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) -> Self

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.

impl Mix for Hsla

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

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 PartialEq for Hsla

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Reflect for Hsla

where Self: Any + Send + Sync, f32: FromReflect + TypePath + RegisterForReflection,

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

Returns the TypeInfo of the type represented by this value.

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

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &dyn Any

Returns the value as a &dyn Any.

fn as_any_mut(&mut self) -> &mut dyn Any

Returns the value as a &mut dyn Any.

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

Casts this type to a boxed reflected value.

fn as_reflect(&self) -> &dyn Reflect

Casts this type to a reflected value.

fn as_reflect_mut(&mut self) -> &mut dyn Reflect

Casts this type to a mutable reflected value.

fn clone_value(&self) -> Box<dyn Reflect>

Clones the value as a Reflect trait object.

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

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

fn try_apply(&mut self, value: &dyn Reflect) -> 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<Self>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn reflect_partial_eq(&self, value: &dyn Reflect) -> Option<bool>

Returns a “partial equality” comparison result.

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

Applies a reflected value to this value.

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 serializable(&self) -> Option<Serializable<'_>>

Returns a serializable version of the value.

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl Serialize for Hsla

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Struct for Hsla

where Self: Any + Send + Sync, f32: FromReflect + TypePath + RegisterForReflection,

fn field(&self, name: &str) -> Option<&dyn Reflect>

Returns a reference to the value of the field named name as a &dyn Reflect.

fn field_mut(&mut self, name: &str) -> Option<&mut dyn Reflect>

Returns a mutable reference to the value of the field named name as a &mut dyn Reflect.

fn field_at(&self, index: usize) -> Option<&dyn Reflect>

Returns a reference to the value of the field with index index as a &dyn Reflect.

fn field_at_mut(&mut self, index: usize) -> Option<&mut dyn Reflect>

Returns a mutable reference to the value of the field with index index as a &mut dyn Reflect.

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

Returns the name of the field with index index.

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 clone_dynamic(&self) -> DynamicStruct

Clones the struct into a DynamicStruct.

impl TypePath for Hsla

where Self: Any + Send + Sync,

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 Hsla

where Self: Any + Send + Sync, f32: FromReflect + TypePath + RegisterForReflection,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl Copy for Hsla

impl StructuralPartialEq for Hsla