ProfilerRecorder

描述

记录 Profiler 标记或计数器产生的 Profiler 指标数据。

使用 ProfilerRecorder 访问 Profiler 公开的性能指标。您可以使用它以统一的方式读取 Profiler 计数器数据（如内存或渲染统计信息）和 Profiler 标记计时数据。

您可以在编辑器和 Player 构建中使用此 API，包括发行版 Player。使用 ProfilerRecorderHandle.GetAvailable 获取支持指标的完整列表。有关可用内置 Profiler 标记的列表，请参阅用户手册文档中的 常用 Profiler 标记。

以下示例演示如何使用 ProfilerRecorder 获取内存和计时统计信息。

using System.Collections.Generic;
using System.Text;
using Unity.Profiling;
using UnityEngine;

public class ExampleScript : MonoBehaviour
{
    string statsText;
    ProfilerRecorder systemMemoryRecorder;
    ProfilerRecorder gcMemoryRecorder;
    ProfilerRecorder mainThreadTimeRecorder;

    static double GetRecorderFrameAverage(ProfilerRecorder recorder)
    {
        var samplesCount = recorder.Capacity;
        if (samplesCount == 0)
            return 0;

        double r = 0;
        unsafe
        {
            var samples = stackalloc ProfilerRecorderSample[samplesCount];
            recorder.CopyTo(samples, samplesCount);
            for (var i = 0; i < samplesCount; ++i)
                r += samples[i].Value;
            r /= samplesCount;
        }

        return r;
    }

    void OnEnable()
    {
        systemMemoryRecorder = ProfilerRecorder.StartNew(ProfilerCategory.Memory, "System Used Memory");
        gcMemoryRecorder = ProfilerRecorder.StartNew(ProfilerCategory.Memory, "GC Reserved Memory");
        mainThreadTimeRecorder = ProfilerRecorder.StartNew(ProfilerCategory.Internal, "Main Thread", 15);
    }

    void OnDisable()
    {
        systemMemoryRecorder.Dispose();
        gcMemoryRecorder.Dispose();
        mainThreadTimeRecorder.Dispose();
    }

    void Update()
    {
        var sb = new StringBuilder(500);
        sb.AppendLine($"Frame Time: {GetRecorderFrameAverage(mainThreadTimeRecorder) * (1e-6f):F1} ms");
        sb.AppendLine($"GC Memory: {gcMemoryRecorder.LastValue / (1024 * 1024)} MB");
        sb.AppendLine($"System Memory: {systemMemoryRecorder.LastValue / (1024 * 1024)} MB");
        statsText = sb.ToString();
    }

    void OnGUI()
    {
        GUI.TextArea(new Rect(10, 30, 250, 50), statsText);
    }
}

注意
ProfilerRecorder 分配非托管资源并实现 IDisposable 接口。使用 Dispose 在不再需要记录统计信息时释放资源。

ProfilerRecorder 以两种模式提供对 Unity 指标的访问：立即访问计数器的值和帧结束时的计数器值。其他资源：CurrentValue、LastValue、GetSample、ProfilerRecorderHandle.GetAvailable。

属性

构造函数

公有方法

静态方法