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.

    Show / Hide Table of Contents

    Mixed Reality Toolkit Packages

    The Microsoft Mixed Reality Toolkit is provided as a collection of packages. The contents of these packages is described in the following sections.

    • Foundation
    • Extensions
    • Tools
    • Providers.UnityAR
    • Examples

    Foundation

    The Microsoft.MixedRealityToolkit.Unity.Foundation package includes the core components required to create a mixed reality application.

    Folder Component Description
    MixedRealityToolkit Interface and type definitions, base classes, standard shader.
    MixedRealityToolkit.Providers
    ObjectMeshObserver Spatial awareness observer using a 3D model as the data.
    OpenVR Support for OpenVR devices.
    WindowsMixedReality Support for Windows Mixed Reality devices, including Microsoft HoloLens and immersive headsets.
    WindowsVoiceInput Support for speech and dicatation on Microsoft Windows platforms.
    MixedRealityToolkit.SDK
    Experimental Experimental features, including shaders, user interface controls and individual system managers.
    Features Functionality that builds upon the Foundation package.
    Profiles Default profiles for the Microsoft Mixed Reality Toolkit systems and services.
    StandardAssets Common assets; models, textures, materials, etc.
    MixedRealityToolkit.Services
    BoundarySystem System implementing VR boundary support.
    CameraSystem System implementing camera configuration and management.
    DiagnosticsSystem System implementing in application diagnostics, for example a visual profiler.
    InputAnimation Support for recording head movement and hand tracking data.
    InputSimulation Support for in-editor simulation of hand and eye input.
    InputSystem System providing support for accessing and handling user input.
    SceneSystem System providing multi-scene application support.
    SpatialAwarenessSystem System providing support for awareness of the user's environment.
    TeleportSystem System providing support for teleporting (moving about the experience in jumps).

    Extensions

    The optional Microsoft.MixedRealityToolkit.Unity.Extensions package includes additional services that extend the functionality of the Microsoft Mixed Reality Toolkit.

    Note

    The extensions package requires Microsoft.MixedRealityToolkit.Unity.Foundation.

    Folder Component Description
    MixedRealityToolkit.Extensions
    LostTrackingService Service that simplifies handing of tracking loss on Microsoft HoloLens devices.
    SceneTransitionService Service that simplifies adding smooth scene transitions.

    Tools

    The optional Microsoft.MixedRealityToolkit.Unity.Tools package includes helpful tools that enhance the mixed reality development experience using the Microsoft Mixed Reality Toolkit. These tools are located in the Mixed Reality Toolkit > Utilities menu in the Unity Editor.

    Note

    The tools package requires Microsoft.MixedRealityToolkit.Unity.Foundation.

    Folder Component Description
    MixedRealityToolkit.Tools
    DependencyWindow Tool that creates a dependency graph of assets in a project.
    ExtensionServiceCreator Wizard to assist in creating extension services.
    OptimizeWindow Utility to help automate configuring a mixed reality project for the best performance in Unity.
    ReserializeAssetsUtility Provides support for reserializing specific Unity files.
    RuntimeTools/Tools/ControllerMappingTool Utility enabling developers to quickly determine Unity mappings for hardware controllers.
    ScreenshotUtility Enables capturing application images in the Unity editor.
    TextureCombinerWindow Utility to combine graphics textures.

    Providers.UnityAR

    Note

    The UnityAR package requires Microsoft.MixedRealityToolkit.Unity.Foundation.

    Folder Component Description
    MixedRealityToolkit.Staging
    UnityAR Camera settings provider enabling MRTK use with mobile AR devices.

    Examples

    The optional Microsoft.MixedRealityToolkit.Unity.Examples package includes demonstration projects that illustrate the features of the Microsoft Mixed Reality Toolkit.

    Note

    The examples package requires Microsoft.MixedRealityToolkit.Unity.Foundation.

    Folder Component Description
    MixedRealityToolkit.Examples
    Demos Simple scenes illustrating one or two related features.
    Experimental Demo scenes illustrating experimental features.
    Inspectors Unity Editor inspectors used by demo scenes.
    StandardAssets Common assets shared by multiple demo scenes.

    See Also

    Getting Started with the MRTK

    • Improve this Doc
    Back to top Generated by DocFX