Struct HsvColor 

pub struct HsvColor {
    pub a: f64,
    pub h: f64,
    pub s: f64,
    pub v: f64,
}

Defines a color using the hue/saturation/value (HSV) model. This uses a cylindrical-coordinate representation of a color.

Fields

a: f64

The Alpha (transparency) component in the range from 0..1 (percentage). 0 is fully transparent, 1 is fully opaque.

h: f64

The Hue component in the range from 0..360 (degrees). This is the color’s location, in degrees, on a color wheel/circle from 0 to 360. Note that 360 is equivalent to 0 and will be adjusted automatically.

s: f64

The Saturation component in the range from 0..1 (percentage). 0 is a shade of gray (no color) and 1 is the full color.

v: f64

The Value component in the range from 0..1 (percentage). 0 is fully black and 1 is the brightest.

Implementations

impl HsvColor

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

Initializes a new instance of the HsvColor struct. Components are clamped to their ranges and a hue of 360 becomes 0.

pub fn new_with_clamp( alpha: f64, hue: f64, saturation: f64, value: f64, clamp_values: bool, ) -> Self

Initializes a new instance of the HsvColor struct.

This constructor exists only for internal use where performance is critical. Whether or not the channel values are in the correct range must be known: when clamp_values is false the components are stored as given.

pub fn from_color(color: Color) -> Self

Initializes a new instance of the HsvColor struct from an RGB color.

pub fn equals(&self, other: HsvColor) -> bool

pub fn to_rgb(&self) -> Color

Returns the RGB color model equivalent of this HSV color.

pub fn to_hsl(&self) -> HslColor

Returns the HSL color model equivalent of this HSV color.

pub fn to_string_format( &self, format: Option<&str>, format_provider: Option<&CultureInfo>, ) -> Result<String, FormatError>

Returns the string representation of the color using a format specifier.

Supported format specifiers:

• V / v: hsva(h, s%, v%, a) / hsv(h, s%, v%)
• V% / v%: hsva(h%, s%, v%, a%) / hsv(h%, s%, v%)
• X, x, H, R, r, R%, r%: converted to RGB and formatted as such
• L, l, L%, l%: converted to HSL and formatted as such

A null or empty format is the same as to_string(). Any other format is an error. format_provider is ignored: color formatting is culture-invariant.

pub fn parse(s: &str) -> Result<HsvColor, FormatError>

Parses an HSV color string (hsv(h, s, v) or hsva(h, s, v, a)).

pub fn try_parse(s: &str) -> Option<HsvColor>

Parses an HSV color string (hsv(h, s, v) or hsva(h, s, v, a)), returning None when it is not valid. Saturation, value and alpha may be given as fractions or percentages.

pub fn from_ahsv(a: f64, h: f64, s: f64, v: f64) -> HsvColor

Creates an HsvColor from alpha, hue, saturation and value (clamped).

pub fn from_hsv(h: f64, s: f64, v: f64) -> HsvColor

Creates an opaque HsvColor from hue, saturation and value (clamped).

pub fn hsv_to_rgb(hue: f64, saturation: f64, value: f64, alpha: f64) -> Color

Converts the given HSVA color component values to their RGB color equivalent.

The hue is wrapped into [0, 360); the other components are clamped to 0..1.

pub fn hsv_to_hsl(hue: f64, saturation: f64, value: f64, alpha: f64) -> HslColor

Converts the given HSVA color component values to their HSL color equivalent.

Trait Implementations

impl Clone for HsvColor

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for HsvColor

impl Debug for HsvColor

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

Formats the value using the given formatter.

impl Default for HsvColor

fn default() -> Self

Returns the “default value” for a type.

impl Display for HsvColor

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

Formats the value using the given formatter.

impl From<HsvColor> for Color

Converts the HSV color to RGB (an explicit conversion in the reference API).

fn from(hsv_color: HsvColor) -> Color

Converts to this type from the input type.

impl FromStr for HsvColor

type Err = FormatError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, FormatError>

Parses a string s to return a value of this type.

impl MarkupTyped for HsvColor

const MARKUP: &'static MarkupType

The markup metadata of the type.

impl PartialEq for HsvColor

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for HsvColor