Use the legacy foveation API

Configure the legacy foveation method with the Meta XR Core SDK, then set the foveation level at runtime.

The legacy API supports Meta Quest headsets only, and might not work on other devices. Use it when your project targets the Built-In Render Pipeline, which the scriptable render pipeline (SRP) foveation API doesn't support.

Note

The Meta XR Core SDK is a third-party package that Unity doesn't control. The OpenXR features and API it provides can change without notice.

Prerequisites

Before you begin, make sure your project meets the conditions in Foveated rendering requirements reference.

Install the Meta XR Core SDK package, if you haven't already. You can get this package from the Unity Asset Store. The package adds the Meta XR feature group and its associated features to the OpenXR settings. Refer to the Meta Horizon developer documentation for more information.

Configure the legacy foveation method

Set the Foveated Rendering Method option to Foveated rendering (Legacy API), and enable the Meta XR Foveation feature.

To configure foveated rendering with the legacy API:

  1. Open the Project Settings window.

  2. Select the XR Plug-in Management settings.

  3. Select the Android tab.

  4. Under OpenXR, enable the Meta XR feature group. Unity might prompt you to restart the Unity Editor. Restart now, or after you finish configuring these settings.

    The Meta XR feature group enabled in the OpenXR settings

  5. Under XR Plug-in Management, select the OpenXR settings.

  6. Set the Foveated Rendering Method option to Foveated rendering (Legacy API).

  7. In the list of OpenXR Feature Groups, select All Features.

  8. Disable the Foveated Rendering feature, if you enabled it.

  9. Enable the Meta XR Foveation feature.

  10. (Optional) Enable the Meta XR Eye Tracked Foveation feature.

Settings to enable foveated rendering with the legacy API
Legacy API foveated rendering settings.

After you apply these settings, the legacy API is available in your project. Next, set the foveation level at runtime.

Set the foveation level

The following code example sets foveated rendering to High and enables gaze-based foveation with the legacy API and the Meta XR Core SDK package:

using UnityEngine;
using UnityEngine.XR;

public class FoveationStarter : MonoBehaviour
{
    private void Start()
    {
        // Only use with the Meta XR Core SDK.
        OVRManager.foveatedRenderingLevel = OVRManager.FoveatedRenderingLevel.High;
        OVRManager.eyeTrackedFoveatedRenderingEnabled = true;
    }
}

Refer to Meta's OVRManager Class Reference for more information.

Additional resources