UIColor Struct

public struct UIColor : IEquatable<UIColor>

public double Alpha { readonly get; set; }

Property Value

double:

The alpha component of the color.

Remarks

0.0 is fully transparent and 1.0 is fully opaque.

public double HslHue { readonly get; set; }

Property Value

double:

The HSL hue component of the color.

Remarks

0/360 degrees is red. 60 degrees is yellow. 120 degrees is green. 180 degrees is cyan. 240 degrees is blue. 300 degrees is magenta.

public double HslLightness { readonly get; set; }

Property Value

double:

The HSL lightness component of the color.

Remarks

0.0 is full black and 1.0 is full white.

public double HslSaturation { readonly get; set; }

Property Value

double:

The HSL saturation component of the color.

Remarks

0.0 is only grayscale (no color hue applied) and 1.0 is full color hue applied.

public double HsvHue { readonly get; set; }

Property Value

double:

The HSV hue component of the color.

Remarks

0/360 degrees is red. 60 degrees is yellow. 120 degrees is green. 180 degrees is cyan. 240 degrees is blue. 300 degrees is magenta.

public double HsvSaturation { readonly get; set; }

Property Value

double:

The HSV saturation component of the color.

Remarks

0.0 is only grayscale (no color hue applied) and 1.0 is full color hue applied.

public double HsvValue { readonly get; set; }

Property Value

double:

The HSV value (brightness) component of the color.

Remarks

0.0 is full black (no light applied) and 1.0 is maximum brightness that allows the full color to show.

public readonly bool IsDark { get; }

Property Value

bool:

true if the color is a dark color; otherwise, false.

See Also

• IsLight

public readonly bool IsLight { get; }

Property Value

bool:

true if the color is a light color; otherwise, false.

See Also

• IsDark

public double OklabAChromaticity { readonly get; set; }

Property Value

double:

The OKLAB A chromaticity component of the color.

public double OklabBChromaticity { readonly get; set; }

Property Value

double:

The OKLAB B chromaticity component of the color.

public double OklabLightness { readonly get; set; }

Property Value

double:

The OKLAB lightness component of the color.

Remarks

0.0 is full black and 1.0 is full white.

public double OklchChroma { readonly get; set; }

Property Value

double:

The OKLCH chroma (saturation) component of the color.

public double OklchHue { readonly get; set; }

Property Value

double:

The OKLCH hue component of the color.

Remarks

Hue angles are slightly different than in other color models. 20 degrees is red. 90 degrees is yellow. 140 degrees is green. 220 degrees is blue. 320 degrees is purple.

public double OklchLightness { readonly get; set; }

Property Value

double:

The OKLCH lightness component of the color.

Remarks

0.0 is full black and 1.0 is full white.

public byte RgbAlpha { readonly get; set; }

Property Value

byte:

The RGB alpha component of the color.

Remarks

0 is fully transparent and 255 is fully opaque.

public byte RgbBlue { readonly get; set; }

Property Value

byte:

The RGB blue component of the color.

Remarks

0 is no blue component and 255 is maximum blue component.

public byte RgbGreen { readonly get; set; }

Property Value

byte:

The RGB green component of the color.

Remarks

0 is no green component and 255 is maximum green component.

public byte RgbRed { readonly get; set; }

Property Value

byte:

The RGB red component of the color.

Remarks

0 is no red component and 255 is maximum red component.

public readonly bool Equals(UIColor other)

Parameter	Type	Description
other	UIColor	An object to compare with this object.

Returns

bool:

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

public override readonly bool Equals(object? obj)

Parameter	Type	Description
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.

public static UIColor FromHsl(HslColor color)

Parameter	Type	Description
color	HslColor	The Avalonia.Media.HslColor to use as a template.

Returns

UIColor:

The UIColor that was created.

public static UIColor FromHsl(double hue, double saturation, double lightness, double alpha = 1)

Parameter	Type	Description
hue	double	The hue component, which is a color wheel degree value in the range 0..360.
saturation	double	The saturation component, which is a percentage value in the range 0.0..1.0.
lightness	double	The lightness component, which is a percentage value in the range 0.0..1.0.
alpha	double	The optional alpha component, which is a percentage value in the range 0.0..1.0. The default value is fully opaque (1.0).

Returns

UIColor:

The UIColor that was created.

public static UIColor FromHsv(HsvColor color)

Parameter	Type	Description
color	HsvColor	The Avalonia.Media.HsvColor to use as a template.

Returns

UIColor:

The UIColor that was created.

public static UIColor FromHsv(double hue, double saturation, double value, double alpha = 1)

Parameter	Type	Description
hue	double	The hue component, which is a color wheel degree value in the range 0..360.
saturation	double	The saturation component, which is a percentage value in the range 0.0..1.0.
value	double	The value (brightness) component, which is a percentage value in the range 0.0..1.0.
alpha	double	The optional alpha component, which is a percentage value in the range 0.0..1.0. The default value is fully opaque (1.0).

Returns

UIColor:

The UIColor that was created.

public static UIColor FromMix(UIColor color1, UIColor color2, double ratio = 0.5, ColorInterpolationMode interpolationMode = ColorInterpolationMode.LinearRgb)

Parameter	Type	Description
color1	UIColor	The first Avalonia.Media.Color to examine.
color2	UIColor	The second Avalonia.Media.Color to examine.
ratio	double	(Optional) A ratio value in the range 0.0..1.0 for how to apply the mix. The default value 0.5 means mix the colors equally. A smaller number closer to 0.0 means use more of color1, while a larger number closer to 1.0 means use more of color2.
interpolationMode	ColorInterpolationMode	(Optional) The interpolation mode to use, which defaults to LinearRgb.

Returns

UIColor:

The UIColor that was created.

public static UIColor FromOklab(double lightness, double a, double b, double alpha = 1)

Parameter	Type	Description
lightness	double	The OKLAB lightness component, which is a percentage value in the range 0.0..1.0.
a	double	The OKLAB A chromaticity component, which is a value in the range -0.4..0.4.
b	double	The OKLAB B chromaticity component, which is a value in the range -0.4..0.4.
alpha	double	The optional alpha component, which is a percentage value in the range 0.0..1.0. The default value is fully opaque (1.0).

Returns

UIColor:

The UIColor that was created.

public static UIColor FromOklch(double lightness, double chroma, double hue, double alpha = 1)

Parameter	Type	Description
lightness	double	The OKLCH lightness component, which is a percentage value in the range 0.0..1.0.
chroma	double	The OKLCH chroma (saturation) component, which is a value in the range 0.0..0.4.
hue	double	The OKLCH hue component, which is a color wheel degree value in the range 0..360.
alpha	double	The optional alpha component, which is a percentage value in the range 0.0..1.0. The default value is fully opaque (1.0).

Returns

UIColor:

The UIColor that was created.

public static UIColor FromRgb(Color color)

Parameter	Type	Description
color	Color	The Avalonia.Media.Color to use as a template.

Returns

UIColor:

The UIColor that was created.

public static UIColor FromRgb(byte red, byte green, byte blue, byte alpha = 255)

Parameter	Type	Description
red	byte	The red component, which is a byte value in the range 0..255.
green	byte	The green component, which is a byte value in the range 0..255.
blue	byte	The blue component, which is a byte value in the range 0..255.
alpha	byte	The optional alpha component, which is a byte value in the range 0..255. The default value is fully opaque (255).

Returns

UIColor:

The UIColor that was created.

public override readonly int GetHashCode()

Returns

int:

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

public static double GetHueFromString(string text)

Parameter	Type	Description
text	string	The text string to examine.

Returns

double:

The hue component value.

public static UIColor Parse(string colorString)

Parameter	Type	Description
colorString	string	The color string to examine.

Returns

UIColor:

The parsed color.

public readonly UIColor ToChromaticAdaptation(UIColor backColor, bool isHighContrast = false)

Parameter	Type	Description
backColor	UIColor	The background color.
isHighContrast	bool	The optional flag for whether in a high-contrast theme. The default value is false.

Returns

UIColor:

A new UIColor instance with the chromatic adaptation applied.

Remarks

Chromatic adaptation is commonly used to adapt a color that was intended for use with light backgrounds to render clearly on dark backgrounds.

public readonly UIColor ToGrayscale()

Returns

UIColor:

A new UIColor instance with the grayscale transformation applied.

public readonly string ToHexString(bool? includeAlpha = null)

Parameter	Type	Description
includeAlpha	bool?	Whether to include the alpha component specification. A null value (the default) indicates to only include alpha when the color is not fully opaque.

Returns

string:

The RGB hexadecimal string representation of the color.

public readonly HslColor ToHsl()

Returns

HslColor:

The Avalonia.Media.HslColor that was created.

public readonly HsvColor ToHsv()

Returns

HsvColor:

The Avalonia.Media.HsvColor that was created.

public readonly Color ToRgb()

Returns

Color:

The Avalonia.Media.Color that was created.

public override readonly string ToString()

Returns

string:

The string representation of this object.

public static bool TryParse(string colorString, out UIColor color)

Parameter	Type	Description
colorString	string	The color string to examine.
color	UIColor	Returns the parsed color.

Returns

bool:

true if the color string was parsed successfully; otherwise, false.

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

Parameter	Type	Description
left	UIColor	The first object to compare.
right	UIColor	The second object to compare.

Returns

bool:

true if the two objects are equal; otherwise, false.

public static implicit operator Color(UIColor color)

Parameter	Type	Description
color	UIColor	the UIColor to examine.

Returns

Color

public static implicit operator HslColor(UIColor color)

Parameter	Type	Description
color	UIColor	the UIColor to examine.

Returns

HslColor

public static implicit operator HsvColor(UIColor color)

Parameter	Type	Description
color	UIColor	the UIColor to examine.

Returns

HsvColor

public static implicit operator UIColor(Color color)

Parameter	Type	Description
color	Color	the Avalonia.Media.Color to examine.

Returns

UIColor

public static implicit operator UIColor(HslColor color)

Parameter	Type	Description
color	HslColor	the Avalonia.Media.HslColor to examine.

Returns

UIColor

public static implicit operator UIColor(HsvColor color)

Parameter	Type	Description
color	HsvColor	the Avalonia.Media.HsvColor to examine.

Returns

UIColor

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

Parameter	Type	Description
left	UIColor	The first object to compare.
right	UIColor	The second object to compare.

Returns

bool:

true if the two objects are not equal; otherwise, false.