_structs_light_.light.md

@ericrabil/phea.js

Globals / "structs/light" / Light

Class: Light

Manages the state of a specific light. Mutations here will be directly visible on your lights as long as they aren't overwritten by an effect.

Hierarchy

• Light

Index

Properties

• blue
• brightness
• gamut
• green
• id
• red

Accessors

• frame

Methods

• make

Properties

blue

• blue: number = 255

Defined in src/structs/light.ts:36

---

brightness

• brightness: number = 255

Defined in src/structs/light.ts:37

---

gamut

• gamut: ColorGamut | null = null

Defined in src/structs/light.ts:38

---

green

• green: number = 255

Defined in src/structs/light.ts:35

---

id

• id: number

Defined in src/structs/light.ts:33

---

red

• red: number = 255

Defined in src/structs/light.ts:34

Accessors

frame

• get frame(): Frame

Defined in src/structs/light.ts:40

Returns: Frame

Methods

make

▸ Staticmake(api: Api, id: number | string): Promise<Light>

Defined in src/structs/light.ts:21

Parameters:

Name	Type
api	Api
id	number | string

Returns: Promise<Light>