MixedRealityDiagnosticsSystem Class

Definition

The default implementation of the IMixedRealityDiagnosticsSystem

public ref class MixedRealityDiagnosticsSystem : Microsoft::MixedReality::Toolkit::BaseCoreSystem, IDisposable, Microsoft::MixedReality::Toolkit::Diagnostics::IMixedRealityDiagnosticsSystem, System::Collections::IEqualityComparer
[UnityEngine.HelpURL("https://docs.microsoft.com/windows/mixed-reality/mrtk-unity/features/diagnostics/diagnostics-system-getting-started")]
public class MixedRealityDiagnosticsSystem : Microsoft.MixedReality.Toolkit.BaseCoreSystem, IDisposable, Microsoft.MixedReality.Toolkit.Diagnostics.IMixedRealityDiagnosticsSystem, System.Collections.IEqualityComparer
[<UnityEngine.HelpURL("https://docs.microsoft.com/windows/mixed-reality/mrtk-unity/features/diagnostics/diagnostics-system-getting-started")>]
type MixedRealityDiagnosticsSystem = class
    inherit BaseCoreSystem
    interface IMixedRealityDiagnosticsSystem
    interface IMixedRealityEventSystem
    interface IMixedRealityService
    interface IDisposable
    interface IMixedRealityEventSource
    interface IEqualityComparer
Public Class MixedRealityDiagnosticsSystem
Inherits BaseCoreSystem
Implements IDisposable, IEqualityComparer, IMixedRealityDiagnosticsSystem
Inheritance
MixedRealityDiagnosticsSystem
Attributes
UnityEngine.HelpURLAttribute
Implements

Constructors

MixedRealityDiagnosticsSystem(IMixedRealityServiceRegistrar, MixedRealityDiagnosticsProfile)
Obsolete.

Constructor.

MixedRealityDiagnosticsSystem(MixedRealityDiagnosticsProfile)

Constructor.

Fields

DefaultPriority (Inherited from BaseService)
disposed

Value indicating if the object has completed disposal.

(Inherited from BaseService)

Properties

ConfigurationProfile

The configuration profile for the service.

(Inherited from BaseService)
DiagnosticsSystemProfile

Typed representation of the ConfigurationProfile property.

EventHandlersByType

List of all event handlers grouped by type that are registered to this Event System.

(Inherited from BaseEventSystem)
EventListeners

List of event listeners that are registered to this Event System.

(Inherited from BaseEventSystem)
FrameSampleRate

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

IsEnabled

Indicates whether or not the service is currently enabled.

(Inherited from BaseService)
IsInitialized

Indicates whether or not the service has been initialized.

(Inherited from BaseService)
IsMarkedDestroyed

Indicates whether or not the Destroy method been called on this service.

(Inherited from BaseService)
Name

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

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.

(Inherited from BaseService)
Registrar
Obsolete.

The service registrar instance that registered this service.

(Inherited from BaseCoreSystem)
ShowDiagnostics

Enable / disable diagnostic display.

ShowFrameInfo

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

ShowMemoryStats

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

ShowProfiler

Enable / disable the profiler display.

ShowProfilerDuringMRC

If the diagnostics profiler should be visible while a mixed reality capture is happening on HoloLens.

SourceId

The unique source id of this event source.

SourceName

The name of this event source.

WindowAnchor

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

WindowFollowSpeed

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

WindowOffset

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

WindowScale

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

Methods

Destroy()

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

Disable()

Optional Disable function to pause the service.

(Inherited from BaseService)
Dispose()

Cleanup resources used by this object.

(Inherited from BaseService)
Dispose(Boolean)

Cleanup resources used by the object

(Inherited from BaseService)
Enable()

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

(Inherited from BaseService)
Equals(Object, Object)

Determines whether the specified objects are equal.

GetHashCode(Object)

Returns a hash code for the specified object.

HandleEvent<T>(BaseEventData, ExecuteEvents.EventFunction)

The main function for handling and forwarding all events to their intended recipients.

(Inherited from BaseEventSystem)
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.

LateUpdate()

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

(Inherited from BaseService)
Register(GameObject)

Registers a GameObject to listen for events from this Event System.

(Inherited from BaseEventSystem)
RegisterHandler<T>(IEventSystemHandler)

Registers the given handler as a global listener for all events handled via the T interface. T must be an interface type, not a class type, derived from IEventSystemHandler.

(Inherited from BaseEventSystem)
Reset()

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

(Inherited from BaseService)
Unregister(GameObject)

Unregisters a GameObject from listening for events from this Event System.

(Inherited from BaseEventSystem)
UnregisterHandler<T>(IEventSystemHandler)

Unregisters the given handler as a global listener for all events handled via the T interface. T must be an interface type, not a class type, derived from IEventSystemHandler.

(Inherited from BaseEventSystem)
Update()

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

(Inherited from BaseService)

Applies to