/ fm / liveswitch / Color

Class: Color

fm.liveswitch.Color

A color.

Table of contents

Constructors

• constructor

Methods

• fmliveswitchColorInit
• getB
• getG
• getR
• getTypeString
• fromHsb
• getBlack
• getBlue
• getCyan
• getDarkBlue
• getDarkGreen
• getDarkRed
• getGray
• getGreen
• getMagenta
• getOlive
• getPurple
• getRed
• getTeal
• getWhite
• getYellow

Constructors

constructor

+ new Color(r: number, g: number, b: number): Color

Initializes a new instance of the [[fm.liveswitch.color]] class.

Parameters:

Name	Type	Description
r	number	The red value (0-255).
g	number	The green value (0-255).
b	number	The blue value (0-255).

Returns: Color

Methods

fmliveswitchColorInit

▸ PrivatefmliveswitchColorInit(): void

Returns: void

---

getB

▸ getB(): number

Gets the blue value (0-255).

Returns: number

---

getG

▸ getG(): number

Gets the green value (0-255).

Returns: number

---

getR

▸ getR(): number

Gets the red value (0-255).

Returns: number

---

getTypeString

▸ getTypeString(): string

Returns: string

---

fromHsb

▸ StaticfromHsb(hue: number, saturation: number, brightness: number): Color

Creates a [[fm.liveswitch.color]] using hue, saturation, and brightness.

Parameters:

Name	Type	Description
hue	number	The hue value (0-359).
saturation	number	The saturation value (0.0-1.0).
brightness	number	The brightness value (0.0-1.0).

Returns: Color

---

getBlack

▸ StaticgetBlack(): Color

Gets a black color.

Returns: Color

---

getBlue

▸ StaticgetBlue(): Color

Gets a blue color.

Returns: Color

---

getCyan

▸ StaticgetCyan(): Color

Gets a cyan color.

Returns: Color

---

getDarkBlue

▸ StaticgetDarkBlue(): Color

Gets a dark-blue color.

Returns: Color

---

getDarkGreen

▸ StaticgetDarkGreen(): Color

Gets a dark-green color.

Returns: Color

---

getDarkRed

▸ StaticgetDarkRed(): Color

Gets a dark-red color.

Returns: Color

---

getGray

▸ StaticgetGray(): Color

Gets a gray color.

Returns: Color

---

getGreen

▸ StaticgetGreen(): Color

Gets a green color.

Returns: Color

---

getMagenta

▸ StaticgetMagenta(): Color

Gets a magenta color.

Returns: Color

---

getOlive

▸ StaticgetOlive(): Color

Gets an olive color.

Returns: Color

---

getPurple

▸ StaticgetPurple(): Color

Gets a purple color.

Returns: Color

---

getRed

▸ StaticgetRed(): Color

Gets a red color.

Returns: Color

---

getTeal

▸ StaticgetTeal(): Color

Gets a teal color.

Returns: Color

---

getWhite

▸ StaticgetWhite(): Color

Gets a white color.

Returns: Color

---

getYellow

▸ StaticgetYellow(): Color

Gets a yellow color.

Returns: Color