Struct CssColor

Namespace

HeyBox

Assembly

HeyBox.Net.Core.dll

表示一个 CSS 颜色值，参见 <color> - CSS: Cascading Style Sheets | MDN。

public readonly struct CssColor : IEquatable<CssColor>

Implements

IEquatable<CssColor>

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Properties

Default

获取一个表示默认颜色的 CssColor 实例。

public static CssColor Default { get; }

Property Value

CssColor

Remarks

黑盒语音客户端将使用等同于 CssColor.FromVariable("--brank-fill") 的值。

Transparent

获取一个表示透明颜色的 CssColor 实例。

public static CssColor Transparent { get; }

Property Value

CssColor

Value

获取颜色的字符串值。

public string Value { get; }

Property Value

string

Methods

Equals(CssColor)

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

public bool Equals(CssColor other)

Parameters

other CssColor

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.

FromHex(string)

通过十六进制颜色值创建 CssColor 实例。

public static CssColor FromHex(string hex)

Parameters

hex string

十六进制颜色值（如 #FFF 或 #FFFFFF）。

Returns

CssColor

对应的 CssColor 实例。

Exceptions

ArgumentException

当 hex 格式无效时抛出。

FromHsl(float, float, float)

通过 HSL 值创建 CssColor 实例。

public static CssColor FromHsl(float h, float s, float l)

Parameters

h float

色调（0-360）。

s float

饱和度（0-100）。

l float

亮度（0-100）。

Returns

CssColor

对应的 CssColor 实例。

Exceptions

ArgumentOutOfRangeException

当 h、s 或 l 不在有效范围内时抛出。

FromHsla(float, float, float, float)

通过 HSLA 值创建 CssColor 实例。

public static CssColor FromHsla(float h, float s, float l, float a)

Parameters

h float

色调（0-360）。

s float

饱和度（0-100）。

l float

亮度（0-100）。

a float

透明度（0-1）。

Returns

CssColor

对应的 CssColor 实例。

Exceptions

ArgumentOutOfRangeException

当 h、s、l 或 a 不在有效范围内时抛出。

FromName(string)

通过颜色名称创建 CssColor 实例。

public static CssColor FromName(string name)

Parameters

name string

CSS 颜色名称。

Returns

CssColor

对应的 CssColor 实例。

Exceptions

ArgumentException

当 name 为空或无效时抛出。

FromRgb(byte, byte, byte)

通过 RGB 值创建 CssColor 实例。

public static CssColor FromRgb(byte r, byte g, byte b)

Parameters

r byte

红色分量（0-255）。

g byte

绿色分量（0-255）。

b byte

蓝色分量（0-255）。

Returns

CssColor

对应的 CssColor 实例。

FromRgba(byte, byte, byte, float)

通过 RGBA 值创建 CssColor 实例。

public static CssColor FromRgba(byte r, byte g, byte b, float a)

Parameters

r byte

红色分量（0-255）。

g byte

绿色分量（0-255）。

b byte

蓝色分量（0-255）。

a float

透明度（0-1）。

Returns

CssColor

对应的 CssColor 实例。

Exceptions

ArgumentOutOfRangeException

当 a 不在 0 到 1 范围内时抛出。

FromValue(string)

通过颜色值创建 CssColor 实例。

public static CssColor FromValue(string value)

Parameters

value string

CSS 颜色值字符串。

Returns

CssColor

对应的 CssColor 实例。

FromVariable(string)

通过 CSS 变量名创建 CssColor 实例。

public static CssColor FromVariable(string variableName)

Parameters

variableName string

CSS 变量名（不包含 var() 前缀，例如 --brand-fill）。

Returns

CssColor

对应的 CssColor 实例。

Exceptions

ArgumentException

当 variableName 为空或无效时抛出。

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.

ToString()

获取颜色的字符串值。

public override string ToString()

Returns

string

Operators

operator ==(CssColor, CssColor)

确定两个 CssColor 实例是否相等。

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

Parameters

left CssColor

左侧的 CssColor 实例。

right CssColor

右侧的 CssColor 实例。

Returns

bool

如果相等，则为 true；否则为 false。

operator !=(CssColor, CssColor)

确定两个 CssColor 实例是否不相等。

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

Parameters

left CssColor

左侧的 CssColor 实例。

right CssColor

右侧的 CssColor 实例。

Returns

bool

如果不相等，则为 true；否则为 false。