Class MixedRealityDiagnosticsSystem
The default implementation of the IMixedRealityDiagnosticsSystem
Implements
Inherited Members
Namespace: Microsoft.MixedReality.Toolkit.Diagnostics
Assembly: cs.temp.dll.dll
Syntax
public class MixedRealityDiagnosticsSystem : BaseCoreSystem, IMixedRealityDiagnosticsSystem, IMixedRealityEventSystem, IMixedRealityService, IDisposable, IMixedRealityEventSource, IEqualityComparer
Constructors
MixedRealityDiagnosticsSystem(MixedRealityDiagnosticsProfile)
Constructor.
Declaration
public MixedRealityDiagnosticsSystem(MixedRealityDiagnosticsProfile profile)
Parameters
Type | Name | Description |
---|---|---|
MixedRealityDiagnosticsProfile | profile | The configuration profile for the service. |
MixedRealityDiagnosticsSystem(IMixedRealityServiceRegistrar, MixedRealityDiagnosticsProfile)
Constructor.
Declaration
[Obsolete("This constructor is obsolete (registrar parameter is no longer required) and will be removed in a future version of the Microsoft Mixed Reality Toolkit.")]
public MixedRealityDiagnosticsSystem(IMixedRealityServiceRegistrar registrar, MixedRealityDiagnosticsProfile profile)
Parameters
Type | Name | Description |
---|---|---|
IMixedRealityServiceRegistrar | registrar | The IMixedRealityServiceRegistrar instance that loaded the service. |
MixedRealityDiagnosticsProfile | profile | The configuration profile for the service. |
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 |
Name
Optional Priority attribute if multiple services of the same type are required, enables targeting a service for action.
Declaration
public override string Name { get; protected set; }
Property Value
Type | Description |
---|---|
String |
Overrides
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 |
ShowProfilerDuringMRC
If the diagnostics profiler should be visible while a mixed reality capture is happening on HoloLens.
Declaration
public bool ShowProfilerDuringMRC { get; set; }
Property Value
Type | Description |
---|---|
Boolean |
Remarks
This is not usually recommended, as MRC can have an effect on an app's frame rate.
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
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()