Struct Hsv

Represents a HSV (hue, saturation, value) color. Also known as HSB (hue, saturation, brightness).

Implements

IEquatable<Hsv>

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: SixLabors.ImageSharp.ColorSpaces

Assembly: SixLabors.ImageSharp.dll

Syntax

public readonly struct Hsv : IEquatable<Hsv>

Constructors

Hsv(Vector3)

Initializes a new instance of the Hsv struct.

Declaration

public Hsv(Vector3 vector)

Parameters

Type	Name	Description
Vector3	vector	The vector representing the h, s, v components.

Hsv(float, float, float)

Initializes a new instance of the Hsv struct.

Declaration

public Hsv(float h, float s, float v)

Parameters

Type	Name	Description
float	h	The h hue component.
float	s	The s saturation component.
float	v	The v value (brightness) component.

Properties

H

Gets the hue component. A value ranging between 0 and 360.

Declaration

public float H { get; }

Property Value

Type	Description
float

S

Gets the saturation component. A value ranging between 0 and 1.

Declaration

public float S { get; }

Property Value

Type	Description
float

V

Gets the value (brightness) component. A value ranging between 0 and 1.

Declaration

public float V { get; }

Property Value

Type	Description
float

Methods

Equals(Hsv)

Indicates whether the current object is equal to another object of the same type.

Declaration

public bool Equals(Hsv other)

Parameters

Type	Name	Description
Hsv	other	An object to compare with this object.

Returns

Type	Description
bool	true if the current object is equal to the other parameter; otherwise, false.

Equals(object?)

Indicates whether this instance and a specified object are equal.

Declaration

public override bool Equals(object? obj)

Parameters

Type	Name	Description
object	obj	The object to compare with the current instance.

Returns

Type	Description
bool	true if obj and this instance are the same type and represent the same value; otherwise, false.

Overrides

ValueType.Equals(object)

GetHashCode()

Returns the hash code for this instance.

Declaration

public override int GetHashCode()

Returns

Type	Description
int	A 32-bit signed integer that is the hash code for this instance.

Overrides

ValueType.GetHashCode()

ToString()

Returns the fully qualified type name of this instance.

Declaration

public override string ToString()

Returns

Type	Description
string	The fully qualified type name.

Overrides

ValueType.ToString()

Operators

operator ==(Hsv, Hsv)

Compares two Hsv objects for equality.

Declaration

public static bool operator ==(Hsv left, Hsv right)

Parameters

Type	Name	Description
Hsv	left	The Hsv on the left side of the operand.
Hsv	right	The Hsv on the right side of the operand.

Returns

Type	Description
bool	True if the current left is equal to the right parameter; otherwise, false.

operator !=(Hsv, Hsv)

Compares two Hsv objects for inequality.

Declaration

public static bool operator !=(Hsv left, Hsv right)

Parameters

Type	Name	Description
Hsv	left	The Hsv on the left side of the operand.
Hsv	right	The Hsv on the right side of the operand.

Returns

Type	Description
bool	True if the current left is unequal to the right parameter; otherwise, false.

Implements

IEquatable<T>