Version: 2021.3

ProfilerRecorderConstructor

切换到手册
public ProfilerRecorder (string categoryName, string statName, int capacity, Unity.Profiling.ProfilerRecorderOptions options);
public ProfilerRecorder (Unity.Profiling.ProfilerCategory category, string statName, int capacity, Unity.Profiling.ProfilerRecorderOptions options);

参数

categoryName Profiler category name.
statName Profiler marker or counter name.
capacity Maximum amount of samples to be collected.
options Profiler recorder options.
category Profiler category identifier.

描述

Constructs ProfilerRecorder instance with a Profiler metric name and category.

Use to initialize ProfilerRecorder and associate it with a specific Profiler metric.

By default, ProfilerRecorder does not start collecting data immediately. Use ProfilerRecorderOptions.StartImmediately to enable collection together with ProfilerRecorder construction. Alternatively, use Start method after construction. If the CurrentValue is the only data you are interested in, you do not need to start ProfilerRecorder or allocate sample storage. In this case, use 0 as a capacity parameter when creating ProfilerRecorder.

Note:
ProfilerRecorder allocates memory and must be disposed when it is no longer needed.

using Unity.Profiling;
using UnityEngine;

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

void OnEnable() { systemMemoryRecorder = new ProfilerRecorder(ProfilerCategory.Memory, "System Used Memory", 1, ProfilerRecorderOptions.Default | ProfilerRecorderOptions.StartImmediately); gcMemoryRecorder = new ProfilerRecorder(ProfilerCategory.Memory, "GC Reserved Memory", 1, ProfilerRecorderOptions.Default | ProfilerRecorderOptions.StartImmediately); mainThreadTimeRecorder = new ProfilerRecorder(ProfilerCategory.Internal, "Main Thread", 15); mainThreadTimeRecorder.Start(); }

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

See Also: StartNew.


public ProfilerRecorder (string statName, int capacity, Unity.Profiling.ProfilerRecorderOptions options);

参数

statName Profiler marker or counter name.
capacity Maximum amount of samples to be collected.
options Profiler recorder options.

描述

Constructs ProfilerRecorder instance with a Profiler metric name.

Use to initialize ProfilerRecorder with a metric name only. Unity searches for the metric name across all categories, and as such, initialization is slower than if you specify a category.


public ProfilerRecorder (Unity.Profiling.ProfilerCategory category, char* statName, int statNameLen, int capacity, Unity.Profiling.ProfilerRecorderOptions options);
public ProfilerRecorder (Unity.Profiling.ProfilerMarker marker, int capacity, Unity.Profiling.ProfilerRecorderOptions options);
public ProfilerRecorder (Unity.Profiling.LowLevel.Unsafe.ProfilerRecorderHandle statHandle, int capacity, Unity.Profiling.ProfilerRecorderOptions options);

参数

category Profiler category identifier.
statName Profiler marker or counter name pointer.
statNameLen Profiler marker or counter name length.
capacity Maximum amount of samples to be collected.
options Profiler recorder options.
marker Profiler marker instance.
statHandle Profiler recorder handle.

描述

Constructs ProfilerRecorder instance with a Profiler metric name pointer or other unsafe handles.