Show / Hide Table of Contents

    Interface IMixedRealityService

    Generic interface for all Mixed Reality Services

    Inherited Members
    IDisposable.Dispose()
    Namespace: Microsoft.MixedReality.Toolkit
    Assembly: cs.temp.dll.dll
    Syntax
    public interface IMixedRealityService : IDisposable

    Properties

    ConfigurationProfile

    The configuration profile for the service.

    Declaration
    BaseMixedRealityProfile ConfigurationProfile { get; }
    Property Value
    Type Description
    BaseMixedRealityProfile
    Remarks

    Many services may wish to provide a typed version (ex: MixedRealityInputSystemProfile) that casts this value for ease of use in calling code.

    Name

    Optional Priority attribute if multiple services of the same type are required, enables targeting a service for action.

    Declaration
    string Name { get; }
    Property Value
    Type Description
    String

    Priority

    Optional Priority to reorder registered managers based on their respective priority, reduces the risk of race conditions by prioritizing the order in which managers are evaluated.

    Declaration
    uint Priority { get; }
    Property Value
    Type Description
    UInt32

    Methods

    Destroy()

    Optional Destroy function to perform cleanup of the service before the Mixed Reality Toolkit is destroyed.

    Declaration
    void Destroy()

    Disable()

    Optional Disable function to pause the service.

    Declaration
    void Disable()

    Enable()

    Optional Enable function to enable / re-enable the service.

    Declaration
    void Enable()

    Initialize()

    The initialize function is used to setup the service once created. This method is called once all services have been registered in the Mixed Reality Toolkit.

    Declaration
    void Initialize()

    LateUpdate()

    Optional LateUpdate function to that is called after Update has been called on all services.

    Declaration
    void LateUpdate()

    Reset()

    Optional Reset function to perform that will Reset the service, for example, whenever there is a profile change.

    Declaration
    void Reset()

    Update()

    Optional Update function to perform per-frame updates of the service.

    Declaration
    void Update()
    Back to top Generated by DocFX