Babylon.js API documentation|

SphericalHarmonics

Class SphericalHarmonics

Class representing spherical harmonics coefficients to the 3rd degree

Hierarchy

SphericalHarmonics

Index

Constructors

constructor

new SphericalHarmonics(): SphericalHarmonics

Returns SphericalHarmonics

Properties

l00 Search playground for l00

The l0,0 coefficients of the spherical harmonics

l10 Search playground for l10

The l1,0 coefficients of the spherical harmonics

l11 Search playground for l11

The l1,1 coefficients of the spherical harmonics

l1_1 Search playground for l1_1

The l1,-1 coefficients of the spherical harmonics

l20 Search playground for l20

The l2,0 coefficients of the spherical harmonics

l21 Search playground for l21

The l2,1 coefficients of the spherical harmonics

l22 Search playground for l22

The l2,2 coefficients of the spherical harmonics

l2_1 Search playground for l2_1

The l2,-1 coefficients of the spherical harmonics

l2_2 Search playground for l2_2

The l2,-2 coefficients of the spherical harmonics

preScaled Search playground for preScaled

preScaled: boolean

Defines whether or not the harmonics have been prescaled for rendering.

Methods

addLight Search playground for addLight

addLight(direction: Vector3, color: Color3, deltaSolidAngle: number): void

- Defined in .temp/docdirectory/doc.d.ts:63814
Adds a light to the spherical harmonics

Parameters
- direction: Vector3
  
  the direction of the light
- color: Color3
  
  the color of the light
- deltaSolidAngle: number
  
  the delta solid angle of the light
Returns void

convertIncidentRadianceToIrradiance Search playground for convertIncidentRadianceToIrradiance

convertIncidentRadianceToIrradiance(): void

- Defined in .temp/docdirectory/doc.d.ts:63831
Convert from incident radiance (Li) to irradiance (E) by applying convolution with the cosine-weighted hemisphere.
```
E_lm = A_l * L_lm
```
In spherical harmonics this convolution amounts to scaling factors for each frequency band. This corresponds to equation 5 in "An Efficient Representation for Irradiance Environment Maps", where the scaling factors are given in equation 9.
Returns void

convertIrradianceToLambertianRadiance Search playground for convertIrradianceToLambertianRadiance

convertIrradianceToLambertianRadiance(): void

- Defined in .temp/docdirectory/doc.d.ts:63841
Convert from irradiance to outgoing radiance for Lambertian BDRF, suitable for efficient shader evaluation.
```
L = (1/pi) * E * rho
```
This is done by an additional scale by 1/pi, so is a fairly trivial operation but important conceptually.
Returns void

preScaleForRendering Search playground for preScaleForRendering

preScaleForRendering(): void

- Defined in .temp/docdirectory/doc.d.ts:63849
Integrates the reconstruction coefficients directly in to the SH preventing further required operations at run time.

This is simply done by scaling back the SH with Ylm constants parameter. The trigonometric part being applied by the shader at run time.

Returns void

scaleInPlace Search playground for scaleInPlace

scaleInPlace(scale: number): void

- Defined in .temp/docdirectory/doc.d.ts:63819
Scales the spherical harmonics by the given amount

Parameters
- scale: number
  
  the amount to scale
Returns void

updateFromArray Search playground for updateFromArray

updateFromArray(data: ArrayLike<ArrayLike<number>>): SphericalHarmonics

- Defined in .temp/docdirectory/doc.d.ts:63855
update the spherical harmonics coefficients from the given array

Parameters
- data: ArrayLike<ArrayLike<number>>
  
  defines the 9x3 coefficients (l00, l1-1, l10, l11, l2-2, l2-1, l20, l21, l22)
Returns SphericalHarmonics
the spherical harmonics (this)

updateFromFloatsArray Search playground for updateFromFloatsArray

updateFromFloatsArray(data: ArrayLike<number>): SphericalHarmonics

- Defined in .temp/docdirectory/doc.d.ts:63861
update the spherical harmonics coefficients from the given floats array

Parameters
- data: ArrayLike<number>
  
  defines the 9x3 coefficients (l00, l1-1, l10, l11, l2-2, l2-1, l20, l21, l22)
Returns SphericalHarmonics
the spherical harmonics (this)

Static FromArray Search playground for FromArray

FromArray(data: ArrayLike<ArrayLike<number>>): SphericalHarmonics

- Defined in .temp/docdirectory/doc.d.ts:63867
Constructs a spherical harmonics from an array.

Parameters
- data: ArrayLike<ArrayLike<number>>
  
  defines the 9x3 coefficients (l00, l1-1, l10, l11, l2-2, l2-1, l20, l21, l22)
Returns SphericalHarmonics
the spherical harmonics

Static FromPolynomial Search playground for FromPolynomial

FromPolynomial(polynomial: SphericalPolynomial): SphericalHarmonics

- Defined in .temp/docdirectory/doc.d.ts:63873
Gets the spherical harmonics from polynomial

Parameters
- polynomial: SphericalPolynomial
  
  the spherical polynomial
Returns SphericalHarmonics
the spherical harmonics