Legacy Documentation: Version 5.1
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

RenderSettings.ambientProbe

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

Sumbission failed

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

Close

Cancel

Switch to Manual
public static var ambientProbe: Rendering.SphericalHarmonicsL2;
public static Rendering.SphericalHarmonicsL2 ambientProbe;

Description

Custom or skybox ambient lighting data.

Skybox ambient lighting mode uses this Spherical Harmonics (SH) probe to calculate ambient. You can also assign a completely custom SH probe this way.

The GI system will bake the ambient probe, but it actually won't be used on geometry that uses light probes or lightmaps, as the environment lighting is already in the light probes and the lightmaps. It is used as the last fallback if light probes or lightmaps are not present or enabled for an object.

Adjusting the ambient probe will not affect the input to realtime and baked Global Illumination. If you want to adjust ambient in a way that affects GI, adjust ambient through RenderSettings.ambientMode, for instance by using AmbientMode.Trilight. The GI system will output the resulting ambient values into the ambient probe, which means that a custom ambient probe can be overwritten by the GI system.

See Also: ambientMode, SphericalHarmonicsL2, Lighting Window.