Struct Okhsva 

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

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

Okhsv is defined relative to the sRGB (Rec. 709) gamut. Converting a wide-gamut or HDR color can push saturation and value 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]

value: f32

The value channel. [0.0, 1.0]

alpha: f32

The alpha channel. [0.0, 1.0]

Implementations

impl Okhsva

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

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

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

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

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

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

Trait Implementations

impl Alpha for Okhsva

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

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 Okhsva

fn clone(&self) -> Okhsva

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ColorToComponents for Okhsva

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 Copy for Okhsva

impl Debug for Okhsva

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

Formats the value using the given formatter.

impl Default for Okhsva

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Okhsva

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 Okhsva

fn from(value: Color) -> Self

Converts to this type from the input type.

impl From<Hsla> for Okhsva

fn from(value: Hsla) -> Self

Converts to this type from the input type.

impl From<Hsva> for Okhsva

fn from(value: Hsva) -> Self

Converts to this type from the input type.

impl From<Hwba> for Okhsva

fn from(value: Hwba) -> Self

Converts to this type from the input type.

impl From<Laba> for Okhsva

fn from(value: Laba) -> Self

Converts to this type from the input type.

impl From<Lcha> for Okhsva

fn from(value: Lcha) -> Self

Converts to this type from the input type.

impl From<LinearRgba> for Okhsva

fn from(value: LinearRgba) -> Self

Converts to this type from the input type.

impl From<Okhsla> for Okhsva

fn from(value: Okhsla) -> Self

Converts to this type from the input type.

impl From<Okhsva> for Color

fn from(value: Okhsva) -> Self

Converts to this type from the input type.

impl From<Okhsva> for Oklaba

fn from(value: Okhsva) -> Self

Converts to this type from the input type.

impl From<Okhsva> for LinearRgba

fn from(value: Okhsva) -> Self

Converts to this type from the input type.

impl From<Okhsva> for Srgba

fn from(value: Okhsva) -> Self

Converts to this type from the input type.

impl From<Okhsva> for Hwba

fn from(value: Okhsva) -> Self

Converts to this type from the input type.

impl From<Okhsva> for Lcha

fn from(value: Okhsva) -> Self

Converts to this type from the input type.

impl From<Okhsva> for Xyza

fn from(value: Okhsva) -> Self

Converts to this type from the input type.

impl From<Okhsva> for Okhsla

fn from(value: Okhsva) -> Self

Converts to this type from the input type.

impl From<Okhsva> for Hsla

fn from(value: Okhsva) -> Self

Converts to this type from the input type.

impl From<Okhsva> for Hsva

fn from(value: Okhsva) -> Self

Converts to this type from the input type.

impl From<Okhsva> for Laba

fn from(value: Okhsva) -> Self

Converts to this type from the input type.

impl From<Okhsva> for Oklcha

fn from(value: Okhsva) -> Self

Converts to this type from the input type.

impl From<Okhsva> for Okhwba

fn from(_: Okhsva) -> Self

Converts to this type from the input type.

impl From<Okhwba> for Okhsva

fn from(_: Okhwba) -> Self

Converts to this type from the input type.

impl From<Oklaba> for Okhsva

fn from(value: Oklaba) -> Self

Converts to this type from the input type.

impl From<Oklcha> for Okhsva

fn from(value: Oklcha) -> Self

Converts to this type from the input type.

impl From<Srgba> for Okhsva

fn from(value: Srgba) -> Self

Converts to this type from the input type.

impl From<Xyza> for Okhsva

fn from(value: Xyza) -> Self

Converts to this type from the input type.

impl FromReflect for Okhsva

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

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 Okhsva

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 Okhsva

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 Okhsva

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 Mix for Okhsva

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 Okhsva

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

Equality operator ==.

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

Inequality operator !=.

impl PartialReflect for Okhsva

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) -> 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 try_into_reflect( self: Box<Self>, ) -> 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>

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

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

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

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

Casts this type to a boxed, reflected value.

fn as_partial_reflect(&self) -> &dyn PartialReflect

Casts this type to a reflected value.

fn as_partial_reflect_mut(&mut self) -> &mut dyn PartialReflect

Casts this type to a mutable, reflected value.

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

Returns a “partial equality” comparison result.

fn reflect_partial_cmp(&self, value: &dyn PartialReflect) -> 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 Okhsva

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, fully-reflected value.

fn as_reflect(&self) -> &dyn Reflect

Casts this type to a fully-reflected value.

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

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 Okhsva

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

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 Okhsva

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 Okhsva

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

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>

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>

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>

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 Okhsva

impl TypePath for Okhsva

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 Okhsva

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.