Инструмент Microprofile

Microprofile отнимает много времени, поэтому мы рекомендуем вам включать его только при работе с ним и оставлять отключенным в противном случае.

Один из способов отключить Microprofile — снять флажок с соответствующей опции перед запуском UnigineEditor или приложения:

Другой способ — использовать консольную команду microprofile_enabled.

Примечание

Если вы измените статус Microprofile через консоль, эта настройка будет сохранена в файле <Project_Name>/data/configs/default.user. Состояние, заданное в файле конфигурации пользователя, переопределит состояние, определенное через SDK Browser.

Microprofile позволяет сохранять данные о производительности в HTML-файл и затем анализировать их в автономном режиме.

Чтобы вывести данные о производительности в HTML-файл, выполните следующие действия:

1. В консоли задайте количество кадров для профилирования с помощью консольной команды microprofile_dump_frames. Вы можете пропустить этот шаг: по умолчанию будет профилировано 500 кадров.
2. Выполните консольную команду microprofile_dump_html.

Данные о производительности будут сохранены в указанном HTML-файле.

Примечание

Если путь не указан, дамп будет сохранен в папке data/microprofile_dump_html.

Использование дампов профилирования упрощает перехват "скачков" производительности: движок продолжает рендерить приложение в фоновом режиме, даже когда оно не в фокусе, поэтому кадр, на котором произошел скачок, может быть перезаписан в случае использования веб-сервера для визуализации данных производительности. Также его можно использовать для оценки результатов оптимизации: вы можете сделать дамп кадров до и после оптимизации и сравнить их.

Чтобы визуализировать данные о производительности с помощью локального веб-сервера, выполните следующие действия:

1. В консоли установите количество кадров для профилирования с помощью консольной команды microprofile_webserver_frames . Вы можете пропустить этот шаг: по умолчанию будет профилировано 200 кадров.

2. В меню UnigineEditor выберите Tools -> Microprofile.

   

Данные о производительности будут отображаться в вашем веб-браузере.

Например, если вы укажете localhost:1337/100, будут отображаться только первые 100 кадров.

В группе данных производительности Main отображается стек вызовов операций (например, update, rendering и т. д.), выполняемых движком на ЦП.

Данные о производительности функции World Update

В группе данных о производительности GPU отображается стек вызовов операций, выполняемых движком на GPU. В дополнение к основным данным о производительности для каждой функции (например, рендеринга среды, рендеринга пост-материалов и т.д.) отображается количество вызовов DIP и визуализированных треугольников. Также может отображаться количество поверхностей, источников света, теней, отрендеренных этой функцией, количество используемых материалов и шейдеров; информация об узле или материале, для которого вызывается функция (идентификатор, имя и т.д.).

Данные о производительности отложенного рендеринга освещения

Когда указывается область, соответствующая определенной функции, отображается Microprofile, когда эта функция вызывается на CPU и сколько времени затрачивается на ее выполнение.

команды Vulkan или DirectX можно объединить в группы отладки графического процессора, которые создаются автоматически при определении области профилирования. Все графические ресурсы, загружаемые из внешних файлов, такие как текстуры, шейдеры, статические меши или меши со костной анимацией, а также внутренние ресурсы движка имеют свои собственные имена отладки для упрощения идентификации. Эта информация может быть полезна при использовании отладчиков Graphics API, таких как NVIDIA Nsight или RenderDoc.

Пример данных отладки, просматриваемых в RenderDoc

Данные о производительности потоков движка визуализируются в группах CPUThread, SoundThread, AsyncQueueThread, WorldSpawnMeshClutterThread, WorldSpawnGrassThread.

Данные о производительности в потоках симуляции физики

Чтобы создать несколько вложенных счетчиков, вы должны использовать функции beginMicro() и endMicro(). beginMicro() возвращает идентификатор, который должен быть передан в endMicro(). Это позволяет создавать вложенные и пересекающиеся счетчики профилировщика.

В следующем примере используется комбинация begin()/end() и beginMicro()/endMicro(). Таким образом, профилирование функции AppWorldLogic::update() будет доступно как в профилировщике, так и в Microprofile.

int AppWorldLogic::update()
{

	// start profiling
	Profiler::begin("AppWorldLogic::update");

	float time = Game::getTime();
	float angle_0 = time * 1.0f;
	float angle_1 = time * 1.5f;
	float angle_2 = time * 2.0f;

	// start profiling of the first light source (available in the Microprofile only)
	int id_0 = Profiler::beginMicro("1st Light Update");

	light_0->setWorldTransform(translate(Unigine::Math::Vec3(sinf(angle_0), cosf(angle_0), 1.0f) * 20.0f));

	// stop profiling of the first light source
	Profiler::endMicro(id_0);

	// start profiling of the second light source (available in the Microprofile only)
	int id_1 = Profiler::beginMicro("2nd Light Update");

	light_1->setWorldTransform(translate(Unigine::Math::Vec3(sinf(angle_1), cosf(angle_1), 1.0f) * 20.0f));

	// stop profiling of the second light source
	Profiler::endMicro(id_1);

	light_2->setWorldTransform(translate(Unigine::Math::Vec3(sinf(angle_2), cosf(angle_2), 1.0f) * 20.0f));

	// stop profiling
	Profiler::end();

	return 1;
}

Примечание

Используйте только beginMicro()/endMicro(), если вам не нужен инструмент Profiler.

Существуют специальные макросы для обозначения фрагментов вашего кода, которые следует проверить. Их можно использовать вместо функций beginMicro() и endMicro():

• UNIGINE_PROFILER_FUNCTION для проверки работоспособности функции.

  Using Macro	Using Functions
  Исходный код (C++) void myFunction() { UNIGINE_PROFILER_FUNCTION; // your function code }	Исходный код (C++) void myFunction() { int id = Profiler::beginMicro(__FUNCTION__); // your function code Profiler::endMicro(id); }

• UNIGINE_PROFILER_SCOPED для проверки только определенной части кода.

  Using Macro	Using Functions
  Исходный код (C++) void myFunction() { // your function code { UNIGINE_PROFILER_SCOPED("Scope name"); // your function code } }	Исходный код (C++) void myFunction() { // your function code { int id = Profiler::beginMicro("Scope name"); // your function code Profiler::endMicro(id); } }