Legacy Documentation: Version 5.5
LanguageEnglish
  • C#
  • JS

Script language

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

LightProbes

class in UnityEngine

/

Inherits from:Object

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

Stores light probes for the scene.

The baked data includes: probe positions, Spherical Harmonics (SH) coefficients and the tetrahedral tessellation. You can modify the coefficients at runtime. You can also swap the entire LightProbes object to a different pre-baked one using LightmapSettings.lightProbes.

See Also: LightmapSettings class, Renderer.useLightProbes property.

Variables

bakedProbesCoefficients of baked light probes.
cellCountThe number of cells space is divided into (Read Only).
countThe number of light probes (Read Only).
positionsPositions of the baked light probes (Read Only).

Static Functions

GetInterpolatedProbeReturns an interpolated probe for the given position for both realtime and baked light probes combined.

Inherited members

Variables

hideFlagsShould the object be hidden, saved with the scene or modifiable by the user?
nameThe name of the object.

Public Functions

GetInstanceIDReturns the instance id of the object.
ToStringReturns the name of the game object.

Static Functions

DestroyRemoves a gameobject, component or asset.
DestroyImmediateDestroys the object obj immediately.
DontDestroyOnLoadMakes the object target not be destroyed automatically when loading a new scene.
FindObjectOfTypeReturns the first active loaded object of Type type.
FindObjectsOfTypeReturns a list of all active loaded objects of Type type.
InstantiateClones the object original and returns the clone.

Operators

boolDoes the object exist?
operator !=Compares if two objects refer to a different object.
operator ==Compares two object references to see if they refer to the same object.