Struct Hsl

Namespace

SixLabors.ImageSharp.ColorProfiles

Assembly

SixLabors.ImageSharp.dll

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

public readonly struct Hsl : IColorProfile<Hsl, Rgb>, IColorProfile<Hsl>, IColorProfile, IEquatable<Hsl>

Implements

IColorProfile<Hsl, Rgb>

IColorProfile<Hsl>

IColorProfile

IEquatable<Hsl>

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

Hsl(Vector3)

Initializes a new instance of the Hsl struct.

public Hsl(Vector3 vector)

Parameters

vector Vector3

The vector representing the h, s, l components.

Hsl(float, float, float)

Initializes a new instance of the Hsl struct.

public Hsl(float h, float s, float l)

Parameters

h float

The h hue component.

s float

The s saturation component.

l float

The l value (lightness) component.

Properties

H

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

public float H { get; }

Property Value

float

L

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

public float L { get; }

Property Value

float

S

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

public float S { get; }

Property Value

float

Methods

Equals(Hsl)

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

public bool Equals(Hsl other)

Parameters

other Hsl

An object to compare with this object.

Returns

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.

public override bool Equals(object? obj)

Parameters

obj object

The object to compare with the current instance.

Returns

bool

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

FromProfileConnectingSpace(ColorConversionOptions, in Rgb)

Initializes the color instance from the profile connection space.

public static Hsl FromProfileConnectingSpace(ColorConversionOptions options, in Rgb source)

Parameters

options ColorConversionOptions

The color profile conversion options.

source Rgb

The color profile connecting space.

Returns

Hsl

The Hsl.

FromProfileConnectionSpace(ColorConversionOptions, ReadOnlySpan<Rgb>, Span<Hsl>)

Converts the span of colors from the profile connection space.

public static void FromProfileConnectionSpace(ColorConversionOptions options, ReadOnlySpan<Rgb> source, Span<Hsl> destination)

Parameters

options ColorConversionOptions

The color profile conversion options.

source ReadOnlySpan<Rgb>

The color profile span to convert from.

destination Span<Hsl>

The color span to write the results to.

FromScaledVector4(Vector4)

Initializes the color instance from a generic a generic ("scaled") Vector4 representation with values scaled and clamped between 0 and 1.

public static Hsl FromScaledVector4(Vector4 source)

Parameters

source Vector4

The vector to load the pixel from.

Returns

Hsl

The Hsl.

FromScaledVector4(ReadOnlySpan<Vector4>, Span<Hsl>)

Converts the span of colors from a generic ("scaled") Vector4 representation with values scaled and clamped between 0 and 1.

public static void FromScaledVector4(ReadOnlySpan<Vector4> source, Span<Hsl> destination)

Parameters

source ReadOnlySpan<Vector4>

The vector span to convert from.

destination Span<Hsl>

The color span to write the results to.

GetChromaticAdaptionWhitePointSource()

Gets the chromatic adaption white point source.

public static ChromaticAdaptionWhitePointSource GetChromaticAdaptionWhitePointSource()

Returns

ChromaticAdaptionWhitePointSource

The ChromaticAdaptionWhitePointSource.

GetHashCode()

Returns the hash code for this instance.

public override int GetHashCode()

Returns

int

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

ToProfileConnectingSpace(ColorConversionOptions)

Converts the color to the profile connection space.

public Rgb ToProfileConnectingSpace(ColorConversionOptions options)

Parameters

options ColorConversionOptions

The color profile conversion options.

Returns

Rgb

The Rgb.

ToProfileConnectionSpace(ColorConversionOptions, ReadOnlySpan<Hsl>, Span<Rgb>)

Converts the span of colors to the profile connection space.

public static void ToProfileConnectionSpace(ColorConversionOptions options, ReadOnlySpan<Hsl> source, Span<Rgb> destination)

Parameters

options ColorConversionOptions

The color profile conversion options.

source ReadOnlySpan<Hsl>

The color span to convert from.

destination Span<Rgb>

The color profile span to write the results to.

ToScaledVector4()

Expands the pixel into a generic ("scaled") Vector4 representation with values scaled and clamped between 0 and 1. The vector components are typically expanded in least to greatest significance order.

public Vector4 ToScaledVector4()

Returns

Vector4

The Vector4.

ToScaledVector4(ReadOnlySpan<Hsl>, Span<Vector4>)

Converts the span of colors to a generic ("scaled") Vector4 representation with values scaled and clamped between 0 and 1.

public static void ToScaledVector4(ReadOnlySpan<Hsl> source, Span<Vector4> destination)

Parameters

source ReadOnlySpan<Hsl>

The color span to convert from.

destination Span<Vector4>

The vector span to write the results to.

ToString()

Returns the fully qualified type name of this instance.

public override string ToString()

Returns

string

The fully qualified type name.

Operators

operator ==(Hsl, Hsl)

Compares two Hsl objects for equality.

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

Parameters

left Hsl

The Hsl on the left side of the operand.

right Hsl

The Hsl on the right side of the operand.

Returns

bool

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

operator !=(Hsl, Hsl)

Compares two Hsl objects for inequality.

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

Parameters

left Hsl

The Hsl on the left side of the operand.

right Hsl

The Hsl on the right side of the operand.

Returns

bool

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