Refer to the following as guidance on which APIs to use:

New projects:

Existing projects:

Health and Safety Recommendation: While building mixed reality experiences, we highly recommend evaluating your content to offer your users a comfortable and safe experience. Please refer to the Health and Safety and Design guidelines before designing and developing your app using Scene.

You can check out Phanto for an example of Scene Mesh being integrated into mixed reality gameplay.

The scene mesh is a low-fidelity, high-coverage artifact which describes the boundary between free and occupied space in a room. It is generated automatically during the space setup experience, and available for applications to query via Scene API.

Previously, Scene Capture was a manual process where a user outlined walls and objects in the room. Space setup will automatically capture structural room elements (walls, ceiling, floor), known as a Roombox, by creating an on-the-fly mesh reconstruction of the entire space and attempt to discover what part of this reconstruction is a wall, ceiling, or floor. This reconstruction yields a single mesh, known as the scene mesh, which can be accessed in Unreal after the space setup process has been completed.

In order to get this up and running, you will need to have the following:

Scene Model is a collection of objects called scene anchors, each of which have any number components on them that provide further information. Components hold information such as whether the anchor is a plane, whether it’s a volume, whether it has a mesh, whether it’s locatable, whether it’s a room, whether it holds other anchors, etc; the idea is that anchors are very generic objects, and an API user queries the components on the anchor to find what information they have.

For example, if you have a Scene Model of four walls, then you will have four scene anchors. Each anchor will be Locatable, have a Semantic Classification of WALL, and be a Plane which holds dimensions.

An app that wants to use Scene API needs to request Spatial Data permission during the app’s runtime. See the Unreal section of Spatial Data Permission and Requesting runtime permissions for more information.

In order to get the scene mesh in Unreal, you will need to do the following steps:

We will now look at each of these steps in greater detail.

After following a typical Unreal setup for Meta Quest development, you should start by adding a VR-ready pawn into the scene. This will add a complete camera setup to the scene, allowing you to move around the scene with the headset. You can also add passthrough to your scene by following these instructions.

Add the OculusXRSceneActor into the scene. This class wraps all the functionality of Scene into a single class with easy-to-use SceneAnchorProperties that will be instantiated for those objects. The split is the following:

Scene mesh is managed by the OculusXRSceneGlobalMesh component, which needs to be a child of the OculusXRSceneActor. You can add it directly from the scene by clicking on the “+ Add” button in the Details panel of the OculusXRSceneActor and searching for “Global Mesh”.

In the OculusXRSceneGlobalMesh component, you can configure the Scene Mesh for collision by selecting the desired Collision Profile. You can also determine its visibility by choosing the appropriate material. It’s recommended to use a material with the Wireframe option enabled for displaying the Scene Mesh. To do this, navigate to Material > Advanced > Wireframe.

In order to have the Scene Mesh working, you need to have the permission to use Scene.

There’s two ways to do so :

Now that everything has been set up, compile the app and install it to your headset to see the app. There are various ways you can install the application, but all require your device to be connected to your computer with developer mode enabled.