Show / Hide Table of Contents

    Class MixedRealityDiagnosticsSystem

    The default implementation of the IMixedRealityDiagnosticsSystem

    Inheritance
    Object
    BaseService
    BaseEventSystem
    BaseCoreSystem
    MixedRealityDiagnosticsSystem
    Implements
    IMixedRealityDiagnosticsSystem
    IMixedRealityEventSystem
    IMixedRealityService
    IDisposable
    IMixedRealityEventSource
    IEqualityComparer
    Inherited Members
    BaseCoreSystem.Registrar
    BaseEventSystem.enableDanglingHandlerDiagnostics
    BaseEventSystem.EventHandlersByType
    BaseEventSystem.EventListeners
    BaseEventSystem.HandleEvent<T>(BaseEventData, ExecuteEvents.EventFunction<T>)
    BaseEventSystem.RegisterHandler<T>(IEventSystemHandler)
    BaseEventSystem.UnregisterHandler<T>(IEventSystemHandler)
    BaseEventSystem.Register(GameObject)
    BaseEventSystem.Unregister(GameObject)
    BaseService.DefaultPriority
    BaseService.Name
    BaseService.Priority
    BaseService.ConfigurationProfile
    BaseService.Reset()
    BaseService.Enable()
    BaseService.Update()
    BaseService.LateUpdate()
    BaseService.Disable()
    BaseService.disposed
    BaseService.Dispose()
    BaseService.Dispose(Boolean)
    Object.ToString()
    Object.Equals(Object)
    Object.ReferenceEquals(Object, Object)
    Object.GetHashCode()
    Object.GetType()
    Object.MemberwiseClone()
    Namespace: Microsoft.MixedReality.Toolkit.Diagnostics
    Assembly: cs.temp.dll.dll
    Syntax
    public class MixedRealityDiagnosticsSystem : BaseCoreSystem, IMixedRealityDiagnosticsSystem, IMixedRealityEventSystem, IMixedRealityService, IDisposable, IMixedRealityEventSource, IEqualityComparer

    Constructors

    MixedRealityDiagnosticsSystem(IMixedRealityServiceRegistrar, MixedRealityDiagnosticsProfile)

    Declaration
    public MixedRealityDiagnosticsSystem(IMixedRealityServiceRegistrar registrar, MixedRealityDiagnosticsProfile profile)
    Parameters
    Type Name Description
    IMixedRealityServiceRegistrar registrar
    MixedRealityDiagnosticsProfile profile

    Properties

    DiagnosticsSystemProfile

    Typed representation of the ConfigurationProfile property.

    Declaration
    public MixedRealityDiagnosticsProfile DiagnosticsSystemProfile { get; }
    Property Value
    Type Description
    MixedRealityDiagnosticsProfile

    FrameSampleRate

    The amount of time, in seconds, to collect frames for frame rate calculation.

    Declaration
    public float FrameSampleRate { get; set; }
    Property Value
    Type Description
    Single

    ShowDiagnostics

    Enable / disable diagnostic display.

    Declaration
    public bool ShowDiagnostics { get; set; }
    Property Value
    Type Description
    Boolean
    Remarks

    When set to true, visibility settings for individual diagnostics are honored. When set to false, all visualizations are hidden.

    ShowFrameInfo

    Show or hide the frame info (per frame stats).

    Declaration
    public bool ShowFrameInfo { get; set; }
    Property Value
    Type Description
    Boolean

    ShowMemoryStats

    Show or hide the memory stats (used, peak, and limit).

    Declaration
    public bool ShowMemoryStats { get; set; }
    Property Value
    Type Description
    Boolean

    ShowProfiler

    Enable / disable the profiler display.

    Declaration
    public bool ShowProfiler { get; set; }
    Property Value
    Type Description
    Boolean

    SourceId

    The Unique Source Id of this Event Source.

    Declaration
    public uint SourceId { get; }
    Property Value
    Type Description
    UInt32

    SourceName

    The Name of this Event Source.

    Declaration
    public string SourceName { get; }
    Property Value
    Type Description
    String

    WindowAnchor

    What part of the view port to anchor the window to.

    Declaration
    public TextAnchor WindowAnchor { get; set; }
    Property Value
    Type Description
    TextAnchor

    WindowFollowSpeed

    How quickly to interpolate the window towards its target position and rotation.

    Declaration
    public float WindowFollowSpeed { get; set; }
    Property Value
    Type Description
    Single

    WindowOffset

    The offset from the view port center applied based on the window anchor selection.

    Declaration
    public Vector2 WindowOffset { get; set; }
    Property Value
    Type Description
    Vector2

    WindowScale

    Use to scale the window size up or down, can simulate a zooming effect.

    Declaration
    public float WindowScale { get; set; }
    Property Value
    Type Description
    Single

    Methods

    Destroy()

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

    Declaration
    public override void Destroy()
    Overrides
    BaseEventSystem.Destroy()

    Equals(Object, Object)

    Declaration
    public bool Equals(object x, object y)
    Parameters
    Type Name Description
    Object x
    Object y
    Returns
    Type Description
    Boolean

    GetHashCode(Object)

    Declaration
    public int GetHashCode(object obj)
    Parameters
    Type Name Description
    Object obj
    Returns
    Type Description
    Int32

    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
    public override void Initialize()
    Overrides
    BaseService.Initialize()

    Implements

    IMixedRealityDiagnosticsSystem
    IMixedRealityEventSystem
    IMixedRealityService
    System.IDisposable
    IMixedRealityEventSource
    IEqualityComparer
    Back to top Generated by DocFX