AR Environment Probe Manager | AR Foundation | 1.5.0-preview.7
docs.unity3d.com
    Show / Hide Table of Contents

    AR Environment Probe Manager

    The environment probe manager is a type of trackable manager.

    alt text

    Environment probes are a technique of capturing real-world imagery from a camera and organizing that information into an environment texture, such as a cube map, that contains the view in all directions from a certain point in the scene. Rendering 3D objects using this environment texture allows for real-world imagery to be reflected in the rendered objects. The result is generally realistic reflections and lighting of virtual objects as influenced by the real-world views.

    For more details, refer to the Environment Probe Subsystem.

    Manual Placement

    Environment probes can be created by calling AREnvironmentProbeManager.AddEnvironmentProbe. Like reference points, the resulting AREnvironmentProbe may be in a "pending" state for a few frames.

    You can remove an environment probe by calling AREnvironmentProbeManager.RemoveEnvironmentProbe. Note you should not Destroy an AREnvironmentProbe unless its manager has already been destroyed.

    Automatic Placement

    Environment probes can be placed automatically, manually, or both. In automatic mode, the device automatically selects suitable locations for environment probes and creates them.

    Note that environment probes can be created in any orientation. However, Unity's reflection probes, which consume the environment probe data, only support axis-aligned orientations. This means the orientation you specify (or which was selected automatically) may not be fully respected.

    Texture Filter Mode

    This corresponds to the UnityEngine.FilterMode for the cubemap generated by the envrionment probe.

    Debug Prefab

    This prefab will be instantiated for each manually or automatically placed environment probe. This is not required, but provided for debugging purposes.

    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023