ReflectionProbe

Description

The reflection probe is used to capture the surroundings into a texture which is passed to the shaders and used for reflections.

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:

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;
    }
}

Static Properties

Properties

Public Methods

Static Methods

Events

Inherited Members