Руководство API скрипты

Profiler

класс в UnityEngine.Profiling / Реализовано в: UnityEngine.CoreModule

Описание

Контролирует Profiler из скрипта.

Вы можете добавлять настраиваемые разделы Profiler в свои скрипты с помощью Profiler.BeginSample и Profiler.EndSample.

На автономных платформах вы можете сохранить всю информацию о профилировании в файл, что позволит вам проверить ее позже. Для этого необходимо указать Profiler.logFile и задать для Profiler.enabled и Profiler.enabled значение true.

Поскольку использование Profiler негативно влияет на производительность вашего приложения, большая часть функций API Profiler доступна только при включенной «Сборке для разработки». Это означает, что вы должны включить «Сборку для разработчиков», если хотите использовать методы API-интерфейса профилировщика в своем созданном приложении. Отключение «Сборки для разработки» ускоряет работу вашего приложения, но запрещает вам использовать большинство методов Profiler API.

Исключением являются методы Profiler API, относящиеся к использованию памяти. Поскольку Unity управляет большей частью своей системной памяти во время выполнения, она может предоставлять эту информацию без снижения производительности, поэтому эти методы доступны, даже если «Разработка сборки» не включена. Это относится ко всем связанным с памятью методам Profiler API, кроме Profiler.GetAllocatedMemoryForGraphicsDriver и Profiler.GetRuntimeMemorySizeLong, поскольку они требуют дополнительных данных профилирования, доступных только в сборках разработки.

Статические Свойства

areaCount Количество областей Profiler, которые вы можете профилировать.
enableAllocationCallstacks Включает запись стеков вызовов для управляемых распределений.
enableBinaryLog Включает запись данных профилирования в файл.
enabled Включает профайлер.
logFile Задает файл для использования при записи данных профилирования.
maxUsedMemory Устанавливает максимальный объем памяти, который Profiler использует для буферизации данных. Это свойство выражается в байтах.
usedHeapSizeLong Возвращает количество байтов, выделенных Unity. Сюда не входят байты, выделенные внешними библиотеками или драйверами.

Статические Методы

AddFramesFromFile Отображает записанные данные профиля в профилировщике.
BeginSample Начинает профилировать фрагмент кода с пользовательской меткой.
BeginThreadProfiling Включает профилирование в потоке, из которого вы вызываете этот метод.
EmitFrameMetaData Записывает метаданные, связанные с текущим кадром, в поток Profiler.
EndSample Завершает текущую выборку профилирования.
EndThreadProfiling Освобождает внутренние ресурсы, используемые профилировщиком для потока.
GetAllocatedMemoryForGraphicsDriver Возвращает объем выделенной памяти для графического драйвера в байтах. Доступно только в проигрывателях и редакторе разработки.
GetAreaEnabled Возвращает значение, включена ли данная ProfilerArea в данный момент.
GetMonoHeapSizeLong Возвращает размер зарезервированного пространства для управляемой памяти.
GetMonoUsedSizeLong Получает выделенную управляемую память для живых объектов и несобранных объектов.
GetRuntimeMemorySizeLong Собирает собственную память, используемую объектом Unity.
GetTempAllocatorSize Возвращает размер временного распределителя.
GetTotalAllocatedMemoryLong Общая память, выделенная внутренними распределителями в Unity. Unity резервирует большие пулы памяти в системе. Эта функция возвращает объем используемой памяти в этих пулах.
GetTotalFragmentationInfo Возвращает информацию о фрагментации памяти кучи.
GetTotalReservedMemoryLong Общий объем памяти, зарезервированной Unity.
GetTotalUnusedReservedMemoryLong Unity выделяет память в пулах для использования, когда единству нужно выделить память. Эта функция возвращает количество неиспользуемой памяти в этих пулах.
SetAreaEnabled Включить или отключить данную ProfilerArea.
SetTempAllocatorRequestedSize Устанавливает размер временного распределителя.
Вы можете отблагодарить автора, за перевод документации на русский язык. Донат
API скрипты 2021.3