Version: 2021.3
LanguageEnglish
  • C#

SphericalHarmonicsL2

struct in UnityEngine.Rendering

/

Implemented in:UnityEngine.CoreModule

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Description

Spherical harmonics up to the second order (3 bands, 9 coefficients).

Spherical harmonics (SH) represent a function or signal over directions, and are commonly used in computer graphics to efficiently evaluate smooth lighting. Unity uses them for LightProbes and environment lighting.

L2 spherical harmonics is composed of 9 coefficients for each color channel.

Additional resources: RenderSettings.ambientMode, RenderSettings.ambientProbe, LightProbes.

Properties

this[int,int]Access individual SH coefficients.

Public Methods

AddAmbientLightAdd an ambient light to the spherical harmonics.
AddDirectionalLightAdd a directional light to the spherical harmonics.
ClearClears the spherical harmonics coefficients to zero.
EvaluateEvaluates the spherical harmonics for each given direction. The directions and results arrays must have the same size.

Operators

operator !=Returns true if the spherical harmonics are different.
operator *Scales SH by a given factor.
operator +Adds two spherical harmonics.
operator ==Returns true if the spherical harmonics are equal.