Version: 2023.2
LanguageEnglish
  • C#

LightProbes

class in UnityEngine

/

Inherits from:Object

/

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

Stores light probe data for all currently loaded Scenes.

The data includes: probe positions, Spherical Harmonics (SH) coefficients and the tetrahedral tessellation.

You can modify the probe positions and coefficients, and update the tetrahedral tessellation at runtime. You can also swap the entire LightProbes object for a different pre-baked one using LightmapSettings.lightProbes.

To retrieve the LightProbes objects for a specific scene, use LightProbes.GetInstantiatedLightProbesForScene or LightProbes.GetSharedLightProbesForScene.

Additional resources: Light Probes in the Unity Manual, LightmapSettings, ReceiveGI.

Properties

bakedProbesCoefficients of baked light probes.
cellCountThe number of cells space is divided into (Read Only).
cellCountSelfThe number of cells space is divided into for this LightProbes object (Read Only).
countThe number of light probes (Read Only).
countSelfThe number of light probes stored in this LightProbes object (Read Only).
positionsPositions of the baked light probes (Read Only).

Public Methods

GetPositionsSelfGets the positions of the baked light probes stored in this LightProbes object.
SetPositionsSelfSets the positions of the baked light probes stored in this LightProbes object.

Static Methods

CalculateInterpolatedLightAndOcclusionProbesCalculate light probes and occlusion probes at the given world space positions.
GetInstantiatedLightProbesForSceneGets an instantiated clone of the LightProbes object for a specific scene.
GetInterpolatedProbeReturns an interpolated probe for the given position for both real-time and baked light probes combined.
GetSharedLightProbesForSceneGets the shared LightProbes object for a specific scene.
TetrahedralizeSynchronously tetrahedralize the currently loaded LightProbe positions.
TetrahedralizeAsyncAsynchronously tetrahedralize all currently loaded LightProbe positions.

Events

lightProbesUpdatedUnity raises this event to indicate that the light probe structure (tetrahedralization) or values (spherical harmonics coefficients) have changed.
needsRetetrahedralizationAn event which is called when the number of currently loaded light probes changes due to additive scene loading or unloading.
tetrahedralizationCompletedEvent which is called after LightProbes.Tetrahedralize or LightProbes.TetrahedralizeAsync has finished computing a tetrahedralization.

Inherited Members

Properties

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

Public Methods

GetInstanceIDGets the instance ID of the object.
ToStringReturns the name of the object.

Static Methods

DestroyRemoves a GameObject, component or asset.
DestroyImmediateDestroys the object obj immediately. You are strongly recommended to use Destroy instead.
DontDestroyOnLoadDo not destroy the target Object when loading a new Scene.
FindAnyObjectByTypeRetrieves any active loaded object of Type type.
FindFirstObjectByTypeRetrieves the first active loaded object of Type type.
FindObjectsByTypeRetrieves a list of all 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.