The Microsoft OpenXR plugin is an Unreal Engine game plugin which provides additional features available on Microsoft's Mixed Reality devices like the HoloLens 2 when using OpenXR. OpenXR is an open royalty-free API standard from Khronos that provides engines with native access to a wide range of devices from vendors across the mixed reality spectrum. While Unreal Engine supports OpenXR natively, some additional functionality specific to Microsoft's Mixed Reality platforms is only available through this plugin.
| NOTE: The Microsoft OpenXR plugin requires Unreal 4.26.0+. |
|---|
Unreal Engine 4.26 with OpenXR provides the following built-in functionality:
- Eye tracking
- Hand joint tracking
- Hand and controller input action mapping
The Microsoft OpenXR plugin provides the following additional functionality:
- Keyboard input routing
- Dynamic hand mesh rendering
- Spatial anchoring
- Holographic Remoting from the PC
- Photo/Video (PV) camera access
- QR code tracking
- Spatial mapping providing a mesh of the physical world
- Voice input
If you're new to Mixed Reality development in Unreal, visit the Unreal development journey in the Microsoft Docs. The Unreal development journey is specifically tailored to walk new developers through the installation, core concepts, and usage of the Microsoft OpenXR plugin.
- Download the Microsoft OpenXR plugin from the release page.
- If you have a Blueprint-only project then you will need to convert it to a C++ project. This can be done in the editor by going to File -> Add C++ Class, selecting "None" and creating the class with the default settings.
- Extract the contents of the packaged Microsoft OpenXR plugin to [YourUnrealProjectRoot]/Plugins. The Plugins folder should be located at the root of your project, where the .uproject file is. Create it if it doesn't exist.
- If you are building the editor from Visual Studio, regenerate the Visual Studio solution file.
Coming soon!
This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.
When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.
This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.