@kismet.ts/core / Exports / KismetColor

Class: KismetColor

Table of contents

Constructors

• constructor

Properties

• A
• B
• G
• MAX_COLOR_VALUE
• MIN_COLOR_VALUE
• R

Methods

• _validateNumber
• _validateOptions
• setColor
• setColors
• setHexColor
• toString
• hexToRgba

Constructors

constructor

• new KismetColor(options?)

Parameters

Name	Type
options?	Object
options.A	number
options.B	number
options.G	number
options.R	number

Defined in

util/Color.ts:11

Properties

A

• A: number

Defined in

util/Color.ts:9

---

B

• B: number

Defined in

util/Color.ts:8

---

G

• G: number

Defined in

util/Color.ts:7

---

MAX_COLOR_VALUE

• MAX_COLOR_VALUE: number

Defined in

util/Color.ts:5

---

MIN_COLOR_VALUE

• MIN_COLOR_VALUE: number

Defined in

util/Color.ts:4

---

R

• R: number

Defined in

util/Color.ts:6

Methods

_validateNumber

▸ Private _validateNumber(value): void

Parameters

Name	Type
value	number

Returns

void

Defined in

util/Color.ts:23

---

_validateOptions

▸ Private _validateOptions(options): void

Parameters

Name	Type
options	Record<string, number>

Returns

void

Defined in

util/Color.ts:38

---

setColor

▸ setColor(type, value): KismetColor

Parameters

Name	Type
type	"R" | "G" | "B" | "A"
value	number

Returns

KismetColor

Defined in

util/Color.ts:62

---

setColors

▸ setColors(colors): KismetColor

Parameters

Name	Type
colors	[number, number, number, number]

Returns

KismetColor

Defined in

util/Color.ts:72

---

setHexColor

▸ setHexColor(hexColor, alpha?): KismetColor

Parameters

Name	Type	Default value
hexColor	`#${string}`	undefined
alpha	number	1

Returns

KismetColor

Defined in

util/Color.ts:84

---

toString

▸ toString(): string

Returns

string

Defined in

util/Color.ts:90

---

hexToRgba

▸ Static hexToRgba(hex, alpha?): [number, number, number, number]

Parameters

Name	Type	Default value
hex	`#${string}`	undefined
alpha	number	1

Returns

[number, number, number, number]

Defined in

util/Color.ts:46