Class HueSaturationLightness

The Hue, Saturation, and Lightness (HSL) model

Inheritance

object

HueSaturationLightness

Namespace: Terminaux.Colors.Models

Assembly: Terminaux.dll

Syntax

public class HueSaturationLightness : BaseColorModel

Properties

| Edit this page View Source

Hue

The position on the color wheel, known as the Hue [0.0 -> 1.0, 0.5 being 180 degrees]

Declaration

public double Hue { get; }

Property Value

Type	Description
double

| Edit this page View Source

HueWhole

The position on the color wheel, known as the Hue [0 -> 360]

Declaration

public int HueWhole { get; }

Property Value

Type	Description
int

| Edit this page View Source

Lightness

The lightness of the color, indicating how light the color is [0.0 -> 1.0]

Declaration

public double Lightness { get; }

Property Value

Type	Description
double

| Edit this page View Source

LightnessWhole

The lightness of the color, indicating how light the color is [0 -> 100]

Declaration

public int LightnessWhole { get; }

Property Value

Type	Description
int

| Edit this page View Source

ReverseHue

The reverse hue position on the color wheel, known as the Reverse Hue [0.0 -> 1.0, 0.5 being 180 degrees]

Declaration

public double ReverseHue { get; }

Property Value

Type	Description
double

| Edit this page View Source

ReverseHueWhole

The reverse hue position on the color wheel, known as the Reverse Hue [0 -> 360]

Declaration

public double ReverseHueWhole { get; }

Property Value

Type	Description
double

| Edit this page View Source

Saturation

The saturation of the color, indicating how intense the color is [0.0 -> 1.0]

Declaration

public double Saturation { get; }

Property Value

Type	Description
double

| Edit this page View Source

SaturationWhole

The saturation of the color, indicating how intense the color is [0 -> 100]

Declaration

public int SaturationWhole { get; }

Property Value

Type	Description
int

Methods

| Edit this page View Source

Equals(object)

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
object	obj

Returns

Type	Description
bool

Overrides

object.Equals(object)

| Edit this page View Source

Equals(HueSaturationLightness)

Declaration

public bool Equals(HueSaturationLightness other)

Parameters

Type	Name	Description
HueSaturationLightness	other

Returns

Type	Description
bool

| Edit this page View Source

GetHashCode()

Declaration

public override int GetHashCode()

Returns

Type	Description
int

Overrides

object.GetHashCode()

| Edit this page View Source

IsSpecifierAndValueValid(string)

Does the string specifier represent a valid HSL specifier?

Declaration

public static bool IsSpecifierAndValueValid(string specifier)

Parameters

Type	Name	Description
string	specifier	Specifier that represents a valid HSL specifier

Returns

Type	Description
bool	True if the specifier is valid; false otherwise.

| Edit this page View Source

IsSpecifierValid(string, bool)

Does the string specifier represent a valid HSL specifier?

Declaration

public static bool IsSpecifierValid(string specifier, bool checkParts = false)

Parameters

Type	Name	Description
string	specifier	Specifier that represents a valid HSL specifier
bool	checkParts	Whether to check the parts count or not

Returns

Type	Description
bool	True if the specifier is valid; false otherwise.

| Edit this page View Source

ParseSpecifier(string)

Parses the specifier and returns an instance of HueSaturationLightness

Declaration

public static HueSaturationLightness ParseSpecifier(string specifier)

Parameters

Type	Name	Description
string	specifier	Specifier of HSL

Returns

Type	Description
HueSaturationLightness	An instance of HueSaturationLightness

Exceptions

Type	Condition
TerminauxException

| Edit this page View Source

ParseSpecifierToRgb(string, ColorSettings?)

Parses the specifier and returns an instance of HueSaturationLightness converted to RedGreenBlue

Declaration

public static RedGreenBlue ParseSpecifierToRgb(string specifier, ColorSettings? settings = null)

Parameters

Type	Name	Description
string	specifier	Specifier of HSL
ColorSettings	settings	Settings to use. Use null for global settings

Returns

Type	Description
RedGreenBlue	An instance of RedGreenBlue

Exceptions

Type	Condition
TerminauxException

| Edit this page View Source

ToString()

hsl:<H>;<S>;<L>

Declaration

public override string ToString()

Returns

Type	Description
string

Overrides

object.ToString()

Operators

| Edit this page View Source

operator ==(HueSaturationLightness, HueSaturationLightness)

Declaration

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

Parameters

Type	Name	Description
HueSaturationLightness	left
HueSaturationLightness	right

Returns

Type	Description
bool

| Edit this page View Source

operator !=(HueSaturationLightness, HueSaturationLightness)

Declaration

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

Parameters

Type	Name	Description
HueSaturationLightness	left
HueSaturationLightness	right

Returns

Type	Description
bool