LightProbes
Stores light probe data for all currently loaded Scenes.
Read time 5 minutesLast updated 5 days ago
Definition
- Type: Class
- Namespace: UnityEngine
- Assembly: UnityEngine.CoreModule
- Inherits from: Object
public sealed class LightProbes : Object
Remarks
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 object for a different pre-baked one using LightmapSettings.lightProbes.
LightProbesTo retrieve the objects for a specific scene, use LightProbes.GetInstantiatedLightProbesForScene or LightProbes.GetSharedLightProbesForScene.
LightProbesProperties
Property | Description |
|---|---|
| bakedProbes | Coefficients of baked light probes. |
| cellCount | The number of cells space is divided into (Read Only). |
| cellCountSelf | The number of cells space is divided into for this |
| count | The number of light probes (Read Only). |
| countSelf | The number of light probes stored in this |
| positions | Positions of the baked light probes (Read Only). |
Methods
Method | Description |
|---|---|
| GetPositionsSelf | Gets the positions of the baked light probes stored in this |
| SetPositionsSelf | Sets the positions of the baked light probes stored in this |
Static Methods
Method | Description |
|---|---|
| CalculateInterpolatedLightAndOcclusionProbes | Calculate light probes and occlusion probes at the given world space positions. |
| GetInstantiatedLightProbesForScene | Gets an instantiated clone of the |
| GetInterpolatedProbe | Returns an interpolated probe for the given position for both real-time and baked light probes combined. |
| GetSharedLightProbesForScene | Gets the shared |
| Tetrahedralize | Synchronously tetrahedralize the currently loaded LightProbe positions. |
| TetrahedralizeAsync | Asynchronously tetrahedralize all currently loaded LightProbe positions. |
Static Events
Member | Description |
|---|---|
| lightProbesUpdated | Unity raises this event to indicate that the light probe structure (tetrahedralization) or values (spherical harmonics coefficients) have changed. |
| needsRetetrahedralization | An event which is called when the number of currently loaded light probes changes due to additive scene loading or unloading. |
| tetrahedralizationCompleted | Event which is called after LightProbes.Tetrahedralize or LightProbes.TetrahedralizeAsync has finished computing a tetrahedralization. |
Inheritance
Operators
Operator | Description |
|---|---|
| operator == | Compares two object references to see if they refer to the same object. |
| bool | Determines whether the object exists. |
| operator != | Compares if two objects refer to a different object. |