ReflectionProbe
The reflection probe is used to capture the surroundings into a texture which is passed to the shaders and used for reflections.
Read time 9 minutesLast updated 2 days ago
Definition
- Type: Class
- Namespace: UnityEngine
- Assembly: UnityEngine.CoreModule
- Inherits from: Behaviour
public sealed class ReflectionProbe : Behaviour
Remarks
The properties are an exact match for the values shown in the Inspector.
This class is a script interface for a reflection probe component.
Reflection probes are usually just created in the Editor, but sometimes you might want to create a reflection probe from a script:
Examples
using UnityEngine;using UnityEditor;public class ProbeCreator{ [MenuItem("ReflectionProbe/CreateRealtimeProbe")] public static void RealtimeProbe() { // Add a GameObject with a ReflectionProbe component GameObject probeGameObject = new GameObject("Realtime Reflection Probe"); ReflectionProbe probeComponent = probeGameObject.AddComponent<ReflectionProbe>(); // The probe will contribute to reflections inside a box of size 10x10x10 centered on the position of the probe probeComponent.size = new Vector3(10, 10, 10); // Set the type to realtime and refresh the probe every frame probeComponent.mode = UnityEngine.Rendering.ReflectionProbeMode.Realtime; probeComponent.refreshMode = UnityEngine.Rendering.ReflectionProbeRefreshMode.EveryFrame; }}
Properties
Property | Description |
|---|---|
| backgroundColor | The color with which the texture of reflection probe will be cleared. |
| bakedTexture | Reference to the baked texture of the reflection probe's surrounding. |
| blendDistance | Distance around probe used for blending (used in deferred probes). |
| bounds | The probe's world space axis-aligned bounding box in which the probe can contribute to reflections (Read Only). |
| boxProjection | Should this reflection probe use box projection? |
| center | The center of the probe's bounding box in which the probe can contribute to reflections. The center is relative to the position of the probe. |
| clearFlags | How the reflection probe clears the background. |
| cullingMask | This is used to render parts of the reflecion probe's surrounding selectively. |
| customBakedTexture | Reference to the baked texture of the reflection probe's surrounding. Use this to assign custom reflection texture. |
| exposureValue | The exposure value at capture time. When the scene's exposure differs from this value, the probe's contribution is re-exposed to match. This property is used only in URP. |
| farClipPlane | The far clipping plane distance when rendering the probe. |
| hdr | Should this reflection probe use HDR rendering? |
| importance | Reflection probe importance. |
| intensity | The intensity modifier that is applied to the texture of reflection probe in the shader. |
| mode | Should reflection probe texture be generated in the Editor (ReflectionProbeMode.Baked) or should probe use custom specified texure (ReflectionProbeMode.Custom)? |
| nearClipPlane | The near clipping plane distance when rendering the probe. |
| realtimeTexture | Reference to the real-time texture of the reflection probe's surroundings. Use this to assign a RenderTexture to use for real-time reflection. |
| refreshMode | Sets the way the probe will refresh. |
| renderDynamicObjects | Specifies whether Unity should render non-static GameObjects into the Reflection Probe. If you set this to |
| resolution | Resolution of the underlying reflection texture in pixels. |
| shadowDistance | Shadow drawing distance when rendering the probe. |
| size | The size of the probe's bounding box in which the probe can contribute to reflections. The size is in world space. |
| texture | Texture which is passed to the shader of the objects in the vicinity of the reflection probe (Read Only). |
| textureHDRDecodeValues | HDR decode values of the reflection probe texture. |
| timeSlicingMode | Sets this probe time-slicing mode |
Static Properties
Property | Description |
|---|---|
| defaultTexture | The surface texture of the default reflection probe that captures the environment contribution. Read only. |
| defaultTextureHDRDecodeValues | HDR decode values of the default reflection probe texture. |
Methods
Method | Description |
|---|---|
| IsFinishedRendering | Checks if a probe has finished a time-sliced render. |
| RenderProbe | Refreshes the probe's cubemap. |
| Reset | Revert all ReflectionProbe parameters to default. |
Static Methods
Method | Description |
|---|---|
| BlendCubemap | Utility method to blend 2 cubemaps into a target render texture. |
| UpdateCachedState | Updates the culling system with the ReflectionProbe's current state. This ensures that Unity correctly culls the ReflectionProbe during rendering if you implement your own runtime reflection system. |
Static Events
Member | Description |
|---|---|
| defaultReflectionTexture | Adds a delegate to get notifications when the default specular Cubemap is changed. |
| reflectionProbeChanged | Adds a delegate to get notifications when a Reflection Probe is added to a Scene or removed from a Scene. |
Enums
Enum | Description |
|---|---|
| ReflectionProbe.ReflectionProbeEvent | Types of events that occur when ReflectionProbe components are used in a Scene. |
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. |