LightProbeProxyVolume
The Light Probe Proxy Volume component offers the possibility to use higher resolution lighting for large non-static GameObjects.
Read time 8 minutesLast updated 2 days ago
Definition
- Type: Class
- Namespace: UnityEngine
- Assembly: UnityEngine.CoreModule
- Inherits from: Behaviour
Warning
Deprecated. The Light Probe Proxy Volume component is deprecated now that the Built-In Render Pipeline is deprecated. To use an alternative, refer to the documentation in the component help icon. #from(6000.5)
public sealed class LightProbeProxyVolume : Behaviour
Remarks
By default, a probe-lit Renderer receives lighting from a single Light Probe that is interpolated from the surrounding Light Probes in the Scene. Because of this, GameObjects have constant ambient lighting regardless of their position on the surface. The light has have a rotational gradient because it's using spherical harmonics, but it lacks a spatial gradient. This is more noticeable on larger GameObjects and Particle Systems. The lighting across the GameObject matches the lighting at the anchor point, and if the GameObject straddles a lighting gradient, parts of the GameObject will look incorrect.
This component will generate a 3D grid of interpolated Light Probes inside a bounding volume. The resolution of the grid can be user-specified. The spherical harmonics coefficients of the interpolated Light Probes are updated into 3D textures, which are sampled at render time to compute the contribution to the diffuse ambient lighting. This adds a spatial gradient to probe-lit GameObjects.
Additional Resources: Light Probes.
Properties
Property | Description |
|---|---|
| boundingBoxMode | The bounding box mode for generating the 3D grid of interpolated Light Probes. |
| boundsGlobal | The world-space bounding box in which the 3D grid of interpolated Light Probes is generated. |
| dataFormat | The texture data format used by the Light Probe Proxy Volume 3D texture. |
| gridResolutionX | The 3D grid resolution on the x-axis. |
| gridResolutionY | The 3D grid resolution on the y-axis. |
| gridResolutionZ | The 3D grid resolution on the z-axis. |
| originCustom | The local-space origin of the bounding box in which the 3D grid of interpolated Light Probes is generated. |
| probeDensity | Interpolated Light Probe density. |
| probePositionMode | The mode in which the interpolated Light Probe positions are generated. |
| qualityMode | Determines how many Spherical Harmonics bands will be evaluated to compute the ambient color. |
| refreshMode | Sets the way the Light Probe Proxy Volume refreshes. |
| resolutionMode | The resolution mode for generating the grid of interpolated Light Probes. |
| sizeCustom | The size of the bounding box in which the 3D grid of interpolated Light Probes is generated. |
Static Properties
Property | Description |
|---|---|
| isFeatureSupported | Checks if Light Probe Proxy Volumes are supported. |
Methods
Method | Description |
|---|---|
| Update | Triggers an update of the Light Probe Proxy Volume. |
Enums
Enum | Description |
|---|---|
| LightProbeProxyVolume.BoundingBoxMode | The bounding box mode for generating a grid of interpolated Light Probes. |
| LightProbeProxyVolume.DataFormat | The texture data format used by the Light Probe Proxy Volume 3D texture. |
| LightProbeProxyVolume.ProbePositionMode | The mode in which the interpolated Light Probe positions are generated. |
| LightProbeProxyVolume.QualityMode | An enum describing the Quality option used by the Light Probe Proxy Volume component. |
| LightProbeProxyVolume.RefreshMode | An enum that describes how Unity refreshes a Light Probe Proxy Volume in the Player. |
| LightProbeProxyVolume.ResolutionMode | The resolution mode for generating a grid of interpolated Light Probes. |
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. |