mrtk_developmentreleases/2.0.0releases/2.1.0releases/2.2.0releases/2.3.0releases/2.4.0releases/2.5.0releases/2.5.1releases/2.5.2releases/2.5.3
  • Features and Architecture
  • API Documentation

We've moved!

Starting from MRTK 2.6, we are publishing both conceptual docs and API references on docs.microsoft.com. For conceptual docs, please visit our new landing page. For API references, please visit the MRTK-Unity section of the dot net API explorer. Existing content will remain here but will not be updated further.

  • Features and Architecture
  • Welcome to MRTK
  • Packages and Release Notes
  • Release Notes
Search Results for

    Show / Hide Table of Contents
    • Welcome to MRTK
      • Installation Guide
      • Configuration
        • Using the Unity Package Manager
        • MRTK configuration dialog
        • Getting started with MRTK and XR SDK
      • Updates and Deployment
        • Updating from earlier versions
        • Upgrading from HTK
        • Building and Deploying MRTK
      • Packages and Release Notes
        • Release Notes
        • MRTK Packages
      • Performance and Best Practices
        • Performance
        • Hologram Stabilization
        • Using MRTK in large projects
    • Architecture
      • Overview
      • Framework and Runtime
      • Input System
        • Terminology
        • Core System
        • Controllers, Pointers, and Focus
      • Systems, Extension Services and Data Providers
    • Feature Overviews
      • Boundary System
        • Boundary System Overview
        • Configuring the Boundary Visualization
      • Camera System
        • Camera System Overview
        • Camera Settings Providers
          • Windows Mixed Reality Camera Settings
          • Unity AR Camera Settings [Experimental]
          • Creating a camera settings provider
      • Cross Platform Support
        • Configure MRTK for iOS and Android
        • Configure MRTK for Leap Motion Hand Tracking
        • Configure MRTK for Oculus Quest
      • Detecting Platform Capabilities
      • Diagnostics System
        • Diagnostics System Overview
        • Configuring the Diagnostics System
        • Using the Visual Profiler
      • Extension Services
        • Extension Service Creation Wizard
        • Scene Transition Service Overview
        • Hand Physics Service Overview
      • Input System
        • Input Overview
        • Input Actions
        • Input Events
        • Input Providers
          • Input Providers Overview
          • Creating an input data provider
        • Controllers
        • Eyes
          • Overview
          • Getting Started
          • Access Data via Code
          • Validate Tracking Calibration
        • Gaze
        • Gestures
        • Hands
        • How to Add Near Interaction
        • In-Editor Input Simulation
        • Pointers
        • Voice Input
          • Dictation
          • Speech (Command and Control)
      • Multi Scene System
        • Multi Scene System Overview
        • Scene Types
        • Content Scene Loading
        • Monitoring Content Loading
        • Lighting Scene Operations
      • Packaging
        • MRTK Packages
        • MRTK Modularization
      • Profiles
        • Profiles Overview
        • Configuration Guide
      • Rendering
        • MRTK Standard Shader
        • Material Instance Overview
        • Hover Light Overview
        • Proximity Light Overview
        • Clipping Primitive Overview
      • Services
        • What makes a mixed reality feature
        • What are the MixedRealityServiceRegistry and IMixedRealityServiceRegistrar
        • Extension services
      • Spatial Awareness System
        • Spatial Awareness Overview
        • Spatial Observers
          • Configuring Observers for Device
          • Configuring Observers for Editor
          • Controlling Observers via Code
          • Creating a custom Observer
      • Teleport System Overview
      • Tools
        • Dependency Window
        • Extension Service Creation Wizard
        • Holographic Remoting
        • Input Animation Recording
          • Input Animation File Format Specification
        • Migration Window
        • Optimize Window
        • Runtime tools
          • Controller Mapping tool
          • InputFeatureUsage tool
      • UX Building Blocks
        • Toolbox Window
        • Button
        • Bounds Control
        • Object Manipulator
        • Constraint Manager
        • Slate
        • System Keyboard
        • Interactable
        • Solvers
          • Tap to Place
        • Object Collection
        • Scrolling Object Collection
        • Tooltips
        • Slider
        • Hand Menu
        • Near Menu
        • App Bar
        • Fingertip Visualization
        • Progress Indicator
        • Dialog [Experimental]
        • Hand Coach [Experimental]
        • Pulse Shader [Experimental]
        • Dock Control [Experimental]
        • HoloLens Keyboard Helpers [Experimental]
        • Rigged Hand Visualizer [Experimental]
        • Elastic System [Experimental]
        • Bounding Box [Obsolete]
        • Manipulation Handler [Obsolete]
      • Example Scenes
        • Examples Hub
        • Hand Interaction Example
        • Eye Tracking Interaction Example
    • Contributing
      • Contributing Overview
      • Coding Guidelines
      • Writing and Running Tests
      • Writing Documentation
      • Pull Requests
      • Experimental Features
      • Breaking Changes
      • How to use DocFX
    • Planning
      • Roadmap
    • Notice
    • Authors

    Microsoft Mixed Reality Toolkit 2.5.4 release notes

    • What's new
    • Updating guidance
    • Known issues
    Important

    There is a known compiler issue that impacts applications built for Microsoft HoloLens 2 using ARM64. This issue is fixed by updating Visual Studio 2019 to version 16.8 or later. If you are unable to update Visual Studio, please import the com.microsoft.mixedreality.toolkit.tools package to apply a workaround.

    What's new

    Fixes a bug with Oculus Integration when using UPM

    When using UPM, the OculusXRSDKDeviceManagerProfile would always have its prefabs set to None on startup. This release configures the Device Manager to point to a working set of prefabs on startup.

    Fixes an issue with OpenXR via UPM

    Fixes an issue where the OpenXR providers weren't added to the link.xml by default, causing new projects to fail to run on-device when using OpenXR and MRTK via Unity's Package Manager. Existing projects that are upgraded will still need this added manually.

    What was new in 2.5.3

    Fixes a regression with Oculus introduced in 2.5.2

    2.5.2 introduced a build issue when integrating the Oculus SDK. This release reverts that issue.

    Add support for OpenXR

    Initial support for Unity's OpenXR preview package and Microsoft's Mixed Reality OpenXR package has been added. See the MRTK/XRSDK getting started page, Unity's forum post, or Microsoft's documentation for more information.

    Important

    OpenXR in Unity is only supported on Unity 2020.2 and higher.

    Currently, it also only supports x64 and ARM64 builds.

    Boundary visualization errors fixed

    Boundary visualizations, like the floor or walls, will now be properly configured and visible at runtime according to the boundary profile.

    MSBuild for Unity support

    Support for MSBuild for Unity has been removed as of the 2.5.2 release, to align with Unity's new package guidance.

    Known issues

    OpenXR

    There's currently a known issue with Holographic Remoting and OpenXR, where hand joints aren't consistently available. Additionally, the eye tracking sample scenes aren't currently compatible, though eye tracking does work.

    Some Mixed Reality Toolkit Standard Shader features require the Foundation package

    When imported via the Unity Package Manager, the MRTK Standard Shader utilities scripts (ex: HoverLight.cs) are not co-located with the shader in the Standard Assets package. To access this functionality, applications will require the Foundation package to be imported.

    CameraCache may create a new camera on shutdown

    In some situations (e.g. when using the LeapMotion provider in the Unity Editor), it is possible for the CameraCache to re-create the MainCamera on shutdown. Please see this issue for more information.

    FileNotFoundException when examples are imported via Unity Package Manager

    Depending on the length of the project path, importing examples via Unity Package Manager may generate FileNotFoundException messages in the Unity Console. The cause of this is the path to the "missing" file being longer than MAX_PATH (256 characters). To resolve, please shorten the length of the project path.

    No spatializer was specified. The application will not support Spatial Sound

    A "No spatializer was specified" warning will appear if an audio spatializer is not configured. This can occur if no XR package is installed, as Unity includes spatializers in these packages.

    To resolve, please ensure that:

    • Window > Package Manager has one or more XR packages installed

    • Mixed Reality Toolkit > Utilities > Configure Unity Project and make a selection for Audio Spatializer

      Select Audio Apatializer

    NullReferenceException: Object reference not set to an instance of an object (SceneTransitionService.Initialize)

    In some situations, opening EyeTrackingDemo-00-RootScene may cause a NullReferenceException in the Initialize method of the SceneTransitionService class. This error is due to the Scene Transition Service's configuration profile being unset. To resolve, please use the following steps:

    • Navigate to the MixedRealityToolkit object in the Hierarchy
    • In the Inspector window, select Extensions
    • If not expanded, expand Scene Transition Service
    • Set the value of Configuration Profile to MRTKExamplesHubSceneTransitionServiceProfile

    Oculus Quest

    There is currently a known issue for using the Oculus XR plugin with when targeting Standalone platforms. Check the Oculus bug tracker/forums/release notes for updates.

    The bug is signified with this set of 3 errors:

    Oculus XR Plugin Error

    UnityUI and TextMeshPro

    There's a known issue for newer versions of TextMeshPro (1.5.0+ or 2.1.1+), where the default font size for dropdowns and bold font character spacing has been altered.

    TMP image

    This can be worked around by downgrading to an earlier version of TextMeshPro. See issue #8556 for more details.

    • Improve this Doc
    In This Article
    • What's new
      • Fixes a bug with Oculus Integration when using UPM
      • Fixes an issue with OpenXR via UPM
    • What was new in 2.5.3
      • Fixes a regression with Oculus introduced in 2.5.2
      • Add support for OpenXR
      • Boundary visualization errors fixed
      • MSBuild for Unity support
    • Known issues
      • OpenXR
      • Some Mixed Reality Toolkit Standard Shader features require the Foundation package
      • CameraCache may create a new camera on shutdown
      • FileNotFoundException when examples are imported via Unity Package Manager
      • No spatializer was specified. The application will not support Spatial Sound
      • NullReferenceException: Object reference not set to an instance of an object (SceneTransitionService.Initialize)
      • Oculus Quest
      • UnityUI and TextMeshPro
    Back to top Generated by DocFX