Version: 5.4 beta (switch to 5.3)
LanguageEnglish
  • C#
  • JS

Script language

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

LightProbeProxyVolume

class in UnityEngine

/

Inherits from: Behaviour

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

Description

The light probe proxy volume component offers the possibility to use higher resolution lighting for large non-static objects.

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, objects have constant ambient lighting regardless of position on the surface. It will have a rotational gradient because it's using spherical harmonics, but it will lack a spatial gradient. This will be more noticeable on larger objects or particle systems. The lighting across the object will match the lighting at the anchor point, and if the object straddles a lighting gradient parts of the object 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 will add a spatial gradient to probe lit objects.

See Also: Light Probes.

Static Variables

isFeatureSupportedChecks if this feature is supported by the graphics hardware or by the graphics API used. The feature requires at least Shader Model 4 including 32-bit floating-point 3D texture support with linear interpolation.

Variables

boundingBoxModeThe bounding box mode for generating the 3D grid of interpolated light probes.
boundsGlobalThe world-space bounding box in which the 3D grid of interpolated light probes is generated.
gridResolutionXThe 3D grid resolution on the X axis. This property is used only when the Resolution Mode is set to Custom. The final resolution will be the closest power of 2.
gridResolutionYThe 3D grid resolution on the Y axis. This property is used only when the Resolution Mode is set to Custom. The final resolution will be the closest power of 2.
gridResolutionZThe 3D grid resolution on the Z axis. This property is used only when the Resolution Mode is set to Custom. The final resolution will be the closest power of 2.
originCustomThe local-space origin of the bounding box in which the 3D grid of interpolated light probes is generated. This is used when the Bounding Box Mode property is set to Custom.
probeDensityInterpolated light probe density. This value is used only when the Resolution Mode is Automatic.
probePositionModeThe mode in which the interpolated light probe positions are generated.
refreshModeSets the way the light probe volume will refresh.
resolutionModeThe resolution mode for generating the grid of interpolated light probes.
sizeCustomThe size of the bounding box in which the 3D grid of interpolated light probes is generated. This is used when the Bounding Box Mode property is set to Custom.

Public Functions

UpdateTriggers an update of the light probe volume.

Inherited members

Variables

enabledEnabled Behaviours are Updated, disabled Behaviours are not.
isActiveAndEnabledHas the Behaviour had enabled called.
gameObjectThe game object this component is attached to. A component is always attached to a game object.
tagThe tag of this game object.
transformThe Transform attached to this GameObject (null if there is none attached).
hideFlagsShould the object be hidden, saved with the scene or modifiable by the user?
nameThe name of the object.

Public Functions

BroadcastMessageCalls the method named methodName on every MonoBehaviour in this game object or any of its children.
CompareTagIs this game object tagged with tag ?
GetComponentReturns the component of Type type if the game object has one attached, null if it doesn't.
GetComponentInChildrenReturns the component of Type type in the GameObject or any of its children using depth first search.
GetComponentInParentReturns the component of Type type in the GameObject or any of its parents.
GetComponentsReturns all components of Type type in the GameObject.
GetComponentsInChildrenReturns all components of Type type in the GameObject or any of its children.
GetComponentsInParentReturns all components of Type type in the GameObject or any of its parents.
SendMessageCalls the method named methodName on every MonoBehaviour in this game object.
SendMessageUpwardsCalls the method named methodName on every MonoBehaviour in this game object and on every ancestor of the behaviour.
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.
InstantiateReturns a copy of the object original.

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.