Class MixedRealityDiagnosticsSystem

The default implementation of the IMixedRealityDiagnosticsSystem

Inheritance
Object
BaseService
BaseEventSystem
BaseCoreSystem
MixedRealityDiagnosticsSystem
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(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.

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

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

DiagnosticsSystemProfile

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

FrameSampleRate

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

FrameSampleRate

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

Name

Declaration
public override string Name { get; protected set; }
Property Value
Type Description
String
Overrides

Name

Declaration
public override string Name { get; protected set; }
Property Value
Type Description
String
Overrides

ShowDiagnostics

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

ShowDiagnostics

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

ShowFrameInfo

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

ShowFrameInfo

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

ShowMemoryStats

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

ShowMemoryStats

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

ShowProfiler

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

ShowProfiler

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

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

SourceId

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

SourceName

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

SourceName

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

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

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

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

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()

Declaration
public override void Destroy()
Overrides

Destroy()

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

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

GetHashCode(Object)

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

Initialize()

Declaration
public override void Initialize()
Overrides

Initialize()

Declaration
public override void Initialize()
Overrides

Implements

IDisposable
IEqualityComparer