This page has been translated automatically.
Video Tutorials
Interface
Essentials
Advanced
How To
Rendering
Professional (SIM)
UnigineEditor
Interface Overview
Assets Workflow
Version Control
Settings and Preferences
Working With Projects
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Lighting
Sandworm
Using Editor Tools for Specific Tasks
Extending Editor Functionality
Built-in Node Types
Nodes
Objects
Effects
Decals
Light Sources
Geodetics
World Nodes
Sound Objects
Pathfinding Objects
Players
Programming
Fundamentals
Setting Up Development Environment
Usage Examples
C++
C#
UnigineScript
UUSL (Unified UNIGINE Shader Language)
Plugins
File Formats
Materials and Shaders
Rebuilding the Engine Tools
GUI
VR Development
Double Precision Coordinates
API
Animations-Related Classes
Containers
Common Functionality
Controls-Related Classes
Engine-Related Classes
Filesystem Functionality
GUI-Related Classes
Math Functionality
Node-Related Classes
Objects-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
IG Plugin
CIGIConnector Plugin
Rendering-Related Classes
VR-Related Classes
Content Creation
Content Optimization
Materials
Material Nodes Library
Miscellaneous
Input
Math
Matrix
Textures
Art Samples
Tutorials
Warning! This version of documentation is OUTDATED, as it describes an older SDK version! Please switch to the documentation for the latest SDK version.
Warning! This version of documentation describes an old SDK version which is no longer supported! Please upgrade to the latest SDK version.

Console

UNIGINE console is used for standard input, output and error streams for the file loading, rendering system, audio and video systems, path-finding system, physics engine, file system and many others.

Can be opened in any UNIGINE-based application.

How to Open Console#

A built-in console is called by pressing the F1 key:

The console can be hidden by pressing the F1 key one more time. See how to assign another key here.

Console Operation#

Console operation can be either command or variable:

  • Command is a directive to a console to perform a specific task.
  • Variable is an identifier that contains some stored value.

Command Syntax#

Console command can take null, one or several arguments. The syntax is:

Source code
command_to_execute // null argument
command_to_execute argument // one argument
command_to_execute argument argument // two arguments

Hints

  • To see the current variable value, other acceptable values and short description, just type it and press the Enter key. For example, if you type the main_window_resizable variable, you get the following result:
    Source code
    Main window resizable toggle
    0 is non-resizable mode
    1 is resizable mode
    main_window_resizable = 1
  • To complete a command or variable name, just start typing first letters and press the TAB key until you get the required result.

How to Change the Console Opening Key#

If you want to change the default F1 console turning on or off key, open the user configuration file (configs/default.user by default) and change the console_key field. You can specify a key scancode or name from the list. For example, to set the back quote key, specify BACK_QUOTE (or 17):

Source code (XML)
<console_key>BACK_QUOTE</console_key>

You can also specify several comma-separated keys:

Source code (XML)
<console_key>BACK_QUOTE,F3,18</console_key>

To set a keyboard shortcut that turns on and off the console, specify a key modifier in the console_key_modifier field in addition to the console key. The modifier can be set by using a modifier code or name from the list. For example, to set the Left Ctrl+` shourtcut, change the user configuration file as follows:

Source code (XML)
<console_key>BACK_QUOTE</console_key>
<console_key_modifier>LEFT_CTRL</console_key>

Notice
You can also change the console opening key or keyboard shortcut using the console_key and console_key_modifier commands while the application is executed.

Console#

Basic operations on the console, command and variable.

bindConfig file: *.user
Description:
  • Command. Binds a key to a command.
    For example, to bind the asterisk (*) key to the world_reload command, type:
    Source code
    Unigine~# bind * world_reload
Arguments:
  1. Key to bind
  2. Command to execute
clear
Description:
  • Command. Clears all messages from the console window.
console_keyConfig file: *.user
Description:
  • Variable. Prints the scancode or the name of the current console turning on or off key.
  • Command. Assigns a new key to turn on or off the console.
Arguments:
Key scancode or name from the list.
Several comma-separated arguments are allowed.
console_key_modifierConfig file: *.user
Description:
  • Variable. Prints the code or the name of the current modifier set for the console turning on or off key.
  • Command. Assigns a new key modifier for the console turning on and off key.
Arguments:
Modifier code or name from the list.
help
Description:
  • Command. Prints the list of the built-in commands.
hide
Description:
  • Command. Hides the console.
ls
Description:
  • Command. Prints a set of all available console keys, commands and variables.
show
Description:
  • Command. Show the console.
switch
Description:
  • Command. Switches among all variable values.
    Notice
    Make sure that the variable is an integer.
Arguments:
Variable, which values will be switched
toggle
Description:
  • Command. Enables or disables a variable.
    Notice
    Enabled variable will have a default value.
    For example, if you toggle the show_visualizer variable, you will get the following result:
    Source code
    toggle show_visualizer
    show_visualizer = 0 // disabled visualizer
    toggle show_visualizer
    show_visualizer = 1 // enabled visualizer
Arguments:
Variable to be toggled
unbind
Description:
  • Command. Unbinds a key from a command.
Arguments:
Key to unbind
console_limitConfig file: *.boot
Description:
  • Variable.   Prints the current maximum number of messages the console can output.
  • Command.   Sets the maximum number of messages the console can output.
Arguments:
[0; INT_MAX] - available range
16384 - by default
console_heightConfig file: *.user
Description:
  • Variable.   Prints the current console height in percentage of the window height.
  • Command.   Sets the console height in percentage of the window height.
Arguments:
[0; 100] - available range
75 - by default

Console GUI#

Operations on the console GUI.

console_sizeConfig file: *.boot
Description:
  • Variable.   Prints the current size for the console font.
  • Command.   Sets the size for the console font.
Arguments:
[4; 32] - available range
16 - by default
console_fontConfig file: *.boot
Description:
  • Variable. Prints a current path to a *.ttf file used as a console font.
  • Command. Sets a path to a *.ttf file to be used as a console font.
Arguments:
Path to a *.ttf file
core/gui/console.ttf (by default)
console_onscreenConfig file: *.user
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Enables displaying of the onscreen overlay.
Arguments:
0 - disabled (by default)
1 - enabled
console_onscreen_font_sizeConfig file: *.user
Description:
  • Variable.   Prints the current size for the onscreen overlay.
  • Command.   Sets the size for the onscreen overlay.
Arguments:
[4; 32] - available range
14 - by default
console_onscreen_heightConfig file: *.user
Description:
  • Variable.   Prints the current height of the onscreen overlay in percentage of the window height.
  • Command.   Sets the height of the onscreen overlay in percentage of the window height.
Arguments:
[0; 100] - available range
20 - by default
console_onscreen_timeConfig file: *.user
Description:
  • Variable.   Prints the current the time in seconds during which the text is displayed on the screen.
  • Command.   Sets the the time in seconds during which the text is displayed on the screen.
Arguments:
[0.0f; 100.0f] - available range
2.0f - by default
console_wrappingConfig file: *.user
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Enables word wrapping for the Console.
Arguments:
0 - disabled (by default)
1 - enabled

Engine#

Basic operations on the engine.

background_updateConfig file: *.boot
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Sets the value indicating whether the application window is updated when the window is hidden or out of focus (rendering frames in background). By default, your UNIGINE application stops rendering frames and updating its main window when its window goes out of focus (e.g. user switches to another window). Setting the background update mode enables constant rendering regardless of whether the application window is focused or in the background.
Arguments:
0 - disabled (by default)
1 - enabled
engine_version_info
Description:
  • Command. Prints the current engine version info.
quit
Description:
  • Command. Quits the engine.
splash_screenConfig file: *.boot
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Sets the value indicating whether the Splash screen is enabled at the engine start-up.
Arguments:
0 - disabled
1 - enabled (by default)

Engine Configuration Files#

General operations on the engine configuration.

boot_config
Description:
Arguments:
Path to the Engine startup configuration file
(data/default.boot by default)
boot_config_autosave
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Enables automatic saving of current Engine startup configuration settings to the file specified by the boot_config variable on loading, closing, and saving the world, as well as on the Engine shutdown.
Arguments:
0 - disabled (by default)
1 - enabled
boot_config_load
Description:
  • Command. Loads Engine startup configuration settings from a configuration file specified by the boot_config variable (configs/default.boot by default).
boot_config_save
Description:
  • Command. Saves Engine startup configuration settings to a configuration file specified by the boot_config variable (configs/default.boot by default).
configConfig file: *.boot
Description:
Arguments:
Path to the application configuration file
(configs/default.config by default)
config_autosave
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Enables automatic saving of current application configuration settings to the file specified by the config variable on loading, closing, and saving the world, as well as on the Engine shutdown.
Arguments:
0 - disabled
1 - enabled (by default)
config_load
Description:
  • Command. Loads the application configuration settings from a configuration file specified by the config variable (configs/default.config by default).
config_save
Description:
  • Command. Saves the current application configuration settings to a configuration file specified by the config variable (configs/default.config by default).
controls_configConfig file: *.boot
Description:
Arguments:
Path to the controls configuration file
(configs/default.controls by default)
controls_config_autosave
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Enables automatic saving of current controls configuration settings to the file specified by the controls_config variable on loading, closing, and saving the world, as well as on the Engine shutdown.
Arguments:
0 - disabled
1 - enabled (by default)
controls_config_load
Description:
controls_config_save
Description:
user_configConfig file: *.boot
Description:
Arguments:
Path to the user configuration file
(configs/default.user by default)
user_config_autosave
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Enables automatic saving of current user configuration settings to the file specified by the user_config variable on loading, closing, and saving the world, as well as on the Engine shutdown.
Arguments:
0 - disabled
1 - enabled (by default)
user_config_load
Description:
user_config_save
Description:
fast_shutdownConfig file: *.boot
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Enables fast and safe Engine shutdown by the operating system. By default this option is enabled to ensure that your application quits and releases all resources quickly. If you need to have the ability to re-initialize the Engine again after shutting it down (call init() after shutdown()) without restarting the application, you can disable this option, but in this case the Engine shutdown process may take significantly more time.
Arguments:
0 - disabled
1 - enabled (by default)

Engine Start-Up Parameters#

Console variables defined on Engine start-up.

Notice
After changing these variables via the console, restart the Engine to apply new values.
pso_preloadConfig file: *.boot
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Enables preloading of PSOs (Pipeline State Objects) on Engine initialization.
Arguments:
0 - disabled (by default)
1 - enabled
materials_preloadConfig file: *.boot
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Enables preloading of all materials on Engine initialization (including render materials). When preloading is enabled, Engine startup takes more time, and more memory is used. There are fewer spikes, but they occur sometimes. You can use materials preloading for a small project with a low number of materials (in case of satisfactory performance and sufficient memory amount). When disabled, materials are loaded on demand, resulting in lots of freezes, spikes, etc., but providing fast iterations during the application development phase (as less time is spent on launching your application and loading resources).
Arguments:
0 - disabled (by default)
1 - enabled
shaders_preloadConfig file: *.boot
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Enables preloading of shaders for the loaded materials on Engine initialization. When disabled, shaders are loaded on demand, resulting in lots of freezes, spikes, etc., but providing fast iterations during the application development phase (as less time is spent on launching your application and loading resources).
Arguments:
0 - disabled (by default)
1 - enabled
shader_cache_preloadConfig file: *.boot
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Enables preloading of the shader cache on Engine initialization. The shader cache stored on the disk is loaded to RAM, reducing the number of disc accesses.
Arguments:
0 - disabled (by default)
1 - enabled
textures_cache_preloadConfig file: *.boot
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Enables preloading of the texture cache on Engine initialization.
    Notice
    Textures cache always remains in memory after loading.
Arguments:
0 - disabled (by default)
1 - enabled
particles_memory_preloadConfig file: *.boot
Description:
  • Variable. Prints the current size of memory allocated for particles by the command below.
  • Command. Sets the size of memory allocated for particles.
Arguments:
Memory size in MB. The default is 50.

World#

Basic operations on world.

starting_worldConfig file: *.boot
Description:
  • Variable. Prints the current world to be loaded at the engine and editor start-up.
  • Command. Sets the current world to be loaded at the engine and editor start-up.
Arguments:
A world name or a path to a world relative to the -data_path folder.
world_load
Description:
  • Loads the specified world. A cache file can also be specified for faster application loading.
Arguments:
  1. Name of the world to load (inside the data directory)
  2. Name of the world cache file (optional)
world_quit
Description:
  • Clears all the world data.
world_save
Description:
  • Saves the current world to a file (*.world).
    Notice
    Materials won't be saved on running the command. To save them, use materials_save.
world_reload
Description:
  • Reloads the world. A cache file can also be specified to be reloaded.
Arguments:
Name of the world cache file (optional)

World Resources#

Operations, representing information on objects generated using CPU logic, such as ObjectGrass, ObjectMeshClutter and WorldClutter objects.

world_manager_info
Description:
  • Command. Print general information (the number of registered/loaded resources; used memory) on world manager resources, such as:
    • ImageManaged - loaded images (if not fully loaded, a dummy texture or one-mipmap texture is used)
    • PathManaged - loaded splines
    • ImageStream - streamed mask images
    • MeshStream - streamed meshes used as an intersection mask for grass or clutters
world_manager_list
Description:
  • Command. Prints the list of resources handled by the world manager (mask images for ObjectGrass and WorldClutter objects), if any.
world_spawn_list
Description:
  • Command. Print the list of generation requests for ObjectGrass and ObjectMeshClutter nodes with the following information:
    • Node type
    • Node ID
    • Camera position coordinates
    • Frame number
world_manager_images_memoryConfig file: *.boot
Description:
  • Variable.   Prints the current cache memory limit for images in MB.
  • Command.   Sets the cache memory limit for images in MB.
Arguments:
[0; 8192] - available range
128 - by default
world_manager_meshes_memoryConfig file: *.boot
Description:
  • Variable.   Prints the current cache memory limit for meshes in MB.
  • Command.   Sets the cache memory limit for meshes in MB.
Arguments:
[0; 8192] - available range
128 - by default
world_moving_immovable_node_modeConfig file: *.boot
Description:
  • Variable.   Prints the current mode of handling attempts to move nodes having the Immovable flag enabled. The Engine will warn you by default in case of any attempts to move nodes marked as Immovable.
  • Command.   Sets the mode of handling attempts to move nodes having the Immovable flag enabled. The Engine will warn you by default in case of any attempts to move nodes marked as Immovable.
    Notice
    Please be aware that there are two cases when you may disable warnings and allow movement of Immovable nodes:
    • At run-time for procedural generation of levels. This may cause some freezing but won't affect performance much. Upon completion of the generation process you should enable warnings again.
    • On world initialization, this will change world loading time but won't affect overall performance.
Arguments:
0 - movement of nodes having the Immovable flag is prohibited.
1 - movement of nodes having the Immovable flag is accompanied by a warning in the Console. (by default)
2 - movement of nodes having the Immovable flag is allowed (no warnings displayed).

Sound#

Operations on the sound.

sound_occlusion
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Enables occlusion of a sound if other nodes are found in front of the sound source.
Arguments:
0 - disabled
1 - enabled (by default)
sound_reverb
Description:
  • Variable.   Prints the current sound reverberation mode.
  • Command.   Sets the sound reverberation mode.
Arguments:
0 - sound reverberation is disabled
1 - single-environment sound reverberation
2 - multi-environment sound reverberation (by default)

Sound Resources#

Operations on the sound resources.

sound_manager_load_samples
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Enables preloading sound samples on world loading (ensure there are no lags afterwards but increases loading time and memory footprint).
Arguments:
0 - disabled (by default)
1 - enabled
sound_manager_info
Description:
  • Command. Prints general information on sound resources: the number of static and streamed sound sources (registered/loaded; memory used).
sound_manager_list
Description:
  • Command. Prints the detailed list of sound files, if any, with used space.
sound_manager_sample_static_memory
Description:
  • Variable.   Prints the current cache memory limit for static sound resources in Mb.
  • Command.   Sets the cache memory limit for static sound resources in Mb.
Arguments:
[1; 1024] - available range
64 - by default
sound_manager_sample_stream_memory
Description:
  • Variable.   Prints the current cache memory limit for streamed sound resources in Mb.
  • Command.   Sets the cache memory limit for streamed sound resources in Mb.
Arguments:
[1; 1024] - available range
16 - by default

Material Manager#

Operations on materials.

material_manager_info
Description:
  • Command. Prints information on all loaded materials (e.g. the number of loaded shaders; states, textures and parameters that don't exist in the parent material).
materials_reload
Description:
  • Command. Reloads all loaded materials and used shaders (by calling the reloadMaterials() method). Shader variables are updated automatically. It can be called, for example, for graphics API changes to come to effect.
materials_reload_event
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Handles materials reload event in the Editor. Disabling is unsafe.
Arguments:
0 - disabled
1 - enabled (by default)
materials_save
Description:
  • Command. Saves all loaded materials.
shaders_create
Description:
  • Command. Creates all shaders for all loaded materials, updates the shaders cache if necessary, and loads shaders to RAM.
shaders_compile
Description:
  • Command. Compiles shaders for all loaded materials.
shaders_destroy
Description:
  • Command. Removes all shaders from RAM.
    Notice
    This command can be used to clear RAM after shader cache generation.

Camera#

Operations for fast positioning of the game camera.

camera_get
Description:
  • Command. Returns the current position of the game camera and its rotation (Euler angles).
camera_set
Description:
  • Command. Set position and rotation (Euler angles) of the game camera.
    Notice
    Position and rotation of the game camera can be changed only if the camera is unlocked.
    Source code
    camera_set 20.0 19.0 3.0 0.0 45.0 90.0
Arguments:
The first 3 arguments set position.
The second 3 arguments set rotation (optional)

File System#

Operations on the File system.

filesystem_clear_paths
Description:
  • Command. Removes all non-existent file system paths.
filesystem_mmapConfig file: *.boot
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Enables the use of memory-mapped files for faster access.
Arguments:
0 - disabled
1 - enabled (by default)
filesystem_reload
Description:
  • Command. Reloads the file system, thereby update the list of files.
filesystem_save_guids
Description:
  • Command. Saves all file system guids to the specified file path in JSON format, or binary format if the corresponding flag is set.
Arguments:
  1. Path to the file
  2. Binary flag - save guids to a file in binary format (optional)

File System Info#

Operations, representing information on the File system.

filesystem_guids
Description:
  • Command. Prints the list of all file system guids.
filesystem_info
Description:
  • Command. Print general file system information (the total number of files and files per package).
filesystem_list
Description:
  • Command. Print the list of all files.

Assets#

Operations on assets.

assets_info
Description:
  • Command. Prints information on the number of non-native assets and runtime files generated for them.
assets_list
Description:
  • Command. Prints the list of all non-native assets and information on runtime files generated for them (file path, alias).

Import and Export#

Operations representing information on importers and exporters of models.

import_info
Description:
  • Command. Prints information on the registered importers of the models and the processors. The information includes an importer vendor name, an importer name, an extension and a priority.
export_info
Description:
  • Command. Prints information on the registered exporters of the models.

Scripts#

Operations on the world, system and editor scripts.

Editor Script Analyzer#

Operations on the editor script debugging.

Notice
Available only for debug builds.
editor_memory_usage
Description:
  • Command. Prints memory usage by the editor script to the console or dump into a specified file.
Arguments:
Path to a file to dump the information into (optional)
editor_analyze
Description:
  • Command. Analyzes the performance of the editor script. The information can be printed to the console or dumped into a specified file.
Arguments:
Path to the log file to dump the log file information into (optional)
editor_disassemble
Description:
  • Command. Disassembles the editor script. The information can be printed to the console or dumped into a specified file.
Arguments:
Path to a file to dump the information into (optional)

System Script Analyzer#

Operations on the system script debugging.

Notice
Available for debug builds only.
system_memory_usage
Description:
  • Command. Prints memory usage by the system script to the console or dump into a specified file.
Arguments:
Path to a file to dump the information into (optional)
system_analyze
Description:
  • Command. Analyzes the performance of the system script. The information can be printed to the console or dumped into a specified file.
Arguments:
Path to the log file to dump the log file information into (optional)
system_disassemble
Description:
  • Command. Disassembles the system script. The information can be printed to the console or dumped into a specified file.
Arguments:
Path to a file to dump the information into (optional)

World Script Analyzer#

Operations on the world script debugging.

Notice
Available for debug builds only.
world_memory_usage
Description:
  • Command. Prints memory usage by the world script to the console or dump into a specified file.
Arguments:
Path to a file to dump the information into (optional)
world_analyze
Description:
  • Command. Analyzes the performance of the world script. The information can be printed to the console or dumped into a specified file.
Arguments:
Path to the log file to dump the log file information into (optional)
world_disassemble
Description:
  • Command. Disassembles the world script. The information can be printed to the console or dumped into a specified file.
Arguments:
Path to a file to dump the information into (optional)

Script Debugger#

Operations on the per-function breakpoint. The syntax to set the breakpoint is the following:

Source code
system_breakpoint/world_breakpoint/editor_breakpoint set/remove function_name number_of_arguments
world_breakpoint
Description:
  • Command. Sets a breakpoint to the specified function in the world script.
The syntax to set the breakpoint is the following:
Source code
world_breakpoint set/remove function_name number_of_arguments
Arguments:
  1. Name of function
  2. Number of arguments
system_breakpoint
Description:
  • Command. Sets a breakpoint to the specified function in the system script.
The syntax to set the breakpoint is the following:
Source code
system_breakpoint set/remove function_name number_of_arguments
Arguments:
  1. Name of function
  2. Number of arguments
editor_breakpoint
Description:
  • Command. Set a breakpoint to the specified function in the editor script.
The syntax to set the breakpoint is the following:
Source code
editor_breakpoint set/remove function_name number_of_arguments
Arguments:
  1. Name of function
  2. Number of arguments

Asynchronous Operations#

Asynchronous operations.

async_log_modeConfig file: *.boot
Description:
  • Variable.   Prints the current mode for printing the list of asynchronous operations (loading / unloading of images, meshes, files, etc.) related to the specified engine component.
  • Command.   Sets the mode for printing the list of asynchronous operations (loading / unloading of images, meshes, files, etc.) related to the specified engine component.
    Notice
    • Available for debug builds only, won't work for release builds.
    • You can specify whether only loading and unloading operations, or all operations should be shown.
Arguments:
0 - do not print (by default)
1 - print operations with the nodes
2 - print operations with the renderer resources (loading / unloading of meshes and textures)
3 - print operations with the file system resources (loading / unloading of files)
4 - print all operations with the nodes, renderer and file systems resources
async_log_priorityConfig file: *.boot
Description:
  • Variable.   Prints the current scope of asynchronous operations to be shown via async_log_mode: only loading and unloading operations or all operations.
  • Command.   Sets the scope of asynchronous operations to be shown via async_log_mode: only loading and unloading operations or all operations.
Arguments:
0 - print only frequently used operations (by default)
1 - print all operations
async_queue_info
Description:
  • Command. Prints the info on async queue resource count and memory usage.
async_queue_list
Description:
  • Command. Prints the list of async queue resources.
async_queue_clear
Description:
  • Command. Clears the async queue.

Visualizer#

Operations on the visualizer.

Notice
To debug the world and objects in it, the show_visualizer command should be set to 1.
show_visualizerConfig file: *.user
Description:
  • Variable.   Prints the current visualizer mode.
  • Command.   Sets the visualizer mode. It specifies if the visualizer geometry (bounding volumes, wireframe, physics bodies and shapes, etc.) is shown.
Arguments:
0 - visualizer is not shown (by default)
1 - visualizer is shown with depth testing (to check if other objects in the scene do not occlude visualized geometry)
2 - visualizer is shown without depth testing (visualized geometry is rendered in front of all objects in the scene)
show_fpsConfig file: *.user
Description:
  • Variable.   Prints the current FPS counter display mode.
  • Command.   Sets the FPS counter display mode.
Arguments:
0 - hide the FPS counter (by default)
1 - display the FPS counter
2 - display the FPS counter and statistics on the last 600 frames: minimum FPS, maximum FPS and average FPS for the last 600 frames.
visualizer_fix_flickerConfig file: *.user
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Reduces wireframe visualizer flickering when TAA is on.
Arguments:
0 - disabled (by default)
1 - enabled
render_wireframe_antialiasing
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Enables antialiasing of wireframes.
Arguments:
0 - disabled
1 - enabled (by default)
render_ffp_antialiasing_lines
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Enables antialiasing of the Visualizer and other FFP lines.
Arguments:
0 - disabled
1 - enabled (by default)

World Debugging#

Operations on the world debugging.

world_show_spatialConfig file: *.user
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Enables displaying of the scene spatial tree.
Arguments:
0 - disabled (by default)
1 - enabled
world_show_visualizerConfig file: *.user
Description:
  • Variable. Prints the list of node types for which the visualizer is displayed.
  • Command. Sets the node types for which the visualizer is displayed.
Arguments:
all
world
field
light
decal
object
player
physical
navigation
obstacle
sound
"" - to hide all handlers
render_show_trianglesConfig file: *.user
Description:
  • Variable.   Prints the current wireframe mode for scene triangles.
  • Command.   Sets the wireframe mode for scene triangles.
Arguments:
0 - triangles are hidden (by default)
1 - front faces with the depth test are shown
2 - front faces without the depth test are shown
3 - front and back faces without the depth test are shown

Lighting Debugging#

Operations on the lighting debugging.

render_show_lightmap_checker
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Enables the Baked Lightmap Checker debug mode. This mode maps the checker texture onto the baked lightmap polygons, which can be used to facilitate the process of comparing UV map texels on neighboring planes.
Arguments:
0 - disabled (by default)
1 - enabled
render_show_voxel_probe_visualizerConfig file: *.user
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Enables displaying of visualizer for Voxel Probes (shown for the selected probe only).
Arguments:
0 - disabled (by default)
1 - enabled
render_show_voxel_probe_visualizer_grid_size
Description:
  • Variable.   Prints the current size of the grid that is used to visualize Voxel Probes (number of spheres along the axis).
  • Command.   Sets the size of the grid that is used to visualize Voxel Probes (number of spheres along the axis).
Arguments:
[7; 40] - available range
15 - by default
render_show_voxel_probe_visualizer_sphere_scale
Description:
  • Variable.   Prints the current scale factor of the sphere that is used to visualize Voxel Probes. The sphere size depends on the scale factor and the voxel size.
  • Command.   Sets the scale factor of the sphere that is used to visualize Voxel Probes. The sphere size depends on the scale factor and the voxel size.
Arguments:
[0.0f; 1.0f] - available range
0.25f - by default

Node Debugging#

Operations on the node debugging.

world_show_handlerConfig file: *.user
Description:
  • Variable. Prints the value indicating if node handlers for lights, particle systems, sectors, portals and so on are displayed.
  • Command. Displays node handlers for lights, particle systems, sectors, portals, etc.
Arguments:
The node type:
  • all
  • world
  • field
  • light
  • decal
  • object
  • player
  • physical
  • navigation
  • obstacle
  • sound
  • "" - to hide all handlers
world_handler_3dConfig file: *.user
Description:
  • Variable.   Prints the current world handlers icon type to be used.
  • Command.   Sets the world handlers icon type to be used.
Arguments:
0 - screen scale (by default)
1 - 3D
world_handler_distanceConfig file: *.user
Description:
  • Variable.   Prints the current world handlers visibility distance.
  • Command.   Sets the world handlers visibility distance.
Arguments:
[0; inf] - available range
500 - by default
render_show_decalsConfig file: *.user
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Enables displaying of the wireframe for decals.
Arguments:
0 - disabled (by default)
1 - enabled
render_show_immovableConfig file: *.
Description:
  • Variable.   Prints the current value visualizing the state of the Immovable option for objects.
  • Command.   Sets the value visualizing the state of the Immovable option for objects.
Arguments:
0 - disabled (by default)
1 - show objects with Immovable option enabled
2 - show objects with Immovable option disabled
render_show_nodes_interaction_triggerConfig file: *.
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating whether the visualizer is enabled for nodes with the Trigger Interaction flag enabled.
Arguments:
0 - disabled (by default)
1 - enabled
render_show_nodes_interaction_clutterConfig file: *.
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating whether the visualizer is enabled for nodes with the Clutter Interaction flag enabled.
Arguments:
0 - disabled (by default)
1 - enabled
render_show_nodes_interaction_grassConfig file: *.
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating whether the visualizer is enabled for nodes with the Grass Interaction flag enabled.
Arguments:
0 - disabled (by default)
1 - enabled

Occluder Debugging#

Operations on the occluder debugging.

render_show_occluderConfig file: *.user
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Enables displaying of the buffer used for occluders shown in the viewport.
Arguments:
0 - disabled (by default)
1 - enabled

Vertex Color Debugging#

Operations on vertex color debugging.

render_show_vertex_colorConfig file: *.
Description:
  • Variable.   Prints the current value indicating whether displaying of geometry that uses the selected vertex color is enabled.
  • Command.   Sets the value indicating whether displaying of geometry that uses the selected vertex color is enabled.
Arguments:
0 - disabled. (by default)
1 - Red color.
2 - Green color.
3 - Blue color.
4 - Alpha color.
5 - RGB color.

Landscape Terrain Debugging#

Operations on the Landscape Terrain debugging.

render_show_landscape_albedoConfig file: *.user
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Enables visualization of albedo data of a Landscape Terrain.
Arguments:
0 - disabled (by default)
1 - enabled
render_show_landscape_maskConfig file: *.user
Description:
  • Variable.   Prints the current visualization of a detail mask of a Landscape Terrain.
  • Command.   Sets the visualization of a detail mask of a Landscape Terrain.
Arguments:
0 - mask vizualization is disabled (by default)
1 - DetailMask 0
2 - DetailMask 1
3 - ...
4 - DetailMask 19
render_show_landscape_terrain_vt_streamingConfig file: *.user
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Enables visualization of tiles being streamed. In this mode colored areas show the tiles that are currently being rendered in a lower resolution until the highest MIP-level is loaded.
Arguments:
0 - disabled (by default)
1 - enabled
render_show_clusters
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating whether the visualizer is displayed for Mesh Cluster objects.
Arguments:
0 - disabled (by default)
1 - enabled
Description:
render_show_field_mask_bits
Description:
value indicating which bit or bits of the field mask are used for visualization. The surfaces that use the specified bits of the field mask will be highlighted. To use this option, rendering of the relevant visualizer (see the render_show_field_mask) should be enabled.
render_show_shadow_mask
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating whether the visualizer is enabled to highlight the surfaces that use the specified bits of the shadow mask.
Arguments:
0 - disabled (by default)
1 - enabled
render_show_shadow_mask_bits
Description:
value indicating which bit or bits of the shadow mask are used for visualization. The surfaces that use the specified bits of the shadow mask will be highlighted. To use this option, rendering of the relevant visualizer (see the render_show_shadow_mask) should be enabled.
render_show_obstacle_mask
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating whether the visualizer is enabled to highlight the surfaces that use the specified bits of the obstacle mask.
Arguments:
0 - disabled (by default)
1 - enabled
render_show_obstacle_mask_bits
Description:
value indicating which bit or bits of the obstacle mask are used for visualization. The surfaces that use the specified bits of the obstacle mask will be highlighted. To use this option, rendering of the relevant visualizer (see the render_show_obstacle_mask) should be enabled.
render_show_material_mask
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating whether the visualizer is enabled to highlight the surfaces that use the specified bits of the material mask.
Arguments:
0 - disabled (by default)
1 - enabled
render_show_material_mask_bits
Description:
value indicating which bit or bits of the material mask are used for visualization. The surfaces that use the specified bits of the material mask will be highlighted. To use this option, rendering of the relevant visualizer (see the render_show_material_mask) should be enabled.
render_show_viewport_mask
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating whether the visualizer is enabled to highlight the surfaces that use the specified bits of the viewport mask.
Arguments:
0 - disabled (by default)
1 - enabled
render_show_viewport_mask_bits
Description:
value indicating which bit or bits of the viewport mask are used for visualization. The surfaces that use the specified bits of the viewport mask will be highlighted. To use this option, rendering of the relevant visualizer (see the render_show_viewport_mask) should be enabled.
render_show_physical_mask
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating whether the visualizer is enabled to highlight the surfaces that use the specified bits of the physical mask.
Arguments:
0 - disabled (by default)
1 - enabled
render_show_physical_mask_bits
Description:
value indicating which bit or bits of the physical mask are used for visualization. The surfaces that use the specified bits of the physical mask will be highlighted. To use this option, rendering of the relevant visualizer (see the render_show_physical_mask) should be enabled.
render_show_collision_mask
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating whether the visualizer is enabled to highlight the surfaces that use the specified bits of the collision mask.
Arguments:
0 - disabled (by default)
1 - enabled
render_show_collision_mask_bits
Description:
value indicating which bit or bits of the collision mask are used for visualization. The surfaces that use the specified bits of the collision mask will be highlighted. To use this option, rendering of the relevant visualizer (see the render_show_collision_mask) should be enabled.
render_show_navigation_mask
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating whether the visualizer is enabled to highlight the surfaces that use the specified bits of the navigation mask.
Arguments:
0 - disabled (by default)
1 - enabled
render_show_navigation_mask_bits
Description:
value indicating which bit or bits of the navigation mask are used for visualization. The surfaces that use the specified bits of the navigation mask will be highlighted. To use this option, rendering of the relevant visualizer (see the render_show_navigation_mask) should be enabled.
render_show_intersection_mask
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating whether the visualizer is enabled to highlight the surfaces that use the specified bits of the intersection mask.
Arguments:
0 - disabled (by default)
1 - enabled
render_show_intersection_mask_bits
Description:
value indicating which bit or bits of the intersection mask are used for visualization. The surfaces that use the specified bits of the intersection mask will be highlighted. To use this option, rendering of the relevant visualizer (see the render_show_intersection_mask) should be enabled.
render_show_sound_reverb_mask
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating whether the visualizer is enabled to highlight the surfaces that use the specified bits of the reverberation mask.
Arguments:
0 - disabled (by default)
1 - enabled
render_show_sound_reverb_mask_bits
Description:
value indicating which bit or bits of the reverberation mask are used for visualization. The surfaces that use the specified bits of the reverberation mask will be highlighted. To use this option, rendering of the relevant visualizer (see the render_show_sound_reverb_mask) should be enabled.
render_show_sound_source_mask
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating whether the visualizer is enabled to highlight the surfaces that use the specified bits of the sound source mask.
Arguments:
0 - disabled (by default)
1 - enabled
render_show_sound_source_mask_bits
Description:
value indicating which bit or bits of the sound source mask are used for visualization. The surfaces that use the specified bits of the sound source mask will be highlighted. To use this option, rendering of the relevant visualizer (see the render_show_sound_source_mask) should be enabled.
render_show_sound_occlusion_mask
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating whether the visualizer is enabled to highlight the surfaces that use the specified bits of the sound occlusion mask.
Arguments:
0 - disabled (by default)
1 - enabled
render_show_sound_occlusion_mask_bits
Description:
value indicating which bit or bits of the sound occlusion mask are used for visualization. The surfaces that use the specified bits of the sound occlusion mask will be highlighted. To use this option, rendering of the relevant visualizer (see the render_show_sound_occlusion_mask) should be enabled.
render_show_physical_exclusion_mask
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating whether the visualizer is enabled to highlight the surfaces that use the specified bits of the physical exclusion mask.
Arguments:
0 - disabled (by default)
1 - enabled
render_show_physical_exclusion_mask_bits
Description:
value indicating which bit or bits of the physical exclusion mask are used for visualization. The surfaces that use the specified bits of the physical exclusion mask will be highlighted. To use this option, rendering of the relevant visualizer (see the render_show_physical_exclusion_mask) should be enabled.
render_show_physics_intersection_mask
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating whether the visualizer is enabled to highlight the surfaces that use the specified bits of the physics intersection mask.
Arguments:
0 - disabled (by default)
1 - enabled
render_show_physics_intersection_mask_bits
Description:
value indicating which bit or bits of the physics intersection mask are used for visualization. The surfaces that use the specified bits of the physics intersection mask will be highlighted. To use this option, rendering of the relevant visualizer (see the render_show_physics_intersection_mask) should be enabled.
render_show_visualizer_distanceConfig file: *.
Description:
  • Variable.   Prints the current distance from the camera within which the helpers are visualized.
  • Command.   Sets the distance from the camera within which the helpers are visualized.
Arguments:
[0; 100000] - available range
500 - by default
render_show_complex_shadow_shader
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating whether the visualizer is displayed for objects that cast shadows in the following way: the pixels are cut out during the shadow pass, as it's done in Alpha Test or Alpha Blend materials, materials assigned to animated Mesh Skinned, opaque materials with the enabled Depth Offset or any other effects that affect shadows.
Arguments:
0 - disabled (by default)
1 - enabled
render_show_surface_custom_texture_not_available
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating whether the visualizer is displayed for surfaces the materials of which use the surface custom texture in the material graph, however the option is not enabled for the surface.
Arguments:
0 - disabled (by default)
1 - enabled
render_show_surface_custom_texture_not_used
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating whether the visualizer is displayed for surfaces with the surface custom texture enabled and/or set, but not used in the material graph.
Arguments:
0 - disabled (by default)
1 - enabled
render_show_surface_custom_texture
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating whether the visualizer is displayed for surfaces with the surface custom texture enabled.
Arguments:
0 - disabled (by default)
1 - enabled
render_show_physics_intersection
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating whether the visualizer is displayed for surfaces with the physics intersection enabled.
Arguments:
0 - disabled (by default)
1 - enabled
render_show_intersection
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating whether the visualizer is displayed for surfaces with the Intersection enabled.
Arguments:
0 - disabled (by default)
1 - enabled
render_show_manual_materials
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating whether the visualizer is displayed for objects with manual materials.
Arguments:
0 - disabled (by default)
1 - enabled
render_show_non_manual_materials
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating whether the visualizer is displayed for objects with non-manual materials.
Arguments:
0 - disabled (by default)
1 - enabled

Physics Debugging#

physics_show_collision_surfacesConfig file: *.user
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Enables displaying of collision surfaces.
Arguments:
0 - disabled (by default)
1 - enabled
physics_show_contactsConfig file: *.user
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Enables displaying of contact points between physical bodies.
Arguments:
0 - disabled (by default)
1 - enabled
physics_show_jointsConfig file: *.user
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Enables displaying of joints between physical bodies.
Arguments:
0 - disabled (by default)
1 - enabled
physics_show_shapesConfig file: *.user
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Enables displaying of collision shapes for physical bodies.
Arguments:
0 - disabled (by default)
1 - enabled

Texture Debugging#

Operations on the texture debugging.

render_show_texture_resolution
Description:
  • Variable.   Prints the current display mode for texture resolution used by the renderer.
  • Command.   Sets the display mode for texture resolution used by the renderer.
Arguments:
0 - disabled (by default)
1 - show surfaces depending on maximum resolution of textures used in materials assigned to them applying colors in accordance with the scale
2 - show the relationship between maximum texture resolution of the material to the size of triangles on the screen to which it is applied: blue indicates insufficient texture resolution, while yellow tells that it is excessive, if the color is green - everything is ok.
render_show_texture_resolution_blend
Description:
  • Variable.   Prints the current value used for blending the rendered image with the color displaying the texture resolution.
  • Command.   Sets the value used for blending the rendered image with the color displaying the texture resolution.
Arguments:
[0; 1] - available range
0.5 - by default
render_show_texture_resolution_uv_mode
Description:
Arguments:
0 - UV0 (by default)
1 - UV1

Occlusion Queries#

render_show_queriesConfig file: *.user
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Enables displaying of occlusion query boxes.
    Notice
    Make sure that the Culled by occlusion query flag is set for nodes.
Arguments:
0 - disabled (by default)
1 - enabled

Performance Profiling#

Operations on the Performance profiler.

show_profilerConfig file: *.user
Description:
  • Variable.   Prints the current mode for the Performance profiler.
  • Command.   Sets the mode for the Performance profiler.
Arguments:
0 - profiler information is hidden (by default)
1 - generic profiler information is shown
2 - rendering profiler information is shown
3 - physics profiler information is shown
4 - world profiler information is shown
5 - pathfinding and sound usage profiler information is shown
show_profiler_chartsConfig file: *.user
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Enables displaying of Performance profiler's charts.
Arguments:
0 - disabled
1 - enabled (by default)

Profiler GUI#

Operations on the Performance profiler style.

profiler_sizeConfig file: *.boot
Description:
  • Variable.   Prints the current size for the profiler font.
  • Command.   Sets the size for the profiler font.
Arguments:
[4; 32] - available range
13 - by default
profiler_fontConfig file: *.boot
Description:
  • Variable. Prints a current path to a *.ttf file used as a profiler font.
  • Command. Sets a path to a *.ttf file to be used as a profiler font.
Arguments:
Path to a *.ttf file
core/gui/font.ttf (by default)

Microprofile#

Operations on the Microprofile.

microprofile_enabled
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Enables Microprofile.
Arguments:
0 - disabled
1 - enabled (by default)
microprofile_info
Description:
  • Command. Prints the Microprofile settings:
    • Maximum number of frames that can be profiled
    • Number of dump frames
    • Flag indicating if GPU profiling is enabled
    • Web server status
    • Web server port
    • Number of webserver frames
    If the application is compiled without Microprofile, the corresponding message will be printed to the console.
microprofile_webserver_framesConfig file: *.user
Description:
  • Variable.   Prints the current number of frames to be visualised in your Web browser.
  • Command.   Sets the number of frames to be visualised in your Web browser.
Arguments:
[1; 500] - available range
200 - by default
microprofile_dump_framesConfig file: *.user
Description:
  • Variable.   Prints the current number of frames to be included in the Microprofile dump.
  • Command.   Sets the number of frames to be included in the Microprofile dump.
Arguments:
[1; 500] - available range
500 - by default
microprofile_dump_html
Description:
  • Command. Saves the Microprofile dump to an .html file.
If the path isn't specified, the dump is saved to data/microprofile_dump_html folder.
Arguments:
Path to an .html file.

VR Settings#

vr_info
Description:
  • Command. Prints the information on the current VR API and the connected VR devices — HMD, controllers, and others. For the controllers, it also displays the battery level (if available).
vr_reset_zero_pose
Description:
  • Command. Sets the zero pose to the current tracker position.
vr_render_enabledConfig file: *.boot
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if rendering into the head-mounted display is enabled.
Arguments:
0 - disabled (by default)
1 - enabled
vr_peripheral_rendering_mode_enabledConfig file: *.boot
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if the peripheral rendering mode is enabled. In this mode, the HMD has two context (peripheral) and two focus displays. You can disable two additional viewports to improve peformance.
    Notice
    This feature is available for the Varjo devices only.
Arguments:
0 - disabled (by default)
1 - enabled
vr_service_init_timeoutConfig file: *.boot
Description:
  • Variable.   Prints the current VR initialization timeout in number of attempts. The engine attempts to run VR Service and has to wait for its initialization.
  • Command.   Sets the VR initialization timeout in number of attempts. The engine attempts to run VR Service and has to wait for its initialization.
Arguments:
[0; 200] - available range
60 - by default
vr_mirror_modeConfig file: *.boot
Description:
  • Variable.   Prints the current mirror mode that defines how the mirrored image (i.e. VR image) will be displayed in the target window.
  • Command.   Sets the mirror mode that defines how the mirrored image (i.e. VR image) will be displayed in the target window.
Arguments:
0 - black screen (no image is displayed).
1 - image rendered for the left eye.
2 - image rendered for the right eye.
3 - stereo image (both the left and right eyes). (by default)
vr_window_modeConfig file: *.boot
Description:
  • Variable.   Prints the current window mode that defines which window will display the mirrored image (i.e. VR image).
  • Command.   Sets the window mode that defines which window will display the mirrored image (i.e. VR image).
Arguments:
0 - mirroring is disabled.
1 - main window displays the mirrored image. (by default)
vr_tracking_spaceConfig file: *.boot
Description:
  • Variable.   Prints the current zero pose of the tracking origin.
  • Command.   Sets the zero pose of the tracking origin.
Arguments:
0 - seated.
1 - standing. (by default)
2 - raw (uncalibrated).
vr_head_tracking_position_enabledConfig file: *.boot
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if the head position is locked.
Arguments:
0 - disabled
1 - enabled (by default)
vr_head_tracking_rotation_enabledConfig file: *.boot
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if the head rotation is locked.
Arguments:
0 - disabled
1 - enabled (by default)
vr_motion_predictionConfig file: *.boot
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if motion prediction in the Varjo headsets is enabled. When enabled, the engine submits the velocity value from the GBuffer to the Varjo Composer.
Arguments:
0 - disabled (by default)
1 - enabled
vr_motion_prediction_velocity_precisionConfig file: *.boot
Description:
  • Variable.   Prints the current factor of velocity scale before packing a floating point value into a 2x8 bit unsigned integer (uint).
    Notice
    This feature is available for the Varjo devices only.
  • Command.   Sets the factor of velocity scale before packing a floating point value into a 2x8 bit unsigned integer (uint).
    Notice
    This feature is available for the Varjo devices only.
Arguments:
[eps; inf] - available range
32.0f - by default
vr_motion_prediction_velocity_time_deltaConfig file: *.boot
Description:
  • Variable.   Prints the current factor for optimizing between fast and slow-moving objects. A smaller number works better for fast-moving objects, and vice versa.
    Notice
    This feature is available for the Varjo devices only.
  • Command.   Sets the factor for optimizing between fast and slow-moving objects. A smaller number works better for fast-moving objects, and vice versa.
    Notice
    This feature is available for the Varjo devices only.
Arguments:
[eps; inf] - available range
1.0f / 60.0f - by default
vr_foveated_rendering_enabledConfig file: *.boot
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if foveated rendering is enabled. Foveated rendering makes use of the eye tracking functionality in the Varjo headsets to improve performance by reducing the image quality in peripheral areas where the user is not looking. Foveation allows applications to render fewer pixels and achieve a better VR experience.
    Notice
    This feature is available for the Varjo devices only.
Arguments:
0 - disabled
1 - enabled (by default)

Mixed Reality Settings#

vr_mixed_reality_chroma_key_enabled
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if chroma keying is enabled. VST capturing from HMD cameras must be enabled.
Arguments:
0 - disabled (by default)
1 - enabled
vr_mixed_reality_depth_test_enabled
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if depth buffer submission is enabled. VST capturing from HMD cameras must be enabled.
Arguments:
0 - disabled (by default)
1 - enabled
vr_mixed_reality_alpha_blend_enabled
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if alpha blending is enabled. This option is used for blending VR and AR images using the alpha channel. VST capturing from HMD cameras must be enabled and the screen precision must be 1.
Arguments:
0 - disabled (by default)
1 - enabled
vr_mixed_reality_video_enabled
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if the video signal from the real-world view from the front-facing HMD-mounted cameras is enabled. The real-world view is used for combining virtual and real-world elements to create an immersive experience in mixed reality.
Arguments:
0 - disabled (by default)
1 - enabled
vr_mixed_reality_depth_test_range_enabled
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if the depth test range usage is enabled. Use the depth test range (Depth Test Near Z, Depth Test Far Z) to control the range for which the depth test is evaluated.
Arguments:
0 - disabled (by default)
1 - enabled
vr_mixed_reality_depth_test_range
Description:
  • Variable.   Prints the current depth test range as a two-component vector (the near and far planes). The depth test range usage must be enabled.
  • Command.   Sets the depth test range as a two-component vector (the near and far planes). The depth test range usage must be enabled.
Arguments:
vec2(0.0f, 1.0f) - default value
vr_mixed_reality_camera_exposure_timeConfig file: *.boot
Description:
  • Variable.   Prints the current exposure time value that is valid for the connected device.
  • Command.   Sets the exposure time value that is valid for the connected device.
Arguments:
  • 1 - exposure time value equal to 91 ms
  • 2 - exposure time value equal to 125 ms (default)
  • 3 - exposure time value equal to 250 ms
  • 4 - exposure time value equal to 500 ms
  • 5 - exposure time value equal to 1000 ms
  • 6 - exposure time value equal to 2000 ms
  • 7 - exposure time value equal to 4000 ms
  • 8 - exposure time value equal to 8000 ms
vr_mixed_reality_camera_exposure_time_mode
Description:
  • Variable.   Prints the current exposure adjustment mode for the camera.
  • Command.   Sets the exposure adjustment mode for the camera.
Arguments:
0 - exposure adjustment is disabled
1 - automatic exposure adjustment (by default)
2 - manual exposure adjustment
vr_mixed_reality_camera_white_balanceConfig file: *.boot
Description:
  • Variable.   Prints the current white balance correction value that is valid for the connected device.
  • Command.   Sets the white balance correction value that is valid for the connected device.
Arguments:
  • 1 - white balance value equal to 2000 K
  • 2 - white balance value equal to 3000 K
  • 3 - white balance value equal to 3500 K
  • 4 - white balance value equal to 4200 K
  • 5 - white balance value equal to 5000 K
  • 6 - white balance value equal to 5400 K
  • 7 - white balance value equal to 6500 K (default)
  • 8 - white balance value equal to 8000 K
  • 9 - white balance value equal to 12000 K
vr_mixed_reality_camera_white_balance_mode
Description:
  • Variable.   Prints the current white balance adjustment mode for the camera.
  • Command.   Sets the white balance adjustment mode for the camera.
Arguments:
0 - white balance adjustment is disabled
1 - automatic white balance adjustment (by default)
2 - manual white balance adjustment
vr_mixed_reality_camera_isoConfig file: *.boot
Description:
  • Variable.   Prints the current ISO value for the camera.
  • Command.   Sets the ISO value for the camera.
Arguments:
  • 1 - ISO value equal to 100
  • 2 - ISO value equal to 200
  • 3 - ISO value equal to 400
  • 4 - ISO value equal to 800 (default)
  • 5 - ISO value equal to 1600
  • 6 - ISO value equal to 3200
  • 7 - ISO value equal to 6400
vr_mixed_reality_camera_iso_mode
Description:
  • Variable.   Prints the current ISO adjustment mode for the camera.
  • Command.   Sets the ISO adjustment mode for the camera.
Arguments:
0 - ISO adjustment is disabled
1 - automatic ISO adjustment (by default)
2 - manual ISO adjustment
vr_mixed_reality_camera_flicker_compensationConfig file: *.boot
Description:
  • Variable.   Prints the current flicker compensation value for the camera.
  • Command.   Sets the flicker compensation value for the camera. This is useful when using the HMD indoors with mostly artificial light bulbs, which flicker at the frequency of 50Hz or 60Hz and can cause visual flicker artifacts on the video see through image. The correct setting depends on the underlying power grid's frequency. For example, in most parts of Africa/Asia/Australia/Europe the frequency is 50 Hz and in most parts of North and South America 60 Hz.
Arguments:
  • 1 - flicker compensation value equal to 50 Hz (default).
  • 2 - flicker compensation value equal to 60 Hz.
vr_mixed_reality_camera_sharpness
Description:
  • Variable.   Prints the current sharpness filter power value for the camera.
  • Command.   Sets the sharpness filter power value for the camera.
Arguments:
[0; 10] - available range
0 - by default
vr_mixed_reality_view_offset
Description:
  • Variable.   Prints the current eyes view offset (where eye camera should be positioned when using Mixed Reality):
    • 0 for physical eye position
    • 1 for VST camera position
  • Command.   Sets the eyes view offset (where eye camera should be positioned when using Mixed Reality):
    • 0 for physical eye position
    • 1 for VST camera position
Arguments:
[0.0; 1.0] - available range
0.0 - by default
vr_mixed_reality_marker_tracking_enabled
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if marker tracking is enabled.
Arguments:
0 - disabled (by default)
1 - enabled
vr_mixed_reality_marker_visualizer_enabledConfig file: *.boot
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating the marker visualizer is enabled.
Arguments:
0 - disabled (by default)
1 - enabled
vr_mixed_reality_blend_masking_mode
Description:
  • Variable.   Prints the current mode of the Blend Control Mask that can be used to extend or restrict the chroma key mask or to control the depth testing against the estimated video depth.
  • Command.   Sets the mode of the Blend Control Mask that can be used to extend or restrict the chroma key mask or to control the depth testing against the estimated video depth.
Arguments:
0 - Disabled (masking mode is disabled). (by default)
1 - Restrict Video to Mask (show the video pass-through image (VST) in the mask; can be used with chroma key)
2 - Restrict VR to Mask (show VR in the mask; can be used with chroma key)
3 - Restrict VR to Chromakey reduced by Mask (show VR in the mask and chroma elsewhere; requires chroma key)
vr_mixed_reality_blend_masking_debug_enabled
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if blend masking debug visualization is enabled. The blend masking mode must be enabled.
Arguments:
0 - disabled (by default)
1 - enabled
vr_mixed_reality_cubemap_mode
Description:
  • Variable.   Prints the current mode defining the way the AR texture is set for the environment.
  • Command.   Sets the mode defining the way the AR texture is set for the environment.
Arguments:
0 - cubemap streaming from AR cameras is disabled.
1 - environment texture substitutes the sky.
2 - the first environment preset defines the way the AR texture is set for the environment. (by default)
3 - the second environment preset defines the way the AR texture is set for the environment.
4 - the third environment preset defines the way the AR texture is set for the environment.
vr_mixed_reality_cubemap_ggx_quality
Description:
  • Variable.   Prints the current quality of the generated GGX mips for the AR cubemap.
  • Command.   Sets the quality of the generated GGX mips for the AR cubemap.
Arguments:
0 - low
1 - medium (by default)
2 - high
3 - ultra
vr_mixed_reality_override_color_correction_mode
Description:
  • Variable.   Prints the current color correction mode for the stream from the AR cameras.
  • Command.   Sets the color correction mode for the stream from the AR cameras.
Arguments:
0 - correction is disabled. (by default)
1 - exposure correction for the stream from the AR cameras.
2 - exposure and white balance correction for the stream.

Video Settings#

video_adapterConfig file: *.boot
Description:
  • Variable.   Prints the current the hardware video adapter ID to be used for rendering.
  • Command.   Sets the the hardware video adapter ID to be used for rendering. The value must be from 0 to the number of available video adapters.
    Notice
    Available only during the Engine initialization (startup), has no effect at run time.
Arguments:
[0; 32] - available range
0 - by default
video_debugConfig file: *.boot
Description:
  • Variable.   Prints the current video debug mode for graphical API.
  • Command.   Sets the video debug mode for graphical API.
    Notice
    Beware of severe slowdown when enabled. Available only during the Engine initialization (startup), has no effect at run time.
Arguments:
0 - release rendering context (no debug) (by default)
1 - debug rendering context
2 - debug rendering context with break on error (only on debug binaries)
3 - GPU side validation (dx12-only, only on debug binaries)
video_debug_shadersConfig file: *.boot
Description:
  • Variable.   Prints the current Enables or disables debug shaders for the application regardless of its binary type (debug or release).
  • Command.   Sets the Enables or disables debug shaders for the application regardless of its binary type (debug or release). This option should be enabled in case you use graphics debugging tools (e.g., the RenderDoc debugger).
Arguments:
0 - disable debug shaders (release shaders are used) (by default)
1 - enable debug shaders
show_displays
Description:
  • Command. Prints the information about all available displays.
show_display_modes
Description:
  • Command. Prints the information about all available modes for the specified display.
Arguments:
Index of the display for which modes are to be displayed (0 - by default).

Main Window Resolution and Fullscreen#

Operations on main window options adjustment (size, fullscreen mode, borders, restart, etc.).

video_offscreenConfig file: *.boot
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Enables the offscreen mode for the application, making it possible to run UNIGINE Engine in a cloud and use powerful servers (e.g., to generate photorealistic datasets for deep learning and verification of AI algorithms).
    Notice
    Available only during the Engine initialization (startup), has no effect at run time.
Arguments:
0 - disabled (by default)
1 - enabled
main_windowConfig file: *.boot
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Enables creating a main window during the application start-up. After starting up the application any window can be created and will work normally. For example, this can be useful in a custom editor or any other application, where there should be no main Engine window.
    Notice
    Available only during the Engine initialization (startup), has no effect at run time.
Arguments:
0 - disabled
1 - enabled (by default)
main_window_sizeConfig file: *.boot
Description:
  • Variable.   Prints the current size of the main application window.
  • Command.   Sets the size of the main application window.
Arguments:
Usage with the argument:
main_window_size width height
(1600 x 900 by default)
main_window_resizableConfig file: *.boot
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Enables the resizable mode for the main application window (its size can be changed on the fly without restarting the application).
Arguments:
0 - disabled
1 - enabled (by default)
main_window_fullscreenConfig file: *.boot
Description:
  • Variable.   Prints the current fullscreen mode for the application window. Only one window is available, when the application runs in the fullscreen mode (no other windows or dialogs shall be displayed atop).
  • Command.   Sets the fullscreen mode for the application window. Only one window is available, when the application runs in the fullscreen mode (no other windows or dialogs shall be displayed atop).
Arguments:
0 - windowed mode (by default)
1 - full-screen mode
main_window_fullscreen_displayConfig file: *.boot
Description:
  • Variable.   Prints the current display on which to show the main application window in fullscreen mode.
  • Command.   Sets the display on which to show the main application window in fullscreen mode.
Arguments:
0 - Main - display set as main in OS settings. (by default)
1 - Current - display that currently has focus (where the mouse cursor is).
main_window_fullscreen_display_modeConfig file: *.boot
Description:
  • Variable.   Prints the current display mode (resolution and frequency) for the application window to be shown in fullscreen mode.
  • Command.   Sets the display mode (resolution and frequency) for the application window to be shown in fullscreen mode.
Arguments:
0 - Desktop - use display mode currently selected on the user's computer. (by default)
1 - Mode by window size - try to find an appropriate display mode that corresponds to the current window resolution (while looking for the appropriate resolution the Engine tries to keep the current desktop display frequency if possible, otherwise it takes maximum available frequency).
Notice
In case such mode does not exist (a corresponding error message is displayed), switch to the Desktop mode.

main_window_auto_restartConfig file: *.boot
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Enables automatic reopening of the main application window after changing its settings (fullscreen mode, borders, size, etc.). Can be disabled, when necessary, to control main window restart manually via the restart_main_window command.
Arguments:
0 - disabled
1 - enabled (by default)
main_window_bordersConfig file: *.boot
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Enables drawing the borders of the main application window. In some cases it might be necessary to render the window in borderless mode.
Arguments:
0 - disabled
1 - enabled (by default)
restart_main_window
Description:

Graphics Settings#

Operations on the graphics adjustment.

render_vsyncConfig file: *.boot
Description:
  • Variable.   Prints the current vertical FPS synchronization.
  • Command.   Sets the vertical FPS synchronization.
Arguments:
0 - not to synchronize FPS (by default)
1 - synchronize FPS
2 - enable adaptive vertical sync

Multi-Monitor and Stereo Rendering#

video_quad_bufferConfig file: *.boot
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Enables quad buffered stereo.
    Notice
    Available only during the Engine initialization (startup), has no effect at run time.
Arguments:
0 - disabled (by default)
1 - enabled

Rendering Settings#

Operations on the renderer.

textures_reload
Description:
  • Command. Reloads all render textures.
render_streaming_reload
Description:
  • Command. Reloads all rendering resources. You can specify an optional argument to reload resources selectively.

Usage with the argument: render_streaming_reload [mesh/texture]
Arguments:
none - reloads all resources
mesh - reload only meshes
texture - reload only textures

Rendering Resources#

Operations representing information on the rendering resources.

render_budget
Description:
  • Variable.   Prints the current render budget value, in seconds, which limits the number of loaded/created graphics resources during a frame according to loading/creation time.
  • Command.   Sets the render budget value, in seconds, which limits the number of loaded/created graphics resources during a frame according to loading/creation time.
Arguments:
[0.0f; inf] - available range
1/60 - by default
render_streaming_meshes_info
Description:
  • Command. Prints general information (the number of registered/loaded meshes; memory used) on rendering resources.
render_streaming_meshes_list
Description:
  • Command. Prints the list of loaded meshes and detailed information about the memory used.
render_streaming_meshes_reload
Description:
  • Command. Reloads all loaded meshes.
render_streaming_first_frames_force
Description:
  • Variable.   Prints the current number of frames to load immediately after the first frame.
  • Command.   Sets the number of frames to load immediately after the first frame. It will make the scene appear right at the application start-up.
Arguments:
[0; INT_MAX] - available range
60 - by default
render_streaming_max_threads
Description:
  • Variable.   Prints the current maximum number of threads used for streaming.
  • Command.   Sets the maximum number of threads used for streaming. Higher number of threads results in faster streaming, but may cause spikes in case of excessive consumption of GPU resources.
Arguments:
[1; 256] - available range
1 - by default
render_streaming_particles_memory_limit
Description:
  • Variable.   Prints the current cache memory limit for vertices of particle systems, in percentage of the total GPU memory.
  • Command.   Sets the cache memory limit for vertices of particle systems, in percentage of the total GPU memory.
    Notice
    Setting a too low limit for a huge number of particle systems in the scene may lead to rendering only some of them.
Arguments:
[0; 100] - available range
3 - by default
render_streaming_budget_loading
Description:
  • Variable.   Prints the current time limit for loading graphics resources, in milliseconds per frame.
  • Command.   Sets the time limit for loading graphics resources, in milliseconds per frame. Increasing the limit leads to increasing the streaming performance. However, memory consumption also increases due to a decrease in the resource loading speed.
Arguments:
[0.0f; inf] - available range
1.0f - by default
render_streaming_budget_destroy_textures
Description:
  • Variable.   Prints the current time limit for deleting textures, in milliseconds per frame.
  • Command.   Sets the time limit for deleting textures, in milliseconds per frame. The Engine will distribute the textures cleanup process by the required number frames in order to not exceed the time limit. The number of frames will also depend on the amount of content in the scene and the computing capacity. Increasing the limit leads to increasing the streaming performance. However, memory consumption also increases due to a decrease in the texture unloading speed.
Arguments:
[0.0f; inf] - available range
0.1f - by default
render_streaming_budget_destroy_meshes
Description:
  • Variable.   Prints the current time limit for deleting meshes, in milliseconds per frame.
  • Command.   Sets the time limit for deleting meshes, in milliseconds per frame. The Engine will distribute the meshes cleanup process by the required number frames in order to not exceed the time limit. The number of frames will also depend on the amount of content in the scene and the computing capacity. Increasing the limit leads to increasing the streaming performance. However, memory consumption also increases due to a decrease in the mesh unloading speed.
Arguments:
[0.0f; inf] - available range
0.1f - by default
render_streaming_textures_mode
Description:
  • Variable.   Prints the current streaming mode for textures.
  • Command.   Sets the streaming mode for textures. The following modes are available:
    • Async - asynchronous loading of textures.
    • Force - force-loading of textures required for each frame at ones.
Arguments:
0 - asynchronous streaming (by default)
1 - force-loading of resources
render_streaming_textures_cache_resolution
Description:
  • Variable.   Prints the current resolution for texture cache elements.
  • Command.   Sets the resolution for texture cache elements. These minimized copies of textures are used instead of the originals while the latter are loaded.
Arguments:
0 - 8x8
1 - 16x16 (by default)
2 - 32x32
3 - 64x64
4 - 128x128
5 - 256x256
6 - 512x512
render_streaming_textures_memory_limit
Description:
  • Variable.   Prints the current cache memory limit used for textures streaming.
  • Command.   Sets the cache memory limit used for textures streaming. This is a recommended value to aim for. So, it can be exceeded if textures are required to render the current frame. The memory limit is associated with the lifetime: textures are deleted from video memory only when both values are exceeded.
Arguments:
[0; 100] - available range
65 - by default
render_streaming_textures_life_time
Description:
  • Variable.   Prints the current lifetime of GPU cache used for textures rendering.
  • Command.   Sets the lifetime of GPU cache used for textures rendering. The engine deletes textures after this time only if the specified memory limit for textures streaming is also exceeded.
Arguments:
[1; 60] - available range
4 - by default
render_streaming_meshes_mode_ram
Description:
  • Variable.   Prints the current streaming mode for loading meshes to memory (RAM).
  • Command.   Sets the streaming mode for loading meshes to memory (RAM). The following modes are available:
    • Async - asychronous loading of meshes.
    • Force - force-loading of meshes required for the current frame at once.
    • All - loading all meshes available in the project on the application start-up. This mode is good for small projects with few meshes.
Arguments:
0 - asynchronous streaming (by default)
1 - force-loading of resources
2 - loading of all resources
render_streaming_meshes_limit_ram
Description:
  • Variable.   Prints the current memory limit used for loading meshes to memory (RAM).
  • Command.   Sets the memory limit used for loading meshes to memory (RAM). This is a recommended value to aim for. So, it can be exceeded if meshes are required for the current frame. The memory limit is associated with the lifetime: meshes are deleted from RAM only when both values are exceeded.
Arguments:
[1; 100] - available range
5 - by default
render_streaming_meshes_life_time_ram
Description:
  • Variable.   Prints the current lifetime of meshes in memory since the last time they were accessed.
  • Command.   Sets the lifetime of meshes in memory since the last time they were accessed. The engine deletes meshes after this time only if the RAM limit is also exceeded.
Arguments:
[1; 60] - available range
20 - by default
render_streaming_meshes_mode_vram
Description:
  • Variable.   Prints the current streaming mode for loading meshes to video memory (VRAM).
  • Command.   Sets the streaming mode for loading meshes to video memory (VRAM). The following modes are available:
    • Async - asynchronous loading of meshes.
    • Force - force-loading of meshes required for the current frame at once.
    • All - loading all meshes available in the project on the application start-up. This mode is good for small projects with few meshes.
Arguments:
0 - asynchronous streaming (by default)
1 - force-loading of resources
2 - loading of all resources
render_streaming_meshes_limit_vram
Description:
  • Variable.   Prints the current memory limit used for loading meshes to video memory (VRAM).
  • Command.   Sets the memory limit used for loading meshes to video memory (VRAM). This is a recommended value to aim for. So, it can be exceeded if meshes are required to render the current frame. The memory limit is associated with the lifetime: meshes are deleted from VRAM only when both values are exceeded.
Arguments:
[0; 100] - available range
4 - by default
render_streaming_meshes_life_time_vram
Description:
  • Variable.   Prints the current lifetime of meshes in video memory since the last time they were accessed.
  • Command.   Sets the lifetime of meshes in video memory since the last time they were accessed. The engine deletes meshes after this time only if the specified VRAM limit is also exceeded.
Arguments:
[0; 60] - available range
4 - by default
render_streaming_meshes_prefetch_collision
Description:
  • Variable.   Prints the current mode of asynchronous pre-loading of meshes to memory before they are used.
  • Command.   Sets the mode of asynchronous pre-loading of meshes to memory before they are used. Pre-loading is available only for meshes, which have at least one surface with the Collision flag set. There are 3 modes of loading such meshes to RAM:
    • Disable - loading is disabled.
    • Radius - meshes within the prefetch radius are loaded.
    • Full - all meshes with the Collision flag are loaded.
    This method should be used when the Async streaming mode for meshes is set.
Arguments:
0 - disable (by default)
1 - physics
2 - full
render_streaming_meshes_prefetch_intersection
Description:
  • Variable.   Prints the current mode of asynchronous pre-loading of meshes into memory before they are used.
  • Command.   Sets the mode of asynchronous pre-loading of meshes into memory before they are used. Pre-loading is available only for meshes, which have at least one surface with the Intersection flag set. There are 3 modes of loading such meshes to RAM:
    • Disable - loading is disabled.
    • Radius - all meshes within the prefetch radius are loaded.
    • Full - all meshes with the Intersection flag are loaded.
    This method should be used when the Async streaming mode for meshes is set.
Arguments:
0 - disable (by default)
1 - physics
2 - full
render_streaming_meshes_prefetch_radius
Description:
  • Variable.   Prints the current radius within which meshes are pre-loaded into memory.
  • Command.   Sets the radius within which meshes are pre-loaded into memory. The value should exceed the physics radius (for collisions) and/or the radius within which intersections are calculated.
Arguments:
[0.0f; inf] - available range
0.0f - by default
render_streaming_textures_info
Description:
  • Command. Prints general information (the number of registered/loaded textures; memory used) on rendering textures.
render_streaming_textures_list
Description:
  • Command. Prints the list of loaded textures and detailed information about the memory used,texture format, used compression, if any, and texture dimensions.
render_streaming_textures_reload
Description:
  • Command. Reloads all textures.
render_streaming_textures_cache_destroy
Description:
  • Command. Clears texture cache (images and metadata) stored on disk. All files in the data/.cache_textures will be removed.
render_streaming_textures_cache_load
Description:
  • Command. Loads texture cache from the disk. Texture cache always remains in memory after loading.
render_streaming_textures_cache_unload
Description:
  • Command. Unloads texture cache from the memory. This method does not delete files in the data/.cache_textures.

Rendering Resources: OpenGL-Specific Commands#

Operations representing information on the rendering resources for OpenGL.

Notice
OpenGL API only.
gl_async_bufferConfig file: *.boot
Description:
  • Variable.   Prints the current size of an intermediate buffer (between the CPU and new resource) used for streaming, in Mb.
  • Command.   Sets the size of an intermediate buffer (between the CPU and new resource) used for streaming, in Mb.
    Notice
    • The size of this buffer must be equal to the size of the largest resource (mesh/texture), otherwise in case of a larger resource, the buffer will be resized causing a spike.
    • Be aware, that the size of this intermediate buffer will be added to total memory consumption.
Arguments:
[0; 1024] - available range
128 - by default
gl_async_buffer_indicesConfig file: *.boot
Description:
  • Variable.   Prints the current size of an intermediate buffer used for mesh streaming (to store vertex indices of meshes), in Mb.
  • Command.   Sets the size of an intermediate buffer used for mesh streaming (to store vertex indices of meshes), in Mb.
Arguments:
[0; 256] - available range
16 - by default
gl_async_buffer_synchronizationConfig file: *.boot
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Enables buffer synchronization for transferring data from the streaming thread to the main one.
    Notice
    When enabled, async buffers are created only once and then synchronized reducing the time on allocating and freeing memory. When disabled, both async buffer and async buffer for indices are created anew. This reduces the number of buffer synchronizations but increases the number of memory allocations. Sometimes (depending on the hardware/driver used, e.g. when the main thread is affected by sychronization primitives in other threads) memory allocation may be faster than synchronizations, in such cases, when streaming becomes unacceptably slow, it is recommended to disable buffer synchronization.
Arguments:
0 - disabled
1 - enabled (by default)
gl_use_debug_infoConfig file: *.boot
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Enables debug info usage.
    Notice
    Available for debug builds only.
Arguments:
0 - disabled (by default)
1 - enabled
gl_terrain_use_async
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Enables asynchronous loading of Landscape Terrain tiles.
    Notice
    When disabled, it may reduce performance spikes on certain AMD and Intel GPUs at the cost of the loading speed.
Arguments:
0 - disabled
1 - enabled (by default)
gl_terrain_waiting_frames
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Set the number of frames to wait for streaming Landscape Terrain tiles. Increase this value (4-16 frames) to avoid more performance spikes and slightly improve the loading speed by forcing deferred data loading that imitates asynchronous data streaming without synchronization points.
Arguments:
0 - disabled
1 - enabled (by default)

Rendering Buffers#

Rendering Buffer Info#

Operations representing information on the rendering buffers.

render_info
Description:
  • Command. Print general information on render buffers:
    • Renderer - GPU and available video memory
    • Per-type information on buffers created by the renderer, their number, and used space
    • Total - how much video memory is used in whole
render_list
Description:
  • Command. Print the detailed list of render buffers, with texture size, format and used space.

Rendering Buffer Debugging#

Operations on the rendering buffer debugging.

render_show_texturesConfig file: *.
Description:
  • Variable.   Prints the current display mode for texture buffers used by the renderer.
  • Command.   Sets the display mode for texture buffers used by the renderer. The number of displayed buffers depends on the number of buffers in a row specified by the corresponding command (see the render_show_textures_number).
Arguments:
0 - all buffers are hidden (by default)
1 - show render textures (compact)
2 - show render textures (full)
render_screen_precision
Description:
  • Variable.   Prints the current value indicating the current screen precision.
  • Command.   Sets the value indicating the current screen precision. This parameter determines the texture format used for screen HDR buffers.
Arguments:
0 - RG11B10F
1 - RGBA16F (by default)
render_show_textures_numberConfig file: *.
Description:
  • Variable.   Prints the current number of buffers in a row and column displayed in the full view mode (see the render_show_textures).
  • Command.   Sets the number of buffers in a row and column displayed in the full view mode (see the render_show_textures). Textures are displayed in the following manner, depending on the set value:
    • 1 — a single texture per screen
    • 2 — 2x2 textures per screen
    • 3 — 3x3 textures per screen
    • ... etc.
Arguments:
[0; 16] - available range
7 - by default
render_show_textures_offsetConfig file: *.
Description:
  • Variable.   Prints the current number of the buffer to start displaying from in the full view mode (see the render_show_textures).
  • Command.   Sets the number of the buffer to start displaying from in the full view mode (see the render_show_textures).
Arguments:
[0; 256] - available range
0 - by default

Rendering Passes#

Operations on rendering passes.

render_debug
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating whether debug materials (the debug_materials material) are rendered. Debug materials can be used for debugging of image generation stages. For example, you can render only SSR, or only cubemaps and so on.
Arguments:
0 - disabled (by default)
1 - enabled
render_depth_pre_pass
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if depth pre-pass rendering is enabled. When enabled, an additional depth buffer rendering pass is performed in the beginning of the rendering sequence.
    Notice
    This option can be used to gain performance for well optimized scenes using LODs and having a low-to-medium number of triangles in case of GPU bottlenecks. In other cases (heavy CAD models, large number of triangles and CPU bottlenecks) it may reduce performance, so it is recommended to use profiling tools to make sure that a positive effect is obtained.
Arguments:
0 - disabled (by default)
1 - enabled
render_show_scissorsConfig file: *.
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if scissor rectangles are displayed.
Arguments:
0 - disabled (by default)
1 - enabled
render_show_ambientConfig file: *.
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating whether the ambient pass buffer is displayed.
Arguments:
0 - disabled (by default)
1 - enabled
render_show_alpha_testConfig file: *.
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating whether the visualizer is displayed for transparent objects using alpha test.
Arguments:
0 - disabled (by default)
1 - enabled
render_show_transparentConfig file: *.
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating whether the visualizer is displayed for transparent objects.
Arguments:
0 - disabled (by default)
1 - enabled
render_clouds_enabled
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if rendering of clouds is enabled.
Arguments:
0 - disabled
1 - enabled (by default)
render_lights_enabled
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if rendering of lights is enabled.
Arguments:
0 - disabled
1 - enabled (by default)
render_water_enabled
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if rendering of water is enabled.
Arguments:
0 - disabled
1 - enabled (by default)
render_screen_space_effects
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if rendering of screen-space effects is enabled.
Arguments:
0 - disabled
1 - enabled (by default)
render_transparent_enabled
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if the transparent pass is rendered.
    Notice
    This option takes effect only when the forward rendering pass is used for transparent objects rendering.
Arguments:
0 - disabled
1 - enabled (by default)
render_transparent_ambient
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if the transparent ambient pass is rendered.
    Notice
    This option takes effect only when the forward rendering pass is used for transparent objects rendering.
Arguments:
0 - disabled
1 - enabled (by default)
render_transparent_light
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if the transparent light pass is rendered.
    Notice
    This option takes effect only when the forward rendering pass is used for transparent objects rendering.
Arguments:
0 - disabled
1 - enabled (by default)
render_transparent_deferred
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if the deferred pass for transparent objects is enabled.
    Notice
    This option takes effect only when the forward rendering pass is used for transparent objects rendering.
Arguments:
0 - disabled
1 - enabled (by default)
render_transparent_multiple_env_probes
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if the transparent multiple environment probes pass is rendered.
    Notice
    This method takes effect only when the forward rendering pass is used for transparent objects rendering.
Arguments:
0 - disabled
1 - enabled (by default)

Meshes#

Operations on mesh rendering.

render_alpha_fade
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if alpha-blend fading (dithering) is enabled for objects. When the feature is enabled, objects LODs are smoothly blended into each other over a fade distance.
Arguments:
0 - disabled
1 - enabled (by default)
render_show_dynamicConfig file: *.
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating whether the visualizer is displayed for dynamic objects.
Arguments:
0 - disabled (by default)
1 - enabled
render_show_mesh_dynamics
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating whether the visualizer is displayed for dynamic meshes.
Arguments:
0 - disabled (by default)
1 - enabled
render_show_mesh_statics
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating whether the visualizer is displayed for static meshes.
Arguments:
0 - disabled (by default)
1 - enabled

Tessellation#

Operations on mesh tessellation.

render_tessellation_density_multiplier
Description:
  • Variable.   Prints the current global Density multiplier for the adaptive hardware-accelerated tessellation.
  • Command.   Sets the global Density multiplier for the adaptive hardware-accelerated tessellation. Higher values produce denser meshes.
Arguments:
[0.0f; 10.0f] - available range
1.0f - by default
render_tessellation_distance_multiplier
Description:
  • Variable.   Prints the current global multiplier for all distance parameters of the adaptive hardware-accelerated tessellation used for distance-dependent optimization.
  • Command.   Sets the global multiplier for all distance parameters of the adaptive hardware-accelerated tessellation used for distance-dependent optimization. Higher values make tessellation visible at longer distances from the camera (consuming more resources).
Arguments:
[0.0f; 10.0f] - available range
1.0f - by default
render_tessellation_shadow_density_multiplier
Description:
  • Variable.   Prints the current global Shadow Density multiplier for the Tessellated Displacement effect.
  • Command.   Sets the global Shadow Density multiplier for the Tessellated Displacement effect. Higher values produce more detailed shadows. You can make shadows from tessellated meshes simpler to save performance.
Arguments:
[0.01f; 10.0f] - available range
1.0f - by default

Decals#

Operations on decal rendering.

render_decals
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if rendering of decals is enabled.
Arguments:
0 - disabled
1 - enabled (by default)

Fields#

Operations on field rendering.

render_field_height_resolution
Description:
  • Variable.   Prints the current resolution of the texture into which all textures set for all FieldHeight objects are rendered.
  • Command.   Sets the resolution of the texture into which all textures set for all FieldHeight objects are rendered.
    Notice
    Increased resolution significantly affects performance.
Arguments:
0 - 128 x 128
1 - 256 x 256
2 - 512 x 512 (by default)
3 - 1024 x 1024
4 - 2048 x 2048
5 - 4096 x 4096
6 - 8192 x 8192
render_field_precision
Description:
  • Variable.   Prints the current value indicating the precision of textures used for field objects.
  • Command.   Sets the value indicating the precision of textures used for field objects. Either of the following:
    • 16-bit precision R16 texture
    • 32-bit precision R32F texture
Arguments:
0 - 16 bit (by default)
1 - 32 bit
render_field_shoreline_resolution
Description:
  • Variable.   Prints the current resolution of the texture into which all textures set for all FieldShoreline objects are rendered.
  • Command.   Sets the resolution of the texture into which all textures set for all FieldShoreline objects are rendered.
    Notice
    Increased resolution significantly affects performance.
Arguments:
0 - 128x128 (by default)
1 - 256x256
2 - 512x512
3 - 1024x1024
4 - 2048x2048
5 - 4096x4096
6 - 8192x8192

Textures#

Operations on texture rendering.

render_textures_quality
Description:
  • Variable.   Prints the current resolution of textures.
  • Command.   Sets the resolution of textures.
Arguments:
One of the following values:
  • 0 - low quality
  • 1 - medium quality
  • 2 - high quality
The default value is (2)
render_textures_max_resolution
Description:
  • Variable.   Prints the current maximum resolution of all textures.
  • Command.   Sets the maximum resolution of all textures. the engine doesn't compress existing textures: it uses specified mipmaps of *.dds textures.
Arguments:
0 - 128x128
1 - 256x256
2 - 512x512
3 - 1024x1024
4 - 2048x2048
5 - 4096x4096
6 - 8192x8192 (by default)
7 - 16384x16384
render_textures_min_resolution
Description:
  • Variable.   Prints the current minimum resolution of all textures.
  • Command.   Sets the minimum resolution of all textures. The Engine doesn't compress existing textures: it uses specified mip maps of *.dds textures.
Arguments:
0 - 128x128 (by default)
1 - 256x256
2 - 512x512
3 - 1024x1024
4 - 2048x2048
5 - 4096x4096
6 - 8192x8192
7 - 16384x16384
render_textures_filter
Description:
  • Variable.   Prints the current texture filtering mode.
  • Command.   Sets the texture filtering mode.
Arguments:
0 - Bilinear
1 - Trilinear (by default)
render_textures_anisotropy
Description:
  • Variable.   Prints the current anisotropy level for textures (degree of anisotropic filtering).
  • Command.   Sets the anisotropy level for textures (degree of anisotropic filtering).
Arguments:
0 - level 1
1 - level 2
2 - level 4
3 - level 8 (by default)
4 - level 16

Shaders#

Operations on shaders.

render_defines
Description:
  • Command. Print the macros list related to the renderer (defines to make corresponding resources available in shaders).

Shader Compilation#

Operations on shader compilation.

render_shaders_compile_mode
Description:
  • Variable.   Prints the current compilation mode for shaders that are used in the loaded world.
  • Command.   Sets the compilation mode for shaders that are used in the loaded world. The following modes are available:
    • Async - asynchronous shaders compilation.
    • Force - forced compilation of shaders required for each frame at ones.
Arguments:
0 - asynchronous compilation (by default)
1 - forced compilation

Effects and Postprocesses#

Operations on the effects and postprocesses.

render_animation_leaf
Description:
  • Variable.   Prints the current global scale for rotation angle of vegetation leaves.
  • Command.   Sets the global scale for rotation angle of vegetation leaves.
Arguments:
[0.0f; inf] - available range
1.0f - by default
render_animation_scale
Description:
  • Variable.   Prints the current global scale for rotation speed of vegetation leaves.
  • Command.   Sets the global scale for rotation speed of vegetation leaves.
Arguments:
[0.0f; inf] - available range
1.0f - by default
render_animation_stem
Description:
  • Variable.   Prints the current global scale for movement amplitude of vegetation stems.
  • Command.   Sets the global scale for movement amplitude of vegetation stems.
Arguments:
[0.0f; inf] - available range
1.0f - by default
render_animation_wind
Description:
  • Variable.   Prints the current direction of wind for all vegetation (grass and trees).
  • Command.   Sets the direction of wind for all vegetation (grass and trees). It is a multiplier for the stem offset (in grass, stem and leaves materials).
Arguments:
(0.0f, 0.0f, 0.0f) - default value
render_auxiliary
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if auxiliary render buffer is used. The buffer should be enabled for render and post post-processes to work.
Arguments:
0 - disabled
1 - enabled (by default)
render_bent_normal
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if ray-traced bent normals calculation is enabled. The use of SSRTGI for bent normals allows for smooth ambient lighting.
    Notice
    Ray-traced bent normals calculation available only when the SSRTGI technique (see the render_ssrtgi_preset) is enabled.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active (change active preset via render_bent_normal_preset). Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
0 - disabled (by default)
1 - enabled
render_bent_normal_fix_overlit_areas
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if correction of overlit areas for bent normals calculation is enabled.
    Notice
    • This option may significantly affect performance, so disable it when it's not necessary.
    • Ray-traced bent normals calculation is available only when the SSRTGI technique (see the render_ssrtgi_preset) is enabled.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active (change active preset via render_bent_normal_preset). Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
0 - disabled (by default)
1 - enabled
render_bent_normal_threshold
Description:
  • Variable.   Prints the current threshold value for the ray-traced bent normals calculation.
  • Command.   Sets the threshold value for the ray-traced bent normals calculation.
    Notice
    Ray-traced bent normals calculation is available only when the SSRTGI technique (see the render_ssrtgi_preset) is enabled.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active (change active preset via render_bent_normal_preset). Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; inf] - available range
1.0f - by default
render_bloom
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if the Bloom effect is enabled.
Arguments:
0 - disabled (by default)
1 - enabled
render_bloom_passes
Description:
  • Variable.   Prints the current number of passes for the bloom effect.
  • Command.   Sets the number of passes for the bloom effect. During the pass a Bloom texture is generating. Up to 8 Bloom textures can be generated: each texture has lower resolution (original size, original size /2, original size /4, so forth) with Bloom effect. After that, all these Bloom textures with the different resolution form the final Bloom texture.
    Notice
    The higher the value, the smoother the effect is. However, this option significantly affects performance.
Arguments:
[2; 8] - available range
6 - by default
render_bloom_power
Description:
  • Variable.   Prints the current power of the Bloom effect.
  • Command.   Sets the power of the Bloom effect.
    • 0.0f (min) - the Bloom effect is blurred.
    • 1.0f (max) - the Bloom effect is more contrast.
Arguments:
[0.0f; 1.0f] - available range
0.7f - by default
render_bloom_resolution
Description:
  • Variable.   Prints the current resolution of the Bloom effect.
  • Command.   Sets the resolution of the Bloom effect.
Arguments:
0 - quarter
1 - half
2 - full (by default)
render_bloom_scale
Description:
  • Variable.   Prints the current scale of the Bloom effect.
  • Command.   Sets the scale of the Bloom effect.
Arguments:
[0.0f; 1.0f] - available range
0.3f - by default
render_border
Description:
  • Variable.   Prints the current width and height of the image border (in pixels), to be rendered outside the horizontal bounds of the screen to reduce artefacts of post effects.
  • Command.   Sets the width and height of the image border (in pixels), to be rendered outside the horizontal bounds of the screen to reduce artefacts of post effects.
    Notice
    Increasing the width of the border may increase performance costs.
Arguments:
(0, 0) - default value
render_denoise_preset
Description:
  • Variable.   Prints the current Denoise preset used at the moment.
  • Command.   Sets the Denoise preset used at the moment. Sharpest to Smoothest — intensity of applying the noise reduction temporal filter (smoother settings cause more ghosting, but provide a more credible and smooth effect in static scenes). Low to High — quality of blur processing in denoiser (higher values are more performance-consuming). To customize the Denoise effect options at run time, activate the Custom preset.
Arguments:
0 - Disabled (by default)
1 - Sharpest Low
2 - Sharpest High
3 - Sharp Low
4 - Sharp High
5 - Smooth Low
6 - Smooth High
7 - Smoothest Low
8 - Smoothest High
9 - Custom
render_denoise_ao_mask_radius
Description:
  • Variable.   Prints the current radius of the Ambient Occlusion Mask (the Distance buffer) that is used to additionally configure the Denoiser parameters. This parameter affects only the Environment Probes with the Raymarching mode enabled.
  • Command.   Sets the radius of the Ambient Occlusion Mask (the Distance buffer) that is used to additionally configure the Denoiser parameters. This parameter affects only the Environment Probes with the Raymarching mode enabled.
Arguments:
[0.0f; inf] - available range
1.0f - by default
render_denoise_color_clamping_blur_intensity
Description:
  • Variable.   Prints the current intensity of using the blurred version of the current frame for color clamping.
  • Command.   Sets the intensity of using the blurred version of the current frame for color clamping.
Arguments:
[0.0f; 1.0f] - available range
0.9f - by default
render_denoise_color_clamping_blur_intensity_ao
Description:
  • Variable.   Prints the current intensity of using the blurred version of the current frame for color clamping in the areas where the Ambient Occlusion mask is black.
  • Command.   Sets the intensity of using the blurred version of the current frame for color clamping in the areas where the Ambient Occlusion mask is black.
Arguments:
[0.0f; 1.0f] - available range
0.1f - by default
render_denoise_color_clamping_blur_radius
Description:
  • Variable.   Prints the current blur radius for the current frame. The blurred image is further used in color clamping. This setting helps reducing noise in dark indoor areas.
  • Command.   Sets the blur radius for the current frame. The blurred image is further used in color clamping. This setting helps reducing noise in dark indoor areas.
Arguments:
[0.0f; 64.0f] - available range
8.0f - by default
render_denoise_hot_pixels_fix_intensity
Description:
  • Variable.   Prints the current value reducing the intensity of flickering pixels in the screen space.
  • Command.   Sets the value reducing the intensity of flickering pixels in the screen space. Adjusting this value may cause darkening of the global illumination.
Arguments:
[0.0f; 1.0f] - available range
0.0f - by default
render_denoise_information_lost_fix_flicker
Description:
  • Variable.   Prints the current value reducing the intensity of flickering pixels in the information lost areas.
  • Command.   Sets the value reducing the intensity of flickering pixels in the information lost areas. An excessive value may cause darkening of the areas behind objects when the camera is moving or when objects are moving in space.
Arguments:
[0.0f; 1.0f] - available range
0.75f - by default
render_denoise_interleaved
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the interleaved rendering for the Denoiser.
Arguments:
0 - disabled (by default)
1 - enabled
render_denoise_information_lost_depth_threshold
Description:
  • Variable.   Prints the current value defining starting from which depth the noise reduction effect is applied to the data in the "information lost" areas. This setting is aimed at reducing noise in areas where the ghosting effect commonly occurs.
  • Command.   Sets the value defining starting from which depth the noise reduction effect is applied to the data in the "information lost" areas. This setting is aimed at reducing noise in areas where the ghosting effect commonly occurs.
Arguments:
[0.0f; inf] - available range
0.1f - by default
render_denoise_radius
Description:
  • Variable.   Prints the current radius of each blur iteration in noise reduction.
  • Command.   Sets the radius of each blur iteration in noise reduction. This value allows simulating a higher number of blur iterations without affecting performance. However, this may cause such screen-space artefact as insufficiently smooth denoiser blur.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active (change active preset via render_denoise_preset). Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[1; 3] - available range
1 - by default
render_denoise_num_blur_iterations
Description:
  • Variable.   Prints the current number of iterations performed for blurring.
  • Command.   Sets the number of iterations performed for blurring. Higher values increase the blur radius, which helps to reduce noise even in areas with very intense noise. However this greatly affects performance. Recommended values are in range [3, 5].
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active (change active preset via render_denoise_preset). Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0; 10] - available range
5 - by default
render_denoise_denoise_mask_bias
Description:
  • Variable.   Prints the current threshold value for the brightness delta between frames below which the denoise mask becomes black.
  • Command.   Sets the threshold value for the brightness delta between frames below which the denoise mask becomes black. Denoise mask is based on the difference in brightness between the previous frame and the current one. Sometimes this difference is very small and can be neglected. This bias value is the threshold difference below which the denoise mask will be plain black. Since a zero value may cause a slight blur effect on the global illumination, this bias was added to avoid such effect.
Arguments:
[0.0f; inf] - available range
0.001f - by default
render_denoise_denoise_mask_denoise_threshold
Description:
  • Variable.   Prints the current threshold for the pixel brightness delta value of neighboring pixels, which defines if the pixels may be blurred together.
  • Command.   Sets the threshold for the pixel brightness delta value of neighboring pixels, which defines if the pixels may be blurred together.
Arguments:
[0.0f; inf] - available range
0.05f - by default
render_denoise_denoise_mask_frame_count
Description:
  • Variable.   Prints the current number of frames stored to generate the denoise mask.
  • Command.   Sets the number of frames stored to generate the denoise mask.
Arguments:
[0.0f; inf] - available range
15.0f - by default
render_denoise_denoise_mask_information_lost_boost
Description:
  • Variable.   Prints the current value controlling the intensity of filling in the information lost areas with the white color and temporally accumulating the the result between frames.
  • Command.   Sets the value controlling the intensity of filling in the information lost areas with the white color and temporally accumulating the the result between frames. This parameter reduces the effect of flickering pixels, but may add a ghosting effect.
Arguments:
[0.0f; 1.0f] - available range
0.0f - by default
render_denoise_denoise_mask_velocity_threshold
Description:
  • Variable.   Prints the current threshold for the velocity intensity value at which the denoise mask becomes white.
  • Command.   Sets the threshold for the velocity intensity value at which the denoise mask becomes white. This parameter is used to remove ghosting and flickering pixels when the camera moves quickly.
Arguments:
[0.0f; inf] - available range
0.0f - by default
render_indirect_diffuse_temporal_filtering_enabled
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if temporal filtering for Indirect Diffuse is enabled. Temporal filtering reduces flickering of indirect diffuse light.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active (change active preset via render_denoise_preset). Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
0 - disabled
1 - enabled (by default)
render_indirect_diffuse_temporal_filtering_frame_count
Description:
  • Variable.   Prints the current frame count of temporal filtering for the indirect diffuse effect.
  • Command.   Sets the frame count of temporal filtering for the indirect diffuse effect. Specifies the number of frames for the velocity buffer. The higher the value, the more frames are combined into the final image and the better anti-aliasing.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active (change active preset via render_denoise_preset). Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; inf] - available range
50.0f - by default
render_indirect_diffuse_temporal_filtering_color_clamping_intensity
Description:
  • Variable.   Prints the current intensity of temporal filtering color clamping at zero pixel velocity for Indirect Diffuse.
  • Command.   Sets the intensity of temporal filtering color clamping at zero pixel velocity for Indirect Diffuse. Lower values result in more accumulated frames combined, which reduces noise flickering, but increases ghosting effect. To reduce ghosting in this case you can use Indirect Diffuse Color Clamping Velocity Threshold (see the render_indirect_diffuse_temporal_filtering_color_clamping_velocity_threshold), while higher values reduce ghosting effect, but increase flickering.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active (change active preset via render_denoise_preset). Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; 1.0f] - available range
1.0f - by default
render_indirect_diffuse_temporal_filtering_color_clamping_velocity_threshold
Description:
  • Variable.   Prints the current sensitivity of temporal filtering color clamping for Indirect Diffuse to pixel velocity change.
  • Command.   Sets the sensitivity of temporal filtering color clamping for Indirect Diffuse to pixel velocity change. This parameter is used to reduce ghosting effect for lower Color Clamping Intensity (see the render_indirect_diffuse_temporal_filtering_color_clamping_intensity) values: it automatically increases clamping intensity for higher velocities, and disables clamping for low velocity values.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active (change active preset via render_denoise_preset). Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; inf] - available range
100.0f - by default
render_indirect_diffuse_denoise_enabled
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if noise reduction for Indirect Diffuse is enabled.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active (change active preset via render_denoise_preset). Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
0 - disabled
1 - enabled (by default)
render_indirect_diffuse_denoise_mask_enabled
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if the denoise mask for Indirect Diffuse is enabled. This mask identifies which portions of the screen should be denoised more, and which — less. This may ensure more detailed ambient lighting.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active (change active preset via render_denoise_preset). Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
0 - disabled
1 - enabled (by default)
render_indirect_diffuse_denoise_threshold
Description:
  • Variable.   Prints the current threshold value for color difference of neighboring pixels used for noise reduction for Indirect Diffuse.
  • Command.   Sets the threshold value for color difference of neighboring pixels used for noise reduction for Indirect Diffuse. Blur is applied when the color difference is less than the threshold value.
    Notice
    Setting too high values results in blurring the whole image.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active (change active preset via render_denoise_preset). Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; 1.0f] - available range
1.0f - by default
render_indirect_specular_temporal_filtering_enabled
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if temporal filtering for Indirect Specular is enabled. Temporal filtering reduces flickering of Indirect Specular lighting.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active (change active preset via render_denoise_preset). Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
0 - disabled
1 - enabled (by default)
render_indirect_specular_temporal_filtering_frame_count
Description:
  • Variable.   Prints the current frame count of temporal filtering for Indirect Specular.
  • Command.   Sets the frame count of temporal filtering for Indirect Specular. Specifies the number of frames for the velocity buffer. The higher the value, the more frames are combined into the final image and the better anti-aliasing.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active (change active preset via render_denoise_preset). Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; inf] - available range
50.0f - by default
render_indirect_specular_temporal_filtering_color_clamping_intensity
Description:
  • Variable.   Prints the current intensity of temporal filtering color clamping at zero pixel velocity for Indirect Specular.
  • Command.   Sets the intensity of temporal filtering color clamping at zero pixel velocity for Indirect Specular. Lower values result in more accumulated frames combined, which reduces noise flickering, but increases ghosting effect. To reduce ghosting in this case you can use Indirect Specular Temporal Filtering Color Clamping Velocity Threshold (see the render_indirect_specular_temporal_filtering_color_clamping_velocity_threshold), while higher values reduce ghosting effect, but increase flickering.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active (change active preset via render_denoise_preset). Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; 1.0f] - available range
1.0f - by default
render_indirect_specular_temporal_filtering_color_clamping_velocity_threshold
Description:
  • Variable.   Prints the current sensitivity of temporal filtering color clamping for Indirect Specular to pixel velocity change.
  • Command.   Sets the sensitivity of temporal filtering color clamping for Indirect Specular to pixel velocity change. This parameter is used to reduce ghosting effect for lower Color Clamping Intensity (see the render_indirect_specular_temporal_filtering_color_clamping_intensity) values: it automatically increases clamping intensity for higher velocities, and disables clamping for low velocity values.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active (change active preset via render_denoise_preset). Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; inf] - available range
100.0f - by default
render_indirect_specular_denoise_enabled
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if noise reduction for Indirect Specular is enabled.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active (change active preset via render_denoise_preset). Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
0 - disabled
1 - enabled (by default)
render_indirect_specular_denoise_mask_enabled
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if the denoise mask for Indirect Specular is enabled.This mask identifies which portions of the screen should be denoised more, and which — less. This may ensure more detailed ambient lighting.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active (change active preset via render_denoise_preset). Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
0 - disabled
1 - enabled (by default)
render_indirect_specular_denoise_threshold
Description:
  • Variable.   Prints the current threshold value for color difference of neighboring pixels used for noise reduction for the Indirect Specular effect.
  • Command.   Sets the threshold value for color difference of neighboring pixels used for noise reduction for the Indirect Specular effect. Blur is applied when the color difference is less than the threshold value.
    Notice
    Setting too high values results in blurring the whole image.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active (change active preset via render_denoise_preset). Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; 1.0f] - available range
1.0f - by default
render_camera_effects_threshold
Description:
  • Variable.   Prints the current brightness threshold, which is used to detect if an object should be blurred in the HDR mode.
  • Command.   Sets the brightness threshold, which is used to detect if an object should be blurred in the HDR mode. By the minimum value of 0, the bright areas can become overexposed.
Arguments:
[0.0f; inf] - available range
1.0f - by default
render_camera_effects_temporal_filtering
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if temporal filtering for camera effects is enabled. Temporal filtering reduces flickering of the bloom effect on the small bright objects (such flickering may appear when the camera moves). For example, it can be used in scenes with industrial pipes.
Arguments:
0 - disabled (by default)
1 - enabled
render_camera_effects_temporal_filtering_color_clamping_intensity
Description:
Arguments:
[1.0f; inf] - available range
3.0f - by default
render_camera_effects_temporal_filtering_min_velocity_clamping
Description:
  • Variable.   Prints the current sensitivity of TAA color clamping for the Bloom effect for static objects.
  • Command.   Sets the sensitivity of TAA color clamping for the Bloom effect for static objects. This parameter is used to reduce ghosting effect for lower Color Clamping Intensity (see the render_camera_effects_temporal_filtering_color_clamping_intensity) values: higher values reduce ghosting, but at the same time reduce the temporal filter effect.
    Notice
    This option is available only when the temporal filtering (see the render_camera_effects_temporal_filtering) is enabled.
Arguments:
[0.0f; 1.0f] - available range
0.05f - by default
render_camera_effects_temporal_filtering_max_velocity_clamping
Description:
  • Variable.   Prints the current sensitivity of TAA color clamping for the Bloom effect for moving objects.
  • Command.   Sets the sensitivity of TAA color clamping for the Bloom effect for moving objects. This parameter is used to reduce ghosting effect for lower Color Clamping Intensity (see the render_camera_effects_temporal_filtering_color_clamping_intensity) values: higher values reduce ghosting, but at the same time reduce the temporal filter effect.
    Notice
    This option is available only when the temporal filtering (see the render_camera_effects_temporal_filtering) is enabled.
Arguments:
[0.0f; 1.0f] - available range
0.1f - by default
render_chromatic_aberration
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if rendering of the Chromatic Aberration post-effect is enabled. This effect simulates color shifts in real-world camera lenses due to light rays entering a lens at different points causing separation of RGB colors.
Arguments:
0 - disabled (by default)
1 - enabled
render_chromatic_aberration_intensity
Description:
  • Variable.   Prints the current intensity (strength) of the Chromatic Aberration post-effect.
  • Command.   Sets the intensity (strength) of the Chromatic Aberration post-effect. Controls how much color shifting occurs.
Arguments:
[0.0f; inf] - available range
0.5f - by default
render_chromatic_aberration_noise_intensity
Description:
Arguments:
[0.0f; 1.0f] - available range
0.3f - by default
render_chromatic_aberration_samples
Description:
  • Variable.   Prints the current number of samples used for calculation of the Chromatic Aberration post-effect.
  • Command.   Sets the number of samples used for calculation of the Chromatic Aberration post-effect. Higher values reduce banding making the effect look smoother.
Arguments:
[1; 32] - available range
1 - by default
render_dirt_scale
Description:
  • Variable.   Prints the current intensity of lens dirt effect modulating the pattern of lens flares defined by the Dirt Texture.
  • Command.   Sets the intensity of lens dirt effect modulating the pattern of lens flares defined by the Dirt Texture. For example, it can be used to create an effect of unclean optics when the camera looks at the sun.
Arguments:
[0.0f; 1.0f] - available range
0.5f - by default
render_dof
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if the DOF (Depth Of Field) effect is enabled.
Arguments:
0 - disabled (by default)
1 - enabled
render_dof_preset
Description:
  • Variable.   Prints the current DoF effect quality preset. To customize the DoF effect options at run time you should activate the Custom preset:
  • Command.   Sets the DoF effect quality preset. To customize the DoF effect options at run time you should activate the Custom preset:
Arguments:
0 - Very Low (by default)
1 - Low
2 - Medium
3 - High
4 - Ultra
5 - Extreme
6 - Custom
render_dof_blur
Description:
  • Variable.   Prints the current intensity of blur for the DOF (Depth Of Field) effect.
  • Command.   Sets the intensity of blur for the DOF (Depth Of Field) effect.
Arguments:
[0.0f; inf] - available range
1.0f - by default
render_dof_chromatic_aberration
Description:
Arguments:
[0.0f; inf] - available range
0.0f - by default
render_dof_far_distance
Description:
  • Variable.   Prints the current far DOF limit of the camera: the distance between the camera and the furthest element that is considered to be acceptably sharp.
  • Command.   Sets the far DOF limit of the camera: the distance between the camera and the furthest element that is considered to be acceptably sharp. Black zone on the DOF mask means in-focus zone.
Arguments:
[0.0f; inf] - available range
10.0f - by default
render_dof_near_distance
Description:
  • Variable.   Prints the current near DOF limit of the camera: the distance between the camera and the first element that is considered to be acceptably sharp.
  • Command.   Sets the near DOF limit of the camera: the distance between the camera and the first element that is considered to be acceptably sharp. Black zone on the DOF mask means in-focus zone.
Arguments:
[0.0f; inf] - available range
10.0f - by default
render_dof_focal_distance
Description:
  • Variable.   Prints the current focal distance of the camera, i.e. a point where objects are in-focus and visible clearly.
  • Command.   Sets the focal distance of the camera, i.e. a point where objects are in-focus and visible clearly.
Arguments:
[0.0f; inf] - available range
1.0f - by default
render_dof_far_focal_offset
Description:
  • Variable.   Prints the current Sets the offset from the focal to the farthest blurred zone for the DOF effect.
  • Command.   Sets the Sets the offset from the focal to the farthest blurred zone for the DOF effect. In other words, the distance when background (far) is in focus.
Arguments:
[0.0f; inf] - available range
0.0f - by default
render_dof_near_focal_offset
Description:
  • Variable.   Prints the current offset from the focal to the nearest blurred zone.
  • Command.   Sets the offset from the focal to the nearest blurred zone. In other words, the distance when foreground (near) is in focus.
Arguments:
[0.0f; inf] - available range
0.0f - by default
render_dof_resolution
Description:
  • Variable.   Prints the current resolution of the DOF (Depth Of Field) effect.
  • Command.   Sets the resolution of the DOF (Depth Of Field) effect.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active (change active preset via render_dof_preset). Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
0 - quarter
1 - half
2 - full (by default)
render_dof_quality
Description:
  • Variable.   Prints the current quality of the DOF (Depth Of Field) effect.
  • Command.   Sets the quality of the DOF (Depth Of Field) effect.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active (change active preset via render_dof_preset). Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
One of the following values:
  • 0 - low quality
  • 1 - medium quality
  • 2 - high quality
  • 3 - ultra quality
The default value is (1)
render_dof_bokeh_mode
Description:
  • Variable.   Prints the current shape of the Bokeh for the DOF effect.
  • Command.   Sets the shape of the Bokeh for the DOF effect. This parameter determines the way the lens renders out-of-focus points of light.
    Notice
    For the DOF effect, the Bokeh effect is enabled by default.
Arguments:
0 - ring (by default)
1 - circle
render_dof_increased_accuracy
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if the increased accuracy option is enabled for the DOF (Depth Of Field) effect. When enabled, focusing calculation is performed with increased accuracy.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active (change active preset via render_dof_preset). Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
0 - disabled (by default)
1 - enabled
render_dof_focus_improvement
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if the focus improvement option is enabled for the DOF (Depth Of Field) effect. When enabled, transitions between the focused and unfocused parts of the scene become more accurate.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active (change active preset via render_dof_preset). Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
0 - disabled
1 - enabled
render_show_emission
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating whether the visualizer is displayed for materials with the Emission state enabled or connecting any data to the Emission input in the material graph.
Arguments:
0 - disabled (by default)
1 - enabled
render_exposure_mode
Description:
Arguments:
0 - static (by default)
1 - logarithmic adaptive exposure
2 - quadratic adaptive exposure
render_exposure
Description:
  • Variable.   Prints the current camera exposure (a multiplier of the scene luminance and brightness).
  • Command.   Sets the camera exposure (a multiplier of the scene luminance and brightness).

    It determines the resulting amount of luminance:

    • By the minimum value of 0.0f, the image is rendered black.
    • The higher the value, the more luminance and the brighter the scene lit.
    Available only when the Camera Mode (see the render_camera_mode) is set to Classic.
Arguments:
[0.0f; inf] - available range
1.0f - by default
render_exposure_adaptation
Description:
  • Variable.   Prints the current time for the camera to adjust exposure, in seconds.
  • Command.   Sets the time for the camera to adjust exposure, in seconds. 0.0f - means instant adaptation. If a too small or even negative value is provided, 1E-6 will be used instead.
Arguments:
[0.0f; inf] - available range
1.0f - by default
render_metering_mask_enabled
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if metering mask for exposure and white balance correction is enabled. This option gives you an additional texture slot (see the MeteringMaskTexture) to control the influence of auto exposure and white balance correction for the whole screen, where each pixel is weighted in importance in accordance with the specified texture mask.
Arguments:
0 - disabled (by default)
1 - enabled
render_iso
Description:
  • Variable.   Prints the current ISO value used for static exposure calculation.
  • Command.   Sets the ISO value used for static exposure calculation. This value is available for the physically-based camera (see the render_camera_mode) and represents the sensitivity of the camera sensor. The higher the ISO number, the more light is collected and the brighter the image is.
Arguments:
[0; inf] - available range
100 - by default
render_shutter_speed
Description:
  • Variable.   Prints the current shutter speed used for static exposure calculation.
  • Command.   Sets the shutter speed used for static exposure calculation. This setting is available for the physically-based camera (see the render_camera_mode) and indicates how long the sensor of the camera is actively collecting light. Higher values make the shutter speed faster and the image — darker.
Arguments:
[0; inf] - available range
250 - by default
render_f_stop
Description:
  • Variable.   Prints the current f-stop value used for static exposure calculation.
  • Command.   Sets the f-stop value used for static exposure calculation. This setting is available for the physically-based camera (see the render_camera_mode) and represents the ratio of the focal length (f) and the diameter of the lens opening (D): f / D. It is the reciprocal of the relative aperture. The higher the value, the darker the image is.
Arguments:
[0; inf] - available range
11 - by default
render_camera_mode
Description:
  • Variable.   Prints the current camera mode, which determines the way the exposure is set.
  • Command.   Sets the camera mode, which determines the way the exposure is set. Either of the following:
    • Physically-Based - the real-world values are used to set up lighting and camera exposure: ISO (see the render_iso), shutter speed (see the render_shutter_speed), F-stop (see the render_f_stop). With the default values of these parameters, the static exposure value is near 1.
      Notice
      For the physically-based mode, the exposure mode (see the render_exposure_mode) should be set to Static to avoid exposure issues.
    • Classic - the exposure is set by the Exposure value (see the render_exposure).
Arguments:
0 - classic (by default)
1 - physically-based
render_white_balance
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if automatic white balance correction is enabled.
Arguments:
0 - disabled
1 - enabled (by default)
render_white_balance_intensity
Description:
  • Variable.   Prints the current value of white balance correction intensity.
  • Command.   Sets the value of white balance correction intensity.
    • 0.0f - no white balance correction is performed.
    • higher values result in stronger correction.
    Notice
    Do not set too high values for night-time and dimly lit scenes, as it may lead to heavy color distortion making the scene look totally unnatural.
Arguments:
[0.0f; 1.0f] - available range
0.3f - by default
render_white_balance_adaptation_time
Description:
  • Variable.   Prints the current time period set for the camera to adjust white balance.
  • Command.   Sets the time period set for the camera to adjust white balance. During this time white balance correction is performed (0.0f - instant correction is to be used).
    Notice
    It is recommended to use lower values, when possible, to make correction process unnoticeable, otherwise it'll be slow and will catch user's eye. However, setting too low values may result in abrupt switching of colors as the camera moves. So, adjust this parameter carefully to make transition smoooth. You can set it equal to the Exposure Adaptation value (see the render_exposure_adaptation).
Arguments:
[0.0f; inf] - available range
1.0f - by default
render_vignette_mask
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if rendering of the Vignette Mask post-effect is enabled. The effect applies darkening towards the edges of an image compared to the center usually caused by thick or stacked filters, secondary lenses, and lens hoods. It can be used for an artistic effect, to draw focus to the center of the image.
Arguments:
0 - disabled (by default)
1 - enabled
render_vignette_mask_intensity
Description:
  • Variable.   Prints the current intensity of the Vignette Mask.
  • Command.   Sets the intensity of the Vignette Mask. Defines the amount of vignetting on the screen: higher values moke the vignette wider.
Arguments:
[0.0f; 1.0f] - available range
1.0f - by default
render_vignette_mask_power
Description:
  • Variable.   Prints the current Power value that controls mask opacity for the Vignette Mask post-effect.
  • Command.   Sets the Power value that controls mask opacity for the Vignette Mask post-effect.
Arguments:
[0.0f; inf] - available range
1.0f - by default
render_noise
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if rendering of the Noise post-effect is enabled.
Arguments:
0 - disabled (by default)
1 - enabled
render_noise_intensity
Description:
  • Variable.   Prints the current intensity of the Noise post-effect.
  • Command.   Sets the intensity of the Noise post-effect. Higher values result in more noise applied to the image.
Arguments:
[0.0f; inf] - available range
0.03f - by default
color_correction_brightness
Description:
  • Variable.   Prints the current overall brightness value for the scene.
  • Command.   Sets the overall brightness value for the scene.
Arguments:
[-1.0f; 1.0f] - available range
0.0f - by default
color_correction_contrast
Description:
  • Variable.   Prints the current overall contrast value for the scene.
  • Command.   Sets the overall contrast value for the scene.
Arguments:
[-1.0f; 1.0f] - available range
0.0f - by default
color_correction_gamma
Description:
  • Variable.   Prints the current Gamma correction value for the scene.
  • Command.   Sets the Gamma correction value for the scene.
Arguments:
[0.5f; 1.5f] - available range
1.0f - by default
color_correction_white
Description:
  • Variable.   Prints the current white balance of the scene.
  • Command.   Sets the white balance of the scene.
Arguments:
vec4_zero - default value (black)
color_correction_by_curves
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if color correction via curves is enabled.
Arguments:
0 - disabled
1 - enabled (by default)
color_correction_hue_per_color
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if fine-adjustment of hue (color shift) for each of the 12 major colors of the spectre is enabled.
Arguments:
0 - disabled
1 - enabled (by default)
color_correction_hue_shift
Description:
  • Variable.   Prints the current hue adjustment values for the scene.
  • Command.   Sets the hue adjustment values for the scene. List of palette colors: 0 - Red, 1 - Orange, 2 - Yellow, 3 - Chartreuse, 4 - Green, 5 - Spring green, 6 - Cyan, 7 - Azure, 8 - Blue, 9 - Violet, 10 - Magenta, 11 - Rose.
Arguments:
(0,0,0,0,0,0,0,0,0,0,0,0) - default value
color_correction_saturation_per_color
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if fine-adjustment of saturation for each of the 12 major colors of the spectre is enabled.
Arguments:
0 - disabled
1 - enabled (by default)
color_correction_saturation
Description:
  • Variable.   Prints the current saturation adjustment values for the scene.
  • Command.   Sets the saturation adjustment values for the scene.List of palette colors: 0 - Red, 1 - Orange, 2 - Yellow, 3 - Chartreuse, 4 - Green, 5 - Spring green, 6 - Cyan, 7 - Azure, 8 - Blue, 9 - Violet, 10 - Magenta, 11 - Rose.
Arguments:
(1,1,1,1,1,1,1,1,1,1,1,1) - default value
color_correction_preserve_saturation
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if initial scene color saturation is to be preserved after applying color correction.
Arguments:
0 - disabled (by default)
1 - enabled
render_supersampling
Description:
  • Variable.   Prints the current number of samples per pixel used for supersampling.
  • Command.   Sets the number of samples per pixel used for supersampling.
Arguments:
[1e-6f; 8.0f] - available range
1.0f - by default
render_occluders
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if rendering of occluders is enabled.
Arguments:
0 - disabled
1 - enabled (by default)
render_occluders_resolution
Description:
  • Variable.   Prints the current resolution of the texture, to which occluders (see the render_occluders) are rendered.
  • Command.   Sets the resolution of the texture, to which occluders (see the render_occluders) are rendered.
Arguments:
From 1x1 to 1024x1024 Default: 128x64
render_occluders_shadows
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating whether rendering of occluders for shadows is enabled.
Arguments:
0 - disabled (by default)
1 - enabled
render_occluders_shadows_resolution
Description:
  • Variable.   Prints the current resolution of the texture, to which occluders for shadows (see the render_occluders_shadows) are rendered.
  • Command.   Sets the resolution of the texture, to which occluders for shadows (see the render_occluders_shadows) are rendered.
Arguments:
From 1x1 to 1024x1024 Default: 512x512
render_ssgi
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if the SSGI (Screen Space Global Illumination) effect is enabled.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active (change active preset via render_gi_preset). Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
0 - disabled (by default)
1 - enabled
render_ssgi_intensity
Description:
  • Variable.   Prints the current intensity of the SSGI (Screen Space Global Illumination) for the scene.
  • Command.   Sets the intensity of the SSGI (Screen Space Global Illumination) for the scene. By the minimum value of 0.0f, the global illumination is the darkest.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active (change active preset via render_ssgi_preset). Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; 1.0f] - available range
1.0f - by default
render_ssgi_intensity_boost
Description:
  • Variable.   Prints the current boost intensity value.
  • Command.   Sets the boost intensity value. Increases the SSGI intensity by raising the value to the specified power.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active (change active preset via render_ssgi_preset). Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
0 - power of 1 (by default)
1 - power of 2
2 - power of 3
3 - power of 4
Description:
render_ssgi_threshold
Description:
  • Variable.   Prints the current threshold value for the ray-traced SSGI (Screen Space Global Illumination).
  • Command.   Sets the threshold value for the ray-traced SSGI (Screen Space Global Illumination).
    Notice
    Ray-traced SSGI calculation available only when the SSRTGI technique (see the render_ssrtgi_preset) is enabled.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active (change active preset via render_ssgi_preset). Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; inf] - available range
1.0f - by default
render_fxaa
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if FXAA (post-process anti-aliasing) is enabled.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active (change active preset via render_aa_preset). Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
0 - disabled
1 - enabled (by default)
render_fxaa_intensity
Description:
  • Variable.   Prints the current intensity of FXAA.
  • Command.   Sets the intensity of FXAA. Intensity specifies the sample offset of FXAA fragment. The higher the value, the more blurred image will be.
Arguments:
[0.0f; 1.0f] - available range
0.0f - by default
render_aa_preset
Description:
  • Variable.   Prints the current index of the AA (Anti-Aliasing) preset used at the moment. To customize Anti-Aliasing options at run time you should activate the Custom preset:
  • Command.   Sets the index of the AA (Anti-Aliasing) preset used at the moment. To customize Anti-Aliasing options at run time you should activate the Custom preset:
Arguments:
0 - Sharpest (by default)
1 - Sharp
2 - Smooth
3 - Smooth + SRAA
4 - Smoothest
5 - Smoothest + SRAA
6 - VR Mode
7 - Custom
render_taa
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if TAA (Temporal Anti-Aliasing) is enabled.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active (change active preset via render_aa_preset). Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
0 - disabled
1 - enabled (by default)
render_taa_preset
Description:
  • Variable.   Prints the current TAA (Temporal Anti-Aliasing) preset used at the moment. To customize Anti-Aliasing options at run time you should activate the Custom preset:
  • Command.   Sets the TAA (Temporal Anti-Aliasing) preset used at the moment. To customize Anti-Aliasing options at run time you should activate the Custom preset:
Arguments:
0 - Sharpest (by default)
1 - Sharp
2 - Smooth
3 - Smoothest
4 - VR Mode
5 - Custom
render_taa_antialiasing_in_motion
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if improved anti-aliasing in motion (for moving camera and objects) is enabled. TAA (see the render_taa) must be enabled.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active (change active preset via render_taa_preset). Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
0 - disabled (by default)
1 - enabled
render_taa_frame_count
Description:
  • Variable.   Prints the current frame count of TAA (Temporal Anti-Aliasing).
  • Command.   Sets the frame count of TAA (Temporal Anti-Aliasing). Specifies the number of frames combined for pixels. The higher the value, the more frames are combined into the final image and the better anti-aliasing. This value is used only when the Frames By Velocity option (see the render_taa_frames_by_velocity) is disabled.
Arguments:
[0.0f; inf] - available range
30.0f - by default
render_taa_catmull_resampling
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if Catmull-Rom resampling is enabled. This option enables you to reduce image blurring when the camera moves forward/backward. It is recommended to disable resampling fow low-quality presets.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active (change active preset via render_taa_preset). Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
0 - disabled
1 - enabled (by default)
render_taa_frames_by_color
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if TAA color clamping option is enabled. This option clamps the color of the current and previous frame. The image becomes more sharp. TAA (see the render_taa) must be enabled.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active (change active preset via render_taa_preset). Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
0 - disabled
1 - enabled (by default)
render_taa_diagonal_neighbors
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if diagonally neighboring pixels are to be taken into account in the process of color clamping for TAA. This mode can be used for relatively static scenes when improved antialiasing is required. In case of a dynamic scene, blurring artefacts near the screen borders may appear.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active (change active preset via render_taa_preset). Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
0 - disabled (by default)
1 - enabled
render_taa_preserve_details
Description:
  • Variable.   Prints the current detail level of TAA (Temporal Anti-Aliasing).
  • Command.   Sets the detail level of TAA (Temporal Anti-Aliasing). The higher the value, the more detailed the image is. Can produce additional flickering.
Arguments:
[0.0f; inf] - available range
0.5f - by default
render_taa_pixel_offset
Description:
  • Variable.   Prints the current size of the sample offset performed during subpixel jittering.
  • Command.   Sets the size of the sample offset performed during subpixel jittering. The offset can be less than a pixel: for example, if 0.5 is set, frames will shift to half a pixel.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active (change active preset via render_taa_preset). Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; 1.0f] - available range
1.0f - by default
render_taa_samples
Description:
  • Variable.   Prints the current number of the sample offsets performed during subpixel jittering.
  • Command.   Sets the number of the sample offsets performed during subpixel jittering. The parameter allows reducing image jittering and blurring. By the minimum value of 0 (1 sample offset), there will be no offsets, and, therefore, no anti-aliasing. TAA (see the render_taa) must be enabled.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active (change active preset via render_taa_preset). Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
0 - 1 sample offset, no anti-aliasing
1 - 4 offsets (by default)
2 - 8 offsets
3 - 16 offsets
render_taa_max_frames_by_velocity
Description:
  • Variable.   Prints the current maximum frame count of TAA (Temporal Anti-Aliasing).
  • Command.   Sets the maximum frame count of TAA (Temporal Anti-Aliasing). Specifies the maximum number of frames in the velocity buffer combined for pixels that don't move relative to the screen space.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active (change active preset via render_taa_preset). Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; inf] - available range
60.0f - by default
render_taa_min_frames_by_velocity
Description:
  • Variable.   Prints the current minimum frame count of TAA (Temporal Anti-Aliasing).
  • Command.   Sets the minimum frame count of TAA (Temporal Anti-Aliasing). Specifies the minimum number of frames in the velocity buffer combined for fast moving pixels on the screen.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active (change active preset via render_taa_preset). Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; inf] - available range
4.0f - by default
render_taa_frames_by_velocity
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if the TAA velocity clamping option is enabled. This option controls the number of frames combined for pixels depending on the velocity in the fragment: the number of frames is clamped to the [Min frame count; Max frame count]. It reduces blurring in dynamic scenes with a lot of moving objects.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active (change active preset via render_taa_preset). Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
0 - disabled
1 - enabled (by default)
render_taa_frames_velocity_threshold
Description:
  • Variable.   Prints the current velocity threshold of TAA (Temporal Anti-Aliasing), at which pixels are treated as fast moving ones.
  • Command.   Sets the velocity threshold of TAA (Temporal Anti-Aliasing), at which pixels are treated as fast moving ones.This value specifies the intensity of velocity clamping. The following options must be enabled: TAA (see the render_taa) and TAA velocity clamping (see the render_taa_frames_by_velocity).
Arguments:
[0.0f; inf] - available range
1.0f - by default
render_taa_fix_flicker
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if the taa fix flicker option is enabled. This option fixes flickering edges caused by TAA: it removes bright pixels by using the pixel brightness information from the previous frame. It is recommended to enable the option for bright thin ropes, wires and lines. The option is available only when TAA (see the render_taa) is enabled.
    Notice
    Enabling this option may increase performance costs.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active (change active preset via render_taa_preset). Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
0 - disabled
1 - enabled (by default)
render_taa_edges_frame_count_multiplier
Description:
  • Variable.   Prints the current multiplier for the number of frames accumulated for TAA effect on the sharp edges of objects within the image.
  • Command.   Sets the multiplier for the number of frames accumulated for TAA effect on the sharp edges of objects within the image.
Arguments:
[1.0f; inf] - available range
1.0f - by default
render_sraa
Description:
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active (change active preset via render_aa_preset). Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
0 - disabled (by default)
1 - enabled
render_sraa_samples
Description:
  • Variable.   Prints the current number of depth geometry samples per pixel.
  • Command.   Sets the number of depth geometry samples per pixel. This value may significantly affect performance, so keep it low when the image quality differences are not apparent.
Arguments:
0 - 2
1 - 4 (by default)
2 - 8
render_sraa_temporal
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if TAA integration is enabled. SRAA will use the shading sample from the previously rendered frame (TAA) to achieve correct anti-aliasing. Uses camera jittering, so it works only when the TAA (see the render_taa) is enabled. It is recommended to use this option by default.
Arguments:
0 - disabled
1 - enabled (by default)
render_sraa_debug
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if the SRAA debug mode is enabled. This mode shows the geometry edges smoothed by the SRAA.
Arguments:
0 - disabled (by default)
1 - enabled
render_sraa_depth_threshold
Description:
  • Variable.   Prints the current depth threshold value used for edges detection that specifies the area for the SRAA processing.
  • Command.   Sets the depth threshold value used for edges detection that specifies the area for the SRAA processing. Turn on the debug mode and adjust this parameter in such a way that covers the required edges but at the same time leaves out the unnecessary geometry in the scene.
Arguments:
[0.0f; inf] - available range
0.1f - by default
render_filmic_shoulder_scale
Description:
  • Variable.   Prints the current Shoulder Strength tonemapping parameter value that is used to change bright values.
  • Command.   Sets the Shoulder Strength tonemapping parameter value that is used to change bright values.
Arguments:
[0.0f; 1.0f] - available range
0.2f - by default
render_filmic_linear_scale
Description:
  • Variable.   Prints the current Linear Strength tone mapping parameter value that is used to change gray values.
  • Command.   Sets the Linear Strength tone mapping parameter value that is used to change gray values. The Linear Scale controls the length of the tone mapping curve linear part.
Arguments:
[0.0f; 1.0f] - available range
0.3f - by default
render_filmic_linear_angle
Description:
  • Variable.   Prints the current Linear Angle tone mapping parameter value.
  • Command.   Sets the Linear Angle tone mapping parameter value. This parameter controls the slope of the linear part of the tone mapping curve.
Arguments:
[0.0f; 1.0f] - available range
1.0f - by default
render_filmic_toe_scale
Description:
  • Variable.   Prints the current Toe Scale tonemapping parameter value that is used to change dark values.
  • Command.   Sets the Toe Scale tonemapping parameter value that is used to change dark values. The Toe Scale controls the slope of the tone mapping curve toe (the area of underexposure).
Arguments:
[0.0f; 1.0f] - available range
0.2f - by default
render_filmic_toe_numerator
Description:
  • Variable.   Prints the current Toe Numerator tonemapping parameter value.
  • Command.   Sets the Toe Numerator tonemapping parameter value.
Arguments:
[0.0f; 1.0f] - available range
0.01f - by default
render_filmic_toe_denominator
Description:
Arguments:
[0.0f; 1.0f] - available range
0.3f - by default
render_filmic_white_level
Description:
  • Variable.   Prints the current Linear White Point tonemapping parameter value, which is mapped as pure white in the resulting image.
  • Command.   Sets the Linear White Point tonemapping parameter value, which is mapped as pure white in the resulting image.
Arguments:
[0.0f; inf] - available range
1.0f - by default
render_filmic_saturation_recovery
Description:
  • Variable.   Prints the current color saturation recovery value for the filmic tonemapper.
  • Command.   Sets the color saturation recovery value for the filmic tonemapper. Filmic tonemapper desaturates image colors in bright areas making them look grayish. This parameter enables you to recover initial color saturation in such areas. Higher values make colors more saturated:
    • 0.0f - standard filmic tonemapping, no saturation recovery is performed.
    • 1.0f - color saturation is recovered to the full extent.
    Notice
    When the 1.0f value is set specular highlights appear too saturated, so the recommended value is 0.75f (default)
Arguments:
[0.0f; 1.0f] - available range
0.75f - by default
render_cross
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if cross flares are enabled.
Arguments:
0 - disabled (by default)
1 - enabled
render_cross_color
Description:
  • Variable.   Prints the current color of the cross flares.
  • Command.   Sets the color of the cross flares. To use this option, rendering of cross flares (see the render_cross) should be enabled.
Arguments:
vec4_one - default value (white)
render_cross_scale
Description:
  • Variable.   Prints the current cross color scale — a multiplier for the color of cross flares.
  • Command.   Sets the color multiplier.cross color scale — a multiplier for the color of cross flares. Higher values produce more pronounced flares. To use this option, rendering of cross flares (see the render_cross) should be enabled.
Arguments:
[0.0f; inf] - available range
1.0f - by default
render_cross_shafts
Description:
  • Variable.   Prints the current number of shafts in a cross flare.
  • Command.   Sets the number of shafts in a cross flare. High number of flares can cause a FPS drop on low-performance hardware. To use this option, rendering of cross flares (see the render_cross) should be enabled.
Arguments:
[2; 32] - available range
4 - by default
render_cross_length
Description:
  • Variable.   Prints the current length of a cross flare relative to the screen width.
  • Command.   Sets the length of a cross flare relative to the screen width. Increasing this value also leads to fading of the shafts across their length. To use this option, rendering of cross flares (see the render_cross) should be enabled.
Arguments:
[0.0f; 2.0f] - available range
0.2f - by default
render_cross_angle
Description:
  • Variable.   Prints the current cross flares orientation angle.
  • Command.   Sets the cross flares orientation angle. To use this option, rendering of cross flares (see the render_cross) should be enabled.
Arguments:
[-inf; inf] - available range
45.0f - by default
render_cross_threshold
Description:
  • Variable.   Prints the current brightness threshold for areas to produce flare
  • Command.   Sets the brightness threshold for areas to produce flare. The higher the threshold value, the brighter the area should be to produce a flare. To use this option, rendering of cross flares (see the render_cross) should be enabled.
Arguments:
[0.0f; inf] - available range
0.0f - by default
render_distance_scale
Description:
  • Variable.   Prints the current global distance multiplier for all distance parameters, such as the world rendering distance, decal distance, field distance, light distance, object distance, reflection distance, LODs, and surface visibility distances.
  • Command.   Sets the global distance multiplier for all distance parameters, such as the world rendering distance, decal distance, field distance, light distance, object distance, reflection distance, LODs, and surface visibility distances. This value enables you to easily increase or decrease rendering performance by changing the world extent. Distances are measured from the camera to the node's (surface's) bound. For example, if the maximum visibility distance of a LOD is 10 meters, and you set Distance Scale = 2, the LOD will disappear at the distance of 20 meters, not 10.
    Notice
    Increasing the value leads to decreasing the performance. The maximum recommended value is 4.
Arguments:
[0.0f; inf] - available range
1.0f - by default
render_distance_offset
Description:
  • Variable.   Prints the current global distance offset for all distance parameters: shadow distance, light distance, LOD distances, etc.
  • Command.   Sets the global distance offset for all distance parameters: shadow distance, light distance, LOD distances, etc.
Arguments:
[0.0f; inf] - available range
0.0f - by default
render_decal_distance
Description:
  • Variable.   Prints the current distance at which (and farther) decals will not be rendered.
  • Command.   Sets the distance at which (and farther) decals will not be rendered. The distance is measured from the camera to the decal's bound. If the value is greater than the World Distance value, the latter is used instead.
Arguments:
[0.0f; inf] - available range
inf - by default
render_field_distance
Description:
  • Variable.   Prints the current distance at which (and farther) field nodes will not be rendered.
  • Command.   Sets the distance at which (and farther) field nodes will not be rendered. The distance is measured from the camera to the field's bound. If the value is greater than the World Distance value, the latter is used instead.
Arguments:
[0.0f; inf] - available range
inf - by default
render_light_distance
Description:
  • Variable.   Prints the current distance at which (and farther) dynamic lights will not be rendered.
  • Command.   Sets the distance at which (and farther) dynamic lights will not be rendered. The distance is measured from the camera to the light's bound. If the value is greater than the World Distance value, the latter is used instead.
Arguments:
[0.0f; inf] - available range
inf - by default
render_object_distance
Description:
  • Variable.   Prints the current distance at which (and farther) objects will not be rendered.
  • Command.   Sets the distance at which (and farther) objects will not be rendered.
    Notice
    If this value is less than the scale multiplier for shadows (see the render_shadow_distance_scale), the shadows will still be rendered even though the objects themselves are not. Please, make sure you set these parameters properly to avoid wasting performance on rendering unnecessary shadows.
Arguments:
[0.0f; inf] - available range
inf - by default
render_reflection_dynamic
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if dynamic reflections for materials are enabled.
Arguments:
0 - disabled
1 - enabled (by default)
render_reflection_dynamic_roughness_offset
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating whether roughness offset is enabled for dynamic reflections produced by Environment Probes. Sometimes, when specular highlights from glossy surfaces get into dynamic Environment Probes a very bright flickering of lighting from it may appear. This option makes surrounding materials look more matte for an Environment Probe than they actually are, reducing such flickering artefacts.
Arguments:
0 - disabled (by default)
1 - enabled
render_reflection_lods
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if reduction of resolution of dynamic reflections when the camera moves away is enabled.
Arguments:
0 - disabled
1 - enabled (by default)
render_reflection_distance
Description:
  • Variable.   Prints the current distance starting from which (and farther) reflections will not be rendered.
  • Command.   Sets the distance starting from which (and farther) reflections will not be rendered.
Arguments:
[0.0f; inf] - available range
inf - by default
render_wireframe_color
Description:
  • Variable.   Prints the current color of the wireframe.
  • Command.   Sets the color of the wireframe.
Arguments:
vec4_one - default value (white)
render_background_color
Description:
  • Variable.   Prints the current background color vector.
  • Command.   Sets the background color vector. The Alpha channel of this color sets background transparency: lower alpha channel values produce darker background color. This parameter allows creating colored transparent background instead of rendering an environment cubemap. However, if the environment cubemap is rendered, the background color will always be rendered over the environment.
Arguments:
vec4_one - default value (white)
render_fade_color
Description:
  • Variable.   Prints the current fade color for the scene on the screen.
  • Command.   Sets the fade color for the scene on the screen. By gradually changing this value it is possible to create "fade in" and "fade out" effects depending on the w component of the given vector. For example, when the following vectors are passed the result will be:
    • vec4(1,1,1,1) - a fully white screen. Positive w results in additive blending.
    • vec4(0.5,0.5,0.5,1) - light colors on the screen.
    • vec4(1,0,0,1) - R channel for all screen colors is to its maximum; G and B without changes.
    • vec4(0,0,0,0) - there is no fading (no color alterations are done to the screen).
    • vec4(1,1,1,-1) - a fully black screen. Negative w results in scene colors * (1 - RGB), where RGB is the first three components of the passed vector.
    • vec4(0.5,0.5,0.5,-1) - dark colors on the screen.
Arguments:
vec4_zero - default value (white)
render_lens
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if lens flares are enabled.
Arguments:
0 - disabled (by default)
1 - enabled
render_lens_color
Description:
  • Variable.   Prints the current color of HDR lens flares.
  • Command.   Sets the color of HDR lens flares. To use this option, rendering of lens flares (see the render_lens) should be enabled.
Arguments:
vec4_one - default value (white)
render_lens_scale
Description:
  • Variable.   Prints the current multiplier for color (see the render_lens_color) of HDR lens flares.
  • Command.   Sets the multiplier for color (see the render_lens_color) of HDR lens flares. To use this option, rendering of lens flares (see the render_lens) should be enabled.
Arguments:
[0.0f; inf] - available range
1.0f - by default
render_lens_length
Description:
  • Variable.   Prints the current length of the radial lens flare indicating if the whole radial lens flare is rendered on the screen or only a part of it.
  • Command.   Sets the length of the radial lens flare indicating if the whole radial lens flare is rendered on the screen or only a part of it. This option controls how lens flares pattern is distributed. To use this option, rendering of lens flares (see the render_lens) should be enabled.
Arguments:
[0.0f; 1.0f] - available range
0.5f - by default
render_lens_radius
Description:
  • Variable.   Prints the current radius of the spherical lens flares on the screen.
  • Command.   Sets the radius of the spherical lens flares on the screen. 1.0f corresponds to a screen-wide radius (a lens flare is not visible). To use this option, rendering of lens flares (see the render_lens) should be enabled.
Arguments:
[0.0f; 1.0f] - available range
0.5f - by default
render_lens_threshold
Description:
  • Variable.   Prints the current value of the brightness threshold for areas to produce lens flares.
  • Command.   Sets the value of the brightness threshold for areas to produce lens flares. The higher the threshold value, the brighter the area should be to produce flares. To use this option, rendering of lens flares (see the render_lens) should be enabled.
Arguments:
[0.0f; 1.0f] - available range
0.5f - by default
render_lens_dispersion
Description:
  • Variable.   Prints the current color displacement for red, green, and blue channels of the lens flares.
  • Command.   Sets the color displacement for red, green, and blue channels of the lens flares. Can be used to create light dispersion (chromatic aberrations). If a negative value is set for a channel, 0 will be used instead. To use this option, rendering of lens flares (see the render_lens) should be enabled.
Arguments:
vec3_one - default value
render_motion_blur
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if the motion blur effect is enabled.
Arguments:
0 - disabled
1 - enabled (by default)
render_motion_blur_preset
Description:
  • Variable.   Prints the current Motion Blur preset. To customize the Motion Blur effect options at run time you should activate the Custom preset:
  • Command.   Sets the Motion Blur preset. To customize the Motion Blur effect options at run time you should activate the Custom preset:
Arguments:
0 - Low (by default)
1 - Medium
2 - High
3 - Ultra
4 - Custom
render_motion_blur_camera_velocity
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if camera velocity contributes to the motion blur effect (false to take into account velocities of objects only). To use this option, rendering of the motion blur effect (see the render_motion_blur) should be enabled.
    Notice
    Disabled in VR mode by default.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active (change active preset via render_motion_blur_preset). Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
0 - disabled
1 - enabled (by default)
render_motion_blur_velocity_blur_samples
Description:
  • Variable.   Prints the current number of iterations performed to blur the border between moving and static objects.
  • Command.   Sets the number of iterations performed to blur the border between moving and static objects. Higher values ensure a higher quality of blurring, but affect the performance. To use this option, rendering of the motion blur effect (see the render_motion_blur) should be enabled.
    Notice
    Disabled in VR mode by default.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active (change active preset via render_motion_blur_preset). Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0; 512] - available range
32 - by default
render_motion_blur_velocity_blur_radius
Description:
  • Variable.   Prints the current radius of the motion blur effect for the boundary between moving and static objects.
  • Command.   Sets the radius of the motion blur effect for the boundary between moving and static objects.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active (change active preset via render_motion_blur_preset). Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; inf] - available range
0.5f - by default
render_motion_blur_depth_threshold_near
Description:
  • Variable.   Prints the current value defining if the blur effect is applied to the foreground object.
  • Command.   Sets the value defining if the blur effect is applied to the foreground object. If the distance between the foreground object and the background object is less than this threshold value, the motion blur effect won't be applied to the foreground object. To use this option, rendering of the motion blur effect (see the render_motion_blur) should be enabled.
    Notice
    Disabled in VR mode by default.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active (change active preset via render_motion_blur_preset). Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; inf] - available range
0.2f - by default
render_motion_blur_depth_threshold_far
Description:
  • Variable.   Prints the current value defining if the blur effect is applied to the background object.
  • Command.   Sets the value defining if the blur effect is applied to the background object. If the distance between the foreground object and the background object is less than this threshold value, the motion blur effect won't be applied to the background object. To use this option, rendering of the motion blur effect (see the render_motion_blur) should be enabled.
    Notice
    Disabled in VR mode by default.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active (change active preset via render_motion_blur_preset). Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; inf] - available range
0.5f - by default
render_motion_blur_noise_intensity
Description:
  • Variable.   Prints the current intensity of the noise used in the motion blur.
  • Command.   Sets the intensity of the noise used in the motion blur. To use this option, rendering of the motion blur effect (see the render_motion_blur) should be enabled.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active (change active preset via render_motion_blur_preset). Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; 1.0f] - available range
0.5f - by default
render_motion_blur_num_steps
Description:
  • Variable.   Prints the current number of steps used in the motion blur.
  • Command.   Sets the number of steps used in the motion blur. The higher the value, the more correct the motion blur effect is. At low values, moving objects may look doubled, however, performance will increase. To use this option, rendering of the motion blur effect (see the render_motion_blur) should be enabled.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active (change active preset via render_motion_blur_preset). Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[2; 64] - available range
8 - by default
render_motion_blur_velocity_scale
Description:
  • Variable.   Prints the current scale value of bodies' linear and angular velocities used for the motion blur.
  • Command.   Sets the scale value of bodies' linear and angular velocities used for the motion blur. The higher the value, the more blurred the objects will appear when moving. To use this option, rendering of the motion blur effect (see the render_motion_blur) should be enabled.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active (change active preset via render_motion_blur_preset). Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; inf] - available range
1.0f - by default
render_motion_blur_max_velocity
Description:
  • Variable.   Prints the current maximum possible amount of motion blur for moving physical objects.
  • Command.   Sets the maximum possible amount of motion blur for moving physical objects. When their body velocity exceeds the set value, they will be blurred as if they have the maximum velocity set by the parameter.

    This parameter should be used:

    • To avoid excessive blurring of fast moving objects.
    • To save performance, as increasing the object's velocity leads increasing the radius of the motion blur effect that drops performance at too high values.
    To use this option, rendering of the motion blur effect (see the render_motion_blur) should be enabled.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active (change active preset via render_motion_blur_preset). Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; inf] - available range
1.0f - by default
render_transparent_blur
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if transparent blur is enabled for materials. This option makes it possible to render matte transparent materials like matte glass.
Arguments:
0 - disabled
1 - enabled (by default)
render_refraction
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if refraction is enabled.
Arguments:
0 - disabled
1 - enabled (by default)
render_refraction_warp_background_transparent_surfaces
Description:
  • Variable.   Prints the current value indicating if refraction affects background transparent surfaces (except for water and clouds).
  • Command.   Sets the value indicating if refraction affects background transparent surfaces (except for water and clouds). The following values are available:
    • Never — no refraction distortion is applied to transparent surfaces.
    • Behind Farthest Refractive Surface — apply refraction distortion to all transparent surfaces behind the farthest refractive surface.
    This method takes effect only when rendering of refractions (see the render_refraction) is enabled.
Arguments:
0 - Never (by default)
1 - Behind Farthest Refractive Surface
render_refraction_dispersion
Description:
  • Variable.   Prints the current refraction displacement for red, green, and blue channels (according to the refraction texture of refractive materials).
  • Command.   Sets the refraction displacement for red, green, and blue channels (according to the refraction texture of refractive materials). Can be used to create light dispersion (chromatic aberrations). To use this option, render_refraction (see the render_refraction) should be enabled.
Arguments:
vec3_one - default value
render_sharpen
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if the sharpening post-processing effect is enabled.
Arguments:
0 - disabled (by default)
1 - enabled
render_sharpen_intensity
Description:
  • Variable.   Prints the current intensity of the sharpening effect.
  • Command.   Sets the intensity of the sharpening effect.intensity of the sharpening effect. To use this option, sharpening post-processing effect should be enabled (see the render_sharpen).
Arguments:
[0.0f; inf] - available range
0.5f - by default
render_vr_emulation
Description:
  • Variable.   Prints the current value indicating the current VR emulation mode.
  • Command.   Sets the value indicating the current VR emulation mode.
Arguments:
0 - Disabled (by default)
1 - HTC Vive
2 - HTC Vive Pro
3 - Oculus Rift
render_ssr
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if the SSR (Screen Space Reflections) effect is enabled.
Arguments:
0 - disabled (by default)
1 - enabled
render_ssr_preset
Description:
  • Variable.   Prints the current SSR (Screen-Space Reflections) preset used at the moment. To customize the SSR effect options at run time you should activate the Custom preset:
  • Command.   Sets the SSR (Screen-Space Reflections) preset used at the moment. To customize the SSR effect options at run time you should activate the Custom preset:
Arguments:
0 - Low (by default)
1 - Medium
2 - High
3 - Ultra
4 - Extreme
5 - Custom
render_ssr_alpha_accumulation_mode
Description:
  • Variable.   Prints the current accumulation mode for Alpha values used when rendering screen-space reflections.
  • Command.   Sets the accumulation mode for Alpha values used when rendering screen-space reflections. Two modes are available:
    • Correct — physically correct implementation.
    • Boosted — artificial implementation that makes SSR more intense and adds additional contrast to some scenes.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active (change active preset via render_ssr_preset). Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
0 - Correct
1 - Boosted (by default)
render_ssr_increased_accuracy
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if increased accuracy option is enabled for the SSR (Screen Space Reflections). This option increases the accuracy of intersection detection between the ray and surfaces, which makes a reflection on smooth surfaces more detailed.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active (change active preset via render_ssr_preset). Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
0 - disabled (by default)
1 - enabled
Description:
render_ssr_resolution
Description:
  • Variable.   Prints the current resolution of SSR (Screen Space Reflections).
  • Command.   Sets the resolution of SSR (Screen Space Reflections).
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active (change active preset via render_ssr_preset). Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
One of the following values:
  • 0 - quarter resolution
  • 1 - half resolution
  • 2 - full resolution
The default value is (1)
render_ssr_resolution_depth
Description:
  • Variable.   Prints the current resolution of the depth buffer used for SSR (Screen Space Reflections) calculation.
  • Command.   Sets the resolution of the depth buffer used for SSR (Screen Space Reflections) calculation. It affects detailing of reflections of tiny objects.
    Notice
    To gain performance, this option can be set to lower values while enabling increased accuracy (see the render_ssr_increased_accuracy).
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active (change active preset via render_ssr_preset). Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
One of the following values:
  • 0 - quarter resolution
  • 1 - half resolution
  • 2 - full resolution
The default value is (0)
render_ssr_resolution_color
Description:
  • Variable.   Prints the current resolution of the color buffer used for SSR (Screen Space Reflections) calculation.
  • Command.   Sets the resolution of the color buffer used for SSR (Screen Space Reflections) calculation. It significantly affects performance.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active (change active preset via render_ssr_preset). Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
One of the following values:
  • 0 - quarter resolution
  • 1 - half resolution
  • 2 - full resolution
The default value is (0)
render_ssr_perspective_compensation
Description:
  • Variable.   Prints the current perspective compensation value for the SSR effect.
  • Command.   Sets the perspective compensation value for the SSR effect. At 0.0f, the raymarching step size doesn't depend on the distance from the reflecting surface to the camera. At 1.0f, the raymarching step size linearly depends on the distance from the reflecting surface to the camera.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active (change active preset via render_ssr_preset). Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; 1.0f] - available range
1.0f - by default
render_ssr_num_rays
Description:
  • Variable.   Prints the current number of SSR rays per pixel that are used to calculate rough refrections.
  • Command.   Sets the number of SSR rays per pixel that are used to calculate rough refrections. Using more rays provides more precise SSR roughness calculation, however, it is more expensive.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active (change active preset via render_ssr_preset). Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[1; 64] - available range
4 - by default
render_ssr_num_steps
Description:
  • Variable.   Prints the current number of SSR steps per ray that are used for trace calculation.
  • Command.   Sets the number of SSR steps per ray that are used for trace calculation. The number of steps defines accuracy of reflections and causes a reasonable performance impact. The higher the value, the more accurate obstacles between objects are accounted.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active (change active preset via render_ssr_preset). Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[1; 64] - available range
16 - by default
render_ssr_step_size
Description:
  • Variable.   Prints the current size of the trace step used for SSR calculation.
  • Command.   Sets the size of the trace step used for SSR calculation. Higher values result in longer traces (however, tiny objects may become missing), lower values produce more detailed reflections of tiny objects.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active (change active preset via render_ssr_preset). Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; inf] - available range
0.5f - by default
render_ssr_non_linear_step_size
Description:
  • Variable.   Prints the current linear step size for the SSR effect.
  • Command.   Sets the linear step size for the SSR effect. At 0.0f, all raymarching steps are of the same size. At 1.0f, each raymarching step is longer than a preceding one, which allows increasing the ray length while keeping the same number of raymarching steps.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active (change active preset via render_ssr_preset). Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; 1.0f] - available range
1.0f - by default
render_ssr_visibility_roughness_min
Description:
  • Variable.   Prints the current minimum roughness value, starting from which the SSR (Screen-Space Reflections) effect begins to fade out.
  • Command.   Sets the minimum roughness value, starting from which the SSR (Screen-Space Reflections) effect begins to fade out. It allows reducing noise of reflections on rough materials.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active (change active preset via render_ssr_preset). Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; 1.0f] - available range
1.0f - by default
render_ssr_visibility_roughness_max
Description:
  • Variable.   Prints the current maximum roughness value, starting from which the SSR (Screen-Space Reflections) effect is not rendered.
  • Command.   Sets the maximum roughness value, starting from which the SSR (Screen-Space Reflections) effect is not rendered. It allows reducing noise of reflections on rough materials.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active (change active preset via render_ssr_preset). Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; 1.0f] - available range
1.0f - by default
render_ssr_roughness_mip_offset
Description:
  • Variable.   Prints the current mip offset value for the SSR effect on rough surfaces.
  • Command.   Sets the mip offset value for the SSR effect on rough surfaces. Enhances reading a color on rough surfaces on lower-resolution screens. This setting allows reducing the noise and improving performance.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active (change active preset via render_ssr_preset). Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; 10.0f] - available range
4.0f - by default
render_ssr_threshold
Description:
  • Variable.   Prints the current threshold used for SSR (Screen-Space Reflections) calculation to limit imitation of reflections in areas where SSR cannot get information.
  • Command.   Sets the threshold used for SSR (Screen-Space Reflections) calculation to limit imitation of reflections in areas where SSR cannot get information. Higher values make the effect less pronounced.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active (change active preset via render_ssr_preset). Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; inf] - available range
1.0f - by default
render_ssr_threshold_occlusion
Description:
  • Variable.   Prints the current value that limits imitation of environment cubemap occlusion in areas where SSR (Screen-Space Reflections) cannot get information.
  • Command.   Sets the value that limits imitation of environment cubemap occlusion in areas where SSR (Screen-Space Reflections) cannot get information. Higher values make the effect less pronounced. This parameter is mainly used for indoor environment to correct false reflections on occluded areas (false reflections are replaced with black color). For outdoor environment, higher values of this parameter are recommended.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active (change active preset via render_ssr_preset). Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; inf] - available range
1.0f - by default
render_ssr_normal_bias
Description:
  • Variable.   Prints the current bias value to which the ray starting position has been shifted along the normal vector.
  • Command.   Sets the bias value to which the ray starting position has been shifted along the normal vector. This value is used for SSR (Screen-Space Reflections) calculation. Can be adjusted to fine-tune reflections of small objects at far distances. Recommended for narrow FOV angles. To use this option, SSR (see the render_ssr) should be enabled.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active (change active preset via render_ssr_preset). Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; 1.0f] - available range
1.0f - by default
render_ssr_view_bias
Description:
  • Variable.   Prints the current bias value to which the ray starting position has been shifted along the view vector.
  • Command.   Sets the bias value to which the ray starting position has been shifted along the view vector. This value is used for SSR (Screen-Space Reflections) calculation. Can be adjusted to fine-tune reflections of small objects at far distances. Recommended for narrow FOV angles. To use this option, SSR (see the render_ssr) should be enabled.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active (change active preset via render_ssr_preset). Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; 1.0f] - available range
1.0f - by default
render_ssr_tonemapping_gamma
Description:
  • Variable.   Prints the current tonemapping Gamma value for the SSR effect.
  • Command.   Sets the tonemapping Gamma value for the SSR effect. Helps reducing noise for reflections from bright surfaces. 1.0f corresponds to the physically correct value. The recommended value is 2.0f — although it slightly reduces the reflection brightness, it also significantly reduces noise.
Notice
Setting the value via this console command changes only the setting stored in the Custom preset, and will take effect only when this preset is active (change active preset via render_ssr_preset). Checking the parameter returns the corresponding setting stored in the active preset (default or custom one).
Arguments:
[0.0f; 10.0f] - available range
2.0f - by default
render_ssrtgi_preset
Description:
  • Variable.   Prints the current index of the SSRTGI (Screen-Space Ray-Traced Global Illumination) preset used at the moment. To customize the SSRTGI effect options at run time you should activate the Custom preset:
  • Command.   Sets the index of the SSRTGI (Screen-Space Ray-Traced Global Illumination) preset used at the moment. To customize the SSRTGI effect options at run time you should activate the Custom preset:
Arguments:
0 - Disabled (by default)
1 - Low
2 - Medium
3 - High
4 - Ultra
5 - Extreme
6 - Custom
render_ssrtgi_fast_tracing
Description:
  • Variable.   Prints a value indicating if the option controlled by the command below is enabled.
  • Command.   Toggles the value indicating if fast tracing is enabled for the SSRTGI (Screen Space Ray-Traced Global Illumination). This option dynamically changes step size to obtain indirect illumination bounces using low number of steps while keeping performance high. Disabling this option improves quality, but significantly reduces performance. SSRTGI must be enabled (see the render_ssrtgi_preset).
Notice
Setting the value via