47 lines
1.5 KiB
C#
47 lines
1.5 KiB
C#
// Copyright (c) Microsoft Corporation.
|
|
// Licensed under the MIT License.
|
|
|
|
|
|
namespace Microsoft.MixedReality.Toolkit.Diagnostics
|
|
{
|
|
/// <summary>
|
|
/// The interface contract that defines the Diagnostics system in the Mixed Reality Toolkit
|
|
/// </summary>
|
|
public interface IMixedRealityDiagnosticsSystem : IMixedRealityEventSystem, IMixedRealityEventSource
|
|
{
|
|
/// <summary>
|
|
/// Typed representation of the ConfigurationProfile property.
|
|
/// </summary>
|
|
MixedRealityDiagnosticsProfile DiagnosticsSystemProfile { get; }
|
|
|
|
/// <summary>
|
|
/// Enable / disable diagnostic display.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// <para>When set to true, visibility settings for individual diagnostics are honored. When set to false,
|
|
/// all visualizations are hidden.</para>
|
|
/// </remarks>
|
|
bool ShowDiagnostics { get; set; }
|
|
|
|
/// <summary>
|
|
/// Enable / disable the profiler display.
|
|
/// </summary>
|
|
bool ShowProfiler { get; set; }
|
|
|
|
/// <summary>
|
|
/// Show or hide the frame info (per frame stats).
|
|
/// </summary>
|
|
bool ShowFrameInfo { get; set; }
|
|
|
|
/// <summary>
|
|
/// Show or hide the memory stats (used, peak, and limit).
|
|
/// </summary>
|
|
bool ShowMemoryStats { get; set; }
|
|
|
|
/// <summary>
|
|
/// The amount of time, in seconds, to collect frames for frame rate calculation.
|
|
/// </summary>
|
|
float FrameSampleRate { get; }
|
|
}
|
|
}
|