Graphics Tools for Unreal Engine is a UE game plugin with code, blueprints and example assets created to help improve the visual fidelity of Mixed Reality applications while staying within performance budgets.
| NOTE: Only HoloLens 2, Windows, and Android development is tested at the moment. If you encounter issues with other platforms please file an issue. |
|---|
If you're new to MRTK or Mixed Reality development in Unreal, we recommend starting at the beginning of our 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 Unreal Engine for Mixed Reality.
If you're already familiar with Mixed Reality development in Unreal, you can find the installation instructions for the Graphics Tools plugin here.
 Windows SDK 18362+ |
 Unreal 5.0.0+ |
 Visual Studio 2019 |
|---|---|---|
| To build apps with MRTK-Unreal and Graphics Tools, you need the Windows 10 May 2019 Update SDK | The Unreal Engine provides support for building Mixed Reality projects in Windows 10 | Visual Studio is used for code editing |
 Lighting |
 Proximity Lights |
 Effects |
|---|---|---|
| Physically based lighting technique optimized for Mixed Reality | A custom light type used to demonstrate distance to surface | Common graphics effects utilized in Mixed Reality |
 Clipping Primitives |
 Profiling |
 Spatial Perception |
| Tools to dynamically slice away a mesh and peer inside the geometry | Explore profiling techniques and tools useful for Mixed Reality development | Techniques that create visually compelling materials for real world geometry |
 Mesh Outlines |
||
| Editor and runtime components to render an outline around a static mesh |
If you want to explore the different Graphics Tools features or want a reference for how to use them, we recommend having a look at the example levels contained in the Graphics Tools Examples plugin (/GraphicsToolsProject/Plugins/GraphicsToolsExamples). You can copy the examples plugin (along with the GraphicsTools plugin) into the 'Plugins' subfolder of your own project or you can simply try out the Graphics Tools Project (/GraphicsToolsProject) in this repository. For that you should:
- Clone this repository.
- Checkout the latest 'public/version.x' branch.
- Bear in mind that this branch is alive. It's not a release, and will be updated regularly with potentially breaking changes. There will be a release tag (e.g. release/0.4.0) marked as such in GitHub.
You can now open the Graphics Tools Project (/GraphicsToolsProject) and explore individual example levels or open the Loader level to access some of the examples from a centralized hub. You can also copy the examples (/GraphicsToolsProject/Plugins/GraphicsToolsExamples) into the 'Plugins' folder in your own project and use the pre-made elements as a base for your own Mixed Reality experience.
Please note that the example content might change significantly between releases. Please make sure to always run the examples with a matching version of the Graphics Tools Plugin as there might be breaking changes in the example code.
We also provide the Graphics Tools Project (/GraphicsToolsProject) pre-packaged for HoloLens 2 so you can try out the main features directly on device easily. To use it:
- Obtain the packaged game from the latest release page (e.g. GTProject-HoloLens.0.4.0.zip) and unzip it to a local directory.
- Install it in the device via the Device Portal.
 |
||
|---|---|---|
| Webinar showing how to build a product configurator using Graphics Tools |
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.opensource.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., status check, 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.