Struct CieLch

Represents the CIE LCh°, cylindrical form of the CIE Lab* 1976 color. https://en.wikipedia.org/wiki/Lab_color_space#Cylindrical_representation:_CIELCh_or_CIEHLC

Implements

IEquatable<CieLch>

Inherited Members

Object.Equals(Object, Object)

Object.GetType()

Object.ReferenceEquals(Object, Object)

Namespace: SixLabors.ImageSharp.ColorSpaces

Assembly: SixLabors.ImageSharp.dll

Syntax

public readonly struct CieLch : IEquatable<CieLch>

Constructors

| Improve this Doc View Source

CieLch(Vector3)

Initializes a new instance of the CieLch struct.

Declaration

public CieLch(Vector3 vector)

Parameters

Type	Name	Description
Vector3	vector	The vector representing the l, c, h components.

Remarks

Uses DefaultWhitePoint as white point.

| Improve this Doc View Source

CieLch(Vector3, CieXyz)

Initializes a new instance of the CieLch struct.

Declaration

public CieLch(Vector3 vector, CieXyz whitePoint)

Parameters

Type	Name	Description
Vector3	vector	The vector representing the l, c, h components.
CieXyz	whitePoint	The reference white point. Illuminants

| Improve this Doc View Source

CieLch(Single, Single, Single)

Initializes a new instance of the CieLch struct.

Declaration

public CieLch(float l, float c, float h)

Parameters

Type	Name	Description
Single	l	The lightness dimension.
Single	c	The chroma, relative saturation.
Single	h	The hue in degrees.

Remarks

Uses DefaultWhitePoint as white point.

| Improve this Doc View Source

CieLch(Single, Single, Single, CieXyz)

Initializes a new instance of the CieLch struct.

Declaration

public CieLch(float l, float c, float h, CieXyz whitePoint)

Parameters

Type	Name	Description
Single	l	The lightness dimension.
Single	c	The chroma, relative saturation.
Single	h	The hue in degrees.
CieXyz	whitePoint	The reference white point. Illuminants

Fields

| Improve this Doc View Source

C

Gets the a chroma component. A value ranging from 0 to 200.

Declaration

public readonly float C

Field Value

Type	Description
Single

| Improve this Doc View Source

DefaultWhitePoint

D50 standard illuminant. Used when reference white is not specified explicitly.

Declaration

public static readonly CieXyz DefaultWhitePoint

Field Value

Type	Description
CieXyz

| Improve this Doc View Source

H

Gets the h° hue component in degrees. A value ranging from 0 to 360.

Declaration

public readonly float H

Field Value

Type	Description
Single

| Improve this Doc View Source

L

Gets the lightness dimension. A value ranging between 0 (black), 100 (diffuse white) or higher (specular white).

Declaration

public readonly float L

Field Value

Type	Description
Single

| Improve this Doc View Source

WhitePoint

Gets the reference white point of this color

Declaration

public readonly CieXyz WhitePoint

Field Value

Type	Description
CieXyz

Methods

| Improve this Doc View Source

Equals(CieLch)

Declaration

public readonly bool Equals(CieLch other)

Parameters

Type	Name	Description
CieLch	other

Returns

Type	Description
Boolean

| Improve this Doc View Source

Equals(Object)

Declaration

public override readonly bool Equals(object obj)

Parameters

Type	Name	Description
Object	obj

Returns

Type	Description
Boolean

Overrides

ValueType.Equals(Object)

| Improve this Doc View Source

GetHashCode()

Declaration

public override readonly int GetHashCode()

Returns

Type	Description
Int32

Overrides

ValueType.GetHashCode()

| Improve this Doc View Source

Saturation()

Computes the saturation of the color (chroma normalized by lightness)

Declaration

public readonly float Saturation()

Returns

Type	Description
Single	The Single

Remarks

A value ranging from 0 to 100.

| Improve this Doc View Source

ToString()

Declaration

public override readonly string ToString()

Returns

Type	Description
String

Overrides

ValueType.ToString()

Operators

| Improve this Doc View Source

Equality(CieLch, CieLch)

Compares two CieLch objects for equality.

Declaration

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

Parameters

Type	Name	Description
CieLch	left	The CieLch on the left side of the operand.
CieLch	right	The CieLch 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(CieLch, CieLch)

Compares two CieLch objects for inequality

Declaration

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

Parameters

Type	Name	Description
CieLch	left	The CieLch on the left side of the operand.
CieLch	right	The CieLch 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

System.IEquatable<T>