Pages in Documentation

../images/architecture/2024/door-settings/thumbs/03.jpg
Settings
../images/architecture/2023/ui32/thumbs/01.jpg
UI3 Overview
../images/architecture/2022/doorsv2/thumbs/01.jpg
[old] Doors UE5
../images/architecture/0040/quick/thumbs/01.jpg
Quick Start
../images/architecture/0040/swap/thumbs/01.jpg
Swap Actor
../images/architecture/0040/custom/thumbs/04.jpg
Custom Assets
../images/architecture/0040/system/thumbs/01.jpg
System Drawings
../images/architecture/0040/steps/thumbs/12.jpg
Step by Step
../images/architecture/0040/faq/thumbs/01.jpg
Tips & FAQ
../images/architecture/0040/settings/thumbs/03.jpg
Settings
../images/architecture/0033/designer/thumbs/02.jpg
UI3 Designer
../images/architecture/0033/cost/thumbs/02.jpg
UI3 Cost
../images/architecture/0033/features/thumbs/08.jpg
UI3 Features
../images/architecture/0033/quick/thumbs/01.jpg
UI3 Quick Guide
../images/architecture/0033/settings/thumbs/16d.jpg
UI3 Scene Settings
../images/architecture/0033/connect/thumbs/02.jpg
UI3 Connect
../images/architecture/0033/vr/thumbs/03.jpg
UI3 VR projects
../images/architecture/0033/history/thumbs/01.jpg
UI3 Vers History
../images/architecture/0033/preview/thumbs/01.jpg
UI3 Preview Ft.
../images/architecture/0033/bugs/thumbs/01m.jpg
UI3 Fix Bugs
../images/architecture/0033/design/thumbs/01t.jpg
UI3 Design
../images/architecture/0033/layout/thumbs/02.jpg
UI3 Layout Design
../images/architecture/0033/game/thumbs/07.jpg
UI3 Input&Mode
../images/architecture/0033/faq/thumbs/08.jpg
UI3 FAQ + TIPS
../images/architecture/0023/history/thumbs/02.jpg
Ver History
../images/architecture/0023/v3-placements/thumbs/02.jpg
V3 Placements
../images/architecture/0023/v3-mesh/thumbs/02.jpg
V3 Mesh Def.
../images/architecture/0023/v3-segments/thumbs/03.jpg
V3 Segments
../images/architecture/0023/v3-quick/thumbs/01.jpg
V3 Quick Start
../images/architecture/0021/v2/thumbs/01.jpg
Books V2
../images/architecture/0021/v1/thumbs/01.jpg
Books V1
../images/architecture/0019/custom/thumbs/01h.jpg
Customize
../images/architecture/0019/overview/thumbs/00b.jpg
Quick Guide
../images/architecture/0019/swap/thumbs/01.jpg
Swap Actor
../images/architecture/0019/faq/thumbs/01.jpg
Doors FAQ
../images/architecture/0019/v2/thumbs/01.jpg
Doors UE4 (V1)
../images/architecture/2021/ui3-bugs/thumbs/02.jpg
3.1 Bugs Fixes
../images/architecture/0040/history/thumbs/02.jpg
Ver History
../images/architecture/0023/v2-generic/thumbs/01.jpg
V2 Generic BP
../images/architecture/0023/v2-examples/thumbs/01.jpg
V2 Examples
../images/architecture/0023/v1/thumbs/01.jpg
V1 Railings Fences
../images/architecture/2019/guide1/thumbs/01.jpg
UI 1 - Part 1
../images/architecture/2018/03/thumbs/06.jpg
UI 1
../images/architecture/2019/guide2/thumbs/01.jpg
Ui 1 - Part 2
../images/architecture/2019/ui2/thumbs/01.jpg
1 Overview
../images/architecture/0013/features/thumbs/04.jpg
UI2 Features
../images/architecture/0013/start/thumbs/01.jpg
UI2 Get Started
../images/architecture/0013/infomap/thumbs/06.jpg
UI2 Info Map
../images/architecture/0013/actors/thumbs/01.jpg
UI2 BP Actors
../images/architecture/0013/users/thumbs/01.jpg
UI2 User Manager
../images/architecture/0013/faq/thumbs/03.jpg
UI2 FAQ
../images/architecture/0013/tutorials/thumbs/06.jpg
UI2 Tutorials
../images/architecture/2021/ui3/thumbs/01.jpg
UI3 Overview
../images/architecture/2021/ui3-start/thumbs/02.jpg
UI3 Get Started
../images/architecture/2021/ui3-infomap/thumbs/02.jpg
3.1 Info Map
../images/architecture/0033/variation/thumbs/01.jpg
UI3 Variations
../images/architecture/0033/other/thumbs/02.jpg
UI3 Other BPs

UI3 In VR Projects

This will give you a brief overview of what is required to run the UI3 with a VR headset.

The demo project is optimised for PC and may run poorly in some VR environments. Your project needs to be performing well if you want to use it in VR!

This is not a complete guide for VR in Unreal Engine. Follow the links provided for better guides.

Unreal Documentation - XR Best Practices

Content:

Installing Your VR Headset

Test Your Project

Oculus Quest Headsets

Steam VR and HTC Vive

VR Game Mode

Settings in the Info Map

Tablet Widget Issues

Simulating Input Controls

OpenXR Plugin

[legacy] VR Headset Tracking Origin (3.1)

Test Your Project

Make sure the project you are trying to use with a VR headset is working in standard PC mode before trying it with your VR headset.
  • The new Usage Preset - VR in the Info Map will apply a few settings that improve performance. Screen Percentage is set to 65% and the Quality is set to "Medium".
  • It has to run with at least 45 or better 90 fps. The image shows 33ms. 1000ms/33ms=30 frames per second for the demo project on my laptop. That would be not good enough.
  • Use the console command ~ stat unit to see what is hitting your performance. The lower the time in milliseconds the better. Green values are ok for 30 fps. Game shows blueprints and UI, which is less than 2 ms. Draw shows the time the geometry needs to be rendered per frame.
  • Run other apps, preferable Unreal Engine apps to test your hardware.

VR development can be difficult, and optimization is an important skill you'll need for it. You can come a long way by

  • The Default Game Settings of the sliders will be applied when the game starts. This only works in a packaged version. You can further reduce the defaults there.
  • Disabling Ray-traced reflections, less bounces, or reduce reflection quality in your post process volumes.
  • Using Lumen with default settings
  • Using Nanite meshes especially for high polygon assets

FAQ: Debugging, Optimization, Profiling

image

image

Steam VR and HTC Vive

Steam VR supports HTC Vive, Oculus Rift and other headsets. There is a good chance that your headset is supported by Steam VR, if it isn't one of the major headset brands. It's well suited for Unreal Engine projects.

Quick Start for Steam VR with Unreal Engine 5.4

image

image

image

image

image

VR Game Mode

The game mode needs to be set to the SDotUI3_GamemodeVR. Open the world settings of your persistent (main) level. Choose the game mode from the list of Game Mode Overrides as seen in the image and save the level.

You should see the virtual tablet next time you play your project in the editor preview with the UI items on it.

The demo project contains the level UI3_PersistentVR that is set up to be used for VR.

image

Simulating Input Controls

You need a game controller to navigate through the menu items on the tablet. You can simulate the controller buttons on the keyboard as seen in the image.

[ENTER] could be replaced with [SPACE] for select in some UI3 versions

image

OpenXR Plugin

The OpenXR plugin is added to the Demo Project by default. Every Game Mode contains a node from it to either enable or disable the Head Mounted Display (HMD) VR headset. This allows the player to travel from a non-VR to a VR enabled scene within the same application.

If you are getting compile errors then check if the OpenXR plugin is enabled in the plugin settings.

Some headsets are not compatible with the OpenXR plugin, In this case you need to remove all Enable HDM nodes from all SDotUI3 game modes. You will need to find the node that enables your headset supplied by the plugin for your headset and connect it to the Begin Play node of the SDotUI3 GamemodeVR.

image

image

image

image
Top of page