Class: Color
一个表示颜色的类,可以使用这个类来初始化颜色
// 默认是白色
const color1 = new Color();
// 16进制颜色
const color2 = new Color('#ff0000');
// RGB
const color3 = new Color('rgb(255, 0, 0)');
const color3 = new Color({ r: 255, g: 255, b: 255 });
const color3 = new Color({ r: 255, g: 255, b: 255, a: 1 });
// css 颜色名称
const color5 = new Color('skyblue');
// HSL
const color6 = new Color('hsl(0, 100%, 50%)');
// HSV
const color6 = new Color({ h: 360, s: 100, v: 100, a: 1 });
// 设置 rgba 值, 支持归一化和非归一化的值
const color7 = new Color(1, 0, 0);
const color7 = new Color(1, 0, 0, 1, true);
Table of contents
Constructors
Properties
Methods
- fromColor
- fromHSL
- fromHSV
- setRGB
- setRGBA
- setAlpha
- toHex
- toHSL
- toHSV
- toObject
- toArray
- toVector
- toVector3
- toString
Constructors
constructor
• new Color(v?
, g?
, b?
, a?
, isNormalized?
): Color
Parameters
Name | Type | Default value | Description |
---|---|---|---|
v | number | AnyColor | 255 | 可以是 rgba 的 r 通道值,也可以是 AnyColor |
g? | number | undefined | g 通道 |
b? | number | undefined | b 通道 |
a | number | 1 | alpha 通道 |
isNormalized | boolean | false | 是否是归一化的数值 |
Returns
Defined in
Properties
r
• r: number
Defined in
g
• g: number
Defined in
b
• b: number
Defined in
a
• a: number
Defined in
Methods
fromColor
▸ fromColor(c
): Color
解析颜色,凡是可以被 colord 解析的都可以使用
Parameters
Name | Type |
---|---|
c | AnyColor |
Returns
Defined in
fromHSL
▸ fromHSL(h
, s
, l
, a?
): Color
解析 hsl 颜色
Parameters
Name | Type | Default value |
---|---|---|
h | any | undefined |
s | any | undefined |
l | any | undefined |
a | number | 1 |
Returns
Defined in
fromHSV
▸ fromHSV(h
, s
, v
, a?
): Color
解析 hsv 颜色
Parameters
Name | Type | Default value |
---|---|---|
h | any | undefined |
s | any | undefined |
v | any | undefined |
a | number | 1 |
Returns
Defined in
setRGB
▸ setRGB(r
, g
, b
): Color
设置 rgb 数值
Parameters
Name | Type | Description |
---|---|---|
r | number | r 值,一般为 0-255 |
g | number | g 值,一般为 0-255 |
b | number | b 值,一般为 0-255 |
Returns
Defined in
setRGBA
▸ setRGBA(r
, g
, b
, a
, isNormalized?
): Color
设置各通道的值
Parameters
Name | Type | Description |
---|---|---|
r | any | red 通道 |
g | any | green 通道 |
b | any | blue 通道 |
a | any | alpha 通道 |
isNormalized? | boolean | 是否已经归一化(一般从颜色字符串解析的都是未归一化的) |
Returns
Defined in
setAlpha
▸ setAlpha(alpha
): Color
设置 alpha 通道
Parameters
Name | Type |
---|---|
alpha | any |
Returns
Defined in
toHex
▸ toHex(): string
输出 16 进制字符串
Returns
string
Defined in
toHSL
▸ toHSL(): HslaColor
输出 hsl 对象
Returns
HslaColor
Defined in
toHSV
▸ toHSV(): HsvaColor
输出 hsv 对象
Returns
HsvaColor
Defined in
toObject
▸ toObject(isNormalized?
): Object
将颜 色转换为对象
Parameters
Name | Type | Default value | Description |
---|---|---|---|
isNormalized | boolean | false | 是否进行归一化,默认采用 0-255 |
Returns
Object
Name | Type |
---|---|
r | number |
g | number |
b | number |
a | number |
Defined in
toArray
▸ toArray(): number
[]
转换为数组(一般已经归一化。可以直接传递给 gl)
Returns
number
[]
Defined in
toVector
▸ toVector(): Vector4
转换为 Vector4
Returns
Defined in
toVector3
▸ toVector3(): Vector3
转换为 Vector3
Returns
Defined in
toString
▸ toString(): string
转换为字符串
Returns
string