Struct Hsl

Represents a Hsl (hue, saturation, lightness) color.

Implements
IEquatable<Hsl>
Namespace: SixLabors.ImageSharp.ColorSpaces
Assembly: SixLabors.ImageSharp.dll
Syntax
public readonly struct Hsl

Constructors

| Improve this Doc View Source

Hsl(Single, Single, Single)

Initializes a new instance of the Hsl struct.

Declaration
public Hsl(float h, float s, float l)
Parameters
Type Name Description
Single h

The h hue component.
Single s

The s saturation component.
Single l

The l value (lightness) component.
| Improve this Doc View Source

Hsl(Vector3)

Initializes a new instance of the Hsl struct.

Declaration
public Hsl(Vector3 vector)
Parameters
Type Name Description
Vector3 vector

The vector representing the h, s, l components.

Properties

| Improve this Doc View Source

H

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

Declaration
public readonly float H { get; }
Property Value
Type Description
Single
| Improve this Doc View Source

L

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

Declaration
public readonly float L { get; }
Property Value
Type Description
Single
| Improve this Doc View Source

S

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

Declaration
public readonly float S { get; }
Property Value
Type Description
Single

Methods

| Improve this Doc View Source

Equals(Hsl)

Declaration
public readonly bool Equals(Hsl other)
Parameters
Type Name Description
Hsl other
Returns
Type Description
Boolean
| Improve this Doc View Source

Equals(Nullable<Object>)

Declaration
public override readonly bool Equals(object? obj)
Parameters
Type Name Description
Nullable<Object> obj
Returns
Type Description
Boolean
| Improve this Doc View Source

GetHashCode()

Declaration
public override readonly int GetHashCode()
Returns
Type Description
Int32
| Improve this Doc View Source

ToString()

Declaration
public override readonly string ToString()
Returns
Type Description
String

Operators

| Improve this Doc View Source

Equality(Hsl, Hsl)

Compares two Hsl objects for equality.

Declaration
public static bool operator ==(Hsl left, Hsl right)
Parameters
Type Name Description
Hsl left

The Hsl on the left side of the operand.
Hsl right

The Hsl on the right side of the operand.
Returns
Type Description
Boolean

True if the current left is equal to the right parameter; otherwise, false.
| Improve this Doc View Source

Inequality(Hsl, Hsl)

Compares two Hsl objects for inequality.

Declaration
public static bool operator !=(Hsl left, Hsl right)
Parameters
Type Name Description
Hsl left

The Hsl on the left side of the operand.
Hsl right

The Hsl on the right side of the operand.
Returns
Type Description
Boolean

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

Implements

IEquatable<>