Struct Hsva

pub struct Hsva {
    pub hue: f32,
    pub saturation: f32,
    pub value: f32,
    pub alpha: f32,
}

Color in Hue-Saturation-Value (HSV) 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]

value: f32

The value channel. [0.0, 1.0]

alpha: f32

The alpha channel. [0.0, 1.0]

Implementations

impl Hsva

pub const fn new(hue: f32, saturation: f32, value: f32, alpha: f32) -> Hsva

Construct a new Hsva color from components.

Arguments

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

pub const fn hsv(hue: f32, saturation: f32, value: f32) -> Hsva

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

Arguments

• hue - Hue channel. [0.0, 360.0]
• saturation - Saturation channel. [0.0, 1.0]
• value - Value channel. [0.0, 1.0]

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

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

pub const fn with_value(self, value: f32) -> Hsva

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

Trait Implementations

impl Alpha for Hsva

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

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 Hsva

fn clone(&self) -> Hsva

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ColorToComponents for Hsva

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

Convert from an f32 array

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

Convert from an f32 array without the alpha value

fn from_vec4(color: Vec4) -> Hsva

Convert from a Vec4

fn from_vec3(color: Vec3) -> Hsva

Convert from a Vec3

impl Debug for Hsva

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

Formats the value using the given formatter.

impl Default for Hsva

fn default() -> Hsva

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Hsva

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Color> for Hsva

fn from(value: Color) -> Hsva

Converts to this type from the input type.

impl From<Hsla> for Hsva

fn from(_: Hsla) -> Hsva

Converts to this type from the input type.

impl From<Hsva> for Color

fn from(value: Hsva) -> Color

Converts to this type from the input type.

impl From<Hsva> for Hsla

fn from(_: Hsva) -> Hsla

Converts to this type from the input type.

impl From<Hsva> for Hwba

fn from(_: Hsva) -> Hwba

Converts to this type from the input type.

impl From<Hsva> for Laba

fn from(value: Hsva) -> Laba

Converts to this type from the input type.

impl From<Hsva> for Lcha

fn from(value: Hsva) -> Lcha

Converts to this type from the input type.

impl From<Hsva> for LinearRgba

fn from(value: Hsva) -> LinearRgba

Converts to this type from the input type.

impl From<Hsva> for Oklaba

fn from(value: Hsva) -> Oklaba

Converts to this type from the input type.

impl From<Hsva> for Oklcha

fn from(value: Hsva) -> Oklcha

Converts to this type from the input type.

impl From<Hsva> for Srgba

fn from(value: Hsva) -> Srgba

Converts to this type from the input type.

impl From<Hsva> for Xyza

fn from(value: Hsva) -> Xyza

Converts to this type from the input type.

impl From<Hwba> for Hsva

fn from(_: Hwba) -> Hsva

Converts to this type from the input type.

impl From<Laba> for Hsva

fn from(value: Laba) -> Hsva

Converts to this type from the input type.

impl From<Lcha> for Hsva

fn from(value: Lcha) -> Hsva

Converts to this type from the input type.

impl From<LinearRgba> for Hsva

fn from(value: LinearRgba) -> Hsva

Converts to this type from the input type.

impl From<Oklaba> for Hsva

fn from(value: Oklaba) -> Hsva

Converts to this type from the input type.

impl From<Oklcha> for Hsva

fn from(value: Oklcha) -> Hsva

Converts to this type from the input type.

impl From<Srgba> for Hsva

fn from(value: Srgba) -> Hsva

Converts to this type from the input type.

impl From<Xyza> for Hsva

fn from(value: Xyza) -> Hsva

Converts to this type from the input type.

impl FromArg for &'static Hsva

where Hsva: Any + Send + Sync, f32: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

type This<'from_arg> = &'from_arg Hsva

The type to convert into.

fn from_arg( arg: Arg<'_>, ) -> Result<<&'static Hsva as FromArg>::This<'_>, ArgError>

Creates an item from an argument.

impl FromArg for &'static mut Hsva

where Hsva: Any + Send + Sync, f32: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

type This<'from_arg> = &'from_arg mut Hsva

The type to convert into.

fn from_arg( arg: Arg<'_>, ) -> Result<<&'static mut Hsva as FromArg>::This<'_>, ArgError>

Creates an item from an argument.

impl FromArg for Hsva

where Hsva: Any + Send + Sync, f32: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

type This<'from_arg> = Hsva

The type to convert into.

fn from_arg(arg: Arg<'_>) -> Result<<Hsva as FromArg>::This<'_>, ArgError>

Creates an item from an argument.

impl FromReflect for Hsva

where Hsva: Any + Send + Sync, f32: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

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

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 GetOwnership for &Hsva

where Hsva: Any + Send + Sync, f32: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn ownership() -> Ownership

Returns the ownership of Self.

impl GetOwnership for &mut Hsva

where Hsva: Any + Send + Sync, f32: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn ownership() -> Ownership

Returns the ownership of Self.

impl GetOwnership for Hsva

where Hsva: Any + Send + Sync, f32: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn ownership() -> Ownership

Returns the ownership of Self.

impl GetTypeRegistration for Hsva

where Hsva: Any + Send + Sync, f32: FromReflect + TypePath + MaybeTyped + 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 Hsva

const BLACK: Hsva

A pure black color.

const WHITE: Hsva

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 Hsva

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

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 IntoReturn for &Hsva

where Hsva: Any + Send + Sync, f32: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn into_return<'into_return>(self) -> Return<'into_return>

where &Hsva: 'into_return,

Converts Self into a Return value.

impl IntoReturn for &mut Hsva

where Hsva: Any + Send + Sync, f32: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn into_return<'into_return>(self) -> Return<'into_return>

where &mut Hsva: 'into_return,

Converts Self into a Return value.

impl IntoReturn for Hsva

where Hsva: Any + Send + Sync, f32: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn into_return<'into_return>(self) -> Return<'into_return>

where Hsva: 'into_return,

Converts Self into a Return value.

impl Mix for Hsva

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

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 Hsva

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialReflect for Hsva

where Hsva: Any + Send + Sync, f32: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

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<Hsva>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn try_into_reflect( self: Box<Hsva>, ) -> 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<Hsva>) -> 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_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 clone_value(&self) -> Box<dyn PartialReflect>

👎Deprecated since 0.16.0: to clone reflected values, prefer using reflect_clone. To convert reflected values to dynamic ones, use to_dynamic.

Clones Self into its dynamic representation.

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

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

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 Hsva

where Hsva: Any + Send + Sync, f32: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn into_any(self: Box<Hsva>) -> 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<Hsva>) -> 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 Hsva

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

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 Hsva

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 Struct for Hsva

where Hsva: Any + Send + Sync, f32: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

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

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

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

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

Returns 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>

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

fn clone_dynamic(&self) -> DynamicStruct

👎Deprecated since 0.16.0: use to_dynamic_struct instead

Clones the struct into a DynamicStruct.

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

Will return None if TypeInfo is not available.

impl TypePath for Hsva

where Hsva: 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 Hsva

where Hsva: Any + Send + Sync, f32: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl Copy for Hsva

impl StructuralPartialEq for Hsva