Environment

1.2.3+

Environment lighting properties

Static Members

• .constructor(scene) ⇒ Environment

Properties

• .coefficients
• .intensity
• .tint

Methods

• .getCoefficients<T>(out) ⇒ T
• .getTint<T>(out) ⇒ T
• .requestBake() ⇒ void
• .setCoefficients(v) ⇒ void
• .setTint(v) ⇒ void

---

Constructor

.constructor(scene: Scene) ⇒ Environment

Constructor

Param	Type	Description
scene	Scene

---

Properties

.coefficients: Float32Array

Equivalent to getCoefficients.

Note: Prefer to use getCoefficients for performance.

.coefficients

Equivalent to setCoefficients.

---

.intensity: number

Get intensity of environment lighting.

Incoming environment lighting is multiplied by this factor.

.intensity

Set intensity of environment lighting.

---

.tint: Float32Array

Equivalent to getTint.

Note: Prefer to use getTint for performance.

.tint

Equivalent to setTint.

---

---

Methods

.getCoefficients<T>(out: T) ⇒ T

.getCoefficients() ⇒ Float32Array

Get spherical harmonics coefficients for indirect lighting.

These are 9 spherical harmonics coefficients for indirect diffuse lighting.

Returns: Spherical harmonics coefficients. Always 27 elements, every consecutive 3 values representing the red, green, blue components of a single coefficient. Unused/empty coefficients at the end can be 0.

Param	Type	Description
out	T	Preallocated array to write into, to avoid garbage, otherwise will allocate a new Float32Array.

Template Param	Type Definition
T	extends NumberArray

---

.getTint<T>(out: T) ⇒ T

.getTint() ⇒ Float32Array

Get tint for environment lighting.

Incoming environment lighting color channels are multiplied by these values.

Returns: Tint values - red, green, blue.

Param	Type	Description
out	T	Preallocated array to write into, to avoid garbage, otherwise will allocate a new Float32Array.

Template Param	Type Definition
T	extends NumberArray

---

.requestBake() ⇒ void

Request a re-bake of the environment.

Note: Currently, baking only takes into account the sky material.

Note: This API is experimental.

---

.setCoefficients(v: Readonly<NumberArray>) ⇒ void

Set spherical harmonics coefficients for indirect lighting.

Note: The scene must have been packaged with environment lighting on for this to take effect.

Example: Coefficients from WebXR Lighting Estimation can be passed as follows:

const probe = await engine.xr.session.requestLightProbe();
const estimate = engine.xr.frame.getLightEstimate(probe);
scene.environment.coefficients = estimate.sphericalHarmonicsCoefficients;

Param	Type	Description
v	Readonly<NumberArray>	A set of spherical harmonics coefficients, every 3 elements constituting the red/green/blue components of a single coefficient. Should be 0, 3, 12 or 27 array elements. Passing an empty array disables indirect lighting.

---

.setTint(v: Readonly<NumberArray>) ⇒ void

Set tint for environment lighting.

Param	Type	Description
v	Readonly<NumberArray>	New tint value. Expects a 3 component array.

---