mrtk_developmentreleases/2.0.0releases/2.1.0releases/2.2.0

    Show / Hide Table of Contents

    Class MixedRealityDiagnosticsProfile

    Configuration profile settings for setting up diagnostics.

    Inheritance
    Object
    BaseMixedRealityProfile
    MixedRealityDiagnosticsProfile
    Implements
    ScriptableObject
    Namespace: Microsoft.MixedReality.Toolkit.Diagnostics
    Assembly: cs.temp.dll.dll
    Syntax
    public class MixedRealityDiagnosticsProfile : BaseMixedRealityProfile, ScriptableObject

    Properties

    DefaultInstancedMaterial

    A material that the diagnostics system can use to render objects with instanced color support. A asset reference is required here to make sure the shader permutation is pulled into player builds.

    Declaration
    public Material DefaultInstancedMaterial { get; }
    Property Value
    Type Description
    Material

    DefaultInstancedMaterial

    A material that the diagnostics system can use to render objects with instanced color support. A asset reference is required here to make sure the shader permutation is pulled into player builds.

    Declaration
    public Material DefaultInstancedMaterial { get; }
    Property Value
    Type Description
    Material

    FrameSampleRate

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

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

    FrameSampleRate

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

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

    ShowDiagnostics

    Show or hide diagnostic visualizations.

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

    ShowDiagnostics

    Show or hide diagnostic visualizations.

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

    ShowFrameInfo

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

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

    ShowFrameInfo

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

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

    ShowMemoryStats

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

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

    ShowMemoryStats

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

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

    ShowProfiler

    Show or hide the profiler UI.

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

    ShowProfiler

    Show or hide the profiler UI.

    Declaration
    public bool ShowProfiler { get; }
    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; }
    Property Value
    Type Description
    Boolean
    Remarks

    This is not usually recommended, as MRC can have an effect on an app's frame rate.

    WindowAnchor

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

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

    WindowAnchor

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

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

    WindowFollowSpeed

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

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

    WindowFollowSpeed

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

    Declaration
    public float WindowFollowSpeed { get; }
    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; }
    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; }
    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; }
    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; }
    Property Value
    Type Description
    Single

    Implements

    ScriptableObject
    In This Article
    • Properties
      • DefaultInstancedMaterial
      • DefaultInstancedMaterial
      • FrameSampleRate
      • FrameSampleRate
      • ShowDiagnostics
      • ShowDiagnostics
      • ShowFrameInfo
      • ShowFrameInfo
      • ShowMemoryStats
      • ShowMemoryStats
      • ShowProfiler
      • ShowProfiler
      • ShowProfilerDuringMRC
      • WindowAnchor
      • WindowAnchor
      • WindowFollowSpeed
      • WindowFollowSpeed
      • WindowOffset
      • WindowOffset
      • WindowScale
      • WindowScale
    • Implements
    Back to top Generated by DocFX