Параметры командной строки при запуске
Startup command-line options can be specified on the UNIGINE executable file launching. These options control what rendering API to use, what resolution to set for Unigine window, where resources for initializing the engine are stored, etc. The options are either set in UNIGINE SDK Browser or manually via the command line. Параметры командной строки запуска можно указать при запуске исполняемого файла UNIGINE. Эти параметры определяют, какой API рендеринга использовать, какое разрешение установить для окна Unigine, где хранятся ресурсы для инициализации движка и т.д. Параметры задаются либо в UNIGINE SDK Browser , либо вручную через командную строку .
If no command-line options is specified, the options with default values will be used when launching the application. Если параметры командной строки не указаны, при запуске приложения будут использоваться параметры со значениями по умолчанию. The syntax of command-line options is as follows: the full name of the binary executable (64-bit development or production version) is specified first and then the start-up options. Синтаксис параметров командной строки следующий: сначала указывается полное имя двоичного исполняемого файла (64-разрядная версия для разработки или производственная версия), а затем параметры запуска.
main_* -command argumentmain_* -command "argument,argument"main_* -console_command "command argument"All paths are specified as absolute or relative to the binary executable or the data directory. Все пути указаны как абсолютные или относительно двоичного исполняемого файла или каталога data.
If the same command is specified multiple times, only the last command will be taken into account by the engine. For example, in the following case, only the argument3 will be used by the Engine: Если одна и та же команда указана несколько раз, движком будет учтена только последняя команда. Например, в следующем случае движком будет использоваться только argument3:
-command "argument1" -command "argument2" -command "argument3"- An exception is file system command-line options: they can accumulate all the specified values. Исключением являются параметры командной строки файловой системы : они могут накапливать все указанные значения.
- The CLI options specified on the application start-up always take precedence over the ones stored in the configuration files. Some of the CLI options can be changed through the console. Such options are automatically stored in the configuration files (this way, after the application is quit, they will be restored on the next start-up). All other CLI options don't change the configuration files. Параметры интерфейса командной строки, указанные при запуске приложения, всегда имеют приоритет над параметрами, хранящимися в файле конфигурации. Некоторые параметры интерфейса командной строки можно изменить с помощью консоли . Такие параметры автоматически сохраняются в файле конфигурации (таким образом, после выхода из приложения они будут восстановлены при следующем запуске). Все остальные параметры интерфейса командной строки не изменяют файл конфигурации.
Video SettingsНастройки видео#
Graphics SettingsНастройки графики#
| Имя | Описание | Аргументы | По умолчанию |
|---|---|---|---|
| -video_app | Графический API, используемый для рендеринга:
|
"null"
"auto" "direct3d11" или "dx" "direct3d12" или "dx12" "vulkan" или "vk" |
"auto" |
| -video_adapter | В случае нескольких графических процессоров позволяет выбрать используемый графический процессор. |
Номер используемого графического процессора. |
0 |
| -video_debug |
Примечание
Включение контекста отладки может привести к падению производительности (~ 30-40%). |
|
0 |
| -video_debug_shader | Включает или отключает отладочные шейдеры для приложения независимо от типа сборки (debug или release). Этот параметр следует включить, если вы используете средства отладки графики (например, отладчик RenderDoc).
|
0 отключить отладочные шейдеры (использутся релизные)
1 включить отладочные шейдеры |
0 |
| -video_offscreen | Включает внеэкранный режим рендеринга для приложения, что позволяет запускать UNIGINE Engine в облаке и использовать мощные серверы (например, с целью создания фотореалистичных наборов данных для глубокого обучения и проверки алгоритмов ИИ). Все окна в этом режиме виртуальные, так же как и дисплей, пользовательский ввод недоступен. |
||
| -main_window | Включает создание главного окна при запуске приложения. После запуска приложения можно создать любое окно, и оно будет работать в штатном режиме. Например, это может быть полезно в пользовательском редакторе или любом другом приложении, где главного окна движка быть не должно. |
1 чтобы включить создание главного окна. 0 чтобы отключить создание главного окна. |
1 |
| -auto_quit | Включает принудительное закрытие движка, при закрытии всех окон. |
1 чтобы включить принудительное закрытие движка. Это значение должно быть установлено, когда в -main_window передается 0. 0 чтобы отключить принудительное закрытие движка. |
0 |
File SystemФайловая система#
| Имя | Описание | Аргументы | По умолчанию |
|---|---|---|---|
| -data_path | Путь к каталогу data со всеми ресурсами . Путь может быть указан как абсолютный путь или относительно двоичного исполняемого файла.
Указанный каталог -data_path можно получить с помощью функции getDataPath(). |
Аргумент можно передать следующим образом:
|
../ |
| -plugin_path | Путь к каталогу, содержащему плагины. Все плагины в этом каталоге будут загружены автоматически при запуске.
Путь может быть указан относительно двоичного исполняемого файла или как абсолютный путь. Список указанных каталогов -plugin_path можно получить с помощью методов getNumPluginPaths() и getPluginPath(int num). |
Аргументы могут быть переданы следующим образом:
|
plugins/ |
Unlike other command-line options, the plugin_path option can accumulate all specified values. It allows specifying multiple paths, each of which will be used by the Engine. В отличие от других параметров командной строки, параметр plugin_path может накапливать все указанные значения. Он позволяет указать несколько путей, каждый из которых будет использоваться движком. For several directories or packages you should specify each item separately without commas, for example: Для нескольких каталогов или пакетов необходимо указывать каждый элемент отдельно без запятых, например:
-plugin_path ../RELATIVE_PATH_1/ -plugin_path ../RELATIVE_PATH_2/ -plugin_path ABSOLUTE_PATHOther DataПрочие данные#
| Имя | Описание | Аргументы | По умолчанию |
|---|---|---|---|
| -boot_config | Путь к стартовому файлу конфигурации, содержащему настройки запуска. Путь может быть указан как абсолютный путь или относительно -data_path. |
Аргументы могут быть переданы следующим образом:
|
configs/default.boot |
| -cache_path | Путь для хранения файлов кэша системы и редактора (указывается system_cache а также editor_cache соответственно). Путь может быть указан как абсолютный путь или относительно -data_path. |
data/ | |
| -editor_cache | Путь к файлу кеша, который будет использоваться UnigineEditor. Путь может быть указан как абсолютный путь или относительно -data_path, или к -cache_path (если есть). |
editor.cache | |
| -system_cache | Путь к файлу кеша, который будет использоваться движком. Путь может быть указан как абсолютный путь или относительно -data_path, или к -cache_path (если есть). |
unigine.cache | |
| -engine_log | Файл журнала, который будет создан и использован. Путь может быть указан как абсолютный путь или относительно двоичного исполняемого файла. Для относительных путей, если установлено -project_name , файл журнала с указанным именем будет создан в соответствующем каталоге в профиле пользователя (будет использоваться только имя , оставшаяся часть относительного пути будет отброшена). |
log.txt | |
| -gui_path | Путь к оболочке GUI, которая будет использоваться для интерфейса движка. Путь может быть указан как абсолютный путь или относительно -data_path. |
core/gui/ | |
| -project_name | Заставляет движок сохранять все изменяющиеся данные (файл журнала, файлы кеша и файл конфигурации) в профиле пользователя, а не в каталоге с двоичными файлами. Для этого будет создан каталог с указанным PROJECT_NAME или путем к каталогу проекта относительно профиля пользователя (например, unigine_projects/my_project). |
PROJECT_NAME, а именно:
|
|
| -system_script | Путь к системному скрипту (указан относительно каталога данных ). |
core/unigine.usc | |
| -skip_guidsdb | Движок игнорирует файл guids.db и ищет идентификаторы GUID среди всех файлов .meta внутри папки данных и всех смонтированных внешних каталогов и пакетов.
Примечание
UnigineEditor uses this argument by default to avoid errors, and always re-generates the guids.db file to ensure its validity. UnigineEditor использует этот аргумент по умолчанию, чтобы избежать ошибок, и всегда повторно генерирует файл guids.db, чтобы гарантировать его достоверность. |
Engine-Related SettingsНастройки, относящиеся к движку#
| Имя | Описание | Аргументы |
|---|---|---|
| -console_command | Консольная команда для использования при запуске двигателя. Несколько команд можно разделить с помощью последовательности &&. |
command <arguments> |
| -console_history |
|
<path_to_file/console_history_file_name>
|
| -extern_plugin | Загрузите библиотеку плагинов (путь указывается относительно исполняемого двоичного файла).
|
Аргументы можно указать следующим образом:
|
| -extern_define |
Примечание
Параметр работает исключительно для UnigineScript.
|
Аргументы можно указать следующим образом:
|
| -memory_statistics_enabled | Включает сбор статистики памяти, необходимой для конфигурации пулов. |
Примечание
Статистика памяти отключена по умолчанию для релизных сборок. |
| -microprofile_enabled | Включает инструмент Microprofile. |
1 чтобы включить инструмент Microprofile. 0 чтобы отключить инструмент Microprofile. |
| -async_init | Включает параллельную инициализацию мешей, свойств и материалов при запуске движка. Если отключено, инициализация мешей, свойств и материалов выполняется последовательно. |
1 - включить параллельную инициализацию (по умолчанию). 0 - последовательная инициализация мешей, свойств и материалов. |
Sound SettingsНастройки звука#
| Имя | Описание | Аргументы | По умолчанию |
|---|---|---|---|
| -sound_app | Используемый звуковой API:
|
null
auto openal |
auto |
| -vr_app |
|
null
auto openvr varjo |
null |
Информация, представленная на данной странице, актуальна для версии UNIGINE 2.20 SDK.