Struct HsvColor

Namespace

Egami.Colors

Assembly

Egami.dll

An HSV (HSB) color: hue, saturation and value of encoded sRGB, as color pickers use them.

public readonly record struct HsvColor : IColorValue<HsvColor>, IEquatable<HsvColor>

Implements

IColorValue<HsvColor>

IEquatable<HsvColor>

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Examples

// Color values in the models apps ask for, from and to pixels, and between each other.
Rgba8 orange = new(240, 128, 32, 255);
HslColor hsl = HslColor.From(orange);                          // hue 28°, saturation 0.87, lightness 0.53
LabColor lab = ColorConvert.Convert<HslColor, LabColor>(hsl);  // through XYZ
OklchColor oklch = OklchColor.From(orange);
YCbCrColor jpeg = YCbCrColor.From(orange);                     // BT.601 full range, as JPEG
YCbCrColor video = YCbCrColor.From(orange, YuvMatrix.Bt709, YuvRange.Limited);

// Color difference: CIEDE2000 on Lab, distance on Oklab.
double deltaE = lab.DeltaE2000(LabColor.From(new Rgba8(235, 130, 40, 255)));

// Whole rows at once, from any pixel type and encoding.
Rgba8[] pixels = [orange, new(10, 20, 30, 255)];
OklabColor[] row = new OklabColor[pixels.Length];
ColorConvert.FromPixels<Rgba8, OklabColor>(pixels, row);
ColorConvert.FromPixels<Rgba8, OklabColor>(pixels, row, ColorProfile.DisplayP3);   // the same pixels read as Display P3

Constructors

HsvColor(float, float, float)

An HSV (HSB) color: hue, saturation and value of encoded sRGB, as color pickers use them.

public HsvColor(float H, float S, float V)

Parameters

H float

Hue in degrees, 0 to 360; 0 for grays.

S float

Saturation, 0 to 1.

V float

Value (brightness), 0 to 1.

Examples

// Color values in the models apps ask for, from and to pixels, and between each other.
Rgba8 orange = new(240, 128, 32, 255);
HslColor hsl = HslColor.From(orange);                          // hue 28°, saturation 0.87, lightness 0.53
LabColor lab = ColorConvert.Convert<HslColor, LabColor>(hsl);  // through XYZ
OklchColor oklch = OklchColor.From(orange);
YCbCrColor jpeg = YCbCrColor.From(orange);                     // BT.601 full range, as JPEG
YCbCrColor video = YCbCrColor.From(orange, YuvMatrix.Bt709, YuvRange.Limited);

// Color difference: CIEDE2000 on Lab, distance on Oklab.
double deltaE = lab.DeltaE2000(LabColor.From(new Rgba8(235, 130, 40, 255)));

// Whole rows at once, from any pixel type and encoding.
Rgba8[] pixels = [orange, new(10, 20, 30, 255)];
OklabColor[] row = new OklabColor[pixels.Length];
ColorConvert.FromPixels<Rgba8, OklabColor>(pixels, row);
ColorConvert.FromPixels<Rgba8, OklabColor>(pixels, row, ColorProfile.DisplayP3);   // the same pixels read as Display P3

Properties

H

Hue in degrees, 0 to 360; 0 for grays.

public float H { get; init; }

Property Value

float

S

Saturation, 0 to 1.

public float S { get; init; }

Property Value

float

V

Value (brightness), 0 to 1.

public float V { get; init; }

Property Value

float

Methods

From(Rgba8)

Returns the value of an sRGB pixel; alpha is ignored.

public static HsvColor From(Rgba8 color)

Parameters

color Rgba8

The pixel.

Returns

HsvColor

The value.

From(RgbaF32)

Returns the value of an sRGB pixel, whose channels may be outside 0..1; alpha is ignored.

public static HsvColor From(RgbaF32 color)

Parameters

color RgbaF32

The pixel.

Returns

HsvColor

The value.

FromXyz(XyzColor)

Returns the value for an XYZ color (D65, white Y = 1).

public static HsvColor FromXyz(XyzColor xyz)

Parameters

xyz XyzColor

The color.

Returns

HsvColor

The value; components may fall outside their usual range for colors outside sRGB.

IsCloseTo(HsvColor, float)

Returns whether every component of the two values differs by at most tolerance.

public bool IsCloseTo(HsvColor other, float tolerance = 0.0001)

Parameters

other HsvColor

The other value.

tolerance float

The largest difference allowed in a component.

Returns

bool

true if they are that close.

ToRgba8()

Returns the color as an opaque sRGB pixel, each channel clamped into range.

public Rgba8 ToRgba8()

Returns

Rgba8

The pixel.

ToRgbaF32()

Returns the color as an opaque sRGB pixel, unclamped, so colors outside sRGB keep channels outside 0..1.

public RgbaF32 ToRgbaF32()

Returns

RgbaF32

The pixel.

ToXyz()

Returns the color as XYZ (D65, white Y = 1).

public XyzColor ToXyz()

Returns

XyzColor

The color.