Quickstart
Let's get started with Spatial Reality Display(SR Display) app in Unity!
Prerequisites
-
A set up your SR Display, if it is not set up, see: Setup SR Display,Setup SR Display Settings
- Connect your SR Display to PC
- Configure the settings of your SR Display
- Install SR Display Settings
-
Installed UnityHub and UnityEditor, see: Download Unity
- Currently supported Unity versions: Unity 2020.4, 2021.3, and 2022.2.
Note
Only one SR Display app can be run at a time. Multiple apps will fail to launch.
Caution
Exit Unity Hub before installing Spatial Reality Display Settings.
Create a new Unity project with SRDisplay UnityPlugin
-
Download latest srdisplay-unity-plugin.unitypackage
-
Create a new Unity project
Create the appropriate project from Standard 3D Renderer, Universal Render Pipeline (URP) and High Definition Render Pipeline (HDRP).
-
Import SRDisplay UnityPlugin
-
Select Assets > Import Package > Custom Package and select srdisplay-unity-plugin.unitypackage that you downloaded
Or you can drag & drop srdisplay-unity-plugin.unitypackage to Project in the UnityEditor, also.
-
Click Import in the Import Unity Package dialog
Make sure that all package options are checked
-
Open the sample scene
-
Open SRDisplaySimpleSample scene in Assets / SRDisplayUnityPlugin / Samples / 1_SRDSimpleSample / Scenes
-
If the architecture of the Unity project is not x86_64, the plugin will change the architecture to x86_64 automatically. When the following dialog window appears, click OK to switch to the correct architecture.
Caution
SRDisplay UnityPlugin only supports Windows x86_64 architecture
Caution
Only "Mono" is supported for "Scripting Backend" in the Project Settings.
Make sure that "Project Settings"-> "Player"-> "Scripting Backend" is set to "Mono".
Tips
Recommend to do Generate Lighting of the SRDisplaySimpleSample from Window > Rendering > Lighting Settings
Build and run the SR Display app
-
Configure Project Settings from Edit > Project Settings...
-
Set the VSync Count for all Quality Levels to Don't Sync (See: Minimize the latency for good user experience in Tips and Constraints
-
-
Open Build Settings dialog from File > Build Settings
-
Configure settings
- Click Add Open Scene and make sure that SRDisplaySimpleSample is added in Scenes In Build
-
Make sure that Architecture is x86_64
-
Click Build and choose the folder where you want to save the app.
Unity will create an executable file in that folder. Click on that file and it will launch the content on the SR Display.