textmode.js / Textmodifier / ambientLight

Method: ambientLight()

Call Signature

ambientLight(gray): void;

Add an ambient light using a grayscale value.

Ambient light shines evenly from all directions. Multiple calls are additive, so colors accumulate. Ambient lights are frame-scoped and reset each layer draw callback. Lighting uses RGB only, so any provided alpha value is ignored.

Parameters

Parameter	Type	Description
gray	number	Grayscale value (0-255)

Returns

void

Example

Call Signature

ambientLight(gray, alpha): void;

Add an ambient light using a grayscale value and alpha.

Parameters

Parameter	Type	Description
gray	number	Grayscale value (0-255)
alpha	number	Alpha value (0-255)

Returns

void

Call Signature

ambientLight(
   v1, 
   v2, 
   v3): void;

Add an ambient light using RGB components.

Parameters

Parameter	Type	Description
v1	number	Red component (0-255)
v2	number	Green component (0-255)
v3	number	Blue component (0-255)

Returns

void

Call Signature

ambientLight(
   v1, 
   v2, 
   v3, 
   alpha): void;

Add an ambient light using RGB components and alpha.

Parameters

Parameter	Type	Description
v1	number	Red component (0-255)
v2	number	Green component (0-255)
v3	number	Blue component (0-255)
alpha	number	Alpha value (0-255)

Returns

void

Call Signature

ambientLight(color): void;

Add an ambient light using a color value.

Parameters

Parameter	Type	Description
color	| string | [number, number, number] | [number, number, number, number] | TextmodeColor	Color value (CSS string, TextmodeColor, or RGB(A) array)

Returns

void